ViewVC Help
View File | Revision Log | Show Annotations | Download File
/cvs/rxvt-unicode/doc/rxvt.7.man.in
Revision: 1.106
Committed: Thu Dec 9 10:36:52 2010 UTC (13 years, 7 months ago) by root
Branch: MAIN
Changes since 1.105: +82 -54 lines
Log Message:
9.10 rc

File Contents

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