ViewVC Help
View File | Revision Log | Show Annotations | Download File
/cvs/rxvt-unicode/doc/rxvt.7.pod
Revision: 1.100
Committed: Tue Jan 31 01:00:49 2006 UTC (18 years, 5 months ago) by root
Branch: MAIN
Changes since 1.99: +15 -1 lines
Log Message:
*** empty log message ***

File Contents

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