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

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents):
Revision 1.128 by root, Wed May 16 22:37:10 2007 UTC vs.
Revision 1.202 by sf-exg, Thu Aug 11 08:37:17 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
28	world. Being a terminal emulator, however, some things are very difficult,	31	world. Being a terminal emulator, however, some things are very difficult,
29	especially cursive scripts such as arabic, vertically written scripts	32	especially cursive scripts such as arabic, vertically written scripts
30	like mongolian or scripts requiring extremely complex combining rules,	33	like mongolian or scripts requiring extremely complex combining rules,
31	like tibetan or devenagari. 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>
108		116
109	Turn on/off simulated reverse video; resource B<reverseVideo>.	117	Turn on/off simulated reverse video; resource B<reverseVideo>.
110		118
111	=item B<-j>\|B<+j>	119	=item B<-j>\|B<+j>
112		120
113	Turn on/off jump scrolling; resource B<jumpScroll>.	121	Turn on/off jump scrolling (allow multiple lines per refresh); resource B<jumpScroll>.
114		122
115	=item B<-ip>\|B<+ip> \| B<-tr>\|B<+tr>	123	=item B<-ss>\|B<+ss>
116		124
117	Turn on/off inheriting parent window's pixmap. Alternative form is	125	Turn on/off skip scrolling (allow multiple screens per refresh); resource B<skipScroll>.
118	B<-tr>; resource B<inheritPixmap>.
119		126
120	I<Please note that transparency of any kind if completely unsupported by	127	=item B<-tr>\|B<+tr>
121	the author. Don't bug him with installation questions! Read the FAQ (man 7	128
122	@@RXVT_NAME@@)!>	129	Turn on/off pseudo-transparency by using the root pixmap as background; resource B<transparent>.
		130
		131	B<-ip> is still accepted as an obsolete alias but will be removed in
		132	future versions.
123		133
124	=item B<-fade> I<number>	134	=item B<-fade> I<number>
125		135
126	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
127	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
…		…
132	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
133	is opaque black. resource B<fadeColor>.	143	is opaque black. resource B<fadeColor>.
134		144
135	=item B<-tint> I<colour>	145	=item B<-tint> I<colour>
136		146
137	Tint the transparent background pixmap with the given colour when	147	Tint the transparent background with the given colour;
138	transparency is enabled with B<-tr> or B<-ip>. This only works for	148	resource I<tintColor>.
139	non-tiled backgrounds, currently. See also the B<-sh> option that can be
140	used to brighten or darken the image in addition to tinting it; resource
141	I<tintColor>. Example:
142		149
143	@@RXVT_NAME@@ -tr -tint blue -sh 40	150	=item B<-sh> I<number>
144		151
145	=item B<-sh>
146
147	I<number> Darken (0 .. 100) or lighten (-1 .. -100) the transparent	152	Darken (0 .. 99) or lighten (101 .. 200) the transparent background.
148	background image in addition to tinting it (i.e. B<-tint> must be	153	A value of 100 means no shading; resource I<shading>.
149	specified, too, e.g. C<-tint white>); resource I<shading>.	154
		155	=item B<-blt> I<string>
		156
		157	Specify background blending type. If background pixmap is specified
		158	at the same time as transparency - such pixmap will be blended over
		159	the transparent background, using the method specified. Supported values are:
		160	B<add>, B<alphablend>, B<allanon> - colour values averaging, B<colorize>,
		161	B<darken>, B<diff>, B<dissipate>, B<hue>, B<lighten>, B<overlay>,
		162	B<saturate>, B<screen>, B<sub>, B<tint>, B<value>. The default is
		163	alpha-blending. Compile I<afterimage>; resource I<blendType>.
		164
		165	=item B<-blr> I<HxV>
		166
		167	Apply Gaussian Blur with the specified radii to the transparent
		168	background. If a single number is specified - both vertical and
		169	horizontal radii are considered to be the same. Setting one of the
		170	radii to 1 and another to a large number creates interesting effects
		171	on some backgrounds. Maximum radius value is 128;
		172	resource I<blurRadius>.
		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>.
150		179
151	=item B<-bg> I<colour>	180	=item B<-bg> I<colour>
152		181
153	Window background colour; resource B<background>.	182	Window background colour; resource B<background>.
154		183
155	=item B<-fg> I<colour>	184	=item B<-fg> I<colour>
156		185
157	Window foreground colour; resource B<foreground>.	186	Window foreground colour; resource B<foreground>.
158		187
159	=item B<-pixmap> I<file[;geom]>	188	=item B<-pixmap> I<file[;geom[:op1][:op2][...]]>
160		189
161	Compile I<XPM>: Specify XPM file for the background and also optionally	190	Compile I<afterimage> or I<pixbuf>: Specify image file for the background and also
162	specify its scaling with a geometry string. Note you may need to	191	optionally specify its scaling with a geometry string. Note you may need to
163	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
164	command-line; resource B<backgroundPixmap>.	193	command-line; for more details see resource B<backgroundPixmap>.
165		194
166	=item B<-cr> I<colour>	195	=item B<-cr> I<colour>
167		196
168	The cursor colour; resource B<cursorColor>.	197	The cursor colour; resource B<cursorColor>.
169		198
…		…
214	italic> >> characters are to be printed. See resource B<boldItalicFont>	243	italic> >> characters are to be printed. See resource B<boldItalicFont>
215	for details.	244	for details.
216		245
217	=item B<-is>\|B<+is>	246	=item B<-is>\|B<+is>
218		247
219	Compile I<font-styles>: Bold/Italic font styles imply high intensity	248	Compile I<font-styles>: Bold/Blink font styles imply high intensity
220	foreground/background (default). See resource B<intensityStyles> for	249	foreground/background (default). See resource B<intensityStyles> for
221	details.	250	details.
222		251
223	=item B<-name> I<name>	252	=item B<-name> I<name>
224		253
…		…
242		271
243	=item B<-sb>\|B<+sb>	272	=item B<-sb>\|B<+sb>
244		273
245	Turn on/off scrollbar; resource B<scrollBar>.	274	Turn on/off scrollbar; resource B<scrollBar>.
246		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
247	=item B<-si>\|B<+si>	285	=item B<-si>\|B<+si>
248		286
249	Turn on/off scroll-to-bottom on TTY output inhibit; resource	287	Turn on/off scroll-to-bottom on TTY output inhibit; resource
250	B<scrollTtyOutput> has opposite effect.	288	B<scrollTtyOutput> has opposite effect.
251		289
…		…
257	=item B<-sw>\|B<+sw>	295	=item B<-sw>\|B<+sw>
258		296
259	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.
260	This only takes effect if B<-si> is also given; resource	298	This only takes effect if B<-si> is also given; resource
261	B<scrollWithBuffer>.	299	B<scrollWithBuffer>.
262
263	=item B<-sr>\|B<+sr>
264
265	Put scrollbar on right/left; resource B<scrollBar_right>.
266
267	=item B<-st>\|B<+st>
268
269	Display rxvt (non XTerm/NeXT) scrollbar without/with a trough;
270	resource B<scrollBar_floating>.
271		300
272	=item B<-ptab>\|B<+ptab>	301	=item B<-ptab>\|B<+ptab>
273		302
274	If enabled (default), "Horizontal Tab" characters are being stored as	303	If enabled (default), "Horizontal Tab" characters are being stored as
275	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
…		…
279		308
280	=item B<-bc>\|B<+bc>	309	=item B<-bc>\|B<+bc>
281		310
282	Blink the cursor; resource B<cursorBlink>.	311	Blink the cursor; resource B<cursorBlink>.
283		312
		313	=item B<-uc>\|B<+uc>
		314
		315	Make the cursor underlined; resource B<cursorUnderline>.
		316
284	=item B<-iconic>	317	=item B<-iconic>
285		318
286	Start iconified, if the window manager supports that option.	319	Start iconified, if the window manager supports that option.
287	Alternative form is B<-ic>.	320	Alternative form is B<-ic>.
288		321
…		…
304		337
305	=item B<-bl>	338	=item B<-bl>
306		339
307	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.
308	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
309	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.
310		344
311	=item B<-override-redirect>	345	=item B<-override-redirect>
312		346
313	Compile I<frills>: Sets override-redirect on the window; resource	347	Compile I<frills>: Sets override-redirect on the window; resource
314	B<override-redirect>.	348	B<override-redirect>.
…		…
322		356
323	=item B<-lsp> I<number>	357	=item B<-lsp> I<number>
324		358
325	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
326	the display. Useful to work around font rendering problems; resource	360	the display. Useful to work around font rendering problems; resource
327	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>.
328		369
329	=item B<-tn> I<termname>	370	=item B<-tn> I<termname>
330		371
331	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
332	B<TERM> environment variable. This terminal type must exist in the	373	B<TERM> environment variable. This terminal type must exist in the
…		…
386	for more info.	427	for more info.
387		428
388	=item B<-tcw>	429	=item B<-tcw>
389		430
390	Change the meaning of triple-click selection with the left mouse	431	Change the meaning of triple-click selection with the left mouse
		432	button. Only effective when the original (non-perl) selection code is
391	button. 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
392	end of the logical line only. resource B<tripleclickwords>.	434	the end of the logical line only. resource B<tripleclickwords>.
393		435
394	=item B<-insecure>	436	=item B<-insecure>
395		437
396	Enable "insecure" mode, which currently enables most of the escape	438	Enable "insecure" mode, which currently enables most of the escape
397	sequences that echo strings. See the resource B<insecure> for more	439	sequences that echo strings. See the resource B<insecure> for more
…		…
417		459
418	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@@
419	will not immediately destroy its window when the program executed within	461	will not immediately destroy its window when the program executed within
420	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
421	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.
422		483
423	=item B<-keysym.>I<sym> I<string>	484	=item B<-keysym.>I<sym> I<string>
424		485
425	Remap a key symbol. See resource B<keysym>.	486	Remap a key symbol. See resource B<keysym>.
426		487
…		…
461	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
462	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
463	yourself if you want that.	524	yourself if you want that.
464		525
465	As an extremely special case, specifying C<-1> will completely suppress	526	As an extremely special case, specifying C<-1> will completely suppress
466	pty/tty operations.	527	pty/tty operations, which is probably only useful in conjunction with some
		528	perl extension that manages the terminal.
467		529
468	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
469	longer example is in F<doc/pty-fd>):	531	longer example is in F<doc/pty-fd>):
470		532
471	use IO::Pty;	533	use IO::Pty;
…		…
485	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
486	this terminal instance. See resource B<perl-ext> for details.	548	this terminal instance. See resource B<perl-ext> for details.
487		549
488	=back	550	=back
489		551
490	=head1 RESOURCES (available also as long-options)	552	=head1 RESOURCES
491		553
492	Note: `@@RXVT_NAME@@ --help' gives a list of all resources (long	554	Note: `@@RXVT_NAME@@ --help' gives a list of all resources (long
493	options) compiled into your version.	555	options) compiled into your version. All resources are also available as
		556	long-options.
494		557
495	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
496	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
497	starts. @@RXVT_NAME@@ will consult the following files/resources in order,	560	starts. @@RXVT_NAME@@ will consult the following files/resources in order,
498	with later settings overwriting earlier ones:	561	with later settings overwriting earlier ones:
499		562
500	1. system-wide app-defaults file, either locale-dependent OR global
501	2. app-defaults file in $XAPPLRESDIR	563	1. app-defaults file in $XAPPLRESDIR
		564	2. $HOME/.Xdefaults
502	3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults	565	3. RESOURCE_MANAGER property on root-window of screen 0
503	4. SCREEN_RESOURCES for the current screen	566	4. SCREEN_RESOURCES property on root-window of the current screen
504	5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename>	567	5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename>
		568	6. resources specified via -xrm on the commandline
505		569
506	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
507	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
508	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
509	configured, while the class name B<URxvt> allows resources unique to	573	configured, while the class name B<URxvt> allows resources unique to
…		…
519	=item B<depth:> I<bitdepth>	583	=item B<depth:> I<bitdepth>
520		584
521	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;
522	option B<-depth>.	586	option B<-depth>.
523		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
524	=item B<geometry:> I<geom>	595	=item B<geometry:> I<geom>
525		596
526	Create the window with the specified X window geometry [default 80x24];	597	Create the window with the specified X window geometry [default 80x24];
527	option B<-geometry>.	598	option B<-geometry>.
528		599
…		…
541	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
542	corresponds to low-intensity (normal) colours and 8-15 corresponds to	613	corresponds to low-intensity (normal) colours and 8-15 corresponds to
543	high-intensity (bold = bright foreground, blink = bright background)	614	high-intensity (bold = bright foreground, blink = bright background)
544	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,
545	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
546	names used are listed in the B<COLORS AND GRAPHICS> section.	617	names used are listed in the B<COLOURS AND GRAPHICS> section.
547		618
548	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
549	changed using an escape command (see @@RXVT_NAME@@(7)).	620	changed using an escape command (see @@RXVT_NAME@@(7)).
550		621
551	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
…		…
562	=item B<colorUL:> I<colour>	633	=item B<colorUL:> I<colour>
563		634
564	Use the specified colour to display underlined characters when the	635	Use the specified colour to display underlined characters when the
565	foreground colour is the default.	636	foreground colour is the default.
566		637
567	=item B<colorRV:> I<colour>
568
569	Use the specified colour as the background for reverse video characters
570	when OPTION_HC is disabled (--disable-frills).
571
572	=item B<underlineColor:> I<colour>	638	=item B<underlineColor:> I<colour>
573		639
574	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
575	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.
576		652
577	=item B<cursorColor:> I<colour>	653	=item B<cursorColor:> I<colour>
578		654
579	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
580	foreground colour; option B<-cr>.	656	foreground colour; option B<-cr>.
…		…
587		663
588	=item B<reverseVideo:> I<boolean>	664	=item B<reverseVideo:> I<boolean>
589		665
590	B<True>: simulate reverse video by foreground and background colours;	666	B<True>: simulate reverse video by foreground and background colours;
591	option B<-rv>. B<False>: regular screen colours [default]; option	667	option B<-rv>. B<False>: regular screen colours [default]; option
592	B<+rv>. See note in B<COLORS AND GRAPHICS> section.	668	B<+rv>. See note in B<COLOURS AND GRAPHICS> section.
593		669
594	=item B<jumpScroll:> I<boolean>	670	=item B<jumpScroll:> I<boolean>
595		671
596	B<True>: specify that jump scrolling should be used. When scrolling	672	B<True>: specify that jump scrolling should be used. When receiving lots
597	quickly, fewer screen updates are performed [default]; option B<-j>.	673	of lines, @@RXVT_NAME@@ will only scroll once a whole screen height of lines
		674	has been read, resulting in fewer updates while still displaying every
		675	received line; option B<-j>.
		676
598	B<False>: specify that smooth scrolling should be used; option B<+j>.	677	B<False>: specify that smooth scrolling should be used. @@RXVT_NAME@@ will
		678	force a screen refresh on each new line it received; option B<+j>.
599		679
600	=item B<inheritPixmap:> I<boolean>	680	=item B<skipScroll:> I<boolean>
601		681
602	B<True>: make the background inherit the parent windows' pixmap, giving	682	B<True>: (the default) specify that skip scrolling should be used. When
603	artificial transparency. B<False>: do not inherit the parent windows'	683	receiving lots of lines, @@RXVT_NAME@@ will only scroll once in a while
604	pixmap.	684	(around 60 times per second), resulting in far fewer updates. This can
		685	result in @@RXVT_NAME@@ not ever displaying some of the lines it receives;
		686	option B<-ss>.
605		687
606	I<Please note that transparency of any kind if completely unsupported by	688	B<False>: specify that everything is to be displayed, even
607	the author. Don't bug him with installation questions!>	689	if the refresh is too fast for the human eye to read anything (or the
		690	monitor to display anything); option B<+ss>.
		691
		692	=item B<transparent:> I<boolean>
		693
		694	Turn on/off pseudo-transparency by using the root pixmap as background.
		695
		696	B<inheritPixmap> is still accepted as an obsolete alias but will be removed in
		697	future versions.
608		698
609	=item B<fading:> I<number>	699	=item B<fading:> I<number>
610		700
611	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>.
612		702
…		…
615	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
616	colour is black; option B<-fadecolor>.	706	colour is black; option B<-fadecolor>.
617		707
618	=item B<tintColor:> I<colour>	708	=item B<tintColor:> I<colour>
619		709
620	Tint the transparent background pixmap with the given colour; option	710	Tint the transparent background with the given colour. If the RENDER
621	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>.
622		715
623	=item B<shading:> I<number>	716	=item B<shading:> I<number>
624		717
625	Darken (0 .. 100) or lighten (-1 .. -100) the transparent background image	718	Darken (0 .. 99) or lighten (101 .. 200) the transparent background.
626	in addition to tinting it; option B<-sh>.	719	A value of 100 means no shading; option B<-sh>.
		720
		721	=item B<blendType:> I<string>
		722
		723	Specify background blending type; option B<-blt>.
		724
		725	=item B<blurRadius:> I<number>
		726
		727	Apply gaussian blur with the specified radius to the transparent
		728	background; option B<-blr>.
		729
		730	=item B<iconFile:> I<file>
		731
		732	Set the application icon pixmap; option B<-icon>.
627		733
628	=item B<scrollColor:> I<colour>	734	=item B<scrollColor:> I<colour>
629		735
630	Use the specified colour for the scrollbar [default #B2B2B2].	736	Use the specified colour for the scrollbar [default #B2B2B2].
631		737
…		…
637	=item B<borderColor:> I<colour>	743	=item B<borderColor:> I<colour>
638		744
639	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
640	and the text.	746	and the text.
641		747
642	=item B<backgroundPixmap:> I<file[;geom]>	748	=item B<backgroundPixmap:> I<file[;geom[:op1][:op2][...]]>
643		749
644	Use the specified XPM file (note the `.xpm' extension is optional) for	750	Use the specified image file for the background and also
645	the background and also optionally specify its scaling with a geometry	751	optionally specify its scaling with a geometry string B<WxH+X+Y>,
646	string B<WxH+X+Y>, in which B<"W" / "H"> specify the	752	(default C<100x100+50+50>) in which B<"W" / "H"> specify the
647	horizontal/vertical scale (percent) and B<"X" / "Y"> locate the image	753	horizontal/vertical scale (percent), and B<"X" / "Y"> locate the image
648	centre (percent). A scale of 0 displays the image with tiling. A scale	754	centre (percent). A scale of 0 disables scaling.
649	of 1 displays the image without any scaling. A scale of 2 to 9	755	The maximum permitted scale is 1000.
650	specifies an integer number of images in that direction. No image will	756	Additional operations can be specified after colon B<:op1:op2...>.
651	be magnified beyond 10 times its original size. The maximum permitted	757	Supported operations are:
652	scale is 1000. [default 0x0+50+50]	758
		759	op=tile enables tiling
		760	op=pscale enables proportional scaling
		761	op=root use the position of the terminal window relative to the root
		762	window as the image offset, simulating a root window background
		763
		764	Alternatively, a predefined set of templates can be used to achieve
		765	the most common setups:
		766
		767	style=tiled the image is tiled with no scaling
		768	style=aspect-stretched the image is scaled to fill the whole window maintaining
		769	the aspect ratio and centered
		770	style=stretched the image is scaled to fill the whole window
		771	style=centered the image is centered with no scaling
		772	style=root-tiled the image is tiled with no scaling and using 'op=root' positioning
		773
		774	If multiple templates are specified the last one wins. Note that a
		775	template overrides all the scale, position and operations settings.
		776	Indeed, the templates can be specified in terms of low level settings
		777	as follows:
		778
		779	style=tiled 0x0+0+0:op=tile
		780	style=aspect-stretched +50+50:op=pscale
		781	style=stretched 100x100
		782	style=centered 0x0+50+50
		783	style=root-tiled 0x0:op=tile:op=root
		784
		785	If used in conjunction with B<-tr> option, the specified pixmap will be
		786	blended over the transparent background using alpha-blending. If I<afterimage>
		787	support has been compiled in it is possible to choose other blending
		788	types with B<-blt "type"> option.
653		789
654	=item B<path:> I<path>	790	=item B<path:> I<path>
655		791
656	Specify the colon-delimited search path for finding XPM files.	792	Specify the colon-delimited search path for finding background image files.
657		793
658	=item B<font:> I<fontlist>	794	=item B<font:> I<fontlist>
659		795
660	Select the fonts to be used. This is a comma separated list of font names	796	Select the fonts to be used. This is a comma separated list of font names
661	that are checked in order when trying to find glyphs for characters. The	797	that are checked in order when trying to find glyphs for characters. The
…		…
684	it is named first) and thus defines the character cell grid to be 9 pixels	820	it is named first) and thus defines the character cell grid to be 9 pixels
685	wide and 15 pixels high.	821	wide and 15 pixels high.
686		822
687	The second font is just used to add additional unicode characters not in	823	The second font is just used to add additional unicode characters not in
688	the base font, likewise the third, which is unfortunately non-bold, but	824	the base font, likewise the third, which is unfortunately non-bold, but
689	the bold version of the font does contain less characters, so this is a	825	the bold version of the font does contain fewer characters, so this is a
690	useful supplement.	826	useful supplement.
691		827
692	The third font is an Xft font with aliasing turned off, and the characters	828	The third font is an Xft font with aliasing turned off, and the characters
693	are limited to the B<JIS 0208> codeset (i.e. japanese kanji). The font	829	are limited to the B<JIS 0208> codeset (i.e. japanese kanji). The font
694	contains other characters, but we are not interested in them.	830	contains other characters, but we are not interested in them.
…		…
718	text font will being used for the given style.	854	text font will being used for the given style.
719		855
720	=item B<intensityStyles:> I<boolean>	856	=item B<intensityStyles:> I<boolean>
721		857
722	When font styles are not enabled, or this option is enabled (B<True>,	858	When font styles are not enabled, or this option is enabled (B<True>,
723	option B<-is>, the default), bold and italic font styles imply high	859	option B<-is>, the default), bold/blink font styles imply high
724	intensity foreground/background colours. Disabling this option (B<False>,	860	intensity foreground/background colours. Disabling this option (B<False>,
725	option B<+is>) disables this behaviour, the high intensity colours are not	861	option B<+is>) disables this behaviour, the high intensity colours are not
726	reachable.	862	reachable.
727		863
728	=item B<selectstyle:> I<mode>
729
730	Set mouse selection style to B<old> which is 2.20, B<oldword> which is
731	xterm style with 2.20 old word selection, or anything else which gives
732	xterm style selection.
733
734	=item B<scrollstyle:> I<mode>
735
736	Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is
737	the author's favourite.
738
739	=item B<title:> I<string>	864	=item B<title:> I<string>
740		865
741	Set window title string, the default title is the command-line	866	Set window title string, the default title is the command-line
742	specified after the B<-e> option, if any, otherwise the application	867	specified after the B<-e> option, if any, otherwise the application
743	name; option B<-title>.	868	name; option B<-title>.
…		…
756	=item B<urgentOnBell:> I<boolean>	881	=item B<urgentOnBell:> I<boolean>
757		882
758	B<True>: set the urgency hint for the wm on receipt of a bell character.	883	B<True>: set the urgency hint for the wm on receipt of a bell character.
759	B<False>: do not set the urgency hint [default].	884	B<False>: do not set the urgency hint [default].
760		885
		886	@@RXVT_NAME@@ resets the urgency hint on every focus change.
		887
761	=item B<visualBell:> I<boolean>	888	=item B<visualBell:> I<boolean>
762		889
763	B<True>: use visual bell on receipt of a bell character; option B<-vb>.	890	B<True>: use visual bell on receipt of a bell character; option B<-vb>.
764	B<False>: no visual bell [default]; option B<+vb>.	891	B<False>: no visual bell [default]; option B<+vb>.
765		892
…		…
788	URxvt.print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX)	915	URxvt.print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX)
789		916
790	This creates a new file in your home directory with the screen contents	917	This creates a new file in your home directory with the screen contents
791	every time you hit C<Print>.	918	every time you hit C<Print>.
792		919
		920	=item B<scrollstyle:> I<mode>
		921
		922	Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is
		923	the author's favourite.
		924
		925	=item B<thickness:> I<number>
		926
		927	Set the scrollbar width in pixels.
		928
793	=item B<scrollBar:> I<boolean>	929	=item B<scrollBar:> I<boolean>
794		930
795	B<True>: enable the scrollbar [default]; option B<-sb>. B<False>:	931	B<True>: enable the scrollbar [default]; option B<-sb>. B<False>:
796	disable the scrollbar; option B<+sb>.	932	disable the scrollbar; option B<+sb>.
797		933
…		…
816	B<False>: do not scroll to bottom when tty receives output; option	952	B<False>: do not scroll to bottom when tty receives output; option
817	B<+si>.	953	B<+si>.
818		954
819	=item B<scrollWithBuffer:> I<boolean>	955	=item B<scrollWithBuffer:> I<boolean>
820		956
821	B<True>: scroll with scrollback buffer when tty receives new lines (and	957	B<True>: scroll with scrollback buffer when tty receives new lines (i.e.
822	B<scrollTtyOutput> is False); option B<-sw>. B<False>: do not scroll	958	try to show the same lines) and B<scrollTtyOutput> is False; option
823	with scrollback buffer when tty receives new lines; option B<+sw>.	959	B<-sw>. B<False>: do not scroll with scrollback buffer when tty receives
		960	new lines; option B<+sw>.
824		961
825	=item B<scrollTtyKeypress:> I<boolean>	962	=item B<scrollTtyKeypress:> I<boolean>
826		963
827	B<True>: scroll to bottom when a non-special key is pressed. Special keys	964	B<True>: scroll to bottom when a non-special key is pressed. Special keys
828	are those which are intercepted by rxvt-unicode for special handling and	965	are those which are intercepted by rxvt-unicode for special handling and
…		…
859	=item B<termName:> I<termname>	996	=item B<termName:> I<termname>
860		997
861	Specifies the terminal type name to be set in the B<TERM> environment	998	Specifies the terminal type name to be set in the B<TERM> environment
862	variable; option B<-tn>.	999	variable; option B<-tn>.
863		1000
864	=item B<linespace:> I<number>	1001	=item B<lineSpace:> I<number>
865		1002
866	Specifies number of lines (pixel height) to insert between each row of	1003	Specifies number of lines (pixel height) to insert between each row of
867	the display [default 0]; option B<-lsp>.	1004	the display [default 0]; option B<-lsp>.
868		1005
869	=item B<meta8:> I<boolean>	1006	=item B<meta8:> I<boolean>
…		…
883		1020
884	=item B<cursorBlink:> I<boolean>	1021	=item B<cursorBlink:> I<boolean>
885		1022
886	B<True>: blink the cursor. B<False>: do not blink the cursor [default];	1023	B<True>: blink the cursor. B<False>: do not blink the cursor [default];
887	option B<-bc>.	1024	option B<-bc>.
		1025
		1026	=item B<cursorUnderline:> I<boolean>
		1027
		1028	B<True>: Make the cursor underlined. B<False>: Make the cursor a box [default];
		1029	option B<-uc>.
888		1030
889	=item B<pointerBlank:> I<boolean>	1031	=item B<pointerBlank:> I<boolean>
890		1032
891	B<True>: blank the pointer when a key is pressed or after a set number	1033	B<True>: blank the pointer when a key is pressed or after a set number
892	of seconds of inactivity. B<False>: the pointer is always visible	1034	of seconds of inactivity. B<False>: the pointer is always visible
…		…
906	large number (e.g. C<987654321>) to effectively disable the timeout.	1048	large number (e.g. C<987654321>) to effectively disable the timeout.
907		1049
908	=item B<backspacekey:> I<string>	1050	=item B<backspacekey:> I<string>
909		1051
910	The string to send when the backspace key is pressed. If set to B<DEC>	1052	The string to send when the backspace key is pressed. If set to B<DEC>
911	or unset it will send B<Delete> (code 127) or, if shifted, B<Backspace>	1053	or unset it will send B<Delete> (code 127) or, with control, B<Backspace>
912	(code 8) - which can be reversed with the appropriate DEC private mode	1054	(code 8) - which can be reversed with the appropriate DEC private mode
913	escape sequence.	1055	escape sequence.
914		1056
915	=item B<deletekey:> I<string>	1057	=item B<deletekey:> I<string>
916		1058
…		…
921	=item B<cutchars:> I<string>	1063	=item B<cutchars:> I<string>
922		1064
923	The characters used as delimiters for double-click word selection	1065	The characters used as delimiters for double-click word selection
924	(whitespace delimiting is added automatically if resource is given).	1066	(whitespace delimiting is added automatically if resource is given).
925		1067
926	When the selection extension is in use (the default if compiled in, see	1068	When the perl selection extension is in use (the default if compiled
927	the @@RXVT_NAME@@perl(3) manpage), a suitable regex using these characters	1069	in, see the @@RXVT_NAME@@perl(3) manpage), a suitable regex using these
928	will be created (if the resource exists, otherwise, no regex will be	1070	characters will be created (if the resource exists, otherwise, no regex
929	created). In this mode, characters outside ISO-8859-1 can be used.	1071	will be created). In this mode, characters outside ISO-8859-1 can be used.
930		1072
931	When the selection extension is not used, only ISO-8859-1 characters can	1073	When the selection extension is not used, only ISO-8859-1 characters can
932	be used. If not specified, the built-in default is used:	1074	be used. If not specified, the built-in default is used:
933		1075
934	B<< BACKSLASH `"'&()*,;<=>?@[]{\|} >>	1076	B<< BACKSLASH `"'&()*,;<=>?@[]^{\|} >>
935		1077
936	=item B<preeditType:> I<style>	1078	=item B<preeditType:> I<style>
937		1079
938	B<OverTheSpot>, B<OffTheSpot>, B<Root>; option B<-pt>.	1080	B<OverTheSpot>, B<OffTheSpot>, B<Root>; option B<-pt>.
939		1081
…		…
995		1137
996	=item B<secondaryScroll:> I<boolean>	1138	=item B<secondaryScroll:> I<boolean>
997		1139
998	Turn on/off secondary screen scroll (default enabled). If this	1140	Turn on/off secondary screen scroll (default enabled). If this
999	option is enabled, scrolls on the secondary screen will change the	1141	option is enabled, scrolls on the secondary screen will change the
1000	scrollback buffer and switching to/from the secondary screen will	1142	scrollback buffer and, when secondaryScreen is off, switching
1001	instead scroll the screen up.	1143	to/from the secondary screen will instead scroll the screen up.
1002		1144
1003	=item B<hold>: I<boolean>	1145	=item B<hold>: I<boolean>
1004		1146
1005	Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@	1147	Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@
1006	will not immediately destroy its window when the program executed within	1148	will not immediately destroy its window when the program executed within
1007	it exits. Instead, it will wait till it is being killed or closed by the	1149	it exits. Instead, it will wait till it is being killed or closed by the
1008	user.	1150	user.
		1151
		1152	=item B<chdir>: I<path>
		1153
		1154	Sets the working directory for the shell (or the command specified via
		1155	B<-e>). The I<path> must be an absolute path and it must exist for
		1156	@@RXVT_NAME@@ to start. If it isn't specified then the current working
		1157	directory will be used; option B<-cd>.
1009		1158
1010	=item B<keysym.>I<sym>: I<string>	1159	=item B<keysym.>I<sym>: I<string>
1011		1160
1012	Compile I<frills>: Associate I<string> with keysym I<sym>. The	1161	Compile I<frills>: Associate I<string> with keysym I<sym>. The
1013	intervening resource name B<keysym.> cannot be omitted.	1162	intervening resource name B<keysym.> cannot be omitted.
…		…
1027	searching keysym macros from B</usr/X11R6/include/X11/keysymdef.h> and	1176	searching keysym macros from B</usr/X11R6/include/X11/keysymdef.h> and
1028	omitting the prefix B<XK_>. Alternatively you can specify I<key> by its hex	1177	omitting the prefix B<XK_>. Alternatively you can specify I<key> by its hex
1029	keysym value (B<0x0000 - 0xFFFF>). Note that the lookup of I<sym>s is not	1178	keysym value (B<0x0000 - 0xFFFF>). Note that the lookup of I<sym>s is not
1030	performed in an exact manner; however, the closest match is assured.	1179	performed in an exact manner; however, the closest match is assured.
1031		1180
1032	I<string> may contain escape values (C<\a>: bell, C<\b>: backspace,	1181	I<string> may contain escape values (C<\n>: newline, C<\000>: octal
1033	C<\e>, C<\E>: escape, C<\n>: newline, C<\r>: carriage return, C<\t>: tab,	1182	number), see RESOURCES in C<man 7 X> for further details.
1034	C<\000>: octal number) or verbatim control characters (C<^?>: delete,
1035	C<^@>: null, C<^A> ...) and may be enclosed with double quotes so that it
1036	can start or end with whitespace. B<This feature is deprecated and will
1037	be removed>.
1038
1039	Please note that you need to double the C<\> in resource files, as
1040	Xlib itself does its own de-escaping (you can use C<\033> instead of
1041	C<\e> (and so on), which will work with both Xt and @@RXVT_NAME@@'s own
1042	processing).
1043		1183
1044	You can define a range of keysyms in one shot by providing a I<string>	1184	You can define a range of keysyms in one shot by providing a I<string>
1045	with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimiter `/'	1185	with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimiter `/'
1046	should be a character not used by the strings.	1186	should be a character not used by the strings.
1047		1187
1048	Its usage can be demonstrated by an example:	1188	Its usage can be demonstrated by an example:
1049		1189
1050	URxvt.keysym.M-C-0x61: list\|\033<M-C-\|abc\|>	1190	URxvt.keysym.M-C-0x61: list\|\033<\|abc\|>
1051		1191
1052	The above line is equivalent to the following three lines:	1192	The above line is equivalent to the following three lines:
1053		1193
1054	URxvt.keysym.Meta-Control-0x61: \033<M-C-a>	1194	URxvt.keysym.Meta-Control-0x61: \033<a>
1055	URxvt.keysym.Meta-Control-0x62: \033<M-C-b>	1195	URxvt.keysym.Meta-Control-0x62: \033<b>
1056	URxvt.keysym.Meta-Control-0x63: \033<M-C-c>	1196	URxvt.keysym.Meta-Control-0x63: \033<c>
1057		1197
1058	If I<string> takes the form of C<command:STRING>, the specified B<STRING>	1198	If I<string> takes the form of C<command:STRING>, the specified B<STRING>
1059	is interpreted and executed as @@RXVT_NAME@@'s control sequence. For	1199	is interpreted and executed as @@RXVT_NAME@@'s control sequence. For
1060	example the following means "change the current locale to C<zh_CN.GBK>	1200	example the following means "change the current locale to C<zh_CN.GBK>
1061	when Control-Meta-c is being pressed":	1201	when Control-Meta-c is being pressed":
1062		1202
1063	URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007	1203	URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007
1064		1204
1065	If I<string> takes the form C<perl:STRING>, then the specified B<STRING>	1205	If I<string> takes the form C<perl:STRING>, then the specified B<STRING>
1066	is passed to the C<on_keyboard_command> perl handler. See the @@RXVT_NAME@@perl(3)	1206	is passed to the C<on_user_command> perl handler. See the @@RXVT_NAME@@perl(3)
1067	manpage. For example, the F<selection> extension (activated via	1207	manpage. For example, the F<selection> extension (activated via
1068	C<@@RXVT_NAME@@ -pe selection>) listens for C<selection:rot13> events:	1208	C<@@RXVT_NAME@@ -pe selection>) listens for C<selection:rot13> events:
1069		1209
1070	URxvt.keysym.M-C-c: perl:selection:rot13	1210	URxvt.keysym.M-C-c: perl:selection:rot13
1071		1211
1072	Due the the large number of modifier combinations, a defined key mapping	1212	Due the the large number of modifier combinations, a defined key mapping
1073	will match if at I<at least> the specified identifiers are being set, and	1213	will match if I<at least> the specified identifiers are being set, and
1074	no other key mappings with those and more bits are being defined. That	1214	no other key mappings with those and more bits are being defined. That
1075	means that defining a key map for C<a> will automatically provide	1215	means that defining a key map for C<a> will automatically provide
1076	definitions for C<Meta-a>, C<Shift-a> and so on, unless some of those are defined	1216	definitions for C<Meta-a>, C<Shift-a> and so on, unless some of those are defined
1077	mappings themselves.	1217	mappings themselves.
1078		1218
…		…
1129	all instances, while B<perl-ext> is used for specific instances.	1269	all instances, while B<perl-ext> is used for specific instances.
1130		1270
1131	=item B<perl-eval>: I<string>	1271	=item B<perl-eval>: I<string>
1132		1272
1133	Perl code to be evaluated when all extensions have been registered. See	1273	Perl code to be evaluated when all extensions have been registered. See
1134	the @@RXVT_NAME@@perl(3) manpage. Due to security reasons, this resource	1274	the @@RXVT_NAME@@perl(3) manpage.
1135	will be ignored when running setuid/setgid.
1136		1275
1137	=item B<perl-lib>: I<path>	1276	=item B<perl-lib>: I<path>
1138		1277
1139	Colon-separated list of additional directories that hold extension	1278	Colon-separated list of additional directories that hold extension
1140	scripts. When looking for extensions specified by the C<perl> resource,	1279	scripts. When looking for extensions specified by the C<perl> resource,
1141	@@RXVT_NAME@@ will first look in these directories and then in	1280	@@RXVT_NAME@@ will first look in these directories and then in
1142	F<@@RXVT_LIBDIR@@/urxvt/perl/>. Due to security reasons, this resource	1281	F<@@RXVT_LIBDIR@@/urxvt/perl/>.
1143	will be ignored when running setuid/setgid.
1144		1282
1145	See the @@RXVT_NAME@@perl(3) manpage.	1283	See the @@RXVT_NAME@@perl(3) manpage.
1146		1284
1147	=item B<< selection.pattern-I<idx> >>: I<perl-regex>	1285	=item B<< selection.pattern-I<idx> >>: I<perl-regex>
1148		1286
…		…
1170		1308
1171	=item B<override-redirect>: I<boolean>	1309	=item B<override-redirect>: I<boolean>
1172		1310
1173	Compile I<frills>: Sets override-redirect for the terminal window, making	1311	Compile I<frills>: Sets override-redirect for the terminal window, making
1174	it almost invisible to window managers; option B<-override-redirect>.	1312	it almost invisible to window managers; option B<-override-redirect>.
		1313
		1314	=item B<iso14755:> I<boolean>
		1315
		1316	Turn on/off ISO 14755 (default enabled).
		1317
		1318	=item B<iso14755_52:> I<boolean>
		1319
		1320	Turn on/off ISO 14755 5.2 mode (default enabled).
1175		1321
1176	=back	1322	=back
1177		1323
1178	=head1 THE SCROLLBAR	1324	=head1 THE SCROLLBAR
1179		1325
…		…
1250		1396
1251	=head1 ISO 14755 SUPPORT	1397	=head1 ISO 14755 SUPPORT
1252		1398
1253	ISO 14755 is a standard for entering and viewing unicode characters	1399	ISO 14755 is a standard for entering and viewing unicode characters
1254	and character codes using the keyboard. It consists of 4 parts. The	1400	and character codes using the keyboard. It consists of 4 parts. The
1255	first part is available rxvt-unicode has been compiled with	1401	first part is available if rxvt-unicode has been compiled with
1256	C<--enable-frills>, the rest is available when rxvt-unicode was compiled	1402	C<--enable-frills>, the rest is available when rxvt-unicode was compiled
1257	with C<--enable-iso14755>.	1403	with C<--enable-iso14755>.
1258		1404
1259	=over 4	1405	=over 4
1260		1406
…		…
1318	B<@@RXVT_NAME@@> tries to write an entry into the I<utmp>(5) file so that	1464	B<@@RXVT_NAME@@> tries to write an entry into the I<utmp>(5) file so that
1319	it can be seen via the I<who(1)> command, and can accept messages. To	1465	it can be seen via the I<who(1)> command, and can accept messages. To
1320	allow this feature, B<@@RXVT_NAME@@> may need to be installed setuid root	1466	allow this feature, B<@@RXVT_NAME@@> may need to be installed setuid root
1321	on some systems or setgid to root or to some other group on others.	1467	on some systems or setgid to root or to some other group on others.
1322		1468
1323	=head1 COLORS AND GRAPHICS	1469	=head1 COLOURS AND GRAPHICS
1324		1470
1325	In addition to the default foreground and background colours,	1471	In addition to the default foreground and background colours,
1326	B<@@RXVT_NAME@@> can display up to 16 colours (8 ANSI colours plus	1472	B<@@RXVT_NAME@@> can display up to 88/256 colours: 8 ANSI colours plus
1327	high-intensity bold/blink versions of the same). Here is a list of the	1473	high-intensity (potentially bold/blink) versions of the same, and 72 (or
1328	colours with their names.	1474	240 in 256 colour mode) colours arranged in an 4x4x4 (or 6x6x6) colour RGB
		1475	cube plus a 8 (24) colour greyscale ramp.
		1476
		1477	Here is a list of the ANSI colours with their names.
1329		1478
1330	=begin table	1479	=begin table
1331		1480
1332	B<color0> (black) = Black	1481	B<color0> (black) = Black
1333	B<color1> (red) = Red3	1482	B<color1> (red) = Red3
…		…
1353	It is also possible to specify the colour values of B<foreground>,	1502	It is also possible to specify the colour values of B<foreground>,
1354	B<background>, B<cursorColor>, B<cursorColor2>, B<colorBD>, B<colorUL> as	1503	B<background>, B<cursorColor>, B<cursorColor2>, B<colorBD>, B<colorUL> as
1355	a number 0-15, as a convenient shorthand to reference the colour name of	1504	a number 0-15, as a convenient shorthand to reference the colour name of
1356	color0-color15.	1505	color0-color15.
1357		1506
1358	In addition to the colours defined above, @@RXVT_NAME@@ offers an	1507	The following text gives values for the standard 88 colour mode (and
1359	additional 72 colours. The first 64 of those (with indices 16 to 79)	1508	values for the 256 colour mode in parentheses).
1360	consist of a 444 RGB colour cube (i.e. I<index = r * 16 + g * 4 + b +
1361	16>), followed by 8 additional shades of gray (with indices 80 to 87).
1362		1509
		1510	The RGB cube uses indices 16..79 (16..231) using the following formulas:
		1511
		1512	index_88 = (r * 4 + g) * 4 + b + 16 # r, g, b = 0..3
		1513	index_256 = (r * 16 + g) * 16 + b + 16 # r, g, b = 0..15
		1514
		1515	The grayscale ramp uses indices 80..87 (232..239), from 10% to 90% in 10%
		1516	steps (1/26 to 25/26 in 1/26 steps) - black and white are already part of
		1517	the RGB cube.
		1518
1363	Together, all those colours implement the 88 colour xterm colours. Only	1519	Together, all those colours implement the 88 (256) colour xterm
1364	the first 16 can be changed using resources currently, the rest can only	1520	colours. Only the first 16 can be changed using resources currently, the
1365	be changed via command sequences ("escape codes").	1521	rest can only be changed via command sequences ("escape codes").
		1522
		1523	Applications are advised to use terminfo or command sequences to discover
		1524	number and RGB values of all colours (yes, you can query this...).
1366		1525
1367	Note that B<-rv> (B<"reverseVideo: True">) simulates reverse video by	1526	Note that B<-rv> (B<"reverseVideo: True">) simulates reverse video by
1368	always swapping the foreground/background colours. This is in contrast to	1527	always swapping the foreground/background colours. This is in contrast to
1369	I<xterm>(1) where the colours are only swapped if they have not otherwise	1528	I<xterm>(1) where the colours are only swapped if they have not otherwise
1370	been specified. For example,	1529	been specified. For example,
1371		1530
1372	=over 4
1373
1374	=item B<@@RXVT_NAME@@ -fg Black -bg White -rv>	1531	@@RXVT_NAME@@ -fg Black -bg White -rv
1375		1532
1376	would yield White on Black, while on I<xterm>(1) it would yield Black	1533	would yield White on Black, while on I<xterm>(1) it would yield Black on
1377	on White.	1534	White.
1378
1379	=back
1380		1535
1381	=head2 ALPHA CHANNEL SUPPORT	1536	=head2 ALPHA CHANNEL SUPPORT
1382		1537
1383	If Xft support has been compiled in and as long as Xft/Xrender/X don't get	1538	If Xft support has been compiled in and as long as Xft/Xrender/X don't get
1384	their act together, rxvt-unicode will support C<rgba:rrrr/gggg/bbbb/aaaa>	1539	their act together, rxvt-unicode will do it's own alpha channel management:
1385	(recommended, but B<MUST> have 4 digits/component) colour specifications,	1540
1386	in addition to the ones provided by X, where the additional A component	1541	You can prefix any colour with an opaqueness percentage enclosed in
		1542	brackets, i.e. C<[percent]>, where C<percent> is a decimal percentage
		1543	(0-100) that specifies the opacity of the colour, where C<0> is completely
		1544	transparent and C<100> is completely opaque. For example, C<[50]red> is a
		1545	half-transparent red, while C<[95]#00ff00> is an almost opaque green. This
		1546	is the recommended format to specify transparency values, and works with
		1547	all ways to specify a colour.
		1548
		1549	For complete control, rxvt-unicode also supports
		1550	C<rgba:rrrr/gggg/bbbb/aaaa> (exactly four hex digits/component) colour
		1551	specifications, where the additional C<aaaa> component specifies opacity
1387	specifies opacity (alpha) values. The minimum value of C<0> is completely	1552	(alpha) values. The minimum value of C<0000> is completely transparent,
1388	transparent). You can also prefix any color with C<[percent]>, where	1553	while C<ffff> is completely opaque). The two example colours from
1389	C<percent> is a decimal percentage (0-100) that specifies the opacity of	1554	earlier could also be specified as C<rgba:ff00/0000/0000/8000> and
1390	the color, where C<0> is completely transparent and C<100> is completelxy	1555	C<rgba:0000/ff00/0000/f332>.
1391	opaque.
1392		1556
1393	You probably need to specify B<"-depth 32">, too, and have the luck that	1557	You probably need to specify B<"-depth 32">, too, to force a visual with
1394	your X-server uses ARGB pixel layout, as X is far from just supporting	1558	alpha channels, and have the luck that your X-server uses ARGB pixel
1395	ARGB visuals out of the box, and rxvt-unicode just fudges around.	1559	layout, as X is far from just supporting ARGB visuals out of the box, and
		1560	rxvt-unicode just fudges around.
1396		1561
1397	For example, the following selects an almost completely transparent red	1562	For example, the following selects an almost completely transparent black
1398	background, and an almost opaque pink foreground:	1563	background, and an almost opaque pink foreground:
1399		1564
1400	@@RXVT_NAME@@ -depth 32 -bg rgba:0000/0000/0000/aaaa -fg "[80]pink"	1565	@@RXVT_NAME@@ -depth 32 -bg rgba:0000/0000/0000/4444 -fg "[80]pink"
1401		1566
1402	I<Please note that transparency of any kind if completely unsupported by	1567	When not using a background image, then the interpretation of the
1403	the author. Don't bug him with installation questions!>	1568	alpha channel is up to your compositing manager (most interpret it as
		1569	transparency of course).
		1570
		1571	When using a background pixmap or pseudo-transparency, then the background
		1572	colour will always behave as if it were completely transparent (so the
		1573	background image shows instead), regardless of how it was specified, while
		1574	other colours will either be transparent as specified (the background
		1575	image will show through) on servers supporting the RENDER extension, or
		1576	fully opaque on servers not supporting the RENDER EXTENSION.
		1577
		1578	Please note that due to bugs in Xft, specifying alpha values might result
		1579	in garbage being displayed when the X-server does not support the RENDER
		1580	extension.
1404		1581
1405	=head1 ENVIRONMENT	1582	=head1 ENVIRONMENT
1406		1583
1407	B<@@RXVT_NAME@@> sets and/or uses the following environment variables:	1584	B<@@RXVT_NAME@@> sets and/or uses the following environment variables:
1408		1585
…		…
1414	resources or on the command line.	1591	resources or on the command line.
1415		1592
1416	=item B<COLORTERM>	1593	=item B<COLORTERM>
1417		1594
1418	Either C<rxvt>, C<rxvt-xpm>, depending on whether @@RXVT_NAME@@ was	1595	Either C<rxvt>, C<rxvt-xpm>, depending on whether @@RXVT_NAME@@ was
1419	compiled with XPM support, and optionally with the added extension	1596	compiled with background image support, and optionally with the added
1420	C<-mono> to indicate that rxvt-unicode runs on a monochrome screen.	1597	extension C<-mono> to indicate that rxvt-unicode runs on a monochrome
		1598	screen.
1421		1599
1422	=item B<COLORFGBG>	1600	=item B<COLORFGBG>
1423		1601
1424	Set to a string of the form C<fg;bg> or C<fg;xpm;bg>, where C<fg> is	1602	Set to a string of the form C<fg;bg> or C<fg;xpm;bg>, where C<fg> is
1425	the colour code used as default foreground/text colour (or the string	1603	the colour code used as default foreground/text colour (or the string
1426	C<default> to indicate that the default-colour escape sequence is to be	1604	C<default> to indicate that the default-colour escape sequence is to be
1427	used), C<bg> is the colour code used as default background colour (or the	1605	used), C<bg> is the colour code used as default background colour (or the
1428	string C<default>), and C<xpm> is the string C<default> if @@RXVT_NAME@@	1606	string C<default>), and C<xpm> is the string C<default> if @@RXVT_NAME@@
1429	was compiled with XPM support. Libraries like C<ncurses> and C<slang> can	1607	was compiled with background image support. Libraries like C<ncurses>
1430	(and do) use this information to optimize screen output.	1608	and C<slang> can (and do) use this information to optimize screen output.
1431		1609
1432	=item B<WINDOWID>	1610	=item B<WINDOWID>
1433		1611
1434	Set to the (decimal) X Window ID of the @@RXVT_NAME@@ window (the toplevel	1612	Set to the (decimal) X Window ID of the @@RXVT_NAME@@ window (the toplevel
1435	window, which usually has subwindows for the scrollbar, the terminal	1613	window, which usually has subwindows for the scrollbar, the terminal
…		…
1441	C<--with-terminfo=PATH>.	1619	C<--with-terminfo=PATH>.
1442		1620
1443	=item B<DISPLAY>	1621	=item B<DISPLAY>
1444		1622
1445	Used by @@RXVT_NAME@@ to connect to the display and set to the correct	1623	Used by @@RXVT_NAME@@ to connect to the display and set to the correct
1446	display in its child processes.	1624	display in its child processes if C<-display> isn't used to override. It
		1625	defaults to C<:0> if it doesn't exist.
1447		1626
1448	=item B<SHELL>	1627	=item B<SHELL>
1449		1628
1450	The shell to be used for command execution, defaults to C</bin/sh>.	1629	The shell to be used for command execution, defaults to C</bin/sh>.
1451		1630
1452	=item B<RXVT_SOCKET>	1631	=item B<RXVT_SOCKET>
1453		1632
1454	The unix domain socket path used by @@RXVT_NAME@@c(1) and	1633	The unix domain socket path used by @@RXVT_NAME@@c(1) and
1455	@@RXVT_NAME@@d(1).	1634	@@RXVT_NAME@@d(1).
1456		1635
1457	Default F<<< $HOME/.rxvt-unicode-I<< <nodename >> >>>.	1636	Default F<<< $HOME/.rxvt-unicode-I<< <nodename> >> >>>.
1458		1637
1459	=item B<HOME>	1638	=item B<HOME>
1460		1639
1461	Used to locate the default directory for the unix domain socket for	1640	Used to locate the default directory for the unix domain socket for
1462	daemon communications and to locate various resource files (such as	1641	daemon communications and to locate various resource files (such as
1463	C<.Xdefaults>)	1642	C<.Xdefaults>)
1464		1643
1465	=item B<XAPPLRESDIR>	1644	=item B<XAPPLRESDIR>
1466		1645
1467	Directory where various X resource files are being located.	1646	Directory where application-specific X resource files are located.
1468		1647
1469	=item B<XENVIRONMENT>	1648	=item B<XENVIRONMENT>
1470		1649
1471	If set and accessible, gives the name of a X resource file to be loaded by	1650	If set and accessible, gives the name of a X resource file to be loaded by
1472	@@RXVT_NAME@@.	1651	@@RXVT_NAME@@.
…		…
1477		1656
1478	=over 4	1657	=over 4
1479		1658
1480	=item B</usr/lib/X11/rgb.txt>	1659	=item B</usr/lib/X11/rgb.txt>
1481		1660
1482	Color names.	1661	Colour names.
1483		1662
1484	=back	1663	=back
1485		1664
1486	=head1 SEE ALSO	1665	=head1 SEE ALSO
1487		1666
…		…
1526	Project Coordinator (changes.txt 2.21a to 2.4.5)	1705	Project Coordinator (changes.txt 2.21a to 2.4.5)
1527		1706
1528	=item Geoff Wing L<< <gcw@pobox.com> >>	1707	=item Geoff Wing L<< <gcw@pobox.com> >>
1529		1708
1530	Rewrote screen display and text selection routines.	1709	Rewrote screen display and text selection routines.
1531		1710
1532	Project Coordinator (changes.txt 2.4.6 - rxvt-unicode)	1711	Project Coordinator (changes.txt 2.4.6 - rxvt-unicode)
1533		1712
1534	=item Marc Alexander Lehmann L<< <rxvt-unicode@schmorp.de> >>	1713	=item Marc Alexander Lehmann L<< <rxvt-unicode@schmorp.de> >>
1535		1714
1536	Forked rxvt-unicode, unicode support, rewrote almost all the code, perl	1715	Forked rxvt-unicode, unicode support, rewrote almost all the code, perl
…		…
1538		1717
1539	Project Coordinator (Changes 1.0 -)	1718	Project Coordinator (Changes 1.0 -)
1540		1719
1541	=item Emanuele Giaquinta L<< <e.giaquinta@glauco.it> >>	1720	=item Emanuele Giaquinta L<< <e.giaquinta@glauco.it> >>
1542		1721
1543	Pty/tty/utmp/wtmp rewrite, lots of random hacking and bugfixing.	1722	pty/utmp code rewrite, image code improvements, many random hacks and bugfixes.
1544		1723
1545	=back	1724	=back
1546		1725

Diff Legend

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

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents): Revision 1.128 by root, Wed May 16 22:37:10 2007 UTC vs. Revision 1.202 by sf-exg, Thu Aug 11 08:37:17 2011 UTC

Diff Legend

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents):
Revision 1.128 by root, Wed May 16 22:37:10 2007 UTC vs.
Revision 1.202 by sf-exg, Thu Aug 11 08:37:17 2011 UTC