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

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents):
Revision 1.141 by sasha, Mon Oct 29 13:40:41 2007 UTC vs.
Revision 1.208 by sf-exg, Fri Dec 2 09:13:50 2011 UTC

…		…
12	emulator intended as an I<xterm>(1) replacement for users who do not	12	emulator intended as an I<xterm>(1) replacement for users who do not
13	require features such as Tektronix 4014 emulation and toolkit-style	13	require features such as Tektronix 4014 emulation and toolkit-style
14	configurability. As a result, B<rxvt-unicode> uses much less swap space --	14	configurability. As a result, B<rxvt-unicode> uses much less swap space --
15	a significant advantage on a machine serving many X sessions.	15	a significant advantage on a machine serving many X sessions.
16		16
		17	This document is also available on the World-Wide-Web at
		18	L<http://pod.tst.eu/http://cvs.schmorp.de/rxvt-unicode/doc/rxvt.1.pod>.
		19
17	=head1 FREQUENTLY ASKED QUESTIONS	20	=head1 FREQUENTLY ASKED QUESTIONS
18		21
19	See @@RXVT_NAME@@(7) (try C<man 7 @@RXVT_NAME@@>) for a list of	22	See @@RXVT_NAME@@(7) (try C<man 7 @@RXVT_NAME@@>) for a list of
20	frequently asked questions and answer to them and some common	23	frequently asked questions and answer to them and some common
21	problems. That document is also accessible on the World-Wide-Web at	24	problems. That document is also accessible on the World-Wide-Web at
22	L<http://cvs.schmorp.de/browse/rxvt-unicode/doc/rxvt.7.html>.	25	L<http://pod.tst.eu/http://cvs.schmorp.de/rxvt-unicode/doc/rxvt.7.pod>.
23		26
24	=head1 RXVT-UNICODE VS. RXVT	27	=head1 RXVT-UNICODE VS. RXVT
25		28
26	Unlike the original rxvt, B<rxvt-unicode> stores all text in Unicode	29	Unlike the original rxvt, B<rxvt-unicode> stores all text in Unicode
27	internally. That means it can store and display most scripts in the	30	internally. That means it can store and display most scripts in the
…		…
30	like mongolian or scripts requiring extremely complex combining rules,	33	like mongolian or scripts requiring extremely complex combining rules,
31	like tibetan or devanagari. Don't expect pretty output when using these	34	like tibetan or devanagari. Don't expect pretty output when using these
32	scripts. Most other scripts, latin, cyrillic, kanji, thai etc. should work	35	scripts. Most other scripts, latin, cyrillic, kanji, thai etc. should work
33	fine, though. A somewhat difficult case are right-to-left scripts, such	36	fine, though. A somewhat difficult case are right-to-left scripts, such
34	as hebrew: B<rxvt-unicode> adopts the view that bidirectional algorithms	37	as hebrew: B<rxvt-unicode> adopts the view that bidirectional algorithms
35	belong into the application, not the terminal emulator (too many things --	38	belong in the application, not the terminal emulator (too many things --
36	such as cursor-movement while editing -- break otherwise), but that might	39	such as cursor-movement while editing -- break otherwise), but that might
37	change.	40	change.
38		41
39	If you are looking for a terminal that supports more exotic scripts, let	42	If you are looking for a terminal that supports more exotic scripts, let
40	me recommend C<mlterm>, which is a very user friendly, lean and clean	43	me recommend C<mlterm>, which is a very user friendly, lean and clean
…		…
89		92
90	Print out a message describing available options.	93	Print out a message describing available options.
91		94
92	=item B<-display> I<displayname>	95	=item B<-display> I<displayname>
93		96
94	Attempt to open a window on the named X display (B<-d> still	97	Attempt to open a window on the named X display (the older form B<-d>
95	respected). In the absence of this option, the display specified by the	98	is still respected. but deprecated). In the absence of this option, the
96	B<DISPLAY> environment variable is used.	99	display specified by the B<DISPLAY> environment variable is used.
97		100
98	=item B<-depth> I<bitdepth>	101	=item B<-depth> I<bitdepth>
99		102
100	Compile I<xft>: Attempt to find a visual with the given bit depth;	103	Compile I<xft>: Attempt to find a visual with the given bit depth;
101	resource B<depth>.	104	resource B<depth>.
102		105
		106	[Please note that many X servers (and libXft) are buggy with
		107	respect to C<-depth 32> and/or alpha channels, and will cause all sorts
		108	of graphical corruption. This is harmless, but we can't do anything about
		109	this, so watch out]
		110
103	=item B<-geometry> I<geom>	111	=item B<-geometry> I<geom>
104		112
105	Window geometry (B<-g> still respected); resource B<geometry>.	113	Window geometry (B<-g> still respected); resource B<geometry>.
106		114
107	=item B<-rv>\|B<+rv>	115	=item B<-rv>\|B<+rv>
…		…
116		124
117	Turn on/off skip scrolling (allow multiple screens per refresh); resource B<skipScroll>.	125	Turn on/off skip scrolling (allow multiple screens per refresh); resource B<skipScroll>.
118		126
119	=item B<-tr>\|B<+tr>	127	=item B<-tr>\|B<+tr>
120		128
121	Turn on/off illusion of a transparent window background. Obsolete form of it is	129	Turn on/off pseudo-transparency by using the root pixmap as background; resource B<transparent>.
122	B<-ip> and it should not be used anymore; resource B<transparent>.
123		130
124	I<Please note that old resource name of B<inheritPixmap> is obsolete and should be	131	B<-ip> is still accepted as an obsolete alias but will be removed in
125	changed to B<transparent>. Backwards compatibility support for B<inheritPixmap> will	132	future versions.
126	be phased out in future versions of rxvt!>
127
128	I<Please address all transparency related issues to Sasha Vasko at
129	sasha@aftercode.net. Read the FAQ (man 7 @@RXVT_NAME@@)!>
130		133
131	=item B<-fade> I<number>	134	=item B<-fade> I<number>
132		135
133	Fade the text by the given percentage when focus is lost. Small values	136	Fade the text by the given percentage when focus is lost. Small values
134	fade a little only, 100 completely replaces all colours by the fade	137	fade a little only, 100 completely replaces all colours by the fade
…		…
139	Fade to this colour when fading is used (see B<-fade>). The default colour	142	Fade to this colour when fading is used (see B<-fade>). The default colour
140	is opaque black. resource B<fadeColor>.	143	is opaque black. resource B<fadeColor>.
141		144
142	=item B<-tint> I<colour>	145	=item B<-tint> I<colour>
143		146
144	Tint the transparent background pixmap with the given colour when	147	Tint the transparent background with the given colour;
145	transparency is enabled with B<-tr>. This only works for	148	resource I<tintColor>.
146	non-tiled backgrounds, currently. See also the B<-sh> option that can be
147	used to brighten or darken the image in addition to tinting it.
148	Please note that certain tint colours can be applied on the server-side,
149	thus yielding performance gain of two orders of magnitude. These colours are:
150	blue, red, green, cyan, magenta, yellow, and those close to them. Also
151	pure black and pure white colors essentialy mean no tinting; resource
152	I<tintColor>. Example:
153
154	@@RXVT_NAME@@ -tr -tint blue -sh 40
155		149
156	=item B<-sh> I<number>	150	=item B<-sh> I<number>
157		151
158	Darken (0 .. 100) or lighten (100 .. 200) the transparent	152	Darken (0 .. 99) or lighten (101 .. 200) the transparent background.
159	background image in addition to (or instead of) tinting it;	153	A value of 100 means no shading; resource I<shading>.
160	resource I<shading>.
161		154
162	=item B<-blt> I<string>	155	=item B<-blt> I<string>
163		156
164	Specify background blending type. If background pixmap is specified	157	Specify background blending type. If background pixmap is specified
165	at the same time as transparency - such pixmap will be blended over	158	at the same time as transparency - such pixmap will be blended over
166	transparency image, using method specified. Supported values are :	159	the transparent background, using the method specified. Supported values are:
167	B<add>, B<alphablend>, B<allanon> - color values averaging, B<colorize>,	160	B<add>, B<alphablend>, B<allanon> - colour values averaging, B<colorize>,
168	B<darken>, B<diff>, B<dissipate>, B<hue>, B<lighten>, B<overlay>,	161	B<darken>, B<diff>, B<dissipate>, B<hue>, B<lighten>, B<overlay>,
169	B<saturate>, B<screen>, B<sub>, B<tint>, B<value>. The default is	162	B<saturate>, B<screen>, B<sub>, B<tint>, B<value>. The default is
170	alpha-blending. Compile I<afterimage>; resource I<blendType>.	163	alpha-blending. Compile I<afterimage>; resource I<blendType>.
171		164
172	=item B<-blr> I<HxV>	165	=item B<-blr> I<HxV>
173		166
174	Apply Gaussian Blur with the specified radii to the transparent	167	Apply Gaussian Blur with the specified radii to the transparent
175	background image. If single number is specified - both vertical and	168	background. If a single number is specified - both vertical and
176	horizontal radii are considered to be the same. Setting one of the	169	horizontal radii are considered to be the same. Setting one of the
177	radii to 1 and another to a large number creates interesting effects	170	radii to 1 and another to a large number creates interesting effects
178	on some backgrounds. Maximum radius value is 128. Compile I<afterimage>;	171	on some backgrounds. Maximum radius value is 128;
179	resource I<blurRadius>.	172	resource I<blurRadius>.
180		173
		174	=item B<-icon> I<file>
		175
		176	Compile I<afterimage> or I<pixbuf>: Use the specified image as application icon. This
		177	is used by many window managers, taskbars and pagers to represent the
		178	application window; resource I<iconFile>.
		179
181	=item B<-bg> I<colour>	180	=item B<-bg> I<colour>
182		181
183	Window background colour; resource B<background>.	182	Window background colour; resource B<background>.
184		183
185	=item B<-fg> I<colour>	184	=item B<-fg> I<colour>
186		185
187	Window foreground colour; resource B<foreground>.	186	Window foreground colour; resource B<foreground>.
188		187
189	=item B<-pixmap> I<file[;geom]>	188	=item B<-pixmap> I<file[;oplist]>
190		189
191	Compile I<afterimage>: Specify image file for the background and also	190	Compile I<afterimage> or I<pixbuf>: Specify image file for the background and also
192	optionally specify its scaling with a geometry string. Note you may need to	191	optionally specify a list of operations to modify it. Note you may need to
193	add quotes to avoid special shell interpretation of the C<;> in the	192	add quotes to avoid special shell interpretation of the C<;> in the
194	command-line; for more details see resource B<backgroundPixmap>.	193	command-line; for more details see resource B<backgroundPixmap>.
195		194
196	=item B<-cr> I<colour>	195	=item B<-cr> I<colour>
197		196
…		…
244	italic> >> characters are to be printed. See resource B<boldItalicFont>	243	italic> >> characters are to be printed. See resource B<boldItalicFont>
245	for details.	244	for details.
246		245
247	=item B<-is>\|B<+is>	246	=item B<-is>\|B<+is>
248		247
249	Compile I<font-styles>: Bold/Italic font styles imply high intensity	248	Compile I<font-styles>: Bold/Blink font styles imply high intensity
250	foreground/background (default). See resource B<intensityStyles> for	249	foreground/background (default). See resource B<intensityStyles> for
251	details.	250	details.
252		251
253	=item B<-name> I<name>	252	=item B<-name> I<name>
254		253
…		…
272		271
273	=item B<-sb>\|B<+sb>	272	=item B<-sb>\|B<+sb>
274		273
275	Turn on/off scrollbar; resource B<scrollBar>.	274	Turn on/off scrollbar; resource B<scrollBar>.
276		275
		276	=item B<-sr>\|B<+sr>
		277
		278	Put scrollbar on right/left; resource B<scrollBar_right>.
		279
		280	=item B<-st>\|B<+st>
		281
		282	Display rxvt (non XTerm/NeXT) scrollbar without/with a trough;
		283	resource B<scrollBar_floating>.
		284
277	=item B<-si>\|B<+si>	285	=item B<-si>\|B<+si>
278		286
279	Turn on/off scroll-to-bottom on TTY output inhibit; resource	287	Turn on/off scroll-to-bottom on TTY output inhibit; resource
280	B<scrollTtyOutput> has opposite effect.	288	B<scrollTtyOutput> has opposite effect.
281		289
…		…
287	=item B<-sw>\|B<+sw>	295	=item B<-sw>\|B<+sw>
288		296
289	Turn on/off scrolling with the scrollback buffer as new lines appear.	297	Turn on/off scrolling with the scrollback buffer as new lines appear.
290	This only takes effect if B<-si> is also given; resource	298	This only takes effect if B<-si> is also given; resource
291	B<scrollWithBuffer>.	299	B<scrollWithBuffer>.
292
293	=item B<-sr>\|B<+sr>
294
295	Put scrollbar on right/left; resource B<scrollBar_right>.
296
297	=item B<-st>\|B<+st>
298
299	Display rxvt (non XTerm/NeXT) scrollbar without/with a trough;
300	resource B<scrollBar_floating>.
301		300
302	=item B<-ptab>\|B<+ptab>	301	=item B<-ptab>\|B<+ptab>
303		302
304	If enabled (default), "Horizontal Tab" characters are being stored as	303	If enabled (default), "Horizontal Tab" characters are being stored as
305	actual wide characters in the screen buffer, which makes it possible to	304	actual wide characters in the screen buffer, which makes it possible to
…		…
309		308
310	=item B<-bc>\|B<+bc>	309	=item B<-bc>\|B<+bc>
311		310
312	Blink the cursor; resource B<cursorBlink>.	311	Blink the cursor; resource B<cursorBlink>.
313		312
		313	=item B<-uc>\|B<+uc>
		314
		315	Make the cursor underlined; resource B<cursorUnderline>.
		316
314	=item B<-iconic>	317	=item B<-iconic>
315		318
316	Start iconified, if the window manager supports that option.	319	Start iconified, if the window manager supports that option.
317	Alternative form is B<-ic>.	320	Alternative form is B<-ic>.
318		321
…		…
334		337
335	=item B<-bl>	338	=item B<-bl>
336		339
337	Compile I<frills>: Set MWM hints to request a borderless window, i.e.	340	Compile I<frills>: Set MWM hints to request a borderless window, i.e.
338	if honoured by the WM, the rxvt-unicode window will not have window	341	if honoured by the WM, the rxvt-unicode window will not have window
339	decorations; resource B<borderLess>.	342	decorations; resource B<borderLess>. If the window manager does not
		343	support MWM hints (e.g. kwin), enables override-redirect mode.
340		344
341	=item B<-override-redirect>	345	=item B<-override-redirect>
342		346
343	Compile I<frills>: Sets override-redirect on the window; resource	347	Compile I<frills>: Sets override-redirect on the window; resource
344	B<override-redirect>.	348	B<override-redirect>.
…		…
353	=item B<-lsp> I<number>	357	=item B<-lsp> I<number>
354		358
355	Compile I<frills>: Lines (pixel height) to insert between each row of	359	Compile I<frills>: Lines (pixel height) to insert between each row of
356	the display. Useful to work around font rendering problems; resource	360	the display. Useful to work around font rendering problems; resource
357	B<lineSpace>.	361	B<lineSpace>.
		362
		363	=item B<-letsp> I<number>
		364
		365	Compile I<frills>: Amount to adjust the computed character width by
		366	to control overall letter spacing. Negative values will tighten up the
		367	letter spacing, positive values will space letters out more. Useful to
		368	work around odd font metrics; resource B<letterSpace>.
358		369
359	=item B<-tn> I<termname>	370	=item B<-tn> I<termname>
360		371
361	This option specifies the name of the terminal type to be set in the	372	This option specifies the name of the terminal type to be set in the
362	B<TERM> environment variable. This terminal type must exist in the	373	B<TERM> environment variable. This terminal type must exist in the
…		…
417		428
418	=item B<-tcw>	429	=item B<-tcw>
419		430
420	Change the meaning of triple-click selection with the left mouse	431	Change the meaning of triple-click selection with the left mouse
421	button. Only effective when the original (non-perl) selection code is	432	button. Only effective when the original (non-perl) selection code is
422	in-use. Instead of selecting a full line it will extend the selection the	433	in-use. Instead of selecting a full line it will extend the selection to
423	end of the logical line only. resource B<tripleclickwords>.	434	the end of the logical line only. resource B<tripleclickwords>.
424		435
425	=item B<-insecure>	436	=item B<-insecure>
426		437
427	Enable "insecure" mode, which currently enables most of the escape	438	Enable "insecure" mode, which currently enables most of the escape
428	sequences that echo strings. See the resource B<insecure> for more	439	sequences that echo strings. See the resource B<insecure> for more
…		…
448		459
449	Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@	460	Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@
450	will not immediately destroy its window when the program executed within	461	will not immediately destroy its window when the program executed within
451	it exits. Instead, it will wait till it is being killed or closed by the	462	it exits. Instead, it will wait till it is being killed or closed by the
452	user; resource B<hold>.	463	user; resource B<hold>.
		464
		465	=item B<-cd> I<path>
		466
		467	Sets the working directory for the shell (or the command specified via
		468	B<-e>). The I<path> must be an absolute path and it must exist for
		469	@@RXVT_NAME@@ to start; resource B<chdir>.
		470
		471	=item B<-xrm> I<string>
		472
		473	Works like the X Toolkit option of the same name, by adding the I<string>
		474	as if it were specified in a resource file. Resource values specified this
		475	way take precedence over all other resource specifications.
		476
		477	Note that you need to use the I<same> syntax as in the .Xdefaults file,
		478	e.g. C<*.background: black>. Also note that all @@RXVT_NAME@@-specific
		479	options can be specified as long-options on the commandline, so use
		480	of B<-xrm> is mostly limited to cases where you want to specify other
		481	resources (e.g. for input methods) or for compatibility with other
		482	programs.
453		483
454	=item B<-keysym.>I<sym> I<string>	484	=item B<-keysym.>I<sym> I<string>
455		485
456	Remap a key symbol. See resource B<keysym>.	486	Remap a key symbol. See resource B<keysym>.
457		487
…		…
492	If this switch is given, @@RXVT_NAME@@ will not create any utmp/wtmp	522	If this switch is given, @@RXVT_NAME@@ will not create any utmp/wtmp
493	entries and will not tinker with pty/tty permissions - you have to do that	523	entries and will not tinker with pty/tty permissions - you have to do that
494	yourself if you want that.	524	yourself if you want that.
495		525
496	As an extremely special case, specifying C<-1> will completely suppress	526	As an extremely special case, specifying C<-1> will completely suppress
497	pty/tty operations.	527	pty/tty operations, which is probably only useful in conjunction with some
		528	perl extension that manages the terminal.
498		529
499	Here is a example in perl that illustrates how this option can be used (a	530	Here is a example in perl that illustrates how this option can be used (a
500	longer example is in F<doc/pty-fd>):	531	longer example is in F<doc/pty-fd>):
501		532
502	use IO::Pty;	533	use IO::Pty;
…		…
516	Comma-separated list of perl extension scripts to use (or not to use) in	547	Comma-separated list of perl extension scripts to use (or not to use) in
517	this terminal instance. See resource B<perl-ext> for details.	548	this terminal instance. See resource B<perl-ext> for details.
518		549
519	=back	550	=back
520		551
521	=head1 RESOURCES (available also as long-options)	552	=head1 RESOURCES
522		553
523	Note: `@@RXVT_NAME@@ --help' gives a list of all resources (long	554	Note: `@@RXVT_NAME@@ --help' gives a list of all resources (long
524	options) compiled into your version.	555	options) compiled into your version. All resources are also available as
		556	long-options.
525		557
526	You can set and change the resources using X11 tools like B<xrdb>. Many	558	You can set and change the resources using X11 tools like B<xrdb>. Many
527	distribution do also load settings from the B<~/.Xresources> file when X	559	distribution do also load settings from the B<~/.Xresources> file when X
528	starts. @@RXVT_NAME@@ will consult the following files/resources in order,	560	starts. @@RXVT_NAME@@ will consult the following files/resources in order,
529	with later settings overwriting earlier ones:	561	with later settings overwriting earlier ones:
530		562
531	1. system-wide app-defaults file, either locale-dependent OR global
532	2. app-defaults file in $XAPPLRESDIR	563	1. app-defaults file in $XAPPLRESDIR
		564	2. $HOME/.Xdefaults
533	3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults	565	3. RESOURCE_MANAGER property on root-window of screen 0
534	4. SCREEN_RESOURCES for the current screen	566	4. SCREEN_RESOURCES property on root-window of the current screen
535	5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename>	567	5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename>
		568	6. resources specified via -xrm on the commandline
536		569
537	Note that when reading X resources, B<@@RXVT_NAME@@> recognizes two class	570	Note that when reading X resources, B<@@RXVT_NAME@@> recognizes two class
538	names: B<Rxvt> and B<URxvt>. The class name B<Rxvt> allows resources	571	names: B<Rxvt> and B<URxvt>. The class name B<Rxvt> allows resources
539	common to both B<@@RXVT_NAME@@> and the original I<rxvt> to be easily	572	common to both B<@@RXVT_NAME@@> and the original I<rxvt> to be easily
540	configured, while the class name B<URxvt> allows resources unique to	573	configured, while the class name B<URxvt> allows resources unique to
…		…
550	=item B<depth:> I<bitdepth>	583	=item B<depth:> I<bitdepth>
551		584
552	Compile I<xft>: Attempt to find a visual with the given bit depth;	585	Compile I<xft>: Attempt to find a visual with the given bit depth;
553	option B<-depth>.	586	option B<-depth>.
554		587
		588	=item B<buffered:> I<boolean>
		589
		590	Compile I<xft>: Turn on/off double-buffering for xft (default enabled).
		591	On some card/driver combination enabling it slightly decreases
		592	performance, on most it greatly helps it. The slowdown is small, so it
		593	should normally be enabled.
		594
555	=item B<geometry:> I<geom>	595	=item B<geometry:> I<geom>
556		596
557	Create the window with the specified X window geometry [default 80x24];	597	Create the window with the specified X window geometry [default 80x24];
558	option B<-geometry>.	598	option B<-geometry>.
559		599
…		…
572	Use the specified colour for the colour value I<n>, where 0-7	612	Use the specified colour for the colour value I<n>, where 0-7
573	corresponds to low-intensity (normal) colours and 8-15 corresponds to	613	corresponds to low-intensity (normal) colours and 8-15 corresponds to
574	high-intensity (bold = bright foreground, blink = bright background)	614	high-intensity (bold = bright foreground, blink = bright background)
575	colours. The canonical names are as follows: 0=black, 1=red, 2=green,	615	colours. The canonical names are as follows: 0=black, 1=red, 2=green,
576	3=yellow, 4=blue, 5=magenta, 6=cyan, 7=white, but the actual colour	616	3=yellow, 4=blue, 5=magenta, 6=cyan, 7=white, but the actual colour
577	names used are listed in the B<COLORS AND GRAPHICS> section.	617	names used are listed in the B<COLOURS AND GRAPHICS> section.
578		618
579	Colours higher than 15 cannot be set using resources (yet), but can be	619	Colours higher than 15 cannot be set using resources (yet), but can be
580	changed using an escape command (see @@RXVT_NAME@@(7)).	620	changed using an escape command (see @@RXVT_NAME@@(7)).
581		621
582	Colours 16-79 form a standard 4x4x4 colour cube (the same as xterm with	622	Colours 16-79 form a standard 4x4x4 colour cube (the same as xterm with
…		…
593	=item B<colorUL:> I<colour>	633	=item B<colorUL:> I<colour>
594		634
595	Use the specified colour to display underlined characters when the	635	Use the specified colour to display underlined characters when the
596	foreground colour is the default.	636	foreground colour is the default.
597		637
598	=item B<colorRV:> I<colour>
599
600	Use the specified colour as the background for reverse video characters
601	when OPTION_HC is disabled (--disable-frills).
602
603	=item B<underlineColor:> I<colour>	638	=item B<underlineColor:> I<colour>
604		639
605	If set, use the specified colour as the colour for the underline	640	If set, use the specified colour as the colour for the underline
606	itself. If unset, use the foreground colour.	641	itself. If unset, use the foreground colour.
		642
		643	=item B<highlightColor:> I<colour>
		644
		645	If set, use the specified colour as the background for highlighted
		646	characters. If unset, use reverse video.
		647
		648	=item B<highlightTextColor:> I<colour>
		649
		650	If set and highlightColor is set, use the specified colour as the
		651	foreground for highlighted characters.
607		652
608	=item B<cursorColor:> I<colour>	653	=item B<cursorColor:> I<colour>
609		654
610	Use the specified colour for the cursor. The default is to use the	655	Use the specified colour for the cursor. The default is to use the
611	foreground colour; option B<-cr>.	656	foreground colour; option B<-cr>.
…		…
618		663
619	=item B<reverseVideo:> I<boolean>	664	=item B<reverseVideo:> I<boolean>
620		665
621	B<True>: simulate reverse video by foreground and background colours;	666	B<True>: simulate reverse video by foreground and background colours;
622	option B<-rv>. B<False>: regular screen colours [default]; option	667	option B<-rv>. B<False>: regular screen colours [default]; option
623	B<+rv>. See note in B<COLORS AND GRAPHICS> section.	668	B<+rv>. See note in B<COLOURS AND GRAPHICS> section.
624		669
625	=item B<jumpScroll:> I<boolean>	670	=item B<jumpScroll:> I<boolean>
626		671
627	B<True>: specify that jump scrolling should be used. When receiving lots	672	B<True>: specify that jump scrolling should be used. When receiving lots
628	of lines, @@RXVT_NAME@@ will only scroll once a whole screen height of lines	673	of lines, @@RXVT_NAME@@ will only scroll once a whole screen height of lines
…		…
642		687
643	B<False>: specify that everything is to be displayed, even	688	B<False>: specify that everything is to be displayed, even
644	if the refresh is too fast for the human eye to read anything (or the	689	if the refresh is too fast for the human eye to read anything (or the
645	monitor to display anything); option B<+ss>.	690	monitor to display anything); option B<+ss>.
646		691
647	=item B<inheritPixmap:> I<boolean>	692	=item B<transparent:> I<boolean>
648		693
649	B<True>: make the background inherit the parent windows' pixmap, giving	694	Turn on/off pseudo-transparency by using the root pixmap as background.
650	artificial transparency. B<False>: do not inherit the parent windows'
651	pixmap.
652		695
653	I<Please note that transparency of any kind if completely unsupported by	696	B<inheritPixmap> is still accepted as an obsolete alias but will be removed in
654	the author. Don't bug him with installation questions!>	697	future versions.
655		698
656	=item B<fading:> I<number>	699	=item B<fading:> I<number>
657		700
658	Fade the text by the given percentage when focus is lost; option B<-fade>.	701	Fade the text by the given percentage when focus is lost; option B<-fade>.
659		702
…		…
662	Fade to this colour, when fading is used (see B<fading:>). The default	705	Fade to this colour, when fading is used (see B<fading:>). The default
663	colour is black; option B<-fadecolor>.	706	colour is black; option B<-fadecolor>.
664		707
665	=item B<tintColor:> I<colour>	708	=item B<tintColor:> I<colour>
666		709
667	Tint the transparent background pixmap with the given colour; option	710	Tint the transparent background with the given colour. If the RENDER
668	B<-tint>.	711	extension is not available only black, red, green, yellow, blue,
		712	magenta, cyan and white tints can be performed server-side. Note that
		713	a black tint yields a completely black image while a white tint yields
		714	the image unchanged; option B<-tint>.
669		715
670	=item B<shading:> I<number>	716	=item B<shading:> I<number>
671		717
672	Darken (0 .. 100) or lighten (-1 .. -100) the transparent background image	718	Darken (0 .. 99) or lighten (101 .. 200) the transparent background.
673	in addition to tinting it; option B<-sh>.	719	A value of 100 means no shading; option B<-sh>.
674		720
675	=item B<blendType:> I<string>	721	=item B<blendType:> I<string>
676		722
677	Specify background blending type; option B<-blt>.	723	Specify background blending type; option B<-blt>.
678		724
679	=item B<blurRadius:> I<number>	725	=item B<blurRadius:> I<number>
680		726
681	Apply Gaussian Blurr with the specified radius to the transparent	727	Apply gaussian blur with the specified radius to the transparent
682	background image; option B<-blr>.	728	background; option B<-blr>.
		729
		730	=item B<iconFile:> I<file>
		731
		732	Set the application icon pixmap; option B<-icon>.
683		733
684	=item B<scrollColor:> I<colour>	734	=item B<scrollColor:> I<colour>
685		735
686	Use the specified colour for the scrollbar [default #B2B2B2].	736	Use the specified colour for the scrollbar [default #B2B2B2].
687		737
…		…
693	=item B<borderColor:> I<colour>	743	=item B<borderColor:> I<colour>
694		744
695	The colour of the border around the text area and between the scrollbar	745	The colour of the border around the text area and between the scrollbar
696	and the text.	746	and the text.
697		747
698	=item B<backgroundPixmap:> I<file[;geom]>	748	=item B<backgroundPixmap:> I<file[;oplist]>
699		749
700	Use the specified image file for the background and also optionally	750	Use the specified image file for the background and also
701	specify its scaling with a geometry string B<WxH+X+Y>,	751	optionally specify a colon separated list of operations to modify it.
702	in which B<"W" / "H"> specify the horizontal/vertical scale (percent),	752	Supported operations are:
		753
		754	=over 4
		755
		756	=item B<WxH+X+Y>
		757
		758	sets scale and position. B<"W" / "H"> specify the horizontal/vertical
703	and B<"X" / "Y"> locate the image centre (percent).	759	scale (percent), and B<"X" / "Y"> locate the image centre (percent). A
704	A scale of 0 displays the image with tiling. A scale of 1 displays the	760	scale of 0 disables scaling. The maximum permitted scale is 1000.
705	image without any scaling. A scale of 2 to 9 specifies an integer	761
706	number of images in that direction. No image will be magnified beyond	762	=item B<op=tile>
707	10 times its original size. The maximum permitted scale is 1000.	763
708	Special string of B<"auto"> used as a geometry will cause image to be	764	enables tiling
709	automatically scaled to match window size.	765
		766	=item B<op=pscale>
		767
		768	enables proportional scaling
		769
		770	=item B<op=root>
		771
		772	use the position of the terminal window relative to the root window as
		773	the image offset, simulating a root window background
		774
		775	=back
		776
		777	The default scale and position setting is C<100x100+50+50>.
		778	Alternatively, a predefined set of templates can be used to achieve
		779	the most common setups:
		780
		781	=over 4
		782
		783	=item B<style=tiled>
		784
		785	the image is tiled with no scaling. Equivalent to 0x0+0+0:op=tile
		786
		787	=item B<style=aspect-stretched>
		788
		789	the image is scaled to fill the whole window maintaining the aspect
		790	ratio and centered. Equivalent to 100x100+50+50:op=pscale
		791
		792	=item B<style=stretched>
		793
		794	the image is scaled to fill the whole window. Equivalent to 100x100
		795
		796	=item B<style=centered>
		797
		798	the image is centered with no scaling. Equivalent to 0x0+50+50
		799
		800	=item B<style=root-tiled>
		801
		802	the image is tiled with no scaling and using 'root' positioning.
		803	Equivalent to 0x0:op=tile:op=root
		804
		805	=back
		806
		807	If multiple templates are specified the last one wins. Note that a
		808	template overrides all the scale, position and operations settings.
		809
710	If used in conjunction with B<-tr> option - specified pixmap will be	810	If used in conjunction with B<-tr> option, the specified pixmap will be
711	blended over transparency image using either alpha-blending, or any	811	blended over the transparent background using alpha-blending. If I<afterimage>
712	other blending type, specified with B<-blt "type"> option.	812	support has been compiled in it is possible to choose other blending
713	[default 0x0+50+50]	813	types with B<-blt "type"> option.
714		814
715	=item B<path:> I<path>	815	=item B<path:> I<path>
716		816
717	Specify the colon-delimited search path for finding background image files.	817	Specify the colon-delimited search path for finding background image files.
718		818
…		…
745	it is named first) and thus defines the character cell grid to be 9 pixels	845	it is named first) and thus defines the character cell grid to be 9 pixels
746	wide and 15 pixels high.	846	wide and 15 pixels high.
747		847
748	The second font is just used to add additional unicode characters not in	848	The second font is just used to add additional unicode characters not in
749	the base font, likewise the third, which is unfortunately non-bold, but	849	the base font, likewise the third, which is unfortunately non-bold, but
750	the bold version of the font does contain less characters, so this is a	850	the bold version of the font does contain fewer characters, so this is a
751	useful supplement.	851	useful supplement.
752		852
753	The third font is an Xft font with aliasing turned off, and the characters	853	The third font is an Xft font with aliasing turned off, and the characters
754	are limited to the B<JIS 0208> codeset (i.e. japanese kanji). The font	854	are limited to the B<JIS 0208> codeset (i.e. japanese kanji). The font
755	contains other characters, but we are not interested in them.	855	contains other characters, but we are not interested in them.
…		…
779	text font will being used for the given style.	879	text font will being used for the given style.
780		880
781	=item B<intensityStyles:> I<boolean>	881	=item B<intensityStyles:> I<boolean>
782		882
783	When font styles are not enabled, or this option is enabled (B<True>,	883	When font styles are not enabled, or this option is enabled (B<True>,
784	option B<-is>, the default), bold and italic font styles imply high	884	option B<-is>, the default), bold/blink font styles imply high
785	intensity foreground/background colours. Disabling this option (B<False>,	885	intensity foreground/background colours. Disabling this option (B<False>,
786	option B<+is>) disables this behaviour, the high intensity colours are not	886	option B<+is>) disables this behaviour, the high intensity colours are not
787	reachable.	887	reachable.
788		888
789	=item B<selectstyle:> I<mode>
790
791	Set mouse selection style to B<old> which is 2.20, B<oldword> which
792	is xterm style with 2.20 old word selection, or anything else which
793	gives xterm style selection. Only effective when the original (non-perl)
794	selection code is in use.
795
796	=item B<scrollstyle:> I<mode>
797
798	Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is
799	the author's favourite.
800
801	=item B<title:> I<string>	889	=item B<title:> I<string>
802		890
803	Set window title string, the default title is the command-line	891	Set window title string, the default title is the command-line
804	specified after the B<-e> option, if any, otherwise the application	892	specified after the B<-e> option, if any, otherwise the application
805	name; option B<-title>.	893	name; option B<-title>.
…		…
818	=item B<urgentOnBell:> I<boolean>	906	=item B<urgentOnBell:> I<boolean>
819		907
820	B<True>: set the urgency hint for the wm on receipt of a bell character.	908	B<True>: set the urgency hint for the wm on receipt of a bell character.
821	B<False>: do not set the urgency hint [default].	909	B<False>: do not set the urgency hint [default].
822		910
		911	@@RXVT_NAME@@ resets the urgency hint on every focus change.
		912
823	=item B<visualBell:> I<boolean>	913	=item B<visualBell:> I<boolean>
824		914
825	B<True>: use visual bell on receipt of a bell character; option B<-vb>.	915	B<True>: use visual bell on receipt of a bell character; option B<-vb>.
826	B<False>: no visual bell [default]; option B<+vb>.	916	B<False>: no visual bell [default]; option B<+vb>.
827		917
…		…
850	URxvt.print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX)	940	URxvt.print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX)
851		941
852	This creates a new file in your home directory with the screen contents	942	This creates a new file in your home directory with the screen contents
853	every time you hit C<Print>.	943	every time you hit C<Print>.
854		944
		945	=item B<scrollstyle:> I<mode>
		946
		947	Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is
		948	the author's favourite.
		949
		950	=item B<thickness:> I<number>
		951
		952	Set the scrollbar width in pixels.
		953
855	=item B<scrollBar:> I<boolean>	954	=item B<scrollBar:> I<boolean>
856		955
857	B<True>: enable the scrollbar [default]; option B<-sb>. B<False>:	956	B<True>: enable the scrollbar [default]; option B<-sb>. B<False>:
858	disable the scrollbar; option B<+sb>.	957	disable the scrollbar; option B<+sb>.
859		958
…		…
878	B<False>: do not scroll to bottom when tty receives output; option	977	B<False>: do not scroll to bottom when tty receives output; option
879	B<+si>.	978	B<+si>.
880		979
881	=item B<scrollWithBuffer:> I<boolean>	980	=item B<scrollWithBuffer:> I<boolean>
882		981
883	B<True>: scroll with scrollback buffer when tty receives new lines (and	982	B<True>: scroll with scrollback buffer when tty receives new lines (i.e.
884	B<scrollTtyOutput> is False); option B<-sw>. B<False>: do not scroll	983	try to show the same lines) and B<scrollTtyOutput> is False; option
885	with scrollback buffer when tty receives new lines; option B<+sw>.	984	B<-sw>. B<False>: do not scroll with scrollback buffer when tty receives
		985	new lines; option B<+sw>.
886		986
887	=item B<scrollTtyKeypress:> I<boolean>	987	=item B<scrollTtyKeypress:> I<boolean>
888		988
889	B<True>: scroll to bottom when a non-special key is pressed. Special keys	989	B<True>: scroll to bottom when a non-special key is pressed. Special keys
890	are those which are intercepted by rxvt-unicode for special handling and	990	are those which are intercepted by rxvt-unicode for special handling and
…		…
946	=item B<cursorBlink:> I<boolean>	1046	=item B<cursorBlink:> I<boolean>
947		1047
948	B<True>: blink the cursor. B<False>: do not blink the cursor [default];	1048	B<True>: blink the cursor. B<False>: do not blink the cursor [default];
949	option B<-bc>.	1049	option B<-bc>.
950		1050
		1051	=item B<cursorUnderline:> I<boolean>
		1052
		1053	B<True>: Make the cursor underlined. B<False>: Make the cursor a box [default];
		1054	option B<-uc>.
		1055
951	=item B<pointerBlank:> I<boolean>	1056	=item B<pointerBlank:> I<boolean>
952		1057
953	B<True>: blank the pointer when a key is pressed or after a set number	1058	B<True>: blank the pointer when a key is pressed or after a set number
954	of seconds of inactivity. B<False>: the pointer is always visible	1059	of seconds of inactivity. B<False>: the pointer is always visible
955	[default].	1060	[default].
…		…
968	large number (e.g. C<987654321>) to effectively disable the timeout.	1073	large number (e.g. C<987654321>) to effectively disable the timeout.
969		1074
970	=item B<backspacekey:> I<string>	1075	=item B<backspacekey:> I<string>
971		1076
972	The string to send when the backspace key is pressed. If set to B<DEC>	1077	The string to send when the backspace key is pressed. If set to B<DEC>
973	or unset it will send B<Delete> (code 127) or, if shifted, B<Backspace>	1078	or unset it will send B<Delete> (code 127) or, with control, B<Backspace>
974	(code 8) - which can be reversed with the appropriate DEC private mode	1079	(code 8) - which can be reversed with the appropriate DEC private mode
975	escape sequence.	1080	escape sequence.
976		1081
977	=item B<deletekey:> I<string>	1082	=item B<deletekey:> I<string>
978		1083
…		…
991	will be created). In this mode, characters outside ISO-8859-1 can be used.	1096	will be created). In this mode, characters outside ISO-8859-1 can be used.
992		1097
993	When the selection extension is not used, only ISO-8859-1 characters can	1098	When the selection extension is not used, only ISO-8859-1 characters can
994	be used. If not specified, the built-in default is used:	1099	be used. If not specified, the built-in default is used:
995		1100
996	B<< BACKSLASH `"'&()*,;<=>?@[]{\|} >>	1101	B<< BACKSLASH `"'&()*,;<=>?@[]^{\|} >>
997		1102
998	=item B<preeditType:> I<style>	1103	=item B<preeditType:> I<style>
999		1104
1000	B<OverTheSpot>, B<OffTheSpot>, B<Root>; option B<-pt>.	1105	B<OverTheSpot>, B<OffTheSpot>, B<Root>; option B<-pt>.
1001		1106
…		…
1057		1162
1058	=item B<secondaryScroll:> I<boolean>	1163	=item B<secondaryScroll:> I<boolean>
1059		1164
1060	Turn on/off secondary screen scroll (default enabled). If this	1165	Turn on/off secondary screen scroll (default enabled). If this
1061	option is enabled, scrolls on the secondary screen will change the	1166	option is enabled, scrolls on the secondary screen will change the
1062	scrollback buffer and switching to/from the secondary screen will	1167	scrollback buffer and, when secondaryScreen is off, switching
1063	instead scroll the screen up.	1168	to/from the secondary screen will instead scroll the screen up.
1064		1169
1065	=item B<hold>: I<boolean>	1170	=item B<hold>: I<boolean>
1066		1171
1067	Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@	1172	Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@
1068	will not immediately destroy its window when the program executed within	1173	will not immediately destroy its window when the program executed within
1069	it exits. Instead, it will wait till it is being killed or closed by the	1174	it exits. Instead, it will wait till it is being killed or closed by the
1070	user.	1175	user.
		1176
		1177	=item B<chdir>: I<path>
		1178
		1179	Sets the working directory for the shell (or the command specified via
		1180	B<-e>). The I<path> must be an absolute path and it must exist for
		1181	@@RXVT_NAME@@ to start. If it isn't specified then the current working
		1182	directory will be used; option B<-cd>.
1071		1183
1072	=item B<keysym.>I<sym>: I<string>	1184	=item B<keysym.>I<sym>: I<string>
1073		1185
1074	Compile I<frills>: Associate I<string> with keysym I<sym>. The	1186	Compile I<frills>: Associate I<string> with keysym I<sym>. The
1075	intervening resource name B<keysym.> cannot be omitted.	1187	intervening resource name B<keysym.> cannot be omitted.
…		…
1090	omitting the prefix B<XK_>. Alternatively you can specify I<key> by its hex	1202	omitting the prefix B<XK_>. Alternatively you can specify I<key> by its hex
1091	keysym value (B<0x0000 - 0xFFFF>). Note that the lookup of I<sym>s is not	1203	keysym value (B<0x0000 - 0xFFFF>). Note that the lookup of I<sym>s is not
1092	performed in an exact manner; however, the closest match is assured.	1204	performed in an exact manner; however, the closest match is assured.
1093		1205
1094	I<string> may contain escape values (C<\n>: newline, C<\000>: octal	1206	I<string> may contain escape values (C<\n>: newline, C<\000>: octal
1095	number), see RESOURCES in C<man 7 X> for futher details.	1207	number), see RESOURCES in C<man 7 X> for further details.
1096		1208
1097	You can define a range of keysyms in one shot by providing a I<string>	1209	You can define a range of keysyms in one shot by
		1210	loading the C<keysym-list> perl extension and providing a I<string>
1098	with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimiter `/'	1211	with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimiter `/'
1099	should be a character not used by the strings.	1212	should be a character not used by the strings.
1100		1213
1101	Its usage can be demonstrated by an example:	1214	Its usage can be demonstrated by an example:
1102		1215
1103	URxvt.keysym.M-C-0x61: list\|\033<M-C-\|abc\|>	1216	URxvt.keysym.M-C-0x61: list\|\033<\|abc\|>
1104		1217
1105	The above line is equivalent to the following three lines:	1218	The above line is equivalent to the following three lines:
1106		1219
1107	URxvt.keysym.Meta-Control-0x61: \033<M-C-a>	1220	URxvt.keysym.Meta-Control-0x61: \033<a>
1108	URxvt.keysym.Meta-Control-0x62: \033<M-C-b>	1221	URxvt.keysym.Meta-Control-0x62: \033<b>
1109	URxvt.keysym.Meta-Control-0x63: \033<M-C-c>	1222	URxvt.keysym.Meta-Control-0x63: \033<c>
1110		1223
1111	If I<string> takes the form of C<command:STRING>, the specified B<STRING>	1224	If I<string> takes the form of C<command:STRING>, the specified B<STRING>
1112	is interpreted and executed as @@RXVT_NAME@@'s control sequence. For	1225	is interpreted and executed as @@RXVT_NAME@@'s control sequence. For
1113	example the following means "change the current locale to C<zh_CN.GBK>	1226	example the following means "change the current locale to C<zh_CN.GBK>
1114	when Control-Meta-c is being pressed":	1227	when Control-Meta-c is being pressed":
1115		1228
1116	URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007	1229	URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007
1117		1230
1118	If I<string> takes the form C<perl:STRING>, then the specified B<STRING>	1231	If I<string> takes the form C<perl:STRING>, then the specified B<STRING>
1119	is passed to the C<on_keyboard_command> perl handler. See the @@RXVT_NAME@@perl(3)	1232	is passed to the C<on_user_command> perl handler. See the @@RXVT_NAME@@perl(3)
1120	manpage. For example, the F<selection> extension (activated via	1233	manpage. For example, the F<selection> extension (activated via
1121	C<@@RXVT_NAME@@ -pe selection>) listens for C<selection:rot13> events:	1234	C<@@RXVT_NAME@@ -pe selection>) listens for C<selection:rot13> events:
1122		1235
1123	URxvt.keysym.M-C-c: perl:selection:rot13	1236	URxvt.keysym.M-C-c: perl:selection:rot13
1124		1237
1125	Due the the large number of modifier combinations, a defined key mapping	1238	Due the the large number of modifier combinations, a defined key mapping
1126	will match if at I<at least> the specified identifiers are being set, and	1239	will match if I<at least> the specified identifiers are being set, and
1127	no other key mappings with those and more bits are being defined. That	1240	no other key mappings with those and more bits are being defined. That
1128	means that defining a key map for C<a> will automatically provide	1241	means that defining a key map for C<a> will automatically provide
1129	definitions for C<Meta-a>, C<Shift-a> and so on, unless some of those are defined	1242	definitions for C<Meta-a>, C<Shift-a> and so on, unless some of those are defined
1130	mappings themselves.	1243	mappings themselves.
1131		1244
…		…
1182	all instances, while B<perl-ext> is used for specific instances.	1295	all instances, while B<perl-ext> is used for specific instances.
1183		1296
1184	=item B<perl-eval>: I<string>	1297	=item B<perl-eval>: I<string>
1185		1298
1186	Perl code to be evaluated when all extensions have been registered. See	1299	Perl code to be evaluated when all extensions have been registered. See
1187	the @@RXVT_NAME@@perl(3) manpage. Due to security reasons, this resource	1300	the @@RXVT_NAME@@perl(3) manpage.
1188	will be ignored when running setuid/setgid.
1189		1301
1190	=item B<perl-lib>: I<path>	1302	=item B<perl-lib>: I<path>
1191		1303
1192	Colon-separated list of additional directories that hold extension	1304	Colon-separated list of additional directories that hold extension
1193	scripts. When looking for extensions specified by the C<perl> resource,	1305	scripts. When looking for perl extensions, @@RXVT_NAME@@ will first
1194	@@RXVT_NAME@@ will first look in these directories and then in	1306	look in these directories, then in $HOME/.urxvt/ext and lastly in
1195	F<@@RXVT_LIBDIR@@/urxvt/perl/>. Due to security reasons, this resource	1307	F<@@RXVT_LIBDIR@@/urxvt/perl/>.
1196	will be ignored when running setuid/setgid.
1197		1308
1198	See the @@RXVT_NAME@@perl(3) manpage.	1309	See the @@RXVT_NAME@@perl(3) manpage.
1199		1310
1200	=item B<< selection.pattern-I<idx> >>: I<perl-regex>	1311	=item B<< selection.pattern-I<idx> >>: I<perl-regex>
1201		1312
…		…
1223		1334
1224	=item B<override-redirect>: I<boolean>	1335	=item B<override-redirect>: I<boolean>
1225		1336
1226	Compile I<frills>: Sets override-redirect for the terminal window, making	1337	Compile I<frills>: Sets override-redirect for the terminal window, making
1227	it almost invisible to window managers; option B<-override-redirect>.	1338	it almost invisible to window managers; option B<-override-redirect>.
		1339
		1340	=item B<iso14755:> I<boolean>
		1341
		1342	Turn on/off ISO 14755 (default enabled).
1228		1343
1229	=item B<iso14755_52:> I<boolean>	1344	=item B<iso14755_52:> I<boolean>
1230		1345
1231	Turn on/off ISO 14755 5.2 mode (default enabled).	1346	Turn on/off ISO 14755 5.2 mode (default enabled).
1232		1347
…		…
1375	B<@@RXVT_NAME@@> tries to write an entry into the I<utmp>(5) file so that	1490	B<@@RXVT_NAME@@> tries to write an entry into the I<utmp>(5) file so that
1376	it can be seen via the I<who(1)> command, and can accept messages. To	1491	it can be seen via the I<who(1)> command, and can accept messages. To
1377	allow this feature, B<@@RXVT_NAME@@> may need to be installed setuid root	1492	allow this feature, B<@@RXVT_NAME@@> may need to be installed setuid root
1378	on some systems or setgid to root or to some other group on others.	1493	on some systems or setgid to root or to some other group on others.
1379		1494
1380	=head1 COLORS AND GRAPHICS	1495	=head1 COLOURS AND GRAPHICS
1381		1496
1382	In addition to the default foreground and background colours,	1497	In addition to the default foreground and background colours,
1383	B<@@RXVT_NAME@@> can display up to 16 colours (8 ANSI colours plus	1498	B<@@RXVT_NAME@@> can display up to 88/256 colours: 8 ANSI colours plus
1384	high-intensity bold/blink versions of the same). Here is a list of the	1499	high-intensity (potentially bold/blink) versions of the same, and 72 (or
1385	colours with their names.	1500	240 in 256 colour mode) colours arranged in an 4x4x4 (or 6x6x6) colour RGB
		1501	cube plus a 8 (24) colour greyscale ramp.
		1502
		1503	Here is a list of the ANSI colours with their names.
1386		1504
1387	=begin table	1505	=begin table
1388		1506
1389	B<color0> (black) = Black	1507	B<color0> (black) = Black
1390	B<color1> (red) = Red3	1508	B<color1> (red) = Red3
…		…
1410	It is also possible to specify the colour values of B<foreground>,	1528	It is also possible to specify the colour values of B<foreground>,
1411	B<background>, B<cursorColor>, B<cursorColor2>, B<colorBD>, B<colorUL> as	1529	B<background>, B<cursorColor>, B<cursorColor2>, B<colorBD>, B<colorUL> as
1412	a number 0-15, as a convenient shorthand to reference the colour name of	1530	a number 0-15, as a convenient shorthand to reference the colour name of
1413	color0-color15.	1531	color0-color15.
1414		1532
1415	In addition to the colours defined above, @@RXVT_NAME@@ offers an	1533	The following text gives values for the standard 88 colour mode (and
1416	additional 72 colours. The first 64 of those (with indices 16 to 79)	1534	values for the 256 colour mode in parentheses).
1417	consist of a 444 RGB colour cube (i.e. I<index = r * 16 + g * 4 + b +
1418	16>), followed by 8 additional shades of gray (with indices 80 to 87).
1419		1535
		1536	The RGB cube uses indices 16..79 (16..231) using the following formulas:
		1537
		1538	index_88 = (r * 4 + g) * 4 + b + 16 # r, g, b = 0..3
		1539	index_256 = (r * 16 + g) * 16 + b + 16 # r, g, b = 0..15
		1540
		1541	The grayscale ramp uses indices 80..87 (232..239), from 10% to 90% in 10%
		1542	steps (1/26 to 25/26 in 1/26 steps) - black and white are already part of
		1543	the RGB cube.
		1544
1420	Together, all those colours implement the 88 colour xterm colours. Only	1545	Together, all those colours implement the 88 (256) colour xterm
1421	the first 16 can be changed using resources currently, the rest can only	1546	colours. Only the first 16 can be changed using resources currently, the
1422	be changed via command sequences ("escape codes").	1547	rest can only be changed via command sequences ("escape codes").
		1548
		1549	Applications are advised to use terminfo or command sequences to discover
		1550	number and RGB values of all colours (yes, you can query this...).
1423		1551
1424	Note that B<-rv> (B<"reverseVideo: True">) simulates reverse video by	1552	Note that B<-rv> (B<"reverseVideo: True">) simulates reverse video by
1425	always swapping the foreground/background colours. This is in contrast to	1553	always swapping the foreground/background colours. This is in contrast to
1426	I<xterm>(1) where the colours are only swapped if they have not otherwise	1554	I<xterm>(1) where the colours are only swapped if they have not otherwise
1427	been specified. For example,	1555	been specified. For example,
1428		1556
1429	=over 4
1430
1431	=item B<@@RXVT_NAME@@ -fg Black -bg White -rv>	1557	@@RXVT_NAME@@ -fg Black -bg White -rv
1432		1558
1433	would yield White on Black, while on I<xterm>(1) it would yield Black	1559	would yield White on Black, while on I<xterm>(1) it would yield Black on
1434	on White.	1560	White.
1435
1436	=back
1437		1561
1438	=head2 ALPHA CHANNEL SUPPORT	1562	=head2 ALPHA CHANNEL SUPPORT
1439		1563
1440	If Xft support has been compiled in and as long as Xft/Xrender/X don't get	1564	If Xft support has been compiled in and as long as Xft/Xrender/X don't get
1441	their act together, rxvt-unicode will support C<rgba:rrrr/gggg/bbbb/aaaa>	1565	their act together, rxvt-unicode will do it's own alpha channel management:
1442	(recommended, but B<MUST> have 4 digits/component) colour specifications,	1566
1443	in addition to the ones provided by X, where the additional A component	1567	You can prefix any colour with an opaqueness percentage enclosed in
		1568	brackets, i.e. C<[percent]>, where C<percent> is a decimal percentage
		1569	(0-100) that specifies the opacity of the colour, where C<0> is completely
		1570	transparent and C<100> is completely opaque. For example, C<[50]red> is a
		1571	half-transparent red, while C<[95]#00ff00> is an almost opaque green. This
		1572	is the recommended format to specify transparency values, and works with
		1573	all ways to specify a colour.
		1574
		1575	For complete control, rxvt-unicode also supports
		1576	C<rgba:rrrr/gggg/bbbb/aaaa> (exactly four hex digits/component) colour
		1577	specifications, where the additional C<aaaa> component specifies opacity
1444	specifies opacity (alpha) values. The minimum value of C<0> is completely	1578	(alpha) values. The minimum value of C<0000> is completely transparent,
1445	transparent). You can also prefix any color with C<[percent]>, where	1579	while C<ffff> is completely opaque). The two example colours from
1446	C<percent> is a decimal percentage (0-100) that specifies the opacity of	1580	earlier could also be specified as C<rgba:ff00/0000/0000/8000> and
1447	the color, where C<0> is completely transparent and C<100> is completelxy	1581	C<rgba:0000/ff00/0000/f332>.
1448	opaque.
1449		1582
1450	You probably need to specify B<"-depth 32">, too, and have the luck that	1583	You probably need to specify B<"-depth 32">, too, to force a visual with
1451	your X-server uses ARGB pixel layout, as X is far from just supporting	1584	alpha channels, and have the luck that your X-server uses ARGB pixel
1452	ARGB visuals out of the box, and rxvt-unicode just fudges around.	1585	layout, as X is far from just supporting ARGB visuals out of the box, and
		1586	rxvt-unicode just fudges around.
1453		1587
1454	For example, the following selects an almost completely transparent red	1588	For example, the following selects an almost completely transparent black
1455	background, and an almost opaque pink foreground:	1589	background, and an almost opaque pink foreground:
1456		1590
1457	@@RXVT_NAME@@ -depth 32 -bg rgba:0000/0000/0000/aaaa -fg "[80]pink"	1591	@@RXVT_NAME@@ -depth 32 -bg rgba:0000/0000/0000/4444 -fg "[80]pink"
1458		1592
1459	I<Please note that transparency of any kind if completely unsupported by	1593	When not using a background image, then the interpretation of the
1460	the author. Don't bug him with installation questions!>	1594	alpha channel is up to your compositing manager (most interpret it as
		1595	transparency of course).
		1596
		1597	When using a background pixmap or pseudo-transparency, then the background
		1598	colour will always behave as if it were completely transparent (so the
		1599	background image shows instead), regardless of how it was specified, while
		1600	other colours will either be transparent as specified (the background
		1601	image will show through) on servers supporting the RENDER extension, or
		1602	fully opaque on servers not supporting the RENDER EXTENSION.
		1603
		1604	Please note that due to bugs in Xft, specifying alpha values might result
		1605	in garbage being displayed when the X-server does not support the RENDER
		1606	extension.
1461		1607
1462	=head1 ENVIRONMENT	1608	=head1 ENVIRONMENT
1463		1609
1464	B<@@RXVT_NAME@@> sets and/or uses the following environment variables:	1610	B<@@RXVT_NAME@@> sets and/or uses the following environment variables:
1465		1611
…		…
1471	resources or on the command line.	1617	resources or on the command line.
1472		1618
1473	=item B<COLORTERM>	1619	=item B<COLORTERM>
1474		1620
1475	Either C<rxvt>, C<rxvt-xpm>, depending on whether @@RXVT_NAME@@ was	1621	Either C<rxvt>, C<rxvt-xpm>, depending on whether @@RXVT_NAME@@ was
1476	compiled with background image support, and optionally with the added	1622	compiled with background image support, and optionally with the added
1477	extension C<-mono> to indicate that rxvt-unicode runs on a monochrome	1623	extension C<-mono> to indicate that rxvt-unicode runs on a monochrome
1478	screen.	1624	screen.
1479		1625
1480	=item B<COLORFGBG>	1626	=item B<COLORFGBG>
1481		1627
1482	Set to a string of the form C<fg;bg> or C<fg;xpm;bg>, where C<fg> is	1628	Set to a string of the form C<fg;bg> or C<fg;xpm;bg>, where C<fg> is
1483	the colour code used as default foreground/text colour (or the string	1629	the colour code used as default foreground/text colour (or the string
1484	C<default> to indicate that the default-colour escape sequence is to be	1630	C<default> to indicate that the default-colour escape sequence is to be
1485	used), C<bg> is the colour code used as default background colour (or the	1631	used), C<bg> is the colour code used as default background colour (or the
1486	string C<default>), and C<xpm> is the string C<default> if @@RXVT_NAME@@	1632	string C<default>), and C<xpm> is the string C<default> if @@RXVT_NAME@@
1487	was compiled with background image support. Libraries like C<ncurses>	1633	was compiled with background image support. Libraries like C<ncurses>
1488	and C<slang> can (and do) use this information to optimize screen output.	1634	and C<slang> can (and do) use this information to optimize screen output.
1489		1635
1490	=item B<WINDOWID>	1636	=item B<WINDOWID>
1491		1637
1492	Set to the (decimal) X Window ID of the @@RXVT_NAME@@ window (the toplevel	1638	Set to the (decimal) X Window ID of the @@RXVT_NAME@@ window (the toplevel
…		…
1499	C<--with-terminfo=PATH>.	1645	C<--with-terminfo=PATH>.
1500		1646
1501	=item B<DISPLAY>	1647	=item B<DISPLAY>
1502		1648
1503	Used by @@RXVT_NAME@@ to connect to the display and set to the correct	1649	Used by @@RXVT_NAME@@ to connect to the display and set to the correct
1504	display in its child processes.	1650	display in its child processes if C<-display> isn't used to override. It
		1651	defaults to C<:0> if it doesn't exist.
1505		1652
1506	=item B<SHELL>	1653	=item B<SHELL>
1507		1654
1508	The shell to be used for command execution, defaults to C</bin/sh>.	1655	The shell to be used for command execution, defaults to C</bin/sh>.
1509		1656
1510	=item B<RXVT_SOCKET>	1657	=item B<RXVT_SOCKET>
1511		1658
1512	The unix domain socket path used by @@RXVT_NAME@@c(1) and	1659	The unix domain socket path used by @@RXVT_NAME@@c(1) and
1513	@@RXVT_NAME@@d(1).	1660	@@RXVT_NAME@@d(1).
1514		1661
1515	Default F<<< $HOME/.rxvt-unicode-I<< <nodename >> >>>.	1662	Default F<<< $HOME/.urxvt/urxvtd-I<< <nodename> >> >>>.
1516		1663
1517	=item B<HOME>	1664	=item B<HOME>
1518		1665
1519	Used to locate the default directory for the unix domain socket for	1666	Used to locate the default directory for the unix domain socket for
1520	daemon communications and to locate various resource files (such as	1667	daemon communications and to locate various resource files (such as
1521	C<.Xdefaults>)	1668	C<.Xdefaults>)
1522		1669
1523	=item B<XAPPLRESDIR>	1670	=item B<XAPPLRESDIR>
1524		1671
1525	Directory where various X resource files are being located.	1672	Directory where application-specific X resource files are located.
1526		1673
1527	=item B<XENVIRONMENT>	1674	=item B<XENVIRONMENT>
1528		1675
1529	If set and accessible, gives the name of a X resource file to be loaded by	1676	If set and accessible, gives the name of a X resource file to be loaded by
1530	@@RXVT_NAME@@.	1677	@@RXVT_NAME@@.
…		…
1535		1682
1536	=over 4	1683	=over 4
1537		1684
1538	=item B</usr/lib/X11/rgb.txt>	1685	=item B</usr/lib/X11/rgb.txt>
1539		1686
1540	Color names.	1687	Colour names.
1541		1688
1542	=back	1689	=back
1543		1690
1544	=head1 SEE ALSO	1691	=head1 SEE ALSO
1545		1692
…		…
1584	Project Coordinator (changes.txt 2.21a to 2.4.5)	1731	Project Coordinator (changes.txt 2.21a to 2.4.5)
1585		1732
1586	=item Geoff Wing L<< <gcw@pobox.com> >>	1733	=item Geoff Wing L<< <gcw@pobox.com> >>
1587		1734
1588	Rewrote screen display and text selection routines.	1735	Rewrote screen display and text selection routines.
1589		1736
1590	Project Coordinator (changes.txt 2.4.6 - rxvt-unicode)	1737	Project Coordinator (changes.txt 2.4.6 - rxvt-unicode)
1591		1738
1592	=item Marc Alexander Lehmann L<< <rxvt-unicode@schmorp.de> >>	1739	=item Marc Alexander Lehmann L<< <rxvt-unicode@schmorp.de> >>
1593		1740
1594	Forked rxvt-unicode, unicode support, rewrote almost all the code, perl	1741	Forked rxvt-unicode, unicode support, rewrote almost all the code, perl
…		…
1596		1743
1597	Project Coordinator (Changes 1.0 -)	1744	Project Coordinator (Changes 1.0 -)
1598		1745
1599	=item Emanuele Giaquinta L<< <e.giaquinta@glauco.it> >>	1746	=item Emanuele Giaquinta L<< <e.giaquinta@glauco.it> >>
1600		1747
1601	Pty/tty/utmp/wtmp rewrite, lots of random hacking and bugfixing.	1748	pty/utmp code rewrite, image code improvements, many random hacks and bugfixes.
1602		1749
1603	=back	1750	=back
1604		1751

Diff Legend

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

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents): Revision 1.141 by sasha, Mon Oct 29 13:40:41 2007 UTC vs. Revision 1.208 by sf-exg, Fri Dec 2 09:13:50 2011 UTC

Diff Legend

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents):
Revision 1.141 by sasha, Mon Oct 29 13:40:41 2007 UTC vs.
Revision 1.208 by sf-exg, Fri Dec 2 09:13:50 2011 UTC