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

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents):
Revision 1.134 by sasha, Tue Jul 31 22:23:56 2007 UTC vs.
Revision 1.160 by root, Fri Jan 25 18:42:23 2008 UTC

…		…
12	emulator intended as an I<xterm>(1) replacement for users who do not	12	emulator intended as an I<xterm>(1) replacement for users who do not
13	require features such as Tektronix 4014 emulation and toolkit-style	13	require features such as Tektronix 4014 emulation and toolkit-style
14	configurability. As a result, B<rxvt-unicode> uses much less swap space --	14	configurability. As a result, B<rxvt-unicode> uses much less swap space --
15	a significant advantage on a machine serving many X sessions.	15	a significant advantage on a machine serving many X sessions.
16		16
		17	This document is also available on the World-Wide-Web at
		18	L<http://pod.tst.eu/http://cvs.schmorp.de/rxvt-unicode/doc/rxvt.1.pod>.
		19
17	=head1 FREQUENTLY ASKED QUESTIONS	20	=head1 FREQUENTLY ASKED QUESTIONS
18		21
19	See @@RXVT_NAME@@(7) (try C<man 7 @@RXVT_NAME@@>) for a list of	22	See @@RXVT_NAME@@(7) (try C<man 7 @@RXVT_NAME@@>) for a list of
20	frequently asked questions and answer to them and some common	23	frequently asked questions and answer to them and some common
21	problems. That document is also accessible on the World-Wide-Web at	24	problems. That document is also accessible on the World-Wide-Web at
22	L<http://cvs.schmorp.de/browse/rxvt-unicode/doc/rxvt.7.html>.	25	L<http://pod.tst.eu/http://cvs.schmorp.de/rxvt-unicode/doc/rxvt.7.pod>.
23		26
24	=head1 RXVT-UNICODE VS. RXVT	27	=head1 RXVT-UNICODE VS. RXVT
25		28
26	Unlike the original rxvt, B<rxvt-unicode> stores all text in Unicode	29	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	30	internally. That means it can store and display most scripts in the
28	world. Being a terminal emulator, however, some things are very difficult,	31	world. Being a terminal emulator, however, some things are very difficult,
29	especially cursive scripts such as arabic, vertically written scripts	32	especially cursive scripts such as arabic, vertically written scripts
30	like mongolian or scripts requiring extremely complex combining rules,	33	like mongolian or scripts requiring extremely complex combining rules,
31	like tibetan or devenagari. Don't expect pretty output when using these	34	like tibetan or devanagari. Don't expect pretty output when using these
32	scripts. Most other scripts, latin, cyrillic, kanji, thai etc. should work	35	scripts. Most other scripts, latin, cyrillic, kanji, thai etc. should work
33	fine, though. A somewhat difficult case are right-to-left scripts, such	36	fine, though. A somewhat difficult case are right-to-left scripts, such
34	as hebrew: B<rxvt-unicode> adopts the view that bidirectional algorithms	37	as hebrew: B<rxvt-unicode> adopts the view that bidirectional algorithms
35	belong into the application, not the terminal emulator (too many things --	38	belong in the application, not the terminal emulator (too many things --
36	such as cursor-movement while editing -- break otherwise), but that might	39	such as cursor-movement while editing -- break otherwise), but that might
37	change.	40	change.
38		41
39	If you are looking for a terminal that supports more exotic scripts, let	42	If you are looking for a terminal that supports more exotic scripts, let
40	me recommend C<mlterm>, which is a very user friendly, lean and clean	43	me recommend C<mlterm>, which is a very user friendly, lean and clean
…		…
98	=item B<-depth> I<bitdepth>	101	=item B<-depth> I<bitdepth>
99		102
100	Compile I<xft>: Attempt to find a visual with the given bit depth;	103	Compile I<xft>: Attempt to find a visual with the given bit depth;
101	resource B<depth>.	104	resource B<depth>.
102		105
		106	[Please note that many X servers (and libXft) are buggy with
		107	respect to C<-depth 32> and/or alpha channels, and will cause all sorts
		108	of graphical corruption. This is harmless, but we can't do anything about
		109	this, so watch out]
		110
