ViewVC Help
View File | Revision Log | Show Annotations | Download File
/cvs/rxvt-unicode/doc/rxvt.7.man.in
Revision: 1.127
Committed: Wed Dec 31 14:12:44 2014 UTC (9 years, 6 months ago) by root
Branch: MAIN
Changes since 1.126: +50 -59 lines
Log Message:
name, alldocclean

File Contents

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