1 | =head1 NAME |
1 | =head1 NAME |
2 | |
2 | |
3 | RXVT REFERENCE - FAQ, command sequences and other background information |
3 | RXVT REFERENCE - FAQ, command sequences and other background information |
4 | |
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 also available on the World Wide Web at |
|
|
22 | L<http://cvs.schmorp.de/browse/*checkout*/rxvt-unicode/doc/rxvt.7.html>. |
|
|
23 | |
5 | =head1 FREQUENTLY ASKED QUESTIONS |
24 | =head1 FREQUENTLY ASKED QUESTIONS |
6 | |
25 | |
7 | =over 4 |
|
|
8 | |
26 | |
|
|
27 | =head2 Meta, Features & Commandline Issues |
|
|
28 | |
|
|
29 | =head3 My question isn't answered here, can I ask a human? |
|
|
30 | |
|
|
31 | Before sending me mail, you could go to IRC: C<irc.freenode.net>, |
|
|
32 | channel C<#rxvt-unicode> has some rxvt-unicode enthusiasts that might be |
|
|
33 | interested in learning about new and exciting problems (but not FAQs :). |
|
|
34 | |
|
|
35 | =head3 Does it support tabs, can I have a tabbed rxvt-unicode? |
|
|
36 | |
|
|
37 | Beginning with version 7.3, there is a perl extension that implements a |
|
|
38 | simple tabbed terminal. It is installed by default, so any of these should |
|
|
39 | give you tabs: |
|
|
40 | |
|
|
41 | @@RXVT_NAME@@ -pe tabbed |
|
|
42 | |
|
|
43 | URxvt.perl-ext-common: default,tabbed |
|
|
44 | |
|
|
45 | It will also work fine with tabbing functionality of many window managers |
|
|
46 | or similar tabbing programs, and its embedding-features allow it to be |
|
|
47 | embedded into other programs, as witnessed by F<doc/rxvt-tabbed> or |
|
|
48 | the upcoming C<Gtk2::URxvt> perl module, which features a tabbed urxvt |
|
|
49 | (murxvt) terminal as an example embedding application. |
|
|
50 | |
9 | =item How do I know which rxvt-unicode version I'm using? |
51 | =head3 How do I know which rxvt-unicode version I'm using? |
10 | |
52 | |
11 | The version number is displayed with the usage (-h). Also the escape |
53 | The version number is displayed with the usage (-h). Also the escape |
12 | sequence C<ESC[8n> sets the window title to the version number. |
54 | sequence C<ESC [ 8 n> sets the window title to the version number. When |
|
|
55 | using the @@RXVT_NAME@@c client, the version displayed is that of the |
|
|
56 | daemon. |
13 | |
57 | |
14 | =item When I log-in to another system it tells me about missing terminfo data? |
|
|
15 | |
|
|
16 | The terminal description used by rxvt-unicode is not as widely available |
|
|
17 | as that for xterm, or even rxvt (for which the same problem often arises). |
|
|
18 | |
|
|
19 | The correct solution for this problem is to install the terminfo, this can |
|
|
20 | be done like this (with ncurses' infocmp): |
|
|
21 | |
|
|
22 | REMOTE=remotesystem.domain |
|
|
23 | infocmp rxvt-unicode | ssh $REMOTE "cat >/tmp/ti && tic /tmp/ti" |
|
|
24 | |
|
|
25 | ... or by installing rxvt-unicode normally on the remote system, |
|
|
26 | |
|
|
27 | If you cannot or do not want to do this, then you can simply set |
|
|
28 | C<TERM=rxvt> or even C<TERM=xterm>, and live with the small number of |
|
|
29 | problems arising, which includes wrong keymapping, less and different |
|
|
30 | colours and some refresh errors in fullscreen applications. It's a nice |
|
|
31 | quick-and-dirty workaround for rare cases, though. |
|
|
32 | |
|
|
33 | If you always want to do this you can either recompile rxvt-unicode with |
|
|
34 | the desired TERM value or use a resource to set it: |
|
|
35 | |
|
|
36 | URxvt.termName: rxvt |
|
|
37 | |
|
|
38 | If you don't plan to use B<rxvt> (quite common...) you could also replace |
|
|
39 | the rxvt terminfo file with the rxvt-unicode one. |
|
|
40 | |
|
|
41 | =item I need a termcap file entry. |
|
|
42 | |
|
|
43 | You could use rxvt's termcap entry with resonable results in many cases. |
|
|
44 | You can also create a termcap entry by using terminfo's infocmp program |
|
|
45 | like this: |
|
|
46 | |
|
|
47 | infocmp -C rxvt-unicode |
|
|
48 | |
|
|
49 | OR you could this termcap entry: |
|
|
50 | |
|
|
51 | rxvt-unicode|rxvt-unicode terminal (X Window System):\ |
|
|
52 | :am:bw:eo:km:mi:ms:xn:xo:\ |
|
|
53 | :co#80:it#8:li#24:\ |
|
|
54 | :AL=\E[%dL:DC=\E[%dP:DL=\E[%dM:DO=\E[%dB:IC=\E[%d@:\ |
|
|
55 | :K1=\EOw:K2=\EOu:K3=\EOy:K4=\EOq:K5=\EOs:LE=\E[%dD:\ |
|
|
56 | :RI=\E[%dC:SF=\E[%dS:SR=\E[%dT:UP=\E[%dA:ae=^O:al=\E[L:\ |
|
|
57 | :as=^N:bl=^G:cd=\E[J:ce=\E[K:cl=\E[H\E[2J:cm=\E[%i%d;%dH:\ |
|
|
58 | :cr=^M:cs=\E[%i%d;%dr:ct=\E[3g:dc=\E[P:dl=\E[M:do=^J:\ |
|
|
59 | :ec=\E[%dX:ei=\E[4l:ho=\E[H:i1=\E[?47l\E=\E[?1l:ic=\E[@:\ |
|
|
60 | :im=\E[4h:is=\E[r\E[m\E[2J\E[H\E[?7h\E[?1;3;4;6l\E[4l:\ |
|
|
61 | :k0=\E[21~:k1=\E[11~:k2=\E[12~:k3=\E[13~:k4=\E[14~:\ |
|
|
62 | :k5=\E[15~:k6=\E[17~:k7=\E[18~:k8=\E[19~:k9=\E[20~:\ |
|
|
63 | :kD=\E[3~:kI=\E[2~:kN=\E[6~:kP=\E[5~:kb=\177:kd=\EOB:\ |
|
|
64 | :ke=\E[?1l\E>:kh=\E[7~:kl=\EOD:kr=\EOC:ks=\E[?1h\E=:\ |
|
|
65 | :ku=\EOA:le=^H:mb=\E[5m:md=\E[1m:me=\E[m\017:mr=\E[7m:\ |
|
|
66 | :nd=\E[C:rc=\E8:sc=\E7:se=\E[27m:sf=^J:so=\E[7m:sr=\EM:\ |
|
|
67 | :st=\EH:ta=^I:te=\E[r\E[?1049l:ti=\E[?1049h:ue=\E[24m:\ |
|
|
68 | :up=\E[A:us=\E[4m:vb=\E[?5h\E[?5l:ve=\E[?25h:vi=\E[?25l:\ |
|
|
69 | :vs=\E[?25h: |
|
|
70 | |
|
|
71 | =item How can I configure rxvt-unicode so that it looks similar to the original rxvt? |
|
|
72 | |
|
|
73 | Felix von Leitner says that these two lines, in your F<.Xdefaults>, will make rxvt-unicode |
|
|
74 | behave similar to the original rxvt: |
|
|
75 | |
|
|
76 | URxvt.font: -misc-fixed-medium-r-semicondensed--13-120-75-75-c-60-iso8859-1 |
|
|
77 | URxvt.boldFont: -misc-fixed-bold-r-semicondensed--13-120-75-75-c-60-iso8859-1 |
|
|
78 | |
|
|
79 | =item Rxvt-unicode does not seem to understand the selected encoding? |
|
|
80 | |
|
|
81 | =item Unicode does not seem to work? |
|
|
82 | |
|
|
83 | If you encounter strange problems like typing an accented character but |
|
|
84 | getting two unrelated other characters or similar, or if program output is |
|
|
85 | subtly garbled, then you should check your locale settings. |
|
|
86 | |
|
|
87 | Rxvt-unicode must be started with the same C<LC_CTYPE> setting as the |
|
|
88 | programs. Often rxvt-unicode is started in the C<C> locale, while the |
|
|
89 | login script running within the rxvt-unicode window changes the locale to |
|
|
90 | sth. else, e.h. C<en_GB.UTF-8>. Needless to say, this is not going to work. |
|
|
91 | |
|
|
92 | The best thing is to fix your startup environment, as you will likely run |
|
|
93 | into other problems. If nothing works you can try this in your .profile. |
|
|
94 | |
|
|
95 | printf '\e]701;%s\007' "$LC_CTYPE" |
|
|
96 | |
|
|
97 | If this doesn't work, then maybe you use a C<LC_CTYPE> specification not |
|
|
98 | supported on your systems. Some systems have a C<locale> command which |
|
|
99 | displays this. If it displays sth. like: |
|
|
100 | |
|
|
101 | locale: Cannot set LC_CTYPE to default locale: ... |
|
|
102 | |
|
|
103 | Then the locale you specified is not supported on your system. |
|
|
104 | |
|
|
105 | If nothing works and you are sure that everything is set correctly then |
|
|
106 | you will need to remember a little known fact: Some programs just don't |
|
|
107 | support locales :( |
|
|
108 | |
|
|
109 | =item Why do some characters look so much different than others? |
|
|
110 | |
|
|
111 | =item How does rxvt-unicode choose fonts? |
|
|
112 | |
|
|
113 | Most fonts do not contain the full range of Unicode, which is |
|
|
114 | fine. Chances are that the font you (or the admin/package maintainer of |
|
|
115 | your system/os) have specified does not cover all the characters you want |
|
|
116 | to display. |
|
|
117 | |
|
|
118 | B<rxvt-unicode> makes a best-effort try at finding a replacement |
|
|
119 | font. Often the result is fine, but sometimes the chosen font looks |
|
|
120 | bad. Many fonts have totally strange characters that don't resemble the |
|
|
121 | correct glyph at all, and rxvt-unicode lacks the artificial intelligence |
|
|
122 | to detect that a specific glyph is wrong: it has to believe the font that |
|
|
123 | the characters it contains indeed look correct. |
|
|
124 | |
|
|
125 | In that case, select a font of your taste and add it to the font list, |
|
|
126 | e.g.: |
|
|
127 | |
|
|
128 | @@RXVT_NAME@@ -fn basefont,font2,font3... |
|
|
129 | |
|
|
130 | When rxvt-unicode sees a character, it will first look at the base |
|
|
131 | font. If the base font does not contain the character, it will go to the |
|
|
132 | next font, and so on. Specifying your own fonts will also speed up this |
|
|
133 | search and use less resources within rxvt-unicode and the X-server. |
|
|
134 | |
|
|
135 | The only limitation is that all the fonts must not be larger than the base |
|
|
136 | font, as the base font defines the principal cell size, which must be the |
|
|
137 | same due to the way terminals work. |
|
|
138 | |
|
|
139 | =item Why do some chinese characters look so different than others? |
|
|
140 | |
|
|
141 | This is because there is a difference between script and language -- |
|
|
142 | rxvt-unicode does not know which language the text that is output |
|
|
143 | is, as it only knows the unicode character codes. If rxvt-unicode |
|
|
144 | first sees a japanese character, it might choose a japanese font for |
|
|
145 | it. Subsequent japanese characters will take that font. Now, many chinese |
|
|
146 | characters aren't represented in japanese fonts, so when the first |
|
|
147 | non-japanese character comes up, rxvt-unicode will look for a chinese font |
|
|
148 | -- unfortunately at this point, it will still use the japanese font for |
|
|
149 | japanese characters that are also chinese. |
|
|
150 | |
|
|
151 | The workaround is easy: just tag a chinese font at the end of your font |
|
|
152 | list (see the previous question). The key is to view the font list as |
|
|
153 | a preference list: If you expect more japanese, list a japanese font |
|
|
154 | first. If you expect more chinese, put a chinese font first. |
|
|
155 | |
|
|
156 | In the future it might be possible to switch preferences at runtime (the |
|
|
157 | internal data structure has no problem with using different fonts for |
|
|
158 | the same character at the same time, but no interface for this has been |
|
|
159 | designed yet). |
|
|
160 | |
|
|
161 | =item Why does rxvt-unicode sometimes leave pixel droppings? |
|
|
162 | |
|
|
163 | Most fonts were not designed for terminal use, which means that character |
|
|
164 | size varies a lot. A font that is otherwise fine for terminal use might |
|
|
165 | contain some characters that are simply too wide. Rxvt-unicode will avoid |
|
|
166 | these characters. For characters that are just "a bit" too wide a special |
|
|
167 | "careful" rendering mode is used that redraws adjacent characters. |
|
|
168 | |
|
|
169 | All of this requires that fonts do not lie about character sizes, |
|
|
170 | however: Xft fonts often draw glyphs larger than their acclaimed bounding |
|
|
171 | box, and rxvt-unicode has no way of detecting this (the correct way is to |
|
|
172 | ask for the character bounding box, which unfortunately is wrong in these |
|
|
173 | cases). |
|
|
174 | |
|
|
175 | It's not clear (to me at least), wether this is a bug in Xft, freetype, or |
|
|
176 | the respective font. If you encounter this problem there is no way to work |
|
|
177 | around this except by using a different font. |
|
|
178 | |
|
|
179 | All of this is not a problem when using X11 core fonts, as their bounding |
|
|
180 | box data is correct. |
|
|
181 | |
|
|
182 | =item My Compose (Multi_key) key is no longer working. |
|
|
183 | |
|
|
184 | The most common causes for this are that either your locale is not set |
|
|
185 | correctly, or you specified a B<preeditStyle> that is not supported by |
|
|
186 | your input method. For example, if you specified B<OverTheSpot> and |
|
|
187 | your input method (e.g. the default input method handling Compose keys) |
|
|
188 | does not support this (for instance because it is not visual), then |
|
|
189 | rxvt-unicode will continue without an input method. |
|
|
190 | |
|
|
191 | In this case either do not specify a B<preeditStyle> or specify more than |
|
|
192 | one pre-edit style, such as B<OverTheSpot,Root,None>. |
|
|
193 | |
|
|
194 | =item I cannot type C<Ctrl-Shift-2> to get an ASCII NUL character due to ISO 14755 |
|
|
195 | |
|
|
196 | Either try C<Ctrl-2> alone (it often is mapped to ASCII NUL even on |
|
|
197 | international keyboards) or simply use ISO 14755 support to your |
|
|
198 | advantage, typing <Ctrl-Shift-0> to get a ASCII NUL. This works for other |
|
|
199 | codes, too, such as C<Ctrl-Shift-1-d> to type the default telnet escape |
|
|
200 | character and so on. |
|
|
201 | |
|
|
202 | =item How can I keep rxvt-unicode from using reverse video so much? |
|
|
203 | |
|
|
204 | First of all, make sure you are running with the right terminfo |
|
|
205 | (C<urxvt>), which will get rid of most of these effects. Then make sure |
|
|
206 | you have specified colours for italic and bold, as otherwise rxvt-unicode |
|
|
207 | might use reverse video to simulate the effect: |
|
|
208 | |
|
|
209 | URxvt*colorBD: white |
|
|
210 | URxvt*colorIT: green |
|
|
211 | |
|
|
212 | =item Some programs assume totally weird colours (red instead of blue), how can I fix that? |
|
|
213 | |
|
|
214 | For some unexplainable reason, some programs (i.e. irssi) assume a very |
|
|
215 | weird colour palette when confronted with a terminal with more than the |
|
|
216 | standard 8 colours (rxvt-unicode supports 88). The right fix is, of |
|
|
217 | course, to fix these programs not to assume non-ISO colours without very |
|
|
218 | good reasons. |
|
|
219 | |
|
|
220 | In the meantime, you can either edit your C<urxvt> terminfo definition to |
|
|
221 | only claim 8 colour support or use C<TERM=rxvt>, which will fix colours |
|
|
222 | but keep you from using other rxvt-unicode features. |
|
|
223 | |
|
|
224 | =item I am on FreeBSD and rxvt-unicode does not seem to work at all. |
|
|
225 | |
|
|
226 | Rxvt-unicode requires the symbol C<__STDC_ISO_10646__> to be defined |
|
|
227 | in your compile environment, or an implementation that implements it, |
|
|
228 | wether it defines the symbol or not. C<__STDC_ISO_10646__> requires that |
|
|
229 | B<wchar_t> is represented as unicode. |
|
|
230 | |
|
|
231 | As you might have guessed, FreeBSD does neither define this symobl nor |
|
|
232 | does it support it. Instead, it uses it's own internal representation of |
|
|
233 | B<wchar_t>. This is, of course, completely legal. |
|
|
234 | |
|
|
235 | However, C<__STDC_ISO_10646__> is the only sane way to support |
|
|
236 | multi-language apps in an OS, as using a locale-dependent (and |
|
|
237 | non-standardized) representation of B<wchar_t> makes it impossible to |
|
|
238 | convert between B<wchar_t> (as used by X11 and your applications) and any |
|
|
239 | other encoding without implementing OS-specific-wrappers for each and |
|
|
240 | every locale. There simply are no APIs to convert B<wchar_t> into anything |
|
|
241 | except the current locale encoding. |
|
|
242 | |
|
|
243 | Some applications (such as the formidable B<mlterm>) work around this |
|
|
244 | by carrying their own replacement functions for character set handling |
|
|
245 | with them, and either implementing OS-dependent hacks or doing multiple |
|
|
246 | conversions (which is slow and unreliable in case the OS implements |
|
|
247 | encodings slightly different than the terminal emulator). |
|
|
248 | |
|
|
249 | The rxvt-unicode author insists that the right way to fix this is in the |
|
|
250 | system libraries once and for all, instead of forcing every app to carry |
|
|
251 | complete replacements. |
|
|
252 | |
|
|
253 | =item How does rxvt-unicode determine the encoding to use? |
|
|
254 | |
|
|
255 | =item Is there an option to switch encodings? |
|
|
256 | |
|
|
257 | Unlike some other terminals, rxvt-unicode has no encoding switch, and no |
|
|
258 | specific "utf-8" mode, such as xterm. In fact, it doesn't even know about |
|
|
259 | UTF-8 or any other encodings with respect to terminal I/O. |
|
|
260 | |
|
|
261 | The reasons is that there exists a perfectly fine mechanism for selecting |
|
|
262 | the encoding, doing I/O and (most important) communicating this to all |
|
|
263 | applications so everybody agrees on character properties such as width and |
|
|
264 | code number. This mechanism is the I<locale>. |
|
|
265 | |
|
|
266 | Rxvt-unicode uses the C<LC_CTYPE> locale category to select encoding. All |
|
|
267 | programs doing the same (that is, most) will automatically agree in the |
|
|
268 | interpretation of characters. |
|
|
269 | |
|
|
270 | Unfortunately, there is no system-independent way to select locales, nor |
|
|
271 | is there a standard on how locale specifiers will look like. |
|
|
272 | |
|
|
273 | On most systems, the content of the C<LC_CTYPE> environment variable |
|
|
274 | contains an arbitrary string which corresponds to an already-installed |
|
|
275 | locale. Common names for locales are C<en_US.UTF-8>, C<de_DE.ISO-8859-15>, |
|
|
276 | C<ja_JP.EUC-JP>, i.e. C<language_country.encoding>, but other forms |
|
|
277 | (i.e. C<de> or C<german>) are also common. |
|
|
278 | |
|
|
279 | Rxvt-unicode ignores all other locale categories, and except for |
|
|
280 | the encoding, ignores country or language-specific settings, |
|
|
281 | i.e. C<de_DE.UTF-8> and C<ja_JP.UTF-8> are the same for rxvt-unicode. |
|
|
282 | |
|
|
283 | If you want to use a specific encoding you have to make sure you start |
|
|
284 | rxvt-unicode with the correct C<LC_CTYPE> category. |
|
|
285 | |
|
|
286 | =item Can I switch locales at runtime? |
|
|
287 | |
|
|
288 | Yes, using an escape sequence. Try sth. like this, which sets |
|
|
289 | rxvt-unicode's idea of C<LC_CTYPE>. |
|
|
290 | |
|
|
291 | printf '\e]701;%s\007' ja_JP.SJIS |
|
|
292 | |
|
|
293 | See also the previous question. |
|
|
294 | |
|
|
295 | Sometimes this capability is rather handy when you want to work in one |
|
|
296 | locale (e.g. C<de_DE.UTF-8>) but some programs don't support UTF-8. For |
|
|
297 | example, I use this script to start C<xjdic>, which first switches to a |
|
|
298 | locale supported by xjdic and back later: |
|
|
299 | |
|
|
300 | printf '\e]701;%s\007' ja_JP.SJIS |
|
|
301 | xjdic -js |
|
|
302 | printf '\e]701;%s\007' de_DE.UTF-8 |
|
|
303 | |
|
|
304 | =item Can I switch the fonts at runtime? |
|
|
305 | |
|
|
306 | Yes, using an escape sequence. Try sth. like this, which has the same |
|
|
307 | effect as using the C<-fn> switch, and takes effect immediately: |
|
|
308 | |
|
|
309 | printf '\e]50;%s\007' "9x15bold,xft:Kochi Gothic" |
|
|
310 | |
|
|
311 | This is useful if you e.g. work primarily with japanese (and prefer a |
|
|
312 | japanese font), but you have to switch to chinese temporarily, where |
|
|
313 | japanese fonts would only be in your way. |
|
|
314 | |
|
|
315 | You can think of this as a kind of manual ISO-2022 switching. |
|
|
316 | |
|
|
317 | =item Why do italic characters look as if clipped? |
|
|
318 | |
|
|
319 | Many fonts have difficulties with italic characters and hinting. For |
|
|
320 | example, the otherwise very nicely hinted font C<xft:Bitstream Vera Sans |
|
|
321 | Mono> completely fails in it's italic face. A workaround is to enable |
|
|
322 | freetype autohinting, i.e. like this: |
|
|
323 | |
|
|
324 | URxvt*italicFont: xft:Bitstream Vera Sans Mono:italic:autohint=true |
|
|
325 | URxvt*boldItalicFont: xft:Bitstream Vera Sans Mono:bold:italic:autohint=true |
|
|
326 | |
|
|
327 | =item My input method wants <some encoding> but I want UTF-8, what can I do? |
|
|
328 | |
|
|
329 | You can specify separate locales for the input method and the rest of the |
|
|
330 | terminal, using the resource C<imlocale>: |
|
|
331 | |
|
|
332 | URxvt*imlocale: ja_JP.EUC-JP |
|
|
333 | |
|
|
334 | Now you can start your terminal with C<LC_CTYPE=ja_JP.UTF-8> and still |
|
|
335 | use your input method. Please note, however, that you will not be able to |
|
|
336 | input characters outside C<EUC-JP> in a normal way then, as your input |
|
|
337 | method limits you. |
|
|
338 | |
|
|
339 | =item Rxvt-unicode uses gobs of memory, how can I reduce that? |
58 | =head3 Rxvt-unicode uses gobs of memory, how can I reduce that? |
340 | |
59 | |
341 | Rxvt-unicode tries to obey the rule of not charging you for sth. you |
60 | Rxvt-unicode tries to obey the rule of not charging you for something you |
342 | don't use. One thing you should try is to configure out all settings that |
61 | don't use. One thing you should try is to configure out all settings that |
343 | you don't need, for example, Xft support is a resource hog by design, |
62 | you don't need, for example, Xft support is a resource hog by design, |
344 | when used. Compiling it out ensures that no Xft font will be loaded |
63 | when used. Compiling it out ensures that no Xft font will be loaded |
345 | accidentally when rxvt-unicode tries to find a font for your characters. |
64 | accidentally when rxvt-unicode tries to find a font for your characters. |
346 | |
65 | |
… | |
… | |
349 | 6 bytes per screen cell. For a 160x?? window this amounts to almost a |
68 | 6 bytes per screen cell. For a 160x?? window this amounts to almost a |
350 | kilobyte per line. A scrollback buffer of 10000 lines will then (if full) |
69 | kilobyte per line. A scrollback buffer of 10000 lines will then (if full) |
351 | use 10 Megabytes of memory. With C<--enable-unicode3> it gets worse, as |
70 | use 10 Megabytes of memory. With C<--enable-unicode3> it gets worse, as |
352 | rxvt-unicode then uses 8 bytes per screen cell. |
71 | rxvt-unicode then uses 8 bytes per screen cell. |
353 | |
72 | |
|
|
73 | =head3 How can I start @@RXVT_NAME@@d in a race-free way? |
|
|
74 | |
|
|
75 | Try C<@@RXVT_NAME@@d -f -o>, which tells @@RXVT_NAME@@d to open the |
|
|
76 | display, create the listening socket and then fork. |
|
|
77 | |
|
|
78 | =head3 How do I distinguish wether I'm running rxvt-unicode or a regular xterm? I need this to decide about setting colors etc. |
|
|
79 | |
|
|
80 | rxvt and rxvt-unicode always export the variable "COLORTERM", so you can |
|
|
81 | check and see if that is set. Note that several programs, JED, slrn, |
|
|
82 | Midnight Commander automatically check this variable to decide whether or |
|
|
83 | not to use color. |
|
|
84 | |
|
|
85 | =head3 How do I set the correct, full IP address for the DISPLAY variable? |
|
|
86 | |
|
|
87 | If you've compiled rxvt-unicode with DISPLAY_IS_IP and have enabled |
|
|
88 | insecure mode then it is possible to use the following shell script |
|
|
89 | snippets to correctly set the display. If your version of rxvt-unicode |
|
|
90 | wasn't also compiled with ESCZ_ANSWER (as assumed in these snippets) then |
|
|
91 | the COLORTERM variable can be used to distinguish rxvt-unicode from a |
|
|
92 | regular xterm. |
|
|
93 | |
|
|
94 | Courtesy of Chuck Blake <cblake@BBN.COM> with the following shell script |
|
|
95 | snippets: |
|
|
96 | |
|
|
97 | # Bourne/Korn/POSIX family of shells: |
|
|
98 | [ ${TERM:-foo} = foo ] && TERM=xterm # assume an xterm if we don't know |
|
|
99 | if [ ${TERM:-foo} = xterm ]; then |
|
|
100 | stty -icanon -echo min 0 time 15 # see if enhanced rxvt or not |
|
|
101 | echo -n '^[Z' |
|
|
102 | read term_id |
|
|
103 | stty icanon echo |
|
|
104 | if [ ""${term_id} = '^[[?1;2C' -a ${DISPLAY:-foo} = foo ]; then |
|
|
105 | echo -n '^[[7n' # query the rxvt we are in for the DISPLAY string |
|
|
106 | read DISPLAY # set it in our local shell |
|
|
107 | fi |
|
|
108 | fi |
|
|
109 | |
|
|
110 | =head3 How do I compile the manual pages on my own? |
|
|
111 | |
|
|
112 | You need to have a recent version of perl installed as F</usr/bin/perl>, |
|
|
113 | one that comes with F<pod2man>, F<pod2text> and F<pod2html>. Then go to |
|
|
114 | the doc subdirectory and enter C<make alldoc>. |
|
|
115 | |
|
|
116 | =head3 Isn't rxvt-unicode supposed to be small? Don't all those features bloat? |
|
|
117 | |
|
|
118 | I often get asked about this, and I think, no, they didn't cause extra |
|
|
119 | bloat. If you compare a minimal rxvt and a minimal urxvt, you can see |
|
|
120 | that the urxvt binary is larger (due to some encoding tables always being |
|
|
121 | compiled in), but it actually uses less memory (RSS) after startup. Even |
|
|
122 | with C<--disable-everything>, this comparison is a bit unfair, as many |
|
|
123 | features unique to urxvt (locale, encoding conversion, iso14755 etc.) are |
|
|
124 | already in use in this mode. |
|
|
125 | |
|
|
126 | text data bss drs rss filename |
|
|
127 | 98398 1664 24 15695 1824 rxvt --disable-everything |
|
|
128 | 188985 9048 66616 18222 1788 urxvt --disable-everything |
|
|
129 | |
|
|
130 | When you C<--enable-everything> (which _is_ unfair, as this involves xft |
|
|
131 | and full locale/XIM support which are quite bloaty inside libX11 and my |
|
|
132 | libc), the two diverge, but not unreasnobaly so. |
|
|
133 | |
|
|
134 | text data bss drs rss filename |
|
|
135 | 163431 2152 24 20123 2060 rxvt --enable-everything |
|
|
136 | 1035683 49680 66648 29096 3680 urxvt --enable-everything |
|
|
137 | |
|
|
138 | The very large size of the text section is explained by the east-asian |
|
|
139 | encoding tables, which, if unused, take up disk space but nothing else |
|
|
140 | and can be compiled out unless you rely on X11 core fonts that use those |
|
|
141 | encodings. The BSS size comes from the 64k emergency buffer that my c++ |
|
|
142 | compiler allocates (but of course doesn't use unless you are out of |
|
|
143 | memory). Also, using an xft font instead of a core font immediately adds a |
|
|
144 | few megabytes of RSS. Xft indeed is responsible for a lot of RSS even when |
|
|
145 | not used. |
|
|
146 | |
|
|
147 | Of course, due to every character using two or four bytes instead of one, |
|
|
148 | a large scrollback buffer will ultimately make rxvt-unicode use more |
|
|
149 | memory. |
|
|
150 | |
|
|
151 | Compared to e.g. Eterm (5112k), aterm (3132k) and xterm (4680k), this |
|
|
152 | still fares rather well. And compared to some monsters like gnome-terminal |
|
|
153 | (21152k + extra 4204k in separate processes) or konsole (22200k + extra |
|
|
154 | 43180k in daemons that stay around after exit, plus half a minute of |
|
|
155 | startup time, including the hundreds of warnings it spits out), it fares |
|
|
156 | extremely well *g*. |
|
|
157 | |
|
|
158 | =head3 Why C++, isn't that unportable/bloated/uncool? |
|
|
159 | |
|
|
160 | Is this a question? :) It comes up very often. The simple answer is: I had |
|
|
161 | to write it, and C++ allowed me to write and maintain it in a fraction |
|
|
162 | of the time and effort (which is a scarce resource for me). Put even |
|
|
163 | shorter: It simply wouldn't exist without C++. |
|
|
164 | |
|
|
165 | My personal stance on this is that C++ is less portable than C, but in |
|
|
166 | the case of rxvt-unicode this hardly matters, as its portability limits |
|
|
167 | are defined by things like X11, pseudo terminals, locale support and unix |
|
|
168 | domain sockets, which are all less portable than C++ itself. |
|
|
169 | |
|
|
170 | Regarding the bloat, see the above question: It's easy to write programs |
|
|
171 | in C that use gobs of memory, an certainly possible to write programs in |
|
|
172 | C++ that don't. C++ also often comes with large libraries, but this is |
|
|
173 | not necessarily the case with GCC. Here is what rxvt links against on my |
|
|
174 | system with a minimal config: |
|
|
175 | |
|
|
176 | libX11.so.6 => /usr/X11R6/lib/libX11.so.6 (0x00002aaaaabc3000) |
|
|
177 | libc.so.6 => /lib/libc.so.6 (0x00002aaaaadde000) |
|
|
178 | libdl.so.2 => /lib/libdl.so.2 (0x00002aaaab01d000) |
|
|
179 | /lib64/ld-linux-x86-64.so.2 (0x00002aaaaaaab000) |
|
|
180 | |
|
|
181 | And here is rxvt-unicode: |
|
|
182 | |
|
|
183 | libX11.so.6 => /usr/X11R6/lib/libX11.so.6 (0x00002aaaaabc3000) |
|
|
184 | libgcc_s.so.1 => /lib/libgcc_s.so.1 (0x00002aaaaada2000) |
|
|
185 | libc.so.6 => /lib/libc.so.6 (0x00002aaaaaeb0000) |
|
|
186 | libdl.so.2 => /lib/libdl.so.2 (0x00002aaaab0ee000) |
|
|
187 | /lib64/ld-linux-x86-64.so.2 (0x00002aaaaaaab000) |
|
|
188 | |
|
|
189 | No large bloated libraries (of course, none were linked in statically), |
|
|
190 | except maybe libX11 :) |
|
|
191 | |
|
|
192 | |
|
|
193 | =head2 Rendering, Font & Look and Feel Issues |
|
|
194 | |
|
|
195 | =head3 I can't get transparency working, what am I doing wrong? |
|
|
196 | |
|
|
197 | First of all, transparency isn't officially supported in rxvt-unicode, so |
|
|
198 | you are mostly on your own. Do not bug the author about it (but you may |
|
|
199 | bug everybody else). Also, if you can't get it working consider it a rite |
|
|
200 | of passage: ... and you failed. |
|
|
201 | |
|
|
202 | Here are four ways to get transparency. B<Do> read the manpage and option |
|
|
203 | descriptions for the programs mentioned and rxvt-unicode. Really, do it! |
|
|
204 | |
|
|
205 | 1. Use inheritPixmap: |
|
|
206 | |
|
|
207 | Esetroot wallpaper.jpg |
|
|
208 | @@RXVT_NAME@@ -ip -tint red -sh 40 |
|
|
209 | |
|
|
210 | That works. If you think it doesn't, you lack transparency and tinting |
|
|
211 | support, or you are unable to read. |
|
|
212 | |
|
|
213 | 2. Use a simple pixmap and emulate pseudo-transparency. This enables you |
|
|
214 | to use effects other than tinting and shading: Just shade/tint/whatever |
|
|
215 | your picture with gimp or any other tool: |
|
|
216 | |
|
|
217 | convert wallpaper.jpg -blur 20x20 -modulate 30 background.xpm |
|
|
218 | @@RXVT_NAME@@ -pixmap background.xpm -pe automove-background |
|
|
219 | |
|
|
220 | That works. If you think it doesn't, you lack XPM and Perl support, or you |
|
|
221 | are unable to read. |
|
|
222 | |
|
|
223 | 3. Use an ARGB visual: |
|
|
224 | |
|
|
225 | @@RXVT_NAME@@ -depth 32 -fg grey90 -bg rgba:0000/0000/4444/cccc |
|
|
226 | |
|
|
227 | This requires XFT support, and the support of your X-server. If that |
|
|
228 | doesn't work for you, blame Xorg and Keith Packard. ARGB visuals aren't |
|
|
229 | there yet, no matter what they claim. Rxvt-Unicode contains the neccessary |
|
|
230 | bugfixes and workarounds for Xft and Xlib to make it work, but that |
|
|
231 | doesn't mean that your WM has the required kludges in place. |
|
|
232 | |
|
|
233 | 4. Use xcompmgr and let it do the job: |
|
|
234 | |
|
|
235 | xprop -frame -f _NET_WM_WINDOW_OPACITY 32c \ |
|
|
236 | -set _NET_WM_WINDOW_OPACITY 0xc0000000 |
|
|
237 | |
|
|
238 | Then click on a window you want to make transparent. Replace C<0xc0000000> |
|
|
239 | by other values to change the degree of opacity. If it doesn't work and |
|
|
240 | your server crashes, you got to keep the pieces. |
|
|
241 | |
|
|
242 | =head3 Why do some chinese characters look so different than others? |
|
|
243 | |
|
|
244 | This is because there is a difference between script and language -- |
|
|
245 | rxvt-unicode does not know which language the text that is output is, |
|
|
246 | as it only knows the unicode character codes. If rxvt-unicode first |
|
|
247 | sees a japanese/chinese character, it might choose a japanese font for |
|
|
248 | display. Subsequent japanese characters will use that font. Now, many |
|
|
249 | chinese characters aren't represented in japanese fonts, so when the first |
|
|
250 | non-japanese character comes up, rxvt-unicode will look for a chinese font |
|
|
251 | -- unfortunately at this point, it will still use the japanese font for |
|
|
252 | chinese characters that are also in the japanese font. |
|
|
253 | |
|
|
254 | The workaround is easy: just tag a chinese font at the end of your font |
|
|
255 | list (see the previous question). The key is to view the font list as |
|
|
256 | a preference list: If you expect more japanese, list a japanese font |
|
|
257 | first. If you expect more chinese, put a chinese font first. |
|
|
258 | |
|
|
259 | In the future it might be possible to switch language preferences at |
|
|
260 | runtime (the internal data structure has no problem with using different |
|
|
261 | fonts for the same character at the same time, but no interface for this |
|
|
262 | has been designed yet). |
|
|
263 | |
|
|
264 | Until then, you might get away with switching fonts at runtime (see L<Can |
|
|
265 | I switch the fonts at runtime?> later in this document). |
|
|
266 | |
|
|
267 | =head3 Why does rxvt-unicode sometimes leave pixel droppings? |
|
|
268 | |
|
|
269 | Most fonts were not designed for terminal use, which means that character |
|
|
270 | size varies a lot. A font that is otherwise fine for terminal use might |
|
|
271 | contain some characters that are simply too wide. Rxvt-unicode will avoid |
|
|
272 | these characters. For characters that are just "a bit" too wide a special |
|
|
273 | "careful" rendering mode is used that redraws adjacent characters. |
|
|
274 | |
|
|
275 | All of this requires that fonts do not lie about character sizes, |
|
|
276 | however: Xft fonts often draw glyphs larger than their acclaimed bounding |
|
|
277 | box, and rxvt-unicode has no way of detecting this (the correct way is to |
|
|
278 | ask for the character bounding box, which unfortunately is wrong in these |
|
|
279 | cases). |
|
|
280 | |
|
|
281 | It's not clear (to me at least), wether this is a bug in Xft, freetype, |
|
|
282 | or the respective font. If you encounter this problem you might try using |
|
|
283 | the C<-lsp> option to give the font more height. If that doesn't work, you |
|
|
284 | might be forced to use a different font. |
|
|
285 | |
|
|
286 | All of this is not a problem when using X11 core fonts, as their bounding |
|
|
287 | box data is correct. |
|
|
288 | |
|
|
289 | =head3 How can I keep rxvt-unicode from using reverse video so much? |
|
|
290 | |
|
|
291 | First of all, make sure you are running with the right terminal settings |
|
|
292 | (C<TERM=rxvt-unicode>), which will get rid of most of these effects. Then |
|
|
293 | make sure you have specified colours for italic and bold, as otherwise |
|
|
294 | rxvt-unicode might use reverse video to simulate the effect: |
|
|
295 | |
|
|
296 | URxvt.colorBD: white |
|
|
297 | URxvt.colorIT: green |
|
|
298 | |
|
|
299 | =head3 Some programs assume totally weird colours (red instead of blue), how can I fix that? |
|
|
300 | |
|
|
301 | For some unexplainable reason, some rare programs assume a very weird |
|
|
302 | colour palette when confronted with a terminal with more than the standard |
|
|
303 | 8 colours (rxvt-unicode supports 88). The right fix is, of course, to fix |
|
|
304 | these programs not to assume non-ISO colours without very good reasons. |
|
|
305 | |
|
|
306 | In the meantime, you can either edit your C<rxvt-unicode> terminfo |
|
|
307 | definition to only claim 8 colour support or use C<TERM=rxvt>, which will |
|
|
308 | fix colours but keep you from using other rxvt-unicode features. |
|
|
309 | |
|
|
310 | =head3 Can I switch the fonts at runtime? |
|
|
311 | |
|
|
312 | Yes, using an escape sequence. Try something like this, which has the same |
|
|
313 | effect as using the C<-fn> switch, and takes effect immediately: |
|
|
314 | |
|
|
315 | printf '\e]50;%s\007' "9x15bold,xft:Kochi Gothic" |
|
|
316 | |
|
|
317 | This is useful if you e.g. work primarily with japanese (and prefer a |
|
|
318 | japanese font), but you have to switch to chinese temporarily, where |
|
|
319 | japanese fonts would only be in your way. |
|
|
320 | |
|
|
321 | You can think of this as a kind of manual ISO-2022 switching. |
|
|
322 | |
|
|
323 | =head3 Why do italic characters look as if clipped? |
|
|
324 | |
|
|
325 | Many fonts have difficulties with italic characters and hinting. For |
|
|
326 | example, the otherwise very nicely hinted font C<xft:Bitstream Vera Sans |
|
|
327 | Mono> completely fails in it's italic face. A workaround might be to |
|
|
328 | enable freetype autohinting, i.e. like this: |
|
|
329 | |
|
|
330 | URxvt.italicFont: xft:Bitstream Vera Sans Mono:italic:autohint=true |
|
|
331 | URxvt.boldItalicFont: xft:Bitstream Vera Sans Mono:bold:italic:autohint=true |
|
|
332 | |
354 | =item Can I speed up Xft rendering somehow? |
333 | =head3 Can I speed up Xft rendering somehow? |
355 | |
334 | |
356 | Yes, the most obvious way to speed it up is to avoid Xft entirely, as |
335 | Yes, the most obvious way to speed it up is to avoid Xft entirely, as |
357 | it is simply slow. If you still want Xft fonts you might try to disable |
336 | it is simply slow. If you still want Xft fonts you might try to disable |
358 | antialiasing (by appending C<:antialiasing=false>), which saves lots of |
337 | antialiasing (by appending C<:antialias=false>), which saves lots of |
359 | memory and also speeds up rendering considerably. |
338 | memory and also speeds up rendering considerably. |
360 | |
339 | |
361 | =item Rxvt-unicode doesn't seem to anti-alias its fonts, what is wrong? |
340 | =head3 Rxvt-unicode doesn't seem to anti-alias its fonts, what is wrong? |
362 | |
341 | |
363 | Rxvt-unicode will use whatever you specify as a font. If it needs to |
342 | Rxvt-unicode will use whatever you specify as a font. If it needs to |
364 | fall back to it's default font search list it will prefer X11 core |
343 | fall back to it's default font search list it will prefer X11 core |
365 | fonts, because they are small and fast, and then use Xft fonts. It has |
344 | fonts, because they are small and fast, and then use Xft fonts. It has |
366 | antialiasing disabled for most of them, because the author thinks they |
345 | antialiasing disabled for most of them, because the author thinks they |
367 | look best that way. |
346 | look best that way. |
368 | |
347 | |
369 | If you want antialiasing, you have to specify the fonts manually. |
348 | If you want antialiasing, you have to specify the fonts manually. |
370 | |
349 | |
371 | =item Mouse cut/paste suddenly no longer works. |
|
|
372 | |
|
|
373 | Make sure that mouse reporting is actually turned off since killing |
|
|
374 | some editors prematurely may leave the mouse in mouse report mode. I've |
|
|
375 | heard that tcsh may use mouse reporting unless it otherwise specified. A |
|
|
376 | quick check is to see if cut/paste works when the Alt or Shift keys are |
|
|
377 | depressed. See @@RXVT_NAME@@(7) |
|
|
378 | |
|
|
379 | =item What's with this bold/blink stuff? |
350 | =head3 What's with this bold/blink stuff? |
380 | |
351 | |
381 | If no bold colour is set via C<colorBD:>, bold will invert text using the |
352 | If no bold colour is set via C<colorBD:>, bold will invert text using the |
382 | standard foreground colour. |
353 | standard foreground colour. |
383 | |
354 | |
384 | For the standard background colour, blinking will actually make the |
355 | For the standard background colour, blinking will actually make the |
… | |
… | |
391 | |
362 | |
392 | color0-7 are the low-intensity colors. |
363 | color0-7 are the low-intensity colors. |
393 | |
364 | |
394 | color8-15 are the corresponding high-intensity colors. |
365 | color8-15 are the corresponding high-intensity colors. |
395 | |
366 | |
396 | =item I don't like the screen colors. How do I change them? |
367 | =head3 I don't like the screen colors. How do I change them? |
397 | |
368 | |
398 | You can change the screen colors at run-time using F<~/.Xdefaults> |
369 | You can change the screen colors at run-time using F<~/.Xdefaults> |
399 | resources (or as long-options). |
370 | resources (or as long-options). |
400 | |
371 | |
401 | Here are values that are supposed to resemble a VGA screen, |
372 | Here are values that are supposed to resemble a VGA screen, |
402 | including the murky brown that passes for low-intensity yellow: |
373 | including the murky brown that passes for low-intensity yellow: |
403 | |
374 | |
404 | URxvt*color0: #000000 |
375 | URxvt.color0: #000000 |
405 | URxvt*color1: #A80000 |
376 | URxvt.color1: #A80000 |
406 | URxvt*color2: #00A800 |
377 | URxvt.color2: #00A800 |
407 | URxvt*color3: #A8A800 |
378 | URxvt.color3: #A8A800 |
408 | URxvt*color4: #0000A8 |
379 | URxvt.color4: #0000A8 |
409 | URxvt*color5: #A800A8 |
380 | URxvt.color5: #A800A8 |
410 | URxvt*color6: #00A8A8 |
381 | URxvt.color6: #00A8A8 |
411 | URxvt*color7: #A8A8A8 |
382 | URxvt.color7: #A8A8A8 |
412 | |
383 | |
413 | URxvt*color8: #000054 |
384 | URxvt.color8: #000054 |
414 | URxvt*color9: #FF0054 |
385 | URxvt.color9: #FF0054 |
415 | URxvt*color10: #00FF54 |
386 | URxvt.color10: #00FF54 |
416 | URxvt*color11: #FFFF54 |
387 | URxvt.color11: #FFFF54 |
417 | URxvt*color12: #0000FF |
388 | URxvt.color12: #0000FF |
418 | URxvt*color13: #FF00FF |
389 | URxvt.color13: #FF00FF |
419 | URxvt*color14: #00FFFF |
390 | URxvt.color14: #00FFFF |
420 | URxvt*color15: #FFFFFF |
391 | URxvt.color15: #FFFFFF |
421 | |
392 | |
422 | And here is a more complete set of non-standard colors described as |
393 | And here is a more complete set of non-standard colors described (not by |
423 | "pretty girly": |
394 | me) as "pretty girly". |
424 | |
395 | |
425 | URxvt.cursorColor: #dc74d1 |
396 | URxvt.cursorColor: #dc74d1 |
426 | URxvt.pointerColor: #dc74d1 |
397 | URxvt.pointerColor: #dc74d1 |
427 | URxvt.background: #0e0e0e |
398 | URxvt.background: #0e0e0e |
428 | URxvt.foreground: #4ad5e1 |
399 | URxvt.foreground: #4ad5e1 |
… | |
… | |
439 | URxvt.color6: #73f7ff |
410 | URxvt.color6: #73f7ff |
440 | URxvt.color14: #73f7ff |
411 | URxvt.color14: #73f7ff |
441 | URxvt.color7: #e1dddd |
412 | URxvt.color7: #e1dddd |
442 | URxvt.color15: #e1dddd |
413 | URxvt.color15: #e1dddd |
443 | |
414 | |
|
|
415 | =head3 Why do some characters look so much different than others? |
|
|
416 | |
|
|
417 | See next entry. |
|
|
418 | |
|
|
419 | =head3 How does rxvt-unicode choose fonts? |
|
|
420 | |
|
|
421 | Most fonts do not contain the full range of Unicode, which is |
|
|
422 | fine. Chances are that the font you (or the admin/package maintainer of |
|
|
423 | your system/os) have specified does not cover all the characters you want |
|
|
424 | to display. |
|
|
425 | |
|
|
426 | B<rxvt-unicode> makes a best-effort try at finding a replacement |
|
|
427 | font. Often the result is fine, but sometimes the chosen font looks |
|
|
428 | bad/ugly/wrong. Some fonts have totally strange characters that don't |
|
|
429 | resemble the correct glyph at all, and rxvt-unicode lacks the artificial |
|
|
430 | intelligence to detect that a specific glyph is wrong: it has to believe |
|
|
431 | the font that the characters it claims to contain indeed look correct. |
|
|
432 | |
|
|
433 | In that case, select a font of your taste and add it to the font list, |
|
|
434 | e.g.: |
|
|
435 | |
|
|
436 | @@RXVT_NAME@@ -fn basefont,font2,font3... |
|
|
437 | |
|
|
438 | When rxvt-unicode sees a character, it will first look at the base |
|
|
439 | font. If the base font does not contain the character, it will go to the |
|
|
440 | next font, and so on. Specifying your own fonts will also speed up this |
|
|
441 | search and use less resources within rxvt-unicode and the X-server. |
|
|
442 | |
|
|
443 | The only limitation is that none of the fonts may be larger than the base |
|
|
444 | font, as the base font defines the terminal character cell size, which |
|
|
445 | must be the same due to the way terminals work. |
|
|
446 | |
|
|
447 | |
|
|
448 | =head2 Keyboard, Mouse & User Interaction |
|
|
449 | |
|
|
450 | =head3 The new selection selects pieces that are too big, how can I select single words? |
|
|
451 | |
|
|
452 | If you want to select e.g. alphanumeric words, you can use the following |
|
|
453 | setting: |
|
|
454 | |
|
|
455 | URxvt.selection.pattern-0: ([[:word:]]+) |
|
|
456 | |
|
|
457 | If you click more than twice, the selection will be extended |
|
|
458 | more and more. |
|
|
459 | |
|
|
460 | To get a selection that is very similar to the old code, try this pattern: |
|
|
461 | |
|
|
462 | URxvt.selection.pattern-0: ([^"&'()*,;<=>?@[\\\\]^`{|})]+) |
|
|
463 | |
|
|
464 | Please also note that the I<LeftClick Shift-LeftClik> combination also |
|
|
465 | selects words like the old code. |
|
|
466 | |
|
|
467 | =head3 I don't like the new selection/popups/hotkeys/perl, how do I change/disable it? |
|
|
468 | |
|
|
469 | You can disable the perl extension completely by setting the |
|
|
470 | B<perl-ext-common> resource to the empty string, which also keeps |
|
|
471 | rxvt-unicode from initialising perl, saving memory. |
|
|
472 | |
|
|
473 | If you only want to disable specific features, you first have to |
|
|
474 | identify which perl extension is responsible. For this, read the section |
|
|
475 | B<PREPACKAGED EXTENSIONS> in the @@RXVT_NAME@@perl(3) manpage. For |
|
|
476 | example, to disable the B<selection-popup> and B<option-popup>, specify |
|
|
477 | this B<perl-ext-common> resource: |
|
|
478 | |
|
|
479 | URxvt.perl-ext-common: default,-selection-popup,-option-popup |
|
|
480 | |
|
|
481 | This will keep the default extensions, but disable the two popup |
|
|
482 | extensions. Some extensions can also be configured, for example, |
|
|
483 | scrollback search mode is triggered by B<M-s>. You can move it to any |
|
|
484 | other combination either by setting the B<searchable-scrollback> resource: |
|
|
485 | |
|
|
486 | URxvt.searchable-scrollback: CM-s |
|
|
487 | |
|
|
488 | =head3 The cursor moves when selecting text in the current input line, how do I switch this off? |
|
|
489 | |
|
|
490 | See next entry. |
|
|
491 | |
|
|
492 | =head3 During rlogin/ssh/telnet/etc. sessions, clicking near the cursor outputs strange escape sequences, how do I fix this? |
|
|
493 | |
|
|
494 | These are caused by the C<readline> perl extension. Under normal |
|
|
495 | circumstances, it will move your cursor around when you click into the |
|
|
496 | line that contains it. It tries hard not to do this at the wrong moment, |
|
|
497 | but when running a program that doesn't parse cursor movements or in some |
|
|
498 | cases during rlogin sessions, it fails to detect this properly. |
|
|
499 | |
|
|
500 | You can permamently switch this feature off by disabling the C<readline> |
|
|
501 | extension: |
|
|
502 | |
|
|
503 | URxvt.perl-ext-common: default,-readline |
|
|
504 | |
|
|
505 | =head3 My numerical keypad acts weird and generates differing output? |
|
|
506 | |
|
|
507 | Some Debian GNUL/Linux users seem to have this problem, although no |
|
|
508 | specific details were reported so far. It is possible that this is caused |
|
|
509 | by the wrong C<TERM> setting, although the details of wether and how |
|
|
510 | this can happen are unknown, as C<TERM=rxvt> should offer a compatible |
|
|
511 | keymap. See the answer to the previous question, and please report if that |
|
|
512 | helped. |
|
|
513 | |
|
|
514 | =head3 My Compose (Multi_key) key is no longer working. |
|
|
515 | |
|
|
516 | The most common causes for this are that either your locale is not set |
|
|
517 | correctly, or you specified a B<preeditStyle> that is not supported by |
|
|
518 | your input method. For example, if you specified B<OverTheSpot> and |
|
|
519 | your input method (e.g. the default input method handling Compose keys) |
|
|
520 | does not support this (for instance because it is not visual), then |
|
|
521 | rxvt-unicode will continue without an input method. |
|
|
522 | |
|
|
523 | In this case either do not specify a B<preeditStyle> or specify more than |
|
|
524 | one pre-edit style, such as B<OverTheSpot,Root,None>. |
|
|
525 | |
|
|
526 | =head3 I cannot type C<Ctrl-Shift-2> to get an ASCII NUL character due to ISO 14755 |
|
|
527 | |
|
|
528 | Either try C<Ctrl-2> alone (it often is mapped to ASCII NUL even on |
|
|
529 | international keyboards) or simply use ISO 14755 support to your |
|
|
530 | advantage, typing <Ctrl-Shift-0> to get a ASCII NUL. This works for other |
|
|
531 | codes, too, such as C<Ctrl-Shift-1-d> to type the default telnet escape |
|
|
532 | character and so on. |
|
|
533 | |
|
|
534 | =head3 Mouse cut/paste suddenly no longer works. |
|
|
535 | |
|
|
536 | Make sure that mouse reporting is actually turned off since killing |
|
|
537 | some editors prematurely may leave the mouse in mouse report mode. I've |
|
|
538 | heard that tcsh may use mouse reporting unless it otherwise specified. A |
|
|
539 | quick check is to see if cut/paste works when the Alt or Shift keys are |
|
|
540 | depressed. |
|
|
541 | |
444 | =item What's with the strange Backspace/Delete key behaviour? |
542 | =head3 What's with the strange Backspace/Delete key behaviour? |
445 | |
543 | |
446 | Assuming that the physical Backspace key corresponds to the |
544 | Assuming that the physical Backspace key corresponds to the |
447 | BackSpace keysym (not likely for Linux ... see the following |
545 | BackSpace keysym (not likely for Linux ... see the following |
448 | question) there are two standard values that can be used for |
546 | question) there are two standard values that can be used for |
449 | Backspace: C<^H> and C<^?>. |
547 | Backspace: C<^H> and C<^?>. |
… | |
… | |
466 | |
564 | |
467 | # use Backspace = ^? |
565 | # use Backspace = ^? |
468 | $ stty erase ^? |
566 | $ stty erase ^? |
469 | $ @@RXVT_NAME@@ |
567 | $ @@RXVT_NAME@@ |
470 | |
568 | |
471 | Toggle with "ESC[36h" / "ESC[36l" as documented in @@RXVT_NAME@@(7). |
569 | Toggle with C<ESC [ 36 h> / C<ESC [ 36 l>. |
472 | |
570 | |
473 | For an existing rxvt-unicode: |
571 | For an existing rxvt-unicode: |
474 | |
572 | |
475 | # use Backspace = ^H |
573 | # use Backspace = ^H |
476 | $ stty erase ^H |
574 | $ stty erase ^H |
… | |
… | |
485 | properly reflects that. |
583 | properly reflects that. |
486 | |
584 | |
487 | The Delete key is a another casualty of the ill-defined Backspace problem. |
585 | The Delete key is a another casualty of the ill-defined Backspace problem. |
488 | To avoid confusion between the Backspace and Delete keys, the Delete |
586 | To avoid confusion between the Backspace and Delete keys, the Delete |
489 | key has been assigned an escape sequence to match the vt100 for Execute |
587 | key has been assigned an escape sequence to match the vt100 for Execute |
490 | (ESC[3~) and is in the supplied termcap/terminfo. |
588 | (C<ESC [ 3 ~>) and is in the supplied termcap/terminfo. |
491 | |
589 | |
492 | Some other Backspace problems: |
590 | Some other Backspace problems: |
493 | |
591 | |
494 | some editors use termcap/terminfo, |
592 | some editors use termcap/terminfo, |
495 | some editors (vim I'm told) expect Backspace = ^H, |
593 | some editors (vim I'm told) expect Backspace = ^H, |
496 | GNU Emacs (and Emacs-like editors) use ^H for help. |
594 | GNU Emacs (and Emacs-like editors) use ^H for help. |
497 | |
595 | |
498 | Perhaps someday this will all be resolved in a consistent manner. |
596 | Perhaps someday this will all be resolved in a consistent manner. |
499 | |
597 | |
500 | =item I don't like the key-bindings. How do I change them? |
598 | =head3 I don't like the key-bindings. How do I change them? |
501 | |
599 | |
502 | There are some compile-time selections available via configure. Unless |
600 | There are some compile-time selections available via configure. Unless |
503 | you have run "configure" with the C<--disable-resources> option you can |
601 | you have run "configure" with the C<--disable-resources> option you can |
504 | use the `keysym' resource to alter the keystrings associated with keysym |
602 | use the `keysym' resource to alter the keystrings associated with keysyms. |
505 | 0xFF00 - 0xFFFF (function, cursor keys, etc). |
|
|
506 | |
603 | |
507 | Here's an example for a tn3270 session started using `@@RXVT_NAME@@ -name tn3270' |
604 | Here's an example for a URxvt session started using C<@@RXVT_NAME@@ -name URxvt> |
508 | |
605 | |
509 | !# ----- special uses ------: |
606 | URxvt.keysym.Home: \033[1~ |
510 | ! tn3270 login, remap function and arrow keys. |
607 | URxvt.keysym.End: \033[4~ |
511 | tn3270*font: *clean-bold-*-*--15-* |
608 | URxvt.keysym.C-apostrophe: \033<C-'> |
|
|
609 | URxvt.keysym.C-slash: \033<C-/> |
|
|
610 | URxvt.keysym.C-semicolon: \033<C-;> |
|
|
611 | URxvt.keysym.C-grave: \033<C-`> |
|
|
612 | URxvt.keysym.C-comma: \033<C-,> |
|
|
613 | URxvt.keysym.C-period: \033<C-.> |
|
|
614 | URxvt.keysym.C-0x60: \033<C-`> |
|
|
615 | URxvt.keysym.C-Tab: \033<C-Tab> |
|
|
616 | URxvt.keysym.C-Return: \033<C-Return> |
|
|
617 | URxvt.keysym.S-Return: \033<S-Return> |
|
|
618 | URxvt.keysym.S-space: \033<S-Space> |
|
|
619 | URxvt.keysym.M-Up: \033<M-Up> |
|
|
620 | URxvt.keysym.M-Down: \033<M-Down> |
|
|
621 | URxvt.keysym.M-Left: \033<M-Left> |
|
|
622 | URxvt.keysym.M-Right: \033<M-Right> |
|
|
623 | URxvt.keysym.M-C-0: list \033<M-C- 0123456789 > |
|
|
624 | URxvt.keysym.M-C-a: list \033<M-C- abcdefghijklmnopqrstuvwxyz > |
|
|
625 | URxvt.keysym.F12: command:\033]701;zh_CN.GBK\007 |
512 | |
626 | |
513 | ! keysym - used by rxvt only |
627 | See some more examples in the documentation for the B<keysym> resource. |
514 | ! Delete - ^D |
|
|
515 | tn3270*keysym.0xFFFF: \004 |
|
|
516 | |
628 | |
517 | ! Home - ^A |
629 | =head3 I'm using keyboard model XXX that has extra Prior/Next/Insert keys. How do I make use of them? For example, the Sun Keyboard type 4 has the following map |
518 | tn3270*keysym.0xFF50: \001 |
|
|
519 | ! Left - ^B |
|
|
520 | tn3270*keysym.0xFF51: \002 |
|
|
521 | ! Up - ^P |
|
|
522 | tn3270*keysym.0xFF52: \020 |
|
|
523 | ! Right - ^F |
|
|
524 | tn3270*keysym.0xFF53: \006 |
|
|
525 | ! Down - ^N |
|
|
526 | tn3270*keysym.0xFF54: \016 |
|
|
527 | ! End - ^E |
|
|
528 | tn3270*keysym.0xFF57: \005 |
|
|
529 | |
|
|
530 | ! F1 - F12 |
|
|
531 | tn3270*keysym.0xFFBE: \e1 |
|
|
532 | tn3270*keysym.0xFFBF: \e2 |
|
|
533 | tn3270*keysym.0xFFC0: \e3 |
|
|
534 | tn3270*keysym.0xFFC1: \e4 |
|
|
535 | tn3270*keysym.0xFFC2: \e5 |
|
|
536 | tn3270*keysym.0xFFC3: \e6 |
|
|
537 | tn3270*keysym.0xFFC4: \e7 |
|
|
538 | tn3270*keysym.0xFFC5: \e8 |
|
|
539 | tn3270*keysym.0xFFC6: \e9 |
|
|
540 | tn3270*keysym.0xFFC7: \e0 |
|
|
541 | tn3270*keysym.0xFFC8: \e- |
|
|
542 | tn3270*keysym.0xFFC9: \e= |
|
|
543 | |
|
|
544 | ! map Prior/Next to F7/F8 |
|
|
545 | tn3270*keysym.0xFF55: \e7 |
|
|
546 | tn3270*keysym.0xFF56: \e8 |
|
|
547 | |
|
|
548 | =item I'm using keyboard model XXX that has extra Prior/Next/Insert keys. |
|
|
549 | How do I make use of them? For example, the Sun Keyboard type 4 |
|
|
550 | has the following mappings that rxvt-unicode doesn't recognize. |
|
|
551 | |
630 | |
552 | KP_Insert == Insert |
631 | KP_Insert == Insert |
553 | F22 == Print |
632 | F22 == Print |
554 | F27 == Home |
633 | F27 == Home |
555 | F29 == Prior |
634 | F29 == Prior |
556 | F33 == End |
635 | F33 == End |
557 | F35 == Next |
636 | F35 == Next |
558 | |
637 | |
559 | Rather than have rxvt-unicode try to accommodate all the various possible keyboard |
638 | Rather than have rxvt-unicode try to accommodate all the various possible |
560 | mappings, it is better to use `xmodmap' to remap the keys as required for |
639 | keyboard mappings, it is better to use `xmodmap' to remap the keys as |
561 | your particular machine. |
640 | required for your particular machine. |
562 | |
641 | |
563 | =item How do I distinguish if I'm running rxvt-unicode or a regular xterm? |
|
|
564 | I need this to decide about setting colors etc. |
|
|
565 | |
642 | |
566 | rxvt and rxvt-unicode always export the variable "COLORTERM", so you can |
|
|
567 | check and see if that is set. Note that several programs, JED, slrn, |
|
|
568 | Midnight Commander automatically check this variable to decide whether or |
|
|
569 | not to use color. |
|
|
570 | |
643 | |
571 | =item How do I set the correct, full IP address for the DISPLAY variable? |
644 | =head2 Terminal Configuration |
572 | |
645 | |
573 | If you've compiled rxvt-unicode with DISPLAY_IS_IP and have enabled |
646 | =head3 Why doesn't rxvt-unicode read my resources? |
574 | insecure mode then it is possible to use the following shell script |
|
|
575 | snippets to correctly set the display. If your version of rxvt-unicode |
|
|
576 | wasn't also compiled with ESCZ_ANSWER (as assumed in these snippets) then |
|
|
577 | the COLORTERM variable can be used to distinguish rxvt-unicode from a |
|
|
578 | regular xterm. |
|
|
579 | |
647 | |
580 | Courtesy of Chuck Blake <cblake@BBN.COM> with the following shell script |
648 | Well, why, indeed? It does, in a way very similar to other X |
581 | snippets: |
649 | applications. Most importantly, this means that if you or your OS loads |
|
|
650 | resources into the X display (the right way to do it), rxvt-unicode will |
|
|
651 | ignore any resource files in your home directory. It will only read |
|
|
652 | F<$HOME/.Xdefaults> when no resources are attached to the display. |
582 | |
653 | |
583 | # Bourne/Korn/POSIX family of shells: |
654 | If you have or use an F<$HOME/.Xresources> file, chances are that |
584 | [ ${TERM:-foo} = foo ] && TERM=xterm # assume an xterm if we don't know |
655 | resources are loaded into your X-server. In this case, you have to |
585 | if [ ${TERM:-foo} = xterm ]; then |
656 | re-login after every change (or run F<xrdb -merge $HOME/.Xresources>). |
586 | stty -icanon -echo min 0 time 15 # see if enhanced rxvt or not |
|
|
587 | echo -n '^[Z' |
|
|
588 | read term_id |
|
|
589 | stty icanon echo |
|
|
590 | if [ ""${term_id} = '^[[?1;2C' -a ${DISPLAY:-foo} = foo ]; then |
|
|
591 | echo -n '^[[7n' # query the rxvt we are in for the DISPLAY string |
|
|
592 | read DISPLAY # set it in our local shell |
|
|
593 | fi |
|
|
594 | fi |
|
|
595 | |
657 | |
596 | =item How do I compile the manual pages for myself? |
658 | Also consider the form resources have to use: |
597 | |
659 | |
598 | You need to have a recent version of perl installed as F</usr/bin/perl>, |
660 | URxvt.resource: value |
599 | one that comes with F<pod2man>, F<pod2text> and F<pod2html>. Then go to |
|
|
600 | the doc subdirectory and enter C<make alldoc>. |
|
|
601 | |
661 | |
602 | =item My question isn't answered here, can I ask a human? |
662 | If you want to use another form (there are lots of different ways of |
|
|
663 | specifying resources), make sure you understand wether and why it |
|
|
664 | works. If unsure, use the form above. |
603 | |
665 | |
604 | Before sending me mail, you could go to IRC: C<irc.freenode.net>, |
666 | =head3 When I log-in to another system it tells me about missing terminfo data? |
605 | channel C<#rxvt-unicode> has some rxvt-unicode enthusiasts that might be |
|
|
606 | interested in learning about new and exciting problems (but not FAQs :). |
|
|
607 | |
667 | |
608 | =back |
668 | The terminal description used by rxvt-unicode is not as widely available |
|
|
669 | as that for xterm, or even rxvt (for which the same problem often arises). |
609 | |
670 | |
610 | =head1 SYNOPSIS |
671 | The correct solution for this problem is to install the terminfo, this can |
|
|
672 | be done like this (with ncurses' infocmp): |
611 | |
673 | |
612 | # set a new font set |
674 | REMOTE=remotesystem.domain |
613 | printf '\33]50;%s\007' 9x15,xft:Kochi" Mincho" |
675 | infocmp rxvt-unicode | ssh $REMOTE "cat >/tmp/ti && tic /tmp/ti" |
614 | |
676 | |
615 | # change the locale and tell rxvt-unicode about it |
677 | ... or by installing rxvt-unicode normally on the remote system, |
616 | export LC_CTYPE=ja_JP.EUC-JP; printf "\33]701;$LC_CTYPE\007" |
|
|
617 | |
678 | |
618 | # set window title |
679 | If you cannot or do not want to do this, then you can simply set |
619 | printf '\33]2;%s\007' "new window title" |
680 | C<TERM=rxvt> or even C<TERM=xterm>, and live with the small number of |
|
|
681 | problems arising, which includes wrong keymapping, less and different |
|
|
682 | colours and some refresh errors in fullscreen applications. It's a nice |
|
|
683 | quick-and-dirty workaround for rare cases, though. |
|
|
684 | |
|
|
685 | If you always want to do this (and are fine with the consequences) you |
|
|
686 | can either recompile rxvt-unicode with the desired TERM value or use a |
|
|
687 | resource to set it: |
|
|
688 | |
|
|
689 | URxvt.termName: rxvt |
|
|
690 | |
|
|
691 | If you don't plan to use B<rxvt> (quite common...) you could also replace |
|
|
692 | the rxvt terminfo file with the rxvt-unicode one. |
|
|
693 | |
|
|
694 | =head3 C<tic> outputs some error when compiling the terminfo entry. |
|
|
695 | |
|
|
696 | Most likely it's the empty definition for C<enacs=>. Just replace it by |
|
|
697 | C<enacs=\E[0@> and try again. |
|
|
698 | |
|
|
699 | =head3 C<bash>'s readline does not work correctly under @@RXVT_NAME@@. |
|
|
700 | |
|
|
701 | See next entry. |
|
|
702 | |
|
|
703 | =head3 I need a termcap file entry. |
|
|
704 | |
|
|
705 | One reason you might want this is that some distributions or operating |
|
|
706 | systems still compile some programs using the long-obsoleted termcap |
|
|
707 | library (Fedora Core's bash is one example) and rely on a termcap entry |
|
|
708 | for C<rxvt-unicode>. |
|
|
709 | |
|
|
710 | You could use rxvt's termcap entry with resonable results in many cases. |
|
|
711 | You can also create a termcap entry by using terminfo's infocmp program |
|
|
712 | like this: |
|
|
713 | |
|
|
714 | infocmp -C rxvt-unicode |
|
|
715 | |
|
|
716 | Or you could use this termcap entry, generated by the command above: |
|
|
717 | |
|
|
718 | rxvt-unicode|rxvt-unicode terminal (X Window System):\ |
|
|
719 | :am:bw:eo:km:mi:ms:xn:xo:\ |
|
|
720 | :co#80:it#8:li#24:lm#0:\ |
|
|
721 | :AL=\E[%dL:DC=\E[%dP:DL=\E[%dM:DO=\E[%dB:IC=\E[%d@:\ |
|
|
722 | :K1=\EOw:K2=\EOu:K3=\EOy:K4=\EOq:K5=\EOs:LE=\E[%dD:\ |
|
|
723 | :RI=\E[%dC:SF=\E[%dS:SR=\E[%dT:UP=\E[%dA:ae=\E(B:al=\E[L:\ |
|
|
724 | :as=\E(0:bl=^G:cd=\E[J:ce=\E[K:cl=\E[H\E[2J:\ |
|
|
725 | :cm=\E[%i%d;%dH:cr=^M:cs=\E[%i%d;%dr:ct=\E[3g:dc=\E[P:\ |
|
|
726 | :dl=\E[M:do=^J:ec=\E[%dX:ei=\E[4l:ho=\E[H:\ |
|
|
727 | :i1=\E[?47l\E=\E[?1l:ic=\E[@:im=\E[4h:\ |
|
|
728 | :is=\E[r\E[m\E[2J\E[H\E[?7h\E[?1;3;4;6l\E[4l:\ |
|
|
729 | :k1=\E[11~:k2=\E[12~:k3=\E[13~:k4=\E[14~:k5=\E[15~:\ |
|
|
730 | :k6=\E[17~:k7=\E[18~:k8=\E[19~:k9=\E[20~:kD=\E[3~:\ |
|
|
731 | :kI=\E[2~:kN=\E[6~:kP=\E[5~:kb=\177:kd=\EOB:ke=\E[?1l\E>:\ |
|
|
732 | :kh=\E[7~:kl=\EOD:kr=\EOC:ks=\E[?1h\E=:ku=\EOA:le=^H:\ |
|
|
733 | :mb=\E[5m:md=\E[1m:me=\E[m\017:mr=\E[7m:nd=\E[C:rc=\E8:\ |
|
|
734 | :sc=\E7:se=\E[27m:sf=^J:so=\E[7m:sr=\EM:st=\EH:ta=^I:\ |
|
|
735 | :te=\E[r\E[?1049l:ti=\E[?1049h:ue=\E[24m:up=\E[A:\ |
|
|
736 | :us=\E[4m:vb=\E[?5h\E[?5l:ve=\E[?25h:vi=\E[?25l:\ |
|
|
737 | :vs=\E[?25h: |
|
|
738 | |
|
|
739 | =head3 Why does C<ls> no longer have coloured output? |
|
|
740 | |
|
|
741 | The C<ls> in the GNU coreutils unfortunately doesn't use terminfo to |
|
|
742 | decide wether a terminal has colour, but uses it's own configuration |
|
|
743 | file. Needless to say, C<rxvt-unicode> is not in it's default file (among |
|
|
744 | with most other terminals supporting colour). Either add: |
|
|
745 | |
|
|
746 | TERM rxvt-unicode |
|
|
747 | |
|
|
748 | to C</etc/DIR_COLORS> or simply add: |
|
|
749 | |
|
|
750 | alias ls='ls --color=auto' |
|
|
751 | |
|
|
752 | to your C<.profile> or C<.bashrc>. |
|
|
753 | |
|
|
754 | =head3 Why doesn't vim/emacs etc. use the 88 colour mode? |
|
|
755 | |
|
|
756 | See next entry. |
|
|
757 | |
|
|
758 | =head3 Why doesn't vim/emacs etc. make use of italic? |
|
|
759 | |
|
|
760 | See next entry. |
|
|
761 | |
|
|
762 | =head3 Why are the secondary screen-related options not working properly? |
|
|
763 | |
|
|
764 | Make sure you are using C<TERM=rxvt-unicode>. Some pre-packaged |
|
|
765 | distributions (most notably Debian GNU/Linux) break rxvt-unicode |
|
|
766 | by setting C<TERM> to C<rxvt>, which doesn't have these extra |
|
|
767 | features. Unfortunately, some of these (most notably, again, Debian |
|
|
768 | GNU/Linux) furthermore fail to even install the C<rxvt-unicode> terminfo |
|
|
769 | file, so you will need to install it on your own (See the question B<When |
|
|
770 | I log-in to another system it tells me about missing terminfo data?> on |
|
|
771 | how to do this). |
|
|
772 | |
|
|
773 | |
|
|
774 | =head2 Encoding / Locale / Input Method Issues |
|
|
775 | |
|
|
776 | =head3 Rxvt-unicode does not seem to understand the selected encoding? |
|
|
777 | |
|
|
778 | See next entry. |
|
|
779 | |
|
|
780 | =head3 Unicode does not seem to work? |
|
|
781 | |
|
|
782 | If you encounter strange problems like typing an accented character but |
|
|
783 | getting two unrelated other characters or similar, or if program output is |
|
|
784 | subtly garbled, then you should check your locale settings. |
|
|
785 | |
|
|
786 | Rxvt-unicode must be started with the same C<LC_CTYPE> setting as the |
|
|
787 | programs. Often rxvt-unicode is started in the C<C> locale, while the |
|
|
788 | login script running within the rxvt-unicode window changes the locale to |
|
|
789 | something else, e.g. C<en_GB.UTF-8>. Needless to say, this is not going to work. |
|
|
790 | |
|
|
791 | The best thing is to fix your startup environment, as you will likely run |
|
|
792 | into other problems. If nothing works you can try this in your .profile. |
|
|
793 | |
|
|
794 | printf '\e]701;%s\007' "$LC_CTYPE" |
|
|
795 | |
|
|
796 | If this doesn't work, then maybe you use a C<LC_CTYPE> specification not |
|
|
797 | supported on your systems. Some systems have a C<locale> command which |
|
|
798 | displays this (also, C<perl -e0> can be used to check locale settings, as |
|
|
799 | it will complain loudly if it cannot set the locale). If it displays something |
|
|
800 | like: |
|
|
801 | |
|
|
802 | locale: Cannot set LC_CTYPE to default locale: ... |
|
|
803 | |
|
|
804 | Then the locale you specified is not supported on your system. |
|
|
805 | |
|
|
806 | If nothing works and you are sure that everything is set correctly then |
|
|
807 | you will need to remember a little known fact: Some programs just don't |
|
|
808 | support locales :( |
|
|
809 | |
|
|
810 | =head3 How does rxvt-unicode determine the encoding to use? |
|
|
811 | |
|
|
812 | See next entry. |
|
|
813 | |
|
|
814 | =head3 Is there an option to switch encodings? |
|
|
815 | |
|
|
816 | Unlike some other terminals, rxvt-unicode has no encoding switch, and no |
|
|
817 | specific "utf-8" mode, such as xterm. In fact, it doesn't even know about |
|
|
818 | UTF-8 or any other encodings with respect to terminal I/O. |
|
|
819 | |
|
|
820 | The reasons is that there exists a perfectly fine mechanism for selecting |
|
|
821 | the encoding, doing I/O and (most important) communicating this to all |
|
|
822 | applications so everybody agrees on character properties such as width |
|
|
823 | and code number. This mechanism is the I<locale>. Applications not using |
|
|
824 | that info will have problems (for example, C<xterm> gets the width of |
|
|
825 | characters wrong as it uses it's own, locale-independent table under all |
|
|
826 | locales). |
|
|
827 | |
|
|
828 | Rxvt-unicode uses the C<LC_CTYPE> locale category to select encoding. All |
|
|
829 | programs doing the same (that is, most) will automatically agree in the |
|
|
830 | interpretation of characters. |
|
|
831 | |
|
|
832 | Unfortunately, there is no system-independent way to select locales, nor |
|
|
833 | is there a standard on how locale specifiers will look like. |
|
|
834 | |
|
|
835 | On most systems, the content of the C<LC_CTYPE> environment variable |
|
|
836 | contains an arbitrary string which corresponds to an already-installed |
|
|
837 | locale. Common names for locales are C<en_US.UTF-8>, C<de_DE.ISO-8859-15>, |
|
|
838 | C<ja_JP.EUC-JP>, i.e. C<language_country.encoding>, but other forms |
|
|
839 | (i.e. C<de> or C<german>) are also common. |
|
|
840 | |
|
|
841 | Rxvt-unicode ignores all other locale categories, and except for |
|
|
842 | the encoding, ignores country or language-specific settings, |
|
|
843 | i.e. C<de_DE.UTF-8> and C<ja_JP.UTF-8> are the normally same to |
|
|
844 | rxvt-unicode. |
|
|
845 | |
|
|
846 | If you want to use a specific encoding you have to make sure you start |
|
|
847 | rxvt-unicode with the correct C<LC_CTYPE> category. |
|
|
848 | |
|
|
849 | =head3 Can I switch locales at runtime? |
|
|
850 | |
|
|
851 | Yes, using an escape sequence. Try something like this, which sets |
|
|
852 | rxvt-unicode's idea of C<LC_CTYPE>. |
|
|
853 | |
|
|
854 | printf '\e]701;%s\007' ja_JP.SJIS |
|
|
855 | |
|
|
856 | See also the previous answer. |
|
|
857 | |
|
|
858 | Sometimes this capability is rather handy when you want to work in |
|
|
859 | one locale (e.g. C<de_DE.UTF-8>) but some programs don't support it |
|
|
860 | (e.g. UTF-8). For example, I use this script to start C<xjdic>, which |
|
|
861 | first switches to a locale supported by xjdic and back later: |
|
|
862 | |
|
|
863 | printf '\e]701;%s\007' ja_JP.SJIS |
|
|
864 | xjdic -js |
|
|
865 | printf '\e]701;%s\007' de_DE.UTF-8 |
|
|
866 | |
|
|
867 | You can also use xterm's C<luit> program, which usually works fine, except |
|
|
868 | for some locales where character width differs between program- and |
|
|
869 | rxvt-unicode-locales. |
|
|
870 | |
|
|
871 | =head3 My input method wants <some encoding> but I want UTF-8, what can I do? |
|
|
872 | |
|
|
873 | You can specify separate locales for the input method and the rest of the |
|
|
874 | terminal, using the resource C<imlocale>: |
|
|
875 | |
|
|
876 | URxvt.imlocale: ja_JP.EUC-JP |
|
|
877 | |
|
|
878 | Now you can start your terminal with C<LC_CTYPE=ja_JP.UTF-8> and still |
|
|
879 | use your input method. Please note, however, that you will not be able to |
|
|
880 | input characters outside C<EUC-JP> in a normal way then, as your input |
|
|
881 | method limits you. |
|
|
882 | |
|
|
883 | =head3 Rxvt-unicode crashes when the X Input Method changes or exits. |
|
|
884 | |
|
|
885 | Unfortunately, this is unavoidable, as the XIM protocol is racy by |
|
|
886 | design. Applications can avoid some crashes at the expense of memory |
|
|
887 | leaks, and Input Methods can avoid some crashes by careful ordering at |
|
|
888 | exit time. B<kinput2> (and derived input methods) generally succeeds, |
|
|
889 | while B<SCIM> (or similar input methods) fails. In the end, however, |
|
|
890 | crashes cannot be completely avoided even if both sides cooperate. |
|
|
891 | |
|
|
892 | So the only workaround is not to kill your Input Method Servers. |
|
|
893 | |
|
|
894 | |
|
|
895 | =head2 Operating Systems / Package Maintaining |
|
|
896 | |
|
|
897 | =head3 I am using Debian GNU/Linux and have a problem... |
|
|
898 | |
|
|
899 | The Debian GNU/Linux package of rxvt-unicode in sarge contains large |
|
|
900 | patches that considerably change the behaviour of rxvt-unicode (but |
|
|
901 | unfortunately this notice has been removed). Before reporting a bug to |
|
|
902 | the original rxvt-unicode author please download and install the genuine |
|
|
903 | version (L<http://software.schmorp.de#rxvt-unicode>) and try to reproduce |
|
|
904 | the problem. If you cannot, chances are that the problems are specific to |
|
|
905 | Debian GNU/Linux, in which case it should be reported via the Debian Bug |
|
|
906 | Tracking System (use C<reportbug> to report the bug). |
|
|
907 | |
|
|
908 | For other problems that also affect the Debian package, you can and |
|
|
909 | probably should use the Debian BTS, too, because, after all, it's also a |
|
|
910 | bug in the Debian version and it serves as a reminder for other users that |
|
|
911 | might encounter the same issue. |
|
|
912 | |
|
|
913 | =head3 I am maintaining rxvt-unicode for distribution/OS XXX, any recommendation? |
|
|
914 | |
|
|
915 | You should build one binary with the default options. F<configure> |
|
|
916 | now enables most useful options, and the trend goes to making them |
|
|
917 | runtime-switchable, too, so there is usually no drawback to enbaling them, |
|
|
918 | except higher disk and possibly memory usage. The perl interpreter should |
|
|
919 | be enabled, as important functionality (menus, selection, likely more in |
|
|
920 | the future) depends on it. |
|
|
921 | |
|
|
922 | You should not overwrite the C<perl-ext-common> snd C<perl-ext> resources |
|
|
923 | system-wide (except maybe with C<defaults>). This will result in useful |
|
|
924 | behaviour. If your distribution aims at low memory, add an empty |
|
|
925 | C<perl-ext-common> resource to the app-defaults file. This will keep the |
|
|
926 | perl interpreter disabled until the user enables it. |
|
|
927 | |
|
|
928 | If you can/want build more binaries, I recommend building a minimal |
|
|
929 | one with C<--disable-everything> (very useful) and a maximal one with |
|
|
930 | C<--enable-everything> (less useful, it will be very big due to a lot of |
|
|
931 | encodings built-in that increase download times and are rarely used). |
|
|
932 | |
|
|
933 | =head3 I need to make it setuid/setgid to support utmp/ptys on my OS, is this safe? |
|
|
934 | |
|
|
935 | It should be, starting with release 7.1. You are encouraged to properly |
|
|
936 | install urxvt with privileges necessary for your OS now. |
|
|
937 | |
|
|
938 | When rxvt-unicode detects that it runs setuid or setgid, it will fork |
|
|
939 | into a helper process for privileged operations (pty handling on some |
|
|
940 | systems, utmp/wtmp/lastlog handling on others) and drop privileges |
|
|
941 | immediately. This is much safer than most other terminals that keep |
|
|
942 | privileges while running (but is more relevant to urxvt, as it contains |
|
|
943 | things as perl interpreters, which might be "helpful" to attackers). |
|
|
944 | |
|
|
945 | This forking is done as the very first within main(), which is very early |
|
|
946 | and reduces possible bugs to initialisation code run before main(), or |
|
|
947 | things like the dynamic loader of your system, which should result in very |
|
|
948 | little risk. |
|
|
949 | |
|
|
950 | =head3 On Solaris 9, many line-drawing characters are too wide. |
|
|
951 | |
|
|
952 | Seems to be a known bug, read |
|
|
953 | L<http://nixdoc.net/files/forum/about34198.html>. Some people use the |
|
|
954 | following ugly workaround to get non-double-wide-characters working: |
|
|
955 | |
|
|
956 | #define wcwidth(x) wcwidth(x) > 1 ? 1 : wcwidth(x) |
|
|
957 | |
|
|
958 | =head3 I am on FreeBSD and rxvt-unicode does not seem to work at all. |
|
|
959 | |
|
|
960 | Rxvt-unicode requires the symbol C<__STDC_ISO_10646__> to be defined |
|
|
961 | in your compile environment, or an implementation that implements it, |
|
|
962 | wether it defines the symbol or not. C<__STDC_ISO_10646__> requires that |
|
|
963 | B<wchar_t> is represented as unicode. |
|
|
964 | |
|
|
965 | As you might have guessed, FreeBSD does neither define this symobl nor |
|
|
966 | does it support it. Instead, it uses it's own internal representation of |
|
|
967 | B<wchar_t>. This is, of course, completely fine with respect to standards. |
|
|
968 | |
|
|
969 | However, that means rxvt-unicode only works in C<POSIX>, C<ISO-8859-1> and |
|
|
970 | C<UTF-8> locales under FreeBSD (which all use Unicode as B<wchar_t>. |
|
|
971 | |
|
|
972 | C<__STDC_ISO_10646__> is the only sane way to support multi-language |
|
|
973 | apps in an OS, as using a locale-dependent (and non-standardized) |
|
|
974 | representation of B<wchar_t> makes it impossible to convert between |
|
|
975 | B<wchar_t> (as used by X11 and your applications) and any other encoding |
|
|
976 | without implementing OS-specific-wrappers for each and every locale. There |
|
|
977 | simply are no APIs to convert B<wchar_t> into anything except the current |
|
|
978 | locale encoding. |
|
|
979 | |
|
|
980 | Some applications (such as the formidable B<mlterm>) work around this |
|
|
981 | by carrying their own replacement functions for character set handling |
|
|
982 | with them, and either implementing OS-dependent hacks or doing multiple |
|
|
983 | conversions (which is slow and unreliable in case the OS implements |
|
|
984 | encodings slightly different than the terminal emulator). |
|
|
985 | |
|
|
986 | The rxvt-unicode author insists that the right way to fix this is in the |
|
|
987 | system libraries once and for all, instead of forcing every app to carry |
|
|
988 | complete replacements for them :) |
|
|
989 | |
|
|
990 | =head3 I use Solaris 9 and it doesn't compile/work/etc. |
|
|
991 | |
|
|
992 | Try the diff in F<doc/solaris9.patch> as a base. It fixes the worst |
|
|
993 | problems with C<wcwidth> and a compile problem. |
|
|
994 | |
|
|
995 | =head3 How can I use rxvt-unicode under cygwin? |
|
|
996 | |
|
|
997 | rxvt-unicode should compile and run out of the box on cygwin, using |
|
|
998 | the X11 libraries that come with cygwin. libW11 emulation is no |
|
|
999 | longer supported (and makes no sense, either, as it only supported a |
|
|
1000 | single font). I recommend starting the X-server in C<-multiwindow> or |
|
|
1001 | C<-rootless> mode instead, which will result in similar look&feel as the |
|
|
1002 | old libW11 emulation. |
|
|
1003 | |
|
|
1004 | At the time of this writing, cygwin didn't seem to support any multi-byte |
|
|
1005 | encodings (you might try C<LC_CTYPE=C-UTF-8>), so you are likely limited |
|
|
1006 | to 8-bit encodings. |
|
|
1007 | |
|
|
1008 | =head1 RXVT TECHNICAL REFERENCE |
620 | |
1009 | |
621 | =head1 DESCRIPTION |
1010 | =head1 DESCRIPTION |
622 | |
1011 | |
623 | The rest of this document describes various technical aspects of |
1012 | The rest of this document describes various technical aspects of |
624 | B<rxvt-unicode>. First the description of supported command sequences, |
1013 | B<rxvt-unicode>. First the description of supported command sequences, |
625 | followed by menu and pixmap support and last by a description of all |
1014 | followed by pixmap support and last by a description of all features |
626 | features selectable at C<configure> time. |
1015 | selectable at C<configure> time. |
627 | |
|
|
628 | =head1 RXVT TECHNICAL REFERENCE |
|
|
629 | |
1016 | |
630 | =head1 Definitions |
1017 | =head1 Definitions |
631 | |
1018 | |
632 | =over 4 |
1019 | =over 4 |
633 | |
1020 | |
… | |
… | |
762 | Single Shift Select of G3 Character Set (SS3): affects next character |
1149 | Single Shift Select of G3 Character Set (SS3): affects next character |
763 | only I<unimplemented> |
1150 | only I<unimplemented> |
764 | |
1151 | |
765 | =item B<< C<ESC Z> >> |
1152 | =item B<< C<ESC Z> >> |
766 | |
1153 | |
767 | Obsolete form of returns: B<< C<ESC[?1;2C> >> I<rxvt-unicode compile-time option> |
1154 | Obsolete form of returns: B<< C<ESC [ ? 1 ; 2 C> >> I<rxvt-unicode compile-time option> |
768 | |
1155 | |
769 | =item B<< C<ESC c> >> |
1156 | =item B<< C<ESC c> >> |
770 | |
1157 | |
771 | Full reset (RIS) |
1158 | Full reset (RIS) |
772 | |
1159 | |
… | |
… | |
776 | |
1163 | |
777 | =item B<< C<ESC o> >> |
1164 | =item B<< C<ESC o> >> |
778 | |
1165 | |
779 | Invoke the G3 Character Set (LS3) |
1166 | Invoke the G3 Character Set (LS3) |
780 | |
1167 | |
781 | =item B<< C<ESC> ( C> >> |
1168 | =item B<< C<ESC ( C> >> |
782 | |
1169 | |
783 | Designate G0 Character Set (ISO 2022), see below for values of C<C>. |
1170 | Designate G0 Character Set (ISO 2022), see below for values of C<C>. |
784 | |
1171 | |
785 | =item B<< C<ESC> ) C> >> |
1172 | =item B<< C<ESC ) C> >> |
786 | |
1173 | |
787 | Designate G1 Character Set (ISO 2022), see below for values of C<C>. |
1174 | Designate G1 Character Set (ISO 2022), see below for values of C<C>. |
788 | |
1175 | |
789 | =item B<< C<ESC * C> >> |
1176 | =item B<< C<ESC * C> >> |
790 | |
1177 | |
… | |
… | |
931 | |
1318 | |
932 | =item B<< C<ESC [ Ps c> >> |
1319 | =item B<< C<ESC [ Ps c> >> |
933 | |
1320 | |
934 | Send Device Attributes (DA) |
1321 | Send Device Attributes (DA) |
935 | B<< C<Ps = 0> >> (or omitted): request attributes from terminal |
1322 | B<< C<Ps = 0> >> (or omitted): request attributes from terminal |
936 | returns: B<< C<ESC[?1;2c> >> (``I am a VT100 with Advanced Video |
1323 | returns: B<< C<ESC [ ? 1 ; 2 c> >> (``I am a VT100 with Advanced Video |
937 | Option'') |
1324 | Option'') |
938 | |
1325 | |
939 | =item B<< C<ESC [ Ps d> >> |
1326 | =item B<< C<ESC [ Ps d> >> |
940 | |
1327 | |
941 | Cursor to Line B<< C<Ps> >> (VPA) |
1328 | Cursor to Line B<< C<Ps> >> (VPA) |
… | |
… | |
1057 | |
1444 | |
1058 | =item B<< C<ESC [ s> >> |
1445 | =item B<< C<ESC [ s> >> |
1059 | |
1446 | |
1060 | Save Cursor (SC) |
1447 | Save Cursor (SC) |
1061 | |
1448 | |
|
|
1449 | =item B<< C<ESC [ Ps;Pt t> >> |
|
|
1450 | |
|
|
1451 | Window Operations |
|
|
1452 | |
|
|
1453 | =begin table |
|
|
1454 | |
|
|
1455 | B<< C<Ps = 1> >> Deiconify (map) window |
|
|
1456 | B<< C<Ps = 2> >> Iconify window |
|
|
1457 | B<< C<Ps = 3> >> B<< C<ESC [ 3 ; X ; Y t> >> Move window to (X|Y) |
|
|
1458 | B<< C<Ps = 4> >> B<< C<ESC [ 4 ; H ; W t> >> Resize to WxH pixels |
|
|
1459 | B<< C<Ps = 5> >> Raise window |
|
|
1460 | B<< C<Ps = 6> >> Lower window |
|
|
1461 | B<< C<Ps = 7> >> Refresh screen once |
|
|
1462 | B<< C<Ps = 8> >> B<< C<ESC [ 8 ; R ; C t> >> Resize to R rows and C columns |
|
|
1463 | B<< C<Ps = 11> >> Report window state (responds with C<Ps = 1> or C<Ps = 2>) |
|
|
1464 | B<< C<Ps = 13> >> Report window position (responds with C<Ps = 3>) |
|
|
1465 | B<< C<Ps = 14> >> Report window pixel size (responds with C<Ps = 4>) |
|
|
1466 | B<< C<Ps = 18> >> Report window text size (responds with C<Ps = 7>) |
|
|
1467 | B<< C<Ps = 19> >> Currently the same as C<Ps = 18>, but responds with C<Ps = 9> |
|
|
1468 | B<< C<Ps = 20> >> Reports icon label (B<< C<ESC ] L NAME \234> >>) |
|
|
1469 | B<< C<Ps = 21> >> Reports window title (B<< C<ESC ] l NAME \234> >>) |
|
|
1470 | B<< C<Ps = 24..> >> Set window height to C<Ps> rows |
|
|
1471 | |
|
|
1472 | =end table |
|
|
1473 | |
|
|
1474 | =item B<< C<ESC [ u> >> |
|
|
1475 | |
|
|
1476 | Restore Cursor |
|
|
1477 | |
1062 | =item B<< C<ESC [ Ps x> >> |
1478 | =item B<< C<ESC [ Ps x> >> |
1063 | |
1479 | |
1064 | Request Terminal Parameters (DECREQTPARM) |
1480 | Request Terminal Parameters (DECREQTPARM) |
1065 | |
|
|
1066 | =item B<< C<ESC [ u> >> |
|
|
1067 | |
|
|
1068 | Restore Cursor |
|
|
1069 | |
1481 | |
1070 | =back |
1482 | =back |
1071 | |
1483 | |
1072 | X<PrivateModes> |
1484 | X<PrivateModes> |
1073 | |
1485 | |
… | |
… | |
1176 | B<< C<h> >> Send Mouse X & Y on button press. |
1588 | B<< C<h> >> Send Mouse X & Y on button press. |
1177 | B<< C<l> >> No mouse reporting. |
1589 | B<< C<l> >> No mouse reporting. |
1178 | |
1590 | |
1179 | =end table |
1591 | =end table |
1180 | |
1592 | |
1181 | =item B<< C<Ps = 10> >> (B<rxvt>) |
|
|
1182 | |
|
|
1183 | =begin table |
|
|
1184 | |
|
|
1185 | B<< C<h> >> menuBar visible |
|
|
1186 | B<< C<l> >> menuBar invisible |
|
|
1187 | |
|
|
1188 | =end table |
|
|
1189 | |
|
|
1190 | =item B<< C<Ps = 25> >> |
1593 | =item B<< C<Ps = 25> >> |
1191 | |
1594 | |
1192 | =begin table |
1595 | =begin table |
1193 | |
1596 | |
1194 | B<< C<h> >> Visible cursor {cnorm/cvvis} |
1597 | B<< C<h> >> Visible cursor {cnorm/cvvis} |
… | |
… | |
1307 | |
1710 | |
1308 | =begin table |
1711 | =begin table |
1309 | |
1712 | |
1310 | B<< C<h> >> Scroll to bottom when a key is pressed |
1713 | B<< C<h> >> Scroll to bottom when a key is pressed |
1311 | B<< C<l> >> Don't scroll to bottom when a key is pressed |
1714 | B<< C<l> >> Don't scroll to bottom when a key is pressed |
|
|
1715 | |
|
|
1716 | =end table |
|
|
1717 | |
|
|
1718 | =item B<< C<Ps = 1021> >> (B<rxvt>) |
|
|
1719 | |
|
|
1720 | =begin table |
|
|
1721 | |
|
|
1722 | B<< C<h> >> Bold/italic implies high intensity (see option B<-is>) |
|
|
1723 | B<< C<l> >> Font styles have no effect on intensity (Compile styles) |
1312 | |
1724 | |
1313 | =end table |
1725 | =end table |
1314 | |
1726 | |
1315 | =item B<< C<Ps = 1047> >> |
1727 | =item B<< C<Ps = 1047> >> |
1316 | |
1728 | |
… | |
… | |
1365 | B<< C<Ps = 10> >> Change colour of text foreground to B<< C<Pt> >> B<(NB: may change in future)> |
1777 | B<< C<Ps = 10> >> Change colour of text foreground to B<< C<Pt> >> B<(NB: may change in future)> |
1366 | B<< C<Ps = 11> >> Change colour of text background to B<< C<Pt> >> B<(NB: may change in future)> |
1778 | B<< C<Ps = 11> >> Change colour of text background to B<< C<Pt> >> B<(NB: may change in future)> |
1367 | B<< C<Ps = 12> >> Change colour of text cursor foreground to B<< C<Pt> >> |
1779 | B<< C<Ps = 12> >> Change colour of text cursor foreground to B<< C<Pt> >> |
1368 | B<< C<Ps = 13> >> Change colour of mouse foreground to B<< C<Pt> >> |
1780 | B<< C<Ps = 13> >> Change colour of mouse foreground to B<< C<Pt> >> |
1369 | B<< C<Ps = 17> >> Change colour of highlight characters to B<< C<Pt> >> |
1781 | B<< C<Ps = 17> >> Change colour of highlight characters to B<< C<Pt> >> |
1370 | B<< C<Ps = 18> >> Change colour of bold characters to B<< C<Pt> >> |
1782 | B<< C<Ps = 18> >> Change colour of bold characters to B<< C<Pt> >> [deprecated, see 706] |
1371 | B<< C<Ps = 19> >> Change colour of underlined characters to B<< C<Pt> >> |
1783 | B<< C<Ps = 19> >> Change colour of underlined characters to B<< C<Pt> >> [deprecated, see 707] |
|
|
1784 | B<< C<Ps = 20> >> Change background pixmap parameters (see section XPM) (Compile XPM). |
1372 | B<< C<Ps = 20> >> Change default background to B<< C<Pt> >> |
1785 | B<< C<Ps = 39> >> Change default foreground colour to B<< C<Pt> >>. |
1373 | B<< C<Ps = 39> >> Change default foreground colour to B<< C<Pt> >> I<rxvt compile-time option> |
|
|
1374 | B<< C<Ps = 46> >> Change Log File to B<< C<Pt> >> I<unimplemented> |
1786 | B<< C<Ps = 46> >> Change Log File to B<< C<Pt> >> I<unimplemented> |
1375 | B<< C<Ps = 49> >> Change default background colour to B<< C<Pt> >> I<rxvt compile-time option> |
1787 | B<< C<Ps = 49> >> Change default background colour to B<< C<Pt> >>. |
1376 | 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> >> |
1788 | 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> >> |
1377 | B<< C<Ps = 55> >> Log all scrollback buffer and all of screen to B<< C<Pt> >> |
1789 | B<< C<Ps = 55> >> Log all scrollback buffer and all of screen to B<< C<Pt> >> |
1378 | 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) |
1790 | 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). |
1379 | B<< C<Ps = 703> >> Menubar command B<< C<Pt> >> I<rxvt compile-time option> (rxvt-unicode extension) |
1791 | B<< C<Ps = 702> >> Request version if B<< C<Pt> >> is B<< C<?> >>, returning C<rxvt-unicode>, the resource name, the major and minor version numbers, e.g. C<ESC ] 702 ; rxvt-unicode ; urxvt ; 7 ; 4 ST>. |
1380 | B<< C<Ps = 704> >> Change colour of italic characters to B<< C<Pt> >> |
1792 | B<< C<Ps = 704> >> Change colour of italic characters to B<< C<Pt> >> |
1381 | B<< C<Ps = 705> >> Change background pixmap tint colour to B<< C<Pt> >> |
1793 | B<< C<Ps = 705> >> Change background pixmap tint colour to B<< C<Pt> >> (Compile transparency). |
|
|
1794 | B<< C<Ps = 706> >> Change colour of bold characters to B<< C<Pt> >> |
|
|
1795 | B<< C<Ps = 707> >> Change colour of underlined characters to B<< C<Pt> >> |
1382 | B<< C<Ps = 710> >> Set normal fontset to B<< C<Pt> >>. Same as C<Ps = 50>. |
1796 | B<< C<Ps = 710> >> Set normal fontset to B<< C<Pt> >>. Same as C<Ps = 50>. |
1383 | B<< C<Ps = 711> >> Set bold fontset to B<< C<Pt> >>. Similar to C<Ps = 50>. |
1797 | B<< C<Ps = 711> >> Set bold fontset to B<< C<Pt> >>. Similar to C<Ps = 50> (Compile styles). |
1384 | B<< C<Ps = 712> >> Set italic fontset to B<< C<Pt> >>. Similar to C<Ps = 50>. |
1798 | B<< C<Ps = 712> >> Set italic fontset to B<< C<Pt> >>. Similar to C<Ps = 50> (Compile styles). |
1385 | B<< C<Ps = 713> >> Set bold-italic fontset to B<< C<Pt> >>. Similar to C<Ps = 50>. |
1799 | B<< C<Ps = 713> >> Set bold-italic fontset to B<< C<Pt> >>. Similar to C<Ps = 50> (Compile styles). |
|
|
1800 | B<< C<Ps = 720> >> Move viewing window up by B<< C<Pt> >> lines, or clear scrollback buffer if C<Pt = 0> (Compile frills). |
|
|
1801 | B<< C<Ps = 721> >> Move viewing window down by B<< C<Pt> >> lines, or clear scrollback buffer if C<Pt = 0> (Compile frills). |
|
|
1802 | B<< C<Ps = 777> >> Call the perl extension with the given string, which should be of the form C<extension:parameters> (Compile perl). |
1386 | |
1803 | |
1387 | =end table |
1804 | =end table |
1388 | |
1805 | |
1389 | =back |
1806 | =back |
1390 | |
1807 | |
1391 | X<menuBar> |
|
|
1392 | |
|
|
1393 | =head1 menuBar |
|
|
1394 | |
|
|
1395 | B<< The exact syntax used is I<almost> solidified. >> |
|
|
1396 | In the menus, B<DON'T> try to use menuBar commands that add or remove a |
|
|
1397 | menuBar. |
|
|
1398 | |
|
|
1399 | Note that in all of the commands, the B<< I</path/> >> I<cannot> be |
|
|
1400 | omitted: use B<./> to specify a menu relative to the current menu. |
|
|
1401 | |
|
|
1402 | =head2 Overview of menuBar operation |
|
|
1403 | |
|
|
1404 | For the menuBar XTerm escape sequence C<ESC ] 703 ; Pt ST>, the syntax |
|
|
1405 | of C<Pt> can be used for a variety of tasks: |
|
|
1406 | |
|
|
1407 | At the top level is the current menuBar which is a member of a circular |
|
|
1408 | linked-list of other such menuBars. |
|
|
1409 | |
|
|
1410 | The menuBar acts as a parent for the various drop-down menus, which in |
|
|
1411 | turn, may have labels, separator lines, menuItems and subMenus. |
|
|
1412 | |
|
|
1413 | The menuItems are the useful bits: you can use them to mimic keyboard |
|
|
1414 | input or even to send text or escape sequences back to rxvt. |
|
|
1415 | |
|
|
1416 | The menuBar syntax is intended to provide a simple yet robust method of |
|
|
1417 | constructing and manipulating menus and navigating through the |
|
|
1418 | menuBars. |
|
|
1419 | |
|
|
1420 | The first step is to use the tag B<< [menu:I<name>] >> which creates |
|
|
1421 | the menuBar called I<name> and allows access. You may now or menus, |
|
|
1422 | subMenus, and menuItems. Finally, use the tag B<[done]> to set the |
|
|
1423 | menuBar access as B<readonly> to prevent accidental corruption of the |
|
|
1424 | menus. To re-access the current menuBar for alterations, use the tag |
|
|
1425 | B<[menu]>, make the alterations and then use B<[done]> |
|
|
1426 | |
|
|
1427 | X<menuBarCommands> |
|
|
1428 | |
|
|
1429 | =head2 Commands |
|
|
1430 | |
|
|
1431 | =over 4 |
|
|
1432 | |
|
|
1433 | =item B<< [menu:+I<name>] >> |
|
|
1434 | |
|
|
1435 | access the named menuBar for creation or alteration. If a new menuBar |
|
|
1436 | is created, it is called I<name> (max of 15 chars) and the current |
|
|
1437 | menuBar is pushed onto the stack |
|
|
1438 | |
|
|
1439 | =item B<[menu]> |
|
|
1440 | |
|
|
1441 | access the current menuBar for alteration |
|
|
1442 | |
|
|
1443 | =item B<< [title:+I<string>] >> |
|
|
1444 | |
|
|
1445 | set the current menuBar's title to I<string>, which may contain the |
|
|
1446 | following format specifiers: |
|
|
1447 | B<%%> : literal B<%> character |
|
|
1448 | B<%n> : rxvt name (as per the B<-name> command-line option) |
|
|
1449 | B<%v> : rxvt version |
|
|
1450 | |
|
|
1451 | =item B<[done]> |
|
|
1452 | |
|
|
1453 | set menuBar access as B<readonly>. |
|
|
1454 | End-of-file tag for B<< [read:+I<file>] >> operations. |
|
|
1455 | |
|
|
1456 | =item B<< [read:+I<file>] >> |
|
|
1457 | |
|
|
1458 | read menu commands directly from I<file> (extension ".menu" will be |
|
|
1459 | appended if required.) Start reading at a line with B<[menu]> or B<< |
|
|
1460 | [menu:+I<name> >> and continuing until B<[done]> is encountered. |
|
|
1461 | |
|
|
1462 | Blank and comment lines (starting with B<#>) are ignored. Actually, |
|
|
1463 | since any invalid menu commands are also ignored, almost anything could |
|
|
1464 | be construed as a comment line, but this may be tightened up in the |
|
|
1465 | future ... so don't count on it!. |
|
|
1466 | |
|
|
1467 | =item B<< [read:+I<file>;+I<name>] >> |
|
|
1468 | |
|
|
1469 | The same as B<< [read:+I<file>] >>, but start reading at a line with |
|
|
1470 | B<< [menu:+I<name>] >> and continuing until B<< [done:+I<name>] >> or |
|
|
1471 | B<[done]> is encountered. |
|
|
1472 | |
|
|
1473 | =item B<[dump]> |
|
|
1474 | |
|
|
1475 | dump all menuBars to the file B</tmp/rxvt-PID> in a format suitable for |
|
|
1476 | later rereading. |
|
|
1477 | |
|
|
1478 | =item B<[rm:name]> |
|
|
1479 | |
|
|
1480 | remove the named menuBar |
|
|
1481 | |
|
|
1482 | =item B<[rm] [rm:]> |
|
|
1483 | |
|
|
1484 | remove the current menuBar |
|
|
1485 | |
|
|
1486 | =item B<[rm*] [rm:*]> |
|
|
1487 | |
|
|
1488 | remove all menuBars |
|
|
1489 | |
|
|
1490 | =item B<[swap]> |
|
|
1491 | |
|
|
1492 | swap the top two menuBars |
|
|
1493 | |
|
|
1494 | =item B<[prev]> |
|
|
1495 | |
|
|
1496 | access the previous menuBar |
|
|
1497 | |
|
|
1498 | =item B<[next]> |
|
|
1499 | |
|
|
1500 | access the next menuBar |
|
|
1501 | |
|
|
1502 | =item B<[show]> |
|
|
1503 | |
|
|
1504 | Enable display of the menuBar |
|
|
1505 | |
|
|
1506 | =item B<[hide]> |
|
|
1507 | |
|
|
1508 | Disable display of the menuBar |
|
|
1509 | |
|
|
1510 | =item B<< [pixmap:+I<name>] >> |
|
|
1511 | |
|
|
1512 | =item B<< [pixmap:+I<name>;I<scaling>] >> |
|
|
1513 | |
|
|
1514 | (set the background pixmap globally |
|
|
1515 | |
|
|
1516 | B<< A Future implementation I<may> make this local to the menubar >>) |
|
|
1517 | |
|
|
1518 | =item B<< [:+I<command>:] >> |
|
|
1519 | |
|
|
1520 | ignore the menu readonly status and issue a I<command> to or a menu or |
|
|
1521 | menuitem or change the ; a useful shortcut for setting the quick arrows |
|
|
1522 | from a menuBar. |
|
|
1523 | |
|
|
1524 | =back |
|
|
1525 | |
|
|
1526 | X<menuBarAdd> |
|
|
1527 | |
|
|
1528 | =head2 Adding and accessing menus |
|
|
1529 | |
|
|
1530 | The following commands may also be B<+> prefixed. |
|
|
1531 | |
|
|
1532 | =over 4 |
|
|
1533 | |
|
|
1534 | =item B</+> |
|
|
1535 | |
|
|
1536 | access menuBar top level |
|
|
1537 | |
|
|
1538 | =item B<./+> |
|
|
1539 | |
|
|
1540 | access current menu level |
|
|
1541 | |
|
|
1542 | =item B<../+> |
|
|
1543 | |
|
|
1544 | access parent menu (1 level up) |
|
|
1545 | |
|
|
1546 | =item B<../../> |
|
|
1547 | |
|
|
1548 | access parent menu (multiple levels up) |
|
|
1549 | |
|
|
1550 | =item B<< I</path/>menu >> |
|
|
1551 | |
|
|
1552 | add/access menu |
|
|
1553 | |
|
|
1554 | =item B<< I</path/>menu/* >> |
|
|
1555 | |
|
|
1556 | add/access menu and clear it if it exists |
|
|
1557 | |
|
|
1558 | =item B<< I</path/>{-} >> |
|
|
1559 | |
|
|
1560 | add separator |
|
|
1561 | |
|
|
1562 | =item B<< I</path/>{item} >> |
|
|
1563 | |
|
|
1564 | add B<item> as a label |
|
|
1565 | |
|
|
1566 | =item B<< I</path/>{item} action >> |
|
|
1567 | |
|
|
1568 | add/alter I<menuitem> with an associated I<action> |
|
|
1569 | |
|
|
1570 | =item B<< I</path/>{item}{right-text} >> |
|
|
1571 | |
|
|
1572 | add/alter I<menuitem> with B<right-text> as the right-justified text |
|
|
1573 | and as the associated I<action> |
|
|
1574 | |
|
|
1575 | =item B<< I</path/>{item}{rtext} action >> |
|
|
1576 | |
|
|
1577 | add/alter I<menuitem> with an associated I<action> and with B<rtext> as |
|
|
1578 | the right-justified text. |
|
|
1579 | |
|
|
1580 | =back |
|
|
1581 | |
|
|
1582 | =over 4 |
|
|
1583 | |
|
|
1584 | =item Special characters in I<action> must be backslash-escaped: |
|
|
1585 | |
|
|
1586 | B<\a \b \E \e \n \r \t \octal> |
|
|
1587 | |
|
|
1588 | =item or in control-character notation: |
|
|
1589 | |
|
|
1590 | B<^@, ^A .. ^Z .. ^_, ^?> |
|
|
1591 | |
|
|
1592 | =back |
|
|
1593 | |
|
|
1594 | To send a string starting with a B<NUL> (B<^@>) character to the |
|
|
1595 | program, start I<action> with a pair of B<NUL> characters (B<^@^@>), |
|
|
1596 | the first of which will be stripped off and the balance directed to the |
|
|
1597 | program. Otherwise if I<action> begins with B<NUL> followed by |
|
|
1598 | non-+B<NUL> characters, the leading B<NUL> is stripped off and the |
|
|
1599 | balance is sent back to rxvt. |
|
|
1600 | |
|
|
1601 | As a convenience for the many Emacs-type editors, I<action> may start |
|
|
1602 | with B<M-> (eg, B<M-$> is equivalent to B<\E$>) and a B<CR> will be |
|
|
1603 | appended if missed from B<M-x> commands. |
|
|
1604 | |
|
|
1605 | As a convenience for issuing XTerm B<ESC]> sequences from a menubar (or |
|
|
1606 | quick arrow), a B<BEL> (B<^G>) will be appended if needed. |
|
|
1607 | |
|
|
1608 | =over 4 |
|
|
1609 | |
|
|
1610 | =item For example, |
|
|
1611 | |
|
|
1612 | B<M-xapropos> is equivalent to B<\Exapropos\r> |
|
|
1613 | |
|
|
1614 | =item and |
|
|
1615 | |
|
|
1616 | B<\E]703;mona;100> is equivalent to B<\E]703;mona;100\a> |
|
|
1617 | |
|
|
1618 | =back |
|
|
1619 | |
|
|
1620 | The option B<< {I<right-rtext>} >> will be right-justified. In the |
|
|
1621 | absence of a specified action, this text will be used as the I<action> |
|
|
1622 | as well. |
|
|
1623 | |
|
|
1624 | =over 4 |
|
|
1625 | |
|
|
1626 | =item For example, |
|
|
1627 | |
|
|
1628 | B</File/{Open}{^X^F}> is equivalent to B</File/{Open}{^X^F} ^X^F> |
|
|
1629 | |
|
|
1630 | =back |
|
|
1631 | |
|
|
1632 | The left label I<is> necessary, since it's used for matching, but |
|
|
1633 | implicitly hiding the left label (by using same name for both left and |
|
|
1634 | right labels), or explicitly hiding the left label (by preceeding it |
|
|
1635 | with a dot), makes it possible to have right-justified text only. |
|
|
1636 | |
|
|
1637 | =over 4 |
|
|
1638 | |
|
|
1639 | =item For example, |
|
|
1640 | |
|
|
1641 | B</File/{Open}{Open} Open-File-Action> |
|
|
1642 | |
|
|
1643 | =item or hiding it |
|
|
1644 | |
|
|
1645 | B</File/{.anylabel}{Open} Open-File-Action> |
|
|
1646 | |
|
|
1647 | =back |
|
|
1648 | |
|
|
1649 | X<menuBarRemove> |
|
|
1650 | |
|
|
1651 | =head2 Removing menus |
|
|
1652 | |
|
|
1653 | =over 4 |
|
|
1654 | |
|
|
1655 | =item B<< -/*+ >> |
|
|
1656 | |
|
|
1657 | remove all menus from the menuBar, the same as B<[clear]> |
|
|
1658 | |
|
|
1659 | =item B<< -+I</path>menu+ >> |
|
|
1660 | |
|
|
1661 | remove menu |
|
|
1662 | |
|
|
1663 | =item B<< -+I</path>{item}+ >> |
|
|
1664 | |
|
|
1665 | remove item |
|
|
1666 | |
|
|
1667 | =item B<< -+I</path>{-} >> |
|
|
1668 | |
|
|
1669 | remove separator) |
|
|
1670 | |
|
|
1671 | =item B<-/path/menu/*> |
|
|
1672 | |
|
|
1673 | remove all items, separators and submenus from menu |
|
|
1674 | |
|
|
1675 | =back |
|
|
1676 | |
|
|
1677 | X<menuBarArrows> |
|
|
1678 | |
|
|
1679 | =head2 Quick Arrows |
|
|
1680 | |
|
|
1681 | The menus also provide a hook for I<quick arrows> to provide easier |
|
|
1682 | user access. If nothing has been explicitly set, the default is to |
|
|
1683 | emulate the curror keys. The syntax permits each arrow to be altered |
|
|
1684 | individually or all four at once without re-entering their common |
|
|
1685 | beginning/end text. For example, to explicitly associate cursor actions |
|
|
1686 | with the arrows, any of the following forms could be used: |
|
|
1687 | |
|
|
1688 | =over 4 |
|
|
1689 | |
|
|
1690 | =item B<< <r>+I<Right> >> |
|
|
1691 | |
|
|
1692 | =item B<< <l>+I<Left> >> |
|
|
1693 | |
|
|
1694 | =item B<< <u>+I<Up> >> |
|
|
1695 | |
|
|
1696 | =item B<< <d>+I<Down> >> |
|
|
1697 | |
|
|
1698 | Define actions for the respective arrow buttons |
|
|
1699 | |
|
|
1700 | =item B<< <b>+I<Begin> >> |
|
|
1701 | |
|
|
1702 | =item B<< <e>+I<End> >> |
|
|
1703 | |
|
|
1704 | Define common beginning/end parts for I<quick arrows> which used in |
|
|
1705 | conjunction with the above <r> <l> <u> <d> constructs |
|
|
1706 | |
|
|
1707 | =back |
|
|
1708 | |
|
|
1709 | =over 4 |
|
|
1710 | |
|
|
1711 | =item For example, define arrows individually, |
|
|
1712 | |
|
|
1713 | <u>\E[A |
|
|
1714 | |
|
|
1715 | <d>\E[B |
|
|
1716 | |
|
|
1717 | <r>\E[C |
|
|
1718 | |
|
|
1719 | <l>\E[D |
|
|
1720 | |
|
|
1721 | =item or all at once |
|
|
1722 | |
|
|
1723 | <u>\E[AZ<><d>\E[BZ<><r>\E[CZ<><l>\E[D |
|
|
1724 | |
|
|
1725 | =item or more compactly (factoring out common parts) |
|
|
1726 | |
|
|
1727 | <b>\E[<u>AZ<><d>BZ<><r>CZ<><l>D |
|
|
1728 | |
|
|
1729 | =back |
|
|
1730 | |
|
|
1731 | X<menuBarSummary> |
|
|
1732 | |
|
|
1733 | =head2 Command Summary |
|
|
1734 | |
|
|
1735 | A short summary of the most I<common> commands: |
|
|
1736 | |
|
|
1737 | =over 4 |
|
|
1738 | |
|
|
1739 | =item [menu:name] |
|
|
1740 | |
|
|
1741 | use an existing named menuBar or start a new one |
|
|
1742 | |
|
|
1743 | =item [menu] |
|
|
1744 | |
|
|
1745 | use the current menuBar |
|
|
1746 | |
|
|
1747 | =item [title:string] |
|
|
1748 | |
|
|
1749 | set menuBar title |
|
|
1750 | |
|
|
1751 | =item [done] |
|
|
1752 | |
|
|
1753 | set menu access to readonly and, if reading from a file, signal EOF |
|
|
1754 | |
|
|
1755 | =item [done:name] |
|
|
1756 | |
|
|
1757 | if reading from a file using [read:file;name] signal EOF |
|
|
1758 | |
|
|
1759 | =item [rm:name] |
|
|
1760 | |
|
|
1761 | remove named menuBar(s) |
|
|
1762 | |
|
|
1763 | =item [rm] [rm:] |
|
|
1764 | |
|
|
1765 | remove current menuBar |
|
|
1766 | |
|
|
1767 | =item [rm*] [rm:*] |
|
|
1768 | |
|
|
1769 | remove all menuBar(s) |
|
|
1770 | |
|
|
1771 | =item [swap] |
|
|
1772 | |
|
|
1773 | swap top two menuBars |
|
|
1774 | |
|
|
1775 | =item [prev] |
|
|
1776 | |
|
|
1777 | access the previous menuBar |
|
|
1778 | |
|
|
1779 | =item [next] |
|
|
1780 | |
|
|
1781 | access the next menuBar |
|
|
1782 | |
|
|
1783 | =item [show] |
|
|
1784 | |
|
|
1785 | map menuBar |
|
|
1786 | |
|
|
1787 | =item [hide] |
|
|
1788 | |
|
|
1789 | unmap menuBar |
|
|
1790 | |
|
|
1791 | =item [pixmap;file] |
|
|
1792 | |
|
|
1793 | =item [pixmap;file;scaling] |
|
|
1794 | |
|
|
1795 | set a background pixmap |
|
|
1796 | |
|
|
1797 | =item [read:file] |
|
|
1798 | |
|
|
1799 | =item [read:file;name] |
|
|
1800 | |
|
|
1801 | read in a menu from a file |
|
|
1802 | |
|
|
1803 | =item [dump] |
|
|
1804 | |
|
|
1805 | dump out all menuBars to /tmp/rxvt-PID |
|
|
1806 | |
|
|
1807 | =item / |
|
|
1808 | |
|
|
1809 | access menuBar top level |
|
|
1810 | |
|
|
1811 | =item ./ |
|
|
1812 | |
|
|
1813 | =item ../ |
|
|
1814 | |
|
|
1815 | =item ../../ |
|
|
1816 | |
|
|
1817 | access current or parent menu level |
|
|
1818 | |
|
|
1819 | =item /path/menu |
|
|
1820 | |
|
|
1821 | add/access menu |
|
|
1822 | |
|
|
1823 | =item /path/{-} |
|
|
1824 | |
|
|
1825 | add separator |
|
|
1826 | |
|
|
1827 | =item /path/{item}{rtext} action |
|
|
1828 | |
|
|
1829 | add/alter menu item |
|
|
1830 | |
|
|
1831 | =item -/* |
|
|
1832 | |
|
|
1833 | remove all menus from the menuBar |
|
|
1834 | |
|
|
1835 | =item -/path/menu |
|
|
1836 | |
|
|
1837 | remove menu items, separators and submenus from menu |
|
|
1838 | |
|
|
1839 | =item -/path/menu |
|
|
1840 | |
|
|
1841 | remove menu |
|
|
1842 | |
|
|
1843 | =item -/path/{item} |
|
|
1844 | |
|
|
1845 | remove item |
|
|
1846 | |
|
|
1847 | =item -/path/{-} |
|
|
1848 | |
|
|
1849 | remove separator |
|
|
1850 | |
|
|
1851 | =item <b>Begin<r>Right<l>Left<u>Up<d>Down<e>End |
|
|
1852 | |
|
|
1853 | menu quick arrows |
|
|
1854 | |
|
|
1855 | =back |
|
|
1856 | X<XPM> |
1808 | X<XPM> |
1857 | |
1809 | |
1858 | =head1 XPM |
1810 | =head1 XPM |
1859 | |
1811 | |
1860 | For the XPM XTerm escape sequence B<< C<ESC ] 20 ; Pt ST> >> then value |
1812 | For the XPM XTerm escape sequence B<< C<ESC ] 20 ; Pt ST> >> then value |
… | |
… | |
2046 | =end table |
1998 | =end table |
2047 | |
1999 | |
2048 | =head1 CONFIGURE OPTIONS |
2000 | =head1 CONFIGURE OPTIONS |
2049 | |
2001 | |
2050 | General hint: if you get compile errors, then likely your configuration |
2002 | General hint: if you get compile errors, then likely your configuration |
2051 | hasn't been tested well. Either try with --enable-everything or use the |
2003 | hasn't been tested well. Either try with C<--enable-everything> or use |
2052 | ./reconf script as a base for experiments. ./reconf is used by myself, |
2004 | the F<./reconf> script as a base for experiments. F<./reconf> is used by |
2053 | so it should generally be a working config. Of course, you should always |
2005 | myself, so it should generally be a working config. Of course, you should |
2054 | report when a combination doesn't work, so it can be fixed. Marc Lehmann |
2006 | always report when a combination doesn't work, so it can be fixed. Marc |
2055 | <rxvt@schmorp.de>. |
2007 | Lehmann <rxvt@schmorp.de>. |
|
|
2008 | |
|
|
2009 | All |
2056 | |
2010 | |
2057 | =over 4 |
2011 | =over 4 |
2058 | |
2012 | |
2059 | =item --enable-everything |
2013 | =item --enable-everything |
2060 | |
2014 | |
2061 | Add support for all non-multichoice options listed in "./configure |
2015 | Add (or remove) support for all non-multichoice options listed in "./configure |
2062 | --help". Note that unlike other enable options this is order dependant. |
2016 | --help". |
|
|
2017 | |
2063 | You can specify this and then disable options which this enables by |
2018 | You can specify this and then disable options you do not like by |
2064 | I<following> this with the appropriate commands. |
2019 | I<following> this with the appropriate C<--disable-...> arguments, |
|
|
2020 | or you can start with a minimal configuration by specifying |
|
|
2021 | C<--disable-everything> and than adding just the C<--enable-...> arguments |
|
|
2022 | you want. |
2065 | |
2023 | |
2066 | =item --enable-xft |
2024 | =item --enable-xft (default: enabled) |
2067 | |
2025 | |
2068 | Add support for Xft (anti-aliases, among others) fonts. Xft fonts are |
2026 | Add support for Xft (anti-aliases, among others) fonts. Xft fonts are |
2069 | slower and require lots of memory, but as long as you don't use them, you |
2027 | slower and require lots of memory, but as long as you don't use them, you |
2070 | don't pay for them. |
2028 | don't pay for them. |
2071 | |
2029 | |
2072 | =item --enable-font-styles |
2030 | =item --enable-font-styles (default: on) |
2073 | |
2031 | |
2074 | Add support for B<bold>, I<italic> and B<< I<bold italic> >> font |
2032 | Add support for B<bold>, I<italic> and B<< I<bold italic> >> font |
2075 | styles. The fonts can be set manually or automatically. |
2033 | styles. The fonts can be set manually or automatically. |
2076 | |
2034 | |
2077 | =item --with-codesets=NAME,... |
2035 | =item --with-codesets=NAME,... (default: all) |
2078 | |
2036 | |
2079 | Compile in support for additional codeset (encoding) groups (eu, vn are |
2037 | Compile in support for additional codeset (encoding) groups (C<eu>, C<vn> |
2080 | always compiled in, which includes most 8-bit character sets). These |
2038 | are always compiled in, which includes most 8-bit character sets). These |
2081 | codeset tables are currently only used for driving X11 core fonts, they |
2039 | codeset tables are used for driving X11 core fonts, they are not required |
2082 | are not required for Xft fonts. Compiling them in will make your binary |
2040 | for Xft fonts, although having them compiled in lets rxvt-unicode choose |
2083 | bigger (together about 700kB), but it doesn't increase memory usage unless |
2041 | replacement fonts more intelligently. Compiling them in will make your |
|
|
2042 | binary bigger (all of together cost about 700kB), but it doesn't increase |
2084 | you use an X11 font requiring one of these encodings. |
2043 | memory usage unless you use a font requiring one of these encodings. |
2085 | |
2044 | |
2086 | =begin table |
2045 | =begin table |
2087 | |
2046 | |
2088 | all all available codeset groups |
2047 | all all available codeset groups |
2089 | zh common chinese encodings |
2048 | zh common chinese encodings |
… | |
… | |
2092 | jp_ext rarely used but big japanese encodings |
2051 | jp_ext rarely used but big japanese encodings |
2093 | kr korean encodings |
2052 | kr korean encodings |
2094 | |
2053 | |
2095 | =end table |
2054 | =end table |
2096 | |
2055 | |
2097 | =item --enable-xim |
2056 | =item --enable-xim (default: on) |
2098 | |
2057 | |
2099 | Add support for XIM (X Input Method) protocol. This allows using |
2058 | Add support for XIM (X Input Method) protocol. This allows using |
2100 | alternative input methods (e.g. kinput2) and will also correctly |
2059 | alternative input methods (e.g. kinput2) and will also correctly |
2101 | set up the input for people using dead keys or compose keys. |
2060 | set up the input for people using dead keys or compose keys. |
2102 | |
2061 | |
2103 | =item --enable-unicode3 |
2062 | =item --enable-unicode3 (default: off) |
|
|
2063 | |
|
|
2064 | Recommended to stay off unless you really need non-BMP characters. |
2104 | |
2065 | |
2105 | Enable direct support for displaying unicode codepoints above |
2066 | Enable direct support for displaying unicode codepoints above |
2106 | 65535 (the basic multilingual page). This increases storage |
2067 | 65535 (the basic multilingual page). This increases storage |
2107 | requirements per character from 2 to 4 bytes. X11 fonts do not yet |
2068 | requirements per character from 2 to 4 bytes. X11 fonts do not yet |
2108 | support these extra characters, but Xft does. |
2069 | support these extra characters, but Xft does. |
… | |
… | |
2111 | even without this flag, but the number of such characters is |
2072 | even without this flag, but the number of such characters is |
2112 | limited to a view thousand (shared with combining characters, |
2073 | limited to a view thousand (shared with combining characters, |
2113 | see next switch), and right now rxvt-unicode cannot display them |
2074 | see next switch), and right now rxvt-unicode cannot display them |
2114 | (input/output and cut&paste still work, though). |
2075 | (input/output and cut&paste still work, though). |
2115 | |
2076 | |
2116 | =item --enable-combining |
2077 | =item --enable-combining (default: on) |
2117 | |
2078 | |
2118 | Enable automatic composition of combining characters into |
2079 | Enable automatic composition of combining characters into |
2119 | composite characters. This is required for proper viewing of text |
2080 | composite characters. This is required for proper viewing of text |
2120 | where accents are encoded as seperate unicode characters. This is |
2081 | where accents are encoded as seperate unicode characters. This is |
2121 | done by using precomposited characters when available or creating |
2082 | done by using precomposited characters when available or creating |
2122 | new pseudo-characters when no precomposed form exists. |
2083 | new pseudo-characters when no precomposed form exists. |
2123 | |
2084 | |
2124 | Without --enable-unicode3, the number of additional precomposed |
2085 | Without --enable-unicode3, the number of additional precomposed |
2125 | characters is rather limited (2048, if this is full, rxvt will use the |
2086 | characters is somewhat limited (the 6400 private use characters will be |
2126 | private use area, extending the number of combinations to 8448). With |
2087 | (ab-)used). With --enable-unicode3, no practical limit exists. |
2127 | --enable-unicode3, no practical limit exists. This will also enable |
2088 | |
2128 | storage of characters >65535. |
2089 | This option will also enable storage (but not display) of characters |
|
|
2090 | beyond plane 0 (>65535) when --enable-unicode3 was not specified. |
2129 | |
2091 | |
2130 | The combining table also contains entries for arabic presentation forms, |
2092 | The combining table also contains entries for arabic presentation forms, |
2131 | but these are not currently used. Bug me if you want these to be used. |
2093 | but these are not currently used. Bug me if you want these to be used (and |
|
|
2094 | tell me how these are to be used...). |
2132 | |
2095 | |
2133 | =item --enable-fallback(=CLASS) |
2096 | =item --enable-fallback(=CLASS) (default: Rxvt) |
2134 | |
2097 | |
2135 | When reading resource settings, also read settings for class CLASS |
2098 | When reading resource settings, also read settings for class CLASS. To |
2136 | (default: Rxvt). To disable resource fallback use --disable-fallback. |
2099 | disable resource fallback use --disable-fallback. |
2137 | |
2100 | |
2138 | =item --with-res-name=NAME |
2101 | =item --with-res-name=NAME (default: urxvt) |
2139 | |
2102 | |
2140 | Use the given name (default: urxvt) as default application name when |
2103 | Use the given name as default application name when |
2141 | reading resources. Specify --with-res-name=rxvt to replace rxvt. |
2104 | reading resources. Specify --with-res-name=rxvt to replace rxvt. |
2142 | |
2105 | |
2143 | =item --with-res-class=CLASS |
2106 | =item --with-res-class=CLASS /default: URxvt) |
2144 | |
2107 | |
2145 | Use the given class (default: URxvt) as default application class |
2108 | Use the given class as default application class |
2146 | when reading resources. Specify --with-res-class=Rxvt to replace |
2109 | when reading resources. Specify --with-res-class=Rxvt to replace |
2147 | rxvt. |
2110 | rxvt. |
2148 | |
2111 | |
2149 | =item --enable-utmp |
2112 | =item --enable-utmp (default: on) |
2150 | |
2113 | |
2151 | Write user and tty to utmp file (used by programs like F<w>) at |
2114 | Write user and tty to utmp file (used by programs like F<w>) at |
2152 | start of rxvt execution and delete information when rxvt exits. |
2115 | start of rxvt execution and delete information when rxvt exits. |
2153 | |
2116 | |
2154 | =item --enable-wtmp |
2117 | =item --enable-wtmp (default: on) |
2155 | |
2118 | |
2156 | Write user and tty to wtmp file (used by programs like F<last>) at |
2119 | Write user and tty to wtmp file (used by programs like F<last>) at |
2157 | start of rxvt execution and write logout when rxvt exits. This |
2120 | start of rxvt execution and write logout when rxvt exits. This |
2158 | option requires --enable-utmp to also be specified. |
2121 | option requires --enable-utmp to also be specified. |
2159 | |
2122 | |
2160 | =item --enable-lastlog |
2123 | =item --enable-lastlog (default: on) |
2161 | |
2124 | |
2162 | Write user and tty to lastlog file (used by programs like |
2125 | Write user and tty to lastlog file (used by programs like |
2163 | F<lastlogin>) at start of rxvt execution. This option requires |
2126 | F<lastlogin>) at start of rxvt execution. This option requires |
2164 | --enable-utmp to also be specified. |
2127 | --enable-utmp to also be specified. |
2165 | |
2128 | |
2166 | =item --enable-xpm-background |
2129 | =item --enable-xpm-background (default: on) |
2167 | |
2130 | |
2168 | Add support for XPM background pixmaps. |
2131 | Add support for XPM background pixmaps. |
2169 | |
2132 | |
2170 | =item --enable-transparency |
2133 | =item --enable-transparency (default: on) |
2171 | |
2134 | |
2172 | Add support for inheriting parent backgrounds thus giving a fake |
2135 | Add support for inheriting parent backgrounds thus giving a fake |
2173 | transparency to the term. |
2136 | transparency to the term. |
2174 | |
2137 | |
2175 | =item --enable-fading |
2138 | =item --enable-fading (default: on) |
2176 | |
2139 | |
2177 | Add support for fading the text when focus is lost. |
2140 | Add support for fading the text when focus is lost (requires C<--enable-transparency>). |
2178 | |
2141 | |
2179 | =item --enable-tinting |
2142 | =item --enable-tinting (default: on) |
2180 | |
2143 | |
2181 | Add support for tinting of transparent backgrounds. |
2144 | Add support for tinting of transparent backgrounds (requires C<--enable-transparency>). |
2182 | |
2145 | |
2183 | =item --enable-menubar |
|
|
2184 | |
|
|
2185 | Add support for our menu bar system (this interacts badly with |
|
|
2186 | dynamic locale switching currently). |
|
|
2187 | |
|
|
2188 | =item --enable-rxvt-scroll |
2146 | =item --enable-rxvt-scroll (default: on) |
2189 | |
2147 | |
2190 | Add support for the original rxvt scrollbar. |
2148 | Add support for the original rxvt scrollbar. |
2191 | |
2149 | |
2192 | =item --enable-next-scroll |
2150 | =item --enable-next-scroll (default: on) |
2193 | |
2151 | |
2194 | Add support for a NeXT-like scrollbar. |
2152 | Add support for a NeXT-like scrollbar. |
2195 | |
2153 | |
2196 | =item --enable-xterm-scroll |
2154 | =item --enable-xterm-scroll (default: on) |
2197 | |
2155 | |
2198 | Add support for an Xterm-like scrollbar. |
2156 | Add support for an Xterm-like scrollbar. |
2199 | |
2157 | |
2200 | =item --enable-plain-scroll |
2158 | =item --enable-plain-scroll (default: on) |
2201 | |
2159 | |
2202 | Add support for a very unobtrusive, plain-looking scrollbar that |
2160 | Add support for a very unobtrusive, plain-looking scrollbar that |
2203 | is the favourite of the rxvt-unicode author, having used it for |
2161 | is the favourite of the rxvt-unicode author, having used it for |
2204 | many years. |
2162 | many years. |
2205 | |
2163 | |
2206 | =item --enable-half-shadow |
2164 | =item --enable-ttygid (default: off) |
2207 | |
|
|
2208 | Make shadows on the scrollbar only half the normal width & height. |
|
|
2209 | only applicable to rxvt scrollbars. |
|
|
2210 | |
|
|
2211 | =item --enable-ttygid |
|
|
2212 | |
2165 | |
2213 | Change tty device setting to group "tty" - only use this if |
2166 | Change tty device setting to group "tty" - only use this if |
2214 | your system uses this type of security. |
2167 | your system uses this type of security. |
2215 | |
2168 | |
2216 | =item --disable-backspace-key |
2169 | =item --disable-backspace-key |
2217 | |
2170 | |
2218 | Disable any handling of the backspace key by us - let the X server |
2171 | Removes any handling of the backspace key by us - let the X server do it. |
|
|
2172 | |
|
|
2173 | =item --disable-delete-key |
|
|
2174 | |
|
|
2175 | Removes any handling of the delete key by us - let the X server |
2219 | do it. |
2176 | do it. |
2220 | |
2177 | |
2221 | =item --disable-delete-key |
|
|
2222 | |
|
|
2223 | Disable any handling of the delete key by us - let the X server |
|
|
2224 | do it. |
|
|
2225 | |
|
|
2226 | =item --disable-resources |
2178 | =item --disable-resources |
2227 | |
2179 | |
2228 | Remove all resources checking. |
2180 | Removes any support for resource checking. |
2229 | |
|
|
2230 | =item --enable-xgetdefault |
|
|
2231 | |
|
|
2232 | Make resources checking via XGetDefault() instead of our small |
|
|
2233 | version which only checks ~/.Xdefaults, or if that doesn't exist |
|
|
2234 | then ~/.Xresources. |
|
|
2235 | |
|
|
2236 | =item --enable-strings |
|
|
2237 | |
|
|
2238 | Add support for our possibly faster memset() function and other |
|
|
2239 | various routines, overriding your system's versions which may |
|
|
2240 | have been hand-crafted in assembly or may require extra libraries |
|
|
2241 | to link in. (this breaks ANSI-C rules and has problems on many |
|
|
2242 | GNU/Linux systems). |
|
|
2243 | |
2181 | |
2244 | =item --disable-swapscreen |
2182 | =item --disable-swapscreen |
2245 | |
2183 | |
2246 | Remove support for swap screen. |
2184 | Remove support for secondary/swap screen. |
2247 | |
2185 | |
2248 | =item --enable-frills |
2186 | =item --enable-frills (default: on) |
2249 | |
2187 | |
2250 | Add support for many small features that are not essential but nice to |
2188 | Add support for many small features that are not essential but nice to |
2251 | have. Normally you want this, but for very small binaries you may want to |
2189 | have. Normally you want this, but for very small binaries you may want to |
2252 | disable this. |
2190 | disable this. |
2253 | |
2191 | |
|
|
2192 | A non-exhaustive list of features enabled by C<--enable-frills> (possibly |
|
|
2193 | in combination with other switches) is: |
|
|
2194 | |
|
|
2195 | MWM-hints |
|
|
2196 | EWMH-hints (pid, utf8 names) and protocols (ping) |
|
|
2197 | seperate underline colour (-underlineColor) |
|
|
2198 | settable border widths and borderless switch (-w, -b, -bl) |
|
|
2199 | visual depth selection (-depth) |
|
|
2200 | settable extra linespacing /-lsp) |
|
|
2201 | iso-14755-2 and -3, and visual feedback |
|
|
2202 | tripleclickwords (-tcw) |
|
|
2203 | settable insecure mode (-insecure) |
|
|
2204 | keysym remapping support |
|
|
2205 | cursor blinking and underline cursor (-cb, -uc) |
|
|
2206 | XEmbed support (-embed) |
|
|
2207 | user-pty (-pty-fd) |
|
|
2208 | hold on exit (-hold) |
|
|
2209 | skip builtin block graphics (-sbg) |
|
|
2210 | |
|
|
2211 | It also enabled some non-essential features otherwise disabled, such as: |
|
|
2212 | |
|
|
2213 | some round-trip time optimisations |
|
|
2214 | nearest color allocation on pseudocolor screens |
|
|
2215 | UTF8_STRING supporr for selection |
|
|
2216 | sgr modes 90..97 and 100..107 |
|
|
2217 | backindex and forwardindex escape sequences |
|
|
2218 | view change/zero scorllback esacpe sequences |
|
|
2219 | locale switching escape sequence |
|
|
2220 | window op and some xterm/OSC escape sequences |
|
|
2221 | rectangular selections |
|
|
2222 | trailing space removal for selections |
|
|
2223 | verbose X error handling |
|
|
2224 | |
2254 | =item --enable-iso14755 |
2225 | =item --enable-iso14755 (default: on) |
2255 | |
2226 | |
2256 | Enable extended ISO 14755 support (see @@RXVT_NAME@@(1), or |
2227 | Enable extended ISO 14755 support (see @@RXVT_NAME@@(1), or |
2257 | F<doc/rxvt.1.txt>). Basic support (section 5.1) is enabled by |
2228 | F<doc/rxvt.1.txt>). Basic support (section 5.1) is enabled by |
2258 | C<--enable-frills>, while support for 5.2, 5.3 and 5.4 is enabled with |
2229 | C<--enable-frills>, while support for 5.2, 5.3 and 5.4 is enabled with |
2259 | this switch. |
2230 | this switch. |
2260 | |
2231 | |
2261 | =item --enable-linespace |
|
|
2262 | |
|
|
2263 | Add support to provide user specified line spacing between text rows. |
|
|
2264 | |
|
|
2265 | =item --enable-keepscrolling |
2232 | =item --enable-keepscrolling (default: on) |
2266 | |
2233 | |
2267 | Add support for continual scrolling of the display when you hold |
2234 | Add support for continual scrolling of the display when you hold |
2268 | the mouse button down on a scrollbar arrow. |
2235 | the mouse button down on a scrollbar arrow. |
2269 | |
2236 | |
2270 | =item --enable-mousewheel |
2237 | =item --enable-mousewheel (default: on) |
2271 | |
2238 | |
2272 | Add support for scrolling via mouse wheel or buttons 4 & 5. |
2239 | Add support for scrolling via mouse wheel or buttons 4 & 5. |
2273 | |
2240 | |
2274 | =item --enable-slipwheeling |
2241 | =item --enable-slipwheeling (default: on) |
2275 | |
2242 | |
2276 | Add support for continual scrolling (using the mouse wheel as an |
2243 | Add support for continual scrolling (using the mouse wheel as an |
2277 | accelerator) while the control key is held down. This option |
2244 | accelerator) while the control key is held down. This option |
2278 | requires --enable-mousewheel to also be specified. |
2245 | requires --enable-mousewheel to also be specified. |
2279 | |
2246 | |
2280 | =item --disable-new-selection |
2247 | =item --disable-new-selection |
2281 | |
2248 | |
2282 | Remove support for mouse selection style like that of xterm. |
2249 | Remove support for mouse selection style like that of xterm. |
2283 | |
2250 | |
2284 | =item --enable-dmalloc |
2251 | =item --enable-dmalloc (default: off) |
2285 | |
2252 | |
2286 | Use Gray Watson's malloc - which is good for debugging See |
2253 | Use Gray Watson's malloc - which is good for debugging See |
2287 | http://www.letters.com/dmalloc/ for details If you use either this or the |
2254 | http://www.letters.com/dmalloc/ for details If you use either this or the |
2288 | next option, you may need to edit src/Makefile after compiling to point |
2255 | next option, you may need to edit src/Makefile after compiling to point |
2289 | DINCLUDE and DLIB to the right places. |
2256 | DINCLUDE and DLIB to the right places. |
2290 | |
2257 | |
2291 | You can only use either this option and the following (should |
2258 | You can only use either this option and the following (should |
2292 | you use either) . |
2259 | you use either) . |
2293 | |
2260 | |
2294 | =item --enable-dlmalloc |
2261 | =item --enable-dlmalloc (default: off) |
2295 | |
2262 | |
2296 | Use Doug Lea's malloc - which is good for a production version |
2263 | Use Doug Lea's malloc - which is good for a production version |
2297 | See L<http://g.oswego.edu/dl/html/malloc.html> for details. |
2264 | See L<http://g.oswego.edu/dl/html/malloc.html> for details. |
2298 | |
2265 | |
2299 | =item --enable-smart-resize |
2266 | =item --enable-smart-resize (default: on) |
2300 | |
2267 | |
2301 | Add smart growth/shrink behaviour when changing font size via from hot |
2268 | Add smart growth/shrink behaviour when changing font size via hot |
2302 | keys. This should keep in a fixed position the rxvt corner which is |
2269 | keys. This should keep the window corner which is closest to a corner of |
2303 | closest to a corner of the screen. |
2270 | the screen in a fixed position. |
2304 | |
2271 | |
2305 | =item --enable-cursor-blink |
|
|
2306 | |
|
|
2307 | Add support for a blinking cursor. |
|
|
2308 | |
|
|
2309 | =item --enable-pointer-blank |
2272 | =item --enable-pointer-blank (default: on) |
2310 | |
2273 | |
2311 | Add support to have the pointer disappear when typing or inactive. |
2274 | Add support to have the pointer disappear when typing or inactive. |
2312 | |
2275 | |
2313 | =item --with-name=NAME |
2276 | =item --enable-perl (default: on) |
2314 | |
2277 | |
|
|
2278 | Enable an embedded perl interpreter. See the B<@@RXVT_NAME@@perl(3)> |
|
|
2279 | manpage (F<doc/rxvtperl.txt>) for more info on this feature, or the files |
|
|
2280 | in F<src/perl-ext/> for the extensions that are installed by default. The |
|
|
2281 | perl interpreter that is used can be specified via the C<PERL> environment |
|
|
2282 | variable when running configure. |
|
|
2283 | |
|
|
2284 | =item --with-name=NAME (default: urxvt) |
|
|
2285 | |
2315 | Set the basename for the installed binaries (default: urxvt, resulting in |
2286 | Set the basename for the installed binaries, resulting |
2316 | urxvt, urxvtd etc.). Specify --with-name=rxvt to replace rxvt. |
2287 | in C<urxvt>, C<urxvtd> etc.). Specify C<--with-name=rxvt> to replace with |
|
|
2288 | C<rxvt>. |
2317 | |
2289 | |
2318 | =item --with-term=NAME |
2290 | =item --with-term=NAME (default: rxvt-unicode) |
2319 | |
2291 | |
2320 | Change the environmental variable for the terminal to NAME (default |
2292 | Change the environmental variable for the terminal to NAME. |
2321 | "rxvt") |
|
|
2322 | |
2293 | |
2323 | =item --with-terminfo=PATH |
2294 | =item --with-terminfo=PATH |
2324 | |
2295 | |
2325 | Change the environmental variable for the path to the terminfo tree to |
2296 | Change the environmental variable for the path to the terminfo tree to |
2326 | PATH. |
2297 | PATH. |