ViewVC Help
View File | Revision Log | Show Annotations | Download File
/cvs/rxvt-unicode/doc/rxvt.7.txt
(Generate patch)

Comparing rxvt-unicode/doc/rxvt.7.txt (file contents):
Revision 1.12 by root, Sun Feb 13 11:07:57 2005 UTC vs.
Revision 1.38 by root, Wed Jan 11 19:55:34 2006 UTC

18 The newest version of this document is also available on the World Wide 18 The newest version of this document is also available on the World Wide
19 Web at 19 Web at
20 <http://cvs.schmorp.de/browse/*checkout*/rxvt-unicode/doc/rxvt.7.html>. 20 <http://cvs.schmorp.de/browse/*checkout*/rxvt-unicode/doc/rxvt.7.html>.
21 21
22FREQUENTLY ASKED QUESTIONS 22FREQUENTLY 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
23 How do I know which rxvt-unicode version I'm using? 106 How do I know which rxvt-unicode version I'm using?
24 The version number is displayed with the usage (-h). Also the escape 107 The version number is displayed with the usage (-h). Also the escape
25 sequence "ESC [ 8 n" sets the window title to the version number. 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.
26 111
27 I am using Debian GNU/Linux and have a problem... 112 I am using Debian GNU/Linux and have a problem...
28 The Debian GNU/Linux package of rxvt-unicode contains large patches 113 The Debian GNU/Linux package of rxvt-unicode in sarge contains large
29 that considerably change the behaviour of rxvt-unicode. Before 114 patches that considerably change the behaviour of rxvt-unicode.
30 reporting a bug to the original rxvt-unicode author please download 115 Before reporting a bug to the original rxvt-unicode author please
31 and install the genuine version 116 download and install the genuine version
32 (<http://software.schmorp.de#rxvt-unicode>) and try to reproduce the 117 (<http://software.schmorp.de#rxvt-unicode>) and try to reproduce the
33 problem. If you cannot, chances are that the problems are specific 118 problem. If you cannot, chances are that the problems are specific
34 to Debian GNU/Linux, in which case it should be reported via the 119 to Debian GNU/Linux, in which case it should be reported via the
35 Debian Bug Tracking System (use "reportbug" to report the bug). 120 Debian Bug Tracking System (use "reportbug" to report the bug).
36 121
37 For other problems that also affect the Debian package, you can and 122 For other problems that also affect the Debian package, you can and
38 probably should use the Debian BTS, too, because, after all, it's 123 probably should use the Debian BTS, too, because, after all, it's
39 also a bug in the Debian version and it serves as a reminder for 124 also a bug in the Debian version and it serves as a reminder for
40 other users that might encounter the same issue. 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.
41 169
42 When I log-in to another system it tells me about missing terminfo data? 170 When I log-in to another system it tells me about missing terminfo data?
43 The terminal description used by rxvt-unicode is not as widely 171 The terminal description used by rxvt-unicode is not as widely
44 available as that for xterm, or even rxvt (for which the same 172 available as that for xterm, or even rxvt (for which the same
45 problem often arises). 173 problem often arises).
66 URxvt.termName: rxvt 194 URxvt.termName: rxvt
67 195
68 If you don't plan to use rxvt (quite common...) you could also 196 If you don't plan to use rxvt (quite common...) you could also
69 replace the rxvt terminfo file with the rxvt-unicode one. 197 replace the rxvt terminfo file with the rxvt-unicode one.
70 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
71 "bash"'s readline does not work correctly under rxvt. 203 "bash"'s readline does not work correctly under rxvt.
72 I need a termcap file entry. 204 I need a termcap file entry.
73 One reason you might want this is that some distributions or 205 One reason you might want this is that some distributions or
74 operating systems still compile some programs using the 206 operating systems still compile some programs using the
75 long-obsoleted termcap (Fedora Core's bash is one example) and rely 207 long-obsoleted termcap library (Fedora Core's bash is one example)
76 on a termcap entry for "rxvt-unicode". 208 and rely on a termcap entry for "rxvt-unicode".
77 209
78 You could use rxvt's termcap entry with resonable results in many 210 You could use rxvt's termcap entry with resonable results in many
79 cases. You can also create a termcap entry by using terminfo's 211 cases. You can also create a termcap entry by using terminfo's
80 infocmp program like this: 212 infocmp program like this:
81 213
83 215
84 Or you could use this termcap entry, generated by the command above: 216 Or you could use this termcap entry, generated by the command above:
85 217
86 rxvt-unicode|rxvt-unicode terminal (X Window System):\ 218 rxvt-unicode|rxvt-unicode terminal (X Window System):\
87 :am:bw:eo:km:mi:ms:xn:xo:\ 219 :am:bw:eo:km:mi:ms:xn:xo:\
88 :co#80:it#8:li#24:\ 220 :co#80:it#8:li#24:lm#0:\
89 :AL=\E[%dL:DC=\E[%dP:DL=\E[%dM:DO=\E[%dB:IC=\E[%d@:\ 221 :AL=\E[%dL:DC=\E[%dP:DL=\E[%dM:DO=\E[%dB:IC=\E[%d@:\
90 :K1=\EOw:K2=\EOu:K3=\EOy:K4=\EOq:K5=\EOs:LE=\E[%dD:\ 222 :K1=\EOw:K2=\EOu:K3=\EOy:K4=\EOq:K5=\EOs:LE=\E[%dD:\
91 :RI=\E[%dC:SF=\E[%dS:SR=\E[%dT:UP=\E[%dA:ae=^O:al=\E[L:\ 223 :RI=\E[%dC:SF=\E[%dS:SR=\E[%dT:UP=\E[%dA:ae=\E(B:al=\E[L:\
92 :as=^N:bl=^G:cd=\E[J:ce=\E[K:cl=\E[H\E[2J:cm=\E[%i%d;%dH:\ 224 :as=\E(0:bl=^G:cd=\E[J:ce=\E[K:cl=\E[H\E[2J:\
93 :cr=^M:cs=\E[%i%d;%dr:ct=\E[3g:dc=\E[P:dl=\E[M:do=^J:\ 225 :cm=\E[%i%d;%dH:cr=^M:cs=\E[%i%d;%dr:ct=\E[3g:dc=\E[P:\
94 :ec=\E[%dX:ei=\E[4l:ho=\E[H:i1=\E[?47l\E=\E[?1l:ic=\E[@:\ 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:\
95 :im=\E[4h:is=\E[r\E[m\E[2J\E[H\E[?7h\E[?1;3;4;6l\E[4l:\ 228 :is=\E[r\E[m\E[2J\E[H\E[?7h\E[?1;3;4;6l\E[4l:\
96 :k0=\E[21~:k1=\E[11~:k2=\E[12~:k3=\E[13~:k4=\E[14~:\ 229 :k1=\E[11~:k2=\E[12~:k3=\E[13~:k4=\E[14~:k5=\E[15~:\
97 :k5=\E[15~:k6=\E[17~:k7=\E[18~:k8=\E[19~:k9=\E[20~:\ 230 :k6=\E[17~:k7=\E[18~:k8=\E[19~:k9=\E[20~:kD=\E[3~:\
98 :kD=\E[3~:kI=\E[2~:kN=\E[6~:kP=\E[5~:kb=\177:kd=\EOB:\ 231 :kI=\E[2~:kN=\E[6~:kP=\E[5~:kb=\177:kd=\EOB:ke=\E[?1l\E>:\
99 :ke=\E[?1l\E>:kh=\E[7~:kl=\EOD:kr=\EOC:ks=\E[?1h\E=:\ 232 :kh=\E[7~:kl=\EOD:kr=\EOC:ks=\E[?1h\E=:ku=\EOA:le=^H:\
100 :ku=\EOA:le=^H:mb=\E[5m:md=\E[1m:me=\E[m\017:mr=\E[7m:\ 233 :mb=\E[5m:md=\E[1m:me=\E[m\017:mr=\E[7m:nd=\E[C:rc=\E8:\
101 :nd=\E[C:rc=\E8:sc=\E7:se=\E[27m:sf=^J:so=\E[7m:sr=\EM:\ 234 :sc=\E7:se=\E[27m:sf=^J:so=\E[7m:sr=\EM:st=\EH:ta=^I:\
102 :st=\EH:ta=^I:te=\E[r\E[?1049l:ti=\E[?1049h:ue=\E[24m:\ 235 :te=\E[r\E[?1049l:ti=\E[?1049h:ue=\E[24m:up=\E[A:\
103 :up=\E[A:us=\E[4m:vb=\E[?5h\E[?5l:ve=\E[?25h:vi=\E[?25l:\ 236 :us=\E[4m:vb=\E[?5h\E[?5l:ve=\E[?25h:vi=\E[?25l:\
104 :vs=\E[?25h: 237 :vs=\E[?25h:
105 238
106 Why does "ls" no longer have coloured output? 239 Why does "ls" no longer have coloured output?
107 The "ls" in the GNU coreutils unfortunately doesn't use terminfo to 240 The "ls" in the GNU coreutils unfortunately doesn't use terminfo to
108 decide wether a terminal has colour, but uses it's own configuration 241 decide wether a terminal has colour, but uses it's own configuration
246 that doesn't work, you might be forced to use a different font. 379 that doesn't work, you might be forced to use a different font.
247 380
248 All of this is not a problem when using X11 core fonts, as their 381 All of this is not a problem when using X11 core fonts, as their
249 bounding box data is correct. 382 bounding box data is correct.
250 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
251 My Compose (Multi_key) key is no longer working. 391 My Compose (Multi_key) key is no longer working.
252 The most common causes for this are that either your locale is not 392 The most common causes for this are that either your locale is not
253 set correctly, or you specified a preeditStyle that is not supported 393 set correctly, or you specified a preeditStyle that is not supported
254 by your input method. For example, if you specified OverTheSpot and 394 by your input method. For example, if you specified OverTheSpot and
255 your input method (e.g. the default input method handling Compose 395 your input method (e.g. the default input method handling Compose
299 As you might have guessed, FreeBSD does neither define this symobl 439 As you might have guessed, FreeBSD does neither define this symobl
300 nor does it support it. Instead, it uses it's own internal 440 nor does it support it. Instead, it uses it's own internal
301 representation of wchar_t. This is, of course, completely fine with 441 representation of wchar_t. This is, of course, completely fine with
302 respect to standards. 442 respect to standards.
303 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
304 However, "__STDC_ISO_10646__" is the only sane way to support 447 "__STDC_ISO_10646__" is the only sane way to support multi-language
305 multi-language apps in an OS, as using a locale-dependent (and 448 apps in an OS, as using a locale-dependent (and non-standardized)
306 non-standardized) representation of wchar_t makes it impossible to 449 representation of wchar_t makes it impossible to convert between
307 convert between wchar_t (as used by X11 and your applications) and 450 wchar_t (as used by X11 and your applications) and any other
308 any other encoding without implementing OS-specific-wrappers for 451 encoding without implementing OS-specific-wrappers for each and
309 each and every locale. There simply are no APIs to convert wchar_t 452 every locale. There simply are no APIs to convert wchar_t into
310 into anything except the current locale encoding. 453 anything except the current locale encoding.
311 454
312 Some applications (such as the formidable mlterm) work around this 455 Some applications (such as the formidable mlterm) work around this
313 by carrying their own replacement functions for character set 456 by carrying their own replacement functions for character set
314 handling with them, and either implementing OS-dependent hacks or 457 handling with them, and either implementing OS-dependent hacks or
315 doing multiple conversions (which is slow and unreliable in case the 458 doing multiple conversions (which is slow and unreliable in case the
317 emulator). 460 emulator).
318 461
319 The rxvt-unicode author insists that the right way to fix this is in 462 The rxvt-unicode author insists that the right way to fix this is in
320 the system libraries once and for all, instead of forcing every app 463 the system libraries once and for all, instead of forcing every app
321 to carry complete replacements for them :) 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.
322 481
323 How does rxvt-unicode determine the encoding to use? 482 How does rxvt-unicode determine the encoding to use?
324 Is there an option to switch encodings? 483 Is there an option to switch encodings?
325 Unlike some other terminals, rxvt-unicode has no encoding switch, 484 Unlike some other terminals, rxvt-unicode has no encoding switch,
326 and no specific "utf-8" mode, such as xterm. In fact, it doesn't 485 and no specific "utf-8" mode, such as xterm. In fact, it doesn't
438 it gets worse, as rxvt-unicode then uses 8 bytes per screen cell. 597 it gets worse, as rxvt-unicode then uses 8 bytes per screen cell.
439 598
440 Can I speed up Xft rendering somehow? 599 Can I speed up Xft rendering somehow?
441 Yes, the most obvious way to speed it up is to avoid Xft entirely, 600 Yes, the most obvious way to speed it up is to avoid Xft entirely,
442 as it is simply slow. If you still want Xft fonts you might try to 601 as it is simply slow. If you still want Xft fonts you might try to
443 disable antialiasing (by appending ":antialiasing=false"), which 602 disable antialiasing (by appending ":antialias=false"), which saves
444 saves lots of memory and also speeds up rendering considerably. 603 lots of memory and also speeds up rendering considerably.
445 604
446 Rxvt-unicode doesn't seem to anti-alias its fonts, what is wrong? 605 Rxvt-unicode doesn't seem to anti-alias its fonts, what is wrong?
447 Rxvt-unicode will use whatever you specify as a font. If it needs to 606 Rxvt-unicode will use whatever you specify as a font. If it needs to
448 fall back to it's default font search list it will prefer X11 core 607 fall back to it's default font search list it will prefer X11 core
449 fonts, because they are small and fast, and then use Xft fonts. It 608 fonts, because they are small and fast, and then use Xft fonts. It
521 URxvt.color14: #73f7ff 680 URxvt.color14: #73f7ff
522 URxvt.color7: #e1dddd 681 URxvt.color7: #e1dddd
523 URxvt.color15: #e1dddd 682 URxvt.color15: #e1dddd
524 683
525 How can I start rxvtd in a race-free way? 684 How can I start rxvtd in a race-free way?
526 Despite it's name, rxvtd is not a real daemon, but more like a 685 Try "rxvtd -f -o", which tells rxvtd to open the display, create the
527 server that answers rxvtc's requests, so it doesn't background 686 listening socket and then fork.
528 itself.
529
530 To ensure rxvtd is listening on it's socket, you can use the
531 following method to wait for the startup message before continuing:
532
533 { rxvtd & } | read
534 687
535 What's with the strange Backspace/Delete key behaviour? 688 What's with the strange Backspace/Delete key behaviour?
536 Assuming that the physical Backspace key corresponds to the 689 Assuming that the physical Backspace key corresponds to the
537 BackSpace keysym (not likely for Linux ... see the following 690 BackSpace keysym (not likely for Linux ... see the following
538 question) there are two standard values that can be used for 691 question) there are two standard values that can be used for
1121 1274
1122 "Ps = 1011" (rxvt) 1275 "Ps = 1011" (rxvt)
1123 h Scroll to bottom when a key is pressed 1276 h Scroll to bottom when a key is pressed
1124 l Don't scroll to bottom when a key is pressed 1277 l Don't scroll to bottom when a key is pressed
1125 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
1126 "Ps = 1047" 1283 "Ps = 1047"
1127 h Use Alternate Screen Buffer 1284 h Use Alternate Screen Buffer
1128 l Use Normal Screen Buffer - clear Alternate Screen Buffer if returning from it 1285 l Use Normal Screen Buffer - clear Alternate Screen Buffer if returning from it
1129 1286
1130 "Ps = 1048" 1287 "Ps = 1048"
1152 Ps = 10 Change colour of text foreground to Pt (NB: may change in future) 1309 Ps = 10 Change colour of text foreground to Pt (NB: may change in future)
1153 Ps = 11 Change colour of text background to Pt (NB: may change in future) 1310 Ps = 11 Change colour of text background to Pt (NB: may change in future)
1154 Ps = 12 Change colour of text cursor foreground to Pt 1311 Ps = 12 Change colour of text cursor foreground to Pt
1155 Ps = 13 Change colour of mouse foreground to Pt 1312 Ps = 13 Change colour of mouse foreground to Pt
1156 Ps = 17 Change colour of highlight characters to Pt 1313 Ps = 17 Change colour of highlight characters to Pt
1157 Ps = 18 Change colour of bold characters to Pt 1314 Ps = 18 Change colour of bold characters to Pt [deprecated, see 706]
1158 Ps = 19 Change colour of underlined characters to Pt 1315 Ps = 19 Change colour of underlined characters to Pt [deprecated, see 707]
1159 Ps = 20 Change default background to Pt 1316 Ps = 20 Change default background to Pt
1160 Ps = 39 Change default foreground colour to Pt rxvt compile-time option 1317 Ps = 39 Change default foreground colour to Pt.
1161 Ps = 46 Change Log File to Pt unimplemented 1318 Ps = 46 Change Log File to Pt unimplemented
1162 Ps = 49 Change default background colour to Pt rxvt compile-time option 1319 Ps = 49 Change default background colour to Pt.
1163 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 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
1164 Ps = 55 Log all scrollback buffer and all of screen to Pt 1321 Ps = 55 Log all scrollback buffer and all of screen to Pt
1165 Ps = 701 Change current locale to Pt, or, if Pt is ?, return the current locale (rxvt extension) 1322 Ps = 701 Change current locale to Pt, or, if Pt is ?, return the current locale (Compile frills).
1166 Ps = 703 Menubar command Pt rxvt compile-time option (rxvt-unicode extension) 1323 Ps = 703 Menubar command Pt (Compile menubar).
1167 Ps = 704 Change colour of italic characters to Pt 1324 Ps = 704 Change colour of italic characters to Pt
1168 Ps = 705 Change background pixmap tint colour 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
1169 Ps = 710 Set normal fontset to Pt. Same as Ps = 50. 1328 Ps = 710 Set normal fontset to Pt. Same as Ps = 50.
1170 Ps = 711 Set bold fontset to Pt. Similar to Ps = 50. 1329 Ps = 711 Set bold fontset to Pt. Similar to Ps = 50 (Compile styles).
1171 Ps = 712 Set italic fontset to Pt. Similar to Ps = 50. 1330 Ps = 712 Set italic fontset to Pt. Similar to Ps = 50 (Compile styles).
1172 Ps = 713 Set bold-italic fontset to Pt. Similar to Ps = 50. 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).
1173 1335
1174 1336
1175 1337
1176menuBar 1338menuBar
1177 The exact syntax used is *almost* solidified. In the menus, DON'T try to 1339 The exact syntax used is *almost* solidified. In the menus, DON'T try to
1214 [menu] 1376 [menu]
1215 access the current menuBar for alteration 1377 access the current menuBar for alteration
1216 1378
1217 [title:+*string*] 1379 [title:+*string*]
1218 set the current menuBar's title to *string*, which may contain the 1380 set the current menuBar's title to *string*, which may contain the
1219 following format specifiers: %% : literal % character %n : rxvt name 1381 following format specifiers:
1220 (as per the -name command-line option) %v : rxvt version 1382
1383 B<%n> rxvt name (as per the B<-name> command-line option)
1384 B<%v> rxvt version
1385 B<%%> literal B<%> character
1221 1386
1222 [done] 1387 [done]
1223 set menuBar access as readonly. End-of-file tag for [read:+*file*] 1388 set menuBar access as readonly. End-of-file tag for [read:+*file*]
1224 operations. 1389 operations.
1225 1390
1639 XK_KP_8 8 ESC O x 1804 XK_KP_8 8 ESC O x
1640 XK_KP_9 9 ESC O y 1805 XK_KP_9 9 ESC O y
1641 1806
1642CONFIGURE OPTIONS 1807CONFIGURE OPTIONS
1643 General hint: if you get compile errors, then likely your configuration 1808 General hint: if you get compile errors, then likely your configuration
1644 hasn't been tested well. Either try with --enable-everything or use the 1809 hasn't been tested well. Either try with "--enable-everything" or use
1645 ./reconf script as a base for experiments. ./reconf is used by myself, 1810 the ./reconf script as a base for experiments. ./reconf is used by
1646 so it should generally be a working config. Of course, you should always 1811 myself, so it should generally be a working config. Of course, you
1647 report when a combination doesn't work, so it can be fixed. Marc Lehmann 1812 should always report when a combination doesn't work, so it can be
1648 <rxvt@schmorp.de>. 1813 fixed. Marc Lehmann <rxvt@schmorp.de>.
1814
1815 All
1649 1816
1650 --enable-everything 1817 --enable-everything
1651 Add support for all non-multichoice options listed in "./configure 1818 Add (or remove) support for all non-multichoice options listed in
1652 --help". Note that unlike other enable options this is order 1819 "./configure --help".
1653 dependant. You can specify this and then disable options which this
1654 enables by *following* this with the appropriate commands.
1655 1820
1656 --enable-xft 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)
1657 Add support for Xft (anti-aliases, among others) fonts. Xft fonts 1828 Add support for Xft (anti-aliases, among others) fonts. Xft fonts
1658 are slower and require lots of memory, but as long as you don't use 1829 are slower and require lots of memory, but as long as you don't use
1659 them, you don't pay for them. 1830 them, you don't pay for them.
1660 1831
1661 --enable-font-styles 1832 --enable-font-styles (default: on)
1662 Add support for bold, *italic* and *bold italic* font styles. The 1833 Add support for bold, *italic* and *bold italic* font styles. The
1663 fonts can be set manually or automatically. 1834 fonts can be set manually or automatically.
1664 1835
1665 --with-codesets=NAME,... 1836 --with-codesets=NAME,... (default: all)
1666 Compile in support for additional codeset (encoding) groups (eu, vn 1837 Compile in support for additional codeset (encoding) groups ("eu",
1667 are always compiled in, which includes most 8-bit character sets). 1838 "vn" are always compiled in, which includes most 8-bit character
1668 These codeset tables are currently only used for driving X11 core 1839 sets). These codeset tables are used for driving X11 core fonts,
1669 fonts, they are not required for Xft fonts. Compiling them in will 1840 they are not required for Xft fonts, although having them compiled
1670 make your binary bigger (together about 700kB), but it doesn't 1841 in lets rxvt-unicode choose replacement fonts more intelligently.
1671 increase memory usage unless you use an X11 font requiring one of 1842 Compiling them in will make your binary bigger (all of together cost
1672 these encodings. 1843 about 700kB), but it doesn't increase memory usage unless you use a
1844 font requiring one of these encodings.
1673 1845
1674 all all available codeset groups 1846 all all available codeset groups
1675 zh common chinese encodings 1847 zh common chinese encodings
1676 zh_ext rarely used but very big chinese encodigs 1848 zh_ext rarely used but very big chinese encodigs
1677 jp common japanese encodings 1849 jp common japanese encodings
1678 jp_ext rarely used but big japanese encodings 1850 jp_ext rarely used but big japanese encodings
1679 kr korean encodings 1851 kr korean encodings
1680 1852
1681 --enable-xim 1853 --enable-xim (default: on)
1682 Add support for XIM (X Input Method) protocol. This allows using 1854 Add support for XIM (X Input Method) protocol. This allows using
1683 alternative input methods (e.g. kinput2) and will also correctly set 1855 alternative input methods (e.g. kinput2) and will also correctly set
1684 up the input for people using dead keys or compose keys. 1856 up the input for people using dead keys or compose keys.
1685 1857
1686 --enable-unicode3 1858 --enable-unicode3 (default: off)
1687 Enable direct support for displaying unicode codepoints above 65535 1859 Enable direct support for displaying unicode codepoints above 65535
1688 (the basic multilingual page). This increases storage requirements 1860 (the basic multilingual page). This increases storage requirements
1689 per character from 2 to 4 bytes. X11 fonts do not yet support these 1861 per character from 2 to 4 bytes. X11 fonts do not yet support these
1690 extra characters, but Xft does. 1862 extra characters, but Xft does.
1691 1863
1693 even without this flag, but the number of such characters is limited 1865 even without this flag, but the number of such characters is limited
1694 to a view thousand (shared with combining characters, see next 1866 to a view thousand (shared with combining characters, see next
1695 switch), and right now rxvt-unicode cannot display them 1867 switch), and right now rxvt-unicode cannot display them
1696 (input/output and cut&paste still work, though). 1868 (input/output and cut&paste still work, though).
1697 1869
1698 --enable-combining 1870 --enable-combining (default: on)
1699 Enable automatic composition of combining characters into composite 1871 Enable automatic composition of combining characters into composite
1700 characters. This is required for proper viewing of text where 1872 characters. This is required for proper viewing of text where
1701 accents are encoded as seperate unicode characters. This is done by 1873 accents are encoded as seperate unicode characters. This is done by
1702 using precomposited characters when available or creating new 1874 using precomposited characters when available or creating new
1703 pseudo-characters when no precomposed form exists. 1875 pseudo-characters when no precomposed form exists.
1704 1876
1705 Without --enable-unicode3, the number of additional precomposed 1877 Without --enable-unicode3, the number of additional precomposed
1706 characters is rather limited (2048, if this is full, rxvt will use 1878 characters is rather limited (2048, if this is full, rxvt-unicode
1707 the private use area, extending the number of combinations to 8448). 1879 will use the private use area, extending the number of combinations
1708 With --enable-unicode3, no practical limit exists. This will also 1880 to 8448). With --enable-unicode3, no practical limit exists.
1709 enable storage of characters >65535. 1881
1882 This option will also enable storage (but not display) of characters
1883 beyond plane 0 (>65535) when --enable-unicode3 was not specified.
1710 1884
1711 The combining table also contains entries for arabic presentation 1885 The combining table also contains entries for arabic presentation
1712 forms, but these are not currently used. Bug me if you want these to 1886 forms, but these are not currently used. Bug me if you want these to
1713 be used. 1887 be used (and tell me how these are to be used...).
1714 1888
1715 --enable-fallback(=CLASS) 1889 --enable-fallback(=CLASS) (default: Rxvt)
1716 When reading resource settings, also read settings for class CLASS 1890 When reading resource settings, also read settings for class CLASS.
1717 (default: Rxvt). To disable resource fallback use 1891 To disable resource fallback use --disable-fallback.
1718 --disable-fallback.
1719 1892
1720 --with-res-name=NAME 1893 --with-res-name=NAME (default: urxvt)
1721 Use the given name (default: urxvt) as default application name when 1894 Use the given name as default application name when reading
1722 reading resources. Specify --with-res-name=rxvt to replace rxvt. 1895 resources. Specify --with-res-name=rxvt to replace rxvt.
1723 1896
1724 --with-res-class=CLASS 1897 --with-res-class=CLASS /default: URxvt)
1725 Use the given class (default: URxvt) as default application class 1898 Use the given class as default application class when reading
1726 when reading resources. Specify --with-res-class=Rxvt to replace 1899 resources. Specify --with-res-class=Rxvt to replace rxvt.
1727 rxvt.
1728 1900
1729 --enable-utmp 1901 --enable-utmp (default: on)
1730 Write user and tty to utmp file (used by programs like w) at start 1902 Write user and tty to utmp file (used by programs like w) at start
1731 of rxvt execution and delete information when rxvt exits. 1903 of rxvt execution and delete information when rxvt exits.
1732 1904
1733 --enable-wtmp 1905 --enable-wtmp (default: on)
1734 Write user and tty to wtmp file (used by programs like last) at 1906 Write user and tty to wtmp file (used by programs like last) at
1735 start of rxvt execution and write logout when rxvt exits. This 1907 start of rxvt execution and write logout when rxvt exits. This
1736 option requires --enable-utmp to also be specified. 1908 option requires --enable-utmp to also be specified.
1737 1909
1738 --enable-lastlog 1910 --enable-lastlog (default: on)
1739 Write user and tty to lastlog file (used by programs like lastlogin) 1911 Write user and tty to lastlog file (used by programs like lastlogin)
1740 at start of rxvt execution. This option requires --enable-utmp to 1912 at start of rxvt execution. This option requires --enable-utmp to
1741 also be specified. 1913 also be specified.
1742 1914
1743 --enable-xpm-background 1915 --enable-xpm-background (default: on)
1744 Add support for XPM background pixmaps. 1916 Add support for XPM background pixmaps.
1745 1917
1746 --enable-transparency 1918 --enable-transparency (default: on)
1747 Add support for inheriting parent backgrounds thus giving a fake 1919 Add support for inheriting parent backgrounds thus giving a fake
1748 transparency to the term. 1920 transparency to the term.
1749 1921
1750 --enable-fading 1922 --enable-fading (default: on)
1751 Add support for fading the text when focus is lost. 1923 Add support for fading the text when focus is lost (requires
1924 "--enable-transparency").
1752 1925
1753 --enable-tinting 1926 --enable-tinting (default: on)
1754 Add support for tinting of transparent backgrounds. 1927 Add support for tinting of transparent backgrounds (requires
1928 "--enable-transparency").
1755 1929
1756 --enable-menubar 1930 --enable-menubar (default: off) [DEPRECATED]
1757 Add support for our menu bar system (this interacts badly with 1931 Add support for our menu bar system (this interacts badly with
1758 dynamic locale switching currently). 1932 dynamic locale switching currently). This option is DEPRECATED and
1933 will be removed in the future.
1759 1934
1760 --enable-rxvt-scroll 1935 --enable-rxvt-scroll (default: on)
1761 Add support for the original rxvt scrollbar. 1936 Add support for the original rxvt scrollbar.
1762 1937
1763 --enable-next-scroll 1938 --enable-next-scroll (default: on)
1764 Add support for a NeXT-like scrollbar. 1939 Add support for a NeXT-like scrollbar.
1765 1940
1766 --enable-xterm-scroll 1941 --enable-xterm-scroll (default: on)
1767 Add support for an Xterm-like scrollbar. 1942 Add support for an Xterm-like scrollbar.
1768 1943
1769 --enable-plain-scroll 1944 --enable-plain-scroll (default: on)
1770 Add support for a very unobtrusive, plain-looking scrollbar that is 1945 Add support for a very unobtrusive, plain-looking scrollbar that is
1771 the favourite of the rxvt-unicode author, having used it for many 1946 the favourite of the rxvt-unicode author, having used it for many
1772 years. 1947 years.
1773 1948
1774 --enable-half-shadow 1949 --enable-half-shadow (default: off)
1775 Make shadows on the scrollbar only half the normal width & height. 1950 Make shadows on the scrollbar only half the normal width & height.
1776 only applicable to rxvt scrollbars. 1951 only applicable to rxvt scrollbars.
1777 1952
1778 --enable-ttygid 1953 --enable-ttygid (default: off)
1779 Change tty device setting to group "tty" - only use this if your 1954 Change tty device setting to group "tty" - only use this if your
1780 system uses this type of security. 1955 system uses this type of security.
1781 1956
1782 --disable-backspace-key 1957 --disable-backspace-key
1783 Disable any handling of the backspace key by us - let the X server 1958 Removes any handling of the backspace key by us - let the X server
1784 do it. 1959 do it.
1785 1960
1786 --disable-delete-key 1961 --disable-delete-key
1787 Disable any handling of the delete key by us - let the X server do 1962 Removes any handling of the delete key by us - let the X server do
1788 it. 1963 it.
1789 1964
1790 --disable-resources 1965 --disable-resources
1791 Remove all resources checking. 1966 Removes any support for resource checking.
1792 1967
1793 --enable-xgetdefault 1968 --enable-xgetdefault
1794 Make resources checking via XGetDefault() instead of our small 1969 Make resources checking via XGetDefault() instead of our small
1795 version which only checks ~/.Xdefaults, or if that doesn't exist 1970 version which only checks ~/.Xdefaults, or if that doesn't exist
1796 then ~/.Xresources. 1971 then ~/.Xresources.
1797 1972
1798 Please note that nowadays, things like XIM will automatically pull 1973 Please note that nowadays, things like XIM will automatically pull
1799 in and use the full X resource manager, so the overhead of using it 1974 in and use the full X resource manager, so the overhead of using it
1800 might be very small, if nonexistant. 1975 might be very small, if nonexistant.
1801 1976
1802 --enable-strings 1977 --enable-strings (default: off)
1803 Add support for our possibly faster memset() function and other 1978 Add support for our possibly faster memset() function and other
1804 various routines, overriding your system's versions which may have 1979 various routines, overriding your system's versions which may have
1805 been hand-crafted in assembly or may require extra libraries to link 1980 been hand-crafted in assembly or may require extra libraries to link
1806 in. (this breaks ANSI-C rules and has problems on many GNU/Linux 1981 in. (this breaks ANSI-C rules and has problems on many GNU/Linux
1807 systems). 1982 systems).
1808 1983
1809 --disable-swapscreen 1984 --disable-swapscreen
1810 Remove support for swap screen. 1985 Remove support for secondary/swap screen.
1811 1986
1812 --enable-frills 1987 --enable-frills (default: on)
1813 Add support for many small features that are not essential but nice 1988 Add support for many small features that are not essential but nice
1814 to have. Normally you want this, but for very small binaries you may 1989 to have. Normally you want this, but for very small binaries you may
1815 want to disable this. 1990 want to disable this.
1816 1991
1817 A non-exhaustive list of features enabled by "--enable-frills" 1992 A non-exhaustive list of features enabled by "--enable-frills"
1818 (possibly in combination with other switches) is: 1993 (possibly in combination with other switches) is:
1819 1994
1820 MWM-hints 1995 MWM-hints
1996 EWMH-hints (pid, utf8 names) and protocols (ping)
1821 seperate underline colour 1997 seperate underline colour (-underlineColor)
1822 settable border widths and borderless switch 1998 settable border widths and borderless switch (-w, -b, -bl)
1823 settable extra linespacing 1999 settable extra linespacing /-lsp)
1824 extra window properties (e.g. UTF-8 window names and PID)
1825 iso-14755-2 and -3, and visual feedback 2000 iso-14755-2 and -3, and visual feedback
1826 backindex and forwardindex escape sequence 2001 backindex and forwardindex escape sequence
1827 window op and locale change escape sequences 2002 window op and some xterm/OSC escape sequences
1828 tripleclickwords 2003 tripleclickwords (-tcw)
1829 settable insecure mode 2004 settable insecure mode (-insecure)
1830 keysym remapping support 2005 keysym remapping support
2006 cursor blinking and underline cursor (-cb, -uc)
2007 XEmbed support (-embed)
2008 user-pty (-pty-fd)
2009 hold on exit (-hold)
2010 skip builtin block graphics (-sbg)
2011 sgr modes 90..97 and 100..107
1831 2012
1832 --enable-iso14755 2013 --enable-iso14755 (default: on)
1833 Enable extended ISO 14755 support (see rxvt(1), or doc/rxvt.1.txt). 2014 Enable extended ISO 14755 support (see rxvt(1), or doc/rxvt.1.txt).
1834 Basic support (section 5.1) is enabled by "--enable-frills", while 2015 Basic support (section 5.1) is enabled by "--enable-frills", while
1835 support for 5.2, 5.3 and 5.4 is enabled with this switch. 2016 support for 5.2, 5.3 and 5.4 is enabled with this switch.
1836 2017
1837 --enable-keepscrolling 2018 --enable-keepscrolling (default: on)
1838 Add support for continual scrolling of the display when you hold the 2019 Add support for continual scrolling of the display when you hold the
1839 mouse button down on a scrollbar arrow. 2020 mouse button down on a scrollbar arrow.
1840 2021
1841 --enable-mousewheel 2022 --enable-mousewheel (default: on)
1842 Add support for scrolling via mouse wheel or buttons 4 & 5. 2023 Add support for scrolling via mouse wheel or buttons 4 & 5.
1843 2024
1844 --enable-slipwheeling 2025 --enable-slipwheeling (default: on)
1845 Add support for continual scrolling (using the mouse wheel as an 2026 Add support for continual scrolling (using the mouse wheel as an
1846 accelerator) while the control key is held down. This option 2027 accelerator) while the control key is held down. This option
1847 requires --enable-mousewheel to also be specified. 2028 requires --enable-mousewheel to also be specified.
1848 2029
1849 --disable-new-selection 2030 --disable-new-selection
1850 Remove support for mouse selection style like that of xterm. 2031 Remove support for mouse selection style like that of xterm.
1851 2032
1852 --enable-dmalloc 2033 --enable-dmalloc (default: off)
1853 Use Gray Watson's malloc - which is good for debugging See 2034 Use Gray Watson's malloc - which is good for debugging See
1854 http://www.letters.com/dmalloc/ for details If you use either this 2035 http://www.letters.com/dmalloc/ for details If you use either this
1855 or the next option, you may need to edit src/Makefile after 2036 or the next option, you may need to edit src/Makefile after
1856 compiling to point DINCLUDE and DLIB to the right places. 2037 compiling to point DINCLUDE and DLIB to the right places.
1857 2038
1858 You can only use either this option and the following (should you 2039 You can only use either this option and the following (should you
1859 use either) . 2040 use either) .
1860 2041
1861 --enable-dlmalloc 2042 --enable-dlmalloc (default: off)
1862 Use Doug Lea's malloc - which is good for a production version See 2043 Use Doug Lea's malloc - which is good for a production version See
1863 <http://g.oswego.edu/dl/html/malloc.html> for details. 2044 <http://g.oswego.edu/dl/html/malloc.html> for details.
1864 2045
1865 --enable-smart-resize 2046 --enable-smart-resize (default: on)
1866 Add smart growth/shrink behaviour when changing font size via from 2047 Add smart growth/shrink behaviour when changing font size via hot
1867 hot keys. This should keep in a fixed position the rxvt corner which 2048 keys. This should keep the window corner which is closest to a
1868 is closest to a corner of the screen. 2049 corner of the screen in a fixed position.
1869 2050
1870 --enable-cursor-blink
1871 Add support for a blinking cursor.
1872
1873 --enable-pointer-blank 2051 --enable-pointer-blank (default: on)
1874 Add support to have the pointer disappear when typing or inactive. 2052 Add support to have the pointer disappear when typing or inactive.
1875 2053
1876 --with-name=NAME 2054 --enable-perl (default: off)
2055 Enable an embedded perl interpreter. See the rxvtperl(3) manpage
2056 (doc/rxvtperl.txt) for more info on this feature, or the files in
2057 src/perl-ext/ for the extensions that are installed by default. The
2058 perl interpreter that is used can be specified via the "PERL"
2059 environment variable when running configure.
2060
2061 --with-name=NAME (default: urxvt)
1877 Set the basename for the installed binaries (default: "urxvt", 2062 Set the basename for the installed binaries, resulting in "urxvt",
1878 resulting in "urxvt", "urxvtd" etc.). Specify "--with-name=rxvt" to 2063 "urxvtd" etc.). Specify "--with-name=rxvt" to replace with "rxvt".
1879 replace with "rxvt".
1880 2064
1881 --with-term=NAME 2065 --with-term=NAME (default: rxvt-unicode)
1882 Change the environmental variable for the terminal to NAME (default 2066 Change the environmental variable for the terminal to NAME.
1883 "rxvt-unicode")
1884 2067
1885 --with-terminfo=PATH 2068 --with-terminfo=PATH
1886 Change the environmental variable for the path to the terminfo tree 2069 Change the environmental variable for the path to the terminfo tree
1887 to PATH. 2070 to PATH.
1888 2071

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines