ViewVC Help

View File | Revision Log | Show Annotations | Download File

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

Comparing rxvt-unicode/doc/rxvt.7.pod (file contents):
Revision 1.56 by root, Wed Jul 13 01:01:41 2005 UTC vs.
Revision 1.174 by root, Thu Dec 4 00:23:55 2008 UTC

…		…
16	=head1 DESCRIPTION	16	=head1 DESCRIPTION
17		17
18	This document contains the FAQ, the RXVT TECHNICAL REFERENCE documenting	18	This document contains the FAQ, the RXVT TECHNICAL REFERENCE documenting
19	all escape sequences, and other background information.	19	all escape sequences, and other background information.
20		20
21	The newest version of this document is	21	The newest version of this document is also available on the World Wide Web at
22	also available on the World Wide Web at	22	L<http://pod.tst.eu/http://cvs.schmorp.de/rxvt-unicode/doc/rxvt.7.pod>.
23	L<http://cvs.schmorp.de/browse/*checkout*/rxvt-unicode/doc/rxvt.7.html>.
24		23
		24	The main manual page for @@RXVT_NAME@@ itself is available at
		25	L<http://pod.tst.eu/http://cvs.schmorp.de/rxvt-unicode/doc/rxvt.1.pod>.
		26
25	=head1 FREQUENTLY ASKED QUESTIONS	27	=head1 RXVT-UNICODE/URXVT FREQUENTLY ASKED QUESTIONS
26		28
27	=over 4
28		29
		30	=head2 Meta, Features & Commandline Issues
		31
		32	=head3 My question isn't answered here, can I ask a human?
		33
		34	Before sending me mail, you could go to IRC: C<irc.freenode.net>,
		35	channel C<#rxvt-unicode> has some rxvt-unicode enthusiasts that might be
		36	interested in learning about new and exciting problems (but not FAQs :).
		37
		38	=head3 I use Gentoo, and I have a problem...
		39
		40	There are three big problems with Gentoo Linux: first of all, most if not
		41	all Gentoo systems are completely broken (missing or mismatched header
		42	files, broken compiler etc. are just the tip of the iceberg); secondly,
		43	the Gentoo maintainer thinks it is a good idea to add broken patches to
		44	the code; and lastly, it should be called Gentoo GNU/Linux.
		45
		46	For these reasons, it is impossible to support rxvt-unicode on
		47	Gentoo. Problems appearing on Gentoo systems will usually simply be
		48	ignored unless they can be reproduced on non-Gentoo systems.
		49
		50	=head3 Does it support tabs, can I have a tabbed rxvt-unicode?
		51
		52	Beginning with version 7.3, there is a perl extension that implements a
		53	simple tabbed terminal. It is installed by default, so any of these should
		54	give you tabs:
		55
		56	@@URXVT_NAME@@ -pe tabbed
		57
		58	URxvt.perl-ext-common: default,tabbed
		59
		60	It will also work fine with tabbing functionality of many window managers
		61	or similar tabbing programs, and its embedding-features allow it to be
		62	embedded into other programs, as witnessed by F<doc/rxvt-tabbed> or
		63	the upcoming C<Gtk2::URxvt> perl module, which features a tabbed urxvt
		64	(murxvt) terminal as an example embedding application.
		65
29	=item How do I know which rxvt-unicode version I'm using?	66	=head3 How do I know which rxvt-unicode version I'm using?
30		67
31	The version number is displayed with the usage (-h). Also the escape	68	The version number is displayed with the usage (-h). Also the escape
32	sequence C<ESC [ 8 n> sets the window title to the version number.	69	sequence C<ESC [ 8 n> sets the window title to the version number. When
		70	using the @@URXVT_NAME@@c client, the version displayed is that of the
		71	daemon.
33		72
34	=item I am using Debian GNU/Linux and have a problem...
35
36	The Debian GNU/Linux package of rxvt-unicode contains large patches that
37	considerably change the behaviour of rxvt-unicode. Before reporting a
38	bug to the original rxvt-unicode author please download and install the
39	genuine version (L<http://software.schmorp.de#rxvt-unicode>) and try to
40	reproduce the problem. If you cannot, chances are that the problems are
41	specific to Debian GNU/Linux, in which case it should be reported via the
42	Debian Bug Tracking System (use C<reportbug> to report the bug).
43
44	For other problems that also affect the Debian package, you can and
45	probably should use the Debian BTS, too, because, after all, it's also a
46	bug in the Debian version and it serves as a reminder for other users that
47	might encounter the same issue.
48
49	=item When I log-in to another system it tells me about missing terminfo data?
50
51	The terminal description used by rxvt-unicode is not as widely available
52	as that for xterm, or even rxvt (for which the same problem often arises).
53
54	The correct solution for this problem is to install the terminfo, this can
55	be done like this (with ncurses' infocmp):
56
57	REMOTE=remotesystem.domain
58	infocmp rxvt-unicode | ssh $REMOTE "cat >/tmp/ti && tic /tmp/ti"
59
60	... or by installing rxvt-unicode normally on the remote system,
61
62	If you cannot or do not want to do this, then you can simply set
63	C<TERM=rxvt> or even C<TERM=xterm>, and live with the small number of
64	problems arising, which includes wrong keymapping, less and different
65	colours and some refresh errors in fullscreen applications. It's a nice
66	quick-and-dirty workaround for rare cases, though.
67
68	If you always want to do this (and are fine with the consequences) you
69	can either recompile rxvt-unicode with the desired TERM value or use a
70	resource to set it:
71
72	URxvt.termName: rxvt
73
74	If you don't plan to use B<rxvt> (quite common...) you could also replace
75	the rxvt terminfo file with the rxvt-unicode one.
76
77	=item C<bash>'s readline does not work correctly under @@RXVT_NAME@@.
78
79	=item I need a termcap file entry.
80
81	One reason you might want this is that some distributions or operating
82	systems still compile some programs using the long-obsoleted termcap
83	library (Fedora Core's bash is one example) and rely on a termcap entry
84	for C<rxvt-unicode>.
85
86	You could use rxvt's termcap entry with resonable results in many cases.
87	You can also create a termcap entry by using terminfo's infocmp program
88	like this:
89
90	infocmp -C rxvt-unicode
91
92	Or you could use this termcap entry, generated by the command above:
93
94	rxvt-unicode|rxvt-unicode terminal (X Window System):\
95	:am:bw:eo:km:mi:ms:xn:xo:\
96	:co#80:it#8:li#24:lm#0:\
97	:AL=\E[%dL:DC=\E[%dP:DL=\E[%dM:DO=\E[%dB:IC=\E[%d@:\
98	:K1=\EOw:K2=\EOu:K3=\EOy:K4=\EOq:K5=\EOs:LE=\E[%dD:\
99	:RI=\E[%dC:SF=\E[%dS:SR=\E[%dT:UP=\E[%dA:ae=\E(B:al=\E[L:\
100	:as=\E(0:bl=^G:cd=\E[J:ce=\E[K:cl=\E[H\E[2J:\
101	:cm=\E[%i%d;%dH:cr=^M:cs=\E[%i%d;%dr:ct=\E[3g:dc=\E[P:\
102	:dl=\E[M:do=^J:ec=\E[%dX:ei=\E[4l:ho=\E[H:\
103	:i1=\E[?47l\E=\E[?1l:ic=\E[@:im=\E[4h:\
104	:is=\E[r\E[m\E[2J\E[H\E[?7h\E[?1;3;4;6l\E[4l:\
105	:k1=\E[11~:k2=\E[12~:k3=\E[13~:k4=\E[14~:k5=\E[15~:\
106	:k6=\E[17~:k7=\E[18~:k8=\E[19~:k9=\E[20~:kD=\E[3~:\
107	:kI=\E[2~:kN=\E[6~:kP=\E[5~:kb=\177:kd=\EOB:ke=\E[?1l\E>:\
108	:kh=\E[7~:kl=\EOD:kr=\EOC:ks=\E[?1h\E=:ku=\EOA:le=^H:\
109	:mb=\E[5m:md=\E[1m:me=\E[m\017:mr=\E[7m:nd=\E[C:rc=\E8:\
110	:sc=\E7:se=\E[27m:sf=^J:so=\E[7m:sr=\EM:st=\EH:ta=^I:\
111	:te=\E[r\E[?1049l:ti=\E[?1049h:ue=\E[24m:up=\E[A:\
112	:us=\E[4m:vb=\E[?5h\E[?5l:ve=\E[?25h:vi=\E[?25l:\
113	:vs=\E[?25h:
114
115	=item Why does C<ls> no longer have coloured output?
116
117	The C<ls> in the GNU coreutils unfortunately doesn't use terminfo to
118	decide wether a terminal has colour, but uses it's own configuration
119	file. Needless to say, C<rxvt-unicode> is not in it's default file (among
120	with most other terminals supporting colour). Either add:
121
122	TERM rxvt-unicode
123
124	to C</etc/DIR_COLORS> or simply add:
125
126	alias ls='ls --color=auto'
127
128	to your C<.profile> or C<.bashrc>.
129
130	=item Why doesn't vim/emacs etc. use the 88 colour mode?
131
132	=item Why doesn't vim/emacs etc. make use of italic?
133
134	=item Why are the secondary screen-related options not working properly?
135
136	Make sure you are using C<TERM=rxvt-unicode>. Some pre-packaged
137	distributions (most notably Debian GNU/Linux) break rxvt-unicode
138	by setting C<TERM> to C<rxvt>, which doesn't have these extra
139	features. Unfortunately, some of these (most notably, again, Debian
140	GNU/Linux) furthermore fail to even install the C<rxvt-unicode> terminfo
141	file, so you will need to install it on your own (See the question B<When
142	I log-in to another system it tells me about missing terminfo data?> on
143	how to do this).
144
145	=item My numerical keypad acts weird and generates differing output?
146
147	Some Debian GNUL/Linux users seem to have this problem, although no
148	specific details were reported so far. It is possible that this is caused
149	by the wrong C<TERM> setting, although the details of wether and how
150	this can happen are unknown, as C<TERM=rxvt> should offer a compatible
151	keymap. See the answer to the previous question, and please report if that
152	helped.
153
154	=item Rxvt-unicode does not seem to understand the selected encoding?
155
156	=item Unicode does not seem to work?
157
158	If you encounter strange problems like typing an accented character but
159	getting two unrelated other characters or similar, or if program output is
160	subtly garbled, then you should check your locale settings.
161
162	Rxvt-unicode must be started with the same C<LC_CTYPE> setting as the
163	programs. Often rxvt-unicode is started in the C<C> locale, while the
164	login script running within the rxvt-unicode window changes the locale to
165	something else, e.g. C<en_GB.UTF-8>. Needless to say, this is not going to work.
166
167	The best thing is to fix your startup environment, as you will likely run
168	into other problems. If nothing works you can try this in your .profile.
169
170	printf '\e]701;%s\007' "$LC_CTYPE"
171
172	If this doesn't work, then maybe you use a C<LC_CTYPE> specification not
173	supported on your systems. Some systems have a C<locale> command which
174	displays this (also, C<perl -e0> can be used to check locale settings, as
175	it will complain loudly if it cannot set the locale). If it displays something
176	like:
177
178	locale: Cannot set LC_CTYPE to default locale: ...
179
180	Then the locale you specified is not supported on your system.
181
182	If nothing works and you are sure that everything is set correctly then
183	you will need to remember a little known fact: Some programs just don't
184	support locales :(
185
186	=item Why do some characters look so much different than others?
187
188	=item How does rxvt-unicode choose fonts?
189
190	Most fonts do not contain the full range of Unicode, which is
191	fine. Chances are that the font you (or the admin/package maintainer of
192	your system/os) have specified does not cover all the characters you want
193	to display.
194
195	B<rxvt-unicode> makes a best-effort try at finding a replacement
196	font. Often the result is fine, but sometimes the chosen font looks
197	bad/ugly/wrong. Some fonts have totally strange characters that don't
198	resemble the correct glyph at all, and rxvt-unicode lacks the artificial
199	intelligence to detect that a specific glyph is wrong: it has to believe
200	the font that the characters it claims to contain indeed look correct.
201
202	In that case, select a font of your taste and add it to the font list,
203	e.g.:
204
205	@@RXVT_NAME@@ -fn basefont,font2,font3...
206
207	When rxvt-unicode sees a character, it will first look at the base
208	font. If the base font does not contain the character, it will go to the
209	next font, and so on. Specifying your own fonts will also speed up this
210	search and use less resources within rxvt-unicode and the X-server.
211
212	The only limitation is that none of the fonts may be larger than the base
213	font, as the base font defines the terminal character cell size, which
214	must be the same due to the way terminals work.
215
216	=item Why do some chinese characters look so different than others?
217
218	This is because there is a difference between script and language --
219	rxvt-unicode does not know which language the text that is output is,
220	as it only knows the unicode character codes. If rxvt-unicode first
221	sees a japanese/chinese character, it might choose a japanese font for
222	display. Subsequent japanese characters will use that font. Now, many
223	chinese characters aren't represented in japanese fonts, so when the first
224	non-japanese character comes up, rxvt-unicode will look for a chinese font
225	-- unfortunately at this point, it will still use the japanese font for
226	chinese characters that are also in the japanese font.
227
228	The workaround is easy: just tag a chinese font at the end of your font
229	list (see the previous question). The key is to view the font list as
230	a preference list: If you expect more japanese, list a japanese font
231	first. If you expect more chinese, put a chinese font first.
232
233	In the future it might be possible to switch language preferences at
234	runtime (the internal data structure has no problem with using different
235	fonts for the same character at the same time, but no interface for this
236	has been designed yet).
237
238	Until then, you might get away with switching fonts at runtime (see L<Can
239	I switch the fonts at runtime?> later in this document).
240
241	=item Why does rxvt-unicode sometimes leave pixel droppings?
242
243	Most fonts were not designed for terminal use, which means that character
244	size varies a lot. A font that is otherwise fine for terminal use might
245	contain some characters that are simply too wide. Rxvt-unicode will avoid
246	these characters. For characters that are just "a bit" too wide a special
247	"careful" rendering mode is used that redraws adjacent characters.
248
249	All of this requires that fonts do not lie about character sizes,
250	however: Xft fonts often draw glyphs larger than their acclaimed bounding
251	box, and rxvt-unicode has no way of detecting this (the correct way is to
252	ask for the character bounding box, which unfortunately is wrong in these
253	cases).
254
255	It's not clear (to me at least), wether this is a bug in Xft, freetype,
256	or the respective font. If you encounter this problem you might try using
257	the C<-lsp> option to give the font more height. If that doesn't work, you
258	might be forced to use a different font.
259
260	All of this is not a problem when using X11 core fonts, as their bounding
261	box data is correct.
262
263	=item On Solaris 9, many line-drawing characters are too wide.
264
265	Seems to be a known bug, read
266	L<http://nixdoc.net/files/forum/about34198.html>. Some people use the
267	following ugly workaround to get non-double-wide-characters working:
268
269	#define wcwidth(x) wcwidth(x) > 1 ? 1 : wcwidth(x)
270
271	=item My Compose (Multi_key) key is no longer working.
272
273	The most common causes for this are that either your locale is not set
274	correctly, or you specified a B<preeditStyle> that is not supported by
275	your input method. For example, if you specified B<OverTheSpot> and
276	your input method (e.g. the default input method handling Compose keys)
277	does not support this (for instance because it is not visual), then
278	rxvt-unicode will continue without an input method.
279
280	In this case either do not specify a B<preeditStyle> or specify more than
281	one pre-edit style, such as B<OverTheSpot,Root,None>.
282
283	=item I cannot type C<Ctrl-Shift-2> to get an ASCII NUL character due to ISO 14755
284
285	Either try C<Ctrl-2> alone (it often is mapped to ASCII NUL even on
286	international keyboards) or simply use ISO 14755 support to your
287	advantage, typing <Ctrl-Shift-0> to get a ASCII NUL. This works for other
288	codes, too, such as C<Ctrl-Shift-1-d> to type the default telnet escape
289	character and so on.
290
291	=item How can I keep rxvt-unicode from using reverse video so much?
292
293	First of all, make sure you are running with the right terminal settings
294	(C<TERM=rxvt-unicode>), which will get rid of most of these effects. Then
295	make sure you have specified colours for italic and bold, as otherwise
296	rxvt-unicode might use reverse video to simulate the effect:
297
298	URxvt.colorBD: white
299	URxvt.colorIT: green
300
301	=item Some programs assume totally weird colours (red instead of blue), how can I fix that?
302
303	For some unexplainable reason, some rare programs assume a very weird
304	colour palette when confronted with a terminal with more than the standard
305	8 colours (rxvt-unicode supports 88). The right fix is, of course, to fix
306	these programs not to assume non-ISO colours without very good reasons.
307
308	In the meantime, you can either edit your C<rxvt-unicode> terminfo
309	definition to only claim 8 colour support or use C<TERM=rxvt>, which will
310	fix colours but keep you from using other rxvt-unicode features.
311
312	=item I am on FreeBSD and rxvt-unicode does not seem to work at all.
313
314	Rxvt-unicode requires the symbol C<__STDC_ISO_10646__> to be defined
315	in your compile environment, or an implementation that implements it,
316	wether it defines the symbol or not. C<__STDC_ISO_10646__> requires that
317	B<wchar_t> is represented as unicode.
318
319	As you might have guessed, FreeBSD does neither define this symobl nor
320	does it support it. Instead, it uses it's own internal representation of
321	B<wchar_t>. This is, of course, completely fine with respect to standards.
322
323	However, that means rxvt-unicode only works in C<POSIX>, C<ISO-8859-1> and
324	C<UTF-8> locales under FreeBSD (which all use Unicode as B<wchar_t>.
325
326	C<__STDC_ISO_10646__> is the only sane way to support multi-language
327	apps in an OS, as using a locale-dependent (and non-standardized)
328	representation of B<wchar_t> makes it impossible to convert between
329	B<wchar_t> (as used by X11 and your applications) and any other encoding
330	without implementing OS-specific-wrappers for each and every locale. There
331	simply are no APIs to convert B<wchar_t> into anything except the current
332	locale encoding.
333
334	Some applications (such as the formidable B<mlterm>) work around this
335	by carrying their own replacement functions for character set handling
336	with them, and either implementing OS-dependent hacks or doing multiple
337	conversions (which is slow and unreliable in case the OS implements
338	encodings slightly different than the terminal emulator).
339
340	The rxvt-unicode author insists that the right way to fix this is in the
341	system libraries once and for all, instead of forcing every app to carry
342	complete replacements for them :)
343
344	=item I use Solaris 9 and it doesn't compile/work/etc.
345
346	Try the diff in F<doc/solaris9.patch> as a base. It fixes the worst
347	problems with C<wcwidth> and a compile problem.
348
349	=item How can I use rxvt-unicode under cygwin?
350
351	rxvt-unicode should compile and run out of the box on cygwin, using
352	the X11 libraries that come with cygwin. libW11 emulation is no
353	longer supported (and makes no sense, either, as it only supported a
354	single font). I recommend starting the X-server in C<-multiwindow> or
355	C<-rootless> mode instead, which will result in similar look&feel as the
356	old libW11 emulation.
357
358	At the time of this writing, cygwin didn't seem to support any multi-byte
359	encodings, so you are likely limited to 8-bit encodings.
360
361	=item How does rxvt-unicode determine the encoding to use?
362
363	=item Is there an option to switch encodings?
364
365	Unlike some other terminals, rxvt-unicode has no encoding switch, and no
366	specific "utf-8" mode, such as xterm. In fact, it doesn't even know about
367	UTF-8 or any other encodings with respect to terminal I/O.
368
369	The reasons is that there exists a perfectly fine mechanism for selecting
370	the encoding, doing I/O and (most important) communicating this to all
371	applications so everybody agrees on character properties such as width
372	and code number. This mechanism is the I<locale>. Applications not using
373	that info will have problems (for example, C<xterm> gets the width of
374	characters wrong as it uses it's own, locale-independent table under all
375	locales).
376
377	Rxvt-unicode uses the C<LC_CTYPE> locale category to select encoding. All
378	programs doing the same (that is, most) will automatically agree in the
379	interpretation of characters.
380
381	Unfortunately, there is no system-independent way to select locales, nor
382	is there a standard on how locale specifiers will look like.
383
384	On most systems, the content of the C<LC_CTYPE> environment variable
385	contains an arbitrary string which corresponds to an already-installed
386	locale. Common names for locales are C<en_US.UTF-8>, C<de_DE.ISO-8859-15>,
387	C<ja_JP.EUC-JP>, i.e. C<language_country.encoding>, but other forms
388	(i.e. C<de> or C<german>) are also common.
389
390	Rxvt-unicode ignores all other locale categories, and except for
391	the encoding, ignores country or language-specific settings,
392	i.e. C<de_DE.UTF-8> and C<ja_JP.UTF-8> are the normally same to
393	rxvt-unicode.
394
395	If you want to use a specific encoding you have to make sure you start
396	rxvt-unicode with the correct C<LC_CTYPE> category.
397
398	=item Can I switch locales at runtime?
399
400	Yes, using an escape sequence. Try something like this, which sets
401	rxvt-unicode's idea of C<LC_CTYPE>.
402
403	printf '\e]701;%s\007' ja_JP.SJIS
404
405	See also the previous answer.
406
407	Sometimes this capability is rather handy when you want to work in
408	one locale (e.g. C<de_DE.UTF-8>) but some programs don't support it
409	(e.g. UTF-8). For example, I use this script to start C<xjdic>, which
410	first switches to a locale supported by xjdic and back later:
411
412	printf '\e]701;%s\007' ja_JP.SJIS
413	xjdic -js
414	printf '\e]701;%s\007' de_DE.UTF-8
415
416	You can also use xterm's C<luit> program, which usually works fine, except
417	for some locales where character width differs between program- and
418	rxvt-unicode-locales.
419
420	=item Can I switch the fonts at runtime?
421
422	Yes, using an escape sequence. Try something like this, which has the same
423	effect as using the C<-fn> switch, and takes effect immediately:
424
425	printf '\e]50;%s\007' "9x15bold,xft:Kochi Gothic"
426
427	This is useful if you e.g. work primarily with japanese (and prefer a
428	japanese font), but you have to switch to chinese temporarily, where
429	japanese fonts would only be in your way.
430
431	You can think of this as a kind of manual ISO-2022 switching.
432
433	=item Why do italic characters look as if clipped?
434
435	Many fonts have difficulties with italic characters and hinting. For
436	example, the otherwise very nicely hinted font C<xft:Bitstream Vera Sans
437	Mono> completely fails in it's italic face. A workaround might be to
438	enable freetype autohinting, i.e. like this:
439
440	URxvt.italicFont: xft:Bitstream Vera Sans Mono:italic:autohint=true
441	URxvt.boldItalicFont: xft:Bitstream Vera Sans Mono:bold:italic:autohint=true
442
443	=item My input method wants <some encoding> but I want UTF-8, what can I do?
444
445	You can specify separate locales for the input method and the rest of the
446	terminal, using the resource C<imlocale>:
447
448	URxvt*imlocale: ja_JP.EUC-JP
449
450	Now you can start your terminal with C<LC_CTYPE=ja_JP.UTF-8> and still
451	use your input method. Please note, however, that you will not be able to
452	input characters outside C<EUC-JP> in a normal way then, as your input
453	method limits you.
454
455	=item Rxvt-unicode crashes when the X Input Method changes or exits.
456
457	Unfortunately, this is unavoidable, as the XIM protocol is racy by
458	design. Applications can avoid some crashes at the expense of memory
459	leaks, and Input Methods can avoid some crashes by careful ordering at
460	exit time. B<kinput2> (and derived input methods) generally succeeds,
461	while B<SCIM> (or similar input methods) fails. In the end, however,
462	crashes cannot be completely avoided even if both sides cooperate.
463
464	So the only workaround is not to kill your Input Method Servers.
465
466	=item Rxvt-unicode uses gobs of memory, how can I reduce that?	73	=head3 Rxvt-unicode uses gobs of memory, how can I reduce that?
467		74
468	Rxvt-unicode tries to obey the rule of not charging you for something you	75	Rxvt-unicode tries to obey the rule of not charging you for something you
469	don't use. One thing you should try is to configure out all settings that	76	don't use. One thing you should try is to configure out all settings that
470	you don't need, for example, Xft support is a resource hog by design,	77	you don't need, for example, Xft support is a resource hog by design,
471	when used. Compiling it out ensures that no Xft font will be loaded	78	when used. Compiling it out ensures that no Xft font will be loaded
…		…
476	6 bytes per screen cell. For a 160x?? window this amounts to almost a	83	6 bytes per screen cell. For a 160x?? window this amounts to almost a
477	kilobyte per line. A scrollback buffer of 10000 lines will then (if full)	84	kilobyte per line. A scrollback buffer of 10000 lines will then (if full)
478	use 10 Megabytes of memory. With C<--enable-unicode3> it gets worse, as	85	use 10 Megabytes of memory. With C<--enable-unicode3> it gets worse, as
479	rxvt-unicode then uses 8 bytes per screen cell.	86	rxvt-unicode then uses 8 bytes per screen cell.
480		87
		88	=head3 How can I start @@URXVT_NAME@@d in a race-free way?
		89
		90	Try C<@@URXVT_NAME@@d -f -o>, which tells @@URXVT_NAME@@d to open the
		91	display, create the listening socket and then fork.
		92
		93	=head3 How can I start @@URXVT_NAME@@d automatically when I run @@URXVT_NAME@@c?
		94
		95	If you want to start @@URXVT_NAME@@d automatically whenever you run
		96	@@URXVT_NAME@@c and the daemon isn't running yet, use this script:
		97
		98	#!/bin/sh
		99	@@URXVT_NAME@@c "$@"
		100	if [ $? -eq 2 ]; then
		101	@@URXVT_NAME@@d -q -o -f
		102	@@URXVT_NAME@@c "$@"
		103	fi
		104
		105	This tries to create a new terminal, and if fails with exit status 2,
		106	meaning it couldn't connect to the daemon, it will start the daemon and
		107	re-run the command. Subsequent invocations of the script will re-use the
		108	existing daemon.
		109
		110	=head3 How do I distinguish whether I'm running rxvt-unicode or a regular xterm? I need this to decide about setting colors etc.
		111
		112	The original rxvt and rxvt-unicode always export the variable "COLORTERM",
		113	so you can check and see if that is set. Note that several programs, JED,
		114	slrn, Midnight Commander automatically check this variable to decide
		115	whether or not to use color.
		116
		117	=head3 How do I set the correct, full IP address for the DISPLAY variable?
		118
		119	If you've compiled rxvt-unicode with DISPLAY_IS_IP and have enabled
		120	insecure mode then it is possible to use the following shell script
		121	snippets to correctly set the display. If your version of rxvt-unicode
		122	wasn't also compiled with ESCZ_ANSWER (as assumed in these snippets) then
		123	the COLORTERM variable can be used to distinguish rxvt-unicode from a
		124	regular xterm.
		125
		126	Courtesy of Chuck Blake <cblake@BBN.COM> with the following shell script
		127	snippets:
		128
		129	# Bourne/Korn/POSIX family of shells:
		130	[ ${TERM:-foo} = foo ] && TERM=xterm # assume an xterm if we don't know
		131	if [ ${TERM:-foo} = xterm ]; then
		132	stty -icanon -echo min 0 time 15 # see if enhanced rxvt or not
		133	echo -n '^[Z'
		134	read term_id
		135	stty icanon echo
		136	if [ ""${term_id} = '^[[?1;2C' -a ${DISPLAY:-foo} = foo ]; then
		137	echo -n '^[[7n' # query the rxvt we are in for the DISPLAY string
		138	read DISPLAY # set it in our local shell
		139	fi
		140	fi
		141
		142	=head3 How do I compile the manual pages on my own?
		143
		144	You need to have a recent version of perl installed as F</usr/bin/perl>,
		145	one that comes with F<pod2man>, F<pod2text> and F<pod2xhtml> (from
		146	F<Pod::Xhtml>). Then go to the doc subdirectory and enter C<make alldoc>.
		147
		148	=head3 Isn't rxvt-unicode supposed to be small? Don't all those features bloat?
		149
		150	I often get asked about this, and I think, no, they didn't cause extra
		151	bloat. If you compare a minimal rxvt and a minimal urxvt, you can see
		152	that the urxvt binary is larger (due to some encoding tables always being
		153	compiled in), but it actually uses less memory (RSS) after startup. Even
		154	with C<--disable-everything>, this comparison is a bit unfair, as many
		155	features unique to urxvt (locale, encoding conversion, iso14755 etc.) are
		156	already in use in this mode.
		157
		158	text data bss drs rss filename
		159	98398 1664 24 15695 1824 rxvt --disable-everything
		160	188985 9048 66616 18222 1788 urxvt --disable-everything
		161
		162	When you C<--enable-everything> (which I<is> unfair, as this involves xft
		163	and full locale/XIM support which are quite bloaty inside libX11 and my
		164	libc), the two diverge, but not unreasonably so.
		165
		166	text data bss drs rss filename
		167	163431 2152 24 20123 2060 rxvt --enable-everything
		168	1035683 49680 66648 29096 3680 urxvt --enable-everything
		169
		170	The very large size of the text section is explained by the east-asian
		171	encoding tables, which, if unused, take up disk space but nothing else
		172	and can be compiled out unless you rely on X11 core fonts that use those
		173	encodings. The BSS size comes from the 64k emergency buffer that my c++
		174	compiler allocates (but of course doesn't use unless you are out of
		175	memory). Also, using an xft font instead of a core font immediately adds a
		176	few megabytes of RSS. Xft indeed is responsible for a lot of RSS even when
		177	not used.
		178
		179	Of course, due to every character using two or four bytes instead of one,
		180	a large scrollback buffer will ultimately make rxvt-unicode use more
		181	memory.
		182
		183	Compared to e.g. Eterm (5112k), aterm (3132k) and xterm (4680k), this
		184	still fares rather well. And compared to some monsters like gnome-terminal
		185	(21152k + extra 4204k in separate processes) or konsole (22200k + extra
		186	43180k in daemons that stay around after exit, plus half a minute of
		187	startup time, including the hundreds of warnings it spits out), it fares
		188	extremely well *g*.
		189
		190	=head3 Why C++, isn't that unportable/bloated/uncool?
		191
		192	Is this a question? :) It comes up very often. The simple answer is: I had
		193	to write it, and C++ allowed me to write and maintain it in a fraction
		194	of the time and effort (which is a scarce resource for me). Put even
		195	shorter: It simply wouldn't exist without C++.
		196
		197	My personal stance on this is that C++ is less portable than C, but in
		198	the case of rxvt-unicode this hardly matters, as its portability limits
		199	are defined by things like X11, pseudo terminals, locale support and unix
		200	domain sockets, which are all less portable than C++ itself.
		201
		202	Regarding the bloat, see the above question: It's easy to write programs
		203	in C that use gobs of memory, an certainly possible to write programs in
		204	C++ that don't. C++ also often comes with large libraries, but this is
		205	not necessarily the case with GCC. Here is what rxvt links against on my
		206	system with a minimal config:
		207
		208	libX11.so.6 => /usr/X11R6/lib/libX11.so.6 (0x00002aaaaabc3000)
		209	libc.so.6 => /lib/libc.so.6 (0x00002aaaaadde000)
		210	libdl.so.2 => /lib/libdl.so.2 (0x00002aaaab01d000)
		211	/lib64/ld-linux-x86-64.so.2 (0x00002aaaaaaab000)
		212
		213	And here is rxvt-unicode:
		214
		215	libX11.so.6 => /usr/X11R6/lib/libX11.so.6 (0x00002aaaaabc3000)
		216	libgcc_s.so.1 => /lib/libgcc_s.so.1 (0x00002aaaaada2000)
		217	libc.so.6 => /lib/libc.so.6 (0x00002aaaaaeb0000)
		218	libdl.so.2 => /lib/libdl.so.2 (0x00002aaaab0ee000)
		219	/lib64/ld-linux-x86-64.so.2 (0x00002aaaaaaab000)
		220
		221	No large bloated libraries (of course, none were linked in statically),
		222	except maybe libX11 :)
		223
		224
		225	=head2 Rendering, Font & Look and Feel Issues
		226
		227	=head3 I can't get transparency working, what am I doing wrong?
		228
		229	First of all, please address all transparency related issues to Sasha Vasko at
		230	sasha@aftercode.net and do not bug the author about it. Also, if you can't
		231	get it working consider it a rite of passage: ... and you failed.
		232
		233	Here are four ways to get transparency. B<Do> read the manpage and option
		234	descriptions for the programs mentioned and rxvt-unicode. Really, do it!
		235
		236	1. Use transparent mode:
		237
		238	Esetroot wallpaper.jpg
		239	@@URXVT_NAME@@ -tr -tint red -sh 40
		240
		241	That works. If you think it doesn't, you lack transparency and tinting
		242	support, or you are unable to read.
		243
		244	2. Use a simple pixmap and emulate pseudo-transparency. This enables you
		245	to use effects other than tinting and shading: Just shade/tint/whatever
		246	your picture with gimp or any other tool:
		247
		248	convert wallpaper.jpg -blur 20x20 -modulate 30 background.jpg
		249	@@URXVT_NAME@@ -pixmap "background.jpg;:root"
		250
		251	That works. If you think it doesn't, you lack AfterImage support, or you
		252	are unable to read.
		253
		254	3. Use an ARGB visual:
		255
		256	@@URXVT_NAME@@ -depth 32 -fg grey90 -bg rgba:0000/0000/4444/cccc
		257
		258	This requires XFT support, and the support of your X-server. If that
		259	doesn't work for you, blame Xorg and Keith Packard. ARGB visuals aren't
		260	there yet, no matter what they claim. Rxvt-Unicode contains the necessary
		261	bugfixes and workarounds for Xft and Xlib to make it work, but that
		262	doesn't mean that your WM has the required kludges in place.
		263
		264	4. Use xcompmgr and let it do the job:
		265
		266	xprop -frame -f _NET_WM_WINDOW_OPACITY 32c \
		267	-set _NET_WM_WINDOW_OPACITY 0xc0000000
		268
		269	Then click on a window you want to make transparent. Replace C<0xc0000000>
		270	by other values to change the degree of opacity. If it doesn't work and
		271	your server crashes, you got to keep the pieces.
		272
		273	=head3 Why does rxvt-unicode sometimes leave pixel droppings?
		274
		275	Most fonts were not designed for terminal use, which means that character
		276	size varies a lot. A font that is otherwise fine for terminal use might
		277	contain some characters that are simply too wide. Rxvt-unicode will avoid
		278	these characters. For characters that are just "a bit" too wide a special
		279	"careful" rendering mode is used that redraws adjacent characters.
		280
		281	All of this requires that fonts do not lie about character sizes,
		282	however: Xft fonts often draw glyphs larger than their acclaimed bounding
		283	box, and rxvt-unicode has no way of detecting this (the correct way is to
		284	ask for the character bounding box, which unfortunately is wrong in these
		285	cases).
		286
		287	It's not clear (to me at least), whether this is a bug in Xft, freetype,
		288	or the respective font. If you encounter this problem you might try using
		289	the C<-lsp> option to give the font more height. If that doesn't work, you
		290	might be forced to use a different font.
		291
		292	All of this is not a problem when using X11 core fonts, as their bounding
		293	box data is correct.
		294
		295	=head3 How can I keep rxvt-unicode from using reverse video so much?
		296
		297	First of all, make sure you are running with the right terminal settings
		298	(C<TERM=rxvt-unicode>), which will get rid of most of these effects. Then
		299	make sure you have specified colours for italic and bold, as otherwise
		300	rxvt-unicode might use reverse video to simulate the effect:
		301
		302	URxvt.colorBD: white
		303	URxvt.colorIT: green
		304
		305	=head3 Some programs assume totally weird colours (red instead of blue), how can I fix that?
		306
		307	For some unexplainable reason, some rare programs assume a very weird
		308	colour palette when confronted with a terminal with more than the standard
		309	8 colours (rxvt-unicode supports 88). The right fix is, of course, to fix
		310	these programs not to assume non-ISO colours without very good reasons.
		311
		312	In the meantime, you can either edit your C<rxvt-unicode> terminfo
		313	definition to only claim 8 colour support or use C<TERM=rxvt>, which will
		314	fix colours but keep you from using other rxvt-unicode features.
		315
		316	=head3 Can I switch the fonts at runtime?
		317
		318	Yes, using an escape sequence. Try something like this, which has the same
		319	effect as using the C<-fn> switch, and takes effect immediately:
		320
		321	printf '\33]50;%s\007' "9x15bold,xft:Kochi Gothic"
		322
		323	This is useful if you e.g. work primarily with japanese (and prefer a
		324	japanese font), but you have to switch to chinese temporarily, where
		325	japanese fonts would only be in your way.
		326
		327	You can think of this as a kind of manual ISO-2022 switching.
		328
		329	=head3 Why do italic characters look as if clipped?
		330
		331	Many fonts have difficulties with italic characters and hinting. For
		332	example, the otherwise very nicely hinted font C<xft:Bitstream Vera Sans
		333	Mono> completely fails in its italic face. A workaround might be to
		334	enable freetype autohinting, i.e. like this:
		335
		336	URxvt.italicFont: xft:Bitstream Vera Sans Mono:italic:autohint=true
		337	URxvt.boldItalicFont: xft:Bitstream Vera Sans Mono:bold:italic:autohint=true
		338
481	=item Can I speed up Xft rendering somehow?	339	=head3 Can I speed up Xft rendering somehow?
482		340
483	Yes, the most obvious way to speed it up is to avoid Xft entirely, as	341	Yes, the most obvious way to speed it up is to avoid Xft entirely, as
484	it is simply slow. If you still want Xft fonts you might try to disable	342	it is simply slow. If you still want Xft fonts you might try to disable
485	antialiasing (by appending C<:antialiasing=false>), which saves lots of	343	antialiasing (by appending C<:antialias=false>), which saves lots of
486	memory and also speeds up rendering considerably.	344	memory and also speeds up rendering considerably.
487		345
488	=item Rxvt-unicode doesn't seem to anti-alias its fonts, what is wrong?	346	=head3 Rxvt-unicode doesn't seem to anti-alias its fonts, what is wrong?
489		347
490	Rxvt-unicode will use whatever you specify as a font. If it needs to	348	Rxvt-unicode will use whatever you specify as a font. If it needs to
491	fall back to it's default font search list it will prefer X11 core	349	fall back to its default font search list it will prefer X11 core
492	fonts, because they are small and fast, and then use Xft fonts. It has	350	fonts, because they are small and fast, and then use Xft fonts. It has
493	antialiasing disabled for most of them, because the author thinks they	351	antialiasing disabled for most of them, because the author thinks they
494	look best that way.	352	look best that way.
495		353
496	If you want antialiasing, you have to specify the fonts manually.	354	If you want antialiasing, you have to specify the fonts manually.
497		355
498	=item Mouse cut/paste suddenly no longer works.
499
500	Make sure that mouse reporting is actually turned off since killing
501	some editors prematurely may leave the mouse in mouse report mode. I've
502	heard that tcsh may use mouse reporting unless it otherwise specified. A
503	quick check is to see if cut/paste works when the Alt or Shift keys are
504	depressed. See @@RXVT_NAME@@(7)
505
506	=item What's with this bold/blink stuff?	356	=head3 What's with this bold/blink stuff?
507		357
508	If no bold colour is set via C<colorBD:>, bold will invert text using the	358	If no bold colour is set via C<colorBD:>, bold will invert text using the
509	standard foreground colour.	359	standard foreground colour.
510		360
511	For the standard background colour, blinking will actually make the	361	For the standard background colour, blinking will actually make
512	text blink when compiled with C<--enable-blinking>. with standard	362	the text blink when compiled with C<--enable-text-blink>. Without
513	colours. Without C<--enable-blinking>, the blink attribute will be	363	C<--enable-text-blink>, the blink attribute will be ignored.
514	ignored.
515		364
516	On ANSI colours, bold/blink attributes are used to set high-intensity	365	On ANSI colours, bold/blink attributes are used to set high-intensity
517	foreground/background colors.	366	foreground/background colors.
518		367
519	color0-7 are the low-intensity colors.	368	color0-7 are the low-intensity colors.
520		369
521	color8-15 are the corresponding high-intensity colors.	370	color8-15 are the corresponding high-intensity colors.
522		371
523	=item I don't like the screen colors. How do I change them?	372	=head3 I don't like the screen colors. How do I change them?
524		373
525	You can change the screen colors at run-time using F<~/.Xdefaults>	374	You can change the screen colors at run-time using F<~/.Xdefaults>
526	resources (or as long-options).	375	resources (or as long-options).
527		376
528	Here are values that are supposed to resemble a VGA screen,	377	Here are values that are supposed to resemble a VGA screen,
…		…
544	URxvt.color12: #0000FF	393	URxvt.color12: #0000FF
545	URxvt.color13: #FF00FF	394	URxvt.color13: #FF00FF
546	URxvt.color14: #00FFFF	395	URxvt.color14: #00FFFF
547	URxvt.color15: #FFFFFF	396	URxvt.color15: #FFFFFF
548		397
549	And here is a more complete set of non-standard colors described (not by	398	And here is a more complete set of non-standard colors.
550	me) as "pretty girly".
551		399
552	URxvt.cursorColor: #dc74d1	400	URxvt.cursorColor: #dc74d1
553	URxvt.pointerColor: #dc74d1	401	URxvt.pointerColor: #dc74d1
554	URxvt.background: #0e0e0e	402	URxvt.background: #0e0e0e
555	URxvt.foreground: #4ad5e1	403	URxvt.foreground: #4ad5e1
…		…
566	URxvt.color6: #73f7ff	414	URxvt.color6: #73f7ff
567	URxvt.color14: #73f7ff	415	URxvt.color14: #73f7ff
568	URxvt.color7: #e1dddd	416	URxvt.color7: #e1dddd
569	URxvt.color15: #e1dddd	417	URxvt.color15: #e1dddd
570		418
571	=item How can I start @@RXVT_NAME@@d in a race-free way?	419	They have been described (not by me) as "pretty girly".
572		420
573	Despite it's name, @@RXVT_NAME@@d is not a real daemon, but more like a	421	=head3 Why do some characters look so much different than others?
574	server that answers @@RXVT_NAME@@c's requests, so it doesn't background
575	itself.
576		422
577	To ensure @@RXVT_NAME@@d is listening on it's socket, you can use the	423	See next entry.
578	following method to wait for the startup message before continuing:
579		424
580	{ @@RXVT_NAME@@d & } | read	425	=head3 How does rxvt-unicode choose fonts?
581		426
		427	Most fonts do not contain the full range of Unicode, which is
		428	fine. Chances are that the font you (or the admin/package maintainer of
		429	your system/os) have specified does not cover all the characters you want
		430	to display.
		431
		432	B<rxvt-unicode> makes a best-effort try at finding a replacement
		433	font. Often the result is fine, but sometimes the chosen font looks
		434	bad/ugly/wrong. Some fonts have totally strange characters that don't
		435	resemble the correct glyph at all, and rxvt-unicode lacks the artificial
		436	intelligence to detect that a specific glyph is wrong: it has to believe
		437	the font that the characters it claims to contain indeed look correct.
		438
		439	In that case, select a font of your taste and add it to the font list,
		440	e.g.:
		441
		442	@@URXVT_NAME@@ -fn basefont,font2,font3...
		443
		444	When rxvt-unicode sees a character, it will first look at the base
		445	font. If the base font does not contain the character, it will go to the
		446	next font, and so on. Specifying your own fonts will also speed up this
		447	search and use less resources within rxvt-unicode and the X-server.
		448
		449	The only limitation is that none of the fonts may be larger than the base
		450	font, as the base font defines the terminal character cell size, which
		451	must be the same due to the way terminals work.
		452
		453	=head3 Why do some chinese characters look so different than others?
		454
		455	This is because there is a difference between script and language --
		456	rxvt-unicode does not know which language the text that is output is,
		457	as it only knows the unicode character codes. If rxvt-unicode first
		458	sees a japanese/chinese character, it might choose a japanese font for
		459	display. Subsequent japanese characters will use that font. Now, many
		460	chinese characters aren't represented in japanese fonts, so when the first
		461	non-japanese character comes up, rxvt-unicode will look for a chinese font
		462	-- unfortunately at this point, it will still use the japanese font for
		463	chinese characters that are also in the japanese font.
		464
		465	The workaround is easy: just tag a chinese font at the end of your font
		466	list (see the previous question). The key is to view the font list as
		467	a preference list: If you expect more japanese, list a japanese font
		468	first. If you expect more chinese, put a chinese font first.
		469
		470	In the future it might be possible to switch language preferences at
		471	runtime (the internal data structure has no problem with using different
		472	fonts for the same character at the same time, but no interface for this
		473	has been designed yet).
		474
		475	Until then, you might get away with switching fonts at runtime (see L<Can
		476	I switch the fonts at runtime?> later in this document).
		477
		478	=head3 How can I make mplayer display video correctly?
		479
		480	We are working on it, in the meantime, as a workaround, use something like:
		481
		482	@@URXVT_NAME@@ -b 600 -geometry 20x1 -e sh -c 'mplayer -wid $WINDOWID file...'
		483
		484
		485	=head2 Keyboard, Mouse & User Interaction
		486
		487	=head3 The new selection selects pieces that are too big, how can I select single words?
		488
		489	If you want to select e.g. alphanumeric words, you can use the following
		490	setting:
		491
		492	URxvt.selection.pattern-0: ([[:word:]]+)
		493
		494	If you click more than twice, the selection will be extended
		495	more and more.
		496
		497	To get a selection that is very similar to the old code, try this pattern:
		498
		499	URxvt.selection.pattern-0: ([^"&'()*,;<=>?@[\\\\]^`{|})]+)
		500
		501	Please also note that the I<LeftClick Shift-LeftClick> combination also
		502	selects words like the old code.
		503
		504	=head3 I don't like the new selection/popups/hotkeys/perl, how do I change/disable it?
		505
		506	You can disable the perl extension completely by setting the
		507	B<perl-ext-common> resource to the empty string, which also keeps
		508	rxvt-unicode from initialising perl, saving memory.
		509
		510	If you only want to disable specific features, you first have to
		511	identify which perl extension is responsible. For this, read the section
		512	B<PREPACKAGED EXTENSIONS> in the @@URXVT_NAME@@perl(3) manpage. For
		513	example, to disable the B<selection-popup> and B<option-popup>, specify
		514	this B<perl-ext-common> resource:
		515
		516	URxvt.perl-ext-common: default,-selection-popup,-option-popup
		517
		518	This will keep the default extensions, but disable the two popup
		519	extensions. Some extensions can also be configured, for example,
		520	scrollback search mode is triggered by B<M-s>. You can move it to any
		521	other combination either by setting the B<searchable-scrollback> resource:
		522
		523	URxvt.searchable-scrollback: CM-s
		524
		525	=head3 The cursor moves when selecting text in the current input line, how do I switch this off?
		526
		527	See next entry.
		528
		529	=head3 During rlogin/ssh/telnet/etc. sessions, clicking near the cursor outputs strange escape sequences, how do I fix this?
		530
		531	These are caused by the C<readline> perl extension. Under normal
		532	circumstances, it will move your cursor around when you click into the
		533	line that contains it. It tries hard not to do this at the wrong moment,
		534	but when running a program that doesn't parse cursor movements or in some
		535	cases during rlogin sessions, it fails to detect this properly.
		536
		537	You can permanently switch this feature off by disabling the C<readline>
		538	extension:
		539
		540	URxvt.perl-ext-common: default,-readline
		541
		542	=head3 My numerical keypad acts weird and generates differing output?
		543
		544	Some Debian GNUL/Linux users seem to have this problem, although no
		545	specific details were reported so far. It is possible that this is caused
		546	by the wrong C<TERM> setting, although the details of whether and how
		547	this can happen are unknown, as C<TERM=rxvt> should offer a compatible
		548	keymap. See the answer to the previous question, and please report if that
		549	helped.
		550
		551	=head3 My Compose (Multi_key) key is no longer working.
		552
		553	The most common causes for this are that either your locale is not set
		554	correctly, or you specified a B<preeditStyle> that is not supported by
		555	your input method. For example, if you specified B<OverTheSpot> and
		556	your input method (e.g. the default input method handling Compose keys)
		557	does not support this (for instance because it is not visual), then
		558	rxvt-unicode will continue without an input method.
		559
		560	In this case either do not specify a B<preeditStyle> or specify more than
		561	one pre-edit style, such as B<OverTheSpot,Root,None>.
		562
		563	=head3 I cannot type C<Ctrl-Shift-2> to get an ASCII NUL character due to ISO 14755
		564
		565	Either try C<Ctrl-2> alone (it often is mapped to ASCII NUL even on
		566	international keyboards) or simply use ISO 14755 support to your
		567	advantage, typing <Ctrl-Shift-0> to get a ASCII NUL. This works for other
		568	codes, too, such as C<Ctrl-Shift-1-d> to type the default telnet escape
		569	character and so on.
		570
		571	=head3 Mouse cut/paste suddenly no longer works.
		572
		573	Make sure that mouse reporting is actually turned off since killing
		574	some editors prematurely may leave the mouse in mouse report mode. I've
		575	heard that tcsh may use mouse reporting unless it otherwise specified. A
		576	quick check is to see if cut/paste works when the Alt or Shift keys are
		577	depressed.
		578
582	=item What's with the strange Backspace/Delete key behaviour?	579	=head3 What's with the strange Backspace/Delete key behaviour?
583		580
584	Assuming that the physical Backspace key corresponds to the	581	Assuming that the physical Backspace key corresponds to the
585	BackSpace keysym (not likely for Linux ... see the following	582	Backspace keysym (not likely for Linux ... see the following
586	question) there are two standard values that can be used for	583	question) there are two standard values that can be used for
587	Backspace: C<^H> and C<^?>.	584	Backspace: C<^H> and C<^?>.
588		585
589	Historically, either value is correct, but rxvt-unicode adopts the debian	586	Historically, either value is correct, but rxvt-unicode adopts the debian
590	policy of using C<^?> when unsure, because it's the one only only correct	587	policy of using C<^?> when unsure, because it's the one and only correct
591	choice :).	588	choice :).
592		589
593	Rxvt-unicode tries to inherit the current stty settings and uses the value	590	Rxvt-unicode tries to inherit the current stty settings and uses the value
594	of `erase' to guess the value for backspace. If rxvt-unicode wasn't	591	of `erase' to guess the value for backspace. If rxvt-unicode wasn't
595	started from a terminal (say, from a menu or by remote shell), then the	592	started from a terminal (say, from a menu or by remote shell), then the
…		…
598		595
599	For starting a new rxvt-unicode:	596	For starting a new rxvt-unicode:
600		597
601	# use Backspace = ^H	598	# use Backspace = ^H
602	$ stty erase ^H	599	$ stty erase ^H
603	$ @@RXVT_NAME@@	600	$ @@URXVT_NAME@@
604		601
605	# use Backspace = ^?	602	# use Backspace = ^?
606	$ stty erase ^?	603	$ stty erase ^?
607	$ @@RXVT_NAME@@	604	$ @@URXVT_NAME@@
608		605
609	Toggle with C<ESC [ 36 h> / C<ESC [ 36 l> as documented in @@RXVT_NAME@@(7).	606	Toggle with C<ESC [ 36 h> / C<ESC [ 36 l>.
610		607
611	For an existing rxvt-unicode:	608	For an existing rxvt-unicode:
612		609
613	# use Backspace = ^H	610	# use Backspace = ^H
614	$ stty erase ^H	611	$ stty erase ^H
…		…
633	some editors (vim I'm told) expect Backspace = ^H,	630	some editors (vim I'm told) expect Backspace = ^H,
634	GNU Emacs (and Emacs-like editors) use ^H for help.	631	GNU Emacs (and Emacs-like editors) use ^H for help.
635		632
636	Perhaps someday this will all be resolved in a consistent manner.	633	Perhaps someday this will all be resolved in a consistent manner.
637		634
638	=item I don't like the key-bindings. How do I change them?	635	=head3 I don't like the key-bindings. How do I change them?
639		636
640	There are some compile-time selections available via configure. Unless	637	There are some compile-time selections available via configure. Unless
641	you have run "configure" with the C<--disable-resources> option you can	638	you have run "configure" with the C<--disable-resources> option you can
642	use the `keysym' resource to alter the keystrings associated with keysyms.	639	use the `keysym' resource to alter the keystrings associated with keysyms.
643		640
644	Here's an example for a URxvt session started using C<@@RXVT_NAME@@ -name URxvt>	641	Here's an example for a URxvt session started using C<@@URXVT_NAME@@ -name URxvt>
645		642
646	URxvt.keysym.Home: \033[1~	643	URxvt.keysym.Home: \033[1~
647	URxvt.keysym.End: \033[4~	644	URxvt.keysym.End: \033[4~
648	URxvt.keysym.C-apostrophe: \033<C-'>	645	URxvt.keysym.C-apostrophe: \033<C-'>
649	URxvt.keysym.C-slash: \033<C-/>	646	URxvt.keysym.C-slash: \033<C-/>
…		…
664	URxvt.keysym.M-C-a: list \033<M-C- abcdefghijklmnopqrstuvwxyz >	661	URxvt.keysym.M-C-a: list \033<M-C- abcdefghijklmnopqrstuvwxyz >
665	URxvt.keysym.F12: command:\033]701;zh_CN.GBK\007	662	URxvt.keysym.F12: command:\033]701;zh_CN.GBK\007
666		663
667	See some more examples in the documentation for the B<keysym> resource.	664	See some more examples in the documentation for the B<keysym> resource.
668		665
669	=item I'm using keyboard model XXX that has extra Prior/Next/Insert keys.	666	=head3 I'm using keyboard model XXX that has extra Prior/Next/Insert keys. How do I make use of them? For example, the Sun Keyboard type 4 has the following map
670	How do I make use of them? For example, the Sun Keyboard type 4
671	has the following mappings that rxvt-unicode doesn't recognize.
672		667
673	KP_Insert == Insert	668	KP_Insert == Insert
674	F22 == Print	669	F22 == Print
675	F27 == Home	670	F27 == Home
676	F29 == Prior	671	F29 == Prior
…		…
679		674
680	Rather than have rxvt-unicode try to accommodate all the various possible	675	Rather than have rxvt-unicode try to accommodate all the various possible
681	keyboard mappings, it is better to use `xmodmap' to remap the keys as	676	keyboard mappings, it is better to use `xmodmap' to remap the keys as
682	required for your particular machine.	677	required for your particular machine.
683		678
684	=item How do I distinguish wether I'm running rxvt-unicode or a regular xterm?
685	I need this to decide about setting colors etc.
686		679
687	rxvt and rxvt-unicode always export the variable "COLORTERM", so you can	680	=head2 Terminal Configuration
688	check and see if that is set. Note that several programs, JED, slrn,
689	Midnight Commander automatically check this variable to decide whether or
690	not to use color.
691		681
692	=item How do I set the correct, full IP address for the DISPLAY variable?	682	=head3 Can I see a typical configuration?
693		683
694	If you've compiled rxvt-unicode with DISPLAY_IS_IP and have enabled	684	The default configuration tries to be xterm-like, which I don't like that
695	insecure mode then it is possible to use the following shell script	685	much, but it's least surprise to regular users.
696	snippets to correctly set the display. If your version of rxvt-unicode
697	wasn't also compiled with ESCZ_ANSWER (as assumed in these snippets) then
698	the COLORTERM variable can be used to distinguish rxvt-unicode from a
699	regular xterm.
700		686
701	Courtesy of Chuck Blake <cblake@BBN.COM> with the following shell script	687	As a rxvt or rxvt-unicode user, you are practically supposed to invest
702	snippets:	688	time into customising your terminal. To get you started, here is the
		689	author's .Xdefaults entries, with comments on what they do. It's certainly
		690	not I<typical>, but what's typical...
703		691
704	# Bourne/Korn/POSIX family of shells:	692	URxvt.cutchars: "()*,<>[]{}|'
705	[ ${TERM:-foo} = foo ] && TERM=xterm # assume an xterm if we don't know	693	URxvt.print-pipe: cat >/tmp/xxx
706	if [ ${TERM:-foo} = xterm ]; then
707	stty -icanon -echo min 0 time 15 # see if enhanced rxvt or not
708	echo -n '^[Z'
709	read term_id
710	stty icanon echo
711	if [ ""${term_id} = '^[[?1;2C' -a ${DISPLAY:-foo} = foo ]; then
712	echo -n '^[[7n' # query the rxvt we are in for the DISPLAY string
713	read DISPLAY # set it in our local shell
714	fi
715	fi
716		694
717	=item How do I compile the manual pages for myself?	695	These are just for testing stuff.
718		696
719	You need to have a recent version of perl installed as F</usr/bin/perl>,	697	URxvt.imLocale: ja_JP.UTF-8
720	one that comes with F<pod2man>, F<pod2text> and F<pod2html>. Then go to	698	URxvt.preeditType: OnTheSpot,None
721	the doc subdirectory and enter C<make alldoc>.
722		699
723	=item My question isn't answered here, can I ask a human?	700	This tells rxvt-unicode to use a special locale when communicating with
		701	the X Input Method, and also tells it to only use the OnTheSpot pre-edit
		702	type, which requires the C<xim-onthespot> perl extension but rewards me
		703	with correct-looking fonts.
724		704
725	Before sending me mail, you could go to IRC: C<irc.freenode.net>,	705	URxvt.perl-lib: /root/lib/urxvt
726	channel C<#rxvt-unicode> has some rxvt-unicode enthusiasts that might be	706	URxvt.perl-ext-common: default,selection-autotransform,selection-pastebin,xim-onthespot,remote-clipboard
727	interested in learning about new and exciting problems (but not FAQs :).	707	URxvt.selection.pattern-0: ( at .*? line \\d+)
		708	URxvt.selection.pattern-1: ^(/[^:]+):\
		709	URxvt.selection-autotransform.0: s/^([^:[:space:]]+):(\\d+):?$/:e \\Q$1\\E\\x0d:$2\\x0d/
		710	URxvt.selection-autotransform.1: s/^ at (.*?) line (\\d+)$/:e \\Q$1\\E\\x0d:$2\\x0d/
		711
		712	This is my perl configuration. The first two set the perl library
		713	directory and also tells urxvt to use a large number of extensions. I
		714	develop for myself mostly, so I actually use most of the extensions I
		715	write.
		716
		717	The selection stuff mainly makes the selection perl-error-message aware
		718	and tells it to convert perl error messages into vi-commands to load the
		719	relevant file and go tot he error line number.
		720
		721	URxvt.scrollstyle: plain
		722	URxvt.secondaryScroll: true
		723
		724	As the documentation says: plain is the preferred scrollbar for the
		725	author. The C<secondaryScroll> configures urxvt to scroll in full-screen
		726	apps, like screen, so lines scrolled out of screen end up in urxvt's
		727	scrollback buffer.
		728
		729	URxvt.background: #000000
		730	URxvt.foreground: gray90
		731	URxvt.color7: gray90
		732	URxvt.colorBD: #ffffff
		733	URxvt.cursorColor: #e0e080
		734	URxvt.throughColor: #8080f0
		735	URxvt.highlightColor: #f0f0f0
		736
		737	Some colours. Not sure which ones are being used or even non-defaults, but
		738	these are in my .Xdefaults. Most notably, they set foreground/background
		739	to light gray/black, and also make sure that the colour 7 matches the
		740	default foreground colour.
		741
		742	URxvt.underlineColor: yellow
		743
		744	Another colour, makes underline lines look different. Sometimes hurts, but
		745	is mostly a nice effect.
		746
		747	URxvt.geometry: 154x36
		748	URxvt.loginShell: false
		749	URxvt.meta: ignore
		750	URxvt.utmpInhibit: true
		751
		752	Uh, well, should be mostly self-explanatory. By specifying some defaults
		753	manually, I can quickly switch them for testing.
		754
		755	URxvt.saveLines: 8192
		756
		757	A large scrollback buffer is essential. Really.
		758
		759	URxvt.mapAlert: true
		760
		761	The only case I use it is for my IRC window, which I like to keep
		762	iconified till people msg me (which beeps).
		763
		764	URxvt.visualBell: true
		765
		766	The audible bell is often annoying, especially when in a crowd.
		767
		768	URxvt.insecure: true
		769
		770	Please don't hack my mutt! Ooops...
		771
		772	URxvt.pastableTabs: false
		773
		774	I once thought this is a great idea.
		775
		776	urxvt.font: 9x15bold,\
		777	-misc-fixed-bold-r-normal--15-140-75-75-c-90-iso10646-1,\
		778	-misc-fixed-medium-r-normal--15-140-75-75-c-90-iso10646-1, \
		779	[codeset=JISX0208]xft:Kochi Gothic, \
		780	xft:Bitstream Vera Sans Mono:autohint=true, \
		781	xft:Code2000:antialias=false
		782	urxvt.boldFont: -xos4-terminus-bold-r-normal--14-140-72-72-c-80-iso8859-15
		783	urxvt.italicFont: xft:Bitstream Vera Sans Mono:italic:autohint=true
		784	urxvt.boldItalicFont: xft:Bitstream Vera Sans Mono:bold:italic:autohint=true
		785
		786	I wrote rxvt-unicode to be able to specify fonts exactly. So don't be
		787	overwhelmed. A special note: the C<9x15bold> mentioned above is actually
		788	the version from XFree-3.3, as XFree-4 replaced it by a totally different
		789	font (different glyphs for C<;> and many other harmless characters),
		790	while the second font is actually the C<9x15bold> from XFree4/XOrg. The
		791	bold version has less chars than the medium version, so I use it for rare
		792	characters, too. When editing sources with vim, I use italic for comments
		793	and other stuff, which looks quite good with Bitstream Vera anti-aliased.
		794
		795	Terminus is a quite bad font (many very wrong glyphs), but for most of my
		796	purposes, it works, and gives a different look, as my normal (Non-bold)
		797	font is already bold, and I want to see a difference between bold and
		798	normal fonts.
		799
		800	Please note that I used the C<urxvt> instance name and not the C<URxvt>
		801	class name. Thats because I use different configs for different purposes,
		802	for example, my IRC window is started with C<-name IRC>, and uses these
		803	defaults:
		804
		805	IRC*title: IRC
		806	IRC*geometry: 87x12+535+542
		807	IRC*saveLines: 0
		808	IRC*mapAlert: true
		809	IRC*font: suxuseuro
		810	IRC*boldFont: suxuseuro
		811	IRC*colorBD: white
		812	IRC*keysym.M-C-1: command:\033]710;suxuseuro\007\033]711;suxuseuro\007
		813	IRC*keysym.M-C-2: command:\033]710;9x15bold\007\033]711;9x15bold\007
		814
		815	C<Alt-Ctrl-1> and C<Alt-Ctrl-2> switch between two different font
		816	sizes. C<suxuseuro> allows me to keep an eye (and actually read)
		817	stuff while keeping a very small window. If somebody pastes something
		818	complicated (e.g. japanese), I temporarily switch to a larger font.
		819
		820	The above is all in my C<.Xdefaults> (I don't use C<.Xresources> nor
		821	C<xrdb>). I also have some resources in a separate C<.Xdefaults-hostname>
		822	file for different hosts, for example, on ym main desktop, I use:
		823
		824	URxvt.keysym.C-M-q: command:\033[3;5;5t
		825	URxvt.keysym.C-M-y: command:\033[3;5;606t
		826	URxvt.keysym.C-M-e: command:\033[3;1605;5t
		827	URxvt.keysym.C-M-c: command:\033[3;1605;606t
		828	URxvt.keysym.C-M-p: perl:test
		829
		830	The first for keysym definitions allow me to quickly bring some windows
		831	in the layout I like most. Ion users might start laughing but will stop
		832	immediately when I tell them that I use my own Fvwm2 module for much the
		833	same effect as Ion provides, and I only very rarely use the above key
		834	combinations :->
		835
		836	=head3 Why doesn't rxvt-unicode read my resources?
		837
		838	Well, why, indeed? It does, in a way very similar to other X
		839	applications. Most importantly, this means that if you or your OS loads
		840	resources into the X display (the right way to do it), rxvt-unicode will
		841	ignore any resource files in your home directory. It will only read
		842	F<$HOME/.Xdefaults> when no resources are attached to the display.
		843
		844	If you have or use an F<$HOME/.Xresources> file, chances are that
		845	resources are loaded into your X-server. In this case, you have to
		846	re-login after every change (or run F<xrdb -merge $HOME/.Xresources>).
		847
		848	Also consider the form resources have to use:
		849
		850	URxvt.resource: value
		851
		852	If you want to use another form (there are lots of different ways of
		853	specifying resources), make sure you understand whether and why it
		854	works. If unsure, use the form above.
		855
		856	=head3 When I log-in to another system it tells me about missing terminfo data?
		857
		858	The terminal description used by rxvt-unicode is not as widely available
		859	as that for xterm, or even rxvt (for which the same problem often arises).
		860
		861	The correct solution for this problem is to install the terminfo, this can
		862	be done like this (with ncurses' infocmp and works as user and admin):
		863
		864	REMOTE=remotesystem.domain
		865	infocmp rxvt-unicode | ssh $REMOTE "mkdir -p .terminfo && cat >/tmp/ti && tic /tmp/ti"
		866
		867	... or by installing rxvt-unicode normally on the remote system,
		868
		869	One some systems you might need to set C<$TERMINFO> to the full path of
		870	F<$HOME/.terminfo> for this to work.
		871
		872	If you cannot or do not want to do this, then you can simply set
		873	C<TERM=rxvt> or even C<TERM=xterm>, and live with the small number of
		874	problems arising, which includes wrong keymapping, less and different
		875	colours and some refresh errors in fullscreen applications. It's a nice
		876	quick-and-dirty workaround for rare cases, though.
		877
		878	If you always want to do this (and are fine with the consequences) you
		879	can either recompile rxvt-unicode with the desired TERM value or use a
		880	resource to set it:
		881
		882	URxvt.termName: rxvt
		883
		884	If you don't plan to use B<rxvt> (quite common...) you could also replace
		885	the rxvt terminfo file with the rxvt-unicode one and use C<TERM=rxvt>.
		886
		887	=head3 C<tic> outputs some error when compiling the terminfo entry.
		888
		889	Most likely it's the empty definition for C<enacs=>. Just replace it by
		890	C<enacs=\E[0@> and try again.
		891
		892	=head3 C<bash>'s readline does not work correctly under @@URXVT_NAME@@.
		893
		894	See next entry.
		895
		896	=head3 I need a termcap file entry.
		897
		898	One reason you might want this is that some distributions or operating
		899	systems still compile some programs using the long-obsoleted termcap
		900	library (Fedora Core's bash is one example) and rely on a termcap entry
		901	for C<rxvt-unicode>.
		902
		903	You could use rxvt's termcap entry with reasonable results in many cases.
		904	You can also create a termcap entry by using terminfo's infocmp program
		905	like this:
		906
		907	infocmp -C rxvt-unicode
		908
		909	Or you could use the termcap entry in doc/etc/rxvt-unicode.termcap,
		910	generated by the command above.
		911
		912	=head3 Why does C<ls> no longer have coloured output?
		913
		914	The C<ls> in the GNU coreutils unfortunately doesn't use terminfo to
		915	decide whether a terminal has colour, but uses its own configuration
		916	file. Needless to say, C<rxvt-unicode> is not in its default file (among
		917	with most other terminals supporting colour). Either add:
		918
		919	TERM rxvt-unicode
		920
		921	to C</etc/DIR_COLORS> or simply add:
		922
		923	alias ls='ls --color=auto'
		924
		925	to your C<.profile> or C<.bashrc>.
		926
		927	=head3 Why doesn't vim/emacs etc. use the 88 colour mode?
		928
		929	See next entry.
		930
		931	=head3 Why doesn't vim/emacs etc. make use of italic?
		932
		933	See next entry.
		934
		935	=head3 Why are the secondary screen-related options not working properly?
		936
		937	Make sure you are using C<TERM=rxvt-unicode>. Some pre-packaged
		938	distributions (most notably Debian GNU/Linux) break rxvt-unicode
		939	by setting C<TERM> to C<rxvt>, which doesn't have these extra
		940	features. Unfortunately, some of these (most notably, again, Debian
		941	GNU/Linux) furthermore fail to even install the C<rxvt-unicode> terminfo
		942	file, so you will need to install it on your own (See the question B<When
		943	I log-in to another system it tells me about missing terminfo data?> on
		944	how to do this).
		945
		946
		947	=head2 Encoding / Locale / Input Method Issues
		948
		949	=head3 Rxvt-unicode does not seem to understand the selected encoding?
		950
		951	See next entry.
		952
		953	=head3 Unicode does not seem to work?
		954
		955	If you encounter strange problems like typing an accented character but
		956	getting two unrelated other characters or similar, or if program output is
		957	subtly garbled, then you should check your locale settings.
		958
		959	Rxvt-unicode must be started with the same C<LC_CTYPE> setting as the
		960	programs running in it. Often rxvt-unicode is started in the C<C> locale,
		961	while the login script running within the rxvt-unicode window changes the
		962	locale to something else, e.g. C<en_GB.UTF-8>. Needless to say, this is
		963	not going to work, and is the most common cause for problems.
		964
		965	The best thing is to fix your startup environment, as you will likely run
		966	into other problems. If nothing works you can try this in your .profile.
		967
		968	printf '\33]701;%s\007' "$LC_CTYPE" # $LANG or $LC_ALL are worth a try, too
		969
		970	If this doesn't work, then maybe you use a C<LC_CTYPE> specification not
		971	supported on your systems. Some systems have a C<locale> command which
		972	displays this (also, C<perl -e0> can be used to check locale settings, as
		973	it will complain loudly if it cannot set the locale). If it displays something
		974	like:
		975
		976	locale: Cannot set LC_CTYPE to default locale: ...
		977
		978	Then the locale you specified is not supported on your system.
		979
		980	If nothing works and you are sure that everything is set correctly then
		981	you will need to remember a little known fact: Some programs just don't
		982	support locales :(
		983
		984	=head3 How does rxvt-unicode determine the encoding to use?
		985
		986	See next entry.
		987
		988	=head3 Is there an option to switch encodings?
		989
		990	Unlike some other terminals, rxvt-unicode has no encoding switch, and no
		991	specific "utf-8" mode, such as xterm. In fact, it doesn't even know about
		992	UTF-8 or any other encodings with respect to terminal I/O.
		993
		994	The reasons is that there exists a perfectly fine mechanism for selecting
		995	the encoding, doing I/O and (most important) communicating this to all
		996	applications so everybody agrees on character properties such as width
		997	and code number. This mechanism is the I<locale>. Applications not using
		998	that info will have problems (for example, C<xterm> gets the width of
		999	characters wrong as it uses its own, locale-independent table under all
		1000	locales).
		1001
		1002	Rxvt-unicode uses the C<LC_CTYPE> locale category to select encoding. All
		1003	programs doing the same (that is, most) will automatically agree in the
		1004	interpretation of characters.
		1005
		1006	Unfortunately, there is no system-independent way to select locales, nor
		1007	is there a standard on how locale specifiers will look like.
		1008
		1009	On most systems, the content of the C<LC_CTYPE> environment variable
		1010	contains an arbitrary string which corresponds to an already-installed
		1011	locale. Common names for locales are C<en_US.UTF-8>, C<de_DE.ISO-8859-15>,
		1012	C<ja_JP.EUC-JP>, i.e. C<language_country.encoding>, but other forms
		1013	(i.e. C<de> or C<german>) are also common.
		1014
		1015	Rxvt-unicode ignores all other locale categories, and except for
		1016	the encoding, ignores country or language-specific settings,
		1017	i.e. C<de_DE.UTF-8> and C<ja_JP.UTF-8> are the normally same to
		1018	rxvt-unicode.
		1019
		1020	If you want to use a specific encoding you have to make sure you start
		1021	rxvt-unicode with the correct C<LC_CTYPE> category.
		1022
		1023	=head3 Can I switch locales at runtime?
		1024
		1025	Yes, using an escape sequence. Try something like this, which sets
		1026	rxvt-unicode's idea of C<LC_CTYPE>.
		1027
		1028	printf '\33]701;%s\007' ja_JP.SJIS
		1029
		1030	See also the previous answer.
		1031
		1032	Sometimes this capability is rather handy when you want to work in
		1033	one locale (e.g. C<de_DE.UTF-8>) but some programs don't support it
		1034	(e.g. UTF-8). For example, I use this script to start C<xjdic>, which
		1035	first switches to a locale supported by xjdic and back later:
		1036
		1037	printf '\33]701;%s\007' ja_JP.SJIS
		1038	xjdic -js
		1039	printf '\33]701;%s\007' de_DE.UTF-8
		1040
		1041	You can also use xterm's C<luit> program, which usually works fine, except
		1042	for some locales where character width differs between program- and
		1043	rxvt-unicode-locales.
		1044
		1045	=head3 I have problems getting my input method working.
		1046
		1047	Try a search engine, as this is slightly different for every input method server.
		1048
		1049	Here is a checklist:
		1050
		1051	=over 4
		1052
		1053	=item - Make sure your locale I<and> the imLocale are supported on your OS.
		1054
		1055	Try C<locale -a> or check the documentation for your OS.
		1056
		1057	=item - Make sure your locale or imLocale matches a locale supported by your XIM.
		1058
		1059	For example, B<kinput2> does not support UTF-8 locales, you should use
		1060	C<ja_JP.EUC-JP> or equivalent.
		1061
		1062	=item - Make sure your XIM server is actually running.
		1063
		1064	=item - Make sure the C<XMODIFIERS> environment variable is set correctly when I<starting> rxvt-unicode.
		1065
		1066	When you want to use e.g. B<kinput2>, it must be set to
		1067	C<@im=kinput2>. For B<scim>, use C<@im=SCIM>. You can see what input
		1068	method servers are running with this command:
		1069
		1070	xprop -root XIM_SERVERS
		1071
		1072	=item
728		1073
729	=back	1074	=back
730		1075
		1076	=head3 My input method wants <some encoding> but I want UTF-8, what can I do?
		1077
		1078	You can specify separate locales for the input method and the rest of the
		1079	terminal, using the resource C<imlocale>:
		1080
		1081	URxvt.imlocale: ja_JP.EUC-JP
		1082
		1083	Now you can start your terminal with C<LC_CTYPE=ja_JP.UTF-8> and still
		1084	use your input method. Please note, however, that, depending on your Xlib
		1085	version, you may not be able to input characters outside C<EUC-JP> in a
		1086	normal way then, as your input method limits you.
		1087
		1088	=head3 Rxvt-unicode crashes when the X Input Method changes or exits.
		1089
		1090	Unfortunately, this is unavoidable, as the XIM protocol is racy by
		1091	design. Applications can avoid some crashes at the expense of memory
		1092	leaks, and Input Methods can avoid some crashes by careful ordering at
		1093	exit time. B<kinput2> (and derived input methods) generally succeeds,
		1094	while B<SCIM> (or similar input methods) fails. In the end, however,
		1095	crashes cannot be completely avoided even if both sides cooperate.
		1096
		1097	So the only workaround is not to kill your Input Method Servers.
		1098
		1099
		1100	=head2 Operating Systems / Package Maintaining
		1101
		1102	=head3 I am using Debian GNU/Linux and have a problem...
		1103
		1104	The Debian GNU/Linux package of rxvt-unicode in sarge contains large
		1105	patches that considerably change the behaviour of rxvt-unicode (but
		1106	unfortunately this notice has been removed). Before reporting a bug to
		1107	the original rxvt-unicode author please download and install the genuine
		1108	version (L<http://software.schmorp.de#rxvt-unicode>) and try to reproduce
		1109	the problem. If you cannot, chances are that the problems are specific to
		1110	Debian GNU/Linux, in which case it should be reported via the Debian Bug
		1111	Tracking System (use C<reportbug> to report the bug).
		1112
		1113	For other problems that also affect the Debian package, you can and
		1114	probably should use the Debian BTS, too, because, after all, it's also a
		1115	bug in the Debian version and it serves as a reminder for other users that
		1116	might encounter the same issue.
		1117
		1118	=head3 I am maintaining rxvt-unicode for distribution/OS XXX, any recommendation?
		1119
		1120	You should build one binary with the default options. F<configure>
		1121	now enables most useful options, and the trend goes to making them
		1122	runtime-switchable, too, so there is usually no drawback to enabling them,
		1123	except higher disk and possibly memory usage. The perl interpreter should
		1124	be enabled, as important functionality (menus, selection, likely more in
		1125	the future) depends on it.
		1126
		1127	You should not overwrite the C<perl-ext-common> snd C<perl-ext> resources
		1128	system-wide (except maybe with C<defaults>). This will result in useful
		1129	behaviour. If your distribution aims at low memory, add an empty
		1130	C<perl-ext-common> resource to the app-defaults file. This will keep the
		1131	perl interpreter disabled until the user enables it.
		1132
		1133	If you can/want build more binaries, I recommend building a minimal
		1134	one with C<--disable-everything> (very useful) and a maximal one with
		1135	C<--enable-everything> (less useful, it will be very big due to a lot of
		1136	encodings built-in that increase download times and are rarely used).
		1137
		1138	=head3 I need to make it setuid/setgid to support utmp/ptys on my OS, is this safe?
		1139
		1140	It should be, starting with release 7.1. You are encouraged to properly
		1141	install urxvt with privileges necessary for your OS now.
		1142
		1143	When rxvt-unicode detects that it runs setuid or setgid, it will fork
		1144	into a helper process for privileged operations (pty handling on some
		1145	systems, utmp/wtmp/lastlog handling on others) and drop privileges
		1146	immediately. This is much safer than most other terminals that keep
		1147	privileges while running (but is more relevant to urxvt, as it contains
		1148	things as perl interpreters, which might be "helpful" to attackers).
		1149
		1150	This forking is done as the very first within main(), which is very early
		1151	and reduces possible bugs to initialisation code run before main(), or
		1152	things like the dynamic loader of your system, which should result in very
		1153	little risk.
		1154
		1155	=head3 I am on FreeBSD and rxvt-unicode does not seem to work at all.
		1156
		1157	Rxvt-unicode requires the symbol C<__STDC_ISO_10646__> to be defined
		1158	in your compile environment, or an implementation that implements it,
		1159	whether it defines the symbol or not. C<__STDC_ISO_10646__> requires that
		1160	B<wchar_t> is represented as unicode.
		1161
		1162	As you might have guessed, FreeBSD does neither define this symbol nor
		1163	does it support it. Instead, it uses its own internal representation of
		1164	B<wchar_t>. This is, of course, completely fine with respect to standards.
		1165
		1166	However, that means rxvt-unicode only works in C<POSIX>, C<ISO-8859-1> and
		1167	C<UTF-8> locales under FreeBSD (which all use Unicode as B<wchar_t>).
		1168
		1169	C<__STDC_ISO_10646__> is the only sane way to support multi-language
		1170	apps in an OS, as using a locale-dependent (and non-standardized)
		1171	representation of B<wchar_t> makes it impossible to convert between
		1172	B<wchar_t> (as used by X11 and your applications) and any other encoding
		1173	without implementing OS-specific-wrappers for each and every locale. There
		1174	simply are no APIs to convert B<wchar_t> into anything except the current
		1175	locale encoding.
		1176
		1177	Some applications (such as the formidable B<mlterm>) work around this
		1178	by carrying their own replacement functions for character set handling
		1179	with them, and either implementing OS-dependent hacks or doing multiple
		1180	conversions (which is slow and unreliable in case the OS implements
		1181	encodings slightly different than the terminal emulator).
		1182
		1183	The rxvt-unicode author insists that the right way to fix this is in the
		1184	system libraries once and for all, instead of forcing every app to carry
		1185	complete replacements for them :)
		1186
		1187	=head3 How can I use rxvt-unicode under cygwin?
		1188
		1189	rxvt-unicode should compile and run out of the box on cygwin, using
		1190	the X11 libraries that come with cygwin. libW11 emulation is no
		1191	longer supported (and makes no sense, either, as it only supported a
		1192	single font). I recommend starting the X-server in C<-multiwindow> or
		1193	C<-rootless> mode instead, which will result in similar look&feel as the
		1194	old libW11 emulation.
		1195
		1196	At the time of this writing, cygwin didn't seem to support any multi-byte
		1197	encodings (you might try C<LC_CTYPE=C-UTF-8>), so you are likely limited
		1198	to 8-bit encodings.
		1199
		1200	=head3 Character widths are not correct.
		1201
		1202	urxvt uses the system wcwidth function to know the information about
		1203	the width of characters, so on systems with incorrect locale data you
		1204	will likely get bad results. Two notorious examples are Solaris 9,
		1205	where single-width characters like U+2514 are reported as double-width,
		1206	and Darwin 8, where combining chars are reported having width 1.
		1207
		1208	The solution is to upgrade your system or switch to a better one. A
		1209	possibly working workaround is to use a wcwidth implementation like
		1210
		1211	http://www.cl.cam.ac.uk/~mgk25/ucs/wcwidth.c
		1212
731	=head1 RXVT TECHNICAL REFERENCE	1213	=head1 RXVT-UNICODE TECHNICAL REFERENCE
732
733	=head1 DESCRIPTION
734		1214
735	The rest of this document describes various technical aspects of	1215	The rest of this document describes various technical aspects of
736	B<rxvt-unicode>. First the description of supported command sequences,	1216	B<rxvt-unicode>. First the description of supported command sequences,
737	followed by menu and pixmap support and last by a description of all	1217	followed by pixmap support and last by a description of all features
738	features selectable at C<configure> time.	1218	selectable at C<configure> time.
739		1219
740	=head1 Definitions	1220	=head2 Definitions
741		1221
742	=over 4	1222	=over 4
743		1223
744	=item B<< C<c> >>	1224	=item B<< C<c> >>
745		1225
…		…
763		1243
764	A text parameter composed of printable characters.	1244	A text parameter composed of printable characters.
765		1245
766	=back	1246	=back
767		1247
768	=head1 Values	1248	=head2 Values
769		1249
770	=over 4	1250	=over 4
771		1251
772	=item B<< C<ENQ> >>	1252	=item B<< C<ENQ> >>
773		1253
…		…
816		1296
817	Space Character	1297	Space Character
818		1298
819	=back	1299	=back
820		1300
821	=head1 Escape Sequences	1301	=head2 Escape Sequences
822		1302
823	=over 4	1303	=over 4
824		1304
825	=item B<< C<ESC # 8> >>	1305	=item B<< C<ESC # 8> >>
826		1306
…		…
924		1404
925	=back	1405	=back
926		1406
927	X<CSI>	1407	X<CSI>
928		1408
929	=head1 CSI (Command Sequence Introducer) Sequences	1409	=head2 CSI (Command Sequence Introducer) Sequences
930		1410
931	=over 4	1411	=over 4
932		1412
933	=item B<< C<ESC [ Ps @> >>	1413	=item B<< C<ESC [ Ps @> >>
934		1414
…		…
989	=begin table	1469	=begin table
990		1470
991	B<< C<Ps = 0> >> Clear to Right (default)	1471	B<< C<Ps = 0> >> Clear to Right (default)
992	B<< C<Ps = 1> >> Clear to Left	1472	B<< C<Ps = 1> >> Clear to Left
993	B<< C<Ps = 2> >> Clear All	1473	B<< C<Ps = 2> >> Clear All
		1474	B<< C<Ps = 3> >> Like Ps = 0, but is ignored when wrapped
		1475	(@@RXVT_NAME@@ extension)
994		1476
995	=end table	1477	=end table
996		1478
997	=item B<< C<ESC [ Ps L> >>	1479	=item B<< C<ESC [ Ps L> >>
998		1480
…		…
1204		1686
1205	=back	1687	=back
1206		1688
1207	X<PrivateModes>	1689	X<PrivateModes>
1208		1690
1209	=head1 DEC Private Modes	1691	=head2 DEC Private Modes
1210		1692
1211	=over 4	1693	=over 4
1212		1694
1213	=item B<< C<ESC [ ? Pm h> >>	1695	=item B<< C<ESC [ ? Pm h> >>
1214		1696
…		…
1230		1712
1231	Toggle DEC Private Mode Values (rxvt extension). I<where>	1713	Toggle DEC Private Mode Values (rxvt extension). I<where>
1232		1714
1233	=over 4	1715	=over 4
1234		1716
1235	=item B<< C<Ps = 1> >> (DECCKM)	1717	=item B<< C<Pm = 1> >> (DECCKM)
1236		1718
1237	=begin table	1719	=begin table
1238		1720
1239	B<< C<h> >> Application Cursor Keys	1721	B<< C<h> >> Application Cursor Keys
1240	B<< C<l> >> Normal Cursor Keys	1722	B<< C<l> >> Normal Cursor Keys
1241		1723
1242	=end table	1724	=end table
1243		1725
1244	=item B<< C<Ps = 2> >> (ANSI/VT52 mode)	1726	=item B<< C<Pm = 2> >> (ANSI/VT52 mode)
1245		1727
1246	=begin table	1728	=begin table
1247		1729
1248	B<< C<h> >> Enter VT52 mode	1730	B<< C<h> >> Enter VT52 mode
1249	B<< C<l> >> Enter VT52 mode	1731	B<< C<l> >> Enter VT52 mode
1250		1732
1251	=end table	1733	=end table
1252		1734
1253	=item B<< C<Ps = 3> >>	1735	=item B<< C<Pm = 3> >>
1254		1736
1255	=begin table	1737	=begin table
1256		1738
1257	B<< C<h> >> 132 Column Mode (DECCOLM)	1739	B<< C<h> >> 132 Column Mode (DECCOLM)
1258	B<< C<l> >> 80 Column Mode (DECCOLM)	1740	B<< C<l> >> 80 Column Mode (DECCOLM)
1259		1741
1260	=end table	1742	=end table
1261		1743
1262	=item B<< C<Ps = 4> >>	1744	=item B<< C<Pm = 4> >>
1263		1745
1264	=begin table	1746	=begin table
1265		1747
1266	B<< C<h> >> Smooth (Slow) Scroll (DECSCLM)	1748	B<< C<h> >> Smooth (Slow) Scroll (DECSCLM)
1267	B<< C<l> >> Jump (Fast) Scroll (DECSCLM)	1749	B<< C<l> >> Jump (Fast) Scroll (DECSCLM)
1268		1750
1269	=end table	1751	=end table
1270		1752
1271	=item B<< C<Ps = 5> >>	1753	=item B<< C<Pm = 5> >>
1272		1754
1273	=begin table	1755	=begin table
1274		1756
1275	B<< C<h> >> Reverse Video (DECSCNM)	1757	B<< C<h> >> Reverse Video (DECSCNM)
1276	B<< C<l> >> Normal Video (DECSCNM)	1758	B<< C<l> >> Normal Video (DECSCNM)
1277		1759
1278	=end table	1760	=end table
1279		1761
1280	=item B<< C<Ps = 6> >>	1762	=item B<< C<Pm = 6> >>
1281		1763
1282	=begin table	1764	=begin table
1283		1765
1284	B<< C<h> >> Origin Mode (DECOM)	1766	B<< C<h> >> Origin Mode (DECOM)
1285	B<< C<l> >> Normal Cursor Mode (DECOM)	1767	B<< C<l> >> Normal Cursor Mode (DECOM)
1286		1768
1287	=end table	1769	=end table
1288		1770
1289	=item B<< C<Ps = 7> >>	1771	=item B<< C<Pm = 7> >>
1290		1772
1291	=begin table	1773	=begin table
1292		1774
1293	B<< C<h> >> Wraparound Mode (DECAWM)	1775	B<< C<h> >> Wraparound Mode (DECAWM)
1294	B<< C<l> >> No Wraparound Mode (DECAWM)	1776	B<< C<l> >> No Wraparound Mode (DECAWM)
1295		1777
1296	=end table	1778	=end table
1297		1779
1298	=item B<< C<Ps = 8> >> I<unimplemented>	1780	=item B<< C<Pm = 8> >> I<unimplemented>
1299		1781
1300	=begin table	1782	=begin table
1301		1783
1302	B<< C<h> >> Auto-repeat Keys (DECARM)	1784	B<< C<h> >> Auto-repeat Keys (DECARM)
1303	B<< C<l> >> No Auto-repeat Keys (DECARM)	1785	B<< C<l> >> No Auto-repeat Keys (DECARM)
1304		1786
1305	=end table	1787	=end table
1306		1788
1307	=item B<< C<Ps = 9> >> X10 XTerm	1789	=item B<< C<Pm = 9> >> X10 XTerm
1308		1790
1309	=begin table	1791	=begin table
1310		1792
1311	B<< C<h> >> Send Mouse X & Y on button press.	1793	B<< C<h> >> Send Mouse X & Y on button press.
1312	B<< C<l> >> No mouse reporting.	1794	B<< C<l> >> No mouse reporting.
1313		1795
1314	=end table	1796	=end table
1315		1797
1316	=item B<< C<Ps = 10> >> (B<rxvt>)
1317
1318	=begin table
1319
1320	B<< C<h> >> menuBar visible
1321	B<< C<l> >> menuBar invisible
1322
1323	=end table
1324
1325	=item B<< C<Ps = 25> >>	1798	=item B<< C<Pm = 25> >>
1326		1799
1327	=begin table	1800	=begin table
1328		1801
1329	B<< C<h> >> Visible cursor {cnorm/cvvis}	1802	B<< C<h> >> Visible cursor {cnorm/cvvis}
1330	B<< C<l> >> Invisible cursor {civis}	1803	B<< C<l> >> Invisible cursor {civis}
1331		1804
1332	=end table	1805	=end table
1333		1806
1334	=item B<< C<Ps = 30> >>	1807	=item B<< C<Pm = 30> >>
1335		1808
1336	=begin table	1809	=begin table
1337		1810
1338	B<< C<h> >> scrollBar visisble	1811	B<< C<h> >> scrollBar visible
1339	B<< C<l> >> scrollBar invisisble	1812	B<< C<l> >> scrollBar invisible
1340		1813
1341	=end table	1814	=end table
1342		1815
1343	=item B<< C<Ps = 35> >> (B<rxvt>)	1816	=item B<< C<Pm = 35> >> (B<rxvt>)
1344		1817
1345	=begin table	1818	=begin table
1346		1819
1347	B<< C<h> >> Allow XTerm Shift+key sequences	1820	B<< C<h> >> Allow XTerm Shift+key sequences
1348	B<< C<l> >> Disallow XTerm Shift+key sequences	1821	B<< C<l> >> Disallow XTerm Shift+key sequences
1349		1822
1350	=end table	1823	=end table
1351		1824
1352	=item B<< C<Ps = 38> >> I<unimplemented>	1825	=item B<< C<Pm = 38> >> I<unimplemented>
1353		1826
1354	Enter Tektronix Mode (DECTEK)	1827	Enter Tektronix Mode (DECTEK)
1355		1828
1356	=item B<< C<Ps = 40> >>	1829	=item B<< C<Pm = 40> >>
1357		1830
1358	=begin table	1831	=begin table
1359		1832
1360	B<< C<h> >> Allow 80/132 Mode	1833	B<< C<h> >> Allow 80/132 Mode
1361	B<< C<l> >> Disallow 80/132 Mode	1834	B<< C<l> >> Disallow 80/132 Mode
1362		1835
1363	=end table	1836	=end table
1364		1837
1365	=item B<< C<Ps = 44> >> I<unimplemented>	1838	=item B<< C<Pm = 44> >> I<unimplemented>
1366		1839
1367	=begin table	1840	=begin table
1368		1841
1369	B<< C<h> >> Turn On Margin Bell	1842	B<< C<h> >> Turn On Margin Bell
1370	B<< C<l> >> Turn Off Margin Bell	1843	B<< C<l> >> Turn Off Margin Bell
1371		1844
1372	=end table	1845	=end table
1373		1846
1374	=item B<< C<Ps = 45> >> I<unimplemented>	1847	=item B<< C<Pm = 45> >> I<unimplemented>
1375		1848
1376	=begin table	1849	=begin table
1377		1850
1378	B<< C<h> >> Reverse-wraparound Mode	1851	B<< C<h> >> Reverse-wraparound Mode
1379	B<< C<l> >> No Reverse-wraparound Mode	1852	B<< C<l> >> No Reverse-wraparound Mode
1380		1853
1381	=end table	1854	=end table
1382		1855
1383	=item B<< C<Ps = 46> >> I<unimplemented>	1856	=item B<< C<Pm = 46> >> I<unimplemented>
1384		1857
1385	=item B<< C<Ps = 47> >>	1858	=item B<< C<Pm = 47> >>
1386		1859
1387	=begin table	1860	=begin table
1388		1861
1389	B<< C<h> >> Use Alternate Screen Buffer	1862	B<< C<h> >> Use Alternate Screen Buffer
1390	B<< C<l> >> Use Normal Screen Buffer	1863	B<< C<l> >> Use Normal Screen Buffer
1391		1864
1392	=end table	1865	=end table
1393		1866
1394	X<Priv66>	1867	X<Priv66>
1395		1868
1396	=item B<< C<Ps = 66> >>	1869	=item B<< C<Pm = 66> >>
1397		1870
1398	=begin table	1871	=begin table
1399		1872
1400	B<< C<h> >> Application Keypad (DECPAM) == C<ESC =>	1873	B<< C<h> >> Application Keypad (DECPAM) == C<ESC =>
1401	B<< C<l> >> Normal Keypad (DECPNM) == C<< ESC > >>	1874	B<< C<l> >> Normal Keypad (DECPNM) == C<< ESC > >>
1402		1875
1403	=end table	1876	=end table
1404		1877
1405	=item B<< C<Ps = 67> >>	1878	=item B<< C<Pm = 67> >>
1406		1879
1407	=begin table	1880	=begin table
1408		1881
1409	B<< C<h> >> Backspace key sends B<< C<BS> (DECBKM) >>	1882	B<< C<h> >> Backspace key sends B<< C<BS> (DECBKM) >>
1410	B<< C<l> >> Backspace key sends B<< C<DEL> >>	1883	B<< C<l> >> Backspace key sends B<< C<DEL> >>
1411		1884
1412	=end table	1885	=end table
1413		1886
1414	=item B<< C<Ps = 1000> >> (X11 XTerm)	1887	=item B<< C<Pm = 1000> >> (X11 XTerm)
1415		1888
1416	=begin table	1889	=begin table
1417		1890
1418	B<< C<h> >> Send Mouse X & Y on button press and release.	1891	B<< C<h> >> Send Mouse X & Y on button press and release.
1419	B<< C<l> >> No mouse reporting.	1892	B<< C<l> >> No mouse reporting.
1420		1893
1421	=end table	1894	=end table
1422		1895
1423	=item B<< C<Ps = 1001> >> (X11 XTerm) I<unimplemented>	1896	=item B<< C<Pm = 1001> >> (X11 XTerm) I<unimplemented>
1424		1897
1425	=begin table	1898	=begin table
1426		1899
1427	B<< C<h> >> Use Hilite Mouse Tracking.	1900	B<< C<h> >> Use Hilite Mouse Tracking.
1428	B<< C<l> >> No mouse reporting.	1901	B<< C<l> >> No mouse reporting.
1429		1902
1430	=end table	1903	=end table
1431		1904
		1905	=item B<< C<Pm = 1002> >> (X11 XTerm)
		1906
		1907	=begin table
		1908
		1909	B<< C<h> >> Send Mouse X & Y on button press and release, and motion with a button pressed.
		1910	B<< C<l> >> No mouse reporting.
		1911
		1912	=end table
		1913
		1914	=item B<< C<Pm = 1003> >> (X11 XTerm)
		1915
		1916	=begin table
		1917
		1918	B<< C<h> >> Send Mouse X & Y on button press and release, and motion.
		1919	B<< C<l> >> No mouse reporting.
		1920
		1921	=end table
		1922
1432	=item B<< C<Ps = 1010> >> (B<rxvt>)	1923	=item B<< C<Pm = 1010> >> (B<rxvt>)
1433		1924
1434	=begin table	1925	=begin table
1435		1926
1436	B<< C<h> >> Don't scroll to bottom on TTY output	1927	B<< C<h> >> Don't scroll to bottom on TTY output
1437	B<< C<l> >> Scroll to bottom on TTY output	1928	B<< C<l> >> Scroll to bottom on TTY output
1438		1929
1439	=end table	1930	=end table
1440		1931
1441	=item B<< C<Ps = 1011> >> (B<rxvt>)	1932	=item B<< C<Pm = 1011> >> (B<rxvt>)
1442		1933
1443	=begin table	1934	=begin table
1444		1935
1445	B<< C<h> >> Scroll to bottom when a key is pressed	1936	B<< C<h> >> Scroll to bottom when a key is pressed
1446	B<< C<l> >> Don't scroll to bottom when a key is pressed	1937	B<< C<l> >> Don't scroll to bottom when a key is pressed
1447		1938
1448	=end table	1939	=end table
1449		1940
		1941	=item B<< C<Pm = 1021> >> (B<rxvt>)
		1942
		1943	=begin table
		1944
		1945	B<< C<h> >> Bold/italic implies high intensity (see option B<-is>)
		1946	B<< C<l> >> Font styles have no effect on intensity (Compile styles)
		1947
		1948	=end table
		1949
1450	=item B<< C<Ps = 1047> >>	1950	=item B<< C<Pm = 1047> >>
1451		1951
1452	=begin table	1952	=begin table
1453		1953
1454	B<< C<h> >> Use Alternate Screen Buffer	1954	B<< C<h> >> Use Alternate Screen Buffer
1455	B<< C<l> >> Use Normal Screen Buffer - clear Alternate Screen Buffer if returning from it	1955	B<< C<l> >> Use Normal Screen Buffer - clear Alternate Screen Buffer if returning from it
1456		1956
1457	=end table	1957	=end table
1458		1958
1459	=item B<< C<Ps = 1048> >>	1959	=item B<< C<Pm = 1048> >>
1460		1960
1461	=begin table	1961	=begin table
1462		1962
1463	B<< C<h> >> Save cursor position	1963	B<< C<h> >> Save cursor position
1464	B<< C<l> >> Restore cursor position	1964	B<< C<l> >> Restore cursor position
1465		1965
1466	=end table	1966	=end table
1467		1967
1468	=item B<< C<Ps = 1049> >>	1968	=item B<< C<Pm = 1049> >>
1469		1969
1470	=begin table	1970	=begin table
1471		1971
1472	B<< C<h> >> Use Alternate Screen Buffer - clear Alternate Screen Buffer if switching to it	1972	B<< C<h> >> Use Alternate Screen Buffer - clear Alternate Screen Buffer if switching to it
1473	B<< C<l> >> Use Normal Screen Buffer	1973	B<< C<l> >> Use Normal Screen Buffer
1474		1974
1475	=end table	1975	=end table
1476		1976
		1977	=item B<< C<Pm = 2004> >>
		1978
		1979	=begin table
		1980
		1981	B<< C<h> >> Enable bracketed paste mode - prepend / append to the pasted text the control sequences C<ESC [ 200 ~> / C<ESC [ 201 ~>
		1982	B<< C<l> >> Disable bracketed paste mode
		1983
		1984	=end table
		1985
1477	=back	1986	=back
1478		1987
1479	=back	1988	=back
1480		1989
1481	X<XTerm>	1990	X<XTerm>
1482		1991
1483	=head1 XTerm Operating System Commands	1992	=head2 XTerm Operating System Commands
1484		1993
1485	=over 4	1994	=over 4
1486		1995
1487	=item B<< C<ESC ] Ps;Pt ST> >>	1996	=item B<< C<ESC ] Ps;Pt ST> >>
1488		1997
…		…
1495	B<< C<Ps = 0> >> Change Icon Name and Window Title to B<< C<Pt> >>	2004	B<< C<Ps = 0> >> Change Icon Name and Window Title to B<< C<Pt> >>
1496	B<< C<Ps = 1> >> Change Icon Name to B<< C<Pt> >>	2005	B<< C<Ps = 1> >> Change Icon Name to B<< C<Pt> >>
1497	B<< C<Ps = 2> >> Change Window Title to B<< C<Pt> >>	2006	B<< C<Ps = 2> >> Change Window Title to B<< C<Pt> >>
1498	B<< C<Ps = 3> >> If B<< C<Pt> >> starts with a B<< C<?> >>, query the (STRING) property of the window and return it. If B<< C<Pt> >> contains a B<< C<=> >>, set the named property to the given value, else delete the specified property.	2007	B<< C<Ps = 3> >> If B<< C<Pt> >> starts with a B<< C<?> >>, query the (STRING) property of the window and return it. If B<< C<Pt> >> contains a B<< C<=> >>, set the named property to the given value, else delete the specified property.
1499	B<< C<Ps = 4> >> B<< C<Pt> >> is a semi-colon separated sequence of one or more semi-colon separated B<number>/B<name> pairs, where B<number> is an index to a colour and B<name> is the name of a colour. Each pair causes the B<number>ed colour to be changed to B<name>. Numbers 0-7 corresponds to low-intensity (normal) colours and 8-15 corresponds to high-intensity colours. 0=black, 1=red, 2=green, 3=yellow, 4=blue, 5=magenta, 6=cyan, 7=white	2008	B<< C<Ps = 4> >> B<< C<Pt> >> is a semi-colon separated sequence of one or more semi-colon separated B<number>/B<name> pairs, where B<number> is an index to a colour and B<name> is the name of a colour. Each pair causes the B<number>ed colour to be changed to B<name>. Numbers 0-7 corresponds to low-intensity (normal) colours and 8-15 corresponds to high-intensity colours. 0=black, 1=red, 2=green, 3=yellow, 4=blue, 5=magenta, 6=cyan, 7=white
1500	B<< C<Ps = 10> >> Change colour of text foreground to B<< C<Pt> >> B<(NB: may change in future)>	2009	B<< C<Ps = 10> >> Change colour of text foreground to B<< C<Pt> >>
1501	B<< C<Ps = 11> >> Change colour of text background to B<< C<Pt> >> B<(NB: may change in future)>	2010	B<< C<Ps = 11> >> Change colour of text background to B<< C<Pt> >>
1502	B<< C<Ps = 12> >> Change colour of text cursor foreground to B<< C<Pt> >>	2011	B<< C<Ps = 12> >> Change colour of text cursor foreground to B<< C<Pt> >>
1503	B<< C<Ps = 13> >> Change colour of mouse foreground to B<< C<Pt> >>	2012	B<< C<Ps = 13> >> Change colour of mouse foreground to B<< C<Pt> >>
1504	B<< C<Ps = 17> >> Change colour of highlight characters to B<< C<Pt> >>	2013	B<< C<Ps = 17> >> Change colour of highlight characters to B<< C<Pt> >>
1505	B<< C<Ps = 18> >> Change colour of bold characters to B<< C<Pt> >>	2014	B<< C<Ps = 18> >> Change colour of bold characters to B<< C<Pt> >> [deprecated, see 706]
1506	B<< C<Ps = 19> >> Change colour of underlined characters to B<< C<Pt> >>	2015	B<< C<Ps = 19> >> Change colour of underlined characters to B<< C<Pt> >> [deprecated, see 707]
1507	B<< C<Ps = 20> >> Change default background to B<< C<Pt> >>	2016	B<< C<Ps = 20> >> Change background pixmap parameters (see section BACKGROUND IMAGE) (Compile AfterImage).
1508	B<< C<Ps = 39> >> Change default foreground colour to B<< C<Pt> >>.	2017	B<< C<Ps = 39> >> Change default foreground colour to B<< C<Pt> >>. [deprecated, use 10]
1509	B<< C<Ps = 46> >> Change Log File to B<< C<Pt> >> I<unimplemented>	2018	B<< C<Ps = 46> >> Change Log File to B<< C<Pt> >> I<unimplemented>
1510	B<< C<Ps = 49> >> Change default background colour to B<< C<Pt> >>.	2019	B<< C<Ps = 49> >> Change default background colour to B<< C<Pt> >>. [deprecated, use 11]
1511	B<< C<Ps = 50> >> Set fontset to B<< C<Pt> >>, with the following special values of B<< C<Pt> >> (B<rxvt>) B<< C<#+n> >> change up B<< C<n> >> B<< C<#-n> >> change down B<< C<n> >> if B<< C<n> >> is missing of 0, a value of 1 is used I<empty> change to font0 B<< C<n> >> change to font B<< C<n> >>	2020	B<< C<Ps = 50> >> Set fontset to B<< C<Pt> >>, with the following special values of B<< C<Pt> >> (B<rxvt>) B<< C<#+n> >> change up B<< C<n> >> B<< C<#-n> >> change down B<< C<n> >> if B<< C<n> >> is missing of 0, a value of 1 is used I<empty> change to font0 B<< C<n> >> change to font B<< C<n> >>
1512	B<< C<Ps = 55> >> Log all scrollback buffer and all of screen to B<< C<Pt> >>	2021	B<< C<Ps = 55> >> Log all scrollback buffer and all of screen to B<< C<Pt> >> [disabled]
1513	B<< C<Ps = 701> >> Change current locale to B<< C<Pt> >>, or, if B<< C<Pt> >> is B<< C<?> >>, return the current locale (Compile frills).	2022	B<< C<Ps = 701> >> Change current locale to B<< C<Pt> >>, or, if B<< C<Pt> >> is B<< C<?> >>, return the current locale (Compile frills).
1514	B<< C<Ps = 703> >> Menubar command B<< C<Pt> >> (Compile menubar).	2023	B<< C<Ps = 702> >> Request version if B<< C<Pt> >> is B<< C<?> >>, returning C<rxvt-unicode>, the resource name, the major and minor version numbers, e.g. C<ESC ] 702 ; rxvt-unicode ; urxvt ; 7 ; 4 ST>.
1515	B<< C<Ps = 704> >> Change colour of italic characters to B<< C<Pt> >>	2024	B<< C<Ps = 704> >> Change colour of italic characters to B<< C<Pt> >>
1516	B<< C<Ps = 705> >> Change background pixmap tint colour to B<< C<Pt> >> (Compile transparency).	2025	B<< C<Ps = 705> >> Change background pixmap tint colour to B<< C<Pt> >> (Compile transparency).
		2026	B<< C<Ps = 706> >> Change colour of bold characters to B<< C<Pt> >>
		2027	B<< C<Ps = 707> >> Change colour of underlined characters to B<< C<Pt> >>
		2028	B<< C<Ps = 708> >> Change colour of the border to B<< C<Pt> >>
1517	B<< C<Ps = 710> >> Set normal fontset to B<< C<Pt> >>. Same as C<Ps = 50>.	2029	B<< C<Ps = 710> >> Set normal fontset to B<< C<Pt> >>. Same as C<Ps = 50>.
1518	B<< C<Ps = 711> >> Set bold fontset to B<< C<Pt> >>. Similar to C<Ps = 50> (Compile styles).	2030	B<< C<Ps = 711> >> Set bold fontset to B<< C<Pt> >>. Similar to C<Ps = 50> (Compile styles).
1519	B<< C<Ps = 712> >> Set italic fontset to B<< C<Pt> >>. Similar to C<Ps = 50> (Compile styles).	2031	B<< C<Ps = 712> >> Set italic fontset to B<< C<Pt> >>. Similar to C<Ps = 50> (Compile styles).
1520	B<< C<Ps = 713> >> Set bold-italic fontset to B<< C<Pt> >>. Similar to C<Ps = 50> (Compile styles).	2032	B<< C<Ps = 713> >> Set bold-italic fontset to B<< C<Pt> >>. Similar to C<Ps = 50> (Compile styles).
1521	B<< C<Ps = 720> >> Move viewing window up by B<< C<Pt> >> lines, or clear scrollback buffer if C<Pt = 0> (Compile frills).	2033	B<< C<Ps = 720> >> Move viewing window up by B<< C<Pt> >> lines, or clear scrollback buffer if C<Pt = 0> (Compile frills).
1522	B<< C<Ps = 721> >> Move viewing window down by B<< C<Pt> >> lines, or clear scrollback buffer if C<Pt = 0> (Compile frills).	2034	B<< C<Ps = 721> >> Move viewing window down by B<< C<Pt> >> lines, or clear scrollback buffer if C<Pt = 0> (Compile frills).
		2035	B<< C<Ps = 777> >> Call the perl extension with the given string, which should be of the form C<extension:parameters> (Compile perl).
1523		2036
1524	=end table	2037	=end table
1525		2038
1526	=back	2039	=back
1527		2040
1528	X<menuBar>	2041	=head1 BACKGROUND IMAGE
1529		2042
1530	=head1 menuBar
1531
1532	B<< The exact syntax used is I<almost> solidified. >>
1533	In the menus, B<DON'T> try to use menuBar commands that add or remove a
1534	menuBar.
1535
1536	Note that in all of the commands, the B<< I</path/> >> I<cannot> be
1537	omitted: use B<./> to specify a menu relative to the current menu.
1538
1539	=head2 Overview of menuBar operation
1540
1541	For the menuBar XTerm escape sequence C<ESC ] 703 ; Pt ST>, the syntax
1542	of C<Pt> can be used for a variety of tasks:
1543
1544	At the top level is the current menuBar which is a member of a circular
1545	linked-list of other such menuBars.
1546
1547	The menuBar acts as a parent for the various drop-down menus, which in
1548	turn, may have labels, separator lines, menuItems and subMenus.
1549
1550	The menuItems are the useful bits: you can use them to mimic keyboard
1551	input or even to send text or escape sequences back to rxvt.
1552
1553	The menuBar syntax is intended to provide a simple yet robust method of
1554	constructing and manipulating menus and navigating through the
1555	menuBars.
1556
1557	The first step is to use the tag B<< [menu:I<name>] >> which creates
1558	the menuBar called I<name> and allows access. You may now or menus,
1559	subMenus, and menuItems. Finally, use the tag B<[done]> to set the
1560	menuBar access as B<readonly> to prevent accidental corruption of the
1561	menus. To re-access the current menuBar for alterations, use the tag
1562	B<[menu]>, make the alterations and then use B<[done]>
1563
1564	X<menuBarCommands>
1565
1566	=head2 Commands
1567
1568	=over 4
1569
1570	=item B<< [menu:+I<name>] >>
1571
1572	access the named menuBar for creation or alteration. If a new menuBar
1573	is created, it is called I<name> (max of 15 chars) and the current
1574	menuBar is pushed onto the stack
1575
1576	=item B<[menu]>
1577
1578	access the current menuBar for alteration
1579
1580	=item B<< [title:+I<string>] >>
1581
1582	set the current menuBar's title to I<string>, which may contain the
1583	following format specifiers:
1584
1585	B<%n> rxvt name (as per the B<-name> command-line option)
1586	B<%v> rxvt version
1587	B<%%> literal B<%> character
1588
1589	=item B<[done]>
1590
1591	set menuBar access as B<readonly>.
1592	End-of-file tag for B<< [read:+I<file>] >> operations.
1593
1594	=item B<< [read:+I<file>] >>
1595
1596	read menu commands directly from I<file> (extension ".menu" will be
1597	appended if required.) Start reading at a line with B<[menu]> or B<<
1598	[menu:+I<name> >> and continuing until B<[done]> is encountered.
1599
1600	Blank and comment lines (starting with B<#>) are ignored. Actually,
1601	since any invalid menu commands are also ignored, almost anything could
1602	be construed as a comment line, but this may be tightened up in the
1603	future ... so don't count on it!.
1604
1605	=item B<< [read:+I<file>;+I<name>] >>
1606
1607	The same as B<< [read:+I<file>] >>, but start reading at a line with
1608	B<< [menu:+I<name>] >> and continuing until B<< [done:+I<name>] >> or
1609	B<[done]> is encountered.
1610
1611	=item B<[dump]>
1612
1613	dump all menuBars to the file B</tmp/rxvt-PID> in a format suitable for
1614	later rereading.
1615
1616	=item B<[rm:name]>
1617
1618	remove the named menuBar
1619
1620	=item B<[rm] [rm:]>
1621
1622	remove the current menuBar
1623
1624	=item B<[rm*] [rm:*]>
1625
1626	remove all menuBars
1627
1628	=item B<[swap]>
1629
1630	swap the top two menuBars
1631
1632	=item B<[prev]>
1633
1634	access the previous menuBar
1635
1636	=item B<[next]>
1637
1638	access the next menuBar
1639
1640	=item B<[show]>
1641
1642	Enable display of the menuBar
1643
1644	=item B<[hide]>
1645
1646	Disable display of the menuBar
1647
1648	=item B<< [pixmap:+I<name>] >>
1649
1650	=item B<< [pixmap:+I<name>;I<scaling>] >>
1651
1652	(set the background pixmap globally
1653
1654	B<< A Future implementation I<may> make this local to the menubar >>)
1655
1656	=item B<< [:+I<command>:] >>
1657
1658	ignore the menu readonly status and issue a I<command> to or a menu or
1659	menuitem or change the ; a useful shortcut for setting the quick arrows
1660	from a menuBar.
1661
1662	=back
1663
1664	X<menuBarAdd>
1665
1666	=head2 Adding and accessing menus
1667
1668	The following commands may also be B<+> prefixed.
1669
1670	=over 4
1671
1672	=item B</+>
1673
1674	access menuBar top level
1675
1676	=item B<./+>
1677
1678	access current menu level
1679
1680	=item B<../+>
1681
1682	access parent menu (1 level up)
1683
1684	=item B<../../>
1685
1686	access parent menu (multiple levels up)
1687
1688	=item B<< I</path/>menu >>
1689
1690	add/access menu
1691
1692	=item B<< I</path/>menu/* >>
1693
1694	add/access menu and clear it if it exists
1695
1696	=item B<< I</path/>{-} >>
1697
1698	add separator
1699
1700	=item B<< I</path/>{item} >>
1701
1702	add B<item> as a label
1703
1704	=item B<< I</path/>{item} action >>
1705
1706	add/alter I<menuitem> with an associated I<action>
1707
1708	=item B<< I</path/>{item}{right-text} >>
1709
1710	add/alter I<menuitem> with B<right-text> as the right-justified text
1711	and as the associated I<action>
1712
1713	=item B<< I</path/>{item}{rtext} action >>
1714
1715	add/alter I<menuitem> with an associated I<action> and with B<rtext> as
1716	the right-justified text.
1717
1718	=back
1719
1720	=over 4
1721
1722	=item Special characters in I<action> must be backslash-escaped:
1723
1724	B<\a \b \E \e \n \r \t \octal>
1725
1726	=item or in control-character notation:
1727
1728	B<^@, ^A .. ^Z .. ^_, ^?>
1729
1730	=back
1731
1732	To send a string starting with a B<NUL> (B<^@>) character to the
1733	program, start I<action> with a pair of B<NUL> characters (B<^@^@>),
1734	the first of which will be stripped off and the balance directed to the
1735	program. Otherwise if I<action> begins with B<NUL> followed by
1736	non-+B<NUL> characters, the leading B<NUL> is stripped off and the
1737	balance is sent back to rxvt.
1738
1739	As a convenience for the many Emacs-type editors, I<action> may start
1740	with B<M-> (eg, B<M-$> is equivalent to B<\E$>) and a B<CR> will be
1741	appended if missed from B<M-x> commands.
1742
1743	As a convenience for issuing XTerm B<ESC ]> sequences from a menubar (or
1744	quick arrow), a B<BEL> (B<^G>) will be appended if needed.
1745
1746	=over 4
1747
1748	=item For example,
1749
1750	B<M-xapropos> is equivalent to B<\Exapropos\r>
1751
1752	=item and
1753
1754	B<\E]703;mona;100> is equivalent to B<\E]703;mona;100\a>
1755
1756	=back
1757
1758	The option B<< {I<right-rtext>} >> will be right-justified. In the
1759	absence of a specified action, this text will be used as the I<action>
1760	as well.
1761
1762	=over 4
1763
1764	=item For example,
1765
1766	B</File/{Open}{^X^F}> is equivalent to B</File/{Open}{^X^F} ^X^F>
1767
1768	=back
1769
1770	The left label I<is> necessary, since it's used for matching, but
1771	implicitly hiding the left label (by using same name for both left and
1772	right labels), or explicitly hiding the left label (by preceeding it
1773	with a dot), makes it possible to have right-justified text only.
1774
1775	=over 4
1776
1777	=item For example,
1778
1779	B</File/{Open}{Open} Open-File-Action>
1780
1781	=item or hiding it
1782
1783	B</File/{.anylabel}{Open} Open-File-Action>
1784
1785	=back
1786
1787	X<menuBarRemove>
1788
1789	=head2 Removing menus
1790
1791	=over 4
1792
1793	=item B<< -/*+ >>
1794
1795	remove all menus from the menuBar, the same as B<[clear]>
1796
1797	=item B<< -+I</path>menu+ >>
1798
1799	remove menu
1800
1801	=item B<< -+I</path>{item}+ >>
1802
1803	remove item
1804
1805	=item B<< -+I</path>{-} >>
1806
1807	remove separator)
1808
1809	=item B<-/path/menu/*>
1810
1811	remove all items, separators and submenus from menu
1812
1813	=back
1814
1815	X<menuBarArrows>
1816
1817	=head2 Quick Arrows
1818
1819	The menus also provide a hook for I<quick arrows> to provide easier
1820	user access. If nothing has been explicitly set, the default is to
1821	emulate the curror keys. The syntax permits each arrow to be altered
1822	individually or all four at once without re-entering their common
1823	beginning/end text. For example, to explicitly associate cursor actions
1824	with the arrows, any of the following forms could be used:
1825
1826	=over 4
1827
1828	=item B<< <r>+I<Right> >>
1829
1830	=item B<< <l>+I<Left> >>
1831
1832	=item B<< <u>+I<Up> >>
1833
1834	=item B<< <d>+I<Down> >>
1835
1836	Define actions for the respective arrow buttons
1837
1838	=item B<< <b>+I<Begin> >>
1839
1840	=item B<< <e>+I<End> >>
1841
1842	Define common beginning/end parts for I<quick arrows> which used in
1843	conjunction with the above <r> <l> <u> <d> constructs
1844
1845	=back
1846
1847	=over 4
1848
1849	=item For example, define arrows individually,
1850
1851	<u>\E[A
1852
1853	<d>\E[B
1854
1855	<r>\E[C
1856
1857	<l>\E[D
1858
1859	=item or all at once
1860
1861	<u>\E[AZ<><d>\E[BZ<><r>\E[CZ<><l>\E[D
1862
1863	=item or more compactly (factoring out common parts)
1864
1865	<b>\E[<u>AZ<><d>BZ<><r>CZ<><l>D
1866
1867	=back
1868
1869	X<menuBarSummary>
1870
1871	=head2 Command Summary
1872
1873	A short summary of the most I<common> commands:
1874
1875	=over 4
1876
1877	=item [menu:name]
1878
1879	use an existing named menuBar or start a new one
1880
1881	=item [menu]
1882
1883	use the current menuBar
1884
1885	=item [title:string]
1886
1887	set menuBar title
1888
1889	=item [done]
1890
1891	set menu access to readonly and, if reading from a file, signal EOF
1892
1893	=item [done:name]
1894
1895	if reading from a file using [read:file;name] signal EOF
1896
1897	=item [rm:name]
1898
1899	remove named menuBar(s)
1900
1901	=item [rm] [rm:]
1902
1903	remove current menuBar
1904
1905	=item [rm*] [rm:*]
1906
1907	remove all menuBar(s)
1908
1909	=item [swap]
1910
1911	swap top two menuBars
1912
1913	=item [prev]
1914
1915	access the previous menuBar
1916
1917	=item [next]
1918
1919	access the next menuBar
1920
1921	=item [show]
1922
1923	map menuBar
1924
1925	=item [hide]
1926
1927	unmap menuBar
1928
1929	=item [pixmap;file]
1930
1931	=item [pixmap;file;scaling]
1932
1933	set a background pixmap
1934
1935	=item [read:file]
1936
1937	=item [read:file;name]
1938
1939	read in a menu from a file
1940
1941	=item [dump]
1942
1943	dump out all menuBars to /tmp/rxvt-PID
1944
1945	=item /
1946
1947	access menuBar top level
1948
1949	=item ./
1950
1951	=item ../
1952
1953	=item ../../
1954
1955	access current or parent menu level
1956
1957	=item /path/menu
1958
1959	add/access menu
1960
1961	=item /path/{-}
1962
1963	add separator
1964
1965	=item /path/{item}{rtext} action
1966
1967	add/alter menu item
1968
1969	=item -/*
1970
1971	remove all menus from the menuBar
1972
1973	=item -/path/menu
1974
1975	remove menu items, separators and submenus from menu
1976
1977	=item -/path/menu
1978
1979	remove menu
1980
1981	=item -/path/{item}
1982
1983	remove item
1984
1985	=item -/path/{-}
1986
1987	remove separator
1988
1989	=item <b>Begin<r>Right<l>Left<u>Up<d>Down<e>End
1990
1991	menu quick arrows
1992
1993	=back
1994	X<XPM>
1995
1996	=head1 XPM
1997
1998	For the XPM XTerm escape sequence B<< C<ESC ] 20 ; Pt ST> >> then value	2043	For the BACKGROUND IMAGE XTerm escape sequence B<< C<ESC ] 20 ; Pt ST> >> the value
1999	of B<< C<Pt> >> can be the name of the background pixmap followed by a	2044	of B<< C<Pt> >> can be the name of the background image file followed by a
2000	sequence of scaling/positioning commands separated by semi-colons. The	2045	sequence of scaling/positioning commands separated by semi-colons. The
2001	scaling/positioning commands are as follows:	2046	scaling/positioning commands are as follows:
2002		2047
2003	=over 4	2048	=over 4
2004		2049
…		…
2042		2087
2043	For example:	2088	For example:
2044		2089
2045	=over 4	2090	=over 4
2046		2091
2047	=item B<\E]20;funky\a>	2092	=item B<\E]20;funky.jpg\a>
2048		2093
2049	load B<funky.xpm> as a tiled image	2094	load B<funky.jpg> as a tiled image
2050		2095
2051	=item B<\E]20;mona;100\a>	2096	=item B<\E]20;mona.jpg;100\a>
2052		2097
2053	load B<mona.xpm> with a scaling of 100%	2098	load B<mona.jpg> with a scaling of 100%
2054		2099
2055	=item B<\E]20;;200;?\a>	2100	=item B<\E]20;;200;?\a>
2056		2101
2057	rescale the current pixmap to 200% and display the image geometry in	2102	rescale the current pixmap to 200% and display the image geometry in
2058	the title	2103	the title
2059		2104
2060	=back	2105	=back
		2106
2061	X<Mouse>	2107	X<Mouse>
2062		2108
2063	=head1 Mouse Reporting	2109	=head1 Mouse Reporting
2064		2110
2065	=over 4	2111	=over 4
…		…
2097	=begin table	2143	=begin table
2098		2144
2099	4 Shift	2145	4 Shift
2100	8 Meta	2146	8 Meta
2101	16 Control	2147	16 Control
2102	32 Double Click I<(Rxvt extension)>	2148	32 Double Click I<(rxvt extension)>
2103		2149
2104	=end table	2150	=end table
2105		2151
2106	Col = B<< C<< <x> - SPACE >> >>	2152	Col = B<< C<< <x> - SPACE >> >>
2107		2153
2108	Row = B<< C<< <y> - SPACE >> >>	2154	Row = B<< C<< <y> - SPACE >> >>
2109		2155
2110	=back	2156	=back
		2157
		2158	=head1 Key Codes
		2159
2111	X<KeyCodes>	2160	X<KeyCodes>
2112
2113	=head1 Key Codes
2114		2161
2115	Note: B<Shift> + B<F1>-B<F10> generates B<F11>-B<F20>	2162	Note: B<Shift> + B<F1>-B<F10> generates B<F11>-B<F20>
2116		2163
2117	For the keypad, use B<Shift> to temporarily override Application-Keypad	2164	For the keypad, use B<Shift> to temporarily override Application-Keypad
2118	setting use B<Num_Lock> to toggle Application-Keypad setting if	2165	setting use B<Num_Lock> to toggle Application-Keypad setting if
…		…
2184	=end table	2231	=end table
2185		2232
2186	=head1 CONFIGURE OPTIONS	2233	=head1 CONFIGURE OPTIONS
2187		2234
2188	General hint: if you get compile errors, then likely your configuration	2235	General hint: if you get compile errors, then likely your configuration
2189	hasn't been tested well. Either try with --enable-everything or use the	2236	hasn't been tested well. Either try with C<--enable-everything> or use
2190	./reconf script as a base for experiments. ./reconf is used by myself,	2237	the default configuration (i.e. no C<--enable-xxx> or C<--disable-xxx>
2191	so it should generally be a working config. Of course, you should always	2238	switches). Of course, you should always report when a combination doesn't
2192	report when a combination doesn't work, so it can be fixed. Marc Lehmann	2239	work, so it can be fixed. Marc Lehmann <rxvt@schmorp.de>.
2193	<rxvt@schmorp.de>.	2240
		2241	All
2194		2242
2195	=over 4	2243	=over 4
2196		2244
2197	=item --enable-everything	2245	=item --enable-everything
2198		2246
2199	Add support for all non-multichoice options listed in "./configure	2247	Add (or remove) support for all non-multichoice options listed in "./configure
2200	--help". Note that unlike other enable options this is order dependant.	2248	--help".
		2249
2201	You can specify this and then disable options which this enables by	2250	You can specify this and then disable options you do not like by
2202	I<following> this with the appropriate commands.	2251	I<following> this with the appropriate C<--disable-...> arguments,
		2252	or you can start with a minimal configuration by specifying
		2253	C<--disable-everything> and than adding just the C<--enable-...> arguments
		2254	you want.
2203		2255
2204	=item --enable-xft	2256	=item --enable-xft (default: enabled)
2205		2257
2206	Add support for Xft (anti-aliases, among others) fonts. Xft fonts are	2258	Add support for Xft (anti-aliases, among others) fonts. Xft fonts are
2207	slower and require lots of memory, but as long as you don't use them, you	2259	slower and require lots of memory, but as long as you don't use them, you
2208	don't pay for them.	2260	don't pay for them.
2209		2261
2210	=item --enable-font-styles	2262	=item --enable-font-styles (default: on)
2211		2263
2212	Add support for B<bold>, I<italic> and B<< I<bold italic> >> font	2264	Add support for B<bold>, I<italic> and B<< I<bold italic> >> font
2213	styles. The fonts can be set manually or automatically.	2265	styles. The fonts can be set manually or automatically.
2214		2266
2215	=item --with-codesets=NAME,...	2267	=item --with-codesets=NAME,... (default: all)
2216		2268
2217	Compile in support for additional codeset (encoding) groups (C<eu>, C<vn>	2269	Compile in support for additional codeset (encoding) groups (C<eu>, C<vn>
2218	are always compiled in, which includes most 8-bit character sets). These	2270	are always compiled in, which includes most 8-bit character sets). These
2219	codeset tables are used for driving X11 core fonts, they are not required	2271	codeset tables are used for driving X11 core fonts, they are not required
2220	for Xft fonts, although having them compiled in lets rxvt-unicode choose	2272	for Xft fonts, although having them compiled in lets rxvt-unicode choose
…		…
2224		2276
2225	=begin table	2277	=begin table
2226		2278
2227	all all available codeset groups	2279	all all available codeset groups
2228	zh common chinese encodings	2280	zh common chinese encodings
2229	zh_ext rarely used but very big chinese encodigs	2281	zh_ext rarely used but very big chinese encodings
2230	jp common japanese encodings	2282	jp common japanese encodings
2231	jp_ext rarely used but big japanese encodings	2283	jp_ext rarely used but big japanese encodings
2232	kr korean encodings	2284	kr korean encodings
2233		2285
2234	=end table	2286	=end table
2235		2287
2236	=item --enable-xim	2288	=item --enable-xim (default: on)
2237		2289
2238	Add support for XIM (X Input Method) protocol. This allows using	2290	Add support for XIM (X Input Method) protocol. This allows using
2239	alternative input methods (e.g. kinput2) and will also correctly	2291	alternative input methods (e.g. kinput2) and will also correctly
2240	set up the input for people using dead keys or compose keys.	2292	set up the input for people using dead keys or compose keys.
2241		2293
2242	=item --enable-unicode3	2294	=item --enable-unicode3 (default: off)
		2295
		2296	Recommended to stay off unless you really need non-BMP characters.
2243		2297
2244	Enable direct support for displaying unicode codepoints above	2298	Enable direct support for displaying unicode codepoints above
2245	65535 (the basic multilingual page). This increases storage	2299	65535 (the basic multilingual page). This increases storage
2246	requirements per character from 2 to 4 bytes. X11 fonts do not yet	2300	requirements per character from 2 to 4 bytes. X11 fonts do not yet
2247	support these extra characters, but Xft does.	2301	support these extra characters, but Xft does.
2248		2302
2249	Please note that rxvt-unicode can store unicode code points >65535	2303	Please note that rxvt-unicode can store unicode code points >65535
2250	even without this flag, but the number of such characters is	2304	even without this flag, but the number of such characters is
2251	limited to a view thousand (shared with combining characters,	2305	limited to a few thousand (shared with combining characters,
2252	see next switch), and right now rxvt-unicode cannot display them	2306	see next switch), and right now rxvt-unicode cannot display them
2253	(input/output and cut&paste still work, though).	2307	(input/output and cut&paste still work, though).
2254		2308
2255	=item --enable-combining	2309	=item --enable-combining (default: on)
2256		2310
2257	Enable automatic composition of combining characters into	2311	Enable automatic composition of combining characters into
2258	composite characters. This is required for proper viewing of text	2312	composite characters. This is required for proper viewing of text
2259	where accents are encoded as seperate unicode characters. This is	2313	where accents are encoded as seperate unicode characters. This is
2260	done by using precomposited characters when available or creating	2314	done by using precomposited characters when available or creating
2261	new pseudo-characters when no precomposed form exists.	2315	new pseudo-characters when no precomposed form exists.
2262		2316
2263	Without --enable-unicode3, the number of additional precomposed characters	2317	Without --enable-unicode3, the number of additional precomposed
2264	is rather limited (2048, if this is full, rxvt-unicode will use the	2318	characters is somewhat limited (the 6400 private use characters will be
2265	private use area, extending the number of combinations to 8448). With
2266	--enable-unicode3, no practical limit exists.	2319	(ab-)used). With --enable-unicode3, no practical limit exists.
2267		2320
2268	This option will also enable storage (but not display) of characters	2321	This option will also enable storage (but not display) of characters
2269	beyond plane 0 (>65535) when --enable-unicode3 was not specified.	2322	beyond plane 0 (>65535) when --enable-unicode3 was not specified.
2270		2323
2271	The combining table also contains entries for arabic presentation forms,	2324	The combining table also contains entries for arabic presentation forms,
2272	but these are not currently used. Bug me if you want these to be used (and	2325	but these are not currently used. Bug me if you want these to be used (and
2273	tell me how these are to be used...).	2326	tell me how these are to be used...).
2274		2327
2275	=item --enable-fallback(=CLASS)	2328	=item --enable-fallback(=CLASS) (default: Rxvt)
2276		2329
2277	When reading resource settings, also read settings for class CLASS	2330	When reading resource settings, also read settings for class CLASS. To
2278	(default: Rxvt). To disable resource fallback use --disable-fallback.	2331	disable resource fallback use --disable-fallback.
2279		2332
2280	=item --with-res-name=NAME	2333	=item --with-res-name=NAME (default: urxvt)
2281		2334
2282	Use the given name (default: urxvt) as default application name when	2335	Use the given name as default application name when
2283	reading resources. Specify --with-res-name=rxvt to replace rxvt.	2336	reading resources. Specify --with-res-name=rxvt to replace rxvt.
2284		2337
2285	=item --with-res-class=CLASS	2338	=item --with-res-class=CLASS (default: URxvt)
2286		2339
2287	Use the given class (default: URxvt) as default application class	2340	Use the given class as default application class
2288	when reading resources. Specify --with-res-class=Rxvt to replace	2341	when reading resources. Specify --with-res-class=Rxvt to replace
2289	rxvt.	2342	rxvt.
2290		2343
2291	=item --enable-utmp	2344	=item --enable-utmp (default: on)
2292		2345
2293	Write user and tty to utmp file (used by programs like F<w>) at	2346	Write user and tty to utmp file (used by programs like F<w>) at
2294	start of rxvt execution and delete information when rxvt exits.	2347	start of rxvt execution and delete information when rxvt exits.
2295		2348
2296	=item --enable-wtmp	2349	=item --enable-wtmp (default: on)
2297		2350
2298	Write user and tty to wtmp file (used by programs like F<last>) at	2351	Write user and tty to wtmp file (used by programs like F<last>) at
2299	start of rxvt execution and write logout when rxvt exits. This	2352	start of rxvt execution and write logout when rxvt exits. This
2300	option requires --enable-utmp to also be specified.	2353	option requires --enable-utmp to also be specified.
2301		2354
2302	=item --enable-lastlog	2355	=item --enable-lastlog (default: on)
2303		2356
2304	Write user and tty to lastlog file (used by programs like	2357	Write user and tty to lastlog file (used by programs like
2305	F<lastlogin>) at start of rxvt execution. This option requires	2358	F<lastlogin>) at start of rxvt execution. This option requires
2306	--enable-utmp to also be specified.	2359	--enable-utmp to also be specified.
2307		2360
2308	=item --enable-xpm-background	2361	=item --enable-afterimage (default: on)
2309		2362
2310	Add support for XPM background pixmaps.	2363	Add support for libAfterImage to be used for transparency and background
		2364	images. It adds support for many file formats including JPG, PNG,
		2365	SVG, TIFF, GIF, XPM, BMP, ICO, XCF, TGA and AfterStep image XML
		2366	(L<http://www.afterstep.org/visualdoc.php?show=asimagexml>).
2311		2367
		2368	This option also adds such eye candy as blending an image over the root
		2369	background, as well as dynamic scaling and bluring of background images.
		2370
		2371	Note that with this option enabled, @@RXVT_NAME@@'s memory footprint might
		2372	increase by a few megabytes even if no extra features are used (mostly due
		2373	to third-party libraries used by libAI). Memory footprint may somewhat be
		2374	lowered if libAfterImage is configured without support for SVG.
		2375
2312	=item --enable-transparency	2376	=item --enable-transparency (default: on)
2313		2377
2314	Add support for inheriting parent backgrounds thus giving a fake	2378	Add support for backgrounds, creating illusion of transparency in the term.
2315	transparency to the term.
2316		2379
2317	=item --enable-fading	2380	=item --enable-fading (default: on)
2318		2381
2319	Add support for fading the text when focus is lost.	2382	Add support for fading the text when focus is lost.
2320		2383
2321	=item --enable-tinting
2322
2323	Add support for tinting of transparent backgrounds.
2324
2325	=item --enable-menubar
2326
2327	Add support for our menu bar system (this interacts badly with
2328	dynamic locale switching currently).
2329
2330	=item --enable-rxvt-scroll	2384	=item --enable-rxvt-scroll (default: on)
2331		2385
2332	Add support for the original rxvt scrollbar.	2386	Add support for the original rxvt scrollbar.
2333		2387
2334	=item --enable-next-scroll	2388	=item --enable-next-scroll (default: on)
2335		2389
2336	Add support for a NeXT-like scrollbar.	2390	Add support for a NeXT-like scrollbar.
2337		2391
2338	=item --enable-xterm-scroll	2392	=item --enable-xterm-scroll (default: on)
2339		2393
2340	Add support for an Xterm-like scrollbar.	2394	Add support for an Xterm-like scrollbar.
2341		2395
2342	=item --enable-plain-scroll
2343
2344	Add support for a very unobtrusive, plain-looking scrollbar that
2345	is the favourite of the rxvt-unicode author, having used it for
2346	many years.
2347
2348	=item --enable-half-shadow
2349
2350	Make shadows on the scrollbar only half the normal width & height.
2351	only applicable to rxvt scrollbars.
2352
2353	=item --enable-ttygid
2354
2355	Change tty device setting to group "tty" - only use this if
2356	your system uses this type of security.
2357
2358	=item --disable-backspace-key	2396	=item --disable-backspace-key
2359		2397
2360	Disable any handling of the backspace key by us - let the X server	2398	Removes any handling of the backspace key by us - let the X server do it.
		2399
		2400	=item --disable-delete-key
		2401
		2402	Removes any handling of the delete key by us - let the X server
2361	do it.	2403	do it.
2362		2404
2363	=item --disable-delete-key
2364
2365	Disable any handling of the delete key by us - let the X server
2366	do it.
2367
2368	=item --disable-resources	2405	=item --disable-resources
2369		2406
2370	Remove all resources checking.	2407	Removes any support for resource checking.
2371
2372	=item --enable-xgetdefault
2373
2374	Make resources checking via XGetDefault() instead of our small
2375	version which only checks ~/.Xdefaults, or if that doesn't exist then
2376	~/.Xresources.
2377
2378	Please note that nowadays, things like XIM will automatically pull in and
2379	use the full X resource manager, so the overhead of using it might be very
2380	small, if nonexistant.
2381
2382	=item --enable-strings
2383
2384	Add support for our possibly faster memset() function and other
2385	various routines, overriding your system's versions which may
2386	have been hand-crafted in assembly or may require extra libraries
2387	to link in. (this breaks ANSI-C rules and has problems on many
2388	GNU/Linux systems).
2389		2408
2390	=item --disable-swapscreen	2409	=item --disable-swapscreen
2391		2410
2392	Remove support for swap screen.	2411	Remove support for secondary/swap screen.
2393		2412
2394	=item --enable-frills	2413	=item --enable-frills (default: on)
2395		2414
2396	Add support for many small features that are not essential but nice to	2415	Add support for many small features that are not essential but nice to
2397	have. Normally you want this, but for very small binaries you may want to	2416	have. Normally you want this, but for very small binaries you may want to
2398	disable this.	2417	disable this.
2399		2418
2400	A non-exhaustive list of features enabled by C<--enable-frills> (possibly	2419	A non-exhaustive list of features enabled by C<--enable-frills> (possibly
2401	in combination with other switches) is:	2420	in combination with other switches) is:
2402		2421
2403	MWM-hints	2422	MWM-hints
2404	EWMH-hints (pid, utf8 names) and protocols (ping)	2423	EWMH-hints (pid, utf8 names) and protocols (ping)
		2424	urgency hint
2405	seperate underline colour	2425	seperate underline colour (-underlineColor)
2406	settable border widths and borderless switch	2426	settable border widths and borderless switch (-w, -b, -bl)
		2427	visual depth selection (-depth)
2407	settable extra linespacing	2428	settable extra linespacing /-lsp)
2408	iso-14755-2 and -3, and visual feedback	2429	iso-14755 5.1 (basic) support
		2430	tripleclickwords (-tcw)
		2431	settable insecure mode (-insecure)
		2432	keysym remapping support
		2433	cursor blinking and underline cursor (-cb, -uc)
		2434	XEmbed support (-embed)
		2435	user-pty (-pty-fd)
		2436	hold on exit (-hold)
		2437	compile in built-in block graphics
		2438	skip builtin block graphics (-sbg)
		2439	separate highlightcolor support (-hc)
		2440
		2441	It also enables some non-essential features otherwise disabled, such as:
		2442
		2443	some round-trip time optimisations
		2444	nearest color allocation on pseudocolor screens
		2445	UTF8_STRING support for selection
		2446	sgr modes 90..97 and 100..107
2409	backindex and forwardindex escape sequence	2447	backindex and forwardindex escape sequences
		2448	view change/zero scrollback escape sequences
		2449	locale switching escape sequence
2410	window op and some xterm/OSC escape sequences	2450	window op and some xterm/OSC escape sequences
2411	tripleclickwords	2451	rectangular selections
2412	settable insecure mode	2452	trailing space removal for selections
2413	keysym remapping support	2453	verbose X error handling
2414	cursor blinking and underline cursor
2415	-embed and -pty-fd options
2416		2454
2417	=item --enable-iso14755	2455	=item --enable-iso14755 (default: on)
2418		2456
2419	Enable extended ISO 14755 support (see @@RXVT_NAME@@(1), or	2457	Enable extended ISO 14755 support (see @@RXVT_NAME@@(1)).
2420	F<doc/rxvt.1.txt>). Basic support (section 5.1) is enabled by	2458	Basic support (section 5.1) is enabled by C<--enable-frills>, while
2421	C<--enable-frills>, while support for 5.2, 5.3 and 5.4 is enabled with	2459	support for 5.2, 5.3 and 5.4 is enabled with this switch.
2422	this switch.
2423		2460
2424	=item --enable-keepscrolling	2461	=item --enable-keepscrolling (default: on)
2425		2462
2426	Add support for continual scrolling of the display when you hold	2463	Add support for continual scrolling of the display when you hold
2427	the mouse button down on a scrollbar arrow.	2464	the mouse button down on a scrollbar arrow.
2428		2465
		2466	=item --enable-selectionscrolling (default: on)
		2467
		2468	Add support for scrolling when the selection moves to the top or
		2469	bottom of the screen.
		2470
2429	=item --enable-mousewheel	2471	=item --enable-mousewheel (default: on)
2430		2472
2431	Add support for scrolling via mouse wheel or buttons 4 & 5.	2473	Add support for scrolling via mouse wheel or buttons 4 & 5.
2432		2474
2433	=item --enable-slipwheeling	2475	=item --enable-slipwheeling (default: on)
2434		2476
2435	Add support for continual scrolling (using the mouse wheel as an	2477	Add support for continual scrolling (using the mouse wheel as an
2436	accelerator) while the control key is held down. This option	2478	accelerator) while the control key is held down. This option
2437	requires --enable-mousewheel to also be specified.	2479	requires --enable-mousewheel to also be specified.
2438		2480
2439	=item --disable-new-selection
2440
2441	Remove support for mouse selection style like that of xterm.
2442
2443	=item --enable-dmalloc
2444
2445	Use Gray Watson's malloc - which is good for debugging See
2446	http://www.letters.com/dmalloc/ for details If you use either this or the
2447	next option, you may need to edit src/Makefile after compiling to point
2448	DINCLUDE and DLIB to the right places.
2449
2450	You can only use either this option and the following (should
2451	you use either) .
2452
2453	=item --enable-dlmalloc
2454
2455	Use Doug Lea's malloc - which is good for a production version
2456	See L<http://g.oswego.edu/dl/html/malloc.html> for details.
2457
2458	=item --enable-smart-resize	2481	=item --enable-smart-resize (default: off)
2459		2482
2460	Add smart growth/shrink behaviour when changing font size via from hot	2483	Add smart growth/shrink behaviour when resizing.
2461	keys. This should keep in a fixed position the rxvt corner which is	2484	This should keep the window corner which is closest to a corner of
2462	closest to a corner of the screen.	2485	the screen in a fixed position.
2463		2486
		2487	=item --enable-text-blink (default: on)
		2488
		2489	Add support for blinking text.
		2490
2464	=item --enable-pointer-blank	2491	=item --enable-pointer-blank (default: on)
2465		2492
2466	Add support to have the pointer disappear when typing or inactive.	2493	Add support to have the pointer disappear when typing or inactive.
2467		2494
2468	=item --with-name=NAME	2495	=item --enable-perl (default: on)
2469		2496
		2497	Enable an embedded perl interpreter. See the B<@@RXVT_NAME@@perl(3)>
		2498	manpage for more info on this feature, or the files in F<src/perl/>
		2499	for the extensions that are installed by default.
		2500	The perl interpreter that is used can be specified via the C<PERL>
		2501	environment variable when running configure. Even when compiled in,
		2502	perl will I<not> be initialised when all extensions have been disabled
		2503	C<-pe "" --perl-ext-common "">, so it should be safe to enable from a
		2504	resource standpoint.
		2505
		2506	=item --with-afterimage-config=DIR
		2507
		2508	Look for the libAfterImage config script in DIR.
		2509
		2510	=item --with-name=NAME (default: urxvt)
		2511
2470	Set the basename for the installed binaries (default: C<urxvt>, resulting	2512	Set the basename for the installed binaries, resulting
2471	in C<urxvt>, C<urxvtd> etc.). Specify C<--with-name=rxvt> to replace with	2513	in C<urxvt>, C<urxvtd> etc.). Specify C<--with-name=rxvt> to replace with
2472	C<rxvt>.	2514	C<rxvt>.
2473		2515
2474	=item --with-term=NAME	2516	=item --with-term=NAME (default: rxvt-unicode)
2475		2517
2476	Change the environmental variable for the terminal to NAME (default	2518	Change the environmental variable for the terminal to NAME.
2477	C<rxvt-unicode>)
2478		2519
2479	=item --with-terminfo=PATH	2520	=item --with-terminfo=PATH
2480		2521
2481	Change the environmental variable for the path to the terminfo tree to	2522	Change the environmental variable for the path to the terminfo tree to
2482	PATH.	2523	PATH.
2483		2524
2484	=item --with-x	2525	=item --with-x
2485		2526
2486	Use the X Window System (pretty much default, eh?).	2527	Use the X Window System (pretty much default, eh?).
2487
2488	=item --with-xpm-includes=DIR
2489
2490	Look for the XPM includes in DIR.
2491
2492	=item --with-xpm-library=DIR
2493
2494	Look for the XPM library in DIR.
2495
2496	=item --with-xpm
2497
2498	Not needed - define via --enable-xpm-background.
2499		2528
2500	=back	2529	=back
2501		2530
2502	=head1 AUTHORS	2531	=head1 AUTHORS
2503		2532

Diff Legend

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