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

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents):
Revision 1.140 by sasha, Fri Oct 26 18:27:29 2007 UTC vs.
Revision 1.215 by sf-exg, Sun May 20 16:34:42 2012 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; resource
151	I<tintColor>. Example:
152
153	@@RXVT_NAME@@ -tr -tint blue -sh 40
154		149
155	=item B<-sh> I<number>	150	=item B<-sh> I<number>
156		151
157	Darken (0 .. 100) or lighten (-1 .. -100) the transparent	152	Darken (0 .. 99) or lighten (101 .. 200) the transparent background.
158	background image in addition to (or instead of) tinting it;	153	A value of 100 means no shading; resource I<shading>.
159	resource I<shading>.
160
161	=item B<-blt> I<string>
162
163	Specify background blending type. If background pixmap is specified
164	at the same time as transparency - such pixmap will be blended over
165	transparency image, using method specified. Supported values are :
166	B<add>, B<alphablend>, B<allanon> - color values averaging, B<colorize>,
167	B<darken>, B<diff>, B<dissipate>, B<hue>, B<lighten>, B<overlay>,
168	B<saturate>, B<screen>, B<sub>, B<tint>, B<value>. The default is
169	alpha-blending. Compile I<afterimage>; resource I<blendType>.
170		154
171	=item B<-blr> I<HxV>	155	=item B<-blr> I<HxV>
172		156
173	Apply Gaussian Blur with the specified radii to the transparent	157	Apply Gaussian Blur with the specified radii to the transparent
174	background image. If single number is specified - both vertical and	158	background. If a single number is specified, the vertical and
175	horizontal radii are considered to be the same. Setting one of the	159	horizontal radii are considered to be the same. Setting one of the
176	radii to 1 and another to a large number creates interesting effects	160	radii to 1 and the other to a large number creates interesting effects
177	on some backgrounds. Maximum radius value is 128. Compile I<afterimage>;	161	on some backgrounds. The maximum radius value is 128. An horizontal or
		162	vertical radius of 0 disables blurring;
178	resource I<blurRadius>.	163	resource I<blurRadius>.
179		164
		165	=item B<-icon> I<file>
		166
		167	Compile I<pixbuf>: Use the specified image as application icon. This
		168	is used by many window managers, taskbars and pagers to represent the
		169	application window; resource I<iconFile>.
		170
180	=item B<-bg> I<colour>	171	=item B<-bg> I<colour>
181		172
182	Window background colour; resource B<background>.	173	Window background colour; resource B<background>.
183		174
184	=item B<-fg> I<colour>	175	=item B<-fg> I<colour>
185		176
186	Window foreground colour; resource B<foreground>.	177	Window foreground colour; resource B<foreground>.
187		178
188	=item B<-pixmap> I<file[;geom]>	179	=item B<-pixmap> I<file[;oplist]>
189		180
190	Compile I<afterimage>: Specify image file for the background and also	181	Compile I<pixbuf>: Specify image file for the background and also
191	optionally specify its scaling with a geometry string. Note you may need to	182	optionally specify a list of operations to modify it. Note you may need to
192	add quotes to avoid special shell interpretation of the C<;> in the	183	add quotes to avoid special shell interpretation of the C<;> in the
193	command-line; for more details see resource B<backgroundPixmap>.	184	command-line; for more details see resource B<backgroundPixmap>.
194		185
195	=item B<-cr> I<colour>	186	=item B<-cr> I<colour>
196		187
…		…
243	italic> >> characters are to be printed. See resource B<boldItalicFont>	234	italic> >> characters are to be printed. See resource B<boldItalicFont>
244	for details.	235	for details.
245		236
246	=item B<-is>\|B<+is>	237	=item B<-is>\|B<+is>
247		238
248	Compile I<font-styles>: Bold/Italic font styles imply high intensity	239	Compile I<font-styles>: Bold/Blink font styles imply high intensity
249	foreground/background (default). See resource B<intensityStyles> for	240	foreground/background (default). See resource B<intensityStyles> for
250	details.	241	details.
251		242
252	=item B<-name> I<name>	243	=item B<-name> I<name>
253		244
…		…
271		262
272	=item B<-sb>\|B<+sb>	263	=item B<-sb>\|B<+sb>
273		264
274	Turn on/off scrollbar; resource B<scrollBar>.	265	Turn on/off scrollbar; resource B<scrollBar>.
275		266
		267	=item B<-sr>\|B<+sr>
		268
		269	Put scrollbar on right/left; resource B<scrollBar_right>.
		270
		271	=item B<-st>\|B<+st>
		272
		273	Display rxvt (non XTerm/NeXT) scrollbar without/with a trough;
		274	resource B<scrollBar_floating>.
		275
276	=item B<-si>\|B<+si>	276	=item B<-si>\|B<+si>
277		277
278	Turn on/off scroll-to-bottom on TTY output inhibit; resource	278	Turn on/off scroll-to-bottom on TTY output inhibit; resource
279	B<scrollTtyOutput> has opposite effect.	279	B<scrollTtyOutput> has opposite effect.
280		280
…		…
286	=item B<-sw>\|B<+sw>	286	=item B<-sw>\|B<+sw>
287		287
288	Turn on/off scrolling with the scrollback buffer as new lines appear.	288	Turn on/off scrolling with the scrollback buffer as new lines appear.
289	This only takes effect if B<-si> is also given; resource	289	This only takes effect if B<-si> is also given; resource
290	B<scrollWithBuffer>.	290	B<scrollWithBuffer>.
291
292	=item B<-sr>\|B<+sr>
293
294	Put scrollbar on right/left; resource B<scrollBar_right>.
295
296	=item B<-st>\|B<+st>
297
298	Display rxvt (non XTerm/NeXT) scrollbar without/with a trough;
299	resource B<scrollBar_floating>.
300		291
301	=item B<-ptab>\|B<+ptab>	292	=item B<-ptab>\|B<+ptab>
302		293
303	If enabled (default), "Horizontal Tab" characters are being stored as	294	If enabled (default), "Horizontal Tab" characters are being stored as
304	actual wide characters in the screen buffer, which makes it possible to	295	actual wide characters in the screen buffer, which makes it possible to
…		…
308		299
309	=item B<-bc>\|B<+bc>	300	=item B<-bc>\|B<+bc>
310		301
311	Blink the cursor; resource B<cursorBlink>.	302	Blink the cursor; resource B<cursorBlink>.
312		303
		304	=item B<-uc>\|B<+uc>
		305
		306	Make the cursor underlined; resource B<cursorUnderline>.
		307
313	=item B<-iconic>	308	=item B<-iconic>
314		309
315	Start iconified, if the window manager supports that option.	310	Start iconified, if the window manager supports that option.
316	Alternative form is B<-ic>.	311	Alternative form is B<-ic>.
317		312
…		…
333		328
334	=item B<-bl>	329	=item B<-bl>
335		330
336	Compile I<frills>: Set MWM hints to request a borderless window, i.e.	331	Compile I<frills>: Set MWM hints to request a borderless window, i.e.
337	if honoured by the WM, the rxvt-unicode window will not have window	332	if honoured by the WM, the rxvt-unicode window will not have window
338	decorations; resource B<borderLess>.	333	decorations; resource B<borderLess>. If the window manager does not
		334	support MWM hints (e.g. kwin), enables override-redirect mode.
339		335
340	=item B<-override-redirect>	336	=item B<-override-redirect>
341		337
342	Compile I<frills>: Sets override-redirect on the window; resource	338	Compile I<frills>: Sets override-redirect on the window; resource
343	B<override-redirect>.	339	B<override-redirect>.
…		…
352	=item B<-lsp> I<number>	348	=item B<-lsp> I<number>
353		349
354	Compile I<frills>: Lines (pixel height) to insert between each row of	350	Compile I<frills>: Lines (pixel height) to insert between each row of
355	the display. Useful to work around font rendering problems; resource	351	the display. Useful to work around font rendering problems; resource
356	B<lineSpace>.	352	B<lineSpace>.
		353
		354	=item B<-letsp> I<number>
		355
		356	Compile I<frills>: Amount to adjust the computed character width by
		357	to control overall letter spacing. Negative values will tighten up the
		358	letter spacing, positive values will space letters out more. Useful to
		359	work around odd font metrics; resource B<letterSpace>.
357		360
358	=item B<-tn> I<termname>	361	=item B<-tn> I<termname>
359		362
360	This option specifies the name of the terminal type to be set in the	363	This option specifies the name of the terminal type to be set in the
361	B<TERM> environment variable. This terminal type must exist in the	364	B<TERM> environment variable. This terminal type must exist in the
…		…
416		419
417	=item B<-tcw>	420	=item B<-tcw>
418		421
419	Change the meaning of triple-click selection with the left mouse	422	Change the meaning of triple-click selection with the left mouse
420	button. Only effective when the original (non-perl) selection code is	423	button. Only effective when the original (non-perl) selection code is
421	in-use. Instead of selecting a full line it will extend the selection the	424	in-use. Instead of selecting a full line it will extend the selection to
422	end of the logical line only. resource B<tripleclickwords>.	425	the end of the logical line only. resource B<tripleclickwords>.
423		426
424	=item B<-insecure>	427	=item B<-insecure>
425		428
426	Enable "insecure" mode, which currently enables most of the escape	429	Enable "insecure" mode, which currently enables most of the escape
427	sequences that echo strings. See the resource B<insecure> for more	430	sequences that echo strings. See the resource B<insecure> for more
…		…
447		450
448	Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@	451	Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@
449	will not immediately destroy its window when the program executed within	452	will not immediately destroy its window when the program executed within
450	it exits. Instead, it will wait till it is being killed or closed by the	453	it exits. Instead, it will wait till it is being killed or closed by the
451	user; resource B<hold>.	454	user; resource B<hold>.
		455
		456	=item B<-cd> I<path>
		457
		458	Sets the working directory for the shell (or the command specified via
		459	B<-e>). The I<path> must be an absolute path and it must exist for
		460	@@RXVT_NAME@@ to start; resource B<chdir>.
		461
		462	=item B<-xrm> I<string>
		463
		464	Works like the X Toolkit option of the same name, by adding the I<string>
		465	as if it were specified in a resource file. Resource values specified this
		466	way take precedence over all other resource specifications.
		467
		468	Note that you need to use the I<same> syntax as in the .Xdefaults file,
		469	e.g. C<*.background: black>. Also note that all @@RXVT_NAME@@-specific
		470	options can be specified as long-options on the commandline, so use
		471	of B<-xrm> is mostly limited to cases where you want to specify other
		472	resources (e.g. for input methods) or for compatibility with other
		473	programs.
452		474
453	=item B<-keysym.>I<sym> I<string>	475	=item B<-keysym.>I<sym> I<string>
454		476
455	Remap a key symbol. See resource B<keysym>.	477	Remap a key symbol. See resource B<keysym>.
456		478
…		…
491	If this switch is given, @@RXVT_NAME@@ will not create any utmp/wtmp	513	If this switch is given, @@RXVT_NAME@@ will not create any utmp/wtmp
492	entries and will not tinker with pty/tty permissions - you have to do that	514	entries and will not tinker with pty/tty permissions - you have to do that
493	yourself if you want that.	515	yourself if you want that.
494		516
495	As an extremely special case, specifying C<-1> will completely suppress	517	As an extremely special case, specifying C<-1> will completely suppress
496	pty/tty operations.	518	pty/tty operations, which is probably only useful in conjunction with some
		519	perl extension that manages the terminal.
497		520
498	Here is a example in perl that illustrates how this option can be used (a	521	Here is a example in perl that illustrates how this option can be used (a
499	longer example is in F<doc/pty-fd>):	522	longer example is in F<doc/pty-fd>):
500		523
501	use IO::Pty;	524	use IO::Pty;
…		…
515	Comma-separated list of perl extension scripts to use (or not to use) in	538	Comma-separated list of perl extension scripts to use (or not to use) in
516	this terminal instance. See resource B<perl-ext> for details.	539	this terminal instance. See resource B<perl-ext> for details.
517		540
518	=back	541	=back
519		542
520	=head1 RESOURCES (available also as long-options)	543	=head1 RESOURCES
521		544
522	Note: `@@RXVT_NAME@@ --help' gives a list of all resources (long	545	Note: `@@RXVT_NAME@@ --help' gives a list of all resources (long
523	options) compiled into your version.	546	options) compiled into your version. All resources are also available as
		547	long-options.
524		548
525	You can set and change the resources using X11 tools like B<xrdb>. Many	549	You can set and change the resources using X11 tools like B<xrdb>. Many
526	distribution do also load settings from the B<~/.Xresources> file when X	550	distribution do also load settings from the B<~/.Xresources> file when X
527	starts. @@RXVT_NAME@@ will consult the following files/resources in order,	551	starts. @@RXVT_NAME@@ will consult the following files/resources in order,
528	with later settings overwriting earlier ones:	552	with later settings overwriting earlier ones:
529		553
530	1. system-wide app-defaults file, either locale-dependent OR global
531	2. app-defaults file in $XAPPLRESDIR	554	1. app-defaults file in $XAPPLRESDIR
		555	2. $HOME/.Xdefaults
532	3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults	556	3. RESOURCE_MANAGER property on root-window of screen 0
533	4. SCREEN_RESOURCES for the current screen	557	4. SCREEN_RESOURCES property on root-window of the current screen
534	5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename>	558	5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename>
		559	6. resources specified via -xrm on the commandline
535		560
536	Note that when reading X resources, B<@@RXVT_NAME@@> recognizes two class	561	Note that when reading X resources, B<@@RXVT_NAME@@> recognizes two class
537	names: B<Rxvt> and B<URxvt>. The class name B<Rxvt> allows resources	562	names: B<Rxvt> and B<URxvt>. The class name B<Rxvt> allows resources
538	common to both B<@@RXVT_NAME@@> and the original I<rxvt> to be easily	563	common to both B<@@RXVT_NAME@@> and the original I<rxvt> to be easily
539	configured, while the class name B<URxvt> allows resources unique to	564	configured, while the class name B<URxvt> allows resources unique to
…		…
549	=item B<depth:> I<bitdepth>	574	=item B<depth:> I<bitdepth>
550		575
551	Compile I<xft>: Attempt to find a visual with the given bit depth;	576	Compile I<xft>: Attempt to find a visual with the given bit depth;
552	option B<-depth>.	577	option B<-depth>.
553		578
		579	=item B<buffered:> I<boolean>
		580
		581	Compile I<xft>: Turn on/off double-buffering for xft (default enabled).
		582	On some card/driver combination enabling it slightly decreases
		583	performance, on most it greatly helps it. The slowdown is small, so it
		584	should normally be enabled.
		585
