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

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents):
Revision 1.136 by root, Mon Aug 13 10:01:18 2007 UTC vs.
Revision 1.187 by sf-exg, Fri Oct 15 10:46:57 2010 UTC

…		…
12	emulator intended as an I<xterm>(1) replacement for users who do not	12	emulator intended as an I<xterm>(1) replacement for users who do not
13	require features such as Tektronix 4014 emulation and toolkit-style	13	require features such as Tektronix 4014 emulation and toolkit-style
14	configurability. As a result, B<rxvt-unicode> uses much less swap space --	14	configurability. As a result, B<rxvt-unicode> uses much less swap space --
15	a significant advantage on a machine serving many X sessions.	15	a significant advantage on a machine serving many X sessions.
16		16
		17	This document is also available on the World-Wide-Web at
		18	L<http://pod.tst.eu/http://cvs.schmorp.de/rxvt-unicode/doc/rxvt.1.pod>.
		19
17	=head1 FREQUENTLY ASKED QUESTIONS	20	=head1 FREQUENTLY ASKED QUESTIONS
18		21
19	See @@RXVT_NAME@@(7) (try C<man 7 @@RXVT_NAME@@>) for a list of	22	See @@RXVT_NAME@@(7) (try C<man 7 @@RXVT_NAME@@>) for a list of
20	frequently asked questions and answer to them and some common	23	frequently asked questions and answer to them and some common
21	problems. That document is also accessible on the World-Wide-Web at	24	problems. That document is also accessible on the World-Wide-Web at
22	L<http://cvs.schmorp.de/browse/rxvt-unicode/doc/rxvt.7.html>.	25	L<http://pod.tst.eu/http://cvs.schmorp.de/rxvt-unicode/doc/rxvt.7.pod>.
23		26
24	=head1 RXVT-UNICODE VS. RXVT	27	=head1 RXVT-UNICODE VS. RXVT
25		28
26	Unlike the original rxvt, B<rxvt-unicode> stores all text in Unicode	29	Unlike the original rxvt, B<rxvt-unicode> stores all text in Unicode
27	internally. That means it can store and display most scripts in the	30	internally. That means it can store and display most scripts in the
…		…
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>
…		…
114		122
115	=item B<-ss>\|B<+ss>	123	=item B<-ss>\|B<+ss>
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<-ip>\|B<+ip> \| B<-tr>\|B<+tr>	127	=item B<-tr>\|B<+tr>
120		128
121	Turn on/off inheriting parent window's pixmap. Alternative form is	129	Turn on/off illusion of a transparent window background; resource B<transparent>.
122	B<-tr>; resource B<inheritPixmap>.
123		130
124	I<Please note that transparency of any kind if completely unsupported by	131	B<-ip> is still accepted as an obsolete alias but will be removed in
125	the author. Don't bug him with installation questions! Read the FAQ (man 7	132	future versions.
126	@@RXVT_NAME@@)!>
127		133
128	=item B<-fade> I<number>	134	=item B<-fade> I<number>
129		135
130	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
131	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	is opaque black. resource B<fadeColor>.	143	is opaque black. resource B<fadeColor>.
138		144
139	=item B<-tint> I<colour>	145	=item B<-tint> I<colour>
140		146
141	Tint the transparent background pixmap with the given colour when	147	Tint the transparent background pixmap with the given colour when
142	transparency is enabled with B<-tr> or B<-ip>. This only works for	148	transparency is enabled with B<-tr>. This only works for
143	non-tiled backgrounds, currently. See also the B<-sh> option that can be	149	non-tiled backgrounds, currently. See also the B<-sh> option that can be
144	used to brighten or darken the image in addition to tinting it.	150	used to brighten or darken the image in addition to tinting it.
145	Please note that certain tint colours can be applied on the server-side,	151	Please note that certain tint colours can be applied on the server-side,
146	thus yielding performance gain of two orders of magnitude. These colours are:	152	thus yielding performance gain of two orders of magnitude. These colours are:
147	blue, red, green, cyan, magenta, yellow, and those close to them; resource	153	blue, red, green, cyan, magenta, yellow, and those close to them. Also
		154	pure black and pure white colours essentially mean no tinting; resource
148	I<tintColor>. Example:	155	I<tintColor>. Example:
149		156
150	@@RXVT_NAME@@ -tr -tint blue -sh 40	157	@@RXVT_NAME@@ -tr -tint blue -sh 40
151		158
152	=item B<-sh> I<number>	159	=item B<-sh> I<number>
153		160
154	Darken (0 .. 100) or lighten (-1 .. -100) the transparent	161	Darken (0 .. 100) or lighten (100 .. 200) the transparent
155	background image in addition to (or instead of) tinting it;	162	background image in addition to (or instead of) tinting it;
156	resource I<shading>.	163	resource I<shading>.
157		164
158	=item B<-blt> I<string>	165	=item B<-blt> I<string>
159		166
160	Specify background blending type. If background pixmap is specified	167	Specify background blending type. If background pixmap is specified
161	at the same time as transparency - such pixmap will be blended over	168	at the same time as transparency - such pixmap will be blended over
162	transparency image, using method specified. Supported values are :	169	transparency image, using method specified. Supported values are :
163	B<add>, B<alphablend>, B<allanon> - color values averaging, B<colorize>,	170	B<add>, B<alphablend>, B<allanon> - colour values averaging, B<colorize>,
164	B<darken>, B<diff>, B<dissipate>, B<hue>, B<lighten>, B<overlay>,	171	B<darken>, B<diff>, B<dissipate>, B<hue>, B<lighten>, B<overlay>,
165	B<saturate>, B<screen>, B<sub>, B<tint>, B<value>. The default is	172	B<saturate>, B<screen>, B<sub>, B<tint>, B<value>. The default is
166	alpha-blending; resource I<blendType>.	173	alpha-blending. Compile I<afterimage>; resource I<blendType>.
167		174
168	=item B<-blr> I<HxV>	175	=item B<-blr> I<HxV>
169		176
170	Apply Gaussian Blur with the specified radii to the transparent	177	Apply Gaussian Blur with the specified radii to the transparent
171	background image. If single number is specified - both vertical and	178	background image. If single number is specified - both vertical and
172	horizontal radii are considered to be the same. Setting one of the	179	horizontal radii are considered to be the same. Setting one of the
173	radii to 1 and another to a large number creates interesting effects	180	radii to 1 and another to a large number creates interesting effects
174	on some backgrounds. Maximum radius value is 128; resource I<blurRadius>.	181	on some backgrounds. Maximum radius value is 128. Compile I<afterimage> or I<xft>;
		182	resource I<blurRadius>.
		183
		184	=item B<-icon> I<file>
		185
		186	Compile I<afterimage> or I<pixbuf>: Use the specified image as application icon. This
		187	is used by many window managers, taskbars and pagers to represent the
		188	application window; resource I<iconFile>.
