ViewVC Help
View File | Revision Log | Show Annotations | Download File
/cvs/rxvt-unicode/doc/rxvt.7.man.in
Revision: 1.30
Committed: Mon Jan 2 15:11:05 2006 UTC (18 years, 6 months ago) by root
Branch: MAIN
CVS Tags: rel-6_2
Changes since 1.29: +10 -1 lines
Log Message:
*** empty log message ***

File Contents

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