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