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

File Contents

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