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

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents):
Revision 1.109 by root, Sun Jan 29 22:27:04 2006 UTC vs.
Revision 1.232 by root, Sun May 18 18:19:10 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
46	display characters: The idea of a single unicode font which many other	49	display characters: The idea of a single unicode font which many other
47	programs force onto it's 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	it's 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 it's 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
58	a client/daemon pair that lets you open any number of terminal windows	61	a client/daemon pair that lets you open any number of terminal windows
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		131
120	=item B<-fade> I<number>	132	=item B<-fade> I<number>
121		133
122	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
123	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
124	colour; resource B<fading>.	136	colour; resource B<fading>.
125		137
126	=item B<-fadecolor> I<colour>	138	=item B<-fadecolor> I<colour>
127		139
128	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
129	is black. resource B<fadeColor>.	141	is opaque black. resource B<fadeColor>.
130		142
131	=item B<-tint> I<colour>	143	=item B<-icon> I<file>
132		144
133	Tint the transparent background pixmap with the given colour when	145	Compile I<pixbuf>: Use the specified image as application icon. This
134	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
135	non-tiled backgrounds, currently. See also the B<-sh> option that can be	147	application window; resource I<iconFile>.
136	used to brighten or darken the image in addition to tinting it; resource
137	I<tintColor>. Example:
138
139	@@RXVT_NAME@@ -tr -tint blue -sh 40
140
141	=item B<-sh>
142
143	I<number> Darken (0 .. 100) or lighten (-1 .. -100) the transparent
144	background image in addition to tinting it (i.e. B<-tint> must be
145	specified, too, e.g. C<-tint white>).
146		148
147	=item B<-bg> I<colour>	149	=item B<-bg> I<colour>
148		150
149	Window background colour; resource B<background>.	151	Window background colour; resource B<background>.
150		152
151	=item B<-fg> I<colour>	153	=item B<-fg> I<colour>
152		154
153	Window foreground colour; resource B<foreground>.	155	Window foreground colour; resource B<foreground>.
154
155	=item B<-pixmap> I<file[;geom]>
156
157	Compile I<XPM>: Specify XPM file for the background and also optionally
158	specify its scaling with a geometry string. Note you may need to
159	add quotes to avoid special shell interpretation of the C<;> in the
160	command-line; resource B<backgroundPixmap>.
161		156
162	=item B<-cr> I<colour>	157	=item B<-cr> I<colour>
163		158
164	The cursor colour; resource B<cursorColor>.	159	The cursor colour; resource B<cursorColor>.
165		160
…		…
182	that are checked in order when trying to find glyphs for characters. The	177	that are checked in order when trying to find glyphs for characters. The
183	first font defines the cell size for characters; other fonts might be	178	first font defines the cell size for characters; other fonts might be
184	smaller, but not (in general) larger. A (hopefully) reasonable default	179	smaller, but not (in general) larger. A (hopefully) reasonable default
185	font list is always appended to it. See resource B<font> for more details.	180	font list is always appended to it. See resource B<font> for more details.
186		181
187	In short, to specify an X11 core font, just specify it's name or prefix it	182	In short, to specify an X11 core font, just specify its name or prefix it
188	with C<x:>. To specify an XFT-font, you need to prefix it with C<xft:>,	183	with C<x:>. To specify an XFT-font, you need to prefix it with C<xft:>,
189	e.g.:	184	e.g.:
190		185
191	@@RXVT_NAME@@ -fn "xft:Bitstream Vera Sans Mono:pixelsize=15"	186	@@RXVT_NAME@@ -fn "xft:Bitstream Vera Sans Mono:pixelsize=15"
192	@@RXVT_NAME@@ -fn "9x15bold,xft:Bitstream Vera Sans Mono"	187	@@RXVT_NAME@@ -fn "9x15bold,xft:Bitstream Vera Sans Mono"
…		…
210	italic> >> characters are to be printed. See resource B<boldItalicFont>	205	italic> >> characters are to be printed. See resource B<boldItalicFont>
211	for details.	206	for details.
212		207
213	=item B<-is>\|B<+is>	208	=item B<-is>\|B<+is>
214		209
215	Compile I<font-styles>: Bold/Italic font styles imply high intensity	210	Compile I<font-styles>: Bold/Blink font styles imply high intensity
216	foreground/background (default). See resource B<intensityStyles> for	211	foreground/background (default). See resource B<intensityStyles> for
217	details.	212	details.
218		213
219	=item B<-name> I<name>	214	=item B<-name> I<name>
220		215
…		…
238		233
239	=item B<-sb>\|B<+sb>	234	=item B<-sb>\|B<+sb>
240		235
241	Turn on/off scrollbar; resource B<scrollBar>.	236	Turn on/off scrollbar; resource B<scrollBar>.
242		237
		238	=item B<-sr>\|B<+sr>
		239
		240	Put scrollbar on right/left; resource B<scrollBar_right>.
		241
		242	=item B<-st>\|B<+st>
		243
		244	Display rxvt (non XTerm/NeXT) scrollbar without/with a trough;
		245	resource B<scrollBar_floating>.
		246
243	=item B<-si>\|B<+si>	247	=item B<-si>\|B<+si>
244		248
245	Turn on/off scroll-to-bottom on TTY output inhibit; resource	249	Turn on/off scroll-to-bottom on TTY output inhibit; resource
246	B<scrollTtyOutput> has opposite effect.	250	B<scrollTtyOutput> has opposite effect.
247		251
…		…
253	=item B<-sw>\|B<+sw>	257	=item B<-sw>\|B<+sw>
254		258
255	Turn on/off scrolling with the scrollback buffer as new lines appear.	259	Turn on/off scrolling with the scrollback buffer as new lines appear.
256	This only takes effect if B<-si> is also given; resource	260	This only takes effect if B<-si> is also given; resource
257	B<scrollWithBuffer>.	261	B<scrollWithBuffer>.
258
259	=item B<-sr>\|B<+sr>
260
261	Put scrollbar on right/left; resource B<scrollBar_right>.
262
263	=item B<-st>\|B<+st>
264
265	Display rxvt (non XTerm/NeXT) scrollbar without/with a trough;
266	resource B<scrollBar_floating>.
267		262
268	=item B<-ptab>\|B<+ptab>	263	=item B<-ptab>\|B<+ptab>
269		264
270	If enabled (default), "Horizontal Tab" characters are being stored as	265	If enabled (default), "Horizontal Tab" characters are being stored as
271	actual wide characters in the screen buffer, which makes it possible to	266	actual wide characters in the screen buffer, which makes it possible to
…		…
275		270
276	=item B<-bc>\|B<+bc>	271	=item B<-bc>\|B<+bc>
277		272
278	Blink the cursor; resource B<cursorBlink>.	273	Blink the cursor; resource B<cursorBlink>.
279		274
		275	=item B<-uc>\|B<+uc>
		276
		277	Make the cursor underlined; resource B<cursorUnderline>.
		278
280	=item B<-iconic>	279	=item B<-iconic>
281		280
282	Start iconified, if the window manager supports that option.	281	Start iconified, if the window manager supports that option.
283	Alternative form is B<-ic>.	282	Alternative form is B<-ic>.
284		283
…		…
300		299
301	=item B<-bl>	300	=item B<-bl>
302		301
303	Compile I<frills>: Set MWM hints to request a borderless window, i.e.	302	Compile I<frills>: Set MWM hints to request a borderless window, i.e.
304	if honoured by the WM, the rxvt-unicode window will not have window	303	if honoured by the WM, the rxvt-unicode window will not have window
305	decorations; resource B<borderLess>.	304	decorations; resource B<borderLess>. If the window manager does not
		305	support MWM hints (e.g. kwin), enables override-redirect mode.
306		306
307	=item B<-override-redirect>	307	=item B<-override-redirect>
308		308
309	Compile I<frills>: Sets override-redirect on the window; resource	309	Compile I<frills>: Sets override-redirect on the window; resource
310	B<override-redirect>.	310	B<override-redirect>.
…		…
318		318
319	=item B<-lsp> I<number>	319	=item B<-lsp> I<number>
320		320
321	Compile I<frills>: Lines (pixel height) to insert between each row of	321	Compile I<frills>: Lines (pixel height) to insert between each row of
322	the display. Useful to work around font rendering problems; resource	322	the display. Useful to work around font rendering problems; resource
323	B<linespace>.	323	B<lineSpace>.
		324
		325	=item B<-letsp> I<number>
		326
		327	Compile I<frills>: Amount to adjust the computed character width by
		328	to control overall letter spacing. Negative values will tighten up the
		329	letter spacing, positive values will space letters out more. Useful to
		330	work around odd font metrics; resource B<letterSpace>.
324		331
325	=item B<-tn> I<termname>	332	=item B<-tn> I<termname>
326		333
327	This option specifies the name of the terminal type to be set in the	334	This option specifies the name of the terminal type to be set in the
328	B<TERM> environment variable. This terminal type must exist in the	335	B<TERM> environment variable. This terminal type must exist in the
…		…
382	for more info.	389	for more info.
383		390
384	=item B<-tcw>	391	=item B<-tcw>
385		392
386	Change the meaning of triple-click selection with the left mouse	393	Change the meaning of triple-click selection with the left mouse
		394	button. Only effective when the original (non-perl) selection code is
387	button. Instead of selecting a full line it will extend the selection the	395	in-use. Instead of selecting a full line it will extend the selection to
388	end of the logical line only. resource B<tripleclickwords>.	396	the end of the logical line only. resource B<tripleclickwords>.
389		397
390	=item B<-insecure>	398	=item B<-insecure>
391		399
392	Enable "insecure" mode, which currently enables most of the escape	400	Enable "insecure" mode, which currently enables most of the escape
393	sequences that echo strings. See the resource B<insecure> for more	401	sequences that echo strings. See the resource B<insecure> for more
…		…
414	Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@	422	Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@
415	will not immediately destroy its window when the program executed within	423	will not immediately destroy its window when the program executed within
416	it exits. Instead, it will wait till it is being killed or closed by the	424	it exits. Instead, it will wait till it is being killed or closed by the
417	user; resource B<hold>.	425	user; resource B<hold>.
418		426
		427	=item B<-cd> I<path>
		428
		429	Sets the working directory for the shell (or the command specified via
		430	B<-e>). The I<path> must be an absolute path and it must exist for
		431	@@RXVT_NAME@@ to start; resource B<chdir>.
		432
		433	=item B<-xrm> I<string>
		434
		435	Works like the X Toolkit option of the same name, by adding the I<string>
		436	as if it were specified in a resource file. Resource values specified this
		437	way take precedence over all other resource specifications.
		438
		439	Note that you need to use the I<same> syntax as in the .Xdefaults file,
		440	e.g. C<*.background: black>. Also note that all @@RXVT_NAME@@-specific
		441	options can be specified as long-options on the commandline, so use
		442	of B<-xrm> is mostly limited to cases where you want to specify other
		443	resources (e.g. for input methods) or for compatibility with other
		444	programs.
		445
419	=item B<-keysym.>I<sym> I<string>	446	=item B<-keysym.>I<sym> I<string>
420		447
421	Remap a key symbol. See resource B<keysym>.	448	Remap a key symbol. See resource B<keysym>.
422		449
423	=item B<-embed> I<windowid>	450	=item B<-embed> I<windowid>
424		451
425	Tells @@RXVT_NAME@@ to embed it's windows into an already-existing window,	452	Tells @@RXVT_NAME@@ to embed its windows into an already-existing window,
426	which enables applications to easily embed a terminal.	453	which enables applications to easily embed a terminal.
427		454
428	Right now, @@RXVT_NAME@@ will first unmap/map the specified window, so it	455	Right now, @@RXVT_NAME@@ will first unmap/map the specified window, so it
429	shouldn't be a top-level window. @@RXVT_NAME@@ will also reconfigure it	456	shouldn't be a top-level window. @@RXVT_NAME@@ will also reconfigure it
430	quite a bit, so don't expect it to keep some specific state. It's best to	457	quite a bit, so don't expect it to keep some specific state. It's best to
…		…
433	The window will not be destroyed when @@RXVT_NAME@@ exits.	460	The window will not be destroyed when @@RXVT_NAME@@ exits.
434		461
435	It might be useful to know that @@RXVT_NAME@@ will not close file	462	It might be useful to know that @@RXVT_NAME@@ will not close file
436	descriptors passed to it (except for stdin/out/err, of course), so you	463	descriptors passed to it (except for stdin/out/err, of course), so you
437	can use file descriptors to communicate with the programs within the	464	can use file descriptors to communicate with the programs within the
438	terminal. This works regardless of wether the C<-embed> option was used or	465	terminal. This works regardless of whether the C<-embed> option was used or
439	not.	466	not.
440		467
441	Here is a short Gtk2-perl snippet that illustrates how this option can be	468	Here is a short Gtk2-perl snippet that illustrates how this option can be
442	used (a longer example is in F<doc/embed>):	469	used (a longer example is in F<doc/embed>):
443		470
…		…
448	});	475	});
449		476
450	=item B<-pty-fd> I<file descriptor>	477	=item B<-pty-fd> I<file descriptor>
451		478
452	Tells @@RXVT_NAME@@ NOT to execute any commands or create a new pty/tty	479	Tells @@RXVT_NAME@@ NOT to execute any commands or create a new pty/tty
453	pair but instead use the given filehandle as the tty master. This is	480	pair but instead use the given file descriptor as the tty master. This is
454	useful if you want to drive @@RXVT_NAME@@ as a generic terminal emulator	481	useful if you want to drive @@RXVT_NAME@@ as a generic terminal emulator
455	without having to run a program within it.	482	without having to run a program within it.
456		483
457	If this switch is given, @@RXVT_NAME@@ will not create any utmp/wtmp	484	If this switch is given, @@RXVT_NAME@@ will not create any utmp/wtmp
458	entries and will not tinker with pty/tty permissions - you have to do that	485	entries and will not tinker with pty/tty permissions - you have to do that
459	yourself if you want that.	486	yourself if you want that.
460		487
461	As an extremely special case, specifying C<-1> will completely suppress	488	As an extremely special case, specifying C<-1> will completely suppress
462	pty/tty operations.	489	pty/tty operations, which is probably only useful in conjunction with some
		490	perl extension that manages the terminal.
463		491
464	Here is a example in perl that illustrates how this option can be used (a	492	Here is a example in perl that illustrates how this option can be used (a
465	longer example is in F<doc/pty-fd>):	493	longer example is in F<doc/pty-fd>):
466		494
467	use IO::Pty;	495	use IO::Pty;
…		…
481	Comma-separated list of perl extension scripts to use (or not to use) in	509	Comma-separated list of perl extension scripts to use (or not to use) in
482	this terminal instance. See resource B<perl-ext> for details.	510	this terminal instance. See resource B<perl-ext> for details.
483		511
484	=back	512	=back
485		513
486	=head1 RESOURCES (available also as long-options)	514	=head1 RESOURCES
487		515
488	Note: `@@RXVT_NAME@@ --help' gives a list of all resources (long	516	Note: `@@RXVT_NAME@@ --help' gives a list of all resources (long
489	options) compiled into your version.	517	options) compiled into your version. All resources are also available as
		518	long-options.
490		519
491	You can set and change the resources using X11 tools like B<xrdb>. Many	520	You can set and change the resources using X11 tools like B<xrdb>. Many
492	distribution do also load settings from the B<~/.Xresources> file when X	521	distribution do also load settings from the B<~/.Xresources> file when X
493	starts. @@RXVT_NAME@@ will consult the following files/resources in order,	522	starts. @@RXVT_NAME@@ will consult the following files/resources in order,
494	with later settings overwriting earlier ones:	523	with later settings overwriting earlier ones:
495		524
496	1. system-wide app-defaults file, either locale-dependent OR global
497	2. app-defaults file in $XAPPLRESDIR	525	1. app-defaults file in $XAPPLRESDIR
		526	2. $HOME/.Xdefaults
498	3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults	527	3. RESOURCE_MANAGER property on root-window of screen 0
499	4. SCREEN_RESOURCES for the current screen	528	4. SCREEN_RESOURCES property on root-window of the current screen
500	5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename>	529	5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename>
		530	6. resources specified via -xrm on the commandline
501		531
502	Note that when reading X resources, B<@@RXVT_NAME@@> recognizes two class	532	Note that when reading X resources, B<@@RXVT_NAME@@> recognizes two class
503	names: B<Rxvt> and B<URxvt>. The class name B<Rxvt> allows resources	533	names: B<Rxvt> and B<URxvt>. The class name B<Rxvt> allows resources
504	common to both B<@@RXVT_NAME@@> and the original I<rxvt> to be easily	534	common to both B<@@RXVT_NAME@@> and the original I<rxvt> to be easily
505	configured, while the class name B<URxvt> allows resources unique to	535	configured, while the class name B<URxvt> allows resources unique to
…		…
515	=item B<depth:> I<bitdepth>	545	=item B<depth:> I<bitdepth>
516		546
517	Compile I<xft>: Attempt to find a visual with the given bit depth;	547	Compile I<xft>: Attempt to find a visual with the given bit depth;
518	option B<-depth>.	548	option B<-depth>.
519		549
		550	=item B<buffered:> I<boolean>
		551
		552	Compile I<xft>: Turn on/off double-buffering for xft (default enabled).
		553	On some card/driver combination enabling it slightly decreases
		554	performance, on most it greatly helps it. The slowdown is small, so it
		555	should normally be enabled.
		556
520	=item B<geometry:> I<geom>	557	=item B<geometry:> I<geom>
521		558
522	Create the window with the specified X window geometry [default 80x24];	559	Create the window with the specified X window geometry [default 80x24];
523	option B<-geometry>.	560	option B<-geometry>.
524		561
…		…
537	Use the specified colour for the colour value I<n>, where 0-7	574	Use the specified colour for the colour value I<n>, where 0-7
538	corresponds to low-intensity (normal) colours and 8-15 corresponds to	575	corresponds to low-intensity (normal) colours and 8-15 corresponds to
539	high-intensity (bold = bright foreground, blink = bright background)	576	high-intensity (bold = bright foreground, blink = bright background)
540	colours. The canonical names are as follows: 0=black, 1=red, 2=green,	577	colours. The canonical names are as follows: 0=black, 1=red, 2=green,
541	3=yellow, 4=blue, 5=magenta, 6=cyan, 7=white, but the actual colour	578	3=yellow, 4=blue, 5=magenta, 6=cyan, 7=white, but the actual colour
542	names used are listed in the B<COLORS AND GRAPHICS> section.	579	names used are listed in the B<COLOURS AND GRAPHICS> section.
543		580
544	Colours higher than 15 cannot be set using resources (yet), but can be	581	Colours higher than 15 cannot be set using resources (yet), but can be
545	changed using an escape command (see @@RXVT_NAME@@(7)).	582	changed using an escape command (see @@RXVT_NAME@@(7)).
546		583
547	Colours 16-79 form a standard 4x4x4 colour cube (the same as xterm with	584	Colours 16-79 form a standard 4x4x4 colour cube (the same as xterm with
…		…
558	=item B<colorUL:> I<colour>	595	=item B<colorUL:> I<colour>
559		596
560	Use the specified colour to display underlined characters when the	597	Use the specified colour to display underlined characters when the
561	foreground colour is the default.	598	foreground colour is the default.
562		599
563	=item B<colorRV:> I<colour>
564
565	Use the specified colour as the background for reverse video
566	characters.
567
568	=item B<underlineColor:> I<colour>	600	=item B<underlineColor:> I<colour>
569		601
570	If set, use the specified colour as the colour for the underline	602	If set, use the specified colour as the colour for the underline
571	itself. If unset, use the foreground colour.	603	itself. If unset, use the foreground colour.
		604
		605	=item B<highlightColor:> I<colour>
		606
		607	If set, use the specified colour as the background for highlighted
		608	characters. If unset, use reverse video.
		609
		610	=item B<highlightTextColor:> I<colour>
		611
		612	If set and highlightColor is set, use the specified colour as the
		613	foreground for highlighted characters.
572		614
573	=item B<cursorColor:> I<colour>	615	=item B<cursorColor:> I<colour>
574		616
575	Use the specified colour for the cursor. The default is to use the	617	Use the specified colour for the cursor. The default is to use the
576	foreground colour; option B<-cr>.	618	foreground colour; option B<-cr>.
…		…
583		625
584	=item B<reverseVideo:> I<boolean>	626	=item B<reverseVideo:> I<boolean>
585		627
586	B<True>: simulate reverse video by foreground and background colours;	628	B<True>: simulate reverse video by foreground and background colours;
587	option B<-rv>. B<False>: regular screen colours [default]; option	629	option B<-rv>. B<False>: regular screen colours [default]; option
588	B<+rv>. See note in B<COLORS AND GRAPHICS> section.	630	B<+rv>. See note in B<COLOURS AND GRAPHICS> section.
589		631
590	=item B<jumpScroll:> I<boolean>	632	=item B<jumpScroll:> I<boolean>
591		633
592	B<True>: specify that jump scrolling should be used. When scrolling	634	B<True>: specify that jump scrolling should be used. When receiving lots
593	quickly, fewer screen updates are performed [default]; option B<-j>.	635	of lines, @@RXVT_NAME@@ will only scroll once a whole screen height of lines
		636	has been read, resulting in fewer updates while still displaying every
		637	received line; option B<-j>.
		638
594	B<False>: specify that smooth scrolling should be used; option B<+j>.	639	B<False>: specify that smooth scrolling should be used. @@RXVT_NAME@@ will
		640	force a screen refresh on each new line it received; option B<+j>.
595		641
596	=item B<inheritPixmap:> I<boolean>	642	=item B<skipScroll:> I<boolean>
597		643
598	B<True>: make the background inherit the parent windows' pixmap, giving	644	B<True>: (the default) specify that skip scrolling should be used. When
599	artificial transparency. B<False>: do not inherit the parent windows'	645	receiving lots of lines, @@RXVT_NAME@@ will only scroll once in a while
600	pixmap.	646	(around 60 times per second), resulting in far fewer updates. This can
		647	result in @@RXVT_NAME@@ not ever displaying some of the lines it receives;
		648	option B<-ss>.
		649
		650	B<False>: specify that everything is to be displayed, even
		651	if the refresh is too fast for the human eye to read anything (or the
		652	monitor to display anything); option B<+ss>.
601		653
602	=item B<fading:> I<number>	654	=item B<fading:> I<number>
603		655
604	Fade the text by the given percentage when focus is lost; option B<-fade>.	656	Fade the text by the given percentage when focus is lost; option B<-fade>.
605		657
606	=item B<fadeColor:> I<colour>	658	=item B<fadeColor:> I<colour>
607		659
608	Fade to this colour, when fading is used (see B<fading:>). The default	660	Fade to this colour, when fading is used (see B<fading:>). The default
609	colour is black; option B<-fadecolor>.	661	colour is black; option B<-fadecolor>.
610		662
611	=item B<tintColor:> I<colour>	663	=item B<iconFile:> I<file>
612		664
613	Tint the transparent background pixmap with the given colour; option	665	Set the application icon pixmap; option B<-icon>.
614	B<-tint>.
615
616	=item B<shading:> I<number>
617
618	Darken (0 .. 100) or lighten (-1 .. -100) the transparent background
619	image in addition to tinting it.
620		666
621	=item B<scrollColor:> I<colour>	667	=item B<scrollColor:> I<colour>
622		668
623	Use the specified colour for the scrollbar [default #B2B2B2].	669	Use the specified colour for the scrollbar [default #B2B2B2].
624		670
…		…
629		675
630	=item B<borderColor:> I<colour>	676	=item B<borderColor:> I<colour>
631		677
632	The colour of the border around the text area and between the scrollbar	678	The colour of the border around the text area and between the scrollbar
633	and the text.	679	and the text.
634
635	=item B<backgroundPixmap:> I<file[;geom]>
636
637	Use the specified XPM file (note the `.xpm' extension is optional) for
638	the background and also optionally specify its scaling with a geometry
639	string B<WxH+X+Y>, in which B<"W" / "H"> specify the
640	horizontal/vertical scale (percent) and B<"X" / "Y"> locate the image
641	centre (percent). A scale of 0 displays the image with tiling. A scale
642	of 1 displays the image without any scaling. A scale of 2 to 9
643	specifies an integer number of images in that direction. No image will
644	be magnified beyond 10 times its original size. The maximum permitted
645	scale is 1000. [default 0x0+50+50]
646
647	=item B<path:> I<path>
648
649	Specify the colon-delimited search path for finding XPM files.
650		680
651	=item B<font:> I<fontlist>	681	=item B<font:> I<fontlist>
652		682
653	Select the fonts to be used. This is a comma separated list of font names	683	Select the fonts to be used. This is a comma separated list of font names
654	that are checked in order when trying to find glyphs for characters. The	684	that are checked in order when trying to find glyphs for characters. The
…		…
677	it is named first) and thus defines the character cell grid to be 9 pixels	707	it is named first) and thus defines the character cell grid to be 9 pixels
678	wide and 15 pixels high.	708	wide and 15 pixels high.
679		709
680	The second font is just used to add additional unicode characters not in	710	The second font is just used to add additional unicode characters not in
681	the base font, likewise the third, which is unfortunately non-bold, but	711	the base font, likewise the third, which is unfortunately non-bold, but
682	the bold version of the font does contain less characters, so this is a	712	the bold version of the font does contain fewer characters, so this is a
683	useful supplement.	713	useful supplement.
684		714
685	The third font is an Xft font with aliasing turned off, and the characters	715	The third font is an Xft font with aliasing turned off, and the characters
686	are limited to the B<JIS 0208> codeset (i.e. japanese kanji). The font	716	are limited to the B<JIS 0208> codeset (i.e. japanese kanji). The font
687	contains other characters, but we are not interested in them.	717	contains other characters, but we are not interested in them.
…		…
711	text font will being used for the given style.	741	text font will being used for the given style.
712		742
713	=item B<intensityStyles:> I<boolean>	743	=item B<intensityStyles:> I<boolean>
714		744
715	When font styles are not enabled, or this option is enabled (B<True>,	745	When font styles are not enabled, or this option is enabled (B<True>,
716	option B<-is>, the default), bold and italic font styles imply high	746	option B<-is>, the default), bold/blink font styles imply high
717	intensity foreground/backround colours. Disabling this option (B<False>,	747	intensity foreground/background colours. Disabling this option (B<False>,
718	option B<+is>) disables this behaviour, the high intensity colours are not	748	option B<+is>) disables this behaviour, the high intensity colours are not
719	reachable.	749	reachable.
720
721	=item B<selectstyle:> I<mode>
722
723	Set mouse selection style to B<old> which is 2.20, B<oldword> which is
724	xterm style with 2.20 old word selection, or anything else which gives
725	xterm style selection.
726
727	=item B<scrollstyle:> I<mode>
728
729	Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is
730	the author's favourite.
731		750
732	=item B<title:> I<string>	751	=item B<title:> I<string>
733		752
734	Set window title string, the default title is the command-line	753	Set window title string, the default title is the command-line
735	specified after the B<-e> option, if any, otherwise the application	754	specified after the B<-e> option, if any, otherwise the application
…		…
744	=item B<mapAlert:> I<boolean>	763	=item B<mapAlert:> I<boolean>
745		764
746	B<True>: de-iconify (map) on receipt of a bell character. B<False>: no	765	B<True>: de-iconify (map) on receipt of a bell character. B<False>: no
747	de-iconify (map) on receipt of a bell character [default].	766	de-iconify (map) on receipt of a bell character [default].
748		767
		768	=item B<urgentOnBell:> I<boolean>
		769
		770	B<True>: set the urgency hint for the wm on receipt of a bell character.
		771	B<False>: do not set the urgency hint [default].
		772
		773	@@RXVT_NAME@@ resets the urgency hint on every focus change.
		774
749	=item B<visualBell:> I<boolean>	775	=item B<visualBell:> I<boolean>
750		776
751	B<True>: use visual bell on receipt of a bell character; option B<-vb>.	777	B<True>: use visual bell on receipt of a bell character; option B<-vb>.
752	B<False>: no visual bell [default]; option B<+vb>.	778	B<False>: no visual bell [default]; option B<+vb>.
753		779
…		…
774	Example:	800	Example:
775		801
776	URxvt.print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX)	802	URxvt.print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX)
777		803
778	This creates a new file in your home directory with the screen contents	804	This creates a new file in your home directory with the screen contents
779	everytime you hit C<Print>.	805	every time you hit C<Print>.
		806
		807	=item B<scrollstyle:> I<mode>
		808
		809	Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is
		810	the author's favourite.
		811
		812	=item B<thickness:> I<number>
		813
		814	Set the scrollbar width in pixels.
780		815
781	=item B<scrollBar:> I<boolean>	816	=item B<scrollBar:> I<boolean>
782		817
783	B<True>: enable the scrollbar [default]; option B<-sb>. B<False>:	818	B<True>: enable the scrollbar [default]; option B<-sb>. B<False>:
784	disable the scrollbar; option B<+sb>.	819	disable the scrollbar; option B<+sb>.
…		…
804	B<False>: do not scroll to bottom when tty receives output; option	839	B<False>: do not scroll to bottom when tty receives output; option
805	B<+si>.	840	B<+si>.
806		841
807	=item B<scrollWithBuffer:> I<boolean>	842	=item B<scrollWithBuffer:> I<boolean>
808		843
809	B<True>: scroll with scrollback buffer when tty receives new lines (and	844	B<True>: scroll with scrollback buffer when tty receives new lines (i.e.
810	B<scrollTtyOutput> is False); option B<-sw>. B<False>: do not scroll	845	try to show the same lines) and B<scrollTtyOutput> is False; option
811	with scrollback buffer when tty recieves new lines; option B<+sw>.	846	B<-sw>. B<False>: do not scroll with scrollback buffer when tty receives
		847	new lines; option B<+sw>.
812		848
813	=item B<scrollTtyKeypress:> I<boolean>	849	=item B<scrollTtyKeypress:> I<boolean>
814		850
815	B<True>: scroll to bottom when a non-special key is pressed. Special keys	851	B<True>: scroll to bottom when a non-special key is pressed. Special keys
816	are those which are intercepted by rxvt-unicode for special handling and	852	are those which are intercepted by rxvt-unicode for special handling and
…		…
847	=item B<termName:> I<termname>	883	=item B<termName:> I<termname>
848		884
849	Specifies the terminal type name to be set in the B<TERM> environment	885	Specifies the terminal type name to be set in the B<TERM> environment
850	variable; option B<-tn>.	886	variable; option B<-tn>.
851		887
852	=item B<linespace:> I<number>	888	=item B<lineSpace:> I<number>
853		889
854	Specifies number of lines (pixel height) to insert between each row of	890	Specifies number of lines (pixel height) to insert between each row of
855	the display [default 0]; option B<-lsp>.	891	the display [default 0]; option B<-lsp>.
856		892
857	=item B<meta8:> I<boolean>	893	=item B<meta8:> I<boolean>
…		…
871		907
872	=item B<cursorBlink:> I<boolean>	908	=item B<cursorBlink:> I<boolean>
873		909
874	B<True>: blink the cursor. B<False>: do not blink the cursor [default];	910	B<True>: blink the cursor. B<False>: do not blink the cursor [default];
875	option B<-bc>.	911	option B<-bc>.
		912
		913	=item B<cursorUnderline:> I<boolean>
		914
		915	B<True>: Make the cursor underlined. B<False>: Make the cursor a box [default];
		916	option B<-uc>.
876		917
877	=item B<pointerBlank:> I<boolean>	918	=item B<pointerBlank:> I<boolean>
878		919
879	B<True>: blank the pointer when a key is pressed or after a set number	920	B<True>: blank the pointer when a key is pressed or after a set number
880	of seconds of inactivity. B<False>: the pointer is always visible	921	of seconds of inactivity. B<False>: the pointer is always visible
…		…
894	large number (e.g. C<987654321>) to effectively disable the timeout.	935	large number (e.g. C<987654321>) to effectively disable the timeout.
895		936
896	=item B<backspacekey:> I<string>	937	=item B<backspacekey:> I<string>
897		938
898	The string to send when the backspace key is pressed. If set to B<DEC>	939	The string to send when the backspace key is pressed. If set to B<DEC>
899	or unset it will send B<Delete> (code 127) or, if shifted, B<Backspace>	940	or unset it will send B<Delete> (code 127) or, with control, B<Backspace>
900	(code 8) - which can be reversed with the appropriate DEC private mode	941	(code 8) - which can be reversed with the appropriate DEC private mode
901	escape sequence.	942	escape sequence.
902		943
903	=item B<deletekey:> I<string>	944	=item B<deletekey:> I<string>
904		945
…		…
909	=item B<cutchars:> I<string>	950	=item B<cutchars:> I<string>
910		951
911	The characters used as delimiters for double-click word selection	952	The characters used as delimiters for double-click word selection
912	(whitespace delimiting is added automatically if resource is given).	953	(whitespace delimiting is added automatically if resource is given).
913		954
914	When the selection extension is in use (the default if compiled in, see	955	When the perl selection extension is in use (the default if compiled
915	the @@RXVT_NAME@@perl(3) manpage), a suitable regex using these characters	956	in, see the @@RXVT_NAME@@perl(3) manpage), a suitable regex using these
916	will be created (if the resource exists, otherwise, no regex will be	957	characters will be created (if the resource exists, otherwise, no regex
917	created). In this mode, characters outside ISO-8859-1 can be used.	958	will be created). In this mode, characters outside ISO-8859-1 can be used.
918		959
919	When the selection extension is not used, only ISO-8859-1 characters can	960	When the selection extension is not used, only ISO-8859-1 characters can
920	be used. If not specified, the built-in default is used:	961	be used. If not specified, the built-in default is used:
921		962
922	B<< BACKSLASH `"'&()*,;<=>?@[]{\|} >>	963	B<< BACKSLASH `"'&()*,;<=>?@[]^{\|} >>
923		964
924	=item B<preeditType:> I<style>	965	=item B<preeditType:> I<style>
925		966
926	B<OverTheSpot>, B<OffTheSpot>, B<Root>; option B<-pt>.	967	B<OverTheSpot>, B<OffTheSpot>, B<Root>; option B<-pt>.
927		968
…		…
981		1022
982	Turn on/off secondary screen (default enabled).	1023	Turn on/off secondary screen (default enabled).
983		1024
984	=item B<secondaryScroll:> I<boolean>	1025	=item B<secondaryScroll:> I<boolean>
985		1026
986	Turn on/off secondary screen scroll (default enabled). If the this	1027	Turn on/off secondary screen scroll (default enabled). If this
987	option is enabled, scrolls on the secondary screen will change the	1028	option is enabled, scrolls on the secondary screen will change the
988	scrollback buffer and switching to/from the secondary screen will	1029	scrollback buffer and, when secondaryScreen is off, switching
989	instead scroll the screen up.	1030	to/from the secondary screen will instead scroll the screen up.
990		1031
991	=item B<hold>: I<boolean>	1032	=item B<hold>: I<boolean>
992		1033
993	Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@	1034	Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@
994	will not immediately destroy its window when the program executed within	1035	will not immediately destroy its window when the program executed within
995	it exits. Instead, it will wait till it is being killed or closed by the	1036	it exits. Instead, it will wait till it is being killed or closed by the
996	user.	1037	user.
997		1038
		1039	=item B<chdir>: I<path>
		1040
		1041	Sets the working directory for the shell (or the command specified via
		1042	B<-e>). The I<path> must be an absolute path and it must exist for
		1043	@@RXVT_NAME@@ to start. If it isn't specified then the current working
		1044	directory will be used; option B<-cd>.
		1045
998	=item B<keysym.>I<sym>: I<string>	1046	=item B<keysym.>I<sym>: I<action>
999		1047
1000	Compile I<frills>: Associate I<string> with keysym I<sym>. The	1048	Compile I<frills>: Associate I<action> with keysym I<sym>. The intervening
1001	intervening resource name B<keysym.> cannot be omitted.	1049	resource name B<keysym.> cannot be omitted.
1002		1050
1003	The format of I<sym> is "I<(modifiers-)key>", where I<modifiers> can be	1051	Using this resource, you can map key combinations such as
1004	any combination of B<ISOLevel3>, B<AppKeypad>, B<Control>, B<NumLock>,	1052	C<Ctrl-Shift-BackSpace> to various actions, such as outputting a different
1005	B<Shift>, B<Meta>, B<Lock>, B<Mod1>, B<Mod2>, B<Mod3>, B<Mod4>, B<Mod5>,	1053	string than would normally result from that combination, making the
1006	and the abbreviated B<I>, B<K>, B<C>, B<N>, B<S>, B<M>, B<A>, B<L>, B<1>,	1054	terminal scroll up or down the way you want it, or any other thing an
1007	B<2>, B<3>, B<4>, B<5>.	1055	extension might provide.
		1056
		1057	The key combination that triggers the action, I<sym>, has the following format:
		1058
		1059	(modifiers-)key
		1060
		1061	Where I<modifiers> can be any combination of B<ISOLevel3>, B<AppKeypad>,
		1062	B<Control>, B<NumLock>, B<Shift>, B<Meta>, B<Lock>, B<Mod1>, B<Mod2>,
		1063	B<Mod3>, B<Mod4>, B<Mod5>, and the abbreviated B<I>, B<K>, B<C>, B<N>,
		1064	B<S>, B<M>, B<A>, B<L>, B<1>, B<2>, B<3>, B<4>, B<5>.
1008		1065
1009	The B<NumLock>, B<Meta> and B<ISOLevel3> modifiers are usually aliased to	1066	The B<NumLock>, B<Meta> and B<ISOLevel3> modifiers are usually aliased to
1010	whatever modifier the NumLock key, Meta/Alt keys or ISO Level3 Shift/AltGr	1067	whatever modifier the NumLock key, Meta/Alt keys or ISO Level3 Shift/AltGr
1011	keys are being mapped. B<AppKeypad> is a synthetic modifier mapped to the	1068	keys are being mapped. B<AppKeypad> is a synthetic modifier mapped to the
1012	current application keymap mode state.	1069	current application keymap mode state.
1013		1070
1014	The spellings of I<key> can be obtained by using B<xev>(1) command or	1071	Due the the large number of modifier combinations, a key mapping will
1015	searching keysym macros from B</usr/X11R6/include/X11/keysymdef.h> and	1072	match if I<at least> the specified identifiers are being set, and no other
		1073	key mappings with those and more bits are being defined. That means that
		1074	defining a mapping for C<a> will automatically provide definitions for
		1075	C<Meta-a>, C<Shift-a> and so on, unless some of those are defined mappings
		1076	themselves. See the C<builtin:> action, below, for a way to work around
		1077	this when this is a problem.
		1078
		1079	The spelling of I<key> depends on your implementation of X. An easy way to
		1080	find a key name is to use the B<xev>(1) command. You can find a list by
		1081	looking for the C<XK_> macros in the B<X11/keysymdef.h> include file (omit
1016	omitting the prefix B<XK_>. Alternatively you can specify I<key> by its hex	1082	the C<XK_> prefix). Alternatively you can specify I<key> by its hex keysym
1017	keysym value (B<0x0000 - 0xFFFF>). Note that the lookup of I<sym>s is not	1083	value (B<0x0000 - 0xFFFF>).
1018	performed in an exact manner; however, the closest match is assured.
1019		1084
1020	I<string> may contain escape values (C<\a>: bell, C<\b>: backspace,	1085	As with any resource value, the I<action> string may contain backslash
1021	C<\e>, C<\E>: escape, C<\n>: newline, C<\r>: carriage return, C<\t>: tab,	1086	escape sequences (C<\n>: newline, C<\\>: backslash, C<\000>: octal
1022	C<\000>: octal number) or verbatim control characters (C<^?>: delete,	1087	number), see RESOURCES in C<man 7 X> for further details.
1023	C<^@>: null, C<^A> ...) and may be enclosed with double quotes so that it
1024	can start or end with whitespace.
1025		1088
1026	Please note that you need to double the C<\> in resource files, as	1089	An action starts with an action prefix that selects a certain type
1027	Xlib itself does it's own de-escaping (you can use C<\033> instead of	1090	of action, followed by a colon. An action strings without colons is
1028	C<\e> (and so on), which will work with both Xt and @@RXVT_NAME@@'s own	1091	interpreted as a literal string to pass to the tty (as if they were
1029	processing).	1092	prefixed with C<string:>).
1030		1093
1031	You can define a range of keysyms in one shot by providing a I<string>	1094	The following action prefixes are known - extensions can provide
1032	with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimeter `/'	1095	additional prefixes:
1033	should be a character not used by the strings.
1034		1096
1035	Its usage can be demonstrated by an example:	1097	=over 4
1036		1098
1037	URxvt.keysym.M-C-0x61: list\|\033<M-C-\|abc\|>	1099	=item string:STRING
1038		1100
1039	The above line is equivalent to the following three lines:	1101	If the I<action> starts with C<string:> (or otherwise contains no colons),
		1102	then the remaining C<STRING> will be passed to the program running in the
		1103	terminal. For example, you could replace whatever Shift-Tab outputs by the
		1104	string C<echo rm -rf /> followed by a newline:
1040		1105
1041	URxvt.keysym.Meta-Control-0x61: \033<M-C-a>	1106	URxvt.keysym.Shift-Tab: string:echo rm -rf /\n
1042	URxvt.keysym.Meta-Control-0x62: \033<M-C-b>
1043	URxvt.keysym.Meta-Control-0x63: \033<M-C-c>
1044		1107
		1108	This could in theory be used to completely redefine your keymap.
		1109
		1110	=item command:STRING
		1111
1045	If I<string> takes the form of C<command:STRING>, the specified B<STRING>	1112	If I<action> takes the form of C<command:STRING>, the specified B<STRING>
1046	is interpreted and executed as @@RXVT_NAME@@'s control sequence. For	1113	is interpreted and executed as @@RXVT_NAME@@'s control sequence (basically
		1114	the opposite of C<string:> - instead of sending it to the program running
		1115	in the terminal, it will be treated as if it were program output). This is
		1116	most useful to feed command sequences into @@RXVT_NAME@@.
		1117
1047	example the following means "change the current locale to C<zh_CN.GBK>	1118	For example the following means "change the current locale to C<zh_CN.GBK>
1048	when Control-Meta-c is being pressed":	1119	when Control-Meta-c is being pressed":
1049		1120
1050	URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007	1121	URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007
1051		1122
1052	If I<string> takes the form C<perl:STRING>, then the specified B<STRING>	1123	The following example will map Control-Meta-1 and Control-Meta-2 to
1053	is passed to the C<on_keyboard_command> perl handler. See the @@RXVT_NAME@@perl(3)	1124	the fonts C<suxuseuro> and C<9x15bold>, so you can have some limited
1054	manpage. For example, the F<selection> extension (activated via	1125	font-switching at runtime:
1055	C<@@RXVT_NAME@@ -pe selection>) listens for C<selection:rot13> events:
1056		1126
1057	URxvt.keysym.M-C-c: perl:selection:rot13	1127	URxvt.keysym.M-C-1: command:\033]50;suxuseuro\007
		1128	URxvt.keysym.M-C-2: command:\033]50;9x15bold\007
1058		1129
1059	Due the the large number of modifier combinations, a defined key mapping	1130	Other things are possible, e.g. resizing (see @@RXVT_NAME@@(7) for more
1060	will match if at I<at least> the specified identifiers are being set, and	1131	info):
1061	no other key mappings with those and more bits are being defined. That
1062	means that defining a key map for C<a> will automatically provide
1063	definitions for C<Meta-a>, C<Shift-a> and so on, unless some of those are defined
1064	mappings themselves.
1065		1132
1066	Unfortunately, this will override built-in key mappings. For example	1133	URxvt.keysym.M-C-3: command:\033[8;25;80t
		1134	URxvt.keysym.M-C-4: command:\033[8;48;110t
		1135
		1136	=item builtin:
		1137
		1138	The builtin action is the action that @@RXVT_NAME@@ would execute if no
		1139	key binding existed for the key combination. The obvious use is to undo
		1140	the effect of existing bindings. The not so obvious use is to reinstate
		1141	bindings when another binding overrides too many modifiers.
		1142
1067	if you overwrite the C<Insert> key you will disable @@RXVT_NAME@@'s	1143	For example if you overwrite the C<Insert> key you will disable
1068	C<Shift-Insert> mapping. To re-enable that, you can poke "holes" into the	1144	@@RXVT_NAME@@'s C<Shift-Insert> mapping. To re-enable that, you can poke
1069	user-defined keymap using the C<builtin:> replacement:	1145	"holes" into the user-defined keymap using the C<builtin:> replacement:
1070		1146
1071	URxvt.keysym.Insert: <my insert key sequence>	1147	URxvt.keysym.Insert: <my insert key sequence>
1072	URxvt.keysym.S-Insert: builtin:	1148	URxvt.keysym.S-Insert: builtin:
1073		1149
1074	The first line defines a mapping for C<Insert> and I<any> combination	1150	The first line defines a mapping for C<Insert> and I<any> combination
1075	of modifiers. The second line re-establishes the default mapping for	1151	of modifiers. The second line re-establishes the default mapping for
1076	C<Shift-Insert>.	1152	C<Shift-Insert>.
1077		1153
1078	The following example will map Control-Meta-1 and Control-Meta-2 to	1154	=item builtin-string:
1079	the fonts C<suxuseuro> and C<9x15bold>, so you can have some limited
1080	font-switching at runtime:
1081		1155
1082	URxvt.keysym.M-C-1: command:\033]50;suxuseuro\007	1156	This action is mainly useful to restore string mappings for keys that
1083	URxvt.keysym.M-C-2: command:\033]50;9x15bold\007	1157	have predefined actions in @@RXVT_NAME@@. The exact semantics are a bit
		1158	difficult to explain - basically, this action will send the string to the
		1159	application that would be sent if @@RXVT_NAME@@ wouldn't have a built-in
		1160	action for it.
1084		1161
1085	Other things are possible, e.g. resizing (see @@RXVT_NAME@@(7) for more	1162	An example might make it clearer: @@RXVT_NAME@@ normally pastes the
1086	info):	1163	selection when you press C<Shift-Insert>. With the following bindings, it
		1164	would instead emit the (undocumented, but what applications running in the
		1165	terminal might expect) sequence C<ESC [ 2 $> instead:
1087		1166
1088	URxvt.keysym.M-C-3: command:\033[8;25;80t	1167	URxvt.keysym.S-Insert: builtin-string:
1089	URxvt.keysym.M-C-4: command:\033[8;48;110t	1168	URxvt.keysym.C-S-Insert: builtin:
		1169
		1170	The first line disables the paste functionality for that key
		1171	combination, and the second reinstates the default behaviour for
		1172	C<Control-Shift-Insert>, which would otherwise be overridden.
		1173
		1174	Similarly, to let applications gain access to the C<C-M-c> (copy to
		1175	clipboard) and C<C-M-v> (paste clipboard) key combination, you can do
		1176	this:
		1177
		1178	URxvt.keysym.C-S-c: builtin-string:
		1179	URxvt.keysym.C-S-v: builtin-string:
		1180
		1181	=item EXTENSION:STRING
		1182
		1183	An action of this form passes the B<STRING> to the @@RXVT_NAME@@perl(3)
		1184	extension of the same name. The extension will be loaded automatically if
		1185	neccessary.
		1186
		1187	Not all extensions define key actions, but popular extensions that do
		1188	include the I<selection> and I<matcher> extensions (documented in their
		1189	own manpages, @@RXVT_NAME@@-selection(1) and @@RXVT_NAME@@-matcher(1),
		1190	respectively).
		1191
		1192	From the silly examples department, this will rot13-"encrypt"
		1193	@@RXVT_NAME@@'s selection when Alt-Control-c is pressed on typical PC
		1194	keyboards:
		1195
		1196	URxvt.keysym.M-C-c: selection:rot13
		1197
		1198	=item perl:STRING DEPRECATED
		1199
		1200	This is a deprecated way of passing key mappings to perl extensions. It is
		1201	still supported, but should not be used anymore.
		1202
		1203	=back
1090		1204
1091	=item B<perl-ext-common>: I<string>	1205	=item B<perl-ext-common>: I<string>
1092		1206
1093	=item B<perl-ext>: I<string>	1207	=item B<perl-ext>: I<string>
1094		1208
…		…
1096	use in this terminal instance; option B<-pe>.	1210	use in this terminal instance; option B<-pe>.
1097		1211
1098	Extension names can be prefixed with a C<-> sign to prohibit using	1212	Extension names can be prefixed with a C<-> sign to prohibit using
1099	them. This can be useful to selectively disable some extensions loaded	1213	them. This can be useful to selectively disable some extensions loaded
1100	by default, or specified via the C<perl-ext-common> resource. For	1214	by default, or specified via the C<perl-ext-common> resource. For
1101	example, C<default,-selection> will use all the default extension except	1215	example, C<default,-selection> will use all the default extensions except
1102	C<selection>.	1216	C<selection>.
1103		1217
1104	Extension names can also be followed by an argument in angle brackets	1218	The default set includes the C<selection>, C<option-popup>,
1105	(e.g. C<< searchable-scrollback<M-s> >>, which binds the hotkey for	1219	C<selection-popup> and C<readline> extensions, any extensions that define
1106	searchable scorllback to Alt/Meta-s). Mentioning the same extension	1220	keybindings via C<BINDING> meta comments, extensions loaded because
1107	multiple times with different arguments will pass multiple arguments to	1221	their resources/commandline switches were used, and extensions which are
1108	the extension.	1222	mentioned in B<keysym> resources.
1109		1223
1110	Each extension is looked up in the library directories, loaded if	1224	Each extension is looked up in the library directories, loaded if
1111	necessary, and bound to the current terminal instance.	1225	necessary, and bound to the current terminal instance. When the library
		1226	search path contains multiple extension files of the same name, then the
		1227	first one found will be used.
1112		1228
1113	If both of these resources are the empty string, then the perl	1229	If both of these resources are the empty string, then the perl interpreter
1114	interpreter will not be initialized. The idea behind two options is that	1230	will not be initialized. The rationale for having two options is that
1115	B<perl-ext-common> will be used for extensions that should be available to	1231	B<perl-ext-common> will be used for extensions that should be available to
1116	all instances, while B<perl-ext> is used for specific instances.	1232	all instances, while B<perl-ext> is used for specific instances.
1117		1233
1118	=item B<perl-eval>: I<string>	1234	=item B<perl-eval>: I<string>
1119		1235
1120	Perl code to be evaluated when all extensions have been registered. See	1236	Perl code to be evaluated when all extensions have been registered. See
1121	the @@RXVT_NAME@@perl(3) manpage. Due to security reasons, this resource	1237	the @@RXVT_NAME@@perl(3) manpage.
1122	will be ignored when running setuid/setgid.
1123		1238
1124	=item B<perl-lib>: I<path>	1239	=item B<perl-lib>: I<path>
1125		1240
1126	Colon-separated list of additional directories that hold extension	1241	Colon-separated list of additional directories that hold extension
1127	scripts. When looking for extensions specified by the C<perl> resource,	1242	scripts. When looking for perl extensions, @@RXVT_NAME@@ will first look
1128	@@RXVT_NAME@@ will first look in these directories and then in	1243	in these directories, then in C<$URXVT_PERL_LIB>, F<$HOME/.urxvt/ext> and
1129	F<@@RXVT_LIBDIR@@/urxvt/perl/>. Due to security reasons, this resource	1244	lastly in F<@@RXVT_LIBDIR@@/urxvt/perl/>.
1130	will be ignored when running setuid/setgid.
1131		1245
1132	See the @@RXVT_NAME@@perl(3) manpage.	1246	See the @@RXVT_NAME@@perl(3) manpage.
1133		1247
1134	=item B<< selection.pattern-I<idx> >>: I<perl-regex>	1248	=item B<< selection.pattern-I<idx> >>: I<perl-regex>
1135		1249
…		…
1139	=item B<< selection-autotransform.I<idx> >>: I<perl-transform>	1253	=item B<< selection-autotransform.I<idx> >>: I<perl-transform>
1140		1254
1141	Selection auto-transform patterns, see the @@RXVT_NAME@@perl(3) manpage	1255	Selection auto-transform patterns, see the @@RXVT_NAME@@perl(3) manpage
1142	for details.	1256	for details.
1143		1257
1144	=item B<searchable-scrollback:> I<keysym>	1258	=item B<searchable-scrollback:> I<keysym> DEPRECATED
1145		1259
1146	Sets the hotkey that starts the incremental scrollback buffer search	1260	This resource is deprecated and will be removed. Use a B<keysym> resource
1147	(default: C<M-s>).	1261	instead, e.g.:
1148		1262
		1263	URxvt.keysym.M-s: searchable-scrollback:start
		1264
1149	=item B<urlLauncher>: I<string>	1265	=item B<url-launcher>: I<string>
1150		1266
1151	Specifies the program to be started with a URL argument. Used by the	1267	Specifies the program to be started with a URL argument. Used by the
1152	C<selection-popup> and C<mark-urls> perl extensions.	1268	C<selection-popup> and C<matcher> perl extensions.
1153		1269
1154	=item B<transient-for>: I<windowid>	1270	=item B<transient-for>: I<windowid>
1155		1271
1156	Compile I<frills>: Sets the WM_TRANSIENT_FOR property to the given window id.	1272	Compile I<frills>: Sets the WM_TRANSIENT_FOR property to the given window id.
1157		1273
1158	=item B<override-redirect>: I<boolean>	1274	=item B<override-redirect>: I<boolean>
1159		1275
1160	Compile I<frills>: Sets override-redirect for the terminal window, making	1276	Compile I<frills>: Sets override-redirect for the terminal window, making
1161	it almost invisible to window managers; option B<-override-redirect>.	1277	it almost invisible to window managers; option B<-override-redirect>.
		1278
		1279	=item B<iso14755:> I<boolean>
		1280
		1281	Turn on/off ISO 14755 (default enabled).
		1282
		1283	=item B<iso14755_52:> I<boolean>
		1284
		1285	Turn on/off ISO 14755 5.2 mode (default enabled).
		1286
		1287	=back
		1288
		1289	=head1 BACKGROUND IMAGE OPTIONS AND RESOURCES
		1290
		1291	=over 4
		1292
		1293	=item B<-pixmap> I<file[;oplist]>
		1294
		1295	=item B<backgroundPixmap:> I<file[;oplist]>
		1296
		1297	Compile I<pixbuf>: Use the specified image file as the window's
		1298	background and also optionally specify a colon separated list of
		1299	operations to modify it. Note that you may need to quote the C<;>
		1300	character when using the command line option, as C<;> is usually a
		1301	metacharacter in shells. Supported operations are:
		1302
		1303	=over 4
		1304
		1305	=item B<WxH+X+Y>
		1306
		1307	sets scale and position. B<"W" / "H"> specify the horizontal/vertical
		1308	scale (percent), and B<"X" / "Y"> locate the image centre (percent). A
		1309	scale of 0 disables scaling.
		1310
		1311	=item B<op=tile>
		1312
		1313	enables tiling
		1314
		1315	=item B<op=keep-aspect>
		1316
		1317	maintain the image aspect ratio when scaling
		1318
		1319	=item B<op=root-align>
		1320
		1321	use the position of the terminal window relative to the root window as
		1322	the image offset, simulating a root window background
		1323
		1324	=back
		1325
		1326	The default scale and position setting is C<100x100+50+50>.
		1327	Alternatively, a predefined set of templates can be used to achieve
		1328	the most common setups:
		1329
		1330	=over 4
		1331
		1332	=item B<style=tiled>
		1333
		1334	the image is tiled with no scaling. Equivalent to 0x0+0+0:op=tile
		1335
		1336	=item B<style=aspect-stretched>
		1337
		1338	the image is scaled to fill the whole window maintaining the aspect
		1339	ratio and centered. Equivalent to 100x100+50+50:op=keep-aspect
		1340
		1341	=item B<style=stretched>
		1342
		1343	the image is scaled to fill the whole window. Equivalent to 100x100
		1344
		1345	=item B<style=centered>
		1346
		1347	the image is centered with no scaling. Equivalent to 0x0+50+50
		1348
		1349	=item B<style=root-tiled>
		1350
		1351	the image is tiled with no scaling and using 'root' positioning.
		1352	Equivalent to 0x0:op=tile:op=root-align
		1353
		1354	=back
		1355
		1356	If multiple templates are specified the last one wins. Note that a
		1357	template overrides all the scale, position and operations settings.
		1358
		1359	If used in conjunction with pseudo-transparency, the specified pixmap
		1360	will be blended over the transparent background using alpha-blending.
		1361
		1362	=item B<-tr>\|B<+tr>
		1363
		1364	=item B<transparent:> I<boolean>
		1365
		1366	Turn on/off pseudo-transparency by using the root pixmap as background.
		1367
		1368	B<-ip> (B<inheritPixmap>) is still accepted as an obsolete alias but
		1369	will be removed in future versions.
		1370
		1371	=item B<-tint> I<colour>
		1372
		1373	=item B<tintColor:> I<colour>
		1374
		1375	Tint the transparent background with the given colour. Note that a
		1376	black tint yields a completely black image while a white tint yields
		1377	the image unchanged.
		1378
		1379	=item B<-sh> I<number>
		1380
		1381	=item B<shading:> I<number>
		1382
		1383	Darken (0 .. 99) or lighten (101 .. 200) the transparent background.
		1384	A value of 100 means no shading.
		1385
		1386	=item B<-blr> I<HxV>
		1387
		1388	=item B<blurRadius:> I<HxV>
		1389
		1390	Apply gaussian blur with the specified radius to the transparent
		1391	background. If a single number is specified, the vertical and
		1392	horizontal radii are considered to be the same. Setting one of the
		1393	radii to 1 and the other to a large number creates interesting effects
		1394	on some backgrounds. The maximum radius value is 128. An horizontal or
		1395	vertical radius of 0 disables blurring.
		1396
		1397	=item B<path:> I<path>
		1398
		1399	Specify the colon-delimited search path for finding background image files.
1162		1400
1163	=back	1401	=back
1164		1402
1165	=head1 THE SCROLLBAR	1403	=head1 THE SCROLLBAR
1166		1404
…		…
1185	application. Instead, pressing Button1 and Button3 sends B<ESC [ 6 ~>	1423	application. Instead, pressing Button1 and Button3 sends B<ESC [ 6 ~>
1186	(Next) and B<ESC [ 5 ~> (Prior), respectively. Similarly, clicking on the	1424	(Next) and B<ESC [ 5 ~> (Prior), respectively. Similarly, clicking on the
1187	up and down arrows sends B<ESC [ A> (Up) and B<ESC [ B> (Down),	1425	up and down arrows sends B<ESC [ A> (Up) and B<ESC [ B> (Down),
1188	respectively.	1426	respectively.
1189		1427
1190	=head1 TEXT SELECTION AND INSERTION	1428	=head1 THE SELECTION: SELECTING AND PASTING TEXT
1191		1429
1192	The behaviour of text selection and insertion mechanism is similar to	1430	The behaviour of text selection and insertion/pasting mechanism is similar
1193	I<xterm>(1).	1431	to I<xterm>(1).
1194		1432
1195	=over 4	1433	=over 4
1196		1434
1197	=item B<Selection>:	1435	=item B<Selecting>:
1198		1436
1199	Left click at the beginning of the region, drag to the end of the region	1437	Left click at the beginning of the region, drag to the end of the region
1200	and release; Right click to extend the marked region; Left double-click	1438	and release; Right click to extend the marked region; Left double-click
1201	to select a word; Left triple-click to select the entire logical line	1439	to select a word; Left triple-click to select the entire logical line
1202	(which can span multiple screen lines), unless modified by resource	1440	(which can span multiple screen lines), unless modified by resource
…		…
1206	(Compile: I<frills>) will create a rectangular selection instead of a	1444	(Compile: I<frills>) will create a rectangular selection instead of a
1207	normal one. In this mode, every selected row becomes its own line in the	1445	normal one. In this mode, every selected row becomes its own line in the
1208	selection, and trailing whitespace is visually underlined and removed from	1446	selection, and trailing whitespace is visually underlined and removed from
1209	the selection.	1447	the selection.
1210		1448
1211	=item B<Insertion>:	1449	=item B<Pasting>:
1212		1450
1213	Pressing and releasing the Middle mouse button in an B<@@RXVT_NAME@@>	1451	Pressing and releasing the Middle mouse button in an B<@@RXVT_NAME@@>
1214	window causes the value of the PRIMARY selection (or CLIPBOARD with the	1452	window causes the value of the PRIMARY selection (or CLIPBOARD with the
1215	Meta modifier) to be inserted as if it had been typed on the keyboard.	1453	B<Meta> modifier) to be inserted as if it had been typed on the keyboard.
1216		1454
1217	Pressing B<Shift-Insert> causes the value of the PRIMARY selection to be	1455	Pressing B<Shift-Insert> causes the value of the PRIMARY selection to be
1218	inserted too.	1456	inserted too.
1219		1457
		1458	rxvt-unicode also provides the bindings B<Ctrl-Meta-c> and
		1459	<Ctrl-Meta-v> to interact with the CLIPBOARD selection. The first
		1460	binding causes the value of the internal selection to be copied to the
		1461	CLIPBOARD selection, while the second binding causes the value of the
		1462	CLIPBOARD selection to be inserted.
		1463
1220	=back	1464	=back
1221		1465
1222	=head1 CHANGING FONTS	1466	=head1 CHANGING FONTS
1223		1467
1224	Changing fonts (or font sizes, respectively) via the keypad is not yet	1468	Changing fonts (or font sizes, respectively) via the keypad is not yet
…		…
1237		1481
1238	=head1 ISO 14755 SUPPORT	1482	=head1 ISO 14755 SUPPORT
1239		1483
1240	ISO 14755 is a standard for entering and viewing unicode characters	1484	ISO 14755 is a standard for entering and viewing unicode characters
1241	and character codes using the keyboard. It consists of 4 parts. The	1485	and character codes using the keyboard. It consists of 4 parts. The
1242	first part is available rxvt-unicode has been compiled with	1486	first part is available if rxvt-unicode has been compiled with
1243	C<--enable-frills>, the rest is available when rxvt-unicode was compiled	1487	C<--enable-frills>, the rest is available when rxvt-unicode was compiled
1244	with C<--enable-iso14755>.	1488	with C<--enable-iso14755>.
1245		1489
1246	=over 4	1490	=over 4
1247		1491
…		…
1267	This mode lets you input characters representing the keycap symbols of	1511	This mode lets you input characters representing the keycap symbols of
1268	your keyboard, if representable in the current locale encoding.	1512	your keyboard, if representable in the current locale encoding.
1269		1513
1270	Start by pressing C<Control> and C<Shift> together, then releasing	1514	Start by pressing C<Control> and C<Shift> together, then releasing
1271	them. The next special key (cursor keys, home etc.) you enter will not	1515	them. The next special key (cursor keys, home etc.) you enter will not
1272	invoke it's usual function but instead will insert the corresponding	1516	invoke its usual function but instead will insert the corresponding
1273	keycap symbol. The symbol will only be entered when the key has been	1517	keycap symbol. The symbol will only be entered when the key has been
1274	released, otherwise pressing e.g. C<Shift> would enter the symbol for	1518	released, otherwise pressing e.g. C<Shift> would enter the symbol for
1275	C<ISO Level 2 Switch>, although your intention might have been to enter a	1519	C<ISO Level 2 Switch>, although your intention might have been to enter a
1276	reverse tab (Shift-Tab).	1520	reverse tab (Shift-Tab).
1277		1521
…		…
1305	B<@@RXVT_NAME@@> tries to write an entry into the I<utmp>(5) file so that	1549	B<@@RXVT_NAME@@> tries to write an entry into the I<utmp>(5) file so that
1306	it can be seen via the I<who(1)> command, and can accept messages. To	1550	it can be seen via the I<who(1)> command, and can accept messages. To
1307	allow this feature, B<@@RXVT_NAME@@> may need to be installed setuid root	1551	allow this feature, B<@@RXVT_NAME@@> may need to be installed setuid root
1308	on some systems or setgid to root or to some other group on others.	1552	on some systems or setgid to root or to some other group on others.
1309		1553
1310	=head1 COLORS AND GRAPHICS	1554	=head1 COLOURS AND GRAPHICS
1311		1555
1312	In addition to the default foreground and background colours,	1556	In addition to the default foreground and background colours,
1313	B<@@RXVT_NAME@@> can display up to 16 colours (8 ANSI colours plus	1557	B<@@RXVT_NAME@@> can display up to 88/256 colours: 8 ANSI colours plus
1314	high-intensity bold/blink versions of the same). Here is a list of the	1558	high-intensity (potentially bold/blink) versions of the same, and 72 (or
1315	colours with their names.	1559	240 in 256 colour mode) colours arranged in an 4x4x4 (or 6x6x6) colour RGB
		1560	cube plus a 8 (24) colour greyscale ramp.
		1561
		1562	Here is a list of the ANSI colours with their names.
1316		1563
1317	=begin table	1564	=begin table
1318		1565
1319	B<color0> (black) = Black	1566	B<color0> (black) = Black
1320	B<color1> (red) = Red3	1567	B<color1> (red) = Red3
…		…
1340	It is also possible to specify the colour values of B<foreground>,	1587	It is also possible to specify the colour values of B<foreground>,
1341	B<background>, B<cursorColor>, B<cursorColor2>, B<colorBD>, B<colorUL> as	1588	B<background>, B<cursorColor>, B<cursorColor2>, B<colorBD>, B<colorUL> as
1342	a number 0-15, as a convenient shorthand to reference the colour name of	1589	a number 0-15, as a convenient shorthand to reference the colour name of
1343	color0-color15.	1590	color0-color15.
1344		1591
1345	If Xft support has been compiled in and as long as Xft/Xrender/X don't get	1592	The following text gives values for the standard 88 colour mode (and
1346	their act together, rxvt-unicode will support C<rgba:rrrr/gggg/bbbb/aaaa>	1593	values for the 256 colour mode in parentheses).
1347	(recommended, but B<MUST> have 4 digits/component), C<#ARGB>, C<#AARRGGBB>	1594
1348	and C<#AAAARRRRGGGGBBBB> colour specifications, in addition to the ones	1595	The RGB cube uses indices 16..79 (16..231) using the following formulas:
1349	provided by X, where the additional A component specifies alpha (opacity)	1596
1350	values (0 is completely transparent and the maximum is opaque). You	1597	index_88 = (r * 4 + g) * 4 + b + 16 # r, g, b = 0..3
1351	probably need to specify B<"-depth 32">, too, and have the luck that your	1598	index_256 = (r * 6 + g) * 6 + b + 16 # r, g, b = 0..5
1352	X-server uses ARGB pixel layout, as X is far from just supporting ARGB	1599
1353	visuals out of the box, and rxvt-unicode just fudges around.	1600	The grayscale ramp uses indices 80..87 (232..239), from 10% to 90% in 10%
		1601	steps (1/26 to 25/26 in 1/26 steps) - black and white are already part of
		1602	the RGB cube.
		1603
		1604	Together, all those colours implement the 88 (256) colour xterm
		1605	colours. Only the first 16 can be changed using resources currently, the
		1606	rest can only be changed via command sequences ("escape codes").
		1607
		1608	Applications are advised to use terminfo or command sequences to discover
		1609	number and RGB values of all colours (yes, you can query this...).
1354		1610
1355	Note that B<-rv> (B<"reverseVideo: True">) simulates reverse video by	1611	Note that B<-rv> (B<"reverseVideo: True">) simulates reverse video by
1356	always swapping the foreground/background colours. This is in contrast to	1612	always swapping the foreground/background colours. This is in contrast to
1357	I<xterm>(1) where the colours are only swapped if they have not otherwise	1613	I<xterm>(1) where the colours are only swapped if they have not otherwise
1358	been specified. For example,	1614	been specified. For example,
1359		1615
		1616	@@RXVT_NAME@@ -fg Black -bg White -rv
		1617
		1618	would yield White on Black, while on I<xterm>(1) it would yield Black on
		1619	White.
		1620
		1621	=head2 ALPHA CHANNEL SUPPORT
		1622
		1623	If Xft support has been compiled in and as long as Xft/Xrender/X don't get
		1624	their act together, rxvt-unicode will do its own alpha channel management:
		1625
		1626	You can prefix any colour with an opaqueness percentage enclosed in
		1627	brackets, i.e. C<[percent]>, where C<percent> is a decimal percentage
		1628	(0-100) that specifies the opacity of the colour, where C<0> is completely
		1629	transparent and C<100> is completely opaque. For example, C<[50]red> is a
		1630	half-transparent red, while C<[95]#00ff00> is an almost opaque green. This
		1631	is the recommended format to specify transparency values, and works with
		1632	all ways to specify a colour.
		1633
		1634	For complete control, rxvt-unicode also supports
		1635	C<rgba:rrrr/gggg/bbbb/aaaa> (exactly four hex digits/component) colour
		1636	specifications, where the additional C<aaaa> component specifies opacity
		1637	(alpha) values. The minimum value of C<0000> is completely transparent,
		1638	while C<ffff> is completely opaque). The two example colours from
		1639	earlier could also be specified as C<rgba:ff00/0000/0000/8000> and
		1640	C<rgba:0000/ff00/0000/f332>.
		1641
		1642	You probably need to specify B<"-depth 32">, too, to force a visual with
		1643	alpha channels, and have the luck that your X-server uses ARGB pixel
		1644	layout, as X is far from just supporting ARGB visuals out of the box, and
		1645	rxvt-unicode just fudges around.
		1646
		1647	For example, the following selects an almost completely transparent black
		1648	background, and an almost opaque pink foreground:
		1649
		1650	@@RXVT_NAME@@ -depth 32 -bg rgba:0000/0000/0000/4444 -fg "[80]pink"
		1651
		1652	When not using a background image, then the interpretation of the
		1653	alpha channel is up to your compositing manager (most interpret it as
		1654	transparency of course).
		1655
		1656	When using a background pixmap or pseudo-transparency, then the background
		1657	colour will always behave as if it were completely transparent (so the
		1658	background image shows instead), regardless of how it was specified, while
		1659	other colours will either be transparent as specified (the background
		1660	image will show through) on servers supporting the RENDER extension, or
		1661	fully opaque on servers not supporting the RENDER EXTENSION.
		1662
		1663	Please note that due to bugs in Xft, specifying alpha values might result
		1664	in garbage being displayed when the X-server does not support the RENDER
		1665	extension.
		1666
		1667	=head1 ENVIRONMENT
		1668
		1669	B<@@RXVT_NAME@@> sets and/or uses the following environment variables:
		1670
1360	=over 4	1671	=over 4
1361		1672
1362	=item B<@@RXVT_NAME@@ -fg Black -bg White -rv>
1363
1364	would yield White on Black, while on I<xterm>(1) it would yield Black
1365	on White.
1366
1367	=back
1368
1369	=head1 ENVIRONMENT
1370
1371	B<@@RXVT_NAME@@> sets and/or uses the following environment variables:
1372
1373	=over 4
1374
1375	=item B<TERM>	1673	=item B<TERM>
1376		1674
1377	Normally set to C<rxvt-unicode>, unless overwritten at configure time, via	1675	Normally set to C<rxvt-unicode>, unless overwritten at configure time, via
1378	resources or on the commandline.	1676	resources or on the command line.
1379		1677
1380	=item B<COLORTERM>	1678	=item B<COLORTERM>
1381		1679
1382	Either C<rxvt>, C<rxvt-xpm>, depending on wether @@RXVT_NAME@@ was	1680	Either C<rxvt>, C<rxvt-xpm>, depending on whether @@RXVT_NAME@@ was
1383	compiled with XPM support, and optionally with the added extension	1681	compiled with background image support, and optionally with the added
1384	C<-mono> to indicate that rxvt-unicode runs on a monochrome screen.	1682	extension C<-mono> to indicate that rxvt-unicode runs on a monochrome
		1683	screen.
1385		1684
1386	=item B<COLORFGBG>	1685	=item B<COLORFGBG>
1387		1686
1388	Set to a string of the form C<fg;bg> or C<fg;xpm;bg>, where C<fg> is	1687	Set to a string of the form C<fg;bg> or C<fg;xpm;bg>, where C<fg> is
1389	the colour code used as default foreground/text colour (or the string	1688	the colour code used as default foreground/text colour (or the string
1390	C<default> to indicate that the default-colour escape sequence is to be	1689	C<default> to indicate that the default-colour escape sequence is to be
1391	used), C<bg> is the colour code used as default background colour (or the	1690	used), C<bg> is the colour code used as default background colour (or the
1392	string C<default>), and C<xpm> is the string C<default> if @@RXVT_NAME@@	1691	string C<default>), and C<xpm> is the string C<default> if @@RXVT_NAME@@
1393	was compiled with XPM support. Libraries like C<ncurses> and C<slang> can	1692	was compiled with background image support. Libraries like C<ncurses>
1394	(and do) use this information to optimize screen output.	1693	and C<slang> can (and do) use this information to optimize screen output.
1395		1694
1396	=item B<WINDOWID>	1695	=item B<WINDOWID>
1397		1696
1398	Set to the (decimal) X Window ID of the @@RXVT_NAME@@ window (the toplevel	1697	Set to the (decimal) X Window ID of the @@RXVT_NAME@@ window (the toplevel
1399	window, which usually has subwindows for the scrollbar, the terminal	1698	window, which usually has subwindows for the scrollbar, the terminal
…		…
1405	C<--with-terminfo=PATH>.	1704	C<--with-terminfo=PATH>.
1406		1705
1407	=item B<DISPLAY>	1706	=item B<DISPLAY>
1408		1707
1409	Used by @@RXVT_NAME@@ to connect to the display and set to the correct	1708	Used by @@RXVT_NAME@@ to connect to the display and set to the correct
1410	display in it's child processes.	1709	display in its child processes if C<-display> isn't used to override. It
		1710	defaults to C<:0> if it doesn't exist.
1411		1711
1412	=item B<SHELL>	1712	=item B<SHELL>
1413		1713
1414	The shell to be used for command execution, defaults to C</bin/sh>.	1714	The shell to be used for command execution, defaults to C</bin/sh>.
1415		1715
1416	=item B<RXVT_SOCKET>	1716	=item B<RXVT_SOCKET> [I<sic>]
1417		1717
1418	The unix domain socket path used by @@RXVT_NAME@@c(1) and	1718	The unix domain socket path used by @@RXVT_NAME@@c(1) and
1419	@@RXVT_NAME@@d(1).	1719	@@RXVT_NAME@@d(1).
1420		1720
1421	Default F<<< $HOME/.rxvt-unicode-I<< <nodename >> >>>.	1721	Default F<<< $HOME/.urxvt/urxvtd-I<< <nodename> >> >>>.
		1722
		1723	=item B<URXVT_PERL_LIB>
		1724
		1725	Additional F<:>-separated library search path for perl extensions. Will be
		1726	searched after B<-perl-lib> but before F<~/.urxvt/ext> and the system library
		1727	directory.
		1728
		1729	=item B<URXVT_PERL_VERBOSITY>
		1730
		1731	See L<@@RXVT_NAME@@perl>(3).
1422		1732
1423	=item B<HOME>	1733	=item B<HOME>
1424		1734
1425	Used to locate the default directory for the unix domain socket for	1735	Used to locate the default directory for the unix domain socket for
1426	daemon communications and to locate various resource files (such as	1736	daemon communications and to locate various resource files (such as
1427	C<.Xdefaults>)	1737	C<.Xdefaults>)
1428		1738
1429	=item B<XAPPLRESDIR>	1739	=item B<XAPPLRESDIR>
1430		1740
1431	Directory where various X resource files are being located.	1741	Directory where application-specific X resource files are located.
1432		1742
1433	=item B<XENVIRONMENT>	1743	=item B<XENVIRONMENT>
1434		1744
1435	If set and accessible, gives the name of a X resource file to be loaded by	1745	If set and accessible, gives the name of a X resource file to be loaded by
1436	@@RXVT_NAME@@.	1746	@@RXVT_NAME@@.
…		…
1441		1751
1442	=over 4	1752	=over 4
1443		1753
1444	=item B</usr/lib/X11/rgb.txt>	1754	=item B</usr/lib/X11/rgb.txt>
1445		1755
1446	Color names.	1756	Colour names.
1447		1757
1448	=back	1758	=back
1449		1759
1450	=head1 SEE ALSO	1760	=head1 SEE ALSO
1451		1761
		1762	@@RXVT_NAME@@(7), @@RXVT_NAME@@c(1), @@RXVT_NAME@@d(1), @@RXVT_NAME@@-extensions(1),
1452	@@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)	1763	@@RXVT_NAME@@perl(3), xterm(1), sh(1), resize(1), X(1), pty(4), tty(4), utmp(5)
1453		1764
1454	=head1 CURRENT PROJECT COORDINATOR	1765	=head1 CURRENT PROJECT COORDINATOR
1455		1766
1456	=over 4	1767	=over 4
1457		1768
1458	=item Project Coordinator	1769	=item Project Coordinator
1459		1770
1460	Marc A. Lehmann L<< <rxvt-unicode@schmorp.de> >>	1771	Marc A. Lehmann <rxvt-unicode@schmorp.de>.
1461		1772
1462	L<http://software.schmorp.de/#rxvt-unicode>	1773	L<http://software.schmorp.de/pkg/rxvt-unicode.html>
1463		1774
1464	=back	1775	=back
1465		1776
1466	=head1 AUTHORS	1777	=head1 AUTHORS
1467		1778
…		…
1469		1780
1470	=item John Bovey	1781	=item John Bovey
1471		1782
1472	University of Kent, 1992, wrote the original Xvt.	1783	University of Kent, 1992, wrote the original Xvt.
1473		1784
1474	=item Rob Nation L<< <nation@rocket.sanders.lockheed.com> >>	1785	=item Rob Nation <nation@rocket.sanders.lockheed.com>
1475		1786
1476	very heavily modified Xvt and came up with Rxvt	1787	very heavily modified Xvt and came up with Rxvt
1477		1788
1478	=item Angelo Haritsis L<< <ah@doc.ic.ac.uk> >>	1789	=item Angelo Haritsis <ah@doc.ic.ac.uk>
1479		1790
1480	wrote the Greek Keyboard Input (no longer in code)	1791	wrote the Greek Keyboard Input (no longer in code)
1481		1792
1482	=item mj olesen L<< <olesen@me.QueensU.CA> >>	1793	=item mj olesen <olesen@me.QueensU.CA>
1483		1794
1484	Wrote the menu system.	1795	Wrote the menu system.
1485		1796
1486	Project Coordinator (changes.txt 2.11 to 2.21)	1797	Project Coordinator (changes.txt 2.11 to 2.21)
1487		1798
1488	=item Oezguer Kesim L<< <kesim@math.fu-berlin.de> >>	1799	=item Oezguer Kesim <kesim@math.fu-berlin.de>
1489		1800
1490	Project Coordinator (changes.txt 2.21a to 2.4.5)	1801	Project Coordinator (changes.txt 2.21a to 2.4.5)
1491		1802
1492	=item Geoff Wing L<< <gcw@pobox.com> >>	1803	=item Geoff Wing <gcw@pobox.com>
1493		1804
1494	Rewrote screen display and text selection routines.	1805	Rewrote screen display and text selection routines.
1495		1806
1496	Project Coordinator (changes.txt 2.4.6 - rxvt-unicode)	1807	Project Coordinator (changes.txt 2.4.6 - rxvt-unicode)
1497		1808
1498	=item Marc Alexander Lehmann L<< <rxvt-unicode@schmorp.de> >>	1809	=item Marc Alexander Lehmann <rxvt-unicode@schmorp.de>
1499		1810
1500	Forked rxvt-unicode, unicode support, rewrote almost all the code, perl	1811	Forked rxvt-unicode, unicode support, rewrote almost all the code, perl
1501	extension, random hacks, numerous bugfixes and extensions.	1812	extension, random hacks, numerous bugfixes and extensions.
1502		1813
1503	Project Coordinator (Changes 1.0 -)	1814	Project Coordinator (Changes 1.0 -)
1504		1815
1505	=item Emanuele Giaquinta L<< <e.giaquinta@glauco.it> >>	1816	=item Emanuele Giaquinta <emanuele.giaquinta@gmail.com>
1506		1817
1507	Pty/tty/utmp/wtmp rewrite, lots of random hacking and bugfixing.	1818	pty/utmp code rewrite, image code improvements, many random hacks and bugfixes.
1508		1819
1509	=back	1820	=back
1510		1821

Diff Legend

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

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents): Revision 1.109 by root, Sun Jan 29 22:27:04 2006 UTC vs. Revision 1.232 by root, Sun May 18 18:19:10 2014 UTC

Diff Legend

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents):
Revision 1.109 by root, Sun Jan 29 22:27:04 2006 UTC vs.
Revision 1.232 by root, Sun May 18 18:19:10 2014 UTC