1 |
=head1 NAME |
2 |
|
3 |
RXVT REFERENCE - FAQ, command sequences and other background information |
4 |
|
5 |
=head1 SYNOPSIS |
6 |
|
7 |
# set a new font set |
8 |
printf '\33]50;%s\007' 9x15,xft:Kochi" Mincho" |
9 |
|
10 |
# change the locale and tell rxvt-unicode about it |
11 |
export LC_CTYPE=ja_JP.EUC-JP; printf "\33]701;$LC_CTYPE\007" |
12 |
|
13 |
# set window title |
14 |
printf '\33]2;%s\007' "new window title" |
15 |
|
16 |
=head1 DESCRIPTION |
17 |
|
18 |
This document contains the FAQ, the RXVT TECHNICAL REFERENCE documenting |
19 |
all escape sequences, and other background information. |
20 |
|
21 |
The newest version of this document is |
22 |
also available on the World Wide Web at |
23 |
L<http://cvs.schmorp.de/browse/*checkout*/rxvt-unicode/doc/rxvt.7.html>. |
24 |
|
25 |
=head1 FREQUENTLY ASKED QUESTIONS |
26 |
|
27 |
=over 4 |
28 |
|
29 |
=item Isn't rxvt supposed to be small? Don't all those features bloat? |
30 |
|
31 |
I often get asked about this, and I think, no, they didn't cause extra |
32 |
bloat. If you compare a minimal rxvt and a minimal urxvt, you can see |
33 |
that the urxvt binary is larger (due to some encoding tables always being |
34 |
compiled in), but it actually uses less memory (RSS) after startup. Even |
35 |
with C<--disable-everything>, this comparison is a bit unfair, as many |
36 |
features unique to urxvt (locale, encoding conversion, iso14755 etc.) are |
37 |
already in use in this mode. |
38 |
|
39 |
text data bss drs rss filename |
40 |
98398 1664 24 15695 1824 rxvt --disable-everything |
41 |
188985 9048 66616 18222 1788 urxvt --disable-everything |
42 |
|
43 |
When you C<--enable-everything> (which _is_ unfair, as this involves xft |
44 |
and full locale/XIM support which are quite bloaty inside libX11 and my |
45 |
libc), the two diverge, but not unreasnobaly so. |
46 |
|
47 |
text data bss drs rss filename |
48 |
163431 2152 24 20123 2060 rxvt --enable-everything |
49 |
1035683 49680 66648 29096 3680 urxvt --enable-everything |
50 |
|
51 |
The very large size of the text section is explained by the east-asian |
52 |
encoding tables, which, if unused, take up disk space but nothing else |
53 |
and can be compiled out unless you rely on X11 core fonts that use those |
54 |
encodings. The BSS size comes from the 64k emergency buffer that my c++ |
55 |
compiler allocates (but of course doesn't use unless you are out of |
56 |
memory). Also, using an xft font instead of a core font immediately adds a |
57 |
few megabytes of RSS. Xft indeed is responsible for a lot of RSS even when |
58 |
not used. |
59 |
|
60 |
Of course, due to every character using two or four bytes instead of one, |
61 |
a large scrollback buffer will ultimately make rxvt-unicode use more |
62 |
memory. |
63 |
|
64 |
Compared to e.g. Eterm (5112k), aterm (3132k) and xterm (4680k), this |
65 |
still fares rather well. And compared to some monsters like gnome-terminal |
66 |
(21152k + extra 4204k in separate processes) or konsole (22200k + extra |
67 |
43180k in daemons that stay around after exit, plus half aminute of |
68 |
startup time, including the hundreds of warnings it spits out), it fares |
69 |
extremely well *g*. |
70 |
|
71 |
=item Why C++, isn't that unportable/bloated/uncool? |
72 |
|
73 |
Is this a question? :) It comes up very often. The simple answer is: I had |
74 |
to write it, and C++ allowed me to write and maintain it in a fraction |
75 |
of the time and effort (which is a scarce resource for me). Put even |
76 |
shorter: It simply wouldn't exist without C++. |
77 |
|
78 |
My personal stance on this is that C++ is less portable than C, but in |
79 |
the case of rxvt-unicode this hardly matters, as its portability limits |
80 |
are defined by things like X11, pseudo terminals, locale support and unix |
81 |
domain sockets, which are all less portable than C++ itself. |
82 |
|
83 |
Regarding the bloat, see the above question: It's easy to write programs |
84 |
in C that use gobs of memory, an certainly possible to write programs in |
85 |
C++ that don't. C++ also often comes with large libraries, but this is |
86 |
not necessarily the case with GCC. Here is what rxvt links against on my |
87 |
system with a minimal config: |
88 |
|
89 |
libX11.so.6 => /usr/X11R6/lib/libX11.so.6 (0x00002aaaaabc3000) |
90 |
libc.so.6 => /lib/libc.so.6 (0x00002aaaaadde000) |
91 |
libdl.so.2 => /lib/libdl.so.2 (0x00002aaaab01d000) |
92 |
/lib64/ld-linux-x86-64.so.2 (0x00002aaaaaaab000) |
93 |
|
94 |
And here is rxvt-unicode: |
95 |
|
96 |
libX11.so.6 => /usr/X11R6/lib/libX11.so.6 (0x00002aaaaabc3000) |
97 |
libgcc_s.so.1 => /lib/libgcc_s.so.1 (0x00002aaaaada2000) |
98 |
libc.so.6 => /lib/libc.so.6 (0x00002aaaaaeb0000) |
99 |
libdl.so.2 => /lib/libdl.so.2 (0x00002aaaab0ee000) |
100 |
/lib64/ld-linux-x86-64.so.2 (0x00002aaaaaaab000) |
101 |
|
102 |
No large bloated libraries (of course, none were linked in statically), |
103 |
except maybe libX11 :) |
104 |
|
105 |
=item Does it support tabs, can I have a tabbed rxvt-unicode? |
106 |
|
107 |
rxvt-unicode does not directly support tabs. It will work fine with |
108 |
tabbing functionality of many window managers or similar tabbing programs, |
109 |
and its embedding-features allow it to be embedded into other programs, |
110 |
as witnessed by F<doc/rxvt-tabbed> or the upcoming C<Gtk2::URxvt> perl |
111 |
module, which features a tabbed urxvt (murxvt) terminal as an example |
112 |
embedding application. |
113 |
|
114 |
=item How do I know which rxvt-unicode version I'm using? |
115 |
|
116 |
The version number is displayed with the usage (-h). Also the escape |
117 |
sequence C<ESC [ 8 n> sets the window title to the version number. When |
118 |
using the @@RXVT_NAME@@c client, the version displayed is that of the |
119 |
daemon. |
120 |
|
121 |
=item I am using Debian GNU/Linux and have a problem... |
122 |
|
123 |
The Debian GNU/Linux package of rxvt-unicode in sarge contains large |
124 |
patches that considerably change the behaviour of rxvt-unicode. Before |
125 |
reporting a bug to the original rxvt-unicode author please download and |
126 |
install the genuine version (L<http://software.schmorp.de#rxvt-unicode>) |
127 |
and try to reproduce the problem. If you cannot, chances are that the |
128 |
problems are specific to Debian GNU/Linux, in which case it should be |
129 |
reported via the Debian Bug Tracking System (use C<reportbug> to report |
130 |
the bug). |
131 |
|
132 |
For other problems that also affect the Debian package, you can and |
133 |
probably should use the Debian BTS, too, because, after all, it's also a |
134 |
bug in the Debian version and it serves as a reminder for other users that |
135 |
might encounter the same issue. |
136 |
|
137 |
=item When I log-in to another system it tells me about missing terminfo data? |
138 |
|
139 |
The terminal description used by rxvt-unicode is not as widely available |
140 |
as that for xterm, or even rxvt (for which the same problem often arises). |
141 |
|
142 |
The correct solution for this problem is to install the terminfo, this can |
143 |
be done like this (with ncurses' infocmp): |
144 |
|
145 |
REMOTE=remotesystem.domain |
146 |
infocmp rxvt-unicode | ssh $REMOTE "cat >/tmp/ti && tic /tmp/ti" |
147 |
|
148 |
... or by installing rxvt-unicode normally on the remote system, |
149 |
|
150 |
If you cannot or do not want to do this, then you can simply set |
151 |
C<TERM=rxvt> or even C<TERM=xterm>, and live with the small number of |
152 |
problems arising, which includes wrong keymapping, less and different |
153 |
colours and some refresh errors in fullscreen applications. It's a nice |
154 |
quick-and-dirty workaround for rare cases, though. |
155 |
|
156 |
If you always want to do this (and are fine with the consequences) you |
157 |
can either recompile rxvt-unicode with the desired TERM value or use a |
158 |
resource to set it: |
159 |
|
160 |
URxvt.termName: rxvt |
161 |
|
162 |
If you don't plan to use B<rxvt> (quite common...) you could also replace |
163 |
the rxvt terminfo file with the rxvt-unicode one. |
164 |
|
165 |
=item C<tic> outputs some error when compiling the terminfo entry. |
166 |
|
167 |
Most likely it's the empty definition for C<enacs=>. Just replace it by |
168 |
C<enacs=\E[0@> and try again. |
169 |
|
170 |
=item C<bash>'s readline does not work correctly under @@RXVT_NAME@@. |
171 |
|
172 |
=item I need a termcap file entry. |
173 |
|
174 |
One reason you might want this is that some distributions or operating |
175 |
systems still compile some programs using the long-obsoleted termcap |
176 |
library (Fedora Core's bash is one example) and rely on a termcap entry |
177 |
for C<rxvt-unicode>. |
178 |
|
179 |
You could use rxvt's termcap entry with resonable results in many cases. |
180 |
You can also create a termcap entry by using terminfo's infocmp program |
181 |
like this: |
182 |
|
183 |
infocmp -C rxvt-unicode |
184 |
|
185 |
Or you could use this termcap entry, generated by the command above: |
186 |
|
187 |
rxvt-unicode|rxvt-unicode terminal (X Window System):\ |
188 |
:am:bw:eo:km:mi:ms:xn:xo:\ |
189 |
:co#80:it#8:li#24:lm#0:\ |
190 |
:AL=\E[%dL:DC=\E[%dP:DL=\E[%dM:DO=\E[%dB:IC=\E[%d@:\ |
191 |
:K1=\EOw:K2=\EOu:K3=\EOy:K4=\EOq:K5=\EOs:LE=\E[%dD:\ |
192 |
:RI=\E[%dC:SF=\E[%dS:SR=\E[%dT:UP=\E[%dA:ae=\E(B:al=\E[L:\ |
193 |
:as=\E(0:bl=^G:cd=\E[J:ce=\E[K:cl=\E[H\E[2J:\ |
194 |
:cm=\E[%i%d;%dH:cr=^M:cs=\E[%i%d;%dr:ct=\E[3g:dc=\E[P:\ |
195 |
:dl=\E[M:do=^J:ec=\E[%dX:ei=\E[4l:ho=\E[H:\ |
196 |
:i1=\E[?47l\E=\E[?1l:ic=\E[@:im=\E[4h:\ |
197 |
:is=\E[r\E[m\E[2J\E[H\E[?7h\E[?1;3;4;6l\E[4l:\ |
198 |
:k1=\E[11~:k2=\E[12~:k3=\E[13~:k4=\E[14~:k5=\E[15~:\ |
199 |
:k6=\E[17~:k7=\E[18~:k8=\E[19~:k9=\E[20~:kD=\E[3~:\ |
200 |
:kI=\E[2~:kN=\E[6~:kP=\E[5~:kb=\177:kd=\EOB:ke=\E[?1l\E>:\ |
201 |
:kh=\E[7~:kl=\EOD:kr=\EOC:ks=\E[?1h\E=:ku=\EOA:le=^H:\ |
202 |
:mb=\E[5m:md=\E[1m:me=\E[m\017:mr=\E[7m:nd=\E[C:rc=\E8:\ |
203 |
:sc=\E7:se=\E[27m:sf=^J:so=\E[7m:sr=\EM:st=\EH:ta=^I:\ |
204 |
:te=\E[r\E[?1049l:ti=\E[?1049h:ue=\E[24m:up=\E[A:\ |
205 |
:us=\E[4m:vb=\E[?5h\E[?5l:ve=\E[?25h:vi=\E[?25l:\ |
206 |
:vs=\E[?25h: |
207 |
|
208 |
=item Why does C<ls> no longer have coloured output? |
209 |
|
210 |
The C<ls> in the GNU coreutils unfortunately doesn't use terminfo to |
211 |
decide wether a terminal has colour, but uses it's own configuration |
212 |
file. Needless to say, C<rxvt-unicode> is not in it's default file (among |
213 |
with most other terminals supporting colour). Either add: |
214 |
|
215 |
TERM rxvt-unicode |
216 |
|
217 |
to C</etc/DIR_COLORS> or simply add: |
218 |
|
219 |
alias ls='ls --color=auto' |
220 |
|
221 |
to your C<.profile> or C<.bashrc>. |
222 |
|
223 |
=item Why doesn't vim/emacs etc. use the 88 colour mode? |
224 |
|
225 |
=item Why doesn't vim/emacs etc. make use of italic? |
226 |
|
227 |
=item Why are the secondary screen-related options not working properly? |
228 |
|
229 |
Make sure you are using C<TERM=rxvt-unicode>. Some pre-packaged |
230 |
distributions (most notably Debian GNU/Linux) break rxvt-unicode |
231 |
by setting C<TERM> to C<rxvt>, which doesn't have these extra |
232 |
features. Unfortunately, some of these (most notably, again, Debian |
233 |
GNU/Linux) furthermore fail to even install the C<rxvt-unicode> terminfo |
234 |
file, so you will need to install it on your own (See the question B<When |
235 |
I log-in to another system it tells me about missing terminfo data?> on |
236 |
how to do this). |
237 |
|
238 |
=item My numerical keypad acts weird and generates differing output? |
239 |
|
240 |
Some Debian GNUL/Linux users seem to have this problem, although no |
241 |
specific details were reported so far. It is possible that this is caused |
242 |
by the wrong C<TERM> setting, although the details of wether and how |
243 |
this can happen are unknown, as C<TERM=rxvt> should offer a compatible |
244 |
keymap. See the answer to the previous question, and please report if that |
245 |
helped. |
246 |
|
247 |
=item Rxvt-unicode does not seem to understand the selected encoding? |
248 |
|
249 |
=item Unicode does not seem to work? |
250 |
|
251 |
If you encounter strange problems like typing an accented character but |
252 |
getting two unrelated other characters or similar, or if program output is |
253 |
subtly garbled, then you should check your locale settings. |
254 |
|
255 |
Rxvt-unicode must be started with the same C<LC_CTYPE> setting as the |
256 |
programs. Often rxvt-unicode is started in the C<C> locale, while the |
257 |
login script running within the rxvt-unicode window changes the locale to |
258 |
something else, e.g. C<en_GB.UTF-8>. Needless to say, this is not going to work. |
259 |
|
260 |
The best thing is to fix your startup environment, as you will likely run |
261 |
into other problems. If nothing works you can try this in your .profile. |
262 |
|
263 |
printf '\e]701;%s\007' "$LC_CTYPE" |
264 |
|
265 |
If this doesn't work, then maybe you use a C<LC_CTYPE> specification not |
266 |
supported on your systems. Some systems have a C<locale> command which |
267 |
displays this (also, C<perl -e0> can be used to check locale settings, as |
268 |
it will complain loudly if it cannot set the locale). If it displays something |
269 |
like: |
270 |
|
271 |
locale: Cannot set LC_CTYPE to default locale: ... |
272 |
|
273 |
Then the locale you specified is not supported on your system. |
274 |
|
275 |
If nothing works and you are sure that everything is set correctly then |
276 |
you will need to remember a little known fact: Some programs just don't |
277 |
support locales :( |
278 |
|
279 |
=item Why do some characters look so much different than others? |
280 |
|
281 |
=item How does rxvt-unicode choose fonts? |
282 |
|
283 |
Most fonts do not contain the full range of Unicode, which is |
284 |
fine. Chances are that the font you (or the admin/package maintainer of |
285 |
your system/os) have specified does not cover all the characters you want |
286 |
to display. |
287 |
|
288 |
B<rxvt-unicode> makes a best-effort try at finding a replacement |
289 |
font. Often the result is fine, but sometimes the chosen font looks |
290 |
bad/ugly/wrong. Some fonts have totally strange characters that don't |
291 |
resemble the correct glyph at all, and rxvt-unicode lacks the artificial |
292 |
intelligence to detect that a specific glyph is wrong: it has to believe |
293 |
the font that the characters it claims to contain indeed look correct. |
294 |
|
295 |
In that case, select a font of your taste and add it to the font list, |
296 |
e.g.: |
297 |
|
298 |
@@RXVT_NAME@@ -fn basefont,font2,font3... |
299 |
|
300 |
When rxvt-unicode sees a character, it will first look at the base |
301 |
font. If the base font does not contain the character, it will go to the |
302 |
next font, and so on. Specifying your own fonts will also speed up this |
303 |
search and use less resources within rxvt-unicode and the X-server. |
304 |
|
305 |
The only limitation is that none of the fonts may be larger than the base |
306 |
font, as the base font defines the terminal character cell size, which |
307 |
must be the same due to the way terminals work. |
308 |
|
309 |
=item Why do some chinese characters look so different than others? |
310 |
|
311 |
This is because there is a difference between script and language -- |
312 |
rxvt-unicode does not know which language the text that is output is, |
313 |
as it only knows the unicode character codes. If rxvt-unicode first |
314 |
sees a japanese/chinese character, it might choose a japanese font for |
315 |
display. Subsequent japanese characters will use that font. Now, many |
316 |
chinese characters aren't represented in japanese fonts, so when the first |
317 |
non-japanese character comes up, rxvt-unicode will look for a chinese font |
318 |
-- unfortunately at this point, it will still use the japanese font for |
319 |
chinese characters that are also in the japanese font. |
320 |
|
321 |
The workaround is easy: just tag a chinese font at the end of your font |
322 |
list (see the previous question). The key is to view the font list as |
323 |
a preference list: If you expect more japanese, list a japanese font |
324 |
first. If you expect more chinese, put a chinese font first. |
325 |
|
326 |
In the future it might be possible to switch language preferences at |
327 |
runtime (the internal data structure has no problem with using different |
328 |
fonts for the same character at the same time, but no interface for this |
329 |
has been designed yet). |
330 |
|
331 |
Until then, you might get away with switching fonts at runtime (see L<Can |
332 |
I switch the fonts at runtime?> later in this document). |
333 |
|
334 |
=item Why does rxvt-unicode sometimes leave pixel droppings? |
335 |
|
336 |
Most fonts were not designed for terminal use, which means that character |
337 |
size varies a lot. A font that is otherwise fine for terminal use might |
338 |
contain some characters that are simply too wide. Rxvt-unicode will avoid |
339 |
these characters. For characters that are just "a bit" too wide a special |
340 |
"careful" rendering mode is used that redraws adjacent characters. |
341 |
|
342 |
All of this requires that fonts do not lie about character sizes, |
343 |
however: Xft fonts often draw glyphs larger than their acclaimed bounding |
344 |
box, and rxvt-unicode has no way of detecting this (the correct way is to |
345 |
ask for the character bounding box, which unfortunately is wrong in these |
346 |
cases). |
347 |
|
348 |
It's not clear (to me at least), wether this is a bug in Xft, freetype, |
349 |
or the respective font. If you encounter this problem you might try using |
350 |
the C<-lsp> option to give the font more height. If that doesn't work, you |
351 |
might be forced to use a different font. |
352 |
|
353 |
All of this is not a problem when using X11 core fonts, as their bounding |
354 |
box data is correct. |
355 |
|
356 |
=item On Solaris 9, many line-drawing characters are too wide. |
357 |
|
358 |
Seems to be a known bug, read |
359 |
L<http://nixdoc.net/files/forum/about34198.html>. Some people use the |
360 |
following ugly workaround to get non-double-wide-characters working: |
361 |
|
362 |
#define wcwidth(x) wcwidth(x) > 1 ? 1 : wcwidth(x) |
363 |
|
364 |
=item My Compose (Multi_key) key is no longer working. |
365 |
|
366 |
The most common causes for this are that either your locale is not set |
367 |
correctly, or you specified a B<preeditStyle> that is not supported by |
368 |
your input method. For example, if you specified B<OverTheSpot> and |
369 |
your input method (e.g. the default input method handling Compose keys) |
370 |
does not support this (for instance because it is not visual), then |
371 |
rxvt-unicode will continue without an input method. |
372 |
|
373 |
In this case either do not specify a B<preeditStyle> or specify more than |
374 |
one pre-edit style, such as B<OverTheSpot,Root,None>. |
375 |
|
376 |
=item I cannot type C<Ctrl-Shift-2> to get an ASCII NUL character due to ISO 14755 |
377 |
|
378 |
Either try C<Ctrl-2> alone (it often is mapped to ASCII NUL even on |
379 |
international keyboards) or simply use ISO 14755 support to your |
380 |
advantage, typing <Ctrl-Shift-0> to get a ASCII NUL. This works for other |
381 |
codes, too, such as C<Ctrl-Shift-1-d> to type the default telnet escape |
382 |
character and so on. |
383 |
|
384 |
=item How can I keep rxvt-unicode from using reverse video so much? |
385 |
|
386 |
First of all, make sure you are running with the right terminal settings |
387 |
(C<TERM=rxvt-unicode>), which will get rid of most of these effects. Then |
388 |
make sure you have specified colours for italic and bold, as otherwise |
389 |
rxvt-unicode might use reverse video to simulate the effect: |
390 |
|
391 |
URxvt.colorBD: white |
392 |
URxvt.colorIT: green |
393 |
|
394 |
=item Some programs assume totally weird colours (red instead of blue), how can I fix that? |
395 |
|
396 |
For some unexplainable reason, some rare programs assume a very weird |
397 |
colour palette when confronted with a terminal with more than the standard |
398 |
8 colours (rxvt-unicode supports 88). The right fix is, of course, to fix |
399 |
these programs not to assume non-ISO colours without very good reasons. |
400 |
|
401 |
In the meantime, you can either edit your C<rxvt-unicode> terminfo |
402 |
definition to only claim 8 colour support or use C<TERM=rxvt>, which will |
403 |
fix colours but keep you from using other rxvt-unicode features. |
404 |
|
405 |
=item I am on FreeBSD and rxvt-unicode does not seem to work at all. |
406 |
|
407 |
Rxvt-unicode requires the symbol C<__STDC_ISO_10646__> to be defined |
408 |
in your compile environment, or an implementation that implements it, |
409 |
wether it defines the symbol or not. C<__STDC_ISO_10646__> requires that |
410 |
B<wchar_t> is represented as unicode. |
411 |
|
412 |
As you might have guessed, FreeBSD does neither define this symobl nor |
413 |
does it support it. Instead, it uses it's own internal representation of |
414 |
B<wchar_t>. This is, of course, completely fine with respect to standards. |
415 |
|
416 |
However, that means rxvt-unicode only works in C<POSIX>, C<ISO-8859-1> and |
417 |
C<UTF-8> locales under FreeBSD (which all use Unicode as B<wchar_t>. |
418 |
|
419 |
C<__STDC_ISO_10646__> is the only sane way to support multi-language |
420 |
apps in an OS, as using a locale-dependent (and non-standardized) |
421 |
representation of B<wchar_t> makes it impossible to convert between |
422 |
B<wchar_t> (as used by X11 and your applications) and any other encoding |
423 |
without implementing OS-specific-wrappers for each and every locale. There |
424 |
simply are no APIs to convert B<wchar_t> into anything except the current |
425 |
locale encoding. |
426 |
|
427 |
Some applications (such as the formidable B<mlterm>) work around this |
428 |
by carrying their own replacement functions for character set handling |
429 |
with them, and either implementing OS-dependent hacks or doing multiple |
430 |
conversions (which is slow and unreliable in case the OS implements |
431 |
encodings slightly different than the terminal emulator). |
432 |
|
433 |
The rxvt-unicode author insists that the right way to fix this is in the |
434 |
system libraries once and for all, instead of forcing every app to carry |
435 |
complete replacements for them :) |
436 |
|
437 |
=item I use Solaris 9 and it doesn't compile/work/etc. |
438 |
|
439 |
Try the diff in F<doc/solaris9.patch> as a base. It fixes the worst |
440 |
problems with C<wcwidth> and a compile problem. |
441 |
|
442 |
=item How can I use rxvt-unicode under cygwin? |
443 |
|
444 |
rxvt-unicode should compile and run out of the box on cygwin, using |
445 |
the X11 libraries that come with cygwin. libW11 emulation is no |
446 |
longer supported (and makes no sense, either, as it only supported a |
447 |
single font). I recommend starting the X-server in C<-multiwindow> or |
448 |
C<-rootless> mode instead, which will result in similar look&feel as the |
449 |
old libW11 emulation. |
450 |
|
451 |
At the time of this writing, cygwin didn't seem to support any multi-byte |
452 |
encodings (you might try C<LC_CTYPE=C-UTF-8>), so you are likely limited |
453 |
to 8-bit encodings. |
454 |
|
455 |
=item How does rxvt-unicode determine the encoding to use? |
456 |
|
457 |
=item Is there an option to switch encodings? |
458 |
|
459 |
Unlike some other terminals, rxvt-unicode has no encoding switch, and no |
460 |
specific "utf-8" mode, such as xterm. In fact, it doesn't even know about |
461 |
UTF-8 or any other encodings with respect to terminal I/O. |
462 |
|
463 |
The reasons is that there exists a perfectly fine mechanism for selecting |
464 |
the encoding, doing I/O and (most important) communicating this to all |
465 |
applications so everybody agrees on character properties such as width |
466 |
and code number. This mechanism is the I<locale>. Applications not using |
467 |
that info will have problems (for example, C<xterm> gets the width of |
468 |
characters wrong as it uses it's own, locale-independent table under all |
469 |
locales). |
470 |
|
471 |
Rxvt-unicode uses the C<LC_CTYPE> locale category to select encoding. All |
472 |
programs doing the same (that is, most) will automatically agree in the |
473 |
interpretation of characters. |
474 |
|
475 |
Unfortunately, there is no system-independent way to select locales, nor |
476 |
is there a standard on how locale specifiers will look like. |
477 |
|
478 |
On most systems, the content of the C<LC_CTYPE> environment variable |
479 |
contains an arbitrary string which corresponds to an already-installed |
480 |
locale. Common names for locales are C<en_US.UTF-8>, C<de_DE.ISO-8859-15>, |
481 |
C<ja_JP.EUC-JP>, i.e. C<language_country.encoding>, but other forms |
482 |
(i.e. C<de> or C<german>) are also common. |
483 |
|
484 |
Rxvt-unicode ignores all other locale categories, and except for |
485 |
the encoding, ignores country or language-specific settings, |
486 |
i.e. C<de_DE.UTF-8> and C<ja_JP.UTF-8> are the normally same to |
487 |
rxvt-unicode. |
488 |
|
489 |
If you want to use a specific encoding you have to make sure you start |
490 |
rxvt-unicode with the correct C<LC_CTYPE> category. |
491 |
|
492 |
=item Can I switch locales at runtime? |
493 |
|
494 |
Yes, using an escape sequence. Try something like this, which sets |
495 |
rxvt-unicode's idea of C<LC_CTYPE>. |
496 |
|
497 |
printf '\e]701;%s\007' ja_JP.SJIS |
498 |
|
499 |
See also the previous answer. |
500 |
|
501 |
Sometimes this capability is rather handy when you want to work in |
502 |
one locale (e.g. C<de_DE.UTF-8>) but some programs don't support it |
503 |
(e.g. UTF-8). For example, I use this script to start C<xjdic>, which |
504 |
first switches to a locale supported by xjdic and back later: |
505 |
|
506 |
printf '\e]701;%s\007' ja_JP.SJIS |
507 |
xjdic -js |
508 |
printf '\e]701;%s\007' de_DE.UTF-8 |
509 |
|
510 |
You can also use xterm's C<luit> program, which usually works fine, except |
511 |
for some locales where character width differs between program- and |
512 |
rxvt-unicode-locales. |
513 |
|
514 |
=item Can I switch the fonts at runtime? |
515 |
|
516 |
Yes, using an escape sequence. Try something like this, which has the same |
517 |
effect as using the C<-fn> switch, and takes effect immediately: |
518 |
|
519 |
printf '\e]50;%s\007' "9x15bold,xft:Kochi Gothic" |
520 |
|
521 |
This is useful if you e.g. work primarily with japanese (and prefer a |
522 |
japanese font), but you have to switch to chinese temporarily, where |
523 |
japanese fonts would only be in your way. |
524 |
|
525 |
You can think of this as a kind of manual ISO-2022 switching. |
526 |
|
527 |
=item Why do italic characters look as if clipped? |
528 |
|
529 |
Many fonts have difficulties with italic characters and hinting. For |
530 |
example, the otherwise very nicely hinted font C<xft:Bitstream Vera Sans |
531 |
Mono> completely fails in it's italic face. A workaround might be to |
532 |
enable freetype autohinting, i.e. like this: |
533 |
|
534 |
URxvt.italicFont: xft:Bitstream Vera Sans Mono:italic:autohint=true |
535 |
URxvt.boldItalicFont: xft:Bitstream Vera Sans Mono:bold:italic:autohint=true |
536 |
|
537 |
=item My input method wants <some encoding> but I want UTF-8, what can I do? |
538 |
|
539 |
You can specify separate locales for the input method and the rest of the |
540 |
terminal, using the resource C<imlocale>: |
541 |
|
542 |
URxvt*imlocale: ja_JP.EUC-JP |
543 |
|
544 |
Now you can start your terminal with C<LC_CTYPE=ja_JP.UTF-8> and still |
545 |
use your input method. Please note, however, that you will not be able to |
546 |
input characters outside C<EUC-JP> in a normal way then, as your input |
547 |
method limits you. |
548 |
|
549 |
=item Rxvt-unicode crashes when the X Input Method changes or exits. |
550 |
|
551 |
Unfortunately, this is unavoidable, as the XIM protocol is racy by |
552 |
design. Applications can avoid some crashes at the expense of memory |
553 |
leaks, and Input Methods can avoid some crashes by careful ordering at |
554 |
exit time. B<kinput2> (and derived input methods) generally succeeds, |
555 |
while B<SCIM> (or similar input methods) fails. In the end, however, |
556 |
crashes cannot be completely avoided even if both sides cooperate. |
557 |
|
558 |
So the only workaround is not to kill your Input Method Servers. |
559 |
|
560 |
=item Rxvt-unicode uses gobs of memory, how can I reduce that? |
561 |
|
562 |
Rxvt-unicode tries to obey the rule of not charging you for something you |
563 |
don't use. One thing you should try is to configure out all settings that |
564 |
you don't need, for example, Xft support is a resource hog by design, |
565 |
when used. Compiling it out ensures that no Xft font will be loaded |
566 |
accidentally when rxvt-unicode tries to find a font for your characters. |
567 |
|
568 |
Also, many people (me included) like large windows and even larger |
569 |
scrollback buffers: Without C<--enable-unicode3>, rxvt-unicode will use |
570 |
6 bytes per screen cell. For a 160x?? window this amounts to almost a |
571 |
kilobyte per line. A scrollback buffer of 10000 lines will then (if full) |
572 |
use 10 Megabytes of memory. With C<--enable-unicode3> it gets worse, as |
573 |
rxvt-unicode then uses 8 bytes per screen cell. |
574 |
|
575 |
=item Can I speed up Xft rendering somehow? |
576 |
|
577 |
Yes, the most obvious way to speed it up is to avoid Xft entirely, as |
578 |
it is simply slow. If you still want Xft fonts you might try to disable |
579 |
antialiasing (by appending C<:antialias=false>), which saves lots of |
580 |
memory and also speeds up rendering considerably. |
581 |
|
582 |
=item Rxvt-unicode doesn't seem to anti-alias its fonts, what is wrong? |
583 |
|
584 |
Rxvt-unicode will use whatever you specify as a font. If it needs to |
585 |
fall back to it's default font search list it will prefer X11 core |
586 |
fonts, because they are small and fast, and then use Xft fonts. It has |
587 |
antialiasing disabled for most of them, because the author thinks they |
588 |
look best that way. |
589 |
|
590 |
If you want antialiasing, you have to specify the fonts manually. |
591 |
|
592 |
=item Mouse cut/paste suddenly no longer works. |
593 |
|
594 |
Make sure that mouse reporting is actually turned off since killing |
595 |
some editors prematurely may leave the mouse in mouse report mode. I've |
596 |
heard that tcsh may use mouse reporting unless it otherwise specified. A |
597 |
quick check is to see if cut/paste works when the Alt or Shift keys are |
598 |
depressed. See @@RXVT_NAME@@(7) |
599 |
|
600 |
=item What's with this bold/blink stuff? |
601 |
|
602 |
If no bold colour is set via C<colorBD:>, bold will invert text using the |
603 |
standard foreground colour. |
604 |
|
605 |
For the standard background colour, blinking will actually make the |
606 |
text blink when compiled with C<--enable-blinking>. with standard |
607 |
colours. Without C<--enable-blinking>, the blink attribute will be |
608 |
ignored. |
609 |
|
610 |
On ANSI colours, bold/blink attributes are used to set high-intensity |
611 |
foreground/background colors. |
612 |
|
613 |
color0-7 are the low-intensity colors. |
614 |
|
615 |
color8-15 are the corresponding high-intensity colors. |
616 |
|
617 |
=item I don't like the screen colors. How do I change them? |
618 |
|
619 |
You can change the screen colors at run-time using F<~/.Xdefaults> |
620 |
resources (or as long-options). |
621 |
|
622 |
Here are values that are supposed to resemble a VGA screen, |
623 |
including the murky brown that passes for low-intensity yellow: |
624 |
|
625 |
URxvt.color0: #000000 |
626 |
URxvt.color1: #A80000 |
627 |
URxvt.color2: #00A800 |
628 |
URxvt.color3: #A8A800 |
629 |
URxvt.color4: #0000A8 |
630 |
URxvt.color5: #A800A8 |
631 |
URxvt.color6: #00A8A8 |
632 |
URxvt.color7: #A8A8A8 |
633 |
|
634 |
URxvt.color8: #000054 |
635 |
URxvt.color9: #FF0054 |
636 |
URxvt.color10: #00FF54 |
637 |
URxvt.color11: #FFFF54 |
638 |
URxvt.color12: #0000FF |
639 |
URxvt.color13: #FF00FF |
640 |
URxvt.color14: #00FFFF |
641 |
URxvt.color15: #FFFFFF |
642 |
|
643 |
And here is a more complete set of non-standard colors described (not by |
644 |
me) as "pretty girly". |
645 |
|
646 |
URxvt.cursorColor: #dc74d1 |
647 |
URxvt.pointerColor: #dc74d1 |
648 |
URxvt.background: #0e0e0e |
649 |
URxvt.foreground: #4ad5e1 |
650 |
URxvt.color0: #000000 |
651 |
URxvt.color8: #8b8f93 |
652 |
URxvt.color1: #dc74d1 |
653 |
URxvt.color9: #dc74d1 |
654 |
URxvt.color2: #0eb8c7 |
655 |
URxvt.color10: #0eb8c7 |
656 |
URxvt.color3: #dfe37e |
657 |
URxvt.color11: #dfe37e |
658 |
URxvt.color5: #9e88f0 |
659 |
URxvt.color13: #9e88f0 |
660 |
URxvt.color6: #73f7ff |
661 |
URxvt.color14: #73f7ff |
662 |
URxvt.color7: #e1dddd |
663 |
URxvt.color15: #e1dddd |
664 |
|
665 |
=item How can I start @@RXVT_NAME@@d in a race-free way? |
666 |
|
667 |
Try C<@@RXVT_NAME@@d -f -o>, which tells @@RXVT_NAME@@d to open the |
668 |
display, create the listening socket and then fork. |
669 |
|
670 |
=item What's with the strange Backspace/Delete key behaviour? |
671 |
|
672 |
Assuming that the physical Backspace key corresponds to the |
673 |
BackSpace keysym (not likely for Linux ... see the following |
674 |
question) there are two standard values that can be used for |
675 |
Backspace: C<^H> and C<^?>. |
676 |
|
677 |
Historically, either value is correct, but rxvt-unicode adopts the debian |
678 |
policy of using C<^?> when unsure, because it's the one only only correct |
679 |
choice :). |
680 |
|
681 |
Rxvt-unicode tries to inherit the current stty settings and uses the value |
682 |
of `erase' to guess the value for backspace. If rxvt-unicode wasn't |
683 |
started from a terminal (say, from a menu or by remote shell), then the |
684 |
system value of `erase', which corresponds to CERASE in <termios.h>, will |
685 |
be used (which may not be the same as your stty setting). |
686 |
|
687 |
For starting a new rxvt-unicode: |
688 |
|
689 |
# use Backspace = ^H |
690 |
$ stty erase ^H |
691 |
$ @@RXVT_NAME@@ |
692 |
|
693 |
# use Backspace = ^? |
694 |
$ stty erase ^? |
695 |
$ @@RXVT_NAME@@ |
696 |
|
697 |
Toggle with C<ESC [ 36 h> / C<ESC [ 36 l> as documented in @@RXVT_NAME@@(7). |
698 |
|
699 |
For an existing rxvt-unicode: |
700 |
|
701 |
# use Backspace = ^H |
702 |
$ stty erase ^H |
703 |
$ echo -n "^[[36h" |
704 |
|
705 |
# use Backspace = ^? |
706 |
$ stty erase ^? |
707 |
$ echo -n "^[[36l" |
708 |
|
709 |
This helps satisfy some of the Backspace discrepancies that occur, but |
710 |
if you use Backspace = C<^H>, make sure that the termcap/terminfo value |
711 |
properly reflects that. |
712 |
|
713 |
The Delete key is a another casualty of the ill-defined Backspace problem. |
714 |
To avoid confusion between the Backspace and Delete keys, the Delete |
715 |
key has been assigned an escape sequence to match the vt100 for Execute |
716 |
(C<ESC [ 3 ~>) and is in the supplied termcap/terminfo. |
717 |
|
718 |
Some other Backspace problems: |
719 |
|
720 |
some editors use termcap/terminfo, |
721 |
some editors (vim I'm told) expect Backspace = ^H, |
722 |
GNU Emacs (and Emacs-like editors) use ^H for help. |
723 |
|
724 |
Perhaps someday this will all be resolved in a consistent manner. |
725 |
|
726 |
=item I don't like the key-bindings. How do I change them? |
727 |
|
728 |
There are some compile-time selections available via configure. Unless |
729 |
you have run "configure" with the C<--disable-resources> option you can |
730 |
use the `keysym' resource to alter the keystrings associated with keysyms. |
731 |
|
732 |
Here's an example for a URxvt session started using C<@@RXVT_NAME@@ -name URxvt> |
733 |
|
734 |
URxvt.keysym.Home: \033[1~ |
735 |
URxvt.keysym.End: \033[4~ |
736 |
URxvt.keysym.C-apostrophe: \033<C-'> |
737 |
URxvt.keysym.C-slash: \033<C-/> |
738 |
URxvt.keysym.C-semicolon: \033<C-;> |
739 |
URxvt.keysym.C-grave: \033<C-`> |
740 |
URxvt.keysym.C-comma: \033<C-,> |
741 |
URxvt.keysym.C-period: \033<C-.> |
742 |
URxvt.keysym.C-0x60: \033<C-`> |
743 |
URxvt.keysym.C-Tab: \033<C-Tab> |
744 |
URxvt.keysym.C-Return: \033<C-Return> |
745 |
URxvt.keysym.S-Return: \033<S-Return> |
746 |
URxvt.keysym.S-space: \033<S-Space> |
747 |
URxvt.keysym.M-Up: \033<M-Up> |
748 |
URxvt.keysym.M-Down: \033<M-Down> |
749 |
URxvt.keysym.M-Left: \033<M-Left> |
750 |
URxvt.keysym.M-Right: \033<M-Right> |
751 |
URxvt.keysym.M-C-0: list \033<M-C- 0123456789 > |
752 |
URxvt.keysym.M-C-a: list \033<M-C- abcdefghijklmnopqrstuvwxyz > |
753 |
URxvt.keysym.F12: command:\033]701;zh_CN.GBK\007 |
754 |
|
755 |
See some more examples in the documentation for the B<keysym> resource. |
756 |
|
757 |
=item I'm using keyboard model XXX that has extra Prior/Next/Insert keys. |
758 |
How do I make use of them? For example, the Sun Keyboard type 4 |
759 |
has the following mappings that rxvt-unicode doesn't recognize. |
760 |
|
761 |
KP_Insert == Insert |
762 |
F22 == Print |
763 |
F27 == Home |
764 |
F29 == Prior |
765 |
F33 == End |
766 |
F35 == Next |
767 |
|
768 |
Rather than have rxvt-unicode try to accommodate all the various possible |
769 |
keyboard mappings, it is better to use `xmodmap' to remap the keys as |
770 |
required for your particular machine. |
771 |
|
772 |
=item How do I distinguish wether I'm running rxvt-unicode or a regular xterm? |
773 |
I need this to decide about setting colors etc. |
774 |
|
775 |
rxvt and rxvt-unicode always export the variable "COLORTERM", so you can |
776 |
check and see if that is set. Note that several programs, JED, slrn, |
777 |
Midnight Commander automatically check this variable to decide whether or |
778 |
not to use color. |
779 |
|
780 |
=item How do I set the correct, full IP address for the DISPLAY variable? |
781 |
|
782 |
If you've compiled rxvt-unicode with DISPLAY_IS_IP and have enabled |
783 |
insecure mode then it is possible to use the following shell script |
784 |
snippets to correctly set the display. If your version of rxvt-unicode |
785 |
wasn't also compiled with ESCZ_ANSWER (as assumed in these snippets) then |
786 |
the COLORTERM variable can be used to distinguish rxvt-unicode from a |
787 |
regular xterm. |
788 |
|
789 |
Courtesy of Chuck Blake <cblake@BBN.COM> with the following shell script |
790 |
snippets: |
791 |
|
792 |
# Bourne/Korn/POSIX family of shells: |
793 |
[ ${TERM:-foo} = foo ] && TERM=xterm # assume an xterm if we don't know |
794 |
if [ ${TERM:-foo} = xterm ]; then |
795 |
stty -icanon -echo min 0 time 15 # see if enhanced rxvt or not |
796 |
echo -n '^[Z' |
797 |
read term_id |
798 |
stty icanon echo |
799 |
if [ ""${term_id} = '^[[?1;2C' -a ${DISPLAY:-foo} = foo ]; then |
800 |
echo -n '^[[7n' # query the rxvt we are in for the DISPLAY string |
801 |
read DISPLAY # set it in our local shell |
802 |
fi |
803 |
fi |
804 |
|
805 |
=item How do I compile the manual pages for myself? |
806 |
|
807 |
You need to have a recent version of perl installed as F</usr/bin/perl>, |
808 |
one that comes with F<pod2man>, F<pod2text> and F<pod2html>. Then go to |
809 |
the doc subdirectory and enter C<make alldoc>. |
810 |
|
811 |
=item My question isn't answered here, can I ask a human? |
812 |
|
813 |
Before sending me mail, you could go to IRC: C<irc.freenode.net>, |
814 |
channel C<#rxvt-unicode> has some rxvt-unicode enthusiasts that might be |
815 |
interested in learning about new and exciting problems (but not FAQs :). |
816 |
|
817 |
=back |
818 |
|
819 |
=head1 RXVT TECHNICAL REFERENCE |
820 |
|
821 |
=head1 DESCRIPTION |
822 |
|
823 |
The rest of this document describes various technical aspects of |
824 |
B<rxvt-unicode>. First the description of supported command sequences, |
825 |
followed by menu and pixmap support and last by a description of all |
826 |
features selectable at C<configure> time. |
827 |
|
828 |
=head1 Definitions |
829 |
|
830 |
=over 4 |
831 |
|
832 |
=item B<< C<c> >> |
833 |
|
834 |
The literal character c. |
835 |
|
836 |
=item B<< C<C> >> |
837 |
|
838 |
A single (required) character. |
839 |
|
840 |
=item B<< C<Ps> >> |
841 |
|
842 |
A single (usually optional) numeric parameter, composed of one or more |
843 |
digits. |
844 |
|
845 |
=item B<< C<Pm> >> |
846 |
|
847 |
A multiple numeric parameter composed of any number of single numeric |
848 |
parameters, separated by C<;> character(s). |
849 |
|
850 |
=item B<< C<Pt> >> |
851 |
|
852 |
A text parameter composed of printable characters. |
853 |
|
854 |
=back |
855 |
|
856 |
=head1 Values |
857 |
|
858 |
=over 4 |
859 |
|
860 |
=item B<< C<ENQ> >> |
861 |
|
862 |
Enquiry (Ctrl-E) = Send Device Attributes (DA) |
863 |
request attributes from terminal. See B<< C<ESC [ Ps c> >>. |
864 |
|
865 |
=item B<< C<BEL> >> |
866 |
|
867 |
Bell (Ctrl-G) |
868 |
|
869 |
=item B<< C<BS> >> |
870 |
|
871 |
Backspace (Ctrl-H) |
872 |
|
873 |
=item B<< C<TAB> >> |
874 |
|
875 |
Horizontal Tab (HT) (Ctrl-I) |
876 |
|
877 |
=item B<< C<LF> >> |
878 |
|
879 |
Line Feed or New Line (NL) (Ctrl-J) |
880 |
|
881 |
=item B<< C<VT> >> |
882 |
|
883 |
Vertical Tab (Ctrl-K) same as B<< C<LF> >> |
884 |
|
885 |
=item B<< C<FF> >> |
886 |
|
887 |
Form Feed or New Page (NP) (Ctrl-L) same as B<< C<LF> >> |
888 |
|
889 |
=item B<< C<CR> >> |
890 |
|
891 |
Carriage Return (Ctrl-M) |
892 |
|
893 |
=item B<< C<SO> >> |
894 |
|
895 |
Shift Out (Ctrl-N), invokes the G1 character set. |
896 |
Switch to Alternate Character Set |
897 |
|
898 |
=item B<< C<SI> >> |
899 |
|
900 |
Shift In (Ctrl-O), invokes the G0 character set (the default). |
901 |
Switch to Standard Character Set |
902 |
|
903 |
=item B<< C<SPC> >> |
904 |
|
905 |
Space Character |
906 |
|
907 |
=back |
908 |
|
909 |
=head1 Escape Sequences |
910 |
|
911 |
=over 4 |
912 |
|
913 |
=item B<< C<ESC # 8> >> |
914 |
|
915 |
DEC Screen Alignment Test (DECALN) |
916 |
|
917 |
=item B<< C<ESC 7> >> |
918 |
|
919 |
Save Cursor (SC) |
920 |
|
921 |
=item B<< C<ESC 8> >> |
922 |
|
923 |
Restore Cursor |
924 |
|
925 |
=item B<< C<ESC => >> |
926 |
|
927 |
Application Keypad (SMKX). See also next sequence. |
928 |
|
929 |
=item B<<< C<< ESC >> >>> |
930 |
|
931 |
Normal Keypad (RMKX) |
932 |
|
933 |
B<Note:> If the numeric keypad is activated, eg, B<Num_Lock> has been |
934 |
pressed, numbers or control functions are generated by the numeric keypad |
935 |
(see Key Codes). |
936 |
|
937 |
=item B<< C<ESC D> >> |
938 |
|
939 |
Index (IND) |
940 |
|
941 |
=item B<< C<ESC E> >> |
942 |
|
943 |
Next Line (NEL) |
944 |
|
945 |
=item B<< C<ESC H> >> |
946 |
|
947 |
Tab Set (HTS) |
948 |
|
949 |
=item B<< C<ESC M> >> |
950 |
|
951 |
Reverse Index (RI) |
952 |
|
953 |
=item B<< C<ESC N> >> |
954 |
|
955 |
Single Shift Select of G2 Character Set (SS2): affects next character |
956 |
only I<unimplemented> |
957 |
|
958 |
=item B<< C<ESC O> >> |
959 |
|
960 |
Single Shift Select of G3 Character Set (SS3): affects next character |
961 |
only I<unimplemented> |
962 |
|
963 |
=item B<< C<ESC Z> >> |
964 |
|
965 |
Obsolete form of returns: B<< C<ESC [ ? 1 ; 2 C> >> I<rxvt-unicode compile-time option> |
966 |
|
967 |
=item B<< C<ESC c> >> |
968 |
|
969 |
Full reset (RIS) |
970 |
|
971 |
=item B<< C<ESC n> >> |
972 |
|
973 |
Invoke the G2 Character Set (LS2) |
974 |
|
975 |
=item B<< C<ESC o> >> |
976 |
|
977 |
Invoke the G3 Character Set (LS3) |
978 |
|
979 |
=item B<< C<ESC ( C> >> |
980 |
|
981 |
Designate G0 Character Set (ISO 2022), see below for values of C<C>. |
982 |
|
983 |
=item B<< C<ESC ) C> >> |
984 |
|
985 |
Designate G1 Character Set (ISO 2022), see below for values of C<C>. |
986 |
|
987 |
=item B<< C<ESC * C> >> |
988 |
|
989 |
Designate G2 Character Set (ISO 2022), see below for values of C<C>. |
990 |
|
991 |
=item B<< C<ESC + C> >> |
992 |
|
993 |
Designate G3 Character Set (ISO 2022), see below for values of C<C>. |
994 |
|
995 |
=item B<< C<ESC $ C> >> |
996 |
|
997 |
Designate Kanji Character Set |
998 |
|
999 |
Where B<< C<C> >> is one of: |
1000 |
|
1001 |
=begin table |
1002 |
|
1003 |
C = C<0> DEC Special Character and Line Drawing Set |
1004 |
C = C<A> United Kingdom (UK) |
1005 |
C = C<B> United States (USASCII) |
1006 |
C = C<< < >> Multinational character set I<unimplemented> |
1007 |
C = C<5> Finnish character set I<unimplemented> |
1008 |
C = C<C> Finnish character set I<unimplemented> |
1009 |
C = C<K> German character set I<unimplemented> |
1010 |
|
1011 |
=end table |
1012 |
|
1013 |
=back |
1014 |
|
1015 |
X<CSI> |
1016 |
|
1017 |
=head1 CSI (Command Sequence Introducer) Sequences |
1018 |
|
1019 |
=over 4 |
1020 |
|
1021 |
=item B<< C<ESC [ Ps @> >> |
1022 |
|
1023 |
Insert B<< C<Ps> >> (Blank) Character(s) [default: 1] (ICH)X<ESCOBPsA> |
1024 |
|
1025 |
=item B<< C<ESC [ Ps A> >> |
1026 |
|
1027 |
Cursor Up B<< C<Ps> >> Times [default: 1] (CUU) |
1028 |
|
1029 |
=item B<< C<ESC [ Ps B> >> |
1030 |
|
1031 |
Cursor Down B<< C<Ps> >> Times [default: 1] (CUD)X<ESCOBPsC> |
1032 |
|
1033 |
=item B<< C<ESC [ Ps C> >> |
1034 |
|
1035 |
Cursor Forward B<< C<Ps> >> Times [default: 1] (CUF) |
1036 |
|
1037 |
=item B<< C<ESC [ Ps D> >> |
1038 |
|
1039 |
Cursor Backward B<< C<Ps> >> Times [default: 1] (CUB) |
1040 |
|
1041 |
=item B<< C<ESC [ Ps E> >> |
1042 |
|
1043 |
Cursor Down B<< C<Ps> >> Times [default: 1] and to first column |
1044 |
|
1045 |
=item B<< C<ESC [ Ps F> >> |
1046 |
|
1047 |
Cursor Up B<< C<Ps> >> Times [default: 1] and to first columnX<ESCOBPsG> |
1048 |
|
1049 |
=item B<< C<ESC [ Ps G> >> |
1050 |
|
1051 |
Cursor to Column B<< C<Ps> >> (HPA) |
1052 |
|
1053 |
=item B<< C<ESC [ Ps;Ps H> >> |
1054 |
|
1055 |
Cursor Position [row;column] [default: 1;1] (CUP) |
1056 |
|
1057 |
=item B<< C<ESC [ Ps I> >> |
1058 |
|
1059 |
Move forward B<< C<Ps> >> tab stops [default: 1] |
1060 |
|
1061 |
=item B<< C<ESC [ Ps J> >> |
1062 |
|
1063 |
Erase in Display (ED) |
1064 |
|
1065 |
=begin table |
1066 |
|
1067 |
B<< C<Ps = 0> >> Clear Below (default) |
1068 |
B<< C<Ps = 1> >> Clear Above |
1069 |
B<< C<Ps = 2> >> Clear All |
1070 |
|
1071 |
=end table |
1072 |
|
1073 |
=item B<< C<ESC [ Ps K> >> |
1074 |
|
1075 |
Erase in Line (EL) |
1076 |
|
1077 |
=begin table |
1078 |
|
1079 |
B<< C<Ps = 0> >> Clear to Right (default) |
1080 |
B<< C<Ps = 1> >> Clear to Left |
1081 |
B<< C<Ps = 2> >> Clear All |
1082 |
|
1083 |
=end table |
1084 |
|
1085 |
=item B<< C<ESC [ Ps L> >> |
1086 |
|
1087 |
Insert B<< C<Ps> >> Line(s) [default: 1] (IL) |
1088 |
|
1089 |
=item B<< C<ESC [ Ps M> >> |
1090 |
|
1091 |
Delete B<< C<Ps> >> Line(s) [default: 1] (DL) |
1092 |
|
1093 |
=item B<< C<ESC [ Ps P> >> |
1094 |
|
1095 |
Delete B<< C<Ps> >> Character(s) [default: 1] (DCH) |
1096 |
|
1097 |
=item B<< C<ESC [ Ps;Ps;Ps;Ps;Ps T> >> |
1098 |
|
1099 |
Initiate . I<unimplemented> Parameters are |
1100 |
[func;startx;starty;firstrow;lastrow]. |
1101 |
|
1102 |
=item B<< C<ESC [ Ps W> >> |
1103 |
|
1104 |
Tabulator functions |
1105 |
|
1106 |
=begin table |
1107 |
|
1108 |
B<< C<Ps = 0> >> Tab Set (HTS) |
1109 |
B<< C<Ps = 2> >> Tab Clear (TBC), Clear Current Column (default) |
1110 |
B<< C<Ps = 5> >> Tab Clear (TBC), Clear All |
1111 |
|
1112 |
=end table |
1113 |
|
1114 |
=item B<< C<ESC [ Ps X> >> |
1115 |
|
1116 |
Erase B<< C<Ps> >> Character(s) [default: 1] (ECH) |
1117 |
|
1118 |
=item B<< C<ESC [ Ps Z> >> |
1119 |
|
1120 |
Move backward B<< C<Ps> >> [default: 1] tab stops |
1121 |
|
1122 |
=item B<< C<ESC [ Ps '> >> |
1123 |
|
1124 |
See B<< C<ESC [ Ps G> >> |
1125 |
|
1126 |
=item B<< C<ESC [ Ps a> >> |
1127 |
|
1128 |
See B<< C<ESC [ Ps C> >> |
1129 |
|
1130 |
=item B<< C<ESC [ Ps c> >> |
1131 |
|
1132 |
Send Device Attributes (DA) |
1133 |
B<< C<Ps = 0> >> (or omitted): request attributes from terminal |
1134 |
returns: B<< C<ESC [ ? 1 ; 2 c> >> (``I am a VT100 with Advanced Video |
1135 |
Option'') |
1136 |
|
1137 |
=item B<< C<ESC [ Ps d> >> |
1138 |
|
1139 |
Cursor to Line B<< C<Ps> >> (VPA) |
1140 |
|
1141 |
=item B<< C<ESC [ Ps e> >> |
1142 |
|
1143 |
See B<< C<ESC [ Ps A> >> |
1144 |
|
1145 |
=item B<< C<ESC [ Ps;Ps f> >> |
1146 |
|
1147 |
Horizontal and Vertical Position [row;column] (HVP) [default: 1;1] |
1148 |
|
1149 |
=item B<< C<ESC [ Ps g> >> |
1150 |
|
1151 |
Tab Clear (TBC) |
1152 |
|
1153 |
=begin table |
1154 |
|
1155 |
B<< C<Ps = 0> >> Clear Current Column (default) |
1156 |
B<< C<Ps = 3> >> Clear All (TBC) |
1157 |
|
1158 |
=end table |
1159 |
|
1160 |
=item B<< C<ESC [ Pm h> >> |
1161 |
|
1162 |
Set Mode (SM). See B<< C<ESC [ Pm l> >> sequence for description of C<Pm>. |
1163 |
|
1164 |
=item B<< C<ESC [ Ps i> >> |
1165 |
|
1166 |
Printing. See also the C<print-pipe> resource. |
1167 |
|
1168 |
=begin table |
1169 |
|
1170 |
B<< C<Ps = 0> >> print screen (MC0) |
1171 |
B<< C<Ps = 4> >> disable transparent print mode (MC4) |
1172 |
B<< C<Ps = 5> >> enable transparent print mode (MC5) |
1173 |
|
1174 |
=end table |
1175 |
|
1176 |
=item B<< C<ESC [ Pm l> >> |
1177 |
|
1178 |
Reset Mode (RM) |
1179 |
|
1180 |
=over 4 |
1181 |
|
1182 |
=item B<< C<Ps = 4> >> |
1183 |
|
1184 |
=begin table |
1185 |
|
1186 |
B<< C<h> >> Insert Mode (SMIR) |
1187 |
B<< C<l> >> Replace Mode (RMIR) |
1188 |
|
1189 |
=end table |
1190 |
|
1191 |
=item B<< C<Ps = 20> >> (partially implemented) |
1192 |
|
1193 |
=begin table |
1194 |
|
1195 |
B<< C<h> >> Automatic Newline (LNM) |
1196 |
B<< C<l> >> Normal Linefeed (LNM) |
1197 |
|
1198 |
=end table |
1199 |
|
1200 |
=back |
1201 |
|
1202 |
=item B<< C<ESC [ Pm m> >> |
1203 |
|
1204 |
Character Attributes (SGR) |
1205 |
|
1206 |
=begin table |
1207 |
|
1208 |
B<< C<Ps = 0> >> Normal (default) |
1209 |
B<< C<Ps = 1 / 21> >> On / Off Bold (bright fg) |
1210 |
B<< C<Ps = 3 / 23> >> On / Off Italic |
1211 |
B<< C<Ps = 4 / 24> >> On / Off Underline |
1212 |
B<< C<Ps = 5 / 25> >> On / Off Slow Blink (bright bg) |
1213 |
B<< C<Ps = 6 / 26> >> On / Off Rapid Blink (bright bg) |
1214 |
B<< C<Ps = 7 / 27> >> On / Off Inverse |
1215 |
B<< C<Ps = 8 / 27> >> On / Off Invisible (NYI) |
1216 |
B<< C<Ps = 30 / 40> >> fg/bg Black |
1217 |
B<< C<Ps = 31 / 41> >> fg/bg Red |
1218 |
B<< C<Ps = 32 / 42> >> fg/bg Green |
1219 |
B<< C<Ps = 33 / 43> >> fg/bg Yellow |
1220 |
B<< C<Ps = 34 / 44> >> fg/bg Blue |
1221 |
B<< C<Ps = 35 / 45> >> fg/bg Magenta |
1222 |
B<< C<Ps = 36 / 46> >> fg/bg Cyan |
1223 |
B<< C<Ps = 38;5 / 48;5> >> set fg/bg to color #m (ISO 8613-6) |
1224 |
B<< C<Ps = 37 / 47> >> fg/bg White |
1225 |
B<< C<Ps = 39 / 49> >> fg/bg Default |
1226 |
B<< C<Ps = 90 / 100> >> fg/bg Bright Black |
1227 |
B<< C<Ps = 91 / 101> >> fg/bg Bright Red |
1228 |
B<< C<Ps = 92 / 102> >> fg/bg Bright Green |
1229 |
B<< C<Ps = 93 / 103> >> fg/bg Bright Yellow |
1230 |
B<< C<Ps = 94 / 104> >> fg/bg Bright Blue |
1231 |
B<< C<Ps = 95 / 105> >> fg/bg Bright Magenta |
1232 |
B<< C<Ps = 96 / 106> >> fg/bg Bright Cyan |
1233 |
B<< C<Ps = 97 / 107> >> fg/bg Bright White |
1234 |
B<< C<Ps = 99 / 109> >> fg/bg Bright Default |
1235 |
|
1236 |
=end table |
1237 |
|
1238 |
=item B<< C<ESC [ Ps n> >> |
1239 |
|
1240 |
Device Status Report (DSR) |
1241 |
|
1242 |
=begin table |
1243 |
|
1244 |
B<< C<Ps = 5> >> Status Report B<< C<ESC [ 0 n> >> (``OK'') |
1245 |
B<< C<Ps = 6> >> Report Cursor Position (CPR) [row;column] as B<< C<ESC [ r ; c R> >> |
1246 |
B<< C<Ps = 7> >> Request Display Name |
1247 |
B<< C<Ps = 8> >> Request Version Number (place in window title) |
1248 |
|
1249 |
=end table |
1250 |
|
1251 |
=item B<< C<ESC [ Ps;Ps r> >> |
1252 |
|
1253 |
Set Scrolling Region [top;bottom] |
1254 |
[default: full size of window] (CSR) |
1255 |
|
1256 |
=item B<< C<ESC [ s> >> |
1257 |
|
1258 |
Save Cursor (SC) |
1259 |
|
1260 |
=item B<< C<ESC [ Ps;Pt t> >> |
1261 |
|
1262 |
Window Operations |
1263 |
|
1264 |
=begin table |
1265 |
|
1266 |
B<< C<Ps = 1> >> Deiconify (map) window |
1267 |
B<< C<Ps = 2> >> Iconify window |
1268 |
B<< C<Ps = 3> >> B<< C<ESC [ 3 ; X ; Y t> >> Move window to (X|Y) |
1269 |
B<< C<Ps = 4> >> B<< C<ESC [ 4 ; H ; W t> >> Resize to WxH pixels |
1270 |
B<< C<Ps = 5> >> Raise window |
1271 |
B<< C<Ps = 6> >> Lower window |
1272 |
B<< C<Ps = 7> >> Refresh screen once |
1273 |
B<< C<Ps = 8> >> B<< C<ESC [ 8 ; R ; C t> >> Resize to R rows and C columns |
1274 |
B<< C<Ps = 11> >> Report window state (responds with C<Ps = 1> or C<Ps = 2>) |
1275 |
B<< C<Ps = 13> >> Report window position (responds with C<Ps = 3>) |
1276 |
B<< C<Ps = 14> >> Report window pixel size (responds with C<Ps = 4>) |
1277 |
B<< C<Ps = 18> >> Report window text size (responds with C<Ps = 7>) |
1278 |
B<< C<Ps = 19> >> Currently the same as C<Ps = 18>, but responds with C<Ps = 9> |
1279 |
B<< C<Ps = 20> >> Reports icon label (B<< C<ESC ] L NAME \234> >>) |
1280 |
B<< C<Ps = 21> >> Reports window title (B<< C<ESC ] l NAME \234> >>) |
1281 |
B<< C<Ps = 24..> >> Set window height to C<Ps> rows |
1282 |
|
1283 |
=end table |
1284 |
|
1285 |
=item B<< C<ESC [ u> >> |
1286 |
|
1287 |
Restore Cursor |
1288 |
|
1289 |
=item B<< C<ESC [ Ps x> >> |
1290 |
|
1291 |
Request Terminal Parameters (DECREQTPARM) |
1292 |
|
1293 |
=back |
1294 |
|
1295 |
X<PrivateModes> |
1296 |
|
1297 |
=head1 DEC Private Modes |
1298 |
|
1299 |
=over 4 |
1300 |
|
1301 |
=item B<< C<ESC [ ? Pm h> >> |
1302 |
|
1303 |
DEC Private Mode Set (DECSET) |
1304 |
|
1305 |
=item B<< C<ESC [ ? Pm l> >> |
1306 |
|
1307 |
DEC Private Mode Reset (DECRST) |
1308 |
|
1309 |
=item B<< C<ESC [ ? Pm r> >> |
1310 |
|
1311 |
Restore previously saved DEC Private Mode Values. |
1312 |
|
1313 |
=item B<< C<ESC [ ? Pm s> >> |
1314 |
|
1315 |
Save DEC Private Mode Values. |
1316 |
|
1317 |
=item B<< C<ESC [ ? Pm t> >> |
1318 |
|
1319 |
Toggle DEC Private Mode Values (rxvt extension). I<where> |
1320 |
|
1321 |
=over 4 |
1322 |
|
1323 |
=item B<< C<Ps = 1> >> (DECCKM) |
1324 |
|
1325 |
=begin table |
1326 |
|
1327 |
B<< C<h> >> Application Cursor Keys |
1328 |
B<< C<l> >> Normal Cursor Keys |
1329 |
|
1330 |
=end table |
1331 |
|
1332 |
=item B<< C<Ps = 2> >> (ANSI/VT52 mode) |
1333 |
|
1334 |
=begin table |
1335 |
|
1336 |
B<< C<h> >> Enter VT52 mode |
1337 |
B<< C<l> >> Enter VT52 mode |
1338 |
|
1339 |
=end table |
1340 |
|
1341 |
=item B<< C<Ps = 3> >> |
1342 |
|
1343 |
=begin table |
1344 |
|
1345 |
B<< C<h> >> 132 Column Mode (DECCOLM) |
1346 |
B<< C<l> >> 80 Column Mode (DECCOLM) |
1347 |
|
1348 |
=end table |
1349 |
|
1350 |
=item B<< C<Ps = 4> >> |
1351 |
|
1352 |
=begin table |
1353 |
|
1354 |
B<< C<h> >> Smooth (Slow) Scroll (DECSCLM) |
1355 |
B<< C<l> >> Jump (Fast) Scroll (DECSCLM) |
1356 |
|
1357 |
=end table |
1358 |
|
1359 |
=item B<< C<Ps = 5> >> |
1360 |
|
1361 |
=begin table |
1362 |
|
1363 |
B<< C<h> >> Reverse Video (DECSCNM) |
1364 |
B<< C<l> >> Normal Video (DECSCNM) |
1365 |
|
1366 |
=end table |
1367 |
|
1368 |
=item B<< C<Ps = 6> >> |
1369 |
|
1370 |
=begin table |
1371 |
|
1372 |
B<< C<h> >> Origin Mode (DECOM) |
1373 |
B<< C<l> >> Normal Cursor Mode (DECOM) |
1374 |
|
1375 |
=end table |
1376 |
|
1377 |
=item B<< C<Ps = 7> >> |
1378 |
|
1379 |
=begin table |
1380 |
|
1381 |
B<< C<h> >> Wraparound Mode (DECAWM) |
1382 |
B<< C<l> >> No Wraparound Mode (DECAWM) |
1383 |
|
1384 |
=end table |
1385 |
|
1386 |
=item B<< C<Ps = 8> >> I<unimplemented> |
1387 |
|
1388 |
=begin table |
1389 |
|
1390 |
B<< C<h> >> Auto-repeat Keys (DECARM) |
1391 |
B<< C<l> >> No Auto-repeat Keys (DECARM) |
1392 |
|
1393 |
=end table |
1394 |
|
1395 |
=item B<< C<Ps = 9> >> X10 XTerm |
1396 |
|
1397 |
=begin table |
1398 |
|
1399 |
B<< C<h> >> Send Mouse X & Y on button press. |
1400 |
B<< C<l> >> No mouse reporting. |
1401 |
|
1402 |
=end table |
1403 |
|
1404 |
=item B<< C<Ps = 10> >> (B<rxvt>) |
1405 |
|
1406 |
=begin table |
1407 |
|
1408 |
B<< C<h> >> menuBar visible |
1409 |
B<< C<l> >> menuBar invisible |
1410 |
|
1411 |
=end table |
1412 |
|
1413 |
=item B<< C<Ps = 25> >> |
1414 |
|
1415 |
=begin table |
1416 |
|
1417 |
B<< C<h> >> Visible cursor {cnorm/cvvis} |
1418 |
B<< C<l> >> Invisible cursor {civis} |
1419 |
|
1420 |
=end table |
1421 |
|
1422 |
=item B<< C<Ps = 30> >> |
1423 |
|
1424 |
=begin table |
1425 |
|
1426 |
B<< C<h> >> scrollBar visisble |
1427 |
B<< C<l> >> scrollBar invisisble |
1428 |
|
1429 |
=end table |
1430 |
|
1431 |
=item B<< C<Ps = 35> >> (B<rxvt>) |
1432 |
|
1433 |
=begin table |
1434 |
|
1435 |
B<< C<h> >> Allow XTerm Shift+key sequences |
1436 |
B<< C<l> >> Disallow XTerm Shift+key sequences |
1437 |
|
1438 |
=end table |
1439 |
|
1440 |
=item B<< C<Ps = 38> >> I<unimplemented> |
1441 |
|
1442 |
Enter Tektronix Mode (DECTEK) |
1443 |
|
1444 |
=item B<< C<Ps = 40> >> |
1445 |
|
1446 |
=begin table |
1447 |
|
1448 |
B<< C<h> >> Allow 80/132 Mode |
1449 |
B<< C<l> >> Disallow 80/132 Mode |
1450 |
|
1451 |
=end table |
1452 |
|
1453 |
=item B<< C<Ps = 44> >> I<unimplemented> |
1454 |
|
1455 |
=begin table |
1456 |
|
1457 |
B<< C<h> >> Turn On Margin Bell |
1458 |
B<< C<l> >> Turn Off Margin Bell |
1459 |
|
1460 |
=end table |
1461 |
|
1462 |
=item B<< C<Ps = 45> >> I<unimplemented> |
1463 |
|
1464 |
=begin table |
1465 |
|
1466 |
B<< C<h> >> Reverse-wraparound Mode |
1467 |
B<< C<l> >> No Reverse-wraparound Mode |
1468 |
|
1469 |
=end table |
1470 |
|
1471 |
=item B<< C<Ps = 46> >> I<unimplemented> |
1472 |
|
1473 |
=item B<< C<Ps = 47> >> |
1474 |
|
1475 |
=begin table |
1476 |
|
1477 |
B<< C<h> >> Use Alternate Screen Buffer |
1478 |
B<< C<l> >> Use Normal Screen Buffer |
1479 |
|
1480 |
=end table |
1481 |
|
1482 |
X<Priv66> |
1483 |
|
1484 |
=item B<< C<Ps = 66> >> |
1485 |
|
1486 |
=begin table |
1487 |
|
1488 |
B<< C<h> >> Application Keypad (DECPAM) == C<ESC => |
1489 |
B<< C<l> >> Normal Keypad (DECPNM) == C<< ESC > >> |
1490 |
|
1491 |
=end table |
1492 |
|
1493 |
=item B<< C<Ps = 67> >> |
1494 |
|
1495 |
=begin table |
1496 |
|
1497 |
B<< C<h> >> Backspace key sends B<< C<BS> (DECBKM) >> |
1498 |
B<< C<l> >> Backspace key sends B<< C<DEL> >> |
1499 |
|
1500 |
=end table |
1501 |
|
1502 |
=item B<< C<Ps = 1000> >> (X11 XTerm) |
1503 |
|
1504 |
=begin table |
1505 |
|
1506 |
B<< C<h> >> Send Mouse X & Y on button press and release. |
1507 |
B<< C<l> >> No mouse reporting. |
1508 |
|
1509 |
=end table |
1510 |
|
1511 |
=item B<< C<Ps = 1001> >> (X11 XTerm) I<unimplemented> |
1512 |
|
1513 |
=begin table |
1514 |
|
1515 |
B<< C<h> >> Use Hilite Mouse Tracking. |
1516 |
B<< C<l> >> No mouse reporting. |
1517 |
|
1518 |
=end table |
1519 |
|
1520 |
=item B<< C<Ps = 1010> >> (B<rxvt>) |
1521 |
|
1522 |
=begin table |
1523 |
|
1524 |
B<< C<h> >> Don't scroll to bottom on TTY output |
1525 |
B<< C<l> >> Scroll to bottom on TTY output |
1526 |
|
1527 |
=end table |
1528 |
|
1529 |
=item B<< C<Ps = 1011> >> (B<rxvt>) |
1530 |
|
1531 |
=begin table |
1532 |
|
1533 |
B<< C<h> >> Scroll to bottom when a key is pressed |
1534 |
B<< C<l> >> Don't scroll to bottom when a key is pressed |
1535 |
|
1536 |
=end table |
1537 |
|
1538 |
=item B<< C<Ps = 1021> >> (B<rxvt>) |
1539 |
|
1540 |
=begin table |
1541 |
|
1542 |
B<< C<h> >> Bold/italic implies high intensity (see option B<-is>) |
1543 |
B<< C<l> >> Font styles have no effect on intensity (Compile styles) |
1544 |
|
1545 |
=end table |
1546 |
|
1547 |
=item B<< C<Ps = 1047> >> |
1548 |
|
1549 |
=begin table |
1550 |
|
1551 |
B<< C<h> >> Use Alternate Screen Buffer |
1552 |
B<< C<l> >> Use Normal Screen Buffer - clear Alternate Screen Buffer if returning from it |
1553 |
|
1554 |
=end table |
1555 |
|
1556 |
=item B<< C<Ps = 1048> >> |
1557 |
|
1558 |
=begin table |
1559 |
|
1560 |
B<< C<h> >> Save cursor position |
1561 |
B<< C<l> >> Restore cursor position |
1562 |
|
1563 |
=end table |
1564 |
|
1565 |
=item B<< C<Ps = 1049> >> |
1566 |
|
1567 |
=begin table |
1568 |
|
1569 |
B<< C<h> >> Use Alternate Screen Buffer - clear Alternate Screen Buffer if switching to it |
1570 |
B<< C<l> >> Use Normal Screen Buffer |
1571 |
|
1572 |
=end table |
1573 |
|
1574 |
=back |
1575 |
|
1576 |
=back |
1577 |
|
1578 |
X<XTerm> |
1579 |
|
1580 |
=head1 XTerm Operating System Commands |
1581 |
|
1582 |
=over 4 |
1583 |
|
1584 |
=item B<< C<ESC ] Ps;Pt ST> >> |
1585 |
|
1586 |
Set XTerm Parameters. 8-bit ST: 0x9c, 7-bit ST sequence: ESC \ (0x1b, |
1587 |
0x5c), backwards compatible terminator BEL (0x07) is also accepted. any |
1588 |
B<octet> can be escaped by prefixing it with SYN (0x16, ^V). |
1589 |
|
1590 |
=begin table |
1591 |
|
1592 |
B<< C<Ps = 0> >> Change Icon Name and Window Title to B<< C<Pt> >> |
1593 |
B<< C<Ps = 1> >> Change Icon Name to B<< C<Pt> >> |
1594 |
B<< C<Ps = 2> >> Change Window Title to B<< C<Pt> >> |
1595 |
B<< C<Ps = 3> >> If B<< C<Pt> >> starts with a B<< C<?> >>, query the (STRING) property of the window and return it. If B<< C<Pt> >> contains a B<< C<=> >>, set the named property to the given value, else delete the specified property. |
1596 |
B<< C<Ps = 4> >> B<< C<Pt> >> is a semi-colon separated sequence of one or more semi-colon separated B<number>/B<name> pairs, where B<number> is an index to a colour and B<name> is the name of a colour. Each pair causes the B<number>ed colour to be changed to B<name>. Numbers 0-7 corresponds to low-intensity (normal) colours and 8-15 corresponds to high-intensity colours. 0=black, 1=red, 2=green, 3=yellow, 4=blue, 5=magenta, 6=cyan, 7=white |
1597 |
B<< C<Ps = 10> >> Change colour of text foreground to B<< C<Pt> >> B<(NB: may change in future)> |
1598 |
B<< C<Ps = 11> >> Change colour of text background to B<< C<Pt> >> B<(NB: may change in future)> |
1599 |
B<< C<Ps = 12> >> Change colour of text cursor foreground to B<< C<Pt> >> |
1600 |
B<< C<Ps = 13> >> Change colour of mouse foreground to B<< C<Pt> >> |
1601 |
B<< C<Ps = 17> >> Change colour of highlight characters to B<< C<Pt> >> |
1602 |
B<< C<Ps = 18> >> Change colour of bold characters to B<< C<Pt> >> |
1603 |
B<< C<Ps = 19> >> Change colour of underlined characters to B<< C<Pt> >> |
1604 |
B<< C<Ps = 20> >> Change default background to B<< C<Pt> >> |
1605 |
B<< C<Ps = 39> >> Change default foreground colour to B<< C<Pt> >>. |
1606 |
B<< C<Ps = 46> >> Change Log File to B<< C<Pt> >> I<unimplemented> |
1607 |
B<< C<Ps = 49> >> Change default background colour to B<< C<Pt> >>. |
1608 |
B<< C<Ps = 50> >> Set fontset to B<< C<Pt> >>, with the following special values of B<< C<Pt> >> (B<rxvt>) B<< C<#+n> >> change up B<< C<n> >> B<< C<#-n> >> change down B<< C<n> >> if B<< C<n> >> is missing of 0, a value of 1 is used I<empty> change to font0 B<< C<n> >> change to font B<< C<n> >> |
1609 |
B<< C<Ps = 55> >> Log all scrollback buffer and all of screen to B<< C<Pt> >> |
1610 |
B<< C<Ps = 701> >> Change current locale to B<< C<Pt> >>, or, if B<< C<Pt> >> is B<< C<?> >>, return the current locale (Compile frills). |
1611 |
B<< C<Ps = 703> >> Menubar command B<< C<Pt> >> (Compile menubar). |
1612 |
B<< C<Ps = 704> >> Change colour of italic characters to B<< C<Pt> >> |
1613 |
B<< C<Ps = 705> >> Change background pixmap tint colour to B<< C<Pt> >> (Compile transparency). |
1614 |
B<< C<Ps = 710> >> Set normal fontset to B<< C<Pt> >>. Same as C<Ps = 50>. |
1615 |
B<< C<Ps = 711> >> Set bold fontset to B<< C<Pt> >>. Similar to C<Ps = 50> (Compile styles). |
1616 |
B<< C<Ps = 712> >> Set italic fontset to B<< C<Pt> >>. Similar to C<Ps = 50> (Compile styles). |
1617 |
B<< C<Ps = 713> >> Set bold-italic fontset to B<< C<Pt> >>. Similar to C<Ps = 50> (Compile styles). |
1618 |
B<< C<Ps = 720> >> Move viewing window up by B<< C<Pt> >> lines, or clear scrollback buffer if C<Pt = 0> (Compile frills). |
1619 |
B<< C<Ps = 721> >> Move viewing window down by B<< C<Pt> >> lines, or clear scrollback buffer if C<Pt = 0> (Compile frills). |
1620 |
|
1621 |
=end table |
1622 |
|
1623 |
=back |
1624 |
|
1625 |
X<menuBar> |
1626 |
|
1627 |
=head1 menuBar |
1628 |
|
1629 |
B<< The exact syntax used is I<almost> solidified. >> |
1630 |
In the menus, B<DON'T> try to use menuBar commands that add or remove a |
1631 |
menuBar. |
1632 |
|
1633 |
Note that in all of the commands, the B<< I</path/> >> I<cannot> be |
1634 |
omitted: use B<./> to specify a menu relative to the current menu. |
1635 |
|
1636 |
=head2 Overview of menuBar operation |
1637 |
|
1638 |
For the menuBar XTerm escape sequence C<ESC ] 703 ; Pt ST>, the syntax |
1639 |
of C<Pt> can be used for a variety of tasks: |
1640 |
|
1641 |
At the top level is the current menuBar which is a member of a circular |
1642 |
linked-list of other such menuBars. |
1643 |
|
1644 |
The menuBar acts as a parent for the various drop-down menus, which in |
1645 |
turn, may have labels, separator lines, menuItems and subMenus. |
1646 |
|
1647 |
The menuItems are the useful bits: you can use them to mimic keyboard |
1648 |
input or even to send text or escape sequences back to rxvt. |
1649 |
|
1650 |
The menuBar syntax is intended to provide a simple yet robust method of |
1651 |
constructing and manipulating menus and navigating through the |
1652 |
menuBars. |
1653 |
|
1654 |
The first step is to use the tag B<< [menu:I<name>] >> which creates |
1655 |
the menuBar called I<name> and allows access. You may now or menus, |
1656 |
subMenus, and menuItems. Finally, use the tag B<[done]> to set the |
1657 |
menuBar access as B<readonly> to prevent accidental corruption of the |
1658 |
menus. To re-access the current menuBar for alterations, use the tag |
1659 |
B<[menu]>, make the alterations and then use B<[done]> |
1660 |
|
1661 |
X<menuBarCommands> |
1662 |
|
1663 |
=head2 Commands |
1664 |
|
1665 |
=over 4 |
1666 |
|
1667 |
=item B<< [menu:+I<name>] >> |
1668 |
|
1669 |
access the named menuBar for creation or alteration. If a new menuBar |
1670 |
is created, it is called I<name> (max of 15 chars) and the current |
1671 |
menuBar is pushed onto the stack |
1672 |
|
1673 |
=item B<[menu]> |
1674 |
|
1675 |
access the current menuBar for alteration |
1676 |
|
1677 |
=item B<< [title:+I<string>] >> |
1678 |
|
1679 |
set the current menuBar's title to I<string>, which may contain the |
1680 |
following format specifiers: |
1681 |
|
1682 |
B<%n> rxvt name (as per the B<-name> command-line option) |
1683 |
B<%v> rxvt version |
1684 |
B<%%> literal B<%> character |
1685 |
|
1686 |
=item B<[done]> |
1687 |
|
1688 |
set menuBar access as B<readonly>. |
1689 |
End-of-file tag for B<< [read:+I<file>] >> operations. |
1690 |
|
1691 |
=item B<< [read:+I<file>] >> |
1692 |
|
1693 |
read menu commands directly from I<file> (extension ".menu" will be |
1694 |
appended if required.) Start reading at a line with B<[menu]> or B<< |
1695 |
[menu:+I<name> >> and continuing until B<[done]> is encountered. |
1696 |
|
1697 |
Blank and comment lines (starting with B<#>) are ignored. Actually, |
1698 |
since any invalid menu commands are also ignored, almost anything could |
1699 |
be construed as a comment line, but this may be tightened up in the |
1700 |
future ... so don't count on it!. |
1701 |
|
1702 |
=item B<< [read:+I<file>;+I<name>] >> |
1703 |
|
1704 |
The same as B<< [read:+I<file>] >>, but start reading at a line with |
1705 |
B<< [menu:+I<name>] >> and continuing until B<< [done:+I<name>] >> or |
1706 |
B<[done]> is encountered. |
1707 |
|
1708 |
=item B<[dump]> |
1709 |
|
1710 |
dump all menuBars to the file B</tmp/rxvt-PID> in a format suitable for |
1711 |
later rereading. |
1712 |
|
1713 |
=item B<[rm:name]> |
1714 |
|
1715 |
remove the named menuBar |
1716 |
|
1717 |
=item B<[rm] [rm:]> |
1718 |
|
1719 |
remove the current menuBar |
1720 |
|
1721 |
=item B<[rm*] [rm:*]> |
1722 |
|
1723 |
remove all menuBars |
1724 |
|
1725 |
=item B<[swap]> |
1726 |
|
1727 |
swap the top two menuBars |
1728 |
|
1729 |
=item B<[prev]> |
1730 |
|
1731 |
access the previous menuBar |
1732 |
|
1733 |
=item B<[next]> |
1734 |
|
1735 |
access the next menuBar |
1736 |
|
1737 |
=item B<[show]> |
1738 |
|
1739 |
Enable display of the menuBar |
1740 |
|
1741 |
=item B<[hide]> |
1742 |
|
1743 |
Disable display of the menuBar |
1744 |
|
1745 |
=item B<< [pixmap:+I<name>] >> |
1746 |
|
1747 |
=item B<< [pixmap:+I<name>;I<scaling>] >> |
1748 |
|
1749 |
(set the background pixmap globally |
1750 |
|
1751 |
B<< A Future implementation I<may> make this local to the menubar >>) |
1752 |
|
1753 |
=item B<< [:+I<command>:] >> |
1754 |
|
1755 |
ignore the menu readonly status and issue a I<command> to or a menu or |
1756 |
menuitem or change the ; a useful shortcut for setting the quick arrows |
1757 |
from a menuBar. |
1758 |
|
1759 |
=back |
1760 |
|
1761 |
X<menuBarAdd> |
1762 |
|
1763 |
=head2 Adding and accessing menus |
1764 |
|
1765 |
The following commands may also be B<+> prefixed. |
1766 |
|
1767 |
=over 4 |
1768 |
|
1769 |
=item B</+> |
1770 |
|
1771 |
access menuBar top level |
1772 |
|
1773 |
=item B<./+> |
1774 |
|
1775 |
access current menu level |
1776 |
|
1777 |
=item B<../+> |
1778 |
|
1779 |
access parent menu (1 level up) |
1780 |
|
1781 |
=item B<../../> |
1782 |
|
1783 |
access parent menu (multiple levels up) |
1784 |
|
1785 |
=item B<< I</path/>menu >> |
1786 |
|
1787 |
add/access menu |
1788 |
|
1789 |
=item B<< I</path/>menu/* >> |
1790 |
|
1791 |
add/access menu and clear it if it exists |
1792 |
|
1793 |
=item B<< I</path/>{-} >> |
1794 |
|
1795 |
add separator |
1796 |
|
1797 |
=item B<< I</path/>{item} >> |
1798 |
|
1799 |
add B<item> as a label |
1800 |
|
1801 |
=item B<< I</path/>{item} action >> |
1802 |
|
1803 |
add/alter I<menuitem> with an associated I<action> |
1804 |
|
1805 |
=item B<< I</path/>{item}{right-text} >> |
1806 |
|
1807 |
add/alter I<menuitem> with B<right-text> as the right-justified text |
1808 |
and as the associated I<action> |
1809 |
|
1810 |
=item B<< I</path/>{item}{rtext} action >> |
1811 |
|
1812 |
add/alter I<menuitem> with an associated I<action> and with B<rtext> as |
1813 |
the right-justified text. |
1814 |
|
1815 |
=back |
1816 |
|
1817 |
=over 4 |
1818 |
|
1819 |
=item Special characters in I<action> must be backslash-escaped: |
1820 |
|
1821 |
B<\a \b \E \e \n \r \t \octal> |
1822 |
|
1823 |
=item or in control-character notation: |
1824 |
|
1825 |
B<^@, ^A .. ^Z .. ^_, ^?> |
1826 |
|
1827 |
=back |
1828 |
|
1829 |
To send a string starting with a B<NUL> (B<^@>) character to the |
1830 |
program, start I<action> with a pair of B<NUL> characters (B<^@^@>), |
1831 |
the first of which will be stripped off and the balance directed to the |
1832 |
program. Otherwise if I<action> begins with B<NUL> followed by |
1833 |
non-+B<NUL> characters, the leading B<NUL> is stripped off and the |
1834 |
balance is sent back to rxvt. |
1835 |
|
1836 |
As a convenience for the many Emacs-type editors, I<action> may start |
1837 |
with B<M-> (eg, B<M-$> is equivalent to B<\E$>) and a B<CR> will be |
1838 |
appended if missed from B<M-x> commands. |
1839 |
|
1840 |
As a convenience for issuing XTerm B<ESC ]> sequences from a menubar (or |
1841 |
quick arrow), a B<BEL> (B<^G>) will be appended if needed. |
1842 |
|
1843 |
=over 4 |
1844 |
|
1845 |
=item For example, |
1846 |
|
1847 |
B<M-xapropos> is equivalent to B<\Exapropos\r> |
1848 |
|
1849 |
=item and |
1850 |
|
1851 |
B<\E]703;mona;100> is equivalent to B<\E]703;mona;100\a> |
1852 |
|
1853 |
=back |
1854 |
|
1855 |
The option B<< {I<right-rtext>} >> will be right-justified. In the |
1856 |
absence of a specified action, this text will be used as the I<action> |
1857 |
as well. |
1858 |
|
1859 |
=over 4 |
1860 |
|
1861 |
=item For example, |
1862 |
|
1863 |
B</File/{Open}{^X^F}> is equivalent to B</File/{Open}{^X^F} ^X^F> |
1864 |
|
1865 |
=back |
1866 |
|
1867 |
The left label I<is> necessary, since it's used for matching, but |
1868 |
implicitly hiding the left label (by using same name for both left and |
1869 |
right labels), or explicitly hiding the left label (by preceeding it |
1870 |
with a dot), makes it possible to have right-justified text only. |
1871 |
|
1872 |
=over 4 |
1873 |
|
1874 |
=item For example, |
1875 |
|
1876 |
B</File/{Open}{Open} Open-File-Action> |
1877 |
|
1878 |
=item or hiding it |
1879 |
|
1880 |
B</File/{.anylabel}{Open} Open-File-Action> |
1881 |
|
1882 |
=back |
1883 |
|
1884 |
X<menuBarRemove> |
1885 |
|
1886 |
=head2 Removing menus |
1887 |
|
1888 |
=over 4 |
1889 |
|
1890 |
=item B<< -/*+ >> |
1891 |
|
1892 |
remove all menus from the menuBar, the same as B<[clear]> |
1893 |
|
1894 |
=item B<< -+I</path>menu+ >> |
1895 |
|
1896 |
remove menu |
1897 |
|
1898 |
=item B<< -+I</path>{item}+ >> |
1899 |
|
1900 |
remove item |
1901 |
|
1902 |
=item B<< -+I</path>{-} >> |
1903 |
|
1904 |
remove separator) |
1905 |
|
1906 |
=item B<-/path/menu/*> |
1907 |
|
1908 |
remove all items, separators and submenus from menu |
1909 |
|
1910 |
=back |
1911 |
|
1912 |
X<menuBarArrows> |
1913 |
|
1914 |
=head2 Quick Arrows |
1915 |
|
1916 |
The menus also provide a hook for I<quick arrows> to provide easier |
1917 |
user access. If nothing has been explicitly set, the default is to |
1918 |
emulate the curror keys. The syntax permits each arrow to be altered |
1919 |
individually or all four at once without re-entering their common |
1920 |
beginning/end text. For example, to explicitly associate cursor actions |
1921 |
with the arrows, any of the following forms could be used: |
1922 |
|
1923 |
=over 4 |
1924 |
|
1925 |
=item B<< <r>+I<Right> >> |
1926 |
|
1927 |
=item B<< <l>+I<Left> >> |
1928 |
|
1929 |
=item B<< <u>+I<Up> >> |
1930 |
|
1931 |
=item B<< <d>+I<Down> >> |
1932 |
|
1933 |
Define actions for the respective arrow buttons |
1934 |
|
1935 |
=item B<< <b>+I<Begin> >> |
1936 |
|
1937 |
=item B<< <e>+I<End> >> |
1938 |
|
1939 |
Define common beginning/end parts for I<quick arrows> which used in |
1940 |
conjunction with the above <r> <l> <u> <d> constructs |
1941 |
|
1942 |
=back |
1943 |
|
1944 |
=over 4 |
1945 |
|
1946 |
=item For example, define arrows individually, |
1947 |
|
1948 |
<u>\E[A |
1949 |
|
1950 |
<d>\E[B |
1951 |
|
1952 |
<r>\E[C |
1953 |
|
1954 |
<l>\E[D |
1955 |
|
1956 |
=item or all at once |
1957 |
|
1958 |
<u>\E[AZ<><d>\E[BZ<><r>\E[CZ<><l>\E[D |
1959 |
|
1960 |
=item or more compactly (factoring out common parts) |
1961 |
|
1962 |
<b>\E[<u>AZ<><d>BZ<><r>CZ<><l>D |
1963 |
|
1964 |
=back |
1965 |
|
1966 |
X<menuBarSummary> |
1967 |
|
1968 |
=head2 Command Summary |
1969 |
|
1970 |
A short summary of the most I<common> commands: |
1971 |
|
1972 |
=over 4 |
1973 |
|
1974 |
=item [menu:name] |
1975 |
|
1976 |
use an existing named menuBar or start a new one |
1977 |
|
1978 |
=item [menu] |
1979 |
|
1980 |
use the current menuBar |
1981 |
|
1982 |
=item [title:string] |
1983 |
|
1984 |
set menuBar title |
1985 |
|
1986 |
=item [done] |
1987 |
|
1988 |
set menu access to readonly and, if reading from a file, signal EOF |
1989 |
|
1990 |
=item [done:name] |
1991 |
|
1992 |
if reading from a file using [read:file;name] signal EOF |
1993 |
|
1994 |
=item [rm:name] |
1995 |
|
1996 |
remove named menuBar(s) |
1997 |
|
1998 |
=item [rm] [rm:] |
1999 |
|
2000 |
remove current menuBar |
2001 |
|
2002 |
=item [rm*] [rm:*] |
2003 |
|
2004 |
remove all menuBar(s) |
2005 |
|
2006 |
=item [swap] |
2007 |
|
2008 |
swap top two menuBars |
2009 |
|
2010 |
=item [prev] |
2011 |
|
2012 |
access the previous menuBar |
2013 |
|
2014 |
=item [next] |
2015 |
|
2016 |
access the next menuBar |
2017 |
|
2018 |
=item [show] |
2019 |
|
2020 |
map menuBar |
2021 |
|
2022 |
=item [hide] |
2023 |
|
2024 |
unmap menuBar |
2025 |
|
2026 |
=item [pixmap;file] |
2027 |
|
2028 |
=item [pixmap;file;scaling] |
2029 |
|
2030 |
set a background pixmap |
2031 |
|
2032 |
=item [read:file] |
2033 |
|
2034 |
=item [read:file;name] |
2035 |
|
2036 |
read in a menu from a file |
2037 |
|
2038 |
=item [dump] |
2039 |
|
2040 |
dump out all menuBars to /tmp/rxvt-PID |
2041 |
|
2042 |
=item / |
2043 |
|
2044 |
access menuBar top level |
2045 |
|
2046 |
=item ./ |
2047 |
|
2048 |
=item ../ |
2049 |
|
2050 |
=item ../../ |
2051 |
|
2052 |
access current or parent menu level |
2053 |
|
2054 |
=item /path/menu |
2055 |
|
2056 |
add/access menu |
2057 |
|
2058 |
=item /path/{-} |
2059 |
|
2060 |
add separator |
2061 |
|
2062 |
=item /path/{item}{rtext} action |
2063 |
|
2064 |
add/alter menu item |
2065 |
|
2066 |
=item -/* |
2067 |
|
2068 |
remove all menus from the menuBar |
2069 |
|
2070 |
=item -/path/menu |
2071 |
|
2072 |
remove menu items, separators and submenus from menu |
2073 |
|
2074 |
=item -/path/menu |
2075 |
|
2076 |
remove menu |
2077 |
|
2078 |
=item -/path/{item} |
2079 |
|
2080 |
remove item |
2081 |
|
2082 |
=item -/path/{-} |
2083 |
|
2084 |
remove separator |
2085 |
|
2086 |
=item <b>Begin<r>Right<l>Left<u>Up<d>Down<e>End |
2087 |
|
2088 |
menu quick arrows |
2089 |
|
2090 |
=back |
2091 |
X<XPM> |
2092 |
|
2093 |
=head1 XPM |
2094 |
|
2095 |
For the XPM XTerm escape sequence B<< C<ESC ] 20 ; Pt ST> >> then value |
2096 |
of B<< C<Pt> >> can be the name of the background pixmap followed by a |
2097 |
sequence of scaling/positioning commands separated by semi-colons. The |
2098 |
scaling/positioning commands are as follows: |
2099 |
|
2100 |
=over 4 |
2101 |
|
2102 |
=item query scale/position |
2103 |
|
2104 |
B<?> |
2105 |
|
2106 |
=item change scale and position |
2107 |
|
2108 |
B<WxH+X+Y> |
2109 |
|
2110 |
B<WxH+X> (== B<WxH+X+X>) |
2111 |
|
2112 |
B<WxH> (same as B<WxH+50+50>) |
2113 |
|
2114 |
B<W+X+Y> (same as B<WxW+X+Y>) |
2115 |
|
2116 |
B<W+X> (same as B<WxW+X+X>) |
2117 |
|
2118 |
B<W> (same as B<WxW+50+50>) |
2119 |
|
2120 |
=item change position (absolute) |
2121 |
|
2122 |
B<=+X+Y> |
2123 |
|
2124 |
B<=+X> (same as B<=+X+Y>) |
2125 |
|
2126 |
=item change position (relative) |
2127 |
|
2128 |
B<+X+Y> |
2129 |
|
2130 |
B<+X> (same as B<+X+Y>) |
2131 |
|
2132 |
=item rescale (relative) |
2133 |
|
2134 |
B<Wx0> -> B<W *= (W/100)> |
2135 |
|
2136 |
B<0xH> -> B<H *= (H/100)> |
2137 |
|
2138 |
=back |
2139 |
|
2140 |
For example: |
2141 |
|
2142 |
=over 4 |
2143 |
|
2144 |
=item B<\E]20;funky\a> |
2145 |
|
2146 |
load B<funky.xpm> as a tiled image |
2147 |
|
2148 |
=item B<\E]20;mona;100\a> |
2149 |
|
2150 |
load B<mona.xpm> with a scaling of 100% |
2151 |
|
2152 |
=item B<\E]20;;200;?\a> |
2153 |
|
2154 |
rescale the current pixmap to 200% and display the image geometry in |
2155 |
the title |
2156 |
|
2157 |
=back |
2158 |
X<Mouse> |
2159 |
|
2160 |
=head1 Mouse Reporting |
2161 |
|
2162 |
=over 4 |
2163 |
|
2164 |
=item B<< C<< ESC [ M <b> <x> <y> >> >> |
2165 |
|
2166 |
report mouse position |
2167 |
|
2168 |
=back |
2169 |
|
2170 |
The lower 2 bits of B<< C<< <b> >> >> indicate the button: |
2171 |
|
2172 |
=over 4 |
2173 |
|
2174 |
=item Button = B<< C<< (<b> - SPACE) & 3 >> >> |
2175 |
|
2176 |
=begin table |
2177 |
|
2178 |
0 Button1 pressed |
2179 |
1 Button2 pressed |
2180 |
2 Button3 pressed |
2181 |
3 button released (X11 mouse report) |
2182 |
|
2183 |
=end table |
2184 |
|
2185 |
=back |
2186 |
|
2187 |
The upper bits of B<< C<< <b> >> >> indicate the modifiers when the |
2188 |
button was pressed and are added together (X11 mouse report only): |
2189 |
|
2190 |
=over 4 |
2191 |
|
2192 |
=item State = B<< C<< (<b> - SPACE) & 60 >> >> |
2193 |
|
2194 |
=begin table |
2195 |
|
2196 |
4 Shift |
2197 |
8 Meta |
2198 |
16 Control |
2199 |
32 Double Click I<(Rxvt extension)> |
2200 |
|
2201 |
=end table |
2202 |
|
2203 |
Col = B<< C<< <x> - SPACE >> >> |
2204 |
|
2205 |
Row = B<< C<< <y> - SPACE >> >> |
2206 |
|
2207 |
=back |
2208 |
X<KeyCodes> |
2209 |
|
2210 |
=head1 Key Codes |
2211 |
|
2212 |
Note: B<Shift> + B<F1>-B<F10> generates B<F11>-B<F20> |
2213 |
|
2214 |
For the keypad, use B<Shift> to temporarily override Application-Keypad |
2215 |
setting use B<Num_Lock> to toggle Application-Keypad setting if |
2216 |
B<Num_Lock> is off, toggle Application-Keypad setting. Also note that |
2217 |
values of B<Home>, B<End>, B<Delete> may have been compiled differently on |
2218 |
your system. |
2219 |
|
2220 |
=begin table |
2221 |
|
2222 |
B<Normal> B<Shift> B<Control> B<Ctrl+Shift> |
2223 |
Tab ^I ESC [ Z ^I ESC [ Z |
2224 |
BackSpace ^H ^? ^? ^? |
2225 |
Find ESC [ 1 ~ ESC [ 1 $ ESC [ 1 ^ ESC [ 1 @ |
2226 |
Insert ESC [ 2 ~ I<paste> ESC [ 2 ^ ESC [ 2 @ |
2227 |
Execute ESC [ 3 ~ ESC [ 3 $ ESC [ 3 ^ ESC [ 3 @ |
2228 |
Select ESC [ 4 ~ ESC [ 4 $ ESC [ 4 ^ ESC [ 4 @ |
2229 |
Prior ESC [ 5 ~ I<scroll-up> ESC [ 5 ^ ESC [ 5 @ |
2230 |
Next ESC [ 6 ~ I<scroll-down> ESC [ 6 ^ ESC [ 6 @ |
2231 |
Home ESC [ 7 ~ ESC [ 7 $ ESC [ 7 ^ ESC [ 7 @ |
2232 |
End ESC [ 8 ~ ESC [ 8 $ ESC [ 8 ^ ESC [ 8 @ |
2233 |
Delete ESC [ 3 ~ ESC [ 3 $ ESC [ 3 ^ ESC [ 3 @ |
2234 |
F1 ESC [ 11 ~ ESC [ 23 ~ ESC [ 11 ^ ESC [ 23 ^ |
2235 |
F2 ESC [ 12 ~ ESC [ 24 ~ ESC [ 12 ^ ESC [ 24 ^ |
2236 |
F3 ESC [ 13 ~ ESC [ 25 ~ ESC [ 13 ^ ESC [ 25 ^ |
2237 |
F4 ESC [ 14 ~ ESC [ 26 ~ ESC [ 14 ^ ESC [ 26 ^ |
2238 |
F5 ESC [ 15 ~ ESC [ 28 ~ ESC [ 15 ^ ESC [ 28 ^ |
2239 |
F6 ESC [ 17 ~ ESC [ 29 ~ ESC [ 17 ^ ESC [ 29 ^ |
2240 |
F7 ESC [ 18 ~ ESC [ 31 ~ ESC [ 18 ^ ESC [ 31 ^ |
2241 |
F8 ESC [ 19 ~ ESC [ 32 ~ ESC [ 19 ^ ESC [ 32 ^ |
2242 |
F9 ESC [ 20 ~ ESC [ 33 ~ ESC [ 20 ^ ESC [ 33 ^ |
2243 |
F10 ESC [ 21 ~ ESC [ 34 ~ ESC [ 21 ^ ESC [ 34 ^ |
2244 |
F11 ESC [ 23 ~ ESC [ 23 $ ESC [ 23 ^ ESC [ 23 @ |
2245 |
F12 ESC [ 24 ~ ESC [ 24 $ ESC [ 24 ^ ESC [ 24 @ |
2246 |
F13 ESC [ 25 ~ ESC [ 25 $ ESC [ 25 ^ ESC [ 25 @ |
2247 |
F14 ESC [ 26 ~ ESC [ 26 $ ESC [ 26 ^ ESC [ 26 @ |
2248 |
F15 (Help) ESC [ 28 ~ ESC [ 28 $ ESC [ 28 ^ ESC [ 28 @ |
2249 |
F16 (Menu) ESC [ 29 ~ ESC [ 29 $ ESC [ 29 ^ ESC [ 29 @ |
2250 |
F17 ESC [ 31 ~ ESC [ 31 $ ESC [ 31 ^ ESC [ 31 @ |
2251 |
F18 ESC [ 32 ~ ESC [ 32 $ ESC [ 32 ^ ESC [ 32 @ |
2252 |
F19 ESC [ 33 ~ ESC [ 33 $ ESC [ 33 ^ ESC [ 33 @ |
2253 |
F20 ESC [ 34 ~ ESC [ 34 $ ESC [ 34 ^ ESC [ 34 @ |
2254 |
B<Application> |
2255 |
Up ESC [ A ESC [ a ESC O a ESC O A |
2256 |
Down ESC [ B ESC [ b ESC O b ESC O B |
2257 |
Right ESC [ C ESC [ c ESC O c ESC O C |
2258 |
Left ESC [ D ESC [ d ESC O d ESC O D |
2259 |
KP_Enter ^M ESC O M |
2260 |
KP_F1 ESC O P ESC O P |
2261 |
KP_F2 ESC O Q ESC O Q |
2262 |
KP_F3 ESC O R ESC O R |
2263 |
KP_F4 ESC O S ESC O S |
2264 |
XK_KP_Multiply * ESC O j |
2265 |
XK_KP_Add + ESC O k |
2266 |
XK_KP_Separator , ESC O l |
2267 |
XK_KP_Subtract - ESC O m |
2268 |
XK_KP_Decimal . ESC O n |
2269 |
XK_KP_Divide / ESC O o |
2270 |
XK_KP_0 0 ESC O p |
2271 |
XK_KP_1 1 ESC O q |
2272 |
XK_KP_2 2 ESC O r |
2273 |
XK_KP_3 3 ESC O s |
2274 |
XK_KP_4 4 ESC O t |
2275 |
XK_KP_5 5 ESC O u |
2276 |
XK_KP_6 6 ESC O v |
2277 |
XK_KP_7 7 ESC O w |
2278 |
XK_KP_8 8 ESC O x |
2279 |
XK_KP_9 9 ESC O y |
2280 |
|
2281 |
=end table |
2282 |
|
2283 |
=head1 CONFIGURE OPTIONS |
2284 |
|
2285 |
General hint: if you get compile errors, then likely your configuration |
2286 |
hasn't been tested well. Either try with C<--enable-everything> or use |
2287 |
the F<./reconf> script as a base for experiments. F<./reconf> is used by |
2288 |
myself, so it should generally be a working config. Of course, you should |
2289 |
always report when a combination doesn't work, so it can be fixed. Marc |
2290 |
Lehmann <rxvt@schmorp.de>. |
2291 |
|
2292 |
All |
2293 |
|
2294 |
=over 4 |
2295 |
|
2296 |
=item --enable-everything |
2297 |
|
2298 |
Add (or remove) support for all non-multichoice options listed in "./configure |
2299 |
--help". |
2300 |
|
2301 |
You can specify this and then disable options you do not like by |
2302 |
I<following> this with the appropriate C<--disable-...> arguments, |
2303 |
or you can start with a minimal configuration by specifying |
2304 |
C<--disable-everything> and than adding just the C<--enable-...> arguments |
2305 |
you want. |
2306 |
|
2307 |
=item --enable-xft (default: enabled) |
2308 |
|
2309 |
Add support for Xft (anti-aliases, among others) fonts. Xft fonts are |
2310 |
slower and require lots of memory, but as long as you don't use them, you |
2311 |
don't pay for them. |
2312 |
|
2313 |
=item --enable-font-styles (default: on) |
2314 |
|
2315 |
Add support for B<bold>, I<italic> and B<< I<bold italic> >> font |
2316 |
styles. The fonts can be set manually or automatically. |
2317 |
|
2318 |
=item --with-codesets=NAME,... (default: all) |
2319 |
|
2320 |
Compile in support for additional codeset (encoding) groups (C<eu>, C<vn> |
2321 |
are always compiled in, which includes most 8-bit character sets). These |
2322 |
codeset tables are used for driving X11 core fonts, they are not required |
2323 |
for Xft fonts, although having them compiled in lets rxvt-unicode choose |
2324 |
replacement fonts more intelligently. Compiling them in will make your |
2325 |
binary bigger (all of together cost about 700kB), but it doesn't increase |
2326 |
memory usage unless you use a font requiring one of these encodings. |
2327 |
|
2328 |
=begin table |
2329 |
|
2330 |
all all available codeset groups |
2331 |
zh common chinese encodings |
2332 |
zh_ext rarely used but very big chinese encodigs |
2333 |
jp common japanese encodings |
2334 |
jp_ext rarely used but big japanese encodings |
2335 |
kr korean encodings |
2336 |
|
2337 |
=end table |
2338 |
|
2339 |
=item --enable-xim (default: on) |
2340 |
|
2341 |
Add support for XIM (X Input Method) protocol. This allows using |
2342 |
alternative input methods (e.g. kinput2) and will also correctly |
2343 |
set up the input for people using dead keys or compose keys. |
2344 |
|
2345 |
=item --enable-unicode3 (default: off) |
2346 |
|
2347 |
Enable direct support for displaying unicode codepoints above |
2348 |
65535 (the basic multilingual page). This increases storage |
2349 |
requirements per character from 2 to 4 bytes. X11 fonts do not yet |
2350 |
support these extra characters, but Xft does. |
2351 |
|
2352 |
Please note that rxvt-unicode can store unicode code points >65535 |
2353 |
even without this flag, but the number of such characters is |
2354 |
limited to a view thousand (shared with combining characters, |
2355 |
see next switch), and right now rxvt-unicode cannot display them |
2356 |
(input/output and cut&paste still work, though). |
2357 |
|
2358 |
=item --enable-combining (default: on) |
2359 |
|
2360 |
Enable automatic composition of combining characters into |
2361 |
composite characters. This is required for proper viewing of text |
2362 |
where accents are encoded as seperate unicode characters. This is |
2363 |
done by using precomposited characters when available or creating |
2364 |
new pseudo-characters when no precomposed form exists. |
2365 |
|
2366 |
Without --enable-unicode3, the number of additional precomposed characters |
2367 |
is rather limited (2048, if this is full, rxvt-unicode will use the |
2368 |
private use area, extending the number of combinations to 8448). With |
2369 |
--enable-unicode3, no practical limit exists. |
2370 |
|
2371 |
This option will also enable storage (but not display) of characters |
2372 |
beyond plane 0 (>65535) when --enable-unicode3 was not specified. |
2373 |
|
2374 |
The combining table also contains entries for arabic presentation forms, |
2375 |
but these are not currently used. Bug me if you want these to be used (and |
2376 |
tell me how these are to be used...). |
2377 |
|
2378 |
=item --enable-fallback(=CLASS) (default: Rxvt) |
2379 |
|
2380 |
When reading resource settings, also read settings for class CLASS. To disable resource fallback use --disable-fallback. |
2381 |
|
2382 |
=item --with-res-name=NAME (default: urxvt) |
2383 |
|
2384 |
Use the given name as default application name when |
2385 |
reading resources. Specify --with-res-name=rxvt to replace rxvt. |
2386 |
|
2387 |
=item --with-res-class=CLASS /default: URxvt) |
2388 |
|
2389 |
Use the given class as default application class |
2390 |
when reading resources. Specify --with-res-class=Rxvt to replace |
2391 |
rxvt. |
2392 |
|
2393 |
=item --enable-utmp (default: on) |
2394 |
|
2395 |
Write user and tty to utmp file (used by programs like F<w>) at |
2396 |
start of rxvt execution and delete information when rxvt exits. |
2397 |
|
2398 |
=item --enable-wtmp (default: on) |
2399 |
|
2400 |
Write user and tty to wtmp file (used by programs like F<last>) at |
2401 |
start of rxvt execution and write logout when rxvt exits. This |
2402 |
option requires --enable-utmp to also be specified. |
2403 |
|
2404 |
=item --enable-lastlog (default: on) |
2405 |
|
2406 |
Write user and tty to lastlog file (used by programs like |
2407 |
F<lastlogin>) at start of rxvt execution. This option requires |
2408 |
--enable-utmp to also be specified. |
2409 |
|
2410 |
=item --enable-xpm-background (default: off) |
2411 |
|
2412 |
Add support for XPM background pixmaps. |
2413 |
|
2414 |
=item --enable-transparency (default: off) |
2415 |
|
2416 |
Add support for inheriting parent backgrounds thus giving a fake |
2417 |
transparency to the term. |
2418 |
|
2419 |
=item --enable-fading (default: on) |
2420 |
|
2421 |
Add support for fading the text when focus is lost (requires C<--enable-transparency>). |
2422 |
|
2423 |
=item --enable-tinting (default: on) |
2424 |
|
2425 |
Add support for tinting of transparent backgrounds (requires C<--enable-transparency>). |
2426 |
|
2427 |
=item --enable-menubar (default: off) |
2428 |
|
2429 |
Add support for our menu bar system (this interacts badly with |
2430 |
dynamic locale switching currently). |
2431 |
|
2432 |
=item --enable-rxvt-scroll (default: on) |
2433 |
|
2434 |
Add support for the original rxvt scrollbar. |
2435 |
|
2436 |
=item --enable-next-scroll (default: on) |
2437 |
|
2438 |
Add support for a NeXT-like scrollbar. |
2439 |
|
2440 |
=item --enable-xterm-scroll (default: on) |
2441 |
|
2442 |
Add support for an Xterm-like scrollbar. |
2443 |
|
2444 |
=item --enable-plain-scroll (default: on) |
2445 |
|
2446 |
Add support for a very unobtrusive, plain-looking scrollbar that |
2447 |
is the favourite of the rxvt-unicode author, having used it for |
2448 |
many years. |
2449 |
|
2450 |
=item --enable-half-shadow (default: off) |
2451 |
|
2452 |
Make shadows on the scrollbar only half the normal width & height. |
2453 |
only applicable to rxvt scrollbars. |
2454 |
|
2455 |
=item --enable-ttygid (default: off) |
2456 |
|
2457 |
Change tty device setting to group "tty" - only use this if |
2458 |
your system uses this type of security. |
2459 |
|
2460 |
=item --disable-backspace-key |
2461 |
|
2462 |
Removes any handling of the backspace key by us - let the X server do it. |
2463 |
|
2464 |
=item --disable-delete-key |
2465 |
|
2466 |
Removes any handling of the delete key by us - let the X server |
2467 |
do it. |
2468 |
|
2469 |
=item --disable-resources |
2470 |
|
2471 |
Removes any support for resource checking. |
2472 |
|
2473 |
=item --enable-xgetdefault |
2474 |
|
2475 |
Make resources checking via XGetDefault() instead of our small |
2476 |
version which only checks ~/.Xdefaults, or if that doesn't exist then |
2477 |
~/.Xresources. |
2478 |
|
2479 |
Please note that nowadays, things like XIM will automatically pull in and |
2480 |
use the full X resource manager, so the overhead of using it might be very |
2481 |
small, if nonexistant. |
2482 |
|
2483 |
=item --enable-strings (default: off) |
2484 |
|
2485 |
Add support for our possibly faster memset() function and other |
2486 |
various routines, overriding your system's versions which may |
2487 |
have been hand-crafted in assembly or may require extra libraries |
2488 |
to link in. (this breaks ANSI-C rules and has problems on many |
2489 |
GNU/Linux systems). |
2490 |
|
2491 |
=item --disable-swapscreen |
2492 |
|
2493 |
Remove support for secondary/swap screen. |
2494 |
|
2495 |
=item --enable-frills (default: on) |
2496 |
|
2497 |
Add support for many small features that are not essential but nice to |
2498 |
have. Normally you want this, but for very small binaries you may want to |
2499 |
disable this. |
2500 |
|
2501 |
A non-exhaustive list of features enabled by C<--enable-frills> (possibly |
2502 |
in combination with other switches) is: |
2503 |
|
2504 |
MWM-hints |
2505 |
EWMH-hints (pid, utf8 names) and protocols (ping) |
2506 |
seperate underline colour |
2507 |
settable border widths and borderless switch |
2508 |
settable extra linespacing |
2509 |
iso-14755-2 and -3, and visual feedback |
2510 |
backindex and forwardindex escape sequence |
2511 |
window op and some xterm/OSC escape sequences |
2512 |
tripleclickwords |
2513 |
settable insecure mode |
2514 |
keysym remapping support |
2515 |
cursor blinking and underline cursor |
2516 |
-embed, -pty-fd and -hold options |
2517 |
|
2518 |
=item --enable-iso14755 (default: on) |
2519 |
|
2520 |
Enable extended ISO 14755 support (see @@RXVT_NAME@@(1), or |
2521 |
F<doc/rxvt.1.txt>). Basic support (section 5.1) is enabled by |
2522 |
C<--enable-frills>, while support for 5.2, 5.3 and 5.4 is enabled with |
2523 |
this switch. |
2524 |
|
2525 |
=item --enable-keepscrolling (default: on) |
2526 |
|
2527 |
Add support for continual scrolling of the display when you hold |
2528 |
the mouse button down on a scrollbar arrow. |
2529 |
|
2530 |
=item --enable-mousewheel (default: on) |
2531 |
|
2532 |
Add support for scrolling via mouse wheel or buttons 4 & 5. |
2533 |
|
2534 |
=item --enable-slipwheeling (default: on) |
2535 |
|
2536 |
Add support for continual scrolling (using the mouse wheel as an |
2537 |
accelerator) while the control key is held down. This option |
2538 |
requires --enable-mousewheel to also be specified. |
2539 |
|
2540 |
=item --disable-new-selection |
2541 |
|
2542 |
Remove support for mouse selection style like that of xterm. |
2543 |
|
2544 |
=item --enable-dmalloc (default: off) |
2545 |
|
2546 |
Use Gray Watson's malloc - which is good for debugging See |
2547 |
http://www.letters.com/dmalloc/ for details If you use either this or the |
2548 |
next option, you may need to edit src/Makefile after compiling to point |
2549 |
DINCLUDE and DLIB to the right places. |
2550 |
|
2551 |
You can only use either this option and the following (should |
2552 |
you use either) . |
2553 |
|
2554 |
=item --enable-dlmalloc (default: off) |
2555 |
|
2556 |
Use Doug Lea's malloc - which is good for a production version |
2557 |
See L<http://g.oswego.edu/dl/html/malloc.html> for details. |
2558 |
|
2559 |
=item --enable-smart-resize (default: on) |
2560 |
|
2561 |
Add smart growth/shrink behaviour when changing font size via hot |
2562 |
keys. This should keep the window corner which is closest to a corner of |
2563 |
the screen in a fixed position. |
2564 |
|
2565 |
=item --enable-pointer-blank (default: on) |
2566 |
|
2567 |
Add support to have the pointer disappear when typing or inactive. |
2568 |
|
2569 |
=item --enable-perl (default: off) |
2570 |
|
2571 |
Enable an embedded perl interpreter. See the B<rxvtperl(3)> manpage |
2572 |
(F<doc/rxvtperl.txt>) for more info on this feature, or the files in |
2573 |
F<src/perl-ext/> for the extensions that are installed by default. |
2574 |
|
2575 |
=item --with-name=NAME (default: urxvt) |
2576 |
|
2577 |
Set the basename for the installed binaries, resulting |
2578 |
in C<urxvt>, C<urxvtd> etc.). Specify C<--with-name=rxvt> to replace with |
2579 |
C<rxvt>. |
2580 |
|
2581 |
=item --with-term=NAME (default: rxvt-unicode) |
2582 |
|
2583 |
Change the environmental variable for the terminal to NAME. |
2584 |
|
2585 |
=item --with-terminfo=PATH |
2586 |
|
2587 |
Change the environmental variable for the path to the terminfo tree to |
2588 |
PATH. |
2589 |
|
2590 |
=item --with-x |
2591 |
|
2592 |
Use the X Window System (pretty much default, eh?). |
2593 |
|
2594 |
=item --with-xpm-includes=DIR |
2595 |
|
2596 |
Look for the XPM includes in DIR. |
2597 |
|
2598 |
=item --with-xpm-library=DIR |
2599 |
|
2600 |
Look for the XPM library in DIR. |
2601 |
|
2602 |
=item --with-xpm |
2603 |
|
2604 |
Not needed - define via --enable-xpm-background. |
2605 |
|
2606 |
=back |
2607 |
|
2608 |
=head1 AUTHORS |
2609 |
|
2610 |
Marc Lehmann <rxvt@schmorp.de> converted this document to pod and |
2611 |
reworked it from the original Rxvt documentation, which was done by Geoff |
2612 |
Wing <gcw@pobox.com>, who in turn used the XTerm documentation and other |
2613 |
sources. |
2614 |
|