175		189
176	=item B<-bg> I<colour>	190	=item B<-bg> I<colour>
177		191
178	Window background colour; resource B<background>.	192	Window background colour; resource B<background>.
179		193
180	=item B<-fg> I<colour>	194	=item B<-fg> I<colour>
181		195
182	Window foreground colour; resource B<foreground>.	196	Window foreground colour; resource B<foreground>.
183		197
184	=item B<-pixmap> I<file[;geom]>	198	=item B<-pixmap> I<file[;geom[:op1][:op2][...]]>
185		199
186	Compile I<afterimage>: Specify image file for the background and also	200	Compile I<afterimage> or I<pixbuf>: Specify image file for the background and also
187	optionally specify its scaling with a geometry string. Note you may need to	201	optionally specify its scaling with a geometry string. Note you may need to
188	add quotes to avoid special shell interpretation of the C<;> in the	202	add quotes to avoid special shell interpretation of the C<;> in the
189	command-line; for more details see resource B<backgroundPixmap>.	203	command-line; for more details see resource B<backgroundPixmap>.
190		204
191	=item B<-cr> I<colour>	205	=item B<-cr> I<colour>
…		…
239	italic> >> characters are to be printed. See resource B<boldItalicFont>	253	italic> >> characters are to be printed. See resource B<boldItalicFont>
240	for details.	254	for details.
241		255
242	=item B<-is>\|B<+is>	256	=item B<-is>\|B<+is>
243		257
244	Compile I<font-styles>: Bold/Italic font styles imply high intensity	258	Compile I<font-styles>: Bold/Blink font styles imply high intensity
245	foreground/background (default). See resource B<intensityStyles> for	259	foreground/background (default). See resource B<intensityStyles> for
246	details.	260	details.
247		261
248	=item B<-name> I<name>	262	=item B<-name> I<name>
249		263
…		…
267		281
268	=item B<-sb>\|B<+sb>	282	=item B<-sb>\|B<+sb>
269		283
270	Turn on/off scrollbar; resource B<scrollBar>.	284	Turn on/off scrollbar; resource B<scrollBar>.
271		285
		286	=item B<-sr>\|B<+sr>
		287
		288	Put scrollbar on right/left; resource B<scrollBar_right>.
		289
		290	=item B<-st>\|B<+st>
		291
		292	Display rxvt (non XTerm/NeXT) scrollbar without/with a trough;
		293	resource B<scrollBar_floating>.
		294
272	=item B<-si>\|B<+si>	295	=item B<-si>\|B<+si>
273		296
274	Turn on/off scroll-to-bottom on TTY output inhibit; resource	297	Turn on/off scroll-to-bottom on TTY output inhibit; resource
275	B<scrollTtyOutput> has opposite effect.	298	B<scrollTtyOutput> has opposite effect.
276		299
…		…
282	=item B<-sw>\|B<+sw>	305	=item B<-sw>\|B<+sw>
283		306
284	Turn on/off scrolling with the scrollback buffer as new lines appear.	307	Turn on/off scrolling with the scrollback buffer as new lines appear.
285	This only takes effect if B<-si> is also given; resource	308	This only takes effect if B<-si> is also given; resource
286	B<scrollWithBuffer>.	309	B<scrollWithBuffer>.
287
288	=item B<-sr>\|B<+sr>
289
290	Put scrollbar on right/left; resource B<scrollBar_right>.
291
292	=item B<-st>\|B<+st>
293
294	Display rxvt (non XTerm/NeXT) scrollbar without/with a trough;
295	resource B<scrollBar_floating>.
296		310
297	=item B<-ptab>\|B<+ptab>	311	=item B<-ptab>\|B<+ptab>
298		312
299	If enabled (default), "Horizontal Tab" characters are being stored as	313	If enabled (default), "Horizontal Tab" characters are being stored as
300	actual wide characters in the screen buffer, which makes it possible to	314	actual wide characters in the screen buffer, which makes it possible to
…		…
304		318
305	=item B<-bc>\|B<+bc>	319	=item B<-bc>\|B<+bc>
306		320
307	Blink the cursor; resource B<cursorBlink>.	321	Blink the cursor; resource B<cursorBlink>.
308		322
		323	=item B<-uc>\|B<+uc>
		324
		325	Make the cursor underlined; resource B<cursorUnderline>.
		326
309	=item B<-iconic>	327	=item B<-iconic>
310		328
311	Start iconified, if the window manager supports that option.	329	Start iconified, if the window manager supports that option.
312	Alternative form is B<-ic>.	330	Alternative form is B<-ic>.
313		331
…		…
329		347
330	=item B<-bl>	348	=item B<-bl>
331		349
332	Compile I<frills>: Set MWM hints to request a borderless window, i.e.	350	Compile I<frills>: Set MWM hints to request a borderless window, i.e.
333	if honoured by the WM, the rxvt-unicode window will not have window	351	if honoured by the WM, the rxvt-unicode window will not have window
334	decorations; resource B<borderLess>.	352	decorations; resource B<borderLess>. If the window manager does not
		353	support MWM hints (e.g. kwin), enables override-redirect mode.
335		354
336	=item B<-override-redirect>	355	=item B<-override-redirect>
337		356
338	Compile I<frills>: Sets override-redirect on the window; resource	357	Compile I<frills>: Sets override-redirect on the window; resource
339	B<override-redirect>.	358	B<override-redirect>.
…		…
347		366
348	=item B<-lsp> I<number>	367	=item B<-lsp> I<number>
349		368
350	Compile I<frills>: Lines (pixel height) to insert between each row of	369	Compile I<frills>: Lines (pixel height) to insert between each row of
351	the display. Useful to work around font rendering problems; resource	370	the display. Useful to work around font rendering problems; resource
352	B<linespace>.	371	B<lineSpace>.
		372
		373	=item B<-letsp> I<number>
		374
		375	Compile I<frills>: Amount to adjust the computed character width by
		376	to control overall letter spacing. Negative values will tighten up the
		377	letter spacing, positive values will space letters out more. Useful to
		378	work around odd font metrics; resource B<letterSpace>.
353		379
354	=item B<-tn> I<termname>	380	=item B<-tn> I<termname>
355		381
356	This option specifies the name of the terminal type to be set in the	382	This option specifies the name of the terminal type to be set in the
357	B<TERM> environment variable. This terminal type must exist in the	383	B<TERM> environment variable. This terminal type must exist in the
…		…
412		438
413	=item B<-tcw>	439	=item B<-tcw>
414		440
415	Change the meaning of triple-click selection with the left mouse	441	Change the meaning of triple-click selection with the left mouse
416	button. Only effective when the original (non-perl) selection code is	442	button. Only effective when the original (non-perl) selection code is
417	in-use. Instead of selecting a full line it will extend the selection the	443	in-use. Instead of selecting a full line it will extend the selection to
418	end of the logical line only. resource B<tripleclickwords>.	444	the end of the logical line only. resource B<tripleclickwords>.
419		445
420	=item B<-insecure>	446	=item B<-insecure>
421		447
422	Enable "insecure" mode, which currently enables most of the escape	448	Enable "insecure" mode, which currently enables most of the escape
423	sequences that echo strings. See the resource B<insecure> for more	449	sequences that echo strings. See the resource B<insecure> for more
…		…
443		469
444	Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@	470	Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@
445	will not immediately destroy its window when the program executed within	471	will not immediately destroy its window when the program executed within
446	it exits. Instead, it will wait till it is being killed or closed by the	472	it exits. Instead, it will wait till it is being killed or closed by the
447	user; resource B<hold>.	473	user; resource B<hold>.
		474
		475	=item B<-cd> I<path>
		476
		477	Sets the working directory for the shell (or the command specified via
		478	B<-e>). The I<path> must be an absolute path and it must exist for
		479	@@RXVT_NAME@@ to start; resource B<chdir>.
		480
		481	=item B<-xrm> I<string>
		482
		483	Works like the X Toolkit option of the same name, by adding the I<string>
		484	as if it were specified in a resource file. Resource values specified this
		485	way take precedence over all other resource specifications.
		486
		487	Note that you need to use the I<same> syntax as in the .Xdefaults file,
		488	e.g. C<*.background: black>. Also note that all @@RXVT_NAME@@-specific
		489	options can be specified as long-options on the commandline, so use
		490	of B<-xrm> is mostly limited to cases where you want to specify other
		491	resources (e.g. for input methods) or for compatibility with other
		492	programs.