554	=item B<geometry:> I<geom>	586	=item B<geometry:> I<geom>
555		587
556	Create the window with the specified X window geometry [default 80x24];	588	Create the window with the specified X window geometry [default 80x24];
557	option B<-geometry>.	589	option B<-geometry>.
558		590
…		…
571	Use the specified colour for the colour value I<n>, where 0-7	603	Use the specified colour for the colour value I<n>, where 0-7
572	corresponds to low-intensity (normal) colours and 8-15 corresponds to	604	corresponds to low-intensity (normal) colours and 8-15 corresponds to
573	high-intensity (bold = bright foreground, blink = bright background)	605	high-intensity (bold = bright foreground, blink = bright background)
574	colours. The canonical names are as follows: 0=black, 1=red, 2=green,	606	colours. The canonical names are as follows: 0=black, 1=red, 2=green,
575	3=yellow, 4=blue, 5=magenta, 6=cyan, 7=white, but the actual colour	607	3=yellow, 4=blue, 5=magenta, 6=cyan, 7=white, but the actual colour
576	names used are listed in the B<COLORS AND GRAPHICS> section.	608	names used are listed in the B<COLOURS AND GRAPHICS> section.
577		609
578	Colours higher than 15 cannot be set using resources (yet), but can be	610	Colours higher than 15 cannot be set using resources (yet), but can be
579	changed using an escape command (see @@RXVT_NAME@@(7)).	611	changed using an escape command (see @@RXVT_NAME@@(7)).
580		612
581	Colours 16-79 form a standard 4x4x4 colour cube (the same as xterm with	613	Colours 16-79 form a standard 4x4x4 colour cube (the same as xterm with
…		…
592	=item B<colorUL:> I<colour>	624	=item B<colorUL:> I<colour>
593		625
594	Use the specified colour to display underlined characters when the	626	Use the specified colour to display underlined characters when the
595	foreground colour is the default.	627	foreground colour is the default.
596		628
597	=item B<colorRV:> I<colour>
598
599	Use the specified colour as the background for reverse video characters
600	when OPTION_HC is disabled (--disable-frills).
601
602	=item B<underlineColor:> I<colour>	629	=item B<underlineColor:> I<colour>
603		630
604	If set, use the specified colour as the colour for the underline	631	If set, use the specified colour as the colour for the underline
605	itself. If unset, use the foreground colour.	632	itself. If unset, use the foreground colour.
		633
		634	=item B<highlightColor:> I<colour>
		635
		636	If set, use the specified colour as the background for highlighted
		637	characters. If unset, use reverse video.
		638
		639	=item B<highlightTextColor:> I<colour>
		640
		641	If set and highlightColor is set, use the specified colour as the
		642	foreground for highlighted characters.
606		643
607	=item B<cursorColor:> I<colour>	644	=item B<cursorColor:> I<colour>
608		645
609	Use the specified colour for the cursor. The default is to use the	646	Use the specified colour for the cursor. The default is to use the
610	foreground colour; option B<-cr>.	647	foreground colour; option B<-cr>.
…		…
617		654
618	=item B<reverseVideo:> I<boolean>	655	=item B<reverseVideo:> I<boolean>
619		656
620	B<True>: simulate reverse video by foreground and background colours;	657	B<True>: simulate reverse video by foreground and background colours;
621	option B<-rv>. B<False>: regular screen colours [default]; option	658	option B<-rv>. B<False>: regular screen colours [default]; option
622	B<+rv>. See note in B<COLORS AND GRAPHICS> section.	659	B<+rv>. See note in B<COLOURS AND GRAPHICS> section.
623		660
624	=item B<jumpScroll:> I<boolean>	661	=item B<jumpScroll:> I<boolean>
625		662
626	B<True>: specify that jump scrolling should be used. When receiving lots	663	B<True>: specify that jump scrolling should be used. When receiving lots
627	of lines, @@RXVT_NAME@@ will only scroll once a whole screen height of lines	664	of lines, @@RXVT_NAME@@ will only scroll once a whole screen height of lines
…		…
641		678
642	B<False>: specify that everything is to be displayed, even	679	B<False>: specify that everything is to be displayed, even
643	if the refresh is too fast for the human eye to read anything (or the	680	if the refresh is too fast for the human eye to read anything (or the
644	monitor to display anything); option B<+ss>.	681	monitor to display anything); option B<+ss>.
645		682
646	=item B<inheritPixmap:> I<boolean>	683	=item B<transparent:> I<boolean>
647		684
648	B<True>: make the background inherit the parent windows' pixmap, giving	685	Turn on/off pseudo-transparency by using the root pixmap as background.
649	artificial transparency. B<False>: do not inherit the parent windows'
650	pixmap.
651		686
652	I<Please note that transparency of any kind if completely unsupported by	687	B<inheritPixmap> is still accepted as an obsolete alias but will be removed in
653	the author. Don't bug him with installation questions!>	688	future versions.
654		689
655	=item B<fading:> I<number>	690	=item B<fading:> I<number>
656		691
657	Fade the text by the given percentage when focus is lost; option B<-fade>.	692	Fade the text by the given percentage when focus is lost; option B<-fade>.
658		693
…		…
661	Fade to this colour, when fading is used (see B<fading:>). The default	696	Fade to this colour, when fading is used (see B<fading:>). The default
662	colour is black; option B<-fadecolor>.	697	colour is black; option B<-fadecolor>.
663		698
664	=item B<tintColor:> I<colour>	699	=item B<tintColor:> I<colour>
665		700
666	Tint the transparent background pixmap with the given colour; option	701	Tint the transparent background with the given colour. If the RENDER
667	B<-tint>.	702	extension is not available only black, red, green, yellow, blue,
		703	magenta, cyan and white tints can be performed server-side. Note that
		704	a black tint yields a completely black image while a white tint yields
		705	the image unchanged; option B<-tint>.
668		706
669	=item B<shading:> I<number>	707	=item B<shading:> I<number>
670		708
671	Darken (0 .. 100) or lighten (-1 .. -100) the transparent background image	709	Darken (0 .. 99) or lighten (101 .. 200) the transparent background.
672	in addition to tinting it; option B<-sh>.	710	A value of 100 means no shading; option B<-sh>.
673
674	=item B<blendType:> I<string>
675
676	Specify background blending type; option B<-blt>.
677		711
678	=item B<blurRadius:> I<number>	712	=item B<blurRadius:> I<number>
679		713
680	Apply Gaussian Blurr with the specified radius to the transparent	714	Apply gaussian blur with the specified radius to the transparent
681	background image; option B<-blr>.	715	background; option B<-blr>.
		716
		717	=item B<iconFile:> I<file>
		718
		719	Set the application icon pixmap; option B<-icon>.
682		720
683	=item B<scrollColor:> I<colour>	721	=item B<scrollColor:> I<colour>
684		722
685	Use the specified colour for the scrollbar [default #B2B2B2].	723	Use the specified colour for the scrollbar [default #B2B2B2].
686		724
…		…
692	=item B<borderColor:> I<colour>	730	=item B<borderColor:> I<colour>
693		731
694	The colour of the border around the text area and between the scrollbar	732	The colour of the border around the text area and between the scrollbar
695	and the text.	733	and the text.
696		734
697	=item B<backgroundPixmap:> I<file[;geom]>	735	=item B<backgroundPixmap:> I<file[;oplist]>
698		736
699	Use the specified image file for the background and also optionally	737	Use the specified image file for the background and also
700	specify its scaling with a geometry string B<WxH+X+Y>,	738	optionally specify a colon separated list of operations to modify it.
701	in which B<"W" / "H"> specify the horizontal/vertical scale (percent),	739	Supported operations are:
		740
		741	=over 4
		742
		743	=item B<WxH+X+Y>
		744
		745	sets scale and position. B<"W" / "H"> specify the horizontal/vertical
702	and B<"X" / "Y"> locate the image centre (percent).	746	scale (percent), and B<"X" / "Y"> locate the image centre (percent). A
703	A scale of 0 displays the image with tiling. A scale of 1 displays the	747	scale of 0 disables scaling.
704	image without any scaling. A scale of 2 to 9 specifies an integer	748
705	number of images in that direction. No image will be magnified beyond	749	=item B<op=tile>
706	10 times its original size. The maximum permitted scale is 1000.	750
707	Special string of B<"auto"> used as a geometry will cause image to be	751	enables tiling
708	automatically scaled to match window size.	752
		753	=item B<op=keep-aspect>
		754
		755	maintain the image aspect ratio when scaling
		756
		757	=item B<op=root-align>
		758
		759	use the position of the terminal window relative to the root window as
		760	the image offset, simulating a root window background
		761
		762	=back
		763
		764	The default scale and position setting is C<100x100+50+50>.
		765	Alternatively, a predefined set of templates can be used to achieve
		766	the most common setups:
		767
		768	=over 4
		769
		770	=item B<style=tiled>
		771
		772	the image is tiled with no scaling. Equivalent to 0x0+0+0:op=tile
		773
		774	=item B<style=aspect-stretched>
		775
		776	the image is scaled to fill the whole window maintaining the aspect
		777	ratio and centered. Equivalent to 100x100+50+50:op=keep-aspect
		778
		779	=item B<style=stretched>
		780
		781	the image is scaled to fill the whole window. Equivalent to 100x100
		782
		783	=item B<style=centered>
		784
		785	the image is centered with no scaling. Equivalent to 0x0+50+50
		786
		787	=item B<style=root-tiled>
		788
		789	the image is tiled with no scaling and using 'root' positioning.
		790	Equivalent to 0x0:op=tile:op=root-align
		791
		792	=back
		793
		794	If multiple templates are specified the last one wins. Note that a
		795	template overrides all the scale, position and operations settings.
		796
709	If used in conjunction with B<-tr> option - specified pixmap will be	797	If used in conjunction with B<-tr> option, the specified pixmap will be
710	blended over transparency image using either alpha-blending, or any	798	blended over the transparent background using alpha-blending.
711	other blending type, specified with B<-blt "type"> option.
712	[default 0x0+50+50]
713		799
714	=item B<path:> I<path>	800	=item B<path:> I<path>
715		801
716	Specify the colon-delimited search path for finding background image files.	802	Specify the colon-delimited search path for finding background image files.
717		803
…		…
744	it is named first) and thus defines the character cell grid to be 9 pixels	830	it is named first) and thus defines the character cell grid to be 9 pixels
745	wide and 15 pixels high.	831	wide and 15 pixels high.
746		832
747	The second font is just used to add additional unicode characters not in	833	The second font is just used to add additional unicode characters not in
748	the base font, likewise the third, which is unfortunately non-bold, but	834	the base font, likewise the third, which is unfortunately non-bold, but
749	the bold version of the font does contain less characters, so this is a	835	the bold version of the font does contain fewer characters, so this is a
750	useful supplement.	836	useful supplement.
751		837
752	The third font is an Xft font with aliasing turned off, and the characters	838	The third font is an Xft font with aliasing turned off, and the characters
753	are limited to the B<JIS 0208> codeset (i.e. japanese kanji). The font	839	are limited to the B<JIS 0208> codeset (i.e. japanese kanji). The font
754	contains other characters, but we are not interested in them.	840	contains other characters, but we are not interested in them.
…		…
778	text font will being used for the given style.	864	text font will being used for the given style.
779		865
780	=item B<intensityStyles:> I<boolean>	866	=item B<intensityStyles:> I<boolean>
781		867
782	When font styles are not enabled, or this option is enabled (B<True>,	868	When font styles are not enabled, or this option is enabled (B<True>,
783	option B<-is>, the default), bold and italic font styles imply high	869	option B<-is>, the default), bold/blink font styles imply high
784	intensity foreground/background colours. Disabling this option (B<False>,	870	intensity foreground/background colours. Disabling this option (B<False>,
785	option B<+is>) disables this behaviour, the high intensity colours are not	871	option B<+is>) disables this behaviour, the high intensity colours are not
786	reachable.	872	reachable.
787		873
788	=item B<selectstyle:> I<mode>
789
790	Set mouse selection style to B<old> which is 2.20, B<oldword> which
791	is xterm style with 2.20 old word selection, or anything else which
792	gives xterm style selection. Only effective when the original (non-perl)
793	selection code is in use.
794
795	=item B<scrollstyle:> I<mode>
796
797	Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is
798	the author's favourite.
799
800	=item B<title:> I<string>	874	=item B<title:> I<string>
801		875
802	Set window title string, the default title is the command-line	876	Set window title string, the default title is the command-line
803	specified after the B<-e> option, if any, otherwise the application	877	specified after the B<-e> option, if any, otherwise the application
804	name; option B<-title>.	878	name; option B<-title>.
…		…
817	=item B<urgentOnBell:> I<boolean>	891	=item B<urgentOnBell:> I<boolean>
818		892
819	B<True>: set the urgency hint for the wm on receipt of a bell character.	893	B<True>: set the urgency hint for the wm on receipt of a bell character.
820	B<False>: do not set the urgency hint [default].	894	B<False>: do not set the urgency hint [default].
821		895
		896	@@RXVT_NAME@@ resets the urgency hint on every focus change.
		897
822	=item B<visualBell:> I<boolean>	898	=item B<visualBell:> I<boolean>
823		899
824	B<True>: use visual bell on receipt of a bell character; option B<-vb>.	900	B<True>: use visual bell on receipt of a bell character; option B<-vb>.
825	B<False>: no visual bell [default]; option B<+vb>.	901	B<False>: no visual bell [default]; option B<+vb>.
826		902
…		…
849	URxvt.print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX)	925	URxvt.print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX)
850		926
851	This creates a new file in your home directory with the screen contents	927	This creates a new file in your home directory with the screen contents
852	every time you hit C<Print>.	928	every time you hit C<Print>.
853		929
		930	=item B<scrollstyle:> I<mode>
		931
		932	Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is
		933	the author's favourite.
		934
		935	=item B<thickness:> I<number>
		936
		937	Set the scrollbar width in pixels.
		938
854	=item B<scrollBar:> I<boolean>	939	=item B<scrollBar:> I<boolean>
855		940
856	B<True>: enable the scrollbar [default]; option B<-sb>. B<False>:	941	B<True>: enable the scrollbar [default]; option B<-sb>. B<False>:
857	disable the scrollbar; option B<+sb>.	942	disable the scrollbar; option B<+sb>.
858		943
…		…
877	B<False>: do not scroll to bottom when tty receives output; option	962	B<False>: do not scroll to bottom when tty receives output; option
878	B<+si>.	963	B<+si>.
879		964
880	=item B<scrollWithBuffer:> I<boolean>	965	=item B<scrollWithBuffer:> I<boolean>
881		966
882	B<True>: scroll with scrollback buffer when tty receives new lines (and	967	B<True>: scroll with scrollback buffer when tty receives new lines (i.e.
883	B<scrollTtyOutput> is False); option B<-sw>. B<False>: do not scroll	968	try to show the same lines) and B<scrollTtyOutput> is False; option
884	with scrollback buffer when tty receives new lines; option B<+sw>.	969	B<-sw>. B<False>: do not scroll with scrollback buffer when tty receives
		970	new lines; option B<+sw>.
885		971
886	=item B<scrollTtyKeypress:> I<boolean>	972	=item B<scrollTtyKeypress:> I<boolean>
887		973
888	B<True>: scroll to bottom when a non-special key is pressed. Special keys	974	B<True>: scroll to bottom when a non-special key is pressed. Special keys
889	are those which are intercepted by rxvt-unicode for special handling and	975	are those which are intercepted by rxvt-unicode for special handling and
…		…
945	=item B<cursorBlink:> I<boolean>	1031	=item B<cursorBlink:> I<boolean>
946		1032
947	B<True>: blink the cursor. B<False>: do not blink the cursor [default];	1033	B<True>: blink the cursor. B<False>: do not blink the cursor [default];
948	option B<-bc>.	1034	option B<-bc>.
949		1035
		1036	=item B<cursorUnderline:> I<boolean>
		1037
		1038	B<True>: Make the cursor underlined. B<False>: Make the cursor a box [default];
		1039	option B<-uc>.
		1040
