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