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

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents):
Revision 1.132 by root, Mon Jun 18 13:38:12 2007 UTC vs.
Revision 1.246 by sf-exg, Tue Jun 21 12:03:55 2016 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<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
		114	possible visual ids) instead of the default, and also allocate a private
		115	colormap. All visual types except for DirectColor are supported.
		116
103	=item B<-geometry> I<geom>	117	=item B<-geometry> I<geom>
104		118
105	Window geometry (B<-g> still respected); resource B<geometry>.	119	Window geometry (B<-g> still respected); resource B<geometry>.
106		120
107	=item B<-rv>\|B<+rv>	121	=item B<-rv>\|B<+rv>
…		…
113	Turn on/off jump scrolling (allow multiple lines per refresh); resource B<jumpScroll>.	127	Turn on/off jump scrolling (allow multiple lines per refresh); resource B<jumpScroll>.
114		128
115	=item B<-ss>\|B<+ss>	129	=item B<-ss>\|B<+ss>
116		130
117	Turn on/off skip scrolling (allow multiple screens per refresh); resource B<skipScroll>.	131	Turn on/off skip scrolling (allow multiple screens per refresh); resource B<skipScroll>.
118
119	=item B<-ip>\|B<+ip> \| B<-tr>\|B<+tr>
120
121	Turn on/off inheriting parent window's pixmap. Alternative form is
122	B<-tr>; resource B<inheritPixmap>.
123
124	I<Please note that transparency of any kind if completely unsupported by
125	the author. Don't bug him with installation questions! Read the FAQ (man 7
126	@@RXVT_NAME@@)!>
127		132
128	=item B<-fade> I<number>	133	=item B<-fade> I<number>
129		134
130	Fade the text by the given percentage when focus is lost. Small values	135	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	136	fade a little only, 100 completely replaces all colours by the fade
…		…
134	=item B<-fadecolor> I<colour>	139	=item B<-fadecolor> I<colour>
135		140
136	Fade to this colour when fading is used (see B<-fade>). The default colour	141	Fade to this colour when fading is used (see B<-fade>). The default colour
137	is opaque black. resource B<fadeColor>.	142	is opaque black. resource B<fadeColor>.
138		143
139	=item B<-tint> I<colour>	144	=item B<-icon> I<file>
140		145
141	Tint the transparent background pixmap with the given colour when	146	Compile I<pixbuf>: Use the specified image as application icon. This
142	transparency is enabled with B<-tr> or B<-ip>. This only works for	147	is used by many window managers, taskbars and pagers to represent the
143	non-tiled backgrounds, currently. See also the B<-sh> option that can be	148	application window; resource I<iconFile>.
144	used to brighten or darken the image in addition to tinting it; resource
145	I<tintColor>. Example:
146
147	@@RXVT_NAME@@ -tr -tint blue -sh 40
148
149	=item B<-sh> I<number>
150
151	Darken (0 .. 100) or lighten (-1 .. -100) the transparent
152	background image in addition to (or instead of) tinting it;
153	resource I<shading>.
154
155	=item B<-blt> I<string>
156
157	Specify background blending type. If background pixmap is specified
158	at the same time as transparency - such pixmap will be blended over
159	transparency image, using method specified. Supported values are :
160	B<add>, B<alphablend>, B<allanon> - color values averaging, B<colorize>,
161	B<darken>, B<diff>, B<dissipate>, B<hue>, B<lighten>, B<overlay>,
162	B<saturate>, B<screen>, B<sub>, B<tint>, B<value>. The default is
163	alpha-blending; resource I<blendType>.
164
165	=item B<-blr> I<number>
166
167	Apply Gaussian Blur with the specified radius to the transparent
168	background image; resource I<blurRadius>.
169		149
170	=item B<-bg> I<colour>	150	=item B<-bg> I<colour>
171		151
172	Window background colour; resource B<background>.	152	Window background colour; resource B<background>.
173		153
174	=item B<-fg> I<colour>	154	=item B<-fg> I<colour>
175		155
176	Window foreground colour; resource B<foreground>.	156	Window foreground colour; resource B<foreground>.
177
178	=item B<-pixmap> I<file[;geom]>
179
180	Compile I<afterimage>: Specify image file for the background and also
181	optionally specify its scaling with a geometry string. Note you may need to
182	add quotes to avoid special shell interpretation of the C<;> in the
183	command-line; for more details see resource B<backgroundPixmap>.
184		157
185	=item B<-cr> I<colour>	158	=item B<-cr> I<colour>
186		159
187	The cursor colour; resource B<cursorColor>.	160	The cursor colour; resource B<cursorColor>.
188		161
…		…
233	italic> >> characters are to be printed. See resource B<boldItalicFont>	206	italic> >> characters are to be printed. See resource B<boldItalicFont>
234	for details.	207	for details.
235		208
236	=item B<-is>\|B<+is>	209	=item B<-is>\|B<+is>
237		210
238	Compile I<font-styles>: Bold/Italic font styles imply high intensity	211	Compile I<font-styles>: Bold/Blink font styles imply high intensity
239	foreground/background (default). See resource B<intensityStyles> for	212	foreground/background (default). See resource B<intensityStyles> for
240	details.	213	details.
241		214
242	=item B<-name> I<name>	215	=item B<-name> I<name>
243		216
…		…
247		220
248	=item B<-ls>\|B<+ls>	221	=item B<-ls>\|B<+ls>
249		222
250	Start as a login-shell/sub-shell; resource B<loginShell>.	223	Start as a login-shell/sub-shell; resource B<loginShell>.
251		224
		225	=item B<-mc> I<milliseconds>
		226
		227	Specify the maximum time between multi-click selections.
		228
252	=item B<-ut>\|B<+ut>	229	=item B<-ut>\|B<+ut>
253		230
254	Compile I<utmp>: Inhibit/enable writing a utmp entry; resource	231	Compile I<utmp>: Inhibit/enable writing a utmp entry; resource
255	B<utmpInhibit>.	232	B<utmpInhibit>.
256		233
…		…
260	B<visualBell>.	237	B<visualBell>.
261		238
262	=item B<-sb>\|B<+sb>	239	=item B<-sb>\|B<+sb>
263		240
264	Turn on/off scrollbar; resource B<scrollBar>.	241	Turn on/off scrollbar; resource B<scrollBar>.
		242
		243	=item B<-sr>\|B<+sr>
		244
		245	Put scrollbar on right/left; resource B<scrollBar_right>.
		246
		247	=item B<-st>\|B<+st>
		248
		249	Display rxvt (non XTerm/NeXT) scrollbar without/with a trough;
		250	resource B<scrollBar_floating>.
265		251
266	=item B<-si>\|B<+si>	252	=item B<-si>\|B<+si>
267		253
268	Turn on/off scroll-to-bottom on TTY output inhibit; resource	254	Turn on/off scroll-to-bottom on TTY output inhibit; resource
269	B<scrollTtyOutput> has opposite effect.	255	B<scrollTtyOutput> has opposite effect.
…		…
276	=item B<-sw>\|B<+sw>	262	=item B<-sw>\|B<+sw>
277		263
278	Turn on/off scrolling with the scrollback buffer as new lines appear.	264	Turn on/off scrolling with the scrollback buffer as new lines appear.
279	This only takes effect if B<-si> is also given; resource	265	This only takes effect if B<-si> is also given; resource
280	B<scrollWithBuffer>.	266	B<scrollWithBuffer>.
281
282	=item B<-sr>\|B<+sr>
283
284	Put scrollbar on right/left; resource B<scrollBar_right>.
285
286	=item B<-st>\|B<+st>
287
288	Display rxvt (non XTerm/NeXT) scrollbar without/with a trough;
289	resource B<scrollBar_floating>.
290		267
291	=item B<-ptab>\|B<+ptab>	268	=item B<-ptab>\|B<+ptab>
292		269
293	If enabled (default), "Horizontal Tab" characters are being stored as	270	If enabled (default), "Horizontal Tab" characters are being stored as
294	actual wide characters in the screen buffer, which makes it possible to	271	actual wide characters in the screen buffer, which makes it possible to
…		…
298		275
299	=item B<-bc>\|B<+bc>	276	=item B<-bc>\|B<+bc>
300		277
301	Blink the cursor; resource B<cursorBlink>.	278	Blink the cursor; resource B<cursorBlink>.
302		279
		280	=item B<-uc>\|B<+uc>
		281
		282	Make the cursor underlined; resource B<cursorUnderline>.
		283
303	=item B<-iconic>	284	=item B<-iconic>
304		285
305	Start iconified, if the window manager supports that option.	286	Start iconified, if the window manager supports that option.
306	Alternative form is B<-ic>.	287	Alternative form is B<-ic>.
307		288
…		…
323		304
324	=item B<-bl>	305	=item B<-bl>
325		306
326	Compile I<frills>: Set MWM hints to request a borderless window, i.e.	307	Compile I<frills>: Set MWM hints to request a borderless window, i.e.
327	if honoured by the WM, the rxvt-unicode window will not have window	308	if honoured by the WM, the rxvt-unicode window will not have window
328	decorations; resource B<borderLess>.	309	decorations; resource B<borderLess>. If the window manager does not
		310	support MWM hints (e.g. kwin), enables override-redirect mode.
329		311
330	=item B<-override-redirect>	312	=item B<-override-redirect>
331		313
332	Compile I<frills>: Sets override-redirect on the window; resource	314	Compile I<frills>: Sets override-redirect on the window; resource
333	B<override-redirect>.	315	B<override-redirect>.
		316
		317	=item B<-dockapp>
		318
		319	Sets the initial state of the window to WithdrawnState, which makes
		320	window managers that support this extension treat it as a dockapp.
334		321
335	=item B<-sbg>	322	=item B<-sbg>
336		323
337	Compile I<frills>: Disable the usage of the built-in block graphics/line	324	Compile I<frills>: Disable the usage of the built-in block graphics/line
338	drawing characters and just rely on what the specified fonts provide. Use	325	drawing characters and just rely on what the specified fonts provide. Use
…		…
341		328
342	=item B<-lsp> I<number>	329	=item B<-lsp> I<number>
343		330
344	Compile I<frills>: Lines (pixel height) to insert between each row of	331	Compile I<frills>: Lines (pixel height) to insert between each row of
345	the display. Useful to work around font rendering problems; resource	332	the display. Useful to work around font rendering problems; resource
346	B<linespace>.	333	B<lineSpace>.
		334
		335	=item B<-letsp> I<number>
		336
		337	Compile I<frills>: Amount to adjust the computed character width by
		338	to control overall letter spacing. Negative values will tighten up the
		339	letter spacing, positive values will space letters out more. Useful to
		340	work around odd font metrics; resource B<letterSpace>.
347		341
348	=item B<-tn> I<termname>	342	=item B<-tn> I<termname>
349		343
350	This option specifies the name of the terminal type to be set in the	344	This option specifies the name of the terminal type to be set in the
351	B<TERM> environment variable. This terminal type must exist in the	345	B<TERM> environment variable. This terminal type must exist in the
…		…
386	=item B<-pt> I<style>	380	=item B<-pt> I<style>
387		381
388	Compile I<XIM>: input style for input method; B<OverTheSpot>,	382	Compile I<XIM>: input style for input method; B<OverTheSpot>,
389	B<OffTheSpot>, B<Root>; resource B<preeditType>.	383	B<OffTheSpot>, B<Root>; resource B<preeditType>.
390		384
		385	If the perl extension C<xim-onthespot> is used (which is the default),
		386	then additionally the C<OnTheSpot> preedit type is available.
		387
391	=item B<-im> I<text>	388	=item B<-im> I<text>
392		389
393	Compile I<XIM>: input method name. resource B<inputMethod>.	390	Compile I<XIM>: input method name. resource B<inputMethod>.
394		391
395	=item B<-imlocale> I<string>	392	=item B<-imlocale> I<string>
…		…
406		403
407	=item B<-tcw>	404	=item B<-tcw>
408		405
409	Change the meaning of triple-click selection with the left mouse	406	Change the meaning of triple-click selection with the left mouse
410	button. Only effective when the original (non-perl) selection code is	407	button. Only effective when the original (non-perl) selection code is
411	in-use. Instead of selecting a full line it will extend the selection the	408	in-use. Instead of selecting a full line it will extend the selection to
412	end of the logical line only. resource B<tripleclickwords>.	409	the end of the logical line only. resource B<tripleclickwords>.
413		410
414	=item B<-insecure>	411	=item B<-insecure>
415		412
416	Enable "insecure" mode, which currently enables most of the escape	413	Enable "insecure" mode, which currently enables most of the escape
417	sequences that echo strings. See the resource B<insecure> for more	414	sequences that echo strings. See the resource B<insecure> for more
…		…
437		434
438	Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@	435	Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@
439	will not immediately destroy its window when the program executed within	436	will not immediately destroy its window when the program executed within
440	it exits. Instead, it will wait till it is being killed or closed by the	437	it exits. Instead, it will wait till it is being killed or closed by the
441	user; resource B<hold>.	438	user; resource B<hold>.
		439
		440	=item B<-cd> I<path>
		441
		442	Sets the working directory for the shell (or the command specified via
		443	B<-e>). The I<path> must be an absolute path and it must exist for
		444	@@RXVT_NAME@@ to start; resource B<chdir>.
		445
		446	=item B<-xrm> I<string>
		447
		448	Works like the X Toolkit option of the same name, by adding the I<string>
		449	as if it were specified in a resource file. Resource values specified this
		450	way take precedence over all other resource specifications.
		451
		452	Note that you need to use the I<same> syntax as in the .Xdefaults file,
		453	e.g. C<*.background: black>. Also note that all @@RXVT_NAME@@-specific
		454	options can be specified as long-options on the commandline, so use
		455	of B<-xrm> is mostly limited to cases where you want to specify other
		456	resources (e.g. for input methods) or for compatibility with other
		457	programs.
442		458
443	=item B<-keysym.>I<sym> I<string>	459	=item B<-keysym.>I<sym> I<string>
444		460
445	Remap a key symbol. See resource B<keysym>.	461	Remap a key symbol. See resource B<keysym>.
446		462
…		…
481	If this switch is given, @@RXVT_NAME@@ will not create any utmp/wtmp	497	If this switch is given, @@RXVT_NAME@@ will not create any utmp/wtmp
482	entries and will not tinker with pty/tty permissions - you have to do that	498	entries and will not tinker with pty/tty permissions - you have to do that
483	yourself if you want that.	499	yourself if you want that.
484		500
485	As an extremely special case, specifying C<-1> will completely suppress	501	As an extremely special case, specifying C<-1> will completely suppress
486	pty/tty operations.	502	pty/tty operations, which is probably only useful in conjunction with some
		503	perl extension that manages the terminal.
487		504
488	Here is a example in perl that illustrates how this option can be used (a	505	Here is a example in perl that illustrates how this option can be used (a
489	longer example is in F<doc/pty-fd>):	506	longer example is in F<doc/pty-fd>):
490		507
491	use IO::Pty;	508	use IO::Pty;
…		…
505	Comma-separated list of perl extension scripts to use (or not to use) in	522	Comma-separated list of perl extension scripts to use (or not to use) in
506	this terminal instance. See resource B<perl-ext> for details.	523	this terminal instance. See resource B<perl-ext> for details.
507		524
508	=back	525	=back
509		526
510	=head1 RESOURCES (available also as long-options)	527	=head1 RESOURCES
511		528
512	Note: `@@RXVT_NAME@@ --help' gives a list of all resources (long	529	Note: `@@RXVT_NAME@@ --help' gives a list of all resources (long
513	options) compiled into your version.	530	options) compiled into your version. All resources are also available as
		531	long-options.
514		532
515	You can set and change the resources using X11 tools like B<xrdb>. Many	533	You can set and change the resources using X11 tools like B<xrdb>. Many
516	distribution do also load settings from the B<~/.Xresources> file when X	534	distribution do also load settings from the B<~/.Xresources> file when X
517	starts. @@RXVT_NAME@@ will consult the following files/resources in order,	535	starts. @@RXVT_NAME@@ will consult the following files/resources in order,
518	with later settings overwriting earlier ones:	536	with later settings overwriting earlier ones:
519		537
520	1. system-wide app-defaults file, either locale-dependent OR global
521	2. app-defaults file in $XAPPLRESDIR	538	1. app-defaults file in $XAPPLRESDIR
		539	2. $HOME/.Xdefaults
522	3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults	540	3. RESOURCE_MANAGER property on root-window of screen 0
523	4. SCREEN_RESOURCES for the current screen	541	4. SCREEN_RESOURCES property on root-window of the current screen
524	5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename>	542	5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename>
		543	6. resources specified via -xrm on the commandline
525		544
526	Note that when reading X resources, B<@@RXVT_NAME@@> recognizes two class	545	Note that when reading X resources, B<@@RXVT_NAME@@> recognizes two class
527	names: B<Rxvt> and B<URxvt>. The class name B<Rxvt> allows resources	546	names: B<Rxvt> and B<URxvt>. The class name B<Rxvt> allows resources
528	common to both B<@@RXVT_NAME@@> and the original I<rxvt> to be easily	547	common to both B<@@RXVT_NAME@@> and the original I<rxvt> to be easily
529	configured, while the class name B<URxvt> allows resources unique to	548	configured, while the class name B<URxvt> allows resources unique to
…		…
539	=item B<depth:> I<bitdepth>	558	=item B<depth:> I<bitdepth>
540		559
541	Compile I<xft>: Attempt to find a visual with the given bit depth;	560	Compile I<xft>: Attempt to find a visual with the given bit depth;
542	option B<-depth>.	561	option B<-depth>.
543		562
		563	=item B<buffered:> I<boolean>
		564
		565	Compile I<xft>: Turn on/off double-buffering for xft (default enabled).
		566	On some card/driver combination enabling it slightly decreases
		567	performance, on most it greatly helps it. The slowdown is small, so it
		568	should normally be enabled.
		569
544	=item B<geometry:> I<geom>	570	=item B<geometry:> I<geom>
545		571
546	Create the window with the specified X window geometry [default 80x24];	572	Create the window with the specified X window geometry [default 80x24];
547	option B<-geometry>.	573	option B<-geometry>.
548		574
…		…
561	Use the specified colour for the colour value I<n>, where 0-7	587	Use the specified colour for the colour value I<n>, where 0-7
562	corresponds to low-intensity (normal) colours and 8-15 corresponds to	588	corresponds to low-intensity (normal) colours and 8-15 corresponds to
563	high-intensity (bold = bright foreground, blink = bright background)	589	high-intensity (bold = bright foreground, blink = bright background)
564	colours. The canonical names are as follows: 0=black, 1=red, 2=green,	590	colours. The canonical names are as follows: 0=black, 1=red, 2=green,
565	3=yellow, 4=blue, 5=magenta, 6=cyan, 7=white, but the actual colour	591	3=yellow, 4=blue, 5=magenta, 6=cyan, 7=white, but the actual colour
566	names used are listed in the B<COLORS AND GRAPHICS> section.	592	names used are listed in the B<COLOURS AND GRAPHICS> section.
567		593
568	Colours higher than 15 cannot be set using resources (yet), but can be	594	Colours higher than 15 cannot be set using resources (yet), but can be
569	changed using an escape command (see @@RXVT_NAME@@(7)).	595	changed using an escape command (see @@RXVT_NAME@@(7)).
570		596
571	Colours 16-79 form a standard 4x4x4 colour cube (the same as xterm with	597	Colours 16-79 form a standard 4x4x4 colour cube (the same as xterm with
…		…
582	=item B<colorUL:> I<colour>	608	=item B<colorUL:> I<colour>
583		609
584	Use the specified colour to display underlined characters when the	610	Use the specified colour to display underlined characters when the
585	foreground colour is the default.	611	foreground colour is the default.
586		612
587	=item B<colorRV:> I<colour>
588
589	Use the specified colour as the background for reverse video characters
590	when OPTION_HC is disabled (--disable-frills).
591
592	=item B<underlineColor:> I<colour>	613	=item B<underlineColor:> I<colour>
593		614
594	If set, use the specified colour as the colour for the underline	615	If set, use the specified colour as the colour for the underline
595	itself. If unset, use the foreground colour.	616	itself. If unset, use the foreground colour.
		617
		618	=item B<highlightColor:> I<colour>
		619
		620	If set, use the specified colour as the background for highlighted
		621	characters. If unset, use reverse video.
		622
		623	=item B<highlightTextColor:> I<colour>
		624
		625	If set and highlightColor is set, use the specified colour as the
		626	foreground for highlighted characters.
596		627
597	=item B<cursorColor:> I<colour>	628	=item B<cursorColor:> I<colour>
598		629
599	Use the specified colour for the cursor. The default is to use the	630	Use the specified colour for the cursor. The default is to use the
600	foreground colour; option B<-cr>.	631	foreground colour; option B<-cr>.
…		…
607		638
608	=item B<reverseVideo:> I<boolean>	639	=item B<reverseVideo:> I<boolean>
609		640
610	B<True>: simulate reverse video by foreground and background colours;	641	B<True>: simulate reverse video by foreground and background colours;
611	option B<-rv>. B<False>: regular screen colours [default]; option	642	option B<-rv>. B<False>: regular screen colours [default]; option
612	B<+rv>. See note in B<COLORS AND GRAPHICS> section.	643	B<+rv>. See note in B<COLOURS AND GRAPHICS> section.
613		644
614	=item B<jumpScroll:> I<boolean>	645	=item B<jumpScroll:> I<boolean>
615		646
616	B<True>: specify that jump scrolling should be used. When receiving lots	647	B<True>: specify that jump scrolling should be used. When receiving lots
617	of lines, @@RXVT_NAME@@ will only scroll once a whole screen height of lines	648	of lines, @@RXVT_NAME@@ will only scroll once a whole screen height of lines
…		…
631		662
632	B<False>: specify that everything is to be displayed, even	663	B<False>: specify that everything is to be displayed, even
633	if the refresh is too fast for the human eye to read anything (or the	664	if the refresh is too fast for the human eye to read anything (or the
634	monitor to display anything); option B<+ss>.	665	monitor to display anything); option B<+ss>.
635		666
636	=item B<inheritPixmap:> I<boolean>
637
638	B<True>: make the background inherit the parent windows' pixmap, giving
639	artificial transparency. B<False>: do not inherit the parent windows'
640	pixmap.
641
642	I<Please note that transparency of any kind if completely unsupported by
643	the author. Don't bug him with installation questions!>
644
645	=item B<fading:> I<number>	667	=item B<fading:> I<number>
646		668
647	Fade the text by the given percentage when focus is lost; option B<-fade>.	669	Fade the text by the given percentage when focus is lost; option B<-fade>.
648		670
649	=item B<fadeColor:> I<colour>	671	=item B<fadeColor:> I<colour>
650		672
651	Fade to this colour, when fading is used (see B<fading:>). The default	673	Fade to this colour, when fading is used (see B<fading:>). The default
652	colour is black; option B<-fadecolor>.	674	colour is black; option B<-fadecolor>.
653		675
654	=item B<tintColor:> I<colour>	676	=item B<iconFile:> I<file>
655		677
656	Tint the transparent background pixmap with the given colour; option	678	Set the application icon pixmap; option B<-icon>.
657	B<-tint>.
658
659	=item B<shading:> I<number>
660
661	Darken (0 .. 100) or lighten (-1 .. -100) the transparent background image
662	in addition to tinting it; option B<-sh>.
663
664	=item B<blendType:> I<string>
665
666	Specify background blending type; option B<-blt>.
667
668	=item B<blurRadius:> I<number>
669
670	Apply Gaussian Blurr with the specified radius to the transparent
671	background image; option B<-blr>.
672		679
673	=item B<scrollColor:> I<colour>	680	=item B<scrollColor:> I<colour>
674		681
675	Use the specified colour for the scrollbar [default #B2B2B2].	682	Use the specified colour for the scrollbar [default #B2B2B2].
676		683
…		…
681		688
682	=item B<borderColor:> I<colour>	689	=item B<borderColor:> I<colour>
683		690
684	The colour of the border around the text area and between the scrollbar	691	The colour of the border around the text area and between the scrollbar
685	and the text.	692	and the text.
686
687	=item B<backgroundPixmap:> I<file[;geom]>
688
689	Use the specified image file for the background and also optionally
690	specify its scaling with a geometry string B<WxH+X+Y>,
691	in which B<"W" / "H"> specify the horizontal/vertical scale (percent),
692	and B<"X" / "Y"> locate the image centre (percent).
693	A scale of 0 displays the image with tiling. A scale of 1 displays the
694	image without any scaling. A scale of 2 to 9 specifies an integer
695	number of images in that direction. No image will be magnified beyond
696	10 times its original size. The maximum permitted scale is 1000.
697	Special string of B<"auto"> used as a geometry will cause image to be
698	automatically scaled to match window size.
699	If used in conjunction with B<-tr> option - specified pixmap will be
700	blended over transparency image using either alpha-blending, or any
701	other blending type, specified with B<-blt "type"> option.
702	[default 0x0+50+50]
703
704	=item B<path:> I<path>
705
706	Specify the colon-delimited search path for finding XPM files.
707		693
708	=item B<font:> I<fontlist>	694	=item B<font:> I<fontlist>
709		695
710	Select the fonts to be used. This is a comma separated list of font names	696	Select the fonts to be used. This is a comma separated list of font names
711	that are checked in order when trying to find glyphs for characters. The	697	that are checked in order when trying to find glyphs for characters. The
…		…
734	it is named first) and thus defines the character cell grid to be 9 pixels	720	it is named first) and thus defines the character cell grid to be 9 pixels
735	wide and 15 pixels high.	721	wide and 15 pixels high.
736		722
737	The second font is just used to add additional unicode characters not in	723	The second font is just used to add additional unicode characters not in
738	the base font, likewise the third, which is unfortunately non-bold, but	724	the base font, likewise the third, which is unfortunately non-bold, but
739	the bold version of the font does contain less characters, so this is a	725	the bold version of the font does contain fewer characters, so this is a
740	useful supplement.	726	useful supplement.
741		727
742	The third font is an Xft font with aliasing turned off, and the characters	728	The third font is an Xft font with aliasing turned off, and the characters
743	are limited to the B<JIS 0208> codeset (i.e. japanese kanji). The font	729	are limited to the B<JIS 0208> codeset (i.e. japanese kanji). The font
744	contains other characters, but we are not interested in them.	730	contains other characters, but we are not interested in them.
…		…
768	text font will being used for the given style.	754	text font will being used for the given style.
769		755
770	=item B<intensityStyles:> I<boolean>	756	=item B<intensityStyles:> I<boolean>
771		757
772	When font styles are not enabled, or this option is enabled (B<True>,	758	When font styles are not enabled, or this option is enabled (B<True>,
773	option B<-is>, the default), bold and italic font styles imply high	759	option B<-is>, the default), bold/blink font styles imply high
774	intensity foreground/background colours. Disabling this option (B<False>,	760	intensity foreground/background colours. Disabling this option (B<False>,
775	option B<+is>) disables this behaviour, the high intensity colours are not	761	option B<+is>) disables this behaviour, the high intensity colours are not
776	reachable.	762	reachable.
777		763
778	=item B<selectstyle:> I<mode>
779
780	Set mouse selection style to B<old> which is 2.20, B<oldword> which
781	is xterm style with 2.20 old word selection, or anything else which
782	gives xterm style selection. Only effective when the original (non-perl)
783	selection code is in use.
784
785	=item B<scrollstyle:> I<mode>
786
787	Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is
788	the author's favourite.
789
790	=item B<title:> I<string>	764	=item B<title:> I<string>
791		765
792	Set window title string, the default title is the command-line	766	Set window title string, the default title is the command-line
793	specified after the B<-e> option, if any, otherwise the application	767	specified after the B<-e> option, if any, otherwise the application
794	name; option B<-title>.	768	name; option B<-title>.
…		…
807	=item B<urgentOnBell:> I<boolean>	781	=item B<urgentOnBell:> I<boolean>
808		782
809	B<True>: set the urgency hint for the wm on receipt of a bell character.	783	B<True>: set the urgency hint for the wm on receipt of a bell character.
810	B<False>: do not set the urgency hint [default].	784	B<False>: do not set the urgency hint [default].
811		785
		786	@@RXVT_NAME@@ resets the urgency hint on every focus change.
		787
812	=item B<visualBell:> I<boolean>	788	=item B<visualBell:> I<boolean>
813		789
814	B<True>: use visual bell on receipt of a bell character; option B<-vb>.	790	B<True>: use visual bell on receipt of a bell character; option B<-vb>.
815	B<False>: no visual bell [default]; option B<+vb>.	791	B<False>: no visual bell [default]; option B<+vb>.
816		792
…		…
818		794
819	B<True>: start as a login shell by prepending a `-' to B<argv[0]> of	795	B<True>: start as a login shell by prepending a `-' to B<argv[0]> of
820	the shell; option B<-ls>. B<False>: start as a normal sub-shell	796	the shell; option B<-ls>. B<False>: start as a normal sub-shell
821	[default]; option B<+ls>.	797	[default]; option B<+ls>.
822		798
		799	=item B<multiClickTime:> I<number>
		800
		801	Specify the maximum time in milliseconds between multi-click select
		802	events. The default is 500 milliseconds; option B<-mc>.
		803
823	=item B<utmpInhibit:> I<boolean>	804	=item B<utmpInhibit:> I<boolean>
824		805
825	B<True>: inhibit writing record into the system log file B<utmp>;	806	B<True>: inhibit writing record into the system log file B<utmp>;
826	option B<-ut>. B<False>: write record into the system log file B<utmp>	807	option B<-ut>. B<False>: write record into the system log file B<utmp>
827	[default]; option B<+ut>.	808	[default]; option B<+ut>.
…		…
839	URxvt.print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX)	820	URxvt.print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX)
840		821
841	This creates a new file in your home directory with the screen contents	822	This creates a new file in your home directory with the screen contents
842	every time you hit C<Print>.	823	every time you hit C<Print>.
843		824
		825	=item B<scrollstyle:> I<mode>
		826
		827	Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is
		828	the author's favourite.
		829
		830	=item B<thickness:> I<number>
		831
		832	Set the scrollbar width in pixels.
		833
844	=item B<scrollBar:> I<boolean>	834	=item B<scrollBar:> I<boolean>
845		835
846	B<True>: enable the scrollbar [default]; option B<-sb>. B<False>:	836	B<True>: enable the scrollbar [default]; option B<-sb>. B<False>:
847	disable the scrollbar; option B<+sb>.	837	disable the scrollbar; option B<+sb>.
848		838
…		…
867	B<False>: do not scroll to bottom when tty receives output; option	857	B<False>: do not scroll to bottom when tty receives output; option
868	B<+si>.	858	B<+si>.
869		859
870	=item B<scrollWithBuffer:> I<boolean>	860	=item B<scrollWithBuffer:> I<boolean>
871		861
872	B<True>: scroll with scrollback buffer when tty receives new lines (and	862	B<True>: scroll with scrollback buffer when tty receives new lines (i.e.
873	B<scrollTtyOutput> is False); option B<-sw>. B<False>: do not scroll	863	try to show the same lines) and B<scrollTtyOutput> is False; option
874	with scrollback buffer when tty receives new lines; option B<+sw>.	864	B<-sw>. B<False>: do not scroll with scrollback buffer when tty receives
		865	new lines; option B<+sw>.
875		866
876	=item B<scrollTtyKeypress:> I<boolean>	867	=item B<scrollTtyKeypress:> I<boolean>
877		868
878	B<True>: scroll to bottom when a non-special key is pressed. Special keys	869	B<True>: scroll to bottom when a non-special key is pressed. Special keys
879	are those which are intercepted by rxvt-unicode for special handling and	870	are those which are intercepted by rxvt-unicode for special handling and
880	are not passed onto the shell; option B<-sk>. B<False>: do not scroll to	871	are not passed onto the shell; option B<-sk>. B<False>: do not scroll to
881	bottom when a non-special key is pressed; option B<+sk>.	872	bottom when a non-special key is pressed; option B<+sk>.
882		873
883	=item B<saveLines:> I<number>	874	=item B<saveLines:> I<number>
884		875
885	Save I<number> lines in the scrollback buffer [default 64]. This	876	Save I<number> lines in the scrollback buffer [default 1000]; option B<-sl>.
886	resource is limited on most machines to 65535; option B<-sl>.
887		877
888	=item B<internalBorder:> I<number>	878	=item B<internalBorder:> I<number>
889		879
890	Internal border of I<number> pixels. This resource is limited to 100;	880	Internal border of I<number> pixels. This resource is limited to 100;
891	option B<-b>.	881	option B<-b>.
…		…
910	=item B<termName:> I<termname>	900	=item B<termName:> I<termname>
911		901
912	Specifies the terminal type name to be set in the B<TERM> environment	902	Specifies the terminal type name to be set in the B<TERM> environment
913	variable; option B<-tn>.	903	variable; option B<-tn>.
914		904
915	=item B<linespace:> I<number>	905	=item B<lineSpace:> I<number>
916		906
917	Specifies number of lines (pixel height) to insert between each row of	907	Specifies number of lines (pixel height) to insert between each row of
918	the display [default 0]; option B<-lsp>.	908	the display [default 0]; option B<-lsp>.
919		909
920	=item B<meta8:> I<boolean>	910	=item B<meta8:> I<boolean>
…		…
934		924
935	=item B<cursorBlink:> I<boolean>	925	=item B<cursorBlink:> I<boolean>
936		926
937	B<True>: blink the cursor. B<False>: do not blink the cursor [default];	927	B<True>: blink the cursor. B<False>: do not blink the cursor [default];
938	option B<-bc>.	928	option B<-bc>.
		929
		930	=item B<cursorUnderline:> I<boolean>
		931
		932	B<True>: Make the cursor underlined. B<False>: Make the cursor a box [default];
		933	option B<-uc>.
939		934
940	=item B<pointerBlank:> I<boolean>	935	=item B<pointerBlank:> I<boolean>
941		936
942	B<True>: blank the pointer when a key is pressed or after a set number	937	B<True>: blank the pointer when a key is pressed or after a set number
943	of seconds of inactivity. B<False>: the pointer is always visible	938	of seconds of inactivity. B<False>: the pointer is always visible
…		…
949		944
950	=item B<pointerColor2:> I<colour>	945	=item B<pointerColor2:> I<colour>
951		946
952	Mouse pointer background colour.	947	Mouse pointer background colour.
953		948
		949	=item B<pointerShape:> I<string>
		950
		951	Compile I<frills>: Specifies the name of the mouse pointer shape
		952	[default B<xterm>]. See the macros in the B<X11/cursorfont.h> include
		953	file for possible values (omit the C<XC_> prefix).
		954
954	=item B<pointerBlankDelay:> I<number>	955	=item B<pointerBlankDelay:> I<number>
955		956
956	Specifies number of seconds before blanking the pointer [default 2]. Use a	957	Specifies number of seconds before blanking the pointer [default 2]. Use a
957	large number (e.g. C<987654321>) to effectively disable the timeout.	958	large number (e.g. C<987654321>) to effectively disable the timeout.
958		959
959	=item B<backspacekey:> I<string>	960	=item B<backspacekey:> I<string>
960		961
961	The string to send when the backspace key is pressed. If set to B<DEC>	962	The string to send when the backspace key is pressed. If set to B<DEC>
962	or unset it will send B<Delete> (code 127) or, if shifted, B<Backspace>	963	or unset it will send B<Delete> (code 127) or, with control, B<Backspace>
963	(code 8) - which can be reversed with the appropriate DEC private mode	964	(code 8) - which can be reversed with the appropriate DEC private mode
964	escape sequence.	965	escape sequence.
965		966
966	=item B<deletekey:> I<string>	967	=item B<deletekey:> I<string>
967		968
…		…
980	will be created). In this mode, characters outside ISO-8859-1 can be used.	981	will be created). In this mode, characters outside ISO-8859-1 can be used.
981		982
982	When the selection extension is not used, only ISO-8859-1 characters can	983	When the selection extension is not used, only ISO-8859-1 characters can
983	be used. If not specified, the built-in default is used:	984	be used. If not specified, the built-in default is used:
984		985
985	B<< BACKSLASH `"'&()*,;<=>?@[]{\|} >>	986	B<< BACKSLASH `"'&()*,;<=>?@[]^{\|} >>
986		987
987	=item B<preeditType:> I<style>	988	=item B<preeditType:> I<style>
988		989
989	B<OverTheSpot>, B<OffTheSpot>, B<Root>; option B<-pt>.	990	B<OnTheSpot>, B<OverTheSpot>, B<OffTheSpot>, B<Root>; option B<-pt>.
990		991
991	=item B<inputMethod:> I<name>	992	=item B<inputMethod:> I<name>
992		993
993	I<name> of inputMethod to use; option B<-im>.	994	I<name> of inputMethod to use; option B<-im>.
994		995
…		…
1046		1047
1047	=item B<secondaryScroll:> I<boolean>	1048	=item B<secondaryScroll:> I<boolean>
1048		1049
1049	Turn on/off secondary screen scroll (default enabled). If this	1050	Turn on/off secondary screen scroll (default enabled). If this
1050	option is enabled, scrolls on the secondary screen will change the	1051	option is enabled, scrolls on the secondary screen will change the
1051	scrollback buffer and switching to/from the secondary screen will	1052	scrollback buffer and, when secondaryScreen is off, switching
1052	instead scroll the screen up.	1053	to/from the secondary screen will instead scroll the screen up.
1053		1054
1054	=item B<hold>: I<boolean>	1055	=item B<hold>: I<boolean>
1055		1056
1056	Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@	1057	Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@
1057	will not immediately destroy its window when the program executed within	1058	will not immediately destroy its window when the program executed within
1058	it exits. Instead, it will wait till it is being killed or closed by the	1059	it exits. Instead, it will wait till it is being killed or closed by the
1059	user.	1060	user.
1060		1061
		1062	=item B<chdir>: I<path>
		1063
		1064	Sets the working directory for the shell (or the command specified via
		1065	B<-e>). The I<path> must be an absolute path and it must exist for
		1066	@@RXVT_NAME@@ to start. If it isn't specified then the current working
		1067	directory will be used; option B<-cd>.
		1068
1061	=item B<keysym.>I<sym>: I<string>	1069	=item B<keysym.>I<sym>: I<action>
1062		1070
1063	Compile I<frills>: Associate I<string> with keysym I<sym>. The	1071	Compile I<frills>: Associate I<action> with keysym I<sym>. The intervening
1064	intervening resource name B<keysym.> cannot be omitted.	1072	resource name B<keysym.> cannot be omitted.
1065		1073
1066	The format of I<sym> is "I<(modifiers-)key>", where I<modifiers> can be	1074	Using this resource, you can map key combinations such as
1067	any combination of B<ISOLevel3>, B<AppKeypad>, B<Control>, B<NumLock>,	1075	C<Ctrl-Shift-BackSpace> to various actions, such as outputting a different
1068	B<Shift>, B<Meta>, B<Lock>, B<Mod1>, B<Mod2>, B<Mod3>, B<Mod4>, B<Mod5>,	1076	string than would normally result from that combination, making the
1069	and the abbreviated B<I>, B<K>, B<C>, B<N>, B<S>, B<M>, B<A>, B<L>, B<1>,	1077	terminal scroll up or down the way you want it, or any other thing an
1070	B<2>, B<3>, B<4>, B<5>.	1078	extension might provide.
		1079
		1080	The key combination that triggers the action, I<sym>, has the following format:
		1081
		1082	(modifiers-)key
		1083
		1084	Where I<modifiers> can be any combination of B<ISOLevel3>, B<AppKeypad>,
		1085	B<Control>, B<NumLock>, B<Shift>, B<Meta>, B<Lock>, B<Mod1>, B<Mod2>,
		1086	B<Mod3>, B<Mod4>, B<Mod5>, and the abbreviated B<I>, B<K>, B<C>, B<N>,
		1087	B<S>, B<M>, B<A>, B<L>, B<1>, B<2>, B<3>, B<4>, B<5>.
1071		1088
1072	The B<NumLock>, B<Meta> and B<ISOLevel3> modifiers are usually aliased to	1089	The B<NumLock>, B<Meta> and B<ISOLevel3> modifiers are usually aliased to
1073	whatever modifier the NumLock key, Meta/Alt keys or ISO Level3 Shift/AltGr	1090	whatever modifier the NumLock key, Meta/Alt keys or ISO Level3 Shift/AltGr
1074	keys are being mapped. B<AppKeypad> is a synthetic modifier mapped to the	1091	keys are being mapped. B<AppKeypad> is a synthetic modifier mapped to the
1075	current application keymap mode state.	1092	current application keymap mode state.
1076		1093
1077	The spellings of I<key> can be obtained by using B<xev>(1) command or	1094	Due the the large number of modifier combinations, a key mapping will
1078	searching keysym macros from B</usr/X11R6/include/X11/keysymdef.h> and	1095	match if I<at least> the specified identifiers are being set, and no other
		1096	key mappings with those and more bits are being defined. That means that
		1097	defining a mapping for C<a> will automatically provide definitions for
		1098	C<Meta-a>, C<Shift-a> and so on, unless some of those are defined mappings
		1099	themselves. See the C<builtin:> action, below, for a way to work around
		1100	this when this is a problem.
		1101
		1102	The spelling of I<key> depends on your implementation of X. An easy way to
		1103	find a key name is to use the B<xev>(1) command. You can find a list by
		1104	looking for the C<XK_> macros in the B<X11/keysymdef.h> include file (omit
1079	omitting the prefix B<XK_>. Alternatively you can specify I<key> by its hex	1105	the C<XK_> prefix). Alternatively you can specify I<key> by its hex keysym
1080	keysym value (B<0x0000 - 0xFFFF>). Note that the lookup of I<sym>s is not	1106	value (B<0x0000 - 0xFFFF>).
1081	performed in an exact manner; however, the closest match is assured.
1082		1107
1083	I<string> may contain escape values (C<\a>: bell, C<\b>: backspace,	1108	As with any resource value, the I<action> string may contain backslash
1084	C<\e>, C<\E>: escape, C<\n>: newline, C<\r>: carriage return, C<\t>: tab,	1109	escape sequences (C<\n>: newline, C<\\>: backslash, C<\000>: octal
1085	C<\000>: octal number) or verbatim control characters (C<^?>: delete,	1110	number), see RESOURCES in C<man 7 X> for further details.
1086	C<^@>: null, C<^A> ...) and may be enclosed with double quotes so that it
1087	can start or end with whitespace. B<This feature is deprecated and will
1088	be removed>.
1089		1111
1090	Please note that you need to double the C<\> in resource files, as	1112	An action starts with an action prefix that selects a certain type
1091	Xlib itself does its own de-escaping (you can use C<\033> instead of	1113	of action, followed by a colon. An action string without colons is
1092	C<\e> (and so on), which will work with both Xt and @@RXVT_NAME@@'s own	1114	interpreted as a literal string to pass to the tty (as if it was
1093	processing).	1115	prefixed with C<string:>).
1094		1116
1095	You can define a range of keysyms in one shot by providing a I<string>	1117	The following action prefixes are known - extensions can provide
1096	with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimiter `/'	1118	additional prefixes:
		1119
		1120	=over 4
		1121
		1122	=item string:STRING
		1123
		1124	If the I<action> starts with C<string:> (or otherwise contains no colons),
		1125	then the remaining C<STRING> will be passed to the program running in the
		1126	terminal. For example, you could replace whatever Shift-Tab outputs by the
		1127	string C<echo rm -rf /> followed by a newline:
		1128
		1129	URxvt.keysym.Shift-Tab: string:echo rm -rf /\n
		1130
		1131	This could in theory be used to completely redefine your keymap.
		1132
		1133	In addition, for actions of this type, you can define a range of
		1134	keysyms in one shot by loading the C<keysym-list> perl extension and
		1135	providing an I<action> with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where
1097	should be a character not used by the strings.	1136	the delimiter `/' should be a character not used by the strings.
1098		1137
1099	Its usage can be demonstrated by an example:	1138	Its usage can be demonstrated by an example:
1100		1139
1101	URxvt.keysym.M-C-0x61: list\|\033<M-C-\|abc\|>	1140	URxvt.keysym.M-C-0x61: list\|\033<\|abc\|>
1102		1141
1103	The above line is equivalent to the following three lines:	1142	The above line is equivalent to the following three lines:
1104		1143
1105	URxvt.keysym.Meta-Control-0x61: \033<M-C-a>	1144	URxvt.keysym.Meta-Control-0x61: string:\033<a>
1106	URxvt.keysym.Meta-Control-0x62: \033<M-C-b>	1145	URxvt.keysym.Meta-Control-0x62: string:\033<b>
1107	URxvt.keysym.Meta-Control-0x63: \033<M-C-c>	1146	URxvt.keysym.Meta-Control-0x63: string:\033<c>
1108		1147
		1148	=item command:STRING
		1149
1109	If I<string> takes the form of C<command:STRING>, the specified B<STRING>	1150	If I<action> takes the form of C<command:STRING>, the specified B<STRING>
1110	is interpreted and executed as @@RXVT_NAME@@'s control sequence. For	1151	is interpreted and executed as @@RXVT_NAME@@'s control sequence (basically
		1152	the opposite of C<string:> - instead of sending it to the program running
		1153	in the terminal, it will be treated as if it were program output). This is
		1154	most useful to feed command sequences into @@RXVT_NAME@@.
		1155
1111	example the following means "change the current locale to C<zh_CN.GBK>	1156	For example the following means "change the current locale to C<zh_CN.GBK>
1112	when Control-Meta-c is being pressed":	1157	when Control-Meta-c is being pressed":
1113		1158
1114	URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007	1159	URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007
1115		1160
1116	If I<string> takes the form C<perl:STRING>, then the specified B<STRING>	1161	The following example will map Control-Meta-1 and Control-Meta-2 to
1117	is passed to the C<on_keyboard_command> perl handler. See the @@RXVT_NAME@@perl(3)	1162	the fonts C<suxuseuro> and C<9x15bold>, so you can have some limited
1118	manpage. For example, the F<selection> extension (activated via	1163	font-switching at runtime:
1119	C<@@RXVT_NAME@@ -pe selection>) listens for C<selection:rot13> events:
1120		1164
1121	URxvt.keysym.M-C-c: perl:selection:rot13	1165	URxvt.keysym.M-C-1: command:\033]50;suxuseuro\007
		1166	URxvt.keysym.M-C-2: command:\033]50;9x15bold\007
1122		1167
1123	Due the the large number of modifier combinations, a defined key mapping	1168	Other things are possible, e.g. resizing (see @@RXVT_NAME@@(7) for more
1124	will match if at I<at least> the specified identifiers are being set, and	1169	info):
1125	no other key mappings with those and more bits are being defined. That
1126	means that defining a key map for C<a> will automatically provide
1127	definitions for C<Meta-a>, C<Shift-a> and so on, unless some of those are defined
1128	mappings themselves.
1129		1170
1130	Unfortunately, this will override built-in key mappings. For example	1171	URxvt.keysym.M-C-3: command:\033[8;25;80t
		1172	URxvt.keysym.M-C-4: command:\033[8;48;110t
		1173
		1174	=item builtin:
		1175
		1176	The builtin action is the action that @@RXVT_NAME@@ would execute if no
		1177	key binding existed for the key combination. The obvious use is to undo
		1178	the effect of existing bindings. The not so obvious use is to reinstate
		1179	bindings when another binding overrides too many modifiers.
		1180
1131	if you overwrite the C<Insert> key you will disable @@RXVT_NAME@@'s	1181	For example if you overwrite the C<Insert> key you will disable
1132	C<Shift-Insert> mapping. To re-enable that, you can poke "holes" into the	1182	@@RXVT_NAME@@'s C<Shift-Insert> mapping. To re-enable that, you can poke
1133	user-defined keymap using the C<builtin:> replacement:	1183	"holes" into the user-defined keymap using the C<builtin:> replacement:
1134		1184
1135	URxvt.keysym.Insert: <my insert key sequence>	1185	URxvt.keysym.Insert: <my insert key sequence>
1136	URxvt.keysym.S-Insert: builtin:	1186	URxvt.keysym.S-Insert: builtin:
1137		1187
1138	The first line defines a mapping for C<Insert> and I<any> combination	1188	The first line defines a mapping for C<Insert> and I<any> combination
1139	of modifiers. The second line re-establishes the default mapping for	1189	of modifiers. The second line re-establishes the default mapping for
1140	C<Shift-Insert>.	1190	C<Shift-Insert>.
1141		1191
1142	The following example will map Control-Meta-1 and Control-Meta-2 to	1192	=item builtin-string:
1143	the fonts C<suxuseuro> and C<9x15bold>, so you can have some limited
1144	font-switching at runtime:
1145		1193
1146	URxvt.keysym.M-C-1: command:\033]50;suxuseuro\007	1194	This action is mainly useful to restore string mappings for keys that
1147	URxvt.keysym.M-C-2: command:\033]50;9x15bold\007	1195	have predefined actions in @@RXVT_NAME@@. The exact semantics are a bit
		1196	difficult to explain - basically, this action will send the string to the
		1197	application that would be sent if @@RXVT_NAME@@ wouldn't have a built-in
		1198	action for it.
1148		1199
1149	Other things are possible, e.g. resizing (see @@RXVT_NAME@@(7) for more	1200	An example might make it clearer: @@RXVT_NAME@@ normally pastes the
1150	info):	1201	selection when you press C<Shift-Insert>. With the following bindings, it
		1202	would instead emit the (undocumented, but what applications running in the
		1203	terminal might expect) sequence C<ESC [ 2 $> instead:
1151		1204
1152	URxvt.keysym.M-C-3: command:\033[8;25;80t	1205	URxvt.keysym.S-Insert: builtin-string:
1153	URxvt.keysym.M-C-4: command:\033[8;48;110t	1206	URxvt.keysym.C-S-Insert: builtin:
		1207
		1208	The first line disables the paste functionality for that key
		1209	combination, and the second reinstates the default behaviour for
		1210	C<Control-Shift-Insert>, which would otherwise be overridden.
		1211
		1212	Similarly, to let applications gain access to the C<C-M-c> (copy to
		1213	clipboard) and C<C-M-v> (paste clipboard) key combination, you can do
		1214	this:
		1215
		1216	URxvt.keysym.C-M-c: builtin-string:
		1217	URxvt.keysym.C-M-v: builtin-string:
		1218
		1219	=item EXTENSION:STRING
		1220
		1221	An action of this form invokes the action B<STRING>, if any, provided
		1222	by the @@RXVT_NAME@@perl(3) extension B<EXTENSION>. The extension will
		1223	be loaded automatically if necessary.
		1224
		1225	Not all extensions define actions, but popular extensions that do
		1226	include the I<selection> and I<matcher> extensions (documented in their
		1227	own manpages, @@RXVT_NAME@@-selection(1) and @@RXVT_NAME@@-matcher(1),
		1228	respectively).
		1229
		1230	From the silly examples department, this will rot13-"encrypt"
		1231	@@RXVT_NAME@@'s selection when Alt-Control-c is pressed on typical PC
		1232	keyboards:
		1233
		1234	URxvt.keysym.M-C-c: selection:rot13
		1235
		1236	=item perl:STRING DEPRECATED
		1237
		1238	This is a deprecated way of invoking commands provided by perl
		1239	extensions. It is still supported, but should not be used anymore.
		1240
		1241	=back
1154		1242
1155	=item B<perl-ext-common>: I<string>	1243	=item B<perl-ext-common>: I<string>
1156		1244
1157	=item B<perl-ext>: I<string>	1245	=item B<perl-ext>: I<string>
1158		1246
…		…
1160	use in this terminal instance; option B<-pe>.	1248	use in this terminal instance; option B<-pe>.
1161		1249
1162	Extension names can be prefixed with a C<-> sign to prohibit using	1250	Extension names can be prefixed with a C<-> sign to prohibit using
1163	them. This can be useful to selectively disable some extensions loaded	1251	them. This can be useful to selectively disable some extensions loaded
1164	by default, or specified via the C<perl-ext-common> resource. For	1252	by default, or specified via the C<perl-ext-common> resource. For
1165	example, C<default,-selection> will use all the default extension except	1253	example, C<default,-selection> will use all the default extensions except
1166	C<selection>.	1254	C<selection>.
1167		1255
1168	Extension names can also be followed by an argument in angle brackets	1256	The default set includes the C<selection>, C<option-popup>,
1169	(e.g. C<< searchable-scrollback<M-s> >>, which binds the hotkey for	1257	C<selection-popup>, C<readline> and C<searchable-scrollback>
1170	searchable scrollback to Alt/Meta-s). Mentioning the same extension	1258	extensions, and extensions which are mentioned in B<keysym> resources.
1171	multiple times with different arguments will pass multiple arguments to	1259
1172	the extension.	1260	Any extension such that a corresponding resource is given on the
		1261	command line is automatically appended to B<perl-ext>.
1173		1262
1174	Each extension is looked up in the library directories, loaded if	1263	Each extension is looked up in the library directories, loaded if
1175	necessary, and bound to the current terminal instance.	1264	necessary, and bound to the current terminal instance. When the library
		1265	search path contains multiple extension files of the same name, then the
		1266	first one found will be used.
1176		1267
1177	If both of these resources are the empty string, then the perl	1268	If both of these resources are the empty string, then the perl interpreter
1178	interpreter will not be initialized. The idea behind two options is that	1269	will not be initialized. The rationale for having two options is that
1179	B<perl-ext-common> will be used for extensions that should be available to	1270	B<perl-ext-common> will be used for extensions that should be available to
1180	all instances, while B<perl-ext> is used for specific instances.	1271	all instances, while B<perl-ext> is used for specific instances.
1181		1272
1182	=item B<perl-eval>: I<string>	1273	=item B<perl-eval>: I<string>
1183		1274
1184	Perl code to be evaluated when all extensions have been registered. See	1275	Perl code to be evaluated when all extensions have been registered. See
1185	the @@RXVT_NAME@@perl(3) manpage. Due to security reasons, this resource	1276	the @@RXVT_NAME@@perl(3) manpage.
1186	will be ignored when running setuid/setgid.
1187		1277
1188	=item B<perl-lib>: I<path>	1278	=item B<perl-lib>: I<path>
1189		1279
1190	Colon-separated list of additional directories that hold extension	1280	Colon-separated list of additional directories that hold extension
1191	scripts. When looking for extensions specified by the C<perl> resource,	1281	scripts. When looking for perl extensions, @@RXVT_NAME@@ will first look
1192	@@RXVT_NAME@@ will first look in these directories and then in	1282	in these directories, then in C<$URXVT_PERL_LIB>, F<$HOME/.urxvt/ext> and
1193	F<@@RXVT_LIBDIR@@/urxvt/perl/>. Due to security reasons, this resource	1283	lastly in F<@@RXVT_LIBDIR@@/urxvt/perl/>.
1194	will be ignored when running setuid/setgid.
1195		1284
1196	See the @@RXVT_NAME@@perl(3) manpage.	1285	See the @@RXVT_NAME@@perl(3) manpage.
1197		1286
1198	=item B<< selection.pattern-I<idx> >>: I<perl-regex>	1287	=item B<< selection.pattern-I<idx> >>: I<perl-regex>
1199		1288
…		…
1203	=item B<< selection-autotransform.I<idx> >>: I<perl-transform>	1292	=item B<< selection-autotransform.I<idx> >>: I<perl-transform>
1204		1293
1205	Selection auto-transform patterns, see the @@RXVT_NAME@@perl(3) manpage	1294	Selection auto-transform patterns, see the @@RXVT_NAME@@perl(3) manpage
1206	for details.	1295	for details.
1207		1296
1208	=item B<searchable-scrollback:> I<keysym>	1297	=item B<searchable-scrollback:> I<keysym> DEPRECATED
1209		1298
1210	Sets the hotkey that starts the incremental scrollback buffer search	1299	This resource is deprecated and will be removed. Use a B<keysym> resource
1211	(default: C<M-s>).	1300	instead, e.g.:
1212		1301
		1302	URxvt.keysym.M-s: searchable-scrollback:start
		1303
1213	=item B<urlLauncher>: I<string>	1304	=item B<url-launcher>: I<string>
1214		1305
1215	Specifies the program to be started with a URL argument. Used by the	1306	Specifies the program to be started with a URL argument. Used by the
1216	C<selection-popup> and C<matcher> perl extensions.	1307	C<selection-popup> and C<matcher> perl extensions.
1217		1308
1218	=item B<transient-for>: I<windowid>	1309	=item B<transient-for>: I<windowid>
…		…
1222	=item B<override-redirect>: I<boolean>	1313	=item B<override-redirect>: I<boolean>
1223		1314
1224	Compile I<frills>: Sets override-redirect for the terminal window, making	1315	Compile I<frills>: Sets override-redirect for the terminal window, making
1225	it almost invisible to window managers; option B<-override-redirect>.	1316	it almost invisible to window managers; option B<-override-redirect>.
1226		1317
		1318	=item B<iso14755:> I<boolean>
		1319
		1320	Turn on/off ISO 14755 (default enabled).
		1321
1227	=item B<iso14755_52:> I<boolean>	1322	=item B<iso14755_52:> I<boolean>
1228		1323
1229	Turn on/off ISO 14755 5.2 mode (default enabled).	1324	Turn on/off ISO 14755 5.2 mode (default enabled).
		1325
		1326	=back
		1327
		1328	=head1 BACKGROUND IMAGE OPTIONS AND RESOURCES
		1329
		1330	=over 4
		1331
		1332	=item B<-pixmap> I<file[;oplist]>
		1333
		1334	=item B<backgroundPixmap:> I<file[;oplist]>
		1335
		1336	Compile I<pixbuf>: Use the specified image file as the window's
		1337	background and also optionally specify a colon separated list of
		1338	operations to modify it. Note that you may need to quote the C<;>
		1339	character when using the command line option, as C<;> is usually a
		1340	metacharacter in shells. Supported operations are:
		1341
		1342	=over 4
		1343
		1344	=item B<WxH+X+Y>
		1345
		1346	sets scale and position. B<"W" / "H"> specify the horizontal/vertical
		1347	scale (percent), and B<"X" / "Y"> locate the image centre (percent). A
		1348	scale of 0 disables scaling.
		1349
		1350	=item B<op=tile>
		1351
		1352	enables tiling
		1353
		1354	=item B<op=keep-aspect>
		1355
		1356	maintain the image aspect ratio when scaling
		1357
		1358	=item B<op=root-align>
		1359
		1360	use the position of the terminal window relative to the root window as
		1361	the image offset, simulating a root window background
		1362
		1363	=back
		1364
		1365	The default scale and position setting is C<100x100+50+50>.
		1366	Alternatively, a predefined set of templates can be used to achieve
		1367	the most common setups:
		1368
		1369	=over 4
		1370
		1371	=item B<style=tiled>
		1372
		1373	the image is tiled with no scaling. Equivalent to 0x0+0+0:op=tile
		1374
		1375	=item B<style=aspect-stretched>
		1376
		1377	the image is scaled to fill the whole window maintaining the aspect
		1378	ratio and centered. Equivalent to 100x100+50+50:op=keep-aspect
		1379
		1380	=item B<style=stretched>
		1381
		1382	the image is scaled to fill the whole window. Equivalent to 100x100
		1383
		1384	=item B<style=centered>
		1385
		1386	the image is centered with no scaling. Equivalent to 0x0+50+50
		1387
		1388	=item B<style=root-tiled>
		1389
		1390	the image is tiled with no scaling and using 'root' positioning.
		1391	Equivalent to 0x0:op=tile:op=root-align
		1392
		1393	=back
		1394
		1395	If multiple templates are specified the last one wins. Note that a
		1396	template overrides all the scale, position and operations settings.
		1397
		1398	If used in conjunction with pseudo-transparency, the specified pixmap
		1399	will be blended over the transparent background using alpha-blending.
		1400
		1401	=item B<-tr>\|B<+tr>
		1402
		1403	=item B<transparent:> I<boolean>
		1404
		1405	Turn on/off pseudo-transparency by using the root pixmap as background.
		1406
		1407	B<-ip> (B<inheritPixmap>) is still accepted as an obsolete alias but
		1408	will be removed in future versions.
		1409
		1410	=item B<-tint> I<colour>
		1411
		1412	=item B<tintColor:> I<colour>
		1413
		1414	Tint the transparent background with the given colour. Note that a
		1415	black tint yields a completely black image while a white tint yields
		1416	the image unchanged.
		1417
		1418	=item B<-sh> I<number>
		1419
		1420	=item B<shading:> I<number>
		1421
		1422	Darken (0 .. 99) or lighten (101 .. 200) the transparent background.
		1423	A value of 100 means no shading.
		1424
		1425	=item B<-blr> I<HxV>
		1426
		1427	=item B<blurRadius:> I<HxV>
		1428
		1429	Apply gaussian blur with the specified radius to the transparent
		1430	background. If a single number is specified, the vertical and
		1431	horizontal radii are considered to be the same. Setting one of the
		1432	radii to 1 and the other to a large number creates interesting effects
		1433	on some backgrounds. The maximum radius value is 128. An horizontal or
		1434	vertical radius of 0 disables blurring.
		1435
		1436	=item B<path:> I<path>
		1437
		1438	Specify the colon-delimited search path for finding background image files.
1230		1439
1231	=back	1440	=back
1232		1441
1233	=head1 THE SCROLLBAR	1442	=head1 THE SCROLLBAR
1234		1443
…		…
1283	B<Meta> modifier) to be inserted as if it had been typed on the keyboard.	1492	B<Meta> modifier) to be inserted as if it had been typed on the keyboard.
1284		1493
1285	Pressing B<Shift-Insert> causes the value of the PRIMARY selection to be	1494	Pressing B<Shift-Insert> causes the value of the PRIMARY selection to be
1286	inserted too.	1495	inserted too.
1287		1496
		1497	rxvt-unicode also provides the bindings B<Ctrl-Meta-c> and
		1498	<Ctrl-Meta-v> to interact with the CLIPBOARD selection. The first
		1499	binding causes the value of the internal selection to be copied to the
		1500	CLIPBOARD selection, while the second binding causes the value of the
		1501	CLIPBOARD selection to be inserted.
		1502
1288	=back	1503	=back
1289		1504
1290	=head1 CHANGING FONTS	1505	=head1 CHANGING FONTS
1291		1506
1292	Changing fonts (or font sizes, respectively) via the keypad is not yet	1507	Changing fonts (or font sizes, respectively) via the keypad is not yet
…		…
1305		1520
1306	=head1 ISO 14755 SUPPORT	1521	=head1 ISO 14755 SUPPORT
1307		1522
1308	ISO 14755 is a standard for entering and viewing unicode characters	1523	ISO 14755 is a standard for entering and viewing unicode characters
1309	and character codes using the keyboard. It consists of 4 parts. The	1524	and character codes using the keyboard. It consists of 4 parts. The
1310	first part is available rxvt-unicode has been compiled with	1525	first part is available if rxvt-unicode has been compiled with
1311	C<--enable-frills>, the rest is available when rxvt-unicode was compiled	1526	C<--enable-frills>, the rest is available when rxvt-unicode was compiled
1312	with C<--enable-iso14755>.	1527	with C<--enable-iso14755>.
1313		1528
1314	=over 4	1529	=over 4
1315		1530
…		…
1373	B<@@RXVT_NAME@@> tries to write an entry into the I<utmp>(5) file so that	1588	B<@@RXVT_NAME@@> tries to write an entry into the I<utmp>(5) file so that
1374	it can be seen via the I<who(1)> command, and can accept messages. To	1589	it can be seen via the I<who(1)> command, and can accept messages. To
1375	allow this feature, B<@@RXVT_NAME@@> may need to be installed setuid root	1590	allow this feature, B<@@RXVT_NAME@@> may need to be installed setuid root
1376	on some systems or setgid to root or to some other group on others.	1591	on some systems or setgid to root or to some other group on others.
1377		1592
1378	=head1 COLORS AND GRAPHICS	1593	=head1 COLOURS AND GRAPHICS
1379		1594
1380	In addition to the default foreground and background colours,	1595	In addition to the default foreground and background colours,
1381	B<@@RXVT_NAME@@> can display up to 16 colours (8 ANSI colours plus	1596	B<@@RXVT_NAME@@> can display up to 88/256 colours: 8 ANSI colours plus
1382	high-intensity bold/blink versions of the same). Here is a list of the	1597	high-intensity (potentially bold/blink) versions of the same, and 72 (or
1383	colours with their names.	1598	240 in 256 colour mode) colours arranged in an 4x4x4 (or 6x6x6) colour RGB
		1599	cube plus a 8 (24) colour greyscale ramp.
		1600
		1601	B<@@RXVT_NAME@@> supports direct 24-bit fg/bg RGB colour escapes
		1602	C< ESC [ 38 ; 2 ; R ; G ; Bm > / C< ESC [ 48 ; 2; R ; G ; Bm >. However the
		1603	number of 24-bit colours that can be used is limited: an internal 7x7x5 (256
		1604	colour mode) or 6x6x4 (88 colour mode) colour cube is used to index into the
		1605	24-bit colour space. When indexing collisions happen, the nearest old colour in
		1606	the cube will be adapted to the new 24-bit RGB colour. That means one cannot
		1607	use many similar 24-bit colours. It's typically not a problem in common
		1608	scenarios.
		1609
		1610	Here is a list of the ANSI colours with their names.
1384		1611
1385	=begin table	1612	=begin table
1386		1613
1387	B<color0> (black) = Black	1614	B<color0> (black) = Black
1388	B<color1> (red) = Red3	1615	B<color1> (red) = Red3
…		…
1408	It is also possible to specify the colour values of B<foreground>,	1635	It is also possible to specify the colour values of B<foreground>,
1409	B<background>, B<cursorColor>, B<cursorColor2>, B<colorBD>, B<colorUL> as	1636	B<background>, B<cursorColor>, B<cursorColor2>, B<colorBD>, B<colorUL> as
1410	a number 0-15, as a convenient shorthand to reference the colour name of	1637	a number 0-15, as a convenient shorthand to reference the colour name of
1411	color0-color15.	1638	color0-color15.
1412		1639
1413	In addition to the colours defined above, @@RXVT_NAME@@ offers an	1640	The following text gives values for the standard 88 colour mode (and
1414	additional 72 colours. The first 64 of those (with indices 16 to 79)	1641	values for the 256 colour mode in parentheses).
1415	consist of a 444 RGB colour cube (i.e. I<index = r * 16 + g * 4 + b +
1416	16>), followed by 8 additional shades of gray (with indices 80 to 87).
1417		1642
		1643	The RGB cube uses indices 16..79 (16..231) using the following formulas:
		1644
		1645	index_88 = (r * 4 + g) * 4 + b + 16 # r, g, b = 0..3
		1646	index_256 = (r * 6 + g) * 6 + b + 16 # r, g, b = 0..5
		1647
		1648	The grayscale ramp uses indices 80..87 (232..239), from 10% to 90% in 10%
		1649	steps (1/26 to 25/26 in 1/26 steps) - black and white are already part of
		1650	the RGB cube.
		1651
1418	Together, all those colours implement the 88 colour xterm colours. Only	1652	Together, all those colours implement the 88 (256) colour xterm
1419	the first 16 can be changed using resources currently, the rest can only	1653	colours. Only the first 16 can be changed using resources currently, the
1420	be changed via command sequences ("escape codes").	1654	rest can only be changed via command sequences ("escape codes").
		1655
		1656	Applications are advised to use terminfo or command sequences to discover
		1657	number and RGB values of all colours (yes, you can query this...).
1421		1658
1422	Note that B<-rv> (B<"reverseVideo: True">) simulates reverse video by	1659	Note that B<-rv> (B<"reverseVideo: True">) simulates reverse video by
1423	always swapping the foreground/background colours. This is in contrast to	1660	always swapping the foreground/background colours. This is in contrast to
1424	I<xterm>(1) where the colours are only swapped if they have not otherwise	1661	I<xterm>(1) where the colours are only swapped if they have not otherwise
1425	been specified. For example,	1662	been specified. For example,
1426		1663
1427	=over 4
1428
1429	=item B<@@RXVT_NAME@@ -fg Black -bg White -rv>	1664	@@RXVT_NAME@@ -fg Black -bg White -rv
1430		1665
1431	would yield White on Black, while on I<xterm>(1) it would yield Black	1666	would yield White on Black, while on I<xterm>(1) it would yield Black on
1432	on White.	1667	White.
1433
1434	=back
1435		1668
1436	=head2 ALPHA CHANNEL SUPPORT	1669	=head2 ALPHA CHANNEL SUPPORT
1437		1670
1438	If Xft support has been compiled in and as long as Xft/Xrender/X don't get	1671	If Xft support has been compiled in and as long as Xft/Xrender/X don't get
1439	their act together, rxvt-unicode will support C<rgba:rrrr/gggg/bbbb/aaaa>	1672	their act together, rxvt-unicode will do its own alpha channel management:
1440	(recommended, but B<MUST> have 4 digits/component) colour specifications,	1673
1441	in addition to the ones provided by X, where the additional A component	1674	You can prefix any colour with an opaqueness percentage enclosed in
		1675	brackets, i.e. C<[percent]>, where C<percent> is a decimal percentage
		1676	(0-100) that specifies the opacity of the colour, where C<0> is completely
		1677	transparent and C<100> is completely opaque. For example, C<[50]red> is a
		1678	half-transparent red, while C<[95]#00ff00> is an almost opaque green. This
		1679	is the recommended format to specify transparency values, and works with
		1680	all ways to specify a colour.
		1681
		1682	For complete control, rxvt-unicode also supports
		1683	C<rgba:rrrr/gggg/bbbb/aaaa> (exactly four hex digits/component) colour
		1684	specifications, where the additional C<aaaa> component specifies opacity
1442	specifies opacity (alpha) values. The minimum value of C<0> is completely	1685	(alpha) values. The minimum value of C<0000> is completely transparent,
1443	transparent). You can also prefix any color with C<[percent]>, where	1686	while C<ffff> is completely opaque). The two example colours from
1444	C<percent> is a decimal percentage (0-100) that specifies the opacity of	1687	earlier could also be specified as C<rgba:ff00/0000/0000/8000> and
1445	the color, where C<0> is completely transparent and C<100> is completelxy	1688	C<rgba:0000/ff00/0000/f332>.
1446	opaque.
1447		1689
1448	You probably need to specify B<"-depth 32">, too, and have the luck that	1690	You probably need to specify B<"-depth 32">, too, to force a visual with
1449	your X-server uses ARGB pixel layout, as X is far from just supporting	1691	alpha channels, and have the luck that your X-server uses ARGB pixel
1450	ARGB visuals out of the box, and rxvt-unicode just fudges around.	1692	layout, as X is far from just supporting ARGB visuals out of the box, and
		1693	rxvt-unicode just fudges around.
1451		1694
1452	For example, the following selects an almost completely transparent red	1695	For example, the following selects an almost completely transparent black
1453	background, and an almost opaque pink foreground:	1696	background, and an almost opaque pink foreground:
1454		1697
1455	@@RXVT_NAME@@ -depth 32 -bg rgba:0000/0000/0000/aaaa -fg "[80]pink"	1698	@@RXVT_NAME@@ -depth 32 -bg rgba:0000/0000/0000/4444 -fg "[80]pink"
1456		1699
1457	I<Please note that transparency of any kind if completely unsupported by	1700	When not using a background image, then the interpretation of the
1458	the author. Don't bug him with installation questions!>	1701	alpha channel is up to your compositing manager (most interpret it as
		1702	transparency of course).
		1703
		1704	When using a background pixmap or pseudo-transparency, then the background
		1705	colour will always behave as if it were completely transparent (so the
		1706	background image shows instead), regardless of how it was specified, while
		1707	other colours will either be transparent as specified (the background
		1708	image will show through) on servers supporting the RENDER extension, or
		1709	fully opaque on servers not supporting the RENDER EXTENSION.
		1710
		1711	Please note that due to bugs in Xft, specifying alpha values might result
		1712	in garbage being displayed when the X-server does not support the RENDER
		1713	extension.
1459		1714
1460	=head1 ENVIRONMENT	1715	=head1 ENVIRONMENT
1461		1716
1462	B<@@RXVT_NAME@@> sets and/or uses the following environment variables:	1717	B<@@RXVT_NAME@@> sets and/or uses the following environment variables:
1463		1718
…		…
1469	resources or on the command line.	1724	resources or on the command line.
1470		1725
1471	=item B<COLORTERM>	1726	=item B<COLORTERM>
1472		1727
1473	Either C<rxvt>, C<rxvt-xpm>, depending on whether @@RXVT_NAME@@ was	1728	Either C<rxvt>, C<rxvt-xpm>, depending on whether @@RXVT_NAME@@ was
1474	compiled with XPM support, and optionally with the added extension	1729	compiled with background image support, and optionally with the added
1475	C<-mono> to indicate that rxvt-unicode runs on a monochrome screen.	1730	extension C<-mono> to indicate that rxvt-unicode runs on a monochrome
		1731	screen.
1476		1732
1477	=item B<COLORFGBG>	1733	=item B<COLORFGBG>
1478		1734
1479	Set to a string of the form C<fg;bg> or C<fg;xpm;bg>, where C<fg> is	1735	Set to a string of the form C<fg;bg> or C<fg;xpm;bg>, where C<fg> is
1480	the colour code used as default foreground/text colour (or the string	1736	the colour code used as default foreground/text colour (or the string
1481	C<default> to indicate that the default-colour escape sequence is to be	1737	C<default> to indicate that the default-colour escape sequence is to be
1482	used), C<bg> is the colour code used as default background colour (or the	1738	used), C<bg> is the colour code used as default background colour (or the
1483	string C<default>), and C<xpm> is the string C<default> if @@RXVT_NAME@@	1739	string C<default>), and C<xpm> is the string C<default> if @@RXVT_NAME@@
1484	was compiled with XPM support. Libraries like C<ncurses> and C<slang> can	1740	was compiled with background image support. Libraries like C<ncurses>
1485	(and do) use this information to optimize screen output.	1741	and C<slang> can (and do) use this information to optimize screen output.
1486		1742
1487	=item B<WINDOWID>	1743	=item B<WINDOWID>
1488		1744
1489	Set to the (decimal) X Window ID of the @@RXVT_NAME@@ window (the toplevel	1745	Set to the (decimal) X Window ID of the @@RXVT_NAME@@ window (the toplevel
1490	window, which usually has subwindows for the scrollbar, the terminal	1746	window, which usually has subwindows for the scrollbar, the terminal
…		…
1496	C<--with-terminfo=PATH>.	1752	C<--with-terminfo=PATH>.
1497		1753
1498	=item B<DISPLAY>	1754	=item B<DISPLAY>
1499		1755
1500	Used by @@RXVT_NAME@@ to connect to the display and set to the correct	1756	Used by @@RXVT_NAME@@ to connect to the display and set to the correct
1501	display in its child processes.	1757	display in its child processes if C<-display> isn't used to override. It
		1758	defaults to C<:0> if it doesn't exist.
1502		1759
1503	=item B<SHELL>	1760	=item B<SHELL>
1504		1761
1505	The shell to be used for command execution, defaults to C</bin/sh>.	1762	The shell to be used for command execution, defaults to C</bin/sh>.
1506		1763
1507	=item B<RXVT_SOCKET>	1764	=item B<RXVT_SOCKET> [I<sic>]
1508		1765
1509	The unix domain socket path used by @@RXVT_NAME@@c(1) and	1766	The unix domain socket path used by @@RXVT_NAME@@c(1) and
1510	@@RXVT_NAME@@d(1).	1767	@@RXVT_NAME@@d(1).
1511		1768
1512	Default F<<< $HOME/.rxvt-unicode-I<< <nodename >> >>>.	1769	Default F<<< $HOME/.urxvt/urxvtd-I<< <nodename> >> >>>.
		1770
		1771	=item B<URXVT_PERL_LIB>
		1772
		1773	Additional F<:>-separated library search path for perl extensions. Will be
		1774	searched after B<-perl-lib> but before F<~/.urxvt/ext> and the system library
		1775	directory.
		1776
		1777	=item B<URXVT_PERL_VERBOSITY>
		1778
		1779	See L<@@RXVT_NAME@@perl>(3).
1513		1780
1514	=item B<HOME>	1781	=item B<HOME>
1515		1782
1516	Used to locate the default directory for the unix domain socket for	1783	Used to locate the default directory for the unix domain socket for
1517	daemon communications and to locate various resource files (such as	1784	daemon communications and to locate various resource files (such as
1518	C<.Xdefaults>)	1785	C<.Xdefaults>)
1519		1786
1520	=item B<XAPPLRESDIR>	1787	=item B<XAPPLRESDIR>
1521		1788
1522	Directory where various X resource files are being located.	1789	Directory where application-specific X resource files are located.
1523		1790
1524	=item B<XENVIRONMENT>	1791	=item B<XENVIRONMENT>
1525		1792
1526	If set and accessible, gives the name of a X resource file to be loaded by	1793	If set and accessible, gives the name of a X resource file to be loaded by
1527	@@RXVT_NAME@@.	1794	@@RXVT_NAME@@.
…		…
1532		1799
1533	=over 4	1800	=over 4
1534		1801
1535	=item B</usr/lib/X11/rgb.txt>	1802	=item B</usr/lib/X11/rgb.txt>
1536		1803
1537	Color names.	1804	Colour names.
1538		1805
1539	=back	1806	=back
1540		1807
1541	=head1 SEE ALSO	1808	=head1 SEE ALSO
1542		1809
		1810	@@RXVT_NAME@@(7), @@RXVT_NAME@@c(1), @@RXVT_NAME@@d(1), @@RXVT_NAME@@-extensions(1),
1543	@@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)	1811	@@RXVT_NAME@@perl(3), xterm(1), sh(1), resize(1), X(1), pty(4), tty(4), utmp(5)
1544		1812
1545	=head1 CURRENT PROJECT COORDINATOR	1813	=head1 CURRENT PROJECT COORDINATOR
1546		1814
1547	=over 4	1815	=over 4
1548		1816
1549	=item Project Coordinator	1817	=item Project Coordinator
1550		1818
1551	Marc A. Lehmann L<< <rxvt-unicode@schmorp.de> >>	1819	Marc A. Lehmann <rxvt-unicode@schmorp.de>.
1552		1820
1553	L<http://software.schmorp.de/pkg/rxvt-unicode.html>	1821	L<http://software.schmorp.de/pkg/rxvt-unicode.html>
1554		1822
1555	=back	1823	=back
1556		1824
…		…
1560		1828
1561	=item John Bovey	1829	=item John Bovey
1562		1830
1563	University of Kent, 1992, wrote the original Xvt.	1831	University of Kent, 1992, wrote the original Xvt.
1564		1832
1565	=item Rob Nation L<< <nation@rocket.sanders.lockheed.com> >>	1833	=item Rob Nation <nation@rocket.sanders.lockheed.com>
1566		1834
1567	very heavily modified Xvt and came up with Rxvt	1835	very heavily modified Xvt and came up with Rxvt
1568		1836
1569	=item Angelo Haritsis L<< <ah@doc.ic.ac.uk> >>	1837	=item Angelo Haritsis <ah@doc.ic.ac.uk>
1570		1838
1571	wrote the Greek Keyboard Input (no longer in code)	1839	wrote the Greek Keyboard Input (no longer in code)
1572		1840
1573	=item mj olesen L<< <olesen@me.QueensU.CA> >>	1841	=item mj olesen <olesen@me.QueensU.CA>
1574		1842
1575	Wrote the menu system.	1843	Wrote the menu system.
1576		1844
1577	Project Coordinator (changes.txt 2.11 to 2.21)	1845	Project Coordinator (changes.txt 2.11 to 2.21)
1578		1846
1579	=item Oezguer Kesim L<< <kesim@math.fu-berlin.de> >>	1847	=item Oezguer Kesim <kesim@math.fu-berlin.de>
1580		1848
1581	Project Coordinator (changes.txt 2.21a to 2.4.5)	1849	Project Coordinator (changes.txt 2.21a to 2.4.5)
1582		1850
1583	=item Geoff Wing L<< <gcw@pobox.com> >>	1851	=item Geoff Wing <gcw@pobox.com>
1584		1852
1585	Rewrote screen display and text selection routines.	1853	Rewrote screen display and text selection routines.
1586		1854
1587	Project Coordinator (changes.txt 2.4.6 - rxvt-unicode)	1855	Project Coordinator (changes.txt 2.4.6 - rxvt-unicode)
1588		1856
1589	=item Marc Alexander Lehmann L<< <rxvt-unicode@schmorp.de> >>	1857	=item Marc Alexander Lehmann <rxvt-unicode@schmorp.de>
1590		1858
1591	Forked rxvt-unicode, unicode support, rewrote almost all the code, perl	1859	Forked rxvt-unicode, unicode support, rewrote almost all the code, perl
1592	extension, random hacks, numerous bugfixes and extensions.	1860	extension, random hacks, numerous bugfixes and extensions.
1593		1861
1594	Project Coordinator (Changes 1.0 -)	1862	Project Coordinator (Changes 1.0 -)
1595		1863
1596	=item Emanuele Giaquinta L<< <e.giaquinta@glauco.it> >>	1864	=item Emanuele Giaquinta <emanuele.giaquinta@gmail.com>
1597		1865
1598	Pty/tty/utmp/wtmp rewrite, lots of random hacking and bugfixing.	1866	pty/utmp code rewrite, image code improvements, many random hacks and bugfixes.
1599		1867
1600	=back	1868	=back
1601		1869

Diff Legend

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

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents): Revision 1.132 by root, Mon Jun 18 13:38:12 2007 UTC vs. Revision 1.246 by sf-exg, Tue Jun 21 12:03:55 2016 UTC

Diff Legend

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents):
Revision 1.132 by root, Mon Jun 18 13:38:12 2007 UTC vs.
Revision 1.246 by sf-exg, Tue Jun 21 12:03:55 2016 UTC