103	=item B<-geometry> I<geom>	111	=item B<-geometry> I<geom>
104		112
105	Window geometry (B<-g> still respected); resource B<geometry>.	113	Window geometry (B<-g> still respected); resource B<geometry>.
106		114
107	=item B<-rv>\|B<+rv>	115	=item B<-rv>\|B<+rv>
…		…
114		122
115	=item B<-ss>\|B<+ss>	123	=item B<-ss>\|B<+ss>
116		124
117	Turn on/off skip scrolling (allow multiple screens per refresh); resource B<skipScroll>.	125	Turn on/off skip scrolling (allow multiple screens per refresh); resource B<skipScroll>.
118		126
119	=item B<-ip>\|B<+ip> \| B<-tr>\|B<+tr>	127	=item B<-tr>\|B<+tr>
120		128
121	Turn on/off inheriting parent window's pixmap. Alternative form is	129	Turn on/off illusion of a transparent window background; resource B<transparent>.
122	B<-tr>; resource B<inheritPixmap>.
123		130
124	I<Please note that transparency of any kind if completely unsupported by	131	B<-ip> is still accepted as an obsolete alias but will be removed in
125	the author. Don't bug him with installation questions! Read the FAQ (man 7	132	future versions.
126	@@RXVT_NAME@@)!>	133
		134	I<Please address all transparency related issues to Sasha Vasko at
		135	sasha@aftercode.net. Read the FAQ (man 7 @@RXVT_NAME@@)!>
127		136
128	=item B<-fade> I<number>	137	=item B<-fade> I<number>
129		138
130	Fade the text by the given percentage when focus is lost. Small values	139	Fade the text by the given percentage when focus is lost. Small values
131	fade a little only, 100 completely replaces all colours by the fade	140	fade a little only, 100 completely replaces all colours by the fade
…		…
137	is opaque black. resource B<fadeColor>.	146	is opaque black. resource B<fadeColor>.
138		147
139	=item B<-tint> I<colour>	148	=item B<-tint> I<colour>
140		149
141	Tint the transparent background pixmap with the given colour when	150	Tint the transparent background pixmap with the given colour when
142	transparency is enabled with B<-tr> or B<-ip>. This only works for	151	transparency is enabled with B<-tr>. This only works for
143	non-tiled backgrounds, currently. See also the B<-sh> option that can be	152	non-tiled backgrounds, currently. See also the B<-sh> option that can be
144	used to brighten or darken the image in addition to tinting it.	153	used to brighten or darken the image in addition to tinting it.
145	Please note that certain tint colors could be applued on the server-side,	154	Please note that certain tint colours can be applied on the server-side,
146	thus yeilding performance gain of two orders of magnitude. This colors are:	155	thus yielding performance gain of two orders of magnitude. These colours are:
147	blue, red, green, cyan, magenta, yellow, and those close to this; resource	156	blue, red, green, cyan, magenta, yellow, and those close to them. Also
		157	pure black and pure white colors essentially mean no tinting; resource
148	I<tintColor>. Example:	158	I<tintColor>. Example:
149		159
150	@@RXVT_NAME@@ -tr -tint blue -sh 40	160	@@RXVT_NAME@@ -tr -tint blue -sh 40
151		161
152	=item B<-sh> I<number>	162	=item B<-sh> I<number>
153		163
154	Darken (0 .. 100) or lighten (-1 .. -100) the transparent	164	Darken (0 .. 100) or lighten (100 .. 200) the transparent
155	background image in addition to (or instead of) tinting it;	165	background image in addition to (or instead of) tinting it;
156	resource I<shading>.	166	resource I<shading>.
157		167
158	=item B<-blt> I<string>	168	=item B<-blt> I<string>
159		169
…		…
161	at the same time as transparency - such pixmap will be blended over	171	at the same time as transparency - such pixmap will be blended over
162	transparency image, using method specified. Supported values are :	172	transparency image, using method specified. Supported values are :
163	B<add>, B<alphablend>, B<allanon> - color values averaging, B<colorize>,	173	B<add>, B<alphablend>, B<allanon> - color values averaging, B<colorize>,
164	B<darken>, B<diff>, B<dissipate>, B<hue>, B<lighten>, B<overlay>,	174	B<darken>, B<diff>, B<dissipate>, B<hue>, B<lighten>, B<overlay>,
165	B<saturate>, B<screen>, B<sub>, B<tint>, B<value>. The default is	175	B<saturate>, B<screen>, B<sub>, B<tint>, B<value>. The default is
166	alpha-blending; resource I<blendType>.	176	alpha-blending. Compile I<afterimage>; resource I<blendType>.
167		177
168	=item B<-blr> I<HxV>	178	=item B<-blr> I<HxV>
169		179
170	Apply Gaussian Blur with the specified radii to the transparent	180	Apply Gaussian Blur with the specified radii to the transparent
171	background image. If single number is specified - both vertical and	181	background image. If single number is specified - both vertical and
172	horizontal radii are considered to be the same. Setting one of the	182	horizontal radii are considered to be the same. Setting one of the
173	radii to 1 and another to a large number creates interesting effects	183	radii to 1 and another to a large number creates interesting effects
174	on some backgrounds. Maximum radius value is 128; resource I<blurRadius>.	184	on some backgrounds. Maximum radius value is 128. Compile I<afterimage>;
		185	resource I<blurRadius>.