448		493
449	=item B<-keysym.>I<sym> I<string>	494	=item B<-keysym.>I<sym> I<string>
450		495
451	Remap a key symbol. See resource B<keysym>.	496	Remap a key symbol. See resource B<keysym>.
452		497
…		…
487	If this switch is given, @@RXVT_NAME@@ will not create any utmp/wtmp	532	If this switch is given, @@RXVT_NAME@@ will not create any utmp/wtmp
488	entries and will not tinker with pty/tty permissions - you have to do that	533	entries and will not tinker with pty/tty permissions - you have to do that
489	yourself if you want that.	534	yourself if you want that.
490		535
491	As an extremely special case, specifying C<-1> will completely suppress	536	As an extremely special case, specifying C<-1> will completely suppress
492	pty/tty operations.	537	pty/tty operations, which is probably only useful in conjunction with some
		538	perl extension that manages the terminal.
493		539
494	Here is a example in perl that illustrates how this option can be used (a	540	Here is a example in perl that illustrates how this option can be used (a
495	longer example is in F<doc/pty-fd>):	541	longer example is in F<doc/pty-fd>):
496		542
497	use IO::Pty;	543	use IO::Pty;
…		…
511	Comma-separated list of perl extension scripts to use (or not to use) in	557	Comma-separated list of perl extension scripts to use (or not to use) in
512	this terminal instance. See resource B<perl-ext> for details.	558	this terminal instance. See resource B<perl-ext> for details.
513		559
514	=back	560	=back
515		561
516	=head1 RESOURCES (available also as long-options)	562	=head1 RESOURCES
517		563
518	Note: `@@RXVT_NAME@@ --help' gives a list of all resources (long	564	Note: `@@RXVT_NAME@@ --help' gives a list of all resources (long
519	options) compiled into your version.	565	options) compiled into your version. All resources are also available as
		566	long-options.
520		567
521	You can set and change the resources using X11 tools like B<xrdb>. Many	568	You can set and change the resources using X11 tools like B<xrdb>. Many
522	distribution do also load settings from the B<~/.Xresources> file when X	569	distribution do also load settings from the B<~/.Xresources> file when X
523	starts. @@RXVT_NAME@@ will consult the following files/resources in order,	570	starts. @@RXVT_NAME@@ will consult the following files/resources in order,
524	with later settings overwriting earlier ones:	571	with later settings overwriting earlier ones:
…		…
526	1. system-wide app-defaults file, either locale-dependent OR global	573	1. system-wide app-defaults file, either locale-dependent OR global
527	2. app-defaults file in $XAPPLRESDIR	574	2. app-defaults file in $XAPPLRESDIR
528	3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults	575	3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults
529	4. SCREEN_RESOURCES for the current screen	576	4. SCREEN_RESOURCES for the current screen
530	5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename>	577	5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename>
		578	6. resources specified via -xrm on the commandline
531		579
532	Note that when reading X resources, B<@@RXVT_NAME@@> recognizes two class	580	Note that when reading X resources, B<@@RXVT_NAME@@> recognizes two class
533	names: B<Rxvt> and B<URxvt>. The class name B<Rxvt> allows resources	581	names: B<Rxvt> and B<URxvt>. The class name B<Rxvt> allows resources
534	common to both B<@@RXVT_NAME@@> and the original I<rxvt> to be easily	582	common to both B<@@RXVT_NAME@@> and the original I<rxvt> to be easily
535	configured, while the class name B<URxvt> allows resources unique to	583	configured, while the class name B<URxvt> allows resources unique to
…		…
545	=item B<depth:> I<bitdepth>	593	=item B<depth:> I<bitdepth>
546		594
547	Compile I<xft>: Attempt to find a visual with the given bit depth;	595	Compile I<xft>: Attempt to find a visual with the given bit depth;
548	option B<-depth>.	596	option B<-depth>.
549		597
		598	=item B<buffered:> I<boolean>
		599
		600	Compile I<xft>: Turn on/off double-buffering for xft (default enabled).
		601	On some card/driver combination enabling it slightly decreases
		602	performance, on most it greatly helps it. The slowdown is small, so it
		603	should normally be enabled.
		604
