ViewVC Help
View File | Revision Log | Show Annotations | Download File
/cvs/rxvt-unicode/doc/rxvt.7.pod
(Generate patch)

Comparing rxvt-unicode/doc/rxvt.7.pod (file contents):
Revision 1.1 by root, Thu Aug 12 20:42:12 2004 UTC vs.
Revision 1.93 by root, Mon Jan 30 19:46:13 2006 UTC

1=head1 Rxvt Technical Reference 1=head1 NAME
2 2
3Marc Lehmann <rxvt@schmorp.de>, converted to pod and reworked from the 3RXVT REFERENCE - FAQ, command sequences and other background information
4original Rxvt documentation by Geoff Wing <gcw@pobox.com>, who in turn used 4
5the XTerm documentation and other sources. 5=head1 SYNOPSIS
6
7 # set a new font set
8 printf '\33]50;%s\007' 9x15,xft:Kochi" Mincho"
9
10 # change the locale and tell rxvt-unicode about it
11 export LC_CTYPE=ja_JP.EUC-JP; printf "\33]701;$LC_CTYPE\007"
12
13 # set window title
14 printf '\33]2;%s\007' "new window title"
15
16=head1 DESCRIPTION
17
18This document contains the FAQ, the RXVT TECHNICAL REFERENCE documenting
19all escape sequences, and other background information.
20
21The newest version of this document is
22also available on the World Wide Web at
23L<http://cvs.schmorp.de/browse/*checkout*/rxvt-unicode/doc/rxvt.7.html>.
24
25=head1 FREQUENTLY ASKED QUESTIONS
26
27=over 4
28
29=item The new selection selects pieces that are too big, how can I select
30single words?
31
32Yes. For example, if you want to select alphanumeric words, you can use
33the following resource:
34
35 URxvt.selection.pattern-0: ([[:word:]]+)
36
37If you click more than twice, the selection will be extended
38more and more.
39
40To get a selection that is very similar to the old code, try this pattern:
41
42 URxvt.selection.pattern-0: ([^"&'()*,;<=>?@[\\\\]^`{|})]+)
43
44Please also note that the I<LeftClick Shift-LeftClik> combination also
45selects words like the old code.
46
47=item I don't like the new selection/popups/hotkeys/perl, how do I
48change/disable it?
49
50You can disable the perl extension completely by setting the
51B<perl-ext-common> resource to the empty string, which also keeps
52rxvt-unicode from initialising perl, saving memory.
53
54If you only want to disable specific features, you first have to
55identify which perl extension is responsible. For this, read the section
56B<PREPACKAGED EXTENSIONS> in the @@RXVT_NAME@@perl(3) manpage. For
57example, to disable the B<selection-popup> and B<option-popup>, specify
58this B<perl-ext-common> resource:
59
60 URxvt.perl-ext-common: default,-selection-popup,-option-popup
61
62This will keep the default extensions, but disable the two popup
63extensions. Some extensions can also be configured, for example,
64scrollback search mode is triggered by B<M-s>. You can move it to any
65other combination either by setting the B<searchable-scrollback> resource:
66
67 URxvt.searchable-scrollback: CM-s
68
69=item Isn't rxvt supposed to be small? Don't all those features bloat?
70
71I often get asked about this, and I think, no, they didn't cause extra
72bloat. If you compare a minimal rxvt and a minimal urxvt, you can see
73that the urxvt binary is larger (due to some encoding tables always being
74compiled in), but it actually uses less memory (RSS) after startup. Even
75with C<--disable-everything>, this comparison is a bit unfair, as many
76features unique to urxvt (locale, encoding conversion, iso14755 etc.) are
77already in use in this mode.
78
79 text data bss drs rss filename
80 98398 1664 24 15695 1824 rxvt --disable-everything
81 188985 9048 66616 18222 1788 urxvt --disable-everything
82
83When you C<--enable-everything> (which _is_ unfair, as this involves xft
84and full locale/XIM support which are quite bloaty inside libX11 and my
85libc), the two diverge, but not unreasnobaly so.
86
87 text data bss drs rss filename
88 163431 2152 24 20123 2060 rxvt --enable-everything
89 1035683 49680 66648 29096 3680 urxvt --enable-everything
90
91The very large size of the text section is explained by the east-asian
92encoding tables, which, if unused, take up disk space but nothing else
93and can be compiled out unless you rely on X11 core fonts that use those
94encodings. The BSS size comes from the 64k emergency buffer that my c++
95compiler allocates (but of course doesn't use unless you are out of
96memory). Also, using an xft font instead of a core font immediately adds a
97few megabytes of RSS. Xft indeed is responsible for a lot of RSS even when
98not used.
99
100Of course, due to every character using two or four bytes instead of one,
101a large scrollback buffer will ultimately make rxvt-unicode use more
102memory.
103
104Compared to e.g. Eterm (5112k), aterm (3132k) and xterm (4680k), this
105still fares rather well. And compared to some monsters like gnome-terminal
106(21152k + extra 4204k in separate processes) or konsole (22200k + extra
10743180k in daemons that stay around after exit, plus half a minute of
108startup time, including the hundreds of warnings it spits out), it fares
109extremely well *g*.
110
111=item Why C++, isn't that unportable/bloated/uncool?
112
113Is this a question? :) It comes up very often. The simple answer is: I had
114to write it, and C++ allowed me to write and maintain it in a fraction
115of the time and effort (which is a scarce resource for me). Put even
116shorter: It simply wouldn't exist without C++.
117
118My personal stance on this is that C++ is less portable than C, but in
119the case of rxvt-unicode this hardly matters, as its portability limits
120are defined by things like X11, pseudo terminals, locale support and unix
121domain sockets, which are all less portable than C++ itself.
122
123Regarding the bloat, see the above question: It's easy to write programs
124in C that use gobs of memory, an certainly possible to write programs in
125C++ that don't. C++ also often comes with large libraries, but this is
126not necessarily the case with GCC. Here is what rxvt links against on my
127system with a minimal config:
128
129 libX11.so.6 => /usr/X11R6/lib/libX11.so.6 (0x00002aaaaabc3000)
130 libc.so.6 => /lib/libc.so.6 (0x00002aaaaadde000)
131 libdl.so.2 => /lib/libdl.so.2 (0x00002aaaab01d000)
132 /lib64/ld-linux-x86-64.so.2 (0x00002aaaaaaab000)
133
134And here is rxvt-unicode:
135
136 libX11.so.6 => /usr/X11R6/lib/libX11.so.6 (0x00002aaaaabc3000)
137 libgcc_s.so.1 => /lib/libgcc_s.so.1 (0x00002aaaaada2000)
138 libc.so.6 => /lib/libc.so.6 (0x00002aaaaaeb0000)
139 libdl.so.2 => /lib/libdl.so.2 (0x00002aaaab0ee000)
140 /lib64/ld-linux-x86-64.so.2 (0x00002aaaaaaab000)
141
142No large bloated libraries (of course, none were linked in statically),
143except maybe libX11 :)
144
145=item Does it support tabs, can I have a tabbed rxvt-unicode?
146
147Beginning with version 7.3, there is a perl extension that implements a
148simple tabbed terminal. It is installed by default, so any of these should
149give you tabs:
150
151 @@RXVT_NAME@@ -pe tabbed
152
153 URxvt.perl-ext-common: default,tabbed
154
155It will also work fine with tabbing functionality of many window managers
156or similar tabbing programs, and its embedding-features allow it to be
157embedded into other programs, as witnessed by F<doc/rxvt-tabbed> or
158the upcoming C<Gtk2::URxvt> perl module, which features a tabbed urxvt
159(murxvt) terminal as an example embedding application.
160
161=item How do I know which rxvt-unicode version I'm using?
162
163The version number is displayed with the usage (-h). Also the escape
164sequence C<ESC [ 8 n> sets the window title to the version number. When
165using the @@RXVT_NAME@@c client, the version displayed is that of the
166daemon.
167
168=item I am using Debian GNU/Linux and have a problem...
169
170The Debian GNU/Linux package of rxvt-unicode in sarge contains large
171patches that considerably change the behaviour of rxvt-unicode (but
172unfortunately this notice has been removed). Before reporting a bug to
173the original rxvt-unicode author please download and install the genuine
174version (L<http://software.schmorp.de#rxvt-unicode>) and try to reproduce
175the problem. If you cannot, chances are that the problems are specific to
176Debian GNU/Linux, in which case it should be reported via the Debian Bug
177Tracking System (use C<reportbug> to report the bug).
178
179For other problems that also affect the Debian package, you can and
180probably should use the Debian BTS, too, because, after all, it's also a
181bug in the Debian version and it serves as a reminder for other users that
182might encounter the same issue.
183
184=item I am maintaining rxvt-unicode for distribution/OS XXX, any
185recommendation?
186
187You should build one binary with the default options. F<configure>
188now enables most useful options, and the trend goes to making them
189runtime-switchable, too, so there is usually no drawback to enbaling them,
190except higher disk and possibly memory usage. The perl interpreter should
191be enabled, as important functionality (menus, selection, likely more in
192the future) depends on it.
193
194You should not overwrite the C<perl-ext-common> snd C<perl-ext> resources
195system-wide (except maybe with C<defaults>). This will result in useful
196behaviour. If your distribution aims at low memory, add an empty
197C<perl-ext-common> resource to the app-defaults file. This will keep the
198perl interpreter disabled until the user enables it.
199
200If you can/want build more binaries, I recommend building a minimal
201one with C<--disable-everything> (very useful) and a maximal one with
202C<--enable-everything> (less useful, it will be very big due to a lot of
203encodings built-in that increase download times and are rarely used).
204
205=item I need to make it setuid/setgid to support utmp/ptys on my OS, is this safe?
206
207It should be, starting with release 7.1. You are encouraged to properly
208install urxvt with privileges necessary for your OS now.
209
210When rxvt-unicode detects that it runs setuid or setgid, it will fork
211into a helper process for privileged operations (pty handling on some
212systems, utmp/wtmp/lastlog handling on others) and drop privileges
213immediately. This is much safer than most other terminals that keep
214privileges while running (but is more relevant to urxvt, as it contains
215things as perl interpreters, which might be "helpful" to attackers).
216
217This forking is done as the very first within main(), which is very early
218and reduces possible bugs to initialisation code run before main(), or
219things like the dynamic loader of your system, which should result in very
220little risk.
221
222=item When I log-in to another system it tells me about missing terminfo data?
223
224The terminal description used by rxvt-unicode is not as widely available
225as that for xterm, or even rxvt (for which the same problem often arises).
226
227The correct solution for this problem is to install the terminfo, this can
228be done like this (with ncurses' infocmp):
229
230 REMOTE=remotesystem.domain
231 infocmp rxvt-unicode | ssh $REMOTE "cat >/tmp/ti && tic /tmp/ti"
232
233... or by installing rxvt-unicode normally on the remote system,
234
235If you cannot or do not want to do this, then you can simply set
236C<TERM=rxvt> or even C<TERM=xterm>, and live with the small number of
237problems arising, which includes wrong keymapping, less and different
238colours and some refresh errors in fullscreen applications. It's a nice
239quick-and-dirty workaround for rare cases, though.
240
241If you always want to do this (and are fine with the consequences) you
242can either recompile rxvt-unicode with the desired TERM value or use a
243resource to set it:
244
245 URxvt.termName: rxvt
246
247If you don't plan to use B<rxvt> (quite common...) you could also replace
248the rxvt terminfo file with the rxvt-unicode one.
249
250=item C<tic> outputs some error when compiling the terminfo entry.
251
252Most likely it's the empty definition for C<enacs=>. Just replace it by
253C<enacs=\E[0@> and try again.
254
255=item C<bash>'s readline does not work correctly under @@RXVT_NAME@@.
256
257=item I need a termcap file entry.
258
259One reason you might want this is that some distributions or operating
260systems still compile some programs using the long-obsoleted termcap
261library (Fedora Core's bash is one example) and rely on a termcap entry
262for C<rxvt-unicode>.
263
264You could use rxvt's termcap entry with resonable results in many cases.
265You can also create a termcap entry by using terminfo's infocmp program
266like this:
267
268 infocmp -C rxvt-unicode
269
270Or you could use this termcap entry, generated by the command above:
271
272 rxvt-unicode|rxvt-unicode terminal (X Window System):\
273 :am:bw:eo:km:mi:ms:xn:xo:\
274 :co#80:it#8:li#24:lm#0:\
275 :AL=\E[%dL:DC=\E[%dP:DL=\E[%dM:DO=\E[%dB:IC=\E[%d@:\
276 :K1=\EOw:K2=\EOu:K3=\EOy:K4=\EOq:K5=\EOs:LE=\E[%dD:\
277 :RI=\E[%dC:SF=\E[%dS:SR=\E[%dT:UP=\E[%dA:ae=\E(B:al=\E[L:\
278 :as=\E(0:bl=^G:cd=\E[J:ce=\E[K:cl=\E[H\E[2J:\
279 :cm=\E[%i%d;%dH:cr=^M:cs=\E[%i%d;%dr:ct=\E[3g:dc=\E[P:\
280 :dl=\E[M:do=^J:ec=\E[%dX:ei=\E[4l:ho=\E[H:\
281 :i1=\E[?47l\E=\E[?1l:ic=\E[@:im=\E[4h:\
282 :is=\E[r\E[m\E[2J\E[H\E[?7h\E[?1;3;4;6l\E[4l:\
283 :k1=\E[11~:k2=\E[12~:k3=\E[13~:k4=\E[14~:k5=\E[15~:\
284 :k6=\E[17~:k7=\E[18~:k8=\E[19~:k9=\E[20~:kD=\E[3~:\
285 :kI=\E[2~:kN=\E[6~:kP=\E[5~:kb=\177:kd=\EOB:ke=\E[?1l\E>:\
286 :kh=\E[7~:kl=\EOD:kr=\EOC:ks=\E[?1h\E=:ku=\EOA:le=^H:\
287 :mb=\E[5m:md=\E[1m:me=\E[m\017:mr=\E[7m:nd=\E[C:rc=\E8:\
288 :sc=\E7:se=\E[27m:sf=^J:so=\E[7m:sr=\EM:st=\EH:ta=^I:\
289 :te=\E[r\E[?1049l:ti=\E[?1049h:ue=\E[24m:up=\E[A:\
290 :us=\E[4m:vb=\E[?5h\E[?5l:ve=\E[?25h:vi=\E[?25l:\
291 :vs=\E[?25h:
292
293=item Why does C<ls> no longer have coloured output?
294
295The C<ls> in the GNU coreutils unfortunately doesn't use terminfo to
296decide wether a terminal has colour, but uses it's own configuration
297file. Needless to say, C<rxvt-unicode> is not in it's default file (among
298with most other terminals supporting colour). Either add:
299
300 TERM rxvt-unicode
301
302to C</etc/DIR_COLORS> or simply add:
303
304 alias ls='ls --color=auto'
305
306to your C<.profile> or C<.bashrc>.
307
308=item Why doesn't vim/emacs etc. use the 88 colour mode?
309
310=item Why doesn't vim/emacs etc. make use of italic?
311
312=item Why are the secondary screen-related options not working properly?
313
314Make sure you are using C<TERM=rxvt-unicode>. Some pre-packaged
315distributions (most notably Debian GNU/Linux) break rxvt-unicode
316by setting C<TERM> to C<rxvt>, which doesn't have these extra
317features. Unfortunately, some of these (most notably, again, Debian
318GNU/Linux) furthermore fail to even install the C<rxvt-unicode> terminfo
319file, so you will need to install it on your own (See the question B<When
320I log-in to another system it tells me about missing terminfo data?> on
321how to do this).
322
323=item My numerical keypad acts weird and generates differing output?
324
325Some Debian GNUL/Linux users seem to have this problem, although no
326specific details were reported so far. It is possible that this is caused
327by the wrong C<TERM> setting, although the details of wether and how
328this can happen are unknown, as C<TERM=rxvt> should offer a compatible
329keymap. See the answer to the previous question, and please report if that
330helped.
331
332=item Rxvt-unicode does not seem to understand the selected encoding?
333
334=item Unicode does not seem to work?
335
336If you encounter strange problems like typing an accented character but
337getting two unrelated other characters or similar, or if program output is
338subtly garbled, then you should check your locale settings.
339
340Rxvt-unicode must be started with the same C<LC_CTYPE> setting as the
341programs. Often rxvt-unicode is started in the C<C> locale, while the
342login script running within the rxvt-unicode window changes the locale to
343something else, e.g. C<en_GB.UTF-8>. Needless to say, this is not going to work.
344
345The best thing is to fix your startup environment, as you will likely run
346into other problems. If nothing works you can try this in your .profile.
347
348 printf '\e]701;%s\007' "$LC_CTYPE"
349
350If this doesn't work, then maybe you use a C<LC_CTYPE> specification not
351supported on your systems. Some systems have a C<locale> command which
352displays this (also, C<perl -e0> can be used to check locale settings, as
353it will complain loudly if it cannot set the locale). If it displays something
354like:
355
356 locale: Cannot set LC_CTYPE to default locale: ...
357
358Then the locale you specified is not supported on your system.
359
360If nothing works and you are sure that everything is set correctly then
361you will need to remember a little known fact: Some programs just don't
362support locales :(
363
364=item Why do some characters look so much different than others?
365
366=item How does rxvt-unicode choose fonts?
367
368Most fonts do not contain the full range of Unicode, which is
369fine. Chances are that the font you (or the admin/package maintainer of
370your system/os) have specified does not cover all the characters you want
371to display.
372
373B<rxvt-unicode> makes a best-effort try at finding a replacement
374font. Often the result is fine, but sometimes the chosen font looks
375bad/ugly/wrong. Some fonts have totally strange characters that don't
376resemble the correct glyph at all, and rxvt-unicode lacks the artificial
377intelligence to detect that a specific glyph is wrong: it has to believe
378the font that the characters it claims to contain indeed look correct.
379
380In that case, select a font of your taste and add it to the font list,
381e.g.:
382
383 @@RXVT_NAME@@ -fn basefont,font2,font3...
384
385When rxvt-unicode sees a character, it will first look at the base
386font. If the base font does not contain the character, it will go to the
387next font, and so on. Specifying your own fonts will also speed up this
388search and use less resources within rxvt-unicode and the X-server.
389
390The only limitation is that none of the fonts may be larger than the base
391font, as the base font defines the terminal character cell size, which
392must be the same due to the way terminals work.
393
394=item Why do some chinese characters look so different than others?
395
396This is because there is a difference between script and language --
397rxvt-unicode does not know which language the text that is output is,
398as it only knows the unicode character codes. If rxvt-unicode first
399sees a japanese/chinese character, it might choose a japanese font for
400display. Subsequent japanese characters will use that font. Now, many
401chinese characters aren't represented in japanese fonts, so when the first
402non-japanese character comes up, rxvt-unicode will look for a chinese font
403-- unfortunately at this point, it will still use the japanese font for
404chinese characters that are also in the japanese font.
405
406The workaround is easy: just tag a chinese font at the end of your font
407list (see the previous question). The key is to view the font list as
408a preference list: If you expect more japanese, list a japanese font
409first. If you expect more chinese, put a chinese font first.
410
411In the future it might be possible to switch language preferences at
412runtime (the internal data structure has no problem with using different
413fonts for the same character at the same time, but no interface for this
414has been designed yet).
415
416Until then, you might get away with switching fonts at runtime (see L<Can
417I switch the fonts at runtime?> later in this document).
418
419=item Why does rxvt-unicode sometimes leave pixel droppings?
420
421Most fonts were not designed for terminal use, which means that character
422size varies a lot. A font that is otherwise fine for terminal use might
423contain some characters that are simply too wide. Rxvt-unicode will avoid
424these characters. For characters that are just "a bit" too wide a special
425"careful" rendering mode is used that redraws adjacent characters.
426
427All of this requires that fonts do not lie about character sizes,
428however: Xft fonts often draw glyphs larger than their acclaimed bounding
429box, and rxvt-unicode has no way of detecting this (the correct way is to
430ask for the character bounding box, which unfortunately is wrong in these
431cases).
432
433It's not clear (to me at least), wether this is a bug in Xft, freetype,
434or the respective font. If you encounter this problem you might try using
435the C<-lsp> option to give the font more height. If that doesn't work, you
436might be forced to use a different font.
437
438All of this is not a problem when using X11 core fonts, as their bounding
439box data is correct.
440
441=item On Solaris 9, many line-drawing characters are too wide.
442
443Seems to be a known bug, read
444L<http://nixdoc.net/files/forum/about34198.html>. Some people use the
445following ugly workaround to get non-double-wide-characters working:
446
447 #define wcwidth(x) wcwidth(x) > 1 ? 1 : wcwidth(x)
448
449=item My Compose (Multi_key) key is no longer working.
450
451The most common causes for this are that either your locale is not set
452correctly, or you specified a B<preeditStyle> that is not supported by
453your input method. For example, if you specified B<OverTheSpot> and
454your input method (e.g. the default input method handling Compose keys)
455does not support this (for instance because it is not visual), then
456rxvt-unicode will continue without an input method.
457
458In this case either do not specify a B<preeditStyle> or specify more than
459one pre-edit style, such as B<OverTheSpot,Root,None>.
460
461=item I cannot type C<Ctrl-Shift-2> to get an ASCII NUL character due to ISO 14755
462
463Either try C<Ctrl-2> alone (it often is mapped to ASCII NUL even on
464international keyboards) or simply use ISO 14755 support to your
465advantage, typing <Ctrl-Shift-0> to get a ASCII NUL. This works for other
466codes, too, such as C<Ctrl-Shift-1-d> to type the default telnet escape
467character and so on.
468
469=item How can I keep rxvt-unicode from using reverse video so much?
470
471First of all, make sure you are running with the right terminal settings
472(C<TERM=rxvt-unicode>), which will get rid of most of these effects. Then
473make sure you have specified colours for italic and bold, as otherwise
474rxvt-unicode might use reverse video to simulate the effect:
475
476 URxvt.colorBD: white
477 URxvt.colorIT: green
478
479=item Some programs assume totally weird colours (red instead of blue), how can I fix that?
480
481For some unexplainable reason, some rare programs assume a very weird
482colour palette when confronted with a terminal with more than the standard
4838 colours (rxvt-unicode supports 88). The right fix is, of course, to fix
484these programs not to assume non-ISO colours without very good reasons.
485
486In the meantime, you can either edit your C<rxvt-unicode> terminfo
487definition to only claim 8 colour support or use C<TERM=rxvt>, which will
488fix colours but keep you from using other rxvt-unicode features.
489
490=item I am on FreeBSD and rxvt-unicode does not seem to work at all.
491
492Rxvt-unicode requires the symbol C<__STDC_ISO_10646__> to be defined
493in your compile environment, or an implementation that implements it,
494wether it defines the symbol or not. C<__STDC_ISO_10646__> requires that
495B<wchar_t> is represented as unicode.
496
497As you might have guessed, FreeBSD does neither define this symobl nor
498does it support it. Instead, it uses it's own internal representation of
499B<wchar_t>. This is, of course, completely fine with respect to standards.
500
501However, that means rxvt-unicode only works in C<POSIX>, C<ISO-8859-1> and
502C<UTF-8> locales under FreeBSD (which all use Unicode as B<wchar_t>.
503
504C<__STDC_ISO_10646__> is the only sane way to support multi-language
505apps in an OS, as using a locale-dependent (and non-standardized)
506representation of B<wchar_t> makes it impossible to convert between
507B<wchar_t> (as used by X11 and your applications) and any other encoding
508without implementing OS-specific-wrappers for each and every locale. There
509simply are no APIs to convert B<wchar_t> into anything except the current
510locale encoding.
511
512Some applications (such as the formidable B<mlterm>) work around this
513by carrying their own replacement functions for character set handling
514with them, and either implementing OS-dependent hacks or doing multiple
515conversions (which is slow and unreliable in case the OS implements
516encodings slightly different than the terminal emulator).
517
518The rxvt-unicode author insists that the right way to fix this is in the
519system libraries once and for all, instead of forcing every app to carry
520complete replacements for them :)
521
522=item I use Solaris 9 and it doesn't compile/work/etc.
523
524Try the diff in F<doc/solaris9.patch> as a base. It fixes the worst
525problems with C<wcwidth> and a compile problem.
526
527=item How can I use rxvt-unicode under cygwin?
528
529rxvt-unicode should compile and run out of the box on cygwin, using
530the X11 libraries that come with cygwin. libW11 emulation is no
531longer supported (and makes no sense, either, as it only supported a
532single font). I recommend starting the X-server in C<-multiwindow> or
533C<-rootless> mode instead, which will result in similar look&feel as the
534old libW11 emulation.
535
536At the time of this writing, cygwin didn't seem to support any multi-byte
537encodings (you might try C<LC_CTYPE=C-UTF-8>), so you are likely limited
538to 8-bit encodings.
539
540=item How does rxvt-unicode determine the encoding to use?
541
542=item Is there an option to switch encodings?
543
544Unlike some other terminals, rxvt-unicode has no encoding switch, and no
545specific "utf-8" mode, such as xterm. In fact, it doesn't even know about
546UTF-8 or any other encodings with respect to terminal I/O.
547
548The reasons is that there exists a perfectly fine mechanism for selecting
549the encoding, doing I/O and (most important) communicating this to all
550applications so everybody agrees on character properties such as width
551and code number. This mechanism is the I<locale>. Applications not using
552that info will have problems (for example, C<xterm> gets the width of
553characters wrong as it uses it's own, locale-independent table under all
554locales).
555
556Rxvt-unicode uses the C<LC_CTYPE> locale category to select encoding. All
557programs doing the same (that is, most) will automatically agree in the
558interpretation of characters.
559
560Unfortunately, there is no system-independent way to select locales, nor
561is there a standard on how locale specifiers will look like.
562
563On most systems, the content of the C<LC_CTYPE> environment variable
564contains an arbitrary string which corresponds to an already-installed
565locale. Common names for locales are C<en_US.UTF-8>, C<de_DE.ISO-8859-15>,
566C<ja_JP.EUC-JP>, i.e. C<language_country.encoding>, but other forms
567(i.e. C<de> or C<german>) are also common.
568
569Rxvt-unicode ignores all other locale categories, and except for
570the encoding, ignores country or language-specific settings,
571i.e. C<de_DE.UTF-8> and C<ja_JP.UTF-8> are the normally same to
572rxvt-unicode.
573
574If you want to use a specific encoding you have to make sure you start
575rxvt-unicode with the correct C<LC_CTYPE> category.
576
577=item Can I switch locales at runtime?
578
579Yes, using an escape sequence. Try something like this, which sets
580rxvt-unicode's idea of C<LC_CTYPE>.
581
582 printf '\e]701;%s\007' ja_JP.SJIS
583
584See also the previous answer.
585
586Sometimes this capability is rather handy when you want to work in
587one locale (e.g. C<de_DE.UTF-8>) but some programs don't support it
588(e.g. UTF-8). For example, I use this script to start C<xjdic>, which
589first switches to a locale supported by xjdic and back later:
590
591 printf '\e]701;%s\007' ja_JP.SJIS
592 xjdic -js
593 printf '\e]701;%s\007' de_DE.UTF-8
594
595You can also use xterm's C<luit> program, which usually works fine, except
596for some locales where character width differs between program- and
597rxvt-unicode-locales.
598
599=item Can I switch the fonts at runtime?
600
601Yes, using an escape sequence. Try something like this, which has the same
602effect as using the C<-fn> switch, and takes effect immediately:
603
604 printf '\e]50;%s\007' "9x15bold,xft:Kochi Gothic"
605
606This is useful if you e.g. work primarily with japanese (and prefer a
607japanese font), but you have to switch to chinese temporarily, where
608japanese fonts would only be in your way.
609
610You can think of this as a kind of manual ISO-2022 switching.
611
612=item Why do italic characters look as if clipped?
613
614Many fonts have difficulties with italic characters and hinting. For
615example, the otherwise very nicely hinted font C<xft:Bitstream Vera Sans
616Mono> completely fails in it's italic face. A workaround might be to
617enable freetype autohinting, i.e. like this:
618
619 URxvt.italicFont: xft:Bitstream Vera Sans Mono:italic:autohint=true
620 URxvt.boldItalicFont: xft:Bitstream Vera Sans Mono:bold:italic:autohint=true
621
622=item My input method wants <some encoding> but I want UTF-8, what can I do?
623
624You can specify separate locales for the input method and the rest of the
625terminal, using the resource C<imlocale>:
626
627 URxvt.imlocale: ja_JP.EUC-JP
628
629Now you can start your terminal with C<LC_CTYPE=ja_JP.UTF-8> and still
630use your input method. Please note, however, that you will not be able to
631input characters outside C<EUC-JP> in a normal way then, as your input
632method limits you.
633
634=item Rxvt-unicode crashes when the X Input Method changes or exits.
635
636Unfortunately, this is unavoidable, as the XIM protocol is racy by
637design. Applications can avoid some crashes at the expense of memory
638leaks, and Input Methods can avoid some crashes by careful ordering at
639exit time. B<kinput2> (and derived input methods) generally succeeds,
640while B<SCIM> (or similar input methods) fails. In the end, however,
641crashes cannot be completely avoided even if both sides cooperate.
642
643So the only workaround is not to kill your Input Method Servers.
644
645=item Rxvt-unicode uses gobs of memory, how can I reduce that?
646
647Rxvt-unicode tries to obey the rule of not charging you for something you
648don't use. One thing you should try is to configure out all settings that
649you don't need, for example, Xft support is a resource hog by design,
650when used. Compiling it out ensures that no Xft font will be loaded
651accidentally when rxvt-unicode tries to find a font for your characters.
652
653Also, many people (me included) like large windows and even larger
654scrollback buffers: Without C<--enable-unicode3>, rxvt-unicode will use
6556 bytes per screen cell. For a 160x?? window this amounts to almost a
656kilobyte per line. A scrollback buffer of 10000 lines will then (if full)
657use 10 Megabytes of memory. With C<--enable-unicode3> it gets worse, as
658rxvt-unicode then uses 8 bytes per screen cell.
659
660=item Can I speed up Xft rendering somehow?
661
662Yes, the most obvious way to speed it up is to avoid Xft entirely, as
663it is simply slow. If you still want Xft fonts you might try to disable
664antialiasing (by appending C<:antialias=false>), which saves lots of
665memory and also speeds up rendering considerably.
666
667=item Rxvt-unicode doesn't seem to anti-alias its fonts, what is wrong?
668
669Rxvt-unicode will use whatever you specify as a font. If it needs to
670fall back to it's default font search list it will prefer X11 core
671fonts, because they are small and fast, and then use Xft fonts. It has
672antialiasing disabled for most of them, because the author thinks they
673look best that way.
674
675If you want antialiasing, you have to specify the fonts manually.
676
677=item Mouse cut/paste suddenly no longer works.
678
679Make sure that mouse reporting is actually turned off since killing
680some editors prematurely may leave the mouse in mouse report mode. I've
681heard that tcsh may use mouse reporting unless it otherwise specified. A
682quick check is to see if cut/paste works when the Alt or Shift keys are
683depressed.
684
685=item What's with this bold/blink stuff?
686
687If no bold colour is set via C<colorBD:>, bold will invert text using the
688standard foreground colour.
689
690For the standard background colour, blinking will actually make the
691text blink when compiled with C<--enable-blinking>. with standard
692colours. Without C<--enable-blinking>, the blink attribute will be
693ignored.
694
695On ANSI colours, bold/blink attributes are used to set high-intensity
696foreground/background colors.
697
698color0-7 are the low-intensity colors.
699
700color8-15 are the corresponding high-intensity colors.
701
702=item I don't like the screen colors. How do I change them?
703
704You can change the screen colors at run-time using F<~/.Xdefaults>
705resources (or as long-options).
706
707Here are values that are supposed to resemble a VGA screen,
708including the murky brown that passes for low-intensity yellow:
709
710 URxvt.color0: #000000
711 URxvt.color1: #A80000
712 URxvt.color2: #00A800
713 URxvt.color3: #A8A800
714 URxvt.color4: #0000A8
715 URxvt.color5: #A800A8
716 URxvt.color6: #00A8A8
717 URxvt.color7: #A8A8A8
718
719 URxvt.color8: #000054
720 URxvt.color9: #FF0054
721 URxvt.color10: #00FF54
722 URxvt.color11: #FFFF54
723 URxvt.color12: #0000FF
724 URxvt.color13: #FF00FF
725 URxvt.color14: #00FFFF
726 URxvt.color15: #FFFFFF
727
728And here is a more complete set of non-standard colors described (not by
729me) as "pretty girly".
730
731 URxvt.cursorColor: #dc74d1
732 URxvt.pointerColor: #dc74d1
733 URxvt.background: #0e0e0e
734 URxvt.foreground: #4ad5e1
735 URxvt.color0: #000000
736 URxvt.color8: #8b8f93
737 URxvt.color1: #dc74d1
738 URxvt.color9: #dc74d1
739 URxvt.color2: #0eb8c7
740 URxvt.color10: #0eb8c7
741 URxvt.color3: #dfe37e
742 URxvt.color11: #dfe37e
743 URxvt.color5: #9e88f0
744 URxvt.color13: #9e88f0
745 URxvt.color6: #73f7ff
746 URxvt.color14: #73f7ff
747 URxvt.color7: #e1dddd
748 URxvt.color15: #e1dddd
749
750=item How can I start @@RXVT_NAME@@d in a race-free way?
751
752Try C<@@RXVT_NAME@@d -f -o>, which tells @@RXVT_NAME@@d to open the
753display, create the listening socket and then fork.
754
755=item What's with the strange Backspace/Delete key behaviour?
756
757Assuming that the physical Backspace key corresponds to the
758BackSpace keysym (not likely for Linux ... see the following
759question) there are two standard values that can be used for
760Backspace: C<^H> and C<^?>.
761
762Historically, either value is correct, but rxvt-unicode adopts the debian
763policy of using C<^?> when unsure, because it's the one only only correct
764choice :).
765
766Rxvt-unicode tries to inherit the current stty settings and uses the value
767of `erase' to guess the value for backspace. If rxvt-unicode wasn't
768started from a terminal (say, from a menu or by remote shell), then the
769system value of `erase', which corresponds to CERASE in <termios.h>, will
770be used (which may not be the same as your stty setting).
771
772For starting a new rxvt-unicode:
773
774 # use Backspace = ^H
775 $ stty erase ^H
776 $ @@RXVT_NAME@@
777
778 # use Backspace = ^?
779 $ stty erase ^?
780 $ @@RXVT_NAME@@
781
782Toggle with C<ESC [ 36 h> / C<ESC [ 36 l>.
783
784For an existing rxvt-unicode:
785
786 # use Backspace = ^H
787 $ stty erase ^H
788 $ echo -n "^[[36h"
789
790 # use Backspace = ^?
791 $ stty erase ^?
792 $ echo -n "^[[36l"
793
794This helps satisfy some of the Backspace discrepancies that occur, but
795if you use Backspace = C<^H>, make sure that the termcap/terminfo value
796properly reflects that.
797
798The Delete key is a another casualty of the ill-defined Backspace problem.
799To avoid confusion between the Backspace and Delete keys, the Delete
800key has been assigned an escape sequence to match the vt100 for Execute
801(C<ESC [ 3 ~>) and is in the supplied termcap/terminfo.
802
803Some other Backspace problems:
804
805some editors use termcap/terminfo,
806some editors (vim I'm told) expect Backspace = ^H,
807GNU Emacs (and Emacs-like editors) use ^H for help.
808
809Perhaps someday this will all be resolved in a consistent manner.
810
811=item I don't like the key-bindings. How do I change them?
812
813There are some compile-time selections available via configure. Unless
814you have run "configure" with the C<--disable-resources> option you can
815use the `keysym' resource to alter the keystrings associated with keysyms.
816
817Here's an example for a URxvt session started using C<@@RXVT_NAME@@ -name URxvt>
818
819 URxvt.keysym.Home: \033[1~
820 URxvt.keysym.End: \033[4~
821 URxvt.keysym.C-apostrophe: \033<C-'>
822 URxvt.keysym.C-slash: \033<C-/>
823 URxvt.keysym.C-semicolon: \033<C-;>
824 URxvt.keysym.C-grave: \033<C-`>
825 URxvt.keysym.C-comma: \033<C-,>
826 URxvt.keysym.C-period: \033<C-.>
827 URxvt.keysym.C-0x60: \033<C-`>
828 URxvt.keysym.C-Tab: \033<C-Tab>
829 URxvt.keysym.C-Return: \033<C-Return>
830 URxvt.keysym.S-Return: \033<S-Return>
831 URxvt.keysym.S-space: \033<S-Space>
832 URxvt.keysym.M-Up: \033<M-Up>
833 URxvt.keysym.M-Down: \033<M-Down>
834 URxvt.keysym.M-Left: \033<M-Left>
835 URxvt.keysym.M-Right: \033<M-Right>
836 URxvt.keysym.M-C-0: list \033<M-C- 0123456789 >
837 URxvt.keysym.M-C-a: list \033<M-C- abcdefghijklmnopqrstuvwxyz >
838 URxvt.keysym.F12: command:\033]701;zh_CN.GBK\007
839
840See some more examples in the documentation for the B<keysym> resource.
841
842=item I'm using keyboard model XXX that has extra Prior/Next/Insert keys.
843How do I make use of them? For example, the Sun Keyboard type 4
844has the following mappings that rxvt-unicode doesn't recognize.
845
846 KP_Insert == Insert
847 F22 == Print
848 F27 == Home
849 F29 == Prior
850 F33 == End
851 F35 == Next
852
853Rather than have rxvt-unicode try to accommodate all the various possible
854keyboard mappings, it is better to use `xmodmap' to remap the keys as
855required for your particular machine.
856
857=item How do I distinguish wether I'm running rxvt-unicode or a regular xterm?
858I need this to decide about setting colors etc.
859
860rxvt and rxvt-unicode always export the variable "COLORTERM", so you can
861check and see if that is set. Note that several programs, JED, slrn,
862Midnight Commander automatically check this variable to decide whether or
863not to use color.
864
865=item How do I set the correct, full IP address for the DISPLAY variable?
866
867If you've compiled rxvt-unicode with DISPLAY_IS_IP and have enabled
868insecure mode then it is possible to use the following shell script
869snippets to correctly set the display. If your version of rxvt-unicode
870wasn't also compiled with ESCZ_ANSWER (as assumed in these snippets) then
871the COLORTERM variable can be used to distinguish rxvt-unicode from a
872regular xterm.
873
874Courtesy of Chuck Blake <cblake@BBN.COM> with the following shell script
875snippets:
876
877 # Bourne/Korn/POSIX family of shells:
878 [ ${TERM:-foo} = foo ] && TERM=xterm # assume an xterm if we don't know
879 if [ ${TERM:-foo} = xterm ]; then
880 stty -icanon -echo min 0 time 15 # see if enhanced rxvt or not
881 echo -n '^[Z'
882 read term_id
883 stty icanon echo
884 if [ ""${term_id} = '^[[?1;2C' -a ${DISPLAY:-foo} = foo ]; then
885 echo -n '^[[7n' # query the rxvt we are in for the DISPLAY string
886 read DISPLAY # set it in our local shell
887 fi
888 fi
889
890=item How do I compile the manual pages for myself?
891
892You need to have a recent version of perl installed as F</usr/bin/perl>,
893one that comes with F<pod2man>, F<pod2text> and F<pod2html>. Then go to
894the doc subdirectory and enter C<make alldoc>.
895
896=item My question isn't answered here, can I ask a human?
897
898Before sending me mail, you could go to IRC: C<irc.freenode.net>,
899channel C<#rxvt-unicode> has some rxvt-unicode enthusiasts that might be
900interested in learning about new and exciting problems (but not FAQs :).
901
902=back
903
904=head1 RXVT TECHNICAL REFERENCE
905
906=head1 DESCRIPTION
907
908The rest of this document describes various technical aspects of
909B<rxvt-unicode>. First the description of supported command sequences,
910followed by pixmap support and last by a description of all features
911selectable at C<configure> time.
6 912
7=head1 Definitions 913=head1 Definitions
8 914
9=over 4 915=over 4
10 916
… …
37=over 4 943=over 4
38 944
39=item B<< C<ENQ> >> 945=item B<< C<ENQ> >>
40 946
41Enquiry (Ctrl-E) = Send Device Attributes (DA) 947Enquiry (Ctrl-E) = Send Device Attributes (DA)
42request attributes from terminal == 948request attributes from terminal. See B<< C<ESC [ Ps c> >>.
43 949
44=item B<< C<BEL> >> 950=item B<< C<BEL> >>
45 951
46Bell (Ctrl-G) 952Bell (Ctrl-G)
47 953
… …
139Single Shift Select of G3 Character Set (SS3): affects next character 1045Single Shift Select of G3 Character Set (SS3): affects next character
140only I<unimplemented> 1046only I<unimplemented>
141 1047
142=item B<< C<ESC Z> >> 1048=item B<< C<ESC Z> >>
143 1049
144Obsolete form of returns: B<< C<ESC[?1;2C> >> I<rxvt compile-time option> 1050Obsolete form of returns: B<< C<ESC [ ? 1 ; 2 C> >> I<rxvt-unicode compile-time option>
145 1051
146=item B<< C<ESC c> >> 1052=item B<< C<ESC c> >>
147 1053
148Full reset (RIS) 1054Full reset (RIS)
149 1055
… …
153 1059
154=item B<< C<ESC o> >> 1060=item B<< C<ESC o> >>
155 1061
156Invoke the G3 Character Set (LS3) 1062Invoke the G3 Character Set (LS3)
157 1063
158=item B<< C<ESC>(C<C> >> 1064=item B<< C<ESC ( C> >>
159 1065
160Designate G0 Character Set (ISO 2022), see below for values of C<C>. 1066Designate G0 Character Set (ISO 2022), see below for values of C<C>.
161 1067
162=item B<< C<ESC>)C<C> >> 1068=item B<< C<ESC ) C> >>
163 1069
164Designate G1 Character Set (ISO 2022), see below for values of C<C>. 1070Designate G1 Character Set (ISO 2022), see below for values of C<C>.
165 1071
166=item B<< C<ESC * C> >> 1072=item B<< C<ESC * C> >>
167 1073
… …
191 1097
192=back 1098=back
193 1099
194X<CSI> 1100X<CSI>
195 1101
196=head1 CSI (Code Sequence Introducer) Sequences 1102=head1 CSI (Command Sequence Introducer) Sequences
197 1103
198=over 4 1104=over 4
199 1105
200=item B<< C<ESC [ Ps @> >> 1106=item B<< C<ESC [ Ps @> >>
201 1107
… …
298 1204
299Move backward B<< C<Ps> >> [default: 1] tab stops 1205Move backward B<< C<Ps> >> [default: 1] tab stops
300 1206
301=item B<< C<ESC [ Ps '> >> 1207=item B<< C<ESC [ Ps '> >>
302 1208
303== 1209See B<< C<ESC [ Ps G> >>
304 1210
305=item B<< C<ESC [ Ps a> >> 1211=item B<< C<ESC [ Ps a> >>
306 1212
307==X<ESCOBPsc> 1213See B<< C<ESC [ Ps C> >>
308 1214
309=item B<< C<ESC [ Ps c> >> 1215=item B<< C<ESC [ Ps c> >>
310 1216
311Send Device Attributes (DA) 1217Send Device Attributes (DA)
312B<< C<Ps = 0> >> (or omitted): request attributes from terminal 1218B<< C<Ps = 0> >> (or omitted): request attributes from terminal
313returns: B<< C<ESC[?1;2c> >> (``I am a VT100 with Advanced Video 1219returns: B<< C<ESC [ ? 1 ; 2 c> >> (``I am a VT100 with Advanced Video
314Option'') 1220Option'')
315 1221
316=item B<< C<ESC [ Ps d> >> 1222=item B<< C<ESC [ Ps d> >>
317 1223
318Cursor to Line B<< C<Ps> >> (VPA) 1224Cursor to Line B<< C<Ps> >> (VPA)
319 1225
320=item B<< C<ESC [ Ps e> >> 1226=item B<< C<ESC [ Ps e> >>
321 1227
322== 1228See B<< C<ESC [ Ps A> >>
323 1229
324=item B<< C<ESC [ Ps;Ps f> >> 1230=item B<< C<ESC [ Ps;Ps f> >>
325 1231
326Horizontal and Vertical Position [row;column] (HVP) [default: 1;1] 1232Horizontal and Vertical Position [row;column] (HVP) [default: 1;1]
327 1233
… …
334 B<< C<Ps = 0> >> Clear Current Column (default) 1240 B<< C<Ps = 0> >> Clear Current Column (default)
335 B<< C<Ps = 3> >> Clear All (TBC) 1241 B<< C<Ps = 3> >> Clear All (TBC)
336 1242
337=end table 1243=end table
338 1244
1245=item B<< C<ESC [ Pm h> >>
1246
1247Set Mode (SM). See B<< C<ESC [ Pm l> >> sequence for description of C<Pm>.
1248
339=item B<< C<ESC [ Ps i> >> 1249=item B<< C<ESC [ Ps i> >>
340 1250
341Printing 1251Printing. See also the C<print-pipe> resource.
342 1252
343=begin table 1253=begin table
344 1254
1255 B<< C<Ps = 0> >> print screen (MC0)
345 B<< C<Ps = 4> >> disable transparent print mode (MC4) 1256 B<< C<Ps = 4> >> disable transparent print mode (MC4)
346 B<< C<Ps = 5> >> enable transparent print mode (MC5) I<unimplemented> 1257 B<< C<Ps = 5> >> enable transparent print mode (MC5)
347 1258
348=end table 1259=end table
349
350=item B<< C<ESC [ Pm h> >>
351
352Set Mode (SM). See next sequence for description of C<Pm>.
353 1260
354=item B<< C<ESC [ Pm l> >> 1261=item B<< C<ESC [ Pm l> >>
355 1262
356Reset Mode (RM) 1263Reset Mode (RM)
357 1264
… …
364 B<< C<h> >> Insert Mode (SMIR) 1271 B<< C<h> >> Insert Mode (SMIR)
365 B<< C<l> >> Replace Mode (RMIR) 1272 B<< C<l> >> Replace Mode (RMIR)
366 1273
367=end table 1274=end table
368 1275
369=item B<< C<Ps = 20> >> I<unimplemented> 1276=item B<< C<Ps = 20> >> (partially implemented)
370 1277
371=begin table 1278=begin table
372 1279
373 B<< C<h> >> Automatic Newline (LNM) 1280 B<< C<h> >> Automatic Newline (LNM)
374 B<< C<h> >> Normal Linefeed (LNM) 1281 B<< C<l> >> Normal Linefeed (LNM)
375 1282
376=end table 1283=end table
377 1284
378=back 1285=back
379 1286
… …
382Character Attributes (SGR) 1289Character Attributes (SGR)
383 1290
384=begin table 1291=begin table
385 1292
386 B<< C<Ps = 0> >> Normal (default) 1293 B<< C<Ps = 0> >> Normal (default)
387 B<< C<Ps = 1 / 22> >> On / Off Bold (bright fg) 1294 B<< C<Ps = 1 / 21> >> On / Off Bold (bright fg)
1295 B<< C<Ps = 3 / 23> >> On / Off Italic
388 B<< C<Ps = 4 / 24> >> On / Off Underline 1296 B<< C<Ps = 4 / 24> >> On / Off Underline
389 B<< C<Ps = 5 / 25> >> On / Off Blink (bright bg) 1297 B<< C<Ps = 5 / 25> >> On / Off Slow Blink (bright bg)
1298 B<< C<Ps = 6 / 26> >> On / Off Rapid Blink (bright bg)
390 B<< C<Ps = 7 / 27> >> On / Off Inverse 1299 B<< C<Ps = 7 / 27> >> On / Off Inverse
1300 B<< C<Ps = 8 / 27> >> On / Off Invisible (NYI)
391 B<< C<Ps = 30 / 40> >> fg/bg Black 1301 B<< C<Ps = 30 / 40> >> fg/bg Black
392 B<< C<Ps = 31 / 41> >> fg/bg Red 1302 B<< C<Ps = 31 / 41> >> fg/bg Red
393 B<< C<Ps = 32 / 42> >> fg/bg Green 1303 B<< C<Ps = 32 / 42> >> fg/bg Green
394 B<< C<Ps = 33 / 43> >> fg/bg Yellow 1304 B<< C<Ps = 33 / 43> >> fg/bg Yellow
395 B<< C<Ps = 34 / 44> >> fg/bg Blue 1305 B<< C<Ps = 34 / 44> >> fg/bg Blue
396 B<< C<Ps = 35 / 45> >> fg/bg Magenta 1306 B<< C<Ps = 35 / 45> >> fg/bg Magenta
397 B<< C<Ps = 36 / 46> >> fg/bg Cyan 1307 B<< C<Ps = 36 / 46> >> fg/bg Cyan
1308 B<< C<Ps = 38;5 / 48;5> >> set fg/bg to color #m (ISO 8613-6)
398 B<< C<Ps = 37 / 47> >> fg/bg White 1309 B<< C<Ps = 37 / 47> >> fg/bg White
399 B<< C<Ps = 39 / 49> >> fg/bg Default 1310 B<< C<Ps = 39 / 49> >> fg/bg Default
1311 B<< C<Ps = 90 / 100> >> fg/bg Bright Black
1312 B<< C<Ps = 91 / 101> >> fg/bg Bright Red
1313 B<< C<Ps = 92 / 102> >> fg/bg Bright Green
1314 B<< C<Ps = 93 / 103> >> fg/bg Bright Yellow
1315 B<< C<Ps = 94 / 104> >> fg/bg Bright Blue
1316 B<< C<Ps = 95 / 105> >> fg/bg Bright Magenta
1317 B<< C<Ps = 96 / 106> >> fg/bg Bright Cyan
1318 B<< C<Ps = 97 / 107> >> fg/bg Bright White
1319 B<< C<Ps = 99 / 109> >> fg/bg Bright Default
400 1320
401=end table 1321=end table
402 1322
403=item B<< C<ESC [ Ps n> >> 1323=item B<< C<ESC [ Ps n> >>
404 1324
… …
420 1340
421=item B<< C<ESC [ s> >> 1341=item B<< C<ESC [ s> >>
422 1342
423Save Cursor (SC) 1343Save Cursor (SC)
424 1344
1345=item B<< C<ESC [ Ps;Pt t> >>
1346
1347Window Operations
1348
1349=begin table
1350
1351 B<< C<Ps = 1> >> Deiconify (map) window
1352 B<< C<Ps = 2> >> Iconify window
1353 B<< C<Ps = 3> >> B<< C<ESC [ 3 ; X ; Y t> >> Move window to (X|Y)
1354 B<< C<Ps = 4> >> B<< C<ESC [ 4 ; H ; W t> >> Resize to WxH pixels
1355 B<< C<Ps = 5> >> Raise window
1356 B<< C<Ps = 6> >> Lower window
1357 B<< C<Ps = 7> >> Refresh screen once
1358 B<< C<Ps = 8> >> B<< C<ESC [ 8 ; R ; C t> >> Resize to R rows and C columns
1359 B<< C<Ps = 11> >> Report window state (responds with C<Ps = 1> or C<Ps = 2>)
1360 B<< C<Ps = 13> >> Report window position (responds with C<Ps = 3>)
1361 B<< C<Ps = 14> >> Report window pixel size (responds with C<Ps = 4>)
1362 B<< C<Ps = 18> >> Report window text size (responds with C<Ps = 7>)
1363 B<< C<Ps = 19> >> Currently the same as C<Ps = 18>, but responds with C<Ps = 9>
1364 B<< C<Ps = 20> >> Reports icon label (B<< C<ESC ] L NAME \234> >>)
1365 B<< C<Ps = 21> >> Reports window title (B<< C<ESC ] l NAME \234> >>)
1366 B<< C<Ps = 24..> >> Set window height to C<Ps> rows
1367
1368=end table
1369
1370=item B<< C<ESC [ u> >>
1371
1372Restore Cursor
1373
425=item B<< C<ESC [ Ps x> >> 1374=item B<< C<ESC [ Ps x> >>
426 1375
427Request Terminal Parameters (DECREQTPARM) 1376Request Terminal Parameters (DECREQTPARM)
428
429=item B<< C<ESC [ u> >>
430
431Restore Cursor
432 1377
433=back 1378=back
434 1379
435X<PrivateModes> 1380X<PrivateModes>
436 1381
… …
539 B<< C<h> >> Send Mouse X & Y on button press. 1484 B<< C<h> >> Send Mouse X & Y on button press.
540 B<< C<l> >> No mouse reporting. 1485 B<< C<l> >> No mouse reporting.
541 1486
542=end table 1487=end table
543 1488
544)X<Priv10>
545
546=item B<< C<Ps = 10> >> (B<rxvt>)
547
548=begin table
549
550 B<< C<h> >> visible
551 B<< C<l> >> invisible
552
553=end table
554
555=item B<< C<Ps = 25> >> 1489=item B<< C<Ps = 25> >>
556 1490
557=begin table 1491=begin table
558 1492
559 B<< C<h> >> Visible cursor {cnorm/cvvis} 1493 B<< C<h> >> Visible cursor {cnorm/cvvis}
… …
625 1559
626=item B<< C<Ps = 66> >> 1560=item B<< C<Ps = 66> >>
627 1561
628=begin table 1562=begin table
629 1563
630 B<< C<h> >> Application Keypad (DECPAM) == 1564 B<< C<h> >> Application Keypad (DECPAM) == C<ESC =>
631 B<< C<l> >> Normal Keypad (DECPNM) == 1565 B<< C<l> >> Normal Keypad (DECPNM) == C<< ESC > >>
632 1566
633=end table 1567=end table
634 1568
635=item B<< C<Ps = 67> >> 1569=item B<< C<Ps = 67> >>
636 1570
… …
657 B<< C<h> >> Use Hilite Mouse Tracking. 1591 B<< C<h> >> Use Hilite Mouse Tracking.
658 B<< C<l> >> No mouse reporting. 1592 B<< C<l> >> No mouse reporting.
659 1593
660=end table 1594=end table
661 1595
662=item B<< C<Ps = 1010> >> 1596=item B<< C<Ps = 1010> >> (B<rxvt>)
663 1597
664=begin table 1598=begin table
665 1599
666 B<< C<h> >> Don't scroll to bottom on TTY output 1600 B<< C<h> >> Don't scroll to bottom on TTY output
667 B<< C<l> >> Scroll to bottom on TTY output 1601 B<< C<l> >> Scroll to bottom on TTY output
668 1602
669=end table 1603=end table
670 1604
671=item B<< C<Ps = 1011> >> 1605=item B<< C<Ps = 1011> >> (B<rxvt>)
672 1606
673=begin table 1607=begin table
674 1608
675 B<< C<h> >> Scroll to bottom when a key is pressed 1609 B<< C<h> >> Scroll to bottom when a key is pressed
676 B<< C<l> >> Don't scroll to bottom when a key is pressed 1610 B<< C<l> >> Don't scroll to bottom when a key is pressed
677 1611
678=end table 1612=end table
679 1613
1614=item B<< C<Ps = 1021> >> (B<rxvt>)
1615
1616=begin table
1617
1618 B<< C<h> >> Bold/italic implies high intensity (see option B<-is>)
1619 B<< C<l> >> Font styles have no effect on intensity (Compile styles)
1620
1621=end table
1622
680=item B<< C<Ps = 1047> >> 1623=item B<< C<Ps = 1047> >>
681 1624
682=begin table 1625=begin table
683 1626
684 B<< C<h> >> Use Alternate Screen Buffer 1627 B<< C<h> >> Use Alternate Screen Buffer
… …
690 1633
691=begin table 1634=begin table
692 1635
693 B<< C<h> >> Save cursor position 1636 B<< C<h> >> Save cursor position
694 B<< C<l> >> Restore cursor position 1637 B<< C<l> >> Restore cursor position
1638
1639=end table
1640
1641=item B<< C<Ps = 1049> >>
1642
1643=begin table
1644
1645 B<< C<h> >> Use Alternate Screen Buffer - clear Alternate Screen Buffer if switching to it
1646 B<< C<l> >> Use Normal Screen Buffer
695 1647
696=end table 1648=end table
697 1649
698=back 1650=back
699 1651
… …
721 B<< C<Ps = 10> >> Change colour of text foreground to B<< C<Pt> >> B<(NB: may change in future)> 1673 B<< C<Ps = 10> >> Change colour of text foreground to B<< C<Pt> >> B<(NB: may change in future)>
722 B<< C<Ps = 11> >> Change colour of text background to B<< C<Pt> >> B<(NB: may change in future)> 1674 B<< C<Ps = 11> >> Change colour of text background to B<< C<Pt> >> B<(NB: may change in future)>
723 B<< C<Ps = 12> >> Change colour of text cursor foreground to B<< C<Pt> >> 1675 B<< C<Ps = 12> >> Change colour of text cursor foreground to B<< C<Pt> >>
724 B<< C<Ps = 13> >> Change colour of mouse foreground to B<< C<Pt> >> 1676 B<< C<Ps = 13> >> Change colour of mouse foreground to B<< C<Pt> >>
725 B<< C<Ps = 17> >> Change colour of highlight characters to B<< C<Pt> >> 1677 B<< C<Ps = 17> >> Change colour of highlight characters to B<< C<Pt> >>
726 B<< C<Ps = 18> >> Change colour of bold characters to B<< C<Pt> >> 1678 B<< C<Ps = 18> >> Change colour of bold characters to B<< C<Pt> >> [deprecated, see 706]
727 B<< C<Ps = 19> >> Change colour of underlined characters to B<< C<Pt> >> 1679 B<< C<Ps = 19> >> Change colour of underlined characters to B<< C<Pt> >> [deprecated, see 707]
1680 B<< C<Ps = 20> >> Change background pixmap parameters (see section XPM) (Compile XPM).
728 B<< C<Ps = 20> >> Change default background to B<< C<Pt> >> 1681 B<< C<Ps = 39> >> Change default foreground colour to B<< C<Pt> >>.
729 B<< C<Ps = 39> >> Change default foreground colour to B<< C<Pt> >> I<rxvt compile-time option>
730 B<< C<Ps = 46> >> Change Log File to B<< C<Pt> >> I<unimplemented> 1682 B<< C<Ps = 46> >> Change Log File to B<< C<Pt> >> I<unimplemented>
731 B<< C<Ps = 49> >> Change default background colour to B<< C<Pt> >> I<rxvt compile-time option> 1683 B<< C<Ps = 49> >> Change default background colour to B<< C<Pt> >>.
732 B<< C<Ps = 50> >> Set fontset to B<< C<Pt> >>, with the following special values of B<< C<Pt> >> (B<rxvt>) B<< C<#+n> >> change up B<< C<n> >> B<< C<#-n> >> change down B<< C<n> >> if B<< C<n> >> is missing of 0, a value of 1 is used I<empty> change to font0 B<< C<n> >> change to font B<< C<n> >> 1684 B<< C<Ps = 50> >> Set fontset to B<< C<Pt> >>, with the following special values of B<< C<Pt> >> (B<rxvt>) B<< C<#+n> >> change up B<< C<n> >> B<< C<#-n> >> change down B<< C<n> >> if B<< C<n> >> is missing of 0, a value of 1 is used I<empty> change to font0 B<< C<n> >> change to font B<< C<n> >>
733 B<< C<Ps = 55> >> Log all scrollback buffer and all of screen to B<< C<Pt> >> 1685 B<< C<Ps = 55> >> Log all scrollback buffer and all of screen to B<< C<Pt> >>
734 B<< C<Ps = 701> >> Change current locale to B<< C<Pt> >>, or, if B<< C<Pt> >> is B<< C<?> >>, return the current locale (@@RXVTNAME@@ extension) 1686 B<< C<Ps = 701> >> Change current locale to B<< C<Pt> >>, or, if B<< C<Pt> >> is B<< C<?> >>, return the current locale (Compile frills).
735 B<< C<Ps = 702> >> find font for character, used for debugging (@@RXVTNAME@@ extension) 1687 B<< C<Ps = 702> >> Request version if B<< C<Pt> >> is B<< C<?> >>, returning C<rxvt-unicode>, the resource name, the major and minor version numbers, e.g. C<ESC ] 702 ; rxvt-unicode ; urxvt ; 7 ; 4 ST>.
736 B<< C<Ps = 703> >> command B<< C<Pt> >> I<rxvt compile-time option> (@@RXVTNAME@@ extension) 1688 B<< C<Ps = 704> >> Change colour of italic characters to B<< C<Pt> >>
1689 B<< C<Ps = 705> >> Change background pixmap tint colour to B<< C<Pt> >> (Compile transparency).
1690 B<< C<Ps = 706> >> Change colour of bold characters to B<< C<Pt> >>
1691 B<< C<Ps = 707> >> Change colour of underlined characters to B<< C<Pt> >>
1692 B<< C<Ps = 710> >> Set normal fontset to B<< C<Pt> >>. Same as C<Ps = 50>.
1693 B<< C<Ps = 711> >> Set bold fontset to B<< C<Pt> >>. Similar to C<Ps = 50> (Compile styles).
1694 B<< C<Ps = 712> >> Set italic fontset to B<< C<Pt> >>. Similar to C<Ps = 50> (Compile styles).
1695 B<< C<Ps = 713> >> Set bold-italic fontset to B<< C<Pt> >>. Similar to C<Ps = 50> (Compile styles).
1696 B<< C<Ps = 720> >> Move viewing window up by B<< C<Pt> >> lines, or clear scrollback buffer if C<Pt = 0> (Compile frills).
1697 B<< C<Ps = 721> >> Move viewing window down by B<< C<Pt> >> lines, or clear scrollback buffer if C<Pt = 0> (Compile frills).
1698 B<< C<Ps = 777> >> Call the perl extension with the given string, which should be of the form C<extension:parameters> (Compile perl).
737 1699
738=end table 1700=end table
739 1701
740=back 1702=back
741 1703
742X<menuBar>
743
744=head1 menuBar
745
746B<< The exact syntax used is I<almost> solidified. >>
747In the menus, B<DON'T> try to use menuBar commands that add or remove a
748menuBar.
749
750Note that in all of the commands, the B<< I</path/> >> I<cannot> be
751omitted: use B<./> to specify a menu relative to the current menu.
752
753=head2 Overview of menuBar operation
754
755For the menuBar XTerm escape sequence C<ESC ] 703 ; Pt ST>, the syntax
756of C<Pt> can be used for a variety of tasks:
757
758At the top level is the current menuBar which is a member of a circular
759linked-list of other such menuBars.
760
761The menuBar acts as a parent for the various drop-down menus, which in
762turn, may have labels, separator lines, menuItems and subMenus.
763
764The menuItems are the useful bits: you can use them to mimic keyboard
765input or even to send text or escape sequences back to rxvt.
766
767The menuBar syntax is intended to provide a simple yet robust method of
768constructing and manipulating menus and navigating through the
769menuBars.
770
771The first step is to use the tag B<< [menu:I<name>] >> which creates
772the menuBar called I<name> and allows access. You may now or menus,
773subMenus, and menuItems. Finally, use the tag B<[done]> to set the
774menuBar access as B<readonly> to prevent accidental corruption of the
775menus. To re-access the current menuBar for alterations, use the tag
776B<[menu]>, make the alterations and then use B<[done]>
777
778X<menuBarCommands>
779
780=head2 Commands
781
782=over 4
783
784=item B<< [menu:+I<name>] >>
785
786access the named menuBar for creation or alteration. If a new menuBar
787is created, it is called I<name> (max of 15 chars) and the current
788menuBar is pushed onto the stack
789
790=item B<[menu]>
791
792access the current menuBar for alteration
793
794=item B<< [title:+I<string>] >>
795
796set the current menuBar's title to I<string>, which may contain the
797following format specifiers:
798B<%%> : literal B<%> character
799B<%n> : rxvt name (as per the B<-name> command-line option)
800B<%v> : rxvt version
801
802=item B<[done]>
803
804set menuBar access as B<readonly>.
805End-of-file tag for B<< [read:+I<file>] >> operations.
806
807=item B<< [read:+I<file>] >>
808
809read menu commands directly from I<file> (extension ".menu" will be
810appended if required.) Start reading at a line with B<[menu]> or B<<
811[menu:+I<name> >> and continuing until B<[done]> is encountered.
812
813Blank and comment lines (starting with B<#>) are ignored. Actually,
814since any invalid menu commands are also ignored, almost anything could
815be construed as a comment line, but this may be tightened up in the
816future ... so don't count on it!.
817
818=item B<< [read:+I<file>;+I<name>] >>
819
820The same as B<< [read:+I<file>] >>, but start reading at a line with
821B<< [menu:+I<name>] >> and continuing until B<< [done:+I<name>] >> or
822B<[done]> is encountered.
823
824=item B<[dump]>
825
826dump all menuBars to the file B</tmp/rxvt-PID> in a format suitable for
827later rereading.
828
829=item B<[rm:name]>
830
831remove the named menuBar
832
833=item B<[rm] [rm:]>
834
835remove the current menuBar
836
837=item B<[rm*] [rm:*]>
838
839remove all menuBars
840
841=item B<[swap]>
842
843swap the top two menuBars
844
845=item B<[prev]>
846
847access the previous menuBar
848
849=item B<[next]>
850
851access the next menuBar
852
853=item B<[show]>
854
855Enable display of the menuBar
856
857=item B<[hide]>
858
859Disable display of the menuBar
860
861=item B<< [pixmap:+I<name>] >>
862
863=item B<< [pixmap:+I<name>;I<scaling>] >>
864
865(set the background pixmap globally
866
867B<< A Future implementation I<may> make this local to the menubar >>)
868
869=item B<< [:+I<command>:] >>
870
871ignore the menu readonly status and issue a I<command> to or a menu or
872menuitem or change the ; a useful shortcut for setting the quick arrows
873from a menuBar.
874
875=back
876
877X<menuBarAdd>
878
879=head2 Adding and accessing menus
880
881The following commands may also be B<+> prefixed.
882
883=over 4
884
885=item B</+>
886
887access menuBar top level
888
889=item B<./+>
890
891access current menu level
892
893=item B<../+>
894
895access parent menu (1 level up)
896
897=item B<../../>
898
899access parent menu (multiple levels up)
900
901=item B<< I</path/>menu >>
902
903add/access menu
904
905=item B<< I</path/>menu/* >>
906
907add/access menu and clear it if it exists
908
909=item B<< I</path/>{-} >>
910
911add separator
912
913=item B<< I</path/>{item} >>
914
915add B<item> as a label
916
917=item B<< I</path/>{item} action >>
918
919add/alter I<menuitem> with an associated I<action>
920
921=item B<< I</path/>{item}{right-text} >>
922
923add/alter I<menuitem> with B<right-text> as the right-justified text
924and as the associated I<action>
925
926=item B<< I</path/>{item}{rtext} action >>
927
928add/alter I<menuitem> with an associated I<action> and with B<rtext> as
929the right-justified text.
930
931=back
932
933=over 4
934
935=item Special characters in I<action> must be backslash-escaped:
936
937B<\a \b \E \e \n \r \t \octal>
938
939=item or in control-character notation:
940
941B<^@, ^A .. ^Z .. ^_, ^?>
942
943=back
944
945To send a string starting with a B<NUL> (B<^@>) character to the
946program, start I<action> with a pair of B<NUL> characters (B<^@^@>),
947the first of which will be stripped off and the balance directed to the
948program. Otherwise if I<action> begins with B<NUL> followed by
949non-+B<NUL> characters, the leading B<NUL> is stripped off and the
950balance is sent back to rxvt.
951
952As a convenience for the many Emacs-type editors, I<action> may start
953with B<M-> (eg, B<M-$> is equivalent to B<\E$>) and a B<CR> will be
954appended if missed from B<M-x> commands.
955
956As a convenience for issuing XTerm B<ESC]> sequences from a menubar (or
957quick arrow), a B<BEL> (B<^G>) will be appended if needed.
958
959=over 4
960
961=item For example,
962
963B<M-xapropos> is equivalent to B<\Exapropos\r>
964
965=item and
966
967B<\E]703;mona;100> is equivalent to B<\E]703;mona;100\a>
968
969=back
970
971The option B<< {I<right-rtext>} >> will be right-justified. In the
972absence of a specified action, this text will be used as the I<action>
973as well.
974
975=over 4
976
977=item For example,
978
979B</File/{Open}{^X^F}> is equivalent to B</File/{Open}{^X^F} ^X^F>
980
981=back
982
983The left label I<is> necessary, since it's used for matching, but
984implicitly hiding the left label (by using same name for both left and
985right labels), or explicitly hiding the left label (by preceeding it
986with a dot), makes it possible to have right-justified text only.
987
988=over 4
989
990=item For example,
991
992B</File/{Open}{Open} Open-File-Action>
993
994=item or hiding it
995
996B</File/{.anylabel}{Open} Open-File-Action>
997
998=back
999
1000X<menuBarRemove>
1001
1002=head2 Removing menus
1003
1004=over 4
1005
1006=item B<< -/*+ >>
1007
1008remove all menus from the menuBar, the same as B<[clear]>
1009
1010=item B<< -+I</path>menu+ >>
1011
1012remove menu
1013
1014=item B<< -+I</path>{item}+ >>
1015
1016remove item
1017
1018=item B<< -+I</path>{-} >>
1019
1020remove separator)
1021
1022=item B<-/path/menu/*>
1023
1024remove all items, separators and submenus from menu
1025
1026=back
1027
1028X<menuBarArrows>
1029
1030=head2 Quick Arrows
1031
1032The menus also provide a hook for I<quick arrows> to provide easier
1033user access. If nothing has been explicitly set, the default is to
1034emulate the curror keys. The syntax permits each arrow to be altered
1035individually or all four at once without re-entering their common
1036beginning/end text. For example, to explicitly associate cursor actions
1037with the arrows, any of the following forms could be used:
1038
1039=over 4
1040
1041=item B<< <r>+I<Right> >>
1042
1043=item B<< <l>+I<Left> >>
1044
1045=item B<< <u>+I<Up> >>
1046
1047=item B<< <d>+I<Down> >>
1048
1049Define actions for the respective arrow buttons
1050
1051=item B<< <b>+I<Begin> >>
1052
1053=item B<< <e>+I<End> >>
1054
1055Define common beginning/end parts for I<quick arrows> which used in
1056conjunction with the above <r> <l> <u> <d> constructs
1057
1058=back
1059
1060=over 4
1061
1062=item For example, define arrows individually,
1063
1064 <u>\E[A
1065
1066 <d>\E[B
1067
1068 <r>\E[C
1069
1070 <l>\E[D
1071
1072=item or all at once
1073
1074 <u>\E[AZ<><d>\E[BZ<><r>\E[CZ<><l>\E[D
1075
1076=item or more compactly (factoring out common parts)
1077
1078 <b>\E[<u>AZ<><d>BZ<><r>CZ<><l>D
1079
1080=back
1081
1082X<menuBarSummary>
1083
1084=head2 Command Summary
1085
1086A short summary of the most I<common> commands:
1087
1088=over 4
1089
1090=item [menu:name]
1091
1092use an existing named menuBar or start a new one
1093
1094=item [menu]
1095
1096use the current menuBar
1097
1098=item [title:string]
1099
1100set menuBar title
1101
1102=item [done]
1103
1104set menu access to readonly and, if reading from a file, signal EOF
1105
1106=item [done:name]
1107
1108if reading from a file using [read:file;name] signal EOF
1109
1110=item [rm:name]
1111
1112remove named menuBar(s)
1113
1114=item [rm] [rm:]
1115
1116remove current menuBar
1117
1118=item [rm*] [rm:*]
1119
1120remove all menuBar(s)
1121
1122=item [swap]
1123
1124swap top two menuBars
1125
1126=item [prev]
1127
1128access the previous menuBar
1129
1130=item [next]
1131
1132access the next menuBar
1133
1134=item [show]
1135
1136map menuBar
1137
1138=item [hide]
1139
1140unmap menuBar
1141
1142=item [pixmap;file]
1143
1144=item [pixmap;file;scaling]
1145
1146set a background pixmap
1147
1148=item [read:file]
1149
1150=item [read:file;name]
1151
1152read in a menu from a file
1153
1154=item [dump]
1155
1156dump out all menuBars to /tmp/rxvt-PID
1157
1158=item /
1159
1160access menuBar top level
1161
1162=item ./
1163
1164=item ../
1165
1166=item ../../
1167
1168access current or parent menu level
1169
1170=item /path/menu
1171
1172add/access menu
1173
1174=item /path/{-}
1175
1176add separator
1177
1178=item /path/{item}{rtext} action
1179
1180add/alter menu item
1181
1182=item -/*
1183
1184remove all menus from the menuBar
1185
1186=item -/path/menu
1187
1188remove menu items, separators and submenus from menu
1189
1190=item -/path/menu
1191
1192remove menu
1193
1194=item -/path/{item}
1195
1196remove item
1197
1198=item -/path/{-}
1199
1200remove separator
1201
1202=item <b>Begin<r>Right<l>Left<u>Up<d>Down<e>End
1203
1204menu quick arrows
1205
1206=back
1207X<XPM> 1704X<XPM>
1208 1705
1209=head1 XPM 1706=head1 XPM
1210 1707
1211For the XPM XTerm escape sequence B<< C<ESC ] 20 ; Pt ST> >> then value 1708For the XPM XTerm escape sequence B<< C<ESC ] 20 ; Pt ST> >> then value
… …
1320 1817
1321Row = B<< C<< <y> - SPACE >> >> 1818Row = B<< C<< <y> - SPACE >> >>
1322 1819
1323=back 1820=back
1324X<KeyCodes> 1821X<KeyCodes>
1325
1326=head1 ISO 14755 support
1327
1328Partial ISO 14755-support is implemented. that means that pressing
1329
1330section 5.1: Control and Shift together enters unicode input
1331mode. Entering hex digits composes a Unicode character, pressing space or
1332releasing the modifiers commits the keycode and every other key cancels
1333the current input character.
1334
1335section 5.2: Pressing and immediately releasing Control and Shift together
1336enters keycap entry mode for the next key: pressing a function key (tab,
1337return etc..) will enter the unicode character corresponding to the given
1338key.
1339 1822
1340=head1 Key Codes 1823=head1 Key Codes
1341 1824
1342Note: B<Shift> + B<F1>-B<F10> generates B<F11>-B<F20> 1825Note: B<Shift> + B<F1>-B<F10> generates B<F11>-B<F20>
1343 1826
… …
1408 XK_KP_8 8 ESC O x 1891 XK_KP_8 8 ESC O x
1409 XK_KP_9 9 ESC O y 1892 XK_KP_9 9 ESC O y
1410 1893
1411=end table 1894=end table
1412 1895
1896=head1 CONFIGURE OPTIONS
1897
1898General hint: if you get compile errors, then likely your configuration
1899hasn't been tested well. Either try with C<--enable-everything> or use
1900the F<./reconf> script as a base for experiments. F<./reconf> is used by
1901myself, so it should generally be a working config. Of course, you should
1902always report when a combination doesn't work, so it can be fixed. Marc
1903Lehmann <rxvt@schmorp.de>.
1904
1905All
1906
1907=over 4
1908
1909=item --enable-everything
1910
1911Add (or remove) support for all non-multichoice options listed in "./configure
1912--help".
1913
1914You can specify this and then disable options you do not like by
1915I<following> this with the appropriate C<--disable-...> arguments,
1916or you can start with a minimal configuration by specifying
1917C<--disable-everything> and than adding just the C<--enable-...> arguments
1918you want.
1919
1920=item --enable-xft (default: enabled)
1921
1922Add support for Xft (anti-aliases, among others) fonts. Xft fonts are
1923slower and require lots of memory, but as long as you don't use them, you
1924don't pay for them.
1925
1926=item --enable-font-styles (default: on)
1927
1928Add support for B<bold>, I<italic> and B<< I<bold italic> >> font
1929styles. The fonts can be set manually or automatically.
1930
1931=item --with-codesets=NAME,... (default: all)
1932
1933Compile in support for additional codeset (encoding) groups (C<eu>, C<vn>
1934are always compiled in, which includes most 8-bit character sets). These
1935codeset tables are used for driving X11 core fonts, they are not required
1936for Xft fonts, although having them compiled in lets rxvt-unicode choose
1937replacement fonts more intelligently. Compiling them in will make your
1938binary bigger (all of together cost about 700kB), but it doesn't increase
1939memory usage unless you use a font requiring one of these encodings.
1940
1941=begin table
1942
1943 all all available codeset groups
1944 zh common chinese encodings
1945 zh_ext rarely used but very big chinese encodigs
1946 jp common japanese encodings
1947 jp_ext rarely used but big japanese encodings
1948 kr korean encodings
1949
1950=end table
1951
1952=item --enable-xim (default: on)
1953
1954Add support for XIM (X Input Method) protocol. This allows using
1955alternative input methods (e.g. kinput2) and will also correctly
1956set up the input for people using dead keys or compose keys.
1957
1958=item --enable-unicode3 (default: off)
1959
1960Recommended to stay off unless you really need non-BMP characters.
1961
1962Enable direct support for displaying unicode codepoints above
196365535 (the basic multilingual page). This increases storage
1964requirements per character from 2 to 4 bytes. X11 fonts do not yet
1965support these extra characters, but Xft does.
1966
1967Please note that rxvt-unicode can store unicode code points >65535
1968even without this flag, but the number of such characters is
1969limited to a view thousand (shared with combining characters,
1970see next switch), and right now rxvt-unicode cannot display them
1971(input/output and cut&paste still work, though).
1972
1973=item --enable-combining (default: on)
1974
1975Enable automatic composition of combining characters into
1976composite characters. This is required for proper viewing of text
1977where accents are encoded as seperate unicode characters. This is
1978done by using precomposited characters when available or creating
1979new pseudo-characters when no precomposed form exists.
1980
1981Without --enable-unicode3, the number of additional precomposed
1982characters is somewhat limited (the 6400 private use characters will be
1983(ab-)used). With --enable-unicode3, no practical limit exists.
1984
1985This option will also enable storage (but not display) of characters
1986beyond plane 0 (>65535) when --enable-unicode3 was not specified.
1987
1988The combining table also contains entries for arabic presentation forms,
1989but these are not currently used. Bug me if you want these to be used (and
1990tell me how these are to be used...).
1991
1992=item --enable-fallback(=CLASS) (default: Rxvt)
1993
1994When reading resource settings, also read settings for class CLASS. To
1995disable resource fallback use --disable-fallback.
1996
1997=item --with-res-name=NAME (default: urxvt)
1998
1999Use the given name as default application name when
2000reading resources. Specify --with-res-name=rxvt to replace rxvt.
2001
2002=item --with-res-class=CLASS /default: URxvt)
2003
2004Use the given class as default application class
2005when reading resources. Specify --with-res-class=Rxvt to replace
2006rxvt.
2007
2008=item --enable-utmp (default: on)
2009
2010Write user and tty to utmp file (used by programs like F<w>) at
2011start of rxvt execution and delete information when rxvt exits.
2012
2013=item --enable-wtmp (default: on)
2014
2015Write user and tty to wtmp file (used by programs like F<last>) at
2016start of rxvt execution and write logout when rxvt exits. This
2017option requires --enable-utmp to also be specified.
2018
2019=item --enable-lastlog (default: on)
2020
2021Write user and tty to lastlog file (used by programs like
2022F<lastlogin>) at start of rxvt execution. This option requires
2023--enable-utmp to also be specified.
2024
2025=item --enable-xpm-background (default: on)
2026
2027Add support for XPM background pixmaps.
2028
2029=item --enable-transparency (default: on)
2030
2031Add support for inheriting parent backgrounds thus giving a fake
2032transparency to the term.
2033
2034=item --enable-fading (default: on)
2035
2036Add support for fading the text when focus is lost (requires C<--enable-transparency>).
2037
2038=item --enable-tinting (default: on)
2039
2040Add support for tinting of transparent backgrounds (requires C<--enable-transparency>).
2041
2042=item --enable-rxvt-scroll (default: on)
2043
2044Add support for the original rxvt scrollbar.
2045
2046=item --enable-next-scroll (default: on)
2047
2048Add support for a NeXT-like scrollbar.
2049
2050=item --enable-xterm-scroll (default: on)
2051
2052Add support for an Xterm-like scrollbar.
2053
2054=item --enable-plain-scroll (default: on)
2055
2056Add support for a very unobtrusive, plain-looking scrollbar that
2057is the favourite of the rxvt-unicode author, having used it for
2058many years.
2059
2060=item --enable-ttygid (default: off)
2061
2062Change tty device setting to group "tty" - only use this if
2063your system uses this type of security.
2064
2065=item --disable-backspace-key
2066
2067Removes any handling of the backspace key by us - let the X server do it.
2068
2069=item --disable-delete-key
2070
2071Removes any handling of the delete key by us - let the X server
2072do it.
2073
2074=item --disable-resources
2075
2076Removes any support for resource checking.
2077
2078=item --disable-swapscreen
2079
2080Remove support for secondary/swap screen.
2081
2082=item --enable-frills (default: on)
2083
2084Add support for many small features that are not essential but nice to
2085have. Normally you want this, but for very small binaries you may want to
2086disable this.
2087
2088A non-exhaustive list of features enabled by C<--enable-frills> (possibly
2089in combination with other switches) is:
2090
2091 MWM-hints
2092 EWMH-hints (pid, utf8 names) and protocols (ping)
2093 seperate underline colour (-underlineColor)
2094 settable border widths and borderless switch (-w, -b, -bl)
2095 visual selection (-depth)
2096 settable extra linespacing /-lsp)
2097 iso-14755-2 and -3, and visual feedback
2098 backindex and forwardindex escape sequence
2099 window op and some xterm/OSC escape sequences
2100 tripleclickwords (-tcw)
2101 settable insecure mode (-insecure)
2102 keysym remapping support
2103 cursor blinking and underline cursor (-cb, -uc)
2104 XEmbed support (-embed)
2105 user-pty (-pty-fd)
2106 hold on exit (-hold)
2107 skip builtin block graphics (-sbg)
2108 sgr modes 90..97 and 100..107
2109
2110It also enabled some non-essential features otherwise disabled, such as:
2111
2112 some round-trip time optimisations
2113 nearest color allocation on pseudocolor screens
2114
2115=item --enable-iso14755 (default: on)
2116
2117Enable extended ISO 14755 support (see @@RXVT_NAME@@(1), or
2118F<doc/rxvt.1.txt>). Basic support (section 5.1) is enabled by
2119C<--enable-frills>, while support for 5.2, 5.3 and 5.4 is enabled with
2120this switch.
2121
2122=item --enable-keepscrolling (default: on)
2123
2124Add support for continual scrolling of the display when you hold
2125the mouse button down on a scrollbar arrow.
2126
2127=item --enable-mousewheel (default: on)
2128
2129Add support for scrolling via mouse wheel or buttons 4 & 5.
2130
2131=item --enable-slipwheeling (default: on)
2132
2133Add support for continual scrolling (using the mouse wheel as an
2134accelerator) while the control key is held down. This option
2135requires --enable-mousewheel to also be specified.
2136
2137=item --disable-new-selection
2138
2139Remove support for mouse selection style like that of xterm.
2140
2141=item --enable-dmalloc (default: off)
2142
2143Use Gray Watson's malloc - which is good for debugging See
2144http://www.letters.com/dmalloc/ for details If you use either this or the
2145next option, you may need to edit src/Makefile after compiling to point
2146DINCLUDE and DLIB to the right places.
2147
2148You can only use either this option and the following (should
2149you use either) .
2150
2151=item --enable-dlmalloc (default: off)
2152
2153Use Doug Lea's malloc - which is good for a production version
2154See L<http://g.oswego.edu/dl/html/malloc.html> for details.
2155
2156=item --enable-smart-resize (default: on)
2157
2158Add smart growth/shrink behaviour when changing font size via hot
2159keys. This should keep the window corner which is closest to a corner of
2160the screen in a fixed position.
2161
2162=item --enable-pointer-blank (default: on)
2163
2164Add support to have the pointer disappear when typing or inactive.
2165
2166=item --enable-perl (default: on)
2167
2168Enable an embedded perl interpreter. See the B<@@RXVT_NAME@@perl(3)>
2169manpage (F<doc/rxvtperl.txt>) for more info on this feature, or the files
2170in F<src/perl-ext/> for the extensions that are installed by default. The
2171perl interpreter that is used can be specified via the C<PERL> environment
2172variable when running configure.
2173
2174=item --with-name=NAME (default: urxvt)
2175
2176Set the basename for the installed binaries, resulting
2177in C<urxvt>, C<urxvtd> etc.). Specify C<--with-name=rxvt> to replace with
2178C<rxvt>.
2179
2180=item --with-term=NAME (default: rxvt-unicode)
2181
2182Change the environmental variable for the terminal to NAME.
2183
2184=item --with-terminfo=PATH
2185
2186Change the environmental variable for the path to the terminfo tree to
2187PATH.
2188
2189=item --with-x
2190
2191Use the X Window System (pretty much default, eh?).
2192
2193=item --with-xpm-includes=DIR
2194
2195Look for the XPM includes in DIR.
2196
2197=item --with-xpm-library=DIR
2198
2199Look for the XPM library in DIR.
2200
2201=item --with-xpm
2202
2203Not needed - define via --enable-xpm-background.
2204
2205=back
2206
2207=head1 AUTHORS
2208
2209Marc Lehmann <rxvt@schmorp.de> converted this document to pod and
2210reworked it from the original Rxvt documentation, which was done by Geoff
2211Wing <gcw@pobox.com>, who in turn used the XTerm documentation and other
2212sources.
2213

Diff Legend

– Removed lines
+ Added lines
< Changed lines
> Changed lines