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