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