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.13 by root, Mon Feb 14 10:44:50 2005 UTC vs.
Revision 1.30 by root, Mon Jan 2 19:36:07 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 aminute 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
… …
66 URxvt.termName: rxvt 151 URxvt.termName: rxvt
67 152
68 If you don't plan to use rxvt (quite common...) you could also 153 If you don't plan to use rxvt (quite common...) you could also
69 replace the rxvt terminfo file with the rxvt-unicode one. 154 replace the rxvt terminfo file with the rxvt-unicode one.
70 155
156 "tic" outputs some error when compiling the terminfo entry.
157 Most likely it's the empty definition for "enacs=". Just replace it
158 by "enacs=\E[0@" and try again.
159
71 "bash"'s readline does not work correctly under rxvt. 160 "bash"'s readline does not work correctly under rxvt.
72 I need a termcap file entry. 161 I need a termcap file entry.
73 One reason you might want this is that some distributions or 162 One reason you might want this is that some distributions or
74 operating systems still compile some programs using the 163 operating systems still compile some programs using the
75 long-obsoleted termcap (Fedora Core's bash is one example) and rely 164 long-obsoleted termcap library (Fedora Core's bash is one example)
76 on a termcap entry for "rxvt-unicode". 165 and rely on a termcap entry for "rxvt-unicode".
77 166
78 You could use rxvt's termcap entry with resonable results in many 167 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 168 cases. You can also create a termcap entry by using terminfo's
80 infocmp program like this: 169 infocmp program like this:
81 170
… …
83 172
84 Or you could use this termcap entry, generated by the command above: 173 Or you could use this termcap entry, generated by the command above:
85 174
86 rxvt-unicode|rxvt-unicode terminal (X Window System):\ 175 rxvt-unicode|rxvt-unicode terminal (X Window System):\
87 :am:bw:eo:km:mi:ms:xn:xo:\ 176 :am:bw:eo:km:mi:ms:xn:xo:\
88 :co#80:it#8:li#24:\ 177 :co#80:it#8:li#24:lm#0:\
89 :AL=\E[%dL:DC=\E[%dP:DL=\E[%dM:DO=\E[%dB:IC=\E[%d@:\ 178 :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:\ 179 :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:\ 180 :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:\ 181 :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:\ 182 :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[@:\ 183 :dl=\E[M:do=^J:ec=\E[%dX:ei=\E[4l:ho=\E[H:\
184 :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:\ 185 :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~:\ 186 :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~:\ 187 :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:\ 188 :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=:\ 189 :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:\ 190 :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:\ 191 :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:\ 192 :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:\ 193 :us=\E[4m:vb=\E[?5h\E[?5l:ve=\E[?25h:vi=\E[?25l:\
104 :vs=\E[?25h: 194 :vs=\E[?25h:
105 195
106 Why does "ls" no longer have coloured output? 196 Why does "ls" no longer have coloured output?
107 The "ls" in the GNU coreutils unfortunately doesn't use terminfo to 197 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 198 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. 336 that doesn't work, you might be forced to use a different font.
247 337
248 All of this is not a problem when using X11 core fonts, as their 338 All of this is not a problem when using X11 core fonts, as their
249 bounding box data is correct. 339 bounding box data is correct.
250 340
341 On Solaris 9, many line-drawing characters are too wide.
342 Seems to be a known bug, read
343 <http://nixdoc.net/files/forum/about34198.html>. Some people use the
344 following ugly workaround to get non-double-wide-characters working:
345
346 #define wcwidth(x) wcwidth(x) > 1 ? 1 : wcwidth(x)
347
251 My Compose (Multi_key) key is no longer working. 348 My Compose (Multi_key) key is no longer working.
252 The most common causes for this are that either your locale is not 349 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 350 set correctly, or you specified a preeditStyle that is not supported
254 by your input method. For example, if you specified OverTheSpot and 351 by your input method. For example, if you specified OverTheSpot and
255 your input method (e.g. the default input method handling Compose 352 your input method (e.g. the default input method handling Compose
… …
299 As you might have guessed, FreeBSD does neither define this symobl 396 As you might have guessed, FreeBSD does neither define this symobl
300 nor does it support it. Instead, it uses it's own internal 397 nor does it support it. Instead, it uses it's own internal
301 representation of wchar_t. This is, of course, completely fine with 398 representation of wchar_t. This is, of course, completely fine with
302 respect to standards. 399 respect to standards.
303 400
401 However, that means rxvt-unicode only works in "POSIX", "ISO-8859-1"
402 and "UTF-8" locales under FreeBSD (which all use Unicode as wchar_t.
403
304 However, "__STDC_ISO_10646__" is the only sane way to support 404 "__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 405 apps in an OS, as using a locale-dependent (and non-standardized)
306 non-standardized) representation of wchar_t makes it impossible to 406 representation of wchar_t makes it impossible to convert between
307 convert between wchar_t (as used by X11 and your applications) and 407 wchar_t (as used by X11 and your applications) and any other
308 any other encoding without implementing OS-specific-wrappers for 408 encoding without implementing OS-specific-wrappers for each and
309 each and every locale. There simply are no APIs to convert wchar_t 409 every locale. There simply are no APIs to convert wchar_t into
310 into anything except the current locale encoding. 410 anything except the current locale encoding.
311 411
312 Some applications (such as the formidable mlterm) work around this 412 Some applications (such as the formidable mlterm) work around this
313 by carrying their own replacement functions for character set 413 by carrying their own replacement functions for character set
314 handling with them, and either implementing OS-dependent hacks or 414 handling with them, and either implementing OS-dependent hacks or
315 doing multiple conversions (which is slow and unreliable in case the 415 doing multiple conversions (which is slow and unreliable in case the
… …
317 emulator). 417 emulator).
318 418
319 The rxvt-unicode author insists that the right way to fix this is in 419 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 420 the system libraries once and for all, instead of forcing every app
321 to carry complete replacements for them :) 421 to carry complete replacements for them :)
422
423 I use Solaris 9 and it doesn't compile/work/etc.
424 Try the diff in doc/solaris9.patch as a base. It fixes the worst
425 problems with "wcwidth" and a compile problem.
426
427 How can I use rxvt-unicode under cygwin?
428 rxvt-unicode should compile and run out of the box on cygwin, using
429 the X11 libraries that come with cygwin. libW11 emulation is no
430 longer supported (and makes no sense, either, as it only supported a
431 single font). I recommend starting the X-server in "-multiwindow" or
432 "-rootless" mode instead, which will result in similar look&feel as
433 the old libW11 emulation.
434
435 At the time of this writing, cygwin didn't seem to support any
436 multi-byte encodings (you might try "LC_CTYPE=C-UTF-8"), so you are
437 likely limited to 8-bit encodings.
322 438
323 How does rxvt-unicode determine the encoding to use? 439 How does rxvt-unicode determine the encoding to use?
324 Is there an option to switch encodings? 440 Is there an option to switch encodings?
325 Unlike some other terminals, rxvt-unicode has no encoding switch, 441 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 442 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. 554 it gets worse, as rxvt-unicode then uses 8 bytes per screen cell.
439 555
440 Can I speed up Xft rendering somehow? 556 Can I speed up Xft rendering somehow?
441 Yes, the most obvious way to speed it up is to avoid Xft entirely, 557 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 558 as it is simply slow. If you still want Xft fonts you might try to
443 disable antialiasing (by appending ":antialiasing=false"), which 559 disable antialiasing (by appending ":antialias=false"), which saves
444 saves lots of memory and also speeds up rendering considerably. 560 lots of memory and also speeds up rendering considerably.
445 561
446 Rxvt-unicode doesn't seem to anti-alias its fonts, what is wrong? 562 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 563 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 564 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 565 fonts, because they are small and fast, and then use Xft fonts. It
… …
521 URxvt.color14: #73f7ff 637 URxvt.color14: #73f7ff
522 URxvt.color7: #e1dddd 638 URxvt.color7: #e1dddd
523 URxvt.color15: #e1dddd 639 URxvt.color15: #e1dddd
524 640
525 How can I start rxvtd in a race-free way? 641 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 642 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 643 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 644
535 What's with the strange Backspace/Delete key behaviour? 645 What's with the strange Backspace/Delete key behaviour?
536 Assuming that the physical Backspace key corresponds to the 646 Assuming that the physical Backspace key corresponds to the
537 BackSpace keysym (not likely for Linux ... see the following 647 BackSpace keysym (not likely for Linux ... see the following
538 question) there are two standard values that can be used for 648 question) there are two standard values that can be used for
… …
1121 1231
1122 "Ps = 1011" (rxvt) 1232 "Ps = 1011" (rxvt)
1123 h Scroll to bottom when a key is pressed 1233 h Scroll to bottom when a key is pressed
1124 l Don't scroll to bottom when a key is pressed 1234 l Don't scroll to bottom when a key is pressed
1125 1235
1236 "Ps = 1021" (rxvt)
1237 h Bold/italic implies high intensity (see option -is)
1238 l Font styles have no effect on intensity (Compile styles)
1239
1126 "Ps = 1047" 1240 "Ps = 1047"
1127 h Use Alternate Screen Buffer 1241 h Use Alternate Screen Buffer
1128 l Use Normal Screen Buffer - clear Alternate Screen Buffer if returning from it 1242 l Use Normal Screen Buffer - clear Alternate Screen Buffer if returning from it
1129 1243
1130 "Ps = 1048" 1244 "Ps = 1048"
… …
1155 Ps = 13 Change colour of mouse foreground to Pt 1269 Ps = 13 Change colour of mouse foreground to Pt
1156 Ps = 17 Change colour of highlight characters to Pt 1270 Ps = 17 Change colour of highlight characters to Pt
1157 Ps = 18 Change colour of bold characters to Pt 1271 Ps = 18 Change colour of bold characters to Pt
1158 Ps = 19 Change colour of underlined characters to Pt 1272 Ps = 19 Change colour of underlined characters to Pt
1159 Ps = 20 Change default background to Pt 1273 Ps = 20 Change default background to Pt
1160 Ps = 39 Change default foreground colour to Pt rxvt compile-time option 1274 Ps = 39 Change default foreground colour to Pt.
1161 Ps = 46 Change Log File to Pt unimplemented 1275 Ps = 46 Change Log File to Pt unimplemented
1162 Ps = 49 Change default background colour to Pt rxvt compile-time option 1276 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 1277 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 1278 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) 1279 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) 1280 Ps = 703 Menubar command Pt (Compile menubar).
1167 Ps = 704 Change colour of italic characters to Pt 1281 Ps = 704 Change colour of italic characters to Pt
1168 Ps = 705 Change background pixmap tint colour to Pt 1282 Ps = 705 Change background pixmap tint colour to Pt (Compile transparency).
1169 Ps = 710 Set normal fontset to Pt. Same as Ps = 50. 1283 Ps = 710 Set normal fontset to Pt. Same as Ps = 50.
1170 Ps = 711 Set bold fontset to Pt. Similar to Ps = 50. 1284 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. 1285 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. 1286 Ps = 713 Set bold-italic fontset to Pt. Similar to Ps = 50 (Compile styles).
1287 Ps = 720 Move viewing window up by Pt lines, or clear scrollback buffer if Pt = 0 (Compile frills).
1288 Ps = 721 Move viewing window down by Pt lines, or clear scrollback buffer if Pt = 0 (Compile frills).
1173 1289
1174 1290
1175 1291
1176menuBar 1292menuBar
1177 The exact syntax used is *almost* solidified. In the menus, DON'T try to 1293 The exact syntax used is *almost* solidified. In the menus, DON'T try to
… …
1642 XK_KP_8 8 ESC O x 1758 XK_KP_8 8 ESC O x
1643 XK_KP_9 9 ESC O y 1759 XK_KP_9 9 ESC O y
1644 1760
1645CONFIGURE OPTIONS 1761CONFIGURE OPTIONS
1646 General hint: if you get compile errors, then likely your configuration 1762 General hint: if you get compile errors, then likely your configuration
1647 hasn't been tested well. Either try with --enable-everything or use the 1763 hasn't been tested well. Either try with "--enable-everything" or use
1648 ./reconf script as a base for experiments. ./reconf is used by myself, 1764 the ./reconf script as a base for experiments. ./reconf is used by
1649 so it should generally be a working config. Of course, you should always 1765 myself, so it should generally be a working config. Of course, you
1650 report when a combination doesn't work, so it can be fixed. Marc Lehmann 1766 should always report when a combination doesn't work, so it can be
1651 <rxvt@schmorp.de>. 1767 fixed. Marc Lehmann <rxvt@schmorp.de>.
1768
1769 All
1652 1770
1653 --enable-everything 1771 --enable-everything
1654 Add support for all non-multichoice options listed in "./configure 1772 Add (or remove) support for all non-multichoice options listed in
1655 --help". Note that unlike other enable options this is order 1773 "./configure --help".
1656 dependant. You can specify this and then disable options which this
1657 enables by *following* this with the appropriate commands.
1658 1774
1659 --enable-xft 1775 You can specify this and then disable options you do not like by
1776 *following* this with the appropriate "--disable-..." arguments, or
1777 you can start with a minimal configuration by specifying
1778 "--disable-everything" and than adding just the "--enable-..."
1779 arguments you want.
1780
1781 --enable-xft (default: enabled)
1660 Add support for Xft (anti-aliases, among others) fonts. Xft fonts 1782 Add support for Xft (anti-aliases, among others) fonts. Xft fonts
1661 are slower and require lots of memory, but as long as you don't use 1783 are slower and require lots of memory, but as long as you don't use
1662 them, you don't pay for them. 1784 them, you don't pay for them.
1663 1785
1664 --enable-font-styles 1786 --enable-font-styles (default: on)
1665 Add support for bold, *italic* and *bold italic* font styles. The 1787 Add support for bold, *italic* and *bold italic* font styles. The
1666 fonts can be set manually or automatically. 1788 fonts can be set manually or automatically.
1667 1789
1668 --with-codesets=NAME,... 1790 --with-codesets=NAME,... (default: all)
1669 Compile in support for additional codeset (encoding) groups (eu, vn 1791 Compile in support for additional codeset (encoding) groups ("eu",
1670 are always compiled in, which includes most 8-bit character sets). 1792 "vn" are always compiled in, which includes most 8-bit character
1671 These codeset tables are currently only used for driving X11 core 1793 sets). These codeset tables are used for driving X11 core fonts,
1672 fonts, they are not required for Xft fonts. Compiling them in will 1794 they are not required for Xft fonts, although having them compiled
1673 make your binary bigger (together about 700kB), but it doesn't 1795 in lets rxvt-unicode choose replacement fonts more intelligently.
1674 increase memory usage unless you use an X11 font requiring one of 1796 Compiling them in will make your binary bigger (all of together cost
1675 these encodings. 1797 about 700kB), but it doesn't increase memory usage unless you use a
1798 font requiring one of these encodings.
1676 1799
1677 all all available codeset groups 1800 all all available codeset groups
1678 zh common chinese encodings 1801 zh common chinese encodings
1679 zh_ext rarely used but very big chinese encodigs 1802 zh_ext rarely used but very big chinese encodigs
1680 jp common japanese encodings 1803 jp common japanese encodings
1681 jp_ext rarely used but big japanese encodings 1804 jp_ext rarely used but big japanese encodings
1682 kr korean encodings 1805 kr korean encodings
1683 1806
1684 --enable-xim 1807 --enable-xim (default: on)
1685 Add support for XIM (X Input Method) protocol. This allows using 1808 Add support for XIM (X Input Method) protocol. This allows using
1686 alternative input methods (e.g. kinput2) and will also correctly set 1809 alternative input methods (e.g. kinput2) and will also correctly set
1687 up the input for people using dead keys or compose keys. 1810 up the input for people using dead keys or compose keys.
1688 1811
1689 --enable-unicode3 1812 --enable-unicode3 (default: off)
1690 Enable direct support for displaying unicode codepoints above 65535 1813 Enable direct support for displaying unicode codepoints above 65535
1691 (the basic multilingual page). This increases storage requirements 1814 (the basic multilingual page). This increases storage requirements
1692 per character from 2 to 4 bytes. X11 fonts do not yet support these 1815 per character from 2 to 4 bytes. X11 fonts do not yet support these
1693 extra characters, but Xft does. 1816 extra characters, but Xft does.
1694 1817
… …
1696 even without this flag, but the number of such characters is limited 1819 even without this flag, but the number of such characters is limited
1697 to a view thousand (shared with combining characters, see next 1820 to a view thousand (shared with combining characters, see next
1698 switch), and right now rxvt-unicode cannot display them 1821 switch), and right now rxvt-unicode cannot display them
1699 (input/output and cut&paste still work, though). 1822 (input/output and cut&paste still work, though).
1700 1823
1701 --enable-combining 1824 --enable-combining (default: on)
1702 Enable automatic composition of combining characters into composite 1825 Enable automatic composition of combining characters into composite
1703 characters. This is required for proper viewing of text where 1826 characters. This is required for proper viewing of text where
1704 accents are encoded as seperate unicode characters. This is done by 1827 accents are encoded as seperate unicode characters. This is done by
1705 using precomposited characters when available or creating new 1828 using precomposited characters when available or creating new
1706 pseudo-characters when no precomposed form exists. 1829 pseudo-characters when no precomposed form exists.
… …
1715 1838
1716 The combining table also contains entries for arabic presentation 1839 The combining table also contains entries for arabic presentation
1717 forms, but these are not currently used. Bug me if you want these to 1840 forms, but these are not currently used. Bug me if you want these to
1718 be used (and tell me how these are to be used...). 1841 be used (and tell me how these are to be used...).
1719 1842
1720 --enable-fallback(=CLASS) 1843 --enable-fallback(=CLASS) (default: Rxvt)
1721 When reading resource settings, also read settings for class CLASS 1844 When reading resource settings, also read settings for class CLASS.
1722 (default: Rxvt). To disable resource fallback use 1845 To disable resource fallback use --disable-fallback.
1723 --disable-fallback.
1724 1846
1725 --with-res-name=NAME 1847 --with-res-name=NAME (default: urxvt)
1726 Use the given name (default: urxvt) as default application name when 1848 Use the given name as default application name when reading
1727 reading resources. Specify --with-res-name=rxvt to replace rxvt. 1849 resources. Specify --with-res-name=rxvt to replace rxvt.
1728 1850
1729 --with-res-class=CLASS 1851 --with-res-class=CLASS /default: URxvt)
1730 Use the given class (default: URxvt) as default application class 1852 Use the given class as default application class when reading
1731 when reading resources. Specify --with-res-class=Rxvt to replace 1853 resources. Specify --with-res-class=Rxvt to replace rxvt.
1732 rxvt.
1733 1854
1734 --enable-utmp 1855 --enable-utmp (default: on)
1735 Write user and tty to utmp file (used by programs like w) at start 1856 Write user and tty to utmp file (used by programs like w) at start
1736 of rxvt execution and delete information when rxvt exits. 1857 of rxvt execution and delete information when rxvt exits.
1737 1858
1738 --enable-wtmp 1859 --enable-wtmp (default: on)
1739 Write user and tty to wtmp file (used by programs like last) at 1860 Write user and tty to wtmp file (used by programs like last) at
1740 start of rxvt execution and write logout when rxvt exits. This 1861 start of rxvt execution and write logout when rxvt exits. This
1741 option requires --enable-utmp to also be specified. 1862 option requires --enable-utmp to also be specified.
1742 1863
1743 --enable-lastlog 1864 --enable-lastlog (default: on)
1744 Write user and tty to lastlog file (used by programs like lastlogin) 1865 Write user and tty to lastlog file (used by programs like lastlogin)
1745 at start of rxvt execution. This option requires --enable-utmp to 1866 at start of rxvt execution. This option requires --enable-utmp to
1746 also be specified. 1867 also be specified.
1747 1868
1748 --enable-xpm-background 1869 --enable-xpm-background (default: off)
1749 Add support for XPM background pixmaps. 1870 Add support for XPM background pixmaps.
1750 1871
1751 --enable-transparency 1872 --enable-transparency (default: off)
1752 Add support for inheriting parent backgrounds thus giving a fake 1873 Add support for inheriting parent backgrounds thus giving a fake
1753 transparency to the term. 1874 transparency to the term.
1754 1875
1755 --enable-fading 1876 --enable-fading (default: on)
1756 Add support for fading the text when focus is lost. 1877 Add support for fading the text when focus is lost (requires
1878 "--enable-transparency").
1757 1879
1758 --enable-tinting 1880 --enable-tinting (default: on)
1759 Add support for tinting of transparent backgrounds. 1881 Add support for tinting of transparent backgrounds (requires
1882 "--enable-transparency").
1760 1883
1761 --enable-menubar 1884 --enable-menubar (default: off)
1762 Add support for our menu bar system (this interacts badly with 1885 Add support for our menu bar system (this interacts badly with
1763 dynamic locale switching currently). 1886 dynamic locale switching currently).
1764 1887
1765 --enable-rxvt-scroll 1888 --enable-rxvt-scroll (default: on)
1766 Add support for the original rxvt scrollbar. 1889 Add support for the original rxvt scrollbar.
1767 1890
1768 --enable-next-scroll 1891 --enable-next-scroll (default: on)
1769 Add support for a NeXT-like scrollbar. 1892 Add support for a NeXT-like scrollbar.
1770 1893
1771 --enable-xterm-scroll 1894 --enable-xterm-scroll (default: on)
1772 Add support for an Xterm-like scrollbar. 1895 Add support for an Xterm-like scrollbar.
1773 1896
1774 --enable-plain-scroll 1897 --enable-plain-scroll (default: on)
1775 Add support for a very unobtrusive, plain-looking scrollbar that is 1898 Add support for a very unobtrusive, plain-looking scrollbar that is
1776 the favourite of the rxvt-unicode author, having used it for many 1899 the favourite of the rxvt-unicode author, having used it for many
1777 years. 1900 years.
1778 1901
1779 --enable-half-shadow 1902 --enable-half-shadow (default: off)
1780 Make shadows on the scrollbar only half the normal width & height. 1903 Make shadows on the scrollbar only half the normal width & height.
1781 only applicable to rxvt scrollbars. 1904 only applicable to rxvt scrollbars.
1782 1905
1783 --enable-ttygid 1906 --enable-ttygid (default: off)
1784 Change tty device setting to group "tty" - only use this if your 1907 Change tty device setting to group "tty" - only use this if your
1785 system uses this type of security. 1908 system uses this type of security.
1786 1909
1787 --disable-backspace-key 1910 --disable-backspace-key
1788 Disable any handling of the backspace key by us - let the X server 1911 Removes any handling of the backspace key by us - let the X server
1789 do it. 1912 do it.
1790 1913
1791 --disable-delete-key 1914 --disable-delete-key
1792 Disable any handling of the delete key by us - let the X server do 1915 Removes any handling of the delete key by us - let the X server do
1793 it. 1916 it.
1794 1917
1795 --disable-resources 1918 --disable-resources
1796 Remove all resources checking. 1919 Removes any support for resource checking.
1797 1920
1798 --enable-xgetdefault 1921 --enable-xgetdefault
1799 Make resources checking via XGetDefault() instead of our small 1922 Make resources checking via XGetDefault() instead of our small
1800 version which only checks ~/.Xdefaults, or if that doesn't exist 1923 version which only checks ~/.Xdefaults, or if that doesn't exist
1801 then ~/.Xresources. 1924 then ~/.Xresources.
1802 1925
1803 Please note that nowadays, things like XIM will automatically pull 1926 Please note that nowadays, things like XIM will automatically pull
1804 in and use the full X resource manager, so the overhead of using it 1927 in and use the full X resource manager, so the overhead of using it
1805 might be very small, if nonexistant. 1928 might be very small, if nonexistant.
1806 1929
1807 --enable-strings 1930 --enable-strings (default: off)
1808 Add support for our possibly faster memset() function and other 1931 Add support for our possibly faster memset() function and other
1809 various routines, overriding your system's versions which may have 1932 various routines, overriding your system's versions which may have
1810 been hand-crafted in assembly or may require extra libraries to link 1933 been hand-crafted in assembly or may require extra libraries to link
1811 in. (this breaks ANSI-C rules and has problems on many GNU/Linux 1934 in. (this breaks ANSI-C rules and has problems on many GNU/Linux
1812 systems). 1935 systems).
1813 1936
1814 --disable-swapscreen 1937 --disable-swapscreen
1815 Remove support for swap screen. 1938 Remove support for secondary/swap screen.
1816 1939
1817 --enable-frills 1940 --enable-frills (default: on)
1818 Add support for many small features that are not essential but nice 1941 Add support for many small features that are not essential but nice
1819 to have. Normally you want this, but for very small binaries you may 1942 to have. Normally you want this, but for very small binaries you may
1820 want to disable this. 1943 want to disable this.
1821 1944
1822 A non-exhaustive list of features enabled by "--enable-frills" 1945 A non-exhaustive list of features enabled by "--enable-frills"
1823 (possibly in combination with other switches) is: 1946 (possibly in combination with other switches) is:
1824 1947
1825 MWM-hints 1948 MWM-hints
1949 EWMH-hints (pid, utf8 names) and protocols (ping)
1826 seperate underline colour 1950 seperate underline colour
1827 settable border widths and borderless switch 1951 settable border widths and borderless switch
1828 settable extra linespacing 1952 settable extra linespacing
1829 extra window properties (e.g. UTF-8 window names and PID)
1830 iso-14755-2 and -3, and visual feedback 1953 iso-14755-2 and -3, and visual feedback
1831 backindex and forwardindex escape sequence 1954 backindex and forwardindex escape sequence
1832 window op and locale change escape sequences 1955 window op and some xterm/OSC escape sequences
1833 tripleclickwords 1956 tripleclickwords
1834 settable insecure mode 1957 settable insecure mode
1835 keysym remapping support 1958 keysym remapping support
1959 cursor blinking and underline cursor
1960 -embed, -pty-fd and -hold options
1836 1961
1837 --enable-iso14755 1962 --enable-iso14755 (default: on)
1838 Enable extended ISO 14755 support (see rxvt(1), or doc/rxvt.1.txt). 1963 Enable extended ISO 14755 support (see rxvt(1), or doc/rxvt.1.txt).
1839 Basic support (section 5.1) is enabled by "--enable-frills", while 1964 Basic support (section 5.1) is enabled by "--enable-frills", while
1840 support for 5.2, 5.3 and 5.4 is enabled with this switch. 1965 support for 5.2, 5.3 and 5.4 is enabled with this switch.
1841 1966
1842 --enable-keepscrolling 1967 --enable-keepscrolling (default: on)
1843 Add support for continual scrolling of the display when you hold the 1968 Add support for continual scrolling of the display when you hold the
1844 mouse button down on a scrollbar arrow. 1969 mouse button down on a scrollbar arrow.
1845 1970
1846 --enable-mousewheel 1971 --enable-mousewheel (default: on)
1847 Add support for scrolling via mouse wheel or buttons 4 & 5. 1972 Add support for scrolling via mouse wheel or buttons 4 & 5.
1848 1973
1849 --enable-slipwheeling 1974 --enable-slipwheeling (default: on)
1850 Add support for continual scrolling (using the mouse wheel as an 1975 Add support for continual scrolling (using the mouse wheel as an
1851 accelerator) while the control key is held down. This option 1976 accelerator) while the control key is held down. This option
1852 requires --enable-mousewheel to also be specified. 1977 requires --enable-mousewheel to also be specified.
1853 1978
1854 --disable-new-selection 1979 --disable-new-selection
1855 Remove support for mouse selection style like that of xterm. 1980 Remove support for mouse selection style like that of xterm.
1856 1981
1857 --enable-dmalloc 1982 --enable-dmalloc (default: off)
1858 Use Gray Watson's malloc - which is good for debugging See 1983 Use Gray Watson's malloc - which is good for debugging See
1859 http://www.letters.com/dmalloc/ for details If you use either this 1984 http://www.letters.com/dmalloc/ for details If you use either this
1860 or the next option, you may need to edit src/Makefile after 1985 or the next option, you may need to edit src/Makefile after
1861 compiling to point DINCLUDE and DLIB to the right places. 1986 compiling to point DINCLUDE and DLIB to the right places.
1862 1987
1863 You can only use either this option and the following (should you 1988 You can only use either this option and the following (should you
1864 use either) . 1989 use either) .
1865 1990
1866 --enable-dlmalloc 1991 --enable-dlmalloc (default: off)
1867 Use Doug Lea's malloc - which is good for a production version See 1992 Use Doug Lea's malloc - which is good for a production version See
1868 <http://g.oswego.edu/dl/html/malloc.html> for details. 1993 <http://g.oswego.edu/dl/html/malloc.html> for details.
1869 1994
1870 --enable-smart-resize 1995 --enable-smart-resize (default: on)
1871 Add smart growth/shrink behaviour when changing font size via from 1996 Add smart growth/shrink behaviour when changing font size via hot
1872 hot keys. This should keep in a fixed position the rxvt corner which 1997 keys. This should keep the window corner which is closest to a
1873 is closest to a corner of the screen. 1998 corner of the screen in a fixed position.
1874 1999
1875 --enable-cursor-blink
1876 Add support for a blinking cursor.
1877
1878 --enable-pointer-blank 2000 --enable-pointer-blank (default: on)
1879 Add support to have the pointer disappear when typing or inactive. 2001 Add support to have the pointer disappear when typing or inactive.
1880 2002
1881 --with-name=NAME 2003 --enable-perl (default: off)
2004 Enable an embedded perl interpreter. See the rxvtperl(3) manpage
2005 (doc/rxvtperl.txt) for more info on this feature, or the files in
2006 src/perl-ext/ for the extensions that are installed by default.
2007
2008 --with-name=NAME (default: urxvt)
1882 Set the basename for the installed binaries (default: "urxvt", 2009 Set the basename for the installed binaries, resulting in "urxvt",
1883 resulting in "urxvt", "urxvtd" etc.). Specify "--with-name=rxvt" to 2010 "urxvtd" etc.). Specify "--with-name=rxvt" to replace with "rxvt".
1884 replace with "rxvt".
1885 2011
1886 --with-term=NAME 2012 --with-term=NAME (default: rxvt-unicode)
1887 Change the environmental variable for the terminal to NAME (default 2013 Change the environmental variable for the terminal to NAME.
1888 "rxvt-unicode")
1889 2014
1890 --with-terminfo=PATH 2015 --with-terminfo=PATH
1891 Change the environmental variable for the path to the terminfo tree 2016 Change the environmental variable for the path to the terminfo tree
1892 to PATH. 2017 to PATH.
1893 2018

Diff Legend

– Removed lines
+ Added lines
< Changed lines
> Changed lines