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