*** empty log message ***
[dana/urxvt.git] / doc / rxvt.7.pod
1 =head1 NAME
2
3 RXVT REFERENCE - FAQ, command sequences and other background information
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
22 also available on the World Wide Web at
23 L<http://cvs.schmorp.de/browse/*checkout*/rxvt-unicode/doc/rxvt.7.html>.
24
25 =head1 FREQUENTLY ASKED QUESTIONS
26
27 =over 4
28
29 =item The new selection selects pieces that are too big, how can I select
30 single words?
31
32 Yes. For example, if you want to select alphanumeric words, you can use
33 the following resource:
34
35    URxvt.selection.pattern-0: ([[:word:]]+)
36
37 If you click more than twice, the selection will be extended
38 more and more.
39
40 To get a selection that is very similar to the old code, try this pattern:
41
42    URxvt.selection.pattern-0: ([^"&'()*,;<=>?@[\\\\]^`{|})]+)
43
44 Please also note that the I<LeftClick Shift-LeftClik> combination also
45 selects words like the old code.
46
47 =item I don't like the new selection/popups/hotkeys/perl, how do I
48 change/disable it?
49
50 You can disable the perl extension completely by setting the
51 B<perl-ext-common> resource to the empty string, which also keeps
52 rxvt-unicode from initialising perl, saving memory.
53
54 If you only want to disable specific features, you first have to
55 identify which perl extension is responsible. For this, read the section
56 B<PREPACKAGED EXTENSIONS> in the @@RXVT_NAME@@perl(3) manpage. For
57 example, to disable the B<selection-popup> and B<option-popup>, specify
58 this B<perl-ext-common> resource:
59
60    URxvt.perl-ext-common: default,-selection-popup,-option-popup
61
62 This will keep the default extensions, but disable the two popup
63 extensions. Some extensions can also be configured, for example,
64 scrollback search mode is triggered by B<M-s>. You can move it to any
65 other combination either by setting the B<searchable-scrollback> resource:
66
67    URxvt.searchable-scrollback: CM-s
68
69 =item Isn't rxvt supposed to be small? Don't all those features bloat?
70
71 I often get asked about this, and I think, no, they didn't cause extra
72 bloat. If you compare a minimal rxvt and a minimal urxvt, you can see
73 that the urxvt binary is larger (due to some encoding tables always being
74 compiled in), but it actually uses less memory (RSS) after startup. Even
75 with C<--disable-everything>, this comparison is a bit unfair, as many
76 features unique to urxvt (locale, encoding conversion, iso14755 etc.) are
77 already in use in this mode.
78
79     text    data     bss     drs     rss filename
80    98398    1664      24   15695    1824 rxvt --disable-everything
81   188985    9048   66616   18222    1788 urxvt --disable-everything
82
83 When you C<--enable-everything> (which _is_ unfair, as this involves xft
84 and full locale/XIM support which are quite bloaty inside libX11 and my
85 libc), the two diverge, but not unreasnobaly so.
86
87     text    data     bss     drs     rss filename
88   163431    2152      24   20123    2060 rxvt --enable-everything
89  1035683   49680   66648   29096    3680 urxvt --enable-everything
90
91 The very large size of the text section is explained by the east-asian
92 encoding tables, which, if unused, take up disk space but nothing else
93 and can be compiled out unless you rely on X11 core fonts that use those
94 encodings. The BSS size comes from the 64k emergency buffer that my c++
95 compiler allocates (but of course doesn't use unless you are out of
96 memory). Also, using an xft font instead of a core font immediately adds a
97 few megabytes of RSS. Xft indeed is responsible for a lot of RSS even when
98 not used.
99
100 Of course, due to every character using two or four bytes instead of one,
101 a large scrollback buffer will ultimately make rxvt-unicode use more
102 memory.
103
104 Compared to e.g. Eterm (5112k), aterm (3132k) and xterm (4680k), this
105 still fares rather well. And compared to some monsters like gnome-terminal
106 (21152k + extra 4204k in separate processes) or konsole (22200k + extra
107 43180k in daemons that stay around after exit, plus half a minute of
108 startup time, including the hundreds of warnings it spits out), it fares
109 extremely well *g*.
110
111 =item Why C++, isn't that unportable/bloated/uncool?
112
113 Is this a question? :) It comes up very often. The simple answer is: I had
114 to write it, and C++ allowed me to write and maintain it in a fraction
115 of the time and effort (which is a scarce resource for me). Put even
116 shorter: It simply wouldn't exist without C++.
117
118 My personal stance on this is that C++ is less portable than C, but in
119 the case of rxvt-unicode this hardly matters, as its portability limits
120 are defined by things like X11, pseudo terminals, locale support and unix
121 domain sockets, which are all less portable than C++ itself.
122
123 Regarding the bloat, see the above question: It's easy to write programs
124 in C that use gobs of memory, an certainly possible to write programs in
125 C++ that don't. C++ also often comes with large libraries, but this is
126 not necessarily the case with GCC. Here is what rxvt links against on my
127 system with a minimal config:
128
129    libX11.so.6 => /usr/X11R6/lib/libX11.so.6 (0x00002aaaaabc3000)
130    libc.so.6 => /lib/libc.so.6 (0x00002aaaaadde000)
131    libdl.so.2 => /lib/libdl.so.2 (0x00002aaaab01d000)
132    /lib64/ld-linux-x86-64.so.2 (0x00002aaaaaaab000)
133
134 And here is rxvt-unicode:
135
136    libX11.so.6 => /usr/X11R6/lib/libX11.so.6 (0x00002aaaaabc3000)
137    libgcc_s.so.1 => /lib/libgcc_s.so.1 (0x00002aaaaada2000)
138    libc.so.6 => /lib/libc.so.6 (0x00002aaaaaeb0000)     
139    libdl.so.2 => /lib/libdl.so.2 (0x00002aaaab0ee000)   
140    /lib64/ld-linux-x86-64.so.2 (0x00002aaaaaaab000)     
141
142 No large bloated libraries (of course, none were linked in statically),
143 except maybe libX11 :)
144
145 =item Does it support tabs, can I have a tabbed rxvt-unicode?
146
147 Beginning with version 7.3, there is a perl extension that implements a
148 simple tabbed terminal. It is installed by default, so any of these should
149 give you tabs:
150
151    @@RXVT_NAME@@ -pe tabbed
152
153    URxvt.perl-ext-common: default,tabbed
154
155 It will also work fine with tabbing functionality of many window managers
156 or similar tabbing programs, and its embedding-features allow it to be
157 embedded into other programs, as witnessed by F<doc/rxvt-tabbed> or
158 the upcoming C<Gtk2::URxvt> perl module, which features a tabbed urxvt
159 (murxvt) terminal as an example embedding application.
160
161 =item How do I know which rxvt-unicode version I'm using?
162
163 The version number is displayed with the usage (-h). Also the escape
164 sequence C<ESC [ 8 n> sets the window title to the version number. When
165 using the @@RXVT_NAME@@c client, the version displayed is that of the
166 daemon.
167
168 =item I am using Debian GNU/Linux and have a problem...
169
170 The Debian GNU/Linux package of rxvt-unicode in sarge contains large
171 patches that considerably change the behaviour of rxvt-unicode (but
172 unfortunately this notice has been removed). Before reporting a bug to
173 the original rxvt-unicode author please download and install the genuine
174 version (L<http://software.schmorp.de#rxvt-unicode>) and try to reproduce
175 the problem. If you cannot, chances are that the problems are specific to
176 Debian GNU/Linux, in which case it should be reported via the Debian Bug
177 Tracking System (use C<reportbug> to report the bug).
178
179 For other problems that also affect the Debian package, you can and
180 probably should use the Debian BTS, too, because, after all, it's also a
181 bug in the Debian version and it serves as a reminder for other users that
182 might encounter the same issue.
183
184 =item I am maintaining rxvt-unicode for distribution/OS XXX, any
185 recommendation?
186
187 You should build one binary with the default options. F<configure>
188 now enables most useful options, and the trend goes to making them
189 runtime-switchable, too, so there is usually no drawback to enbaling them,
190 except higher disk and possibly memory usage. The perl interpreter should
191 be enabled, as important functionality (menus, selection, likely more in
192 the future) depends on it.
193
194 You should not overwrite the C<perl-ext-common> snd C<perl-ext> resources
195 system-wide (except maybe with C<defaults>). This will result in useful
196 behaviour. If your distribution aims at low memory, add an empty
197 C<perl-ext-common> resource to the app-defaults file. This will keep the
198 perl interpreter disabled until the user enables it.
199
200 If you can/want build more binaries, I recommend building a minimal
201 one with C<--disable-everything> (very useful) and a maximal one with
202 C<--enable-everything> (less useful, it will be very big due to a lot of
203 encodings built-in that increase download times and are rarely used).
204
205 =item I need to make it setuid/setgid to support utmp/ptys on my OS, is this safe?
206
207 It should be, starting with release 7.1. You are encouraged to properly
208 install urxvt with privileges necessary for your OS now.
209
210 When rxvt-unicode detects that it runs setuid or setgid, it will fork
211 into a helper process for privileged operations (pty handling on some
212 systems, utmp/wtmp/lastlog handling on others) and drop privileges
213 immediately. This is much safer than most other terminals that keep
214 privileges while running (but is more relevant to urxvt, as it contains
215 things as perl interpreters, which might be "helpful" to attackers).
216
217 This forking is done as the very first within main(), which is very early
218 and reduces possible bugs to initialisation code run before main(), or
219 things like the dynamic loader of your system, which should result in very
220 little risk.
221
222 =item When I log-in to another system it tells me about missing terminfo data?
223
224 The terminal description used by rxvt-unicode is not as widely available
225 as that for xterm, or even rxvt (for which the same problem often arises).
226
227 The correct solution for this problem is to install the terminfo, this can
228 be done like this (with ncurses' infocmp):
229
230    REMOTE=remotesystem.domain
231    infocmp rxvt-unicode | ssh $REMOTE "cat >/tmp/ti && tic /tmp/ti"
232
233 ... or by installing rxvt-unicode normally on the remote system,
234
235 If you cannot or do not want to do this, then you can simply set
236 C<TERM=rxvt> or even C<TERM=xterm>, and live with the small number of
237 problems arising, which includes wrong keymapping, less and different
238 colours and some refresh errors in fullscreen applications. It's a nice
239 quick-and-dirty workaround for rare cases, though.
240
241 If you always want to do this (and are fine with the consequences) you
242 can either recompile rxvt-unicode with the desired TERM value or use a
243 resource to set it:
244
245    URxvt.termName: rxvt
246
247 If you don't plan to use B<rxvt> (quite common...) you could also replace
248 the rxvt terminfo file with the rxvt-unicode one.
249
250 =item C<tic> outputs some error when compiling the terminfo entry.
251
252 Most likely it's the empty definition for C<enacs=>. Just replace it by
253 C<enacs=\E[0@> and try again.
254
255 =item C<bash>'s readline does not work correctly under @@RXVT_NAME@@.
256
257 =item I need a termcap file entry.
258
259 One reason you might want this is that some distributions or operating
260 systems still compile some programs using the long-obsoleted termcap
261 library (Fedora Core's bash is one example) and rely on a termcap entry
262 for C<rxvt-unicode>.
263
264 You could use rxvt's termcap entry with resonable results in many cases.
265 You can also create a termcap entry by using terminfo's infocmp program
266 like this:
267
268    infocmp -C rxvt-unicode
269
270 Or you could use this termcap entry, generated by the command above:
271
272    rxvt-unicode|rxvt-unicode terminal (X Window System):\
273            :am:bw:eo:km:mi:ms:xn:xo:\
274            :co#80:it#8:li#24:lm#0:\
275            :AL=\E[%dL:DC=\E[%dP:DL=\E[%dM:DO=\E[%dB:IC=\E[%d@:\
276            :K1=\EOw:K2=\EOu:K3=\EOy:K4=\EOq:K5=\EOs:LE=\E[%dD:\
277            :RI=\E[%dC:SF=\E[%dS:SR=\E[%dT:UP=\E[%dA:ae=\E(B:al=\E[L:\
278            :as=\E(0:bl=^G:cd=\E[J:ce=\E[K:cl=\E[H\E[2J:\
279            :cm=\E[%i%d;%dH:cr=^M:cs=\E[%i%d;%dr:ct=\E[3g:dc=\E[P:\
280            :dl=\E[M:do=^J:ec=\E[%dX:ei=\E[4l:ho=\E[H:\
281            :i1=\E[?47l\E=\E[?1l:ic=\E[@:im=\E[4h:\
282            :is=\E[r\E[m\E[2J\E[H\E[?7h\E[?1;3;4;6l\E[4l:\
283            :k1=\E[11~:k2=\E[12~:k3=\E[13~:k4=\E[14~:k5=\E[15~:\
284            :k6=\E[17~:k7=\E[18~:k8=\E[19~:k9=\E[20~:kD=\E[3~:\
285            :kI=\E[2~:kN=\E[6~:kP=\E[5~:kb=\177:kd=\EOB:ke=\E[?1l\E>:\
286            :kh=\E[7~:kl=\EOD:kr=\EOC:ks=\E[?1h\E=:ku=\EOA:le=^H:\
287            :mb=\E[5m:md=\E[1m:me=\E[m\017:mr=\E[7m:nd=\E[C:rc=\E8:\
288            :sc=\E7:se=\E[27m:sf=^J:so=\E[7m:sr=\EM:st=\EH:ta=^I:\
289            :te=\E[r\E[?1049l:ti=\E[?1049h:ue=\E[24m:up=\E[A:\
290            :us=\E[4m:vb=\E[?5h\E[?5l:ve=\E[?25h:vi=\E[?25l:\
291            :vs=\E[?25h:
292
293 =item Why does C<ls> no longer have coloured output?
294
295 The C<ls> in the GNU coreutils unfortunately doesn't use terminfo to
296 decide wether a terminal has colour, but uses it's own configuration
297 file. Needless to say, C<rxvt-unicode> is not in it's default file (among
298 with most other terminals supporting colour). Either add:
299
300    TERM rxvt-unicode
301
302 to C</etc/DIR_COLORS> or simply add:
303
304    alias ls='ls --color=auto'
305
306 to your C<.profile> or C<.bashrc>.
307
308 =item Why doesn't vim/emacs etc. use the 88 colour mode?
309
310 =item Why doesn't vim/emacs etc. make use of italic?
311
312 =item Why are the secondary screen-related options not working properly?
313
314 Make sure you are using C<TERM=rxvt-unicode>. Some pre-packaged
315 distributions (most notably Debian GNU/Linux) break rxvt-unicode
316 by setting C<TERM> to C<rxvt>, which doesn't have these extra
317 features. Unfortunately, some of these (most notably, again, Debian
318 GNU/Linux) furthermore fail to even install the C<rxvt-unicode> terminfo
319 file, so you will need to install it on your own (See the question B<When
320 I log-in to another system it tells me about missing terminfo data?> on
321 how to do this).
322
323 =item My numerical keypad acts weird and generates differing output?
324
325 Some Debian GNUL/Linux users seem to have this problem, although no
326 specific details were reported so far. It is possible that this is caused
327 by the wrong C<TERM> setting, although the details of wether and how
328 this can happen are unknown, as C<TERM=rxvt> should offer a compatible
329 keymap. See the answer to the previous question, and please report if that
330 helped.
331
332 =item Rxvt-unicode does not seem to understand the selected encoding?
333
334 =item Unicode does not seem to work?
335
336 If you encounter strange problems like typing an accented character but
337 getting two unrelated other characters or similar, or if program output is
338 subtly garbled, then you should check your locale settings.
339
340 Rxvt-unicode must be started with the same C<LC_CTYPE> setting as the
341 programs. Often rxvt-unicode is started in the C<C> locale, while the
342 login script running within the rxvt-unicode window changes the locale to
343 something else, e.g. C<en_GB.UTF-8>. Needless to say, this is not going to work.
344
345 The best thing is to fix your startup environment, as you will likely run
346 into other problems. If nothing works you can try this in your .profile.
347
348   printf '\e]701;%s\007' "$LC_CTYPE"
349
350 If this doesn't work, then maybe you use a C<LC_CTYPE> specification not
351 supported on your systems. Some systems have a C<locale> command which
352 displays this (also, C<perl -e0> can be used to check locale settings, as
353 it will complain loudly if it cannot set the locale). If it displays something
354 like:
355
356   locale: Cannot set LC_CTYPE to default locale: ...
357
358 Then the locale you specified is not supported on your system.
359
360 If nothing works and you are sure that everything is set correctly then
361 you will need to remember a little known fact: Some programs just don't
362 support locales :(
363
364 =item Why do some characters look so much different than others?
365
366 =item How does rxvt-unicode choose fonts?
367
368 Most fonts do not contain the full range of Unicode, which is
369 fine. Chances are that the font you (or the admin/package maintainer of
370 your system/os) have specified does not cover all the characters you want
371 to display.
372
373 B<rxvt-unicode> makes a best-effort try at finding a replacement
374 font. Often the result is fine, but sometimes the chosen font looks
375 bad/ugly/wrong. Some fonts have totally strange characters that don't
376 resemble the correct glyph at all, and rxvt-unicode lacks the artificial
377 intelligence to detect that a specific glyph is wrong: it has to believe
378 the font that the characters it claims to contain indeed look correct.
379
380 In that case, select a font of your taste and add it to the font list,
381 e.g.:
382
383    @@RXVT_NAME@@ -fn basefont,font2,font3...
384
385 When rxvt-unicode sees a character, it will first look at the base
386 font. If the base font does not contain the character, it will go to the
387 next font, and so on. Specifying your own fonts will also speed up this
388 search and use less resources within rxvt-unicode and the X-server.
389
390 The only limitation is that none of the fonts may be larger than the base
391 font, as the base font defines the terminal character cell size, which
392 must be the same due to the way terminals work.
393
394 =item Why do some chinese characters look so different than others?
395
396 This is because there is a difference between script and language --
397 rxvt-unicode does not know which language the text that is output is,
398 as it only knows the unicode character codes. If rxvt-unicode first
399 sees a japanese/chinese character, it might choose a japanese font for
400 display. Subsequent japanese characters will use that font. Now, many
401 chinese characters aren't represented in japanese fonts, so when the first
402 non-japanese character comes up, rxvt-unicode will look for a chinese font
403 -- unfortunately at this point, it will still use the japanese font for
404 chinese characters that are also in the japanese font.
405
406 The workaround is easy: just tag a chinese font at the end of your font
407 list (see the previous question). The key is to view the font list as
408 a preference list: If you expect more japanese, list a japanese font
409 first. If you expect more chinese, put a chinese font first.
410
411 In the future it might be possible to switch language preferences at
412 runtime (the internal data structure has no problem with using different
413 fonts for the same character at the same time, but no interface for this
414 has been designed yet).
415
416 Until then, you might get away with switching fonts at runtime (see L<Can
417 I switch the fonts at runtime?> later in this document).
418
419 =item Why does rxvt-unicode sometimes leave pixel droppings?
420
421 Most fonts were not designed for terminal use, which means that character
422 size varies a lot. A font that is otherwise fine for terminal use might
423 contain some characters that are simply too wide. Rxvt-unicode will avoid
424 these characters. For characters that are just "a bit" too wide a special
425 "careful" rendering mode is used that redraws adjacent characters.
426
427 All of this requires that fonts do not lie about character sizes,
428 however: Xft fonts often draw glyphs larger than their acclaimed bounding
429 box, and rxvt-unicode has no way of detecting this (the correct way is to
430 ask for the character bounding box, which unfortunately is wrong in these
431 cases).
432
433 It's not clear (to me at least), wether this is a bug in Xft, freetype,
434 or the respective font. If you encounter this problem you might try using
435 the C<-lsp> option to give the font more height. If that doesn't work, you
436 might be forced to use a different font.
437
438 All of this is not a problem when using X11 core fonts, as their bounding
439 box data is correct.
440
441 =item On Solaris 9, many line-drawing characters are too wide.
442
443 Seems to be a known bug, read
444 L<http://nixdoc.net/files/forum/about34198.html>. Some people use the
445 following ugly workaround to get non-double-wide-characters working:
446
447    #define wcwidth(x) wcwidth(x) > 1 ? 1 : wcwidth(x)
448
449 =item My Compose (Multi_key) key is no longer working.
450
451 The most common causes for this are that either your locale is not set
452 correctly, or you specified a B<preeditStyle> that is not supported by
453 your input method. For example, if you specified B<OverTheSpot> and
454 your input method (e.g. the default input method handling Compose keys)
455 does not support this (for instance because it is not visual), then
456 rxvt-unicode will continue without an input method.
457
458 In this case either do not specify a B<preeditStyle> or specify more than
459 one pre-edit style, such as B<OverTheSpot,Root,None>.
460
461 =item I cannot type C<Ctrl-Shift-2> to get an ASCII NUL character due to ISO 14755
462
463 Either try C<Ctrl-2> alone (it often is mapped to ASCII NUL even on
464 international keyboards) or simply use ISO 14755 support to your
465 advantage, typing <Ctrl-Shift-0> to get a ASCII NUL. This works for other
466 codes, too, such as C<Ctrl-Shift-1-d> to type the default telnet escape
467 character and so on.
468
469 =item How can I keep rxvt-unicode from using reverse video so much?
470
471 First of all, make sure you are running with the right terminal settings
472 (C<TERM=rxvt-unicode>), which will get rid of most of these effects. Then
473 make sure you have specified colours for italic and bold, as otherwise
474 rxvt-unicode might use reverse video to simulate the effect:
475
476    URxvt.colorBD:  white
477    URxvt.colorIT:  green
478
479 =item Some programs assume totally weird colours (red instead of blue), how can I fix that?
480
481 For some unexplainable reason, some rare programs assume a very weird
482 colour palette when confronted with a terminal with more than the standard
483 8 colours (rxvt-unicode supports 88). The right fix is, of course, to fix
484 these programs not to assume non-ISO colours without very good reasons.
485
486 In the meantime, you can either edit your C<rxvt-unicode> terminfo
487 definition to only claim 8 colour support or use C<TERM=rxvt>, which will
488 fix colours but keep you from using other rxvt-unicode features.
489
490 =item I am on FreeBSD and rxvt-unicode does not seem to work at all.
491
492 Rxvt-unicode requires the symbol C<__STDC_ISO_10646__> to be defined
493 in your compile environment, or an implementation that implements it,
494 wether it defines the symbol or not. C<__STDC_ISO_10646__> requires that
495 B<wchar_t> is represented as unicode.
496
497 As you might have guessed, FreeBSD does neither define this symobl nor
498 does it support it. Instead, it uses it's own internal representation of
499 B<wchar_t>. This is, of course, completely fine with respect to standards.
500
501 However, that means rxvt-unicode only works in C<POSIX>, C<ISO-8859-1> and
502 C<UTF-8> locales under FreeBSD (which all use Unicode as B<wchar_t>.
503
504 C<__STDC_ISO_10646__> is the only sane way to support multi-language
505 apps in an OS, as using a locale-dependent (and non-standardized)
506 representation of B<wchar_t> makes it impossible to convert between
507 B<wchar_t> (as used by X11 and your applications) and any other encoding
508 without implementing OS-specific-wrappers for each and every locale. There
509 simply are no APIs to convert B<wchar_t> into anything except the current
510 locale encoding.
511
512 Some applications (such as the formidable B<mlterm>) work around this
513 by carrying their own replacement functions for character set handling
514 with them, and either implementing OS-dependent hacks or doing multiple
515 conversions (which is slow and unreliable in case the OS implements
516 encodings slightly different than the terminal emulator).
517
518 The rxvt-unicode author insists that the right way to fix this is in the
519 system libraries once and for all, instead of forcing every app to carry
520 complete replacements for them :)
521
522 =item I use Solaris 9 and it doesn't compile/work/etc.
523
524 Try the diff in F<doc/solaris9.patch> as a base. It fixes the worst
525 problems with C<wcwidth> and a compile problem.
526
527 =item How can I use rxvt-unicode under cygwin?
528
529 rxvt-unicode should compile and run out of the box on cygwin, using
530 the X11 libraries that come with cygwin. libW11 emulation is no
531 longer supported (and makes no sense, either, as it only supported a
532 single font). I recommend starting the X-server in C<-multiwindow> or
533 C<-rootless> mode instead, which will result in similar look&feel as the
534 old libW11 emulation.
535
536 At the time of this writing, cygwin didn't seem to support any multi-byte
537 encodings (you might try C<LC_CTYPE=C-UTF-8>), so you are likely limited
538 to 8-bit encodings.
539
540 =item How does rxvt-unicode determine the encoding to use?
541
542 =item Is there an option to switch encodings?
543
544 Unlike some other terminals, rxvt-unicode has no encoding switch, and no
545 specific "utf-8" mode, such as xterm. In fact, it doesn't even know about
546 UTF-8 or any other encodings with respect to terminal I/O.
547
548 The reasons is that there exists a perfectly fine mechanism for selecting
549 the encoding, doing I/O and (most important) communicating this to all
550 applications so everybody agrees on character properties such as width
551 and code number. This mechanism is the I<locale>. Applications not using
552 that info will have problems (for example, C<xterm> gets the width of
553 characters wrong as it uses it's own, locale-independent table under all
554 locales).
555
556 Rxvt-unicode uses the C<LC_CTYPE> locale category to select encoding. All
557 programs doing the same (that is, most) will automatically agree in the
558 interpretation of characters.
559
560 Unfortunately, there is no system-independent way to select locales, nor
561 is there a standard on how locale specifiers will look like.
562
563 On most systems, the content of the C<LC_CTYPE> environment variable
564 contains an arbitrary string which corresponds to an already-installed
565 locale. Common names for locales are C<en_US.UTF-8>, C<de_DE.ISO-8859-15>,
566 C<ja_JP.EUC-JP>, i.e. C<language_country.encoding>, but other forms
567 (i.e. C<de> or C<german>) are also common.
568
569 Rxvt-unicode ignores all other locale categories, and except for
570 the encoding, ignores country or language-specific settings,
571 i.e. C<de_DE.UTF-8> and C<ja_JP.UTF-8> are the normally same to
572 rxvt-unicode.
573
574 If you want to use a specific encoding you have to make sure you start
575 rxvt-unicode with the correct C<LC_CTYPE> category.
576
577 =item Can I switch locales at runtime?
578
579 Yes, using an escape sequence. Try something like this, which sets
580 rxvt-unicode's idea of C<LC_CTYPE>.
581
582   printf '\e]701;%s\007' ja_JP.SJIS
583
584 See also the previous answer.
585
586 Sometimes this capability is rather handy when you want to work in
587 one locale (e.g. C<de_DE.UTF-8>) but some programs don't support it
588 (e.g. UTF-8). For example, I use this script to start C<xjdic>, which
589 first switches to a locale supported by xjdic and back later:
590
591    printf '\e]701;%s\007' ja_JP.SJIS
592    xjdic -js
593    printf '\e]701;%s\007' de_DE.UTF-8
594
595 You can also use xterm's C<luit> program, which usually works fine, except
596 for some locales where character width differs between program- and
597 rxvt-unicode-locales.
598
599 =item Can I switch the fonts at runtime?
600
601 Yes, using an escape sequence. Try something like this, which has the same
602 effect as using the C<-fn> switch, and takes effect immediately:
603
604    printf '\e]50;%s\007' "9x15bold,xft:Kochi Gothic"
605
606 This is useful if you e.g. work primarily with japanese (and prefer a
607 japanese font), but you have to switch to chinese temporarily, where
608 japanese fonts would only be in your way.
609
610 You can think of this as a kind of manual ISO-2022 switching.
611
612 =item Why do italic characters look as if clipped?
613
614 Many fonts have difficulties with italic characters and hinting. For
615 example, the otherwise very nicely hinted font C<xft:Bitstream Vera Sans
616 Mono> completely fails in it's italic face. A workaround might be to
617 enable freetype autohinting, i.e. like this:
618
619    URxvt.italicFont:        xft:Bitstream Vera Sans Mono:italic:autohint=true
620    URxvt.boldItalicFont:    xft:Bitstream Vera Sans Mono:bold:italic:autohint=true
621
622 =item My input method wants <some encoding> but I want UTF-8, what can I do?
623
624 You can specify separate locales for the input method and the rest of the
625 terminal, using the resource C<imlocale>:
626
627    URxvt.imlocale: ja_JP.EUC-JP
628
629 Now you can start your terminal with C<LC_CTYPE=ja_JP.UTF-8> and still
630 use your input method. Please note, however, that you will not be able to
631 input characters outside C<EUC-JP> in a normal way then, as your input
632 method limits you.
633
634 =item Rxvt-unicode crashes when the X Input Method changes or exits.
635
636 Unfortunately, this is unavoidable, as the XIM protocol is racy by
637 design. Applications can avoid some crashes at the expense of memory
638 leaks, and Input Methods can avoid some crashes by careful ordering at
639 exit time. B<kinput2> (and derived input methods) generally succeeds,
640 while B<SCIM> (or similar input methods) fails. In the end, however,
641 crashes cannot be completely avoided even if both sides cooperate.
642
643 So the only workaround is not to kill your Input Method Servers.
644
645 =item Rxvt-unicode uses gobs of memory, how can I reduce that?
646
647 Rxvt-unicode tries to obey the rule of not charging you for something you
648 don't use. One thing you should try is to configure out all settings that
649 you don't need, for example, Xft support is a resource hog by design,
650 when used. Compiling it out ensures that no Xft font will be loaded
651 accidentally when rxvt-unicode tries to find a font for your characters.
652
653 Also, many people (me included) like large windows and even larger
654 scrollback buffers: Without C<--enable-unicode3>, rxvt-unicode will use
655 6 bytes per screen cell. For a 160x?? window this amounts to almost a
656 kilobyte per line. A scrollback buffer of 10000 lines will then (if full)
657 use 10 Megabytes of memory. With C<--enable-unicode3> it gets worse, as
658 rxvt-unicode then uses 8 bytes per screen cell.
659
660 =item Can I speed up Xft rendering somehow?
661
662 Yes, the most obvious way to speed it up is to avoid Xft entirely, as
663 it is simply slow. If you still want Xft fonts you might try to disable
664 antialiasing (by appending C<:antialias=false>), which saves lots of
665 memory and also speeds up rendering considerably.
666
667 =item Rxvt-unicode doesn't seem to anti-alias its fonts, what is wrong?
668
669 Rxvt-unicode will use whatever you specify as a font. If it needs to
670 fall back to it's default font search list it will prefer X11 core
671 fonts, because they are small and fast, and then use Xft fonts. It has
672 antialiasing disabled for most of them, because the author thinks they
673 look best that way.
674
675 If you want antialiasing, you have to specify the fonts manually.
676
677 =item Mouse cut/paste suddenly no longer works.
678
679 Make sure that mouse reporting is actually turned off since killing
680 some editors prematurely may leave the mouse in mouse report mode. I've
681 heard that tcsh may use mouse reporting unless it otherwise specified. A
682 quick check is to see if cut/paste works when the Alt or Shift keys are
683 depressed.
684
685 =item What's with this bold/blink stuff?
686
687 If no bold colour is set via C<colorBD:>, bold will invert text using the
688 standard foreground colour.
689
690 For the standard background colour, blinking will actually make the
691 text blink when compiled with C<--enable-blinking>. with standard
692 colours. Without C<--enable-blinking>, the blink attribute will be
693 ignored.
694
695 On ANSI colours, bold/blink attributes are used to set high-intensity
696 foreground/background colors.
697
698 color0-7 are the low-intensity colors.
699
700 color8-15 are the corresponding high-intensity colors.
701
702 =item I don't like the screen colors.  How do I change them?
703
704 You can change the screen colors at run-time using F<~/.Xdefaults>
705 resources (or as long-options).
706
707 Here are values that are supposed to resemble a VGA screen,
708 including the murky brown that passes for low-intensity yellow:
709
710    URxvt.color0:   #000000
711    URxvt.color1:   #A80000
712    URxvt.color2:   #00A800
713    URxvt.color3:   #A8A800
714    URxvt.color4:   #0000A8
715    URxvt.color5:   #A800A8
716    URxvt.color6:   #00A8A8
717    URxvt.color7:   #A8A8A8
718
719    URxvt.color8:   #000054
720    URxvt.color9:   #FF0054
721    URxvt.color10:  #00FF54
722    URxvt.color11:  #FFFF54
723    URxvt.color12:  #0000FF
724    URxvt.color13:  #FF00FF
725    URxvt.color14:  #00FFFF
726    URxvt.color15:  #FFFFFF
727
728 And here is a more complete set of non-standard colors described (not by
729 me) as "pretty girly".
730
731    URxvt.cursorColor:  #dc74d1
732    URxvt.pointerColor: #dc74d1
733    URxvt.background:   #0e0e0e
734    URxvt.foreground:   #4ad5e1
735    URxvt.color0:       #000000
736    URxvt.color8:       #8b8f93
737    URxvt.color1:       #dc74d1
738    URxvt.color9:       #dc74d1
739    URxvt.color2:       #0eb8c7
740    URxvt.color10:      #0eb8c7
741    URxvt.color3:       #dfe37e
742    URxvt.color11:      #dfe37e
743    URxvt.color5:       #9e88f0
744    URxvt.color13:      #9e88f0
745    URxvt.color6:       #73f7ff
746    URxvt.color14:      #73f7ff
747    URxvt.color7:       #e1dddd
748    URxvt.color15:      #e1dddd
749
750 =item How can I start @@RXVT_NAME@@d in a race-free way?
751
752 Try C<@@RXVT_NAME@@d -f -o>, which tells @@RXVT_NAME@@d to open the
753 display, create the listening socket and then fork.
754
755 =item What's with the strange Backspace/Delete key behaviour?
756
757 Assuming that the physical Backspace key corresponds to the
758 BackSpace keysym (not likely for Linux ... see the following
759 question) there are two standard values that can be used for
760 Backspace: C<^H> and C<^?>.
761
762 Historically, either value is correct, but rxvt-unicode adopts the debian
763 policy of using C<^?> when unsure, because it's the one only only correct
764 choice :).
765
766 Rxvt-unicode tries to inherit the current stty settings and uses the value
767 of `erase' to guess the value for backspace.  If rxvt-unicode wasn't
768 started from a terminal (say, from a menu or by remote shell), then the
769 system value of `erase', which corresponds to CERASE in <termios.h>, will
770 be used (which may not be the same as your stty setting).
771
772 For starting a new rxvt-unicode:
773
774    # use Backspace = ^H
775    $ stty erase ^H
776    $ @@RXVT_NAME@@
777
778    # use Backspace = ^?
779    $ stty erase ^?
780    $ @@RXVT_NAME@@
781
782 Toggle with C<ESC [ 36 h> / C<ESC [ 36 l>.
783
784 For an existing rxvt-unicode:
785
786    # use Backspace = ^H
787    $ stty erase ^H
788    $ echo -n "^[[36h"
789
790    # use Backspace = ^?
791    $ stty erase ^?
792    $ echo -n "^[[36l"
793
794 This helps satisfy some of the Backspace discrepancies that occur, but
795 if you use Backspace = C<^H>, make sure that the termcap/terminfo value
796 properly reflects that.
797
798 The Delete key is a another casualty of the ill-defined Backspace problem.
799 To avoid confusion between the Backspace and Delete keys, the Delete
800 key has been assigned an escape sequence to match the vt100 for Execute
801 (C<ESC [ 3 ~>) and is in the supplied termcap/terminfo.
802
803 Some other Backspace problems:
804
805 some editors use termcap/terminfo,
806 some editors (vim I'm told) expect Backspace = ^H,
807 GNU Emacs (and Emacs-like editors) use ^H for help.
808
809 Perhaps someday this will all be resolved in a consistent manner.
810
811 =item I don't like the key-bindings.  How do I change them?
812
813 There are some compile-time selections available via configure. Unless
814 you have run "configure" with the C<--disable-resources> option you can
815 use the `keysym' resource to alter the keystrings associated with keysyms.
816
817 Here's an example for a URxvt session started using C<@@RXVT_NAME@@ -name URxvt>
818
819    URxvt.keysym.Home:          \033[1~
820    URxvt.keysym.End:           \033[4~
821    URxvt.keysym.C-apostrophe:  \033<C-'>
822    URxvt.keysym.C-slash:       \033<C-/>
823    URxvt.keysym.C-semicolon:   \033<C-;>
824    URxvt.keysym.C-grave:       \033<C-`>
825    URxvt.keysym.C-comma:       \033<C-,>
826    URxvt.keysym.C-period:      \033<C-.>
827    URxvt.keysym.C-0x60:        \033<C-`>
828    URxvt.keysym.C-Tab:         \033<C-Tab>
829    URxvt.keysym.C-Return:      \033<C-Return>
830    URxvt.keysym.S-Return:      \033<S-Return>
831    URxvt.keysym.S-space:       \033<S-Space>
832    URxvt.keysym.M-Up:          \033<M-Up>
833    URxvt.keysym.M-Down:        \033<M-Down>
834    URxvt.keysym.M-Left:        \033<M-Left>
835    URxvt.keysym.M-Right:       \033<M-Right>
836    URxvt.keysym.M-C-0:         list \033<M-C- 0123456789 >
837    URxvt.keysym.M-C-a:         list \033<M-C- abcdefghijklmnopqrstuvwxyz >
838    URxvt.keysym.F12:           command:\033]701;zh_CN.GBK\007
839
840 See some more examples in the documentation for the B<keysym> resource.
841
842 =item I'm using keyboard model XXX that has extra Prior/Next/Insert keys.
843 How do I make use of them?  For example, the Sun Keyboard type 4
844 has the following mappings that rxvt-unicode doesn't recognize.
845
846    KP_Insert == Insert
847    F22 == Print
848    F27 == Home
849    F29 == Prior
850    F33 == End
851    F35 == Next
852
853 Rather than have rxvt-unicode try to accommodate all the various possible
854 keyboard mappings, it is better to use `xmodmap' to remap the keys as
855 required for your particular machine.
856
857 =item How do I distinguish wether I'm running rxvt-unicode or a regular xterm?
858 I need this to decide about setting colors etc.
859
860 rxvt and rxvt-unicode always export the variable "COLORTERM", so you can
861 check and see if that is set. Note that several programs, JED, slrn,
862 Midnight Commander automatically check this variable to decide whether or
863 not to use color.
864
865 =item How do I set the correct, full IP address for the DISPLAY variable?
866
867 If you've compiled rxvt-unicode with DISPLAY_IS_IP and have enabled
868 insecure mode then it is possible to use the following shell script
869 snippets to correctly set the display. If your version of rxvt-unicode
870 wasn't also compiled with ESCZ_ANSWER (as assumed in these snippets) then
871 the COLORTERM variable can be used to distinguish rxvt-unicode from a
872 regular xterm.
873
874 Courtesy of Chuck Blake <cblake@BBN.COM> with the following shell script
875 snippets:
876
877    # Bourne/Korn/POSIX family of shells:
878    [ ${TERM:-foo} = foo ] && TERM=xterm # assume an xterm if we don't know
879    if [ ${TERM:-foo} = xterm ]; then
880       stty -icanon -echo min 0 time 15 # see if enhanced rxvt or not
881       echo -n '^[Z'
882       read term_id
883       stty icanon echo
884       if [ ""${term_id} = '^[[?1;2C' -a ${DISPLAY:-foo} = foo ]; then
885          echo -n '^[[7n'        # query the rxvt we are in for the DISPLAY string
886          read DISPLAY           # set it in our local shell
887       fi
888    fi
889
890 =item How do I compile the manual pages for myself?
891
892 You need to have a recent version of perl installed as F</usr/bin/perl>,
893 one that comes with F<pod2man>, F<pod2text> and F<pod2html>. Then go to
894 the doc subdirectory and enter C<make alldoc>.
895
896 =item My question isn't answered here, can I ask a human?
897
898 Before sending me mail, you could go to IRC: C<irc.freenode.net>,
899 channel C<#rxvt-unicode> has some rxvt-unicode enthusiasts that might be
900 interested in learning about new and exciting problems (but not FAQs :).
901
902 =back
903
904 =head1 RXVT TECHNICAL REFERENCE
905
906 =head1 DESCRIPTION
907
908 The rest of this document describes various technical aspects of
909 B<rxvt-unicode>. First the description of supported command sequences,
910 followed by pixmap support and last by a description of all features
911 selectable at C<configure> time.
912
913 =head1 Definitions
914
915 =over 4
916
917 =item B<< C<c> >>
918
919 The literal character c.
920
921 =item B<< C<C> >>
922
923 A single (required) character.
924
925 =item B<< C<Ps> >>
926
927 A single (usually optional) numeric parameter, composed of one or more
928 digits.
929
930 =item B<< C<Pm> >>
931
932 A multiple numeric parameter composed of any number of single numeric
933 parameters, separated by C<;> character(s).
934
935 =item B<< C<Pt> >>
936
937 A text parameter composed of printable characters.
938
939 =back
940
941 =head1 Values
942
943 =over 4
944
945 =item B<< C<ENQ> >>
946
947 Enquiry (Ctrl-E) = Send Device Attributes (DA)
948 request attributes from terminal. See B<< C<ESC [ Ps c> >>.
949
950 =item B<< C<BEL> >>
951
952 Bell (Ctrl-G)
953
954 =item B<< C<BS> >>
955
956 Backspace (Ctrl-H)
957
958 =item B<< C<TAB> >>
959
960 Horizontal Tab (HT) (Ctrl-I)
961
962 =item B<< C<LF> >>
963
964 Line Feed or New Line (NL) (Ctrl-J)
965
966 =item B<< C<VT> >>
967
968 Vertical Tab (Ctrl-K) same as B<< C<LF> >>
969
970 =item B<< C<FF> >>
971
972 Form Feed or New Page (NP) (Ctrl-L) same as B<< C<LF> >>
973
974 =item B<< C<CR> >>
975
976 Carriage Return (Ctrl-M)
977
978 =item B<< C<SO> >>
979
980 Shift Out (Ctrl-N), invokes the G1 character set.
981 Switch to Alternate Character Set
982
983 =item B<< C<SI> >>
984
985 Shift In (Ctrl-O), invokes the G0 character set (the default).
986 Switch to Standard Character Set
987
988 =item B<< C<SPC> >>
989
990 Space Character
991
992 =back
993
994 =head1 Escape Sequences
995
996 =over 4
997
998 =item B<< C<ESC # 8> >>
999
1000 DEC Screen Alignment Test (DECALN)
1001
1002 =item B<< C<ESC 7> >>
1003
1004 Save Cursor (SC)
1005
1006 =item B<< C<ESC 8> >>
1007
1008 Restore Cursor
1009
1010 =item B<< C<ESC => >>
1011
1012 Application Keypad (SMKX). See also next sequence.
1013
1014 =item B<<< C<< ESC >> >>>
1015
1016 Normal Keypad (RMKX)
1017
1018 B<Note:> If the numeric keypad is activated, eg, B<Num_Lock> has been
1019 pressed, numbers or control functions are generated by the numeric keypad
1020 (see Key Codes).
1021
1022 =item B<< C<ESC D> >>
1023
1024 Index (IND)
1025
1026 =item B<< C<ESC E> >>
1027
1028 Next Line (NEL)
1029
1030 =item B<< C<ESC H> >>
1031
1032 Tab Set (HTS)
1033
1034 =item B<< C<ESC M> >>
1035
1036 Reverse Index (RI)
1037
1038 =item B<< C<ESC N> >>
1039
1040 Single Shift Select of G2 Character Set (SS2): affects next character
1041 only I<unimplemented>
1042
1043 =item B<< C<ESC O> >>
1044
1045 Single Shift Select of G3 Character Set (SS3): affects next character
1046 only I<unimplemented>
1047
1048 =item B<< C<ESC Z> >>
1049
1050 Obsolete form of returns: B<< C<ESC [ ? 1 ; 2 C> >> I<rxvt-unicode compile-time option>
1051
1052 =item B<< C<ESC c> >>
1053
1054 Full reset (RIS)
1055
1056 =item B<< C<ESC n> >>
1057
1058 Invoke the G2 Character Set (LS2)
1059
1060 =item B<< C<ESC o> >>
1061
1062 Invoke the G3 Character Set (LS3)
1063
1064 =item B<< C<ESC ( C> >>
1065
1066 Designate G0 Character Set (ISO 2022), see below for values of C<C>.
1067
1068 =item B<< C<ESC ) C> >>
1069
1070 Designate G1 Character Set (ISO 2022), see below for values of C<C>.
1071
1072 =item B<< C<ESC * C> >>
1073
1074 Designate G2 Character Set (ISO 2022), see below for values of C<C>.
1075
1076 =item B<< C<ESC + C> >>
1077
1078 Designate G3 Character Set (ISO 2022), see below for values of C<C>.
1079
1080 =item B<< C<ESC $ C> >>
1081
1082 Designate Kanji Character Set
1083
1084 Where B<< C<C> >> is one of:
1085
1086 =begin table
1087
1088         C = C<0>        DEC Special Character and Line Drawing Set
1089         C = C<A>        United Kingdom (UK)
1090         C = C<B>        United States (USASCII)
1091         C = C<< < >>    Multinational character set I<unimplemented>
1092         C = C<5>        Finnish character set I<unimplemented>
1093         C = C<C>        Finnish character set I<unimplemented>
1094         C = C<K>        German character set I<unimplemented>
1095
1096 =end table
1097
1098 =back
1099
1100 X<CSI>
1101
1102 =head1 CSI (Command Sequence Introducer) Sequences
1103
1104 =over 4
1105
1106 =item B<< C<ESC [ Ps @> >>
1107
1108 Insert B<< C<Ps> >> (Blank) Character(s) [default: 1] (ICH)X<ESCOBPsA>
1109
1110 =item B<< C<ESC [ Ps A> >>
1111
1112 Cursor Up B<< C<Ps> >> Times [default: 1] (CUU)
1113
1114 =item B<< C<ESC [ Ps B> >>
1115
1116 Cursor Down B<< C<Ps> >> Times [default: 1] (CUD)X<ESCOBPsC>
1117
1118 =item B<< C<ESC [ Ps C> >>
1119
1120 Cursor Forward B<< C<Ps> >> Times [default: 1] (CUF)
1121
1122 =item B<< C<ESC [ Ps D> >>
1123
1124 Cursor Backward B<< C<Ps> >> Times [default: 1] (CUB)
1125
1126 =item B<< C<ESC [ Ps E> >>
1127
1128 Cursor Down B<< C<Ps> >> Times [default: 1] and to first column
1129
1130 =item B<< C<ESC [ Ps F> >>
1131
1132 Cursor Up B<< C<Ps> >> Times [default: 1] and to first columnX<ESCOBPsG>
1133
1134 =item B<< C<ESC [ Ps G> >>
1135
1136 Cursor to Column B<< C<Ps> >> (HPA)
1137
1138 =item B<< C<ESC [ Ps;Ps H> >>
1139
1140 Cursor Position [row;column] [default: 1;1] (CUP)
1141
1142 =item B<< C<ESC [ Ps I> >>
1143
1144 Move forward B<< C<Ps> >> tab stops [default: 1]
1145
1146 =item B<< C<ESC [ Ps J> >>
1147
1148 Erase in Display (ED)
1149
1150 =begin table
1151
1152         B<< C<Ps = 0> >>        Clear Below (default)
1153         B<< C<Ps = 1> >>        Clear Above
1154         B<< C<Ps = 2> >>        Clear All
1155
1156 =end table
1157
1158 =item B<< C<ESC [ Ps K> >>
1159
1160 Erase in Line (EL)
1161
1162 =begin table
1163
1164         B<< C<Ps = 0> >>        Clear to Right (default)
1165         B<< C<Ps = 1> >>        Clear to Left
1166         B<< C<Ps = 2> >>        Clear All
1167
1168 =end table
1169
1170 =item B<< C<ESC [ Ps L> >>
1171
1172 Insert B<< C<Ps> >> Line(s) [default: 1] (IL)
1173
1174 =item B<< C<ESC [ Ps M> >>
1175
1176 Delete B<< C<Ps> >> Line(s) [default: 1] (DL)
1177
1178 =item B<< C<ESC [ Ps P> >>
1179
1180 Delete B<< C<Ps> >> Character(s) [default: 1] (DCH)
1181
1182 =item B<< C<ESC [ Ps;Ps;Ps;Ps;Ps T> >>
1183
1184 Initiate . I<unimplemented> Parameters are
1185 [func;startx;starty;firstrow;lastrow].
1186
1187 =item B<< C<ESC [ Ps W> >>
1188
1189 Tabulator functions
1190
1191 =begin table
1192
1193         B<< C<Ps = 0> >>        Tab Set (HTS)
1194         B<< C<Ps = 2> >>        Tab Clear (TBC), Clear Current Column (default)
1195         B<< C<Ps = 5> >>        Tab Clear (TBC), Clear All
1196
1197 =end table
1198
1199 =item B<< C<ESC [ Ps X> >>
1200
1201 Erase B<< C<Ps> >> Character(s) [default: 1] (ECH)
1202
1203 =item B<< C<ESC [ Ps Z> >>
1204
1205 Move backward B<< C<Ps> >> [default: 1] tab stops
1206
1207 =item B<< C<ESC [ Ps '> >>
1208
1209 See B<< C<ESC [ Ps G> >>
1210
1211 =item B<< C<ESC [ Ps a> >>
1212
1213 See B<< C<ESC [ Ps C> >>
1214
1215 =item B<< C<ESC [ Ps c> >>
1216
1217 Send Device Attributes (DA)
1218 B<< C<Ps = 0> >> (or omitted): request attributes from terminal
1219 returns: B<< C<ESC [ ? 1 ; 2 c> >> (``I am a VT100 with Advanced Video
1220 Option'')
1221
1222 =item B<< C<ESC [ Ps d> >>
1223
1224 Cursor to Line B<< C<Ps> >> (VPA)
1225
1226 =item B<< C<ESC [ Ps e> >>
1227
1228 See B<< C<ESC [ Ps A> >>
1229
1230 =item B<< C<ESC [ Ps;Ps f> >>
1231
1232 Horizontal and Vertical Position [row;column] (HVP) [default: 1;1]
1233
1234 =item B<< C<ESC [ Ps g> >>
1235
1236 Tab Clear (TBC)
1237
1238 =begin table
1239
1240         B<< C<Ps = 0> >>        Clear Current Column (default)
1241         B<< C<Ps = 3> >>        Clear All (TBC)
1242
1243 =end table
1244
1245 =item B<< C<ESC [ Pm h> >>
1246
1247 Set Mode (SM). See B<< C<ESC [ Pm l> >> sequence for description of C<Pm>.
1248
1249 =item B<< C<ESC [ Ps i> >>
1250
1251 Printing. See also the C<print-pipe> resource.
1252
1253 =begin table
1254
1255         B<< C<Ps = 0> >>        print screen (MC0)
1256         B<< C<Ps = 4> >>        disable transparent print mode (MC4)
1257         B<< C<Ps = 5> >>        enable transparent print mode (MC5)
1258
1259 =end table
1260
1261 =item B<< C<ESC [ Pm l> >>
1262
1263 Reset Mode (RM)
1264
1265 =over 4
1266
1267 =item B<< C<Ps = 4> >>
1268
1269 =begin table
1270
1271         B<< C<h> >>     Insert Mode (SMIR)
1272         B<< C<l> >>     Replace Mode (RMIR)
1273
1274 =end table
1275
1276 =item B<< C<Ps = 20> >> (partially implemented)
1277
1278 =begin table
1279
1280         B<< C<h> >>     Automatic Newline (LNM)
1281         B<< C<l> >>     Normal Linefeed (LNM)
1282
1283 =end table
1284
1285 =back
1286
1287 =item B<< C<ESC [ Pm m> >>
1288
1289 Character Attributes (SGR)
1290
1291 =begin table
1292
1293         B<< C<Ps = 0> >>        Normal (default)
1294         B<< C<Ps = 1 / 21> >>   On / Off Bold (bright fg)
1295         B<< C<Ps = 3 / 23> >>   On / Off Italic
1296         B<< C<Ps = 4 / 24> >>   On / Off Underline
1297         B<< C<Ps = 5 / 25> >>   On / Off Slow Blink (bright bg)
1298         B<< C<Ps = 6 / 26> >>   On / Off Rapid Blink (bright bg)
1299         B<< C<Ps = 7 / 27> >>   On / Off Inverse
1300         B<< C<Ps = 8 / 27> >>   On / Off Invisible (NYI)
1301         B<< C<Ps = 30 / 40> >>  fg/bg Black
1302         B<< C<Ps = 31 / 41> >>  fg/bg Red
1303         B<< C<Ps = 32 / 42> >>  fg/bg Green
1304         B<< C<Ps = 33 / 43> >>  fg/bg Yellow
1305         B<< C<Ps = 34 / 44> >>  fg/bg Blue
1306         B<< C<Ps = 35 / 45> >>  fg/bg Magenta
1307         B<< C<Ps = 36 / 46> >>  fg/bg Cyan
1308         B<< C<Ps = 38;5 / 48;5> >>      set fg/bg to color #m (ISO 8613-6)
1309         B<< C<Ps = 37 / 47> >>  fg/bg White
1310         B<< C<Ps = 39 / 49> >>  fg/bg Default
1311         B<< C<Ps = 90 / 100> >> fg/bg Bright Black
1312         B<< C<Ps = 91 / 101> >> fg/bg Bright Red
1313         B<< C<Ps = 92 / 102> >> fg/bg Bright Green
1314         B<< C<Ps = 93 / 103> >> fg/bg Bright Yellow
1315         B<< C<Ps = 94 / 104> >> fg/bg Bright Blue
1316         B<< C<Ps = 95 / 105> >> fg/bg Bright Magenta
1317         B<< C<Ps = 96 / 106> >> fg/bg Bright Cyan
1318         B<< C<Ps = 97 / 107> >> fg/bg Bright White
1319         B<< C<Ps = 99 / 109> >> fg/bg Bright Default
1320
1321 =end table
1322
1323 =item B<< C<ESC [ Ps n> >>
1324
1325 Device Status Report (DSR)
1326
1327 =begin table
1328
1329         B<< C<Ps = 5> >>        Status Report B<< C<ESC [ 0 n> >> (``OK'')
1330         B<< C<Ps = 6> >>        Report Cursor Position (CPR) [row;column] as B<< C<ESC [ r ; c R> >>
1331         B<< C<Ps = 7> >>        Request Display Name
1332         B<< C<Ps = 8> >>        Request Version Number (place in window title)
1333
1334 =end table
1335
1336 =item B<< C<ESC [ Ps;Ps r> >>
1337
1338 Set Scrolling Region [top;bottom]
1339 [default: full size of window] (CSR)
1340
1341 =item B<< C<ESC [ s> >>
1342
1343 Save Cursor (SC)
1344
1345 =item B<< C<ESC [ Ps;Pt t> >>
1346
1347 Window Operations
1348
1349 =begin table
1350
1351         B<< C<Ps = 1> >>        Deiconify (map) window
1352         B<< C<Ps = 2> >>        Iconify window
1353         B<< C<Ps = 3> >>        B<< C<ESC [ 3 ; X ; Y t> >> Move window to (X|Y)
1354         B<< C<Ps = 4> >>        B<< C<ESC [ 4 ; H ; W t> >> Resize to WxH pixels
1355         B<< C<Ps = 5> >>        Raise window
1356         B<< C<Ps = 6> >>        Lower window
1357         B<< C<Ps = 7> >>        Refresh screen once
1358         B<< C<Ps = 8> >>        B<< C<ESC [ 8 ; R ; C t> >> Resize to R rows and C columns
1359         B<< C<Ps = 11> >>       Report window state (responds with C<Ps = 1> or C<Ps = 2>)
1360         B<< C<Ps = 13> >>       Report window position (responds with C<Ps = 3>)
1361         B<< C<Ps = 14> >>       Report window pixel size (responds with C<Ps = 4>)
1362         B<< C<Ps = 18> >>       Report window text size (responds with C<Ps = 7>)
1363         B<< C<Ps = 19> >>       Currently the same as C<Ps = 18>, but responds with C<Ps = 9>
1364         B<< C<Ps = 20> >>       Reports icon label (B<< C<ESC ] L NAME \234> >>)
1365         B<< C<Ps = 21> >>       Reports window title (B<< C<ESC ] l NAME \234> >>)
1366         B<< C<Ps = 24..> >>     Set window height to C<Ps> rows
1367
1368 =end table
1369
1370 =item B<< C<ESC [ u> >>
1371
1372 Restore Cursor
1373
1374 =item B<< C<ESC [ Ps x> >>
1375
1376 Request Terminal Parameters (DECREQTPARM)
1377
1378 =back
1379
1380 X<PrivateModes>
1381
1382 =head1 DEC Private Modes
1383
1384 =over 4
1385
1386 =item B<< C<ESC [ ? Pm h> >>
1387
1388 DEC Private Mode Set (DECSET)
1389
1390 =item B<< C<ESC [ ? Pm l> >>
1391
1392 DEC Private Mode Reset (DECRST)
1393
1394 =item B<< C<ESC [ ? Pm r> >>
1395
1396 Restore previously saved DEC Private Mode Values.
1397
1398 =item B<< C<ESC [ ? Pm s> >>
1399
1400 Save DEC Private Mode Values.
1401
1402 =item B<< C<ESC [ ? Pm t> >>
1403
1404 Toggle DEC Private Mode Values (rxvt extension). I<where>
1405
1406 =over 4
1407
1408 =item B<< C<Ps = 1> >> (DECCKM)
1409
1410 =begin table
1411
1412         B<< C<h> >>     Application Cursor Keys
1413         B<< C<l> >>     Normal Cursor Keys
1414
1415 =end table
1416
1417 =item B<< C<Ps = 2> >> (ANSI/VT52 mode)
1418
1419 =begin table
1420
1421         B<< C<h> >>     Enter VT52 mode
1422         B<< C<l> >>     Enter VT52 mode
1423
1424 =end table
1425
1426 =item B<< C<Ps = 3> >>
1427
1428 =begin table
1429
1430         B<< C<h> >>     132 Column Mode (DECCOLM)
1431         B<< C<l> >>     80 Column Mode (DECCOLM)
1432
1433 =end table
1434
1435 =item B<< C<Ps = 4> >>
1436
1437 =begin table
1438
1439         B<< C<h> >>     Smooth (Slow) Scroll (DECSCLM)
1440         B<< C<l> >>     Jump (Fast) Scroll (DECSCLM)
1441
1442 =end table
1443
1444 =item B<< C<Ps = 5> >>
1445
1446 =begin table
1447
1448         B<< C<h> >>     Reverse Video (DECSCNM)
1449         B<< C<l> >>     Normal Video (DECSCNM)
1450
1451 =end table
1452
1453 =item B<< C<Ps = 6> >>
1454
1455 =begin table
1456
1457         B<< C<h> >>     Origin Mode (DECOM)
1458         B<< C<l> >>     Normal Cursor Mode (DECOM)
1459
1460 =end table
1461
1462 =item B<< C<Ps = 7> >>
1463
1464 =begin table
1465
1466         B<< C<h> >>     Wraparound Mode (DECAWM)
1467         B<< C<l> >>     No Wraparound Mode (DECAWM)
1468
1469 =end table
1470
1471 =item B<< C<Ps = 8> >> I<unimplemented>
1472
1473 =begin table
1474
1475         B<< C<h> >>     Auto-repeat Keys (DECARM)
1476         B<< C<l> >>     No Auto-repeat Keys (DECARM)
1477
1478 =end table
1479
1480 =item B<< C<Ps = 9> >> X10 XTerm
1481
1482 =begin table
1483
1484         B<< C<h> >>     Send Mouse X & Y on button press.
1485         B<< C<l> >>     No mouse reporting.
1486
1487 =end table
1488
1489 =item B<< C<Ps = 25> >>
1490
1491 =begin table
1492
1493         B<< C<h> >>     Visible cursor {cnorm/cvvis}
1494         B<< C<l> >>     Invisible cursor {civis}
1495
1496 =end table
1497
1498 =item B<< C<Ps = 30> >>
1499
1500 =begin table
1501
1502         B<< C<h> >>     scrollBar visisble
1503         B<< C<l> >>     scrollBar invisisble
1504
1505 =end table
1506
1507 =item B<< C<Ps = 35> >> (B<rxvt>)
1508
1509 =begin table
1510
1511         B<< C<h> >>     Allow XTerm Shift+key sequences
1512         B<< C<l> >>     Disallow XTerm Shift+key sequences
1513
1514 =end table
1515
1516 =item B<< C<Ps = 38> >> I<unimplemented>
1517
1518 Enter Tektronix Mode (DECTEK)
1519
1520 =item B<< C<Ps = 40> >>
1521
1522 =begin table
1523
1524         B<< C<h> >>     Allow 80/132 Mode
1525         B<< C<l> >>     Disallow 80/132 Mode
1526
1527 =end table
1528
1529 =item B<< C<Ps = 44> >> I<unimplemented>
1530
1531 =begin table
1532
1533         B<< C<h> >>     Turn On Margin Bell
1534         B<< C<l> >>     Turn Off Margin Bell
1535
1536 =end table
1537
1538 =item B<< C<Ps = 45> >> I<unimplemented>
1539
1540 =begin table
1541
1542         B<< C<h> >>     Reverse-wraparound Mode
1543         B<< C<l> >>     No Reverse-wraparound Mode
1544
1545 =end table
1546
1547 =item B<< C<Ps = 46> >> I<unimplemented>
1548
1549 =item B<< C<Ps = 47> >>
1550
1551 =begin table
1552
1553         B<< C<h> >>     Use Alternate Screen Buffer
1554         B<< C<l> >>     Use Normal Screen Buffer
1555
1556 =end table
1557
1558 X<Priv66>
1559
1560 =item B<< C<Ps = 66> >>
1561
1562 =begin table
1563
1564         B<< C<h> >>     Application Keypad (DECPAM) == C<ESC =>
1565         B<< C<l> >>     Normal Keypad (DECPNM) == C<< ESC > >>
1566
1567 =end table
1568
1569 =item B<< C<Ps = 67> >>
1570
1571 =begin table
1572
1573         B<< C<h> >>     Backspace key sends B<< C<BS> (DECBKM) >>
1574         B<< C<l> >>     Backspace key sends B<< C<DEL> >>
1575
1576 =end table
1577
1578 =item B<< C<Ps = 1000> >> (X11 XTerm)
1579
1580 =begin table
1581
1582         B<< C<h> >>     Send Mouse X & Y on button press and release.
1583         B<< C<l> >>     No mouse reporting.
1584
1585 =end table
1586
1587 =item B<< C<Ps = 1001> >> (X11 XTerm) I<unimplemented>
1588
1589 =begin table
1590
1591         B<< C<h> >>     Use Hilite Mouse Tracking.
1592         B<< C<l> >>     No mouse reporting.
1593
1594 =end table
1595
1596 =item B<< C<Ps = 1010> >> (B<rxvt>)
1597
1598 =begin table
1599
1600         B<< C<h> >>     Don't scroll to bottom on TTY output
1601         B<< C<l> >>     Scroll to bottom on TTY output
1602
1603 =end table
1604
1605 =item B<< C<Ps = 1011> >> (B<rxvt>)
1606
1607 =begin table
1608
1609         B<< C<h> >>     Scroll to bottom when a key is pressed
1610         B<< C<l> >>     Don't scroll to bottom when a key is pressed
1611
1612 =end table
1613
1614 =item B<< C<Ps = 1021> >> (B<rxvt>)
1615
1616 =begin table
1617
1618         B<< C<h> >>     Bold/italic implies high intensity (see option B<-is>)
1619         B<< C<l> >>     Font styles have no effect on intensity (Compile styles)
1620
1621 =end table
1622
1623 =item B<< C<Ps = 1047> >>
1624
1625 =begin table
1626
1627         B<< C<h> >>     Use Alternate Screen Buffer
1628         B<< C<l> >>     Use Normal Screen Buffer - clear Alternate Screen Buffer if returning from it
1629
1630 =end table
1631
1632 =item B<< C<Ps = 1048> >>
1633
1634 =begin table
1635
1636         B<< C<h> >>     Save cursor position
1637         B<< C<l> >>     Restore cursor position
1638
1639 =end table
1640
1641 =item B<< C<Ps = 1049> >>
1642
1643 =begin table
1644
1645         B<< C<h> >>     Use Alternate Screen Buffer - clear Alternate Screen Buffer if switching to it
1646         B<< C<l> >>     Use Normal Screen Buffer
1647
1648 =end table
1649
1650 =back
1651
1652 =back
1653
1654 X<XTerm>
1655
1656 =head1 XTerm Operating System Commands
1657
1658 =over 4
1659
1660 =item B<< C<ESC ] Ps;Pt ST> >>
1661
1662 Set XTerm Parameters. 8-bit ST: 0x9c, 7-bit ST sequence: ESC \ (0x1b,
1663 0x5c), backwards compatible terminator BEL (0x07) is also accepted. any
1664 B<octet> can be escaped by prefixing it with SYN (0x16, ^V).
1665
1666 =begin table
1667
1668         B<< C<Ps = 0> >>        Change Icon Name and Window Title to B<< C<Pt> >>
1669         B<< C<Ps = 1> >>        Change Icon Name to B<< C<Pt> >>
1670         B<< C<Ps = 2> >>        Change Window Title to B<< C<Pt> >>
1671         B<< C<Ps = 3> >>        If B<< C<Pt> >> starts with a B<< C<?> >>, query the (STRING) property of the window and return it. If B<< C<Pt> >> contains a B<< C<=> >>, set the named property to the given value, else delete the specified property.
1672         B<< C<Ps = 4> >>        B<< C<Pt> >> is a semi-colon separated sequence of one or more semi-colon separated B<number>/B<name> pairs, where B<number> is an index to a colour and B<name> is the name of a colour. Each pair causes the B<number>ed colour to be changed to B<name>. Numbers 0-7 corresponds to low-intensity (normal) colours and 8-15 corresponds to high-intensity colours. 0=black, 1=red, 2=green, 3=yellow, 4=blue, 5=magenta, 6=cyan, 7=white
1673         B<< C<Ps = 10> >>       Change colour of text foreground to B<< C<Pt> >> B<(NB: may change in future)>
1674         B<< C<Ps = 11> >>       Change colour of text background to B<< C<Pt> >> B<(NB: may change in future)>
1675         B<< C<Ps = 12> >>       Change colour of text cursor foreground to B<< C<Pt> >>
1676         B<< C<Ps = 13> >>       Change colour of mouse foreground to B<< C<Pt> >>
1677         B<< C<Ps = 17> >>       Change colour of highlight characters to B<< C<Pt> >>
1678         B<< C<Ps = 18> >>       Change colour of bold characters to B<< C<Pt> >> [deprecated, see 706]
1679         B<< C<Ps = 19> >>       Change colour of underlined characters to B<< C<Pt> >> [deprecated, see 707]
1680         B<< C<Ps = 20> >>       Change background pixmap parameters (see section XPM) (Compile XPM).
1681         B<< C<Ps = 39> >>       Change default foreground colour to B<< C<Pt> >>.
1682         B<< C<Ps = 46> >>       Change Log File to B<< C<Pt> >> I<unimplemented>
1683         B<< C<Ps = 49> >>       Change default background colour to B<< C<Pt> >>.
1684         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> >>
1685         B<< C<Ps = 55> >>       Log all scrollback buffer and all of screen to B<< C<Pt> >>
1686         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).
1687         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>.
1688         B<< C<Ps = 704> >>      Change colour of italic characters to B<< C<Pt> >>
1689         B<< C<Ps = 705> >>      Change background pixmap tint colour to B<< C<Pt> >> (Compile transparency).
1690         B<< C<Ps = 706> >>      Change colour of bold characters to B<< C<Pt> >>
1691         B<< C<Ps = 707> >>      Change colour of underlined characters to B<< C<Pt> >>
1692         B<< C<Ps = 710> >>      Set normal fontset to B<< C<Pt> >>. Same as C<Ps = 50>.
1693         B<< C<Ps = 711> >>      Set bold fontset to B<< C<Pt> >>. Similar to C<Ps = 50> (Compile styles).
1694         B<< C<Ps = 712> >>      Set italic fontset to B<< C<Pt> >>. Similar to C<Ps = 50> (Compile styles).
1695         B<< C<Ps = 713> >>      Set bold-italic fontset to B<< C<Pt> >>. Similar to C<Ps = 50> (Compile styles).
1696         B<< C<Ps = 720> >>      Move viewing window up by B<< C<Pt> >> lines, or clear scrollback buffer if C<Pt = 0> (Compile frills).
1697         B<< C<Ps = 721> >>      Move viewing window down by B<< C<Pt> >> lines, or clear scrollback buffer if C<Pt = 0> (Compile frills).
1698         B<< C<Ps = 777> >>      Call the perl extension with the given string, which should be of the form C<extension:parameters> (Compile perl).
1699
1700 =end table
1701
1702 =back
1703
1704 X<XPM>
1705
1706 =head1 XPM
1707
1708 For the XPM XTerm escape sequence B<< C<ESC ] 20 ; Pt ST> >> then value
1709 of B<< C<Pt> >> can be the name of the background pixmap followed by a
1710 sequence of scaling/positioning commands separated by semi-colons. The
1711 scaling/positioning commands are as follows:
1712
1713 =over 4
1714
1715 =item query scale/position
1716
1717 B<?>
1718
1719 =item change scale and position
1720
1721 B<WxH+X+Y>
1722
1723 B<WxH+X> (== B<WxH+X+X>)
1724
1725 B<WxH> (same as B<WxH+50+50>)
1726
1727 B<W+X+Y> (same as B<WxW+X+Y>)
1728
1729 B<W+X> (same as B<WxW+X+X>)
1730
1731 B<W> (same as B<WxW+50+50>)
1732
1733 =item change position (absolute)
1734
1735 B<=+X+Y>
1736
1737 B<=+X> (same as B<=+X+Y>)
1738
1739 =item change position (relative)
1740
1741 B<+X+Y>
1742
1743 B<+X> (same as B<+X+Y>)
1744
1745 =item rescale (relative)
1746
1747 B<Wx0> -> B<W *= (W/100)>
1748
1749 B<0xH> -> B<H *= (H/100)>
1750
1751 =back
1752
1753 For example:
1754
1755 =over 4
1756
1757 =item B<\E]20;funky\a>
1758
1759 load B<funky.xpm> as a tiled image
1760
1761 =item B<\E]20;mona;100\a>
1762
1763 load B<mona.xpm> with a scaling of 100%
1764
1765 =item B<\E]20;;200;?\a>
1766
1767 rescale the current pixmap to 200% and display the image geometry in
1768 the title
1769
1770 =back
1771 X<Mouse>
1772
1773 =head1 Mouse Reporting
1774
1775 =over 4
1776
1777 =item B<< C<< ESC [ M <b> <x> <y> >> >>
1778
1779 report mouse position
1780
1781 =back
1782
1783 The lower 2 bits of B<< C<< <b> >> >> indicate the button:
1784
1785 =over 4
1786
1787 =item Button = B<< C<< (<b> - SPACE) & 3 >> >>
1788
1789 =begin table
1790
1791         0       Button1 pressed
1792         1       Button2 pressed
1793         2       Button3 pressed
1794         3       button released (X11 mouse report)
1795
1796 =end table
1797
1798 =back
1799
1800 The upper bits of B<< C<< <b> >> >> indicate the modifiers when the
1801 button was pressed and are added together (X11 mouse report only):
1802
1803 =over 4
1804
1805 =item State = B<< C<< (<b> - SPACE) & 60 >> >>
1806
1807 =begin table
1808
1809         4       Shift
1810         8       Meta
1811         16      Control
1812         32      Double Click I<(Rxvt extension)>
1813
1814 =end table
1815
1816 Col = B<< C<< <x> - SPACE >> >>
1817
1818 Row = B<< C<< <y> - SPACE >> >>
1819
1820 =back
1821 X<KeyCodes>
1822
1823 =head1 Key Codes
1824
1825 Note: B<Shift> + B<F1>-B<F10> generates B<F11>-B<F20>
1826
1827 For the keypad, use B<Shift> to temporarily override Application-Keypad
1828 setting use B<Num_Lock> to toggle Application-Keypad setting if
1829 B<Num_Lock> is off, toggle Application-Keypad setting. Also note that
1830 values of B<Home>, B<End>, B<Delete> may have been compiled differently on
1831 your system.
1832
1833 =begin table
1834
1835                 B<Normal>       B<Shift>        B<Control>      B<Ctrl+Shift>
1836         Tab     ^I      ESC [ Z ^I      ESC [ Z
1837         BackSpace       ^H      ^?      ^?      ^?
1838         Find    ESC [ 1 ~       ESC [ 1 $       ESC [ 1 ^       ESC [ 1 @
1839         Insert  ESC [ 2 ~       I<paste>        ESC [ 2 ^       ESC [ 2 @
1840         Execute ESC [ 3 ~       ESC [ 3 $       ESC [ 3 ^       ESC [ 3 @
1841         Select  ESC [ 4 ~       ESC [ 4 $       ESC [ 4 ^       ESC [ 4 @
1842         Prior   ESC [ 5 ~       I<scroll-up>    ESC [ 5 ^       ESC [ 5 @
1843         Next    ESC [ 6 ~       I<scroll-down>  ESC [ 6 ^       ESC [ 6 @
1844         Home    ESC [ 7 ~       ESC [ 7 $       ESC [ 7 ^       ESC [ 7 @
1845         End     ESC [ 8 ~       ESC [ 8 $       ESC [ 8 ^       ESC [ 8 @
1846         Delete  ESC [ 3 ~       ESC [ 3 $       ESC [ 3 ^       ESC [ 3 @
1847         F1      ESC [ 11 ~      ESC [ 23 ~      ESC [ 11 ^      ESC [ 23 ^
1848         F2      ESC [ 12 ~      ESC [ 24 ~      ESC [ 12 ^      ESC [ 24 ^
1849         F3      ESC [ 13 ~      ESC [ 25 ~      ESC [ 13 ^      ESC [ 25 ^
1850         F4      ESC [ 14 ~      ESC [ 26 ~      ESC [ 14 ^      ESC [ 26 ^
1851         F5      ESC [ 15 ~      ESC [ 28 ~      ESC [ 15 ^      ESC [ 28 ^
1852         F6      ESC [ 17 ~      ESC [ 29 ~      ESC [ 17 ^      ESC [ 29 ^
1853         F7      ESC [ 18 ~      ESC [ 31 ~      ESC [ 18 ^      ESC [ 31 ^
1854         F8      ESC [ 19 ~      ESC [ 32 ~      ESC [ 19 ^      ESC [ 32 ^
1855         F9      ESC [ 20 ~      ESC [ 33 ~      ESC [ 20 ^      ESC [ 33 ^
1856         F10     ESC [ 21 ~      ESC [ 34 ~      ESC [ 21 ^      ESC [ 34 ^
1857         F11     ESC [ 23 ~      ESC [ 23 $      ESC [ 23 ^      ESC [ 23 @
1858         F12     ESC [ 24 ~      ESC [ 24 $      ESC [ 24 ^      ESC [ 24 @
1859         F13     ESC [ 25 ~      ESC [ 25 $      ESC [ 25 ^      ESC [ 25 @
1860         F14     ESC [ 26 ~      ESC [ 26 $      ESC [ 26 ^      ESC [ 26 @
1861         F15 (Help)      ESC [ 28 ~      ESC [ 28 $      ESC [ 28 ^      ESC [ 28 @
1862         F16 (Menu)      ESC [ 29 ~      ESC [ 29 $      ESC [ 29 ^      ESC [ 29 @
1863         F17     ESC [ 31 ~      ESC [ 31 $      ESC [ 31 ^      ESC [ 31 @
1864         F18     ESC [ 32 ~      ESC [ 32 $      ESC [ 32 ^      ESC [ 32 @
1865         F19     ESC [ 33 ~      ESC [ 33 $      ESC [ 33 ^      ESC [ 33 @
1866         F20     ESC [ 34 ~      ESC [ 34 $      ESC [ 34 ^      ESC [ 34 @
1867                                         B<Application>
1868         Up      ESC [ A ESC [ a ESC O a ESC O A
1869         Down    ESC [ B ESC [ b ESC O b ESC O B
1870         Right   ESC [ C ESC [ c ESC O c ESC O C
1871         Left    ESC [ D ESC [ d ESC O d ESC O D
1872         KP_Enter        ^M                      ESC O M
1873         KP_F1   ESC O P                 ESC O P
1874         KP_F2   ESC O Q                 ESC O Q
1875         KP_F3   ESC O R                 ESC O R
1876         KP_F4   ESC O S                 ESC O S
1877         XK_KP_Multiply  *                       ESC O j
1878         XK_KP_Add       +                       ESC O k
1879         XK_KP_Separator ,                       ESC O l
1880         XK_KP_Subtract  -                       ESC O m
1881         XK_KP_Decimal   .                       ESC O n
1882         XK_KP_Divide    /                       ESC O o
1883         XK_KP_0 0                       ESC O p
1884         XK_KP_1 1                       ESC O q
1885         XK_KP_2 2                       ESC O r
1886         XK_KP_3 3                       ESC O s
1887         XK_KP_4 4                       ESC O t
1888         XK_KP_5 5                       ESC O u
1889         XK_KP_6 6                       ESC O v
1890         XK_KP_7 7                       ESC O w
1891         XK_KP_8 8                       ESC O x
1892         XK_KP_9 9                       ESC O y
1893
1894 =end table
1895
1896 =head1 CONFIGURE OPTIONS
1897
1898 General hint: if you get compile errors, then likely your configuration
1899 hasn't been tested well. Either try with C<--enable-everything> or use
1900 the F<./reconf> script as a base for experiments. F<./reconf> is used by
1901 myself, so it should generally be a working config. Of course, you should
1902 always report when a combination doesn't work, so it can be fixed. Marc
1903 Lehmann <rxvt@schmorp.de>.
1904
1905 All
1906
1907 =over 4
1908
1909 =item --enable-everything
1910
1911 Add (or remove) support for all non-multichoice options listed in "./configure
1912 --help".
1913
1914 You can specify this and then disable options you do not like by
1915 I<following> this with the appropriate C<--disable-...> arguments,
1916 or you can start with a minimal configuration by specifying
1917 C<--disable-everything> and than adding just the C<--enable-...> arguments
1918 you want.
1919
1920 =item --enable-xft (default: enabled)
1921
1922 Add support for Xft (anti-aliases, among others) fonts. Xft fonts are
1923 slower and require lots of memory, but as long as you don't use them, you
1924 don't pay for them.
1925
1926 =item --enable-font-styles (default: on)
1927
1928 Add support for B<bold>, I<italic> and B<< I<bold italic> >> font
1929 styles. The fonts can be set manually or automatically.
1930
1931 =item --with-codesets=NAME,... (default: all)
1932
1933 Compile in support for additional codeset (encoding) groups (C<eu>, C<vn>
1934 are always compiled in, which includes most 8-bit character sets). These
1935 codeset tables are used for driving X11 core fonts, they are not required
1936 for Xft fonts, although having them compiled in lets rxvt-unicode choose
1937 replacement fonts more intelligently. Compiling them in will make your
1938 binary bigger (all of together cost about 700kB), but it doesn't increase
1939 memory usage unless you use a font requiring one of these encodings.
1940
1941 =begin table
1942
1943         all     all available codeset groups
1944         zh      common chinese encodings
1945         zh_ext  rarely used but very big chinese encodigs
1946         jp      common japanese encodings
1947         jp_ext  rarely used but big japanese encodings
1948         kr      korean encodings
1949
1950 =end table
1951
1952 =item --enable-xim (default: on)
1953
1954 Add support for XIM (X Input Method) protocol. This allows using
1955 alternative input methods (e.g. kinput2) and will also correctly
1956 set up the input for people using dead keys or compose keys.
1957
1958 =item --enable-unicode3 (default: off)
1959
1960 Recommended to stay off unless you really need non-BMP characters.
1961
1962 Enable direct support for displaying unicode codepoints above
1963 65535 (the basic multilingual page). This increases storage
1964 requirements per character from 2 to 4 bytes. X11 fonts do not yet
1965 support these extra characters, but Xft does.
1966
1967 Please note that rxvt-unicode can store unicode code points >65535
1968 even without this flag, but the number of such characters is
1969 limited to a view thousand (shared with combining characters,
1970 see next switch), and right now rxvt-unicode cannot display them
1971 (input/output and cut&paste still work, though).
1972
1973 =item --enable-combining (default: on)
1974
1975 Enable automatic composition of combining characters into
1976 composite characters. This is required for proper viewing of text
1977 where accents are encoded as seperate unicode characters. This is
1978 done by using precomposited characters when available or creating
1979 new pseudo-characters when no precomposed form exists.
1980
1981 Without --enable-unicode3, the number of additional precomposed
1982 characters is somewhat limited (the 6400 private use characters will be
1983 (ab-)used). With --enable-unicode3, no practical limit exists.
1984
1985 This option will also enable storage (but not display) of characters
1986 beyond plane 0 (>65535) when --enable-unicode3 was not specified.
1987
1988 The combining table also contains entries for arabic presentation forms,
1989 but these are not currently used. Bug me if you want these to be used (and
1990 tell me how these are to be used...).
1991
1992 =item --enable-fallback(=CLASS) (default: Rxvt)
1993
1994 When reading resource settings, also read settings for class CLASS. To
1995 disable resource fallback use --disable-fallback.
1996
1997 =item --with-res-name=NAME (default: urxvt)
1998
1999 Use the given name as default application name when
2000 reading resources. Specify --with-res-name=rxvt to replace rxvt.
2001
2002 =item --with-res-class=CLASS /default: URxvt)
2003
2004 Use the given class as default application class
2005 when reading resources. Specify --with-res-class=Rxvt to replace
2006 rxvt.
2007
2008 =item --enable-utmp (default: on)
2009
2010 Write user and tty to utmp file (used by programs like F<w>) at
2011 start of rxvt execution and delete information when rxvt exits.
2012
2013 =item --enable-wtmp (default: on)
2014
2015 Write user and tty to wtmp file (used by programs like F<last>) at
2016 start of rxvt execution and write logout when rxvt exits.  This
2017 option requires --enable-utmp to also be specified.
2018
2019 =item --enable-lastlog (default: on)
2020
2021 Write user and tty to lastlog file (used by programs like
2022 F<lastlogin>) at start of rxvt execution.  This option requires
2023 --enable-utmp to also be specified.
2024
2025 =item --enable-xpm-background (default: on)
2026
2027 Add support for XPM background pixmaps.
2028
2029 =item --enable-transparency (default: on)
2030
2031 Add support for inheriting parent backgrounds thus giving a fake
2032 transparency to the term.
2033
2034 =item --enable-fading (default: on)
2035
2036 Add support for fading the text when focus is lost (requires C<--enable-transparency>).
2037
2038 =item --enable-tinting (default: on)
2039
2040 Add support for tinting of transparent backgrounds (requires C<--enable-transparency>).
2041
2042 =item --enable-rxvt-scroll (default: on)
2043
2044 Add support for the original rxvt scrollbar.
2045
2046 =item --enable-next-scroll (default: on)
2047
2048 Add support for a NeXT-like scrollbar.
2049
2050 =item --enable-xterm-scroll (default: on)
2051
2052 Add support for an Xterm-like scrollbar.
2053
2054 =item --enable-plain-scroll (default: on)
2055
2056 Add support for a very unobtrusive, plain-looking scrollbar that
2057 is the favourite of the rxvt-unicode author, having used it for
2058 many years.
2059
2060 =item --enable-ttygid (default: off)
2061
2062 Change tty device setting to group "tty" - only use this if
2063 your system uses this type of security.
2064
2065 =item --disable-backspace-key
2066
2067 Removes any handling of the backspace key by us - let the X server do it.
2068
2069 =item --disable-delete-key
2070
2071 Removes any handling of the delete key by us - let the X server
2072 do it.
2073
2074 =item --disable-resources
2075
2076 Removes any support for resource checking.
2077
2078 =item --disable-swapscreen
2079
2080 Remove support for secondary/swap screen.
2081
2082 =item --enable-frills (default: on)
2083
2084 Add support for many small features that are not essential but nice to
2085 have. Normally you want this, but for very small binaries you may want to
2086 disable this.
2087
2088 A non-exhaustive list of features enabled by C<--enable-frills> (possibly
2089 in combination with other switches) is:
2090
2091   MWM-hints
2092   EWMH-hints (pid, utf8 names) and protocols (ping)
2093   seperate underline colour (-underlineColor)
2094   settable border widths and borderless switch (-w, -b, -bl)
2095   visual selection (-depth)
2096   settable extra linespacing /-lsp)
2097   iso-14755-2 and -3, and visual feedback
2098   backindex and forwardindex escape sequence
2099   window op and some xterm/OSC escape sequences
2100   tripleclickwords (-tcw)
2101   settable insecure mode (-insecure)
2102   keysym remapping support
2103   cursor blinking and underline cursor (-cb, -uc)
2104   XEmbed support (-embed)
2105   user-pty (-pty-fd)
2106   hold on exit (-hold)
2107   skip builtin block graphics (-sbg)
2108   sgr modes 90..97 and 100..107
2109
2110 =item --enable-iso14755 (default: on)
2111
2112 Enable extended ISO 14755 support (see @@RXVT_NAME@@(1), or
2113 F<doc/rxvt.1.txt>). Basic support (section 5.1) is enabled by
2114 C<--enable-frills>, while support for 5.2, 5.3 and 5.4 is enabled with
2115 this switch.
2116
2117 =item --enable-keepscrolling (default: on)
2118
2119 Add support for continual scrolling of the display when you hold
2120 the mouse button down on a scrollbar arrow.
2121
2122 =item --enable-mousewheel (default: on)
2123
2124 Add support for scrolling via mouse wheel or buttons 4 & 5.
2125
2126 =item --enable-slipwheeling (default: on)
2127
2128 Add support for continual scrolling (using the mouse wheel as an
2129 accelerator) while the control key is held down.  This option
2130 requires --enable-mousewheel to also be specified.
2131
2132 =item --disable-new-selection
2133
2134 Remove support for mouse selection style like that of xterm.
2135
2136 =item --enable-dmalloc (default: off)
2137
2138 Use Gray Watson's malloc - which is good for debugging See
2139 http://www.letters.com/dmalloc/ for details If you use either this or the
2140 next option, you may need to edit src/Makefile after compiling to point
2141 DINCLUDE and DLIB to the right places.
2142
2143 You can only use either this option and the following (should
2144 you use either) .
2145
2146 =item --enable-dlmalloc (default: off)
2147
2148 Use Doug Lea's malloc - which is good for a production version
2149 See L<http://g.oswego.edu/dl/html/malloc.html> for details.
2150
2151 =item --enable-smart-resize (default: on)
2152
2153 Add smart growth/shrink behaviour when changing font size via hot
2154 keys. This should keep the window corner which is closest to a corner of
2155 the screen in a fixed position.
2156
2157 =item --enable-pointer-blank (default: on)
2158
2159 Add support to have the pointer disappear when typing or inactive.
2160
2161 =item --enable-perl (default: on)
2162
2163 Enable an embedded perl interpreter. See the B<@@RXVT_NAME@@perl(3)>
2164 manpage (F<doc/rxvtperl.txt>) for more info on this feature, or the files
2165 in F<src/perl-ext/> for the extensions that are installed by default. The
2166 perl interpreter that is used can be specified via the C<PERL> environment
2167 variable when running configure.
2168
2169 =item --with-name=NAME (default: urxvt)
2170
2171 Set the basename for the installed binaries, resulting
2172 in C<urxvt>, C<urxvtd> etc.). Specify C<--with-name=rxvt> to replace with
2173 C<rxvt>.
2174
2175 =item --with-term=NAME (default: rxvt-unicode)
2176
2177 Change the environmental variable for the terminal to NAME.
2178
2179 =item --with-terminfo=PATH
2180
2181 Change the environmental variable for the path to the terminfo tree to
2182 PATH.
2183
2184 =item --with-x
2185
2186 Use the X Window System (pretty much default, eh?).
2187
2188 =item --with-xpm-includes=DIR
2189
2190 Look for the XPM includes in DIR.
2191
2192 =item --with-xpm-library=DIR
2193
2194 Look for the XPM library in DIR.
2195
2196 =item --with-xpm
2197
2198 Not needed - define via --enable-xpm-background.
2199
2200 =back
2201
2202 =head1 AUTHORS
2203
2204 Marc Lehmann <rxvt@schmorp.de> converted this document to pod and
2205 reworked it from the original Rxvt documentation, which was done by Geoff
2206 Wing <gcw@pobox.com>, who in turn used the XTerm documentation and other
2207 sources.
2208