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.113 by root, Thu Feb 2 18:04:45 2006 UTC

1	=head1 NAME	1	=head1 NAME
2		2
3	RXVT REFERENCE - FAQ, command sequences and other background information	3	RXVT REFERENCE - FAQ, command sequences and other background information
4		4
		5	=head1 SYNOPSIS
		6
		7	# set a new font set
		8	printf '\33]50;%s\007' 9x15,xft:Kochi" Mincho"
		9
		10	# change the locale and tell rxvt-unicode about it
		11	export LC_CTYPE=ja_JP.EUC-JP; printf "\33]701;$LC_CTYPE\007"
		12
		13	# set window title
		14	printf '\33]2;%s\007' "new window title"
		15
		16	=head1 DESCRIPTION
		17
		18	This document contains the FAQ, the RXVT TECHNICAL REFERENCE documenting
		19	all escape sequences, and other background information.
		20
		21	The newest version of this document is also available on the World Wide Web at
		22	L<http://cvs.schmorp.de/browse/*checkout*/rxvt-unicode/doc/rxvt.7.html>.
		23
5	=head1 FREQUENTLY ASKED QUESTIONS	24	=head1 RXVT-UNICODE/URXVT FREQUENTLY ASKED QUESTIONS
6		25
7	=over 4
8		26
		27	=head2 Meta, Features & Commandline Issues
		28
		29	=head3 My question isn't answered here, can I ask a human?
		30
		31	Before sending me mail, you could go to IRC: C<irc.freenode.net>,
		32	channel C<#rxvt-unicode> has some rxvt-unicode enthusiasts that might be
		33	interested in learning about new and exciting problems (but not FAQs :).
		34
		35	=head3 Does it support tabs, can I have a tabbed rxvt-unicode?
		36
		37	Beginning with version 7.3, there is a perl extension that implements a
		38	simple tabbed terminal. It is installed by default, so any of these should
		39	give you tabs:
		40
		41	@@URXVT_NAME@@ -pe tabbed
		42
		43	URxvt.perl-ext-common: default,tabbed
		44
		45	It will also work fine with tabbing functionality of many window managers
		46	or similar tabbing programs, and its embedding-features allow it to be
		47	embedded into other programs, as witnessed by F<doc/rxvt-tabbed> or
		48	the upcoming C<Gtk2::URxvt> perl module, which features a tabbed urxvt
		49	(murxvt) terminal as an example embedding application.
		50
9	=item How do I know which rxvt-unicode version I'm using?	51	=head3 How do I know which rxvt-unicode version I'm using?
10		52
11	The version number is displayed with the usage (-h). Also the escape	53	The version number is displayed with the usage (-h). Also the escape
12	sequence C<ESC[8n> sets the window title to the version number.	54	sequence C<ESC [ 8 n> sets the window title to the version number. When
		55	using the @@URXVT_NAME@@c client, the version displayed is that of the
		56	daemon.
13		57
14	=item When I log-in to another system it tells me about missing terminfo data?
15
16	The terminal description used by rxvt-unicode is not as widely available
17	as that for xterm, or even rxvt (for which the same problem often arises).
18
19	The correct solution for this problem is to install the terminfo, this can
20	be done like this (with ncurses' infocmp):
21
22	REMOTE=remotesystem.domain
23	infocmp rxvt-unicode | ssh $REMOTE "cat >/tmp/ti && tic /tmp/ti"
24
25	... or by installing rxvt-unicode normally on the remote system,
26
27	If you cannot or do not want to do this, then you can simply set
28	C<TERM=rxvt> or even C<TERM=xterm>, and live with the small number of
29	problems arising, which includes wrong keymapping, less and different
30	colours and some refresh errors in fullscreen applications. It's a nice
31	quick-and-dirty workaround for rare cases, though.
32
33	If you always want to do this you can either recompile rxvt-unicode with
34	the desired TERM value or use a resource to set it:
35
36	URxvt.termName: rxvt
37
38	If you don't plan to use B<rxvt> (quite common...) you could also replace
39	the rxvt terminfo file with the rxvt-unicode one.
40
41	=item I need a termcap file entry.
42
43	You could use rxvt's termcap entry with resonable results in many cases.
44	You can also create a termcap entry by using terminfo's infocmp program
45	like this:
46
47	infocmp -C rxvt-unicode
48
49	OR you could this termcap entry:
50
51	rxvt-unicode|rxvt-unicode terminal (X Window System):\
52	:am:bw:eo:km:mi:ms:xn:xo:\
53	:co#80:it#8:li#24:\
54	:AL=\E[%dL:DC=\E[%dP:DL=\E[%dM:DO=\E[%dB:IC=\E[%d@:\
55	:K1=\EOw:K2=\EOu:K3=\EOy:K4=\EOq:K5=\EOs:LE=\E[%dD:\
56	:RI=\E[%dC:SF=\E[%dS:SR=\E[%dT:UP=\E[%dA:ae=^O:al=\E[L:\
57	:as=^N:bl=^G:cd=\E[J:ce=\E[K:cl=\E[H\E[2J:cm=\E[%i%d;%dH:\
58	:cr=^M:cs=\E[%i%d;%dr:ct=\E[3g:dc=\E[P:dl=\E[M:do=^J:\
59	:ec=\E[%dX:ei=\E[4l:ho=\E[H:i1=\E[?47l\E=\E[?1l:ic=\E[@:\
60	:im=\E[4h:is=\E[r\E[m\E[2J\E[H\E[?7h\E[?1;3;4;6l\E[4l:\
61	:k0=\E[21~:k1=\E[11~:k2=\E[12~:k3=\E[13~:k4=\E[14~:\
62	:k5=\E[15~:k6=\E[17~:k7=\E[18~:k8=\E[19~:k9=\E[20~:\
63	:kD=\E[3~:kI=\E[2~:kN=\E[6~:kP=\E[5~:kb=\177:kd=\EOB:\
64	:ke=\E[?1l\E>:kh=\E[7~:kl=\EOD:kr=\EOC:ks=\E[?1h\E=:\
65	:ku=\EOA:le=^H:mb=\E[5m:md=\E[1m:me=\E[m\017:mr=\E[7m:\
66	:nd=\E[C:rc=\E8:sc=\E7:se=\E[27m:sf=^J:so=\E[7m:sr=\EM:\
67	:st=\EH:ta=^I:te=\E[r\E[?1049l:ti=\E[?1049h:ue=\E[24m:\
68	:up=\E[A:us=\E[4m:vb=\E[?5h\E[?5l:ve=\E[?25h:vi=\E[?25l:\
69	:vs=\E[?25h:
70
71	=item How can I configure rxvt-unicode so that it looks similar to the original rxvt?
72
73	Felix von Leitner says that these two lines, in your F<.Xdefaults>, will make rxvt-unicode
74	behave similar to the original rxvt:
75
76	URxvt.font: -misc-fixed-medium-r-semicondensed--13-120-75-75-c-60-iso8859-1
77	URxvt.boldFont: -misc-fixed-bold-r-semicondensed--13-120-75-75-c-60-iso8859-1
78
79	=item Rxvt-unicode does not seem to understand the selected encoding?
80
81	=item Unicode does not seem to work?
82
83	If you encounter strange problems like typing an accented character but
84	getting two unrelated other characters or similar, or if program output is
85	subtly garbled, then you should check your locale settings.
86
87	Rxvt-unicode must be started with the same C<LC_CTYPE> setting as the
88	programs. Often rxvt-unicode is started in the C<C> locale, while the
89	login script running within the rxvt-unicode window changes the locale to
90	sth. else, e.h. C<en_GB.UTF-8>. Needless to say, this is not going to work.
91
92	The best thing is to fix your startup environment, as you will likely run
93	into other problems. If nothing works you can try this in your .profile.
94
95	printf '\e]701;%s\007' "$LC_CTYPE"
96
97	If this doesn't work, then maybe you use a C<LC_CTYPE> specification not
98	supported on your systems. Some systems have a C<locale> command which
99	displays this. If it displays sth. like:
100
101	locale: Cannot set LC_CTYPE to default locale: ...
102
103	Then the locale you specified is not supported on your system.
104
105	If nothing works and you are sure that everything is set correctly then
106	you will need to remember a little known fact: Some programs just don't
107	support locales :(
108
109	=item Why do some characters look so much different than others?
110
111	=item How does rxvt-unicode choose fonts?
112
113	Most fonts do not contain the full range of Unicode, which is
114	fine. Chances are that the font you (or the admin/package maintainer of
115	your system/os) have specified does not cover all the characters you want
116	to display.
117
118	B<rxvt-unicode> makes a best-effort try at finding a replacement
119	font. Often the result is fine, but sometimes the chosen font looks
120	bad. Many fonts have totally strange characters that don't resemble the
121	correct glyph at all, and rxvt-unicode lacks the artificial intelligence
122	to detect that a specific glyph is wrong: it has to believe the font that
123	the characters it contains indeed look correct.
124
125	In that case, select a font of your taste and add it to the font list,
126	e.g.:
127
128	@@RXVT_NAME@@ -fn basefont,font2,font3...
129
130	When rxvt-unicode sees a character, it will first look at the base
131	font. If the base font does not contain the character, it will go to the
132	next font, and so on. Specifying your own fonts will also speed up this
133	search and use less resources within rxvt-unicode and the X-server.
134
135	The only limitation is that all the fonts must not be larger than the base
136	font, as the base font defines the principal cell size, which must be the
137	same due to the way terminals work.
138
139	=item Why do some chinese characters look so different than others?
140
141	This is because there is a difference between script and language --
142	rxvt-unicode does not know which language the text that is output
143	is, as it only knows the unicode character codes. If rxvt-unicode
144	first sees a japanese character, it might choose a japanese font for
145	it. Subsequent japanese characters will take that font. Now, many chinese
146	characters aren't represented in japanese fonts, so when the first
147	non-japanese character comes up, rxvt-unicode will look for a chinese font
148	-- unfortunately at this point, it will still use the japanese font for
149	japanese characters that are also chinese.
150
151	The workaround is easy: just tag a chinese font at the end of your font
152	list (see the previous question). The key is to view the font list as
153	a preference list: If you expect more japanese, list a japanese font
154	first. If you expect more chinese, put a chinese font first.
155
156	In the future it might be possible to switch preferences at runtime (the
157	internal data structure has no problem with using different fonts for
158	the same character at the same time, but no interface for this has been
159	designed yet).
160
161	=item Why does rxvt-unicode sometimes leave pixel droppings?
162
163	Most fonts were not designed for terminal use, which means that character
164	size varies a lot. A font that is otherwise fine for terminal use might
165	contain some characters that are simply too wide. Rxvt-unicode will avoid
166	these characters. For characters that are just "a bit" too wide a special
167	"careful" rendering mode is used that redraws adjacent characters.
168
169	All of this requires that fonts do not lie about character sizes,
170	however: Xft fonts often draw glyphs larger than their acclaimed bounding
171	box, and rxvt-unicode has no way of detecting this (the correct way is to
172	ask for the character bounding box, which unfortunately is wrong in these
173	cases).
174
175	It's not clear (to me at least), wether this is a bug in Xft, freetype, or
176	the respective font. If you encounter this problem there is no way to work
177	around this except by using a different font.
178
179	All of this is not a problem when using X11 core fonts, as their bounding
180	box data is correct.
181
182	=item My Compose (Multi_key) key is no longer working.
183
184	The most common causes for this are that either your locale is not set
185	correctly, or you specified a B<preeditStyle> that is not supported by
186	your input method. For example, if you specified B<OverTheSpot> and
187	your input method (e.g. the default input method handling Compose keys)
188	does not support this (for instance because it is not visual), then
189	rxvt-unicode will continue without an input method.
190
191	In this case either do not specify a B<preeditStyle> or specify more than
192	one pre-edit style, such as B<OverTheSpot,Root,None>.
193
194	=item How can I keep rxvt-unicode from using reverse video so much?
195
196	First of all, make sure you are running with the right terminfo
197	(C<urxvt>), which will get rid of most of these effects. Then make sure
198	you have specified colours for italic and bold, as otherwise rxvt-unicode
199	might use reverse video to simulate the effect:
200
201	URxvt*colorBD: white
202	URxvt*colorIT: green
203
204	=item Some programs assume totally weird colours (red instead of blue), how can I fix that?
205
206	For some unexplainable reason, some programs (i.e. irssi) assume a very
207	weird colour palette when confronted with a terminal with more than the
208	standard 8 colours (rxvt-unicode supports 88). The right fix is, of
209	course, to fix these programs not to assume non-ISO colours without very
210	good reasons.
211
212	In the meantime, you can either edit your C<urxvt> terminfo definition to
213	only claim 8 colour support or use C<TERM=rxvt>, which will fix colours
214	but keep you from using other rxvt-unicode features.
215
216	=item I am on FreeBSD and rxvt-unicode does not seem to work at all.
217
218	Rxvt-unicode requires the symbol C<__STDC_ISO_10646__> to be defined
219	in your compile environment, or an implementation that implements it,
220	wether it defines the symbol or not. C<__STDC_ISO_10646__> requires that
221	B<wchar_t> is represented as unicode.
222
223	As you might have guessed, FreeBSD does neither define this symobl nor
224	does it support it. Instead, it uses it's own internal representation of
225	B<wchar_t>. This is, of course, completely legal.
226
227	However, C<__STDC_ISO_10646__> is the only sane way to support
228	multi-language apps in an OS, as using a locale-dependent (and
229	non-standardized) representation of B<wchar_t> makes it impossible to
230	convert between B<wchar_t> (as used by X11 and your applications) and any
231	other encoding without implementing OS-specific-wrappers for each and
232	every locale. There simply are no APIs to convert B<wchar_t> into anything
233	except the current locale encoding.
234
235	Some applications (such as the formidable B<mlterm>) work around this
236	by carrying their own replacement functions for character set handling
237	with them, and either implementing OS-dependent hacks or doing multiple
238	conversions (which is slow and unreliable in case the OS implements
239	encodings slightly different than the terminal emulator).
240
241	The rxvt-unicode author insists that the right way to fix this is in the
242	system libraries once and for all, instead of forcing every app to carry
243	complete replacements.
244
245	=item How does rxvt-unicode determine the encoding to use?
246
247	=item Is there an option to switch encodings?
248
249	Unlike some other terminals, rxvt-unicode has no encoding switch, and no
250	specific "utf-8" mode, such as xterm. In fact, it doesn't even know about
251	UTF-8 or any other encodings with respect to terminal I/O.
252
253	The reasons is that there exists a perfectly fine mechanism for selecting
254	the encoding, doing I/O and (most important) communicating this to all
255	applications so everybody agrees on character properties such as width and
256	code number. This mechanism is the I<locale>.
257
258	Rxvt-unicode uses the C<LC_CTYPE> locale category to select encoding. All
259	programs doing the same (that is, most) will automatically agree in the
260	interpretation of characters.
261
262	Unfortunately, there is no system-independent way to select locales, nor
263	is there a standard on how locale specifiers will look like.
264
265	On most systems, the content of the C<LC_CTYPE> environment variable
266	contains an arbitrary string which corresponds to an already-installed
267	locale. Common names for locales are C<en_US.UTF-8>, C<de_DE.ISO-8859-15>,
268	C<ja_JP.EUC-JP>, i.e. C<language_country.encoding>, but other forms
269	(i.e. C<de> or C<german>) are also common.
270
271	Rxvt-unicode ignores all other locale categories, and except for
272	the encoding, ignores country or language-specific settings,
273	i.e. C<de_DE.UTF-8> and C<ja_JP.UTF-8> are the same for rxvt-unicode.
274
275	If you want to use a specific encoding you have to make sure you start
276	rxvt-unicode with the correct C<LC_CTYPE> category.
277
278	=item Can I switch locales at runtime?
279
280	Yes, using an escape sequence. Try sth. like this, which sets
281	rxvt-unicode's idea of C<LC_CTYPE>.
282
283	printf '\e]701;%s\007' ja_JP.SJIS
284
285	See also the previous question.
286
287	Sometimes this capability is rather handy when you want to work in one
288	locale (e.g. C<de_DE.UTF-8>) but some programs don't support UTF-8. For
289	example, I use this script to start C<xjdic>, which first switches to a
290	locale supported by xjdic and back later:
291
292	printf '\e]701;%s\007' ja_JP.SJIS
293	xjdic -js
294	printf '\e]701;%s\007' de_DE.UTF-8
295
296	=item Can I switch the fonts at runtime?
297
298	Yes, using an escape sequence. Try sth. like this, which has the same
299	effect as using the C<-fn> switch, and takes effect immediately:
300
301	printf '\e]50;%s\007' "9x15bold,xft:Kochi Gothic"
302
303	This is useful if you e.g. work primarily with japanese (and prefer a
304	japanese font), but you have to switch to chinese temporarily, where
305	japanese fonts would only be in your way.
306
307	You can think of this as a kind of manual ISO-2022 switching.
308
309	=item Why do italic characters look as if clipped?
310
311	Many fonts have difficulties with italic characters and hinting. For
312	example, the otherwise very nicely hinted font C<xft:Bitstream Vera Sans
313	Mono> completely fails in it's italic face. A workaround is to enable
314	freetype autohinting, i.e. like this:
315
316	URxvt*italicFont: xft:Bitstream Vera Sans Mono:italic:autohint=true
317	URxvt*boldItalicFont: xft:Bitstream Vera Sans Mono:bold:italic:autohint=true
318
319	=item My input method wants <some encoding> but I want UTF-8, what can I do?
320
321	You can specify separate locales for the input method and the rest of the
322	terminal, using the resource C<imlocale>:
323
324	URxvt*imlocale: ja_JP.EUC-JP
325
326	Now you can start your terminal with C<LC_CTYPE=ja_JP.UTF-8> and still
327	use your input method. Please note, however, that you will not be able to
328	input characters outside C<EUC-JP> in a normal way then, as your input
329	method limits you.
330
331	=item Rxvt-unicode uses gobs of memory, how can I reduce that?	58	=head3 Rxvt-unicode uses gobs of memory, how can I reduce that?
332		59
333	Rxvt-unicode tries to obey the rule of not charging you for sth. you	60	Rxvt-unicode tries to obey the rule of not charging you for something you
334	don't use. One thing you should try is to configure out all settings that	61	don't use. One thing you should try is to configure out all settings that
335	you don't need, for example, Xft support is a resource hog by design,	62	you don't need, for example, Xft support is a resource hog by design,
336	when used. Compiling it out ensures that no Xft font will be loaded	63	when used. Compiling it out ensures that no Xft font will be loaded
337	accidentally when rxvt-unicode tries to find a font for your characters.	64	accidentally when rxvt-unicode tries to find a font for your characters.
338		65
…		…
341	6 bytes per screen cell. For a 160x?? window this amounts to almost a	68	6 bytes per screen cell. For a 160x?? window this amounts to almost a
342	kilobyte per line. A scrollback buffer of 10000 lines will then (if full)	69	kilobyte per line. A scrollback buffer of 10000 lines will then (if full)
343	use 10 Megabytes of memory. With C<--enable-unicode3> it gets worse, as	70	use 10 Megabytes of memory. With C<--enable-unicode3> it gets worse, as
344	rxvt-unicode then uses 8 bytes per screen cell.	71	rxvt-unicode then uses 8 bytes per screen cell.
345		72
346	=item Can I speed up Xft rendering somehow?	73	=head3 How can I start @@URXVT_NAME@@d in a race-free way?
347		74
348	Yes, the most obvious way to speed it up is to avoid Xft entirely, as	75	Try C<@@URXVT_NAME@@d -f -o>, which tells @@URXVT_NAME@@d to open the
349	it is simply slow. If you still want Xft fonts you might try to disable	76	display, create the listening socket and then fork.
350	antialiasing (by appending C<:antialiasing=false>), which saves lots of
351	memory and also speeds up rendering considerably.
352		77
353	=item Rxvt-unicode doesn't seem to anti-alias its fonts, what is wrong?	78	=head3 How can I start @@URXVT_NAME@@d automatically when I run URXVT_NAME@@c?
354		79
355	Rxvt-unicode will use whatever you specify as a font. If it needs to	80	If you want to start @@URXVT_NAME@@d automatically whenever you run
356	fall back to it's default font search list it will prefer X11 core	81	@@URXVT_NAME@@c and the daemon isn't running yet, use this script:
357	fonts, because they are small and fast, and then use Xft fonts. It has
358	antialiasing disabled for most of them, because the author thinks they
359	look best that way.
360		82
361	If you want antialiasing, you have to specify the fonts manually.	83	#!/bin/sh
362
363	=item Mouse cut/paste suddenly no longer works.
364
365	Make sure that mouse reporting is actually turned off since killing
366	some editors prematurely may leave the mouse in mouse report mode. I've
367	heard that tcsh may use mouse reporting unless it otherwise specified. A
368	quick check is to see if cut/paste works when the Alt or Shift keys are
369	depressed. See @@RXVT_NAME@@(7)
370
371	=item What's with this bold/blink stuff?
372
373	If no bold colour is set via C<colorBD:>, bold will invert text using the
374	standard foreground colour.
375
376	For the standard background colour, blinking will actually make the
377	text blink when compiled with C<--enable-blinking>. with standard
378	colours. Without C<--enable-blinking>, the blink attribute will be
379	ignored.
380
381	On ANSI colours, bold/blink attributes are used to set high-intensity
382	foreground/background colors.
383
384	color0-7 are the low-intensity colors.
385
386	color8-15 are the corresponding high-intensity colors.
387
388	=item I don't like the screen colors. How do I change them?
389
390	You can change the screen colors at run-time using F<~/.Xdefaults>
391	resources (or as long-options).
392
393	Here are values that are supposed to resemble a VGA screen,
394	including the murky brown that passes for low-intensity yellow:
395
396	Rxvt*color0: #000000
397	Rxvt*color1: #A80000
398	Rxvt*color2: #00A800
399	Rxvt*color3: #A8A800
400	Rxvt*color4: #0000A8
401	Rxvt*color5: #A800A8
402	Rxvt*color6: #00A8A8
403	Rxvt*color7: #A8A8A8
404
405	Rxvt*color8: #000054
406	Rxvt*color9: #FF0054
407	Rxvt*color10: #00FF54
408	Rxvt*color11: #FFFF54
409	Rxvt*color12: #0000FF
410	Rxvt*color13: #FF00FF
411	Rxvt*color14: #00FFFF
412	Rxvt*color15: #FFFFFF
413
414	=item What's with the strange Backspace/Delete key behaviour?
415
416	Assuming that the physical Backspace key corresponds to the
417	BackSpace keysym (not likely for Linux ... see the following
418	question) there are two standard values that can be used for
419	Backspace: C<^H> and C<^?>.
420
421	Historically, either value is correct, but rxvt-unicode adopts the debian
422	policy of using C<^?> when unsure, because it's the one only only correct
423	choice :).
424
425	Rxvt-unicode tries to inherit the current stty settings and uses the value
426	of `erase' to guess the value for backspace. If rxvt-unicode wasn't
427	started from a terminal (say, from a menu or by remote shell), then the
428	system value of `erase', which corresponds to CERASE in <termios.h>, will
429	be used (which may not be the same as your stty setting).
430
431	For starting a new rxvt-unicode:
432
433	# use Backspace = ^H
434	$ stty erase ^H
435	$ @@RXVT_NAME@@	84	@@URXVT_NAME@@c "$@"
436		85	if [ $? -eq 2 ]; then
437	# use Backspace = ^?	86	@@URXVT_NAME@@d -q -o -f
438	$ stty erase ^?
439	$ @@RXVT_NAME@@	87	@@URXVT_NAME@@c "$@"
		88	fi
440		89
441	Toggle with "ESC[36h" / "ESC[36l" as documented in @@RXVT_NAME@@(7).	90	This tries to create a new terminal, and if fails with exit status 2,
		91	meaning it couldn't connect to the daemon, it will start the daemon and
		92	re-run the command. Subsequent invocations of the script will re-use the
		93	existing daemon.
442		94
443	For an existing rxvt-unicode:	95	=head3 How do I distinguish wether I'm running rxvt-unicode or a regular xterm? I need this to decide about setting colors etc.
444		96
445	# use Backspace = ^H
446	$ stty erase ^H
447	$ echo -n "^[[36h"
448
449	# use Backspace = ^?
450	$ stty erase ^?
451	$ echo -n "^[[36l"
452
453	This helps satisfy some of the Backspace discrepancies that occur, but
454	if you use Backspace = C<^H>, make sure that the termcap/terminfo value
455	properly reflects that.
456
457	The Delete key is a another casualty of the ill-defined Backspace problem.
458	To avoid confusion between the Backspace and Delete keys, the Delete
459	key has been assigned an escape sequence to match the vt100 for Execute
460	(ESC[3~) and is in the supplied termcap/terminfo.
461
462	Some other Backspace problems:
463
464	some editors use termcap/terminfo,
465	some editors (vim I'm told) expect Backspace = ^H,
466	GNU Emacs (and Emacs-like editors) use ^H for help.
467
468	Perhaps someday this will all be resolved in a consistent manner.
469
470	=item I don't like the key-bindings. How do I change them?
471
472	There are some compile-time selections available via configure. Unless
473	you have run "configure" with the C<--disable-resources> option you can
474	use the `keysym' resource to alter the keystrings associated with keysym
475	0xFF00 - 0xFFFF (function, cursor keys, etc).
476
477	Here's an example for a tn3270 session started using `@@RXVT_NAME@@ -name tn3270'
478
479	!# ----- special uses ------:
480	! tn3270 login, remap function and arrow keys.
481	tn3270*font: *clean-bold-*-*--15-*
482
483	! keysym - used by rxvt only
484	! Delete - ^D
485	tn3270*keysym.0xFFFF: \004
486
487	! Home - ^A
488	tn3270*keysym.0xFF50: \001
489	! Left - ^B
490	tn3270*keysym.0xFF51: \002
491	! Up - ^P
492	tn3270*keysym.0xFF52: \020
493	! Right - ^F
494	tn3270*keysym.0xFF53: \006
495	! Down - ^N
496	tn3270*keysym.0xFF54: \016
497	! End - ^E
498	tn3270*keysym.0xFF57: \005
499
500	! F1 - F12
501	tn3270*keysym.0xFFBE: \e1
502	tn3270*keysym.0xFFBF: \e2
503	tn3270*keysym.0xFFC0: \e3
504	tn3270*keysym.0xFFC1: \e4
505	tn3270*keysym.0xFFC2: \e5
506	tn3270*keysym.0xFFC3: \e6
507	tn3270*keysym.0xFFC4: \e7
508	tn3270*keysym.0xFFC5: \e8
509	tn3270*keysym.0xFFC6: \e9
510	tn3270*keysym.0xFFC7: \e0
511	tn3270*keysym.0xFFC8: \e-
512	tn3270*keysym.0xFFC9: \e=
513
514	! map Prior/Next to F7/F8
515	tn3270*keysym.0xFF55: \e7
516	tn3270*keysym.0xFF56: \e8
517
518	=item I'm using keyboard model XXX that has extra Prior/Next/Insert keys.
519	How do I make use of them? For example, the Sun Keyboard type 4
520	has the following mappings that rxvt-unicode doesn't recognize.
521
522	KP_Insert == Insert
523	F22 == Print
524	F27 == Home
525	F29 == Prior
526	F33 == End
527	F35 == Next
528
529	Rather than have rxvt-unicode try to accommodate all the various possible keyboard
530	mappings, it is better to use `xmodmap' to remap the keys as required for
531	your particular machine.
532
533	=item How do I distinguish if I'm running rxvt-unicode or a regular xterm?
534	I need this to decide about setting colors etc.
535
536	rxvt and rxvt-unicode always export the variable "COLORTERM", so you can	97	The original rxvt and rxvt-unicode always export the variable "COLORTERM",
537	check and see if that is set. Note that several programs, JED, slrn,	98	so you can check and see if that is set. Note that several programs, JED,
538	Midnight Commander automatically check this variable to decide whether or	99	slrn, Midnight Commander automatically check this variable to decide
539	not to use color.	100	whether or not to use color.
540		101
541	=item How do I set the correct, full IP address for the DISPLAY variable?	102	=head3 How do I set the correct, full IP address for the DISPLAY variable?
542		103
543	If you've compiled rxvt-unicode with DISPLAY_IS_IP and have enabled	104	If you've compiled rxvt-unicode with DISPLAY_IS_IP and have enabled
544	insecure mode then it is possible to use the following shell script	105	insecure mode then it is possible to use the following shell script
545	snippets to correctly set the display. If your version of rxvt-unicode	106	snippets to correctly set the display. If your version of rxvt-unicode
546	wasn't also compiled with ESCZ_ANSWER (as assumed in these snippets) then	107	wasn't also compiled with ESCZ_ANSWER (as assumed in these snippets) then
…		…
556	stty -icanon -echo min 0 time 15 # see if enhanced rxvt or not	117	stty -icanon -echo min 0 time 15 # see if enhanced rxvt or not
557	echo -n '^[Z'	118	echo -n '^[Z'
558	read term_id	119	read term_id
559	stty icanon echo	120	stty icanon echo
560	if [ ""${term_id} = '^[[?1;2C' -a ${DISPLAY:-foo} = foo ]; then	121	if [ ""${term_id} = '^[[?1;2C' -a ${DISPLAY:-foo} = foo ]; then
561	echo -n '^[[7n' # query the rxvt we are in for the DISPLAY string	122	echo -n '^[[7n' # query the rxvt we are in for the DISPLAY string
562	read DISPLAY # set it in our local shell	123	read DISPLAY # set it in our local shell
563	fi	124	fi
564	fi	125	fi
565		126
566	=item How do I compile the manual pages for myself?	127	=head3 How do I compile the manual pages on my own?
567		128
568	You need to have a recent version of perl installed as F</usr/bin/perl>,	129	You need to have a recent version of perl installed as F</usr/bin/perl>,
569	one that comes with F<pod2man>, F<pod2text> and F<pod2html>. Then go to	130	one that comes with F<pod2man>, F<pod2text> and F<pod2html>. Then go to
570	the doc subdirectory and enter C<make alldoc>.	131	the doc subdirectory and enter C<make alldoc>.
571		132
		133	=head3 Isn't rxvt-unicode supposed to be small? Don't all those features bloat?
		134
		135	I often get asked about this, and I think, no, they didn't cause extra
		136	bloat. If you compare a minimal rxvt and a minimal urxvt, you can see
		137	that the urxvt binary is larger (due to some encoding tables always being
		138	compiled in), but it actually uses less memory (RSS) after startup. Even
		139	with C<--disable-everything>, this comparison is a bit unfair, as many
		140	features unique to urxvt (locale, encoding conversion, iso14755 etc.) are
		141	already in use in this mode.
		142
		143	text data bss drs rss filename
		144	98398 1664 24 15695 1824 rxvt --disable-everything
		145	188985 9048 66616 18222 1788 urxvt --disable-everything
		146
		147	When you C<--enable-everything> (which I<is> unfair, as this involves xft
		148	and full locale/XIM support which are quite bloaty inside libX11 and my
		149	libc), the two diverge, but not unreasnobaly so.
		150
		151	text data bss drs rss filename
		152	163431 2152 24 20123 2060 rxvt --enable-everything
		153	1035683 49680 66648 29096 3680 urxvt --enable-everything
		154
		155	The very large size of the text section is explained by the east-asian
		156	encoding tables, which, if unused, take up disk space but nothing else
		157	and can be compiled out unless you rely on X11 core fonts that use those
		158	encodings. The BSS size comes from the 64k emergency buffer that my c++
		159	compiler allocates (but of course doesn't use unless you are out of
		160	memory). Also, using an xft font instead of a core font immediately adds a
		161	few megabytes of RSS. Xft indeed is responsible for a lot of RSS even when
		162	not used.
		163
		164	Of course, due to every character using two or four bytes instead of one,
		165	a large scrollback buffer will ultimately make rxvt-unicode use more
		166	memory.
		167
		168	Compared to e.g. Eterm (5112k), aterm (3132k) and xterm (4680k), this
		169	still fares rather well. And compared to some monsters like gnome-terminal
		170	(21152k + extra 4204k in separate processes) or konsole (22200k + extra
		171	43180k in daemons that stay around after exit, plus half a minute of
		172	startup time, including the hundreds of warnings it spits out), it fares
		173	extremely well *g*.
		174
		175	=head3 Why C++, isn't that unportable/bloated/uncool?
		176
		177	Is this a question? :) It comes up very often. The simple answer is: I had
		178	to write it, and C++ allowed me to write and maintain it in a fraction
		179	of the time and effort (which is a scarce resource for me). Put even
		180	shorter: It simply wouldn't exist without C++.
		181
		182	My personal stance on this is that C++ is less portable than C, but in
		183	the case of rxvt-unicode this hardly matters, as its portability limits
		184	are defined by things like X11, pseudo terminals, locale support and unix
		185	domain sockets, which are all less portable than C++ itself.
		186
		187	Regarding the bloat, see the above question: It's easy to write programs
		188	in C that use gobs of memory, an certainly possible to write programs in
		189	C++ that don't. C++ also often comes with large libraries, but this is
		190	not necessarily the case with GCC. Here is what rxvt links against on my
		191	system with a minimal config:
		192
		193	libX11.so.6 => /usr/X11R6/lib/libX11.so.6 (0x00002aaaaabc3000)
		194	libc.so.6 => /lib/libc.so.6 (0x00002aaaaadde000)
		195	libdl.so.2 => /lib/libdl.so.2 (0x00002aaaab01d000)
		196	/lib64/ld-linux-x86-64.so.2 (0x00002aaaaaaab000)
		197
		198	And here is rxvt-unicode:
		199
		200	libX11.so.6 => /usr/X11R6/lib/libX11.so.6 (0x00002aaaaabc3000)
		201	libgcc_s.so.1 => /lib/libgcc_s.so.1 (0x00002aaaaada2000)
		202	libc.so.6 => /lib/libc.so.6 (0x00002aaaaaeb0000)
		203	libdl.so.2 => /lib/libdl.so.2 (0x00002aaaab0ee000)
		204	/lib64/ld-linux-x86-64.so.2 (0x00002aaaaaaab000)
		205
		206	No large bloated libraries (of course, none were linked in statically),
		207	except maybe libX11 :)
		208
		209
		210	=head2 Rendering, Font & Look and Feel Issues
		211
		212	=head3 I can't get transparency working, what am I doing wrong?
		213
		214	First of all, transparency isn't officially supported in rxvt-unicode, so
		215	you are mostly on your own. Do not bug the author about it (but you may
		216	bug everybody else). Also, if you can't get it working consider it a rite
		217	of passage: ... and you failed.
		218
		219	Here are four ways to get transparency. B<Do> read the manpage and option
		220	descriptions for the programs mentioned and rxvt-unicode. Really, do it!
		221
		222	1. Use inheritPixmap:
		223
		224	Esetroot wallpaper.jpg
		225	@@URXVT_NAME@@ -ip -tint red -sh 40
		226
		227	That works. If you think it doesn't, you lack transparency and tinting
		228	support, or you are unable to read.
		229
		230	2. Use a simple pixmap and emulate pseudo-transparency. This enables you
		231	to use effects other than tinting and shading: Just shade/tint/whatever
		232	your picture with gimp or any other tool:
		233
		234	convert wallpaper.jpg -blur 20x20 -modulate 30 background.xpm
		235	@@URXVT_NAME@@ -pixmap background.xpm -pe automove-background
		236
		237	That works. If you think it doesn't, you lack XPM and Perl support, or you
		238	are unable to read.
		239
		240	3. Use an ARGB visual:
		241
		242	@@URXVT_NAME@@ -depth 32 -fg grey90 -bg rgba:0000/0000/4444/cccc
		243
		244	This requires XFT support, and the support of your X-server. If that
		245	doesn't work for you, blame Xorg and Keith Packard. ARGB visuals aren't
		246	there yet, no matter what they claim. Rxvt-Unicode contains the neccessary
		247	bugfixes and workarounds for Xft and Xlib to make it work, but that
		248	doesn't mean that your WM has the required kludges in place.
		249
		250	4. Use xcompmgr and let it do the job:
		251
		252	xprop -frame -f _NET_WM_WINDOW_OPACITY 32c \
		253	-set _NET_WM_WINDOW_OPACITY 0xc0000000
		254
		255	Then click on a window you want to make transparent. Replace C<0xc0000000>
		256	by other values to change the degree of opacity. If it doesn't work and
		257	your server crashes, you got to keep the pieces.
		258
		259	=head3 Why does rxvt-unicode sometimes leave pixel droppings?
		260
		261	Most fonts were not designed for terminal use, which means that character
		262	size varies a lot. A font that is otherwise fine for terminal use might
		263	contain some characters that are simply too wide. Rxvt-unicode will avoid
		264	these characters. For characters that are just "a bit" too wide a special
		265	"careful" rendering mode is used that redraws adjacent characters.
		266
		267	All of this requires that fonts do not lie about character sizes,
		268	however: Xft fonts often draw glyphs larger than their acclaimed bounding
		269	box, and rxvt-unicode has no way of detecting this (the correct way is to
		270	ask for the character bounding box, which unfortunately is wrong in these
		271	cases).
		272
		273	It's not clear (to me at least), wether this is a bug in Xft, freetype,
		274	or the respective font. If you encounter this problem you might try using
		275	the C<-lsp> option to give the font more height. If that doesn't work, you
		276	might be forced to use a different font.
		277
		278	All of this is not a problem when using X11 core fonts, as their bounding
		279	box data is correct.
		280
		281	=head3 How can I keep rxvt-unicode from using reverse video so much?
		282
		283	First of all, make sure you are running with the right terminal settings
		284	(C<TERM=rxvt-unicode>), which will get rid of most of these effects. Then
		285	make sure you have specified colours for italic and bold, as otherwise
		286	rxvt-unicode might use reverse video to simulate the effect:
		287
		288	URxvt.colorBD: white
		289	URxvt.colorIT: green
		290
		291	=head3 Some programs assume totally weird colours (red instead of blue), how can I fix that?
		292
		293	For some unexplainable reason, some rare programs assume a very weird
		294	colour palette when confronted with a terminal with more than the standard
		295	8 colours (rxvt-unicode supports 88). The right fix is, of course, to fix
		296	these programs not to assume non-ISO colours without very good reasons.
		297
		298	In the meantime, you can either edit your C<rxvt-unicode> terminfo
		299	definition to only claim 8 colour support or use C<TERM=rxvt>, which will
		300	fix colours but keep you from using other rxvt-unicode features.
		301
		302	=head3 Can I switch the fonts at runtime?
		303
		304	Yes, using an escape sequence. Try something like this, which has the same
		305	effect as using the C<-fn> switch, and takes effect immediately:
		306
		307	printf '\e]50;%s\007' "9x15bold,xft:Kochi Gothic"
		308
		309	This is useful if you e.g. work primarily with japanese (and prefer a
		310	japanese font), but you have to switch to chinese temporarily, where
		311	japanese fonts would only be in your way.
		312
		313	You can think of this as a kind of manual ISO-2022 switching.
		314
		315	=head3 Why do italic characters look as if clipped?
		316
		317	Many fonts have difficulties with italic characters and hinting. For
		318	example, the otherwise very nicely hinted font C<xft:Bitstream Vera Sans
		319	Mono> completely fails in it's italic face. A workaround might be to
		320	enable freetype autohinting, i.e. like this:
		321
		322	URxvt.italicFont: xft:Bitstream Vera Sans Mono:italic:autohint=true
		323	URxvt.boldItalicFont: xft:Bitstream Vera Sans Mono:bold:italic:autohint=true
		324
		325	=head3 Can I speed up Xft rendering somehow?
		326
		327	Yes, the most obvious way to speed it up is to avoid Xft entirely, as
		328	it is simply slow. If you still want Xft fonts you might try to disable
		329	antialiasing (by appending C<:antialias=false>), which saves lots of
		330	memory and also speeds up rendering considerably.
		331
		332	=head3 Rxvt-unicode doesn't seem to anti-alias its fonts, what is wrong?
		333
		334	Rxvt-unicode will use whatever you specify as a font. If it needs to
		335	fall back to it's default font search list it will prefer X11 core
		336	fonts, because they are small and fast, and then use Xft fonts. It has
		337	antialiasing disabled for most of them, because the author thinks they
		338	look best that way.
		339
		340	If you want antialiasing, you have to specify the fonts manually.
		341
		342	=head3 What's with this bold/blink stuff?
		343
		344	If no bold colour is set via C<colorBD:>, bold will invert text using the
		345	standard foreground colour.
		346
		347	For the standard background colour, blinking will actually make the
		348	text blink when compiled with C<--enable-blinking>. with standard
		349	colours. Without C<--enable-blinking>, the blink attribute will be
		350	ignored.
		351
		352	On ANSI colours, bold/blink attributes are used to set high-intensity
		353	foreground/background colors.
		354
		355	color0-7 are the low-intensity colors.
		356
		357	color8-15 are the corresponding high-intensity colors.
		358
		359	=head3 I don't like the screen colors. How do I change them?
		360
		361	You can change the screen colors at run-time using F<~/.Xdefaults>
		362	resources (or as long-options).
		363
		364	Here are values that are supposed to resemble a VGA screen,
		365	including the murky brown that passes for low-intensity yellow:
		366
		367	URxvt.color0: #000000
		368	URxvt.color1: #A80000
		369	URxvt.color2: #00A800
		370	URxvt.color3: #A8A800
		371	URxvt.color4: #0000A8
		372	URxvt.color5: #A800A8
		373	URxvt.color6: #00A8A8
		374	URxvt.color7: #A8A8A8
		375
		376	URxvt.color8: #000054
		377	URxvt.color9: #FF0054
		378	URxvt.color10: #00FF54
		379	URxvt.color11: #FFFF54
		380	URxvt.color12: #0000FF
		381	URxvt.color13: #FF00FF
		382	URxvt.color14: #00FFFF
		383	URxvt.color15: #FFFFFF
		384
		385	And here is a more complete set of non-standard colors.
		386
		387	URxvt.cursorColor: #dc74d1
		388	URxvt.pointerColor: #dc74d1
		389	URxvt.background: #0e0e0e
		390	URxvt.foreground: #4ad5e1
		391	URxvt.color0: #000000
		392	URxvt.color8: #8b8f93
		393	URxvt.color1: #dc74d1
		394	URxvt.color9: #dc74d1
		395	URxvt.color2: #0eb8c7
		396	URxvt.color10: #0eb8c7
		397	URxvt.color3: #dfe37e
		398	URxvt.color11: #dfe37e
		399	URxvt.color5: #9e88f0
		400	URxvt.color13: #9e88f0
		401	URxvt.color6: #73f7ff
		402	URxvt.color14: #73f7ff
		403	URxvt.color7: #e1dddd
		404	URxvt.color15: #e1dddd
		405
		406	They have been described (not by me) as "pretty girly".
		407
		408	=head3 Why do some characters look so much different than others?
		409
		410	See next entry.
		411
		412	=head3 How does rxvt-unicode choose fonts?
		413
		414	Most fonts do not contain the full range of Unicode, which is
		415	fine. Chances are that the font you (or the admin/package maintainer of
		416	your system/os) have specified does not cover all the characters you want
		417	to display.
		418
		419	B<rxvt-unicode> makes a best-effort try at finding a replacement
		420	font. Often the result is fine, but sometimes the chosen font looks
		421	bad/ugly/wrong. Some fonts have totally strange characters that don't
		422	resemble the correct glyph at all, and rxvt-unicode lacks the artificial
		423	intelligence to detect that a specific glyph is wrong: it has to believe
		424	the font that the characters it claims to contain indeed look correct.
		425
		426	In that case, select a font of your taste and add it to the font list,
		427	e.g.:
		428
		429	@@URXVT_NAME@@ -fn basefont,font2,font3...
		430
		431	When rxvt-unicode sees a character, it will first look at the base
		432	font. If the base font does not contain the character, it will go to the
		433	next font, and so on. Specifying your own fonts will also speed up this
		434	search and use less resources within rxvt-unicode and the X-server.
		435
		436	The only limitation is that none of the fonts may be larger than the base
		437	font, as the base font defines the terminal character cell size, which
		438	must be the same due to the way terminals work.
		439
		440	=head3 Why do some chinese characters look so different than others?
		441
		442	This is because there is a difference between script and language --
		443	rxvt-unicode does not know which language the text that is output is,
		444	as it only knows the unicode character codes. If rxvt-unicode first
		445	sees a japanese/chinese character, it might choose a japanese font for
		446	display. Subsequent japanese characters will use that font. Now, many
		447	chinese characters aren't represented in japanese fonts, so when the first
		448	non-japanese character comes up, rxvt-unicode will look for a chinese font
		449	-- unfortunately at this point, it will still use the japanese font for
		450	chinese characters that are also in the japanese font.
		451
		452	The workaround is easy: just tag a chinese font at the end of your font
		453	list (see the previous question). The key is to view the font list as
		454	a preference list: If you expect more japanese, list a japanese font
		455	first. If you expect more chinese, put a chinese font first.
		456
		457	In the future it might be possible to switch language preferences at
		458	runtime (the internal data structure has no problem with using different
		459	fonts for the same character at the same time, but no interface for this
		460	has been designed yet).
		461
		462	Until then, you might get away with switching fonts at runtime (see L<Can
		463	I switch the fonts at runtime?> later in this document).
		464
		465	=head2 Keyboard, Mouse & User Interaction
		466
		467	=head3 The new selection selects pieces that are too big, how can I select single words?
		468
		469	If you want to select e.g. alphanumeric words, you can use the following
		470	setting:
		471
		472	URxvt.selection.pattern-0: ([[:word:]]+)
		473
		474	If you click more than twice, the selection will be extended
		475	more and more.
		476
		477	To get a selection that is very similar to the old code, try this pattern:
		478
		479	URxvt.selection.pattern-0: ([^"&'()*,;<=>?@[\\\\]^`{|})]+)
		480
		481	Please also note that the I<LeftClick Shift-LeftClik> combination also
		482	selects words like the old code.
		483
		484	=head3 I don't like the new selection/popups/hotkeys/perl, how do I change/disable it?
		485
		486	You can disable the perl extension completely by setting the
		487	B<perl-ext-common> resource to the empty string, which also keeps
		488	rxvt-unicode from initialising perl, saving memory.
		489
		490	If you only want to disable specific features, you first have to
		491	identify which perl extension is responsible. For this, read the section
		492	B<PREPACKAGED EXTENSIONS> in the @@URXVT_NAME@@perl(3) manpage. For
		493	example, to disable the B<selection-popup> and B<option-popup>, specify
		494	this B<perl-ext-common> resource:
		495
		496	URxvt.perl-ext-common: default,-selection-popup,-option-popup
		497
		498	This will keep the default extensions, but disable the two popup
		499	extensions. Some extensions can also be configured, for example,
		500	scrollback search mode is triggered by B<M-s>. You can move it to any
		501	other combination either by setting the B<searchable-scrollback> resource:
		502
		503	URxvt.searchable-scrollback: CM-s
		504
		505	=head3 The cursor moves when selecting text in the current input line, how do I switch this off?
		506
		507	See next entry.
		508
		509	=head3 During rlogin/ssh/telnet/etc. sessions, clicking near the cursor outputs strange escape sequences, how do I fix this?
		510
		511	These are caused by the C<readline> perl extension. Under normal
		512	circumstances, it will move your cursor around when you click into the
		513	line that contains it. It tries hard not to do this at the wrong moment,
		514	but when running a program that doesn't parse cursor movements or in some
		515	cases during rlogin sessions, it fails to detect this properly.
		516
		517	You can permamently switch this feature off by disabling the C<readline>
		518	extension:
		519
		520	URxvt.perl-ext-common: default,-readline
		521
		522	=head3 My numerical keypad acts weird and generates differing output?
		523
		524	Some Debian GNUL/Linux users seem to have this problem, although no
		525	specific details were reported so far. It is possible that this is caused
		526	by the wrong C<TERM> setting, although the details of wether and how
		527	this can happen are unknown, as C<TERM=rxvt> should offer a compatible
		528	keymap. See the answer to the previous question, and please report if that
		529	helped.
		530
		531	=head3 My Compose (Multi_key) key is no longer working.
		532
		533	The most common causes for this are that either your locale is not set
		534	correctly, or you specified a B<preeditStyle> that is not supported by
		535	your input method. For example, if you specified B<OverTheSpot> and
		536	your input method (e.g. the default input method handling Compose keys)
		537	does not support this (for instance because it is not visual), then
		538	rxvt-unicode will continue without an input method.
		539
		540	In this case either do not specify a B<preeditStyle> or specify more than
		541	one pre-edit style, such as B<OverTheSpot,Root,None>.
		542
		543	=head3 I cannot type C<Ctrl-Shift-2> to get an ASCII NUL character due to ISO 14755
		544
		545	Either try C<Ctrl-2> alone (it often is mapped to ASCII NUL even on
		546	international keyboards) or simply use ISO 14755 support to your
		547	advantage, typing <Ctrl-Shift-0> to get a ASCII NUL. This works for other
		548	codes, too, such as C<Ctrl-Shift-1-d> to type the default telnet escape
		549	character and so on.
		550
		551	=head3 Mouse cut/paste suddenly no longer works.
		552
		553	Make sure that mouse reporting is actually turned off since killing
		554	some editors prematurely may leave the mouse in mouse report mode. I've
		555	heard that tcsh may use mouse reporting unless it otherwise specified. A
		556	quick check is to see if cut/paste works when the Alt or Shift keys are
		557	depressed.
		558
		559	=head3 What's with the strange Backspace/Delete key behaviour?
		560
		561	Assuming that the physical Backspace key corresponds to the
		562	BackSpace keysym (not likely for Linux ... see the following
		563	question) there are two standard values that can be used for
		564	Backspace: C<^H> and C<^?>.
		565
		566	Historically, either value is correct, but rxvt-unicode adopts the debian
		567	policy of using C<^?> when unsure, because it's the one only only correct
		568	choice :).
		569
		570	Rxvt-unicode tries to inherit the current stty settings and uses the value
		571	of `erase' to guess the value for backspace. If rxvt-unicode wasn't
		572	started from a terminal (say, from a menu or by remote shell), then the
		573	system value of `erase', which corresponds to CERASE in <termios.h>, will
		574	be used (which may not be the same as your stty setting).
		575
		576	For starting a new rxvt-unicode:
		577
		578	# use Backspace = ^H
		579	$ stty erase ^H
		580	$ @@URXVT_NAME@@
		581
		582	# use Backspace = ^?
		583	$ stty erase ^?
		584	$ @@URXVT_NAME@@
		585
		586	Toggle with C<ESC [ 36 h> / C<ESC [ 36 l>.
		587
		588	For an existing rxvt-unicode:
		589
		590	# use Backspace = ^H
		591	$ stty erase ^H
		592	$ echo -n "^[[36h"
		593
		594	# use Backspace = ^?
		595	$ stty erase ^?
		596	$ echo -n "^[[36l"
		597
		598	This helps satisfy some of the Backspace discrepancies that occur, but
		599	if you use Backspace = C<^H>, make sure that the termcap/terminfo value
		600	properly reflects that.
		601
		602	The Delete key is a another casualty of the ill-defined Backspace problem.
		603	To avoid confusion between the Backspace and Delete keys, the Delete
		604	key has been assigned an escape sequence to match the vt100 for Execute
		605	(C<ESC [ 3 ~>) and is in the supplied termcap/terminfo.
		606
		607	Some other Backspace problems:
		608
		609	some editors use termcap/terminfo,
		610	some editors (vim I'm told) expect Backspace = ^H,
		611	GNU Emacs (and Emacs-like editors) use ^H for help.
		612
		613	Perhaps someday this will all be resolved in a consistent manner.
		614
		615	=head3 I don't like the key-bindings. How do I change them?
		616
		617	There are some compile-time selections available via configure. Unless
		618	you have run "configure" with the C<--disable-resources> option you can
		619	use the `keysym' resource to alter the keystrings associated with keysyms.
		620
		621	Here's an example for a URxvt session started using C<@@URXVT_NAME@@ -name URxvt>
		622
		623	URxvt.keysym.Home: \033[1~
		624	URxvt.keysym.End: \033[4~
		625	URxvt.keysym.C-apostrophe: \033<C-'>
		626	URxvt.keysym.C-slash: \033<C-/>
		627	URxvt.keysym.C-semicolon: \033<C-;>
		628	URxvt.keysym.C-grave: \033<C-`>
		629	URxvt.keysym.C-comma: \033<C-,>
		630	URxvt.keysym.C-period: \033<C-.>
		631	URxvt.keysym.C-0x60: \033<C-`>
		632	URxvt.keysym.C-Tab: \033<C-Tab>
		633	URxvt.keysym.C-Return: \033<C-Return>
		634	URxvt.keysym.S-Return: \033<S-Return>
		635	URxvt.keysym.S-space: \033<S-Space>
		636	URxvt.keysym.M-Up: \033<M-Up>
		637	URxvt.keysym.M-Down: \033<M-Down>
		638	URxvt.keysym.M-Left: \033<M-Left>
		639	URxvt.keysym.M-Right: \033<M-Right>
		640	URxvt.keysym.M-C-0: list \033<M-C- 0123456789 >
		641	URxvt.keysym.M-C-a: list \033<M-C- abcdefghijklmnopqrstuvwxyz >
		642	URxvt.keysym.F12: command:\033]701;zh_CN.GBK\007
		643
		644	See some more examples in the documentation for the B<keysym> resource.
		645
		646	=head3 I'm using keyboard model XXX that has extra Prior/Next/Insert keys. How do I make use of them? For example, the Sun Keyboard type 4 has the following map
		647
		648	KP_Insert == Insert
		649	F22 == Print
		650	F27 == Home
		651	F29 == Prior
		652	F33 == End
		653	F35 == Next
		654
		655	Rather than have rxvt-unicode try to accommodate all the various possible
		656	keyboard mappings, it is better to use `xmodmap' to remap the keys as
		657	required for your particular machine.
		658
		659
		660
		661	=head2 Terminal Configuration
		662
		663	=head3 Why doesn't rxvt-unicode read my resources?
		664
		665	Well, why, indeed? It does, in a way very similar to other X
		666	applications. Most importantly, this means that if you or your OS loads
		667	resources into the X display (the right way to do it), rxvt-unicode will
		668	ignore any resource files in your home directory. It will only read
		669	F<$HOME/.Xdefaults> when no resources are attached to the display.
		670
		671	If you have or use an F<$HOME/.Xresources> file, chances are that
		672	resources are loaded into your X-server. In this case, you have to
		673	re-login after every change (or run F<xrdb -merge $HOME/.Xresources>).
		674
		675	Also consider the form resources have to use:
		676
		677	URxvt.resource: value
		678
		679	If you want to use another form (there are lots of different ways of
		680	specifying resources), make sure you understand wether and why it
		681	works. If unsure, use the form above.
		682
		683	=head3 When I log-in to another system it tells me about missing terminfo data?
		684
		685	The terminal description used by rxvt-unicode is not as widely available
		686	as that for xterm, or even rxvt (for which the same problem often arises).
		687
		688	The correct solution for this problem is to install the terminfo, this can
		689	be done like this (with ncurses' infocmp):
		690
		691	REMOTE=remotesystem.domain
		692	infocmp rxvt-unicode | ssh $REMOTE "cat >/tmp/ti && tic /tmp/ti"
		693
		694	... or by installing rxvt-unicode normally on the remote system,
		695
		696	If you cannot or do not want to do this, then you can simply set
		697	C<TERM=rxvt> or even C<TERM=xterm>, and live with the small number of
		698	problems arising, which includes wrong keymapping, less and different
		699	colours and some refresh errors in fullscreen applications. It's a nice
		700	quick-and-dirty workaround for rare cases, though.
		701
		702	If you always want to do this (and are fine with the consequences) you
		703	can either recompile rxvt-unicode with the desired TERM value or use a
		704	resource to set it:
		705
		706	URxvt.termName: rxvt
		707
		708	If you don't plan to use B<rxvt> (quite common...) you could also replace
		709	the rxvt terminfo file with the rxvt-unicode one and use C<TERM=rxvt>.
		710
		711	=head3 C<tic> outputs some error when compiling the terminfo entry.
		712
		713	Most likely it's the empty definition for C<enacs=>. Just replace it by
		714	C<enacs=\E[0@> and try again.
		715
		716	=head3 C<bash>'s readline does not work correctly under @@URXVT_NAME@@.
		717
		718	See next entry.
		719
		720	=head3 I need a termcap file entry.
		721
		722	One reason you might want this is that some distributions or operating
		723	systems still compile some programs using the long-obsoleted termcap
		724	library (Fedora Core's bash is one example) and rely on a termcap entry
		725	for C<rxvt-unicode>.
		726
		727	You could use rxvt's termcap entry with resonable results in many cases.
		728	You can also create a termcap entry by using terminfo's infocmp program
		729	like this:
		730
		731	infocmp -C rxvt-unicode
		732
		733	Or you could use this termcap entry, generated by the command above:
		734
		735	rxvt-unicode|rxvt-unicode terminal (X Window System):\
		736	:am:bw:eo:km:mi:ms:xn:xo:\
		737	:co#80:it#8:li#24:lm#0:\
		738	:AL=\E[%dL:DC=\E[%dP:DL=\E[%dM:DO=\E[%dB:IC=\E[%d@:\
		739	:K1=\EOw:K2=\EOu:K3=\EOy:K4=\EOq:K5=\EOs:LE=\E[%dD:\
		740	:RI=\E[%dC:SF=\E[%dS:SR=\E[%dT:UP=\E[%dA:ae=\E(B:al=\E[L:\
		741	:as=\E(0:bl=^G:cd=\E[J:ce=\E[K:cl=\E[H\E[2J:\
		742	:cm=\E[%i%d;%dH:cr=^M:cs=\E[%i%d;%dr:ct=\E[3g:dc=\E[P:\
		743	:dl=\E[M:do=^J:ec=\E[%dX:ei=\E[4l:ho=\E[H:\
		744	:i1=\E[?47l\E=\E[?1l:ic=\E[@:im=\E[4h:\
		745	:is=\E[r\E[m\E[2J\E[H\E[?7h\E[?1;3;4;6l\E[4l:\
		746	:k1=\E[11~:k2=\E[12~:k3=\E[13~:k4=\E[14~:k5=\E[15~:\
		747	:k6=\E[17~:k7=\E[18~:k8=\E[19~:k9=\E[20~:kD=\E[3~:\
		748	:kI=\E[2~:kN=\E[6~:kP=\E[5~:kb=\177:kd=\EOB:ke=\E[?1l\E>:\
		749	:kh=\E[7~:kl=\EOD:kr=\EOC:ks=\E[?1h\E=:ku=\EOA:le=^H:\
		750	:mb=\E[5m:md=\E[1m:me=\E[m\017:mr=\E[7m:nd=\E[C:rc=\E8:\
		751	:sc=\E7:se=\E[27m:sf=^J:so=\E[7m:sr=\EM:st=\EH:ta=^I:\
		752	:te=\E[r\E[?1049l:ti=\E[?1049h:ue=\E[24m:up=\E[A:\
		753	:us=\E[4m:vb=\E[?5h\E[?5l:ve=\E[?25h:vi=\E[?25l:\
		754	:vs=\E[?25h:
		755
		756	=head3 Why does C<ls> no longer have coloured output?
		757
		758	The C<ls> in the GNU coreutils unfortunately doesn't use terminfo to
		759	decide wether a terminal has colour, but uses it's own configuration
		760	file. Needless to say, C<rxvt-unicode> is not in it's default file (among
		761	with most other terminals supporting colour). Either add:
		762
		763	TERM rxvt-unicode
		764
		765	to C</etc/DIR_COLORS> or simply add:
		766
		767	alias ls='ls --color=auto'
		768
		769	to your C<.profile> or C<.bashrc>.
		770
		771	=head3 Why doesn't vim/emacs etc. use the 88 colour mode?
		772
		773	See next entry.
		774
		775	=head3 Why doesn't vim/emacs etc. make use of italic?
		776
		777	See next entry.
		778
		779	=head3 Why are the secondary screen-related options not working properly?
		780
		781	Make sure you are using C<TERM=rxvt-unicode>. Some pre-packaged
		782	distributions (most notably Debian GNU/Linux) break rxvt-unicode
		783	by setting C<TERM> to C<rxvt>, which doesn't have these extra
		784	features. Unfortunately, some of these (most notably, again, Debian
		785	GNU/Linux) furthermore fail to even install the C<rxvt-unicode> terminfo
		786	file, so you will need to install it on your own (See the question B<When
		787	I log-in to another system it tells me about missing terminfo data?> on
		788	how to do this).
		789
		790
		791	=head2 Encoding / Locale / Input Method Issues
		792
		793	=head3 Rxvt-unicode does not seem to understand the selected encoding?
		794
		795	See next entry.
		796
		797	=head3 Unicode does not seem to work?
		798
		799	If you encounter strange problems like typing an accented character but
		800	getting two unrelated other characters or similar, or if program output is
		801	subtly garbled, then you should check your locale settings.
		802
		803	Rxvt-unicode must be started with the same C<LC_CTYPE> setting as the
		804	programs. Often rxvt-unicode is started in the C<C> locale, while the
		805	login script running within the rxvt-unicode window changes the locale to
		806	something else, e.g. C<en_GB.UTF-8>. Needless to say, this is not going to work.
		807
		808	The best thing is to fix your startup environment, as you will likely run
		809	into other problems. If nothing works you can try this in your .profile.
		810
		811	printf '\e]701;%s\007' "$LC_CTYPE"
		812
		813	If this doesn't work, then maybe you use a C<LC_CTYPE> specification not
		814	supported on your systems. Some systems have a C<locale> command which
		815	displays this (also, C<perl -e0> can be used to check locale settings, as
		816	it will complain loudly if it cannot set the locale). If it displays something
		817	like:
		818
		819	locale: Cannot set LC_CTYPE to default locale: ...
		820
		821	Then the locale you specified is not supported on your system.
		822
		823	If nothing works and you are sure that everything is set correctly then
		824	you will need to remember a little known fact: Some programs just don't
		825	support locales :(
		826
		827	=head3 How does rxvt-unicode determine the encoding to use?
		828
		829	See next entry.
		830
		831	=head3 Is there an option to switch encodings?
		832
		833	Unlike some other terminals, rxvt-unicode has no encoding switch, and no
		834	specific "utf-8" mode, such as xterm. In fact, it doesn't even know about
		835	UTF-8 or any other encodings with respect to terminal I/O.
		836
		837	The reasons is that there exists a perfectly fine mechanism for selecting
		838	the encoding, doing I/O and (most important) communicating this to all
		839	applications so everybody agrees on character properties such as width
		840	and code number. This mechanism is the I<locale>. Applications not using
		841	that info will have problems (for example, C<xterm> gets the width of
		842	characters wrong as it uses it's own, locale-independent table under all
		843	locales).
		844
		845	Rxvt-unicode uses the C<LC_CTYPE> locale category to select encoding. All
		846	programs doing the same (that is, most) will automatically agree in the
		847	interpretation of characters.
		848
		849	Unfortunately, there is no system-independent way to select locales, nor
		850	is there a standard on how locale specifiers will look like.
		851
		852	On most systems, the content of the C<LC_CTYPE> environment variable
		853	contains an arbitrary string which corresponds to an already-installed
		854	locale. Common names for locales are C<en_US.UTF-8>, C<de_DE.ISO-8859-15>,
		855	C<ja_JP.EUC-JP>, i.e. C<language_country.encoding>, but other forms
		856	(i.e. C<de> or C<german>) are also common.
		857
		858	Rxvt-unicode ignores all other locale categories, and except for
		859	the encoding, ignores country or language-specific settings,
		860	i.e. C<de_DE.UTF-8> and C<ja_JP.UTF-8> are the normally same to
		861	rxvt-unicode.
		862
		863	If you want to use a specific encoding you have to make sure you start
		864	rxvt-unicode with the correct C<LC_CTYPE> category.
		865
		866	=head3 Can I switch locales at runtime?
		867
		868	Yes, using an escape sequence. Try something like this, which sets
		869	rxvt-unicode's idea of C<LC_CTYPE>.
		870
		871	printf '\e]701;%s\007' ja_JP.SJIS
		872
		873	See also the previous answer.
		874
		875	Sometimes this capability is rather handy when you want to work in
		876	one locale (e.g. C<de_DE.UTF-8>) but some programs don't support it
		877	(e.g. UTF-8). For example, I use this script to start C<xjdic>, which
		878	first switches to a locale supported by xjdic and back later:
		879
		880	printf '\e]701;%s\007' ja_JP.SJIS
		881	xjdic -js
		882	printf '\e]701;%s\007' de_DE.UTF-8
		883
		884	You can also use xterm's C<luit> program, which usually works fine, except
		885	for some locales where character width differs between program- and
		886	rxvt-unicode-locales.
		887
		888	=head3 I have problems getting my input method working.
		889
		890	Try a search engine, as this is slightly different for every input method server.
		891
		892	Here is a checklist:
		893
		894	=over 4
		895
		896	=item - Make sure your locale I<and> the imLocale are supported on your OS.
		897
		898	Try C<locale -a> or check the documentation for your OS.
		899
		900	=item - Make sure your locale or imLocale matches a locale supported by your XIM.
		901
		902	For example, B<kinput2> does not support UTF-8 locales, you should use
		903	C<ja_JP.EUC-JP> or equivalent.
		904
		905	=item - Make sure your XIM server is actually running.
		906
		907	=item - Make sure the C<XMODIFIERS> environment variable is set correctly when I<starting> rxvt-unicode.
		908
		909	When you want to use e.g. B<kinput2>, it must be set to
		910	C<@im=kinput2>. For B<scim>, use C<@im=SCIM>. Youc an see what input
		911	method servers are running with this command:
		912
		913	xprop -root XIM_SERVERS
		914
		915	=item
		916
572	=back	917	=back
573		918
574	=head1 SYNOPSIS	919	=head3 My input method wants <some encoding> but I want UTF-8, what can I do?
575		920
576	# set a new font set	921	You can specify separate locales for the input method and the rest of the
577	printf '\33]50;%s\007' 9x15,xft:Kochi" Mincho"	922	terminal, using the resource C<imlocale>:
578		923
579	# change the locale and tell rxvt-unicode about it	924	URxvt.imlocale: ja_JP.EUC-JP
580	export LC_CTYPE=ja_JP.EUC-JP; printf "\33]701;$LC_CTYPE\007"
581		925
582	# set window title	926	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"	927	use your input method. Please note, however, that, depending on your Xlib
		928	version, you may not be able to input characters outside C<EUC-JP> in a
		929	normal way then, as your input method limits you.
584		930
585	=head1 DESCRIPTION	931	=head3 Rxvt-unicode crashes when the X Input Method changes or exits.
		932
		933	Unfortunately, this is unavoidable, as the XIM protocol is racy by
		934	design. Applications can avoid some crashes at the expense of memory
		935	leaks, and Input Methods can avoid some crashes by careful ordering at
		936	exit time. B<kinput2> (and derived input methods) generally succeeds,
		937	while B<SCIM> (or similar input methods) fails. In the end, however,
		938	crashes cannot be completely avoided even if both sides cooperate.
		939
		940	So the only workaround is not to kill your Input Method Servers.
		941
		942
		943	=head2 Operating Systems / Package Maintaining
		944
		945	=head3 I am using Debian GNU/Linux and have a problem...
		946
		947	The Debian GNU/Linux package of rxvt-unicode in sarge contains large
		948	patches that considerably change the behaviour of rxvt-unicode (but
		949	unfortunately this notice has been removed). Before reporting a bug to
		950	the original rxvt-unicode author please download and install the genuine
		951	version (L<http://software.schmorp.de#rxvt-unicode>) and try to reproduce
		952	the problem. If you cannot, chances are that the problems are specific to
		953	Debian GNU/Linux, in which case it should be reported via the Debian Bug
		954	Tracking System (use C<reportbug> to report the bug).
		955
		956	For other problems that also affect the Debian package, you can and
		957	probably should use the Debian BTS, too, because, after all, it's also a
		958	bug in the Debian version and it serves as a reminder for other users that
		959	might encounter the same issue.
		960
		961	=head3 I am maintaining rxvt-unicode for distribution/OS XXX, any recommendation?
		962
		963	You should build one binary with the default options. F<configure>
		964	now enables most useful options, and the trend goes to making them
		965	runtime-switchable, too, so there is usually no drawback to enbaling them,
		966	except higher disk and possibly memory usage. The perl interpreter should
		967	be enabled, as important functionality (menus, selection, likely more in
		968	the future) depends on it.
		969
		970	You should not overwrite the C<perl-ext-common> snd C<perl-ext> resources
		971	system-wide (except maybe with C<defaults>). This will result in useful
		972	behaviour. If your distribution aims at low memory, add an empty
		973	C<perl-ext-common> resource to the app-defaults file. This will keep the
		974	perl interpreter disabled until the user enables it.
		975
		976	If you can/want build more binaries, I recommend building a minimal
		977	one with C<--disable-everything> (very useful) and a maximal one with
		978	C<--enable-everything> (less useful, it will be very big due to a lot of
		979	encodings built-in that increase download times and are rarely used).
		980
		981	=head3 I need to make it setuid/setgid to support utmp/ptys on my OS, is this safe?
		982
		983	It should be, starting with release 7.1. You are encouraged to properly
		984	install urxvt with privileges necessary for your OS now.
		985
		986	When rxvt-unicode detects that it runs setuid or setgid, it will fork
		987	into a helper process for privileged operations (pty handling on some
		988	systems, utmp/wtmp/lastlog handling on others) and drop privileges
		989	immediately. This is much safer than most other terminals that keep
		990	privileges while running (but is more relevant to urxvt, as it contains
		991	things as perl interpreters, which might be "helpful" to attackers).
		992
		993	This forking is done as the very first within main(), which is very early
		994	and reduces possible bugs to initialisation code run before main(), or
		995	things like the dynamic loader of your system, which should result in very
		996	little risk.
		997
		998	=head3 On Solaris 9, many line-drawing characters are too wide.
		999
		1000	Seems to be a known bug, read
		1001	L<http://nixdoc.net/files/forum/about34198.html>. Some people use the
		1002	following ugly workaround to get non-double-wide-characters working:
		1003
		1004	#define wcwidth(x) wcwidth(x) > 1 ? 1 : wcwidth(x)
		1005
		1006	=head3 I am on FreeBSD and rxvt-unicode does not seem to work at all.
		1007
		1008	Rxvt-unicode requires the symbol C<__STDC_ISO_10646__> to be defined
		1009	in your compile environment, or an implementation that implements it,
		1010	wether it defines the symbol or not. C<__STDC_ISO_10646__> requires that
		1011	B<wchar_t> is represented as unicode.
		1012
		1013	As you might have guessed, FreeBSD does neither define this symobl nor
		1014	does it support it. Instead, it uses it's own internal representation of
		1015	B<wchar_t>. This is, of course, completely fine with respect to standards.
		1016
		1017	However, that means rxvt-unicode only works in C<POSIX>, C<ISO-8859-1> and
		1018	C<UTF-8> locales under FreeBSD (which all use Unicode as B<wchar_t>.
		1019
		1020	C<__STDC_ISO_10646__> is the only sane way to support multi-language
		1021	apps in an OS, as using a locale-dependent (and non-standardized)
		1022	representation of B<wchar_t> makes it impossible to convert between
		1023	B<wchar_t> (as used by X11 and your applications) and any other encoding
		1024	without implementing OS-specific-wrappers for each and every locale. There
		1025	simply are no APIs to convert B<wchar_t> into anything except the current
		1026	locale encoding.
		1027
		1028	Some applications (such as the formidable B<mlterm>) work around this
		1029	by carrying their own replacement functions for character set handling
		1030	with them, and either implementing OS-dependent hacks or doing multiple
		1031	conversions (which is slow and unreliable in case the OS implements
		1032	encodings slightly different than the terminal emulator).
		1033
		1034	The rxvt-unicode author insists that the right way to fix this is in the
		1035	system libraries once and for all, instead of forcing every app to carry
		1036	complete replacements for them :)
		1037
		1038	=head3 I use Solaris 9 and it doesn't compile/work/etc.
		1039
		1040	Try the diff in F<doc/solaris9.patch> as a base. It fixes the worst
		1041	problems with C<wcwidth> and a compile problem.
		1042
		1043	=head3 How can I use rxvt-unicode under cygwin?
		1044
		1045	rxvt-unicode should compile and run out of the box on cygwin, using
		1046	the X11 libraries that come with cygwin. libW11 emulation is no
		1047	longer supported (and makes no sense, either, as it only supported a
		1048	single font). I recommend starting the X-server in C<-multiwindow> or
		1049	C<-rootless> mode instead, which will result in similar look&feel as the
		1050	old libW11 emulation.
		1051
		1052	At the time of this writing, cygwin didn't seem to support any multi-byte
		1053	encodings (you might try C<LC_CTYPE=C-UTF-8>), so you are likely limited
		1054	to 8-bit encodings.
		1055
		1056	=head1 RXVT-UNICODE TECHNICAL REFERENCE
586		1057
587	The rest of this document describes various technical aspects of	1058	The rest of this document describes various technical aspects of
588	B<rxvt-unicode>. First the description of supported command sequences,	1059	B<rxvt-unicode>. First the description of supported command sequences,
589	followed by menu and pixmap support and last by a description of all	1060	followed by pixmap support and last by a description of all features
590	features selectable at C<configure> time.	1061	selectable at C<configure> time.
591		1062
592	=head1 RXVT TECHNICAL REFERENCE
593
594	=head1 Definitions	1063	=head2 Definitions
595		1064
596	=over 4	1065	=over 4
597		1066
598	=item B<< C<c> >>	1067	=item B<< C<c> >>
599		1068
…		…
617		1086
618	A text parameter composed of printable characters.	1087	A text parameter composed of printable characters.
619		1088
620	=back	1089	=back
621		1090
622	=head1 Values	1091	=head2 Values
623		1092
624	=over 4	1093	=over 4
625		1094
626	=item B<< C<ENQ> >>	1095	=item B<< C<ENQ> >>
627		1096
…		…
670		1139
671	Space Character	1140	Space Character
672		1141
673	=back	1142	=back
674		1143
675	=head1 Escape Sequences	1144	=head2 Escape Sequences
676		1145
677	=over 4	1146	=over 4
678		1147
679	=item B<< C<ESC # 8> >>	1148	=item B<< C<ESC # 8> >>
680		1149
…		…
726	Single Shift Select of G3 Character Set (SS3): affects next character	1195	Single Shift Select of G3 Character Set (SS3): affects next character
727	only I<unimplemented>	1196	only I<unimplemented>
728		1197
729	=item B<< C<ESC Z> >>	1198	=item B<< C<ESC Z> >>
730		1199
731	Obsolete form of returns: B<< C<ESC[?1;2C> >> I<rxvt-unicode compile-time option>	1200	Obsolete form of returns: B<< C<ESC [ ? 1 ; 2 C> >> I<rxvt-unicode compile-time option>
732		1201
733	=item B<< C<ESC c> >>	1202	=item B<< C<ESC c> >>
734		1203
735	Full reset (RIS)	1204	Full reset (RIS)
736		1205
…		…
740		1209
741	=item B<< C<ESC o> >>	1210	=item B<< C<ESC o> >>
742		1211
743	Invoke the G3 Character Set (LS3)	1212	Invoke the G3 Character Set (LS3)
744		1213
745	=item B<< C<ESC> ( C> >>	1214	=item B<< C<ESC ( C> >>
746		1215
747	Designate G0 Character Set (ISO 2022), see below for values of C<C>.	1216	Designate G0 Character Set (ISO 2022), see below for values of C<C>.
748		1217
749	=item B<< C<ESC> ) C> >>	1218	=item B<< C<ESC ) C> >>
750		1219
751	Designate G1 Character Set (ISO 2022), see below for values of C<C>.	1220	Designate G1 Character Set (ISO 2022), see below for values of C<C>.
752		1221
753	=item B<< C<ESC * C> >>	1222	=item B<< C<ESC * C> >>
754		1223
…		…
778		1247
779	=back	1248	=back
780		1249
781	X<CSI>	1250	X<CSI>
782		1251
783	=head1 CSI (Command Sequence Introducer) Sequences	1252	=head2 CSI (Command Sequence Introducer) Sequences
784		1253
785	=over 4	1254	=over 4
786		1255
787	=item B<< C<ESC [ Ps @> >>	1256	=item B<< C<ESC [ Ps @> >>
788		1257
…		…
895		1364
896	=item B<< C<ESC [ Ps c> >>	1365	=item B<< C<ESC [ Ps c> >>
897		1366
898	Send Device Attributes (DA)	1367	Send Device Attributes (DA)
899	B<< C<Ps = 0> >> (or omitted): request attributes from terminal	1368	B<< C<Ps = 0> >> (or omitted): request attributes from terminal
900	returns: B<< C<ESC[?1;2c> >> (``I am a VT100 with Advanced Video	1369	returns: B<< C<ESC [ ? 1 ; 2 c> >> (``I am a VT100 with Advanced Video
901	Option'')	1370	Option'')
902		1371
903	=item B<< C<ESC [ Ps d> >>	1372	=item B<< C<ESC [ Ps d> >>
904		1373
905	Cursor to Line B<< C<Ps> >> (VPA)	1374	Cursor to Line B<< C<Ps> >> (VPA)
…		…
1021		1490
1022	=item B<< C<ESC [ s> >>	1491	=item B<< C<ESC [ s> >>
1023		1492
1024	Save Cursor (SC)	1493	Save Cursor (SC)
1025		1494
		1495	=item B<< C<ESC [ Ps;Pt t> >>
		1496
		1497	Window Operations
		1498
		1499	=begin table
		1500
		1501	B<< C<Ps = 1> >> Deiconify (map) window
		1502	B<< C<Ps = 2> >> Iconify window
		1503	B<< C<Ps = 3> >> B<< C<ESC [ 3 ; X ; Y t> >> Move window to (X|Y)
		1504	B<< C<Ps = 4> >> B<< C<ESC [ 4 ; H ; W t> >> Resize to WxH pixels
		1505	B<< C<Ps = 5> >> Raise window
		1506	B<< C<Ps = 6> >> Lower window
		1507	B<< C<Ps = 7> >> Refresh screen once
		1508	B<< C<Ps = 8> >> B<< C<ESC [ 8 ; R ; C t> >> Resize to R rows and C columns
		1509	B<< C<Ps = 11> >> Report window state (responds with C<Ps = 1> or C<Ps = 2>)
		1510	B<< C<Ps = 13> >> Report window position (responds with C<Ps = 3>)
		1511	B<< C<Ps = 14> >> Report window pixel size (responds with C<Ps = 4>)
		1512	B<< C<Ps = 18> >> Report window text size (responds with C<Ps = 7>)
		1513	B<< C<Ps = 19> >> Currently the same as C<Ps = 18>, but responds with C<Ps = 9>
		1514	B<< C<Ps = 20> >> Reports icon label (B<< C<ESC ] L NAME \234> >>)
		1515	B<< C<Ps = 21> >> Reports window title (B<< C<ESC ] l NAME \234> >>)
		1516	B<< C<Ps = 24..> >> Set window height to C<Ps> rows
		1517
		1518	=end table
		1519
		1520	=item B<< C<ESC [ u> >>
		1521
		1522	Restore Cursor
		1523
1026	=item B<< C<ESC [ Ps x> >>	1524	=item B<< C<ESC [ Ps x> >>
1027		1525
1028	Request Terminal Parameters (DECREQTPARM)	1526	Request Terminal Parameters (DECREQTPARM)
1029		1527
1030	=item B<< C<ESC [ u> >>
1031
1032	Restore Cursor
1033
1034	=back	1528	=back
1035		1529
1036	X<PrivateModes>	1530	X<PrivateModes>
1037		1531
1038	=head1 DEC Private Modes	1532	=head2 DEC Private Modes
1039		1533
1040	=over 4	1534	=over 4
1041		1535
1042	=item B<< C<ESC [ ? Pm h> >>	1536	=item B<< C<ESC [ ? Pm h> >>
1043		1537
…		…
1140	B<< C<h> >> Send Mouse X & Y on button press.	1634	B<< C<h> >> Send Mouse X & Y on button press.
1141	B<< C<l> >> No mouse reporting.	1635	B<< C<l> >> No mouse reporting.
1142		1636
1143	=end table	1637	=end table
1144		1638
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> >>	1639	=item B<< C<Ps = 25> >>
1155		1640
1156	=begin table	1641	=begin table
1157		1642
1158	B<< C<h> >> Visible cursor {cnorm/cvvis}	1643	B<< C<h> >> Visible cursor {cnorm/cvvis}
…		…
1274	B<< C<h> >> Scroll to bottom when a key is pressed	1759	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	1760	B<< C<l> >> Don't scroll to bottom when a key is pressed
1276		1761
1277	=end table	1762	=end table
1278		1763
		1764	=item B<< C<Ps = 1021> >> (B<rxvt>)
		1765
		1766	=begin table
		1767
		1768	B<< C<h> >> Bold/italic implies high intensity (see option B<-is>)
		1769	B<< C<l> >> Font styles have no effect on intensity (Compile styles)
		1770
		1771	=end table
		1772
1279	=item B<< C<Ps = 1047> >>	1773	=item B<< C<Ps = 1047> >>
1280		1774
1281	=begin table	1775	=begin table
1282		1776
1283	B<< C<h> >> Use Alternate Screen Buffer	1777	B<< C<h> >> Use Alternate Screen Buffer
…		…
1307		1801
1308	=back	1802	=back
1309		1803
1310	X<XTerm>	1804	X<XTerm>
1311		1805
1312	=head1 XTerm Operating System Commands	1806	=head2 XTerm Operating System Commands
1313		1807
1314	=over 4	1808	=over 4
1315		1809
1316	=item B<< C<ESC ] Ps;Pt ST> >>	1810	=item B<< C<ESC ] Ps;Pt ST> >>
1317		1811
…		…
1329	B<< C<Ps = 10> >> Change colour of text foreground to B<< C<Pt> >> B<(NB: may change in future)>	1823	B<< C<Ps = 10> >> Change colour of text foreground to B<< C<Pt> >> B<(NB: may change in future)>
1330	B<< C<Ps = 11> >> Change colour of text background to B<< C<Pt> >> B<(NB: may change in future)>	1824	B<< C<Ps = 11> >> Change colour of text background to B<< C<Pt> >> B<(NB: may change in future)>
1331	B<< C<Ps = 12> >> Change colour of text cursor foreground to B<< C<Pt> >>	1825	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> >>	1826	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> >>	1827	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> >>	1828	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> >>	1829	B<< C<Ps = 19> >> Change colour of underlined characters to B<< C<Pt> >> [deprecated, see 707]
		1830	B<< C<Ps = 20> >> Change background pixmap parameters (see section XPM) (Compile XPM).
1336	B<< C<Ps = 20> >> Change default background to B<< C<Pt> >>	1831	B<< C<Ps = 39> >> Change default foreground colour to B<< C<Pt> >>.
1337	B<< C<Ps = 39> >> Change default foreground colour to B<< C<Pt> >> I<rxvt compile-time option>
1338	B<< C<Ps = 46> >> Change Log File to B<< C<Pt> >> I<unimplemented>	1832	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>	1833	B<< C<Ps = 49> >> Change default background colour to B<< C<Pt> >>.
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> >>	1834	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> >>	1835	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)	1836	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)	1837	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> >>	1838	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> >>	1839	B<< C<Ps = 705> >> Change background pixmap tint colour to B<< C<Pt> >> (Compile transparency).
		1840	B<< C<Ps = 706> >> Change colour of bold characters to B<< C<Pt> >>
		1841	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>.	1842	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>.	1843	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>.	1844	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>.	1845	B<< C<Ps = 713> >> Set bold-italic fontset to B<< C<Pt> >>. Similar to C<Ps = 50> (Compile styles).
		1846	B<< C<Ps = 720> >> Move viewing window up by B<< C<Pt> >> lines, or clear scrollback buffer if C<Pt = 0> (Compile frills).
		1847	B<< C<Ps = 721> >> Move viewing window down by B<< C<Pt> >> lines, or clear scrollback buffer if C<Pt = 0> (Compile frills).
		1848	B<< C<Ps = 777> >> Call the perl extension with the given string, which should be of the form C<extension:parameters> (Compile perl).
1350		1849
1351	=end table	1850	=end table
1352		1851
1353	=back	1852	=back
1354
1355	X<menuBar>
1356
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		1853
1822	=head1 XPM	1854	=head1 XPM
1823		1855
1824	For the XPM XTerm escape sequence B<< C<ESC ] 20 ; Pt ST> >> then value	1856	For the XPM XTerm escape sequence B<< C<ESC ] 20 ; Pt ST> >> then value
1825	of B<< C<Pt> >> can be the name of the background pixmap followed by a	1857	of B<< C<Pt> >> can be the name of the background pixmap followed by a
…		…
1923	=begin table	1955	=begin table
1924		1956
1925	4 Shift	1957	4 Shift
1926	8 Meta	1958	8 Meta
1927	16 Control	1959	16 Control
1928	32 Double Click I<(Rxvt extension)>	1960	32 Double Click I<(rxvt extension)>
1929		1961
1930	=end table	1962	=end table
1931		1963
1932	Col = B<< C<< <x> - SPACE >> >>	1964	Col = B<< C<< <x> - SPACE >> >>
1933		1965
…		…
2010	=end table	2042	=end table
2011		2043
2012	=head1 CONFIGURE OPTIONS	2044	=head1 CONFIGURE OPTIONS
2013		2045
2014	General hint: if you get compile errors, then likely your configuration	2046	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	2047	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,	2048	the F<./reconf> script as a base for experiments. F<./reconf> is used by
2017	so it should generally be a working config. Of course, you should always	2049	myself, so it should generally be a working config. Of course, you should
2018	report when a combination doesn't work, so it can be fixed. Marc Lehmann	2050	always report when a combination doesn't work, so it can be fixed. Marc
2019	<rxvt@schmorp.de>.	2051	Lehmann <rxvt@schmorp.de>.
		2052
		2053	All
2020		2054
2021	=over 4	2055	=over 4
2022		2056
2023	=item --enable-everything	2057	=item --enable-everything
2024		2058
2025	Add support for all non-multichoice options listed in "./configure	2059	Add (or remove) support for all non-multichoice options listed in "./configure
2026	--help". Note that unlike other enable options this is order dependant.	2060	--help".
		2061
2027	You can specify this and then disable options which this enables by	2062	You can specify this and then disable options you do not like by
2028	I<following> this with the appropriate commands.	2063	I<following> this with the appropriate C<--disable-...> arguments,
		2064	or you can start with a minimal configuration by specifying
		2065	C<--disable-everything> and than adding just the C<--enable-...> arguments
		2066	you want.
2029		2067
2030	=item --enable-xft	2068	=item --enable-xft (default: enabled)
2031		2069
2032	Add support for Xft (anti-aliases, among others) fonts. Xft fonts are	2070	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	2071	slower and require lots of memory, but as long as you don't use them, you
2034	don't pay for them.	2072	don't pay for them.
2035		2073
2036	=item --enable-font-styles	2074	=item --enable-font-styles (default: on)
2037		2075
2038	Add support for B<bold>, I<italic> and B<< I<bold italic> >> font	2076	Add support for B<bold>, I<italic> and B<< I<bold italic> >> font
2039	styles. The fonts can be set manually or automatically.	2077	styles. The fonts can be set manually or automatically.
2040		2078
2041	=item --with-codesets=NAME,...	2079	=item --with-codesets=NAME,... (default: all)
2042		2080
2043	Compile in support for additional codeset (encoding) groups (eu, vn are	2081	Compile in support for additional codeset (encoding) groups (C<eu>, C<vn>
2044	always compiled in, which includes most 8-bit character sets). These	2082	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	2083	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	2084	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	2085	replacement fonts more intelligently. Compiling them in will make your
		2086	binary bigger (all of together cost about 700kB), but it doesn't increase
2048	you use an X11 font requiring one of these encodings.	2087	memory usage unless you use a font requiring one of these encodings.
2049		2088
2050	=begin table	2089	=begin table
2051		2090
2052	all all available codeset groups	2091	all all available codeset groups
2053	cn common chinese encodings	2092	zh common chinese encodings
2054	cn_ext rarely used but very big chinese encodigs	2093	zh_ext rarely used but very big chinese encodigs
2055	jp common japanese encodings	2094	jp common japanese encodings
2056	jp_ext rarely used but big japanese encodings	2095	jp_ext rarely used but big japanese encodings
2057	kr korean encodings	2096	kr korean encodings
2058		2097
2059	=end table	2098	=end table
2060		2099
2061	=item --enable-xim	2100	=item --enable-xim (default: on)
2062		2101
2063	Add support for XIM (X Input Method) protocol. This allows using	2102	Add support for XIM (X Input Method) protocol. This allows using
2064	alternative input methods (e.g. kinput2) and will also correctly	2103	alternative input methods (e.g. kinput2) and will also correctly
2065	set up the input for people using dead keys or compose keys.	2104	set up the input for people using dead keys or compose keys.
2066		2105
2067	=item --enable-unicode3	2106	=item --enable-unicode3 (default: off)
		2107
		2108	Recommended to stay off unless you really need non-BMP characters.
2068		2109
2069	Enable direct support for displaying unicode codepoints above	2110	Enable direct support for displaying unicode codepoints above
2070	65535 (the basic multilingual page). This increases storage	2111	65535 (the basic multilingual page). This increases storage
2071	requirements per character from 2 to 4 bytes. X11 fonts do not yet	2112	requirements per character from 2 to 4 bytes. X11 fonts do not yet
2072	support these extra characters, but Xft does.	2113	support these extra characters, but Xft does.
…		…
2075	even without this flag, but the number of such characters is	2116	even without this flag, but the number of such characters is
2076	limited to a view thousand (shared with combining characters,	2117	limited to a view thousand (shared with combining characters,
2077	see next switch), and right now rxvt-unicode cannot display them	2118	see next switch), and right now rxvt-unicode cannot display them
2078	(input/output and cut&paste still work, though).	2119	(input/output and cut&paste still work, though).
2079		2120
2080	=item --enable-combining	2121	=item --enable-combining (default: on)
2081		2122
2082	Enable automatic composition of combining characters into	2123	Enable automatic composition of combining characters into
2083	composite characters. This is required for proper viewing of text	2124	composite characters. This is required for proper viewing of text
2084	where accents are encoded as seperate unicode characters. This is	2125	where accents are encoded as seperate unicode characters. This is
2085	done by using precomposited characters when available or creating	2126	done by using precomposited characters when available or creating
2086	new pseudo-characters when no precomposed form exists.	2127	new pseudo-characters when no precomposed form exists.
2087		2128
2088	Without --enable-unicode3, the number of additional precomposed	2129	Without --enable-unicode3, the number of additional precomposed
2089	characters is rather limited (2048, if this is full, rxvt will use the	2130	characters is somewhat limited (the 6400 private use characters will be
2090	private use area, extending the number of combinations to 8448). With	2131	(ab-)used). With --enable-unicode3, no practical limit exists.
2091	--enable-unicode3, no practical limit exists. This will also enable	2132
2092	storage of characters >65535.	2133	This option will also enable storage (but not display) of characters
		2134	beyond plane 0 (>65535) when --enable-unicode3 was not specified.
2093		2135
2094	The combining table also contains entries for arabic presentation forms,	2136	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.	2137	but these are not currently used. Bug me if you want these to be used (and
		2138	tell me how these are to be used...).
2096		2139
2097	=item --enable-fallback(=CLASS)	2140	=item --enable-fallback(=CLASS) (default: Rxvt)
2098		2141
2099	When reading resource settings, also read settings for class CLASS	2142	When reading resource settings, also read settings for class CLASS. To
2100	(default: Rxvt). To disable resource fallback use --disable-fallback.	2143	disable resource fallback use --disable-fallback.
2101		2144
2102	=item --with-res-name=NAME	2145	=item --with-res-name=NAME (default: urxvt)
2103		2146
2104	Use the given name (default: urxvt) as default application name when	2147	Use the given name as default application name when
2105	reading resources. Specify --with-res-name=rxvt to replace rxvt.	2148	reading resources. Specify --with-res-name=rxvt to replace rxvt.
2106		2149
2107	=item --with-res-class=CLASS	2150	=item --with-res-class=CLASS /default: URxvt)
2108		2151
2109	Use the given class (default: URxvt) as default application class	2152	Use the given class as default application class
2110	when reading resources. Specify --with-res-class=Rxvt to replace	2153	when reading resources. Specify --with-res-class=Rxvt to replace
2111	rxvt.	2154	rxvt.
2112		2155
2113	=item --enable-utmp	2156	=item --enable-utmp (default: on)
2114		2157
2115	Write user and tty to utmp file (used by programs like F<w>) at	2158	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.	2159	start of rxvt execution and delete information when rxvt exits.
2117		2160
2118	=item --enable-wtmp	2161	=item --enable-wtmp (default: on)
2119		2162
2120	Write user and tty to wtmp file (used by programs like F<last>) at	2163	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	2164	start of rxvt execution and write logout when rxvt exits. This
2122	option requires --enable-utmp to also be specified.	2165	option requires --enable-utmp to also be specified.
2123		2166
2124	=item --enable-lastlog	2167	=item --enable-lastlog (default: on)
2125		2168
2126	Write user and tty to lastlog file (used by programs like	2169	Write user and tty to lastlog file (used by programs like
2127	F<lastlogin>) at start of rxvt execution. This option requires	2170	F<lastlogin>) at start of rxvt execution. This option requires
2128	--enable-utmp to also be specified.	2171	--enable-utmp to also be specified.
2129		2172
2130	=item --enable-xpm-background	2173	=item --enable-xpm-background (default: on)
2131		2174
2132	Add support for XPM background pixmaps.	2175	Add support for XPM background pixmaps.
2133		2176
2134	=item --enable-transparency	2177	=item --enable-transparency (default: on)
2135		2178
2136	Add support for inheriting parent backgrounds thus giving a fake	2179	Add support for inheriting parent backgrounds thus giving a fake
2137	transparency to the term.	2180	transparency to the term.
2138		2181
2139	=item --enable-fading	2182	=item --enable-fading (default: on)
2140		2183
2141	Add support for fading the text when focus is lost.	2184	Add support for fading the text when focus is lost (requires C<--enable-transparency>).
2142		2185
2143	=item --enable-tinting	2186	=item --enable-tinting (default: on)
2144		2187
2145	Add support for tinting of transparent backgrounds.	2188	Add support for tinting of transparent backgrounds (requires C<--enable-transparency>).
2146		2189
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	2190	=item --enable-rxvt-scroll (default: on)
2153		2191
2154	Add support for the original rxvt scrollbar.	2192	Add support for the original rxvt scrollbar.
2155		2193
2156	=item --enable-next-scroll	2194	=item --enable-next-scroll (default: on)
2157		2195
2158	Add support for a NeXT-like scrollbar.	2196	Add support for a NeXT-like scrollbar.
2159		2197
2160	=item --enable-xterm-scroll	2198	=item --enable-xterm-scroll (default: on)
2161		2199
2162	Add support for an Xterm-like scrollbar.	2200	Add support for an Xterm-like scrollbar.
2163		2201
2164	=item --enable-plain-scroll	2202	=item --enable-plain-scroll (default: on)
2165		2203
2166	Add support for a very unobtrusive, plain-looking scrollbar that	2204	Add support for a very unobtrusive, plain-looking scrollbar that
2167	is the favourite of the rxvt-unicode author, having used it for	2205	is the favourite of the rxvt-unicode author, having used it for
2168	many years.	2206	many years.
2169		2207
2170	=item --enable-half-shadow	2208	=item --enable-ttygid (default: off)
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		2209
2177	Change tty device setting to group "tty" - only use this if	2210	Change tty device setting to group "tty" - only use this if
2178	your system uses this type of security.	2211	your system uses this type of security.
2179		2212
2180	=item --disable-backspace-key	2213	=item --disable-backspace-key
2181		2214
2182	Disable any handling of the backspace key by us - let the X server	2215	Removes any handling of the backspace key by us - let the X server do it.
		2216
		2217	=item --disable-delete-key
		2218
		2219	Removes any handling of the delete key by us - let the X server
2183	do it.	2220	do it.
2184		2221
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	2222	=item --disable-resources
2191		2223
2192	Remove all resources checking.	2224	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		2225
2208	=item --disable-swapscreen	2226	=item --disable-swapscreen
2209		2227
2210	Remove support for swap screen.	2228	Remove support for secondary/swap screen.
2211		2229
2212	=item --enable-frills	2230	=item --enable-frills (default: on)
2213		2231
2214	Add support for many small features that are not essential but nice to	2232	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	2233	have. Normally you want this, but for very small binaries you may want to
2216	disable this.	2234	disable this.
2217		2235
		2236	A non-exhaustive list of features enabled by C<--enable-frills> (possibly
		2237	in combination with other switches) is:
		2238
		2239	MWM-hints
		2240	EWMH-hints (pid, utf8 names) and protocols (ping)
		2241	seperate underline colour (-underlineColor)
		2242	settable border widths and borderless switch (-w, -b, -bl)
		2243	visual depth selection (-depth)
		2244	settable extra linespacing /-lsp)
		2245	iso-14755-2 and -3, and visual feedback
		2246	tripleclickwords (-tcw)
		2247	settable insecure mode (-insecure)
		2248	keysym remapping support
		2249	cursor blinking and underline cursor (-cb, -uc)
		2250	XEmbed support (-embed)
		2251	user-pty (-pty-fd)
		2252	hold on exit (-hold)
		2253	skip builtin block graphics (-sbg)
		2254
		2255	It also enabled some non-essential features otherwise disabled, such as:
		2256
		2257	some round-trip time optimisations
		2258	nearest color allocation on pseudocolor screens
		2259	UTF8_STRING supporr for selection
		2260	sgr modes 90..97 and 100..107
		2261	backindex and forwardindex escape sequences
		2262	view change/zero scorllback esacpe sequences
		2263	locale switching escape sequence
		2264	window op and some xterm/OSC escape sequences
		2265	rectangular selections
		2266	trailing space removal for selections
		2267	verbose X error handling
		2268
2218	=item --enable-iso14755	2269	=item --enable-iso14755 (default: on)
2219		2270
2220	Enable extended ISO 14755 support (see @@RXVT_NAME@@(1), or	2271	Enable extended ISO 14755 support (see @@RXVT_NAME@@(1), or
2221	F<doc/rxvt.1.txt>). Basic support (section 5.1) is enabled by	2272	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	2273	C<--enable-frills>, while support for 5.2, 5.3 and 5.4 is enabled with
2223	this switch.	2274	this switch.
2224		2275
2225	=item --enable-linespace
2226
2227	Add support to provide user specified line spacing between text rows.
2228
2229	=item --enable-keepscrolling	2276	=item --enable-keepscrolling (default: on)
2230		2277
2231	Add support for continual scrolling of the display when you hold	2278	Add support for continual scrolling of the display when you hold
2232	the mouse button down on a scrollbar arrow.	2279	the mouse button down on a scrollbar arrow.
2233		2280
2234	=item --enable-mousewheel	2281	=item --enable-mousewheel (default: on)
2235		2282
2236	Add support for scrolling via mouse wheel or buttons 4 & 5.	2283	Add support for scrolling via mouse wheel or buttons 4 & 5.
2237		2284
2238	=item --enable-slipwheeling	2285	=item --enable-slipwheeling (default: on)
2239		2286
2240	Add support for continual scrolling (using the mouse wheel as an	2287	Add support for continual scrolling (using the mouse wheel as an
2241	accelerator) while the control key is held down. This option	2288	accelerator) while the control key is held down. This option
2242	requires --enable-mousewheel to also be specified.	2289	requires --enable-mousewheel to also be specified.
2243		2290
2244	=item --disable-new-selection	2291	=item --disable-new-selection
2245		2292
2246	Remove support for mouse selection style like that of xterm.	2293	Remove support for mouse selection style like that of xterm.
2247		2294
2248	=item --enable-dmalloc	2295	=item --enable-dmalloc (default: off)
2249		2296
2250	Use Gray Watson's malloc - which is good for debugging See	2297	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	2298	L<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	2299	next option, you may need to edit src/Makefile after compiling to point
2253	DINCLUDE and DLIB to the right places.	2300	DINCLUDE and DLIB to the right places.
2254		2301
2255	You can only use either this option and the following (should	2302	You can only use either this option and the following (should
2256	you use either) .	2303	you use either) .
2257		2304
2258	=item --enable-dlmalloc	2305	=item --enable-dlmalloc (default: off)
2259		2306
2260	Use Doug Lea's malloc - which is good for a production version	2307	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.	2308	See L<http://g.oswego.edu/dl/html/malloc.html> for details.
2262		2309
2263	=item --enable-smart-resize	2310	=item --enable-smart-resize (default: on)
2264		2311
2265	Add smart growth/shrink behaviour when changing font size via from hot	2312	Add smart growth/shrink behaviour when changing font size via hot
2266	keys. This should keep in a fixed position the rxvt corner which is	2313	keys. This should keep the window corner which is closest to a corner of
2267	closest to a corner of the screen.	2314	the screen in a fixed position.
2268		2315
2269	=item --enable-cursor-blink
2270
2271	Add support for a blinking cursor.
2272
2273	=item --enable-pointer-blank	2316	=item --enable-pointer-blank (default: on)
2274		2317
2275	Add support to have the pointer disappear when typing or inactive.	2318	Add support to have the pointer disappear when typing or inactive.
2276		2319
2277	=item --with-name=NAME	2320	=item --enable-perl (default: on)
2278		2321
		2322	Enable an embedded perl interpreter. See the B<@@RXVT_NAME@@perl(3)>
		2323	manpage (F<doc/rxvtperl.txt>) for more info on this feature, or the files
		2324	in F<src/perl-ext/> for the extensions that are installed by default. The
		2325	perl interpreter that is used can be specified via the C<PERL> environment
		2326	variable when running configure.
		2327
		2328	=item --with-name=NAME (default: urxvt)
		2329
2279	Set the basename for the installed binaries (default: urxvt, resulting in	2330	Set the basename for the installed binaries, resulting
2280	urxvt, urxvtd etc.). Specify --with-name=rxvt to replace rxvt.	2331	in C<urxvt>, C<urxvtd> etc.). Specify C<--with-name=rxvt> to replace with
		2332	C<rxvt>.
2281		2333
2282	=item --with-term=NAME	2334	=item --with-term=NAME (default: rxvt-unicode)
2283		2335
2284	Change the environmental variable for the terminal to NAME (default	2336	Change the environmental variable for the terminal to NAME.
2285	"rxvt")
2286		2337
2287	=item --with-terminfo=PATH	2338	=item --with-terminfo=PATH
2288		2339
2289	Change the environmental variable for the path to the terminfo tree to	2340	Change the environmental variable for the path to the terminfo tree to
2290	PATH.	2341	PATH.

Diff Legend

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