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

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents):
Revision 1.147 by root, Fri Nov 23 11:18:04 2007 UTC vs.
Revision 1.210 by sf-exg, Mon Dec 26 15:20:58 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
…		…
30	like mongolian or scripts requiring extremely complex combining rules,	33	like mongolian or scripts requiring extremely complex combining rules,
31	like tibetan or devanagari. Don't expect pretty output when using these	34	like tibetan or devanagari. Don't expect pretty output when using these
32	scripts. Most other scripts, latin, cyrillic, kanji, thai etc. should work	35	scripts. Most other scripts, latin, cyrillic, kanji, thai etc. should work
33	fine, though. A somewhat difficult case are right-to-left scripts, such	36	fine, though. A somewhat difficult case are right-to-left scripts, such
34	as hebrew: B<rxvt-unicode> adopts the view that bidirectional algorithms	37	as hebrew: B<rxvt-unicode> adopts the view that bidirectional algorithms
35	belong into the application, not the terminal emulator (too many things --	38	belong in the application, not the terminal emulator (too many things --
36	such as cursor-movement while editing -- break otherwise), but that might	39	such as cursor-movement while editing -- break otherwise), but that might
37	change.	40	change.
38		41
39	If you are looking for a terminal that supports more exotic scripts, let	42	If you are looking for a terminal that supports more exotic scripts, let
40	me recommend C<mlterm>, which is a very user friendly, lean and clean	43	me recommend C<mlterm>, which is a very user friendly, lean and clean
…		…
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. Obsolete form of it is	129	Turn on/off pseudo-transparency by using the root pixmap as background; resource B<transparent>.
122	B<-ip> and it should not be used anymore; resource B<transparent>.
123		130
124	I<Please note that old resource name of B<inheritPixmap> is obsolete and should be	131	B<-ip> is still accepted as an obsolete alias but will be removed in
125	changed to B<transparent>. Backwards compatibility support for B<inheritPixmap> will	132	future versions.
126	be phased out in future versions of rxvt!>
127
128	I<Please address all transparency related issues to Sasha Vasko at
129	sasha@aftercode.net. Read the FAQ (man 7 @@RXVT_NAME@@)!>
130		133
131	=item B<-fade> I<number>	134	=item B<-fade> I<number>
132		135
133	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
134	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
…		…
139	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
140	is opaque black. resource B<fadeColor>.	143	is opaque black. resource B<fadeColor>.
141		144
142	=item B<-tint> I<colour>	145	=item B<-tint> I<colour>
143		146
144	Tint the transparent background pixmap with the given colour when	147	Tint the transparent background with the given colour;
145	transparency is enabled with B<-tr>. This only works for	148	resource I<tintColor>.
146	non-tiled backgrounds, currently. See also the B<-sh> option that can be
147	used to brighten or darken the image in addition to tinting it.
148	Please note that certain tint colours can be applied on the server-side,
149	thus yielding performance gain of two orders of magnitude. These colours are:
150	blue, red, green, cyan, magenta, yellow, and those close to them. Also
151	pure black and pure white colors essentially mean no tinting; resource
152	I<tintColor>. Example:
153
154	@@RXVT_NAME@@ -tr -tint blue -sh 40
155		149
156	=item B<-sh> I<number>	150	=item B<-sh> I<number>
157		151
158	Darken (0 .. 100) or lighten (100 .. 200) the transparent	152	Darken (0 .. 99) or lighten (101 .. 200) the transparent background.
159	background image in addition to (or instead of) tinting it;	153	A value of 100 means no shading; resource I<shading>.
160	resource I<shading>.
161		154
162	=item B<-blt> I<string>	155	=item B<-blt> I<string>
163		156
164	Specify background blending type. If background pixmap is specified	157	Specify background blending type. If background pixmap is specified
165	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
166	transparency image, using method specified. Supported values are :	159	the transparent background, using the method specified. Supported values are:
167	B<add>, B<alphablend>, B<allanon> - color values averaging, B<colorize>,	160	B<add>, B<alphablend>, B<allanon> - colour values averaging, B<colorize>,
168	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>,
169	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
170	alpha-blending. Compile I<afterimage>; resource I<blendType>.	163	alpha-blending. Compile I<afterimage>; resource I<blendType>.
171		164
172	=item B<-blr> I<HxV>	165	=item B<-blr> I<HxV>
173		166
174	Apply Gaussian Blur with the specified radii to the transparent	167	Apply Gaussian Blur with the specified radii to the transparent
175	background image. If single number is specified - both vertical and	168	background. If a single number is specified - both vertical and
176	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
177	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
178	on some backgrounds. Maximum radius value is 128. Compile I<afterimage>;	171	on some backgrounds. Maximum radius value is 128;
179	resource I<blurRadius>.	172	resource I<blurRadius>.
180		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
181	=item B<-bg> I<colour>	180	=item B<-bg> I<colour>
182		181
183	Window background colour; resource B<background>.	182	Window background colour; resource B<background>.
184		183
185	=item B<-fg> I<colour>	184	=item B<-fg> I<colour>
186		185
187	Window foreground colour; resource B<foreground>.	186	Window foreground colour; resource B<foreground>.
188		187
189	=item B<-pixmap> I<file[;geom[:op1][:op2][...]]>	188	=item B<-pixmap> I<file[;oplist]>
190		189
191	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
192	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
193	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
194	command-line; for more details see resource B<backgroundPixmap>.	193	command-line; for more details see resource B<backgroundPixmap>.
195		194
196	=item B<-cr> I<colour>	195	=item B<-cr> I<colour>
197		196
…		…
244	italic> >> characters are to be printed. See resource B<boldItalicFont>	243	italic> >> characters are to be printed. See resource B<boldItalicFont>
245	for details.	244	for details.
246		245
247	=item B<-is>\|B<+is>	246	=item B<-is>\|B<+is>
248		247
249	Compile I<font-styles>: Bold/Italic font styles imply high intensity	248	Compile I<font-styles>: Bold/Blink font styles imply high intensity
250	foreground/background (default). See resource B<intensityStyles> for	249	foreground/background (default). See resource B<intensityStyles> for
251	details.	250	details.
252		251
253	=item B<-name> I<name>	252	=item B<-name> I<name>
254		253
…		…
272		271
273	=item B<-sb>\|B<+sb>	272	=item B<-sb>\|B<+sb>
274		273
275	Turn on/off scrollbar; resource B<scrollBar>.	274	Turn on/off scrollbar; resource B<scrollBar>.
276		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
277	=item B<-si>\|B<+si>	285	=item B<-si>\|B<+si>
278		286
279	Turn on/off scroll-to-bottom on TTY output inhibit; resource	287	Turn on/off scroll-to-bottom on TTY output inhibit; resource
280	B<scrollTtyOutput> has opposite effect.	288	B<scrollTtyOutput> has opposite effect.
281		289
…		…
287	=item B<-sw>\|B<+sw>	295	=item B<-sw>\|B<+sw>
288		296
289	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.
290	This only takes effect if B<-si> is also given; resource	298	This only takes effect if B<-si> is also given; resource
291	B<scrollWithBuffer>.	299	B<scrollWithBuffer>.
292
293	=item B<-sr>\|B<+sr>
294
295	Put scrollbar on right/left; resource B<scrollBar_right>.
296
297	=item B<-st>\|B<+st>
298
299	Display rxvt (non XTerm/NeXT) scrollbar without/with a trough;
300	resource B<scrollBar_floating>.
301		300
302	=item B<-ptab>\|B<+ptab>	301	=item B<-ptab>\|B<+ptab>
303		302
304	If enabled (default), "Horizontal Tab" characters are being stored as	303	If enabled (default), "Horizontal Tab" characters are being stored as
305	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
…		…
309		308
310	=item B<-bc>\|B<+bc>	309	=item B<-bc>\|B<+bc>
311		310
312	Blink the cursor; resource B<cursorBlink>.	311	Blink the cursor; resource B<cursorBlink>.
313		312
		313	=item B<-uc>\|B<+uc>
		314
		315	Make the cursor underlined; resource B<cursorUnderline>.
		316
