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

Comparing rxvt-unicode/doc/rxvt.7.pod (file contents):
Revision 1.1 by root, Thu Aug 12 20:42:12 2004 UTC vs.
Revision 1.65 by root, Sat Dec 31 17:16:17 2005 UTC

1=head1 Rxvt Technical Reference 1=head1 NAME
2 2
3Marc Lehmann <rxvt@schmorp.de>, converted to pod and reworked from the 3RXVT REFERENCE - FAQ, command sequences and other background information
4original Rxvt documentation by Geoff Wing <gcw@pobox.com>, who in turn used 4
5the XTerm documentation and other sources. 5=head1 SYNOPSIS
6
7 # set a new font set
8 printf '\33]50;%s\007' 9x15,xft:Kochi" Mincho"
9
10 # change the locale and tell rxvt-unicode about it
11 export LC_CTYPE=ja_JP.EUC-JP; printf "\33]701;$LC_CTYPE\007"
12
13 # set window title
14 printf '\33]2;%s\007' "new window title"
15
16=head1 DESCRIPTION
17
18This document contains the FAQ, the RXVT TECHNICAL REFERENCE documenting
19all escape sequences, and other background information.
20
21The newest version of this document is
22also available on the World Wide Web at
23L<http://cvs.schmorp.de/browse/*checkout*/rxvt-unicode/doc/rxvt.7.html>.
24
25=head1 FREQUENTLY ASKED QUESTIONS
26
27=over 4
28
29=item 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 aminute 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 When I log-in to another system it tells me about missing terminfo data?
138
139The terminal description used by rxvt-unicode is not as widely available
140as that for xterm, or even rxvt (for which the same problem often arises).
141
142The correct solution for this problem is to install the terminfo, this can
143be done like this (with ncurses' infocmp):
144
145 REMOTE=remotesystem.domain
146 infocmp rxvt-unicode | ssh $REMOTE "cat >/tmp/ti && tic /tmp/ti"
147
148... or by installing rxvt-unicode normally on the remote system,
149
150If you cannot or do not want to do this, then you can simply set
151C<TERM=rxvt> or even C<TERM=xterm>, and live with the small number of
152problems arising, which includes wrong keymapping, less and different
153colours and some refresh errors in fullscreen applications. It's a nice
154quick-and-dirty workaround for rare cases, though.
155
156If you always want to do this (and are fine with the consequences) you
157can either recompile rxvt-unicode with the desired TERM value or use a
158resource to set it:
159
160 URxvt.termName: rxvt
161
162If you don't plan to use B<rxvt> (quite common...) you could also replace
163the rxvt terminfo file with the rxvt-unicode one.
164
165=item C<tic> outputs some error when compiling the terminfo entry.
166
167Most likely it's the empty definition for C<enacs=>. Just replace it by
168C<enacs=\E[0@> and try again.
169
170=item C<bash>'s readline does not work correctly under @@RXVT_NAME@@.
171
172=item I need a termcap file entry.
173
174One reason you might want this is that some distributions or operating
175systems still compile some programs using the long-obsoleted termcap
176library (Fedora Core's bash is one example) and rely on a termcap entry
177for C<rxvt-unicode>.
178
179You could use rxvt's termcap entry with resonable results in many cases.
180You can also create a termcap entry by using terminfo's infocmp program
181like this:
182
183 infocmp -C rxvt-unicode
184
185Or you could use this termcap entry, generated by the command above:
186
187 rxvt-unicode|rxvt-unicode terminal (X Window System):\
188 :am:bw:eo:km:mi:ms:xn:xo:\
189 :co#80:it#8:li#24:lm#0:\
190 :AL=\E[%dL:DC=\E[%dP:DL=\E[%dM:DO=\E[%dB:IC=\E[%d@:\
191 :K1=\EOw:K2=\EOu:K3=\EOy:K4=\EOq:K5=\EOs:LE=\E[%dD:\
192 :RI=\E[%dC:SF=\E[%dS:SR=\E[%dT:UP=\E[%dA:ae=\E(B:al=\E[L:\
193 :as=\E(0:bl=^G:cd=\E[J:ce=\E[K:cl=\E[H\E[2J:\
194 :cm=\E[%i%d;%dH:cr=^M:cs=\E[%i%d;%dr:ct=\E[3g:dc=\E[P:\
195 :dl=\E[M:do=^J:ec=\E[%dX:ei=\E[4l:ho=\E[H:\
196 :i1=\E[?47l\E=\E[?1l:ic=\E[@:im=\E[4h:\
197 :is=\E[r\E[m\E[2J\E[H\E[?7h\E[?1;3;4;6l\E[4l:\
198 :k1=\E[11~:k2=\E[12~:k3=\E[13~:k4=\E[14~:k5=\E[15~:\
199 :k6=\E[17~:k7=\E[18~:k8=\E[19~:k9=\E[20~:kD=\E[3~:\
200 :kI=\E[2~:kN=\E[6~:kP=\E[5~:kb=\177:kd=\EOB:ke=\E[?1l\E>:\
201 :kh=\E[7~:kl=\EOD:kr=\EOC:ks=\E[?1h\E=:ku=\EOA:le=^H:\
202 :mb=\E[5m:md=\E[1m:me=\E[m\017:mr=\E[7m:nd=\E[C:rc=\E8:\
203 :sc=\E7:se=\E[27m:sf=^J:so=\E[7m:sr=\EM:st=\EH:ta=^I:\
204 :te=\E[r\E[?1049l:ti=\E[?1049h:ue=\E[24m:up=\E[A:\
205 :us=\E[4m:vb=\E[?5h\E[?5l:ve=\E[?25h:vi=\E[?25l:\
206 :vs=\E[?25h:
207
208=item Why does C<ls> no longer have coloured output?
209
210The C<ls> in the GNU coreutils unfortunately doesn't use terminfo to
211decide wether a terminal has colour, but uses it's own configuration
212file. Needless to say, C<rxvt-unicode> is not in it's default file (among
213with most other terminals supporting colour). Either add:
214
215 TERM rxvt-unicode
216
217to C</etc/DIR_COLORS> or simply add:
218
219 alias ls='ls --color=auto'
220
221to your C<.profile> or C<.bashrc>.
222
223=item Why doesn't vim/emacs etc. use the 88 colour mode?
224
225=item Why doesn't vim/emacs etc. make use of italic?
226
227=item Why are the secondary screen-related options not working properly?
228
229Make sure you are using C<TERM=rxvt-unicode>. Some pre-packaged
230distributions (most notably Debian GNU/Linux) break rxvt-unicode
231by setting C<TERM> to C<rxvt>, which doesn't have these extra
232features. Unfortunately, some of these (most notably, again, Debian
233GNU/Linux) furthermore fail to even install the C<rxvt-unicode> terminfo
234file, so you will need to install it on your own (See the question B<When
235I log-in to another system it tells me about missing terminfo data?> on
236how to do this).
237
238=item My numerical keypad acts weird and generates differing output?
239
240Some Debian GNUL/Linux users seem to have this problem, although no
241specific details were reported so far. It is possible that this is caused
242by the wrong C<TERM> setting, although the details of wether and how
243this can happen are unknown, as C<TERM=rxvt> should offer a compatible
244keymap. See the answer to the previous question, and please report if that
245helped.
246
247=item Rxvt-unicode does not seem to understand the selected encoding?
248
249=item Unicode does not seem to work?
250
251If you encounter strange problems like typing an accented character but
252getting two unrelated other characters or similar, or if program output is
253subtly garbled, then you should check your locale settings.
254
255Rxvt-unicode must be started with the same C<LC_CTYPE> setting as the
256programs. Often rxvt-unicode is started in the C<C> locale, while the
257login script running within the rxvt-unicode window changes the locale to
258something else, e.g. C<en_GB.UTF-8>. Needless to say, this is not going to work.
259
260The best thing is to fix your startup environment, as you will likely run
261into other problems. If nothing works you can try this in your .profile.
262
263 printf '\e]701;%s\007' "$LC_CTYPE"
264
265If this doesn't work, then maybe you use a C<LC_CTYPE> specification not
266supported on your systems. Some systems have a C<locale> command which
267displays this (also, C<perl -e0> can be used to check locale settings, as
268it will complain loudly if it cannot set the locale). If it displays something
269like:
270
271 locale: Cannot set LC_CTYPE to default locale: ...
272
273Then the locale you specified is not supported on your system.
274
275If nothing works and you are sure that everything is set correctly then
276you will need to remember a little known fact: Some programs just don't
277support locales :(
278
279=item Why do some characters look so much different than others?
280
281=item How does rxvt-unicode choose fonts?
282
283Most fonts do not contain the full range of Unicode, which is
284fine. Chances are that the font you (or the admin/package maintainer of
285your system/os) have specified does not cover all the characters you want
286to display.
287
288B<rxvt-unicode> makes a best-effort try at finding a replacement
289font. Often the result is fine, but sometimes the chosen font looks
290bad/ugly/wrong. Some fonts have totally strange characters that don't
291resemble the correct glyph at all, and rxvt-unicode lacks the artificial
292intelligence to detect that a specific glyph is wrong: it has to believe
293the font that the characters it claims to contain indeed look correct.
294
295In that case, select a font of your taste and add it to the font list,
296e.g.:
297
298 @@RXVT_NAME@@ -fn basefont,font2,font3...
299
300When rxvt-unicode sees a character, it will first look at the base
301font. If the base font does not contain the character, it will go to the
302next font, and so on. Specifying your own fonts will also speed up this
303search and use less resources within rxvt-unicode and the X-server.
304
305The only limitation is that none of the fonts may be larger than the base
306font, as the base font defines the terminal character cell size, which
307must be the same due to the way terminals work.
308
309=item Why do some chinese characters look so different than others?
310
311This is because there is a difference between script and language --
312rxvt-unicode does not know which language the text that is output is,
313as it only knows the unicode character codes. If rxvt-unicode first
314sees a japanese/chinese character, it might choose a japanese font for
315display. Subsequent japanese characters will use that font. Now, many
316chinese characters aren't represented in japanese fonts, so when the first
317non-japanese character comes up, rxvt-unicode will look for a chinese font
318-- unfortunately at this point, it will still use the japanese font for
319chinese characters that are also in the japanese font.
320
321The workaround is easy: just tag a chinese font at the end of your font
322list (see the previous question). The key is to view the font list as
323a preference list: If you expect more japanese, list a japanese font
324first. If you expect more chinese, put a chinese font first.
325
326In the future it might be possible to switch language preferences at
327runtime (the internal data structure has no problem with using different
328fonts for the same character at the same time, but no interface for this
329has been designed yet).
330
331Until then, you might get away with switching fonts at runtime (see L<Can
332I switch the fonts at runtime?> later in this document).
333
334=item Why does rxvt-unicode sometimes leave pixel droppings?
335
336Most fonts were not designed for terminal use, which means that character
337size varies a lot. A font that is otherwise fine for terminal use might
338contain some characters that are simply too wide. Rxvt-unicode will avoid
339these characters. For characters that are just "a bit" too wide a special
340"careful" rendering mode is used that redraws adjacent characters.
341
342All of this requires that fonts do not lie about character sizes,
343however: Xft fonts often draw glyphs larger than their acclaimed bounding
344box, and rxvt-unicode has no way of detecting this (the correct way is to
345ask for the character bounding box, which unfortunately is wrong in these
346cases).
347
348It's not clear (to me at least), wether this is a bug in Xft, freetype,
349or the respective font. If you encounter this problem you might try using
350the C<-lsp> option to give the font more height. If that doesn't work, you
351might be forced to use a different font.
352
353All of this is not a problem when using X11 core fonts, as their bounding
354box data is correct.
355
356=item On Solaris 9, many line-drawing characters are too wide.
357
358Seems to be a known bug, read
359L<http://nixdoc.net/files/forum/about34198.html>. Some people use the
360following ugly workaround to get non-double-wide-characters working:
361
362 #define wcwidth(x) wcwidth(x) > 1 ? 1 : wcwidth(x)
363
364=item My Compose (Multi_key) key is no longer working.
365
366The most common causes for this are that either your locale is not set
367correctly, or you specified a B<preeditStyle> that is not supported by
368your input method. For example, if you specified B<OverTheSpot> and
369your input method (e.g. the default input method handling Compose keys)
370does not support this (for instance because it is not visual), then
371rxvt-unicode will continue without an input method.
372
373In this case either do not specify a B<preeditStyle> or specify more than
374one pre-edit style, such as B<OverTheSpot,Root,None>.
375
376=item I cannot type C<Ctrl-Shift-2> to get an ASCII NUL character due to ISO 14755
377
378Either try C<Ctrl-2> alone (it often is mapped to ASCII NUL even on
379international keyboards) or simply use ISO 14755 support to your
380advantage, typing <Ctrl-Shift-0> to get a ASCII NUL. This works for other
381codes, too, such as C<Ctrl-Shift-1-d> to type the default telnet escape
382character and so on.
383
384=item How can I keep rxvt-unicode from using reverse video so much?
385
386First of all, make sure you are running with the right terminal settings
387(C<TERM=rxvt-unicode>), which will get rid of most of these effects. Then
388make sure you have specified colours for italic and bold, as otherwise
389rxvt-unicode might use reverse video to simulate the effect:
390
391 URxvt.colorBD: white
392 URxvt.colorIT: green
393
394=item Some programs assume totally weird colours (red instead of blue), how can I fix that?
395
396For some unexplainable reason, some rare programs assume a very weird
397colour palette when confronted with a terminal with more than the standard
3988 colours (rxvt-unicode supports 88). The right fix is, of course, to fix
399these programs not to assume non-ISO colours without very good reasons.
400
401In the meantime, you can either edit your C<rxvt-unicode> terminfo
402definition to only claim 8 colour support or use C<TERM=rxvt>, which will
403fix colours but keep you from using other rxvt-unicode features.
404
405=item I am on FreeBSD and rxvt-unicode does not seem to work at all.
406
407Rxvt-unicode requires the symbol C<__STDC_ISO_10646__> to be defined
408in your compile environment, or an implementation that implements it,
409wether it defines the symbol or not. C<__STDC_ISO_10646__> requires that
410B<wchar_t> is represented as unicode.
411
412As you might have guessed, FreeBSD does neither define this symobl nor
413does it support it. Instead, it uses it's own internal representation of
414B<wchar_t>. This is, of course, completely fine with respect to standards.
415
416However, that means rxvt-unicode only works in C<POSIX>, C<ISO-8859-1> and
417C<UTF-8> locales under FreeBSD (which all use Unicode as B<wchar_t>.
418
419C<__STDC_ISO_10646__> is the only sane way to support multi-language
420apps in an OS, as using a locale-dependent (and non-standardized)
421representation of B<wchar_t> makes it impossible to convert between
422B<wchar_t> (as used by X11 and your applications) and any other encoding
423without implementing OS-specific-wrappers for each and every locale. There
424simply are no APIs to convert B<wchar_t> into anything except the current
425locale encoding.
426
427Some applications (such as the formidable B<mlterm>) work around this
428by carrying their own replacement functions for character set handling
429with them, and either implementing OS-dependent hacks or doing multiple
430conversions (which is slow and unreliable in case the OS implements
431encodings slightly different than the terminal emulator).
432
433The rxvt-unicode author insists that the right way to fix this is in the
434system libraries once and for all, instead of forcing every app to carry
435complete replacements for them :)
436
437=item I use Solaris 9 and it doesn't compile/work/etc.
438
439Try the diff in F<doc/solaris9.patch> as a base. It fixes the worst
440problems with C<wcwidth> and a compile problem.
441
442=item How can I use rxvt-unicode under cygwin?
443
444rxvt-unicode should compile and run out of the box on cygwin, using
445the X11 libraries that come with cygwin. libW11 emulation is no
446longer supported (and makes no sense, either, as it only supported a
447single font). I recommend starting the X-server in C<-multiwindow> or
448C<-rootless> mode instead, which will result in similar look&feel as the
449old libW11 emulation.
450
451At the time of this writing, cygwin didn't seem to support any multi-byte
452encodings (you might try C<LC_CTYPE=C-UTF-8>), so you are likely limited
453to 8-bit encodings.
454
455=item How does rxvt-unicode determine the encoding to use?
456
457=item Is there an option to switch encodings?
458
459Unlike some other terminals, rxvt-unicode has no encoding switch, and no
460specific "utf-8" mode, such as xterm. In fact, it doesn't even know about
461UTF-8 or any other encodings with respect to terminal I/O.
462
463The reasons is that there exists a perfectly fine mechanism for selecting
464the encoding, doing I/O and (most important) communicating this to all
465applications so everybody agrees on character properties such as width
466and code number. This mechanism is the I<locale>. Applications not using
467that info will have problems (for example, C<xterm> gets the width of
468characters wrong as it uses it's own, locale-independent table under all
469locales).
470
471Rxvt-unicode uses the C<LC_CTYPE> locale category to select encoding. All
472programs doing the same (that is, most) will automatically agree in the
473interpretation of characters.
474
475Unfortunately, there is no system-independent way to select locales, nor
476is there a standard on how locale specifiers will look like.
477
478On most systems, the content of the C<LC_CTYPE> environment variable
479contains an arbitrary string which corresponds to an already-installed
480locale. Common names for locales are C<en_US.UTF-8>, C<de_DE.ISO-8859-15>,
481C<ja_JP.EUC-JP>, i.e. C<language_country.encoding>, but other forms
482(i.e. C<de> or C<german>) are also common.
483
484Rxvt-unicode ignores all other locale categories, and except for
485the encoding, ignores country or language-specific settings,
486i.e. C<de_DE.UTF-8> and C<ja_JP.UTF-8> are the normally same to
487rxvt-unicode.
488
489If you want to use a specific encoding you have to make sure you start
490rxvt-unicode with the correct C<LC_CTYPE> category.
491
492=item Can I switch locales at runtime?
493
494Yes, using an escape sequence. Try something like this, which sets
495rxvt-unicode's idea of C<LC_CTYPE>.
496
497 printf '\e]701;%s\007' ja_JP.SJIS
498
499See also the previous answer.
500
501Sometimes this capability is rather handy when you want to work in
502one locale (e.g. C<de_DE.UTF-8>) but some programs don't support it
503(e.g. UTF-8). For example, I use this script to start C<xjdic>, which
504first switches to a locale supported by xjdic and back later:
505
506 printf '\e]701;%s\007' ja_JP.SJIS
507 xjdic -js
508 printf '\e]701;%s\007' de_DE.UTF-8
509
510You can also use xterm's C<luit> program, which usually works fine, except
511for some locales where character width differs between program- and
512rxvt-unicode-locales.
513
514=item Can I switch the fonts at runtime?
515
516Yes, using an escape sequence. Try something like this, which has the same
517effect as using the C<-fn> switch, and takes effect immediately:
518
519 printf '\e]50;%s\007' "9x15bold,xft:Kochi Gothic"
520
521This is useful if you e.g. work primarily with japanese (and prefer a
522japanese font), but you have to switch to chinese temporarily, where
523japanese fonts would only be in your way.
524
525You can think of this as a kind of manual ISO-2022 switching.
526
527=item Why do italic characters look as if clipped?
528
529Many fonts have difficulties with italic characters and hinting. For
530example, the otherwise very nicely hinted font C<xft:Bitstream Vera Sans
531Mono> completely fails in it's italic face. A workaround might be to
532enable freetype autohinting, i.e. like this:
533
534 URxvt.italicFont: xft:Bitstream Vera Sans Mono:italic:autohint=true
535 URxvt.boldItalicFont: xft:Bitstream Vera Sans Mono:bold:italic:autohint=true
536
537=item My input method wants <some encoding> but I want UTF-8, what can I do?
538
539You can specify separate locales for the input method and the rest of the
540terminal, using the resource C<imlocale>:
541
542 URxvt*imlocale: ja_JP.EUC-JP
543
544Now you can start your terminal with C<LC_CTYPE=ja_JP.UTF-8> and still
545use your input method. Please note, however, that you will not be able to
546input characters outside C<EUC-JP> in a normal way then, as your input
547method limits you.
548
549=item Rxvt-unicode crashes when the X Input Method changes or exits.
550
551Unfortunately, this is unavoidable, as the XIM protocol is racy by
552design. Applications can avoid some crashes at the expense of memory
553leaks, and Input Methods can avoid some crashes by careful ordering at
554exit time. B<kinput2> (and derived input methods) generally succeeds,
555while B<SCIM> (or similar input methods) fails. In the end, however,
556crashes cannot be completely avoided even if both sides cooperate.
557
558So the only workaround is not to kill your Input Method Servers.
559
560=item Rxvt-unicode uses gobs of memory, how can I reduce that?
561
562Rxvt-unicode tries to obey the rule of not charging you for something you
563don't use. One thing you should try is to configure out all settings that
564you don't need, for example, Xft support is a resource hog by design,
565when used. Compiling it out ensures that no Xft font will be loaded
566accidentally when rxvt-unicode tries to find a font for your characters.
567
568Also, many people (me included) like large windows and even larger
569scrollback buffers: Without C<--enable-unicode3>, rxvt-unicode will use
5706 bytes per screen cell. For a 160x?? window this amounts to almost a
571kilobyte per line. A scrollback buffer of 10000 lines will then (if full)
572use 10 Megabytes of memory. With C<--enable-unicode3> it gets worse, as
573rxvt-unicode then uses 8 bytes per screen cell.
574
575=item Can I speed up Xft rendering somehow?
576
577Yes, the most obvious way to speed it up is to avoid Xft entirely, as
578it is simply slow. If you still want Xft fonts you might try to disable
579antialiasing (by appending C<:antialias=false>), which saves lots of
580memory and also speeds up rendering considerably.
581
582=item Rxvt-unicode doesn't seem to anti-alias its fonts, what is wrong?
583
584Rxvt-unicode will use whatever you specify as a font. If it needs to
585fall back to it's default font search list it will prefer X11 core
586fonts, because they are small and fast, and then use Xft fonts. It has
587antialiasing disabled for most of them, because the author thinks they
588look best that way.
589
590If you want antialiasing, you have to specify the fonts manually.
591
592=item Mouse cut/paste suddenly no longer works.
593
594Make sure that mouse reporting is actually turned off since killing
595some editors prematurely may leave the mouse in mouse report mode. I've
596heard that tcsh may use mouse reporting unless it otherwise specified. A
597quick check is to see if cut/paste works when the Alt or Shift keys are
598depressed. See @@RXVT_NAME@@(7)
599
600=item What's with this bold/blink stuff?
601
602If no bold colour is set via C<colorBD:>, bold will invert text using the
603standard foreground colour.
604
605For the standard background colour, blinking will actually make the
606text blink when compiled with C<--enable-blinking>. with standard
607colours. Without C<--enable-blinking>, the blink attribute will be
608ignored.
609
610On ANSI colours, bold/blink attributes are used to set high-intensity
611foreground/background colors.
612
613color0-7 are the low-intensity colors.
614
615color8-15 are the corresponding high-intensity colors.
616
617=item I don't like the screen colors. How do I change them?
618
619You can change the screen colors at run-time using F<~/.Xdefaults>
620resources (or as long-options).
621
622Here are values that are supposed to resemble a VGA screen,
623including the murky brown that passes for low-intensity yellow:
624
625 URxvt.color0: #000000
626 URxvt.color1: #A80000
627 URxvt.color2: #00A800
628 URxvt.color3: #A8A800
629 URxvt.color4: #0000A8
630 URxvt.color5: #A800A8
631 URxvt.color6: #00A8A8
632 URxvt.color7: #A8A8A8
633
634 URxvt.color8: #000054
635 URxvt.color9: #FF0054
636 URxvt.color10: #00FF54
637 URxvt.color11: #FFFF54
638 URxvt.color12: #0000FF
639 URxvt.color13: #FF00FF
640 URxvt.color14: #00FFFF
641 URxvt.color15: #FFFFFF
642
643And here is a more complete set of non-standard colors described (not by
644me) as "pretty girly".
645
646 URxvt.cursorColor: #dc74d1
647 URxvt.pointerColor: #dc74d1
648 URxvt.background: #0e0e0e
649 URxvt.foreground: #4ad5e1
650 URxvt.color0: #000000
651 URxvt.color8: #8b8f93
652 URxvt.color1: #dc74d1
653 URxvt.color9: #dc74d1
654 URxvt.color2: #0eb8c7
655 URxvt.color10: #0eb8c7
656 URxvt.color3: #dfe37e
657 URxvt.color11: #dfe37e
658 URxvt.color5: #9e88f0
659 URxvt.color13: #9e88f0
660 URxvt.color6: #73f7ff
661 URxvt.color14: #73f7ff
662 URxvt.color7: #e1dddd
663 URxvt.color15: #e1dddd
664
665=item How can I start @@RXVT_NAME@@d in a race-free way?
666
667Try C<@@RXVT_NAME@@d -f -o>, which tells @@RXVT_NAME@@d to open the
668display, create the listening socket and then fork.
669
670=item What's with the strange Backspace/Delete key behaviour?
671
672Assuming that the physical Backspace key corresponds to the
673BackSpace keysym (not likely for Linux ... see the following
674question) there are two standard values that can be used for
675Backspace: C<^H> and C<^?>.
676
677Historically, either value is correct, but rxvt-unicode adopts the debian
678policy of using C<^?> when unsure, because it's the one only only correct
679choice :).
680
681Rxvt-unicode tries to inherit the current stty settings and uses the value
682of `erase' to guess the value for backspace. If rxvt-unicode wasn't
683started from a terminal (say, from a menu or by remote shell), then the
684system value of `erase', which corresponds to CERASE in <termios.h>, will
685be used (which may not be the same as your stty setting).
686
687For starting a new rxvt-unicode:
688
689 # use Backspace = ^H
690 $ stty erase ^H
691 $ @@RXVT_NAME@@
692
693 # use Backspace = ^?
694 $ stty erase ^?
695 $ @@RXVT_NAME@@
696
697Toggle with C<ESC [ 36 h> / C<ESC [ 36 l> as documented in @@RXVT_NAME@@(7).
698
699For an existing rxvt-unicode:
700
701 # use Backspace = ^H
702 $ stty erase ^H
703 $ echo -n "^[[36h"
704
705 # use Backspace = ^?
706 $ stty erase ^?
707 $ echo -n "^[[36l"
708
709This helps satisfy some of the Backspace discrepancies that occur, but
710if you use Backspace = C<^H>, make sure that the termcap/terminfo value
711properly reflects that.
712
713The Delete key is a another casualty of the ill-defined Backspace problem.
714To avoid confusion between the Backspace and Delete keys, the Delete
715key has been assigned an escape sequence to match the vt100 for Execute
716(C<ESC [ 3 ~>) and is in the supplied termcap/terminfo.
717
718Some other Backspace problems:
719
720some editors use termcap/terminfo,
721some editors (vim I'm told) expect Backspace = ^H,
722GNU Emacs (and Emacs-like editors) use ^H for help.
723
724Perhaps someday this will all be resolved in a consistent manner.
725
726=item I don't like the key-bindings. How do I change them?
727
728There are some compile-time selections available via configure. Unless
729you have run "configure" with the C<--disable-resources> option you can
730use the `keysym' resource to alter the keystrings associated with keysyms.
731
732Here's an example for a URxvt session started using C<@@RXVT_NAME@@ -name URxvt>
733
734 URxvt.keysym.Home: \033[1~
735 URxvt.keysym.End: \033[4~
736 URxvt.keysym.C-apostrophe: \033<C-'>
737 URxvt.keysym.C-slash: \033<C-/>
738 URxvt.keysym.C-semicolon: \033<C-;>
739 URxvt.keysym.C-grave: \033<C-`>
740 URxvt.keysym.C-comma: \033<C-,>
741 URxvt.keysym.C-period: \033<C-.>
742 URxvt.keysym.C-0x60: \033<C-`>
743 URxvt.keysym.C-Tab: \033<C-Tab>
744 URxvt.keysym.C-Return: \033<C-Return>
745 URxvt.keysym.S-Return: \033<S-Return>
746 URxvt.keysym.S-space: \033<S-Space>
747 URxvt.keysym.M-Up: \033<M-Up>
748 URxvt.keysym.M-Down: \033<M-Down>
749 URxvt.keysym.M-Left: \033<M-Left>
750 URxvt.keysym.M-Right: \033<M-Right>
751 URxvt.keysym.M-C-0: list \033<M-C- 0123456789 >
752 URxvt.keysym.M-C-a: list \033<M-C- abcdefghijklmnopqrstuvwxyz >
753 URxvt.keysym.F12: command:\033]701;zh_CN.GBK\007
754
755See some more examples in the documentation for the B<keysym> resource.
756
757=item I'm using keyboard model XXX that has extra Prior/Next/Insert keys.
758How do I make use of them? For example, the Sun Keyboard type 4
759has the following mappings that rxvt-unicode doesn't recognize.
760
761 KP_Insert == Insert
762 F22 == Print
763 F27 == Home
764 F29 == Prior
765 F33 == End
766 F35 == Next
767
768Rather than have rxvt-unicode try to accommodate all the various possible
769keyboard mappings, it is better to use `xmodmap' to remap the keys as
770required for your particular machine.
771
772=item How do I distinguish wether I'm running rxvt-unicode or a regular xterm?
773I need this to decide about setting colors etc.
774
775rxvt and rxvt-unicode always export the variable "COLORTERM", so you can
776check and see if that is set. Note that several programs, JED, slrn,
777Midnight Commander automatically check this variable to decide whether or
778not to use color.
779
780=item How do I set the correct, full IP address for the DISPLAY variable?
781
782If you've compiled rxvt-unicode with DISPLAY_IS_IP and have enabled
783insecure mode then it is possible to use the following shell script
784snippets to correctly set the display. If your version of rxvt-unicode
785wasn't also compiled with ESCZ_ANSWER (as assumed in these snippets) then
786the COLORTERM variable can be used to distinguish rxvt-unicode from a
787regular xterm.
788
789Courtesy of Chuck Blake <cblake@BBN.COM> with the following shell script
790snippets:
791
792 # Bourne/Korn/POSIX family of shells:
793 [ ${TERM:-foo} = foo ] && TERM=xterm # assume an xterm if we don't know
794 if [ ${TERM:-foo} = xterm ]; then
795 stty -icanon -echo min 0 time 15 # see if enhanced rxvt or not
796 echo -n '^[Z'
797 read term_id
798 stty icanon echo
799 if [ ""${term_id} = '^[[?1;2C' -a ${DISPLAY:-foo} = foo ]; then
800 echo -n '^[[7n' # query the rxvt we are in for the DISPLAY string
801 read DISPLAY # set it in our local shell
802 fi
803 fi
804
805=item How do I compile the manual pages for myself?
806
807You need to have a recent version of perl installed as F</usr/bin/perl>,
808one that comes with F<pod2man>, F<pod2text> and F<pod2html>. Then go to
809the doc subdirectory and enter C<make alldoc>.
810
811=item My question isn't answered here, can I ask a human?
812
813Before sending me mail, you could go to IRC: C<irc.freenode.net>,
814channel C<#rxvt-unicode> has some rxvt-unicode enthusiasts that might be
815interested in learning about new and exciting problems (but not FAQs :).
816
817=back
818
819=head1 RXVT TECHNICAL REFERENCE
820
821=head1 DESCRIPTION
822
823The rest of this document describes various technical aspects of
824B<rxvt-unicode>. First the description of supported command sequences,
825followed by menu and pixmap support and last by a description of all
826features selectable at C<configure> time.
6 827
7=head1 Definitions 828=head1 Definitions
8 829
9=over 4 830=over 4
10 831
37=over 4 858=over 4
38 859
39=item B<< C<ENQ> >> 860=item B<< C<ENQ> >>
40 861
41Enquiry (Ctrl-E) = Send Device Attributes (DA) 862Enquiry (Ctrl-E) = Send Device Attributes (DA)
42request attributes from terminal == 863request attributes from terminal. See B<< C<ESC [ Ps c> >>.
43 864
44=item B<< C<BEL> >> 865=item B<< C<BEL> >>
45 866
46Bell (Ctrl-G) 867Bell (Ctrl-G)
47 868
139Single Shift Select of G3 Character Set (SS3): affects next character 960Single Shift Select of G3 Character Set (SS3): affects next character
140only I<unimplemented> 961only I<unimplemented>
141 962
142=item B<< C<ESC Z> >> 963=item B<< C<ESC Z> >>
143 964
144Obsolete form of returns: B<< C<ESC[?1;2C> >> I<rxvt compile-time option> 965Obsolete form of returns: B<< C<ESC [ ? 1 ; 2 C> >> I<rxvt-unicode compile-time option>
145 966
146=item B<< C<ESC c> >> 967=item B<< C<ESC c> >>
147 968
148Full reset (RIS) 969Full reset (RIS)
149 970
153 974
154=item B<< C<ESC o> >> 975=item B<< C<ESC o> >>
155 976
156Invoke the G3 Character Set (LS3) 977Invoke the G3 Character Set (LS3)
157 978
158=item B<< C<ESC>(C<C> >> 979=item B<< C<ESC ( C> >>
159 980
160Designate G0 Character Set (ISO 2022), see below for values of C<C>. 981Designate G0 Character Set (ISO 2022), see below for values of C<C>.
161 982
162=item B<< C<ESC>)C<C> >> 983=item B<< C<ESC ) C> >>
163 984
164Designate G1 Character Set (ISO 2022), see below for values of C<C>. 985Designate G1 Character Set (ISO 2022), see below for values of C<C>.
165 986
166=item B<< C<ESC * C> >> 987=item B<< C<ESC * C> >>
167 988
191 1012
192=back 1013=back
193 1014
194X<CSI> 1015X<CSI>
195 1016
196=head1 CSI (Code Sequence Introducer) Sequences 1017=head1 CSI (Command Sequence Introducer) Sequences
197 1018
198=over 4 1019=over 4
199 1020
200=item B<< C<ESC [ Ps @> >> 1021=item B<< C<ESC [ Ps @> >>
201 1022
298 1119
299Move backward B<< C<Ps> >> [default: 1] tab stops 1120Move backward B<< C<Ps> >> [default: 1] tab stops
300 1121
301=item B<< C<ESC [ Ps '> >> 1122=item B<< C<ESC [ Ps '> >>
302 1123
303== 1124See B<< C<ESC [ Ps G> >>
304 1125
305=item B<< C<ESC [ Ps a> >> 1126=item B<< C<ESC [ Ps a> >>
306 1127
307==X<ESCOBPsc> 1128See B<< C<ESC [ Ps C> >>
308 1129
309=item B<< C<ESC [ Ps c> >> 1130=item B<< C<ESC [ Ps c> >>
310 1131
311Send Device Attributes (DA) 1132Send Device Attributes (DA)
312B<< C<Ps = 0> >> (or omitted): request attributes from terminal 1133B<< C<Ps = 0> >> (or omitted): request attributes from terminal
313returns: B<< C<ESC[?1;2c> >> (``I am a VT100 with Advanced Video 1134returns: B<< C<ESC [ ? 1 ; 2 c> >> (``I am a VT100 with Advanced Video
314Option'') 1135Option'')
315 1136
316=item B<< C<ESC [ Ps d> >> 1137=item B<< C<ESC [ Ps d> >>
317 1138
318Cursor to Line B<< C<Ps> >> (VPA) 1139Cursor to Line B<< C<Ps> >> (VPA)
319 1140
320=item B<< C<ESC [ Ps e> >> 1141=item B<< C<ESC [ Ps e> >>
321 1142
322== 1143See B<< C<ESC [ Ps A> >>
323 1144
324=item B<< C<ESC [ Ps;Ps f> >> 1145=item B<< C<ESC [ Ps;Ps f> >>
325 1146
326Horizontal and Vertical Position [row;column] (HVP) [default: 1;1] 1147Horizontal and Vertical Position [row;column] (HVP) [default: 1;1]
327 1148
334 B<< C<Ps = 0> >> Clear Current Column (default) 1155 B<< C<Ps = 0> >> Clear Current Column (default)
335 B<< C<Ps = 3> >> Clear All (TBC) 1156 B<< C<Ps = 3> >> Clear All (TBC)
336 1157
337=end table 1158=end table
338 1159
1160=item B<< C<ESC [ Pm h> >>
1161
1162Set Mode (SM). See B<< C<ESC [ Pm l> >> sequence for description of C<Pm>.
1163
339=item B<< C<ESC [ Ps i> >> 1164=item B<< C<ESC [ Ps i> >>
340 1165
341Printing 1166Printing. See also the C<print-pipe> resource.
342 1167
343=begin table 1168=begin table
344 1169
1170 B<< C<Ps = 0> >> print screen (MC0)
345 B<< C<Ps = 4> >> disable transparent print mode (MC4) 1171 B<< C<Ps = 4> >> disable transparent print mode (MC4)
346 B<< C<Ps = 5> >> enable transparent print mode (MC5) I<unimplemented> 1172 B<< C<Ps = 5> >> enable transparent print mode (MC5)
347 1173
348=end table 1174=end table
349
350=item B<< C<ESC [ Pm h> >>
351
352Set Mode (SM). See next sequence for description of C<Pm>.
353 1175
354=item B<< C<ESC [ Pm l> >> 1176=item B<< C<ESC [ Pm l> >>
355 1177
356Reset Mode (RM) 1178Reset Mode (RM)
357 1179
364 B<< C<h> >> Insert Mode (SMIR) 1186 B<< C<h> >> Insert Mode (SMIR)
365 B<< C<l> >> Replace Mode (RMIR) 1187 B<< C<l> >> Replace Mode (RMIR)
366 1188
367=end table 1189=end table
368 1190
369=item B<< C<Ps = 20> >> I<unimplemented> 1191=item B<< C<Ps = 20> >> (partially implemented)
370 1192
371=begin table 1193=begin table
372 1194
373 B<< C<h> >> Automatic Newline (LNM) 1195 B<< C<h> >> Automatic Newline (LNM)
374 B<< C<h> >> Normal Linefeed (LNM) 1196 B<< C<l> >> Normal Linefeed (LNM)
375 1197
376=end table 1198=end table
377 1199
378=back 1200=back
379 1201
382Character Attributes (SGR) 1204Character Attributes (SGR)
383 1205
384=begin table 1206=begin table
385 1207
386 B<< C<Ps = 0> >> Normal (default) 1208 B<< C<Ps = 0> >> Normal (default)
387 B<< C<Ps = 1 / 22> >> On / Off Bold (bright fg) 1209 B<< C<Ps = 1 / 21> >> On / Off Bold (bright fg)
1210 B<< C<Ps = 3 / 23> >> On / Off Italic
388 B<< C<Ps = 4 / 24> >> On / Off Underline 1211 B<< C<Ps = 4 / 24> >> On / Off Underline
389 B<< C<Ps = 5 / 25> >> On / Off Blink (bright bg) 1212 B<< C<Ps = 5 / 25> >> On / Off Slow Blink (bright bg)
1213 B<< C<Ps = 6 / 26> >> On / Off Rapid Blink (bright bg)
390 B<< C<Ps = 7 / 27> >> On / Off Inverse 1214 B<< C<Ps = 7 / 27> >> On / Off Inverse
1215 B<< C<Ps = 8 / 27> >> On / Off Invisible (NYI)
391 B<< C<Ps = 30 / 40> >> fg/bg Black 1216 B<< C<Ps = 30 / 40> >> fg/bg Black
392 B<< C<Ps = 31 / 41> >> fg/bg Red 1217 B<< C<Ps = 31 / 41> >> fg/bg Red
393 B<< C<Ps = 32 / 42> >> fg/bg Green 1218 B<< C<Ps = 32 / 42> >> fg/bg Green
394 B<< C<Ps = 33 / 43> >> fg/bg Yellow 1219 B<< C<Ps = 33 / 43> >> fg/bg Yellow
395 B<< C<Ps = 34 / 44> >> fg/bg Blue 1220 B<< C<Ps = 34 / 44> >> fg/bg Blue
396 B<< C<Ps = 35 / 45> >> fg/bg Magenta 1221 B<< C<Ps = 35 / 45> >> fg/bg Magenta
397 B<< C<Ps = 36 / 46> >> fg/bg Cyan 1222 B<< C<Ps = 36 / 46> >> fg/bg Cyan
1223 B<< C<Ps = 38;5 / 48;5> >> set fg/bg to color #m (ISO 8613-6)
398 B<< C<Ps = 37 / 47> >> fg/bg White 1224 B<< C<Ps = 37 / 47> >> fg/bg White
399 B<< C<Ps = 39 / 49> >> fg/bg Default 1225 B<< C<Ps = 39 / 49> >> fg/bg Default
1226 B<< C<Ps = 90 / 100> >> fg/bg Bright Black
1227 B<< C<Ps = 91 / 101> >> fg/bg Bright Red
1228 B<< C<Ps = 92 / 102> >> fg/bg Bright Green
1229 B<< C<Ps = 93 / 103> >> fg/bg Bright Yellow
1230 B<< C<Ps = 94 / 104> >> fg/bg Bright Blue
1231 B<< C<Ps = 95 / 105> >> fg/bg Bright Magenta
1232 B<< C<Ps = 96 / 106> >> fg/bg Bright Cyan
1233 B<< C<Ps = 97 / 107> >> fg/bg Bright White
1234 B<< C<Ps = 99 / 109> >> fg/bg Bright Default
400 1235
401=end table 1236=end table
402 1237
403=item B<< C<ESC [ Ps n> >> 1238=item B<< C<ESC [ Ps n> >>
404 1239
420 1255
421=item B<< C<ESC [ s> >> 1256=item B<< C<ESC [ s> >>
422 1257
423Save Cursor (SC) 1258Save Cursor (SC)
424 1259
1260=item B<< C<ESC [ Ps;Pt t> >>
1261
1262Window Operations
1263
1264=begin table
1265
1266 B<< C<Ps = 1> >> Deiconify (map) window
1267 B<< C<Ps = 2> >> Iconify window
1268 B<< C<Ps = 3> >> B<< C<ESC [ 3 ; X ; Y t> >> Move window to (X|Y)
1269 B<< C<Ps = 4> >> B<< C<ESC [ 4 ; H ; W t> >> Resize to WxH pixels
1270 B<< C<Ps = 5> >> Raise window
1271 B<< C<Ps = 6> >> Lower window
1272 B<< C<Ps = 7> >> Refresh screen once
1273 B<< C<Ps = 8> >> B<< C<ESC [ 8 ; R ; C t> >> Resize to R rows and C columns
1274 B<< C<Ps = 11> >> Report window state (responds with C<Ps = 1> or C<Ps = 2>)
1275 B<< C<Ps = 13> >> Report window position (responds with C<Ps = 3>)
1276 B<< C<Ps = 14> >> Report window pixel size (responds with C<Ps = 4>)
1277 B<< C<Ps = 18> >> Report window text size (responds with C<Ps = 7>)
1278 B<< C<Ps = 19> >> Currently the same as C<Ps = 18>, but responds with C<Ps = 9>
1279 B<< C<Ps = 20> >> Reports icon label (B<< C<ESC ] L NAME \234> >>)
1280 B<< C<Ps = 21> >> Reports window title (B<< C<ESC ] l NAME \234> >>)
1281 B<< C<Ps = 24..> >> Set window height to C<Ps> rows
1282
1283=end table
1284
1285=item B<< C<ESC [ u> >>
1286
1287Restore Cursor
1288
425=item B<< C<ESC [ Ps x> >> 1289=item B<< C<ESC [ Ps x> >>
426 1290
427Request Terminal Parameters (DECREQTPARM) 1291Request Terminal Parameters (DECREQTPARM)
428
429=item B<< C<ESC [ u> >>
430
431Restore Cursor
432 1292
433=back 1293=back
434 1294
435X<PrivateModes> 1295X<PrivateModes>
436 1296
539 B<< C<h> >> Send Mouse X & Y on button press. 1399 B<< C<h> >> Send Mouse X & Y on button press.
540 B<< C<l> >> No mouse reporting. 1400 B<< C<l> >> No mouse reporting.
541 1401
542=end table 1402=end table
543 1403
544)X<Priv10>
545
546=item B<< C<Ps = 10> >> (B<rxvt>) 1404=item B<< C<Ps = 10> >> (B<rxvt>)
547 1405
548=begin table 1406=begin table
549 1407
550 B<< C<h> >> visible 1408 B<< C<h> >> menuBar visible
551 B<< C<l> >> invisible 1409 B<< C<l> >> menuBar invisible
552 1410
553=end table 1411=end table
554 1412
555=item B<< C<Ps = 25> >> 1413=item B<< C<Ps = 25> >>
556 1414
625 1483
626=item B<< C<Ps = 66> >> 1484=item B<< C<Ps = 66> >>
627 1485
628=begin table 1486=begin table
629 1487
630 B<< C<h> >> Application Keypad (DECPAM) == 1488 B<< C<h> >> Application Keypad (DECPAM) == C<ESC =>
631 B<< C<l> >> Normal Keypad (DECPNM) == 1489 B<< C<l> >> Normal Keypad (DECPNM) == C<< ESC > >>
632 1490
633=end table 1491=end table
634 1492
635=item B<< C<Ps = 67> >> 1493=item B<< C<Ps = 67> >>
636 1494
657 B<< C<h> >> Use Hilite Mouse Tracking. 1515 B<< C<h> >> Use Hilite Mouse Tracking.
658 B<< C<l> >> No mouse reporting. 1516 B<< C<l> >> No mouse reporting.
659 1517
660=end table 1518=end table
661 1519
662=item B<< C<Ps = 1010> >> 1520=item B<< C<Ps = 1010> >> (B<rxvt>)
663 1521
664=begin table 1522=begin table
665 1523
666 B<< C<h> >> Don't scroll to bottom on TTY output 1524 B<< C<h> >> Don't scroll to bottom on TTY output
667 B<< C<l> >> Scroll to bottom on TTY output 1525 B<< C<l> >> Scroll to bottom on TTY output
668 1526
669=end table 1527=end table
670 1528
671=item B<< C<Ps = 1011> >> 1529=item B<< C<Ps = 1011> >> (B<rxvt>)
672 1530
673=begin table 1531=begin table
674 1532
675 B<< C<h> >> Scroll to bottom when a key is pressed 1533 B<< C<h> >> Scroll to bottom when a key is pressed
676 B<< C<l> >> Don't scroll to bottom when a key is pressed 1534 B<< C<l> >> Don't scroll to bottom when a key is pressed
677 1535
678=end table 1536=end table
679 1537
1538=item B<< C<Ps = 1021> >> (B<rxvt>)
1539
1540=begin table
1541
1542 B<< C<h> >> Bold/italic implies high intensity (see option B<-is>)
1543 B<< C<l> >> Font styles have no effect on intensity.
1544
1545=end table
1546
680=item B<< C<Ps = 1047> >> 1547=item B<< C<Ps = 1047> >>
681 1548
682=begin table 1549=begin table
683 1550
684 B<< C<h> >> Use Alternate Screen Buffer 1551 B<< C<h> >> Use Alternate Screen Buffer
690 1557
691=begin table 1558=begin table
692 1559
693 B<< C<h> >> Save cursor position 1560 B<< C<h> >> Save cursor position
694 B<< C<l> >> Restore cursor position 1561 B<< C<l> >> Restore cursor position
1562
1563=end table
1564
1565=item B<< C<Ps = 1049> >>
1566
1567=begin table
1568
1569 B<< C<h> >> Use Alternate Screen Buffer - clear Alternate Screen Buffer if switching to it
1570 B<< C<l> >> Use Normal Screen Buffer
695 1571
696=end table 1572=end table
697 1573
698=back 1574=back
699 1575
724 B<< C<Ps = 13> >> Change colour of mouse foreground to B<< C<Pt> >> 1600 B<< C<Ps = 13> >> Change colour of mouse foreground to B<< C<Pt> >>
725 B<< C<Ps = 17> >> Change colour of highlight characters to B<< C<Pt> >> 1601 B<< C<Ps = 17> >> Change colour of highlight characters to B<< C<Pt> >>
726 B<< C<Ps = 18> >> Change colour of bold characters to B<< C<Pt> >> 1602 B<< C<Ps = 18> >> Change colour of bold characters to B<< C<Pt> >>
727 B<< C<Ps = 19> >> Change colour of underlined characters to B<< C<Pt> >> 1603 B<< C<Ps = 19> >> Change colour of underlined characters to B<< C<Pt> >>
728 B<< C<Ps = 20> >> Change default background to B<< C<Pt> >> 1604 B<< C<Ps = 20> >> Change default background to B<< C<Pt> >>
729 B<< C<Ps = 39> >> Change default foreground colour to B<< C<Pt> >> I<rxvt compile-time option> 1605 B<< C<Ps = 39> >> Change default foreground colour to B<< C<Pt> >>.
730 B<< C<Ps = 46> >> Change Log File to B<< C<Pt> >> I<unimplemented> 1606 B<< C<Ps = 46> >> Change Log File to B<< C<Pt> >> I<unimplemented>
731 B<< C<Ps = 49> >> Change default background colour to B<< C<Pt> >> I<rxvt compile-time option> 1607 B<< C<Ps = 49> >> Change default background colour to B<< C<Pt> >>.
732 B<< C<Ps = 50> >> Set fontset to B<< C<Pt> >>, with the following special values of B<< C<Pt> >> (B<rxvt>) B<< C<#+n> >> change up B<< C<n> >> B<< C<#-n> >> change down B<< C<n> >> if B<< C<n> >> is missing of 0, a value of 1 is used I<empty> change to font0 B<< C<n> >> change to font B<< C<n> >> 1608 B<< C<Ps = 50> >> Set fontset to B<< C<Pt> >>, with the following special values of B<< C<Pt> >> (B<rxvt>) B<< C<#+n> >> change up B<< C<n> >> B<< C<#-n> >> change down B<< C<n> >> if B<< C<n> >> is missing of 0, a value of 1 is used I<empty> change to font0 B<< C<n> >> change to font B<< C<n> >>
733 B<< C<Ps = 55> >> Log all scrollback buffer and all of screen to B<< C<Pt> >> 1609 B<< C<Ps = 55> >> Log all scrollback buffer and all of screen to B<< C<Pt> >>
734 B<< C<Ps = 701> >> Change current locale to B<< C<Pt> >>, or, if B<< C<Pt> >> is B<< C<?> >>, return the current locale (@@RXVTNAME@@ extension) 1610 B<< C<Ps = 701> >> Change current locale to B<< C<Pt> >>, or, if B<< C<Pt> >> is B<< C<?> >>, return the current locale (Compile frills).
735 B<< C<Ps = 702> >> find font for character, used for debugging (@@RXVTNAME@@ extension) 1611 B<< C<Ps = 703> >> Menubar command B<< C<Pt> >> (Compile menubar).
736 B<< C<Ps = 703> >> command B<< C<Pt> >> I<rxvt compile-time option> (@@RXVTNAME@@ extension) 1612 B<< C<Ps = 704> >> Change colour of italic characters to B<< C<Pt> >>
1613 B<< C<Ps = 705> >> Change background pixmap tint colour to B<< C<Pt> >> (Compile transparency).
1614 B<< C<Ps = 710> >> Set normal fontset to B<< C<Pt> >>. Same as C<Ps = 50>.
1615 B<< C<Ps = 711> >> Set bold fontset to B<< C<Pt> >>. Similar to C<Ps = 50> (Compile styles).
1616 B<< C<Ps = 712> >> Set italic fontset to B<< C<Pt> >>. Similar to C<Ps = 50> (Compile styles).
1617 B<< C<Ps = 713> >> Set bold-italic fontset to B<< C<Pt> >>. Similar to C<Ps = 50> (Compile styles).
1618 B<< C<Ps = 720> >> Move viewing window up by B<< C<Pt> >> lines, or clear scrollback buffer if C<Pt = 0> (Compile frills).
1619 B<< C<Ps = 721> >> Move viewing window down by B<< C<Pt> >> lines, or clear scrollback buffer if C<Pt = 0> (Compile frills).
737 1620
738=end table 1621=end table
739 1622
740=back 1623=back
741 1624
793 1676
794=item B<< [title:+I<string>] >> 1677=item B<< [title:+I<string>] >>
795 1678
796set the current menuBar's title to I<string>, which may contain the 1679set the current menuBar's title to I<string>, which may contain the
797following format specifiers: 1680following format specifiers:
798B<%%> : literal B<%> character 1681
799B<%n> : rxvt name (as per the B<-name> command-line option) 1682 B<%n> rxvt name (as per the B<-name> command-line option)
800B<%v> : rxvt version 1683 B<%v> rxvt version
1684 B<%%> literal B<%> character
801 1685
802=item B<[done]> 1686=item B<[done]>
803 1687
804set menuBar access as B<readonly>. 1688set menuBar access as B<readonly>.
805End-of-file tag for B<< [read:+I<file>] >> operations. 1689End-of-file tag for B<< [read:+I<file>] >> operations.
951 1835
952As a convenience for the many Emacs-type editors, I<action> may start 1836As a convenience for the many Emacs-type editors, I<action> may start
953with B<M-> (eg, B<M-$> is equivalent to B<\E$>) and a B<CR> will be 1837with B<M-> (eg, B<M-$> is equivalent to B<\E$>) and a B<CR> will be
954appended if missed from B<M-x> commands. 1838appended if missed from B<M-x> commands.
955 1839
956As a convenience for issuing XTerm B<ESC]> sequences from a menubar (or 1840As a convenience for issuing XTerm B<ESC ]> sequences from a menubar (or
957quick arrow), a B<BEL> (B<^G>) will be appended if needed. 1841quick arrow), a B<BEL> (B<^G>) will be appended if needed.
958 1842
959=over 4 1843=over 4
960 1844
961=item For example, 1845=item For example,
1320 2204
1321Row = B<< C<< <y> - SPACE >> >> 2205Row = B<< C<< <y> - SPACE >> >>
1322 2206
1323=back 2207=back
1324X<KeyCodes> 2208X<KeyCodes>
1325
1326=head1 ISO 14755 support
1327
1328Partial ISO 14755-support is implemented. that means that pressing
1329
1330section 5.1: Control and Shift together enters unicode input
1331mode. Entering hex digits composes a Unicode character, pressing space or
1332releasing the modifiers commits the keycode and every other key cancels
1333the current input character.
1334
1335section 5.2: Pressing and immediately releasing Control and Shift together
1336enters keycap entry mode for the next key: pressing a function key (tab,
1337return etc..) will enter the unicode character corresponding to the given
1338key.
1339 2209
1340=head1 Key Codes 2210=head1 Key Codes
1341 2211
1342Note: B<Shift> + B<F1>-B<F10> generates B<F11>-B<F20> 2212Note: B<Shift> + B<F1>-B<F10> generates B<F11>-B<F20>
1343 2213
1408 XK_KP_8 8 ESC O x 2278 XK_KP_8 8 ESC O x
1409 XK_KP_9 9 ESC O y 2279 XK_KP_9 9 ESC O y
1410 2280
1411=end table 2281=end table
1412 2282
2283=head1 CONFIGURE OPTIONS
2284
2285General hint: if you get compile errors, then likely your configuration
2286hasn't been tested well. Either try with C<--enable-everything> or use
2287the F<./reconf> script as a base for experiments. F<./reconf> is used by
2288myself, so it should generally be a working config. Of course, you should
2289always report when a combination doesn't work, so it can be fixed. Marc
2290Lehmann <rxvt@schmorp.de>.
2291
2292All
2293
2294=over 4
2295
2296=item --enable-everything
2297
2298Add (or remove) support for all non-multichoice options listed in "./configure
2299--help".
2300
2301You can specify this and then disable options you do not like by
2302I<following> this with the appropriate C<--disable-...> arguments,
2303or you can start with a minimal configuration by specifying
2304C<--disable-everything> and than adding just the C<--enable-...> arguments
2305you want.
2306
2307=item --enable-xft (default: enabled)
2308
2309Add support for Xft (anti-aliases, among others) fonts. Xft fonts are
2310slower and require lots of memory, but as long as you don't use them, you
2311don't pay for them.
2312
2313=item --enable-font-styles (default: on)
2314
2315Add support for B<bold>, I<italic> and B<< I<bold italic> >> font
2316styles. The fonts can be set manually or automatically.
2317
2318=item --with-codesets=NAME,... (default: all)
2319
2320Compile in support for additional codeset (encoding) groups (C<eu>, C<vn>
2321are always compiled in, which includes most 8-bit character sets). These
2322codeset tables are used for driving X11 core fonts, they are not required
2323for Xft fonts, although having them compiled in lets rxvt-unicode choose
2324replacement fonts more intelligently. Compiling them in will make your
2325binary bigger (all of together cost about 700kB), but it doesn't increase
2326memory usage unless you use a font requiring one of these encodings.
2327
2328=begin table
2329
2330 all all available codeset groups
2331 zh common chinese encodings
2332 zh_ext rarely used but very big chinese encodigs
2333 jp common japanese encodings
2334 jp_ext rarely used but big japanese encodings
2335 kr korean encodings
2336
2337=end table
2338
2339=item --enable-xim (default: on)
2340
2341Add support for XIM (X Input Method) protocol. This allows using
2342alternative input methods (e.g. kinput2) and will also correctly
2343set up the input for people using dead keys or compose keys.
2344
2345=item --enable-unicode3 (default: off)
2346
2347Enable direct support for displaying unicode codepoints above
234865535 (the basic multilingual page). This increases storage
2349requirements per character from 2 to 4 bytes. X11 fonts do not yet
2350support these extra characters, but Xft does.
2351
2352Please note that rxvt-unicode can store unicode code points >65535
2353even without this flag, but the number of such characters is
2354limited to a view thousand (shared with combining characters,
2355see next switch), and right now rxvt-unicode cannot display them
2356(input/output and cut&paste still work, though).
2357
2358=item --enable-combining (default: on)
2359
2360Enable automatic composition of combining characters into
2361composite characters. This is required for proper viewing of text
2362where accents are encoded as seperate unicode characters. This is
2363done by using precomposited characters when available or creating
2364new pseudo-characters when no precomposed form exists.
2365
2366Without --enable-unicode3, the number of additional precomposed characters
2367is rather limited (2048, if this is full, rxvt-unicode will use the
2368private use area, extending the number of combinations to 8448). With
2369--enable-unicode3, no practical limit exists.
2370
2371This option will also enable storage (but not display) of characters
2372beyond plane 0 (>65535) when --enable-unicode3 was not specified.
2373
2374The combining table also contains entries for arabic presentation forms,
2375but these are not currently used. Bug me if you want these to be used (and
2376tell me how these are to be used...).
2377
2378=item --enable-fallback(=CLASS) (default: Rxvt)
2379
2380When reading resource settings, also read settings for class CLASS. To disable resource fallback use --disable-fallback.
2381
2382=item --with-res-name=NAME (default: urxvt)
2383
2384Use the given name as default application name when
2385reading resources. Specify --with-res-name=rxvt to replace rxvt.
2386
2387=item --with-res-class=CLASS /default: URxvt)
2388
2389Use the given class as default application class
2390when reading resources. Specify --with-res-class=Rxvt to replace
2391rxvt.
2392
2393=item --enable-utmp (default: on)
2394
2395Write user and tty to utmp file (used by programs like F<w>) at
2396start of rxvt execution and delete information when rxvt exits.
2397
2398=item --enable-wtmp (default: on)
2399
2400Write user and tty to wtmp file (used by programs like F<last>) at
2401start of rxvt execution and write logout when rxvt exits. This
2402option requires --enable-utmp to also be specified.
2403
2404=item --enable-lastlog (default: on)
2405
2406Write user and tty to lastlog file (used by programs like
2407F<lastlogin>) at start of rxvt execution. This option requires
2408--enable-utmp to also be specified.
2409
2410=item --enable-xpm-background (default: off)
2411
2412Add support for XPM background pixmaps.
2413
2414=item --enable-transparency (default: off)
2415
2416Add support for inheriting parent backgrounds thus giving a fake
2417transparency to the term.
2418
2419=item --enable-fading (default: on)
2420
2421Add support for fading the text when focus is lost (requires C<--enable-transparency>).
2422
2423=item --enable-tinting (default: on)
2424
2425Add support for tinting of transparent backgrounds (requires C<--enable-transparency>).
2426
2427=item --enable-menubar (default: off)
2428
2429Add support for our menu bar system (this interacts badly with
2430dynamic locale switching currently).
2431
2432=item --enable-rxvt-scroll (default: on)
2433
2434Add support for the original rxvt scrollbar.
2435
2436=item --enable-next-scroll (default: on)
2437
2438Add support for a NeXT-like scrollbar.
2439
2440=item --enable-xterm-scroll (default: on)
2441
2442Add support for an Xterm-like scrollbar.
2443
2444=item --enable-plain-scroll (default: on)
2445
2446Add support for a very unobtrusive, plain-looking scrollbar that
2447is the favourite of the rxvt-unicode author, having used it for
2448many years.
2449
2450=item --enable-half-shadow (default: off)
2451
2452Make shadows on the scrollbar only half the normal width & height.
2453only applicable to rxvt scrollbars.
2454
2455=item --enable-ttygid (default: off)
2456
2457Change tty device setting to group "tty" - only use this if
2458your system uses this type of security.
2459
2460=item --disable-backspace-key
2461
2462Removes any handling of the backspace key by us - let the X server do it.
2463
2464=item --disable-delete-key
2465
2466Removes any handling of the delete key by us - let the X server
2467do it.
2468
2469=item --disable-resources
2470
2471Removes any support for resource checking.
2472
2473=item --enable-xgetdefault
2474
2475Make resources checking via XGetDefault() instead of our small
2476version which only checks ~/.Xdefaults, or if that doesn't exist then
2477~/.Xresources.
2478
2479Please note that nowadays, things like XIM will automatically pull in and
2480use the full X resource manager, so the overhead of using it might be very
2481small, if nonexistant.
2482
2483=item --enable-strings (default: off)
2484
2485Add support for our possibly faster memset() function and other
2486various routines, overriding your system's versions which may
2487have been hand-crafted in assembly or may require extra libraries
2488to link in. (this breaks ANSI-C rules and has problems on many
2489GNU/Linux systems).
2490
2491=item --disable-swapscreen
2492
2493Remove support for secondary/swap screen.
2494
2495=item --enable-frills (default: on)
2496
2497Add support for many small features that are not essential but nice to
2498have. Normally you want this, but for very small binaries you may want to
2499disable this.
2500
2501A non-exhaustive list of features enabled by C<--enable-frills> (possibly
2502in combination with other switches) is:
2503
2504 MWM-hints
2505 EWMH-hints (pid, utf8 names) and protocols (ping)
2506 seperate underline colour
2507 settable border widths and borderless switch
2508 settable extra linespacing
2509 iso-14755-2 and -3, and visual feedback
2510 backindex and forwardindex escape sequence
2511 window op and some xterm/OSC escape sequences
2512 tripleclickwords
2513 settable insecure mode
2514 keysym remapping support
2515 cursor blinking and underline cursor
2516 -embed, -pty-fd and -hold options
2517
2518=item --enable-iso14755 (default: on)
2519
2520Enable extended ISO 14755 support (see @@RXVT_NAME@@(1), or
2521F<doc/rxvt.1.txt>). Basic support (section 5.1) is enabled by
2522C<--enable-frills>, while support for 5.2, 5.3 and 5.4 is enabled with
2523this switch.
2524
2525=item --enable-keepscrolling (default: on)
2526
2527Add support for continual scrolling of the display when you hold
2528the mouse button down on a scrollbar arrow.
2529
2530=item --enable-mousewheel (default: on)
2531
2532Add support for scrolling via mouse wheel or buttons 4 & 5.
2533
2534=item --enable-slipwheeling (default: on)
2535
2536Add support for continual scrolling (using the mouse wheel as an
2537accelerator) while the control key is held down. This option
2538requires --enable-mousewheel to also be specified.
2539
2540=item --disable-new-selection
2541
2542Remove support for mouse selection style like that of xterm.
2543
2544=item --enable-dmalloc (default: off)
2545
2546Use Gray Watson's malloc - which is good for debugging See
2547http://www.letters.com/dmalloc/ for details If you use either this or the
2548next option, you may need to edit src/Makefile after compiling to point
2549DINCLUDE and DLIB to the right places.
2550
2551You can only use either this option and the following (should
2552you use either) .
2553
2554=item --enable-dlmalloc (default: off)
2555
2556Use Doug Lea's malloc - which is good for a production version
2557See L<http://g.oswego.edu/dl/html/malloc.html> for details.
2558
2559=item --enable-smart-resize (default: on)
2560
2561Add smart growth/shrink behaviour when changing font size via hot
2562keys. This should keep the window corner which is closest to a corner of
2563the screen in a fixed position.
2564
2565=item --enable-pointer-blank (default: on)
2566
2567Add support to have the pointer disappear when typing or inactive.
2568
2569=item --with-name=NAME (default: urxvt)
2570
2571Set the basename for the installed binaries, resulting
2572in C<urxvt>, C<urxvtd> etc.). Specify C<--with-name=rxvt> to replace with
2573C<rxvt>.
2574
2575=item --with-term=NAME (default: rxvt-unicode)
2576
2577Change the environmental variable for the terminal to NAME.
2578
2579=item --with-terminfo=PATH
2580
2581Change the environmental variable for the path to the terminfo tree to
2582PATH.
2583
2584=item --with-x
2585
2586Use the X Window System (pretty much default, eh?).
2587
2588=item --with-xpm-includes=DIR
2589
2590Look for the XPM includes in DIR.
2591
2592=item --with-xpm-library=DIR
2593
2594Look for the XPM library in DIR.
2595
2596=item --with-xpm
2597
2598Not needed - define via --enable-xpm-background.
2599
2600=back
2601
2602=head1 AUTHORS
2603
2604Marc Lehmann <rxvt@schmorp.de> converted this document to pod and
2605reworked it from the original Rxvt documentation, which was done by Geoff
2606Wing <gcw@pobox.com>, who in turn used the XTerm documentation and other
2607sources.
2608

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines