ViewVC Help
View File | Revision Log | Show Annotations | Download File
/cvs/rxvt-unicode/doc/rxvt.7.man.in
Revision: 1.126
Committed: Fri Dec 26 22:52:23 2014 UTC (9 years, 6 months ago) by root
Branch: MAIN
Changes since 1.125: +100 -105 lines
Log Message:
*** empty log message ***

File Contents

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