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

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents):
Revision 1.151 by root, Wed Dec 12 19:55:55 2007 UTC vs.
Revision 1.186 by sf-exg, Wed Oct 13 23:36:00 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>
171		179
172	Apply Gaussian Blur with the specified radii to the transparent	180	Apply Gaussian Blur with the specified radii to the transparent
173	background image. If single number is specified - both vertical and	181	background image. If single number is specified - both vertical and
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> or I<xft>;
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
…		…
446		472
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>.
		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>.
451		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
…		…
564	=item B<depth:> I<bitdepth>	596	=item B<depth:> I<bitdepth>
565		597
566	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;
567	option B<-depth>.	599	option B<-depth>.
568		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
569	=item B<geometry:> I<geom>	608	=item B<geometry:> I<geom>
570		609
571	Create the window with the specified X window geometry [default 80x24];	610	Create the window with the specified X window geometry [default 80x24];
572	option B<-geometry>.	611	option B<-geometry>.
573		612
…		…
586	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
587	corresponds to low-intensity (normal) colours and 8-15 corresponds to	626	corresponds to low-intensity (normal) colours and 8-15 corresponds to
588	high-intensity (bold = bright foreground, blink = bright background)	627	high-intensity (bold = bright foreground, blink = bright background)
589	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,
590	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
591	names used are listed in the B<COLORS AND GRAPHICS> section.	630	names used are listed in the B<COLOURS AND GRAPHICS> section.
592		631
593	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
594	changed using an escape command (see @@RXVT_NAME@@(7)).	633	changed using an escape command (see @@RXVT_NAME@@(7)).
595		634
596	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
…		…
607	=item B<colorUL:> I<colour>	646	=item B<colorUL:> I<colour>
608		647
609	Use the specified colour to display underlined characters when the	648	Use the specified colour to display underlined characters when the
610	foreground colour is the default.	649	foreground colour is the default.
611		650
612	=item B<colorRV:> I<colour>
613
614	Use the specified colour as the background for reverse video characters
615	when OPTION_HC is disabled (--disable-frills).
616
617	=item B<underlineColor:> I<colour>	651	=item B<underlineColor:> I<colour>
618		652
619	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
620	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.
621		665
622	=item B<cursorColor:> I<colour>	666	=item B<cursorColor:> I<colour>
623		667
624	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
625	foreground colour; option B<-cr>.	669	foreground colour; option B<-cr>.
…		…
632		676
633	=item B<reverseVideo:> I<boolean>	677	=item B<reverseVideo:> I<boolean>
634		678
635	B<True>: simulate reverse video by foreground and background colours;	679	B<True>: simulate reverse video by foreground and background colours;
636	option B<-rv>. B<False>: regular screen colours [default]; option	680	option B<-rv>. B<False>: regular screen colours [default]; option
637	B<+rv>. See note in B<COLORS AND GRAPHICS> section.	681	B<+rv>. See note in B<COLOURS AND GRAPHICS> section.
638		682
639	=item B<jumpScroll:> I<boolean>	683	=item B<jumpScroll:> I<boolean>
640		684
641	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
642	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
…		…
691		735
692	Specify background blending type; option B<-blt>.	736	Specify background blending type; option B<-blt>.
693		737
694	=item B<blurRadius:> I<number>	738	=item B<blurRadius:> I<number>
695		739
696	Apply Gaussian Blurr with the specified radius to the transparent	740	Apply gaussian blur with the specified radius to the transparent
697	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>.
698		746
699	=item B<scrollColor:> I<colour>	747	=item B<scrollColor:> I<colour>
700		748
701	Use the specified colour for the scrollbar [default #B2B2B2].	749	Use the specified colour for the scrollbar [default #B2B2B2].
702		750
…		…
712		760
713	=item B<backgroundPixmap:> I<file[;geom[:op1][:op2][...]]>	761	=item B<backgroundPixmap:> I<file[;geom[:op1][:op2][...]]>
714		762
715	Use the specified image file for the background and also	763	Use the specified image file for the background and also
716	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>,
717	(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
718	horizontal/vertical scale (percent), and B<"X" / "Y"> locate the image	766	horizontal/vertical scale (percent), and B<"X" / "Y"> locate the image
719	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.
720	of 1 displays the image without any scaling. A scale of 2 to 9 specifies	768	The maximum permitted scale is 1000.
721	an integer number of images in that direction. No image will be magnified
722	beyond 10 times its original size. The maximum permitted scale is 1000.
723	Additional operations can be specified after colon B<:op1:op2...>.	769	Additional operations can be specified after colon B<:op1:op2...>.
724	Supported operations are:	770	Supported operations are:
725		771
726	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
727	propscale will scale image keeping proportions,	773	propscale will scale image keeping proportions
728	auto will scale image to match window size. Equivalent to 100x100;	774	auto will scale image to match window size. Equivalent to 100x100
729	hscale will scale image horizontally to the window size;	775	hscale will scale image horizontally to the window size
730	vscale will scale image vertically to the window size;	776	vscale will scale image vertically to the window size
731	scale will scale image to match window size;	777	scale will scale image to match window size
732	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
733	whenever terminal window moves.	779	whenever terminal window moves
734		780
735	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
736	blended over transparency image using either alpha-blending, or any	782	blended over transparency image using alpha-blending. If I<afterimage>
737	other blending type, specified with B<-blt "type"> option.	783	support has been compiled in it is possible to choose other blending
		784	types with B<-blt "type"> option.
738		785
739	=item B<path:> I<path>	786	=item B<path:> I<path>
740		787
741	Specify the colon-delimited search path for finding background image files.	788	Specify the colon-delimited search path for finding background image files.
742		789
…		…
769	it is named first) and thus defines the character cell grid to be 9 pixels	816	it is named first) and thus defines the character cell grid to be 9 pixels
770	wide and 15 pixels high.	817	wide and 15 pixels high.
771		818
772	The second font is just used to add additional unicode characters not in	819	The second font is just used to add additional unicode characters not in
773	the base font, likewise the third, which is unfortunately non-bold, but	820	the base font, likewise the third, which is unfortunately non-bold, but
774	the bold version of the font does contain less characters, so this is a	821	the bold version of the font does contain fewer characters, so this is a
775	useful supplement.	822	useful supplement.
776		823
777	The third font is an Xft font with aliasing turned off, and the characters	824	The third font is an Xft font with aliasing turned off, and the characters
778	are limited to the B<JIS 0208> codeset (i.e. japanese kanji). The font	825	are limited to the B<JIS 0208> codeset (i.e. japanese kanji). The font
779	contains other characters, but we are not interested in them.	826	contains other characters, but we are not interested in them.
…		…
803	text font will being used for the given style.	850	text font will being used for the given style.
804		851
805	=item B<intensityStyles:> I<boolean>	852	=item B<intensityStyles:> I<boolean>
806		853
807	When font styles are not enabled, or this option is enabled (B<True>,	854	When font styles are not enabled, or this option is enabled (B<True>,
808	option B<-is>, the default), bold and italic font styles imply high	855	option B<-is>, the default), bold/blink font styles imply high
809	intensity foreground/background colours. Disabling this option (B<False>,	856	intensity foreground/background colours. Disabling this option (B<False>,
810	option B<+is>) disables this behaviour, the high intensity colours are not	857	option B<+is>) disables this behaviour, the high intensity colours are not
811	reachable.	858	reachable.
812		859
813	=item B<selectstyle:> I<mode>
814
815	Set mouse selection style to B<old> which is 2.20, B<oldword> which
816	is xterm style with 2.20 old word selection, or anything else which
817	gives xterm style selection. Only effective when the original (non-perl)
818	selection code is in use.
819
820	=item B<scrollstyle:> I<mode>
821
822	Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is
823	the author's favourite.
824
825	=item B<title:> I<string>	860	=item B<title:> I<string>
826		861
827	Set window title string, the default title is the command-line	862	Set window title string, the default title is the command-line
828	specified after the B<-e> option, if any, otherwise the application	863	specified after the B<-e> option, if any, otherwise the application
829	name; option B<-title>.	864	name; option B<-title>.
…		…
842	=item B<urgentOnBell:> I<boolean>	877	=item B<urgentOnBell:> I<boolean>
843		878
844	B<True>: set the urgency hint for the wm on receipt of a bell character.	879	B<True>: set the urgency hint for the wm on receipt of a bell character.
845	B<False>: do not set the urgency hint [default].	880	B<False>: do not set the urgency hint [default].
846		881
		882	@@RXVT_NAME@@ resets the urgency hint on every focus change.
		883
