ViewVC Help
View File | Revision Log | Show Annotations | Download File
/cvs/rxvt-unicode/doc/rxvt.7.man.in
Revision: 1.26
Committed: Tue Nov 8 17:35:28 2005 UTC (18 years, 7 months ago) by root
Branch: MAIN
Changes since 1.25: +3 -3 lines
Log Message:
*** empty log message ***

File Contents

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