ViewVC Help
View File | Revision Log | Show Annotations | Download File
/cvs/rxvt-unicode/doc/rxvt.7.man.in
Revision: 1.67
Committed: Tue Jan 31 21:04:56 2006 UTC (18 years, 5 months ago) by root
Branch: MAIN
Changes since 1.66: +0 -5 lines
Log Message:
*** empty log message ***

File Contents

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