550	=item B<geometry:> I<geom>	605	=item B<geometry:> I<geom>
551		606
552	Create the window with the specified X window geometry [default 80x24];	607	Create the window with the specified X window geometry [default 80x24];
553	option B<-geometry>.	608	option B<-geometry>.
554		609
…		…
567	Use the specified colour for the colour value I<n>, where 0-7	622	Use the specified colour for the colour value I<n>, where 0-7
568	corresponds to low-intensity (normal) colours and 8-15 corresponds to	623	corresponds to low-intensity (normal) colours and 8-15 corresponds to
569	high-intensity (bold = bright foreground, blink = bright background)	624	high-intensity (bold = bright foreground, blink = bright background)
570	colours. The canonical names are as follows: 0=black, 1=red, 2=green,	625	colours. The canonical names are as follows: 0=black, 1=red, 2=green,
571	3=yellow, 4=blue, 5=magenta, 6=cyan, 7=white, but the actual colour	626	3=yellow, 4=blue, 5=magenta, 6=cyan, 7=white, but the actual colour
572	names used are listed in the B<COLORS AND GRAPHICS> section.	627	names used are listed in the B<COLOURS AND GRAPHICS> section.
573		628
574	Colours higher than 15 cannot be set using resources (yet), but can be	629	Colours higher than 15 cannot be set using resources (yet), but can be
575	changed using an escape command (see @@RXVT_NAME@@(7)).	630	changed using an escape command (see @@RXVT_NAME@@(7)).
576		631
577	Colours 16-79 form a standard 4x4x4 colour cube (the same as xterm with	632	Colours 16-79 form a standard 4x4x4 colour cube (the same as xterm with
…		…
588	=item B<colorUL:> I<colour>	643	=item B<colorUL:> I<colour>
589		644
590	Use the specified colour to display underlined characters when the	645	Use the specified colour to display underlined characters when the
591	foreground colour is the default.	646	foreground colour is the default.
592		647
593	=item B<colorRV:> I<colour>
594
595	Use the specified colour as the background for reverse video characters
596	when OPTION_HC is disabled (--disable-frills).
597
598	=item B<underlineColor:> I<colour>	648	=item B<underlineColor:> I<colour>
599		649
600	If set, use the specified colour as the colour for the underline	650	If set, use the specified colour as the colour for the underline
601	itself. If unset, use the foreground colour.	651	itself. If unset, use the foreground colour.
		652
		653	=item B<highlightColor:> I<colour>
		654
		655	If set, use the specified colour as the background for highlighted
		656	characters. If unset, use reverse video.
		657
		658	=item B<highlightTextColor:> I<colour>
		659
		660	If set and highlightColor is set, use the specified colour as the
		661	foreground for highlighted characters.
602		662
603	=item B<cursorColor:> I<colour>	663	=item B<cursorColor:> I<colour>
604		664
605	Use the specified colour for the cursor. The default is to use the	665	Use the specified colour for the cursor. The default is to use the
606	foreground colour; option B<-cr>.	666	foreground colour; option B<-cr>.
…		…
613		673
614	=item B<reverseVideo:> I<boolean>	674	=item B<reverseVideo:> I<boolean>
615		675
616	B<True>: simulate reverse video by foreground and background colours;	676	B<True>: simulate reverse video by foreground and background colours;
617	option B<-rv>. B<False>: regular screen colours [default]; option	677	option B<-rv>. B<False>: regular screen colours [default]; option
618	B<+rv>. See note in B<COLORS AND GRAPHICS> section.	678	B<+rv>. See note in B<COLOURS AND GRAPHICS> section.
619		679
620	=item B<jumpScroll:> I<boolean>	680	=item B<jumpScroll:> I<boolean>
621		681
622	B<True>: specify that jump scrolling should be used. When receiving lots	682	B<True>: specify that jump scrolling should be used. When receiving lots
623	of lines, @@RXVT_NAME@@ will only scroll once a whole screen height of lines	683	of lines, @@RXVT_NAME@@ will only scroll once a whole screen height of lines
…		…
637		697
638	B<False>: specify that everything is to be displayed, even	698	B<False>: specify that everything is to be displayed, even
639	if the refresh is too fast for the human eye to read anything (or the	699	if the refresh is too fast for the human eye to read anything (or the
640	monitor to display anything); option B<+ss>.	700	monitor to display anything); option B<+ss>.
641		701
642	=item B<inheritPixmap:> I<boolean>	702	=item B<transparent:> I<boolean>
643		703
644	B<True>: make the background inherit the parent windows' pixmap, giving	704	Turn on/off illusion of a transparent window background.
645	artificial transparency. B<False>: do not inherit the parent windows'
646	pixmap.
647		705
648	I<Please note that transparency of any kind if completely unsupported by	706	B<inheritPixmap> is still accepted as an obsolete alias but will be removed in
649	the author. Don't bug him with installation questions!>	707	future versions.
650		708
651	=item B<fading:> I<number>	709	=item B<fading:> I<number>
652		710
653	Fade the text by the given percentage when focus is lost; option B<-fade>.	711	Fade the text by the given percentage when focus is lost; option B<-fade>.
654		712
…		…
671		729
672	Specify background blending type; option B<-blt>.	730	Specify background blending type; option B<-blt>.
673		731
674	=item B<blurRadius:> I<number>	732	=item B<blurRadius:> I<number>
675		733
676	Apply Gaussian Blurr with the specified radius to the transparent	734	Apply gaussian blur with the specified radius to the transparent
677	background image; option B<-blr>.	735	background image; option B<-blr>.
		736
		737	=item B<iconFile:> I<file>
		738
		739	Set the application icon pixmap; option B<-icon>.
678		740
679	=item B<scrollColor:> I<colour>	741	=item B<scrollColor:> I<colour>
680		742
681	Use the specified colour for the scrollbar [default #B2B2B2].	743	Use the specified colour for the scrollbar [default #B2B2B2].
682		744
…		…
688	=item B<borderColor:> I<colour>	750	=item B<borderColor:> I<colour>
689		751
690	The colour of the border around the text area and between the scrollbar	752	The colour of the border around the text area and between the scrollbar
691	and the text.	753	and the text.
692		754
693	=item B<backgroundPixmap:> I<file[;geom]>	755	=item B<backgroundPixmap:> I<file[;geom[:op1][:op2][...]]>
694		756
695	Use the specified image file for the background and also optionally	757	Use the specified image file for the background and also
696	specify its scaling with a geometry string B<WxH+X+Y>,	758	optionally specify its scaling with a geometry string B<WxH+X+Y>,
697	in which B<"W" / "H"> specify the horizontal/vertical scale (percent),	759	(default C<100x100+50+50>) in which B<"W" / "H"> specify the
698	and B<"X" / "Y"> locate the image centre (percent).	760	horizontal/vertical scale (percent), and B<"X" / "Y"> locate the image
699	A scale of 0 displays the image with tiling. A scale of 1 displays the	761	centre (percent). A scale of 0 displays the image with tiling.
700	image without any scaling. A scale of 2 to 9 specifies an integer	762	The maximum permitted scale is 1000.
701	number of images in that direction. No image will be magnified beyond	763	Additional operations can be specified after colon B<:op1:op2...>.
702	10 times its original size. The maximum permitted scale is 1000.	764	Supported operations are:
703	Special string of B<"auto"> used as a geometry will cause image to be	765
704	automatically scaled to match window size.	766	tile force background image to be tiled and not scaled. Equivalent to 0x0
		767	propscale will scale image keeping proportions
		768	auto will scale image to match window size. Equivalent to 100x100
		769	hscale will scale image horizontally to the window size
		770	vscale will scale image vertically to the window size
		771	scale will scale image to match window size
		772	root will tile image as if it was a root window background, auto-adjusting
		773	whenever terminal window moves
		774
705	If used in conjunction with B<-tr> option - specified pixmap will be	775	If used in conjunction with B<-tr> option, the specified pixmap will be
706	blended over transparency image using either alpha-blending, or any	776	blended over transparency image using alpha-blending. If I<afterimage>
707	other blending type, specified with B<-blt "type"> option.	777	support has been compiled in it is possible to choose other blending
708	[default 0x0+50+50]	778	types with B<-blt "type"> option.
709		779
710	=item B<path:> I<path>	780	=item B<path:> I<path>
711		781
712	Specify the colon-delimited search path for finding XPM files.	782	Specify the colon-delimited search path for finding background image files.
713		783
714	=item B<font:> I<fontlist>	784	=item B<font:> I<fontlist>
715		785
716	Select the fonts to be used. This is a comma separated list of font names	786	Select the fonts to be used. This is a comma separated list of font names
717	that are checked in order when trying to find glyphs for characters. The	787	that are checked in order when trying to find glyphs for characters. The
…		…
740	it is named first) and thus defines the character cell grid to be 9 pixels	810	it is named first) and thus defines the character cell grid to be 9 pixels
741	wide and 15 pixels high.	811	wide and 15 pixels high.
742		812
743	The second font is just used to add additional unicode characters not in	813	The second font is just used to add additional unicode characters not in
744	the base font, likewise the third, which is unfortunately non-bold, but	814	the base font, likewise the third, which is unfortunately non-bold, but
745	the bold version of the font does contain less characters, so this is a	815	the bold version of the font does contain fewer characters, so this is a
746	useful supplement.	816	useful supplement.
747		817
748	The third font is an Xft font with aliasing turned off, and the characters	818	The third font is an Xft font with aliasing turned off, and the characters
749	are limited to the B<JIS 0208> codeset (i.e. japanese kanji). The font	819	are limited to the B<JIS 0208> codeset (i.e. japanese kanji). The font
750	contains other characters, but we are not interested in them.	820	contains other characters, but we are not interested in them.
…		…
774	text font will being used for the given style.	844	text font will being used for the given style.
775		845
776	=item B<intensityStyles:> I<boolean>	846	=item B<intensityStyles:> I<boolean>
777		847
778	When font styles are not enabled, or this option is enabled (B<True>,	848	When font styles are not enabled, or this option is enabled (B<True>,
779	option B<-is>, the default), bold and italic font styles imply high	849	option B<-is>, the default), bold/blink font styles imply high
780	intensity foreground/background colours. Disabling this option (B<False>,	850	intensity foreground/background colours. Disabling this option (B<False>,
781	option B<+is>) disables this behaviour, the high intensity colours are not	851	option B<+is>) disables this behaviour, the high intensity colours are not
782	reachable.	852	reachable.
783		853
784	=item B<selectstyle:> I<mode>
785
786	Set mouse selection style to B<old> which is 2.20, B<oldword> which
787	is xterm style with 2.20 old word selection, or anything else which
788	gives xterm style selection. Only effective when the original (non-perl)
789	selection code is in use.
790
791	=item B<scrollstyle:> I<mode>
792
793	Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is
794	the author's favourite.
795
796	=item B<title:> I<string>	854	=item B<title:> I<string>
797		855
798	Set window title string, the default title is the command-line	856	Set window title string, the default title is the command-line
799	specified after the B<-e> option, if any, otherwise the application	857	specified after the B<-e> option, if any, otherwise the application
800	name; option B<-title>.	858	name; option B<-title>.
…		…
813	=item B<urgentOnBell:> I<boolean>	871	=item B<urgentOnBell:> I<boolean>
814		872
815	B<True>: set the urgency hint for the wm on receipt of a bell character.	873	B<True>: set the urgency hint for the wm on receipt of a bell character.
816	B<False>: do not set the urgency hint [default].	874	B<False>: do not set the urgency hint [default].
817		875
		876	@@RXVT_NAME@@ resets the urgency hint on every focus change.
		877
818	=item B<visualBell:> I<boolean>	878	=item B<visualBell:> I<boolean>
819		879
820	B<True>: use visual bell on receipt of a bell character; option B<-vb>.	880	B<True>: use visual bell on receipt of a bell character; option B<-vb>.
821	B<False>: no visual bell [default]; option B<+vb>.	881	B<False>: no visual bell [default]; option B<+vb>.
822		882
…		…
844		904
845	URxvt.print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX)	905	URxvt.print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX)
846		906
847	This creates a new file in your home directory with the screen contents	907	This creates a new file in your home directory with the screen contents
848	every time you hit C<Print>.	908	every time you hit C<Print>.
		909
		910	=item B<scrollstyle:> I<mode>
		911
		912	Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is
		913	the author's favourite.
