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.5 by root, Thu Aug 12 22:29:28 2004 UTC vs.
Revision 1.74 by root, Mon Jan 9 07:24:43 2006 UTC

1=head1 NAME
2
3RXVT REFERENCE - FAQ, command sequences and other background information
4
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 Isn't rxvt supposed to be small? Don't all those features bloat?
30
31I often get asked about this, and I think, no, they didn't cause extra
32bloat. If you compare a minimal rxvt and a minimal urxvt, you can see
33that the urxvt binary is larger (due to some encoding tables always being
34compiled in), but it actually uses less memory (RSS) after startup. Even
35with C<--disable-everything>, this comparison is a bit unfair, as many
36features unique to urxvt (locale, encoding conversion, iso14755 etc.) are
37already in use in this mode.
38
39 text data bss drs rss filename
40 98398 1664 24 15695 1824 rxvt --disable-everything
41 188985 9048 66616 18222 1788 urxvt --disable-everything
42
43When you C<--enable-everything> (which _is_ unfair, as this involves xft
44and full locale/XIM support which are quite bloaty inside libX11 and my
45libc), the two diverge, but not unreasnobaly so.
46
47 text data bss drs rss filename
48 163431 2152 24 20123 2060 rxvt --enable-everything
49 1035683 49680 66648 29096 3680 urxvt --enable-everything
50
51The very large size of the text section is explained by the east-asian
52encoding tables, which, if unused, take up disk space but nothing else
53and can be compiled out unless you rely on X11 core fonts that use those
54encodings. The BSS size comes from the 64k emergency buffer that my c++
55compiler allocates (but of course doesn't use unless you are out of
56memory). Also, using an xft font instead of a core font immediately adds a
57few megabytes of RSS. Xft indeed is responsible for a lot of RSS even when
58not used.
59
60Of course, due to every character using two or four bytes instead of one,
61a large scrollback buffer will ultimately make rxvt-unicode use more
62memory.
63
64Compared to e.g. Eterm (5112k), aterm (3132k) and xterm (4680k), this
65still fares rather well. And compared to some monsters like gnome-terminal
66(21152k + extra 4204k in separate processes) or konsole (22200k + extra
6743180k in daemons that stay around after exit, plus half a minute of
68startup time, including the hundreds of warnings it spits out), it fares
69extremely well *g*.
70
71=item Why C++, isn't that unportable/bloated/uncool?
72
73Is this a question? :) It comes up very often. The simple answer is: I had
74to write it, and C++ allowed me to write and maintain it in a fraction
75of the time and effort (which is a scarce resource for me). Put even
76shorter: It simply wouldn't exist without C++.
77
78My personal stance on this is that C++ is less portable than C, but in
79the case of rxvt-unicode this hardly matters, as its portability limits
80are defined by things like X11, pseudo terminals, locale support and unix
81domain sockets, which are all less portable than C++ itself.
82
83Regarding the bloat, see the above question: It's easy to write programs
84in C that use gobs of memory, an certainly possible to write programs in
85C++ that don't. C++ also often comes with large libraries, but this is
86not necessarily the case with GCC. Here is what rxvt links against on my
87system with a minimal config:
88
89 libX11.so.6 => /usr/X11R6/lib/libX11.so.6 (0x00002aaaaabc3000)
90 libc.so.6 => /lib/libc.so.6 (0x00002aaaaadde000)
91 libdl.so.2 => /lib/libdl.so.2 (0x00002aaaab01d000)
92 /lib64/ld-linux-x86-64.so.2 (0x00002aaaaaaab000)
93
94And here is rxvt-unicode:
95
96 libX11.so.6 => /usr/X11R6/lib/libX11.so.6 (0x00002aaaaabc3000)
97 libgcc_s.so.1 => /lib/libgcc_s.so.1 (0x00002aaaaada2000)
98 libc.so.6 => /lib/libc.so.6 (0x00002aaaaaeb0000)
99 libdl.so.2 => /lib/libdl.so.2 (0x00002aaaab0ee000)
100 /lib64/ld-linux-x86-64.so.2 (0x00002aaaaaaab000)
101
102No large bloated libraries (of course, none were linked in statically),
103except maybe libX11 :)
104
105=item Does it support tabs, can I have a tabbed rxvt-unicode?
106
107rxvt-unicode does not directly support tabs. It will work fine with
108tabbing functionality of many window managers or similar tabbing programs,
109and its embedding-features allow it to be embedded into other programs,
110as witnessed by F<doc/rxvt-tabbed> or the upcoming C<Gtk2::URxvt> perl
111module, which features a tabbed urxvt (murxvt) terminal as an example
112embedding application.
113
114=item How do I know which rxvt-unicode version I'm using?
115
116The version number is displayed with the usage (-h). Also the escape
117sequence C<ESC [ 8 n> sets the window title to the version number. When
118using the @@RXVT_NAME@@c client, the version displayed is that of the
119daemon.
120
121=item I am using Debian GNU/Linux and have a problem...
122
123The Debian GNU/Linux package of rxvt-unicode in sarge contains large
124patches that considerably change the behaviour of rxvt-unicode. Before
125reporting a bug to the original rxvt-unicode author please download and
126install the genuine version (L<http://software.schmorp.de#rxvt-unicode>)
127and try to reproduce the problem. If you cannot, chances are that the
128problems are specific to Debian GNU/Linux, in which case it should be
129reported via the Debian Bug Tracking System (use C<reportbug> to report
130the bug).
131
132For other problems that also affect the Debian package, you can and
133probably should use the Debian BTS, too, because, after all, it's also a
134bug in the Debian version and it serves as a reminder for other users that
135might encounter the same issue.
136
137=item I am maintaining rxvt-unicode for distribution/OS XXX, any recommendation?
138
139You should build one binary with the default options. F<configure>
140now enables most useful options, and the trend goes to making them
141runtime-switchable, too, so there is usually no drawback to enbaling them,
142except higher disk and possibly memory usage. The perl interpreter should
143be enabled, as important functionality (menus, selection, likely more in
144the future) depends on it.
145
146You should not overwrite the C<perl-ext-common> snd C<perl-ext> resources
147system-wide (except maybe with C<defaults>). This will result in useful
148behaviour. If your distribution aims at low memory, add an empty
149C<perl-ext-common> resource to the app-defaults file. This will keep the
150perl interpreter disabled until the user enables it.
151
152If you can/want build more binaries, I recommend building a minimal
153one with C<--disable-everything> (very useful) and a maximal one with
154C<--enable-everything> (less useful, it will be very big due to a lot of
155encodings built-in that increase download times and are rarely used).
156
157=item I need to make it setuid/setgid to support utmp/ptys on my OS, is this safe?
158
159Likely not. While I honestly try to make it secure, and am probably
160not bad at it, I think it is simply unreasonable to expect all of
161freetype + fontconfig + xft + xlib + ... + rxvt-unicode itself to all be
162secure. Also, rxvt-unicode disables some options when it detects that it
163runs setuid or setgid, which is not nice.
164
165Elevated privileges are only required for utmp and pty operations on some
166systems (for example, GNU/Linux doesn't need any extra privileges for
167ptys, but some need it for utmp support). If rxvt-unicode doesn't support
168the library/setuid helper that your OS needs I'll be happy to assist you
169in implementing support for it.
170
171So, while setuid/setgid operation is supported and not a problem on your
172typical single-user-no-other-logins unix desktop, always remember that
173its an awful lot of code, most of which isn't checked for security issues
174regularly.
175
176=item When I log-in to another system it tells me about missing terminfo data?
177
178The terminal description used by rxvt-unicode is not as widely available
179as that for xterm, or even rxvt (for which the same problem often arises).
180
181The correct solution for this problem is to install the terminfo, this can
182be done like this (with ncurses' infocmp):
183
184 REMOTE=remotesystem.domain
185 infocmp rxvt-unicode | ssh $REMOTE "cat >/tmp/ti && tic /tmp/ti"
186
187... or by installing rxvt-unicode normally on the remote system,
188
189If you cannot or do not want to do this, then you can simply set
190C<TERM=rxvt> or even C<TERM=xterm>, and live with the small number of
191problems arising, which includes wrong keymapping, less and different
192colours and some refresh errors in fullscreen applications. It's a nice
193quick-and-dirty workaround for rare cases, though.
194
195If you always want to do this (and are fine with the consequences) you
196can either recompile rxvt-unicode with the desired TERM value or use a
197resource to set it:
198
199 URxvt.termName: rxvt
200
201If you don't plan to use B<rxvt> (quite common...) you could also replace
202the rxvt terminfo file with the rxvt-unicode one.
203
204=item C<tic> outputs some error when compiling the terminfo entry.
205
206Most likely it's the empty definition for C<enacs=>. Just replace it by
207C<enacs=\E[0@> and try again.
208
209=item C<bash>'s readline does not work correctly under @@RXVT_NAME@@.
210
211=item I need a termcap file entry.
212
213One reason you might want this is that some distributions or operating
214systems still compile some programs using the long-obsoleted termcap
215library (Fedora Core's bash is one example) and rely on a termcap entry
216for C<rxvt-unicode>.
217
218You could use rxvt's termcap entry with resonable results in many cases.
219You can also create a termcap entry by using terminfo's infocmp program
220like this:
221
222 infocmp -C rxvt-unicode
223
224Or you could use this termcap entry, generated by the command above:
225
226 rxvt-unicode|rxvt-unicode terminal (X Window System):\
227 :am:bw:eo:km:mi:ms:xn:xo:\
228 :co#80:it#8:li#24:lm#0:\
229 :AL=\E[%dL:DC=\E[%dP:DL=\E[%dM:DO=\E[%dB:IC=\E[%d@:\
230 :K1=\EOw:K2=\EOu:K3=\EOy:K4=\EOq:K5=\EOs:LE=\E[%dD:\
231 :RI=\E[%dC:SF=\E[%dS:SR=\E[%dT:UP=\E[%dA:ae=\E(B:al=\E[L:\
232 :as=\E(0:bl=^G:cd=\E[J:ce=\E[K:cl=\E[H\E[2J:\
233 :cm=\E[%i%d;%dH:cr=^M:cs=\E[%i%d;%dr:ct=\E[3g:dc=\E[P:\
234 :dl=\E[M:do=^J:ec=\E[%dX:ei=\E[4l:ho=\E[H:\
235 :i1=\E[?47l\E=\E[?1l:ic=\E[@:im=\E[4h:\
236 :is=\E[r\E[m\E[2J\E[H\E[?7h\E[?1;3;4;6l\E[4l:\
237 :k1=\E[11~:k2=\E[12~:k3=\E[13~:k4=\E[14~:k5=\E[15~:\
238 :k6=\E[17~:k7=\E[18~:k8=\E[19~:k9=\E[20~:kD=\E[3~:\
239 :kI=\E[2~:kN=\E[6~:kP=\E[5~:kb=\177:kd=\EOB:ke=\E[?1l\E>:\
240 :kh=\E[7~:kl=\EOD:kr=\EOC:ks=\E[?1h\E=:ku=\EOA:le=^H:\
241 :mb=\E[5m:md=\E[1m:me=\E[m\017:mr=\E[7m:nd=\E[C:rc=\E8:\
242 :sc=\E7:se=\E[27m:sf=^J:so=\E[7m:sr=\EM:st=\EH:ta=^I:\
243 :te=\E[r\E[?1049l:ti=\E[?1049h:ue=\E[24m:up=\E[A:\
244 :us=\E[4m:vb=\E[?5h\E[?5l:ve=\E[?25h:vi=\E[?25l:\
245 :vs=\E[?25h:
246
247=item Why does C<ls> no longer have coloured output?
248
249The C<ls> in the GNU coreutils unfortunately doesn't use terminfo to
250decide wether a terminal has colour, but uses it's own configuration
251file. Needless to say, C<rxvt-unicode> is not in it's default file (among
252with most other terminals supporting colour). Either add:
253
254 TERM rxvt-unicode
255
256to C</etc/DIR_COLORS> or simply add:
257
258 alias ls='ls --color=auto'
259
260to your C<.profile> or C<.bashrc>.
261
262=item Why doesn't vim/emacs etc. use the 88 colour mode?
263
264=item Why doesn't vim/emacs etc. make use of italic?
265
266=item Why are the secondary screen-related options not working properly?
267
268Make sure you are using C<TERM=rxvt-unicode>. Some pre-packaged
269distributions (most notably Debian GNU/Linux) break rxvt-unicode
270by setting C<TERM> to C<rxvt>, which doesn't have these extra
271features. Unfortunately, some of these (most notably, again, Debian
272GNU/Linux) furthermore fail to even install the C<rxvt-unicode> terminfo
273file, so you will need to install it on your own (See the question B<When
274I log-in to another system it tells me about missing terminfo data?> on
275how to do this).
276
277=item My numerical keypad acts weird and generates differing output?
278
279Some Debian GNUL/Linux users seem to have this problem, although no
280specific details were reported so far. It is possible that this is caused
281by the wrong C<TERM> setting, although the details of wether and how
282this can happen are unknown, as C<TERM=rxvt> should offer a compatible
283keymap. See the answer to the previous question, and please report if that
284helped.
285
286=item Rxvt-unicode does not seem to understand the selected encoding?
287
288=item Unicode does not seem to work?
289
290If you encounter strange problems like typing an accented character but
291getting two unrelated other characters or similar, or if program output is
292subtly garbled, then you should check your locale settings.
293
294Rxvt-unicode must be started with the same C<LC_CTYPE> setting as the
295programs. Often rxvt-unicode is started in the C<C> locale, while the
296login script running within the rxvt-unicode window changes the locale to
297something else, e.g. C<en_GB.UTF-8>. Needless to say, this is not going to work.
298
299The best thing is to fix your startup environment, as you will likely run
300into other problems. If nothing works you can try this in your .profile.
301
302 printf '\e]701;%s\007' "$LC_CTYPE"
303
304If this doesn't work, then maybe you use a C<LC_CTYPE> specification not
305supported on your systems. Some systems have a C<locale> command which
306displays this (also, C<perl -e0> can be used to check locale settings, as
307it will complain loudly if it cannot set the locale). If it displays something
308like:
309
310 locale: Cannot set LC_CTYPE to default locale: ...
311
312Then the locale you specified is not supported on your system.
313
314If nothing works and you are sure that everything is set correctly then
315you will need to remember a little known fact: Some programs just don't
316support locales :(
317
318=item Why do some characters look so much different than others?
319
320=item How does rxvt-unicode choose fonts?
321
322Most fonts do not contain the full range of Unicode, which is
323fine. Chances are that the font you (or the admin/package maintainer of
324your system/os) have specified does not cover all the characters you want
325to display.
326
327B<rxvt-unicode> makes a best-effort try at finding a replacement
328font. Often the result is fine, but sometimes the chosen font looks
329bad/ugly/wrong. Some fonts have totally strange characters that don't
330resemble the correct glyph at all, and rxvt-unicode lacks the artificial
331intelligence to detect that a specific glyph is wrong: it has to believe
332the font that the characters it claims to contain indeed look correct.
333
334In that case, select a font of your taste and add it to the font list,
335e.g.:
336
337 @@RXVT_NAME@@ -fn basefont,font2,font3...
338
339When rxvt-unicode sees a character, it will first look at the base
340font. If the base font does not contain the character, it will go to the
341next font, and so on. Specifying your own fonts will also speed up this
342search and use less resources within rxvt-unicode and the X-server.
343
344The only limitation is that none of the fonts may be larger than the base
345font, as the base font defines the terminal character cell size, which
346must be the same due to the way terminals work.
347
348=item Why do some chinese characters look so different than others?
349
350This is because there is a difference between script and language --
351rxvt-unicode does not know which language the text that is output is,
352as it only knows the unicode character codes. If rxvt-unicode first
353sees a japanese/chinese character, it might choose a japanese font for
354display. Subsequent japanese characters will use that font. Now, many
355chinese characters aren't represented in japanese fonts, so when the first
356non-japanese character comes up, rxvt-unicode will look for a chinese font
357-- unfortunately at this point, it will still use the japanese font for
358chinese characters that are also in the japanese font.
359
360The workaround is easy: just tag a chinese font at the end of your font
361list (see the previous question). The key is to view the font list as
362a preference list: If you expect more japanese, list a japanese font
363first. If you expect more chinese, put a chinese font first.
364
365In the future it might be possible to switch language preferences at
366runtime (the internal data structure has no problem with using different
367fonts for the same character at the same time, but no interface for this
368has been designed yet).
369
370Until then, you might get away with switching fonts at runtime (see L<Can
371I switch the fonts at runtime?> later in this document).
372
373=item Why does rxvt-unicode sometimes leave pixel droppings?
374
375Most fonts were not designed for terminal use, which means that character
376size varies a lot. A font that is otherwise fine for terminal use might
377contain some characters that are simply too wide. Rxvt-unicode will avoid
378these characters. For characters that are just "a bit" too wide a special
379"careful" rendering mode is used that redraws adjacent characters.
380
381All of this requires that fonts do not lie about character sizes,
382however: Xft fonts often draw glyphs larger than their acclaimed bounding
383box, and rxvt-unicode has no way of detecting this (the correct way is to
384ask for the character bounding box, which unfortunately is wrong in these
385cases).
386
387It's not clear (to me at least), wether this is a bug in Xft, freetype,
388or the respective font. If you encounter this problem you might try using
389the C<-lsp> option to give the font more height. If that doesn't work, you
390might be forced to use a different font.
391
392All of this is not a problem when using X11 core fonts, as their bounding
393box data is correct.
394
395=item On Solaris 9, many line-drawing characters are too wide.
396
397Seems to be a known bug, read
398L<http://nixdoc.net/files/forum/about34198.html>. Some people use the
399following ugly workaround to get non-double-wide-characters working:
400
401 #define wcwidth(x) wcwidth(x) > 1 ? 1 : wcwidth(x)
402
403=item My Compose (Multi_key) key is no longer working.
404
405The most common causes for this are that either your locale is not set
406correctly, or you specified a B<preeditStyle> that is not supported by
407your input method. For example, if you specified B<OverTheSpot> and
408your input method (e.g. the default input method handling Compose keys)
409does not support this (for instance because it is not visual), then
410rxvt-unicode will continue without an input method.
411
412In this case either do not specify a B<preeditStyle> or specify more than
413one pre-edit style, such as B<OverTheSpot,Root,None>.
414
415=item I cannot type C<Ctrl-Shift-2> to get an ASCII NUL character due to ISO 14755
416
417Either try C<Ctrl-2> alone (it often is mapped to ASCII NUL even on
418international keyboards) or simply use ISO 14755 support to your
419advantage, typing <Ctrl-Shift-0> to get a ASCII NUL. This works for other
420codes, too, such as C<Ctrl-Shift-1-d> to type the default telnet escape
421character and so on.
422
423=item How can I keep rxvt-unicode from using reverse video so much?
424
425First of all, make sure you are running with the right terminal settings
426(C<TERM=rxvt-unicode>), which will get rid of most of these effects. Then
427make sure you have specified colours for italic and bold, as otherwise
428rxvt-unicode might use reverse video to simulate the effect:
429
430 URxvt.colorBD: white
431 URxvt.colorIT: green
432
433=item Some programs assume totally weird colours (red instead of blue), how can I fix that?
434
435For some unexplainable reason, some rare programs assume a very weird
436colour palette when confronted with a terminal with more than the standard
4378 colours (rxvt-unicode supports 88). The right fix is, of course, to fix
438these programs not to assume non-ISO colours without very good reasons.
439
440In the meantime, you can either edit your C<rxvt-unicode> terminfo
441definition to only claim 8 colour support or use C<TERM=rxvt>, which will
442fix colours but keep you from using other rxvt-unicode features.
443
444=item I am on FreeBSD and rxvt-unicode does not seem to work at all.
445
446Rxvt-unicode requires the symbol C<__STDC_ISO_10646__> to be defined
447in your compile environment, or an implementation that implements it,
448wether it defines the symbol or not. C<__STDC_ISO_10646__> requires that
449B<wchar_t> is represented as unicode.
450
451As you might have guessed, FreeBSD does neither define this symobl nor
452does it support it. Instead, it uses it's own internal representation of
453B<wchar_t>. This is, of course, completely fine with respect to standards.
454
455However, that means rxvt-unicode only works in C<POSIX>, C<ISO-8859-1> and
456C<UTF-8> locales under FreeBSD (which all use Unicode as B<wchar_t>.
457
458C<__STDC_ISO_10646__> is the only sane way to support multi-language
459apps in an OS, as using a locale-dependent (and non-standardized)
460representation of B<wchar_t> makes it impossible to convert between
461B<wchar_t> (as used by X11 and your applications) and any other encoding
462without implementing OS-specific-wrappers for each and every locale. There
463simply are no APIs to convert B<wchar_t> into anything except the current
464locale encoding.
465
466Some applications (such as the formidable B<mlterm>) work around this
467by carrying their own replacement functions for character set handling
468with them, and either implementing OS-dependent hacks or doing multiple
469conversions (which is slow and unreliable in case the OS implements
470encodings slightly different than the terminal emulator).
471
472The rxvt-unicode author insists that the right way to fix this is in the
473system libraries once and for all, instead of forcing every app to carry
474complete replacements for them :)
475
476=item I use Solaris 9 and it doesn't compile/work/etc.
477
478Try the diff in F<doc/solaris9.patch> as a base. It fixes the worst
479problems with C<wcwidth> and a compile problem.
480
481=item How can I use rxvt-unicode under cygwin?
482
483rxvt-unicode should compile and run out of the box on cygwin, using
484the X11 libraries that come with cygwin. libW11 emulation is no
485longer supported (and makes no sense, either, as it only supported a
486single font). I recommend starting the X-server in C<-multiwindow> or
487C<-rootless> mode instead, which will result in similar look&feel as the
488old libW11 emulation.
489
490At the time of this writing, cygwin didn't seem to support any multi-byte
491encodings (you might try C<LC_CTYPE=C-UTF-8>), so you are likely limited
492to 8-bit encodings.
493
494=item How does rxvt-unicode determine the encoding to use?
495
496=item Is there an option to switch encodings?
497
498Unlike some other terminals, rxvt-unicode has no encoding switch, and no
499specific "utf-8" mode, such as xterm. In fact, it doesn't even know about
500UTF-8 or any other encodings with respect to terminal I/O.
501
502The reasons is that there exists a perfectly fine mechanism for selecting
503the encoding, doing I/O and (most important) communicating this to all
504applications so everybody agrees on character properties such as width
505and code number. This mechanism is the I<locale>. Applications not using
506that info will have problems (for example, C<xterm> gets the width of
507characters wrong as it uses it's own, locale-independent table under all
508locales).
509
510Rxvt-unicode uses the C<LC_CTYPE> locale category to select encoding. All
511programs doing the same (that is, most) will automatically agree in the
512interpretation of characters.
513
514Unfortunately, there is no system-independent way to select locales, nor
515is there a standard on how locale specifiers will look like.
516
517On most systems, the content of the C<LC_CTYPE> environment variable
518contains an arbitrary string which corresponds to an already-installed
519locale. Common names for locales are C<en_US.UTF-8>, C<de_DE.ISO-8859-15>,
520C<ja_JP.EUC-JP>, i.e. C<language_country.encoding>, but other forms
521(i.e. C<de> or C<german>) are also common.
522
523Rxvt-unicode ignores all other locale categories, and except for
524the encoding, ignores country or language-specific settings,
525i.e. C<de_DE.UTF-8> and C<ja_JP.UTF-8> are the normally same to
526rxvt-unicode.
527
528If you want to use a specific encoding you have to make sure you start
529rxvt-unicode with the correct C<LC_CTYPE> category.
530
531=item Can I switch locales at runtime?
532
533Yes, using an escape sequence. Try something like this, which sets
534rxvt-unicode's idea of C<LC_CTYPE>.
535
536 printf '\e]701;%s\007' ja_JP.SJIS
537
538See also the previous answer.
539
540Sometimes this capability is rather handy when you want to work in
541one locale (e.g. C<de_DE.UTF-8>) but some programs don't support it
542(e.g. UTF-8). For example, I use this script to start C<xjdic>, which
543first switches to a locale supported by xjdic and back later:
544
545 printf '\e]701;%s\007' ja_JP.SJIS
546 xjdic -js
547 printf '\e]701;%s\007' de_DE.UTF-8
548
549You can also use xterm's C<luit> program, which usually works fine, except
550for some locales where character width differs between program- and
551rxvt-unicode-locales.
552
553=item Can I switch the fonts at runtime?
554
555Yes, using an escape sequence. Try something like this, which has the same
556effect as using the C<-fn> switch, and takes effect immediately:
557
558 printf '\e]50;%s\007' "9x15bold,xft:Kochi Gothic"
559
560This is useful if you e.g. work primarily with japanese (and prefer a
561japanese font), but you have to switch to chinese temporarily, where
562japanese fonts would only be in your way.
563
564You can think of this as a kind of manual ISO-2022 switching.
565
566=item Why do italic characters look as if clipped?
567
568Many fonts have difficulties with italic characters and hinting. For
569example, the otherwise very nicely hinted font C<xft:Bitstream Vera Sans
570Mono> completely fails in it's italic face. A workaround might be to
571enable freetype autohinting, i.e. like this:
572
573 URxvt.italicFont: xft:Bitstream Vera Sans Mono:italic:autohint=true
574 URxvt.boldItalicFont: xft:Bitstream Vera Sans Mono:bold:italic:autohint=true
575
576=item My input method wants <some encoding> but I want UTF-8, what can I do?
577
578You can specify separate locales for the input method and the rest of the
579terminal, using the resource C<imlocale>:
580
581 URxvt*imlocale: ja_JP.EUC-JP
582
583Now you can start your terminal with C<LC_CTYPE=ja_JP.UTF-8> and still
584use your input method. Please note, however, that you will not be able to
585input characters outside C<EUC-JP> in a normal way then, as your input
586method limits you.
587
588=item Rxvt-unicode crashes when the X Input Method changes or exits.
589
590Unfortunately, this is unavoidable, as the XIM protocol is racy by
591design. Applications can avoid some crashes at the expense of memory
592leaks, and Input Methods can avoid some crashes by careful ordering at
593exit time. B<kinput2> (and derived input methods) generally succeeds,
594while B<SCIM> (or similar input methods) fails. In the end, however,
595crashes cannot be completely avoided even if both sides cooperate.
596
597So the only workaround is not to kill your Input Method Servers.
598
599=item Rxvt-unicode uses gobs of memory, how can I reduce that?
600
601Rxvt-unicode tries to obey the rule of not charging you for something you
602don't use. One thing you should try is to configure out all settings that
603you don't need, for example, Xft support is a resource hog by design,
604when used. Compiling it out ensures that no Xft font will be loaded
605accidentally when rxvt-unicode tries to find a font for your characters.
606
607Also, many people (me included) like large windows and even larger
608scrollback buffers: Without C<--enable-unicode3>, rxvt-unicode will use
6096 bytes per screen cell. For a 160x?? window this amounts to almost a
610kilobyte per line. A scrollback buffer of 10000 lines will then (if full)
611use 10 Megabytes of memory. With C<--enable-unicode3> it gets worse, as
612rxvt-unicode then uses 8 bytes per screen cell.
613
614=item Can I speed up Xft rendering somehow?
615
616Yes, the most obvious way to speed it up is to avoid Xft entirely, as
617it is simply slow. If you still want Xft fonts you might try to disable
618antialiasing (by appending C<:antialias=false>), which saves lots of
619memory and also speeds up rendering considerably.
620
621=item Rxvt-unicode doesn't seem to anti-alias its fonts, what is wrong?
622
623Rxvt-unicode will use whatever you specify as a font. If it needs to
624fall back to it's default font search list it will prefer X11 core
625fonts, because they are small and fast, and then use Xft fonts. It has
626antialiasing disabled for most of them, because the author thinks they
627look best that way.
628
629If you want antialiasing, you have to specify the fonts manually.
630
631=item Mouse cut/paste suddenly no longer works.
632
633Make sure that mouse reporting is actually turned off since killing
634some editors prematurely may leave the mouse in mouse report mode. I've
635heard that tcsh may use mouse reporting unless it otherwise specified. A
636quick check is to see if cut/paste works when the Alt or Shift keys are
637depressed. See @@RXVT_NAME@@(7)
638
639=item What's with this bold/blink stuff?
640
641If no bold colour is set via C<colorBD:>, bold will invert text using the
642standard foreground colour.
643
644For the standard background colour, blinking will actually make the
645text blink when compiled with C<--enable-blinking>. with standard
646colours. Without C<--enable-blinking>, the blink attribute will be
647ignored.
648
649On ANSI colours, bold/blink attributes are used to set high-intensity
650foreground/background colors.
651
652color0-7 are the low-intensity colors.
653
654color8-15 are the corresponding high-intensity colors.
655
656=item I don't like the screen colors. How do I change them?
657
658You can change the screen colors at run-time using F<~/.Xdefaults>
659resources (or as long-options).
660
661Here are values that are supposed to resemble a VGA screen,
662including the murky brown that passes for low-intensity yellow:
663
664 URxvt.color0: #000000
665 URxvt.color1: #A80000
666 URxvt.color2: #00A800
667 URxvt.color3: #A8A800
668 URxvt.color4: #0000A8
669 URxvt.color5: #A800A8
670 URxvt.color6: #00A8A8
671 URxvt.color7: #A8A8A8
672
673 URxvt.color8: #000054
674 URxvt.color9: #FF0054
675 URxvt.color10: #00FF54
676 URxvt.color11: #FFFF54
677 URxvt.color12: #0000FF
678 URxvt.color13: #FF00FF
679 URxvt.color14: #00FFFF
680 URxvt.color15: #FFFFFF
681
682And here is a more complete set of non-standard colors described (not by
683me) as "pretty girly".
684
685 URxvt.cursorColor: #dc74d1
686 URxvt.pointerColor: #dc74d1
687 URxvt.background: #0e0e0e
688 URxvt.foreground: #4ad5e1
689 URxvt.color0: #000000
690 URxvt.color8: #8b8f93
691 URxvt.color1: #dc74d1
692 URxvt.color9: #dc74d1
693 URxvt.color2: #0eb8c7
694 URxvt.color10: #0eb8c7
695 URxvt.color3: #dfe37e
696 URxvt.color11: #dfe37e
697 URxvt.color5: #9e88f0
698 URxvt.color13: #9e88f0
699 URxvt.color6: #73f7ff
700 URxvt.color14: #73f7ff
701 URxvt.color7: #e1dddd
702 URxvt.color15: #e1dddd
703
704=item How can I start @@RXVT_NAME@@d in a race-free way?
705
706Try C<@@RXVT_NAME@@d -f -o>, which tells @@RXVT_NAME@@d to open the
707display, create the listening socket and then fork.
708
709=item What's with the strange Backspace/Delete key behaviour?
710
711Assuming that the physical Backspace key corresponds to the
712BackSpace keysym (not likely for Linux ... see the following
713question) there are two standard values that can be used for
714Backspace: C<^H> and C<^?>.
715
716Historically, either value is correct, but rxvt-unicode adopts the debian
717policy of using C<^?> when unsure, because it's the one only only correct
718choice :).
719
720Rxvt-unicode tries to inherit the current stty settings and uses the value
721of `erase' to guess the value for backspace. If rxvt-unicode wasn't
722started from a terminal (say, from a menu or by remote shell), then the
723system value of `erase', which corresponds to CERASE in <termios.h>, will
724be used (which may not be the same as your stty setting).
725
726For starting a new rxvt-unicode:
727
728 # use Backspace = ^H
729 $ stty erase ^H
730 $ @@RXVT_NAME@@
731
732 # use Backspace = ^?
733 $ stty erase ^?
734 $ @@RXVT_NAME@@
735
736Toggle with C<ESC [ 36 h> / C<ESC [ 36 l> as documented in @@RXVT_NAME@@(7).
737
738For an existing rxvt-unicode:
739
740 # use Backspace = ^H
741 $ stty erase ^H
742 $ echo -n "^[[36h"
743
744 # use Backspace = ^?
745 $ stty erase ^?
746 $ echo -n "^[[36l"
747
748This helps satisfy some of the Backspace discrepancies that occur, but
749if you use Backspace = C<^H>, make sure that the termcap/terminfo value
750properly reflects that.
751
752The Delete key is a another casualty of the ill-defined Backspace problem.
753To avoid confusion between the Backspace and Delete keys, the Delete
754key has been assigned an escape sequence to match the vt100 for Execute
755(C<ESC [ 3 ~>) and is in the supplied termcap/terminfo.
756
757Some other Backspace problems:
758
759some editors use termcap/terminfo,
760some editors (vim I'm told) expect Backspace = ^H,
761GNU Emacs (and Emacs-like editors) use ^H for help.
762
763Perhaps someday this will all be resolved in a consistent manner.
764
765=item I don't like the key-bindings. How do I change them?
766
767There are some compile-time selections available via configure. Unless
768you have run "configure" with the C<--disable-resources> option you can
769use the `keysym' resource to alter the keystrings associated with keysyms.
770
771Here's an example for a URxvt session started using C<@@RXVT_NAME@@ -name URxvt>
772
773 URxvt.keysym.Home: \033[1~
774 URxvt.keysym.End: \033[4~
775 URxvt.keysym.C-apostrophe: \033<C-'>
776 URxvt.keysym.C-slash: \033<C-/>
777 URxvt.keysym.C-semicolon: \033<C-;>
778 URxvt.keysym.C-grave: \033<C-`>
779 URxvt.keysym.C-comma: \033<C-,>
780 URxvt.keysym.C-period: \033<C-.>
781 URxvt.keysym.C-0x60: \033<C-`>
782 URxvt.keysym.C-Tab: \033<C-Tab>
783 URxvt.keysym.C-Return: \033<C-Return>
784 URxvt.keysym.S-Return: \033<S-Return>
785 URxvt.keysym.S-space: \033<S-Space>
786 URxvt.keysym.M-Up: \033<M-Up>
787 URxvt.keysym.M-Down: \033<M-Down>
788 URxvt.keysym.M-Left: \033<M-Left>
789 URxvt.keysym.M-Right: \033<M-Right>
790 URxvt.keysym.M-C-0: list \033<M-C- 0123456789 >
791 URxvt.keysym.M-C-a: list \033<M-C- abcdefghijklmnopqrstuvwxyz >
792 URxvt.keysym.F12: command:\033]701;zh_CN.GBK\007
793
794See some more examples in the documentation for the B<keysym> resource.
795
796=item I'm using keyboard model XXX that has extra Prior/Next/Insert keys.
797How do I make use of them? For example, the Sun Keyboard type 4
798has the following mappings that rxvt-unicode doesn't recognize.
799
800 KP_Insert == Insert
801 F22 == Print
802 F27 == Home
803 F29 == Prior
804 F33 == End
805 F35 == Next
806
807Rather than have rxvt-unicode try to accommodate all the various possible
808keyboard mappings, it is better to use `xmodmap' to remap the keys as
809required for your particular machine.
810
811=item How do I distinguish wether I'm running rxvt-unicode or a regular xterm?
812I need this to decide about setting colors etc.
813
814rxvt and rxvt-unicode always export the variable "COLORTERM", so you can
815check and see if that is set. Note that several programs, JED, slrn,
816Midnight Commander automatically check this variable to decide whether or
817not to use color.
818
819=item How do I set the correct, full IP address for the DISPLAY variable?
820
821If you've compiled rxvt-unicode with DISPLAY_IS_IP and have enabled
822insecure mode then it is possible to use the following shell script
823snippets to correctly set the display. If your version of rxvt-unicode
824wasn't also compiled with ESCZ_ANSWER (as assumed in these snippets) then
825the COLORTERM variable can be used to distinguish rxvt-unicode from a
826regular xterm.
827
828Courtesy of Chuck Blake <cblake@BBN.COM> with the following shell script
829snippets:
830
831 # Bourne/Korn/POSIX family of shells:
832 [ ${TERM:-foo} = foo ] && TERM=xterm # assume an xterm if we don't know
833 if [ ${TERM:-foo} = xterm ]; then
834 stty -icanon -echo min 0 time 15 # see if enhanced rxvt or not
835 echo -n '^[Z'
836 read term_id
837 stty icanon echo
838 if [ ""${term_id} = '^[[?1;2C' -a ${DISPLAY:-foo} = foo ]; then
839 echo -n '^[[7n' # query the rxvt we are in for the DISPLAY string
840 read DISPLAY # set it in our local shell
841 fi
842 fi
843
844=item How do I compile the manual pages for myself?
845
846You need to have a recent version of perl installed as F</usr/bin/perl>,
847one that comes with F<pod2man>, F<pod2text> and F<pod2html>. Then go to
848the doc subdirectory and enter C<make alldoc>.
849
850=item My question isn't answered here, can I ask a human?
851
852Before sending me mail, you could go to IRC: C<irc.freenode.net>,
853channel C<#rxvt-unicode> has some rxvt-unicode enthusiasts that might be
854interested in learning about new and exciting problems (but not FAQs :).
855
856=back
857
1=head1 RXVT TECHNICAL REFERENCE 858=head1 RXVT TECHNICAL REFERENCE
859
860=head1 DESCRIPTION
861
862The rest of this document describes various technical aspects of
863B<rxvt-unicode>. First the description of supported command sequences,
864followed by menu and pixmap support and last by a description of all
865features selectable at C<configure> time.
2 866
3=head1 Definitions 867=head1 Definitions
4 868
5=over 4 869=over 4
6 870
135Single Shift Select of G3 Character Set (SS3): affects next character 999Single Shift Select of G3 Character Set (SS3): affects next character
136only I<unimplemented> 1000only I<unimplemented>
137 1001
138=item B<< C<ESC Z> >> 1002=item B<< C<ESC Z> >>
139 1003
140Obsolete form of returns: B<< C<ESC[?1;2C> >> I<rxvt-unicode compile-time option> 1004Obsolete form of returns: B<< C<ESC [ ? 1 ; 2 C> >> I<rxvt-unicode compile-time option>
141 1005
142=item B<< C<ESC c> >> 1006=item B<< C<ESC c> >>
143 1007
144Full reset (RIS) 1008Full reset (RIS)
145 1009
149 1013
150=item B<< C<ESC o> >> 1014=item B<< C<ESC o> >>
151 1015
152Invoke the G3 Character Set (LS3) 1016Invoke the G3 Character Set (LS3)
153 1017
154=item B<< C<ESC>(C<C> >> 1018=item B<< C<ESC ( C> >>
155 1019
156Designate G0 Character Set (ISO 2022), see below for values of C<C>. 1020Designate G0 Character Set (ISO 2022), see below for values of C<C>.
157 1021
158=item B<< C<ESC>)C<C> >> 1022=item B<< C<ESC ) C> >>
159 1023
160Designate G1 Character Set (ISO 2022), see below for values of C<C>. 1024Designate G1 Character Set (ISO 2022), see below for values of C<C>.
161 1025
162=item B<< C<ESC * C> >> 1026=item B<< C<ESC * C> >>
163 1027
187 1051
188=back 1052=back
189 1053
190X<CSI> 1054X<CSI>
191 1055
192=head1 CSI (Code Sequence Introducer) Sequences 1056=head1 CSI (Command Sequence Introducer) Sequences
193 1057
194=over 4 1058=over 4
195 1059
196=item B<< C<ESC [ Ps @> >> 1060=item B<< C<ESC [ Ps @> >>
197 1061
304 1168
305=item B<< C<ESC [ Ps c> >> 1169=item B<< C<ESC [ Ps c> >>
306 1170
307Send Device Attributes (DA) 1171Send Device Attributes (DA)
308B<< C<Ps = 0> >> (or omitted): request attributes from terminal 1172B<< C<Ps = 0> >> (or omitted): request attributes from terminal
309returns: B<< C<ESC[?1;2c> >> (``I am a VT100 with Advanced Video 1173returns: B<< C<ESC [ ? 1 ; 2 c> >> (``I am a VT100 with Advanced Video
310Option'') 1174Option'')
311 1175
312=item B<< C<ESC [ Ps d> >> 1176=item B<< C<ESC [ Ps d> >>
313 1177
314Cursor to Line B<< C<Ps> >> (VPA) 1178Cursor to Line B<< C<Ps> >> (VPA)
330 B<< C<Ps = 0> >> Clear Current Column (default) 1194 B<< C<Ps = 0> >> Clear Current Column (default)
331 B<< C<Ps = 3> >> Clear All (TBC) 1195 B<< C<Ps = 3> >> Clear All (TBC)
332 1196
333=end table 1197=end table
334 1198
1199=item B<< C<ESC [ Pm h> >>
1200
1201Set Mode (SM). See B<< C<ESC [ Pm l> >> sequence for description of C<Pm>.
1202
335=item B<< C<ESC [ Ps i> >> 1203=item B<< C<ESC [ Ps i> >>
336 1204
337Printing 1205Printing. See also the C<print-pipe> resource.
338 1206
339=begin table 1207=begin table
340 1208
1209 B<< C<Ps = 0> >> print screen (MC0)
341 B<< C<Ps = 4> >> disable transparent print mode (MC4) 1210 B<< C<Ps = 4> >> disable transparent print mode (MC4)
342 B<< C<Ps = 5> >> enable transparent print mode (MC5) I<unimplemented> 1211 B<< C<Ps = 5> >> enable transparent print mode (MC5)
343 1212
344=end table 1213=end table
345
346=item B<< C<ESC [ Pm h> >>
347
348Set Mode (SM). See next sequence for description of C<Pm>.
349 1214
350=item B<< C<ESC [ Pm l> >> 1215=item B<< C<ESC [ Pm l> >>
351 1216
352Reset Mode (RM) 1217Reset Mode (RM)
353 1218
360 B<< C<h> >> Insert Mode (SMIR) 1225 B<< C<h> >> Insert Mode (SMIR)
361 B<< C<l> >> Replace Mode (RMIR) 1226 B<< C<l> >> Replace Mode (RMIR)
362 1227
363=end table 1228=end table
364 1229
365=item B<< C<Ps = 20> >> I<unimplemented> 1230=item B<< C<Ps = 20> >> (partially implemented)
366 1231
367=begin table 1232=begin table
368 1233
369 B<< C<h> >> Automatic Newline (LNM) 1234 B<< C<h> >> Automatic Newline (LNM)
370 B<< C<h> >> Normal Linefeed (LNM) 1235 B<< C<l> >> Normal Linefeed (LNM)
371 1236
372=end table 1237=end table
373 1238
374=back 1239=back
375 1240
378Character Attributes (SGR) 1243Character Attributes (SGR)
379 1244
380=begin table 1245=begin table
381 1246
382 B<< C<Ps = 0> >> Normal (default) 1247 B<< C<Ps = 0> >> Normal (default)
383 B<< C<Ps = 1 / 22> >> On / Off Bold (bright fg) 1248 B<< C<Ps = 1 / 21> >> On / Off Bold (bright fg)
1249 B<< C<Ps = 3 / 23> >> On / Off Italic
384 B<< C<Ps = 4 / 24> >> On / Off Underline 1250 B<< C<Ps = 4 / 24> >> On / Off Underline
385 B<< C<Ps = 5 / 25> >> On / Off Blink (bright bg) 1251 B<< C<Ps = 5 / 25> >> On / Off Slow Blink (bright bg)
1252 B<< C<Ps = 6 / 26> >> On / Off Rapid Blink (bright bg)
386 B<< C<Ps = 7 / 27> >> On / Off Inverse 1253 B<< C<Ps = 7 / 27> >> On / Off Inverse
1254 B<< C<Ps = 8 / 27> >> On / Off Invisible (NYI)
387 B<< C<Ps = 30 / 40> >> fg/bg Black 1255 B<< C<Ps = 30 / 40> >> fg/bg Black
388 B<< C<Ps = 31 / 41> >> fg/bg Red 1256 B<< C<Ps = 31 / 41> >> fg/bg Red
389 B<< C<Ps = 32 / 42> >> fg/bg Green 1257 B<< C<Ps = 32 / 42> >> fg/bg Green
390 B<< C<Ps = 33 / 43> >> fg/bg Yellow 1258 B<< C<Ps = 33 / 43> >> fg/bg Yellow
391 B<< C<Ps = 34 / 44> >> fg/bg Blue 1259 B<< C<Ps = 34 / 44> >> fg/bg Blue
392 B<< C<Ps = 35 / 45> >> fg/bg Magenta 1260 B<< C<Ps = 35 / 45> >> fg/bg Magenta
393 B<< C<Ps = 36 / 46> >> fg/bg Cyan 1261 B<< C<Ps = 36 / 46> >> fg/bg Cyan
1262 B<< C<Ps = 38;5 / 48;5> >> set fg/bg to color #m (ISO 8613-6)
394 B<< C<Ps = 37 / 47> >> fg/bg White 1263 B<< C<Ps = 37 / 47> >> fg/bg White
395 B<< C<Ps = 39 / 49> >> fg/bg Default 1264 B<< C<Ps = 39 / 49> >> fg/bg Default
1265 B<< C<Ps = 90 / 100> >> fg/bg Bright Black
1266 B<< C<Ps = 91 / 101> >> fg/bg Bright Red
1267 B<< C<Ps = 92 / 102> >> fg/bg Bright Green
1268 B<< C<Ps = 93 / 103> >> fg/bg Bright Yellow
1269 B<< C<Ps = 94 / 104> >> fg/bg Bright Blue
1270 B<< C<Ps = 95 / 105> >> fg/bg Bright Magenta
1271 B<< C<Ps = 96 / 106> >> fg/bg Bright Cyan
1272 B<< C<Ps = 97 / 107> >> fg/bg Bright White
1273 B<< C<Ps = 99 / 109> >> fg/bg Bright Default
396 1274
397=end table 1275=end table
398 1276
399=item B<< C<ESC [ Ps n> >> 1277=item B<< C<ESC [ Ps n> >>
400 1278
416 1294
417=item B<< C<ESC [ s> >> 1295=item B<< C<ESC [ s> >>
418 1296
419Save Cursor (SC) 1297Save Cursor (SC)
420 1298
1299=item B<< C<ESC [ Ps;Pt t> >>
1300
1301Window Operations
1302
1303=begin table
1304
1305 B<< C<Ps = 1> >> Deiconify (map) window
1306 B<< C<Ps = 2> >> Iconify window
1307 B<< C<Ps = 3> >> B<< C<ESC [ 3 ; X ; Y t> >> Move window to (X|Y)
1308 B<< C<Ps = 4> >> B<< C<ESC [ 4 ; H ; W t> >> Resize to WxH pixels
1309 B<< C<Ps = 5> >> Raise window
1310 B<< C<Ps = 6> >> Lower window
1311 B<< C<Ps = 7> >> Refresh screen once
1312 B<< C<Ps = 8> >> B<< C<ESC [ 8 ; R ; C t> >> Resize to R rows and C columns
1313 B<< C<Ps = 11> >> Report window state (responds with C<Ps = 1> or C<Ps = 2>)
1314 B<< C<Ps = 13> >> Report window position (responds with C<Ps = 3>)
1315 B<< C<Ps = 14> >> Report window pixel size (responds with C<Ps = 4>)
1316 B<< C<Ps = 18> >> Report window text size (responds with C<Ps = 7>)
1317 B<< C<Ps = 19> >> Currently the same as C<Ps = 18>, but responds with C<Ps = 9>
1318 B<< C<Ps = 20> >> Reports icon label (B<< C<ESC ] L NAME \234> >>)
1319 B<< C<Ps = 21> >> Reports window title (B<< C<ESC ] l NAME \234> >>)
1320 B<< C<Ps = 24..> >> Set window height to C<Ps> rows
1321
1322=end table
1323
1324=item B<< C<ESC [ u> >>
1325
1326Restore Cursor
1327
421=item B<< C<ESC [ Ps x> >> 1328=item B<< C<ESC [ Ps x> >>
422 1329
423Request Terminal Parameters (DECREQTPARM) 1330Request Terminal Parameters (DECREQTPARM)
424
425=item B<< C<ESC [ u> >>
426
427Restore Cursor
428 1331
429=back 1332=back
430 1333
431X<PrivateModes> 1334X<PrivateModes>
432 1335
535 B<< C<h> >> Send Mouse X & Y on button press. 1438 B<< C<h> >> Send Mouse X & Y on button press.
536 B<< C<l> >> No mouse reporting. 1439 B<< C<l> >> No mouse reporting.
537 1440
538=end table 1441=end table
539 1442
540X<Priv10>
541
542=item B<< C<Ps = 10> >> (B<rxvt>) 1443=item B<< C<Ps = 10> >> (B<rxvt>)
543 1444
544=begin table 1445=begin table
545 1446
546 B<< C<h> >> visible 1447 B<< C<h> >> menuBar visible
547 B<< C<l> >> invisible 1448 B<< C<l> >> menuBar invisible
548 1449
549=end table 1450=end table
550 1451
551=item B<< C<Ps = 25> >> 1452=item B<< C<Ps = 25> >>
552 1453
653 B<< C<h> >> Use Hilite Mouse Tracking. 1554 B<< C<h> >> Use Hilite Mouse Tracking.
654 B<< C<l> >> No mouse reporting. 1555 B<< C<l> >> No mouse reporting.
655 1556
656=end table 1557=end table
657 1558
658=item B<< C<Ps = 1010> >> 1559=item B<< C<Ps = 1010> >> (B<rxvt>)
659 1560
660=begin table 1561=begin table
661 1562
662 B<< C<h> >> Don't scroll to bottom on TTY output 1563 B<< C<h> >> Don't scroll to bottom on TTY output
663 B<< C<l> >> Scroll to bottom on TTY output 1564 B<< C<l> >> Scroll to bottom on TTY output
664 1565
665=end table 1566=end table
666 1567
667=item B<< C<Ps = 1011> >> 1568=item B<< C<Ps = 1011> >> (B<rxvt>)
668 1569
669=begin table 1570=begin table
670 1571
671 B<< C<h> >> Scroll to bottom when a key is pressed 1572 B<< C<h> >> Scroll to bottom when a key is pressed
672 B<< C<l> >> Don't scroll to bottom when a key is pressed 1573 B<< C<l> >> Don't scroll to bottom when a key is pressed
673 1574
674=end table 1575=end table
675 1576
1577=item B<< C<Ps = 1021> >> (B<rxvt>)
1578
1579=begin table
1580
1581 B<< C<h> >> Bold/italic implies high intensity (see option B<-is>)
1582 B<< C<l> >> Font styles have no effect on intensity (Compile styles)
1583
1584=end table
1585
676=item B<< C<Ps = 1047> >> 1586=item B<< C<Ps = 1047> >>
677 1587
678=begin table 1588=begin table
679 1589
680 B<< C<h> >> Use Alternate Screen Buffer 1590 B<< C<h> >> Use Alternate Screen Buffer
686 1596
687=begin table 1597=begin table
688 1598
689 B<< C<h> >> Save cursor position 1599 B<< C<h> >> Save cursor position
690 B<< C<l> >> Restore cursor position 1600 B<< C<l> >> Restore cursor position
1601
1602=end table
1603
1604=item B<< C<Ps = 1049> >>
1605
1606=begin table
1607
1608 B<< C<h> >> Use Alternate Screen Buffer - clear Alternate Screen Buffer if switching to it
1609 B<< C<l> >> Use Normal Screen Buffer
691 1610
692=end table 1611=end table
693 1612
694=back 1613=back
695 1614
720 B<< C<Ps = 13> >> Change colour of mouse foreground to B<< C<Pt> >> 1639 B<< C<Ps = 13> >> Change colour of mouse foreground to B<< C<Pt> >>
721 B<< C<Ps = 17> >> Change colour of highlight characters to B<< C<Pt> >> 1640 B<< C<Ps = 17> >> Change colour of highlight characters to B<< C<Pt> >>
722 B<< C<Ps = 18> >> Change colour of bold characters to B<< C<Pt> >> 1641 B<< C<Ps = 18> >> Change colour of bold characters to B<< C<Pt> >>
723 B<< C<Ps = 19> >> Change colour of underlined characters to B<< C<Pt> >> 1642 B<< C<Ps = 19> >> Change colour of underlined characters to B<< C<Pt> >>
724 B<< C<Ps = 20> >> Change default background to B<< C<Pt> >> 1643 B<< C<Ps = 20> >> Change default background to B<< C<Pt> >>
725 B<< C<Ps = 39> >> Change default foreground colour to B<< C<Pt> >> I<rxvt compile-time option> 1644 B<< C<Ps = 39> >> Change default foreground colour to B<< C<Pt> >>.
726 B<< C<Ps = 46> >> Change Log File to B<< C<Pt> >> I<unimplemented> 1645 B<< C<Ps = 46> >> Change Log File to B<< C<Pt> >> I<unimplemented>
727 B<< C<Ps = 49> >> Change default background colour to B<< C<Pt> >> I<rxvt compile-time option> 1646 B<< C<Ps = 49> >> Change default background colour to B<< C<Pt> >>.
728 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> >> 1647 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> >>
729 B<< C<Ps = 55> >> Log all scrollback buffer and all of screen to B<< C<Pt> >> 1648 B<< C<Ps = 55> >> Log all scrollback buffer and all of screen to B<< C<Pt> >>
730 B<< C<Ps = 701> >> Change current locale to B<< C<Pt> >>, or, if B<< C<Pt> >> is B<< C<?> >>, return the current locale (@@RXVT_NAME@@ extension) 1649 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).
731 B<< C<Ps = 702> >> find font for character, used for debugging (@@RXVT_NAME@@ extension) 1650 B<< C<Ps = 703> >> Menubar command B<< C<Pt> >> (Compile menubar).
732 B<< C<Ps = 703> >> command B<< C<Pt> >> I<rxvt compile-time option> (@@RXVT_NAME@@ extension) 1651 B<< C<Ps = 704> >> Change colour of italic characters to B<< C<Pt> >>
1652 B<< C<Ps = 705> >> Change background pixmap tint colour to B<< C<Pt> >> (Compile transparency).
1653 B<< C<Ps = 710> >> Set normal fontset to B<< C<Pt> >>. Same as C<Ps = 50>.
1654 B<< C<Ps = 711> >> Set bold fontset to B<< C<Pt> >>. Similar to C<Ps = 50> (Compile styles).
1655 B<< C<Ps = 712> >> Set italic fontset to B<< C<Pt> >>. Similar to C<Ps = 50> (Compile styles).
1656 B<< C<Ps = 713> >> Set bold-italic fontset to B<< C<Pt> >>. Similar to C<Ps = 50> (Compile styles).
1657 B<< C<Ps = 720> >> Move viewing window up by B<< C<Pt> >> lines, or clear scrollback buffer if C<Pt = 0> (Compile frills).
1658 B<< C<Ps = 721> >> Move viewing window down by B<< C<Pt> >> lines, or clear scrollback buffer if C<Pt = 0> (Compile frills).
1659 B<< C<Ps = 777> >> Call the perl extension with the given string, which should be of the form C<extension:parameters> (Compile perl).
733 1660
734=end table 1661=end table
735 1662
736=back 1663=back
737 1664
789 1716
790=item B<< [title:+I<string>] >> 1717=item B<< [title:+I<string>] >>
791 1718
792set the current menuBar's title to I<string>, which may contain the 1719set the current menuBar's title to I<string>, which may contain the
793following format specifiers: 1720following format specifiers:
794B<%%> : literal B<%> character 1721
795B<%n> : rxvt name (as per the B<-name> command-line option) 1722 B<%n> rxvt name (as per the B<-name> command-line option)
796B<%v> : rxvt version 1723 B<%v> rxvt version
1724 B<%%> literal B<%> character
797 1725
798=item B<[done]> 1726=item B<[done]>
799 1727
800set menuBar access as B<readonly>. 1728set menuBar access as B<readonly>.
801End-of-file tag for B<< [read:+I<file>] >> operations. 1729End-of-file tag for B<< [read:+I<file>] >> operations.
947 1875
948As a convenience for the many Emacs-type editors, I<action> may start 1876As a convenience for the many Emacs-type editors, I<action> may start
949with B<M-> (eg, B<M-$> is equivalent to B<\E$>) and a B<CR> will be 1877with B<M-> (eg, B<M-$> is equivalent to B<\E$>) and a B<CR> will be
950appended if missed from B<M-x> commands. 1878appended if missed from B<M-x> commands.
951 1879
952As a convenience for issuing XTerm B<ESC]> sequences from a menubar (or 1880As a convenience for issuing XTerm B<ESC ]> sequences from a menubar (or
953quick arrow), a B<BEL> (B<^G>) will be appended if needed. 1881quick arrow), a B<BEL> (B<^G>) will be appended if needed.
954 1882
955=over 4 1883=over 4
956 1884
957=item For example, 1885=item For example,
1390 XK_KP_8 8 ESC O x 2318 XK_KP_8 8 ESC O x
1391 XK_KP_9 9 ESC O y 2319 XK_KP_9 9 ESC O y
1392 2320
1393=end table 2321=end table
1394 2322
2323=head1 CONFIGURE OPTIONS
2324
2325General hint: if you get compile errors, then likely your configuration
2326hasn't been tested well. Either try with C<--enable-everything> or use
2327the F<./reconf> script as a base for experiments. F<./reconf> is used by
2328myself, so it should generally be a working config. Of course, you should
2329always report when a combination doesn't work, so it can be fixed. Marc
2330Lehmann <rxvt@schmorp.de>.
2331
2332All
2333
2334=over 4
2335
2336=item --enable-everything
2337
2338Add (or remove) support for all non-multichoice options listed in "./configure
2339--help".
2340
2341You can specify this and then disable options you do not like by
2342I<following> this with the appropriate C<--disable-...> arguments,
2343or you can start with a minimal configuration by specifying
2344C<--disable-everything> and than adding just the C<--enable-...> arguments
2345you want.
2346
2347=item --enable-xft (default: enabled)
2348
2349Add support for Xft (anti-aliases, among others) fonts. Xft fonts are
2350slower and require lots of memory, but as long as you don't use them, you
2351don't pay for them.
2352
2353=item --enable-font-styles (default: on)
2354
2355Add support for B<bold>, I<italic> and B<< I<bold italic> >> font
2356styles. The fonts can be set manually or automatically.
2357
2358=item --with-codesets=NAME,... (default: all)
2359
2360Compile in support for additional codeset (encoding) groups (C<eu>, C<vn>
2361are always compiled in, which includes most 8-bit character sets). These
2362codeset tables are used for driving X11 core fonts, they are not required
2363for Xft fonts, although having them compiled in lets rxvt-unicode choose
2364replacement fonts more intelligently. Compiling them in will make your
2365binary bigger (all of together cost about 700kB), but it doesn't increase
2366memory usage unless you use a font requiring one of these encodings.
2367
2368=begin table
2369
2370 all all available codeset groups
2371 zh common chinese encodings
2372 zh_ext rarely used but very big chinese encodigs
2373 jp common japanese encodings
2374 jp_ext rarely used but big japanese encodings
2375 kr korean encodings
2376
2377=end table
2378
2379=item --enable-xim (default: on)
2380
2381Add support for XIM (X Input Method) protocol. This allows using
2382alternative input methods (e.g. kinput2) and will also correctly
2383set up the input for people using dead keys or compose keys.
2384
2385=item --enable-unicode3 (default: off)
2386
2387Enable direct support for displaying unicode codepoints above
238865535 (the basic multilingual page). This increases storage
2389requirements per character from 2 to 4 bytes. X11 fonts do not yet
2390support these extra characters, but Xft does.
2391
2392Please note that rxvt-unicode can store unicode code points >65535
2393even without this flag, but the number of such characters is
2394limited to a view thousand (shared with combining characters,
2395see next switch), and right now rxvt-unicode cannot display them
2396(input/output and cut&paste still work, though).
2397
2398=item --enable-combining (default: on)
2399
2400Enable automatic composition of combining characters into
2401composite characters. This is required for proper viewing of text
2402where accents are encoded as seperate unicode characters. This is
2403done by using precomposited characters when available or creating
2404new pseudo-characters when no precomposed form exists.
2405
2406Without --enable-unicode3, the number of additional precomposed characters
2407is rather limited (2048, if this is full, rxvt-unicode will use the
2408private use area, extending the number of combinations to 8448). With
2409--enable-unicode3, no practical limit exists.
2410
2411This option will also enable storage (but not display) of characters
2412beyond plane 0 (>65535) when --enable-unicode3 was not specified.
2413
2414The combining table also contains entries for arabic presentation forms,
2415but these are not currently used. Bug me if you want these to be used (and
2416tell me how these are to be used...).
2417
2418=item --enable-fallback(=CLASS) (default: Rxvt)
2419
2420When reading resource settings, also read settings for class CLASS. To disable resource fallback use --disable-fallback.
2421
2422=item --with-res-name=NAME (default: urxvt)
2423
2424Use the given name as default application name when
2425reading resources. Specify --with-res-name=rxvt to replace rxvt.
2426
2427=item --with-res-class=CLASS /default: URxvt)
2428
2429Use the given class as default application class
2430when reading resources. Specify --with-res-class=Rxvt to replace
2431rxvt.
2432
2433=item --enable-utmp (default: on)
2434
2435Write user and tty to utmp file (used by programs like F<w>) at
2436start of rxvt execution and delete information when rxvt exits.
2437
2438=item --enable-wtmp (default: on)
2439
2440Write user and tty to wtmp file (used by programs like F<last>) at
2441start of rxvt execution and write logout when rxvt exits. This
2442option requires --enable-utmp to also be specified.
2443
2444=item --enable-lastlog (default: on)
2445
2446Write user and tty to lastlog file (used by programs like
2447F<lastlogin>) at start of rxvt execution. This option requires
2448--enable-utmp to also be specified.
2449
2450=item --enable-xpm-background (default: on)
2451
2452Add support for XPM background pixmaps.
2453
2454=item --enable-transparency (default: on)
2455
2456Add support for inheriting parent backgrounds thus giving a fake
2457transparency to the term.
2458
2459=item --enable-fading (default: on)
2460
2461Add support for fading the text when focus is lost (requires C<--enable-transparency>).
2462
2463=item --enable-tinting (default: on)
2464
2465Add support for tinting of transparent backgrounds (requires C<--enable-transparency>).
2466
2467=item --enable-menubar (default: off) [DEPRECATED]
2468
2469Add support for our menu bar system (this interacts badly with dynamic
2470locale switching currently). This option is DEPRECATED and will be removed
2471in the future.
2472
2473=item --enable-rxvt-scroll (default: on)
2474
2475Add support for the original rxvt scrollbar.
2476
2477=item --enable-next-scroll (default: on)
2478
2479Add support for a NeXT-like scrollbar.
2480
2481=item --enable-xterm-scroll (default: on)
2482
2483Add support for an Xterm-like scrollbar.
2484
2485=item --enable-plain-scroll (default: on)
2486
2487Add support for a very unobtrusive, plain-looking scrollbar that
2488is the favourite of the rxvt-unicode author, having used it for
2489many years.
2490
2491=item --enable-half-shadow (default: off)
2492
2493Make shadows on the scrollbar only half the normal width & height.
2494only applicable to rxvt scrollbars.
2495
2496=item --enable-ttygid (default: off)
2497
2498Change tty device setting to group "tty" - only use this if
2499your system uses this type of security.
2500
2501=item --disable-backspace-key
2502
2503Removes any handling of the backspace key by us - let the X server do it.
2504
2505=item --disable-delete-key
2506
2507Removes any handling of the delete key by us - let the X server
2508do it.
2509
2510=item --disable-resources
2511
2512Removes any support for resource checking.
2513
2514=item --enable-xgetdefault
2515
2516Make resources checking via XGetDefault() instead of our small
2517version which only checks ~/.Xdefaults, or if that doesn't exist then
2518~/.Xresources.
2519
2520Please note that nowadays, things like XIM will automatically pull in and
2521use the full X resource manager, so the overhead of using it might be very
2522small, if nonexistant.
2523
2524=item --enable-strings (default: off)
2525
2526Add support for our possibly faster memset() function and other
2527various routines, overriding your system's versions which may
2528have been hand-crafted in assembly or may require extra libraries
2529to link in. (this breaks ANSI-C rules and has problems on many
2530GNU/Linux systems).
2531
2532=item --disable-swapscreen
2533
2534Remove support for secondary/swap screen.
2535
2536=item --enable-frills (default: on)
2537
2538Add support for many small features that are not essential but nice to
2539have. Normally you want this, but for very small binaries you may want to
2540disable this.
2541
2542A non-exhaustive list of features enabled by C<--enable-frills> (possibly
2543in combination with other switches) is:
2544
2545 MWM-hints
2546 EWMH-hints (pid, utf8 names) and protocols (ping)
2547 seperate underline colour (-underlineColor)
2548 settable border widths and borderless switch (-w, -b, -bl)
2549 settable extra linespacing /-lsp)
2550 iso-14755-2 and -3, and visual feedback
2551 backindex and forwardindex escape sequence
2552 window op and some xterm/OSC escape sequences
2553 tripleclickwords (-tcw)
2554 settable insecure mode (-insecure)
2555 keysym remapping support
2556 cursor blinking and underline cursor (-cb, -uc)
2557 XEmbed support (-embed)
2558 user-pty (-pty-fd)
2559 hold on exit (-hold)
2560 skip builtin block graphics (-sbg)
2561 sgr modes 90..97 and 100..107
2562
2563=item --enable-iso14755 (default: on)
2564
2565Enable extended ISO 14755 support (see @@RXVT_NAME@@(1), or
2566F<doc/rxvt.1.txt>). Basic support (section 5.1) is enabled by
2567C<--enable-frills>, while support for 5.2, 5.3 and 5.4 is enabled with
2568this switch.
2569
2570=item --enable-keepscrolling (default: on)
2571
2572Add support for continual scrolling of the display when you hold
2573the mouse button down on a scrollbar arrow.
2574
2575=item --enable-mousewheel (default: on)
2576
2577Add support for scrolling via mouse wheel or buttons 4 & 5.
2578
2579=item --enable-slipwheeling (default: on)
2580
2581Add support for continual scrolling (using the mouse wheel as an
2582accelerator) while the control key is held down. This option
2583requires --enable-mousewheel to also be specified.
2584
2585=item --disable-new-selection
2586
2587Remove support for mouse selection style like that of xterm.
2588
2589=item --enable-dmalloc (default: off)
2590
2591Use Gray Watson's malloc - which is good for debugging See
2592http://www.letters.com/dmalloc/ for details If you use either this or the
2593next option, you may need to edit src/Makefile after compiling to point
2594DINCLUDE and DLIB to the right places.
2595
2596You can only use either this option and the following (should
2597you use either) .
2598
2599=item --enable-dlmalloc (default: off)
2600
2601Use Doug Lea's malloc - which is good for a production version
2602See L<http://g.oswego.edu/dl/html/malloc.html> for details.
2603
2604=item --enable-smart-resize (default: on)
2605
2606Add smart growth/shrink behaviour when changing font size via hot
2607keys. This should keep the window corner which is closest to a corner of
2608the screen in a fixed position.
2609
2610=item --enable-pointer-blank (default: on)
2611
2612Add support to have the pointer disappear when typing or inactive.
2613
2614=item --enable-perl (default: off)
2615
2616Enable an embedded perl interpreter. See the B<@@RXVT_NAME@@perl(3)>
2617manpage (F<doc/rxvtperl.txt>) for more info on this feature, or the files
2618in F<src/perl-ext/> for the extensions that are installed by default. The
2619perl interpreter that is used can be specified via the C<PERL> environment
2620variable when running configure.
2621
2622=item --with-name=NAME (default: urxvt)
2623
2624Set the basename for the installed binaries, resulting
2625in C<urxvt>, C<urxvtd> etc.). Specify C<--with-name=rxvt> to replace with
2626C<rxvt>.
2627
2628=item --with-term=NAME (default: rxvt-unicode)
2629
2630Change the environmental variable for the terminal to NAME.
2631
2632=item --with-terminfo=PATH
2633
2634Change the environmental variable for the path to the terminfo tree to
2635PATH.
2636
2637=item --with-x
2638
2639Use the X Window System (pretty much default, eh?).
2640
2641=item --with-xpm-includes=DIR
2642
2643Look for the XPM includes in DIR.
2644
2645=item --with-xpm-library=DIR
2646
2647Look for the XPM library in DIR.
2648
2649=item --with-xpm
2650
2651Not needed - define via --enable-xpm-background.
2652
2653=back
2654
1395=head1 AUTHORS 2655=head1 AUTHORS
1396 2656
1397Marc Lehmann <rxvt@schmorp.de> converted this document to pod and 2657Marc Lehmann <rxvt@schmorp.de> converted this document to pod and
1398reworked it from the original Rxvt documentation, which was done by Geoff 2658reworked it from the original Rxvt documentation, which was done by Geoff
1399Wing <gcw@pobox.com>, who in turn used the XTerm documentation and other 2659Wing <gcw@pobox.com>, who in turn used the XTerm documentation and other

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines