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

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents):
Revision 1.149 by ayin, Fri Dec 7 13:49:43 2007 UTC vs.
Revision 1.225 by sf-exg, Wed Jun 5 07:58:17 2013 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<frills>: 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
		111	=item B<-visual> I<visualID>
		112
		113	Compile I<frills>: Use the given visual (see e.g. C<xdpyinfo> for possible
		114	visual ids).
		115
103	=item B<-geometry> I<geom>	116	=item B<-geometry> I<geom>
104		117
105	Window geometry (B<-g> still respected); resource B<geometry>.	118	Window geometry (B<-g> still respected); resource B<geometry>.
106		119
107	=item B<-rv>\|B<+rv>	120	=item B<-rv>\|B<+rv>
…		…
113	Turn on/off jump scrolling (allow multiple lines per refresh); resource B<jumpScroll>.	126	Turn on/off jump scrolling (allow multiple lines per refresh); resource B<jumpScroll>.
114		127
115	=item B<-ss>\|B<+ss>	128	=item B<-ss>\|B<+ss>
116		129
117	Turn on/off skip scrolling (allow multiple screens per refresh); resource B<skipScroll>.	130	Turn on/off skip scrolling (allow multiple screens per refresh); resource B<skipScroll>.
118
119	=item B<-tr>\|B<+tr>
120
121	Turn on/off illusion of a transparent window background; resource B<transparent>.
122
123	B<-ip> is still accepted as an obsolete alias but will be removed in
124	future versions.
125
126	I<Please address all transparency related issues to Sasha Vasko at
127	sasha@aftercode.net. Read the FAQ (man 7 @@RXVT_NAME@@)!>
128		131
129	=item B<-fade> I<number>	132	=item B<-fade> I<number>
130		133
131	Fade the text by the given percentage when focus is lost. Small values	134	Fade the text by the given percentage when focus is lost. Small values
132	fade a little only, 100 completely replaces all colours by the fade	135	fade a little only, 100 completely replaces all colours by the fade
…		…
135	=item B<-fadecolor> I<colour>	138	=item B<-fadecolor> I<colour>
136		139
137	Fade to this colour when fading is used (see B<-fade>). The default colour	140	Fade to this colour when fading is used (see B<-fade>). The default colour
138	is opaque black. resource B<fadeColor>.	141	is opaque black. resource B<fadeColor>.
139		142
140	=item B<-tint> I<colour>	143	=item B<-icon> I<file>
141		144
142	Tint the transparent background pixmap with the given colour when	145	Compile I<pixbuf>: Use the specified image as application icon. This
143	transparency is enabled with B<-tr>. This only works for	146	is used by many window managers, taskbars and pagers to represent the
144	non-tiled backgrounds, currently. See also the B<-sh> option that can be	147	application window; resource I<iconFile>.
145	used to brighten or darken the image in addition to tinting it.
146	Please note that certain tint colours can be applied on the server-side,
147	thus yielding performance gain of two orders of magnitude. These colours are:
148	blue, red, green, cyan, magenta, yellow, and those close to them. Also
149	pure black and pure white colors essentially mean no tinting; resource
150	I<tintColor>. Example:
151
152	@@RXVT_NAME@@ -tr -tint blue -sh 40
153
154	=item B<-sh> I<number>
155
156	Darken (0 .. 100) or lighten (100 .. 200) the transparent
157	background image in addition to (or instead of) tinting it;
158	resource I<shading>.
159
160	=item B<-blt> I<string>
161
162	Specify background blending type. If background pixmap is specified
163	at the same time as transparency - such pixmap will be blended over
164	transparency image, using method specified. Supported values are :
165	B<add>, B<alphablend>, B<allanon> - color values averaging, B<colorize>,
166	B<darken>, B<diff>, B<dissipate>, B<hue>, B<lighten>, B<overlay>,
167	B<saturate>, B<screen>, B<sub>, B<tint>, B<value>. The default is
168	alpha-blending. Compile I<afterimage>; resource I<blendType>.
169
170	=item B<-blr> I<HxV>
171
172	Apply Gaussian Blur with the specified radii to the transparent
173	background image. If single number is specified - both vertical and
174	horizontal radii are considered to be the same. Setting one of the
175	radii to 1 and another to a large number creates interesting effects
176	on some backgrounds. Maximum radius value is 128. Compile I<afterimage>;
177	resource I<blurRadius>.
178		148
179	=item B<-bg> I<colour>	149	=item B<-bg> I<colour>
180		150
181	Window background colour; resource B<background>.	151	Window background colour; resource B<background>.
182		152
183	=item B<-fg> I<colour>	153	=item B<-fg> I<colour>
184		154
185	Window foreground colour; resource B<foreground>.	155	Window foreground colour; resource B<foreground>.
186
187	=item B<-pixmap> I<file[;geom[:op1][:op2][...]]>
188
189	Compile I<afterimage>: Specify image file for the background and also
190	optionally specify its scaling with a geometry string. Note you may need to
191	add quotes to avoid special shell interpretation of the C<;> in the
192	command-line; for more details see resource B<backgroundPixmap>.
193		156
194	=item B<-cr> I<colour>	157	=item B<-cr> I<colour>
195		158
196	The cursor colour; resource B<cursorColor>.	159	The cursor colour; resource B<cursorColor>.
197		160
…		…
242	italic> >> characters are to be printed. See resource B<boldItalicFont>	205	italic> >> characters are to be printed. See resource B<boldItalicFont>
243	for details.	206	for details.
244		207
245	=item B<-is>\|B<+is>	208	=item B<-is>\|B<+is>
246		209
247	Compile I<font-styles>: Bold/Italic font styles imply high intensity	210	Compile I<font-styles>: Bold/Blink font styles imply high intensity
248	foreground/background (default). See resource B<intensityStyles> for	211	foreground/background (default). See resource B<intensityStyles> for
249	details.	212	details.
250		213
251	=item B<-name> I<name>	214	=item B<-name> I<name>
252		215
…		…
270		233
271	=item B<-sb>\|B<+sb>	234	=item B<-sb>\|B<+sb>
272		235
273	Turn on/off scrollbar; resource B<scrollBar>.	236	Turn on/off scrollbar; resource B<scrollBar>.
274		237
		238	=item B<-sr>\|B<+sr>
		239
		240	Put scrollbar on right/left; resource B<scrollBar_right>.
		241
		242	=item B<-st>\|B<+st>
		243
		244	Display rxvt (non XTerm/NeXT) scrollbar without/with a trough;
		245	resource B<scrollBar_floating>.
		246
275	=item B<-si>\|B<+si>	247	=item B<-si>\|B<+si>
276		248
277	Turn on/off scroll-to-bottom on TTY output inhibit; resource	249	Turn on/off scroll-to-bottom on TTY output inhibit; resource
278	B<scrollTtyOutput> has opposite effect.	250	B<scrollTtyOutput> has opposite effect.
279		251
…		…
285	=item B<-sw>\|B<+sw>	257	=item B<-sw>\|B<+sw>
286		258
287	Turn on/off scrolling with the scrollback buffer as new lines appear.	259	Turn on/off scrolling with the scrollback buffer as new lines appear.
288	This only takes effect if B<-si> is also given; resource	260	This only takes effect if B<-si> is also given; resource
289	B<scrollWithBuffer>.	261	B<scrollWithBuffer>.
290
291	=item B<-sr>\|B<+sr>
292
293	Put scrollbar on right/left; resource B<scrollBar_right>.
294
295	=item B<-st>\|B<+st>
296
297	Display rxvt (non XTerm/NeXT) scrollbar without/with a trough;
298	resource B<scrollBar_floating>.
299		262
300	=item B<-ptab>\|B<+ptab>	263	=item B<-ptab>\|B<+ptab>
301		264
302	If enabled (default), "Horizontal Tab" characters are being stored as	265	If enabled (default), "Horizontal Tab" characters are being stored as
303	actual wide characters in the screen buffer, which makes it possible to	266	actual wide characters in the screen buffer, which makes it possible to
…		…
307		270
308	=item B<-bc>\|B<+bc>	271	=item B<-bc>\|B<+bc>
309		272
310	Blink the cursor; resource B<cursorBlink>.	273	Blink the cursor; resource B<cursorBlink>.
311		274
		275	=item B<-uc>\|B<+uc>
		276
		277	Make the cursor underlined; resource B<cursorUnderline>.
		278
312	=item B<-iconic>	279	=item B<-iconic>
313		280
314	Start iconified, if the window manager supports that option.	281	Start iconified, if the window manager supports that option.
315	Alternative form is B<-ic>.	282	Alternative form is B<-ic>.
316		283
…		…
332		299
333	=item B<-bl>	300	=item B<-bl>
334		301
335	Compile I<frills>: Set MWM hints to request a borderless window, i.e.	302	Compile I<frills>: Set MWM hints to request a borderless window, i.e.
336	if honoured by the WM, the rxvt-unicode window will not have window	303	if honoured by the WM, the rxvt-unicode window will not have window
337	decorations; resource B<borderLess>.	304	decorations; resource B<borderLess>. If the window manager does not
		305	support MWM hints (e.g. kwin), enables override-redirect mode.
338		306
339	=item B<-override-redirect>	307	=item B<-override-redirect>
340		308
341	Compile I<frills>: Sets override-redirect on the window; resource	309	Compile I<frills>: Sets override-redirect on the window; resource
342	B<override-redirect>.	310	B<override-redirect>.
…		…
351	=item B<-lsp> I<number>	319	=item B<-lsp> I<number>
352		320
353	Compile I<frills>: Lines (pixel height) to insert between each row of	321	Compile I<frills>: Lines (pixel height) to insert between each row of
354	the display. Useful to work around font rendering problems; resource	322	the display. Useful to work around font rendering problems; resource
355	B<lineSpace>.	323	B<lineSpace>.
		324
		325	=item B<-letsp> I<number>
		326
		327	Compile I<frills>: Amount to adjust the computed character width by
		328	to control overall letter spacing. Negative values will tighten up the
		329	letter spacing, positive values will space letters out more. Useful to
		330	work around odd font metrics; resource B<letterSpace>.
356		331
357	=item B<-tn> I<termname>	332	=item B<-tn> I<termname>
358		333
359	This option specifies the name of the terminal type to be set in the	334	This option specifies the name of the terminal type to be set in the
360	B<TERM> environment variable. This terminal type must exist in the	335	B<TERM> environment variable. This terminal type must exist in the
…		…
447	Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@	422	Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@
448	will not immediately destroy its window when the program executed within	423	will not immediately destroy its window when the program executed within
449	it exits. Instead, it will wait till it is being killed or closed by the	424	it exits. Instead, it will wait till it is being killed or closed by the
450	user; resource B<hold>.	425	user; resource B<hold>.
451		426
		427	=item B<-cd> I<path>
		428
		429	Sets the working directory for the shell (or the command specified via
		430	B<-e>). The I<path> must be an absolute path and it must exist for
		431	@@RXVT_NAME@@ to start; resource B<chdir>.
		432
452	=item B<-xrm> I<string>	433	=item B<-xrm> I<string>
453		434
454	Works like the X Toolkit option of the same name, by adding the I<string>	435	Works like the X Toolkit option of the same name, by adding the I<string>
455	as if it were specified in a resource file. Resource values specified this	436	as if it were specified in a resource file. Resource values specified this
456	way take precedence over all other resource specifications.	437	way take precedence over all other resource specifications.
…		…
503	If this switch is given, @@RXVT_NAME@@ will not create any utmp/wtmp	484	If this switch is given, @@RXVT_NAME@@ will not create any utmp/wtmp
504	entries and will not tinker with pty/tty permissions - you have to do that	485	entries and will not tinker with pty/tty permissions - you have to do that
505	yourself if you want that.	486	yourself if you want that.
506		487
507	As an extremely special case, specifying C<-1> will completely suppress	488	As an extremely special case, specifying C<-1> will completely suppress
508	pty/tty operations.	489	pty/tty operations, which is probably only useful in conjunction with some
		490	perl extension that manages the terminal.
509		491
510	Here is a example in perl that illustrates how this option can be used (a	492	Here is a example in perl that illustrates how this option can be used (a
511	longer example is in F<doc/pty-fd>):	493	longer example is in F<doc/pty-fd>):
512		494
513	use IO::Pty;	495	use IO::Pty;
…		…
527	Comma-separated list of perl extension scripts to use (or not to use) in	509	Comma-separated list of perl extension scripts to use (or not to use) in
528	this terminal instance. See resource B<perl-ext> for details.	510	this terminal instance. See resource B<perl-ext> for details.
529		511
530	=back	512	=back
531		513
532	=head1 RESOURCES (available also as long-options)	514	=head1 RESOURCES
533		515
534	Note: `@@RXVT_NAME@@ --help' gives a list of all resources (long	516	Note: `@@RXVT_NAME@@ --help' gives a list of all resources (long
535	options) compiled into your version.	517	options) compiled into your version. All resources are also available as
		518	long-options.
536		519
537	You can set and change the resources using X11 tools like B<xrdb>. Many	520	You can set and change the resources using X11 tools like B<xrdb>. Many
538	distribution do also load settings from the B<~/.Xresources> file when X	521	distribution do also load settings from the B<~/.Xresources> file when X
539	starts. @@RXVT_NAME@@ will consult the following files/resources in order,	522	starts. @@RXVT_NAME@@ will consult the following files/resources in order,
540	with later settings overwriting earlier ones:	523	with later settings overwriting earlier ones:
541		524
542	1. system-wide app-defaults file, either locale-dependent OR global
543	2. app-defaults file in $XAPPLRESDIR	525	1. app-defaults file in $XAPPLRESDIR
		526	2. $HOME/.Xdefaults
544	3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults	527	3. RESOURCE_MANAGER property on root-window of screen 0
545	4. SCREEN_RESOURCES for the current screen	528	4. SCREEN_RESOURCES property on root-window of the current screen
546	5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename>	529	5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename>
547	6. resources specified via -xrm on the commandline	530	6. resources specified via -xrm on the commandline
548		531
549	Note that when reading X resources, B<@@RXVT_NAME@@> recognizes two class	532	Note that when reading X resources, B<@@RXVT_NAME@@> recognizes two class
550	names: B<Rxvt> and B<URxvt>. The class name B<Rxvt> allows resources	533	names: B<Rxvt> and B<URxvt>. The class name B<Rxvt> allows resources
…		…
562	=item B<depth:> I<bitdepth>	545	=item B<depth:> I<bitdepth>
563		546
564	Compile I<xft>: Attempt to find a visual with the given bit depth;	547	Compile I<xft>: Attempt to find a visual with the given bit depth;
565	option B<-depth>.	548	option B<-depth>.
566		549
		550	=item B<buffered:> I<boolean>
		551
		552	Compile I<xft>: Turn on/off double-buffering for xft (default enabled).
		553	On some card/driver combination enabling it slightly decreases
		554	performance, on most it greatly helps it. The slowdown is small, so it
		555	should normally be enabled.
		556
567	=item B<geometry:> I<geom>	557	=item B<geometry:> I<geom>
568		558
569	Create the window with the specified X window geometry [default 80x24];	559	Create the window with the specified X window geometry [default 80x24];
570	option B<-geometry>.	560	option B<-geometry>.
571		561
…		…
584	Use the specified colour for the colour value I<n>, where 0-7	574	Use the specified colour for the colour value I<n>, where 0-7
585	corresponds to low-intensity (normal) colours and 8-15 corresponds to	575	corresponds to low-intensity (normal) colours and 8-15 corresponds to
586	high-intensity (bold = bright foreground, blink = bright background)	576	high-intensity (bold = bright foreground, blink = bright background)
587	colours. The canonical names are as follows: 0=black, 1=red, 2=green,	577	colours. The canonical names are as follows: 0=black, 1=red, 2=green,
588	3=yellow, 4=blue, 5=magenta, 6=cyan, 7=white, but the actual colour	578	3=yellow, 4=blue, 5=magenta, 6=cyan, 7=white, but the actual colour
589	names used are listed in the B<COLORS AND GRAPHICS> section.	579	names used are listed in the B<COLOURS AND GRAPHICS> section.
590		580
591	Colours higher than 15 cannot be set using resources (yet), but can be	581	Colours higher than 15 cannot be set using resources (yet), but can be
592	changed using an escape command (see @@RXVT_NAME@@(7)).	582	changed using an escape command (see @@RXVT_NAME@@(7)).
593		583
594	Colours 16-79 form a standard 4x4x4 colour cube (the same as xterm with	584	Colours 16-79 form a standard 4x4x4 colour cube (the same as xterm with
…		…
605	=item B<colorUL:> I<colour>	595	=item B<colorUL:> I<colour>
606		596
607	Use the specified colour to display underlined characters when the	597	Use the specified colour to display underlined characters when the
608	foreground colour is the default.	598	foreground colour is the default.
609		599
610	=item B<colorRV:> I<colour>
611
612	Use the specified colour as the background for reverse video characters
613	when OPTION_HC is disabled (--disable-frills).
614
615	=item B<underlineColor:> I<colour>	600	=item B<underlineColor:> I<colour>
616		601
617	If set, use the specified colour as the colour for the underline	602	If set, use the specified colour as the colour for the underline
618	itself. If unset, use the foreground colour.	603	itself. If unset, use the foreground colour.
		604
		605	=item B<highlightColor:> I<colour>
		606
		607	If set, use the specified colour as the background for highlighted
		608	characters. If unset, use reverse video.
		609
		610	=item B<highlightTextColor:> I<colour>
		611
		612	If set and highlightColor is set, use the specified colour as the
		613	foreground for highlighted characters.
619		614
620	=item B<cursorColor:> I<colour>	615	=item B<cursorColor:> I<colour>
621		616
622	Use the specified colour for the cursor. The default is to use the	617	Use the specified colour for the cursor. The default is to use the
623	foreground colour; option B<-cr>.	618	foreground colour; option B<-cr>.
…		…
630		625
631	=item B<reverseVideo:> I<boolean>	626	=item B<reverseVideo:> I<boolean>
632		627
633	B<True>: simulate reverse video by foreground and background colours;	628	B<True>: simulate reverse video by foreground and background colours;
634	option B<-rv>. B<False>: regular screen colours [default]; option	629	option B<-rv>. B<False>: regular screen colours [default]; option
635	B<+rv>. See note in B<COLORS AND GRAPHICS> section.	630	B<+rv>. See note in B<COLOURS AND GRAPHICS> section.
636		631
637	=item B<jumpScroll:> I<boolean>	632	=item B<jumpScroll:> I<boolean>
638		633
639	B<True>: specify that jump scrolling should be used. When receiving lots	634	B<True>: specify that jump scrolling should be used. When receiving lots
640	of lines, @@RXVT_NAME@@ will only scroll once a whole screen height of lines	635	of lines, @@RXVT_NAME@@ will only scroll once a whole screen height of lines
…		…
654		649
655	B<False>: specify that everything is to be displayed, even	650	B<False>: specify that everything is to be displayed, even
656	if the refresh is too fast for the human eye to read anything (or the	651	if the refresh is too fast for the human eye to read anything (or the
657	monitor to display anything); option B<+ss>.	652	monitor to display anything); option B<+ss>.
658		653
659	=item B<transparent:> I<boolean>
660
661	Turn on/off illusion of a transparent window background.
662
663	B<inheritPixmap> is still accepted as an obsolete alias but will be removed in
664	future versions.
665
666	I<Please address all transparency related issues to Sasha Vasko at
667	sasha@aftercode.net. Read the FAQ (man 7 @@RXVT_NAME@@)!>
668
669	=item B<fading:> I<number>	654	=item B<fading:> I<number>
670		655
671	Fade the text by the given percentage when focus is lost; option B<-fade>.	656	Fade the text by the given percentage when focus is lost; option B<-fade>.
672		657
673	=item B<fadeColor:> I<colour>	658	=item B<fadeColor:> I<colour>
674		659
675	Fade to this colour, when fading is used (see B<fading:>). The default	660	Fade to this colour, when fading is used (see B<fading:>). The default
676	colour is black; option B<-fadecolor>.	661	colour is black; option B<-fadecolor>.
677		662
678	=item B<tintColor:> I<colour>	663	=item B<iconFile:> I<file>
679		664
680	Tint the transparent background pixmap with the given colour; option	665	Set the application icon pixmap; option B<-icon>.
681	B<-tint>.
682
683	=item B<shading:> I<number>
684
685	Darken (0 .. 100) or lighten (-1 .. -100) the transparent background image
686	in addition to tinting it; option B<-sh>.
687
688	=item B<blendType:> I<string>
689
690	Specify background blending type; option B<-blt>.
691
692	=item B<blurRadius:> I<number>
693
694	Apply Gaussian Blurr with the specified radius to the transparent
695	background image; option B<-blr>.
696		666
697	=item B<scrollColor:> I<colour>	667	=item B<scrollColor:> I<colour>
698		668
699	Use the specified colour for the scrollbar [default #B2B2B2].	669	Use the specified colour for the scrollbar [default #B2B2B2].
700		670
…		…
705		675
706	=item B<borderColor:> I<colour>	676	=item B<borderColor:> I<colour>
707		677
708	The colour of the border around the text area and between the scrollbar	678	The colour of the border around the text area and between the scrollbar
709	and the text.	679	and the text.
710
711	=item B<backgroundPixmap:> I<file[;geom[:op1][:op2][...]]>
712
713	Use the specified image file for the background and also
714	optionally specify its scaling with a geometry string B<WxH+X+Y>,
715	(default C<0x0+50+50>) in which B<"W" / "H"> specify the
716	horizontal/vertical scale (percent), and B<"X" / "Y"> locate the image
717	centre (percent). A scale of 0 displays the image with tiling. A scale
718	of 1 displays the image without any scaling. A scale of 2 to 9 specifies
719	an integer number of images in that direction. No image will be magnified
720	beyond 10 times its original size. The maximum permitted scale is 1000.
721	Additional operations can be specified after colon B<:op1:op2...>.
722	Supported operations are:
723
724	tile force background image to be tiled and not scaled. Equivalent to 0x0,
725	propscale will scale image keeping proportions,
726	auto will scale image to match window size. Equivalent to 100x100;
727	hscale will scale image horizontally to the window size;
728	vscale will scale image vertically to the window size;
729	scale will scale image to match window size;
730	root will tile image as if it was a root window background, auto-adjusting
731	whenever terminal window moves.
732
733	If used in conjunction with B<-tr> option, the specified pixmap will be
734	blended over transparency image using either alpha-blending, or any
735	other blending type, specified with B<-blt "type"> option.
736
737	=item B<path:> I<path>
738
739	Specify the colon-delimited search path for finding background image files.
740		680
741	=item B<font:> I<fontlist>	681	=item B<font:> I<fontlist>
742		682
743	Select the fonts to be used. This is a comma separated list of font names	683	Select the fonts to be used. This is a comma separated list of font names
744	that are checked in order when trying to find glyphs for characters. The	684	that are checked in order when trying to find glyphs for characters. The
…		…
767	it is named first) and thus defines the character cell grid to be 9 pixels	707	it is named first) and thus defines the character cell grid to be 9 pixels
768	wide and 15 pixels high.	708	wide and 15 pixels high.
769		709
770	The second font is just used to add additional unicode characters not in	710	The second font is just used to add additional unicode characters not in
771	the base font, likewise the third, which is unfortunately non-bold, but	711	the base font, likewise the third, which is unfortunately non-bold, but
772	the bold version of the font does contain less characters, so this is a	712	the bold version of the font does contain fewer characters, so this is a
773	useful supplement.	713	useful supplement.
774		714
775	The third font is an Xft font with aliasing turned off, and the characters	715	The third font is an Xft font with aliasing turned off, and the characters
776	are limited to the B<JIS 0208> codeset (i.e. japanese kanji). The font	716	are limited to the B<JIS 0208> codeset (i.e. japanese kanji). The font
777	contains other characters, but we are not interested in them.	717	contains other characters, but we are not interested in them.
…		…
801	text font will being used for the given style.	741	text font will being used for the given style.
802		742
803	=item B<intensityStyles:> I<boolean>	743	=item B<intensityStyles:> I<boolean>
804		744
805	When font styles are not enabled, or this option is enabled (B<True>,	745	When font styles are not enabled, or this option is enabled (B<True>,
806	option B<-is>, the default), bold and italic font styles imply high	746	option B<-is>, the default), bold/blink font styles imply high
807	intensity foreground/background colours. Disabling this option (B<False>,	747	intensity foreground/background colours. Disabling this option (B<False>,
808	option B<+is>) disables this behaviour, the high intensity colours are not	748	option B<+is>) disables this behaviour, the high intensity colours are not
809	reachable.	749	reachable.
810		750
811	=item B<selectstyle:> I<mode>
812
813	Set mouse selection style to B<old> which is 2.20, B<oldword> which
814	is xterm style with 2.20 old word selection, or anything else which
815	gives xterm style selection. Only effective when the original (non-perl)
816	selection code is in use.
817
818	=item B<scrollstyle:> I<mode>
819
820	Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is
821	the author's favourite.
822
823	=item B<title:> I<string>	751	=item B<title:> I<string>
824		752
825	Set window title string, the default title is the command-line	753	Set window title string, the default title is the command-line
826	specified after the B<-e> option, if any, otherwise the application	754	specified after the B<-e> option, if any, otherwise the application
827	name; option B<-title>.	755	name; option B<-title>.
…		…
840	=item B<urgentOnBell:> I<boolean>	768	=item B<urgentOnBell:> I<boolean>
841		769
842	B<True>: set the urgency hint for the wm on receipt of a bell character.	770	B<True>: set the urgency hint for the wm on receipt of a bell character.
843	B<False>: do not set the urgency hint [default].	771	B<False>: do not set the urgency hint [default].
844		772
		773	@@RXVT_NAME@@ resets the urgency hint on every focus change.
		774
845	=item B<visualBell:> I<boolean>	775	=item B<visualBell:> I<boolean>
846		776
847	B<True>: use visual bell on receipt of a bell character; option B<-vb>.	777	B<True>: use visual bell on receipt of a bell character; option B<-vb>.
848	B<False>: no visual bell [default]; option B<+vb>.	778	B<False>: no visual bell [default]; option B<+vb>.
849		779
…		…
872	URxvt.print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX)	802	URxvt.print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX)
873		803
874	This creates a new file in your home directory with the screen contents	804	This creates a new file in your home directory with the screen contents
875	every time you hit C<Print>.	805	every time you hit C<Print>.
876		806
		807	=item B<scrollstyle:> I<mode>
		808
		809	Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is
		810	the author's favourite.
		811
		812	=item B<thickness:> I<number>
		813
		814	Set the scrollbar width in pixels.
		815
877	=item B<scrollBar:> I<boolean>	816	=item B<scrollBar:> I<boolean>
878		817
879	B<True>: enable the scrollbar [default]; option B<-sb>. B<False>:	818	B<True>: enable the scrollbar [default]; option B<-sb>. B<False>:
880	disable the scrollbar; option B<+sb>.	819	disable the scrollbar; option B<+sb>.
881		820
…		…
900	B<False>: do not scroll to bottom when tty receives output; option	839	B<False>: do not scroll to bottom when tty receives output; option
901	B<+si>.	840	B<+si>.
902		841
903	=item B<scrollWithBuffer:> I<boolean>	842	=item B<scrollWithBuffer:> I<boolean>
904		843
905	B<True>: scroll with scrollback buffer when tty receives new lines (and	844	B<True>: scroll with scrollback buffer when tty receives new lines (i.e.
906	B<scrollTtyOutput> is False); option B<-sw>. B<False>: do not scroll	845	try to show the same lines) and B<scrollTtyOutput> is False; option
907	with scrollback buffer when tty receives new lines; option B<+sw>.	846	B<-sw>. B<False>: do not scroll with scrollback buffer when tty receives
		847	new lines; option B<+sw>.
908		848
909	=item B<scrollTtyKeypress:> I<boolean>	849	=item B<scrollTtyKeypress:> I<boolean>
910		850
911	B<True>: scroll to bottom when a non-special key is pressed. Special keys	851	B<True>: scroll to bottom when a non-special key is pressed. Special keys
912	are those which are intercepted by rxvt-unicode for special handling and	852	are those which are intercepted by rxvt-unicode for special handling and
…		…
968	=item B<cursorBlink:> I<boolean>	908	=item B<cursorBlink:> I<boolean>
969		909
970	B<True>: blink the cursor. B<False>: do not blink the cursor [default];	910	B<True>: blink the cursor. B<False>: do not blink the cursor [default];
971	option B<-bc>.	911	option B<-bc>.
972		912
		913	=item B<cursorUnderline:> I<boolean>
		914
		915	B<True>: Make the cursor underlined. B<False>: Make the cursor a box [default];
		916	option B<-uc>.
		917
973	=item B<pointerBlank:> I<boolean>	918	=item B<pointerBlank:> I<boolean>
974		919
975	B<True>: blank the pointer when a key is pressed or after a set number	920	B<True>: blank the pointer when a key is pressed or after a set number
976	of seconds of inactivity. B<False>: the pointer is always visible	921	of seconds of inactivity. B<False>: the pointer is always visible
977	[default].	922	[default].
…		…
990	large number (e.g. C<987654321>) to effectively disable the timeout.	935	large number (e.g. C<987654321>) to effectively disable the timeout.
991		936
992	=item B<backspacekey:> I<string>	937	=item B<backspacekey:> I<string>
993		938
994	The string to send when the backspace key is pressed. If set to B<DEC>	939	The string to send when the backspace key is pressed. If set to B<DEC>
995	or unset it will send B<Delete> (code 127) or, if shifted, B<Backspace>	940	or unset it will send B<Delete> (code 127) or, with control, B<Backspace>
996	(code 8) - which can be reversed with the appropriate DEC private mode	941	(code 8) - which can be reversed with the appropriate DEC private mode
997	escape sequence.	942	escape sequence.
998		943
999	=item B<deletekey:> I<string>	944	=item B<deletekey:> I<string>
1000		945
…		…
1079		1024
1080	=item B<secondaryScroll:> I<boolean>	1025	=item B<secondaryScroll:> I<boolean>
1081		1026
1082	Turn on/off secondary screen scroll (default enabled). If this	1027	Turn on/off secondary screen scroll (default enabled). If this
1083	option is enabled, scrolls on the secondary screen will change the	1028	option is enabled, scrolls on the secondary screen will change the
1084	scrollback buffer and switching to/from the secondary screen will	1029	scrollback buffer and, when secondaryScreen is off, switching
1085	instead scroll the screen up.	1030	to/from the secondary screen will instead scroll the screen up.
1086		1031
1087	=item B<hold>: I<boolean>	1032	=item B<hold>: I<boolean>
1088		1033
1089	Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@	1034	Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@
1090	will not immediately destroy its window when the program executed within	1035	will not immediately destroy its window when the program executed within
1091	it exits. Instead, it will wait till it is being killed or closed by the	1036	it exits. Instead, it will wait till it is being killed or closed by the
1092	user.	1037	user.
		1038
		1039	=item B<chdir>: I<path>
		1040
		1041	Sets the working directory for the shell (or the command specified via
		1042	B<-e>). The I<path> must be an absolute path and it must exist for
		1043	@@RXVT_NAME@@ to start. If it isn't specified then the current working
		1044	directory will be used; option B<-cd>.
1093		1045
1094	=item B<keysym.>I<sym>: I<string>	1046	=item B<keysym.>I<sym>: I<string>
1095		1047
1096	Compile I<frills>: Associate I<string> with keysym I<sym>. The	1048	Compile I<frills>: Associate I<string> with keysym I<sym>. The
1097	intervening resource name B<keysym.> cannot be omitted.	1049	intervening resource name B<keysym.> cannot be omitted.
…		…
1112	omitting the prefix B<XK_>. Alternatively you can specify I<key> by its hex	1064	omitting the prefix B<XK_>. Alternatively you can specify I<key> by its hex
1113	keysym value (B<0x0000 - 0xFFFF>). Note that the lookup of I<sym>s is not	1065	keysym value (B<0x0000 - 0xFFFF>). Note that the lookup of I<sym>s is not
1114	performed in an exact manner; however, the closest match is assured.	1066	performed in an exact manner; however, the closest match is assured.
1115		1067
1116	I<string> may contain escape values (C<\n>: newline, C<\000>: octal	1068	I<string> may contain escape values (C<\n>: newline, C<\000>: octal
1117	number), see RESOURCES in C<man 7 X> for futher details.	1069	number), see RESOURCES in C<man 7 X> for further details.
1118		1070
1119	You can define a range of keysyms in one shot by providing a I<string>	1071	You can define a range of keysyms in one shot by
		1072	loading the C<keysym-list> perl extension and providing a I<string>
1120	with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimiter `/'	1073	with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimiter `/'
1121	should be a character not used by the strings.	1074	should be a character not used by the strings.
1122		1075
1123	Its usage can be demonstrated by an example:	1076	Its usage can be demonstrated by an example:
1124		1077
1125	URxvt.keysym.M-C-0x61: list\|\033<M-C-\|abc\|>	1078	URxvt.keysym.M-C-0x61: list\|\033<\|abc\|>
1126		1079
1127	The above line is equivalent to the following three lines:	1080	The above line is equivalent to the following three lines:
1128		1081
1129	URxvt.keysym.Meta-Control-0x61: \033<M-C-a>	1082	URxvt.keysym.Meta-Control-0x61: \033<a>
1130	URxvt.keysym.Meta-Control-0x62: \033<M-C-b>	1083	URxvt.keysym.Meta-Control-0x62: \033<b>
1131	URxvt.keysym.Meta-Control-0x63: \033<M-C-c>	1084	URxvt.keysym.Meta-Control-0x63: \033<c>
1132		1085
1133	If I<string> takes the form of C<command:STRING>, the specified B<STRING>	1086	If I<string> takes the form of C<command:STRING>, the specified B<STRING>
1134	is interpreted and executed as @@RXVT_NAME@@'s control sequence. For	1087	is interpreted and executed as @@RXVT_NAME@@'s control sequence. For
1135	example the following means "change the current locale to C<zh_CN.GBK>	1088	example the following means "change the current locale to C<zh_CN.GBK>
1136	when Control-Meta-c is being pressed":	1089	when Control-Meta-c is being pressed":
1137		1090
1138	URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007	1091	URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007
1139		1092
1140	If I<string> takes the form C<perl:STRING>, then the specified B<STRING>	1093	If I<string> takes the form C<perl:STRING>, then the specified B<STRING>
1141	is passed to the C<on_keyboard_command> perl handler. See the @@RXVT_NAME@@perl(3)	1094	is passed to the C<on_user_command> perl handler. See the @@RXVT_NAME@@perl(3)
1142	manpage. For example, the F<selection> extension (activated via	1095	manpage. For example, the F<selection> extension (activated via
1143	C<@@RXVT_NAME@@ -pe selection>) listens for C<selection:rot13> events:	1096	C<@@RXVT_NAME@@ -pe selection>) listens for C<selection:rot13> events:
1144		1097
1145	URxvt.keysym.M-C-c: perl:selection:rot13	1098	URxvt.keysym.M-C-c: perl:selection:rot13
1146		1099
1147	Due the the large number of modifier combinations, a defined key mapping	1100	Due the the large number of modifier combinations, a defined key mapping
1148	will match if at I<at least> the specified identifiers are being set, and	1101	will match if I<at least> the specified identifiers are being set, and
1149	no other key mappings with those and more bits are being defined. That	1102	no other key mappings with those and more bits are being defined. That
1150	means that defining a key map for C<a> will automatically provide	1103	means that defining a key map for C<a> will automatically provide
1151	definitions for C<Meta-a>, C<Shift-a> and so on, unless some of those are defined	1104	definitions for C<Meta-a>, C<Shift-a> and so on, unless some of those are defined
1152	mappings themselves.	1105	mappings themselves.
1153		1106
…		…
1204	all instances, while B<perl-ext> is used for specific instances.	1157	all instances, while B<perl-ext> is used for specific instances.
1205		1158
1206	=item B<perl-eval>: I<string>	1159	=item B<perl-eval>: I<string>
1207		1160
1208	Perl code to be evaluated when all extensions have been registered. See	1161	Perl code to be evaluated when all extensions have been registered. See
1209	the @@RXVT_NAME@@perl(3) manpage. Due to security reasons, this resource	1162	the @@RXVT_NAME@@perl(3) manpage.
1210	will be ignored when running setuid/setgid.
1211		1163
1212	=item B<perl-lib>: I<path>	1164	=item B<perl-lib>: I<path>
1213		1165
1214	Colon-separated list of additional directories that hold extension	1166	Colon-separated list of additional directories that hold extension
1215	scripts. When looking for extensions specified by the C<perl> resource,	1167	scripts. When looking for perl extensions, @@RXVT_NAME@@ will first look
1216	@@RXVT_NAME@@ will first look in these directories and then in	1168	in these directories, then in C<$URXVT_PERL_LIB>, F<$HOME/.urxvt/ext> and
1217	F<@@RXVT_LIBDIR@@/urxvt/perl/>. Due to security reasons, this resource	1169	lastly in F<@@RXVT_LIBDIR@@/urxvt/perl/>.
1218	will be ignored when running setuid/setgid.
1219		1170
1220	See the @@RXVT_NAME@@perl(3) manpage.	1171	See the @@RXVT_NAME@@perl(3) manpage.
1221		1172
1222	=item B<< selection.pattern-I<idx> >>: I<perl-regex>	1173	=item B<< selection.pattern-I<idx> >>: I<perl-regex>
1223		1174
…		…
1232	=item B<searchable-scrollback:> I<keysym>	1183	=item B<searchable-scrollback:> I<keysym>
1233		1184
1234	Sets the hotkey that starts the incremental scrollback buffer search	1185	Sets the hotkey that starts the incremental scrollback buffer search
1235	(default: C<M-s>).	1186	(default: C<M-s>).
1236		1187
1237	=item B<urlLauncher>: I<string>	1188	=item B<url-launcher>: I<string>
1238		1189
1239	Specifies the program to be started with a URL argument. Used by the	1190	Specifies the program to be started with a URL argument. Used by the
1240	C<selection-popup> and C<matcher> perl extensions.	1191	C<selection-popup> and C<matcher> perl extensions.
1241		1192
1242	=item B<transient-for>: I<windowid>	1193	=item B<transient-for>: I<windowid>
…		…
1246	=item B<override-redirect>: I<boolean>	1197	=item B<override-redirect>: I<boolean>
1247		1198
1248	Compile I<frills>: Sets override-redirect for the terminal window, making	1199	Compile I<frills>: Sets override-redirect for the terminal window, making
1249	it almost invisible to window managers; option B<-override-redirect>.	1200	it almost invisible to window managers; option B<-override-redirect>.
1250		1201
		1202	=item B<iso14755:> I<boolean>
		1203
		1204	Turn on/off ISO 14755 (default enabled).
		1205
1251	=item B<iso14755_52:> I<boolean>	1206	=item B<iso14755_52:> I<boolean>
1252		1207
1253	Turn on/off ISO 14755 5.2 mode (default enabled).	1208	Turn on/off ISO 14755 5.2 mode (default enabled).
		1209
		1210	=back
		1211
		1212	=head1 BACKGROUND IMAGE OPTIONS AND RESOURCES
		1213
		1214	=over 4
		1215
		1216	=item B<-pixmap> I<file[;oplist]>
		1217
		1218	=item B<backgroundPixmap:> I<file[;oplist]>
		1219
		1220	Compile I<pixbuf>: Use the specified image file as the window's
		1221	background and also optionally specify a colon separated list of
		1222	operations to modify it. Note that you may need to quote the C<;>
		1223	character when using the command line option, as C<;> is usually a
		1224	metacharacter in shells. Supported operations are:
		1225
		1226	=over 4
		1227
		1228	=item B<WxH+X+Y>
		1229
		1230	sets scale and position. B<"W" / "H"> specify the horizontal/vertical
		1231	scale (percent), and B<"X" / "Y"> locate the image centre (percent). A
		1232	scale of 0 disables scaling.
		1233
		1234	=item B<op=tile>
		1235
		1236	enables tiling
		1237
		1238	=item B<op=keep-aspect>
		1239
		1240	maintain the image aspect ratio when scaling
		1241
		1242	=item B<op=root-align>
		1243
		1244	use the position of the terminal window relative to the root window as
		1245	the image offset, simulating a root window background
		1246
		1247	=back
		1248
		1249	The default scale and position setting is C<100x100+50+50>.
		1250	Alternatively, a predefined set of templates can be used to achieve
		1251	the most common setups:
		1252
		1253	=over 4
		1254
		1255	=item B<style=tiled>
		1256
		1257	the image is tiled with no scaling. Equivalent to 0x0+0+0:op=tile
		1258
		1259	=item B<style=aspect-stretched>
		1260
		1261	the image is scaled to fill the whole window maintaining the aspect
		1262	ratio and centered. Equivalent to 100x100+50+50:op=keep-aspect
		1263
		1264	=item B<style=stretched>
		1265
		1266	the image is scaled to fill the whole window. Equivalent to 100x100
		1267
		1268	=item B<style=centered>
		1269
		1270	the image is centered with no scaling. Equivalent to 0x0+50+50
		1271
		1272	=item B<style=root-tiled>
		1273
		1274	the image is tiled with no scaling and using 'root' positioning.
		1275	Equivalent to 0x0:op=tile:op=root-align
		1276
		1277	=back
		1278
		1279	If multiple templates are specified the last one wins. Note that a
		1280	template overrides all the scale, position and operations settings.
		1281
		1282	If used in conjunction with pseudo-transparency, the specified pixmap
		1283	will be blended over the transparent background using alpha-blending.
		1284
		1285	=item B<-tr>\|B<+tr>
		1286
		1287	=item B<transparent:> I<boolean>
		1288
		1289	Turn on/off pseudo-transparency by using the root pixmap as background.
		1290
		1291	B<-ip> (B<inheritPixmap>) is still accepted as an obsolete alias but
		1292	will be removed in future versions.
		1293
		1294	=item B<-tint> I<colour>
		1295
		1296	=item B<tintColor:> I<colour>
		1297
		1298	Tint the transparent background with the given colour. Note that a
		1299	black tint yields a completely black image while a white tint yields
		1300	the image unchanged.
		1301
		1302	=item B<-sh> I<number>
		1303
		1304	=item B<shading:> I<number>
		1305
		1306	Darken (0 .. 99) or lighten (101 .. 200) the transparent background.
		1307	A value of 100 means no shading.
		1308
		1309	=item B<-blr> I<HxV>
		1310
		1311	=item B<blurRadius:> I<HxV>
		1312
		1313	Apply gaussian blur with the specified radius to the transparent
		1314	background. If a single number is specified, the vertical and
		1315	horizontal radii are considered to be the same. Setting one of the
		1316	radii to 1 and the other to a large number creates interesting effects
		1317	on some backgrounds. The maximum radius value is 128. An horizontal or
		1318	vertical radius of 0 disables blurring.
		1319
		1320	=item B<path:> I<path>
		1321
		1322	Specify the colon-delimited search path for finding background image files.
1254		1323
1255	=back	1324	=back
1256		1325
1257	=head1 THE SCROLLBAR	1326	=head1 THE SCROLLBAR
1258		1327
…		…
1397	B<@@RXVT_NAME@@> tries to write an entry into the I<utmp>(5) file so that	1466	B<@@RXVT_NAME@@> tries to write an entry into the I<utmp>(5) file so that
1398	it can be seen via the I<who(1)> command, and can accept messages. To	1467	it can be seen via the I<who(1)> command, and can accept messages. To
1399	allow this feature, B<@@RXVT_NAME@@> may need to be installed setuid root	1468	allow this feature, B<@@RXVT_NAME@@> may need to be installed setuid root
1400	on some systems or setgid to root or to some other group on others.	1469	on some systems or setgid to root or to some other group on others.
1401		1470
1402	=head1 COLORS AND GRAPHICS	1471	=head1 COLOURS AND GRAPHICS
1403		1472
1404	In addition to the default foreground and background colours,	1473	In addition to the default foreground and background colours,
1405	B<@@RXVT_NAME@@> can display up to 16 colours (8 ANSI colours plus	1474	B<@@RXVT_NAME@@> can display up to 88/256 colours: 8 ANSI colours plus
1406	high-intensity bold/blink versions of the same). Here is a list of the	1475	high-intensity (potentially bold/blink) versions of the same, and 72 (or
1407	colours with their names.	1476	240 in 256 colour mode) colours arranged in an 4x4x4 (or 6x6x6) colour RGB
		1477	cube plus a 8 (24) colour greyscale ramp.
		1478
		1479	Here is a list of the ANSI colours with their names.
1408		1480
1409	=begin table	1481	=begin table
1410		1482
1411	B<color0> (black) = Black	1483	B<color0> (black) = Black
1412	B<color1> (red) = Red3	1484	B<color1> (red) = Red3
…		…
1432	It is also possible to specify the colour values of B<foreground>,	1504	It is also possible to specify the colour values of B<foreground>,
1433	B<background>, B<cursorColor>, B<cursorColor2>, B<colorBD>, B<colorUL> as	1505	B<background>, B<cursorColor>, B<cursorColor2>, B<colorBD>, B<colorUL> as
1434	a number 0-15, as a convenient shorthand to reference the colour name of	1506	a number 0-15, as a convenient shorthand to reference the colour name of
1435	color0-color15.	1507	color0-color15.
1436		1508
1437	In addition to the colours defined above, @@RXVT_NAME@@ offers an	1509	The following text gives values for the standard 88 colour mode (and
1438	additional 72 colours. The first 64 of those (with indices 16 to 79)	1510	values for the 256 colour mode in parentheses).
1439	consist of a 444 RGB colour cube (i.e. I<index = r * 16 + g * 4 + b +
1440	16>), followed by 8 additional shades of gray (with indices 80 to 87).
1441		1511
		1512	The RGB cube uses indices 16..79 (16..231) using the following formulas:
		1513
		1514	index_88 = (r * 4 + g) * 4 + b + 16 # r, g, b = 0..3
		1515	index_256 = (r * 16 + g) * 16 + b + 16 # r, g, b = 0..15
		1516
		1517	The grayscale ramp uses indices 80..87 (232..239), from 10% to 90% in 10%
		1518	steps (1/26 to 25/26 in 1/26 steps) - black and white are already part of
		1519	the RGB cube.
		1520
1442	Together, all those colours implement the 88 colour xterm colours. Only	1521	Together, all those colours implement the 88 (256) colour xterm
1443	the first 16 can be changed using resources currently, the rest can only	1522	colours. Only the first 16 can be changed using resources currently, the
1444	be changed via command sequences ("escape codes").	1523	rest can only be changed via command sequences ("escape codes").
		1524
		1525	Applications are advised to use terminfo or command sequences to discover
		1526	number and RGB values of all colours (yes, you can query this...).
1445		1527
1446	Note that B<-rv> (B<"reverseVideo: True">) simulates reverse video by	1528	Note that B<-rv> (B<"reverseVideo: True">) simulates reverse video by
1447	always swapping the foreground/background colours. This is in contrast to	1529	always swapping the foreground/background colours. This is in contrast to
1448	I<xterm>(1) where the colours are only swapped if they have not otherwise	1530	I<xterm>(1) where the colours are only swapped if they have not otherwise
1449	been specified. For example,	1531	been specified. For example,
1450		1532
1451	=over 4
1452
1453	=item B<@@RXVT_NAME@@ -fg Black -bg White -rv>	1533	@@RXVT_NAME@@ -fg Black -bg White -rv
1454		1534
1455	would yield White on Black, while on I<xterm>(1) it would yield Black	1535	would yield White on Black, while on I<xterm>(1) it would yield Black on
1456	on White.	1536	White.
1457
1458	=back
1459		1537
1460	=head2 ALPHA CHANNEL SUPPORT	1538	=head2 ALPHA CHANNEL SUPPORT
1461		1539
1462	If Xft support has been compiled in and as long as Xft/Xrender/X don't get	1540	If Xft support has been compiled in and as long as Xft/Xrender/X don't get
1463	their act together, rxvt-unicode will support C<rgba:rrrr/gggg/bbbb/aaaa>	1541	their act together, rxvt-unicode will do its own alpha channel management:
1464	(recommended, but B<MUST> have 4 digits/component) colour specifications,	1542
1465	in addition to the ones provided by X, where the additional A component	1543	You can prefix any colour with an opaqueness percentage enclosed in
		1544	brackets, i.e. C<[percent]>, where C<percent> is a decimal percentage
		1545	(0-100) that specifies the opacity of the colour, where C<0> is completely
		1546	transparent and C<100> is completely opaque. For example, C<[50]red> is a
		1547	half-transparent red, while C<[95]#00ff00> is an almost opaque green. This
		1548	is the recommended format to specify transparency values, and works with
		1549	all ways to specify a colour.
		1550
		1551	For complete control, rxvt-unicode also supports
		1552	C<rgba:rrrr/gggg/bbbb/aaaa> (exactly four hex digits/component) colour
		1553	specifications, where the additional C<aaaa> component specifies opacity
1466	specifies opacity (alpha) values. The minimum value of C<0> is completely	1554	(alpha) values. The minimum value of C<0000> is completely transparent,
1467	transparent). You can also prefix any color with C<[percent]>, where	1555	while C<ffff> is completely opaque). The two example colours from
1468	C<percent> is a decimal percentage (0-100) that specifies the opacity of	1556	earlier could also be specified as C<rgba:ff00/0000/0000/8000> and
1469	the color, where C<0> is completely transparent and C<100> is completelxy	1557	C<rgba:0000/ff00/0000/f332>.
1470	opaque.
1471		1558
1472	You probably need to specify B<"-depth 32">, too, and have the luck that	1559	You probably need to specify B<"-depth 32">, too, to force a visual with
1473	your X-server uses ARGB pixel layout, as X is far from just supporting	1560	alpha channels, and have the luck that your X-server uses ARGB pixel
1474	ARGB visuals out of the box, and rxvt-unicode just fudges around.	1561	layout, as X is far from just supporting ARGB visuals out of the box, and
		1562	rxvt-unicode just fudges around.
1475		1563
1476	For example, the following selects an almost completely transparent red	1564	For example, the following selects an almost completely transparent black
1477	background, and an almost opaque pink foreground:	1565	background, and an almost opaque pink foreground:
1478		1566
1479	@@RXVT_NAME@@ -depth 32 -bg rgba:0000/0000/0000/aaaa -fg "[80]pink"	1567	@@RXVT_NAME@@ -depth 32 -bg rgba:0000/0000/0000/4444 -fg "[80]pink"
1480		1568
1481	I<Please note that transparency of any kind if completely unsupported by	1569	When not using a background image, then the interpretation of the
1482	the author. Don't bug him with installation questions!>	1570	alpha channel is up to your compositing manager (most interpret it as
		1571	transparency of course).
		1572
		1573	When using a background pixmap or pseudo-transparency, then the background
		1574	colour will always behave as if it were completely transparent (so the
		1575	background image shows instead), regardless of how it was specified, while
		1576	other colours will either be transparent as specified (the background
		1577	image will show through) on servers supporting the RENDER extension, or
		1578	fully opaque on servers not supporting the RENDER EXTENSION.
		1579
		1580	Please note that due to bugs in Xft, specifying alpha values might result
		1581	in garbage being displayed when the X-server does not support the RENDER
		1582	extension.
1483		1583
1484	=head1 ENVIRONMENT	1584	=head1 ENVIRONMENT
1485		1585
1486	B<@@RXVT_NAME@@> sets and/or uses the following environment variables:	1586	B<@@RXVT_NAME@@> sets and/or uses the following environment variables:
1487		1587
…		…
1521	C<--with-terminfo=PATH>.	1621	C<--with-terminfo=PATH>.
1522		1622
1523	=item B<DISPLAY>	1623	=item B<DISPLAY>
1524		1624
1525	Used by @@RXVT_NAME@@ to connect to the display and set to the correct	1625	Used by @@RXVT_NAME@@ to connect to the display and set to the correct
1526	display in its child processes.	1626	display in its child processes if C<-display> isn't used to override. It
		1627	defaults to C<:0> if it doesn't exist.
