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

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents):
Revision 1.152 by root, Wed Dec 12 19:56:37 2007 UTC vs.
Revision 1.187 by sf-exg, Fri Oct 15 10:46:57 2010 UTC

…		…
11	B<rxvt-unicode>, version B<@@RXVT_VERSION@@>, is a colour vt102 terminal	11	B<rxvt-unicode>, version B<@@RXVT_VERSION@@>, is a colour vt102 terminal
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
		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>.
16		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
…		…
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>.
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>
…		…
120		128
121	Turn on/off illusion of a transparent window background; resource B<transparent>.	129	Turn on/off illusion of a transparent window background; resource B<transparent>.
122		130
123	B<-ip> is still accepted as an obsolete alias but will be removed in	131	B<-ip> is still accepted as an obsolete alias but will be removed in
124	future versions.	132	future versions.
125
126	I<Please address all transparency related issues to Sasha Vasko at
127	sasha@aftercode.net. Read the FAQ (man 7 @@RXVT_NAME@@)!>
128		133
129	=item B<-fade> I<number>	134	=item B<-fade> I<number>
130		135
131	Fade the text by the given percentage when focus is lost. Small values	136	Fade the text by the given percentage when focus is lost. Small values
132	fade a little only, 100 completely replaces all colours by the fade	137	fade a little only, 100 completely replaces all colours by the fade
…		…
144	non-tiled backgrounds, currently. See also the B<-sh> option that can be	149	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.	150	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,	151	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:	152	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	153	blue, red, green, cyan, magenta, yellow, and those close to them. Also
149	pure black and pure white colors essentially mean no tinting; resource	154	pure black and pure white colours essentially mean no tinting; resource
150	I<tintColor>. Example:	155	I<tintColor>. Example:
151		156
152	@@RXVT_NAME@@ -tr -tint blue -sh 40	157	@@RXVT_NAME@@ -tr -tint blue -sh 40
153		158
154	=item B<-sh> I<number>	159	=item B<-sh> I<number>
…		…
160	=item B<-blt> I<string>	165	=item B<-blt> I<string>
161		166
162	Specify background blending type. If background pixmap is specified	167	Specify background blending type. If background pixmap is specified
163	at the same time as transparency - such pixmap will be blended over	168	at the same time as transparency - such pixmap will be blended over
164	transparency image, using method specified. Supported values are :	169	transparency image, using method specified. Supported values are :
165	B<add>, B<alphablend>, B<allanon> - color values averaging, B<colorize>,	170	B<add>, B<alphablend>, B<allanon> - colour values averaging, B<colorize>,
166	B<darken>, B<diff>, B<dissipate>, B<hue>, B<lighten>, B<overlay>,	171	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	172	B<saturate>, B<screen>, B<sub>, B<tint>, B<value>. The default is
168	alpha-blending. Compile I<afterimage>; resource I<blendType>.	173	alpha-blending. Compile I<afterimage>; resource I<blendType>.
169		174
170	=item B<-blr> I<HxV>	175	=item B<-blr> I<HxV>
171		176
172	Apply Gaussian Blur with the specified radii to the transparent	177	Apply Gaussian Blur with the specified radii to the transparent
173	background image. If single number is specified - both vertical and	178	background image. If single number is specified - both vertical and
174	horizontal radii are considered to be the same. Setting one of the	179	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	180	radii to 1 and another to a large number creates interesting effects
176	on some backgrounds. Maximum radius value is 128. Compile I<afterimage>;	181	on some backgrounds. Maximum radius value is 128. Compile I<afterimage> or I<xft>;
177	resource I<blurRadius>.	182	resource I<blurRadius>.
178		183
		184	=item B<-icon> I<file>
		185
		186	Compile I<afterimage> or I<pixbuf>: Use the specified image as application icon. This
		187	is used by many window managers, taskbars and pagers to represent the
		188	application window; resource I<iconFile>.
		189
179	=item B<-bg> I<colour>	190	=item B<-bg> I<colour>
180		191
181	Window background colour; resource B<background>.	192	Window background colour; resource B<background>.
182		193
183	=item B<-fg> I<colour>	194	=item B<-fg> I<colour>
184		195
185	Window foreground colour; resource B<foreground>.	196	Window foreground colour; resource B<foreground>.
186		197
187	=item B<-pixmap> I<file[;geom[:op1][:op2][...]]>	198	=item B<-pixmap> I<file[;geom[:op1][:op2][...]]>
188		199
189	Compile I<afterimage>: Specify image file for the background and also	200	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	201	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	202	add quotes to avoid special shell interpretation of the C<;> in the
192	command-line; for more details see resource B<backgroundPixmap>.	203	command-line; for more details see resource B<backgroundPixmap>.
193		204
194	=item B<-cr> I<colour>	205	=item B<-cr> I<colour>
…		…
242	italic> >> characters are to be printed. See resource B<boldItalicFont>	253	italic> >> characters are to be printed. See resource B<boldItalicFont>
243	for details.	254	for details.
244		255
245	=item B<-is>\|B<+is>	256	=item B<-is>\|B<+is>
246		257
247	Compile I<font-styles>: Bold/Italic font styles imply high intensity	258	Compile I<font-styles>: Bold/Blink font styles imply high intensity
248	foreground/background (default). See resource B<intensityStyles> for	259	foreground/background (default). See resource B<intensityStyles> for
249	details.	260	details.
250		261
251	=item B<-name> I<name>	262	=item B<-name> I<name>
252		263
…		…
270		281
271	=item B<-sb>\|B<+sb>	282	=item B<-sb>\|B<+sb>
272		283
273	Turn on/off scrollbar; resource B<scrollBar>.	284	Turn on/off scrollbar; resource B<scrollBar>.
274		285
		286	=item B<-sr>\|B<+sr>
		287
		288	Put scrollbar on right/left; resource B<scrollBar_right>.
		289
		290	=item B<-st>\|B<+st>
		291
		292	Display rxvt (non XTerm/NeXT) scrollbar without/with a trough;
		293	resource B<scrollBar_floating>.
		294
275	=item B<-si>\|B<+si>	295	=item B<-si>\|B<+si>
276		296
277	Turn on/off scroll-to-bottom on TTY output inhibit; resource	297	Turn on/off scroll-to-bottom on TTY output inhibit; resource
278	B<scrollTtyOutput> has opposite effect.	298	B<scrollTtyOutput> has opposite effect.
279		299
…		…
285	=item B<-sw>\|B<+sw>	305	=item B<-sw>\|B<+sw>
286		306
287	Turn on/off scrolling with the scrollback buffer as new lines appear.	307	Turn on/off scrolling with the scrollback buffer as new lines appear.
288	This only takes effect if B<-si> is also given; resource	308	This only takes effect if B<-si> is also given; resource
289	B<scrollWithBuffer>.	309	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		310
300	=item B<-ptab>\|B<+ptab>	311	=item B<-ptab>\|B<+ptab>
301		312
302	If enabled (default), "Horizontal Tab" characters are being stored as	313	If enabled (default), "Horizontal Tab" characters are being stored as
303	actual wide characters in the screen buffer, which makes it possible to	314	actual wide characters in the screen buffer, which makes it possible to
…		…
307		318
308	=item B<-bc>\|B<+bc>	319	=item B<-bc>\|B<+bc>
309		320
310	Blink the cursor; resource B<cursorBlink>.	321	Blink the cursor; resource B<cursorBlink>.
311		322
		323	=item B<-uc>\|B<+uc>
		324
		325	Make the cursor underlined; resource B<cursorUnderline>.
		326
312	=item B<-iconic>	327	=item B<-iconic>
313		328
314	Start iconified, if the window manager supports that option.	329	Start iconified, if the window manager supports that option.
315	Alternative form is B<-ic>.	330	Alternative form is B<-ic>.
316		331
…		…
332		347
333	=item B<-bl>	348	=item B<-bl>
334		349
335	Compile I<frills>: Set MWM hints to request a borderless window, i.e.	350	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	351	if honoured by the WM, the rxvt-unicode window will not have window
337	decorations; resource B<borderLess>.	352	decorations; resource B<borderLess>. If the window manager does not
		353	support MWM hints (e.g. kwin), enables override-redirect mode.
338		354
339	=item B<-override-redirect>	355	=item B<-override-redirect>
340		356
341	Compile I<frills>: Sets override-redirect on the window; resource	357	Compile I<frills>: Sets override-redirect on the window; resource
342	B<override-redirect>.	358	B<override-redirect>.
…		…
351	=item B<-lsp> I<number>	367	=item B<-lsp> I<number>
352		368
353	Compile I<frills>: Lines (pixel height) to insert between each row of	369	Compile I<frills>: Lines (pixel height) to insert between each row of
354	the display. Useful to work around font rendering problems; resource	370	the display. Useful to work around font rendering problems; resource
355	B<lineSpace>.	371	B<lineSpace>.
		372
		373	=item B<-letsp> I<number>
		374
		375	Compile I<frills>: Amount to adjust the computed character width by
		376	to control overall letter spacing. Negative values will tighten up the
		377	letter spacing, positive values will space letters out more. Useful to
		378	work around odd font metrics; resource B<letterSpace>.
356		379
357	=item B<-tn> I<termname>	380	=item B<-tn> I<termname>
358		381
359	This option specifies the name of the terminal type to be set in the	382	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	383	B<TERM> environment variable. This terminal type must exist in the
…		…
446		469
447	Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@	470	Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@
448	will not immediately destroy its window when the program executed within	471	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	472	it exits. Instead, it will wait till it is being killed or closed by the
450	user; resource B<hold>.	473	user; resource B<hold>.
		474
		475	=item B<-cd> I<path>
		476
		477	Sets the working directory for the shell (or the command specified via
		478	B<-e>). The I<path> must be an absolute path and it must exist for
		479	@@RXVT_NAME@@ to start; resource B<chdir>.
451		480
452	=item B<-xrm> I<string>	481	=item B<-xrm> I<string>
453		482
454	Works like the X Toolkit option of the same name, by adding the I<string>	483	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	484	as if it were specified in a resource file. Resource values specified this
…		…
564	=item B<depth:> I<bitdepth>	593	=item B<depth:> I<bitdepth>
565		594
566	Compile I<xft>: Attempt to find a visual with the given bit depth;	595	Compile I<xft>: Attempt to find a visual with the given bit depth;
567	option B<-depth>.	596	option B<-depth>.
568		597
		598	=item B<buffered:> I<boolean>
		599
		600	Compile I<xft>: Turn on/off double-buffering for xft (default enabled).
		601	On some card/driver combination enabling it slightly decreases
		602	performance, on most it greatly helps it. The slowdown is small, so it
		603	should normally be enabled.
		604
569	=item B<geometry:> I<geom>	605	=item B<geometry:> I<geom>
570		606
571	Create the window with the specified X window geometry [default 80x24];	607	Create the window with the specified X window geometry [default 80x24];
572	option B<-geometry>.	608	option B<-geometry>.
573		609
…		…
586	Use the specified colour for the colour value I<n>, where 0-7	622	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	623	corresponds to low-intensity (normal) colours and 8-15 corresponds to
588	high-intensity (bold = bright foreground, blink = bright background)	624	high-intensity (bold = bright foreground, blink = bright background)
589	colours. The canonical names are as follows: 0=black, 1=red, 2=green,	625	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	626	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.	627	names used are listed in the B<COLOURS AND GRAPHICS> section.
592		628
593	Colours higher than 15 cannot be set using resources (yet), but can be	629	Colours higher than 15 cannot be set using resources (yet), but can be
594	changed using an escape command (see @@RXVT_NAME@@(7)).	630	changed using an escape command (see @@RXVT_NAME@@(7)).
595		631
596	Colours 16-79 form a standard 4x4x4 colour cube (the same as xterm with	632	Colours 16-79 form a standard 4x4x4 colour cube (the same as xterm with
…		…
607	=item B<colorUL:> I<colour>	643	=item B<colorUL:> I<colour>
608		644
609	Use the specified colour to display underlined characters when the	645	Use the specified colour to display underlined characters when the
610	foreground colour is the default.	646	foreground colour is the default.
611		647
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>	648	=item B<underlineColor:> I<colour>
618		649
619	If set, use the specified colour as the colour for the underline	650	If set, use the specified colour as the colour for the underline
620	itself. If unset, use the foreground colour.	651	itself. If unset, use the foreground colour.
		652
		653	=item B<highlightColor:> I<colour>
		654
		655	If set, use the specified colour as the background for highlighted
		656	characters. If unset, use reverse video.
		657
		658	=item B<highlightTextColor:> I<colour>
		659
		660	If set and highlightColor is set, use the specified colour as the
		661	foreground for highlighted characters.
621		662
622	=item B<cursorColor:> I<colour>	663	=item B<cursorColor:> I<colour>
623		664
624	Use the specified colour for the cursor. The default is to use the	665	Use the specified colour for the cursor. The default is to use the
625	foreground colour; option B<-cr>.	666	foreground colour; option B<-cr>.
…		…
632		673
633	=item B<reverseVideo:> I<boolean>	674	=item B<reverseVideo:> I<boolean>
634		675
635	B<True>: simulate reverse video by foreground and background colours;	676	B<True>: simulate reverse video by foreground and background colours;
636	option B<-rv>. B<False>: regular screen colours [default]; option	677	option B<-rv>. B<False>: regular screen colours [default]; option
637	B<+rv>. See note in B<COLORS AND GRAPHICS> section.	678	B<+rv>. See note in B<COLOURS AND GRAPHICS> section.
638		679
639	=item B<jumpScroll:> I<boolean>	680	=item B<jumpScroll:> I<boolean>
640		681
641	B<True>: specify that jump scrolling should be used. When receiving lots	682	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	683	of lines, @@RXVT_NAME@@ will only scroll once a whole screen height of lines
…		…
663	Turn on/off illusion of a transparent window background.	704	Turn on/off illusion of a transparent window background.
664		705
665	B<inheritPixmap> is still accepted as an obsolete alias but will be removed in	706	B<inheritPixmap> is still accepted as an obsolete alias but will be removed in
666	future versions.	707	future versions.
667		708
668	I<Please address all transparency related issues to Sasha Vasko at
669	sasha@aftercode.net. Read the FAQ (man 7 @@RXVT_NAME@@)!>
670
671	=item B<fading:> I<number>	709	=item B<fading:> I<number>
672		710
673	Fade the text by the given percentage when focus is lost; option B<-fade>.	711	Fade the text by the given percentage when focus is lost; option B<-fade>.
674		712
675	=item B<fadeColor:> I<colour>	713	=item B<fadeColor:> I<colour>
…		…
691		729
692	Specify background blending type; option B<-blt>.	730	Specify background blending type; option B<-blt>.
693		731
694	=item B<blurRadius:> I<number>	732	=item B<blurRadius:> I<number>
695		733
696	Apply Gaussian Blurr with the specified radius to the transparent	734	Apply gaussian blur with the specified radius to the transparent
697	background image; option B<-blr>.	735	background image; option B<-blr>.
		736
		737	=item B<iconFile:> I<file>
		738
		739	Set the application icon pixmap; option B<-icon>.
698		740
699	=item B<scrollColor:> I<colour>	741	=item B<scrollColor:> I<colour>
700		742
701	Use the specified colour for the scrollbar [default #B2B2B2].	743	Use the specified colour for the scrollbar [default #B2B2B2].
702		744
…		…
712		754
713	=item B<backgroundPixmap:> I<file[;geom[:op1][:op2][...]]>	755	=item B<backgroundPixmap:> I<file[;geom[:op1][:op2][...]]>
714		756
715	Use the specified image file for the background and also	757	Use the specified image file for the background and also
716	optionally specify its scaling with a geometry string B<WxH+X+Y>,	758	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	759	(default C<100x100+50+50>) in which B<"W" / "H"> specify the
718	horizontal/vertical scale (percent), and B<"X" / "Y"> locate the image	760	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	761	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	762	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...>.	763	Additional operations can be specified after colon B<:op1:op2...>.
724	Supported operations are:	764	Supported operations are:
725		765
726	tile force background image to be tiled and not scaled. Equivalent to 0x0,	766	tile force background image to be tiled and not scaled. Equivalent to 0x0
727	propscale will scale image keeping proportions,	767	propscale will scale image keeping proportions
728	auto will scale image to match window size. Equivalent to 100x100;	768	auto will scale image to match window size. Equivalent to 100x100
729	hscale will scale image horizontally to the window size;	769	hscale will scale image horizontally to the window size
730	vscale will scale image vertically to the window size;	770	vscale will scale image vertically to the window size
731	scale will scale image to match window size;	771	scale will scale image to match window size
732	root will tile image as if it was a root window background, auto-adjusting	772	root will tile image as if it was a root window background, auto-adjusting
733	whenever terminal window moves.	773	whenever terminal window moves
734		774
735	If used in conjunction with B<-tr> option, the specified pixmap will be	775	If used in conjunction with B<-tr> option, the specified pixmap will be
736	blended over transparency image using either alpha-blending, or any	776	blended over transparency image using alpha-blending. If I<afterimage>
737	other blending type, specified with B<-blt "type"> option.	777	support has been compiled in it is possible to choose other blending
		778	types with B<-blt "type"> option.
738		779
739	=item B<path:> I<path>	780	=item B<path:> I<path>
740		781
741	Specify the colon-delimited search path for finding background image files.	782	Specify the colon-delimited search path for finding background image files.
742		783
…		…
769	it is named first) and thus defines the character cell grid to be 9 pixels	810	it is named first) and thus defines the character cell grid to be 9 pixels
770	wide and 15 pixels high.	811	wide and 15 pixels high.
771		812
772	The second font is just used to add additional unicode characters not in	813	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	814	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	815	the bold version of the font does contain fewer characters, so this is a
775	useful supplement.	816	useful supplement.
776		817
777	The third font is an Xft font with aliasing turned off, and the characters	818	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	819	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.	820	contains other characters, but we are not interested in them.
…		…
803	text font will being used for the given style.	844	text font will being used for the given style.
804		845
805	=item B<intensityStyles:> I<boolean>	846	=item B<intensityStyles:> I<boolean>
806		847
807	When font styles are not enabled, or this option is enabled (B<True>,	848	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	849	option B<-is>, the default), bold/blink font styles imply high
809	intensity foreground/background colours. Disabling this option (B<False>,	850	intensity foreground/background colours. Disabling this option (B<False>,
810	option B<+is>) disables this behaviour, the high intensity colours are not	851	option B<+is>) disables this behaviour, the high intensity colours are not
811	reachable.	852	reachable.
812		853
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>	854	=item B<title:> I<string>
826		855
827	Set window title string, the default title is the command-line	856	Set window title string, the default title is the command-line
828	specified after the B<-e> option, if any, otherwise the application	857	specified after the B<-e> option, if any, otherwise the application
829	name; option B<-title>.	858	name; option B<-title>.
…		…
842	=item B<urgentOnBell:> I<boolean>	871	=item B<urgentOnBell:> I<boolean>
843		872
844	B<True>: set the urgency hint for the wm on receipt of a bell character.	873	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].	874	B<False>: do not set the urgency hint [default].
846		875
		876	@@RXVT_NAME@@ resets the urgency hint on every focus change.
		877
