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