|
|
1 | =head1 NAME |
|
|
2 | |
|
|
3 | RXVT REFERENCE - FAQ, command sequences and other background information |
|
|
4 | |
|
|
5 | =head1 SYNOPSIS |
|
|
6 | |
|
|
7 | # set a new font set |
|
|
8 | printf '\33]50;%s\007' 9x15,xft:Kochi" Mincho" |
|
|
9 | |
|
|
10 | # change the locale and tell rxvt-unicode about it |
|
|
11 | export LC_CTYPE=ja_JP.EUC-JP; printf "\33]701;$LC_CTYPE\007" |
|
|
12 | |
|
|
13 | # set window title |
|
|
14 | printf '\33]2;%s\007' "new window title" |
|
|
15 | |
|
|
16 | =head1 DESCRIPTION |
|
|
17 | |
|
|
18 | This document contains the FAQ, the RXVT TECHNICAL REFERENCE documenting |
|
|
19 | all escape sequences, and other background information. |
|
|
20 | |
|
|
21 | The newest version of this document is |
|
|
22 | also available on the World Wide Web at |
|
|
23 | L<http://cvs.schmorp.de/browse/*checkout*/rxvt-unicode/doc/rxvt.7.html>. |
|
|
24 | |
|
|
25 | =head1 FREQUENTLY ASKED QUESTIONS |
|
|
26 | |
|
|
27 | =over 4 |
|
|
28 | |
|
|
29 | =item Isn't rxvt supposed to be small? Don't all those features bloat? |
|
|
30 | |
|
|
31 | I often get asked about this, and I think, no, they didn't cause extra |
|
|
32 | bloat. If you compare a minimal rxvt and a minimal urxvt, you can see |
|
|
33 | that the urxvt binary is larger (due to some encoding tables always being |
|
|
34 | compiled in), but it actually uses less memory (RSS) after startup. Even |
|
|
35 | with C<--disable-everything>, this comparison is a bit unfair, as many |
|
|
36 | features unique to urxvt (locale, encoding conversion, iso14755 etc.) are |
|
|
37 | already in use in this mode. |
|
|
38 | |
|
|
39 | text data bss drs rss filename |
|
|
40 | 98398 1664 24 15695 1824 rxvt --disable-everything |
|
|
41 | 188985 9048 66616 18222 1788 urxvt --disable-everything |
|
|
42 | |
|
|
43 | When you C<--enable-everything> (which _is_ unfair, as this involves xft |
|
|
44 | and full locale/XIM support which are quite bloaty inside libX11 and my |
|
|
45 | libc), the two diverge, but not unreasnobaly so. |
|
|
46 | |
|
|
47 | text data bss drs rss filename |
|
|
48 | 163431 2152 24 20123 2060 rxvt --enable-everything |
|
|
49 | 1035683 49680 66648 29096 3680 urxvt --enable-everything |
|
|
50 | |
|
|
51 | The very large size of the text section is explained by the east-asian |
|
|
52 | encoding tables, which, if unused, take up disk space but nothing else |
|
|
53 | and can be compiled out unless you rely on X11 core fonts that use those |
|
|
54 | encodings. The BSS size comes from the 64k emergency buffer that my c++ |
|
|
55 | compiler allocates (but of course doesn't use unless you are out of |
|
|
56 | memory). Also, using an xft font instead of a core font immediately adds a |
|
|
57 | few megabytes of RSS. Xft indeed is responsible for a lot of RSS even when |
|
|
58 | not used. |
|
|
59 | |
|
|
60 | Of course, due to every character using two or four bytes instead of one, |
|
|
61 | a large scrollback buffer will ultimately make rxvt-unicode use more |
|
|
62 | memory. |
|
|
63 | |
|
|
64 | Compared to e.g. Eterm (5112k), aterm (3132k) and xterm (4680k), this |
|
|
65 | still fares rather well. And compared to some monsters like gnome-terminal |
|
|
66 | (21152k + extra 4204k in separate processes) or konsole (22200k + extra |
|
|
67 | 43180k in daemons that stay around after exit, plus half aminute of |
|
|
68 | startup time, including the hundreds of warnings it spits out), it fares |
|
|
69 | extremely well *g*. |
|
|
70 | |
|
|
71 | =item Why C++, isn't that unportable/bloated/uncool? |
|
|
72 | |
|
|
73 | Is this a question? :) It comes up very often. The simple answer is: I had |
|
|
74 | to write it, and C++ allowed me to write and maintain it in a fraction |
|
|
75 | of the time and effort (which is a scarce resource for me). Put even |
|
|
76 | shorter: It simply wouldn't exist without C++. |
|
|
77 | |
|
|
78 | My personal stance on this is that C++ is less portable than C, but in |
|
|
79 | the case of rxvt-unicode this hardly matters, as its portability limits |
|
|
80 | are defined by things like X11, pseudo terminals, locale support and unix |
|
|
81 | domain sockets, which are all less portable than C++ itself. |
|
|
82 | |
|
|
83 | Regarding the bloat, see the above question: It's easy to write programs |
|
|
84 | in C that use gobs of memory, an certainly possible to write programs in |
|
|
85 | C++ that don't. C++ also often comes with large libraries, but this is |
|
|
86 | not necessarily the case with GCC. Here is what rxvt links against on my |
|
|
87 | system with a minimal config: |
|
|
88 | |
|
|
89 | libX11.so.6 => /usr/X11R6/lib/libX11.so.6 (0x00002aaaaabc3000) |
|
|
90 | libc.so.6 => /lib/libc.so.6 (0x00002aaaaadde000) |
|
|
91 | libdl.so.2 => /lib/libdl.so.2 (0x00002aaaab01d000) |
|
|
92 | /lib64/ld-linux-x86-64.so.2 (0x00002aaaaaaab000) |
|
|
93 | |
|
|
94 | And here is rxvt-unicode: |
|
|
95 | |
|
|
96 | libX11.so.6 => /usr/X11R6/lib/libX11.so.6 (0x00002aaaaabc3000) |
|
|
97 | libgcc_s.so.1 => /lib/libgcc_s.so.1 (0x00002aaaaada2000) |
|
|
98 | libc.so.6 => /lib/libc.so.6 (0x00002aaaaaeb0000) |
|
|
99 | libdl.so.2 => /lib/libdl.so.2 (0x00002aaaab0ee000) |
|
|
100 | /lib64/ld-linux-x86-64.so.2 (0x00002aaaaaaab000) |
|
|
101 | |
|
|
102 | No large bloated libraries (of course, none were linked in statically), |
|
|
103 | except maybe libX11 :) |
|
|
104 | |
|
|
105 | =item Does it support tabs, can I have a tabbed rxvt-unicode? |
|
|
106 | |
|
|
107 | rxvt-unicode does not directly support tabs. It will work fine with |
|
|
108 | tabbing functionality of many window managers or similar tabbing programs, |
|
|
109 | and its embedding-features allow it to be embedded into other programs, |
|
|
110 | as witnessed by F<doc/rxvt-tabbed> or the upcoming C<Gtk2::URxvt> perl |
|
|
111 | module, which features a tabbed urxvt (murxvt) terminal as an example |
|
|
112 | embedding application. |
|
|
113 | |
|
|
114 | =item How do I know which rxvt-unicode version I'm using? |
|
|
115 | |
|
|
116 | The version number is displayed with the usage (-h). Also the escape |
|
|
117 | sequence C<ESC [ 8 n> sets the window title to the version number. When |
|
|
118 | using the @@RXVT_NAME@@c client, the version displayed is that of the |
|
|
119 | daemon. |
|
|
120 | |
|
|
121 | =item I am using Debian GNU/Linux and have a problem... |
|
|
122 | |
|
|
123 | The Debian GNU/Linux package of rxvt-unicode in sarge contains large |
|
|
124 | patches that considerably change the behaviour of rxvt-unicode. Before |
|
|
125 | reporting a bug to the original rxvt-unicode author please download and |
|
|
126 | install the genuine version (L<http://software.schmorp.de#rxvt-unicode>) |
|
|
127 | and try to reproduce the problem. If you cannot, chances are that the |
|
|
128 | problems are specific to Debian GNU/Linux, in which case it should be |
|
|
129 | reported via the Debian Bug Tracking System (use C<reportbug> to report |
|
|
130 | the bug). |
|
|
131 | |
|
|
132 | For other problems that also affect the Debian package, you can and |
|
|
133 | probably should use the Debian BTS, too, because, after all, it's also a |
|
|
134 | bug in the Debian version and it serves as a reminder for other users that |
|
|
135 | might encounter the same issue. |
|
|
136 | |
|
|
137 | =item When I log-in to another system it tells me about missing terminfo data? |
|
|
138 | |
|
|
139 | The terminal description used by rxvt-unicode is not as widely available |
|
|
140 | as that for xterm, or even rxvt (for which the same problem often arises). |
|
|
141 | |
|
|
142 | The correct solution for this problem is to install the terminfo, this can |
|
|
143 | be done like this (with ncurses' infocmp): |
|
|
144 | |
|
|
145 | REMOTE=remotesystem.domain |
|
|
146 | infocmp rxvt-unicode | ssh $REMOTE "cat >/tmp/ti && tic /tmp/ti" |
|
|
147 | |
|
|
148 | ... or by installing rxvt-unicode normally on the remote system, |
|
|
149 | |
|
|
150 | If you cannot or do not want to do this, then you can simply set |
|
|
151 | C<TERM=rxvt> or even C<TERM=xterm>, and live with the small number of |
|
|
152 | problems arising, which includes wrong keymapping, less and different |
|
|
153 | colours and some refresh errors in fullscreen applications. It's a nice |
|
|
154 | quick-and-dirty workaround for rare cases, though. |
|
|
155 | |
|
|
156 | If you always want to do this (and are fine with the consequences) you |
|
|
157 | can either recompile rxvt-unicode with the desired TERM value or use a |
|
|
158 | resource to set it: |
|
|
159 | |
|
|
160 | URxvt.termName: rxvt |
|
|
161 | |
|
|
162 | If you don't plan to use B<rxvt> (quite common...) you could also replace |
|
|
163 | the rxvt terminfo file with the rxvt-unicode one. |
|
|
164 | |
|
|
165 | =item C<tic> outputs some error when compiling the terminfo entry. |
|
|
166 | |
|
|
167 | Most likely it's the empty definition for C<enacs=>. Just replace it by |
|
|
168 | C<enacs=\E[0@> and try again. |
|
|
169 | |
|
|
170 | =item C<bash>'s readline does not work correctly under @@RXVT_NAME@@. |
|
|
171 | |
|
|
172 | =item I need a termcap file entry. |
|
|
173 | |
|
|
174 | One reason you might want this is that some distributions or operating |
|
|
175 | systems still compile some programs using the long-obsoleted termcap |
|
|
176 | library (Fedora Core's bash is one example) and rely on a termcap entry |
|
|
177 | for C<rxvt-unicode>. |
|
|
178 | |
|
|
179 | You could use rxvt's termcap entry with resonable results in many cases. |
|
|
180 | You can also create a termcap entry by using terminfo's infocmp program |
|
|
181 | like this: |
|
|
182 | |
|
|
183 | infocmp -C rxvt-unicode |
|
|
184 | |
|
|
185 | Or you could use this termcap entry, generated by the command above: |
|
|
186 | |
|
|
187 | rxvt-unicode|rxvt-unicode terminal (X Window System):\ |
|
|
188 | :am:bw:eo:km:mi:ms:xn:xo:\ |
|
|
189 | :co#80:it#8:li#24:lm#0:\ |
|
|
190 | :AL=\E[%dL:DC=\E[%dP:DL=\E[%dM:DO=\E[%dB:IC=\E[%d@:\ |
|
|
191 | :K1=\EOw:K2=\EOu:K3=\EOy:K4=\EOq:K5=\EOs:LE=\E[%dD:\ |
|
|
192 | :RI=\E[%dC:SF=\E[%dS:SR=\E[%dT:UP=\E[%dA:ae=\E(B:al=\E[L:\ |
|
|
193 | :as=\E(0:bl=^G:cd=\E[J:ce=\E[K:cl=\E[H\E[2J:\ |
|
|
194 | :cm=\E[%i%d;%dH:cr=^M:cs=\E[%i%d;%dr:ct=\E[3g:dc=\E[P:\ |
|
|
195 | :dl=\E[M:do=^J:ec=\E[%dX:ei=\E[4l:ho=\E[H:\ |
|
|
196 | :i1=\E[?47l\E=\E[?1l:ic=\E[@:im=\E[4h:\ |
|
|
197 | :is=\E[r\E[m\E[2J\E[H\E[?7h\E[?1;3;4;6l\E[4l:\ |
|
|
198 | :k1=\E[11~:k2=\E[12~:k3=\E[13~:k4=\E[14~:k5=\E[15~:\ |
|
|
199 | :k6=\E[17~:k7=\E[18~:k8=\E[19~:k9=\E[20~:kD=\E[3~:\ |
|
|
200 | :kI=\E[2~:kN=\E[6~:kP=\E[5~:kb=\177:kd=\EOB:ke=\E[?1l\E>:\ |
|
|
201 | :kh=\E[7~:kl=\EOD:kr=\EOC:ks=\E[?1h\E=:ku=\EOA:le=^H:\ |
|
|
202 | :mb=\E[5m:md=\E[1m:me=\E[m\017:mr=\E[7m:nd=\E[C:rc=\E8:\ |
|
|
203 | :sc=\E7:se=\E[27m:sf=^J:so=\E[7m:sr=\EM:st=\EH:ta=^I:\ |
|
|
204 | :te=\E[r\E[?1049l:ti=\E[?1049h:ue=\E[24m:up=\E[A:\ |
|
|
205 | :us=\E[4m:vb=\E[?5h\E[?5l:ve=\E[?25h:vi=\E[?25l:\ |
|
|
206 | :vs=\E[?25h: |
|
|
207 | |
|
|
208 | =item Why does C<ls> no longer have coloured output? |
|
|
209 | |
|
|
210 | The C<ls> in the GNU coreutils unfortunately doesn't use terminfo to |
|
|
211 | decide wether a terminal has colour, but uses it's own configuration |
|
|
212 | file. Needless to say, C<rxvt-unicode> is not in it's default file (among |
|
|
213 | with most other terminals supporting colour). Either add: |
|
|
214 | |
|
|
215 | TERM rxvt-unicode |
|
|
216 | |
|
|
217 | to C</etc/DIR_COLORS> or simply add: |
|
|
218 | |
|
|
219 | alias ls='ls --color=auto' |
|
|
220 | |
|
|
221 | to your C<.profile> or C<.bashrc>. |
|
|
222 | |
|
|
223 | =item Why doesn't vim/emacs etc. use the 88 colour mode? |
|
|
224 | |
|
|
225 | =item Why doesn't vim/emacs etc. make use of italic? |
|
|
226 | |
|
|
227 | =item Why are the secondary screen-related options not working properly? |
|
|
228 | |
|
|
229 | Make sure you are using C<TERM=rxvt-unicode>. Some pre-packaged |
|
|
230 | distributions (most notably Debian GNU/Linux) break rxvt-unicode |
|
|
231 | by setting C<TERM> to C<rxvt>, which doesn't have these extra |
|
|
232 | features. Unfortunately, some of these (most notably, again, Debian |
|
|
233 | GNU/Linux) furthermore fail to even install the C<rxvt-unicode> terminfo |
|
|
234 | file, so you will need to install it on your own (See the question B<When |
|
|
235 | I log-in to another system it tells me about missing terminfo data?> on |
|
|
236 | how to do this). |
|
|
237 | |
|
|
238 | =item My numerical keypad acts weird and generates differing output? |
|
|
239 | |
|
|
240 | Some Debian GNUL/Linux users seem to have this problem, although no |
|
|
241 | specific details were reported so far. It is possible that this is caused |
|
|
242 | by the wrong C<TERM> setting, although the details of wether and how |
|
|
243 | this can happen are unknown, as C<TERM=rxvt> should offer a compatible |
|
|
244 | keymap. See the answer to the previous question, and please report if that |
|
|
245 | helped. |
|
|
246 | |
|
|
247 | =item Rxvt-unicode does not seem to understand the selected encoding? |
|
|
248 | |
|
|
249 | =item Unicode does not seem to work? |
|
|
250 | |
|
|
251 | If you encounter strange problems like typing an accented character but |
|
|
252 | getting two unrelated other characters or similar, or if program output is |
|
|
253 | subtly garbled, then you should check your locale settings. |
|
|
254 | |
|
|
255 | Rxvt-unicode must be started with the same C<LC_CTYPE> setting as the |
|
|
256 | programs. Often rxvt-unicode is started in the C<C> locale, while the |
|
|
257 | login script running within the rxvt-unicode window changes the locale to |
|
|
258 | something else, e.g. C<en_GB.UTF-8>. Needless to say, this is not going to work. |
|
|
259 | |
|
|
260 | The best thing is to fix your startup environment, as you will likely run |
|
|
261 | into other problems. If nothing works you can try this in your .profile. |
|
|
262 | |
|
|
263 | printf '\e]701;%s\007' "$LC_CTYPE" |
|
|
264 | |
|
|
265 | If this doesn't work, then maybe you use a C<LC_CTYPE> specification not |
|
|
266 | supported on your systems. Some systems have a C<locale> command which |
|
|
267 | displays this (also, C<perl -e0> can be used to check locale settings, as |
|
|
268 | it will complain loudly if it cannot set the locale). If it displays something |
|
|
269 | like: |
|
|
270 | |
|
|
271 | locale: Cannot set LC_CTYPE to default locale: ... |
|
|
272 | |
|
|
273 | Then the locale you specified is not supported on your system. |
|
|
274 | |
|
|
275 | If nothing works and you are sure that everything is set correctly then |
|
|
276 | you will need to remember a little known fact: Some programs just don't |
|
|
277 | support locales :( |
|
|
278 | |
|
|
279 | =item Why do some characters look so much different than others? |
|
|
280 | |
|
|
281 | =item How does rxvt-unicode choose fonts? |
|
|
282 | |
|
|
283 | Most fonts do not contain the full range of Unicode, which is |
|
|
284 | fine. Chances are that the font you (or the admin/package maintainer of |
|
|
285 | your system/os) have specified does not cover all the characters you want |
|
|
286 | to display. |
|
|
287 | |
|
|
288 | B<rxvt-unicode> makes a best-effort try at finding a replacement |
|
|
289 | font. Often the result is fine, but sometimes the chosen font looks |
|
|
290 | bad/ugly/wrong. Some fonts have totally strange characters that don't |
|
|
291 | resemble the correct glyph at all, and rxvt-unicode lacks the artificial |
|
|
292 | intelligence to detect that a specific glyph is wrong: it has to believe |
|
|
293 | the font that the characters it claims to contain indeed look correct. |
|
|
294 | |
|
|
295 | In that case, select a font of your taste and add it to the font list, |
|
|
296 | e.g.: |
|
|
297 | |
|
|
298 | @@RXVT_NAME@@ -fn basefont,font2,font3... |
|
|
299 | |
|
|
300 | When rxvt-unicode sees a character, it will first look at the base |
|
|
301 | font. If the base font does not contain the character, it will go to the |
|
|
302 | next font, and so on. Specifying your own fonts will also speed up this |
|
|
303 | search and use less resources within rxvt-unicode and the X-server. |
|
|
304 | |
|
|
305 | The only limitation is that none of the fonts may be larger than the base |
|
|
306 | font, as the base font defines the terminal character cell size, which |
|
|
307 | must be the same due to the way terminals work. |
|
|
308 | |
|
|
309 | =item Why do some chinese characters look so different than others? |
|
|
310 | |
|
|
311 | This is because there is a difference between script and language -- |
|
|
312 | rxvt-unicode does not know which language the text that is output is, |
|
|
313 | as it only knows the unicode character codes. If rxvt-unicode first |
|
|
314 | sees a japanese/chinese character, it might choose a japanese font for |
|
|
315 | display. Subsequent japanese characters will use that font. Now, many |
|
|
316 | chinese characters aren't represented in japanese fonts, so when the first |
|
|
317 | non-japanese character comes up, rxvt-unicode will look for a chinese font |
|
|
318 | -- unfortunately at this point, it will still use the japanese font for |
|
|
319 | chinese characters that are also in the japanese font. |
|
|
320 | |
|
|
321 | The workaround is easy: just tag a chinese font at the end of your font |
|
|
322 | list (see the previous question). The key is to view the font list as |
|
|
323 | a preference list: If you expect more japanese, list a japanese font |
|
|
324 | first. If you expect more chinese, put a chinese font first. |
|
|
325 | |
|
|
326 | In the future it might be possible to switch language preferences at |
|
|
327 | runtime (the internal data structure has no problem with using different |
|
|
328 | fonts for the same character at the same time, but no interface for this |
|
|
329 | has been designed yet). |
|
|
330 | |
|
|
331 | Until then, you might get away with switching fonts at runtime (see L<Can |
|
|
332 | I switch the fonts at runtime?> later in this document). |
|
|
333 | |
|
|
334 | =item Why does rxvt-unicode sometimes leave pixel droppings? |
|
|
335 | |
|
|
336 | Most fonts were not designed for terminal use, which means that character |
|
|
337 | size varies a lot. A font that is otherwise fine for terminal use might |
|
|
338 | contain some characters that are simply too wide. Rxvt-unicode will avoid |
|
|
339 | these characters. For characters that are just "a bit" too wide a special |
|
|
340 | "careful" rendering mode is used that redraws adjacent characters. |
|
|
341 | |
|
|
342 | All of this requires that fonts do not lie about character sizes, |
|
|
343 | however: Xft fonts often draw glyphs larger than their acclaimed bounding |
|
|
344 | box, and rxvt-unicode has no way of detecting this (the correct way is to |
|
|
345 | ask for the character bounding box, which unfortunately is wrong in these |
|
|
346 | cases). |
|
|
347 | |
|
|
348 | It's not clear (to me at least), wether this is a bug in Xft, freetype, |
|
|
349 | or the respective font. If you encounter this problem you might try using |
|
|
350 | the C<-lsp> option to give the font more height. If that doesn't work, you |
|
|
351 | might be forced to use a different font. |
|
|
352 | |
|
|
353 | All of this is not a problem when using X11 core fonts, as their bounding |
|
|
354 | box data is correct. |
|
|
355 | |
|
|
356 | =item On Solaris 9, many line-drawing characters are too wide. |
|
|
357 | |
|
|
358 | Seems to be a known bug, read |
|
|
359 | L<http://nixdoc.net/files/forum/about34198.html>. Some people use the |
|
|
360 | following ugly workaround to get non-double-wide-characters working: |
|
|
361 | |
|
|
362 | #define wcwidth(x) wcwidth(x) > 1 ? 1 : wcwidth(x) |
|
|
363 | |
|
|
364 | =item My Compose (Multi_key) key is no longer working. |
|
|
365 | |
|
|
366 | The most common causes for this are that either your locale is not set |
|
|
367 | correctly, or you specified a B<preeditStyle> that is not supported by |
|
|
368 | your input method. For example, if you specified B<OverTheSpot> and |
|
|
369 | your input method (e.g. the default input method handling Compose keys) |
|
|
370 | does not support this (for instance because it is not visual), then |
|
|
371 | rxvt-unicode will continue without an input method. |
|
|
372 | |
|
|
373 | In this case either do not specify a B<preeditStyle> or specify more than |
|
|
374 | one pre-edit style, such as B<OverTheSpot,Root,None>. |
|
|
375 | |
|
|
376 | =item I cannot type C<Ctrl-Shift-2> to get an ASCII NUL character due to ISO 14755 |
|
|
377 | |
|
|
378 | Either try C<Ctrl-2> alone (it often is mapped to ASCII NUL even on |
|
|
379 | international keyboards) or simply use ISO 14755 support to your |
|
|
380 | advantage, typing <Ctrl-Shift-0> to get a ASCII NUL. This works for other |
|
|
381 | codes, too, such as C<Ctrl-Shift-1-d> to type the default telnet escape |
|
|
382 | character and so on. |
|
|
383 | |
|
|
384 | =item How can I keep rxvt-unicode from using reverse video so much? |
|
|
385 | |
|
|
386 | First of all, make sure you are running with the right terminal settings |
|
|
387 | (C<TERM=rxvt-unicode>), which will get rid of most of these effects. Then |
|
|
388 | make sure you have specified colours for italic and bold, as otherwise |
|
|
389 | rxvt-unicode might use reverse video to simulate the effect: |
|
|
390 | |
|
|
391 | URxvt.colorBD: white |
|
|
392 | URxvt.colorIT: green |
|
|
393 | |
|
|
394 | =item Some programs assume totally weird colours (red instead of blue), how can I fix that? |
|
|
395 | |
|
|
396 | For some unexplainable reason, some rare programs assume a very weird |
|
|
397 | colour palette when confronted with a terminal with more than the standard |
|
|
398 | 8 colours (rxvt-unicode supports 88). The right fix is, of course, to fix |
|
|
399 | these programs not to assume non-ISO colours without very good reasons. |
|
|
400 | |
|
|
401 | In the meantime, you can either edit your C<rxvt-unicode> terminfo |
|
|
402 | definition to only claim 8 colour support or use C<TERM=rxvt>, which will |
|
|
403 | fix colours but keep you from using other rxvt-unicode features. |
|
|
404 | |
|
|
405 | =item I am on FreeBSD and rxvt-unicode does not seem to work at all. |
|
|
406 | |
|
|
407 | Rxvt-unicode requires the symbol C<__STDC_ISO_10646__> to be defined |
|
|
408 | in your compile environment, or an implementation that implements it, |
|
|
409 | wether it defines the symbol or not. C<__STDC_ISO_10646__> requires that |
|
|
410 | B<wchar_t> is represented as unicode. |
|
|
411 | |
|
|
412 | As you might have guessed, FreeBSD does neither define this symobl nor |
|
|
413 | does it support it. Instead, it uses it's own internal representation of |
|
|
414 | B<wchar_t>. This is, of course, completely fine with respect to standards. |
|
|
415 | |
|
|
416 | However, that means rxvt-unicode only works in C<POSIX>, C<ISO-8859-1> and |
|
|
417 | C<UTF-8> locales under FreeBSD (which all use Unicode as B<wchar_t>. |
|
|
418 | |
|
|
419 | C<__STDC_ISO_10646__> is the only sane way to support multi-language |
|
|
420 | apps in an OS, as using a locale-dependent (and non-standardized) |
|
|
421 | representation of B<wchar_t> makes it impossible to convert between |
|
|
422 | B<wchar_t> (as used by X11 and your applications) and any other encoding |
|
|
423 | without implementing OS-specific-wrappers for each and every locale. There |
|
|
424 | simply are no APIs to convert B<wchar_t> into anything except the current |
|
|
425 | locale encoding. |
|
|
426 | |
|
|
427 | Some applications (such as the formidable B<mlterm>) work around this |
|
|
428 | by carrying their own replacement functions for character set handling |
|
|
429 | with them, and either implementing OS-dependent hacks or doing multiple |
|
|
430 | conversions (which is slow and unreliable in case the OS implements |
|
|
431 | encodings slightly different than the terminal emulator). |
|
|
432 | |
|
|
433 | The rxvt-unicode author insists that the right way to fix this is in the |
|
|
434 | system libraries once and for all, instead of forcing every app to carry |
|
|
435 | complete replacements for them :) |
|
|
436 | |
|
|
437 | =item I use Solaris 9 and it doesn't compile/work/etc. |
|
|
438 | |
|
|
439 | Try the diff in F<doc/solaris9.patch> as a base. It fixes the worst |
|
|
440 | problems with C<wcwidth> and a compile problem. |
|
|
441 | |
|
|
442 | =item How can I use rxvt-unicode under cygwin? |
|
|
443 | |
|
|
444 | rxvt-unicode should compile and run out of the box on cygwin, using |
|
|
445 | the X11 libraries that come with cygwin. libW11 emulation is no |
|
|
446 | longer supported (and makes no sense, either, as it only supported a |
|
|
447 | single font). I recommend starting the X-server in C<-multiwindow> or |
|
|
448 | C<-rootless> mode instead, which will result in similar look&feel as the |
|
|
449 | old libW11 emulation. |
|
|
450 | |
|
|
451 | At the time of this writing, cygwin didn't seem to support any multi-byte |
|
|
452 | encodings (you might try C<LC_CTYPE=C-UTF-8>), so you are likely limited |
|
|
453 | to 8-bit encodings. |
|
|
454 | |
|
|
455 | =item How does rxvt-unicode determine the encoding to use? |
|
|
456 | |
|
|
457 | =item Is there an option to switch encodings? |
|
|
458 | |
|
|
459 | Unlike some other terminals, rxvt-unicode has no encoding switch, and no |
|
|
460 | specific "utf-8" mode, such as xterm. In fact, it doesn't even know about |
|
|
461 | UTF-8 or any other encodings with respect to terminal I/O. |
|
|
462 | |
|
|
463 | The reasons is that there exists a perfectly fine mechanism for selecting |
|
|
464 | the encoding, doing I/O and (most important) communicating this to all |
|
|
465 | applications so everybody agrees on character properties such as width |
|
|
466 | and code number. This mechanism is the I<locale>. Applications not using |
|
|
467 | that info will have problems (for example, C<xterm> gets the width of |
|
|
468 | characters wrong as it uses it's own, locale-independent table under all |
|
|
469 | locales). |
|
|
470 | |
|
|
471 | Rxvt-unicode uses the C<LC_CTYPE> locale category to select encoding. All |
|
|
472 | programs doing the same (that is, most) will automatically agree in the |
|
|
473 | interpretation of characters. |
|
|
474 | |
|
|
475 | Unfortunately, there is no system-independent way to select locales, nor |
|
|
476 | is there a standard on how locale specifiers will look like. |
|
|
477 | |
|
|
478 | On most systems, the content of the C<LC_CTYPE> environment variable |
|
|
479 | contains an arbitrary string which corresponds to an already-installed |
|
|
480 | locale. Common names for locales are C<en_US.UTF-8>, C<de_DE.ISO-8859-15>, |
|
|
481 | C<ja_JP.EUC-JP>, i.e. C<language_country.encoding>, but other forms |
|
|
482 | (i.e. C<de> or C<german>) are also common. |
|
|
483 | |
|
|
484 | Rxvt-unicode ignores all other locale categories, and except for |
|
|
485 | the encoding, ignores country or language-specific settings, |
|
|
486 | i.e. C<de_DE.UTF-8> and C<ja_JP.UTF-8> are the normally same to |
|
|
487 | rxvt-unicode. |
|
|
488 | |
|
|
489 | If you want to use a specific encoding you have to make sure you start |
|
|
490 | rxvt-unicode with the correct C<LC_CTYPE> category. |
|
|
491 | |
|
|
492 | =item Can I switch locales at runtime? |
|
|
493 | |
|
|
494 | Yes, using an escape sequence. Try something like this, which sets |
|
|
495 | rxvt-unicode's idea of C<LC_CTYPE>. |
|
|
496 | |
|
|
497 | printf '\e]701;%s\007' ja_JP.SJIS |
|
|
498 | |
|
|
499 | See also the previous answer. |
|
|
500 | |
|
|
501 | Sometimes this capability is rather handy when you want to work in |
|
|
502 | one locale (e.g. C<de_DE.UTF-8>) but some programs don't support it |
|
|
503 | (e.g. UTF-8). For example, I use this script to start C<xjdic>, which |
|
|
504 | first switches to a locale supported by xjdic and back later: |
|
|
505 | |
|
|
506 | printf '\e]701;%s\007' ja_JP.SJIS |
|
|
507 | xjdic -js |
|
|
508 | printf '\e]701;%s\007' de_DE.UTF-8 |
|
|
509 | |
|
|
510 | You can also use xterm's C<luit> program, which usually works fine, except |
|
|
511 | for some locales where character width differs between program- and |
|
|
512 | rxvt-unicode-locales. |
|
|
513 | |
|
|
514 | =item Can I switch the fonts at runtime? |
|
|
515 | |
|
|
516 | Yes, using an escape sequence. Try something like this, which has the same |
|
|
517 | effect as using the C<-fn> switch, and takes effect immediately: |
|
|
518 | |
|
|
519 | printf '\e]50;%s\007' "9x15bold,xft:Kochi Gothic" |
|
|
520 | |
|
|
521 | This is useful if you e.g. work primarily with japanese (and prefer a |
|
|
522 | japanese font), but you have to switch to chinese temporarily, where |
|
|
523 | japanese fonts would only be in your way. |
|
|
524 | |
|
|
525 | You can think of this as a kind of manual ISO-2022 switching. |
|
|
526 | |
|
|
527 | =item Why do italic characters look as if clipped? |
|
|
528 | |
|
|
529 | Many fonts have difficulties with italic characters and hinting. For |
|
|
530 | example, the otherwise very nicely hinted font C<xft:Bitstream Vera Sans |
|
|
531 | Mono> completely fails in it's italic face. A workaround might be to |
|
|
532 | enable freetype autohinting, i.e. like this: |
|
|
533 | |
|
|
534 | URxvt.italicFont: xft:Bitstream Vera Sans Mono:italic:autohint=true |
|
|
535 | URxvt.boldItalicFont: xft:Bitstream Vera Sans Mono:bold:italic:autohint=true |
|
|
536 | |
|
|
537 | =item My input method wants <some encoding> but I want UTF-8, what can I do? |
|
|
538 | |
|
|
539 | You can specify separate locales for the input method and the rest of the |
|
|
540 | terminal, using the resource C<imlocale>: |
|
|
541 | |
|
|
542 | URxvt*imlocale: ja_JP.EUC-JP |
|
|
543 | |
|
|
544 | Now you can start your terminal with C<LC_CTYPE=ja_JP.UTF-8> and still |
|
|
545 | use your input method. Please note, however, that you will not be able to |
|
|
546 | input characters outside C<EUC-JP> in a normal way then, as your input |
|
|
547 | method limits you. |
|
|
548 | |
|
|
549 | =item Rxvt-unicode crashes when the X Input Method changes or exits. |
|
|
550 | |
|
|
551 | Unfortunately, this is unavoidable, as the XIM protocol is racy by |
|
|
552 | design. Applications can avoid some crashes at the expense of memory |
|
|
553 | leaks, and Input Methods can avoid some crashes by careful ordering at |
|
|
554 | exit time. B<kinput2> (and derived input methods) generally succeeds, |
|
|
555 | while B<SCIM> (or similar input methods) fails. In the end, however, |
|
|
556 | crashes cannot be completely avoided even if both sides cooperate. |
|
|
557 | |
|
|
558 | So the only workaround is not to kill your Input Method Servers. |
|
|
559 | |
|
|
560 | =item Rxvt-unicode uses gobs of memory, how can I reduce that? |
|
|
561 | |
|
|
562 | Rxvt-unicode tries to obey the rule of not charging you for something you |
|
|
563 | don't use. One thing you should try is to configure out all settings that |
|
|
564 | you don't need, for example, Xft support is a resource hog by design, |
|
|
565 | when used. Compiling it out ensures that no Xft font will be loaded |
|
|
566 | accidentally when rxvt-unicode tries to find a font for your characters. |
|
|
567 | |
|
|
568 | Also, many people (me included) like large windows and even larger |
|
|
569 | scrollback buffers: Without C<--enable-unicode3>, rxvt-unicode will use |
|
|
570 | 6 bytes per screen cell. For a 160x?? window this amounts to almost a |
|
|
571 | kilobyte per line. A scrollback buffer of 10000 lines will then (if full) |
|
|
572 | use 10 Megabytes of memory. With C<--enable-unicode3> it gets worse, as |
|
|
573 | rxvt-unicode then uses 8 bytes per screen cell. |
|
|
574 | |
|
|
575 | =item Can I speed up Xft rendering somehow? |
|
|
576 | |
|
|
577 | Yes, the most obvious way to speed it up is to avoid Xft entirely, as |
|
|
578 | it is simply slow. If you still want Xft fonts you might try to disable |
|
|
579 | antialiasing (by appending C<:antialias=false>), which saves lots of |
|
|
580 | memory and also speeds up rendering considerably. |
|
|
581 | |
|
|
582 | =item Rxvt-unicode doesn't seem to anti-alias its fonts, what is wrong? |
|
|
583 | |
|
|
584 | Rxvt-unicode will use whatever you specify as a font. If it needs to |
|
|
585 | fall back to it's default font search list it will prefer X11 core |
|
|
586 | fonts, because they are small and fast, and then use Xft fonts. It has |
|
|
587 | antialiasing disabled for most of them, because the author thinks they |
|
|
588 | look best that way. |
|
|
589 | |
|
|
590 | If you want antialiasing, you have to specify the fonts manually. |
|
|
591 | |
|
|
592 | =item Mouse cut/paste suddenly no longer works. |
|
|
593 | |
|
|
594 | Make sure that mouse reporting is actually turned off since killing |
|
|
595 | some editors prematurely may leave the mouse in mouse report mode. I've |
|
|
596 | heard that tcsh may use mouse reporting unless it otherwise specified. A |
|
|
597 | quick check is to see if cut/paste works when the Alt or Shift keys are |
|
|
598 | depressed. See @@RXVT_NAME@@(7) |
|
|
599 | |
|
|
600 | =item What's with this bold/blink stuff? |
|
|
601 | |
|
|
602 | If no bold colour is set via C<colorBD:>, bold will invert text using the |
|
|
603 | standard foreground colour. |
|
|
604 | |
|
|
605 | For the standard background colour, blinking will actually make the |
|
|
606 | text blink when compiled with C<--enable-blinking>. with standard |
|
|
607 | colours. Without C<--enable-blinking>, the blink attribute will be |
|
|
608 | ignored. |
|
|
609 | |
|
|
610 | On ANSI colours, bold/blink attributes are used to set high-intensity |
|
|
611 | foreground/background colors. |
|
|
612 | |
|
|
613 | color0-7 are the low-intensity colors. |
|
|
614 | |
|
|
615 | color8-15 are the corresponding high-intensity colors. |
|
|
616 | |
|
|
617 | =item I don't like the screen colors. How do I change them? |
|
|
618 | |
|
|
619 | You can change the screen colors at run-time using F<~/.Xdefaults> |
|
|
620 | resources (or as long-options). |
|
|
621 | |
|
|
622 | Here are values that are supposed to resemble a VGA screen, |
|
|
623 | including the murky brown that passes for low-intensity yellow: |
|
|
624 | |
|
|
625 | URxvt.color0: #000000 |
|
|
626 | URxvt.color1: #A80000 |
|
|
627 | URxvt.color2: #00A800 |
|
|
628 | URxvt.color3: #A8A800 |
|
|
629 | URxvt.color4: #0000A8 |
|
|
630 | URxvt.color5: #A800A8 |
|
|
631 | URxvt.color6: #00A8A8 |
|
|
632 | URxvt.color7: #A8A8A8 |
|
|
633 | |
|
|
634 | URxvt.color8: #000054 |
|
|
635 | URxvt.color9: #FF0054 |
|
|
636 | URxvt.color10: #00FF54 |
|
|
637 | URxvt.color11: #FFFF54 |
|
|
638 | URxvt.color12: #0000FF |
|
|
639 | URxvt.color13: #FF00FF |
|
|
640 | URxvt.color14: #00FFFF |
|
|
641 | URxvt.color15: #FFFFFF |
|
|
642 | |
|
|
643 | And here is a more complete set of non-standard colors described (not by |
|
|
644 | me) as "pretty girly". |
|
|
645 | |
|
|
646 | URxvt.cursorColor: #dc74d1 |
|
|
647 | URxvt.pointerColor: #dc74d1 |
|
|
648 | URxvt.background: #0e0e0e |
|
|
649 | URxvt.foreground: #4ad5e1 |
|
|
650 | URxvt.color0: #000000 |
|
|
651 | URxvt.color8: #8b8f93 |
|
|
652 | URxvt.color1: #dc74d1 |
|
|
653 | URxvt.color9: #dc74d1 |
|
|
654 | URxvt.color2: #0eb8c7 |
|
|
655 | URxvt.color10: #0eb8c7 |
|
|
656 | URxvt.color3: #dfe37e |
|
|
657 | URxvt.color11: #dfe37e |
|
|
658 | URxvt.color5: #9e88f0 |
|
|
659 | URxvt.color13: #9e88f0 |
|
|
660 | URxvt.color6: #73f7ff |
|
|
661 | URxvt.color14: #73f7ff |
|
|
662 | URxvt.color7: #e1dddd |
|
|
663 | URxvt.color15: #e1dddd |
|
|
664 | |
|
|
665 | =item How can I start @@RXVT_NAME@@d in a race-free way? |
|
|
666 | |
|
|
667 | Try C<@@RXVT_NAME@@d -f -o>, which tells @@RXVT_NAME@@d to open the |
|
|
668 | display, create the listening socket and then fork. |
|
|
669 | |
|
|
670 | =item What's with the strange Backspace/Delete key behaviour? |
|
|
671 | |
|
|
672 | Assuming that the physical Backspace key corresponds to the |
|
|
673 | BackSpace keysym (not likely for Linux ... see the following |
|
|
674 | question) there are two standard values that can be used for |
|
|
675 | Backspace: C<^H> and C<^?>. |
|
|
676 | |
|
|
677 | Historically, either value is correct, but rxvt-unicode adopts the debian |
|
|
678 | policy of using C<^?> when unsure, because it's the one only only correct |
|
|
679 | choice :). |
|
|
680 | |
|
|
681 | Rxvt-unicode tries to inherit the current stty settings and uses the value |
|
|
682 | of `erase' to guess the value for backspace. If rxvt-unicode wasn't |
|
|
683 | started from a terminal (say, from a menu or by remote shell), then the |
|
|
684 | system value of `erase', which corresponds to CERASE in <termios.h>, will |
|
|
685 | be used (which may not be the same as your stty setting). |
|
|
686 | |
|
|
687 | For starting a new rxvt-unicode: |
|
|
688 | |
|
|
689 | # use Backspace = ^H |
|
|
690 | $ stty erase ^H |
|
|
691 | $ @@RXVT_NAME@@ |
|
|
692 | |
|
|
693 | # use Backspace = ^? |
|
|
694 | $ stty erase ^? |
|
|
695 | $ @@RXVT_NAME@@ |
|
|
696 | |
|
|
697 | Toggle with C<ESC [ 36 h> / C<ESC [ 36 l> as documented in @@RXVT_NAME@@(7). |
|
|
698 | |
|
|
699 | For an existing rxvt-unicode: |
|
|
700 | |
|
|
701 | # use Backspace = ^H |
|
|
702 | $ stty erase ^H |
|
|
703 | $ echo -n "^[[36h" |
|
|
704 | |
|
|
705 | # use Backspace = ^? |
|
|
706 | $ stty erase ^? |
|
|
707 | $ echo -n "^[[36l" |
|
|
708 | |
|
|
709 | This helps satisfy some of the Backspace discrepancies that occur, but |
|
|
710 | if you use Backspace = C<^H>, make sure that the termcap/terminfo value |
|
|
711 | properly reflects that. |
|
|
712 | |
|
|
713 | The Delete key is a another casualty of the ill-defined Backspace problem. |
|
|
714 | To avoid confusion between the Backspace and Delete keys, the Delete |
|
|
715 | key has been assigned an escape sequence to match the vt100 for Execute |
|
|
716 | (C<ESC [ 3 ~>) and is in the supplied termcap/terminfo. |
|
|
717 | |
|
|
718 | Some other Backspace problems: |
|
|
719 | |
|
|
720 | some editors use termcap/terminfo, |
|
|
721 | some editors (vim I'm told) expect Backspace = ^H, |
|
|
722 | GNU Emacs (and Emacs-like editors) use ^H for help. |
|
|
723 | |
|
|
724 | Perhaps someday this will all be resolved in a consistent manner. |
|
|
725 | |
|
|
726 | =item I don't like the key-bindings. How do I change them? |
|
|
727 | |
|
|
728 | There are some compile-time selections available via configure. Unless |
|
|
729 | you have run "configure" with the C<--disable-resources> option you can |
|
|
730 | use the `keysym' resource to alter the keystrings associated with keysyms. |
|
|
731 | |
|
|
732 | Here's an example for a URxvt session started using C<@@RXVT_NAME@@ -name URxvt> |
|
|
733 | |
|
|
734 | URxvt.keysym.Home: \033[1~ |
|
|
735 | URxvt.keysym.End: \033[4~ |
|
|
736 | URxvt.keysym.C-apostrophe: \033<C-'> |
|
|
737 | URxvt.keysym.C-slash: \033<C-/> |
|
|
738 | URxvt.keysym.C-semicolon: \033<C-;> |
|
|
739 | URxvt.keysym.C-grave: \033<C-`> |
|
|
740 | URxvt.keysym.C-comma: \033<C-,> |
|
|
741 | URxvt.keysym.C-period: \033<C-.> |
|
|
742 | URxvt.keysym.C-0x60: \033<C-`> |
|
|
743 | URxvt.keysym.C-Tab: \033<C-Tab> |
|
|
744 | URxvt.keysym.C-Return: \033<C-Return> |
|
|
745 | URxvt.keysym.S-Return: \033<S-Return> |
|
|
746 | URxvt.keysym.S-space: \033<S-Space> |
|
|
747 | URxvt.keysym.M-Up: \033<M-Up> |
|
|
748 | URxvt.keysym.M-Down: \033<M-Down> |
|
|
749 | URxvt.keysym.M-Left: \033<M-Left> |
|
|
750 | URxvt.keysym.M-Right: \033<M-Right> |
|
|
751 | URxvt.keysym.M-C-0: list \033<M-C- 0123456789 > |
|
|
752 | URxvt.keysym.M-C-a: list \033<M-C- abcdefghijklmnopqrstuvwxyz > |
|
|
753 | URxvt.keysym.F12: command:\033]701;zh_CN.GBK\007 |
|
|
754 | |
|
|
755 | See some more examples in the documentation for the B<keysym> resource. |
|
|
756 | |
|
|
757 | =item I'm using keyboard model XXX that has extra Prior/Next/Insert keys. |
|
|
758 | How do I make use of them? For example, the Sun Keyboard type 4 |
|
|
759 | has the following mappings that rxvt-unicode doesn't recognize. |
|
|
760 | |
|
|
761 | KP_Insert == Insert |
|
|
762 | F22 == Print |
|
|
763 | F27 == Home |
|
|
764 | F29 == Prior |
|
|
765 | F33 == End |
|
|
766 | F35 == Next |
|
|
767 | |
|
|
768 | Rather than have rxvt-unicode try to accommodate all the various possible |
|
|
769 | keyboard mappings, it is better to use `xmodmap' to remap the keys as |
|
|
770 | required for your particular machine. |
|
|
771 | |
|
|
772 | =item How do I distinguish wether I'm running rxvt-unicode or a regular xterm? |
|
|
773 | I need this to decide about setting colors etc. |
|
|
774 | |
|
|
775 | rxvt and rxvt-unicode always export the variable "COLORTERM", so you can |
|
|
776 | check and see if that is set. Note that several programs, JED, slrn, |
|
|
777 | Midnight Commander automatically check this variable to decide whether or |
|
|
778 | not to use color. |
|
|
779 | |
|
|
780 | =item How do I set the correct, full IP address for the DISPLAY variable? |
|
|
781 | |
|
|
782 | If you've compiled rxvt-unicode with DISPLAY_IS_IP and have enabled |
|
|
783 | insecure mode then it is possible to use the following shell script |
|
|
784 | snippets to correctly set the display. If your version of rxvt-unicode |
|
|
785 | wasn't also compiled with ESCZ_ANSWER (as assumed in these snippets) then |
|
|
786 | the COLORTERM variable can be used to distinguish rxvt-unicode from a |
|
|
787 | regular xterm. |
|
|
788 | |
|
|
789 | Courtesy of Chuck Blake <cblake@BBN.COM> with the following shell script |
|
|
790 | snippets: |
|
|
791 | |
|
|
792 | # Bourne/Korn/POSIX family of shells: |
|
|
793 | [ ${TERM:-foo} = foo ] && TERM=xterm # assume an xterm if we don't know |
|
|
794 | if [ ${TERM:-foo} = xterm ]; then |
|
|
795 | stty -icanon -echo min 0 time 15 # see if enhanced rxvt or not |
|
|
796 | echo -n '^[Z' |
|
|
797 | read term_id |
|
|
798 | stty icanon echo |
|
|
799 | if [ ""${term_id} = '^[[?1;2C' -a ${DISPLAY:-foo} = foo ]; then |
|
|
800 | echo -n '^[[7n' # query the rxvt we are in for the DISPLAY string |
|
|
801 | read DISPLAY # set it in our local shell |
|
|
802 | fi |
|
|
803 | fi |
|
|
804 | |
|
|
805 | =item How do I compile the manual pages for myself? |
|
|
806 | |
|
|
807 | You need to have a recent version of perl installed as F</usr/bin/perl>, |
|
|
808 | one that comes with F<pod2man>, F<pod2text> and F<pod2html>. Then go to |
|
|
809 | the doc subdirectory and enter C<make alldoc>. |
|
|
810 | |
|
|
811 | =item My question isn't answered here, can I ask a human? |
|
|
812 | |
|
|
813 | Before sending me mail, you could go to IRC: C<irc.freenode.net>, |
|
|
814 | channel C<#rxvt-unicode> has some rxvt-unicode enthusiasts that might be |
|
|
815 | interested in learning about new and exciting problems (but not FAQs :). |
|
|
816 | |
|
|
817 | =back |
|
|
818 | |
1 | =head1 RXVT TECHNICAL REFERENCE |
819 | =head1 RXVT TECHNICAL REFERENCE |
|
|
820 | |
|
|
821 | =head1 DESCRIPTION |
|
|
822 | |
|
|
823 | The rest of this document describes various technical aspects of |
|
|
824 | B<rxvt-unicode>. First the description of supported command sequences, |
|
|
825 | followed by menu and pixmap support and last by a description of all |
|
|
826 | features selectable at C<configure> time. |
2 | |
827 | |
3 | =head1 Definitions |
828 | =head1 Definitions |
4 | |
829 | |
5 | =over 4 |
830 | =over 4 |
6 | |
831 | |
… | |
… | |
135 | Single Shift Select of G3 Character Set (SS3): affects next character |
960 | Single Shift Select of G3 Character Set (SS3): affects next character |
136 | only I<unimplemented> |
961 | only I<unimplemented> |
137 | |
962 | |
138 | =item B<< C<ESC Z> >> |
963 | =item B<< C<ESC Z> >> |
139 | |
964 | |
140 | Obsolete form of returns: B<< C<ESC[?1;2C> >> I<rxvt-unicode compile-time option> |
965 | Obsolete form of returns: B<< C<ESC [ ? 1 ; 2 C> >> I<rxvt-unicode compile-time option> |
141 | |
966 | |
142 | =item B<< C<ESC c> >> |
967 | =item B<< C<ESC c> >> |
143 | |
968 | |
144 | Full reset (RIS) |
969 | Full reset (RIS) |
145 | |
970 | |
… | |
… | |
149 | |
974 | |
150 | =item B<< C<ESC o> >> |
975 | =item B<< C<ESC o> >> |
151 | |
976 | |
152 | Invoke the G3 Character Set (LS3) |
977 | Invoke the G3 Character Set (LS3) |
153 | |
978 | |
154 | =item B<< C<ESC>(C<C> >> |
979 | =item B<< C<ESC ( C> >> |
155 | |
980 | |
156 | Designate G0 Character Set (ISO 2022), see below for values of C<C>. |
981 | Designate G0 Character Set (ISO 2022), see below for values of C<C>. |
157 | |
982 | |
158 | =item B<< C<ESC>)C<C> >> |
983 | =item B<< C<ESC ) C> >> |
159 | |
984 | |
160 | Designate G1 Character Set (ISO 2022), see below for values of C<C>. |
985 | Designate G1 Character Set (ISO 2022), see below for values of C<C>. |
161 | |
986 | |
162 | =item B<< C<ESC * C> >> |
987 | =item B<< C<ESC * C> >> |
163 | |
988 | |
… | |
… | |
187 | |
1012 | |
188 | =back |
1013 | =back |
189 | |
1014 | |
190 | X<CSI> |
1015 | X<CSI> |
191 | |
1016 | |
192 | =head1 CSI (Code Sequence Introducer) Sequences |
1017 | =head1 CSI (Command Sequence Introducer) Sequences |
193 | |
1018 | |
194 | =over 4 |
1019 | =over 4 |
195 | |
1020 | |
196 | =item B<< C<ESC [ Ps @> >> |
1021 | =item B<< C<ESC [ Ps @> >> |
197 | |
1022 | |
… | |
… | |
304 | |
1129 | |
305 | =item B<< C<ESC [ Ps c> >> |
1130 | =item B<< C<ESC [ Ps c> >> |
306 | |
1131 | |
307 | Send Device Attributes (DA) |
1132 | Send Device Attributes (DA) |
308 | B<< C<Ps = 0> >> (or omitted): request attributes from terminal |
1133 | B<< C<Ps = 0> >> (or omitted): request attributes from terminal |
309 | returns: B<< C<ESC[?1;2c> >> (``I am a VT100 with Advanced Video |
1134 | returns: B<< C<ESC [ ? 1 ; 2 c> >> (``I am a VT100 with Advanced Video |
310 | Option'') |
1135 | Option'') |
311 | |
1136 | |
312 | =item B<< C<ESC [ Ps d> >> |
1137 | =item B<< C<ESC [ Ps d> >> |
313 | |
1138 | |
314 | Cursor to Line B<< C<Ps> >> (VPA) |
1139 | Cursor to Line B<< C<Ps> >> (VPA) |
… | |
… | |
330 | B<< C<Ps = 0> >> Clear Current Column (default) |
1155 | B<< C<Ps = 0> >> Clear Current Column (default) |
331 | B<< C<Ps = 3> >> Clear All (TBC) |
1156 | B<< C<Ps = 3> >> Clear All (TBC) |
332 | |
1157 | |
333 | =end table |
1158 | =end table |
334 | |
1159 | |
|
|
1160 | =item B<< C<ESC [ Pm h> >> |
|
|
1161 | |
|
|
1162 | Set Mode (SM). See B<< C<ESC [ Pm l> >> sequence for description of C<Pm>. |
|
|
1163 | |
335 | =item B<< C<ESC [ Ps i> >> |
1164 | =item B<< C<ESC [ Ps i> >> |
336 | |
1165 | |
337 | Printing |
1166 | Printing. See also the C<print-pipe> resource. |
338 | |
1167 | |
339 | =begin table |
1168 | =begin table |
340 | |
1169 | |
|
|
1170 | B<< C<Ps = 0> >> print screen (MC0) |
341 | B<< C<Ps = 4> >> disable transparent print mode (MC4) |
1171 | B<< C<Ps = 4> >> disable transparent print mode (MC4) |
342 | B<< C<Ps = 5> >> enable transparent print mode (MC5) I<unimplemented> |
1172 | B<< C<Ps = 5> >> enable transparent print mode (MC5) |
343 | |
1173 | |
344 | =end table |
1174 | =end table |
345 | |
|
|
346 | =item B<< C<ESC [ Pm h> >> |
|
|
347 | |
|
|
348 | Set Mode (SM). See next sequence for description of C<Pm>. |
|
|
349 | |
1175 | |
350 | =item B<< C<ESC [ Pm l> >> |
1176 | =item B<< C<ESC [ Pm l> >> |
351 | |
1177 | |
352 | Reset Mode (RM) |
1178 | Reset Mode (RM) |
353 | |
1179 | |
… | |
… | |
360 | B<< C<h> >> Insert Mode (SMIR) |
1186 | B<< C<h> >> Insert Mode (SMIR) |
361 | B<< C<l> >> Replace Mode (RMIR) |
1187 | B<< C<l> >> Replace Mode (RMIR) |
362 | |
1188 | |
363 | =end table |
1189 | =end table |
364 | |
1190 | |
365 | =item B<< C<Ps = 20> >> I<unimplemented> |
1191 | =item B<< C<Ps = 20> >> (partially implemented) |
366 | |
1192 | |
367 | =begin table |
1193 | =begin table |
368 | |
1194 | |
369 | B<< C<h> >> Automatic Newline (LNM) |
1195 | B<< C<h> >> Automatic Newline (LNM) |
370 | B<< C<h> >> Normal Linefeed (LNM) |
1196 | B<< C<l> >> Normal Linefeed (LNM) |
371 | |
1197 | |
372 | =end table |
1198 | =end table |
373 | |
1199 | |
374 | =back |
1200 | =back |
375 | |
1201 | |
… | |
… | |
378 | Character Attributes (SGR) |
1204 | Character Attributes (SGR) |
379 | |
1205 | |
380 | =begin table |
1206 | =begin table |
381 | |
1207 | |
382 | B<< C<Ps = 0> >> Normal (default) |
1208 | B<< C<Ps = 0> >> Normal (default) |
383 | B<< C<Ps = 1 / 22> >> On / Off Bold (bright fg) |
1209 | B<< C<Ps = 1 / 21> >> On / Off Bold (bright fg) |
|
|
1210 | B<< C<Ps = 3 / 23> >> On / Off Italic |
384 | B<< C<Ps = 4 / 24> >> On / Off Underline |
1211 | B<< C<Ps = 4 / 24> >> On / Off Underline |
385 | B<< C<Ps = 5 / 25> >> On / Off Blink (bright bg) |
1212 | B<< C<Ps = 5 / 25> >> On / Off Slow Blink (bright bg) |
|
|
1213 | B<< C<Ps = 6 / 26> >> On / Off Rapid Blink (bright bg) |
386 | B<< C<Ps = 7 / 27> >> On / Off Inverse |
1214 | B<< C<Ps = 7 / 27> >> On / Off Inverse |
|
|
1215 | B<< C<Ps = 8 / 27> >> On / Off Invisible (NYI) |
387 | B<< C<Ps = 30 / 40> >> fg/bg Black |
1216 | B<< C<Ps = 30 / 40> >> fg/bg Black |
388 | B<< C<Ps = 31 / 41> >> fg/bg Red |
1217 | B<< C<Ps = 31 / 41> >> fg/bg Red |
389 | B<< C<Ps = 32 / 42> >> fg/bg Green |
1218 | B<< C<Ps = 32 / 42> >> fg/bg Green |
390 | B<< C<Ps = 33 / 43> >> fg/bg Yellow |
1219 | B<< C<Ps = 33 / 43> >> fg/bg Yellow |
391 | B<< C<Ps = 34 / 44> >> fg/bg Blue |
1220 | B<< C<Ps = 34 / 44> >> fg/bg Blue |
392 | B<< C<Ps = 35 / 45> >> fg/bg Magenta |
1221 | B<< C<Ps = 35 / 45> >> fg/bg Magenta |
393 | B<< C<Ps = 36 / 46> >> fg/bg Cyan |
1222 | B<< C<Ps = 36 / 46> >> fg/bg Cyan |
|
|
1223 | B<< C<Ps = 38;5 / 48;5> >> set fg/bg to color #m (ISO 8613-6) |
394 | B<< C<Ps = 37 / 47> >> fg/bg White |
1224 | B<< C<Ps = 37 / 47> >> fg/bg White |
395 | B<< C<Ps = 39 / 49> >> fg/bg Default |
1225 | B<< C<Ps = 39 / 49> >> fg/bg Default |
|
|
1226 | B<< C<Ps = 90 / 100> >> fg/bg Bright Black |
|
|
1227 | B<< C<Ps = 91 / 101> >> fg/bg Bright Red |
|
|
1228 | B<< C<Ps = 92 / 102> >> fg/bg Bright Green |
|
|
1229 | B<< C<Ps = 93 / 103> >> fg/bg Bright Yellow |
|
|
1230 | B<< C<Ps = 94 / 104> >> fg/bg Bright Blue |
|
|
1231 | B<< C<Ps = 95 / 105> >> fg/bg Bright Magenta |
|
|
1232 | B<< C<Ps = 96 / 106> >> fg/bg Bright Cyan |
|
|
1233 | B<< C<Ps = 97 / 107> >> fg/bg Bright White |
|
|
1234 | B<< C<Ps = 99 / 109> >> fg/bg Bright Default |
396 | |
1235 | |
397 | =end table |
1236 | =end table |
398 | |
1237 | |
399 | =item B<< C<ESC [ Ps n> >> |
1238 | =item B<< C<ESC [ Ps n> >> |
400 | |
1239 | |
… | |
… | |
416 | |
1255 | |
417 | =item B<< C<ESC [ s> >> |
1256 | =item B<< C<ESC [ s> >> |
418 | |
1257 | |
419 | Save Cursor (SC) |
1258 | Save Cursor (SC) |
420 | |
1259 | |
|
|
1260 | =item B<< C<ESC [ Ps;Pt t> >> |
|
|
1261 | |
|
|
1262 | Window Operations |
|
|
1263 | |
|
|
1264 | =begin table |
|
|
1265 | |
|
|
1266 | B<< C<Ps = 1> >> Deiconify (map) window |
|
|
1267 | B<< C<Ps = 2> >> Iconify window |
|
|
1268 | B<< C<Ps = 3> >> B<< C<ESC [ 3 ; X ; Y t> >> Move window to (X|Y) |
|
|
1269 | B<< C<Ps = 4> >> B<< C<ESC [ 4 ; H ; W t> >> Resize to WxH pixels |
|
|
1270 | B<< C<Ps = 5> >> Raise window |
|
|
1271 | B<< C<Ps = 6> >> Lower window |
|
|
1272 | B<< C<Ps = 7> >> Refresh screen once |
|
|
1273 | B<< C<Ps = 8> >> B<< C<ESC [ 8 ; R ; C t> >> Resize to R rows and C columns |
|
|
1274 | B<< C<Ps = 11> >> Report window state (responds with C<Ps = 1> or C<Ps = 2>) |
|
|
1275 | B<< C<Ps = 13> >> Report window position (responds with C<Ps = 3>) |
|
|
1276 | B<< C<Ps = 14> >> Report window pixel size (responds with C<Ps = 4>) |
|
|
1277 | B<< C<Ps = 18> >> Report window text size (responds with C<Ps = 7>) |
|
|
1278 | B<< C<Ps = 19> >> Currently the same as C<Ps = 18>, but responds with C<Ps = 9> |
|
|
1279 | B<< C<Ps = 20> >> Reports icon label (B<< C<ESC ] L NAME \234> >>) |
|
|
1280 | B<< C<Ps = 21> >> Reports window title (B<< C<ESC ] l NAME \234> >>) |
|
|
1281 | B<< C<Ps = 24..> >> Set window height to C<Ps> rows |
|
|
1282 | |
|
|
1283 | =end table |
|
|
1284 | |
|
|
1285 | =item B<< C<ESC [ u> >> |
|
|
1286 | |
|
|
1287 | Restore Cursor |
|
|
1288 | |
421 | =item B<< C<ESC [ Ps x> >> |
1289 | =item B<< C<ESC [ Ps x> >> |
422 | |
1290 | |
423 | Request Terminal Parameters (DECREQTPARM) |
1291 | Request Terminal Parameters (DECREQTPARM) |
424 | |
|
|
425 | =item B<< C<ESC [ u> >> |
|
|
426 | |
|
|
427 | Restore Cursor |
|
|
428 | |
1292 | |
429 | =back |
1293 | =back |
430 | |
1294 | |
431 | X<PrivateModes> |
1295 | X<PrivateModes> |
432 | |
1296 | |
… | |
… | |
535 | B<< C<h> >> Send Mouse X & Y on button press. |
1399 | B<< C<h> >> Send Mouse X & Y on button press. |
536 | B<< C<l> >> No mouse reporting. |
1400 | B<< C<l> >> No mouse reporting. |
537 | |
1401 | |
538 | =end table |
1402 | =end table |
539 | |
1403 | |
540 | X<Priv10> |
|
|
541 | |
|
|
542 | =item B<< C<Ps = 10> >> (B<rxvt>) |
1404 | =item B<< C<Ps = 10> >> (B<rxvt>) |
543 | |
1405 | |
544 | =begin table |
1406 | =begin table |
545 | |
1407 | |
546 | B<< C<h> >> visible |
1408 | B<< C<h> >> menuBar visible |
547 | B<< C<l> >> invisible |
1409 | B<< C<l> >> menuBar invisible |
548 | |
1410 | |
549 | =end table |
1411 | =end table |
550 | |
1412 | |
551 | =item B<< C<Ps = 25> >> |
1413 | =item B<< C<Ps = 25> >> |
552 | |
1414 | |
… | |
… | |
653 | B<< C<h> >> Use Hilite Mouse Tracking. |
1515 | B<< C<h> >> Use Hilite Mouse Tracking. |
654 | B<< C<l> >> No mouse reporting. |
1516 | B<< C<l> >> No mouse reporting. |
655 | |
1517 | |
656 | =end table |
1518 | =end table |
657 | |
1519 | |
658 | =item B<< C<Ps = 1010> >> |
1520 | =item B<< C<Ps = 1010> >> (B<rxvt>) |
659 | |
1521 | |
660 | =begin table |
1522 | =begin table |
661 | |
1523 | |
662 | B<< C<h> >> Don't scroll to bottom on TTY output |
1524 | B<< C<h> >> Don't scroll to bottom on TTY output |
663 | B<< C<l> >> Scroll to bottom on TTY output |
1525 | B<< C<l> >> Scroll to bottom on TTY output |
664 | |
1526 | |
665 | =end table |
1527 | =end table |
666 | |
1528 | |
667 | =item B<< C<Ps = 1011> >> |
1529 | =item B<< C<Ps = 1011> >> (B<rxvt>) |
668 | |
1530 | |
669 | =begin table |
1531 | =begin table |
670 | |
1532 | |
671 | B<< C<h> >> Scroll to bottom when a key is pressed |
1533 | B<< C<h> >> Scroll to bottom when a key is pressed |
672 | B<< C<l> >> Don't scroll to bottom when a key is pressed |
1534 | B<< C<l> >> Don't scroll to bottom when a key is pressed |
673 | |
1535 | |
674 | =end table |
1536 | =end table |
675 | |
1537 | |
|
|
1538 | =item B<< C<Ps = 1021> >> (B<rxvt>) |
|
|
1539 | |
|
|
1540 | =begin table |
|
|
1541 | |
|
|
1542 | B<< C<h> >> Bold/italic implies high intensity (see option B<-is>) |
|
|
1543 | B<< C<l> >> Font styles have no effect on intensity (Compile styles) |
|
|
1544 | |
|
|
1545 | =end table |
|
|
1546 | |
676 | =item B<< C<Ps = 1047> >> |
1547 | =item B<< C<Ps = 1047> >> |
677 | |
1548 | |
678 | =begin table |
1549 | =begin table |
679 | |
1550 | |
680 | B<< C<h> >> Use Alternate Screen Buffer |
1551 | B<< C<h> >> Use Alternate Screen Buffer |
… | |
… | |
686 | |
1557 | |
687 | =begin table |
1558 | =begin table |
688 | |
1559 | |
689 | B<< C<h> >> Save cursor position |
1560 | B<< C<h> >> Save cursor position |
690 | B<< C<l> >> Restore cursor position |
1561 | B<< C<l> >> Restore cursor position |
|
|
1562 | |
|
|
1563 | =end table |
|
|
1564 | |
|
|
1565 | =item B<< C<Ps = 1049> >> |
|
|
1566 | |
|
|
1567 | =begin table |
|
|
1568 | |
|
|
1569 | B<< C<h> >> Use Alternate Screen Buffer - clear Alternate Screen Buffer if switching to it |
|
|
1570 | B<< C<l> >> Use Normal Screen Buffer |
691 | |
1571 | |
692 | =end table |
1572 | =end table |
693 | |
1573 | |
694 | =back |
1574 | =back |
695 | |
1575 | |
… | |
… | |
720 | B<< C<Ps = 13> >> Change colour of mouse foreground to B<< C<Pt> >> |
1600 | B<< C<Ps = 13> >> Change colour of mouse foreground to B<< C<Pt> >> |
721 | B<< C<Ps = 17> >> Change colour of highlight characters to B<< C<Pt> >> |
1601 | B<< C<Ps = 17> >> Change colour of highlight characters to B<< C<Pt> >> |
722 | B<< C<Ps = 18> >> Change colour of bold characters to B<< C<Pt> >> |
1602 | B<< C<Ps = 18> >> Change colour of bold characters to B<< C<Pt> >> |
723 | B<< C<Ps = 19> >> Change colour of underlined characters to B<< C<Pt> >> |
1603 | B<< C<Ps = 19> >> Change colour of underlined characters to B<< C<Pt> >> |
724 | B<< C<Ps = 20> >> Change default background to B<< C<Pt> >> |
1604 | B<< C<Ps = 20> >> Change default background to B<< C<Pt> >> |
725 | B<< C<Ps = 39> >> Change default foreground colour to B<< C<Pt> >> I<rxvt compile-time option> |
1605 | B<< C<Ps = 39> >> Change default foreground colour to B<< C<Pt> >>. |
726 | B<< C<Ps = 46> >> Change Log File to B<< C<Pt> >> I<unimplemented> |
1606 | B<< C<Ps = 46> >> Change Log File to B<< C<Pt> >> I<unimplemented> |
727 | B<< C<Ps = 49> >> Change default background colour to B<< C<Pt> >> I<rxvt compile-time option> |
1607 | B<< C<Ps = 49> >> Change default background colour to B<< C<Pt> >>. |
728 | B<< C<Ps = 50> >> Set fontset to B<< C<Pt> >>, with the following special values of B<< C<Pt> >> (B<rxvt>) B<< C<#+n> >> change up B<< C<n> >> B<< C<#-n> >> change down B<< C<n> >> if B<< C<n> >> is missing of 0, a value of 1 is used I<empty> change to font0 B<< C<n> >> change to font B<< C<n> >> |
1608 | B<< C<Ps = 50> >> Set fontset to B<< C<Pt> >>, with the following special values of B<< C<Pt> >> (B<rxvt>) B<< C<#+n> >> change up B<< C<n> >> B<< C<#-n> >> change down B<< C<n> >> if B<< C<n> >> is missing of 0, a value of 1 is used I<empty> change to font0 B<< C<n> >> change to font B<< C<n> >> |
729 | B<< C<Ps = 55> >> Log all scrollback buffer and all of screen to B<< C<Pt> >> |
1609 | B<< C<Ps = 55> >> Log all scrollback buffer and all of screen to B<< C<Pt> >> |
730 | B<< C<Ps = 701> >> Change current locale to B<< C<Pt> >>, or, if B<< C<Pt> >> is B<< C<?> >>, return the current locale (@@RXVT_NAME@@ extension) |
1610 | B<< C<Ps = 701> >> Change current locale to B<< C<Pt> >>, or, if B<< C<Pt> >> is B<< C<?> >>, return the current locale (Compile frills). |
731 | B<< C<Ps = 702> >> find font for character, used for debugging (@@RXVT_NAME@@ extension) |
1611 | B<< C<Ps = 703> >> Menubar command B<< C<Pt> >> (Compile menubar). |
732 | B<< C<Ps = 703> >> command B<< C<Pt> >> I<rxvt compile-time option> (@@RXVT_NAME@@ extension) |
1612 | B<< C<Ps = 704> >> Change colour of italic characters to B<< C<Pt> >> |
|
|
1613 | B<< C<Ps = 705> >> Change background pixmap tint colour to B<< C<Pt> >> (Compile transparency). |
|
|
1614 | B<< C<Ps = 710> >> Set normal fontset to B<< C<Pt> >>. Same as C<Ps = 50>. |
|
|
1615 | B<< C<Ps = 711> >> Set bold fontset to B<< C<Pt> >>. Similar to C<Ps = 50> (Compile styles). |
|
|
1616 | B<< C<Ps = 712> >> Set italic fontset to B<< C<Pt> >>. Similar to C<Ps = 50> (Compile styles). |
|
|
1617 | B<< C<Ps = 713> >> Set bold-italic fontset to B<< C<Pt> >>. Similar to C<Ps = 50> (Compile styles). |
|
|
1618 | B<< C<Ps = 720> >> Move viewing window up by B<< C<Pt> >> lines, or clear scrollback buffer if C<Pt = 0> (Compile frills). |
|
|
1619 | B<< C<Ps = 721> >> Move viewing window down by B<< C<Pt> >> lines, or clear scrollback buffer if C<Pt = 0> (Compile frills). |
|
|
1620 | B<< C<Ps = 777> >> Call the perl extension with the given string, which should be of the form C<extension:parameters> (Compile perl). |
733 | |
1621 | |
734 | =end table |
1622 | =end table |
735 | |
1623 | |
736 | =back |
1624 | =back |
737 | |
1625 | |
… | |
… | |
789 | |
1677 | |
790 | =item B<< [title:+I<string>] >> |
1678 | =item B<< [title:+I<string>] >> |
791 | |
1679 | |
792 | set the current menuBar's title to I<string>, which may contain the |
1680 | set the current menuBar's title to I<string>, which may contain the |
793 | following format specifiers: |
1681 | following format specifiers: |
794 | B<%%> : literal B<%> character |
1682 | |
795 | B<%n> : rxvt name (as per the B<-name> command-line option) |
1683 | B<%n> rxvt name (as per the B<-name> command-line option) |
796 | B<%v> : rxvt version |
1684 | B<%v> rxvt version |
|
|
1685 | B<%%> literal B<%> character |
797 | |
1686 | |
798 | =item B<[done]> |
1687 | =item B<[done]> |
799 | |
1688 | |
800 | set menuBar access as B<readonly>. |
1689 | set menuBar access as B<readonly>. |
801 | End-of-file tag for B<< [read:+I<file>] >> operations. |
1690 | End-of-file tag for B<< [read:+I<file>] >> operations. |
… | |
… | |
947 | |
1836 | |
948 | As a convenience for the many Emacs-type editors, I<action> may start |
1837 | As a convenience for the many Emacs-type editors, I<action> may start |
949 | with B<M-> (eg, B<M-$> is equivalent to B<\E$>) and a B<CR> will be |
1838 | with B<M-> (eg, B<M-$> is equivalent to B<\E$>) and a B<CR> will be |
950 | appended if missed from B<M-x> commands. |
1839 | appended if missed from B<M-x> commands. |
951 | |
1840 | |
952 | As a convenience for issuing XTerm B<ESC]> sequences from a menubar (or |
1841 | As a convenience for issuing XTerm B<ESC ]> sequences from a menubar (or |
953 | quick arrow), a B<BEL> (B<^G>) will be appended if needed. |
1842 | quick arrow), a B<BEL> (B<^G>) will be appended if needed. |
954 | |
1843 | |
955 | =over 4 |
1844 | =over 4 |
956 | |
1845 | |
957 | =item For example, |
1846 | =item For example, |
… | |
… | |
1390 | XK_KP_8 8 ESC O x |
2279 | XK_KP_8 8 ESC O x |
1391 | XK_KP_9 9 ESC O y |
2280 | XK_KP_9 9 ESC O y |
1392 | |
2281 | |
1393 | =end table |
2282 | =end table |
1394 | |
2283 | |
|
|
2284 | =head1 CONFIGURE OPTIONS |
|
|
2285 | |
|
|
2286 | General hint: if you get compile errors, then likely your configuration |
|
|
2287 | hasn't been tested well. Either try with C<--enable-everything> or use |
|
|
2288 | the F<./reconf> script as a base for experiments. F<./reconf> is used by |
|
|
2289 | myself, so it should generally be a working config. Of course, you should |
|
|
2290 | always report when a combination doesn't work, so it can be fixed. Marc |
|
|
2291 | Lehmann <rxvt@schmorp.de>. |
|
|
2292 | |
|
|
2293 | All |
|
|
2294 | |
|
|
2295 | =over 4 |
|
|
2296 | |
|
|
2297 | =item --enable-everything |
|
|
2298 | |
|
|
2299 | Add (or remove) support for all non-multichoice options listed in "./configure |
|
|
2300 | --help". |
|
|
2301 | |
|
|
2302 | You can specify this and then disable options you do not like by |
|
|
2303 | I<following> this with the appropriate C<--disable-...> arguments, |
|
|
2304 | or you can start with a minimal configuration by specifying |
|
|
2305 | C<--disable-everything> and than adding just the C<--enable-...> arguments |
|
|
2306 | you want. |
|
|
2307 | |
|
|
2308 | =item --enable-xft (default: enabled) |
|
|
2309 | |
|
|
2310 | Add support for Xft (anti-aliases, among others) fonts. Xft fonts are |
|
|
2311 | slower and require lots of memory, but as long as you don't use them, you |
|
|
2312 | don't pay for them. |
|
|
2313 | |
|
|
2314 | =item --enable-font-styles (default: on) |
|
|
2315 | |
|
|
2316 | Add support for B<bold>, I<italic> and B<< I<bold italic> >> font |
|
|
2317 | styles. The fonts can be set manually or automatically. |
|
|
2318 | |
|
|
2319 | =item --with-codesets=NAME,... (default: all) |
|
|
2320 | |
|
|
2321 | Compile in support for additional codeset (encoding) groups (C<eu>, C<vn> |
|
|
2322 | are always compiled in, which includes most 8-bit character sets). These |
|
|
2323 | codeset tables are used for driving X11 core fonts, they are not required |
|
|
2324 | for Xft fonts, although having them compiled in lets rxvt-unicode choose |
|
|
2325 | replacement fonts more intelligently. Compiling them in will make your |
|
|
2326 | binary bigger (all of together cost about 700kB), but it doesn't increase |
|
|
2327 | memory usage unless you use a font requiring one of these encodings. |
|
|
2328 | |
|
|
2329 | =begin table |
|
|
2330 | |
|
|
2331 | all all available codeset groups |
|
|
2332 | zh common chinese encodings |
|
|
2333 | zh_ext rarely used but very big chinese encodigs |
|
|
2334 | jp common japanese encodings |
|
|
2335 | jp_ext rarely used but big japanese encodings |
|
|
2336 | kr korean encodings |
|
|
2337 | |
|
|
2338 | =end table |
|
|
2339 | |
|
|
2340 | =item --enable-xim (default: on) |
|
|
2341 | |
|
|
2342 | Add support for XIM (X Input Method) protocol. This allows using |
|
|
2343 | alternative input methods (e.g. kinput2) and will also correctly |
|
|
2344 | set up the input for people using dead keys or compose keys. |
|
|
2345 | |
|
|
2346 | =item --enable-unicode3 (default: off) |
|
|
2347 | |
|
|
2348 | Enable direct support for displaying unicode codepoints above |
|
|
2349 | 65535 (the basic multilingual page). This increases storage |
|
|
2350 | requirements per character from 2 to 4 bytes. X11 fonts do not yet |
|
|
2351 | support these extra characters, but Xft does. |
|
|
2352 | |
|
|
2353 | Please note that rxvt-unicode can store unicode code points >65535 |
|
|
2354 | even without this flag, but the number of such characters is |
|
|
2355 | limited to a view thousand (shared with combining characters, |
|
|
2356 | see next switch), and right now rxvt-unicode cannot display them |
|
|
2357 | (input/output and cut&paste still work, though). |
|
|
2358 | |
|
|
2359 | =item --enable-combining (default: on) |
|
|
2360 | |
|
|
2361 | Enable automatic composition of combining characters into |
|
|
2362 | composite characters. This is required for proper viewing of text |
|
|
2363 | where accents are encoded as seperate unicode characters. This is |
|
|
2364 | done by using precomposited characters when available or creating |
|
|
2365 | new pseudo-characters when no precomposed form exists. |
|
|
2366 | |
|
|
2367 | Without --enable-unicode3, the number of additional precomposed characters |
|
|
2368 | is rather limited (2048, if this is full, rxvt-unicode will use the |
|
|
2369 | private use area, extending the number of combinations to 8448). With |
|
|
2370 | --enable-unicode3, no practical limit exists. |
|
|
2371 | |
|
|
2372 | This option will also enable storage (but not display) of characters |
|
|
2373 | beyond plane 0 (>65535) when --enable-unicode3 was not specified. |
|
|
2374 | |
|
|
2375 | The combining table also contains entries for arabic presentation forms, |
|
|
2376 | but these are not currently used. Bug me if you want these to be used (and |
|
|
2377 | tell me how these are to be used...). |
|
|
2378 | |
|
|
2379 | =item --enable-fallback(=CLASS) (default: Rxvt) |
|
|
2380 | |
|
|
2381 | When reading resource settings, also read settings for class CLASS. To disable resource fallback use --disable-fallback. |
|
|
2382 | |
|
|
2383 | =item --with-res-name=NAME (default: urxvt) |
|
|
2384 | |
|
|
2385 | Use the given name as default application name when |
|
|
2386 | reading resources. Specify --with-res-name=rxvt to replace rxvt. |
|
|
2387 | |
|
|
2388 | =item --with-res-class=CLASS /default: URxvt) |
|
|
2389 | |
|
|
2390 | Use the given class as default application class |
|
|
2391 | when reading resources. Specify --with-res-class=Rxvt to replace |
|
|
2392 | rxvt. |
|
|
2393 | |
|
|
2394 | =item --enable-utmp (default: on) |
|
|
2395 | |
|
|
2396 | Write user and tty to utmp file (used by programs like F<w>) at |
|
|
2397 | start of rxvt execution and delete information when rxvt exits. |
|
|
2398 | |
|
|
2399 | =item --enable-wtmp (default: on) |
|
|
2400 | |
|
|
2401 | Write user and tty to wtmp file (used by programs like F<last>) at |
|
|
2402 | start of rxvt execution and write logout when rxvt exits. This |
|
|
2403 | option requires --enable-utmp to also be specified. |
|
|
2404 | |
|
|
2405 | =item --enable-lastlog (default: on) |
|
|
2406 | |
|
|
2407 | Write user and tty to lastlog file (used by programs like |
|
|
2408 | F<lastlogin>) at start of rxvt execution. This option requires |
|
|
2409 | --enable-utmp to also be specified. |
|
|
2410 | |
|
|
2411 | =item --enable-xpm-background (default: off) |
|
|
2412 | |
|
|
2413 | Add support for XPM background pixmaps. |
|
|
2414 | |
|
|
2415 | =item --enable-transparency (default: off) |
|
|
2416 | |
|
|
2417 | Add support for inheriting parent backgrounds thus giving a fake |
|
|
2418 | transparency to the term. |
|
|
2419 | |
|
|
2420 | =item --enable-fading (default: on) |
|
|
2421 | |
|
|
2422 | Add support for fading the text when focus is lost (requires C<--enable-transparency>). |
|
|
2423 | |
|
|
2424 | =item --enable-tinting (default: on) |
|
|
2425 | |
|
|
2426 | Add support for tinting of transparent backgrounds (requires C<--enable-transparency>). |
|
|
2427 | |
|
|
2428 | =item --enable-menubar (default: off) |
|
|
2429 | |
|
|
2430 | Add support for our menu bar system (this interacts badly with |
|
|
2431 | dynamic locale switching currently). |
|
|
2432 | |
|
|
2433 | =item --enable-rxvt-scroll (default: on) |
|
|
2434 | |
|
|
2435 | Add support for the original rxvt scrollbar. |
|
|
2436 | |
|
|
2437 | =item --enable-next-scroll (default: on) |
|
|
2438 | |
|
|
2439 | Add support for a NeXT-like scrollbar. |
|
|
2440 | |
|
|
2441 | =item --enable-xterm-scroll (default: on) |
|
|
2442 | |
|
|
2443 | Add support for an Xterm-like scrollbar. |
|
|
2444 | |
|
|
2445 | =item --enable-plain-scroll (default: on) |
|
|
2446 | |
|
|
2447 | Add support for a very unobtrusive, plain-looking scrollbar that |
|
|
2448 | is the favourite of the rxvt-unicode author, having used it for |
|
|
2449 | many years. |
|
|
2450 | |
|
|
2451 | =item --enable-half-shadow (default: off) |
|
|
2452 | |
|
|
2453 | Make shadows on the scrollbar only half the normal width & height. |
|
|
2454 | only applicable to rxvt scrollbars. |
|
|
2455 | |
|
|
2456 | =item --enable-ttygid (default: off) |
|
|
2457 | |
|
|
2458 | Change tty device setting to group "tty" - only use this if |
|
|
2459 | your system uses this type of security. |
|
|
2460 | |
|
|
2461 | =item --disable-backspace-key |
|
|
2462 | |
|
|
2463 | Removes any handling of the backspace key by us - let the X server do it. |
|
|
2464 | |
|
|
2465 | =item --disable-delete-key |
|
|
2466 | |
|
|
2467 | Removes any handling of the delete key by us - let the X server |
|
|
2468 | do it. |
|
|
2469 | |
|
|
2470 | =item --disable-resources |
|
|
2471 | |
|
|
2472 | Removes any support for resource checking. |
|
|
2473 | |
|
|
2474 | =item --enable-xgetdefault |
|
|
2475 | |
|
|
2476 | Make resources checking via XGetDefault() instead of our small |
|
|
2477 | version which only checks ~/.Xdefaults, or if that doesn't exist then |
|
|
2478 | ~/.Xresources. |
|
|
2479 | |
|
|
2480 | Please note that nowadays, things like XIM will automatically pull in and |
|
|
2481 | use the full X resource manager, so the overhead of using it might be very |
|
|
2482 | small, if nonexistant. |
|
|
2483 | |
|
|
2484 | =item --enable-strings (default: off) |
|
|
2485 | |
|
|
2486 | Add support for our possibly faster memset() function and other |
|
|
2487 | various routines, overriding your system's versions which may |
|
|
2488 | have been hand-crafted in assembly or may require extra libraries |
|
|
2489 | to link in. (this breaks ANSI-C rules and has problems on many |
|
|
2490 | GNU/Linux systems). |
|
|
2491 | |
|
|
2492 | =item --disable-swapscreen |
|
|
2493 | |
|
|
2494 | Remove support for secondary/swap screen. |
|
|
2495 | |
|
|
2496 | =item --enable-frills (default: on) |
|
|
2497 | |
|
|
2498 | Add support for many small features that are not essential but nice to |
|
|
2499 | have. Normally you want this, but for very small binaries you may want to |
|
|
2500 | disable this. |
|
|
2501 | |
|
|
2502 | A non-exhaustive list of features enabled by C<--enable-frills> (possibly |
|
|
2503 | in combination with other switches) is: |
|
|
2504 | |
|
|
2505 | MWM-hints |
|
|
2506 | EWMH-hints (pid, utf8 names) and protocols (ping) |
|
|
2507 | seperate underline colour |
|
|
2508 | settable border widths and borderless switch |
|
|
2509 | settable extra linespacing |
|
|
2510 | iso-14755-2 and -3, and visual feedback |
|
|
2511 | backindex and forwardindex escape sequence |
|
|
2512 | window op and some xterm/OSC escape sequences |
|
|
2513 | tripleclickwords |
|
|
2514 | settable insecure mode |
|
|
2515 | keysym remapping support |
|
|
2516 | cursor blinking and underline cursor |
|
|
2517 | -embed, -pty-fd and -hold options |
|
|
2518 | |
|
|
2519 | =item --enable-iso14755 (default: on) |
|
|
2520 | |
|
|
2521 | Enable extended ISO 14755 support (see @@RXVT_NAME@@(1), or |
|
|
2522 | F<doc/rxvt.1.txt>). Basic support (section 5.1) is enabled by |
|
|
2523 | C<--enable-frills>, while support for 5.2, 5.3 and 5.4 is enabled with |
|
|
2524 | this switch. |
|
|
2525 | |
|
|
2526 | =item --enable-keepscrolling (default: on) |
|
|
2527 | |
|
|
2528 | Add support for continual scrolling of the display when you hold |
|
|
2529 | the mouse button down on a scrollbar arrow. |
|
|
2530 | |
|
|
2531 | =item --enable-mousewheel (default: on) |
|
|
2532 | |
|
|
2533 | Add support for scrolling via mouse wheel or buttons 4 & 5. |
|
|
2534 | |
|
|
2535 | =item --enable-slipwheeling (default: on) |
|
|
2536 | |
|
|
2537 | Add support for continual scrolling (using the mouse wheel as an |
|
|
2538 | accelerator) while the control key is held down. This option |
|
|
2539 | requires --enable-mousewheel to also be specified. |
|
|
2540 | |
|
|
2541 | =item --disable-new-selection |
|
|
2542 | |
|
|
2543 | Remove support for mouse selection style like that of xterm. |
|
|
2544 | |
|
|
2545 | =item --enable-dmalloc (default: off) |
|
|
2546 | |
|
|
2547 | Use Gray Watson's malloc - which is good for debugging See |
|
|
2548 | http://www.letters.com/dmalloc/ for details If you use either this or the |
|
|
2549 | next option, you may need to edit src/Makefile after compiling to point |
|
|
2550 | DINCLUDE and DLIB to the right places. |
|
|
2551 | |
|
|
2552 | You can only use either this option and the following (should |
|
|
2553 | you use either) . |
|
|
2554 | |
|
|
2555 | =item --enable-dlmalloc (default: off) |
|
|
2556 | |
|
|
2557 | Use Doug Lea's malloc - which is good for a production version |
|
|
2558 | See L<http://g.oswego.edu/dl/html/malloc.html> for details. |
|
|
2559 | |
|
|
2560 | =item --enable-smart-resize (default: on) |
|
|
2561 | |
|
|
2562 | Add smart growth/shrink behaviour when changing font size via hot |
|
|
2563 | keys. This should keep the window corner which is closest to a corner of |
|
|
2564 | the screen in a fixed position. |
|
|
2565 | |
|
|
2566 | =item --enable-pointer-blank (default: on) |
|
|
2567 | |
|
|
2568 | Add support to have the pointer disappear when typing or inactive. |
|
|
2569 | |
|
|
2570 | =item --enable-perl (default: off) |
|
|
2571 | |
|
|
2572 | Enable an embedded perl interpreter. See the B<@@RXVT_NAME@@perl(3)> |
|
|
2573 | manpage (F<doc/rxvtperl.txt>) for more info on this feature, or the files |
|
|
2574 | in F<src/perl-ext/> for the extensions that are installed by default. |
|
|
2575 | |
|
|
2576 | =item --with-name=NAME (default: urxvt) |
|
|
2577 | |
|
|
2578 | Set the basename for the installed binaries, resulting |
|
|
2579 | in C<urxvt>, C<urxvtd> etc.). Specify C<--with-name=rxvt> to replace with |
|
|
2580 | C<rxvt>. |
|
|
2581 | |
|
|
2582 | =item --with-term=NAME (default: rxvt-unicode) |
|
|
2583 | |
|
|
2584 | Change the environmental variable for the terminal to NAME. |
|
|
2585 | |
|
|
2586 | =item --with-terminfo=PATH |
|
|
2587 | |
|
|
2588 | Change the environmental variable for the path to the terminfo tree to |
|
|
2589 | PATH. |
|
|
2590 | |
|
|
2591 | =item --with-x |
|
|
2592 | |
|
|
2593 | Use the X Window System (pretty much default, eh?). |
|
|
2594 | |
|
|
2595 | =item --with-xpm-includes=DIR |
|
|
2596 | |
|
|
2597 | Look for the XPM includes in DIR. |
|
|
2598 | |
|
|
2599 | =item --with-xpm-library=DIR |
|
|
2600 | |
|
|
2601 | Look for the XPM library in DIR. |
|
|
2602 | |
|
|
2603 | =item --with-xpm |
|
|
2604 | |
|
|
2605 | Not needed - define via --enable-xpm-background. |
|
|
2606 | |
|
|
2607 | =back |
|
|
2608 | |
1395 | =head1 AUTHORS |
2609 | =head1 AUTHORS |
1396 | |
2610 | |
1397 | Marc Lehmann <rxvt@schmorp.de> converted this document to pod and |
2611 | Marc Lehmann <rxvt@schmorp.de> converted this document to pod and |
1398 | reworked it from the original Rxvt documentation, which was done by Geoff |
2612 | reworked it from the original Rxvt documentation, which was done by Geoff |
1399 | Wing <gcw@pobox.com>, who in turn used the XTerm documentation and other |
2613 | Wing <gcw@pobox.com>, who in turn used the XTerm documentation and other |