950	=item B<pointerBlank:> I<boolean>	1041	=item B<pointerBlank:> I<boolean>
951		1042
952	B<True>: blank the pointer when a key is pressed or after a set number	1043	B<True>: blank the pointer when a key is pressed or after a set number
953	of seconds of inactivity. B<False>: the pointer is always visible	1044	of seconds of inactivity. B<False>: the pointer is always visible
954	[default].	1045	[default].
…		…
967	large number (e.g. C<987654321>) to effectively disable the timeout.	1058	large number (e.g. C<987654321>) to effectively disable the timeout.
968		1059
969	=item B<backspacekey:> I<string>	1060	=item B<backspacekey:> I<string>
970		1061
971	The string to send when the backspace key is pressed. If set to B<DEC>	1062	The string to send when the backspace key is pressed. If set to B<DEC>
972	or unset it will send B<Delete> (code 127) or, if shifted, B<Backspace>	1063	or unset it will send B<Delete> (code 127) or, with control, B<Backspace>
973	(code 8) - which can be reversed with the appropriate DEC private mode	1064	(code 8) - which can be reversed with the appropriate DEC private mode
974	escape sequence.	1065	escape sequence.
975		1066
976	=item B<deletekey:> I<string>	1067	=item B<deletekey:> I<string>
977		1068
…		…
990	will be created). In this mode, characters outside ISO-8859-1 can be used.	1081	will be created). In this mode, characters outside ISO-8859-1 can be used.
991		1082
992	When the selection extension is not used, only ISO-8859-1 characters can	1083	When the selection extension is not used, only ISO-8859-1 characters can
993	be used. If not specified, the built-in default is used:	1084	be used. If not specified, the built-in default is used:
994		1085
995	B<< BACKSLASH `"'&()*,;<=>?@[]{\|} >>	1086	B<< BACKSLASH `"'&()*,;<=>?@[]^{\|} >>
996		1087
997	=item B<preeditType:> I<style>	1088	=item B<preeditType:> I<style>
998		1089
999	B<OverTheSpot>, B<OffTheSpot>, B<Root>; option B<-pt>.	1090	B<OverTheSpot>, B<OffTheSpot>, B<Root>; option B<-pt>.
1000		1091
…		…
1056		1147
1057	=item B<secondaryScroll:> I<boolean>	1148	=item B<secondaryScroll:> I<boolean>
1058		1149
1059	Turn on/off secondary screen scroll (default enabled). If this	1150	Turn on/off secondary screen scroll (default enabled). If this
1060	option is enabled, scrolls on the secondary screen will change the	1151	option is enabled, scrolls on the secondary screen will change the
1061	scrollback buffer and switching to/from the secondary screen will	1152	scrollback buffer and, when secondaryScreen is off, switching
1062	instead scroll the screen up.	1153	to/from the secondary screen will instead scroll the screen up.
1063		1154
1064	=item B<hold>: I<boolean>	1155	=item B<hold>: I<boolean>
1065		1156
1066	Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@	1157	Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@
1067	will not immediately destroy its window when the program executed within	1158	will not immediately destroy its window when the program executed within
1068	it exits. Instead, it will wait till it is being killed or closed by the	1159	it exits. Instead, it will wait till it is being killed or closed by the
1069	user.	1160	user.
		1161
		1162	=item B<chdir>: I<path>
		1163
		1164	Sets the working directory for the shell (or the command specified via
		1165	B<-e>). The I<path> must be an absolute path and it must exist for
		1166	@@RXVT_NAME@@ to start. If it isn't specified then the current working
		1167	directory will be used; option B<-cd>.
1070		1168
1071	=item B<keysym.>I<sym>: I<string>	1169	=item B<keysym.>I<sym>: I<string>
1072		1170
1073	Compile I<frills>: Associate I<string> with keysym I<sym>. The	1171	Compile I<frills>: Associate I<string> with keysym I<sym>. The
1074	intervening resource name B<keysym.> cannot be omitted.	1172	intervening resource name B<keysym.> cannot be omitted.
…		…
1089	omitting the prefix B<XK_>. Alternatively you can specify I<key> by its hex	1187	omitting the prefix B<XK_>. Alternatively you can specify I<key> by its hex
1090	keysym value (B<0x0000 - 0xFFFF>). Note that the lookup of I<sym>s is not	1188	keysym value (B<0x0000 - 0xFFFF>). Note that the lookup of I<sym>s is not
1091	performed in an exact manner; however, the closest match is assured.	1189	performed in an exact manner; however, the closest match is assured.
1092		1190
1093	I<string> may contain escape values (C<\n>: newline, C<\000>: octal	1191	I<string> may contain escape values (C<\n>: newline, C<\000>: octal
1094	number), see RESOURCES in C<man 7 X> for futher details.	1192	number), see RESOURCES in C<man 7 X> for further details.
1095		1193
1096	You can define a range of keysyms in one shot by providing a I<string>	1194	You can define a range of keysyms in one shot by
		1195	loading the C<keysym-list> perl extension and providing a I<string>
1097	with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimiter `/'	1196	with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimiter `/'
1098	should be a character not used by the strings.	1197	should be a character not used by the strings.
1099		1198
1100	Its usage can be demonstrated by an example:	1199	Its usage can be demonstrated by an example:
1101		1200
1102	URxvt.keysym.M-C-0x61: list\|\033<M-C-\|abc\|>	1201	URxvt.keysym.M-C-0x61: list\|\033<\|abc\|>
1103		1202
1104	The above line is equivalent to the following three lines:	1203	The above line is equivalent to the following three lines:
1105		1204
1106	URxvt.keysym.Meta-Control-0x61: \033<M-C-a>	1205	URxvt.keysym.Meta-Control-0x61: \033<a>
1107	URxvt.keysym.Meta-Control-0x62: \033<M-C-b>	1206	URxvt.keysym.Meta-Control-0x62: \033<b>
1108	URxvt.keysym.Meta-Control-0x63: \033<M-C-c>	1207	URxvt.keysym.Meta-Control-0x63: \033<c>
1109		1208
1110	If I<string> takes the form of C<command:STRING>, the specified B<STRING>	1209	If I<string> takes the form of C<command:STRING>, the specified B<STRING>
1111	is interpreted and executed as @@RXVT_NAME@@'s control sequence. For	1210	is interpreted and executed as @@RXVT_NAME@@'s control sequence. For
1112	example the following means "change the current locale to C<zh_CN.GBK>	1211	example the following means "change the current locale to C<zh_CN.GBK>
1113	when Control-Meta-c is being pressed":	1212	when Control-Meta-c is being pressed":
1114		1213
1115	URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007	1214	URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007
1116		1215
1117	If I<string> takes the form C<perl:STRING>, then the specified B<STRING>	1216	If I<string> takes the form C<perl:STRING>, then the specified B<STRING>
1118	is passed to the C<on_keyboard_command> perl handler. See the @@RXVT_NAME@@perl(3)	1217	is passed to the C<on_user_command> perl handler. See the @@RXVT_NAME@@perl(3)
1119	manpage. For example, the F<selection> extension (activated via	1218	manpage. For example, the F<selection> extension (activated via
1120	C<@@RXVT_NAME@@ -pe selection>) listens for C<selection:rot13> events:	1219	C<@@RXVT_NAME@@ -pe selection>) listens for C<selection:rot13> events:
1121		1220
1122	URxvt.keysym.M-C-c: perl:selection:rot13	1221	URxvt.keysym.M-C-c: perl:selection:rot13
1123		1222
1124	Due the the large number of modifier combinations, a defined key mapping	1223	Due the the large number of modifier combinations, a defined key mapping
1125	will match if at I<at least> the specified identifiers are being set, and	1224	will match if I<at least> the specified identifiers are being set, and
1126	no other key mappings with those and more bits are being defined. That	1225	no other key mappings with those and more bits are being defined. That
1127	means that defining a key map for C<a> will automatically provide	1226	means that defining a key map for C<a> will automatically provide
1128	definitions for C<Meta-a>, C<Shift-a> and so on, unless some of those are defined	1227	definitions for C<Meta-a>, C<Shift-a> and so on, unless some of those are defined
1129	mappings themselves.	1228	mappings themselves.
1130		1229
…		…
1181	all instances, while B<perl-ext> is used for specific instances.	1280	all instances, while B<perl-ext> is used for specific instances.
1182		1281
1183	=item B<perl-eval>: I<string>	1282	=item B<perl-eval>: I<string>
1184		1283
1185	Perl code to be evaluated when all extensions have been registered. See	1284	Perl code to be evaluated when all extensions have been registered. See
1186	the @@RXVT_NAME@@perl(3) manpage. Due to security reasons, this resource	1285	the @@RXVT_NAME@@perl(3) manpage.
1187	will be ignored when running setuid/setgid.
1188		1286
1189	=item B<perl-lib>: I<path>	1287	=item B<perl-lib>: I<path>
1190		1288
1191	Colon-separated list of additional directories that hold extension	1289	Colon-separated list of additional directories that hold extension
1192	scripts. When looking for extensions specified by the C<perl> resource,	1290	scripts. When looking for perl extensions, @@RXVT_NAME@@ will first
1193	@@RXVT_NAME@@ will first look in these directories and then in	1291	look in these directories, then in $HOME/.urxvt/ext and lastly in
1194	F<@@RXVT_LIBDIR@@/urxvt/perl/>. Due to security reasons, this resource	1292	F<@@RXVT_LIBDIR@@/urxvt/perl/>.
1195	will be ignored when running setuid/setgid.
1196		1293
1197	See the @@RXVT_NAME@@perl(3) manpage.	1294	See the @@RXVT_NAME@@perl(3) manpage.
1198		1295
1199	=item B<< selection.pattern-I<idx> >>: I<perl-regex>	1296	=item B<< selection.pattern-I<idx> >>: I<perl-regex>
1200		1297
…		…
1222		1319
1223	=item B<override-redirect>: I<boolean>	1320	=item B<override-redirect>: I<boolean>
1224		1321
1225	Compile I<frills>: Sets override-redirect for the terminal window, making	1322	Compile I<frills>: Sets override-redirect for the terminal window, making
1226	it almost invisible to window managers; option B<-override-redirect>.	1323	it almost invisible to window managers; option B<-override-redirect>.
		1324
		1325	=item B<iso14755:> I<boolean>
		1326
		1327	Turn on/off ISO 14755 (default enabled).
1227		1328
1228	=item B<iso14755_52:> I<boolean>	1329	=item B<iso14755_52:> I<boolean>
1229		1330
1230	Turn on/off ISO 14755 5.2 mode (default enabled).	1331	Turn on/off ISO 14755 5.2 mode (default enabled).
1231		1332
…		…
1374	B<@@RXVT_NAME@@> tries to write an entry into the I<utmp>(5) file so that	1475	B<@@RXVT_NAME@@> tries to write an entry into the I<utmp>(5) file so that
1375	it can be seen via the I<who(1)> command, and can accept messages. To	1476	it can be seen via the I<who(1)> command, and can accept messages. To
1376	allow this feature, B<@@RXVT_NAME@@> may need to be installed setuid root	1477	allow this feature, B<@@RXVT_NAME@@> may need to be installed setuid root
1377	on some systems or setgid to root or to some other group on others.	1478	on some systems or setgid to root or to some other group on others.
1378		1479
1379	=head1 COLORS AND GRAPHICS	1480	=head1 COLOURS AND GRAPHICS
1380		1481
1381	In addition to the default foreground and background colours,	1482	In addition to the default foreground and background colours,
1382	B<@@RXVT_NAME@@> can display up to 16 colours (8 ANSI colours plus	1483	B<@@RXVT_NAME@@> can display up to 88/256 colours: 8 ANSI colours plus
1383	high-intensity bold/blink versions of the same). Here is a list of the	1484	high-intensity (potentially bold/blink) versions of the same, and 72 (or
1384	colours with their names.	1485	240 in 256 colour mode) colours arranged in an 4x4x4 (or 6x6x6) colour RGB
		1486	cube plus a 8 (24) colour greyscale ramp.
		1487
		1488	Here is a list of the ANSI colours with their names.
