ViewVC Help
View File | Revision Log | Show Annotations | Download File
/cvs/rxvt-unicode/doc/rxvt.7.man.in
Revision: 1.130
Committed: Sat May 14 08:28:25 2016 UTC (8 years, 2 months ago) by root
Branch: MAIN
CVS Tags: rxvt-unicode-rel-9_22
Changes since 1.129: +9 -6 lines
Log Message:
9.22-maybe

File Contents

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