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

Diff Legend

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