[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.212 by sf-exg, Sun Jan 1 14:31:28 2012 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>
…		…
116		124
117	Turn on/off skip scrolling (allow multiple screens per refresh); resource B<skipScroll>.	125	Turn on/off skip scrolling (allow multiple screens per refresh); resource B<skipScroll>.
118		126
119	=item B<-tr>\|B<+tr>	127	=item B<-tr>\|B<+tr>
120		128
121	Turn on/off illusion of a transparent window background; resource B<transparent>.	129	Turn on/off pseudo-transparency by using the root pixmap as 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
…		…
137	Fade to this colour when fading is used (see B<-fade>). The default colour	142	Fade to this colour when fading is used (see B<-fade>). The default colour
138	is opaque black. resource B<fadeColor>.	143	is opaque black. resource B<fadeColor>.
139		144
140	=item B<-tint> I<colour>	145	=item B<-tint> I<colour>
141		146
142	Tint the transparent background pixmap with the given colour when	147	Tint the transparent background with the given colour;
143	transparency is enabled with B<-tr>. This only works for	148	resource I<tintColor>.
144	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.
146	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:
148	blue, red, green, cyan, magenta, yellow, and those close to them. Also
149	pure black and pure white colors essentially mean no tinting; resource
150	I<tintColor>. Example:
151
152	@@RXVT_NAME@@ -tr -tint blue -sh 40
153		149
154	=item B<-sh> I<number>	150	=item B<-sh> I<number>
155		151
156	Darken (0 .. 100) or lighten (100 .. 200) the transparent	152	Darken (0 .. 99) or lighten (101 .. 200) the transparent background.
157	background image in addition to (or instead of) tinting it;	153	A value of 100 means no shading; resource I<shading>.
158	resource I<shading>.
159		154
160	=item B<-blt> I<string>	155	=item B<-blt> I<string>
161		156
162	Specify background blending type. If background pixmap is specified	157	Specify background blending type. If background pixmap is specified
163	at the same time as transparency - such pixmap will be blended over	158	at the same time as transparency - such pixmap will be blended over
164	transparency image, using method specified. Supported values are :	159	the transparent background, using the method specified. Supported values are:
165	B<add>, B<alphablend>, B<allanon> - color values averaging, B<colorize>,	160	B<add>, B<alphablend>, B<allanon> - colour values averaging, B<colorize>,
166	B<darken>, B<diff>, B<dissipate>, B<hue>, B<lighten>, B<overlay>,	161	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	162	B<saturate>, B<screen>, B<sub>, B<tint>, B<value>. The default is
168	alpha-blending. Compile I<afterimage>; resource I<blendType>.	163	alpha-blending. Compile I<afterimage>; resource I<blendType>.
169		164
170	=item B<-blr> I<HxV>	165	=item B<-blr> I<HxV>
171		166
172	Apply Gaussian Blur with the specified radii to the transparent	167	Apply Gaussian Blur with the specified radii to the transparent
173	background image. If single number is specified - both vertical and	168	background. If a single number is specified, the vertical and
174	horizontal radii are considered to be the same. Setting one of the	169	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	170	radii to 1 and the other to a large number creates interesting effects
176	on some backgrounds. Maximum radius value is 128. Compile I<afterimage>;	171	on some backgrounds. The maximum radius value is 128. An horizontal or
		172	vertical radius of 0 disables blurring;
177	resource I<blurRadius>.	173	resource I<blurRadius>.
178		174
		175	=item B<-icon> I<file>
		176
		177	Compile I<afterimage> or I<pixbuf>: Use the specified image as application icon. This
		178	is used by many window managers, taskbars and pagers to represent the
		179	application window; resource I<iconFile>.
		180
179	=item B<-bg> I<colour>	181	=item B<-bg> I<colour>
180		182
181	Window background colour; resource B<background>.	183	Window background colour; resource B<background>.
182		184
183	=item B<-fg> I<colour>	185	=item B<-fg> I<colour>
184		186
185	Window foreground colour; resource B<foreground>.	187	Window foreground colour; resource B<foreground>.
186		188
187	=item B<-pixmap> I<file[;geom[:op1][:op2][...]]>	189	=item B<-pixmap> I<file[;oplist]>
188		190
189	Compile I<afterimage>: Specify image file for the background and also	191	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	192	optionally specify a list of operations to modify it. Note you may need to
191	add quotes to avoid special shell interpretation of the C<;> in the	193	add quotes to avoid special shell interpretation of the C<;> in the
192	command-line; for more details see resource B<backgroundPixmap>.	194	command-line; for more details see resource B<backgroundPixmap>.
193		195
194	=item B<-cr> I<colour>	196	=item B<-cr> I<colour>
195		197
…		…
242	italic> >> characters are to be printed. See resource B<boldItalicFont>	244	italic> >> characters are to be printed. See resource B<boldItalicFont>
243	for details.	245	for details.
244		246
245	=item B<-is>\|B<+is>	247	=item B<-is>\|B<+is>
246		248
247	Compile I<font-styles>: Bold/Italic font styles imply high intensity	249	Compile I<font-styles>: Bold/Blink font styles imply high intensity
248	foreground/background (default). See resource B<intensityStyles> for	250	foreground/background (default). See resource B<intensityStyles> for
249	details.	251	details.
250		252
251	=item B<-name> I<name>	253	=item B<-name> I<name>
252		254
…		…
270		272
271	=item B<-sb>\|B<+sb>	273	=item B<-sb>\|B<+sb>
272		274
273	Turn on/off scrollbar; resource B<scrollBar>.	275	Turn on/off scrollbar; resource B<scrollBar>.
274		276
		277	=item B<-sr>\|B<+sr>
		278
		279	Put scrollbar on right/left; resource B<scrollBar_right>.
		280
		281	=item B<-st>\|B<+st>
		282
		283	Display rxvt (non XTerm/NeXT) scrollbar without/with a trough;
		284	resource B<scrollBar_floating>.
		285
275	=item B<-si>\|B<+si>	286	=item B<-si>\|B<+si>
276		287
277	Turn on/off scroll-to-bottom on TTY output inhibit; resource	288	Turn on/off scroll-to-bottom on TTY output inhibit; resource
278	B<scrollTtyOutput> has opposite effect.	289	B<scrollTtyOutput> has opposite effect.
279		290
…		…
285	=item B<-sw>\|B<+sw>	296	=item B<-sw>\|B<+sw>
286		297
287	Turn on/off scrolling with the scrollback buffer as new lines appear.	298	Turn on/off scrolling with the scrollback buffer as new lines appear.
288	This only takes effect if B<-si> is also given; resource	299	This only takes effect if B<-si> is also given; resource
289	B<scrollWithBuffer>.	300	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		301
300	=item B<-ptab>\|B<+ptab>	302	=item B<-ptab>\|B<+ptab>
301		303
302	If enabled (default), "Horizontal Tab" characters are being stored as	304	If enabled (default), "Horizontal Tab" characters are being stored as
303	actual wide characters in the screen buffer, which makes it possible to	305	actual wide characters in the screen buffer, which makes it possible to
…		…
307		309
308	=item B<-bc>\|B<+bc>	310	=item B<-bc>\|B<+bc>
309		311
310	Blink the cursor; resource B<cursorBlink>.	312	Blink the cursor; resource B<cursorBlink>.
311		313
		314	=item B<-uc>\|B<+uc>
		315
		316	Make the cursor underlined; resource B<cursorUnderline>.
		317
312	=item B<-iconic>	318	=item B<-iconic>
313		319
314	Start iconified, if the window manager supports that option.	320	Start iconified, if the window manager supports that option.
315	Alternative form is B<-ic>.	321	Alternative form is B<-ic>.
316		322
…		…
332		338
333	=item B<-bl>	339	=item B<-bl>
334		340
335	Compile I<frills>: Set MWM hints to request a borderless window, i.e.	341	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	342	if honoured by the WM, the rxvt-unicode window will not have window
337	decorations; resource B<borderLess>.	343	decorations; resource B<borderLess>. If the window manager does not
		344	support MWM hints (e.g. kwin), enables override-redirect mode.
338		345
339	=item B<-override-redirect>	346	=item B<-override-redirect>
340		347
341	Compile I<frills>: Sets override-redirect on the window; resource	348	Compile I<frills>: Sets override-redirect on the window; resource
342	B<override-redirect>.	349	B<override-redirect>.
…		…
351	=item B<-lsp> I<number>	358	=item B<-lsp> I<number>
352		359
353	Compile I<frills>: Lines (pixel height) to insert between each row of	360	Compile I<frills>: Lines (pixel height) to insert between each row of
354	the display. Useful to work around font rendering problems; resource	361	the display. Useful to work around font rendering problems; resource
355	B<lineSpace>.	362	B<lineSpace>.
		363
		364	=item B<-letsp> I<number>
		365
		366	Compile I<frills>: Amount to adjust the computed character width by
		367	to control overall letter spacing. Negative values will tighten up the
		368	letter spacing, positive values will space letters out more. Useful to
		369	work around odd font metrics; resource B<letterSpace>.
356		370
357	=item B<-tn> I<termname>	371	=item B<-tn> I<termname>
358		372
359	This option specifies the name of the terminal type to be set in the	373	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	374	B<TERM> environment variable. This terminal type must exist in the
…		…
447	Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@	461	Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@
448	will not immediately destroy its window when the program executed within	462	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	463	it exits. Instead, it will wait till it is being killed or closed by the
450	user; resource B<hold>.	464	user; resource B<hold>.
451		465
		466	=item B<-cd> I<path>
		467
		468	Sets the working directory for the shell (or the command specified via
		469	B<-e>). The I<path> must be an absolute path and it must exist for
		470	@@RXVT_NAME@@ to start; resource B<chdir>.
		471
452	=item B<-xrm> I<string>	472	=item B<-xrm> I<string>
453		473
454	Works like the X Toolkit option of the same name, by adding the I<string>	474	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	475	as if it were specified in a resource file. Resource values specified this
456	way take precedence over all other resource specifications.	476	way take precedence over all other resource specifications.
…		…
539	You can set and change the resources using X11 tools like B<xrdb>. Many	559	You can set and change the resources using X11 tools like B<xrdb>. Many
540	distribution do also load settings from the B<~/.Xresources> file when X	560	distribution do also load settings from the B<~/.Xresources> file when X
541	starts. @@RXVT_NAME@@ will consult the following files/resources in order,	561	starts. @@RXVT_NAME@@ will consult the following files/resources in order,
542	with later settings overwriting earlier ones:	562	with later settings overwriting earlier ones:
543		563
544	1. system-wide app-defaults file, either locale-dependent OR global
545	2. app-defaults file in $XAPPLRESDIR	564	1. app-defaults file in $XAPPLRESDIR
		565	2. $HOME/.Xdefaults
546	3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults	566	3. RESOURCE_MANAGER property on root-window of screen 0
547	4. SCREEN_RESOURCES for the current screen	567	4. SCREEN_RESOURCES property on root-window of the current screen
548	5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename>	568	5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename>
549	6. resources specified via -xrm on the commandline	569	6. resources specified via -xrm on the commandline
550		570
551	Note that when reading X resources, B<@@RXVT_NAME@@> recognizes two class	571	Note that when reading X resources, B<@@RXVT_NAME@@> recognizes two class
552	names: B<Rxvt> and B<URxvt>. The class name B<Rxvt> allows resources	572	names: B<Rxvt> and B<URxvt>. The class name B<Rxvt> allows resources
…		…
564	=item B<depth:> I<bitdepth>	584	=item B<depth:> I<bitdepth>
565		585
566	Compile I<xft>: Attempt to find a visual with the given bit depth;	586	Compile I<xft>: Attempt to find a visual with the given bit depth;
567	option B<-depth>.	587	option B<-depth>.
568		588
		589	=item B<buffered:> I<boolean>
		590
		591	Compile I<xft>: Turn on/off double-buffering for xft (default enabled).
		592	On some card/driver combination enabling it slightly decreases
		593	performance, on most it greatly helps it. The slowdown is small, so it
		594	should normally be enabled.
		595
569	=item B<geometry:> I<geom>	596	=item B<geometry:> I<geom>
570		597
571	Create the window with the specified X window geometry [default 80x24];	598	Create the window with the specified X window geometry [default 80x24];
572	option B<-geometry>.	599	option B<-geometry>.
573		600
…		…
586	Use the specified colour for the colour value I<n>, where 0-7	613	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	614	corresponds to low-intensity (normal) colours and 8-15 corresponds to
588	high-intensity (bold = bright foreground, blink = bright background)	615	high-intensity (bold = bright foreground, blink = bright background)
589	colours. The canonical names are as follows: 0=black, 1=red, 2=green,	616	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	617	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.	618	names used are listed in the B<COLOURS AND GRAPHICS> section.
592		619
593	Colours higher than 15 cannot be set using resources (yet), but can be	620	Colours higher than 15 cannot be set using resources (yet), but can be
594	changed using an escape command (see @@RXVT_NAME@@(7)).	621	changed using an escape command (see @@RXVT_NAME@@(7)).
595		622
596	Colours 16-79 form a standard 4x4x4 colour cube (the same as xterm with	623	Colours 16-79 form a standard 4x4x4 colour cube (the same as xterm with
…		…
607	=item B<colorUL:> I<colour>	634	=item B<colorUL:> I<colour>
608		635
609	Use the specified colour to display underlined characters when the	636	Use the specified colour to display underlined characters when the
610	foreground colour is the default.	637	foreground colour is the default.
611		638
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>	639	=item B<underlineColor:> I<colour>
618		640
619	If set, use the specified colour as the colour for the underline	641	If set, use the specified colour as the colour for the underline
620	itself. If unset, use the foreground colour.	642	itself. If unset, use the foreground colour.
		643
		644	=item B<highlightColor:> I<colour>
		645
		646	If set, use the specified colour as the background for highlighted
		647	characters. If unset, use reverse video.
		648
		649	=item B<highlightTextColor:> I<colour>
		650
		651	If set and highlightColor is set, use the specified colour as the
		652	foreground for highlighted characters.
621		653
622	=item B<cursorColor:> I<colour>	654	=item B<cursorColor:> I<colour>
623		655
624	Use the specified colour for the cursor. The default is to use the	656	Use the specified colour for the cursor. The default is to use the
625	foreground colour; option B<-cr>.	657	foreground colour; option B<-cr>.
…		…
632		664
633	=item B<reverseVideo:> I<boolean>	665	=item B<reverseVideo:> I<boolean>
634		666
635	B<True>: simulate reverse video by foreground and background colours;	667	B<True>: simulate reverse video by foreground and background colours;
636	option B<-rv>. B<False>: regular screen colours [default]; option	668	option B<-rv>. B<False>: regular screen colours [default]; option
637	B<+rv>. See note in B<COLORS AND GRAPHICS> section.	669	B<+rv>. See note in B<COLOURS AND GRAPHICS> section.
638		670
639	=item B<jumpScroll:> I<boolean>	671	=item B<jumpScroll:> I<boolean>
640		672
641	B<True>: specify that jump scrolling should be used. When receiving lots	673	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	674	of lines, @@RXVT_NAME@@ will only scroll once a whole screen height of lines
…		…
658	if the refresh is too fast for the human eye to read anything (or the	690	if the refresh is too fast for the human eye to read anything (or the
659	monitor to display anything); option B<+ss>.	691	monitor to display anything); option B<+ss>.
660		692
661	=item B<transparent:> I<boolean>	693	=item B<transparent:> I<boolean>
662		694
663	Turn on/off illusion of a transparent window background.	695	Turn on/off pseudo-transparency by using the root pixmap as background.
664		696
665	B<inheritPixmap> is still accepted as an obsolete alias but will be removed in	697	B<inheritPixmap> is still accepted as an obsolete alias but will be removed in
666	future versions.	698	future versions.
667		699
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>	700	=item B<fading:> I<number>
672		701
673	Fade the text by the given percentage when focus is lost; option B<-fade>.	702	Fade the text by the given percentage when focus is lost; option B<-fade>.
674		703
675	=item B<fadeColor:> I<colour>	704	=item B<fadeColor:> I<colour>
…		…
677	Fade to this colour, when fading is used (see B<fading:>). The default	706	Fade to this colour, when fading is used (see B<fading:>). The default
678	colour is black; option B<-fadecolor>.	707	colour is black; option B<-fadecolor>.
679		708
680	=item B<tintColor:> I<colour>	709	=item B<tintColor:> I<colour>
681		710
682	Tint the transparent background pixmap with the given colour; option	711	Tint the transparent background with the given colour. If the RENDER
683	B<-tint>.	712	extension is not available only black, red, green, yellow, blue,
		713	magenta, cyan and white tints can be performed server-side. Note that
		714	a black tint yields a completely black image while a white tint yields
		715	the image unchanged; option B<-tint>.
684		716
685	=item B<shading:> I<number>	717	=item B<shading:> I<number>
686		718
687	Darken (0 .. 100) or lighten (-1 .. -100) the transparent background image	719	Darken (0 .. 99) or lighten (101 .. 200) the transparent background.
688	in addition to tinting it; option B<-sh>.	720	A value of 100 means no shading; option B<-sh>.
689		721
690	=item B<blendType:> I<string>	722	=item B<blendType:> I<string>
691		723
692	Specify background blending type; option B<-blt>.	724	Specify background blending type; option B<-blt>.
693		725
694	=item B<blurRadius:> I<number>	726	=item B<blurRadius:> I<number>
695		727
696	Apply Gaussian Blurr with the specified radius to the transparent	728	Apply gaussian blur with the specified radius to the transparent
697	background image; option B<-blr>.	729	background; option B<-blr>.
		730
		731	=item B<iconFile:> I<file>
		732
		733	Set the application icon pixmap; option B<-icon>.
698		734
699	=item B<scrollColor:> I<colour>	735	=item B<scrollColor:> I<colour>
700		736
701	Use the specified colour for the scrollbar [default #B2B2B2].	737	Use the specified colour for the scrollbar [default #B2B2B2].
702		738
…		…
708	=item B<borderColor:> I<colour>	744	=item B<borderColor:> I<colour>
709		745
710	The colour of the border around the text area and between the scrollbar	746	The colour of the border around the text area and between the scrollbar
711	and the text.	747	and the text.
712		748
713	=item B<backgroundPixmap:> I<file[;geom[:op1][:op2][...]]>	749	=item B<backgroundPixmap:> I<file[;oplist]>
714		750
715	Use the specified image file for the background and also	751	Use the specified image file for the background and also
716	optionally specify its scaling with a geometry string B<WxH+X+Y>,	752	optionally specify a colon separated list of operations to modify it.
717	(default C<0x0+50+50>) in which B<"W" / "H"> specify the
718	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
720	of 1 displays the image without any scaling. A scale of 2 to 9 specifies
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...>.
724	Supported operations are:	753	Supported operations are:
725		754
726	tile force background image to be tiled and not scaled. Equivalent to 0x0,	755	=over 4
727	propscale will scale image keeping proportions,	756
728	auto will scale image to match window size. Equivalent to 100x100;	757	=item B<WxH+X+Y>
729	hscale will scale image horizontally to the window size;	758
730	vscale will scale image vertically to the window size;	759	sets scale and position. B<"W" / "H"> specify the horizontal/vertical
731	scale will scale image to match window size;	760	scale (percent), and B<"X" / "Y"> locate the image centre (percent). A
732	root will tile image as if it was a root window background, auto-adjusting	761	scale of 0 disables scaling. The maximum permitted scale is 1000.
733	whenever terminal window moves.	762
		763	=item B<op=tile>
		764
		765	enables tiling
		766
		767	=item B<op=keep-aspect>
		768
		769	maintain the image aspect ratio when scaling
		770
		771	=item B<op=root-align>
		772
		773	use the position of the terminal window relative to the root window as
		774	the image offset, simulating a root window background
		775
		776	=back
		777
		778	The default scale and position setting is C<100x100+50+50>.
		779	Alternatively, a predefined set of templates can be used to achieve
		780	the most common setups:
		781
		782	=over 4
		783
		784	=item B<style=tiled>
		785
		786	the image is tiled with no scaling. Equivalent to 0x0+0+0:op=tile
		787
		788	=item B<style=aspect-stretched>
		789
		790	the image is scaled to fill the whole window maintaining the aspect
		791	ratio and centered. Equivalent to 100x100+50+50:op=keep-aspect
		792
		793	=item B<style=stretched>
		794
		795	the image is scaled to fill the whole window. Equivalent to 100x100
		796
		797	=item B<style=centered>
		798
		799	the image is centered with no scaling. Equivalent to 0x0+50+50
		800
		801	=item B<style=root-tiled>
		802
		803	the image is tiled with no scaling and using 'root' positioning.
		804	Equivalent to 0x0:op=tile:op=root-align
		805
		806	=back
		807
		808	If multiple templates are specified the last one wins. Note that a
		809	template overrides all the scale, position and operations settings.
734		810
735	If used in conjunction with B<-tr> option, the specified pixmap will be	811	If used in conjunction with B<-tr> option, the specified pixmap will be
736	blended over transparency image using either alpha-blending, or any	812	blended over the transparent background using alpha-blending. If I<afterimage>
737	other blending type, specified with B<-blt "type"> option.	813	support has been compiled in it is possible to choose other blending
		814	types with B<-blt "type"> option.
738		815
739	=item B<path:> I<path>	816	=item B<path:> I<path>
740		817
741	Specify the colon-delimited search path for finding background image files.	818	Specify the colon-delimited search path for finding background image files.
742		819
…		…
769	it is named first) and thus defines the character cell grid to be 9 pixels	846	it is named first) and thus defines the character cell grid to be 9 pixels
770	wide and 15 pixels high.	847	wide and 15 pixels high.
771		848
772	The second font is just used to add additional unicode characters not in	849	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	850	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	851	the bold version of the font does contain fewer characters, so this is a
775	useful supplement.	852	useful supplement.
776		853
777	The third font is an Xft font with aliasing turned off, and the characters	854	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	855	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.	856	contains other characters, but we are not interested in them.
…		…
803	text font will being used for the given style.	880	text font will being used for the given style.
804		881
805	=item B<intensityStyles:> I<boolean>	882	=item B<intensityStyles:> I<boolean>
806		883
807	When font styles are not enabled, or this option is enabled (B<True>,	884	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	885	option B<-is>, the default), bold/blink font styles imply high
809	intensity foreground/background colours. Disabling this option (B<False>,	886	intensity foreground/background colours. Disabling this option (B<False>,
810	option B<+is>) disables this behaviour, the high intensity colours are not	887	option B<+is>) disables this behaviour, the high intensity colours are not
811	reachable.	888	reachable.
812		889
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>	890	=item B<title:> I<string>
826		891
827	Set window title string, the default title is the command-line	892	Set window title string, the default title is the command-line
828	specified after the B<-e> option, if any, otherwise the application	893	specified after the B<-e> option, if any, otherwise the application
829	name; option B<-title>.	894	name; option B<-title>.
…		…
842	=item B<urgentOnBell:> I<boolean>	907	=item B<urgentOnBell:> I<boolean>
843		908
844	B<True>: set the urgency hint for the wm on receipt of a bell character.	909	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].	910	B<False>: do not set the urgency hint [default].
846		911
		912	@@RXVT_NAME@@ resets the urgency hint on every focus change.
		913
847	=item B<visualBell:> I<boolean>	914	=item B<visualBell:> I<boolean>
848		915
849	B<True>: use visual bell on receipt of a bell character; option B<-vb>.	916	B<True>: use visual bell on receipt of a bell character; option B<-vb>.
850	B<False>: no visual bell [default]; option B<+vb>.	917	B<False>: no visual bell [default]; option B<+vb>.
851		918
…		…
874	URxvt.print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX)	941	URxvt.print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX)
875		942
876	This creates a new file in your home directory with the screen contents	943	This creates a new file in your home directory with the screen contents
877	every time you hit C<Print>.	944	every time you hit C<Print>.
878		945
		946	=item B<scrollstyle:> I<mode>
		947
		948	Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is
		949	the author's favourite.
		950
		951	=item B<thickness:> I<number>
		952
		953	Set the scrollbar width in pixels.
		954
879	=item B<scrollBar:> I<boolean>	955	=item B<scrollBar:> I<boolean>
880		956
881	B<True>: enable the scrollbar [default]; option B<-sb>. B<False>:	957	B<True>: enable the scrollbar [default]; option B<-sb>. B<False>:
882	disable the scrollbar; option B<+sb>.	958	disable the scrollbar; option B<+sb>.
883		959
…		…
902	B<False>: do not scroll to bottom when tty receives output; option	978	B<False>: do not scroll to bottom when tty receives output; option
903	B<+si>.	979	B<+si>.
904		980
905	=item B<scrollWithBuffer:> I<boolean>	981	=item B<scrollWithBuffer:> I<boolean>
906		982
907	B<True>: scroll with scrollback buffer when tty receives new lines (and	983	B<True>: scroll with scrollback buffer when tty receives new lines (i.e.
908	B<scrollTtyOutput> is False); option B<-sw>. B<False>: do not scroll	984	try to show the same lines) and B<scrollTtyOutput> is False; option
909	with scrollback buffer when tty receives new lines; option B<+sw>.	985	B<-sw>. B<False>: do not scroll with scrollback buffer when tty receives
		986	new lines; option B<+sw>.
910		987
911	=item B<scrollTtyKeypress:> I<boolean>	988	=item B<scrollTtyKeypress:> I<boolean>
912		989
913	B<True>: scroll to bottom when a non-special key is pressed. Special keys	990	B<True>: scroll to bottom when a non-special key is pressed. Special keys
914	are those which are intercepted by rxvt-unicode for special handling and	991	are those which are intercepted by rxvt-unicode for special handling and
…		…
970	=item B<cursorBlink:> I<boolean>	1047	=item B<cursorBlink:> I<boolean>
971		1048
972	B<True>: blink the cursor. B<False>: do not blink the cursor [default];	1049	B<True>: blink the cursor. B<False>: do not blink the cursor [default];
973	option B<-bc>.	1050	option B<-bc>.
974		1051
		1052	=item B<cursorUnderline:> I<boolean>
		1053
		1054	B<True>: Make the cursor underlined. B<False>: Make the cursor a box [default];
		1055	option B<-uc>.
		1056
975	=item B<pointerBlank:> I<boolean>	1057	=item B<pointerBlank:> I<boolean>
976		1058
977	B<True>: blank the pointer when a key is pressed or after a set number	1059	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	1060	of seconds of inactivity. B<False>: the pointer is always visible
979	[default].	1061	[default].
…		…
992	large number (e.g. C<987654321>) to effectively disable the timeout.	1074	large number (e.g. C<987654321>) to effectively disable the timeout.
993		1075
994	=item B<backspacekey:> I<string>	1076	=item B<backspacekey:> I<string>
995		1077
996	The string to send when the backspace key is pressed. If set to B<DEC>	1078	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>	1079	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	1080	(code 8) - which can be reversed with the appropriate DEC private mode
999	escape sequence.	1081	escape sequence.
1000		1082
1001	=item B<deletekey:> I<string>	1083	=item B<deletekey:> I<string>
1002		1084
…		…
1081		1163
1082	=item B<secondaryScroll:> I<boolean>	1164	=item B<secondaryScroll:> I<boolean>
1083		1165
1084	Turn on/off secondary screen scroll (default enabled). If this	1166	Turn on/off secondary screen scroll (default enabled). If this
1085	option is enabled, scrolls on the secondary screen will change the	1167	option is enabled, scrolls on the secondary screen will change the
1086	scrollback buffer and switching to/from the secondary screen will	1168	scrollback buffer and, when secondaryScreen is off, switching
1087	instead scroll the screen up.	1169	to/from the secondary screen will instead scroll the screen up.
1088		1170
1089	=item B<hold>: I<boolean>	1171	=item B<hold>: I<boolean>
1090		1172
1091	Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@	1173	Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@
1092	will not immediately destroy its window when the program executed within	1174	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	1175	it exits. Instead, it will wait till it is being killed or closed by the
1094	user.	1176	user.
		1177
		1178	=item B<chdir>: I<path>
		1179
		1180	Sets the working directory for the shell (or the command specified via
		1181	B<-e>). The I<path> must be an absolute path and it must exist for
		1182	@@RXVT_NAME@@ to start. If it isn't specified then the current working
		1183	directory will be used; option B<-cd>.
1095		1184
1096	=item B<keysym.>I<sym>: I<string>	1185	=item B<keysym.>I<sym>: I<string>
1097		1186
1098	Compile I<frills>: Associate I<string> with keysym I<sym>. The	1187	Compile I<frills>: Associate I<string> with keysym I<sym>. The
1099	intervening resource name B<keysym.> cannot be omitted.	1188	intervening resource name B<keysym.> cannot be omitted.
…		…
1114	omitting the prefix B<XK_>. Alternatively you can specify I<key> by its hex	1203	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	1204	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.	1205	performed in an exact manner; however, the closest match is assured.
1117		1206
1118	I<string> may contain escape values (C<\n>: newline, C<\000>: octal	1207	I<string> may contain escape values (C<\n>: newline, C<\000>: octal
1119	number), see RESOURCES in C<man 7 X> for futher details.	1208	number), see RESOURCES in C<man 7 X> for further details.
1120		1209
1121	You can define a range of keysyms in one shot by providing a I<string>	1210	You can define a range of keysyms in one shot by
		1211	loading the C<keysym-list> perl extension and providing a I<string>
1122	with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimiter `/'	1212	with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimiter `/'
1123	should be a character not used by the strings.	1213	should be a character not used by the strings.
1124		1214
1125	Its usage can be demonstrated by an example:	1215	Its usage can be demonstrated by an example:
1126		1216
1127	URxvt.keysym.M-C-0x61: list\|\033<M-C-\|abc\|>	1217	URxvt.keysym.M-C-0x61: list\|\033<\|abc\|>
1128		1218
1129	The above line is equivalent to the following three lines:	1219	The above line is equivalent to the following three lines:
1130		1220
1131	URxvt.keysym.Meta-Control-0x61: \033<M-C-a>	1221	URxvt.keysym.Meta-Control-0x61: \033<a>
1132	URxvt.keysym.Meta-Control-0x62: \033<M-C-b>	1222	URxvt.keysym.Meta-Control-0x62: \033<b>
1133	URxvt.keysym.Meta-Control-0x63: \033<M-C-c>	1223	URxvt.keysym.Meta-Control-0x63: \033<c>
1134		1224
1135	If I<string> takes the form of C<command:STRING>, the specified B<STRING>	1225	If I<string> takes the form of C<command:STRING>, the specified B<STRING>
1136	is interpreted and executed as @@RXVT_NAME@@'s control sequence. For	1226	is interpreted and executed as @@RXVT_NAME@@'s control sequence. For
1137	example the following means "change the current locale to C<zh_CN.GBK>	1227	example the following means "change the current locale to C<zh_CN.GBK>
1138	when Control-Meta-c is being pressed":	1228	when Control-Meta-c is being pressed":
1139		1229
1140	URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007	1230	URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007
1141		1231
1142	If I<string> takes the form C<perl:STRING>, then the specified B<STRING>	1232	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)	1233	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	1234	manpage. For example, the F<selection> extension (activated via
1145	C<@@RXVT_NAME@@ -pe selection>) listens for C<selection:rot13> events:	1235	C<@@RXVT_NAME@@ -pe selection>) listens for C<selection:rot13> events:
1146		1236
1147	URxvt.keysym.M-C-c: perl:selection:rot13	1237	URxvt.keysym.M-C-c: perl:selection:rot13
1148		1238
1149	Due the the large number of modifier combinations, a defined key mapping	1239	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	1240	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	1241	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	1242	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	1243	definitions for C<Meta-a>, C<Shift-a> and so on, unless some of those are defined
1154	mappings themselves.	1244	mappings themselves.
1155		1245
…		…
1206	all instances, while B<perl-ext> is used for specific instances.	1296	all instances, while B<perl-ext> is used for specific instances.
1207		1297
1208	=item B<perl-eval>: I<string>	1298	=item B<perl-eval>: I<string>
1209		1299
1210	Perl code to be evaluated when all extensions have been registered. See	1300	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	1301	the @@RXVT_NAME@@perl(3) manpage.
1212	will be ignored when running setuid/setgid.
1213		1302
1214	=item B<perl-lib>: I<path>	1303	=item B<perl-lib>: I<path>
1215		1304
1216	Colon-separated list of additional directories that hold extension	1305	Colon-separated list of additional directories that hold extension
1217	scripts. When looking for extensions specified by the C<perl> resource,	1306	scripts. When looking for perl extensions, @@RXVT_NAME@@ will first
1218	@@RXVT_NAME@@ will first look in these directories and then in	1307	look in these directories, then in $HOME/.urxvt/ext and lastly in
1219	F<@@RXVT_LIBDIR@@/urxvt/perl/>. Due to security reasons, this resource	1308	F<@@RXVT_LIBDIR@@/urxvt/perl/>.
1220	will be ignored when running setuid/setgid.
1221		1309
1222	See the @@RXVT_NAME@@perl(3) manpage.	1310	See the @@RXVT_NAME@@perl(3) manpage.
1223		1311
1224	=item B<< selection.pattern-I<idx> >>: I<perl-regex>	1312	=item B<< selection.pattern-I<idx> >>: I<perl-regex>
1225		1313
…		…
1247		1335
1248	=item B<override-redirect>: I<boolean>	1336	=item B<override-redirect>: I<boolean>
1249		1337
1250	Compile I<frills>: Sets override-redirect for the terminal window, making	1338	Compile I<frills>: Sets override-redirect for the terminal window, making
1251	it almost invisible to window managers; option B<-override-redirect>.	1339	it almost invisible to window managers; option B<-override-redirect>.
		1340
		1341	=item B<iso14755:> I<boolean>
		1342
		1343	Turn on/off ISO 14755 (default enabled).
1252		1344
1253	=item B<iso14755_52:> I<boolean>	1345	=item B<iso14755_52:> I<boolean>
1254		1346
1255	Turn on/off ISO 14755 5.2 mode (default enabled).	1347	Turn on/off ISO 14755 5.2 mode (default enabled).
1256		1348
…		…
1399	B<@@RXVT_NAME@@> tries to write an entry into the I<utmp>(5) file so that	1491	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	1492	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	1493	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.	1494	on some systems or setgid to root or to some other group on others.
1403		1495
1404	=head1 COLORS AND GRAPHICS	1496	=head1 COLOURS AND GRAPHICS
1405		1497
1406	In addition to the default foreground and background colours,	1498	In addition to the default foreground and background colours,
1407	B<@@RXVT_NAME@@> can display up to 16 colours (8 ANSI colours plus	1499	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	1500	high-intensity (potentially bold/blink) versions of the same, and 72 (or
1409	colours with their names.	1501	240 in 256 colour mode) colours arranged in an 4x4x4 (or 6x6x6) colour RGB
		1502	cube plus a 8 (24) colour greyscale ramp.
		1503
		1504	Here is a list of the ANSI colours with their names.
1410		1505
1411	=begin table	1506	=begin table
1412		1507
1413	B<color0> (black) = Black	1508	B<color0> (black) = Black
1414	B<color1> (red) = Red3	1509	B<color1> (red) = Red3
…		…
1434	It is also possible to specify the colour values of B<foreground>,	1529	It is also possible to specify the colour values of B<foreground>,
1435	B<background>, B<cursorColor>, B<cursorColor2>, B<colorBD>, B<colorUL> as	1530	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	1531	a number 0-15, as a convenient shorthand to reference the colour name of
1437	color0-color15.	1532	color0-color15.
1438		1533
1439	In addition to the colours defined above, @@RXVT_NAME@@ offers an	1534	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)	1535	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		1536
		1537	The RGB cube uses indices 16..79 (16..231) using the following formulas:
		1538
		1539	index_88 = (r * 4 + g) * 4 + b + 16 # r, g, b = 0..3
		1540	index_256 = (r * 16 + g) * 16 + b + 16 # r, g, b = 0..15
		1541
		1542	The grayscale ramp uses indices 80..87 (232..239), from 10% to 90% in 10%
		1543	steps (1/26 to 25/26 in 1/26 steps) - black and white are already part of
		1544	the RGB cube.
		1545
1444	Together, all those colours implement the 88 colour xterm colours. Only	1546	Together, all those colours implement the 88 (256) colour xterm
1445	the first 16 can be changed using resources currently, the rest can only	1547	colours. Only the first 16 can be changed using resources currently, the
1446	be changed via command sequences ("escape codes").	1548	rest can only be changed via command sequences ("escape codes").
		1549
		1550	Applications are advised to use terminfo or command sequences to discover
		1551	number and RGB values of all colours (yes, you can query this...).
1447		1552
1448	Note that B<-rv> (B<"reverseVideo: True">) simulates reverse video by	1553	Note that B<-rv> (B<"reverseVideo: True">) simulates reverse video by
1449	always swapping the foreground/background colours. This is in contrast to	1554	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	1555	I<xterm>(1) where the colours are only swapped if they have not otherwise
1451	been specified. For example,	1556	been specified. For example,
1452		1557
1453	=over 4
1454
1455	=item B<@@RXVT_NAME@@ -fg Black -bg White -rv>	1558	@@RXVT_NAME@@ -fg Black -bg White -rv
1456		1559
1457	would yield White on Black, while on I<xterm>(1) it would yield Black	1560	would yield White on Black, while on I<xterm>(1) it would yield Black on
1458	on White.	1561	White.
1459
1460	=back
1461		1562
1462	=head2 ALPHA CHANNEL SUPPORT	1563	=head2 ALPHA CHANNEL SUPPORT
1463		1564
1464	If Xft support has been compiled in and as long as Xft/Xrender/X don't get	1565	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>	1566	their act together, rxvt-unicode will do its own alpha channel management:
1466	(recommended, but B<MUST> have 4 digits/component) colour specifications,	1567
1467	in addition to the ones provided by X, where the additional A component	1568	You can prefix any colour with an opaqueness percentage enclosed in
		1569	brackets, i.e. C<[percent]>, where C<percent> is a decimal percentage
		1570	(0-100) that specifies the opacity of the colour, where C<0> is completely
		1571	transparent and C<100> is completely opaque. For example, C<[50]red> is a
		1572	half-transparent red, while C<[95]#00ff00> is an almost opaque green. This
		1573	is the recommended format to specify transparency values, and works with
		1574	all ways to specify a colour.
		1575
		1576	For complete control, rxvt-unicode also supports
		1577	C<rgba:rrrr/gggg/bbbb/aaaa> (exactly four hex digits/component) colour
		1578	specifications, where the additional C<aaaa> component specifies opacity
1468	specifies opacity (alpha) values. The minimum value of C<0> is completely	1579	(alpha) values. The minimum value of C<0000> is completely transparent,
1469	transparent). You can also prefix any color with C<[percent]>, where	1580	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	1581	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	1582	C<rgba:0000/ff00/0000/f332>.
1472	opaque.
1473		1583
1474	You probably need to specify B<"-depth 32">, too, and have the luck that	1584	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	1585	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.	1586	layout, as X is far from just supporting ARGB visuals out of the box, and
		1587	rxvt-unicode just fudges around.
1477		1588
1478	For example, the following selects an almost completely transparent red	1589	For example, the following selects an almost completely transparent black
1479	background, and an almost opaque pink foreground:	1590	background, and an almost opaque pink foreground:
1480		1591
1481	@@RXVT_NAME@@ -depth 32 -bg rgba:0000/0000/0000/aaaa -fg "[80]pink"	1592	@@RXVT_NAME@@ -depth 32 -bg rgba:0000/0000/0000/4444 -fg "[80]pink"
1482		1593
1483	I<Please note that transparency of any kind if completely unsupported by	1594	When not using a background image, then the interpretation of the
1484	the author. Don't bug him with installation questions!>	1595	alpha channel is up to your compositing manager (most interpret it as
		1596	transparency of course).
		1597
		1598	When using a background pixmap or pseudo-transparency, then the background
		1599	colour will always behave as if it were completely transparent (so the
		1600	background image shows instead), regardless of how it was specified, while
		1601	other colours will either be transparent as specified (the background
		1602	image will show through) on servers supporting the RENDER extension, or
		1603	fully opaque on servers not supporting the RENDER EXTENSION.
		1604
		1605	Please note that due to bugs in Xft, specifying alpha values might result
		1606	in garbage being displayed when the X-server does not support the RENDER
		1607	extension.
1485		1608
1486	=head1 ENVIRONMENT	1609	=head1 ENVIRONMENT
1487		1610
1488	B<@@RXVT_NAME@@> sets and/or uses the following environment variables:	1611	B<@@RXVT_NAME@@> sets and/or uses the following environment variables:
1489		1612
…		…
1523	C<--with-terminfo=PATH>.	1646	C<--with-terminfo=PATH>.
1524		1647
1525	=item B<DISPLAY>	1648	=item B<DISPLAY>
1526		1649
1527	Used by @@RXVT_NAME@@ to connect to the display and set to the correct	1650	Used by @@RXVT_NAME@@ to connect to the display and set to the correct
1528	display in its child processes.	1651	display in its child processes if C<-display> isn't used to override. It
		1652	defaults to C<:0> if it doesn't exist.
1529		1653
1530	=item B<SHELL>	1654	=item B<SHELL>
1531		1655
1532	The shell to be used for command execution, defaults to C</bin/sh>.	1656	The shell to be used for command execution, defaults to C</bin/sh>.
1533		1657
1534	=item B<RXVT_SOCKET>	1658	=item B<RXVT_SOCKET>
1535		1659
1536	The unix domain socket path used by @@RXVT_NAME@@c(1) and	1660	The unix domain socket path used by @@RXVT_NAME@@c(1) and
1537	@@RXVT_NAME@@d(1).	1661	@@RXVT_NAME@@d(1).
1538		1662
1539	Default F<<< $HOME/.rxvt-unicode-I<< <nodename >> >>>.	1663	Default F<<< $HOME/.urxvt/urxvtd-I<< <nodename> >> >>>.
1540		1664
1541	=item B<HOME>	1665	=item B<HOME>
1542		1666
1543	Used to locate the default directory for the unix domain socket for	1667	Used to locate the default directory for the unix domain socket for
1544	daemon communications and to locate various resource files (such as	1668	daemon communications and to locate various resource files (such as
1545	C<.Xdefaults>)	1669	C<.Xdefaults>)
1546		1670
1547	=item B<XAPPLRESDIR>	1671	=item B<XAPPLRESDIR>
1548		1672
1549	Directory where various X resource files are being located.	1673	Directory where application-specific X resource files are located.
1550		1674
1551	=item B<XENVIRONMENT>	1675	=item B<XENVIRONMENT>
1552		1676
1553	If set and accessible, gives the name of a X resource file to be loaded by	1677	If set and accessible, gives the name of a X resource file to be loaded by
1554	@@RXVT_NAME@@.	1678	@@RXVT_NAME@@.
…		…
1559		1683
1560	=over 4	1684	=over 4
1561		1685
1562	=item B</usr/lib/X11/rgb.txt>	1686	=item B</usr/lib/X11/rgb.txt>
1563		1687
1564	Color names.	1688	Colour names.
1565		1689
1566	=back	1690	=back
1567		1691
1568	=head1 SEE ALSO	1692	=head1 SEE ALSO
1569		1693
…		…
1620		1744
1621	Project Coordinator (Changes 1.0 -)	1745	Project Coordinator (Changes 1.0 -)
1622		1746
1623	=item Emanuele Giaquinta L<< <e.giaquinta@glauco.it> >>	1747	=item Emanuele Giaquinta L<< <e.giaquinta@glauco.it> >>
1624		1748
1625	Pty/tty/utmp/wtmp rewrite, lots of random hacking and bugfixing.	1749	pty/utmp code rewrite, image code improvements, many random hacks and bugfixes.
1626		1750
1627	=back	1751	=back
1628		1752

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.212 by sf-exg, Sun Jan 1 14:31:28 2012 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.212 by sf-exg, Sun Jan 1 14:31:28 2012 UTC