ViewVC Help
View File | Revision Log | Show Annotations | Download File
/cvs/rxvt-unicode/doc/rxvt.7.man.in
Revision: 1.88
Committed: Sat Oct 27 12:09:02 2007 UTC (16 years, 8 months ago) by root
Branch: MAIN
CVS Tags: rel-8_4
Changes since 1.87: +95 -95 lines
Log Message:
*** empty log message ***

File Contents

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