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.27 by root, Mon Nov 8 22:16:51 2004 UTC vs.
Revision 1.120 by root, Mon Aug 7 15:59:44 2006 UTC

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

Diff Legend

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