847	=item B<visualBell:> I<boolean>	884	=item B<visualBell:> I<boolean>
848		885
849	B<True>: use visual bell on receipt of a bell character; option B<-vb>.	886	B<True>: use visual bell on receipt of a bell character; option B<-vb>.
850	B<False>: no visual bell [default]; option B<+vb>.	887	B<False>: no visual bell [default]; option B<+vb>.
851		888
…		…
873		910
874	URxvt.print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX)	911	URxvt.print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX)
875		912
876	This creates a new file in your home directory with the screen contents	913	This creates a new file in your home directory with the screen contents
877	every time you hit C<Print>.	914	every time you hit C<Print>.
		915
		916	=item B<scrollstyle:> I<mode>
		917
		918	Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is
		919	the author's favourite.
878		920
879	=item B<scrollBar:> I<boolean>	921	=item B<scrollBar:> I<boolean>
880		922
881	B<True>: enable the scrollbar [default]; option B<-sb>. B<False>:	923	B<True>: enable the scrollbar [default]; option B<-sb>. B<False>:
882	disable the scrollbar; option B<+sb>.	924	disable the scrollbar; option B<+sb>.
…		…
970	=item B<cursorBlink:> I<boolean>	1012	=item B<cursorBlink:> I<boolean>
971		1013
972	B<True>: blink the cursor. B<False>: do not blink the cursor [default];	1014	B<True>: blink the cursor. B<False>: do not blink the cursor [default];
973	option B<-bc>.	1015	option B<-bc>.
974		1016
		1017	=item B<cursorUnderline:> I<boolean>
		1018
		1019	B<True>: Make the cursor underlined. B<False>: Make the cursor a box [default];
		1020	option B<-uc>.
		1021
975	=item B<pointerBlank:> I<boolean>	1022	=item B<pointerBlank:> I<boolean>
976		1023
977	B<True>: blank the pointer when a key is pressed or after a set number	1024	B<True>: blank the pointer when a key is pressed or after a set number
978	of seconds of inactivity. B<False>: the pointer is always visible	1025	of seconds of inactivity. B<False>: the pointer is always visible
979	[default].	1026	[default].
…		…
992	large number (e.g. C<987654321>) to effectively disable the timeout.	1039	large number (e.g. C<987654321>) to effectively disable the timeout.
993		1040
994	=item B<backspacekey:> I<string>	1041	=item B<backspacekey:> I<string>
995		1042
996	The string to send when the backspace key is pressed. If set to B<DEC>	1043	The string to send when the backspace key is pressed. If set to B<DEC>
997	or unset it will send B<Delete> (code 127) or, if shifted, B<Backspace>	1044	or unset it will send B<Delete> (code 127) or, with control, B<Backspace>
998	(code 8) - which can be reversed with the appropriate DEC private mode	1045	(code 8) - which can be reversed with the appropriate DEC private mode
999	escape sequence.	1046	escape sequence.
1000		1047
1001	=item B<deletekey:> I<string>	1048	=item B<deletekey:> I<string>
1002		1049
…		…
1081		1128
1082	=item B<secondaryScroll:> I<boolean>	1129	=item B<secondaryScroll:> I<boolean>
1083		1130
1084	Turn on/off secondary screen scroll (default enabled). If this	1131	Turn on/off secondary screen scroll (default enabled). If this
1085	option is enabled, scrolls on the secondary screen will change the	1132	option is enabled, scrolls on the secondary screen will change the
1086	scrollback buffer and switching to/from the secondary screen will	1133	scrollback buffer and, when secondaryScreen is off, switching
1087	instead scroll the screen up.	1134	to/from the secondary screen will instead scroll the screen up.
1088		1135
1089	=item B<hold>: I<boolean>	1136	=item B<hold>: I<boolean>
1090		1137
1091	Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@	1138	Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@
1092	will not immediately destroy its window when the program executed within	1139	will not immediately destroy its window when the program executed within
1093	it exits. Instead, it will wait till it is being killed or closed by the	1140	it exits. Instead, it will wait till it is being killed or closed by the
1094	user.	1141	user.
		1142
		1143	=item B<chdir>: I<path>
		1144
		1145	Sets the working directory for the shell (or the command specified via
		1146	B<-e>). The I<path> must be an absolute path and it must exist for
		1147	@@RXVT_NAME@@ to start. If it isn't specified then the current working
		1148	directory will be used; option B<-cd>.
1095		1149
1096	=item B<keysym.>I<sym>: I<string>	1150	=item B<keysym.>I<sym>: I<string>
1097		1151
1098	Compile I<frills>: Associate I<string> with keysym I<sym>. The	1152	Compile I<frills>: Associate I<string> with keysym I<sym>. The
1099	intervening resource name B<keysym.> cannot be omitted.	1153	intervening resource name B<keysym.> cannot be omitted.
…		…
1114	omitting the prefix B<XK_>. Alternatively you can specify I<key> by its hex	1168	omitting the prefix B<XK_>. Alternatively you can specify I<key> by its hex
1115	keysym value (B<0x0000 - 0xFFFF>). Note that the lookup of I<sym>s is not	1169	keysym value (B<0x0000 - 0xFFFF>). Note that the lookup of I<sym>s is not
1116	performed in an exact manner; however, the closest match is assured.	1170	performed in an exact manner; however, the closest match is assured.
1117		1171
1118	I<string> may contain escape values (C<\n>: newline, C<\000>: octal	1172	I<string> may contain escape values (C<\n>: newline, C<\000>: octal
1119	number), see RESOURCES in C<man 7 X> for futher details.	1173	number), see RESOURCES in C<man 7 X> for further details.
1120		1174
1121	You can define a range of keysyms in one shot by providing a I<string>	1175	You can define a range of keysyms in one shot by providing a I<string>
1122	with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimiter `/'	1176	with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimiter `/'
1123	should be a character not used by the strings.	1177	should be a character not used by the strings.
1124		1178
…		…
1138	when Control-Meta-c is being pressed":	1192	when Control-Meta-c is being pressed":
1139		1193
1140	URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007	1194	URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007
1141		1195
1142	If I<string> takes the form C<perl:STRING>, then the specified B<STRING>	1196	If I<string> takes the form C<perl:STRING>, then the specified B<STRING>
1143	is passed to the C<on_keyboard_command> perl handler. See the @@RXVT_NAME@@perl(3)	1197	is passed to the C<on_user_command> perl handler. See the @@RXVT_NAME@@perl(3)
1144	manpage. For example, the F<selection> extension (activated via	1198	manpage. For example, the F<selection> extension (activated via
1145	C<@@RXVT_NAME@@ -pe selection>) listens for C<selection:rot13> events:	1199	C<@@RXVT_NAME@@ -pe selection>) listens for C<selection:rot13> events:
1146		1200
1147	URxvt.keysym.M-C-c: perl:selection:rot13	1201	URxvt.keysym.M-C-c: perl:selection:rot13
1148		1202
1149	Due the the large number of modifier combinations, a defined key mapping	1203	Due the the large number of modifier combinations, a defined key mapping
1150	will match if at I<at least> the specified identifiers are being set, and	1204	will match if I<at least> the specified identifiers are being set, and
1151	no other key mappings with those and more bits are being defined. That	1205	no other key mappings with those and more bits are being defined. That
1152	means that defining a key map for C<a> will automatically provide	1206	means that defining a key map for C<a> will automatically provide
1153	definitions for C<Meta-a>, C<Shift-a> and so on, unless some of those are defined	1207	definitions for C<Meta-a>, C<Shift-a> and so on, unless some of those are defined
1154	mappings themselves.	1208	mappings themselves.
1155		1209
…		…
1206	all instances, while B<perl-ext> is used for specific instances.	1260	all instances, while B<perl-ext> is used for specific instances.
1207		1261
1208	=item B<perl-eval>: I<string>	1262	=item B<perl-eval>: I<string>
1209		1263
1210	Perl code to be evaluated when all extensions have been registered. See	1264	Perl code to be evaluated when all extensions have been registered. See
1211	the @@RXVT_NAME@@perl(3) manpage. Due to security reasons, this resource	1265	the @@RXVT_NAME@@perl(3) manpage.
1212	will be ignored when running setuid/setgid.
1213		1266
1214	=item B<perl-lib>: I<path>	1267	=item B<perl-lib>: I<path>
1215		1268
1216	Colon-separated list of additional directories that hold extension	1269	Colon-separated list of additional directories that hold extension
1217	scripts. When looking for extensions specified by the C<perl> resource,	1270	scripts. When looking for extensions specified by the C<perl> resource,
1218	@@RXVT_NAME@@ will first look in these directories and then in	1271	@@RXVT_NAME@@ will first look in these directories and then in
1219	F<@@RXVT_LIBDIR@@/urxvt/perl/>. Due to security reasons, this resource	1272	F<@@RXVT_LIBDIR@@/urxvt/perl/>.
1220	will be ignored when running setuid/setgid.
1221		1273
1222	See the @@RXVT_NAME@@perl(3) manpage.	1274	See the @@RXVT_NAME@@perl(3) manpage.
1223		1275
1224	=item B<< selection.pattern-I<idx> >>: I<perl-regex>	1276	=item B<< selection.pattern-I<idx> >>: I<perl-regex>
1225		1277
…		…
1247		1299
1248	=item B<override-redirect>: I<boolean>	1300	=item B<override-redirect>: I<boolean>
1249		1301
1250	Compile I<frills>: Sets override-redirect for the terminal window, making	1302	Compile I<frills>: Sets override-redirect for the terminal window, making
1251	it almost invisible to window managers; option B<-override-redirect>.	1303	it almost invisible to window managers; option B<-override-redirect>.
		1304
		1305	=item B<iso14755:> I<boolean>
		1306
		1307	Turn on/off ISO 14755 (default enabled).
1252		1308
1253	=item B<iso14755_52:> I<boolean>	1309	=item B<iso14755_52:> I<boolean>
1254		1310
1255	Turn on/off ISO 14755 5.2 mode (default enabled).	1311	Turn on/off ISO 14755 5.2 mode (default enabled).
1256		1312
…		…
1399	B<@@RXVT_NAME@@> tries to write an entry into the I<utmp>(5) file so that	1455	B<@@RXVT_NAME@@> tries to write an entry into the I<utmp>(5) file so that
1400	it can be seen via the I<who(1)> command, and can accept messages. To	1456	it can be seen via the I<who(1)> command, and can accept messages. To
1401	allow this feature, B<@@RXVT_NAME@@> may need to be installed setuid root	1457	allow this feature, B<@@RXVT_NAME@@> may need to be installed setuid root
1402	on some systems or setgid to root or to some other group on others.	1458	on some systems or setgid to root or to some other group on others.
1403		1459
1404	=head1 COLORS AND GRAPHICS	1460	=head1 COLOURS AND GRAPHICS
1405		1461
1406	In addition to the default foreground and background colours,	1462	In addition to the default foreground and background colours,
1407	B<@@RXVT_NAME@@> can display up to 16 colours (8 ANSI colours plus	1463	B<@@RXVT_NAME@@> can display up to 88/256 colours: 8 ANSI colours plus
1408	high-intensity bold/blink versions of the same). Here is a list of the	1464	high-intensity (potentially bold/blink) versions of the same, and 72 (or
1409	colours with their names.	1465	240 in 256 colour mode) colours arranged in an 4x4x4 (or 6x6x6) colour RGB
		1466	cube plus a 8 (24) colour greyscale ramp.
		1467
		1468	Here is a list of the ANSI colours with their names.
1410		1469
1411	=begin table	1470	=begin table
1412		1471
1413	B<color0> (black) = Black	1472	B<color0> (black) = Black
1414	B<color1> (red) = Red3	1473	B<color1> (red) = Red3
…		…
1434	It is also possible to specify the colour values of B<foreground>,	1493	It is also possible to specify the colour values of B<foreground>,
1435	B<background>, B<cursorColor>, B<cursorColor2>, B<colorBD>, B<colorUL> as	1494	B<background>, B<cursorColor>, B<cursorColor2>, B<colorBD>, B<colorUL> as
1436	a number 0-15, as a convenient shorthand to reference the colour name of	1495	a number 0-15, as a convenient shorthand to reference the colour name of
1437	color0-color15.	1496	color0-color15.
1438		1497
1439	In addition to the colours defined above, @@RXVT_NAME@@ offers an	1498	The following text gives values for the standard 88 colour mode (and
1440	additional 72 colours. The first 64 of those (with indices 16 to 79)	1499	values for the 256 colour mode in parentheses).
1441	consist of a 444 RGB colour cube (i.e. I<index = r * 16 + g * 4 + b +
1442	16>), followed by 8 additional shades of gray (with indices 80 to 87).
1443		1500
		1501	The RGB cube uses indices 16..79 (16..231) using the following formulas:
		1502
		1503	index_88 = (r * 4 + g) * 4 + b + 16 # r, g, b = 0..3
		1504	index_256 = (r * 16 + g) * 16 + b + 16 # r, g, b = 0..15
		1505
		1506	The grayscale ramp uses indices 80..87 (232..239), from 10% to 90% in 10%
		1507	steps (1/26 to 25/26 in 1/26 steps) - black and white are already part of
		1508	the RGB cube.
		1509
1444	Together, all those colours implement the 88 colour xterm colours. Only	1510	Together, all those colours implement the 88 (256) colour xterm
1445	the first 16 can be changed using resources currently, the rest can only	1511	colours. Only the first 16 can be changed using resources currently, the
1446	be changed via command sequences ("escape codes").	1512	rest can only be changed via command sequences ("escape codes").
		1513
		1514	Applications are advised to use terminfo or command sequences to discover
		1515	number and RGB values of all colours (yes, you can query this...).
1447		1516
1448	Note that B<-rv> (B<"reverseVideo: True">) simulates reverse video by	1517	Note that B<-rv> (B<"reverseVideo: True">) simulates reverse video by
1449	always swapping the foreground/background colours. This is in contrast to	1518	always swapping the foreground/background colours. This is in contrast to
1450	I<xterm>(1) where the colours are only swapped if they have not otherwise	1519	I<xterm>(1) where the colours are only swapped if they have not otherwise
1451	been specified. For example,	1520	been specified. For example,
1452		1521
1453	=over 4
1454
1455	=item B<@@RXVT_NAME@@ -fg Black -bg White -rv>	1522	@@RXVT_NAME@@ -fg Black -bg White -rv
1456		1523
1457	would yield White on Black, while on I<xterm>(1) it would yield Black	1524	would yield White on Black, while on I<xterm>(1) it would yield Black on
1458	on White.	1525	White.
1459
1460	=back
1461		1526
1462	=head2 ALPHA CHANNEL SUPPORT	1527	=head2 ALPHA CHANNEL SUPPORT
1463		1528
1464	If Xft support has been compiled in and as long as Xft/Xrender/X don't get	1529	If Xft support has been compiled in and as long as Xft/Xrender/X don't get
1465	their act together, rxvt-unicode will support C<rgba:rrrr/gggg/bbbb/aaaa>	1530	their act together, rxvt-unicode will do it's own alpha channel management:
1466	(recommended, but B<MUST> have 4 digits/component) colour specifications,	1531
1467	in addition to the ones provided by X, where the additional A component	1532	You can prefix any colour with an opaqueness percentage enclosed in
		1533	brackets, i.e. C<[percent]>, where C<percent> is a decimal percentage
		1534	(0-100) that specifies the opacity of the colour, where C<0> is completely
		1535	transparent and C<100> is completely opaque. For example, C<[50]red> is a
		1536	half-transparent red, while C<[95]#00ff00> is an almost opaque green. This
		1537	is the recommended format to specify transparency values, and works with
		1538	all ways to specify a colour.
		1539
		1540	For complete control, rxvt-unicode also supports
		1541	C<rgba:rrrr/gggg/bbbb/aaaa> (exactly four hex digits/component) colour
		1542	specifications, where the additional C<aaaa> component specifies opacity
1468	specifies opacity (alpha) values. The minimum value of C<0> is completely	1543	(alpha) values. The minimum value of C<0000> is completely transparent,
1469	transparent). You can also prefix any color with C<[percent]>, where	1544	while C<ffff> is completely opaque). The two example colours from
1470	C<percent> is a decimal percentage (0-100) that specifies the opacity of	1545	earlier could also be specified as C<rgba:ff00/0000/0000/8000> and
1471	the color, where C<0> is completely transparent and C<100> is completelxy	1546	C<rgba:0000/ff00/0000/f332>.
1472	opaque.
1473		1547
1474	You probably need to specify B<"-depth 32">, too, and have the luck that	1548	You probably need to specify B<"-depth 32">, too, to force a visual with
1475	your X-server uses ARGB pixel layout, as X is far from just supporting	1549	alpha channels, and have the luck that your X-server uses ARGB pixel
1476	ARGB visuals out of the box, and rxvt-unicode just fudges around.	1550	layout, as X is far from just supporting ARGB visuals out of the box, and
		1551	rxvt-unicode just fudges around.
1477		1552
1478	For example, the following selects an almost completely transparent red	1553	For example, the following selects an almost completely transparent black
1479	background, and an almost opaque pink foreground:	1554	background, and an almost opaque pink foreground:
1480		1555
1481	@@RXVT_NAME@@ -depth 32 -bg rgba:0000/0000/0000/aaaa -fg "[80]pink"	1556	@@RXVT_NAME@@ -depth 32 -bg rgba:0000/0000/0000/4444 -fg "[80]pink"
1482		1557
1483	I<Please note that transparency of any kind if completely unsupported by	1558	When not using a background image, then the interpretation of the
1484	the author. Don't bug him with installation questions!>	1559	alpha channel is up to your compositing manager (most interpret it as
		1560	transparency of course).
		1561
		1562	When using a background pixmap or pseudo-transparency, then the background
		1563	colour will always behave as if it were completely transparent (so the
		1564	background image shows instead), regardless of how it was specified, while
		1565	other colours will either be transparent as specified (the background
		1566	image will show through) on servers supporting the RENDER extension, or
		1567	fully opaque on servers not supporting the RENDER EXTENSION.
		1568
		1569	Please note that due to bugs in Xft, specifying alpha values might result
		1570	in garbage being displayed when the X-server does not support the RENDER
		1571	extension.
1485		1572
1486	=head1 ENVIRONMENT	1573	=head1 ENVIRONMENT
1487		1574
1488	B<@@RXVT_NAME@@> sets and/or uses the following environment variables:	1575	B<@@RXVT_NAME@@> sets and/or uses the following environment variables:
1489		1576
…		…
1523	C<--with-terminfo=PATH>.	1610	C<--with-terminfo=PATH>.
1524		1611
1525	=item B<DISPLAY>	1612	=item B<DISPLAY>
1526		1613
1527	Used by @@RXVT_NAME@@ to connect to the display and set to the correct	1614	Used by @@RXVT_NAME@@ to connect to the display and set to the correct
1528	display in its child processes.	1615	display in its child processes if C<-display> isn't used to override. It
		1616	defaults to C<:0> if it doesn't exist.
1529		1617
1530	=item B<SHELL>	1618	=item B<SHELL>
1531		1619
1532	The shell to be used for command execution, defaults to C</bin/sh>.	1620	The shell to be used for command execution, defaults to C</bin/sh>.
1533		1621
…		…
1559		1647
1560	=over 4	1648	=over 4
1561		1649
1562	=item B</usr/lib/X11/rgb.txt>	1650	=item B</usr/lib/X11/rgb.txt>
1563		1651
1564	Color names.	1652	Colour names.
1565		1653
1566	=back	1654	=back
1567		1655
1568	=head1 SEE ALSO	1656	=head1 SEE ALSO
1569		1657

Diff Legend

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

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents): Revision 1.151 by root, Wed Dec 12 19:55:55 2007 UTC vs. Revision 1.186 by sf-exg, Wed Oct 13 23:36:00 2010 UTC

Diff Legend

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents):
Revision 1.151 by root, Wed Dec 12 19:55:55 2007 UTC vs.
Revision 1.186 by sf-exg, Wed Oct 13 23:36:00 2010 UTC