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

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents):
Revision 1.147 by root, Fri Nov 23 11:18:04 2007 UTC vs.
Revision 1.221 by sf-exg, Mon Nov 5 12:59:13 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<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. Obsolete form of it is
122	B<-ip> and it should not be used anymore; resource B<transparent>.
123
124	I<Please note that old resource name of B<inheritPixmap> is obsolete and should be
125	changed to B<transparent>. Backwards compatibility support for B<inheritPixmap> will
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		131
131	=item B<-fade> I<number>	132	=item B<-fade> I<number>
132		133
133	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
134	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
…		…
137	=item B<-fadecolor> I<colour>	138	=item B<-fadecolor> I<colour>
138		139
139	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
140	is opaque black. resource B<fadeColor>.	141	is opaque black. resource B<fadeColor>.
141		142
142	=item B<-tint> I<colour>	143	=item B<-icon> I<file>
143		144
144	Tint the transparent background pixmap with the given colour when	145	Compile I<pixbuf>: Use the specified image as application icon. This
145	transparency is enabled with B<-tr>. This only works for	146	is used by many window managers, taskbars and pagers to represent the
146	non-tiled backgrounds, currently. See also the B<-sh> option that can be	147	application window; resource I<iconFile>.
147	used to brighten or darken the image in addition to tinting it.
148	Please note that certain tint colours can be applied on the server-side,
149	thus yielding performance gain of two orders of magnitude. These colours are:
150	blue, red, green, cyan, magenta, yellow, and those close to them. Also
151	pure black and pure white colors essentially mean no tinting; resource
152	I<tintColor>. Example:
153
154	@@RXVT_NAME@@ -tr -tint blue -sh 40
155
156	=item B<-sh> I<number>
157
158	Darken (0 .. 100) or lighten (100 .. 200) the transparent
159	background image in addition to (or instead of) tinting it;
160	resource I<shading>.
161
162	=item B<-blt> I<string>
163
164	Specify background blending type. If background pixmap is specified
165	at the same time as transparency - such pixmap will be blended over
166	transparency image, using method specified. Supported values are :
167	B<add>, B<alphablend>, B<allanon> - color values averaging, B<colorize>,
168	B<darken>, B<diff>, B<dissipate>, B<hue>, B<lighten>, B<overlay>,
169	B<saturate>, B<screen>, B<sub>, B<tint>, B<value>. The default is
170	alpha-blending. Compile I<afterimage>; resource I<blendType>.
171
172	=item B<-blr> I<HxV>
173
174	Apply Gaussian Blur with the specified radii to the transparent
175	background image. If single number is specified - both vertical and
176	horizontal radii are considered to be the same. Setting one of the
177	radii to 1 and another to a large number creates interesting effects
178	on some backgrounds. Maximum radius value is 128. Compile I<afterimage>;
179	resource I<blurRadius>.
180		148
181	=item B<-bg> I<colour>	149	=item B<-bg> I<colour>
182		150
183	Window background colour; resource B<background>.	151	Window background colour; resource B<background>.
184		152
185	=item B<-fg> I<colour>	153	=item B<-fg> I<colour>
186		154
187	Window foreground colour; resource B<foreground>.	155	Window foreground colour; resource B<foreground>.
188
189	=item B<-pixmap> I<file[;geom[:op1][:op2][...]]>
190
191	Compile I<afterimage>: Specify image file for the background and also
192	optionally specify its scaling with a geometry string. Note you may need to
193	add quotes to avoid special shell interpretation of the C<;> in the
194	command-line; for more details see resource B<backgroundPixmap>.
195		156
196	=item B<-cr> I<colour>	157	=item B<-cr> I<colour>
197		158
198	The cursor colour; resource B<cursorColor>.	159	The cursor colour; resource B<cursorColor>.
199		160
…		…
244	italic> >> characters are to be printed. See resource B<boldItalicFont>	205	italic> >> characters are to be printed. See resource B<boldItalicFont>
245	for details.	206	for details.
246		207
247	=item B<-is>\|B<+is>	208	=item B<-is>\|B<+is>
248		209
249	Compile I<font-styles>: Bold/Italic font styles imply high intensity	210	Compile I<font-styles>: Bold/Blink font styles imply high intensity
250	foreground/background (default). See resource B<intensityStyles> for	211	foreground/background (default). See resource B<intensityStyles> for
251	details.	212	details.
252		213
253	=item B<-name> I<name>	214	=item B<-name> I<name>
254		215
…		…
272		233
273	=item B<-sb>\|B<+sb>	234	=item B<-sb>\|B<+sb>
274		235
275	Turn on/off scrollbar; resource B<scrollBar>.	236	Turn on/off scrollbar; resource B<scrollBar>.
276		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
277	=item B<-si>\|B<+si>	247	=item B<-si>\|B<+si>
278		248
279	Turn on/off scroll-to-bottom on TTY output inhibit; resource	249	Turn on/off scroll-to-bottom on TTY output inhibit; resource
280	B<scrollTtyOutput> has opposite effect.	250	B<scrollTtyOutput> has opposite effect.
281		251
…		…
287	=item B<-sw>\|B<+sw>	257	=item B<-sw>\|B<+sw>
288		258
289	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.
290	This only takes effect if B<-si> is also given; resource	260	This only takes effect if B<-si> is also given; resource
291	B<scrollWithBuffer>.	261	B<scrollWithBuffer>.
292
293	=item B<-sr>\|B<+sr>
294
295	Put scrollbar on right/left; resource B<scrollBar_right>.
296
297	=item B<-st>\|B<+st>
298
299	Display rxvt (non XTerm/NeXT) scrollbar without/with a trough;
300	resource B<scrollBar_floating>.
301		262
302	=item B<-ptab>\|B<+ptab>	263	=item B<-ptab>\|B<+ptab>
303		264
304	If enabled (default), "Horizontal Tab" characters are being stored as	265	If enabled (default), "Horizontal Tab" characters are being stored as
305	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
…		…
309		270
310	=item B<-bc>\|B<+bc>	271	=item B<-bc>\|B<+bc>
311		272
312	Blink the cursor; resource B<cursorBlink>.	273	Blink the cursor; resource B<cursorBlink>.
313		274
		275	=item B<-uc>\|B<+uc>
		276
		277	Make the cursor underlined; resource B<cursorUnderline>.
		278
