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.47 by root, Tue Jan 17 16:22:41 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 The new selection selects pieces that are too big, how can I select
24 single words?
25 Yes. For example, if you want to select alphanumeric words, you can
26 use the following resource:
27
28 URxvt.selection.pattern-0: ([[:word:]]+)
29
30 If you click more than twice, the selection will be extended more
31 and more.
32
33 To get a selection that is very similar to the old code, try this
34 pattern:
35
36 URxvt.selection.pattern-0: ([^"&'()*,;<=>?@[\\\\]^`{|})]+)
37
38 Please also note that the *LeftClick Shift-LeftClik* combination
39 also selects words like the old code.
40
41 I don't like the new selection/popups/hotkeys/perl, how do I
42 change/disable it?
43 You can disable the perl extension completely by setting the
44 perl-ext-common resource to the empty string, which also keeps
45 rxvt-unicode from initialising perl, saving memory.
46
47 If you only want to disable specific features, you first have to
48 identify which perl extension is responsible. For this, read the
49 section PREPACKAGED EXTENSIONS in the rxvtperl(3) manpage. For
50 example, to disable the selection-popup and option-popup, specify
51 this perl-ext-common resource:
52
53 URxvt.perl-ext-common: default,-selection-popup,-option-popup
54
55 This will keep the default extensions, but disable the two popup
56 extensions. Some extensions can also be configured, for example,
57 scrollback search mode is triggered by M-s. You can move it to any
58 other combination either by setting the searchable-scrollback
59 resource:
60
61 URxvt.searchable-scrollback: CM-s
62
63 Isn't rxvt supposed to be small? Don't all those features bloat?
64 I often get asked about this, and I think, no, they didn't cause
65 extra bloat. If you compare a minimal rxvt and a minimal urxvt, you
66 can see that the urxvt binary is larger (due to some encoding tables
67 always being compiled in), but it actually uses less memory (RSS)
68 after startup. Even with "--disable-everything", this comparison is
69 a bit unfair, as many features unique to urxvt (locale, encoding
70 conversion, iso14755 etc.) are already in use in this mode.
71
72 text data bss drs rss filename
73 98398 1664 24 15695 1824 rxvt --disable-everything
74 188985 9048 66616 18222 1788 urxvt --disable-everything
75
76 When you "--enable-everything" (which _is_ unfair, as this involves
77 xft and full locale/XIM support which are quite bloaty inside libX11
78 and my libc), the two diverge, but not unreasnobaly so.
79
80 text data bss drs rss filename
81 163431 2152 24 20123 2060 rxvt --enable-everything
82 1035683 49680 66648 29096 3680 urxvt --enable-everything
83
84 The very large size of the text section is explained by the
85 east-asian encoding tables, which, if unused, take up disk space but
86 nothing else and can be compiled out unless you rely on X11 core
87 fonts that use those encodings. The BSS size comes from the 64k
88 emergency buffer that my c++ compiler allocates (but of course
89 doesn't use unless you are out of memory). Also, using an xft font
90 instead of a core font immediately adds a few megabytes of RSS. Xft
91 indeed is responsible for a lot of RSS even when not used.
92
93 Of course, due to every character using two or four bytes instead of
94 one, a large scrollback buffer will ultimately make rxvt-unicode use
95 more memory.
96
97 Compared to e.g. Eterm (5112k), aterm (3132k) and xterm (4680k),
98 this still fares rather well. And compared to some monsters like
99 gnome-terminal (21152k + extra 4204k in separate processes) or
100 konsole (22200k + extra 43180k in daemons that stay around after
101 exit, plus half a minute of startup time, including the hundreds of
102 warnings it spits out), it fares extremely well *g*.
103
104 Why C++, isn't that unportable/bloated/uncool?
105 Is this a question? :) It comes up very often. The simple answer is:
106 I had to write it, and C++ allowed me to write and maintain it in a
107 fraction of the time and effort (which is a scarce resource for me).
108 Put even shorter: It simply wouldn't exist without C++.
109
110 My personal stance on this is that C++ is less portable than C, but
111 in the case of rxvt-unicode this hardly matters, as its portability
112 limits are defined by things like X11, pseudo terminals, locale
113 support and unix domain sockets, which are all less portable than
114 C++ itself.
115
116 Regarding the bloat, see the above question: It's easy to write
117 programs in C that use gobs of memory, an certainly possible to
118 write programs in C++ that don't. C++ also often comes with large
119 libraries, but this is not necessarily the case with GCC. Here is
120 what rxvt links against on my system with a minimal config:
121
122 libX11.so.6 => /usr/X11R6/lib/libX11.so.6 (0x00002aaaaabc3000)
123 libc.so.6 => /lib/libc.so.6 (0x00002aaaaadde000)
124 libdl.so.2 => /lib/libdl.so.2 (0x00002aaaab01d000)
125 /lib64/ld-linux-x86-64.so.2 (0x00002aaaaaaab000)
126
127 And here is rxvt-unicode:
128
129 libX11.so.6 => /usr/X11R6/lib/libX11.so.6 (0x00002aaaaabc3000)
130 libgcc_s.so.1 => /lib/libgcc_s.so.1 (0x00002aaaaada2000)
131 libc.so.6 => /lib/libc.so.6 (0x00002aaaaaeb0000)
132 libdl.so.2 => /lib/libdl.so.2 (0x00002aaaab0ee000)
133 /lib64/ld-linux-x86-64.so.2 (0x00002aaaaaaab000)
134
135 No large bloated libraries (of course, none were linked in
136 statically), except maybe libX11 :)
137
138 Does it support tabs, can I have a tabbed rxvt-unicode?
139 rxvt-unicode does not directly support tabs. It will work fine with
140 tabbing functionality of many window managers or similar tabbing
141 programs, and its embedding-features allow it to be embedded into
142 other programs, as witnessed by doc/rxvt-tabbed or the upcoming
143 "Gtk2::URxvt" perl module, which features a tabbed urxvt (murxvt)
144 terminal as an example embedding application.
145
23 How do I know which rxvt-unicode version I'm using? 146 How do I know which rxvt-unicode version I'm using?
24 The version number is displayed with the usage (-h). Also the escape 147 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. 148 sequence "ESC [ 8 n" sets the window title to the version number.
149 When using the rxvtc client, the version displayed is that of the
150 daemon.
26 151
27 I am using Debian GNU/Linux and have a problem... 152 I am using Debian GNU/Linux and have a problem...
28 The Debian GNU/Linux package of rxvt-unicode contains large patches 153 The Debian GNU/Linux package of rxvt-unicode in sarge contains large
29 that considerably change the behaviour of rxvt-unicode. Before 154 patches that considerably change the behaviour of rxvt-unicode.
30 reporting a bug to the original rxvt-unicode author please download 155 Before reporting a bug to the original rxvt-unicode author please
31 and install the genuine version 156 download and install the genuine version
32 (<http://software.schmorp.de#rxvt-unicode>) and try to reproduce the 157 (<http://software.schmorp.de#rxvt-unicode>) and try to reproduce the
33 problem. If you cannot, chances are that the problems are specific 158 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 159 to Debian GNU/Linux, in which case it should be reported via the
35 Debian Bug Tracking System (use "reportbug" to report the bug). 160 Debian Bug Tracking System (use "reportbug" to report the bug).
36 161
37 For other problems that also affect the Debian package, you can and 162 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 163 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 164 also a bug in the Debian version and it serves as a reminder for
40 other users that might encounter the same issue. 165 other users that might encounter the same issue.
166
167 I am maintaining rxvt-unicode for distribution/OS XXX, any
168 recommendation?
169 You should build one binary with the default options. configure now
170 enables most useful options, and the trend goes to making them
171 runtime-switchable, too, so there is usually no drawback to enbaling
172 them, except higher disk and possibly memory usage. The perl
173 interpreter should be enabled, as important functionality (menus,
174 selection, likely more in the future) depends on it.
175
176 You should not overwrite the "perl-ext-common" snd "perl-ext"
177 resources system-wide (except maybe with "defaults"). This will
178 result in useful behaviour. If your distribution aims at low memory,
179 add an empty "perl-ext-common" resource to the app-defaults file.
180 This will keep the perl interpreter disabled until the user enables
181 it.
182
183 If you can/want build more binaries, I recommend building a minimal
184 one with "--disable-everything" (very useful) and a maximal one with
185 "--enable-everything" (less useful, it will be very big due to a lot
186 of encodings built-in that increase download times and are rarely
187 used).
188
189 I need to make it setuid/setgid to support utmp/ptys on my OS, is this
190 safe?
191 It should be, starting with release 7.1. You are encouraged to
192 properly install urxvt with privileges necessary for your OS now.
193
194 When rxvt-unicode detects that it runs setuid or setgid, it will
195 fork into a helper process for privileged operations (pty handling
196 on some systems, utmp/wtmp/lastlog handling on others) and drop
197 privileges immediately. This is much safer than most other terminals
198 that keep privileges while running (but is more relevant to urxvt,
199 as it contains things as perl interpreters, which might be "helpful"
200 to attackers).
201
202 This forking is done as the very first within main(), which is very
203 early and reduces possible bugs to initialisation code run before
204 main(), or things like the dynamic loader of your system, which
205 should result in very little risk.
41 206
42 When I log-in to another system it tells me about missing terminfo data? 207 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 208 The terminal description used by rxvt-unicode is not as widely
44 available as that for xterm, or even rxvt (for which the same 209 available as that for xterm, or even rxvt (for which the same
45 problem often arises). 210 problem often arises).
66 URxvt.termName: rxvt 231 URxvt.termName: rxvt
67 232
68 If you don't plan to use rxvt (quite common...) you could also 233 If you don't plan to use rxvt (quite common...) you could also
69 replace the rxvt terminfo file with the rxvt-unicode one. 234 replace the rxvt terminfo file with the rxvt-unicode one.
70 235
236 "tic" outputs some error when compiling the terminfo entry.
237 Most likely it's the empty definition for "enacs=". Just replace it
238 by "enacs=\E[0@" and try again.
239
71 "bash"'s readline does not work correctly under rxvt. 240 "bash"'s readline does not work correctly under rxvt.
72 I need a termcap file entry. 241 I need a termcap file entry.
73 One reason you might want this is that some distributions or 242 One reason you might want this is that some distributions or
74 operating systems still compile some programs using the 243 operating systems still compile some programs using the
75 long-obsoleted termcap (Fedora Core's bash is one example) and rely 244 long-obsoleted termcap library (Fedora Core's bash is one example)
76 on a termcap entry for "rxvt-unicode". 245 and rely on a termcap entry for "rxvt-unicode".
77 246
78 You could use rxvt's termcap entry with resonable results in many 247 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 248 cases. You can also create a termcap entry by using terminfo's
80 infocmp program like this: 249 infocmp program like this:
81 250
83 252
84 Or you could use this termcap entry, generated by the command above: 253 Or you could use this termcap entry, generated by the command above:
85 254
86 rxvt-unicode|rxvt-unicode terminal (X Window System):\ 255 rxvt-unicode|rxvt-unicode terminal (X Window System):\
87 :am:bw:eo:km:mi:ms:xn:xo:\ 256 :am:bw:eo:km:mi:ms:xn:xo:\
88 :co#80:it#8:li#24:\ 257 :co#80:it#8:li#24:lm#0:\
89 :AL=\E[%dL:DC=\E[%dP:DL=\E[%dM:DO=\E[%dB:IC=\E[%d@:\ 258 :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:\ 259 :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:\ 260 :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:\ 261 :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:\ 262 :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[@:\ 263 :dl=\E[M:do=^J:ec=\E[%dX:ei=\E[4l:ho=\E[H:\
264 :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:\ 265 :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~:\ 266 :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~:\ 267 :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:\ 268 :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=:\ 269 :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:\ 270 :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:\ 271 :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:\ 272 :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:\ 273 :us=\E[4m:vb=\E[?5h\E[?5l:ve=\E[?25h:vi=\E[?25l:\
104 :vs=\E[?25h: 274 :vs=\E[?25h:
105 275
106 Why does "ls" no longer have coloured output? 276 Why does "ls" no longer have coloured output?
107 The "ls" in the GNU coreutils unfortunately doesn't use terminfo to 277 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 278 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. 416 that doesn't work, you might be forced to use a different font.
247 417
248 All of this is not a problem when using X11 core fonts, as their 418 All of this is not a problem when using X11 core fonts, as their
249 bounding box data is correct. 419 bounding box data is correct.
250 420
421 On Solaris 9, many line-drawing characters are too wide.
422 Seems to be a known bug, read
423 <http://nixdoc.net/files/forum/about34198.html>. Some people use the
424 following ugly workaround to get non-double-wide-characters working:
425
426 #define wcwidth(x) wcwidth(x) > 1 ? 1 : wcwidth(x)
427
251 My Compose (Multi_key) key is no longer working. 428 My Compose (Multi_key) key is no longer working.
252 The most common causes for this are that either your locale is not 429 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 430 set correctly, or you specified a preeditStyle that is not supported
254 by your input method. For example, if you specified OverTheSpot and 431 by your input method. For example, if you specified OverTheSpot and
255 your input method (e.g. the default input method handling Compose 432 your input method (e.g. the default input method handling Compose
299 As you might have guessed, FreeBSD does neither define this symobl 476 As you might have guessed, FreeBSD does neither define this symobl
300 nor does it support it. Instead, it uses it's own internal 477 nor does it support it. Instead, it uses it's own internal
301 representation of wchar_t. This is, of course, completely fine with 478 representation of wchar_t. This is, of course, completely fine with
302 respect to standards. 479 respect to standards.
303 480
481 However, that means rxvt-unicode only works in "POSIX", "ISO-8859-1"
482 and "UTF-8" locales under FreeBSD (which all use Unicode as wchar_t.
483
304 However, "__STDC_ISO_10646__" is the only sane way to support 484 "__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 485 apps in an OS, as using a locale-dependent (and non-standardized)
306 non-standardized) representation of wchar_t makes it impossible to 486 representation of wchar_t makes it impossible to convert between
307 convert between wchar_t (as used by X11 and your applications) and 487 wchar_t (as used by X11 and your applications) and any other
308 any other encoding without implementing OS-specific-wrappers for 488 encoding without implementing OS-specific-wrappers for each and
309 each and every locale. There simply are no APIs to convert wchar_t 489 every locale. There simply are no APIs to convert wchar_t into
310 into anything except the current locale encoding. 490 anything except the current locale encoding.
311 491
312 Some applications (such as the formidable mlterm) work around this 492 Some applications (such as the formidable mlterm) work around this
313 by carrying their own replacement functions for character set 493 by carrying their own replacement functions for character set
314 handling with them, and either implementing OS-dependent hacks or 494 handling with them, and either implementing OS-dependent hacks or
315 doing multiple conversions (which is slow and unreliable in case the 495 doing multiple conversions (which is slow and unreliable in case the
317 emulator). 497 emulator).
318 498
319 The rxvt-unicode author insists that the right way to fix this is in 499 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 500 the system libraries once and for all, instead of forcing every app
321 to carry complete replacements for them :) 501 to carry complete replacements for them :)
502
503 I use Solaris 9 and it doesn't compile/work/etc.
504 Try the diff in doc/solaris9.patch as a base. It fixes the worst
505 problems with "wcwidth" and a compile problem.
506
507 How can I use rxvt-unicode under cygwin?
508 rxvt-unicode should compile and run out of the box on cygwin, using
509 the X11 libraries that come with cygwin. libW11 emulation is no
510 longer supported (and makes no sense, either, as it only supported a
511 single font). I recommend starting the X-server in "-multiwindow" or
512 "-rootless" mode instead, which will result in similar look&feel as
513 the old libW11 emulation.
514
515 At the time of this writing, cygwin didn't seem to support any
516 multi-byte encodings (you might try "LC_CTYPE=C-UTF-8"), so you are
517 likely limited to 8-bit encodings.
322 518
323 How does rxvt-unicode determine the encoding to use? 519 How does rxvt-unicode determine the encoding to use?
324 Is there an option to switch encodings? 520 Is there an option to switch encodings?
325 Unlike some other terminals, rxvt-unicode has no encoding switch, 521 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 522 and no specific "utf-8" mode, such as xterm. In fact, it doesn't
402 598
403 My input method wants <some encoding> but I want UTF-8, what can I do? 599 My input method wants <some encoding> but I want UTF-8, what can I do?
404 You can specify separate locales for the input method and the rest 600 You can specify separate locales for the input method and the rest
405 of the terminal, using the resource "imlocale": 601 of the terminal, using the resource "imlocale":
406 602
407 URxvt*imlocale: ja_JP.EUC-JP 603 URxvt.imlocale: ja_JP.EUC-JP
408 604
409 Now you can start your terminal with "LC_CTYPE=ja_JP.UTF-8" and 605 Now you can start your terminal with "LC_CTYPE=ja_JP.UTF-8" and
410 still use your input method. Please note, however, that you will not 606 still use your input method. Please note, however, that you will not
411 be able to input characters outside "EUC-JP" in a normal way then, 607 be able to input characters outside "EUC-JP" in a normal way then,
412 as your input method limits you. 608 as your input method limits you.
438 it gets worse, as rxvt-unicode then uses 8 bytes per screen cell. 634 it gets worse, as rxvt-unicode then uses 8 bytes per screen cell.
439 635
440 Can I speed up Xft rendering somehow? 636 Can I speed up Xft rendering somehow?
441 Yes, the most obvious way to speed it up is to avoid Xft entirely, 637 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 638 as it is simply slow. If you still want Xft fonts you might try to
443 disable antialiasing (by appending ":antialiasing=false"), which 639 disable antialiasing (by appending ":antialias=false"), which saves
444 saves lots of memory and also speeds up rendering considerably. 640 lots of memory and also speeds up rendering considerably.
445 641
446 Rxvt-unicode doesn't seem to anti-alias its fonts, what is wrong? 642 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 643 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 644 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 645 fonts, because they are small and fast, and then use Xft fonts. It
455 Mouse cut/paste suddenly no longer works. 651 Mouse cut/paste suddenly no longer works.
456 Make sure that mouse reporting is actually turned off since killing 652 Make sure that mouse reporting is actually turned off since killing
457 some editors prematurely may leave the mouse in mouse report mode. 653 some editors prematurely may leave the mouse in mouse report mode.
458 I've heard that tcsh may use mouse reporting unless it otherwise 654 I've heard that tcsh may use mouse reporting unless it otherwise
459 specified. A quick check is to see if cut/paste works when the Alt 655 specified. A quick check is to see if cut/paste works when the Alt
460 or Shift keys are depressed. See rxvt(7) 656 or Shift keys are depressed.
461 657
462 What's with this bold/blink stuff? 658 What's with this bold/blink stuff?
463 If no bold colour is set via "colorBD:", bold will invert text using 659 If no bold colour is set via "colorBD:", bold will invert text using
464 the standard foreground colour. 660 the standard foreground colour.
465 661
521 URxvt.color14: #73f7ff 717 URxvt.color14: #73f7ff
522 URxvt.color7: #e1dddd 718 URxvt.color7: #e1dddd
523 URxvt.color15: #e1dddd 719 URxvt.color15: #e1dddd
524 720
525 How can I start rxvtd in a race-free way? 721 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 722 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 723 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 724
535 What's with the strange Backspace/Delete key behaviour? 725 What's with the strange Backspace/Delete key behaviour?
536 Assuming that the physical Backspace key corresponds to the 726 Assuming that the physical Backspace key corresponds to the
537 BackSpace keysym (not likely for Linux ... see the following 727 BackSpace keysym (not likely for Linux ... see the following
538 question) there are two standard values that can be used for 728 question) there are two standard values that can be used for
557 747
558 # use Backspace = ^? 748 # use Backspace = ^?
559 $ stty erase ^? 749 $ stty erase ^?
560 $ rxvt 750 $ rxvt
561 751
562 Toggle with "ESC [ 36 h" / "ESC [ 36 l" as documented in rxvt(7). 752 Toggle with "ESC [ 36 h" / "ESC [ 36 l".
563 753
564 For an existing rxvt-unicode: 754 For an existing rxvt-unicode:
565 755
566 # use Backspace = ^H 756 # use Backspace = ^H
567 $ stty erase ^H 757 $ stty erase ^H
679 869
680RXVT TECHNICAL REFERENCE 870RXVT TECHNICAL REFERENCE
681DESCRIPTION 871DESCRIPTION
682 The rest of this document describes various technical aspects of 872 The rest of this document describes various technical aspects of
683 rxvt-unicode. First the description of supported command sequences, 873 rxvt-unicode. First the description of supported command sequences,
684 followed by menu and pixmap support and last by a description of all 874 followed by pixmap support and last by a description of all features
685 features selectable at "configure" time. 875 selectable at "configure" time.
686 876
687Definitions 877Definitions
688 "c" The literal character c. 878 "c" The literal character c.
689 879
690 "C" A single (required) character. 880 "C" A single (required) character.
1059 1249
1060 "Ps = 9" X10 XTerm 1250 "Ps = 9" X10 XTerm
1061 h Send Mouse X & Y on button press. 1251 h Send Mouse X & Y on button press.
1062 l No mouse reporting. 1252 l No mouse reporting.
1063 1253
1064 "Ps = 10" (rxvt)
1065 h menuBar visible
1066 l menuBar invisible
1067
1068 "Ps = 25" 1254 "Ps = 25"
1069 h Visible cursor {cnorm/cvvis} 1255 h Visible cursor {cnorm/cvvis}
1070 l Invisible cursor {civis} 1256 l Invisible cursor {civis}
1071 1257
1072 "Ps = 30" 1258 "Ps = 30"
1120 l Scroll to bottom on TTY output 1306 l Scroll to bottom on TTY output
1121 1307
1122 "Ps = 1011" (rxvt) 1308 "Ps = 1011" (rxvt)
1123 h Scroll to bottom when a key is pressed 1309 h Scroll to bottom when a key is pressed
1124 l Don't scroll to bottom when a key is pressed 1310 l Don't scroll to bottom when a key is pressed
1311
1312 "Ps = 1021" (rxvt)
1313 h Bold/italic implies high intensity (see option -is)
1314 l Font styles have no effect on intensity (Compile styles)
1125 1315
1126 "Ps = 1047" 1316 "Ps = 1047"
1127 h Use Alternate Screen Buffer 1317 h Use Alternate Screen Buffer
1128 l Use Normal Screen Buffer - clear Alternate Screen Buffer if returning from it 1318 l Use Normal Screen Buffer - clear Alternate Screen Buffer if returning from it
1129 1319
1152 Ps = 10 Change colour of text foreground to Pt (NB: may change in future) 1342 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) 1343 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 1344 Ps = 12 Change colour of text cursor foreground to Pt
1155 Ps = 13 Change colour of mouse foreground to Pt 1345 Ps = 13 Change colour of mouse foreground to Pt
1156 Ps = 17 Change colour of highlight characters to Pt 1346 Ps = 17 Change colour of highlight characters to Pt
1157 Ps = 18 Change colour of bold characters to Pt 1347 Ps = 18 Change colour of bold characters to Pt [deprecated, see 706]
1158 Ps = 19 Change colour of underlined characters to Pt 1348 Ps = 19 Change colour of underlined characters to Pt [deprecated, see 707]
1159 Ps = 20 Change default background to Pt 1349 Ps = 20 Change default background to Pt
1160 Ps = 39 Change default foreground colour to Pt rxvt compile-time option 1350 Ps = 39 Change default foreground colour to Pt.
1161 Ps = 46 Change Log File to Pt unimplemented 1351 Ps = 46 Change Log File to Pt unimplemented
1162 Ps = 49 Change default background colour to Pt rxvt compile-time option 1352 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 1353 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 1354 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) 1355 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)
1167 Ps = 704 Change colour of italic characters to Pt 1356 Ps = 704 Change colour of italic characters to Pt
1168 Ps = 705 Change background pixmap tint colour to Pt 1357 Ps = 705 Change background pixmap tint colour to Pt (Compile transparency).
1358 Ps = 706 Change colour of bold characters to Pt
1359 Ps = 707 Change colour of underlined characters to Pt
1169 Ps = 710 Set normal fontset to Pt. Same as Ps = 50. 1360 Ps = 710 Set normal fontset to Pt. Same as Ps = 50.
1170 Ps = 711 Set bold fontset to Pt. Similar to Ps = 50. 1361 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. 1362 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. 1363 Ps = 713 Set bold-italic fontset to Pt. Similar to Ps = 50 (Compile styles).
1364 Ps = 720 Move viewing window up by Pt lines, or clear scrollback buffer if Pt = 0 (Compile frills).
1365 Ps = 721 Move viewing window down by Pt lines, or clear scrollback buffer if Pt = 0 (Compile frills).
1366 Ps = 777 Call the perl extension with the given string, which should be of the form extension:parameters (Compile perl).
1173 1367
1174 1368
1175
1176menuBar
1177 The exact syntax used is *almost* solidified. In the menus, DON'T try to
1178 use menuBar commands that add or remove a menuBar.
1179
1180 Note that in all of the commands, the */path/* *cannot* be omitted: use
1181 ./ to specify a menu relative to the current menu.
1182
1183 Overview of menuBar operation
1184 For the menuBar XTerm escape sequence "ESC ] 703 ; Pt ST", the syntax of
1185 "Pt" can be used for a variety of tasks:
1186
1187 At the top level is the current menuBar which is a member of a circular
1188 linked-list of other such menuBars.
1189
1190 The menuBar acts as a parent for the various drop-down menus, which in
1191 turn, may have labels, separator lines, menuItems and subMenus.
1192
1193 The menuItems are the useful bits: you can use them to mimic keyboard
1194 input or even to send text or escape sequences back to rxvt.
1195
1196 The menuBar syntax is intended to provide a simple yet robust method of
1197 constructing and manipulating menus and navigating through the menuBars.
1198
1199 The first step is to use the tag [menu:*name*] which creates the menuBar
1200 called *name* and allows access. You may now or menus, subMenus, and
1201 menuItems. Finally, use the tag [done] to set the menuBar access as
1202 readonly to prevent accidental corruption of the menus. To re-access the
1203 current menuBar for alterations, use the tag [menu], make the
1204 alterations and then use [done]
1205
1206
1207
1208 Commands
1209 [menu:+*name*]
1210 access the named menuBar for creation or alteration. If a new
1211 menuBar is created, it is called *name* (max of 15 chars) and the
1212 current menuBar is pushed onto the stack
1213
1214 [menu]
1215 access the current menuBar for alteration
1216
1217 [title:+*string*]
1218 set the current menuBar's title to *string*, which may contain the
1219 following format specifiers: %% : literal % character %n : rxvt name
1220 (as per the -name command-line option) %v : rxvt version
1221
1222 [done]
1223 set menuBar access as readonly. End-of-file tag for [read:+*file*]
1224 operations.
1225
1226 [read:+*file*]
1227 read menu commands directly from *file* (extension ".menu" will be
1228 appended if required.) Start reading at a line with [menu] or
1229 [menu:+*name* and continuing until [done] is encountered.
1230
1231 Blank and comment lines (starting with #) are ignored. Actually,
1232 since any invalid menu commands are also ignored, almost anything
1233 could be construed as a comment line, but this may be tightened up
1234 in the future ... so don't count on it!.
1235
1236 [read:+*file*;+*name*]
1237 The same as [read:+*file*], but start reading at a line with
1238 [menu:+*name*] and continuing until [done:+*name*] or [done] is
1239 encountered.
1240
1241 [dump]
1242 dump all menuBars to the file /tmp/rxvt-PID in a format suitable for
1243 later rereading.
1244
1245 [rm:name]
1246 remove the named menuBar
1247
1248 [rm] [rm:]
1249 remove the current menuBar
1250
1251 [rm*] [rm:*]
1252 remove all menuBars
1253
1254 [swap]
1255 swap the top two menuBars
1256
1257 [prev]
1258 access the previous menuBar
1259
1260 [next]
1261 access the next menuBar
1262
1263 [show]
1264 Enable display of the menuBar
1265
1266 [hide]
1267 Disable display of the menuBar
1268
1269 [pixmap:+*name*]
1270 [pixmap:+*name*;*scaling*]
1271 (set the background pixmap globally
1272
1273 A Future implementation *may* make this local to the menubar)
1274
1275 [:+*command*:]
1276 ignore the menu readonly status and issue a *command* to or a menu
1277 or menuitem or change the ; a useful shortcut for setting the quick
1278 arrows from a menuBar.
1279
1280
1281
1282 Adding and accessing menus
1283 The following commands may also be + prefixed.
1284
1285 /+ access menuBar top level
1286
1287 ./+ access current menu level
1288
1289 ../+
1290 access parent menu (1 level up)
1291
1292 ../../
1293 access parent menu (multiple levels up)
1294
1295 */path/*menu
1296 add/access menu
1297
1298 */path/*menu/*
1299 add/access menu and clear it if it exists
1300
1301 */path/*{-}
1302 add separator
1303
1304 */path/*{item}
1305 add item as a label
1306
1307 */path/*{item} action
1308 add/alter *menuitem* with an associated *action*
1309
1310 */path/*{item}{right-text}
1311 add/alter *menuitem* with right-text as the right-justified text and
1312 as the associated *action*
1313
1314 */path/*{item}{rtext} action
1315 add/alter *menuitem* with an associated *action* and with rtext as
1316 the right-justified text.
1317
1318 Special characters in *action* must be backslash-escaped:
1319 \a \b \E \e \n \r \t \octal
1320
1321 or in control-character notation:
1322 ^@, ^A .. ^Z .. ^_, ^?
1323
1324 To send a string starting with a NUL (^@) character to the program,
1325 start *action* with a pair of NUL characters (^@^@), the first of which
1326 will be stripped off and the balance directed to the program. Otherwise
1327 if *action* begins with NUL followed by non-+NUL characters, the leading
1328 NUL is stripped off and the balance is sent back to rxvt.
1329
1330 As a convenience for the many Emacs-type editors, *action* may start
1331 with M- (eg, M-$ is equivalent to \E$) and a CR will be appended if
1332 missed from M-x commands.
1333
1334 As a convenience for issuing XTerm ESC ] sequences from a menubar (or
1335 quick arrow), a BEL (^G) will be appended if needed.
1336
1337 For example,
1338 M-xapropos is equivalent to \Exapropos\r
1339
1340 and \E]703;mona;100 is equivalent to \E]703;mona;100\a
1341
1342 The option {*right-rtext*} will be right-justified. In the absence of a
1343 specified action, this text will be used as the *action* as well.
1344
1345 For example,
1346 /File/{Open}{^X^F} is equivalent to /File/{Open}{^X^F} ^X^F
1347
1348 The left label *is* necessary, since it's used for matching, but
1349 implicitly hiding the left label (by using same name for both left and
1350 right labels), or explicitly hiding the left label (by preceeding it
1351 with a dot), makes it possible to have right-justified text only.
1352
1353 For example,
1354 /File/{Open}{Open} Open-File-Action
1355
1356 or hiding it
1357 /File/{.anylabel}{Open} Open-File-Action
1358
1359
1360
1361 Removing menus
1362 -/*+
1363 remove all menus from the menuBar, the same as [clear]
1364
1365 -+*/path*menu+
1366 remove menu
1367
1368 -+*/path*{item}+
1369 remove item
1370
1371 -+*/path*{-}
1372 remove separator)
1373
1374 -/path/menu/*
1375 remove all items, separators and submenus from menu
1376
1377
1378
1379 Quick Arrows
1380 The menus also provide a hook for *quick arrows* to provide easier user
1381 access. If nothing has been explicitly set, the default is to emulate
1382 the curror keys. The syntax permits each arrow to be altered
1383 individually or all four at once without re-entering their common
1384 beginning/end text. For example, to explicitly associate cursor actions
1385 with the arrows, any of the following forms could be used:
1386
1387 <r>+*Right*
1388 <l>+*Left*
1389 <u>+*Up*
1390 <d>+*Down*
1391 Define actions for the respective arrow buttons
1392
1393 <b>+*Begin*
1394 <e>+*End*
1395 Define common beginning/end parts for *quick arrows* which used in
1396 conjunction with the above <r> <l> <u> <d> constructs
1397
1398 For example, define arrows individually,
1399 <u>\E[A
1400
1401 <d>\E[B
1402
1403 <r>\E[C
1404
1405 <l>\E[D
1406
1407 or all at once
1408 <u>\E[AZ<><d>\E[BZ<><r>\E[CZ<><l>\E[D
1409
1410 or more compactly (factoring out common parts)
1411 <b>\E[<u>AZ<><d>BZ<><r>CZ<><l>D
1412
1413
1414
1415 Command Summary
1416 A short summary of the most *common* commands:
1417
1418 [menu:name]
1419 use an existing named menuBar or start a new one
1420
1421 [menu]
1422 use the current menuBar
1423
1424 [title:string]
1425 set menuBar title
1426
1427 [done]
1428 set menu access to readonly and, if reading from a file, signal EOF
1429
1430 [done:name]
1431 if reading from a file using [read:file;name] signal EOF
1432
1433 [rm:name]
1434 remove named menuBar(s)
1435
1436 [rm] [rm:]
1437 remove current menuBar
1438
1439 [rm*] [rm:*]
1440 remove all menuBar(s)
1441
1442 [swap]
1443 swap top two menuBars
1444
1445 [prev]
1446 access the previous menuBar
1447
1448 [next]
1449 access the next menuBar
1450
1451 [show]
1452 map menuBar
1453
1454 [hide]
1455 unmap menuBar
1456
1457 [pixmap;file]
1458 [pixmap;file;scaling]
1459 set a background pixmap
1460
1461 [read:file]
1462 [read:file;name]
1463 read in a menu from a file
1464
1465 [dump]
1466 dump out all menuBars to /tmp/rxvt-PID
1467
1468 / access menuBar top level
1469
1470 ./
1471 ../
1472 ../../
1473 access current or parent menu level
1474
1475 /path/menu
1476 add/access menu
1477
1478 /path/{-}
1479 add separator
1480
1481 /path/{item}{rtext} action
1482 add/alter menu item
1483
1484 -/* remove all menus from the menuBar
1485
1486 -/path/menu
1487 remove menu items, separators and submenus from menu
1488
1489 -/path/menu
1490 remove menu
1491
1492 -/path/{item}
1493 remove item
1494
1495 -/path/{-}
1496 remove separator
1497
1498 <b>Begin<r>Right<l>Left<u>Up<d>Down<e>End
1499 menu quick arrows
1500 1369
1501XPM 1370XPM
1502 For the XPM XTerm escape sequence "ESC ] 20 ; Pt ST" then value of "Pt" 1371 For the XPM XTerm escape sequence "ESC ] 20 ; Pt ST" then value of "Pt"
1503 can be the name of the background pixmap followed by a sequence of 1372 can be the name of the background pixmap followed by a sequence of
1504 scaling/positioning commands separated by semi-colons. The 1373 scaling/positioning commands separated by semi-colons. The
1639 XK_KP_8 8 ESC O x 1508 XK_KP_8 8 ESC O x
1640 XK_KP_9 9 ESC O y 1509 XK_KP_9 9 ESC O y
1641 1510
1642CONFIGURE OPTIONS 1511CONFIGURE OPTIONS
1643 General hint: if you get compile errors, then likely your configuration 1512 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 1513 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, 1514 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 1515 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 1516 should always report when a combination doesn't work, so it can be
1648 <rxvt@schmorp.de>. 1517 fixed. Marc Lehmann <rxvt@schmorp.de>.
1518
1519 All
1649 1520
1650 --enable-everything 1521 --enable-everything
1651 Add support for all non-multichoice options listed in "./configure 1522 Add (or remove) support for all non-multichoice options listed in
1652 --help". Note that unlike other enable options this is order 1523 "./configure --help".
1653 dependant. You can specify this and then disable options which this
1654 enables by *following* this with the appropriate commands.
1655 1524
1656 --enable-xft 1525 You can specify this and then disable options you do not like by
1526 *following* this with the appropriate "--disable-..." arguments, or
1527 you can start with a minimal configuration by specifying
1528 "--disable-everything" and than adding just the "--enable-..."
1529 arguments you want.
1530
1531 --enable-xft (default: enabled)
1657 Add support for Xft (anti-aliases, among others) fonts. Xft fonts 1532 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 1533 are slower and require lots of memory, but as long as you don't use
1659 them, you don't pay for them. 1534 them, you don't pay for them.
1660 1535
1661 --enable-font-styles 1536 --enable-font-styles (default: on)
1662 Add support for bold, *italic* and *bold italic* font styles. The 1537 Add support for bold, *italic* and *bold italic* font styles. The
1663 fonts can be set manually or automatically. 1538 fonts can be set manually or automatically.
1664 1539
1665 --with-codesets=NAME,... 1540 --with-codesets=NAME,... (default: all)
1666 Compile in support for additional codeset (encoding) groups (eu, vn 1541 Compile in support for additional codeset (encoding) groups ("eu",
1667 are always compiled in, which includes most 8-bit character sets). 1542 "vn" are always compiled in, which includes most 8-bit character
1668 These codeset tables are currently only used for driving X11 core 1543 sets). These codeset tables are used for driving X11 core fonts,
1669 fonts, they are not required for Xft fonts. Compiling them in will 1544 they are not required for Xft fonts, although having them compiled
1670 make your binary bigger (together about 700kB), but it doesn't 1545 in lets rxvt-unicode choose replacement fonts more intelligently.
1671 increase memory usage unless you use an X11 font requiring one of 1546 Compiling them in will make your binary bigger (all of together cost
1672 these encodings. 1547 about 700kB), but it doesn't increase memory usage unless you use a
1548 font requiring one of these encodings.
1673 1549
1674 all all available codeset groups 1550 all all available codeset groups
1675 zh common chinese encodings 1551 zh common chinese encodings
1676 zh_ext rarely used but very big chinese encodigs 1552 zh_ext rarely used but very big chinese encodigs
1677 jp common japanese encodings 1553 jp common japanese encodings
1678 jp_ext rarely used but big japanese encodings 1554 jp_ext rarely used but big japanese encodings
1679 kr korean encodings 1555 kr korean encodings
1680 1556
1681 --enable-xim 1557 --enable-xim (default: on)
1682 Add support for XIM (X Input Method) protocol. This allows using 1558 Add support for XIM (X Input Method) protocol. This allows using
1683 alternative input methods (e.g. kinput2) and will also correctly set 1559 alternative input methods (e.g. kinput2) and will also correctly set
1684 up the input for people using dead keys or compose keys. 1560 up the input for people using dead keys or compose keys.
1685 1561
1686 --enable-unicode3 1562 --enable-unicode3 (default: off)
1687 Enable direct support for displaying unicode codepoints above 65535 1563 Enable direct support for displaying unicode codepoints above 65535
1688 (the basic multilingual page). This increases storage requirements 1564 (the basic multilingual page). This increases storage requirements
1689 per character from 2 to 4 bytes. X11 fonts do not yet support these 1565 per character from 2 to 4 bytes. X11 fonts do not yet support these
1690 extra characters, but Xft does. 1566 extra characters, but Xft does.
1691 1567
1693 even without this flag, but the number of such characters is limited 1569 even without this flag, but the number of such characters is limited
1694 to a view thousand (shared with combining characters, see next 1570 to a view thousand (shared with combining characters, see next
1695 switch), and right now rxvt-unicode cannot display them 1571 switch), and right now rxvt-unicode cannot display them
1696 (input/output and cut&paste still work, though). 1572 (input/output and cut&paste still work, though).
1697 1573
1698 --enable-combining 1574 --enable-combining (default: on)
1699 Enable automatic composition of combining characters into composite 1575 Enable automatic composition of combining characters into composite
1700 characters. This is required for proper viewing of text where 1576 characters. This is required for proper viewing of text where
1701 accents are encoded as seperate unicode characters. This is done by 1577 accents are encoded as seperate unicode characters. This is done by
1702 using precomposited characters when available or creating new 1578 using precomposited characters when available or creating new
1703 pseudo-characters when no precomposed form exists. 1579 pseudo-characters when no precomposed form exists.
1704 1580
1705 Without --enable-unicode3, the number of additional precomposed 1581 Without --enable-unicode3, the number of additional precomposed
1706 characters is rather limited (2048, if this is full, rxvt will use 1582 characters is rather limited (2048, if this is full, rxvt-unicode
1707 the private use area, extending the number of combinations to 8448). 1583 will use the private use area, extending the number of combinations
1708 With --enable-unicode3, no practical limit exists. This will also 1584 to 8448). With --enable-unicode3, no practical limit exists.
1709 enable storage of characters >65535. 1585
1586 This option will also enable storage (but not display) of characters
1587 beyond plane 0 (>65535) when --enable-unicode3 was not specified.
1710 1588
1711 The combining table also contains entries for arabic presentation 1589 The combining table also contains entries for arabic presentation
1712 forms, but these are not currently used. Bug me if you want these to 1590 forms, but these are not currently used. Bug me if you want these to
1713 be used. 1591 be used (and tell me how these are to be used...).
1714 1592
1715 --enable-fallback(=CLASS) 1593 --enable-fallback(=CLASS) (default: Rxvt)
1716 When reading resource settings, also read settings for class CLASS 1594 When reading resource settings, also read settings for class CLASS.
1717 (default: Rxvt). To disable resource fallback use 1595 To disable resource fallback use --disable-fallback.
1718 --disable-fallback.
1719 1596
1720 --with-res-name=NAME 1597 --with-res-name=NAME (default: urxvt)
1721 Use the given name (default: urxvt) as default application name when 1598 Use the given name as default application name when reading
1722 reading resources. Specify --with-res-name=rxvt to replace rxvt. 1599 resources. Specify --with-res-name=rxvt to replace rxvt.
1723 1600
1724 --with-res-class=CLASS 1601 --with-res-class=CLASS /default: URxvt)
1725 Use the given class (default: URxvt) as default application class 1602 Use the given class as default application class when reading
1726 when reading resources. Specify --with-res-class=Rxvt to replace 1603 resources. Specify --with-res-class=Rxvt to replace rxvt.
1727 rxvt.
1728 1604
1729 --enable-utmp 1605 --enable-utmp (default: on)
1730 Write user and tty to utmp file (used by programs like w) at start 1606 Write user and tty to utmp file (used by programs like w) at start
1731 of rxvt execution and delete information when rxvt exits. 1607 of rxvt execution and delete information when rxvt exits.
1732 1608
1733 --enable-wtmp 1609 --enable-wtmp (default: on)
1734 Write user and tty to wtmp file (used by programs like last) at 1610 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 1611 start of rxvt execution and write logout when rxvt exits. This
1736 option requires --enable-utmp to also be specified. 1612 option requires --enable-utmp to also be specified.
1737 1613
1738 --enable-lastlog 1614 --enable-lastlog (default: on)
1739 Write user and tty to lastlog file (used by programs like lastlogin) 1615 Write user and tty to lastlog file (used by programs like lastlogin)
1740 at start of rxvt execution. This option requires --enable-utmp to 1616 at start of rxvt execution. This option requires --enable-utmp to
1741 also be specified. 1617 also be specified.
1742 1618
1743 --enable-xpm-background 1619 --enable-xpm-background (default: on)
1744 Add support for XPM background pixmaps. 1620 Add support for XPM background pixmaps.
1745 1621
1746 --enable-transparency 1622 --enable-transparency (default: on)
1747 Add support for inheriting parent backgrounds thus giving a fake 1623 Add support for inheriting parent backgrounds thus giving a fake
1748 transparency to the term. 1624 transparency to the term.
1749 1625
1750 --enable-fading 1626 --enable-fading (default: on)
1751 Add support for fading the text when focus is lost. 1627 Add support for fading the text when focus is lost (requires
1628 "--enable-transparency").
1752 1629
1753 --enable-tinting 1630 --enable-tinting (default: on)
1754 Add support for tinting of transparent backgrounds. 1631 Add support for tinting of transparent backgrounds (requires
1632 "--enable-transparency").
1755 1633
1756 --enable-menubar
1757 Add support for our menu bar system (this interacts badly with
1758 dynamic locale switching currently).
1759
1760 --enable-rxvt-scroll 1634 --enable-rxvt-scroll (default: on)
1761 Add support for the original rxvt scrollbar. 1635 Add support for the original rxvt scrollbar.
1762 1636
1763 --enable-next-scroll 1637 --enable-next-scroll (default: on)
1764 Add support for a NeXT-like scrollbar. 1638 Add support for a NeXT-like scrollbar.
1765 1639
1766 --enable-xterm-scroll 1640 --enable-xterm-scroll (default: on)
1767 Add support for an Xterm-like scrollbar. 1641 Add support for an Xterm-like scrollbar.
1768 1642
1769 --enable-plain-scroll 1643 --enable-plain-scroll (default: on)
1770 Add support for a very unobtrusive, plain-looking scrollbar that is 1644 Add support for a very unobtrusive, plain-looking scrollbar that is
1771 the favourite of the rxvt-unicode author, having used it for many 1645 the favourite of the rxvt-unicode author, having used it for many
1772 years. 1646 years.
1773 1647
1774 --enable-half-shadow 1648 --enable-ttygid (default: off)
1775 Make shadows on the scrollbar only half the normal width & height.
1776 only applicable to rxvt scrollbars.
1777
1778 --enable-ttygid
1779 Change tty device setting to group "tty" - only use this if your 1649 Change tty device setting to group "tty" - only use this if your
1780 system uses this type of security. 1650 system uses this type of security.
1781 1651
1782 --disable-backspace-key 1652 --disable-backspace-key
1783 Disable any handling of the backspace key by us - let the X server 1653 Removes any handling of the backspace key by us - let the X server
1784 do it. 1654 do it.
1785 1655
1786 --disable-delete-key 1656 --disable-delete-key
1787 Disable any handling of the delete key by us - let the X server do 1657 Removes any handling of the delete key by us - let the X server do
1788 it. 1658 it.
1789 1659
1790 --disable-resources 1660 --disable-resources
1791 Remove all resources checking. 1661 Removes any support for resource checking.
1792
1793 --enable-xgetdefault
1794 Make resources checking via XGetDefault() instead of our small
1795 version which only checks ~/.Xdefaults, or if that doesn't exist
1796 then ~/.Xresources.
1797
1798 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
1800 might be very small, if nonexistant.
1801
1802 --enable-strings
1803 Add support for our possibly faster memset() function and other
1804 various routines, overriding your system's versions which may have
1805 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
1807 systems).
1808 1662
1809 --disable-swapscreen 1663 --disable-swapscreen
1810 Remove support for swap screen. 1664 Remove support for secondary/swap screen.
1811 1665
1812 --enable-frills 1666 --enable-frills (default: on)
1813 Add support for many small features that are not essential but nice 1667 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 1668 to have. Normally you want this, but for very small binaries you may
1815 want to disable this. 1669 want to disable this.
1816 1670
1817 A non-exhaustive list of features enabled by "--enable-frills" 1671 A non-exhaustive list of features enabled by "--enable-frills"
1818 (possibly in combination with other switches) is: 1672 (possibly in combination with other switches) is:
1819 1673
1820 MWM-hints 1674 MWM-hints
1675 EWMH-hints (pid, utf8 names) and protocols (ping)
1821 seperate underline colour 1676 seperate underline colour (-underlineColor)
1822 settable border widths and borderless switch 1677 settable border widths and borderless switch (-w, -b, -bl)
1823 settable extra linespacing 1678 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 1679 iso-14755-2 and -3, and visual feedback
1826 backindex and forwardindex escape sequence 1680 backindex and forwardindex escape sequence
1827 window op and locale change escape sequences 1681 window op and some xterm/OSC escape sequences
1828 tripleclickwords 1682 tripleclickwords (-tcw)
1829 settable insecure mode 1683 settable insecure mode (-insecure)
1830 keysym remapping support 1684 keysym remapping support
1685 cursor blinking and underline cursor (-cb, -uc)
1686 XEmbed support (-embed)
1687 user-pty (-pty-fd)
1688 hold on exit (-hold)
1689 skip builtin block graphics (-sbg)
1690 sgr modes 90..97 and 100..107
1831 1691
1832 --enable-iso14755 1692 --enable-iso14755 (default: on)
1833 Enable extended ISO 14755 support (see rxvt(1), or doc/rxvt.1.txt). 1693 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 1694 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. 1695 support for 5.2, 5.3 and 5.4 is enabled with this switch.
1836 1696
1837 --enable-keepscrolling 1697 --enable-keepscrolling (default: on)
1838 Add support for continual scrolling of the display when you hold the 1698 Add support for continual scrolling of the display when you hold the
1839 mouse button down on a scrollbar arrow. 1699 mouse button down on a scrollbar arrow.
1840 1700
1841 --enable-mousewheel 1701 --enable-mousewheel (default: on)
1842 Add support for scrolling via mouse wheel or buttons 4 & 5. 1702 Add support for scrolling via mouse wheel or buttons 4 & 5.
1843 1703
1844 --enable-slipwheeling 1704 --enable-slipwheeling (default: on)
1845 Add support for continual scrolling (using the mouse wheel as an 1705 Add support for continual scrolling (using the mouse wheel as an
1846 accelerator) while the control key is held down. This option 1706 accelerator) while the control key is held down. This option
1847 requires --enable-mousewheel to also be specified. 1707 requires --enable-mousewheel to also be specified.
1848 1708
1849 --disable-new-selection 1709 --disable-new-selection
1850 Remove support for mouse selection style like that of xterm. 1710 Remove support for mouse selection style like that of xterm.
1851 1711
1852 --enable-dmalloc 1712 --enable-dmalloc (default: off)
1853 Use Gray Watson's malloc - which is good for debugging See 1713 Use Gray Watson's malloc - which is good for debugging See
1854 http://www.letters.com/dmalloc/ for details If you use either this 1714 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 1715 or the next option, you may need to edit src/Makefile after
1856 compiling to point DINCLUDE and DLIB to the right places. 1716 compiling to point DINCLUDE and DLIB to the right places.
1857 1717
1858 You can only use either this option and the following (should you 1718 You can only use either this option and the following (should you
1859 use either) . 1719 use either) .
1860 1720
1861 --enable-dlmalloc 1721 --enable-dlmalloc (default: off)
1862 Use Doug Lea's malloc - which is good for a production version See 1722 Use Doug Lea's malloc - which is good for a production version See
1863 <http://g.oswego.edu/dl/html/malloc.html> for details. 1723 <http://g.oswego.edu/dl/html/malloc.html> for details.
1864 1724
1865 --enable-smart-resize 1725 --enable-smart-resize (default: on)
1866 Add smart growth/shrink behaviour when changing font size via from 1726 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 1727 keys. This should keep the window corner which is closest to a
1868 is closest to a corner of the screen. 1728 corner of the screen in a fixed position.
1869 1729
1870 --enable-cursor-blink
1871 Add support for a blinking cursor.
1872
1873 --enable-pointer-blank 1730 --enable-pointer-blank (default: on)
1874 Add support to have the pointer disappear when typing or inactive. 1731 Add support to have the pointer disappear when typing or inactive.
1875 1732
1876 --with-name=NAME 1733 --enable-perl (default: off)
1734 Enable an embedded perl interpreter. See the rxvtperl(3) manpage
1735 (doc/rxvtperl.txt) for more info on this feature, or the files in
1736 src/perl-ext/ for the extensions that are installed by default. The
1737 perl interpreter that is used can be specified via the "PERL"
1738 environment variable when running configure.
1739
1740 --with-name=NAME (default: urxvt)
1877 Set the basename for the installed binaries (default: "urxvt", 1741 Set the basename for the installed binaries, resulting in "urxvt",
1878 resulting in "urxvt", "urxvtd" etc.). Specify "--with-name=rxvt" to 1742 "urxvtd" etc.). Specify "--with-name=rxvt" to replace with "rxvt".
1879 replace with "rxvt".
1880 1743
1881 --with-term=NAME 1744 --with-term=NAME (default: rxvt-unicode)
1882 Change the environmental variable for the terminal to NAME (default 1745 Change the environmental variable for the terminal to NAME.
1883 "rxvt-unicode")
1884 1746
1885 --with-terminfo=PATH 1747 --with-terminfo=PATH
1886 Change the environmental variable for the path to the terminfo tree 1748 Change the environmental variable for the path to the terminfo tree
1887 to PATH. 1749 to PATH.
1888 1750

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines