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.33 by root, Sun Jan 16 18:48:04 2005 UTC vs.
Revision 1.123 by root, Sat Dec 16 03:48:49 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/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 whether I'm running rxvt-unicode or a regular xterm? I need this to decide about setting colors etc.
		96
		97	The original rxvt and rxvt-unicode always export the variable "COLORTERM",
		98	so you can check and see if that is set. Note that several programs, JED,
		99	slrn, Midnight Commander automatically check this variable to decide
		100	whether or not to use color.
		101
		102	=head3 How do I set the correct, full IP address for the DISPLAY variable?
		103
		104	If you've compiled rxvt-unicode with DISPLAY_IS_IP and have enabled
		105	insecure mode then it is possible to use the following shell script
		106	snippets to correctly set the display. If your version of rxvt-unicode
		107	wasn't also compiled with ESCZ_ANSWER (as assumed in these snippets) then
		108	the COLORTERM variable can be used to distinguish rxvt-unicode from a
		109	regular xterm.
		110
		111	Courtesy of Chuck Blake <cblake@BBN.COM> with the following shell script
		112	snippets:
		113
		114	# Bourne/Korn/POSIX family of shells:
		115	[ ${TERM:-foo} = foo ] && TERM=xterm # assume an xterm if we don't know
		116	if [ ${TERM:-foo} = xterm ]; then
		117	stty -icanon -echo min 0 time 15 # see if enhanced rxvt or not
		118	echo -n '^[Z'
		119	read term_id
		120	stty icanon echo
		121	if [ ""${term_id} = '^[[?1;2C' -a ${DISPLAY:-foo} = foo ]; then
		122	echo -n '^[[7n' # query the rxvt we are in for the DISPLAY string
		123	read DISPLAY # set it in our local shell
		124	fi
		125	fi
		126
		127	=head3 How do I compile the manual pages on my own?
		128
		129	You need to have a recent version of perl installed as F</usr/bin/perl>,
		130	one that comes with F<pod2man>, F<pod2text> and F<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 unreasonably so.
		150
		151	text data bss drs rss filename
		152	163431 2152 24 20123 2060 rxvt --enable-everything
		153	1035683 49680 66648 29096 3680 urxvt --enable-everything
		154
		155	The very large size of the text section is explained by the east-asian
		156	encoding tables, which, if unused, take up disk space but nothing else
		157	and can be compiled out unless you rely on X11 core fonts that use those
		158	encodings. The BSS size comes from the 64k emergency buffer that my c++
		159	compiler allocates (but of course doesn't use unless you are out of
		160	memory). Also, using an xft font instead of a core font immediately adds a
		161	few megabytes of RSS. Xft indeed is responsible for a lot of RSS even when
		162	not used.
		163
		164	Of course, due to every character using two or four bytes instead of one,
		165	a large scrollback buffer will ultimately make rxvt-unicode use more
		166	memory.
		167
		168	Compared to e.g. Eterm (5112k), aterm (3132k) and xterm (4680k), this
		169	still fares rather well. And compared to some monsters like gnome-terminal
		170	(21152k + extra 4204k in separate processes) or konsole (22200k + extra
		171	43180k in daemons that stay around after exit, plus half a minute of
		172	startup time, including the hundreds of warnings it spits out), it fares
		173	extremely well *g*.
		174
		175	=head3 Why C++, isn't that unportable/bloated/uncool?
		176
		177	Is this a question? :) It comes up very often. The simple answer is: I had
		178	to write it, and C++ allowed me to write and maintain it in a fraction
		179	of the time and effort (which is a scarce resource for me). Put even
		180	shorter: It simply wouldn't exist without C++.
		181
		182	My personal stance on this is that C++ is less portable than C, but in
		183	the case of rxvt-unicode this hardly matters, as its portability limits
		184	are defined by things like X11, pseudo terminals, locale support and unix
		185	domain sockets, which are all less portable than C++ itself.
		186
		187	Regarding the bloat, see the above question: It's easy to write programs
		188	in C that use gobs of memory, an certainly possible to write programs in
		189	C++ that don't. C++ also often comes with large libraries, but this is
		190	not necessarily the case with GCC. Here is what rxvt links against on my
		191	system with a minimal config:
		192
		193	libX11.so.6 => /usr/X11R6/lib/libX11.so.6 (0x00002aaaaabc3000)
		194	libc.so.6 => /lib/libc.so.6 (0x00002aaaaadde000)
		195	libdl.so.2 => /lib/libdl.so.2 (0x00002aaaab01d000)
		196	/lib64/ld-linux-x86-64.so.2 (0x00002aaaaaaab000)
		197
		198	And here is rxvt-unicode:
		199
		200	libX11.so.6 => /usr/X11R6/lib/libX11.so.6 (0x00002aaaaabc3000)
		201	libgcc_s.so.1 => /lib/libgcc_s.so.1 (0x00002aaaaada2000)
		202	libc.so.6 => /lib/libc.so.6 (0x00002aaaaaeb0000)
		203	libdl.so.2 => /lib/libdl.so.2 (0x00002aaaab0ee000)
		204	/lib64/ld-linux-x86-64.so.2 (0x00002aaaaaaab000)
		205
		206	No large bloated libraries (of course, none were linked in statically),
		207	except maybe libX11 :)
		208
		209
		210	=head2 Rendering, Font & Look and Feel Issues
		211
		212	=head3 I can't get transparency working, what am I doing wrong?
		213
		214	First of all, 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 necessary
		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), whether 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 '\33]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 its 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 its 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 permanently 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 whether 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<^?>.