1385		1489
1386	=begin table	1490	=begin table
1387		1491
1388	B<color0> (black) = Black	1492	B<color0> (black) = Black
1389	B<color1> (red) = Red3	1493	B<color1> (red) = Red3
…		…
1409	It is also possible to specify the colour values of B<foreground>,	1513	It is also possible to specify the colour values of B<foreground>,
1410	B<background>, B<cursorColor>, B<cursorColor2>, B<colorBD>, B<colorUL> as	1514	B<background>, B<cursorColor>, B<cursorColor2>, B<colorBD>, B<colorUL> as
1411	a number 0-15, as a convenient shorthand to reference the colour name of	1515	a number 0-15, as a convenient shorthand to reference the colour name of
1412	color0-color15.	1516	color0-color15.
1413		1517
1414	In addition to the colours defined above, @@RXVT_NAME@@ offers an	1518	The following text gives values for the standard 88 colour mode (and
1415	additional 72 colours. The first 64 of those (with indices 16 to 79)	1519	values for the 256 colour mode in parentheses).
1416	consist of a 444 RGB colour cube (i.e. I<index = r * 16 + g * 4 + b +
1417	16>), followed by 8 additional shades of gray (with indices 80 to 87).
1418		1520
		1521	The RGB cube uses indices 16..79 (16..231) using the following formulas:
		1522
		1523	index_88 = (r * 4 + g) * 4 + b + 16 # r, g, b = 0..3
		1524	index_256 = (r * 16 + g) * 16 + b + 16 # r, g, b = 0..15
		1525
		1526	The grayscale ramp uses indices 80..87 (232..239), from 10% to 90% in 10%
		1527	steps (1/26 to 25/26 in 1/26 steps) - black and white are already part of
		1528	the RGB cube.
		1529
1419	Together, all those colours implement the 88 colour xterm colours. Only	1530	Together, all those colours implement the 88 (256) colour xterm
1420	the first 16 can be changed using resources currently, the rest can only	1531	colours. Only the first 16 can be changed using resources currently, the
1421	be changed via command sequences ("escape codes").	1532	rest can only be changed via command sequences ("escape codes").
		1533
		1534	Applications are advised to use terminfo or command sequences to discover
		1535	number and RGB values of all colours (yes, you can query this...).
1422		1536
1423	Note that B<-rv> (B<"reverseVideo: True">) simulates reverse video by	1537	Note that B<-rv> (B<"reverseVideo: True">) simulates reverse video by
1424	always swapping the foreground/background colours. This is in contrast to	1538	always swapping the foreground/background colours. This is in contrast to
1425	I<xterm>(1) where the colours are only swapped if they have not otherwise	1539	I<xterm>(1) where the colours are only swapped if they have not otherwise
1426	been specified. For example,	1540	been specified. For example,
1427		1541
1428	=over 4
1429
1430	=item B<@@RXVT_NAME@@ -fg Black -bg White -rv>	1542	@@RXVT_NAME@@ -fg Black -bg White -rv
1431		1543
1432	would yield White on Black, while on I<xterm>(1) it would yield Black	1544	would yield White on Black, while on I<xterm>(1) it would yield Black on
1433	on White.	1545	White.
1434
1435	=back
1436		1546
1437	=head2 ALPHA CHANNEL SUPPORT	1547	=head2 ALPHA CHANNEL SUPPORT
1438		1548
1439	If Xft support has been compiled in and as long as Xft/Xrender/X don't get	1549	If Xft support has been compiled in and as long as Xft/Xrender/X don't get
1440	their act together, rxvt-unicode will support C<rgba:rrrr/gggg/bbbb/aaaa>	1550	their act together, rxvt-unicode will do its own alpha channel management:
1441	(recommended, but B<MUST> have 4 digits/component) colour specifications,	1551
1442	in addition to the ones provided by X, where the additional A component	1552	You can prefix any colour with an opaqueness percentage enclosed in
		1553	brackets, i.e. C<[percent]>, where C<percent> is a decimal percentage
		1554	(0-100) that specifies the opacity of the colour, where C<0> is completely
		1555	transparent and C<100> is completely opaque. For example, C<[50]red> is a
		1556	half-transparent red, while C<[95]#00ff00> is an almost opaque green. This
		1557	is the recommended format to specify transparency values, and works with
		1558	all ways to specify a colour.
		1559
		1560	For complete control, rxvt-unicode also supports
		1561	C<rgba:rrrr/gggg/bbbb/aaaa> (exactly four hex digits/component) colour
		1562	specifications, where the additional C<aaaa> component specifies opacity
1443	specifies opacity (alpha) values. The minimum value of C<0> is completely	1563	(alpha) values. The minimum value of C<0000> is completely transparent,
1444	transparent). You can also prefix any color with C<[percent]>, where	1564	while C<ffff> is completely opaque). The two example colours from
1445	C<percent> is a decimal percentage (0-100) that specifies the opacity of	1565	earlier could also be specified as C<rgba:ff00/0000/0000/8000> and
1446	the color, where C<0> is completely transparent and C<100> is completelxy	1566	C<rgba:0000/ff00/0000/f332>.
1447	opaque.
1448		1567
1449	You probably need to specify B<"-depth 32">, too, and have the luck that	1568	You probably need to specify B<"-depth 32">, too, to force a visual with
1450	your X-server uses ARGB pixel layout, as X is far from just supporting	1569	alpha channels, and have the luck that your X-server uses ARGB pixel
1451	ARGB visuals out of the box, and rxvt-unicode just fudges around.	1570	layout, as X is far from just supporting ARGB visuals out of the box, and
		1571	rxvt-unicode just fudges around.
1452		1572
1453	For example, the following selects an almost completely transparent red	1573	For example, the following selects an almost completely transparent black
1454	background, and an almost opaque pink foreground:	1574	background, and an almost opaque pink foreground:
1455		1575
1456	@@RXVT_NAME@@ -depth 32 -bg rgba:0000/0000/0000/aaaa -fg "[80]pink"	1576	@@RXVT_NAME@@ -depth 32 -bg rgba:0000/0000/0000/4444 -fg "[80]pink"
1457		1577
1458	I<Please note that transparency of any kind if completely unsupported by	1578	When not using a background image, then the interpretation of the
1459	the author. Don't bug him with installation questions!>	1579	alpha channel is up to your compositing manager (most interpret it as
		1580	transparency of course).
		1581
		1582	When using a background pixmap or pseudo-transparency, then the background
		1583	colour will always behave as if it were completely transparent (so the
		1584	background image shows instead), regardless of how it was specified, while
		1585	other colours will either be transparent as specified (the background
		1586	image will show through) on servers supporting the RENDER extension, or
		1587	fully opaque on servers not supporting the RENDER EXTENSION.
		1588
		1589	Please note that due to bugs in Xft, specifying alpha values might result
		1590	in garbage being displayed when the X-server does not support the RENDER
		1591	extension.
