ViewVC Help
View File | Revision Log | Show Annotations | Download File
/cvs/rxvt-unicode/doc/rxvt.7.man.in
Revision: 1.103
Committed: Fri Oct 15 21:30:52 2010 UTC (13 years, 8 months ago) by root
Branch: MAIN
Changes since 1.102: +15 -32 lines
Log Message:
prerelease

File Contents

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