473		565
474	Historically, either value is correct, but rxvt-unicode adopts the debian	566	Historically, either value is correct, but rxvt-unicode adopts the debian
475	policy of using C<^?> when unsure, because it's the one only only correct	567	policy of using C<^?> when unsure, because it's the one only only correct
…		…
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: \e[1~	623	URxvt.keysym.Home: \033[1~
532	URxvt*keysym.End: \e[4~	624	URxvt.keysym.End: \033[4~
533	URxvt*keysym.C-apostrophe: \e<C-'>	625	URxvt.keysym.C-apostrophe: \033<C-'>
534	URxvt*keysym.C-slash: \e<C-/>	626	URxvt.keysym.C-slash: \033<C-/>
535	URxvt*keysym.C-semicolon: \e<C-;>	627	URxvt.keysym.C-semicolon: \033<C-;>
536	URxvt*keysym.C-grave: \e<C-`>	628	URxvt.keysym.C-grave: \033<C-`>
537	URxvt*keysym.C-comma: \e<C-,>	629	URxvt.keysym.C-comma: \033<C-,>
538	URxvt*keysym.C-period: \e<C-.>	630	URxvt.keysym.C-period: \033<C-.>
539	URxvt*keysym.C-0x60: \e<C-`>	631	URxvt.keysym.C-0x60: \033<C-`>
540	URxvt*keysym.C-Tab: \e<C-Tab>	632	URxvt.keysym.C-Tab: \033<C-Tab>
541	URxvt*keysym.C-Return: \e<C-Return>	633	URxvt.keysym.C-Return: \033<C-Return>
542	URxvt*keysym.S-Return: \e<S-Return>	634	URxvt.keysym.S-Return: \033<S-Return>
543	URxvt*keysym.S-space: \e<S-Space>	635	URxvt.keysym.S-space: \033<S-Space>
544	URxvt*keysym.M-Up: \e<M-Up>	636	URxvt.keysym.M-Up: \033<M-Up>
545	URxvt*keysym.M-Down: \e<M-Down>	637	URxvt.keysym.M-Down: \033<M-Down>
546	URxvt*keysym.M-Left: \e<M-Left>	638	URxvt.keysym.M-Left: \033<M-Left>
547	URxvt*keysym.M-Right: \e<M-Right>	639	URxvt.keysym.M-Right: \033<M-Right>
548	URxvt*keysym.M-C-0: list.0123456789.\e<M-C-.>	640	URxvt.keysym.M-C-0: list \033<M-C- 0123456789 >
549	URxvt*keysym.M-C-a: list.abcdefghijklmnopqrstuvwxyz.\033<M-C-.>	641	URxvt.keysym.M-C-a: list \033<M-C- abcdefghijklmnopqrstuvwxyz >
550	URxvt*keysym.F12: proto:\033]701;zh_CN.GBK\007	642	URxvt.keysym.F12: command:\033]701;zh_CN.GBK\007
551		643
552	=item I'm using keyboard model XXX that has extra Prior/Next/Insert keys.	644	See some more examples in the documentation for the B<keysym> resource.
553	How do I make use of them? For example, the Sun Keyboard type 4	645
554	has the following mappings that rxvt-unicode doesn't recognize.	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		647
556	KP_Insert == Insert	648	KP_Insert == Insert
557	F22 == Print	649	F22 == Print
558	F27 == Home	650	F27 == Home
559	F29 == Prior	651	F29 == Prior
560	F33 == End	652	F33 == End
561	F35 == Next	653	F35 == Next
562		654
563	Rather than have rxvt-unicode try to accommodate all the various possible keyboard	655	Rather than have rxvt-unicode try to accommodate all the various possible
564	mappings, it is better to use `xmodmap' to remap the keys as required for	656	keyboard mappings, it is better to use `xmodmap' to remap the keys as
565	your particular machine.	657	required for your particular machine.
566		658
567	=item How do I distinguish if I'm running rxvt-unicode or a regular xterm?
568	I need this to decide about setting colors etc.
569		659
570	rxvt and rxvt-unicode always export the variable "COLORTERM", so you can
571	check and see if that is set. Note that several programs, JED, slrn,
572	Midnight Commander automatically check this variable to decide whether or
573	not to use color.
574		660
575	=item How do I set the correct, full IP address for the DISPLAY variable?	661	=head2 Terminal Configuration
576		662
577	If you've compiled rxvt-unicode with DISPLAY_IS_IP and have enabled	663	=head3 Can I see a typical configuration?
578	insecure mode then it is possible to use the following shell script
579	snippets to correctly set the display. If your version of rxvt-unicode
580	wasn't also compiled with ESCZ_ANSWER (as assumed in these snippets) then
581	the COLORTERM variable can be used to distinguish rxvt-unicode from a
582	regular xterm.
583		664
584	Courtesy of Chuck Blake <cblake@BBN.COM> with the following shell script	665	The default configuration tries to be xterm-like, which I don't like that
585	snippets:	666	much, but it's least surprise to regular users.
586		667
587	# Bourne/Korn/POSIX family of shells:	668	As a rxvt or rxvt-unicode user, you are practically supposed to invest
588	[ ${TERM:-foo} = foo ] && TERM=xterm # assume an xterm if we don't know	669	time into customising your terminal. To get you started, here is the
589	if [ ${TERM:-foo} = xterm ]; then	670	author's .Xdefaults entries, with comments on what they do. It's certainly
590	stty -icanon -echo min 0 time 15 # see if enhanced rxvt or not	671	not I<typical>, but what's typical...
591	echo -n '^[Z'
592	read term_id
593	stty icanon echo
594	if [ ""${term_id} = '^[[?1;2C' -a ${DISPLAY:-foo} = foo ]; then
595	echo -n '^[[7n' # query the rxvt we are in for the DISPLAY string
596	read DISPLAY # set it in our local shell
597	fi
598	fi
599		672
600	=item How do I compile the manual pages for myself?	673	URxvt.cutchars: "()*,<>[]{}|'
		674	URxvt.print-pipe: cat >/tmp/xxx
601		675
602	You need to have a recent version of perl installed as F</usr/bin/perl>,	676	These are just for testing stuff.
603	one that comes with F<pod2man>, F<pod2text> and F<pod2html>. Then go to
604	the doc subdirectory and enter C<make alldoc>.
605		677
606	=item My question isn't answered here, can I ask a human?	678	URxvt.imLocale: ja_JP.UTF-8
		679	URxvt.preeditType: OnTheSpot,None
607		680
608	Before sending me mail, you could go to IRC: C<irc.freenode.net>,	681	This tells rxvt-unicode to use a special locale when communicating with
609	channel C<#rxvt-unicode> has some rxvt-unicode enthusiasts that might be	682	the X Input Method, and also tells it to only use the OnTheSpot pre-edit
610	interested in learning about new and exciting problems (but not FAQs :).	683	type, which requires the C<xim-onthespot> perl extension but rewards me
		684	with correct-looking fonts.
		685
		686	URxvt.perl-lib: /root/lib/urxvt
		687	URxvt.perl-ext-common: default,selection-autotransform,selection-pastebin,xim-onthespot,remote-clipboard
		688	URxvt.selection.pattern-0: ( at .*? line \\d+)
		689	URxvt.selection.pattern-1: ^(/[^:]+):\
		690	URxvt.selection-autotransform.0: s/^([^:[:space:]]+):(\\d+):?$/:e \\Q$1\\E\\x0d:$2\\x0d/
		691	URxvt.selection-autotransform.1: s/^ at (.*?) line (\\d+)$/:e \\Q$1\\E\\x0d:$2\\x0d/
		692
		693	This is my perl configuration. The first two set the perl library
		694	directory and also tells urxvt to use a large number of extensions. I
		695	develop for myself mostly, so I actually use most of the extensions I
		696	write.
		697
		698	The selection stuff mainly makes the selection perl-error-message aware
		699	and tells it to convert perl error messages into vi-commands to load the
		700	relevant file and go tot he error line number.
		701
		702	URxvt.scrollstyle: plain
		703	URxvt.secondaryScroll: true
		704
		705	As the documentation says: plain is the preferred scrollbar for the
		706	author. The C<secondaryScroll> configures urxvt to scroll in full-screen
		707	apps, like screen, so lines scrolled out of screen end up in urxvt's
		708	scrollback buffer.
		709
		710	URxvt.background: #000000
		711	URxvt.foreground: gray90
		712	URxvt.color7: gray90
		713	URxvt.colorBD: #ffffff
		714	URxvt.cursorColor: #e0e080
		715	URxvt.throughColor: #8080f0
		716	URxvt.highlightColor: #f0f0f0
		717
		718	Some colours. Not sure which ones are being used or even non-defaults, but
		719	these are in my .Xdefaults. Most notably, they set foreground/background
		720	to light gray/black, and also make sure that the colour 7 matches the
		721	default foreground colour.
		722
		723	URxvt.underlineColor: yellow
		724
		725	Another colour, makes underline lines look different. Sometimes hurts, but
		726	is mostly a nice effect.
		727
		728	URxvt.geometry: 154x36
		729	URxvt.loginShell: false
		730	URxvt.meta: ignore
		731	URxvt.utmpInhibit: true
		732
		733	Uh, well, should be mostly self-explanatory. By specifying some defaults
		734	manually, I can quickly switch them for testing.
		735
		736	URxvt.saveLines: 8192
		737
		738	A large scrollback buffer is essential. Really.
		739
		740	URxvt.mapAlert: true
		741
		742	The only case I use it is for my IRC window, which I like to keep
		743	iconified till people msg me (which beeps).
		744
		745	URxvt.visualBell: true
		746
		747	The audible bell is often annoying, especially when in a crowd.
		748
		749	URxvt.insecure: true
		750
		751	Please don't hack my mutt! Ooops...
		752
		753	URxvt.pastableTabs: false
		754
		755	I once thought this is a great idea.
		756
		757	urxvt.font: 9x15bold,\
		758	-misc-fixed-bold-r-normal--15-140-75-75-c-90-iso10646-1,\
		759	-misc-fixed-medium-r-normal--15-140-75-75-c-90-iso10646-1, \
		760	[codeset=JISX0208]xft:Kochi Gothic, \
		761	xft:Bitstream Vera Sans Mono:autohint=true, \
		762	xft:Code2000:antialias=false
		763	urxvt.boldFont: -xos4-terminus-bold-r-normal--14-140-72-72-c-80-iso8859-15
		764	urxvt.italicFont: xft:Bitstream Vera Sans Mono:italic:autohint=true
		765	urxvt.boldItalicFont: xft:Bitstream Vera Sans Mono:bold:italic:autohint=true
		766
		767	I wrote rxvt-unicode to be able to specify fonts exactly. So don't be
		768	overwhelmed. A special note: the C<9x15bold> mentioned above is actually
		769	the version from XFree-3.3, as XFree-4 replaced it by a totally different
		770	font (different glyphs for C<;> and many other harmless characters),
		771	while the second font is actually the C<9x15bold> from XFree4/XOrg. The
		772	bold version has less chars than the medium version, so I use it for rare
		773	characters, too. When editing sources with vim, I use italic for comments
		774	and other stuff, which looks quite good with Bitstream Vera anti-aliased.
		775
		776	Terminus is a quite bad font (many very wrong glyphs), but for most of my
		777	purposes, it works, and gives a different look, as my normal (Non-bold)
		778	font is already bold, and I want to see a difference between bold and
		779	normal fonts.
		780
		781	Please note that I used the C<urxvt> instance name and not the C<URxvt>
		782	class name. Thats because I use different configs for different purposes,
		783	for example, my IRC window is started with C<-name IRC>, and uses these
		784	defaults:
		785
		786	IRC*title: IRC
		787	IRC*geometry: 87x12+535+542
		788	IRC*saveLines: 0
		789	IRC*mapAlert: true
		790	IRC*font: suxuseuro
		791	IRC*boldFont: suxuseuro
		792	IRC*colorBD: white
		793	IRC*keysym.M-C-1: command:\033]710;suxuseuro\007\033]711;suxuseuro\007
		794	IRC*keysym.M-C-2: command:\033]710;9x15bold\007\033]711;9x15bold\007
		795
		796	C<Alt-Shift-1> and C<Alt-Shift-2> switch between two different font
		797	sizes. C<suxuseuro> allows me to keep an eye (and actually read)
		798	stuff while keeping a very small window. If somebody pastes something
		799	complicated (e.g. japanese), I temporarily switch to a larger font.
		800
		801	The above is all in my C<.Xdefaults> (I don't use C<.Xresources> nor
		802	C<xrdb>). I also have some resources in a separate C<.Xdefaults-hostname>
		803	file for different hosts, for example, on ym main desktop, I use:
		804
		805	URxvt.keysym.C-M-q: command:\033[3;5;5t
		806	URxvt.keysym.C-M-y: command:\033[3;5;606t
		807	URxvt.keysym.C-M-e: command:\033[3;1605;5t
		808	URxvt.keysym.C-M-c: command:\033[3;1605;606t
		809	URxvt.keysym.C-M-p: perl:test
		810
		811	The first for keysym definitions allow me to quickly bring some windows
		812	in the layout I like most. Ion users might start laughing but will stop
		813	immediately when I tell them that I use my own Fvwm2 module for much the
		814	same effect as Ion provides, and I only very rarely use the above key
		815	combinations :->
		816
		817	=head3 Why doesn't rxvt-unicode read my resources?
		818
		819	Well, why, indeed? It does, in a way very similar to other X
		820	applications. Most importantly, this means that if you or your OS loads
		821	resources into the X display (the right way to do it), rxvt-unicode will
		822	ignore any resource files in your home directory. It will only read
		823	F<$HOME/.Xdefaults> when no resources are attached to the display.
		824
		825	If you have or use an F<$HOME/.Xresources> file, chances are that
		826	resources are loaded into your X-server. In this case, you have to
		827	re-login after every change (or run F<xrdb -merge $HOME/.Xresources>).
		828
		829	Also consider the form resources have to use:
		830
		831	URxvt.resource: value
		832
		833	If you want to use another form (there are lots of different ways of
		834	specifying resources), make sure you understand whether and why it
		835	works. If unsure, use the form above.
		836
		837	=head3 When I log-in to another system it tells me about missing terminfo data?
		838
		839	The terminal description used by rxvt-unicode is not as widely available
		840	as that for xterm, or even rxvt (for which the same problem often arises).
		841
		842	The correct solution for this problem is to install the terminfo, this can
		843	be done like this (with ncurses' infocmp and works as user and admin):
		844
		845	REMOTE=remotesystem.domain
		846	infocmp rxvt-unicode | ssh $REMOTE "mkdir -p .terminfo && cat >/tmp/ti && tic /tmp/ti"
		847
		848	... or by installing rxvt-unicode normally on the remote system,
		849
		850	One some systems you might need to set C<$TERMINFO> to the full path of
		851	F<$HOME/.terminfo> for this to work.
		852
		853	If you cannot or do not want to do this, then you can simply set
		854	C<TERM=rxvt> or even C<TERM=xterm>, and live with the small number of
		855	problems arising, which includes wrong keymapping, less and different
		856	colours and some refresh errors in fullscreen applications. It's a nice
		857	quick-and-dirty workaround for rare cases, though.
		858
		859	If you always want to do this (and are fine with the consequences) you
		860	can either recompile rxvt-unicode with the desired TERM value or use a
		861	resource to set it:
		862
		863	URxvt.termName: rxvt
		864
		865	If you don't plan to use B<rxvt> (quite common...) you could also replace
		866	the rxvt terminfo file with the rxvt-unicode one and use C<TERM=rxvt>.
		867
		868	=head3 C<tic> outputs some error when compiling the terminfo entry.
		869
		870	Most likely it's the empty definition for C<enacs=>. Just replace it by
		871	C<enacs=\E[0@> and try again.
		872
		873	=head3 C<bash>'s readline does not work correctly under @@URXVT_NAME@@.
		874
		875	See next entry.
		876
		877	=head3 I need a termcap file entry.
		878
		879	One reason you might want this is that some distributions or operating
		880	systems still compile some programs using the long-obsoleted termcap
		881	library (Fedora Core's bash is one example) and rely on a termcap entry
		882	for C<rxvt-unicode>.
		883
		884	You could use rxvt's termcap entry with reasonable results in many cases.
		885	You can also create a termcap entry by using terminfo's infocmp program
		886	like this:
		887
		888	infocmp -C rxvt-unicode
		889
		890	Or you could use this termcap entry, generated by the command above:
		891
		892	rxvt-unicode|rxvt-unicode terminal (X Window System):\
		893	:am:bw:eo:km:mi:ms:xn:xo:\
		894	:co#80:it#8:li#24:lm#0:\
		895	:AL=\E[%dL:DC=\E[%dP:DL=\E[%dM:DO=\E[%dB:IC=\E[%d@:\
		896	:K1=\EOw:K2=\EOu:K3=\EOy:K4=\EOq:K5=\EOs:LE=\E[%dD:\
		897	:RI=\E[%dC:SF=\E[%dS:SR=\E[%dT:UP=\E[%dA:ae=\E(B:al=\E[L:\
		898	:as=\E(0:bl=^G:cd=\E[J:ce=\E[K:cl=\E[H\E[2J:\
		899	:cm=\E[%i%d;%dH:cr=^M:cs=\E[%i%d;%dr:ct=\E[3g:dc=\E[P:\
		900	:dl=\E[M:do=^J:ec=\E[%dX:ei=\E[4l:ho=\E[H:\
		901	:i1=\E[?47l\E=\E[?1l:ic=\E[@:im=\E[4h:\
		902	:is=\E[r\E[m\E[2J\E[H\E[?7h\E[?1;3;4;6l\E[4l:\
		903	:k1=\E[11~:k2=\E[12~:k3=\E[13~:k4=\E[14~:k5=\E[15~:\
		904	:k6=\E[17~:k7=\E[18~:k8=\E[19~:k9=\E[20~:kD=\E[3~:\
		905	:kI=\E[2~:kN=\E[6~:kP=\E[5~:kb=\177:kd=\EOB:ke=\E[?1l\E>:\
		906	:kh=\E[7~:kl=\EOD:kr=\EOC:ks=\E[?1h\E=:ku=\EOA:le=^H:\
		907	:mb=\E[5m:md=\E[1m:me=\E[m\017:mr=\E[7m:nd=\E[C:rc=\E8:\
		908	:sc=\E7:se=\E[27m:sf=^J:so=\E[7m:sr=\EM:st=\EH:ta=^I:\
		909	:te=\E[r\E[?1049l:ti=\E[?1049h:ue=\E[24m:up=\E[A:\
		910	:us=\E[4m:vb=\E[?5h\E[?5l:ve=\E[?25h:vi=\E[?25l:\
		911	:vs=\E[?25h:
		912
		913	=head3 Why does C<ls> no longer have coloured output?
		914
		915	The C<ls> in the GNU coreutils unfortunately doesn't use terminfo to
		916	decide whether a terminal has colour, but uses its own configuration
		917	file. Needless to say, C<rxvt-unicode> is not in its default file (among
		918	with most other terminals supporting colour). Either add:
		919
		920	TERM rxvt-unicode
		921
		922	to C</etc/DIR_COLORS> or simply add:
		923
		924	alias ls='ls --color=auto'
		925
		926	to your C<.profile> or C<.bashrc>.
		927
		928	=head3 Why doesn't vim/emacs etc. use the 88 colour mode?
		929
		930	See next entry.
		931
		932	=head3 Why doesn't vim/emacs etc. make use of italic?
		933
		934	See next entry.
		935
		936	=head3 Why are the secondary screen-related options not working properly?
		937
		938	Make sure you are using C<TERM=rxvt-unicode>. Some pre-packaged
		939	distributions (most notably Debian GNU/Linux) break rxvt-unicode
		940	by setting C<TERM> to C<rxvt>, which doesn't have these extra
		941	features. Unfortunately, some of these (most notably, again, Debian
		942	GNU/Linux) furthermore fail to even install the C<rxvt-unicode> terminfo
		943	file, so you will need to install it on your own (See the question B<When
		944	I log-in to another system it tells me about missing terminfo data?> on
		945	how to do this).
		946
		947
		948	=head2 Encoding / Locale / Input Method Issues
		949
		950	=head3 Rxvt-unicode does not seem to understand the selected encoding?
		951
		952	See next entry.
		953
		954	=head3 Unicode does not seem to work?
		955
		956	If you encounter strange problems like typing an accented character but
		957	getting two unrelated other characters or similar, or if program output is
		958	subtly garbled, then you should check your locale settings.
		959
		960	Rxvt-unicode must be started with the same C<LC_CTYPE> setting as the
		961	programs. Often rxvt-unicode is started in the C<C> locale, while the
		962	login script running within the rxvt-unicode window changes the locale to
		963	something else, e.g. C<en_GB.UTF-8>. Needless to say, this is not going to work.
		964
		965	The best thing is to fix your startup environment, as you will likely run
		966	into other problems. If nothing works you can try this in your .profile.
		967
		968	printf '\33]701;%s\007' "$LC_CTYPE"
		969
		970	If this doesn't work, then maybe you use a C<LC_CTYPE> specification not
		971	supported on your systems. Some systems have a C<locale> command which
		972	displays this (also, C<perl -e0> can be used to check locale settings, as
		973	it will complain loudly if it cannot set the locale). If it displays something
		974	like:
		975
		976	locale: Cannot set LC_CTYPE to default locale: ...
		977
		978	Then the locale you specified is not supported on your system.
		979
		980	If nothing works and you are sure that everything is set correctly then
		981	you will need to remember a little known fact: Some programs just don't
		982	support locales :(
		983
		984	=head3 How does rxvt-unicode determine the encoding to use?
		985
		986	See next entry.
		987
		988	=head3 Is there an option to switch encodings?
		989
		990	Unlike some other terminals, rxvt-unicode has no encoding switch, and no
		991	specific "utf-8" mode, such as xterm. In fact, it doesn't even know about
		992	UTF-8 or any other encodings with respect to terminal I/O.
		993
		994	The reasons is that there exists a perfectly fine mechanism for selecting
		995	the encoding, doing I/O and (most important) communicating this to all
		996	applications so everybody agrees on character properties such as width
		997	and code number. This mechanism is the I<locale>. Applications not using
		998	that info will have problems (for example, C<xterm> gets the width of
		999	characters wrong as it uses its own, locale-independent table under all
		1000	locales).
		1001
		1002	Rxvt-unicode uses the C<LC_CTYPE> locale category to select encoding. All
		1003	programs doing the same (that is, most) will automatically agree in the
		1004	interpretation of characters.
		1005
		1006	Unfortunately, there is no system-independent way to select locales, nor
		1007	is there a standard on how locale specifiers will look like.
		1008
		1009	On most systems, the content of the C<LC_CTYPE> environment variable
		1010	contains an arbitrary string which corresponds to an already-installed
		1011	locale. Common names for locales are C<en_US.UTF-8>, C<de_DE.ISO-8859-15>,
		1012	C<ja_JP.EUC-JP>, i.e. C<language_country.encoding>, but other forms
		1013	(i.e. C<de> or C<german>) are also common.
		1014
		1015	Rxvt-unicode ignores all other locale categories, and except for
		1016	the encoding, ignores country or language-specific settings,
		1017	i.e. C<de_DE.UTF-8> and C<ja_JP.UTF-8> are the normally same to
		1018	rxvt-unicode.
		1019
		1020	If you want to use a specific encoding you have to make sure you start
		1021	rxvt-unicode with the correct C<LC_CTYPE> category.
		1022
		1023	=head3 Can I switch locales at runtime?
		1024
		1025	Yes, using an escape sequence. Try something like this, which sets
		1026	rxvt-unicode's idea of C<LC_CTYPE>.
		1027
		1028	printf '\33]701;%s\007' ja_JP.SJIS
		1029
		1030	See also the previous answer.
		1031
		1032	Sometimes this capability is rather handy when you want to work in
		1033	one locale (e.g. C<de_DE.UTF-8>) but some programs don't support it
		1034	(e.g. UTF-8). For example, I use this script to start C<xjdic>, which
		1035	first switches to a locale supported by xjdic and back later:
		1036
		1037	printf '\33]701;%s\007' ja_JP.SJIS
		1038	xjdic -js
		1039	printf '\33]701;%s\007' de_DE.UTF-8
		1040
		1041	You can also use xterm's C<luit> program, which usually works fine, except
		1042	for some locales where character width differs between program- and
		1043	rxvt-unicode-locales.
		1044
		1045	=head3 I have problems getting my input method working.
		1046
		1047	Try a search engine, as this is slightly different for every input method server.
		1048
		1049	Here is a checklist:
		1050
		1051	=over 4
		1052
		1053	=item - Make sure your locale I<and> the imLocale are supported on your OS.
		1054
		1055	Try C<locale -a> or check the documentation for your OS.
		1056
		1057	=item - Make sure your locale or imLocale matches a locale supported by your XIM.
		1058
		1059	For example, B<kinput2> does not support UTF-8 locales, you should use
		1060	C<ja_JP.EUC-JP> or equivalent.
		1061
		1062	=item - Make sure your XIM server is actually running.
		1063
		1064	=item - Make sure the C<XMODIFIERS> environment variable is set correctly when I<starting> rxvt-unicode.
		1065
		1066	When you want to use e.g. B<kinput2>, it must be set to
		1067	C<@im=kinput2>. For B<scim>, use C<@im=SCIM>. You can see what input
		1068	method servers are running with this command:
		1069
		1070	xprop -root XIM_SERVERS
		1071
		1072	=item
611		1073
612	=back	1074	=back
613		1075
614	=head1 SYNOPSIS	1076	=head3 My input method wants <some encoding> but I want UTF-8, what can I do?
615		1077
616	# set a new font set	1078	You can specify separate locales for the input method and the rest of the
617	printf '\33]50;%s\007' 9x15,xft:Kochi" Mincho"	1079	terminal, using the resource C<imlocale>:
618		1080
619	# change the locale and tell rxvt-unicode about it	1081	URxvt.imlocale: ja_JP.EUC-JP
620	export LC_CTYPE=ja_JP.EUC-JP; printf "\33]701;$LC_CTYPE\007"
621		1082
622	# set window title	1083	Now you can start your terminal with C<LC_CTYPE=ja_JP.UTF-8> and still
623	printf '\33]2;%s\007' "new window title"	1084	use your input method. Please note, however, that, depending on your Xlib
		1085	version, you may not be able to input characters outside C<EUC-JP> in a
		1086	normal way then, as your input method limits you.
624		1087
625	=head1 DESCRIPTION	1088	=head3 Rxvt-unicode crashes when the X Input Method changes or exits.
		1089
		1090	Unfortunately, this is unavoidable, as the XIM protocol is racy by
		1091	design. Applications can avoid some crashes at the expense of memory
		1092	leaks, and Input Methods can avoid some crashes by careful ordering at
		1093	exit time. B<kinput2> (and derived input methods) generally succeeds,
		1094	while B<SCIM> (or similar input methods) fails. In the end, however,
		1095	crashes cannot be completely avoided even if both sides cooperate.
		1096
		1097	So the only workaround is not to kill your Input Method Servers.
		1098
		1099
		1100	=head2 Operating Systems / Package Maintaining
		1101
		1102	=head3 I am using Debian GNU/Linux and have a problem...
		1103
		1104	The Debian GNU/Linux package of rxvt-unicode in sarge contains large
		1105	patches that considerably change the behaviour of rxvt-unicode (but
		1106	unfortunately this notice has been removed). Before reporting a bug to
		1107	the original rxvt-unicode author please download and install the genuine
		1108	version (L<http://software.schmorp.de#rxvt-unicode>) and try to reproduce
		1109	the problem. If you cannot, chances are that the problems are specific to
		1110	Debian GNU/Linux, in which case it should be reported via the Debian Bug
		1111	Tracking System (use C<reportbug> to report the bug).
		1112
		1113	For other problems that also affect the Debian package, you can and
		1114	probably should use the Debian BTS, too, because, after all, it's also a
		1115	bug in the Debian version and it serves as a reminder for other users that
		1116	might encounter the same issue.
		1117
		1118	=head3 I am maintaining rxvt-unicode for distribution/OS XXX, any recommendation?
		1119
		1120	You should build one binary with the default options. F<configure>
		1121	now enables most useful options, and the trend goes to making them
		1122	runtime-switchable, too, so there is usually no drawback to enabling them,
		1123	except higher disk and possibly memory usage. The perl interpreter should
		1124	be enabled, as important functionality (menus, selection, likely more in
		1125	the future) depends on it.
		1126
		1127	You should not overwrite the C<perl-ext-common> snd C<perl-ext> resources
		1128	system-wide (except maybe with C<defaults>). This will result in useful
		1129	behaviour. If your distribution aims at low memory, add an empty
		1130	C<perl-ext-common> resource to the app-defaults file. This will keep the
		1131	perl interpreter disabled until the user enables it.
		1132
		1133	If you can/want build more binaries, I recommend building a minimal
		1134	one with C<--disable-everything> (very useful) and a maximal one with
		1135	C<--enable-everything> (less useful, it will be very big due to a lot of
		1136	encodings built-in that increase download times and are rarely used).
		1137
		1138	=head3 I need to make it setuid/setgid to support utmp/ptys on my OS, is this safe?
		1139
		1140	It should be, starting with release 7.1. You are encouraged to properly
		1141	install urxvt with privileges necessary for your OS now.
		1142
		1143	When rxvt-unicode detects that it runs setuid or setgid, it will fork
		1144	into a helper process for privileged operations (pty handling on some
		1145	systems, utmp/wtmp/lastlog handling on others) and drop privileges
		1146	immediately. This is much safer than most other terminals that keep
		1147	privileges while running (but is more relevant to urxvt, as it contains
		1148	things as perl interpreters, which might be "helpful" to attackers).
		1149
		1150	This forking is done as the very first within main(), which is very early
		1151	and reduces possible bugs to initialisation code run before main(), or
		1152	things like the dynamic loader of your system, which should result in very
		1153	little risk.
		1154
		1155	=head3 On Solaris 9, many line-drawing characters are too wide.
		1156
		1157	Seems to be a known bug, read
		1158	L<http://nixdoc.net/files/forum/about34198.html>. Some people use the
		1159	following ugly workaround to get non-double-wide-characters working:
		1160
		1161	#define wcwidth(x) wcwidth(x) > 1 ? 1 : wcwidth(x)
		1162
		1163	=head3 I am on FreeBSD and rxvt-unicode does not seem to work at all.
		1164
		1165	Rxvt-unicode requires the symbol C<__STDC_ISO_10646__> to be defined
		1166	in your compile environment, or an implementation that implements it,
		1167	whether it defines the symbol or not. C<__STDC_ISO_10646__> requires that
		1168	B<wchar_t> is represented as unicode.
		1169
		1170	As you might have guessed, FreeBSD does neither define this symbol nor
		1171	does it support it. Instead, it uses its own internal representation of
		1172	B<wchar_t>. This is, of course, completely fine with respect to standards.
		1173
		1174	However, that means rxvt-unicode only works in C<POSIX>, C<ISO-8859-1> and
		1175	C<UTF-8> locales under FreeBSD (which all use Unicode as B<wchar_t>.
		1176
		1177	C<__STDC_ISO_10646__> is the only sane way to support multi-language
		1178	apps in an OS, as using a locale-dependent (and non-standardized)
		1179	representation of B<wchar_t> makes it impossible to convert between
		1180	B<wchar_t> (as used by X11 and your applications) and any other encoding
		1181	without implementing OS-specific-wrappers for each and every locale. There
		1182	simply are no APIs to convert B<wchar_t> into anything except the current
		1183	locale encoding.
		1184
		1185	Some applications (such as the formidable B<mlterm>) work around this
		1186	by carrying their own replacement functions for character set handling
		1187	with them, and either implementing OS-dependent hacks or doing multiple
		1188	conversions (which is slow and unreliable in case the OS implements
		1189	encodings slightly different than the terminal emulator).
		1190
		1191	The rxvt-unicode author insists that the right way to fix this is in the
		1192	system libraries once and for all, instead of forcing every app to carry
		1193	complete replacements for them :)
		1194
		1195	=head3 I use Solaris 9 and it doesn't compile/work/etc.
		1196
		1197	Try the diff in F<doc/solaris9.patch> as a base. It fixes the worst
		1198	problems with C<wcwidth> and a compile problem.
		1199
		1200	=head3 How can I use rxvt-unicode under cygwin?
		1201
		1202	rxvt-unicode should compile and run out of the box on cygwin, using
		1203	the X11 libraries that come with cygwin. libW11 emulation is no
		1204	longer supported (and makes no sense, either, as it only supported a
		1205	single font). I recommend starting the X-server in C<-multiwindow> or
		1206	C<-rootless> mode instead, which will result in similar look&feel as the
		1207	old libW11 emulation.
		1208
		1209	At the time of this writing, cygwin didn't seem to support any multi-byte
		1210	encodings (you might try C<LC_CTYPE=C-UTF-8>), so you are likely limited
		1211	to 8-bit encodings.
		1212
		1213	=head1 RXVT-UNICODE TECHNICAL REFERENCE
626		1214
627	The rest of this document describes various technical aspects of	1215	The rest of this document describes various technical aspects of
628	B<rxvt-unicode>. First the description of supported command sequences,	1216	B<rxvt-unicode>. First the description of supported command sequences,
629	followed by menu and pixmap support and last by a description of all	1217	followed by pixmap support and last by a description of all features
630	features selectable at C<configure> time.	1218	selectable at C<configure> time.
631		1219
632	=head1 RXVT TECHNICAL REFERENCE
633
634	=head1 Definitions	1220	=head2 Definitions
635		1221
636	=over 4	1222	=over 4
637		1223
638	=item B<< C<c> >>	1224	=item B<< C<c> >>
639		1225
…		…
657		1243
658	A text parameter composed of printable characters.	1244	A text parameter composed of printable characters.
659		1245
660	=back	1246	=back
661		1247
662	=head1 Values	1248	=head2 Values
663		1249
664	=over 4	1250	=over 4
665		1251
666	=item B<< C<ENQ> >>	1252	=item B<< C<ENQ> >>
667		1253
…		…
710		1296
711	Space Character	1297	Space Character
712		1298
713	=back	1299	=back
714		1300
715	=head1 Escape Sequences	1301	=head2 Escape Sequences
716		1302
717	=over 4	1303	=over 4
718		1304
719	=item B<< C<ESC # 8> >>	1305	=item B<< C<ESC # 8> >>
720		1306
…		…
766	Single Shift Select of G3 Character Set (SS3): affects next character	1352	Single Shift Select of G3 Character Set (SS3): affects next character
767	only I<unimplemented>	1353	only I<unimplemented>
768		1354
769	=item B<< C<ESC Z> >>	1355	=item B<< C<ESC Z> >>
770		1356
771	Obsolete form of returns: B<< C<ESC[?1;2C> >> I<rxvt-unicode compile-time option>	1357	Obsolete form of returns: B<< C<ESC [ ? 1 ; 2 C> >> I<rxvt-unicode compile-time option>
772		1358
773	=item B<< C<ESC c> >>	1359	=item B<< C<ESC c> >>
774		1360
775	Full reset (RIS)	1361	Full reset (RIS)
776		1362
…		…
780		1366
781	=item B<< C<ESC o> >>	1367	=item B<< C<ESC o> >>
782		1368
783	Invoke the G3 Character Set (LS3)	1369	Invoke the G3 Character Set (LS3)
784		1370
785	=item B<< C<ESC> ( C> >>	1371	=item B<< C<ESC ( C> >>
786		1372
787	Designate G0 Character Set (ISO 2022), see below for values of C<C>.	1373	Designate G0 Character Set (ISO 2022), see below for values of C<C>.
788		1374
789	=item B<< C<ESC> ) C> >>	1375	=item B<< C<ESC ) C> >>
790		1376
791	Designate G1 Character Set (ISO 2022), see below for values of C<C>.	1377	Designate G1 Character Set (ISO 2022), see below for values of C<C>.
792		1378
793	=item B<< C<ESC * C> >>	1379	=item B<< C<ESC * C> >>
794		1380
…		…
818		1404
819	=back	1405	=back
820		1406
821	X<CSI>	1407	X<CSI>
822		1408
823	=head1 CSI (Command Sequence Introducer) Sequences	1409	=head2 CSI (Command Sequence Introducer) Sequences
824		1410
825	=over 4	1411	=over 4
826		1412
827	=item B<< C<ESC [ Ps @> >>	1413	=item B<< C<ESC [ Ps @> >>
828		1414
…		…
935		1521
936	=item B<< C<ESC [ Ps c> >>	1522	=item B<< C<ESC [ Ps c> >>
937		1523
938	Send Device Attributes (DA)	1524	Send Device Attributes (DA)
939	B<< C<Ps = 0> >> (or omitted): request attributes from terminal	1525	B<< C<Ps = 0> >> (or omitted): request attributes from terminal
940	returns: B<< C<ESC[?1;2c> >> (``I am a VT100 with Advanced Video	1526	returns: B<< C<ESC [ ? 1 ; 2 c> >> (``I am a VT100 with Advanced Video
941	Option'')	1527	Option'')
942		1528
943	=item B<< C<ESC [ Ps d> >>	1529	=item B<< C<ESC [ Ps d> >>
944		1530
945	Cursor to Line B<< C<Ps> >> (VPA)	1531	Cursor to Line B<< C<Ps> >> (VPA)
…		…
1061		1647
1062	=item B<< C<ESC [ s> >>	1648	=item B<< C<ESC [ s> >>
1063		1649
1064	Save Cursor (SC)	1650	Save Cursor (SC)
1065		1651
		1652	=item B<< C<ESC [ Ps;Pt t> >>
		1653
		1654	Window Operations
		1655
		1656	=begin table
		1657
		1658	B<< C<Ps = 1> >> Deiconify (map) window
		1659	B<< C<Ps = 2> >> Iconify window
		1660	B<< C<Ps = 3> >> B<< C<ESC [ 3 ; X ; Y t> >> Move window to (X|Y)
		1661	B<< C<Ps = 4> >> B<< C<ESC [ 4 ; H ; W t> >> Resize to WxH pixels
		1662	B<< C<Ps = 5> >> Raise window
		1663	B<< C<Ps = 6> >> Lower window
		1664	B<< C<Ps = 7> >> Refresh screen once
		1665	B<< C<Ps = 8> >> B<< C<ESC [ 8 ; R ; C t> >> Resize to R rows and C columns
		1666	B<< C<Ps = 11> >> Report window state (responds with C<Ps = 1> or C<Ps = 2>)
		1667	B<< C<Ps = 13> >> Report window position (responds with C<Ps = 3>)
		1668	B<< C<Ps = 14> >> Report window pixel size (responds with C<Ps = 4>)
		1669	B<< C<Ps = 18> >> Report window text size (responds with C<Ps = 7>)
		1670	B<< C<Ps = 19> >> Currently the same as C<Ps = 18>, but responds with C<Ps = 9>
		1671	B<< C<Ps = 20> >> Reports icon label (B<< C<ESC ] L NAME \234> >>)
		1672	B<< C<Ps = 21> >> Reports window title (B<< C<ESC ] l NAME \234> >>)
		1673	B<< C<Ps = 24..> >> Set window height to C<Ps> rows
		1674
		1675	=end table
		1676
		1677	=item B<< C<ESC [ u> >>
		1678
		1679	Restore Cursor
		1680
1066	=item B<< C<ESC [ Ps x> >>	1681	=item B<< C<ESC [ Ps x> >>
1067		1682
1068	Request Terminal Parameters (DECREQTPARM)	1683	Request Terminal Parameters (DECREQTPARM)
1069		1684
1070	=item B<< C<ESC [ u> >>
1071
1072	Restore Cursor
1073
1074	=back	1685	=back
1075		1686
1076	X<PrivateModes>	1687	X<PrivateModes>
1077		1688
1078	=head1 DEC Private Modes	1689	=head2 DEC Private Modes
1079		1690
1080	=over 4	1691	=over 4
1081		1692
1082	=item B<< C<ESC [ ? Pm h> >>	1693	=item B<< C<ESC [ ? Pm h> >>
1083		1694
…		…
1099		1710
1100	Toggle DEC Private Mode Values (rxvt extension). I<where>	1711	Toggle DEC Private Mode Values (rxvt extension). I<where>
1101		1712
1102	=over 4	1713	=over 4
1103		1714
1104	=item B<< C<Ps = 1> >> (DECCKM)	1715	=item B<< C<Pm = 1> >> (DECCKM)
1105		1716
1106	=begin table	1717	=begin table
1107		1718
1108	B<< C<h> >> Application Cursor Keys	1719	B<< C<h> >> Application Cursor Keys
1109	B<< C<l> >> Normal Cursor Keys	1720	B<< C<l> >> Normal Cursor Keys
1110		1721
1111	=end table	1722	=end table
1112		1723
1113	=item B<< C<Ps = 2> >> (ANSI/VT52 mode)	1724	=item B<< C<Pm = 2> >> (ANSI/VT52 mode)
1114		1725
1115	=begin table	1726	=begin table
1116		1727
1117	B<< C<h> >> Enter VT52 mode	1728	B<< C<h> >> Enter VT52 mode
1118	B<< C<l> >> Enter VT52 mode	1729	B<< C<l> >> Enter VT52 mode
1119		1730
1120	=end table	1731	=end table
1121		1732
1122	=item B<< C<Ps = 3> >>	1733	=item B<< C<Pm = 3> >>
1123		1734
1124	=begin table	1735	=begin table
1125		1736
1126	B<< C<h> >> 132 Column Mode (DECCOLM)	1737	B<< C<h> >> 132 Column Mode (DECCOLM)
1127	B<< C<l> >> 80 Column Mode (DECCOLM)	1738	B<< C<l> >> 80 Column Mode (DECCOLM)
1128		1739
1129	=end table	1740	=end table
1130		1741
1131	=item B<< C<Ps = 4> >>	1742	=item B<< C<Pm = 4> >>
1132		1743
1133	=begin table	1744	=begin table
1134		1745
1135	B<< C<h> >> Smooth (Slow) Scroll (DECSCLM)	1746	B<< C<h> >> Smooth (Slow) Scroll (DECSCLM)
1136	B<< C<l> >> Jump (Fast) Scroll (DECSCLM)	1747	B<< C<l> >> Jump (Fast) Scroll (DECSCLM)
1137		1748
1138	=end table	1749	=end table
1139		1750
1140	=item B<< C<Ps = 5> >>	1751	=item B<< C<Pm = 5> >>
1141		1752
1142	=begin table	1753	=begin table
1143		1754
1144	B<< C<h> >> Reverse Video (DECSCNM)	1755	B<< C<h> >> Reverse Video (DECSCNM)
1145	B<< C<l> >> Normal Video (DECSCNM)	1756	B<< C<l> >> Normal Video (DECSCNM)
1146		1757
1147	=end table	1758	=end table
1148		1759
1149	=item B<< C<Ps = 6> >>	1760	=item B<< C<Pm = 6> >>
1150		1761
1151	=begin table	1762	=begin table
1152		1763
1153	B<< C<h> >> Origin Mode (DECOM)	1764	B<< C<h> >> Origin Mode (DECOM)
1154	B<< C<l> >> Normal Cursor Mode (DECOM)	1765	B<< C<l> >> Normal Cursor Mode (DECOM)
1155		1766
1156	=end table	1767	=end table
1157		1768
1158	=item B<< C<Ps = 7> >>	1769	=item B<< C<Pm = 7> >>
1159		1770
1160	=begin table	1771	=begin table
1161		1772
1162	B<< C<h> >> Wraparound Mode (DECAWM)	1773	B<< C<h> >> Wraparound Mode (DECAWM)
1163	B<< C<l> >> No Wraparound Mode (DECAWM)	1774	B<< C<l> >> No Wraparound Mode (DECAWM)
1164		1775
1165	=end table	1776	=end table
1166		1777
1167	=item B<< C<Ps = 8> >> I<unimplemented>	1778	=item B<< C<Pm = 8> >> I<unimplemented>
1168		1779
1169	=begin table	1780	=begin table
1170		1781
1171	B<< C<h> >> Auto-repeat Keys (DECARM)	1782	B<< C<h> >> Auto-repeat Keys (DECARM)
1172	B<< C<l> >> No Auto-repeat Keys (DECARM)	1783	B<< C<l> >> No Auto-repeat Keys (DECARM)
1173		1784
1174	=end table	1785	=end table
1175		1786
1176	=item B<< C<Ps = 9> >> X10 XTerm	1787	=item B<< C<Pm = 9> >> X10 XTerm
1177		1788
1178	=begin table	1789	=begin table
1179		1790
1180	B<< C<h> >> Send Mouse X & Y on button press.	1791	B<< C<h> >> Send Mouse X & Y on button press.
1181	B<< C<l> >> No mouse reporting.	1792	B<< C<l> >> No mouse reporting.
1182		1793
1183	=end table	1794	=end table
1184		1795
1185	=item B<< C<Ps = 10> >> (B<rxvt>)
1186
1187	=begin table
1188
1189	B<< C<h> >> menuBar visible
1190	B<< C<l> >> menuBar invisible
1191
1192	=end table
1193
1194	=item B<< C<Ps = 25> >>	1796	=item B<< C<Pm = 25> >>
1195		1797
1196	=begin table	1798	=begin table
1197		1799
1198	B<< C<h> >> Visible cursor {cnorm/cvvis}	1800	B<< C<h> >> Visible cursor {cnorm/cvvis}
1199	B<< C<l> >> Invisible cursor {civis}	1801	B<< C<l> >> Invisible cursor {civis}
1200		1802
1201	=end table	1803	=end table
1202		1804
1203	=item B<< C<Ps = 30> >>	1805	=item B<< C<Pm = 30> >>
1204		1806
1205	=begin table	1807	=begin table
1206		1808
1207	B<< C<h> >> scrollBar visisble	1809	B<< C<h> >> scrollBar visisble
1208	B<< C<l> >> scrollBar invisisble	1810	B<< C<l> >> scrollBar invisisble
1209		1811
1210	=end table	1812	=end table
1211		1813
1212	=item B<< C<Ps = 35> >> (B<rxvt>)	1814	=item B<< C<Pm = 35> >> (B<rxvt>)
1213		1815
1214	=begin table	1816	=begin table
1215		1817
1216	B<< C<h> >> Allow XTerm Shift+key sequences	1818	B<< C<h> >> Allow XTerm Shift+key sequences
1217	B<< C<l> >> Disallow XTerm Shift+key sequences	1819	B<< C<l> >> Disallow XTerm Shift+key sequences
1218		1820
1219	=end table	1821	=end table
1220		1822
1221	=item B<< C<Ps = 38> >> I<unimplemented>	1823	=item B<< C<Pm = 38> >> I<unimplemented>
1222		1824
1223	Enter Tektronix Mode (DECTEK)	1825	Enter Tektronix Mode (DECTEK)
1224		1826
1225	=item B<< C<Ps = 40> >>	1827	=item B<< C<Pm = 40> >>
1226		1828
1227	=begin table	1829	=begin table
1228		1830
1229	B<< C<h> >> Allow 80/132 Mode	1831	B<< C<h> >> Allow 80/132 Mode
1230	B<< C<l> >> Disallow 80/132 Mode	1832	B<< C<l> >> Disallow 80/132 Mode
1231		1833
1232	=end table	1834	=end table
1233		1835
1234	=item B<< C<Ps = 44> >> I<unimplemented>	1836	=item B<< C<Pm = 44> >> I<unimplemented>
1235		1837
1236	=begin table	1838	=begin table
1237		1839
1238	B<< C<h> >> Turn On Margin Bell	1840	B<< C<h> >> Turn On Margin Bell
1239	B<< C<l> >> Turn Off Margin Bell	1841	B<< C<l> >> Turn Off Margin Bell
1240		1842
1241	=end table	1843	=end table
1242		1844
1243	=item B<< C<Ps = 45> >> I<unimplemented>	1845	=item B<< C<Pm = 45> >> I<unimplemented>
1244		1846
1245	=begin table	1847	=begin table
1246		1848
1247	B<< C<h> >> Reverse-wraparound Mode	1849	B<< C<h> >> Reverse-wraparound Mode
1248	B<< C<l> >> No Reverse-wraparound Mode	1850	B<< C<l> >> No Reverse-wraparound Mode
1249		1851
1250	=end table	1852	=end table
1251		1853
1252	=item B<< C<Ps = 46> >> I<unimplemented>	1854	=item B<< C<Pm = 46> >> I<unimplemented>
1253		1855
1254	=item B<< C<Ps = 47> >>	1856	=item B<< C<Pm = 47> >>
1255		1857
1256	=begin table	1858	=begin table
1257		1859
1258	B<< C<h> >> Use Alternate Screen Buffer	1860	B<< C<h> >> Use Alternate Screen Buffer
1259	B<< C<l> >> Use Normal Screen Buffer	1861	B<< C<l> >> Use Normal Screen Buffer
1260		1862
1261	=end table	1863	=end table
1262		1864
1263	X<Priv66>	1865	X<Priv66>
1264		1866
1265	=item B<< C<Ps = 66> >>	1867	=item B<< C<Pm = 66> >>
1266		1868
1267	=begin table	1869	=begin table
1268		1870
1269	B<< C<h> >> Application Keypad (DECPAM) == C<ESC =>	1871	B<< C<h> >> Application Keypad (DECPAM) == C<ESC =>
1270	B<< C<l> >> Normal Keypad (DECPNM) == C<< ESC > >>	1872	B<< C<l> >> Normal Keypad (DECPNM) == C<< ESC > >>
1271		1873
1272	=end table	1874	=end table
1273		1875
1274	=item B<< C<Ps = 67> >>	1876	=item B<< C<Pm = 67> >>
1275		1877
1276	=begin table	1878	=begin table
1277		1879
1278	B<< C<h> >> Backspace key sends B<< C<BS> (DECBKM) >>	1880	B<< C<h> >> Backspace key sends B<< C<BS> (DECBKM) >>
1279	B<< C<l> >> Backspace key sends B<< C<DEL> >>	1881	B<< C<l> >> Backspace key sends B<< C<DEL> >>
1280		1882
1281	=end table	1883	=end table
1282		1884
1283	=item B<< C<Ps = 1000> >> (X11 XTerm)	1885	=item B<< C<Pm = 1000> >> (X11 XTerm)
1284		1886
1285	=begin table	1887	=begin table
1286		1888
1287	B<< C<h> >> Send Mouse X & Y on button press and release.	1889	B<< C<h> >> Send Mouse X & Y on button press and release.
1288	B<< C<l> >> No mouse reporting.	1890	B<< C<l> >> No mouse reporting.
1289		1891
1290	=end table	1892	=end table
1291		1893
1292	=item B<< C<Ps = 1001> >> (X11 XTerm) I<unimplemented>	1894	=item B<< C<Pm = 1001> >> (X11 XTerm) I<unimplemented>
1293		1895
1294	=begin table	1896	=begin table
1295		1897
1296	B<< C<h> >> Use Hilite Mouse Tracking.	1898	B<< C<h> >> Use Hilite Mouse Tracking.
1297	B<< C<l> >> No mouse reporting.	1899	B<< C<l> >> No mouse reporting.
1298		1900
1299	=end table	1901	=end table
1300		1902
1301	=item B<< C<Ps = 1010> >> (B<rxvt>)	1903	=item B<< C<Pm = 1010> >> (B<rxvt>)
1302		1904
1303	=begin table	1905	=begin table
1304		1906
1305	B<< C<h> >> Don't scroll to bottom on TTY output	1907	B<< C<h> >> Don't scroll to bottom on TTY output
1306	B<< C<l> >> Scroll to bottom on TTY output	1908	B<< C<l> >> Scroll to bottom on TTY output
1307		1909
1308	=end table	1910	=end table
1309		1911
1310	=item B<< C<Ps = 1011> >> (B<rxvt>)	1912	=item B<< C<Pm = 1011> >> (B<rxvt>)
1311		1913
1312	=begin table	1914	=begin table
1313		1915
1314	B<< C<h> >> Scroll to bottom when a key is pressed	1916	B<< C<h> >> Scroll to bottom when a key is pressed
1315	B<< C<l> >> Don't scroll to bottom when a key is pressed	1917	B<< C<l> >> Don't scroll to bottom when a key is pressed
1316		1918
1317	=end table	1919	=end table
1318		1920
		1921	=item B<< C<Pm = 1021> >> (B<rxvt>)
		1922
		1923	=begin table
		1924
		1925	B<< C<h> >> Bold/italic implies high intensity (see option B<-is>)
		1926	B<< C<l> >> Font styles have no effect on intensity (Compile styles)
		1927
		1928	=end table
		1929
1319	=item B<< C<Ps = 1047> >>	1930	=item B<< C<Pm = 1047> >>
1320		1931
1321	=begin table	1932	=begin table
1322		1933
1323	B<< C<h> >> Use Alternate Screen Buffer	1934	B<< C<h> >> Use Alternate Screen Buffer
1324	B<< C<l> >> Use Normal Screen Buffer - clear Alternate Screen Buffer if returning from it	1935	B<< C<l> >> Use Normal Screen Buffer - clear Alternate Screen Buffer if returning from it
1325		1936
1326	=end table	1937	=end table
1327		1938
1328	=item B<< C<Ps = 1048> >>	1939	=item B<< C<Pm = 1048> >>
1329		1940
1330	=begin table	1941	=begin table
1331		1942
1332	B<< C<h> >> Save cursor position	1943	B<< C<h> >> Save cursor position
1333	B<< C<l> >> Restore cursor position	1944	B<< C<l> >> Restore cursor position
1334		1945
1335	=end table	1946	=end table
1336		1947
1337	=item B<< C<Ps = 1049> >>	1948	=item B<< C<Pm = 1049> >>
1338		1949
1339	=begin table	1950	=begin table
1340		1951
1341	B<< C<h> >> Use Alternate Screen Buffer - clear Alternate Screen Buffer if switching to it	1952	B<< C<h> >> Use Alternate Screen Buffer - clear Alternate Screen Buffer if switching to it
1342	B<< C<l> >> Use Normal Screen Buffer	1953	B<< C<l> >> Use Normal Screen Buffer
…		…
1347		1958
1348	=back	1959	=back
1349		1960
1350	X<XTerm>	1961	X<XTerm>
1351		1962
1352	=head1 XTerm Operating System Commands	1963	=head2 XTerm Operating System Commands
1353		1964
1354	=over 4	1965	=over 4
1355		1966
1356	=item B<< C<ESC ] Ps;Pt ST> >>	1967	=item B<< C<ESC ] Ps;Pt ST> >>
1357		1968
…		…
1369	B<< C<Ps = 10> >> Change colour of text foreground to B<< C<Pt> >> B<(NB: may change in future)>	1980	B<< C<Ps = 10> >> Change colour of text foreground to B<< C<Pt> >> B<(NB: may change in future)>
1370	B<< C<Ps = 11> >> Change colour of text background to B<< C<Pt> >> B<(NB: may change in future)>	1981	B<< C<Ps = 11> >> Change colour of text background to B<< C<Pt> >> B<(NB: may change in future)>
1371	B<< C<Ps = 12> >> Change colour of text cursor foreground to B<< C<Pt> >>	1982	B<< C<Ps = 12> >> Change colour of text cursor foreground to B<< C<Pt> >>
1372	B<< C<Ps = 13> >> Change colour of mouse foreground to B<< C<Pt> >>	1983	B<< C<Ps = 13> >> Change colour of mouse foreground to B<< C<Pt> >>
1373	B<< C<Ps = 17> >> Change colour of highlight characters to B<< C<Pt> >>	1984	B<< C<Ps = 17> >> Change colour of highlight characters to B<< C<Pt> >>
1374	B<< C<Ps = 18> >> Change colour of bold characters to B<< C<Pt> >>	1985	B<< C<Ps = 18> >> Change colour of bold characters to B<< C<Pt> >> [deprecated, see 706]
1375	B<< C<Ps = 19> >> Change colour of underlined characters to B<< C<Pt> >>	1986	B<< C<Ps = 19> >> Change colour of underlined characters to B<< C<Pt> >> [deprecated, see 707]
		1987	B<< C<Ps = 20> >> Change background pixmap parameters (see section XPM) (Compile XPM).
1376	B<< C<Ps = 20> >> Change default background to B<< C<Pt> >>	1988	B<< C<Ps = 39> >> Change default foreground colour to B<< C<Pt> >>.
1377	B<< C<Ps = 39> >> Change default foreground colour to B<< C<Pt> >> I<rxvt compile-time option>
1378	B<< C<Ps = 46> >> Change Log File to B<< C<Pt> >> I<unimplemented>	1989	B<< C<Ps = 46> >> Change Log File to B<< C<Pt> >> I<unimplemented>
1379	B<< C<Ps = 49> >> Change default background colour to B<< C<Pt> >> I<rxvt compile-time option>	1990	B<< C<Ps = 49> >> Change default background colour to B<< C<Pt> >>.
1380	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> >>	1991	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> >>
1381	B<< C<Ps = 55> >> Log all scrollback buffer and all of screen to B<< C<Pt> >>	1992	B<< C<Ps = 55> >> Log all scrollback buffer and all of screen to B<< C<Pt> >>
1382	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)	1993	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).
1383	B<< C<Ps = 703> >> Menubar command B<< C<Pt> >> I<rxvt compile-time option> (rxvt-unicode extension)	1994	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>.
1384	B<< C<Ps = 704> >> Change colour of italic characters to B<< C<Pt> >>	1995	B<< C<Ps = 704> >> Change colour of italic characters to B<< C<Pt> >>
1385	B<< C<Ps = 705> >> Change background pixmap tint colour to B<< C<Pt> >>	1996	B<< C<Ps = 705> >> Change background pixmap tint colour to B<< C<Pt> >> (Compile transparency).
		1997	B<< C<Ps = 706> >> Change colour of bold characters to B<< C<Pt> >>
		1998	B<< C<Ps = 707> >> Change colour of underlined characters to B<< C<Pt> >>
1386	B<< C<Ps = 710> >> Set normal fontset to B<< C<Pt> >>. Same as C<Ps = 50>.	1999	B<< C<Ps = 710> >> Set normal fontset to B<< C<Pt> >>. Same as C<Ps = 50>.
1387	B<< C<Ps = 711> >> Set bold fontset to B<< C<Pt> >>. Similar to C<Ps = 50>.	2000	B<< C<Ps = 711> >> Set bold fontset to B<< C<Pt> >>. Similar to C<Ps = 50> (Compile styles).
1388	B<< C<Ps = 712> >> Set italic fontset to B<< C<Pt> >>. Similar to C<Ps = 50>.	2001	B<< C<Ps = 712> >> Set italic fontset to B<< C<Pt> >>. Similar to C<Ps = 50> (Compile styles).
1389	B<< C<Ps = 713> >> Set bold-italic fontset to B<< C<Pt> >>. Similar to C<Ps = 50>.	2002	B<< C<Ps = 713> >> Set bold-italic fontset to B<< C<Pt> >>. Similar to C<Ps = 50> (Compile styles).
		2003	B<< C<Ps = 720> >> Move viewing window up by B<< C<Pt> >> lines, or clear scrollback buffer if C<Pt = 0> (Compile frills).
		2004	B<< C<Ps = 721> >> Move viewing window down by B<< C<Pt> >> lines, or clear scrollback buffer if C<Pt = 0> (Compile frills).
		2005	B<< C<Ps = 777> >> Call the perl extension with the given string, which should be of the form C<extension:parameters> (Compile perl).
1390		2006
1391	=end table	2007	=end table
1392		2008
1393	=back	2009	=back
1394
1395	X<menuBar>
1396
1397	=head1 menuBar
1398
1399	B<< The exact syntax used is I<almost> solidified. >>
1400	In the menus, B<DON'T> try to use menuBar commands that add or remove a
1401	menuBar.
1402
1403	Note that in all of the commands, the B<< I</path/> >> I<cannot> be
1404	omitted: use B<./> to specify a menu relative to the current menu.
1405
1406	=head2 Overview of menuBar operation
1407
1408	For the menuBar XTerm escape sequence C<ESC ] 703 ; Pt ST>, the syntax
1409	of C<Pt> can be used for a variety of tasks:
1410
1411	At the top level is the current menuBar which is a member of a circular
1412	linked-list of other such menuBars.
1413
1414	The menuBar acts as a parent for the various drop-down menus, which in
1415	turn, may have labels, separator lines, menuItems and subMenus.
1416
1417	The menuItems are the useful bits: you can use them to mimic keyboard
1418	input or even to send text or escape sequences back to rxvt.
1419
1420	The menuBar syntax is intended to provide a simple yet robust method of
1421	constructing and manipulating menus and navigating through the
1422	menuBars.
1423
1424	The first step is to use the tag B<< [menu:I<name>] >> which creates
1425	the menuBar called I<name> and allows access. You may now or menus,
1426	subMenus, and menuItems. Finally, use the tag B<[done]> to set the
1427	menuBar access as B<readonly> to prevent accidental corruption of the
1428	menus. To re-access the current menuBar for alterations, use the tag
1429	B<[menu]>, make the alterations and then use B<[done]>
1430
1431	X<menuBarCommands>
1432
1433	=head2 Commands
1434
1435	=over 4
1436
1437	=item B<< [menu:+I<name>] >>
1438
1439	access the named menuBar for creation or alteration. If a new menuBar
1440	is created, it is called I<name> (max of 15 chars) and the current
1441	menuBar is pushed onto the stack
1442
1443	=item B<[menu]>
1444
1445	access the current menuBar for alteration
1446
1447	=item B<< [title:+I<string>] >>
1448
1449	set the current menuBar's title to I<string>, which may contain the
1450	following format specifiers:
1451	B<%%> : literal B<%> character
1452	B<%n> : rxvt name (as per the B<-name> command-line option)
1453	B<%v> : rxvt version
1454
1455	=item B<[done]>
1456
1457	set menuBar access as B<readonly>.
1458	End-of-file tag for B<< [read:+I<file>] >> operations.
1459
1460	=item B<< [read:+I<file>] >>
1461
1462	read menu commands directly from I<file> (extension ".menu" will be
1463	appended if required.) Start reading at a line with B<[menu]> or B<<
1464	[menu:+I<name> >> and continuing until B<[done]> is encountered.
1465
1466	Blank and comment lines (starting with B<#>) are ignored. Actually,
1467	since any invalid menu commands are also ignored, almost anything could
1468	be construed as a comment line, but this may be tightened up in the
1469	future ... so don't count on it!.
1470
1471	=item B<< [read:+I<file>;+I<name>] >>
1472
1473	The same as B<< [read:+I<file>] >>, but start reading at a line with
1474	B<< [menu:+I<name>] >> and continuing until B<< [done:+I<name>] >> or
1475	B<[done]> is encountered.
1476
1477	=item B<[dump]>
1478
1479	dump all menuBars to the file B</tmp/rxvt-PID> in a format suitable for
1480	later rereading.
1481
1482	=item B<[rm:name]>
1483
1484	remove the named menuBar
1485
1486	=item B<[rm] [rm:]>
1487
1488	remove the current menuBar
1489
1490	=item B<[rm*] [rm:*]>
1491
1492	remove all menuBars
1493
1494	=item B<[swap]>
1495
1496	swap the top two menuBars
1497
1498	=item B<[prev]>
1499
1500	access the previous menuBar
1501
1502	=item B<[next]>
1503
1504	access the next menuBar
1505
1506	=item B<[show]>
1507
1508	Enable display of the menuBar
1509
1510	=item B<[hide]>
1511
1512	Disable display of the menuBar
1513
1514	=item B<< [pixmap:+I<name>] >>
1515
1516	=item B<< [pixmap:+I<name>;I<scaling>] >>
1517
1518	(set the background pixmap globally
1519
1520	B<< A Future implementation I<may> make this local to the menubar >>)
1521
1522	=item B<< [:+I<command>:] >>
1523
1524	ignore the menu readonly status and issue a I<command> to or a menu or
1525	menuitem or change the ; a useful shortcut for setting the quick arrows
1526	from a menuBar.
1527
1528	=back
1529
1530	X<menuBarAdd>
1531
1532	=head2 Adding and accessing menus
1533
1534	The following commands may also be B<+> prefixed.
1535
1536	=over 4
1537
1538	=item B</+>
1539
1540	access menuBar top level
1541
1542	=item B<./+>
1543
1544	access current menu level
1545
1546	=item B<../+>
1547
1548	access parent menu (1 level up)
1549
1550	=item B<../../>
1551
1552	access parent menu (multiple levels up)
1553
1554	=item B<< I</path/>menu >>
1555
1556	add/access menu
1557
1558	=item B<< I</path/>menu/* >>
1559
1560	add/access menu and clear it if it exists
1561
1562	=item B<< I</path/>{-} >>
1563
1564	add separator
1565
1566	=item B<< I</path/>{item} >>
1567
1568	add B<item> as a label
1569
1570	=item B<< I</path/>{item} action >>
1571
1572	add/alter I<menuitem> with an associated I<action>
1573
1574	=item B<< I</path/>{item}{right-text} >>
1575
1576	add/alter I<menuitem> with B<right-text> as the right-justified text
1577	and as the associated I<action>
1578
1579	=item B<< I</path/>{item}{rtext} action >>
1580
1581	add/alter I<menuitem> with an associated I<action> and with B<rtext> as
1582	the right-justified text.
1583
1584	=back
1585
1586	=over 4
1587
1588	=item Special characters in I<action> must be backslash-escaped:
1589
1590	B<\a \b \E \e \n \r \t \octal>
1591
1592	=item or in control-character notation:
1593
1594	B<^@, ^A .. ^Z .. ^_, ^?>
1595
1596	=back
1597
1598	To send a string starting with a B<NUL> (B<^@>) character to the
1599	program, start I<action> with a pair of B<NUL> characters (B<^@^@>),
1600	the first of which will be stripped off and the balance directed to the
1601	program. Otherwise if I<action> begins with B<NUL> followed by
1602	non-+B<NUL> characters, the leading B<NUL> is stripped off and the
1603	balance is sent back to rxvt.
1604
1605	As a convenience for the many Emacs-type editors, I<action> may start
1606	with B<M-> (eg, B<M-$> is equivalent to B<\E$>) and a B<CR> will be
1607	appended if missed from B<M-x> commands.
1608
1609	As a convenience for issuing XTerm B<ESC]> sequences from a menubar (or
1610	quick arrow), a B<BEL> (B<^G>) will be appended if needed.
1611
1612	=over 4
1613
1614	=item For example,
1615
1616	B<M-xapropos> is equivalent to B<\Exapropos\r>
1617
1618	=item and
1619
1620	B<\E]703;mona;100> is equivalent to B<\E]703;mona;100\a>
1621
1622	=back
1623
1624	The option B<< {I<right-rtext>} >> will be right-justified. In the
1625	absence of a specified action, this text will be used as the I<action>
1626	as well.
1627
1628	=over 4
1629
1630	=item For example,
1631
1632	B</File/{Open}{^X^F}> is equivalent to B</File/{Open}{^X^F} ^X^F>
1633
1634	=back
1635
1636	The left label I<is> necessary, since it's used for matching, but
1637	implicitly hiding the left label (by using same name for both left and
1638	right labels), or explicitly hiding the left label (by preceeding it
1639	with a dot), makes it possible to have right-justified text only.
1640
1641	=over 4
1642
1643	=item For example,
1644
1645	B</File/{Open}{Open} Open-File-Action>
1646
1647	=item or hiding it
1648
1649	B</File/{.anylabel}{Open} Open-File-Action>
1650
1651	=back
1652
1653	X<menuBarRemove>
1654
1655	=head2 Removing menus
1656
1657	=over 4
1658
1659	=item B<< -/*+ >>
1660
1661	remove all menus from the menuBar, the same as B<[clear]>
1662
1663	=item B<< -+I</path>menu+ >>
1664
1665	remove menu
1666
1667	=item B<< -+I</path>{item}+ >>
1668
1669	remove item
1670
1671	=item B<< -+I</path>{-} >>
1672
1673	remove separator)
1674
1675	=item B<-/path/menu/*>
1676
1677	remove all items, separators and submenus from menu
1678
1679	=back
1680
1681	X<menuBarArrows>
1682
1683	=head2 Quick Arrows
1684
1685	The menus also provide a hook for I<quick arrows> to provide easier
1686	user access. If nothing has been explicitly set, the default is to
1687	emulate the curror keys. The syntax permits each arrow to be altered
1688	individually or all four at once without re-entering their common
1689	beginning/end text. For example, to explicitly associate cursor actions
1690	with the arrows, any of the following forms could be used:
1691
1692	=over 4
1693
1694	=item B<< <r>+I<Right> >>
1695
1696	=item B<< <l>+I<Left> >>
1697
1698	=item B<< <u>+I<Up> >>
1699
1700	=item B<< <d>+I<Down> >>
1701
1702	Define actions for the respective arrow buttons
1703
1704	=item B<< <b>+I<Begin> >>
1705
1706	=item B<< <e>+I<End> >>
1707
1708	Define common beginning/end parts for I<quick arrows> which used in
1709	conjunction with the above <r> <l> <u> <d> constructs
1710
1711	=back
1712
1713	=over 4
1714
1715	=item For example, define arrows individually,
1716
1717	<u>\E[A
1718
1719	<d>\E[B
1720
1721	<r>\E[C
1722
1723	<l>\E[D
1724
1725	=item or all at once
1726
1727	<u>\E[AZ<><d>\E[BZ<><r>\E[CZ<><l>\E[D
1728
1729	=item or more compactly (factoring out common parts)
1730
1731	<b>\E[<u>AZ<><d>BZ<><r>CZ<><l>D
1732
1733	=back
1734
1735	X<menuBarSummary>
1736
1737	=head2 Command Summary
1738
1739	A short summary of the most I<common> commands:
1740
1741	=over 4
1742
1743	=item [menu:name]
1744
1745	use an existing named menuBar or start a new one
1746
1747	=item [menu]
1748
1749	use the current menuBar
1750
1751	=item [title:string]
1752
1753	set menuBar title
1754
1755	=item [done]
1756
1757	set menu access to readonly and, if reading from a file, signal EOF
1758
1759	=item [done:name]
1760
1761	if reading from a file using [read:file;name] signal EOF
1762
1763	=item [rm:name]
1764
1765	remove named menuBar(s)
1766
1767	=item [rm] [rm:]
1768
1769	remove current menuBar
1770
1771	=item [rm*] [rm:*]
1772
1773	remove all menuBar(s)
1774
1775	=item [swap]
1776
1777	swap top two menuBars
1778
1779	=item [prev]
1780
1781	access the previous menuBar
1782
1783	=item [next]
1784
1785	access the next menuBar
1786
1787	=item [show]
1788
1789	map menuBar
1790
1791	=item [hide]
1792
1793	unmap menuBar
1794
1795	=item [pixmap;file]
1796
1797	=item [pixmap;file;scaling]
1798
1799	set a background pixmap
1800
1801	=item [read:file]
1802
1803	=item [read:file;name]
1804
1805	read in a menu from a file
1806
1807	=item [dump]
1808
1809	dump out all menuBars to /tmp/rxvt-PID
1810
1811	=item /
1812
1813	access menuBar top level
1814
1815	=item ./
1816
1817	=item ../
1818
1819	=item ../../
1820
1821	access current or parent menu level
1822
1823	=item /path/menu
1824
1825	add/access menu
1826
1827	=item /path/{-}
1828
1829	add separator
1830
1831	=item /path/{item}{rtext} action
1832
1833	add/alter menu item
1834
1835	=item -/*
1836
1837	remove all menus from the menuBar
1838
1839	=item -/path/menu
1840
1841	remove menu items, separators and submenus from menu
1842
1843	=item -/path/menu
1844
1845	remove menu
1846
1847	=item -/path/{item}
1848
1849	remove item
1850
1851	=item -/path/{-}
1852
1853	remove separator
1854
1855	=item <b>Begin<r>Right<l>Left<u>Up<d>Down<e>End
1856
1857	menu quick arrows
1858
1859	=back
1860	X<XPM>
1861		2010
1862	=head1 XPM	2011	=head1 XPM
1863		2012
1864	For the XPM XTerm escape sequence B<< C<ESC ] 20 ; Pt ST> >> then value	2013	For the XPM XTerm escape sequence B<< C<ESC ] 20 ; Pt ST> >> then value
1865	of B<< C<Pt> >> can be the name of the background pixmap followed by a	2014	of B<< C<Pt> >> can be the name of the background pixmap followed by a
…		…
1963	=begin table	2112	=begin table
1964		2113
1965	4 Shift	2114	4 Shift
1966	8 Meta	2115	8 Meta
1967	16 Control	2116	16 Control
1968	32 Double Click I<(Rxvt extension)>	2117	32 Double Click I<(rxvt extension)>
1969		2118
1970	=end table	2119	=end table
1971		2120
1972	Col = B<< C<< <x> - SPACE >> >>	2121	Col = B<< C<< <x> - SPACE >> >>
1973		2122
…		…
2050	=end table	2199	=end table
2051		2200
2052	=head1 CONFIGURE OPTIONS	2201	=head1 CONFIGURE OPTIONS
2053		2202
2054	General hint: if you get compile errors, then likely your configuration	2203	General hint: if you get compile errors, then likely your configuration
2055	hasn't been tested well. Either try with --enable-everything or use the	2204	hasn't been tested well. Either try with C<--enable-everything> or use
2056	./reconf script as a base for experiments. ./reconf is used by myself,	2205	the F<./reconf> script as a base for experiments. F<./reconf> is used by
2057	so it should generally be a working config. Of course, you should always	2206	myself, so it should generally be a working config. Of course, you should
2058	report when a combination doesn't work, so it can be fixed. Marc Lehmann	2207	always report when a combination doesn't work, so it can be fixed. Marc
2059	<rxvt@schmorp.de>.	2208	Lehmann <rxvt@schmorp.de>.
		2209
		2210	All
2060		2211
2061	=over 4	2212	=over 4
2062		2213
2063	=item --enable-everything	2214	=item --enable-everything
2064		2215
2065	Add support for all non-multichoice options listed in "./configure	2216	Add (or remove) support for all non-multichoice options listed in "./configure
2066	--help". Note that unlike other enable options this is order dependant.	2217	--help".
		2218
2067	You can specify this and then disable options which this enables by	2219	You can specify this and then disable options you do not like by
2068	I<following> this with the appropriate commands.	2220	I<following> this with the appropriate C<--disable-...> arguments,
		2221	or you can start with a minimal configuration by specifying
		2222	C<--disable-everything> and than adding just the C<--enable-...> arguments
		2223	you want.
2069		2224
2070	=item --enable-xft	2225	=item --enable-xft (default: enabled)
2071		2226
2072	Add support for Xft (anti-aliases, among others) fonts. Xft fonts are	2227	Add support for Xft (anti-aliases, among others) fonts. Xft fonts are
2073	slower and require lots of memory, but as long as you don't use them, you	2228	slower and require lots of memory, but as long as you don't use them, you
2074	don't pay for them.	2229	don't pay for them.
2075		2230
2076	=item --enable-font-styles	2231	=item --enable-font-styles (default: on)
2077		2232
2078	Add support for B<bold>, I<italic> and B<< I<bold italic> >> font	2233	Add support for B<bold>, I<italic> and B<< I<bold italic> >> font
2079	styles. The fonts can be set manually or automatically.	2234	styles. The fonts can be set manually or automatically.
2080		2235
2081	=item --with-codesets=NAME,...	2236	=item --with-codesets=NAME,... (default: all)
2082		2237
2083	Compile in support for additional codeset (encoding) groups (eu, vn are	2238	Compile in support for additional codeset (encoding) groups (C<eu>, C<vn>
2084	always compiled in, which includes most 8-bit character sets). These	2239	are always compiled in, which includes most 8-bit character sets). These
2085	codeset tables are currently only used for driving X11 core fonts, they	2240	codeset tables are used for driving X11 core fonts, they are not required
2086	are not required for Xft fonts. Compiling them in will make your binary	2241	for Xft fonts, although having them compiled in lets rxvt-unicode choose
2087	bigger (together about 700kB), but it doesn't increase memory usage unless	2242	replacement fonts more intelligently. Compiling them in will make your
		2243	binary bigger (all of together cost about 700kB), but it doesn't increase
2088	you use an X11 font requiring one of these encodings.	2244	memory usage unless you use a font requiring one of these encodings.
2089		2245
2090	=begin table	2246	=begin table
2091		2247
2092	all all available codeset groups	2248	all all available codeset groups
2093	zh common chinese encodings	2249	zh common chinese encodings
…		…
2096	jp_ext rarely used but big japanese encodings	2252	jp_ext rarely used but big japanese encodings
2097	kr korean encodings	2253	kr korean encodings
2098		2254
2099	=end table	2255	=end table
2100		2256
2101	=item --enable-xim	2257	=item --enable-xim (default: on)
2102		2258
2103	Add support for XIM (X Input Method) protocol. This allows using	2259	Add support for XIM (X Input Method) protocol. This allows using
2104	alternative input methods (e.g. kinput2) and will also correctly	2260	alternative input methods (e.g. kinput2) and will also correctly
2105	set up the input for people using dead keys or compose keys.	2261	set up the input for people using dead keys or compose keys.
2106		2262
2107	=item --enable-unicode3	2263	=item --enable-unicode3 (default: off)
		2264
		2265	Recommended to stay off unless you really need non-BMP characters.
2108		2266
2109	Enable direct support for displaying unicode codepoints above	2267	Enable direct support for displaying unicode codepoints above
2110	65535 (the basic multilingual page). This increases storage	2268	65535 (the basic multilingual page). This increases storage
2111	requirements per character from 2 to 4 bytes. X11 fonts do not yet	2269	requirements per character from 2 to 4 bytes. X11 fonts do not yet
2112	support these extra characters, but Xft does.	2270	support these extra characters, but Xft does.
…		…
2115	even without this flag, but the number of such characters is	2273	even without this flag, but the number of such characters is
2116	limited to a view thousand (shared with combining characters,	2274	limited to a view thousand (shared with combining characters,
2117	see next switch), and right now rxvt-unicode cannot display them	2275	see next switch), and right now rxvt-unicode cannot display them
2118	(input/output and cut&paste still work, though).	2276	(input/output and cut&paste still work, though).
2119		2277
2120	=item --enable-combining	2278	=item --enable-combining (default: on)
2121		2279
2122	Enable automatic composition of combining characters into	2280	Enable automatic composition of combining characters into
2123	composite characters. This is required for proper viewing of text	2281	composite characters. This is required for proper viewing of text
2124	where accents are encoded as seperate unicode characters. This is	2282	where accents are encoded as seperate unicode characters. This is
2125	done by using precomposited characters when available or creating	2283	done by using precomposited characters when available or creating
2126	new pseudo-characters when no precomposed form exists.	2284	new pseudo-characters when no precomposed form exists.
2127		2285
2128	Without --enable-unicode3, the number of additional precomposed	2286	Without --enable-unicode3, the number of additional precomposed
2129	characters is rather limited (2048, if this is full, rxvt will use the	2287	characters is somewhat limited (the 6400 private use characters will be
2130	private use area, extending the number of combinations to 8448). With	2288	(ab-)used). With --enable-unicode3, no practical limit exists.
2131	--enable-unicode3, no practical limit exists. This will also enable	2289
2132	storage of characters >65535.	2290	This option will also enable storage (but not display) of characters
		2291	beyond plane 0 (>65535) when --enable-unicode3 was not specified.
2133		2292
2134	The combining table also contains entries for arabic presentation forms,	2293	The combining table also contains entries for arabic presentation forms,
2135	but these are not currently used. Bug me if you want these to be used.	2294	but these are not currently used. Bug me if you want these to be used (and
		2295	tell me how these are to be used...).
2136		2296
2137	=item --enable-fallback(=CLASS)	2297	=item --enable-fallback(=CLASS) (default: Rxvt)
2138		2298
2139	When reading resource settings, also read settings for class CLASS	2299	When reading resource settings, also read settings for class CLASS. To
2140	(default: Rxvt). To disable resource fallback use --disable-fallback.	2300	disable resource fallback use --disable-fallback.
2141		2301
2142	=item --with-res-name=NAME	2302	=item --with-res-name=NAME (default: urxvt)
2143		2303
2144	Use the given name (default: urxvt) as default application name when	2304	Use the given name as default application name when
2145	reading resources. Specify --with-res-name=rxvt to replace rxvt.	2305	reading resources. Specify --with-res-name=rxvt to replace rxvt.
2146		2306
2147	=item --with-res-class=CLASS	2307	=item --with-res-class=CLASS /default: URxvt)
2148		2308
2149	Use the given class (default: URxvt) as default application class	2309	Use the given class as default application class
2150	when reading resources. Specify --with-res-class=Rxvt to replace	2310	when reading resources. Specify --with-res-class=Rxvt to replace
2151	rxvt.	2311	rxvt.
2152		2312
2153	=item --enable-utmp	2313	=item --enable-utmp (default: on)
2154		2314
2155	Write user and tty to utmp file (used by programs like F<w>) at	2315	Write user and tty to utmp file (used by programs like F<w>) at
2156	start of rxvt execution and delete information when rxvt exits.	2316	start of rxvt execution and delete information when rxvt exits.
2157		2317
2158	=item --enable-wtmp	2318	=item --enable-wtmp (default: on)
2159		2319
2160	Write user and tty to wtmp file (used by programs like F<last>) at	2320	Write user and tty to wtmp file (used by programs like F<last>) at
2161	start of rxvt execution and write logout when rxvt exits. This	2321	start of rxvt execution and write logout when rxvt exits. This
2162	option requires --enable-utmp to also be specified.	2322	option requires --enable-utmp to also be specified.
2163		2323
2164	=item --enable-lastlog	2324	=item --enable-lastlog (default: on)
2165		2325
2166	Write user and tty to lastlog file (used by programs like	2326	Write user and tty to lastlog file (used by programs like
2167	F<lastlogin>) at start of rxvt execution. This option requires	2327	F<lastlogin>) at start of rxvt execution. This option requires
2168	--enable-utmp to also be specified.	2328	--enable-utmp to also be specified.
2169		2329
2170	=item --enable-xpm-background	2330	=item --enable-xpm-background (default: on)
2171		2331
2172	Add support for XPM background pixmaps.	2332	Add support for XPM background pixmaps.
2173		2333
2174	=item --enable-transparency	2334	=item --enable-transparency (default: on)
2175		2335
2176	Add support for inheriting parent backgrounds thus giving a fake	2336	Add support for inheriting parent backgrounds thus giving a fake
2177	transparency to the term.	2337	transparency to the term.
2178		2338
2179	=item --enable-fading	2339	=item --enable-fading (default: on)
2180		2340
2181	Add support for fading the text when focus is lost.	2341	Add support for fading the text when focus is lost (requires C<--enable-transparency>).
2182		2342
2183	=item --enable-tinting	2343	=item --enable-tinting (default: on)
2184		2344
2185	Add support for tinting of transparent backgrounds.	2345	Add support for tinting of transparent backgrounds (requires C<--enable-transparency>).
2186		2346
2187	=item --enable-menubar
2188
2189	Add support for our menu bar system (this interacts badly with
2190	dynamic locale switching currently).
2191
2192	=item --enable-rxvt-scroll	2347	=item --enable-rxvt-scroll (default: on)
2193		2348
2194	Add support for the original rxvt scrollbar.	2349	Add support for the original rxvt scrollbar.
2195		2350
2196	=item --enable-next-scroll	2351	=item --enable-next-scroll (default: on)
2197		2352
2198	Add support for a NeXT-like scrollbar.	2353	Add support for a NeXT-like scrollbar.
2199		2354
2200	=item --enable-xterm-scroll	2355	=item --enable-xterm-scroll (default: on)
2201		2356
2202	Add support for an Xterm-like scrollbar.	2357	Add support for an Xterm-like scrollbar.
2203		2358
2204	=item --enable-plain-scroll	2359	=item --enable-plain-scroll (default: on)
2205		2360
2206	Add support for a very unobtrusive, plain-looking scrollbar that	2361	Add support for a very unobtrusive, plain-looking scrollbar that
2207	is the favourite of the rxvt-unicode author, having used it for	2362	is the favourite of the rxvt-unicode author, having used it for
2208	many years.	2363	many years.
2209		2364
2210	=item --enable-half-shadow	2365	=item --enable-ttygid (default: off)
2211
2212	Make shadows on the scrollbar only half the normal width & height.
2213	only applicable to rxvt scrollbars.
2214
2215	=item --enable-ttygid
2216		2366
2217	Change tty device setting to group "tty" - only use this if	2367	Change tty device setting to group "tty" - only use this if
2218	your system uses this type of security.	2368	your system uses this type of security.
2219		2369
2220	=item --disable-backspace-key	2370	=item --disable-backspace-key
2221		2371
2222	Disable any handling of the backspace key by us - let the X server	2372	Removes any handling of the backspace key by us - let the X server do it.
		2373
		2374	=item --disable-delete-key
		2375
		2376	Removes any handling of the delete key by us - let the X server
2223	do it.	2377	do it.
2224		2378
2225	=item --disable-delete-key
2226
2227	Disable any handling of the delete key by us - let the X server
2228	do it.
2229
2230	=item --disable-resources	2379	=item --disable-resources
2231		2380
2232	Remove all resources checking.	2381	Removes any support for resource checking.
2233
2234	=item --enable-xgetdefault
2235
2236	Make resources checking via XGetDefault() instead of our small
2237	version which only checks ~/.Xdefaults, or if that doesn't exist
2238	then ~/.Xresources.
2239
2240	=item --enable-strings
2241
2242	Add support for our possibly faster memset() function and other
2243	various routines, overriding your system's versions which may
2244	have been hand-crafted in assembly or may require extra libraries
2245	to link in. (this breaks ANSI-C rules and has problems on many
2246	GNU/Linux systems).
2247		2382
2248	=item --disable-swapscreen	2383	=item --disable-swapscreen
2249		2384
2250	Remove support for swap screen.	2385	Remove support for secondary/swap screen.
2251		2386
2252	=item --enable-frills	2387	=item --enable-frills (default: on)
2253		2388
2254	Add support for many small features that are not essential but nice to	2389	Add support for many small features that are not essential but nice to
2255	have. Normally you want this, but for very small binaries you may want to	2390	have. Normally you want this, but for very small binaries you may want to
2256	disable this.	2391	disable this.
2257		2392
2258	A non-exhaustive list of features enabled by C<--enable-frills> (possibly	2393	A non-exhaustive list of features enabled by C<--enable-frills> (possibly
2259	in combination with other switches) is:	2394	in combination with other switches) is:
2260		2395
2261	MWM-hints	2396	MWM-hints
		2397	EWMH-hints (pid, utf8 names) and protocols (ping)
2262	seperate underline colour	2398	seperate underline colour (-underlineColor)
2263	settable border widths and borderless switch	2399	settable border widths and borderless switch (-w, -b, -bl)
		2400	visual depth selection (-depth)
2264	settable extra linespacing	2401	settable extra linespacing /-lsp)
2265	extra window properties (e.g. UTF-8 window names and PID)
2266	iso-14755-2 and -3, and visual feedback	2402	iso-14755-2 and -3, and visual feedback
		2403	tripleclickwords (-tcw)
		2404	settable insecure mode (-insecure)
		2405	keysym remapping support
		2406	cursor blinking and underline cursor (-cb, -uc)
		2407	XEmbed support (-embed)
		2408	user-pty (-pty-fd)
		2409	hold on exit (-hold)
		2410	skip builtin block graphics (-sbg)
		2411	separate highlightcolor support (-hc)
		2412
		2413	It also enables some non-essential features otherwise disabled, such as:
		2414
		2415	some round-trip time optimisations
		2416	nearest color allocation on pseudocolor screens
		2417	UTF8_STRING supporr for selection
		2418	sgr modes 90..97 and 100..107
2267	backindex and forwardindex escape sequence	2419	backindex and forwardindex escape sequences
		2420	view change/zero scorllback esacpe sequences
		2421	locale switching escape sequence
2268	window op and locale change escape sequences	2422	window op and some xterm/OSC escape sequences
2269	tripleclickwords	2423	rectangular selections
2270	settable insecure mode	2424	trailing space removal for selections
		2425	verbose X error handling
2271		2426
2272	=item --enable-iso14755	2427	=item --enable-iso14755 (default: on)
2273		2428
2274	Enable extended ISO 14755 support (see @@RXVT_NAME@@(1), or	2429	Enable extended ISO 14755 support (see @@RXVT_NAME@@(1), or
2275	F<doc/rxvt.1.txt>). Basic support (section 5.1) is enabled by	2430	F<doc/rxvt.1.txt>). Basic support (section 5.1) is enabled by
2276	C<--enable-frills>, while support for 5.2, 5.3 and 5.4 is enabled with	2431	C<--enable-frills>, while support for 5.2, 5.3 and 5.4 is enabled with
2277	this switch.	2432	this switch.
2278		2433
2279	=item --enable-keepscrolling	2434	=item --enable-keepscrolling (default: on)
2280		2435
2281	Add support for continual scrolling of the display when you hold	2436	Add support for continual scrolling of the display when you hold
2282	the mouse button down on a scrollbar arrow.	2437	the mouse button down on a scrollbar arrow.
2283		2438
2284	=item --enable-mousewheel	2439	=item --enable-mousewheel (default: on)
2285		2440
2286	Add support for scrolling via mouse wheel or buttons 4 & 5.	2441	Add support for scrolling via mouse wheel or buttons 4 & 5.
2287		2442
2288	=item --enable-slipwheeling	2443	=item --enable-slipwheeling (default: on)
2289		2444
2290	Add support for continual scrolling (using the mouse wheel as an	2445	Add support for continual scrolling (using the mouse wheel as an
2291	accelerator) while the control key is held down. This option	2446	accelerator) while the control key is held down. This option
2292	requires --enable-mousewheel to also be specified.	2447	requires --enable-mousewheel to also be specified.
2293		2448
2294	=item --disable-new-selection	2449	=item --disable-new-selection
2295		2450
2296	Remove support for mouse selection style like that of xterm.	2451	Remove support for mouse selection style like that of xterm.
2297		2452
2298	=item --enable-dmalloc	2453	=item --enable-dmalloc (default: off)
2299		2454
2300	Use Gray Watson's malloc - which is good for debugging See	2455	Use Gray Watson's malloc - which is good for debugging See
2301	http://www.letters.com/dmalloc/ for details If you use either this or the	2456	L<http://www.letters.com/dmalloc/> for details If you use either this or the
2302	next option, you may need to edit src/Makefile after compiling to point	2457	next option, you may need to edit src/Makefile after compiling to point
2303	DINCLUDE and DLIB to the right places.	2458	DINCLUDE and DLIB to the right places.
2304		2459
2305	You can only use either this option and the following (should	2460	You can only use either this option and the following (should
2306	you use either) .	2461	you use either) .
2307		2462
2308	=item --enable-dlmalloc	2463	=item --enable-dlmalloc (default: off)
2309		2464
2310	Use Doug Lea's malloc - which is good for a production version	2465	Use Doug Lea's malloc - which is good for a production version
2311	See L<http://g.oswego.edu/dl/html/malloc.html> for details.	2466	See L<http://g.oswego.edu/dl/html/malloc.html> for details.
2312		2467
2313	=item --enable-smart-resize	2468	=item --enable-smart-resize (default: on)
2314		2469
2315	Add smart growth/shrink behaviour when changing font size via from hot	2470	Add smart growth/shrink behaviour when changing font size via hot
2316	keys. This should keep in a fixed position the rxvt corner which is	2471	keys. This should keep the window corner which is closest to a corner of
2317	closest to a corner of the screen.	2472	the screen in a fixed position.
2318		2473
2319	=item --enable-cursor-blink
2320
2321	Add support for a blinking cursor.
2322
2323	=item --enable-pointer-blank	2474	=item --enable-pointer-blank (default: on)
2324		2475
2325	Add support to have the pointer disappear when typing or inactive.	2476	Add support to have the pointer disappear when typing or inactive.
2326		2477
2327	=item --with-name=NAME	2478	=item --enable-perl (default: on)
2328		2479
		2480	Enable an embedded perl interpreter. See the B<@@RXVT_NAME@@perl(3)>
		2481	manpage (F<doc/rxvtperl.txt>) for more info on this feature, or the files
		2482	in F<src/perl-ext/> for the extensions that are installed by default. The
		2483	perl interpreter that is used can be specified via the C<PERL> environment
		2484	variable when running configure.
		2485
		2486	=item --with-name=NAME (default: urxvt)
		2487
2329	Set the basename for the installed binaries (default: C<urxvt>, resulting	2488	Set the basename for the installed binaries, resulting
2330	in C<urxvt>, C<urxvtd> etc.). Specify C<--with-name=rxvt> to replace with	2489	in C<urxvt>, C<urxvtd> etc.). Specify C<--with-name=rxvt> to replace with
2331	C<rxvt>.	2490	C<rxvt>.
2332		2491
2333	=item --with-term=NAME	2492	=item --with-term=NAME (default: rxvt-unicode)
2334		2493
2335	Change the environmental variable for the terminal to NAME (default	2494	Change the environmental variable for the terminal to NAME.
2336	C<rxvt-unicode>)
2337		2495
2338	=item --with-terminfo=PATH	2496	=item --with-terminfo=PATH
2339		2497
2340	Change the environmental variable for the path to the terminfo tree to	2498	Change the environmental variable for the path to the terminfo tree to
2341	PATH.	2499	PATH.

Diff Legend

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