175		186
176	=item B<-bg> I<colour>	187	=item B<-bg> I<colour>
177		188
178	Window background colour; resource B<background>.	189	Window background colour; resource B<background>.
179		190
180	=item B<-fg> I<colour>	191	=item B<-fg> I<colour>
181		192
182	Window foreground colour; resource B<foreground>.	193	Window foreground colour; resource B<foreground>.
183		194
184	=item B<-pixmap> I<file[;geom]>	195	=item B<-pixmap> I<file[;geom[:op1][:op2][...]]>
185		196
186	Compile I<afterimage>: Specify image file for the background and also	197	Compile I<afterimage>: Specify image file for the background and also
187	optionally specify its scaling with a geometry string. Note you may need to	198	optionally specify its scaling with a geometry string. Note you may need to
188	add quotes to avoid special shell interpretation of the C<;> in the	199	add quotes to avoid special shell interpretation of the C<;> in the
189	command-line; for more details see resource B<backgroundPixmap>.	200	command-line; for more details see resource B<backgroundPixmap>.
190		201
191	=item B<-cr> I<colour>	202	=item B<-cr> I<colour>
…		…
239	italic> >> characters are to be printed. See resource B<boldItalicFont>	250	italic> >> characters are to be printed. See resource B<boldItalicFont>
240	for details.	251	for details.
241		252
242	=item B<-is>\|B<+is>	253	=item B<-is>\|B<+is>
243		254
244	Compile I<font-styles>: Bold/Italic font styles imply high intensity	255	Compile I<font-styles>: Bold/Blink font styles imply high intensity
245	foreground/background (default). See resource B<intensityStyles> for	256	foreground/background (default). See resource B<intensityStyles> for
246	details.	257	details.
247		258
248	=item B<-name> I<name>	259	=item B<-name> I<name>
249		260
…		…
267		278
268	=item B<-sb>\|B<+sb>	279	=item B<-sb>\|B<+sb>
269		280
270	Turn on/off scrollbar; resource B<scrollBar>.	281	Turn on/off scrollbar; resource B<scrollBar>.
271		282
		283	=item B<-sr>\|B<+sr>
		284
		285	Put scrollbar on right/left; resource B<scrollBar_right>.
		286
		287	=item B<-st>\|B<+st>
		288
		289	Display rxvt (non XTerm/NeXT) scrollbar without/with a trough;
		290	resource B<scrollBar_floating>.
		291
272	=item B<-si>\|B<+si>	292	=item B<-si>\|B<+si>
273		293
274	Turn on/off scroll-to-bottom on TTY output inhibit; resource	294	Turn on/off scroll-to-bottom on TTY output inhibit; resource
275	B<scrollTtyOutput> has opposite effect.	295	B<scrollTtyOutput> has opposite effect.
276		296
…		…
282	=item B<-sw>\|B<+sw>	302	=item B<-sw>\|B<+sw>
283		303
284	Turn on/off scrolling with the scrollback buffer as new lines appear.	304	Turn on/off scrolling with the scrollback buffer as new lines appear.
285	This only takes effect if B<-si> is also given; resource	305	This only takes effect if B<-si> is also given; resource
286	B<scrollWithBuffer>.	306	B<scrollWithBuffer>.
287
288	=item B<-sr>\|B<+sr>
289
290	Put scrollbar on right/left; resource B<scrollBar_right>.
291
292	=item B<-st>\|B<+st>
293
294	Display rxvt (non XTerm/NeXT) scrollbar without/with a trough;
295	resource B<scrollBar_floating>.
296		307
297	=item B<-ptab>\|B<+ptab>	308	=item B<-ptab>\|B<+ptab>
298		309
299	If enabled (default), "Horizontal Tab" characters are being stored as	310	If enabled (default), "Horizontal Tab" characters are being stored as
300	actual wide characters in the screen buffer, which makes it possible to	311	actual wide characters in the screen buffer, which makes it possible to
…		…
347		358
348	=item B<-lsp> I<number>	359	=item B<-lsp> I<number>
349		360
350	Compile I<frills>: Lines (pixel height) to insert between each row of	361	Compile I<frills>: Lines (pixel height) to insert between each row of
351	the display. Useful to work around font rendering problems; resource	362	the display. Useful to work around font rendering problems; resource
352	B<linespace>.	363	B<lineSpace>.
353		364
354	=item B<-tn> I<termname>	365	=item B<-tn> I<termname>
355		366
356	This option specifies the name of the terminal type to be set in the	367	This option specifies the name of the terminal type to be set in the
357	B<TERM> environment variable. This terminal type must exist in the	368	B<TERM> environment variable. This terminal type must exist in the
…		…
412		423
413	=item B<-tcw>	424	=item B<-tcw>
414		425
415	Change the meaning of triple-click selection with the left mouse	426	Change the meaning of triple-click selection with the left mouse
416	button. Only effective when the original (non-perl) selection code is	427	button. Only effective when the original (non-perl) selection code is
417	in-use. Instead of selecting a full line it will extend the selection the	428	in-use. Instead of selecting a full line it will extend the selection to
418	end of the logical line only. resource B<tripleclickwords>.	429	the end of the logical line only. resource B<tripleclickwords>.
419		430
420	=item B<-insecure>	431	=item B<-insecure>
421		432
422	Enable "insecure" mode, which currently enables most of the escape	433	Enable "insecure" mode, which currently enables most of the escape
423	sequences that echo strings. See the resource B<insecure> for more	434	sequences that echo strings. See the resource B<insecure> for more
…		…
443		454
444	Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@	455	Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@
445	will not immediately destroy its window when the program executed within	456	will not immediately destroy its window when the program executed within
446	it exits. Instead, it will wait till it is being killed or closed by the	457	it exits. Instead, it will wait till it is being killed or closed by the
447	user; resource B<hold>.	458	user; resource B<hold>.
		459
		460	=item B<-xrm> I<string>
		461
		462	Works like the X Toolkit option of the same name, by adding the I<string>
		463	as if it were specified in a resource file. Resource values specified this
		464	way take precedence over all other resource specifications.
		465
		466	Note that you need to use the I<same> syntax as in the .Xdefaults file,
		467	e.g. C<*.background: black>. Also note that all @@RXVT_NAME@@-specific
		468	options can be specified as long-options on the commandline, so use
		469	of B<-xrm> is mostly limited to cases where you want to specify other
		470	resources (e.g. for input methods) or for compatibility with other
		471	programs.
448		472
449	=item B<-keysym.>I<sym> I<string>	473	=item B<-keysym.>I<sym> I<string>
450		474
451	Remap a key symbol. See resource B<keysym>.	475	Remap a key symbol. See resource B<keysym>.
452		476
…		…
487	If this switch is given, @@RXVT_NAME@@ will not create any utmp/wtmp	511	If this switch is given, @@RXVT_NAME@@ will not create any utmp/wtmp
488	entries and will not tinker with pty/tty permissions - you have to do that	512	entries and will not tinker with pty/tty permissions - you have to do that
489	yourself if you want that.	513	yourself if you want that.
490		514
491	As an extremely special case, specifying C<-1> will completely suppress	515	As an extremely special case, specifying C<-1> will completely suppress
492	pty/tty operations.	516	pty/tty operations, which is probably only useful in conjunction with some
		517	perl extension that manages the terminal.
493		518
494	Here is a example in perl that illustrates how this option can be used (a	519	Here is a example in perl that illustrates how this option can be used (a
495	longer example is in F<doc/pty-fd>):	520	longer example is in F<doc/pty-fd>):
496		521
497	use IO::Pty;	522	use IO::Pty;
…		…
511	Comma-separated list of perl extension scripts to use (or not to use) in	536	Comma-separated list of perl extension scripts to use (or not to use) in
512	this terminal instance. See resource B<perl-ext> for details.	537	this terminal instance. See resource B<perl-ext> for details.
513		538
514	=back	539	=back
515		540
516	=head1 RESOURCES (available also as long-options)	541	=head1 RESOURCES
517		542
518	Note: `@@RXVT_NAME@@ --help' gives a list of all resources (long	543	Note: `@@RXVT_NAME@@ --help' gives a list of all resources (long
519	options) compiled into your version.	544	options) compiled into your version. All resources are also available as
		545	long-options.
520		546
521	You can set and change the resources using X11 tools like B<xrdb>. Many	547	You can set and change the resources using X11 tools like B<xrdb>. Many
522	distribution do also load settings from the B<~/.Xresources> file when X	548	distribution do also load settings from the B<~/.Xresources> file when X
523	starts. @@RXVT_NAME@@ will consult the following files/resources in order,	549	starts. @@RXVT_NAME@@ will consult the following files/resources in order,
524	with later settings overwriting earlier ones:	550	with later settings overwriting earlier ones:
…		…
526	1. system-wide app-defaults file, either locale-dependent OR global	552	1. system-wide app-defaults file, either locale-dependent OR global
527	2. app-defaults file in $XAPPLRESDIR	553	2. app-defaults file in $XAPPLRESDIR
528	3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults	554	3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults
529	4. SCREEN_RESOURCES for the current screen	555	4. SCREEN_RESOURCES for the current screen
530	5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename>	556	5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename>
		557	6. resources specified via -xrm on the commandline
531		558
532	Note that when reading X resources, B<@@RXVT_NAME@@> recognizes two class	559	Note that when reading X resources, B<@@RXVT_NAME@@> recognizes two class
533	names: B<Rxvt> and B<URxvt>. The class name B<Rxvt> allows resources	560	names: B<Rxvt> and B<URxvt>. The class name B<Rxvt> allows resources
534	common to both B<@@RXVT_NAME@@> and the original I<rxvt> to be easily	561	common to both B<@@RXVT_NAME@@> and the original I<rxvt> to be easily
535	configured, while the class name B<URxvt> allows resources unique to	562	configured, while the class name B<URxvt> allows resources unique to
…		…
637		664
638	B<False>: specify that everything is to be displayed, even	665	B<False>: specify that everything is to be displayed, even
639	if the refresh is too fast for the human eye to read anything (or the	666	if the refresh is too fast for the human eye to read anything (or the
640	monitor to display anything); option B<+ss>.	667	monitor to display anything); option B<+ss>.
641		668
642	=item B<inheritPixmap:> I<boolean>	669	=item B<transparent:> I<boolean>
643		670
644	B<True>: make the background inherit the parent windows' pixmap, giving	671	Turn on/off illusion of a transparent window background.
645	artificial transparency. B<False>: do not inherit the parent windows'
646	pixmap.
647		672
648	I<Please note that transparency of any kind if completely unsupported by	673	B<inheritPixmap> is still accepted as an obsolete alias but will be removed in
649	the author. Don't bug him with installation questions!>	674	future versions.
		675
		676	I<Please address all transparency related issues to Sasha Vasko at
		677	sasha@aftercode.net. Read the FAQ (man 7 @@RXVT_NAME@@)!>
650		678
651	=item B<fading:> I<number>	679	=item B<fading:> I<number>
652		680
653	Fade the text by the given percentage when focus is lost; option B<-fade>.	681	Fade the text by the given percentage when focus is lost; option B<-fade>.
654		682
…		…
671		699
672	Specify background blending type; option B<-blt>.	700	Specify background blending type; option B<-blt>.
673		701
674	=item B<blurRadius:> I<number>	702	=item B<blurRadius:> I<number>
675		703
676	Apply Gaussian Blurr with the specified radius to the transparent	704	Apply Gaussian Blurr with the specified radius to the transparent
677	background image; option B<-blr>.	705	background image; option B<-blr>.
678		706
679	=item B<scrollColor:> I<colour>	707	=item B<scrollColor:> I<colour>
680		708
681	Use the specified colour for the scrollbar [default #B2B2B2].	709	Use the specified colour for the scrollbar [default #B2B2B2].
…		…
688	=item B<borderColor:> I<colour>	716	=item B<borderColor:> I<colour>
689		717
690	The colour of the border around the text area and between the scrollbar	718	The colour of the border around the text area and between the scrollbar
691	and the text.	719	and the text.
692		720
693	=item B<backgroundPixmap:> I<file[;geom]>	721	=item B<backgroundPixmap:> I<file[;geom[:op1][:op2][...]]>
694		722
695	Use the specified image file for the background and also optionally	723	Use the specified image file for the background and also
696	specify its scaling with a geometry string B<WxH+X+Y>,	724	optionally specify its scaling with a geometry string B<WxH+X+Y>,
697	in which B<"W" / "H"> specify the horizontal/vertical scale (percent),	725	(default C<0x0+50+50>) in which B<"W" / "H"> specify the
698	and B<"X" / "Y"> locate the image centre (percent).	726	horizontal/vertical scale (percent), and B<"X" / "Y"> locate the image
699	A scale of 0 displays the image with tiling. A scale of 1 displays the	727	centre (percent). A scale of 0 displays the image with tiling. A scale
700	image without any scaling. A scale of 2 to 9 specifies an integer	728	of 1 displays the image without any scaling. A scale of 2 to 9 specifies
701	number of images in that direction. No image will be magnified beyond	729	an integer number of images in that direction. No image will be magnified
702	10 times its original size. The maximum permitted scale is 1000.	730	beyond 10 times its original size. The maximum permitted scale is 1000.
703	Special string of B<"auto"> used as a geometry will cause image to be	731	Additional operations can be specified after colon B<:op1:op2...>.
704	automatically scaled to match window size.	732	Supported operations are:
		733
		734	tile force background image to be tiled and not scaled. Equivalent to 0x0
		735	propscale will scale image keeping proportions
		736	auto will scale image to match window size. Equivalent to 100x100
		737	hscale will scale image horizontally to the window size
		738	vscale will scale image vertically to the window size
		739	scale will scale image to match window size
		740	root will tile image as if it was a root window background, auto-adjusting
		741	whenever terminal window moves
		742
705	If used in conjunction with B<-tr> option - specified pixmap will be	743	If used in conjunction with B<-tr> option, the specified pixmap will be
706	blended over transparency image using either alpha-blending, or any	744	blended over transparency image using either alpha-blending, or any
707	other blending type, specified with B<-blt "type"> option.	745	other blending type, specified with B<-blt "type"> option.
708	[default 0x0+50+50]
709		746
710	=item B<path:> I<path>	747	=item B<path:> I<path>
711		748
712	Specify the colon-delimited search path for finding XPM files.	749	Specify the colon-delimited search path for finding background image files.
713		750
714	=item B<font:> I<fontlist>	751	=item B<font:> I<fontlist>
715		752
716	Select the fonts to be used. This is a comma separated list of font names	753	Select the fonts to be used. This is a comma separated list of font names
717	that are checked in order when trying to find glyphs for characters. The	754	that are checked in order when trying to find glyphs for characters. The
…		…
774	text font will being used for the given style.	811	text font will being used for the given style.
775		812
776	=item B<intensityStyles:> I<boolean>	813	=item B<intensityStyles:> I<boolean>
777		814
778	When font styles are not enabled, or this option is enabled (B<True>,	815	When font styles are not enabled, or this option is enabled (B<True>,
779	option B<-is>, the default), bold and italic font styles imply high	816	option B<-is>, the default), bold/blink font styles imply high
780	intensity foreground/background colours. Disabling this option (B<False>,	817	intensity foreground/background colours. Disabling this option (B<False>,
781	option B<+is>) disables this behaviour, the high intensity colours are not	818	option B<+is>) disables this behaviour, the high intensity colours are not
782	reachable.	819	reachable.
783		820
784	=item B<selectstyle:> I<mode>
785
786	Set mouse selection style to B<old> which is 2.20, B<oldword> which
787	is xterm style with 2.20 old word selection, or anything else which
788	gives xterm style selection. Only effective when the original (non-perl)
789	selection code is in use.
790
791	=item B<scrollstyle:> I<mode>
792
793	Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is
794	the author's favourite.
795
796	=item B<title:> I<string>	821	=item B<title:> I<string>
797		822
798	Set window title string, the default title is the command-line	823	Set window title string, the default title is the command-line
799	specified after the B<-e> option, if any, otherwise the application	824	specified after the B<-e> option, if any, otherwise the application
800	name; option B<-title>.	825	name; option B<-title>.
…		…
844		869
845	URxvt.print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX)	870	URxvt.print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX)
846		871
847	This creates a new file in your home directory with the screen contents	872	This creates a new file in your home directory with the screen contents
848	every time you hit C<Print>.	873	every time you hit C<Print>.
		874
		875	=item B<scrollstyle:> I<mode>
		876
		877	Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is
		878	the author's favourite.
849		879
850	=item B<scrollBar:> I<boolean>	880	=item B<scrollBar:> I<boolean>
851		881
852	B<True>: enable the scrollbar [default]; option B<-sb>. B<False>:	882	B<True>: enable the scrollbar [default]; option B<-sb>. B<False>:
853	disable the scrollbar; option B<+sb>.	883	disable the scrollbar; option B<+sb>.
…		…
916	=item B<termName:> I<termname>	946	=item B<termName:> I<termname>
917		947
918	Specifies the terminal type name to be set in the B<TERM> environment	948	Specifies the terminal type name to be set in the B<TERM> environment
919	variable; option B<-tn>.	949	variable; option B<-tn>.
920		950
921	=item B<linespace:> I<number>	951	=item B<lineSpace:> I<number>
922		952
923	Specifies number of lines (pixel height) to insert between each row of	953	Specifies number of lines (pixel height) to insert between each row of
924	the display [default 0]; option B<-lsp>.	954	the display [default 0]; option B<-lsp>.
925		955
926	=item B<meta8:> I<boolean>	956	=item B<meta8:> I<boolean>
…		…
986	will be created). In this mode, characters outside ISO-8859-1 can be used.	1016	will be created). In this mode, characters outside ISO-8859-1 can be used.
987		1017
988	When the selection extension is not used, only ISO-8859-1 characters can	1018	When the selection extension is not used, only ISO-8859-1 characters can
989	be used. If not specified, the built-in default is used:	1019	be used. If not specified, the built-in default is used:
990		1020
991	B<< BACKSLASH `"'&()*,;<=>?@[]{\|} >>	1021	B<< BACKSLASH `"'&()*,;<=>?@[]^{\|} >>
992		1022
993	=item B<preeditType:> I<style>	1023	=item B<preeditType:> I<style>
994		1024
995	B<OverTheSpot>, B<OffTheSpot>, B<Root>; option B<-pt>.	1025	B<OverTheSpot>, B<OffTheSpot>, B<Root>; option B<-pt>.
996		1026
…		…
1084	searching keysym macros from B</usr/X11R6/include/X11/keysymdef.h> and	1114	searching keysym macros from B</usr/X11R6/include/X11/keysymdef.h> and
1085	omitting the prefix B<XK_>. Alternatively you can specify I<key> by its hex	1115	omitting the prefix B<XK_>. Alternatively you can specify I<key> by its hex
1086	keysym value (B<0x0000 - 0xFFFF>). Note that the lookup of I<sym>s is not	1116	keysym value (B<0x0000 - 0xFFFF>). Note that the lookup of I<sym>s is not
1087	performed in an exact manner; however, the closest match is assured.	1117	performed in an exact manner; however, the closest match is assured.
1088		1118
1089	I<string> may contain escape values (C<\a>: bell, C<\b>: backspace,	1119	I<string> may contain escape values (C<\n>: newline, C<\000>: octal
1090	C<\e>, C<\E>: escape, C<\n>: newline, C<\r>: carriage return, C<\t>: tab,	1120	number), see RESOURCES in C<man 7 X> for futher details.
1091	C<\000>: octal number) or verbatim control characters (C<^?>: delete,
1092	C<^@>: null, C<^A> ...) and may be enclosed with double quotes so that it
1093	can start or end with whitespace. B<This feature is deprecated and will
1094	be removed>.
1095
1096	Please note that you need to double the C<\> in resource files, as
1097	Xlib itself does its own de-escaping (you can use C<\033> instead of
1098	C<\e> (and so on), which will work with both Xt and @@RXVT_NAME@@'s own
1099	processing).
1100		1121
1101	You can define a range of keysyms in one shot by providing a I<string>	1122	You can define a range of keysyms in one shot by providing a I<string>
1102	with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimiter `/'	1123	with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimiter `/'
1103	should be a character not used by the strings.	1124	should be a character not used by the strings.
1104		1125
…		…
1440	=back	1461	=back
1441		1462
1442	=head2 ALPHA CHANNEL SUPPORT	1463	=head2 ALPHA CHANNEL SUPPORT
1443		1464
1444	If Xft support has been compiled in and as long as Xft/Xrender/X don't get	1465	If Xft support has been compiled in and as long as Xft/Xrender/X don't get
1445	their act together, rxvt-unicode will support C<rgba:rrrr/gggg/bbbb/aaaa>	1466	their act together, rxvt-unicode will do it's own alpha channel management:
1446	(recommended, but B<MUST> have 4 digits/component) colour specifications,	1467
1447	in addition to the ones provided by X, where the additional A component	1468	You can prefix any color with an opaquenes percentage enclosed in
		1469	brackets, i.e. C<[percent]>, where C<percent> is a decimal percentage
		1470	(0-100) that specifies the opacity of the color, where C<0> is completely
		1471	transparent and C<100> is completely opaque. For example, C<[50]red> is a
		1472	half-transparent red, while C<[95]#00ff00> is an almost opaque green. This
		1473	is the recommended format to specify transparency values, and works with
		1474	all ways to specify a colour.
		1475
		1476	For complete control, rxvt-unicode also supports
		1477	C<rgba:rrrr/gggg/bbbb/aaaa> (exactly four hex digits/component) colour
		1478	specifications, where the additional C<aaaa> component specifies opacity
1448	specifies opacity (alpha) values. The minimum value of C<0> is completely	1479	(alpha) values. The minimum value of C<0000> is completely transparent,
1449	transparent). You can also prefix any color with C<[percent]>, where	1480	while C<ffff> is completely opaque). The two example colours from
1450	C<percent> is a decimal percentage (0-100) that specifies the opacity of	1481	earlier could also be specified as C<rgba:ff00/0000/0000/8000> and
1451	the color, where C<0> is completely transparent and C<100> is completelxy	1482	C<rgba:0000/ff00/0000/f332>.
1452	opaque.
1453		1483
1454	You probably need to specify B<"-depth 32">, too, and have the luck that	1484	You probably need to specify B<"-depth 32">, too, to force a visual with
1455	your X-server uses ARGB pixel layout, as X is far from just supporting	1485	alpha channels, and have the luck that your X-server uses ARGB pixel
1456	ARGB visuals out of the box, and rxvt-unicode just fudges around.	1486	layout, as X is far from just supporting ARGB visuals out of the box, and
		1487	rxvt-unicode just fudges around.
1457		1488
1458	For example, the following selects an almost completely transparent red	1489	For example, the following selects an almost completely transparent black
1459	background, and an almost opaque pink foreground:	1490	background, and an almost opaque pink foreground:
1460		1491
1461	@@RXVT_NAME@@ -depth 32 -bg rgba:0000/0000/0000/aaaa -fg "[80]pink"	1492	@@RXVT_NAME@@ -depth 32 -bg rgba:0000/0000/0000/4444 -fg "[80]pink"
1462		1493
1463	I<Please note that transparency of any kind if completely unsupported by	1494	When not using a background image, then the interpretation of the
1464	the author. Don't bug him with installation questions!>	1495	alpha channel is up to your compositing manager (most interpret it as
		1496	transparency of course).
		1497
		1498	When using a background pixmap or pseudo-transparency, then the background
		1499	colour will always behave as if it were completely transparent (so the
		1500	background image shows instead), regardless of how it was specified, while
		1501	other colours will either be transparent as specified (the background
		1502	image will show through) on servers supporting the RENDER extension, or
		1503	fully opaque on servers not supporting the RENDER EXTENSION.
		1504
		1505	Please note that due to bugs in Xft, specifying alpha values might result
		1506	in garbage being displayed when the X-server does not support the RENDER
		1507	extension.
1465		1508
1466	=head1 ENVIRONMENT	1509	=head1 ENVIRONMENT
1467		1510
1468	B<@@RXVT_NAME@@> sets and/or uses the following environment variables:	1511	B<@@RXVT_NAME@@> sets and/or uses the following environment variables:
1469		1512
…		…
1475	resources or on the command line.	1518	resources or on the command line.
1476		1519
1477	=item B<COLORTERM>	1520	=item B<COLORTERM>
1478		1521
1479	Either C<rxvt>, C<rxvt-xpm>, depending on whether @@RXVT_NAME@@ was	1522	Either C<rxvt>, C<rxvt-xpm>, depending on whether @@RXVT_NAME@@ was
1480	compiled with XPM support, and optionally with the added extension	1523	compiled with background image support, and optionally with the added
1481	C<-mono> to indicate that rxvt-unicode runs on a monochrome screen.	1524	extension C<-mono> to indicate that rxvt-unicode runs on a monochrome
		1525	screen.
1482		1526
1483	=item B<COLORFGBG>	1527	=item B<COLORFGBG>
1484		1528
1485	Set to a string of the form C<fg;bg> or C<fg;xpm;bg>, where C<fg> is	1529	Set to a string of the form C<fg;bg> or C<fg;xpm;bg>, where C<fg> is
1486	the colour code used as default foreground/text colour (or the string	1530	the colour code used as default foreground/text colour (or the string
1487	C<default> to indicate that the default-colour escape sequence is to be	1531	C<default> to indicate that the default-colour escape sequence is to be
1488	used), C<bg> is the colour code used as default background colour (or the	1532	used), C<bg> is the colour code used as default background colour (or the
1489	string C<default>), and C<xpm> is the string C<default> if @@RXVT_NAME@@	1533	string C<default>), and C<xpm> is the string C<default> if @@RXVT_NAME@@
1490	was compiled with XPM support. Libraries like C<ncurses> and C<slang> can	1534	was compiled with background image support. Libraries like C<ncurses>
1491	(and do) use this information to optimize screen output.	1535	and C<slang> can (and do) use this information to optimize screen output.
1492		1536
1493	=item B<WINDOWID>	1537	=item B<WINDOWID>
1494		1538
1495	Set to the (decimal) X Window ID of the @@RXVT_NAME@@ window (the toplevel	1539	Set to the (decimal) X Window ID of the @@RXVT_NAME@@ window (the toplevel
1496	window, which usually has subwindows for the scrollbar, the terminal	1540	window, which usually has subwindows for the scrollbar, the terminal
…		…
1587	Project Coordinator (changes.txt 2.21a to 2.4.5)	1631	Project Coordinator (changes.txt 2.21a to 2.4.5)
1588		1632
1589	=item Geoff Wing L<< <gcw@pobox.com> >>	1633	=item Geoff Wing L<< <gcw@pobox.com> >>
1590		1634
1591	Rewrote screen display and text selection routines.	1635	Rewrote screen display and text selection routines.
1592		1636
1593	Project Coordinator (changes.txt 2.4.6 - rxvt-unicode)	1637	Project Coordinator (changes.txt 2.4.6 - rxvt-unicode)
1594		1638
1595	=item Marc Alexander Lehmann L<< <rxvt-unicode@schmorp.de> >>	1639	=item Marc Alexander Lehmann L<< <rxvt-unicode@schmorp.de> >>
1596		1640
1597	Forked rxvt-unicode, unicode support, rewrote almost all the code, perl	1641	Forked rxvt-unicode, unicode support, rewrote almost all the code, perl

Diff Legend

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

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents): Revision 1.134 by sasha, Tue Jul 31 22:23:56 2007 UTC vs. Revision 1.160 by root, Fri Jan 25 18:42:23 2008 UTC

Diff Legend

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents):
Revision 1.134 by sasha, Tue Jul 31 22:23:56 2007 UTC vs.
Revision 1.160 by root, Fri Jan 25 18:42:23 2008 UTC