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

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents):
Revision 1.150 by root, Fri Dec 7 16:14:26 2007 UTC vs.
Revision 1.185 by sf-exg, Mon Oct 4 07:18:23 2010 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
…		…
89		92
90	Print out a message describing available options.	93	Print out a message describing available options.
91		94
92	=item B<-display> I<displayname>	95	=item B<-display> I<displayname>
93		96
94	Attempt to open a window on the named X display (B<-d> still	97	Attempt to open a window on the named X display (the older form B<-d>
95	respected). In the absence of this option, the display specified by the	98	is still respected. but deprecated). In the absence of this option, the
96	B<DISPLAY> environment variable is used.	99	display specified by the B<DISPLAY> environment variable is used.
97		100
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>.
		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]
102		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
…		…
144	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
145	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.
146	Please note that certain tint colours can be applied on the server-side,	154	Please note that certain tint colours can be applied on the server-side,
147	thus yielding performance gain of two orders of magnitude. These colours are:	155	thus yielding performance gain of two orders of magnitude. These colours are:
148	blue, red, green, cyan, magenta, yellow, and those close to them. Also	156	blue, red, green, cyan, magenta, yellow, and those close to them. Also
149	pure black and pure white colors essentially mean no tinting; resource	157	pure black and pure white colours essentially mean no tinting; resource
150	I<tintColor>. Example:	158	I<tintColor>. Example:
151		159
152	@@RXVT_NAME@@ -tr -tint blue -sh 40	160	@@RXVT_NAME@@ -tr -tint blue -sh 40
153		161
154	=item B<-sh> I<number>	162	=item B<-sh> I<number>
…		…
160	=item B<-blt> I<string>	168	=item B<-blt> I<string>
161		169
162	Specify background blending type. If background pixmap is specified	170	Specify background blending type. If background pixmap is specified
163	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
164	transparency image, using method specified. Supported values are :	172	transparency image, using method specified. Supported values are :
165	B<add>, B<alphablend>, B<allanon> - color values averaging, B<colorize>,	173	B<add>, B<alphablend>, B<allanon> - colour values averaging, B<colorize>,
166	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>,
167	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
168	alpha-blending. Compile I<afterimage>; resource I<blendType>.	176	alpha-blending. Compile I<afterimage>; resource I<blendType>.
169		177
170	=item B<-blr> I<HxV>	178	=item B<-blr> I<HxV>
…		…
174	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
175	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
176	on some backgrounds. Maximum radius value is 128. Compile I<afterimage>;	184	on some backgrounds. Maximum radius value is 128. Compile I<afterimage>;
177	resource I<blurRadius>.	185	resource I<blurRadius>.
178		186
		187	=item B<-icon> I<file>
		188
		189	Compile I<afterimage> or I<pixbuf>: Use the specified image as application icon. This
		190	is used by many window managers, taskbars and pagers to represent the
		191	application window; resource I<iconFile>.
		192
179	=item B<-bg> I<colour>	193	=item B<-bg> I<colour>
180		194
181	Window background colour; resource B<background>.	195	Window background colour; resource B<background>.
182		196
183	=item B<-fg> I<colour>	197	=item B<-fg> I<colour>
184		198
185	Window foreground colour; resource B<foreground>.	199	Window foreground colour; resource B<foreground>.
186		200
187	=item B<-pixmap> I<file[;geom[:op1][:op2][...]]>	201	=item B<-pixmap> I<file[;geom[:op1][:op2][...]]>
188		202
189	Compile I<afterimage>: Specify image file for the background and also	203	Compile I<afterimage> or I<pixbuf>: Specify image file for the background and also
190	optionally specify its scaling with a geometry string. Note you may need to	204	optionally specify its scaling with a geometry string. Note you may need to
191	add quotes to avoid special shell interpretation of the C<;> in the	205	add quotes to avoid special shell interpretation of the C<;> in the
192	command-line; for more details see resource B<backgroundPixmap>.	206	command-line; for more details see resource B<backgroundPixmap>.
193		207
194	=item B<-cr> I<colour>	208	=item B<-cr> I<colour>
…		…
242	italic> >> characters are to be printed. See resource B<boldItalicFont>	256	italic> >> characters are to be printed. See resource B<boldItalicFont>
243	for details.	257	for details.
244		258
245	=item B<-is>\|B<+is>	259	=item B<-is>\|B<+is>
246		260
247	Compile I<font-styles>: Bold/Italic font styles imply high intensity	261	Compile I<font-styles>: Bold/Blink font styles imply high intensity
248	foreground/background (default). See resource B<intensityStyles> for	262	foreground/background (default). See resource B<intensityStyles> for
249	details.	263	details.
250		264
251	=item B<-name> I<name>	265	=item B<-name> I<name>
252		266
…		…
270		284
271	=item B<-sb>\|B<+sb>	285	=item B<-sb>\|B<+sb>
272		286
273	Turn on/off scrollbar; resource B<scrollBar>.	287	Turn on/off scrollbar; resource B<scrollBar>.
274		288
		289	=item B<-sr>\|B<+sr>
		290
		291	Put scrollbar on right/left; resource B<scrollBar_right>.
		292
		293	=item B<-st>\|B<+st>
		294
		295	Display rxvt (non XTerm/NeXT) scrollbar without/with a trough;
		296	resource B<scrollBar_floating>.
		297
275	=item B<-si>\|B<+si>	298	=item B<-si>\|B<+si>
276		299
277	Turn on/off scroll-to-bottom on TTY output inhibit; resource	300	Turn on/off scroll-to-bottom on TTY output inhibit; resource
278	B<scrollTtyOutput> has opposite effect.	301	B<scrollTtyOutput> has opposite effect.
279		302
…		…
285	=item B<-sw>\|B<+sw>	308	=item B<-sw>\|B<+sw>
286		309
287	Turn on/off scrolling with the scrollback buffer as new lines appear.	310	Turn on/off scrolling with the scrollback buffer as new lines appear.
288	This only takes effect if B<-si> is also given; resource	311	This only takes effect if B<-si> is also given; resource
289	B<scrollWithBuffer>.	312	B<scrollWithBuffer>.
290
291	=item B<-sr>\|B<+sr>
292
293	Put scrollbar on right/left; resource B<scrollBar_right>.
294
295	=item B<-st>\|B<+st>
296
297	Display rxvt (non XTerm/NeXT) scrollbar without/with a trough;
298	resource B<scrollBar_floating>.
299		313
300	=item B<-ptab>\|B<+ptab>	314	=item B<-ptab>\|B<+ptab>
301		315
302	If enabled (default), "Horizontal Tab" characters are being stored as	316	If enabled (default), "Horizontal Tab" characters are being stored as
303	actual wide characters in the screen buffer, which makes it possible to	317	actual wide characters in the screen buffer, which makes it possible to
…		…
307		321
308	=item B<-bc>\|B<+bc>	322	=item B<-bc>\|B<+bc>
309		323
310	Blink the cursor; resource B<cursorBlink>.	324	Blink the cursor; resource B<cursorBlink>.
311		325
		326	=item B<-uc>\|B<+uc>
		327
		328	Make the cursor underlined; resource B<cursorUnderline>.
		329
312	=item B<-iconic>	330	=item B<-iconic>
313		331
314	Start iconified, if the window manager supports that option.	332	Start iconified, if the window manager supports that option.
315	Alternative form is B<-ic>.	333	Alternative form is B<-ic>.
316		334
…		…
332		350
333	=item B<-bl>	351	=item B<-bl>
334		352
335	Compile I<frills>: Set MWM hints to request a borderless window, i.e.	353	Compile I<frills>: Set MWM hints to request a borderless window, i.e.
336	if honoured by the WM, the rxvt-unicode window will not have window	354	if honoured by the WM, the rxvt-unicode window will not have window
337	decorations; resource B<borderLess>.	355	decorations; resource B<borderLess>. If the window manager does not
		356	support MWM hints (e.g. kwin), enables override-redirect mode.
338		357
339	=item B<-override-redirect>	358	=item B<-override-redirect>
340		359
341	Compile I<frills>: Sets override-redirect on the window; resource	360	Compile I<frills>: Sets override-redirect on the window; resource
342	B<override-redirect>.	361	B<override-redirect>.
…		…
351	=item B<-lsp> I<number>	370	=item B<-lsp> I<number>
352		371
353	Compile I<frills>: Lines (pixel height) to insert between each row of	372	Compile I<frills>: Lines (pixel height) to insert between each row of
354	the display. Useful to work around font rendering problems; resource	373	the display. Useful to work around font rendering problems; resource
355	B<lineSpace>.	374	B<lineSpace>.
		375
		376	=item B<-letsp> I<number>
		377
		378	Compile I<frills>: Amount to adjust the computed character width by
		379	to control overall letter spacing. Negative values will tighten up the
		380	letter spacing, positive values will space letters out more. Useful to
		381	work around odd font metrics; resource B<letterSpace>.
356		382
357	=item B<-tn> I<termname>	383	=item B<-tn> I<termname>
358		384
359	This option specifies the name of the terminal type to be set in the	385	This option specifies the name of the terminal type to be set in the
360	B<TERM> environment variable. This terminal type must exist in the	386	B<TERM> environment variable. This terminal type must exist in the
…		…
447	Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@	473	Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@
448	will not immediately destroy its window when the program executed within	474	will not immediately destroy its window when the program executed within
449	it exits. Instead, it will wait till it is being killed or closed by the	475	it exits. Instead, it will wait till it is being killed or closed by the
450	user; resource B<hold>.	476	user; resource B<hold>.
451		477
		478	=item B<-cd> I<path>
		479
		480	Sets the working directory for the shell (or the command specified via
		481	B<-e>). The I<path> must be an absolute path and it must exist for
		482	@@RXVT_NAME@@ to start; resource B<chdir>.
		483
452	=item B<-xrm> I<string>	484	=item B<-xrm> I<string>
453		485
454	Works like the X Toolkit option of the same name, by adding the I<string>	486	Works like the X Toolkit option of the same name, by adding the I<string>
455	as if it were specified in a resource file. Resource values specified this	487	as if it were specified in a resource file. Resource values specified this
456	way take precedence over all other resource specifications.	488	way take precedence over all other resource specifications.
…		…
503	If this switch is given, @@RXVT_NAME@@ will not create any utmp/wtmp	535	If this switch is given, @@RXVT_NAME@@ will not create any utmp/wtmp
504	entries and will not tinker with pty/tty permissions - you have to do that	536	entries and will not tinker with pty/tty permissions - you have to do that
505	yourself if you want that.	537	yourself if you want that.
506		538
507	As an extremely special case, specifying C<-1> will completely suppress	539	As an extremely special case, specifying C<-1> will completely suppress
508	pty/tty operations.	540	pty/tty operations, which is probably only useful in conjunction with some
		541	perl extension that manages the terminal.
509		542
510	Here is a example in perl that illustrates how this option can be used (a	543	Here is a example in perl that illustrates how this option can be used (a
511	longer example is in F<doc/pty-fd>):	544	longer example is in F<doc/pty-fd>):
512		545
513	use IO::Pty;	546	use IO::Pty;
…		…
527	Comma-separated list of perl extension scripts to use (or not to use) in	560	Comma-separated list of perl extension scripts to use (or not to use) in
528	this terminal instance. See resource B<perl-ext> for details.	561	this terminal instance. See resource B<perl-ext> for details.
529		562
530	=back	563	=back
531		564
532	=head1 RESOURCES (available also as long-options)	565	=head1 RESOURCES
533		566
534	Note: `@@RXVT_NAME@@ --help' gives a list of all resources (long	567	Note: `@@RXVT_NAME@@ --help' gives a list of all resources (long
535	options) compiled into your version.	568	options) compiled into your version. All resources are also available as
		569	long-options.
536		570
537	You can set and change the resources using X11 tools like B<xrdb>. Many	571	You can set and change the resources using X11 tools like B<xrdb>. Many
538	distribution do also load settings from the B<~/.Xresources> file when X	572	distribution do also load settings from the B<~/.Xresources> file when X
539	starts. @@RXVT_NAME@@ will consult the following files/resources in order,	573	starts. @@RXVT_NAME@@ will consult the following files/resources in order,
540	with later settings overwriting earlier ones:	574	with later settings overwriting earlier ones:
…		…
562	=item B<depth:> I<bitdepth>	596	=item B<depth:> I<bitdepth>
563		597
564	Compile I<xft>: Attempt to find a visual with the given bit depth;	598	Compile I<xft>: Attempt to find a visual with the given bit depth;
565	option B<-depth>.	599	option B<-depth>.
566		600
		601	=item B<buffered:> I<boolean>
		602
		603	Compile I<xft>: Turn on/off double-buffering for xft (default enabled).
		604	On some card/driver combination enabling it slightly decreases
		605	performance, on most it greatly helps it. The slowdown is small, so it
		606	should normally be enabled.
		607
567	=item B<geometry:> I<geom>	608	=item B<geometry:> I<geom>
568		609
569	Create the window with the specified X window geometry [default 80x24];	610	Create the window with the specified X window geometry [default 80x24];
570	option B<-geometry>.	611	option B<-geometry>.
571		612
…		…
584	Use the specified colour for the colour value I<n>, where 0-7	625	Use the specified colour for the colour value I<n>, where 0-7
585	corresponds to low-intensity (normal) colours and 8-15 corresponds to	626	corresponds to low-intensity (normal) colours and 8-15 corresponds to
586	high-intensity (bold = bright foreground, blink = bright background)	627	high-intensity (bold = bright foreground, blink = bright background)
587	colours. The canonical names are as follows: 0=black, 1=red, 2=green,	628	colours. The canonical names are as follows: 0=black, 1=red, 2=green,
588	3=yellow, 4=blue, 5=magenta, 6=cyan, 7=white, but the actual colour	629	3=yellow, 4=blue, 5=magenta, 6=cyan, 7=white, but the actual colour
589	names used are listed in the B<COLORS AND GRAPHICS> section.	630	names used are listed in the B<COLOURS AND GRAPHICS> section.
590		631
591	Colours higher than 15 cannot be set using resources (yet), but can be	632	Colours higher than 15 cannot be set using resources (yet), but can be
592	changed using an escape command (see @@RXVT_NAME@@(7)).	633	changed using an escape command (see @@RXVT_NAME@@(7)).
593		634
594	Colours 16-79 form a standard 4x4x4 colour cube (the same as xterm with	635	Colours 16-79 form a standard 4x4x4 colour cube (the same as xterm with
…		…
605	=item B<colorUL:> I<colour>	646	=item B<colorUL:> I<colour>
606		647
607	Use the specified colour to display underlined characters when the	648	Use the specified colour to display underlined characters when the
608	foreground colour is the default.	649	foreground colour is the default.
609		650
610	=item B<colorRV:> I<colour>
611
612	Use the specified colour as the background for reverse video characters
613	when OPTION_HC is disabled (--disable-frills).
614
615	=item B<underlineColor:> I<colour>	651	=item B<underlineColor:> I<colour>
616		652
617	If set, use the specified colour as the colour for the underline	653	If set, use the specified colour as the colour for the underline
618	itself. If unset, use the foreground colour.	654	itself. If unset, use the foreground colour.
		655
		656	=item B<highlightColor:> I<colour>
		657
		658	If set, use the specified colour as the background for highlighted
		659	characters. If unset, use reverse video.
		660
		661	=item B<highlightTextColor:> I<colour>
		662
		663	If set and highlightColor is set, use the specified colour as the
		664	foreground for highlighted characters.
619		665
620	=item B<cursorColor:> I<colour>	666	=item B<cursorColor:> I<colour>
621		667
622	Use the specified colour for the cursor. The default is to use the	668	Use the specified colour for the cursor. The default is to use the
623	foreground colour; option B<-cr>.	669	foreground colour; option B<-cr>.
…		…
630		676
631	=item B<reverseVideo:> I<boolean>	677	=item B<reverseVideo:> I<boolean>
632		678
633	B<True>: simulate reverse video by foreground and background colours;	679	B<True>: simulate reverse video by foreground and background colours;
634	option B<-rv>. B<False>: regular screen colours [default]; option	680	option B<-rv>. B<False>: regular screen colours [default]; option
635	B<+rv>. See note in B<COLORS AND GRAPHICS> section.	681	B<+rv>. See note in B<COLOURS AND GRAPHICS> section.
636		682
637	=item B<jumpScroll:> I<boolean>	683	=item B<jumpScroll:> I<boolean>
638		684
639	B<True>: specify that jump scrolling should be used. When receiving lots	685	B<True>: specify that jump scrolling should be used. When receiving lots
640	of lines, @@RXVT_NAME@@ will only scroll once a whole screen height of lines	686	of lines, @@RXVT_NAME@@ will only scroll once a whole screen height of lines
…		…
689		735
690	Specify background blending type; option B<-blt>.	736	Specify background blending type; option B<-blt>.
691		737
692	=item B<blurRadius:> I<number>	738	=item B<blurRadius:> I<number>
693		739
694	Apply Gaussian Blurr with the specified radius to the transparent	740	Apply gaussian blur with the specified radius to the transparent
695	background image; option B<-blr>.	741	background image; option B<-blr>.
		742
		743	=item B<iconFile:> I<file>
		744
		745	Set the application icon pixmap; option B<-icon>.
696		746
697	=item B<scrollColor:> I<colour>	747	=item B<scrollColor:> I<colour>
698		748
699	Use the specified colour for the scrollbar [default #B2B2B2].	749	Use the specified colour for the scrollbar [default #B2B2B2].
700		750
…		…
710		760
711	=item B<backgroundPixmap:> I<file[;geom[:op1][:op2][...]]>	761	=item B<backgroundPixmap:> I<file[;geom[:op1][:op2][...]]>
712		762
713	Use the specified image file for the background and also	763	Use the specified image file for the background and also
714	optionally specify its scaling with a geometry string B<WxH+X+Y>,	764	optionally specify its scaling with a geometry string B<WxH+X+Y>,
715	(default C<0x0+50+50>) in which B<"W" / "H"> specify the	765	(default C<100x100+50+50>) in which B<"W" / "H"> specify the
716	horizontal/vertical scale (percent), and B<"X" / "Y"> locate the image	766	horizontal/vertical scale (percent), and B<"X" / "Y"> locate the image
717	centre (percent). A scale of 0 displays the image with tiling. A scale	767	centre (percent). A scale of 0 displays the image with tiling.
718	of 1 displays the image without any scaling. A scale of 2 to 9 specifies	768	The maximum permitted scale is 1000.
719	an integer number of images in that direction. No image will be magnified
720	beyond 10 times its original size. The maximum permitted scale is 1000.
721	Additional operations can be specified after colon B<:op1:op2...>.	769	Additional operations can be specified after colon B<:op1:op2...>.
722	Supported operations are:	770	Supported operations are:
723		771
724	tile force background image to be tiled and not scaled. Equivalent to 0x0,	772	tile force background image to be tiled and not scaled. Equivalent to 0x0
725	propscale will scale image keeping proportions,	773	propscale will scale image keeping proportions
726	auto will scale image to match window size. Equivalent to 100x100;	774	auto will scale image to match window size. Equivalent to 100x100
727	hscale will scale image horizontally to the window size;	775	hscale will scale image horizontally to the window size
728	vscale will scale image vertically to the window size;	776	vscale will scale image vertically to the window size
729	scale will scale image to match window size;	777	scale will scale image to match window size
730	root will tile image as if it was a root window background, auto-adjusting	778	root will tile image as if it was a root window background, auto-adjusting
731	whenever terminal window moves.	779	whenever terminal window moves
732		780
733	If used in conjunction with B<-tr> option, the specified pixmap will be	781	If used in conjunction with B<-tr> option, the specified pixmap will be
734	blended over transparency image using either alpha-blending, or any	782	blended over transparency image using either alpha-blending, or any
735	other blending type, specified with B<-blt "type"> option.	783	other blending type, specified with B<-blt "type"> option.
736		784
…		…
767	it is named first) and thus defines the character cell grid to be 9 pixels	815	it is named first) and thus defines the character cell grid to be 9 pixels
768	wide and 15 pixels high.	816	wide and 15 pixels high.
769		817
770	The second font is just used to add additional unicode characters not in	818	The second font is just used to add additional unicode characters not in
771	the base font, likewise the third, which is unfortunately non-bold, but	819	the base font, likewise the third, which is unfortunately non-bold, but
772	the bold version of the font does contain less characters, so this is a	820	the bold version of the font does contain fewer characters, so this is a
773	useful supplement.	821	useful supplement.
774		822
775	The third font is an Xft font with aliasing turned off, and the characters	823	The third font is an Xft font with aliasing turned off, and the characters
776	are limited to the B<JIS 0208> codeset (i.e. japanese kanji). The font	824	are limited to the B<JIS 0208> codeset (i.e. japanese kanji). The font
777	contains other characters, but we are not interested in them.	825	contains other characters, but we are not interested in them.
…		…
801	text font will being used for the given style.	849	text font will being used for the given style.
802		850
803	=item B<intensityStyles:> I<boolean>	851	=item B<intensityStyles:> I<boolean>
804		852
805	When font styles are not enabled, or this option is enabled (B<True>,	853	When font styles are not enabled, or this option is enabled (B<True>,
806	option B<-is>, the default), bold and italic font styles imply high	854	option B<-is>, the default), bold/blink font styles imply high
807	intensity foreground/background colours. Disabling this option (B<False>,	855	intensity foreground/background colours. Disabling this option (B<False>,
808	option B<+is>) disables this behaviour, the high intensity colours are not	856	option B<+is>) disables this behaviour, the high intensity colours are not
809	reachable.	857	reachable.
810		858
811	=item B<selectstyle:> I<mode>
812
813	Set mouse selection style to B<old> which is 2.20, B<oldword> which
814	is xterm style with 2.20 old word selection, or anything else which
815	gives xterm style selection. Only effective when the original (non-perl)
816	selection code is in use.
817
818	=item B<scrollstyle:> I<mode>
819
820	Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is
821	the author's favourite.
822
823	=item B<title:> I<string>	859	=item B<title:> I<string>
824		860
825	Set window title string, the default title is the command-line	861	Set window title string, the default title is the command-line
826	specified after the B<-e> option, if any, otherwise the application	862	specified after the B<-e> option, if any, otherwise the application
827	name; option B<-title>.	863	name; option B<-title>.
…		…
840	=item B<urgentOnBell:> I<boolean>	876	=item B<urgentOnBell:> I<boolean>
841		877
842	B<True>: set the urgency hint for the wm on receipt of a bell character.	878	B<True>: set the urgency hint for the wm on receipt of a bell character.
843	B<False>: do not set the urgency hint [default].	879	B<False>: do not set the urgency hint [default].
844		880
		881	@@RXVT_NAME@@ resets the urgency hint on every focus change.
		882
845	=item B<visualBell:> I<boolean>	883	=item B<visualBell:> I<boolean>
846		884
847	B<True>: use visual bell on receipt of a bell character; option B<-vb>.	885	B<True>: use visual bell on receipt of a bell character; option B<-vb>.
848	B<False>: no visual bell [default]; option B<+vb>.	886	B<False>: no visual bell [default]; option B<+vb>.
849		887
…		…
871		909
872	URxvt.print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX)	910	URxvt.print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX)
873		911
874	This creates a new file in your home directory with the screen contents	912	This creates a new file in your home directory with the screen contents
875	every time you hit C<Print>.	913	every time you hit C<Print>.
		914
		915	=item B<scrollstyle:> I<mode>
		916
		917	Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is
		918	the author's favourite.
876		919
877	=item B<scrollBar:> I<boolean>	920	=item B<scrollBar:> I<boolean>
878		921
879	B<True>: enable the scrollbar [default]; option B<-sb>. B<False>:	922	B<True>: enable the scrollbar [default]; option B<-sb>. B<False>:
880	disable the scrollbar; option B<+sb>.	923	disable the scrollbar; option B<+sb>.
…		…
968	=item B<cursorBlink:> I<boolean>	1011	=item B<cursorBlink:> I<boolean>
969		1012
970	B<True>: blink the cursor. B<False>: do not blink the cursor [default];	1013	B<True>: blink the cursor. B<False>: do not blink the cursor [default];
971	option B<-bc>.	1014	option B<-bc>.
972		1015
		1016	=item B<cursorUnderline:> I<boolean>
		1017
		1018	B<True>: Make the cursor underlined. B<False>: Make the cursor a box [default];
		1019	option B<-uc>.
		1020
973	=item B<pointerBlank:> I<boolean>	1021	=item B<pointerBlank:> I<boolean>
974		1022
975	B<True>: blank the pointer when a key is pressed or after a set number	1023	B<True>: blank the pointer when a key is pressed or after a set number
976	of seconds of inactivity. B<False>: the pointer is always visible	1024	of seconds of inactivity. B<False>: the pointer is always visible
977	[default].	1025	[default].
…		…
990	large number (e.g. C<987654321>) to effectively disable the timeout.	1038	large number (e.g. C<987654321>) to effectively disable the timeout.
991		1039
992	=item B<backspacekey:> I<string>	1040	=item B<backspacekey:> I<string>
993		1041
994	The string to send when the backspace key is pressed. If set to B<DEC>	1042	The string to send when the backspace key is pressed. If set to B<DEC>
995	or unset it will send B<Delete> (code 127) or, if shifted, B<Backspace>	1043	or unset it will send B<Delete> (code 127) or, with control, B<Backspace>
996	(code 8) - which can be reversed with the appropriate DEC private mode	1044	(code 8) - which can be reversed with the appropriate DEC private mode
997	escape sequence.	1045	escape sequence.
998		1046
999	=item B<deletekey:> I<string>	1047	=item B<deletekey:> I<string>
1000		1048
…		…
1079		1127
1080	=item B<secondaryScroll:> I<boolean>	1128	=item B<secondaryScroll:> I<boolean>
1081		1129
1082	Turn on/off secondary screen scroll (default enabled). If this	1130	Turn on/off secondary screen scroll (default enabled). If this
1083	option is enabled, scrolls on the secondary screen will change the	1131	option is enabled, scrolls on the secondary screen will change the
1084	scrollback buffer and switching to/from the secondary screen will	1132	scrollback buffer and, when secondaryScreen is off, switching
1085	instead scroll the screen up.	1133	to/from the secondary screen will instead scroll the screen up.
1086		1134
1087	=item B<hold>: I<boolean>	1135	=item B<hold>: I<boolean>
1088		1136
1089	Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@	1137	Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@
1090	will not immediately destroy its window when the program executed within	1138	will not immediately destroy its window when the program executed within
1091	it exits. Instead, it will wait till it is being killed or closed by the	1139	it exits. Instead, it will wait till it is being killed or closed by the
1092	user.	1140	user.
		1141
		1142	=item B<chdir>: I<path>
		1143
		1144	Sets the working directory for the shell (or the command specified via
		1145	B<-e>). The I<path> must be an absolute path and it must exist for
		1146	@@RXVT_NAME@@ to start. If it isn't specified then the current working
		1147	directory will be used; option B<-cd>.
1093		1148
1094	=item B<keysym.>I<sym>: I<string>	1149	=item B<keysym.>I<sym>: I<string>
1095		1150
1096	Compile I<frills>: Associate I<string> with keysym I<sym>. The	1151	Compile I<frills>: Associate I<string> with keysym I<sym>. The
1097	intervening resource name B<keysym.> cannot be omitted.	1152	intervening resource name B<keysym.> cannot be omitted.
…		…
1112	omitting the prefix B<XK_>. Alternatively you can specify I<key> by its hex	1167	omitting the prefix B<XK_>. Alternatively you can specify I<key> by its hex
1113	keysym value (B<0x0000 - 0xFFFF>). Note that the lookup of I<sym>s is not	1168	keysym value (B<0x0000 - 0xFFFF>). Note that the lookup of I<sym>s is not
1114	performed in an exact manner; however, the closest match is assured.	1169	performed in an exact manner; however, the closest match is assured.
1115		1170
1116	I<string> may contain escape values (C<\n>: newline, C<\000>: octal	1171	I<string> may contain escape values (C<\n>: newline, C<\000>: octal
1117	number), see RESOURCES in C<man 7 X> for futher details.	1172	number), see RESOURCES in C<man 7 X> for further details.
1118		1173
1119	You can define a range of keysyms in one shot by providing a I<string>	1174	You can define a range of keysyms in one shot by providing a I<string>
1120	with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimiter `/'	1175	with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimiter `/'
1121	should be a character not used by the strings.	1176	should be a character not used by the strings.
1122		1177
…		…
1136	when Control-Meta-c is being pressed":	1191	when Control-Meta-c is being pressed":
1137		1192
1138	URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007	1193	URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007
1139		1194
1140	If I<string> takes the form C<perl:STRING>, then the specified B<STRING>	1195	If I<string> takes the form C<perl:STRING>, then the specified B<STRING>
1141	is passed to the C<on_keyboard_command> perl handler. See the @@RXVT_NAME@@perl(3)	1196	is passed to the C<on_user_command> perl handler. See the @@RXVT_NAME@@perl(3)
1142	manpage. For example, the F<selection> extension (activated via	1197	manpage. For example, the F<selection> extension (activated via
1143	C<@@RXVT_NAME@@ -pe selection>) listens for C<selection:rot13> events:	1198	C<@@RXVT_NAME@@ -pe selection>) listens for C<selection:rot13> events:
1144		1199
1145	URxvt.keysym.M-C-c: perl:selection:rot13	1200	URxvt.keysym.M-C-c: perl:selection:rot13
1146		1201
1147	Due the the large number of modifier combinations, a defined key mapping	1202	Due the the large number of modifier combinations, a defined key mapping
1148	will match if at I<at least> the specified identifiers are being set, and	1203	will match if I<at least> the specified identifiers are being set, and
1149	no other key mappings with those and more bits are being defined. That	1204	no other key mappings with those and more bits are being defined. That
1150	means that defining a key map for C<a> will automatically provide	1205	means that defining a key map for C<a> will automatically provide
1151	definitions for C<Meta-a>, C<Shift-a> and so on, unless some of those are defined	1206	definitions for C<Meta-a>, C<Shift-a> and so on, unless some of those are defined
1152	mappings themselves.	1207	mappings themselves.
1153		1208
…		…
1204	all instances, while B<perl-ext> is used for specific instances.	1259	all instances, while B<perl-ext> is used for specific instances.
1205		1260
1206	=item B<perl-eval>: I<string>	1261	=item B<perl-eval>: I<string>
1207		1262
1208	Perl code to be evaluated when all extensions have been registered. See	1263	Perl code to be evaluated when all extensions have been registered. See
1209	the @@RXVT_NAME@@perl(3) manpage. Due to security reasons, this resource	1264	the @@RXVT_NAME@@perl(3) manpage.
1210	will be ignored when running setuid/setgid.
1211		1265
1212	=item B<perl-lib>: I<path>	1266	=item B<perl-lib>: I<path>
1213		1267
1214	Colon-separated list of additional directories that hold extension	1268	Colon-separated list of additional directories that hold extension
1215	scripts. When looking for extensions specified by the C<perl> resource,	1269	scripts. When looking for extensions specified by the C<perl> resource,
1216	@@RXVT_NAME@@ will first look in these directories and then in	1270	@@RXVT_NAME@@ will first look in these directories and then in
1217	F<@@RXVT_LIBDIR@@/urxvt/perl/>. Due to security reasons, this resource	1271	F<@@RXVT_LIBDIR@@/urxvt/perl/>.
1218	will be ignored when running setuid/setgid.
1219		1272
1220	See the @@RXVT_NAME@@perl(3) manpage.	1273	See the @@RXVT_NAME@@perl(3) manpage.
1221		1274
1222	=item B<< selection.pattern-I<idx> >>: I<perl-regex>	1275	=item B<< selection.pattern-I<idx> >>: I<perl-regex>
1223		1276
…		…
1245		1298
1246	=item B<override-redirect>: I<boolean>	1299	=item B<override-redirect>: I<boolean>
1247		1300
1248	Compile I<frills>: Sets override-redirect for the terminal window, making	1301	Compile I<frills>: Sets override-redirect for the terminal window, making
1249	it almost invisible to window managers; option B<-override-redirect>.	1302	it almost invisible to window managers; option B<-override-redirect>.
		1303
		1304	=item B<iso14755:> I<boolean>
		1305
		1306	Turn on/off ISO 14755 (default enabled).
1250		1307
1251	=item B<iso14755_52:> I<boolean>	1308	=item B<iso14755_52:> I<boolean>
1252		1309
1253	Turn on/off ISO 14755 5.2 mode (default enabled).	1310	Turn on/off ISO 14755 5.2 mode (default enabled).
1254		1311
…		…
1397	B<@@RXVT_NAME@@> tries to write an entry into the I<utmp>(5) file so that	1454	B<@@RXVT_NAME@@> tries to write an entry into the I<utmp>(5) file so that
1398	it can be seen via the I<who(1)> command, and can accept messages. To	1455	it can be seen via the I<who(1)> command, and can accept messages. To
1399	allow this feature, B<@@RXVT_NAME@@> may need to be installed setuid root	1456	allow this feature, B<@@RXVT_NAME@@> may need to be installed setuid root
1400	on some systems or setgid to root or to some other group on others.	1457	on some systems or setgid to root or to some other group on others.
1401		1458
1402	=head1 COLORS AND GRAPHICS	1459	=head1 COLOURS AND GRAPHICS
1403		1460
1404	In addition to the default foreground and background colours,	1461	In addition to the default foreground and background colours,
1405	B<@@RXVT_NAME@@> can display up to 16 colours (8 ANSI colours plus	1462	B<@@RXVT_NAME@@> can display up to 88/256 colours: 8 ANSI colours plus
1406	high-intensity bold/blink versions of the same). Here is a list of the	1463	high-intensity (potentially bold/blink) versions of the same, and 72 (or
1407	colours with their names.	1464	240 in 256 colour mode) colours arranged in an 4x4x4 (or 6x6x6) colour RGB
		1465	cube plus a 8 (24) colour greyscale ramp.
		1466
		1467	Here is a list of the ANSI colours with their names.
1408		1468
1409	=begin table	1469	=begin table
1410		1470
1411	B<color0> (black) = Black	1471	B<color0> (black) = Black
1412	B<color1> (red) = Red3	1472	B<color1> (red) = Red3
…		…
1432	It is also possible to specify the colour values of B<foreground>,	1492	It is also possible to specify the colour values of B<foreground>,
1433	B<background>, B<cursorColor>, B<cursorColor2>, B<colorBD>, B<colorUL> as	1493	B<background>, B<cursorColor>, B<cursorColor2>, B<colorBD>, B<colorUL> as
1434	a number 0-15, as a convenient shorthand to reference the colour name of	1494	a number 0-15, as a convenient shorthand to reference the colour name of
1435	color0-color15.	1495	color0-color15.
1436		1496
1437	In addition to the colours defined above, @@RXVT_NAME@@ offers an	1497	The following text gives values for the standard 88 colour mode (and
1438	additional 72 colours. The first 64 of those (with indices 16 to 79)	1498	values for the 256 colour mode in parentheses).
1439	consist of a 444 RGB colour cube (i.e. I<index = r * 16 + g * 4 + b +
1440	16>), followed by 8 additional shades of gray (with indices 80 to 87).
1441		1499
		1500	The RGB cube uses indices 16..79 (16..231) using the following formulas:
		1501
		1502	index_88 = (r * 4 + g) * 4 + b + 16 # r, g, b = 0..3
		1503	index_256 = (r * 16 + g) * 16 + b + 16 # r, g, b = 0..15
		1504
		1505	The grayscale ramp uses indices 80..87 (232..239), from 10% to 90% in 10%
		1506	steps (1/26 to 25/26 in 1/26 steps) - black and white are already part of
		1507	the RGB cube.
		1508
1442	Together, all those colours implement the 88 colour xterm colours. Only	1509	Together, all those colours implement the 88 (256) colour xterm
1443	the first 16 can be changed using resources currently, the rest can only	1510	colours. Only the first 16 can be changed using resources currently, the
1444	be changed via command sequences ("escape codes").	1511	rest can only be changed via command sequences ("escape codes").
		1512
		1513	Applications are advised to use terminfo or command sequences to discover
		1514	number and RGB values of all colours (yes, you can query this...).
