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

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents):
Revision 1.151 by root, Wed Dec 12 19:55:55 2007 UTC vs.
Revision 1.203 by sf-exg, Sat Aug 13 09:05:43 2011 UTC

…		…
12	emulator intended as an I<xterm>(1) replacement for users who do not	12	emulator intended as an I<xterm>(1) replacement for users who do not
13	require features such as Tektronix 4014 emulation and toolkit-style	13	require features such as Tektronix 4014 emulation and toolkit-style
14	configurability. As a result, B<rxvt-unicode> uses much less swap space --	14	configurability. As a result, B<rxvt-unicode> uses much less swap space --
15	a significant advantage on a machine serving many X sessions.	15	a significant advantage on a machine serving many X sessions.
16		16
		17	This document is also available on the World-Wide-Web at
		18	L<http://pod.tst.eu/http://cvs.schmorp.de/rxvt-unicode/doc/rxvt.1.pod>.
		19
17	=head1 FREQUENTLY ASKED QUESTIONS	20	=head1 FREQUENTLY ASKED QUESTIONS
18		21
19	See @@RXVT_NAME@@(7) (try C<man 7 @@RXVT_NAME@@>) for a list of	22	See @@RXVT_NAME@@(7) (try C<man 7 @@RXVT_NAME@@>) for a list of
20	frequently asked questions and answer to them and some common	23	frequently asked questions and answer to them and some common
21	problems. That document is also accessible on the World-Wide-Web at	24	problems. That document is also accessible on the World-Wide-Web at
22	L<http://cvs.schmorp.de/browse/rxvt-unicode/doc/rxvt.7.html>.	25	L<http://pod.tst.eu/http://cvs.schmorp.de/rxvt-unicode/doc/rxvt.7.pod>.
23		26
24	=head1 RXVT-UNICODE VS. RXVT	27	=head1 RXVT-UNICODE VS. RXVT
25		28
26	Unlike the original rxvt, B<rxvt-unicode> stores all text in Unicode	29	Unlike the original rxvt, B<rxvt-unicode> stores all text in Unicode
27	internally. That means it can store and display most scripts in the	30	internally. That means it can store and display most scripts in the
…		…
89		92
90	Print out a message describing available options.	93	Print out a message describing available options.
91		94
92	=item B<-display> I<displayname>	95	=item B<-display> I<displayname>
93		96
94	Attempt to open a window on the named X display (B<-d> still	97	Attempt to open a window on the named X display (the older form B<-d>
95	respected). In the absence of this option, the display specified by the	98	is still respected. but deprecated). In the absence of this option, the
96	B<DISPLAY> environment variable is used.	99	display specified by the B<DISPLAY> environment variable is used.
97		100
98	=item B<-depth> I<bitdepth>	101	=item B<-depth> I<bitdepth>
99		102
100	Compile I<xft>: Attempt to find a visual with the given bit depth;	103	Compile I<xft>: Attempt to find a visual with the given bit depth;
101	resource B<depth>.	104	resource B<depth>.
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 - both 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 another to a large number creates interesting effects
176	on some backgrounds. Maximum radius value is 128. Compile I<afterimage>;	171	on some backgrounds. Maximum radius value is 128;
177	resource I<blurRadius>.	172	resource I<blurRadius>.
178		173
		174	=item B<-icon> I<file>
		175
		176	Compile I<afterimage> or I<pixbuf>: Use the specified image as application icon. This
		177	is used by many window managers, taskbars and pagers to represent the
		178	application window; resource I<iconFile>.
		179
179	=item B<-bg> I<colour>	180	=item B<-bg> I<colour>
180		181
181	Window background colour; resource B<background>.	182	Window background colour; resource B<background>.
182		183
183	=item B<-fg> I<colour>	184	=item B<-fg> I<colour>
184		185
185	Window foreground colour; resource B<foreground>.	186	Window foreground colour; resource B<foreground>.
186		187
187	=item B<-pixmap> I<file[;geom[:op1][:op2][...]]>	188	=item B<-pixmap> I<file[;oplist]>
188		189
189	Compile I<afterimage>: Specify image file for the background and also	190	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	191	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	192	add quotes to avoid special shell interpretation of the C<;> in the
192	command-line; for more details see resource B<backgroundPixmap>.	193	command-line; for more details see resource B<backgroundPixmap>.
193		194
194	=item B<-cr> I<colour>	195	=item B<-cr> I<colour>
195		196
…		…
242	italic> >> characters are to be printed. See resource B<boldItalicFont>	243	italic> >> characters are to be printed. See resource B<boldItalicFont>
243	for details.	244	for details.
244		245
245	=item B<-is>\|B<+is>	246	=item B<-is>\|B<+is>
246		247
247	Compile I<font-styles>: Bold/Italic font styles imply high intensity	248	Compile I<font-styles>: Bold/Blink font styles imply high intensity
248	foreground/background (default). See resource B<intensityStyles> for	249	foreground/background (default). See resource B<intensityStyles> for
249	details.	250	details.
250		251
251	=item B<-name> I<name>	252	=item B<-name> I<name>
252		253
…		…
270		271
271	=item B<-sb>\|B<+sb>	272	=item B<-sb>\|B<+sb>
272		273
273	Turn on/off scrollbar; resource B<scrollBar>.	274	Turn on/off scrollbar; resource B<scrollBar>.
274		275
		276	=item B<-sr>\|B<+sr>
		277
		278	Put scrollbar on right/left; resource B<scrollBar_right>.
		279
		280	=item B<-st>\|B<+st>
		281
		282	Display rxvt (non XTerm/NeXT) scrollbar without/with a trough;
		283	resource B<scrollBar_floating>.
		284
275	=item B<-si>\|B<+si>	285	=item B<-si>\|B<+si>
276		286
277	Turn on/off scroll-to-bottom on TTY output inhibit; resource	287	Turn on/off scroll-to-bottom on TTY output inhibit; resource
278	B<scrollTtyOutput> has opposite effect.	288	B<scrollTtyOutput> has opposite effect.
279		289
…		…
285	=item B<-sw>\|B<+sw>	295	=item B<-sw>\|B<+sw>
286		296
287	Turn on/off scrolling with the scrollback buffer as new lines appear.	297	Turn on/off scrolling with the scrollback buffer as new lines appear.
288	This only takes effect if B<-si> is also given; resource	298	This only takes effect if B<-si> is also given; resource
289	B<scrollWithBuffer>.	299	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		300
300	=item B<-ptab>\|B<+ptab>	301	=item B<-ptab>\|B<+ptab>
301		302
302	If enabled (default), "Horizontal Tab" characters are being stored as	303	If enabled (default), "Horizontal Tab" characters are being stored as
303	actual wide characters in the screen buffer, which makes it possible to	304	actual wide characters in the screen buffer, which makes it possible to
…		…
307		308
308	=item B<-bc>\|B<+bc>	309	=item B<-bc>\|B<+bc>
309		310
310	Blink the cursor; resource B<cursorBlink>.	311	Blink the cursor; resource B<cursorBlink>.
311		312
		313	=item B<-uc>\|B<+uc>
		314
		315	Make the cursor underlined; resource B<cursorUnderline>.
		316
312	=item B<-iconic>	317	=item B<-iconic>
313		318
314	Start iconified, if the window manager supports that option.	319	Start iconified, if the window manager supports that option.
315	Alternative form is B<-ic>.	320	Alternative form is B<-ic>.
316		321
…		…
332		337
333	=item B<-bl>	338	=item B<-bl>
334		339
335	Compile I<frills>: Set MWM hints to request a borderless window, i.e.	340	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	341	if honoured by the WM, the rxvt-unicode window will not have window
337	decorations; resource B<borderLess>.	342	decorations; resource B<borderLess>. If the window manager does not
		343	support MWM hints (e.g. kwin), enables override-redirect mode.
338		344
339	=item B<-override-redirect>	345	=item B<-override-redirect>
340		346
341	Compile I<frills>: Sets override-redirect on the window; resource	347	Compile I<frills>: Sets override-redirect on the window; resource
342	B<override-redirect>.	348	B<override-redirect>.
…		…
351	=item B<-lsp> I<number>	357	=item B<-lsp> I<number>
352		358
353	Compile I<frills>: Lines (pixel height) to insert between each row of	359	Compile I<frills>: Lines (pixel height) to insert between each row of
354	the display. Useful to work around font rendering problems; resource	360	the display. Useful to work around font rendering problems; resource
355	B<lineSpace>.	361	B<lineSpace>.
		362
		363	=item B<-letsp> I<number>
		364
		365	Compile I<frills>: Amount to adjust the computed character width by
		366	to control overall letter spacing. Negative values will tighten up the
		367	letter spacing, positive values will space letters out more. Useful to
		368	work around odd font metrics; resource B<letterSpace>.
356		369
357	=item B<-tn> I<termname>	370	=item B<-tn> I<termname>
358		371
359	This option specifies the name of the terminal type to be set in the	372	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	373	B<TERM> environment variable. This terminal type must exist in the
…		…
447	Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@	460	Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@
448	will not immediately destroy its window when the program executed within	461	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	462	it exits. Instead, it will wait till it is being killed or closed by the
450	user; resource B<hold>.	463	user; resource B<hold>.
451		464
		465	=item B<-cd> I<path>
		466
		467	Sets the working directory for the shell (or the command specified via
		468	B<-e>). The I<path> must be an absolute path and it must exist for
		469	@@RXVT_NAME@@ to start; resource B<chdir>.
		470
452	=item B<-xrm> I<string>	471	=item B<-xrm> I<string>
453		472
454	Works like the X Toolkit option of the same name, by adding the I<string>	473	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	474	as if it were specified in a resource file. Resource values specified this
456	way take precedence over all other resource specifications.	475	way take precedence over all other resource specifications.
…		…
539	You can set and change the resources using X11 tools like B<xrdb>. Many	558	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	559	distribution do also load settings from the B<~/.Xresources> file when X
541	starts. @@RXVT_NAME@@ will consult the following files/resources in order,	560	starts. @@RXVT_NAME@@ will consult the following files/resources in order,
542	with later settings overwriting earlier ones:	561	with later settings overwriting earlier ones:
543		562
544	1. system-wide app-defaults file, either locale-dependent OR global
545	2. app-defaults file in $XAPPLRESDIR	563	1. app-defaults file in $XAPPLRESDIR
		564	2. $HOME/.Xdefaults
546	3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults	565	3. RESOURCE_MANAGER property on root-window of screen 0
547	4. SCREEN_RESOURCES for the current screen	566	4. SCREEN_RESOURCES property on root-window of the current screen
548	5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename>	567	5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename>
549	6. resources specified via -xrm on the commandline	568	6. resources specified via -xrm on the commandline
550		569
551	Note that when reading X resources, B<@@RXVT_NAME@@> recognizes two class	570	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	571	names: B<Rxvt> and B<URxvt>. The class name B<Rxvt> allows resources
…		…
564	=item B<depth:> I<bitdepth>	583	=item B<depth:> I<bitdepth>
565		584
566	Compile I<xft>: Attempt to find a visual with the given bit depth;	585	Compile I<xft>: Attempt to find a visual with the given bit depth;
567	option B<-depth>.	586	option B<-depth>.
568		587
		588	=item B<buffered:> I<boolean>
		589
		590	Compile I<xft>: Turn on/off double-buffering for xft (default enabled).
		591	On some card/driver combination enabling it slightly decreases
		592	performance, on most it greatly helps it. The slowdown is small, so it
		593	should normally be enabled.
		594
569	=item B<geometry:> I<geom>	595	=item B<geometry:> I<geom>
570		596
571	Create the window with the specified X window geometry [default 80x24];	597	Create the window with the specified X window geometry [default 80x24];
572	option B<-geometry>.	598	option B<-geometry>.
573		599
…		…
586	Use the specified colour for the colour value I<n>, where 0-7	612	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	613	corresponds to low-intensity (normal) colours and 8-15 corresponds to
588	high-intensity (bold = bright foreground, blink = bright background)	614	high-intensity (bold = bright foreground, blink = bright background)
589	colours. The canonical names are as follows: 0=black, 1=red, 2=green,	615	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	616	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.	617	names used are listed in the B<COLOURS AND GRAPHICS> section.
592		618
593	Colours higher than 15 cannot be set using resources (yet), but can be	619	Colours higher than 15 cannot be set using resources (yet), but can be
594	changed using an escape command (see @@RXVT_NAME@@(7)).	620	changed using an escape command (see @@RXVT_NAME@@(7)).
595		621
596	Colours 16-79 form a standard 4x4x4 colour cube (the same as xterm with	622	Colours 16-79 form a standard 4x4x4 colour cube (the same as xterm with
…		…
607	=item B<colorUL:> I<colour>	633	=item B<colorUL:> I<colour>
608		634
609	Use the specified colour to display underlined characters when the	635	Use the specified colour to display underlined characters when the
610	foreground colour is the default.	636	foreground colour is the default.
611		637
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>	638	=item B<underlineColor:> I<colour>
618		639
619	If set, use the specified colour as the colour for the underline	640	If set, use the specified colour as the colour for the underline
620	itself. If unset, use the foreground colour.	641	itself. If unset, use the foreground colour.
		642
		643	=item B<highlightColor:> I<colour>
		644
		645	If set, use the specified colour as the background for highlighted
		646	characters. If unset, use reverse video.
		647
		648	=item B<highlightTextColor:> I<colour>
		649
		650	If set and highlightColor is set, use the specified colour as the
		651	foreground for highlighted characters.
621		652
622	=item B<cursorColor:> I<colour>	653	=item B<cursorColor:> I<colour>
623		654
624	Use the specified colour for the cursor. The default is to use the	655	Use the specified colour for the cursor. The default is to use the
625	foreground colour; option B<-cr>.	656	foreground colour; option B<-cr>.
…		…
632		663
633	=item B<reverseVideo:> I<boolean>	664	=item B<reverseVideo:> I<boolean>
634		665
635	B<True>: simulate reverse video by foreground and background colours;	666	B<True>: simulate reverse video by foreground and background colours;
636	option B<-rv>. B<False>: regular screen colours [default]; option	667	option B<-rv>. B<False>: regular screen colours [default]; option
637	B<+rv>. See note in B<COLORS AND GRAPHICS> section.	668	B<+rv>. See note in B<COLOURS AND GRAPHICS> section.
638		669
639	=item B<jumpScroll:> I<boolean>	670	=item B<jumpScroll:> I<boolean>
640		671
641	B<True>: specify that jump scrolling should be used. When receiving lots	672	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	673	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	689	if the refresh is too fast for the human eye to read anything (or the
659	monitor to display anything); option B<+ss>.	690	monitor to display anything); option B<+ss>.
660		691
661	=item B<transparent:> I<boolean>	692	=item B<transparent:> I<boolean>
662		693
663	Turn on/off illusion of a transparent window background.	694	Turn on/off pseudo-transparency by using the root pixmap as background.
664		695
665	B<inheritPixmap> is still accepted as an obsolete alias but will be removed in	696	B<inheritPixmap> is still accepted as an obsolete alias but will be removed in
666	future versions.	697	future versions.
667		698
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>	699	=item B<fading:> I<number>
672		700
673	Fade the text by the given percentage when focus is lost; option B<-fade>.	701	Fade the text by the given percentage when focus is lost; option B<-fade>.
674		702
675	=item B<fadeColor:> I<colour>	703	=item B<fadeColor:> I<colour>
…		…
677	Fade to this colour, when fading is used (see B<fading:>). The default	705	Fade to this colour, when fading is used (see B<fading:>). The default
678	colour is black; option B<-fadecolor>.	706	colour is black; option B<-fadecolor>.
679		707
680	=item B<tintColor:> I<colour>	708	=item B<tintColor:> I<colour>
681		709
682	Tint the transparent background pixmap with the given colour; option	710	Tint the transparent background with the given colour. If the RENDER
683	B<-tint>.	711	extension is not available only black, red, green, yellow, blue,
		712	magenta, cyan and white tints can be performed server-side. Note that
		713	a black tint yields a completely black image while a white tint yields
		714	the image unchanged; option B<-tint>.
684		715
685	=item B<shading:> I<number>	716	=item B<shading:> I<number>
686		717
687	Darken (0 .. 100) or lighten (-1 .. -100) the transparent background image	718	Darken (0 .. 99) or lighten (101 .. 200) the transparent background.
688	in addition to tinting it; option B<-sh>.	719	A value of 100 means no shading; option B<-sh>.
689		720
690	=item B<blendType:> I<string>	721	=item B<blendType:> I<string>
691		722
692	Specify background blending type; option B<-blt>.	723	Specify background blending type; option B<-blt>.
693		724
694	=item B<blurRadius:> I<number>	725	=item B<blurRadius:> I<number>
695		726
696	Apply Gaussian Blurr with the specified radius to the transparent	727	Apply gaussian blur with the specified radius to the transparent
697	background image; option B<-blr>.	728	background; option B<-blr>.
		729
		730	=item B<iconFile:> I<file>
		731
		732	Set the application icon pixmap; option B<-icon>.
698		733
699	=item B<scrollColor:> I<colour>	734	=item B<scrollColor:> I<colour>
700		735
701	Use the specified colour for the scrollbar [default #B2B2B2].	736	Use the specified colour for the scrollbar [default #B2B2B2].
702		737
…		…
708	=item B<borderColor:> I<colour>	743	=item B<borderColor:> I<colour>
709		744
710	The colour of the border around the text area and between the scrollbar	745	The colour of the border around the text area and between the scrollbar
711	and the text.	746	and the text.
712		747
713	=item B<backgroundPixmap:> I<file[;geom[:op1][:op2][...]]>	748	=item B<backgroundPixmap:> I<file[;oplist]>
714		749
715	Use the specified image file for the background and also	750	Use the specified image file for the background and also
716	optionally specify its scaling with a geometry string B<WxH+X+Y>,	751	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:	752	Supported operations are:
725		753
726	tile force background image to be tiled and not scaled. Equivalent to 0x0,	754	B<WxH+X+Y> sets scale and position. B<"W" / "H"> specify the
727	propscale will scale image keeping proportions,	755	horizontal/vertical scale (percent), and B<"X" / "Y">
728	auto will scale image to match window size. Equivalent to 100x100;	756	locate the image centre (percent). A scale of 0 disables
729	hscale will scale image horizontally to the window size;	757	scaling. The maximum permitted scale is 1000.
730	vscale will scale image vertically to the window size;	758	op=tile enables tiling
731	scale will scale image to match window size;	759	op=pscale enables proportional scaling
732	root will tile image as if it was a root window background, auto-adjusting	760	op=root use the position of the terminal window relative to the root
733	whenever terminal window moves.	761	window as the image offset, simulating a root window background
		762
		763	The default scale and position setting is C<100x100+50+50>.
		764	Alternatively, a predefined set of templates can be used to achieve
		765	the most common setups:
		766
		767	style=tiled the image is tiled with no scaling
		768	style=aspect-stretched the image is scaled to fill the whole window maintaining
		769	the aspect ratio and centered
		770	style=stretched the image is scaled to fill the whole window
		771	style=centered the image is centered with no scaling
		772	style=root-tiled the image is tiled with no scaling and using 'op=root' positioning
		773
		774	If multiple templates are specified the last one wins. Note that a
		775	template overrides all the scale, position and operations settings.
		776	Indeed, the templates can be specified in terms of low level settings
		777	as follows:
		778
		779	style=tiled 0x0+0+0:op=tile
		780	style=aspect-stretched +50+50:op=pscale
		781	style=stretched 100x100
		782	style=centered 0x0+50+50
		783	style=root-tiled 0x0:op=tile:op=root
734		784
735	If used in conjunction with B<-tr> option, the specified pixmap will be	785	If used in conjunction with B<-tr> option, the specified pixmap will be
736	blended over transparency image using either alpha-blending, or any	786	blended over the transparent background using alpha-blending. If I<afterimage>
737	other blending type, specified with B<-blt "type"> option.	787	support has been compiled in it is possible to choose other blending
		788	types with B<-blt "type"> option.
738		789
739	=item B<path:> I<path>	790	=item B<path:> I<path>
740		791
741	Specify the colon-delimited search path for finding background image files.	792	Specify the colon-delimited search path for finding background image files.
742		793
…		…
769	it is named first) and thus defines the character cell grid to be 9 pixels	820	it is named first) and thus defines the character cell grid to be 9 pixels
770	wide and 15 pixels high.	821	wide and 15 pixels high.
771		822
772	The second font is just used to add additional unicode characters not in	823	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	824	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	825	the bold version of the font does contain fewer characters, so this is a
775	useful supplement.	826	useful supplement.
776		827
777	The third font is an Xft font with aliasing turned off, and the characters	828	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	829	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.	830	contains other characters, but we are not interested in them.
…		…
803	text font will being used for the given style.	854	text font will being used for the given style.
804		855
805	=item B<intensityStyles:> I<boolean>	856	=item B<intensityStyles:> I<boolean>
806		857
807	When font styles are not enabled, or this option is enabled (B<True>,	858	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	859	option B<-is>, the default), bold/blink font styles imply high
809	intensity foreground/background colours. Disabling this option (B<False>,	860	intensity foreground/background colours. Disabling this option (B<False>,
810	option B<+is>) disables this behaviour, the high intensity colours are not	861	option B<+is>) disables this behaviour, the high intensity colours are not
811	reachable.	862	reachable.
812		863
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>	864	=item B<title:> I<string>
826		865
827	Set window title string, the default title is the command-line	866	Set window title string, the default title is the command-line
828	specified after the B<-e> option, if any, otherwise the application	867	specified after the B<-e> option, if any, otherwise the application
829	name; option B<-title>.	868	name; option B<-title>.
…		…
842	=item B<urgentOnBell:> I<boolean>	881	=item B<urgentOnBell:> I<boolean>
843		882
844	B<True>: set the urgency hint for the wm on receipt of a bell character.	883	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].	884	B<False>: do not set the urgency hint [default].
846		885
		886	@@RXVT_NAME@@ resets the urgency hint on every focus change.
		887
847	=item B<visualBell:> I<boolean>	888	=item B<visualBell:> I<boolean>
848		889
849	B<True>: use visual bell on receipt of a bell character; option B<-vb>.	890	B<True>: use visual bell on receipt of a bell character; option B<-vb>.
850	B<False>: no visual bell [default]; option B<+vb>.	891	B<False>: no visual bell [default]; option B<+vb>.
851		892
…		…
874	URxvt.print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX)	915	URxvt.print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX)
875		916
876	This creates a new file in your home directory with the screen contents	917	This creates a new file in your home directory with the screen contents
877	every time you hit C<Print>.	918	every time you hit C<Print>.
878		919
		920	=item B<scrollstyle:> I<mode>
		921
		922	Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is
		923	the author's favourite.
		924
		925	=item B<thickness:> I<number>
		926
		927	Set the scrollbar width in pixels.
		928
879	=item B<scrollBar:> I<boolean>	929	=item B<scrollBar:> I<boolean>
880		930
881	B<True>: enable the scrollbar [default]; option B<-sb>. B<False>:	931	B<True>: enable the scrollbar [default]; option B<-sb>. B<False>:
882	disable the scrollbar; option B<+sb>.	932	disable the scrollbar; option B<+sb>.
883		933
…		…
902	B<False>: do not scroll to bottom when tty receives output; option	952	B<False>: do not scroll to bottom when tty receives output; option
903	B<+si>.	953	B<+si>.
904		954
905	=item B<scrollWithBuffer:> I<boolean>	955	=item B<scrollWithBuffer:> I<boolean>
906		956
907	B<True>: scroll with scrollback buffer when tty receives new lines (and	957	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	958	try to show the same lines) and B<scrollTtyOutput> is False; option
909	with scrollback buffer when tty receives new lines; option B<+sw>.	959	B<-sw>. B<False>: do not scroll with scrollback buffer when tty receives
		960	new lines; option B<+sw>.
