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