ViewVC Help
View File | Revision Log | Show Annotations | Download File
/cvs/rxvt-unicode/doc/rxvt.7.man.in
Revision: 1.129
Committed: Wed Dec 31 14:40:24 2014 UTC (9 years, 6 months ago) by root
Branch: MAIN
CVS Tags: rxvt-unicode-rel-9_21
Changes since 1.128: +23 -0 lines
Log Message:
cvvis faq

File Contents

# User Rev Content
1 root 1.128 .\" Automatically generated by Pod::Man 2.28 (Pod::Simple 3.28)
2 root 1.1 .\"
3     .\" Standard preamble:
4     .\" ========================================================================
5     .de Sp \" Vertical space (when we can't use .PP)
6     .if t .sp .5v
7     .if n .sp
8     ..
9     .de Vb \" Begin verbatim text
10     .ft CW
11     .nf
12     .ne \\$1
13     ..
14     .de Ve \" End verbatim text
15     .ft R
16     .fi
17     ..
18     .\" Set up some character translations and predefined strings. \*(-- will
19     .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
20 root 1.95 .\" double quote, and \*(R" will give a right double quote. \*(C+ will
21     .\" give a nicer C++. Capital omega is used to do unbreakable dashes and
22     .\" therefore won't be available. \*(C` and \*(C' expand to `' in nroff,
23     .\" nothing in troff, for use with C<>.
24     .tr \(*W-
25 root 1.1 .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
26     .ie n \{\
27     . ds -- \(*W-
28     . ds PI pi
29     . if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
30     . if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch
31     . ds L" ""
32     . ds R" ""
33 root 1.12 . ds C` ""
34     . ds C' ""
35 root 1.1 'br\}
36     .el\{\
37     . ds -- \|\(em\|
38     . ds PI \(*p
39     . ds L" ``
40     . ds R" ''
41 root 1.128 . ds C`
42     . ds C'
43 root 1.1 'br\}
44     .\"
45 root 1.95 .\" Escape single quotes in literal strings from groff's Unicode transform.
46     .ie \n(.g .ds Aq \(aq
47     .el .ds Aq '
48     .\"
49 root 1.1 .\" If the F register is turned on, we'll generate index entries on stderr for
50 root 1.100 .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
51 root 1.1 .\" entries marked with X<> in POD. Of course, you'll have to process the
52     .\" output yourself in some meaningful fashion.
53 root 1.128 .\"
54     .\" Avoid warning from groff about undefined register 'F'.
55     .de IX
56 root 1.1 ..
57 root 1.128 .nr rF 0
58     .if \n(.g .if rF .nr rF 1
59     .if (\n(rF:(\n(.g==0)) \{
60     . if \nF \{
61     . de IX
62     . tm Index:\\$1\t\\n%\t"\\$2"
63 root 1.95 ..
64 root 1.128 . if !\nF==2 \{
65     . nr % 0
66     . nr F 2
67     . \}
68     . \}
69 root 1.95 .\}
70 root 1.128 .rr rF
71 root 1.1 .\"
72     .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
73     .\" Fear. Run. Save yourself. No user-serviceable parts.
74     . \" fudge factors for nroff and troff
75     .if n \{\
76     . ds #H 0
77     . ds #V .8m
78     . ds #F .3m
79     . ds #[ \f1
80     . ds #] \fP
81     .\}
82     .if t \{\
83     . ds #H ((1u-(\\\\n(.fu%2u))*.13m)
84     . ds #V .6m
85     . ds #F 0
86     . ds #[ \&
87     . ds #] \&
88     .\}
89     . \" simple accents for nroff and troff
90     .if n \{\
91     . ds ' \&
92     . ds ` \&
93     . ds ^ \&
94     . ds , \&
95     . ds ~ ~
96     . ds /
97     .\}
98     .if t \{\
99     . ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
100     . ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
101     . ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
102     . ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
103     . ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
104     . ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
105     .\}
106     . \" troff and (daisy-wheel) nroff accents
107     .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
108     .ds 8 \h'\*(#H'\(*b\h'-\*(#H'
109     .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
110     .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
111     .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
112     .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
113     .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
114     .ds ae a\h'-(\w'a'u*4/10)'e
115     .ds Ae A\h'-(\w'A'u*4/10)'E
116     . \" corrections for vroff
117     .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
118     .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
119     . \" for low resolution devices (crt and lpr)
120     .if \n(.H>23 .if \n(.V>19 \
121     \{\
122     . ds : e
123     . ds 8 ss
124     . ds o a
125     . ds d- d\h'-1'\(ga
126     . ds D- D\h'-1'\(hy
127     . ds th \o'bp'
128     . ds Th \o'LP'
129     . ds ae ae
130     . ds Ae AE
131     .\}
132     .rm #[ #] #H #V #F C
133     .\" ========================================================================
134     .\"
135 root 1.77 .IX Title "@@RXVT_NAME@@ 7"
136 root 1.127 .TH @@RXVT_NAME@@ 7 "2014-12-31" "@@RXVT_VERSION@@" "RXVT-UNICODE"
137 root 1.95 .\" For nroff, turn off justification. Always turn off hyphenation; it makes
138     .\" way too many mistakes in technical documents.
139     .if n .ad l
140     .nh
141 root 1.1 .SH "NAME"
142     RXVT REFERENCE \- FAQ, command sequences and other background information
143 root 1.12 .SH "SYNOPSIS"
144     .IX Header "SYNOPSIS"
145     .Vb 2
146     \& # set a new font set
147 root 1.95 \& printf \*(Aq\e33]50;%s\e007\*(Aq 9x15,xft:Kochi" Mincho"
148     \&
149     \& # change the locale and tell rxvt\-unicode about it
150     \& export LC_CTYPE=ja_JP.EUC\-JP; printf "\e33]701;$LC_CTYPE\e007"
151     \&
152 root 1.12 \& # set window title
153 root 1.95 \& printf \*(Aq\e33]2;%s\e007\*(Aq "new window title"
154 root 1.12 .Ve
155     .SH "DESCRIPTION"
156     .IX Header "DESCRIPTION"
157 root 1.128 This document contains the \s-1FAQ,\s0 the \s-1RXVT TECHNICAL REFERENCE\s0 documenting
158 root 1.12 all escape sequences, and other background information.
159     .PP
160 root 1.56 The newest version of this document is also available on the World Wide Web at
161 root 1.128 <http://pod.tst.eu/http://cvs.schmorp.de/rxvt\-unicode/doc/rxvt.7.pod>.
162 root 1.92 .PP
163     The main manual page for @@RXVT_NAME@@ itself is available at
164 root 1.128 <http://pod.tst.eu/http://cvs.schmorp.de/rxvt\-unicode/doc/rxvt.1.pod>.
165 root 1.64 .SH "RXVT\-UNICODE/URXVT FREQUENTLY ASKED QUESTIONS"
166     .IX Header "RXVT-UNICODE/URXVT FREQUENTLY ASKED QUESTIONS"
167 root 1.100 .SS "Meta, Features & Commandline Issues"
168 root 1.62 .IX Subsection "Meta, Features & Commandline Issues"
169     \fIMy question isn't answered here, can I ask a human?\fR
170     .IX Subsection "My question isn't answered here, can I ask a human?"
171 root 1.58 .PP
172 root 1.128 Before sending me mail, you could go to \s-1IRC: \s0\f(CW\*(C`irc.freenode.net\*(C'\fR,
173 root 1.62 channel \f(CW\*(C`#rxvt\-unicode\*(C'\fR has some rxvt-unicode enthusiasts that might be
174     interested in learning about new and exciting problems (but not FAQs :).
175 root 1.58 .PP
176 root 1.98 \fII use Gentoo, and I have a problem...\fR
177     .IX Subsection "I use Gentoo, and I have a problem..."
178     .PP
179 root 1.126 There are two big problems with Gentoo Linux: first, most if not all
180     Gentoo systems are completely broken (missing or mismatched header
181     files, broken compiler etc. are just the tip of the iceberg);
182     secondly, it should be called Gentoo GNU/Linux.
183 root 1.98 .PP
184     For these reasons, it is impossible to support rxvt-unicode on
185     Gentoo. Problems appearing on Gentoo systems will usually simply be
186     ignored unless they can be reproduced on non-Gentoo systems.
187     .PP
188 root 1.95 \fIDoes it support tabs, can I have a tabbed rxvt-unicode?\fR
189 root 1.62 .IX Subsection "Does it support tabs, can I have a tabbed rxvt-unicode?"
190 root 1.58 .PP
191 root 1.62 Beginning with version 7.3, there is a perl extension that implements a
192     simple tabbed terminal. It is installed by default, so any of these should
193     give you tabs:
194 root 1.58 .PP
195 root 1.43 .Vb 1
196 root 1.95 \& @@URXVT_NAME@@ \-pe tabbed
197     \&
198     \& URxvt.perl\-ext\-common: default,tabbed
199 root 1.42 .Ve
200 root 1.59 .PP
201 root 1.62 It will also work fine with tabbing functionality of many window managers
202     or similar tabbing programs, and its embedding-features allow it to be
203     embedded into other programs, as witnessed by \fIdoc/rxvt\-tabbed\fR or
204     the upcoming \f(CW\*(C`Gtk2::URxvt\*(C'\fR perl module, which features a tabbed urxvt
205     (murxvt) terminal as an example embedding application.
206 root 1.59 .PP
207 root 1.62 \fIHow do I know which rxvt-unicode version I'm using?\fR
208     .IX Subsection "How do I know which rxvt-unicode version I'm using?"
209 root 1.59 .PP
210 root 1.62 The version number is displayed with the usage (\-h). Also the escape
211     sequence \f(CW\*(C`ESC [ 8 n\*(C'\fR sets the window title to the version number. When
212 root 1.63 using the @@URXVT_NAME@@c client, the version displayed is that of the
213 root 1.62 daemon.
214 root 1.59 .PP
215 root 1.62 \fIRxvt-unicode uses gobs of memory, how can I reduce that?\fR
216     .IX Subsection "Rxvt-unicode uses gobs of memory, how can I reduce that?"
217 root 1.59 .PP
218 root 1.62 Rxvt-unicode tries to obey the rule of not charging you for something you
219     don't use. One thing you should try is to configure out all settings that
220     you don't need, for example, Xft support is a resource hog by design,
221     when used. Compiling it out ensures that no Xft font will be loaded
222     accidentally when rxvt-unicode tries to find a font for your characters.
223 root 1.59 .PP
224 root 1.62 Also, many people (me included) like large windows and even larger
225     scrollback buffers: Without \f(CW\*(C`\-\-enable\-unicode3\*(C'\fR, rxvt-unicode will use
226     6 bytes per screen cell. For a 160x?? window this amounts to almost a
227     kilobyte per line. A scrollback buffer of 10000 lines will then (if full)
228     use 10 Megabytes of memory. With \f(CW\*(C`\-\-enable\-unicode3\*(C'\fR it gets worse, as
229     rxvt-unicode then uses 8 bytes per screen cell.
230 root 1.59 .PP
231 root 1.63 \fIHow can I start @@URXVT_NAME@@d in a race-free way?\fR
232     .IX Subsection "How can I start @@URXVT_NAME@@d in a race-free way?"
233 root 1.59 .PP
234 root 1.63 Try \f(CW\*(C`@@URXVT_NAME@@d \-f \-o\*(C'\fR, which tells @@URXVT_NAME@@d to open the
235 root 1.62 display, create the listening socket and then fork.
236 root 1.59 .PP
237 root 1.81 \fIHow can I start @@URXVT_NAME@@d automatically when I run @@URXVT_NAME@@c?\fR
238     .IX Subsection "How can I start @@URXVT_NAME@@d automatically when I run @@URXVT_NAME@@c?"
239 root 1.70 .PP
240     If you want to start @@URXVT_NAME@@d automatically whenever you run
241     @@URXVT_NAME@@c and the daemon isn't running yet, use this script:
242     .PP
243     .Vb 6
244     \& #!/bin/sh
245     \& @@URXVT_NAME@@c "$@"
246 root 1.95 \& if [ $? \-eq 2 ]; then
247     \& @@URXVT_NAME@@d \-q \-o \-f
248 root 1.70 \& @@URXVT_NAME@@c "$@"
249     \& fi
250     .Ve
251     .PP
252     This tries to create a new terminal, and if fails with exit status 2,
253     meaning it couldn't connect to the daemon, it will start the daemon and
254     re-run the command. Subsequent invocations of the script will re-use the
255     existing daemon.
256     .PP
257 sf-exg 1.102 \fIHow do I distinguish whether I'm running rxvt-unicode or a regular xterm? I need this to decide about setting colours etc.\fR
258     .IX Subsection "How do I distinguish whether I'm running rxvt-unicode or a regular xterm? I need this to decide about setting colours etc."
259 root 1.59 .PP
260 root 1.128 The original rxvt and rxvt-unicode always export the variable \*(L"\s-1COLORTERM\*(R",\s0
261     so you can check and see if that is set. Note that several programs, \s-1JED,\s0
262 root 1.65 slrn, Midnight Commander automatically check this variable to decide
263 sf-exg 1.102 whether or not to use colour.
264 root 1.59 .PP
265 root 1.62 \fIHow do I set the correct, full \s-1IP\s0 address for the \s-1DISPLAY\s0 variable?\fR
266     .IX Subsection "How do I set the correct, full IP address for the DISPLAY variable?"
267 root 1.59 .PP
268 root 1.62 If you've compiled rxvt-unicode with \s-1DISPLAY_IS_IP\s0 and have enabled
269     insecure mode then it is possible to use the following shell script
270     snippets to correctly set the display. If your version of rxvt-unicode
271 root 1.128 wasn't also compiled with \s-1ESCZ_ANSWER \s0(as assumed in these snippets) then
272 root 1.62 the \s-1COLORTERM\s0 variable can be used to distinguish rxvt-unicode from a
273     regular xterm.
274 root 1.59 .PP
275 root 1.62 Courtesy of Chuck Blake <cblake@BBN.COM> with the following shell script
276     snippets:
277 root 1.59 .PP
278 root 1.62 .Vb 12
279     \& # Bourne/Korn/POSIX family of shells:
280 root 1.95 \& [ ${TERM:\-foo} = foo ] && TERM=xterm # assume an xterm if we don\*(Aqt know
281     \& if [ ${TERM:\-foo} = xterm ]; then
282     \& stty \-icanon \-echo min 0 time 15 # see if enhanced rxvt or not
283 root 1.119 \& printf "\eeZ"
284 root 1.62 \& read term_id
285     \& stty icanon echo
286 root 1.95 \& if [ ""${term_id} = \*(Aq^[[?1;2C\*(Aq \-a ${DISPLAY:\-foo} = foo ]; then
287 root 1.119 \& printf \*(Aq\ee[7n\*(Aq # query the rxvt we are in for the DISPLAY string
288     \& read DISPLAY # set it in our local shell
289 root 1.62 \& fi
290     \& fi
291 root 1.55 .Ve
292 root 1.59 .PP
293 root 1.62 \fIHow do I compile the manual pages on my own?\fR
294     .IX Subsection "How do I compile the manual pages on my own?"
295 root 1.59 .PP
296 root 1.62 You need to have a recent version of perl installed as \fI/usr/bin/perl\fR,
297 root 1.85 one that comes with \fIpod2man\fR, \fIpod2text\fR and \fIpod2xhtml\fR (from
298 root 1.86 \&\fIPod::Xhtml\fR). Then go to the doc subdirectory and enter \f(CW\*(C`make alldoc\*(C'\fR.
299 root 1.59 .PP
300 root 1.62 \fIIsn't rxvt-unicode supposed to be small? Don't all those features bloat?\fR
301     .IX Subsection "Isn't rxvt-unicode supposed to be small? Don't all those features bloat?"
302 root 1.59 .PP
303 root 1.29 I often get asked about this, and I think, no, they didn't cause extra
304     bloat. If you compare a minimal rxvt and a minimal urxvt, you can see
305     that the urxvt binary is larger (due to some encoding tables always being
306     compiled in), but it actually uses less memory (\s-1RSS\s0) after startup. Even
307     with \f(CW\*(C`\-\-disable\-everything\*(C'\fR, this comparison is a bit unfair, as many
308     features unique to urxvt (locale, encoding conversion, iso14755 etc.) are
309     already in use in this mode.
310 root 1.59 .PP
311 root 1.29 .Vb 3
312     \& text data bss drs rss filename
313 root 1.95 \& 98398 1664 24 15695 1824 rxvt \-\-disable\-everything
314     \& 188985 9048 66616 18222 1788 urxvt \-\-disable\-everything
315 root 1.29 .Ve
316 root 1.59 .PP
317 root 1.66 When you \f(CW\*(C`\-\-enable\-everything\*(C'\fR (which \fIis\fR unfair, as this involves xft
318 root 1.29 and full locale/XIM support which are quite bloaty inside libX11 and my
319 root 1.79 libc), the two diverge, but not unreasonably so.
320 root 1.59 .PP
321 root 1.29 .Vb 3
322     \& text data bss drs rss filename
323 root 1.95 \& 163431 2152 24 20123 2060 rxvt \-\-enable\-everything
324     \& 1035683 49680 66648 29096 3680 urxvt \-\-enable\-everything
325 root 1.29 .Ve
326 root 1.59 .PP
327 root 1.29 The very large size of the text section is explained by the east-asian
328     encoding tables, which, if unused, take up disk space but nothing else
329     and can be compiled out unless you rely on X11 core fonts that use those
330     encodings. The \s-1BSS\s0 size comes from the 64k emergency buffer that my c++
331     compiler allocates (but of course doesn't use unless you are out of
332     memory). Also, using an xft font instead of a core font immediately adds a
333 root 1.128 few megabytes of \s-1RSS.\s0 Xft indeed is responsible for a lot of \s-1RSS\s0 even when
334 root 1.29 not used.
335 root 1.59 .PP
336 root 1.29 Of course, due to every character using two or four bytes instead of one,
337     a large scrollback buffer will ultimately make rxvt-unicode use more
338     memory.
339 root 1.59 .PP
340 root 1.29 Compared to e.g. Eterm (5112k), aterm (3132k) and xterm (4680k), this
341     still fares rather well. And compared to some monsters like gnome-terminal
342     (21152k + extra 4204k in separate processes) or konsole (22200k + extra
343 root 1.38 43180k in daemons that stay around after exit, plus half a minute of
344 root 1.29 startup time, including the hundreds of warnings it spits out), it fares
345     extremely well *g*.
346 root 1.62 .PP
347     \fIWhy \*(C+, isn't that unportable/bloated/uncool?\fR
348 root 1.59 .IX Subsection "Why , isn't that unportable/bloated/uncool?"
349 root 1.62 .PP
350 root 1.29 Is this a question? :) It comes up very often. The simple answer is: I had
351     to write it, and \*(C+ allowed me to write and maintain it in a fraction
352     of the time and effort (which is a scarce resource for me). Put even
353     shorter: It simply wouldn't exist without \*(C+.
354 root 1.59 .PP
355 root 1.29 My personal stance on this is that \*(C+ is less portable than C, but in
356     the case of rxvt-unicode this hardly matters, as its portability limits
357     are defined by things like X11, pseudo terminals, locale support and unix
358     domain sockets, which are all less portable than \*(C+ itself.
359 root 1.59 .PP
360 root 1.29 Regarding the bloat, see the above question: It's easy to write programs
361 root 1.106 in C that use gobs of memory, and certainly possible to write programs in
362 root 1.29 \&\*(C+ that don't. \*(C+ also often comes with large libraries, but this is
363 root 1.128 not necessarily the case with \s-1GCC.\s0 Here is what rxvt links against on my
364 root 1.29 system with a minimal config:
365 root 1.59 .PP
366 root 1.29 .Vb 4
367     \& libX11.so.6 => /usr/X11R6/lib/libX11.so.6 (0x00002aaaaabc3000)
368     \& libc.so.6 => /lib/libc.so.6 (0x00002aaaaadde000)
369     \& libdl.so.2 => /lib/libdl.so.2 (0x00002aaaab01d000)
370 root 1.95 \& /lib64/ld\-linux\-x86\-64.so.2 (0x00002aaaaaaab000)
371 root 1.29 .Ve
372 root 1.59 .PP
373 root 1.95 And here is rxvt-unicode:
374 root 1.59 .PP
375 root 1.29 .Vb 5
376     \& libX11.so.6 => /usr/X11R6/lib/libX11.so.6 (0x00002aaaaabc3000)
377     \& libgcc_s.so.1 => /lib/libgcc_s.so.1 (0x00002aaaaada2000)
378 root 1.89 \& libc.so.6 => /lib/libc.so.6 (0x00002aaaaaeb0000)
379     \& libdl.so.2 => /lib/libdl.so.2 (0x00002aaaab0ee000)
380 root 1.95 \& /lib64/ld\-linux\-x86\-64.so.2 (0x00002aaaaaaab000)
381 root 1.29 .Ve
382 root 1.59 .PP
383 root 1.29 No large bloated libraries (of course, none were linked in statically),
384     except maybe libX11 :)
385 root 1.100 .SS "Rendering, Font & Look and Feel Issues"
386 root 1.62 .IX Subsection "Rendering, Font & Look and Feel Issues"
387     \fII can't get transparency working, what am I doing wrong?\fR
388     .IX Subsection "I can't get transparency working, what am I doing wrong?"
389     .PP
390 root 1.104 First of all, transparency isn't officially supported in rxvt-unicode, so
391     you are mostly on your own. Do not bug the author about it (but you may
392     bug everybody else). Also, if you can't get it working consider it a rite
393     of passage: ... and you failed.
394 root 1.62 .PP
395     Here are four ways to get transparency. \fBDo\fR read the manpage and option
396 root 1.95 descriptions for the programs mentioned and rxvt-unicode. Really, do it!
397 root 1.62 .PP
398 root 1.89 1. Use transparent mode:
399 root 1.62 .PP
400     .Vb 2
401     \& Esetroot wallpaper.jpg
402 root 1.95 \& @@URXVT_NAME@@ \-tr \-tint red \-sh 40
403 root 1.62 .Ve
404     .PP
405     That works. If you think it doesn't, you lack transparency and tinting
406     support, or you are unable to read.
407 root 1.106 This method requires that the background-setting program sets the
408     _XROOTPMAP_ID or \s-1ESETROOT_PMAP_ID\s0 property. Compatible programs
409     are Esetroot, hsetroot and feh.
410 root 1.62 .PP
411 root 1.95 2. Use a simple pixmap and emulate pseudo-transparency. This enables you
412 root 1.62 to use effects other than tinting and shading: Just shade/tint/whatever
413     your picture with gimp or any other tool:
414 root 1.59 .PP
415 root 1.62 .Vb 2
416 root 1.95 \& convert wallpaper.jpg \-blur 20x20 \-modulate 30 background.jpg
417     \& @@URXVT_NAME@@ \-pixmap "background.jpg;:root"
418 root 1.54 .Ve
419 root 1.59 .PP
420 root 1.118 That works. If you think it doesn't, you lack GDK-PixBuf support, or you
421 root 1.62 are unable to read.
422     .PP
423     3. Use an \s-1ARGB\s0 visual:
424     .PP
425 root 1.54 .Vb 1
426 root 1.95 \& @@URXVT_NAME@@ \-depth 32 \-fg grey90 \-bg rgba:0000/0000/4444/cccc
427 root 1.54 .Ve
428 root 1.59 .PP
429 root 1.62 This requires \s-1XFT\s0 support, and the support of your X\-server. If that
430     doesn't work for you, blame Xorg and Keith Packard. \s-1ARGB\s0 visuals aren't
431 root 1.79 there yet, no matter what they claim. Rxvt-Unicode contains the necessary
432 root 1.62 bugfixes and workarounds for Xft and Xlib to make it work, but that
433     doesn't mean that your \s-1WM\s0 has the required kludges in place.
434     .PP
435     4. Use xcompmgr and let it do the job:
436 root 1.59 .PP
437 root 1.62 .Vb 2
438 root 1.95 \& xprop \-frame \-f _NET_WM_WINDOW_OPACITY 32c \e
439     \& \-set _NET_WM_WINDOW_OPACITY 0xc0000000
440 root 1.62 .Ve
441 root 1.59 .PP
442 root 1.62 Then click on a window you want to make transparent. Replace \f(CW0xc0000000\fR
443     by other values to change the degree of opacity. If it doesn't work and
444     your server crashes, you got to keep the pieces.
445 root 1.59 .PP
446 root 1.62 \fIWhy does rxvt-unicode sometimes leave pixel droppings?\fR
447 root 1.59 .IX Subsection "Why does rxvt-unicode sometimes leave pixel droppings?"
448 root 1.62 .PP
449 root 1.1 Most fonts were not designed for terminal use, which means that character
450     size varies a lot. A font that is otherwise fine for terminal use might
451     contain some characters that are simply too wide. Rxvt-unicode will avoid
452     these characters. For characters that are just \*(L"a bit\*(R" too wide a special
453     \&\*(L"careful\*(R" rendering mode is used that redraws adjacent characters.
454 root 1.59 .PP
455 root 1.1 All of this requires that fonts do not lie about character sizes,
456     however: Xft fonts often draw glyphs larger than their acclaimed bounding
457     box, and rxvt-unicode has no way of detecting this (the correct way is to
458     ask for the character bounding box, which unfortunately is wrong in these
459     cases).
460 root 1.59 .PP
461 root 1.79 It's not clear (to me at least), whether this is a bug in Xft, freetype,
462 root 1.1 or the respective font. If you encounter this problem you might try using
463     the \f(CW\*(C`\-lsp\*(C'\fR option to give the font more height. If that doesn't work, you
464     might be forced to use a different font.
465 root 1.59 .PP
466 root 1.1 All of this is not a problem when using X11 core fonts, as their bounding
467     box data is correct.
468 root 1.59 .PP
469 root 1.62 \fIHow can I keep rxvt-unicode from using reverse video so much?\fR
470     .IX Subsection "How can I keep rxvt-unicode from using reverse video so much?"
471 root 1.59 .PP
472 root 1.12 First of all, make sure you are running with the right terminal settings
473     (\f(CW\*(C`TERM=rxvt\-unicode\*(C'\fR), which will get rid of most of these effects. Then
474     make sure you have specified colours for italic and bold, as otherwise
475     rxvt-unicode might use reverse video to simulate the effect:
476 root 1.59 .PP
477 root 1.1 .Vb 2
478 root 1.12 \& URxvt.colorBD: white
479     \& URxvt.colorIT: green
480 root 1.1 .Ve
481 root 1.62 .PP
482     \fISome programs assume totally weird colours (red instead of blue), how can I fix that?\fR
483 root 1.59 .IX Subsection "Some programs assume totally weird colours (red instead of blue), how can I fix that?"
484 root 1.62 .PP
485 root 1.12 For some unexplainable reason, some rare programs assume a very weird
486     colour palette when confronted with a terminal with more than the standard
487 root 1.95 8 colours (rxvt-unicode supports 88). The right fix is, of course, to fix
488 root 1.12 these programs not to assume non-ISO colours without very good reasons.
489 root 1.59 .PP
490 root 1.12 In the meantime, you can either edit your \f(CW\*(C`rxvt\-unicode\*(C'\fR terminfo
491     definition to only claim 8 colour support or use \f(CW\*(C`TERM=rxvt\*(C'\fR, which will
492     fix colours but keep you from using other rxvt-unicode features.
493 root 1.59 .PP
494 root 1.62 \fICan I switch the fonts at runtime?\fR
495     .IX Subsection "Can I switch the fonts at runtime?"
496     .PP
497     Yes, using an escape sequence. Try something like this, which has the same
498     effect as using the \f(CW\*(C`\-fn\*(C'\fR switch, and takes effect immediately:
499     .PP
500     .Vb 1
501 root 1.95 \& printf \*(Aq\e33]50;%s\e007\*(Aq "9x15bold,xft:Kochi Gothic"
502 root 1.62 .Ve
503 root 1.59 .PP
504 root 1.62 This is useful if you e.g. work primarily with japanese (and prefer a
505     japanese font), but you have to switch to chinese temporarily, where
506     japanese fonts would only be in your way.
507 root 1.59 .PP
508 root 1.62 You can think of this as a kind of manual \s-1ISO\-2022\s0 switching.
509 root 1.59 .PP
510 root 1.62 \fIWhy do italic characters look as if clipped?\fR
511     .IX Subsection "Why do italic characters look as if clipped?"
512 root 1.59 .PP
513 root 1.1 Many fonts have difficulties with italic characters and hinting. For
514     example, the otherwise very nicely hinted font \f(CW\*(C`xft:Bitstream Vera Sans
515 root 1.77 Mono\*(C'\fR completely fails in its italic face. A workaround might be to
516 root 1.12 enable freetype autohinting, i.e. like this:
517 root 1.59 .PP
518 root 1.1 .Vb 2
519 root 1.12 \& URxvt.italicFont: xft:Bitstream Vera Sans Mono:italic:autohint=true
520     \& URxvt.boldItalicFont: xft:Bitstream Vera Sans Mono:bold:italic:autohint=true
521 root 1.1 .Ve
522 root 1.59 .PP
523 root 1.62 \fICan I speed up Xft rendering somehow?\fR
524     .IX Subsection "Can I speed up Xft rendering somehow?"
525 root 1.59 .PP
526 root 1.1 Yes, the most obvious way to speed it up is to avoid Xft entirely, as
527     it is simply slow. If you still want Xft fonts you might try to disable
528 root 1.24 antialiasing (by appending \f(CW\*(C`:antialias=false\*(C'\fR), which saves lots of
529 root 1.1 memory and also speeds up rendering considerably.
530 root 1.62 .PP
531     \fIRxvt-unicode doesn't seem to anti-alias its fonts, what is wrong?\fR
532 root 1.59 .IX Subsection "Rxvt-unicode doesn't seem to anti-alias its fonts, what is wrong?"
533 root 1.62 .PP
534 root 1.1 Rxvt-unicode will use whatever you specify as a font. If it needs to
535 root 1.77 fall back to its default font search list it will prefer X11 core
536 root 1.1 fonts, because they are small and fast, and then use Xft fonts. It has
537     antialiasing disabled for most of them, because the author thinks they
538     look best that way.
539 root 1.59 .PP
540 root 1.1 If you want antialiasing, you have to specify the fonts manually.
541 root 1.62 .PP
542     \fIWhat's with this bold/blink stuff?\fR
543 root 1.59 .IX Subsection "What's with this bold/blink stuff?"
544 root 1.62 .PP
545 root 1.1 If no bold colour is set via \f(CW\*(C`colorBD:\*(C'\fR, bold will invert text using the
546     standard foreground colour.
547 root 1.59 .PP
548 root 1.90 For the standard background colour, blinking will actually make
549     the text blink when compiled with \f(CW\*(C`\-\-enable\-text\-blink\*(C'\fR. Without
550     \&\f(CW\*(C`\-\-enable\-text\-blink\*(C'\fR, the blink attribute will be ignored.
551 root 1.59 .PP
552 root 1.1 On \s-1ANSI\s0 colours, bold/blink attributes are used to set high-intensity
553 sf-exg 1.102 foreground/background colours.
554 root 1.59 .PP
555 sf-exg 1.102 color0\-7 are the low-intensity colours.
556 root 1.59 .PP
557 sf-exg 1.102 color8\-15 are the corresponding high-intensity colours.
558 root 1.62 .PP
559 sf-exg 1.102 \fII don't like the screen colours. How do I change them?\fR
560 root 1.128 .IX Subsection "I don't like the screen colours. How do I change them?"
561 root 1.62 .PP
562 sf-exg 1.102 You can change the screen colours at run-time using \fI~/.Xdefaults\fR
563 root 1.95 resources (or as long-options).
564 root 1.59 .PP
565 root 1.1 Here are values that are supposed to resemble a \s-1VGA\s0 screen,
566     including the murky brown that passes for low-intensity yellow:
567 root 1.59 .PP
568 root 1.1 .Vb 8
569 root 1.12 \& URxvt.color0: #000000
570     \& URxvt.color1: #A80000
571     \& URxvt.color2: #00A800
572     \& URxvt.color3: #A8A800
573     \& URxvt.color4: #0000A8
574     \& URxvt.color5: #A800A8
575     \& URxvt.color6: #00A8A8
576     \& URxvt.color7: #A8A8A8
577 root 1.95 \&
578 root 1.12 \& URxvt.color8: #000054
579     \& URxvt.color9: #FF0054
580     \& URxvt.color10: #00FF54
581     \& URxvt.color11: #FFFF54
582     \& URxvt.color12: #0000FF
583     \& URxvt.color13: #FF00FF
584     \& URxvt.color14: #00FFFF
585     \& URxvt.color15: #FFFFFF
586 root 1.1 .Ve
587 root 1.59 .PP
588 sf-exg 1.102 And here is a more complete set of non-standard colours.
589 root 1.59 .PP
590 root 1.95 .Vb 10
591 root 1.1 \& URxvt.cursorColor: #dc74d1
592     \& URxvt.pointerColor: #dc74d1
593     \& URxvt.background: #0e0e0e
594     \& URxvt.foreground: #4ad5e1
595     \& URxvt.color0: #000000
596     \& URxvt.color8: #8b8f93
597     \& URxvt.color1: #dc74d1
598     \& URxvt.color9: #dc74d1
599     \& URxvt.color2: #0eb8c7
600     \& URxvt.color10: #0eb8c7
601     \& URxvt.color3: #dfe37e
602     \& URxvt.color11: #dfe37e
603     \& URxvt.color5: #9e88f0
604     \& URxvt.color13: #9e88f0
605     \& URxvt.color6: #73f7ff
606     \& URxvt.color14: #73f7ff
607     \& URxvt.color7: #e1dddd
608     \& URxvt.color15: #e1dddd
609     .Ve
610 root 1.59 .PP
611 root 1.68 They have been described (not by me) as \*(L"pretty girly\*(R".
612     .PP
613     \fIWhy do some characters look so much different than others?\fR
614     .IX Subsection "Why do some characters look so much different than others?"
615     .PP
616     See next entry.
617 root 1.66 .PP
618 root 1.62 \fIHow does rxvt-unicode choose fonts?\fR
619     .IX Subsection "How does rxvt-unicode choose fonts?"
620     .PP
621     Most fonts do not contain the full range of Unicode, which is
622     fine. Chances are that the font you (or the admin/package maintainer of
623     your system/os) have specified does not cover all the characters you want
624     to display.
625 root 1.59 .PP
626 root 1.62 \&\fBrxvt-unicode\fR makes a best-effort try at finding a replacement
627     font. Often the result is fine, but sometimes the chosen font looks
628     bad/ugly/wrong. Some fonts have totally strange characters that don't
629     resemble the correct glyph at all, and rxvt-unicode lacks the artificial
630     intelligence to detect that a specific glyph is wrong: it has to believe
631     the font that the characters it claims to contain indeed look correct.
632 root 1.59 .PP
633 root 1.62 In that case, select a font of your taste and add it to the font list,
634     e.g.:
635 root 1.59 .PP
636 root 1.62 .Vb 1
637 root 1.95 \& @@URXVT_NAME@@ \-fn basefont,font2,font3...
638 root 1.1 .Ve
639 root 1.59 .PP
640 root 1.62 When rxvt-unicode sees a character, it will first look at the base
641     font. If the base font does not contain the character, it will go to the
642     next font, and so on. Specifying your own fonts will also speed up this
643     search and use less resources within rxvt-unicode and the X\-server.
644     .PP
645     The only limitation is that none of the fonts may be larger than the base
646     font, as the base font defines the terminal character cell size, which
647     must be the same due to the way terminals work.
648 root 1.69 .PP
649     \fIWhy do some chinese characters look so different than others?\fR
650     .IX Subsection "Why do some chinese characters look so different than others?"
651     .PP
652     This is because there is a difference between script and language \*(--
653     rxvt-unicode does not know which language the text that is output is,
654     as it only knows the unicode character codes. If rxvt-unicode first
655     sees a japanese/chinese character, it might choose a japanese font for
656     display. Subsequent japanese characters will use that font. Now, many
657     chinese characters aren't represented in japanese fonts, so when the first
658     non-japanese character comes up, rxvt-unicode will look for a chinese font
659     \&\*(-- unfortunately at this point, it will still use the japanese font for
660     chinese characters that are also in the japanese font.
661     .PP
662     The workaround is easy: just tag a chinese font at the end of your font
663     list (see the previous question). The key is to view the font list as
664     a preference list: If you expect more japanese, list a japanese font
665     first. If you expect more chinese, put a chinese font first.
666     .PP
667     In the future it might be possible to switch language preferences at
668     runtime (the internal data structure has no problem with using different
669     fonts for the same character at the same time, but no interface for this
670     has been designed yet).
671     .PP
672 root 1.95 Until then, you might get away with switching fonts at runtime (see \*(L"Can
673     I switch the fonts at runtime?\*(R" later in this document).
674 sasha 1.87 .PP
675     \fIHow can I make mplayer display video correctly?\fR
676     .IX Subsection "How can I make mplayer display video correctly?"
677     .PP
678     We are working on it, in the meantime, as a workaround, use something like:
679     .PP
680     .Vb 1
681 root 1.95 \& @@URXVT_NAME@@ \-b 600 \-geometry 20x1 \-e sh \-c \*(Aqmplayer \-wid $WINDOWID file...\*(Aq
682 sasha 1.87 .Ve
683 root 1.129 .PP
684     \fIWhy is the cursor now blinking in emacs/vi/...?\fR
685     .IX Subsection "Why is the cursor now blinking in emacs/vi/...?"
686     .PP
687     This is likely caused by your editor/program's use of the \f(CW\*(C`cvvis\*(C'\fR
688     terminfo capability. Emacs uses it by default, as well as some versions of
689     vi and possibly other programs.
690     .PP
691     In emacs, you can switch that off by adding this to your \f(CW\*(C`.emacs\*(C'\fR file:
692     .PP
693     .Vb 1
694     \& (setq visible\-cursor nil)
695     .Ve
696     .PP
697     For other programs, if they do not have an option, your have to remove the
698     \&\f(CW\*(C`cvvis\*(C'\fR capability from the terminfo description.
699     .PP
700     When @@URXVT_NAME@@ first added the blinking cursor option, it didn't
701     add a \f(CW\*(C`cvvis\*(C'\fR capability, which served no purpose before. Version 9.21
702     introduced \f(CW\*(C`cvvis\*(C'\fR (and the ability to control blinking independent of
703     cursor shape) for compatibility with other terminals, which traditionally
704     use a blinking cursor for \f(CW\*(C`cvvis\*(C'\fR. This also reflects the intent of
705     programs such as emacs, who expect \f(CW\*(C`cvvis\*(C'\fR to enable a blinking cursor.
706 root 1.100 .SS "Keyboard, Mouse & User Interaction"
707 root 1.62 .IX Subsection "Keyboard, Mouse & User Interaction"
708     \fIThe new selection selects pieces that are too big, how can I select single words?\fR
709     .IX Subsection "The new selection selects pieces that are too big, how can I select single words?"
710     .PP
711     If you want to select e.g. alphanumeric words, you can use the following
712     setting:
713     .PP
714     .Vb 1
715 root 1.95 \& URxvt.selection.pattern\-0: ([[:word:]]+)
716 root 1.1 .Ve
717 root 1.59 .PP
718 root 1.62 If you click more than twice, the selection will be extended
719     more and more.
720 root 1.59 .PP
721 root 1.62 To get a selection that is very similar to the old code, try this pattern:
722 root 1.59 .PP
723 root 1.62 .Vb 1
724 root 1.95 \& URxvt.selection.pattern\-0: ([^"&\*(Aq()*,;<=>?@[\e\e\e\e]^\`{|})]+)
725 root 1.1 .Ve
726 root 1.59 .PP
727 root 1.94 Please also note that the \fILeftClick Shift-LeftClick\fR combination also
728 root 1.62 selects words like the old code.
729     .PP
730     \fII don't like the new selection/popups/hotkeys/perl, how do I change/disable it?\fR
731     .IX Subsection "I don't like the new selection/popups/hotkeys/perl, how do I change/disable it?"
732     .PP
733     You can disable the perl extension completely by setting the
734     \&\fBperl-ext-common\fR resource to the empty string, which also keeps
735     rxvt-unicode from initialising perl, saving memory.
736     .PP
737     If you only want to disable specific features, you first have to
738     identify which perl extension is responsible. For this, read the section
739 root 1.128 \&\fB\s-1PREPACKAGED EXTENSIONS\s0\fR in the @@URXVT_NAME@@\fIperl\fR\|(3) manpage. For
740 root 1.62 example, to disable the \fBselection-popup\fR and \fBoption-popup\fR, specify
741     this \fBperl-ext-common\fR resource:
742     .PP
743     .Vb 1
744 root 1.95 \& URxvt.perl\-ext\-common: default,\-selection\-popup,\-option\-popup
745 root 1.1 .Ve
746 root 1.59 .PP
747 root 1.62 This will keep the default extensions, but disable the two popup
748     extensions. Some extensions can also be configured, for example,
749     scrollback search mode is triggered by \fBM\-s\fR. You can move it to any
750     other combination either by setting the \fBsearchable-scrollback\fR resource:
751 root 1.59 .PP
752 root 1.62 .Vb 1
753 root 1.95 \& URxvt.searchable\-scrollback: CM\-s
754 root 1.62 .Ve
755 root 1.59 .PP
756 root 1.62 \fIThe cursor moves when selecting text in the current input line, how do I switch this off?\fR
757     .IX Subsection "The cursor moves when selecting text in the current input line, how do I switch this off?"
758 root 1.59 .PP
759 root 1.62 See next entry.
760 root 1.59 .PP
761 root 1.62 \fIDuring rlogin/ssh/telnet/etc. sessions, clicking near the cursor outputs strange escape sequences, how do I fix this?\fR
762     .IX Subsection "During rlogin/ssh/telnet/etc. sessions, clicking near the cursor outputs strange escape sequences, how do I fix this?"
763     .PP
764     These are caused by the \f(CW\*(C`readline\*(C'\fR perl extension. Under normal
765     circumstances, it will move your cursor around when you click into the
766     line that contains it. It tries hard not to do this at the wrong moment,
767     but when running a program that doesn't parse cursor movements or in some
768     cases during rlogin sessions, it fails to detect this properly.
769     .PP
770 root 1.79 You can permanently switch this feature off by disabling the \f(CW\*(C`readline\*(C'\fR
771 root 1.62 extension:
772     .PP
773     .Vb 1
774 root 1.95 \& URxvt.perl\-ext\-common: default,\-readline
775 root 1.62 .Ve
776     .PP
777 root 1.126 \fIMy numeric keypad acts weird and generates differing output?\fR
778     .IX Subsection "My numeric keypad acts weird and generates differing output?"
779 root 1.62 .PP
780 root 1.126 Some Debian GNU/Linux users seem to have this problem, although no
781 root 1.62 specific details were reported so far. It is possible that this is caused
782 root 1.79 by the wrong \f(CW\*(C`TERM\*(C'\fR setting, although the details of whether and how
783 root 1.62 this can happen are unknown, as \f(CW\*(C`TERM=rxvt\*(C'\fR should offer a compatible
784     keymap. See the answer to the previous question, and please report if that
785     helped.
786     .PP
787     \fIMy Compose (Multi_key) key is no longer working.\fR
788     .IX Subsection "My Compose (Multi_key) key is no longer working."
789     .PP
790     The most common causes for this are that either your locale is not set
791 root 1.125 correctly, or you specified a \fBpreeditType\fR that is not supported by
792 root 1.62 your input method. For example, if you specified \fBOverTheSpot\fR and
793     your input method (e.g. the default input method handling Compose keys)
794     does not support this (for instance because it is not visual), then
795     rxvt-unicode will continue without an input method.
796     .PP
797 root 1.125 In this case either do not specify a \fBpreeditType\fR or specify more than
798 root 1.62 one pre-edit style, such as \fBOverTheSpot,Root,None\fR.
799     .PP
800 root 1.100 If it still doesn't work, then maybe your input method doesn't support
801     compose sequences \- to fall back to the built-in one, make sure you don't
802     specify an input method via \f(CW\*(C`\-im\*(C'\fR or \f(CW\*(C`XMODIFIERS\*(C'\fR.
803     .PP
804 root 1.128 \fII cannot type \f(CI\*(C`Ctrl\-Shift\-2\*(C'\fI to get an \s-1ASCII NUL\s0 character due to \s-1ISO 14755\s0\fR
805 root 1.62 .IX Subsection "I cannot type Ctrl-Shift-2 to get an ASCII NUL character due to ISO 14755"
806     .PP
807 root 1.128 Either try \f(CW\*(C`Ctrl\-2\*(C'\fR alone (it often is mapped to \s-1ASCII NUL\s0 even on
808     international keyboards) or simply use \s-1ISO 14755\s0 support to your
809     advantage, typing <Ctrl\-Shift\-0> to get a \s-1ASCII NUL.\s0 This works for other
810 root 1.62 codes, too, such as \f(CW\*(C`Ctrl\-Shift\-1\-d\*(C'\fR to type the default telnet escape
811     character and so on.
812     .PP
813     \fIMouse cut/paste suddenly no longer works.\fR
814     .IX Subsection "Mouse cut/paste suddenly no longer works."
815     .PP
816     Make sure that mouse reporting is actually turned off since killing
817 sf-exg 1.108 some editors prematurely may leave it active. I've
818     heard that tcsh may use mouse reporting unless it is otherwise specified. A
819 root 1.62 quick check is to see if cut/paste works when the Alt or Shift keys are
820 sf-exg 1.108 pressed.
821 root 1.62 .PP
822     \fIWhat's with the strange Backspace/Delete key behaviour?\fR
823     .IX Subsection "What's with the strange Backspace/Delete key behaviour?"
824     .PP
825     Assuming that the physical Backspace key corresponds to the
826 root 1.79 Backspace keysym (not likely for Linux ... see the following
827 root 1.62 question) there are two standard values that can be used for
828     Backspace: \f(CW\*(C`^H\*(C'\fR and \f(CW\*(C`^?\*(C'\fR.
829     .PP
830     Historically, either value is correct, but rxvt-unicode adopts the debian
831 root 1.83 policy of using \f(CW\*(C`^?\*(C'\fR when unsure, because it's the one and only correct
832 root 1.62 choice :).
833     .PP
834 root 1.103 It is possible to toggle between \f(CW\*(C`^H\*(C'\fR and \f(CW\*(C`^?\*(C'\fR with the \s-1DECBKM\s0
835     private mode:
836 root 1.62 .PP
837     .Vb 3
838     \& # use Backspace = ^H
839     \& $ stty erase ^H
840 root 1.119 \& $ printf "\ee[?67h"
841 root 1.95 \&
842 root 1.62 \& # use Backspace = ^?
843     \& $ stty erase ^?
844 root 1.119 \& $ printf "\ee[?67l"
845 root 1.62 .Ve
846     .PP
847     This helps satisfy some of the Backspace discrepancies that occur, but
848     if you use Backspace = \f(CW\*(C`^H\*(C'\fR, make sure that the termcap/terminfo value
849     properly reflects that.
850     .PP
851     The Delete key is a another casualty of the ill-defined Backspace problem.
852     To avoid confusion between the Backspace and Delete keys, the Delete
853     key has been assigned an escape sequence to match the vt100 for Execute
854     (\f(CW\*(C`ESC [ 3 ~\*(C'\fR) and is in the supplied termcap/terminfo.
855     .PP
856     Some other Backspace problems:
857     .PP
858 root 1.89 some editors use termcap/terminfo,
859 root 1.62 some editors (vim I'm told) expect Backspace = ^H,
860     \&\s-1GNU\s0 Emacs (and Emacs-like editors) use ^H for help.
861     .PP
862     Perhaps someday this will all be resolved in a consistent manner.
863     .PP
864 root 1.95 \fII don't like the key-bindings. How do I change them?\fR
865 root 1.128 .IX Subsection "I don't like the key-bindings. How do I change them?"
866 root 1.62 .PP
867     There are some compile-time selections available via configure. Unless
868     you have run \*(L"configure\*(R" with the \f(CW\*(C`\-\-disable\-resources\*(C'\fR option you can
869     use the `keysym' resource to alter the keystrings associated with keysyms.
870 root 1.59 .PP
871 root 1.63 Here's an example for a URxvt session started using \f(CW\*(C`@@URXVT_NAME@@ \-name URxvt\*(C'\fR
872 root 1.59 .PP
873 sf-exg 1.108 .Vb 8
874     \& URxvt.keysym.Prior: \e033[5~
875     \& URxvt.keysym.Next: \e033[6~
876     \& URxvt.keysym.Home: \e033[7~
877     \& URxvt.keysym.End: \e033[8~
878     \& URxvt.keysym.Up: \e033[A
879     \& URxvt.keysym.Down: \e033[B
880     \& URxvt.keysym.Right: \e033[C
881     \& URxvt.keysym.Left: \e033[D
882 root 1.1 .Ve
883 root 1.59 .PP
884 root 1.5 See some more examples in the documentation for the \fBkeysym\fR resource.
885 root 1.62 .PP
886     \fII'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 map\fR
887     .IX Subsection "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 map"
888     .PP
889 root 1.1 .Vb 6
890     \& KP_Insert == Insert
891     \& F22 == Print
892     \& F27 == Home
893     \& F29 == Prior
894     \& F33 == End
895     \& F35 == Next
896     .Ve
897 root 1.59 .PP
898 root 1.5 Rather than have rxvt-unicode try to accommodate all the various possible
899     keyboard mappings, it is better to use `xmodmap' to remap the keys as
900     required for your particular machine.
901 root 1.100 .SS "Terminal Configuration"
902 root 1.62 .IX Subsection "Terminal Configuration"
903 root 1.73 \fICan I see a typical configuration?\fR
904     .IX Subsection "Can I see a typical configuration?"
905     .PP
906 root 1.95 The default configuration tries to be xterm-like, which I don't like that
907 root 1.73 much, but it's least surprise to regular users.
908     .PP
909     As a rxvt or rxvt-unicode user, you are practically supposed to invest
910     time into customising your terminal. To get you started, here is the
911 root 1.74 author's .Xdefaults entries, with comments on what they do. It's certainly
912     not \fItypical\fR, but what's typical...
913 root 1.73 .PP
914     .Vb 2
915 root 1.95 \& URxvt.cutchars: "()*,<>[]{}|\*(Aq
916     \& URxvt.print\-pipe: cat >/tmp/xxx
917 root 1.73 .Ve
918     .PP
919     These are just for testing stuff.
920     .PP
921     .Vb 2
922 root 1.95 \& URxvt.imLocale: ja_JP.UTF\-8
923 root 1.73 \& URxvt.preeditType: OnTheSpot,None
924     .Ve
925     .PP
926     This tells rxvt-unicode to use a special locale when communicating with
927     the X Input Method, and also tells it to only use the OnTheSpot pre-edit
928     type, which requires the \f(CW\*(C`xim\-onthespot\*(C'\fR perl extension but rewards me
929     with correct-looking fonts.
930     .PP
931     .Vb 6
932 root 1.95 \& URxvt.perl\-lib: /root/lib/urxvt
933     \& URxvt.perl\-ext\-common: default,selection\-autotransform,selection\-pastebin,xim\-onthespot,remote\-clipboard
934     \& URxvt.selection.pattern\-0: ( at .*? line \e\ed+)
935     \& URxvt.selection.pattern\-1: ^(/[^:]+):\e
936     \& URxvt.selection\-autotransform.0: s/^([^:[:space:]]+):(\e\ed+):?$/:e \e\eQ$1\e\eE\e\ex0d:$2\e\ex0d/
937     \& URxvt.selection\-autotransform.1: s/^ at (.*?) line (\e\ed+)$/:e \e\eQ$1\e\eE\e\ex0d:$2\e\ex0d/
938 root 1.73 .Ve
939     .PP
940     This is my perl configuration. The first two set the perl library
941     directory and also tells urxvt to use a large number of extensions. I
942     develop for myself mostly, so I actually use most of the extensions I
943     write.
944     .PP
945     The selection stuff mainly makes the selection perl-error-message aware
946 root 1.79 and tells it to convert perl error messages into vi-commands to load the
947 root 1.101 relevant file and go to the error line number.
948 root 1.73 .PP
949     .Vb 2
950     \& URxvt.scrollstyle: plain
951     \& URxvt.secondaryScroll: true
952     .Ve
953     .PP
954     As the documentation says: plain is the preferred scrollbar for the
955 root 1.79 author. The \f(CW\*(C`secondaryScroll\*(C'\fR configures urxvt to scroll in full-screen
956     apps, like screen, so lines scrolled out of screen end up in urxvt's
957 root 1.73 scrollback buffer.
958     .PP
959     .Vb 7
960     \& URxvt.background: #000000
961     \& URxvt.foreground: gray90
962     \& URxvt.color7: gray90
963     \& URxvt.colorBD: #ffffff
964     \& URxvt.cursorColor: #e0e080
965     \& URxvt.throughColor: #8080f0
966     \& URxvt.highlightColor: #f0f0f0
967     .Ve
968     .PP
969 root 1.95 Some colours. Not sure which ones are being used or even non-defaults, but
970 root 1.73 these are in my .Xdefaults. Most notably, they set foreground/background
971     to light gray/black, and also make sure that the colour 7 matches the
972     default foreground colour.
973     .PP
974     .Vb 1
975     \& URxvt.underlineColor: yellow
976     .Ve
977     .PP
978     Another colour, makes underline lines look different. Sometimes hurts, but
979     is mostly a nice effect.
980     .PP
981     .Vb 4
982     \& URxvt.geometry: 154x36
983     \& URxvt.loginShell: false
984     \& URxvt.meta: ignore
985     \& URxvt.utmpInhibit: true
986     .Ve
987     .PP
988 root 1.95 Uh, well, should be mostly self-explanatory. By specifying some defaults
989 root 1.73 manually, I can quickly switch them for testing.
990     .PP
991     .Vb 1
992     \& URxvt.saveLines: 8192
993     .Ve
994     .PP
995     A large scrollback buffer is essential. Really.
996     .PP
997     .Vb 1
998     \& URxvt.mapAlert: true
999     .Ve
1000     .PP
1001     The only case I use it is for my \s-1IRC\s0 window, which I like to keep
1002     iconified till people msg me (which beeps).
1003     .PP
1004     .Vb 1
1005     \& URxvt.visualBell: true
1006     .Ve
1007     .PP
1008     The audible bell is often annoying, especially when in a crowd.
1009     .PP
1010     .Vb 1
1011     \& URxvt.insecure: true
1012     .Ve
1013     .PP
1014     Please don't hack my mutt! Ooops...
1015     .PP
1016     .Vb 1
1017     \& URxvt.pastableTabs: false
1018     .Ve
1019     .PP
1020     I once thought this is a great idea.
1021     .PP
1022     .Vb 9
1023     \& urxvt.font: 9x15bold,\e
1024 root 1.95 \& \-misc\-fixed\-bold\-r\-normal\-\-15\-140\-75\-75\-c\-90\-iso10646\-1,\e
1025     \& \-misc\-fixed\-medium\-r\-normal\-\-15\-140\-75\-75\-c\-90\-iso10646\-1, \e
1026 root 1.73 \& [codeset=JISX0208]xft:Kochi Gothic, \e
1027     \& xft:Bitstream Vera Sans Mono:autohint=true, \e
1028     \& xft:Code2000:antialias=false
1029 root 1.95 \& urxvt.boldFont: \-xos4\-terminus\-bold\-r\-normal\-\-14\-140\-72\-72\-c\-80\-iso8859\-15
1030 root 1.73 \& urxvt.italicFont: xft:Bitstream Vera Sans Mono:italic:autohint=true
1031     \& urxvt.boldItalicFont: xft:Bitstream Vera Sans Mono:bold:italic:autohint=true
1032     .Ve
1033     .PP
1034     I wrote rxvt-unicode to be able to specify fonts exactly. So don't be
1035 root 1.79 overwhelmed. A special note: the \f(CW\*(C`9x15bold\*(C'\fR mentioned above is actually
1036 root 1.73 the version from XFree\-3.3, as XFree\-4 replaced it by a totally different
1037     font (different glyphs for \f(CW\*(C`;\*(C'\fR and many other harmless characters),
1038     while the second font is actually the \f(CW\*(C`9x15bold\*(C'\fR from XFree4/XOrg. The
1039     bold version has less chars than the medium version, so I use it for rare
1040 root 1.79 characters, too. When editing sources with vim, I use italic for comments
1041 root 1.95 and other stuff, which looks quite good with Bitstream Vera anti-aliased.
1042 root 1.73 .PP
1043     Terminus is a quite bad font (many very wrong glyphs), but for most of my
1044 root 1.95 purposes, it works, and gives a different look, as my normal (Non-bold)
1045 root 1.73 font is already bold, and I want to see a difference between bold and
1046     normal fonts.
1047     .PP
1048     Please note that I used the \f(CW\*(C`urxvt\*(C'\fR instance name and not the \f(CW\*(C`URxvt\*(C'\fR
1049 root 1.101 class name. That is because I use different configs for different purposes,
1050 root 1.73 for example, my \s-1IRC\s0 window is started with \f(CW\*(C`\-name IRC\*(C'\fR, and uses these
1051     defaults:
1052     .PP
1053     .Vb 9
1054     \& IRC*title: IRC
1055     \& IRC*geometry: 87x12+535+542
1056     \& IRC*saveLines: 0
1057     \& IRC*mapAlert: true
1058     \& IRC*font: suxuseuro
1059     \& IRC*boldFont: suxuseuro
1060     \& IRC*colorBD: white
1061 root 1.95 \& IRC*keysym.M\-C\-1: command:\e033]710;suxuseuro\e007\e033]711;suxuseuro\e007
1062     \& IRC*keysym.M\-C\-2: command:\e033]710;9x15bold\e007\e033]711;9x15bold\e007
1063 root 1.73 .Ve
1064     .PP
1065 root 1.100 \&\f(CW\*(C`Alt\-Ctrl\-1\*(C'\fR and \f(CW\*(C`Alt\-Ctrl\-2\*(C'\fR switch between two different font
1066 root 1.73 sizes. \f(CW\*(C`suxuseuro\*(C'\fR allows me to keep an eye (and actually read)
1067     stuff while keeping a very small window. If somebody pastes something
1068     complicated (e.g. japanese), I temporarily switch to a larger font.
1069     .PP
1070     The above is all in my \f(CW\*(C`.Xdefaults\*(C'\fR (I don't use \f(CW\*(C`.Xresources\*(C'\fR nor
1071     \&\f(CW\*(C`xrdb\*(C'\fR). I also have some resources in a separate \f(CW\*(C`.Xdefaults\-hostname\*(C'\fR
1072 root 1.103 file for different hosts, for example, on my main desktop, I use:
1073 root 1.73 .PP
1074     .Vb 5
1075 root 1.95 \& URxvt.keysym.C\-M\-q: command:\e033[3;5;5t
1076     \& URxvt.keysym.C\-M\-y: command:\e033[3;5;606t
1077     \& URxvt.keysym.C\-M\-e: command:\e033[3;1605;5t
1078     \& URxvt.keysym.C\-M\-c: command:\e033[3;1605;606t
1079     \& URxvt.keysym.C\-M\-p: perl:test
1080 root 1.73 .Ve
1081     .PP
1082     The first for keysym definitions allow me to quickly bring some windows
1083     in the layout I like most. Ion users might start laughing but will stop
1084     immediately when I tell them that I use my own Fvwm2 module for much the
1085     same effect as Ion provides, and I only very rarely use the above key
1086     combinations :\->
1087     .PP
1088 root 1.62 \fIWhy doesn't rxvt-unicode read my resources?\fR
1089     .IX Subsection "Why doesn't rxvt-unicode read my resources?"
1090     .PP
1091     Well, why, indeed? It does, in a way very similar to other X
1092     applications. Most importantly, this means that if you or your \s-1OS\s0 loads
1093     resources into the X display (the right way to do it), rxvt-unicode will
1094     ignore any resource files in your home directory. It will only read
1095 root 1.95 \&\fI\f(CI$HOME\fI/.Xdefaults\fR when no resources are attached to the display.
1096 root 1.62 .PP
1097 root 1.95 If you have or use an \fI\f(CI$HOME\fI/.Xresources\fR file, chances are that
1098 root 1.62 resources are loaded into your X\-server. In this case, you have to
1099     re-login after every change (or run \fIxrdb \-merge \f(CI$HOME\fI/.Xresources\fR).
1100     .PP
1101     Also consider the form resources have to use:
1102     .PP
1103     .Vb 1
1104     \& URxvt.resource: value
1105     .Ve
1106     .PP
1107     If you want to use another form (there are lots of different ways of
1108 root 1.79 specifying resources), make sure you understand whether and why it
1109 root 1.62 works. If unsure, use the form above.
1110     .PP
1111     \fIWhen I log-in to another system it tells me about missing terminfo data?\fR
1112     .IX Subsection "When I log-in to another system it tells me about missing terminfo data?"
1113     .PP
1114     The terminal description used by rxvt-unicode is not as widely available
1115     as that for xterm, or even rxvt (for which the same problem often arises).
1116     .PP
1117     The correct solution for this problem is to install the terminfo, this can
1118 root 1.100 be done by simply installing rxvt-unicode on the remote system as well
1119     (in case you have a nice package manager ready), or you can install the
1120     terminfo database manually like this (with ncurses infocmp. works as
1121     user and root):
1122 root 1.62 .PP
1123     .Vb 2
1124     \& REMOTE=remotesystem.domain
1125 root 1.95 \& infocmp rxvt\-unicode | ssh $REMOTE "mkdir \-p .terminfo && cat >/tmp/ti && tic /tmp/ti"
1126 root 1.62 .Ve
1127     .PP
1128 root 1.80 One some systems you might need to set \f(CW$TERMINFO\fR to the full path of
1129 root 1.126 \&\fI\f(CI$HOME\fI/.terminfo\fR for this to work.
1130 root 1.80 .PP
1131 root 1.62 If you cannot or do not want to do this, then you can simply set
1132     \&\f(CW\*(C`TERM=rxvt\*(C'\fR or even \f(CW\*(C`TERM=xterm\*(C'\fR, and live with the small number of
1133     problems arising, which includes wrong keymapping, less and different
1134     colours and some refresh errors in fullscreen applications. It's a nice
1135     quick-and-dirty workaround for rare cases, though.
1136     .PP
1137     If you always want to do this (and are fine with the consequences) you
1138     can either recompile rxvt-unicode with the desired \s-1TERM\s0 value or use a
1139     resource to set it:
1140     .PP
1141     .Vb 1
1142     \& URxvt.termName: rxvt
1143     .Ve
1144     .PP
1145     If you don't plan to use \fBrxvt\fR (quite common...) you could also replace
1146 root 1.65 the rxvt terminfo file with the rxvt-unicode one and use \f(CW\*(C`TERM=rxvt\*(C'\fR.
1147 root 1.62 .PP
1148 root 1.100 \fInano fails with \*(L"Error opening terminal: rxvt-unicode\*(R"\fR
1149     .IX Subsection "nano fails with Error opening terminal: rxvt-unicode"
1150     .PP
1151     This exceptionally confusing and useless error message is printed by nano
1152     when it can't find the terminfo database. Nothing is wrong with your
1153     terminal, read the previous answer for a solution.
1154     .PP
1155 root 1.62 \fI\f(CI\*(C`tic\*(C'\fI outputs some error when compiling the terminfo entry.\fR
1156     .IX Subsection "tic outputs some error when compiling the terminfo entry."
1157     .PP
1158     Most likely it's the empty definition for \f(CW\*(C`enacs=\*(C'\fR. Just replace it by
1159     \&\f(CW\*(C`enacs=\eE[0@\*(C'\fR and try again.
1160     .PP
1161 root 1.63 \fI\f(CI\*(C`bash\*(C'\fI's readline does not work correctly under @@URXVT_NAME@@.\fR
1162     .IX Subsection "bash's readline does not work correctly under @@URXVT_NAME@@."
1163 root 1.62 .PP
1164     See next entry.
1165     .PP
1166     \fII need a termcap file entry.\fR
1167     .IX Subsection "I need a termcap file entry."
1168     .PP
1169     One reason you might want this is that some distributions or operating
1170     systems still compile some programs using the long-obsoleted termcap
1171     library (Fedora Core's bash is one example) and rely on a termcap entry
1172     for \f(CW\*(C`rxvt\-unicode\*(C'\fR.
1173     .PP
1174 root 1.79 You could use rxvt's termcap entry with reasonable results in many cases.
1175 root 1.62 You can also create a termcap entry by using terminfo's infocmp program
1176     like this:
1177     .PP
1178     .Vb 1
1179 root 1.95 \& infocmp \-C rxvt\-unicode
1180 root 1.62 .Ve
1181     .PP
1182 root 1.97 Or you could use the termcap entry in doc/etc/rxvt\-unicode.termcap,
1183     generated by the command above.
1184 root 1.62 .PP
1185     \fIWhy does \f(CI\*(C`ls\*(C'\fI no longer have coloured output?\fR
1186     .IX Subsection "Why does ls no longer have coloured output?"
1187 root 1.59 .PP
1188 root 1.62 The \f(CW\*(C`ls\*(C'\fR in the \s-1GNU\s0 coreutils unfortunately doesn't use terminfo to
1189 root 1.79 decide whether a terminal has colour, but uses its own configuration
1190 root 1.77 file. Needless to say, \f(CW\*(C`rxvt\-unicode\*(C'\fR is not in its default file (among
1191 root 1.62 with most other terminals supporting colour). Either add:
1192 root 1.59 .PP
1193 root 1.62 .Vb 1
1194 root 1.95 \& TERM rxvt\-unicode
1195 root 1.1 .Ve
1196 root 1.62 .PP
1197     to \f(CW\*(C`/etc/DIR_COLORS\*(C'\fR or simply add:
1198     .PP
1199     .Vb 1
1200 root 1.95 \& alias ls=\*(Aqls \-\-color=auto\*(Aq
1201 root 1.62 .Ve
1202     .PP
1203     to your \f(CW\*(C`.profile\*(C'\fR or \f(CW\*(C`.bashrc\*(C'\fR.
1204     .PP
1205     \fIWhy doesn't vim/emacs etc. use the 88 colour mode?\fR
1206     .IX Subsection "Why doesn't vim/emacs etc. use the 88 colour mode?"
1207     .PP
1208     See next entry.
1209     .PP
1210     \fIWhy doesn't vim/emacs etc. make use of italic?\fR
1211     .IX Subsection "Why doesn't vim/emacs etc. make use of italic?"
1212     .PP
1213     See next entry.
1214     .PP
1215     \fIWhy are the secondary screen-related options not working properly?\fR
1216     .IX Subsection "Why are the secondary screen-related options not working properly?"
1217     .PP
1218     Make sure you are using \f(CW\*(C`TERM=rxvt\-unicode\*(C'\fR. Some pre-packaged
1219 root 1.126 distributions break rxvt-unicode by setting \f(CW\*(C`TERM\*(C'\fR to \f(CW\*(C`rxvt\*(C'\fR, which
1220     doesn't have these extra features. Unfortunately, some of these
1221     furthermore fail to even install the \f(CW\*(C`rxvt\-unicode\*(C'\fR terminfo file, so
1222     you will need to install it on your own (See the question \fBWhen I
1223     log-in to another system it tells me about missing terminfo data?\fR on
1224 root 1.62 how to do this).
1225 root 1.100 .SS "Encoding / Locale / Input Method Issues"
1226 root 1.62 .IX Subsection "Encoding / Locale / Input Method Issues"
1227     \fIRxvt-unicode does not seem to understand the selected encoding?\fR
1228     .IX Subsection "Rxvt-unicode does not seem to understand the selected encoding?"
1229     .PP
1230     See next entry.
1231     .PP
1232     \fIUnicode does not seem to work?\fR
1233     .IX Subsection "Unicode does not seem to work?"
1234     .PP
1235     If you encounter strange problems like typing an accented character but
1236     getting two unrelated other characters or similar, or if program output is
1237     subtly garbled, then you should check your locale settings.
1238     .PP
1239     Rxvt-unicode must be started with the same \f(CW\*(C`LC_CTYPE\*(C'\fR setting as the
1240 root 1.82 programs running in it. Often rxvt-unicode is started in the \f(CW\*(C`C\*(C'\fR locale,
1241     while the login script running within the rxvt-unicode window changes the
1242     locale to something else, e.g. \f(CW\*(C`en_GB.UTF\-8\*(C'\fR. Needless to say, this is
1243     not going to work, and is the most common cause for problems.
1244 root 1.62 .PP
1245     The best thing is to fix your startup environment, as you will likely run
1246     into other problems. If nothing works you can try this in your .profile.
1247     .PP
1248     .Vb 1
1249 root 1.95 \& printf \*(Aq\e33]701;%s\e007\*(Aq "$LC_CTYPE" # $LANG or $LC_ALL are worth a try, too
1250 root 1.62 .Ve
1251     .PP
1252     If this doesn't work, then maybe you use a \f(CW\*(C`LC_CTYPE\*(C'\fR specification not
1253     supported on your systems. Some systems have a \f(CW\*(C`locale\*(C'\fR command which
1254     displays this (also, \f(CW\*(C`perl \-e0\*(C'\fR can be used to check locale settings, as
1255     it will complain loudly if it cannot set the locale). If it displays something
1256     like:
1257     .PP
1258     .Vb 1
1259     \& locale: Cannot set LC_CTYPE to default locale: ...
1260     .Ve
1261     .PP
1262     Then the locale you specified is not supported on your system.
1263     .PP
1264     If nothing works and you are sure that everything is set correctly then
1265     you will need to remember a little known fact: Some programs just don't
1266     support locales :(
1267     .PP
1268     \fIHow does rxvt-unicode determine the encoding to use?\fR
1269     .IX Subsection "How does rxvt-unicode determine the encoding to use?"
1270     .PP
1271     See next entry.
1272     .PP
1273     \fIIs there an option to switch encodings?\fR
1274     .IX Subsection "Is there an option to switch encodings?"
1275     .PP
1276     Unlike some other terminals, rxvt-unicode has no encoding switch, and no
1277     specific \*(L"utf\-8\*(R" mode, such as xterm. In fact, it doesn't even know about
1278     \&\s-1UTF\-8\s0 or any other encodings with respect to terminal I/O.
1279     .PP
1280     The reasons is that there exists a perfectly fine mechanism for selecting
1281     the encoding, doing I/O and (most important) communicating this to all
1282     applications so everybody agrees on character properties such as width
1283     and code number. This mechanism is the \fIlocale\fR. Applications not using
1284     that info will have problems (for example, \f(CW\*(C`xterm\*(C'\fR gets the width of
1285 root 1.77 characters wrong as it uses its own, locale-independent table under all
1286 root 1.62 locales).
1287     .PP
1288     Rxvt-unicode uses the \f(CW\*(C`LC_CTYPE\*(C'\fR locale category to select encoding. All
1289     programs doing the same (that is, most) will automatically agree in the
1290     interpretation of characters.
1291     .PP
1292     Unfortunately, there is no system-independent way to select locales, nor
1293     is there a standard on how locale specifiers will look like.
1294     .PP
1295     On most systems, the content of the \f(CW\*(C`LC_CTYPE\*(C'\fR environment variable
1296     contains an arbitrary string which corresponds to an already-installed
1297     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,
1298     \&\f(CW\*(C`ja_JP.EUC\-JP\*(C'\fR, i.e. \f(CW\*(C`language_country.encoding\*(C'\fR, but other forms
1299     (i.e. \f(CW\*(C`de\*(C'\fR or \f(CW\*(C`german\*(C'\fR) are also common.
1300     .PP
1301     Rxvt-unicode ignores all other locale categories, and except for
1302     the encoding, ignores country or language-specific settings,
1303     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
1304 root 1.95 rxvt-unicode.
1305 root 1.62 .PP
1306     If you want to use a specific encoding you have to make sure you start
1307     rxvt-unicode with the correct \f(CW\*(C`LC_CTYPE\*(C'\fR category.
1308     .PP
1309     \fICan I switch locales at runtime?\fR
1310     .IX Subsection "Can I switch locales at runtime?"
1311     .PP
1312     Yes, using an escape sequence. Try something like this, which sets
1313 root 1.95 rxvt-unicode's idea of \f(CW\*(C`LC_CTYPE\*(C'\fR.
1314 root 1.62 .PP
1315     .Vb 1
1316 root 1.95 \& printf \*(Aq\e33]701;%s\e007\*(Aq ja_JP.SJIS
1317 root 1.62 .Ve
1318     .PP
1319     See also the previous answer.
1320     .PP
1321     Sometimes this capability is rather handy when you want to work in
1322     one locale (e.g. \f(CW\*(C`de_DE.UTF\-8\*(C'\fR) but some programs don't support it
1323     (e.g. \s-1UTF\-8\s0). For example, I use this script to start \f(CW\*(C`xjdic\*(C'\fR, which
1324     first switches to a locale supported by xjdic and back later:
1325     .PP
1326     .Vb 3
1327 root 1.95 \& printf \*(Aq\e33]701;%s\e007\*(Aq ja_JP.SJIS
1328     \& xjdic \-js
1329     \& printf \*(Aq\e33]701;%s\e007\*(Aq de_DE.UTF\-8
1330 root 1.62 .Ve
1331     .PP
1332     You can also use xterm's \f(CW\*(C`luit\*(C'\fR program, which usually works fine, except
1333     for some locales where character width differs between program\- and
1334 root 1.95 rxvt-unicode-locales.
1335 root 1.62 .PP
1336 root 1.71 \fII have problems getting my input method working.\fR
1337     .IX Subsection "I have problems getting my input method working."
1338     .PP
1339     Try a search engine, as this is slightly different for every input method server.
1340     .PP
1341     Here is a checklist:
1342 root 1.128 .IP "\- Make sure your locale \fIand\fR the imLocale are supported on your \s-1OS.\s0" 4
1343 root 1.71 .IX Item "- Make sure your locale and the imLocale are supported on your OS."
1344 root 1.128 Try \f(CW\*(C`locale \-a\*(C'\fR or check the documentation for your \s-1OS.\s0
1345     .IP "\- Make sure your locale or imLocale matches a locale supported by your \s-1XIM.\s0" 4
1346 root 1.71 .IX Item "- Make sure your locale or imLocale matches a locale supported by your XIM."
1347     For example, \fBkinput2\fR does not support \s-1UTF\-8\s0 locales, you should use
1348     \&\f(CW\*(C`ja_JP.EUC\-JP\*(C'\fR or equivalent.
1349     .IP "\- Make sure your \s-1XIM\s0 server is actually running." 4
1350     .IX Item "- Make sure your XIM server is actually running."
1351     .PD 0
1352 root 1.100 .ie n .IP "\- Make sure the ""XMODIFIERS"" environment variable is set correctly when \fIstarting\fR rxvt-unicode." 4
1353 root 1.95 .el .IP "\- Make sure the \f(CWXMODIFIERS\fR environment variable is set correctly when \fIstarting\fR rxvt-unicode." 4
1354 root 1.71 .IX Item "- Make sure the XMODIFIERS environment variable is set correctly when starting rxvt-unicode."
1355     .PD
1356     When you want to use e.g. \fBkinput2\fR, it must be set to
1357 root 1.79 \&\f(CW\*(C`@im=kinput2\*(C'\fR. For \fBscim\fR, use \f(CW\*(C`@im=SCIM\*(C'\fR. You can see what input
1358 root 1.71 method servers are running with this command:
1359     .Sp
1360     .Vb 1
1361 root 1.95 \& xprop \-root XIM_SERVERS
1362 root 1.71 .Ve
1363     .PP
1364 root 1.128 \fIMy input method wants <some encoding> but I want \s-1UTF\-8,\s0 what can I do?\fR
1365 root 1.62 .IX Subsection "My input method wants <some encoding> but I want UTF-8, what can I do?"
1366     .PP
1367     You can specify separate locales for the input method and the rest of the
1368     terminal, using the resource \f(CW\*(C`imlocale\*(C'\fR:
1369     .PP
1370     .Vb 1
1371 root 1.95 \& URxvt.imlocale: ja_JP.EUC\-JP
1372 root 1.62 .Ve
1373     .PP
1374     Now you can start your terminal with \f(CW\*(C`LC_CTYPE=ja_JP.UTF\-8\*(C'\fR and still
1375 root 1.71 use your input method. Please note, however, that, depending on your Xlib
1376     version, you may not be able to input characters outside \f(CW\*(C`EUC\-JP\*(C'\fR in a
1377     normal way then, as your input method limits you.
1378 root 1.62 .PP
1379     \fIRxvt-unicode crashes when the X Input Method changes or exits.\fR
1380     .IX Subsection "Rxvt-unicode crashes when the X Input Method changes or exits."
1381     .PP
1382     Unfortunately, this is unavoidable, as the \s-1XIM\s0 protocol is racy by
1383     design. Applications can avoid some crashes at the expense of memory
1384     leaks, and Input Methods can avoid some crashes by careful ordering at
1385     exit time. \fBkinput2\fR (and derived input methods) generally succeeds,
1386     while \fB\s-1SCIM\s0\fR (or similar input methods) fails. In the end, however,
1387     crashes cannot be completely avoided even if both sides cooperate.
1388     .PP
1389     So the only workaround is not to kill your Input Method Servers.
1390 root 1.100 .SS "Operating Systems / Package Maintaining"
1391 root 1.62 .IX Subsection "Operating Systems / Package Maintaining"
1392 root 1.128 \fII am maintaining rxvt-unicode for distribution/OS \s-1XXX,\s0 any recommendation?\fR
1393 root 1.62 .IX Subsection "I am maintaining rxvt-unicode for distribution/OS XXX, any recommendation?"
1394     .PP
1395     You should build one binary with the default options. \fIconfigure\fR
1396     now enables most useful options, and the trend goes to making them
1397 root 1.95 runtime-switchable, too, so there is usually no drawback to enabling them,
1398 root 1.62 except higher disk and possibly memory usage. The perl interpreter should
1399     be enabled, as important functionality (menus, selection, likely more in
1400     the future) depends on it.
1401     .PP
1402 root 1.101 You should not overwrite the \f(CW\*(C`perl\-ext\-common\*(C'\fR and \f(CW\*(C`perl\-ext\*(C'\fR resources
1403 root 1.62 system-wide (except maybe with \f(CW\*(C`defaults\*(C'\fR). This will result in useful
1404     behaviour. If your distribution aims at low memory, add an empty
1405     \&\f(CW\*(C`perl\-ext\-common\*(C'\fR resource to the app-defaults file. This will keep the
1406     perl interpreter disabled until the user enables it.
1407     .PP
1408     If you can/want build more binaries, I recommend building a minimal
1409     one with \f(CW\*(C`\-\-disable\-everything\*(C'\fR (very useful) and a maximal one with
1410     \&\f(CW\*(C`\-\-enable\-everything\*(C'\fR (less useful, it will be very big due to a lot of
1411     encodings built-in that increase download times and are rarely used).
1412     .PP
1413 root 1.128 \fII need to make it setuid/setgid to support utmp/ptys on my \s-1OS,\s0 is this safe?\fR
1414 root 1.62 .IX Subsection "I need to make it setuid/setgid to support utmp/ptys on my OS, is this safe?"
1415     .PP
1416     It should be, starting with release 7.1. You are encouraged to properly
1417     install urxvt with privileges necessary for your \s-1OS\s0 now.
1418     .PP
1419     When rxvt-unicode detects that it runs setuid or setgid, it will fork
1420     into a helper process for privileged operations (pty handling on some
1421     systems, utmp/wtmp/lastlog handling on others) and drop privileges
1422     immediately. This is much safer than most other terminals that keep
1423     privileges while running (but is more relevant to urxvt, as it contains
1424     things as perl interpreters, which might be \*(L"helpful\*(R" to attackers).
1425     .PP
1426     This forking is done as the very first within \fImain()\fR, which is very early
1427     and reduces possible bugs to initialisation code run before \fImain()\fR, or
1428     things like the dynamic loader of your system, which should result in very
1429     little risk.
1430     .PP
1431     \fII am on FreeBSD and rxvt-unicode does not seem to work at all.\fR
1432     .IX Subsection "I am on FreeBSD and rxvt-unicode does not seem to work at all."
1433     .PP
1434     Rxvt-unicode requires the symbol \f(CW\*(C`_\|_STDC_ISO_10646_\|_\*(C'\fR to be defined
1435     in your compile environment, or an implementation that implements it,
1436 root 1.79 whether it defines the symbol or not. \f(CW\*(C`_\|_STDC_ISO_10646_\|_\*(C'\fR requires that
1437 root 1.62 \&\fBwchar_t\fR is represented as unicode.
1438     .PP
1439 root 1.79 As you might have guessed, FreeBSD does neither define this symbol nor
1440 root 1.77 does it support it. Instead, it uses its own internal representation of
1441 root 1.62 \&\fBwchar_t\fR. This is, of course, completely fine with respect to standards.
1442     .PP
1443     However, that means rxvt-unicode only works in \f(CW\*(C`POSIX\*(C'\fR, \f(CW\*(C`ISO\-8859\-1\*(C'\fR and
1444 root 1.97 \&\f(CW\*(C`UTF\-8\*(C'\fR locales under FreeBSD (which all use Unicode as \fBwchar_t\fR).
1445 root 1.62 .PP
1446     \&\f(CW\*(C`_\|_STDC_ISO_10646_\|_\*(C'\fR is the only sane way to support multi-language
1447 root 1.128 apps in an \s-1OS,\s0 as using a locale-dependent (and non-standardized)
1448 root 1.62 representation of \fBwchar_t\fR makes it impossible to convert between
1449     \&\fBwchar_t\fR (as used by X11 and your applications) and any other encoding
1450     without implementing OS-specific-wrappers for each and every locale. There
1451     simply are no APIs to convert \fBwchar_t\fR into anything except the current
1452     locale encoding.
1453     .PP
1454     Some applications (such as the formidable \fBmlterm\fR) work around this
1455     by carrying their own replacement functions for character set handling
1456     with them, and either implementing OS-dependent hacks or doing multiple
1457     conversions (which is slow and unreliable in case the \s-1OS\s0 implements
1458     encodings slightly different than the terminal emulator).
1459     .PP
1460     The rxvt-unicode author insists that the right way to fix this is in the
1461     system libraries once and for all, instead of forcing every app to carry
1462     complete replacements for them :)
1463     .PP
1464     \fIHow can I use rxvt-unicode under cygwin?\fR
1465     .IX Subsection "How can I use rxvt-unicode under cygwin?"
1466     .PP
1467     rxvt-unicode should compile and run out of the box on cygwin, using
1468     the X11 libraries that come with cygwin. libW11 emulation is no
1469     longer supported (and makes no sense, either, as it only supported a
1470     single font). I recommend starting the X\-server in \f(CW\*(C`\-multiwindow\*(C'\fR or
1471     \&\f(CW\*(C`\-rootless\*(C'\fR mode instead, which will result in similar look&feel as the
1472     old libW11 emulation.
1473     .PP
1474     At the time of this writing, cygwin didn't seem to support any multi-byte
1475     encodings (you might try \f(CW\*(C`LC_CTYPE=C\-UTF\-8\*(C'\fR), so you are likely limited
1476     to 8\-bit encodings.
1477 root 1.86 .PP
1478     \fICharacter widths are not correct.\fR
1479     .IX Subsection "Character widths are not correct."
1480     .PP
1481     urxvt uses the system wcwidth function to know the information about
1482     the width of characters, so on systems with incorrect locale data you
1483     will likely get bad results. Two notorious examples are Solaris 9,
1484 root 1.95 where single-width characters like U+2514 are reported as double-width,
1485 root 1.86 and Darwin 8, where combining chars are reported having width 1.
1486     .PP
1487     The solution is to upgrade your system or switch to a better one. A
1488     possibly working workaround is to use a wcwidth implementation like
1489     .PP
1490     http://www.cl.cam.ac.uk/~mgk25/ucs/wcwidth.c
1491 root 1.65 .SH "RXVT-UNICODE TECHNICAL REFERENCE"
1492     .IX Header "RXVT-UNICODE TECHNICAL REFERENCE"
1493 root 1.1 The rest of this document describes various technical aspects of
1494     \&\fBrxvt-unicode\fR. First the description of supported command sequences,
1495 root 1.48 followed by pixmap support and last by a description of all features
1496     selectable at \f(CW\*(C`configure\*(C'\fR time.
1497 root 1.100 .SS "Definitions"
1498 root 1.69 .IX Subsection "Definitions"
1499 root 1.12 .ie n .IP "\fB\fB""c""\fB\fR" 4
1500     .el .IP "\fB\f(CBc\fB\fR" 4
1501 root 1.1 .IX Item "c"
1502 root 1.106 The literal character c (potentially a multi-byte character).
1503 root 1.12 .ie n .IP "\fB\fB""C""\fB\fR" 4
1504     .el .IP "\fB\f(CBC\fB\fR" 4
1505 root 1.1 .IX Item "C"
1506     A single (required) character.
1507 root 1.12 .ie n .IP "\fB\fB""Ps""\fB\fR" 4
1508     .el .IP "\fB\f(CBPs\fB\fR" 4
1509 root 1.1 .IX Item "Ps"
1510     A single (usually optional) numeric parameter, composed of one or more
1511     digits.
1512 root 1.12 .ie n .IP "\fB\fB""Pm""\fB\fR" 4
1513     .el .IP "\fB\f(CBPm\fB\fR" 4
1514 root 1.1 .IX Item "Pm"
1515     A multiple numeric parameter composed of any number of single numeric
1516     parameters, separated by \f(CW\*(C`;\*(C'\fR character(s).
1517 root 1.12 .ie n .IP "\fB\fB""Pt""\fB\fR" 4
1518     .el .IP "\fB\f(CBPt\fB\fR" 4
1519 root 1.1 .IX Item "Pt"
1520     A text parameter composed of printable characters.
1521 root 1.100 .SS "Values"
1522 root 1.69 .IX Subsection "Values"
1523 root 1.12 .ie n .IP "\fB\fB""ENQ""\fB\fR" 4
1524     .el .IP "\fB\f(CBENQ\fB\fR" 4
1525 root 1.1 .IX Item "ENQ"
1526 root 1.95 Enquiry (Ctrl-E) = Send Device Attributes (\s-1DA\s0)
1527 root 1.1 request attributes from terminal. See \fB\f(CB\*(C`ESC [ Ps c\*(C'\fB\fR.
1528 root 1.12 .ie n .IP "\fB\fB""BEL""\fB\fR" 4
1529     .el .IP "\fB\f(CBBEL\fB\fR" 4
1530 root 1.1 .IX Item "BEL"
1531 root 1.95 Bell (Ctrl-G)
1532 root 1.12 .ie n .IP "\fB\fB""BS""\fB\fR" 4
1533     .el .IP "\fB\f(CBBS\fB\fR" 4
1534 root 1.1 .IX Item "BS"
1535 root 1.95 Backspace (Ctrl-H)
1536 root 1.12 .ie n .IP "\fB\fB""TAB""\fB\fR" 4
1537     .el .IP "\fB\f(CBTAB\fB\fR" 4
1538 root 1.1 .IX Item "TAB"
1539 root 1.95 Horizontal Tab (\s-1HT\s0) (Ctrl-I)
1540 root 1.12 .ie n .IP "\fB\fB""LF""\fB\fR" 4
1541     .el .IP "\fB\f(CBLF\fB\fR" 4
1542 root 1.1 .IX Item "LF"
1543 root 1.95 Line Feed or New Line (\s-1NL\s0) (Ctrl-J)
1544 root 1.12 .ie n .IP "\fB\fB""VT""\fB\fR" 4
1545     .el .IP "\fB\f(CBVT\fB\fR" 4
1546 root 1.1 .IX Item "VT"
1547 root 1.95 Vertical Tab (Ctrl-K) same as \fB\f(CB\*(C`LF\*(C'\fB\fR
1548 root 1.12 .ie n .IP "\fB\fB""FF""\fB\fR" 4
1549     .el .IP "\fB\f(CBFF\fB\fR" 4
1550 root 1.1 .IX Item "FF"
1551 root 1.95 Form Feed or New Page (\s-1NP\s0) (Ctrl-L) same as \fB\f(CB\*(C`LF\*(C'\fB\fR
1552 root 1.12 .ie n .IP "\fB\fB""CR""\fB\fR" 4
1553     .el .IP "\fB\f(CBCR\fB\fR" 4
1554 root 1.1 .IX Item "CR"
1555 root 1.95 Carriage Return (Ctrl-M)
1556 root 1.12 .ie n .IP "\fB\fB""SO""\fB\fR" 4
1557     .el .IP "\fB\f(CBSO\fB\fR" 4
1558 root 1.1 .IX Item "SO"
1559 root 1.95 Shift Out (Ctrl-N), invokes the G1 character set.
1560 root 1.1 Switch to Alternate Character Set
1561 root 1.12 .ie n .IP "\fB\fB""SI""\fB\fR" 4
1562     .el .IP "\fB\f(CBSI\fB\fR" 4
1563 root 1.1 .IX Item "SI"
1564 root 1.95 Shift In (Ctrl-O), invokes the G0 character set (the default).
1565 root 1.1 Switch to Standard Character Set
1566 root 1.123 .ie n .IP "\fB\fB""SP""\fB\fR" 4
1567     .el .IP "\fB\f(CBSP\fB\fR" 4
1568     .IX Item "SP"
1569 root 1.1 Space Character
1570 root 1.100 .SS "Escape Sequences"
1571 root 1.69 .IX Subsection "Escape Sequences"
1572 root 1.12 .ie n .IP "\fB\fB""ESC # 8""\fB\fR" 4
1573     .el .IP "\fB\f(CBESC # 8\fB\fR" 4
1574 root 1.1 .IX Item "ESC # 8"
1575     \&\s-1DEC\s0 Screen Alignment Test (\s-1DECALN\s0)
1576 root 1.12 .ie n .IP "\fB\fB""ESC 7""\fB\fR" 4
1577     .el .IP "\fB\f(CBESC 7\fB\fR" 4
1578 root 1.1 .IX Item "ESC 7"
1579     Save Cursor (\s-1SC\s0)
1580 root 1.12 .ie n .IP "\fB\fB""ESC 8""\fB\fR" 4
1581     .el .IP "\fB\f(CBESC 8\fB\fR" 4
1582 root 1.1 .IX Item "ESC 8"
1583     Restore Cursor
1584 root 1.12 .ie n .IP "\fB\fB""ESC =""\fB\fR" 4
1585     .el .IP "\fB\f(CBESC =\fB\fR" 4
1586 root 1.1 .IX Item "ESC ="
1587     Application Keypad (\s-1SMKX\s0). See also next sequence.
1588 sf-exg 1.102 .ie n .IP "\fB\fB""ESC >""\fB\fR" 4
1589     .el .IP "\fB\f(CBESC >\fB\fR" 4
1590     .IX Item "ESC >"
1591 root 1.1 Normal Keypad (\s-1RMKX\s0)
1592     .Sp
1593 root 1.126 \&\fBNote:\fR numbers or control functions are generated by the numeric
1594     keypad in normal or application mode, respectively (see Key Codes).
1595 root 1.12 .ie n .IP "\fB\fB""ESC D""\fB\fR" 4
1596     .el .IP "\fB\f(CBESC D\fB\fR" 4
1597 root 1.1 .IX Item "ESC D"
1598     Index (\s-1IND\s0)
1599 root 1.12 .ie n .IP "\fB\fB""ESC E""\fB\fR" 4
1600     .el .IP "\fB\f(CBESC E\fB\fR" 4
1601 root 1.1 .IX Item "ESC E"
1602     Next Line (\s-1NEL\s0)
1603 root 1.12 .ie n .IP "\fB\fB""ESC H""\fB\fR" 4
1604     .el .IP "\fB\f(CBESC H\fB\fR" 4
1605 root 1.1 .IX Item "ESC H"
1606     Tab Set (\s-1HTS\s0)
1607 root 1.12 .ie n .IP "\fB\fB""ESC M""\fB\fR" 4
1608     .el .IP "\fB\f(CBESC M\fB\fR" 4
1609 root 1.1 .IX Item "ESC M"
1610     Reverse Index (\s-1RI\s0)
1611 root 1.12 .ie n .IP "\fB\fB""ESC N""\fB\fR" 4
1612     .el .IP "\fB\f(CBESC N\fB\fR" 4
1613 root 1.1 .IX Item "ESC N"
1614     Single Shift Select of G2 Character Set (\s-1SS2\s0): affects next character
1615     only \fIunimplemented\fR
1616 root 1.12 .ie n .IP "\fB\fB""ESC O""\fB\fR" 4
1617     .el .IP "\fB\f(CBESC O\fB\fR" 4
1618 root 1.1 .IX Item "ESC O"
1619     Single Shift Select of G3 Character Set (\s-1SS3\s0): affects next character
1620     only \fIunimplemented\fR
1621 root 1.12 .ie n .IP "\fB\fB""ESC Z""\fB\fR" 4
1622     .el .IP "\fB\f(CBESC Z\fB\fR" 4
1623 root 1.1 .IX Item "ESC Z"
1624 root 1.12 Obsolete form of returns: \fB\f(CB\*(C`ESC [ ? 1 ; 2 C\*(C'\fB\fR \fIrxvt-unicode compile-time option\fR
1625     .ie n .IP "\fB\fB""ESC c""\fB\fR" 4
1626     .el .IP "\fB\f(CBESC c\fB\fR" 4
1627 root 1.1 .IX Item "ESC c"
1628     Full reset (\s-1RIS\s0)
1629 root 1.12 .ie n .IP "\fB\fB""ESC n""\fB\fR" 4
1630     .el .IP "\fB\f(CBESC n\fB\fR" 4
1631 root 1.1 .IX Item "ESC n"
1632     Invoke the G2 Character Set (\s-1LS2\s0)
1633 root 1.12 .ie n .IP "\fB\fB""ESC o""\fB\fR" 4
1634     .el .IP "\fB\f(CBESC o\fB\fR" 4
1635 root 1.1 .IX Item "ESC o"
1636     Invoke the G3 Character Set (\s-1LS3\s0)
1637 root 1.12 .ie n .IP "\fB\fB""ESC ( C""\fB\fR" 4
1638     .el .IP "\fB\f(CBESC ( C\fB\fR" 4
1639     .IX Item "ESC ( C"
1640 root 1.128 Designate G0 Character Set (\s-1ISO 2022\s0), see below for values of \f(CW\*(C`C\*(C'\fR.
1641 root 1.12 .ie n .IP "\fB\fB""ESC ) C""\fB\fR" 4
1642     .el .IP "\fB\f(CBESC ) C\fB\fR" 4
1643     .IX Item "ESC ) C"
1644 root 1.128 Designate G1 Character Set (\s-1ISO 2022\s0), see below for values of \f(CW\*(C`C\*(C'\fR.
1645 root 1.12 .ie n .IP "\fB\fB""ESC * C""\fB\fR" 4
1646     .el .IP "\fB\f(CBESC * C\fB\fR" 4
1647 root 1.1 .IX Item "ESC * C"
1648 root 1.128 Designate G2 Character Set (\s-1ISO 2022\s0), see below for values of \f(CW\*(C`C\*(C'\fR.
1649 root 1.12 .ie n .IP "\fB\fB""ESC + C""\fB\fR" 4
1650     .el .IP "\fB\f(CBESC + C\fB\fR" 4
1651 root 1.1 .IX Item "ESC + C"
1652 root 1.128 Designate G3 Character Set (\s-1ISO 2022\s0), see below for values of \f(CW\*(C`C\*(C'\fR.
1653 root 1.12 .ie n .IP "\fB\fB""ESC $ C""\fB\fR" 4
1654     .el .IP "\fB\f(CBESC $ C\fB\fR" 4
1655 root 1.1 .IX Item "ESC $ C"
1656     Designate Kanji Character Set
1657     .Sp
1658     Where \fB\f(CB\*(C`C\*(C'\fB\fR is one of:
1659     .TS
1660     l l .
1661 root 1.126 C = 0 DEC Special Character and Line Drawing Set
1662     C = A United Kingdom (UK)
1663     C = B United States (USASCII)
1664 root 1.1 C = < Multinational character set unimplemented
1665 root 1.126 C = 5 Finnish character set unimplemented
1666     C = C Finnish character set unimplemented
1667     C = K German character set unimplemented
1668 root 1.1 .TE
1669     .PP
1670    
1671     .IX Xref "CSI"
1672 root 1.128 .SS "\s-1CSI \s0(Command Sequence Introducer) Sequences"
1673 root 1.69 .IX Subsection "CSI (Command Sequence Introducer) Sequences"
1674 root 1.12 .ie n .IP "\fB\fB""ESC [ Ps @""\fB\fR" 4
1675     .el .IP "\fB\f(CBESC [ Ps @\fB\fR" 4
1676 root 1.1 .IX Item "ESC [ Ps @"
1677     Insert \fB\f(CB\*(C`Ps\*(C'\fB\fR (Blank) Character(s) [default: 1] (\s-1ICH\s0)
1678     .IX Xref "ESCOBPsA"
1679 root 1.12 .ie n .IP "\fB\fB""ESC [ Ps A""\fB\fR" 4
1680     .el .IP "\fB\f(CBESC [ Ps A\fB\fR" 4
1681 root 1.1 .IX Item "ESC [ Ps A"
1682     Cursor Up \fB\f(CB\*(C`Ps\*(C'\fB\fR Times [default: 1] (\s-1CUU\s0)
1683 root 1.12 .ie n .IP "\fB\fB""ESC [ Ps B""\fB\fR" 4
1684     .el .IP "\fB\f(CBESC [ Ps B\fB\fR" 4
1685 root 1.1 .IX Item "ESC [ Ps B"
1686     Cursor Down \fB\f(CB\*(C`Ps\*(C'\fB\fR Times [default: 1] (\s-1CUD\s0)
1687     .IX Xref "ESCOBPsC"
1688 root 1.12 .ie n .IP "\fB\fB""ESC [ Ps C""\fB\fR" 4
1689     .el .IP "\fB\f(CBESC [ Ps C\fB\fR" 4
1690 root 1.1 .IX Item "ESC [ Ps C"
1691     Cursor Forward \fB\f(CB\*(C`Ps\*(C'\fB\fR Times [default: 1] (\s-1CUF\s0)
1692 root 1.12 .ie n .IP "\fB\fB""ESC [ Ps D""\fB\fR" 4
1693     .el .IP "\fB\f(CBESC [ Ps D\fB\fR" 4
1694 root 1.1 .IX Item "ESC [ Ps D"
1695     Cursor Backward \fB\f(CB\*(C`Ps\*(C'\fB\fR Times [default: 1] (\s-1CUB\s0)
1696 root 1.12 .ie n .IP "\fB\fB""ESC [ Ps E""\fB\fR" 4
1697     .el .IP "\fB\f(CBESC [ Ps E\fB\fR" 4
1698 root 1.1 .IX Item "ESC [ Ps E"
1699     Cursor Down \fB\f(CB\*(C`Ps\*(C'\fB\fR Times [default: 1] and to first column
1700 root 1.12 .ie n .IP "\fB\fB""ESC [ Ps F""\fB\fR" 4
1701     .el .IP "\fB\f(CBESC [ Ps F\fB\fR" 4
1702 root 1.1 .IX Item "ESC [ Ps F"
1703     Cursor Up \fB\f(CB\*(C`Ps\*(C'\fB\fR Times [default: 1] and to first column
1704     .IX Xref "ESCOBPsG"
1705 root 1.12 .ie n .IP "\fB\fB""ESC [ Ps G""\fB\fR" 4
1706     .el .IP "\fB\f(CBESC [ Ps G\fB\fR" 4
1707 root 1.1 .IX Item "ESC [ Ps G"
1708     Cursor to Column \fB\f(CB\*(C`Ps\*(C'\fB\fR (\s-1HPA\s0)
1709 root 1.12 .ie n .IP "\fB\fB""ESC [ Ps;Ps H""\fB\fR" 4
1710     .el .IP "\fB\f(CBESC [ Ps;Ps H\fB\fR" 4
1711 root 1.1 .IX Item "ESC [ Ps;Ps H"
1712     Cursor Position [row;column] [default: 1;1] (\s-1CUP\s0)
1713 root 1.12 .ie n .IP "\fB\fB""ESC [ Ps I""\fB\fR" 4
1714     .el .IP "\fB\f(CBESC [ Ps I\fB\fR" 4
1715 root 1.1 .IX Item "ESC [ Ps I"
1716     Move forward \fB\f(CB\*(C`Ps\*(C'\fB\fR tab stops [default: 1]
1717 root 1.12 .ie n .IP "\fB\fB""ESC [ Ps J""\fB\fR" 4
1718     .el .IP "\fB\f(CBESC [ Ps J\fB\fR" 4
1719 root 1.1 .IX Item "ESC [ Ps J"
1720     Erase in Display (\s-1ED\s0)
1721     .TS
1722     l l .
1723 sf-exg 1.112 Ps = 0 Clear Right and Below (default)
1724     Ps = 1 Clear Left and Above
1725 root 1.1 Ps = 2 Clear All
1726     .TE
1727 root 1.12 .ie n .IP "\fB\fB""ESC [ Ps K""\fB\fR" 4
1728     .el .IP "\fB\f(CBESC [ Ps K\fB\fR" 4
1729 root 1.1 .IX Item "ESC [ Ps K"
1730     Erase in Line (\s-1EL\s0)
1731     .TS
1732 root 1.126 l l l l .
1733 root 1.1 Ps = 0 Clear to Right (default)
1734     Ps = 1 Clear to Left
1735     Ps = 2 Clear All
1736 root 1.97 Ps = 3 Like Ps = 0, but is ignored when wrapped
1737 root 1.126 (@@RXVT_NAME@@ extension)
1738 root 1.1 .TE
1739 root 1.12 .ie n .IP "\fB\fB""ESC [ Ps L""\fB\fR" 4
1740     .el .IP "\fB\f(CBESC [ Ps L\fB\fR" 4
1741 root 1.1 .IX Item "ESC [ Ps L"
1742     Insert \fB\f(CB\*(C`Ps\*(C'\fB\fR Line(s) [default: 1] (\s-1IL\s0)
1743 root 1.12 .ie n .IP "\fB\fB""ESC [ Ps M""\fB\fR" 4
1744     .el .IP "\fB\f(CBESC [ Ps M\fB\fR" 4
1745 root 1.1 .IX Item "ESC [ Ps M"
1746     Delete \fB\f(CB\*(C`Ps\*(C'\fB\fR Line(s) [default: 1] (\s-1DL\s0)
1747 root 1.12 .ie n .IP "\fB\fB""ESC [ Ps P""\fB\fR" 4
1748     .el .IP "\fB\f(CBESC [ Ps P\fB\fR" 4
1749 root 1.1 .IX Item "ESC [ Ps P"
1750     Delete \fB\f(CB\*(C`Ps\*(C'\fB\fR Character(s) [default: 1] (\s-1DCH\s0)
1751 root 1.12 .ie n .IP "\fB\fB""ESC [ Ps;Ps;Ps;Ps;Ps T""\fB\fR" 4
1752     .el .IP "\fB\f(CBESC [ Ps;Ps;Ps;Ps;Ps T\fB\fR" 4
1753 root 1.1 .IX Item "ESC [ Ps;Ps;Ps;Ps;Ps T"
1754     Initiate . \fIunimplemented\fR Parameters are
1755     [func;startx;starty;firstrow;lastrow].
1756 root 1.12 .ie n .IP "\fB\fB""ESC [ Ps W""\fB\fR" 4
1757     .el .IP "\fB\f(CBESC [ Ps W\fB\fR" 4
1758 root 1.1 .IX Item "ESC [ Ps W"
1759     Tabulator functions
1760     .TS
1761     l l .
1762     Ps = 0 Tab Set (HTS)
1763     Ps = 2 Tab Clear (TBC), Clear Current Column (default)
1764     Ps = 5 Tab Clear (TBC), Clear All
1765     .TE
1766 root 1.12 .ie n .IP "\fB\fB""ESC [ Ps X""\fB\fR" 4
1767     .el .IP "\fB\f(CBESC [ Ps X\fB\fR" 4
1768 root 1.1 .IX Item "ESC [ Ps X"
1769     Erase \fB\f(CB\*(C`Ps\*(C'\fB\fR Character(s) [default: 1] (\s-1ECH\s0)
1770 root 1.12 .ie n .IP "\fB\fB""ESC [ Ps Z""\fB\fR" 4
1771     .el .IP "\fB\f(CBESC [ Ps Z\fB\fR" 4
1772 root 1.1 .IX Item "ESC [ Ps Z"
1773     Move backward \fB\f(CB\*(C`Ps\*(C'\fB\fR [default: 1] tab stops
1774 root 1.95 .ie n .IP "\fB\fB""ESC [ Ps \*(Aq""\fB\fR" 4
1775     .el .IP "\fB\f(CBESC [ Ps \*(Aq\fB\fR" 4
1776     .IX Item "ESC [ Ps "
1777 root 1.1 See \fB\f(CB\*(C`ESC [ Ps G\*(C'\fB\fR
1778 root 1.12 .ie n .IP "\fB\fB""ESC [ Ps a""\fB\fR" 4
1779     .el .IP "\fB\f(CBESC [ Ps a\fB\fR" 4
1780 root 1.1 .IX Item "ESC [ Ps a"
1781     See \fB\f(CB\*(C`ESC [ Ps C\*(C'\fB\fR
1782 root 1.12 .ie n .IP "\fB\fB""ESC [ Ps c""\fB\fR" 4
1783     .el .IP "\fB\f(CBESC [ Ps c\fB\fR" 4
1784 root 1.1 .IX Item "ESC [ Ps c"
1785     Send Device Attributes (\s-1DA\s0)
1786     \&\fB\f(CB\*(C`Ps = 0\*(C'\fB\fR (or omitted): request attributes from terminal
1787 root 1.12 returns: \fB\f(CB\*(C`ESC [ ? 1 ; 2 c\*(C'\fB\fR (``I am a \s-1VT100\s0 with Advanced Video
1788 root 1.1 Option'')
1789 root 1.12 .ie n .IP "\fB\fB""ESC [ Ps d""\fB\fR" 4
1790     .el .IP "\fB\f(CBESC [ Ps d\fB\fR" 4
1791 root 1.1 .IX Item "ESC [ Ps d"
1792     Cursor to Line \fB\f(CB\*(C`Ps\*(C'\fB\fR (\s-1VPA\s0)
1793 root 1.12 .ie n .IP "\fB\fB""ESC [ Ps e""\fB\fR" 4
1794     .el .IP "\fB\f(CBESC [ Ps e\fB\fR" 4
1795 root 1.1 .IX Item "ESC [ Ps e"
1796     See \fB\f(CB\*(C`ESC [ Ps A\*(C'\fB\fR
1797 root 1.12 .ie n .IP "\fB\fB""ESC [ Ps;Ps f""\fB\fR" 4
1798     .el .IP "\fB\f(CBESC [ Ps;Ps f\fB\fR" 4
1799 root 1.1 .IX Item "ESC [ Ps;Ps f"
1800     Horizontal and Vertical Position [row;column] (\s-1HVP\s0) [default: 1;1]
1801 root 1.12 .ie n .IP "\fB\fB""ESC [ Ps g""\fB\fR" 4
1802     .el .IP "\fB\f(CBESC [ Ps g\fB\fR" 4
1803 root 1.1 .IX Item "ESC [ Ps g"
1804     Tab Clear (\s-1TBC\s0)
1805     .TS
1806     l l .
1807     Ps = 0 Clear Current Column (default)
1808     Ps = 3 Clear All (TBC)
1809     .TE
1810 root 1.12 .ie n .IP "\fB\fB""ESC [ Pm h""\fB\fR" 4
1811     .el .IP "\fB\f(CBESC [ Pm h\fB\fR" 4
1812 root 1.1 .IX Item "ESC [ Pm h"
1813     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.
1814 root 1.12 .ie n .IP "\fB\fB""ESC [ Ps i""\fB\fR" 4
1815     .el .IP "\fB\f(CBESC [ Ps i\fB\fR" 4
1816 root 1.1 .IX Item "ESC [ Ps i"
1817     Printing. See also the \f(CW\*(C`print\-pipe\*(C'\fR resource.
1818     .TS
1819     l l .
1820     Ps = 0 print screen (MC0)
1821     Ps = 4 disable transparent print mode (MC4)
1822     Ps = 5 enable transparent print mode (MC5)
1823     .TE
1824 root 1.12 .ie n .IP "\fB\fB""ESC [ Pm l""\fB\fR" 4
1825     .el .IP "\fB\f(CBESC [ Pm l\fB\fR" 4
1826 root 1.1 .IX Item "ESC [ Pm l"
1827     Reset Mode (\s-1RM\s0)
1828     .RS 4
1829 root 1.12 .ie n .IP "\fB\fB""Ps = 4""\fB\fR" 4
1830     .el .IP "\fB\f(CBPs = 4\fB\fR" 4
1831 root 1.1 .IX Item "Ps = 4"
1832     .TS
1833     l l .
1834     h Insert Mode (SMIR)
1835     l Replace Mode (RMIR)
1836     .TE
1837     .PD 0
1838 root 1.12 .ie n .IP "\fB\fB""Ps = 20""\fB\fR (partially implemented)" 4
1839     .el .IP "\fB\f(CBPs = 20\fB\fR (partially implemented)" 4
1840 root 1.1 .IX Item "Ps = 20 (partially implemented)"
1841     .TS
1842     l l .
1843     h Automatic Newline (LNM)
1844     l Normal Linefeed (LNM)
1845     .TE
1846     .RE
1847     .RS 4
1848     .RE
1849 root 1.12 .ie n .IP "\fB\fB""ESC [ Pm m""\fB\fR" 4
1850     .el .IP "\fB\f(CBESC [ Pm m\fB\fR" 4
1851 root 1.1 .IX Item "ESC [ Pm m"
1852     .PD
1853     Character Attributes (\s-1SGR\s0)
1854     .TS
1855     l l .
1856 root 1.123 Pm = 0 Normal (default)
1857     Pm = 1 / 21 On / Off Bold (bright fg)
1858     Pm = 3 / 23 On / Off Italic
1859     Pm = 4 / 24 On / Off Underline
1860     Pm = 5 / 25 On / Off Slow Blink (bright bg)
1861     Pm = 6 / 26 On / Off Rapid Blink (bright bg)
1862     Pm = 7 / 27 On / Off Inverse
1863     Pm = 8 / 27 On / Off Invisible (NYI)
1864     Pm = 30 / 40 fg/bg Black
1865     Pm = 31 / 41 fg/bg Red
1866     Pm = 32 / 42 fg/bg Green
1867     Pm = 33 / 43 fg/bg Yellow
1868     Pm = 34 / 44 fg/bg Blue
1869     Pm = 35 / 45 fg/bg Magenta
1870     Pm = 36 / 46 fg/bg Cyan
1871     Pm = 37 / 47 fg/bg White
1872     Pm = 38;5 / 48;5 set fg/bg to colour #m (ISO 8613-6)
1873     Pm = 39 / 49 fg/bg Default
1874     Pm = 90 / 100 fg/bg Bright Black
1875     Pm = 91 / 101 fg/bg Bright Red
1876     Pm = 92 / 102 fg/bg Bright Green
1877     Pm = 93 / 103 fg/bg Bright Yellow
1878     Pm = 94 / 104 fg/bg Bright Blue
1879     Pm = 95 / 105 fg/bg Bright Magenta
1880     Pm = 96 / 106 fg/bg Bright Cyan
1881     Pm = 97 / 107 fg/bg Bright White
1882     Pm = 99 / 109 fg/bg Bright Default
1883 root 1.1 .TE
1884 root 1.12 .ie n .IP "\fB\fB""ESC [ Ps n""\fB\fR" 4
1885     .el .IP "\fB\f(CBESC [ Ps n\fB\fR" 4
1886 root 1.1 .IX Item "ESC [ Ps n"
1887     Device Status Report (\s-1DSR\s0)
1888     .TS
1889     l l .
1890     Ps = 5 Status Report ESC [ 0 n (``OK'')
1891     Ps = 6 Report Cursor Position (CPR) [row;column] as ESC [ r ; c R
1892     Ps = 7 Request Display Name
1893     Ps = 8 Request Version Number (place in window title)
1894     .TE
1895 root 1.123 .ie n .IP "\fB\fB""ESC [ Ps SP q""\fB\fR" 4
1896     .el .IP "\fB\f(CBESC [ Ps SP q\fB\fR" 4
1897     .IX Item "ESC [ Ps SP q"
1898 root 1.126 Set Cursor Style (\s-1DECSCUSR\s0)
1899 root 1.123 .TS
1900     l l .
1901     Ps = 0 Blink Block
1902     Ps = 1 Blink Block
1903     Ps = 2 Steady Block
1904     Ps = 3 Blink Underline
1905     Ps = 4 Steady Underline
1906 root 1.126 Ps = 5 Blink Bar (XTerm)
1907     Ps = 6 Steady Bar (XTerm)
1908 root 1.123 .TE
1909 root 1.12 .ie n .IP "\fB\fB""ESC [ Ps;Ps r""\fB\fR" 4
1910     .el .IP "\fB\f(CBESC [ Ps;Ps r\fB\fR" 4
1911 root 1.1 .IX Item "ESC [ Ps;Ps r"
1912     Set Scrolling Region [top;bottom]
1913     [default: full size of window] (\s-1CSR\s0)
1914 root 1.12 .ie n .IP "\fB\fB""ESC [ s""\fB\fR" 4
1915     .el .IP "\fB\f(CBESC [ s\fB\fR" 4
1916 root 1.1 .IX Item "ESC [ s"
1917     Save Cursor (\s-1SC\s0)
1918 root 1.12 .ie n .IP "\fB\fB""ESC [ Ps;Pt t""\fB\fR" 4
1919     .el .IP "\fB\f(CBESC [ Ps;Pt t\fB\fR" 4
1920 root 1.5 .IX Item "ESC [ Ps;Pt t"
1921     Window Operations
1922     .TS
1923     l l .
1924     Ps = 1 Deiconify (map) window
1925     Ps = 2 Iconify window
1926     Ps = 3 ESC [ 3 ; X ; Y t Move window to (X|Y)
1927 root 1.12 Ps = 4 ESC [ 4 ; H ; W t Resize to WxH pixels
1928 root 1.5 Ps = 5 Raise window
1929     Ps = 6 Lower window
1930     Ps = 7 Refresh screen once
1931 root 1.12 Ps = 8 ESC [ 8 ; R ; C t Resize to R rows and C columns
1932     Ps = 11 Report window state (responds with Ps = 1 or Ps = 2)
1933 root 1.5 Ps = 13 Report window position (responds with Ps = 3)
1934     Ps = 14 Report window pixel size (responds with Ps = 4)
1935     Ps = 18 Report window text size (responds with Ps = 7)
1936     Ps = 19 Currently the same as Ps = 18, but responds with Ps = 9
1937     Ps = 20 Reports icon label (ESC ] L NAME \234)
1938     Ps = 21 Reports window title (ESC ] l NAME \234)
1939     Ps = 24.. Set window height to Ps rows
1940     .TE
1941 root 1.12 .ie n .IP "\fB\fB""ESC [ u""\fB\fR" 4
1942     .el .IP "\fB\f(CBESC [ u\fB\fR" 4
1943 root 1.5 .IX Item "ESC [ u"
1944     Restore Cursor
1945 root 1.12 .ie n .IP "\fB\fB""ESC [ Ps x""\fB\fR" 4
1946     .el .IP "\fB\f(CBESC [ Ps x\fB\fR" 4
1947 root 1.1 .IX Item "ESC [ Ps x"
1948     Request Terminal Parameters (\s-1DECREQTPARM\s0)
1949     .PP
1950    
1951     .IX Xref "PrivateModes"
1952 root 1.100 .SS "\s-1DEC\s0 Private Modes"
1953 root 1.69 .IX Subsection "DEC Private Modes"
1954 root 1.12 .ie n .IP "\fB\fB""ESC [ ? Pm h""\fB\fR" 4
1955     .el .IP "\fB\f(CBESC [ ? Pm h\fB\fR" 4
1956 root 1.1 .IX Item "ESC [ ? Pm h"
1957     \&\s-1DEC\s0 Private Mode Set (\s-1DECSET\s0)
1958 root 1.12 .ie n .IP "\fB\fB""ESC [ ? Pm l""\fB\fR" 4
1959     .el .IP "\fB\f(CBESC [ ? Pm l\fB\fR" 4
1960 root 1.1 .IX Item "ESC [ ? Pm l"
1961     \&\s-1DEC\s0 Private Mode Reset (\s-1DECRST\s0)
1962 root 1.12 .ie n .IP "\fB\fB""ESC [ ? Pm r""\fB\fR" 4
1963     .el .IP "\fB\f(CBESC [ ? Pm r\fB\fR" 4
1964 root 1.1 .IX Item "ESC [ ? Pm r"
1965     Restore previously saved \s-1DEC\s0 Private Mode Values.
1966 root 1.12 .ie n .IP "\fB\fB""ESC [ ? Pm s""\fB\fR" 4
1967     .el .IP "\fB\f(CBESC [ ? Pm s\fB\fR" 4
1968 root 1.1 .IX Item "ESC [ ? Pm s"
1969     Save \s-1DEC\s0 Private Mode Values.
1970 root 1.12 .ie n .IP "\fB\fB""ESC [ ? Pm t""\fB\fR" 4
1971     .el .IP "\fB\f(CBESC [ ? Pm t\fB\fR" 4
1972 root 1.1 .IX Item "ESC [ ? Pm t"
1973     Toggle \s-1DEC\s0 Private Mode Values (rxvt extension). \fIwhere\fR
1974     .RS 4
1975 root 1.76 .ie n .IP "\fB\fB""Pm = 1""\fB\fR (\s-1DECCKM\s0)" 4
1976     .el .IP "\fB\f(CBPm = 1\fB\fR (\s-1DECCKM\s0)" 4
1977     .IX Item "Pm = 1 (DECCKM)"
1978 root 1.1 .TS
1979     l l .
1980     h Application Cursor Keys
1981     l Normal Cursor Keys
1982     .TE
1983     .PD 0
1984 root 1.123 .ie n .IP "\fB\fB""Pm = 2""\fB\fR (\s-1DECANM\s0)" 4
1985     .el .IP "\fB\f(CBPm = 2\fB\fR (\s-1DECANM\s0)" 4
1986     .IX Item "Pm = 2 (DECANM)"
1987 root 1.1 .TS
1988     l l .
1989     h Enter VT52 mode
1990     l Enter VT52 mode
1991     .TE
1992 root 1.123 .ie n .IP "\fB\fB""Pm = 3""\fB\fR (\s-1DECCOLM\s0)" 4
1993     .el .IP "\fB\f(CBPm = 3\fB\fR (\s-1DECCOLM\s0)" 4
1994     .IX Item "Pm = 3 (DECCOLM)"
1995 root 1.1 .TS
1996     l l .
1997 root 1.123 h 132 Column Mode
1998     l 80 Column Mode
1999 root 1.1 .TE
2000 root 1.123 .ie n .IP "\fB\fB""Pm = 4""\fB\fR (\s-1DECSCLM\s0)" 4
2001     .el .IP "\fB\f(CBPm = 4\fB\fR (\s-1DECSCLM\s0)" 4
2002     .IX Item "Pm = 4 (DECSCLM)"
2003 root 1.1 .TS
2004     l l .
2005 root 1.123 h Smooth (Slow) Scroll
2006     l Jump (Fast) Scroll
2007 root 1.1 .TE
2008 root 1.123 .ie n .IP "\fB\fB""Pm = 5""\fB\fR (\s-1DECSCNM\s0)" 4
2009     .el .IP "\fB\f(CBPm = 5\fB\fR (\s-1DECSCNM\s0)" 4
2010     .IX Item "Pm = 5 (DECSCNM)"
2011 root 1.1 .TS
2012     l l .
2013 root 1.123 h Reverse Video
2014     l Normal Video
2015 root 1.1 .TE
2016 root 1.123 .ie n .IP "\fB\fB""Pm = 6""\fB\fR (\s-1DECOM\s0)" 4
2017     .el .IP "\fB\f(CBPm = 6\fB\fR (\s-1DECOM\s0)" 4
2018     .IX Item "Pm = 6 (DECOM)"
2019 root 1.1 .TS
2020     l l .
2021 root 1.123 h Origin Mode
2022     l Normal Cursor Mode
2023 root 1.1 .TE
2024 root 1.123 .ie n .IP "\fB\fB""Pm = 7""\fB\fR (\s-1DECAWM\s0)" 4
2025     .el .IP "\fB\f(CBPm = 7\fB\fR (\s-1DECAWM\s0)" 4
2026     .IX Item "Pm = 7 (DECAWM)"
2027 root 1.1 .TS
2028     l l .
2029 root 1.123 h Wraparound Mode
2030     l No Wraparound Mode
2031 root 1.1 .TE
2032 root 1.123 .ie n .IP "\fB\fB""Pm = 8""\fB\fR (\s-1DECARM\s0) \fIunimplemented\fR" 4
2033     .el .IP "\fB\f(CBPm = 8\fB\fR (\s-1DECARM\s0) \fIunimplemented\fR" 4
2034     .IX Item "Pm = 8 (DECARM) unimplemented"
2035 root 1.1 .TS
2036     l l .
2037 root 1.123 h Auto-repeat Keys
2038     l No Auto-repeat Keys
2039 root 1.1 .TE
2040 root 1.126 .ie n .IP "\fB\fB""Pm = 9""\fB\fR (X10 XTerm mouse protocol)" 4
2041     .el .IP "\fB\f(CBPm = 9\fB\fR (X10 XTerm mouse protocol)" 4
2042     .IX Item "Pm = 9 (X10 XTerm mouse protocol)"
2043 root 1.1 .TS
2044     l l .
2045     h Send Mouse X & Y on button press.
2046     l No mouse reporting.
2047     .TE
2048 root 1.128 .ie n .IP "\fB\fB""Pm = 12""\fB\fR (\s-1AT&T 610,\s0 XTerm)" 4
2049     .el .IP "\fB\f(CBPm = 12\fB\fR (\s-1AT&T 610,\s0 XTerm)" 4
2050 root 1.126 .IX Item "Pm = 12 (AT&T 610, XTerm)"
2051     .TS
2052     l l .
2053     h Blinking cursor (cvvis)
2054     l Steady cursor (cnorm)
2055     .TE
2056 root 1.123 .ie n .IP "\fB\fB""Pm = 25""\fB\fR (\s-1DECTCEM\s0)" 4
2057     .el .IP "\fB\f(CBPm = 25\fB\fR (\s-1DECTCEM\s0)" 4
2058     .IX Item "Pm = 25 (DECTCEM)"
2059 root 1.1 .TS
2060     l l .
2061     h Visible cursor {cnorm/cvvis}
2062     l Invisible cursor {civis}
2063     .TE
2064 root 1.126 .ie n .IP "\fB\fB""Pm = 30""\fB\fR (\fBrxvt\fR)" 4
2065     .el .IP "\fB\f(CBPm = 30\fB\fR (\fBrxvt\fR)" 4
2066     .IX Item "Pm = 30 (rxvt)"
2067 root 1.1 .TS
2068     l l .
2069 root 1.95 h scrollBar visible
2070     l scrollBar invisible
2071 root 1.1 .TE
2072 root 1.76 .ie n .IP "\fB\fB""Pm = 35""\fB\fR (\fBrxvt\fR)" 4
2073     .el .IP "\fB\f(CBPm = 35\fB\fR (\fBrxvt\fR)" 4
2074     .IX Item "Pm = 35 (rxvt)"
2075 root 1.1 .TS
2076     l l .
2077     h Allow XTerm Shift+key sequences
2078     l Disallow XTerm Shift+key sequences
2079     .TE
2080 root 1.76 .ie n .IP "\fB\fB""Pm = 38""\fB\fR \fIunimplemented\fR" 4
2081     .el .IP "\fB\f(CBPm = 38\fB\fR \fIunimplemented\fR" 4
2082     .IX Item "Pm = 38 unimplemented"
2083 root 1.1 .PD
2084     Enter Tektronix Mode (\s-1DECTEK\s0)
2085 root 1.76 .ie n .IP "\fB\fB""Pm = 40""\fB\fR" 4
2086     .el .IP "\fB\f(CBPm = 40\fB\fR" 4
2087     .IX Item "Pm = 40"
2088 root 1.1 .TS
2089     l l .
2090     h Allow 80/132 Mode
2091     l Disallow 80/132 Mode
2092     .TE
2093     .PD 0
2094 root 1.76 .ie n .IP "\fB\fB""Pm = 44""\fB\fR \fIunimplemented\fR" 4
2095     .el .IP "\fB\f(CBPm = 44\fB\fR \fIunimplemented\fR" 4
2096     .IX Item "Pm = 44 unimplemented"
2097 root 1.1 .TS
2098     l l .
2099     h Turn On Margin Bell
2100     l Turn Off Margin Bell
2101     .TE
2102 root 1.76 .ie n .IP "\fB\fB""Pm = 45""\fB\fR \fIunimplemented\fR" 4
2103     .el .IP "\fB\f(CBPm = 45\fB\fR \fIunimplemented\fR" 4
2104     .IX Item "Pm = 45 unimplemented"
2105 root 1.1 .TS
2106     l l .
2107     h Reverse-wraparound Mode
2108     l No Reverse-wraparound Mode
2109     .TE
2110 root 1.76 .ie n .IP "\fB\fB""Pm = 46""\fB\fR \fIunimplemented\fR" 4
2111     .el .IP "\fB\f(CBPm = 46\fB\fR \fIunimplemented\fR" 4
2112     .IX Item "Pm = 46 unimplemented"
2113     .ie n .IP "\fB\fB""Pm = 47""\fB\fR" 4
2114     .el .IP "\fB\f(CBPm = 47\fB\fR" 4
2115     .IX Item "Pm = 47"
2116 root 1.1 .TS
2117     l l .
2118     h Use Alternate Screen Buffer
2119     l Use Normal Screen Buffer
2120     .TE
2121     .PD
2122    
2123     .IX Xref "Priv66"
2124 root 1.123 .ie n .IP "\fB\fB""Pm = 66""\fB\fR (\s-1DECNKM\s0)" 4
2125     .el .IP "\fB\f(CBPm = 66\fB\fR (\s-1DECNKM\s0)" 4
2126     .IX Item "Pm = 66 (DECNKM)"
2127 root 1.1 .TS
2128     l l .
2129 sf-exg 1.102 h Application Keypad (DECKPAM/DECPAM) == ESC =
2130     l Normal Keypad (DECKPNM/DECPNM) == ESC >
2131 root 1.1 .TE
2132     .PD 0
2133 root 1.123 .ie n .IP "\fB\fB""Pm = 67""\fB\fR (\s-1DECBKM\s0)" 4
2134     .el .IP "\fB\f(CBPm = 67\fB\fR (\s-1DECBKM\s0)" 4
2135     .IX Item "Pm = 67 (DECBKM)"
2136 root 1.1 .TS
2137     l l .
2138 root 1.123 h Backspace key sends BS
2139 root 1.1 l Backspace key sends DEL
2140     .TE
2141 root 1.126 .ie n .IP "\fB\fB""Pm = 1000""\fB\fR (X11 XTerm mouse protocol)" 4
2142     .el .IP "\fB\f(CBPm = 1000\fB\fR (X11 XTerm mouse protocol)" 4
2143     .IX Item "Pm = 1000 (X11 XTerm mouse protocol)"
2144 root 1.1 .TS
2145     l l .
2146     h Send Mouse X & Y on button press and release.
2147     l No mouse reporting.
2148     .TE
2149 root 1.76 .ie n .IP "\fB\fB""Pm = 1001""\fB\fR (X11 XTerm) \fIunimplemented\fR" 4
2150     .el .IP "\fB\f(CBPm = 1001\fB\fR (X11 XTerm) \fIunimplemented\fR" 4
2151     .IX Item "Pm = 1001 (X11 XTerm) unimplemented"
2152 root 1.1 .TS
2153     l l .
2154     h Use Hilite Mouse Tracking.
2155     l No mouse reporting.
2156     .TE
2157 root 1.126 .ie n .IP "\fB\fB""Pm = 1002""\fB\fR (X11 XTerm cell motion mouse tracking)" 4
2158     .el .IP "\fB\f(CBPm = 1002\fB\fR (X11 XTerm cell motion mouse tracking)" 4
2159     .IX Item "Pm = 1002 (X11 XTerm cell motion mouse tracking)"
2160 sasha 1.87 .TS
2161     l l .
2162     h Send Mouse X & Y on button press and release, and motion with a button pressed.
2163     l No mouse reporting.
2164     .TE
2165 root 1.126 .ie n .IP "\fB\fB""Pm = 1003""\fB\fR (X11 XTerm all motion mouse tracking)" 4
2166     .el .IP "\fB\f(CBPm = 1003\fB\fR (X11 XTerm all motion mouse tracking)" 4
2167     .IX Item "Pm = 1003 (X11 XTerm all motion mouse tracking)"
2168 sasha 1.87 .TS
2169     l l .
2170     h Send Mouse X & Y on button press and release, and motion.
2171     l No mouse reporting.
2172     .TE
2173 root 1.126 .ie n .IP "\fB\fB""Pm = 1004""\fB\fR (X11 XTerm focus in/focus out events) \fIunimplemented\fR" 4
2174     .el .IP "\fB\f(CBPm = 1004\fB\fR (X11 XTerm focus in/focus out events) \fIunimplemented\fR" 4
2175     .IX Item "Pm = 1004 (X11 XTerm focus in/focus out events) unimplemented"
2176     .TS
2177     l l .
2178     h Send Mouse focus in/focus out events.
2179     l Don'T send focus events.
2180     .TE
2181     .ie n .IP "\fB\fB""Pm = 1005""\fB\fR (X11 XTerm \s-1UTF\-8\s0 mouse mode) (Compile frills)" 4
2182     .el .IP "\fB\f(CBPm = 1005\fB\fR (X11 XTerm \s-1UTF\-8\s0 mouse mode) (Compile frills)" 4
2183     .IX Item "Pm = 1005 (X11 XTerm UTF-8 mouse mode) (Compile frills)"
2184 root 1.106 .PD
2185     Try to avoid this mode, it doesn't work sensibly in non\-UTF\-8 locales. Use
2186     mode \f(CW1015\fR instead.
2187     .Sp
2188     Unlike XTerm, coordinates larger than 2015) will work fine.
2189     .TS
2190     l l .
2191     h Enable mouse coordinates in locale-specific encoding.
2192     l Enable mouse coordinates as binary octets.
2193     .TE
2194 root 1.76 .ie n .IP "\fB\fB""Pm = 1010""\fB\fR (\fBrxvt\fR)" 4
2195     .el .IP "\fB\f(CBPm = 1010\fB\fR (\fBrxvt\fR)" 4
2196     .IX Item "Pm = 1010 (rxvt)"
2197 root 1.1 .TS
2198     l l .
2199     h Don't scroll to bottom on TTY output
2200     l Scroll to bottom on TTY output
2201     .TE
2202 root 1.106 .PD 0
2203 root 1.76 .ie n .IP "\fB\fB""Pm = 1011""\fB\fR (\fBrxvt\fR)" 4
2204     .el .IP "\fB\f(CBPm = 1011\fB\fR (\fBrxvt\fR)" 4
2205     .IX Item "Pm = 1011 (rxvt)"
2206 root 1.1 .TS
2207     l l .
2208     h Scroll to bottom when a key is pressed
2209     l Don't scroll to bottom when a key is pressed
2210     .TE
2211 root 1.106 .ie n .IP "\fB\fB""Pm = 1015""\fB\fR (\fBrxvt-unicode\fR) (Compile frills)" 4
2212     .el .IP "\fB\f(CBPm = 1015\fB\fR (\fBrxvt-unicode\fR) (Compile frills)" 4
2213     .IX Item "Pm = 1015 (rxvt-unicode) (Compile frills)"
2214 root 1.126 .TS
2215     l l .
2216     h Enable urxvt mouse coordinate reporting.
2217     l Use old-style CSI M C C C encoding.
2218     .TE
2219 root 1.106 .PD
2220     Changes all mouse reporting codes to use decimal parameters instead of
2221     octets or characters.
2222     .Sp
2223     This mode should be enabled \fIbefore\fR actually enabling mouse reporting,
2224     for semi-obvious reasons.
2225     .Sp
2226     The sequences received for various modes are as follows:
2227     .Sp
2228     .Vb 3
2229     \& ESC [ M o o o !1005, !1015 (three octets)
2230     \& ESC [ M c c c 1005, !1015 (three characters)
2231 sf-exg 1.108 \& ESC [ Pm M 1015 (three or more numeric parameters)
2232 root 1.106 .Ve
2233     .Sp
2234 sf-exg 1.108 The first three parameters are \f(CW\*(C`code\*(C'\fR, \f(CW\*(C`x\*(C'\fR and \f(CW\*(C`y\*(C'\fR. Code is the numeric
2235     code as for the other modes (but encoded as a decimal number, including
2236     the additional offset of 32, so you have to subtract 32 first), \f(CW\*(C`x\*(C'\fR and
2237     \&\f(CW\*(C`y\*(C'\fR are the coordinates (1|1 is the upper left corner, just as with
2238     cursor positioning).
2239 root 1.106 .Sp
2240     Example: Shift\-Button\-1 press at top row, column 80.
2241     .Sp
2242     .Vb 1
2243 sf-exg 1.108 \& ESC [ 37 ; 80 ; 1 M
2244 root 1.106 .Ve
2245     .Sp
2246     One can use this feature by simply enabling it and then looking for
2247     parameters to the \f(CW\*(C`ESC [ M\*(C'\fR reply \- if there are any, this mode is
2248     active, otherwise one of the old reporting styles is used.
2249     .Sp
2250     Other (to be implemented) reply sequences will use a similar encoding.
2251     .Sp
2252     In the future, more parameters might get added (pixel coordinates for
2253     example \- anybody out there who needs this?).
2254 root 1.76 .ie n .IP "\fB\fB""Pm = 1021""\fB\fR (\fBrxvt\fR)" 4
2255     .el .IP "\fB\f(CBPm = 1021\fB\fR (\fBrxvt\fR)" 4
2256     .IX Item "Pm = 1021 (rxvt)"
2257 root 1.30 .TS
2258     l l .
2259     h Bold/italic implies high intensity (see option -is)
2260     l Font styles have no effect on intensity (Compile styles)
2261     .TE
2262 root 1.106 .PD 0
2263 root 1.126 .ie n .IP "\fB\fB""Pm = 1047""\fB\fR (X11 XTerm alternate screen buffer)" 4
2264     .el .IP "\fB\f(CBPm = 1047\fB\fR (X11 XTerm alternate screen buffer)" 4
2265     .IX Item "Pm = 1047 (X11 XTerm alternate screen buffer)"
2266 root 1.1 .TS
2267     l l .
2268     h Use Alternate Screen Buffer
2269     l Use Normal Screen Buffer - clear Alternate Screen Buffer if returning from it
2270     .TE
2271 root 1.126 .ie n .IP "\fB\fB""Pm = 1048""\fB\fR (X11 XTerm alternate \s-1DECSC\s0)" 4
2272     .el .IP "\fB\f(CBPm = 1048\fB\fR (X11 XTerm alternate \s-1DECSC\s0)" 4
2273     .IX Item "Pm = 1048 (X11 XTerm alternate DECSC)"
2274 root 1.1 .TS
2275     l l .
2276     h Save cursor position
2277     l Restore cursor position
2278     .TE
2279 root 1.126 .ie n .IP "\fB\fB""Pm = 1049""\fB\fR (X11 XTerm 1047 + 1048)" 4
2280     .el .IP "\fB\f(CBPm = 1049\fB\fR (X11 XTerm 1047 + 1048)" 4
2281     .IX Item "Pm = 1049 (X11 XTerm 1047 + 1048)"
2282 root 1.1 .TS
2283     l l .
2284     h Use Alternate Screen Buffer - clear Alternate Screen Buffer if switching to it
2285     l Use Normal Screen Buffer
2286     .TE
2287 root 1.126 .ie n .IP "\fB\fB""Pm = 2004""\fB\fR (X11 XTerm bracketed paste mode)" 4
2288     .el .IP "\fB\f(CBPm = 2004\fB\fR (X11 XTerm bracketed paste mode)" 4
2289     .IX Item "Pm = 2004 (X11 XTerm bracketed paste mode)"
2290 root 1.95 .TS
2291     l l .
2292     h Enable bracketed paste mode - prepend / append to the pasted text the control sequences ESC [ 200 ~ / ESC [ 201 ~
2293     l Disable bracketed paste mode
2294     .TE
2295 root 1.1 .RE
2296     .RS 4
2297     .RE
2298     .PD
2299     .PP
2300    
2301     .IX Xref "XTerm"
2302 root 1.100 .SS "XTerm Operating System Commands"
2303 root 1.69 .IX Subsection "XTerm Operating System Commands"
2304 root 1.12 .ie n .IP "\fB\fB""ESC ] Ps;Pt ST""\fB\fR" 4
2305     .el .IP "\fB\f(CBESC ] Ps;Pt ST\fB\fR" 4
2306 root 1.1 .IX Item "ESC ] Ps;Pt ST"
2307     Set XTerm Parameters. 8\-bit \s-1ST:\s0 0x9c, 7\-bit \s-1ST\s0 sequence: \s-1ESC\s0 \e (0x1b,
2308 root 1.128 0x5c), backwards compatible terminator \s-1BEL \s0(0x07) is also accepted. any
2309     \&\fBoctet\fR can be escaped by prefixing it with \s-1SYN \s0(0x16, ^V).
2310 root 1.1 .TS
2311     l l .
2312     Ps = 0 Change Icon Name and Window Title to Pt
2313     Ps = 1 Change Icon Name to Pt
2314     Ps = 2 Change Window Title to Pt
2315     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.
2316     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
2317 root 1.95 Ps = 10 Change colour of text foreground to Pt
2318     Ps = 11 Change colour of text background to Pt
2319 root 1.1 Ps = 12 Change colour of text cursor foreground to Pt
2320     Ps = 13 Change colour of mouse foreground to Pt
2321 sf-exg 1.102 Ps = 17 Change background colour of highlight characters to Pt
2322     Ps = 19 Change foreground colour of highlight characters to Pt
2323 root 1.118 Ps = 20 Change background pixmap parameters (see section BACKGROUND IMAGE) (Compile pixbuf).
2324 root 1.95 Ps = 39 Change default foreground colour to Pt. [deprecated, use 10]
2325 root 1.1 Ps = 46 Change Log File to Pt unimplemented
2326 root 1.95 Ps = 49 Change default background colour to Pt. [deprecated, use 11]
2327 root 1.1 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
2328 root 1.95 Ps = 55 Log all scrollback buffer and all of screen to Pt [disabled]
2329 root 1.19 Ps = 701 Change current locale to Pt, or, if Pt is ?, return the current locale (Compile frills).
2330 root 1.54 Ps = 702 Request version if Pt is ?, returning rxvt-unicode, the resource name, the major and minor version numbers, e.g. ESC ] 702 ; rxvt-unicode ; urxvt ; 7 ; 4 ST.
2331 root 1.1 Ps = 704 Change colour of italic characters to Pt
2332 root 1.19 Ps = 705 Change background pixmap tint colour to Pt (Compile transparency).
2333 root 1.39 Ps = 706 Change colour of bold characters to Pt
2334     Ps = 707 Change colour of underlined characters to Pt
2335 root 1.99 Ps = 708 Change colour of the border to Pt
2336 root 1.1 Ps = 710 Set normal fontset to Pt. Same as Ps = 50.
2337 root 1.19 Ps = 711 Set bold fontset to Pt. Similar to Ps = 50 (Compile styles).
2338     Ps = 712 Set italic fontset to Pt. Similar to Ps = 50 (Compile styles).
2339     Ps = 713 Set bold-italic fontset to Pt. Similar to Ps = 50 (Compile styles).
2340     Ps = 720 Move viewing window up by Pt lines, or clear scrollback buffer if Pt = 0 (Compile frills).
2341     Ps = 721 Move viewing window down by Pt lines, or clear scrollback buffer if Pt = 0 (Compile frills).
2342 root 1.33 Ps = 777 Call the perl extension with the given string, which should be of the form extension:parameters (Compile perl).
2343 root 1.1 .TE
2344 sasha 1.87 .SH "BACKGROUND IMAGE"
2345     .IX Header "BACKGROUND IMAGE"
2346 root 1.128 For the \s-1BACKGROUND IMAGE\s0 XTerm escape sequence \fB\f(CB\*(C`ESC ] 20 ; Pt ST\*(C'\fB\fR the value
2347 root 1.106 of \fB\f(CB\*(C`Pt\*(C'\fB\fR can be one of the following commands:
2348     .ie n .IP "\fB\fB""?""\fB\fR" 4
2349     .el .IP "\fB\f(CB?\fB\fR" 4
2350     .IX Item "?"
2351     display scale and position in the title
2352     .ie n .IP "\fB\fB"";WxH+X+Y""\fB\fR" 4
2353     .el .IP "\fB\f(CB;WxH+X+Y\fB\fR" 4
2354     .IX Item ";WxH+X+Y"
2355     change scale and/or position
2356     .ie n .IP "\fB\fB""FILE;WxH+X+Y""\fB\fR" 4
2357     .el .IP "\fB\f(CBFILE;WxH+X+Y\fB\fR" 4
2358     .IX Item "FILE;WxH+X+Y"
2359     change background image
2360 root 1.97 .PP
2361    
2362     .IX Xref "Mouse"
2363 root 1.1 .SH "Mouse Reporting"
2364     .IX Header "Mouse Reporting"
2365 root 1.12 .ie n .IP "\fB\fB""ESC [ M <b> <x> <y>""\fB\fR" 4
2366     .el .IP "\fB\f(CBESC [ M <b> <x> <y>\fB\fR" 4
2367 root 1.1 .IX Item "ESC [ M <b> <x> <y>"
2368     report mouse position
2369     .PP
2370     The lower 2 bits of \fB\f(CB\*(C`<b>\*(C'\fB\fR indicate the button:
2371 root 1.12 .ie n .IP "Button = \fB\fB""(<b> \- SPACE) & 3""\fB\fR" 4
2372     .el .IP "Button = \fB\f(CB(<b> \- SPACE) & 3\fB\fR" 4
2373 root 1.1 .IX Item "Button = (<b> - SPACE) & 3"
2374     .TS
2375     l l .
2376     0 Button1 pressed
2377     1 Button2 pressed
2378     2 Button3 pressed
2379     3 button released (X11 mouse report)
2380     .TE
2381     .PP
2382     The upper bits of \fB\f(CB\*(C`<b>\*(C'\fB\fR indicate the modifiers when the
2383     button was pressed and are added together (X11 mouse report only):
2384 sf-exg 1.108 .ie n .IP "State = \fB\fB""(<b> \- SPACE) & ~3""\fB\fR" 4
2385     .el .IP "State = \fB\f(CB(<b> \- SPACE) & ~3\fB\fR" 4
2386     .IX Item "State = (<b> - SPACE) & ~3"
2387 root 1.1 .TS
2388     l l .
2389     4 Shift
2390     8 Meta
2391     16 Control
2392 sf-exg 1.108 32 Motion Notify
2393     32 Double Click (rxvt extension), disabled by default
2394     64 Button1 is actually Button4, Button2 is actually Button5 etc.
2395 root 1.1 .TE
2396     Col = \fB\f(CB\*(C`<x> \- SPACE\*(C'\fB\fR
2397     .Sp
2398     Row = \fB\f(CB\*(C`<y> \- SPACE\*(C'\fB\fR
2399     .SH "Key Codes"
2400     .IX Header "Key Codes"
2401 root 1.97
2402     .IX Xref "KeyCodes"
2403     .PP
2404 root 1.1 Note: \fBShift\fR + \fBF1\fR\-\fBF10\fR generates \fBF11\fR\-\fBF20\fR
2405     .PP
2406 root 1.126 For the keypad, use \fBShift\fR to temporarily toggle Application Keypad
2407     mode and use \fBNum_Lock\fR to override Application Keypad mode, i.e. if
2408     \&\fBNum_Lock\fR is on the keypad is in normal mode. Also note that the
2409     values of \fBBackSpace\fR, \fBDelete\fR may have been compiled differently
2410     on your system.
2411 root 1.1 .TS
2412     l l l l l .
2413     Normal Shift Control Ctrl+Shift
2414     Tab ^I ESC [ Z ^I ESC [ Z
2415 root 1.126 BackSpace ^? ^? ^H ^H
2416 root 1.1 Find ESC [ 1 ~ ESC [ 1 $ ESC [ 1 ^ ESC [ 1 @
2417     Insert ESC [ 2 ~ paste ESC [ 2 ^ ESC [ 2 @
2418     Execute ESC [ 3 ~ ESC [ 3 $ ESC [ 3 ^ ESC [ 3 @
2419     Select ESC [ 4 ~ ESC [ 4 $ ESC [ 4 ^ ESC [ 4 @
2420     Prior ESC [ 5 ~ scroll-up ESC [ 5 ^ ESC [ 5 @
2421     Next ESC [ 6 ~ scroll-down ESC [ 6 ^ ESC [ 6 @
2422     Home ESC [ 7 ~ ESC [ 7 $ ESC [ 7 ^ ESC [ 7 @
2423     End ESC [ 8 ~ ESC [ 8 $ ESC [ 8 ^ ESC [ 8 @
2424     Delete ESC [ 3 ~ ESC [ 3 $ ESC [ 3 ^ ESC [ 3 @
2425     F1 ESC [ 11 ~ ESC [ 23 ~ ESC [ 11 ^ ESC [ 23 ^
2426     F2 ESC [ 12 ~ ESC [ 24 ~ ESC [ 12 ^ ESC [ 24 ^
2427     F3 ESC [ 13 ~ ESC [ 25 ~ ESC [ 13 ^ ESC [ 25 ^
2428     F4 ESC [ 14 ~ ESC [ 26 ~ ESC [ 14 ^ ESC [ 26 ^
2429     F5 ESC [ 15 ~ ESC [ 28 ~ ESC [ 15 ^ ESC [ 28 ^
2430     F6 ESC [ 17 ~ ESC [ 29 ~ ESC [ 17 ^ ESC [ 29 ^
2431     F7 ESC [ 18 ~ ESC [ 31 ~ ESC [ 18 ^ ESC [ 31 ^
2432     F8 ESC [ 19 ~ ESC [ 32 ~ ESC [ 19 ^ ESC [ 32 ^
2433     F9 ESC [ 20 ~ ESC [ 33 ~ ESC [ 20 ^ ESC [ 33 ^
2434     F10 ESC [ 21 ~ ESC [ 34 ~ ESC [ 21 ^ ESC [ 34 ^
2435     F11 ESC [ 23 ~ ESC [ 23 $ ESC [ 23 ^ ESC [ 23 @
2436     F12 ESC [ 24 ~ ESC [ 24 $ ESC [ 24 ^ ESC [ 24 @
2437     F13 ESC [ 25 ~ ESC [ 25 $ ESC [ 25 ^ ESC [ 25 @
2438     F14 ESC [ 26 ~ ESC [ 26 $ ESC [ 26 ^ ESC [ 26 @
2439     F15 (Help) ESC [ 28 ~ ESC [ 28 $ ESC [ 28 ^ ESC [ 28 @
2440     F16 (Menu) ESC [ 29 ~ ESC [ 29 $ ESC [ 29 ^ ESC [ 29 @
2441     F17 ESC [ 31 ~ ESC [ 31 $ ESC [ 31 ^ ESC [ 31 @
2442     F18 ESC [ 32 ~ ESC [ 32 $ ESC [ 32 ^ ESC [ 32 @
2443     F19 ESC [ 33 ~ ESC [ 33 $ ESC [ 33 ^ ESC [ 33 @
2444     F20 ESC [ 34 ~ ESC [ 34 $ ESC [ 34 ^ ESC [ 34 @
2445     Application
2446     Up ESC [ A ESC [ a ESC O a ESC O A
2447     Down ESC [ B ESC [ b ESC O b ESC O B
2448     Right ESC [ C ESC [ c ESC O c ESC O C
2449     Left ESC [ D ESC [ d ESC O d ESC O D
2450     KP_Enter ^M ESC O M
2451     KP_F1 ESC O P ESC O P
2452     KP_F2 ESC O Q ESC O Q
2453     KP_F3 ESC O R ESC O R
2454     KP_F4 ESC O S ESC O S
2455 root 1.126 KP_Multiply * ESC O j
2456     KP_Add + ESC O k
2457     KP_Separator , ESC O l
2458     KP_Subtract - ESC O m
2459     KP_Decimal . ESC O n
2460     KP_Divide / ESC O o
2461     KP_0 0 ESC O p
2462     KP_1 1 ESC O q
2463     KP_2 2 ESC O r
2464     KP_3 3 ESC O s
2465     KP_4 4 ESC O t
2466     KP_5 5 ESC O u
2467     KP_6 6 ESC O v
2468     KP_7 7 ESC O w
2469     KP_8 8 ESC O x
2470     KP_9 9 ESC O y
2471 root 1.1 .TE
2472     .SH "CONFIGURE OPTIONS"
2473     .IX Header "CONFIGURE OPTIONS"
2474     General hint: if you get compile errors, then likely your configuration
2475 root 1.25 hasn't been tested well. Either try with \f(CW\*(C`\-\-enable\-everything\*(C'\fR or use
2476 sasha 1.87 the default configuration (i.e. no \f(CW\*(C`\-\-enable\-xxx\*(C'\fR or \f(CW\*(C`\-\-disable\-xxx\*(C'\fR
2477     switches). Of course, you should always report when a combination doesn't
2478     work, so it can be fixed. Marc Lehmann <rxvt@schmorp.de>.
2479 root 1.25 .PP
2480     All
2481 root 1.1 .IP "\-\-enable\-everything" 4
2482     .IX Item "--enable-everything"
2483 sf-exg 1.102 Add (or remove) support for all non-multichoice options listed
2484     in \f(CW\*(C`./configure \-\-help\*(C'\fR, except for \f(CW\*(C`\-\-enable\-assert\*(C'\fR and
2485     \&\f(CW\*(C`\-\-enable\-256\-color\*(C'\fR.
2486 root 1.25 .Sp
2487     You can specify this and then disable options you do not like by
2488     \&\fIfollowing\fR this with the appropriate \f(CW\*(C`\-\-disable\-...\*(C'\fR arguments,
2489     or you can start with a minimal configuration by specifying
2490     \&\f(CW\*(C`\-\-disable\-everything\*(C'\fR and than adding just the \f(CW\*(C`\-\-enable\-...\*(C'\fR arguments
2491     you want.
2492 sf-exg 1.108 .IP "\-\-enable\-xft (default: on)" 4
2493     .IX Item "--enable-xft (default: on)"
2494 root 1.107 Add support for Xft (anti-aliased, among others) fonts. Xft fonts are
2495 root 1.1 slower and require lots of memory, but as long as you don't use them, you
2496     don't pay for them.
2497 root 1.25 .IP "\-\-enable\-font\-styles (default: on)" 4
2498     .IX Item "--enable-font-styles (default: on)"
2499 root 1.1 Add support for \fBbold\fR, \fIitalic\fR and \fB\f(BIbold italic\fB\fR font
2500     styles. The fonts can be set manually or automatically.
2501 sf-exg 1.108 .IP "\-\-with\-codesets=CS,... (default: all)" 4
2502     .IX Item "--with-codesets=CS,... (default: all)"
2503 root 1.20 Compile in support for additional codeset (encoding) groups (\f(CW\*(C`eu\*(C'\fR, \f(CW\*(C`vn\*(C'\fR
2504     are always compiled in, which includes most 8\-bit character sets). These
2505     codeset tables are used for driving X11 core fonts, they are not required
2506     for Xft fonts, although having them compiled in lets rxvt-unicode choose
2507     replacement fonts more intelligently. Compiling them in will make your
2508     binary bigger (all of together cost about 700kB), but it doesn't increase
2509     memory usage unless you use a font requiring one of these encodings.
2510 root 1.1 .TS
2511     l l .
2512     all all available codeset groups
2513     zh common chinese encodings
2514 root 1.82 zh_ext rarely used but very big chinese encodings
2515 root 1.1 jp common japanese encodings
2516     jp_ext rarely used but big japanese encodings
2517     kr korean encodings
2518     .TE
2519 root 1.25 .IP "\-\-enable\-xim (default: on)" 4
2520     .IX Item "--enable-xim (default: on)"
2521 root 1.128 Add support for \s-1XIM \s0(X Input Method) protocol. This allows using
2522 root 1.1 alternative input methods (e.g. kinput2) and will also correctly
2523     set up the input for people using dead keys or compose keys.
2524 root 1.25 .IP "\-\-enable\-unicode3 (default: off)" 4
2525     .IX Item "--enable-unicode3 (default: off)"
2526 root 1.51 Recommended to stay off unless you really need non-BMP characters.
2527     .Sp
2528 root 1.1 Enable direct support for displaying unicode codepoints above
2529     65535 (the basic multilingual page). This increases storage
2530     requirements per character from 2 to 4 bytes. X11 fonts do not yet
2531     support these extra characters, but Xft does.
2532     .Sp
2533     Please note that rxvt-unicode can store unicode code points >65535
2534     even without this flag, but the number of such characters is
2535 root 1.84 limited to a few thousand (shared with combining characters,
2536 root 1.1 see next switch), and right now rxvt-unicode cannot display them
2537     (input/output and cut&paste still work, though).
2538 root 1.25 .IP "\-\-enable\-combining (default: on)" 4
2539     .IX Item "--enable-combining (default: on)"
2540 root 1.1 Enable automatic composition of combining characters into
2541     composite characters. This is required for proper viewing of text
2542 root 1.101 where accents are encoded as separate unicode characters. This is
2543 sf-exg 1.108 done by using precomposed characters when available or creating
2544 root 1.1 new pseudo-characters when no precomposed form exists.
2545     .Sp
2546 root 1.51 Without \-\-enable\-unicode3, the number of additional precomposed
2547     characters is somewhat limited (the 6400 private use characters will be
2548     (ab\-)used). With \-\-enable\-unicode3, no practical limit exists.
2549 root 1.14 .Sp
2550     This option will also enable storage (but not display) of characters
2551     beyond plane 0 (>65535) when \-\-enable\-unicode3 was not specified.
2552 root 1.1 .Sp
2553     The combining table also contains entries for arabic presentation forms,
2554 root 1.14 but these are not currently used. Bug me if you want these to be used (and
2555     tell me how these are to be used...).
2556 sf-exg 1.108 .IP "\-\-enable\-fallback[=CLASS] (default: Rxvt)" 4
2557     .IX Item "--enable-fallback[=CLASS] (default: Rxvt)"
2558 root 1.128 When reading resource settings, also read settings for class \s-1CLASS.\s0 To
2559 root 1.51 disable resource fallback use \-\-disable\-fallback.
2560 root 1.25 .IP "\-\-with\-res\-name=NAME (default: urxvt)" 4
2561     .IX Item "--with-res-name=NAME (default: urxvt)"
2562     Use the given name as default application name when
2563 root 1.1 reading resources. Specify \-\-with\-res\-name=rxvt to replace rxvt.
2564 root 1.92 .IP "\-\-with\-res\-class=CLASS (default: URxvt)" 4
2565     .IX Item "--with-res-class=CLASS (default: URxvt)"
2566 root 1.25 Use the given class as default application class
2567     when reading resources. Specify \-\-with\-res\-class=Rxvt to replace
2568 root 1.1 rxvt.
2569 root 1.25 .IP "\-\-enable\-utmp (default: on)" 4
2570     .IX Item "--enable-utmp (default: on)"
2571 root 1.1 Write user and tty to utmp file (used by programs like \fIw\fR) at
2572     start of rxvt execution and delete information when rxvt exits.
2573 root 1.25 .IP "\-\-enable\-wtmp (default: on)" 4
2574     .IX Item "--enable-wtmp (default: on)"
2575 root 1.1 Write user and tty to wtmp file (used by programs like \fIlast\fR) at
2576     start of rxvt execution and write logout when rxvt exits. This
2577     option requires \-\-enable\-utmp to also be specified.
2578 root 1.25 .IP "\-\-enable\-lastlog (default: on)" 4
2579     .IX Item "--enable-lastlog (default: on)"
2580 root 1.1 Write user and tty to lastlog file (used by programs like
2581     \&\fIlastlogin\fR) at start of rxvt execution. This option requires
2582     \&\-\-enable\-utmp to also be specified.
2583 sf-exg 1.108 .IP "\-\-enable\-pixbuf (default: on)" 4
2584     .IX Item "--enable-pixbuf (default: on)"
2585 root 1.103 Add support for GDK-PixBuf to be used for background images.
2586 root 1.128 It adds support for many file formats including \s-1JPG, PNG,
2587     TIFF, GIF, XPM, BMP, ICO\s0 and \s-1TGA.\s0
2588 sf-exg 1.113 .IP "\-\-enable\-startup\-notification (default: on)" 4
2589     .IX Item "--enable-startup-notification (default: on)"
2590     Add support for freedesktop startup notifications. This allows window managers
2591     to display some kind of progress indicator during startup.
2592 root 1.36 .IP "\-\-enable\-transparency (default: on)" 4
2593     .IX Item "--enable-transparency (default: on)"
2594 root 1.105 Add support for using the root pixmap as background to simulate transparency.
2595 root 1.120 Note that this feature depends on libXrender and on the availability
2596     of the \s-1RENDER\s0 extension in the X server.
2597 root 1.25 .IP "\-\-enable\-fading (default: on)" 4
2598     .IX Item "--enable-fading (default: on)"
2599 root 1.86 Add support for fading the text when focus is lost.
2600 root 1.25 .IP "\-\-enable\-rxvt\-scroll (default: on)" 4
2601     .IX Item "--enable-rxvt-scroll (default: on)"
2602 root 1.1 Add support for the original rxvt scrollbar.
2603 root 1.25 .IP "\-\-enable\-next\-scroll (default: on)" 4
2604     .IX Item "--enable-next-scroll (default: on)"
2605 root 1.1 Add support for a NeXT-like scrollbar.
2606 root 1.25 .IP "\-\-enable\-xterm\-scroll (default: on)" 4
2607     .IX Item "--enable-xterm-scroll (default: on)"
2608 root 1.1 Add support for an Xterm-like scrollbar.
2609     .IP "\-\-disable\-backspace\-key" 4
2610     .IX Item "--disable-backspace-key"
2611 root 1.25 Removes any handling of the backspace key by us \- let the X server do it.
2612 root 1.1 .IP "\-\-disable\-delete\-key" 4
2613     .IX Item "--disable-delete-key"
2614 root 1.25 Removes any handling of the delete key by us \- let the X server
2615 root 1.1 do it.
2616     .IP "\-\-disable\-resources" 4
2617     .IX Item "--disable-resources"
2618 root 1.25 Removes any support for resource checking.
2619 root 1.1 .IP "\-\-disable\-swapscreen" 4
2620     .IX Item "--disable-swapscreen"
2621 root 1.25 Remove support for secondary/swap screen.
2622     .IP "\-\-enable\-frills (default: on)" 4
2623     .IX Item "--enable-frills (default: on)"
2624 root 1.1 Add support for many small features that are not essential but nice to
2625     have. Normally you want this, but for very small binaries you may want to
2626     disable this.
2627 root 1.2 .Sp
2628     A non-exhaustive list of features enabled by \f(CW\*(C`\-\-enable\-frills\*(C'\fR (possibly
2629     in combination with other switches) is:
2630     .Sp
2631 root 1.95 .Vb 10
2632     \& MWM\-hints
2633     \& EWMH\-hints (pid, utf8 names) and protocols (ping)
2634 root 1.83 \& urgency hint
2635 root 1.101 \& separate underline colour (\-underlineColor)
2636 root 1.95 \& settable border widths and borderless switch (\-w, \-b, \-bl)
2637     \& visual depth selection (\-depth)
2638 sf-exg 1.102 \& settable extra linespacing (\-lsp)
2639 root 1.95 \& iso\-14755 5.1 (basic) support
2640     \& tripleclickwords (\-tcw)
2641     \& settable insecure mode (\-insecure)
2642 root 1.12 \& keysym remapping support
2643 root 1.100 \& cursor blinking and underline cursor (\-bc, \-uc)
2644 root 1.95 \& XEmbed support (\-embed)
2645     \& user\-pty (\-pty\-fd)
2646     \& hold on exit (\-hold)
2647     \& compile in built\-in block graphics
2648     \& skip builtin block graphics (\-sbg)
2649 sf-exg 1.102 \& separate highlight colour (\-highlightColor, \-highlightTextColor)
2650 root 1.106 \& extended mouse reporting modes (1005 and 1015).
2651 root 1.119 \& visual selection via \-visual and \-depth.
2652 root 1.55 .Ve
2653     .Sp
2654 root 1.76 It also enables some non-essential features otherwise disabled, such as:
2655 root 1.55 .Sp
2656     .Vb 11
2657 root 1.95 \& some round\-trip time optimisations
2658 sf-exg 1.102 \& nearest colour allocation on pseudocolor screens
2659 root 1.82 \& UTF8_STRING support for selection
2660 root 1.34 \& sgr modes 90..97 and 100..107
2661 root 1.55 \& backindex and forwardindex escape sequences
2662 root 1.82 \& view change/zero scrollback escape sequences
2663 root 1.55 \& locale switching escape sequence
2664     \& window op and some xterm/OSC escape sequences
2665     \& rectangular selections
2666     \& trailing space removal for selections
2667     \& verbose X error handling
2668 root 1.2 .Ve
2669 root 1.25 .IP "\-\-enable\-iso14755 (default: on)" 4
2670     .IX Item "--enable-iso14755 (default: on)"
2671 root 1.128 Enable extended \s-1ISO 14755\s0 support (see @@RXVT_NAME@@(1)).
2672 root 1.97 Basic support (section 5.1) is enabled by \f(CW\*(C`\-\-enable\-frills\*(C'\fR, while
2673     support for 5.2, 5.3 and 5.4 is enabled with this switch.
2674 root 1.25 .IP "\-\-enable\-keepscrolling (default: on)" 4
2675     .IX Item "--enable-keepscrolling (default: on)"
2676 root 1.1 Add support for continual scrolling of the display when you hold
2677     the mouse button down on a scrollbar arrow.
2678 root 1.86 .IP "\-\-enable\-selectionscrolling (default: on)" 4
2679     .IX Item "--enable-selectionscrolling (default: on)"
2680     Add support for scrolling when the selection moves to the top or
2681     bottom of the screen.
2682 root 1.25 .IP "\-\-enable\-mousewheel (default: on)" 4
2683     .IX Item "--enable-mousewheel (default: on)"
2684 root 1.1 Add support for scrolling via mouse wheel or buttons 4 & 5.
2685 root 1.25 .IP "\-\-enable\-slipwheeling (default: on)" 4
2686     .IX Item "--enable-slipwheeling (default: on)"
2687 root 1.1 Add support for continual scrolling (using the mouse wheel as an
2688     accelerator) while the control key is held down. This option
2689     requires \-\-enable\-mousewheel to also be specified.
2690 root 1.86 .IP "\-\-enable\-smart\-resize (default: off)" 4
2691     .IX Item "--enable-smart-resize (default: off)"
2692     Add smart growth/shrink behaviour when resizing.
2693     This should keep the window corner which is closest to a corner of
2694 root 1.27 the screen in a fixed position.
2695 root 1.92 .IP "\-\-enable\-text\-blink (default: on)" 4
2696     .IX Item "--enable-text-blink (default: on)"
2697     Add support for blinking text.
2698 root 1.25 .IP "\-\-enable\-pointer\-blank (default: on)" 4
2699     .IX Item "--enable-pointer-blank (default: on)"
2700 root 1.1 Add support to have the pointer disappear when typing or inactive.
2701 root 1.51 .IP "\-\-enable\-perl (default: on)" 4
2702     .IX Item "--enable-perl (default: on)"
2703 root 1.32 Enable an embedded perl interpreter. See the \fB@@RXVT_NAME@@\f(BIperl\fB\|(3)\fR
2704 root 1.97 manpage for more info on this feature, or the files in \fIsrc/perl/\fR
2705     for the extensions that are installed by default.
2706     The perl interpreter that is used can be specified via the \f(CW\*(C`PERL\*(C'\fR
2707     environment variable when running configure. Even when compiled in,
2708     perl will \fInot\fR be initialised when all extensions have been disabled
2709 root 1.84 \&\f(CW\*(C`\-pe "" \-\-perl\-ext\-common ""\*(C'\fR, so it should be safe to enable from a
2710     resource standpoint.
2711 root 1.100 .IP "\-\-enable\-assert (default: off)" 4
2712     .IX Item "--enable-assert (default: off)"
2713     Enables the assertions in the code, normally disabled. This switch is only
2714     useful when developing rxvt-unicode.
2715 sf-exg 1.102 .IP "\-\-enable\-256\-color (default: off)" 4
2716     .IX Item "--enable-256-color (default: off)"
2717     Force use of so-called 256 colour mode, to work around buggy applications
2718     that do not support termcap/terminfo, or simply improve support for
2719     applications hardcoding the xterm 256 colour table.
2720     .Sp
2721     This switch breaks termcap/terminfo compatibility to \f(CW\*(C`TERM=rxvt\-unicode\*(C'\fR,
2722     and consequently sets \f(CW\*(C`TERM\*(C'\fR to \f(CW\*(C`rxvt\-unicode\-256color\*(C'\fR by default
2723     (\fIdoc/etc/\fR contains termcap/terminfo definitions for both).
2724     .Sp
2725     It also results in higher memory usage and can slow down @@RXVT_NAME@@
2726     dramatically when more than six fonts are in use by a terminal instance.
2727 root 1.25 .IP "\-\-with\-name=NAME (default: urxvt)" 4
2728     .IX Item "--with-name=NAME (default: urxvt)"
2729     Set the basename for the installed binaries, resulting
2730 root 1.3 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
2731     \&\f(CW\*(C`rxvt\*(C'\fR.
2732 root 1.95 .IP "\-\-with\-term=NAME (default: rxvt-unicode)" 4
2733 root 1.25 .IX Item "--with-term=NAME (default: rxvt-unicode)"
2734 root 1.128 Change the environmental variable for the terminal to \s-1NAME.\s0
2735 root 1.1 .IP "\-\-with\-terminfo=PATH" 4
2736     .IX Item "--with-terminfo=PATH"
2737     Change the environmental variable for the path to the terminfo tree to
2738 root 1.128 \&\s-1PATH.\s0
2739 root 1.1 .IP "\-\-with\-x" 4
2740     .IX Item "--with-x"
2741     Use the X Window System (pretty much default, eh?).
2742     .SH "AUTHORS"
2743     .IX Header "AUTHORS"
2744     Marc Lehmann <rxvt@schmorp.de> converted this document to pod and
2745     reworked it from the original Rxvt documentation, which was done by Geoff
2746     Wing <gcw@pobox.com>, who in turn used the XTerm documentation and other
2747     sources.