849		914
850	=item B<scrollBar:> I<boolean>	915	=item B<scrollBar:> I<boolean>
851		916
852	B<True>: enable the scrollbar [default]; option B<-sb>. B<False>:	917	B<True>: enable the scrollbar [default]; option B<-sb>. B<False>:
853	disable the scrollbar; option B<+sb>.	918	disable the scrollbar; option B<+sb>.
…		…
916	=item B<termName:> I<termname>	981	=item B<termName:> I<termname>
917		982
918	Specifies the terminal type name to be set in the B<TERM> environment	983	Specifies the terminal type name to be set in the B<TERM> environment
919	variable; option B<-tn>.	984	variable; option B<-tn>.
920		985
921	=item B<linespace:> I<number>	986	=item B<lineSpace:> I<number>
922		987
923	Specifies number of lines (pixel height) to insert between each row of	988	Specifies number of lines (pixel height) to insert between each row of
924	the display [default 0]; option B<-lsp>.	989	the display [default 0]; option B<-lsp>.
925		990
926	=item B<meta8:> I<boolean>	991	=item B<meta8:> I<boolean>
…		…
940		1005
941	=item B<cursorBlink:> I<boolean>	1006	=item B<cursorBlink:> I<boolean>
942		1007
943	B<True>: blink the cursor. B<False>: do not blink the cursor [default];	1008	B<True>: blink the cursor. B<False>: do not blink the cursor [default];
944	option B<-bc>.	1009	option B<-bc>.
		1010
		1011	=item B<cursorUnderline:> I<boolean>
		1012
		1013	B<True>: Make the cursor underlined. B<False>: Make the cursor a box [default];
		1014	option B<-uc>.
945		1015
946	=item B<pointerBlank:> I<boolean>	1016	=item B<pointerBlank:> I<boolean>
947		1017
948	B<True>: blank the pointer when a key is pressed or after a set number	1018	B<True>: blank the pointer when a key is pressed or after a set number
949	of seconds of inactivity. B<False>: the pointer is always visible	1019	of seconds of inactivity. B<False>: the pointer is always visible
…		…
963	large number (e.g. C<987654321>) to effectively disable the timeout.	1033	large number (e.g. C<987654321>) to effectively disable the timeout.
964		1034
965	=item B<backspacekey:> I<string>	1035	=item B<backspacekey:> I<string>
966		1036
967	The string to send when the backspace key is pressed. If set to B<DEC>	1037	The string to send when the backspace key is pressed. If set to B<DEC>
968	or unset it will send B<Delete> (code 127) or, if shifted, B<Backspace>	1038	or unset it will send B<Delete> (code 127) or, with control, B<Backspace>
969	(code 8) - which can be reversed with the appropriate DEC private mode	1039	(code 8) - which can be reversed with the appropriate DEC private mode
970	escape sequence.	1040	escape sequence.
971		1041
972	=item B<deletekey:> I<string>	1042	=item B<deletekey:> I<string>
973		1043
…		…
986	will be created). In this mode, characters outside ISO-8859-1 can be used.	1056	will be created). In this mode, characters outside ISO-8859-1 can be used.
987		1057
988	When the selection extension is not used, only ISO-8859-1 characters can	1058	When the selection extension is not used, only ISO-8859-1 characters can
989	be used. If not specified, the built-in default is used:	1059	be used. If not specified, the built-in default is used:
990		1060
991	B<< BACKSLASH `"'&()*,;<=>?@[]{\|} >>	1061	B<< BACKSLASH `"'&()*,;<=>?@[]^{\|} >>
992		1062
993	=item B<preeditType:> I<style>	1063	=item B<preeditType:> I<style>
994		1064
995	B<OverTheSpot>, B<OffTheSpot>, B<Root>; option B<-pt>.	1065	B<OverTheSpot>, B<OffTheSpot>, B<Root>; option B<-pt>.
996		1066
…		…
1052		1122
1053	=item B<secondaryScroll:> I<boolean>	1123	=item B<secondaryScroll:> I<boolean>
1054		1124
1055	Turn on/off secondary screen scroll (default enabled). If this	1125	Turn on/off secondary screen scroll (default enabled). If this
1056	option is enabled, scrolls on the secondary screen will change the	1126	option is enabled, scrolls on the secondary screen will change the
1057	scrollback buffer and switching to/from the secondary screen will	1127	scrollback buffer and, when secondaryScreen is off, switching
1058	instead scroll the screen up.	1128	to/from the secondary screen will instead scroll the screen up.
1059		1129
1060	=item B<hold>: I<boolean>	1130	=item B<hold>: I<boolean>
1061		1131
1062	Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@	1132	Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@
1063	will not immediately destroy its window when the program executed within	1133	will not immediately destroy its window when the program executed within
1064	it exits. Instead, it will wait till it is being killed or closed by the	1134	it exits. Instead, it will wait till it is being killed or closed by the
1065	user.	1135	user.
		1136
		1137	=item B<chdir>: I<path>
		1138
		1139	Sets the working directory for the shell (or the command specified via
		1140	B<-e>). The I<path> must be an absolute path and it must exist for
		1141	@@RXVT_NAME@@ to start. If it isn't specified then the current working
		1142	directory will be used; option B<-cd>.
1066		1143
1067	=item B<keysym.>I<sym>: I<string>	1144	=item B<keysym.>I<sym>: I<string>
1068		1145
1069	Compile I<frills>: Associate I<string> with keysym I<sym>. The	1146	Compile I<frills>: Associate I<string> with keysym I<sym>. The
1070	intervening resource name B<keysym.> cannot be omitted.	1147	intervening resource name B<keysym.> cannot be omitted.
…		…
1084	searching keysym macros from B</usr/X11R6/include/X11/keysymdef.h> and	1161	searching keysym macros from B</usr/X11R6/include/X11/keysymdef.h> and
1085	omitting the prefix B<XK_>. Alternatively you can specify I<key> by its hex	1162	omitting the prefix B<XK_>. Alternatively you can specify I<key> by its hex
1086	keysym value (B<0x0000 - 0xFFFF>). Note that the lookup of I<sym>s is not	1163	keysym value (B<0x0000 - 0xFFFF>). Note that the lookup of I<sym>s is not
1087	performed in an exact manner; however, the closest match is assured.	1164	performed in an exact manner; however, the closest match is assured.
1088		1165
1089	I<string> may contain escape values (C<\a>: bell, C<\b>: backspace,	1166	I<string> may contain escape values (C<\n>: newline, C<\000>: octal
1090	C<\e>, C<\E>: escape, C<\n>: newline, C<\r>: carriage return, C<\t>: tab,	1167	number), see RESOURCES in C<man 7 X> for further details.
1091	C<\000>: octal number) or verbatim control characters (C<^?>: delete,
1092	C<^@>: null, C<^A> ...) and may be enclosed with double quotes so that it
1093	can start or end with whitespace. B<This feature is deprecated and will
1094	be removed>.
1095
1096	Please note that you need to double the C<\> in resource files, as
1097	Xlib itself does its own de-escaping (you can use C<\033> instead of
1098	C<\e> (and so on), which will work with both Xt and @@RXVT_NAME@@'s own
1099	processing).
1100		1168
1101	You can define a range of keysyms in one shot by providing a I<string>	1169	You can define a range of keysyms in one shot by providing a I<string>
1102	with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimiter `/'	1170	with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimiter `/'
1103	should be a character not used by the strings.	1171	should be a character not used by the strings.
1104		1172
…		…
1118	when Control-Meta-c is being pressed":	1186	when Control-Meta-c is being pressed":
1119		1187
1120	URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007	1188	URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007
1121		1189
1122	If I<string> takes the form C<perl:STRING>, then the specified B<STRING>	1190	If I<string> takes the form C<perl:STRING>, then the specified B<STRING>
1123	is passed to the C<on_keyboard_command> perl handler. See the @@RXVT_NAME@@perl(3)	1191	is passed to the C<on_user_command> perl handler. See the @@RXVT_NAME@@perl(3)
1124	manpage. For example, the F<selection> extension (activated via	1192	manpage. For example, the F<selection> extension (activated via
1125	C<@@RXVT_NAME@@ -pe selection>) listens for C<selection:rot13> events:	1193	C<@@RXVT_NAME@@ -pe selection>) listens for C<selection:rot13> events:
1126		1194
1127	URxvt.keysym.M-C-c: perl:selection:rot13	1195	URxvt.keysym.M-C-c: perl:selection:rot13
1128		1196
1129	Due the the large number of modifier combinations, a defined key mapping	1197	Due the the large number of modifier combinations, a defined key mapping
1130	will match if at I<at least> the specified identifiers are being set, and	1198	will match if I<at least> the specified identifiers are being set, and
1131	no other key mappings with those and more bits are being defined. That	1199	no other key mappings with those and more bits are being defined. That
1132	means that defining a key map for C<a> will automatically provide	1200	means that defining a key map for C<a> will automatically provide
1133	definitions for C<Meta-a>, C<Shift-a> and so on, unless some of those are defined	1201	definitions for C<Meta-a>, C<Shift-a> and so on, unless some of those are defined
1134	mappings themselves.	1202	mappings themselves.
1135		1203
…		…
1186	all instances, while B<perl-ext> is used for specific instances.	1254	all instances, while B<perl-ext> is used for specific instances.
1187		1255
1188	=item B<perl-eval>: I<string>	1256	=item B<perl-eval>: I<string>
1189		1257
1190	Perl code to be evaluated when all extensions have been registered. See	1258	Perl code to be evaluated when all extensions have been registered. See
1191	the @@RXVT_NAME@@perl(3) manpage. Due to security reasons, this resource	1259	the @@RXVT_NAME@@perl(3) manpage.
1192	will be ignored when running setuid/setgid.
1193		1260
1194	=item B<perl-lib>: I<path>	1261	=item B<perl-lib>: I<path>
1195		1262
1196	Colon-separated list of additional directories that hold extension	1263	Colon-separated list of additional directories that hold extension
1197	scripts. When looking for extensions specified by the C<perl> resource,	1264	scripts. When looking for extensions specified by the C<perl> resource,
1198	@@RXVT_NAME@@ will first look in these directories and then in	1265	@@RXVT_NAME@@ will first look in these directories and then in
1199	F<@@RXVT_LIBDIR@@/urxvt/perl/>. Due to security reasons, this resource	1266	F<@@RXVT_LIBDIR@@/urxvt/perl/>.
1200	will be ignored when running setuid/setgid.
1201		1267
1202	See the @@RXVT_NAME@@perl(3) manpage.	1268	See the @@RXVT_NAME@@perl(3) manpage.
1203		1269
1204	=item B<< selection.pattern-I<idx> >>: I<perl-regex>	1270	=item B<< selection.pattern-I<idx> >>: I<perl-regex>
1205		1271
…		…
1227		1293
1228	=item B<override-redirect>: I<boolean>	1294	=item B<override-redirect>: I<boolean>
1229		1295
1230	Compile I<frills>: Sets override-redirect for the terminal window, making	1296	Compile I<frills>: Sets override-redirect for the terminal window, making
1231	it almost invisible to window managers; option B<-override-redirect>.	1297	it almost invisible to window managers; option B<-override-redirect>.
		1298
		1299	=item B<iso14755:> I<boolean>
		1300
		1301	Turn on/off ISO 14755 (default enabled).
1232		1302
1233	=item B<iso14755_52:> I<boolean>	1303	=item B<iso14755_52:> I<boolean>
1234		1304
1235	Turn on/off ISO 14755 5.2 mode (default enabled).	1305	Turn on/off ISO 14755 5.2 mode (default enabled).
1236		1306
…		…
1379	B<@@RXVT_NAME@@> tries to write an entry into the I<utmp>(5) file so that	1449	B<@@RXVT_NAME@@> tries to write an entry into the I<utmp>(5) file so that
1380	it can be seen via the I<who(1)> command, and can accept messages. To	1450	it can be seen via the I<who(1)> command, and can accept messages. To
1381	allow this feature, B<@@RXVT_NAME@@> may need to be installed setuid root	1451	allow this feature, B<@@RXVT_NAME@@> may need to be installed setuid root
1382	on some systems or setgid to root or to some other group on others.	1452	on some systems or setgid to root or to some other group on others.
1383		1453
1384	=head1 COLORS AND GRAPHICS	1454	=head1 COLOURS AND GRAPHICS
1385		1455
1386	In addition to the default foreground and background colours,	1456	In addition to the default foreground and background colours,
1387	B<@@RXVT_NAME@@> can display up to 16 colours (8 ANSI colours plus	1457	B<@@RXVT_NAME@@> can display up to 88/256 colours: 8 ANSI colours plus
1388	high-intensity bold/blink versions of the same). Here is a list of the	1458	high-intensity (potentially bold/blink) versions of the same, and 72 (or
1389	colours with their names.	1459	240 in 256 colour mode) colours arranged in an 4x4x4 (or 6x6x6) colour RGB
		1460	cube plus a 8 (24) colour greyscale ramp.
		1461
		1462	Here is a list of the ANSI colours with their names.
1390		1463
1391	=begin table	1464	=begin table
1392		1465
1393	B<color0> (black) = Black	1466	B<color0> (black) = Black
1394	B<color1> (red) = Red3	1467	B<color1> (red) = Red3
…		…
1414	It is also possible to specify the colour values of B<foreground>,	1487	It is also possible to specify the colour values of B<foreground>,
1415	B<background>, B<cursorColor>, B<cursorColor2>, B<colorBD>, B<colorUL> as	1488	B<background>, B<cursorColor>, B<cursorColor2>, B<colorBD>, B<colorUL> as
1416	a number 0-15, as a convenient shorthand to reference the colour name of	1489	a number 0-15, as a convenient shorthand to reference the colour name of
1417	color0-color15.	1490	color0-color15.
1418		1491
1419	In addition to the colours defined above, @@RXVT_NAME@@ offers an	1492	The following text gives values for the standard 88 colour mode (and
1420	additional 72 colours. The first 64 of those (with indices 16 to 79)	1493	values for the 256 colour mode in parentheses).
1421	consist of a 444 RGB colour cube (i.e. I<index = r * 16 + g * 4 + b +
1422	16>), followed by 8 additional shades of gray (with indices 80 to 87).
1423		1494
		1495	The RGB cube uses indices 16..79 (16..231) using the following formulas:
		1496
		1497	index_88 = (r * 4 + g) * 4 + b + 16 # r, g, b = 0..3
		1498	index_256 = (r * 16 + g) * 16 + b + 16 # r, g, b = 0..15
		1499
		1500	The grayscale ramp uses indices 80..87 (232..239), from 10% to 90% in 10%
		1501	steps (1/26 to 25/26 in 1/26 steps) - black and white are already part of
		1502	the RGB cube.
		1503
1424	Together, all those colours implement the 88 colour xterm colours. Only	1504	Together, all those colours implement the 88 (256) colour xterm
1425	the first 16 can be changed using resources currently, the rest can only	1505	colours. Only the first 16 can be changed using resources currently, the
1426	be changed via command sequences ("escape codes").	1506	rest can only be changed via command sequences ("escape codes").
		1507
		1508	Applications are advised to use terminfo or command sequences to discover
		1509	number and RGB values of all colours (yes, you can query this...).
1427		1510
1428	Note that B<-rv> (B<"reverseVideo: True">) simulates reverse video by	1511	Note that B<-rv> (B<"reverseVideo: True">) simulates reverse video by
1429	always swapping the foreground/background colours. This is in contrast to	1512	always swapping the foreground/background colours. This is in contrast to
1430	I<xterm>(1) where the colours are only swapped if they have not otherwise	1513	I<xterm>(1) where the colours are only swapped if they have not otherwise
1431	been specified. For example,	1514	been specified. For example,
1432		1515
1433	=over 4
1434
1435	=item B<@@RXVT_NAME@@ -fg Black -bg White -rv>	1516	@@RXVT_NAME@@ -fg Black -bg White -rv
1436		1517
1437	would yield White on Black, while on I<xterm>(1) it would yield Black	1518	would yield White on Black, while on I<xterm>(1) it would yield Black on
1438	on White.	1519	White.
1439
1440	=back
1441		1520
1442	=head2 ALPHA CHANNEL SUPPORT	1521	=head2 ALPHA CHANNEL SUPPORT
1443		1522
1444	If Xft support has been compiled in and as long as Xft/Xrender/X don't get	1523	If Xft support has been compiled in and as long as Xft/Xrender/X don't get
1445	their act together, rxvt-unicode will support C<rgba:rrrr/gggg/bbbb/aaaa>	1524	their act together, rxvt-unicode will do it's own alpha channel management:
1446	(recommended, but B<MUST> have 4 digits/component) colour specifications,	1525
1447	in addition to the ones provided by X, where the additional A component	1526	You can prefix any colour with an opaqueness percentage enclosed in
		1527	brackets, i.e. C<[percent]>, where C<percent> is a decimal percentage
		1528	(0-100) that specifies the opacity of the colour, where C<0> is completely
		1529	transparent and C<100> is completely opaque. For example, C<[50]red> is a
		1530	half-transparent red, while C<[95]#00ff00> is an almost opaque green. This
		1531	is the recommended format to specify transparency values, and works with
		1532	all ways to specify a colour.
		1533
		1534	For complete control, rxvt-unicode also supports
		1535	C<rgba:rrrr/gggg/bbbb/aaaa> (exactly four hex digits/component) colour
		1536	specifications, where the additional C<aaaa> component specifies opacity
1448	specifies opacity (alpha) values. The minimum value of C<0> is completely	1537	(alpha) values. The minimum value of C<0000> is completely transparent,
1449	transparent). You can also prefix any color with C<[percent]>, where	1538	while C<ffff> is completely opaque). The two example colours from
1450	C<percent> is a decimal percentage (0-100) that specifies the opacity of	1539	earlier could also be specified as C<rgba:ff00/0000/0000/8000> and
1451	the color, where C<0> is completely transparent and C<100> is completelxy	1540	C<rgba:0000/ff00/0000/f332>.
1452	opaque.
1453		1541
1454	You probably need to specify B<"-depth 32">, too, and have the luck that	1542	You probably need to specify B<"-depth 32">, too, to force a visual with
1455	your X-server uses ARGB pixel layout, as X is far from just supporting	1543	alpha channels, and have the luck that your X-server uses ARGB pixel
1456	ARGB visuals out of the box, and rxvt-unicode just fudges around.	1544	layout, as X is far from just supporting ARGB visuals out of the box, and
		1545	rxvt-unicode just fudges around.
1457		1546
1458	For example, the following selects an almost completely transparent red	1547	For example, the following selects an almost completely transparent black
1459	background, and an almost opaque pink foreground:	1548	background, and an almost opaque pink foreground:
1460		1549
1461	@@RXVT_NAME@@ -depth 32 -bg rgba:0000/0000/0000/aaaa -fg "[80]pink"	1550	@@RXVT_NAME@@ -depth 32 -bg rgba:0000/0000/0000/4444 -fg "[80]pink"
1462		1551
1463	I<Please note that transparency of any kind if completely unsupported by	1552	When not using a background image, then the interpretation of the
1464	the author. Don't bug him with installation questions!>	1553	alpha channel is up to your compositing manager (most interpret it as
		1554	transparency of course).
		1555
		1556	When using a background pixmap or pseudo-transparency, then the background
		1557	colour will always behave as if it were completely transparent (so the
		1558	background image shows instead), regardless of how it was specified, while
		1559	other colours will either be transparent as specified (the background
		1560	image will show through) on servers supporting the RENDER extension, or
		1561	fully opaque on servers not supporting the RENDER EXTENSION.
		1562
		1563	Please note that due to bugs in Xft, specifying alpha values might result
		1564	in garbage being displayed when the X-server does not support the RENDER
		1565	extension.
1465		1566
1466	=head1 ENVIRONMENT	1567	=head1 ENVIRONMENT
1467		1568
1468	B<@@RXVT_NAME@@> sets and/or uses the following environment variables:	1569	B<@@RXVT_NAME@@> sets and/or uses the following environment variables:
1469		1570
…		…
1475	resources or on the command line.	1576	resources or on the command line.
1476		1577
1477	=item B<COLORTERM>	1578	=item B<COLORTERM>
1478		1579
1479	Either C<rxvt>, C<rxvt-xpm>, depending on whether @@RXVT_NAME@@ was	1580	Either C<rxvt>, C<rxvt-xpm>, depending on whether @@RXVT_NAME@@ was
1480	compiled with XPM support, and optionally with the added extension	1581	compiled with background image support, and optionally with the added
1481	C<-mono> to indicate that rxvt-unicode runs on a monochrome screen.	1582	extension C<-mono> to indicate that rxvt-unicode runs on a monochrome
		1583	screen.
1482		1584
1483	=item B<COLORFGBG>	1585	=item B<COLORFGBG>
1484		1586
1485	Set to a string of the form C<fg;bg> or C<fg;xpm;bg>, where C<fg> is	1587	Set to a string of the form C<fg;bg> or C<fg;xpm;bg>, where C<fg> is
1486	the colour code used as default foreground/text colour (or the string	1588	the colour code used as default foreground/text colour (or the string
1487	C<default> to indicate that the default-colour escape sequence is to be	1589	C<default> to indicate that the default-colour escape sequence is to be
1488	used), C<bg> is the colour code used as default background colour (or the	1590	used), C<bg> is the colour code used as default background colour (or the
1489	string C<default>), and C<xpm> is the string C<default> if @@RXVT_NAME@@	1591	string C<default>), and C<xpm> is the string C<default> if @@RXVT_NAME@@
1490	was compiled with XPM support. Libraries like C<ncurses> and C<slang> can	1592	was compiled with background image support. Libraries like C<ncurses>
1491	(and do) use this information to optimize screen output.	1593	and C<slang> can (and do) use this information to optimize screen output.
1492		1594
1493	=item B<WINDOWID>	1595	=item B<WINDOWID>
1494		1596
1495	Set to the (decimal) X Window ID of the @@RXVT_NAME@@ window (the toplevel	1597	Set to the (decimal) X Window ID of the @@RXVT_NAME@@ window (the toplevel
1496	window, which usually has subwindows for the scrollbar, the terminal	1598	window, which usually has subwindows for the scrollbar, the terminal
…		…
1502	C<--with-terminfo=PATH>.	1604	C<--with-terminfo=PATH>.
1503		1605
1504	=item B<DISPLAY>	1606	=item B<DISPLAY>
1505		1607
1506	Used by @@RXVT_NAME@@ to connect to the display and set to the correct	1608	Used by @@RXVT_NAME@@ to connect to the display and set to the correct
1507	display in its child processes.	1609	display in its child processes if C<-display> isn't used to override. It
		1610	defaults to C<:0> if it doesn't exist.
1508		1611
1509	=item B<SHELL>	1612	=item B<SHELL>
1510		1613
1511	The shell to be used for command execution, defaults to C</bin/sh>.	1614	The shell to be used for command execution, defaults to C</bin/sh>.
1512		1615
…		…
1538		1641
1539	=over 4	1642	=over 4
1540		1643
1541	=item B</usr/lib/X11/rgb.txt>	1644	=item B</usr/lib/X11/rgb.txt>
1542		1645
1543	Color names.	1646	Colour names.
1544		1647
1545	=back	1648	=back
1546		1649
1547	=head1 SEE ALSO	1650	=head1 SEE ALSO
1548		1651
…		…
1587	Project Coordinator (changes.txt 2.21a to 2.4.5)	1690	Project Coordinator (changes.txt 2.21a to 2.4.5)
1588		1691
1589	=item Geoff Wing L<< <gcw@pobox.com> >>	1692	=item Geoff Wing L<< <gcw@pobox.com> >>
1590		1693
1591	Rewrote screen display and text selection routines.	1694	Rewrote screen display and text selection routines.
1592		1695
1593	Project Coordinator (changes.txt 2.4.6 - rxvt-unicode)	1696	Project Coordinator (changes.txt 2.4.6 - rxvt-unicode)
1594		1697
1595	=item Marc Alexander Lehmann L<< <rxvt-unicode@schmorp.de> >>	1698	=item Marc Alexander Lehmann L<< <rxvt-unicode@schmorp.de> >>
1596		1699
1597	Forked rxvt-unicode, unicode support, rewrote almost all the code, perl	1700	Forked rxvt-unicode, unicode support, rewrote almost all the code, perl

Diff Legend

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

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents): Revision 1.136 by root, Mon Aug 13 10:01:18 2007 UTC vs. Revision 1.187 by sf-exg, Fri Oct 15 10:46:57 2010 UTC

Diff Legend

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents):
Revision 1.136 by root, Mon Aug 13 10:01:18 2007 UTC vs.
Revision 1.187 by sf-exg, Fri Oct 15 10:46:57 2010 UTC