ViewVC Help
View File | Revision Log | Show Annotations | Download File
/cvs/rxvt-unicode/doc/rxvt.7.man.in
Revision: 1.1
Committed: Tue Jan 11 02:24:59 2005 UTC (19 years, 5 months ago) by root
Branch: MAIN
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-01-11" "4.8" "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 keysym
684 0xFF00 \- 0xFFFF (function, cursor keys, etc).
685 .Sp
686 Here's an example for a tn3270 session started using `@@RXVT_NAME@@ \-name tn3270'
687 .Sp
688 .Vb 3
689 \& !# ----- special uses ------:
690 \& ! tn3270 login, remap function and arrow keys.
691 \& tn3270*font: *clean-bold-*-*--15-*
692 .Ve
693 .Sp
694 .Vb 3
695 \& ! keysym - used by rxvt only
696 \& ! Delete - ^D
697 \& tn3270*keysym.0xFFFF: \e004
698 .Ve
699 .Sp
700 .Vb 12
701 \& ! Home - ^A
702 \& tn3270*keysym.0xFF50: \e001
703 \& ! Left - ^B
704 \& tn3270*keysym.0xFF51: \e002
705 \& ! Up - ^P
706 \& tn3270*keysym.0xFF52: \e020
707 \& ! Right - ^F
708 \& tn3270*keysym.0xFF53: \e006
709 \& ! Down - ^N
710 \& tn3270*keysym.0xFF54: \e016
711 \& ! End - ^E
712 \& tn3270*keysym.0xFF57: \e005
713 .Ve
714 .Sp
715 .Vb 13
716 \& ! F1 - F12
717 \& tn3270*keysym.0xFFBE: \ee1
718 \& tn3270*keysym.0xFFBF: \ee2
719 \& tn3270*keysym.0xFFC0: \ee3
720 \& tn3270*keysym.0xFFC1: \ee4
721 \& tn3270*keysym.0xFFC2: \ee5
722 \& tn3270*keysym.0xFFC3: \ee6
723 \& tn3270*keysym.0xFFC4: \ee7
724 \& tn3270*keysym.0xFFC5: \ee8
725 \& tn3270*keysym.0xFFC6: \ee9
726 \& tn3270*keysym.0xFFC7: \ee0
727 \& tn3270*keysym.0xFFC8: \ee-
728 \& tn3270*keysym.0xFFC9: \ee=
729 .Ve
730 .Sp
731 .Vb 3
732 \& ! map Prior/Next to F7/F8
733 \& tn3270*keysym.0xFF55: \ee7
734 \& tn3270*keysym.0xFF56: \ee8
735 .Ve
736 .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
737 .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."
738 .Vb 6
739 \& KP_Insert == Insert
740 \& F22 == Print
741 \& F27 == Home
742 \& F29 == Prior
743 \& F33 == End
744 \& F35 == Next
745 .Ve
746 .Sp
747 Rather than have rxvt-unicode try to accommodate all the various possible keyboard
748 mappings, it is better to use `xmodmap' to remap the keys as required for
749 your particular machine.
750 .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
751 .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."
752 rxvt and rxvt-unicode always export the variable \*(L"\s-1COLORTERM\s0\*(R", so you can
753 check and see if that is set. Note that several programs, \s-1JED\s0, slrn,
754 Midnight Commander automatically check this variable to decide whether or
755 not to use color.
756 .IP "How do I set the correct, full \s-1IP\s0 address for the \s-1DISPLAY\s0 variable?" 4
757 .IX Item "How do I set the correct, full IP address for the DISPLAY variable?"
758 If you've compiled rxvt-unicode with \s-1DISPLAY_IS_IP\s0 and have enabled
759 insecure mode then it is possible to use the following shell script
760 snippets to correctly set the display. If your version of rxvt-unicode
761 wasn't also compiled with \s-1ESCZ_ANSWER\s0 (as assumed in these snippets) then
762 the \s-1COLORTERM\s0 variable can be used to distinguish rxvt-unicode from a
763 regular xterm.
764 .Sp
765 Courtesy of Chuck Blake <cblake@BBN.COM> with the following shell script
766 snippets:
767 .Sp
768 .Vb 12
769 \& # Bourne/Korn/POSIX family of shells:
770 \& [ ${TERM:-foo} = foo ] && TERM=xterm # assume an xterm if we don't know
771 \& if [ ${TERM:-foo} = xterm ]; then
772 \& stty -icanon -echo min 0 time 15 # see if enhanced rxvt or not
773 \& echo -n '^[Z'
774 \& read term_id
775 \& stty icanon echo
776 \& if [ ""${term_id} = '^[[?1;2C' -a ${DISPLAY:-foo} = foo ]; then
777 \& echo -n '^[[7n' # query the rxvt we are in for the DISPLAY string
778 \& read DISPLAY # set it in our local shell
779 \& fi
780 \& fi
781 .Ve
782 .IP "How do I compile the manual pages for myself?" 4
783 .IX Item "How do I compile the manual pages for myself?"
784 You need to have a recent version of perl installed as \fI/usr/bin/perl\fR,
785 one that comes with \fIpod2man\fR, \fIpod2text\fR and \fIpod2html\fR. Then go to
786 the doc subdirectory and enter \f(CW\*(C`make alldoc\*(C'\fR.
787 .IP "My question isn't answered here, can I ask a human?" 4
788 .IX Item "My question isn't answered here, can I ask a human?"
789 Before sending me mail, you could go to \s-1IRC:\s0 \f(CW\*(C`irc.freenode.net\*(C'\fR,
790 channel \f(CW\*(C`#rxvt\-unicode\*(C'\fR has some rxvt-unicode enthusiasts that might be
791 interested in learning about new and exciting problems (but not FAQs :).
792 .SH "SYNOPSIS"
793 .IX Header "SYNOPSIS"
794 .Vb 2
795 \& # set a new font set
796 \& printf '\e33]50;%s\e007' 9x15,xft:Kochi" Mincho"
797 .Ve
798 .PP
799 .Vb 2
800 \& # change the locale and tell rxvt-unicode about it
801 \& export LC_CTYPE=ja_JP.EUC-JP; printf "\e33]701;$LC_CTYPE\e007"
802 .Ve
803 .PP
804 .Vb 2
805 \& # set window title
806 \& printf '\e33]2;%s\e007' "new window title"
807 .Ve
808 .SH "DESCRIPTION"
809 .IX Header "DESCRIPTION"
810 The rest of this document describes various technical aspects of
811 \&\fBrxvt-unicode\fR. First the description of supported command sequences,
812 followed by menu and pixmap support and last by a description of all
813 features selectable at \f(CW\*(C`configure\*(C'\fR time.
814 .SH "RXVT TECHNICAL REFERENCE"
815 .IX Header "RXVT TECHNICAL REFERENCE"
816 .SH "Definitions"
817 .IX Header "Definitions"
818 .ie n .IP "\fB\fB\*(C`c\*(C'\fB\fR" 4
819 .el .IP "\fB\f(CB\*(C`c\*(C'\fB\fR" 4
820 .IX Item "c"
821 The literal character c.
822 .ie n .IP "\fB\fB\*(C`C\*(C'\fB\fR" 4
823 .el .IP "\fB\f(CB\*(C`C\*(C'\fB\fR" 4
824 .IX Item "C"
825 A single (required) character.
826 .ie n .IP "\fB\fB\*(C`Ps\*(C'\fB\fR" 4
827 .el .IP "\fB\f(CB\*(C`Ps\*(C'\fB\fR" 4
828 .IX Item "Ps"
829 A single (usually optional) numeric parameter, composed of one or more
830 digits.
831 .ie n .IP "\fB\fB\*(C`Pm\*(C'\fB\fR" 4
832 .el .IP "\fB\f(CB\*(C`Pm\*(C'\fB\fR" 4
833 .IX Item "Pm"
834 A multiple numeric parameter composed of any number of single numeric
835 parameters, separated by \f(CW\*(C`;\*(C'\fR character(s).
836 .ie n .IP "\fB\fB\*(C`Pt\*(C'\fB\fR" 4
837 .el .IP "\fB\f(CB\*(C`Pt\*(C'\fB\fR" 4
838 .IX Item "Pt"
839 A text parameter composed of printable characters.
840 .SH "Values"
841 .IX Header "Values"
842 .ie n .IP "\fB\fB\*(C`ENQ\*(C'\fB\fR" 4
843 .el .IP "\fB\f(CB\*(C`ENQ\*(C'\fB\fR" 4
844 .IX Item "ENQ"
845 Enquiry (Ctrl\-E) = Send Device Attributes (\s-1DA\s0)
846 request attributes from terminal. See \fB\f(CB\*(C`ESC [ Ps c\*(C'\fB\fR.
847 .ie n .IP "\fB\fB\*(C`BEL\*(C'\fB\fR" 4
848 .el .IP "\fB\f(CB\*(C`BEL\*(C'\fB\fR" 4
849 .IX Item "BEL"
850 Bell (Ctrl\-G)
851 .ie n .IP "\fB\fB\*(C`BS\*(C'\fB\fR" 4
852 .el .IP "\fB\f(CB\*(C`BS\*(C'\fB\fR" 4
853 .IX Item "BS"
854 Backspace (Ctrl\-H)
855 .ie n .IP "\fB\fB\*(C`TAB\*(C'\fB\fR" 4
856 .el .IP "\fB\f(CB\*(C`TAB\*(C'\fB\fR" 4
857 .IX Item "TAB"
858 Horizontal Tab (\s-1HT\s0) (Ctrl\-I)
859 .ie n .IP "\fB\fB\*(C`LF\*(C'\fB\fR" 4
860 .el .IP "\fB\f(CB\*(C`LF\*(C'\fB\fR" 4
861 .IX Item "LF"
862 Line Feed or New Line (\s-1NL\s0) (Ctrl\-J)
863 .ie n .IP "\fB\fB\*(C`VT\*(C'\fB\fR" 4
864 .el .IP "\fB\f(CB\*(C`VT\*(C'\fB\fR" 4
865 .IX Item "VT"
866 Vertical Tab (Ctrl\-K) same as \fB\f(CB\*(C`LF\*(C'\fB\fR
867 .ie n .IP "\fB\fB\*(C`FF\*(C'\fB\fR" 4
868 .el .IP "\fB\f(CB\*(C`FF\*(C'\fB\fR" 4
869 .IX Item "FF"
870 Form Feed or New Page (\s-1NP\s0) (Ctrl\-L) same as \fB\f(CB\*(C`LF\*(C'\fB\fR
871 .ie n .IP "\fB\fB\*(C`CR\*(C'\fB\fR" 4
872 .el .IP "\fB\f(CB\*(C`CR\*(C'\fB\fR" 4
873 .IX Item "CR"
874 Carriage Return (Ctrl\-M)
875 .ie n .IP "\fB\fB\*(C`SO\*(C'\fB\fR" 4
876 .el .IP "\fB\f(CB\*(C`SO\*(C'\fB\fR" 4
877 .IX Item "SO"
878 Shift Out (Ctrl\-N), invokes the G1 character set.
879 Switch to Alternate Character Set
880 .ie n .IP "\fB\fB\*(C`SI\*(C'\fB\fR" 4
881 .el .IP "\fB\f(CB\*(C`SI\*(C'\fB\fR" 4
882 .IX Item "SI"
883 Shift In (Ctrl\-O), invokes the G0 character set (the default).
884 Switch to Standard Character Set
885 .ie n .IP "\fB\fB\*(C`SPC\*(C'\fB\fR" 4
886 .el .IP "\fB\f(CB\*(C`SPC\*(C'\fB\fR" 4
887 .IX Item "SPC"
888 Space Character
889 .SH "Escape Sequences"
890 .IX Header "Escape Sequences"
891 .ie n .IP "\fB\fB\*(C`ESC # 8\*(C'\fB\fR" 4
892 .el .IP "\fB\f(CB\*(C`ESC # 8\*(C'\fB\fR" 4
893 .IX Item "ESC # 8"
894 \&\s-1DEC\s0 Screen Alignment Test (\s-1DECALN\s0)
895 .ie n .IP "\fB\fB\*(C`ESC 7\*(C'\fB\fR" 4
896 .el .IP "\fB\f(CB\*(C`ESC 7\*(C'\fB\fR" 4
897 .IX Item "ESC 7"
898 Save Cursor (\s-1SC\s0)
899 .ie n .IP "\fB\fB\*(C`ESC 8\*(C'\fB\fR" 4
900 .el .IP "\fB\f(CB\*(C`ESC 8\*(C'\fB\fR" 4
901 .IX Item "ESC 8"
902 Restore Cursor
903 .ie n .IP "\fB\fB\*(C`ESC =\*(C'\fB\fR" 4
904 .el .IP "\fB\f(CB\*(C`ESC =\*(C'\fB\fR" 4
905 .IX Item "ESC ="
906 Application Keypad (\s-1SMKX\s0). See also next sequence.
907 .ie n .IP "\fB\fB\*(C`ESC\*(C'\fB\fR" 4
908 .el .IP "\fB\f(CB\*(C`ESC\*(C'\fB\fR" 4
909 .IX Item "ESC"
910 Normal Keypad (\s-1RMKX\s0)
911 .Sp
912 \&\fBNote:\fR If the numeric keypad is activated, eg, \fBNum_Lock\fR has been
913 pressed, numbers or control functions are generated by the numeric keypad
914 (see Key Codes).
915 .ie n .IP "\fB\fB\*(C`ESC D\*(C'\fB\fR" 4
916 .el .IP "\fB\f(CB\*(C`ESC D\*(C'\fB\fR" 4
917 .IX Item "ESC D"
918 Index (\s-1IND\s0)
919 .ie n .IP "\fB\fB\*(C`ESC E\*(C'\fB\fR" 4
920 .el .IP "\fB\f(CB\*(C`ESC E\*(C'\fB\fR" 4
921 .IX Item "ESC E"
922 Next Line (\s-1NEL\s0)
923 .ie n .IP "\fB\fB\*(C`ESC H\*(C'\fB\fR" 4
924 .el .IP "\fB\f(CB\*(C`ESC H\*(C'\fB\fR" 4
925 .IX Item "ESC H"
926 Tab Set (\s-1HTS\s0)
927 .ie n .IP "\fB\fB\*(C`ESC M\*(C'\fB\fR" 4
928 .el .IP "\fB\f(CB\*(C`ESC M\*(C'\fB\fR" 4
929 .IX Item "ESC M"
930 Reverse Index (\s-1RI\s0)
931 .ie n .IP "\fB\fB\*(C`ESC N\*(C'\fB\fR" 4
932 .el .IP "\fB\f(CB\*(C`ESC N\*(C'\fB\fR" 4
933 .IX Item "ESC N"
934 Single Shift Select of G2 Character Set (\s-1SS2\s0): affects next character
935 only \fIunimplemented\fR
936 .ie n .IP "\fB\fB\*(C`ESC O\*(C'\fB\fR" 4
937 .el .IP "\fB\f(CB\*(C`ESC O\*(C'\fB\fR" 4
938 .IX Item "ESC O"
939 Single Shift Select of G3 Character Set (\s-1SS3\s0): affects next character
940 only \fIunimplemented\fR
941 .ie n .IP "\fB\fB\*(C`ESC Z\*(C'\fB\fR" 4
942 .el .IP "\fB\f(CB\*(C`ESC Z\*(C'\fB\fR" 4
943 .IX Item "ESC Z"
944 Obsolete form of returns: \fB\f(CB\*(C`ESC[?1;2C\*(C'\fB\fR \fIrxvt-unicode compile-time option\fR
945 .ie n .IP "\fB\fB\*(C`ESC c\*(C'\fB\fR" 4
946 .el .IP "\fB\f(CB\*(C`ESC c\*(C'\fB\fR" 4
947 .IX Item "ESC c"
948 Full reset (\s-1RIS\s0)
949 .ie n .IP "\fB\fB\*(C`ESC n\*(C'\fB\fR" 4
950 .el .IP "\fB\f(CB\*(C`ESC n\*(C'\fB\fR" 4
951 .IX Item "ESC n"
952 Invoke the G2 Character Set (\s-1LS2\s0)
953 .ie n .IP "\fB\fB\*(C`ESC o\*(C'\fB\fR" 4
954 .el .IP "\fB\f(CB\*(C`ESC o\*(C'\fB\fR" 4
955 .IX Item "ESC o"
956 Invoke the G3 Character Set (\s-1LS3\s0)
957 .ie n .IP "\fB\fB\*(C`ESC\*(C'\fB ( C>\fR" 4
958 .el .IP "\fB\f(CB\*(C`ESC\*(C'\fB ( C>\fR" 4
959 .IX Item "ESC ( C>"
960 Designate G0 Character Set (\s-1ISO\s0 2022), see below for values of \f(CW\*(C`C\*(C'\fR.
961 .ie n .IP "\fB\fB\*(C`ESC\*(C'\fB ) C>\fR" 4
962 .el .IP "\fB\f(CB\*(C`ESC\*(C'\fB ) C>\fR" 4
963 .IX Item "ESC ) C>"
964 Designate G1 Character Set (\s-1ISO\s0 2022), see below for values of \f(CW\*(C`C\*(C'\fR.
965 .ie n .IP "\fB\fB\*(C`ESC * C\*(C'\fB\fR" 4
966 .el .IP "\fB\f(CB\*(C`ESC * C\*(C'\fB\fR" 4
967 .IX Item "ESC * C"
968 Designate G2 Character Set (\s-1ISO\s0 2022), see below for values of \f(CW\*(C`C\*(C'\fR.
969 .ie n .IP "\fB\fB\*(C`ESC + C\*(C'\fB\fR" 4
970 .el .IP "\fB\f(CB\*(C`ESC + C\*(C'\fB\fR" 4
971 .IX Item "ESC + C"
972 Designate G3 Character Set (\s-1ISO\s0 2022), see below for values of \f(CW\*(C`C\*(C'\fR.
973 .ie n .IP "\fB\fB\*(C`ESC $ C\*(C'\fB\fR" 4
974 .el .IP "\fB\f(CB\*(C`ESC $ C\*(C'\fB\fR" 4
975 .IX Item "ESC $ C"
976 Designate Kanji Character Set
977 .Sp
978 Where \fB\f(CB\*(C`C\*(C'\fB\fR is one of:
979 .TS
980 l l .
981 C = 0 DEC Special Character and Line Drawing Set
982 C = A United Kingdom (UK)
983 C = B United States (USASCII)
984 C = < Multinational character set unimplemented
985 C = 5 Finnish character set unimplemented
986 C = C Finnish character set unimplemented
987 C = K German character set unimplemented
988 .TE
989
990 .PP
991
992 .IX Xref "CSI"
993 .SH "CSI (Command Sequence Introducer) Sequences"
994 .IX Header "CSI (Command Sequence Introducer) Sequences"
995 .ie n .IP "\fB\fB\*(C`ESC [ Ps @\*(C'\fB\fR" 4
996 .el .IP "\fB\f(CB\*(C`ESC [ Ps @\*(C'\fB\fR" 4
997 .IX Item "ESC [ Ps @"
998 Insert \fB\f(CB\*(C`Ps\*(C'\fB\fR (Blank) Character(s) [default: 1] (\s-1ICH\s0)
999 .IX Xref "ESCOBPsA"
1000 .ie n .IP "\fB\fB\*(C`ESC [ Ps A\*(C'\fB\fR" 4
1001 .el .IP "\fB\f(CB\*(C`ESC [ Ps A\*(C'\fB\fR" 4
1002 .IX Item "ESC [ Ps A"
1003 Cursor Up \fB\f(CB\*(C`Ps\*(C'\fB\fR Times [default: 1] (\s-1CUU\s0)
1004 .ie n .IP "\fB\fB\*(C`ESC [ Ps B\*(C'\fB\fR" 4
1005 .el .IP "\fB\f(CB\*(C`ESC [ Ps B\*(C'\fB\fR" 4
1006 .IX Item "ESC [ Ps B"
1007 Cursor Down \fB\f(CB\*(C`Ps\*(C'\fB\fR Times [default: 1] (\s-1CUD\s0)
1008 .IX Xref "ESCOBPsC"
1009 .ie n .IP "\fB\fB\*(C`ESC [ Ps C\*(C'\fB\fR" 4
1010 .el .IP "\fB\f(CB\*(C`ESC [ Ps C\*(C'\fB\fR" 4
1011 .IX Item "ESC [ Ps C"
1012 Cursor Forward \fB\f(CB\*(C`Ps\*(C'\fB\fR Times [default: 1] (\s-1CUF\s0)
1013 .ie n .IP "\fB\fB\*(C`ESC [ Ps D\*(C'\fB\fR" 4
1014 .el .IP "\fB\f(CB\*(C`ESC [ Ps D\*(C'\fB\fR" 4
1015 .IX Item "ESC [ Ps D"
1016 Cursor Backward \fB\f(CB\*(C`Ps\*(C'\fB\fR Times [default: 1] (\s-1CUB\s0)
1017 .ie n .IP "\fB\fB\*(C`ESC [ Ps E\*(C'\fB\fR" 4
1018 .el .IP "\fB\f(CB\*(C`ESC [ Ps E\*(C'\fB\fR" 4
1019 .IX Item "ESC [ Ps E"
1020 Cursor Down \fB\f(CB\*(C`Ps\*(C'\fB\fR Times [default: 1] and to first column
1021 .ie n .IP "\fB\fB\*(C`ESC [ Ps F\*(C'\fB\fR" 4
1022 .el .IP "\fB\f(CB\*(C`ESC [ Ps F\*(C'\fB\fR" 4
1023 .IX Item "ESC [ Ps F"
1024 Cursor Up \fB\f(CB\*(C`Ps\*(C'\fB\fR Times [default: 1] and to first column
1025 .IX Xref "ESCOBPsG"
1026 .ie n .IP "\fB\fB\*(C`ESC [ Ps G\*(C'\fB\fR" 4
1027 .el .IP "\fB\f(CB\*(C`ESC [ Ps G\*(C'\fB\fR" 4
1028 .IX Item "ESC [ Ps G"
1029 Cursor to Column \fB\f(CB\*(C`Ps\*(C'\fB\fR (\s-1HPA\s0)
1030 .ie n .IP "\fB\fB\*(C`ESC [ Ps;Ps H\*(C'\fB\fR" 4
1031 .el .IP "\fB\f(CB\*(C`ESC [ Ps;Ps H\*(C'\fB\fR" 4
1032 .IX Item "ESC [ Ps;Ps H"
1033 Cursor Position [row;column] [default: 1;1] (\s-1CUP\s0)
1034 .ie n .IP "\fB\fB\*(C`ESC [ Ps I\*(C'\fB\fR" 4
1035 .el .IP "\fB\f(CB\*(C`ESC [ Ps I\*(C'\fB\fR" 4
1036 .IX Item "ESC [ Ps I"
1037 Move forward \fB\f(CB\*(C`Ps\*(C'\fB\fR tab stops [default: 1]
1038 .ie n .IP "\fB\fB\*(C`ESC [ Ps J\*(C'\fB\fR" 4
1039 .el .IP "\fB\f(CB\*(C`ESC [ Ps J\*(C'\fB\fR" 4
1040 .IX Item "ESC [ Ps J"
1041 Erase in Display (\s-1ED\s0)
1042 .TS
1043 l l .
1044 Ps = 0 Clear Below (default)
1045 Ps = 1 Clear Above
1046 Ps = 2 Clear All
1047 .TE
1048
1049 .ie n .IP "\fB\fB\*(C`ESC [ Ps K\*(C'\fB\fR" 4
1050 .el .IP "\fB\f(CB\*(C`ESC [ Ps K\*(C'\fB\fR" 4
1051 .IX Item "ESC [ Ps K"
1052 Erase in Line (\s-1EL\s0)
1053 .TS
1054 l l .
1055 Ps = 0 Clear to Right (default)
1056 Ps = 1 Clear to Left
1057 Ps = 2 Clear All
1058 .TE
1059
1060 .ie n .IP "\fB\fB\*(C`ESC [ Ps L\*(C'\fB\fR" 4
1061 .el .IP "\fB\f(CB\*(C`ESC [ Ps L\*(C'\fB\fR" 4
1062 .IX Item "ESC [ Ps L"
1063 Insert \fB\f(CB\*(C`Ps\*(C'\fB\fR Line(s) [default: 1] (\s-1IL\s0)
1064 .ie n .IP "\fB\fB\*(C`ESC [ Ps M\*(C'\fB\fR" 4
1065 .el .IP "\fB\f(CB\*(C`ESC [ Ps M\*(C'\fB\fR" 4
1066 .IX Item "ESC [ Ps M"
1067 Delete \fB\f(CB\*(C`Ps\*(C'\fB\fR Line(s) [default: 1] (\s-1DL\s0)
1068 .ie n .IP "\fB\fB\*(C`ESC [ Ps P\*(C'\fB\fR" 4
1069 .el .IP "\fB\f(CB\*(C`ESC [ Ps P\*(C'\fB\fR" 4
1070 .IX Item "ESC [ Ps P"
1071 Delete \fB\f(CB\*(C`Ps\*(C'\fB\fR Character(s) [default: 1] (\s-1DCH\s0)
1072 .ie n .IP "\fB\fB\*(C`ESC [ Ps;Ps;Ps;Ps;Ps T\*(C'\fB\fR" 4
1073 .el .IP "\fB\f(CB\*(C`ESC [ Ps;Ps;Ps;Ps;Ps T\*(C'\fB\fR" 4
1074 .IX Item "ESC [ Ps;Ps;Ps;Ps;Ps T"
1075 Initiate . \fIunimplemented\fR Parameters are
1076 [func;startx;starty;firstrow;lastrow].
1077 .ie n .IP "\fB\fB\*(C`ESC [ Ps W\*(C'\fB\fR" 4
1078 .el .IP "\fB\f(CB\*(C`ESC [ Ps W\*(C'\fB\fR" 4
1079 .IX Item "ESC [ Ps W"
1080 Tabulator functions
1081 .TS
1082 l l .
1083 Ps = 0 Tab Set (HTS)
1084 Ps = 2 Tab Clear (TBC), Clear Current Column (default)
1085 Ps = 5 Tab Clear (TBC), Clear All
1086 .TE
1087
1088 .ie n .IP "\fB\fB\*(C`ESC [ Ps X\*(C'\fB\fR" 4
1089 .el .IP "\fB\f(CB\*(C`ESC [ Ps X\*(C'\fB\fR" 4
1090 .IX Item "ESC [ Ps X"
1091 Erase \fB\f(CB\*(C`Ps\*(C'\fB\fR Character(s) [default: 1] (\s-1ECH\s0)
1092 .ie n .IP "\fB\fB\*(C`ESC [ Ps Z\*(C'\fB\fR" 4
1093 .el .IP "\fB\f(CB\*(C`ESC [ Ps Z\*(C'\fB\fR" 4
1094 .IX Item "ESC [ Ps Z"
1095 Move backward \fB\f(CB\*(C`Ps\*(C'\fB\fR [default: 1] tab stops
1096 .ie n .IP "\fB\fB\*(C`ESC [ Ps '\*(C'\fB\fR" 4
1097 .el .IP "\fB\f(CB\*(C`ESC [ Ps '\*(C'\fB\fR" 4
1098 .IX Item "ESC [ Ps '"
1099 See \fB\f(CB\*(C`ESC [ Ps G\*(C'\fB\fR
1100 .ie n .IP "\fB\fB\*(C`ESC [ Ps a\*(C'\fB\fR" 4
1101 .el .IP "\fB\f(CB\*(C`ESC [ Ps a\*(C'\fB\fR" 4
1102 .IX Item "ESC [ Ps a"
1103 See \fB\f(CB\*(C`ESC [ Ps C\*(C'\fB\fR
1104 .ie n .IP "\fB\fB\*(C`ESC [ Ps c\*(C'\fB\fR" 4
1105 .el .IP "\fB\f(CB\*(C`ESC [ Ps c\*(C'\fB\fR" 4
1106 .IX Item "ESC [ Ps c"
1107 Send Device Attributes (\s-1DA\s0)
1108 \&\fB\f(CB\*(C`Ps = 0\*(C'\fB\fR (or omitted): request attributes from terminal
1109 returns: \fB\f(CB\*(C`ESC[?1;2c\*(C'\fB\fR (``I am a \s-1VT100\s0 with Advanced Video
1110 Option'')
1111 .ie n .IP "\fB\fB\*(C`ESC [ Ps d\*(C'\fB\fR" 4
1112 .el .IP "\fB\f(CB\*(C`ESC [ Ps d\*(C'\fB\fR" 4
1113 .IX Item "ESC [ Ps d"
1114 Cursor to Line \fB\f(CB\*(C`Ps\*(C'\fB\fR (\s-1VPA\s0)
1115 .ie n .IP "\fB\fB\*(C`ESC [ Ps e\*(C'\fB\fR" 4
1116 .el .IP "\fB\f(CB\*(C`ESC [ Ps e\*(C'\fB\fR" 4
1117 .IX Item "ESC [ Ps e"
1118 See \fB\f(CB\*(C`ESC [ Ps A\*(C'\fB\fR
1119 .ie n .IP "\fB\fB\*(C`ESC [ Ps;Ps f\*(C'\fB\fR" 4
1120 .el .IP "\fB\f(CB\*(C`ESC [ Ps;Ps f\*(C'\fB\fR" 4
1121 .IX Item "ESC [ Ps;Ps f"
1122 Horizontal and Vertical Position [row;column] (\s-1HVP\s0) [default: 1;1]
1123 .ie n .IP "\fB\fB\*(C`ESC [ Ps g\*(C'\fB\fR" 4
1124 .el .IP "\fB\f(CB\*(C`ESC [ Ps g\*(C'\fB\fR" 4
1125 .IX Item "ESC [ Ps g"
1126 Tab Clear (\s-1TBC\s0)
1127 .TS
1128 l l .
1129 Ps = 0 Clear Current Column (default)
1130 Ps = 3 Clear All (TBC)
1131 .TE
1132
1133 .ie n .IP "\fB\fB\*(C`ESC [ Pm h\*(C'\fB\fR" 4
1134 .el .IP "\fB\f(CB\*(C`ESC [ Pm h\*(C'\fB\fR" 4
1135 .IX Item "ESC [ Pm h"
1136 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.
1137 .ie n .IP "\fB\fB\*(C`ESC [ Ps i\*(C'\fB\fR" 4
1138 .el .IP "\fB\f(CB\*(C`ESC [ Ps i\*(C'\fB\fR" 4
1139 .IX Item "ESC [ Ps i"
1140 Printing. See also the \f(CW\*(C`print\-pipe\*(C'\fR resource.
1141 .TS
1142 l l .
1143 Ps = 0 print screen (MC0)
1144 Ps = 4 disable transparent print mode (MC4)
1145 Ps = 5 enable transparent print mode (MC5)
1146 .TE
1147
1148 .ie n .IP "\fB\fB\*(C`ESC [ Pm l\*(C'\fB\fR" 4
1149 .el .IP "\fB\f(CB\*(C`ESC [ Pm l\*(C'\fB\fR" 4
1150 .IX Item "ESC [ Pm l"
1151 Reset Mode (\s-1RM\s0)
1152 .RS 4
1153 .ie n .IP "\fB\fB\*(C`Ps = 4\*(C'\fB\fR" 4
1154 .el .IP "\fB\f(CB\*(C`Ps = 4\*(C'\fB\fR" 4
1155 .IX Item "Ps = 4"
1156 .TS
1157 l l .
1158 h Insert Mode (SMIR)
1159 l Replace Mode (RMIR)
1160 .TE
1161
1162 .PD 0
1163 .ie n .IP "\fB\fB\*(C`Ps = 20\*(C'\fB\fR (partially implemented)" 4
1164 .el .IP "\fB\f(CB\*(C`Ps = 20\*(C'\fB\fR (partially implemented)" 4
1165 .IX Item "Ps = 20 (partially implemented)"
1166 .TS
1167 l l .
1168 h Automatic Newline (LNM)
1169 l Normal Linefeed (LNM)
1170 .TE
1171
1172 .RE
1173 .RS 4
1174 .RE
1175 .ie n .IP "\fB\fB\*(C`ESC [ Pm m\*(C'\fB\fR" 4
1176 .el .IP "\fB\f(CB\*(C`ESC [ Pm m\*(C'\fB\fR" 4
1177 .IX Item "ESC [ Pm m"
1178 .PD
1179 Character Attributes (\s-1SGR\s0)
1180 .TS
1181 l l .
1182 Ps = 0 Normal (default)
1183 Ps = 1 / 21 On / Off Bold (bright fg)
1184 Ps = 3 / 23 On / Off Italic
1185 Ps = 4 / 24 On / Off Underline
1186 Ps = 5 / 25 On / Off Slow Blink (bright bg)
1187 Ps = 6 / 26 On / Off Rapid Blink (bright bg)
1188 Ps = 7 / 27 On / Off Inverse
1189 Ps = 8 / 27 On / Off Invisible (NYI)
1190 Ps = 30 / 40 fg/bg Black
1191 Ps = 31 / 41 fg/bg Red
1192 Ps = 32 / 42 fg/bg Green
1193 Ps = 33 / 43 fg/bg Yellow
1194 Ps = 34 / 44 fg/bg Blue
1195 Ps = 35 / 45 fg/bg Magenta
1196 Ps = 36 / 46 fg/bg Cyan
1197 Ps = 38;5 / 48;5 set fg/bg to color #m (ISO 8613-6)
1198 Ps = 37 / 47 fg/bg White
1199 Ps = 39 / 49 fg/bg Default
1200 Ps = 90 / 100 fg/bg Bright Black
1201 Ps = 91 / 101 fg/bg Bright Red
1202 Ps = 92 / 102 fg/bg Bright Green
1203 Ps = 93 / 103 fg/bg Bright Yellow
1204 Ps = 94 / 104 fg/bg Bright Blue
1205 Ps = 95 / 105 fg/bg Bright Magenta
1206 Ps = 96 / 106 fg/bg Bright Cyan
1207 Ps = 97 / 107 fg/bg Bright White
1208 Ps = 99 / 109 fg/bg Bright Default
1209 .TE
1210
1211 .ie n .IP "\fB\fB\*(C`ESC [ Ps n\*(C'\fB\fR" 4
1212 .el .IP "\fB\f(CB\*(C`ESC [ Ps n\*(C'\fB\fR" 4
1213 .IX Item "ESC [ Ps n"
1214 Device Status Report (\s-1DSR\s0)
1215 .TS
1216 l l .
1217 Ps = 5 Status Report ESC [ 0 n (``OK'')
1218 Ps = 6 Report Cursor Position (CPR) [row;column] as ESC [ r ; c R
1219 Ps = 7 Request Display Name
1220 Ps = 8 Request Version Number (place in window title)
1221 .TE
1222
1223 .ie n .IP "\fB\fB\*(C`ESC [ Ps;Ps r\*(C'\fB\fR" 4
1224 .el .IP "\fB\f(CB\*(C`ESC [ Ps;Ps r\*(C'\fB\fR" 4
1225 .IX Item "ESC [ Ps;Ps r"
1226 Set Scrolling Region [top;bottom]
1227 [default: full size of window] (\s-1CSR\s0)
1228 .ie n .IP "\fB\fB\*(C`ESC [ s\*(C'\fB\fR" 4
1229 .el .IP "\fB\f(CB\*(C`ESC [ s\*(C'\fB\fR" 4
1230 .IX Item "ESC [ s"
1231 Save Cursor (\s-1SC\s0)
1232 .ie n .IP "\fB\fB\*(C`ESC [ Ps x\*(C'\fB\fR" 4
1233 .el .IP "\fB\f(CB\*(C`ESC [ Ps x\*(C'\fB\fR" 4
1234 .IX Item "ESC [ Ps x"
1235 Request Terminal Parameters (\s-1DECREQTPARM\s0)
1236 .ie n .IP "\fB\fB\*(C`ESC [ u\*(C'\fB\fR" 4
1237 .el .IP "\fB\f(CB\*(C`ESC [ u\*(C'\fB\fR" 4
1238 .IX Item "ESC [ u"
1239 Restore Cursor
1240 .PP
1241
1242 .IX Xref "PrivateModes"
1243 .SH "DEC Private Modes"
1244 .IX Header "DEC Private Modes"
1245 .ie n .IP "\fB\fB\*(C`ESC [ ? Pm h\*(C'\fB\fR" 4
1246 .el .IP "\fB\f(CB\*(C`ESC [ ? Pm h\*(C'\fB\fR" 4
1247 .IX Item "ESC [ ? Pm h"
1248 \&\s-1DEC\s0 Private Mode Set (\s-1DECSET\s0)
1249 .ie n .IP "\fB\fB\*(C`ESC [ ? Pm l\*(C'\fB\fR" 4
1250 .el .IP "\fB\f(CB\*(C`ESC [ ? Pm l\*(C'\fB\fR" 4
1251 .IX Item "ESC [ ? Pm l"
1252 \&\s-1DEC\s0 Private Mode Reset (\s-1DECRST\s0)
1253 .ie n .IP "\fB\fB\*(C`ESC [ ? Pm r\*(C'\fB\fR" 4
1254 .el .IP "\fB\f(CB\*(C`ESC [ ? Pm r\*(C'\fB\fR" 4
1255 .IX Item "ESC [ ? Pm r"
1256 Restore previously saved \s-1DEC\s0 Private Mode Values.
1257 .ie n .IP "\fB\fB\*(C`ESC [ ? Pm s\*(C'\fB\fR" 4
1258 .el .IP "\fB\f(CB\*(C`ESC [ ? Pm s\*(C'\fB\fR" 4
1259 .IX Item "ESC [ ? Pm s"
1260 Save \s-1DEC\s0 Private Mode Values.
1261 .ie n .IP "\fB\fB\*(C`ESC [ ? Pm t\*(C'\fB\fR" 4
1262 .el .IP "\fB\f(CB\*(C`ESC [ ? Pm t\*(C'\fB\fR" 4
1263 .IX Item "ESC [ ? Pm t"
1264 Toggle \s-1DEC\s0 Private Mode Values (rxvt extension). \fIwhere\fR
1265 .RS 4
1266 .ie n .IP "\fB\fB\*(C`Ps = 1\*(C'\fB\fR (\s-1DECCKM\s0)" 4
1267 .el .IP "\fB\f(CB\*(C`Ps = 1\*(C'\fB\fR (\s-1DECCKM\s0)" 4
1268 .IX Item "Ps = 1 (DECCKM)"
1269 .TS
1270 l l .
1271 h Application Cursor Keys
1272 l Normal Cursor Keys
1273 .TE
1274
1275 .PD 0
1276 .ie n .IP "\fB\fB\*(C`Ps = 2\*(C'\fB\fR (\s-1ANSI/VT52\s0 mode)" 4
1277 .el .IP "\fB\f(CB\*(C`Ps = 2\*(C'\fB\fR (\s-1ANSI/VT52\s0 mode)" 4
1278 .IX Item "Ps = 2 (ANSI/VT52 mode)"
1279 .TS
1280 l l .
1281 h Enter VT52 mode
1282 l Enter VT52 mode
1283 .TE
1284
1285 .ie n .IP "\fB\fB\*(C`Ps = 3\*(C'\fB\fR" 4
1286 .el .IP "\fB\f(CB\*(C`Ps = 3\*(C'\fB\fR" 4
1287 .IX Item "Ps = 3"
1288 .TS
1289 l l .
1290 h 132 Column Mode (DECCOLM)
1291 l 80 Column Mode (DECCOLM)
1292 .TE
1293
1294 .ie n .IP "\fB\fB\*(C`Ps = 4\*(C'\fB\fR" 4
1295 .el .IP "\fB\f(CB\*(C`Ps = 4\*(C'\fB\fR" 4
1296 .IX Item "Ps = 4"
1297 .TS
1298 l l .
1299 h Smooth (Slow) Scroll (DECSCLM)
1300 l Jump (Fast) Scroll (DECSCLM)
1301 .TE
1302
1303 .ie n .IP "\fB\fB\*(C`Ps = 5\*(C'\fB\fR" 4
1304 .el .IP "\fB\f(CB\*(C`Ps = 5\*(C'\fB\fR" 4
1305 .IX Item "Ps = 5"
1306 .TS
1307 l l .
1308 h Reverse Video (DECSCNM)
1309 l Normal Video (DECSCNM)
1310 .TE
1311
1312 .ie n .IP "\fB\fB\*(C`Ps = 6\*(C'\fB\fR" 4
1313 .el .IP "\fB\f(CB\*(C`Ps = 6\*(C'\fB\fR" 4
1314 .IX Item "Ps = 6"
1315 .TS
1316 l l .
1317 h Origin Mode (DECOM)
1318 l Normal Cursor Mode (DECOM)
1319 .TE
1320
1321 .ie n .IP "\fB\fB\*(C`Ps = 7\*(C'\fB\fR" 4
1322 .el .IP "\fB\f(CB\*(C`Ps = 7\*(C'\fB\fR" 4
1323 .IX Item "Ps = 7"
1324 .TS
1325 l l .
1326 h Wraparound Mode (DECAWM)
1327 l No Wraparound Mode (DECAWM)
1328 .TE
1329
1330 .ie n .IP "\fB\fB\*(C`Ps = 8\*(C'\fB\fR \fIunimplemented\fR" 4
1331 .el .IP "\fB\f(CB\*(C`Ps = 8\*(C'\fB\fR \fIunimplemented\fR" 4
1332 .IX Item "Ps = 8 unimplemented"
1333 .TS
1334 l l .
1335 h Auto-repeat Keys (DECARM)
1336 l No Auto-repeat Keys (DECARM)
1337 .TE
1338
1339 .ie n .IP "\fB\fB\*(C`Ps = 9\*(C'\fB\fR X10 XTerm" 4
1340 .el .IP "\fB\f(CB\*(C`Ps = 9\*(C'\fB\fR X10 XTerm" 4
1341 .IX Item "Ps = 9 X10 XTerm"
1342 .TS
1343 l l .
1344 h Send Mouse X & Y on button press.
1345 l No mouse reporting.
1346 .TE
1347
1348 .ie n .IP "\fB\fB\*(C`Ps = 10\*(C'\fB\fR (\fBrxvt\fR)" 4
1349 .el .IP "\fB\f(CB\*(C`Ps = 10\*(C'\fB\fR (\fBrxvt\fR)" 4
1350 .IX Item "Ps = 10 (rxvt)"
1351 .TS
1352 l l .
1353 h menuBar visible
1354 l menuBar invisible
1355 .TE
1356
1357 .ie n .IP "\fB\fB\*(C`Ps = 25\*(C'\fB\fR" 4
1358 .el .IP "\fB\f(CB\*(C`Ps = 25\*(C'\fB\fR" 4
1359 .IX Item "Ps = 25"
1360 .TS
1361 l l .
1362 h Visible cursor {cnorm/cvvis}
1363 l Invisible cursor {civis}
1364 .TE
1365
1366 .ie n .IP "\fB\fB\*(C`Ps = 30\*(C'\fB\fR" 4
1367 .el .IP "\fB\f(CB\*(C`Ps = 30\*(C'\fB\fR" 4
1368 .IX Item "Ps = 30"
1369 .TS
1370 l l .
1371 h scrollBar visisble
1372 l scrollBar invisisble
1373 .TE
1374
1375 .ie n .IP "\fB\fB\*(C`Ps = 35\*(C'\fB\fR (\fBrxvt\fR)" 4
1376 .el .IP "\fB\f(CB\*(C`Ps = 35\*(C'\fB\fR (\fBrxvt\fR)" 4
1377 .IX Item "Ps = 35 (rxvt)"
1378 .TS
1379 l l .
1380 h Allow XTerm Shift+key sequences
1381 l Disallow XTerm Shift+key sequences
1382 .TE
1383
1384 .ie n .IP "\fB\fB\*(C`Ps = 38\*(C'\fB\fR \fIunimplemented\fR" 4
1385 .el .IP "\fB\f(CB\*(C`Ps = 38\*(C'\fB\fR \fIunimplemented\fR" 4
1386 .IX Item "Ps = 38 unimplemented"
1387 .PD
1388 Enter Tektronix Mode (\s-1DECTEK\s0)
1389 .ie n .IP "\fB\fB\*(C`Ps = 40\*(C'\fB\fR" 4
1390 .el .IP "\fB\f(CB\*(C`Ps = 40\*(C'\fB\fR" 4
1391 .IX Item "Ps = 40"
1392 .TS
1393 l l .
1394 h Allow 80/132 Mode
1395 l Disallow 80/132 Mode
1396 .TE
1397
1398 .PD 0
1399 .ie n .IP "\fB\fB\*(C`Ps = 44\*(C'\fB\fR \fIunimplemented\fR" 4
1400 .el .IP "\fB\f(CB\*(C`Ps = 44\*(C'\fB\fR \fIunimplemented\fR" 4
1401 .IX Item "Ps = 44 unimplemented"
1402 .TS
1403 l l .
1404 h Turn On Margin Bell
1405 l Turn Off Margin Bell
1406 .TE
1407
1408 .ie n .IP "\fB\fB\*(C`Ps = 45\*(C'\fB\fR \fIunimplemented\fR" 4
1409 .el .IP "\fB\f(CB\*(C`Ps = 45\*(C'\fB\fR \fIunimplemented\fR" 4
1410 .IX Item "Ps = 45 unimplemented"
1411 .TS
1412 l l .
1413 h Reverse-wraparound Mode
1414 l No Reverse-wraparound Mode
1415 .TE
1416
1417 .ie n .IP "\fB\fB\*(C`Ps = 46\*(C'\fB\fR \fIunimplemented\fR" 4
1418 .el .IP "\fB\f(CB\*(C`Ps = 46\*(C'\fB\fR \fIunimplemented\fR" 4
1419 .IX Item "Ps = 46 unimplemented"
1420 .ie n .IP "\fB\fB\*(C`Ps = 47\*(C'\fB\fR" 4
1421 .el .IP "\fB\f(CB\*(C`Ps = 47\*(C'\fB\fR" 4
1422 .IX Item "Ps = 47"
1423 .TS
1424 l l .
1425 h Use Alternate Screen Buffer
1426 l Use Normal Screen Buffer
1427 .TE
1428
1429 .PD
1430
1431 .IX Xref "Priv66"
1432 .ie n .IP "\fB\fB\*(C`Ps = 66\*(C'\fB\fR" 4
1433 .el .IP "\fB\f(CB\*(C`Ps = 66\*(C'\fB\fR" 4
1434 .IX Item "Ps = 66"
1435 .TS
1436 l l .
1437 h Application Keypad (DECPAM) == ESC =
1438 l Normal Keypad (DECPNM) == ESC >
1439 .TE
1440
1441 .PD 0
1442 .ie n .IP "\fB\fB\*(C`Ps = 67\*(C'\fB\fR" 4
1443 .el .IP "\fB\f(CB\*(C`Ps = 67\*(C'\fB\fR" 4
1444 .IX Item "Ps = 67"
1445 .TS
1446 l l .
1447 h Backspace key sends BS (DECBKM)
1448 l Backspace key sends DEL
1449 .TE
1450
1451 .ie n .IP "\fB\fB\*(C`Ps = 1000\*(C'\fB\fR (X11 XTerm)" 4
1452 .el .IP "\fB\f(CB\*(C`Ps = 1000\*(C'\fB\fR (X11 XTerm)" 4
1453 .IX Item "Ps = 1000 (X11 XTerm)"
1454 .TS
1455 l l .
1456 h Send Mouse X & Y on button press and release.
1457 l No mouse reporting.
1458 .TE
1459
1460 .ie n .IP "\fB\fB\*(C`Ps = 1001\*(C'\fB\fR (X11 XTerm) \fIunimplemented\fR" 4
1461 .el .IP "\fB\f(CB\*(C`Ps = 1001\*(C'\fB\fR (X11 XTerm) \fIunimplemented\fR" 4
1462 .IX Item "Ps = 1001 (X11 XTerm) unimplemented"
1463 .TS
1464 l l .
1465 h Use Hilite Mouse Tracking.
1466 l No mouse reporting.
1467 .TE
1468
1469 .ie n .IP "\fB\fB\*(C`Ps = 1010\*(C'\fB\fR (\fBrxvt\fR)" 4
1470 .el .IP "\fB\f(CB\*(C`Ps = 1010\*(C'\fB\fR (\fBrxvt\fR)" 4
1471 .IX Item "Ps = 1010 (rxvt)"
1472 .TS
1473 l l .
1474 h Don't scroll to bottom on TTY output
1475 l Scroll to bottom on TTY output
1476 .TE
1477
1478 .ie n .IP "\fB\fB\*(C`Ps = 1011\*(C'\fB\fR (\fBrxvt\fR)" 4
1479 .el .IP "\fB\f(CB\*(C`Ps = 1011\*(C'\fB\fR (\fBrxvt\fR)" 4
1480 .IX Item "Ps = 1011 (rxvt)"
1481 .TS
1482 l l .
1483 h Scroll to bottom when a key is pressed
1484 l Don't scroll to bottom when a key is pressed
1485 .TE
1486
1487 .ie n .IP "\fB\fB\*(C`Ps = 1047\*(C'\fB\fR" 4
1488 .el .IP "\fB\f(CB\*(C`Ps = 1047\*(C'\fB\fR" 4
1489 .IX Item "Ps = 1047"
1490 .TS
1491 l l .
1492 h Use Alternate Screen Buffer
1493 l Use Normal Screen Buffer - clear Alternate Screen Buffer if returning from it
1494 .TE
1495
1496 .ie n .IP "\fB\fB\*(C`Ps = 1048\*(C'\fB\fR" 4
1497 .el .IP "\fB\f(CB\*(C`Ps = 1048\*(C'\fB\fR" 4
1498 .IX Item "Ps = 1048"
1499 .TS
1500 l l .
1501 h Save cursor position
1502 l Restore cursor position
1503 .TE
1504
1505 .ie n .IP "\fB\fB\*(C`Ps = 1049\*(C'\fB\fR" 4
1506 .el .IP "\fB\f(CB\*(C`Ps = 1049\*(C'\fB\fR" 4
1507 .IX Item "Ps = 1049"
1508 .TS
1509 l l .
1510 h Use Alternate Screen Buffer - clear Alternate Screen Buffer if switching to it
1511 l Use Normal Screen Buffer
1512 .TE
1513
1514 .RE
1515 .RS 4
1516 .RE
1517 .PD
1518 .PP
1519
1520 .IX Xref "XTerm"
1521 .SH "XTerm Operating System Commands"
1522 .IX Header "XTerm Operating System Commands"
1523 .ie n .IP "\fB\fB\*(C`ESC ] Ps;Pt ST\*(C'\fB\fR" 4
1524 .el .IP "\fB\f(CB\*(C`ESC ] Ps;Pt ST\*(C'\fB\fR" 4
1525 .IX Item "ESC ] Ps;Pt ST"
1526 Set XTerm Parameters. 8\-bit \s-1ST:\s0 0x9c, 7\-bit \s-1ST\s0 sequence: \s-1ESC\s0 \e (0x1b,
1527 0x5c), backwards compatible terminator \s-1BEL\s0 (0x07) is also accepted. any
1528 \&\fBoctet\fR can be escaped by prefixing it with \s-1SYN\s0 (0x16, ^V).
1529 .TS
1530 l l .
1531 Ps = 0 Change Icon Name and Window Title to Pt
1532 Ps = 1 Change Icon Name to Pt
1533 Ps = 2 Change Window Title to Pt
1534 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.
1535 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
1536 Ps = 10 Change colour of text foreground to Pt (NB: may change in future)
1537 Ps = 11 Change colour of text background to Pt (NB: may change in future)
1538 Ps = 12 Change colour of text cursor foreground to Pt
1539 Ps = 13 Change colour of mouse foreground to Pt
1540 Ps = 17 Change colour of highlight characters to Pt
1541 Ps = 18 Change colour of bold characters to Pt
1542 Ps = 19 Change colour of underlined characters to Pt
1543 Ps = 20 Change default background to Pt
1544 Ps = 39 Change default foreground colour to Pt rxvt compile-time option
1545 Ps = 46 Change Log File to Pt unimplemented
1546 Ps = 49 Change default background colour to Pt rxvt compile-time option
1547 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
1548 Ps = 55 Log all scrollback buffer and all of screen to Pt
1549 Ps = 701 Change current locale to Pt, or, if Pt is ?, return the current locale (@@RXVT_NAME@@ extension)
1550 Ps = 703 Menubar command Pt rxvt compile-time option (rxvt-unicode extension)
1551 Ps = 704 Change colour of italic characters to Pt
1552 Ps = 705 Change background pixmap tint colour to Pt
1553 Ps = 710 Set normal fontset to Pt. Same as Ps = 50.
1554 Ps = 711 Set bold fontset to Pt. Similar to Ps = 50.
1555 Ps = 712 Set italic fontset to Pt. Similar to Ps = 50.
1556 Ps = 713 Set bold-italic fontset to Pt. Similar to Ps = 50.
1557 .TE
1558
1559 .PP
1560
1561 .IX Xref "menuBar"
1562 .SH "menuBar"
1563 .IX Header "menuBar"
1564 \&\fBThe exact syntax used is \f(BIalmost\fB solidified.\fR
1565 In the menus, \fB\s-1DON\s0'T\fR try to use menuBar commands that add or remove a
1566 menuBar.
1567 .PP
1568 Note that in all of the commands, the \fB\f(BI/path/\fB\fR \fIcannot\fR be
1569 omitted: use \fB./\fR to specify a menu relative to the current menu.
1570 .Sh "Overview of menuBar operation"
1571 .IX Subsection "Overview of menuBar operation"
1572 For the menuBar XTerm escape sequence \f(CW\*(C`ESC ] 703 ; Pt ST\*(C'\fR, the syntax
1573 of \f(CW\*(C`Pt\*(C'\fR can be used for a variety of tasks:
1574 .PP
1575 At the top level is the current menuBar which is a member of a circular
1576 linked-list of other such menuBars.
1577 .PP
1578 The menuBar acts as a parent for the various drop-down menus, which in
1579 turn, may have labels, separator lines, menuItems and subMenus.
1580 .PP
1581 The menuItems are the useful bits: you can use them to mimic keyboard
1582 input or even to send text or escape sequences back to rxvt.
1583 .PP
1584 The menuBar syntax is intended to provide a simple yet robust method of
1585 constructing and manipulating menus and navigating through the
1586 menuBars.
1587 .PP
1588 The first step is to use the tag \fB[menu:\f(BIname\fB]\fR which creates
1589 the menuBar called \fIname\fR and allows access. You may now or menus,
1590 subMenus, and menuItems. Finally, use the tag \fB[done]\fR to set the
1591 menuBar access as \fBreadonly\fR to prevent accidental corruption of the
1592 menus. To re-access the current menuBar for alterations, use the tag
1593 \&\fB[menu]\fR, make the alterations and then use \fB[done]\fR
1594 .PP
1595
1596 .IX Xref "menuBarCommands"
1597 .Sh "Commands"
1598 .IX Subsection "Commands"
1599 .IP "\fB[menu:+\f(BIname\fB]\fR" 4
1600 .IX Item "[menu:+name]"
1601 access the named menuBar for creation or alteration. If a new menuBar
1602 is created, it is called \fIname\fR (max of 15 chars) and the current
1603 menuBar is pushed onto the stack
1604 .IP "\fB[menu]\fR" 4
1605 .IX Item "[menu]"
1606 access the current menuBar for alteration
1607 .IP "\fB[title:+\f(BIstring\fB]\fR" 4
1608 .IX Item "[title:+string]"
1609 set the current menuBar's title to \fIstring\fR, which may contain the
1610 following format specifiers:
1611 \&\fB%%\fR : literal \fB%\fR character
1612 \&\fB%n\fR : rxvt name (as per the \fB\-name\fR command-line option)
1613 \&\fB%v\fR : rxvt version
1614 .IP "\fB[done]\fR" 4
1615 .IX Item "[done]"
1616 set menuBar access as \fBreadonly\fR.
1617 End-of-file tag for \fB[read:+\f(BIfile\fB]\fR operations.
1618 .IP "\fB[read:+\f(BIfile\fB]\fR" 4
1619 .IX Item "[read:+file]"
1620 read menu commands directly from \fIfile\fR (extension \*(L".menu\*(R" will be
1621 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.
1622 .Sp
1623 Blank and comment lines (starting with \fB#\fR) are ignored. Actually,
1624 since any invalid menu commands are also ignored, almost anything could
1625 be construed as a comment line, but this may be tightened up in the
1626 future ... so don't count on it!.
1627 .IP "\fB[read:+\f(BIfile\fB;+\f(BIname\fB]\fR" 4
1628 .IX Item "[read:+file;+name]"
1629 The same as \fB[read:+\f(BIfile\fB]\fR, but start reading at a line with
1630 \&\fB[menu:+\f(BIname\fB]\fR and continuing until \fB[done:+\f(BIname\fB]\fR or
1631 \&\fB[done]\fR is encountered.
1632 .IP "\fB[dump]\fR" 4
1633 .IX Item "[dump]"
1634 dump all menuBars to the file \fB/tmp/rxvt\-PID\fR in a format suitable for
1635 later rereading.
1636 .IP "\fB[rm:name]\fR" 4
1637 .IX Item "[rm:name]"
1638 remove the named menuBar
1639 .IP "\fB[rm] [rm:]\fR" 4
1640 .IX Item "[rm] [rm:]"
1641 remove the current menuBar
1642 .IP "\fB[rm*] [rm:*]\fR" 4
1643 .IX Item "[rm*] [rm:*]"
1644 remove all menuBars
1645 .IP "\fB[swap]\fR" 4
1646 .IX Item "[swap]"
1647 swap the top two menuBars
1648 .IP "\fB[prev]\fR" 4
1649 .IX Item "[prev]"
1650 access the previous menuBar
1651 .IP "\fB[next]\fR" 4
1652 .IX Item "[next]"
1653 access the next menuBar
1654 .IP "\fB[show]\fR" 4
1655 .IX Item "[show]"
1656 Enable display of the menuBar
1657 .IP "\fB[hide]\fR" 4
1658 .IX Item "[hide]"
1659 Disable display of the menuBar
1660 .IP "\fB[pixmap:+\f(BIname\fB]\fR" 4
1661 .IX Item "[pixmap:+name]"
1662 .PD 0
1663 .IP "\fB[pixmap:+\f(BIname\fB;\f(BIscaling\fB]\fR" 4
1664 .IX Item "[pixmap:+name;scaling]"
1665 .PD
1666 (set the background pixmap globally
1667 .Sp
1668 \&\fBA Future implementation \f(BImay\fB make this local to the menubar\fR)
1669 .IP "\fB[:+\f(BIcommand\fB:]\fR" 4
1670 .IX Item "[:+command:]"
1671 ignore the menu readonly status and issue a \fIcommand\fR to or a menu or
1672 menuitem or change the ; a useful shortcut for setting the quick arrows
1673 from a menuBar.
1674 .PP
1675
1676 .IX Xref "menuBarAdd"
1677 .Sh "Adding and accessing menus"
1678 .IX Subsection "Adding and accessing menus"
1679 The following commands may also be \fB+\fR prefixed.
1680 .IP "\fB/+\fR" 4
1681 .IX Item "/+"
1682 access menuBar top level
1683 .IP "\fB./+\fR" 4
1684 .IX Item "./+"
1685 access current menu level
1686 .IP "\fB../+\fR" 4
1687 .IX Item "../+"
1688 access parent menu (1 level up)
1689 .IP "\fB../../\fR" 4
1690 .IX Item "../../"
1691 access parent menu (multiple levels up)
1692 .IP "\fB\f(BI/path/\fBmenu\fR" 4
1693 .IX Item "/path/menu"
1694 add/access menu
1695 .IP "\fB\f(BI/path/\fBmenu/*\fR" 4
1696 .IX Item "/path/menu/*"
1697 add/access menu and clear it if it exists
1698 .IP "\fB\f(BI/path/\fB{\-}\fR" 4
1699 .IX Item "/path/{-}"
1700 add separator
1701 .IP "\fB\f(BI/path/\fB{item}\fR" 4
1702 .IX Item "/path/{item}"
1703 add \fBitem\fR as a label
1704 .IP "\fB\f(BI/path/\fB{item} action\fR" 4
1705 .IX Item "/path/{item} action"
1706 add/alter \fImenuitem\fR with an associated \fIaction\fR
1707 .IP "\fB\f(BI/path/\fB{item}{right\-text}\fR" 4
1708 .IX Item "/path/{item}{right-text}"
1709 add/alter \fImenuitem\fR with \fBright-text\fR as the right-justified text
1710 and as the associated \fIaction\fR
1711 .IP "\fB\f(BI/path/\fB{item}{rtext} action\fR" 4
1712 .IX Item "/path/{item}{rtext} action"
1713 add/alter \fImenuitem\fR with an associated \fIaction\fR and with \fBrtext\fR as
1714 the right-justified text.
1715 .IP "Special characters in \fIaction\fR must be backslash\-escaped:" 4
1716 .IX Item "Special characters in action must be backslash-escaped:"
1717 \&\fB\ea \eb \eE \ee \en \er \et \eoctal\fR
1718 .IP "or in control-character notation:" 4
1719 .IX Item "or in control-character notation:"
1720 \&\fB^@, ^A .. ^Z .. ^_, ^?\fR
1721 .PP
1722 To send a string starting with a \fB\s-1NUL\s0\fR (\fB^@\fR) character to the
1723 program, start \fIaction\fR with a pair of \fB\s-1NUL\s0\fR characters (\fB^@^@\fR),
1724 the first of which will be stripped off and the balance directed to the
1725 program. Otherwise if \fIaction\fR begins with \fB\s-1NUL\s0\fR followed by
1726 non\-+\fB\s-1NUL\s0\fR characters, the leading \fB\s-1NUL\s0\fR is stripped off and the
1727 balance is sent back to rxvt.
1728 .PP
1729 As a convenience for the many Emacs-type editors, \fIaction\fR may start
1730 with \fBM\-\fR (eg, \fBM\-$\fR is equivalent to \fB\eE$\fR) and a \fB\s-1CR\s0\fR will be
1731 appended if missed from \fBM\-x\fR commands.
1732 .PP
1733 As a convenience for issuing XTerm \fB\s-1ESC\s0]\fR sequences from a menubar (or
1734 quick arrow), a \fB\s-1BEL\s0\fR (\fB^G\fR) will be appended if needed.
1735 .IP "For example," 4
1736 .IX Item "For example,"
1737 \&\fBM\-xapropos\fR is equivalent to \fB\eExapropos\er\fR
1738 .IP "and" 4
1739 .IX Item "and"
1740 \&\fB\eE]703;mona;100\fR is equivalent to \fB\eE]703;mona;100\ea\fR
1741 .PP
1742 The option \fB{\f(BIright-rtext\fB}\fR will be right\-justified. In the
1743 absence of a specified action, this text will be used as the \fIaction\fR
1744 as well.
1745 .IP "For example," 4
1746 .IX Item "For example,"
1747 \&\fB/File/{Open}{^X^F}\fR is equivalent to \fB/File/{Open}{^X^F} ^X^F\fR
1748 .PP
1749 The left label \fIis\fR necessary, since it's used for matching, but
1750 implicitly hiding the left label (by using same name for both left and
1751 right labels), or explicitly hiding the left label (by preceeding it
1752 with a dot), makes it possible to have right-justified text only.
1753 .IP "For example," 4
1754 .IX Item "For example,"
1755 \&\fB/File/{Open}{Open} Open-File-Action\fR
1756 .IP "or hiding it" 4
1757 .IX Item "or hiding it"
1758 \&\fB/File/{.anylabel}{Open} Open-File-Action\fR
1759 .PP
1760
1761 .IX Xref "menuBarRemove"
1762 .Sh "Removing menus"
1763 .IX Subsection "Removing menus"
1764 .IP "\fB\-/*+\fR" 4
1765 .IX Item "-/*+"
1766 remove all menus from the menuBar, the same as \fB[clear]\fR
1767 .IP "\fB\-+\f(BI/path\fBmenu+\fR" 4
1768 .IX Item "-+/pathmenu+"
1769 remove menu
1770 .IP "\fB\-+\f(BI/path\fB{item}+\fR" 4
1771 .IX Item "-+/path{item}+"
1772 remove item
1773 .IP "\fB\-+\f(BI/path\fB{\-}\fR" 4
1774 .IX Item "-+/path{-}"
1775 remove separator)
1776 .IP "\fB\-/path/menu/*\fR" 4
1777 .IX Item "-/path/menu/*"
1778 remove all items, separators and submenus from menu
1779 .PP
1780
1781 .IX Xref "menuBarArrows"
1782 .Sh "Quick Arrows"
1783 .IX Subsection "Quick Arrows"
1784 The menus also provide a hook for \fIquick arrows\fR to provide easier
1785 user access. If nothing has been explicitly set, the default is to
1786 emulate the curror keys. The syntax permits each arrow to be altered
1787 individually or all four at once without re-entering their common
1788 beginning/end text. For example, to explicitly associate cursor actions
1789 with the arrows, any of the following forms could be used:
1790 .IP "\fB<r>+\f(BIRight\fB\fR" 4
1791 .IX Item "<r>+Right"
1792 .PD 0
1793 .IP "\fB<l>+\f(BILeft\fB\fR" 4
1794 .IX Item "<l>+Left"
1795 .IP "\fB<u>+\f(BIUp\fB\fR" 4
1796 .IX Item "<u>+Up"
1797 .IP "\fB<d>+\f(BIDown\fB\fR" 4
1798 .IX Item "<d>+Down"
1799 .PD
1800 Define actions for the respective arrow buttons
1801 .IP "\fB<b>+\f(BIBegin\fB\fR" 4
1802 .IX Item "<b>+Begin"
1803 .PD 0
1804 .IP "\fB<e>+\f(BIEnd\fB\fR" 4
1805 .IX Item "<e>+End"
1806 .PD
1807 Define common beginning/end parts for \fIquick arrows\fR which used in
1808 conjunction with the above <r> <l> <u> <d> constructs
1809 .IP "For example, define arrows individually," 4
1810 .IX Item "For example, define arrows individually,"
1811 .Vb 1
1812 \& <u>\eE[A
1813 .Ve
1814 .Sp
1815 .Vb 1
1816 \& <d>\eE[B
1817 .Ve
1818 .Sp
1819 .Vb 1
1820 \& <r>\eE[C
1821 .Ve
1822 .Sp
1823 .Vb 1
1824 \& <l>\eE[D
1825 .Ve
1826 .IP "or all at once" 4
1827 .IX Item "or all at once"
1828 .Vb 1
1829 \& <u>\eE[AZ<><d>\eE[BZ<><r>\eE[CZ<><l>\eE[D
1830 .Ve
1831 .IP "or more compactly (factoring out common parts)" 4
1832 .IX Item "or more compactly (factoring out common parts)"
1833 .Vb 1
1834 \& <b>\eE[<u>AZ<><d>BZ<><r>CZ<><l>D
1835 .Ve
1836 .PP
1837
1838 .IX Xref "menuBarSummary"
1839 .Sh "Command Summary"
1840 .IX Subsection "Command Summary"
1841 A short summary of the most \fIcommon\fR commands:
1842 .IP "[menu:name]" 4
1843 .IX Item "[menu:name]"
1844 use an existing named menuBar or start a new one
1845 .IP "[menu]" 4
1846 .IX Item "[menu]"
1847 use the current menuBar
1848 .IP "[title:string]" 4
1849 .IX Item "[title:string]"
1850 set menuBar title
1851 .IP "[done]" 4
1852 .IX Item "[done]"
1853 set menu access to readonly and, if reading from a file, signal \s-1EOF\s0
1854 .IP "[done:name]" 4
1855 .IX Item "[done:name]"
1856 if reading from a file using [read:file;name] signal \s-1EOF\s0
1857 .IP "[rm:name]" 4
1858 .IX Item "[rm:name]"
1859 remove named menuBar(s)
1860 .IP "[rm] [rm:]" 4
1861 .IX Item "[rm] [rm:]"
1862 remove current menuBar
1863 .IP "[rm*] [rm:*]" 4
1864 .IX Item "[rm*] [rm:*]"
1865 remove all menuBar(s)
1866 .IP "[swap]" 4
1867 .IX Item "[swap]"
1868 swap top two menuBars
1869 .IP "[prev]" 4
1870 .IX Item "[prev]"
1871 access the previous menuBar
1872 .IP "[next]" 4
1873 .IX Item "[next]"
1874 access the next menuBar
1875 .IP "[show]" 4
1876 .IX Item "[show]"
1877 map menuBar
1878 .IP "[hide]" 4
1879 .IX Item "[hide]"
1880 unmap menuBar
1881 .IP "[pixmap;file]" 4
1882 .IX Item "[pixmap;file]"
1883 .PD 0
1884 .IP "[pixmap;file;scaling]" 4
1885 .IX Item "[pixmap;file;scaling]"
1886 .PD
1887 set a background pixmap
1888 .IP "[read:file]" 4
1889 .IX Item "[read:file]"
1890 .PD 0
1891 .IP "[read:file;name]" 4
1892 .IX Item "[read:file;name]"
1893 .PD
1894 read in a menu from a file
1895 .IP "[dump]" 4
1896 .IX Item "[dump]"
1897 dump out all menuBars to /tmp/rxvt\-PID
1898 .IP "/" 4
1899 access menuBar top level
1900 .IP "./" 4
1901 .PD 0
1902 .IP "../" 4
1903 .IP "../../" 4
1904 .PD
1905 access current or parent menu level
1906 .IP "/path/menu" 4
1907 .IX Item "/path/menu"
1908 add/access menu
1909 .IP "/path/{\-}" 4
1910 .IX Item "/path/{-}"
1911 add separator
1912 .IP "/path/{item}{rtext} action" 4
1913 .IX Item "/path/{item}{rtext} action"
1914 add/alter menu item
1915 .IP "\-/*" 4
1916 remove all menus from the menuBar
1917 .IP "\-/path/menu" 4
1918 .IX Item "-/path/menu"
1919 remove menu items, separators and submenus from menu
1920 .IP "\-/path/menu" 4
1921 .IX Item "-/path/menu"
1922 remove menu
1923 .IP "\-/path/{item}" 4
1924 .IX Item "-/path/{item}"
1925 remove item
1926 .IP "\-/path/{\-}" 4
1927 .IX Item "-/path/{-}"
1928 remove separator
1929 .IP "<b>Begin<r>Right<l>Left<u>Up<d>Down<e>End" 4
1930 .IX Item "<b>Begin<r>Right<l>Left<u>Up<d>Down<e>End"
1931 menu quick arrows
1932 .SH "XPM"
1933 .IX Header "XPM"
1934 For the \s-1XPM\s0 XTerm escape sequence \fB\f(CB\*(C`ESC ] 20 ; Pt ST\*(C'\fB\fR then value
1935 of \fB\f(CB\*(C`Pt\*(C'\fB\fR can be the name of the background pixmap followed by a
1936 sequence of scaling/positioning commands separated by semi\-colons. The
1937 scaling/positioning commands are as follows:
1938 .IP "query scale/position" 4
1939 .IX Item "query scale/position"
1940 \&\fB?\fR
1941 .IP "change scale and position" 4
1942 .IX Item "change scale and position"
1943 \&\fBWxH+X+Y\fR
1944 .Sp
1945 \&\fBWxH+X\fR (== \fBWxH+X+X\fR)
1946 .Sp
1947 \&\fBWxH\fR (same as \fBWxH+50+50\fR)
1948 .Sp
1949 \&\fBW+X+Y\fR (same as \fBWxW+X+Y\fR)
1950 .Sp
1951 \&\fBW+X\fR (same as \fBWxW+X+X\fR)
1952 .Sp
1953 \&\fBW\fR (same as \fBWxW+50+50\fR)
1954 .IP "change position (absolute)" 4
1955 .IX Item "change position (absolute)"
1956 \&\fB=+X+Y\fR
1957 .Sp
1958 \&\fB=+X\fR (same as \fB=+X+Y\fR)
1959 .IP "change position (relative)" 4
1960 .IX Item "change position (relative)"
1961 \&\fB+X+Y\fR
1962 .Sp
1963 \&\fB+X\fR (same as \fB+X+Y\fR)
1964 .IP "rescale (relative)" 4
1965 .IX Item "rescale (relative)"
1966 \&\fBWx0\fR \-> \fBW *= (W/100)\fR
1967 .Sp
1968 \&\fB0xH\fR \-> \fBH *= (H/100)\fR
1969 .PP
1970 For example:
1971 .IP "\fB\eE]20;funky\ea\fR" 4
1972 .IX Item "E]20;funkya"
1973 load \fBfunky.xpm\fR as a tiled image
1974 .IP "\fB\eE]20;mona;100\ea\fR" 4
1975 .IX Item "E]20;mona;100a"
1976 load \fBmona.xpm\fR with a scaling of 100%
1977 .IP "\fB\eE]20;;200;?\ea\fR" 4
1978 .IX Item "E]20;;200;?a"
1979 rescale the current pixmap to 200% and display the image geometry in
1980 the title
1981 .SH "Mouse Reporting"
1982 .IX Header "Mouse Reporting"
1983 .ie n .IP "\fB\fB\*(C`ESC [ M <b> <x> <y>\*(C'\fB\fR" 4
1984 .el .IP "\fB\f(CB\*(C`ESC [ M <b> <x> <y>\*(C'\fB\fR" 4
1985 .IX Item "ESC [ M <b> <x> <y>"
1986 report mouse position
1987 .PP
1988 The lower 2 bits of \fB\f(CB\*(C`<b>\*(C'\fB\fR indicate the button:
1989 .ie n .IP "Button = \fB\fB\*(C`(<b> \- SPACE) & 3\*(C'\fB\fR" 4
1990 .el .IP "Button = \fB\f(CB\*(C`(<b> \- SPACE) & 3\*(C'\fB\fR" 4
1991 .IX Item "Button = (<b> - SPACE) & 3"
1992 .TS
1993 l l .
1994 0 Button1 pressed
1995 1 Button2 pressed
1996 2 Button3 pressed
1997 3 button released (X11 mouse report)
1998 .TE
1999
2000 .PP
2001 The upper bits of \fB\f(CB\*(C`<b>\*(C'\fB\fR indicate the modifiers when the
2002 button was pressed and are added together (X11 mouse report only):
2003 .ie n .IP "State = \fB\fB\*(C`(<b> \- SPACE) & 60\*(C'\fB\fR" 4
2004 .el .IP "State = \fB\f(CB\*(C`(<b> \- SPACE) & 60\*(C'\fB\fR" 4
2005 .IX Item "State = (<b> - SPACE) & 60"
2006 .TS
2007 l l .
2008 4 Shift
2009 8 Meta
2010 16 Control
2011 32 Double Click (Rxvt extension)
2012 .TE
2013
2014 Col = \fB\f(CB\*(C`<x> \- SPACE\*(C'\fB\fR
2015 .Sp
2016 Row = \fB\f(CB\*(C`<y> \- SPACE\*(C'\fB\fR
2017 .SH "Key Codes"
2018 .IX Header "Key Codes"
2019 Note: \fBShift\fR + \fBF1\fR\-\fBF10\fR generates \fBF11\fR\-\fBF20\fR
2020 .PP
2021 For the keypad, use \fBShift\fR to temporarily override Application-Keypad
2022 setting use \fBNum_Lock\fR to toggle Application-Keypad setting if
2023 \&\fBNum_Lock\fR is off, toggle Application-Keypad setting. Also note that
2024 values of \fBHome\fR, \fBEnd\fR, \fBDelete\fR may have been compiled differently on
2025 your system.
2026 .TS
2027 l l l l l .
2028 Normal Shift Control Ctrl+Shift
2029 Tab ^I ESC [ Z ^I ESC [ Z
2030 BackSpace ^H ^? ^? ^?
2031 Find ESC [ 1 ~ ESC [ 1 $ ESC [ 1 ^ ESC [ 1 @
2032 Insert ESC [ 2 ~ paste ESC [ 2 ^ ESC [ 2 @
2033 Execute ESC [ 3 ~ ESC [ 3 $ ESC [ 3 ^ ESC [ 3 @
2034 Select ESC [ 4 ~ ESC [ 4 $ ESC [ 4 ^ ESC [ 4 @
2035 Prior ESC [ 5 ~ scroll-up ESC [ 5 ^ ESC [ 5 @
2036 Next ESC [ 6 ~ scroll-down ESC [ 6 ^ ESC [ 6 @
2037 Home ESC [ 7 ~ ESC [ 7 $ ESC [ 7 ^ ESC [ 7 @
2038 End ESC [ 8 ~ ESC [ 8 $ ESC [ 8 ^ ESC [ 8 @
2039 Delete ESC [ 3 ~ ESC [ 3 $ ESC [ 3 ^ ESC [ 3 @
2040 F1 ESC [ 11 ~ ESC [ 23 ~ ESC [ 11 ^ ESC [ 23 ^
2041 F2 ESC [ 12 ~ ESC [ 24 ~ ESC [ 12 ^ ESC [ 24 ^
2042 F3 ESC [ 13 ~ ESC [ 25 ~ ESC [ 13 ^ ESC [ 25 ^
2043 F4 ESC [ 14 ~ ESC [ 26 ~ ESC [ 14 ^ ESC [ 26 ^
2044 F5 ESC [ 15 ~ ESC [ 28 ~ ESC [ 15 ^ ESC [ 28 ^
2045 F6 ESC [ 17 ~ ESC [ 29 ~ ESC [ 17 ^ ESC [ 29 ^
2046 F7 ESC [ 18 ~ ESC [ 31 ~ ESC [ 18 ^ ESC [ 31 ^
2047 F8 ESC [ 19 ~ ESC [ 32 ~ ESC [ 19 ^ ESC [ 32 ^
2048 F9 ESC [ 20 ~ ESC [ 33 ~ ESC [ 20 ^ ESC [ 33 ^
2049 F10 ESC [ 21 ~ ESC [ 34 ~ ESC [ 21 ^ ESC [ 34 ^
2050 F11 ESC [ 23 ~ ESC [ 23 $ ESC [ 23 ^ ESC [ 23 @
2051 F12 ESC [ 24 ~ ESC [ 24 $ ESC [ 24 ^ ESC [ 24 @
2052 F13 ESC [ 25 ~ ESC [ 25 $ ESC [ 25 ^ ESC [ 25 @
2053 F14 ESC [ 26 ~ ESC [ 26 $ ESC [ 26 ^ ESC [ 26 @
2054 F15 (Help) ESC [ 28 ~ ESC [ 28 $ ESC [ 28 ^ ESC [ 28 @
2055 F16 (Menu) ESC [ 29 ~ ESC [ 29 $ ESC [ 29 ^ ESC [ 29 @
2056 F17 ESC [ 31 ~ ESC [ 31 $ ESC [ 31 ^ ESC [ 31 @
2057 F18 ESC [ 32 ~ ESC [ 32 $ ESC [ 32 ^ ESC [ 32 @
2058 F19 ESC [ 33 ~ ESC [ 33 $ ESC [ 33 ^ ESC [ 33 @
2059 F20 ESC [ 34 ~ ESC [ 34 $ ESC [ 34 ^ ESC [ 34 @
2060 Application
2061 Up ESC [ A ESC [ a ESC O a ESC O A
2062 Down ESC [ B ESC [ b ESC O b ESC O B
2063 Right ESC [ C ESC [ c ESC O c ESC O C
2064 Left ESC [ D ESC [ d ESC O d ESC O D
2065 KP_Enter ^M ESC O M
2066 KP_F1 ESC O P ESC O P
2067 KP_F2 ESC O Q ESC O Q
2068 KP_F3 ESC O R ESC O R
2069 KP_F4 ESC O S ESC O S
2070 XK_KP_Multiply * ESC O j
2071 XK_KP_Add + ESC O k
2072 XK_KP_Separator , ESC O l
2073 XK_KP_Subtract - ESC O m
2074 XK_KP_Decimal . ESC O n
2075 XK_KP_Divide / ESC O o
2076 XK_KP_0 0 ESC O p
2077 XK_KP_1 1 ESC O q
2078 XK_KP_2 2 ESC O r
2079 XK_KP_3 3 ESC O s
2080 XK_KP_4 4 ESC O t
2081 XK_KP_5 5 ESC O u
2082 XK_KP_6 6 ESC O v
2083 XK_KP_7 7 ESC O w
2084 XK_KP_8 8 ESC O x
2085 XK_KP_9 9 ESC O y
2086 .TE
2087
2088 .SH "CONFIGURE OPTIONS"
2089 .IX Header "CONFIGURE OPTIONS"
2090 General hint: if you get compile errors, then likely your configuration
2091 hasn't been tested well. Either try with \-\-enable\-everything or use the
2092 \&./reconf script as a base for experiments. ./reconf is used by myself,
2093 so it should generally be a working config. Of course, you should always
2094 report when a combination doesn't work, so it can be fixed. Marc Lehmann
2095 <rxvt@schmorp.de>.
2096 .IP "\-\-enable\-everything" 4
2097 .IX Item "--enable-everything"
2098 Add support for all non-multichoice options listed in \*(L"./configure
2099 \&\-\-help\*(R". Note that unlike other enable options this is order dependant.
2100 You can specify this and then disable options which this enables by
2101 \&\fIfollowing\fR this with the appropriate commands.
2102 .IP "\-\-enable\-xft" 4
2103 .IX Item "--enable-xft"
2104 Add support for Xft (anti\-aliases, among others) fonts. Xft fonts are
2105 slower and require lots of memory, but as long as you don't use them, you
2106 don't pay for them.
2107 .IP "\-\-enable\-font\-styles" 4
2108 .IX Item "--enable-font-styles"
2109 Add support for \fBbold\fR, \fIitalic\fR and \fB\f(BIbold italic\fB\fR font
2110 styles. The fonts can be set manually or automatically.
2111 .IP "\-\-with\-codesets=NAME,..." 4
2112 .IX Item "--with-codesets=NAME,..."
2113 Compile in support for additional codeset (encoding) groups (eu, vn are
2114 always compiled in, which includes most 8\-bit character sets). These
2115 codeset tables are currently only used for driving X11 core fonts, they
2116 are not required for Xft fonts. Compiling them in will make your binary
2117 bigger (together about 700kB), but it doesn't increase memory usage unless
2118 you use an X11 font requiring one of these encodings.
2119 .TS
2120 l l .
2121 all all available codeset groups
2122 zh common chinese encodings
2123 zh_ext rarely used but very big chinese encodigs
2124 jp common japanese encodings
2125 jp_ext rarely used but big japanese encodings
2126 kr korean encodings
2127 .TE
2128
2129 .IP "\-\-enable\-xim" 4
2130 .IX Item "--enable-xim"
2131 Add support for \s-1XIM\s0 (X Input Method) protocol. This allows using
2132 alternative input methods (e.g. kinput2) and will also correctly
2133 set up the input for people using dead keys or compose keys.
2134 .IP "\-\-enable\-unicode3" 4
2135 .IX Item "--enable-unicode3"
2136 Enable direct support for displaying unicode codepoints above
2137 65535 (the basic multilingual page). This increases storage
2138 requirements per character from 2 to 4 bytes. X11 fonts do not yet
2139 support these extra characters, but Xft does.
2140 .Sp
2141 Please note that rxvt-unicode can store unicode code points >65535
2142 even without this flag, but the number of such characters is
2143 limited to a view thousand (shared with combining characters,
2144 see next switch), and right now rxvt-unicode cannot display them
2145 (input/output and cut&paste still work, though).
2146 .IP "\-\-enable\-combining" 4
2147 .IX Item "--enable-combining"
2148 Enable automatic composition of combining characters into
2149 composite characters. This is required for proper viewing of text
2150 where accents are encoded as seperate unicode characters. This is
2151 done by using precomposited characters when available or creating
2152 new pseudo-characters when no precomposed form exists.
2153 .Sp
2154 Without \-\-enable\-unicode3, the number of additional precomposed
2155 characters is rather limited (2048, if this is full, rxvt will use the
2156 private use area, extending the number of combinations to 8448). With
2157 \&\-\-enable\-unicode3, no practical limit exists. This will also enable
2158 storage of characters >65535.
2159 .Sp
2160 The combining table also contains entries for arabic presentation forms,
2161 but these are not currently used. Bug me if you want these to be used.
2162 .IP "\-\-enable\-fallback(=CLASS)" 4
2163 .IX Item "--enable-fallback(=CLASS)"
2164 When reading resource settings, also read settings for class \s-1CLASS\s0
2165 (default: Rxvt). To disable resource fallback use \-\-disable\-fallback.
2166 .IP "\-\-with\-res\-name=NAME" 4
2167 .IX Item "--with-res-name=NAME"
2168 Use the given name (default: urxvt) as default application name when
2169 reading resources. Specify \-\-with\-res\-name=rxvt to replace rxvt.
2170 .IP "\-\-with\-res\-class=CLASS" 4
2171 .IX Item "--with-res-class=CLASS"
2172 Use the given class (default: URxvt) as default application class
2173 when reading resources. Specify \-\-with\-res\-class=Rxvt to replace
2174 rxvt.
2175 .IP "\-\-enable\-utmp" 4
2176 .IX Item "--enable-utmp"
2177 Write user and tty to utmp file (used by programs like \fIw\fR) at
2178 start of rxvt execution and delete information when rxvt exits.
2179 .IP "\-\-enable\-wtmp" 4
2180 .IX Item "--enable-wtmp"
2181 Write user and tty to wtmp file (used by programs like \fIlast\fR) at
2182 start of rxvt execution and write logout when rxvt exits. This
2183 option requires \-\-enable\-utmp to also be specified.
2184 .IP "\-\-enable\-lastlog" 4
2185 .IX Item "--enable-lastlog"
2186 Write user and tty to lastlog file (used by programs like
2187 \&\fIlastlogin\fR) at start of rxvt execution. This option requires
2188 \&\-\-enable\-utmp to also be specified.
2189 .IP "\-\-enable\-xpm\-background" 4
2190 .IX Item "--enable-xpm-background"
2191 Add support for \s-1XPM\s0 background pixmaps.
2192 .IP "\-\-enable\-transparency" 4
2193 .IX Item "--enable-transparency"
2194 Add support for inheriting parent backgrounds thus giving a fake
2195 transparency to the term.
2196 .IP "\-\-enable\-fading" 4
2197 .IX Item "--enable-fading"
2198 Add support for fading the text when focus is lost.
2199 .IP "\-\-enable\-tinting" 4
2200 .IX Item "--enable-tinting"
2201 Add support for tinting of transparent backgrounds.
2202 .IP "\-\-enable\-menubar" 4
2203 .IX Item "--enable-menubar"
2204 Add support for our menu bar system (this interacts badly with
2205 dynamic locale switching currently).
2206 .IP "\-\-enable\-rxvt\-scroll" 4
2207 .IX Item "--enable-rxvt-scroll"
2208 Add support for the original rxvt scrollbar.
2209 .IP "\-\-enable\-next\-scroll" 4
2210 .IX Item "--enable-next-scroll"
2211 Add support for a NeXT-like scrollbar.
2212 .IP "\-\-enable\-xterm\-scroll" 4
2213 .IX Item "--enable-xterm-scroll"
2214 Add support for an Xterm-like scrollbar.
2215 .IP "\-\-enable\-plain\-scroll" 4
2216 .IX Item "--enable-plain-scroll"
2217 Add support for a very unobtrusive, plain-looking scrollbar that
2218 is the favourite of the rxvt-unicode author, having used it for
2219 many years.
2220 .IP "\-\-enable\-half\-shadow" 4
2221 .IX Item "--enable-half-shadow"
2222 Make shadows on the scrollbar only half the normal width & height.
2223 only applicable to rxvt scrollbars.
2224 .IP "\-\-enable\-ttygid" 4
2225 .IX Item "--enable-ttygid"
2226 Change tty device setting to group \*(L"tty\*(R" \- only use this if
2227 your system uses this type of security.
2228 .IP "\-\-disable\-backspace\-key" 4
2229 .IX Item "--disable-backspace-key"
2230 Disable any handling of the backspace key by us \- let the X server
2231 do it.
2232 .IP "\-\-disable\-delete\-key" 4
2233 .IX Item "--disable-delete-key"
2234 Disable any handling of the delete key by us \- let the X server
2235 do it.
2236 .IP "\-\-disable\-resources" 4
2237 .IX Item "--disable-resources"
2238 Remove all resources checking.
2239 .IP "\-\-enable\-xgetdefault" 4
2240 .IX Item "--enable-xgetdefault"
2241 Make resources checking via \fIXGetDefault()\fR instead of our small
2242 version which only checks ~/.Xdefaults, or if that doesn't exist
2243 then ~/.Xresources.
2244 .IP "\-\-enable\-strings" 4
2245 .IX Item "--enable-strings"
2246 Add support for our possibly faster \fImemset()\fR function and other
2247 various routines, overriding your system's versions which may
2248 have been hand-crafted in assembly or may require extra libraries
2249 to link in. (this breaks ANSI-C rules and has problems on many
2250 GNU/Linux systems).
2251 .IP "\-\-disable\-swapscreen" 4
2252 .IX Item "--disable-swapscreen"
2253 Remove support for swap screen.
2254 .IP "\-\-enable\-frills" 4
2255 .IX Item "--enable-frills"
2256 Add support for many small features that are not essential but nice to
2257 have. Normally you want this, but for very small binaries you may want to
2258 disable this.
2259 .IP "\-\-enable\-iso14755" 4
2260 .IX Item "--enable-iso14755"
2261 Enable extended \s-1ISO\s0 14755 support (see @@RXVT_NAME@@(1), or
2262 \&\fIdoc/rxvt.1.txt\fR). Basic support (section 5.1) is enabled by
2263 \&\f(CW\*(C`\-\-enable\-frills\*(C'\fR, while support for 5.2, 5.3 and 5.4 is enabled with
2264 this switch.
2265 .IP "\-\-enable\-keepscrolling" 4
2266 .IX Item "--enable-keepscrolling"
2267 Add support for continual scrolling of the display when you hold
2268 the mouse button down on a scrollbar arrow.
2269 .IP "\-\-enable\-mousewheel" 4
2270 .IX Item "--enable-mousewheel"
2271 Add support for scrolling via mouse wheel or buttons 4 & 5.
2272 .IP "\-\-enable\-slipwheeling" 4
2273 .IX Item "--enable-slipwheeling"
2274 Add support for continual scrolling (using the mouse wheel as an
2275 accelerator) while the control key is held down. This option
2276 requires \-\-enable\-mousewheel to also be specified.
2277 .IP "\-\-disable\-new\-selection" 4
2278 .IX Item "--disable-new-selection"
2279 Remove support for mouse selection style like that of xterm.
2280 .IP "\-\-enable\-dmalloc" 4
2281 .IX Item "--enable-dmalloc"
2282 Use Gray Watson's malloc \- which is good for debugging See
2283 http://www.letters.com/dmalloc/ for details If you use either this or the
2284 next option, you may need to edit src/Makefile after compiling to point
2285 \&\s-1DINCLUDE\s0 and \s-1DLIB\s0 to the right places.
2286 .Sp
2287 You can only use either this option and the following (should
2288 you use either) .
2289 .IP "\-\-enable\-dlmalloc" 4
2290 .IX Item "--enable-dlmalloc"
2291 Use Doug Lea's malloc \- which is good for a production version
2292 See <http://g.oswego.edu/dl/html/malloc.html> for details.
2293 .IP "\-\-enable\-smart\-resize" 4
2294 .IX Item "--enable-smart-resize"
2295 Add smart growth/shrink behaviour when changing font size via from hot
2296 keys. This should keep in a fixed position the rxvt corner which is
2297 closest to a corner of the screen.
2298 .IP "\-\-enable\-cursor\-blink" 4
2299 .IX Item "--enable-cursor-blink"
2300 Add support for a blinking cursor.
2301 .IP "\-\-enable\-pointer\-blank" 4
2302 .IX Item "--enable-pointer-blank"
2303 Add support to have the pointer disappear when typing or inactive.
2304 .IP "\-\-with\-name=NAME" 4
2305 .IX Item "--with-name=NAME"
2306 Set the basename for the installed binaries (default: urxvt, resulting in
2307 urxvt, urxvtd etc.). Specify \-\-with\-name=rxvt to replace rxvt.
2308 .IP "\-\-with\-term=NAME" 4
2309 .IX Item "--with-term=NAME"
2310 Change the environmental variable for the terminal to \s-1NAME\s0 (default
2311 \&\*(L"rxvt\*(R")
2312 .IP "\-\-with\-terminfo=PATH" 4
2313 .IX Item "--with-terminfo=PATH"
2314 Change the environmental variable for the path to the terminfo tree to
2315 \&\s-1PATH\s0.
2316 .IP "\-\-with\-x" 4
2317 .IX Item "--with-x"
2318 Use the X Window System (pretty much default, eh?).
2319 .IP "\-\-with\-xpm\-includes=DIR" 4
2320 .IX Item "--with-xpm-includes=DIR"
2321 Look for the \s-1XPM\s0 includes in \s-1DIR\s0.
2322 .IP "\-\-with\-xpm\-library=DIR" 4
2323 .IX Item "--with-xpm-library=DIR"
2324 Look for the \s-1XPM\s0 library in \s-1DIR\s0.
2325 .IP "\-\-with\-xpm" 4
2326 .IX Item "--with-xpm"
2327 Not needed \- define via \-\-enable\-xpm\-background.
2328 .SH "AUTHORS"
2329 .IX Header "AUTHORS"
2330 Marc Lehmann <rxvt@schmorp.de> converted this document to pod and
2331 reworked it from the original Rxvt documentation, which was done by Geoff
2332 Wing <gcw@pobox.com>, who in turn used the XTerm documentation and other
2333 sources.