314	=item B<-iconic>	317	=item B<-iconic>
315		318
316	Start iconified, if the window manager supports that option.	319	Start iconified, if the window manager supports that option.
317	Alternative form is B<-ic>.	320	Alternative form is B<-ic>.
318		321
…		…
334		337
335	=item B<-bl>	338	=item B<-bl>
336		339
337	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.
338	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
339	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.
340		344
341	=item B<-override-redirect>	345	=item B<-override-redirect>
342		346
343	Compile I<frills>: Sets override-redirect on the window; resource	347	Compile I<frills>: Sets override-redirect on the window; resource
344	B<override-redirect>.	348	B<override-redirect>.
…		…
353	=item B<-lsp> I<number>	357	=item B<-lsp> I<number>
354		358
355	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
356	the display. Useful to work around font rendering problems; resource	360	the display. Useful to work around font rendering problems; resource
357	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>.
358		369
359	=item B<-tn> I<termname>	370	=item B<-tn> I<termname>
360		371
361	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
362	B<TERM> environment variable. This terminal type must exist in the	373	B<TERM> environment variable. This terminal type must exist in the
…		…
417		428
418	=item B<-tcw>	429	=item B<-tcw>
419		430
420	Change the meaning of triple-click selection with the left mouse	431	Change the meaning of triple-click selection with the left mouse
421	button. Only effective when the original (non-perl) selection code is	432	button. Only effective when the original (non-perl) selection code is
422	in-use. Instead of selecting a full line it will extend the selection the	433	in-use. Instead of selecting a full line it will extend the selection to
423	end of the logical line only. resource B<tripleclickwords>.	434	the end of the logical line only. resource B<tripleclickwords>.
424		435
425	=item B<-insecure>	436	=item B<-insecure>
426		437
427	Enable "insecure" mode, which currently enables most of the escape	438	Enable "insecure" mode, which currently enables most of the escape
428	sequences that echo strings. See the resource B<insecure> for more	439	sequences that echo strings. See the resource B<insecure> for more
…		…
448		459
449	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@@
450	will not immediately destroy its window when the program executed within	461	will not immediately destroy its window when the program executed within
451	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
452	user; resource B<hold>.	463	user; resource B<hold>.
		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>.
453		470
454	=item B<-xrm> I<string>	471	=item B<-xrm> I<string>
455		472
456	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>
457	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
…		…
505	If this switch is given, @@RXVT_NAME@@ will not create any utmp/wtmp	522	If this switch is given, @@RXVT_NAME@@ will not create any utmp/wtmp
506	entries and will not tinker with pty/tty permissions - you have to do that	523	entries and will not tinker with pty/tty permissions - you have to do that
507	yourself if you want that.	524	yourself if you want that.
508		525
509	As an extremely special case, specifying C<-1> will completely suppress	526	As an extremely special case, specifying C<-1> will completely suppress
510	pty/tty operations.	527	pty/tty operations, which is probably only useful in conjunction with some
		528	perl extension that manages the terminal.
511		529
512	Here is a example in perl that illustrates how this option can be used (a	530	Here is a example in perl that illustrates how this option can be used (a
513	longer example is in F<doc/pty-fd>):	531	longer example is in F<doc/pty-fd>):
514		532
515	use IO::Pty;	533	use IO::Pty;
…		…
529	Comma-separated list of perl extension scripts to use (or not to use) in	547	Comma-separated list of perl extension scripts to use (or not to use) in
530	this terminal instance. See resource B<perl-ext> for details.	548	this terminal instance. See resource B<perl-ext> for details.
531		549
532	=back	550	=back
533		551
534	=head1 RESOURCES (available also as long-options)	552	=head1 RESOURCES
535		553
536	Note: `@@RXVT_NAME@@ --help' gives a list of all resources (long	554	Note: `@@RXVT_NAME@@ --help' gives a list of all resources (long
537	options) compiled into your version.	555	options) compiled into your version. All resources are also available as
		556	long-options.
538		557
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
…		…
656		687
657	B<False>: specify that everything is to be displayed, even	688	B<False>: specify that everything is to be displayed, even
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<inheritPixmap:> I<boolean>	692	=item B<transparent:> I<boolean>
662		693
663	B<True>: make the background inherit the parent windows' pixmap, giving	694	Turn on/off pseudo-transparency by using the root pixmap as background.
664	artificial transparency. B<False>: do not inherit the parent windows'
665	pixmap.
666		695
667	I<Please note that transparency of any kind if completely unsupported by	696	B<inheritPixmap> is still accepted as an obsolete alias but will be removed in
668	the author. Don't bug him with installation questions!>	697	future versions.
669		698
670	=item B<fading:> I<number>	699	=item B<fading:> I<number>
671		700
672	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>.
673		702
…		…
676	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
677	colour is black; option B<-fadecolor>.	706	colour is black; option B<-fadecolor>.
678		707
679	=item B<tintColor:> I<colour>	708	=item B<tintColor:> I<colour>
680		709
681	Tint the transparent background pixmap with the given colour; option	710	Tint the transparent background with the given colour. If the RENDER
682	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>.
683		715
684	=item B<shading:> I<number>	716	=item B<shading:> I<number>
685		717
686	Darken (0 .. 100) or lighten (-1 .. -100) the transparent background image	718	Darken (0 .. 99) or lighten (101 .. 200) the transparent background.
687	in addition to tinting it; option B<-sh>.	719	A value of 100 means no shading; option B<-sh>.
688		720
689	=item B<blendType:> I<string>	721	=item B<blendType:> I<string>
690		722
691	Specify background blending type; option B<-blt>.	723	Specify background blending type; option B<-blt>.
692		724
693	=item B<blurRadius:> I<number>	725	=item B<blurRadius:> I<number>
694		726
695	Apply Gaussian Blurr with the specified radius to the transparent	727	Apply gaussian blur with the specified radius to the transparent
696	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>.
697		733
698	=item B<scrollColor:> I<colour>	734	=item B<scrollColor:> I<colour>
699		735
700	Use the specified colour for the scrollbar [default #B2B2B2].	736	Use the specified colour for the scrollbar [default #B2B2B2].
701		737
…		…
707	=item B<borderColor:> I<colour>	743	=item B<borderColor:> I<colour>
708		744
709	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
710	and the text.	746	and the text.
711		747
712	=item B<backgroundPixmap:> I<file[;geom[:op1][:op2][...]]>	748	=item B<backgroundPixmap:> I<file[;oplist]>
713		749
714	Use the specified image file for the background and also	750	Use the specified image file for the background and also
715	optionally specify its scaling with a geometry string B<WxH+X+Y>,	751	optionally specify a colon separated list of operations to modify it.
716	(default C<0x0+50+50>) in which B<"W" / "H"> specify the
717	horizontal/vertical scale (percent), and B<"X" / "Y"> locate the image
718	centre (percent). A scale of 0 displays the image with tiling. A scale
719	of 1 displays the image without any scaling. A scale of 2 to 9 specifies
720	an integer number of images in that direction. No image will be magnified
721	beyond 10 times its original size. The maximum permitted scale is 1000.
722	Additional operations can be specified after colon B<:op1:op2...>.
723	Supported operations are:	752	Supported operations are:
724		753
725	tile force background image to be tiled and not scaled. Equivalent to 0x0,	754	=over 4
726	propscale will scale image keeping proportions,	755
727	auto will scale image to match window size. Equivalent to 100x100;	756	=item B<WxH+X+Y>
728	hscale will scale image horizontally to the window size;	757
729	vscale will scale image vertically to the window size;	758	sets scale and position. B<"W" / "H"> specify the horizontal/vertical
730	scale will scale image to match window size;	759	scale (percent), and B<"X" / "Y"> locate the image centre (percent). A
731	root will tile image as if it was a root window background, auto-adjusting	760	scale of 0 disables scaling. The maximum permitted scale is 1000.
732	whenever terminal window moves.	761
		762	=item B<op=tile>
		763
		764	enables tiling
		765
		766	=item B<op=keep-aspect>
		767
		768	maintain the image aspect ratio when scaling
		769
		770	=item B<op=root-align>
		771
		772	use the position of the terminal window relative to the root window as
		773	the image offset, simulating a root window background
		774
		775	=back
		776
		777	The default scale and position setting is C<100x100+50+50>.
		778	Alternatively, a predefined set of templates can be used to achieve
		779	the most common setups:
		780
		781	=over 4
		782
		783	=item B<style=tiled>
		784
		785	the image is tiled with no scaling. Equivalent to 0x0+0+0:op=tile
		786
		787	=item B<style=aspect-stretched>
		788
		789	the image is scaled to fill the whole window maintaining the aspect
		790	ratio and centered. Equivalent to 100x100+50+50:op=keep-aspect
		791
		792	=item B<style=stretched>
		793
		794	the image is scaled to fill the whole window. Equivalent to 100x100
		795
		796	=item B<style=centered>
		797
		798	the image is centered with no scaling. Equivalent to 0x0+50+50
		799
		800	=item B<style=root-tiled>
		801
		802	the image is tiled with no scaling and using 'root' positioning.
		803	Equivalent to 0x0:op=tile:op=root-align
		804
		805	=back
		806
		807	If multiple templates are specified the last one wins. Note that a
		808	template overrides all the scale, position and operations settings.
733		809
734	If used in conjunction with B<-tr> option, the specified pixmap will be	810	If used in conjunction with B<-tr> option, the specified pixmap will be
735	blended over transparency image using either alpha-blending, or any	811	blended over the transparent background using alpha-blending. If I<afterimage>
736	other blending type, specified with B<-blt "type"> option.	812	support has been compiled in it is possible to choose other blending
		813	types with B<-blt "type"> option.
737		814
738	=item B<path:> I<path>	815	=item B<path:> I<path>
739		816
740	Specify the colon-delimited search path for finding background image files.	817	Specify the colon-delimited search path for finding background image files.
741		818
…		…
768	it is named first) and thus defines the character cell grid to be 9 pixels	845	it is named first) and thus defines the character cell grid to be 9 pixels
769	wide and 15 pixels high.	846	wide and 15 pixels high.
770		847
771	The second font is just used to add additional unicode characters not in	848	The second font is just used to add additional unicode characters not in
772	the base font, likewise the third, which is unfortunately non-bold, but	849	the base font, likewise the third, which is unfortunately non-bold, but
773	the bold version of the font does contain less characters, so this is a	850	the bold version of the font does contain fewer characters, so this is a
774	useful supplement.	851	useful supplement.
775		852
776	The third font is an Xft font with aliasing turned off, and the characters	853	The third font is an Xft font with aliasing turned off, and the characters
777	are limited to the B<JIS 0208> codeset (i.e. japanese kanji). The font	854	are limited to the B<JIS 0208> codeset (i.e. japanese kanji). The font
778	contains other characters, but we are not interested in them.	855	contains other characters, but we are not interested in them.
…		…
802	text font will being used for the given style.	879	text font will being used for the given style.
803		880
804	=item B<intensityStyles:> I<boolean>	881	=item B<intensityStyles:> I<boolean>
805		882
806	When font styles are not enabled, or this option is enabled (B<True>,	883	When font styles are not enabled, or this option is enabled (B<True>,
807	option B<-is>, the default), bold and italic font styles imply high	884	option B<-is>, the default), bold/blink font styles imply high
808	intensity foreground/background colours. Disabling this option (B<False>,	885	intensity foreground/background colours. Disabling this option (B<False>,
809	option B<+is>) disables this behaviour, the high intensity colours are not	886	option B<+is>) disables this behaviour, the high intensity colours are not
810	reachable.	887	reachable.
811		888
812	=item B<selectstyle:> I<mode>
813
814	Set mouse selection style to B<old> which is 2.20, B<oldword> which
815	is xterm style with 2.20 old word selection, or anything else which
816	gives xterm style selection. Only effective when the original (non-perl)
817	selection code is in use.
818
819	=item B<scrollstyle:> I<mode>
820
821	Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is
822	the author's favourite.
823
824	=item B<title:> I<string>	889	=item B<title:> I<string>
825		890
826	Set window title string, the default title is the command-line	891	Set window title string, the default title is the command-line
827	specified after the B<-e> option, if any, otherwise the application	892	specified after the B<-e> option, if any, otherwise the application
828	name; option B<-title>.	893	name; option B<-title>.
…		…
841	=item B<urgentOnBell:> I<boolean>	906	=item B<urgentOnBell:> I<boolean>
842		907
843	B<True>: set the urgency hint for the wm on receipt of a bell character.	908	B<True>: set the urgency hint for the wm on receipt of a bell character.
844	B<False>: do not set the urgency hint [default].	909	B<False>: do not set the urgency hint [default].
845		910
		911	@@RXVT_NAME@@ resets the urgency hint on every focus change.
		912
846	=item B<visualBell:> I<boolean>	913	=item B<visualBell:> I<boolean>
847		914
848	B<True>: use visual bell on receipt of a bell character; option B<-vb>.	915	B<True>: use visual bell on receipt of a bell character; option B<-vb>.
849	B<False>: no visual bell [default]; option B<+vb>.	916	B<False>: no visual bell [default]; option B<+vb>.
850		917
…		…
873	URxvt.print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX)	940	URxvt.print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX)
874		941
875	This creates a new file in your home directory with the screen contents	942	This creates a new file in your home directory with the screen contents
876	every time you hit C<Print>.	943	every time you hit C<Print>.
877		944
		945	=item B<scrollstyle:> I<mode>
		946
		947	Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is
		948	the author's favourite.
		949
		950	=item B<thickness:> I<number>
		951
		952	Set the scrollbar width in pixels.
		953
878	=item B<scrollBar:> I<boolean>	954	=item B<scrollBar:> I<boolean>
879		955
880	B<True>: enable the scrollbar [default]; option B<-sb>. B<False>:	956	B<True>: enable the scrollbar [default]; option B<-sb>. B<False>:
881	disable the scrollbar; option B<+sb>.	957	disable the scrollbar; option B<+sb>.
882		958
…		…
901	B<False>: do not scroll to bottom when tty receives output; option	977	B<False>: do not scroll to bottom when tty receives output; option
902	B<+si>.	978	B<+si>.
903		979
904	=item B<scrollWithBuffer:> I<boolean>	980	=item B<scrollWithBuffer:> I<boolean>
905		981
906	B<True>: scroll with scrollback buffer when tty receives new lines (and	982	B<True>: scroll with scrollback buffer when tty receives new lines (i.e.
907	B<scrollTtyOutput> is False); option B<-sw>. B<False>: do not scroll	983	try to show the same lines) and B<scrollTtyOutput> is False; option
908	with scrollback buffer when tty receives new lines; option B<+sw>.	984	B<-sw>. B<False>: do not scroll with scrollback buffer when tty receives
		985	new lines; option B<+sw>.
909		986
910	=item B<scrollTtyKeypress:> I<boolean>	987	=item B<scrollTtyKeypress:> I<boolean>
911		988
912	B<True>: scroll to bottom when a non-special key is pressed. Special keys	989	B<True>: scroll to bottom when a non-special key is pressed. Special keys
913	are those which are intercepted by rxvt-unicode for special handling and	990	are those which are intercepted by rxvt-unicode for special handling and
…		…
969	=item B<cursorBlink:> I<boolean>	1046	=item B<cursorBlink:> I<boolean>
970		1047
971	B<True>: blink the cursor. B<False>: do not blink the cursor [default];	1048	B<True>: blink the cursor. B<False>: do not blink the cursor [default];
972	option B<-bc>.	1049	option B<-bc>.
973		1050
		1051	=item B<cursorUnderline:> I<boolean>
		1052
		1053	B<True>: Make the cursor underlined. B<False>: Make the cursor a box [default];
		1054	option B<-uc>.
		1055
974	=item B<pointerBlank:> I<boolean>	1056	=item B<pointerBlank:> I<boolean>
975		1057
976	B<True>: blank the pointer when a key is pressed or after a set number	1058	B<True>: blank the pointer when a key is pressed or after a set number
977	of seconds of inactivity. B<False>: the pointer is always visible	1059	of seconds of inactivity. B<False>: the pointer is always visible
978	[default].	1060	[default].
…		…
991	large number (e.g. C<987654321>) to effectively disable the timeout.	1073	large number (e.g. C<987654321>) to effectively disable the timeout.
992		1074
993	=item B<backspacekey:> I<string>	1075	=item B<backspacekey:> I<string>
994		1076
995	The string to send when the backspace key is pressed. If set to B<DEC>	1077	The string to send when the backspace key is pressed. If set to B<DEC>
996	or unset it will send B<Delete> (code 127) or, if shifted, B<Backspace>	1078	or unset it will send B<Delete> (code 127) or, with control, B<Backspace>
997	(code 8) - which can be reversed with the appropriate DEC private mode	1079	(code 8) - which can be reversed with the appropriate DEC private mode
998	escape sequence.	1080	escape sequence.
999		1081
1000	=item B<deletekey:> I<string>	1082	=item B<deletekey:> I<string>
1001		1083
…		…
1080		1162
1081	=item B<secondaryScroll:> I<boolean>	1163	=item B<secondaryScroll:> I<boolean>
1082		1164
1083	Turn on/off secondary screen scroll (default enabled). If this	1165	Turn on/off secondary screen scroll (default enabled). If this
1084	option is enabled, scrolls on the secondary screen will change the	1166	option is enabled, scrolls on the secondary screen will change the
1085	scrollback buffer and switching to/from the secondary screen will	1167	scrollback buffer and, when secondaryScreen is off, switching
1086	instead scroll the screen up.	1168	to/from the secondary screen will instead scroll the screen up.
1087		1169
1088	=item B<hold>: I<boolean>	1170	=item B<hold>: I<boolean>
1089		1171
1090	Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@	1172	Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@
1091	will not immediately destroy its window when the program executed within	1173	will not immediately destroy its window when the program executed within
1092	it exits. Instead, it will wait till it is being killed or closed by the	1174	it exits. Instead, it will wait till it is being killed or closed by the
1093	user.	1175	user.
		1176
		1177	=item B<chdir>: I<path>
		1178
		1179	Sets the working directory for the shell (or the command specified via
		1180	B<-e>). The I<path> must be an absolute path and it must exist for
		1181	@@RXVT_NAME@@ to start. If it isn't specified then the current working
		1182	directory will be used; option B<-cd>.
1094		1183
1095	=item B<keysym.>I<sym>: I<string>	1184	=item B<keysym.>I<sym>: I<string>
1096		1185
1097	Compile I<frills>: Associate I<string> with keysym I<sym>. The	1186	Compile I<frills>: Associate I<string> with keysym I<sym>. The
1098	intervening resource name B<keysym.> cannot be omitted.	1187	intervening resource name B<keysym.> cannot be omitted.
…		…
1113	omitting the prefix B<XK_>. Alternatively you can specify I<key> by its hex	1202	omitting the prefix B<XK_>. Alternatively you can specify I<key> by its hex
1114	keysym value (B<0x0000 - 0xFFFF>). Note that the lookup of I<sym>s is not	1203	keysym value (B<0x0000 - 0xFFFF>). Note that the lookup of I<sym>s is not
1115	performed in an exact manner; however, the closest match is assured.	1204	performed in an exact manner; however, the closest match is assured.
1116		1205
1117	I<string> may contain escape values (C<\n>: newline, C<\000>: octal	1206	I<string> may contain escape values (C<\n>: newline, C<\000>: octal
1118	number), see RESOURCES in C<man 7 X> for futher details.	1207	number), see RESOURCES in C<man 7 X> for further details.
1119		1208
1120	You can define a range of keysyms in one shot by providing a I<string>	1209	You can define a range of keysyms in one shot by
		1210	loading the C<keysym-list> perl extension and providing a I<string>
1121	with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimiter `/'	1211	with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimiter `/'
1122	should be a character not used by the strings.	1212	should be a character not used by the strings.
1123		1213
1124	Its usage can be demonstrated by an example:	1214	Its usage can be demonstrated by an example:
1125		1215
1126	URxvt.keysym.M-C-0x61: list\|\033<M-C-\|abc\|>	1216	URxvt.keysym.M-C-0x61: list\|\033<\|abc\|>
1127		1217
1128	The above line is equivalent to the following three lines:	1218	The above line is equivalent to the following three lines:
1129		1219
1130	URxvt.keysym.Meta-Control-0x61: \033<M-C-a>	1220	URxvt.keysym.Meta-Control-0x61: \033<a>
1131	URxvt.keysym.Meta-Control-0x62: \033<M-C-b>	1221	URxvt.keysym.Meta-Control-0x62: \033<b>
1132	URxvt.keysym.Meta-Control-0x63: \033<M-C-c>	1222	URxvt.keysym.Meta-Control-0x63: \033<c>
1133		1223
1134	If I<string> takes the form of C<command:STRING>, the specified B<STRING>	1224	If I<string> takes the form of C<command:STRING>, the specified B<STRING>
1135	is interpreted and executed as @@RXVT_NAME@@'s control sequence. For	1225	is interpreted and executed as @@RXVT_NAME@@'s control sequence. For
1136	example the following means "change the current locale to C<zh_CN.GBK>	1226	example the following means "change the current locale to C<zh_CN.GBK>
1137	when Control-Meta-c is being pressed":	1227	when Control-Meta-c is being pressed":
1138		1228
1139	URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007	1229	URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007
1140		1230
1141	If I<string> takes the form C<perl:STRING>, then the specified B<STRING>	1231	If I<string> takes the form C<perl:STRING>, then the specified B<STRING>
1142	is passed to the C<on_keyboard_command> perl handler. See the @@RXVT_NAME@@perl(3)	1232	is passed to the C<on_user_command> perl handler. See the @@RXVT_NAME@@perl(3)
1143	manpage. For example, the F<selection> extension (activated via	1233	manpage. For example, the F<selection> extension (activated via
1144	C<@@RXVT_NAME@@ -pe selection>) listens for C<selection:rot13> events:	1234	C<@@RXVT_NAME@@ -pe selection>) listens for C<selection:rot13> events:
1145		1235
1146	URxvt.keysym.M-C-c: perl:selection:rot13	1236	URxvt.keysym.M-C-c: perl:selection:rot13
1147		1237
1148	Due the the large number of modifier combinations, a defined key mapping	1238	Due the the large number of modifier combinations, a defined key mapping
1149	will match if at I<at least> the specified identifiers are being set, and	1239	will match if I<at least> the specified identifiers are being set, and
1150	no other key mappings with those and more bits are being defined. That	1240	no other key mappings with those and more bits are being defined. That
1151	means that defining a key map for C<a> will automatically provide	1241	means that defining a key map for C<a> will automatically provide
1152	definitions for C<Meta-a>, C<Shift-a> and so on, unless some of those are defined	1242	definitions for C<Meta-a>, C<Shift-a> and so on, unless some of those are defined
1153	mappings themselves.	1243	mappings themselves.
1154		1244
…		…
1205	all instances, while B<perl-ext> is used for specific instances.	1295	all instances, while B<perl-ext> is used for specific instances.
1206		1296
1207	=item B<perl-eval>: I<string>	1297	=item B<perl-eval>: I<string>
1208		1298
1209	Perl code to be evaluated when all extensions have been registered. See	1299	Perl code to be evaluated when all extensions have been registered. See
1210	the @@RXVT_NAME@@perl(3) manpage. Due to security reasons, this resource	1300	the @@RXVT_NAME@@perl(3) manpage.
1211	will be ignored when running setuid/setgid.
1212		1301
1213	=item B<perl-lib>: I<path>	1302	=item B<perl-lib>: I<path>
1214		1303
1215	Colon-separated list of additional directories that hold extension	1304	Colon-separated list of additional directories that hold extension
1216	scripts. When looking for extensions specified by the C<perl> resource,	1305	scripts. When looking for perl extensions, @@RXVT_NAME@@ will first
1217	@@RXVT_NAME@@ will first look in these directories and then in	1306	look in these directories, then in $HOME/.urxvt/ext and lastly in
1218	F<@@RXVT_LIBDIR@@/urxvt/perl/>. Due to security reasons, this resource	1307	F<@@RXVT_LIBDIR@@/urxvt/perl/>.
1219	will be ignored when running setuid/setgid.
1220		1308
1221	See the @@RXVT_NAME@@perl(3) manpage.	1309	See the @@RXVT_NAME@@perl(3) manpage.
1222		1310
1223	=item B<< selection.pattern-I<idx> >>: I<perl-regex>	1311	=item B<< selection.pattern-I<idx> >>: I<perl-regex>
1224		1312
…		…
1246		1334
1247	=item B<override-redirect>: I<boolean>	1335	=item B<override-redirect>: I<boolean>
1248		1336
1249	Compile I<frills>: Sets override-redirect for the terminal window, making	1337	Compile I<frills>: Sets override-redirect for the terminal window, making
1250	it almost invisible to window managers; option B<-override-redirect>.	1338	it almost invisible to window managers; option B<-override-redirect>.
		1339
		1340	=item B<iso14755:> I<boolean>
		1341
		1342	Turn on/off ISO 14755 (default enabled).
1251		1343
1252	=item B<iso14755_52:> I<boolean>	1344	=item B<iso14755_52:> I<boolean>
1253		1345
1254	Turn on/off ISO 14755 5.2 mode (default enabled).	1346	Turn on/off ISO 14755 5.2 mode (default enabled).
1255		1347
…		…
1398	B<@@RXVT_NAME@@> tries to write an entry into the I<utmp>(5) file so that	1490	B<@@RXVT_NAME@@> tries to write an entry into the I<utmp>(5) file so that
1399	it can be seen via the I<who(1)> command, and can accept messages. To	1491	it can be seen via the I<who(1)> command, and can accept messages. To
1400	allow this feature, B<@@RXVT_NAME@@> may need to be installed setuid root	1492	allow this feature, B<@@RXVT_NAME@@> may need to be installed setuid root
1401	on some systems or setgid to root or to some other group on others.	1493	on some systems or setgid to root or to some other group on others.
1402		1494
1403	=head1 COLORS AND GRAPHICS	1495	=head1 COLOURS AND GRAPHICS
1404		1496
1405	In addition to the default foreground and background colours,	1497	In addition to the default foreground and background colours,
1406	B<@@RXVT_NAME@@> can display up to 16 colours (8 ANSI colours plus	1498	B<@@RXVT_NAME@@> can display up to 88/256 colours: 8 ANSI colours plus
1407	high-intensity bold/blink versions of the same). Here is a list of the	1499	high-intensity (potentially bold/blink) versions of the same, and 72 (or
1408	colours with their names.	1500	240 in 256 colour mode) colours arranged in an 4x4x4 (or 6x6x6) colour RGB
		1501	cube plus a 8 (24) colour greyscale ramp.
		1502
		1503	Here is a list of the ANSI colours with their names.
1409		1504
1410	=begin table	1505	=begin table
1411		1506
1412	B<color0> (black) = Black	1507	B<color0> (black) = Black
1413	B<color1> (red) = Red3	1508	B<color1> (red) = Red3
…		…
1433	It is also possible to specify the colour values of B<foreground>,	1528	It is also possible to specify the colour values of B<foreground>,
1434	B<background>, B<cursorColor>, B<cursorColor2>, B<colorBD>, B<colorUL> as	1529	B<background>, B<cursorColor>, B<cursorColor2>, B<colorBD>, B<colorUL> as
1435	a number 0-15, as a convenient shorthand to reference the colour name of	1530	a number 0-15, as a convenient shorthand to reference the colour name of
1436	color0-color15.	1531	color0-color15.
1437		1532
1438	In addition to the colours defined above, @@RXVT_NAME@@ offers an	1533	The following text gives values for the standard 88 colour mode (and
1439	additional 72 colours. The first 64 of those (with indices 16 to 79)	1534	values for the 256 colour mode in parentheses).
1440	consist of a 444 RGB colour cube (i.e. I<index = r * 16 + g * 4 + b +
1441	16>), followed by 8 additional shades of gray (with indices 80 to 87).
1442		1535
		1536	The RGB cube uses indices 16..79 (16..231) using the following formulas:
		1537
		1538	index_88 = (r * 4 + g) * 4 + b + 16 # r, g, b = 0..3
		1539	index_256 = (r * 16 + g) * 16 + b + 16 # r, g, b = 0..15
		1540
		1541	The grayscale ramp uses indices 80..87 (232..239), from 10% to 90% in 10%
		1542	steps (1/26 to 25/26 in 1/26 steps) - black and white are already part of
		1543	the RGB cube.
		1544
1443	Together, all those colours implement the 88 colour xterm colours. Only	1545	Together, all those colours implement the 88 (256) colour xterm
1444	the first 16 can be changed using resources currently, the rest can only	1546	colours. Only the first 16 can be changed using resources currently, the
1445	be changed via command sequences ("escape codes").	1547	rest can only be changed via command sequences ("escape codes").
		1548
		1549	Applications are advised to use terminfo or command sequences to discover
		1550	number and RGB values of all colours (yes, you can query this...).
1446		1551
1447	Note that B<-rv> (B<"reverseVideo: True">) simulates reverse video by	1552	Note that B<-rv> (B<"reverseVideo: True">) simulates reverse video by
1448	always swapping the foreground/background colours. This is in contrast to	1553	always swapping the foreground/background colours. This is in contrast to
1449	I<xterm>(1) where the colours are only swapped if they have not otherwise	1554	I<xterm>(1) where the colours are only swapped if they have not otherwise
1450	been specified. For example,	1555	been specified. For example,
1451		1556
1452	=over 4
1453
1454	=item B<@@RXVT_NAME@@ -fg Black -bg White -rv>	1557	@@RXVT_NAME@@ -fg Black -bg White -rv
1455		1558
1456	would yield White on Black, while on I<xterm>(1) it would yield Black	1559	would yield White on Black, while on I<xterm>(1) it would yield Black on
1457	on White.	1560	White.
1458
1459	=back
1460		1561
1461	=head2 ALPHA CHANNEL SUPPORT	1562	=head2 ALPHA CHANNEL SUPPORT
1462		1563
1463	If Xft support has been compiled in and as long as Xft/Xrender/X don't get	1564	If Xft support has been compiled in and as long as Xft/Xrender/X don't get
1464	their act together, rxvt-unicode will support C<rgba:rrrr/gggg/bbbb/aaaa>	1565	their act together, rxvt-unicode will do its own alpha channel management:
1465	(recommended, but B<MUST> have 4 digits/component) colour specifications,	1566
1466	in addition to the ones provided by X, where the additional A component	1567	You can prefix any colour with an opaqueness percentage enclosed in
		1568	brackets, i.e. C<[percent]>, where C<percent> is a decimal percentage
		1569	(0-100) that specifies the opacity of the colour, where C<0> is completely
		1570	transparent and C<100> is completely opaque. For example, C<[50]red> is a
		1571	half-transparent red, while C<[95]#00ff00> is an almost opaque green. This
		1572	is the recommended format to specify transparency values, and works with
		1573	all ways to specify a colour.
		1574
		1575	For complete control, rxvt-unicode also supports
		1576	C<rgba:rrrr/gggg/bbbb/aaaa> (exactly four hex digits/component) colour
		1577	specifications, where the additional C<aaaa> component specifies opacity
1467	specifies opacity (alpha) values. The minimum value of C<0> is completely	1578	(alpha) values. The minimum value of C<0000> is completely transparent,
1468	transparent). You can also prefix any color with C<[percent]>, where	1579	while C<ffff> is completely opaque). The two example colours from
1469	C<percent> is a decimal percentage (0-100) that specifies the opacity of	1580	earlier could also be specified as C<rgba:ff00/0000/0000/8000> and
1470	the color, where C<0> is completely transparent and C<100> is completelxy	1581	C<rgba:0000/ff00/0000/f332>.
1471	opaque.
1472		1582
1473	You probably need to specify B<"-depth 32">, too, and have the luck that	1583	You probably need to specify B<"-depth 32">, too, to force a visual with
1474	your X-server uses ARGB pixel layout, as X is far from just supporting	1584	alpha channels, and have the luck that your X-server uses ARGB pixel
1475	ARGB visuals out of the box, and rxvt-unicode just fudges around.	1585	layout, as X is far from just supporting ARGB visuals out of the box, and
		1586	rxvt-unicode just fudges around.
1476		1587
1477	For example, the following selects an almost completely transparent red	1588	For example, the following selects an almost completely transparent black
1478	background, and an almost opaque pink foreground:	1589	background, and an almost opaque pink foreground:
1479		1590
1480	@@RXVT_NAME@@ -depth 32 -bg rgba:0000/0000/0000/aaaa -fg "[80]pink"	1591	@@RXVT_NAME@@ -depth 32 -bg rgba:0000/0000/0000/4444 -fg "[80]pink"
1481		1592
1482	I<Please note that transparency of any kind if completely unsupported by	1593	When not using a background image, then the interpretation of the
1483	the author. Don't bug him with installation questions!>	1594	alpha channel is up to your compositing manager (most interpret it as
		1595	transparency of course).
		1596
		1597	When using a background pixmap or pseudo-transparency, then the background
		1598	colour will always behave as if it were completely transparent (so the
		1599	background image shows instead), regardless of how it was specified, while
		1600	other colours will either be transparent as specified (the background
		1601	image will show through) on servers supporting the RENDER extension, or
		1602	fully opaque on servers not supporting the RENDER EXTENSION.
		1603
		1604	Please note that due to bugs in Xft, specifying alpha values might result
		1605	in garbage being displayed when the X-server does not support the RENDER
		1606	extension.
1484		1607
1485	=head1 ENVIRONMENT	1608	=head1 ENVIRONMENT
1486		1609
1487	B<@@RXVT_NAME@@> sets and/or uses the following environment variables:	1610	B<@@RXVT_NAME@@> sets and/or uses the following environment variables:
1488		1611
…		…
1522	C<--with-terminfo=PATH>.	1645	C<--with-terminfo=PATH>.
1523		1646
1524	=item B<DISPLAY>	1647	=item B<DISPLAY>
1525		1648
1526	Used by @@RXVT_NAME@@ to connect to the display and set to the correct	1649	Used by @@RXVT_NAME@@ to connect to the display and set to the correct
1527	display in its child processes.	1650	display in its child processes if C<-display> isn't used to override. It
		1651	defaults to C<:0> if it doesn't exist.
1528		1652
1529	=item B<SHELL>	1653	=item B<SHELL>
1530		1654
1531	The shell to be used for command execution, defaults to C</bin/sh>.	1655	The shell to be used for command execution, defaults to C</bin/sh>.
1532		1656
1533	=item B<RXVT_SOCKET>	1657	=item B<RXVT_SOCKET>
1534		1658
1535	The unix domain socket path used by @@RXVT_NAME@@c(1) and	1659	The unix domain socket path used by @@RXVT_NAME@@c(1) and
1536	@@RXVT_NAME@@d(1).	1660	@@RXVT_NAME@@d(1).
1537		1661
1538	Default F<<< $HOME/.rxvt-unicode-I<< <nodename >> >>>.	1662	Default F<<< $HOME/.urxvt/urxvtd-I<< <nodename> >> >>>.
1539		1663
1540	=item B<HOME>	1664	=item B<HOME>
1541		1665
1542	Used to locate the default directory for the unix domain socket for	1666	Used to locate the default directory for the unix domain socket for
1543	daemon communications and to locate various resource files (such as	1667	daemon communications and to locate various resource files (such as
1544	C<.Xdefaults>)	1668	C<.Xdefaults>)
1545		1669
1546	=item B<XAPPLRESDIR>	1670	=item B<XAPPLRESDIR>
1547		1671
1548	Directory where various X resource files are being located.	1672	Directory where application-specific X resource files are located.
1549		1673
1550	=item B<XENVIRONMENT>	1674	=item B<XENVIRONMENT>
1551		1675
1552	If set and accessible, gives the name of a X resource file to be loaded by	1676	If set and accessible, gives the name of a X resource file to be loaded by
1553	@@RXVT_NAME@@.	1677	@@RXVT_NAME@@.
…		…
1558		1682
1559	=over 4	1683	=over 4
1560		1684
1561	=item B</usr/lib/X11/rgb.txt>	1685	=item B</usr/lib/X11/rgb.txt>
1562		1686
1563	Color names.	1687	Colour names.
1564		1688
1565	=back	1689	=back
1566		1690
1567	=head1 SEE ALSO	1691	=head1 SEE ALSO
1568		1692
…		…
1619		1743
1620	Project Coordinator (Changes 1.0 -)	1744	Project Coordinator (Changes 1.0 -)
1621		1745
1622	=item Emanuele Giaquinta L<< <e.giaquinta@glauco.it> >>	1746	=item Emanuele Giaquinta L<< <e.giaquinta@glauco.it> >>
1623		1747
1624	Pty/tty/utmp/wtmp rewrite, lots of random hacking and bugfixing.	1748	pty/utmp code rewrite, image code improvements, many random hacks and bugfixes.
1625		1749
1626	=back	1750	=back
1627		1751

Diff Legend

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

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents): Revision 1.147 by root, Fri Nov 23 11:18:04 2007 UTC vs. Revision 1.210 by sf-exg, Mon Dec 26 15:20:58 2011 UTC

Diff Legend

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents):
Revision 1.147 by root, Fri Nov 23 11:18:04 2007 UTC vs.
Revision 1.210 by sf-exg, Mon Dec 26 15:20:58 2011 UTC