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

Diff Legend

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