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