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.34 by root, Thu Feb 3 10:24:10 2005 UTC vs.
Revision 1.111 by root, Thu Feb 2 00:31:47 2006 UTC

1	=head1 NAME	1	=head1 NAME
2		2
3	RXVT REFERENCE - FAQ, command sequences and other background information	3	RXVT REFERENCE - FAQ, command sequences and other background information
4		4
		5	=head1 SYNOPSIS
		6
		7	# set a new font set
		8	printf '\33]50;%s\007' 9x15,xft:Kochi" Mincho"
		9
		10	# change the locale and tell rxvt-unicode about it
		11	export LC_CTYPE=ja_JP.EUC-JP; printf "\33]701;$LC_CTYPE\007"
		12
		13	# set window title
		14	printf '\33]2;%s\007' "new window title"
		15
		16	=head1 DESCRIPTION
		17
		18	This document contains the FAQ, the RXVT TECHNICAL REFERENCE documenting
		19	all escape sequences, and other background information.
		20
		21	The newest version of this document is also available on the World Wide Web at
		22	L<http://cvs.schmorp.de/browse/*checkout*/rxvt-unicode/doc/rxvt.7.html>.
		23
5	=head1 FREQUENTLY ASKED QUESTIONS	24	=head1 RXVT-UNICODE/URXVT FREQUENTLY ASKED QUESTIONS
6		25
7	=over 4
8		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
9	=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?
10		52
11	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
12	sequence C<ESC[8n> 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.
13		57
14	=item When I log-in to another system it tells me about missing terminfo data?
15
16	The terminal description used by rxvt-unicode is not as widely available
17	as that for xterm, or even rxvt (for which the same problem often arises).
18
19	The correct solution for this problem is to install the terminfo, this can
20	be done like this (with ncurses' infocmp):
21
22	REMOTE=remotesystem.domain
23	infocmp rxvt-unicode | ssh $REMOTE "cat >/tmp/ti && tic /tmp/ti"
24
25	... or by installing rxvt-unicode normally on the remote system,
26
27	If you cannot or do not want to do this, then you can simply set
28	C<TERM=rxvt> or even C<TERM=xterm>, and live with the small number of
29	problems arising, which includes wrong keymapping, less and different
30	colours and some refresh errors in fullscreen applications. It's a nice
31	quick-and-dirty workaround for rare cases, though.
32
33	If you always want to do this you can either recompile rxvt-unicode with
34	the desired TERM value or use a resource to set it:
35
36	URxvt.termName: rxvt
37
38	If you don't plan to use B<rxvt> (quite common...) you could also replace
39	the rxvt terminfo file with the rxvt-unicode one.
40
41	=item I need a termcap file entry.
42
43	You could use rxvt's termcap entry with resonable results in many cases.
44	You can also create a termcap entry by using terminfo's infocmp program
45	like this:
46
47	infocmp -C rxvt-unicode
48
49	OR you could this termcap entry:
50
51	rxvt-unicode|rxvt-unicode terminal (X Window System):\
52	:am:bw:eo:km:mi:ms:xn:xo:\
53	:co#80:it#8:li#24:\
54	:AL=\E[%dL:DC=\E[%dP:DL=\E[%dM:DO=\E[%dB:IC=\E[%d@:\
55	:K1=\EOw:K2=\EOu:K3=\EOy:K4=\EOq:K5=\EOs:LE=\E[%dD:\
56	:RI=\E[%dC:SF=\E[%dS:SR=\E[%dT:UP=\E[%dA:ae=^O:al=\E[L:\
57	:as=^N:bl=^G:cd=\E[J:ce=\E[K:cl=\E[H\E[2J:cm=\E[%i%d;%dH:\
58	:cr=^M:cs=\E[%i%d;%dr:ct=\E[3g:dc=\E[P:dl=\E[M:do=^J:\
59	:ec=\E[%dX:ei=\E[4l:ho=\E[H:i1=\E[?47l\E=\E[?1l:ic=\E[@:\
60	:im=\E[4h:is=\E[r\E[m\E[2J\E[H\E[?7h\E[?1;3;4;6l\E[4l:\
61	:k0=\E[21~:k1=\E[11~:k2=\E[12~:k3=\E[13~:k4=\E[14~:\
62	:k5=\E[15~:k6=\E[17~:k7=\E[18~:k8=\E[19~:k9=\E[20~:\
63	:kD=\E[3~:kI=\E[2~:kN=\E[6~:kP=\E[5~:kb=\177:kd=\EOB:\
64	:ke=\E[?1l\E>:kh=\E[7~:kl=\EOD:kr=\EOC:ks=\E[?1h\E=:\
65	:ku=\EOA:le=^H:mb=\E[5m:md=\E[1m:me=\E[m\017:mr=\E[7m:\
66	:nd=\E[C:rc=\E8:sc=\E7:se=\E[27m:sf=^J:so=\E[7m:sr=\EM:\
67	:st=\EH:ta=^I:te=\E[r\E[?1049l:ti=\E[?1049h:ue=\E[24m:\
68	:up=\E[A:us=\E[4m:vb=\E[?5h\E[?5l:ve=\E[?25h:vi=\E[?25l:\
69	:vs=\E[?25h:
70
71	=item Why does C<ls> no longer have coloured output?
72
73	The C<ls> in the GNU coreutils unfortunately doesn't use terminfo to
74	decide wether a terminal has colour, but uses it's own configuration
75	file. Needless to say, C<rxvt-unicode> is not in it's default file (among
76	with most other terminals supporting colour). Either add:
77
78	TERM rxvt-unicode
79
80	to C</etc/DIR_COLORS> or simply add:
81
82	alias ls='ls --color=auto'
83
84	to your C<.profile> or C<.bashrc>.
85
86	=item Why doesn't vim/emacs etc. use the 88 colour mode?
87
88	=item Why doesn't vim/emacs etc. make use of italic?
89
90	=item Why are the secondary screen-related options not working properly?
91
92	Make sure you are using C<TERM=rxvt-unicode>. Some pre-packaged
93	distributions (most notably Debian GNU/Linux) break rxvt-unicode
94	by setting C<TERM> to C<rxvt>, which doesn't have these extra
95	features. Unfortunately, some of these (most notably, again, Debian
96	GNU/Linux) furthermore fail to even install the C<rxvt-unicode> terminfo
97	file, so you will need to install it on your own (See the question B<When
98	I log-in to another system it tells me about missing terminfo data?> on
99	how to do this).
100
101	=item Rxvt-unicode does not seem to understand the selected encoding?
102
103	=item Unicode does not seem to work?
104
105	If you encounter strange problems like typing an accented character but
106	getting two unrelated other characters or similar, or if program output is
107	subtly garbled, then you should check your locale settings.
108
109	Rxvt-unicode must be started with the same C<LC_CTYPE> setting as the
110	programs. Often rxvt-unicode is started in the C<C> locale, while the
111	login script running within the rxvt-unicode window changes the locale to
112	sth. else, e.h. C<en_GB.UTF-8>. Needless to say, this is not going to work.
113
114	The best thing is to fix your startup environment, as you will likely run
115	into other problems. If nothing works you can try this in your .profile.
116
117	printf '\e]701;%s\007' "$LC_CTYPE"
118
119	If this doesn't work, then maybe you use a C<LC_CTYPE> specification not
120	supported on your systems. Some systems have a C<locale> command which
121	displays this. If it displays sth. like:
122
123	locale: Cannot set LC_CTYPE to default locale: ...
124
125	Then the locale you specified is not supported on your system.
126
127	If nothing works and you are sure that everything is set correctly then
128	you will need to remember a little known fact: Some programs just don't
129	support locales :(
130
131	=item Why do some characters look so much different than others?
132
133	=item How does rxvt-unicode choose fonts?
134
135	Most fonts do not contain the full range of Unicode, which is
136	fine. Chances are that the font you (or the admin/package maintainer of
137	your system/os) have specified does not cover all the characters you want
138	to display.
139
140	B<rxvt-unicode> makes a best-effort try at finding a replacement
141	font. Often the result is fine, but sometimes the chosen font looks
142	bad. Many fonts have totally strange characters that don't resemble the
143	correct glyph at all, and rxvt-unicode lacks the artificial intelligence
144	to detect that a specific glyph is wrong: it has to believe the font that
145	the characters it contains indeed look correct.
146
147	In that case, select a font of your taste and add it to the font list,
148	e.g.:
149
150	@@RXVT_NAME@@ -fn basefont,font2,font3...
151
152	When rxvt-unicode sees a character, it will first look at the base
153	font. If the base font does not contain the character, it will go to the
154	next font, and so on. Specifying your own fonts will also speed up this
155	search and use less resources within rxvt-unicode and the X-server.
156
157	The only limitation is that all the fonts must not be larger than the base
158	font, as the base font defines the principal cell size, which must be the
159	same due to the way terminals work.
160
161	=item Why do some chinese characters look so different than others?
162
163	This is because there is a difference between script and language --
164	rxvt-unicode does not know which language the text that is output
165	is, as it only knows the unicode character codes. If rxvt-unicode
166	first sees a japanese character, it might choose a japanese font for
167	it. Subsequent japanese characters will take that font. Now, many chinese
168	characters aren't represented in japanese fonts, so when the first
169	non-japanese character comes up, rxvt-unicode will look for a chinese font
170	-- unfortunately at this point, it will still use the japanese font for
171	japanese characters that are also chinese.
172
173	The workaround is easy: just tag a chinese font at the end of your font
174	list (see the previous question). The key is to view the font list as
175	a preference list: If you expect more japanese, list a japanese font
176	first. If you expect more chinese, put a chinese font first.
177
178	In the future it might be possible to switch preferences at runtime (the
179	internal data structure has no problem with using different fonts for
180	the same character at the same time, but no interface for this has been
181	designed yet).
182
183	=item Why does rxvt-unicode sometimes leave pixel droppings?
184
185	Most fonts were not designed for terminal use, which means that character
186	size varies a lot. A font that is otherwise fine for terminal use might
187	contain some characters that are simply too wide. Rxvt-unicode will avoid
188	these characters. For characters that are just "a bit" too wide a special
189	"careful" rendering mode is used that redraws adjacent characters.
190
191	All of this requires that fonts do not lie about character sizes,
192	however: Xft fonts often draw glyphs larger than their acclaimed bounding
193	box, and rxvt-unicode has no way of detecting this (the correct way is to
194	ask for the character bounding box, which unfortunately is wrong in these
195	cases).
196
197	It's not clear (to me at least), wether this is a bug in Xft, freetype,
198	or the respective font. If you encounter this problem you might try using
199	the C<-lsp> option to give the font more height. If that doesn't work, you
200	might be forced to use a different font.
201
202	All of this is not a problem when using X11 core fonts, as their bounding
203	box data is correct.
204
205	=item My Compose (Multi_key) key is no longer working.
206
207	The most common causes for this are that either your locale is not set
208	correctly, or you specified a B<preeditStyle> that is not supported by
209	your input method. For example, if you specified B<OverTheSpot> and
210	your input method (e.g. the default input method handling Compose keys)
211	does not support this (for instance because it is not visual), then
212	rxvt-unicode will continue without an input method.
213
214	In this case either do not specify a B<preeditStyle> or specify more than
215	one pre-edit style, such as B<OverTheSpot,Root,None>.
216
217	=item I cannot type C<Ctrl-Shift-2> to get an ASCII NUL character due to ISO 14755
218
219	Either try C<Ctrl-2> alone (it often is mapped to ASCII NUL even on
220	international keyboards) or simply use ISO 14755 support to your
221	advantage, typing <Ctrl-Shift-0> to get a ASCII NUL. This works for other
222	codes, too, such as C<Ctrl-Shift-1-d> to type the default telnet escape
223	character and so on.
224
225	=item How can I keep rxvt-unicode from using reverse video so much?
226
227	First of all, make sure you are running with the right terminfo
228	(C<urxvt>), which will get rid of most of these effects. Then make sure
229	you have specified colours for italic and bold, as otherwise rxvt-unicode
230	might use reverse video to simulate the effect:
231
232	URxvt*colorBD: white
233	URxvt*colorIT: green
234
235	=item Some programs assume totally weird colours (red instead of blue), how can I fix that?
236
237	For some unexplainable reason, some programs (i.e. irssi) assume a very
238	weird colour palette when confronted with a terminal with more than the
239	standard 8 colours (rxvt-unicode supports 88). The right fix is, of
240	course, to fix these programs not to assume non-ISO colours without very
241	good reasons.
242
243	In the meantime, you can either edit your C<urxvt> terminfo definition to
244	only claim 8 colour support or use C<TERM=rxvt>, which will fix colours
245	but keep you from using other rxvt-unicode features.
246
247	=item I am on FreeBSD and rxvt-unicode does not seem to work at all.
248
249	Rxvt-unicode requires the symbol C<__STDC_ISO_10646__> to be defined
250	in your compile environment, or an implementation that implements it,
251	wether it defines the symbol or not. C<__STDC_ISO_10646__> requires that
252	B<wchar_t> is represented as unicode.
253
254	As you might have guessed, FreeBSD does neither define this symobl nor
255	does it support it. Instead, it uses it's own internal representation of
256	B<wchar_t>. This is, of course, completely legal.
257
258	However, C<__STDC_ISO_10646__> is the only sane way to support
259	multi-language apps in an OS, as using a locale-dependent (and
260	non-standardized) representation of B<wchar_t> makes it impossible to
261	convert between B<wchar_t> (as used by X11 and your applications) and any
262	other encoding without implementing OS-specific-wrappers for each and
263	every locale. There simply are no APIs to convert B<wchar_t> into anything
264	except the current locale encoding.
265
266	Some applications (such as the formidable B<mlterm>) work around this
267	by carrying their own replacement functions for character set handling
268	with them, and either implementing OS-dependent hacks or doing multiple
269	conversions (which is slow and unreliable in case the OS implements
270	encodings slightly different than the terminal emulator).
271
272	The rxvt-unicode author insists that the right way to fix this is in the
273	system libraries once and for all, instead of forcing every app to carry
274	complete replacements.
275
276	=item How does rxvt-unicode determine the encoding to use?
277
278	=item Is there an option to switch encodings?
279
280	Unlike some other terminals, rxvt-unicode has no encoding switch, and no
281	specific "utf-8" mode, such as xterm. In fact, it doesn't even know about
282	UTF-8 or any other encodings with respect to terminal I/O.
283
284	The reasons is that there exists a perfectly fine mechanism for selecting
285	the encoding, doing I/O and (most important) communicating this to all
286	applications so everybody agrees on character properties such as width and
287	code number. This mechanism is the I<locale>.
288
289	Rxvt-unicode uses the C<LC_CTYPE> locale category to select encoding. All
290	programs doing the same (that is, most) will automatically agree in the
291	interpretation of characters.
292
293	Unfortunately, there is no system-independent way to select locales, nor
294	is there a standard on how locale specifiers will look like.
295
296	On most systems, the content of the C<LC_CTYPE> environment variable
297	contains an arbitrary string which corresponds to an already-installed
298	locale. Common names for locales are C<en_US.UTF-8>, C<de_DE.ISO-8859-15>,
299	C<ja_JP.EUC-JP>, i.e. C<language_country.encoding>, but other forms
300	(i.e. C<de> or C<german>) are also common.
301
302	Rxvt-unicode ignores all other locale categories, and except for
303	the encoding, ignores country or language-specific settings,
304	i.e. C<de_DE.UTF-8> and C<ja_JP.UTF-8> are the same for rxvt-unicode.
305
306	If you want to use a specific encoding you have to make sure you start
307	rxvt-unicode with the correct C<LC_CTYPE> category.
308
309	=item Can I switch locales at runtime?
310
311	Yes, using an escape sequence. Try sth. like this, which sets
312	rxvt-unicode's idea of C<LC_CTYPE>.
313
314	printf '\e]701;%s\007' ja_JP.SJIS
315
316	See also the previous question.
317
318	Sometimes this capability is rather handy when you want to work in one
319	locale (e.g. C<de_DE.UTF-8>) but some programs don't support UTF-8. For
320	example, I use this script to start C<xjdic>, which first switches to a
321	locale supported by xjdic and back later:
322
323	printf '\e]701;%s\007' ja_JP.SJIS
324	xjdic -js
325	printf '\e]701;%s\007' de_DE.UTF-8
326
327	=item Can I switch the fonts at runtime?
328
329	Yes, using an escape sequence. Try sth. like this, which has the same
330	effect as using the C<-fn> switch, and takes effect immediately:
331
332	printf '\e]50;%s\007' "9x15bold,xft:Kochi Gothic"
333
334	This is useful if you e.g. work primarily with japanese (and prefer a
335	japanese font), but you have to switch to chinese temporarily, where
336	japanese fonts would only be in your way.
337
338	You can think of this as a kind of manual ISO-2022 switching.
339
340	=item Why do italic characters look as if clipped?
341
342	Many fonts have difficulties with italic characters and hinting. For
343	example, the otherwise very nicely hinted font C<xft:Bitstream Vera Sans
344	Mono> completely fails in it's italic face. A workaround is to enable
345	freetype autohinting, i.e. like this:
346
347	URxvt*italicFont: xft:Bitstream Vera Sans Mono:italic:autohint=true
348	URxvt*boldItalicFont: xft:Bitstream Vera Sans Mono:bold:italic:autohint=true
349
350	=item My input method wants <some encoding> but I want UTF-8, what can I do?
351
352	You can specify separate locales for the input method and the rest of the
353	terminal, using the resource C<imlocale>:
354
355	URxvt*imlocale: ja_JP.EUC-JP
356
357	Now you can start your terminal with C<LC_CTYPE=ja_JP.UTF-8> and still
358	use your input method. Please note, however, that you will not be able to
359	input characters outside C<EUC-JP> in a normal way then, as your input
360	method limits you.
361
362	=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?
363		59
364	Rxvt-unicode tries to obey the rule of not charging you for sth. you	60	Rxvt-unicode tries to obey the rule of not charging you for something you
365	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
366	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,
367	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
368	accidentally when rxvt-unicode tries to find a font for your characters.	64	accidentally when rxvt-unicode tries to find a font for your characters.
369		65
…		…
372	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
373	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)
374	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
375	rxvt-unicode then uses 8 bytes per screen cell.	71	rxvt-unicode then uses 8 bytes per screen cell.
376		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 wether 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<pod2html>. Then go to
		131	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 unreasnobaly 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, transparency isn't officially supported in rxvt-unicode, so
		215	you are mostly on your own. Do not bug the author about it (but you may
		216	bug everybody else). Also, if you can't get it working consider it a rite
		217	of passage: ... and you failed.
		218
		219	Here are four ways to get transparency. B<Do> read the manpage and option
		220	descriptions for the programs mentioned and rxvt-unicode. Really, do it!
		221
		222	1. Use inheritPixmap:
		223
		224	Esetroot wallpaper.jpg
		225	@@URXVT_NAME@@ -ip -tint red -sh 40
		226
		227	That works. If you think it doesn't, you lack transparency and tinting
		228	support, or you are unable to read.
		229
		230	2. Use a simple pixmap and emulate pseudo-transparency. This enables you
		231	to use effects other than tinting and shading: Just shade/tint/whatever
		232	your picture with gimp or any other tool:
		233
		234	convert wallpaper.jpg -blur 20x20 -modulate 30 background.xpm
		235	@@URXVT_NAME@@ -pixmap background.xpm -pe automove-background
		236
		237	That works. If you think it doesn't, you lack XPM and Perl support, or you
		238	are unable to read.
		239
		240	3. Use an ARGB visual:
		241
		242	@@URXVT_NAME@@ -depth 32 -fg grey90 -bg rgba:0000/0000/4444/cccc
		243
		244	This requires XFT support, and the support of your X-server. If that
		245	doesn't work for you, blame Xorg and Keith Packard. ARGB visuals aren't
		246	there yet, no matter what they claim. Rxvt-Unicode contains the neccessary
		247	bugfixes and workarounds for Xft and Xlib to make it work, but that
		248	doesn't mean that your WM has the required kludges in place.
		249
		250	4. Use xcompmgr and let it do the job:
		251
		252	xprop -frame -f _NET_WM_WINDOW_OPACITY 32c \
		253	-set _NET_WM_WINDOW_OPACITY 0xc0000000
		254
		255	Then click on a window you want to make transparent. Replace C<0xc0000000>
		256	by other values to change the degree of opacity. If it doesn't work and
		257	your server crashes, you got to keep the pieces.
		258
		259	=head3 Why does rxvt-unicode sometimes leave pixel droppings?
		260
		261	Most fonts were not designed for terminal use, which means that character
		262	size varies a lot. A font that is otherwise fine for terminal use might
		263	contain some characters that are simply too wide. Rxvt-unicode will avoid
		264	these characters. For characters that are just "a bit" too wide a special
		265	"careful" rendering mode is used that redraws adjacent characters.
		266
		267	All of this requires that fonts do not lie about character sizes,
		268	however: Xft fonts often draw glyphs larger than their acclaimed bounding
		269	box, and rxvt-unicode has no way of detecting this (the correct way is to
		270	ask for the character bounding box, which unfortunately is wrong in these
		271	cases).
		272
		273	It's not clear (to me at least), wether this is a bug in Xft, freetype,
		274	or the respective font. If you encounter this problem you might try using
		275	the C<-lsp> option to give the font more height. If that doesn't work, you
		276	might be forced to use a different font.
		277
		278	All of this is not a problem when using X11 core fonts, as their bounding
		279	box data is correct.
		280
		281	=head3 How can I keep rxvt-unicode from using reverse video so much?
		282
		283	First of all, make sure you are running with the right terminal settings
		284	(C<TERM=rxvt-unicode>), which will get rid of most of these effects. Then
		285	make sure you have specified colours for italic and bold, as otherwise
		286	rxvt-unicode might use reverse video to simulate the effect:
		287
		288	URxvt.colorBD: white
		289	URxvt.colorIT: green
		290
		291	=head3 Some programs assume totally weird colours (red instead of blue), how can I fix that?
		292
		293	For some unexplainable reason, some rare programs assume a very weird
		294	colour palette when confronted with a terminal with more than the standard
		295	8 colours (rxvt-unicode supports 88). The right fix is, of course, to fix
		296	these programs not to assume non-ISO colours without very good reasons.
		297
		298	In the meantime, you can either edit your C<rxvt-unicode> terminfo
		299	definition to only claim 8 colour support or use C<TERM=rxvt>, which will
		300	fix colours but keep you from using other rxvt-unicode features.
		301
		302	=head3 Can I switch the fonts at runtime?
		303
		304	Yes, using an escape sequence. Try something like this, which has the same
		305	effect as using the C<-fn> switch, and takes effect immediately:
		306
		307	printf '\e]50;%s\007' "9x15bold,xft:Kochi Gothic"
		308
		309	This is useful if you e.g. work primarily with japanese (and prefer a
		310	japanese font), but you have to switch to chinese temporarily, where
		311	japanese fonts would only be in your way.
		312
		313	You can think of this as a kind of manual ISO-2022 switching.
		314
		315	=head3 Why do italic characters look as if clipped?
		316
		317	Many fonts have difficulties with italic characters and hinting. For
		318	example, the otherwise very nicely hinted font C<xft:Bitstream Vera Sans
		319	Mono> completely fails in it's italic face. A workaround might be to
		320	enable freetype autohinting, i.e. like this:
		321
		322	URxvt.italicFont: xft:Bitstream Vera Sans Mono:italic:autohint=true
		323	URxvt.boldItalicFont: xft:Bitstream Vera Sans Mono:bold:italic:autohint=true
		324
377	=item Can I speed up Xft rendering somehow?	325	=head3 Can I speed up Xft rendering somehow?
378		326
379	Yes, the most obvious way to speed it up is to avoid Xft entirely, as	327	Yes, the most obvious way to speed it up is to avoid Xft entirely, as
380	it is simply slow. If you still want Xft fonts you might try to disable	328	it is simply slow. If you still want Xft fonts you might try to disable
381	antialiasing (by appending C<:antialiasing=false>), which saves lots of	329	antialiasing (by appending C<:antialias=false>), which saves lots of
382	memory and also speeds up rendering considerably.	330	memory and also speeds up rendering considerably.
383		331
384	=item Rxvt-unicode doesn't seem to anti-alias its fonts, what is wrong?	332	=head3 Rxvt-unicode doesn't seem to anti-alias its fonts, what is wrong?
385		333
386	Rxvt-unicode will use whatever you specify as a font. If it needs to	334	Rxvt-unicode will use whatever you specify as a font. If it needs to
387	fall back to it's default font search list it will prefer X11 core	335	fall back to it's default font search list it will prefer X11 core
388	fonts, because they are small and fast, and then use Xft fonts. It has	336	fonts, because they are small and fast, and then use Xft fonts. It has
389	antialiasing disabled for most of them, because the author thinks they	337	antialiasing disabled for most of them, because the author thinks they
390	look best that way.	338	look best that way.
391		339
392	If you want antialiasing, you have to specify the fonts manually.	340	If you want antialiasing, you have to specify the fonts manually.
393		341
394	=item Mouse cut/paste suddenly no longer works.
395
396	Make sure that mouse reporting is actually turned off since killing
397	some editors prematurely may leave the mouse in mouse report mode. I've
398	heard that tcsh may use mouse reporting unless it otherwise specified. A
399	quick check is to see if cut/paste works when the Alt or Shift keys are
400	depressed. See @@RXVT_NAME@@(7)
401
402	=item What's with this bold/blink stuff?	342	=head3 What's with this bold/blink stuff?
403		343
404	If no bold colour is set via C<colorBD:>, bold will invert text using the	344	If no bold colour is set via C<colorBD:>, bold will invert text using the
405	standard foreground colour.	345	standard foreground colour.
406		346
407	For the standard background colour, blinking will actually make the	347	For the standard background colour, blinking will actually make the
…		…
414		354
415	color0-7 are the low-intensity colors.	355	color0-7 are the low-intensity colors.
416		356
417	color8-15 are the corresponding high-intensity colors.	357	color8-15 are the corresponding high-intensity colors.
418		358
419	=item I don't like the screen colors. How do I change them?	359	=head3 I don't like the screen colors. How do I change them?
420		360
421	You can change the screen colors at run-time using F<~/.Xdefaults>	361	You can change the screen colors at run-time using F<~/.Xdefaults>
422	resources (or as long-options).	362	resources (or as long-options).
423		363
424	Here are values that are supposed to resemble a VGA screen,	364	Here are values that are supposed to resemble a VGA screen,
425	including the murky brown that passes for low-intensity yellow:	365	including the murky brown that passes for low-intensity yellow:
426		366
427	URxvt*color0: #000000	367	URxvt.color0: #000000
428	URxvt*color1: #A80000	368	URxvt.color1: #A80000
429	URxvt*color2: #00A800	369	URxvt.color2: #00A800
430	URxvt*color3: #A8A800	370	URxvt.color3: #A8A800
431	URxvt*color4: #0000A8	371	URxvt.color4: #0000A8
432	URxvt*color5: #A800A8	372	URxvt.color5: #A800A8
433	URxvt*color6: #00A8A8	373	URxvt.color6: #00A8A8
434	URxvt*color7: #A8A8A8	374	URxvt.color7: #A8A8A8
435		375
436	URxvt*color8: #000054	376	URxvt.color8: #000054
437	URxvt*color9: #FF0054	377	URxvt.color9: #FF0054
438	URxvt*color10: #00FF54	378	URxvt.color10: #00FF54
439	URxvt*color11: #FFFF54	379	URxvt.color11: #FFFF54
440	URxvt*color12: #0000FF	380	URxvt.color12: #0000FF
441	URxvt*color13: #FF00FF	381	URxvt.color13: #FF00FF
442	URxvt*color14: #00FFFF	382	URxvt.color14: #00FFFF
443	URxvt*color15: #FFFFFF	383	URxvt.color15: #FFFFFF
444		384
445	And here is a more complete set of non-standard colors described as	385	And here is a more complete set of non-standard colors.
446	"pretty girly":
447		386
448	URxvt.cursorColor: #dc74d1	387	URxvt.cursorColor: #dc74d1
449	URxvt.pointerColor: #dc74d1	388	URxvt.pointerColor: #dc74d1
450	URxvt.background: #0e0e0e	389	URxvt.background: #0e0e0e
451	URxvt.foreground: #4ad5e1	390	URxvt.foreground: #4ad5e1
…		…
462	URxvt.color6: #73f7ff	401	URxvt.color6: #73f7ff
463	URxvt.color14: #73f7ff	402	URxvt.color14: #73f7ff
464	URxvt.color7: #e1dddd	403	URxvt.color7: #e1dddd
465	URxvt.color15: #e1dddd	404	URxvt.color15: #e1dddd
466		405
		406	They have been described (not by me) as "pretty girly".
		407
		408	=head3 Why do some characters look so much different than others?
		409
		410	See next entry.
		411
		412	=head3 How does rxvt-unicode choose fonts?
		413
		414	Most fonts do not contain the full range of Unicode, which is
		415	fine. Chances are that the font you (or the admin/package maintainer of
		416	your system/os) have specified does not cover all the characters you want
		417	to display.
		418
		419	B<rxvt-unicode> makes a best-effort try at finding a replacement
		420	font. Often the result is fine, but sometimes the chosen font looks
		421	bad/ugly/wrong. Some fonts have totally strange characters that don't
		422	resemble the correct glyph at all, and rxvt-unicode lacks the artificial
		423	intelligence to detect that a specific glyph is wrong: it has to believe
		424	the font that the characters it claims to contain indeed look correct.
		425
		426	In that case, select a font of your taste and add it to the font list,
		427	e.g.:
		428
		429	@@URXVT_NAME@@ -fn basefont,font2,font3...
		430
		431	When rxvt-unicode sees a character, it will first look at the base
		432	font. If the base font does not contain the character, it will go to the
		433	next font, and so on. Specifying your own fonts will also speed up this
		434	search and use less resources within rxvt-unicode and the X-server.
		435
		436	The only limitation is that none of the fonts may be larger than the base
		437	font, as the base font defines the terminal character cell size, which
		438	must be the same due to the way terminals work.
		439
		440	=head3 Why do some chinese characters look so different than others?
		441
		442	This is because there is a difference between script and language --
		443	rxvt-unicode does not know which language the text that is output is,
		444	as it only knows the unicode character codes. If rxvt-unicode first
		445	sees a japanese/chinese character, it might choose a japanese font for
		446	display. Subsequent japanese characters will use that font. Now, many
		447	chinese characters aren't represented in japanese fonts, so when the first
		448	non-japanese character comes up, rxvt-unicode will look for a chinese font
		449	-- unfortunately at this point, it will still use the japanese font for
		450	chinese characters that are also in the japanese font.
		451
		452	The workaround is easy: just tag a chinese font at the end of your font
		453	list (see the previous question). The key is to view the font list as
		454	a preference list: If you expect more japanese, list a japanese font
		455	first. If you expect more chinese, put a chinese font first.
		456
		457	In the future it might be possible to switch language preferences at
		458	runtime (the internal data structure has no problem with using different
		459	fonts for the same character at the same time, but no interface for this
		460	has been designed yet).
		461
		462	Until then, you might get away with switching fonts at runtime (see L<Can
		463	I switch the fonts at runtime?> later in this document).
		464
		465	=head2 Keyboard, Mouse & User Interaction
		466
		467	=head3 The new selection selects pieces that are too big, how can I select single words?
		468
		469	If you want to select e.g. alphanumeric words, you can use the following
		470	setting:
		471
		472	URxvt.selection.pattern-0: ([[:word:]]+)
		473
		474	If you click more than twice, the selection will be extended
		475	more and more.
		476
		477	To get a selection that is very similar to the old code, try this pattern:
		478
		479	URxvt.selection.pattern-0: ([^"&'()*,;<=>?@[\\\\]^`{|})]+)
		480
		481	Please also note that the I<LeftClick Shift-LeftClik> combination also
		482	selects words like the old code.
		483
		484	=head3 I don't like the new selection/popups/hotkeys/perl, how do I change/disable it?
		485
		486	You can disable the perl extension completely by setting the
		487	B<perl-ext-common> resource to the empty string, which also keeps
		488	rxvt-unicode from initialising perl, saving memory.
		489
		490	If you only want to disable specific features, you first have to
		491	identify which perl extension is responsible. For this, read the section
		492	B<PREPACKAGED EXTENSIONS> in the @@URXVT_NAME@@perl(3) manpage. For
		493	example, to disable the B<selection-popup> and B<option-popup>, specify
		494	this B<perl-ext-common> resource:
		495
		496	URxvt.perl-ext-common: default,-selection-popup,-option-popup
		497
		498	This will keep the default extensions, but disable the two popup
		499	extensions. Some extensions can also be configured, for example,
		500	scrollback search mode is triggered by B<M-s>. You can move it to any
		501	other combination either by setting the B<searchable-scrollback> resource:
		502
		503	URxvt.searchable-scrollback: CM-s
		504
		505	=head3 The cursor moves when selecting text in the current input line, how do I switch this off?
		506
		507	See next entry.
		508
		509	=head3 During rlogin/ssh/telnet/etc. sessions, clicking near the cursor outputs strange escape sequences, how do I fix this?
		510
		511	These are caused by the C<readline> perl extension. Under normal
		512	circumstances, it will move your cursor around when you click into the
		513	line that contains it. It tries hard not to do this at the wrong moment,
		514	but when running a program that doesn't parse cursor movements or in some
		515	cases during rlogin sessions, it fails to detect this properly.
		516
		517	You can permamently switch this feature off by disabling the C<readline>
		518	extension:
		519
		520	URxvt.perl-ext-common: default,-readline
		521
		522	=head3 My numerical keypad acts weird and generates differing output?
		523
		524	Some Debian GNUL/Linux users seem to have this problem, although no
		525	specific details were reported so far. It is possible that this is caused
		526	by the wrong C<TERM> setting, although the details of wether and how
		527	this can happen are unknown, as C<TERM=rxvt> should offer a compatible
		528	keymap. See the answer to the previous question, and please report if that
		529	helped.
		530
		531	=head3 My Compose (Multi_key) key is no longer working.
		532
		533	The most common causes for this are that either your locale is not set
		534	correctly, or you specified a B<preeditStyle> that is not supported by
		535	your input method. For example, if you specified B<OverTheSpot> and
		536	your input method (e.g. the default input method handling Compose keys)
		537	does not support this (for instance because it is not visual), then
		538	rxvt-unicode will continue without an input method.
		539
		540	In this case either do not specify a B<preeditStyle> or specify more than
		541	one pre-edit style, such as B<OverTheSpot,Root,None>.
		542
		543	=head3 I cannot type C<Ctrl-Shift-2> to get an ASCII NUL character due to ISO 14755
		544
		545	Either try C<Ctrl-2> alone (it often is mapped to ASCII NUL even on
		546	international keyboards) or simply use ISO 14755 support to your
		547	advantage, typing <Ctrl-Shift-0> to get a ASCII NUL. This works for other
		548	codes, too, such as C<Ctrl-Shift-1-d> to type the default telnet escape
		549	character and so on.
		550
		551	=head3 Mouse cut/paste suddenly no longer works.
		552
		553	Make sure that mouse reporting is actually turned off since killing
		554	some editors prematurely may leave the mouse in mouse report mode. I've
		555	heard that tcsh may use mouse reporting unless it otherwise specified. A
		556	quick check is to see if cut/paste works when the Alt or Shift keys are
		557	depressed.
		558
467	=item What's with the strange Backspace/Delete key behaviour?	559	=head3 What's with the strange Backspace/Delete key behaviour?
468		560
469	Assuming that the physical Backspace key corresponds to the	561	Assuming that the physical Backspace key corresponds to the
470	BackSpace keysym (not likely for Linux ... see the following	562	BackSpace keysym (not likely for Linux ... see the following
471	question) there are two standard values that can be used for	563	question) there are two standard values that can be used for
472	Backspace: C<^H> and C<^?>.	564	Backspace: C<^H> and C<^?>.
…		…
483		575
484	For starting a new rxvt-unicode:	576	For starting a new rxvt-unicode:
485		577
486	# use Backspace = ^H	578	# use Backspace = ^H
487	$ stty erase ^H	579	$ stty erase ^H
488	$ @@RXVT_NAME@@	580	$ @@URXVT_NAME@@
489		581
490	# use Backspace = ^?	582	# use Backspace = ^?
491	$ stty erase ^?	583	$ stty erase ^?
492	$ @@RXVT_NAME@@	584	$ @@URXVT_NAME@@
493		585
494	Toggle with "ESC[36h" / "ESC[36l" as documented in @@RXVT_NAME@@(7).	586	Toggle with C<ESC [ 36 h> / C<ESC [ 36 l>.
495		587
496	For an existing rxvt-unicode:	588	For an existing rxvt-unicode:
497		589
498	# use Backspace = ^H	590	# use Backspace = ^H
499	$ stty erase ^H	591	$ stty erase ^H
…		…
508	properly reflects that.	600	properly reflects that.
509		601
510	The Delete key is a another casualty of the ill-defined Backspace problem.	602	The Delete key is a another casualty of the ill-defined Backspace problem.
511	To avoid confusion between the Backspace and Delete keys, the Delete	603	To avoid confusion between the Backspace and Delete keys, the Delete
512	key has been assigned an escape sequence to match the vt100 for Execute	604	key has been assigned an escape sequence to match the vt100 for Execute
513	(ESC[3~) and is in the supplied termcap/terminfo.	605	(C<ESC [ 3 ~>) and is in the supplied termcap/terminfo.
514		606
515	Some other Backspace problems:	607	Some other Backspace problems:
516		608
517	some editors use termcap/terminfo,	609	some editors use termcap/terminfo,
518	some editors (vim I'm told) expect Backspace = ^H,	610	some editors (vim I'm told) expect Backspace = ^H,
519	GNU Emacs (and Emacs-like editors) use ^H for help.	611	GNU Emacs (and Emacs-like editors) use ^H for help.
520		612
521	Perhaps someday this will all be resolved in a consistent manner.	613	Perhaps someday this will all be resolved in a consistent manner.
522		614
523	=item I don't like the key-bindings. How do I change them?	615	=head3 I don't like the key-bindings. How do I change them?
524		616
525	There are some compile-time selections available via configure. Unless	617	There are some compile-time selections available via configure. Unless
526	you have run "configure" with the C<--disable-resources> option you can	618	you have run "configure" with the C<--disable-resources> option you can
527	use the `keysym' resource to alter the keystrings associated with keysyms.	619	use the `keysym' resource to alter the keystrings associated with keysyms.
528		620
529	Here's an example for a URxvt session started using `@@RXVT_NAME@@ -name URxvt'	621	Here's an example for a URxvt session started using C<@@URXVT_NAME@@ -name URxvt>
530		622
531	URxvt.keysym.Home: \033[1~	623	URxvt.keysym.Home: \033[1~
532	URxvt.keysym.End: \033[4~	624	URxvt.keysym.End: \033[4~
533	URxvt.keysym.C-apostrophe: \033<C-'>	625	URxvt.keysym.C-apostrophe: \033<C-'>
534	URxvt.keysym.C-slash: \033<C-/>	626	URxvt.keysym.C-slash: \033<C-/>
…		…
549	URxvt.keysym.M-C-a: list \033<M-C- abcdefghijklmnopqrstuvwxyz >	641	URxvt.keysym.M-C-a: list \033<M-C- abcdefghijklmnopqrstuvwxyz >
550	URxvt.keysym.F12: command:\033]701;zh_CN.GBK\007	642	URxvt.keysym.F12: command:\033]701;zh_CN.GBK\007
551		643
552	See some more examples in the documentation for the B<keysym> resource.	644	See some more examples in the documentation for the B<keysym> resource.
553		645
554	=item I'm using keyboard model XXX that has extra Prior/Next/Insert keys.	646	=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
555	How do I make use of them? For example, the Sun Keyboard type 4
556	has the following mappings that rxvt-unicode doesn't recognize.
557		647
558	KP_Insert == Insert	648	KP_Insert == Insert
559	F22 == Print	649	F22 == Print
560	F27 == Home	650	F27 == Home
561	F29 == Prior	651	F29 == Prior
…		…
564		654
565	Rather than have rxvt-unicode try to accommodate all the various possible	655	Rather than have rxvt-unicode try to accommodate all the various possible
566	keyboard mappings, it is better to use `xmodmap' to remap the keys as	656	keyboard mappings, it is better to use `xmodmap' to remap the keys as
567	required for your particular machine.	657	required for your particular machine.
568		658
569	=item How do I distinguish if I'm running rxvt-unicode or a regular xterm?
570	I need this to decide about setting colors etc.
571		659
572	rxvt and rxvt-unicode always export the variable "COLORTERM", so you can
573	check and see if that is set. Note that several programs, JED, slrn,
574	Midnight Commander automatically check this variable to decide whether or
575	not to use color.
576		660
577	=item How do I set the correct, full IP address for the DISPLAY variable?	661	=head2 Terminal Configuration
578		662
579	If you've compiled rxvt-unicode with DISPLAY_IS_IP and have enabled	663	=head3 Why doesn't rxvt-unicode read my resources?
580	insecure mode then it is possible to use the following shell script
581	snippets to correctly set the display. If your version of rxvt-unicode
582	wasn't also compiled with ESCZ_ANSWER (as assumed in these snippets) then
583	the COLORTERM variable can be used to distinguish rxvt-unicode from a
584	regular xterm.
585		664
586	Courtesy of Chuck Blake <cblake@BBN.COM> with the following shell script	665	Well, why, indeed? It does, in a way very similar to other X
587	snippets:	666	applications. Most importantly, this means that if you or your OS loads
		667	resources into the X display (the right way to do it), rxvt-unicode will
		668	ignore any resource files in your home directory. It will only read
		669	F<$HOME/.Xdefaults> when no resources are attached to the display.
588		670
589	# Bourne/Korn/POSIX family of shells:	671	If you have or use an F<$HOME/.Xresources> file, chances are that
590	[ ${TERM:-foo} = foo ] && TERM=xterm # assume an xterm if we don't know	672	resources are loaded into your X-server. In this case, you have to
591	if [ ${TERM:-foo} = xterm ]; then	673	re-login after every change (or run F<xrdb -merge $HOME/.Xresources>).
592	stty -icanon -echo min 0 time 15 # see if enhanced rxvt or not
593	echo -n '^[Z'
594	read term_id
595	stty icanon echo
596	if [ ""${term_id} = '^[[?1;2C' -a ${DISPLAY:-foo} = foo ]; then
597	echo -n '^[[7n' # query the rxvt we are in for the DISPLAY string
598	read DISPLAY # set it in our local shell
599	fi
600	fi
601		674
602	=item How do I compile the manual pages for myself?	675	Also consider the form resources have to use:
603		676
604	You need to have a recent version of perl installed as F</usr/bin/perl>,	677	URxvt.resource: value
605	one that comes with F<pod2man>, F<pod2text> and F<pod2html>. Then go to
606	the doc subdirectory and enter C<make alldoc>.
607		678
608	=item My question isn't answered here, can I ask a human?	679	If you want to use another form (there are lots of different ways of
		680	specifying resources), make sure you understand wether and why it
		681	works. If unsure, use the form above.
609		682
610	Before sending me mail, you could go to IRC: C<irc.freenode.net>,	683	=head3 When I log-in to another system it tells me about missing terminfo data?
611	channel C<#rxvt-unicode> has some rxvt-unicode enthusiasts that might be
612	interested in learning about new and exciting problems (but not FAQs :).
613		684
614	=back	685	The terminal description used by rxvt-unicode is not as widely available
		686	as that for xterm, or even rxvt (for which the same problem often arises).
615		687
616	=head1 SYNOPSIS	688	The correct solution for this problem is to install the terminfo, this can
		689	be done like this (with ncurses' infocmp):
617		690
618	# set a new font set	691	REMOTE=remotesystem.domain
619	printf '\33]50;%s\007' 9x15,xft:Kochi" Mincho"	692	infocmp rxvt-unicode | ssh $REMOTE "cat >/tmp/ti && tic /tmp/ti"
620		693
621	# change the locale and tell rxvt-unicode about it	694	... or by installing rxvt-unicode normally on the remote system,
622	export LC_CTYPE=ja_JP.EUC-JP; printf "\33]701;$LC_CTYPE\007"
623		695
624	# set window title	696	If you cannot or do not want to do this, then you can simply set
625	printf '\33]2;%s\007' "new window title"	697	C<TERM=rxvt> or even C<TERM=xterm>, and live with the small number of
		698	problems arising, which includes wrong keymapping, less and different
		699	colours and some refresh errors in fullscreen applications. It's a nice
		700	quick-and-dirty workaround for rare cases, though.
626		701
627	=head1 DESCRIPTION	702	If you always want to do this (and are fine with the consequences) you
		703	can either recompile rxvt-unicode with the desired TERM value or use a
		704	resource to set it:
		705
		706	URxvt.termName: rxvt
		707
		708	If you don't plan to use B<rxvt> (quite common...) you could also replace
		709	the rxvt terminfo file with the rxvt-unicode one and use C<TERM=rxvt>.
		710
		711	=head3 C<tic> outputs some error when compiling the terminfo entry.
		712
		713	Most likely it's the empty definition for C<enacs=>. Just replace it by
		714	C<enacs=\E[0@> and try again.
		715
		716	=head3 C<bash>'s readline does not work correctly under @@URXVT_NAME@@.
		717
		718	See next entry.
		719
		720	=head3 I need a termcap file entry.
		721
		722	One reason you might want this is that some distributions or operating
		723	systems still compile some programs using the long-obsoleted termcap
		724	library (Fedora Core's bash is one example) and rely on a termcap entry
		725	for C<rxvt-unicode>.
		726
		727	You could use rxvt's termcap entry with resonable results in many cases.
		728	You can also create a termcap entry by using terminfo's infocmp program
		729	like this:
		730
		731	infocmp -C rxvt-unicode
		732
		733	Or you could use this termcap entry, generated by the command above:
		734
		735	rxvt-unicode|rxvt-unicode terminal (X Window System):\
		736	:am:bw:eo:km:mi:ms:xn:xo:\
		737	:co#80:it#8:li#24:lm#0:\
		738	:AL=\E[%dL:DC=\E[%dP:DL=\E[%dM:DO=\E[%dB:IC=\E[%d@:\
		739	:K1=\EOw:K2=\EOu:K3=\EOy:K4=\EOq:K5=\EOs:LE=\E[%dD:\
		740	:RI=\E[%dC:SF=\E[%dS:SR=\E[%dT:UP=\E[%dA:ae=\E(B:al=\E[L:\
		741	:as=\E(0:bl=^G:cd=\E[J:ce=\E[K:cl=\E[H\E[2J:\
		742	:cm=\E[%i%d;%dH:cr=^M:cs=\E[%i%d;%dr:ct=\E[3g:dc=\E[P:\
		743	:dl=\E[M:do=^J:ec=\E[%dX:ei=\E[4l:ho=\E[H:\
		744	:i1=\E[?47l\E=\E[?1l:ic=\E[@:im=\E[4h:\
		745	:is=\E[r\E[m\E[2J\E[H\E[?7h\E[?1;3;4;6l\E[4l:\
		746	:k1=\E[11~:k2=\E[12~:k3=\E[13~:k4=\E[14~:k5=\E[15~:\
		747	:k6=\E[17~:k7=\E[18~:k8=\E[19~:k9=\E[20~:kD=\E[3~:\
		748	:kI=\E[2~:kN=\E[6~:kP=\E[5~:kb=\177:kd=\EOB:ke=\E[?1l\E>:\
		749	:kh=\E[7~:kl=\EOD:kr=\EOC:ks=\E[?1h\E=:ku=\EOA:le=^H:\
		750	:mb=\E[5m:md=\E[1m:me=\E[m\017:mr=\E[7m:nd=\E[C:rc=\E8:\
		751	:sc=\E7:se=\E[27m:sf=^J:so=\E[7m:sr=\EM:st=\EH:ta=^I:\
		752	:te=\E[r\E[?1049l:ti=\E[?1049h:ue=\E[24m:up=\E[A:\
		753	:us=\E[4m:vb=\E[?5h\E[?5l:ve=\E[?25h:vi=\E[?25l:\
		754	:vs=\E[?25h:
		755
		756	=head3 Why does C<ls> no longer have coloured output?
		757
		758	The C<ls> in the GNU coreutils unfortunately doesn't use terminfo to
		759	decide wether a terminal has colour, but uses it's own configuration
		760	file. Needless to say, C<rxvt-unicode> is not in it's default file (among
		761	with most other terminals supporting colour). Either add:
		762
		763	TERM rxvt-unicode
		764
		765	to C</etc/DIR_COLORS> or simply add:
		766
		767	alias ls='ls --color=auto'
		768
		769	to your C<.profile> or C<.bashrc>.
		770
		771	=head3 Why doesn't vim/emacs etc. use the 88 colour mode?
		772
		773	See next entry.
		774
		775	=head3 Why doesn't vim/emacs etc. make use of italic?
		776
		777	See next entry.
		778
		779	=head3 Why are the secondary screen-related options not working properly?
		780
		781	Make sure you are using C<TERM=rxvt-unicode>. Some pre-packaged
		782	distributions (most notably Debian GNU/Linux) break rxvt-unicode
		783	by setting C<TERM> to C<rxvt>, which doesn't have these extra
		784	features. Unfortunately, some of these (most notably, again, Debian
		785	GNU/Linux) furthermore fail to even install the C<rxvt-unicode> terminfo
		786	file, so you will need to install it on your own (See the question B<When
		787	I log-in to another system it tells me about missing terminfo data?> on
		788	how to do this).
		789
		790
		791	=head2 Encoding / Locale / Input Method Issues
		792
		793	=head3 Rxvt-unicode does not seem to understand the selected encoding?
		794
		795	See next entry.
		796
		797	=head3 Unicode does not seem to work?
		798
		799	If you encounter strange problems like typing an accented character but
		800	getting two unrelated other characters or similar, or if program output is
		801	subtly garbled, then you should check your locale settings.
		802
		803	Rxvt-unicode must be started with the same C<LC_CTYPE> setting as the
		804	programs. Often rxvt-unicode is started in the C<C> locale, while the
		805	login script running within the rxvt-unicode window changes the locale to
		806	something else, e.g. C<en_GB.UTF-8>. Needless to say, this is not going to work.
		807
		808	The best thing is to fix your startup environment, as you will likely run
		809	into other problems. If nothing works you can try this in your .profile.
		810
		811	printf '\e]701;%s\007' "$LC_CTYPE"
		812
		813	If this doesn't work, then maybe you use a C<LC_CTYPE> specification not
		814	supported on your systems. Some systems have a C<locale> command which
		815	displays this (also, C<perl -e0> can be used to check locale settings, as
		816	it will complain loudly if it cannot set the locale). If it displays something
		817	like:
		818
		819	locale: Cannot set LC_CTYPE to default locale: ...
		820
		821	Then the locale you specified is not supported on your system.
		822
		823	If nothing works and you are sure that everything is set correctly then
		824	you will need to remember a little known fact: Some programs just don't
		825	support locales :(
		826
		827	=head3 How does rxvt-unicode determine the encoding to use?
		828
		829	See next entry.
		830
		831	=head3 Is there an option to switch encodings?
		832
		833	Unlike some other terminals, rxvt-unicode has no encoding switch, and no
		834	specific "utf-8" mode, such as xterm. In fact, it doesn't even know about
		835	UTF-8 or any other encodings with respect to terminal I/O.
		836
		837	The reasons is that there exists a perfectly fine mechanism for selecting
		838	the encoding, doing I/O and (most important) communicating this to all
		839	applications so everybody agrees on character properties such as width
		840	and code number. This mechanism is the I<locale>. Applications not using
		841	that info will have problems (for example, C<xterm> gets the width of
		842	characters wrong as it uses it's own, locale-independent table under all
		843	locales).
		844
		845	Rxvt-unicode uses the C<LC_CTYPE> locale category to select encoding. All
		846	programs doing the same (that is, most) will automatically agree in the
		847	interpretation of characters.
		848
		849	Unfortunately, there is no system-independent way to select locales, nor
		850	is there a standard on how locale specifiers will look like.
		851
		852	On most systems, the content of the C<LC_CTYPE> environment variable
		853	contains an arbitrary string which corresponds to an already-installed
		854	locale. Common names for locales are C<en_US.UTF-8>, C<de_DE.ISO-8859-15>,
		855	C<ja_JP.EUC-JP>, i.e. C<language_country.encoding>, but other forms
		856	(i.e. C<de> or C<german>) are also common.
		857
		858	Rxvt-unicode ignores all other locale categories, and except for
		859	the encoding, ignores country or language-specific settings,
		860	i.e. C<de_DE.UTF-8> and C<ja_JP.UTF-8> are the normally same to
		861	rxvt-unicode.
		862
		863	If you want to use a specific encoding you have to make sure you start
		864	rxvt-unicode with the correct C<LC_CTYPE> category.
		865
		866	=head3 Can I switch locales at runtime?
		867
		868	Yes, using an escape sequence. Try something like this, which sets
		869	rxvt-unicode's idea of C<LC_CTYPE>.
		870
		871	printf '\e]701;%s\007' ja_JP.SJIS
		872
		873	See also the previous answer.
		874
		875	Sometimes this capability is rather handy when you want to work in
		876	one locale (e.g. C<de_DE.UTF-8>) but some programs don't support it
		877	(e.g. UTF-8). For example, I use this script to start C<xjdic>, which
		878	first switches to a locale supported by xjdic and back later:
		879
		880	printf '\e]701;%s\007' ja_JP.SJIS
		881	xjdic -js
		882	printf '\e]701;%s\007' de_DE.UTF-8
		883
		884	You can also use xterm's C<luit> program, which usually works fine, except
		885	for some locales where character width differs between program- and
		886	rxvt-unicode-locales.
		887
		888	=head3 My input method wants <some encoding> but I want UTF-8, what can I do?
		889
		890	You can specify separate locales for the input method and the rest of the
		891	terminal, using the resource C<imlocale>:
		892
		893	URxvt.imlocale: ja_JP.EUC-JP
		894
		895	Now you can start your terminal with C<LC_CTYPE=ja_JP.UTF-8> and still
		896	use your input method. Please note, however, that you will not be able to
		897	input characters outside C<EUC-JP> in a normal way then, as your input
		898	method limits you.
		899
		900	=head3 Rxvt-unicode crashes when the X Input Method changes or exits.
		901
		902	Unfortunately, this is unavoidable, as the XIM protocol is racy by
		903	design. Applications can avoid some crashes at the expense of memory
		904	leaks, and Input Methods can avoid some crashes by careful ordering at
		905	exit time. B<kinput2> (and derived input methods) generally succeeds,
		906	while B<SCIM> (or similar input methods) fails. In the end, however,
		907	crashes cannot be completely avoided even if both sides cooperate.
		908
		909	So the only workaround is not to kill your Input Method Servers.
		910
		911
		912	=head2 Operating Systems / Package Maintaining
		913
		914	=head3 I am using Debian GNU/Linux and have a problem...
		915
		916	The Debian GNU/Linux package of rxvt-unicode in sarge contains large
		917	patches that considerably change the behaviour of rxvt-unicode (but
		918	unfortunately this notice has been removed). Before reporting a bug to
		919	the original rxvt-unicode author please download and install the genuine
		920	version (L<http://software.schmorp.de#rxvt-unicode>) and try to reproduce
		921	the problem. If you cannot, chances are that the problems are specific to
		922	Debian GNU/Linux, in which case it should be reported via the Debian Bug
		923	Tracking System (use C<reportbug> to report the bug).
		924
		925	For other problems that also affect the Debian package, you can and
		926	probably should use the Debian BTS, too, because, after all, it's also a
		927	bug in the Debian version and it serves as a reminder for other users that
		928	might encounter the same issue.
		929
		930	=head3 I am maintaining rxvt-unicode for distribution/OS XXX, any recommendation?
		931
		932	You should build one binary with the default options. F<configure>
		933	now enables most useful options, and the trend goes to making them
		934	runtime-switchable, too, so there is usually no drawback to enbaling them,
		935	except higher disk and possibly memory usage. The perl interpreter should
		936	be enabled, as important functionality (menus, selection, likely more in
		937	the future) depends on it.
		938
		939	You should not overwrite the C<perl-ext-common> snd C<perl-ext> resources
		940	system-wide (except maybe with C<defaults>). This will result in useful
		941	behaviour. If your distribution aims at low memory, add an empty
		942	C<perl-ext-common> resource to the app-defaults file. This will keep the
		943	perl interpreter disabled until the user enables it.
		944
		945	If you can/want build more binaries, I recommend building a minimal
		946	one with C<--disable-everything> (very useful) and a maximal one with
		947	C<--enable-everything> (less useful, it will be very big due to a lot of
		948	encodings built-in that increase download times and are rarely used).
		949
		950	=head3 I need to make it setuid/setgid to support utmp/ptys on my OS, is this safe?
		951
		952	It should be, starting with release 7.1. You are encouraged to properly
		953	install urxvt with privileges necessary for your OS now.
		954
		955	When rxvt-unicode detects that it runs setuid or setgid, it will fork
		956	into a helper process for privileged operations (pty handling on some
		957	systems, utmp/wtmp/lastlog handling on others) and drop privileges
		958	immediately. This is much safer than most other terminals that keep
		959	privileges while running (but is more relevant to urxvt, as it contains
		960	things as perl interpreters, which might be "helpful" to attackers).
		961
		962	This forking is done as the very first within main(), which is very early
		963	and reduces possible bugs to initialisation code run before main(), or
		964	things like the dynamic loader of your system, which should result in very
		965	little risk.
		966
		967	=head3 On Solaris 9, many line-drawing characters are too wide.
		968
		969	Seems to be a known bug, read
		970	L<http://nixdoc.net/files/forum/about34198.html>. Some people use the
		971	following ugly workaround to get non-double-wide-characters working:
		972
		973	#define wcwidth(x) wcwidth(x) > 1 ? 1 : wcwidth(x)
		974
		975	=head3 I am on FreeBSD and rxvt-unicode does not seem to work at all.
		976
		977	Rxvt-unicode requires the symbol C<__STDC_ISO_10646__> to be defined
		978	in your compile environment, or an implementation that implements it,
		979	wether it defines the symbol or not. C<__STDC_ISO_10646__> requires that
		980	B<wchar_t> is represented as unicode.
		981
		982	As you might have guessed, FreeBSD does neither define this symobl nor
		983	does it support it. Instead, it uses it's own internal representation of
		984	B<wchar_t>. This is, of course, completely fine with respect to standards.
		985
		986	However, that means rxvt-unicode only works in C<POSIX>, C<ISO-8859-1> and
		987	C<UTF-8> locales under FreeBSD (which all use Unicode as B<wchar_t>.
		988
		989	C<__STDC_ISO_10646__> is the only sane way to support multi-language
		990	apps in an OS, as using a locale-dependent (and non-standardized)
		991	representation of B<wchar_t> makes it impossible to convert between
		992	B<wchar_t> (as used by X11 and your applications) and any other encoding
		993	without implementing OS-specific-wrappers for each and every locale. There
		994	simply are no APIs to convert B<wchar_t> into anything except the current
		995	locale encoding.
		996
		997	Some applications (such as the formidable B<mlterm>) work around this
		998	by carrying their own replacement functions for character set handling
		999	with them, and either implementing OS-dependent hacks or doing multiple
		1000	conversions (which is slow and unreliable in case the OS implements
		1001	encodings slightly different than the terminal emulator).
		1002
		1003	The rxvt-unicode author insists that the right way to fix this is in the
		1004	system libraries once and for all, instead of forcing every app to carry
		1005	complete replacements for them :)
		1006
		1007	=head3 I use Solaris 9 and it doesn't compile/work/etc.
		1008
		1009	Try the diff in F<doc/solaris9.patch> as a base. It fixes the worst
		1010	problems with C<wcwidth> and a compile problem.
		1011
		1012	=head3 How can I use rxvt-unicode under cygwin?
		1013
		1014	rxvt-unicode should compile and run out of the box on cygwin, using
		1015	the X11 libraries that come with cygwin. libW11 emulation is no
		1016	longer supported (and makes no sense, either, as it only supported a
		1017	single font). I recommend starting the X-server in C<-multiwindow> or
		1018	C<-rootless> mode instead, which will result in similar look&feel as the
		1019	old libW11 emulation.
		1020
		1021	At the time of this writing, cygwin didn't seem to support any multi-byte
		1022	encodings (you might try C<LC_CTYPE=C-UTF-8>), so you are likely limited
		1023	to 8-bit encodings.
		1024
		1025	=head1 RXVT-UNICODE TECHNICAL REFERENCE
628		1026
629	The rest of this document describes various technical aspects of	1027	The rest of this document describes various technical aspects of
630	B<rxvt-unicode>. First the description of supported command sequences,	1028	B<rxvt-unicode>. First the description of supported command sequences,
631	followed by menu and pixmap support and last by a description of all	1029	followed by pixmap support and last by a description of all features
632	features selectable at C<configure> time.	1030	selectable at C<configure> time.
633		1031
634	=head1 RXVT TECHNICAL REFERENCE
635
636	=head1 Definitions	1032	=head2 Definitions
637		1033
638	=over 4	1034	=over 4
639		1035
640	=item B<< C<c> >>	1036	=item B<< C<c> >>
641		1037
…		…
659		1055
660	A text parameter composed of printable characters.	1056	A text parameter composed of printable characters.
661		1057
662	=back	1058	=back
663		1059
664	=head1 Values	1060	=head2 Values
665		1061
666	=over 4	1062	=over 4
667		1063
668	=item B<< C<ENQ> >>	1064	=item B<< C<ENQ> >>
669		1065
…		…
712		1108
713	Space Character	1109	Space Character
714		1110
715	=back	1111	=back
716		1112
717	=head1 Escape Sequences	1113	=head2 Escape Sequences
718		1114
719	=over 4	1115	=over 4
720		1116
721	=item B<< C<ESC # 8> >>	1117	=item B<< C<ESC # 8> >>
722		1118
…		…
768	Single Shift Select of G3 Character Set (SS3): affects next character	1164	Single Shift Select of G3 Character Set (SS3): affects next character
769	only I<unimplemented>	1165	only I<unimplemented>
770		1166
771	=item B<< C<ESC Z> >>	1167	=item B<< C<ESC Z> >>
772		1168
773	Obsolete form of returns: B<< C<ESC[?1;2C> >> I<rxvt-unicode compile-time option>	1169	Obsolete form of returns: B<< C<ESC [ ? 1 ; 2 C> >> I<rxvt-unicode compile-time option>
774		1170
775	=item B<< C<ESC c> >>	1171	=item B<< C<ESC c> >>
776		1172
777	Full reset (RIS)	1173	Full reset (RIS)
778		1174
…		…
782		1178
783	=item B<< C<ESC o> >>	1179	=item B<< C<ESC o> >>
784		1180
785	Invoke the G3 Character Set (LS3)	1181	Invoke the G3 Character Set (LS3)
786		1182
787	=item B<< C<ESC> ( C> >>	1183	=item B<< C<ESC ( C> >>
788		1184
789	Designate G0 Character Set (ISO 2022), see below for values of C<C>.	1185	Designate G0 Character Set (ISO 2022), see below for values of C<C>.
790		1186
791	=item B<< C<ESC> ) C> >>	1187	=item B<< C<ESC ) C> >>
792		1188
793	Designate G1 Character Set (ISO 2022), see below for values of C<C>.	1189	Designate G1 Character Set (ISO 2022), see below for values of C<C>.
794		1190
795	=item B<< C<ESC * C> >>	1191	=item B<< C<ESC * C> >>
796		1192
…		…
820		1216
821	=back	1217	=back
822		1218
823	X<CSI>	1219	X<CSI>
824		1220
825	=head1 CSI (Command Sequence Introducer) Sequences	1221	=head2 CSI (Command Sequence Introducer) Sequences
826		1222
827	=over 4	1223	=over 4
828		1224
829	=item B<< C<ESC [ Ps @> >>	1225	=item B<< C<ESC [ Ps @> >>
830		1226
…		…
937		1333
938	=item B<< C<ESC [ Ps c> >>	1334	=item B<< C<ESC [ Ps c> >>
939		1335
940	Send Device Attributes (DA)	1336	Send Device Attributes (DA)
941	B<< C<Ps = 0> >> (or omitted): request attributes from terminal	1337	B<< C<Ps = 0> >> (or omitted): request attributes from terminal
942	returns: B<< C<ESC[?1;2c> >> (``I am a VT100 with Advanced Video	1338	returns: B<< C<ESC [ ? 1 ; 2 c> >> (``I am a VT100 with Advanced Video
943	Option'')	1339	Option'')
944		1340
945	=item B<< C<ESC [ Ps d> >>	1341	=item B<< C<ESC [ Ps d> >>
946		1342
947	Cursor to Line B<< C<Ps> >> (VPA)	1343	Cursor to Line B<< C<Ps> >> (VPA)
…		…
1077	B<< C<Ps = 4> >> B<< C<ESC [ 4 ; H ; W t> >> Resize to WxH pixels	1473	B<< C<Ps = 4> >> B<< C<ESC [ 4 ; H ; W t> >> Resize to WxH pixels
1078	B<< C<Ps = 5> >> Raise window	1474	B<< C<Ps = 5> >> Raise window
1079	B<< C<Ps = 6> >> Lower window	1475	B<< C<Ps = 6> >> Lower window
1080	B<< C<Ps = 7> >> Refresh screen once	1476	B<< C<Ps = 7> >> Refresh screen once
1081	B<< C<Ps = 8> >> B<< C<ESC [ 8 ; R ; C t> >> Resize to R rows and C columns	1477	B<< C<Ps = 8> >> B<< C<ESC [ 8 ; R ; C t> >> Resize to R rows and C columns
1082	B<< C<Ps = 11> >> Report window state (responds with C<Ps = 1> or C<Ps = 2>	1478	B<< C<Ps = 11> >> Report window state (responds with C<Ps = 1> or C<Ps = 2>)
1083	B<< C<Ps = 13> >> Report window position (responds with C<Ps = 3>)	1479	B<< C<Ps = 13> >> Report window position (responds with C<Ps = 3>)
1084	B<< C<Ps = 14> >> Report window pixel size (responds with C<Ps = 4>)	1480	B<< C<Ps = 14> >> Report window pixel size (responds with C<Ps = 4>)
1085	B<< C<Ps = 18> >> Report window text size (responds with C<Ps = 7>)	1481	B<< C<Ps = 18> >> Report window text size (responds with C<Ps = 7>)
1086	B<< C<Ps = 19> >> Currently the same as C<Ps = 18>, but responds with C<Ps = 9>	1482	B<< C<Ps = 19> >> Currently the same as C<Ps = 18>, but responds with C<Ps = 9>
1087	B<< C<Ps = 20> >> Reports icon label (B<< C<ESC ] L NAME \234> >>)	1483	B<< C<Ps = 20> >> Reports icon label (B<< C<ESC ] L NAME \234> >>)
…		…
1100		1496
1101	=back	1497	=back
1102		1498
1103	X<PrivateModes>	1499	X<PrivateModes>
1104		1500
1105	=head1 DEC Private Modes	1501	=head2 DEC Private Modes
1106		1502
1107	=over 4	1503	=over 4
1108		1504
1109	=item B<< C<ESC [ ? Pm h> >>	1505	=item B<< C<ESC [ ? Pm h> >>
1110		1506
…		…
1207	B<< C<h> >> Send Mouse X & Y on button press.	1603	B<< C<h> >> Send Mouse X & Y on button press.
1208	B<< C<l> >> No mouse reporting.	1604	B<< C<l> >> No mouse reporting.
1209		1605
1210	=end table	1606	=end table
1211		1607
1212	=item B<< C<Ps = 10> >> (B<rxvt>)
1213
1214	=begin table
1215
1216	B<< C<h> >> menuBar visible
1217	B<< C<l> >> menuBar invisible
1218
1219	=end table
1220
1221	=item B<< C<Ps = 25> >>	1608	=item B<< C<Ps = 25> >>
1222		1609
1223	=begin table	1610	=begin table
1224		1611
1225	B<< C<h> >> Visible cursor {cnorm/cvvis}	1612	B<< C<h> >> Visible cursor {cnorm/cvvis}
…		…
1341	B<< C<h> >> Scroll to bottom when a key is pressed	1728	B<< C<h> >> Scroll to bottom when a key is pressed
1342	B<< C<l> >> Don't scroll to bottom when a key is pressed	1729	B<< C<l> >> Don't scroll to bottom when a key is pressed
1343		1730
1344	=end table	1731	=end table
1345		1732
		1733	=item B<< C<Ps = 1021> >> (B<rxvt>)
		1734
		1735	=begin table
		1736
		1737	B<< C<h> >> Bold/italic implies high intensity (see option B<-is>)
		1738	B<< C<l> >> Font styles have no effect on intensity (Compile styles)
		1739
		1740	=end table
		1741
1346	=item B<< C<Ps = 1047> >>	1742	=item B<< C<Ps = 1047> >>
1347		1743
1348	=begin table	1744	=begin table
1349		1745
1350	B<< C<h> >> Use Alternate Screen Buffer	1746	B<< C<h> >> Use Alternate Screen Buffer
…		…
1374		1770
1375	=back	1771	=back
1376		1772
1377	X<XTerm>	1773	X<XTerm>
1378		1774
1379	=head1 XTerm Operating System Commands	1775	=head2 XTerm Operating System Commands
1380		1776
1381	=over 4	1777	=over 4
1382		1778
1383	=item B<< C<ESC ] Ps;Pt ST> >>	1779	=item B<< C<ESC ] Ps;Pt ST> >>
1384		1780
…		…
1396	B<< C<Ps = 10> >> Change colour of text foreground to B<< C<Pt> >> B<(NB: may change in future)>	1792	B<< C<Ps = 10> >> Change colour of text foreground to B<< C<Pt> >> B<(NB: may change in future)>
1397	B<< C<Ps = 11> >> Change colour of text background to B<< C<Pt> >> B<(NB: may change in future)>	1793	B<< C<Ps = 11> >> Change colour of text background to B<< C<Pt> >> B<(NB: may change in future)>
1398	B<< C<Ps = 12> >> Change colour of text cursor foreground to B<< C<Pt> >>	1794	B<< C<Ps = 12> >> Change colour of text cursor foreground to B<< C<Pt> >>
1399	B<< C<Ps = 13> >> Change colour of mouse foreground to B<< C<Pt> >>	1795	B<< C<Ps = 13> >> Change colour of mouse foreground to B<< C<Pt> >>
1400	B<< C<Ps = 17> >> Change colour of highlight characters to B<< C<Pt> >>	1796	B<< C<Ps = 17> >> Change colour of highlight characters to B<< C<Pt> >>
1401	B<< C<Ps = 18> >> Change colour of bold characters to B<< C<Pt> >>	1797	B<< C<Ps = 18> >> Change colour of bold characters to B<< C<Pt> >> [deprecated, see 706]
1402	B<< C<Ps = 19> >> Change colour of underlined characters to B<< C<Pt> >>	1798	B<< C<Ps = 19> >> Change colour of underlined characters to B<< C<Pt> >> [deprecated, see 707]
		1799	B<< C<Ps = 20> >> Change background pixmap parameters (see section XPM) (Compile XPM).
1403	B<< C<Ps = 20> >> Change default background to B<< C<Pt> >>	1800	B<< C<Ps = 39> >> Change default foreground colour to B<< C<Pt> >>.
1404	B<< C<Ps = 39> >> Change default foreground colour to B<< C<Pt> >> I<rxvt compile-time option>
1405	B<< C<Ps = 46> >> Change Log File to B<< C<Pt> >> I<unimplemented>	1801	B<< C<Ps = 46> >> Change Log File to B<< C<Pt> >> I<unimplemented>
1406	B<< C<Ps = 49> >> Change default background colour to B<< C<Pt> >> I<rxvt compile-time option>	1802	B<< C<Ps = 49> >> Change default background colour to B<< C<Pt> >>.
1407	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> >>	1803	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> >>
1408	B<< C<Ps = 55> >> Log all scrollback buffer and all of screen to B<< C<Pt> >>	1804	B<< C<Ps = 55> >> Log all scrollback buffer and all of screen to B<< C<Pt> >>
1409	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)	1805	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).
1410	B<< C<Ps = 703> >> Menubar command B<< C<Pt> >> I<rxvt compile-time option> (rxvt-unicode extension)	1806	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>.
1411	B<< C<Ps = 704> >> Change colour of italic characters to B<< C<Pt> >>	1807	B<< C<Ps = 704> >> Change colour of italic characters to B<< C<Pt> >>
1412	B<< C<Ps = 705> >> Change background pixmap tint colour to B<< C<Pt> >>	1808	B<< C<Ps = 705> >> Change background pixmap tint colour to B<< C<Pt> >> (Compile transparency).
		1809	B<< C<Ps = 706> >> Change colour of bold characters to B<< C<Pt> >>
		1810	B<< C<Ps = 707> >> Change colour of underlined characters to B<< C<Pt> >>
1413	B<< C<Ps = 710> >> Set normal fontset to B<< C<Pt> >>. Same as C<Ps = 50>.	1811	B<< C<Ps = 710> >> Set normal fontset to B<< C<Pt> >>. Same as C<Ps = 50>.
1414	B<< C<Ps = 711> >> Set bold fontset to B<< C<Pt> >>. Similar to C<Ps = 50>.	1812	B<< C<Ps = 711> >> Set bold fontset to B<< C<Pt> >>. Similar to C<Ps = 50> (Compile styles).
1415	B<< C<Ps = 712> >> Set italic fontset to B<< C<Pt> >>. Similar to C<Ps = 50>.	1813	B<< C<Ps = 712> >> Set italic fontset to B<< C<Pt> >>. Similar to C<Ps = 50> (Compile styles).
1416	B<< C<Ps = 713> >> Set bold-italic fontset to B<< C<Pt> >>. Similar to C<Ps = 50>.	1814	B<< C<Ps = 713> >> Set bold-italic fontset to B<< C<Pt> >>. Similar to C<Ps = 50> (Compile styles).
		1815	B<< C<Ps = 720> >> Move viewing window up by B<< C<Pt> >> lines, or clear scrollback buffer if C<Pt = 0> (Compile frills).
		1816	B<< C<Ps = 721> >> Move viewing window down by B<< C<Pt> >> lines, or clear scrollback buffer if C<Pt = 0> (Compile frills).
		1817	B<< C<Ps = 777> >> Call the perl extension with the given string, which should be of the form C<extension:parameters> (Compile perl).
1417		1818
1418	=end table	1819	=end table
1419		1820
1420	=back	1821	=back
1421
1422	X<menuBar>
1423
1424	=head1 menuBar
1425
1426	B<< The exact syntax used is I<almost> solidified. >>
1427	In the menus, B<DON'T> try to use menuBar commands that add or remove a
1428	menuBar.
1429
1430	Note that in all of the commands, the B<< I</path/> >> I<cannot> be
1431	omitted: use B<./> to specify a menu relative to the current menu.
1432
1433	=head2 Overview of menuBar operation
1434
1435	For the menuBar XTerm escape sequence C<ESC ] 703 ; Pt ST>, the syntax
1436	of C<Pt> can be used for a variety of tasks:
1437
1438	At the top level is the current menuBar which is a member of a circular
1439	linked-list of other such menuBars.
1440
1441	The menuBar acts as a parent for the various drop-down menus, which in
1442	turn, may have labels, separator lines, menuItems and subMenus.
1443
1444	The menuItems are the useful bits: you can use them to mimic keyboard
1445	input or even to send text or escape sequences back to rxvt.
1446
1447	The menuBar syntax is intended to provide a simple yet robust method of
1448	constructing and manipulating menus and navigating through the
1449	menuBars.
1450
1451	The first step is to use the tag B<< [menu:I<name>] >> which creates
1452	the menuBar called I<name> and allows access. You may now or menus,
1453	subMenus, and menuItems. Finally, use the tag B<[done]> to set the
1454	menuBar access as B<readonly> to prevent accidental corruption of the
1455	menus. To re-access the current menuBar for alterations, use the tag
1456	B<[menu]>, make the alterations and then use B<[done]>
1457
1458	X<menuBarCommands>
1459
1460	=head2 Commands
1461
1462	=over 4
1463
1464	=item B<< [menu:+I<name>] >>
1465
1466	access the named menuBar for creation or alteration. If a new menuBar
1467	is created, it is called I<name> (max of 15 chars) and the current
1468	menuBar is pushed onto the stack
1469
1470	=item B<[menu]>
1471
1472	access the current menuBar for alteration
1473
1474	=item B<< [title:+I<string>] >>
1475
1476	set the current menuBar's title to I<string>, which may contain the
1477	following format specifiers:
1478	B<%%> : literal B<%> character
1479	B<%n> : rxvt name (as per the B<-name> command-line option)
1480	B<%v> : rxvt version
1481
1482	=item B<[done]>
1483
1484	set menuBar access as B<readonly>.
1485	End-of-file tag for B<< [read:+I<file>] >> operations.
1486
1487	=item B<< [read:+I<file>] >>
1488
1489	read menu commands directly from I<file> (extension ".menu" will be
1490	appended if required.) Start reading at a line with B<[menu]> or B<<
1491	[menu:+I<name> >> and continuing until B<[done]> is encountered.
1492
1493	Blank and comment lines (starting with B<#>) are ignored. Actually,
1494	since any invalid menu commands are also ignored, almost anything could
1495	be construed as a comment line, but this may be tightened up in the
1496	future ... so don't count on it!.
1497
1498	=item B<< [read:+I<file>;+I<name>] >>
1499
1500	The same as B<< [read:+I<file>] >>, but start reading at a line with
1501	B<< [menu:+I<name>] >> and continuing until B<< [done:+I<name>] >> or
1502	B<[done]> is encountered.
1503
1504	=item B<[dump]>
1505
1506	dump all menuBars to the file B</tmp/rxvt-PID> in a format suitable for
1507	later rereading.
1508
1509	=item B<[rm:name]>
1510
1511	remove the named menuBar
1512
1513	=item B<[rm] [rm:]>
1514
1515	remove the current menuBar
1516
1517	=item B<[rm*] [rm:*]>
1518
1519	remove all menuBars
1520
1521	=item B<[swap]>
1522
1523	swap the top two menuBars
1524
1525	=item B<[prev]>
1526
1527	access the previous menuBar
1528
1529	=item B<[next]>
1530
1531	access the next menuBar
1532
1533	=item B<[show]>
1534
1535	Enable display of the menuBar
1536
1537	=item B<[hide]>
1538
1539	Disable display of the menuBar
1540
1541	=item B<< [pixmap:+I<name>] >>
1542
1543	=item B<< [pixmap:+I<name>;I<scaling>] >>
1544
1545	(set the background pixmap globally
1546
1547	B<< A Future implementation I<may> make this local to the menubar >>)
1548
1549	=item B<< [:+I<command>:] >>
1550
1551	ignore the menu readonly status and issue a I<command> to or a menu or
1552	menuitem or change the ; a useful shortcut for setting the quick arrows
1553	from a menuBar.
1554
1555	=back
1556
1557	X<menuBarAdd>
1558
1559	=head2 Adding and accessing menus
1560
1561	The following commands may also be B<+> prefixed.
1562
1563	=over 4
1564
1565	=item B</+>
1566
1567	access menuBar top level
1568
1569	=item B<./+>
1570
1571	access current menu level
1572
1573	=item B<../+>
1574
1575	access parent menu (1 level up)
1576
1577	=item B<../../>
1578
1579	access parent menu (multiple levels up)
1580
1581	=item B<< I</path/>menu >>
1582
1583	add/access menu
1584
1585	=item B<< I</path/>menu/* >>
1586
1587	add/access menu and clear it if it exists
1588
1589	=item B<< I</path/>{-} >>
1590
1591	add separator
1592
1593	=item B<< I</path/>{item} >>
1594
1595	add B<item> as a label
1596
1597	=item B<< I</path/>{item} action >>
1598
1599	add/alter I<menuitem> with an associated I<action>
1600
1601	=item B<< I</path/>{item}{right-text} >>
1602
1603	add/alter I<menuitem> with B<right-text> as the right-justified text
1604	and as the associated I<action>
1605
1606	=item B<< I</path/>{item}{rtext} action >>
1607
1608	add/alter I<menuitem> with an associated I<action> and with B<rtext> as
1609	the right-justified text.
1610
1611	=back
1612
1613	=over 4
1614
1615	=item Special characters in I<action> must be backslash-escaped:
1616
1617	B<\a \b \E \e \n \r \t \octal>
1618
1619	=item or in control-character notation:
1620
1621	B<^@, ^A .. ^Z .. ^_, ^?>
1622
1623	=back
1624
1625	To send a string starting with a B<NUL> (B<^@>) character to the
1626	program, start I<action> with a pair of B<NUL> characters (B<^@^@>),
1627	the first of which will be stripped off and the balance directed to the
1628	program. Otherwise if I<action> begins with B<NUL> followed by
1629	non-+B<NUL> characters, the leading B<NUL> is stripped off and the
1630	balance is sent back to rxvt.
1631
1632	As a convenience for the many Emacs-type editors, I<action> may start
1633	with B<M-> (eg, B<M-$> is equivalent to B<\E$>) and a B<CR> will be
1634	appended if missed from B<M-x> commands.
1635
1636	As a convenience for issuing XTerm B<ESC]> sequences from a menubar (or
1637	quick arrow), a B<BEL> (B<^G>) will be appended if needed.
1638
1639	=over 4
1640
1641	=item For example,
1642
1643	B<M-xapropos> is equivalent to B<\Exapropos\r>
1644
1645	=item and
1646
1647	B<\E]703;mona;100> is equivalent to B<\E]703;mona;100\a>
1648
1649	=back
1650
1651	The option B<< {I<right-rtext>} >> will be right-justified. In the
1652	absence of a specified action, this text will be used as the I<action>
1653	as well.
1654
1655	=over 4
1656
1657	=item For example,
1658
1659	B</File/{Open}{^X^F}> is equivalent to B</File/{Open}{^X^F} ^X^F>
1660
1661	=back
1662
1663	The left label I<is> necessary, since it's used for matching, but
1664	implicitly hiding the left label (by using same name for both left and
1665	right labels), or explicitly hiding the left label (by preceeding it
1666	with a dot), makes it possible to have right-justified text only.
1667
1668	=over 4
1669
1670	=item For example,
1671
1672	B</File/{Open}{Open} Open-File-Action>
1673
1674	=item or hiding it
1675
1676	B</File/{.anylabel}{Open} Open-File-Action>
1677
1678	=back
1679
1680	X<menuBarRemove>
1681
1682	=head2 Removing menus
1683
1684	=over 4
1685
1686	=item B<< -/*+ >>
1687
1688	remove all menus from the menuBar, the same as B<[clear]>
1689
1690	=item B<< -+I</path>menu+ >>
1691
1692	remove menu
1693
1694	=item B<< -+I</path>{item}+ >>
1695
1696	remove item
1697
1698	=item B<< -+I</path>{-} >>
1699
1700	remove separator)
1701
1702	=item B<-/path/menu/*>
1703
1704	remove all items, separators and submenus from menu
1705
1706	=back
1707
1708	X<menuBarArrows>
1709
1710	=head2 Quick Arrows
1711
1712	The menus also provide a hook for I<quick arrows> to provide easier
1713	user access. If nothing has been explicitly set, the default is to
1714	emulate the curror keys. The syntax permits each arrow to be altered
1715	individually or all four at once without re-entering their common
1716	beginning/end text. For example, to explicitly associate cursor actions
1717	with the arrows, any of the following forms could be used:
1718
1719	=over 4
1720
1721	=item B<< <r>+I<Right> >>
1722
1723	=item B<< <l>+I<Left> >>
1724
1725	=item B<< <u>+I<Up> >>
1726
1727	=item B<< <d>+I<Down> >>
1728
1729	Define actions for the respective arrow buttons
1730
1731	=item B<< <b>+I<Begin> >>
1732
1733	=item B<< <e>+I<End> >>
1734
1735	Define common beginning/end parts for I<quick arrows> which used in
1736	conjunction with the above <r> <l> <u> <d> constructs
1737
1738	=back
1739
1740	=over 4
1741
1742	=item For example, define arrows individually,
1743
1744	<u>\E[A
1745
1746	<d>\E[B
1747
1748	<r>\E[C
1749
1750	<l>\E[D
1751
1752	=item or all at once
1753
1754	<u>\E[AZ<><d>\E[BZ<><r>\E[CZ<><l>\E[D
1755
1756	=item or more compactly (factoring out common parts)
1757
1758	<b>\E[<u>AZ<><d>BZ<><r>CZ<><l>D
1759
1760	=back
1761
1762	X<menuBarSummary>
1763
1764	=head2 Command Summary
1765
1766	A short summary of the most I<common> commands:
1767
1768	=over 4
1769
1770	=item [menu:name]
1771
1772	use an existing named menuBar or start a new one
1773
1774	=item [menu]
1775
1776	use the current menuBar
1777
1778	=item [title:string]
1779
1780	set menuBar title
1781
1782	=item [done]
1783
1784	set menu access to readonly and, if reading from a file, signal EOF
1785
1786	=item [done:name]
1787
1788	if reading from a file using [read:file;name] signal EOF
1789
1790	=item [rm:name]
1791
1792	remove named menuBar(s)
1793
1794	=item [rm] [rm:]
1795
1796	remove current menuBar
1797
1798	=item [rm*] [rm:*]
1799
1800	remove all menuBar(s)
1801
1802	=item [swap]
1803
1804	swap top two menuBars
1805
1806	=item [prev]
1807
1808	access the previous menuBar
1809
1810	=item [next]
1811
1812	access the next menuBar
1813
1814	=item [show]
1815
1816	map menuBar
1817
1818	=item [hide]
1819
1820	unmap menuBar
1821
1822	=item [pixmap;file]
1823
1824	=item [pixmap;file;scaling]
1825
1826	set a background pixmap
1827
1828	=item [read:file]
1829
1830	=item [read:file;name]
1831
1832	read in a menu from a file
1833
1834	=item [dump]
1835
1836	dump out all menuBars to /tmp/rxvt-PID
1837
1838	=item /
1839
1840	access menuBar top level
1841
1842	=item ./
1843
1844	=item ../
1845
1846	=item ../../
1847
1848	access current or parent menu level
1849
1850	=item /path/menu
1851
1852	add/access menu
1853
1854	=item /path/{-}
1855
1856	add separator
1857
1858	=item /path/{item}{rtext} action
1859
1860	add/alter menu item
1861
1862	=item -/*
1863
1864	remove all menus from the menuBar
1865
1866	=item -/path/menu
1867
1868	remove menu items, separators and submenus from menu
1869
1870	=item -/path/menu
1871
1872	remove menu
1873
1874	=item -/path/{item}
1875
1876	remove item
1877
1878	=item -/path/{-}
1879
1880	remove separator
1881
1882	=item <b>Begin<r>Right<l>Left<u>Up<d>Down<e>End
1883
1884	menu quick arrows
1885
1886	=back
1887	X<XPM>
1888		1822
1889	=head1 XPM	1823	=head1 XPM
1890		1824
1891	For the XPM XTerm escape sequence B<< C<ESC ] 20 ; Pt ST> >> then value	1825	For the XPM XTerm escape sequence B<< C<ESC ] 20 ; Pt ST> >> then value
1892	of B<< C<Pt> >> can be the name of the background pixmap followed by a	1826	of B<< C<Pt> >> can be the name of the background pixmap followed by a
…		…
1990	=begin table	1924	=begin table
1991		1925
1992	4 Shift	1926	4 Shift
1993	8 Meta	1927	8 Meta
1994	16 Control	1928	16 Control
1995	32 Double Click I<(Rxvt extension)>	1929	32 Double Click I<(rxvt extension)>
1996		1930
1997	=end table	1931	=end table
1998		1932
1999	Col = B<< C<< <x> - SPACE >> >>	1933	Col = B<< C<< <x> - SPACE >> >>
2000		1934
…		…
2077	=end table	2011	=end table
2078		2012
2079	=head1 CONFIGURE OPTIONS	2013	=head1 CONFIGURE OPTIONS
2080		2014
2081	General hint: if you get compile errors, then likely your configuration	2015	General hint: if you get compile errors, then likely your configuration
2082	hasn't been tested well. Either try with --enable-everything or use the	2016	hasn't been tested well. Either try with C<--enable-everything> or use
2083	./reconf script as a base for experiments. ./reconf is used by myself,	2017	the F<./reconf> script as a base for experiments. F<./reconf> is used by
2084	so it should generally be a working config. Of course, you should always	2018	myself, so it should generally be a working config. Of course, you should
2085	report when a combination doesn't work, so it can be fixed. Marc Lehmann	2019	always report when a combination doesn't work, so it can be fixed. Marc
2086	<rxvt@schmorp.de>.	2020	Lehmann <rxvt@schmorp.de>.
		2021
		2022	All
2087		2023
2088	=over 4	2024	=over 4
2089		2025
2090	=item --enable-everything	2026	=item --enable-everything
2091		2027
2092	Add support for all non-multichoice options listed in "./configure	2028	Add (or remove) support for all non-multichoice options listed in "./configure
2093	--help". Note that unlike other enable options this is order dependant.	2029	--help".
		2030
2094	You can specify this and then disable options which this enables by	2031	You can specify this and then disable options you do not like by
2095	I<following> this with the appropriate commands.	2032	I<following> this with the appropriate C<--disable-...> arguments,
		2033	or you can start with a minimal configuration by specifying
		2034	C<--disable-everything> and than adding just the C<--enable-...> arguments
		2035	you want.
2096		2036
2097	=item --enable-xft	2037	=item --enable-xft (default: enabled)
2098		2038
2099	Add support for Xft (anti-aliases, among others) fonts. Xft fonts are	2039	Add support for Xft (anti-aliases, among others) fonts. Xft fonts are
2100	slower and require lots of memory, but as long as you don't use them, you	2040	slower and require lots of memory, but as long as you don't use them, you
2101	don't pay for them.	2041	don't pay for them.
2102		2042
2103	=item --enable-font-styles	2043	=item --enable-font-styles (default: on)
2104		2044
2105	Add support for B<bold>, I<italic> and B<< I<bold italic> >> font	2045	Add support for B<bold>, I<italic> and B<< I<bold italic> >> font
2106	styles. The fonts can be set manually or automatically.	2046	styles. The fonts can be set manually or automatically.
2107		2047
2108	=item --with-codesets=NAME,...	2048	=item --with-codesets=NAME,... (default: all)
2109		2049
2110	Compile in support for additional codeset (encoding) groups (eu, vn are	2050	Compile in support for additional codeset (encoding) groups (C<eu>, C<vn>
2111	always compiled in, which includes most 8-bit character sets). These	2051	are always compiled in, which includes most 8-bit character sets). These
2112	codeset tables are currently only used for driving X11 core fonts, they	2052	codeset tables are used for driving X11 core fonts, they are not required
2113	are not required for Xft fonts. Compiling them in will make your binary	2053	for Xft fonts, although having them compiled in lets rxvt-unicode choose
2114	bigger (together about 700kB), but it doesn't increase memory usage unless	2054	replacement fonts more intelligently. Compiling them in will make your
		2055	binary bigger (all of together cost about 700kB), but it doesn't increase
2115	you use an X11 font requiring one of these encodings.	2056	memory usage unless you use a font requiring one of these encodings.
2116		2057
2117	=begin table	2058	=begin table
2118		2059
2119	all all available codeset groups	2060	all all available codeset groups
2120	zh common chinese encodings	2061	zh common chinese encodings
…		…
2123	jp_ext rarely used but big japanese encodings	2064	jp_ext rarely used but big japanese encodings
2124	kr korean encodings	2065	kr korean encodings
2125		2066
2126	=end table	2067	=end table
2127		2068
2128	=item --enable-xim	2069	=item --enable-xim (default: on)
2129		2070
2130	Add support for XIM (X Input Method) protocol. This allows using	2071	Add support for XIM (X Input Method) protocol. This allows using
2131	alternative input methods (e.g. kinput2) and will also correctly	2072	alternative input methods (e.g. kinput2) and will also correctly
2132	set up the input for people using dead keys or compose keys.	2073	set up the input for people using dead keys or compose keys.
2133		2074
2134	=item --enable-unicode3	2075	=item --enable-unicode3 (default: off)
		2076
		2077	Recommended to stay off unless you really need non-BMP characters.
2135		2078
2136	Enable direct support for displaying unicode codepoints above	2079	Enable direct support for displaying unicode codepoints above
2137	65535 (the basic multilingual page). This increases storage	2080	65535 (the basic multilingual page). This increases storage
2138	requirements per character from 2 to 4 bytes. X11 fonts do not yet	2081	requirements per character from 2 to 4 bytes. X11 fonts do not yet
2139	support these extra characters, but Xft does.	2082	support these extra characters, but Xft does.
…		…
2142	even without this flag, but the number of such characters is	2085	even without this flag, but the number of such characters is
2143	limited to a view thousand (shared with combining characters,	2086	limited to a view thousand (shared with combining characters,
2144	see next switch), and right now rxvt-unicode cannot display them	2087	see next switch), and right now rxvt-unicode cannot display them
2145	(input/output and cut&paste still work, though).	2088	(input/output and cut&paste still work, though).
2146		2089
2147	=item --enable-combining	2090	=item --enable-combining (default: on)
2148		2091
2149	Enable automatic composition of combining characters into	2092	Enable automatic composition of combining characters into
2150	composite characters. This is required for proper viewing of text	2093	composite characters. This is required for proper viewing of text
2151	where accents are encoded as seperate unicode characters. This is	2094	where accents are encoded as seperate unicode characters. This is
2152	done by using precomposited characters when available or creating	2095	done by using precomposited characters when available or creating
2153	new pseudo-characters when no precomposed form exists.	2096	new pseudo-characters when no precomposed form exists.
2154		2097
2155	Without --enable-unicode3, the number of additional precomposed	2098	Without --enable-unicode3, the number of additional precomposed
2156	characters is rather limited (2048, if this is full, rxvt will use the	2099	characters is somewhat limited (the 6400 private use characters will be
2157	private use area, extending the number of combinations to 8448). With	2100	(ab-)used). With --enable-unicode3, no practical limit exists.
2158	--enable-unicode3, no practical limit exists. This will also enable	2101
2159	storage of characters >65535.	2102	This option will also enable storage (but not display) of characters
		2103	beyond plane 0 (>65535) when --enable-unicode3 was not specified.
2160		2104
2161	The combining table also contains entries for arabic presentation forms,	2105	The combining table also contains entries for arabic presentation forms,
2162	but these are not currently used. Bug me if you want these to be used.	2106	but these are not currently used. Bug me if you want these to be used (and
		2107	tell me how these are to be used...).
2163		2108
2164	=item --enable-fallback(=CLASS)	2109	=item --enable-fallback(=CLASS) (default: Rxvt)
2165		2110
2166	When reading resource settings, also read settings for class CLASS	2111	When reading resource settings, also read settings for class CLASS. To
2167	(default: Rxvt). To disable resource fallback use --disable-fallback.	2112	disable resource fallback use --disable-fallback.
2168		2113
2169	=item --with-res-name=NAME	2114	=item --with-res-name=NAME (default: urxvt)
2170		2115
2171	Use the given name (default: urxvt) as default application name when	2116	Use the given name as default application name when
2172	reading resources. Specify --with-res-name=rxvt to replace rxvt.	2117	reading resources. Specify --with-res-name=rxvt to replace rxvt.
2173		2118
2174	=item --with-res-class=CLASS	2119	=item --with-res-class=CLASS /default: URxvt)
2175		2120
2176	Use the given class (default: URxvt) as default application class	2121	Use the given class as default application class
2177	when reading resources. Specify --with-res-class=Rxvt to replace	2122	when reading resources. Specify --with-res-class=Rxvt to replace
2178	rxvt.	2123	rxvt.
2179		2124
2180	=item --enable-utmp	2125	=item --enable-utmp (default: on)
2181		2126
2182	Write user and tty to utmp file (used by programs like F<w>) at	2127	Write user and tty to utmp file (used by programs like F<w>) at
2183	start of rxvt execution and delete information when rxvt exits.	2128	start of rxvt execution and delete information when rxvt exits.
2184		2129
2185	=item --enable-wtmp	2130	=item --enable-wtmp (default: on)
2186		2131
2187	Write user and tty to wtmp file (used by programs like F<last>) at	2132	Write user and tty to wtmp file (used by programs like F<last>) at
2188	start of rxvt execution and write logout when rxvt exits. This	2133	start of rxvt execution and write logout when rxvt exits. This
2189	option requires --enable-utmp to also be specified.	2134	option requires --enable-utmp to also be specified.
2190		2135
2191	=item --enable-lastlog	2136	=item --enable-lastlog (default: on)
2192		2137
2193	Write user and tty to lastlog file (used by programs like	2138	Write user and tty to lastlog file (used by programs like
2194	F<lastlogin>) at start of rxvt execution. This option requires	2139	F<lastlogin>) at start of rxvt execution. This option requires
2195	--enable-utmp to also be specified.	2140	--enable-utmp to also be specified.
2196		2141
2197	=item --enable-xpm-background	2142	=item --enable-xpm-background (default: on)
2198		2143
2199	Add support for XPM background pixmaps.	2144	Add support for XPM background pixmaps.
2200		2145
2201	=item --enable-transparency	2146	=item --enable-transparency (default: on)
2202		2147
2203	Add support for inheriting parent backgrounds thus giving a fake	2148	Add support for inheriting parent backgrounds thus giving a fake
2204	transparency to the term.	2149	transparency to the term.
2205		2150
2206	=item --enable-fading	2151	=item --enable-fading (default: on)
2207		2152
2208	Add support for fading the text when focus is lost.	2153	Add support for fading the text when focus is lost (requires C<--enable-transparency>).
2209		2154
2210	=item --enable-tinting	2155	=item --enable-tinting (default: on)
2211		2156
2212	Add support for tinting of transparent backgrounds.	2157	Add support for tinting of transparent backgrounds (requires C<--enable-transparency>).
2213		2158
2214	=item --enable-menubar
2215
2216	Add support for our menu bar system (this interacts badly with
2217	dynamic locale switching currently).
2218
2219	=item --enable-rxvt-scroll	2159	=item --enable-rxvt-scroll (default: on)
2220		2160
2221	Add support for the original rxvt scrollbar.	2161	Add support for the original rxvt scrollbar.
2222		2162
2223	=item --enable-next-scroll	2163	=item --enable-next-scroll (default: on)
2224		2164
2225	Add support for a NeXT-like scrollbar.	2165	Add support for a NeXT-like scrollbar.
2226		2166
2227	=item --enable-xterm-scroll	2167	=item --enable-xterm-scroll (default: on)
2228		2168
2229	Add support for an Xterm-like scrollbar.	2169	Add support for an Xterm-like scrollbar.
2230		2170
2231	=item --enable-plain-scroll	2171	=item --enable-plain-scroll (default: on)
2232		2172
2233	Add support for a very unobtrusive, plain-looking scrollbar that	2173	Add support for a very unobtrusive, plain-looking scrollbar that
2234	is the favourite of the rxvt-unicode author, having used it for	2174	is the favourite of the rxvt-unicode author, having used it for
2235	many years.	2175	many years.
2236		2176
2237	=item --enable-half-shadow	2177	=item --enable-ttygid (default: off)
2238
2239	Make shadows on the scrollbar only half the normal width & height.
2240	only applicable to rxvt scrollbars.
2241
2242	=item --enable-ttygid
2243		2178
2244	Change tty device setting to group "tty" - only use this if	2179	Change tty device setting to group "tty" - only use this if
2245	your system uses this type of security.	2180	your system uses this type of security.
2246		2181
2247	=item --disable-backspace-key	2182	=item --disable-backspace-key
2248		2183
2249	Disable any handling of the backspace key by us - let the X server	2184	Removes any handling of the backspace key by us - let the X server do it.
		2185
		2186	=item --disable-delete-key
		2187
		2188	Removes any handling of the delete key by us - let the X server
2250	do it.	2189	do it.
2251		2190
2252	=item --disable-delete-key
2253
2254	Disable any handling of the delete key by us - let the X server
2255	do it.
2256
2257	=item --disable-resources	2191	=item --disable-resources
2258		2192
2259	Remove all resources checking.	2193	Removes any support for resource checking.
2260
2261	=item --enable-xgetdefault
2262
2263	Make resources checking via XGetDefault() instead of our small
2264	version which only checks ~/.Xdefaults, or if that doesn't exist
2265	then ~/.Xresources.
2266
2267	=item --enable-strings
2268
2269	Add support for our possibly faster memset() function and other
2270	various routines, overriding your system's versions which may
2271	have been hand-crafted in assembly or may require extra libraries
2272	to link in. (this breaks ANSI-C rules and has problems on many
2273	GNU/Linux systems).
2274		2194
2275	=item --disable-swapscreen	2195	=item --disable-swapscreen
2276		2196
2277	Remove support for swap screen.	2197	Remove support for secondary/swap screen.
2278		2198
2279	=item --enable-frills	2199	=item --enable-frills (default: on)
2280		2200
2281	Add support for many small features that are not essential but nice to	2201	Add support for many small features that are not essential but nice to
2282	have. Normally you want this, but for very small binaries you may want to	2202	have. Normally you want this, but for very small binaries you may want to
2283	disable this.	2203	disable this.
2284		2204
2285	A non-exhaustive list of features enabled by C<--enable-frills> (possibly	2205	A non-exhaustive list of features enabled by C<--enable-frills> (possibly
2286	in combination with other switches) is:	2206	in combination with other switches) is:
2287		2207
2288	MWM-hints	2208	MWM-hints
		2209	EWMH-hints (pid, utf8 names) and protocols (ping)
2289	seperate underline colour	2210	seperate underline colour (-underlineColor)
2290	settable border widths and borderless switch	2211	settable border widths and borderless switch (-w, -b, -bl)
		2212	visual depth selection (-depth)
2291	settable extra linespacing	2213	settable extra linespacing /-lsp)
2292	extra window properties (e.g. UTF-8 window names and PID)
2293	iso-14755-2 and -3, and visual feedback	2214	iso-14755-2 and -3, and visual feedback
		2215	tripleclickwords (-tcw)
		2216	settable insecure mode (-insecure)
		2217	keysym remapping support
		2218	cursor blinking and underline cursor (-cb, -uc)
		2219	XEmbed support (-embed)
		2220	user-pty (-pty-fd)
		2221	hold on exit (-hold)
		2222	skip builtin block graphics (-sbg)
		2223
		2224	It also enabled some non-essential features otherwise disabled, such as:
		2225
		2226	some round-trip time optimisations
		2227	nearest color allocation on pseudocolor screens
		2228	UTF8_STRING supporr for selection
		2229	sgr modes 90..97 and 100..107
2294	backindex and forwardindex escape sequence	2230	backindex and forwardindex escape sequences
		2231	view change/zero scorllback esacpe sequences
		2232	locale switching escape sequence
2295	window op and locale change escape sequences	2233	window op and some xterm/OSC escape sequences
2296	tripleclickwords	2234	rectangular selections
2297	settable insecure mode	2235	trailing space removal for selections
		2236	verbose X error handling
2298		2237
2299	=item --enable-iso14755	2238	=item --enable-iso14755 (default: on)
2300		2239
2301	Enable extended ISO 14755 support (see @@RXVT_NAME@@(1), or	2240	Enable extended ISO 14755 support (see @@RXVT_NAME@@(1), or
2302	F<doc/rxvt.1.txt>). Basic support (section 5.1) is enabled by	2241	F<doc/rxvt.1.txt>). Basic support (section 5.1) is enabled by
2303	C<--enable-frills>, while support for 5.2, 5.3 and 5.4 is enabled with	2242	C<--enable-frills>, while support for 5.2, 5.3 and 5.4 is enabled with
2304	this switch.	2243	this switch.
2305		2244
2306	=item --enable-keepscrolling	2245	=item --enable-keepscrolling (default: on)
2307		2246
2308	Add support for continual scrolling of the display when you hold	2247	Add support for continual scrolling of the display when you hold
2309	the mouse button down on a scrollbar arrow.	2248	the mouse button down on a scrollbar arrow.
2310		2249
2311	=item --enable-mousewheel	2250	=item --enable-mousewheel (default: on)
2312		2251
2313	Add support for scrolling via mouse wheel or buttons 4 & 5.	2252	Add support for scrolling via mouse wheel or buttons 4 & 5.
2314		2253
2315	=item --enable-slipwheeling	2254	=item --enable-slipwheeling (default: on)
2316		2255
2317	Add support for continual scrolling (using the mouse wheel as an	2256	Add support for continual scrolling (using the mouse wheel as an
2318	accelerator) while the control key is held down. This option	2257	accelerator) while the control key is held down. This option
2319	requires --enable-mousewheel to also be specified.	2258	requires --enable-mousewheel to also be specified.
2320		2259
2321	=item --disable-new-selection	2260	=item --disable-new-selection
2322		2261
2323	Remove support for mouse selection style like that of xterm.	2262	Remove support for mouse selection style like that of xterm.
2324		2263
2325	=item --enable-dmalloc	2264	=item --enable-dmalloc (default: off)
2326		2265
2327	Use Gray Watson's malloc - which is good for debugging See	2266	Use Gray Watson's malloc - which is good for debugging See
2328	http://www.letters.com/dmalloc/ for details If you use either this or the	2267	http://www.letters.com/dmalloc/ for details If you use either this or the
2329	next option, you may need to edit src/Makefile after compiling to point	2268	next option, you may need to edit src/Makefile after compiling to point
2330	DINCLUDE and DLIB to the right places.	2269	DINCLUDE and DLIB to the right places.
2331		2270
2332	You can only use either this option and the following (should	2271	You can only use either this option and the following (should
2333	you use either) .	2272	you use either) .
2334		2273
2335	=item --enable-dlmalloc	2274	=item --enable-dlmalloc (default: off)
2336		2275
2337	Use Doug Lea's malloc - which is good for a production version	2276	Use Doug Lea's malloc - which is good for a production version
2338	See L<http://g.oswego.edu/dl/html/malloc.html> for details.	2277	See L<http://g.oswego.edu/dl/html/malloc.html> for details.
2339		2278
2340	=item --enable-smart-resize	2279	=item --enable-smart-resize (default: on)
2341		2280
2342	Add smart growth/shrink behaviour when changing font size via from hot	2281	Add smart growth/shrink behaviour when changing font size via hot
2343	keys. This should keep in a fixed position the rxvt corner which is	2282	keys. This should keep the window corner which is closest to a corner of
2344	closest to a corner of the screen.	2283	the screen in a fixed position.
2345		2284
2346	=item --enable-cursor-blink
2347
2348	Add support for a blinking cursor.
2349
2350	=item --enable-pointer-blank	2285	=item --enable-pointer-blank (default: on)
2351		2286
2352	Add support to have the pointer disappear when typing or inactive.	2287	Add support to have the pointer disappear when typing or inactive.
2353		2288
2354	=item --with-name=NAME	2289	=item --enable-perl (default: on)
2355		2290
		2291	Enable an embedded perl interpreter. See the B<@@RXVT_NAME@@perl(3)>
		2292	manpage (F<doc/rxvtperl.txt>) for more info on this feature, or the files
		2293	in F<src/perl-ext/> for the extensions that are installed by default. The
		2294	perl interpreter that is used can be specified via the C<PERL> environment
		2295	variable when running configure.
		2296
		2297	=item --with-name=NAME (default: urxvt)
		2298
2356	Set the basename for the installed binaries (default: C<urxvt>, resulting	2299	Set the basename for the installed binaries, resulting
2357	in C<urxvt>, C<urxvtd> etc.). Specify C<--with-name=rxvt> to replace with	2300	in C<urxvt>, C<urxvtd> etc.). Specify C<--with-name=rxvt> to replace with
2358	C<rxvt>.	2301	C<rxvt>.
2359		2302
2360	=item --with-term=NAME	2303	=item --with-term=NAME (default: rxvt-unicode)
2361		2304
2362	Change the environmental variable for the terminal to NAME (default	2305	Change the environmental variable for the terminal to NAME.
2363	C<rxvt-unicode>)
2364		2306
2365	=item --with-terminfo=PATH	2307	=item --with-terminfo=PATH
2366		2308
2367	Change the environmental variable for the path to the terminfo tree to	2309	Change the environmental variable for the path to the terminfo tree to
2368	PATH.	2310	PATH.

Diff Legend

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