ViewVC Help
View File | Revision Log | Show Annotations | Download File
/cvs/rxvt-unicode/doc/rxvt.7.man.in
Revision: 1.98
Committed: Tue Nov 4 22:57:20 2008 UTC (15 years, 8 months ago) by root
Branch: MAIN
Changes since 1.97: +14 -1 lines
Log Message:
*** empty log message ***

File Contents

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