1460		1592
1461	=head1 ENVIRONMENT	1593	=head1 ENVIRONMENT
1462		1594
1463	B<@@RXVT_NAME@@> sets and/or uses the following environment variables:	1595	B<@@RXVT_NAME@@> sets and/or uses the following environment variables:
1464		1596
…		…
1470	resources or on the command line.	1602	resources or on the command line.
1471		1603
1472	=item B<COLORTERM>	1604	=item B<COLORTERM>
1473		1605
1474	Either C<rxvt>, C<rxvt-xpm>, depending on whether @@RXVT_NAME@@ was	1606	Either C<rxvt>, C<rxvt-xpm>, depending on whether @@RXVT_NAME@@ was
1475	compiled with background image support, and optionally with the added	1607	compiled with background image support, and optionally with the added
1476	extension C<-mono> to indicate that rxvt-unicode runs on a monochrome	1608	extension C<-mono> to indicate that rxvt-unicode runs on a monochrome
1477	screen.	1609	screen.
1478		1610
1479	=item B<COLORFGBG>	1611	=item B<COLORFGBG>
1480		1612
1481	Set to a string of the form C<fg;bg> or C<fg;xpm;bg>, where C<fg> is	1613	Set to a string of the form C<fg;bg> or C<fg;xpm;bg>, where C<fg> is
1482	the colour code used as default foreground/text colour (or the string	1614	the colour code used as default foreground/text colour (or the string
1483	C<default> to indicate that the default-colour escape sequence is to be	1615	C<default> to indicate that the default-colour escape sequence is to be
1484	used), C<bg> is the colour code used as default background colour (or the	1616	used), C<bg> is the colour code used as default background colour (or the
1485	string C<default>), and C<xpm> is the string C<default> if @@RXVT_NAME@@	1617	string C<default>), and C<xpm> is the string C<default> if @@RXVT_NAME@@
1486	was compiled with background image support. Libraries like C<ncurses>	1618	was compiled with background image support. Libraries like C<ncurses>
1487	and C<slang> can (and do) use this information to optimize screen output.	1619	and C<slang> can (and do) use this information to optimize screen output.
1488		1620
1489	=item B<WINDOWID>	1621	=item B<WINDOWID>
1490		1622
1491	Set to the (decimal) X Window ID of the @@RXVT_NAME@@ window (the toplevel	1623	Set to the (decimal) X Window ID of the @@RXVT_NAME@@ window (the toplevel
…		…
1498	C<--with-terminfo=PATH>.	1630	C<--with-terminfo=PATH>.
1499		1631
1500	=item B<DISPLAY>	1632	=item B<DISPLAY>
1501		1633
1502	Used by @@RXVT_NAME@@ to connect to the display and set to the correct	1634	Used by @@RXVT_NAME@@ to connect to the display and set to the correct
1503	display in its child processes.	1635	display in its child processes if C<-display> isn't used to override. It
		1636	defaults to C<:0> if it doesn't exist.
1504		1637
1505	=item B<SHELL>	1638	=item B<SHELL>
1506		1639
1507	The shell to be used for command execution, defaults to C</bin/sh>.	1640	The shell to be used for command execution, defaults to C</bin/sh>.
1508		1641
1509	=item B<RXVT_SOCKET>	1642	=item B<RXVT_SOCKET>
1510		1643
1511	The unix domain socket path used by @@RXVT_NAME@@c(1) and	1644	The unix domain socket path used by @@RXVT_NAME@@c(1) and
1512	@@RXVT_NAME@@d(1).	1645	@@RXVT_NAME@@d(1).
1513		1646
1514	Default F<<< $HOME/.rxvt-unicode-I<< <nodename >> >>>.	1647	Default F<<< $HOME/.urxvt/urxvtd-I<< <nodename> >> >>>.
1515		1648
1516	=item B<HOME>	1649	=item B<HOME>
1517		1650
1518	Used to locate the default directory for the unix domain socket for	1651	Used to locate the default directory for the unix domain socket for
1519	daemon communications and to locate various resource files (such as	1652	daemon communications and to locate various resource files (such as
1520	C<.Xdefaults>)	1653	C<.Xdefaults>)
1521		1654
1522	=item B<XAPPLRESDIR>	1655	=item B<XAPPLRESDIR>
1523		1656
1524	Directory where various X resource files are being located.	1657	Directory where application-specific X resource files are located.
1525		1658
1526	=item B<XENVIRONMENT>	1659	=item B<XENVIRONMENT>
1527		1660
1528	If set and accessible, gives the name of a X resource file to be loaded by	1661	If set and accessible, gives the name of a X resource file to be loaded by
1529	@@RXVT_NAME@@.	1662	@@RXVT_NAME@@.
…		…
1534		1667
1535	=over 4	1668	=over 4
1536		1669
1537	=item B</usr/lib/X11/rgb.txt>	1670	=item B</usr/lib/X11/rgb.txt>
1538		1671
1539	Color names.	1672	Colour names.
1540		1673
1541	=back	1674	=back
1542		1675
1543	=head1 SEE ALSO	1676	=head1 SEE ALSO
1544		1677
…		…
1583	Project Coordinator (changes.txt 2.21a to 2.4.5)	1716	Project Coordinator (changes.txt 2.21a to 2.4.5)
1584		1717
1585	=item Geoff Wing L<< <gcw@pobox.com> >>	1718	=item Geoff Wing L<< <gcw@pobox.com> >>
1586		1719
1587	Rewrote screen display and text selection routines.	1720	Rewrote screen display and text selection routines.
1588		1721
1589	Project Coordinator (changes.txt 2.4.6 - rxvt-unicode)	1722	Project Coordinator (changes.txt 2.4.6 - rxvt-unicode)
1590		1723
1591	=item Marc Alexander Lehmann L<< <rxvt-unicode@schmorp.de> >>	1724	=item Marc Alexander Lehmann L<< <rxvt-unicode@schmorp.de> >>
1592		1725
1593	Forked rxvt-unicode, unicode support, rewrote almost all the code, perl	1726	Forked rxvt-unicode, unicode support, rewrote almost all the code, perl
…		…
1595		1728
1596	Project Coordinator (Changes 1.0 -)	1729	Project Coordinator (Changes 1.0 -)
1597		1730
1598	=item Emanuele Giaquinta L<< <e.giaquinta@glauco.it> >>	1731	=item Emanuele Giaquinta L<< <e.giaquinta@glauco.it> >>
1599		1732
1600	Pty/tty/utmp/wtmp rewrite, lots of random hacking and bugfixing.	1733	pty/utmp code rewrite, image code improvements, many random hacks and bugfixes.
1601		1734
1602	=back	1735	=back
1603		1736

Diff Legend

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

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents): Revision 1.140 by sasha, Fri Oct 26 18:27:29 2007 UTC vs. Revision 1.215 by sf-exg, Sun May 20 16:34:42 2012 UTC

Diff Legend

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents):
Revision 1.140 by sasha, Fri Oct 26 18:27:29 2007 UTC vs.
Revision 1.215 by sf-exg, Sun May 20 16:34:42 2012 UTC