910		961
911	=item B<scrollTtyKeypress:> I<boolean>	962	=item B<scrollTtyKeypress:> I<boolean>
912		963
913	B<True>: scroll to bottom when a non-special key is pressed. Special keys	964	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	965	are those which are intercepted by rxvt-unicode for special handling and
…		…
970	=item B<cursorBlink:> I<boolean>	1021	=item B<cursorBlink:> I<boolean>
971		1022
972	B<True>: blink the cursor. B<False>: do not blink the cursor [default];	1023	B<True>: blink the cursor. B<False>: do not blink the cursor [default];
973	option B<-bc>.	1024	option B<-bc>.
974		1025
		1026	=item B<cursorUnderline:> I<boolean>
		1027
		1028	B<True>: Make the cursor underlined. B<False>: Make the cursor a box [default];
		1029	option B<-uc>.
		1030
975	=item B<pointerBlank:> I<boolean>	1031	=item B<pointerBlank:> I<boolean>
976		1032
977	B<True>: blank the pointer when a key is pressed or after a set number	1033	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	1034	of seconds of inactivity. B<False>: the pointer is always visible
979	[default].	1035	[default].
…		…
992	large number (e.g. C<987654321>) to effectively disable the timeout.	1048	large number (e.g. C<987654321>) to effectively disable the timeout.
993		1049
994	=item B<backspacekey:> I<string>	1050	=item B<backspacekey:> I<string>
995		1051
996	The string to send when the backspace key is pressed. If set to B<DEC>	1052	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>	1053	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	1054	(code 8) - which can be reversed with the appropriate DEC private mode
999	escape sequence.	1055	escape sequence.
1000		1056
1001	=item B<deletekey:> I<string>	1057	=item B<deletekey:> I<string>
1002		1058
…		…
1081		1137
1082	=item B<secondaryScroll:> I<boolean>	1138	=item B<secondaryScroll:> I<boolean>
1083		1139
1084	Turn on/off secondary screen scroll (default enabled). If this	1140	Turn on/off secondary screen scroll (default enabled). If this
1085	option is enabled, scrolls on the secondary screen will change the	1141	option is enabled, scrolls on the secondary screen will change the
1086	scrollback buffer and switching to/from the secondary screen will	1142	scrollback buffer and, when secondaryScreen is off, switching
1087	instead scroll the screen up.	1143	to/from the secondary screen will instead scroll the screen up.
1088		1144
1089	=item B<hold>: I<boolean>	1145	=item B<hold>: I<boolean>
1090		1146
1091	Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@	1147	Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@
1092	will not immediately destroy its window when the program executed within	1148	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	1149	it exits. Instead, it will wait till it is being killed or closed by the
1094	user.	1150	user.
		1151
		1152	=item B<chdir>: I<path>
		1153
		1154	Sets the working directory for the shell (or the command specified via
		1155	B<-e>). The I<path> must be an absolute path and it must exist for
		1156	@@RXVT_NAME@@ to start. If it isn't specified then the current working
		1157	directory will be used; option B<-cd>.
1095		1158
1096	=item B<keysym.>I<sym>: I<string>	1159	=item B<keysym.>I<sym>: I<string>
1097		1160
1098	Compile I<frills>: Associate I<string> with keysym I<sym>. The	1161	Compile I<frills>: Associate I<string> with keysym I<sym>. The
1099	intervening resource name B<keysym.> cannot be omitted.	1162	intervening resource name B<keysym.> cannot be omitted.
…		…
1114	omitting the prefix B<XK_>. Alternatively you can specify I<key> by its hex	1177	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	1178	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.	1179	performed in an exact manner; however, the closest match is assured.
1117		1180
1118	I<string> may contain escape values (C<\n>: newline, C<\000>: octal	1181	I<string> may contain escape values (C<\n>: newline, C<\000>: octal
1119	number), see RESOURCES in C<man 7 X> for futher details.	1182	number), see RESOURCES in C<man 7 X> for further details.
1120		1183
1121	You can define a range of keysyms in one shot by providing a I<string>	1184	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 `/'	1185	with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimiter `/'
1123	should be a character not used by the strings.	1186	should be a character not used by the strings.
1124		1187
1125	Its usage can be demonstrated by an example:	1188	Its usage can be demonstrated by an example:
1126		1189
1127	URxvt.keysym.M-C-0x61: list\|\033<M-C-\|abc\|>	1190	URxvt.keysym.M-C-0x61: list\|\033<\|abc\|>
1128		1191
1129	The above line is equivalent to the following three lines:	1192	The above line is equivalent to the following three lines:
1130		1193
1131	URxvt.keysym.Meta-Control-0x61: \033<M-C-a>	1194	URxvt.keysym.Meta-Control-0x61: \033<a>
1132	URxvt.keysym.Meta-Control-0x62: \033<M-C-b>	1195	URxvt.keysym.Meta-Control-0x62: \033<b>
1133	URxvt.keysym.Meta-Control-0x63: \033<M-C-c>	1196	URxvt.keysym.Meta-Control-0x63: \033<c>
1134		1197
1135	If I<string> takes the form of C<command:STRING>, the specified B<STRING>	1198	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	1199	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>	1200	example the following means "change the current locale to C<zh_CN.GBK>
1138	when Control-Meta-c is being pressed":	1201	when Control-Meta-c is being pressed":
1139		1202
1140	URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007	1203	URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007
1141		1204
1142	If I<string> takes the form C<perl:STRING>, then the specified B<STRING>	1205	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)	1206	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	1207	manpage. For example, the F<selection> extension (activated via
1145	C<@@RXVT_NAME@@ -pe selection>) listens for C<selection:rot13> events:	1208	C<@@RXVT_NAME@@ -pe selection>) listens for C<selection:rot13> events:
1146		1209
1147	URxvt.keysym.M-C-c: perl:selection:rot13	1210	URxvt.keysym.M-C-c: perl:selection:rot13
1148		1211
1149	Due the the large number of modifier combinations, a defined key mapping	1212	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	1213	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	1214	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	1215	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	1216	definitions for C<Meta-a>, C<Shift-a> and so on, unless some of those are defined
1154	mappings themselves.	1217	mappings themselves.
1155		1218
…		…
1206	all instances, while B<perl-ext> is used for specific instances.	1269	all instances, while B<perl-ext> is used for specific instances.
1207		1270
1208	=item B<perl-eval>: I<string>	1271	=item B<perl-eval>: I<string>
1209		1272
1210	Perl code to be evaluated when all extensions have been registered. See	1273	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	1274	the @@RXVT_NAME@@perl(3) manpage.
1212	will be ignored when running setuid/setgid.
1213		1275
1214	=item B<perl-lib>: I<path>	1276	=item B<perl-lib>: I<path>
1215		1277
1216	Colon-separated list of additional directories that hold extension	1278	Colon-separated list of additional directories that hold extension
1217	scripts. When looking for extensions specified by the C<perl> resource,	1279	scripts. When looking for extensions specified by the C<perl> resource,
1218	@@RXVT_NAME@@ will first look in these directories and then in	1280	@@RXVT_NAME@@ will first look in these directories and then in
1219	F<@@RXVT_LIBDIR@@/urxvt/perl/>. Due to security reasons, this resource	1281	F<@@RXVT_LIBDIR@@/urxvt/perl/>.
1220	will be ignored when running setuid/setgid.
1221		1282
1222	See the @@RXVT_NAME@@perl(3) manpage.	1283	See the @@RXVT_NAME@@perl(3) manpage.
1223		1284
1224	=item B<< selection.pattern-I<idx> >>: I<perl-regex>	1285	=item B<< selection.pattern-I<idx> >>: I<perl-regex>
1225		1286
…		…
1247		1308
1248	=item B<override-redirect>: I<boolean>	1309	=item B<override-redirect>: I<boolean>
1249		1310
1250	Compile I<frills>: Sets override-redirect for the terminal window, making	1311	Compile I<frills>: Sets override-redirect for the terminal window, making
1251	it almost invisible to window managers; option B<-override-redirect>.	1312	it almost invisible to window managers; option B<-override-redirect>.
		1313
		1314	=item B<iso14755:> I<boolean>
		1315
		1316	Turn on/off ISO 14755 (default enabled).
