ViewVC Help
View File | Revision Log | Show Annotations | Download File
/cvs/rxvt-unicode/doc/rxvt.7.txt
Revision: 1.42
Committed: Thu Jan 12 23:16:31 2006 UTC (18 years, 5 months ago) by root
Content type: text/plain
Branch: MAIN
Changes since 1.41: +7 -4 lines
Log Message:
*** empty log message ***

File Contents

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