314	=item B<-iconic>	279	=item B<-iconic>
315		280
316	Start iconified, if the window manager supports that option.	281	Start iconified, if the window manager supports that option.
317	Alternative form is B<-ic>.	282	Alternative form is B<-ic>.
318		283
…		…
334		299
335	=item B<-bl>	300	=item B<-bl>
336		301
337	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.
338	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
339	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.
340		306
341	=item B<-override-redirect>	307	=item B<-override-redirect>
342		308
343	Compile I<frills>: Sets override-redirect on the window; resource	309	Compile I<frills>: Sets override-redirect on the window; resource
344	B<override-redirect>.	310	B<override-redirect>.
…		…
353	=item B<-lsp> I<number>	319	=item B<-lsp> I<number>
354		320
355	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
356	the display. Useful to work around font rendering problems; resource	322	the display. Useful to work around font rendering problems; resource
357	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>.
358		331
359	=item B<-tn> I<termname>	332	=item B<-tn> I<termname>
360		333
361	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
362	B<TERM> environment variable. This terminal type must exist in the	335	B<TERM> environment variable. This terminal type must exist in the
…		…
417		390
418	=item B<-tcw>	391	=item B<-tcw>
419		392
420	Change the meaning of triple-click selection with the left mouse	393	Change the meaning of triple-click selection with the left mouse
421	button. Only effective when the original (non-perl) selection code is	394	button. Only effective when the original (non-perl) selection code is
422	in-use. Instead of selecting a full line it will extend the selection the	395	in-use. Instead of selecting a full line it will extend the selection to
423	end of the logical line only. resource B<tripleclickwords>.	396	the end of the logical line only. resource B<tripleclickwords>.
424		397
425	=item B<-insecure>	398	=item B<-insecure>
426		399
427	Enable "insecure" mode, which currently enables most of the escape	400	Enable "insecure" mode, which currently enables most of the escape
428	sequences that echo strings. See the resource B<insecure> for more	401	sequences that echo strings. See the resource B<insecure> for more
…		…
448		421
449	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@@
450	will not immediately destroy its window when the program executed within	423	will not immediately destroy its window when the program executed within
451	it exits. Instead, it will wait till it is being killed or closed by the	424	it exits. Instead, it will wait till it is being killed or closed by the
452	user; resource B<hold>.	425	user; resource B<hold>.
		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>.
453		432
454	=item B<-xrm> I<string>	433	=item B<-xrm> I<string>
455		434
456	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>
457	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
…		…
505	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
506	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
507	yourself if you want that.	486	yourself if you want that.
508		487
509	As an extremely special case, specifying C<-1> will completely suppress	488	As an extremely special case, specifying C<-1> will completely suppress
510	pty/tty operations.	489	pty/tty operations, which is probably only useful in conjunction with some
		490	perl extension that manages the terminal.
511		491
512	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
513	longer example is in F<doc/pty-fd>):	493	longer example is in F<doc/pty-fd>):
514		494
515	use IO::Pty;	495	use IO::Pty;
…		…
529	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
530	this terminal instance. See resource B<perl-ext> for details.	510	this terminal instance. See resource B<perl-ext> for details.
531		511
532	=back	512	=back
533		513
534	=head1 RESOURCES (available also as long-options)	514	=head1 RESOURCES
535		515
536	Note: `@@RXVT_NAME@@ --help' gives a list of all resources (long	516	Note: `@@RXVT_NAME@@ --help' gives a list of all resources (long
537	options) compiled into your version.	517	options) compiled into your version. All resources are also available as
		518	long-options.
538		519
539	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
540	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
541	starts. @@RXVT_NAME@@ will consult the following files/resources in order,	522	starts. @@RXVT_NAME@@ will consult the following files/resources in order,
542	with later settings overwriting earlier ones:	523	with later settings overwriting earlier ones:
543		524
544	1. system-wide app-defaults file, either locale-dependent OR global
545	2. app-defaults file in $XAPPLRESDIR	525	1. app-defaults file in $XAPPLRESDIR
		526	2. $HOME/.Xdefaults
546	3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults	527	3. RESOURCE_MANAGER property on root-window of screen 0
547	4. SCREEN_RESOURCES for the current screen	528	4. SCREEN_RESOURCES property on root-window of the current screen
548	5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename>	529	5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename>
549	6. resources specified via -xrm on the commandline	530	6. resources specified via -xrm on the commandline
550		531
551	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
552	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
…		…
564	=item B<depth:> I<bitdepth>	545	=item B<depth:> I<bitdepth>
565		546
566	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;
567	option B<-depth>.	548	option B<-depth>.
568		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
569	=item B<geometry:> I<geom>	557	=item B<geometry:> I<geom>
570		558
571	Create the window with the specified X window geometry [default 80x24];	559	Create the window with the specified X window geometry [default 80x24];
572	option B<-geometry>.	560	option B<-geometry>.
573		561
…		…
586	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
587	corresponds to low-intensity (normal) colours and 8-15 corresponds to	575	corresponds to low-intensity (normal) colours and 8-15 corresponds to
588	high-intensity (bold = bright foreground, blink = bright background)	576	high-intensity (bold = bright foreground, blink = bright background)
589	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,
590	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
591	names used are listed in the B<COLORS AND GRAPHICS> section.	579	names used are listed in the B<COLOURS AND GRAPHICS> section.
592		580
593	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
594	changed using an escape command (see @@RXVT_NAME@@(7)).	582	changed using an escape command (see @@RXVT_NAME@@(7)).
595		583
596	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
…		…
607	=item B<colorUL:> I<colour>	595	=item B<colorUL:> I<colour>
608		596
609	Use the specified colour to display underlined characters when the	597	Use the specified colour to display underlined characters when the
610	foreground colour is the default.	598	foreground colour is the default.
611		599
612	=item B<colorRV:> I<colour>
613
614	Use the specified colour as the background for reverse video characters
615	when OPTION_HC is disabled (--disable-frills).
616
617	=item B<underlineColor:> I<colour>	600	=item B<underlineColor:> I<colour>
618		601
619	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
620	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.
621		614
622	=item B<cursorColor:> I<colour>	615	=item B<cursorColor:> I<colour>
623		616
624	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
625	foreground colour; option B<-cr>.	618	foreground colour; option B<-cr>.
…		…
632		625
633	=item B<reverseVideo:> I<boolean>	626	=item B<reverseVideo:> I<boolean>
634		627
635	B<True>: simulate reverse video by foreground and background colours;	628	B<True>: simulate reverse video by foreground and background colours;
636	option B<-rv>. B<False>: regular screen colours [default]; option	629	option B<-rv>. B<False>: regular screen colours [default]; option
637	B<+rv>. See note in B<COLORS AND GRAPHICS> section.	630	B<+rv>. See note in B<COLOURS AND GRAPHICS> section.
638		631
639	=item B<jumpScroll:> I<boolean>	632	=item B<jumpScroll:> I<boolean>
640		633
641	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
642	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
…		…
656		649
657	B<False>: specify that everything is to be displayed, even	650	B<False>: specify that everything is to be displayed, even
658	if the refresh is too fast for the human eye to read anything (or the	651	if the refresh is too fast for the human eye to read anything (or the
659	monitor to display anything); option B<+ss>.	652	monitor to display anything); option B<+ss>.
660		653
661	=item B<inheritPixmap:> I<boolean>
662
663	B<True>: make the background inherit the parent windows' pixmap, giving
664	artificial transparency. B<False>: do not inherit the parent windows'
665	pixmap.
666
667	I<Please note that transparency of any kind if completely unsupported by
668	the author. Don't bug him with installation questions!>
669
670	=item B<fading:> I<number>	654	=item B<fading:> I<number>
671		655
672	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>.
673		657
674	=item B<fadeColor:> I<colour>	658	=item B<fadeColor:> I<colour>
675		659
676	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
677	colour is black; option B<-fadecolor>.	661	colour is black; option B<-fadecolor>.
678		662
679	=item B<tintColor:> I<colour>	663	=item B<iconFile:> I<file>
680		664
681	Tint the transparent background pixmap with the given colour; option	665	Set the application icon pixmap; option B<-icon>.
682	B<-tint>.
683
684	=item B<shading:> I<number>
685
686	Darken (0 .. 100) or lighten (-1 .. -100) the transparent background image
687	in addition to tinting it; option B<-sh>.
688
689	=item B<blendType:> I<string>
690
691	Specify background blending type; option B<-blt>.
692
693	=item B<blurRadius:> I<number>
694
695	Apply Gaussian Blurr with the specified radius to the transparent
696	background image; option B<-blr>.
697		666
698	=item B<scrollColor:> I<colour>	667	=item B<scrollColor:> I<colour>
699		668
700	Use the specified colour for the scrollbar [default #B2B2B2].	669	Use the specified colour for the scrollbar [default #B2B2B2].
701		670
…		…
706		675
707	=item B<borderColor:> I<colour>	676	=item B<borderColor:> I<colour>
708		677
709	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
710	and the text.	679	and the text.
711
712	=item B<backgroundPixmap:> I<file[;geom[:op1][:op2][...]]>
713
714	Use the specified image file for the background and also
715	optionally specify its scaling with a geometry string B<WxH+X+Y>,
716	(default C<0x0+50+50>) in which B<"W" / "H"> specify the
717	horizontal/vertical scale (percent), and B<"X" / "Y"> locate the image
718	centre (percent). A scale of 0 displays the image with tiling. A scale
719	of 1 displays the image without any scaling. A scale of 2 to 9 specifies
720	an integer number of images in that direction. No image will be magnified
721	beyond 10 times its original size. The maximum permitted scale is 1000.
722	Additional operations can be specified after colon B<:op1:op2...>.
723	Supported operations are:
724
725	tile force background image to be tiled and not scaled. Equivalent to 0x0,
726	propscale will scale image keeping proportions,
727	auto will scale image to match window size. Equivalent to 100x100;
728	hscale will scale image horizontally to the window size;
729	vscale will scale image vertically to the window size;
730	scale will scale image to match window size;
731	root will tile image as if it was a root window background, auto-adjusting
732	whenever terminal window moves.
733
734	If used in conjunction with B<-tr> option, the specified pixmap will be
735	blended over transparency image using either alpha-blending, or any
736	other blending type, specified with B<-blt "type"> option.
737
738	=item B<path:> I<path>
739
740	Specify the colon-delimited search path for finding background image files.
741		680
742	=item B<font:> I<fontlist>	681	=item B<font:> I<fontlist>
743		682
744	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
745	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
…		…
768	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
769	wide and 15 pixels high.	708	wide and 15 pixels high.
770		709
771	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
772	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
773	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
774	useful supplement.	713	useful supplement.
775		714
776	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
777	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
778	contains other characters, but we are not interested in them.	717	contains other characters, but we are not interested in them.
…		…
802	text font will being used for the given style.	741	text font will being used for the given style.
803		742
804	=item B<intensityStyles:> I<boolean>	743	=item B<intensityStyles:> I<boolean>
805		744
806	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>,
807	option B<-is>, the default), bold and italic font styles imply high	746	option B<-is>, the default), bold/blink font styles imply high
808	intensity foreground/background colours. Disabling this option (B<False>,	747	intensity foreground/background colours. Disabling this option (B<False>,
809	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
810	reachable.	749	reachable.
811		750
812	=item B<selectstyle:> I<mode>
813
814	Set mouse selection style to B<old> which is 2.20, B<oldword> which
815	is xterm style with 2.20 old word selection, or anything else which
816	gives xterm style selection. Only effective when the original (non-perl)
817	selection code is in use.
818
819	=item B<scrollstyle:> I<mode>
820
821	Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is
822	the author's favourite.
823
824	=item B<title:> I<string>	751	=item B<title:> I<string>
825		752
826	Set window title string, the default title is the command-line	753	Set window title string, the default title is the command-line
827	specified after the B<-e> option, if any, otherwise the application	754	specified after the B<-e> option, if any, otherwise the application
828	name; option B<-title>.	755	name; option B<-title>.
…		…
841	=item B<urgentOnBell:> I<boolean>	768	=item B<urgentOnBell:> I<boolean>
842		769
843	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.
844	B<False>: do not set the urgency hint [default].	771	B<False>: do not set the urgency hint [default].
845		772
		773	@@RXVT_NAME@@ resets the urgency hint on every focus change.
		774
846	=item B<visualBell:> I<boolean>	775	=item B<visualBell:> I<boolean>
847		776
848	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>.
849	B<False>: no visual bell [default]; option B<+vb>.	778	B<False>: no visual bell [default]; option B<+vb>.
850		779
…		…
873	URxvt.print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX)	802	URxvt.print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX)
874		803
875	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
876	every time you hit C<Print>.	805	every time you hit C<Print>.
877		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
878	=item B<scrollBar:> I<boolean>	816	=item B<scrollBar:> I<boolean>
879		817
880	B<True>: enable the scrollbar [default]; option B<-sb>. B<False>:	818	B<True>: enable the scrollbar [default]; option B<-sb>. B<False>:
881	disable the scrollbar; option B<+sb>.	819	disable the scrollbar; option B<+sb>.
882		820
…		…
901	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
902	B<+si>.	840	B<+si>.
903		841
904	=item B<scrollWithBuffer:> I<boolean>	842	=item B<scrollWithBuffer:> I<boolean>
905		843
906	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.
907	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
908	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>.
909		848
910	=item B<scrollTtyKeypress:> I<boolean>	849	=item B<scrollTtyKeypress:> I<boolean>
911		850
912	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
913	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
…		…
969	=item B<cursorBlink:> I<boolean>	908	=item B<cursorBlink:> I<boolean>
970		909
971	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];
972	option B<-bc>.	911	option B<-bc>.
973		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
974	=item B<pointerBlank:> I<boolean>	918	=item B<pointerBlank:> I<boolean>
975		919
976	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
977	of seconds of inactivity. B<False>: the pointer is always visible	921	of seconds of inactivity. B<False>: the pointer is always visible
978	[default].	922	[default].
…		…
991	large number (e.g. C<987654321>) to effectively disable the timeout.	935	large number (e.g. C<987654321>) to effectively disable the timeout.
992		936
993	=item B<backspacekey:> I<string>	937	=item B<backspacekey:> I<string>
994		938
995	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>
996	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>
997	(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
998	escape sequence.	942	escape sequence.
999		943
1000	=item B<deletekey:> I<string>	944	=item B<deletekey:> I<string>
1001		945
…		…
1080		1024
1081	=item B<secondaryScroll:> I<boolean>	1025	=item B<secondaryScroll:> I<boolean>
1082		1026
1083	Turn on/off secondary screen scroll (default enabled). If this	1027	Turn on/off secondary screen scroll (default enabled). If this
1084	option is enabled, scrolls on the secondary screen will change the	1028	option is enabled, scrolls on the secondary screen will change the
1085	scrollback buffer and switching to/from the secondary screen will	1029	scrollback buffer and, when secondaryScreen is off, switching
1086	instead scroll the screen up.	1030	to/from the secondary screen will instead scroll the screen up.
1087		1031
1088	=item B<hold>: I<boolean>	1032	=item B<hold>: I<boolean>
1089		1033
1090	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@@
1091	will not immediately destroy its window when the program executed within	1035	will not immediately destroy its window when the program executed within
1092	it exits. Instead, it will wait till it is being killed or closed by the	1036	it exits. Instead, it will wait till it is being killed or closed by the
1093	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>.
1094		1045
1095	=item B<keysym.>I<sym>: I<string>	1046	=item B<keysym.>I<sym>: I<string>
1096		1047
1097	Compile I<frills>: Associate I<string> with keysym I<sym>. The	1048	Compile I<frills>: Associate I<string> with keysym I<sym>. The
1098	intervening resource name B<keysym.> cannot be omitted.	1049	intervening resource name B<keysym.> cannot be omitted.
…		…
1113	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
1114	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
1115	performed in an exact manner; however, the closest match is assured.	1066	performed in an exact manner; however, the closest match is assured.
1116		1067
1117	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
1118	number), see RESOURCES in C<man 7 X> for futher details.	1069	number), see RESOURCES in C<man 7 X> for further details.
1119		1070
1120	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>
1121	with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimiter `/'	1073	with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimiter `/'
1122	should be a character not used by the strings.	1074	should be a character not used by the strings.
1123		1075
1124	Its usage can be demonstrated by an example:	1076	Its usage can be demonstrated by an example:
1125		1077
1126	URxvt.keysym.M-C-0x61: list\|\033<M-C-\|abc\|>	1078	URxvt.keysym.M-C-0x61: list\|\033<\|abc\|>
1127		1079
1128	The above line is equivalent to the following three lines:	1080	The above line is equivalent to the following three lines:
1129		1081
1130	URxvt.keysym.Meta-Control-0x61: \033<M-C-a>	1082	URxvt.keysym.Meta-Control-0x61: \033<a>
1131	URxvt.keysym.Meta-Control-0x62: \033<M-C-b>	1083	URxvt.keysym.Meta-Control-0x62: \033<b>
1132	URxvt.keysym.Meta-Control-0x63: \033<M-C-c>	1084	URxvt.keysym.Meta-Control-0x63: \033<c>
1133		1085
1134	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>
1135	is interpreted and executed as @@RXVT_NAME@@'s control sequence. For	1087	is interpreted and executed as @@RXVT_NAME@@'s control sequence. For
1136	example the following means "change the current locale to C<zh_CN.GBK>	1088	example the following means "change the current locale to C<zh_CN.GBK>
1137	when Control-Meta-c is being pressed":	1089	when Control-Meta-c is being pressed":
1138		1090
1139	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
1140		1092
1141	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>
1142	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)
1143	manpage. For example, the F<selection> extension (activated via	1095	manpage. For example, the F<selection> extension (activated via
1144	C<@@RXVT_NAME@@ -pe selection>) listens for C<selection:rot13> events:	1096	C<@@RXVT_NAME@@ -pe selection>) listens for C<selection:rot13> events:
1145		1097
1146	URxvt.keysym.M-C-c: perl:selection:rot13	1098	URxvt.keysym.M-C-c: perl:selection:rot13
1147		1099
1148	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
1149	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
1150	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
1151	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
1152	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
1153	mappings themselves.	1105	mappings themselves.
1154		1106
…		…
1205	all instances, while B<perl-ext> is used for specific instances.	1157	all instances, while B<perl-ext> is used for specific instances.
1206		1158
1207	=item B<perl-eval>: I<string>	1159	=item B<perl-eval>: I<string>
1208		1160
1209	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
1210	the @@RXVT_NAME@@perl(3) manpage. Due to security reasons, this resource	1162	the @@RXVT_NAME@@perl(3) manpage.
1211	will be ignored when running setuid/setgid.
1212		1163
1213	=item B<perl-lib>: I<path>	1164	=item B<perl-lib>: I<path>
1214		1165
1215	Colon-separated list of additional directories that hold extension	1166	Colon-separated list of additional directories that hold extension
1216	scripts. When looking for extensions specified by the C<perl> resource,	1167	scripts. When looking for perl extensions, @@RXVT_NAME@@ will first look
1217	@@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
1218	F<@@RXVT_LIBDIR@@/urxvt/perl/>. Due to security reasons, this resource	1169	lastly in F<@@RXVT_LIBDIR@@/urxvt/perl/>.
1219	will be ignored when running setuid/setgid.
1220		1170
1221	See the @@RXVT_NAME@@perl(3) manpage.	1171	See the @@RXVT_NAME@@perl(3) manpage.
1222		1172
1223	=item B<< selection.pattern-I<idx> >>: I<perl-regex>	1173	=item B<< selection.pattern-I<idx> >>: I<perl-regex>
1224		1174
…		…
1247	=item B<override-redirect>: I<boolean>	1197	=item B<override-redirect>: I<boolean>
1248		1198
1249	Compile I<frills>: Sets override-redirect for the terminal window, making	1199	Compile I<frills>: Sets override-redirect for the terminal window, making
1250	it almost invisible to window managers; option B<-override-redirect>.	1200	it almost invisible to window managers; option B<-override-redirect>.
1251		1201
		1202	=item B<iso14755:> I<boolean>
		1203
		1204	Turn on/off ISO 14755 (default enabled).
		1205