847	=item B<visualBell:> I<boolean>	878	=item B<visualBell:> I<boolean>
848		879
849	B<True>: use visual bell on receipt of a bell character; option B<-vb>.	880	B<True>: use visual bell on receipt of a bell character; option B<-vb>.
850	B<False>: no visual bell [default]; option B<+vb>.	881	B<False>: no visual bell [default]; option B<+vb>.
851		882
…		…
873		904
874	URxvt.print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX)	905	URxvt.print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX)
875		906
876	This creates a new file in your home directory with the screen contents	907	This creates a new file in your home directory with the screen contents
877	every time you hit C<Print>.	908	every time you hit C<Print>.
		909
		910	=item B<scrollstyle:> I<mode>
		911
		912	Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is
		913	the author's favourite.
878		914
879	=item B<scrollBar:> I<boolean>	915	=item B<scrollBar:> I<boolean>
880		916
881	B<True>: enable the scrollbar [default]; option B<-sb>. B<False>:	917	B<True>: enable the scrollbar [default]; option B<-sb>. B<False>:
882	disable the scrollbar; option B<+sb>.	918	disable the scrollbar; option B<+sb>.
…		…
970	=item B<cursorBlink:> I<boolean>	1006	=item B<cursorBlink:> I<boolean>
971		1007
972	B<True>: blink the cursor. B<False>: do not blink the cursor [default];	1008	B<True>: blink the cursor. B<False>: do not blink the cursor [default];
973	option B<-bc>.	1009	option B<-bc>.
974		1010
		1011	=item B<cursorUnderline:> I<boolean>
		1012
		1013	B<True>: Make the cursor underlined. B<False>: Make the cursor a box [default];
		1014	option B<-uc>.
		1015
975	=item B<pointerBlank:> I<boolean>	1016	=item B<pointerBlank:> I<boolean>
976		1017
977	B<True>: blank the pointer when a key is pressed or after a set number	1018	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	1019	of seconds of inactivity. B<False>: the pointer is always visible
979	[default].	1020	[default].
…		…
992	large number (e.g. C<987654321>) to effectively disable the timeout.	1033	large number (e.g. C<987654321>) to effectively disable the timeout.
993		1034
994	=item B<backspacekey:> I<string>	1035	=item B<backspacekey:> I<string>
995		1036
996	The string to send when the backspace key is pressed. If set to B<DEC>	1037	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>	1038	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	1039	(code 8) - which can be reversed with the appropriate DEC private mode
999	escape sequence.	1040	escape sequence.
1000		1041
1001	=item B<deletekey:> I<string>	1042	=item B<deletekey:> I<string>
1002		1043
…		…
1081		1122
1082	=item B<secondaryScroll:> I<boolean>	1123	=item B<secondaryScroll:> I<boolean>
1083		1124
1084	Turn on/off secondary screen scroll (default enabled). If this	1125	Turn on/off secondary screen scroll (default enabled). If this
1085	option is enabled, scrolls on the secondary screen will change the	1126	option is enabled, scrolls on the secondary screen will change the
1086	scrollback buffer and switching to/from the secondary screen will	1127	scrollback buffer and, when secondaryScreen is off, switching
1087	instead scroll the screen up.	1128	to/from the secondary screen will instead scroll the screen up.
1088		1129
1089	=item B<hold>: I<boolean>	1130	=item B<hold>: I<boolean>
1090		1131
1091	Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@	1132	Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@
1092	will not immediately destroy its window when the program executed within	1133	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	1134	it exits. Instead, it will wait till it is being killed or closed by the
1094	user.	1135	user.
		1136
		1137	=item B<chdir>: I<path>
		1138
		1139	Sets the working directory for the shell (or the command specified via
		1140	B<-e>). The I<path> must be an absolute path and it must exist for
		1141	@@RXVT_NAME@@ to start. If it isn't specified then the current working
		1142	directory will be used; option B<-cd>.
1095		1143
1096	=item B<keysym.>I<sym>: I<string>	1144	=item B<keysym.>I<sym>: I<string>
1097		1145
1098	Compile I<frills>: Associate I<string> with keysym I<sym>. The	1146	Compile I<frills>: Associate I<string> with keysym I<sym>. The
1099	intervening resource name B<keysym.> cannot be omitted.	1147	intervening resource name B<keysym.> cannot be omitted.
…		…
1114	omitting the prefix B<XK_>. Alternatively you can specify I<key> by its hex	1162	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	1163	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.	1164	performed in an exact manner; however, the closest match is assured.
1117		1165
1118	I<string> may contain escape values (C<\n>: newline, C<\000>: octal	1166	I<string> may contain escape values (C<\n>: newline, C<\000>: octal
1119	number), see RESOURCES in C<man 7 X> for futher details.	1167	number), see RESOURCES in C<man 7 X> for further details.
1120		1168
1121	You can define a range of keysyms in one shot by providing a I<string>	1169	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 `/'	1170	with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimiter `/'
1123	should be a character not used by the strings.	1171	should be a character not used by the strings.
1124		1172
…		…
1138	when Control-Meta-c is being pressed":	1186	when Control-Meta-c is being pressed":
1139		1187
1140	URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007	1188	URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007
1141		1189
1142	If I<string> takes the form C<perl:STRING>, then the specified B<STRING>	1190	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)	1191	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	1192	manpage. For example, the F<selection> extension (activated via
1145	C<@@RXVT_NAME@@ -pe selection>) listens for C<selection:rot13> events:	1193	C<@@RXVT_NAME@@ -pe selection>) listens for C<selection:rot13> events:
1146		1194
1147	URxvt.keysym.M-C-c: perl:selection:rot13	1195	URxvt.keysym.M-C-c: perl:selection:rot13
1148		1196
1149	Due the the large number of modifier combinations, a defined key mapping	1197	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	1198	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	1199	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	1200	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	1201	definitions for C<Meta-a>, C<Shift-a> and so on, unless some of those are defined
1154	mappings themselves.	1202	mappings themselves.
1155		1203
…		…
1206	all instances, while B<perl-ext> is used for specific instances.	1254	all instances, while B<perl-ext> is used for specific instances.
1207		1255
1208	=item B<perl-eval>: I<string>	1256	=item B<perl-eval>: I<string>
1209		1257
1210	Perl code to be evaluated when all extensions have been registered. See	1258	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	1259	the @@RXVT_NAME@@perl(3) manpage.
1212	will be ignored when running setuid/setgid.
1213		1260
1214	=item B<perl-lib>: I<path>	1261	=item B<perl-lib>: I<path>
1215		1262
1216	Colon-separated list of additional directories that hold extension	1263	Colon-separated list of additional directories that hold extension
1217	scripts. When looking for extensions specified by the C<perl> resource,	1264	scripts. When looking for extensions specified by the C<perl> resource,
1218	@@RXVT_NAME@@ will first look in these directories and then in	1265	@@RXVT_NAME@@ will first look in these directories and then in
1219	F<@@RXVT_LIBDIR@@/urxvt/perl/>. Due to security reasons, this resource	1266	F<@@RXVT_LIBDIR@@/urxvt/perl/>.
1220	will be ignored when running setuid/setgid.
1221		1267
1222	See the @@RXVT_NAME@@perl(3) manpage.	1268	See the @@RXVT_NAME@@perl(3) manpage.
1223		1269
1224	=item B<< selection.pattern-I<idx> >>: I<perl-regex>	1270	=item B<< selection.pattern-I<idx> >>: I<perl-regex>
1225		1271
…		…
1247		1293
1248	=item B<override-redirect>: I<boolean>	1294	=item B<override-redirect>: I<boolean>
1249		1295
1250	Compile I<frills>: Sets override-redirect for the terminal window, making	1296	Compile I<frills>: Sets override-redirect for the terminal window, making
1251	it almost invisible to window managers; option B<-override-redirect>.	1297	it almost invisible to window managers; option B<-override-redirect>.
		1298
		1299	=item B<iso14755:> I<boolean>
		1300
		1301	Turn on/off ISO 14755 (default enabled).
1252		1302
1253	=item B<iso14755_52:> I<boolean>	1303	=item B<iso14755_52:> I<boolean>
1254		1304
1255	Turn on/off ISO 14755 5.2 mode (default enabled).	1305	Turn on/off ISO 14755 5.2 mode (default enabled).
1256		1306
…		…
1399	B<@@RXVT_NAME@@> tries to write an entry into the I<utmp>(5) file so that	1449	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	1450	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	1451	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.	1452	on some systems or setgid to root or to some other group on others.
1403		1453
1404	=head1 COLORS AND GRAPHICS	1454	=head1 COLOURS AND GRAPHICS
1405		1455
1406	In addition to the default foreground and background colours,	1456	In addition to the default foreground and background colours,
1407	B<@@RXVT_NAME@@> can display up to 16 colours (8 ANSI colours plus	1457	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	1458	high-intensity (potentially bold/blink) versions of the same, and 72 (or
1409	colours with their names.	1459	240 in 256 colour mode) colours arranged in an 4x4x4 (or 6x6x6) colour RGB
		1460	cube plus a 8 (24) colour greyscale ramp.
		1461
		1462	Here is a list of the ANSI colours with their names.
1410		1463
1411	=begin table	1464	=begin table
1412		1465
1413	B<color0> (black) = Black	1466	B<color0> (black) = Black
1414	B<color1> (red) = Red3	1467	B<color1> (red) = Red3
…		…
1434	It is also possible to specify the colour values of B<foreground>,	1487	It is also possible to specify the colour values of B<foreground>,
1435	B<background>, B<cursorColor>, B<cursorColor2>, B<colorBD>, B<colorUL> as	1488	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	1489	a number 0-15, as a convenient shorthand to reference the colour name of
1437	color0-color15.	1490	color0-color15.
1438		1491
1439	In addition to the colours defined above, @@RXVT_NAME@@ offers an	1492	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)	1493	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		1494
		1495	The RGB cube uses indices 16..79 (16..231) using the following formulas:
		1496
		1497	index_88 = (r * 4 + g) * 4 + b + 16 # r, g, b = 0..3
		1498	index_256 = (r * 16 + g) * 16 + b + 16 # r, g, b = 0..15
		1499
		1500	The grayscale ramp uses indices 80..87 (232..239), from 10% to 90% in 10%
		1501	steps (1/26 to 25/26 in 1/26 steps) - black and white are already part of
		1502	the RGB cube.
		1503
1444	Together, all those colours implement the 88 colour xterm colours. Only	1504	Together, all those colours implement the 88 (256) colour xterm
1445	the first 16 can be changed using resources currently, the rest can only	1505	colours. Only the first 16 can be changed using resources currently, the
1446	be changed via command sequences ("escape codes").	1506	rest can only be changed via command sequences ("escape codes").
		1507
		1508	Applications are advised to use terminfo or command sequences to discover
		1509	number and RGB values of all colours (yes, you can query this...).
1447		1510
1448	Note that B<-rv> (B<"reverseVideo: True">) simulates reverse video by	1511	Note that B<-rv> (B<"reverseVideo: True">) simulates reverse video by
1449	always swapping the foreground/background colours. This is in contrast to	1512	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	1513	I<xterm>(1) where the colours are only swapped if they have not otherwise
1451	been specified. For example,	1514	been specified. For example,
1452		1515
1453	=over 4
1454
1455	=item B<@@RXVT_NAME@@ -fg Black -bg White -rv>	1516	@@RXVT_NAME@@ -fg Black -bg White -rv
1456		1517
1457	would yield White on Black, while on I<xterm>(1) it would yield Black	1518	would yield White on Black, while on I<xterm>(1) it would yield Black on
1458	on White.	1519	White.
1459
1460	=back
1461		1520
1462	=head2 ALPHA CHANNEL SUPPORT	1521	=head2 ALPHA CHANNEL SUPPORT
1463		1522
1464	If Xft support has been compiled in and as long as Xft/Xrender/X don't get	1523	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>	1524	their act together, rxvt-unicode will do it's own alpha channel management:
1466	(recommended, but B<MUST> have 4 digits/component) colour specifications,	1525
1467	in addition to the ones provided by X, where the additional A component	1526	You can prefix any colour with an opaqueness percentage enclosed in
		1527	brackets, i.e. C<[percent]>, where C<percent> is a decimal percentage
		1528	(0-100) that specifies the opacity of the colour, where C<0> is completely
		1529	transparent and C<100> is completely opaque. For example, C<[50]red> is a
		1530	half-transparent red, while C<[95]#00ff00> is an almost opaque green. This
		1531	is the recommended format to specify transparency values, and works with
		1532	all ways to specify a colour.
		1533
		1534	For complete control, rxvt-unicode also supports
		1535	C<rgba:rrrr/gggg/bbbb/aaaa> (exactly four hex digits/component) colour
		1536	specifications, where the additional C<aaaa> component specifies opacity
1468	specifies opacity (alpha) values. The minimum value of C<0> is completely	1537	(alpha) values. The minimum value of C<0000> is completely transparent,
1469	transparent). You can also prefix any color with C<[percent]>, where	1538	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	1539	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	1540	C<rgba:0000/ff00/0000/f332>.
1472	opaque.
1473		1541
1474	You probably need to specify B<"-depth 32">, too, and have the luck that	1542	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	1543	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.	1544	layout, as X is far from just supporting ARGB visuals out of the box, and
		1545	rxvt-unicode just fudges around.
1477		1546
1478	For example, the following selects an almost completely transparent red	1547	For example, the following selects an almost completely transparent black
1479	background, and an almost opaque pink foreground:	1548	background, and an almost opaque pink foreground:
1480		1549
1481	@@RXVT_NAME@@ -depth 32 -bg rgba:0000/0000/0000/aaaa -fg "[80]pink"	1550	@@RXVT_NAME@@ -depth 32 -bg rgba:0000/0000/0000/4444 -fg "[80]pink"
1482		1551
1483	I<Please note that transparency of any kind if completely unsupported by	1552	When not using a background image, then the interpretation of the
1484	the author. Don't bug him with installation questions!>	1553	alpha channel is up to your compositing manager (most interpret it as
		1554	transparency of course).
		1555
		1556	When using a background pixmap or pseudo-transparency, then the background
		1557	colour will always behave as if it were completely transparent (so the
		1558	background image shows instead), regardless of how it was specified, while
		1559	other colours will either be transparent as specified (the background
		1560	image will show through) on servers supporting the RENDER extension, or
		1561	fully opaque on servers not supporting the RENDER EXTENSION.
		1562
		1563	Please note that due to bugs in Xft, specifying alpha values might result
		1564	in garbage being displayed when the X-server does not support the RENDER
		1565	extension.
1485		1566
1486	=head1 ENVIRONMENT	1567	=head1 ENVIRONMENT
1487		1568
1488	B<@@RXVT_NAME@@> sets and/or uses the following environment variables:	1569	B<@@RXVT_NAME@@> sets and/or uses the following environment variables:
1489		1570
…		…
1523	C<--with-terminfo=PATH>.	1604	C<--with-terminfo=PATH>.
1524		1605
1525	=item B<DISPLAY>	1606	=item B<DISPLAY>
1526		1607
1527	Used by @@RXVT_NAME@@ to connect to the display and set to the correct	1608	Used by @@RXVT_NAME@@ to connect to the display and set to the correct
1528	display in its child processes.	1609	display in its child processes if C<-display> isn't used to override. It
		1610	defaults to C<:0> if it doesn't exist.
1529		1611
1530	=item B<SHELL>	1612	=item B<SHELL>
1531		1613
1532	The shell to be used for command execution, defaults to C</bin/sh>.	1614	The shell to be used for command execution, defaults to C</bin/sh>.
1533		1615
…		…
1559		1641
1560	=over 4	1642	=over 4
1561		1643
1562	=item B</usr/lib/X11/rgb.txt>	1644	=item B</usr/lib/X11/rgb.txt>
1563		1645
1564	Color names.	1646	Colour names.
1565		1647
1566	=back	1648	=back
1567		1649
1568	=head1 SEE ALSO	1650	=head1 SEE ALSO
1569		1651

Diff Legend

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

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents): Revision 1.152 by root, Wed Dec 12 19:56:37 2007 UTC vs. Revision 1.187 by sf-exg, Fri Oct 15 10:46:57 2010 UTC

Diff Legend

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents):
Revision 1.152 by root, Wed Dec 12 19:56:37 2007 UTC vs.
Revision 1.187 by sf-exg, Fri Oct 15 10:46:57 2010 UTC