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

Diff Legend

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