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