1252	=item B<iso14755_52:> I<boolean>	1206	=item B<iso14755_52:> I<boolean>
1253		1207
1254	Turn on/off ISO 14755 5.2 mode (default enabled).	1208	Turn on/off ISO 14755 5.2 mode (default enabled).
		1209
		1210	=head1 BACKGROUND IMAGE OPTIONS AND RESOURCES
		1211
		1212	=item B<-pixmap> I<file[;oplist]>
		1213
		1214	=item B<backgroundPixmap:> I<file[;oplist]>
		1215
		1216	Compile I<pixbuf>: Use the specified image file as the window's
		1217	background and also optionally specify a colon separated list of
		1218	operations to modify it. Note that you may need to quote the C<;>
		1219	character when using the command line option, as C<;> is usually a
		1220	metacharacter in shells. Supported operations are:
		1221
		1222	=over 4
		1223
		1224	=item B<WxH+X+Y>
		1225
		1226	sets scale and position. B<"W" / "H"> specify the horizontal/vertical
		1227	scale (percent), and B<"X" / "Y"> locate the image centre (percent). A
		1228	scale of 0 disables scaling.
		1229
		1230	=item B<op=tile>
		1231
		1232	enables tiling
		1233
		1234	=item B<op=keep-aspect>
		1235
		1236	maintain the image aspect ratio when scaling
		1237
		1238	=item B<op=root-align>
		1239
		1240	use the position of the terminal window relative to the root window as
		1241	the image offset, simulating a root window background
		1242
		1243	=back
		1244
		1245	The default scale and position setting is C<100x100+50+50>.
		1246	Alternatively, a predefined set of templates can be used to achieve
		1247	the most common setups:
		1248
		1249	=over 4
		1250
		1251	=item B<style=tiled>
		1252
		1253	the image is tiled with no scaling. Equivalent to 0x0+0+0:op=tile
		1254
		1255	=item B<style=aspect-stretched>
		1256
		1257	the image is scaled to fill the whole window maintaining the aspect
		1258	ratio and centered. Equivalent to 100x100+50+50:op=keep-aspect
		1259
		1260	=item B<style=stretched>
		1261
		1262	the image is scaled to fill the whole window. Equivalent to 100x100
		1263
		1264	=item B<style=centered>
		1265
		1266	the image is centered with no scaling. Equivalent to 0x0+50+50
		1267
		1268	=item B<style=root-tiled>
		1269
		1270	the image is tiled with no scaling and using 'root' positioning.
		1271	Equivalent to 0x0:op=tile:op=root-align
		1272
		1273	=back
		1274
		1275	If multiple templates are specified the last one wins. Note that a
		1276	template overrides all the scale, position and operations settings.
		1277
		1278	If used in conjunction with pseudo-transparency, the specified pixmap
		1279	will be blended over the transparent background using alpha-blending.
		1280
		1281	=item B<-tr>\|B<+tr>
		1282
		1283	=item B<transparent:> I<boolean>
		1284
		1285	Turn on/off pseudo-transparency by using the root pixmap as background.
		1286
		1287	B<-ip> (B<inheritPixmap>) is still accepted as an obsolete alias but
		1288	will be removed in future versions.
		1289
		1290	=item B<-tint> I<colour>
		1291
		1292	=item B<tintColor:> I<colour>
		1293
		1294	Tint the transparent background with the given colour. Note that a
		1295	black tint yields a completely black image while a white tint yields
		1296	the image unchanged.
		1297
		1298	=item B<-sh> I<number>
		1299
		1300	=item B<shading:> I<number>
		1301
		1302	Darken (0 .. 99) or lighten (101 .. 200) the transparent background.
		1303	A value of 100 means no shading.
		1304
		1305	=item B<-blr> I<HxV>
		1306
		1307	=item B<blurRadius:> I<HxV>
		1308
		1309	Apply gaussian blur with the specified radius to the transparent
		1310	background. If a single number is specified, the vertical and
		1311	horizontal radii are considered to be the same. Setting one of the
		1312	radii to 1 and the other to a large number creates interesting effects
		1313	on some backgrounds. The maximum radius value is 128. An horizontal or
		1314	vertical radius of 0 disables blurring.
		1315
		1316	=item B<path:> I<path>
		1317
		1318	Specify the colon-delimited search path for finding background image files.
1255		1319
1256	=back	1320	=back
1257		1321
1258	=head1 THE SCROLLBAR	1322	=head1 THE SCROLLBAR
1259		1323
…		…
1398	B<@@RXVT_NAME@@> tries to write an entry into the I<utmp>(5) file so that	1462	B<@@RXVT_NAME@@> tries to write an entry into the I<utmp>(5) file so that
1399	it can be seen via the I<who(1)> command, and can accept messages. To	1463	it can be seen via the I<who(1)> command, and can accept messages. To
1400	allow this feature, B<@@RXVT_NAME@@> may need to be installed setuid root	1464	allow this feature, B<@@RXVT_NAME@@> may need to be installed setuid root
1401	on some systems or setgid to root or to some other group on others.	1465	on some systems or setgid to root or to some other group on others.
1402		1466
1403	=head1 COLORS AND GRAPHICS	1467	=head1 COLOURS AND GRAPHICS
1404		1468
1405	In addition to the default foreground and background colours,	1469	In addition to the default foreground and background colours,
1406	B<@@RXVT_NAME@@> can display up to 16 colours (8 ANSI colours plus	1470	B<@@RXVT_NAME@@> can display up to 88/256 colours: 8 ANSI colours plus
1407	high-intensity bold/blink versions of the same). Here is a list of the	1471	high-intensity (potentially bold/blink) versions of the same, and 72 (or
1408	colours with their names.	1472	240 in 256 colour mode) colours arranged in an 4x4x4 (or 6x6x6) colour RGB
		1473	cube plus a 8 (24) colour greyscale ramp.
		1474
		1475	Here is a list of the ANSI colours with their names.
1409		1476
1410	=begin table	1477	=begin table
1411		1478
1412	B<color0> (black) = Black	1479	B<color0> (black) = Black
1413	B<color1> (red) = Red3	1480	B<color1> (red) = Red3
…		…
1433	It is also possible to specify the colour values of B<foreground>,	1500	It is also possible to specify the colour values of B<foreground>,
1434	B<background>, B<cursorColor>, B<cursorColor2>, B<colorBD>, B<colorUL> as	1501	B<background>, B<cursorColor>, B<cursorColor2>, B<colorBD>, B<colorUL> as
1435	a number 0-15, as a convenient shorthand to reference the colour name of	1502	a number 0-15, as a convenient shorthand to reference the colour name of
1436	color0-color15.	1503	color0-color15.
1437		1504
1438	In addition to the colours defined above, @@RXVT_NAME@@ offers an	1505	The following text gives values for the standard 88 colour mode (and
1439	additional 72 colours. The first 64 of those (with indices 16 to 79)	1506	values for the 256 colour mode in parentheses).
1440	consist of a 444 RGB colour cube (i.e. I<index = r * 16 + g * 4 + b +
1441	16>), followed by 8 additional shades of gray (with indices 80 to 87).
1442		1507
		1508	The RGB cube uses indices 16..79 (16..231) using the following formulas:
		1509
		1510	index_88 = (r * 4 + g) * 4 + b + 16 # r, g, b = 0..3
		1511	index_256 = (r * 16 + g) * 16 + b + 16 # r, g, b = 0..15
		1512
		1513	The grayscale ramp uses indices 80..87 (232..239), from 10% to 90% in 10%
		1514	steps (1/26 to 25/26 in 1/26 steps) - black and white are already part of
		1515	the RGB cube.
		1516
1443	Together, all those colours implement the 88 colour xterm colours. Only	1517	Together, all those colours implement the 88 (256) colour xterm
1444	the first 16 can be changed using resources currently, the rest can only	1518	colours. Only the first 16 can be changed using resources currently, the
1445	be changed via command sequences ("escape codes").	1519	rest can only be changed via command sequences ("escape codes").
		1520
		1521	Applications are advised to use terminfo or command sequences to discover
		1522	number and RGB values of all colours (yes, you can query this...).
1446		1523
1447	Note that B<-rv> (B<"reverseVideo: True">) simulates reverse video by	1524	Note that B<-rv> (B<"reverseVideo: True">) simulates reverse video by
1448	always swapping the foreground/background colours. This is in contrast to	1525	always swapping the foreground/background colours. This is in contrast to
1449	I<xterm>(1) where the colours are only swapped if they have not otherwise	1526	I<xterm>(1) where the colours are only swapped if they have not otherwise
1450	been specified. For example,	1527	been specified. For example,
1451		1528
1452	=over 4
1453
1454	=item B<@@RXVT_NAME@@ -fg Black -bg White -rv>	1529	@@RXVT_NAME@@ -fg Black -bg White -rv
1455		1530
1456	would yield White on Black, while on I<xterm>(1) it would yield Black	1531	would yield White on Black, while on I<xterm>(1) it would yield Black on
1457	on White.	1532	White.
1458
1459	=back
1460		1533
1461	=head2 ALPHA CHANNEL SUPPORT	1534	=head2 ALPHA CHANNEL SUPPORT
1462		1535
1463	If Xft support has been compiled in and as long as Xft/Xrender/X don't get	1536	If Xft support has been compiled in and as long as Xft/Xrender/X don't get
1464	their act together, rxvt-unicode will support C<rgba:rrrr/gggg/bbbb/aaaa>	1537	their act together, rxvt-unicode will do its own alpha channel management:
1465	(recommended, but B<MUST> have 4 digits/component) colour specifications,	1538
1466	in addition to the ones provided by X, where the additional A component	1539	You can prefix any colour with an opaqueness percentage enclosed in
		1540	brackets, i.e. C<[percent]>, where C<percent> is a decimal percentage
		1541	(0-100) that specifies the opacity of the colour, where C<0> is completely
		1542	transparent and C<100> is completely opaque. For example, C<[50]red> is a
		1543	half-transparent red, while C<[95]#00ff00> is an almost opaque green. This
		1544	is the recommended format to specify transparency values, and works with
		1545	all ways to specify a colour.
		1546
		1547	For complete control, rxvt-unicode also supports
		1548	C<rgba:rrrr/gggg/bbbb/aaaa> (exactly four hex digits/component) colour
		1549	specifications, where the additional C<aaaa> component specifies opacity
1467	specifies opacity (alpha) values. The minimum value of C<0> is completely	1550	(alpha) values. The minimum value of C<0000> is completely transparent,
1468	transparent). You can also prefix any color with C<[percent]>, where	1551	while C<ffff> is completely opaque). The two example colours from
1469	C<percent> is a decimal percentage (0-100) that specifies the opacity of	1552	earlier could also be specified as C<rgba:ff00/0000/0000/8000> and
1470	the color, where C<0> is completely transparent and C<100> is completelxy	1553	C<rgba:0000/ff00/0000/f332>.
1471	opaque.
1472		1554
1473	You probably need to specify B<"-depth 32">, too, and have the luck that	1555	You probably need to specify B<"-depth 32">, too, to force a visual with
1474	your X-server uses ARGB pixel layout, as X is far from just supporting	1556	alpha channels, and have the luck that your X-server uses ARGB pixel
1475	ARGB visuals out of the box, and rxvt-unicode just fudges around.	1557	layout, as X is far from just supporting ARGB visuals out of the box, and
		1558	rxvt-unicode just fudges around.
1476		1559
1477	For example, the following selects an almost completely transparent red	1560	For example, the following selects an almost completely transparent black
1478	background, and an almost opaque pink foreground:	1561	background, and an almost opaque pink foreground:
1479		1562
1480	@@RXVT_NAME@@ -depth 32 -bg rgba:0000/0000/0000/aaaa -fg "[80]pink"	1563	@@RXVT_NAME@@ -depth 32 -bg rgba:0000/0000/0000/4444 -fg "[80]pink"
1481		1564
1482	I<Please note that transparency of any kind if completely unsupported by	1565	When not using a background image, then the interpretation of the
1483	the author. Don't bug him with installation questions!>	1566	alpha channel is up to your compositing manager (most interpret it as
		1567	transparency of course).
		1568
		1569	When using a background pixmap or pseudo-transparency, then the background
		1570	colour will always behave as if it were completely transparent (so the
		1571	background image shows instead), regardless of how it was specified, while
		1572	other colours will either be transparent as specified (the background
		1573	image will show through) on servers supporting the RENDER extension, or
		1574	fully opaque on servers not supporting the RENDER EXTENSION.
		1575
		1576	Please note that due to bugs in Xft, specifying alpha values might result
		1577	in garbage being displayed when the X-server does not support the RENDER
		1578	extension.
