ViewVC Help
View File | Revision Log | Show Annotations | Download File
/cvs/rxvt-unicode/doc/rxvt.7.man.in
Revision: 1.112
Committed: Thu Aug 11 08:49:43 2011 UTC (12 years, 11 months ago) by sf-exg
Branch: MAIN
Changes since 1.111: +3 -3 lines
Log Message:
*** empty log message ***

File Contents

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