[ViewVC] Diff of: cvs/rxvt-unicode/doc/rxvt.1.pod

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents):
Revision 1.129 by root, Mon May 28 20:34:56 2007 UTC vs.
Revision 1.141 by sasha, Mon Oct 29 13:40:41 2007 UTC

…		…
26	Unlike the original rxvt, B<rxvt-unicode> stores all text in Unicode	26	Unlike the original rxvt, B<rxvt-unicode> stores all text in Unicode
27	internally. That means it can store and display most scripts in the	27	internally. That means it can store and display most scripts in the
28	world. Being a terminal emulator, however, some things are very difficult,	28	world. Being a terminal emulator, however, some things are very difficult,
29	especially cursive scripts such as arabic, vertically written scripts	29	especially cursive scripts such as arabic, vertically written scripts
30	like mongolian or scripts requiring extremely complex combining rules,	30	like mongolian or scripts requiring extremely complex combining rules,
31	like tibetan or devenagari. Don't expect pretty output when using these	31	like tibetan or devanagari. Don't expect pretty output when using these
32	scripts. Most other scripts, latin, cyrillic, kanji, thai etc. should work	32	scripts. Most other scripts, latin, cyrillic, kanji, thai etc. should work
33	fine, though. A somewhat difficult case are right-to-left scripts, such	33	fine, though. A somewhat difficult case are right-to-left scripts, such
34	as hebrew: B<rxvt-unicode> adopts the view that bidirectional algorithms	34	as hebrew: B<rxvt-unicode> adopts the view that bidirectional algorithms
35	belong into the application, not the terminal emulator (too many things --	35	belong into the application, not the terminal emulator (too many things --
36	such as cursor-movement while editing -- break otherwise), but that might	36	such as cursor-movement while editing -- break otherwise), but that might
…		…
108		108
109	Turn on/off simulated reverse video; resource B<reverseVideo>.	109	Turn on/off simulated reverse video; resource B<reverseVideo>.
110		110
111	=item B<-j>\|B<+j>	111	=item B<-j>\|B<+j>
112		112
113	Turn on/off jump scrolling; resource B<jumpScroll>.	113	Turn on/off jump scrolling (allow multiple lines per refresh); resource B<jumpScroll>.
114		114
115	=item B<-ip>\|B<+ip> \| B<-tr>\|B<+tr>	115	=item B<-ss>\|B<+ss>
116		116
117	Turn on/off inheriting parent window's pixmap. Alternative form is	117	Turn on/off skip scrolling (allow multiple screens per refresh); resource B<skipScroll>.
118	B<-tr>; resource B<inheritPixmap>.
119		118
120	I<Please note that transparency of any kind if completely unsupported by	119	=item B<-tr>\|B<+tr>
121	the author. Don't bug him with installation questions! Read the FAQ (man 7	120
122	@@RXVT_NAME@@)!>	121	Turn on/off illusion of a transparent window background. Obsolete form of it is
		122	B<-ip> and it should not be used anymore; resource B<transparent>.
		123
		124	I<Please note that old resource name of B<inheritPixmap> is obsolete and should be
		125	changed to B<transparent>. Backwards compatibility support for B<inheritPixmap> will
		126	be phased out in future versions of rxvt!>
		127
		128	I<Please address all transparency related issues to Sasha Vasko at
		129	sasha@aftercode.net. Read the FAQ (man 7 @@RXVT_NAME@@)!>
123		130
124	=item B<-fade> I<number>	131	=item B<-fade> I<number>
125		132
126	Fade the text by the given percentage when focus is lost. Small values	133	Fade the text by the given percentage when focus is lost. Small values
127	fade a little only, 100 completely replaces all colours by the fade	134	fade a little only, 100 completely replaces all colours by the fade
…		…
133	is opaque black. resource B<fadeColor>.	140	is opaque black. resource B<fadeColor>.
134		141
135	=item B<-tint> I<colour>	142	=item B<-tint> I<colour>
136		143
137	Tint the transparent background pixmap with the given colour when	144	Tint the transparent background pixmap with the given colour when
138	transparency is enabled with B<-tr> or B<-ip>. This only works for	145	transparency is enabled with B<-tr>. This only works for
139	non-tiled backgrounds, currently. See also the B<-sh> option that can be	146	non-tiled backgrounds, currently. See also the B<-sh> option that can be
140	used to brighten or darken the image in addition to tinting it; resource	147	used to brighten or darken the image in addition to tinting it.
		148	Please note that certain tint colours can be applied on the server-side,
		149	thus yielding performance gain of two orders of magnitude. These colours are:
		150	blue, red, green, cyan, magenta, yellow, and those close to them. Also
		151	pure black and pure white colors essentialy mean no tinting; resource
141	I<tintColor>. Example:	152	I<tintColor>. Example:
142		153
143	@@RXVT_NAME@@ -tr -tint blue -sh 40	154	@@RXVT_NAME@@ -tr -tint blue -sh 40
144		155
145	=item B<-sh>	156	=item B<-sh> I<number>
146		157
147	I<number> Darken (0 .. 100) or lighten (-1 .. -100) the transparent	158	Darken (0 .. 100) or lighten (100 .. 200) the transparent
148	background image in addition to tinting it (i.e. B<-tint> must be	159	background image in addition to (or instead of) tinting it;
149	specified, too, e.g. C<-tint white>); resource I<shading>.	160	resource I<shading>.
		161
		162	=item B<-blt> I<string>
		163
		164	Specify background blending type. If background pixmap is specified
		165	at the same time as transparency - such pixmap will be blended over
		166	transparency image, using method specified. Supported values are :
		167	B<add>, B<alphablend>, B<allanon> - color values averaging, B<colorize>,
		168	B<darken>, B<diff>, B<dissipate>, B<hue>, B<lighten>, B<overlay>,
		169	B<saturate>, B<screen>, B<sub>, B<tint>, B<value>. The default is
		170	alpha-blending. Compile I<afterimage>; resource I<blendType>.
		171
		172	=item B<-blr> I<HxV>
		173
		174	Apply Gaussian Blur with the specified radii to the transparent
		175	background image. If single number is specified - both vertical and
		176	horizontal radii are considered to be the same. Setting one of the
		177	radii to 1 and another to a large number creates interesting effects
		178	on some backgrounds. Maximum radius value is 128. Compile I<afterimage>;
		179	resource I<blurRadius>.
150		180
151	=item B<-bg> I<colour>	181	=item B<-bg> I<colour>
152		182
153	Window background colour; resource B<background>.	183	Window background colour; resource B<background>.
154		184
…		…
156		186
157	Window foreground colour; resource B<foreground>.	187	Window foreground colour; resource B<foreground>.
158		188
159	=item B<-pixmap> I<file[;geom]>	189	=item B<-pixmap> I<file[;geom]>
160		190
161	Compile I<XPM>: Specify XPM file for the background and also optionally	191	Compile I<afterimage>: Specify image file for the background and also
162	specify its scaling with a geometry string. Note you may need to	192	optionally specify its scaling with a geometry string. Note you may need to
163	add quotes to avoid special shell interpretation of the C<;> in the	193	add quotes to avoid special shell interpretation of the C<;> in the
164	command-line; resource B<backgroundPixmap>.	194	command-line; for more details see resource B<backgroundPixmap>.
165		195
166	=item B<-cr> I<colour>	196	=item B<-cr> I<colour>
167		197
168	The cursor colour; resource B<cursorColor>.	198	The cursor colour; resource B<cursorColor>.
169		199
…		…
322		352
323	=item B<-lsp> I<number>	353	=item B<-lsp> I<number>
324		354
325	Compile I<frills>: Lines (pixel height) to insert between each row of	355	Compile I<frills>: Lines (pixel height) to insert between each row of
326	the display. Useful to work around font rendering problems; resource	356	the display. Useful to work around font rendering problems; resource
327	B<linespace>.	357	B<lineSpace>.
328		358
329	=item B<-tn> I<termname>	359	=item B<-tn> I<termname>
330		360
331	This option specifies the name of the terminal type to be set in the	361	This option specifies the name of the terminal type to be set in the
332	B<TERM> environment variable. This terminal type must exist in the	362	B<TERM> environment variable. This terminal type must exist in the
…		…
592	option B<-rv>. B<False>: regular screen colours [default]; option	622	option B<-rv>. B<False>: regular screen colours [default]; option
593	B<+rv>. See note in B<COLORS AND GRAPHICS> section.	623	B<+rv>. See note in B<COLORS AND GRAPHICS> section.
594		624
595	=item B<jumpScroll:> I<boolean>	625	=item B<jumpScroll:> I<boolean>
596		626
597	B<True>: specify that jump scrolling should be used. When scrolling	627	B<True>: specify that jump scrolling should be used. When receiving lots
598	quickly, fewer screen updates are performed [default]; option B<-j>.	628	of lines, @@RXVT_NAME@@ will only scroll once a whole screen height of lines
		629	has been read, resulting in fewer updates while still displaying every
		630	received line; option B<-j>.
		631
599	B<False>: specify that smooth scrolling should be used; option B<+j>.	632	B<False>: specify that smooth scrolling should be used. @@RXVT_NAME@@ will
		633	force a screen refresh on each new line it received; option B<+j>.
		634
		635	=item B<skipScroll:> I<boolean>
		636
		637	B<True>: (the default) specify that skip scrolling should be used. When
		638	receiving lots of lines, @@RXVT_NAME@@ will only scroll once in a while
		639	(around 60 times per second), resulting in far fewer updates. This can
		640	result in @@RXVT_NAME@@ not ever displaying some of the lines it receives;
		641	option B<-ss>.
		642
		643	B<False>: specify that everything is to be displayed, even
		644	if the refresh is too fast for the human eye to read anything (or the
		645	monitor to display anything); option B<+ss>.
600		646
601	=item B<inheritPixmap:> I<boolean>	647	=item B<inheritPixmap:> I<boolean>
602		648
603	B<True>: make the background inherit the parent windows' pixmap, giving	649	B<True>: make the background inherit the parent windows' pixmap, giving
604	artificial transparency. B<False>: do not inherit the parent windows'	650	artificial transparency. B<False>: do not inherit the parent windows'
…		…
624	=item B<shading:> I<number>	670	=item B<shading:> I<number>
625		671
626	Darken (0 .. 100) or lighten (-1 .. -100) the transparent background image	672	Darken (0 .. 100) or lighten (-1 .. -100) the transparent background image
627	in addition to tinting it; option B<-sh>.	673	in addition to tinting it; option B<-sh>.
628		674
		675	=item B<blendType:> I<string>
		676
		677	Specify background blending type; option B<-blt>.
		678
		679	=item B<blurRadius:> I<number>
		680
		681	Apply Gaussian Blurr with the specified radius to the transparent
		682	background image; option B<-blr>.
		683
