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