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.1 by root, Tue Jan 11 02:24:59 2005 UTC vs.
Revision 1.47 by root, Tue Jan 17 16:22:41 2006 UTC

1NAME 1NAME
2 RXVT REFERENCE - FAQ, command sequences and other background information 2 RXVT REFERENCE - FAQ, command sequences and other background information
3 3
4SYNOPSIS
5 # set a new font set
6 printf '\33]50;%s\007' 9x15,xft:Kochi" Mincho"
7
8 # change the locale and tell rxvt-unicode about it
9 export LC_CTYPE=ja_JP.EUC-JP; printf "\33]701;$LC_CTYPE\007"
10
11 # set window title
12 printf '\33]2;%s\007' "new window title"
13
14DESCRIPTION
15 This document contains the FAQ, the RXVT TECHNICAL REFERENCE documenting
16 all escape sequences, and other background information.
17
18 The newest version of this document is also available on the World Wide
19 Web at
20 <http://cvs.schmorp.de/browse/*checkout*/rxvt-unicode/doc/rxvt.7.html>.
21
4FREQUENTLY 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
5 How do I know which rxvt-unicode version I'm using? 146 How do I know which rxvt-unicode version I'm using?
6 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
7 sequence "ESC[8n" 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.
151
152 I am using Debian GNU/Linux and have a problem...
153 The Debian GNU/Linux package of rxvt-unicode in sarge contains large
154 patches that considerably change the behaviour of rxvt-unicode.
155 Before reporting a bug to the original rxvt-unicode author please
156 download and install the genuine version
157 (<http://software.schmorp.de#rxvt-unicode>) and try to reproduce the
158 problem. If you cannot, chances are that the problems are specific
159 to Debian GNU/Linux, in which case it should be reported via the
160 Debian Bug Tracking System (use "reportbug" to report the bug).
161
162 For other problems that also affect the Debian package, you can and
163 probably should use the Debian BTS, too, because, after all, it's
164 also a bug in the Debian version and it serves as a reminder for
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.
8 206
9 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?
10 The terminal description used by rxvt-unicode is not as widely 208 The terminal description used by rxvt-unicode is not as widely
11 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
12 problem often arises). 210 problem often arises).
… …
24 problems arising, which includes wrong keymapping, less and 222 problems arising, which includes wrong keymapping, less and
25 different colours and some refresh errors in fullscreen 223 different colours and some refresh errors in fullscreen
26 applications. It's a nice quick-and-dirty workaround for rare cases, 224 applications. It's a nice quick-and-dirty workaround for rare cases,
27 though. 225 though.
28 226
29 If you always want to do this you can either recompile rxvt-unicode 227 If you always want to do this (and are fine with the consequences)
30 with the desired TERM value or use a resource to set it: 228 you can either recompile rxvt-unicode with the desired TERM value or
229 use a resource to set it:
31 230
32 URxvt.termName: rxvt 231 URxvt.termName: rxvt
33 232
34 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
35 replace the rxvt terminfo file with the rxvt-unicode one. 234 replace the rxvt terminfo file with the rxvt-unicode one.
36 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
240 "bash"'s readline does not work correctly under rxvt.
37 I need a termcap file entry. 241 I need a termcap file entry.
242 One reason you might want this is that some distributions or
243 operating systems still compile some programs using the
244 long-obsoleted termcap library (Fedora Core's bash is one example)
245 and rely on a termcap entry for "rxvt-unicode".
246
38 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
39 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
40 infocmp program like this: 249 infocmp program like this:
41 250
42 infocmp -C rxvt-unicode 251 infocmp -C rxvt-unicode
43 252
44 OR you could this termcap entry: 253 Or you could use this termcap entry, generated by the command above:
45 254
46 rxvt-unicode|rxvt-unicode terminal (X Window System):\ 255 rxvt-unicode|rxvt-unicode terminal (X Window System):\
47 :am:bw:eo:km:mi:ms:xn:xo:\ 256 :am:bw:eo:km:mi:ms:xn:xo:\
48 :co#80:it#8:li#24:\ 257 :co#80:it#8:li#24:lm#0:\
49 :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@:\
50 :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:\
51 :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:\
52 :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:\
53 :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:\
54 :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:\
55 :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:\
56 :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~:\
57 :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~:\
58 :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>:\
59 :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:\
60 :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:\
61 :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:\
62 :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:\
63 :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:\
64 :vs=\E[?25h: 274 :vs=\E[?25h:
65 275
66 Why does "ls" no longer have coloured output? 276 Why does "ls" no longer have coloured output?
67 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
68 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
… …
87 furthermore fail to even install the "rxvt-unicode" terminfo file, 297 furthermore fail to even install the "rxvt-unicode" terminfo file,
88 so you will need to install it on your own (See the question When I 298 so you will need to install it on your own (See the question When I
89 log-in to another system it tells me about missing terminfo data? on 299 log-in to another system it tells me about missing terminfo data? on
90 how to do this). 300 how to do this).
91 301
302 My numerical keypad acts weird and generates differing output?
303 Some Debian GNUL/Linux users seem to have this problem, although no
304 specific details were reported so far. It is possible that this is
305 caused by the wrong "TERM" setting, although the details of wether
306 and how this can happen are unknown, as "TERM=rxvt" should offer a
307 compatible keymap. See the answer to the previous question, and
308 please report if that helped.
309
92 Rxvt-unicode does not seem to understand the selected encoding? 310 Rxvt-unicode does not seem to understand the selected encoding?
93 Unicode does not seem to work? 311 Unicode does not seem to work?
94 If you encounter strange problems like typing an accented character 312 If you encounter strange problems like typing an accented character
95 but getting two unrelated other characters or similar, or if program 313 but getting two unrelated other characters or similar, or if program
96 output is subtly garbled, then you should check your locale 314 output is subtly garbled, then you should check your locale
97 settings. 315 settings.
98 316
99 Rxvt-unicode must be started with the same "LC_CTYPE" setting as the 317 Rxvt-unicode must be started with the same "LC_CTYPE" setting as the
100 programs. Often rxvt-unicode is started in the "C" locale, while the 318 programs. Often rxvt-unicode is started in the "C" locale, while the
101 login script running within the rxvt-unicode window changes the 319 login script running within the rxvt-unicode window changes the
102 locale to sth. else, e.h. "en_GB.UTF-8". Needless to say, this is 320 locale to something else, e.g. "en_GB.UTF-8". Needless to say, this
103 not going to work. 321 is not going to work.
104 322
105 The best thing is to fix your startup environment, as you will 323 The best thing is to fix your startup environment, as you will
106 likely run into other problems. If nothing works you can try this in 324 likely run into other problems. If nothing works you can try this in
107 your .profile. 325 your .profile.
108 326
109 printf '\e]701;%s\007' "$LC_CTYPE" 327 printf '\e]701;%s\007' "$LC_CTYPE"
110 328
111 If this doesn't work, then maybe you use a "LC_CTYPE" specification 329 If this doesn't work, then maybe you use a "LC_CTYPE" specification
112 not supported on your systems. Some systems have a "locale" command 330 not supported on your systems. Some systems have a "locale" command
113 which displays this. If it displays sth. like: 331 which displays this (also, "perl -e0" can be used to check locale
332 settings, as it will complain loudly if it cannot set the locale).
333 If it displays something like:
114 334
115 locale: Cannot set LC_CTYPE to default locale: ... 335 locale: Cannot set LC_CTYPE to default locale: ...
116 336
117 Then the locale you specified is not supported on your system. 337 Then the locale you specified is not supported on your system.
118 338
… …
126 Chances are that the font you (or the admin/package maintainer of 346 Chances are that the font you (or the admin/package maintainer of
127 your system/os) have specified does not cover all the characters you 347 your system/os) have specified does not cover all the characters you
128 want to display. 348 want to display.
129 349
130 rxvt-unicode makes a best-effort try at finding a replacement font. 350 rxvt-unicode makes a best-effort try at finding a replacement font.
131 Often the result is fine, but sometimes the chosen font looks bad. 351 Often the result is fine, but sometimes the chosen font looks
132 Many fonts have totally strange characters that don't resemble the 352 bad/ugly/wrong. Some fonts have totally strange characters that
133 correct glyph at all, and rxvt-unicode lacks the artificial 353 don't resemble the correct glyph at all, and rxvt-unicode lacks the
134 intelligence to detect that a specific glyph is wrong: it has to 354 artificial intelligence to detect that a specific glyph is wrong: it
135 believe the font that the characters it contains indeed look 355 has to believe the font that the characters it claims to contain
136 correct. 356 indeed look correct.
137 357
138 In that case, select a font of your taste and add it to the font 358 In that case, select a font of your taste and add it to the font
139 list, e.g.: 359 list, e.g.:
140 360
141 rxvt -fn basefont,font2,font3... 361 rxvt -fn basefont,font2,font3...
… …
144 font. If the base font does not contain the character, it will go to 364 font. If the base font does not contain the character, it will go to
145 the next font, and so on. Specifying your own fonts will also speed 365 the next font, and so on. Specifying your own fonts will also speed
146 up this search and use less resources within rxvt-unicode and the 366 up this search and use less resources within rxvt-unicode and the
147 X-server. 367 X-server.
148 368
149 The only limitation is that all the fonts must not be larger than 369 The only limitation is that none of the fonts may be larger than the
150 the base font, as the base font defines the principal cell size, 370 base font, as the base font defines the terminal character cell
151 which must be the same due to the way terminals work. 371 size, which must be the same due to the way terminals work.
152 372
153 Why do some chinese characters look so different than others? 373 Why do some chinese characters look so different than others?
154 This is because there is a difference between script and language -- 374 This is because there is a difference between script and language --
155 rxvt-unicode does not know which language the text that is output 375 rxvt-unicode does not know which language the text that is output
156 is, as it only knows the unicode character codes. If rxvt-unicode 376 is, as it only knows the unicode character codes. If rxvt-unicode
157 first sees a japanese character, it might choose a japanese font for 377 first sees a japanese/chinese character, it might choose a japanese
158 it. Subsequent japanese characters will take that font. Now, many 378 font for display. Subsequent japanese characters will use that font.
159 chinese characters aren't represented in japanese fonts, so when the 379 Now, many chinese characters aren't represented in japanese fonts,
160 first non-japanese character comes up, rxvt-unicode will look for a 380 so when the first non-japanese character comes up, rxvt-unicode will
161 chinese font -- unfortunately at this point, it will still use the 381 look for a chinese font -- unfortunately at this point, it will
162 japanese font for japanese characters that are also chinese. 382 still use the japanese font for chinese characters that are also in
383 the japanese font.
163 384
164 The workaround is easy: just tag a chinese font at the end of your 385 The workaround is easy: just tag a chinese font at the end of your
165 font list (see the previous question). The key is to view the font 386 font list (see the previous question). The key is to view the font
166 list as a preference list: If you expect more japanese, list a 387 list as a preference list: If you expect more japanese, list a
167 japanese font first. If you expect more chinese, put a chinese font 388 japanese font first. If you expect more chinese, put a chinese font
168 first. 389 first.
169 390
170 In the future it might be possible to switch preferences at runtime 391 In the future it might be possible to switch language preferences at
171 (the internal data structure has no problem with using different 392 runtime (the internal data structure has no problem with using
172 fonts for the same character at the same time, but no interface for 393 different fonts for the same character at the same time, but no
173 this has been designed yet). 394 interface for this has been designed yet).
395
396 Until then, you might get away with switching fonts at runtime (see
397 "Can I switch the fonts at runtime?" later in this document).
174 398
175 Why does rxvt-unicode sometimes leave pixel droppings? 399 Why does rxvt-unicode sometimes leave pixel droppings?
176 Most fonts were not designed for terminal use, which means that 400 Most fonts were not designed for terminal use, which means that
177 character size varies a lot. A font that is otherwise fine for 401 character size varies a lot. A font that is otherwise fine for
178 terminal use might contain some characters that are simply too wide. 402 terminal use might contain some characters that are simply too wide.
… …
192 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.
193 417
194 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
195 bounding box data is correct. 419 bounding box data is correct.
196 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
197 My Compose (Multi_key) key is no longer working. 428 My Compose (Multi_key) key is no longer working.
198 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
199 set correctly, or you specified a preeditStyle that is not supported 430 set correctly, or you specified a preeditStyle that is not supported
200 by your input method. For example, if you specified OverTheSpot and 431 by your input method. For example, if you specified OverTheSpot and
201 your input method (e.g. the default input method handling Compose 432 your input method (e.g. the default input method handling Compose
… …
212 advantage, typing <Ctrl-Shift-0> to get a ASCII NUL. This works for 443 advantage, typing <Ctrl-Shift-0> to get a ASCII NUL. This works for
213 other codes, too, such as "Ctrl-Shift-1-d" to type the default 444 other codes, too, such as "Ctrl-Shift-1-d" to type the default
214 telnet escape character and so on. 445 telnet escape character and so on.
215 446
216 How can I keep rxvt-unicode from using reverse video so much? 447 How can I keep rxvt-unicode from using reverse video so much?
217 First of all, make sure you are running with the right terminfo 448 First of all, make sure you are running with the right terminal
218 ("urxvt"), which will get rid of most of these effects. Then make 449 settings ("TERM=rxvt-unicode"), which will get rid of most of these
219 sure you have specified colours for italic and bold, as otherwise 450 effects. Then make sure you have specified colours for italic and
220 rxvt-unicode might use reverse video to simulate the effect: 451 bold, as otherwise rxvt-unicode might use reverse video to simulate
452 the effect:
221 453
222 URxvt*colorBD: white 454 URxvt.colorBD: white
223 URxvt*colorIT: green 455 URxvt.colorIT: green
224 456
225 Some programs assume totally weird colours (red instead of blue), how 457 Some programs assume totally weird colours (red instead of blue), how
226 can I fix that? 458 can I fix that?
227 For some unexplainable reason, some programs (i.e. irssi) assume a 459 For some unexplainable reason, some rare programs assume a very
228 very weird colour palette when confronted with a terminal with more 460 weird colour palette when confronted with a terminal with more than
229 than the standard 8 colours (rxvt-unicode supports 88). The right 461 the standard 8 colours (rxvt-unicode supports 88). The right fix is,
230 fix is, of course, to fix these programs not to assume non-ISO 462 of course, to fix these programs not to assume non-ISO colours
231 colours without very good reasons. 463 without very good reasons.
232 464
233 In the meantime, you can either edit your "urxvt" terminfo 465 In the meantime, you can either edit your "rxvt-unicode" terminfo
234 definition to only claim 8 colour support or use "TERM=rxvt", which 466 definition to only claim 8 colour support or use "TERM=rxvt", which
235 will fix colours but keep you from using other rxvt-unicode 467 will fix colours but keep you from using other rxvt-unicode
236 features. 468 features.
237 469
238 I am on FreeBSD and rxvt-unicode does not seem to work at all. 470 I am on FreeBSD and rxvt-unicode does not seem to work at all.
… …
241 it, wether it defines the symbol or not. "__STDC_ISO_10646__" 473 it, wether it defines the symbol or not. "__STDC_ISO_10646__"
242 requires that wchar_t is represented as unicode. 474 requires that wchar_t is represented as unicode.
243 475
244 As you might have guessed, FreeBSD does neither define this symobl 476 As you might have guessed, FreeBSD does neither define this symobl
245 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
246 representation of wchar_t. This is, of course, completely legal. 478 representation of wchar_t. This is, of course, completely fine with
479 respect to standards.
247 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
248 However, "__STDC_ISO_10646__" is the only sane way to support 484 "__STDC_ISO_10646__" is the only sane way to support multi-language
249 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)
250 non-standardized) representation of wchar_t makes it impossible to 486 representation of wchar_t makes it impossible to convert between
251 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
252 any other encoding without implementing OS-specific-wrappers for 488 encoding without implementing OS-specific-wrappers for each and
253 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
254 into anything except the current locale encoding. 490 anything except the current locale encoding.
255 491
256 Some applications (such as the formidable mlterm) work around this 492 Some applications (such as the formidable mlterm) work around this
257 by carrying their own replacement functions for character set 493 by carrying their own replacement functions for character set
258 handling with them, and either implementing OS-dependent hacks or 494 handling with them, and either implementing OS-dependent hacks or
259 doing multiple conversions (which is slow and unreliable in case the 495 doing multiple conversions (which is slow and unreliable in case the
260 OS implements encodings slightly different than the terminal 496 OS implements encodings slightly different than the terminal
261 emulator). 497 emulator).
262 498
263 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
264 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
265 to carry complete replacements. 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.
266 518
267 How does rxvt-unicode determine the encoding to use? 519 How does rxvt-unicode determine the encoding to use?
268 Is there an option to switch encodings? 520 Is there an option to switch encodings?
269 Unlike some other terminals, rxvt-unicode has no encoding switch, 521 Unlike some other terminals, rxvt-unicode has no encoding switch,
270 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
… …
273 525
274 The reasons is that there exists a perfectly fine mechanism for 526 The reasons is that there exists a perfectly fine mechanism for
275 selecting the encoding, doing I/O and (most important) communicating 527 selecting the encoding, doing I/O and (most important) communicating
276 this to all applications so everybody agrees on character properties 528 this to all applications so everybody agrees on character properties
277 such as width and code number. This mechanism is the *locale*. 529 such as width and code number. This mechanism is the *locale*.
530 Applications not using that info will have problems (for example,
531 "xterm" gets the width of characters wrong as it uses it's own,
532 locale-independent table under all locales).
278 533
279 Rxvt-unicode uses the "LC_CTYPE" locale category to select encoding. 534 Rxvt-unicode uses the "LC_CTYPE" locale category to select encoding.
280 All programs doing the same (that is, most) will automatically agree 535 All programs doing the same (that is, most) will automatically agree
281 in the interpretation of characters. 536 in the interpretation of characters.
282 537
… …
290 "language_country.encoding", but other forms (i.e. "de" or "german") 545 "language_country.encoding", but other forms (i.e. "de" or "german")
291 are also common. 546 are also common.
292 547
293 Rxvt-unicode ignores all other locale categories, and except for the 548 Rxvt-unicode ignores all other locale categories, and except for the
294 encoding, ignores country or language-specific settings, i.e. 549 encoding, ignores country or language-specific settings, i.e.
295 "de_DE.UTF-8" and "ja_JP.UTF-8" are the same for rxvt-unicode. 550 "de_DE.UTF-8" and "ja_JP.UTF-8" are the normally same to
551 rxvt-unicode.
296 552
297 If you want to use a specific encoding you have to make sure you 553 If you want to use a specific encoding you have to make sure you
298 start rxvt-unicode with the correct "LC_CTYPE" category. 554 start rxvt-unicode with the correct "LC_CTYPE" category.
299 555
300 Can I switch locales at runtime? 556 Can I switch locales at runtime?
301 Yes, using an escape sequence. Try sth. like this, which sets 557 Yes, using an escape sequence. Try something like this, which sets
302 rxvt-unicode's idea of "LC_CTYPE". 558 rxvt-unicode's idea of "LC_CTYPE".
303 559
304 printf '\e]701;%s\007' ja_JP.SJIS 560 printf '\e]701;%s\007' ja_JP.SJIS
305 561
306 See also the previous question. 562 See also the previous answer.
307 563
308 Sometimes this capability is rather handy when you want to work in 564 Sometimes this capability is rather handy when you want to work in
309 one locale (e.g. "de_DE.UTF-8") but some programs don't support 565 one locale (e.g. "de_DE.UTF-8") but some programs don't support it
310 UTF-8. For example, I use this script to start "xjdic", which first 566 (e.g. UTF-8). For example, I use this script to start "xjdic", which
311 switches to a locale supported by xjdic and back later: 567 first switches to a locale supported by xjdic and back later:
312 568
313 printf '\e]701;%s\007' ja_JP.SJIS 569 printf '\e]701;%s\007' ja_JP.SJIS
314 xjdic -js 570 xjdic -js
315 printf '\e]701;%s\007' de_DE.UTF-8 571 printf '\e]701;%s\007' de_DE.UTF-8
316 572
573 You can also use xterm's "luit" program, which usually works fine,
574 except for some locales where character width differs between
575 program- and rxvt-unicode-locales.
576
317 Can I switch the fonts at runtime? 577 Can I switch the fonts at runtime?
318 Yes, using an escape sequence. Try sth. like this, which has the 578 Yes, using an escape sequence. Try something like this, which has
319 same effect as using the "-fn" switch, and takes effect immediately: 579 the same effect as using the "-fn" switch, and takes effect
580 immediately:
320 581
321 printf '\e]50;%s\007' "9x15bold,xft:Kochi Gothic" 582 printf '\e]50;%s\007' "9x15bold,xft:Kochi Gothic"
322 583
323 This is useful if you e.g. work primarily with japanese (and prefer 584 This is useful if you e.g. work primarily with japanese (and prefer
324 a japanese font), but you have to switch to chinese temporarily, 585 a japanese font), but you have to switch to chinese temporarily,
… …
327 You can think of this as a kind of manual ISO-2022 switching. 588 You can think of this as a kind of manual ISO-2022 switching.
328 589
329 Why do italic characters look as if clipped? 590 Why do italic characters look as if clipped?
330 Many fonts have difficulties with italic characters and hinting. For 591 Many fonts have difficulties with italic characters and hinting. For
331 example, the otherwise very nicely hinted font "xft:Bitstream Vera 592 example, the otherwise very nicely hinted font "xft:Bitstream Vera
332 Sans Mono" completely fails in it's italic face. A workaround is to 593 Sans Mono" completely fails in it's italic face. A workaround might
333 enable freetype autohinting, i.e. like this: 594 be to enable freetype autohinting, i.e. like this:
334 595
335 URxvt*italicFont: xft:Bitstream Vera Sans Mono:italic:autohint=true 596 URxvt.italicFont: xft:Bitstream Vera Sans Mono:italic:autohint=true
336 URxvt*boldItalicFont: xft:Bitstream Vera Sans Mono:bold:italic:autohint=true 597 URxvt.boldItalicFont: xft:Bitstream Vera Sans Mono:bold:italic:autohint=true
337 598
338 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?
339 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
340 of the terminal, using the resource "imlocale": 601 of the terminal, using the resource "imlocale":
341 602
342 URxvt*imlocale: ja_JP.EUC-JP 603 URxvt.imlocale: ja_JP.EUC-JP
343 604
344 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
345 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
346 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,
347 as your input method limits you. 608 as your input method limits you.
348 609
610 Rxvt-unicode crashes when the X Input Method changes or exits.
611 Unfortunately, this is unavoidable, as the XIM protocol is racy by
612 design. Applications can avoid some crashes at the expense of memory
613 leaks, and Input Methods can avoid some crashes by careful ordering
614 at exit time. kinput2 (and derived input methods) generally
615 succeeds, while SCIM (or similar input methods) fails. In the end,
616 however, crashes cannot be completely avoided even if both sides
617 cooperate.
618
619 So the only workaround is not to kill your Input Method Servers.
620
349 Rxvt-unicode uses gobs of memory, how can I reduce that? 621 Rxvt-unicode uses gobs of memory, how can I reduce that?
350 Rxvt-unicode tries to obey the rule of not charging you for sth. you 622 Rxvt-unicode tries to obey the rule of not charging you for
351 don't use. One thing you should try is to configure out all settings 623 something you don't use. One thing you should try is to configure
352 that you don't need, for example, Xft support is a resource hog by 624 out all settings that you don't need, for example, Xft support is a
353 design, when used. Compiling it out ensures that no Xft font will be 625 resource hog by design, when used. Compiling it out ensures that no
354 loaded accidentally when rxvt-unicode tries to find a font for your 626 Xft font will be loaded accidentally when rxvt-unicode tries to find
355 characters. 627 a font for your characters.
356 628
357 Also, many people (me included) like large windows and even larger 629 Also, many people (me included) like large windows and even larger
358 scrollback buffers: Without "--enable-unicode3", rxvt-unicode will 630 scrollback buffers: Without "--enable-unicode3", rxvt-unicode will
359 use 6 bytes per screen cell. For a 160x?? window this amounts to 631 use 6 bytes per screen cell. For a 160x?? window this amounts to
360 almost a kilobyte per line. A scrollback buffer of 10000 lines will 632 almost a kilobyte per line. A scrollback buffer of 10000 lines will
… …
362 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.
363 635
364 Can I speed up Xft rendering somehow? 636 Can I speed up Xft rendering somehow?
365 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,
366 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
367 disable antialiasing (by appending ":antialiasing=false"), which 639 disable antialiasing (by appending ":antialias=false"), which saves
368 saves lots of memory and also speeds up rendering considerably. 640 lots of memory and also speeds up rendering considerably.
369 641
370 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?
371 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
372 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
373 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
… …
379 Mouse cut/paste suddenly no longer works. 651 Mouse cut/paste suddenly no longer works.
380 Make sure that mouse reporting is actually turned off since killing 652 Make sure that mouse reporting is actually turned off since killing
381 some editors prematurely may leave the mouse in mouse report mode. 653 some editors prematurely may leave the mouse in mouse report mode.
382 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
383 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
384 or Shift keys are depressed. See rxvt(7) 656 or Shift keys are depressed.
385 657
386 What's with this bold/blink stuff? 658 What's with this bold/blink stuff?
387 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
388 the standard foreground colour. 660 the standard foreground colour.
389 661
… …
404 resources (or as long-options). 676 resources (or as long-options).
405 677
406 Here are values that are supposed to resemble a VGA screen, 678 Here are values that are supposed to resemble a VGA screen,
407 including the murky brown that passes for low-intensity yellow: 679 including the murky brown that passes for low-intensity yellow:
408 680
409 URxvt*color0: #000000 681 URxvt.color0: #000000
410 URxvt*color1: #A80000 682 URxvt.color1: #A80000
411 URxvt*color2: #00A800 683 URxvt.color2: #00A800
412 URxvt*color3: #A8A800 684 URxvt.color3: #A8A800
413 URxvt*color4: #0000A8 685 URxvt.color4: #0000A8
414 URxvt*color5: #A800A8 686 URxvt.color5: #A800A8
415 URxvt*color6: #00A8A8 687 URxvt.color6: #00A8A8
416 URxvt*color7: #A8A8A8 688 URxvt.color7: #A8A8A8
417 689
418 URxvt*color8: #000054 690 URxvt.color8: #000054
419 URxvt*color9: #FF0054 691 URxvt.color9: #FF0054
420 URxvt*color10: #00FF54 692 URxvt.color10: #00FF54
421 URxvt*color11: #FFFF54 693 URxvt.color11: #FFFF54
422 URxvt*color12: #0000FF 694 URxvt.color12: #0000FF
423 URxvt*color13: #FF00FF 695 URxvt.color13: #FF00FF
424 URxvt*color14: #00FFFF 696 URxvt.color14: #00FFFF
425 URxvt*color15: #FFFFFF 697 URxvt.color15: #FFFFFF
426 698
427 And here is a more complete set of non-standard colors described as 699 And here is a more complete set of non-standard colors described
428 "pretty girly": 700 (not by me) as "pretty girly".
429 701
430 URxvt.cursorColor: #dc74d1 702 URxvt.cursorColor: #dc74d1
431 URxvt.pointerColor: #dc74d1 703 URxvt.pointerColor: #dc74d1
432 URxvt.background: #0e0e0e 704 URxvt.background: #0e0e0e
433 URxvt.foreground: #4ad5e1 705 URxvt.foreground: #4ad5e1
… …
444 URxvt.color6: #73f7ff 716 URxvt.color6: #73f7ff
445 URxvt.color14: #73f7ff 717 URxvt.color14: #73f7ff
446 URxvt.color7: #e1dddd 718 URxvt.color7: #e1dddd
447 URxvt.color15: #e1dddd 719 URxvt.color15: #e1dddd
448 720
721 How can I start rxvtd in a race-free way?
722 Try "rxvtd -f -o", which tells rxvtd to open the display, create the
723 listening socket and then fork.
724
449 What's with the strange Backspace/Delete key behaviour? 725 What's with the strange Backspace/Delete key behaviour?
450 Assuming that the physical Backspace key corresponds to the 726 Assuming that the physical Backspace key corresponds to the
451 BackSpace keysym (not likely for Linux ... see the following 727 BackSpace keysym (not likely for Linux ... see the following
452 question) there are two standard values that can be used for 728 question) there are two standard values that can be used for
453 Backspace: "^H" and "^?". 729 Backspace: "^H" and "^?".
… …
471 747
472 # use Backspace = ^? 748 # use Backspace = ^?
473 $ stty erase ^? 749 $ stty erase ^?
474 $ rxvt 750 $ rxvt
475 751
476 Toggle with "ESC[36h" / "ESC[36l" as documented in rxvt(7). 752 Toggle with "ESC [ 36 h" / "ESC [ 36 l".
477 753
478 For an existing rxvt-unicode: 754 For an existing rxvt-unicode:
479 755
480 # use Backspace = ^H 756 # use Backspace = ^H
481 $ stty erase ^H 757 $ stty erase ^H
… …
490 value properly reflects that. 766 value properly reflects that.
491 767
492 The Delete key is a another casualty of the ill-defined Backspace 768 The Delete key is a another casualty of the ill-defined Backspace
493 problem. To avoid confusion between the Backspace and Delete keys, 769 problem. To avoid confusion between the Backspace and Delete keys,
494 the Delete key has been assigned an escape sequence to match the 770 the Delete key has been assigned an escape sequence to match the
495 vt100 for Execute (ESC[3~) and is in the supplied termcap/terminfo. 771 vt100 for Execute ("ESC [ 3 ~") and is in the supplied
772 termcap/terminfo.
496 773
497 Some other Backspace problems: 774 Some other Backspace problems:
498 775
499 some editors use termcap/terminfo, some editors (vim I'm told) 776 some editors use termcap/terminfo, some editors (vim I'm told)
500 expect Backspace = ^H, GNU Emacs (and Emacs-like editors) use ^H for 777 expect Backspace = ^H, GNU Emacs (and Emacs-like editors) use ^H for
… …
504 781
505 I don't like the key-bindings. How do I change them? 782 I don't like the key-bindings. How do I change them?
506 There are some compile-time selections available via configure. 783 There are some compile-time selections available via configure.
507 Unless you have run "configure" with the "--disable-resources" 784 Unless you have run "configure" with the "--disable-resources"
508 option you can use the `keysym' resource to alter the keystrings 785 option you can use the `keysym' resource to alter the keystrings
509 associated with keysym 0xFF00 - 0xFFFF (function, cursor keys, etc). 786 associated with keysyms.
510 787
511 Here's an example for a tn3270 session started using `rxvt -name 788 Here's an example for a URxvt session started using "rxvt -name
512 tn3270' 789 URxvt"
513 790
514 !# ----- special uses ------: 791 URxvt.keysym.Home: \033[1~
515 ! tn3270 login, remap function and arrow keys. 792 URxvt.keysym.End: \033[4~
516 tn3270*font: *clean-bold-*-*--15-* 793 URxvt.keysym.C-apostrophe: \033<C-'>
794 URxvt.keysym.C-slash: \033<C-/>
795 URxvt.keysym.C-semicolon: \033<C-;>
796 URxvt.keysym.C-grave: \033<C-`>
797 URxvt.keysym.C-comma: \033<C-,>
798 URxvt.keysym.C-period: \033<C-.>
799 URxvt.keysym.C-0x60: \033<C-`>
800 URxvt.keysym.C-Tab: \033<C-Tab>
801 URxvt.keysym.C-Return: \033<C-Return>
802 URxvt.keysym.S-Return: \033<S-Return>
803 URxvt.keysym.S-space: \033<S-Space>
804 URxvt.keysym.M-Up: \033<M-Up>
805 URxvt.keysym.M-Down: \033<M-Down>
806 URxvt.keysym.M-Left: \033<M-Left>
807 URxvt.keysym.M-Right: \033<M-Right>
808 URxvt.keysym.M-C-0: list \033<M-C- 0123456789 >
809 URxvt.keysym.M-C-a: list \033<M-C- abcdefghijklmnopqrstuvwxyz >
810 URxvt.keysym.F12: command:\033]701;zh_CN.GBK\007
517 811
518 ! keysym - used by rxvt only 812 See some more examples in the documentation for the keysym resource.
519 ! Delete - ^D
520 tn3270*keysym.0xFFFF: \004
521
522 ! Home - ^A
523 tn3270*keysym.0xFF50: \001
524 ! Left - ^B
525 tn3270*keysym.0xFF51: \002
526 ! Up - ^P
527 tn3270*keysym.0xFF52: \020
528 ! Right - ^F
529 tn3270*keysym.0xFF53: \006
530 ! Down - ^N
531 tn3270*keysym.0xFF54: \016
532 ! End - ^E
533 tn3270*keysym.0xFF57: \005
534
535 ! F1 - F12
536 tn3270*keysym.0xFFBE: \e1
537 tn3270*keysym.0xFFBF: \e2
538 tn3270*keysym.0xFFC0: \e3
539 tn3270*keysym.0xFFC1: \e4
540 tn3270*keysym.0xFFC2: \e5
541 tn3270*keysym.0xFFC3: \e6
542 tn3270*keysym.0xFFC4: \e7
543 tn3270*keysym.0xFFC5: \e8
544 tn3270*keysym.0xFFC6: \e9
545 tn3270*keysym.0xFFC7: \e0
546 tn3270*keysym.0xFFC8: \e-
547 tn3270*keysym.0xFFC9: \e=
548
549 ! map Prior/Next to F7/F8
550 tn3270*keysym.0xFF55: \e7
551 tn3270*keysym.0xFF56: \e8
552 813
553 I'm using keyboard model XXX that has extra Prior/Next/Insert keys. How 814 I'm using keyboard model XXX that has extra Prior/Next/Insert keys. How
554 do I make use of them? For example, the Sun Keyboard type 4 has the 815 do I make use of them? For example, the Sun Keyboard type 4 has the
555 following mappings that rxvt-unicode doesn't recognize. 816 following mappings that rxvt-unicode doesn't recognize.
556 KP_Insert == Insert 817 KP_Insert == Insert
… …
562 823
563 Rather than have rxvt-unicode try to accommodate all the various 824 Rather than have rxvt-unicode try to accommodate all the various
564 possible keyboard mappings, it is better to use `xmodmap' to remap 825 possible keyboard mappings, it is better to use `xmodmap' to remap
565 the keys as required for your particular machine. 826 the keys as required for your particular machine.
566 827
567 How do I distinguish if I'm running rxvt-unicode or a regular xterm? I 828 How do I distinguish wether I'm running rxvt-unicode or a regular xterm?
568 need this to decide about setting colors etc. 829 I need this to decide about setting colors etc.
569 rxvt and rxvt-unicode always export the variable "COLORTERM", so you 830 rxvt and rxvt-unicode always export the variable "COLORTERM", so you
570 can check and see if that is set. Note that several programs, JED, 831 can check and see if that is set. Note that several programs, JED,
571 slrn, Midnight Commander automatically check this variable to decide 832 slrn, Midnight Commander automatically check this variable to decide
572 whether or not to use color. 833 whether or not to use color.
573 834
… …
604 Before sending me mail, you could go to IRC: "irc.freenode.net", 865 Before sending me mail, you could go to IRC: "irc.freenode.net",
605 channel "#rxvt-unicode" has some rxvt-unicode enthusiasts that might 866 channel "#rxvt-unicode" has some rxvt-unicode enthusiasts that might
606 be interested in learning about new and exciting problems (but not 867 be interested in learning about new and exciting problems (but not
607 FAQs :). 868 FAQs :).
608 869
609SYNOPSIS 870RXVT TECHNICAL REFERENCE
610 # set a new font set
611 printf '\33]50;%s\007' 9x15,xft:Kochi" Mincho"
612
613 # change the locale and tell rxvt-unicode about it
614 export LC_CTYPE=ja_JP.EUC-JP; printf "\33]701;$LC_CTYPE\007"
615
616 # set window title
617 printf '\33]2;%s\007' "new window title"
618
619DESCRIPTION 871DESCRIPTION
620 The rest of this document describes various technical aspects of 872 The rest of this document describes various technical aspects of
621 rxvt-unicode. First the description of supported command sequences, 873 rxvt-unicode. First the description of supported command sequences,
622 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
623 features selectable at "configure" time. 875 selectable at "configure" time.
624 876
625RXVT TECHNICAL REFERENCE
626Definitions 877Definitions
627 "c" The literal character c. 878 "c" The literal character c.
628 879
629 "C" A single (required) character. 880 "C" A single (required) character.
630 881
… …
715 "ESC O" 966 "ESC O"
716 Single Shift Select of G3 Character Set (SS3): affects next 967 Single Shift Select of G3 Character Set (SS3): affects next
717 character only *unimplemented* 968 character only *unimplemented*
718 969
719 "ESC Z" 970 "ESC Z"
720 Obsolete form of returns: "ESC[?1;2C" *rxvt-unicode compile-time 971 Obsolete form of returns: "ESC [ ? 1 ; 2 C" *rxvt-unicode
721 option* 972 compile-time option*
722 973
723 "ESC c" 974 "ESC c"
724 Full reset (RIS) 975 Full reset (RIS)
725 976
726 "ESC n" 977 "ESC n"
727 Invoke the G2 Character Set (LS2) 978 Invoke the G2 Character Set (LS2)
728 979
729 "ESC o" 980 "ESC o"
730 Invoke the G3 Character Set (LS3) 981 Invoke the G3 Character Set (LS3)
731 982
732 "ESC" ( C> 983 "ESC ( C"
733 Designate G0 Character Set (ISO 2022), see below for values of "C". 984 Designate G0 Character Set (ISO 2022), see below for values of "C".
734 985
735 "ESC" ) C> 986 "ESC ) C"
736 Designate G1 Character Set (ISO 2022), see below for values of "C". 987 Designate G1 Character Set (ISO 2022), see below for values of "C".
737 988
738 "ESC * C" 989 "ESC * C"
739 Designate G2 Character Set (ISO 2022), see below for values of "C". 990 Designate G2 Character Set (ISO 2022), see below for values of "C".
740 991
… …
833 "ESC [ Ps a" 1084 "ESC [ Ps a"
834 See "ESC [ Ps C" 1085 See "ESC [ Ps C"
835 1086
836 "ESC [ Ps c" 1087 "ESC [ Ps c"
837 Send Device Attributes (DA) "Ps = 0" (or omitted): request 1088 Send Device Attributes (DA) "Ps = 0" (or omitted): request
838 attributes from terminal returns: "ESC[?1;2c" (``I am a VT100 with 1089 attributes from terminal returns: "ESC [ ? 1 ; 2 c" (``I am a VT100
839 Advanced Video Option'') 1090 with Advanced Video Option'')
840 1091
841 "ESC [ Ps d" 1092 "ESC [ Ps d"
842 Cursor to Line "Ps" (VPA) 1093 Cursor to Line "Ps" (VPA)
843 1094
844 "ESC [ Ps e" 1095 "ESC [ Ps e"
… …
918 (CSR) 1169 (CSR)
919 1170
920 "ESC [ s" 1171 "ESC [ s"
921 Save Cursor (SC) 1172 Save Cursor (SC)
922 1173
1174 "ESC [ Ps;Pt t"
1175 Window Operations
1176
1177 Ps = 1 Deiconify (map) window
1178 Ps = 2 Iconify window
1179 Ps = 3 ESC [ 3 ; X ; Y t Move window to (X|Y)
1180 Ps = 4 ESC [ 4 ; H ; W t Resize to WxH pixels
1181 Ps = 5 Raise window
1182 Ps = 6 Lower window
1183 Ps = 7 Refresh screen once
1184 Ps = 8 ESC [ 8 ; R ; C t Resize to R rows and C columns
1185 Ps = 11 Report window state (responds with Ps = 1 or Ps = 2)
1186 Ps = 13 Report window position (responds with Ps = 3)
1187 Ps = 14 Report window pixel size (responds with Ps = 4)
1188 Ps = 18 Report window text size (responds with Ps = 7)
1189 Ps = 19 Currently the same as Ps = 18, but responds with Ps = 9
1190 Ps = 20 Reports icon label (ESC ] L NAME \234)
1191 Ps = 21 Reports window title (ESC ] l NAME \234)
1192 Ps = 24.. Set window height to Ps rows
1193
1194 "ESC [ u"
1195 Restore Cursor
1196
923 "ESC [ Ps x" 1197 "ESC [ Ps x"
924 Request Terminal Parameters (DECREQTPARM) 1198 Request Terminal Parameters (DECREQTPARM)
925
926 "ESC [ u"
927 Restore Cursor
928 1199
929 1200
930 1201
931DEC Private Modes 1202DEC Private Modes
932 "ESC [ ? Pm h" 1203 "ESC [ ? Pm h"
… …
977 l No Auto-repeat Keys (DECARM) 1248 l No Auto-repeat Keys (DECARM)
978 1249
979 "Ps = 9" X10 XTerm 1250 "Ps = 9" X10 XTerm
980 h Send Mouse X & Y on button press. 1251 h Send Mouse X & Y on button press.
981 l No mouse reporting. 1252 l No mouse reporting.
982
983 "Ps = 10" (rxvt)
984 h menuBar visible
985 l menuBar invisible
986 1253
987 "Ps = 25" 1254 "Ps = 25"
988 h Visible cursor {cnorm/cvvis} 1255 h Visible cursor {cnorm/cvvis}
989 l Invisible cursor {civis} 1256 l Invisible cursor {civis}
990 1257
… …
1039 l Scroll to bottom on TTY output 1306 l Scroll to bottom on TTY output
1040 1307
1041 "Ps = 1011" (rxvt) 1308 "Ps = 1011" (rxvt)
1042 h Scroll to bottom when a key is pressed 1309 h Scroll to bottom when a key is pressed
1043 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)
1044 1315
1045 "Ps = 1047" 1316 "Ps = 1047"
1046 h Use Alternate Screen Buffer 1317 h Use Alternate Screen Buffer
1047 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
1048 1319
… …
1071 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)
1072 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)
1073 Ps = 12 Change colour of text cursor foreground to Pt 1344 Ps = 12 Change colour of text cursor foreground to Pt
1074 Ps = 13 Change colour of mouse foreground to Pt 1345 Ps = 13 Change colour of mouse foreground to Pt
1075 Ps = 17 Change colour of highlight characters to Pt 1346 Ps = 17 Change colour of highlight characters to Pt
1076 Ps = 18 Change colour of bold characters to Pt 1347 Ps = 18 Change colour of bold characters to Pt [deprecated, see 706]
1077 Ps = 19 Change colour of underlined characters to Pt 1348 Ps = 19 Change colour of underlined characters to Pt [deprecated, see 707]
1078 Ps = 20 Change default background to Pt 1349 Ps = 20 Change default background to Pt
1079 Ps = 39 Change default foreground colour to Pt rxvt compile-time option 1350 Ps = 39 Change default foreground colour to Pt.
1080 Ps = 46 Change Log File to Pt unimplemented 1351 Ps = 46 Change Log File to Pt unimplemented
1081 Ps = 49 Change default background colour to Pt rxvt compile-time option 1352 Ps = 49 Change default background colour to Pt.
1082 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
1083 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
1084 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).
1085 Ps = 703 Menubar command Pt rxvt compile-time option (rxvt-unicode extension)
1086 Ps = 704 Change colour of italic characters to Pt 1356 Ps = 704 Change colour of italic characters to Pt
1087 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
1088 Ps = 710 Set normal fontset to Pt. Same as Ps = 50. 1360 Ps = 710 Set normal fontset to Pt. Same as Ps = 50.
1089 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).
1090 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).
1091 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).
1092 1367
1093 1368
1094
1095menuBar
1096 The exact syntax used is *almost* solidified. In the menus, DON'T try to
1097 use menuBar commands that add or remove a menuBar.
1098
1099 Note that in all of the commands, the */path/* *cannot* be omitted: use
1100 ./ to specify a menu relative to the current menu.
1101
1102 Overview of menuBar operation
1103 For the menuBar XTerm escape sequence "ESC ] 703 ; Pt ST", the syntax of
1104 "Pt" can be used for a variety of tasks:
1105
1106 At the top level is the current menuBar which is a member of a circular
1107 linked-list of other such menuBars.
1108
1109 The menuBar acts as a parent for the various drop-down menus, which in
1110 turn, may have labels, separator lines, menuItems and subMenus.
1111
1112 The menuItems are the useful bits: you can use them to mimic keyboard
1113 input or even to send text or escape sequences back to rxvt.
1114
1115 The menuBar syntax is intended to provide a simple yet robust method of
1116 constructing and manipulating menus and navigating through the menuBars.
1117
1118 The first step is to use the tag [menu:*name*] which creates the menuBar
1119 called *name* and allows access. You may now or menus, subMenus, and
1120 menuItems. Finally, use the tag [done] to set the menuBar access as
1121 readonly to prevent accidental corruption of the menus. To re-access the
1122 current menuBar for alterations, use the tag [menu], make the
1123 alterations and then use [done]
1124
1125
1126
1127 Commands
1128 [menu:+*name*]
1129 access the named menuBar for creation or alteration. If a new
1130 menuBar is created, it is called *name* (max of 15 chars) and the
1131 current menuBar is pushed onto the stack
1132
1133 [menu]
1134 access the current menuBar for alteration
1135
1136 [title:+*string*]
1137 set the current menuBar's title to *string*, which may contain the
1138 following format specifiers: %% : literal % character %n : rxvt name
1139 (as per the -name command-line option) %v : rxvt version
1140
1141 [done]
1142 set menuBar access as readonly. End-of-file tag for [read:+*file*]
1143 operations.
1144
1145 [read:+*file*]
1146 read menu commands directly from *file* (extension ".menu" will be
1147 appended if required.) Start reading at a line with [menu] or
1148 [menu:+*name* and continuing until [done] is encountered.
1149
1150 Blank and comment lines (starting with #) are ignored. Actually,
1151 since any invalid menu commands are also ignored, almost anything
1152 could be construed as a comment line, but this may be tightened up
1153 in the future ... so don't count on it!.
1154
1155 [read:+*file*;+*name*]
1156 The same as [read:+*file*], but start reading at a line with
1157 [menu:+*name*] and continuing until [done:+*name*] or [done] is
1158 encountered.
1159
1160 [dump]
1161 dump all menuBars to the file /tmp/rxvt-PID in a format suitable for
1162 later rereading.
1163
1164 [rm:name]
1165 remove the named menuBar
1166
1167 [rm] [rm:]
1168 remove the current menuBar
1169
1170 [rm*] [rm:*]
1171 remove all menuBars
1172
1173 [swap]
1174 swap the top two menuBars
1175
1176 [prev]
1177 access the previous menuBar
1178
1179 [next]
1180 access the next menuBar
1181
1182 [show]
1183 Enable display of the menuBar
1184
1185 [hide]
1186 Disable display of the menuBar
1187
1188 [pixmap:+*name*]
1189 [pixmap:+*name*;*scaling*]
1190 (set the background pixmap globally
1191
1192 A Future implementation *may* make this local to the menubar)
1193
1194 [:+*command*:]
1195 ignore the menu readonly status and issue a *command* to or a menu
1196 or menuitem or change the ; a useful shortcut for setting the quick
1197 arrows from a menuBar.
1198
1199
1200
1201 Adding and accessing menus
1202 The following commands may also be + prefixed.
1203
1204 /+ access menuBar top level
1205
1206 ./+ access current menu level
1207
1208 ../+
1209 access parent menu (1 level up)
1210
1211 ../../
1212 access parent menu (multiple levels up)
1213
1214 */path/*menu
1215 add/access menu
1216
1217 */path/*menu/*
1218 add/access menu and clear it if it exists
1219
1220 */path/*{-}
1221 add separator
1222
1223 */path/*{item}
1224 add item as a label
1225
1226 */path/*{item} action
1227 add/alter *menuitem* with an associated *action*
1228
1229 */path/*{item}{right-text}
1230 add/alter *menuitem* with right-text as the right-justified text and
1231 as the associated *action*
1232
1233 */path/*{item}{rtext} action
1234 add/alter *menuitem* with an associated *action* and with rtext as
1235 the right-justified text.
1236
1237 Special characters in *action* must be backslash-escaped:
1238 \a \b \E \e \n \r \t \octal
1239
1240 or in control-character notation:
1241 ^@, ^A .. ^Z .. ^_, ^?
1242
1243 To send a string starting with a NUL (^@) character to the program,
1244 start *action* with a pair of NUL characters (^@^@), the first of which
1245 will be stripped off and the balance directed to the program. Otherwise
1246 if *action* begins with NUL followed by non-+NUL characters, the leading
1247 NUL is stripped off and the balance is sent back to rxvt.
1248
1249 As a convenience for the many Emacs-type editors, *action* may start
1250 with M- (eg, M-$ is equivalent to \E$) and a CR will be appended if
1251 missed from M-x commands.
1252
1253 As a convenience for issuing XTerm ESC] sequences from a menubar (or
1254 quick arrow), a BEL (^G) will be appended if needed.
1255
1256 For example,
1257 M-xapropos is equivalent to \Exapropos\r
1258
1259 and \E]703;mona;100 is equivalent to \E]703;mona;100\a
1260
1261 The option {*right-rtext*} will be right-justified. In the absence of a
1262 specified action, this text will be used as the *action* as well.
1263
1264 For example,
1265 /File/{Open}{^X^F} is equivalent to /File/{Open}{^X^F} ^X^F
1266
1267 The left label *is* necessary, since it's used for matching, but
1268 implicitly hiding the left label (by using same name for both left and
1269 right labels), or explicitly hiding the left label (by preceeding it
1270 with a dot), makes it possible to have right-justified text only.
1271
1272 For example,
1273 /File/{Open}{Open} Open-File-Action
1274
1275 or hiding it
1276 /File/{.anylabel}{Open} Open-File-Action
1277
1278
1279
1280 Removing menus
1281 -/*+
1282 remove all menus from the menuBar, the same as [clear]
1283
1284 -+*/path*menu+
1285 remove menu
1286
1287 -+*/path*{item}+
1288 remove item
1289
1290 -+*/path*{-}
1291 remove separator)
1292
1293 -/path/menu/*
1294 remove all items, separators and submenus from menu
1295
1296
1297
1298 Quick Arrows
1299 The menus also provide a hook for *quick arrows* to provide easier user
1300 access. If nothing has been explicitly set, the default is to emulate
1301 the curror keys. The syntax permits each arrow to be altered
1302 individually or all four at once without re-entering their common
1303 beginning/end text. For example, to explicitly associate cursor actions
1304 with the arrows, any of the following forms could be used:
1305
1306 <r>+*Right*
1307 <l>+*Left*
1308 <u>+*Up*
1309 <d>+*Down*
1310 Define actions for the respective arrow buttons
1311
1312 <b>+*Begin*
1313 <e>+*End*
1314 Define common beginning/end parts for *quick arrows* which used in
1315 conjunction with the above <r> <l> <u> <d> constructs
1316
1317 For example, define arrows individually,
1318 <u>\E[A
1319
1320 <d>\E[B
1321
1322 <r>\E[C
1323
1324 <l>\E[D
1325
1326 or all at once
1327 <u>\E[AZ<><d>\E[BZ<><r>\E[CZ<><l>\E[D
1328
1329 or more compactly (factoring out common parts)
1330 <b>\E[<u>AZ<><d>BZ<><r>CZ<><l>D
1331
1332
1333
1334 Command Summary
1335 A short summary of the most *common* commands:
1336
1337 [menu:name]
1338 use an existing named menuBar or start a new one
1339
1340 [menu]
1341 use the current menuBar
1342
1343 [title:string]
1344 set menuBar title
1345
1346 [done]
1347 set menu access to readonly and, if reading from a file, signal EOF
1348
1349 [done:name]
1350 if reading from a file using [read:file;name] signal EOF
1351
1352 [rm:name]
1353 remove named menuBar(s)
1354
1355 [rm] [rm:]
1356 remove current menuBar
1357
1358 [rm*] [rm:*]
1359 remove all menuBar(s)
1360
1361 [swap]
1362 swap top two menuBars
1363
1364 [prev]
1365 access the previous menuBar
1366
1367 [next]
1368 access the next menuBar
1369
1370 [show]
1371 map menuBar
1372
1373 [hide]
1374 unmap menuBar
1375
1376 [pixmap;file]
1377 [pixmap;file;scaling]
1378 set a background pixmap
1379
1380 [read:file]
1381 [read:file;name]
1382 read in a menu from a file
1383
1384 [dump]
1385 dump out all menuBars to /tmp/rxvt-PID
1386
1387 / access menuBar top level
1388
1389 ./
1390 ../
1391 ../../
1392 access current or parent menu level
1393
1394 /path/menu
1395 add/access menu
1396
1397 /path/{-}
1398 add separator
1399
1400 /path/{item}{rtext} action
1401 add/alter menu item
1402
1403 -/* remove all menus from the menuBar
1404
1405 -/path/menu
1406 remove menu items, separators and submenus from menu
1407
1408 -/path/menu
1409 remove menu
1410
1411 -/path/{item}
1412 remove item
1413
1414 -/path/{-}
1415 remove separator
1416
1417 <b>Begin<r>Right<l>Left<u>Up<d>Down<e>End
1418 menu quick arrows
1419 1369
1420XPM 1370XPM
1421 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"
1422 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
1423 scaling/positioning commands separated by semi-colons. The 1373 scaling/positioning commands separated by semi-colons. The
… …
1558 XK_KP_8 8 ESC O x 1508 XK_KP_8 8 ESC O x
1559 XK_KP_9 9 ESC O y 1509 XK_KP_9 9 ESC O y
1560 1510
1561CONFIGURE OPTIONS 1511CONFIGURE OPTIONS
1562 General hint: if you get compile errors, then likely your configuration 1512 General hint: if you get compile errors, then likely your configuration
1563 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
1564 ./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
1565 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
1566 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
1567 <rxvt@schmorp.de>. 1517 fixed. Marc Lehmann <rxvt@schmorp.de>.
1518
1519 All
1568 1520
1569 --enable-everything 1521 --enable-everything
1570 Add support for all non-multichoice options listed in "./configure 1522 Add (or remove) support for all non-multichoice options listed in
1571 --help". Note that unlike other enable options this is order 1523 "./configure --help".
1572 dependant. You can specify this and then disable options which this
1573 enables by *following* this with the appropriate commands.
1574 1524
1575 --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)
1576 Add support for Xft (anti-aliases, among others) fonts. Xft fonts 1532 Add support for Xft (anti-aliases, among others) fonts. Xft fonts
1577 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
1578 them, you don't pay for them. 1534 them, you don't pay for them.
1579 1535
1580 --enable-font-styles 1536 --enable-font-styles (default: on)
1581 Add support for bold, *italic* and *bold italic* font styles. The 1537 Add support for bold, *italic* and *bold italic* font styles. The
1582 fonts can be set manually or automatically. 1538 fonts can be set manually or automatically.
1583 1539
1584 --with-codesets=NAME,... 1540 --with-codesets=NAME,... (default: all)
1585 Compile in support for additional codeset (encoding) groups (eu, vn 1541 Compile in support for additional codeset (encoding) groups ("eu",
1586 are always compiled in, which includes most 8-bit character sets). 1542 "vn" are always compiled in, which includes most 8-bit character
1587 These codeset tables are currently only used for driving X11 core 1543 sets). These codeset tables are used for driving X11 core fonts,
1588 fonts, they are not required for Xft fonts. Compiling them in will 1544 they are not required for Xft fonts, although having them compiled
1589 make your binary bigger (together about 700kB), but it doesn't 1545 in lets rxvt-unicode choose replacement fonts more intelligently.
1590 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
1591 these encodings. 1547 about 700kB), but it doesn't increase memory usage unless you use a
1548 font requiring one of these encodings.
1592 1549
1593 all all available codeset groups 1550 all all available codeset groups
1594 zh common chinese encodings 1551 zh common chinese encodings
1595 zh_ext rarely used but very big chinese encodigs 1552 zh_ext rarely used but very big chinese encodigs
1596 jp common japanese encodings 1553 jp common japanese encodings
1597 jp_ext rarely used but big japanese encodings 1554 jp_ext rarely used but big japanese encodings
1598 kr korean encodings 1555 kr korean encodings
1599 1556
1600 --enable-xim 1557 --enable-xim (default: on)
1601 Add support for XIM (X Input Method) protocol. This allows using 1558 Add support for XIM (X Input Method) protocol. This allows using
1602 alternative input methods (e.g. kinput2) and will also correctly set 1559 alternative input methods (e.g. kinput2) and will also correctly set
1603 up the input for people using dead keys or compose keys. 1560 up the input for people using dead keys or compose keys.
1604 1561
1605 --enable-unicode3 1562 --enable-unicode3 (default: off)
1606 Enable direct support for displaying unicode codepoints above 65535 1563 Enable direct support for displaying unicode codepoints above 65535
1607 (the basic multilingual page). This increases storage requirements 1564 (the basic multilingual page). This increases storage requirements
1608 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
1609 extra characters, but Xft does. 1566 extra characters, but Xft does.
1610 1567
… …
1612 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
1613 to a view thousand (shared with combining characters, see next 1570 to a view thousand (shared with combining characters, see next
1614 switch), and right now rxvt-unicode cannot display them 1571 switch), and right now rxvt-unicode cannot display them
1615 (input/output and cut&paste still work, though). 1572 (input/output and cut&paste still work, though).
1616 1573
1617 --enable-combining 1574 --enable-combining (default: on)
1618 Enable automatic composition of combining characters into composite 1575 Enable automatic composition of combining characters into composite
1619 characters. This is required for proper viewing of text where 1576 characters. This is required for proper viewing of text where
1620 accents are encoded as seperate unicode characters. This is done by 1577 accents are encoded as seperate unicode characters. This is done by
1621 using precomposited characters when available or creating new 1578 using precomposited characters when available or creating new
1622 pseudo-characters when no precomposed form exists. 1579 pseudo-characters when no precomposed form exists.
1623 1580
1624 Without --enable-unicode3, the number of additional precomposed 1581 Without --enable-unicode3, the number of additional precomposed
1625 characters is rather limited (2048, if this is full, rxvt will use 1582 characters is rather limited (2048, if this is full, rxvt-unicode
1626 the private use area, extending the number of combinations to 8448). 1583 will use the private use area, extending the number of combinations
1627 With --enable-unicode3, no practical limit exists. This will also 1584 to 8448). With --enable-unicode3, no practical limit exists.
1628 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.
1629 1588
1630 The combining table also contains entries for arabic presentation 1589 The combining table also contains entries for arabic presentation
1631 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
1632 be used. 1591 be used (and tell me how these are to be used...).
1633 1592
1634 --enable-fallback(=CLASS) 1593 --enable-fallback(=CLASS) (default: Rxvt)
1635 When reading resource settings, also read settings for class CLASS 1594 When reading resource settings, also read settings for class CLASS.
1636 (default: Rxvt). To disable resource fallback use 1595 To disable resource fallback use --disable-fallback.
1637 --disable-fallback.
1638 1596
1639 --with-res-name=NAME 1597 --with-res-name=NAME (default: urxvt)
1640 Use the given name (default: urxvt) as default application name when 1598 Use the given name as default application name when reading
1641 reading resources. Specify --with-res-name=rxvt to replace rxvt. 1599 resources. Specify --with-res-name=rxvt to replace rxvt.
1642 1600
1643 --with-res-class=CLASS 1601 --with-res-class=CLASS /default: URxvt)
1644 Use the given class (default: URxvt) as default application class 1602 Use the given class as default application class when reading
1645 when reading resources. Specify --with-res-class=Rxvt to replace 1603 resources. Specify --with-res-class=Rxvt to replace rxvt.
1646 rxvt.
1647 1604
1648 --enable-utmp 1605 --enable-utmp (default: on)
1649 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
1650 of rxvt execution and delete information when rxvt exits. 1607 of rxvt execution and delete information when rxvt exits.
1651 1608
1652 --enable-wtmp 1609 --enable-wtmp (default: on)
1653 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
1654 start of rxvt execution and write logout when rxvt exits. This 1611 start of rxvt execution and write logout when rxvt exits. This
1655 option requires --enable-utmp to also be specified. 1612 option requires --enable-utmp to also be specified.
1656 1613
1657 --enable-lastlog 1614 --enable-lastlog (default: on)
1658 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)
1659 at start of rxvt execution. This option requires --enable-utmp to 1616 at start of rxvt execution. This option requires --enable-utmp to
1660 also be specified. 1617 also be specified.
1661 1618
1662 --enable-xpm-background 1619 --enable-xpm-background (default: on)
1663 Add support for XPM background pixmaps. 1620 Add support for XPM background pixmaps.
1664 1621
1665 --enable-transparency 1622 --enable-transparency (default: on)
1666 Add support for inheriting parent backgrounds thus giving a fake 1623 Add support for inheriting parent backgrounds thus giving a fake
1667 transparency to the term. 1624 transparency to the term.
1668 1625
1669 --enable-fading 1626 --enable-fading (default: on)
1670 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").
1671 1629
1672 --enable-tinting 1630 --enable-tinting (default: on)
1673 Add support for tinting of transparent backgrounds. 1631 Add support for tinting of transparent backgrounds (requires
1632 "--enable-transparency").
1674 1633
1675 --enable-menubar
1676 Add support for our menu bar system (this interacts badly with
1677 dynamic locale switching currently).
1678
1679 --enable-rxvt-scroll 1634 --enable-rxvt-scroll (default: on)
1680 Add support for the original rxvt scrollbar. 1635 Add support for the original rxvt scrollbar.
1681 1636
1682 --enable-next-scroll 1637 --enable-next-scroll (default: on)
1683 Add support for a NeXT-like scrollbar. 1638 Add support for a NeXT-like scrollbar.
1684 1639
1685 --enable-xterm-scroll 1640 --enable-xterm-scroll (default: on)
1686 Add support for an Xterm-like scrollbar. 1641 Add support for an Xterm-like scrollbar.
1687 1642
1688 --enable-plain-scroll 1643 --enable-plain-scroll (default: on)
1689 Add support for a very unobtrusive, plain-looking scrollbar that is 1644 Add support for a very unobtrusive, plain-looking scrollbar that is
1690 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
1691 years. 1646 years.
1692 1647
1693 --enable-half-shadow 1648 --enable-ttygid (default: off)
1694 Make shadows on the scrollbar only half the normal width & height.
1695 only applicable to rxvt scrollbars.
1696
1697 --enable-ttygid
1698 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
1699 system uses this type of security. 1650 system uses this type of security.
1700 1651
1701 --disable-backspace-key 1652 --disable-backspace-key
1702 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
1703 do it. 1654 do it.
1704 1655
1705 --disable-delete-key 1656 --disable-delete-key
1706 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
1707 it. 1658 it.
1708 1659
1709 --disable-resources 1660 --disable-resources
1710 Remove all resources checking. 1661 Removes any support for resource checking.
1711
1712 --enable-xgetdefault
1713 Make resources checking via XGetDefault() instead of our small
1714 version which only checks ~/.Xdefaults, or if that doesn't exist
1715 then ~/.Xresources.
1716
1717 --enable-strings
1718 Add support for our possibly faster memset() function and other
1719 various routines, overriding your system's versions which may have
1720 been hand-crafted in assembly or may require extra libraries to link
1721 in. (this breaks ANSI-C rules and has problems on many GNU/Linux
1722 systems).
1723 1662
1724 --disable-swapscreen 1663 --disable-swapscreen
1725 Remove support for swap screen. 1664 Remove support for secondary/swap screen.
1726 1665
1727 --enable-frills 1666 --enable-frills (default: on)
1728 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
1729 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
1730 want to disable this. 1669 want to disable this.
1731 1670
1671 A non-exhaustive list of features enabled by "--enable-frills"
1672 (possibly in combination with other switches) is:
1673
1674 MWM-hints
1675 EWMH-hints (pid, utf8 names) and protocols (ping)
1676 seperate underline colour (-underlineColor)
1677 settable border widths and borderless switch (-w, -b, -bl)
1678 settable extra linespacing /-lsp)
1679 iso-14755-2 and -3, and visual feedback
1680 backindex and forwardindex escape sequence
1681 window op and some xterm/OSC escape sequences
1682 tripleclickwords (-tcw)
1683 settable insecure mode (-insecure)
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
1691
1732 --enable-iso14755 1692 --enable-iso14755 (default: on)
1733 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).
1734 Basic support (section 5.1) is enabled by "--enable-frills", while 1694 Basic support (section 5.1) is enabled by "--enable-frills", while
1735 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.
1736 1696
1737 --enable-keepscrolling 1697 --enable-keepscrolling (default: on)
1738 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
1739 mouse button down on a scrollbar arrow. 1699 mouse button down on a scrollbar arrow.
1740 1700
1741 --enable-mousewheel 1701 --enable-mousewheel (default: on)
1742 Add support for scrolling via mouse wheel or buttons 4 & 5. 1702 Add support for scrolling via mouse wheel or buttons 4 & 5.
1743 1703
1744 --enable-slipwheeling 1704 --enable-slipwheeling (default: on)
1745 Add support for continual scrolling (using the mouse wheel as an 1705 Add support for continual scrolling (using the mouse wheel as an
1746 accelerator) while the control key is held down. This option 1706 accelerator) while the control key is held down. This option
1747 requires --enable-mousewheel to also be specified. 1707 requires --enable-mousewheel to also be specified.
1748 1708
1749 --disable-new-selection 1709 --disable-new-selection
1750 Remove support for mouse selection style like that of xterm. 1710 Remove support for mouse selection style like that of xterm.
1751 1711
1752 --enable-dmalloc 1712 --enable-dmalloc (default: off)
1753 Use Gray Watson's malloc - which is good for debugging See 1713 Use Gray Watson's malloc - which is good for debugging See
1754 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
1755 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
1756 compiling to point DINCLUDE and DLIB to the right places. 1716 compiling to point DINCLUDE and DLIB to the right places.
1757 1717
1758 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
1759 use either) . 1719 use either) .
1760 1720
1761 --enable-dlmalloc 1721 --enable-dlmalloc (default: off)
1762 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
1763 <http://g.oswego.edu/dl/html/malloc.html> for details. 1723 <http://g.oswego.edu/dl/html/malloc.html> for details.
1764 1724
1765 --enable-smart-resize 1725 --enable-smart-resize (default: on)
1766 Add smart growth/shrink behaviour when changing font size via from 1726 Add smart growth/shrink behaviour when changing font size via hot
1767 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
1768 is closest to a corner of the screen. 1728 corner of the screen in a fixed position.
1769 1729
1770 --enable-cursor-blink
1771 Add support for a blinking cursor.
1772
1773 --enable-pointer-blank 1730 --enable-pointer-blank (default: on)
1774 Add support to have the pointer disappear when typing or inactive. 1731 Add support to have the pointer disappear when typing or inactive.
1775 1732
1776 --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)
1777 Set the basename for the installed binaries (default: urxvt, 1741 Set the basename for the installed binaries, resulting in "urxvt",
1778 resulting in urxvt, urxvtd etc.). Specify --with-name=rxvt to 1742 "urxvtd" etc.). Specify "--with-name=rxvt" to replace with "rxvt".
1779 replace rxvt.
1780 1743
1781 --with-term=NAME 1744 --with-term=NAME (default: rxvt-unicode)
1782 Change the environmental variable for the terminal to NAME (default 1745 Change the environmental variable for the terminal to NAME.
1783 "rxvt")
1784 1746
1785 --with-terminfo=PATH 1747 --with-terminfo=PATH
1786 Change the environmental variable for the path to the terminfo tree 1748 Change the environmental variable for the path to the terminfo tree
1787 to PATH. 1749 to PATH.
1788 1750

Diff Legend

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