1445		1515
1446	Note that B<-rv> (B<"reverseVideo: True">) simulates reverse video by	1516	Note that B<-rv> (B<"reverseVideo: True">) simulates reverse video by
1447	always swapping the foreground/background colours. This is in contrast to	1517	always swapping the foreground/background colours. This is in contrast to
1448	I<xterm>(1) where the colours are only swapped if they have not otherwise	1518	I<xterm>(1) where the colours are only swapped if they have not otherwise
1449	been specified. For example,	1519	been specified. For example,
1450		1520
1451	=over 4
1452
1453	=item B<@@RXVT_NAME@@ -fg Black -bg White -rv>	1521	@@RXVT_NAME@@ -fg Black -bg White -rv
1454		1522
1455	would yield White on Black, while on I<xterm>(1) it would yield Black	1523	would yield White on Black, while on I<xterm>(1) it would yield Black on
1456	on White.	1524	White.
1457
1458	=back
1459		1525
1460	=head2 ALPHA CHANNEL SUPPORT	1526	=head2 ALPHA CHANNEL SUPPORT
1461		1527
1462	If Xft support has been compiled in and as long as Xft/Xrender/X don't get	1528	If Xft support has been compiled in and as long as Xft/Xrender/X don't get
1463	their act together, rxvt-unicode will support C<rgba:rrrr/gggg/bbbb/aaaa>	1529	their act together, rxvt-unicode will do it's own alpha channel management:
1464	(recommended, but B<MUST> have 4 digits/component) colour specifications,	1530
1465	in addition to the ones provided by X, where the additional A component	1531	You can prefix any colour with an opaqueness percentage enclosed in
		1532	brackets, i.e. C<[percent]>, where C<percent> is a decimal percentage
		1533	(0-100) that specifies the opacity of the colour, where C<0> is completely
		1534	transparent and C<100> is completely opaque. For example, C<[50]red> is a
		1535	half-transparent red, while C<[95]#00ff00> is an almost opaque green. This
		1536	is the recommended format to specify transparency values, and works with
		1537	all ways to specify a colour.
		1538
		1539	For complete control, rxvt-unicode also supports
		1540	C<rgba:rrrr/gggg/bbbb/aaaa> (exactly four hex digits/component) colour
		1541	specifications, where the additional C<aaaa> component specifies opacity
1466	specifies opacity (alpha) values. The minimum value of C<0> is completely	1542	(alpha) values. The minimum value of C<0000> is completely transparent,
1467	transparent). You can also prefix any color with C<[percent]>, where	1543	while C<ffff> is completely opaque). The two example colours from
1468	C<percent> is a decimal percentage (0-100) that specifies the opacity of	1544	earlier could also be specified as C<rgba:ff00/0000/0000/8000> and
1469	the color, where C<0> is completely transparent and C<100> is completelxy	1545	C<rgba:0000/ff00/0000/f332>.
1470	opaque.
1471		1546
1472	You probably need to specify B<"-depth 32">, too, and have the luck that	1547	You probably need to specify B<"-depth 32">, too, to force a visual with
1473	your X-server uses ARGB pixel layout, as X is far from just supporting	1548	alpha channels, and have the luck that your X-server uses ARGB pixel
1474	ARGB visuals out of the box, and rxvt-unicode just fudges around.	1549	layout, as X is far from just supporting ARGB visuals out of the box, and
		1550	rxvt-unicode just fudges around.
1475		1551
1476	For example, the following selects an almost completely transparent red	1552	For example, the following selects an almost completely transparent black
1477	background, and an almost opaque pink foreground:	1553	background, and an almost opaque pink foreground:
1478		1554
1479	@@RXVT_NAME@@ -depth 32 -bg rgba:0000/0000/0000/aaaa -fg "[80]pink"	1555	@@RXVT_NAME@@ -depth 32 -bg rgba:0000/0000/0000/4444 -fg "[80]pink"
1480		1556
1481	I<Please note that transparency of any kind if completely unsupported by	1557	When not using a background image, then the interpretation of the
1482	the author. Don't bug him with installation questions!>	1558	alpha channel is up to your compositing manager (most interpret it as
		1559	transparency of course).
		1560
		1561	When using a background pixmap or pseudo-transparency, then the background
		1562	colour will always behave as if it were completely transparent (so the
		1563	background image shows instead), regardless of how it was specified, while
		1564	other colours will either be transparent as specified (the background
		1565	image will show through) on servers supporting the RENDER extension, or
		1566	fully opaque on servers not supporting the RENDER EXTENSION.
		1567
		1568	Please note that due to bugs in Xft, specifying alpha values might result
		1569	in garbage being displayed when the X-server does not support the RENDER
		1570	extension.
1483		1571
1484	=head1 ENVIRONMENT	1572	=head1 ENVIRONMENT
1485		1573
1486	B<@@RXVT_NAME@@> sets and/or uses the following environment variables:	1574	B<@@RXVT_NAME@@> sets and/or uses the following environment variables:
1487		1575
…		…
1521	C<--with-terminfo=PATH>.	1609	C<--with-terminfo=PATH>.
1522		1610
1523	=item B<DISPLAY>	1611	=item B<DISPLAY>
1524		1612
1525	Used by @@RXVT_NAME@@ to connect to the display and set to the correct	1613	Used by @@RXVT_NAME@@ to connect to the display and set to the correct
1526	display in its child processes.	1614	display in its child processes if C<-display> isn't used to override. It
		1615	defaults to C<:0> if it doesn't exist.
1527		1616
1528	=item B<SHELL>	1617	=item B<SHELL>
1529		1618
1530	The shell to be used for command execution, defaults to C</bin/sh>.	1619	The shell to be used for command execution, defaults to C</bin/sh>.
1531		1620
…		…
1557		1646
1558	=over 4	1647	=over 4
1559		1648
1560	=item B</usr/lib/X11/rgb.txt>	1649	=item B</usr/lib/X11/rgb.txt>
1561		1650
1562	Color names.	1651	Colour names.
1563		1652
1564	=back	1653	=back
1565		1654
1566	=head1 SEE ALSO	1655	=head1 SEE ALSO
1567		1656

Diff Legend

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

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents): Revision 1.150 by root, Fri Dec 7 16:14:26 2007 UTC vs. Revision 1.185 by sf-exg, Mon Oct 4 07:18:23 2010 UTC

Diff Legend

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents):
Revision 1.150 by root, Fri Dec 7 16:14:26 2007 UTC vs.
Revision 1.185 by sf-exg, Mon Oct 4 07:18:23 2010 UTC