ViewVC Help

View File | Revision Log | Show Annotations | Download File

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

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

Diff Legend

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