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