1252		1317
1253	=item B<iso14755_52:> I<boolean>	1318	=item B<iso14755_52:> I<boolean>
1254		1319
1255	Turn on/off ISO 14755 5.2 mode (default enabled).	1320	Turn on/off ISO 14755 5.2 mode (default enabled).
1256		1321
…		…
1399	B<@@RXVT_NAME@@> tries to write an entry into the I<utmp>(5) file so that	1464	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	1465	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	1466	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.	1467	on some systems or setgid to root or to some other group on others.
1403		1468
1404	=head1 COLORS AND GRAPHICS	1469	=head1 COLOURS AND GRAPHICS
1405		1470
1406	In addition to the default foreground and background colours,	1471	In addition to the default foreground and background colours,
1407	B<@@RXVT_NAME@@> can display up to 16 colours (8 ANSI colours plus	1472	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	1473	high-intensity (potentially bold/blink) versions of the same, and 72 (or
1409	colours with their names.	1474	240 in 256 colour mode) colours arranged in an 4x4x4 (or 6x6x6) colour RGB
		1475	cube plus a 8 (24) colour greyscale ramp.
		1476
		1477	Here is a list of the ANSI colours with their names.
1410		1478
1411	=begin table	1479	=begin table
1412		1480
1413	B<color0> (black) = Black	1481	B<color0> (black) = Black
1414	B<color1> (red) = Red3	1482	B<color1> (red) = Red3
…		…
1434	It is also possible to specify the colour values of B<foreground>,	1502	It is also possible to specify the colour values of B<foreground>,
1435	B<background>, B<cursorColor>, B<cursorColor2>, B<colorBD>, B<colorUL> as	1503	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	1504	a number 0-15, as a convenient shorthand to reference the colour name of
1437	color0-color15.	1505	color0-color15.
1438		1506
1439	In addition to the colours defined above, @@RXVT_NAME@@ offers an	1507	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)	1508	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		1509
		1510	The RGB cube uses indices 16..79 (16..231) using the following formulas:
		1511
		1512	index_88 = (r * 4 + g) * 4 + b + 16 # r, g, b = 0..3
		1513	index_256 = (r * 16 + g) * 16 + b + 16 # r, g, b = 0..15
		1514
		1515	The grayscale ramp uses indices 80..87 (232..239), from 10% to 90% in 10%
		1516	steps (1/26 to 25/26 in 1/26 steps) - black and white are already part of
		1517	the RGB cube.
		1518
1444	Together, all those colours implement the 88 colour xterm colours. Only	1519	Together, all those colours implement the 88 (256) colour xterm
1445	the first 16 can be changed using resources currently, the rest can only	1520	colours. Only the first 16 can be changed using resources currently, the
1446	be changed via command sequences ("escape codes").	1521	rest can only be changed via command sequences ("escape codes").
		1522
		1523	Applications are advised to use terminfo or command sequences to discover
		1524	number and RGB values of all colours (yes, you can query this...).
1447		1525
1448	Note that B<-rv> (B<"reverseVideo: True">) simulates reverse video by	1526	Note that B<-rv> (B<"reverseVideo: True">) simulates reverse video by
1449	always swapping the foreground/background colours. This is in contrast to	1527	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	1528	I<xterm>(1) where the colours are only swapped if they have not otherwise
1451	been specified. For example,	1529	been specified. For example,
1452		1530
1453	=over 4
1454
1455	=item B<@@RXVT_NAME@@ -fg Black -bg White -rv>	1531	@@RXVT_NAME@@ -fg Black -bg White -rv
1456		1532
1457	would yield White on Black, while on I<xterm>(1) it would yield Black	1533	would yield White on Black, while on I<xterm>(1) it would yield Black on
1458	on White.	1534	White.
1459
1460	=back
1461		1535
1462	=head2 ALPHA CHANNEL SUPPORT	1536	=head2 ALPHA CHANNEL SUPPORT
1463		1537
1464	If Xft support has been compiled in and as long as Xft/Xrender/X don't get	1538	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>	1539	their act together, rxvt-unicode will do it's own alpha channel management:
1466	(recommended, but B<MUST> have 4 digits/component) colour specifications,	1540
1467	in addition to the ones provided by X, where the additional A component	1541	You can prefix any colour with an opaqueness percentage enclosed in
		1542	brackets, i.e. C<[percent]>, where C<percent> is a decimal percentage
		1543	(0-100) that specifies the opacity of the colour, where C<0> is completely
		1544	transparent and C<100> is completely opaque. For example, C<[50]red> is a
		1545	half-transparent red, while C<[95]#00ff00> is an almost opaque green. This
		1546	is the recommended format to specify transparency values, and works with
		1547	all ways to specify a colour.
		1548
		1549	For complete control, rxvt-unicode also supports
		1550	C<rgba:rrrr/gggg/bbbb/aaaa> (exactly four hex digits/component) colour
		1551	specifications, where the additional C<aaaa> component specifies opacity
1468	specifies opacity (alpha) values. The minimum value of C<0> is completely	1552	(alpha) values. The minimum value of C<0000> is completely transparent,
1469	transparent). You can also prefix any color with C<[percent]>, where	1553	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	1554	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	1555	C<rgba:0000/ff00/0000/f332>.
1472	opaque.
1473		1556
1474	You probably need to specify B<"-depth 32">, too, and have the luck that	1557	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	1558	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.	1559	layout, as X is far from just supporting ARGB visuals out of the box, and
		1560	rxvt-unicode just fudges around.
1477		1561
1478	For example, the following selects an almost completely transparent red	1562	For example, the following selects an almost completely transparent black
1479	background, and an almost opaque pink foreground:	1563	background, and an almost opaque pink foreground:
1480		1564
1481	@@RXVT_NAME@@ -depth 32 -bg rgba:0000/0000/0000/aaaa -fg "[80]pink"	1565	@@RXVT_NAME@@ -depth 32 -bg rgba:0000/0000/0000/4444 -fg "[80]pink"
1482		1566
1483	I<Please note that transparency of any kind if completely unsupported by	1567	When not using a background image, then the interpretation of the
1484	the author. Don't bug him with installation questions!>	1568	alpha channel is up to your compositing manager (most interpret it as
		1569	transparency of course).
		1570
		1571	When using a background pixmap or pseudo-transparency, then the background
		1572	colour will always behave as if it were completely transparent (so the
		1573	background image shows instead), regardless of how it was specified, while
		1574	other colours will either be transparent as specified (the background
		1575	image will show through) on servers supporting the RENDER extension, or
		1576	fully opaque on servers not supporting the RENDER EXTENSION.
		1577
		1578	Please note that due to bugs in Xft, specifying alpha values might result
		1579	in garbage being displayed when the X-server does not support the RENDER
		1580	extension.
1485		1581
1486	=head1 ENVIRONMENT	1582	=head1 ENVIRONMENT
1487		1583
1488	B<@@RXVT_NAME@@> sets and/or uses the following environment variables:	1584	B<@@RXVT_NAME@@> sets and/or uses the following environment variables:
1489		1585
…		…
1523	C<--with-terminfo=PATH>.	1619	C<--with-terminfo=PATH>.
1524		1620
1525	=item B<DISPLAY>	1621	=item B<DISPLAY>
1526		1622
1527	Used by @@RXVT_NAME@@ to connect to the display and set to the correct	1623	Used by @@RXVT_NAME@@ to connect to the display and set to the correct
1528	display in its child processes.	1624	display in its child processes if C<-display> isn't used to override. It
		1625	defaults to C<:0> if it doesn't exist.
1529		1626
1530	=item B<SHELL>	1627	=item B<SHELL>
1531		1628
1532	The shell to be used for command execution, defaults to C</bin/sh>.	1629	The shell to be used for command execution, defaults to C</bin/sh>.
1533		1630
1534	=item B<RXVT_SOCKET>	1631	=item B<RXVT_SOCKET>
1535		1632
1536	The unix domain socket path used by @@RXVT_NAME@@c(1) and	1633	The unix domain socket path used by @@RXVT_NAME@@c(1) and
1537	@@RXVT_NAME@@d(1).	1634	@@RXVT_NAME@@d(1).
1538		1635
1539	Default F<<< $HOME/.rxvt-unicode-I<< <nodename >> >>>.	1636	Default F<<< $HOME/.rxvt-unicode-I<< <nodename> >> >>>.
1540		1637
1541	=item B<HOME>	1638	=item B<HOME>
1542		1639
1543	Used to locate the default directory for the unix domain socket for	1640	Used to locate the default directory for the unix domain socket for
1544	daemon communications and to locate various resource files (such as	1641	daemon communications and to locate various resource files (such as
1545	C<.Xdefaults>)	1642	C<.Xdefaults>)
1546		1643
1547	=item B<XAPPLRESDIR>	1644	=item B<XAPPLRESDIR>
1548		1645
1549	Directory where various X resource files are being located.	1646	Directory where application-specific X resource files are located.
1550		1647
1551	=item B<XENVIRONMENT>	1648	=item B<XENVIRONMENT>
1552		1649
1553	If set and accessible, gives the name of a X resource file to be loaded by	1650	If set and accessible, gives the name of a X resource file to be loaded by
1554	@@RXVT_NAME@@.	1651	@@RXVT_NAME@@.
…		…
1559		1656
1560	=over 4	1657	=over 4
1561		1658
1562	=item B</usr/lib/X11/rgb.txt>	1659	=item B</usr/lib/X11/rgb.txt>
1563		1660
1564	Color names.	1661	Colour names.
1565		1662
1566	=back	1663	=back
1567		1664
1568	=head1 SEE ALSO	1665	=head1 SEE ALSO
1569		1666
…		…
1620		1717
1621	Project Coordinator (Changes 1.0 -)	1718	Project Coordinator (Changes 1.0 -)
1622		1719
1623	=item Emanuele Giaquinta L<< <e.giaquinta@glauco.it> >>	1720	=item Emanuele Giaquinta L<< <e.giaquinta@glauco.it> >>
1624		1721
1625	Pty/tty/utmp/wtmp rewrite, lots of random hacking and bugfixing.	1722	pty/utmp code rewrite, image code improvements, many random hacks and bugfixes.
1626		1723
1627	=back	1724	=back
1628		1725

Diff Legend

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

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents): Revision 1.151 by root, Wed Dec 12 19:55:55 2007 UTC vs. Revision 1.203 by sf-exg, Sat Aug 13 09:05:43 2011 UTC

Diff Legend

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents):
Revision 1.151 by root, Wed Dec 12 19:55:55 2007 UTC vs.
Revision 1.203 by sf-exg, Sat Aug 13 09:05:43 2011 UTC