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

Diff Legend

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