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