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

Diff Legend

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