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

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents):
Revision 1.136 by root, Mon Aug 13 10:01:18 2007 UTC vs.
Revision 1.220 by root, Fri Sep 21 23:31:43 2012 UTC

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

Diff Legend

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

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents): Revision 1.136 by root, Mon Aug 13 10:01:18 2007 UTC vs. Revision 1.220 by root, Fri Sep 21 23:31:43 2012 UTC

Diff Legend

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents):
Revision 1.136 by root, Mon Aug 13 10:01:18 2007 UTC vs.
Revision 1.220 by root, Fri Sep 21 23:31:43 2012 UTC