629	=item B<scrollColor:> I<colour>	684	=item B<scrollColor:> I<colour>
630		685
631	Use the specified colour for the scrollbar [default #B2B2B2].	686	Use the specified colour for the scrollbar [default #B2B2B2].
632		687
633	=item B<troughColor:> I<colour>	688	=item B<troughColor:> I<colour>
…		…
640	The colour of the border around the text area and between the scrollbar	695	The colour of the border around the text area and between the scrollbar
641	and the text.	696	and the text.
642		697
643	=item B<backgroundPixmap:> I<file[;geom]>	698	=item B<backgroundPixmap:> I<file[;geom]>
644		699
645	Use the specified XPM file (note the `.xpm' extension is optional) for	700	Use the specified image file for the background and also optionally
646	the background and also optionally specify its scaling with a geometry	701	specify its scaling with a geometry string B<WxH+X+Y>,
647	string B<WxH+X+Y>, in which B<"W" / "H"> specify the	702	in which B<"W" / "H"> specify the horizontal/vertical scale (percent),
648	horizontal/vertical scale (percent) and B<"X" / "Y"> locate the image	703	and B<"X" / "Y"> locate the image centre (percent).
649	centre (percent). A scale of 0 displays the image with tiling. A scale	704	A scale of 0 displays the image with tiling. A scale of 1 displays the
650	of 1 displays the image without any scaling. A scale of 2 to 9	705	image without any scaling. A scale of 2 to 9 specifies an integer
651	specifies an integer number of images in that direction. No image will	706	number of images in that direction. No image will be magnified beyond
652	be magnified beyond 10 times its original size. The maximum permitted	707	10 times its original size. The maximum permitted scale is 1000.
653	scale is 1000. [default 0x0+50+50]	708	Special string of B<"auto"> used as a geometry will cause image to be
		709	automatically scaled to match window size.
		710	If used in conjunction with B<-tr> option - specified pixmap will be
		711	blended over transparency image using either alpha-blending, or any
		712	other blending type, specified with B<-blt "type"> option.
		713	[default 0x0+50+50]
654		714
655	=item B<path:> I<path>	715	=item B<path:> I<path>
656		716
657	Specify the colon-delimited search path for finding XPM files.	717	Specify the colon-delimited search path for finding background image files.
658		718
659	=item B<font:> I<fontlist>	719	=item B<font:> I<fontlist>
660		720
661	Select the fonts to be used. This is a comma separated list of font names	721	Select the fonts to be used. This is a comma separated list of font names
662	that are checked in order when trying to find glyphs for characters. The	722	that are checked in order when trying to find glyphs for characters. The
…		…
861	=item B<termName:> I<termname>	921	=item B<termName:> I<termname>
862		922
863	Specifies the terminal type name to be set in the B<TERM> environment	923	Specifies the terminal type name to be set in the B<TERM> environment
864	variable; option B<-tn>.	924	variable; option B<-tn>.
865		925
866	=item B<linespace:> I<number>	926	=item B<lineSpace:> I<number>
867		927
868	Specifies number of lines (pixel height) to insert between each row of	928	Specifies number of lines (pixel height) to insert between each row of
869	the display [default 0]; option B<-lsp>.	929	the display [default 0]; option B<-lsp>.
870		930
871	=item B<meta8:> I<boolean>	931	=item B<meta8:> I<boolean>
…		…
1029	searching keysym macros from B</usr/X11R6/include/X11/keysymdef.h> and	1089	searching keysym macros from B</usr/X11R6/include/X11/keysymdef.h> and
1030	omitting the prefix B<XK_>. Alternatively you can specify I<key> by its hex	1090	omitting the prefix B<XK_>. Alternatively you can specify I<key> by its hex
1031	keysym value (B<0x0000 - 0xFFFF>). Note that the lookup of I<sym>s is not	1091	keysym value (B<0x0000 - 0xFFFF>). Note that the lookup of I<sym>s is not
1032	performed in an exact manner; however, the closest match is assured.	1092	performed in an exact manner; however, the closest match is assured.
1033		1093
1034	I<string> may contain escape values (C<\a>: bell, C<\b>: backspace,	1094	I<string> may contain escape values (C<\n>: newline, C<\000>: octal
1035	C<\e>, C<\E>: escape, C<\n>: newline, C<\r>: carriage return, C<\t>: tab,	1095	number), see RESOURCES in C<man 7 X> for futher details.
1036	C<\000>: octal number) or verbatim control characters (C<^?>: delete,
1037	C<^@>: null, C<^A> ...) and may be enclosed with double quotes so that it
1038	can start or end with whitespace. B<This feature is deprecated and will
1039	be removed>.
1040
1041	Please note that you need to double the C<\> in resource files, as
1042	Xlib itself does its own de-escaping (you can use C<\033> instead of
1043	C<\e> (and so on), which will work with both Xt and @@RXVT_NAME@@'s own
1044	processing).
1045		1096
1046	You can define a range of keysyms in one shot by providing a I<string>	1097	You can define a range of keysyms in one shot by providing a I<string>
1047	with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimiter `/'	1098	with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimiter `/'
1048	should be a character not used by the strings.	1099	should be a character not used by the strings.
1049		1100
…		…
1173	=item B<override-redirect>: I<boolean>	1224	=item B<override-redirect>: I<boolean>
1174		1225
1175	Compile I<frills>: Sets override-redirect for the terminal window, making	1226	Compile I<frills>: Sets override-redirect for the terminal window, making
1176	it almost invisible to window managers; option B<-override-redirect>.	1227	it almost invisible to window managers; option B<-override-redirect>.
1177		1228
		1229	=item B<iso14755_52:> I<boolean>
		1230
		1231	Turn on/off ISO 14755 5.2 mode (default enabled).
		1232
1178	=back	1233	=back
1179		1234
1180	=head1 THE SCROLLBAR	1235	=head1 THE SCROLLBAR
1181		1236
1182	Lines of text that scroll off the top of the B<@@RXVT_NAME@@> window	1237	Lines of text that scroll off the top of the B<@@RXVT_NAME@@> window
…		…
1252		1307
1253	=head1 ISO 14755 SUPPORT	1308	=head1 ISO 14755 SUPPORT
1254		1309
1255	ISO 14755 is a standard for entering and viewing unicode characters	1310	ISO 14755 is a standard for entering and viewing unicode characters
1256	and character codes using the keyboard. It consists of 4 parts. The	1311	and character codes using the keyboard. It consists of 4 parts. The
1257	first part is available rxvt-unicode has been compiled with	1312	first part is available if rxvt-unicode has been compiled with
1258	C<--enable-frills>, the rest is available when rxvt-unicode was compiled	1313	C<--enable-frills>, the rest is available when rxvt-unicode was compiled
1259	with C<--enable-iso14755>.	1314	with C<--enable-iso14755>.
1260		1315
1261	=over 4	1316	=over 4
1262		1317
…		…
1416	resources or on the command line.	1471	resources or on the command line.
1417		1472
1418	=item B<COLORTERM>	1473	=item B<COLORTERM>
1419		1474
1420	Either C<rxvt>, C<rxvt-xpm>, depending on whether @@RXVT_NAME@@ was	1475	Either C<rxvt>, C<rxvt-xpm>, depending on whether @@RXVT_NAME@@ was
1421	compiled with XPM support, and optionally with the added extension	1476	compiled with background image support, and optionally with the added
1422	C<-mono> to indicate that rxvt-unicode runs on a monochrome screen.	1477	extension C<-mono> to indicate that rxvt-unicode runs on a monochrome
		1478	screen.
1423		1479
1424	=item B<COLORFGBG>	1480	=item B<COLORFGBG>
1425		1481
1426	Set to a string of the form C<fg;bg> or C<fg;xpm;bg>, where C<fg> is	1482	Set to a string of the form C<fg;bg> or C<fg;xpm;bg>, where C<fg> is
1427	the colour code used as default foreground/text colour (or the string	1483	the colour code used as default foreground/text colour (or the string
1428	C<default> to indicate that the default-colour escape sequence is to be	1484	C<default> to indicate that the default-colour escape sequence is to be
1429	used), C<bg> is the colour code used as default background colour (or the	1485	used), C<bg> is the colour code used as default background colour (or the
1430	string C<default>), and C<xpm> is the string C<default> if @@RXVT_NAME@@	1486	string C<default>), and C<xpm> is the string C<default> if @@RXVT_NAME@@
1431	was compiled with XPM support. Libraries like C<ncurses> and C<slang> can	1487	was compiled with background image support. Libraries like C<ncurses>
1432	(and do) use this information to optimize screen output.	1488	and C<slang> can (and do) use this information to optimize screen output.
1433		1489
1434	=item B<WINDOWID>	1490	=item B<WINDOWID>
1435		1491
1436	Set to the (decimal) X Window ID of the @@RXVT_NAME@@ window (the toplevel	1492	Set to the (decimal) X Window ID of the @@RXVT_NAME@@ window (the toplevel
1437	window, which usually has subwindows for the scrollbar, the terminal	1493	window, which usually has subwindows for the scrollbar, the terminal

Diff Legend

-–
+Removed lines
-+
+Added lines
-<
+Changed lines
->
+Changed lines

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents): Revision 1.129 by root, Mon May 28 20:34:56 2007 UTC vs. Revision 1.141 by sasha, Mon Oct 29 13:40:41 2007 UTC

Diff Legend

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents):
Revision 1.129 by root, Mon May 28 20:34:56 2007 UTC vs.
Revision 1.141 by sasha, Mon Oct 29 13:40:41 2007 UTC