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.22 by root, Tue Aug 24 15:46:27 2004 UTC vs.
Revision 1.244 by sf-exg, Tue Jun 16 11:58:26 2015 UTC

…		…
12	emulator intended as an I<xterm>(1) replacement for users who do not	12	emulator intended as an I<xterm>(1) replacement for users who do not
13	require features such as Tektronix 4014 emulation and toolkit-style	13	require features such as Tektronix 4014 emulation and toolkit-style
14	configurability. As a result, B<rxvt-unicode> uses much less swap space --	14	configurability. As a result, B<rxvt-unicode> uses much less swap space --
15	a significant advantage on a machine serving many X sessions.	15	a significant advantage on a machine serving many X sessions.
16		16
		17	This document is also available on the World-Wide-Web at
		18	L<http://pod.tst.eu/http://cvs.schmorp.de/rxvt-unicode/doc/rxvt.1.pod>.
		19
		20	=head1 FREQUENTLY ASKED QUESTIONS
		21
		22	See @@RXVT_NAME@@(7) (try C<man 7 @@RXVT_NAME@@>) for a list of
		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>.
		26
17	=head1 RXVT-UNICODE VS. RXVT	27	=head1 RXVT-UNICODE VS. RXVT
18		28
19	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
20	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
21	world. Being a terminal emulator, however, some things are very difficult,	31	world. Being a terminal emulator, however, some things are very difficult,
22	especially cursive scripts such as arabic, vertically written scripts	32	especially cursive scripts such as arabic, vertically written scripts
23	like mongolian or scripts requiring extremely complex combining rules,	33	like mongolian or scripts requiring extremely complex combining rules,
24	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
25	scripts. Most other scripts, latin, cyrillic, kanji, thai etc. should work	35	scripts. Most other scripts, latin, cyrillic, kanji, thai etc. should work
26	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
27	as hebrew: B<rxvt-unicode> adopts the view that bidirectional algorithms	37	as hebrew: B<rxvt-unicode> adopts the view that bidirectional algorithms
28	belong into the application, not the terminal emulator (too many things --	38	belong in the application, not the terminal emulator (too many things --
29	such as cursor-movement while editing -- break othwerwise), but that might	39	such as cursor-movement while editing -- break otherwise), but that might
30	change.	40	change.
31		41
32	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
33	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
34	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
35	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
36	another for japanese.	46	another for japanese.
37		47
38	Therefore another design rationale was the use of multiple fonts to	48	Therefore another design rationale was the use of multiple fonts to
39	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
40	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
41	to choose any font for any script freely.	51	to choose any font for any script freely.
42		52
43	Apart from that, rxvt-unicode is also much better internationalised than	53	Apart from that, rxvt-unicode is also much better internationalised than
44	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
45	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
46	rxvt. This all in addition to dozens of other small improvements.	56	rxvt. This all in addition to dozens of other small improvements.
47		57
48	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
49	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
50	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
51	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
52	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
53	drastically reduces memory usage. See @@RXVT_NAME@@d(1) (daemon) and	63	drastically reduces memory usage. See @@RXVT_NAME@@d(1) (daemon) and
54	@@RXVT_NAME@@c(1) (client).	64	@@RXVT_NAME@@c(1) (client).
55		65
56	It also makes technical information about escape sequences (which have	66	It also makes technical information about escape sequences (which have
57	been extended) easier accessible: see @@RXVT_NAME@@(7) for technical	67	been extended) more accessible: see @@RXVT_NAME@@(7) for technical
58	reference documentation (escape sequences etc.) and the FAQ section at the	68	reference documentation (escape sequences etc.).
59	end of this document.
60		69
61	=head1 OPTIONS	70	=head1 OPTIONS
62		71
63	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
64	below. In keeping with the smaller-is-better philosophy, options may be	73	below. In keeping with the smaller-is-better philosophy, options may be
…		…
83		92
84	Print out a message describing available options.	93	Print out a message describing available options.
85		94
86	=item B<-display> I<displayname>	95	=item B<-display> I<displayname>
87		96
88	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>
89	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
90	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.
91		116
92	=item B<-geometry> I<geom>	117	=item B<-geometry> I<geom>
93		118
94	Window geometry (B<-g> still respected); resource B<geometry>.	119	Window geometry (B<-g> still respected); resource B<geometry>.
95		120
…		…
97		122
98	Turn on/off simulated reverse video; resource B<reverseVideo>.	123	Turn on/off simulated reverse video; resource B<reverseVideo>.
99		124
100	=item B<-j>|B<+j>	125	=item B<-j>|B<+j>
101		126
102	Turn on/off jump scrolling; resource B<jumpScroll>.	127	Turn on/off jump scrolling (allow multiple lines per refresh); resource B<jumpScroll>.
103		128
104	=item B<-ip>|B<+ip>	129	=item B<-ss>|B<+ss>
105		130
106	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>.
107	B<-tr>; resource B<inheritPixmap>.
108		132
109	=item B<-fade> I<number>	133	=item B<-fade> I<number>
110		134
111	Fade the text by the given percentage when focus is lost.	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>.
112		138
113	=item B<-tint> I<colour>	139	=item B<-fadecolor> I<colour>
114		140
115	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
116	transparency is enabled with B<-tr> or B<-ip>. See also the B<-sh>	142	is opaque black. resource B<fadeColor>.
117	option that can be used to brighten or darken the image in addition to
118	tinting it.
119		143
120	=item B<-sh>	144	=item B<-icon> I<file>
121		145
122	I<number> Darken (0 .. 100) or lighten (-1 .. -100) the transparent	146	Compile I<pixbuf>: Use the specified image as application icon. This
123	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
124	specified, too).	148	application window; resource I<iconFile>.
125		149
126	=item B<-bg> I<colour>	150	=item B<-bg> I<colour>
127		151
128	Window background colour; resource B<background>.	152	Window background colour; resource B<background>.
129		153
130	=item B<-fg> I<colour>	154	=item B<-fg> I<colour>
131		155
132	Window foreground colour; resource B<foreground>.	156	Window foreground colour; resource B<foreground>.
133
134	=item B<-pixmap> I<file[;geom]>
135
136	Compile I<XPM>: Specify XPM file for the background and also optionally
137	specify its scaling with a geometry string. Note you may need to add
138	quotes to avoid special shell interpretation of the `;' in the
139	command-line; resource B<backgroundPixmap>.
140		157
141	=item B<-cr> I<colour>	158	=item B<-cr> I<colour>
142		159
143	The cursor colour; resource B<cursorColor>.	160	The cursor colour; resource B<cursorColor>.
144		161
…		…
156	resource B<borderColor>.	173	resource B<borderColor>.
157		174
158	=item B<-fn> I<fontlist>	175	=item B<-fn> I<fontlist>
159		176
160	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
161	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
162	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
163	smaller, but not (in general) larger. A reasonable default font list is	180	smaller, but not (in general) larger. A (hopefully) reasonable default
164	always appended to it. See resource B<font> for details.	181	font list is always appended to it. See resource B<font> for more details.
		182
		183	In short, to specify an X11 core font, just specify its name or prefix it
		184	with C<x:>. To specify an XFT-font, you need to prefix it with C<xft:>,
		185	e.g.:
		186
		187	@@RXVT_NAME@@ -fn "xft:Bitstream Vera Sans Mono:pixelsize=15"
		188	@@RXVT_NAME@@ -fn "9x15bold,xft:Bitstream Vera Sans Mono"
165		189
166	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
167	section.	191	section of @@RXVT_NAME@@(7).
168		192
169	=item B<-fb> I<fontlist>	193	=item B<-fb> I<fontlist>
170		194
171	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
172	be printed. See resource B<boldFont> for details.	196	are to be printed. See resource B<boldFont> for details.
173		197
174	=item B<-fi> I<fontlist>	198	=item B<-fi> I<fontlist>
175		199
176	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>
177	be printed. See resource B<italicFont> for details.	201	characters are to be printed. See resource B<italicFont> for details.
178		202
179	=item B<-fbi> I<fontlist>	203	=item B<-fbi> I<fontlist>
180		204
181	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
182	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.
183		214
184	=item B<-name> I<name>	215	=item B<-name> I<name>
185		216
186	Specify the application name under which resources are to be obtained,	217	Specify the application name under which resources are to be obtained,
187	rather than the default executable file name. Name should not contain	218	rather than the default executable file name. Name should not contain
…		…
189		220
190	=item B<-ls>|B<+ls>	221	=item B<-ls>|B<+ls>
191		222
192	Start as a login-shell/sub-shell; resource B<loginShell>.	223	Start as a login-shell/sub-shell; resource B<loginShell>.
193		224
		225	=item B<-mc> I<milliseconds>
		226
		227	Specify the maximum time between multi-click selections.
		228
194	=item B<-ut>|B<+ut>	229	=item B<-ut>|B<+ut>
195		230
196	Compile I<utmp>: Inhibit/enable writing a utmp entry; resource	231	Compile I<utmp>: Inhibit/enable writing a utmp entry; resource
197	B<utmpInhibit>.	232	B<utmpInhibit>.
198		233
…		…
202	B<visualBell>.	237	B<visualBell>.
203		238
204	=item B<-sb>|B<+sb>	239	=item B<-sb>|B<+sb>
205		240
206	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>.
207		251
208	=item B<-si>|B<+si>	252	=item B<-si>|B<+si>
209		253
210	Turn on/off scroll-to-bottom on TTY output inhibit; resource	254	Turn on/off scroll-to-bottom on TTY output inhibit; resource
211	B<scrollTtyOutput> has opposite effect.	255	B<scrollTtyOutput> has opposite effect.
…		…
219		263
220	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.
221	This only takes effect if B<-si> is also given; resource	265	This only takes effect if B<-si> is also given; resource
222	B<scrollWithBuffer>.	266	B<scrollWithBuffer>.
223		267
224	=item B<-sr>|B<+sr>
225
226	Put scrollbar on right/left; resource B<scrollBar_right>.
227
228	=item B<-st>|B<+st>	268	=item B<-ptab>|B<+ptab>
229		269
230	Display normal (non XTerm/NeXT) scrollbar without/with a trough;	270	If enabled (default), "Horizontal Tab" characters are being stored as
231	resource B<scrollBar_floating>.	271	actual wide characters in the screen buffer, which makes it possible to
		272	select and paste them. Since a horizontal tab is a cursor movement and
		273	not an actual glyph, this can sometimes be visually annoying as the cursor
		274	on a tab character is displayed as a wide cursor; resource B<pastableTabs>.
232		275
233	=item B<-bc>|B<+bc>	276	=item B<-bc>|B<+bc>
234		277
235	Blink the cursor; resource B<cursorBlink>.	278	Blink the cursor; resource B<cursorBlink>.
		279
		280	=item B<-uc>|B<+uc>
		281
		282	Make the cursor underlined; resource B<cursorUnderline>.
236		283
237	=item B<-iconic>	284	=item B<-iconic>
238		285
239	Start iconified, if the window manager supports that option.	286	Start iconified, if the window manager supports that option.
240	Alternative form is B<-ic>.	287	Alternative form is B<-ic>.
…		…
257		304
258	=item B<-bl>	305	=item B<-bl>
259		306
260	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.
261	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
262	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>.
263		328
264	=item B<-lsp> I<number>	329	=item B<-lsp> I<number>
265		330
266	Compile I<linespace>: Lines (pixel height) to insert between each row	331	Compile I<frills>: Lines (pixel height) to insert between each row of
267	of the display; resource B<linespace>.	332	the display. Useful to work around font rendering problems; resource
		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>.
268		341
269	=item B<-tn> I<termname>	342	=item B<-tn> I<termname>
270		343
271	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
272	B<TERM> environment variable. This terminal type must exist in the	345	B<TERM> environment variable. This terminal type must exist in the
…		…
281	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
282	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
283	run the program specified by the B<SHELL> environment variable or,	356	run the program specified by the B<SHELL> environment variable or,
284	failing that, I<sh(1)>.	357	failing that, I<sh(1)>.
285		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
286	=item B<-title> I<text>	364	=item B<-title> I<text>
287		365
288	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
289	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
290	application name; resource B<title>.	368	application name; resource B<title>.
…		…
302	=item B<-pt> I<style>	380	=item B<-pt> I<style>
303		381
304	Compile I<XIM>: input style for input method; B<OverTheSpot>,	382	Compile I<XIM>: input style for input method; B<OverTheSpot>,
305	B<OffTheSpot>, B<Root>; resource B<preeditType>.	383	B<OffTheSpot>, B<Root>; resource B<preeditType>.
306		384
		385	If the perl extension C<xim-onthespot> is used (which is the default),
		386	then additionally the C<OnTheSpot> preedit type is available.
		387
307	=item B<-im> I<text>	388	=item B<-im> I<text>
308		389
309	Compile I<XIM>: input method name. resource B<inputMethod>.	390	Compile I<XIM>: input method name. resource B<inputMethod>.
310		391
311	=item B<-imlocale> I<string>	392	=item B<-imlocale> I<string>
312		393
313	The locale to use for opening the IM. You can use an LC_CTYPE of e.g.	394	The locale to use for opening the IM. You can use an C<LC_CTYPE> of e.g.
314	de_DE.UTF-8 for normal text processing but ja_JP.EUC-JP for the input	395	C<de_DE.UTF-8> for normal text processing but C<ja_JP.EUC-JP> for the
315	extension to be able to input japanese characters while staying in	396	input extension to be able to input japanese characters while staying in
316	another locale.	397	another locale. resource B<imLocale>.
		398
		399	=item B<-imfont> I<fontset>
		400
		401	Set the font set to use for the X Input Method, see resource B<imFont>
		402	for more info.
		403
		404	=item B<-tcw>
		405
		406	Change the meaning of triple-click selection with the left mouse
		407	button. Only effective when the original (non-perl) selection code is
		408	in-use. Instead of selecting a full line it will extend the selection to
		409	the end of the logical line only. resource B<tripleclickwords>.
317		410
318	=item B<-insecure>	411	=item B<-insecure>
319		412
320	Enable "insecure" mode, which currently enables most of the escape	413	Enable "insecure" mode, which currently enables most of the escape
321	sequences that echo strings. See the resource B<insecure> for more	414	sequences that echo strings. See the resource B<insecure> for more
…		…
335	=item B<-ssr>|B<+ssr>	428	=item B<-ssr>|B<+ssr>
336		429
337	Turn on/off secondary screen scroll (default enabled); resource	430	Turn on/off secondary screen scroll (default enabled); resource
338	B<secondaryScroll>.	431	B<secondaryScroll>.
339		432
		433	=item B<-hold>|B<+hold>
		434
		435	Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@
		436	will not immediately destroy its window when the program executed within
		437	it exits. Instead, it will wait till it is being killed or closed by the
		438	user; resource B<hold>.
		439
		440	=item B<-cd> I<path>
		441
		442	Sets the working directory for the shell (or the command specified via
		443	B<-e>). The I<path> must be an absolute path and it must exist for
		444	@@RXVT_NAME@@ to start; resource B<chdir>.
		445
340	=item B<-xrm> I<resourcestring>	446	=item B<-xrm> I<string>
341		447
342	No effect on rxvt-unicode. Simply passes through an argument to be made	448	Works like the X Toolkit option of the same name, by adding the I<string>
343	available in the instance's argument list. Appears in I<WM_COMMAND> in	449	as if it were specified in a resource file. Resource values specified this
344	some window managers.	450	way take precedence over all other resource specifications.
		451
		452	Note that you need to use the I<same> syntax as in the .Xdefaults file,
		453	e.g. C<*.background: black>. Also note that all @@RXVT_NAME@@-specific
		454	options can be specified as long-options on the commandline, so use
		455	of B<-xrm> is mostly limited to cases where you want to specify other
		456	resources (e.g. for input methods) or for compatibility with other
		457	programs.
		458
		459	=item B<-keysym.>I<sym> I<string>
		460
		461	Remap a key symbol. See resource B<keysym>.
		462
		463	=item B<-embed> I<windowid>
		464
		465	Tells @@RXVT_NAME@@ to embed its windows into an already-existing window,
		466	which enables applications to easily embed a terminal.
		467
		468	Right now, @@RXVT_NAME@@ will first unmap/map the specified window, so it
		469	shouldn't be a top-level window. @@RXVT_NAME@@ will also reconfigure it
		470	quite a bit, so don't expect it to keep some specific state. It's best to
		471	create an extra subwindow for @@RXVT_NAME@@ and leave it alone.
		472
		473	The window will not be destroyed when @@RXVT_NAME@@ exits.
		474
		475	It might be useful to know that @@RXVT_NAME@@ will not close file
		476	descriptors passed to it (except for stdin/out/err, of course), so you
		477	can use file descriptors to communicate with the programs within the
		478	terminal. This works regardless of whether the C<-embed> option was used or
		479	not.
		480
		481	Here is a short Gtk2-perl snippet that illustrates how this option can be
		482	used (a longer example is in F<doc/embed>):
		483
		484	my $rxvt = new Gtk2::Socket;
		485	$rxvt->signal_connect_after (realize => sub {
		486	my $xid = $_[0]->window->get_xid;
		487	system "@@RXVT_NAME@@ -embed $xid &";
		488	});
		489
		490	=item B<-pty-fd> I<file descriptor>
		491
		492	Tells @@RXVT_NAME@@ NOT to execute any commands or create a new pty/tty
		493	pair but instead use the given file descriptor as the tty master. This is
		494	useful if you want to drive @@RXVT_NAME@@ as a generic terminal emulator
		495	without having to run a program within it.
		496
		497	If this switch is given, @@RXVT_NAME@@ will not create any utmp/wtmp
		498	entries and will not tinker with pty/tty permissions - you have to do that
		499	yourself if you want that.
		500
		501	As an extremely special case, specifying C<-1> will completely suppress
		502	pty/tty operations, which is probably only useful in conjunction with some
		503	perl extension that manages the terminal.
		504
		505	Here is a example in perl that illustrates how this option can be used (a
		506	longer example is in F<doc/pty-fd>):
		507
		508	use IO::Pty;
		509	use Fcntl;
		510
		511	my $pty = new IO::Pty;
		512	fcntl $pty, F_SETFD, 0; # clear close-on-exec
		513	system "@@RXVT_NAME@@ -pty-fd " . (fileno $pty) . "&";
		514	close $pty;
		515
		516	# now communicate with rxvt
		517	my $slave = $pty->slave;
		518	while (<$slave>) { print $slave "got <$_>\n" }
		519
		520	=item B<-pe> I<string>
		521
		522	Comma-separated list of perl extension scripts to use (or not to use) in
		523	this terminal instance. See resource B<perl-ext> for details.
345		524
346	=back	525	=back
347		526
348	=head1 RESOURCES (available also as long-options)	527	=head1 RESOURCES
349		528
350	Note: `@@RXVT_NAME@@ --help' gives a list of all resources (long	529	Note: `@@RXVT_NAME@@ --help' gives a list of all resources (long
351	options) compiled into your version.	530	options) compiled into your version. All resources are also available as
		531	long-options.
352		532
353	There are two different methods that @@RXVT_NAME@@ can use to get the	533	You can set and change the resources using X11 tools like B<xrdb>. Many
354	Xresource data: using the X libraries (Xrm*-functions) or internal	534	distribution do also load settings from the B<~/.Xresources> file when X
355	Xresources reader (B<~/.Xdefaults>). For the first method (ie.	535	starts. @@RXVT_NAME@@ will consult the following files/resources in order,
356	B<@@RXVT_NAME@@ -h> lists B<XGetDefaults>), you can set and change the	536	with later settings overwriting earlier ones:
357	resources using X11 tools like B<xset>. Many distribution do also load
358	settings from the B<~/.Xresources> file when X starts.
359		537
360	If compiled with internal Xresources support (i.e. B<@@RXVT_NAME@@ -h>	538	1. app-defaults file in $XAPPLRESDIR
361	lists B<.Xdefaults>) then B<@@RXVT_NAME@@> accepts application defaults	539	2. $HOME/.Xdefaults
362	set in XAPPLOADDIR/URxvt (compile-time defined: usually	540	3. RESOURCE_MANAGER property on root-window of screen 0
363	B</usr/lib/X11/app-defaults/URxvt>) and resources set in	541	4. SCREEN_RESOURCES property on root-window of the current screen
364	B<~/.Xdefaults>, or B<~/.Xresources> if B<~/.Xdefaults> does not exist.	542	5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename>
		543	6. resources specified via -xrm on the commandline
		544
365	Note that when reading X resources, B<@@RXVT_NAME@@> recognizes two	545	Note that when reading X resources, B<@@RXVT_NAME@@> recognizes two class
366	class names: B<XTerm> and B<URxvt>. The class name B<Rxvt> allows	546	names: B<Rxvt> and B<URxvt>. The class name B<Rxvt> allows resources
367	resources common to both B<@@RXVT_NAME@@> and the original I<rxvt> to be	547	common to both B<@@RXVT_NAME@@> and the original I<rxvt> to be easily
368	easily configured, while the class name B<URxvt> allows resources	548	configured, while the class name B<URxvt> allows resources unique to
369	unique to B<@@RXVT_NAME@@>, notably colours and key-handling, to be	549	B<@@RXVT_NAME@@>, to be shared between different B<@@RXVT_NAME@@>
370	shared between different B<@@RXVT_NAME@@> configurations. If no	550	configurations. If no resources are specified, suitable defaults will
371	resources are specified, suitable defaults will be used. Command-line	551	be used. Command-line arguments can be used to override resource
372	arguments can be used to override resource settings. The following	552	settings. The following resources are supported (you might want to
373	resources are allowed:	553	check the @@RXVT_NAME@@perl(3) manpage for additional settings by perl
		554	extensions not documented here):
374		555
375	=over 4	556	=over 4
		557
		558	=item B<depth:> I<bitdepth>
		559
		560	Compile I<xft>: Attempt to find a visual with the given bit depth;
		561	option B<-depth>.
		562
		563	=item B<buffered:> I<boolean>
		564
		565	Compile I<xft>: Turn on/off double-buffering for xft (default enabled).
		566	On some card/driver combination enabling it slightly decreases
		567	performance, on most it greatly helps it. The slowdown is small, so it
		568	should normally be enabled.
376		569
377	=item B<geometry:> I<geom>	570	=item B<geometry:> I<geom>
378		571
379	Create the window with the specified X window geometry [default 80x24];	572	Create the window with the specified X window geometry [default 80x24];
380	option B<-geometry>.	573	option B<-geometry>.
…		…
394	Use the specified colour for the colour value I<n>, where 0-7	587	Use the specified colour for the colour value I<n>, where 0-7
395	corresponds to low-intensity (normal) colours and 8-15 corresponds to	588	corresponds to low-intensity (normal) colours and 8-15 corresponds to
396	high-intensity (bold = bright foreground, blink = bright background)	589	high-intensity (bold = bright foreground, blink = bright background)
397	colours. The canonical names are as follows: 0=black, 1=red, 2=green,	590	colours. The canonical names are as follows: 0=black, 1=red, 2=green,
398	3=yellow, 4=blue, 5=magenta, 6=cyan, 7=white, but the actual colour	591	3=yellow, 4=blue, 5=magenta, 6=cyan, 7=white, but the actual colour
399	names used are listed in the B<COLORS AND GRAPHICS> section.	592	names used are listed in the B<COLOURS AND GRAPHICS> section.
400		593
401	Colours higher than 15 cannot be set using resources (yet), but can be	594	Colours higher than 15 cannot be set using resources (yet), but can be
402	changed using an escape command (see @@RXVT_NAME@@(7)).	595	changed using an escape command (see @@RXVT_NAME@@(7)).
403		596
404	Colours 16-79 form a standard 4x4x4 colour cube (the same as xterm with	597	Colours 16-79 form a standard 4x4x4 colour cube (the same as xterm with
…		…
408		601
409	=item B<colorIT:> I<colour>	602	=item B<colorIT:> I<colour>
410		603
411	Use the specified colour to display bold or italic characters when the	604	Use the specified colour to display bold or italic characters when the
412	foreground colour is the default. If font styles are not available	605	foreground colour is the default. If font styles are not available
413	(Compile styles) and this option is unset, reverse video is used instead.	606	(Compile I<styles>) and this option is unset, reverse video is used instead.
414		607
415	=item B<colorUL:> I<colour>	608	=item B<colorUL:> I<colour>
416		609
417	Use the specified colour to display underlined characters when the	610	Use the specified colour to display underlined characters when the
418	foreground colour is the default.	611	foreground colour is the default.
419		612
420	=item B<colorRV:> I<colour>	613	=item B<underlineColor:> I<colour>
421		614
		615	If set, use the specified colour as the colour for the underline
		616	itself. If unset, use the foreground colour.
		617
		618	=item B<highlightColor:> I<colour>
		619
422	Use the specified colour as the background for reverse video	620	If set, use the specified colour as the background for highlighted
423	characters.	621	characters. If unset, use reverse video.
		622
		623	=item B<highlightTextColor:> I<colour>
		624
		625	If set and highlightColor is set, use the specified colour as the
		626	foreground for highlighted characters.
424		627
425	=item B<cursorColor:> I<colour>	628	=item B<cursorColor:> I<colour>
426		629
427	Use the specified colour for the cursor. The default is to use the	630	Use the specified colour for the cursor. The default is to use the
428	foreground colour; option B<-cr>.	631	foreground colour; option B<-cr>.
…		…
435		638
436	=item B<reverseVideo:> I<boolean>	639	=item B<reverseVideo:> I<boolean>
437		640
438	B<True>: simulate reverse video by foreground and background colours;	641	B<True>: simulate reverse video by foreground and background colours;
439	option B<-rv>. B<False>: regular screen colours [default]; option	642	option B<-rv>. B<False>: regular screen colours [default]; option
440	B<+rv>. See note in B<COLORS AND GRAPHICS> section.	643	B<+rv>. See note in B<COLOURS AND GRAPHICS> section.
441		644
442	=item B<jumpScroll:> I<boolean>	645	=item B<jumpScroll:> I<boolean>
443		646
444	B<True>: specify that jump scrolling should be used. When scrolling	647	B<True>: specify that jump scrolling should be used. When receiving lots
445	quickly, fewer screen updates are performed [default]; option B<-j>.	648	of lines, @@RXVT_NAME@@ will only scroll once a whole screen height of lines
		649	has been read, resulting in fewer updates while still displaying every
		650	received line; option B<-j>.
		651
446	B<False>: specify that smooth scrolling should be used; option B<+j>.	652	B<False>: specify that smooth scrolling should be used. @@RXVT_NAME@@ will
		653	force a screen refresh on each new line it received; option B<+j>.
447		654
448	=item B<inheritPixmap:> I<boolean>	655	=item B<skipScroll:> I<boolean>
449		656
450	B<True>: make the background inherit the parent windows' pixmap, giving	657	B<True>: (the default) specify that skip scrolling should be used. When
451	artificial transparency. B<False>: do not inherit the parent windows'	658	receiving lots of lines, @@RXVT_NAME@@ will only scroll once in a while
452	pixmap.	659	(around 60 times per second), resulting in far fewer updates. This can
		660	result in @@RXVT_NAME@@ not ever displaying some of the lines it receives;
		661	option B<-ss>.
		662
		663	B<False>: specify that everything is to be displayed, even
		664	if the refresh is too fast for the human eye to read anything (or the
		665	monitor to display anything); option B<+ss>.
453		666
454	=item B<fading:> I<number>	667	=item B<fading:> I<number>
455		668
456	Fade the text by the given percentage when focus is lost.	669	Fade the text by the given percentage when focus is lost; option B<-fade>.
457		670
458	=item B<tintColor:> I<colour>	671	=item B<fadeColor:> I<colour>
459		672
460	Tint the transparent background pixmap with the given colour.	673	Fade to this colour, when fading is used (see B<fading:>). The default
		674	colour is black; option B<-fadecolor>.
461		675
462	=item B<shading:> I<number>	676	=item B<iconFile:> I<file>
463		677
464	Darken (0 .. 100) or lighten (-1 .. -100) the transparent background	678	Set the application icon pixmap; option B<-icon>.
465	image in addition to tinting it.
466
467	=item B<fading:> I<number>
468
469	Scale the tint colour by the given percentage.
470		679
471	=item B<scrollColor:> I<colour>	680	=item B<scrollColor:> I<colour>
472		681
473	Use the specified colour for the scrollbar [default #B2B2B2].	682	Use the specified colour for the scrollbar [default #B2B2B2].
474		683
475	=item B<troughColor:> I<colour>	684	=item B<troughColor:> I<colour>
476		685
477	Use the specified colour for the scrollbar's trough area [default	686	Use the specified colour for the scrollbar's trough area [default
478	#969696]. Only relevant for normal (non XTerm/NeXT) scrollbar.	687	#969696]. Only relevant for rxvt (non XTerm/NeXT) scrollbar.
479		688
480	=item B<borderColor:> I<colour>	689	=item B<borderColor:> I<colour>
481		690
482	The colour of the border around the text area and between the scrollbar	691	The colour of the border around the text area and between the scrollbar
483	and the text.	692	and the text.
484		693
485	=item B<backgroundPixmap:> I<file[;geom]>
486
487	Use the specified XPM file (note the `.xpm' extension is optional) for
488	the background and also optionally specify its scaling with a geometry
489	string B<WxH+X+Y>, in which B<"W" / "H"> specify the
490	horizontal/vertical scale (percent) and B<"X" / "Y"> locate the image
491	centre (percent). A scale of 0 displays the image with tiling. A scale
492	of 1 displays the image without any scaling. A scale of 2 to 9
493	specifies an integer number of images in that direction. No image will
494	be magnified beyond 10 times its original size. The maximum permitted
495	scale is 1000. [default 0x0+50+50]
496
497	=item B<menu:> I<file[;tag]>
498
499	Read in the specified menu file (note the `.menu' extension is
500	optional) and also optionally specify a starting tag to find. See the
501	reference documentation for details on the syntax for the menuBar.
502
503	=item B<path:> I<path>
504
505	Specify the colon-delimited search path for finding files (XPM and
506	menus), in addition to the paths specified by the B<RXVTPATH> and
507	B<PATH> environment variables.
508
509	=item B<font:> I<fontlist>	694	=item B<font:> I<fontlist>
510		695
511	Select the fonts to be used. This is a comma separated list of font	696	Select the fonts to be used. This is a comma separated list of font names
512	names that are used in turn when trying to display Unicode characters.	697	that are checked in order when trying to find glyphs for characters. The
513	The first font defines the cell size for characters; other fonts might	698	first font defines the cell size for characters; other fonts might be
514	be smaller, but not larger. A reasonable default font list is always	699	smaller, but not (in general) larger. A (hopefully) reasonable default
515	appended to it. option B<-fn>.	700	font list is always appended to it; option B<-fn>.
516		701
517	Each font can either be a standard X11 core font (XLFD) name, with	702	Each font can either be a standard X11 core font (XLFD) name, with
518	optional prefix C<x:> or a Xft font (Compile xft), prefixed with C<xft:>.	703	optional prefix C<x:> or a Xft font (Compile I<xft>), prefixed with C<xft:>.
519		704
520	In addition, each font can be prefixed with additional hints and	705	In addition, each font can be prefixed with additional hints and
521	specifications enclosed in square brackets (C<[]>). The only available	706	specifications enclosed in square brackets (C<[]>). The only available
522	hint currently is C<codeset=codeset-name>, and this is only used for Xft	707	hint currently is C<codeset=codeset-name>, and this is only used for Xft
523	fonts.	708	fonts.
524		709
525	For example, this font resource	710	For example, this font resource
526		711
527	URxvt*font: 9x15bold,\	712	URxvt.font: 9x15bold,\
528	-misc-fixed-bold-r-normal--15-140-75-75-c-90-iso10646-1,\	713	-misc-fixed-bold-r-normal--15-140-75-75-c-90-iso10646-1,\
529	-misc-fixed-medium-r-normal--15-140-75-75-c-90-iso10646-1, \	714	-misc-fixed-medium-r-normal--15-140-75-75-c-90-iso10646-1, \
530	[codeset=JISX0208]xft:Kochi Gothic:antialias=false, \	715	[codeset=JISX0208]xft:Kochi Gothic:antialias=false, \
531	xft:Code2000:antialias=false	716	xft:Code2000:antialias=false
532		717
533	specifies five fonts to be used. The first one is C<9x15bold> (actually	718	specifies five fonts to be used. The first one is C<9x15bold> (actually
534	the iso8859-1 version of the second font), which is the base font (because	719	the iso8859-1 version of the second font), which is the base font (because
535	it is named first) and thus defines the character cell grid to be 9 pixels	720	it is named first) and thus defines the character cell grid to be 9 pixels
536	wide and 15 pixels high.	721	wide and 15 pixels high.
537		722
538	the second font is just used to add additional unicode characters not in	723	The second font is just used to add additional unicode characters not in
539	the base font, likewise the third, which is unfortunately non-bold, but	724	the base font, likewise the third, which is unfortunately non-bold, but
540	the bold version of the font does contain less characters, so this is a	725	the bold version of the font does contain fewer characters, so this is a
541	useful supplement.	726	useful supplement.
542		727
543	The third font is an Xft font with aliasing turned off, and the characters	728	The third font is an Xft font with aliasing turned off, and the characters
544	are limited to the B<JIS 0208> codeset (i.e. japanese kanji). The font	729	are limited to the B<JIS 0208> codeset (i.e. japanese kanji). The font
545	contains other characters, but we are not interested in them.	730	contains other characters, but we are not interested in them.
…		…
566	not possible, replacement fonts of the desired shape will be tried.	751	not possible, replacement fonts of the desired shape will be tried.
567		752
568	If set, but empty, then this specific style is disabled and the normal	753	If set, but empty, then this specific style is disabled and the normal
569	text font will being used for the given style.	754	text font will being used for the given style.
570		755
571	=item B<selectstyle:> I<mode>	756	=item B<intensityStyles:> I<boolean>
572		757
573	Set mouse selection style to B<old> which is 2.20, B<oldword> which is	758	When font styles are not enabled, or this option is enabled (B<True>,
574	xterm style with 2.20 old word selection, or anything else which gives	759	option B<-is>, the default), bold/blink font styles imply high
575	xterm style selection.	760	intensity foreground/background colours. Disabling this option (B<False>,
576		761	option B<+is>) disables this behaviour, the high intensity colours are not
577	=item B<scrollstyle:> I<mode>	762	reachable.
578
579	Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is
580	the author's favourite..
581		763
582	=item B<title:> I<string>	764	=item B<title:> I<string>
583		765
584	Set window title string, the default title is the command-line	766	Set window title string, the default title is the command-line
585	specified after the B<-e> option, if any, otherwise the application	767	specified after the B<-e> option, if any, otherwise the application
…		…
594	=item B<mapAlert:> I<boolean>	776	=item B<mapAlert:> I<boolean>
595		777
596	B<True>: de-iconify (map) on receipt of a bell character. B<False>: no	778	B<True>: de-iconify (map) on receipt of a bell character. B<False>: no
597	de-iconify (map) on receipt of a bell character [default].	779	de-iconify (map) on receipt of a bell character [default].
598		780
		781	=item B<urgentOnBell:> I<boolean>
		782
		783	B<True>: set the urgency hint for the wm on receipt of a bell character.
		784	B<False>: do not set the urgency hint [default].
		785
		786	@@RXVT_NAME@@ resets the urgency hint on every focus change.
		787
599	=item B<visualBell:> I<boolean>	788	=item B<visualBell:> I<boolean>
600		789
601	B<True>: use visual bell on receipt of a bell character; option B<-vb>.	790	B<True>: use visual bell on receipt of a bell character; option B<-vb>.
602	B<False>: no visual bell [default]; option B<+vb>.	791	B<False>: no visual bell [default]; option B<+vb>.
603		792
…		…
605		794
606	B<True>: start as a login shell by prepending a `-' to B<argv[0]> of	795	B<True>: start as a login shell by prepending a `-' to B<argv[0]> of
607	the shell; option B<-ls>. B<False>: start as a normal sub-shell	796	the shell; option B<-ls>. B<False>: start as a normal sub-shell
608	[default]; option B<+ls>.	797	[default]; option B<+ls>.
609		798
		799	=item B<multiClickTime:> I<number>
		800
		801	Specify the maximum time in milliseconds between multi-click select
		802	events. The default is 500 milliseconds; option B<-mc>.
		803
610	=item B<utmpInhibit:> I<boolean>	804	=item B<utmpInhibit:> I<boolean>
611		805
612	B<True>: inhibit writing record into the system log file B<utmp>;	806	B<True>: inhibit writing record into the system log file B<utmp>;
613	option B<-ut>. B<False>: write record into the system log file B<utmp>	807	option B<-ut>. B<False>: write record into the system log file B<utmp>
614	[default]; option B<+ut>.	808	[default]; option B<+ut>.
…		…
617		811
618	Specify a command pipe for vt100 printer [default I<lpr(1)>]. Use	812	Specify a command pipe for vt100 printer [default I<lpr(1)>]. Use
619	B<Print> to initiate a screen dump to the printer and B<Ctrl-Print> or	813	B<Print> to initiate a screen dump to the printer and B<Ctrl-Print> or
620	B<Shift-Print> to include the scrollback as well.	814	B<Shift-Print> to include the scrollback as well.
621		815
		816	The string will be interpreted as if typed into the shell as-is.
		817
		818	Example:
		819
		820	URxvt.print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX)
		821
		822	This creates a new file in your home directory with the screen contents
		823	every time you hit C<Print>.
		824
		825	=item B<scrollstyle:> I<mode>
		826
		827	Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is
		828	the author's favourite.
		829
		830	=item B<thickness:> I<number>
		831
		832	Set the scrollbar width in pixels.
		833
622	=item B<scrollBar:> I<boolean>	834	=item B<scrollBar:> I<boolean>
623		835
624	B<True>: enable the scrollbar [default]; option B<-sb>. B<False>:	836	B<True>: enable the scrollbar [default]; option B<-sb>. B<False>:
625	disable the scrollbar; option B<+sb>.	837	disable the scrollbar; option B<+sb>.
626		838
…		…
645	B<False>: do not scroll to bottom when tty receives output; option	857	B<False>: do not scroll to bottom when tty receives output; option
646	B<+si>.	858	B<+si>.
647		859
648	=item B<scrollWithBuffer:> I<boolean>	860	=item B<scrollWithBuffer:> I<boolean>
649		861
650	B<True>: scroll with scrollback buffer when tty recieves new lines (and	862	B<True>: scroll with scrollback buffer when tty receives new lines (i.e.
651	B<scrollTtyOutput> is False); option B<+sw>. B<False>: do not scroll	863	try to show the same lines) and B<scrollTtyOutput> is False; option
652	with scrollback buffer when tty recieves new lines; option B<-sw>.	864	B<-sw>. B<False>: do not scroll with scrollback buffer when tty receives
		865	new lines; option B<+sw>.
653		866
654	=item B<scrollTtyKeypress:> I<boolean>	867	=item B<scrollTtyKeypress:> I<boolean>
655		868
656	B<True>: scroll to bottom when a non-special key is pressed. Special keys	869	B<True>: scroll to bottom when a non-special key is pressed. Special keys
657	are those which are intercepted by rxvt-unicode for special handling and	870	are those which are intercepted by rxvt-unicode for special handling and
…		…
676	=item B<borderLess:> I<boolean>	889	=item B<borderLess:> I<boolean>
677		890
678	Set MWM hints to request a borderless window, i.e. if honoured by the	891	Set MWM hints to request a borderless window, i.e. if honoured by the
679	WM, the rxvt-unicode window will not have window decorations; option B<-bl>.	892	WM, the rxvt-unicode window will not have window decorations; option B<-bl>.
680		893
		894	=item B<skipBuiltinGlyphs:> I<boolean>
		895
		896	Compile I<frills>: Disable the usage of the built-in block graphics/line
		897	drawing characters and just rely on what the specified fonts provide. Use
		898	this if you have a good font and want to use its block graphic glyphs;
		899	option B<-sbg>.
		900
681	=item B<termName:> I<termname>	901	=item B<termName:> I<termname>
682		902
683	Specifies the terminal type name to be set in the B<TERM> environment	903	Specifies the terminal type name to be set in the B<TERM> environment
684	variable; option B<-tn>.	904	variable; option B<-tn>.
685		905
686	=item B<linespace:> I<number>	906	=item B<lineSpace:> I<number>
687		907
688	Specifies number of lines (pixel height) to insert between each row of	908	Specifies number of lines (pixel height) to insert between each row of
689	the display [default 0]; option B<-lsp>.	909	the display [default 0]; option B<-lsp>.
690		910
691	=item B<meta8:> I<boolean>	911	=item B<meta8:> I<boolean>
…		…
696	=item B<mouseWheelScrollPage:> I<boolean>	916	=item B<mouseWheelScrollPage:> I<boolean>
697		917
698	B<True>: the mouse wheel scrolls a page full. B<False>: the mouse wheel	918	B<True>: the mouse wheel scrolls a page full. B<False>: the mouse wheel
699	scrolls five lines [default].	919	scrolls five lines [default].
700		920
		921	=item B<pastableTabs:> I<boolean>
		922
		923	B<True>: store tabs as wide characters. B<False>: interpret tabs as cursor
		924	movement only; option C<-ptab>.
		925
701	=item B<cursorBlink:> I<boolean>	926	=item B<cursorBlink:> I<boolean>
702		927
703	B<True>: blink the cursor. B<False>: do not blink the cursor [default];	928	B<True>: blink the cursor. B<False>: do not blink the cursor [default];
704	option B<-bc>.	929	option B<-bc>.
		930
		931	=item B<cursorUnderline:> I<boolean>
		932
		933	B<True>: Make the cursor underlined. B<False>: Make the cursor a box [default];
		934	option B<-uc>.
705		935
706	=item B<pointerBlank:> I<boolean>	936	=item B<pointerBlank:> I<boolean>
707		937
708	B<True>: blank the pointer when a key is pressed or after a set number	938	B<True>: blank the pointer when a key is pressed or after a set number
709	of seconds of inactivity. B<False>: the pointer is always visible	939	of seconds of inactivity. B<False>: the pointer is always visible
…		…
715		945
716	=item B<pointerColor2:> I<colour>	946	=item B<pointerColor2:> I<colour>
717		947
718	Mouse pointer background colour.	948	Mouse pointer background colour.
719		949
		950	=item B<pointerShape:> I<string>
		951
		952	Compile I<frills>: Specifies the name of the mouse pointer shape
		953	[default B<xterm>]. See the macros in the B<X11/cursorfont.h> include
		954	file for possible values (omit the C<XC_> prefix).
		955
720	=item B<pointerBlankDelay:> I<number>	956	=item B<pointerBlankDelay:> I<number>
721		957
722	Specifies number of seconds before blanking the pointer [default 2].	958	Specifies number of seconds before blanking the pointer [default 2]. Use a
		959	large number (e.g. C<987654321>) to effectively disable the timeout.
723		960
724	=item B<backspacekey:> I<string>	961	=item B<backspacekey:> I<string>
725		962
726	The string to send when the backspace key is pressed. If set to B<DEC>	963	The string to send when the backspace key is pressed. If set to B<DEC>
727	or unset it will send B<Delete> (code 127) or, if shifted, B<Backspace>	964	or unset it will send B<Delete> (code 127) or, with control, B<Backspace>
728	(code 8) - which can be reversed with the appropriate DEC private mode	965	(code 8) - which can be reversed with the appropriate DEC private mode
729	escape sequence.	966	escape sequence.
730		967
731	=item B<deletekey:> I<string>	968	=item B<deletekey:> I<string>
732		969
…		…
734	pressed. If unset it will send the sequence traditionally associated	971	pressed. If unset it will send the sequence traditionally associated
735	with the B<Execute> key.	972	with the B<Execute> key.
736		973
737	=item B<cutchars:> I<string>	974	=item B<cutchars:> I<string>
738		975
739	The characters used as delimiters for double-click word selection. The	976	The characters used as delimiters for double-click word selection
740	built-in default:	977	(whitespace delimiting is added automatically if resource is given).
741		978
		979	When the perl selection extension is in use (the default if compiled
		980	in, see the @@RXVT_NAME@@perl(3) manpage), a suitable regex using these
		981	characters will be created (if the resource exists, otherwise, no regex
		982	will be created). In this mode, characters outside ISO-8859-1 can be used.
		983
		984	When the selection extension is not used, only ISO-8859-1 characters can
		985	be used. If not specified, the built-in default is used:
		986
742	B<< BACKSLASH `"'&()*,;<=>?@[]{|} >>	987	B<< BACKSLASH `"'&()*,;<=>?@[]^{|} >>
743		988
744	=item B<preeditType:> I<style>	989	=item B<preeditType:> I<style>
745		990
746	B<OverTheSpot>, B<OffTheSpot>, B<Root>; option B<-pt>.	991	B<OnTheSpot>, B<OverTheSpot>, B<OffTheSpot>, B<Root>; option B<-pt>.
747		992
748	=item B<inputMethod:> I<name>	993	=item B<inputMethod:> I<name>
749		994
750	I<name> of inputMethod to use; option B<-im>.	995	I<name> of inputMethod to use; option B<-im>.
751		996
752	=item B<imLocale:> I<name>	997	=item B<imLocale:> I<name>
753		998
754	The locale to use for opening the IM. You can use an LC_CTYPE of e.g.	999	The locale to use for opening the IM. You can use an C<LC_CTYPE> of e.g.
755	de_DE.UTF-8 for normal text processing but ja_JP.EUC-JP for the input	1000	C<de_DE.UTF-8> for normal text processing but C<ja_JP.EUC-JP> for the
756	extension to be able to input japanese characters while staying in	1001	input extension to be able to input japanese characters while staying in
757	another locale. option B<-imlocale>.	1002	another locale; option B<-imlocale>.
		1003
		1004	=item B<imFont:> I<fontset>
		1005
		1006	Specify the font-set used for XIM styles C<OverTheSpot> or
		1007	C<OffTheSpot>. It must be a standard X font set (XLFD patterns separated
		1008	by commas), i.e. it's not in the same format as the other font lists used
		1009	in @@RXVT_NAME@@. The default will be set-up to chose *any* suitable found
		1010	found, preferably one or two pixels differing in size to the base font.
		1011	option B<-imfont>.
		1012
		1013	=item B<tripleclickwords:> I<boolean>
		1014
		1015	Change the meaning of triple-click selection with the left mouse
		1016	button. Instead of selecting a full line it will extend the selection to
		1017	the end of the logical line only; option B<-tcw>.
758		1018
759	=item B<insecure:> I<boolean>	1019	=item B<insecure:> I<boolean>
760		1020
761	Enables "insecure" mode. Rxvt-unicode offers some escape sequences that	1021	Enables "insecure" mode. Rxvt-unicode offers some escape sequences that
762	echo arbitrary strings like the icon name or the locale. This could be	1022	echo arbitrary strings like the icon name or the locale. This could be
763	abused if somebody gets 8-bit-clean access to your display, wether	1023	abused if somebody gets 8-bit-clean access to your display, whether
764	throuh a mail client displaying mail bodies unfiltered or though	1024	through a mail client displaying mail bodies unfiltered or through
765	write(1). Therefore, these sequences are disabled by default. (Note	1025	write(1) or any other means. Therefore, these sequences are disabled by
766	that other terminals, including xterm, have these sequences	1026	default. (Note that many other terminals, including xterm, have these
767	enabled by default). You can enable them by setting this boolean	1027	sequences enabled by default, which doesn't make it safer, though).
768	resource or specifying B<-insecure> as an option. At the moment, this	1028
769	enabled display-answer, locale, findfont, icon label and window title	1029	You can enable them by setting this boolean resource or specifying
770	requests as well as dynamic menubar dispatch.	1030	B<-insecure> as an option. At the moment, this enables display-answer,
		1031	locale, findfont, icon label and window title requests.
771		1032
772	=item B<modifier:> I<modifier>	1033	=item B<modifier:> I<modifier>
773		1034
774	Set the key to be interpreted as the Meta key to: B<alt>, B<meta>,	1035	Set the key to be interpreted as the Meta key to: B<alt>, B<meta>,
775	B<hyper>, B<super>, B<mod1>, B<mod2>, B<mod3>, B<mod4>, B<mod5>; option	1036	B<hyper>, B<super>, B<mod1>, B<mod2>, B<mod3>, B<mod4>, B<mod5>; option
…		…
779		1040
780	Specify the reply rxvt-unicode sends to the shell when an ENQ (control-E)	1041	Specify the reply rxvt-unicode sends to the shell when an ENQ (control-E)
781	character is passed through. It may contain escape values as described	1042	character is passed through. It may contain escape values as described
782	in the entry on B<keysym> following.	1043	in the entry on B<keysym> following.
783		1044
784	=item B<secondaryScreen:> I<bool>	1045	=item B<secondaryScreen:> I<boolean>
785		1046
786	Turn on/off secondary screen (default enabled).	1047	Turn on/off secondary screen (default enabled).
787		1048
788	=item B<secondaryScroll:> I<bool>	1049	=item B<secondaryScroll:> I<boolean>
789		1050
790	Turn on/off secondary screen scroll (default enabled). If the this	1051	Turn on/off secondary screen scroll (default enabled). If this
791	option is enabled, scrolls on the secondary screen will change the	1052	option is enabled, scrolls on the secondary screen will change the
792	scrollback buffer and switching to/from the secondary screen will	1053	scrollback buffer and, when secondaryScreen is off, switching
793	instead scroll the screen up.	1054	to/from the secondary screen will instead scroll the screen up.
794		1055
		1056	=item B<hold>: I<boolean>
		1057
		1058	Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@
		1059	will not immediately destroy its window when the program executed within
		1060	it exits. Instead, it will wait till it is being killed or closed by the
		1061	user.
		1062
		1063	=item B<chdir>: I<path>
		1064
		1065	Sets the working directory for the shell (or the command specified via
		1066	B<-e>). The I<path> must be an absolute path and it must exist for
		1067	@@RXVT_NAME@@ to start. If it isn't specified then the current working
		1068	directory will be used; option B<-cd>.
		1069
795	=item B<keysym.>I<sym>: I<string>	1070	=item B<keysym.>I<sym>: I<action>
796		1071
797	Associate I<string> with keysym I<sym> (B<0xFF00 - 0xFFFF>). It may	1072	Compile I<frills>: Associate I<action> with keysym I<sym>. The intervening
798	contain escape values (\a: bell, \b: backspace, \e, \E: escape, \n:	1073	resource name B<keysym.> cannot be omitted.
799	newline, \r: return, \t:	1074
800	tab, \000: octal number) or control characters (^?: delete, ^@: null,	1075	Using this resource, you can map key combinations such as
801	^A ...) and may enclosed with double quotes so that it can start or end	1076	C<Ctrl-Shift-BackSpace> to various actions, such as outputting a different
802	with whitespace. The intervening resource name B<keysym.> cannot be	1077	string than would normally result from that combination, making the
803	omitted. This resource is only available when compiled with	1078	terminal scroll up or down the way you want it, or any other thing an
804	KEYSYM_RESOURCE.	1079	extension might provide.
		1080
		1081	The key combination that triggers the action, I<sym>, has the following format:
		1082
		1083	(modifiers-)key
		1084
		1085	Where I<modifiers> can be any combination of B<ISOLevel3>, B<AppKeypad>,
		1086	B<Control>, B<NumLock>, B<Shift>, B<Meta>, B<Lock>, B<Mod1>, B<Mod2>,
		1087	B<Mod3>, B<Mod4>, B<Mod5>, and the abbreviated B<I>, B<K>, B<C>, B<N>,
		1088	B<S>, B<M>, B<A>, B<L>, B<1>, B<2>, B<3>, B<4>, B<5>.
		1089
		1090	The B<NumLock>, B<Meta> and B<ISOLevel3> modifiers are usually aliased to
		1091	whatever modifier the NumLock key, Meta/Alt keys or ISO Level3 Shift/AltGr
		1092	keys are being mapped. B<AppKeypad> is a synthetic modifier mapped to the
		1093	current application keymap mode state.
		1094
		1095	Due the the large number of modifier combinations, a key mapping will
		1096	match if I<at least> the specified identifiers are being set, and no other
		1097	key mappings with those and more bits are being defined. That means that
		1098	defining a mapping for C<a> will automatically provide definitions for
		1099	C<Meta-a>, C<Shift-a> and so on, unless some of those are defined mappings
		1100	themselves. See the C<builtin:> action, below, for a way to work around
		1101	this when this is a problem.
		1102
		1103	The spelling of I<key> depends on your implementation of X. An easy way to
		1104	find a key name is to use the B<xev>(1) command. You can find a list by
		1105	looking for the C<XK_> macros in the B<X11/keysymdef.h> include file (omit
		1106	the C<XK_> prefix). Alternatively you can specify I<key> by its hex keysym
		1107	value (B<0x0000 - 0xFFFF>).
		1108
		1109	As with any resource value, the I<action> string may contain backslash
		1110	escape sequences (C<\n>: newline, C<\\>: backslash, C<\000>: octal
		1111	number), see RESOURCES in C<man 7 X> for further details.
		1112
		1113	An action starts with an action prefix that selects a certain type
		1114	of action, followed by a colon. An action string without colons is
		1115	interpreted as a literal string to pass to the tty (as if it was
		1116	prefixed with C<string:>).
		1117
		1118	The following action prefixes are known - extensions can provide
		1119	additional prefixes:
		1120
		1121	=over 4
		1122
		1123	=item string:STRING
		1124
		1125	If the I<action> starts with C<string:> (or otherwise contains no colons),
		1126	then the remaining C<STRING> will be passed to the program running in the
		1127	terminal. For example, you could replace whatever Shift-Tab outputs by the
		1128	string C<echo rm -rf /> followed by a newline:
		1129
		1130	URxvt.keysym.Shift-Tab: string:echo rm -rf /\n
		1131
		1132	This could in theory be used to completely redefine your keymap.
		1133
		1134	In addition, for actions of this type, you can define a range of
		1135	keysyms in one shot by loading the C<keysym-list> perl extension and
		1136	providing an I<action> with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where
		1137	the delimiter `/' should be a character not used by the strings.
		1138
		1139	Its usage can be demonstrated by an example:
		1140
		1141	URxvt.keysym.M-C-0x61: list|\033<|abc|>
		1142
		1143	The above line is equivalent to the following three lines:
		1144
		1145	URxvt.keysym.Meta-Control-0x61: string:\033<a>
		1146	URxvt.keysym.Meta-Control-0x62: string:\033<b>
		1147	URxvt.keysym.Meta-Control-0x63: string:\033<c>
		1148
		1149	=item command:STRING
		1150
		1151	If I<action> takes the form of C<command:STRING>, the specified B<STRING>
		1152	is interpreted and executed as @@RXVT_NAME@@'s control sequence (basically
		1153	the opposite of C<string:> - instead of sending it to the program running
		1154	in the terminal, it will be treated as if it were program output). This is
		1155	most useful to feed command sequences into @@RXVT_NAME@@.
		1156
		1157	For example the following means "change the current locale to C<zh_CN.GBK>
		1158	when Control-Meta-c is being pressed":
		1159
		1160	URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007
		1161
		1162	The following example will map Control-Meta-1 and Control-Meta-2 to
		1163	the fonts C<suxuseuro> and C<9x15bold>, so you can have some limited
		1164	font-switching at runtime:
		1165
		1166	URxvt.keysym.M-C-1: command:\033]50;suxuseuro\007
		1167	URxvt.keysym.M-C-2: command:\033]50;9x15bold\007
		1168
		1169	Other things are possible, e.g. resizing (see @@RXVT_NAME@@(7) for more
		1170	info):
		1171
		1172	URxvt.keysym.M-C-3: command:\033[8;25;80t
		1173	URxvt.keysym.M-C-4: command:\033[8;48;110t
		1174
		1175	=item builtin:
		1176
		1177	The builtin action is the action that @@RXVT_NAME@@ would execute if no
		1178	key binding existed for the key combination. The obvious use is to undo
		1179	the effect of existing bindings. The not so obvious use is to reinstate
		1180	bindings when another binding overrides too many modifiers.
		1181
		1182	For example if you overwrite the C<Insert> key you will disable
		1183	@@RXVT_NAME@@'s C<Shift-Insert> mapping. To re-enable that, you can poke
		1184	"holes" into the user-defined keymap using the C<builtin:> replacement:
		1185
		1186	URxvt.keysym.Insert: <my insert key sequence>
		1187	URxvt.keysym.S-Insert: builtin:
		1188
		1189	The first line defines a mapping for C<Insert> and I<any> combination
		1190	of modifiers. The second line re-establishes the default mapping for
		1191	C<Shift-Insert>.
		1192
		1193	=item builtin-string:
		1194
		1195	This action is mainly useful to restore string mappings for keys that
		1196	have predefined actions in @@RXVT_NAME@@. The exact semantics are a bit
		1197	difficult to explain - basically, this action will send the string to the
		1198	application that would be sent if @@RXVT_NAME@@ wouldn't have a built-in
		1199	action for it.
		1200
		1201	An example might make it clearer: @@RXVT_NAME@@ normally pastes the
		1202	selection when you press C<Shift-Insert>. With the following bindings, it
		1203	would instead emit the (undocumented, but what applications running in the
		1204	terminal might expect) sequence C<ESC [ 2 $> instead:
		1205
		1206	URxvt.keysym.S-Insert: builtin-string:
		1207	URxvt.keysym.C-S-Insert: builtin:
		1208
		1209	The first line disables the paste functionality for that key
		1210	combination, and the second reinstates the default behaviour for
		1211	C<Control-Shift-Insert>, which would otherwise be overridden.
		1212
		1213	Similarly, to let applications gain access to the C<C-M-c> (copy to
		1214	clipboard) and C<C-M-v> (paste clipboard) key combination, you can do
		1215	this:
		1216
		1217	URxvt.keysym.C-M-c: builtin-string:
		1218	URxvt.keysym.C-M-v: builtin-string:
		1219
		1220	=item EXTENSION:STRING
		1221
		1222	An action of this form invokes the action B<STRING>, if any, provided
		1223	by the @@RXVT_NAME@@perl(3) extension B<EXTENSION>. The extension will
		1224	be loaded automatically if necessary.
		1225
		1226	Not all extensions define actions, but popular extensions that do
		1227	include the I<selection> and I<matcher> extensions (documented in their
		1228	own manpages, @@RXVT_NAME@@-selection(1) and @@RXVT_NAME@@-matcher(1),
		1229	respectively).
		1230
		1231	From the silly examples department, this will rot13-"encrypt"
		1232	@@RXVT_NAME@@'s selection when Alt-Control-c is pressed on typical PC
		1233	keyboards:
		1234
		1235	URxvt.keysym.M-C-c: selection:rot13
		1236
		1237	=item perl:STRING *DEPRECATED*
		1238
		1239	This is a deprecated way of invoking commands provided by perl
		1240	extensions. It is still supported, but should not be used anymore.
		1241
		1242	=back
		1243
		1244	=item B<perl-ext-common>: I<string>
		1245
		1246	=item B<perl-ext>: I<string>
		1247
		1248	Comma-separated list(s) of perl extension scripts (default: C<default>) to
		1249	use in this terminal instance; option B<-pe>.
		1250
		1251	Extension names can be prefixed with a C<-> sign to prohibit using
		1252	them. This can be useful to selectively disable some extensions loaded
		1253	by default, or specified via the C<perl-ext-common> resource. For
		1254	example, C<default,-selection> will use all the default extensions except
		1255	C<selection>.
		1256
		1257	The default set includes the C<selection>, C<option-popup>,
		1258	C<selection-popup>, C<readline> and C<searchable-scrollback>
		1259	extensions, and extensions which are mentioned in B<keysym> resources.
		1260
		1261	Any extension such that a corresponding resource is given on the
		1262	command line is automatically appended to B<perl-ext>.
		1263
		1264	Each extension is looked up in the library directories, loaded if
		1265	necessary, and bound to the current terminal instance. When the library
		1266	search path contains multiple extension files of the same name, then the
		1267	first one found will be used.
		1268
		1269	If both of these resources are the empty string, then the perl interpreter
		1270	will not be initialized. The rationale for having two options is that
		1271	B<perl-ext-common> will be used for extensions that should be available to
		1272	all instances, while B<perl-ext> is used for specific instances.
		1273
		1274	=item B<perl-eval>: I<string>
		1275
		1276	Perl code to be evaluated when all extensions have been registered. See
		1277	the @@RXVT_NAME@@perl(3) manpage.
		1278
		1279	=item B<perl-lib>: I<path>
		1280
		1281	Colon-separated list of additional directories that hold extension
		1282	scripts. When looking for perl extensions, @@RXVT_NAME@@ will first look
		1283	in these directories, then in C<$URXVT_PERL_LIB>, F<$HOME/.urxvt/ext> and
		1284	lastly in F<@@RXVT_LIBDIR@@/urxvt/perl/>.
		1285
		1286	See the @@RXVT_NAME@@perl(3) manpage.
		1287
		1288	=item B<< selection.pattern-I<idx> >>: I<perl-regex>
		1289
		1290	Additional selection patterns, see the @@RXVT_NAME@@perl(3) manpage for
		1291	details.
		1292
		1293	=item B<< selection-autotransform.I<idx> >>: I<perl-transform>
		1294
		1295	Selection auto-transform patterns, see the @@RXVT_NAME@@perl(3) manpage
		1296	for details.
		1297
		1298	=item B<searchable-scrollback:> I<keysym> *DEPRECATED*
		1299
		1300	This resource is deprecated and will be removed. Use a B<keysym> resource
		1301	instead, e.g.:
		1302
		1303	URxvt.keysym.M-s: searchable-scrollback:start
		1304
		1305	=item B<url-launcher>: I<string>
		1306
		1307	Specifies the program to be started with a URL argument. Used by the
		1308	C<selection-popup> and C<matcher> perl extensions.
		1309
		1310	=item B<transient-for>: I<windowid>
		1311
		1312	Compile I<frills>: Sets the WM_TRANSIENT_FOR property to the given window id.
		1313
		1314	=item B<override-redirect>: I<boolean>
		1315
		1316	Compile I<frills>: Sets override-redirect for the terminal window, making
		1317	it almost invisible to window managers; option B<-override-redirect>.
		1318
		1319	=item B<iso14755:> I<boolean>
		1320
		1321	Turn on/off ISO 14755 (default enabled).
		1322
		1323	=item B<iso14755_52:> I<boolean>
		1324
		1325	Turn on/off ISO 14755 5.2 mode (default enabled).
		1326
		1327	=back
		1328
		1329	=head1 BACKGROUND IMAGE OPTIONS AND RESOURCES
		1330
		1331	=over 4
		1332
		1333	=item B<-pixmap> I<file[;oplist]>
		1334
		1335	=item B<backgroundPixmap:> I<file[;oplist]>
		1336
		1337	Compile I<pixbuf>: Use the specified image file as the window's
		1338	background and also optionally specify a colon separated list of
		1339	operations to modify it. Note that you may need to quote the C<;>
		1340	character when using the command line option, as C<;> is usually a
		1341	metacharacter in shells. Supported operations are:
		1342
		1343	=over 4
		1344
		1345	=item B<WxH+X+Y>
		1346
		1347	sets scale and position. B<"W" / "H"> specify the horizontal/vertical
		1348	scale (percent), and B<"X" / "Y"> locate the image centre (percent). A
		1349	scale of 0 disables scaling.
		1350
		1351	=item B<op=tile>
		1352
		1353	enables tiling
		1354
		1355	=item B<op=keep-aspect>
		1356
		1357	maintain the image aspect ratio when scaling
		1358
		1359	=item B<op=root-align>
		1360
		1361	use the position of the terminal window relative to the root window as
		1362	the image offset, simulating a root window background
		1363
		1364	=back
		1365
		1366	The default scale and position setting is C<100x100+50+50>.
		1367	Alternatively, a predefined set of templates can be used to achieve
		1368	the most common setups:
		1369
		1370	=over 4
		1371
		1372	=item B<style=tiled>
		1373
		1374	the image is tiled with no scaling. Equivalent to 0x0+0+0:op=tile
		1375
		1376	=item B<style=aspect-stretched>
		1377
		1378	the image is scaled to fill the whole window maintaining the aspect
		1379	ratio and centered. Equivalent to 100x100+50+50:op=keep-aspect
		1380
		1381	=item B<style=stretched>
		1382
		1383	the image is scaled to fill the whole window. Equivalent to 100x100
		1384
		1385	=item B<style=centered>
		1386
		1387	the image is centered with no scaling. Equivalent to 0x0+50+50
		1388
		1389	=item B<style=root-tiled>
		1390
		1391	the image is tiled with no scaling and using 'root' positioning.
		1392	Equivalent to 0x0:op=tile:op=root-align
		1393
		1394	=back
		1395
		1396	If multiple templates are specified the last one wins. Note that a
		1397	template overrides all the scale, position and operations settings.
		1398
		1399	If used in conjunction with pseudo-transparency, the specified pixmap
		1400	will be blended over the transparent background using alpha-blending.
		1401
		1402	=item B<-tr>|B<+tr>
		1403
		1404	=item B<transparent:> I<boolean>
		1405
		1406	Turn on/off pseudo-transparency by using the root pixmap as background.
		1407
		1408	B<-ip> (B<inheritPixmap>) is still accepted as an obsolete alias but
		1409	will be removed in future versions.
		1410
		1411	=item B<-tint> I<colour>
		1412
		1413	=item B<tintColor:> I<colour>
		1414
		1415	Tint the transparent background with the given colour. Note that a
		1416	black tint yields a completely black image while a white tint yields
		1417	the image unchanged.
		1418
		1419	=item B<-sh> I<number>
		1420
		1421	=item B<shading:> I<number>
		1422
		1423	Darken (0 .. 99) or lighten (101 .. 200) the transparent background.
		1424	A value of 100 means no shading.
		1425
		1426	=item B<-blr> I<HxV>
		1427
		1428	=item B<blurRadius:> I<HxV>
		1429
		1430	Apply gaussian blur with the specified radius to the transparent
		1431	background. If a single number is specified, the vertical and
		1432	horizontal radii are considered to be the same. Setting one of the
		1433	radii to 1 and the other to a large number creates interesting effects
		1434	on some backgrounds. The maximum radius value is 128. An horizontal or
		1435	vertical radius of 0 disables blurring.
		1436
		1437	=item B<path:> I<path>
		1438
		1439	Specify the colon-delimited search path for finding background image files.
805		1440
806	=back	1441	=back
807		1442
808	=head1 THE SCROLLBAR	1443	=head1 THE SCROLLBAR
809		1444
…		…
823	the normal text selection/insertion, hold either the Shift or the Meta	1458	the normal text selection/insertion, hold either the Shift or the Meta
824	(Alt) key while performing the desired mouse action.	1459	(Alt) key while performing the desired mouse action.
825		1460
826	If mouse reporting mode is active, the normal scrollbar actions are	1461	If mouse reporting mode is active, the normal scrollbar actions are
827	disabled -- on the assumption that we are using a fullscreen	1462	disabled -- on the assumption that we are using a fullscreen
828	application. Instead, pressing Button1 and Button3 sends B<ESC[6~>	1463	application. Instead, pressing Button1 and Button3 sends B<ESC [ 6 ~>
829	(Next) and B<ESC[5~> (Prior), respectively. Similarly, clicking on the	1464	(Next) and B<ESC [ 5 ~> (Prior), respectively. Similarly, clicking on the
830	up and down arrows sends B<ESC[A> (Up) and B<ESC[B> (Down),	1465	up and down arrows sends B<ESC [ A> (Up) and B<ESC [ B> (Down),
831	respectively.	1466	respectively.
832		1467
833	=head1 TEXT SELECTION AND INSERTION	1468	=head1 THE SELECTION: SELECTING AND PASTING TEXT
834		1469
835	The behaviour of text selection and insertion mechanism is similar to	1470	The behaviour of text selection and insertion/pasting mechanism is similar
836	I<xterm>(1).	1471	to I<xterm>(1).
837		1472
838	=over 4	1473	=over 4
839		1474
840	=item B<Selection>:	1475	=item B<Selecting>:
841		1476
842	Left click at the beginning of the region, drag to the end of the	1477	Left click at the beginning of the region, drag to the end of the region
843	region and release; Right click to extend the marked region; Left	1478	and release; Right click to extend the marked region; Left double-click
844	double-click to select a word; Left triple-click to select the entire	1479	to select a word; Left triple-click to select the entire logical line
845	line.	1480	(which can span multiple screen lines), unless modified by resource
		1481	B<tripleclickwords>.
846		1482
		1483	Starting a selection while pressing the B<Meta> key (or B<Meta+Ctrl> keys)
		1484	(Compile: I<frills>) will create a rectangular selection instead of a
		1485	normal one. In this mode, every selected row becomes its own line in the
		1486	selection, and trailing whitespace is visually underlined and removed from
		1487	the selection.
		1488
847	=item B<Insertion>:	1489	=item B<Pasting>:
848		1490
849	Pressing and releasing the Middle mouse button (or B<Shift-Insert>) in	1491	Pressing and releasing the Middle mouse button in an B<@@RXVT_NAME@@>
850	an B<@@RXVT_NAME@@> window causes the current text selection to be	1492	window causes the value of the PRIMARY selection (or CLIPBOARD with the
851	inserted as if it had been typed on the keyboard.	1493	B<Meta> modifier) to be inserted as if it had been typed on the keyboard.
		1494
		1495	Pressing B<Shift-Insert> causes the value of the PRIMARY selection to be
		1496	inserted too.
		1497
		1498	rxvt-unicode also provides the bindings B<Ctrl-Meta-c> and
		1499	<Ctrl-Meta-v> to interact with the CLIPBOARD selection. The first
		1500	binding causes the value of the internal selection to be copied to the
		1501	CLIPBOARD selection, while the second binding causes the value of the
		1502	CLIPBOARD selection to be inserted.
852		1503
853	=back	1504	=back
854		1505
855	=head1 CHANGING FONTS	1506	=head1 CHANGING FONTS
856		1507
857	Changing fonts (or font sizes, respectively) via the keypad is not yet	1508	Changing fonts (or font sizes, respectively) via the keypad is not yet
858	supported in rxvt-unicode. Bug me if you need this.	1509	supported in rxvt-unicode. Bug me if you need this.
859		1510
860	You can, however, switch fonts at runtime using escape sequences (and	1511	You can, however, switch fonts at runtime using escape sequences, e.g.:
861	therefore using the menubar), e.g.:
862		1512
863	printf '\e]701;%s\007' "9x15bold,xft:Kochi Gothic"	1513	printf '\e]710;%s\007' "9x15bold,xft:Kochi Gothic"
		1514
		1515	You can use keyboard shortcuts, too:
		1516
		1517	URxvt.keysym.M-C-1: command:\033]710;suxuseuro\007\033]711;suxuseuro\007
		1518	URxvt.keysym.M-C-2: command:\033]710;9x15bold\007\033]711;9x15bold\007
864		1519
865	rxvt-unicode will automatically re-apply these fonts to the output so far.	1520	rxvt-unicode will automatically re-apply these fonts to the output so far.
866		1521
867	=head1 ISO 14755 SUPPORT	1522	=head1 ISO 14755 SUPPORT
868		1523
869	ISO 14755 is a standard for entering and viewing unicode characters	1524	ISO 14755 is a standard for entering and viewing unicode characters
870	and character codes using the keyboard. It consists of 4 parts. The	1525	and character codes using the keyboard. It consists of 4 parts. The
871	first part is available rxvt-unicode has been compiled with	1526	first part is available if rxvt-unicode has been compiled with
872	C<--enable-frills>, the rest is available when rxvt-unicode was compiled	1527	C<--enable-frills>, the rest is available when rxvt-unicode was compiled
873	with C<--enable-iso14755>.	1528	with C<--enable-iso14755>.
874		1529
875	=over 4	1530	=over 4
876		1531
877	=item 5.1: Basic method	1532	=item * 5.1: Basic method
878		1533
879	This allows you to enter unicode characters using their hexcode.	1534	This allows you to enter unicode characters using their hexcode.
880		1535
881	Start by pressing and holding both C<Control> and C<Shift>, then enter	1536	Start by pressing and holding both C<Control> and C<Shift>, then enter
882	hex-digits (between one and six). Releasing C<Control> and C<Shift> will	1537	hex-digits (between one and six). Releasing C<Control> and C<Shift> will
…		…
889	address, which you cannot type. Fortunately, the card has the e-mail	1544	address, which you cannot type. Fortunately, the card has the e-mail
890	address printed as hexcodes, e.g. C<671d 65e5>. You can enter this easily	1545	address printed as hexcodes, e.g. C<671d 65e5>. You can enter this easily
891	by pressing C<Control> and C<Shift>, followed by C<6-7-1-D-SPACE-6-5-E-5>,	1546	by pressing C<Control> and C<Shift>, followed by C<6-7-1-D-SPACE-6-5-E-5>,
892	followed by releasing the modifier keys.	1547	followed by releasing the modifier keys.
893		1548
894	=item 5.2: Keyboard symbols entry method	1549	=item * 5.2: Keyboard symbols entry method
895		1550
896	This mode lets you input characters representing the keycap symbols of	1551	This mode lets you input characters representing the keycap symbols of
897	your keyboard, if representable in the current locale encoding.	1552	your keyboard, if representable in the current locale encoding.
898		1553
899	Start by pressing C<Control> and C<Shift> together, then releasing	1554	Start by pressing C<Control> and C<Shift> together, then releasing
900	them. The next special key (cursor keys, home etc.) you enter will not	1555	them. The next special key (cursor keys, home etc.) you enter will not
901	invoke it's usual function but instead will insert the corresponding	1556	invoke its usual function but instead will insert the corresponding
902	keycap symbol. The symbol will only be entered when the key has been	1557	keycap symbol. The symbol will only be entered when the key has been
903	released, otherwise pressing e.g. C<Shift> would enter the symbol for	1558	released, otherwise pressing e.g. C<Shift> would enter the symbol for
904	C<ISO Level 2 Switch>, although your intention might have beenm to enter a	1559	C<ISO Level 2 Switch>, although your intention might have been to enter a
905	reverse tab (Shift-Tab).	1560	reverse tab (Shift-Tab).
906		1561
907	=item 5.3: Screen-selection entry method	1562	=item * 5.3: Screen-selection entry method
908		1563
909	While this is implemented already (it's basically the selection	1564	While this is implemented already (it's basically the selection
910	mechanism), it could be extended by displaying a unicode character map.	1565	mechanism), it could be extended by displaying a unicode character map.
911		1566
912	=item 5.4: Feedback method for identifying displayed characters for later input	1567	=item * 5.4: Feedback method for identifying displayed characters for later input
913		1568
914	This method lets you display the unicode character code associated with	1569	This method lets you display the unicode character code associated with
915	characters already displayed.	1570	characters already displayed.
916		1571
917	You enter this mode by holding down C<Control> and C<Shift> together, then	1572	You enter this mode by holding down C<Control> and C<Shift> together, then
…		…
929	With respect to conformance, rxvt-unicode is supposed to be compliant to	1584	With respect to conformance, rxvt-unicode is supposed to be compliant to
930	both scenario A and B of ISO 14755, including part 5.2.	1585	both scenario A and B of ISO 14755, including part 5.2.
931		1586
932	=head1 LOGIN STAMP	1587	=head1 LOGIN STAMP
933		1588
934	B<@@RXVT_NAME@@> tries to write an entry into the I<utmp>(5) file so	1589	B<@@RXVT_NAME@@> tries to write an entry into the I<utmp>(5) file so that
935	that it can be seen via the I<who(1)> command, and can accept messages.	1590	it can be seen via the I<who(1)> command, and can accept messages. To
936	To allow this feature, B<@@RXVT_NAME@@> must be installed setuid root on	1591	allow this feature, B<@@RXVT_NAME@@> may need to be installed setuid root
937	some systems.	1592	on some systems or setgid to root or to some other group on others.
938		1593
939	=head1 COLORS AND GRAPHICS	1594	=head1 COLOURS AND GRAPHICS
940		1595
941	In addition to the default foreground and background colours,	1596	In addition to the default foreground and background colours,
942	B<@@RXVT_NAME@@> can display up to 16 colours (8 ANSI colours plus	1597	B<@@RXVT_NAME@@> can display up to 88/256 colours: 8 ANSI colours plus
943	high-intensity bold/blink versions of the same). Here is a list of the	1598	high-intensity (potentially bold/blink) versions of the same, and 72 (or
944	colours with their B<rgb.txt> names.	1599	240 in 256 colour mode) colours arranged in an 4x4x4 (or 6x6x6) colour RGB
		1600	cube plus a 8 (24) colour greyscale ramp.
		1601
		1602	Here is a list of the ANSI colours with their names.
945		1603
946	=begin table	1604	=begin table
947		1605
948	B<color0> (black) = Black	1606	B<color0> (black) = Black
949	B<color1> (red) = Red3	1607	B<color1> (red) = Red3
…		…
969	It is also possible to specify the colour values of B<foreground>,	1627	It is also possible to specify the colour values of B<foreground>,
970	B<background>, B<cursorColor>, B<cursorColor2>, B<colorBD>, B<colorUL> as	1628	B<background>, B<cursorColor>, B<cursorColor2>, B<colorBD>, B<colorUL> as
971	a number 0-15, as a convenient shorthand to reference the colour name of	1629	a number 0-15, as a convenient shorthand to reference the colour name of
972	color0-color15.	1630	color0-color15.
973		1631
		1632	The following text gives values for the standard 88 colour mode (and
		1633	values for the 256 colour mode in parentheses).
		1634
		1635	The RGB cube uses indices 16..79 (16..231) using the following formulas:
		1636
		1637	index_88 = (r * 4 + g) * 4 + b + 16 # r, g, b = 0..3
		1638	index_256 = (r * 6 + g) * 6 + b + 16 # r, g, b = 0..5
		1639
		1640	The grayscale ramp uses indices 80..87 (232..239), from 10% to 90% in 10%
		1641	steps (1/26 to 25/26 in 1/26 steps) - black and white are already part of
		1642	the RGB cube.
		1643
		1644	Together, all those colours implement the 88 (256) colour xterm
		1645	colours. Only the first 16 can be changed using resources currently, the
		1646	rest can only be changed via command sequences ("escape codes").
		1647
		1648	Applications are advised to use terminfo or command sequences to discover
		1649	number and RGB values of all colours (yes, you can query this...).
		1650
974	Note that B<-rv> (B<"reverseVideo: True">) simulates reverse video by	1651	Note that B<-rv> (B<"reverseVideo: True">) simulates reverse video by
975	always swapping the foreground/background colours. This is in contrast to	1652	always swapping the foreground/background colours. This is in contrast to
976	I<xterm>(1) where the colours are only swapped if they have not otherwise	1653	I<xterm>(1) where the colours are only swapped if they have not otherwise
977	been specified. For example,	1654	been specified. For example,
978		1655
		1656	@@RXVT_NAME@@ -fg Black -bg White -rv
		1657
		1658	would yield White on Black, while on I<xterm>(1) it would yield Black on
		1659	White.
		1660
		1661	=head2 ALPHA CHANNEL SUPPORT
		1662
		1663	If Xft support has been compiled in and as long as Xft/Xrender/X don't get
		1664	their act together, rxvt-unicode will do its own alpha channel management:
		1665
		1666	You can prefix any colour with an opaqueness percentage enclosed in
		1667	brackets, i.e. C<[percent]>, where C<percent> is a decimal percentage
		1668	(0-100) that specifies the opacity of the colour, where C<0> is completely
		1669	transparent and C<100> is completely opaque. For example, C<[50]red> is a
		1670	half-transparent red, while C<[95]#00ff00> is an almost opaque green. This
		1671	is the recommended format to specify transparency values, and works with
		1672	all ways to specify a colour.
		1673
		1674	For complete control, rxvt-unicode also supports
		1675	C<rgba:rrrr/gggg/bbbb/aaaa> (exactly four hex digits/component) colour
		1676	specifications, where the additional C<aaaa> component specifies opacity
		1677	(alpha) values. The minimum value of C<0000> is completely transparent,
		1678	while C<ffff> is completely opaque). The two example colours from
		1679	earlier could also be specified as C<rgba:ff00/0000/0000/8000> and
		1680	C<rgba:0000/ff00/0000/f332>.
		1681
		1682	You probably need to specify B<"-depth 32">, too, to force a visual with
		1683	alpha channels, and have the luck that your X-server uses ARGB pixel
		1684	layout, as X is far from just supporting ARGB visuals out of the box, and
		1685	rxvt-unicode just fudges around.
		1686
		1687	For example, the following selects an almost completely transparent black
		1688	background, and an almost opaque pink foreground:
		1689
		1690	@@RXVT_NAME@@ -depth 32 -bg rgba:0000/0000/0000/4444 -fg "[80]pink"
		1691
		1692	When not using a background image, then the interpretation of the
		1693	alpha channel is up to your compositing manager (most interpret it as
		1694	transparency of course).
		1695
		1696	When using a background pixmap or pseudo-transparency, then the background
		1697	colour will always behave as if it were completely transparent (so the
		1698	background image shows instead), regardless of how it was specified, while
		1699	other colours will either be transparent as specified (the background
		1700	image will show through) on servers supporting the RENDER extension, or
		1701	fully opaque on servers not supporting the RENDER EXTENSION.
		1702
		1703	Please note that due to bugs in Xft, specifying alpha values might result
		1704	in garbage being displayed when the X-server does not support the RENDER
		1705	extension.
		1706
		1707	=head1 ENVIRONMENT
		1708
		1709	B<@@RXVT_NAME@@> sets and/or uses the following environment variables:
		1710
979	=over 4	1711	=over 4
980		1712
981	=item B<@@RXVT_NAME@@ -fg Black -bg White -rv>	1713	=item B<TERM>
982		1714
983	would yield White on Black, while on I<xterm>(1) it would yield Black	1715	Normally set to C<rxvt-unicode>, unless overwritten at configure time, via
984	on White.	1716	resources or on the command line.
		1717
		1718	=item B<COLORTERM>
		1719
		1720	Either C<rxvt>, C<rxvt-xpm>, depending on whether @@RXVT_NAME@@ was
		1721	compiled with background image support, and optionally with the added
		1722	extension C<-mono> to indicate that rxvt-unicode runs on a monochrome
		1723	screen.
		1724
		1725	=item B<COLORFGBG>
		1726
		1727	Set to a string of the form C<fg;bg> or C<fg;xpm;bg>, where C<fg> is
		1728	the colour code used as default foreground/text colour (or the string
		1729	C<default> to indicate that the default-colour escape sequence is to be
		1730	used), C<bg> is the colour code used as default background colour (or the
		1731	string C<default>), and C<xpm> is the string C<default> if @@RXVT_NAME@@
		1732	was compiled with background image support. Libraries like C<ncurses>
		1733	and C<slang> can (and do) use this information to optimize screen output.
		1734
		1735	=item B<WINDOWID>
		1736
		1737	Set to the (decimal) X Window ID of the @@RXVT_NAME@@ window (the toplevel
		1738	window, which usually has subwindows for the scrollbar, the terminal
		1739	window and so on).
		1740
		1741	=item B<TERMINFO>
		1742
		1743	Set to the terminfo directory iff @@RXVT_NAME@@ was configured with
		1744	C<--with-terminfo=PATH>.
		1745
		1746	=item B<DISPLAY>
		1747
		1748	Used by @@RXVT_NAME@@ to connect to the display and set to the correct
		1749	display in its child processes if C<-display> isn't used to override. It
		1750	defaults to C<:0> if it doesn't exist.
		1751
		1752	=item B<SHELL>
		1753
		1754	The shell to be used for command execution, defaults to C</bin/sh>.
		1755
		1756	=item B<RXVT_SOCKET> [I<sic>]
		1757
		1758	The unix domain socket path used by @@RXVT_NAME@@c(1) and
		1759	@@RXVT_NAME@@d(1).
		1760
		1761	Default F<<< $HOME/.urxvt/urxvtd-I<< <nodename> >> >>>.
		1762
		1763	=item B<URXVT_PERL_LIB>
		1764
		1765	Additional F<:>-separated library search path for perl extensions. Will be
		1766	searched after B<-perl-lib> but before F<~/.urxvt/ext> and the system library
		1767	directory.
		1768
		1769	=item B<URXVT_PERL_VERBOSITY>
		1770
		1771	See L<@@RXVT_NAME@@perl>(3).
		1772
		1773	=item B<HOME>
		1774
		1775	Used to locate the default directory for the unix domain socket for
		1776	daemon communications and to locate various resource files (such as
		1777	C<.Xdefaults>)
		1778
		1779	=item B<XAPPLRESDIR>
		1780
		1781	Directory where application-specific X resource files are located.
		1782
		1783	=item B<XENVIRONMENT>
		1784
		1785	If set and accessible, gives the name of a X resource file to be loaded by
		1786	@@RXVT_NAME@@.
985		1787
986	=back	1788	=back
987		1789
988	=head1 FREQUENTLY ASKED QUESTIONS (FAQ)	1790	=head1 FILES
989		1791
990	=over 4	1792	=over 4
991		1793
992	=item How do I know which rxvt-unicode version I'm using?	1794	=item B</usr/lib/X11/rgb.txt>
993		1795
994	The version number is displayed with the usage (-h). Also the escape	1796	Colour names.
995	sequence C<ESC[8n> sets the window title to the version number.
996
997	=item When I log-in to another system it tells me about missing terminfo data?
998
999	The terminal description used by rxvt-unicode is not as widely available
1000	as that for xterm, or even rxvt (for which the same problem often arises).
1001
1002	The correct solution for this problem is to install the terminfo, this can be done
1003	like this:
1004
1005	infocmp rxvt-unicode >rxvt.unicode.tic
1006	scp rxvt-unicode.tic remotesystem:
1007	ssh remotesystem tic rxvt-unicode.tic
1008
1009	... or by installing rxvt-unicode normally on the remote system,
1010
1011	If you cannot or do not want to do this, then you can simply set
1012	C<TERM=rxvt> or even C<TERM=xterm>, and live with the small number of
1013	problems arising, which includes wrong keymapping, less and different
1014	colours and some refresh errors in fullscreen applications. It's a nice
1015	quick-and-dirty workaround for rare cases, though.
1016
1017	If you always want to do this you can either recompile rxvt-unicode with
1018	the desired TERM value or use a resource to set it:
1019
1020	URxvt.termName: rxvt
1021
1022	=item How can I configure rxvt-unicode so that it looks similar to the original rxvt?
1023
1024	Felix von Leitner says that these two lines, in your F<.Xdefaults>, will make rxvt-unicode
1025	behave similar to the original rxvt:
1026
1027	URxvt.font: -misc-fixed-medium-r-semicondensed--13-120-75-75-c-60-iso8859-1
1028	URxvt.boldFont: -misc-fixed-bold-r-semicondensed--13-120-75-75-c-60-iso8859-1
1029
1030	=item Rxvt-unicode does not seem to understand the selected encoding?
1031
1032	=item Unicode does not seem to work?
1033
1034	If you encounter strange problems like typing an accented character but
1035	getting two unrelated other characters or similar, or if program output is
1036	subtly garbled, then you should check your locale settings.
1037
1038	Rxvt-unicode must be started with the same C<LC_CTYPE> setting as the
1039	programs. Often rxvt-unicode is started in the C<C> locale, while the
1040	login script running within the rxvt-unicode window changes the locale to
1041	sth. else, e.h. C<en_GB.UTF-8>. Needless to say, this is not going to work.
1042
1043	The best thing is to fix your startup environment, as you will likely run
1044	into other problems. If nothing works you can try this in your .profile.
1045
1046	printf '\e]701;%s\007' "$LC_CTYPE"
1047
1048	If this doesn't work, then maybe you use a C<LC_CTYPE> specification not
1049	supported on your systems. Some systems have a C<locale> comamnd which
1050	displays this. If it displays sth. like:
1051
1052	locale: Cannot set LC_CTYPE to default locale: ...
1053
1054	Then the locale you specified is not supported on your system.
1055
1056	If nothing works and you are sure that everything is set correctly then
1057	you will need to remember a little known fact: Some programs just don't
1058	support locales :(
1059
1060	=item Why do the characters look ugly?
1061
1062	=item How does rxvt-unicode choose fonts?
1063
1064	Most fonts do not contain the full range of Unicode, which is
1065	fine. Chances are that the font you (or the admin/package maintainer of
1066	your system/os) have specified does not cover all the characters you want
1067	to display.
1068
1069	B<rxvt-unicode> makes a best-effort try at finding a replacement
1070	font. Often the result is fine, but sometimes the chosen font looks
1071	bad. Many fonts have totally strange characters that don't resemble the
1072	correct glyph at all, and rxvt-unicode lacks the artificial intelligence
1073	to detetc that a specific glyph is wrong: it has to believe the font that
1074	the characters it contains indeed look correct.
1075
1076	In that case, select a font of your taste and add it to the font list,
1077	e.g.:
1078
1079	@@RXVT_NAME@@ -fn basefont,font2,font3...
1080
1081	When rxvt-unicode sees a character, it will first look at the base
1082	font. If the base font does not contain the character, it will go to the
1083	next font, and so on. Specifying your own fonts will also speed up this
1084	search and use less resources within rxvt-unicode and the X-server.
1085
1086	The only limitation is that all the fonts must not be larger than the base
1087	font, as the base font defines the principial cell size, which must be the
1088	same due to the way terminals work.
1089
1090	=item Why do some chinese characters look so different than others?
1091
1092	This is because there is a difference between script and language --
1093	rxvt-unicode does not know which language the text that is output
1094	is, as it only knows the unicode character codes. If rxvt-unicode
1095	first sees a japanese character, it might choose a japanese font for
1096	it. Subseqzuent japanese characters will take that font. Now, many chinese
1097	characters aren't represented in japanese fonts, so when the first
1098	non-japanese character comes up, rxvt-unicode will look for a chinese font
1099	-- unfortunately at this point, it will still use the japanese font for
1100	japanese characters that are also chinese.
1101
1102	The workaround is easy: just tag a chinese font at the end of your font
1103	list (see the previous question). The key is to view the font list as
1104	a preference list: If you expect more japanese, list a japanese font
1105	first. If you expect more chinese, put a chinese font first.
1106
1107	In the future it might be possible to switch preferences at runtime (the
1108	internal data structure has no problem with using different fonts for
1109	the same character at the same time, but no interface for this has been
1110	designed yet).
1111
1112	=item How can I keep rxvt-unicode from using reverse video so much?
1113
1114	First of all, make sure you are running with the right terminfo
1115	(C<urxvt>), which will get rid of most of these effects. Then make sure
1116	you have specified colours for italic and bold, as otherwise rxvt-unicode
1117	might use reverse video to simulate the effect:
1118
1119	URxvt*colorBD: white
1120	URxvt*colorIT: green
1121
1122	=item Some programs assume totally weird colours (red instead of blue), how can I fix that?
1123
1124	For some unexplainable reason, some programs (i.e. irssi) assume a very
1125	weird colour palette when confronted with a terminal with more than the
1126	standard 8 colours (rxvt-unicode supports 88). The right fix is, of
1127	course, to fix these programs not to assume non-ISO colours without very
1128	good reasons.
1129
1130	In the meantime, you can either edit your C<urxvt> terminfo definition to
1131	only claim 8 colour support or use C<TERM=rxvt>, which will fix colours
1132	but keep you from using other rxvt-unicode features.
1133
1134	=item How does rxvt-unicode determine the encoding to use?
1135
1136	=item Is there an option to switch encodings?
1137
1138	Unlike some other terminals, rxvt-unicode has no encoding switch, and no
1139	specific "utf-8" mode, such as xterm. In fact, it doesn't even know about
1140	UTF-8 or any other encodings with respect to terminal I/O.
1141
1142	The reasons is that there exists a perfectly fine mechanism for selecting
1143	the encoding, doing I/O and (most important) communicating this to all
1144	applications so everybody agrees on character properties such as width and
1145	code number. This mechanism is the I<locale>.
1146
1147	Rxvt-unicode uses the C<LC_CTYPE> locale category to select encoding. All
1148	programs doing the same (that is, most) will automatically agree in the
1149	interpretation of characters.
1150
1151	Unfortunately, there is no system-independent way to select locales, nor
1152	is there a standard on how locale specifiers will look like.
1153
1154	On most systems, the content of the C<LC_CTYPE> environment variable
1155	contains an arbitrary string which corresponds to an already-installed
1156	locale. Common names for locales are C<en_US.UTF-8>, C<de_DE.ISO-8859-15>,
1157	C<ja_JP.EUC-JP>, i.e. C<language_country.encoding>, but other forms
1158	(i.e. C<de> or C<german>) are also common.
1159
1160	Rxvt-unicode ignores all other locale categories, and except for
1161	the encoding, ignores country or language-specific settings,
1162	i.e. C<de_DE.UTF-8> and C<ja_JP.UTF-8> are the same for rxvt-unicode.
1163
1164	If you want to use a specific encoding you have to make sure you start
1165	rxvt-unicode with the correct C<LC_CTYPE> category.
1166
1167	=item Can I switch locales at runtime?
1168
1169	Yes, using an escape sequence. Try sth. like this, which sets
1170	rxvt-unicode's idea of C<LC_CTYPE>.
1171
1172	printf '\e]701;%s\007' ja_JP.SJIS
1173
1174	See also the previous question.
1175
1176	Sometimes this capability is rather handy when you want to work in one
1177	locale (e.g. C<de_DE.UTF-8>) but some programs don't support UTF-8. For
1178	example, I use this script to start C<xjdic>, which first switches to a
1179	locale supported by xjdic and back later:
1180
1181	printf '\e]701;%s\007' ja_JP.SJIS
1182	xjdic -js
1183	printf '\e]701;%s\007' de_DE.UTF-8
1184
1185	=item Can I switch the fonts at runtime?
1186
1187	Yes, using an escape sequence. Try sth. like this, which has the same
1188	effect as using the C<-fn> switch, and takes effect immediately:
1189
1190	printf '\e]50;%s\007' "9x15bold,xft:Kochi Gothic"
1191
1192	This is useful if you e.g. work primarily with japanese (and prefer a
1193	japanese font), but you have to switch to chinese temporarily, where
1194	japanese fonts would only be in your way.
1195
1196	You can think of this as a kind of manual ISO-2022 switching.
1197
1198	=item Why do italic characters look as if clipped?
1199
1200	Many fonts have difficulties with italic characters and hinting. For
1201	example, the otherwise very nicely hinted font C<xft:Bitstream Vera Sans
1202	Mono> completely fails in it's italic face. A workaround is to enable
1203	freetype autohinting, i.e. like this:
1204
1205	URxvt*italicFont: xft:Bitstream Vera Sans Mono:italic:autohint=true
1206	URxvt*boldItalicFont: xft:Bitstream Vera Sans Mono:bold:italic:autohint=true
1207
1208	=item My input method wants <some encoding> but I want UTF-8, what can I do?
1209
1210	You cna specify separate locales for the input method and the rest of the
1211	terminal, using the resource C<imlocale>:
1212
1213	URxvt*imlocale: ja_JP.EUC-JP
1214
1215	Now you can start your terminal with C<LC_CTYPE=ja_JP.UTF-8> and still
1216	use your input method. Please note, however, that you will not be able to
1217	input characters outside C<EUC-JP> in a normal way then, as your input
1218	method limits you.
1219
1220	=item Rxvt-unicode uses gobs of memory, how can I reduce that?
1221
1222	Rxvt-unicode tries to obey the rule of not charging you for sth. you
1223	don't use. One thing you should try is to configure out all settings that
1224	you don't need, for example, Xft support is a resource hog by design,
1225	when used. Compiling it out ensures that no Xft font will be loaded
1226	accidentally when rxvt-unicode tries to find a font for your characters.
1227
1228	Also, many people (me included) like large windows and even larger
1229	scrollback buffers: Without C<--enable-unicode3>, rxvt-unicode will use
1230	6 bytes per screen cell. For a 160x?? window this amounts to almost a
1231	kilobyte per line. A scorllback buffer of 10000 lines will then (if full)
1232	use 10 Megabytes of memory. With C<--enable-unicode3> it gets worse, as
1233	rxvt-unicode then uses 8 bytes per screen cell.
1234
1235	=item Can I speed up Xft rendering somehow?
1236
1237	Yes, the most obvious way to speed it up is to avoid Xft entirely, as
1238	it is simply slow. If you still want Xft fonts you might try to disable
1239	antialiasing (by appending C<:antialiasing=false>), which saves lots of
1240	memory and also speeds up rendering considerably.
1241
1242	=item Rxvt-unicode doesn't seem to anti-alias its fonts, what is wrong?
1243
1244	Rxvt-unicode will use whatever you specify as a font. If it needs to
1245	fall back to it's default font search list it will prefer X11 core
1246	fonts, because they are small and fast, and then use Xft fonts. It has
1247	antialiaisng disabled for most of them, because the author thinks they
1248	look best that way.
1249
1250	If you want antialiasing, you have to specify the fonts manually.
1251
1252	=item Mouse cut/paste suddenly no longer works.
1253
1254	Make sure that mouse reporting is actually turned off since killing
1255	some editors prematurely may leave the mouse in mouse report mode. I've
1256	heard that tcsh may use mouse reporting unless it otherwise specified. A
1257	quick check is to see if cut/paste works when the Alt or Shift keys are
1258	depressed. See @@RXVT_NAME@@(7)
1259
1260	=item What's with this bold/blink stuff?
1261
1262	If no bold colour is set via C<colorBD:>, bold will invert text using the
1263	standard foreground colour.
1264
1265	For the standard background colour, blinking will actually make the
1266	text blink when compiled with C<--enable-blinking>. with standard
1267	colours. Without C<--enable-blinking>, the blink attribute will be
1268	ignored.
1269
1270	On ANSI colours, bold/blink attributes are used to set high-intensity
1271	foreground/background colors.
1272
1273	color0-7 are the low-intensity colors.
1274
1275	color8-15 are the corresponding high-intensity colors.
1276
1277	=item I don't like the screen colors. How do I change them?
1278
1279	You can change the screen colors at run-time using F<~/.Xdefaults>
1280	resources (or as long-options).
1281
1282	Here are values that are supposed to resemble a VGA screen,
1283	including the murky brown that passes for low-intensity yellow:
1284
1285	Rxvt*color0: #000000
1286	Rxvt*color1: #A80000
1287	Rxvt*color2: #00A800
1288	Rxvt*color3: #A8A800
1289	Rxvt*color4: #0000A8
1290	Rxvt*color5: #A800A8
1291	Rxvt*color6: #00A8A8
1292	Rxvt*color7: #A8A8A8
1293
1294	Rxvt*color8: #000054
1295	Rxvt*color9: #FF0054
1296	Rxvt*color10: #00FF54
1297	Rxvt*color11: #FFFF54
1298	Rxvt*color12: #0000FF
1299	Rxvt*color13: #FF00FF
1300	Rxvt*color14: #00FFFF
1301	Rxvt*color15: #FFFFFF
1302
1303	=item What's with the strange Backspace/Delete key behaviour?
1304
1305	Assuming that the physical Backspace key corresponds to the
1306	BackSpace keysym (not likely for Linux ... see the following
1307	question) there are two standard values that can be used for
1308	Backspace: C<^H> and C<^?>.
1309
1310	Historically, either value is correct, but rxvt-unicode adopts the debian
1311	policy of using C<^?> when unsure, because it's the one only only correct
1312	choice :).
1313
1314	Rxvt-unicode tries to inherit the current stty settings and uses the value
1315	of `erase' to guess the value for backspace. If rxvt-unicode wasn't
1316	started from a terminal (say, from a menu or by remote shell), then the
1317	system value of `erase', which corresponds to CERASE in <termios.h>, will
1318	be used (which may not be the same as your stty setting).
1319
1320	For starting a new rxvt-unicode:
1321
1322	# use Backspace = ^H
1323	$ stty erase ^H
1324	$ @@RXVT_NAME@@
1325
1326	# use Backspace = ^?
1327	$ stty erase ^?
1328	$ @@RXVT_NAME@@
1329
1330	Toggle with "ESC[36h" / "ESC[36l" as documented in @@RXVT_NAME@@(7).
1331
1332	For an existing rxvt-unicode:
1333
1334	# use Backspace = ^H
1335	$ stty erase ^H
1336	$ echo -n "^[[36h"
1337
1338	# use Backspace = ^?
1339	$ stty erase ^?
1340	$ echo -n "^[[36l"
1341
1342	This helps satisfy some of the Backspace discrepancies that occur, but
1343	if you use Backspace = C<^H>, make sure that the termcap/terminfo value
1344	properly reflects that.
1345
1346	The Delete key is a another casualty of the ill-defined Backspace problem.
1347	To avoid confusion between the Backspace and Delete keys, the Delete
1348	key has been assigned an escape sequence to match the vt100 for Execute
1349	(ESC[3~) and is in the supplied termcap/terminfo.
1350
1351	Some other Backspace problems:
1352
1353	some editors use termcap/terminfo,
1354	some editors (vim I'm told) expect Backspace = ^H,
1355	GNU Emacs (and Emacs-like editors) use ^H for help.
1356
1357	Perhaps someday this will all be resolved in a consistent manner.
1358
1359	=item I don't like the key-bindings. How do I change them?
1360
1361	There are some compile-time selections available via configure. Unless
1362	you have run "configure" with the C<--disable-resources> option you can
1363	use the `keysym' resource to alter the keystrings associated with keysym
1364	0xFF00 - 0xFFFF (function, cursor keys, etc).
1365
1366	Here's an example for a tn3270 session started using `@@RXVT_NAME@@ -name tn3270'
1367
1368	!# ----- special uses ------:
1369	! tn3270 login, remap function and arrow keys.
1370	tn3270*font: *clean-bold-*-*--15-*
1371
1372	! keysym - used by rxvt only
1373	! Delete - ^D
1374	tn3270*keysym.0xFFFF: \004
1375
1376	! Home - ^A
1377	tn3270*keysym.0xFF50: \001
1378	! Left - ^B
1379	tn3270*keysym.0xFF51: \002
1380	! Up - ^P
1381	tn3270*keysym.0xFF52: \020
1382	! Right - ^F
1383	tn3270*keysym.0xFF53: \006
1384	! Down - ^N
1385	tn3270*keysym.0xFF54: \016
1386	! End - ^E
1387	tn3270*keysym.0xFF57: \005
1388
1389	! F1 - F12
1390	tn3270*keysym.0xFFBE: \e1
1391	tn3270*keysym.0xFFBF: \e2
1392	tn3270*keysym.0xFFC0: \e3
1393	tn3270*keysym.0xFFC1: \e4
1394	tn3270*keysym.0xFFC2: \e5
1395	tn3270*keysym.0xFFC3: \e6
1396	tn3270*keysym.0xFFC4: \e7
1397	tn3270*keysym.0xFFC5: \e8
1398	tn3270*keysym.0xFFC6: \e9
1399	tn3270*keysym.0xFFC7: \e0
1400	tn3270*keysym.0xFFC8: \e-
1401	tn3270*keysym.0xFFC9: \e=
1402
1403	! map Prior/Next to F7/F8
1404	tn3270*keysym.0xFF55: \e7
1405	tn3270*keysym.0xFF56: \e8
1406
1407	=item I'm using keyboard model XXX that has extra Prior/Next/Insert keys.
1408	How do I make use of them? For example, the Sun Keyboard type 4
1409	has the following mappings that rxvt-unicode doesn't recognize.
1410
1411	KP_Insert == Insert
1412	F22 == Print
1413	F27 == Home
1414	F29 == Prior
1415	F33 == End
1416	F35 == Next
1417
1418	Rather than have rxvt-unicode try to accomodate all the various possible keyboard
1419	mappings, it is better to use `xmodmap' to remap the keys as required for
1420	your particular machine.
1421
1422	=item How do I distinguish if I'm running rxvt-unicode or a regular xterm?
1423	I need this to decide about setting colors etc.
1424
1425	rxvt and rxvt-unicode always export the variable "COLORTERM", so you can
1426	check and see if that is set. Note that several programs, JED, slrn,
1427	Midnight Commander automatically check this variable to decide whether or
1428	not to use color.
1429
1430	=item How do I set the correct, full IP address for the DISPLAY variable?
1431
1432	If you've compiled rxvt-unicode with DISPLAY_IS_IP and ahve enabled
1433	insecure mode then it is possible to use the following shell script
1434	snippets to correctly set the display. If your version of rxvt-unicode
1435	wasn't also compiled with ESCZ_ANSWER (as assumed in these snippets) then
1436	the COLORTERM variable can be used to distinguish rxvt-unicode from a
1437	regular xterm.
1438
1439	Courtesy of Chuck Blake <cblake@BBN.COM> with the following shell script
1440	snippets:
1441
1442	# Bourne/Korn/POSIX family of shells:
1443	[ ${TERM:-foo} = foo ] && TERM=xterm # assume an xterm if we don't know
1444	if [ ${TERM:-foo} = xterm ]; then
1445	stty -icanon -echo min 0 time 15 # see if enhanced rxvt or not
1446	echo -n '^[Z'
1447	read term_id
1448	stty icanon echo
1449	if [ ""${term_id} = '^[[?1;2C' -a ${DISPLAY:-foo} = foo ]; then
1450	echo -n '^[[7n' # query the rxvt we are in for the DISPLAY string
1451	read DISPLAY # set it in our local shell
1452	fi
1453	fi
1454
1455	=item How do I compile the manual pages for myself?
1456
1457	You need to have a recent version of perl installed as F</usr/bin/perl>,
1458	one that comes with F<pod2man>, F<pod2text> and F<pod2html>. Then go to
1459	the doc subdirectory and enter C<make alldoc>.
1460		1797
1461	=back	1798	=back
1462		1799
1463	=head1 ENVIRONMENT	1800	=head1 SEE ALSO
1464		1801
1465	B<@@RXVT_NAME@@> sets the environment variables B<TERM>, B<COLORTERM>	1802	@@RXVT_NAME@@(7), @@RXVT_NAME@@c(1), @@RXVT_NAME@@d(1), @@RXVT_NAME@@-extensions(1),
1466	and B<COLORFGBG>. The environment variable B<WINDOWID> is set to the X	1803	@@RXVT_NAME@@perl(3), xterm(1), sh(1), resize(1), X(1), pty(4), tty(4), utmp(5)
1467	window id number of the B<@@RXVT_NAME@@> window and it also uses and
1468	sets the environment variable B<DISPLAY> to specify which display
1469	terminal to use. B<@@RXVT_NAME@@> uses the environment variables
1470	B<RXVTPATH> and B<PATH> to find XPM files.
1471		1804
1472	=head1 FILES	1805	=head1 CURRENT PROJECT COORDINATOR
1473		1806
1474	=over 4	1807	=over 4
1475		1808
1476	=item B</etc/utmp>	1809	=item Project Coordinator
1477		1810
1478	System file for login records.	1811	Marc A. Lehmann <rxvt-unicode@schmorp.de>.
1479		1812
1480	=item B</usr/lib/X11/rgb.txt>	1813	L<http://software.schmorp.de/pkg/rxvt-unicode.html>
1481
1482	Color names.
1483		1814
1484	=back	1815	=back
1485		1816
1486	=head1 SEE ALSO	1817	=head1 AUTHORS
1487
1488	@@RXVT_NAME@@(7), xterm(1), sh(1), resize(1), X(1), pty(4), tty(4), utmp(5)
1489
1490	=head1 BUGS
1491
1492	Check the BUGS file for an up-to-date list.
1493
1494	Cursor change support is not yet implemented.
1495
1496	Click-and-drag doesn't work with X11 mouse report overriding.
1497
1498	=head1 CURRENT PROJECT COORDINATOR
1499		1818
1500	=over 4	1819	=over 4
1501		1820
1502	=item Project Coordinator	1821	=item John Bovey
1503		1822
1504	@@RXVT_MAINT@@ L<@@RXVT_MAINTEMAIL@@>	1823	University of Kent, 1992, wrote the original Xvt.
1505		1824
1506	=item Web page maintainter	1825	=item Rob Nation <nation@rocket.sanders.lockheed.com>
1507		1826
1508	@@RXVT_WEBMAINT@@ L<@@RXVT_WEBMAINTEMAIL@@>	1827	very heavily modified Xvt and came up with Rxvt
1509		1828
1510	L<@@RXVT_WEBPAGE@@>	1829	=item Angelo Haritsis <ah@doc.ic.ac.uk>
		1830
		1831	wrote the Greek Keyboard Input (no longer in code)
		1832
		1833	=item mj olesen <olesen@me.QueensU.CA>
		1834
		1835	Wrote the menu system.
		1836
		1837	Project Coordinator (changes.txt 2.11 to 2.21)
		1838
		1839	=item Oezguer Kesim <kesim@math.fu-berlin.de>
		1840
		1841	Project Coordinator (changes.txt 2.21a to 2.4.5)
		1842
		1843	=item Geoff Wing <gcw@pobox.com>
		1844
		1845	Rewrote screen display and text selection routines.
		1846
		1847	Project Coordinator (changes.txt 2.4.6 - rxvt-unicode)
		1848
		1849	=item Marc Alexander Lehmann <rxvt-unicode@schmorp.de>
		1850
		1851	Forked rxvt-unicode, unicode support, rewrote almost all the code, perl
		1852	extension, random hacks, numerous bugfixes and extensions.
		1853
		1854	Project Coordinator (Changes 1.0 -)
		1855
		1856	=item Emanuele Giaquinta <emanuele.giaquinta@gmail.com>
		1857
		1858	pty/utmp code rewrite, image code improvements, many random hacks and bugfixes.
1511		1859
1512	=back	1860	=back
1513		1861
1514	=head1 AUTHORS
1515
1516	=over 4
1517
1518	=item John Bovey
1519
1520	University of Kent, 1992, wrote the original Xvt.
1521
1522	=item Rob Nation L<< <nation@rocket.sanders.lockheed.com> >>
1523
1524	very heavily modified Xvt and came up with Rxvt
1525
1526	=item Angelo Haritsis L<< <ah@doc.ic.ac.uk> >>
1527
1528	wrote the Greek Keyboard Input (no longer in code)
1529
1530	=item mj olesen L<< <olesen@me.QueensU.CA> >>
1531
1532	Wrote the menu system.
1533
1534	Project Coordinator (changes.txt 2.11 to 2.21)
1535
1536	=item Oezguer Kesim L<< <kesim@math.fu-berlin.de> >>
1537
1538	Project Coordinator (changes.txt 2.21a to 2.4.5)
1539
1540	=item Geoff Wing L<< <gcw@pobox.com> >>
1541
1542	Rewrote screen display and text selection routines. Project Coordinator
1543	(changes.txt 2.4.6 - rxvt-unicode)
1544
1545	=item Marc Alexander Lehmann L<< <rxvt@schmorp.de> >>
1546
1547	Forked rxvt-unicode, rewrote most of the display code and internal
1548	character handling to store text in unicode, improve xterm
1549	compatibility and apply numerous other bugfixes and extensions.
1550
1551	Project Coordinator (Changes 1.0 -)
1552
1553	=back
1554

Diff Legend

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