ViewVC Help
View File | Revision Log | Show Annotations | Download File
/cvs/rxvt-unicode/doc/rxvt.7.man.in
Revision: 1.92
Committed: Fri Dec 14 06:05:40 2007 UTC (16 years, 7 months ago) by root
Branch: MAIN
Changes since 1.91: +10 -8 lines
Log Message:
*** empty log message ***

File Contents

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