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.87 by root, Tue Jan 17 16:22:41 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
147rxvt-unicode does not directly support tabs. It will work fine with
148tabbing functionality of many window managers or similar tabbing programs,
149and its embedding-features allow it to be embedded into other programs,
150as witnessed by F<doc/rxvt-tabbed> or the upcoming C<Gtk2::URxvt> perl
151module, which features a tabbed urxvt (murxvt) terminal as an example
152embedding application.
153
154=item How do I know which rxvt-unicode version I'm using?
155
156The version number is displayed with the usage (-h). Also the escape
157sequence C<ESC [ 8 n> sets the window title to the version number. When
158using the @@RXVT_NAME@@c client, the version displayed is that of the
159daemon.
160
161=item I am using Debian GNU/Linux and have a problem...
162
163The Debian GNU/Linux package of rxvt-unicode in sarge contains large
164patches that considerably change the behaviour of rxvt-unicode. Before
165reporting a bug to the original rxvt-unicode author please download and
166install the genuine version (L<http://software.schmorp.de#rxvt-unicode>)
167and try to reproduce the problem. If you cannot, chances are that the
168problems are specific to Debian GNU/Linux, in which case it should be
169reported via the Debian Bug Tracking System (use C<reportbug> to report
170the bug).
171
172For other problems that also affect the Debian package, you can and
173probably should use the Debian BTS, too, because, after all, it's also a
174bug in the Debian version and it serves as a reminder for other users that
175might encounter the same issue.
176
177=item I am maintaining rxvt-unicode for distribution/OS XXX, any recommendation?
178
179You should build one binary with the default options. F<configure>
180now enables most useful options, and the trend goes to making them
181runtime-switchable, too, so there is usually no drawback to enbaling them,
182except higher disk and possibly memory usage. The perl interpreter should
183be enabled, as important functionality (menus, selection, likely more in
184the future) depends on it.
185
186You should not overwrite the C<perl-ext-common> snd C<perl-ext> resources
187system-wide (except maybe with C<defaults>). This will result in useful
188behaviour. If your distribution aims at low memory, add an empty
189C<perl-ext-common> resource to the app-defaults file. This will keep the
190perl interpreter disabled until the user enables it.
191
192If you can/want build more binaries, I recommend building a minimal
193one with C<--disable-everything> (very useful) and a maximal one with
194C<--enable-everything> (less useful, it will be very big due to a lot of
195encodings built-in that increase download times and are rarely used).
196
197=item I need to make it setuid/setgid to support utmp/ptys on my OS, is this safe?
198
199It should be, starting with release 7.1. You are encouraged to properly
200install urxvt with privileges necessary for your OS now.
201
202When rxvt-unicode detects that it runs setuid or setgid, it will fork
203into a helper process for privileged operations (pty handling on some
204systems, utmp/wtmp/lastlog handling on others) and drop privileges
205immediately. This is much safer than most other terminals that keep
206privileges while running (but is more relevant to urxvt, as it contains
207things as perl interpreters, which might be "helpful" to attackers).
208
209This forking is done as the very first within main(), which is very early
210and reduces possible bugs to initialisation code run before main(), or
211things like the dynamic loader of your system, which should result in very
212little risk.
213
214=item When I log-in to another system it tells me about missing terminfo data?
215
216The terminal description used by rxvt-unicode is not as widely available
217as that for xterm, or even rxvt (for which the same problem often arises).
218
219The correct solution for this problem is to install the terminfo, this can
220be done like this (with ncurses' infocmp):
221
222 REMOTE=remotesystem.domain
223 infocmp rxvt-unicode | ssh $REMOTE "cat >/tmp/ti && tic /tmp/ti"
224
225... or by installing rxvt-unicode normally on the remote system,
226
227If you cannot or do not want to do this, then you can simply set
228C<TERM=rxvt> or even C<TERM=xterm>, and live with the small number of
229problems arising, which includes wrong keymapping, less and different
230colours and some refresh errors in fullscreen applications. It's a nice
231quick-and-dirty workaround for rare cases, though.
232
233If you always want to do this (and are fine with the consequences) you
234can either recompile rxvt-unicode with the desired TERM value or use a
235resource to set it:
236
237 URxvt.termName: rxvt
238
239If you don't plan to use B<rxvt> (quite common...) you could also replace
240the rxvt terminfo file with the rxvt-unicode one.
241
242=item C<tic> outputs some error when compiling the terminfo entry.
243
244Most likely it's the empty definition for C<enacs=>. Just replace it by
245C<enacs=\E[0@> and try again.
246
247=item C<bash>'s readline does not work correctly under @@RXVT_NAME@@.
248
249=item I need a termcap file entry.
250
251One reason you might want this is that some distributions or operating
252systems still compile some programs using the long-obsoleted termcap
253library (Fedora Core's bash is one example) and rely on a termcap entry
254for C<rxvt-unicode>.
255
256You could use rxvt's termcap entry with resonable results in many cases.
257You can also create a termcap entry by using terminfo's infocmp program
258like this:
259
260 infocmp -C rxvt-unicode
261
262Or you could use this termcap entry, generated by the command above:
263
264 rxvt-unicode|rxvt-unicode terminal (X Window System):\
265 :am:bw:eo:km:mi:ms:xn:xo:\
266 :co#80:it#8:li#24:lm#0:\
267 :AL=\E[%dL:DC=\E[%dP:DL=\E[%dM:DO=\E[%dB:IC=\E[%d@:\
268 :K1=\EOw:K2=\EOu:K3=\EOy:K4=\EOq:K5=\EOs:LE=\E[%dD:\
269 :RI=\E[%dC:SF=\E[%dS:SR=\E[%dT:UP=\E[%dA:ae=\E(B:al=\E[L:\
270 :as=\E(0:bl=^G:cd=\E[J:ce=\E[K:cl=\E[H\E[2J:\
271 :cm=\E[%i%d;%dH:cr=^M:cs=\E[%i%d;%dr:ct=\E[3g:dc=\E[P:\
272 :dl=\E[M:do=^J:ec=\E[%dX:ei=\E[4l:ho=\E[H:\
273 :i1=\E[?47l\E=\E[?1l:ic=\E[@:im=\E[4h:\
274 :is=\E[r\E[m\E[2J\E[H\E[?7h\E[?1;3;4;6l\E[4l:\
275 :k1=\E[11~:k2=\E[12~:k3=\E[13~:k4=\E[14~:k5=\E[15~:\
276 :k6=\E[17~:k7=\E[18~:k8=\E[19~:k9=\E[20~:kD=\E[3~:\
277 :kI=\E[2~:kN=\E[6~:kP=\E[5~:kb=\177:kd=\EOB:ke=\E[?1l\E>:\
278 :kh=\E[7~:kl=\EOD:kr=\EOC:ks=\E[?1h\E=:ku=\EOA:le=^H:\
279 :mb=\E[5m:md=\E[1m:me=\E[m\017:mr=\E[7m:nd=\E[C:rc=\E8:\
280 :sc=\E7:se=\E[27m:sf=^J:so=\E[7m:sr=\EM:st=\EH:ta=^I:\
281 :te=\E[r\E[?1049l:ti=\E[?1049h:ue=\E[24m:up=\E[A:\
282 :us=\E[4m:vb=\E[?5h\E[?5l:ve=\E[?25h:vi=\E[?25l:\
283 :vs=\E[?25h:
284
285=item Why does C<ls> no longer have coloured output?
286
287The C<ls> in the GNU coreutils unfortunately doesn't use terminfo to
288decide wether a terminal has colour, but uses it's own configuration
289file. Needless to say, C<rxvt-unicode> is not in it's default file (among
290with most other terminals supporting colour). Either add:
291
292 TERM rxvt-unicode
293
294to C</etc/DIR_COLORS> or simply add:
295
296 alias ls='ls --color=auto'
297
298to your C<.profile> or C<.bashrc>.
299
300=item Why doesn't vim/emacs etc. use the 88 colour mode?
301
302=item Why doesn't vim/emacs etc. make use of italic?
303
304=item Why are the secondary screen-related options not working properly?
305
306Make sure you are using C<TERM=rxvt-unicode>. Some pre-packaged
307distributions (most notably Debian GNU/Linux) break rxvt-unicode
308by setting C<TERM> to C<rxvt>, which doesn't have these extra
309features. Unfortunately, some of these (most notably, again, Debian
310GNU/Linux) furthermore fail to even install the C<rxvt-unicode> terminfo
311file, so you will need to install it on your own (See the question B<When
312I log-in to another system it tells me about missing terminfo data?> on
313how to do this).
314
315=item My numerical keypad acts weird and generates differing output?
316
317Some Debian GNUL/Linux users seem to have this problem, although no
318specific details were reported so far. It is possible that this is caused
319by the wrong C<TERM> setting, although the details of wether and how
320this can happen are unknown, as C<TERM=rxvt> should offer a compatible
321keymap. See the answer to the previous question, and please report if that
322helped.
323
324=item Rxvt-unicode does not seem to understand the selected encoding?
325
326=item Unicode does not seem to work?
327
328If you encounter strange problems like typing an accented character but
329getting two unrelated other characters or similar, or if program output is
330subtly garbled, then you should check your locale settings.
331
332Rxvt-unicode must be started with the same C<LC_CTYPE> setting as the
333programs. Often rxvt-unicode is started in the C<C> locale, while the
334login script running within the rxvt-unicode window changes the locale to
335something else, e.g. C<en_GB.UTF-8>. Needless to say, this is not going to work.
336
337The best thing is to fix your startup environment, as you will likely run
338into other problems. If nothing works you can try this in your .profile.
339
340 printf '\e]701;%s\007' "$LC_CTYPE"
341
342If this doesn't work, then maybe you use a C<LC_CTYPE> specification not
343supported on your systems. Some systems have a C<locale> command which
344displays this (also, C<perl -e0> can be used to check locale settings, as
345it will complain loudly if it cannot set the locale). If it displays something
346like:
347
348 locale: Cannot set LC_CTYPE to default locale: ...
349
350Then the locale you specified is not supported on your system.
351
352If nothing works and you are sure that everything is set correctly then
353you will need to remember a little known fact: Some programs just don't
354support locales :(
355
356=item Why do some characters look so much different than others?
357
358=item How does rxvt-unicode choose fonts?
359
360Most fonts do not contain the full range of Unicode, which is
361fine. Chances are that the font you (or the admin/package maintainer of
362your system/os) have specified does not cover all the characters you want
363to display.
364
365B<rxvt-unicode> makes a best-effort try at finding a replacement
366font. Often the result is fine, but sometimes the chosen font looks
367bad/ugly/wrong. Some fonts have totally strange characters that don't
368resemble the correct glyph at all, and rxvt-unicode lacks the artificial
369intelligence to detect that a specific glyph is wrong: it has to believe
370the font that the characters it claims to contain indeed look correct.
371
372In that case, select a font of your taste and add it to the font list,
373e.g.:
374
375 @@RXVT_NAME@@ -fn basefont,font2,font3...
376
377When rxvt-unicode sees a character, it will first look at the base
378font. If the base font does not contain the character, it will go to the
379next font, and so on. Specifying your own fonts will also speed up this
380search and use less resources within rxvt-unicode and the X-server.
381
382The only limitation is that none of the fonts may be larger than the base
383font, as the base font defines the terminal character cell size, which
384must be the same due to the way terminals work.
385
386=item Why do some chinese characters look so different than others?
387
388This is because there is a difference between script and language --
389rxvt-unicode does not know which language the text that is output is,
390as it only knows the unicode character codes. If rxvt-unicode first
391sees a japanese/chinese character, it might choose a japanese font for
392display. Subsequent japanese characters will use that font. Now, many
393chinese characters aren't represented in japanese fonts, so when the first
394non-japanese character comes up, rxvt-unicode will look for a chinese font
395-- unfortunately at this point, it will still use the japanese font for
396chinese characters that are also in the japanese font.
397
398The workaround is easy: just tag a chinese font at the end of your font
399list (see the previous question). The key is to view the font list as
400a preference list: If you expect more japanese, list a japanese font
401first. If you expect more chinese, put a chinese font first.
402
403In the future it might be possible to switch language preferences at
404runtime (the internal data structure has no problem with using different
405fonts for the same character at the same time, but no interface for this
406has been designed yet).
407
408Until then, you might get away with switching fonts at runtime (see L<Can
409I switch the fonts at runtime?> later in this document).
410
411=item Why does rxvt-unicode sometimes leave pixel droppings?
412
413Most fonts were not designed for terminal use, which means that character
414size varies a lot. A font that is otherwise fine for terminal use might
415contain some characters that are simply too wide. Rxvt-unicode will avoid
416these characters. For characters that are just "a bit" too wide a special
417"careful" rendering mode is used that redraws adjacent characters.
418
419All of this requires that fonts do not lie about character sizes,
420however: Xft fonts often draw glyphs larger than their acclaimed bounding
421box, and rxvt-unicode has no way of detecting this (the correct way is to
422ask for the character bounding box, which unfortunately is wrong in these
423cases).
424
425It's not clear (to me at least), wether this is a bug in Xft, freetype,
426or the respective font. If you encounter this problem you might try using
427the C<-lsp> option to give the font more height. If that doesn't work, you
428might be forced to use a different font.
429
430All of this is not a problem when using X11 core fonts, as their bounding
431box data is correct.
432
433=item On Solaris 9, many line-drawing characters are too wide.
434
435Seems to be a known bug, read
436L<http://nixdoc.net/files/forum/about34198.html>. Some people use the
437following ugly workaround to get non-double-wide-characters working:
438
439 #define wcwidth(x) wcwidth(x) > 1 ? 1 : wcwidth(x)
440
441=item My Compose (Multi_key) key is no longer working.
442
443The most common causes for this are that either your locale is not set
444correctly, or you specified a B<preeditStyle> that is not supported by
445your input method. For example, if you specified B<OverTheSpot> and
446your input method (e.g. the default input method handling Compose keys)
447does not support this (for instance because it is not visual), then
448rxvt-unicode will continue without an input method.
449
450In this case either do not specify a B<preeditStyle> or specify more than
451one pre-edit style, such as B<OverTheSpot,Root,None>.
452
453=item I cannot type C<Ctrl-Shift-2> to get an ASCII NUL character due to ISO 14755
454
455Either try C<Ctrl-2> alone (it often is mapped to ASCII NUL even on
456international keyboards) or simply use ISO 14755 support to your
457advantage, typing <Ctrl-Shift-0> to get a ASCII NUL. This works for other
458codes, too, such as C<Ctrl-Shift-1-d> to type the default telnet escape
459character and so on.
460
461=item How can I keep rxvt-unicode from using reverse video so much?
462
463First of all, make sure you are running with the right terminal settings
464(C<TERM=rxvt-unicode>), which will get rid of most of these effects. Then
465make sure you have specified colours for italic and bold, as otherwise
466rxvt-unicode might use reverse video to simulate the effect:
467
468 URxvt.colorBD: white
469 URxvt.colorIT: green
470
471=item Some programs assume totally weird colours (red instead of blue), how can I fix that?
472
473For some unexplainable reason, some rare programs assume a very weird
474colour palette when confronted with a terminal with more than the standard
4758 colours (rxvt-unicode supports 88). The right fix is, of course, to fix
476these programs not to assume non-ISO colours without very good reasons.
477
478In the meantime, you can either edit your C<rxvt-unicode> terminfo
479definition to only claim 8 colour support or use C<TERM=rxvt>, which will
480fix colours but keep you from using other rxvt-unicode features.
481
482=item I am on FreeBSD and rxvt-unicode does not seem to work at all.
483
484Rxvt-unicode requires the symbol C<__STDC_ISO_10646__> to be defined
485in your compile environment, or an implementation that implements it,
486wether it defines the symbol or not. C<__STDC_ISO_10646__> requires that
487B<wchar_t> is represented as unicode.
488
489As you might have guessed, FreeBSD does neither define this symobl nor
490does it support it. Instead, it uses it's own internal representation of
491B<wchar_t>. This is, of course, completely fine with respect to standards.
492
493However, that means rxvt-unicode only works in C<POSIX>, C<ISO-8859-1> and
494C<UTF-8> locales under FreeBSD (which all use Unicode as B<wchar_t>.
495
496C<__STDC_ISO_10646__> is the only sane way to support multi-language
497apps in an OS, as using a locale-dependent (and non-standardized)
498representation of B<wchar_t> makes it impossible to convert between
499B<wchar_t> (as used by X11 and your applications) and any other encoding
500without implementing OS-specific-wrappers for each and every locale. There
501simply are no APIs to convert B<wchar_t> into anything except the current
502locale encoding.
503
504Some applications (such as the formidable B<mlterm>) work around this
505by carrying their own replacement functions for character set handling
506with them, and either implementing OS-dependent hacks or doing multiple
507conversions (which is slow and unreliable in case the OS implements
508encodings slightly different than the terminal emulator).
509
510The rxvt-unicode author insists that the right way to fix this is in the
511system libraries once and for all, instead of forcing every app to carry
512complete replacements for them :)
513
514=item I use Solaris 9 and it doesn't compile/work/etc.
515
516Try the diff in F<doc/solaris9.patch> as a base. It fixes the worst
517problems with C<wcwidth> and a compile problem.
518
519=item How can I use rxvt-unicode under cygwin?
520
521rxvt-unicode should compile and run out of the box on cygwin, using
522the X11 libraries that come with cygwin. libW11 emulation is no
523longer supported (and makes no sense, either, as it only supported a
524single font). I recommend starting the X-server in C<-multiwindow> or
525C<-rootless> mode instead, which will result in similar look&feel as the
526old libW11 emulation.
527
528At the time of this writing, cygwin didn't seem to support any multi-byte
529encodings (you might try C<LC_CTYPE=C-UTF-8>), so you are likely limited
530to 8-bit encodings.
531
532=item How does rxvt-unicode determine the encoding to use?
533
534=item Is there an option to switch encodings?
535
536Unlike some other terminals, rxvt-unicode has no encoding switch, and no
537specific "utf-8" mode, such as xterm. In fact, it doesn't even know about
538UTF-8 or any other encodings with respect to terminal I/O.
539
540The reasons is that there exists a perfectly fine mechanism for selecting
541the encoding, doing I/O and (most important) communicating this to all
542applications so everybody agrees on character properties such as width
543and code number. This mechanism is the I<locale>. Applications not using
544that info will have problems (for example, C<xterm> gets the width of
545characters wrong as it uses it's own, locale-independent table under all
546locales).
547
548Rxvt-unicode uses the C<LC_CTYPE> locale category to select encoding. All
549programs doing the same (that is, most) will automatically agree in the
550interpretation of characters.
551
552Unfortunately, there is no system-independent way to select locales, nor
553is there a standard on how locale specifiers will look like.
554
555On most systems, the content of the C<LC_CTYPE> environment variable
556contains an arbitrary string which corresponds to an already-installed
557locale. Common names for locales are C<en_US.UTF-8>, C<de_DE.ISO-8859-15>,
558C<ja_JP.EUC-JP>, i.e. C<language_country.encoding>, but other forms
559(i.e. C<de> or C<german>) are also common.
560
561Rxvt-unicode ignores all other locale categories, and except for
562the encoding, ignores country or language-specific settings,
563i.e. C<de_DE.UTF-8> and C<ja_JP.UTF-8> are the normally same to
564rxvt-unicode.
565
566If you want to use a specific encoding you have to make sure you start
567rxvt-unicode with the correct C<LC_CTYPE> category.
568
569=item Can I switch locales at runtime?
570
571Yes, using an escape sequence. Try something like this, which sets
572rxvt-unicode's idea of C<LC_CTYPE>.
573
574 printf '\e]701;%s\007' ja_JP.SJIS
575
576See also the previous answer.
577
578Sometimes this capability is rather handy when you want to work in
579one locale (e.g. C<de_DE.UTF-8>) but some programs don't support it
580(e.g. UTF-8). For example, I use this script to start C<xjdic>, which
581first switches to a locale supported by xjdic and back later:
582
583 printf '\e]701;%s\007' ja_JP.SJIS
584 xjdic -js
585 printf '\e]701;%s\007' de_DE.UTF-8
586
587You can also use xterm's C<luit> program, which usually works fine, except
588for some locales where character width differs between program- and
589rxvt-unicode-locales.
590
591=item Can I switch the fonts at runtime?
592
593Yes, using an escape sequence. Try something like this, which has the same
594effect as using the C<-fn> switch, and takes effect immediately:
595
596 printf '\e]50;%s\007' "9x15bold,xft:Kochi Gothic"
597
598This is useful if you e.g. work primarily with japanese (and prefer a
599japanese font), but you have to switch to chinese temporarily, where
600japanese fonts would only be in your way.
601
602You can think of this as a kind of manual ISO-2022 switching.
603
604=item Why do italic characters look as if clipped?
605
606Many fonts have difficulties with italic characters and hinting. For
607example, the otherwise very nicely hinted font C<xft:Bitstream Vera Sans
608Mono> completely fails in it's italic face. A workaround might be to
609enable freetype autohinting, i.e. like this:
610
611 URxvt.italicFont: xft:Bitstream Vera Sans Mono:italic:autohint=true
612 URxvt.boldItalicFont: xft:Bitstream Vera Sans Mono:bold:italic:autohint=true
613
614=item My input method wants <some encoding> but I want UTF-8, what can I do?
615
616You can specify separate locales for the input method and the rest of the
617terminal, using the resource C<imlocale>:
618
619 URxvt.imlocale: ja_JP.EUC-JP
620
621Now you can start your terminal with C<LC_CTYPE=ja_JP.UTF-8> and still
622use your input method. Please note, however, that you will not be able to
623input characters outside C<EUC-JP> in a normal way then, as your input
624method limits you.
625
626=item Rxvt-unicode crashes when the X Input Method changes or exits.
627
628Unfortunately, this is unavoidable, as the XIM protocol is racy by
629design. Applications can avoid some crashes at the expense of memory
630leaks, and Input Methods can avoid some crashes by careful ordering at
631exit time. B<kinput2> (and derived input methods) generally succeeds,
632while B<SCIM> (or similar input methods) fails. In the end, however,
633crashes cannot be completely avoided even if both sides cooperate.
634
635So the only workaround is not to kill your Input Method Servers.
636
637=item Rxvt-unicode uses gobs of memory, how can I reduce that?
638
639Rxvt-unicode tries to obey the rule of not charging you for something you
640don't use. One thing you should try is to configure out all settings that
641you don't need, for example, Xft support is a resource hog by design,
642when used. Compiling it out ensures that no Xft font will be loaded
643accidentally when rxvt-unicode tries to find a font for your characters.
644
645Also, many people (me included) like large windows and even larger
646scrollback buffers: Without C<--enable-unicode3>, rxvt-unicode will use
6476 bytes per screen cell. For a 160x?? window this amounts to almost a
648kilobyte per line. A scrollback buffer of 10000 lines will then (if full)
649use 10 Megabytes of memory. With C<--enable-unicode3> it gets worse, as
650rxvt-unicode then uses 8 bytes per screen cell.
651
652=item Can I speed up Xft rendering somehow?
653
654Yes, the most obvious way to speed it up is to avoid Xft entirely, as
655it is simply slow. If you still want Xft fonts you might try to disable
656antialiasing (by appending C<:antialias=false>), which saves lots of
657memory and also speeds up rendering considerably.
658
659=item Rxvt-unicode doesn't seem to anti-alias its fonts, what is wrong?
660
661Rxvt-unicode will use whatever you specify as a font. If it needs to
662fall back to it's default font search list it will prefer X11 core
663fonts, because they are small and fast, and then use Xft fonts. It has
664antialiasing disabled for most of them, because the author thinks they
665look best that way.
666
667If you want antialiasing, you have to specify the fonts manually.
668
669=item Mouse cut/paste suddenly no longer works.
670
671Make sure that mouse reporting is actually turned off since killing
672some editors prematurely may leave the mouse in mouse report mode. I've
673heard that tcsh may use mouse reporting unless it otherwise specified. A
674quick check is to see if cut/paste works when the Alt or Shift keys are
675depressed.
676
677=item What's with this bold/blink stuff?
678
679If no bold colour is set via C<colorBD:>, bold will invert text using the
680standard foreground colour.
681
682For the standard background colour, blinking will actually make the
683text blink when compiled with C<--enable-blinking>. with standard
684colours. Without C<--enable-blinking>, the blink attribute will be
685ignored.
686
687On ANSI colours, bold/blink attributes are used to set high-intensity
688foreground/background colors.
689
690color0-7 are the low-intensity colors.
691
692color8-15 are the corresponding high-intensity colors.
693
694=item I don't like the screen colors. How do I change them?
695
696You can change the screen colors at run-time using F<~/.Xdefaults>
697resources (or as long-options).
698
699Here are values that are supposed to resemble a VGA screen,
700including the murky brown that passes for low-intensity yellow:
701
702 URxvt.color0: #000000
703 URxvt.color1: #A80000
704 URxvt.color2: #00A800
705 URxvt.color3: #A8A800
706 URxvt.color4: #0000A8
707 URxvt.color5: #A800A8
708 URxvt.color6: #00A8A8
709 URxvt.color7: #A8A8A8
710
711 URxvt.color8: #000054
712 URxvt.color9: #FF0054
713 URxvt.color10: #00FF54
714 URxvt.color11: #FFFF54
715 URxvt.color12: #0000FF
716 URxvt.color13: #FF00FF
717 URxvt.color14: #00FFFF
718 URxvt.color15: #FFFFFF
719
720And here is a more complete set of non-standard colors described (not by
721me) as "pretty girly".
722
723 URxvt.cursorColor: #dc74d1
724 URxvt.pointerColor: #dc74d1
725 URxvt.background: #0e0e0e
726 URxvt.foreground: #4ad5e1
727 URxvt.color0: #000000
728 URxvt.color8: #8b8f93
729 URxvt.color1: #dc74d1
730 URxvt.color9: #dc74d1
731 URxvt.color2: #0eb8c7
732 URxvt.color10: #0eb8c7
733 URxvt.color3: #dfe37e
734 URxvt.color11: #dfe37e
735 URxvt.color5: #9e88f0
736 URxvt.color13: #9e88f0
737 URxvt.color6: #73f7ff
738 URxvt.color14: #73f7ff
739 URxvt.color7: #e1dddd
740 URxvt.color15: #e1dddd
741
742=item How can I start @@RXVT_NAME@@d in a race-free way?
743
744Try C<@@RXVT_NAME@@d -f -o>, which tells @@RXVT_NAME@@d to open the
745display, create the listening socket and then fork.
746
747=item What's with the strange Backspace/Delete key behaviour?
748
749Assuming that the physical Backspace key corresponds to the
750BackSpace keysym (not likely for Linux ... see the following
751question) there are two standard values that can be used for
752Backspace: C<^H> and C<^?>.
753
754Historically, either value is correct, but rxvt-unicode adopts the debian
755policy of using C<^?> when unsure, because it's the one only only correct
756choice :).
757
758Rxvt-unicode tries to inherit the current stty settings and uses the value
759of `erase' to guess the value for backspace. If rxvt-unicode wasn't
760started from a terminal (say, from a menu or by remote shell), then the
761system value of `erase', which corresponds to CERASE in <termios.h>, will
762be used (which may not be the same as your stty setting).
763
764For starting a new rxvt-unicode:
765
766 # use Backspace = ^H
767 $ stty erase ^H
768 $ @@RXVT_NAME@@
769
770 # use Backspace = ^?
771 $ stty erase ^?
772 $ @@RXVT_NAME@@
773
774Toggle with C<ESC [ 36 h> / C<ESC [ 36 l>.
775
776For an existing rxvt-unicode:
777
778 # use Backspace = ^H
779 $ stty erase ^H
780 $ echo -n "^[[36h"
781
782 # use Backspace = ^?
783 $ stty erase ^?
784 $ echo -n "^[[36l"
785
786This helps satisfy some of the Backspace discrepancies that occur, but
787if you use Backspace = C<^H>, make sure that the termcap/terminfo value
788properly reflects that.
789
790The Delete key is a another casualty of the ill-defined Backspace problem.
791To avoid confusion between the Backspace and Delete keys, the Delete
792key has been assigned an escape sequence to match the vt100 for Execute
793(C<ESC [ 3 ~>) and is in the supplied termcap/terminfo.
794
795Some other Backspace problems:
796
797some editors use termcap/terminfo,
798some editors (vim I'm told) expect Backspace = ^H,
799GNU Emacs (and Emacs-like editors) use ^H for help.
800
801Perhaps someday this will all be resolved in a consistent manner.
802
803=item I don't like the key-bindings. How do I change them?
804
805There are some compile-time selections available via configure. Unless
806you have run "configure" with the C<--disable-resources> option you can
807use the `keysym' resource to alter the keystrings associated with keysyms.
808
809Here's an example for a URxvt session started using C<@@RXVT_NAME@@ -name URxvt>
810
811 URxvt.keysym.Home: \033[1~
812 URxvt.keysym.End: \033[4~
813 URxvt.keysym.C-apostrophe: \033<C-'>
814 URxvt.keysym.C-slash: \033<C-/>
815 URxvt.keysym.C-semicolon: \033<C-;>
816 URxvt.keysym.C-grave: \033<C-`>
817 URxvt.keysym.C-comma: \033<C-,>
818 URxvt.keysym.C-period: \033<C-.>
819 URxvt.keysym.C-0x60: \033<C-`>
820 URxvt.keysym.C-Tab: \033<C-Tab>
821 URxvt.keysym.C-Return: \033<C-Return>
822 URxvt.keysym.S-Return: \033<S-Return>
823 URxvt.keysym.S-space: \033<S-Space>
824 URxvt.keysym.M-Up: \033<M-Up>
825 URxvt.keysym.M-Down: \033<M-Down>
826 URxvt.keysym.M-Left: \033<M-Left>
827 URxvt.keysym.M-Right: \033<M-Right>
828 URxvt.keysym.M-C-0: list \033<M-C- 0123456789 >
829 URxvt.keysym.M-C-a: list \033<M-C- abcdefghijklmnopqrstuvwxyz >
830 URxvt.keysym.F12: command:\033]701;zh_CN.GBK\007
831
832See some more examples in the documentation for the B<keysym> resource.
833
834=item I'm using keyboard model XXX that has extra Prior/Next/Insert keys.
835How do I make use of them? For example, the Sun Keyboard type 4
836has the following mappings that rxvt-unicode doesn't recognize.
837
838 KP_Insert == Insert
839 F22 == Print
840 F27 == Home
841 F29 == Prior
842 F33 == End
843 F35 == Next
844
845Rather than have rxvt-unicode try to accommodate all the various possible
846keyboard mappings, it is better to use `xmodmap' to remap the keys as
847required for your particular machine.
848
849=item How do I distinguish wether I'm running rxvt-unicode or a regular xterm?
850I need this to decide about setting colors etc.
851
852rxvt and rxvt-unicode always export the variable "COLORTERM", so you can
853check and see if that is set. Note that several programs, JED, slrn,
854Midnight Commander automatically check this variable to decide whether or
855not to use color.
856
857=item How do I set the correct, full IP address for the DISPLAY variable?
858
859If you've compiled rxvt-unicode with DISPLAY_IS_IP and have enabled
860insecure mode then it is possible to use the following shell script
861snippets to correctly set the display. If your version of rxvt-unicode
862wasn't also compiled with ESCZ_ANSWER (as assumed in these snippets) then
863the COLORTERM variable can be used to distinguish rxvt-unicode from a
864regular xterm.
865
866Courtesy of Chuck Blake <cblake@BBN.COM> with the following shell script
867snippets:
868
869 # Bourne/Korn/POSIX family of shells:
870 [ ${TERM:-foo} = foo ] && TERM=xterm # assume an xterm if we don't know
871 if [ ${TERM:-foo} = xterm ]; then
872 stty -icanon -echo min 0 time 15 # see if enhanced rxvt or not
873 echo -n '^[Z'
874 read term_id
875 stty icanon echo
876 if [ ""${term_id} = '^[[?1;2C' -a ${DISPLAY:-foo} = foo ]; then
877 echo -n '^[[7n' # query the rxvt we are in for the DISPLAY string
878 read DISPLAY # set it in our local shell
879 fi
880 fi
881
882=item How do I compile the manual pages for myself?
883
884You need to have a recent version of perl installed as F</usr/bin/perl>,
885one that comes with F<pod2man>, F<pod2text> and F<pod2html>. Then go to
886the doc subdirectory and enter C<make alldoc>.
887
888=item My question isn't answered here, can I ask a human?
889
890Before sending me mail, you could go to IRC: C<irc.freenode.net>,
891channel C<#rxvt-unicode> has some rxvt-unicode enthusiasts that might be
892interested in learning about new and exciting problems (but not FAQs :).
893
894=back
895
896=head1 RXVT TECHNICAL REFERENCE
897
898=head1 DESCRIPTION
899
900The rest of this document describes various technical aspects of
901B<rxvt-unicode>. First the description of supported command sequences,
902followed by pixmap support and last by a description of all features
903selectable at C<configure> time.
6 904
7=head1 Definitions 905=head1 Definitions
8 906
9=over 4 907=over 4
10 908
… …
37=over 4 935=over 4
38 936
39=item B<< C<ENQ> >> 937=item B<< C<ENQ> >>
40 938
41Enquiry (Ctrl-E) = Send Device Attributes (DA) 939Enquiry (Ctrl-E) = Send Device Attributes (DA)
42request attributes from terminal == 940request attributes from terminal. See B<< C<ESC [ Ps c> >>.
43 941
44=item B<< C<BEL> >> 942=item B<< C<BEL> >>
45 943
46Bell (Ctrl-G) 944Bell (Ctrl-G)
47 945
… …
139Single Shift Select of G3 Character Set (SS3): affects next character 1037Single Shift Select of G3 Character Set (SS3): affects next character
140only I<unimplemented> 1038only I<unimplemented>
141 1039
142=item B<< C<ESC Z> >> 1040=item B<< C<ESC Z> >>
143 1041
144Obsolete form of returns: B<< C<ESC[?1;2C> >> I<rxvt compile-time option> 1042Obsolete form of returns: B<< C<ESC [ ? 1 ; 2 C> >> I<rxvt-unicode compile-time option>
145 1043
146=item B<< C<ESC c> >> 1044=item B<< C<ESC c> >>
147 1045
148Full reset (RIS) 1046Full reset (RIS)
149 1047
… …
153 1051
154=item B<< C<ESC o> >> 1052=item B<< C<ESC o> >>
155 1053
156Invoke the G3 Character Set (LS3) 1054Invoke the G3 Character Set (LS3)
157 1055
158=item B<< C<ESC>(C<C> >> 1056=item B<< C<ESC ( C> >>
159 1057
160Designate G0 Character Set (ISO 2022), see below for values of C<C>. 1058Designate G0 Character Set (ISO 2022), see below for values of C<C>.
161 1059
162=item B<< C<ESC>)C<C> >> 1060=item B<< C<ESC ) C> >>
163 1061
164Designate G1 Character Set (ISO 2022), see below for values of C<C>. 1062Designate G1 Character Set (ISO 2022), see below for values of C<C>.
165 1063
166=item B<< C<ESC * C> >> 1064=item B<< C<ESC * C> >>
167 1065
… …
191 1089
192=back 1090=back
193 1091
194X<CSI> 1092X<CSI>
195 1093
196=head1 CSI (Code Sequence Introducer) Sequences 1094=head1 CSI (Command Sequence Introducer) Sequences
197 1095
198=over 4 1096=over 4
199 1097
200=item B<< C<ESC [ Ps @> >> 1098=item B<< C<ESC [ Ps @> >>
201 1099
… …
298 1196
299Move backward B<< C<Ps> >> [default: 1] tab stops 1197Move backward B<< C<Ps> >> [default: 1] tab stops
300 1198
301=item B<< C<ESC [ Ps '> >> 1199=item B<< C<ESC [ Ps '> >>
302 1200
303== 1201See B<< C<ESC [ Ps G> >>
304 1202
305=item B<< C<ESC [ Ps a> >> 1203=item B<< C<ESC [ Ps a> >>
306 1204
307==X<ESCOBPsc> 1205See B<< C<ESC [ Ps C> >>
308 1206
309=item B<< C<ESC [ Ps c> >> 1207=item B<< C<ESC [ Ps c> >>
310 1208
311Send Device Attributes (DA) 1209Send Device Attributes (DA)
312B<< C<Ps = 0> >> (or omitted): request attributes from terminal 1210B<< C<Ps = 0> >> (or omitted): request attributes from terminal
313returns: B<< C<ESC[?1;2c> >> (``I am a VT100 with Advanced Video 1211returns: B<< C<ESC [ ? 1 ; 2 c> >> (``I am a VT100 with Advanced Video
314Option'') 1212Option'')
315 1213
316=item B<< C<ESC [ Ps d> >> 1214=item B<< C<ESC [ Ps d> >>
317 1215
318Cursor to Line B<< C<Ps> >> (VPA) 1216Cursor to Line B<< C<Ps> >> (VPA)
319 1217
320=item B<< C<ESC [ Ps e> >> 1218=item B<< C<ESC [ Ps e> >>
321 1219
322== 1220See B<< C<ESC [ Ps A> >>
323 1221
324=item B<< C<ESC [ Ps;Ps f> >> 1222=item B<< C<ESC [ Ps;Ps f> >>
325 1223
326Horizontal and Vertical Position [row;column] (HVP) [default: 1;1] 1224Horizontal and Vertical Position [row;column] (HVP) [default: 1;1]
327 1225
… …
334 B<< C<Ps = 0> >> Clear Current Column (default) 1232 B<< C<Ps = 0> >> Clear Current Column (default)
335 B<< C<Ps = 3> >> Clear All (TBC) 1233 B<< C<Ps = 3> >> Clear All (TBC)
336 1234
337=end table 1235=end table
338 1236
1237=item B<< C<ESC [ Pm h> >>
1238
1239Set Mode (SM). See B<< C<ESC [ Pm l> >> sequence for description of C<Pm>.
1240
339=item B<< C<ESC [ Ps i> >> 1241=item B<< C<ESC [ Ps i> >>
340 1242
341Printing 1243Printing. See also the C<print-pipe> resource.
342 1244
343=begin table 1245=begin table
344 1246
1247 B<< C<Ps = 0> >> print screen (MC0)
345 B<< C<Ps = 4> >> disable transparent print mode (MC4) 1248 B<< C<Ps = 4> >> disable transparent print mode (MC4)
346 B<< C<Ps = 5> >> enable transparent print mode (MC5) I<unimplemented> 1249 B<< C<Ps = 5> >> enable transparent print mode (MC5)
347 1250
348=end table 1251=end table
349
350=item B<< C<ESC [ Pm h> >>
351
352Set Mode (SM). See next sequence for description of C<Pm>.
353 1252
354=item B<< C<ESC [ Pm l> >> 1253=item B<< C<ESC [ Pm l> >>
355 1254
356Reset Mode (RM) 1255Reset Mode (RM)
357 1256
… …
364 B<< C<h> >> Insert Mode (SMIR) 1263 B<< C<h> >> Insert Mode (SMIR)
365 B<< C<l> >> Replace Mode (RMIR) 1264 B<< C<l> >> Replace Mode (RMIR)
366 1265
367=end table 1266=end table
368 1267
369=item B<< C<Ps = 20> >> I<unimplemented> 1268=item B<< C<Ps = 20> >> (partially implemented)
370 1269
371=begin table 1270=begin table
372 1271
373 B<< C<h> >> Automatic Newline (LNM) 1272 B<< C<h> >> Automatic Newline (LNM)
374 B<< C<h> >> Normal Linefeed (LNM) 1273 B<< C<l> >> Normal Linefeed (LNM)
375 1274
376=end table 1275=end table
377 1276
378=back 1277=back
379 1278
… …
382Character Attributes (SGR) 1281Character Attributes (SGR)
383 1282
384=begin table 1283=begin table
385 1284
386 B<< C<Ps = 0> >> Normal (default) 1285 B<< C<Ps = 0> >> Normal (default)
387 B<< C<Ps = 1 / 22> >> On / Off Bold (bright fg) 1286 B<< C<Ps = 1 / 21> >> On / Off Bold (bright fg)
1287 B<< C<Ps = 3 / 23> >> On / Off Italic
388 B<< C<Ps = 4 / 24> >> On / Off Underline 1288 B<< C<Ps = 4 / 24> >> On / Off Underline
389 B<< C<Ps = 5 / 25> >> On / Off Blink (bright bg) 1289 B<< C<Ps = 5 / 25> >> On / Off Slow Blink (bright bg)
1290 B<< C<Ps = 6 / 26> >> On / Off Rapid Blink (bright bg)
390 B<< C<Ps = 7 / 27> >> On / Off Inverse 1291 B<< C<Ps = 7 / 27> >> On / Off Inverse
1292 B<< C<Ps = 8 / 27> >> On / Off Invisible (NYI)
391 B<< C<Ps = 30 / 40> >> fg/bg Black 1293 B<< C<Ps = 30 / 40> >> fg/bg Black
392 B<< C<Ps = 31 / 41> >> fg/bg Red 1294 B<< C<Ps = 31 / 41> >> fg/bg Red
393 B<< C<Ps = 32 / 42> >> fg/bg Green 1295 B<< C<Ps = 32 / 42> >> fg/bg Green
394 B<< C<Ps = 33 / 43> >> fg/bg Yellow 1296 B<< C<Ps = 33 / 43> >> fg/bg Yellow
395 B<< C<Ps = 34 / 44> >> fg/bg Blue 1297 B<< C<Ps = 34 / 44> >> fg/bg Blue
396 B<< C<Ps = 35 / 45> >> fg/bg Magenta 1298 B<< C<Ps = 35 / 45> >> fg/bg Magenta
397 B<< C<Ps = 36 / 46> >> fg/bg Cyan 1299 B<< C<Ps = 36 / 46> >> fg/bg Cyan
1300 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 1301 B<< C<Ps = 37 / 47> >> fg/bg White
399 B<< C<Ps = 39 / 49> >> fg/bg Default 1302 B<< C<Ps = 39 / 49> >> fg/bg Default
1303 B<< C<Ps = 90 / 100> >> fg/bg Bright Black
1304 B<< C<Ps = 91 / 101> >> fg/bg Bright Red
1305 B<< C<Ps = 92 / 102> >> fg/bg Bright Green
1306 B<< C<Ps = 93 / 103> >> fg/bg Bright Yellow
1307 B<< C<Ps = 94 / 104> >> fg/bg Bright Blue
1308 B<< C<Ps = 95 / 105> >> fg/bg Bright Magenta
1309 B<< C<Ps = 96 / 106> >> fg/bg Bright Cyan
1310 B<< C<Ps = 97 / 107> >> fg/bg Bright White
1311 B<< C<Ps = 99 / 109> >> fg/bg Bright Default
400 1312
401=end table 1313=end table
402 1314
403=item B<< C<ESC [ Ps n> >> 1315=item B<< C<ESC [ Ps n> >>
404 1316
… …
420 1332
421=item B<< C<ESC [ s> >> 1333=item B<< C<ESC [ s> >>
422 1334
423Save Cursor (SC) 1335Save Cursor (SC)
424 1336
1337=item B<< C<ESC [ Ps;Pt t> >>
1338
1339Window Operations
1340
1341=begin table
1342
1343 B<< C<Ps = 1> >> Deiconify (map) window
1344 B<< C<Ps = 2> >> Iconify window
1345 B<< C<Ps = 3> >> B<< C<ESC [ 3 ; X ; Y t> >> Move window to (X|Y)
1346 B<< C<Ps = 4> >> B<< C<ESC [ 4 ; H ; W t> >> Resize to WxH pixels
1347 B<< C<Ps = 5> >> Raise window
1348 B<< C<Ps = 6> >> Lower window
1349 B<< C<Ps = 7> >> Refresh screen once
1350 B<< C<Ps = 8> >> B<< C<ESC [ 8 ; R ; C t> >> Resize to R rows and C columns
1351 B<< C<Ps = 11> >> Report window state (responds with C<Ps = 1> or C<Ps = 2>)
1352 B<< C<Ps = 13> >> Report window position (responds with C<Ps = 3>)
1353 B<< C<Ps = 14> >> Report window pixel size (responds with C<Ps = 4>)
1354 B<< C<Ps = 18> >> Report window text size (responds with C<Ps = 7>)
1355 B<< C<Ps = 19> >> Currently the same as C<Ps = 18>, but responds with C<Ps = 9>
1356 B<< C<Ps = 20> >> Reports icon label (B<< C<ESC ] L NAME \234> >>)
1357 B<< C<Ps = 21> >> Reports window title (B<< C<ESC ] l NAME \234> >>)
1358 B<< C<Ps = 24..> >> Set window height to C<Ps> rows
1359
1360=end table
1361
1362=item B<< C<ESC [ u> >>
1363
1364Restore Cursor
1365
425=item B<< C<ESC [ Ps x> >> 1366=item B<< C<ESC [ Ps x> >>
426 1367
427Request Terminal Parameters (DECREQTPARM) 1368Request Terminal Parameters (DECREQTPARM)
428
429=item B<< C<ESC [ u> >>
430
431Restore Cursor
432 1369
433=back 1370=back
434 1371
435X<PrivateModes> 1372X<PrivateModes>
436 1373
… …
539 B<< C<h> >> Send Mouse X & Y on button press. 1476 B<< C<h> >> Send Mouse X & Y on button press.
540 B<< C<l> >> No mouse reporting. 1477 B<< C<l> >> No mouse reporting.
541 1478
542=end table 1479=end table
543 1480
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> >> 1481=item B<< C<Ps = 25> >>
556 1482
557=begin table 1483=begin table
558 1484
559 B<< C<h> >> Visible cursor {cnorm/cvvis} 1485 B<< C<h> >> Visible cursor {cnorm/cvvis}
… …
625 1551
626=item B<< C<Ps = 66> >> 1552=item B<< C<Ps = 66> >>
627 1553
628=begin table 1554=begin table
629 1555
630 B<< C<h> >> Application Keypad (DECPAM) == 1556 B<< C<h> >> Application Keypad (DECPAM) == C<ESC =>
631 B<< C<l> >> Normal Keypad (DECPNM) == 1557 B<< C<l> >> Normal Keypad (DECPNM) == C<< ESC > >>
632 1558
633=end table 1559=end table
634 1560
635=item B<< C<Ps = 67> >> 1561=item B<< C<Ps = 67> >>
636 1562
… …
657 B<< C<h> >> Use Hilite Mouse Tracking. 1583 B<< C<h> >> Use Hilite Mouse Tracking.
658 B<< C<l> >> No mouse reporting. 1584 B<< C<l> >> No mouse reporting.
659 1585
660=end table 1586=end table
661 1587
662=item B<< C<Ps = 1010> >> 1588=item B<< C<Ps = 1010> >> (B<rxvt>)
663 1589
664=begin table 1590=begin table
665 1591
666 B<< C<h> >> Don't scroll to bottom on TTY output 1592 B<< C<h> >> Don't scroll to bottom on TTY output
667 B<< C<l> >> Scroll to bottom on TTY output 1593 B<< C<l> >> Scroll to bottom on TTY output
668 1594
669=end table 1595=end table
670 1596
671=item B<< C<Ps = 1011> >> 1597=item B<< C<Ps = 1011> >> (B<rxvt>)
672 1598
673=begin table 1599=begin table
674 1600
675 B<< C<h> >> Scroll to bottom when a key is pressed 1601 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 1602 B<< C<l> >> Don't scroll to bottom when a key is pressed
677 1603
678=end table 1604=end table
679 1605
1606=item B<< C<Ps = 1021> >> (B<rxvt>)
1607
1608=begin table
1609
1610 B<< C<h> >> Bold/italic implies high intensity (see option B<-is>)
1611 B<< C<l> >> Font styles have no effect on intensity (Compile styles)
1612
1613=end table
1614
680=item B<< C<Ps = 1047> >> 1615=item B<< C<Ps = 1047> >>
681 1616
682=begin table 1617=begin table
683 1618
684 B<< C<h> >> Use Alternate Screen Buffer 1619 B<< C<h> >> Use Alternate Screen Buffer
… …
690 1625
691=begin table 1626=begin table
692 1627
693 B<< C<h> >> Save cursor position 1628 B<< C<h> >> Save cursor position
694 B<< C<l> >> Restore cursor position 1629 B<< C<l> >> Restore cursor position
1630
1631=end table
1632
1633=item B<< C<Ps = 1049> >>
1634
1635=begin table
1636
1637 B<< C<h> >> Use Alternate Screen Buffer - clear Alternate Screen Buffer if switching to it
1638 B<< C<l> >> Use Normal Screen Buffer
695 1639
696=end table 1640=end table
697 1641
698=back 1642=back
699 1643
… …
721 B<< C<Ps = 10> >> Change colour of text foreground to B<< C<Pt> >> B<(NB: may change in future)> 1665 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)> 1666 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> >> 1667 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> >> 1668 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> >> 1669 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> >> 1670 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> >> 1671 B<< C<Ps = 19> >> Change colour of underlined characters to B<< C<Pt> >> [deprecated, see 707]
728 B<< C<Ps = 20> >> Change default background to B<< C<Pt> >> 1672 B<< C<Ps = 20> >> Change default background to B<< C<Pt> >>
729 B<< C<Ps = 39> >> Change default foreground colour to B<< C<Pt> >> I<rxvt compile-time option> 1673 B<< C<Ps = 39> >> Change default foreground colour to B<< C<Pt> >>.
730 B<< C<Ps = 46> >> Change Log File to B<< C<Pt> >> I<unimplemented> 1674 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> 1675 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> >> 1676 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> >> 1677 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) 1678 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) 1679 B<< C<Ps = 704> >> Change colour of italic characters to B<< C<Pt> >>
736 B<< C<Ps = 703> >> command B<< C<Pt> >> I<rxvt compile-time option> (@@RXVTNAME@@ extension) 1680 B<< C<Ps = 705> >> Change background pixmap tint colour to B<< C<Pt> >> (Compile transparency).
1681 B<< C<Ps = 706> >> Change colour of bold characters to B<< C<Pt> >>
1682 B<< C<Ps = 707> >> Change colour of underlined characters to B<< C<Pt> >>
1683 B<< C<Ps = 710> >> Set normal fontset to B<< C<Pt> >>. Same as C<Ps = 50>.
1684 B<< C<Ps = 711> >> Set bold fontset to B<< C<Pt> >>. Similar to C<Ps = 50> (Compile styles).
1685 B<< C<Ps = 712> >> Set italic fontset to B<< C<Pt> >>. Similar to C<Ps = 50> (Compile styles).
1686 B<< C<Ps = 713> >> Set bold-italic fontset to B<< C<Pt> >>. Similar to C<Ps = 50> (Compile styles).
1687 B<< C<Ps = 720> >> Move viewing window up by B<< C<Pt> >> lines, or clear scrollback buffer if C<Pt = 0> (Compile frills).
1688 B<< C<Ps = 721> >> Move viewing window down by B<< C<Pt> >> lines, or clear scrollback buffer if C<Pt = 0> (Compile frills).
1689 B<< C<Ps = 777> >> Call the perl extension with the given string, which should be of the form C<extension:parameters> (Compile perl).
737 1690
738=end table 1691=end table
739 1692
740=back 1693=back
741 1694
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> 1695X<XPM>
1208 1696
1209=head1 XPM 1697=head1 XPM
1210 1698
1211For the XPM XTerm escape sequence B<< C<ESC ] 20 ; Pt ST> >> then value 1699For the XPM XTerm escape sequence B<< C<ESC ] 20 ; Pt ST> >> then value
… …
1320 1808
1321Row = B<< C<< <y> - SPACE >> >> 1809Row = B<< C<< <y> - SPACE >> >>
1322 1810
1323=back 1811=back
1324X<KeyCodes> 1812X<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 1813
1340=head1 Key Codes 1814=head1 Key Codes
1341 1815
1342Note: B<Shift> + B<F1>-B<F10> generates B<F11>-B<F20> 1816Note: B<Shift> + B<F1>-B<F10> generates B<F11>-B<F20>
1343 1817
… …
1408 XK_KP_8 8 ESC O x 1882 XK_KP_8 8 ESC O x
1409 XK_KP_9 9 ESC O y 1883 XK_KP_9 9 ESC O y
1410 1884
1411=end table 1885=end table
1412 1886
1887=head1 CONFIGURE OPTIONS
1888
1889General hint: if you get compile errors, then likely your configuration
1890hasn't been tested well. Either try with C<--enable-everything> or use
1891the F<./reconf> script as a base for experiments. F<./reconf> is used by
1892myself, so it should generally be a working config. Of course, you should
1893always report when a combination doesn't work, so it can be fixed. Marc
1894Lehmann <rxvt@schmorp.de>.
1895
1896All
1897
1898=over 4
1899
1900=item --enable-everything
1901
1902Add (or remove) support for all non-multichoice options listed in "./configure
1903--help".
1904
1905You can specify this and then disable options you do not like by
1906I<following> this with the appropriate C<--disable-...> arguments,
1907or you can start with a minimal configuration by specifying
1908C<--disable-everything> and than adding just the C<--enable-...> arguments
1909you want.
1910
1911=item --enable-xft (default: enabled)
1912
1913Add support for Xft (anti-aliases, among others) fonts. Xft fonts are
1914slower and require lots of memory, but as long as you don't use them, you
1915don't pay for them.
1916
1917=item --enable-font-styles (default: on)
1918
1919Add support for B<bold>, I<italic> and B<< I<bold italic> >> font
1920styles. The fonts can be set manually or automatically.
1921
1922=item --with-codesets=NAME,... (default: all)
1923
1924Compile in support for additional codeset (encoding) groups (C<eu>, C<vn>
1925are always compiled in, which includes most 8-bit character sets). These
1926codeset tables are used for driving X11 core fonts, they are not required
1927for Xft fonts, although having them compiled in lets rxvt-unicode choose
1928replacement fonts more intelligently. Compiling them in will make your
1929binary bigger (all of together cost about 700kB), but it doesn't increase
1930memory usage unless you use a font requiring one of these encodings.
1931
1932=begin table
1933
1934 all all available codeset groups
1935 zh common chinese encodings
1936 zh_ext rarely used but very big chinese encodigs
1937 jp common japanese encodings
1938 jp_ext rarely used but big japanese encodings
1939 kr korean encodings
1940
1941=end table
1942
1943=item --enable-xim (default: on)
1944
1945Add support for XIM (X Input Method) protocol. This allows using
1946alternative input methods (e.g. kinput2) and will also correctly
1947set up the input for people using dead keys or compose keys.
1948
1949=item --enable-unicode3 (default: off)
1950
1951Enable direct support for displaying unicode codepoints above
195265535 (the basic multilingual page). This increases storage
1953requirements per character from 2 to 4 bytes. X11 fonts do not yet
1954support these extra characters, but Xft does.
1955
1956Please note that rxvt-unicode can store unicode code points >65535
1957even without this flag, but the number of such characters is
1958limited to a view thousand (shared with combining characters,
1959see next switch), and right now rxvt-unicode cannot display them
1960(input/output and cut&paste still work, though).
1961
1962=item --enable-combining (default: on)
1963
1964Enable automatic composition of combining characters into
1965composite characters. This is required for proper viewing of text
1966where accents are encoded as seperate unicode characters. This is
1967done by using precomposited characters when available or creating
1968new pseudo-characters when no precomposed form exists.
1969
1970Without --enable-unicode3, the number of additional precomposed characters
1971is rather limited (2048, if this is full, rxvt-unicode will use the
1972private use area, extending the number of combinations to 8448). With
1973--enable-unicode3, no practical limit exists.
1974
1975This option will also enable storage (but not display) of characters
1976beyond plane 0 (>65535) when --enable-unicode3 was not specified.
1977
1978The combining table also contains entries for arabic presentation forms,
1979but these are not currently used. Bug me if you want these to be used (and
1980tell me how these are to be used...).
1981
1982=item --enable-fallback(=CLASS) (default: Rxvt)
1983
1984When reading resource settings, also read settings for class CLASS. To disable resource fallback use --disable-fallback.
1985
1986=item --with-res-name=NAME (default: urxvt)
1987
1988Use the given name as default application name when
1989reading resources. Specify --with-res-name=rxvt to replace rxvt.
1990
1991=item --with-res-class=CLASS /default: URxvt)
1992
1993Use the given class as default application class
1994when reading resources. Specify --with-res-class=Rxvt to replace
1995rxvt.
1996
1997=item --enable-utmp (default: on)
1998
1999Write user and tty to utmp file (used by programs like F<w>) at
2000start of rxvt execution and delete information when rxvt exits.
2001
2002=item --enable-wtmp (default: on)
2003
2004Write user and tty to wtmp file (used by programs like F<last>) at
2005start of rxvt execution and write logout when rxvt exits. This
2006option requires --enable-utmp to also be specified.
2007
2008=item --enable-lastlog (default: on)
2009
2010Write user and tty to lastlog file (used by programs like
2011F<lastlogin>) at start of rxvt execution. This option requires
2012--enable-utmp to also be specified.
2013
2014=item --enable-xpm-background (default: on)
2015
2016Add support for XPM background pixmaps.
2017
2018=item --enable-transparency (default: on)
2019
2020Add support for inheriting parent backgrounds thus giving a fake
2021transparency to the term.
2022
2023=item --enable-fading (default: on)
2024
2025Add support for fading the text when focus is lost (requires C<--enable-transparency>).
2026
2027=item --enable-tinting (default: on)
2028
2029Add support for tinting of transparent backgrounds (requires C<--enable-transparency>).
2030
2031=item --enable-rxvt-scroll (default: on)
2032
2033Add support for the original rxvt scrollbar.
2034
2035=item --enable-next-scroll (default: on)
2036
2037Add support for a NeXT-like scrollbar.
2038
2039=item --enable-xterm-scroll (default: on)
2040
2041Add support for an Xterm-like scrollbar.
2042
2043=item --enable-plain-scroll (default: on)
2044
2045Add support for a very unobtrusive, plain-looking scrollbar that
2046is the favourite of the rxvt-unicode author, having used it for
2047many years.
2048
2049=item --enable-ttygid (default: off)
2050
2051Change tty device setting to group "tty" - only use this if
2052your system uses this type of security.
2053
2054=item --disable-backspace-key
2055
2056Removes any handling of the backspace key by us - let the X server do it.
2057
2058=item --disable-delete-key
2059
2060Removes any handling of the delete key by us - let the X server
2061do it.
2062
2063=item --disable-resources
2064
2065Removes any support for resource checking.
2066
2067=item --disable-swapscreen
2068
2069Remove support for secondary/swap screen.
2070
2071=item --enable-frills (default: on)
2072
2073Add support for many small features that are not essential but nice to
2074have. Normally you want this, but for very small binaries you may want to
2075disable this.
2076
2077A non-exhaustive list of features enabled by C<--enable-frills> (possibly
2078in combination with other switches) is:
2079
2080 MWM-hints
2081 EWMH-hints (pid, utf8 names) and protocols (ping)
2082 seperate underline colour (-underlineColor)
2083 settable border widths and borderless switch (-w, -b, -bl)
2084 settable extra linespacing /-lsp)
2085 iso-14755-2 and -3, and visual feedback
2086 backindex and forwardindex escape sequence
2087 window op and some xterm/OSC escape sequences
2088 tripleclickwords (-tcw)
2089 settable insecure mode (-insecure)
2090 keysym remapping support
2091 cursor blinking and underline cursor (-cb, -uc)
2092 XEmbed support (-embed)
2093 user-pty (-pty-fd)
2094 hold on exit (-hold)
2095 skip builtin block graphics (-sbg)
2096 sgr modes 90..97 and 100..107
2097
2098=item --enable-iso14755 (default: on)
2099
2100Enable extended ISO 14755 support (see @@RXVT_NAME@@(1), or
2101F<doc/rxvt.1.txt>). Basic support (section 5.1) is enabled by
2102C<--enable-frills>, while support for 5.2, 5.3 and 5.4 is enabled with
2103this switch.
2104
2105=item --enable-keepscrolling (default: on)
2106
2107Add support for continual scrolling of the display when you hold
2108the mouse button down on a scrollbar arrow.
2109
2110=item --enable-mousewheel (default: on)
2111
2112Add support for scrolling via mouse wheel or buttons 4 & 5.
2113
2114=item --enable-slipwheeling (default: on)
2115
2116Add support for continual scrolling (using the mouse wheel as an
2117accelerator) while the control key is held down. This option
2118requires --enable-mousewheel to also be specified.
2119
2120=item --disable-new-selection
2121
2122Remove support for mouse selection style like that of xterm.
2123
2124=item --enable-dmalloc (default: off)
2125
2126Use Gray Watson's malloc - which is good for debugging See
2127http://www.letters.com/dmalloc/ for details If you use either this or the
2128next option, you may need to edit src/Makefile after compiling to point
2129DINCLUDE and DLIB to the right places.
2130
2131You can only use either this option and the following (should
2132you use either) .
2133
2134=item --enable-dlmalloc (default: off)
2135
2136Use Doug Lea's malloc - which is good for a production version
2137See L<http://g.oswego.edu/dl/html/malloc.html> for details.
2138
2139=item --enable-smart-resize (default: on)
2140
2141Add smart growth/shrink behaviour when changing font size via hot
2142keys. This should keep the window corner which is closest to a corner of
2143the screen in a fixed position.
2144
2145=item --enable-pointer-blank (default: on)
2146
2147Add support to have the pointer disappear when typing or inactive.
2148
2149=item --enable-perl (default: off)
2150
2151Enable an embedded perl interpreter. See the B<@@RXVT_NAME@@perl(3)>
2152manpage (F<doc/rxvtperl.txt>) for more info on this feature, or the files
2153in F<src/perl-ext/> for the extensions that are installed by default. The
2154perl interpreter that is used can be specified via the C<PERL> environment
2155variable when running configure.
2156
2157=item --with-name=NAME (default: urxvt)
2158
2159Set the basename for the installed binaries, resulting
2160in C<urxvt>, C<urxvtd> etc.). Specify C<--with-name=rxvt> to replace with
2161C<rxvt>.
2162
2163=item --with-term=NAME (default: rxvt-unicode)
2164
2165Change the environmental variable for the terminal to NAME.
2166
2167=item --with-terminfo=PATH
2168
2169Change the environmental variable for the path to the terminfo tree to
2170PATH.
2171
2172=item --with-x
2173
2174Use the X Window System (pretty much default, eh?).
2175
2176=item --with-xpm-includes=DIR
2177
2178Look for the XPM includes in DIR.
2179
2180=item --with-xpm-library=DIR
2181
2182Look for the XPM library in DIR.
2183
2184=item --with-xpm
2185
2186Not needed - define via --enable-xpm-background.
2187
2188=back
2189
2190=head1 AUTHORS
2191
2192Marc Lehmann <rxvt@schmorp.de> converted this document to pod and
2193reworked it from the original Rxvt documentation, which was done by Geoff
2194Wing <gcw@pobox.com>, who in turn used the XTerm documentation and other
2195sources.
2196

Diff Legend

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