ViewVC Help
View File | Revision Log | Show Annotations | Download File
/cvs/rxvt-unicode/doc/rxvt.7.man.in
Revision: 1.5
Committed: Thu Feb 3 10:24:10 2005 UTC (19 years, 4 months ago) by root
Branch: MAIN
CVS Tags: rel-4_9
Changes since 1.4: +54 -28 lines
Log Message:
*** empty log message ***

File Contents

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