ViewVC Help
View File | Revision Log | Show Annotations | Download File
/cvs/rxvt-unicode/doc/rxvt.7.man.in
Revision: 1.19
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.18: +12 -10 lines
Log Message:
*** empty log message ***

File Contents

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