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

Comparing rxvt-unicode/doc/rxvt.7.pod (file contents):
Revision 1.52 by root, Sat Mar 19 02:27:26 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 My Compose (Multi_key) key is no longer working.
264
265	The most common causes for this are that either your locale is not set
266	correctly, or you specified a B<preeditStyle> that is not supported by
267	your input method. For example, if you specified B<OverTheSpot> and
268	your input method (e.g. the default input method handling Compose keys)
269	does not support this (for instance because it is not visual), then
270	rxvt-unicode will continue without an input method.
271
272	In this case either do not specify a B<preeditStyle> or specify more than
273	one pre-edit style, such as B<OverTheSpot,Root,None>.
274
275	=item I cannot type C<Ctrl-Shift-2> to get an ASCII NUL character due to ISO 14755
276
277	Either try C<Ctrl-2> alone (it often is mapped to ASCII NUL even on
278	international keyboards) or simply use ISO 14755 support to your
279	advantage, typing <Ctrl-Shift-0> to get a ASCII NUL. This works for other
280	codes, too, such as C<Ctrl-Shift-1-d> to type the default telnet escape
281	character and so on.
282
283	=item How can I keep rxvt-unicode from using reverse video so much?
284
285	First of all, make sure you are running with the right terminal settings
286	(C<TERM=rxvt-unicode>), which will get rid of most of these effects. Then
287	make sure you have specified colours for italic and bold, as otherwise
288	rxvt-unicode might use reverse video to simulate the effect:
289
290	URxvt.colorBD: white
291	URxvt.colorIT: green
292
293	=item Some programs assume totally weird colours (red instead of blue), how can I fix that?
294
295	For some unexplainable reason, some rare programs assume a very weird
296	colour palette when confronted with a terminal with more than the standard
297	8 colours (rxvt-unicode supports 88). The right fix is, of course, to fix
298	these programs not to assume non-ISO colours without very good reasons.
299
300	In the meantime, you can either edit your C<rxvt-unicode> terminfo
301	definition to only claim 8 colour support or use C<TERM=rxvt>, which will
302	fix colours but keep you from using other rxvt-unicode features.
303
304	=item I am on FreeBSD and rxvt-unicode does not seem to work at all.
305
306	Rxvt-unicode requires the symbol C<__STDC_ISO_10646__> to be defined
307	in your compile environment, or an implementation that implements it,
308	wether it defines the symbol or not. C<__STDC_ISO_10646__> requires that
309	B<wchar_t> is represented as unicode.
310
311	As you might have guessed, FreeBSD does neither define this symobl nor
312	does it support it. Instead, it uses it's own internal representation of
313	B<wchar_t>. This is, of course, completely fine with respect to standards.
314
315	However, that means rxvt-unicode only works in C<POSIX>, C<ISO-8859-1> and
316	C<UTF-8> locales under FreeBSD (which all use Unicode as B<wchar_t>.
317
318	C<__STDC_ISO_10646__> is the only sane way to support multi-language
319	apps in an OS, as using a locale-dependent (and non-standardized)
320	representation of B<wchar_t> makes it impossible to convert between
321	B<wchar_t> (as used by X11 and your applications) and any other encoding
322	without implementing OS-specific-wrappers for each and every locale. There
323	simply are no APIs to convert B<wchar_t> into anything except the current
324	locale encoding.
325
326	Some applications (such as the formidable B<mlterm>) work around this
327	by carrying their own replacement functions for character set handling
328	with them, and either implementing OS-dependent hacks or doing multiple
329	conversions (which is slow and unreliable in case the OS implements
330	encodings slightly different than the terminal emulator).
331
332	The rxvt-unicode author insists that the right way to fix this is in the
333	system libraries once and for all, instead of forcing every app to carry
334	complete replacements for them :)
335
336	=item How does rxvt-unicode determine the encoding to use?
337
338	=item Is there an option to switch encodings?
339
340	Unlike some other terminals, rxvt-unicode has no encoding switch, and no
341	specific "utf-8" mode, such as xterm. In fact, it doesn't even know about
342	UTF-8 or any other encodings with respect to terminal I/O.
343
344	The reasons is that there exists a perfectly fine mechanism for selecting
345	the encoding, doing I/O and (most important) communicating this to all
346	applications so everybody agrees on character properties such as width
347	and code number. This mechanism is the I<locale>. Applications not using
348	that info will have problems (for example, C<xterm> gets the width of
349	characters wrong as it uses it's own, locale-independent table under all
350	locales).
351
352	Rxvt-unicode uses the C<LC_CTYPE> locale category to select encoding. All
353	programs doing the same (that is, most) will automatically agree in the
354	interpretation of characters.
355
356	Unfortunately, there is no system-independent way to select locales, nor
357	is there a standard on how locale specifiers will look like.
358
359	On most systems, the content of the C<LC_CTYPE> environment variable
360	contains an arbitrary string which corresponds to an already-installed
361	locale. Common names for locales are C<en_US.UTF-8>, C<de_DE.ISO-8859-15>,
362	C<ja_JP.EUC-JP>, i.e. C<language_country.encoding>, but other forms
363	(i.e. C<de> or C<german>) are also common.
364
365	Rxvt-unicode ignores all other locale categories, and except for
366	the encoding, ignores country or language-specific settings,
367	i.e. C<de_DE.UTF-8> and C<ja_JP.UTF-8> are the normally same to
368	rxvt-unicode.
369
370	If you want to use a specific encoding you have to make sure you start
371	rxvt-unicode with the correct C<LC_CTYPE> category.
372
373	=item Can I switch locales at runtime?
374
375	Yes, using an escape sequence. Try something like this, which sets
376	rxvt-unicode's idea of C<LC_CTYPE>.
377
378	printf '\e]701;%s\007' ja_JP.SJIS
379
380	See also the previous answer.
381
382	Sometimes this capability is rather handy when you want to work in
383	one locale (e.g. C<de_DE.UTF-8>) but some programs don't support it
384	(e.g. UTF-8). For example, I use this script to start C<xjdic>, which
385	first switches to a locale supported by xjdic and back later:
386
387	printf '\e]701;%s\007' ja_JP.SJIS
388	xjdic -js
389	printf '\e]701;%s\007' de_DE.UTF-8
390
391	You can also use xterm's C<luit> program, which usually works fine, except
392	for some locales where character width differs between program- and
393	rxvt-unicode-locales.
394
395	=item Can I switch the fonts at runtime?
396
397	Yes, using an escape sequence. Try something like this, which has the same
398	effect as using the C<-fn> switch, and takes effect immediately:
399
400	printf '\e]50;%s\007' "9x15bold,xft:Kochi Gothic"
401
402	This is useful if you e.g. work primarily with japanese (and prefer a
403	japanese font), but you have to switch to chinese temporarily, where
404	japanese fonts would only be in your way.
405
406	You can think of this as a kind of manual ISO-2022 switching.
407
408	=item Why do italic characters look as if clipped?
409
410	Many fonts have difficulties with italic characters and hinting. For
411	example, the otherwise very nicely hinted font C<xft:Bitstream Vera Sans
412	Mono> completely fails in it's italic face. A workaround might be to
413	enable freetype autohinting, i.e. like this:
414
415	URxvt.italicFont: xft:Bitstream Vera Sans Mono:italic:autohint=true
416	URxvt.boldItalicFont: xft:Bitstream Vera Sans Mono:bold:italic:autohint=true
417
418	=item My input method wants <some encoding> but I want UTF-8, what can I do?
419
420	You can specify separate locales for the input method and the rest of the
421	terminal, using the resource C<imlocale>:
422
423	URxvt*imlocale: ja_JP.EUC-JP
424
425	Now you can start your terminal with C<LC_CTYPE=ja_JP.UTF-8> and still
426	use your input method. Please note, however, that you will not be able to
427	input characters outside C<EUC-JP> in a normal way then, as your input
428	method limits you.
429
430	=item Rxvt-unicode crashes when the X Input Method changes or exits.
431
432	Unfortunately, this is unavoidable, as the XIM protocol is racy by
433	design. Applications can avoid some crashes at the expense of memory
434	leaks, and Input Methods can avoid some crashes by careful ordering at
435	exit time. B<kinput2> (and derived input methods) generally succeeds,
436	while B<SCIM> (or similar input methods) fails. In the end, however,
437	crashes cannot be completely avoided even if both sides cooperate.
438
439	So the only workaround is not to kill your Input Method Servers.
440
441	=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?
442		74
443	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
444	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
445	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,
446	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
…		…
451	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
452	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)
453	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
454	rxvt-unicode then uses 8 bytes per screen cell.	86	rxvt-unicode then uses 8 bytes per screen cell.
455		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
456	=item Can I speed up Xft rendering somehow?	339	=head3 Can I speed up Xft rendering somehow?
457		340
458	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
459	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
460	antialiasing (by appending C<:antialiasing=false>), which saves lots of	343	antialiasing (by appending C<:antialias=false>), which saves lots of
461	memory and also speeds up rendering considerably.	344	memory and also speeds up rendering considerably.
462		345
463	=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?
464		347
465	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
466	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
467	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
468	antialiasing disabled for most of them, because the author thinks they	351	antialiasing disabled for most of them, because the author thinks they
469	look best that way.	352	look best that way.
470		353
471	If you want antialiasing, you have to specify the fonts manually.	354	If you want antialiasing, you have to specify the fonts manually.
472		355
473	=item Mouse cut/paste suddenly no longer works.
474
475	Make sure that mouse reporting is actually turned off since killing
476	some editors prematurely may leave the mouse in mouse report mode. I've
477	heard that tcsh may use mouse reporting unless it otherwise specified. A
478	quick check is to see if cut/paste works when the Alt or Shift keys are
479	depressed. See @@RXVT_NAME@@(7)
480
481	=item What's with this bold/blink stuff?	356	=head3 What's with this bold/blink stuff?
482		357
483	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
484	standard foreground colour.	359	standard foreground colour.
485		360
486	For the standard background colour, blinking will actually make the	361	For the standard background colour, blinking will actually make
487	text blink when compiled with C<--enable-blinking>. with standard	362	the text blink when compiled with C<--enable-text-blink>. Without
488	colours. Without C<--enable-blinking>, the blink attribute will be	363	C<--enable-text-blink>, the blink attribute will be ignored.
489	ignored.
490		364
491	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
492	foreground/background colors.	366	foreground/background colors.
493		367
494	color0-7 are the low-intensity colors.	368	color0-7 are the low-intensity colors.
495		369
496	color8-15 are the corresponding high-intensity colors.	370	color8-15 are the corresponding high-intensity colors.
497		371
498	=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?
499		373
500	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>
501	resources (or as long-options).	375	resources (or as long-options).
502		376
503	Here are values that are supposed to resemble a VGA screen,	377	Here are values that are supposed to resemble a VGA screen,
…		…
519	URxvt.color12: #0000FF	393	URxvt.color12: #0000FF
520	URxvt.color13: #FF00FF	394	URxvt.color13: #FF00FF
521	URxvt.color14: #00FFFF	395	URxvt.color14: #00FFFF
522	URxvt.color15: #FFFFFF	396	URxvt.color15: #FFFFFF
523		397
524	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.
525	me) as "pretty girly".
526		399
527	URxvt.cursorColor: #dc74d1	400	URxvt.cursorColor: #dc74d1
528	URxvt.pointerColor: #dc74d1	401	URxvt.pointerColor: #dc74d1
529	URxvt.background: #0e0e0e	402	URxvt.background: #0e0e0e
530	URxvt.foreground: #4ad5e1	403	URxvt.foreground: #4ad5e1
…		…
541	URxvt.color6: #73f7ff	414	URxvt.color6: #73f7ff
542	URxvt.color14: #73f7ff	415	URxvt.color14: #73f7ff
543	URxvt.color7: #e1dddd	416	URxvt.color7: #e1dddd
544	URxvt.color15: #e1dddd	417	URxvt.color15: #e1dddd
545		418
546	=item How can I start @@RXVT_NAME@@d in a race-free way?	419	They have been described (not by me) as "pretty girly".
547		420
548	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?
549	server that answers @@RXVT_NAME@@c's requests, so it doesn't background
550	itself.
551		422
552	To ensure @@RXVT_NAME@@d is listening on it's socket, you can use the	423	See next entry.
553	following method to wait for the startup message before continuing:
554		424
555	{ @@RXVT_NAME@@d & } \| read	425	=head3 How does rxvt-unicode choose fonts?
556		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
557	=item What's with the strange Backspace/Delete key behaviour?	579	=head3 What's with the strange Backspace/Delete key behaviour?
558		580
559	Assuming that the physical Backspace key corresponds to the	581	Assuming that the physical Backspace key corresponds to the
560	BackSpace keysym (not likely for Linux ... see the following	582	Backspace keysym (not likely for Linux ... see the following
561	question) there are two standard values that can be used for	583	question) there are two standard values that can be used for
562	Backspace: C<^H> and C<^?>.	584	Backspace: C<^H> and C<^?>.
563		585
564	Historically, either value is correct, but rxvt-unicode adopts the debian	586	Historically, either value is correct, but rxvt-unicode adopts the debian
565	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
566	choice :).	588	choice :).
567		589
568	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
569	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
570	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
…		…
573		595
574	For starting a new rxvt-unicode:	596	For starting a new rxvt-unicode:
575		597
576	# use Backspace = ^H	598	# use Backspace = ^H
577	$ stty erase ^H	599	$ stty erase ^H
578	$ @@RXVT_NAME@@	600	$ @@URXVT_NAME@@
579		601
580	# use Backspace = ^?	602	# use Backspace = ^?
581	$ stty erase ^?	603	$ stty erase ^?
582	$ @@RXVT_NAME@@	604	$ @@URXVT_NAME@@
583		605
584	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>.
585		607
586	For an existing rxvt-unicode:	608	For an existing rxvt-unicode:
587		609
588	# use Backspace = ^H	610	# use Backspace = ^H
589	$ stty erase ^H	611	$ stty erase ^H
…		…
608	some editors (vim I'm told) expect Backspace = ^H,	630	some editors (vim I'm told) expect Backspace = ^H,
609	GNU Emacs (and Emacs-like editors) use ^H for help.	631	GNU Emacs (and Emacs-like editors) use ^H for help.
610		632
611	Perhaps someday this will all be resolved in a consistent manner.	633	Perhaps someday this will all be resolved in a consistent manner.
612		634
613	=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?
614		636
615	There are some compile-time selections available via configure. Unless	637	There are some compile-time selections available via configure. Unless
616	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
617	use the `keysym' resource to alter the keystrings associated with keysyms.	639	use the `keysym' resource to alter the keystrings associated with keysyms.
618		640
619	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>
620		642
621	URxvt.keysym.Home: \033[1~	643	URxvt.keysym.Home: \033[1~
622	URxvt.keysym.End: \033[4~	644	URxvt.keysym.End: \033[4~
623	URxvt.keysym.C-apostrophe: \033<C-'>	645	URxvt.keysym.C-apostrophe: \033<C-'>
624	URxvt.keysym.C-slash: \033<C-/>	646	URxvt.keysym.C-slash: \033<C-/>
…		…
639	URxvt.keysym.M-C-a: list \033<M-C- abcdefghijklmnopqrstuvwxyz >	661	URxvt.keysym.M-C-a: list \033<M-C- abcdefghijklmnopqrstuvwxyz >
640	URxvt.keysym.F12: command:\033]701;zh_CN.GBK\007	662	URxvt.keysym.F12: command:\033]701;zh_CN.GBK\007
641		663
642	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.
643		665
644	=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
645	How do I make use of them? For example, the Sun Keyboard type 4
646	has the following mappings that rxvt-unicode doesn't recognize.
647		667
648	KP_Insert == Insert	668	KP_Insert == Insert
649	F22 == Print	669	F22 == Print
650	F27 == Home	670	F27 == Home
651	F29 == Prior	671	F29 == Prior
…		…
654		674
655	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
656	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
657	required for your particular machine.	677	required for your particular machine.
658		678
659	=item How do I distinguish wether I'm running rxvt-unicode or a regular xterm?
660	I need this to decide about setting colors etc.
661		679
662	rxvt and rxvt-unicode always export the variable "COLORTERM", so you can	680	=head2 Terminal Configuration
663	check and see if that is set. Note that several programs, JED, slrn,
664	Midnight Commander automatically check this variable to decide whether or
665	not to use color.
666		681
667	=item How do I set the correct, full IP address for the DISPLAY variable?	682	=head3 Can I see a typical configuration?
668		683
669	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
670	insecure mode then it is possible to use the following shell script	685	much, but it's least surprise to regular users.
671	snippets to correctly set the display. If your version of rxvt-unicode
672	wasn't also compiled with ESCZ_ANSWER (as assumed in these snippets) then
673	the COLORTERM variable can be used to distinguish rxvt-unicode from a
674	regular xterm.
675		686
676	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
677	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...
678		691
679	# Bourne/Korn/POSIX family of shells:	692	URxvt.cutchars: "()*,<>[]{}\|'
680	[ ${TERM:-foo} = foo ] && TERM=xterm # assume an xterm if we don't know	693	URxvt.print-pipe: cat >/tmp/xxx
681	if [ ${TERM:-foo} = xterm ]; then
682	stty -icanon -echo min 0 time 15 # see if enhanced rxvt or not
683	echo -n '^[Z'
684	read term_id
685	stty icanon echo
686	if [ ""${term_id} = '^[[?1;2C' -a ${DISPLAY:-foo} = foo ]; then
687	echo -n '^[[7n' # query the rxvt we are in for the DISPLAY string
688	read DISPLAY # set it in our local shell
689	fi
690	fi
691		694
692	=item How do I compile the manual pages for myself?	695	These are just for testing stuff.
693		696
694	You need to have a recent version of perl installed as F</usr/bin/perl>,	697	URxvt.imLocale: ja_JP.UTF-8
695	one that comes with F<pod2man>, F<pod2text> and F<pod2html>. Then go to	698	URxvt.preeditType: OnTheSpot,None
696	the doc subdirectory and enter C<make alldoc>.
697		699
698	=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.
699		704
700	Before sending me mail, you could go to IRC: C<irc.freenode.net>,	705	URxvt.perl-lib: /root/lib/urxvt
701	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
702	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
703		1080
704	=back	1081	=back
705		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
706	=head1 RXVT TECHNICAL REFERENCE	1226	=head1 RXVT-UNICODE TECHNICAL REFERENCE
707
708	=head1 DESCRIPTION
709		1227
710	The rest of this document describes various technical aspects of	1228	The rest of this document describes various technical aspects of
711	B<rxvt-unicode>. First the description of supported command sequences,	1229	B<rxvt-unicode>. First the description of supported command sequences,
712	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
713	features selectable at C<configure> time.	1231	selectable at C<configure> time.
714		1232
715	=head1 Definitions	1233	=head2 Definitions
716		1234
717	=over 4	1235	=over 4
718		1236
719	=item B<< C<c> >>	1237	=item B<< C<c> >>
720		1238
…		…
738		1256
739	A text parameter composed of printable characters.	1257	A text parameter composed of printable characters.
740		1258
741	=back	1259	=back
742		1260
743	=head1 Values	1261	=head2 Values
744		1262
745	=over 4	1263	=over 4
746		1264
747	=item B<< C<ENQ> >>	1265	=item B<< C<ENQ> >>
748		1266
…		…
791		1309
792	Space Character	1310	Space Character
793		1311
794	=back	1312	=back
795		1313
796	=head1 Escape Sequences	1314	=head2 Escape Sequences
797		1315
798	=over 4	1316	=over 4
799		1317
800	=item B<< C<ESC # 8> >>	1318	=item B<< C<ESC # 8> >>
801		1319
…		…
899		1417
900	=back	1418	=back
901		1419
902	X<CSI>	1420	X<CSI>
903		1421
904	=head1 CSI (Command Sequence Introducer) Sequences	1422	=head2 CSI (Command Sequence Introducer) Sequences
905		1423
906	=over 4	1424	=over 4
907		1425
908	=item B<< C<ESC [ Ps @> >>	1426	=item B<< C<ESC [ Ps @> >>
909		1427
…		…
964	=begin table	1482	=begin table
965		1483
966	B<< C<Ps = 0> >> Clear to Right (default)	1484	B<< C<Ps = 0> >> Clear to Right (default)
967	B<< C<Ps = 1> >> Clear to Left	1485	B<< C<Ps = 1> >> Clear to Left
968	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)
969		1489
970	=end table	1490	=end table
971		1491
972	=item B<< C<ESC [ Ps L> >>	1492	=item B<< C<ESC [ Ps L> >>
973		1493
…		…
1179		1699
1180	=back	1700	=back
1181		1701
1182	X<PrivateModes>	1702	X<PrivateModes>
1183		1703
1184	=head1 DEC Private Modes	1704	=head2 DEC Private Modes
1185		1705
1186	=over 4	1706	=over 4
1187		1707
1188	=item B<< C<ESC [ ? Pm h> >>	1708	=item B<< C<ESC [ ? Pm h> >>
1189		1709
…		…
1205		1725
1206	Toggle DEC Private Mode Values (rxvt extension). I<where>	1726	Toggle DEC Private Mode Values (rxvt extension). I<where>
1207		1727
1208	=over 4	1728	=over 4
1209		1729
1210	=item B<< C<Ps = 1> >> (DECCKM)	1730	=item B<< C<Pm = 1> >> (DECCKM)
1211		1731
1212	=begin table	1732	=begin table
1213		1733
1214	B<< C<h> >> Application Cursor Keys	1734	B<< C<h> >> Application Cursor Keys
1215	B<< C<l> >> Normal Cursor Keys	1735	B<< C<l> >> Normal Cursor Keys
1216		1736
1217	=end table	1737	=end table
1218		1738
1219	=item B<< C<Ps = 2> >> (ANSI/VT52 mode)	1739	=item B<< C<Pm = 2> >> (ANSI/VT52 mode)
1220		1740
1221	=begin table	1741	=begin table
1222		1742
1223	B<< C<h> >> Enter VT52 mode	1743	B<< C<h> >> Enter VT52 mode
1224	B<< C<l> >> Enter VT52 mode	1744	B<< C<l> >> Enter VT52 mode
1225		1745
1226	=end table	1746	=end table
1227		1747
1228	=item B<< C<Ps = 3> >>	1748	=item B<< C<Pm = 3> >>
1229		1749
1230	=begin table	1750	=begin table
1231		1751
1232	B<< C<h> >> 132 Column Mode (DECCOLM)	1752	B<< C<h> >> 132 Column Mode (DECCOLM)
1233	B<< C<l> >> 80 Column Mode (DECCOLM)	1753	B<< C<l> >> 80 Column Mode (DECCOLM)
1234		1754
1235	=end table	1755	=end table
1236		1756
1237	=item B<< C<Ps = 4> >>	1757	=item B<< C<Pm = 4> >>
1238		1758
1239	=begin table	1759	=begin table
1240		1760
1241	B<< C<h> >> Smooth (Slow) Scroll (DECSCLM)	1761	B<< C<h> >> Smooth (Slow) Scroll (DECSCLM)
1242	B<< C<l> >> Jump (Fast) Scroll (DECSCLM)	1762	B<< C<l> >> Jump (Fast) Scroll (DECSCLM)
1243		1763
1244	=end table	1764	=end table
1245		1765
1246	=item B<< C<Ps = 5> >>	1766	=item B<< C<Pm = 5> >>
1247		1767
1248	=begin table	1768	=begin table
1249		1769
1250	B<< C<h> >> Reverse Video (DECSCNM)	1770	B<< C<h> >> Reverse Video (DECSCNM)
1251	B<< C<l> >> Normal Video (DECSCNM)	1771	B<< C<l> >> Normal Video (DECSCNM)
1252		1772
1253	=end table	1773	=end table
1254		1774
1255	=item B<< C<Ps = 6> >>	1775	=item B<< C<Pm = 6> >>
1256		1776
1257	=begin table	1777	=begin table
1258		1778
1259	B<< C<h> >> Origin Mode (DECOM)	1779	B<< C<h> >> Origin Mode (DECOM)
1260	B<< C<l> >> Normal Cursor Mode (DECOM)	1780	B<< C<l> >> Normal Cursor Mode (DECOM)
1261		1781
1262	=end table	1782	=end table
1263		1783
1264	=item B<< C<Ps = 7> >>	1784	=item B<< C<Pm = 7> >>
1265		1785
1266	=begin table	1786	=begin table
1267		1787
1268	B<< C<h> >> Wraparound Mode (DECAWM)	1788	B<< C<h> >> Wraparound Mode (DECAWM)
1269	B<< C<l> >> No Wraparound Mode (DECAWM)	1789	B<< C<l> >> No Wraparound Mode (DECAWM)
1270		1790
1271	=end table	1791	=end table
1272		1792
1273	=item B<< C<Ps = 8> >> I<unimplemented>	1793	=item B<< C<Pm = 8> >> I<unimplemented>
1274		1794
1275	=begin table	1795	=begin table
1276		1796
1277	B<< C<h> >> Auto-repeat Keys (DECARM)	1797	B<< C<h> >> Auto-repeat Keys (DECARM)
1278	B<< C<l> >> No Auto-repeat Keys (DECARM)	1798	B<< C<l> >> No Auto-repeat Keys (DECARM)
1279		1799
1280	=end table	1800	=end table
1281		1801
1282	=item B<< C<Ps = 9> >> X10 XTerm	1802	=item B<< C<Pm = 9> >> X10 XTerm
1283		1803
1284	=begin table	1804	=begin table
1285		1805
1286	B<< C<h> >> Send Mouse X & Y on button press.	1806	B<< C<h> >> Send Mouse X & Y on button press.
1287	B<< C<l> >> No mouse reporting.	1807	B<< C<l> >> No mouse reporting.
1288		1808
1289	=end table	1809	=end table
1290		1810
1291	=item B<< C<Ps = 10> >> (B<rxvt>)
1292
1293	=begin table
1294
1295	B<< C<h> >> menuBar visible
1296	B<< C<l> >> menuBar invisible
1297
1298	=end table
1299
1300	=item B<< C<Ps = 25> >>	1811	=item B<< C<Pm = 25> >>
1301		1812
1302	=begin table	1813	=begin table
1303		1814
1304	B<< C<h> >> Visible cursor {cnorm/cvvis}	1815	B<< C<h> >> Visible cursor {cnorm/cvvis}
1305	B<< C<l> >> Invisible cursor {civis}	1816	B<< C<l> >> Invisible cursor {civis}
1306		1817
1307	=end table	1818	=end table
1308		1819
1309	=item B<< C<Ps = 30> >>	1820	=item B<< C<Pm = 30> >>
1310		1821
1311	=begin table	1822	=begin table
1312		1823
1313	B<< C<h> >> scrollBar visisble	1824	B<< C<h> >> scrollBar visible
1314	B<< C<l> >> scrollBar invisisble	1825	B<< C<l> >> scrollBar invisible
1315		1826
1316	=end table	1827	=end table
1317		1828
1318	=item B<< C<Ps = 35> >> (B<rxvt>)	1829	=item B<< C<Pm = 35> >> (B<rxvt>)
1319		1830
1320	=begin table	1831	=begin table
1321		1832
1322	B<< C<h> >> Allow XTerm Shift+key sequences	1833	B<< C<h> >> Allow XTerm Shift+key sequences
1323	B<< C<l> >> Disallow XTerm Shift+key sequences	1834	B<< C<l> >> Disallow XTerm Shift+key sequences
1324		1835
1325	=end table	1836	=end table
1326		1837
1327	=item B<< C<Ps = 38> >> I<unimplemented>	1838	=item B<< C<Pm = 38> >> I<unimplemented>
1328		1839
1329	Enter Tektronix Mode (DECTEK)	1840	Enter Tektronix Mode (DECTEK)
1330		1841
1331	=item B<< C<Ps = 40> >>	1842	=item B<< C<Pm = 40> >>
1332		1843
1333	=begin table	1844	=begin table
1334		1845
1335	B<< C<h> >> Allow 80/132 Mode	1846	B<< C<h> >> Allow 80/132 Mode
1336	B<< C<l> >> Disallow 80/132 Mode	1847	B<< C<l> >> Disallow 80/132 Mode
1337		1848
1338	=end table	1849	=end table
1339		1850
1340	=item B<< C<Ps = 44> >> I<unimplemented>	1851	=item B<< C<Pm = 44> >> I<unimplemented>
1341		1852
1342	=begin table	1853	=begin table
1343		1854
1344	B<< C<h> >> Turn On Margin Bell	1855	B<< C<h> >> Turn On Margin Bell
1345	B<< C<l> >> Turn Off Margin Bell	1856	B<< C<l> >> Turn Off Margin Bell
1346		1857
1347	=end table	1858	=end table
1348		1859
1349	=item B<< C<Ps = 45> >> I<unimplemented>	1860	=item B<< C<Pm = 45> >> I<unimplemented>
1350		1861
1351	=begin table	1862	=begin table
1352		1863
1353	B<< C<h> >> Reverse-wraparound Mode	1864	B<< C<h> >> Reverse-wraparound Mode
1354	B<< C<l> >> No Reverse-wraparound Mode	1865	B<< C<l> >> No Reverse-wraparound Mode
1355		1866
1356	=end table	1867	=end table
1357		1868
1358	=item B<< C<Ps = 46> >> I<unimplemented>	1869	=item B<< C<Pm = 46> >> I<unimplemented>
1359		1870
1360	=item B<< C<Ps = 47> >>	1871	=item B<< C<Pm = 47> >>
1361		1872
1362	=begin table	1873	=begin table
1363		1874
1364	B<< C<h> >> Use Alternate Screen Buffer	1875	B<< C<h> >> Use Alternate Screen Buffer
1365	B<< C<l> >> Use Normal Screen Buffer	1876	B<< C<l> >> Use Normal Screen Buffer
1366		1877
1367	=end table	1878	=end table
1368		1879
1369	X<Priv66>	1880	X<Priv66>
1370		1881
1371	=item B<< C<Ps = 66> >>	1882	=item B<< C<Pm = 66> >>
1372		1883
1373	=begin table	1884	=begin table
1374		1885
1375	B<< C<h> >> Application Keypad (DECPAM) == C<ESC =>	1886	B<< C<h> >> Application Keypad (DECPAM) == C<ESC =>
1376	B<< C<l> >> Normal Keypad (DECPNM) == C<< ESC > >>	1887	B<< C<l> >> Normal Keypad (DECPNM) == C<< ESC > >>
1377		1888
1378	=end table	1889	=end table
1379		1890
1380	=item B<< C<Ps = 67> >>	1891	=item B<< C<Pm = 67> >>
1381		1892
1382	=begin table	1893	=begin table
1383		1894
1384	B<< C<h> >> Backspace key sends B<< C<BS> (DECBKM) >>	1895	B<< C<h> >> Backspace key sends B<< C<BS> (DECBKM) >>
1385	B<< C<l> >> Backspace key sends B<< C<DEL> >>	1896	B<< C<l> >> Backspace key sends B<< C<DEL> >>
1386		1897
1387	=end table	1898	=end table
1388		1899
1389	=item B<< C<Ps = 1000> >> (X11 XTerm)	1900	=item B<< C<Pm = 1000> >> (X11 XTerm)
1390		1901
1391	=begin table	1902	=begin table
1392		1903
1393	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.
1394	B<< C<l> >> No mouse reporting.	1905	B<< C<l> >> No mouse reporting.
1395		1906
1396	=end table	1907	=end table
1397		1908
1398	=item B<< C<Ps = 1001> >> (X11 XTerm) I<unimplemented>	1909	=item B<< C<Pm = 1001> >> (X11 XTerm) I<unimplemented>
1399		1910
1400	=begin table	1911	=begin table
1401		1912
1402	B<< C<h> >> Use Hilite Mouse Tracking.	1913	B<< C<h> >> Use Hilite Mouse Tracking.
1403	B<< C<l> >> No mouse reporting.	1914	B<< C<l> >> No mouse reporting.
1404		1915
1405	=end table	1916	=end table
1406		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
1407	=item B<< C<Ps = 1010> >> (B<rxvt>)	1936	=item B<< C<Pm = 1010> >> (B<rxvt>)
1408		1937
1409	=begin table	1938	=begin table
1410		1939
1411	B<< C<h> >> Don't scroll to bottom on TTY output	1940	B<< C<h> >> Don't scroll to bottom on TTY output
1412	B<< C<l> >> Scroll to bottom on TTY output	1941	B<< C<l> >> Scroll to bottom on TTY output
1413		1942
1414	=end table	1943	=end table
1415		1944
1416	=item B<< C<Ps = 1011> >> (B<rxvt>)	1945	=item B<< C<Pm = 1011> >> (B<rxvt>)
1417		1946
1418	=begin table	1947	=begin table
1419		1948
1420	B<< C<h> >> Scroll to bottom when a key is pressed	1949	B<< C<h> >> Scroll to bottom when a key is pressed
1421	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
1422		1951
1423	=end table	1952	=end table
1424		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
1425	=item B<< C<Ps = 1047> >>	1963	=item B<< C<Pm = 1047> >>
1426		1964
1427	=begin table	1965	=begin table
1428		1966
1429	B<< C<h> >> Use Alternate Screen Buffer	1967	B<< C<h> >> Use Alternate Screen Buffer
1430	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
1431		1969
1432	=end table	1970	=end table
1433		1971
1434	=item B<< C<Ps = 1048> >>	1972	=item B<< C<Pm = 1048> >>
1435		1973
1436	=begin table	1974	=begin table
1437		1975
1438	B<< C<h> >> Save cursor position	1976	B<< C<h> >> Save cursor position
1439	B<< C<l> >> Restore cursor position	1977	B<< C<l> >> Restore cursor position
1440		1978
1441	=end table	1979	=end table
1442		1980
1443	=item B<< C<Ps = 1049> >>	1981	=item B<< C<Pm = 1049> >>
1444		1982
1445	=begin table	1983	=begin table
1446		1984
1447	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
1448	B<< C<l> >> Use Normal Screen Buffer	1986	B<< C<l> >> Use Normal Screen Buffer
1449		1987
1450	=end table	1988	=end table
1451		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
1452	=back	1999	=back
1453		2000
1454	=back	2001	=back
1455		2002
1456	X<XTerm>	2003	X<XTerm>
1457		2004
1458	=head1 XTerm Operating System Commands	2005	=head2 XTerm Operating System Commands
1459		2006
1460	=over 4	2007	=over 4
1461		2008
1462	=item B<< C<ESC ] Ps;Pt ST> >>	2009	=item B<< C<ESC ] Ps;Pt ST> >>
1463		2010
…		…
1470	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> >>
1471	B<< C<Ps = 1> >> Change Icon Name to B<< C<Pt> >>	2018	B<< C<Ps = 1> >> Change Icon Name to B<< C<Pt> >>
1472	B<< C<Ps = 2> >> Change Window Title to B<< C<Pt> >>	2019	B<< C<Ps = 2> >> Change Window Title to B<< C<Pt> >>
1473	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.
1474	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
1475	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> >>
1476	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> >>
1477	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> >>
1478	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> >>
1479	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> >>
1480	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]
1481	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]
1482	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).
1483	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]
1484	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>
1485	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]
1486	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> >>
1487	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]
1488	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).
1489	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>.
1490	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> >>
1491	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> >>
1492	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>.
1493	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).
1494	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).
1495	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).
1496	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).
1497	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).
1498		2049
1499	=end table	2050	=end table
1500		2051
1501	=back	2052	=back
1502		2053
1503	X<menuBar>	2054	=head1 BACKGROUND IMAGE
1504		2055
1505	=head1 menuBar
1506
1507	B<< The exact syntax used is I<almost> solidified. >>
1508	In the menus, B<DON'T> try to use menuBar commands that add or remove a
1509	menuBar.
1510
1511	Note that in all of the commands, the B<< I</path/> >> I<cannot> be
1512	omitted: use B<./> to specify a menu relative to the current menu.
1513
1514	=head2 Overview of menuBar operation
1515
1516	For the menuBar XTerm escape sequence C<ESC ] 703 ; Pt ST>, the syntax
1517	of C<Pt> can be used for a variety of tasks:
1518
1519	At the top level is the current menuBar which is a member of a circular
1520	linked-list of other such menuBars.
1521
1522	The menuBar acts as a parent for the various drop-down menus, which in
1523	turn, may have labels, separator lines, menuItems and subMenus.
1524
1525	The menuItems are the useful bits: you can use them to mimic keyboard
1526	input or even to send text or escape sequences back to rxvt.
1527
1528	The menuBar syntax is intended to provide a simple yet robust method of
1529	constructing and manipulating menus and navigating through the
1530	menuBars.
1531
1532	The first step is to use the tag B<< [menu:I<name>] >> which creates
1533	the menuBar called I<name> and allows access. You may now or menus,
1534	subMenus, and menuItems. Finally, use the tag B<[done]> to set the
1535	menuBar access as B<readonly> to prevent accidental corruption of the
1536	menus. To re-access the current menuBar for alterations, use the tag
1537	B<[menu]>, make the alterations and then use B<[done]>
1538
1539	X<menuBarCommands>
1540
1541	=head2 Commands
1542
1543	=over 4
1544
1545	=item B<< [menu:+I<name>] >>
1546
1547	access the named menuBar for creation or alteration. If a new menuBar
1548	is created, it is called I<name> (max of 15 chars) and the current
1549	menuBar is pushed onto the stack
1550
1551	=item B<[menu]>
1552
1553	access the current menuBar for alteration
1554
1555	=item B<< [title:+I<string>] >>
1556
1557	set the current menuBar's title to I<string>, which may contain the
1558	following format specifiers:
1559
1560	B<%n> rxvt name (as per the B<-name> command-line option)
1561	B<%v> rxvt version
1562	B<%%> literal B<%> character
1563
1564	=item B<[done]>
1565
1566	set menuBar access as B<readonly>.
1567	End-of-file tag for B<< [read:+I<file>] >> operations.
1568
1569	=item B<< [read:+I<file>] >>
1570
1571	read menu commands directly from I<file> (extension ".menu" will be
1572	appended if required.) Start reading at a line with B<[menu]> or B<<
1573	[menu:+I<name> >> and continuing until B<[done]> is encountered.
1574
1575	Blank and comment lines (starting with B<#>) are ignored. Actually,
1576	since any invalid menu commands are also ignored, almost anything could
1577	be construed as a comment line, but this may be tightened up in the
1578	future ... so don't count on it!.
1579
1580	=item B<< [read:+I<file>;+I<name>] >>
1581
1582	The same as B<< [read:+I<file>] >>, but start reading at a line with
1583	B<< [menu:+I<name>] >> and continuing until B<< [done:+I<name>] >> or
1584	B<[done]> is encountered.
1585
1586	=item B<[dump]>
1587
1588	dump all menuBars to the file B</tmp/rxvt-PID> in a format suitable for
1589	later rereading.
1590
1591	=item B<[rm:name]>
1592
1593	remove the named menuBar
1594
1595	=item B<[rm] [rm:]>
1596
1597	remove the current menuBar
1598
1599	=item B<[rm] [rm:]>
1600
1601	remove all menuBars
1602
1603	=item B<[swap]>
1604
1605	swap the top two menuBars
1606
1607	=item B<[prev]>
1608
1609	access the previous menuBar
1610
1611	=item B<[next]>
1612
1613	access the next menuBar
1614
1615	=item B<[show]>
1616
1617	Enable display of the menuBar
1618
1619	=item B<[hide]>
1620
1621	Disable display of the menuBar
1622
1623	=item B<< [pixmap:+I<name>] >>
1624
1625	=item B<< [pixmap:+I<name>;I<scaling>] >>
1626
1627	(set the background pixmap globally
1628
1629	B<< A Future implementation I<may> make this local to the menubar >>)
1630
1631	=item B<< [:+I<command>:] >>
1632
1633	ignore the menu readonly status and issue a I<command> to or a menu or
1634	menuitem or change the ; a useful shortcut for setting the quick arrows
1635	from a menuBar.
1636
1637	=back
1638
1639	X<menuBarAdd>
1640
1641	=head2 Adding and accessing menus
1642
1643	The following commands may also be B<+> prefixed.
1644
1645	=over 4
1646
1647	=item B</+>
1648
1649	access menuBar top level
1650
1651	=item B<./+>
1652
1653	access current menu level
1654
1655	=item B<../+>
1656
1657	access parent menu (1 level up)
1658
1659	=item B<../../>
1660
1661	access parent menu (multiple levels up)
1662
1663	=item B<< I</path/>menu >>
1664
1665	add/access menu
1666
1667	=item B<< I</path/>menu/* >>
1668
1669	add/access menu and clear it if it exists
1670
1671	=item B<< I</path/>{-} >>
1672
1673	add separator
1674
1675	=item B<< I</path/>{item} >>
1676
1677	add B<item> as a label
1678
1679	=item B<< I</path/>{item} action >>
1680
1681	add/alter I<menuitem> with an associated I<action>
1682
1683	=item B<< I</path/>{item}{right-text} >>
1684
1685	add/alter I<menuitem> with B<right-text> as the right-justified text
1686	and as the associated I<action>
1687
1688	=item B<< I</path/>{item}{rtext} action >>
1689
1690	add/alter I<menuitem> with an associated I<action> and with B<rtext> as
1691	the right-justified text.
1692
1693	=back
1694
1695	=over 4
1696
1697	=item Special characters in I<action> must be backslash-escaped:
1698
1699	B<\a \b \E \e \n \r \t \octal>
1700
1701	=item or in control-character notation:
1702
1703	B<^@, ^A .. ^Z .. ^_, ^?>
1704
1705	=back
1706
1707	To send a string starting with a B<NUL> (B<^@>) character to the
1708	program, start I<action> with a pair of B<NUL> characters (B<^@^@>),
1709	the first of which will be stripped off and the balance directed to the
1710	program. Otherwise if I<action> begins with B<NUL> followed by
1711	non-+B<NUL> characters, the leading B<NUL> is stripped off and the
1712	balance is sent back to rxvt.
1713
1714	As a convenience for the many Emacs-type editors, I<action> may start
1715	with B<M-> (eg, B<M-$> is equivalent to B<\E$>) and a B<CR> will be
1716	appended if missed from B<M-x> commands.
1717
1718	As a convenience for issuing XTerm B<ESC ]> sequences from a menubar (or
1719	quick arrow), a B<BEL> (B<^G>) will be appended if needed.
1720
1721	=over 4
1722
1723	=item For example,
1724
1725	B<M-xapropos> is equivalent to B<\Exapropos\r>
1726
1727	=item and
1728
1729	B<\E]703;mona;100> is equivalent to B<\E]703;mona;100\a>
1730
1731	=back
1732
1733	The option B<< {I<right-rtext>} >> will be right-justified. In the
1734	absence of a specified action, this text will be used as the I<action>
1735	as well.
1736
1737	=over 4
1738
1739	=item For example,
1740
1741	B</File/{Open}{^X^F}> is equivalent to B</File/{Open}{^X^F} ^X^F>
1742
1743	=back
1744
1745	The left label I<is> necessary, since it's used for matching, but
1746	implicitly hiding the left label (by using same name for both left and
1747	right labels), or explicitly hiding the left label (by preceeding it
1748	with a dot), makes it possible to have right-justified text only.
1749
1750	=over 4
1751
1752	=item For example,
1753
1754	B</File/{Open}{Open} Open-File-Action>
1755
1756	=item or hiding it
1757
1758	B</File/{.anylabel}{Open} Open-File-Action>
1759
1760	=back
1761
1762	X<menuBarRemove>
1763
1764	=head2 Removing menus
1765
1766	=over 4
1767
1768	=item B<< -/*+ >>
1769
1770	remove all menus from the menuBar, the same as B<[clear]>
1771
1772	=item B<< -+I</path>menu+ >>
1773
1774	remove menu
1775
1776	=item B<< -+I</path>{item}+ >>
1777
1778	remove item
1779
1780	=item B<< -+I</path>{-} >>
1781
1782	remove separator)
1783
1784	=item B<-/path/menu/*>
1785
1786	remove all items, separators and submenus from menu
1787
1788	=back
1789
1790	X<menuBarArrows>
1791
1792	=head2 Quick Arrows
1793
1794	The menus also provide a hook for I<quick arrows> to provide easier
1795	user access. If nothing has been explicitly set, the default is to
1796	emulate the curror keys. The syntax permits each arrow to be altered
1797	individually or all four at once without re-entering their common
1798	beginning/end text. For example, to explicitly associate cursor actions
1799	with the arrows, any of the following forms could be used:
1800
1801	=over 4
1802
1803	=item B<< <r>+I<Right> >>
1804
1805	=item B<< <l>+I<Left> >>
1806
1807	=item B<< <u>+I<Up> >>
1808
1809	=item B<< <d>+I<Down> >>
1810
1811	Define actions for the respective arrow buttons
1812
1813	=item B<< <b>+I<Begin> >>
1814
1815	=item B<< <e>+I<End> >>
1816
1817	Define common beginning/end parts for I<quick arrows> which used in
1818	conjunction with the above <r> <l> <u> <d> constructs
1819
1820	=back
1821
1822	=over 4
1823
1824	=item For example, define arrows individually,
1825
1826	<u>\E[A
1827
1828	<d>\E[B
1829
1830	<r>\E[C
1831
1832	<l>\E[D
1833
1834	=item or all at once
1835
1836	<u>\E[AZ<><d>\E[BZ<><r>\E[CZ<><l>\E[D
1837
1838	=item or more compactly (factoring out common parts)
1839
1840	<b>\E[<u>AZ<><d>BZ<><r>CZ<><l>D
1841
1842	=back
1843
1844	X<menuBarSummary>
1845
1846	=head2 Command Summary
1847
1848	A short summary of the most I<common> commands:
1849
1850	=over 4
1851
1852	=item [menu:name]
1853
1854	use an existing named menuBar or start a new one
1855
1856	=item [menu]
1857
1858	use the current menuBar
1859
1860	=item [title:string]
1861
1862	set menuBar title
1863
1864	=item [done]
1865
1866	set menu access to readonly and, if reading from a file, signal EOF
1867
1868	=item [done:name]
1869
1870	if reading from a file using [read:file;name] signal EOF
1871
1872	=item [rm:name]
1873
1874	remove named menuBar(s)
1875
1876	=item [rm] [rm:]
1877
1878	remove current menuBar
1879
1880	=item [rm] [rm:]
1881
1882	remove all menuBar(s)
1883
1884	=item [swap]
1885
1886	swap top two menuBars
1887
1888	=item [prev]
1889
1890	access the previous menuBar
1891
1892	=item [next]
1893
1894	access the next menuBar
1895
1896	=item [show]
1897
1898	map menuBar
1899
1900	=item [hide]
1901
1902	unmap menuBar
1903
1904	=item [pixmap;file]
1905
1906	=item [pixmap;file;scaling]
1907
1908	set a background pixmap
1909
1910	=item [read:file]
1911
1912	=item [read:file;name]
1913
1914	read in a menu from a file
1915
1916	=item [dump]
1917
1918	dump out all menuBars to /tmp/rxvt-PID
1919
1920	=item /
1921
1922	access menuBar top level
1923
1924	=item ./
1925
1926	=item ../
1927
1928	=item ../../
1929
1930	access current or parent menu level
1931
1932	=item /path/menu
1933
1934	add/access menu
1935
1936	=item /path/{-}
1937
1938	add separator
1939
1940	=item /path/{item}{rtext} action
1941
1942	add/alter menu item
1943
1944	=item -/*
1945
1946	remove all menus from the menuBar
1947
1948	=item -/path/menu
1949
1950	remove menu items, separators and submenus from menu
1951
1952	=item -/path/menu
1953
1954	remove menu
1955
1956	=item -/path/{item}
1957
1958	remove item
1959
1960	=item -/path/{-}
1961
1962	remove separator
1963
1964	=item <b>Begin<r>Right<l>Left<u>Up<d>Down<e>End
1965
1966	menu quick arrows
1967
1968	=back
1969	X<XPM>
1970
1971	=head1 XPM
1972
1973	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
1974	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
1975	sequence of scaling/positioning commands separated by semi-colons. The	2058	sequence of scaling/positioning commands separated by semi-colons. The
1976	scaling/positioning commands are as follows:	2059	scaling/positioning commands are as follows:
1977		2060
1978	=over 4	2061	=over 4
1979		2062
…		…
2017		2100
2018	For example:	2101	For example:
2019		2102
2020	=over 4	2103	=over 4
2021		2104
2022	=item B<\E]20;funky\a>	2105	=item B<\E]20;funky.jpg\a>
2023		2106
2024	load B<funky.xpm> as a tiled image	2107	load B<funky.jpg> as a tiled image
2025		2108
2026	=item B<\E]20;mona;100\a>	2109	=item B<\E]20;mona.jpg;100\a>
2027		2110
2028	load B<mona.xpm> with a scaling of 100%	2111	load B<mona.jpg> with a scaling of 100%
2029		2112
2030	=item B<\E]20;;200;?\a>	2113	=item B<\E]20;;200;?\a>
2031		2114
2032	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
2033	the title	2116	the title
2034		2117
2035	=back	2118	=back
		2119
2036	X<Mouse>	2120	X<Mouse>
2037		2121
2038	=head1 Mouse Reporting	2122	=head1 Mouse Reporting
2039		2123
2040	=over 4	2124	=over 4
…		…
2072	=begin table	2156	=begin table
2073		2157
2074	4 Shift	2158	4 Shift
2075	8 Meta	2159	8 Meta
2076	16 Control	2160	16 Control
2077	32 Double Click I<(Rxvt extension)>	2161	32 Double Click I<(rxvt extension)>
2078		2162
2079	=end table	2163	=end table
2080		2164
2081	Col = B<< C<< <x> - SPACE >> >>	2165	Col = B<< C<< <x> - SPACE >> >>
2082		2166
2083	Row = B<< C<< <y> - SPACE >> >>	2167	Row = B<< C<< <y> - SPACE >> >>
2084		2168
2085	=back	2169	=back
		2170
		2171	=head1 Key Codes
		2172
2086	X<KeyCodes>	2173	X<KeyCodes>
2087
2088	=head1 Key Codes
2089		2174
2090	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>
2091		2176
2092	For the keypad, use B<Shift> to temporarily override Application-Keypad	2177	For the keypad, use B<Shift> to temporarily override Application-Keypad
2093	setting use B<Num_Lock> to toggle Application-Keypad setting if	2178	setting use B<Num_Lock> to toggle Application-Keypad setting if
…		…
2159	=end table	2244	=end table
2160		2245
2161	=head1 CONFIGURE OPTIONS	2246	=head1 CONFIGURE OPTIONS
2162		2247
2163	General hint: if you get compile errors, then likely your configuration	2248	General hint: if you get compile errors, then likely your configuration
2164	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
2165	./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>
2166	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
2167	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>.
2168	<rxvt@schmorp.de>.	2253
		2254	All
2169		2255
2170	=over 4	2256	=over 4
2171		2257
2172	=item --enable-everything	2258	=item --enable-everything
2173		2259
2174	Add support for all non-multichoice options listed in "./configure	2260	Add (or remove) support for all non-multichoice options listed in "./configure
2175	--help". Note that unlike other enable options this is order dependant.	2261	--help".
		2262
2176	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
2177	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.
2178		2268
2179	=item --enable-xft	2269	=item --enable-xft (default: enabled)
2180		2270
2181	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
2182	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
2183	don't pay for them.	2273	don't pay for them.
2184		2274
2185	=item --enable-font-styles	2275	=item --enable-font-styles (default: on)
2186		2276
2187	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
2188	styles. The fonts can be set manually or automatically.	2278	styles. The fonts can be set manually or automatically.
2189		2279
2190	=item --with-codesets=NAME,...	2280	=item --with-codesets=NAME,... (default: all)
2191		2281
2192	Compile in support for additional codeset (encoding) groups (eu, vn are	2282	Compile in support for additional codeset (encoding) groups (C<eu>, C<vn>
2193	always compiled in, which includes most 8-bit character sets). These	2283	are always compiled in, which includes most 8-bit character sets). These
2194	codeset tables are currently only used for driving X11 core fonts, they	2284	codeset tables are used for driving X11 core fonts, they are not required
2195	are not required for Xft fonts. Compiling them in will make your binary	2285	for Xft fonts, although having them compiled in lets rxvt-unicode choose
2196	bigger (together about 700kB), but it doesn't increase memory usage unless	2286	replacement fonts more intelligently. Compiling them in will make your
		2287	binary bigger (all of together cost about 700kB), but it doesn't increase
2197	you use an X11 font requiring one of these encodings.	2288	memory usage unless you use a font requiring one of these encodings.
2198		2289
2199	=begin table	2290	=begin table
2200		2291
2201	all all available codeset groups	2292	all all available codeset groups
2202	zh common chinese encodings	2293	zh common chinese encodings
2203	zh_ext rarely used but very big chinese encodigs	2294	zh_ext rarely used but very big chinese encodings
2204	jp common japanese encodings	2295	jp common japanese encodings
2205	jp_ext rarely used but big japanese encodings	2296	jp_ext rarely used but big japanese encodings
2206	kr korean encodings	2297	kr korean encodings
2207		2298
2208	=end table	2299	=end table
2209		2300
2210	=item --enable-xim	2301	=item --enable-xim (default: on)
2211		2302
2212	Add support for XIM (X Input Method) protocol. This allows using	2303	Add support for XIM (X Input Method) protocol. This allows using
2213	alternative input methods (e.g. kinput2) and will also correctly	2304	alternative input methods (e.g. kinput2) and will also correctly
2214	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.
2215		2306
2216	=item --enable-unicode3	2307	=item --enable-unicode3 (default: off)
		2308
		2309	Recommended to stay off unless you really need non-BMP characters.
2217		2310
2218	Enable direct support for displaying unicode codepoints above	2311	Enable direct support for displaying unicode codepoints above
2219	65535 (the basic multilingual page). This increases storage	2312	65535 (the basic multilingual page). This increases storage
2220	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
2221	support these extra characters, but Xft does.	2314	support these extra characters, but Xft does.
2222		2315
2223	Please note that rxvt-unicode can store unicode code points >65535	2316	Please note that rxvt-unicode can store unicode code points >65535
2224	even without this flag, but the number of such characters is	2317	even without this flag, but the number of such characters is
2225	limited to a view thousand (shared with combining characters,	2318	limited to a few thousand (shared with combining characters,
2226	see next switch), and right now rxvt-unicode cannot display them	2319	see next switch), and right now rxvt-unicode cannot display them
2227	(input/output and cut&paste still work, though).	2320	(input/output and cut&paste still work, though).
2228		2321
2229	=item --enable-combining	2322	=item --enable-combining (default: on)
2230		2323
2231	Enable automatic composition of combining characters into	2324	Enable automatic composition of combining characters into
2232	composite characters. This is required for proper viewing of text	2325	composite characters. This is required for proper viewing of text
2233	where accents are encoded as seperate unicode characters. This is	2326	where accents are encoded as seperate unicode characters. This is
2234	done by using precomposited characters when available or creating	2327	done by using precomposited characters when available or creating
2235	new pseudo-characters when no precomposed form exists.	2328	new pseudo-characters when no precomposed form exists.
2236		2329
2237	Without --enable-unicode3, the number of additional precomposed characters	2330	Without --enable-unicode3, the number of additional precomposed
2238	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
2239	private use area, extending the number of combinations to 8448). With
2240	--enable-unicode3, no practical limit exists.	2332	(ab-)used). With --enable-unicode3, no practical limit exists.
2241		2333
2242	This option will also enable storage (but not display) of characters	2334	This option will also enable storage (but not display) of characters
2243	beyond plane 0 (>65535) when --enable-unicode3 was not specified.	2335	beyond plane 0 (>65535) when --enable-unicode3 was not specified.
2244		2336
2245	The combining table also contains entries for arabic presentation forms,	2337	The combining table also contains entries for arabic presentation forms,
2246	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
2247	tell me how these are to be used...).	2339	tell me how these are to be used...).
2248		2340
2249	=item --enable-fallback(=CLASS)	2341	=item --enable-fallback(=CLASS) (default: Rxvt)
2250		2342
2251	When reading resource settings, also read settings for class CLASS	2343	When reading resource settings, also read settings for class CLASS. To
2252	(default: Rxvt). To disable resource fallback use --disable-fallback.	2344	disable resource fallback use --disable-fallback.
2253		2345
2254	=item --with-res-name=NAME	2346	=item --with-res-name=NAME (default: urxvt)
2255		2347
2256	Use the given name (default: urxvt) as default application name when	2348	Use the given name as default application name when
2257	reading resources. Specify --with-res-name=rxvt to replace rxvt.	2349	reading resources. Specify --with-res-name=rxvt to replace rxvt.
2258		2350
2259	=item --with-res-class=CLASS	2351	=item --with-res-class=CLASS (default: URxvt)
2260		2352
2261	Use the given class (default: URxvt) as default application class	2353	Use the given class as default application class
2262	when reading resources. Specify --with-res-class=Rxvt to replace	2354	when reading resources. Specify --with-res-class=Rxvt to replace
2263	rxvt.	2355	rxvt.
2264		2356
2265	=item --enable-utmp	2357	=item --enable-utmp (default: on)
2266		2358
2267	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
2268	start of rxvt execution and delete information when rxvt exits.	2360	start of rxvt execution and delete information when rxvt exits.
2269		2361
2270	=item --enable-wtmp	2362	=item --enable-wtmp (default: on)
2271		2363
2272	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
2273	start of rxvt execution and write logout when rxvt exits. This	2365	start of rxvt execution and write logout when rxvt exits. This
2274	option requires --enable-utmp to also be specified.	2366	option requires --enable-utmp to also be specified.
2275		2367
2276	=item --enable-lastlog	2368	=item --enable-lastlog (default: on)
2277		2369
2278	Write user and tty to lastlog file (used by programs like	2370	Write user and tty to lastlog file (used by programs like
2279	F<lastlogin>) at start of rxvt execution. This option requires	2371	F<lastlogin>) at start of rxvt execution. This option requires
2280	--enable-utmp to also be specified.	2372	--enable-utmp to also be specified.
2281		2373
2282	=item --enable-xpm-background	2374	=item --enable-afterimage (default: on)
2283		2375
2284	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>).
2285		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
2286	=item --enable-transparency	2389	=item --enable-transparency (default: on)
2287		2390
2288	Add support for inheriting parent backgrounds thus giving a fake	2391	Add support for backgrounds, creating illusion of transparency in the term.
2289	transparency to the term.
2290		2392
2291	=item --enable-fading	2393	=item --enable-fading (default: on)
2292		2394
2293	Add support for fading the text when focus is lost.	2395	Add support for fading the text when focus is lost.
2294		2396
2295	=item --enable-tinting
2296
2297	Add support for tinting of transparent backgrounds.
2298
2299	=item --enable-menubar
2300
2301	Add support for our menu bar system (this interacts badly with
2302	dynamic locale switching currently).
2303
2304	=item --enable-rxvt-scroll	2397	=item --enable-rxvt-scroll (default: on)
2305		2398
2306	Add support for the original rxvt scrollbar.	2399	Add support for the original rxvt scrollbar.
2307		2400
2308	=item --enable-next-scroll	2401	=item --enable-next-scroll (default: on)
2309		2402
2310	Add support for a NeXT-like scrollbar.	2403	Add support for a NeXT-like scrollbar.
2311		2404
2312	=item --enable-xterm-scroll	2405	=item --enable-xterm-scroll (default: on)
2313		2406
2314	Add support for an Xterm-like scrollbar.	2407	Add support for an Xterm-like scrollbar.
2315		2408
2316	=item --enable-plain-scroll
2317
2318	Add support for a very unobtrusive, plain-looking scrollbar that
2319	is the favourite of the rxvt-unicode author, having used it for
2320	many years.
2321
2322	=item --enable-half-shadow
2323
2324	Make shadows on the scrollbar only half the normal width & height.
2325	only applicable to rxvt scrollbars.
2326
2327	=item --enable-ttygid
2328
2329	Change tty device setting to group "tty" - only use this if
2330	your system uses this type of security.
2331
2332	=item --disable-backspace-key	2409	=item --disable-backspace-key
2333		2410
2334	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
2335	do it.	2416	do it.
2336		2417
2337	=item --disable-delete-key
2338
2339	Disable any handling of the delete key by us - let the X server
2340	do it.
2341
2342	=item --disable-resources	2418	=item --disable-resources
2343		2419
2344	Remove all resources checking.	2420	Removes any support for resource checking.
2345
2346	=item --enable-xgetdefault
2347
2348	Make resources checking via XGetDefault() instead of our small
2349	version which only checks ~/.Xdefaults, or if that doesn't exist then
2350	~/.Xresources.
2351
2352	Please note that nowadays, things like XIM will automatically pull in and
2353	use the full X resource manager, so the overhead of using it might be very
2354	small, if nonexistant.
2355
2356	=item --enable-strings
2357
2358	Add support for our possibly faster memset() function and other
2359	various routines, overriding your system's versions which may
2360	have been hand-crafted in assembly or may require extra libraries
2361	to link in. (this breaks ANSI-C rules and has problems on many
2362	GNU/Linux systems).
2363		2421
2364	=item --disable-swapscreen	2422	=item --disable-swapscreen
2365		2423
2366	Remove support for swap screen.	2424	Remove support for secondary/swap screen.
2367		2425
2368	=item --enable-frills	2426	=item --enable-frills (default: on)
2369		2427
2370	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
2371	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
2372	disable this.	2430	disable this.
2373		2431
2374	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
2375	in combination with other switches) is:	2433	in combination with other switches) is:
2376		2434
2377	MWM-hints	2435	MWM-hints
2378	EWMH-hints (pid, utf8 names) and protocols (ping)	2436	EWMH-hints (pid, utf8 names) and protocols (ping)
		2437	urgency hint
2379	seperate underline colour	2438	seperate underline colour (-underlineColor)
2380	settable border widths and borderless switch	2439	settable border widths and borderless switch (-w, -b, -bl)
		2440	visual depth selection (-depth)
2381	settable extra linespacing	2441	settable extra linespacing /-lsp)
2382	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
2383	backindex and forwardindex escape sequence	2460	backindex and forwardindex escape sequences
		2461	view change/zero scrollback escape sequences
		2462	locale switching escape sequence
2384	window op and some xterm/OSC escape sequences	2463	window op and some xterm/OSC escape sequences
2385	tripleclickwords	2464	rectangular selections
2386	settable insecure mode	2465	trailing space removal for selections
2387	keysym remapping support	2466	verbose X error handling
2388	-embed and -pty-fd options
2389		2467
2390	=item --enable-iso14755	2468	=item --enable-iso14755 (default: on)
2391		2469
2392	Enable extended ISO 14755 support (see @@RXVT_NAME@@(1), or	2470	Enable extended ISO 14755 support (see @@RXVT_NAME@@(1)).
2393	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
2394	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.
2395	this switch.
2396		2473
2397	=item --enable-keepscrolling	2474	=item --enable-keepscrolling (default: on)
2398		2475
2399	Add support for continual scrolling of the display when you hold	2476	Add support for continual scrolling of the display when you hold
2400	the mouse button down on a scrollbar arrow.	2477	the mouse button down on a scrollbar arrow.
2401		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
2402	=item --enable-mousewheel	2484	=item --enable-mousewheel (default: on)
2403		2485
2404	Add support for scrolling via mouse wheel or buttons 4 & 5.	2486	Add support for scrolling via mouse wheel or buttons 4 & 5.
2405		2487
2406	=item --enable-slipwheeling	2488	=item --enable-slipwheeling (default: on)
2407		2489
2408	Add support for continual scrolling (using the mouse wheel as an	2490	Add support for continual scrolling (using the mouse wheel as an
2409	accelerator) while the control key is held down. This option	2491	accelerator) while the control key is held down. This option
2410	requires --enable-mousewheel to also be specified.	2492	requires --enable-mousewheel to also be specified.
2411		2493
2412	=item --disable-new-selection
2413
2414	Remove support for mouse selection style like that of xterm.
2415
2416	=item --enable-dmalloc
2417
2418	Use Gray Watson's malloc - which is good for debugging See
2419	http://www.letters.com/dmalloc/ for details If you use either this or the
2420	next option, you may need to edit src/Makefile after compiling to point
2421	DINCLUDE and DLIB to the right places.
2422
2423	You can only use either this option and the following (should
2424	you use either) .
2425
2426	=item --enable-dlmalloc
2427
2428	Use Doug Lea's malloc - which is good for a production version
2429	See L<http://g.oswego.edu/dl/html/malloc.html> for details.
2430
2431	=item --enable-smart-resize	2494	=item --enable-smart-resize (default: off)
2432		2495
2433	Add smart growth/shrink behaviour when changing font size via from hot	2496	Add smart growth/shrink behaviour when resizing.
2434	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
2435	closest to a corner of the screen.	2498	the screen in a fixed position.
2436		2499
2437	=item --enable-cursor-blink	2500	=item --enable-text-blink (default: on)
2438		2501
2439	Add support for a blinking cursor.	2502	Add support for blinking text.
2440		2503
2441	=item --enable-pointer-blank	2504	=item --enable-pointer-blank (default: on)
2442		2505
2443	Add support to have the pointer disappear when typing or inactive.	2506	Add support to have the pointer disappear when typing or inactive.
2444		2507
2445	=item --with-name=NAME	2508	=item --enable-perl (default: on)
2446		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
2447	Set the basename for the installed binaries (default: C<urxvt>, resulting	2525	Set the basename for the installed binaries, resulting
2448	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
2449	C<rxvt>.	2527	C<rxvt>.
2450		2528
2451	=item --with-term=NAME	2529	=item --with-term=NAME (default: rxvt-unicode)
2452		2530
2453	Change the environmental variable for the terminal to NAME (default	2531	Change the environmental variable for the terminal to NAME.
2454	C<rxvt-unicode>)
2455		2532
2456	=item --with-terminfo=PATH	2533	=item --with-terminfo=PATH
2457		2534
2458	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
2459	PATH.	2536	PATH.
2460		2537
2461	=item --with-x	2538	=item --with-x
2462		2539
2463	Use the X Window System (pretty much default, eh?).	2540	Use the X Window System (pretty much default, eh?).
2464
2465	=item --with-xpm-includes=DIR
2466
2467	Look for the XPM includes in DIR.
2468
2469	=item --with-xpm-library=DIR
2470
2471	Look for the XPM library in DIR.
2472
2473	=item --with-xpm
2474
2475	Not needed - define via --enable-xpm-background.
2476		2541
2477	=back	2542	=back
2478		2543
2479	=head1 AUTHORS	2544	=head1 AUTHORS
2480		2545

Diff Legend

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

Comparing rxvt-unicode/doc/rxvt.7.pod (file contents): Revision 1.52 by root, Sat Mar 19 02:27:26 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.52 by root, Sat Mar 19 02:27:26 2005 UTC vs.
Revision 1.177 by root, Sat May 30 08:53:48 2009 UTC