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