ViewVC Help
View File | Revision Log | Show Annotations | Download File
/cvs/rxvt-unicode/doc/rxvt.7.man.in
Revision: 1.132
Committed: Fri May 14 13:52:31 2021 UTC (3 years, 1 month ago) by root
Branch: MAIN
CVS Tags: rxvt-unicode-rel-9_26, rxvt-unicode-rel-9_25
Changes since 1.131: +1 -1 lines
Log Message:
9.25

File Contents

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