ViewVC Help
View File | Revision Log | Show Annotations | Download File
/cvs/rxvt-unicode/doc/rxvt.7.pod
Revision: 1.87
Committed: Tue Jan 17 16:22:41 2006 UTC (18 years, 6 months ago) by root
Branch: MAIN
Changes since 1.86: +14 -16 lines
Log Message:
*** empty log message ***

File Contents

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