1527		1628
1528	=item B<SHELL>	1629	=item B<SHELL>
1529		1630
1530	The shell to be used for command execution, defaults to C</bin/sh>.	1631	The shell to be used for command execution, defaults to C</bin/sh>.
1531		1632
1532	=item B<RXVT_SOCKET>	1633	=item B<RXVT_SOCKET> [I<sic>]
1533		1634
1534	The unix domain socket path used by @@RXVT_NAME@@c(1) and	1635	The unix domain socket path used by @@RXVT_NAME@@c(1) and
1535	@@RXVT_NAME@@d(1).	1636	@@RXVT_NAME@@d(1).
1536		1637
1537	Default F<<< $HOME/.rxvt-unicode-I<< <nodename >> >>>.	1638	Default F<<< $HOME/.urxvt/urxvtd-I<< <nodename> >> >>>.
		1639
		1640	=item B<URXVT_PERL_LIB>
		1641
		1642	Additional F<:>-separated library search path for perl extensions. Will be
		1643	searched after B<-perl-lib> but before F<~/.urxvt/ext> and the system library
		1644	directory.
		1645
		1646	=item B<URXVT_PERL_VERBOSITY>
		1647
		1648	See L<@@RXVT_NAME@@perl>(3).
1538		1649
1539	=item B<HOME>	1650	=item B<HOME>
1540		1651
1541	Used to locate the default directory for the unix domain socket for	1652	Used to locate the default directory for the unix domain socket for
1542	daemon communications and to locate various resource files (such as	1653	daemon communications and to locate various resource files (such as
1543	C<.Xdefaults>)	1654	C<.Xdefaults>)
1544		1655
1545	=item B<XAPPLRESDIR>	1656	=item B<XAPPLRESDIR>
1546		1657
1547	Directory where various X resource files are being located.	1658	Directory where application-specific X resource files are located.
1548		1659
1549	=item B<XENVIRONMENT>	1660	=item B<XENVIRONMENT>
1550		1661
1551	If set and accessible, gives the name of a X resource file to be loaded by	1662	If set and accessible, gives the name of a X resource file to be loaded by
1552	@@RXVT_NAME@@.	1663	@@RXVT_NAME@@.
…		…
1557		1668
1558	=over 4	1669	=over 4
1559		1670
1560	=item B</usr/lib/X11/rgb.txt>	1671	=item B</usr/lib/X11/rgb.txt>
1561		1672
1562	Color names.	1673	Colour names.
1563		1674
1564	=back	1675	=back
1565		1676
1566	=head1 SEE ALSO	1677	=head1 SEE ALSO
1567		1678
		1679	@@RXVT_NAME@@(7), @@RXVT_NAME@@c(1), @@RXVT_NAME@@d(1), @@RXVT_NAME@@-extensions(1),
1568	@@RXVT_NAME@@(7), @@RXVT_NAME@@c(1), @@RXVT_NAME@@d(1), xterm(1), sh(1), resize(1), X(1), pty(4), tty(4), utmp(5)	1680	@@RXVT_NAME@@perl(3), xterm(1), sh(1), resize(1), X(1), pty(4), tty(4), utmp(5)
1569		1681
1570	=head1 CURRENT PROJECT COORDINATOR	1682	=head1 CURRENT PROJECT COORDINATOR
1571		1683
1572	=over 4	1684	=over 4
1573		1685
1574	=item Project Coordinator	1686	=item Project Coordinator
1575		1687
1576	Marc A. Lehmann L<< <rxvt-unicode@schmorp.de> >>	1688	Marc A. Lehmann <rxvt-unicode@schmorp.de>.
1577		1689
1578	L<http://software.schmorp.de/pkg/rxvt-unicode.html>	1690	L<http://software.schmorp.de/pkg/rxvt-unicode.html>
1579		1691
1580	=back	1692	=back
1581		1693
…		…
1585		1697
1586	=item John Bovey	1698	=item John Bovey
1587		1699
1588	University of Kent, 1992, wrote the original Xvt.	1700	University of Kent, 1992, wrote the original Xvt.
1589		1701
1590	=item Rob Nation L<< <nation@rocket.sanders.lockheed.com> >>	1702	=item Rob Nation <nation@rocket.sanders.lockheed.com>
1591		1703
1592	very heavily modified Xvt and came up with Rxvt	1704	very heavily modified Xvt and came up with Rxvt
1593		1705
1594	=item Angelo Haritsis L<< <ah@doc.ic.ac.uk> >>	1706	=item Angelo Haritsis <ah@doc.ic.ac.uk>
1595		1707
1596	wrote the Greek Keyboard Input (no longer in code)	1708	wrote the Greek Keyboard Input (no longer in code)
1597		1709
1598	=item mj olesen L<< <olesen@me.QueensU.CA> >>	1710	=item mj olesen <olesen@me.QueensU.CA>
1599		1711
1600	Wrote the menu system.	1712	Wrote the menu system.
1601		1713
1602	Project Coordinator (changes.txt 2.11 to 2.21)	1714	Project Coordinator (changes.txt 2.11 to 2.21)
1603		1715
1604	=item Oezguer Kesim L<< <kesim@math.fu-berlin.de> >>	1716	=item Oezguer Kesim <kesim@math.fu-berlin.de>
1605		1717
1606	Project Coordinator (changes.txt 2.21a to 2.4.5)	1718	Project Coordinator (changes.txt 2.21a to 2.4.5)
1607		1719
1608	=item Geoff Wing L<< <gcw@pobox.com> >>	1720	=item Geoff Wing <gcw@pobox.com>
1609		1721
1610	Rewrote screen display and text selection routines.	1722	Rewrote screen display and text selection routines.
1611		1723
1612	Project Coordinator (changes.txt 2.4.6 - rxvt-unicode)	1724	Project Coordinator (changes.txt 2.4.6 - rxvt-unicode)
1613		1725
1614	=item Marc Alexander Lehmann L<< <rxvt-unicode@schmorp.de> >>	1726	=item Marc Alexander Lehmann <rxvt-unicode@schmorp.de>
1615		1727
1616	Forked rxvt-unicode, unicode support, rewrote almost all the code, perl	1728	Forked rxvt-unicode, unicode support, rewrote almost all the code, perl
1617	extension, random hacks, numerous bugfixes and extensions.	1729	extension, random hacks, numerous bugfixes and extensions.
1618		1730
1619	Project Coordinator (Changes 1.0 -)	1731	Project Coordinator (Changes 1.0 -)
1620		1732
1621	=item Emanuele Giaquinta L<< <e.giaquinta@glauco.it> >>	1733	=item Emanuele Giaquinta <emanuele.giaquinta@gmail.com>
1622		1734
1623	Pty/tty/utmp/wtmp rewrite, lots of random hacking and bugfixing.	1735	pty/utmp code rewrite, image code improvements, many random hacks and bugfixes.
1624		1736
1625	=back	1737	=back
1626		1738

Diff Legend

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

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents): Revision 1.149 by ayin, Fri Dec 7 13:49:43 2007 UTC vs. Revision 1.225 by sf-exg, Wed Jun 5 07:58:17 2013 UTC

Diff Legend

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents):
Revision 1.149 by ayin, Fri Dec 7 13:49:43 2007 UTC vs.
Revision 1.225 by sf-exg, Wed Jun 5 07:58:17 2013 UTC