ViewVC Help
View File | Revision Log | Show Annotations | Download File
/cvs/rxvt-unicode/doc/rxvt.7.pod
Revision: 1.58
Committed: Wed Jul 13 02:24:02 2005 UTC (18 years, 11 months ago) by root
Branch: MAIN
Changes since 1.57: +13 -7 lines
Log Message:
*** empty log message ***

File Contents

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