ViewVC Help

View File | Revision Log | Show Annotations | Download File

/cvs/rxvt-unicode/doc/rxvt.1.pod

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents):
Revision 1.116 by root, Mon Jul 10 04:03:09 2006 UTC vs.
Revision 1.243 by root, Sat May 30 21:02:05 2015 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/*checkout*/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 userfriendly, lean and clean	43	me recommend C<mlterm>, which is a very user friendly, lean and clean
41	terminal emulator. In fact, the reason rxvt-unicode was born was solely	44	terminal emulator. In fact, the reason rxvt-unicode was born was solely
42	because the author couldn't get C<mlterm> to use one font for latin1 and	45	because the author couldn't get C<mlterm> to use one font for latin1 and
43	another for japanese.	46	another for japanese.
44		47
45	Therefore another design rationale was the use of multiple fonts to	48	Therefore another design rationale was the use of multiple fonts to
…		…
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>
108		122
109	Turn on/off simulated reverse video; resource B<reverseVideo>.	123	Turn on/off simulated reverse video; resource B<reverseVideo>.
110		124
111	=item B<-j>|B<+j>	125	=item B<-j>|B<+j>
112		126
113	Turn on/off jump scrolling; resource B<jumpScroll>.	127	Turn on/off jump scrolling (allow multiple lines per refresh); resource B<jumpScroll>.
114		128
115	=item B<-ip>|B<+ip> | B<-tr>|B<+tr>	129	=item B<-ss>|B<+ss>
116		130
117	Turn on/off inheriting parent window's pixmap. Alternative form is	131	Turn on/off skip scrolling (allow multiple screens per refresh); resource B<skipScroll>.
118	B<-tr>; resource B<inheritPixmap>.
119
120	I<Please note that transparency of any kind if completely unsupported by
121	the author. Don't bug him with installation questions!>
122		132
123	=item B<-fade> I<number>	133	=item B<-fade> I<number>
124		134
125	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
126	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
…		…
129	=item B<-fadecolor> I<colour>	139	=item B<-fadecolor> I<colour>
130		140
131	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
132	is opaque black. resource B<fadeColor>.	142	is opaque black. resource B<fadeColor>.
133		143
134	=item B<-tint> I<colour>	144	=item B<-icon> I<file>
135		145
136	Tint the transparent background pixmap with the given colour when	146	Compile I<pixbuf>: Use the specified image as application icon. This
137	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
138	non-tiled backgrounds, currently. See also the B<-sh> option that can be	148	application window; resource I<iconFile>.
139	used to brighten or darken the image in addition to tinting it; resource
140	I<tintColor>. Example:
141
142	@@RXVT_NAME@@ -tr -tint blue -sh 40
143
144	=item B<-sh>
145
146	I<number> Darken (0 .. 100) or lighten (-1 .. -100) the transparent
147	background image in addition to tinting it (i.e. B<-tint> must be
148	specified, too, e.g. C<-tint white>).
149		149
150	=item B<-bg> I<colour>	150	=item B<-bg> I<colour>
151		151
152	Window background colour; resource B<background>.	152	Window background colour; resource B<background>.
153		153
154	=item B<-fg> I<colour>	154	=item B<-fg> I<colour>
155		155
156	Window foreground colour; resource B<foreground>.	156	Window foreground colour; resource B<foreground>.
157
158	=item B<-pixmap> I<file[;geom]>
159
160	Compile I<XPM>: Specify XPM file for the background and also optionally
161	specify its scaling with a geometry string. Note you may need to
162	add quotes to avoid special shell interpretation of the C<;> in the
163	command-line; resource B<backgroundPixmap>.
164		157
165	=item B<-cr> I<colour>	158	=item B<-cr> I<colour>
166		159
167	The cursor colour; resource B<cursorColor>.	160	The cursor colour; resource B<cursorColor>.
168		161
…		…
213	italic> >> characters are to be printed. See resource B<boldItalicFont>	206	italic> >> characters are to be printed. See resource B<boldItalicFont>
214	for details.	207	for details.
215		208
216	=item B<-is>|B<+is>	209	=item B<-is>|B<+is>
217		210
218	Compile I<font-styles>: Bold/Italic font styles imply high intensity	211	Compile I<font-styles>: Bold/Blink font styles imply high intensity
219	foreground/background (default). See resource B<intensityStyles> for	212	foreground/background (default). See resource B<intensityStyles> for
220	details.	213	details.
221		214
222	=item B<-name> I<name>	215	=item B<-name> I<name>
223		216
…		…
227		220
228	=item B<-ls>|B<+ls>	221	=item B<-ls>|B<+ls>
229		222
230	Start as a login-shell/sub-shell; resource B<loginShell>.	223	Start as a login-shell/sub-shell; resource B<loginShell>.
231		224
		225	=item B<-mc> I<milliseconds>
		226
		227	Specify the maximum time between multi-click selections.
		228
232	=item B<-ut>|B<+ut>	229	=item B<-ut>|B<+ut>
233		230
234	Compile I<utmp>: Inhibit/enable writing a utmp entry; resource	231	Compile I<utmp>: Inhibit/enable writing a utmp entry; resource
235	B<utmpInhibit>.	232	B<utmpInhibit>.
236		233
…		…
240	B<visualBell>.	237	B<visualBell>.
241		238
242	=item B<-sb>|B<+sb>	239	=item B<-sb>|B<+sb>
243		240
244	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>.
245		251
246	=item B<-si>|B<+si>	252	=item B<-si>|B<+si>
247		253
248	Turn on/off scroll-to-bottom on TTY output inhibit; resource	254	Turn on/off scroll-to-bottom on TTY output inhibit; resource
249	B<scrollTtyOutput> has opposite effect.	255	B<scrollTtyOutput> has opposite effect.
…		…
256	=item B<-sw>|B<+sw>	262	=item B<-sw>|B<+sw>
257		263
258	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.
259	This only takes effect if B<-si> is also given; resource	265	This only takes effect if B<-si> is also given; resource
260	B<scrollWithBuffer>.	266	B<scrollWithBuffer>.
261
262	=item B<-sr>|B<+sr>
263
264	Put scrollbar on right/left; resource B<scrollBar_right>.
265
266	=item B<-st>|B<+st>
267
268	Display rxvt (non XTerm/NeXT) scrollbar without/with a trough;
269	resource B<scrollBar_floating>.
270		267
271	=item B<-ptab>|B<+ptab>	268	=item B<-ptab>|B<+ptab>
272		269
273	If enabled (default), "Horizontal Tab" characters are being stored as	270	If enabled (default), "Horizontal Tab" characters are being stored as
274	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
…		…
278		275
279	=item B<-bc>|B<+bc>	276	=item B<-bc>|B<+bc>
280		277
281	Blink the cursor; resource B<cursorBlink>.	278	Blink the cursor; resource B<cursorBlink>.
282		279
		280	=item B<-uc>|B<+uc>
		281
		282	Make the cursor underlined; resource B<cursorUnderline>.
		283
283	=item B<-iconic>	284	=item B<-iconic>
284		285
285	Start iconified, if the window manager supports that option.	286	Start iconified, if the window manager supports that option.
286	Alternative form is B<-ic>.	287	Alternative form is B<-ic>.
287		288
…		…
303		304
304	=item B<-bl>	305	=item B<-bl>
305		306
306	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.
307	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
308	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.
309		311
310	=item B<-override-redirect>	312	=item B<-override-redirect>
311		313
312	Compile I<frills>: Sets override-redirect on the window; resource	314	Compile I<frills>: Sets override-redirect on the window; resource
313	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.
314		321
315	=item B<-sbg>	322	=item B<-sbg>
316		323
317	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
318	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
…		…
321		328
322	=item B<-lsp> I<number>	329	=item B<-lsp> I<number>
323		330
324	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
325	the display. Useful to work around font rendering problems; resource	332	the display. Useful to work around font rendering problems; resource
326	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>.
327		341
328	=item B<-tn> I<termname>	342	=item B<-tn> I<termname>
329		343
330	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
331	B<TERM> environment variable. This terminal type must exist in the	345	B<TERM> environment variable. This terminal type must exist in the
…		…
366	=item B<-pt> I<style>	380	=item B<-pt> I<style>
367		381
368	Compile I<XIM>: input style for input method; B<OverTheSpot>,	382	Compile I<XIM>: input style for input method; B<OverTheSpot>,
369	B<OffTheSpot>, B<Root>; resource B<preeditType>.	383	B<OffTheSpot>, B<Root>; resource B<preeditType>.
370		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
371	=item B<-im> I<text>	388	=item B<-im> I<text>
372		389
373	Compile I<XIM>: input method name. resource B<inputMethod>.	390	Compile I<XIM>: input method name. resource B<inputMethod>.
374		391
375	=item B<-imlocale> I<string>	392	=item B<-imlocale> I<string>
…		…
385	for more info.	402	for more info.
386		403
387	=item B<-tcw>	404	=item B<-tcw>
388		405
389	Change the meaning of triple-click selection with the left mouse	406	Change the meaning of triple-click selection with the left mouse
		407	button. Only effective when the original (non-perl) selection code is
390	button. 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
391	end of the logical line only. resource B<tripleclickwords>.	409	the end of the logical line only. resource B<tripleclickwords>.
392		410
393	=item B<-insecure>	411	=item B<-insecure>
394		412
395	Enable "insecure" mode, which currently enables most of the escape	413	Enable "insecure" mode, which currently enables most of the escape
396	sequences that echo strings. See the resource B<insecure> for more	414	sequences that echo strings. See the resource B<insecure> for more
…		…
417	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@@
418	will not immediately destroy its window when the program executed within	436	will not immediately destroy its window when the program executed within
419	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
420	user; resource B<hold>.	438	user; resource B<hold>.
421		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.
		458
422	=item B<-keysym.>I<sym> I<string>	459	=item B<-keysym.>I<sym> I<string>
423		460
424	Remap a key symbol. See resource B<keysym>.	461	Remap a key symbol. See resource B<keysym>.
425		462
426	=item B<-embed> I<windowid>	463	=item B<-embed> I<windowid>
…		…
436	The window will not be destroyed when @@RXVT_NAME@@ exits.	473	The window will not be destroyed when @@RXVT_NAME@@ exits.
437		474
438	It might be useful to know that @@RXVT_NAME@@ will not close file	475	It might be useful to know that @@RXVT_NAME@@ will not close file
439	descriptors passed to it (except for stdin/out/err, of course), so you	476	descriptors passed to it (except for stdin/out/err, of course), so you
440	can use file descriptors to communicate with the programs within the	477	can use file descriptors to communicate with the programs within the
441	terminal. This works regardless of wether the C<-embed> option was used or	478	terminal. This works regardless of whether the C<-embed> option was used or
442	not.	479	not.
443		480
444	Here is a short Gtk2-perl snippet that illustrates how this option can be	481	Here is a short Gtk2-perl snippet that illustrates how this option can be
445	used (a longer example is in F<doc/embed>):	482	used (a longer example is in F<doc/embed>):
446		483
…		…
451	});	488	});
452		489
453	=item B<-pty-fd> I<file descriptor>	490	=item B<-pty-fd> I<file descriptor>
454		491
455	Tells @@RXVT_NAME@@ NOT to execute any commands or create a new pty/tty	492	Tells @@RXVT_NAME@@ NOT to execute any commands or create a new pty/tty
456	pair but instead use the given filehandle as the tty master. This is	493	pair but instead use the given file descriptor as the tty master. This is
457	useful if you want to drive @@RXVT_NAME@@ as a generic terminal emulator	494	useful if you want to drive @@RXVT_NAME@@ as a generic terminal emulator
458	without having to run a program within it.	495	without having to run a program within it.
459		496
460	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
461	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
462	yourself if you want that.	499	yourself if you want that.
463		500
464	As an extremely special case, specifying C<-1> will completely suppress	501	As an extremely special case, specifying C<-1> will completely suppress
465	pty/tty operations.	502	pty/tty operations, which is probably only useful in conjunction with some
		503	perl extension that manages the terminal.
466		504
467	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
468	longer example is in F<doc/pty-fd>):	506	longer example is in F<doc/pty-fd>):
469		507
470	use IO::Pty;	508	use IO::Pty;
…		…
484	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
485	this terminal instance. See resource B<perl-ext> for details.	523	this terminal instance. See resource B<perl-ext> for details.
486		524
487	=back	525	=back
488		526
489	=head1 RESOURCES (available also as long-options)	527	=head1 RESOURCES
490		528
491	Note: `@@RXVT_NAME@@ --help' gives a list of all resources (long	529	Note: `@@RXVT_NAME@@ --help' gives a list of all resources (long
492	options) compiled into your version.	530	options) compiled into your version. All resources are also available as
		531	long-options.
493		532
494	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
495	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
496	starts. @@RXVT_NAME@@ will consult the following files/resources in order,	535	starts. @@RXVT_NAME@@ will consult the following files/resources in order,
497	with later settings overwriting earlier ones:	536	with later settings overwriting earlier ones:
498		537
499	1. system-wide app-defaults file, either locale-dependent OR global
500	2. app-defaults file in $XAPPLRESDIR	538	1. app-defaults file in $XAPPLRESDIR
		539	2. $HOME/.Xdefaults
501	3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults	540	3. RESOURCE_MANAGER property on root-window of screen 0
502	4. SCREEN_RESOURCES for the current screen	541	4. SCREEN_RESOURCES property on root-window of the current screen
503	5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename>	542	5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename>
		543	6. resources specified via -xrm on the commandline
504		544
505	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
506	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
507	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
508	configured, while the class name B<URxvt> allows resources unique to	548	configured, while the class name B<URxvt> allows resources unique to
…		…
518	=item B<depth:> I<bitdepth>	558	=item B<depth:> I<bitdepth>
519		559
520	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;
521	option B<-depth>.	561	option B<-depth>.
522		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
523	=item B<geometry:> I<geom>	570	=item B<geometry:> I<geom>
524		571
525	Create the window with the specified X window geometry [default 80x24];	572	Create the window with the specified X window geometry [default 80x24];
526	option B<-geometry>.	573	option B<-geometry>.
527		574
…		…
540	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
541	corresponds to low-intensity (normal) colours and 8-15 corresponds to	588	corresponds to low-intensity (normal) colours and 8-15 corresponds to
542	high-intensity (bold = bright foreground, blink = bright background)	589	high-intensity (bold = bright foreground, blink = bright background)
543	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,
544	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
545	names used are listed in the B<COLORS AND GRAPHICS> section.	592	names used are listed in the B<COLOURS AND GRAPHICS> section.
546		593
547	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
548	changed using an escape command (see @@RXVT_NAME@@(7)).	595	changed using an escape command (see @@RXVT_NAME@@(7)).
549		596
550	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
…		…
561	=item B<colorUL:> I<colour>	608	=item B<colorUL:> I<colour>
562		609
563	Use the specified colour to display underlined characters when the	610	Use the specified colour to display underlined characters when the
564	foreground colour is the default.	611	foreground colour is the default.
565		612
566	=item B<colorRV:> I<colour>
567
568	Use the specified colour as the background for reverse video
569	characters.
570
571	=item B<underlineColor:> I<colour>	613	=item B<underlineColor:> I<colour>
572		614
573	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
574	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.
575		627
576	=item B<cursorColor:> I<colour>	628	=item B<cursorColor:> I<colour>
577		629
578	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
579	foreground colour; option B<-cr>.	631	foreground colour; option B<-cr>.
…		…
586		638
587	=item B<reverseVideo:> I<boolean>	639	=item B<reverseVideo:> I<boolean>
588		640
589	B<True>: simulate reverse video by foreground and background colours;	641	B<True>: simulate reverse video by foreground and background colours;
590	option B<-rv>. B<False>: regular screen colours [default]; option	642	option B<-rv>. B<False>: regular screen colours [default]; option
591	B<+rv>. See note in B<COLORS AND GRAPHICS> section.	643	B<+rv>. See note in B<COLOURS AND GRAPHICS> section.
592		644
593	=item B<jumpScroll:> I<boolean>	645	=item B<jumpScroll:> I<boolean>
594		646
595	B<True>: specify that jump scrolling should be used. When scrolling	647	B<True>: specify that jump scrolling should be used. When receiving lots
596	quickly, fewer screen updates are performed [default]; option B<-j>.	648	of lines, @@RXVT_NAME@@ will only scroll once a whole screen height of lines
		649	has been read, resulting in fewer updates while still displaying every
		650	received line; option B<-j>.
		651
597	B<False>: specify that smooth scrolling should be used; option B<+j>.	652	B<False>: specify that smooth scrolling should be used. @@RXVT_NAME@@ will
		653	force a screen refresh on each new line it received; option B<+j>.
598		654
599	=item B<inheritPixmap:> I<boolean>	655	=item B<skipScroll:> I<boolean>
600		656
601	B<True>: make the background inherit the parent windows' pixmap, giving	657	B<True>: (the default) specify that skip scrolling should be used. When
602	artificial transparency. B<False>: do not inherit the parent windows'	658	receiving lots of lines, @@RXVT_NAME@@ will only scroll once in a while
603	pixmap.	659	(around 60 times per second), resulting in far fewer updates. This can
		660	result in @@RXVT_NAME@@ not ever displaying some of the lines it receives;
		661	option B<-ss>.
604		662
605	I<Please note that transparency of any kind if completely unsupported by	663	B<False>: specify that everything is to be displayed, even
606	the author. Don't bug him with installation questions!>	664	if the refresh is too fast for the human eye to read anything (or the
		665	monitor to display anything); option B<+ss>.
607		666
608	=item B<fading:> I<number>	667	=item B<fading:> I<number>
609		668
610	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>.
611		670
612	=item B<fadeColor:> I<colour>	671	=item B<fadeColor:> I<colour>
613		672
614	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
615	colour is black; option B<-fadecolor>.	674	colour is black; option B<-fadecolor>.
616		675
617	=item B<tintColor:> I<colour>	676	=item B<iconFile:> I<file>
618		677
619	Tint the transparent background pixmap with the given colour; option	678	Set the application icon pixmap; option B<-icon>.
620	B<-tint>.
621
622	=item B<shading:> I<number>
623
624	Darken (0 .. 100) or lighten (-1 .. -100) the transparent background
625	image in addition to tinting it.
626		679
627	=item B<scrollColor:> I<colour>	680	=item B<scrollColor:> I<colour>
628		681
629	Use the specified colour for the scrollbar [default #B2B2B2].	682	Use the specified colour for the scrollbar [default #B2B2B2].
630		683
…		…
635		688
636	=item B<borderColor:> I<colour>	689	=item B<borderColor:> I<colour>
637		690
638	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
639	and the text.	692	and the text.
640
641	=item B<backgroundPixmap:> I<file[;geom]>
642
643	Use the specified XPM file (note the `.xpm' extension is optional) for
644	the background and also optionally specify its scaling with a geometry
645	string B<WxH+X+Y>, in which B<"W" / "H"> specify the
646	horizontal/vertical scale (percent) and B<"X" / "Y"> locate the image
647	centre (percent). A scale of 0 displays the image with tiling. A scale
648	of 1 displays the image without any scaling. A scale of 2 to 9
649	specifies an integer number of images in that direction. No image will
650	be magnified beyond 10 times its original size. The maximum permitted
651	scale is 1000. [default 0x0+50+50]
652
653	=item B<path:> I<path>
654
655	Specify the colon-delimited search path for finding XPM files.
656		693
657	=item B<font:> I<fontlist>	694	=item B<font:> I<fontlist>
658		695
659	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
660	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
…		…
683	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
684	wide and 15 pixels high.	721	wide and 15 pixels high.
685		722
686	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
687	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
688	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
689	useful supplement.	726	useful supplement.
690		727
691	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
692	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
693	contains other characters, but we are not interested in them.	730	contains other characters, but we are not interested in them.
…		…
717	text font will being used for the given style.	754	text font will being used for the given style.
718		755
719	=item B<intensityStyles:> I<boolean>	756	=item B<intensityStyles:> I<boolean>
720		757
721	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>,
722	option B<-is>, the default), bold and italic font styles imply high	759	option B<-is>, the default), bold/blink font styles imply high
723	intensity foreground/backround colours. Disabling this option (B<False>,	760	intensity foreground/background colours. Disabling this option (B<False>,
724	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
725	reachable.	762	reachable.
726
727	=item B<selectstyle:> I<mode>
728
729	Set mouse selection style to B<old> which is 2.20, B<oldword> which is
730	xterm style with 2.20 old word selection, or anything else which gives
731	xterm style selection.
732
733	=item B<scrollstyle:> I<mode>
734
735	Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is
736	the author's favourite.
737		763
738	=item B<title:> I<string>	764	=item B<title:> I<string>
739		765
740	Set window title string, the default title is the command-line	766	Set window title string, the default title is the command-line
741	specified after the B<-e> option, if any, otherwise the application	767	specified after the B<-e> option, if any, otherwise the application
…		…
750	=item B<mapAlert:> I<boolean>	776	=item B<mapAlert:> I<boolean>
751		777
752	B<True>: de-iconify (map) on receipt of a bell character. B<False>: no	778	B<True>: de-iconify (map) on receipt of a bell character. B<False>: no
753	de-iconify (map) on receipt of a bell character [default].	779	de-iconify (map) on receipt of a bell character [default].
754		780
		781	=item B<urgentOnBell:> I<boolean>
		782
		783	B<True>: set the urgency hint for the wm on receipt of a bell character.
		784	B<False>: do not set the urgency hint [default].
		785
		786	@@RXVT_NAME@@ resets the urgency hint on every focus change.
		787
755	=item B<visualBell:> I<boolean>	788	=item B<visualBell:> I<boolean>
756		789
757	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>.
758	B<False>: no visual bell [default]; option B<+vb>.	791	B<False>: no visual bell [default]; option B<+vb>.
759		792
…		…
761		794
762	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
763	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
764	[default]; option B<+ls>.	797	[default]; option B<+ls>.
765		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
766	=item B<utmpInhibit:> I<boolean>	804	=item B<utmpInhibit:> I<boolean>
767		805
768	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>;
769	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>
770	[default]; option B<+ut>.	808	[default]; option B<+ut>.
…		…
780	Example:	818	Example:
781		819
782	URxvt.print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX)	820	URxvt.print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX)
783		821
784	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
785	everytime you hit C<Print>.	823	every time you hit C<Print>.
		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.
786		833
787	=item B<scrollBar:> I<boolean>	834	=item B<scrollBar:> I<boolean>
788		835
789	B<True>: enable the scrollbar [default]; option B<-sb>. B<False>:	836	B<True>: enable the scrollbar [default]; option B<-sb>. B<False>:
790	disable the scrollbar; option B<+sb>.	837	disable the scrollbar; option B<+sb>.
…		…
810	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
811	B<+si>.	858	B<+si>.
812		859
813	=item B<scrollWithBuffer:> I<boolean>	860	=item B<scrollWithBuffer:> I<boolean>
814		861
815	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.
816	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
817	with scrollback buffer when tty recieves 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>.
818		866
819	=item B<scrollTtyKeypress:> I<boolean>	867	=item B<scrollTtyKeypress:> I<boolean>
820		868
821	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
822	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
…		…
853	=item B<termName:> I<termname>	901	=item B<termName:> I<termname>
854		902
855	Specifies the terminal type name to be set in the B<TERM> environment	903	Specifies the terminal type name to be set in the B<TERM> environment
856	variable; option B<-tn>.	904	variable; option B<-tn>.
857		905
858	=item B<linespace:> I<number>	906	=item B<lineSpace:> I<number>
859		907
860	Specifies number of lines (pixel height) to insert between each row of	908	Specifies number of lines (pixel height) to insert between each row of
861	the display [default 0]; option B<-lsp>.	909	the display [default 0]; option B<-lsp>.
862		910
863	=item B<meta8:> I<boolean>	911	=item B<meta8:> I<boolean>
…		…
877		925
878	=item B<cursorBlink:> I<boolean>	926	=item B<cursorBlink:> I<boolean>
879		927
880	B<True>: blink the cursor. B<False>: do not blink the cursor [default];	928	B<True>: blink the cursor. B<False>: do not blink the cursor [default];
881	option B<-bc>.	929	option B<-bc>.
		930
		931	=item B<cursorUnderline:> I<boolean>
		932
		933	B<True>: Make the cursor underlined. B<False>: Make the cursor a box [default];
		934	option B<-uc>.
882		935
883	=item B<pointerBlank:> I<boolean>	936	=item B<pointerBlank:> I<boolean>
884		937
885	B<True>: blank the pointer when a key is pressed or after a set number	938	B<True>: blank the pointer when a key is pressed or after a set number
886	of seconds of inactivity. B<False>: the pointer is always visible	939	of seconds of inactivity. B<False>: the pointer is always visible
…		…
900	large number (e.g. C<987654321>) to effectively disable the timeout.	953	large number (e.g. C<987654321>) to effectively disable the timeout.
901		954
902	=item B<backspacekey:> I<string>	955	=item B<backspacekey:> I<string>
903		956
904	The string to send when the backspace key is pressed. If set to B<DEC>	957	The string to send when the backspace key is pressed. If set to B<DEC>
905	or unset it will send B<Delete> (code 127) or, if shifted, B<Backspace>	958	or unset it will send B<Delete> (code 127) or, with control, B<Backspace>
906	(code 8) - which can be reversed with the appropriate DEC private mode	959	(code 8) - which can be reversed with the appropriate DEC private mode
907	escape sequence.	960	escape sequence.
908		961
909	=item B<deletekey:> I<string>	962	=item B<deletekey:> I<string>
910		963
…		…
915	=item B<cutchars:> I<string>	968	=item B<cutchars:> I<string>
916		969
917	The characters used as delimiters for double-click word selection	970	The characters used as delimiters for double-click word selection
918	(whitespace delimiting is added automatically if resource is given).	971	(whitespace delimiting is added automatically if resource is given).
919		972
920	When the selection extension is in use (the default if compiled in, see	973	When the perl selection extension is in use (the default if compiled
921	the @@RXVT_NAME@@perl(3) manpage), a suitable regex using these characters	974	in, see the @@RXVT_NAME@@perl(3) manpage), a suitable regex using these
922	will be created (if the resource exists, otherwise, no regex will be	975	characters will be created (if the resource exists, otherwise, no regex
923	created). In this mode, characters outside ISO-8859-1 can be used.	976	will be created). In this mode, characters outside ISO-8859-1 can be used.
924		977
925	When the selection extension is not used, only ISO-8859-1 characters can	978	When the selection extension is not used, only ISO-8859-1 characters can
926	be used. If not specified, the built-in default is used:	979	be used. If not specified, the built-in default is used:
927		980
928	B<< BACKSLASH `"'&()*,;<=>?@[]{|} >>	981	B<< BACKSLASH `"'&()*,;<=>?@[]^{|} >>
929		982
930	=item B<preeditType:> I<style>	983	=item B<preeditType:> I<style>
931		984
932	B<OverTheSpot>, B<OffTheSpot>, B<Root>; option B<-pt>.	985	B<OnTheSpot>, B<OverTheSpot>, B<OffTheSpot>, B<Root>; option B<-pt>.
933		986
934	=item B<inputMethod:> I<name>	987	=item B<inputMethod:> I<name>
935		988
936	I<name> of inputMethod to use; option B<-im>.	989	I<name> of inputMethod to use; option B<-im>.
937		990
…		…
987		1040
988	Turn on/off secondary screen (default enabled).	1041	Turn on/off secondary screen (default enabled).
989		1042
990	=item B<secondaryScroll:> I<boolean>	1043	=item B<secondaryScroll:> I<boolean>
991		1044
992	Turn on/off secondary screen scroll (default enabled). If the this	1045	Turn on/off secondary screen scroll (default enabled). If this
993	option is enabled, scrolls on the secondary screen will change the	1046	option is enabled, scrolls on the secondary screen will change the
994	scrollback buffer and switching to/from the secondary screen will	1047	scrollback buffer and, when secondaryScreen is off, switching
995	instead scroll the screen up.	1048	to/from the secondary screen will instead scroll the screen up.
996		1049
997	=item B<hold>: I<boolean>	1050	=item B<hold>: I<boolean>
998		1051
999	Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@	1052	Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@
1000	will not immediately destroy its window when the program executed within	1053	will not immediately destroy its window when the program executed within
1001	it exits. Instead, it will wait till it is being killed or closed by the	1054	it exits. Instead, it will wait till it is being killed or closed by the
1002	user.	1055	user.
1003		1056
		1057	=item B<chdir>: I<path>
		1058
		1059	Sets the working directory for the shell (or the command specified via
		1060	B<-e>). The I<path> must be an absolute path and it must exist for
		1061	@@RXVT_NAME@@ to start. If it isn't specified then the current working
		1062	directory will be used; option B<-cd>.
		1063
1004	=item B<keysym.>I<sym>: I<string>	1064	=item B<keysym.>I<sym>: I<action>
1005		1065
1006	Compile I<frills>: Associate I<string> with keysym I<sym>. The	1066	Compile I<frills>: Associate I<action> with keysym I<sym>. The intervening
1007	intervening resource name B<keysym.> cannot be omitted.	1067	resource name B<keysym.> cannot be omitted.
1008		1068
1009	The format of I<sym> is "I<(modifiers-)key>", where I<modifiers> can be	1069	Using this resource, you can map key combinations such as
1010	any combination of B<ISOLevel3>, B<AppKeypad>, B<Control>, B<NumLock>,	1070	C<Ctrl-Shift-BackSpace> to various actions, such as outputting a different
1011	B<Shift>, B<Meta>, B<Lock>, B<Mod1>, B<Mod2>, B<Mod3>, B<Mod4>, B<Mod5>,	1071	string than would normally result from that combination, making the
1012	and the abbreviated B<I>, B<K>, B<C>, B<N>, B<S>, B<M>, B<A>, B<L>, B<1>,	1072	terminal scroll up or down the way you want it, or any other thing an
1013	B<2>, B<3>, B<4>, B<5>.	1073	extension might provide.
		1074
		1075	The key combination that triggers the action, I<sym>, has the following format:
		1076
		1077	(modifiers-)key
		1078
		1079	Where I<modifiers> can be any combination of B<ISOLevel3>, B<AppKeypad>,
		1080	B<Control>, B<NumLock>, B<Shift>, B<Meta>, B<Lock>, B<Mod1>, B<Mod2>,
		1081	B<Mod3>, B<Mod4>, B<Mod5>, and the abbreviated B<I>, B<K>, B<C>, B<N>,
		1082	B<S>, B<M>, B<A>, B<L>, B<1>, B<2>, B<3>, B<4>, B<5>.
1014		1083
1015	The B<NumLock>, B<Meta> and B<ISOLevel3> modifiers are usually aliased to	1084	The B<NumLock>, B<Meta> and B<ISOLevel3> modifiers are usually aliased to
1016	whatever modifier the NumLock key, Meta/Alt keys or ISO Level3 Shift/AltGr	1085	whatever modifier the NumLock key, Meta/Alt keys or ISO Level3 Shift/AltGr
1017	keys are being mapped. B<AppKeypad> is a synthetic modifier mapped to the	1086	keys are being mapped. B<AppKeypad> is a synthetic modifier mapped to the
1018	current application keymap mode state.	1087	current application keymap mode state.
1019		1088
1020	The spellings of I<key> can be obtained by using B<xev>(1) command or	1089	Due the the large number of modifier combinations, a key mapping will
1021	searching keysym macros from B</usr/X11R6/include/X11/keysymdef.h> and	1090	match if I<at least> the specified identifiers are being set, and no other
		1091	key mappings with those and more bits are being defined. That means that
		1092	defining a mapping for C<a> will automatically provide definitions for
		1093	C<Meta-a>, C<Shift-a> and so on, unless some of those are defined mappings
		1094	themselves. See the C<builtin:> action, below, for a way to work around
		1095	this when this is a problem.
		1096
		1097	The spelling of I<key> depends on your implementation of X. An easy way to
		1098	find a key name is to use the B<xev>(1) command. You can find a list by
		1099	looking for the C<XK_> macros in the B<X11/keysymdef.h> include file (omit
1022	omitting the prefix B<XK_>. Alternatively you can specify I<key> by its hex	1100	the C<XK_> prefix). Alternatively you can specify I<key> by its hex keysym
1023	keysym value (B<0x0000 - 0xFFFF>). Note that the lookup of I<sym>s is not	1101	value (B<0x0000 - 0xFFFF>).
1024	performed in an exact manner; however, the closest match is assured.
1025		1102
1026	I<string> may contain escape values (C<\a>: bell, C<\b>: backspace,	1103	As with any resource value, the I<action> string may contain backslash
1027	C<\e>, C<\E>: escape, C<\n>: newline, C<\r>: carriage return, C<\t>: tab,	1104	escape sequences (C<\n>: newline, C<\\>: backslash, C<\000>: octal
1028	C<\000>: octal number) or verbatim control characters (C<^?>: delete,	1105	number), see RESOURCES in C<man 7 X> for further details.
1029	C<^@>: null, C<^A> ...) and may be enclosed with double quotes so that it
1030	can start or end with whitespace.
1031		1106
1032	Please note that you need to double the C<\> in resource files, as	1107	An action starts with an action prefix that selects a certain type
1033	Xlib itself does its own de-escaping (you can use C<\033> instead of	1108	of action, followed by a colon. An action string without colons is
1034	C<\e> (and so on), which will work with both Xt and @@RXVT_NAME@@'s own	1109	interpreted as a literal string to pass to the tty (as if it was
1035	processing).	1110	prefixed with C<string:>).
1036		1111
1037	You can define a range of keysyms in one shot by providing a I<string>	1112	The following action prefixes are known - extensions can provide
1038	with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimeter `/'	1113	additional prefixes:
		1114
		1115	=over 4
		1116
		1117	=item string:STRING
		1118
		1119	If the I<action> starts with C<string:> (or otherwise contains no colons),
		1120	then the remaining C<STRING> will be passed to the program running in the
		1121	terminal. For example, you could replace whatever Shift-Tab outputs by the
		1122	string C<echo rm -rf /> followed by a newline:
		1123
		1124	URxvt.keysym.Shift-Tab: string:echo rm -rf /\n
		1125
		1126	This could in theory be used to completely redefine your keymap.
		1127
		1128	In addition, for actions of this type, you can define a range of
		1129	keysyms in one shot by loading the C<keysym-list> perl extension and
		1130	providing an I<action> with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where
1039	should be a character not used by the strings.	1131	the delimiter `/' should be a character not used by the strings.
1040		1132
1041	Its usage can be demonstrated by an example:	1133	Its usage can be demonstrated by an example:
1042		1134
1043	URxvt.keysym.M-C-0x61: list|\033<M-C-|abc|>	1135	URxvt.keysym.M-C-0x61: list|\033<|abc|>
1044		1136
1045	The above line is equivalent to the following three lines:	1137	The above line is equivalent to the following three lines:
1046		1138
1047	URxvt.keysym.Meta-Control-0x61: \033<M-C-a>	1139	URxvt.keysym.Meta-Control-0x61: string:\033<a>
1048	URxvt.keysym.Meta-Control-0x62: \033<M-C-b>	1140	URxvt.keysym.Meta-Control-0x62: string:\033<b>
1049	URxvt.keysym.Meta-Control-0x63: \033<M-C-c>	1141	URxvt.keysym.Meta-Control-0x63: string:\033<c>
1050		1142
		1143	=item command:STRING
		1144
1051	If I<string> takes the form of C<command:STRING>, the specified B<STRING>	1145	If I<action> takes the form of C<command:STRING>, the specified B<STRING>
1052	is interpreted and executed as @@RXVT_NAME@@'s control sequence. For	1146	is interpreted and executed as @@RXVT_NAME@@'s control sequence (basically
		1147	the opposite of C<string:> - instead of sending it to the program running
		1148	in the terminal, it will be treated as if it were program output). This is
		1149	most useful to feed command sequences into @@RXVT_NAME@@.
		1150
1053	example the following means "change the current locale to C<zh_CN.GBK>	1151	For example the following means "change the current locale to C<zh_CN.GBK>
1054	when Control-Meta-c is being pressed":	1152	when Control-Meta-c is being pressed":
1055		1153
1056	URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007	1154	URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007
1057		1155
1058	If I<string> takes the form C<perl:STRING>, then the specified B<STRING>	1156	The following example will map Control-Meta-1 and Control-Meta-2 to
1059	is passed to the C<on_keyboard_command> perl handler. See the @@RXVT_NAME@@perl(3)	1157	the fonts C<suxuseuro> and C<9x15bold>, so you can have some limited
1060	manpage. For example, the F<selection> extension (activated via	1158	font-switching at runtime:
1061	C<@@RXVT_NAME@@ -pe selection>) listens for C<selection:rot13> events:
1062		1159
1063	URxvt.keysym.M-C-c: perl:selection:rot13	1160	URxvt.keysym.M-C-1: command:\033]50;suxuseuro\007
		1161	URxvt.keysym.M-C-2: command:\033]50;9x15bold\007
1064		1162
1065	Due the the large number of modifier combinations, a defined key mapping	1163	Other things are possible, e.g. resizing (see @@RXVT_NAME@@(7) for more
1066	will match if at I<at least> the specified identifiers are being set, and	1164	info):
1067	no other key mappings with those and more bits are being defined. That
1068	means that defining a key map for C<a> will automatically provide
1069	definitions for C<Meta-a>, C<Shift-a> and so on, unless some of those are defined
1070	mappings themselves.
1071		1165
1072	Unfortunately, this will override built-in key mappings. For example	1166	URxvt.keysym.M-C-3: command:\033[8;25;80t
		1167	URxvt.keysym.M-C-4: command:\033[8;48;110t
		1168
		1169	=item builtin:
		1170
		1171	The builtin action is the action that @@RXVT_NAME@@ would execute if no
		1172	key binding existed for the key combination. The obvious use is to undo
		1173	the effect of existing bindings. The not so obvious use is to reinstate
		1174	bindings when another binding overrides too many modifiers.
		1175
1073	if you overwrite the C<Insert> key you will disable @@RXVT_NAME@@'s	1176	For example if you overwrite the C<Insert> key you will disable
1074	C<Shift-Insert> mapping. To re-enable that, you can poke "holes" into the	1177	@@RXVT_NAME@@'s C<Shift-Insert> mapping. To re-enable that, you can poke
1075	user-defined keymap using the C<builtin:> replacement:	1178	"holes" into the user-defined keymap using the C<builtin:> replacement:
1076		1179
1077	URxvt.keysym.Insert: <my insert key sequence>	1180	URxvt.keysym.Insert: <my insert key sequence>
1078	URxvt.keysym.S-Insert: builtin:	1181	URxvt.keysym.S-Insert: builtin:
1079		1182
1080	The first line defines a mapping for C<Insert> and I<any> combination	1183	The first line defines a mapping for C<Insert> and I<any> combination
1081	of modifiers. The second line re-establishes the default mapping for	1184	of modifiers. The second line re-establishes the default mapping for
1082	C<Shift-Insert>.	1185	C<Shift-Insert>.
1083		1186
1084	The following example will map Control-Meta-1 and Control-Meta-2 to	1187	=item builtin-string:
1085	the fonts C<suxuseuro> and C<9x15bold>, so you can have some limited
1086	font-switching at runtime:
1087		1188
1088	URxvt.keysym.M-C-1: command:\033]50;suxuseuro\007	1189	This action is mainly useful to restore string mappings for keys that
1089	URxvt.keysym.M-C-2: command:\033]50;9x15bold\007	1190	have predefined actions in @@RXVT_NAME@@. The exact semantics are a bit
		1191	difficult to explain - basically, this action will send the string to the
		1192	application that would be sent if @@RXVT_NAME@@ wouldn't have a built-in
		1193	action for it.
1090		1194
1091	Other things are possible, e.g. resizing (see @@RXVT_NAME@@(7) for more	1195	An example might make it clearer: @@RXVT_NAME@@ normally pastes the
1092	info):	1196	selection when you press C<Shift-Insert>. With the following bindings, it
		1197	would instead emit the (undocumented, but what applications running in the
		1198	terminal might expect) sequence C<ESC [ 2 $> instead:
1093		1199
1094	URxvt.keysym.M-C-3: command:\033[8;25;80t	1200	URxvt.keysym.S-Insert: builtin-string:
1095	URxvt.keysym.M-C-4: command:\033[8;48;110t	1201	URxvt.keysym.C-S-Insert: builtin:
		1202
		1203	The first line disables the paste functionality for that key
		1204	combination, and the second reinstates the default behaviour for
		1205	C<Control-Shift-Insert>, which would otherwise be overridden.
		1206
		1207	Similarly, to let applications gain access to the C<C-M-c> (copy to
		1208	clipboard) and C<C-M-v> (paste clipboard) key combination, you can do
		1209	this:
		1210
		1211	URxvt.keysym.C-M-c: builtin-string:
		1212	URxvt.keysym.C-M-v: builtin-string:
		1213
		1214	=item EXTENSION:STRING
		1215
		1216	An action of this form invokes the action B<STRING>, if any, provided
		1217	by the @@RXVT_NAME@@perl(3) extension B<EXTENSION>. The extension will
		1218	be loaded automatically if necessary.
		1219
		1220	Not all extensions define actions, but popular extensions that do
		1221	include the I<selection> and I<matcher> extensions (documented in their
		1222	own manpages, @@RXVT_NAME@@-selection(1) and @@RXVT_NAME@@-matcher(1),
		1223	respectively).
		1224
		1225	From the silly examples department, this will rot13-"encrypt"
		1226	@@RXVT_NAME@@'s selection when Alt-Control-c is pressed on typical PC
		1227	keyboards:
		1228
		1229	URxvt.keysym.M-C-c: selection:rot13
		1230
		1231	=item perl:STRING *DEPRECATED*
		1232
		1233	This is a deprecated way of invoking commands provided by perl
		1234	extensions. It is still supported, but should not be used anymore.
		1235
		1236	=back
1096		1237
1097	=item B<perl-ext-common>: I<string>	1238	=item B<perl-ext-common>: I<string>
1098		1239
1099	=item B<perl-ext>: I<string>	1240	=item B<perl-ext>: I<string>
1100		1241
…		…
1102	use in this terminal instance; option B<-pe>.	1243	use in this terminal instance; option B<-pe>.
1103		1244
1104	Extension names can be prefixed with a C<-> sign to prohibit using	1245	Extension names can be prefixed with a C<-> sign to prohibit using
1105	them. This can be useful to selectively disable some extensions loaded	1246	them. This can be useful to selectively disable some extensions loaded
1106	by default, or specified via the C<perl-ext-common> resource. For	1247	by default, or specified via the C<perl-ext-common> resource. For
1107	example, C<default,-selection> will use all the default extension except	1248	example, C<default,-selection> will use all the default extensions except
1108	C<selection>.	1249	C<selection>.
1109		1250
1110	Extension names can also be followed by an argument in angle brackets	1251	The default set includes the C<selection>, C<option-popup>,
1111	(e.g. C<< searchable-scrollback<M-s> >>, which binds the hotkey for	1252	C<selection-popup>, C<readline> and C<searchable-scrollback>
1112	searchable scorllback to Alt/Meta-s). Mentioning the same extension	1253	extensions, and extensions which are mentioned in B<keysym> resources.
1113	multiple times with different arguments will pass multiple arguments to	1254
1114	the extension.	1255	Any extension such that a corresponding resource is given on the
		1256	command line is automatically appended to B<perl-ext>.
1115		1257
1116	Each extension is looked up in the library directories, loaded if	1258	Each extension is looked up in the library directories, loaded if
1117	necessary, and bound to the current terminal instance.	1259	necessary, and bound to the current terminal instance. When the library
		1260	search path contains multiple extension files of the same name, then the
		1261	first one found will be used.
1118		1262
1119	If both of these resources are the empty string, then the perl	1263	If both of these resources are the empty string, then the perl interpreter
1120	interpreter will not be initialized. The idea behind two options is that	1264	will not be initialized. The rationale for having two options is that
1121	B<perl-ext-common> will be used for extensions that should be available to	1265	B<perl-ext-common> will be used for extensions that should be available to
1122	all instances, while B<perl-ext> is used for specific instances.	1266	all instances, while B<perl-ext> is used for specific instances.
1123		1267
1124	=item B<perl-eval>: I<string>	1268	=item B<perl-eval>: I<string>
1125		1269
1126	Perl code to be evaluated when all extensions have been registered. See	1270	Perl code to be evaluated when all extensions have been registered. See
1127	the @@RXVT_NAME@@perl(3) manpage. Due to security reasons, this resource	1271	the @@RXVT_NAME@@perl(3) manpage.
1128	will be ignored when running setuid/setgid.
1129		1272
1130	=item B<perl-lib>: I<path>	1273	=item B<perl-lib>: I<path>
1131		1274
1132	Colon-separated list of additional directories that hold extension	1275	Colon-separated list of additional directories that hold extension
1133	scripts. When looking for extensions specified by the C<perl> resource,	1276	scripts. When looking for perl extensions, @@RXVT_NAME@@ will first look
1134	@@RXVT_NAME@@ will first look in these directories and then in	1277	in these directories, then in C<$URXVT_PERL_LIB>, F<$HOME/.urxvt/ext> and
1135	F<@@RXVT_LIBDIR@@/urxvt/perl/>. Due to security reasons, this resource	1278	lastly in F<@@RXVT_LIBDIR@@/urxvt/perl/>.
1136	will be ignored when running setuid/setgid.
1137		1279
1138	See the @@RXVT_NAME@@perl(3) manpage.	1280	See the @@RXVT_NAME@@perl(3) manpage.
1139		1281
1140	=item B<< selection.pattern-I<idx> >>: I<perl-regex>	1282	=item B<< selection.pattern-I<idx> >>: I<perl-regex>
1141		1283
…		…
1145	=item B<< selection-autotransform.I<idx> >>: I<perl-transform>	1287	=item B<< selection-autotransform.I<idx> >>: I<perl-transform>
1146		1288
1147	Selection auto-transform patterns, see the @@RXVT_NAME@@perl(3) manpage	1289	Selection auto-transform patterns, see the @@RXVT_NAME@@perl(3) manpage
1148	for details.	1290	for details.
1149		1291
1150	=item B<searchable-scrollback:> I<keysym>	1292	=item B<searchable-scrollback:> I<keysym> *DEPRECATED*
1151		1293
1152	Sets the hotkey that starts the incremental scrollback buffer search	1294	This resource is deprecated and will be removed. Use a B<keysym> resource
1153	(default: C<M-s>).	1295	instead, e.g.:
1154		1296
		1297	URxvt.keysym.M-s: searchable-scrollback:start
		1298
1155	=item B<urlLauncher>: I<string>	1299	=item B<url-launcher>: I<string>
1156		1300
1157	Specifies the program to be started with a URL argument. Used by the	1301	Specifies the program to be started with a URL argument. Used by the
1158	C<selection-popup> and C<mark-urls> perl extensions.	1302	C<selection-popup> and C<matcher> perl extensions.
1159		1303
1160	=item B<transient-for>: I<windowid>	1304	=item B<transient-for>: I<windowid>
1161		1305
1162	Compile I<frills>: Sets the WM_TRANSIENT_FOR property to the given window id.	1306	Compile I<frills>: Sets the WM_TRANSIENT_FOR property to the given window id.
1163		1307
1164	=item B<override-redirect>: I<boolean>	1308	=item B<override-redirect>: I<boolean>
1165		1309
1166	Compile I<frills>: Sets override-redirect for the terminal window, making	1310	Compile I<frills>: Sets override-redirect for the terminal window, making
1167	it almost invisible to window managers; option B<-override-redirect>.	1311	it almost invisible to window managers; option B<-override-redirect>.
		1312
		1313	=item B<iso14755:> I<boolean>
		1314
		1315	Turn on/off ISO 14755 (default enabled).
		1316
		1317	=item B<iso14755_52:> I<boolean>
		1318
		1319	Turn on/off ISO 14755 5.2 mode (default enabled).
		1320
		1321	=back
		1322
		1323	=head1 BACKGROUND IMAGE OPTIONS AND RESOURCES
		1324
		1325	=over 4
		1326
		1327	=item B<-pixmap> I<file[;oplist]>
		1328
		1329	=item B<backgroundPixmap:> I<file[;oplist]>
		1330
		1331	Compile I<pixbuf>: Use the specified image file as the window's
		1332	background and also optionally specify a colon separated list of
		1333	operations to modify it. Note that you may need to quote the C<;>
		1334	character when using the command line option, as C<;> is usually a
		1335	metacharacter in shells. Supported operations are:
		1336
		1337	=over 4
		1338
		1339	=item B<WxH+X+Y>
		1340
		1341	sets scale and position. B<"W" / "H"> specify the horizontal/vertical
		1342	scale (percent), and B<"X" / "Y"> locate the image centre (percent). A
		1343	scale of 0 disables scaling.
		1344
		1345	=item B<op=tile>
		1346
		1347	enables tiling
		1348
		1349	=item B<op=keep-aspect>
		1350
		1351	maintain the image aspect ratio when scaling
		1352
		1353	=item B<op=root-align>
		1354
		1355	use the position of the terminal window relative to the root window as
		1356	the image offset, simulating a root window background
		1357
		1358	=back
		1359
		1360	The default scale and position setting is C<100x100+50+50>.
		1361	Alternatively, a predefined set of templates can be used to achieve
		1362	the most common setups:
		1363
		1364	=over 4
		1365
		1366	=item B<style=tiled>
		1367
		1368	the image is tiled with no scaling. Equivalent to 0x0+0+0:op=tile
		1369
		1370	=item B<style=aspect-stretched>
		1371
		1372	the image is scaled to fill the whole window maintaining the aspect
		1373	ratio and centered. Equivalent to 100x100+50+50:op=keep-aspect
		1374
		1375	=item B<style=stretched>
		1376
		1377	the image is scaled to fill the whole window. Equivalent to 100x100
		1378
		1379	=item B<style=centered>
		1380
		1381	the image is centered with no scaling. Equivalent to 0x0+50+50
		1382
		1383	=item B<style=root-tiled>
		1384
		1385	the image is tiled with no scaling and using 'root' positioning.
		1386	Equivalent to 0x0:op=tile:op=root-align
		1387
		1388	=back
		1389
		1390	If multiple templates are specified the last one wins. Note that a
		1391	template overrides all the scale, position and operations settings.
		1392
		1393	If used in conjunction with pseudo-transparency, the specified pixmap
		1394	will be blended over the transparent background using alpha-blending.
		1395
		1396	=item B<-tr>|B<+tr>
		1397
		1398	=item B<transparent:> I<boolean>
		1399
		1400	Turn on/off pseudo-transparency by using the root pixmap as background.
		1401
		1402	B<-ip> (B<inheritPixmap>) is still accepted as an obsolete alias but
		1403	will be removed in future versions.
		1404
		1405	=item B<-tint> I<colour>
		1406
		1407	=item B<tintColor:> I<colour>
		1408
		1409	Tint the transparent background with the given colour. Note that a
		1410	black tint yields a completely black image while a white tint yields
		1411	the image unchanged.
		1412
		1413	=item B<-sh> I<number>
		1414
		1415	=item B<shading:> I<number>
		1416
		1417	Darken (0 .. 99) or lighten (101 .. 200) the transparent background.
		1418	A value of 100 means no shading.
		1419
		1420	=item B<-blr> I<HxV>
		1421
		1422	=item B<blurRadius:> I<HxV>
		1423
		1424	Apply gaussian blur with the specified radius to the transparent
		1425	background. If a single number is specified, the vertical and
		1426	horizontal radii are considered to be the same. Setting one of the
		1427	radii to 1 and the other to a large number creates interesting effects
		1428	on some backgrounds. The maximum radius value is 128. An horizontal or
		1429	vertical radius of 0 disables blurring.
		1430
		1431	=item B<path:> I<path>
		1432
		1433	Specify the colon-delimited search path for finding background image files.
1168		1434
1169	=back	1435	=back
1170		1436
1171	=head1 THE SCROLLBAR	1437	=head1 THE SCROLLBAR
1172		1438
…		…
1191	application. Instead, pressing Button1 and Button3 sends B<ESC [ 6 ~>	1457	application. Instead, pressing Button1 and Button3 sends B<ESC [ 6 ~>
1192	(Next) and B<ESC [ 5 ~> (Prior), respectively. Similarly, clicking on the	1458	(Next) and B<ESC [ 5 ~> (Prior), respectively. Similarly, clicking on the
1193	up and down arrows sends B<ESC [ A> (Up) and B<ESC [ B> (Down),	1459	up and down arrows sends B<ESC [ A> (Up) and B<ESC [ B> (Down),
1194	respectively.	1460	respectively.
1195		1461
1196	=head1 TEXT SELECTION AND INSERTION	1462	=head1 THE SELECTION: SELECTING AND PASTING TEXT
1197		1463
1198	The behaviour of text selection and insertion mechanism is similar to	1464	The behaviour of text selection and insertion/pasting mechanism is similar
1199	I<xterm>(1).	1465	to I<xterm>(1).
1200		1466
1201	=over 4	1467	=over 4
1202		1468
1203	=item B<Selection>:	1469	=item B<Selecting>:
1204		1470
1205	Left click at the beginning of the region, drag to the end of the region	1471	Left click at the beginning of the region, drag to the end of the region
1206	and release; Right click to extend the marked region; Left double-click	1472	and release; Right click to extend the marked region; Left double-click
1207	to select a word; Left triple-click to select the entire logical line	1473	to select a word; Left triple-click to select the entire logical line
1208	(which can span multiple screen lines), unless modified by resource	1474	(which can span multiple screen lines), unless modified by resource
…		…
1212	(Compile: I<frills>) will create a rectangular selection instead of a	1478	(Compile: I<frills>) will create a rectangular selection instead of a
1213	normal one. In this mode, every selected row becomes its own line in the	1479	normal one. In this mode, every selected row becomes its own line in the
1214	selection, and trailing whitespace is visually underlined and removed from	1480	selection, and trailing whitespace is visually underlined and removed from
1215	the selection.	1481	the selection.
1216		1482
1217	=item B<Insertion>:	1483	=item B<Pasting>:
1218		1484
1219	Pressing and releasing the Middle mouse button in an B<@@RXVT_NAME@@>	1485	Pressing and releasing the Middle mouse button in an B<@@RXVT_NAME@@>
1220	window causes the value of the PRIMARY selection (or CLIPBOARD with the	1486	window causes the value of the PRIMARY selection (or CLIPBOARD with the
1221	Meta modifier) to be inserted as if it had been typed on the keyboard.	1487	B<Meta> modifier) to be inserted as if it had been typed on the keyboard.
1222		1488
1223	Pressing B<Shift-Insert> causes the value of the PRIMARY selection to be	1489	Pressing B<Shift-Insert> causes the value of the PRIMARY selection to be
1224	inserted too.	1490	inserted too.
1225		1491
		1492	rxvt-unicode also provides the bindings B<Ctrl-Meta-c> and
		1493	<Ctrl-Meta-v> to interact with the CLIPBOARD selection. The first
		1494	binding causes the value of the internal selection to be copied to the
		1495	CLIPBOARD selection, while the second binding causes the value of the
		1496	CLIPBOARD selection to be inserted.
		1497
1226	=back	1498	=back
1227		1499
1228	=head1 CHANGING FONTS	1500	=head1 CHANGING FONTS
1229		1501
1230	Changing fonts (or font sizes, respectively) via the keypad is not yet	1502	Changing fonts (or font sizes, respectively) via the keypad is not yet
…		…
1243		1515
1244	=head1 ISO 14755 SUPPORT	1516	=head1 ISO 14755 SUPPORT
1245		1517
1246	ISO 14755 is a standard for entering and viewing unicode characters	1518	ISO 14755 is a standard for entering and viewing unicode characters
1247	and character codes using the keyboard. It consists of 4 parts. The	1519	and character codes using the keyboard. It consists of 4 parts. The
1248	first part is available rxvt-unicode has been compiled with	1520	first part is available if rxvt-unicode has been compiled with
1249	C<--enable-frills>, the rest is available when rxvt-unicode was compiled	1521	C<--enable-frills>, the rest is available when rxvt-unicode was compiled
1250	with C<--enable-iso14755>.	1522	with C<--enable-iso14755>.
1251		1523
1252	=over 4	1524	=over 4
1253		1525
…		…
1311	B<@@RXVT_NAME@@> tries to write an entry into the I<utmp>(5) file so that	1583	B<@@RXVT_NAME@@> tries to write an entry into the I<utmp>(5) file so that
1312	it can be seen via the I<who(1)> command, and can accept messages. To	1584	it can be seen via the I<who(1)> command, and can accept messages. To
1313	allow this feature, B<@@RXVT_NAME@@> may need to be installed setuid root	1585	allow this feature, B<@@RXVT_NAME@@> may need to be installed setuid root
1314	on some systems or setgid to root or to some other group on others.	1586	on some systems or setgid to root or to some other group on others.
1315		1587
1316	=head1 COLORS AND GRAPHICS	1588	=head1 COLOURS AND GRAPHICS
1317		1589
1318	In addition to the default foreground and background colours,	1590	In addition to the default foreground and background colours,
1319	B<@@RXVT_NAME@@> can display up to 16 colours (8 ANSI colours plus	1591	B<@@RXVT_NAME@@> can display up to 88/256 colours: 8 ANSI colours plus
1320	high-intensity bold/blink versions of the same). Here is a list of the	1592	high-intensity (potentially bold/blink) versions of the same, and 72 (or
1321	colours with their names.	1593	240 in 256 colour mode) colours arranged in an 4x4x4 (or 6x6x6) colour RGB
		1594	cube plus a 8 (24) colour greyscale ramp.
		1595
		1596	Here is a list of the ANSI colours with their names.
1322		1597
1323	=begin table	1598	=begin table
1324		1599
1325	B<color0> (black) = Black	1600	B<color0> (black) = Black
1326	B<color1> (red) = Red3	1601	B<color1> (red) = Red3
…		…
1346	It is also possible to specify the colour values of B<foreground>,	1621	It is also possible to specify the colour values of B<foreground>,
1347	B<background>, B<cursorColor>, B<cursorColor2>, B<colorBD>, B<colorUL> as	1622	B<background>, B<cursorColor>, B<cursorColor2>, B<colorBD>, B<colorUL> as
1348	a number 0-15, as a convenient shorthand to reference the colour name of	1623	a number 0-15, as a convenient shorthand to reference the colour name of
1349	color0-color15.	1624	color0-color15.
1350		1625
1351	In addition to the colours defined above, @@RXVT_NAME@@ offers an	1626	The following text gives values for the standard 88 colour mode (and
1352	additional 72 colours. The first 64 of those (with indices 16 to 79)	1627	values for the 256 colour mode in parentheses).
1353	consist of a 4*4*4 RGB colour cube (i.e. I<index = r * 16 + g * 4 + b +
1354	16>), followed by 8 additional shades of gray (with indices 80 to 87).
1355		1628
		1629	The RGB cube uses indices 16..79 (16..231) using the following formulas:
		1630
		1631	index_88 = (r * 4 + g) * 4 + b + 16 # r, g, b = 0..3
		1632	index_256 = (r * 6 + g) * 6 + b + 16 # r, g, b = 0..5
		1633
		1634	The grayscale ramp uses indices 80..87 (232..239), from 10% to 90% in 10%
		1635	steps (1/26 to 25/26 in 1/26 steps) - black and white are already part of
		1636	the RGB cube.
		1637
1356	Together, all those colours implement the 88 colour xterm colours. Only	1638	Together, all those colours implement the 88 (256) colour xterm
1357	the first 16 can be changed using resources currently, the rest can only	1639	colours. Only the first 16 can be changed using resources currently, the
1358	be changed via command sequences ("escape codes").	1640	rest can only be changed via command sequences ("escape codes").
		1641
		1642	Applications are advised to use terminfo or command sequences to discover
		1643	number and RGB values of all colours (yes, you can query this...).
1359		1644
1360	Note that B<-rv> (B<"reverseVideo: True">) simulates reverse video by	1645	Note that B<-rv> (B<"reverseVideo: True">) simulates reverse video by
1361	always swapping the foreground/background colours. This is in contrast to	1646	always swapping the foreground/background colours. This is in contrast to
1362	I<xterm>(1) where the colours are only swapped if they have not otherwise	1647	I<xterm>(1) where the colours are only swapped if they have not otherwise
1363	been specified. For example,	1648	been specified. For example,
1364		1649
		1650	@@RXVT_NAME@@ -fg Black -bg White -rv
		1651
		1652	would yield White on Black, while on I<xterm>(1) it would yield Black on
		1653	White.
		1654
		1655	=head2 ALPHA CHANNEL SUPPORT
		1656
		1657	If Xft support has been compiled in and as long as Xft/Xrender/X don't get
		1658	their act together, rxvt-unicode will do its own alpha channel management:
		1659
		1660	You can prefix any colour with an opaqueness percentage enclosed in
		1661	brackets, i.e. C<[percent]>, where C<percent> is a decimal percentage
		1662	(0-100) that specifies the opacity of the colour, where C<0> is completely
		1663	transparent and C<100> is completely opaque. For example, C<[50]red> is a
		1664	half-transparent red, while C<[95]#00ff00> is an almost opaque green. This
		1665	is the recommended format to specify transparency values, and works with
		1666	all ways to specify a colour.
		1667
		1668	For complete control, rxvt-unicode also supports
		1669	C<rgba:rrrr/gggg/bbbb/aaaa> (exactly four hex digits/component) colour
		1670	specifications, where the additional C<aaaa> component specifies opacity
		1671	(alpha) values. The minimum value of C<0000> is completely transparent,
		1672	while C<ffff> is completely opaque). The two example colours from
		1673	earlier could also be specified as C<rgba:ff00/0000/0000/8000> and
		1674	C<rgba:0000/ff00/0000/f332>.
		1675
		1676	You probably need to specify B<"-depth 32">, too, to force a visual with
		1677	alpha channels, and have the luck that your X-server uses ARGB pixel
		1678	layout, as X is far from just supporting ARGB visuals out of the box, and
		1679	rxvt-unicode just fudges around.
		1680
		1681	For example, the following selects an almost completely transparent black
		1682	background, and an almost opaque pink foreground:
		1683
		1684	@@RXVT_NAME@@ -depth 32 -bg rgba:0000/0000/0000/4444 -fg "[80]pink"
		1685
		1686	When not using a background image, then the interpretation of the
		1687	alpha channel is up to your compositing manager (most interpret it as
		1688	transparency of course).
		1689
		1690	When using a background pixmap or pseudo-transparency, then the background
		1691	colour will always behave as if it were completely transparent (so the
		1692	background image shows instead), regardless of how it was specified, while
		1693	other colours will either be transparent as specified (the background
		1694	image will show through) on servers supporting the RENDER extension, or
		1695	fully opaque on servers not supporting the RENDER EXTENSION.
		1696
		1697	Please note that due to bugs in Xft, specifying alpha values might result
		1698	in garbage being displayed when the X-server does not support the RENDER
		1699	extension.
		1700
		1701	=head1 ENVIRONMENT
		1702
		1703	B<@@RXVT_NAME@@> sets and/or uses the following environment variables:
		1704
1365	=over 4	1705	=over 4
1366		1706
1367	=item B<@@RXVT_NAME@@ -fg Black -bg White -rv>
1368
1369	would yield White on Black, while on I<xterm>(1) it would yield Black
1370	on White.
1371
1372	=back
1373
1374	=head2 ALPHA CHANNEL SUPPORT
1375
1376	If Xft support has been compiled in and as long as Xft/Xrender/X don't get
1377	their act together, rxvt-unicode will support C<rgba:rrrr/gggg/bbbb/aaaa>
1378	(recommended, but B<MUST> have 4 digits/component) colour specifications,
1379	in addition to the ones provided by X, where the additional A component
1380	specifies opacity (alpha) values. The minimum value of C<0> is completely
1381	transparent). You can also prefix any color with C<[a]>, where C<a> is on
1382	to four hex digits specifiying the opacity value.
1383
1384	You probably need to specify B<"-depth 32">, too, and have the luck that
1385	your X-server uses ARGB pixel layout, as X is far from just supporting
1386	ARGB visuals out of the box, and rxvt-unicode just fudges around.
1387
1388	For example, the following selects an almost completely transparent red
1389	background, and an almost opaque pink foreground:
1390
1391	@@RXVT_NAME@@ -depth 32 -bg rgba:0000/0000/0000/2222 -fg "[e]pink"
1392
1393	I<Please note that transparency of any kind if completely unsupported by
1394	the author. Don't bug him with installation questions!>
1395
1396	=head1 ENVIRONMENT
1397
1398	B<@@RXVT_NAME@@> sets and/or uses the following environment variables:
1399
1400	=over 4
1401
1402	=item B<TERM>	1707	=item B<TERM>
1403		1708
1404	Normally set to C<rxvt-unicode>, unless overwritten at configure time, via	1709	Normally set to C<rxvt-unicode>, unless overwritten at configure time, via
1405	resources or on the commandline.	1710	resources or on the command line.
1406		1711
1407	=item B<COLORTERM>	1712	=item B<COLORTERM>
1408		1713
1409	Either C<rxvt>, C<rxvt-xpm>, depending on wether @@RXVT_NAME@@ was	1714	Either C<rxvt>, C<rxvt-xpm>, depending on whether @@RXVT_NAME@@ was
1410	compiled with XPM support, and optionally with the added extension	1715	compiled with background image support, and optionally with the added
1411	C<-mono> to indicate that rxvt-unicode runs on a monochrome screen.	1716	extension C<-mono> to indicate that rxvt-unicode runs on a monochrome
		1717	screen.
1412		1718
1413	=item B<COLORFGBG>	1719	=item B<COLORFGBG>
1414		1720
1415	Set to a string of the form C<fg;bg> or C<fg;xpm;bg>, where C<fg> is	1721	Set to a string of the form C<fg;bg> or C<fg;xpm;bg>, where C<fg> is
1416	the colour code used as default foreground/text colour (or the string	1722	the colour code used as default foreground/text colour (or the string
1417	C<default> to indicate that the default-colour escape sequence is to be	1723	C<default> to indicate that the default-colour escape sequence is to be
1418	used), C<bg> is the colour code used as default background colour (or the	1724	used), C<bg> is the colour code used as default background colour (or the
1419	string C<default>), and C<xpm> is the string C<default> if @@RXVT_NAME@@	1725	string C<default>), and C<xpm> is the string C<default> if @@RXVT_NAME@@
1420	was compiled with XPM support. Libraries like C<ncurses> and C<slang> can	1726	was compiled with background image support. Libraries like C<ncurses>
1421	(and do) use this information to optimize screen output.	1727	and C<slang> can (and do) use this information to optimize screen output.
1422		1728
1423	=item B<WINDOWID>	1729	=item B<WINDOWID>
1424		1730
1425	Set to the (decimal) X Window ID of the @@RXVT_NAME@@ window (the toplevel	1731	Set to the (decimal) X Window ID of the @@RXVT_NAME@@ window (the toplevel
1426	window, which usually has subwindows for the scrollbar, the terminal	1732	window, which usually has subwindows for the scrollbar, the terminal
…		…
1432	C<--with-terminfo=PATH>.	1738	C<--with-terminfo=PATH>.
1433		1739
1434	=item B<DISPLAY>	1740	=item B<DISPLAY>
1435		1741
1436	Used by @@RXVT_NAME@@ to connect to the display and set to the correct	1742	Used by @@RXVT_NAME@@ to connect to the display and set to the correct
1437	display in its child processes.	1743	display in its child processes if C<-display> isn't used to override. It
		1744	defaults to C<:0> if it doesn't exist.
1438		1745
1439	=item B<SHELL>	1746	=item B<SHELL>
1440		1747
1441	The shell to be used for command execution, defaults to C</bin/sh>.	1748	The shell to be used for command execution, defaults to C</bin/sh>.
1442		1749
1443	=item B<RXVT_SOCKET>	1750	=item B<RXVT_SOCKET> [I<sic>]
1444		1751
1445	The unix domain socket path used by @@RXVT_NAME@@c(1) and	1752	The unix domain socket path used by @@RXVT_NAME@@c(1) and
1446	@@RXVT_NAME@@d(1).	1753	@@RXVT_NAME@@d(1).
1447		1754
1448	Default F<<< $HOME/.rxvt-unicode-I<< <nodename >> >>>.	1755	Default F<<< $HOME/.urxvt/urxvtd-I<< <nodename> >> >>>.
		1756
		1757	=item B<URXVT_PERL_LIB>
		1758
		1759	Additional F<:>-separated library search path for perl extensions. Will be
		1760	searched after B<-perl-lib> but before F<~/.urxvt/ext> and the system library
		1761	directory.
		1762
		1763	=item B<URXVT_PERL_VERBOSITY>
		1764
		1765	See L<@@RXVT_NAME@@perl>(3).
1449		1766
1450	=item B<HOME>	1767	=item B<HOME>
1451		1768
1452	Used to locate the default directory for the unix domain socket for	1769	Used to locate the default directory for the unix domain socket for
1453	daemon communications and to locate various resource files (such as	1770	daemon communications and to locate various resource files (such as
1454	C<.Xdefaults>)	1771	C<.Xdefaults>)
1455		1772
1456	=item B<XAPPLRESDIR>	1773	=item B<XAPPLRESDIR>
1457		1774
1458	Directory where various X resource files are being located.	1775	Directory where application-specific X resource files are located.
1459		1776
1460	=item B<XENVIRONMENT>	1777	=item B<XENVIRONMENT>
1461		1778
1462	If set and accessible, gives the name of a X resource file to be loaded by	1779	If set and accessible, gives the name of a X resource file to be loaded by
1463	@@RXVT_NAME@@.	1780	@@RXVT_NAME@@.
…		…
1468		1785
1469	=over 4	1786	=over 4
1470		1787
1471	=item B</usr/lib/X11/rgb.txt>	1788	=item B</usr/lib/X11/rgb.txt>
1472		1789
1473	Color names.	1790	Colour names.
1474		1791
1475	=back	1792	=back
1476		1793
1477	=head1 SEE ALSO	1794	=head1 SEE ALSO
1478		1795
		1796	@@RXVT_NAME@@(7), @@RXVT_NAME@@c(1), @@RXVT_NAME@@d(1), @@RXVT_NAME@@-extensions(1),
1479	@@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)	1797	@@RXVT_NAME@@perl(3), xterm(1), sh(1), resize(1), X(1), pty(4), tty(4), utmp(5)
1480		1798
1481	=head1 CURRENT PROJECT COORDINATOR	1799	=head1 CURRENT PROJECT COORDINATOR
1482		1800
1483	=over 4	1801	=over 4
1484		1802
1485	=item Project Coordinator	1803	=item Project Coordinator
1486		1804
1487	Marc A. Lehmann L<< <rxvt-unicode@schmorp.de> >>	1805	Marc A. Lehmann <rxvt-unicode@schmorp.de>.
1488		1806
1489	L<http://software.schmorp.de/pkg/rxvt-unicode.html>	1807	L<http://software.schmorp.de/pkg/rxvt-unicode.html>
1490		1808
1491	=back	1809	=back
1492		1810
…		…
1496		1814
1497	=item John Bovey	1815	=item John Bovey
1498		1816
1499	University of Kent, 1992, wrote the original Xvt.	1817	University of Kent, 1992, wrote the original Xvt.
1500		1818
1501	=item Rob Nation L<< <nation@rocket.sanders.lockheed.com> >>	1819	=item Rob Nation <nation@rocket.sanders.lockheed.com>
1502		1820
1503	very heavily modified Xvt and came up with Rxvt	1821	very heavily modified Xvt and came up with Rxvt
1504		1822
1505	=item Angelo Haritsis L<< <ah@doc.ic.ac.uk> >>	1823	=item Angelo Haritsis <ah@doc.ic.ac.uk>
1506		1824
1507	wrote the Greek Keyboard Input (no longer in code)	1825	wrote the Greek Keyboard Input (no longer in code)
1508		1826
1509	=item mj olesen L<< <olesen@me.QueensU.CA> >>	1827	=item mj olesen <olesen@me.QueensU.CA>
1510		1828
1511	Wrote the menu system.	1829	Wrote the menu system.
1512		1830
1513	Project Coordinator (changes.txt 2.11 to 2.21)	1831	Project Coordinator (changes.txt 2.11 to 2.21)
1514		1832
1515	=item Oezguer Kesim L<< <kesim@math.fu-berlin.de> >>	1833	=item Oezguer Kesim <kesim@math.fu-berlin.de>
1516		1834
1517	Project Coordinator (changes.txt 2.21a to 2.4.5)	1835	Project Coordinator (changes.txt 2.21a to 2.4.5)
1518		1836
1519	=item Geoff Wing L<< <gcw@pobox.com> >>	1837	=item Geoff Wing <gcw@pobox.com>
1520		1838
1521	Rewrote screen display and text selection routines.	1839	Rewrote screen display and text selection routines.
1522		1840
1523	Project Coordinator (changes.txt 2.4.6 - rxvt-unicode)	1841	Project Coordinator (changes.txt 2.4.6 - rxvt-unicode)
1524		1842
1525	=item Marc Alexander Lehmann L<< <rxvt-unicode@schmorp.de> >>	1843	=item Marc Alexander Lehmann <rxvt-unicode@schmorp.de>
1526		1844
1527	Forked rxvt-unicode, unicode support, rewrote almost all the code, perl	1845	Forked rxvt-unicode, unicode support, rewrote almost all the code, perl
1528	extension, random hacks, numerous bugfixes and extensions.	1846	extension, random hacks, numerous bugfixes and extensions.
1529		1847
1530	Project Coordinator (Changes 1.0 -)	1848	Project Coordinator (Changes 1.0 -)
1531		1849
1532	=item Emanuele Giaquinta L<< <e.giaquinta@glauco.it> >>	1850	=item Emanuele Giaquinta <emanuele.giaquinta@gmail.com>
1533		1851
1534	Pty/tty/utmp/wtmp rewrite, lots of random hacking and bugfixing.	1852	pty/utmp code rewrite, image code improvements, many random hacks and bugfixes.
1535		1853
1536	=back	1854	=back
1537		1855

Diff Legend

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