1484		1579
1485	=head1 ENVIRONMENT	1580	=head1 ENVIRONMENT
1486		1581
1487	B<@@RXVT_NAME@@> sets and/or uses the following environment variables:	1582	B<@@RXVT_NAME@@> sets and/or uses the following environment variables:
1488		1583
…		…
1522	C<--with-terminfo=PATH>.	1617	C<--with-terminfo=PATH>.
1523		1618
1524	=item B<DISPLAY>	1619	=item B<DISPLAY>
1525		1620
1526	Used by @@RXVT_NAME@@ to connect to the display and set to the correct	1621	Used by @@RXVT_NAME@@ to connect to the display and set to the correct
1527	display in its child processes.	1622	display in its child processes if C<-display> isn't used to override. It
		1623	defaults to C<:0> if it doesn't exist.
1528		1624
1529	=item B<SHELL>	1625	=item B<SHELL>
1530		1626
1531	The shell to be used for command execution, defaults to C</bin/sh>.	1627	The shell to be used for command execution, defaults to C</bin/sh>.
1532		1628
1533	=item B<RXVT_SOCKET>	1629	=item B<RXVT_SOCKET> [I<sic>]
1534		1630
1535	The unix domain socket path used by @@RXVT_NAME@@c(1) and	1631	The unix domain socket path used by @@RXVT_NAME@@c(1) and
1536	@@RXVT_NAME@@d(1).	1632	@@RXVT_NAME@@d(1).
1537		1633
1538	Default F<<< $HOME/.rxvt-unicode-I<< <nodename >> >>>.	1634	Default F<<< $HOME/.urxvt/urxvtd-I<< <nodename> >> >>>.
		1635
		1636	=item B<URXVT_PERL_LIB>
		1637
		1638	Additional F<:>-separated library search path for perl extensions. Will be
		1639	searched after B<-perl-lib> but before F<~/.urxvt/ext> and the system library
		1640	directory.
		1641
		1642	=item B<URXVT_PERL_VERBOSITY>
		1643
		1644	See L<@@RXVT_NAME@@perl>(3).
1539		1645
1540	=item B<HOME>	1646	=item B<HOME>
1541		1647
1542	Used to locate the default directory for the unix domain socket for	1648	Used to locate the default directory for the unix domain socket for
1543	daemon communications and to locate various resource files (such as	1649	daemon communications and to locate various resource files (such as
1544	C<.Xdefaults>)	1650	C<.Xdefaults>)
1545		1651
1546	=item B<XAPPLRESDIR>	1652	=item B<XAPPLRESDIR>
1547		1653
1548	Directory where various X resource files are being located.	1654	Directory where application-specific X resource files are located.
1549		1655
1550	=item B<XENVIRONMENT>	1656	=item B<XENVIRONMENT>
1551		1657
1552	If set and accessible, gives the name of a X resource file to be loaded by	1658	If set and accessible, gives the name of a X resource file to be loaded by
1553	@@RXVT_NAME@@.	1659	@@RXVT_NAME@@.
…		…
1558		1664
1559	=over 4	1665	=over 4
1560		1666
1561	=item B</usr/lib/X11/rgb.txt>	1667	=item B</usr/lib/X11/rgb.txt>
1562		1668
1563	Color names.	1669	Colour names.
1564		1670
1565	=back	1671	=back
1566		1672
1567	=head1 SEE ALSO	1673	=head1 SEE ALSO
1568		1674
		1675	@@RXVT_NAME@@(7), @@RXVT_NAME@@c(1), @@RXVT_NAME@@d(1), @@RXVT_NAME@@-extensions(1),
1569	@@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)	1676	@@RXVT_NAME@@perl(3), xterm(1), sh(1), resize(1), X(1), pty(4), tty(4), utmp(5)
1570		1677
1571	=head1 CURRENT PROJECT COORDINATOR	1678	=head1 CURRENT PROJECT COORDINATOR
1572		1679
1573	=over 4	1680	=over 4
1574		1681
…		…
1619		1726
1620	Project Coordinator (Changes 1.0 -)	1727	Project Coordinator (Changes 1.0 -)
1621		1728
1622	=item Emanuele Giaquinta L<< <e.giaquinta@glauco.it> >>	1729	=item Emanuele Giaquinta L<< <e.giaquinta@glauco.it> >>
1623		1730
1624	Pty/tty/utmp/wtmp rewrite, lots of random hacking and bugfixing.	1731	pty/utmp code rewrite, image code improvements, many random hacks and bugfixes.
1625		1732
1626	=back	1733	=back
1627		1734

Diff Legend

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

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents): Revision 1.147 by root, Fri Nov 23 11:18:04 2007 UTC vs. Revision 1.221 by sf-exg, Mon Nov 5 12:59:13 2012 UTC

Diff Legend

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents):
Revision 1.147 by root, Fri Nov 23 11:18:04 2007 UTC vs.
Revision 1.221 by sf-exg, Mon Nov 5 12:59:13 2012 UTC