ViewVC Help
View File | Revision Log | Show Annotations | Download File
/cvs/rxvt-unicode/doc/rxvt.7.man.in
Revision: 1.136
Committed: Mon Nov 22 15:43:26 2021 UTC (2 years, 7 months ago) by root
Branch: MAIN
CVS Tags: rxvt-unicode-rel-9_29, rxvt-unicode-rel-9_30
Changes since 1.135: +2 -1 lines
Log Message:
*** empty log message ***

File Contents

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