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

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents):
Revision 1.134 by sasha, Tue Jul 31 22:23:56 2007 UTC vs.
Revision 1.212 by sf-exg, Sun Jan 1 14:31:28 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
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>
…		…
114		122
115	=item B<-ss>\|B<+ss>	123	=item B<-ss>\|B<+ss>
116		124
117	Turn on/off skip scrolling (allow multiple screens per refresh); resource B<skipScroll>.	125	Turn on/off skip scrolling (allow multiple screens per refresh); resource B<skipScroll>.
118		126
119	=item B<-ip>\|B<+ip> \| B<-tr>\|B<+tr>	127	=item B<-tr>\|B<+tr>
120		128
121	Turn on/off inheriting parent window's pixmap. Alternative form is	129	Turn on/off pseudo-transparency by using the root pixmap as background; resource B<transparent>.
122	B<-tr>; resource B<inheritPixmap>.
123		130
124	I<Please note that transparency of any kind if completely unsupported by	131	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	132	future versions.
126	@@RXVT_NAME@@)!>
127		133
128	=item B<-fade> I<number>	134	=item B<-fade> I<number>
129		135
130	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
131	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
…		…
136	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
137	is opaque black. resource B<fadeColor>.	143	is opaque black. resource B<fadeColor>.
138		144
139	=item B<-tint> I<colour>	145	=item B<-tint> I<colour>
140		146
141	Tint the transparent background pixmap with the given colour when	147	Tint the transparent background with the given colour;
142	transparency is enabled with B<-tr> or B<-ip>. This only works for	148	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 colors could be applued on the server-side,
146	thus yeilding performance gain of two orders of magnitude. This colors are:
147	blue, red, green, cyan, magenta, yellow, and those close to this; resource
148	I<tintColor>. Example:
149
150	@@RXVT_NAME@@ -tr -tint blue -sh 40
151		149
152	=item B<-sh> I<number>	150	=item B<-sh> I<number>
153		151
154	Darken (0 .. 100) or lighten (-1 .. -100) the transparent	152	Darken (0 .. 99) or lighten (101 .. 200) the transparent background.
155	background image in addition to (or instead of) tinting it;	153	A value of 100 means no shading; resource I<shading>.
156	resource I<shading>.
157		154
158	=item B<-blt> I<string>	155	=item B<-blt> I<string>
159		156
160	Specify background blending type. If background pixmap is specified	157	Specify background blending type. If background pixmap is specified
161	at the same time as transparency - such pixmap will be blended over	158	at the same time as transparency - such pixmap will be blended over
162	transparency image, using method specified. Supported values are :	159	the transparent background, using the method specified. Supported values are:
163	B<add>, B<alphablend>, B<allanon> - color values averaging, B<colorize>,	160	B<add>, B<alphablend>, B<allanon> - colour values averaging, B<colorize>,
164	B<darken>, B<diff>, B<dissipate>, B<hue>, B<lighten>, B<overlay>,	161	B<darken>, B<diff>, B<dissipate>, B<hue>, B<lighten>, B<overlay>,
165	B<saturate>, B<screen>, B<sub>, B<tint>, B<value>. The default is	162	B<saturate>, B<screen>, B<sub>, B<tint>, B<value>. The default is
166	alpha-blending; resource I<blendType>.	163	alpha-blending. Compile I<afterimage>; resource I<blendType>.
167		164
168	=item B<-blr> I<HxV>	165	=item B<-blr> I<HxV>
169		166
170	Apply Gaussian Blur with the specified radii to the transparent	167	Apply Gaussian Blur with the specified radii to the transparent
171	background image. If single number is specified - both vertical and	168	background. If a single number is specified, the vertical and
172	horizontal radii are considered to be the same. Setting one of the	169	horizontal radii are considered to be the same. Setting one of the
173	radii to 1 and another to a large number creates interesting effects	170	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>.	171	on some backgrounds. The maximum radius value is 128. An horizontal or
		172	vertical radius of 0 disables blurring;
		173	resource I<blurRadius>.
		174
		175	=item B<-icon> I<file>
		176
		177	Compile I<afterimage> or I<pixbuf>: Use the specified image as application icon. This
		178	is used by many window managers, taskbars and pagers to represent the
		179	application window; resource I<iconFile>.
175		180
176	=item B<-bg> I<colour>	181	=item B<-bg> I<colour>
177		182
178	Window background colour; resource B<background>.	183	Window background colour; resource B<background>.
179		184
180	=item B<-fg> I<colour>	185	=item B<-fg> I<colour>
181		186
182	Window foreground colour; resource B<foreground>.	187	Window foreground colour; resource B<foreground>.
183		188
184	=item B<-pixmap> I<file[;geom]>	189	=item B<-pixmap> I<file[;oplist]>
185		190
186	Compile I<afterimage>: Specify image file for the background and also	191	Compile I<afterimage> or I<pixbuf>: Specify image file for the background and also
187	optionally specify its scaling with a geometry string. Note you may need to	192	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	193	add quotes to avoid special shell interpretation of the C<;> in the
189	command-line; for more details see resource B<backgroundPixmap>.	194	command-line; for more details see resource B<backgroundPixmap>.
190		195
191	=item B<-cr> I<colour>	196	=item B<-cr> I<colour>
192		197
…		…
239	italic> >> characters are to be printed. See resource B<boldItalicFont>	244	italic> >> characters are to be printed. See resource B<boldItalicFont>
240	for details.	245	for details.
241		246
242	=item B<-is>\|B<+is>	247	=item B<-is>\|B<+is>
243		248
244	Compile I<font-styles>: Bold/Italic font styles imply high intensity	249	Compile I<font-styles>: Bold/Blink font styles imply high intensity
245	foreground/background (default). See resource B<intensityStyles> for	250	foreground/background (default). See resource B<intensityStyles> for
246	details.	251	details.
247		252
248	=item B<-name> I<name>	253	=item B<-name> I<name>
249		254
…		…
267		272
268	=item B<-sb>\|B<+sb>	273	=item B<-sb>\|B<+sb>
269		274
270	Turn on/off scrollbar; resource B<scrollBar>.	275	Turn on/off scrollbar; resource B<scrollBar>.
271		276
		277	=item B<-sr>\|B<+sr>
		278
		279	Put scrollbar on right/left; resource B<scrollBar_right>.
		280
		281	=item B<-st>\|B<+st>
		282
		283	Display rxvt (non XTerm/NeXT) scrollbar without/with a trough;
		284	resource B<scrollBar_floating>.
		285
272	=item B<-si>\|B<+si>	286	=item B<-si>\|B<+si>
273		287
274	Turn on/off scroll-to-bottom on TTY output inhibit; resource	288	Turn on/off scroll-to-bottom on TTY output inhibit; resource
275	B<scrollTtyOutput> has opposite effect.	289	B<scrollTtyOutput> has opposite effect.
276		290
…		…
282	=item B<-sw>\|B<+sw>	296	=item B<-sw>\|B<+sw>
283		297
284	Turn on/off scrolling with the scrollback buffer as new lines appear.	298	Turn on/off scrolling with the scrollback buffer as new lines appear.
285	This only takes effect if B<-si> is also given; resource	299	This only takes effect if B<-si> is also given; resource
286	B<scrollWithBuffer>.	300	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		301
297	=item B<-ptab>\|B<+ptab>	302	=item B<-ptab>\|B<+ptab>
298		303
299	If enabled (default), "Horizontal Tab" characters are being stored as	304	If enabled (default), "Horizontal Tab" characters are being stored as
300	actual wide characters in the screen buffer, which makes it possible to	305	actual wide characters in the screen buffer, which makes it possible to
…		…
304		309
305	=item B<-bc>\|B<+bc>	310	=item B<-bc>\|B<+bc>
306		311
307	Blink the cursor; resource B<cursorBlink>.	312	Blink the cursor; resource B<cursorBlink>.
308		313
		314	=item B<-uc>\|B<+uc>
		315
		316	Make the cursor underlined; resource B<cursorUnderline>.
		317
309	=item B<-iconic>	318	=item B<-iconic>
310		319
311	Start iconified, if the window manager supports that option.	320	Start iconified, if the window manager supports that option.
312	Alternative form is B<-ic>.	321	Alternative form is B<-ic>.
313		322
…		…
329		338
330	=item B<-bl>	339	=item B<-bl>
331		340
332	Compile I<frills>: Set MWM hints to request a borderless window, i.e.	341	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	342	if honoured by the WM, the rxvt-unicode window will not have window
334	decorations; resource B<borderLess>.	343	decorations; resource B<borderLess>. If the window manager does not
		344	support MWM hints (e.g. kwin), enables override-redirect mode.
335		345
336	=item B<-override-redirect>	346	=item B<-override-redirect>
337		347
338	Compile I<frills>: Sets override-redirect on the window; resource	348	Compile I<frills>: Sets override-redirect on the window; resource
339	B<override-redirect>.	349	B<override-redirect>.
…		…
347		357
348	=item B<-lsp> I<number>	358	=item B<-lsp> I<number>
349		359
350	Compile I<frills>: Lines (pixel height) to insert between each row of	360	Compile I<frills>: Lines (pixel height) to insert between each row of
351	the display. Useful to work around font rendering problems; resource	361	the display. Useful to work around font rendering problems; resource
352	B<linespace>.	362	B<lineSpace>.
		363
		364	=item B<-letsp> I<number>
		365
		366	Compile I<frills>: Amount to adjust the computed character width by
		367	to control overall letter spacing. Negative values will tighten up the
		368	letter spacing, positive values will space letters out more. Useful to
		369	work around odd font metrics; resource B<letterSpace>.
353		370
354	=item B<-tn> I<termname>	371	=item B<-tn> I<termname>
355		372
356	This option specifies the name of the terminal type to be set in the	373	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	374	B<TERM> environment variable. This terminal type must exist in the
…		…
412		429
413	=item B<-tcw>	430	=item B<-tcw>
414		431
415	Change the meaning of triple-click selection with the left mouse	432	Change the meaning of triple-click selection with the left mouse
416	button. Only effective when the original (non-perl) selection code is	433	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	434	in-use. Instead of selecting a full line it will extend the selection to
418	end of the logical line only. resource B<tripleclickwords>.	435	the end of the logical line only. resource B<tripleclickwords>.
419		436
420	=item B<-insecure>	437	=item B<-insecure>
421		438
422	Enable "insecure" mode, which currently enables most of the escape	439	Enable "insecure" mode, which currently enables most of the escape
423	sequences that echo strings. See the resource B<insecure> for more	440	sequences that echo strings. See the resource B<insecure> for more
…		…
443		460
444	Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@	461	Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@
445	will not immediately destroy its window when the program executed within	462	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	463	it exits. Instead, it will wait till it is being killed or closed by the
447	user; resource B<hold>.	464	user; resource B<hold>.
		465
		466	=item B<-cd> I<path>
		467
		468	Sets the working directory for the shell (or the command specified via
		469	B<-e>). The I<path> must be an absolute path and it must exist for
		470	@@RXVT_NAME@@ to start; resource B<chdir>.
		471
		472	=item B<-xrm> I<string>
		473
		474	Works like the X Toolkit option of the same name, by adding the I<string>
		475	as if it were specified in a resource file. Resource values specified this
		476	way take precedence over all other resource specifications.
		477
		478	Note that you need to use the I<same> syntax as in the .Xdefaults file,
		479	e.g. C<*.background: black>. Also note that all @@RXVT_NAME@@-specific
		480	options can be specified as long-options on the commandline, so use
		481	of B<-xrm> is mostly limited to cases where you want to specify other
		482	resources (e.g. for input methods) or for compatibility with other
		483	programs.
448		484
449	=item B<-keysym.>I<sym> I<string>	485	=item B<-keysym.>I<sym> I<string>
450		486
451	Remap a key symbol. See resource B<keysym>.	487	Remap a key symbol. See resource B<keysym>.
452		488
…		…
487	If this switch is given, @@RXVT_NAME@@ will not create any utmp/wtmp	523	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	524	entries and will not tinker with pty/tty permissions - you have to do that
489	yourself if you want that.	525	yourself if you want that.
490		526
491	As an extremely special case, specifying C<-1> will completely suppress	527	As an extremely special case, specifying C<-1> will completely suppress
492	pty/tty operations.	528	pty/tty operations, which is probably only useful in conjunction with some
		529	perl extension that manages the terminal.
493		530
494	Here is a example in perl that illustrates how this option can be used (a	531	Here is a example in perl that illustrates how this option can be used (a
495	longer example is in F<doc/pty-fd>):	532	longer example is in F<doc/pty-fd>):
496		533
497	use IO::Pty;	534	use IO::Pty;
…		…
511	Comma-separated list of perl extension scripts to use (or not to use) in	548	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.	549	this terminal instance. See resource B<perl-ext> for details.
513		550
514	=back	551	=back
515		552
516	=head1 RESOURCES (available also as long-options)	553	=head1 RESOURCES
517		554
518	Note: `@@RXVT_NAME@@ --help' gives a list of all resources (long	555	Note: `@@RXVT_NAME@@ --help' gives a list of all resources (long
519	options) compiled into your version.	556	options) compiled into your version. All resources are also available as
		557	long-options.
520		558
521	You can set and change the resources using X11 tools like B<xrdb>. Many	559	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	560	distribution do also load settings from the B<~/.Xresources> file when X
523	starts. @@RXVT_NAME@@ will consult the following files/resources in order,	561	starts. @@RXVT_NAME@@ will consult the following files/resources in order,
524	with later settings overwriting earlier ones:	562	with later settings overwriting earlier ones:
525		563
526	1. system-wide app-defaults file, either locale-dependent OR global
527	2. app-defaults file in $XAPPLRESDIR	564	1. app-defaults file in $XAPPLRESDIR
		565	2. $HOME/.Xdefaults
528	3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults	566	3. RESOURCE_MANAGER property on root-window of screen 0
529	4. SCREEN_RESOURCES for the current screen	567	4. SCREEN_RESOURCES property on root-window of the current screen
530	5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename>	568	5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename>
		569	6. resources specified via -xrm on the commandline
531		570
532	Note that when reading X resources, B<@@RXVT_NAME@@> recognizes two class	571	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	572	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	573	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	574	configured, while the class name B<URxvt> allows resources unique to
…		…
545	=item B<depth:> I<bitdepth>	584	=item B<depth:> I<bitdepth>
546		585
547	Compile I<xft>: Attempt to find a visual with the given bit depth;	586	Compile I<xft>: Attempt to find a visual with the given bit depth;
548	option B<-depth>.	587	option B<-depth>.
549		588
		589	=item B<buffered:> I<boolean>
		590
		591	Compile I<xft>: Turn on/off double-buffering for xft (default enabled).
		592	On some card/driver combination enabling it slightly decreases
		593	performance, on most it greatly helps it. The slowdown is small, so it
		594	should normally be enabled.
		595
550	=item B<geometry:> I<geom>	596	=item B<geometry:> I<geom>
551		597
552	Create the window with the specified X window geometry [default 80x24];	598	Create the window with the specified X window geometry [default 80x24];
553	option B<-geometry>.	599	option B<-geometry>.
554		600
…		…
567	Use the specified colour for the colour value I<n>, where 0-7	613	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	614	corresponds to low-intensity (normal) colours and 8-15 corresponds to
569	high-intensity (bold = bright foreground, blink = bright background)	615	high-intensity (bold = bright foreground, blink = bright background)
570	colours. The canonical names are as follows: 0=black, 1=red, 2=green,	616	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	617	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.	618	names used are listed in the B<COLOURS AND GRAPHICS> section.
573		619
574	Colours higher than 15 cannot be set using resources (yet), but can be	620	Colours higher than 15 cannot be set using resources (yet), but can be
575	changed using an escape command (see @@RXVT_NAME@@(7)).	621	changed using an escape command (see @@RXVT_NAME@@(7)).
576		622
577	Colours 16-79 form a standard 4x4x4 colour cube (the same as xterm with	623	Colours 16-79 form a standard 4x4x4 colour cube (the same as xterm with
…		…
588	=item B<colorUL:> I<colour>	634	=item B<colorUL:> I<colour>
589		635
590	Use the specified colour to display underlined characters when the	636	Use the specified colour to display underlined characters when the
591	foreground colour is the default.	637	foreground colour is the default.
592		638
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>	639	=item B<underlineColor:> I<colour>
599		640
600	If set, use the specified colour as the colour for the underline	641	If set, use the specified colour as the colour for the underline
601	itself. If unset, use the foreground colour.	642	itself. If unset, use the foreground colour.
		643
		644	=item B<highlightColor:> I<colour>
		645
		646	If set, use the specified colour as the background for highlighted
		647	characters. If unset, use reverse video.
		648
		649	=item B<highlightTextColor:> I<colour>
		650
		651	If set and highlightColor is set, use the specified colour as the
		652	foreground for highlighted characters.
602		653
603	=item B<cursorColor:> I<colour>	654	=item B<cursorColor:> I<colour>
604		655
605	Use the specified colour for the cursor. The default is to use the	656	Use the specified colour for the cursor. The default is to use the
606	foreground colour; option B<-cr>.	657	foreground colour; option B<-cr>.
…		…
613		664
614	=item B<reverseVideo:> I<boolean>	665	=item B<reverseVideo:> I<boolean>
615		666
616	B<True>: simulate reverse video by foreground and background colours;	667	B<True>: simulate reverse video by foreground and background colours;
617	option B<-rv>. B<False>: regular screen colours [default]; option	668	option B<-rv>. B<False>: regular screen colours [default]; option
618	B<+rv>. See note in B<COLORS AND GRAPHICS> section.	669	B<+rv>. See note in B<COLOURS AND GRAPHICS> section.
619		670
620	=item B<jumpScroll:> I<boolean>	671	=item B<jumpScroll:> I<boolean>
621		672
622	B<True>: specify that jump scrolling should be used. When receiving lots	673	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	674	of lines, @@RXVT_NAME@@ will only scroll once a whole screen height of lines
…		…
637		688
638	B<False>: specify that everything is to be displayed, even	689	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	690	if the refresh is too fast for the human eye to read anything (or the
640	monitor to display anything); option B<+ss>.	691	monitor to display anything); option B<+ss>.
641		692
642	=item B<inheritPixmap:> I<boolean>	693	=item B<transparent:> I<boolean>
643		694
644	B<True>: make the background inherit the parent windows' pixmap, giving	695	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		696
648	I<Please note that transparency of any kind if completely unsupported by	697	B<inheritPixmap> is still accepted as an obsolete alias but will be removed in
649	the author. Don't bug him with installation questions!>	698	future versions.
650		699
651	=item B<fading:> I<number>	700	=item B<fading:> I<number>
652		701
653	Fade the text by the given percentage when focus is lost; option B<-fade>.	702	Fade the text by the given percentage when focus is lost; option B<-fade>.
654		703
…		…
657	Fade to this colour, when fading is used (see B<fading:>). The default	706	Fade to this colour, when fading is used (see B<fading:>). The default
658	colour is black; option B<-fadecolor>.	707	colour is black; option B<-fadecolor>.
659		708
660	=item B<tintColor:> I<colour>	709	=item B<tintColor:> I<colour>
661		710
662	Tint the transparent background pixmap with the given colour; option	711	Tint the transparent background with the given colour. If the RENDER
663	B<-tint>.	712	extension is not available only black, red, green, yellow, blue,
		713	magenta, cyan and white tints can be performed server-side. Note that
		714	a black tint yields a completely black image while a white tint yields
		715	the image unchanged; option B<-tint>.
664		716
665	=item B<shading:> I<number>	717	=item B<shading:> I<number>
666		718
667	Darken (0 .. 100) or lighten (-1 .. -100) the transparent background image	719	Darken (0 .. 99) or lighten (101 .. 200) the transparent background.
668	in addition to tinting it; option B<-sh>.	720	A value of 100 means no shading; option B<-sh>.
669		721
670	=item B<blendType:> I<string>	722	=item B<blendType:> I<string>
671		723
672	Specify background blending type; option B<-blt>.	724	Specify background blending type; option B<-blt>.
673		725
674	=item B<blurRadius:> I<number>	726	=item B<blurRadius:> I<number>
675		727
676	Apply Gaussian Blurr with the specified radius to the transparent	728	Apply gaussian blur with the specified radius to the transparent
677	background image; option B<-blr>.	729	background; option B<-blr>.
		730
		731	=item B<iconFile:> I<file>
		732
		733	Set the application icon pixmap; option B<-icon>.
678		734
679	=item B<scrollColor:> I<colour>	735	=item B<scrollColor:> I<colour>
680		736
681	Use the specified colour for the scrollbar [default #B2B2B2].	737	Use the specified colour for the scrollbar [default #B2B2B2].
682		738
…		…
688	=item B<borderColor:> I<colour>	744	=item B<borderColor:> I<colour>
689		745
690	The colour of the border around the text area and between the scrollbar	746	The colour of the border around the text area and between the scrollbar
691	and the text.	747	and the text.
692		748
693	=item B<backgroundPixmap:> I<file[;geom]>	749	=item B<backgroundPixmap:> I<file[;oplist]>
694		750
695	Use the specified image file for the background and also optionally	751	Use the specified image file for the background and also
696	specify its scaling with a geometry string B<WxH+X+Y>,	752	optionally specify a colon separated list of operations to modify it.
697	in which B<"W" / "H"> specify the horizontal/vertical scale (percent),	753	Supported operations are:
		754
		755	=over 4
		756
		757	=item B<WxH+X+Y>
		758
		759	sets scale and position. B<"W" / "H"> specify the horizontal/vertical
698	and B<"X" / "Y"> locate the image centre (percent).	760	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	761	scale of 0 disables scaling. The maximum permitted scale is 1000.
700	image without any scaling. A scale of 2 to 9 specifies an integer	762
701	number of images in that direction. No image will be magnified beyond	763	=item B<op=tile>
702	10 times its original size. The maximum permitted scale is 1000.	764
703	Special string of B<"auto"> used as a geometry will cause image to be	765	enables tiling
704	automatically scaled to match window size.	766
		767	=item B<op=keep-aspect>
		768
		769	maintain the image aspect ratio when scaling
		770
		771	=item B<op=root-align>
		772
		773	use the position of the terminal window relative to the root window as
		774	the image offset, simulating a root window background
		775
		776	=back
		777
		778	The default scale and position setting is C<100x100+50+50>.
		779	Alternatively, a predefined set of templates can be used to achieve
		780	the most common setups:
		781
		782	=over 4
		783
		784	=item B<style=tiled>
		785
		786	the image is tiled with no scaling. Equivalent to 0x0+0+0:op=tile
		787
		788	=item B<style=aspect-stretched>
		789
		790	the image is scaled to fill the whole window maintaining the aspect
		791	ratio and centered. Equivalent to 100x100+50+50:op=keep-aspect
		792
		793	=item B<style=stretched>
		794
		795	the image is scaled to fill the whole window. Equivalent to 100x100
		796
		797	=item B<style=centered>
		798
		799	the image is centered with no scaling. Equivalent to 0x0+50+50
		800
		801	=item B<style=root-tiled>
		802
		803	the image is tiled with no scaling and using 'root' positioning.
		804	Equivalent to 0x0:op=tile:op=root-align
		805
		806	=back
		807
		808	If multiple templates are specified the last one wins. Note that a
		809	template overrides all the scale, position and operations settings.
		810
705	If used in conjunction with B<-tr> option - specified pixmap will be	811	If used in conjunction with B<-tr> option, the specified pixmap will be
706	blended over transparency image using either alpha-blending, or any	812	blended over the transparent background using alpha-blending. If I<afterimage>
707	other blending type, specified with B<-blt "type"> option.	813	support has been compiled in it is possible to choose other blending
708	[default 0x0+50+50]	814	types with B<-blt "type"> option.
709		815
710	=item B<path:> I<path>	816	=item B<path:> I<path>
711		817
712	Specify the colon-delimited search path for finding XPM files.	818	Specify the colon-delimited search path for finding background image files.
713		819
714	=item B<font:> I<fontlist>	820	=item B<font:> I<fontlist>
715		821
716	Select the fonts to be used. This is a comma separated list of font names	822	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	823	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	846	it is named first) and thus defines the character cell grid to be 9 pixels
741	wide and 15 pixels high.	847	wide and 15 pixels high.
742		848
743	The second font is just used to add additional unicode characters not in	849	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	850	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	851	the bold version of the font does contain fewer characters, so this is a
746	useful supplement.	852	useful supplement.
747		853
748	The third font is an Xft font with aliasing turned off, and the characters	854	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	855	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.	856	contains other characters, but we are not interested in them.
…		…
774	text font will being used for the given style.	880	text font will being used for the given style.
775		881
776	=item B<intensityStyles:> I<boolean>	882	=item B<intensityStyles:> I<boolean>
777		883
778	When font styles are not enabled, or this option is enabled (B<True>,	884	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	885	option B<-is>, the default), bold/blink font styles imply high
780	intensity foreground/background colours. Disabling this option (B<False>,	886	intensity foreground/background colours. Disabling this option (B<False>,
781	option B<+is>) disables this behaviour, the high intensity colours are not	887	option B<+is>) disables this behaviour, the high intensity colours are not
782	reachable.	888	reachable.
783		889
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>	890	=item B<title:> I<string>
797		891
798	Set window title string, the default title is the command-line	892	Set window title string, the default title is the command-line
799	specified after the B<-e> option, if any, otherwise the application	893	specified after the B<-e> option, if any, otherwise the application
800	name; option B<-title>.	894	name; option B<-title>.
…		…
813	=item B<urgentOnBell:> I<boolean>	907	=item B<urgentOnBell:> I<boolean>
814		908
815	B<True>: set the urgency hint for the wm on receipt of a bell character.	909	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].	910	B<False>: do not set the urgency hint [default].
817		911
		912	@@RXVT_NAME@@ resets the urgency hint on every focus change.
		913
818	=item B<visualBell:> I<boolean>	914	=item B<visualBell:> I<boolean>
819		915
820	B<True>: use visual bell on receipt of a bell character; option B<-vb>.	916	B<True>: use visual bell on receipt of a bell character; option B<-vb>.
821	B<False>: no visual bell [default]; option B<+vb>.	917	B<False>: no visual bell [default]; option B<+vb>.
822		918
…		…
845	URxvt.print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX)	941	URxvt.print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX)
846		942
847	This creates a new file in your home directory with the screen contents	943	This creates a new file in your home directory with the screen contents
848	every time you hit C<Print>.	944	every time you hit C<Print>.
849		945
		946	=item B<scrollstyle:> I<mode>
		947
		948	Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is
		949	the author's favourite.
		950
		951	=item B<thickness:> I<number>
		952
		953	Set the scrollbar width in pixels.
		954
850	=item B<scrollBar:> I<boolean>	955	=item B<scrollBar:> I<boolean>
851		956
852	B<True>: enable the scrollbar [default]; option B<-sb>. B<False>:	957	B<True>: enable the scrollbar [default]; option B<-sb>. B<False>:
853	disable the scrollbar; option B<+sb>.	958	disable the scrollbar; option B<+sb>.
854		959
…		…
873	B<False>: do not scroll to bottom when tty receives output; option	978	B<False>: do not scroll to bottom when tty receives output; option
874	B<+si>.	979	B<+si>.
875		980
876	=item B<scrollWithBuffer:> I<boolean>	981	=item B<scrollWithBuffer:> I<boolean>
877		982
878	B<True>: scroll with scrollback buffer when tty receives new lines (and	983	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	984	try to show the same lines) and B<scrollTtyOutput> is False; option
880	with scrollback buffer when tty receives new lines; option B<+sw>.	985	B<-sw>. B<False>: do not scroll with scrollback buffer when tty receives
		986	new lines; option B<+sw>.
881		987
882	=item B<scrollTtyKeypress:> I<boolean>	988	=item B<scrollTtyKeypress:> I<boolean>
883		989
884	B<True>: scroll to bottom when a non-special key is pressed. Special keys	990	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	991	are those which are intercepted by rxvt-unicode for special handling and
…		…
916	=item B<termName:> I<termname>	1022	=item B<termName:> I<termname>
917		1023
918	Specifies the terminal type name to be set in the B<TERM> environment	1024	Specifies the terminal type name to be set in the B<TERM> environment
919	variable; option B<-tn>.	1025	variable; option B<-tn>.
920		1026
921	=item B<linespace:> I<number>	1027	=item B<lineSpace:> I<number>
922		1028
923	Specifies number of lines (pixel height) to insert between each row of	1029	Specifies number of lines (pixel height) to insert between each row of
924	the display [default 0]; option B<-lsp>.	1030	the display [default 0]; option B<-lsp>.
925		1031
926	=item B<meta8:> I<boolean>	1032	=item B<meta8:> I<boolean>
…		…
940		1046
941	=item B<cursorBlink:> I<boolean>	1047	=item B<cursorBlink:> I<boolean>
942		1048
943	B<True>: blink the cursor. B<False>: do not blink the cursor [default];	1049	B<True>: blink the cursor. B<False>: do not blink the cursor [default];
944	option B<-bc>.	1050	option B<-bc>.
		1051
		1052	=item B<cursorUnderline:> I<boolean>
		1053
		1054	B<True>: Make the cursor underlined. B<False>: Make the cursor a box [default];
		1055	option B<-uc>.
945		1056
946	=item B<pointerBlank:> I<boolean>	1057	=item B<pointerBlank:> I<boolean>
947		1058
948	B<True>: blank the pointer when a key is pressed or after a set number	1059	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	1060	of seconds of inactivity. B<False>: the pointer is always visible
…		…
963	large number (e.g. C<987654321>) to effectively disable the timeout.	1074	large number (e.g. C<987654321>) to effectively disable the timeout.
964		1075
965	=item B<backspacekey:> I<string>	1076	=item B<backspacekey:> I<string>
966		1077
967	The string to send when the backspace key is pressed. If set to B<DEC>	1078	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>	1079	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	1080	(code 8) - which can be reversed with the appropriate DEC private mode
970	escape sequence.	1081	escape sequence.
971		1082
972	=item B<deletekey:> I<string>	1083	=item B<deletekey:> I<string>
973		1084
…		…
986	will be created). In this mode, characters outside ISO-8859-1 can be used.	1097	will be created). In this mode, characters outside ISO-8859-1 can be used.
987		1098
988	When the selection extension is not used, only ISO-8859-1 characters can	1099	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:	1100	be used. If not specified, the built-in default is used:
990		1101
991	B<< BACKSLASH `"'&()*,;<=>?@[]{\|} >>	1102	B<< BACKSLASH `"'&()*,;<=>?@[]^{\|} >>
992		1103
993	=item B<preeditType:> I<style>	1104	=item B<preeditType:> I<style>
994		1105
995	B<OverTheSpot>, B<OffTheSpot>, B<Root>; option B<-pt>.	1106	B<OverTheSpot>, B<OffTheSpot>, B<Root>; option B<-pt>.
996		1107
…		…
1052		1163
1053	=item B<secondaryScroll:> I<boolean>	1164	=item B<secondaryScroll:> I<boolean>
1054		1165
1055	Turn on/off secondary screen scroll (default enabled). If this	1166	Turn on/off secondary screen scroll (default enabled). If this
1056	option is enabled, scrolls on the secondary screen will change the	1167	option is enabled, scrolls on the secondary screen will change the
1057	scrollback buffer and switching to/from the secondary screen will	1168	scrollback buffer and, when secondaryScreen is off, switching
1058	instead scroll the screen up.	1169	to/from the secondary screen will instead scroll the screen up.
1059		1170
1060	=item B<hold>: I<boolean>	1171	=item B<hold>: I<boolean>
1061		1172
1062	Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@	1173	Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@
1063	will not immediately destroy its window when the program executed within	1174	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	1175	it exits. Instead, it will wait till it is being killed or closed by the
1065	user.	1176	user.
		1177
		1178	=item B<chdir>: I<path>
		1179
		1180	Sets the working directory for the shell (or the command specified via
		1181	B<-e>). The I<path> must be an absolute path and it must exist for
		1182	@@RXVT_NAME@@ to start. If it isn't specified then the current working
		1183	directory will be used; option B<-cd>.
1066		1184
1067	=item B<keysym.>I<sym>: I<string>	1185	=item B<keysym.>I<sym>: I<string>
1068		1186
1069	Compile I<frills>: Associate I<string> with keysym I<sym>. The	1187	Compile I<frills>: Associate I<string> with keysym I<sym>. The
1070	intervening resource name B<keysym.> cannot be omitted.	1188	intervening resource name B<keysym.> cannot be omitted.
…		…
1084	searching keysym macros from B</usr/X11R6/include/X11/keysymdef.h> and	1202	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	1203	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	1204	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.	1205	performed in an exact manner; however, the closest match is assured.
1088		1206
1089	I<string> may contain escape values (C<\a>: bell, C<\b>: backspace,	1207	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,	1208	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		1209
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>	1210	You can define a range of keysyms in one shot by
		1211	loading the C<keysym-list> perl extension and providing a I<string>
1102	with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimiter `/'	1212	with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimiter `/'
1103	should be a character not used by the strings.	1213	should be a character not used by the strings.
1104		1214
1105	Its usage can be demonstrated by an example:	1215	Its usage can be demonstrated by an example:
1106		1216
1107	URxvt.keysym.M-C-0x61: list\|\033<M-C-\|abc\|>	1217	URxvt.keysym.M-C-0x61: list\|\033<\|abc\|>
1108		1218
1109	The above line is equivalent to the following three lines:	1219	The above line is equivalent to the following three lines:
1110		1220
1111	URxvt.keysym.Meta-Control-0x61: \033<M-C-a>	1221	URxvt.keysym.Meta-Control-0x61: \033<a>
1112	URxvt.keysym.Meta-Control-0x62: \033<M-C-b>	1222	URxvt.keysym.Meta-Control-0x62: \033<b>
1113	URxvt.keysym.Meta-Control-0x63: \033<M-C-c>	1223	URxvt.keysym.Meta-Control-0x63: \033<c>
1114		1224
1115	If I<string> takes the form of C<command:STRING>, the specified B<STRING>	1225	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	1226	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>	1227	example the following means "change the current locale to C<zh_CN.GBK>
1118	when Control-Meta-c is being pressed":	1228	when Control-Meta-c is being pressed":
1119		1229
1120	URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007	1230	URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007
1121		1231
1122	If I<string> takes the form C<perl:STRING>, then the specified B<STRING>	1232	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)	1233	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	1234	manpage. For example, the F<selection> extension (activated via
1125	C<@@RXVT_NAME@@ -pe selection>) listens for C<selection:rot13> events:	1235	C<@@RXVT_NAME@@ -pe selection>) listens for C<selection:rot13> events:
1126		1236
1127	URxvt.keysym.M-C-c: perl:selection:rot13	1237	URxvt.keysym.M-C-c: perl:selection:rot13
1128		1238
1129	Due the the large number of modifier combinations, a defined key mapping	1239	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	1240	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	1241	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	1242	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	1243	definitions for C<Meta-a>, C<Shift-a> and so on, unless some of those are defined
1134	mappings themselves.	1244	mappings themselves.
1135		1245
…		…
1186	all instances, while B<perl-ext> is used for specific instances.	1296	all instances, while B<perl-ext> is used for specific instances.
1187		1297
1188	=item B<perl-eval>: I<string>	1298	=item B<perl-eval>: I<string>
1189		1299
1190	Perl code to be evaluated when all extensions have been registered. See	1300	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	1301	the @@RXVT_NAME@@perl(3) manpage.
1192	will be ignored when running setuid/setgid.
1193		1302
1194	=item B<perl-lib>: I<path>	1303	=item B<perl-lib>: I<path>
1195		1304
1196	Colon-separated list of additional directories that hold extension	1305	Colon-separated list of additional directories that hold extension
1197	scripts. When looking for extensions specified by the C<perl> resource,	1306	scripts. When looking for perl extensions, @@RXVT_NAME@@ will first
1198	@@RXVT_NAME@@ will first look in these directories and then in	1307	look in these directories, then in $HOME/.urxvt/ext and lastly in
1199	F<@@RXVT_LIBDIR@@/urxvt/perl/>. Due to security reasons, this resource	1308	F<@@RXVT_LIBDIR@@/urxvt/perl/>.
1200	will be ignored when running setuid/setgid.
1201		1309
1202	See the @@RXVT_NAME@@perl(3) manpage.	1310	See the @@RXVT_NAME@@perl(3) manpage.
1203		1311
1204	=item B<< selection.pattern-I<idx> >>: I<perl-regex>	1312	=item B<< selection.pattern-I<idx> >>: I<perl-regex>
1205		1313
…		…
1227		1335
1228	=item B<override-redirect>: I<boolean>	1336	=item B<override-redirect>: I<boolean>
1229		1337
1230	Compile I<frills>: Sets override-redirect for the terminal window, making	1338	Compile I<frills>: Sets override-redirect for the terminal window, making
1231	it almost invisible to window managers; option B<-override-redirect>.	1339	it almost invisible to window managers; option B<-override-redirect>.
		1340
		1341	=item B<iso14755:> I<boolean>
		1342
		1343	Turn on/off ISO 14755 (default enabled).
1232		1344
1233	=item B<iso14755_52:> I<boolean>	1345	=item B<iso14755_52:> I<boolean>
1234		1346
1235	Turn on/off ISO 14755 5.2 mode (default enabled).	1347	Turn on/off ISO 14755 5.2 mode (default enabled).
1236		1348
…		…
1379	B<@@RXVT_NAME@@> tries to write an entry into the I<utmp>(5) file so that	1491	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	1492	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	1493	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.	1494	on some systems or setgid to root or to some other group on others.
1383		1495
1384	=head1 COLORS AND GRAPHICS	1496	=head1 COLOURS AND GRAPHICS
1385		1497
1386	In addition to the default foreground and background colours,	1498	In addition to the default foreground and background colours,
1387	B<@@RXVT_NAME@@> can display up to 16 colours (8 ANSI colours plus	1499	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	1500	high-intensity (potentially bold/blink) versions of the same, and 72 (or
1389	colours with their names.	1501	240 in 256 colour mode) colours arranged in an 4x4x4 (or 6x6x6) colour RGB
		1502	cube plus a 8 (24) colour greyscale ramp.
		1503
		1504	Here is a list of the ANSI colours with their names.
1390		1505
1391	=begin table	1506	=begin table
1392		1507
1393	B<color0> (black) = Black	1508	B<color0> (black) = Black
1394	B<color1> (red) = Red3	1509	B<color1> (red) = Red3
…		…
1414	It is also possible to specify the colour values of B<foreground>,	1529	It is also possible to specify the colour values of B<foreground>,
1415	B<background>, B<cursorColor>, B<cursorColor2>, B<colorBD>, B<colorUL> as	1530	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	1531	a number 0-15, as a convenient shorthand to reference the colour name of
1417	color0-color15.	1532	color0-color15.
1418		1533
1419	In addition to the colours defined above, @@RXVT_NAME@@ offers an	1534	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)	1535	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		1536
		1537	The RGB cube uses indices 16..79 (16..231) using the following formulas:
		1538
		1539	index_88 = (r * 4 + g) * 4 + b + 16 # r, g, b = 0..3
		1540	index_256 = (r * 16 + g) * 16 + b + 16 # r, g, b = 0..15
		1541
		1542	The grayscale ramp uses indices 80..87 (232..239), from 10% to 90% in 10%
		1543	steps (1/26 to 25/26 in 1/26 steps) - black and white are already part of
		1544	the RGB cube.
		1545
1424	Together, all those colours implement the 88 colour xterm colours. Only	1546	Together, all those colours implement the 88 (256) colour xterm
1425	the first 16 can be changed using resources currently, the rest can only	1547	colours. Only the first 16 can be changed using resources currently, the
1426	be changed via command sequences ("escape codes").	1548	rest can only be changed via command sequences ("escape codes").
		1549
		1550	Applications are advised to use terminfo or command sequences to discover
		1551	number and RGB values of all colours (yes, you can query this...).
1427		1552
1428	Note that B<-rv> (B<"reverseVideo: True">) simulates reverse video by	1553	Note that B<-rv> (B<"reverseVideo: True">) simulates reverse video by
1429	always swapping the foreground/background colours. This is in contrast to	1554	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	1555	I<xterm>(1) where the colours are only swapped if they have not otherwise
1431	been specified. For example,	1556	been specified. For example,
1432		1557
1433	=over 4
1434
1435	=item B<@@RXVT_NAME@@ -fg Black -bg White -rv>	1558	@@RXVT_NAME@@ -fg Black -bg White -rv
1436		1559
1437	would yield White on Black, while on I<xterm>(1) it would yield Black	1560	would yield White on Black, while on I<xterm>(1) it would yield Black on
1438	on White.	1561	White.
1439
1440	=back
1441		1562
1442	=head2 ALPHA CHANNEL SUPPORT	1563	=head2 ALPHA CHANNEL SUPPORT
1443		1564
1444	If Xft support has been compiled in and as long as Xft/Xrender/X don't get	1565	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>	1566	their act together, rxvt-unicode will do its own alpha channel management:
1446	(recommended, but B<MUST> have 4 digits/component) colour specifications,	1567
1447	in addition to the ones provided by X, where the additional A component	1568	You can prefix any colour with an opaqueness percentage enclosed in
		1569	brackets, i.e. C<[percent]>, where C<percent> is a decimal percentage
		1570	(0-100) that specifies the opacity of the colour, where C<0> is completely
		1571	transparent and C<100> is completely opaque. For example, C<[50]red> is a
		1572	half-transparent red, while C<[95]#00ff00> is an almost opaque green. This
		1573	is the recommended format to specify transparency values, and works with
		1574	all ways to specify a colour.
		1575
		1576	For complete control, rxvt-unicode also supports
		1577	C<rgba:rrrr/gggg/bbbb/aaaa> (exactly four hex digits/component) colour
		1578	specifications, where the additional C<aaaa> component specifies opacity
1448	specifies opacity (alpha) values. The minimum value of C<0> is completely	1579	(alpha) values. The minimum value of C<0000> is completely transparent,
1449	transparent). You can also prefix any color with C<[percent]>, where	1580	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	1581	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	1582	C<rgba:0000/ff00/0000/f332>.
1452	opaque.
1453		1583
1454	You probably need to specify B<"-depth 32">, too, and have the luck that	1584	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	1585	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.	1586	layout, as X is far from just supporting ARGB visuals out of the box, and
		1587	rxvt-unicode just fudges around.
1457		1588
1458	For example, the following selects an almost completely transparent red	1589	For example, the following selects an almost completely transparent black
1459	background, and an almost opaque pink foreground:	1590	background, and an almost opaque pink foreground:
1460		1591
1461	@@RXVT_NAME@@ -depth 32 -bg rgba:0000/0000/0000/aaaa -fg "[80]pink"	1592	@@RXVT_NAME@@ -depth 32 -bg rgba:0000/0000/0000/4444 -fg "[80]pink"
1462		1593
1463	I<Please note that transparency of any kind if completely unsupported by	1594	When not using a background image, then the interpretation of the
1464	the author. Don't bug him with installation questions!>	1595	alpha channel is up to your compositing manager (most interpret it as
		1596	transparency of course).
		1597
		1598	When using a background pixmap or pseudo-transparency, then the background
		1599	colour will always behave as if it were completely transparent (so the
		1600	background image shows instead), regardless of how it was specified, while
		1601	other colours will either be transparent as specified (the background
		1602	image will show through) on servers supporting the RENDER extension, or
		1603	fully opaque on servers not supporting the RENDER EXTENSION.
		1604
		1605	Please note that due to bugs in Xft, specifying alpha values might result
		1606	in garbage being displayed when the X-server does not support the RENDER
		1607	extension.
1465		1608
1466	=head1 ENVIRONMENT	1609	=head1 ENVIRONMENT
1467		1610
1468	B<@@RXVT_NAME@@> sets and/or uses the following environment variables:	1611	B<@@RXVT_NAME@@> sets and/or uses the following environment variables:
1469		1612
…		…
1475	resources or on the command line.	1618	resources or on the command line.
1476		1619
1477	=item B<COLORTERM>	1620	=item B<COLORTERM>
1478		1621
1479	Either C<rxvt>, C<rxvt-xpm>, depending on whether @@RXVT_NAME@@ was	1622	Either C<rxvt>, C<rxvt-xpm>, depending on whether @@RXVT_NAME@@ was
1480	compiled with XPM support, and optionally with the added extension	1623	compiled with background image support, and optionally with the added
1481	C<-mono> to indicate that rxvt-unicode runs on a monochrome screen.	1624	extension C<-mono> to indicate that rxvt-unicode runs on a monochrome
		1625	screen.
1482		1626
1483	=item B<COLORFGBG>	1627	=item B<COLORFGBG>
1484		1628
1485	Set to a string of the form C<fg;bg> or C<fg;xpm;bg>, where C<fg> is	1629	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	1630	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	1631	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	1632	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@@	1633	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	1634	was compiled with background image support. Libraries like C<ncurses>
1491	(and do) use this information to optimize screen output.	1635	and C<slang> can (and do) use this information to optimize screen output.
1492		1636
1493	=item B<WINDOWID>	1637	=item B<WINDOWID>
1494		1638
1495	Set to the (decimal) X Window ID of the @@RXVT_NAME@@ window (the toplevel	1639	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	1640	window, which usually has subwindows for the scrollbar, the terminal
…		…
1502	C<--with-terminfo=PATH>.	1646	C<--with-terminfo=PATH>.
1503		1647
1504	=item B<DISPLAY>	1648	=item B<DISPLAY>
1505		1649
1506	Used by @@RXVT_NAME@@ to connect to the display and set to the correct	1650	Used by @@RXVT_NAME@@ to connect to the display and set to the correct
1507	display in its child processes.	1651	display in its child processes if C<-display> isn't used to override. It
		1652	defaults to C<:0> if it doesn't exist.
1508		1653
1509	=item B<SHELL>	1654	=item B<SHELL>
1510		1655
1511	The shell to be used for command execution, defaults to C</bin/sh>.	1656	The shell to be used for command execution, defaults to C</bin/sh>.
1512		1657
1513	=item B<RXVT_SOCKET>	1658	=item B<RXVT_SOCKET>
1514		1659
1515	The unix domain socket path used by @@RXVT_NAME@@c(1) and	1660	The unix domain socket path used by @@RXVT_NAME@@c(1) and
1516	@@RXVT_NAME@@d(1).	1661	@@RXVT_NAME@@d(1).
1517		1662
1518	Default F<<< $HOME/.rxvt-unicode-I<< <nodename >> >>>.	1663	Default F<<< $HOME/.urxvt/urxvtd-I<< <nodename> >> >>>.
1519		1664
1520	=item B<HOME>	1665	=item B<HOME>
1521		1666
1522	Used to locate the default directory for the unix domain socket for	1667	Used to locate the default directory for the unix domain socket for
1523	daemon communications and to locate various resource files (such as	1668	daemon communications and to locate various resource files (such as
1524	C<.Xdefaults>)	1669	C<.Xdefaults>)
1525		1670
1526	=item B<XAPPLRESDIR>	1671	=item B<XAPPLRESDIR>
1527		1672
1528	Directory where various X resource files are being located.	1673	Directory where application-specific X resource files are located.
1529		1674
1530	=item B<XENVIRONMENT>	1675	=item B<XENVIRONMENT>
1531		1676
1532	If set and accessible, gives the name of a X resource file to be loaded by	1677	If set and accessible, gives the name of a X resource file to be loaded by
1533	@@RXVT_NAME@@.	1678	@@RXVT_NAME@@.
…		…
1538		1683
1539	=over 4	1684	=over 4
1540		1685
1541	=item B</usr/lib/X11/rgb.txt>	1686	=item B</usr/lib/X11/rgb.txt>
1542		1687
1543	Color names.	1688	Colour names.
1544		1689
1545	=back	1690	=back
1546		1691
1547	=head1 SEE ALSO	1692	=head1 SEE ALSO
1548		1693
…		…
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.134 by sasha, Tue Jul 31 22:23:56 2007 UTC vs. Revision 1.212 by sf-exg, Sun Jan 1 14:31:28 2012 UTC

Diff Legend

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents):
Revision 1.134 by sasha, Tue Jul 31 22:23:56 2007 UTC vs.
Revision 1.212 by sf-exg, Sun Jan 1 14:31:28 2012 UTC