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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines