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.48 by root, Thu Feb 3 10:24:10 2005 UTC vs.
Revision 1.257 by root, Mon Nov 22 17:01:05 2021 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 frequently	22	See @@RXVT_NAME@@(7) (try C<man 7 @@RXVT_NAME@@>) for a list of
20	asked questions and answer to them and some common problems.	23	frequently asked questions and answer to them and some common
		24	problems. That document is also accessible on the World-Wide-Web at
		25	L<http://pod.tst.eu/http://cvs.schmorp.de/rxvt-unicode/doc/rxvt.7.pod>.
21		26
22	=head1 RXVT-UNICODE VS. RXVT	27	=head1 RXVT-UNICODE VS. RXVT
23		28
24	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
25	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
26	world. Being a terminal emulator, however, some things are very difficult,	31	world. Being a terminal emulator, however, some things are very difficult,
27	especially cursive scripts such as arabic, vertically written scripts	32	especially cursive scripts such as arabic, vertically written scripts
28	like mongolian or scripts requiring extremely complex combining rules,	33	like mongolian or scripts requiring extremely complex combining rules,
29	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
30	scripts. Most other scripts, latin, cyrillic, kanji, thai etc. should work	35	scripts. Most other scripts, latin, cyrillic, kanji, thai etc. should work
31	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
32	as hebrew: B<rxvt-unicode> adopts the view that bidirectional algorithms	37	as hebrew: B<rxvt-unicode> adopts the view that bidirectional algorithms
33	belong into the application, not the terminal emulator (too many things --	38	belong in the application, not the terminal emulator (too many things --
34	such as cursor-movement while editing -- break otherwise), but that might	39	such as cursor-movement while editing -- break otherwise), but that might
35	change.	40	change.
36		41
37	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
38	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
39	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
40	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
41	another for japanese.	46	another for japanese.
42		47
43	Therefore another design rationale was the use of multiple fonts to	48	Therefore another design rationale was the use of multiple fonts to
44	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
45	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
46	to choose any font for any script freely.	51	to choose any font for any script freely.
47		52
48	Apart from that, rxvt-unicode is also much better internationalised than	53	Apart from that, rxvt-unicode is also much better internationalised than
49	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
50	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
51	rxvt. This all in addition to dozens of other small improvements.	56	rxvt. This all in addition to dozens of other small improvements.
52		57
53	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
54	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
55	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
56	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
57	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
58	drastically reduces memory usage. See @@RXVT_NAME@@d(1) (daemon) and	63	drastically reduces memory usage. See @@RXVT_NAME@@d(1) (daemon) and
59	@@RXVT_NAME@@c(1) (client).	64	@@RXVT_NAME@@c(1) (client).
60		65
61	It also makes technical information about escape sequences (which have	66	It also makes technical information about escape sequences (which have
62	been extended) easier accessible: see @@RXVT_NAME@@(7) for technical	67	been extended) more accessible: see @@RXVT_NAME@@(7) for technical
63	reference documentation (escape sequences etc.).	68	reference documentation (escape sequences etc.).
64		69
65	=head1 OPTIONS	70	=head1 OPTIONS
66		71
67	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
…		…
79	far greater than those listed. For example: `@@RXVT_NAME@@ --loginShell --color1	84	far greater than those listed. For example: `@@RXVT_NAME@@ --loginShell --color1
80	Orange'.	85	Orange'.
81		86
82	The following options are available:	87	The following options are available:
83		88
84	=over 4	89	=over
85		90
86	=item B<-help>, B<--help>	91	=item B<-help>, B<--help>
87		92
88	Print out a message describing available options.	93	Print out a message describing available options.
89		94
90	=item B<-display> I<displayname>	95	=item B<-display> I<displayname>
91		96
92	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>
93	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
94	B<DISPLAY> environment variable is used.	99	display specified by the B<DISPLAY> environment variable is used.
		100
		101	=item B<-depth> I<bitdepth>
		102
		103	Compile I<frills>: Attempt to find a visual with the given bit depth;
		104	resource B<depth>.
		105
		106	[Please note that many X servers (and libXft) are buggy with
		107	respect to C<-depth 32> and/or alpha channels, and will cause all sorts
		108	of graphical corruption. This is harmless, but we can't do anything about
		109	this, so watch out]
		110
		111	=item B<-visual> I<visualID>
		112
		113	Compile I<frills>: Use the given visual (see e.g. C<xdpyinfo> for
		114	possible visual ids) instead of the default, and also allocate a private
		115	colormap. All visual types except for DirectColor are supported.
95		116
96	=item B<-geometry> I<geom>	117	=item B<-geometry> I<geom>
97		118
98	Window geometry (B<-g> still respected); resource B<geometry>.	119	Window geometry (B<-g> still respected); resource B<geometry>.
99		120
…		…
101		122
102	Turn on/off simulated reverse video; resource B<reverseVideo>.	123	Turn on/off simulated reverse video; resource B<reverseVideo>.
103		124
104	=item B<-j>|B<+j>	125	=item B<-j>|B<+j>
105		126
106	Turn on/off jump scrolling; resource B<jumpScroll>.	127	Turn on/off jump scrolling (allow multiple lines per refresh); resource B<jumpScroll>.
107		128
108	=item B<-ip>|B<+ip>	129	=item B<-ss>|B<+ss>
109		130
110	Turn on/off inheriting parent window's pixmap. Alternative form is	131	Turn on/off skip scrolling (allow multiple screens per refresh); resource B<skipScroll>.
111	B<-tr>; resource B<inheritPixmap>.
112		132
113	=item B<-fade> I<number>	133	=item B<-fade> I<number>
114		134
115	Fade the text by the given percentage when focus is lost. resource B<fading>.	135	Fade the text by the given percentage when focus is lost. Small values
		136	fade a little only, 100 completely replaces all colours by the fade
		137	colour; resource B<fading>.
116		138
117	=item B<-tint> I<colour>	139	=item B<-fadecolor> I<colour>
118		140
119	Tint the transparent background pixmap with the given colour when	141	Fade to this colour when fading is used (see B<-fade>). The default colour
120	transparency is enabled with B<-tr> or B<-ip>. See also the B<-sh>	142	is opaque black. resource B<fadeColor>.
121	option that can be used to brighten or darken the image in addition to
122	tinting it.
123		143
124	=item B<-sh>	144	=item B<-icon> I<file>
125		145
126	I<number> Darken (0 .. 100) or lighten (-1 .. -100) the transparent	146	Compile I<pixbuf>: Use the specified image as application icon. This
127	background image in addition to tinting it (i.e. B<-tint> must be	147	is used by many window managers, taskbars and pagers to represent the
128	specified, too, e.g. C<-tint white>).	148	application window; resource I<iconFile>.
129		149
130	=item B<-bg> I<colour>	150	=item B<-bg> I<colour>
131		151
132	Window background colour; resource B<background>.	152	Window background colour; resource B<background>.
133		153
134	=item B<-fg> I<colour>	154	=item B<-fg> I<colour>
135		155
136	Window foreground colour; resource B<foreground>.	156	Window foreground colour; resource B<foreground>.
137
138	=item B<-pixmap> I<file[;geom]>
139
140	Compile I<XPM>: Specify XPM file for the background and also optionally
141	specify its scaling with a geometry string. Note you may need to
142	add quotes to avoid special shell interpretation of the C<;> in the
143	command-line; resource B<backgroundPixmap>.
144		157
145	=item B<-cr> I<colour>	158	=item B<-cr> I<colour>
146		159
147	The cursor colour; resource B<cursorColor>.	160	The cursor colour; resource B<cursorColor>.
148		161
…		…
160	resource B<borderColor>.	173	resource B<borderColor>.
161		174
162	=item B<-fn> I<fontlist>	175	=item B<-fn> I<fontlist>
163		176
164	Select the fonts to be used. This is a comma separated list of font names	177	Select the fonts to be used. This is a comma separated list of font names
165	that are used in turn when trying to display Unicode characters. The	178	that are checked in order when trying to find glyphs for characters. The
166	first font defines the cell size for characters; other fonts might be	179	first font defines the cell size for characters; other fonts might be
167	smaller, but not (in general) larger. A (hopefully) reasonable default	180	smaller, but not (in general) larger. A (hopefully) reasonable default
168	font list is always appended to it. See resource B<font> for more details.	181	font list is always appended to it. See resource B<font> for more details.
169		182
170	In short, to specify an X11 core font, just specify it's name or prefix it	183	In short, to specify an X11 core font, just specify its name or prefix it
171	with C<x:>. To specify an XFT-font, you need to prefix it with C<xft:>,	184	with C<x:>. To specify an XFT-font, you need to prefix it with C<xft:>,
172	e.g.:	185	e.g.:
173		186
174	@@RXVT_NAME@@ -fn "xft:Bitstream Vera Sans Mono:pixelsize=15"	187	@@RXVT_NAME@@ -fn "xft:Bitstream Vera Sans Mono:pixelsize=15"
175	@@RXVT_NAME@@ -fn "9x15bold,xft:Bitstream Vera Sans Mono"	188	@@RXVT_NAME@@ -fn "9x15bold,xft:Bitstream Vera Sans Mono"
…		…
177	See also the question "How does rxvt-unicode choose fonts?" in the FAQ	190	See also the question "How does rxvt-unicode choose fonts?" in the FAQ
178	section of @@RXVT_NAME@@(7).	191	section of @@RXVT_NAME@@(7).
179		192
180	=item B<-fb> I<fontlist>	193	=item B<-fb> I<fontlist>
181		194
182	Compile font-styles: The bold font list to use when bold characters are to	195	Compile I<font-styles>: The bold font list to use when B<bold> characters
183	be printed. See resource B<boldFont> for details.	196	are to be printed. See resource B<boldFont> for details.
184		197
185	=item B<-fi> I<fontlist>	198	=item B<-fi> I<fontlist>
186		199
187	Compile font-styles: The italic font list to use when bold characters are to	200	Compile I<font-styles>: The italic font list to use when I<italic>
188	be printed. See resource B<italicFont> for details.	201	characters are to be printed. See resource B<italicFont> for details.
189		202
190	=item B<-fbi> I<fontlist>	203	=item B<-fbi> I<fontlist>
191		204
192	Compile font-styles: The bold italic font list to use when bold characters are to	205	Compile I<font-styles>: The bold italic font list to use when B<< I<bold
193	be printed. See resource B<boldItalicFont> for details.	206	italic> >> characters are to be printed. See resource B<boldItalicFont>
		207	for details.
		208
		209	=item B<-is>|B<+is>
		210
		211	Compile I<font-styles>: Bold/Blink font styles imply high intensity
		212	foreground/background (default). See resource B<intensityStyles> for
		213	details.
194		214
195	=item B<-name> I<name>	215	=item B<-name> I<name>
196		216
197	Specify the application name under which resources are to be obtained,	217	Specify the application name under which resources are to be obtained,
198	rather than the default executable file name. Name should not contain	218	rather than the default executable file name. Name should not contain
…		…
200		220
201	=item B<-ls>|B<+ls>	221	=item B<-ls>|B<+ls>
202		222
203	Start as a login-shell/sub-shell; resource B<loginShell>.	223	Start as a login-shell/sub-shell; resource B<loginShell>.
204		224
		225	=item B<-mc> I<milliseconds>
		226
		227	Specify the maximum time between multi-click selections.
		228
205	=item B<-ut>|B<+ut>	229	=item B<-ut>|B<+ut>
206		230
207	Compile I<utmp>: Inhibit/enable writing a utmp entry; resource	231	Compile I<utmp>: Inhibit/enable writing a utmp entry; resource
208	B<utmpInhibit>.	232	B<utmpInhibit>.
209		233
…		…
213	B<visualBell>.	237	B<visualBell>.
214		238
215	=item B<-sb>|B<+sb>	239	=item B<-sb>|B<+sb>
216		240
217	Turn on/off scrollbar; resource B<scrollBar>.	241	Turn on/off scrollbar; resource B<scrollBar>.
		242
		243	=item B<-sr>|B<+sr>
		244
		245	Put scrollbar on right/left; resource B<scrollBar_right>.
		246
		247	=item B<-st>|B<+st>
		248
		249	Display rxvt (non XTerm/NeXT) scrollbar without/with a trough;
		250	resource B<scrollBar_floating>.
218		251
219	=item B<-si>|B<+si>	252	=item B<-si>|B<+si>
220		253
221	Turn on/off scroll-to-bottom on TTY output inhibit; resource	254	Turn on/off scroll-to-bottom on TTY output inhibit; resource
222	B<scrollTtyOutput> has opposite effect.	255	B<scrollTtyOutput> has opposite effect.
…		…
229	=item B<-sw>|B<+sw>	262	=item B<-sw>|B<+sw>
230		263
231	Turn on/off scrolling with the scrollback buffer as new lines appear.	264	Turn on/off scrolling with the scrollback buffer as new lines appear.
232	This only takes effect if B<-si> is also given; resource	265	This only takes effect if B<-si> is also given; resource
233	B<scrollWithBuffer>.	266	B<scrollWithBuffer>.
234
235	=item B<-sr>|B<+sr>
236
237	Put scrollbar on right/left; resource B<scrollBar_right>.
238
239	=item B<-st>|B<+st>
240
241	Display normal (non XTerm/NeXT) scrollbar without/with a trough;
242	resource B<scrollBar_floating>.
243		267
244	=item B<-ptab>|B<+ptab>	268	=item B<-ptab>|B<+ptab>
245		269
246	If enabled (default), "Horizontal Tab" characters are being stored as	270	If enabled (default), "Horizontal Tab" characters are being stored as
247	actual wide characters in the screen buffer, which makes it possible to	271	actual wide characters in the screen buffer, which makes it possible to
…		…
251		275
252	=item B<-bc>|B<+bc>	276	=item B<-bc>|B<+bc>
253		277
254	Blink the cursor; resource B<cursorBlink>.	278	Blink the cursor; resource B<cursorBlink>.
255		279
		280	=item B<-uc>|B<+uc>
		281
		282	Make the cursor underlined; resource B<cursorUnderline>.
		283
256	=item B<-iconic>	284	=item B<-iconic>
257		285
258	Start iconified, if the window manager supports that option.	286	Start iconified, if the window manager supports that option.
259	Alternative form is B<-ic>.	287	Alternative form is B<-ic>.
260		288
…		…
276		304
277	=item B<-bl>	305	=item B<-bl>
278		306
279	Compile I<frills>: Set MWM hints to request a borderless window, i.e.	307	Compile I<frills>: Set MWM hints to request a borderless window, i.e.
280	if honoured by the WM, the rxvt-unicode window will not have window	308	if honoured by the WM, the rxvt-unicode window will not have window
281	decorations; resource B<borderLess>.	309	decorations; resource B<borderLess>. If the window manager does not
		310	support MWM hints (e.g. kwin), enables override-redirect mode.
		311
		312	=item B<-override-redirect>
		313
		314	Compile I<frills>: Sets override-redirect on the window; resource
		315	B<override-redirect>.
		316
		317	=item B<-dockapp>
		318
		319	Sets the initial state of the window to WithdrawnState, which makes
		320	window managers that support this extension treat it as a dockapp.
		321
		322	=item B<-sbg>
		323
		324	Compile I<frills>: Disable the usage of the built-in block graphics/line
		325	drawing characters and just rely on what the specified fonts provide. Use
		326	this if you have a good font and want to use its block graphic glyphs;
		327	resource B<skipBuiltinGlyphs>.
282		328
283	=item B<-lsp> I<number>	329	=item B<-lsp> I<number>
284		330
285	Compile I<frills>: Lines (pixel height) to insert between each row of	331	Compile I<frills>: Lines (pixel height) to insert between each row of
286	the display. Useful to work around font rendering problems; resource	332	the display. Useful to work around font rendering problems; resource
287	B<linespace>.	333	B<lineSpace>.
		334
		335	=item B<-letsp> I<number>
		336
		337	Compile I<frills>: Amount to adjust the computed character width by
		338	to control overall letter spacing. Negative values will tighten up the
		339	letter spacing, positive values will space letters out more. Useful to
		340	work around odd font metrics; resource B<letterSpace>.
288		341
289	=item B<-tn> I<termname>	342	=item B<-tn> I<termname>
290		343
291	This option specifies the name of the terminal type to be set in the	344	This option specifies the name of the terminal type to be set in the
292	B<TERM> environment variable. This terminal type must exist in the	345	B<TERM> environment variable. This terminal type must exist in the
…		…
301	given on the command line. If this option is used, it must be the last	354	given on the command line. If this option is used, it must be the last
302	on the command-line. If there is no B<-e> option then the default is to	355	on the command-line. If there is no B<-e> option then the default is to
303	run the program specified by the B<SHELL> environment variable or,	356	run the program specified by the B<SHELL> environment variable or,
304	failing that, I<sh(1)>.	357	failing that, I<sh(1)>.
305		358
		359	Please note that you must specify a program with arguments. If you want to
		360	run shell commands, you have to specify the shell, like this:
		361
		362	@@RXVT_NAME@@ -e sh -c "shell commands"
		363
306	=item B<-title> I<text>	364	=item B<-title> I<text>
307		365
308	Window title (B<-T> still respected); the default title is the basename	366	Window title (B<-T> still respected); the default title is the basename
309	of the program specified after the B<-e> option, if any, otherwise the	367	of the program specified after the B<-e> option, if any, otherwise the
310	application name; resource B<title>.	368	application name; resource B<title>.
…		…
321		379
322	=item B<-pt> I<style>	380	=item B<-pt> I<style>
323		381
324	Compile I<XIM>: input style for input method; B<OverTheSpot>,	382	Compile I<XIM>: input style for input method; B<OverTheSpot>,
325	B<OffTheSpot>, B<Root>; resource B<preeditType>.	383	B<OffTheSpot>, B<Root>; resource B<preeditType>.
		384
		385	If the perl extension C<xim-onthespot> is used (which is the default),
		386	then additionally the C<OnTheSpot> preedit type is available.
326		387
327	=item B<-im> I<text>	388	=item B<-im> I<text>
328		389
329	Compile I<XIM>: input method name. resource B<inputMethod>.	390	Compile I<XIM>: input method name. resource B<inputMethod>.
330		391
…		…
341	for more info.	402	for more info.
342		403
343	=item B<-tcw>	404	=item B<-tcw>
344		405
345	Change the meaning of triple-click selection with the left mouse	406	Change the meaning of triple-click selection with the left mouse
		407	button. Only effective when the original (non-perl) selection code is
346	button. Instead of selecting a full line it will extend the selection the	408	in-use. Instead of selecting a full line it will extend the selection to
347	end of the logical line only. resource B<tripleclickwords>.	409	the end of the logical line only. resource B<tripleclickwords>.
		410
		411	=item B<-dpb>|B<+dpb>
		412
		413	Compile frills: Disable (or enable) emitting bracketed paste mode
		414	sequences (default enabled). Bracketed paste mode allows programs
		415	to detect when something is pasted. Since more and more programs
		416	abuse this, these sequences can be disabled. The command sequences to
		417	enable and query paste mode will still work, but the actual bracket
		418	sequences will no longer be emitted. You can also toggle this from the
		419	ctrl-middle-mouse-button menu; resource B<disablePasteBrackets>.
348		420
349	=item B<-insecure>	421	=item B<-insecure>
350		422
351	Enable "insecure" mode, which currently enables most of the escape	423	Enable "insecure" mode, which currently enables most of the escape
352	sequences that echo strings. See the resource B<insecure> for more	424	sequences that echo strings. See the resource B<insecure> for more
…		…
366	=item B<-ssr>|B<+ssr>	438	=item B<-ssr>|B<+ssr>
367		439
368	Turn on/off secondary screen scroll (default enabled); resource	440	Turn on/off secondary screen scroll (default enabled); resource
369	B<secondaryScroll>.	441	B<secondaryScroll>.
370		442
		443	=item B<-rm> I<mode>
		444
		445	Compile I<frills>: Sets long line rewrapping behaviour on window resizes
		446	to one of B<auto> (the default), B<always> or B<never>. The latter two
		447	modes do the obvious, B<auto> rewraps (acts like B<always>) if scrollback
		448	is non-empty, and wings lines (acts like B<never>) otherwise; resource
		449	B<rewrapMode>.
		450
		451	=item B<-hold>|B<+hold>
		452
		453	Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@
		454	will not immediately destroy its window when the program executed within
		455	it exits. Instead, it will wait till it is being killed or closed by the
		456	user; resource B<hold>.
		457
		458	=item B<-cd> I<path>
		459
		460	Sets the working directory for the shell (or the command specified via
		461	B<-e>). The I<path> must be an absolute path and it must exist for
		462	@@RXVT_NAME@@ to start; resource B<chdir>.
		463
371	=item B<-xrm> I<resourcestring>	464	=item B<-xrm> I<string>
372		465
373	No effect on rxvt-unicode. Simply passes through an argument to be made	466	Works like the X Toolkit option of the same name, by adding the I<string>
374	available in the instance's argument list. Appears in I<WM_COMMAND> in	467	as if it were specified in a resource file. Resource values specified this
375	some window managers.	468	way take precedence over all other resource specifications.
		469
		470	Note that you need to use the I<same> syntax as in the .Xdefaults file,
		471	e.g. C<*.background: black>. Also note that all @@RXVT_NAME@@-specific
		472	options can be specified as long-options on the commandline, so use
		473	of B<-xrm> is mostly limited to cases where you want to specify other
		474	resources (e.g. for input methods) or for compatibility with other
		475	programs.
		476
		477	=item B<-keysym.>I<sym> I<string>
		478
		479	Remap a key symbol. See resource B<keysym>.
		480
		481	=item B<-embed> I<windowid>
		482
		483	Tells @@RXVT_NAME@@ to embed its windows into an already-existing window,
		484	which enables applications to easily embed a terminal.
		485
		486	Right now, @@RXVT_NAME@@ will first unmap/map the specified window, so it
		487	shouldn't be a top-level window. @@RXVT_NAME@@ will also reconfigure it
		488	quite a bit, so don't expect it to keep some specific state. It's best to
		489	create an extra subwindow for @@RXVT_NAME@@ and leave it alone.
		490
		491	The window will not be destroyed when @@RXVT_NAME@@ exits.
		492
		493	It might be useful to know that @@RXVT_NAME@@ will not close file
		494	descriptors passed to it (except for stdin/out/err, of course), so you
		495	can use file descriptors to communicate with the programs within the
		496	terminal. This works regardless of whether the C<-embed> option was used or
		497	not.
		498
		499	Here is a short Gtk2-perl snippet that illustrates how this option can be
		500	used (a longer example is in F<doc/embed>):
		501
		502	my $rxvt = new Gtk2::Socket;
		503	$rxvt->signal_connect_after (realize => sub {
		504	my $xid = $_[0]->window->get_xid;
		505	system "@@RXVT_NAME@@ -embed $xid &";
		506	});
		507
		508	=item B<-pty-fd> I<file descriptor>
		509
		510	Tells @@RXVT_NAME@@ NOT to execute any commands or create a new pty/tty
		511	pair but instead use the given file descriptor as the tty master. This is
		512	useful if you want to drive @@RXVT_NAME@@ as a generic terminal emulator
		513	without having to run a program within it.
		514
		515	If this switch is given, @@RXVT_NAME@@ will not create any utmp/wtmp
		516	entries and will not tinker with pty/tty permissions - you have to do that
		517	yourself if you want that.
		518
		519	As an extremely special case, specifying C<-1> will completely suppress
		520	pty/tty operations, which is probably only useful in conjunction with some
		521	perl extension that manages the terminal.
		522
		523	Here is a example in perl that illustrates how this option can be used (a
		524	longer example is in F<doc/pty-fd>):
		525
		526	use IO::Pty;
		527	use Fcntl;
		528
		529	my $pty = new IO::Pty;
		530	fcntl $pty, F_SETFD, 0; # clear close-on-exec
		531	system "@@RXVT_NAME@@ -pty-fd " . (fileno $pty) . "&";
		532	close $pty;
		533
		534	# now communicate with rxvt
		535	my $slave = $pty->slave;
		536	while (<$slave>) { print $slave "got <$_>\n" }
		537
		538	Note that, despite what the name might imply, the file descriptor does not
		539	need to be a pty, it can be a bi-directional pipe as well (e.g. a unix
		540	domain or tcp socket). While tty operations cannot be done in this case,
		541	B<@@RXVT_NAME@@> can still be remote controlled with it:
		542
		543	use Socket;
		544	use Fcntl;
		545
		546	socketpair my $URXVT, my $slave, Socket::AF_UNIX, Socket::SOCK_STREAM, Socket::PF_UNSPEC;
		547	fcntl $slave, Fcntl::F_SETFD, 0;
		548	system "exec @@RXVT_NAME|| -pty-fd " . (fileno $slave) . " &";
		549	close $slave;
		550
		551	syswrite $URXVT, "Type a secret password: ";
		552	my $secret = do { local $/ = "\r"; <$URXVT> };
		553	print "Not so secret anymore: $secret\n";
		554
		555	=item B<-pe> I<string>
		556
		557	Comma-separated list of perl extension scripts to use (or not to use) in
		558	this terminal instance. See resource B<perl-ext> for details.
376		559
377	=back	560	=back
378		561
379	=head1 RESOURCES (available also as long-options)	562	=head1 RESOURCES
380		563
381	Note: `@@RXVT_NAME@@ --help' gives a list of all resources (long	564	Note: `@@RXVT_NAME@@ --help' gives a list of all resources (long
382	options) compiled into your version.	565	options) compiled into your version. All resources are also available as
		566	long-options.
383		567
384	There are two different methods that @@RXVT_NAME@@ can use to get the	568	You can set and change the resources using X11 tools like B<xrdb>. Many
385	Xresource data: using the X libraries (Xrm*-functions) or internal	569	distribution do also load settings from the B<~/.Xresources> file when X
386	Xresources reader (B<~/.Xdefaults>). For the first method (ie.	570	starts. @@RXVT_NAME@@ will consult the following files/resources in order,
387	B<@@RXVT_NAME@@ -h> lists B<XGetDefaults>), you can set and change the	571	with later settings overwriting earlier ones:
388	resources using X11 tools like B<xset>. Many distribution do also load
389	settings from the B<~/.Xresources> file when X starts.
390		572
391	If compiled with internal Xresources support (i.e. B<@@RXVT_NAME@@ -h>	573	1. app-defaults file in $XAPPLRESDIR
392	lists B<.Xdefaults>) then B<@@RXVT_NAME@@> accepts application defaults	574	2. $HOME/.Xdefaults
393	set in XAPPLOADDIR/URxvt (compile-time defined: usually	575	3. RESOURCE_MANAGER property on root-window of screen 0
394	B</usr/lib/X11/app-defaults/URxvt>) and resources set in	576	4. SCREEN_RESOURCES property on root-window of the current screen
395	B<~/.Xdefaults>, or B<~/.Xresources> if B<~/.Xdefaults> does not exist.	577	5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename>
		578	6. resources specified via -xrm on the commandline
		579
396	Note that when reading X resources, B<@@RXVT_NAME@@> recognizes two	580	Note that when reading X resources, B<@@RXVT_NAME@@> recognizes two class
397	class names: B<XTerm> and B<URxvt>. The class name B<Rxvt> allows	581	names: B<Rxvt> and B<URxvt>. The class name B<Rxvt> allows resources
398	resources common to both B<@@RXVT_NAME@@> and the original I<rxvt> to be	582	common to both B<@@RXVT_NAME@@> and the original I<rxvt> to be easily
399	easily configured, while the class name B<URxvt> allows resources	583	configured, while the class name B<URxvt> allows resources unique to
400	unique to B<@@RXVT_NAME@@>, notably colours and key-handling, to be	584	B<@@RXVT_NAME@@>, to be shared between different B<@@RXVT_NAME@@>
401	shared between different B<@@RXVT_NAME@@> configurations. If no	585	configurations. If no resources are specified, suitable defaults will
402	resources are specified, suitable defaults will be used. Command-line	586	be used. Command-line arguments can be used to override resource
403	arguments can be used to override resource settings. The following	587	settings. The following resources are supported (you might want to
404	resources are allowed:	588	check the @@RXVT_NAME@@perl(3) manpage for additional settings by perl
		589	extensions not documented here):
405		590
406	=over 4	591	=over
		592
		593	=item B<depth:> I<bitdepth>
		594
		595	Compile I<xft>: Attempt to find a visual with the given bit depth;
		596	option B<-depth>.
		597
		598	=item B<buffered:> I<boolean>
		599
		600	Compile I<xft>: Turn on/off double-buffering for xft (default enabled).
		601	On some card/driver combination enabling it slightly decreases
		602	performance, on most it greatly helps it. The slowdown is small, so it
		603	should normally be enabled.
407		604
408	=item B<geometry:> I<geom>	605	=item B<geometry:> I<geom>
409		606
410	Create the window with the specified X window geometry [default 80x24];	607	Create the window with the specified X window geometry [default 80x24];
411	option B<-geometry>.	608	option B<-geometry>.
…		…
425	Use the specified colour for the colour value I<n>, where 0-7	622	Use the specified colour for the colour value I<n>, where 0-7
426	corresponds to low-intensity (normal) colours and 8-15 corresponds to	623	corresponds to low-intensity (normal) colours and 8-15 corresponds to
427	high-intensity (bold = bright foreground, blink = bright background)	624	high-intensity (bold = bright foreground, blink = bright background)
428	colours. The canonical names are as follows: 0=black, 1=red, 2=green,	625	colours. The canonical names are as follows: 0=black, 1=red, 2=green,
429	3=yellow, 4=blue, 5=magenta, 6=cyan, 7=white, but the actual colour	626	3=yellow, 4=blue, 5=magenta, 6=cyan, 7=white, but the actual colour
430	names used are listed in the B<COLORS AND GRAPHICS> section.	627	names used are listed in the B<COLOURS AND GRAPHICS> section.
431		628
432	Colours higher than 15 cannot be set using resources (yet), but can be	629	Colours higher than 15 cannot be set using resources (yet), but can be
433	changed using an escape command (see @@RXVT_NAME@@(7)).	630	changed using an escape command (see @@RXVT_NAME@@(7)).
434		631
435	Colours 16-79 form a standard 4x4x4 colour cube (the same as xterm with	632	Colours 16-79 form a standard 4x4x4 colour cube (the same as xterm with
…		…
446	=item B<colorUL:> I<colour>	643	=item B<colorUL:> I<colour>
447		644
448	Use the specified colour to display underlined characters when the	645	Use the specified colour to display underlined characters when the
449	foreground colour is the default.	646	foreground colour is the default.
450		647
451	=item B<colorRV:> I<colour>
452
453	Use the specified colour as the background for reverse video
454	characters.
455
456	=item B<underlineColor:> I<colour>	648	=item B<underlineColor:> I<colour>
457		649
458	If set, use the specified colour as the colour for the underline	650	If set, use the specified colour as the colour for the underline
459	itself. If unset, use the foreground colour.	651	itself. If unset, use the foreground colour.
		652
		653	=item B<highlightColor:> I<colour>
		654
		655	If set, use the specified colour as the background for highlighted
		656	characters. If unset, use reverse video.
		657
		658	=item B<highlightTextColor:> I<colour>
		659
		660	If set and highlightColor is set, use the specified colour as the
		661	foreground for highlighted characters.
460		662
461	=item B<cursorColor:> I<colour>	663	=item B<cursorColor:> I<colour>
462		664
463	Use the specified colour for the cursor. The default is to use the	665	Use the specified colour for the cursor. The default is to use the
464	foreground colour; option B<-cr>.	666	foreground colour; option B<-cr>.
…		…
471		673
472	=item B<reverseVideo:> I<boolean>	674	=item B<reverseVideo:> I<boolean>
473		675
474	B<True>: simulate reverse video by foreground and background colours;	676	B<True>: simulate reverse video by foreground and background colours;
475	option B<-rv>. B<False>: regular screen colours [default]; option	677	option B<-rv>. B<False>: regular screen colours [default]; option
476	B<+rv>. See note in B<COLORS AND GRAPHICS> section.	678	B<+rv>. See note in B<COLOURS AND GRAPHICS> section.
477		679
478	=item B<jumpScroll:> I<boolean>	680	=item B<jumpScroll:> I<boolean>
479		681
480	B<True>: specify that jump scrolling should be used. When scrolling	682	B<True>: specify that jump scrolling should be used. When receiving lots
481	quickly, fewer screen updates are performed [default]; option B<-j>.	683	of lines, @@RXVT_NAME@@ will only scroll once a whole screen height of lines
		684	has been read, resulting in fewer updates while still displaying every
		685	received line; option B<-j>.
		686
482	B<False>: specify that smooth scrolling should be used; option B<+j>.	687	B<False>: specify that smooth scrolling should be used. @@RXVT_NAME@@ will
		688	force a screen refresh on each new line it received; option B<+j>.
483		689
484	=item B<inheritPixmap:> I<boolean>	690	=item B<skipScroll:> I<boolean>
485		691
486	B<True>: make the background inherit the parent windows' pixmap, giving	692	B<True>: (the default) specify that skip scrolling should be used. When
487	artificial transparency. B<False>: do not inherit the parent windows'	693	receiving lots of lines, @@RXVT_NAME@@ will only scroll once in a while
488	pixmap.	694	(around 60 times per second), resulting in far fewer updates. This can
		695	result in @@RXVT_NAME@@ not ever displaying some of the lines it receives;
		696	option B<-ss>.
		697
		698	B<False>: specify that everything is to be displayed, even
		699	if the refresh is too fast for the human eye to read anything (or the
		700	monitor to display anything); option B<+ss>.
489		701
490	=item B<fading:> I<number>	702	=item B<fading:> I<number>
491		703
492	Fade the text by the given percentage when focus is lost.	704	Fade the text by the given percentage when focus is lost; option B<-fade>.
493		705
494	=item B<tintColor:> I<colour>	706	=item B<fadeColor:> I<colour>
495		707
496	Tint the transparent background pixmap with the given colour.	708	Fade to this colour, when fading is used (see B<fading:>). The default
		709	colour is black; option B<-fadecolor>.
497		710
498	=item B<shading:> I<number>	711	=item B<iconFile:> I<file>
499		712
500	Darken (0 .. 100) or lighten (-1 .. -100) the transparent background	713	Set the application icon pixmap; option B<-icon>.
501	image in addition to tinting it.
502		714
503	=item B<scrollColor:> I<colour>	715	=item B<scrollColor:> I<colour>
504		716
505	Use the specified colour for the scrollbar [default #B2B2B2].	717	Use the specified colour for the scrollbar [default #B2B2B2].
506		718
507	=item B<troughColor:> I<colour>	719	=item B<troughColor:> I<colour>
508		720
509	Use the specified colour for the scrollbar's trough area [default	721	Use the specified colour for the scrollbar's trough area [default
510	#969696]. Only relevant for normal (non XTerm/NeXT) scrollbar.	722	#969696]. Only relevant for rxvt (non XTerm/NeXT) scrollbar.
511		723
512	=item B<borderColor:> I<colour>	724	=item B<borderColor:> I<colour>
513		725
514	The colour of the border around the text area and between the scrollbar	726	The colour of the border around the text area and between the scrollbar
515	and the text.	727	and the text.
516		728
517	=item B<backgroundPixmap:> I<file[;geom]>
518
519	Use the specified XPM file (note the `.xpm' extension is optional) for
520	the background and also optionally specify its scaling with a geometry
521	string B<WxH+X+Y>, in which B<"W" / "H"> specify the
522	horizontal/vertical scale (percent) and B<"X" / "Y"> locate the image
523	centre (percent). A scale of 0 displays the image with tiling. A scale
524	of 1 displays the image without any scaling. A scale of 2 to 9
525	specifies an integer number of images in that direction. No image will
526	be magnified beyond 10 times its original size. The maximum permitted
527	scale is 1000. [default 0x0+50+50]
528
529	=item B<menu:> I<file[;tag]>
530
531	Read in the specified menu file (note the `.menu' extension is
532	optional) and also optionally specify a starting tag to find. See the
533	reference documentation for details on the syntax for the menuBar.
534
535	=item B<path:> I<path>
536
537	Specify the colon-delimited search path for finding files (XPM and
538	menus), in addition to the paths specified by the B<RXVTPATH> and
539	B<PATH> environment variables.
540
541	=item B<font:> I<fontlist>	729	=item B<font:> I<fontlist>
542		730
543	Select the fonts to be used. This is a comma separated list of font	731	Select the fonts to be used. This is a comma separated list of font names
544	names that are used in turn when trying to display Unicode characters.	732	that are checked in order when trying to find glyphs for characters. The
545	The first font defines the cell size for characters; other fonts might	733	first font defines the cell size for characters; other fonts might be
546	be smaller, but not larger. A reasonable default font list is always	734	smaller, but not (in general) larger. A (hopefully) reasonable default
547	appended to it. option B<-fn>.	735	font list is always appended to it; option B<-fn>.
548		736
549	Each font can either be a standard X11 core font (XLFD) name, with	737	Each font can either be a standard X11 core font (XLFD) name, with
550	optional prefix C<x:> or a Xft font (Compile I<xft>), prefixed with C<xft:>.	738	optional prefix C<x:> or a Xft font (Compile I<xft>), prefixed with C<xft:>.
551		739
552	In addition, each font can be prefixed with additional hints and	740	In addition, each font can be prefixed with additional hints and
…		…
554	hint currently is C<codeset=codeset-name>, and this is only used for Xft	742	hint currently is C<codeset=codeset-name>, and this is only used for Xft
555	fonts.	743	fonts.
556		744
557	For example, this font resource	745	For example, this font resource
558		746
559	URxvt*font: 9x15bold,\	747	URxvt.font: 9x15bold,\
560	-misc-fixed-bold-r-normal--15-140-75-75-c-90-iso10646-1,\	748	-misc-fixed-bold-r-normal--15-140-75-75-c-90-iso10646-1,\
561	-misc-fixed-medium-r-normal--15-140-75-75-c-90-iso10646-1, \	749	-misc-fixed-medium-r-normal--15-140-75-75-c-90-iso10646-1, \
562	[codeset=JISX0208]xft:Kochi Gothic:antialias=false, \	750	[codeset=JISX0208]xft:Kochi Gothic:antialias=false, \
563	xft:Code2000:antialias=false	751	xft:Code2000:antialias=false
564		752
…		…
567	it is named first) and thus defines the character cell grid to be 9 pixels	755	it is named first) and thus defines the character cell grid to be 9 pixels
568	wide and 15 pixels high.	756	wide and 15 pixels high.
569		757
570	The second font is just used to add additional unicode characters not in	758	The second font is just used to add additional unicode characters not in
571	the base font, likewise the third, which is unfortunately non-bold, but	759	the base font, likewise the third, which is unfortunately non-bold, but
572	the bold version of the font does contain less characters, so this is a	760	the bold version of the font does contain fewer characters, so this is a
573	useful supplement.	761	useful supplement.
574		762
575	The third font is an Xft font with aliasing turned off, and the characters	763	The third font is an Xft font with aliasing turned off, and the characters
576	are limited to the B<JIS 0208> codeset (i.e. japanese kanji). The font	764	are limited to the B<JIS 0208> codeset (i.e. japanese kanji). The font
577	contains other characters, but we are not interested in them.	765	contains other characters, but we are not interested in them.
…		…
598	not possible, replacement fonts of the desired shape will be tried.	786	not possible, replacement fonts of the desired shape will be tried.
599		787
600	If set, but empty, then this specific style is disabled and the normal	788	If set, but empty, then this specific style is disabled and the normal
601	text font will being used for the given style.	789	text font will being used for the given style.
602		790
603	=item B<selectstyle:> I<mode>	791	=item B<intensityStyles:> I<boolean>
604		792
605	Set mouse selection style to B<old> which is 2.20, B<oldword> which is	793	When font styles are not enabled, or this option is enabled (B<True>,
606	xterm style with 2.20 old word selection, or anything else which gives	794	option B<-is>, the default), bold/blink font styles imply high
607	xterm style selection.	795	intensity foreground/background colours. Disabling this option (B<False>,
608		796	option B<+is>) disables this behaviour, the high intensity colours are not
609	=item B<scrollstyle:> I<mode>	797	reachable.
610
611	Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is
612	the author's favourite..
613		798
614	=item B<title:> I<string>	799	=item B<title:> I<string>
615		800
616	Set window title string, the default title is the command-line	801	Set window title string, the default title is the command-line
617	specified after the B<-e> option, if any, otherwise the application	802	specified after the B<-e> option, if any, otherwise the application
…		…
626	=item B<mapAlert:> I<boolean>	811	=item B<mapAlert:> I<boolean>
627		812
628	B<True>: de-iconify (map) on receipt of a bell character. B<False>: no	813	B<True>: de-iconify (map) on receipt of a bell character. B<False>: no
629	de-iconify (map) on receipt of a bell character [default].	814	de-iconify (map) on receipt of a bell character [default].
630		815
		816	=item B<urgentOnBell:> I<boolean>
		817
		818	B<True>: set the urgency hint for the wm on receipt of a bell character.
		819	B<False>: do not set the urgency hint [default].
		820
		821	@@RXVT_NAME@@ resets the urgency hint on every focus change.
		822
631	=item B<visualBell:> I<boolean>	823	=item B<visualBell:> I<boolean>
632		824
633	B<True>: use visual bell on receipt of a bell character; option B<-vb>.	825	B<True>: use visual bell on receipt of a bell character; option B<-vb>.
634	B<False>: no visual bell [default]; option B<+vb>.	826	B<False>: no visual bell [default]; option B<+vb>.
635		827
…		…
637		829
638	B<True>: start as a login shell by prepending a `-' to B<argv[0]> of	830	B<True>: start as a login shell by prepending a `-' to B<argv[0]> of
639	the shell; option B<-ls>. B<False>: start as a normal sub-shell	831	the shell; option B<-ls>. B<False>: start as a normal sub-shell
640	[default]; option B<+ls>.	832	[default]; option B<+ls>.
641		833
		834	=item B<multiClickTime:> I<number>
		835
		836	Specify the maximum time in milliseconds between multi-click select
		837	events. The default is 500 milliseconds; option B<-mc>.
		838
642	=item B<utmpInhibit:> I<boolean>	839	=item B<utmpInhibit:> I<boolean>
643		840
644	B<True>: inhibit writing record into the system log file B<utmp>;	841	B<True>: inhibit writing record into the system log file B<utmp>;
645	option B<-ut>. B<False>: write record into the system log file B<utmp>	842	option B<-ut>. B<False>: write record into the system log file B<utmp>
646	[default]; option B<+ut>.	843	[default]; option B<+ut>.
…		…
649		846
650	Specify a command pipe for vt100 printer [default I<lpr(1)>]. Use	847	Specify a command pipe for vt100 printer [default I<lpr(1)>]. Use
651	B<Print> to initiate a screen dump to the printer and B<Ctrl-Print> or	848	B<Print> to initiate a screen dump to the printer and B<Ctrl-Print> or
652	B<Shift-Print> to include the scrollback as well.	849	B<Shift-Print> to include the scrollback as well.
653		850
		851	The string will be interpreted as if typed into the shell as-is.
		852
		853	Example:
		854
		855	URxvt.print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX)
		856
		857	This creates a new file in your home directory with the screen contents
		858	every time you hit C<Print>.
		859
		860	=item B<scrollstyle:> I<mode>
		861
		862	Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is
		863	the author's favourite.
		864
		865	=item B<thickness:> I<number>
		866
		867	Set the scrollbar width in pixels.
		868
654	=item B<scrollBar:> I<boolean>	869	=item B<scrollBar:> I<boolean>
655		870
656	B<True>: enable the scrollbar [default]; option B<-sb>. B<False>:	871	B<True>: enable the scrollbar [default]; option B<-sb>. B<False>:
657	disable the scrollbar; option B<+sb>.	872	disable the scrollbar; option B<+sb>.
658		873
…		…
677	B<False>: do not scroll to bottom when tty receives output; option	892	B<False>: do not scroll to bottom when tty receives output; option
678	B<+si>.	893	B<+si>.
679		894
680	=item B<scrollWithBuffer:> I<boolean>	895	=item B<scrollWithBuffer:> I<boolean>
681		896
682	B<True>: scroll with scrollback buffer when tty receives new lines (and	897	B<True>: scroll with scrollback buffer when tty receives new lines (i.e.
683	B<scrollTtyOutput> is False); option B<+sw>. B<False>: do not scroll	898	try to show the same lines) and B<scrollTtyOutput> is False; option
684	with scrollback buffer when tty recieves new lines; option B<-sw>.	899	B<-sw>. B<False>: do not scroll with scrollback buffer when tty receives
		900	new lines; option B<+sw>.
685		901
686	=item B<scrollTtyKeypress:> I<boolean>	902	=item B<scrollTtyKeypress:> I<boolean>
687		903
688	B<True>: scroll to bottom when a non-special key is pressed. Special keys	904	B<True>: scroll to bottom when a non-special key is pressed. Special keys
689	are those which are intercepted by rxvt-unicode for special handling and	905	are those which are intercepted by rxvt-unicode for special handling and
690	are not passed onto the shell; option B<-sk>. B<False>: do not scroll to	906	are not passed onto the shell; option B<-sk>. B<False>: do not scroll to
691	bottom when a non-special key is pressed; option B<+sk>.	907	bottom when a non-special key is pressed; option B<+sk>.
692		908
693	=item B<saveLines:> I<number>	909	=item B<saveLines:> I<number>
694		910
695	Save I<number> lines in the scrollback buffer [default 64]. This	911	Save I<number> lines in the scrollback buffer [default 1000]; option B<-sl>.
696	resource is limited on most machines to 65535; option B<-sl>.
697		912
698	=item B<internalBorder:> I<number>	913	=item B<internalBorder:> I<number>
699		914
700	Internal border of I<number> pixels. This resource is limited to 100;	915	Internal border of I<number> pixels. This resource is limited to 100;
701	option B<-b>.	916	option B<-b>.
…		…
708	=item B<borderLess:> I<boolean>	923	=item B<borderLess:> I<boolean>
709		924
710	Set MWM hints to request a borderless window, i.e. if honoured by the	925	Set MWM hints to request a borderless window, i.e. if honoured by the
711	WM, the rxvt-unicode window will not have window decorations; option B<-bl>.	926	WM, the rxvt-unicode window will not have window decorations; option B<-bl>.
712		927
		928	=item B<skipBuiltinGlyphs:> I<boolean>
		929
		930	Compile I<frills>: Disable the usage of the built-in block graphics/line
		931	drawing characters and just rely on what the specified fonts provide. Use
		932	this if you have a good font and want to use its block graphic glyphs;
		933	option B<-sbg>.
		934
713	=item B<termName:> I<termname>	935	=item B<termName:> I<termname>
714		936
715	Specifies the terminal type name to be set in the B<TERM> environment	937	Specifies the terminal type name to be set in the B<TERM> environment
716	variable; option B<-tn>.	938	variable; option B<-tn>.
717		939
718	=item B<linespace:> I<number>	940	=item B<lineSpace:> I<number>
719		941
720	Specifies number of lines (pixel height) to insert between each row of	942	Specifies number of lines (pixel height) to insert between each row of
721	the display [default 0]; option B<-lsp>.	943	the display [default 0]; option B<-lsp>.
722		944
723	=item B<meta8:> I<boolean>	945	=item B<meta8:> I<boolean>
…		…
737		959
738	=item B<cursorBlink:> I<boolean>	960	=item B<cursorBlink:> I<boolean>
739		961
740	B<True>: blink the cursor. B<False>: do not blink the cursor [default];	962	B<True>: blink the cursor. B<False>: do not blink the cursor [default];
741	option B<-bc>.	963	option B<-bc>.
		964
		965	=item B<cursorUnderline:> I<boolean>
		966
		967	B<True>: Make the cursor underlined. B<False>: Make the cursor a box [default];
		968	option B<-uc>.
742		969
743	=item B<pointerBlank:> I<boolean>	970	=item B<pointerBlank:> I<boolean>
744		971
745	B<True>: blank the pointer when a key is pressed or after a set number	972	B<True>: blank the pointer when a key is pressed or after a set number
746	of seconds of inactivity. B<False>: the pointer is always visible	973	of seconds of inactivity. B<False>: the pointer is always visible
…		…
752		979
753	=item B<pointerColor2:> I<colour>	980	=item B<pointerColor2:> I<colour>
754		981
755	Mouse pointer background colour.	982	Mouse pointer background colour.
756		983
		984	=item B<pointerShape:> I<string>
		985
		986	Compile I<frills>: Specifies the name of the mouse pointer shape
		987	[default B<xterm>]. See the macros in the B<X11/cursorfont.h> include
		988	file for possible values (omit the C<XC_> prefix).
		989
757	=item B<pointerBlankDelay:> I<number>	990	=item B<pointerBlankDelay:> I<number>
758		991
759	Specifies number of seconds before blanking the pointer [default 2].	992	Specifies number of seconds before blanking the pointer [default 2]. Use a
		993	large number (e.g. C<987654321>) to effectively disable the timeout.
760		994
761	=item B<backspacekey:> I<string>	995	=item B<backspacekey:> I<string>
762		996
763	The string to send when the backspace key is pressed. If set to B<DEC>	997	The string to send when the backspace key is pressed. If set to B<DEC>
764	or unset it will send B<Delete> (code 127) or, if shifted, B<Backspace>	998	or unset it will send B<Delete> (code 127) or, with control, B<Backspace>
765	(code 8) - which can be reversed with the appropriate DEC private mode	999	(code 8) - which can be reversed with the appropriate DEC private mode
766	escape sequence.	1000	escape sequence.
767		1001
768	=item B<deletekey:> I<string>	1002	=item B<deletekey:> I<string>
769		1003
…		…
771	pressed. If unset it will send the sequence traditionally associated	1005	pressed. If unset it will send the sequence traditionally associated
772	with the B<Execute> key.	1006	with the B<Execute> key.
773		1007
774	=item B<cutchars:> I<string>	1008	=item B<cutchars:> I<string>
775		1009
776	The characters used as delimiters for double-click word selection. The	1010	The characters used as delimiters for double-click word selection
777	built-in default:	1011	(whitespace delimiting is added automatically if resource is given).
778		1012
		1013	When the perl selection extension is in use (the default if compiled
		1014	in, see the @@RXVT_NAME@@perl(3) manpage), a suitable regex using these
		1015	characters will be created (if the resource exists, otherwise, no regex
		1016	will be created). In this mode, characters outside ISO-8859-1 can be used.
		1017
		1018	When the selection extension is not used, only ISO-8859-1 characters can
		1019	be used. If not specified, the built-in default is used:
		1020
779	B<< BACKSLASH `"'&()*,;<=>?@[]{|} >>	1021	B<< BACKSLASH `"'&()*,;<=>?@[]^{|} >>
780		1022
781	=item B<preeditType:> I<style>	1023	=item B<preeditType:> I<style>
782		1024
783	B<OverTheSpot>, B<OffTheSpot>, B<Root>; option B<-pt>.	1025	B<OnTheSpot>, B<OverTheSpot>, B<OffTheSpot>, B<Root>; option B<-pt>.
784		1026
785	=item B<inputMethod:> I<name>	1027	=item B<inputMethod:> I<name>
786		1028
787	I<name> of inputMethod to use; option B<-im>.	1029	I<name> of inputMethod to use; option B<-im>.
788		1030
789	=item B<imLocale:> I<name>	1031	=item B<imLocale:> I<name>
790		1032
791	The locale to use for opening the IM. You can use an C<LC_CTYPE> of e.g.	1033	The locale to use for opening the IM. You can use an C<LC_CTYPE> of e.g.
792	C<de_DE.UTF-8> for normal text processing but C<ja_JP.EUC-JP> for the	1034	C<de_DE.UTF-8> for normal text processing but C<ja_JP.EUC-JP> for the
793	input extension to be able to input japanese characters while staying in	1035	input extension to be able to input japanese characters while staying in
794	another locale. option B<-imlocale>.	1036	another locale; option B<-imlocale>.
795		1037
796	=item B<imFont:> I<fontset>	1038	=item B<imFont:> I<fontset>
797		1039
798	Specify the font-set used for XIM styles C<OverTheSpot> or	1040	Specify the font-set used for XIM styles C<OverTheSpot> or
799	C<OffTheSpot>. It must be a standard X font set (XLFD patterns separated	1041	C<OffTheSpot>. It must be a standard X font set (XLFD patterns separated
…		…
804		1046
805	=item B<tripleclickwords:> I<boolean>	1047	=item B<tripleclickwords:> I<boolean>
806		1048
807	Change the meaning of triple-click selection with the left mouse	1049	Change the meaning of triple-click selection with the left mouse
808	button. Instead of selecting a full line it will extend the selection to	1050	button. Instead of selecting a full line it will extend the selection to
809	the end of the logical line only. option B<-tcw>.	1051	the end of the logical line only; option B<-tcw>.
		1052
		1053	=item B<disablePasteBrackets:> I<boolean>
		1054
		1055	Prevent emission of paste bracket sequences; option B<-dpb>.
810		1056
811	=item B<insecure:> I<boolean>	1057	=item B<insecure:> I<boolean>
812		1058
813	Enables "insecure" mode. Rxvt-unicode offers some escape sequences that	1059	Enable "insecure" mode. Rxvt-unicode offers some escape sequences that
814	echo arbitrary strings like the icon name or the locale. This could be	1060	echo arbitrary strings like the icon name or the locale. This could be
815	abused if somebody gets 8-bit-clean access to your display, whether	1061	abused if somebody gets 8-bit-clean access to your display, whether
816	throuh a mail client displaying mail bodies unfiltered or though	1062	through a mail client displaying mail bodies unfiltered or through
817	write(1). Therefore, these sequences are disabled by default. (Note	1063	write(1) or any other means. Therefore, these sequences are disabled by
818	that other terminals, including xterm, have these sequences	1064	default. (Note that many other terminals, including xterm, have these
819	enabled by default). You can enable them by setting this boolean	1065	sequences enabled by default, which doesn't make it safer, though).
820	resource or specifying B<-insecure> as an option. At the moment, this	1066
821	enabled display-answer, locale, findfont, icon label and window title	1067	You can enable them by setting this boolean resource or specifying
822	requests as well as dynamic menubar dispatch.	1068	B<-insecure> as an option. At the moment, this enables display-answer,
		1069	locale, findfont, icon label and window title requests.
823		1070
824	=item B<modifier:> I<modifier>	1071	=item B<modifier:> I<modifier>
825		1072
826	Set the key to be interpreted as the Meta key to: B<alt>, B<meta>,	1073	Set the key to be interpreted as the Meta key to: B<alt>, B<meta>,
827	B<hyper>, B<super>, B<mod1>, B<mod2>, B<mod3>, B<mod4>, B<mod5>; option	1074	B<hyper>, B<super>, B<mod1>, B<mod2>, B<mod3>, B<mod4>, B<mod5>; option
…		…
831		1078
832	Specify the reply rxvt-unicode sends to the shell when an ENQ (control-E)	1079	Specify the reply rxvt-unicode sends to the shell when an ENQ (control-E)
833	character is passed through. It may contain escape values as described	1080	character is passed through. It may contain escape values as described
834	in the entry on B<keysym> following.	1081	in the entry on B<keysym> following.
835		1082
836	=item B<secondaryScreen:> I<bool>	1083	=item B<secondaryScreen:> I<boolean>
837		1084
838	Turn on/off secondary screen (default enabled).	1085	Turn on/off secondary screen (default enabled).
839		1086
		1087	=item B<rewrapMode:> I<mode>
		1088
		1089	Sets long line rewrap behaviour on window resize to one of B<auto>
		1090	(default), B<always> or B<never>.
		1091
840	=item B<secondaryScroll:> I<bool>	1092	=item B<secondaryScroll:> I<boolean>
841		1093
842	Turn on/off secondary screen scroll (default enabled). If the this	1094	Turn on/off secondary screen scroll (default enabled). If this
843	option is enabled, scrolls on the secondary screen will change the	1095	option is enabled, scrolls on the secondary screen will change the
844	scrollback buffer and switching to/from the secondary screen will	1096	scrollback buffer and, when secondaryScreen is off, switching
845	instead scroll the screen up.	1097	to/from the secondary screen will instead scroll the screen up.
846		1098
		1099	=item B<hold>: I<boolean>
		1100
		1101	Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@
		1102	will not immediately destroy its window when the program executed within
		1103	it exits. Instead, it will wait till it is being killed or closed by the
		1104	user.
		1105
		1106	=item B<chdir>: I<path>
		1107
		1108	Sets the working directory for the shell (or the command specified via
		1109	B<-e>). The I<path> must be an absolute path and it must exist for
		1110	@@RXVT_NAME@@ to start. If it isn't specified then the current working
		1111	directory will be used; option B<-cd>.
		1112
847	=item B<keysym.>I<sym>: I<string>	1113	=item B<keysym.>I<sym>: I<action>
848		1114
849	Compile I<frills>: Associate I<string> with keysym I<sym>. The	1115	Compile I<frills>: Associate I<action> with keysym I<sym>. The intervening
850	intervening resource name B<keysym.> cannot be omitted.	1116	resource name B<keysym.> cannot be omitted.
851		1117
852	The format of I<sym> is "I<(modifiers-)key>", where I<modifiers> can be	1118	Using this resource, you can map key combinations such as
853	any combination of B<ISOLevel3>, B<AppKeypad>, B<Control>, B<NumLock>,	1119	C<Ctrl-Shift-BackSpace> to various actions, such as outputting a different
854	B<Shift>, B<Meta>, B<Lock>, B<Mod1>, B<Mod2>, B<Mod3>, B<Mod4>, B<Mod5>,	1120	string than would normally result from that combination, making the
855	and the abbreviated B<I>, B<K>, B<C>, B<N>, B<S>, B<M>, B<A>, B<L>, B<1>,	1121	terminal scroll up or down the way you want it, or any other thing an
856	B<2>, B<3>, B<4>, B<5>.	1122	extension might provide.
		1123
		1124	The key combination that triggers the action, I<sym>, has the following format:
		1125
		1126	(modifiers-)key
		1127
		1128	Where I<modifiers> can be any combination of the following full or
		1129	abbreviated modifier names:
		1130
		1131	=begin table
		1132
		1133	B<ISOLevel3> B<I>
		1134	B<AppKeypad> B<K>
		1135	B<Control> B<C>
		1136	B<NumLock> B<N>
		1137	B<Shift> B<S>
		1138	B<Meta> B<M> I<or> B<A>
		1139	B<Lock> B<L>
		1140	B<Mod1> B<1>
		1141	B<Mod2> B<2>
		1142	B<Mod3> B<3>
		1143	B<Mod4> B<4>
		1144	B<Mod5> B<5>
		1145
		1146	=end table
857		1147
858	The B<NumLock>, B<Meta> and B<ISOLevel3> modifiers are usually aliased to	1148	The B<NumLock>, B<Meta> and B<ISOLevel3> modifiers are usually aliased to
859	whatever modifier the NumLock key, Meta/Alt keys or ISO Level3 Shift/AltGr	1149	whatever modifier the NumLock key, Meta/Alt keys or ISO Level3 Shift/AltGr
860	keys are being mapped. B<AppKeypad> is a synthetic modifier mapped to the	1150	keys are being mapped. B<AppKeypad> is a synthetic modifier mapped to the
861	current application keymap mode state.	1151	current application keymap mode state.
862		1152
863	The spellings of I<key> can be obtained by using B<xev>(1) command or	1153	Due the the large number of modifier combinations, a key mapping will
864	searching keysym macros from B</usr/X11R6/include/X11/keysymdef.h> and	1154	match if I<at least> the specified identifiers are being set, and no other
		1155	key mappings with those and more bits are being defined. That means that
		1156	defining a mapping for C<a> will automatically provide definitions for
		1157	C<Meta-a>, C<Shift-a> and so on, unless some of those are defined mappings
		1158	themselves. See the C<builtin:> action, below, for a way to work around
		1159	this when this is a problem.
		1160
		1161	The spelling of I<key> depends on your implementation of X. An easy way to
		1162	find a key name is to use the B<xev>(1) command. You can find a list by
		1163	looking for the C<XK_> macros in the B<X11/keysymdef.h> include file (omit
865	omitting the prefix B<XK_>. Alternatively you can specify I<key> by its hex	1164	the C<XK_> prefix). Alternatively you can specify I<key> by its hex keysym
866	keysym value (B<0x0000 - 0xFFFF>). Note that the lookup of I<sym>s is not	1165	value (B<0x0000 - 0xFFFF>).
867	performed in an exact manner; however, the closest match is assured.
868		1166
869	I<string> may contain escape values (C<\a>: bell, C<\b>: backspace,	1167	As with any resource value, the I<action> string may contain backslash
870	C<\e>, C<\E>: escape, C<\n>: newline, C<\r>: carriage return, C<\t>: tab,	1168	escape sequences (C<\n>: newline, C<\\>: backslash, C<\000>: octal
871	C<\000>: octal number) or verbatim control characters (C<^?>: delete,	1169	number), see RESOURCES in C<man 7 X> for further details.
872	C<^@>: null, C<^A> ...) and may be enclosed with double quotes so that it
873	can start or end with whitespace.
874		1170
875	Please note that you need to double the C<\> when using	1171	An action starts with an action prefix that selects a certain type
876	C<--enable-xgetdefault>, as X itself does it's own de-escaping (you can	1172	of action, followed by a colon. An action string without colons is
877	use C<\033> instead of C<\e> (and so on), which will work with both Xt and	1173	interpreted as a literal string to pass to the tty (as if it was
878	@@RXVT_NAME@@'s own processing).	1174	prefixed with C<string:>).
879		1175
880	You can define a range of keysyms in one shot by providing a I<string>	1176	The following action prefixes are known - extensions can provide
881	with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimeter `/'	1177	additional prefixes:
		1178
		1179	=over
		1180
		1181	=item string:STRING
		1182
		1183	If the I<action> starts with C<string:> (or otherwise contains no colons),
		1184	then the remaining C<STRING> will be passed to the program running in the
		1185	terminal. For example, you could replace whatever Shift-Tab outputs by the
		1186	string C<echo rm -rf /> followed by a newline:
		1187
		1188	URxvt.keysym.Shift-Tab: string:echo rm -rf /\n
		1189
		1190	This could in theory be used to completely redefine your keymap.
		1191
		1192	In addition, for actions of this type, you can define a range of
		1193	keysyms in one shot by loading the C<keysym-list> perl extension and
		1194	providing an I<action> with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where
882	should be a character not used by the strings.	1195	the delimiter `/' should be a character not used by the strings.
883		1196
884	Its usage can be demonstrated by an example:	1197	Its usage can be demonstrated by an example:
885		1198
886	URxvt.keysym.M-C-0x61: list|\033<M-C-|abc|>	1199	URxvt.keysym.M-C-0x61: list|\033<|abc|>
887		1200
888	The above line is equivalent to the following three lines:	1201	The above line is equivalent to the following three lines:
889		1202
890	URxvt.keysym.Meta-Control-0x61: \033<M-C-a>	1203	URxvt.keysym.Meta-Control-0x61: string:\033<a>
891	URxvt.keysym.Meta-Control-0x62: \033<M-C-b>	1204	URxvt.keysym.Meta-Control-0x62: string:\033<b>
892	URxvt.keysym.Meta-Control-0x63: \033<M-C-c>	1205	URxvt.keysym.Meta-Control-0x63: string:\033<c>
893		1206
		1207	=item command:STRING
		1208
894	If I<string> takes the form of C<command:STRING>, the specified B<STRING>	1209	If I<action> takes the form of C<command:STRING>, the specified B<STRING>
895	is interpreted and executed as @@RXVT_NAME@@'s control sequence. For	1210	is interpreted and executed as @@RXVT_NAME@@'s control sequence (basically
		1211	the opposite of C<string:> - instead of sending it to the program running
		1212	in the terminal, it will be treated as if it were program output). This is
		1213	most useful to feed command sequences into @@RXVT_NAME@@.
		1214
896	example the following means "change the current locale to C<zh_CN.GBK>	1215	For example the following means "change the current locale to C<zh_CN.GBK>
897	when Control-Meta-c is being pressed":	1216	when Control-Meta-c is being pressed":
898		1217
899	URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007	1218	URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007
900		1219
901	The following example will map Control-Meta-1 and Control-Meta-2 to	1220	The following example will map Control-Meta-1 and Control-Meta-2 to
…		…
908	Other things are possible, e.g. resizing (see @@RXVT_NAME@@(7) for more	1227	Other things are possible, e.g. resizing (see @@RXVT_NAME@@(7) for more
909	info):	1228	info):
910		1229
911	URxvt.keysym.M-C-3: command:\033[8;25;80t	1230	URxvt.keysym.M-C-3: command:\033[8;25;80t
912	URxvt.keysym.M-C-4: command:\033[8;48;110t	1231	URxvt.keysym.M-C-4: command:\033[8;48;110t
		1232
		1233	=item builtin:
		1234
		1235	The builtin action is the action that @@RXVT_NAME@@ would execute if no
		1236	key binding existed for the key combination. The obvious use is to undo
		1237	the effect of existing bindings. The not so obvious use is to reinstate
		1238	bindings when another binding overrides too many modifiers.
		1239
		1240	For example if you overwrite the C<Insert> key you will disable
		1241	@@RXVT_NAME@@'s C<Shift-Insert> mapping. To re-enable that, you can poke
		1242	"holes" into the user-defined keymap using the C<builtin:> replacement:
		1243
		1244	URxvt.keysym.Insert: <my insert key sequence>
		1245	URxvt.keysym.S-Insert: builtin:
		1246
		1247	The first line defines a mapping for C<Insert> and I<any> combination
		1248	of modifiers. The second line re-establishes the default mapping for
		1249	C<Shift-Insert>.
		1250
		1251	=item builtin-string:
		1252
		1253	This action is mainly useful to restore string mappings for keys that
		1254	have predefined actions in @@RXVT_NAME@@. The exact semantics are a bit
		1255	difficult to explain - basically, this action will send the string to the
		1256	application that would be sent if @@RXVT_NAME@@ wouldn't have a built-in
		1257	action for it.
		1258
		1259	An example might make it clearer: @@RXVT_NAME@@ normally pastes the
		1260	selection when you press C<Shift-Insert>. With the following bindings, it
		1261	would instead emit the (undocumented, but what applications running in the
		1262	terminal might expect) sequence C<ESC [ 2 $> instead:
		1263
		1264	URxvt.keysym.S-Insert: builtin-string:
		1265	URxvt.keysym.C-S-Insert: builtin:
		1266
		1267	The first line disables the paste functionality for that key
		1268	combination, and the second reinstates the default behaviour for
		1269	C<Control-Shift-Insert>, which would otherwise be overridden.
		1270
		1271	Similarly, to let applications gain access to the C<C-M-c> (copy to
		1272	clipboard) and C<C-M-v> (paste clipboard) key combination, you can do
		1273	this:
		1274
		1275	URxvt.keysym.C-M-c: builtin-string:
		1276	URxvt.keysym.C-M-v: builtin-string:
		1277
		1278	=item EXTENSION:STRING
		1279
		1280	An action of this form invokes the action B<STRING>, if any, provided
		1281	by the @@RXVT_NAME@@perl(3) extension B<EXTENSION>. The extension will
		1282	be loaded automatically if necessary.
		1283
		1284	Not all extensions define actions, but popular extensions that do
		1285	include the I<selection> and I<matcher> extensions (documented in their
		1286	own manpages, @@RXVT_NAME@@-selection(1) and @@RXVT_NAME@@-matcher(1),
		1287	respectively).
		1288
		1289	From the silly examples department, this will rot13-"encrypt"
		1290	@@RXVT_NAME@@'s selection when Alt-Control-c is pressed on typical PC
		1291	keyboards:
		1292
		1293	URxvt.keysym.M-C-c: selection:rot13
		1294
		1295	=item perl:STRING *DEPRECATED*
		1296
		1297	This is a deprecated way of invoking commands provided by perl
		1298	extensions. It is still supported, but should not be used anymore.
		1299
		1300	=back
		1301
		1302	=item B<perl-ext-common>: I<string>
		1303
		1304	=item B<perl-ext>: I<string>
		1305
		1306	Comma-separated list(s) of perl extension scripts (default: C<default>) to
		1307	use in this terminal instance; option B<-pe>.
		1308
		1309	Extension names can be prefixed with a C<-> sign to remove them again, in
		1310	case they had been specified earlier. This can be useful to selectively
		1311	disable some extensions loaded by default, or specified via the
		1312	C<perl-ext-common> resource. For example, C<default,-selection> will use
		1313	all the default extensions except C<selection>.
		1314
		1315	To prohibit autoloading of extensions, you can prefix them with C</>,
		1316	which will make urxvt refuse to automatically load them (this can be
		1317	overriden, however, by specifying the extension name again without a
		1318	prefix, though). This does not prohibit extensions themselves loading
		1319	other extensions. For example, C<default,/background> will keep the
		1320	C<background> extension from being loaded when a background OSC sequence
		1321	is received.
		1322
		1323	The default set includes the C<selection>, C<option-popup>,
		1324	C<selection-popup>, C<readline>, C<searchable-scrollback> and
		1325	C<confirm-paste> extensions, as well as any extensions which are mentioned
		1326	in B<keysym> resources.
		1327
		1328	Any extension such that a corresponding resource is given on the
		1329	command line is automatically appended to B<perl-ext>.
		1330
		1331	Each extension is looked up in the library directories, loaded if
		1332	necessary, and bound to the current terminal instance. When the library
		1333	search path contains multiple extension files of the same name, then the
		1334	first one found will be used.
		1335
		1336	If both of these resources are the empty string, then the perl interpreter
		1337	will not be initialized. The rationale for having two options is that
		1338	B<perl-ext-common> will be used for extensions that should be available to
		1339	all instances, while B<perl-ext> is used for specific instances.
		1340
		1341	=item B<perl-eval>: I<string>
		1342
		1343	Perl code to be evaluated when all extensions have been registered. See
		1344	the @@RXVT_NAME@@perl(3) manpage.
		1345
		1346	=item B<perl-lib>: I<path>
		1347
		1348	Colon-separated list of additional directories that hold extension
		1349	scripts. When looking for perl extensions, @@RXVT_NAME@@ will first look
		1350	in these directories, then in C<$URXVT_PERL_LIB>, F<$HOME/.urxvt/ext> and
		1351	lastly in F<@@RXVT_LIBDIR@@/urxvt/perl/>.
		1352
		1353	See the @@RXVT_NAME@@perl(3) manpage.
		1354
		1355	=item B<< selection.pattern-I<idx> >>: I<perl-regex>
		1356
		1357	Additional selection patterns, see the @@RXVT_NAME@@perl(3) manpage for
		1358	details.
		1359
		1360	=item B<< selection-autotransform.I<idx> >>: I<perl-transform>
		1361
		1362	Selection auto-transform patterns, see the @@RXVT_NAME@@perl(3) manpage
		1363	for details.
		1364
		1365	=item B<searchable-scrollback:> I<keysym> *DEPRECATED*
		1366
		1367	This resource is deprecated and will be removed. Use a B<keysym> resource
		1368	instead, e.g.:
		1369
		1370	URxvt.keysym.M-s: searchable-scrollback:start
		1371
		1372	=item B<url-launcher>: I<string>
		1373
		1374	Specifies the program to be started with a URL argument. Used by the
		1375	C<selection-popup> and C<matcher> perl extensions.
		1376
		1377	=item B<transient-for>: I<windowid>
		1378
		1379	Compile I<frills>: Sets the WM_TRANSIENT_FOR property to the given window id.
		1380
		1381	=item B<override-redirect>: I<boolean>
		1382
		1383	Compile I<frills>: Sets override-redirect for the terminal window, making
		1384	it almost invisible to window managers; option B<-override-redirect>.
		1385
		1386	=item B<iso14755:> I<boolean>
		1387
		1388	Turn on/off ISO 14755 (default enabled).
		1389
		1390	=item B<iso14755_52:> I<boolean>
		1391
		1392	Turn on/off ISO 14755 5.2 mode (default enabled).
913		1393
914	=back	1394	=back
915		1395
916	=head1 THE SCROLLBAR	1396	=head1 THE SCROLLBAR
917		1397
…		…
931	the normal text selection/insertion, hold either the Shift or the Meta	1411	the normal text selection/insertion, hold either the Shift or the Meta
932	(Alt) key while performing the desired mouse action.	1412	(Alt) key while performing the desired mouse action.
933		1413
934	If mouse reporting mode is active, the normal scrollbar actions are	1414	If mouse reporting mode is active, the normal scrollbar actions are
935	disabled -- on the assumption that we are using a fullscreen	1415	disabled -- on the assumption that we are using a fullscreen
936	application. Instead, pressing Button1 and Button3 sends B<ESC[6~>	1416	application. Instead, pressing Button1 and Button3 sends B<ESC [ 6 ~>
937	(Next) and B<ESC[5~> (Prior), respectively. Similarly, clicking on the	1417	(Next) and B<ESC [ 5 ~> (Prior), respectively. Similarly, clicking on the
938	up and down arrows sends B<ESC[A> (Up) and B<ESC[B> (Down),	1418	up and down arrows sends B<ESC [ A> (Up) and B<ESC [ B> (Down),
939	respectively.	1419	respectively.
940		1420
941	=head1 TEXT SELECTION AND INSERTION	1421	=head1 THE SELECTION: SELECTING AND PASTING TEXT
942		1422
943	The behaviour of text selection and insertion mechanism is similar to	1423	The behaviour of text selection and insertion/pasting mechanism is similar
944	I<xterm>(1).	1424	to I<xterm>(1).
945		1425
946	=over 4	1426	=over
947		1427
948	=item B<Selection>:	1428	=item B<Selecting>:
949		1429
950	Left click at the beginning of the region, drag to the end of the region	1430	Left click at the beginning of the region, drag to the end of the region
951	and release; Right click to extend the marked region; Left double-click	1431	and release; Right click to extend the marked region; Left double-click
952	to select a word; Left triple-click to select the entire logical line	1432	to select a word; Left triple-click to select the entire logical line
953	(which can span multiple screen lines), unless modified by resource	1433	(which can span multiple screen lines), unless modified by resource
954	B<tripleclickwords>.	1434	B<tripleclickwords>.
955		1435
956	Starting a selection while pressing the B<Meta> key (or B<Meta+Ctrl> keys)	1436	Starting a selection while pressing the B<Meta> key (or B<Meta+Ctrl> keys)
957	(Compile: I<frills>) will create a rectangular selection instead of a normal	1437	(Compile: I<frills>) will create a rectangular selection instead of a
958	one.	1438	normal one. In this mode, every selected row becomes its own line in the
		1439	selection, and trailing whitespace is visually underlined and removed from
		1440	the selection.
959		1441
960	=item B<Insertion>:	1442	=item B<Pasting>:
961		1443
962	Pressing and releasing the Middle mouse button (or B<Shift-Insert>) in	1444	Pressing and releasing the Middle mouse button in an B<@@RXVT_NAME@@>
963	an B<@@RXVT_NAME@@> window causes the current text selection to be	1445	window causes the value of the PRIMARY selection (or CLIPBOARD with the
964	inserted as if it had been typed on the keyboard.	1446	B<Meta> modifier) to be inserted as if it had been typed on the keyboard.
		1447
		1448	Pressing B<Shift-Insert> causes the value of the PRIMARY selection to be
		1449	inserted too.
		1450
		1451	rxvt-unicode also provides the bindings B<Ctrl-Meta-c> and
		1452	<Ctrl-Meta-v> to interact with the CLIPBOARD selection. The first
		1453	binding causes the value of the internal selection to be copied to the
		1454	CLIPBOARD selection, while the second binding causes the value of the
		1455	CLIPBOARD selection to be inserted.
965		1456
966	=back	1457	=back
967		1458
968	=head1 CHANGING FONTS	1459	=head1 CHANGING FONTS
969		1460
970	Changing fonts (or font sizes, respectively) via the keypad is not yet	1461	Changing fonts (or font sizes, respectively) via the keypad is not yet
971	supported in rxvt-unicode. Bug me if you need this.	1462	supported in rxvt-unicode. Bug me if you need this.
972		1463
973	You can, however, switch fonts at runtime using escape sequences (and	1464	You can, however, switch fonts at runtime using escape sequences, e.g.:
974	therefore using the menubar), e.g.:
975		1465
976	printf '\e]701;%s\007' "9x15bold,xft:Kochi Gothic"	1466	printf '\e]710;%s\007' "9x15bold,xft:Kochi Gothic"
		1467
		1468	You can use keyboard shortcuts, too:
		1469
		1470	URxvt.keysym.M-C-1: command:\033]710;suxuseuro\007\033]711;suxuseuro\007
		1471	URxvt.keysym.M-C-2: command:\033]710;9x15bold\007\033]711;9x15bold\007
977		1472
978	rxvt-unicode will automatically re-apply these fonts to the output so far.	1473	rxvt-unicode will automatically re-apply these fonts to the output so far.
979		1474
980	=head1 ISO 14755 SUPPORT	1475	=head1 ISO 14755 SUPPORT
981		1476
982	ISO 14755 is a standard for entering and viewing unicode characters	1477	ISO 14755 is a standard for entering and viewing unicode characters
983	and character codes using the keyboard. It consists of 4 parts. The	1478	and character codes using the keyboard. It consists of 4 parts. The
984	first part is available rxvt-unicode has been compiled with	1479	first part is available if rxvt-unicode has been compiled with
985	C<--enable-frills>, the rest is available when rxvt-unicode was compiled	1480	C<--enable-frills>, the rest is available when rxvt-unicode was compiled
986	with C<--enable-iso14755>.	1481	with C<--enable-iso14755>.
987		1482
988	=over 4	1483	=over
989		1484
990	=item * 5.1: Basic method	1485	=item * 5.1: Basic method
991		1486
992	This allows you to enter unicode characters using their hexcode.	1487	This allows you to enter unicode characters using their hexcode.
993		1488
…		…
1009	This mode lets you input characters representing the keycap symbols of	1504	This mode lets you input characters representing the keycap symbols of
1010	your keyboard, if representable in the current locale encoding.	1505	your keyboard, if representable in the current locale encoding.
1011		1506
1012	Start by pressing C<Control> and C<Shift> together, then releasing	1507	Start by pressing C<Control> and C<Shift> together, then releasing
1013	them. The next special key (cursor keys, home etc.) you enter will not	1508	them. The next special key (cursor keys, home etc.) you enter will not
1014	invoke it's usual function but instead will insert the corresponding	1509	invoke its usual function but instead will insert the corresponding
1015	keycap symbol. The symbol will only be entered when the key has been	1510	keycap symbol. The symbol will only be entered when the key has been
1016	released, otherwise pressing e.g. C<Shift> would enter the symbol for	1511	released, otherwise pressing e.g. C<Shift> would enter the symbol for
1017	C<ISO Level 2 Switch>, although your intention might have been to enter a	1512	C<ISO Level 2 Switch>, although your intention might have been to enter a
1018	reverse tab (Shift-Tab).	1513	reverse tab (Shift-Tab).
1019		1514
…		…
1047	B<@@RXVT_NAME@@> tries to write an entry into the I<utmp>(5) file so that	1542	B<@@RXVT_NAME@@> tries to write an entry into the I<utmp>(5) file so that
1048	it can be seen via the I<who(1)> command, and can accept messages. To	1543	it can be seen via the I<who(1)> command, and can accept messages. To
1049	allow this feature, B<@@RXVT_NAME@@> may need to be installed setuid root	1544	allow this feature, B<@@RXVT_NAME@@> may need to be installed setuid root
1050	on some systems or setgid to root or to some other group on others.	1545	on some systems or setgid to root or to some other group on others.
1051		1546
1052	=head1 COLORS AND GRAPHICS	1547	=head1 COLOURS AND GRAPHICS
1053		1548
1054	In addition to the default foreground and background colours,	1549	In addition to the default foreground and background colours,
1055	B<@@RXVT_NAME@@> can display up to 16 colours (8 ANSI colours plus	1550	B<@@RXVT_NAME@@> can display up to 88/256 colours: 8 ANSI colours plus
1056	high-intensity bold/blink versions of the same). Here is a list of the	1551	high-intensity (potentially bold/blink) versions of the same, and 72 (or
1057	colours with their B<rgb.txt> names.	1552	240 in 256 colour mode) colours arranged in an 4x4x4 (or 6x6x6) colour RGB
		1553	cube plus a 8 (24) colour greyscale ramp.
		1554
		1555	B<@@RXVT_NAME@@> supports direct 24-bit fg/bg RGB colour escapes
		1556	C< ESC [ 38 ; 2 ; R ; G ; Bm > / C< ESC [ 48 ; 2; R ; G ; Bm >. However the
		1557	number of 24-bit colours that can be used is limited: an internal 7x7x5 (256
		1558	colour mode) or 6x6x4 (88 colour mode) colour cube is used to index into the
		1559	24-bit colour space. When indexing collisions happen, the nearest old colour in
		1560	the cube will be adapted to the new 24-bit RGB colour. That means one cannot
		1561	use many similar 24-bit colours. It's typically not a problem in common
		1562	scenarios.
		1563
		1564	Here is a list of the ANSI colours with their names.
1058		1565
1059	=begin table	1566	=begin table
1060		1567
1061	B<color0> (black) = Black	1568	B<color0> (black) = Black
1062	B<color1> (red) = Red3	1569	B<color1> (red) = Red3
…		…
1082	It is also possible to specify the colour values of B<foreground>,	1589	It is also possible to specify the colour values of B<foreground>,
1083	B<background>, B<cursorColor>, B<cursorColor2>, B<colorBD>, B<colorUL> as	1590	B<background>, B<cursorColor>, B<cursorColor2>, B<colorBD>, B<colorUL> as
1084	a number 0-15, as a convenient shorthand to reference the colour name of	1591	a number 0-15, as a convenient shorthand to reference the colour name of
1085	color0-color15.	1592	color0-color15.
1086		1593
		1594	The following text gives values for the standard 88 colour mode (and
		1595	values for the 256 colour mode in parentheses).
		1596
		1597	The RGB cube uses indices 16..79 (16..231) using the following formulas:
		1598
		1599	index_88 = (r * 4 + g) * 4 + b + 16 # r, g, b = 0..3
		1600	index_256 = (r * 6 + g) * 6 + b + 16 # r, g, b = 0..5
		1601
		1602	The grayscale ramp uses indices 80..87 (232..239), from 10% to 90% in 10%
		1603	steps (1/26 to 25/26 in 1/26 steps) - black and white are already part of
		1604	the RGB cube.
		1605
		1606	Together, all those colours implement the 88 (256) colour xterm
		1607	colours. Only the first 16 can be changed using resources currently, the
		1608	rest can only be changed via command sequences ("escape codes").
		1609
		1610	Applications are advised to use terminfo or command sequences to discover
		1611	number and RGB values of all colours (yes, you can query this...).
		1612
1087	Note that B<-rv> (B<"reverseVideo: True">) simulates reverse video by	1613	Note that B<-rv> (B<"reverseVideo: True">) simulates reverse video by
1088	always swapping the foreground/background colours. This is in contrast to	1614	always swapping the foreground/background colours. This is in contrast to
1089	I<xterm>(1) where the colours are only swapped if they have not otherwise	1615	I<xterm>(1) where the colours are only swapped if they have not otherwise
1090	been specified. For example,	1616	been specified. For example,
1091		1617
1092	=over 4
1093
1094	=item B<@@RXVT_NAME@@ -fg Black -bg White -rv>	1618	@@RXVT_NAME@@ -fg Black -bg White -rv
1095		1619
1096	would yield White on Black, while on I<xterm>(1) it would yield Black	1620	would yield White on Black, while on I<xterm>(1) it would yield Black on
1097	on White.	1621	White.
		1622
		1623	=head2 ALPHA CHANNEL SUPPORT
		1624
		1625	If Xft support has been compiled in and as long as Xft/Xrender/X don't get
		1626	their act together, rxvt-unicode will do its own alpha channel management:
		1627
		1628	You can prefix any colour with an opaqueness percentage enclosed in
		1629	brackets, i.e. C<[percent]>, where C<percent> is a decimal percentage
		1630	(0-100) that specifies the opacity of the colour, where C<0> is completely
		1631	transparent and C<100> is completely opaque. For example, C<[50]red> is a
		1632	half-transparent red, while C<[95]#00ff00> is an almost opaque green. This
		1633	is the recommended format to specify transparency values, and works with
		1634	all ways to specify a colour.
		1635
		1636	For complete control, rxvt-unicode also supports
		1637	C<rgba:rrrr/gggg/bbbb/aaaa> (exactly four hex digits/component) colour
		1638	specifications, where the additional C<aaaa> component specifies opacity
		1639	(alpha) values. The minimum value of C<0000> is completely transparent,
		1640	while C<ffff> is completely opaque). The two example colours from
		1641	earlier could also be specified as C<rgba:ff00/0000/0000/8000> and
		1642	C<rgba:0000/ff00/0000/f332>.
		1643
		1644	You probably need to specify B<"-depth 32">, too, to force a visual with
		1645	alpha channels, and have the luck that your X-server uses ARGB pixel
		1646	layout, as X is far from just supporting ARGB visuals out of the box, and
		1647	rxvt-unicode just fudges around.
		1648
		1649	For example, the following selects an almost completely transparent black
		1650	background, and an almost opaque pink foreground:
		1651
		1652	@@RXVT_NAME@@ -depth 32 -bg rgba:0000/0000/0000/4444 -fg "[80]pink"
		1653
		1654	When not using a background image, then the interpretation of the
		1655	alpha channel is up to your compositing manager (most interpret it as
		1656	transparency of course).
		1657
		1658	When using a background pixmap or pseudo-transparency, then the background
		1659	colour will always behave as if it were completely transparent (so the
		1660	background image shows instead), regardless of how it was specified, while
		1661	other colours will either be transparent as specified (the background
		1662	image will show through) on servers supporting the RENDER extension, or
		1663	fully opaque on servers not supporting the RENDER EXTENSION.
		1664
		1665	Please note that due to bugs in Xft, specifying alpha values might result
		1666	in garbage being displayed when the X-server does not support the RENDER
		1667	extension.
		1668
		1669	=head1 ENVIRONMENT
		1670
		1671	B<@@RXVT_NAME@@> sets and/or uses the following environment variables:
		1672
		1673	=over
		1674
		1675	=item B<TERM>
		1676
		1677	Normally set to C<rxvt-unicode>, unless overwritten at configure time, via
		1678	resources or on the command line.
		1679
		1680	=item B<COLORTERM>
		1681
		1682	Either C<rxvt>, C<rxvt-xpm>, depending on whether @@RXVT_NAME@@ was
		1683	compiled with background image support, and optionally with the added
		1684	extension C<-mono> to indicate that rxvt-unicode runs on a monochrome
		1685	screen.
		1686
		1687	=item B<COLORFGBG>
		1688
		1689	Set to a string of the form C<fg;bg> or C<fg;xpm;bg>, where C<fg> is
		1690	the colour code used as default foreground/text colour (or the string
		1691	C<default> to indicate that the default-colour escape sequence is to be
		1692	used), C<bg> is the colour code used as default background colour (or the
		1693	string C<default>), and C<xpm> is the string C<default> if @@RXVT_NAME@@
		1694	was compiled with background image support. Libraries like C<ncurses>
		1695	and C<slang> can (and do) use this information to optimize screen output.
		1696
		1697	=item B<WINDOWID>
		1698
		1699	Set to the (decimal) X Window ID of the @@RXVT_NAME@@ window (the toplevel
		1700	window, which usually has subwindows for the scrollbar, the terminal
		1701	window and so on).
		1702
		1703	=item B<TERMINFO>
		1704
		1705	Set to the terminfo directory iff @@RXVT_NAME@@ was configured with
		1706	C<--with-terminfo=PATH>.
		1707
		1708	=item B<DISPLAY>
		1709
		1710	Used by @@RXVT_NAME@@ to connect to the display and set to the correct
		1711	display in its child processes if C<-display> isn't used to override. It
		1712	defaults to C<:0> if it doesn't exist.
		1713
		1714	=item B<SHELL>
		1715
		1716	The shell to be used for command execution, defaults to C</bin/sh>.
		1717
		1718	=item B<RXVT_SOCKET> [I<sic>]
		1719
		1720	The unix domain socket path used by @@RXVT_NAME@@c(1) and
		1721	@@RXVT_NAME@@d(1).
		1722
		1723	Default F<<< $HOME/.urxvt/urxvtd-I<< <nodename> >> >>>.
		1724
		1725	=item B<URXVT_PERL_LIB>
		1726
		1727	Additional F<:>-separated library search path for perl extensions. Will be
		1728	searched after B<-perl-lib> but before F<~/.urxvt/ext> and the system library
		1729	directory.
		1730
		1731	=item B<URXVT_PERL_VERBOSITY>
		1732
		1733	See L<@@RXVT_NAME@@perl>(3).
		1734
		1735	=item B<HOME>
		1736
		1737	Used to locate the default directory for the unix domain socket for
		1738	daemon communications and to locate various resource files (such as
		1739	C<.Xdefaults>)
		1740
		1741	=item B<XAPPLRESDIR>
		1742
		1743	Directory where application-specific X resource files are located.
		1744
		1745	=item B<XENVIRONMENT>
		1746
		1747	If set and accessible, gives the name of a X resource file to be loaded by
		1748	@@RXVT_NAME@@.
1098		1749
1099	=back	1750	=back
1100		1751
1101	=head1 ENVIRONMENT
1102
1103	B<@@RXVT_NAME@@> sets the environment variables B<TERM>, B<COLORTERM>
1104	and B<COLORFGBG>. The environment variable B<WINDOWID> is set to the X
1105	window id number of the B<@@RXVT_NAME@@> window and it also uses and
1106	sets the environment variable B<DISPLAY> to specify which display
1107	terminal to use. B<@@RXVT_NAME@@> uses the environment variables
1108	B<RXVTPATH> and B<PATH> to find XPM files.
1109
1110	=head1 FILES	1752	=head1 FILES
1111		1753
1112	=over 4	1754	=over
1113		1755
1114	=item B</usr/lib/X11/rgb.txt>	1756	=item B</usr/lib/X11/rgb.txt>
1115		1757
1116	Color names.	1758	Colour names.
1117		1759
1118	=back	1760	=back
1119		1761
1120	=head1 SEE ALSO	1762	=head1 SEE ALSO
1121		1763
		1764	@@RXVT_NAME@@(7), @@RXVT_NAME@@c(1), @@RXVT_NAME@@d(1), @@RXVT_NAME@@-extensions(1),
1122	@@RXVT_NAME@@(7), xterm(1), sh(1), resize(1), X(1), pty(4), tty(4), utmp(5)	1765	@@RXVT_NAME@@perl(3), xterm(1), sh(1), resize(1), X(1), pty(4), tty(4), utmp(5)
1123
1124	=head1 BUGS
1125
1126	Check the BUGS file for an up-to-date list.
1127
1128	Cursor change support is not yet implemented.
1129
1130	Click-and-drag doesn't work with X11 mouse report overriding.
1131		1766
1132	=head1 CURRENT PROJECT COORDINATOR	1767	=head1 CURRENT PROJECT COORDINATOR
1133		1768
1134	=over 4	1769	=over
1135		1770
1136	=item Project Coordinator	1771	=item Project Coordinator
1137		1772
1138	@@RXVT_MAINT@@ L<@@RXVT_MAINTEMAIL@@>	1773	Marc A. Lehmann <rxvt-unicode@schmorp.de>.
1139		1774
1140	=item Web page maintainter	1775	L<http://software.schmorp.de/pkg/rxvt-unicode.html>
1141
1142	@@RXVT_WEBMAINT@@ L<@@RXVT_WEBMAINTEMAIL@@>
1143
1144	L<@@RXVT_WEBPAGE@@>
1145		1776
1146	=back	1777	=back
1147		1778
1148	=head1 AUTHORS	1779	=head1 AUTHORS
1149		1780
1150	=over 4	1781	=over
1151		1782
1152	=item John Bovey	1783	=item John Bovey
1153		1784
1154	University of Kent, 1992, wrote the original Xvt.	1785	University of Kent, 1992, wrote the original Xvt.
1155		1786
1156	=item Rob Nation L<< <nation@rocket.sanders.lockheed.com> >>	1787	=item Rob Nation <nation@rocket.sanders.lockheed.com>
1157		1788
1158	very heavily modified Xvt and came up with Rxvt	1789	very heavily modified Xvt and came up with Rxvt
1159		1790
1160	=item Angelo Haritsis L<< <ah@doc.ic.ac.uk> >>	1791	=item Angelo Haritsis <ah@doc.ic.ac.uk>
1161		1792
1162	wrote the Greek Keyboard Input (no longer in code)	1793	wrote the Greek Keyboard Input (no longer in code)
1163		1794
1164	=item mj olesen L<< <olesen@me.QueensU.CA> >>	1795	=item mj olesen <olesen@me.QueensU.CA>
1165		1796
1166	Wrote the menu system.	1797	Wrote the menu system.
1167		1798
1168	Project Coordinator (changes.txt 2.11 to 2.21)	1799	Project Coordinator (changes.txt 2.11 to 2.21)
1169		1800
1170	=item Oezguer Kesim L<< <kesim@math.fu-berlin.de> >>	1801	=item Oezguer Kesim <kesim@math.fu-berlin.de>
1171		1802
1172	Project Coordinator (changes.txt 2.21a to 2.4.5)	1803	Project Coordinator (changes.txt 2.21a to 2.4.5)
1173		1804
1174	=item Geoff Wing L<< <gcw@pobox.com> >>	1805	=item Geoff Wing <gcw@pobox.com>
1175		1806
1176	Rewrote screen display and text selection routines. Project Coordinator	1807	Rewrote screen display and text selection routines.
		1808
1177	(changes.txt 2.4.6 - rxvt-unicode)	1809	Project Coordinator (changes.txt 2.4.6 - rxvt-unicode)
1178		1810
1179	=item Marc Alexander Lehmann L<< <rxvt@schmorp.de> >>	1811	=item Marc Alexander Lehmann <rxvt-unicode@schmorp.de>
1180		1812
1181	Forked rxvt-unicode, rewrote most of the display code and internal	1813	Forked rxvt-unicode, unicode support, rewrote almost all the code, perl
1182	character handling to store text in unicode, improve xterm	1814	extension, random hacks, numerous bugfixes and extensions.
1183	compatibility and apply numerous other bugfixes and extensions.
1184		1815
1185	Project Coordinator (Changes 1.0 -)	1816	Project Coordinator (Changes 1.0 -)
1186		1817
		1818	=item Emanuele Giaquinta <emanuele.giaquinta@gmail.com>
		1819
		1820	pty/utmp code rewrite, image code improvements, many random hacks and bugfixes.
		1821
1187	=back	1822	=back
1188		1823

Diff Legend

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