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