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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines