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

Comparing rxvt-unicode/doc/rxvt.7.pod (file contents):
Revision 1.57 by root, Wed Jul 13 01:24:09 2005 UTC vs.
Revision 1.177 by root, Sat May 30 08:53:48 2009 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 (you might try C<LC_CTYPE=C-UTF-8>), so you are likely limited
360	to 8-bit encodings.
361
362	=item How does rxvt-unicode determine the encoding to use?
363
364	=item Is there an option to switch encodings?
365
366	Unlike some other terminals, rxvt-unicode has no encoding switch, and no
367	specific "utf-8" mode, such as xterm. In fact, it doesn't even know about
368	UTF-8 or any other encodings with respect to terminal I/O.
369
370	The reasons is that there exists a perfectly fine mechanism for selecting
371	the encoding, doing I/O and (most important) communicating this to all
372	applications so everybody agrees on character properties such as width
373	and code number. This mechanism is the I<locale>. Applications not using
374	that info will have problems (for example, C<xterm> gets the width of
375	characters wrong as it uses it's own, locale-independent table under all
376	locales).
377
378	Rxvt-unicode uses the C<LC_CTYPE> locale category to select encoding. All
379	programs doing the same (that is, most) will automatically agree in the
380	interpretation of characters.
381
382	Unfortunately, there is no system-independent way to select locales, nor
383	is there a standard on how locale specifiers will look like.
384
385	On most systems, the content of the C<LC_CTYPE> environment variable
386	contains an arbitrary string which corresponds to an already-installed
387	locale. Common names for locales are C<en_US.UTF-8>, C<de_DE.ISO-8859-15>,
388	C<ja_JP.EUC-JP>, i.e. C<language_country.encoding>, but other forms
389	(i.e. C<de> or C<german>) are also common.
390
391	Rxvt-unicode ignores all other locale categories, and except for
392	the encoding, ignores country or language-specific settings,
393	i.e. C<de_DE.UTF-8> and C<ja_JP.UTF-8> are the normally same to
394	rxvt-unicode.
395
396	If you want to use a specific encoding you have to make sure you start
397	rxvt-unicode with the correct C<LC_CTYPE> category.
398
399	=item Can I switch locales at runtime?
400
401	Yes, using an escape sequence. Try something like this, which sets
402	rxvt-unicode's idea of C<LC_CTYPE>.
403
404	printf '\e]701;%s\007' ja_JP.SJIS
405
406	See also the previous answer.
407
408	Sometimes this capability is rather handy when you want to work in
409	one locale (e.g. C<de_DE.UTF-8>) but some programs don't support it
410	(e.g. UTF-8). For example, I use this script to start C<xjdic>, which
411	first switches to a locale supported by xjdic and back later:
412
413	printf '\e]701;%s\007' ja_JP.SJIS
414	xjdic -js
415	printf '\e]701;%s\007' de_DE.UTF-8
416
417	You can also use xterm's C<luit> program, which usually works fine, except
418	for some locales where character width differs between program- and
419	rxvt-unicode-locales.
420
421	=item Can I switch the fonts at runtime?
422
423	Yes, using an escape sequence. Try something like this, which has the same
424	effect as using the C<-fn> switch, and takes effect immediately:
425
426	printf '\e]50;%s\007' "9x15bold,xft:Kochi Gothic"
427
428	This is useful if you e.g. work primarily with japanese (and prefer a
429	japanese font), but you have to switch to chinese temporarily, where
430	japanese fonts would only be in your way.
431
432	You can think of this as a kind of manual ISO-2022 switching.
433
434	=item Why do italic characters look as if clipped?
435
436	Many fonts have difficulties with italic characters and hinting. For
437	example, the otherwise very nicely hinted font C<xft:Bitstream Vera Sans
438	Mono> completely fails in it's italic face. A workaround might be to
439	enable freetype autohinting, i.e. like this:
440
441	URxvt.italicFont: xft:Bitstream Vera Sans Mono:italic:autohint=true
442	URxvt.boldItalicFont: xft:Bitstream Vera Sans Mono:bold:italic:autohint=true
443
444	=item My input method wants <some encoding> but I want UTF-8, what can I do?
445
446	You can specify separate locales for the input method and the rest of the
447	terminal, using the resource C<imlocale>:
448
449	URxvt*imlocale: ja_JP.EUC-JP
450
451	Now you can start your terminal with C<LC_CTYPE=ja_JP.UTF-8> and still
452	use your input method. Please note, however, that you will not be able to
453	input characters outside C<EUC-JP> in a normal way then, as your input
454	method limits you.
455
456	=item Rxvt-unicode crashes when the X Input Method changes or exits.
457
458	Unfortunately, this is unavoidable, as the XIM protocol is racy by
459	design. Applications can avoid some crashes at the expense of memory
460	leaks, and Input Methods can avoid some crashes by careful ordering at
461	exit time. B<kinput2> (and derived input methods) generally succeeds,
462	while B<SCIM> (or similar input methods) fails. In the end, however,
463	crashes cannot be completely avoided even if both sides cooperate.
464
465	So the only workaround is not to kill your Input Method Servers.
466
467	=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?
468		74
469	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
470	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
471	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,
472	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
…		…
477	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
478	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)
479	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
480	rxvt-unicode then uses 8 bytes per screen cell.	86	rxvt-unicode then uses 8 bytes per screen cell.
481		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
482	=item Can I speed up Xft rendering somehow?	339	=head3 Can I speed up Xft rendering somehow?
483		340
484	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
485	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
486	antialiasing (by appending C<:antialiasing=false>), which saves lots of	343	antialiasing (by appending C<:antialias=false>), which saves lots of
487	memory and also speeds up rendering considerably.	344	memory and also speeds up rendering considerably.
488		345
489	=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?
490		347
491	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
492	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
493	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
494	antialiasing disabled for most of them, because the author thinks they	351	antialiasing disabled for most of them, because the author thinks they
495	look best that way.	352	look best that way.
496		353
497	If you want antialiasing, you have to specify the fonts manually.	354	If you want antialiasing, you have to specify the fonts manually.
498		355
499	=item Mouse cut/paste suddenly no longer works.
500
501	Make sure that mouse reporting is actually turned off since killing
502	some editors prematurely may leave the mouse in mouse report mode. I've
503	heard that tcsh may use mouse reporting unless it otherwise specified. A
504	quick check is to see if cut/paste works when the Alt or Shift keys are
505	depressed. See @@RXVT_NAME@@(7)
506
507	=item What's with this bold/blink stuff?	356	=head3 What's with this bold/blink stuff?
508		357
509	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
510	standard foreground colour.	359	standard foreground colour.
511		360
512	For the standard background colour, blinking will actually make the	361	For the standard background colour, blinking will actually make
513	text blink when compiled with C<--enable-blinking>. with standard	362	the text blink when compiled with C<--enable-text-blink>. Without
514	colours. Without C<--enable-blinking>, the blink attribute will be	363	C<--enable-text-blink>, the blink attribute will be ignored.
515	ignored.
516		364
517	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
518	foreground/background colors.	366	foreground/background colors.
519		367
520	color0-7 are the low-intensity colors.	368	color0-7 are the low-intensity colors.
521		369
522	color8-15 are the corresponding high-intensity colors.	370	color8-15 are the corresponding high-intensity colors.
523		371
524	=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?
525		373
526	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>
527	resources (or as long-options).	375	resources (or as long-options).
528		376
529	Here are values that are supposed to resemble a VGA screen,	377	Here are values that are supposed to resemble a VGA screen,
…		…
545	URxvt.color12: #0000FF	393	URxvt.color12: #0000FF
546	URxvt.color13: #FF00FF	394	URxvt.color13: #FF00FF
547	URxvt.color14: #00FFFF	395	URxvt.color14: #00FFFF
548	URxvt.color15: #FFFFFF	396	URxvt.color15: #FFFFFF
549		397
550	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.
551	me) as "pretty girly".
552		399
553	URxvt.cursorColor: #dc74d1	400	URxvt.cursorColor: #dc74d1
554	URxvt.pointerColor: #dc74d1	401	URxvt.pointerColor: #dc74d1
555	URxvt.background: #0e0e0e	402	URxvt.background: #0e0e0e
556	URxvt.foreground: #4ad5e1	403	URxvt.foreground: #4ad5e1
…		…
567	URxvt.color6: #73f7ff	414	URxvt.color6: #73f7ff
568	URxvt.color14: #73f7ff	415	URxvt.color14: #73f7ff
569	URxvt.color7: #e1dddd	416	URxvt.color7: #e1dddd
570	URxvt.color15: #e1dddd	417	URxvt.color15: #e1dddd
571		418
572	=item How can I start @@RXVT_NAME@@d in a race-free way?	419	They have been described (not by me) as "pretty girly".
573		420
574	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?
575	server that answers @@RXVT_NAME@@c's requests, so it doesn't background
576	itself.
577		422
578	To ensure @@RXVT_NAME@@d is listening on it's socket, you can use the	423	See next entry.
579	following method to wait for the startup message before continuing:
580		424
581	{ @@RXVT_NAME@@d & } \| read	425	=head3 How does rxvt-unicode choose fonts?
582		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
583	=item What's with the strange Backspace/Delete key behaviour?	579	=head3 What's with the strange Backspace/Delete key behaviour?
584		580
585	Assuming that the physical Backspace key corresponds to the	581	Assuming that the physical Backspace key corresponds to the
586	BackSpace keysym (not likely for Linux ... see the following	582	Backspace keysym (not likely for Linux ... see the following
587	question) there are two standard values that can be used for	583	question) there are two standard values that can be used for
588	Backspace: C<^H> and C<^?>.	584	Backspace: C<^H> and C<^?>.
589		585
590	Historically, either value is correct, but rxvt-unicode adopts the debian	586	Historically, either value is correct, but rxvt-unicode adopts the debian
591	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
592	choice :).	588	choice :).
593		589
594	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
595	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
596	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
…		…
599		595
600	For starting a new rxvt-unicode:	596	For starting a new rxvt-unicode:
601		597
602	# use Backspace = ^H	598	# use Backspace = ^H
603	$ stty erase ^H	599	$ stty erase ^H
604	$ @@RXVT_NAME@@	600	$ @@URXVT_NAME@@
605		601
606	# use Backspace = ^?	602	# use Backspace = ^?
607	$ stty erase ^?	603	$ stty erase ^?
608	$ @@RXVT_NAME@@	604	$ @@URXVT_NAME@@
609		605
610	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>.
611		607
612	For an existing rxvt-unicode:	608	For an existing rxvt-unicode:
613		609
614	# use Backspace = ^H	610	# use Backspace = ^H
615	$ stty erase ^H	611	$ stty erase ^H
…		…
634	some editors (vim I'm told) expect Backspace = ^H,	630	some editors (vim I'm told) expect Backspace = ^H,
635	GNU Emacs (and Emacs-like editors) use ^H for help.	631	GNU Emacs (and Emacs-like editors) use ^H for help.
636		632
637	Perhaps someday this will all be resolved in a consistent manner.	633	Perhaps someday this will all be resolved in a consistent manner.
638		634
639	=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?
640		636
641	There are some compile-time selections available via configure. Unless	637	There are some compile-time selections available via configure. Unless
642	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
643	use the `keysym' resource to alter the keystrings associated with keysyms.	639	use the `keysym' resource to alter the keystrings associated with keysyms.
644		640
645	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>
646		642
647	URxvt.keysym.Home: \033[1~	643	URxvt.keysym.Home: \033[1~
648	URxvt.keysym.End: \033[4~	644	URxvt.keysym.End: \033[4~
649	URxvt.keysym.C-apostrophe: \033<C-'>	645	URxvt.keysym.C-apostrophe: \033<C-'>
650	URxvt.keysym.C-slash: \033<C-/>	646	URxvt.keysym.C-slash: \033<C-/>
…		…
665	URxvt.keysym.M-C-a: list \033<M-C- abcdefghijklmnopqrstuvwxyz >	661	URxvt.keysym.M-C-a: list \033<M-C- abcdefghijklmnopqrstuvwxyz >
666	URxvt.keysym.F12: command:\033]701;zh_CN.GBK\007	662	URxvt.keysym.F12: command:\033]701;zh_CN.GBK\007
667		663
668	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.
669		665
670	=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
671	How do I make use of them? For example, the Sun Keyboard type 4
672	has the following mappings that rxvt-unicode doesn't recognize.
673		667
674	KP_Insert == Insert	668	KP_Insert == Insert
675	F22 == Print	669	F22 == Print
676	F27 == Home	670	F27 == Home
677	F29 == Prior	671	F29 == Prior
…		…
680		674
681	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
682	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
683	required for your particular machine.	677	required for your particular machine.
684		678
685	=item How do I distinguish wether I'm running rxvt-unicode or a regular xterm?
686	I need this to decide about setting colors etc.
687		679
688	rxvt and rxvt-unicode always export the variable "COLORTERM", so you can	680	=head2 Terminal Configuration
689	check and see if that is set. Note that several programs, JED, slrn,
690	Midnight Commander automatically check this variable to decide whether or
691	not to use color.
692		681
693	=item How do I set the correct, full IP address for the DISPLAY variable?	682	=head3 Can I see a typical configuration?
694		683
695	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
696	insecure mode then it is possible to use the following shell script	685	much, but it's least surprise to regular users.
697	snippets to correctly set the display. If your version of rxvt-unicode
698	wasn't also compiled with ESCZ_ANSWER (as assumed in these snippets) then
699	the COLORTERM variable can be used to distinguish rxvt-unicode from a
700	regular xterm.
701		686
702	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
703	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...
704		691
705	# Bourne/Korn/POSIX family of shells:	692	URxvt.cutchars: "()*,<>[]{}\|'
706	[ ${TERM:-foo} = foo ] && TERM=xterm # assume an xterm if we don't know	693	URxvt.print-pipe: cat >/tmp/xxx
707	if [ ${TERM:-foo} = xterm ]; then
708	stty -icanon -echo min 0 time 15 # see if enhanced rxvt or not
709	echo -n '^[Z'
710	read term_id
711	stty icanon echo
712	if [ ""${term_id} = '^[[?1;2C' -a ${DISPLAY:-foo} = foo ]; then
713	echo -n '^[[7n' # query the rxvt we are in for the DISPLAY string
714	read DISPLAY # set it in our local shell
715	fi
716	fi
717		694
718	=item How do I compile the manual pages for myself?	695	These are just for testing stuff.
719		696
720	You need to have a recent version of perl installed as F</usr/bin/perl>,	697	URxvt.imLocale: ja_JP.UTF-8
721	one that comes with F<pod2man>, F<pod2text> and F<pod2html>. Then go to	698	URxvt.preeditType: OnTheSpot,None
722	the doc subdirectory and enter C<make alldoc>.
723		699
724	=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.
725		704
726	Before sending me mail, you could go to IRC: C<irc.freenode.net>,	705	URxvt.perl-lib: /root/lib/urxvt
727	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
728	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 by simply installing rxvt-unicode on the remote system as well
		863	(in case you have a nice package manager ready), or you can install the
		864	terminfo database manually like this (with ncurses infocmp. works as
		865	user and root):
		866
		867	REMOTE=remotesystem.domain
		868	infocmp rxvt-unicode \| ssh $REMOTE "mkdir -p .terminfo && cat >/tmp/ti && tic /tmp/ti"
		869
		870	One some systems you might need to set C<$TERMINFO> to the full path of
		871	F<$HOME/.terminfo> for this to work.
		872
		873	If you cannot or do not want to do this, then you can simply set
		874	C<TERM=rxvt> or even C<TERM=xterm>, and live with the small number of
		875	problems arising, which includes wrong keymapping, less and different
		876	colours and some refresh errors in fullscreen applications. It's a nice
		877	quick-and-dirty workaround for rare cases, though.
		878
		879	If you always want to do this (and are fine with the consequences) you
		880	can either recompile rxvt-unicode with the desired TERM value or use a
		881	resource to set it:
		882
		883	URxvt.termName: rxvt
		884
		885	If you don't plan to use B<rxvt> (quite common...) you could also replace
		886	the rxvt terminfo file with the rxvt-unicode one and use C<TERM=rxvt>.
		887
		888	=head3 nano fails with "Error opening terminal: rxvt-unicode"
		889
		890	This exceptionally confusing and useless error message is printed by nano
		891	when it can't find the terminfo database. Nothing is wrong with your
		892	terminal, read the previous answer for a solution.
		893
		894	=head3 C<tic> outputs some error when compiling the terminfo entry.
		895
		896	Most likely it's the empty definition for C<enacs=>. Just replace it by
		897	C<enacs=\E[0@> and try again.
		898
		899	=head3 C<bash>'s readline does not work correctly under @@URXVT_NAME@@.
		900
		901	See next entry.
		902
		903	=head3 I need a termcap file entry.
		904
		905	One reason you might want this is that some distributions or operating
		906	systems still compile some programs using the long-obsoleted termcap
		907	library (Fedora Core's bash is one example) and rely on a termcap entry
		908	for C<rxvt-unicode>.
		909
		910	You could use rxvt's termcap entry with reasonable results in many cases.
		911	You can also create a termcap entry by using terminfo's infocmp program
		912	like this:
		913
		914	infocmp -C rxvt-unicode
		915
		916	Or you could use the termcap entry in doc/etc/rxvt-unicode.termcap,
		917	generated by the command above.
		918
		919	=head3 Why does C<ls> no longer have coloured output?
		920
		921	The C<ls> in the GNU coreutils unfortunately doesn't use terminfo to
		922	decide whether a terminal has colour, but uses its own configuration
		923	file. Needless to say, C<rxvt-unicode> is not in its default file (among
		924	with most other terminals supporting colour). Either add:
		925
		926	TERM rxvt-unicode
		927
		928	to C</etc/DIR_COLORS> or simply add:
		929
		930	alias ls='ls --color=auto'
		931
		932	to your C<.profile> or C<.bashrc>.
		933
		934	=head3 Why doesn't vim/emacs etc. use the 88 colour mode?
		935
		936	See next entry.
		937
		938	=head3 Why doesn't vim/emacs etc. make use of italic?
		939
		940	See next entry.
		941
		942	=head3 Why are the secondary screen-related options not working properly?
		943
		944	Make sure you are using C<TERM=rxvt-unicode>. Some pre-packaged
		945	distributions (most notably Debian GNU/Linux) break rxvt-unicode
		946	by setting C<TERM> to C<rxvt>, which doesn't have these extra
		947	features. Unfortunately, some of these (most notably, again, Debian
		948	GNU/Linux) furthermore fail to even install the C<rxvt-unicode> terminfo
		949	file, so you will need to install it on your own (See the question B<When
		950	I log-in to another system it tells me about missing terminfo data?> on
		951	how to do this).
		952
		953
		954	=head2 Encoding / Locale / Input Method Issues
		955
		956	=head3 Rxvt-unicode does not seem to understand the selected encoding?
		957
		958	See next entry.
		959
		960	=head3 Unicode does not seem to work?
		961
		962	If you encounter strange problems like typing an accented character but
		963	getting two unrelated other characters or similar, or if program output is
		964	subtly garbled, then you should check your locale settings.
		965
		966	Rxvt-unicode must be started with the same C<LC_CTYPE> setting as the
		967	programs running in it. Often rxvt-unicode is started in the C<C> locale,
		968	while the login script running within the rxvt-unicode window changes the
		969	locale to something else, e.g. C<en_GB.UTF-8>. Needless to say, this is
		970	not going to work, and is the most common cause for problems.
		971
		972	The best thing is to fix your startup environment, as you will likely run
		973	into other problems. If nothing works you can try this in your .profile.
		974
		975	printf '\33]701;%s\007' "$LC_CTYPE" # $LANG or $LC_ALL are worth a try, too
		976
		977	If this doesn't work, then maybe you use a C<LC_CTYPE> specification not
		978	supported on your systems. Some systems have a C<locale> command which
		979	displays this (also, C<perl -e0> can be used to check locale settings, as
		980	it will complain loudly if it cannot set the locale). If it displays something
		981	like:
		982
		983	locale: Cannot set LC_CTYPE to default locale: ...
		984
		985	Then the locale you specified is not supported on your system.
		986
		987	If nothing works and you are sure that everything is set correctly then
		988	you will need to remember a little known fact: Some programs just don't
		989	support locales :(
		990
		991	=head3 How does rxvt-unicode determine the encoding to use?
		992
		993	See next entry.
		994
		995	=head3 Is there an option to switch encodings?
		996
		997	Unlike some other terminals, rxvt-unicode has no encoding switch, and no
		998	specific "utf-8" mode, such as xterm. In fact, it doesn't even know about
		999	UTF-8 or any other encodings with respect to terminal I/O.
		1000
		1001	The reasons is that there exists a perfectly fine mechanism for selecting
		1002	the encoding, doing I/O and (most important) communicating this to all
		1003	applications so everybody agrees on character properties such as width
		1004	and code number. This mechanism is the I<locale>. Applications not using
		1005	that info will have problems (for example, C<xterm> gets the width of
		1006	characters wrong as it uses its own, locale-independent table under all
		1007	locales).
		1008
		1009	Rxvt-unicode uses the C<LC_CTYPE> locale category to select encoding. All
		1010	programs doing the same (that is, most) will automatically agree in the
		1011	interpretation of characters.
		1012
		1013	Unfortunately, there is no system-independent way to select locales, nor
		1014	is there a standard on how locale specifiers will look like.
		1015
		1016	On most systems, the content of the C<LC_CTYPE> environment variable
		1017	contains an arbitrary string which corresponds to an already-installed
		1018	locale. Common names for locales are C<en_US.UTF-8>, C<de_DE.ISO-8859-15>,
		1019	C<ja_JP.EUC-JP>, i.e. C<language_country.encoding>, but other forms
		1020	(i.e. C<de> or C<german>) are also common.
		1021
		1022	Rxvt-unicode ignores all other locale categories, and except for
		1023	the encoding, ignores country or language-specific settings,
		1024	i.e. C<de_DE.UTF-8> and C<ja_JP.UTF-8> are the normally same to
		1025	rxvt-unicode.
		1026
		1027	If you want to use a specific encoding you have to make sure you start
		1028	rxvt-unicode with the correct C<LC_CTYPE> category.
		1029
		1030	=head3 Can I switch locales at runtime?
		1031
		1032	Yes, using an escape sequence. Try something like this, which sets
		1033	rxvt-unicode's idea of C<LC_CTYPE>.
		1034
		1035	printf '\33]701;%s\007' ja_JP.SJIS
		1036
		1037	See also the previous answer.
		1038
		1039	Sometimes this capability is rather handy when you want to work in
		1040	one locale (e.g. C<de_DE.UTF-8>) but some programs don't support it
		1041	(e.g. UTF-8). For example, I use this script to start C<xjdic>, which
		1042	first switches to a locale supported by xjdic and back later:
		1043
		1044	printf '\33]701;%s\007' ja_JP.SJIS
		1045	xjdic -js
		1046	printf '\33]701;%s\007' de_DE.UTF-8
		1047
		1048	You can also use xterm's C<luit> program, which usually works fine, except
		1049	for some locales where character width differs between program- and
		1050	rxvt-unicode-locales.
		1051
		1052	=head3 I have problems getting my input method working.
		1053
		1054	Try a search engine, as this is slightly different for every input method server.
		1055
		1056	Here is a checklist:
		1057
		1058	=over 4
		1059
		1060	=item - Make sure your locale I<and> the imLocale are supported on your OS.
		1061
		1062	Try C<locale -a> or check the documentation for your OS.
		1063
		1064	=item - Make sure your locale or imLocale matches a locale supported by your XIM.
		1065
		1066	For example, B<kinput2> does not support UTF-8 locales, you should use
		1067	C<ja_JP.EUC-JP> or equivalent.
		1068
		1069	=item - Make sure your XIM server is actually running.
		1070
		1071	=item - Make sure the C<XMODIFIERS> environment variable is set correctly when I<starting> rxvt-unicode.
		1072
		1073	When you want to use e.g. B<kinput2>, it must be set to
		1074	C<@im=kinput2>. For B<scim>, use C<@im=SCIM>. You can see what input
		1075	method servers are running with this command:
		1076
		1077	xprop -root XIM_SERVERS
		1078
		1079	=item
729		1080
730	=back	1081	=back
731		1082
		1083	=head3 My input method wants <some encoding> but I want UTF-8, what can I do?
		1084
		1085	You can specify separate locales for the input method and the rest of the
		1086	terminal, using the resource C<imlocale>:
		1087
		1088	URxvt.imlocale: ja_JP.EUC-JP
		1089
		1090	Now you can start your terminal with C<LC_CTYPE=ja_JP.UTF-8> and still
		1091	use your input method. Please note, however, that, depending on your Xlib
		1092	version, you may not be able to input characters outside C<EUC-JP> in a
		1093	normal way then, as your input method limits you.
		1094
		1095	=head3 Rxvt-unicode crashes when the X Input Method changes or exits.
		1096
		1097	Unfortunately, this is unavoidable, as the XIM protocol is racy by
		1098	design. Applications can avoid some crashes at the expense of memory
		1099	leaks, and Input Methods can avoid some crashes by careful ordering at
		1100	exit time. B<kinput2> (and derived input methods) generally succeeds,
		1101	while B<SCIM> (or similar input methods) fails. In the end, however,
		1102	crashes cannot be completely avoided even if both sides cooperate.
		1103
		1104	So the only workaround is not to kill your Input Method Servers.
		1105
		1106
		1107	=head2 Operating Systems / Package Maintaining
		1108
		1109	=head3 I am using Debian GNU/Linux and have a problem...
		1110
		1111	The Debian GNU/Linux package of rxvt-unicode in sarge contains large
		1112	patches that considerably change the behaviour of rxvt-unicode (but
		1113	unfortunately this notice has been removed). Before reporting a bug to
		1114	the original rxvt-unicode author please download and install the genuine
		1115	version (L<http://software.schmorp.de#rxvt-unicode>) and try to reproduce
		1116	the problem. If you cannot, chances are that the problems are specific to
		1117	Debian GNU/Linux, in which case it should be reported via the Debian Bug
		1118	Tracking System (use C<reportbug> to report the bug).
		1119
		1120	For other problems that also affect the Debian package, you can and
		1121	probably should use the Debian BTS, too, because, after all, it's also a
		1122	bug in the Debian version and it serves as a reminder for other users that
		1123	might encounter the same issue.
		1124
		1125	=head3 I am maintaining rxvt-unicode for distribution/OS XXX, any recommendation?
		1126
		1127	You should build one binary with the default options. F<configure>
		1128	now enables most useful options, and the trend goes to making them
		1129	runtime-switchable, too, so there is usually no drawback to enabling them,
		1130	except higher disk and possibly memory usage. The perl interpreter should
		1131	be enabled, as important functionality (menus, selection, likely more in
		1132	the future) depends on it.
		1133
		1134	You should not overwrite the C<perl-ext-common> snd C<perl-ext> resources
		1135	system-wide (except maybe with C<defaults>). This will result in useful
		1136	behaviour. If your distribution aims at low memory, add an empty
		1137	C<perl-ext-common> resource to the app-defaults file. This will keep the
		1138	perl interpreter disabled until the user enables it.
		1139
		1140	If you can/want build more binaries, I recommend building a minimal
		1141	one with C<--disable-everything> (very useful) and a maximal one with
		1142	C<--enable-everything> (less useful, it will be very big due to a lot of
		1143	encodings built-in that increase download times and are rarely used).
		1144
		1145	=head3 I need to make it setuid/setgid to support utmp/ptys on my OS, is this safe?
		1146
		1147	It should be, starting with release 7.1. You are encouraged to properly
		1148	install urxvt with privileges necessary for your OS now.
		1149
		1150	When rxvt-unicode detects that it runs setuid or setgid, it will fork
		1151	into a helper process for privileged operations (pty handling on some
		1152	systems, utmp/wtmp/lastlog handling on others) and drop privileges
		1153	immediately. This is much safer than most other terminals that keep
		1154	privileges while running (but is more relevant to urxvt, as it contains
		1155	things as perl interpreters, which might be "helpful" to attackers).
		1156
		1157	This forking is done as the very first within main(), which is very early
		1158	and reduces possible bugs to initialisation code run before main(), or
		1159	things like the dynamic loader of your system, which should result in very
		1160	little risk.
		1161
		1162	=head3 I am on FreeBSD and rxvt-unicode does not seem to work at all.
		1163
		1164	Rxvt-unicode requires the symbol C<__STDC_ISO_10646__> to be defined
		1165	in your compile environment, or an implementation that implements it,
		1166	whether it defines the symbol or not. C<__STDC_ISO_10646__> requires that
		1167	B<wchar_t> is represented as unicode.
		1168
		1169	As you might have guessed, FreeBSD does neither define this symbol nor
		1170	does it support it. Instead, it uses its own internal representation of
		1171	B<wchar_t>. This is, of course, completely fine with respect to standards.
		1172
		1173	However, that means rxvt-unicode only works in C<POSIX>, C<ISO-8859-1> and
		1174	C<UTF-8> locales under FreeBSD (which all use Unicode as B<wchar_t>).
		1175
		1176	C<__STDC_ISO_10646__> is the only sane way to support multi-language
		1177	apps in an OS, as using a locale-dependent (and non-standardized)
		1178	representation of B<wchar_t> makes it impossible to convert between
		1179	B<wchar_t> (as used by X11 and your applications) and any other encoding
		1180	without implementing OS-specific-wrappers for each and every locale. There
		1181	simply are no APIs to convert B<wchar_t> into anything except the current
		1182	locale encoding.
		1183
		1184	Some applications (such as the formidable B<mlterm>) work around this
		1185	by carrying their own replacement functions for character set handling
		1186	with them, and either implementing OS-dependent hacks or doing multiple
		1187	conversions (which is slow and unreliable in case the OS implements
		1188	encodings slightly different than the terminal emulator).
		1189
		1190	The rxvt-unicode author insists that the right way to fix this is in the
		1191	system libraries once and for all, instead of forcing every app to carry
		1192	complete replacements for them :)
		1193
		1194	=head3 How can I use rxvt-unicode under cygwin?
		1195
		1196	rxvt-unicode should compile and run out of the box on cygwin, using
		1197	the X11 libraries that come with cygwin. libW11 emulation is no
		1198	longer supported (and makes no sense, either, as it only supported a
		1199	single font). I recommend starting the X-server in C<-multiwindow> or
		1200	C<-rootless> mode instead, which will result in similar look&feel as the
		1201	old libW11 emulation.
		1202
		1203	At the time of this writing, cygwin didn't seem to support any multi-byte
		1204	encodings (you might try C<LC_CTYPE=C-UTF-8>), so you are likely limited
		1205	to 8-bit encodings.
		1206
		1207	=head3 Character widths are not correct.
		1208
		1209	urxvt uses the system wcwidth function to know the information about
		1210	the width of characters, so on systems with incorrect locale data you
		1211	will likely get bad results. Two notorious examples are Solaris 9,
		1212	where single-width characters like U+2514 are reported as double-width,
		1213	and Darwin 8, where combining chars are reported having width 1.
		1214
		1215	The solution is to upgrade your system or switch to a better one. A
		1216	possibly working workaround is to use a wcwidth implementation like
		1217
		1218	http://www.cl.cam.ac.uk/~mgk25/ucs/wcwidth.c
		1219
		1220	=head3 I want 256 colors
		1221
		1222	Are you sure you need 256 colors? 88 colors should be enough for most
		1223	purposes. If you really need more, there is an unsupported patch for
		1224	it in the doc directory, but please do not ask for it to be applied.
		1225
732	=head1 RXVT TECHNICAL REFERENCE	1226	=head1 RXVT-UNICODE TECHNICAL REFERENCE
733
734	=head1 DESCRIPTION
735		1227
736	The rest of this document describes various technical aspects of	1228	The rest of this document describes various technical aspects of
737	B<rxvt-unicode>. First the description of supported command sequences,	1229	B<rxvt-unicode>. First the description of supported command sequences,
738	followed by menu and pixmap support and last by a description of all	1230	followed by pixmap support and last by a description of all features
739	features selectable at C<configure> time.	1231	selectable at C<configure> time.
740		1232
741	=head1 Definitions	1233	=head2 Definitions
742		1234
743	=over 4	1235	=over 4
744		1236
745	=item B<< C<c> >>	1237	=item B<< C<c> >>
746		1238
…		…
764		1256
765	A text parameter composed of printable characters.	1257	A text parameter composed of printable characters.
766		1258
767	=back	1259	=back
768		1260
769	=head1 Values	1261	=head2 Values
770		1262
771	=over 4	1263	=over 4
772		1264
773	=item B<< C<ENQ> >>	1265	=item B<< C<ENQ> >>
774		1266
…		…
817		1309
818	Space Character	1310	Space Character
819		1311
820	=back	1312	=back
821		1313
822	=head1 Escape Sequences	1314	=head2 Escape Sequences
823		1315
824	=over 4	1316	=over 4
825		1317
826	=item B<< C<ESC # 8> >>	1318	=item B<< C<ESC # 8> >>
827		1319
…		…
925		1417
926	=back	1418	=back
927		1419
928	X<CSI>	1420	X<CSI>
929		1421
930	=head1 CSI (Command Sequence Introducer) Sequences	1422	=head2 CSI (Command Sequence Introducer) Sequences
931		1423
932	=over 4	1424	=over 4
933		1425
934	=item B<< C<ESC [ Ps @> >>	1426	=item B<< C<ESC [ Ps @> >>
935		1427
…		…
990	=begin table	1482	=begin table
991		1483
992	B<< C<Ps = 0> >> Clear to Right (default)	1484	B<< C<Ps = 0> >> Clear to Right (default)
993	B<< C<Ps = 1> >> Clear to Left	1485	B<< C<Ps = 1> >> Clear to Left
994	B<< C<Ps = 2> >> Clear All	1486	B<< C<Ps = 2> >> Clear All
		1487	B<< C<Ps = 3> >> Like Ps = 0, but is ignored when wrapped
		1488	(@@RXVT_NAME@@ extension)
995		1489
996	=end table	1490	=end table
997		1491
998	=item B<< C<ESC [ Ps L> >>	1492	=item B<< C<ESC [ Ps L> >>
999		1493
…		…
1205		1699
1206	=back	1700	=back
1207		1701
1208	X<PrivateModes>	1702	X<PrivateModes>
1209		1703
1210	=head1 DEC Private Modes	1704	=head2 DEC Private Modes
1211		1705
1212	=over 4	1706	=over 4
1213		1707
1214	=item B<< C<ESC [ ? Pm h> >>	1708	=item B<< C<ESC [ ? Pm h> >>
1215		1709
…		…
1231		1725
1232	Toggle DEC Private Mode Values (rxvt extension). I<where>	1726	Toggle DEC Private Mode Values (rxvt extension). I<where>
1233		1727
1234	=over 4	1728	=over 4
1235		1729
1236	=item B<< C<Ps = 1> >> (DECCKM)	1730	=item B<< C<Pm = 1> >> (DECCKM)
1237		1731
1238	=begin table	1732	=begin table
1239		1733
1240	B<< C<h> >> Application Cursor Keys	1734	B<< C<h> >> Application Cursor Keys
1241	B<< C<l> >> Normal Cursor Keys	1735	B<< C<l> >> Normal Cursor Keys
1242		1736
1243	=end table	1737	=end table
1244		1738
1245	=item B<< C<Ps = 2> >> (ANSI/VT52 mode)	1739	=item B<< C<Pm = 2> >> (ANSI/VT52 mode)
1246		1740
1247	=begin table	1741	=begin table
1248		1742
1249	B<< C<h> >> Enter VT52 mode	1743	B<< C<h> >> Enter VT52 mode
1250	B<< C<l> >> Enter VT52 mode	1744	B<< C<l> >> Enter VT52 mode
1251		1745
1252	=end table	1746	=end table
1253		1747
1254	=item B<< C<Ps = 3> >>	1748	=item B<< C<Pm = 3> >>
1255		1749
1256	=begin table	1750	=begin table
1257		1751
1258	B<< C<h> >> 132 Column Mode (DECCOLM)	1752	B<< C<h> >> 132 Column Mode (DECCOLM)
1259	B<< C<l> >> 80 Column Mode (DECCOLM)	1753	B<< C<l> >> 80 Column Mode (DECCOLM)
1260		1754
1261	=end table	1755	=end table
1262		1756
1263	=item B<< C<Ps = 4> >>	1757	=item B<< C<Pm = 4> >>
1264		1758
1265	=begin table	1759	=begin table
1266		1760
1267	B<< C<h> >> Smooth (Slow) Scroll (DECSCLM)	1761	B<< C<h> >> Smooth (Slow) Scroll (DECSCLM)
1268	B<< C<l> >> Jump (Fast) Scroll (DECSCLM)	1762	B<< C<l> >> Jump (Fast) Scroll (DECSCLM)
1269		1763
1270	=end table	1764	=end table
1271		1765
1272	=item B<< C<Ps = 5> >>	1766	=item B<< C<Pm = 5> >>
1273		1767
1274	=begin table	1768	=begin table
1275		1769
1276	B<< C<h> >> Reverse Video (DECSCNM)	1770	B<< C<h> >> Reverse Video (DECSCNM)
1277	B<< C<l> >> Normal Video (DECSCNM)	1771	B<< C<l> >> Normal Video (DECSCNM)
1278		1772
1279	=end table	1773	=end table
1280		1774
1281	=item B<< C<Ps = 6> >>	1775	=item B<< C<Pm = 6> >>
1282		1776
1283	=begin table	1777	=begin table
1284		1778
1285	B<< C<h> >> Origin Mode (DECOM)	1779	B<< C<h> >> Origin Mode (DECOM)
1286	B<< C<l> >> Normal Cursor Mode (DECOM)	1780	B<< C<l> >> Normal Cursor Mode (DECOM)
1287		1781
1288	=end table	1782	=end table
1289		1783
1290	=item B<< C<Ps = 7> >>	1784	=item B<< C<Pm = 7> >>
1291		1785
1292	=begin table	1786	=begin table
1293		1787
1294	B<< C<h> >> Wraparound Mode (DECAWM)	1788	B<< C<h> >> Wraparound Mode (DECAWM)
1295	B<< C<l> >> No Wraparound Mode (DECAWM)	1789	B<< C<l> >> No Wraparound Mode (DECAWM)
1296		1790
1297	=end table	1791	=end table
1298		1792
1299	=item B<< C<Ps = 8> >> I<unimplemented>	1793	=item B<< C<Pm = 8> >> I<unimplemented>
1300		1794
1301	=begin table	1795	=begin table
1302		1796
1303	B<< C<h> >> Auto-repeat Keys (DECARM)	1797	B<< C<h> >> Auto-repeat Keys (DECARM)
1304	B<< C<l> >> No Auto-repeat Keys (DECARM)	1798	B<< C<l> >> No Auto-repeat Keys (DECARM)
1305		1799
1306	=end table	1800	=end table
1307		1801
1308	=item B<< C<Ps = 9> >> X10 XTerm	1802	=item B<< C<Pm = 9> >> X10 XTerm
1309		1803
1310	=begin table	1804	=begin table
1311		1805
1312	B<< C<h> >> Send Mouse X & Y on button press.	1806	B<< C<h> >> Send Mouse X & Y on button press.
1313	B<< C<l> >> No mouse reporting.	1807	B<< C<l> >> No mouse reporting.
1314		1808
1315	=end table	1809	=end table
1316		1810
1317	=item B<< C<Ps = 10> >> (B<rxvt>)
1318
1319	=begin table
1320
1321	B<< C<h> >> menuBar visible
1322	B<< C<l> >> menuBar invisible
1323
1324	=end table
1325
1326	=item B<< C<Ps = 25> >>	1811	=item B<< C<Pm = 25> >>
1327		1812
1328	=begin table	1813	=begin table
1329		1814
1330	B<< C<h> >> Visible cursor {cnorm/cvvis}	1815	B<< C<h> >> Visible cursor {cnorm/cvvis}
1331	B<< C<l> >> Invisible cursor {civis}	1816	B<< C<l> >> Invisible cursor {civis}
1332		1817
1333	=end table	1818	=end table
1334		1819
1335	=item B<< C<Ps = 30> >>	1820	=item B<< C<Pm = 30> >>
1336		1821
1337	=begin table	1822	=begin table
1338		1823
1339	B<< C<h> >> scrollBar visisble	1824	B<< C<h> >> scrollBar visible
1340	B<< C<l> >> scrollBar invisisble	1825	B<< C<l> >> scrollBar invisible
1341		1826
1342	=end table	1827	=end table
1343		1828
1344	=item B<< C<Ps = 35> >> (B<rxvt>)	1829	=item B<< C<Pm = 35> >> (B<rxvt>)
1345		1830
1346	=begin table	1831	=begin table
1347		1832
1348	B<< C<h> >> Allow XTerm Shift+key sequences	1833	B<< C<h> >> Allow XTerm Shift+key sequences
1349	B<< C<l> >> Disallow XTerm Shift+key sequences	1834	B<< C<l> >> Disallow XTerm Shift+key sequences
1350		1835
1351	=end table	1836	=end table
1352		1837
1353	=item B<< C<Ps = 38> >> I<unimplemented>	1838	=item B<< C<Pm = 38> >> I<unimplemented>
1354		1839
1355	Enter Tektronix Mode (DECTEK)	1840	Enter Tektronix Mode (DECTEK)
1356		1841
1357	=item B<< C<Ps = 40> >>	1842	=item B<< C<Pm = 40> >>
1358		1843
1359	=begin table	1844	=begin table
1360		1845
1361	B<< C<h> >> Allow 80/132 Mode	1846	B<< C<h> >> Allow 80/132 Mode
1362	B<< C<l> >> Disallow 80/132 Mode	1847	B<< C<l> >> Disallow 80/132 Mode
1363		1848
1364	=end table	1849	=end table
1365		1850
1366	=item B<< C<Ps = 44> >> I<unimplemented>	1851	=item B<< C<Pm = 44> >> I<unimplemented>
1367		1852
1368	=begin table	1853	=begin table
1369		1854
1370	B<< C<h> >> Turn On Margin Bell	1855	B<< C<h> >> Turn On Margin Bell
1371	B<< C<l> >> Turn Off Margin Bell	1856	B<< C<l> >> Turn Off Margin Bell
1372		1857
1373	=end table	1858	=end table
1374		1859
1375	=item B<< C<Ps = 45> >> I<unimplemented>	1860	=item B<< C<Pm = 45> >> I<unimplemented>
1376		1861
1377	=begin table	1862	=begin table
1378		1863
1379	B<< C<h> >> Reverse-wraparound Mode	1864	B<< C<h> >> Reverse-wraparound Mode
1380	B<< C<l> >> No Reverse-wraparound Mode	1865	B<< C<l> >> No Reverse-wraparound Mode
1381		1866
1382	=end table	1867	=end table
1383		1868
1384	=item B<< C<Ps = 46> >> I<unimplemented>	1869	=item B<< C<Pm = 46> >> I<unimplemented>
1385		1870
1386	=item B<< C<Ps = 47> >>	1871	=item B<< C<Pm = 47> >>
1387		1872
1388	=begin table	1873	=begin table
1389		1874
1390	B<< C<h> >> Use Alternate Screen Buffer	1875	B<< C<h> >> Use Alternate Screen Buffer
1391	B<< C<l> >> Use Normal Screen Buffer	1876	B<< C<l> >> Use Normal Screen Buffer
1392		1877
1393	=end table	1878	=end table
1394		1879
1395	X<Priv66>	1880	X<Priv66>
1396		1881
1397	=item B<< C<Ps = 66> >>	1882	=item B<< C<Pm = 66> >>
1398		1883
1399	=begin table	1884	=begin table
1400		1885
1401	B<< C<h> >> Application Keypad (DECPAM) == C<ESC =>	1886	B<< C<h> >> Application Keypad (DECPAM) == C<ESC =>
1402	B<< C<l> >> Normal Keypad (DECPNM) == C<< ESC > >>	1887	B<< C<l> >> Normal Keypad (DECPNM) == C<< ESC > >>
1403		1888
1404	=end table	1889	=end table
1405		1890
1406	=item B<< C<Ps = 67> >>	1891	=item B<< C<Pm = 67> >>
1407		1892
1408	=begin table	1893	=begin table
1409		1894
1410	B<< C<h> >> Backspace key sends B<< C<BS> (DECBKM) >>	1895	B<< C<h> >> Backspace key sends B<< C<BS> (DECBKM) >>
1411	B<< C<l> >> Backspace key sends B<< C<DEL> >>	1896	B<< C<l> >> Backspace key sends B<< C<DEL> >>
1412		1897
1413	=end table	1898	=end table
1414		1899
1415	=item B<< C<Ps = 1000> >> (X11 XTerm)	1900	=item B<< C<Pm = 1000> >> (X11 XTerm)
1416		1901
1417	=begin table	1902	=begin table
1418		1903
1419	B<< C<h> >> Send Mouse X & Y on button press and release.	1904	B<< C<h> >> Send Mouse X & Y on button press and release.
1420	B<< C<l> >> No mouse reporting.	1905	B<< C<l> >> No mouse reporting.
1421		1906
1422	=end table	1907	=end table
1423		1908
1424	=item B<< C<Ps = 1001> >> (X11 XTerm) I<unimplemented>	1909	=item B<< C<Pm = 1001> >> (X11 XTerm) I<unimplemented>
1425		1910
1426	=begin table	1911	=begin table
1427		1912
1428	B<< C<h> >> Use Hilite Mouse Tracking.	1913	B<< C<h> >> Use Hilite Mouse Tracking.
1429	B<< C<l> >> No mouse reporting.	1914	B<< C<l> >> No mouse reporting.
1430		1915
1431	=end table	1916	=end table
1432		1917
		1918	=item B<< C<Pm = 1002> >> (X11 XTerm)
		1919
		1920	=begin table
		1921
		1922	B<< C<h> >> Send Mouse X & Y on button press and release, and motion with a button pressed.
		1923	B<< C<l> >> No mouse reporting.
		1924
		1925	=end table
		1926
		1927	=item B<< C<Pm = 1003> >> (X11 XTerm)
		1928
		1929	=begin table
		1930
		1931	B<< C<h> >> Send Mouse X & Y on button press and release, and motion.
		1932	B<< C<l> >> No mouse reporting.
		1933
		1934	=end table
		1935
1433	=item B<< C<Ps = 1010> >> (B<rxvt>)	1936	=item B<< C<Pm = 1010> >> (B<rxvt>)
1434		1937
1435	=begin table	1938	=begin table
1436		1939
1437	B<< C<h> >> Don't scroll to bottom on TTY output	1940	B<< C<h> >> Don't scroll to bottom on TTY output
1438	B<< C<l> >> Scroll to bottom on TTY output	1941	B<< C<l> >> Scroll to bottom on TTY output
1439		1942
1440	=end table	1943	=end table
1441		1944
1442	=item B<< C<Ps = 1011> >> (B<rxvt>)	1945	=item B<< C<Pm = 1011> >> (B<rxvt>)
1443		1946
1444	=begin table	1947	=begin table
1445		1948
1446	B<< C<h> >> Scroll to bottom when a key is pressed	1949	B<< C<h> >> Scroll to bottom when a key is pressed
1447	B<< C<l> >> Don't scroll to bottom when a key is pressed	1950	B<< C<l> >> Don't scroll to bottom when a key is pressed
1448		1951
1449	=end table	1952	=end table
1450		1953
		1954	=item B<< C<Pm = 1021> >> (B<rxvt>)
		1955
		1956	=begin table
		1957
		1958	B<< C<h> >> Bold/italic implies high intensity (see option B<-is>)
		1959	B<< C<l> >> Font styles have no effect on intensity (Compile styles)
		1960
		1961	=end table
		1962
1451	=item B<< C<Ps = 1047> >>	1963	=item B<< C<Pm = 1047> >>
1452		1964
1453	=begin table	1965	=begin table
1454		1966
1455	B<< C<h> >> Use Alternate Screen Buffer	1967	B<< C<h> >> Use Alternate Screen Buffer
1456	B<< C<l> >> Use Normal Screen Buffer - clear Alternate Screen Buffer if returning from it	1968	B<< C<l> >> Use Normal Screen Buffer - clear Alternate Screen Buffer if returning from it
1457		1969
1458	=end table	1970	=end table
1459		1971
1460	=item B<< C<Ps = 1048> >>	1972	=item B<< C<Pm = 1048> >>
1461		1973
1462	=begin table	1974	=begin table
1463		1975
1464	B<< C<h> >> Save cursor position	1976	B<< C<h> >> Save cursor position
1465	B<< C<l> >> Restore cursor position	1977	B<< C<l> >> Restore cursor position
1466		1978
1467	=end table	1979	=end table
1468		1980
1469	=item B<< C<Ps = 1049> >>	1981	=item B<< C<Pm = 1049> >>
1470		1982
1471	=begin table	1983	=begin table
1472		1984
1473	B<< C<h> >> Use Alternate Screen Buffer - clear Alternate Screen Buffer if switching to it	1985	B<< C<h> >> Use Alternate Screen Buffer - clear Alternate Screen Buffer if switching to it
1474	B<< C<l> >> Use Normal Screen Buffer	1986	B<< C<l> >> Use Normal Screen Buffer
1475		1987
1476	=end table	1988	=end table
1477		1989
		1990	=item B<< C<Pm = 2004> >>
		1991
		1992	=begin table
		1993
		1994	B<< C<h> >> Enable bracketed paste mode - prepend / append to the pasted text the control sequences C<ESC [ 200 ~> / C<ESC [ 201 ~>
		1995	B<< C<l> >> Disable bracketed paste mode
		1996
		1997	=end table
		1998
1478	=back	1999	=back
1479		2000
1480	=back	2001	=back
1481		2002
1482	X<XTerm>	2003	X<XTerm>
1483		2004
1484	=head1 XTerm Operating System Commands	2005	=head2 XTerm Operating System Commands
1485		2006
1486	=over 4	2007	=over 4
1487		2008
1488	=item B<< C<ESC ] Ps;Pt ST> >>	2009	=item B<< C<ESC ] Ps;Pt ST> >>
1489		2010
…		…
1496	B<< C<Ps = 0> >> Change Icon Name and Window Title to B<< C<Pt> >>	2017	B<< C<Ps = 0> >> Change Icon Name and Window Title to B<< C<Pt> >>
1497	B<< C<Ps = 1> >> Change Icon Name to B<< C<Pt> >>	2018	B<< C<Ps = 1> >> Change Icon Name to B<< C<Pt> >>
1498	B<< C<Ps = 2> >> Change Window Title to B<< C<Pt> >>	2019	B<< C<Ps = 2> >> Change Window Title to B<< C<Pt> >>
1499	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.	2020	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.
1500	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	2021	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
1501	B<< C<Ps = 10> >> Change colour of text foreground to B<< C<Pt> >> B<(NB: may change in future)>	2022	B<< C<Ps = 10> >> Change colour of text foreground to B<< C<Pt> >>
1502	B<< C<Ps = 11> >> Change colour of text background to B<< C<Pt> >> B<(NB: may change in future)>	2023	B<< C<Ps = 11> >> Change colour of text background to B<< C<Pt> >>
1503	B<< C<Ps = 12> >> Change colour of text cursor foreground to B<< C<Pt> >>	2024	B<< C<Ps = 12> >> Change colour of text cursor foreground to B<< C<Pt> >>
1504	B<< C<Ps = 13> >> Change colour of mouse foreground to B<< C<Pt> >>	2025	B<< C<Ps = 13> >> Change colour of mouse foreground to B<< C<Pt> >>
1505	B<< C<Ps = 17> >> Change colour of highlight characters to B<< C<Pt> >>	2026	B<< C<Ps = 17> >> Change colour of highlight characters to B<< C<Pt> >>
1506	B<< C<Ps = 18> >> Change colour of bold characters to B<< C<Pt> >>	2027	B<< C<Ps = 18> >> Change colour of bold characters to B<< C<Pt> >> [deprecated, see 706]
1507	B<< C<Ps = 19> >> Change colour of underlined characters to B<< C<Pt> >>	2028	B<< C<Ps = 19> >> Change colour of underlined characters to B<< C<Pt> >> [deprecated, see 707]
1508	B<< C<Ps = 20> >> Change default background to B<< C<Pt> >>	2029	B<< C<Ps = 20> >> Change background pixmap parameters (see section BACKGROUND IMAGE) (Compile AfterImage).
1509	B<< C<Ps = 39> >> Change default foreground colour to B<< C<Pt> >>.	2030	B<< C<Ps = 39> >> Change default foreground colour to B<< C<Pt> >>. [deprecated, use 10]
1510	B<< C<Ps = 46> >> Change Log File to B<< C<Pt> >> I<unimplemented>	2031	B<< C<Ps = 46> >> Change Log File to B<< C<Pt> >> I<unimplemented>
1511	B<< C<Ps = 49> >> Change default background colour to B<< C<Pt> >>.	2032	B<< C<Ps = 49> >> Change default background colour to B<< C<Pt> >>. [deprecated, use 11]
1512	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> >>	2033	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> >>
1513	B<< C<Ps = 55> >> Log all scrollback buffer and all of screen to B<< C<Pt> >>	2034	B<< C<Ps = 55> >> Log all scrollback buffer and all of screen to B<< C<Pt> >> [disabled]
1514	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).	2035	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).
1515	B<< C<Ps = 703> >> Menubar command B<< C<Pt> >> (Compile menubar).	2036	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>.
1516	B<< C<Ps = 704> >> Change colour of italic characters to B<< C<Pt> >>	2037	B<< C<Ps = 704> >> Change colour of italic characters to B<< C<Pt> >>
1517	B<< C<Ps = 705> >> Change background pixmap tint colour to B<< C<Pt> >> (Compile transparency).	2038	B<< C<Ps = 705> >> Change background pixmap tint colour to B<< C<Pt> >> (Compile transparency).
		2039	B<< C<Ps = 706> >> Change colour of bold characters to B<< C<Pt> >>
		2040	B<< C<Ps = 707> >> Change colour of underlined characters to B<< C<Pt> >>
		2041	B<< C<Ps = 708> >> Change colour of the border to B<< C<Pt> >>
1518	B<< C<Ps = 710> >> Set normal fontset to B<< C<Pt> >>. Same as C<Ps = 50>.	2042	B<< C<Ps = 710> >> Set normal fontset to B<< C<Pt> >>. Same as C<Ps = 50>.
1519	B<< C<Ps = 711> >> Set bold fontset to B<< C<Pt> >>. Similar to C<Ps = 50> (Compile styles).	2043	B<< C<Ps = 711> >> Set bold fontset to B<< C<Pt> >>. Similar to C<Ps = 50> (Compile styles).
1520	B<< C<Ps = 712> >> Set italic fontset to B<< C<Pt> >>. Similar to C<Ps = 50> (Compile styles).	2044	B<< C<Ps = 712> >> Set italic fontset to B<< C<Pt> >>. Similar to C<Ps = 50> (Compile styles).
1521	B<< C<Ps = 713> >> Set bold-italic fontset to B<< C<Pt> >>. Similar to C<Ps = 50> (Compile styles).	2045	B<< C<Ps = 713> >> Set bold-italic fontset to B<< C<Pt> >>. Similar to C<Ps = 50> (Compile styles).
1522	B<< C<Ps = 720> >> Move viewing window up by B<< C<Pt> >> lines, or clear scrollback buffer if C<Pt = 0> (Compile frills).	2046	B<< C<Ps = 720> >> Move viewing window up by B<< C<Pt> >> lines, or clear scrollback buffer if C<Pt = 0> (Compile frills).
1523	B<< C<Ps = 721> >> Move viewing window down by B<< C<Pt> >> lines, or clear scrollback buffer if C<Pt = 0> (Compile frills).	2047	B<< C<Ps = 721> >> Move viewing window down by B<< C<Pt> >> lines, or clear scrollback buffer if C<Pt = 0> (Compile frills).
		2048	B<< C<Ps = 777> >> Call the perl extension with the given string, which should be of the form C<extension:parameters> (Compile perl).
1524		2049
1525	=end table	2050	=end table
1526		2051
1527	=back	2052	=back
1528		2053
1529	X<menuBar>	2054	=head1 BACKGROUND IMAGE
1530		2055
1531	=head1 menuBar
1532
1533	B<< The exact syntax used is I<almost> solidified. >>
1534	In the menus, B<DON'T> try to use menuBar commands that add or remove a
1535	menuBar.
1536
1537	Note that in all of the commands, the B<< I</path/> >> I<cannot> be
1538	omitted: use B<./> to specify a menu relative to the current menu.
1539
1540	=head2 Overview of menuBar operation
1541
1542	For the menuBar XTerm escape sequence C<ESC ] 703 ; Pt ST>, the syntax
1543	of C<Pt> can be used for a variety of tasks:
1544
1545	At the top level is the current menuBar which is a member of a circular
1546	linked-list of other such menuBars.
1547
1548	The menuBar acts as a parent for the various drop-down menus, which in
1549	turn, may have labels, separator lines, menuItems and subMenus.
1550
1551	The menuItems are the useful bits: you can use them to mimic keyboard
1552	input or even to send text or escape sequences back to rxvt.
1553
1554	The menuBar syntax is intended to provide a simple yet robust method of
1555	constructing and manipulating menus and navigating through the
1556	menuBars.
1557
1558	The first step is to use the tag B<< [menu:I<name>] >> which creates
1559	the menuBar called I<name> and allows access. You may now or menus,
1560	subMenus, and menuItems. Finally, use the tag B<[done]> to set the
1561	menuBar access as B<readonly> to prevent accidental corruption of the
1562	menus. To re-access the current menuBar for alterations, use the tag
1563	B<[menu]>, make the alterations and then use B<[done]>
1564
1565	X<menuBarCommands>
1566
1567	=head2 Commands
1568
1569	=over 4
1570
1571	=item B<< [menu:+I<name>] >>
1572
1573	access the named menuBar for creation or alteration. If a new menuBar
1574	is created, it is called I<name> (max of 15 chars) and the current
1575	menuBar is pushed onto the stack
1576
1577	=item B<[menu]>
1578
1579	access the current menuBar for alteration
1580
1581	=item B<< [title:+I<string>] >>
1582
1583	set the current menuBar's title to I<string>, which may contain the
1584	following format specifiers:
1585
1586	B<%n> rxvt name (as per the B<-name> command-line option)
1587	B<%v> rxvt version
1588	B<%%> literal B<%> character
1589
1590	=item B<[done]>
1591
1592	set menuBar access as B<readonly>.
1593	End-of-file tag for B<< [read:+I<file>] >> operations.
1594
1595	=item B<< [read:+I<file>] >>
1596
1597	read menu commands directly from I<file> (extension ".menu" will be
1598	appended if required.) Start reading at a line with B<[menu]> or B<<
1599	[menu:+I<name> >> and continuing until B<[done]> is encountered.
1600
1601	Blank and comment lines (starting with B<#>) are ignored. Actually,
1602	since any invalid menu commands are also ignored, almost anything could
1603	be construed as a comment line, but this may be tightened up in the
1604	future ... so don't count on it!.
1605
1606	=item B<< [read:+I<file>;+I<name>] >>
1607
1608	The same as B<< [read:+I<file>] >>, but start reading at a line with
1609	B<< [menu:+I<name>] >> and continuing until B<< [done:+I<name>] >> or
1610	B<[done]> is encountered.
1611
1612	=item B<[dump]>
1613
1614	dump all menuBars to the file B</tmp/rxvt-PID> in a format suitable for
1615	later rereading.
1616
1617	=item B<[rm:name]>
1618
1619	remove the named menuBar
1620
1621	=item B<[rm] [rm:]>
1622
1623	remove the current menuBar
1624
1625	=item B<[rm] [rm:]>
1626
1627	remove all menuBars
1628
1629	=item B<[swap]>
1630
1631	swap the top two menuBars
1632
1633	=item B<[prev]>
1634
1635	access the previous menuBar
1636
1637	=item B<[next]>
1638
1639	access the next menuBar
1640
1641	=item B<[show]>
1642
1643	Enable display of the menuBar
1644
1645	=item B<[hide]>
1646
1647	Disable display of the menuBar
1648
1649	=item B<< [pixmap:+I<name>] >>
1650
1651	=item B<< [pixmap:+I<name>;I<scaling>] >>
1652
1653	(set the background pixmap globally
1654
1655	B<< A Future implementation I<may> make this local to the menubar >>)
1656
1657	=item B<< [:+I<command>:] >>
1658
1659	ignore the menu readonly status and issue a I<command> to or a menu or
1660	menuitem or change the ; a useful shortcut for setting the quick arrows
1661	from a menuBar.
1662
1663	=back
1664
1665	X<menuBarAdd>
1666
1667	=head2 Adding and accessing menus
1668
1669	The following commands may also be B<+> prefixed.
1670
1671	=over 4
1672
1673	=item B</+>
1674
1675	access menuBar top level
1676
1677	=item B<./+>
1678
1679	access current menu level
1680
1681	=item B<../+>
1682
1683	access parent menu (1 level up)
1684
1685	=item B<../../>
1686
1687	access parent menu (multiple levels up)
1688
1689	=item B<< I</path/>menu >>
1690
1691	add/access menu
1692
1693	=item B<< I</path/>menu/* >>
1694
1695	add/access menu and clear it if it exists
1696
1697	=item B<< I</path/>{-} >>
1698
1699	add separator
1700
1701	=item B<< I</path/>{item} >>
1702
1703	add B<item> as a label
1704
1705	=item B<< I</path/>{item} action >>
1706
1707	add/alter I<menuitem> with an associated I<action>
1708
1709	=item B<< I</path/>{item}{right-text} >>
1710
1711	add/alter I<menuitem> with B<right-text> as the right-justified text
1712	and as the associated I<action>
1713
1714	=item B<< I</path/>{item}{rtext} action >>
1715
1716	add/alter I<menuitem> with an associated I<action> and with B<rtext> as
1717	the right-justified text.
1718
1719	=back
1720
1721	=over 4
1722
1723	=item Special characters in I<action> must be backslash-escaped:
1724
1725	B<\a \b \E \e \n \r \t \octal>
1726
1727	=item or in control-character notation:
1728
1729	B<^@, ^A .. ^Z .. ^_, ^?>
1730
1731	=back
1732
1733	To send a string starting with a B<NUL> (B<^@>) character to the
1734	program, start I<action> with a pair of B<NUL> characters (B<^@^@>),
1735	the first of which will be stripped off and the balance directed to the
1736	program. Otherwise if I<action> begins with B<NUL> followed by
1737	non-+B<NUL> characters, the leading B<NUL> is stripped off and the
1738	balance is sent back to rxvt.
1739
1740	As a convenience for the many Emacs-type editors, I<action> may start
1741	with B<M-> (eg, B<M-$> is equivalent to B<\E$>) and a B<CR> will be
1742	appended if missed from B<M-x> commands.
1743
1744	As a convenience for issuing XTerm B<ESC ]> sequences from a menubar (or
1745	quick arrow), a B<BEL> (B<^G>) will be appended if needed.
1746
1747	=over 4
1748
1749	=item For example,
1750
1751	B<M-xapropos> is equivalent to B<\Exapropos\r>
1752
1753	=item and
1754
1755	B<\E]703;mona;100> is equivalent to B<\E]703;mona;100\a>
1756
1757	=back
1758
1759	The option B<< {I<right-rtext>} >> will be right-justified. In the
1760	absence of a specified action, this text will be used as the I<action>
1761	as well.
1762
1763	=over 4
1764
1765	=item For example,
1766
1767	B</File/{Open}{^X^F}> is equivalent to B</File/{Open}{^X^F} ^X^F>
1768
1769	=back
1770
1771	The left label I<is> necessary, since it's used for matching, but
1772	implicitly hiding the left label (by using same name for both left and
1773	right labels), or explicitly hiding the left label (by preceeding it
1774	with a dot), makes it possible to have right-justified text only.
1775
1776	=over 4
1777
1778	=item For example,
1779
1780	B</File/{Open}{Open} Open-File-Action>
1781
1782	=item or hiding it
1783
1784	B</File/{.anylabel}{Open} Open-File-Action>
1785
1786	=back
1787
1788	X<menuBarRemove>
1789
1790	=head2 Removing menus
1791
1792	=over 4
1793
1794	=item B<< -/*+ >>
1795
1796	remove all menus from the menuBar, the same as B<[clear]>
1797
1798	=item B<< -+I</path>menu+ >>
1799
1800	remove menu
1801
1802	=item B<< -+I</path>{item}+ >>
1803
1804	remove item
1805
1806	=item B<< -+I</path>{-} >>
1807
1808	remove separator)
1809
1810	=item B<-/path/menu/*>
1811
1812	remove all items, separators and submenus from menu
1813
1814	=back
1815
1816	X<menuBarArrows>
1817
1818	=head2 Quick Arrows
1819
1820	The menus also provide a hook for I<quick arrows> to provide easier
1821	user access. If nothing has been explicitly set, the default is to
1822	emulate the curror keys. The syntax permits each arrow to be altered
1823	individually or all four at once without re-entering their common
1824	beginning/end text. For example, to explicitly associate cursor actions
1825	with the arrows, any of the following forms could be used:
1826
1827	=over 4
1828
1829	=item B<< <r>+I<Right> >>
1830
1831	=item B<< <l>+I<Left> >>
1832
1833	=item B<< <u>+I<Up> >>
1834
1835	=item B<< <d>+I<Down> >>
1836
1837	Define actions for the respective arrow buttons
1838
1839	=item B<< <b>+I<Begin> >>
1840
1841	=item B<< <e>+I<End> >>
1842
1843	Define common beginning/end parts for I<quick arrows> which used in
1844	conjunction with the above <r> <l> <u> <d> constructs
1845
1846	=back
1847
1848	=over 4
1849
1850	=item For example, define arrows individually,
1851
1852	<u>\E[A
1853
1854	<d>\E[B
1855
1856	<r>\E[C
1857
1858	<l>\E[D
1859
1860	=item or all at once
1861
1862	<u>\E[AZ<><d>\E[BZ<><r>\E[CZ<><l>\E[D
1863
1864	=item or more compactly (factoring out common parts)
1865
1866	<b>\E[<u>AZ<><d>BZ<><r>CZ<><l>D
1867
1868	=back
1869
1870	X<menuBarSummary>
1871
1872	=head2 Command Summary
1873
1874	A short summary of the most I<common> commands:
1875
1876	=over 4
1877
1878	=item [menu:name]
1879
1880	use an existing named menuBar or start a new one
1881
1882	=item [menu]
1883
1884	use the current menuBar
1885
1886	=item [title:string]
1887
1888	set menuBar title
1889
1890	=item [done]
1891
1892	set menu access to readonly and, if reading from a file, signal EOF
1893
1894	=item [done:name]
1895
1896	if reading from a file using [read:file;name] signal EOF
1897
1898	=item [rm:name]
1899
1900	remove named menuBar(s)
1901
1902	=item [rm] [rm:]
1903
1904	remove current menuBar
1905
1906	=item [rm] [rm:]
1907
1908	remove all menuBar(s)
1909
1910	=item [swap]
1911
1912	swap top two menuBars
1913
1914	=item [prev]
1915
1916	access the previous menuBar
1917
1918	=item [next]
1919
1920	access the next menuBar
1921
1922	=item [show]
1923
1924	map menuBar
1925
1926	=item [hide]
1927
1928	unmap menuBar
1929
1930	=item [pixmap;file]
1931
1932	=item [pixmap;file;scaling]
1933
1934	set a background pixmap
1935
1936	=item [read:file]
1937
1938	=item [read:file;name]
1939
1940	read in a menu from a file
1941
1942	=item [dump]
1943
1944	dump out all menuBars to /tmp/rxvt-PID
1945
1946	=item /
1947
1948	access menuBar top level
1949
1950	=item ./
1951
1952	=item ../
1953
1954	=item ../../
1955
1956	access current or parent menu level
1957
1958	=item /path/menu
1959
1960	add/access menu
1961
1962	=item /path/{-}
1963
1964	add separator
1965
1966	=item /path/{item}{rtext} action
1967
1968	add/alter menu item
1969
1970	=item -/*
1971
1972	remove all menus from the menuBar
1973
1974	=item -/path/menu
1975
1976	remove menu items, separators and submenus from menu
1977
1978	=item -/path/menu
1979
1980	remove menu
1981
1982	=item -/path/{item}
1983
1984	remove item
1985
1986	=item -/path/{-}
1987
1988	remove separator
1989
1990	=item <b>Begin<r>Right<l>Left<u>Up<d>Down<e>End
1991
1992	menu quick arrows
1993
1994	=back
1995	X<XPM>
1996
1997	=head1 XPM
1998
1999	For the XPM XTerm escape sequence B<< C<ESC ] 20 ; Pt ST> >> then value	2056	For the BACKGROUND IMAGE XTerm escape sequence B<< C<ESC ] 20 ; Pt ST> >> the value
2000	of B<< C<Pt> >> can be the name of the background pixmap followed by a	2057	of B<< C<Pt> >> can be the name of the background image file followed by a
2001	sequence of scaling/positioning commands separated by semi-colons. The	2058	sequence of scaling/positioning commands separated by semi-colons. The
2002	scaling/positioning commands are as follows:	2059	scaling/positioning commands are as follows:
2003		2060
2004	=over 4	2061	=over 4
2005		2062
…		…
2043		2100
2044	For example:	2101	For example:
2045		2102
2046	=over 4	2103	=over 4
2047		2104
2048	=item B<\E]20;funky\a>	2105	=item B<\E]20;funky.jpg\a>
2049		2106
2050	load B<funky.xpm> as a tiled image	2107	load B<funky.jpg> as a tiled image
2051		2108
2052	=item B<\E]20;mona;100\a>	2109	=item B<\E]20;mona.jpg;100\a>
2053		2110
2054	load B<mona.xpm> with a scaling of 100%	2111	load B<mona.jpg> with a scaling of 100%
2055		2112
2056	=item B<\E]20;;200;?\a>	2113	=item B<\E]20;;200;?\a>
2057		2114
2058	rescale the current pixmap to 200% and display the image geometry in	2115	rescale the current pixmap to 200% and display the image geometry in
2059	the title	2116	the title
2060		2117
2061	=back	2118	=back
		2119
2062	X<Mouse>	2120	X<Mouse>
2063		2121
2064	=head1 Mouse Reporting	2122	=head1 Mouse Reporting
2065		2123
2066	=over 4	2124	=over 4
…		…
2098	=begin table	2156	=begin table
2099		2157
2100	4 Shift	2158	4 Shift
2101	8 Meta	2159	8 Meta
2102	16 Control	2160	16 Control
2103	32 Double Click I<(Rxvt extension)>	2161	32 Double Click I<(rxvt extension)>
2104		2162
2105	=end table	2163	=end table
2106		2164
2107	Col = B<< C<< <x> - SPACE >> >>	2165	Col = B<< C<< <x> - SPACE >> >>
2108		2166
2109	Row = B<< C<< <y> - SPACE >> >>	2167	Row = B<< C<< <y> - SPACE >> >>
2110		2168
2111	=back	2169	=back
		2170
		2171	=head1 Key Codes
		2172
2112	X<KeyCodes>	2173	X<KeyCodes>
2113
2114	=head1 Key Codes
2115		2174
2116	Note: B<Shift> + B<F1>-B<F10> generates B<F11>-B<F20>	2175	Note: B<Shift> + B<F1>-B<F10> generates B<F11>-B<F20>
2117		2176
2118	For the keypad, use B<Shift> to temporarily override Application-Keypad	2177	For the keypad, use B<Shift> to temporarily override Application-Keypad
2119	setting use B<Num_Lock> to toggle Application-Keypad setting if	2178	setting use B<Num_Lock> to toggle Application-Keypad setting if
…		…
2185	=end table	2244	=end table
2186		2245
2187	=head1 CONFIGURE OPTIONS	2246	=head1 CONFIGURE OPTIONS
2188		2247
2189	General hint: if you get compile errors, then likely your configuration	2248	General hint: if you get compile errors, then likely your configuration
2190	hasn't been tested well. Either try with --enable-everything or use the	2249	hasn't been tested well. Either try with C<--enable-everything> or use
2191	./reconf script as a base for experiments. ./reconf is used by myself,	2250	the default configuration (i.e. no C<--enable-xxx> or C<--disable-xxx>
2192	so it should generally be a working config. Of course, you should always	2251	switches). Of course, you should always report when a combination doesn't
2193	report when a combination doesn't work, so it can be fixed. Marc Lehmann	2252	work, so it can be fixed. Marc Lehmann <rxvt@schmorp.de>.
2194	<rxvt@schmorp.de>.	2253
		2254	All
2195		2255
2196	=over 4	2256	=over 4
2197		2257
2198	=item --enable-everything	2258	=item --enable-everything
2199		2259
2200	Add support for all non-multichoice options listed in "./configure	2260	Add (or remove) support for all non-multichoice options listed in "./configure
2201	--help". Note that unlike other enable options this is order dependant.	2261	--help".
		2262
2202	You can specify this and then disable options which this enables by	2263	You can specify this and then disable options you do not like by
2203	I<following> this with the appropriate commands.	2264	I<following> this with the appropriate C<--disable-...> arguments,
		2265	or you can start with a minimal configuration by specifying
		2266	C<--disable-everything> and than adding just the C<--enable-...> arguments
		2267	you want.
2204		2268
2205	=item --enable-xft	2269	=item --enable-xft (default: enabled)
2206		2270
2207	Add support for Xft (anti-aliases, among others) fonts. Xft fonts are	2271	Add support for Xft (anti-aliases, among others) fonts. Xft fonts are
2208	slower and require lots of memory, but as long as you don't use them, you	2272	slower and require lots of memory, but as long as you don't use them, you
2209	don't pay for them.	2273	don't pay for them.
2210		2274
2211	=item --enable-font-styles	2275	=item --enable-font-styles (default: on)
2212		2276
2213	Add support for B<bold>, I<italic> and B<< I<bold italic> >> font	2277	Add support for B<bold>, I<italic> and B<< I<bold italic> >> font
2214	styles. The fonts can be set manually or automatically.	2278	styles. The fonts can be set manually or automatically.
2215		2279
2216	=item --with-codesets=NAME,...	2280	=item --with-codesets=NAME,... (default: all)
2217		2281
2218	Compile in support for additional codeset (encoding) groups (C<eu>, C<vn>	2282	Compile in support for additional codeset (encoding) groups (C<eu>, C<vn>
2219	are always compiled in, which includes most 8-bit character sets). These	2283	are always compiled in, which includes most 8-bit character sets). These
2220	codeset tables are used for driving X11 core fonts, they are not required	2284	codeset tables are used for driving X11 core fonts, they are not required
2221	for Xft fonts, although having them compiled in lets rxvt-unicode choose	2285	for Xft fonts, although having them compiled in lets rxvt-unicode choose
…		…
2225		2289
2226	=begin table	2290	=begin table
2227		2291
2228	all all available codeset groups	2292	all all available codeset groups
2229	zh common chinese encodings	2293	zh common chinese encodings
2230	zh_ext rarely used but very big chinese encodigs	2294	zh_ext rarely used but very big chinese encodings
2231	jp common japanese encodings	2295	jp common japanese encodings
2232	jp_ext rarely used but big japanese encodings	2296	jp_ext rarely used but big japanese encodings
2233	kr korean encodings	2297	kr korean encodings
2234		2298
2235	=end table	2299	=end table
2236		2300
2237	=item --enable-xim	2301	=item --enable-xim (default: on)
2238		2302
2239	Add support for XIM (X Input Method) protocol. This allows using	2303	Add support for XIM (X Input Method) protocol. This allows using
2240	alternative input methods (e.g. kinput2) and will also correctly	2304	alternative input methods (e.g. kinput2) and will also correctly
2241	set up the input for people using dead keys or compose keys.	2305	set up the input for people using dead keys or compose keys.
2242		2306
2243	=item --enable-unicode3	2307	=item --enable-unicode3 (default: off)
		2308
		2309	Recommended to stay off unless you really need non-BMP characters.
2244		2310
2245	Enable direct support for displaying unicode codepoints above	2311	Enable direct support for displaying unicode codepoints above
2246	65535 (the basic multilingual page). This increases storage	2312	65535 (the basic multilingual page). This increases storage
2247	requirements per character from 2 to 4 bytes. X11 fonts do not yet	2313	requirements per character from 2 to 4 bytes. X11 fonts do not yet
2248	support these extra characters, but Xft does.	2314	support these extra characters, but Xft does.
2249		2315
2250	Please note that rxvt-unicode can store unicode code points >65535	2316	Please note that rxvt-unicode can store unicode code points >65535
2251	even without this flag, but the number of such characters is	2317	even without this flag, but the number of such characters is
2252	limited to a view thousand (shared with combining characters,	2318	limited to a few thousand (shared with combining characters,
2253	see next switch), and right now rxvt-unicode cannot display them	2319	see next switch), and right now rxvt-unicode cannot display them
2254	(input/output and cut&paste still work, though).	2320	(input/output and cut&paste still work, though).
2255		2321
2256	=item --enable-combining	2322	=item --enable-combining (default: on)
2257		2323
2258	Enable automatic composition of combining characters into	2324	Enable automatic composition of combining characters into
2259	composite characters. This is required for proper viewing of text	2325	composite characters. This is required for proper viewing of text
2260	where accents are encoded as seperate unicode characters. This is	2326	where accents are encoded as seperate unicode characters. This is
2261	done by using precomposited characters when available or creating	2327	done by using precomposited characters when available or creating
2262	new pseudo-characters when no precomposed form exists.	2328	new pseudo-characters when no precomposed form exists.
2263		2329
2264	Without --enable-unicode3, the number of additional precomposed characters	2330	Without --enable-unicode3, the number of additional precomposed
2265	is rather limited (2048, if this is full, rxvt-unicode will use the	2331	characters is somewhat limited (the 6400 private use characters will be
2266	private use area, extending the number of combinations to 8448). With
2267	--enable-unicode3, no practical limit exists.	2332	(ab-)used). With --enable-unicode3, no practical limit exists.
2268		2333
2269	This option will also enable storage (but not display) of characters	2334	This option will also enable storage (but not display) of characters
2270	beyond plane 0 (>65535) when --enable-unicode3 was not specified.	2335	beyond plane 0 (>65535) when --enable-unicode3 was not specified.
2271		2336
2272	The combining table also contains entries for arabic presentation forms,	2337	The combining table also contains entries for arabic presentation forms,
2273	but these are not currently used. Bug me if you want these to be used (and	2338	but these are not currently used. Bug me if you want these to be used (and
2274	tell me how these are to be used...).	2339	tell me how these are to be used...).
2275		2340
2276	=item --enable-fallback(=CLASS)	2341	=item --enable-fallback(=CLASS) (default: Rxvt)
2277		2342
2278	When reading resource settings, also read settings for class CLASS	2343	When reading resource settings, also read settings for class CLASS. To
2279	(default: Rxvt). To disable resource fallback use --disable-fallback.	2344	disable resource fallback use --disable-fallback.
2280		2345
2281	=item --with-res-name=NAME	2346	=item --with-res-name=NAME (default: urxvt)
2282		2347
2283	Use the given name (default: urxvt) as default application name when	2348	Use the given name as default application name when
2284	reading resources. Specify --with-res-name=rxvt to replace rxvt.	2349	reading resources. Specify --with-res-name=rxvt to replace rxvt.
2285		2350
2286	=item --with-res-class=CLASS	2351	=item --with-res-class=CLASS (default: URxvt)
2287		2352
2288	Use the given class (default: URxvt) as default application class	2353	Use the given class as default application class
2289	when reading resources. Specify --with-res-class=Rxvt to replace	2354	when reading resources. Specify --with-res-class=Rxvt to replace
2290	rxvt.	2355	rxvt.
2291		2356
2292	=item --enable-utmp	2357	=item --enable-utmp (default: on)
2293		2358
2294	Write user and tty to utmp file (used by programs like F<w>) at	2359	Write user and tty to utmp file (used by programs like F<w>) at
2295	start of rxvt execution and delete information when rxvt exits.	2360	start of rxvt execution and delete information when rxvt exits.
2296		2361
2297	=item --enable-wtmp	2362	=item --enable-wtmp (default: on)
2298		2363
2299	Write user and tty to wtmp file (used by programs like F<last>) at	2364	Write user and tty to wtmp file (used by programs like F<last>) at
2300	start of rxvt execution and write logout when rxvt exits. This	2365	start of rxvt execution and write logout when rxvt exits. This
2301	option requires --enable-utmp to also be specified.	2366	option requires --enable-utmp to also be specified.
2302		2367
2303	=item --enable-lastlog	2368	=item --enable-lastlog (default: on)
2304		2369
2305	Write user and tty to lastlog file (used by programs like	2370	Write user and tty to lastlog file (used by programs like
2306	F<lastlogin>) at start of rxvt execution. This option requires	2371	F<lastlogin>) at start of rxvt execution. This option requires
2307	--enable-utmp to also be specified.	2372	--enable-utmp to also be specified.
2308		2373
2309	=item --enable-xpm-background	2374	=item --enable-afterimage (default: on)
2310		2375
2311	Add support for XPM background pixmaps.	2376	Add support for libAfterImage to be used for transparency and background
		2377	images. It adds support for many file formats including JPG, PNG,
		2378	SVG, TIFF, GIF, XPM, BMP, ICO, XCF, TGA and AfterStep image XML
		2379	(L<http://www.afterstep.org/visualdoc.php?show=asimagexml>).
2312		2380
		2381	This option also adds such eye candy as blending an image over the root
		2382	background, as well as dynamic scaling and bluring of background images.
		2383
		2384	Note that with this option enabled, @@RXVT_NAME@@'s memory footprint might
		2385	increase by a few megabytes even if no extra features are used (mostly due
		2386	to third-party libraries used by libAI). Memory footprint may somewhat be
		2387	lowered if libAfterImage is configured without support for SVG.
		2388
2313	=item --enable-transparency	2389	=item --enable-transparency (default: on)
2314		2390
2315	Add support for inheriting parent backgrounds thus giving a fake	2391	Add support for backgrounds, creating illusion of transparency in the term.
2316	transparency to the term.
2317		2392
2318	=item --enable-fading	2393	=item --enable-fading (default: on)
2319		2394
2320	Add support for fading the text when focus is lost.	2395	Add support for fading the text when focus is lost.
2321		2396
2322	=item --enable-tinting
2323
2324	Add support for tinting of transparent backgrounds.
2325
2326	=item --enable-menubar
2327
2328	Add support for our menu bar system (this interacts badly with
2329	dynamic locale switching currently).
2330
2331	=item --enable-rxvt-scroll	2397	=item --enable-rxvt-scroll (default: on)
2332		2398
2333	Add support for the original rxvt scrollbar.	2399	Add support for the original rxvt scrollbar.
2334		2400
2335	=item --enable-next-scroll	2401	=item --enable-next-scroll (default: on)
2336		2402
2337	Add support for a NeXT-like scrollbar.	2403	Add support for a NeXT-like scrollbar.
2338		2404
2339	=item --enable-xterm-scroll	2405	=item --enable-xterm-scroll (default: on)
2340		2406
2341	Add support for an Xterm-like scrollbar.	2407	Add support for an Xterm-like scrollbar.
2342		2408
2343	=item --enable-plain-scroll
2344
2345	Add support for a very unobtrusive, plain-looking scrollbar that
2346	is the favourite of the rxvt-unicode author, having used it for
2347	many years.
2348
2349	=item --enable-half-shadow
2350
2351	Make shadows on the scrollbar only half the normal width & height.
2352	only applicable to rxvt scrollbars.
2353
2354	=item --enable-ttygid
2355
2356	Change tty device setting to group "tty" - only use this if
2357	your system uses this type of security.
2358
2359	=item --disable-backspace-key	2409	=item --disable-backspace-key
2360		2410
2361	Disable any handling of the backspace key by us - let the X server	2411	Removes any handling of the backspace key by us - let the X server do it.
		2412
		2413	=item --disable-delete-key
		2414
		2415	Removes any handling of the delete key by us - let the X server
2362	do it.	2416	do it.
2363		2417
2364	=item --disable-delete-key
2365
2366	Disable any handling of the delete key by us - let the X server
2367	do it.
2368
2369	=item --disable-resources	2418	=item --disable-resources
2370		2419
2371	Remove all resources checking.	2420	Removes any support for resource checking.
2372
2373	=item --enable-xgetdefault
2374
2375	Make resources checking via XGetDefault() instead of our small
2376	version which only checks ~/.Xdefaults, or if that doesn't exist then
2377	~/.Xresources.
2378
2379	Please note that nowadays, things like XIM will automatically pull in and
2380	use the full X resource manager, so the overhead of using it might be very
2381	small, if nonexistant.
2382
2383	=item --enable-strings
2384
2385	Add support for our possibly faster memset() function and other
2386	various routines, overriding your system's versions which may
2387	have been hand-crafted in assembly or may require extra libraries
2388	to link in. (this breaks ANSI-C rules and has problems on many
2389	GNU/Linux systems).
2390		2421
2391	=item --disable-swapscreen	2422	=item --disable-swapscreen
2392		2423
2393	Remove support for swap screen.	2424	Remove support for secondary/swap screen.
2394		2425
2395	=item --enable-frills	2426	=item --enable-frills (default: on)
2396		2427
2397	Add support for many small features that are not essential but nice to	2428	Add support for many small features that are not essential but nice to
2398	have. Normally you want this, but for very small binaries you may want to	2429	have. Normally you want this, but for very small binaries you may want to
2399	disable this.	2430	disable this.
2400		2431
2401	A non-exhaustive list of features enabled by C<--enable-frills> (possibly	2432	A non-exhaustive list of features enabled by C<--enable-frills> (possibly
2402	in combination with other switches) is:	2433	in combination with other switches) is:
2403		2434
2404	MWM-hints	2435	MWM-hints
2405	EWMH-hints (pid, utf8 names) and protocols (ping)	2436	EWMH-hints (pid, utf8 names) and protocols (ping)
		2437	urgency hint
2406	seperate underline colour	2438	seperate underline colour (-underlineColor)
2407	settable border widths and borderless switch	2439	settable border widths and borderless switch (-w, -b, -bl)
		2440	visual depth selection (-depth)
2408	settable extra linespacing	2441	settable extra linespacing /-lsp)
2409	iso-14755-2 and -3, and visual feedback	2442	iso-14755 5.1 (basic) support
		2443	tripleclickwords (-tcw)
		2444	settable insecure mode (-insecure)
		2445	keysym remapping support
		2446	cursor blinking and underline cursor (-bc, -uc)
		2447	XEmbed support (-embed)
		2448	user-pty (-pty-fd)
		2449	hold on exit (-hold)
		2450	compile in built-in block graphics
		2451	skip builtin block graphics (-sbg)
		2452	separate highlightcolor support (-hc)
		2453
		2454	It also enables some non-essential features otherwise disabled, such as:
		2455
		2456	some round-trip time optimisations
		2457	nearest color allocation on pseudocolor screens
		2458	UTF8_STRING support for selection
		2459	sgr modes 90..97 and 100..107
2410	backindex and forwardindex escape sequence	2460	backindex and forwardindex escape sequences
		2461	view change/zero scrollback escape sequences
		2462	locale switching escape sequence
2411	window op and some xterm/OSC escape sequences	2463	window op and some xterm/OSC escape sequences
2412	tripleclickwords	2464	rectangular selections
2413	settable insecure mode	2465	trailing space removal for selections
2414	keysym remapping support	2466	verbose X error handling
2415	cursor blinking and underline cursor
2416	-embed and -pty-fd options
2417		2467
2418	=item --enable-iso14755	2468	=item --enable-iso14755 (default: on)
2419		2469
2420	Enable extended ISO 14755 support (see @@RXVT_NAME@@(1), or	2470	Enable extended ISO 14755 support (see @@RXVT_NAME@@(1)).
2421	F<doc/rxvt.1.txt>). Basic support (section 5.1) is enabled by	2471	Basic support (section 5.1) is enabled by C<--enable-frills>, while
2422	C<--enable-frills>, while support for 5.2, 5.3 and 5.4 is enabled with	2472	support for 5.2, 5.3 and 5.4 is enabled with this switch.
2423	this switch.
2424		2473
2425	=item --enable-keepscrolling	2474	=item --enable-keepscrolling (default: on)
2426		2475
2427	Add support for continual scrolling of the display when you hold	2476	Add support for continual scrolling of the display when you hold
2428	the mouse button down on a scrollbar arrow.	2477	the mouse button down on a scrollbar arrow.
2429		2478
		2479	=item --enable-selectionscrolling (default: on)
		2480
		2481	Add support for scrolling when the selection moves to the top or
		2482	bottom of the screen.
		2483
2430	=item --enable-mousewheel	2484	=item --enable-mousewheel (default: on)
2431		2485
2432	Add support for scrolling via mouse wheel or buttons 4 & 5.	2486	Add support for scrolling via mouse wheel or buttons 4 & 5.
2433		2487
2434	=item --enable-slipwheeling	2488	=item --enable-slipwheeling (default: on)
2435		2489
2436	Add support for continual scrolling (using the mouse wheel as an	2490	Add support for continual scrolling (using the mouse wheel as an
2437	accelerator) while the control key is held down. This option	2491	accelerator) while the control key is held down. This option
2438	requires --enable-mousewheel to also be specified.	2492	requires --enable-mousewheel to also be specified.
2439		2493
2440	=item --disable-new-selection
2441
2442	Remove support for mouse selection style like that of xterm.
2443
2444	=item --enable-dmalloc
2445
2446	Use Gray Watson's malloc - which is good for debugging See
2447	http://www.letters.com/dmalloc/ for details If you use either this or the
2448	next option, you may need to edit src/Makefile after compiling to point
2449	DINCLUDE and DLIB to the right places.
2450
2451	You can only use either this option and the following (should
2452	you use either) .
2453
2454	=item --enable-dlmalloc
2455
2456	Use Doug Lea's malloc - which is good for a production version
2457	See L<http://g.oswego.edu/dl/html/malloc.html> for details.
2458
2459	=item --enable-smart-resize	2494	=item --enable-smart-resize (default: off)
2460		2495
2461	Add smart growth/shrink behaviour when changing font size via from hot	2496	Add smart growth/shrink behaviour when resizing.
2462	keys. This should keep in a fixed position the rxvt corner which is	2497	This should keep the window corner which is closest to a corner of
2463	closest to a corner of the screen.	2498	the screen in a fixed position.
2464		2499
		2500	=item --enable-text-blink (default: on)
		2501
		2502	Add support for blinking text.
		2503
2465	=item --enable-pointer-blank	2504	=item --enable-pointer-blank (default: on)
2466		2505
2467	Add support to have the pointer disappear when typing or inactive.	2506	Add support to have the pointer disappear when typing or inactive.
2468		2507
2469	=item --with-name=NAME	2508	=item --enable-perl (default: on)
2470		2509
		2510	Enable an embedded perl interpreter. See the B<@@RXVT_NAME@@perl(3)>
		2511	manpage for more info on this feature, or the files in F<src/perl/>
		2512	for the extensions that are installed by default.
		2513	The perl interpreter that is used can be specified via the C<PERL>
		2514	environment variable when running configure. Even when compiled in,
		2515	perl will I<not> be initialised when all extensions have been disabled
		2516	C<-pe "" --perl-ext-common "">, so it should be safe to enable from a
		2517	resource standpoint.
		2518
		2519	=item --with-afterimage-config=DIR
		2520
		2521	Look for the libAfterImage config script in DIR.
		2522
		2523	=item --with-name=NAME (default: urxvt)
		2524
2471	Set the basename for the installed binaries (default: C<urxvt>, resulting	2525	Set the basename for the installed binaries, resulting
2472	in C<urxvt>, C<urxvtd> etc.). Specify C<--with-name=rxvt> to replace with	2526	in C<urxvt>, C<urxvtd> etc.). Specify C<--with-name=rxvt> to replace with
2473	C<rxvt>.	2527	C<rxvt>.
2474		2528
2475	=item --with-term=NAME	2529	=item --with-term=NAME (default: rxvt-unicode)
2476		2530
2477	Change the environmental variable for the terminal to NAME (default	2531	Change the environmental variable for the terminal to NAME.
2478	C<rxvt-unicode>)
2479		2532
2480	=item --with-terminfo=PATH	2533	=item --with-terminfo=PATH
2481		2534
2482	Change the environmental variable for the path to the terminfo tree to	2535	Change the environmental variable for the path to the terminfo tree to
2483	PATH.	2536	PATH.
2484		2537
2485	=item --with-x	2538	=item --with-x
2486		2539
2487	Use the X Window System (pretty much default, eh?).	2540	Use the X Window System (pretty much default, eh?).
2488
2489	=item --with-xpm-includes=DIR
2490
2491	Look for the XPM includes in DIR.
2492
2493	=item --with-xpm-library=DIR
2494
2495	Look for the XPM library in DIR.
2496
2497	=item --with-xpm
2498
2499	Not needed - define via --enable-xpm-background.
2500		2541
2501	=back	2542	=back
2502		2543
2503	=head1 AUTHORS	2544	=head1 AUTHORS
2504		2545

Diff Legend

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

Comparing rxvt-unicode/doc/rxvt.7.pod (file contents): Revision 1.57 by root, Wed Jul 13 01:24:09 2005 UTC vs. Revision 1.177 by root, Sat May 30 08:53:48 2009 UTC

Diff Legend

Comparing rxvt-unicode/doc/rxvt.7.pod (file contents):
Revision 1.57 by root, Wed Jul 13 01:24:09 2005 UTC vs.
Revision 1.177 by root, Sat May 30 08:53:48 2009 UTC