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.56 by root, Wed Jul 13 01:01:41 2005 UTC vs.
Revision 1.199 by sf-exg, Thu Nov 4 12:13:20 2010 UTC

16=head1 DESCRIPTION 16=head1 DESCRIPTION
17 17
18This document contains the FAQ, the RXVT TECHNICAL REFERENCE documenting 18This document contains the FAQ, the RXVT TECHNICAL REFERENCE documenting
19all escape sequences, and other background information. 19all escape sequences, and other background information.
20 20
21The newest version of this document is 21The newest version of this document is also available on the World Wide Web at
22also available on the World Wide Web at 22L<http://pod.tst.eu/http://cvs.schmorp.de/rxvt-unicode/doc/rxvt.7.pod>.
23L<http://cvs.schmorp.de/browse/*checkout*/rxvt-unicode/doc/rxvt.7.html>.
24 23
24The main manual page for @@RXVT_NAME@@ itself is available at
25L<http://pod.tst.eu/http://cvs.schmorp.de/rxvt-unicode/doc/rxvt.1.pod>.
26
25=head1 FREQUENTLY ASKED QUESTIONS 27=head1 RXVT-UNICODE/URXVT FREQUENTLY ASKED QUESTIONS
26 28
27=over 4
28 29
30=head2 Meta, Features & Commandline Issues
31
32=head3 My question isn't answered here, can I ask a human?
33
34Before sending me mail, you could go to IRC: C<irc.freenode.net>,
35channel C<#rxvt-unicode> has some rxvt-unicode enthusiasts that might be
36interested in learning about new and exciting problems (but not FAQs :).
37
38=head3 I use Gentoo, and I have a problem...
39
40There are three big problems with Gentoo Linux: first of all, most if not
41all Gentoo systems are completely broken (missing or mismatched header
42files, broken compiler etc. are just the tip of the iceberg); secondly,
43the Gentoo maintainer thinks it is a good idea to add broken patches to
44the code; and lastly, it should be called Gentoo GNU/Linux.
45
46For these reasons, it is impossible to support rxvt-unicode on
47Gentoo. Problems appearing on Gentoo systems will usually simply be
48ignored unless they can be reproduced on non-Gentoo systems.
49
50=head3 Does it support tabs, can I have a tabbed rxvt-unicode?
51
52Beginning with version 7.3, there is a perl extension that implements a
53simple tabbed terminal. It is installed by default, so any of these should
54give you tabs:
55
56 @@URXVT_NAME@@ -pe tabbed
57
58 URxvt.perl-ext-common: default,tabbed
59
60It will also work fine with tabbing functionality of many window managers
61or similar tabbing programs, and its embedding-features allow it to be
62embedded into other programs, as witnessed by F<doc/rxvt-tabbed> or
63the upcoming C<Gtk2::URxvt> perl module, which features a tabbed urxvt
64(murxvt) terminal as an example embedding application.
65
29=item How do I know which rxvt-unicode version I'm using? 66=head3 How do I know which rxvt-unicode version I'm using?
30 67
31The version number is displayed with the usage (-h). Also the escape 68The version number is displayed with the usage (-h). Also the escape
32sequence C<ESC [ 8 n> sets the window title to the version number. 69sequence C<ESC [ 8 n> sets the window title to the version number. When
70using the @@URXVT_NAME@@c client, the version displayed is that of the
71daemon.
33 72
34=item I am using Debian GNU/Linux and have a problem...
35
36The Debian GNU/Linux package of rxvt-unicode contains large patches that
37considerably change the behaviour of rxvt-unicode. Before reporting a
38bug to the original rxvt-unicode author please download and install the
39genuine version (L<http://software.schmorp.de#rxvt-unicode>) and try to
40reproduce the problem. If you cannot, chances are that the problems are
41specific to Debian GNU/Linux, in which case it should be reported via the
42Debian Bug Tracking System (use C<reportbug> to report the bug).
43
44For other problems that also affect the Debian package, you can and
45probably should use the Debian BTS, too, because, after all, it's also a
46bug in the Debian version and it serves as a reminder for other users that
47might encounter the same issue.
48
49=item When I log-in to another system it tells me about missing terminfo data?
50
51The terminal description used by rxvt-unicode is not as widely available
52as that for xterm, or even rxvt (for which the same problem often arises).
53
54The correct solution for this problem is to install the terminfo, this can
55be done like this (with ncurses' infocmp):
56
57 REMOTE=remotesystem.domain
58 infocmp rxvt-unicode | ssh $REMOTE "cat >/tmp/ti && tic /tmp/ti"
59
60... or by installing rxvt-unicode normally on the remote system,
61
62If you cannot or do not want to do this, then you can simply set
63C<TERM=rxvt> or even C<TERM=xterm>, and live with the small number of
64problems arising, which includes wrong keymapping, less and different
65colours and some refresh errors in fullscreen applications. It's a nice
66quick-and-dirty workaround for rare cases, though.
67
68If you always want to do this (and are fine with the consequences) you
69can either recompile rxvt-unicode with the desired TERM value or use a
70resource to set it:
71
72 URxvt.termName: rxvt
73
74If you don't plan to use B<rxvt> (quite common...) you could also replace
75the rxvt terminfo file with the rxvt-unicode one.
76
77=item C<bash>'s readline does not work correctly under @@RXVT_NAME@@.
78
79=item I need a termcap file entry.
80
81One reason you might want this is that some distributions or operating
82systems still compile some programs using the long-obsoleted termcap
83library (Fedora Core's bash is one example) and rely on a termcap entry
84for C<rxvt-unicode>.
85
86You could use rxvt's termcap entry with resonable results in many cases.
87You can also create a termcap entry by using terminfo's infocmp program
88like this:
89
90 infocmp -C rxvt-unicode
91
92Or you could use this termcap entry, generated by the command above:
93
94 rxvt-unicode|rxvt-unicode terminal (X Window System):\
95 :am:bw:eo:km:mi:ms:xn:xo:\
96 :co#80:it#8:li#24:lm#0:\
97 :AL=\E[%dL:DC=\E[%dP:DL=\E[%dM:DO=\E[%dB:IC=\E[%d@:\
98 :K1=\EOw:K2=\EOu:K3=\EOy:K4=\EOq:K5=\EOs:LE=\E[%dD:\
99 :RI=\E[%dC:SF=\E[%dS:SR=\E[%dT:UP=\E[%dA:ae=\E(B:al=\E[L:\
100 :as=\E(0:bl=^G:cd=\E[J:ce=\E[K:cl=\E[H\E[2J:\
101 :cm=\E[%i%d;%dH:cr=^M:cs=\E[%i%d;%dr:ct=\E[3g:dc=\E[P:\
102 :dl=\E[M:do=^J:ec=\E[%dX:ei=\E[4l:ho=\E[H:\
103 :i1=\E[?47l\E=\E[?1l:ic=\E[@:im=\E[4h:\
104 :is=\E[r\E[m\E[2J\E[H\E[?7h\E[?1;3;4;6l\E[4l:\
105 :k1=\E[11~:k2=\E[12~:k3=\E[13~:k4=\E[14~:k5=\E[15~:\
106 :k6=\E[17~:k7=\E[18~:k8=\E[19~:k9=\E[20~:kD=\E[3~:\
107 :kI=\E[2~:kN=\E[6~:kP=\E[5~:kb=\177:kd=\EOB:ke=\E[?1l\E>:\
108 :kh=\E[7~:kl=\EOD:kr=\EOC:ks=\E[?1h\E=:ku=\EOA:le=^H:\
109 :mb=\E[5m:md=\E[1m:me=\E[m\017:mr=\E[7m:nd=\E[C:rc=\E8:\
110 :sc=\E7:se=\E[27m:sf=^J:so=\E[7m:sr=\EM:st=\EH:ta=^I:\
111 :te=\E[r\E[?1049l:ti=\E[?1049h:ue=\E[24m:up=\E[A:\
112 :us=\E[4m:vb=\E[?5h\E[?5l:ve=\E[?25h:vi=\E[?25l:\
113 :vs=\E[?25h:
114
115=item Why does C<ls> no longer have coloured output?
116
117The C<ls> in the GNU coreutils unfortunately doesn't use terminfo to
118decide wether a terminal has colour, but uses it's own configuration
119file. Needless to say, C<rxvt-unicode> is not in it's default file (among
120with most other terminals supporting colour). Either add:
121
122 TERM rxvt-unicode
123
124to C</etc/DIR_COLORS> or simply add:
125
126 alias ls='ls --color=auto'
127
128to your C<.profile> or C<.bashrc>.
129
130=item Why doesn't vim/emacs etc. use the 88 colour mode?
131
132=item Why doesn't vim/emacs etc. make use of italic?
133
134=item Why are the secondary screen-related options not working properly?
135
136Make sure you are using C<TERM=rxvt-unicode>. Some pre-packaged
137distributions (most notably Debian GNU/Linux) break rxvt-unicode
138by setting C<TERM> to C<rxvt>, which doesn't have these extra
139features. Unfortunately, some of these (most notably, again, Debian
140GNU/Linux) furthermore fail to even install the C<rxvt-unicode> terminfo
141file, so you will need to install it on your own (See the question B<When
142I log-in to another system it tells me about missing terminfo data?> on
143how to do this).
144
145=item My numerical keypad acts weird and generates differing output?
146
147Some Debian GNUL/Linux users seem to have this problem, although no
148specific details were reported so far. It is possible that this is caused
149by the wrong C<TERM> setting, although the details of wether and how
150this can happen are unknown, as C<TERM=rxvt> should offer a compatible
151keymap. See the answer to the previous question, and please report if that
152helped.
153
154=item Rxvt-unicode does not seem to understand the selected encoding?
155
156=item Unicode does not seem to work?
157
158If you encounter strange problems like typing an accented character but
159getting two unrelated other characters or similar, or if program output is
160subtly garbled, then you should check your locale settings.
161
162Rxvt-unicode must be started with the same C<LC_CTYPE> setting as the
163programs. Often rxvt-unicode is started in the C<C> locale, while the
164login script running within the rxvt-unicode window changes the locale to
165something else, e.g. C<en_GB.UTF-8>. Needless to say, this is not going to work.
166
167The best thing is to fix your startup environment, as you will likely run
168into other problems. If nothing works you can try this in your .profile.
169
170 printf '\e]701;%s\007' "$LC_CTYPE"
171
172If this doesn't work, then maybe you use a C<LC_CTYPE> specification not
173supported on your systems. Some systems have a C<locale> command which
174displays this (also, C<perl -e0> can be used to check locale settings, as
175it will complain loudly if it cannot set the locale). If it displays something
176like:
177
178 locale: Cannot set LC_CTYPE to default locale: ...
179
180Then the locale you specified is not supported on your system.
181
182If nothing works and you are sure that everything is set correctly then
183you will need to remember a little known fact: Some programs just don't
184support locales :(
185
186=item Why do some characters look so much different than others?
187
188=item How does rxvt-unicode choose fonts?
189
190Most fonts do not contain the full range of Unicode, which is
191fine. Chances are that the font you (or the admin/package maintainer of
192your system/os) have specified does not cover all the characters you want
193to display.
194
195B<rxvt-unicode> makes a best-effort try at finding a replacement
196font. Often the result is fine, but sometimes the chosen font looks
197bad/ugly/wrong. Some fonts have totally strange characters that don't
198resemble the correct glyph at all, and rxvt-unicode lacks the artificial
199intelligence to detect that a specific glyph is wrong: it has to believe
200the font that the characters it claims to contain indeed look correct.
201
202In that case, select a font of your taste and add it to the font list,
203e.g.:
204
205 @@RXVT_NAME@@ -fn basefont,font2,font3...
206
207When rxvt-unicode sees a character, it will first look at the base
208font. If the base font does not contain the character, it will go to the
209next font, and so on. Specifying your own fonts will also speed up this
210search and use less resources within rxvt-unicode and the X-server.
211
212The only limitation is that none of the fonts may be larger than the base
213font, as the base font defines the terminal character cell size, which
214must be the same due to the way terminals work.
215
216=item Why do some chinese characters look so different than others?
217
218This is because there is a difference between script and language --
219rxvt-unicode does not know which language the text that is output is,
220as it only knows the unicode character codes. If rxvt-unicode first
221sees a japanese/chinese character, it might choose a japanese font for
222display. Subsequent japanese characters will use that font. Now, many
223chinese characters aren't represented in japanese fonts, so when the first
224non-japanese character comes up, rxvt-unicode will look for a chinese font
225-- unfortunately at this point, it will still use the japanese font for
226chinese characters that are also in the japanese font.
227
228The workaround is easy: just tag a chinese font at the end of your font
229list (see the previous question). The key is to view the font list as
230a preference list: If you expect more japanese, list a japanese font
231first. If you expect more chinese, put a chinese font first.
232
233In the future it might be possible to switch language preferences at
234runtime (the internal data structure has no problem with using different
235fonts for the same character at the same time, but no interface for this
236has been designed yet).
237
238Until then, you might get away with switching fonts at runtime (see L<Can
239I switch the fonts at runtime?> later in this document).
240
241=item Why does rxvt-unicode sometimes leave pixel droppings?
242
243Most fonts were not designed for terminal use, which means that character
244size varies a lot. A font that is otherwise fine for terminal use might
245contain some characters that are simply too wide. Rxvt-unicode will avoid
246these characters. For characters that are just "a bit" too wide a special
247"careful" rendering mode is used that redraws adjacent characters.
248
249All of this requires that fonts do not lie about character sizes,
250however: Xft fonts often draw glyphs larger than their acclaimed bounding
251box, and rxvt-unicode has no way of detecting this (the correct way is to
252ask for the character bounding box, which unfortunately is wrong in these
253cases).
254
255It's not clear (to me at least), wether this is a bug in Xft, freetype,
256or the respective font. If you encounter this problem you might try using
257the C<-lsp> option to give the font more height. If that doesn't work, you
258might be forced to use a different font.
259
260All of this is not a problem when using X11 core fonts, as their bounding
261box data is correct.
262
263=item On Solaris 9, many line-drawing characters are too wide.
264
265Seems to be a known bug, read
266L<http://nixdoc.net/files/forum/about34198.html>. Some people use the
267following ugly workaround to get non-double-wide-characters working:
268
269 #define wcwidth(x) wcwidth(x) > 1 ? 1 : wcwidth(x)
270
271=item My Compose (Multi_key) key is no longer working.
272
273The most common causes for this are that either your locale is not set
274correctly, or you specified a B<preeditStyle> that is not supported by
275your input method. For example, if you specified B<OverTheSpot> and
276your input method (e.g. the default input method handling Compose keys)
277does not support this (for instance because it is not visual), then
278rxvt-unicode will continue without an input method.
279
280In this case either do not specify a B<preeditStyle> or specify more than
281one pre-edit style, such as B<OverTheSpot,Root,None>.
282
283=item I cannot type C<Ctrl-Shift-2> to get an ASCII NUL character due to ISO 14755
284
285Either try C<Ctrl-2> alone (it often is mapped to ASCII NUL even on
286international keyboards) or simply use ISO 14755 support to your
287advantage, typing <Ctrl-Shift-0> to get a ASCII NUL. This works for other
288codes, too, such as C<Ctrl-Shift-1-d> to type the default telnet escape
289character and so on.
290
291=item How can I keep rxvt-unicode from using reverse video so much?
292
293First of all, make sure you are running with the right terminal settings
294(C<TERM=rxvt-unicode>), which will get rid of most of these effects. Then
295make sure you have specified colours for italic and bold, as otherwise
296rxvt-unicode might use reverse video to simulate the effect:
297
298 URxvt.colorBD: white
299 URxvt.colorIT: green
300
301=item Some programs assume totally weird colours (red instead of blue), how can I fix that?
302
303For some unexplainable reason, some rare programs assume a very weird
304colour palette when confronted with a terminal with more than the standard
3058 colours (rxvt-unicode supports 88). The right fix is, of course, to fix
306these programs not to assume non-ISO colours without very good reasons.
307
308In the meantime, you can either edit your C<rxvt-unicode> terminfo
309definition to only claim 8 colour support or use C<TERM=rxvt>, which will
310fix colours but keep you from using other rxvt-unicode features.
311
312=item I am on FreeBSD and rxvt-unicode does not seem to work at all.
313
314Rxvt-unicode requires the symbol C<__STDC_ISO_10646__> to be defined
315in your compile environment, or an implementation that implements it,
316wether it defines the symbol or not. C<__STDC_ISO_10646__> requires that
317B<wchar_t> is represented as unicode.
318
319As you might have guessed, FreeBSD does neither define this symobl nor
320does it support it. Instead, it uses it's own internal representation of
321B<wchar_t>. This is, of course, completely fine with respect to standards.
322
323However, that means rxvt-unicode only works in C<POSIX>, C<ISO-8859-1> and
324C<UTF-8> locales under FreeBSD (which all use Unicode as B<wchar_t>.
325
326C<__STDC_ISO_10646__> is the only sane way to support multi-language
327apps in an OS, as using a locale-dependent (and non-standardized)
328representation of B<wchar_t> makes it impossible to convert between
329B<wchar_t> (as used by X11 and your applications) and any other encoding
330without implementing OS-specific-wrappers for each and every locale. There
331simply are no APIs to convert B<wchar_t> into anything except the current
332locale encoding.
333
334Some applications (such as the formidable B<mlterm>) work around this
335by carrying their own replacement functions for character set handling
336with them, and either implementing OS-dependent hacks or doing multiple
337conversions (which is slow and unreliable in case the OS implements
338encodings slightly different than the terminal emulator).
339
340The rxvt-unicode author insists that the right way to fix this is in the
341system libraries once and for all, instead of forcing every app to carry
342complete replacements for them :)
343
344=item I use Solaris 9 and it doesn't compile/work/etc.
345
346Try the diff in F<doc/solaris9.patch> as a base. It fixes the worst
347problems with C<wcwidth> and a compile problem.
348
349=item How can I use rxvt-unicode under cygwin?
350
351rxvt-unicode should compile and run out of the box on cygwin, using
352the X11 libraries that come with cygwin. libW11 emulation is no
353longer supported (and makes no sense, either, as it only supported a
354single font). I recommend starting the X-server in C<-multiwindow> or
355C<-rootless> mode instead, which will result in similar look&feel as the
356old libW11 emulation.
357
358At the time of this writing, cygwin didn't seem to support any multi-byte
359encodings, so you are likely limited to 8-bit encodings.
360
361=item How does rxvt-unicode determine the encoding to use?
362
363=item Is there an option to switch encodings?
364
365Unlike some other terminals, rxvt-unicode has no encoding switch, and no
366specific "utf-8" mode, such as xterm. In fact, it doesn't even know about
367UTF-8 or any other encodings with respect to terminal I/O.
368
369The reasons is that there exists a perfectly fine mechanism for selecting
370the encoding, doing I/O and (most important) communicating this to all
371applications so everybody agrees on character properties such as width
372and code number. This mechanism is the I<locale>. Applications not using
373that info will have problems (for example, C<xterm> gets the width of
374characters wrong as it uses it's own, locale-independent table under all
375locales).
376
377Rxvt-unicode uses the C<LC_CTYPE> locale category to select encoding. All
378programs doing the same (that is, most) will automatically agree in the
379interpretation of characters.
380
381Unfortunately, there is no system-independent way to select locales, nor
382is there a standard on how locale specifiers will look like.
383
384On most systems, the content of the C<LC_CTYPE> environment variable
385contains an arbitrary string which corresponds to an already-installed
386locale. Common names for locales are C<en_US.UTF-8>, C<de_DE.ISO-8859-15>,
387C<ja_JP.EUC-JP>, i.e. C<language_country.encoding>, but other forms
388(i.e. C<de> or C<german>) are also common.
389
390Rxvt-unicode ignores all other locale categories, and except for
391the encoding, ignores country or language-specific settings,
392i.e. C<de_DE.UTF-8> and C<ja_JP.UTF-8> are the normally same to
393rxvt-unicode.
394
395If you want to use a specific encoding you have to make sure you start
396rxvt-unicode with the correct C<LC_CTYPE> category.
397
398=item Can I switch locales at runtime?
399
400Yes, using an escape sequence. Try something like this, which sets
401rxvt-unicode's idea of C<LC_CTYPE>.
402
403 printf '\e]701;%s\007' ja_JP.SJIS
404
405See also the previous answer.
406
407Sometimes this capability is rather handy when you want to work in
408one locale (e.g. C<de_DE.UTF-8>) but some programs don't support it
409(e.g. UTF-8). For example, I use this script to start C<xjdic>, which
410first switches to a locale supported by xjdic and back later:
411
412 printf '\e]701;%s\007' ja_JP.SJIS
413 xjdic -js
414 printf '\e]701;%s\007' de_DE.UTF-8
415
416You can also use xterm's C<luit> program, which usually works fine, except
417for some locales where character width differs between program- and
418rxvt-unicode-locales.
419
420=item Can I switch the fonts at runtime?
421
422Yes, using an escape sequence. Try something like this, which has the same
423effect as using the C<-fn> switch, and takes effect immediately:
424
425 printf '\e]50;%s\007' "9x15bold,xft:Kochi Gothic"
426
427This is useful if you e.g. work primarily with japanese (and prefer a
428japanese font), but you have to switch to chinese temporarily, where
429japanese fonts would only be in your way.
430
431You can think of this as a kind of manual ISO-2022 switching.
432
433=item Why do italic characters look as if clipped?
434
435Many fonts have difficulties with italic characters and hinting. For
436example, the otherwise very nicely hinted font C<xft:Bitstream Vera Sans
437Mono> completely fails in it's italic face. A workaround might be to
438enable freetype autohinting, i.e. like this:
439
440 URxvt.italicFont: xft:Bitstream Vera Sans Mono:italic:autohint=true
441 URxvt.boldItalicFont: xft:Bitstream Vera Sans Mono:bold:italic:autohint=true
442
443=item My input method wants <some encoding> but I want UTF-8, what can I do?
444
445You can specify separate locales for the input method and the rest of the
446terminal, using the resource C<imlocale>:
447
448 URxvt*imlocale: ja_JP.EUC-JP
449
450Now you can start your terminal with C<LC_CTYPE=ja_JP.UTF-8> and still
451use your input method. Please note, however, that you will not be able to
452input characters outside C<EUC-JP> in a normal way then, as your input
453method limits you.
454
455=item Rxvt-unicode crashes when the X Input Method changes or exits.
456
457Unfortunately, this is unavoidable, as the XIM protocol is racy by
458design. Applications can avoid some crashes at the expense of memory
459leaks, and Input Methods can avoid some crashes by careful ordering at
460exit time. B<kinput2> (and derived input methods) generally succeeds,
461while B<SCIM> (or similar input methods) fails. In the end, however,
462crashes cannot be completely avoided even if both sides cooperate.
463
464So the only workaround is not to kill your Input Method Servers.
465
466=item Rxvt-unicode uses gobs of memory, how can I reduce that? 73=head3 Rxvt-unicode uses gobs of memory, how can I reduce that?
467 74
468Rxvt-unicode tries to obey the rule of not charging you for something you 75Rxvt-unicode tries to obey the rule of not charging you for something you
469don't use. One thing you should try is to configure out all settings that 76don't use. One thing you should try is to configure out all settings that
470you don't need, for example, Xft support is a resource hog by design, 77you don't need, for example, Xft support is a resource hog by design,
471when used. Compiling it out ensures that no Xft font will be loaded 78when used. Compiling it out ensures that no Xft font will be loaded
4766 bytes per screen cell. For a 160x?? window this amounts to almost a 836 bytes per screen cell. For a 160x?? window this amounts to almost a
477kilobyte per line. A scrollback buffer of 10000 lines will then (if full) 84kilobyte per line. A scrollback buffer of 10000 lines will then (if full)
478use 10 Megabytes of memory. With C<--enable-unicode3> it gets worse, as 85use 10 Megabytes of memory. With C<--enable-unicode3> it gets worse, as
479rxvt-unicode then uses 8 bytes per screen cell. 86rxvt-unicode then uses 8 bytes per screen cell.
480 87
88=head3 How can I start @@URXVT_NAME@@d in a race-free way?
89
90Try C<@@URXVT_NAME@@d -f -o>, which tells @@URXVT_NAME@@d to open the
91display, create the listening socket and then fork.
92
93=head3 How can I start @@URXVT_NAME@@d automatically when I run @@URXVT_NAME@@c?
94
95If you want to start @@URXVT_NAME@@d automatically whenever you run
96@@URXVT_NAME@@c and the daemon isn't running yet, use this script:
97
98 #!/bin/sh
99 @@URXVT_NAME@@c "$@"
100 if [ $? -eq 2 ]; then
101 @@URXVT_NAME@@d -q -o -f
102 @@URXVT_NAME@@c "$@"
103 fi
104
105This tries to create a new terminal, and if fails with exit status 2,
106meaning it couldn't connect to the daemon, it will start the daemon and
107re-run the command. Subsequent invocations of the script will re-use the
108existing daemon.
109
110=head3 How do I distinguish whether I'm running rxvt-unicode or a regular
111xterm? I need this to decide about setting colours etc.
112
113The original rxvt and rxvt-unicode always export the variable "COLORTERM",
114so you can check and see if that is set. Note that several programs, JED,
115slrn, Midnight Commander automatically check this variable to decide
116whether or not to use colour.
117
118=head3 How do I set the correct, full IP address for the DISPLAY variable?
119
120If you've compiled rxvt-unicode with DISPLAY_IS_IP and have enabled
121insecure mode then it is possible to use the following shell script
122snippets to correctly set the display. If your version of rxvt-unicode
123wasn't also compiled with ESCZ_ANSWER (as assumed in these snippets) then
124the COLORTERM variable can be used to distinguish rxvt-unicode from a
125regular xterm.
126
127Courtesy of Chuck Blake <cblake@BBN.COM> with the following shell script
128snippets:
129
130 # Bourne/Korn/POSIX family of shells:
131 [ ${TERM:-foo} = foo ] && TERM=xterm # assume an xterm if we don't know
132 if [ ${TERM:-foo} = xterm ]; then
133 stty -icanon -echo min 0 time 15 # see if enhanced rxvt or not
134 echo -n '^[Z'
135 read term_id
136 stty icanon echo
137 if [ ""${term_id} = '^[[?1;2C' -a ${DISPLAY:-foo} = foo ]; then
138 echo -n '^[[7n' # query the rxvt we are in for the DISPLAY string
139 read DISPLAY # set it in our local shell
140 fi
141 fi
142
143=head3 How do I compile the manual pages on my own?
144
145You need to have a recent version of perl installed as F</usr/bin/perl>,
146one that comes with F<pod2man>, F<pod2text> and F<pod2xhtml> (from
147F<Pod::Xhtml>). Then go to the doc subdirectory and enter C<make alldoc>.
148
149=head3 Isn't rxvt-unicode supposed to be small? Don't all those features bloat?
150
151I often get asked about this, and I think, no, they didn't cause extra
152bloat. If you compare a minimal rxvt and a minimal urxvt, you can see
153that the urxvt binary is larger (due to some encoding tables always being
154compiled in), but it actually uses less memory (RSS) after startup. Even
155with C<--disable-everything>, this comparison is a bit unfair, as many
156features unique to urxvt (locale, encoding conversion, iso14755 etc.) are
157already in use in this mode.
158
159 text data bss drs rss filename
160 98398 1664 24 15695 1824 rxvt --disable-everything
161 188985 9048 66616 18222 1788 urxvt --disable-everything
162
163When you C<--enable-everything> (which I<is> unfair, as this involves xft
164and full locale/XIM support which are quite bloaty inside libX11 and my
165libc), the two diverge, but not unreasonably so.
166
167 text data bss drs rss filename
168 163431 2152 24 20123 2060 rxvt --enable-everything
169 1035683 49680 66648 29096 3680 urxvt --enable-everything
170
171The very large size of the text section is explained by the east-asian
172encoding tables, which, if unused, take up disk space but nothing else
173and can be compiled out unless you rely on X11 core fonts that use those
174encodings. The BSS size comes from the 64k emergency buffer that my c++
175compiler allocates (but of course doesn't use unless you are out of
176memory). Also, using an xft font instead of a core font immediately adds a
177few megabytes of RSS. Xft indeed is responsible for a lot of RSS even when
178not used.
179
180Of course, due to every character using two or four bytes instead of one,
181a large scrollback buffer will ultimately make rxvt-unicode use more
182memory.
183
184Compared to e.g. Eterm (5112k), aterm (3132k) and xterm (4680k), this
185still fares rather well. And compared to some monsters like gnome-terminal
186(21152k + extra 4204k in separate processes) or konsole (22200k + extra
18743180k in daemons that stay around after exit, plus half a minute of
188startup time, including the hundreds of warnings it spits out), it fares
189extremely well *g*.
190
191=head3 Why C++, isn't that unportable/bloated/uncool?
192
193Is this a question? :) It comes up very often. The simple answer is: I had
194to write it, and C++ allowed me to write and maintain it in a fraction
195of the time and effort (which is a scarce resource for me). Put even
196shorter: It simply wouldn't exist without C++.
197
198My personal stance on this is that C++ is less portable than C, but in
199the case of rxvt-unicode this hardly matters, as its portability limits
200are defined by things like X11, pseudo terminals, locale support and unix
201domain sockets, which are all less portable than C++ itself.
202
203Regarding the bloat, see the above question: It's easy to write programs
204in C that use gobs of memory, an certainly possible to write programs in
205C++ that don't. C++ also often comes with large libraries, but this is
206not necessarily the case with GCC. Here is what rxvt links against on my
207system with a minimal config:
208
209 libX11.so.6 => /usr/X11R6/lib/libX11.so.6 (0x00002aaaaabc3000)
210 libc.so.6 => /lib/libc.so.6 (0x00002aaaaadde000)
211 libdl.so.2 => /lib/libdl.so.2 (0x00002aaaab01d000)
212 /lib64/ld-linux-x86-64.so.2 (0x00002aaaaaaab000)
213
214And here is rxvt-unicode:
215
216 libX11.so.6 => /usr/X11R6/lib/libX11.so.6 (0x00002aaaaabc3000)
217 libgcc_s.so.1 => /lib/libgcc_s.so.1 (0x00002aaaaada2000)
218 libc.so.6 => /lib/libc.so.6 (0x00002aaaaaeb0000)
219 libdl.so.2 => /lib/libdl.so.2 (0x00002aaaab0ee000)
220 /lib64/ld-linux-x86-64.so.2 (0x00002aaaaaaab000)
221
222No large bloated libraries (of course, none were linked in statically),
223except maybe libX11 :)
224
225
226=head2 Rendering, Font & Look and Feel Issues
227
228=head3 I can't get transparency working, what am I doing wrong?
229
230First of all, transparency isn't officially supported in rxvt-unicode, so
231you are mostly on your own. Do not bug the author about it (but you may
232bug everybody else). Also, if you can't get it working consider it a rite
233of passage: ... and you failed.
234
235Here are four ways to get transparency. B<Do> read the manpage and option
236descriptions for the programs mentioned and rxvt-unicode. Really, do it!
237
2381. Use transparent mode:
239
240 Esetroot wallpaper.jpg
241 @@URXVT_NAME@@ -tr -tint red -sh 40
242
243That works. If you think it doesn't, you lack transparency and tinting
244support, or you are unable to read.
245
2462. Use a simple pixmap and emulate pseudo-transparency. This enables you
247to use effects other than tinting and shading: Just shade/tint/whatever
248your picture with gimp or any other tool:
249
250 convert wallpaper.jpg -blur 20x20 -modulate 30 background.jpg
251 @@URXVT_NAME@@ -pixmap "background.jpg;:root"
252
253That works. If you think it doesn't, you lack libAfterImage or GDK-PixBuf support, or you
254are unable to read.
255
2563. Use an ARGB visual:
257
258 @@URXVT_NAME@@ -depth 32 -fg grey90 -bg rgba:0000/0000/4444/cccc
259
260This requires XFT support, and the support of your X-server. If that
261doesn't work for you, blame Xorg and Keith Packard. ARGB visuals aren't
262there yet, no matter what they claim. Rxvt-Unicode contains the necessary
263bugfixes and workarounds for Xft and Xlib to make it work, but that
264doesn't mean that your WM has the required kludges in place.
265
2664. Use xcompmgr and let it do the job:
267
268 xprop -frame -f _NET_WM_WINDOW_OPACITY 32c \
269 -set _NET_WM_WINDOW_OPACITY 0xc0000000
270
271Then click on a window you want to make transparent. Replace C<0xc0000000>
272by other values to change the degree of opacity. If it doesn't work and
273your server crashes, you got to keep the pieces.
274
275=head3 Why does rxvt-unicode sometimes leave pixel droppings?
276
277Most fonts were not designed for terminal use, which means that character
278size varies a lot. A font that is otherwise fine for terminal use might
279contain some characters that are simply too wide. Rxvt-unicode will avoid
280these characters. For characters that are just "a bit" too wide a special
281"careful" rendering mode is used that redraws adjacent characters.
282
283All of this requires that fonts do not lie about character sizes,
284however: Xft fonts often draw glyphs larger than their acclaimed bounding
285box, and rxvt-unicode has no way of detecting this (the correct way is to
286ask for the character bounding box, which unfortunately is wrong in these
287cases).
288
289It's not clear (to me at least), whether this is a bug in Xft, freetype,
290or the respective font. If you encounter this problem you might try using
291the C<-lsp> option to give the font more height. If that doesn't work, you
292might be forced to use a different font.
293
294All of this is not a problem when using X11 core fonts, as their bounding
295box data is correct.
296
297=head3 How can I keep rxvt-unicode from using reverse video so much?
298
299First of all, make sure you are running with the right terminal settings
300(C<TERM=rxvt-unicode>), which will get rid of most of these effects. Then
301make sure you have specified colours for italic and bold, as otherwise
302rxvt-unicode might use reverse video to simulate the effect:
303
304 URxvt.colorBD: white
305 URxvt.colorIT: green
306
307=head3 Some programs assume totally weird colours (red instead of blue), how can I fix that?
308
309For some unexplainable reason, some rare programs assume a very weird
310colour palette when confronted with a terminal with more than the standard
3118 colours (rxvt-unicode supports 88). The right fix is, of course, to fix
312these programs not to assume non-ISO colours without very good reasons.
313
314In the meantime, you can either edit your C<rxvt-unicode> terminfo
315definition to only claim 8 colour support or use C<TERM=rxvt>, which will
316fix colours but keep you from using other rxvt-unicode features.
317
318=head3 Can I switch the fonts at runtime?
319
320Yes, using an escape sequence. Try something like this, which has the same
321effect as using the C<-fn> switch, and takes effect immediately:
322
323 printf '\33]50;%s\007' "9x15bold,xft:Kochi Gothic"
324
325This is useful if you e.g. work primarily with japanese (and prefer a
326japanese font), but you have to switch to chinese temporarily, where
327japanese fonts would only be in your way.
328
329You can think of this as a kind of manual ISO-2022 switching.
330
331=head3 Why do italic characters look as if clipped?
332
333Many fonts have difficulties with italic characters and hinting. For
334example, the otherwise very nicely hinted font C<xft:Bitstream Vera Sans
335Mono> completely fails in its italic face. A workaround might be to
336enable freetype autohinting, i.e. like this:
337
338 URxvt.italicFont: xft:Bitstream Vera Sans Mono:italic:autohint=true
339 URxvt.boldItalicFont: xft:Bitstream Vera Sans Mono:bold:italic:autohint=true
340
481=item Can I speed up Xft rendering somehow? 341=head3 Can I speed up Xft rendering somehow?
482 342
483Yes, the most obvious way to speed it up is to avoid Xft entirely, as 343Yes, the most obvious way to speed it up is to avoid Xft entirely, as
484it is simply slow. If you still want Xft fonts you might try to disable 344it is simply slow. If you still want Xft fonts you might try to disable
485antialiasing (by appending C<:antialiasing=false>), which saves lots of 345antialiasing (by appending C<:antialias=false>), which saves lots of
486memory and also speeds up rendering considerably. 346memory and also speeds up rendering considerably.
487 347
488=item Rxvt-unicode doesn't seem to anti-alias its fonts, what is wrong? 348=head3 Rxvt-unicode doesn't seem to anti-alias its fonts, what is wrong?
489 349
490Rxvt-unicode will use whatever you specify as a font. If it needs to 350Rxvt-unicode will use whatever you specify as a font. If it needs to
491fall back to it's default font search list it will prefer X11 core 351fall back to its default font search list it will prefer X11 core
492fonts, because they are small and fast, and then use Xft fonts. It has 352fonts, because they are small and fast, and then use Xft fonts. It has
493antialiasing disabled for most of them, because the author thinks they 353antialiasing disabled for most of them, because the author thinks they
494look best that way. 354look best that way.
495 355
496If you want antialiasing, you have to specify the fonts manually. 356If you want antialiasing, you have to specify the fonts manually.
497 357
498=item Mouse cut/paste suddenly no longer works.
499
500Make sure that mouse reporting is actually turned off since killing
501some editors prematurely may leave the mouse in mouse report mode. I've
502heard that tcsh may use mouse reporting unless it otherwise specified. A
503quick check is to see if cut/paste works when the Alt or Shift keys are
504depressed. See @@RXVT_NAME@@(7)
505
506=item What's with this bold/blink stuff? 358=head3 What's with this bold/blink stuff?
507 359
508If no bold colour is set via C<colorBD:>, bold will invert text using the 360If no bold colour is set via C<colorBD:>, bold will invert text using the
509standard foreground colour. 361standard foreground colour.
510 362
511For the standard background colour, blinking will actually make the 363For the standard background colour, blinking will actually make
512text blink when compiled with C<--enable-blinking>. with standard 364the text blink when compiled with C<--enable-text-blink>. Without
513colours. Without C<--enable-blinking>, the blink attribute will be 365C<--enable-text-blink>, the blink attribute will be ignored.
514ignored.
515 366
516On ANSI colours, bold/blink attributes are used to set high-intensity 367On ANSI colours, bold/blink attributes are used to set high-intensity
517foreground/background colors. 368foreground/background colours.
518 369
519color0-7 are the low-intensity colors. 370color0-7 are the low-intensity colours.
520 371
521color8-15 are the corresponding high-intensity colors. 372color8-15 are the corresponding high-intensity colours.
522 373
523=item I don't like the screen colors. How do I change them? 374=head3 I don't like the screen colours. How do I change them?
524 375
525You can change the screen colors at run-time using F<~/.Xdefaults> 376You can change the screen colours at run-time using F<~/.Xdefaults>
526resources (or as long-options). 377resources (or as long-options).
527 378
528Here are values that are supposed to resemble a VGA screen, 379Here are values that are supposed to resemble a VGA screen,
529including the murky brown that passes for low-intensity yellow: 380including the murky brown that passes for low-intensity yellow:
530 381
544 URxvt.color12: #0000FF 395 URxvt.color12: #0000FF
545 URxvt.color13: #FF00FF 396 URxvt.color13: #FF00FF
546 URxvt.color14: #00FFFF 397 URxvt.color14: #00FFFF
547 URxvt.color15: #FFFFFF 398 URxvt.color15: #FFFFFF
548 399
549And here is a more complete set of non-standard colors described (not by 400And here is a more complete set of non-standard colours.
550me) as "pretty girly".
551 401
552 URxvt.cursorColor: #dc74d1 402 URxvt.cursorColor: #dc74d1
553 URxvt.pointerColor: #dc74d1 403 URxvt.pointerColor: #dc74d1
554 URxvt.background: #0e0e0e 404 URxvt.background: #0e0e0e
555 URxvt.foreground: #4ad5e1 405 URxvt.foreground: #4ad5e1
566 URxvt.color6: #73f7ff 416 URxvt.color6: #73f7ff
567 URxvt.color14: #73f7ff 417 URxvt.color14: #73f7ff
568 URxvt.color7: #e1dddd 418 URxvt.color7: #e1dddd
569 URxvt.color15: #e1dddd 419 URxvt.color15: #e1dddd
570 420
571=item How can I start @@RXVT_NAME@@d in a race-free way? 421They have been described (not by me) as "pretty girly".
572 422
573Despite it's name, @@RXVT_NAME@@d is not a real daemon, but more like a 423=head3 Why do some characters look so much different than others?
574server that answers @@RXVT_NAME@@c's requests, so it doesn't background
575itself.
576 424
577To ensure @@RXVT_NAME@@d is listening on it's socket, you can use the 425See next entry.
578following method to wait for the startup message before continuing:
579 426
580 { @@RXVT_NAME@@d & } | read 427=head3 How does rxvt-unicode choose fonts?
581 428
429Most fonts do not contain the full range of Unicode, which is
430fine. Chances are that the font you (or the admin/package maintainer of
431your system/os) have specified does not cover all the characters you want
432to display.
433
434B<rxvt-unicode> makes a best-effort try at finding a replacement
435font. Often the result is fine, but sometimes the chosen font looks
436bad/ugly/wrong. Some fonts have totally strange characters that don't
437resemble the correct glyph at all, and rxvt-unicode lacks the artificial
438intelligence to detect that a specific glyph is wrong: it has to believe
439the font that the characters it claims to contain indeed look correct.
440
441In that case, select a font of your taste and add it to the font list,
442e.g.:
443
444 @@URXVT_NAME@@ -fn basefont,font2,font3...
445
446When rxvt-unicode sees a character, it will first look at the base
447font. If the base font does not contain the character, it will go to the
448next font, and so on. Specifying your own fonts will also speed up this
449search and use less resources within rxvt-unicode and the X-server.
450
451The only limitation is that none of the fonts may be larger than the base
452font, as the base font defines the terminal character cell size, which
453must be the same due to the way terminals work.
454
455=head3 Why do some chinese characters look so different than others?
456
457This is because there is a difference between script and language --
458rxvt-unicode does not know which language the text that is output is,
459as it only knows the unicode character codes. If rxvt-unicode first
460sees a japanese/chinese character, it might choose a japanese font for
461display. Subsequent japanese characters will use that font. Now, many
462chinese characters aren't represented in japanese fonts, so when the first
463non-japanese character comes up, rxvt-unicode will look for a chinese font
464-- unfortunately at this point, it will still use the japanese font for
465chinese characters that are also in the japanese font.
466
467The workaround is easy: just tag a chinese font at the end of your font
468list (see the previous question). The key is to view the font list as
469a preference list: If you expect more japanese, list a japanese font
470first. If you expect more chinese, put a chinese font first.
471
472In the future it might be possible to switch language preferences at
473runtime (the internal data structure has no problem with using different
474fonts for the same character at the same time, but no interface for this
475has been designed yet).
476
477Until then, you might get away with switching fonts at runtime (see L<Can
478I switch the fonts at runtime?> later in this document).
479
480=head3 How can I make mplayer display video correctly?
481
482We are working on it, in the meantime, as a workaround, use something like:
483
484 @@URXVT_NAME@@ -b 600 -geometry 20x1 -e sh -c 'mplayer -wid $WINDOWID file...'
485
486
487=head2 Keyboard, Mouse & User Interaction
488
489=head3 The new selection selects pieces that are too big, how can I select single words?
490
491If you want to select e.g. alphanumeric words, you can use the following
492setting:
493
494 URxvt.selection.pattern-0: ([[:word:]]+)
495
496If you click more than twice, the selection will be extended
497more and more.
498
499To get a selection that is very similar to the old code, try this pattern:
500
501 URxvt.selection.pattern-0: ([^"&'()*,;<=>?@[\\\\]^`{|})]+)
502
503Please also note that the I<LeftClick Shift-LeftClick> combination also
504selects words like the old code.
505
506=head3 I don't like the new selection/popups/hotkeys/perl, how do I change/disable it?
507
508You can disable the perl extension completely by setting the
509B<perl-ext-common> resource to the empty string, which also keeps
510rxvt-unicode from initialising perl, saving memory.
511
512If you only want to disable specific features, you first have to
513identify which perl extension is responsible. For this, read the section
514B<PREPACKAGED EXTENSIONS> in the @@URXVT_NAME@@perl(3) manpage. For
515example, to disable the B<selection-popup> and B<option-popup>, specify
516this B<perl-ext-common> resource:
517
518 URxvt.perl-ext-common: default,-selection-popup,-option-popup
519
520This will keep the default extensions, but disable the two popup
521extensions. Some extensions can also be configured, for example,
522scrollback search mode is triggered by B<M-s>. You can move it to any
523other combination either by setting the B<searchable-scrollback> resource:
524
525 URxvt.searchable-scrollback: CM-s
526
527=head3 The cursor moves when selecting text in the current input line, how do I switch this off?
528
529See next entry.
530
531=head3 During rlogin/ssh/telnet/etc. sessions, clicking near the cursor outputs strange escape sequences, how do I fix this?
532
533These are caused by the C<readline> perl extension. Under normal
534circumstances, it will move your cursor around when you click into the
535line that contains it. It tries hard not to do this at the wrong moment,
536but when running a program that doesn't parse cursor movements or in some
537cases during rlogin sessions, it fails to detect this properly.
538
539You can permanently switch this feature off by disabling the C<readline>
540extension:
541
542 URxvt.perl-ext-common: default,-readline
543
544=head3 My numerical keypad acts weird and generates differing output?
545
546Some Debian GNUL/Linux users seem to have this problem, although no
547specific details were reported so far. It is possible that this is caused
548by the wrong C<TERM> setting, although the details of whether and how
549this can happen are unknown, as C<TERM=rxvt> should offer a compatible
550keymap. See the answer to the previous question, and please report if that
551helped.
552
553=head3 My Compose (Multi_key) key is no longer working.
554
555The most common causes for this are that either your locale is not set
556correctly, or you specified a B<preeditStyle> that is not supported by
557your input method. For example, if you specified B<OverTheSpot> and
558your input method (e.g. the default input method handling Compose keys)
559does not support this (for instance because it is not visual), then
560rxvt-unicode will continue without an input method.
561
562In this case either do not specify a B<preeditStyle> or specify more than
563one pre-edit style, such as B<OverTheSpot,Root,None>.
564
565If it still doesn't work, then maybe your input method doesn't support
566compose sequences - to fall back to the built-in one, make sure you don't
567specify an input method via C<-im> or C<XMODIFIERS>.
568
569=head3 I cannot type C<Ctrl-Shift-2> to get an ASCII NUL character due to ISO 14755
570
571Either try C<Ctrl-2> alone (it often is mapped to ASCII NUL even on
572international keyboards) or simply use ISO 14755 support to your
573advantage, typing <Ctrl-Shift-0> to get a ASCII NUL. This works for other
574codes, too, such as C<Ctrl-Shift-1-d> to type the default telnet escape
575character and so on.
576
577=head3 Mouse cut/paste suddenly no longer works.
578
579Make sure that mouse reporting is actually turned off since killing
580some editors prematurely may leave the mouse in mouse report mode. I've
581heard that tcsh may use mouse reporting unless it otherwise specified. A
582quick check is to see if cut/paste works when the Alt or Shift keys are
583depressed.
584
582=item What's with the strange Backspace/Delete key behaviour? 585=head3 What's with the strange Backspace/Delete key behaviour?
583 586
584Assuming that the physical Backspace key corresponds to the 587Assuming that the physical Backspace key corresponds to the
585BackSpace keysym (not likely for Linux ... see the following 588Backspace keysym (not likely for Linux ... see the following
586question) there are two standard values that can be used for 589question) there are two standard values that can be used for
587Backspace: C<^H> and C<^?>. 590Backspace: C<^H> and C<^?>.
588 591
589Historically, either value is correct, but rxvt-unicode adopts the debian 592Historically, either value is correct, but rxvt-unicode adopts the debian
590policy of using C<^?> when unsure, because it's the one only only correct 593policy of using C<^?> when unsure, because it's the one and only correct
591choice :). 594choice :).
592 595
593Rxvt-unicode tries to inherit the current stty settings and uses the value 596It is possible to toggle between C<^H> and C<^?> with the DECBKM
594of `erase' to guess the value for backspace. If rxvt-unicode wasn't 597private mode:
595started from a terminal (say, from a menu or by remote shell), then the
596system value of `erase', which corresponds to CERASE in <termios.h>, will
597be used (which may not be the same as your stty setting).
598
599For starting a new rxvt-unicode:
600 598
601 # use Backspace = ^H 599 # use Backspace = ^H
602 $ stty erase ^H 600 $ stty erase ^H
603 $ @@RXVT_NAME@@ 601 $ echo -n "^[[?67h"
604 602
605 # use Backspace = ^? 603 # use Backspace = ^?
606 $ stty erase ^? 604 $ stty erase ^?
607 $ @@RXVT_NAME@@
608
609Toggle with C<ESC [ 36 h> / C<ESC [ 36 l> as documented in @@RXVT_NAME@@(7).
610
611For an existing rxvt-unicode:
612
613 # use Backspace = ^H
614 $ stty erase ^H
615 $ echo -n "^[[36h"
616
617 # use Backspace = ^?
618 $ stty erase ^?
619 $ echo -n "^[[36l" 605 $ echo -n "^[[?67l"
620 606
621This helps satisfy some of the Backspace discrepancies that occur, but 607This helps satisfy some of the Backspace discrepancies that occur, but
622if you use Backspace = C<^H>, make sure that the termcap/terminfo value 608if you use Backspace = C<^H>, make sure that the termcap/terminfo value
623properly reflects that. 609properly reflects that.
624 610
633some editors (vim I'm told) expect Backspace = ^H, 619some editors (vim I'm told) expect Backspace = ^H,
634GNU Emacs (and Emacs-like editors) use ^H for help. 620GNU Emacs (and Emacs-like editors) use ^H for help.
635 621
636Perhaps someday this will all be resolved in a consistent manner. 622Perhaps someday this will all be resolved in a consistent manner.
637 623
638=item I don't like the key-bindings. How do I change them? 624=head3 I don't like the key-bindings. How do I change them?
639 625
640There are some compile-time selections available via configure. Unless 626There are some compile-time selections available via configure. Unless
641you have run "configure" with the C<--disable-resources> option you can 627you have run "configure" with the C<--disable-resources> option you can
642use the `keysym' resource to alter the keystrings associated with keysyms. 628use the `keysym' resource to alter the keystrings associated with keysyms.
643 629
644Here's an example for a URxvt session started using C<@@RXVT_NAME@@ -name URxvt> 630Here's an example for a URxvt session started using C<@@URXVT_NAME@@ -name URxvt>
645 631
646 URxvt.keysym.Home: \033[1~ 632 URxvt.keysym.Home: \033[1~
647 URxvt.keysym.End: \033[4~ 633 URxvt.keysym.End: \033[4~
648 URxvt.keysym.C-apostrophe: \033<C-'> 634 URxvt.keysym.C-apostrophe: \033<C-'>
649 URxvt.keysym.C-slash: \033<C-/> 635 URxvt.keysym.C-slash: \033<C-/>
664 URxvt.keysym.M-C-a: list \033<M-C- abcdefghijklmnopqrstuvwxyz > 650 URxvt.keysym.M-C-a: list \033<M-C- abcdefghijklmnopqrstuvwxyz >
665 URxvt.keysym.F12: command:\033]701;zh_CN.GBK\007 651 URxvt.keysym.F12: command:\033]701;zh_CN.GBK\007
666 652
667See some more examples in the documentation for the B<keysym> resource. 653See some more examples in the documentation for the B<keysym> resource.
668 654
669=item I'm using keyboard model XXX that has extra Prior/Next/Insert keys. 655=head3 I'm using keyboard model XXX that has extra Prior/Next/Insert keys. How do I make use of them? For example, the Sun Keyboard type 4 has the following map
670How do I make use of them? For example, the Sun Keyboard type 4
671has the following mappings that rxvt-unicode doesn't recognize.
672 656
673 KP_Insert == Insert 657 KP_Insert == Insert
674 F22 == Print 658 F22 == Print
675 F27 == Home 659 F27 == Home
676 F29 == Prior 660 F29 == Prior
679 663
680Rather than have rxvt-unicode try to accommodate all the various possible 664Rather than have rxvt-unicode try to accommodate all the various possible
681keyboard mappings, it is better to use `xmodmap' to remap the keys as 665keyboard mappings, it is better to use `xmodmap' to remap the keys as
682required for your particular machine. 666required for your particular machine.
683 667
684=item How do I distinguish wether I'm running rxvt-unicode or a regular xterm?
685I need this to decide about setting colors etc.
686 668
687rxvt and rxvt-unicode always export the variable "COLORTERM", so you can 669=head2 Terminal Configuration
688check and see if that is set. Note that several programs, JED, slrn,
689Midnight Commander automatically check this variable to decide whether or
690not to use color.
691 670
692=item How do I set the correct, full IP address for the DISPLAY variable? 671=head3 Can I see a typical configuration?
693 672
694If you've compiled rxvt-unicode with DISPLAY_IS_IP and have enabled 673The default configuration tries to be xterm-like, which I don't like that
695insecure mode then it is possible to use the following shell script 674much, but it's least surprise to regular users.
696snippets to correctly set the display. If your version of rxvt-unicode
697wasn't also compiled with ESCZ_ANSWER (as assumed in these snippets) then
698the COLORTERM variable can be used to distinguish rxvt-unicode from a
699regular xterm.
700 675
701Courtesy of Chuck Blake <cblake@BBN.COM> with the following shell script 676As a rxvt or rxvt-unicode user, you are practically supposed to invest
702snippets: 677time into customising your terminal. To get you started, here is the
678author's .Xdefaults entries, with comments on what they do. It's certainly
679not I<typical>, but what's typical...
703 680
704 # Bourne/Korn/POSIX family of shells: 681 URxvt.cutchars: "()*,<>[]{}|'
705 [ ${TERM:-foo} = foo ] && TERM=xterm # assume an xterm if we don't know 682 URxvt.print-pipe: cat >/tmp/xxx
706 if [ ${TERM:-foo} = xterm ]; then
707 stty -icanon -echo min 0 time 15 # see if enhanced rxvt or not
708 echo -n '^[Z'
709 read term_id
710 stty icanon echo
711 if [ ""${term_id} = '^[[?1;2C' -a ${DISPLAY:-foo} = foo ]; then
712 echo -n '^[[7n' # query the rxvt we are in for the DISPLAY string
713 read DISPLAY # set it in our local shell
714 fi
715 fi
716 683
717=item How do I compile the manual pages for myself? 684These are just for testing stuff.
718 685
719You need to have a recent version of perl installed as F</usr/bin/perl>, 686 URxvt.imLocale: ja_JP.UTF-8
720one that comes with F<pod2man>, F<pod2text> and F<pod2html>. Then go to 687 URxvt.preeditType: OnTheSpot,None
721the doc subdirectory and enter C<make alldoc>.
722 688
723=item My question isn't answered here, can I ask a human? 689This tells rxvt-unicode to use a special locale when communicating with
690the X Input Method, and also tells it to only use the OnTheSpot pre-edit
691type, which requires the C<xim-onthespot> perl extension but rewards me
692with correct-looking fonts.
724 693
725Before sending me mail, you could go to IRC: C<irc.freenode.net>, 694 URxvt.perl-lib: /root/lib/urxvt
726channel C<#rxvt-unicode> has some rxvt-unicode enthusiasts that might be 695 URxvt.perl-ext-common: default,selection-autotransform,selection-pastebin,xim-onthespot,remote-clipboard
727interested in learning about new and exciting problems (but not FAQs :). 696 URxvt.selection.pattern-0: ( at .*? line \\d+)
697 URxvt.selection.pattern-1: ^(/[^:]+):\
698 URxvt.selection-autotransform.0: s/^([^:[:space:]]+):(\\d+):?$/:e \\Q$1\\E\\x0d:$2\\x0d/
699 URxvt.selection-autotransform.1: s/^ at (.*?) line (\\d+)$/:e \\Q$1\\E\\x0d:$2\\x0d/
700
701This is my perl configuration. The first two set the perl library
702directory and also tells urxvt to use a large number of extensions. I
703develop for myself mostly, so I actually use most of the extensions I
704write.
705
706The selection stuff mainly makes the selection perl-error-message aware
707and tells it to convert perl error messages into vi-commands to load the
708relevant file and go to the error line number.
709
710 URxvt.scrollstyle: plain
711 URxvt.secondaryScroll: true
712
713As the documentation says: plain is the preferred scrollbar for the
714author. The C<secondaryScroll> configures urxvt to scroll in full-screen
715apps, like screen, so lines scrolled out of screen end up in urxvt's
716scrollback buffer.
717
718 URxvt.background: #000000
719 URxvt.foreground: gray90
720 URxvt.color7: gray90
721 URxvt.colorBD: #ffffff
722 URxvt.cursorColor: #e0e080
723 URxvt.throughColor: #8080f0
724 URxvt.highlightColor: #f0f0f0
725
726Some colours. Not sure which ones are being used or even non-defaults, but
727these are in my .Xdefaults. Most notably, they set foreground/background
728to light gray/black, and also make sure that the colour 7 matches the
729default foreground colour.
730
731 URxvt.underlineColor: yellow
732
733Another colour, makes underline lines look different. Sometimes hurts, but
734is mostly a nice effect.
735
736 URxvt.geometry: 154x36
737 URxvt.loginShell: false
738 URxvt.meta: ignore
739 URxvt.utmpInhibit: true
740
741Uh, well, should be mostly self-explanatory. By specifying some defaults
742manually, I can quickly switch them for testing.
743
744 URxvt.saveLines: 8192
745
746A large scrollback buffer is essential. Really.
747
748 URxvt.mapAlert: true
749
750The only case I use it is for my IRC window, which I like to keep
751iconified till people msg me (which beeps).
752
753 URxvt.visualBell: true
754
755The audible bell is often annoying, especially when in a crowd.
756
757 URxvt.insecure: true
758
759Please don't hack my mutt! Ooops...
760
761 URxvt.pastableTabs: false
762
763I once thought this is a great idea.
764
765 urxvt.font: 9x15bold,\
766 -misc-fixed-bold-r-normal--15-140-75-75-c-90-iso10646-1,\
767 -misc-fixed-medium-r-normal--15-140-75-75-c-90-iso10646-1, \
768 [codeset=JISX0208]xft:Kochi Gothic, \
769 xft:Bitstream Vera Sans Mono:autohint=true, \
770 xft:Code2000:antialias=false
771 urxvt.boldFont: -xos4-terminus-bold-r-normal--14-140-72-72-c-80-iso8859-15
772 urxvt.italicFont: xft:Bitstream Vera Sans Mono:italic:autohint=true
773 urxvt.boldItalicFont: xft:Bitstream Vera Sans Mono:bold:italic:autohint=true
774
775I wrote rxvt-unicode to be able to specify fonts exactly. So don't be
776overwhelmed. A special note: the C<9x15bold> mentioned above is actually
777the version from XFree-3.3, as XFree-4 replaced it by a totally different
778font (different glyphs for C<;> and many other harmless characters),
779while the second font is actually the C<9x15bold> from XFree4/XOrg. The
780bold version has less chars than the medium version, so I use it for rare
781characters, too. When editing sources with vim, I use italic for comments
782and other stuff, which looks quite good with Bitstream Vera anti-aliased.
783
784Terminus is a quite bad font (many very wrong glyphs), but for most of my
785purposes, it works, and gives a different look, as my normal (Non-bold)
786font is already bold, and I want to see a difference between bold and
787normal fonts.
788
789Please note that I used the C<urxvt> instance name and not the C<URxvt>
790class name. That is because I use different configs for different purposes,
791for example, my IRC window is started with C<-name IRC>, and uses these
792defaults:
793
794 IRC*title: IRC
795 IRC*geometry: 87x12+535+542
796 IRC*saveLines: 0
797 IRC*mapAlert: true
798 IRC*font: suxuseuro
799 IRC*boldFont: suxuseuro
800 IRC*colorBD: white
801 IRC*keysym.M-C-1: command:\033]710;suxuseuro\007\033]711;suxuseuro\007
802 IRC*keysym.M-C-2: command:\033]710;9x15bold\007\033]711;9x15bold\007
803
804C<Alt-Ctrl-1> and C<Alt-Ctrl-2> switch between two different font
805sizes. C<suxuseuro> allows me to keep an eye (and actually read)
806stuff while keeping a very small window. If somebody pastes something
807complicated (e.g. japanese), I temporarily switch to a larger font.
808
809The above is all in my C<.Xdefaults> (I don't use C<.Xresources> nor
810C<xrdb>). I also have some resources in a separate C<.Xdefaults-hostname>
811file for different hosts, for example, on my main desktop, I use:
812
813 URxvt.keysym.C-M-q: command:\033[3;5;5t
814 URxvt.keysym.C-M-y: command:\033[3;5;606t
815 URxvt.keysym.C-M-e: command:\033[3;1605;5t
816 URxvt.keysym.C-M-c: command:\033[3;1605;606t
817 URxvt.keysym.C-M-p: perl:test
818
819The first for keysym definitions allow me to quickly bring some windows
820in the layout I like most. Ion users might start laughing but will stop
821immediately when I tell them that I use my own Fvwm2 module for much the
822same effect as Ion provides, and I only very rarely use the above key
823combinations :->
824
825=head3 Why doesn't rxvt-unicode read my resources?
826
827Well, why, indeed? It does, in a way very similar to other X
828applications. Most importantly, this means that if you or your OS loads
829resources into the X display (the right way to do it), rxvt-unicode will
830ignore any resource files in your home directory. It will only read
831F<$HOME/.Xdefaults> when no resources are attached to the display.
832
833If you have or use an F<$HOME/.Xresources> file, chances are that
834resources are loaded into your X-server. In this case, you have to
835re-login after every change (or run F<xrdb -merge $HOME/.Xresources>).
836
837Also consider the form resources have to use:
838
839 URxvt.resource: value
840
841If you want to use another form (there are lots of different ways of
842specifying resources), make sure you understand whether and why it
843works. If unsure, use the form above.
844
845=head3 When I log-in to another system it tells me about missing terminfo data?
846
847The terminal description used by rxvt-unicode is not as widely available
848as that for xterm, or even rxvt (for which the same problem often arises).
849
850The correct solution for this problem is to install the terminfo, this can
851be done by simply installing rxvt-unicode on the remote system as well
852(in case you have a nice package manager ready), or you can install the
853terminfo database manually like this (with ncurses infocmp. works as
854user and root):
855
856 REMOTE=remotesystem.domain
857 infocmp rxvt-unicode | ssh $REMOTE "mkdir -p .terminfo && cat >/tmp/ti && tic /tmp/ti"
858
859One some systems you might need to set C<$TERMINFO> to the full path of
860F<$HOME/.terminfo> for this to work.
861
862If you cannot or do not want to do this, then you can simply set
863C<TERM=rxvt> or even C<TERM=xterm>, and live with the small number of
864problems arising, which includes wrong keymapping, less and different
865colours and some refresh errors in fullscreen applications. It's a nice
866quick-and-dirty workaround for rare cases, though.
867
868If you always want to do this (and are fine with the consequences) you
869can either recompile rxvt-unicode with the desired TERM value or use a
870resource to set it:
871
872 URxvt.termName: rxvt
873
874If you don't plan to use B<rxvt> (quite common...) you could also replace
875the rxvt terminfo file with the rxvt-unicode one and use C<TERM=rxvt>.
876
877=head3 nano fails with "Error opening terminal: rxvt-unicode"
878
879This exceptionally confusing and useless error message is printed by nano
880when it can't find the terminfo database. Nothing is wrong with your
881terminal, read the previous answer for a solution.
882
883=head3 C<tic> outputs some error when compiling the terminfo entry.
884
885Most likely it's the empty definition for C<enacs=>. Just replace it by
886C<enacs=\E[0@> and try again.
887
888=head3 C<bash>'s readline does not work correctly under @@URXVT_NAME@@.
889
890See next entry.
891
892=head3 I need a termcap file entry.
893
894One reason you might want this is that some distributions or operating
895systems still compile some programs using the long-obsoleted termcap
896library (Fedora Core's bash is one example) and rely on a termcap entry
897for C<rxvt-unicode>.
898
899You could use rxvt's termcap entry with reasonable results in many cases.
900You can also create a termcap entry by using terminfo's infocmp program
901like this:
902
903 infocmp -C rxvt-unicode
904
905Or you could use the termcap entry in doc/etc/rxvt-unicode.termcap,
906generated by the command above.
907
908=head3 Why does C<ls> no longer have coloured output?
909
910The C<ls> in the GNU coreutils unfortunately doesn't use terminfo to
911decide whether a terminal has colour, but uses its own configuration
912file. Needless to say, C<rxvt-unicode> is not in its default file (among
913with most other terminals supporting colour). Either add:
914
915 TERM rxvt-unicode
916
917to C</etc/DIR_COLORS> or simply add:
918
919 alias ls='ls --color=auto'
920
921to your C<.profile> or C<.bashrc>.
922
923=head3 Why doesn't vim/emacs etc. use the 88 colour mode?
924
925See next entry.
926
927=head3 Why doesn't vim/emacs etc. make use of italic?
928
929See next entry.
930
931=head3 Why are the secondary screen-related options not working properly?
932
933Make sure you are using C<TERM=rxvt-unicode>. Some pre-packaged
934distributions (most notably Debian GNU/Linux) break rxvt-unicode
935by setting C<TERM> to C<rxvt>, which doesn't have these extra
936features. Unfortunately, some of these (most notably, again, Debian
937GNU/Linux) furthermore fail to even install the C<rxvt-unicode> terminfo
938file, so you will need to install it on your own (See the question B<When
939I log-in to another system it tells me about missing terminfo data?> on
940how to do this).
941
942
943=head2 Encoding / Locale / Input Method Issues
944
945=head3 Rxvt-unicode does not seem to understand the selected encoding?
946
947See next entry.
948
949=head3 Unicode does not seem to work?
950
951If you encounter strange problems like typing an accented character but
952getting two unrelated other characters or similar, or if program output is
953subtly garbled, then you should check your locale settings.
954
955Rxvt-unicode must be started with the same C<LC_CTYPE> setting as the
956programs running in it. Often rxvt-unicode is started in the C<C> locale,
957while the login script running within the rxvt-unicode window changes the
958locale to something else, e.g. C<en_GB.UTF-8>. Needless to say, this is
959not going to work, and is the most common cause for problems.
960
961The best thing is to fix your startup environment, as you will likely run
962into other problems. If nothing works you can try this in your .profile.
963
964 printf '\33]701;%s\007' "$LC_CTYPE" # $LANG or $LC_ALL are worth a try, too
965
966If this doesn't work, then maybe you use a C<LC_CTYPE> specification not
967supported on your systems. Some systems have a C<locale> command which
968displays this (also, C<perl -e0> can be used to check locale settings, as
969it will complain loudly if it cannot set the locale). If it displays something
970like:
971
972 locale: Cannot set LC_CTYPE to default locale: ...
973
974Then the locale you specified is not supported on your system.
975
976If nothing works and you are sure that everything is set correctly then
977you will need to remember a little known fact: Some programs just don't
978support locales :(
979
980=head3 How does rxvt-unicode determine the encoding to use?
981
982See next entry.
983
984=head3 Is there an option to switch encodings?
985
986Unlike some other terminals, rxvt-unicode has no encoding switch, and no
987specific "utf-8" mode, such as xterm. In fact, it doesn't even know about
988UTF-8 or any other encodings with respect to terminal I/O.
989
990The reasons is that there exists a perfectly fine mechanism for selecting
991the encoding, doing I/O and (most important) communicating this to all
992applications so everybody agrees on character properties such as width
993and code number. This mechanism is the I<locale>. Applications not using
994that info will have problems (for example, C<xterm> gets the width of
995characters wrong as it uses its own, locale-independent table under all
996locales).
997
998Rxvt-unicode uses the C<LC_CTYPE> locale category to select encoding. All
999programs doing the same (that is, most) will automatically agree in the
1000interpretation of characters.
1001
1002Unfortunately, there is no system-independent way to select locales, nor
1003is there a standard on how locale specifiers will look like.
1004
1005On most systems, the content of the C<LC_CTYPE> environment variable
1006contains an arbitrary string which corresponds to an already-installed
1007locale. Common names for locales are C<en_US.UTF-8>, C<de_DE.ISO-8859-15>,
1008C<ja_JP.EUC-JP>, i.e. C<language_country.encoding>, but other forms
1009(i.e. C<de> or C<german>) are also common.
1010
1011Rxvt-unicode ignores all other locale categories, and except for
1012the encoding, ignores country or language-specific settings,
1013i.e. C<de_DE.UTF-8> and C<ja_JP.UTF-8> are the normally same to
1014rxvt-unicode.
1015
1016If you want to use a specific encoding you have to make sure you start
1017rxvt-unicode with the correct C<LC_CTYPE> category.
1018
1019=head3 Can I switch locales at runtime?
1020
1021Yes, using an escape sequence. Try something like this, which sets
1022rxvt-unicode's idea of C<LC_CTYPE>.
1023
1024 printf '\33]701;%s\007' ja_JP.SJIS
1025
1026See also the previous answer.
1027
1028Sometimes this capability is rather handy when you want to work in
1029one locale (e.g. C<de_DE.UTF-8>) but some programs don't support it
1030(e.g. UTF-8). For example, I use this script to start C<xjdic>, which
1031first switches to a locale supported by xjdic and back later:
1032
1033 printf '\33]701;%s\007' ja_JP.SJIS
1034 xjdic -js
1035 printf '\33]701;%s\007' de_DE.UTF-8
1036
1037You can also use xterm's C<luit> program, which usually works fine, except
1038for some locales where character width differs between program- and
1039rxvt-unicode-locales.
1040
1041=head3 I have problems getting my input method working.
1042
1043Try a search engine, as this is slightly different for every input method server.
1044
1045Here is a checklist:
1046
1047=over 4
1048
1049=item - Make sure your locale I<and> the imLocale are supported on your OS.
1050
1051Try C<locale -a> or check the documentation for your OS.
1052
1053=item - Make sure your locale or imLocale matches a locale supported by your XIM.
1054
1055For example, B<kinput2> does not support UTF-8 locales, you should use
1056C<ja_JP.EUC-JP> or equivalent.
1057
1058=item - Make sure your XIM server is actually running.
1059
1060=item - Make sure the C<XMODIFIERS> environment variable is set correctly when I<starting> rxvt-unicode.
1061
1062When you want to use e.g. B<kinput2>, it must be set to
1063C<@im=kinput2>. For B<scim>, use C<@im=SCIM>. You can see what input
1064method servers are running with this command:
1065
1066 xprop -root XIM_SERVERS
1067
1068=item
728 1069
729=back 1070=back
730 1071
1072=head3 My input method wants <some encoding> but I want UTF-8, what can I do?
1073
1074You can specify separate locales for the input method and the rest of the
1075terminal, using the resource C<imlocale>:
1076
1077 URxvt.imlocale: ja_JP.EUC-JP
1078
1079Now you can start your terminal with C<LC_CTYPE=ja_JP.UTF-8> and still
1080use your input method. Please note, however, that, depending on your Xlib
1081version, you may not be able to input characters outside C<EUC-JP> in a
1082normal way then, as your input method limits you.
1083
1084=head3 Rxvt-unicode crashes when the X Input Method changes or exits.
1085
1086Unfortunately, this is unavoidable, as the XIM protocol is racy by
1087design. Applications can avoid some crashes at the expense of memory
1088leaks, and Input Methods can avoid some crashes by careful ordering at
1089exit time. B<kinput2> (and derived input methods) generally succeeds,
1090while B<SCIM> (or similar input methods) fails. In the end, however,
1091crashes cannot be completely avoided even if both sides cooperate.
1092
1093So the only workaround is not to kill your Input Method Servers.
1094
1095
1096=head2 Operating Systems / Package Maintaining
1097
1098=head3 I am using Debian GNU/Linux and have a problem...
1099
1100The Debian GNU/Linux package of rxvt-unicode in sarge contains large
1101patches that considerably change the behaviour of rxvt-unicode (but
1102unfortunately this notice has been removed). Before reporting a bug to
1103the original rxvt-unicode author please download and install the genuine
1104version (L<http://software.schmorp.de#rxvt-unicode>) and try to reproduce
1105the problem. If you cannot, chances are that the problems are specific to
1106Debian GNU/Linux, in which case it should be reported via the Debian Bug
1107Tracking System (use C<reportbug> to report the bug).
1108
1109For other problems that also affect the Debian package, you can and
1110probably should use the Debian BTS, too, because, after all, it's also a
1111bug in the Debian version and it serves as a reminder for other users that
1112might encounter the same issue.
1113
1114=head3 I am maintaining rxvt-unicode for distribution/OS XXX, any recommendation?
1115
1116You should build one binary with the default options. F<configure>
1117now enables most useful options, and the trend goes to making them
1118runtime-switchable, too, so there is usually no drawback to enabling them,
1119except higher disk and possibly memory usage. The perl interpreter should
1120be enabled, as important functionality (menus, selection, likely more in
1121the future) depends on it.
1122
1123You should not overwrite the C<perl-ext-common> and C<perl-ext> resources
1124system-wide (except maybe with C<defaults>). This will result in useful
1125behaviour. If your distribution aims at low memory, add an empty
1126C<perl-ext-common> resource to the app-defaults file. This will keep the
1127perl interpreter disabled until the user enables it.
1128
1129If you can/want build more binaries, I recommend building a minimal
1130one with C<--disable-everything> (very useful) and a maximal one with
1131C<--enable-everything> (less useful, it will be very big due to a lot of
1132encodings built-in that increase download times and are rarely used).
1133
1134=head3 I need to make it setuid/setgid to support utmp/ptys on my OS, is this safe?
1135
1136It should be, starting with release 7.1. You are encouraged to properly
1137install urxvt with privileges necessary for your OS now.
1138
1139When rxvt-unicode detects that it runs setuid or setgid, it will fork
1140into a helper process for privileged operations (pty handling on some
1141systems, utmp/wtmp/lastlog handling on others) and drop privileges
1142immediately. This is much safer than most other terminals that keep
1143privileges while running (but is more relevant to urxvt, as it contains
1144things as perl interpreters, which might be "helpful" to attackers).
1145
1146This forking is done as the very first within main(), which is very early
1147and reduces possible bugs to initialisation code run before main(), or
1148things like the dynamic loader of your system, which should result in very
1149little risk.
1150
1151=head3 I am on FreeBSD and rxvt-unicode does not seem to work at all.
1152
1153Rxvt-unicode requires the symbol C<__STDC_ISO_10646__> to be defined
1154in your compile environment, or an implementation that implements it,
1155whether it defines the symbol or not. C<__STDC_ISO_10646__> requires that
1156B<wchar_t> is represented as unicode.
1157
1158As you might have guessed, FreeBSD does neither define this symbol nor
1159does it support it. Instead, it uses its own internal representation of
1160B<wchar_t>. This is, of course, completely fine with respect to standards.
1161
1162However, that means rxvt-unicode only works in C<POSIX>, C<ISO-8859-1> and
1163C<UTF-8> locales under FreeBSD (which all use Unicode as B<wchar_t>).
1164
1165C<__STDC_ISO_10646__> is the only sane way to support multi-language
1166apps in an OS, as using a locale-dependent (and non-standardized)
1167representation of B<wchar_t> makes it impossible to convert between
1168B<wchar_t> (as used by X11 and your applications) and any other encoding
1169without implementing OS-specific-wrappers for each and every locale. There
1170simply are no APIs to convert B<wchar_t> into anything except the current
1171locale encoding.
1172
1173Some applications (such as the formidable B<mlterm>) work around this
1174by carrying their own replacement functions for character set handling
1175with them, and either implementing OS-dependent hacks or doing multiple
1176conversions (which is slow and unreliable in case the OS implements
1177encodings slightly different than the terminal emulator).
1178
1179The rxvt-unicode author insists that the right way to fix this is in the
1180system libraries once and for all, instead of forcing every app to carry
1181complete replacements for them :)
1182
1183=head3 How can I use rxvt-unicode under cygwin?
1184
1185rxvt-unicode should compile and run out of the box on cygwin, using
1186the X11 libraries that come with cygwin. libW11 emulation is no
1187longer supported (and makes no sense, either, as it only supported a
1188single font). I recommend starting the X-server in C<-multiwindow> or
1189C<-rootless> mode instead, which will result in similar look&feel as the
1190old libW11 emulation.
1191
1192At the time of this writing, cygwin didn't seem to support any multi-byte
1193encodings (you might try C<LC_CTYPE=C-UTF-8>), so you are likely limited
1194to 8-bit encodings.
1195
1196=head3 Character widths are not correct.
1197
1198urxvt uses the system wcwidth function to know the information about
1199the width of characters, so on systems with incorrect locale data you
1200will likely get bad results. Two notorious examples are Solaris 9,
1201where single-width characters like U+2514 are reported as double-width,
1202and Darwin 8, where combining chars are reported having width 1.
1203
1204The solution is to upgrade your system or switch to a better one. A
1205possibly working workaround is to use a wcwidth implementation like
1206
1207http://www.cl.cam.ac.uk/~mgk25/ucs/wcwidth.c
1208
731=head1 RXVT TECHNICAL REFERENCE 1209=head1 RXVT-UNICODE TECHNICAL REFERENCE
732
733=head1 DESCRIPTION
734 1210
735The rest of this document describes various technical aspects of 1211The rest of this document describes various technical aspects of
736B<rxvt-unicode>. First the description of supported command sequences, 1212B<rxvt-unicode>. First the description of supported command sequences,
737followed by menu and pixmap support and last by a description of all 1213followed by pixmap support and last by a description of all features
738features selectable at C<configure> time. 1214selectable at C<configure> time.
739 1215
740=head1 Definitions 1216=head2 Definitions
741 1217
742=over 4 1218=over 4
743 1219
744=item B<< C<c> >> 1220=item B<< C<c> >>
745 1221
763 1239
764A text parameter composed of printable characters. 1240A text parameter composed of printable characters.
765 1241
766=back 1242=back
767 1243
768=head1 Values 1244=head2 Values
769 1245
770=over 4 1246=over 4
771 1247
772=item B<< C<ENQ> >> 1248=item B<< C<ENQ> >>
773 1249
816 1292
817Space Character 1293Space Character
818 1294
819=back 1295=back
820 1296
821=head1 Escape Sequences 1297=head2 Escape Sequences
822 1298
823=over 4 1299=over 4
824 1300
825=item B<< C<ESC # 8> >> 1301=item B<< C<ESC # 8> >>
826 1302
836 1312
837=item B<< C<ESC => >> 1313=item B<< C<ESC => >>
838 1314
839Application Keypad (SMKX). See also next sequence. 1315Application Keypad (SMKX). See also next sequence.
840 1316
841=item B<<< C<< ESC >> >>> 1317=item B<<< C<< ESC > >> >>>
842 1318
843Normal Keypad (RMKX) 1319Normal Keypad (RMKX)
844 1320
845B<Note:> If the numeric keypad is activated, eg, B<Num_Lock> has been 1321B<Note:> If the numeric keypad is activated, eg, B<Num_Lock> has been
846pressed, numbers or control functions are generated by the numeric keypad 1322pressed, numbers or control functions are generated by the numeric keypad
924 1400
925=back 1401=back
926 1402
927X<CSI> 1403X<CSI>
928 1404
929=head1 CSI (Command Sequence Introducer) Sequences 1405=head2 CSI (Command Sequence Introducer) Sequences
930 1406
931=over 4 1407=over 4
932 1408
933=item B<< C<ESC [ Ps @> >> 1409=item B<< C<ESC [ Ps @> >>
934 1410
989=begin table 1465=begin table
990 1466
991 B<< C<Ps = 0> >> Clear to Right (default) 1467 B<< C<Ps = 0> >> Clear to Right (default)
992 B<< C<Ps = 1> >> Clear to Left 1468 B<< C<Ps = 1> >> Clear to Left
993 B<< C<Ps = 2> >> Clear All 1469 B<< C<Ps = 2> >> Clear All
1470 B<< C<Ps = 3> >> Like Ps = 0, but is ignored when wrapped
1471 (@@RXVT_NAME@@ extension)
994 1472
995=end table 1473=end table
996 1474
997=item B<< C<ESC [ Ps L> >> 1475=item B<< C<ESC [ Ps L> >>
998 1476
1130 B<< C<Ps = 32 / 42> >> fg/bg Green 1608 B<< C<Ps = 32 / 42> >> fg/bg Green
1131 B<< C<Ps = 33 / 43> >> fg/bg Yellow 1609 B<< C<Ps = 33 / 43> >> fg/bg Yellow
1132 B<< C<Ps = 34 / 44> >> fg/bg Blue 1610 B<< C<Ps = 34 / 44> >> fg/bg Blue
1133 B<< C<Ps = 35 / 45> >> fg/bg Magenta 1611 B<< C<Ps = 35 / 45> >> fg/bg Magenta
1134 B<< C<Ps = 36 / 46> >> fg/bg Cyan 1612 B<< C<Ps = 36 / 46> >> fg/bg Cyan
1135 B<< C<Ps = 38;5 / 48;5> >> set fg/bg to color #m (ISO 8613-6) 1613 B<< C<Ps = 38;5 / 48;5> >> set fg/bg to colour #m (ISO 8613-6)
1136 B<< C<Ps = 37 / 47> >> fg/bg White 1614 B<< C<Ps = 37 / 47> >> fg/bg White
1137 B<< C<Ps = 39 / 49> >> fg/bg Default 1615 B<< C<Ps = 39 / 49> >> fg/bg Default
1138 B<< C<Ps = 90 / 100> >> fg/bg Bright Black 1616 B<< C<Ps = 90 / 100> >> fg/bg Bright Black
1139 B<< C<Ps = 91 / 101> >> fg/bg Bright Red 1617 B<< C<Ps = 91 / 101> >> fg/bg Bright Red
1140 B<< C<Ps = 92 / 102> >> fg/bg Bright Green 1618 B<< C<Ps = 92 / 102> >> fg/bg Bright Green
1204 1682
1205=back 1683=back
1206 1684
1207X<PrivateModes> 1685X<PrivateModes>
1208 1686
1209=head1 DEC Private Modes 1687=head2 DEC Private Modes
1210 1688
1211=over 4 1689=over 4
1212 1690
1213=item B<< C<ESC [ ? Pm h> >> 1691=item B<< C<ESC [ ? Pm h> >>
1214 1692
1230 1708
1231Toggle DEC Private Mode Values (rxvt extension). I<where> 1709Toggle DEC Private Mode Values (rxvt extension). I<where>
1232 1710
1233=over 4 1711=over 4
1234 1712
1235=item B<< C<Ps = 1> >> (DECCKM) 1713=item B<< C<Pm = 1> >> (DECCKM)
1236 1714
1237=begin table 1715=begin table
1238 1716
1239 B<< C<h> >> Application Cursor Keys 1717 B<< C<h> >> Application Cursor Keys
1240 B<< C<l> >> Normal Cursor Keys 1718 B<< C<l> >> Normal Cursor Keys
1241 1719
1242=end table 1720=end table
1243 1721
1244=item B<< C<Ps = 2> >> (ANSI/VT52 mode) 1722=item B<< C<Pm = 2> >> (ANSI/VT52 mode)
1245 1723
1246=begin table 1724=begin table
1247 1725
1248 B<< C<h> >> Enter VT52 mode 1726 B<< C<h> >> Enter VT52 mode
1249 B<< C<l> >> Enter VT52 mode 1727 B<< C<l> >> Enter VT52 mode
1250 1728
1251=end table 1729=end table
1252 1730
1253=item B<< C<Ps = 3> >> 1731=item B<< C<Pm = 3> >>
1254 1732
1255=begin table 1733=begin table
1256 1734
1257 B<< C<h> >> 132 Column Mode (DECCOLM) 1735 B<< C<h> >> 132 Column Mode (DECCOLM)
1258 B<< C<l> >> 80 Column Mode (DECCOLM) 1736 B<< C<l> >> 80 Column Mode (DECCOLM)
1259 1737
1260=end table 1738=end table
1261 1739
1262=item B<< C<Ps = 4> >> 1740=item B<< C<Pm = 4> >>
1263 1741
1264=begin table 1742=begin table
1265 1743
1266 B<< C<h> >> Smooth (Slow) Scroll (DECSCLM) 1744 B<< C<h> >> Smooth (Slow) Scroll (DECSCLM)
1267 B<< C<l> >> Jump (Fast) Scroll (DECSCLM) 1745 B<< C<l> >> Jump (Fast) Scroll (DECSCLM)
1268 1746
1269=end table 1747=end table
1270 1748
1271=item B<< C<Ps = 5> >> 1749=item B<< C<Pm = 5> >>
1272 1750
1273=begin table 1751=begin table
1274 1752
1275 B<< C<h> >> Reverse Video (DECSCNM) 1753 B<< C<h> >> Reverse Video (DECSCNM)
1276 B<< C<l> >> Normal Video (DECSCNM) 1754 B<< C<l> >> Normal Video (DECSCNM)
1277 1755
1278=end table 1756=end table
1279 1757
1280=item B<< C<Ps = 6> >> 1758=item B<< C<Pm = 6> >>
1281 1759
1282=begin table 1760=begin table
1283 1761
1284 B<< C<h> >> Origin Mode (DECOM) 1762 B<< C<h> >> Origin Mode (DECOM)
1285 B<< C<l> >> Normal Cursor Mode (DECOM) 1763 B<< C<l> >> Normal Cursor Mode (DECOM)
1286 1764
1287=end table 1765=end table
1288 1766
1289=item B<< C<Ps = 7> >> 1767=item B<< C<Pm = 7> >>
1290 1768
1291=begin table 1769=begin table
1292 1770
1293 B<< C<h> >> Wraparound Mode (DECAWM) 1771 B<< C<h> >> Wraparound Mode (DECAWM)
1294 B<< C<l> >> No Wraparound Mode (DECAWM) 1772 B<< C<l> >> No Wraparound Mode (DECAWM)
1295 1773
1296=end table 1774=end table
1297 1775
1298=item B<< C<Ps = 8> >> I<unimplemented> 1776=item B<< C<Pm = 8> >> I<unimplemented>
1299 1777
1300=begin table 1778=begin table
1301 1779
1302 B<< C<h> >> Auto-repeat Keys (DECARM) 1780 B<< C<h> >> Auto-repeat Keys (DECARM)
1303 B<< C<l> >> No Auto-repeat Keys (DECARM) 1781 B<< C<l> >> No Auto-repeat Keys (DECARM)
1304 1782
1305=end table 1783=end table
1306 1784
1307=item B<< C<Ps = 9> >> X10 XTerm 1785=item B<< C<Pm = 9> >> X10 XTerm
1308 1786
1309=begin table 1787=begin table
1310 1788
1311 B<< C<h> >> Send Mouse X & Y on button press. 1789 B<< C<h> >> Send Mouse X & Y on button press.
1312 B<< C<l> >> No mouse reporting. 1790 B<< C<l> >> No mouse reporting.
1313 1791
1314=end table 1792=end table
1315 1793
1316=item B<< C<Ps = 10> >> (B<rxvt>)
1317
1318=begin table
1319
1320 B<< C<h> >> menuBar visible
1321 B<< C<l> >> menuBar invisible
1322
1323=end table
1324
1325=item B<< C<Ps = 25> >> 1794=item B<< C<Pm = 25> >>
1326 1795
1327=begin table 1796=begin table
1328 1797
1329 B<< C<h> >> Visible cursor {cnorm/cvvis} 1798 B<< C<h> >> Visible cursor {cnorm/cvvis}
1330 B<< C<l> >> Invisible cursor {civis} 1799 B<< C<l> >> Invisible cursor {civis}
1331 1800
1332=end table 1801=end table
1333 1802
1334=item B<< C<Ps = 30> >> 1803=item B<< C<Pm = 30> >>
1335 1804
1336=begin table 1805=begin table
1337 1806
1338 B<< C<h> >> scrollBar visisble 1807 B<< C<h> >> scrollBar visible
1339 B<< C<l> >> scrollBar invisisble 1808 B<< C<l> >> scrollBar invisible
1340 1809
1341=end table 1810=end table
1342 1811
1343=item B<< C<Ps = 35> >> (B<rxvt>) 1812=item B<< C<Pm = 35> >> (B<rxvt>)
1344 1813
1345=begin table 1814=begin table
1346 1815
1347 B<< C<h> >> Allow XTerm Shift+key sequences 1816 B<< C<h> >> Allow XTerm Shift+key sequences
1348 B<< C<l> >> Disallow XTerm Shift+key sequences 1817 B<< C<l> >> Disallow XTerm Shift+key sequences
1349 1818
1350=end table 1819=end table
1351 1820
1352=item B<< C<Ps = 38> >> I<unimplemented> 1821=item B<< C<Pm = 38> >> I<unimplemented>
1353 1822
1354Enter Tektronix Mode (DECTEK) 1823Enter Tektronix Mode (DECTEK)
1355 1824
1356=item B<< C<Ps = 40> >> 1825=item B<< C<Pm = 40> >>
1357 1826
1358=begin table 1827=begin table
1359 1828
1360 B<< C<h> >> Allow 80/132 Mode 1829 B<< C<h> >> Allow 80/132 Mode
1361 B<< C<l> >> Disallow 80/132 Mode 1830 B<< C<l> >> Disallow 80/132 Mode
1362 1831
1363=end table 1832=end table
1364 1833
1365=item B<< C<Ps = 44> >> I<unimplemented> 1834=item B<< C<Pm = 44> >> I<unimplemented>
1366 1835
1367=begin table 1836=begin table
1368 1837
1369 B<< C<h> >> Turn On Margin Bell 1838 B<< C<h> >> Turn On Margin Bell
1370 B<< C<l> >> Turn Off Margin Bell 1839 B<< C<l> >> Turn Off Margin Bell
1371 1840
1372=end table 1841=end table
1373 1842
1374=item B<< C<Ps = 45> >> I<unimplemented> 1843=item B<< C<Pm = 45> >> I<unimplemented>
1375 1844
1376=begin table 1845=begin table
1377 1846
1378 B<< C<h> >> Reverse-wraparound Mode 1847 B<< C<h> >> Reverse-wraparound Mode
1379 B<< C<l> >> No Reverse-wraparound Mode 1848 B<< C<l> >> No Reverse-wraparound Mode
1380 1849
1381=end table 1850=end table
1382 1851
1383=item B<< C<Ps = 46> >> I<unimplemented> 1852=item B<< C<Pm = 46> >> I<unimplemented>
1384 1853
1385=item B<< C<Ps = 47> >> 1854=item B<< C<Pm = 47> >>
1386 1855
1387=begin table 1856=begin table
1388 1857
1389 B<< C<h> >> Use Alternate Screen Buffer 1858 B<< C<h> >> Use Alternate Screen Buffer
1390 B<< C<l> >> Use Normal Screen Buffer 1859 B<< C<l> >> Use Normal Screen Buffer
1391 1860
1392=end table 1861=end table
1393 1862
1394X<Priv66> 1863X<Priv66>
1395 1864
1396=item B<< C<Ps = 66> >> 1865=item B<< C<Pm = 66> >>
1397 1866
1398=begin table 1867=begin table
1399 1868
1400 B<< C<h> >> Application Keypad (DECPAM) == C<ESC => 1869 B<< C<h> >> Application Keypad (DECKPAM/DECPAM) == C<ESC =>
1401 B<< C<l> >> Normal Keypad (DECPNM) == C<< ESC > >> 1870 B<< C<l> >> Normal Keypad (DECKPNM/DECPNM) == C<< ESC > >>
1402 1871
1403=end table 1872=end table
1404 1873
1405=item B<< C<Ps = 67> >> 1874=item B<< C<Pm = 67> >>
1406 1875
1407=begin table 1876=begin table
1408 1877
1409 B<< C<h> >> Backspace key sends B<< C<BS> (DECBKM) >> 1878 B<< C<h> >> Backspace key sends B<< C<BS> (DECBKM) >>
1410 B<< C<l> >> Backspace key sends B<< C<DEL> >> 1879 B<< C<l> >> Backspace key sends B<< C<DEL> >>
1411 1880
1412=end table 1881=end table
1413 1882
1414=item B<< C<Ps = 1000> >> (X11 XTerm) 1883=item B<< C<Pm = 1000> >> (X11 XTerm)
1415 1884
1416=begin table 1885=begin table
1417 1886
1418 B<< C<h> >> Send Mouse X & Y on button press and release. 1887 B<< C<h> >> Send Mouse X & Y on button press and release.
1419 B<< C<l> >> No mouse reporting. 1888 B<< C<l> >> No mouse reporting.
1420 1889
1421=end table 1890=end table
1422 1891
1423=item B<< C<Ps = 1001> >> (X11 XTerm) I<unimplemented> 1892=item B<< C<Pm = 1001> >> (X11 XTerm) I<unimplemented>
1424 1893
1425=begin table 1894=begin table
1426 1895
1427 B<< C<h> >> Use Hilite Mouse Tracking. 1896 B<< C<h> >> Use Hilite Mouse Tracking.
1428 B<< C<l> >> No mouse reporting. 1897 B<< C<l> >> No mouse reporting.
1429 1898
1430=end table 1899=end table
1431 1900
1901=item B<< C<Pm = 1002> >> (X11 XTerm)
1902
1903=begin table
1904
1905 B<< C<h> >> Send Mouse X & Y on button press and release, and motion with a button pressed.
1906 B<< C<l> >> No mouse reporting.
1907
1908=end table
1909
1910=item B<< C<Pm = 1003> >> (X11 XTerm)
1911
1912=begin table
1913
1914 B<< C<h> >> Send Mouse X & Y on button press and release, and motion.
1915 B<< C<l> >> No mouse reporting.
1916
1917=end table
1918
1432=item B<< C<Ps = 1010> >> (B<rxvt>) 1919=item B<< C<Pm = 1010> >> (B<rxvt>)
1433 1920
1434=begin table 1921=begin table
1435 1922
1436 B<< C<h> >> Don't scroll to bottom on TTY output 1923 B<< C<h> >> Don't scroll to bottom on TTY output
1437 B<< C<l> >> Scroll to bottom on TTY output 1924 B<< C<l> >> Scroll to bottom on TTY output
1438 1925
1439=end table 1926=end table
1440 1927
1441=item B<< C<Ps = 1011> >> (B<rxvt>) 1928=item B<< C<Pm = 1011> >> (B<rxvt>)
1442 1929
1443=begin table 1930=begin table
1444 1931
1445 B<< C<h> >> Scroll to bottom when a key is pressed 1932 B<< C<h> >> Scroll to bottom when a key is pressed
1446 B<< C<l> >> Don't scroll to bottom when a key is pressed 1933 B<< C<l> >> Don't scroll to bottom when a key is pressed
1447 1934
1448=end table 1935=end table
1449 1936
1937=item B<< C<Pm = 1021> >> (B<rxvt>)
1938
1939=begin table
1940
1941 B<< C<h> >> Bold/italic implies high intensity (see option B<-is>)
1942 B<< C<l> >> Font styles have no effect on intensity (Compile styles)
1943
1944=end table
1945
1450=item B<< C<Ps = 1047> >> 1946=item B<< C<Pm = 1047> >>
1451 1947
1452=begin table 1948=begin table
1453 1949
1454 B<< C<h> >> Use Alternate Screen Buffer 1950 B<< C<h> >> Use Alternate Screen Buffer
1455 B<< C<l> >> Use Normal Screen Buffer - clear Alternate Screen Buffer if returning from it 1951 B<< C<l> >> Use Normal Screen Buffer - clear Alternate Screen Buffer if returning from it
1456 1952
1457=end table 1953=end table
1458 1954
1459=item B<< C<Ps = 1048> >> 1955=item B<< C<Pm = 1048> >>
1460 1956
1461=begin table 1957=begin table
1462 1958
1463 B<< C<h> >> Save cursor position 1959 B<< C<h> >> Save cursor position
1464 B<< C<l> >> Restore cursor position 1960 B<< C<l> >> Restore cursor position
1465 1961
1466=end table 1962=end table
1467 1963
1468=item B<< C<Ps = 1049> >> 1964=item B<< C<Pm = 1049> >>
1469 1965
1470=begin table 1966=begin table
1471 1967
1472 B<< C<h> >> Use Alternate Screen Buffer - clear Alternate Screen Buffer if switching to it 1968 B<< C<h> >> Use Alternate Screen Buffer - clear Alternate Screen Buffer if switching to it
1473 B<< C<l> >> Use Normal Screen Buffer 1969 B<< C<l> >> Use Normal Screen Buffer
1474 1970
1475=end table 1971=end table
1476 1972
1973=item B<< C<Pm = 2004> >>
1974
1975=begin table
1976
1977 B<< C<h> >> Enable bracketed paste mode - prepend / append to the pasted text the control sequences C<ESC [ 200 ~> / C<ESC [ 201 ~>
1978 B<< C<l> >> Disable bracketed paste mode
1979
1980=end table
1981
1477=back 1982=back
1478 1983
1479=back 1984=back
1480 1985
1481X<XTerm> 1986X<XTerm>
1482 1987
1483=head1 XTerm Operating System Commands 1988=head2 XTerm Operating System Commands
1484 1989
1485=over 4 1990=over 4
1486 1991
1487=item B<< C<ESC ] Ps;Pt ST> >> 1992=item B<< C<ESC ] Ps;Pt ST> >>
1488 1993
1495 B<< C<Ps = 0> >> Change Icon Name and Window Title to B<< C<Pt> >> 2000 B<< C<Ps = 0> >> Change Icon Name and Window Title to B<< C<Pt> >>
1496 B<< C<Ps = 1> >> Change Icon Name to B<< C<Pt> >> 2001 B<< C<Ps = 1> >> Change Icon Name to B<< C<Pt> >>
1497 B<< C<Ps = 2> >> Change Window Title to B<< C<Pt> >> 2002 B<< C<Ps = 2> >> Change Window Title to B<< C<Pt> >>
1498 B<< C<Ps = 3> >> If B<< C<Pt> >> starts with a B<< C<?> >>, query the (STRING) property of the window and return it. If B<< C<Pt> >> contains a B<< C<=> >>, set the named property to the given value, else delete the specified property. 2003 B<< C<Ps = 3> >> If B<< C<Pt> >> starts with a B<< C<?> >>, query the (STRING) property of the window and return it. If B<< C<Pt> >> contains a B<< C<=> >>, set the named property to the given value, else delete the specified property.
1499 B<< C<Ps = 4> >> B<< C<Pt> >> is a semi-colon separated sequence of one or more semi-colon separated B<number>/B<name> pairs, where B<number> is an index to a colour and B<name> is the name of a colour. Each pair causes the B<number>ed colour to be changed to B<name>. Numbers 0-7 corresponds to low-intensity (normal) colours and 8-15 corresponds to high-intensity colours. 0=black, 1=red, 2=green, 3=yellow, 4=blue, 5=magenta, 6=cyan, 7=white 2004 B<< C<Ps = 4> >> B<< C<Pt> >> is a semi-colon separated sequence of one or more semi-colon separated B<number>/B<name> pairs, where B<number> is an index to a colour and B<name> is the name of a colour. Each pair causes the B<number>ed colour to be changed to B<name>. Numbers 0-7 corresponds to low-intensity (normal) colours and 8-15 corresponds to high-intensity colours. 0=black, 1=red, 2=green, 3=yellow, 4=blue, 5=magenta, 6=cyan, 7=white
1500 B<< C<Ps = 10> >> Change colour of text foreground to B<< C<Pt> >> B<(NB: may change in future)> 2005 B<< C<Ps = 10> >> Change colour of text foreground to B<< C<Pt> >>
1501 B<< C<Ps = 11> >> Change colour of text background to B<< C<Pt> >> B<(NB: may change in future)> 2006 B<< C<Ps = 11> >> Change colour of text background to B<< C<Pt> >>
1502 B<< C<Ps = 12> >> Change colour of text cursor foreground to B<< C<Pt> >> 2007 B<< C<Ps = 12> >> Change colour of text cursor foreground to B<< C<Pt> >>
1503 B<< C<Ps = 13> >> Change colour of mouse foreground to B<< C<Pt> >> 2008 B<< C<Ps = 13> >> Change colour of mouse foreground to B<< C<Pt> >>
1504 B<< C<Ps = 17> >> Change colour of highlight characters to B<< C<Pt> >> 2009 B<< C<Ps = 17> >> Change background colour of highlight characters to B<< C<Pt> >>
1505 B<< C<Ps = 18> >> Change colour of bold characters to B<< C<Pt> >> 2010 B<< C<Ps = 19> >> Change foreground colour of highlight characters to B<< C<Pt> >>
1506 B<< C<Ps = 19> >> Change colour of underlined characters to B<< C<Pt> >> 2011 B<< C<Ps = 20> >> Change background pixmap parameters (see section BACKGROUND IMAGE) (Compile afterimage or pixbuf).
1507 B<< C<Ps = 20> >> Change default background to B<< C<Pt> >>
1508 B<< C<Ps = 39> >> Change default foreground colour to B<< C<Pt> >>. 2012 B<< C<Ps = 39> >> Change default foreground colour to B<< C<Pt> >>. [deprecated, use 10]
1509 B<< C<Ps = 46> >> Change Log File to B<< C<Pt> >> I<unimplemented> 2013 B<< C<Ps = 46> >> Change Log File to B<< C<Pt> >> I<unimplemented>
1510 B<< C<Ps = 49> >> Change default background colour to B<< C<Pt> >>. 2014 B<< C<Ps = 49> >> Change default background colour to B<< C<Pt> >>. [deprecated, use 11]
1511 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> >> 2015 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> >>
1512 B<< C<Ps = 55> >> Log all scrollback buffer and all of screen to B<< C<Pt> >> 2016 B<< C<Ps = 55> >> Log all scrollback buffer and all of screen to B<< C<Pt> >> [disabled]
1513 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). 2017 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).
1514 B<< C<Ps = 703> >> Menubar command B<< C<Pt> >> (Compile menubar). 2018 B<< C<Ps = 702> >> Request version if B<< C<Pt> >> is B<< C<?> >>, returning C<rxvt-unicode>, the resource name, the major and minor version numbers, e.g. C<ESC ] 702 ; rxvt-unicode ; urxvt ; 7 ; 4 ST>.
1515 B<< C<Ps = 704> >> Change colour of italic characters to B<< C<Pt> >> 2019 B<< C<Ps = 704> >> Change colour of italic characters to B<< C<Pt> >>
1516 B<< C<Ps = 705> >> Change background pixmap tint colour to B<< C<Pt> >> (Compile transparency). 2020 B<< C<Ps = 705> >> Change background pixmap tint colour to B<< C<Pt> >> (Compile transparency).
2021 B<< C<Ps = 706> >> Change colour of bold characters to B<< C<Pt> >>
2022 B<< C<Ps = 707> >> Change colour of underlined characters to B<< C<Pt> >>
2023 B<< C<Ps = 708> >> Change colour of the border to B<< C<Pt> >>
1517 B<< C<Ps = 710> >> Set normal fontset to B<< C<Pt> >>. Same as C<Ps = 50>. 2024 B<< C<Ps = 710> >> Set normal fontset to B<< C<Pt> >>. Same as C<Ps = 50>.
1518 B<< C<Ps = 711> >> Set bold fontset to B<< C<Pt> >>. Similar to C<Ps = 50> (Compile styles). 2025 B<< C<Ps = 711> >> Set bold fontset to B<< C<Pt> >>. Similar to C<Ps = 50> (Compile styles).
1519 B<< C<Ps = 712> >> Set italic fontset to B<< C<Pt> >>. Similar to C<Ps = 50> (Compile styles). 2026 B<< C<Ps = 712> >> Set italic fontset to B<< C<Pt> >>. Similar to C<Ps = 50> (Compile styles).
1520 B<< C<Ps = 713> >> Set bold-italic fontset to B<< C<Pt> >>. Similar to C<Ps = 50> (Compile styles). 2027 B<< C<Ps = 713> >> Set bold-italic fontset to B<< C<Pt> >>. Similar to C<Ps = 50> (Compile styles).
1521 B<< C<Ps = 720> >> Move viewing window up by B<< C<Pt> >> lines, or clear scrollback buffer if C<Pt = 0> (Compile frills). 2028 B<< C<Ps = 720> >> Move viewing window up by B<< C<Pt> >> lines, or clear scrollback buffer if C<Pt = 0> (Compile frills).
1522 B<< C<Ps = 721> >> Move viewing window down by B<< C<Pt> >> lines, or clear scrollback buffer if C<Pt = 0> (Compile frills). 2029 B<< C<Ps = 721> >> Move viewing window down by B<< C<Pt> >> lines, or clear scrollback buffer if C<Pt = 0> (Compile frills).
2030 B<< C<Ps = 777> >> Call the perl extension with the given string, which should be of the form C<extension:parameters> (Compile perl).
1523 2031
1524=end table 2032=end table
1525 2033
1526=back 2034=back
1527 2035
1528X<menuBar> 2036=head1 BACKGROUND IMAGE
1529 2037
1530=head1 menuBar
1531
1532B<< The exact syntax used is I<almost> solidified. >>
1533In the menus, B<DON'T> try to use menuBar commands that add or remove a
1534menuBar.
1535
1536Note that in all of the commands, the B<< I</path/> >> I<cannot> be
1537omitted: use B<./> to specify a menu relative to the current menu.
1538
1539=head2 Overview of menuBar operation
1540
1541For the menuBar XTerm escape sequence C<ESC ] 703 ; Pt ST>, the syntax
1542of C<Pt> can be used for a variety of tasks:
1543
1544At the top level is the current menuBar which is a member of a circular
1545linked-list of other such menuBars.
1546
1547The menuBar acts as a parent for the various drop-down menus, which in
1548turn, may have labels, separator lines, menuItems and subMenus.
1549
1550The menuItems are the useful bits: you can use them to mimic keyboard
1551input or even to send text or escape sequences back to rxvt.
1552
1553The menuBar syntax is intended to provide a simple yet robust method of
1554constructing and manipulating menus and navigating through the
1555menuBars.
1556
1557The first step is to use the tag B<< [menu:I<name>] >> which creates
1558the menuBar called I<name> and allows access. You may now or menus,
1559subMenus, and menuItems. Finally, use the tag B<[done]> to set the
1560menuBar access as B<readonly> to prevent accidental corruption of the
1561menus. To re-access the current menuBar for alterations, use the tag
1562B<[menu]>, make the alterations and then use B<[done]>
1563
1564X<menuBarCommands>
1565
1566=head2 Commands
1567
1568=over 4
1569
1570=item B<< [menu:+I<name>] >>
1571
1572access the named menuBar for creation or alteration. If a new menuBar
1573is created, it is called I<name> (max of 15 chars) and the current
1574menuBar is pushed onto the stack
1575
1576=item B<[menu]>
1577
1578access the current menuBar for alteration
1579
1580=item B<< [title:+I<string>] >>
1581
1582set the current menuBar's title to I<string>, which may contain the
1583following format specifiers:
1584
1585 B<%n> rxvt name (as per the B<-name> command-line option)
1586 B<%v> rxvt version
1587 B<%%> literal B<%> character
1588
1589=item B<[done]>
1590
1591set menuBar access as B<readonly>.
1592End-of-file tag for B<< [read:+I<file>] >> operations.
1593
1594=item B<< [read:+I<file>] >>
1595
1596read menu commands directly from I<file> (extension ".menu" will be
1597appended if required.) Start reading at a line with B<[menu]> or B<<
1598[menu:+I<name> >> and continuing until B<[done]> is encountered.
1599
1600Blank and comment lines (starting with B<#>) are ignored. Actually,
1601since any invalid menu commands are also ignored, almost anything could
1602be construed as a comment line, but this may be tightened up in the
1603future ... so don't count on it!.
1604
1605=item B<< [read:+I<file>;+I<name>] >>
1606
1607The same as B<< [read:+I<file>] >>, but start reading at a line with
1608B<< [menu:+I<name>] >> and continuing until B<< [done:+I<name>] >> or
1609B<[done]> is encountered.
1610
1611=item B<[dump]>
1612
1613dump all menuBars to the file B</tmp/rxvt-PID> in a format suitable for
1614later rereading.
1615
1616=item B<[rm:name]>
1617
1618remove the named menuBar
1619
1620=item B<[rm] [rm:]>
1621
1622remove the current menuBar
1623
1624=item B<[rm*] [rm:*]>
1625
1626remove all menuBars
1627
1628=item B<[swap]>
1629
1630swap the top two menuBars
1631
1632=item B<[prev]>
1633
1634access the previous menuBar
1635
1636=item B<[next]>
1637
1638access the next menuBar
1639
1640=item B<[show]>
1641
1642Enable display of the menuBar
1643
1644=item B<[hide]>
1645
1646Disable display of the menuBar
1647
1648=item B<< [pixmap:+I<name>] >>
1649
1650=item B<< [pixmap:+I<name>;I<scaling>] >>
1651
1652(set the background pixmap globally
1653
1654B<< A Future implementation I<may> make this local to the menubar >>)
1655
1656=item B<< [:+I<command>:] >>
1657
1658ignore the menu readonly status and issue a I<command> to or a menu or
1659menuitem or change the ; a useful shortcut for setting the quick arrows
1660from a menuBar.
1661
1662=back
1663
1664X<menuBarAdd>
1665
1666=head2 Adding and accessing menus
1667
1668The following commands may also be B<+> prefixed.
1669
1670=over 4
1671
1672=item B</+>
1673
1674access menuBar top level
1675
1676=item B<./+>
1677
1678access current menu level
1679
1680=item B<../+>
1681
1682access parent menu (1 level up)
1683
1684=item B<../../>
1685
1686access parent menu (multiple levels up)
1687
1688=item B<< I</path/>menu >>
1689
1690add/access menu
1691
1692=item B<< I</path/>menu/* >>
1693
1694add/access menu and clear it if it exists
1695
1696=item B<< I</path/>{-} >>
1697
1698add separator
1699
1700=item B<< I</path/>{item} >>
1701
1702add B<item> as a label
1703
1704=item B<< I</path/>{item} action >>
1705
1706add/alter I<menuitem> with an associated I<action>
1707
1708=item B<< I</path/>{item}{right-text} >>
1709
1710add/alter I<menuitem> with B<right-text> as the right-justified text
1711and as the associated I<action>
1712
1713=item B<< I</path/>{item}{rtext} action >>
1714
1715add/alter I<menuitem> with an associated I<action> and with B<rtext> as
1716the right-justified text.
1717
1718=back
1719
1720=over 4
1721
1722=item Special characters in I<action> must be backslash-escaped:
1723
1724B<\a \b \E \e \n \r \t \octal>
1725
1726=item or in control-character notation:
1727
1728B<^@, ^A .. ^Z .. ^_, ^?>
1729
1730=back
1731
1732To send a string starting with a B<NUL> (B<^@>) character to the
1733program, start I<action> with a pair of B<NUL> characters (B<^@^@>),
1734the first of which will be stripped off and the balance directed to the
1735program. Otherwise if I<action> begins with B<NUL> followed by
1736non-+B<NUL> characters, the leading B<NUL> is stripped off and the
1737balance is sent back to rxvt.
1738
1739As a convenience for the many Emacs-type editors, I<action> may start
1740with B<M-> (eg, B<M-$> is equivalent to B<\E$>) and a B<CR> will be
1741appended if missed from B<M-x> commands.
1742
1743As a convenience for issuing XTerm B<ESC ]> sequences from a menubar (or
1744quick arrow), a B<BEL> (B<^G>) will be appended if needed.
1745
1746=over 4
1747
1748=item For example,
1749
1750B<M-xapropos> is equivalent to B<\Exapropos\r>
1751
1752=item and
1753
1754B<\E]703;mona;100> is equivalent to B<\E]703;mona;100\a>
1755
1756=back
1757
1758The option B<< {I<right-rtext>} >> will be right-justified. In the
1759absence of a specified action, this text will be used as the I<action>
1760as well.
1761
1762=over 4
1763
1764=item For example,
1765
1766B</File/{Open}{^X^F}> is equivalent to B</File/{Open}{^X^F} ^X^F>
1767
1768=back
1769
1770The left label I<is> necessary, since it's used for matching, but
1771implicitly hiding the left label (by using same name for both left and
1772right labels), or explicitly hiding the left label (by preceeding it
1773with a dot), makes it possible to have right-justified text only.
1774
1775=over 4
1776
1777=item For example,
1778
1779B</File/{Open}{Open} Open-File-Action>
1780
1781=item or hiding it
1782
1783B</File/{.anylabel}{Open} Open-File-Action>
1784
1785=back
1786
1787X<menuBarRemove>
1788
1789=head2 Removing menus
1790
1791=over 4
1792
1793=item B<< -/*+ >>
1794
1795remove all menus from the menuBar, the same as B<[clear]>
1796
1797=item B<< -+I</path>menu+ >>
1798
1799remove menu
1800
1801=item B<< -+I</path>{item}+ >>
1802
1803remove item
1804
1805=item B<< -+I</path>{-} >>
1806
1807remove separator)
1808
1809=item B<-/path/menu/*>
1810
1811remove all items, separators and submenus from menu
1812
1813=back
1814
1815X<menuBarArrows>
1816
1817=head2 Quick Arrows
1818
1819The menus also provide a hook for I<quick arrows> to provide easier
1820user access. If nothing has been explicitly set, the default is to
1821emulate the curror keys. The syntax permits each arrow to be altered
1822individually or all four at once without re-entering their common
1823beginning/end text. For example, to explicitly associate cursor actions
1824with the arrows, any of the following forms could be used:
1825
1826=over 4
1827
1828=item B<< <r>+I<Right> >>
1829
1830=item B<< <l>+I<Left> >>
1831
1832=item B<< <u>+I<Up> >>
1833
1834=item B<< <d>+I<Down> >>
1835
1836Define actions for the respective arrow buttons
1837
1838=item B<< <b>+I<Begin> >>
1839
1840=item B<< <e>+I<End> >>
1841
1842Define common beginning/end parts for I<quick arrows> which used in
1843conjunction with the above <r> <l> <u> <d> constructs
1844
1845=back
1846
1847=over 4
1848
1849=item For example, define arrows individually,
1850
1851 <u>\E[A
1852
1853 <d>\E[B
1854
1855 <r>\E[C
1856
1857 <l>\E[D
1858
1859=item or all at once
1860
1861 <u>\E[AZ<><d>\E[BZ<><r>\E[CZ<><l>\E[D
1862
1863=item or more compactly (factoring out common parts)
1864
1865 <b>\E[<u>AZ<><d>BZ<><r>CZ<><l>D
1866
1867=back
1868
1869X<menuBarSummary>
1870
1871=head2 Command Summary
1872
1873A short summary of the most I<common> commands:
1874
1875=over 4
1876
1877=item [menu:name]
1878
1879use an existing named menuBar or start a new one
1880
1881=item [menu]
1882
1883use the current menuBar
1884
1885=item [title:string]
1886
1887set menuBar title
1888
1889=item [done]
1890
1891set menu access to readonly and, if reading from a file, signal EOF
1892
1893=item [done:name]
1894
1895if reading from a file using [read:file;name] signal EOF
1896
1897=item [rm:name]
1898
1899remove named menuBar(s)
1900
1901=item [rm] [rm:]
1902
1903remove current menuBar
1904
1905=item [rm*] [rm:*]
1906
1907remove all menuBar(s)
1908
1909=item [swap]
1910
1911swap top two menuBars
1912
1913=item [prev]
1914
1915access the previous menuBar
1916
1917=item [next]
1918
1919access the next menuBar
1920
1921=item [show]
1922
1923map menuBar
1924
1925=item [hide]
1926
1927unmap menuBar
1928
1929=item [pixmap;file]
1930
1931=item [pixmap;file;scaling]
1932
1933set a background pixmap
1934
1935=item [read:file]
1936
1937=item [read:file;name]
1938
1939read in a menu from a file
1940
1941=item [dump]
1942
1943dump out all menuBars to /tmp/rxvt-PID
1944
1945=item /
1946
1947access menuBar top level
1948
1949=item ./
1950
1951=item ../
1952
1953=item ../../
1954
1955access current or parent menu level
1956
1957=item /path/menu
1958
1959add/access menu
1960
1961=item /path/{-}
1962
1963add separator
1964
1965=item /path/{item}{rtext} action
1966
1967add/alter menu item
1968
1969=item -/*
1970
1971remove all menus from the menuBar
1972
1973=item -/path/menu
1974
1975remove menu items, separators and submenus from menu
1976
1977=item -/path/menu
1978
1979remove menu
1980
1981=item -/path/{item}
1982
1983remove item
1984
1985=item -/path/{-}
1986
1987remove separator
1988
1989=item <b>Begin<r>Right<l>Left<u>Up<d>Down<e>End
1990
1991menu quick arrows
1992
1993=back
1994X<XPM>
1995
1996=head1 XPM
1997
1998For the XPM XTerm escape sequence B<< C<ESC ] 20 ; Pt ST> >> then value 2038For the BACKGROUND IMAGE XTerm escape sequence B<< C<ESC ] 20 ; Pt ST> >> the value
1999of B<< C<Pt> >> can be the name of the background pixmap followed by a 2039of B<< C<Pt> >> can be the name of the background image file followed by a
2000sequence of scaling/positioning commands separated by semi-colons. The 2040sequence of scaling/positioning commands separated by semi-colons. The
2001scaling/positioning commands are as follows: 2041scaling/positioning commands are as follows:
2002 2042
2003=over 4 2043=over 4
2004 2044
2042 2082
2043For example: 2083For example:
2044 2084
2045=over 4 2085=over 4
2046 2086
2047=item B<\E]20;funky\a> 2087=item B<\E]20;funky.jpg\a>
2048 2088
2049load B<funky.xpm> as a tiled image 2089load B<funky.jpg> as a tiled image
2050 2090
2051=item B<\E]20;mona;100\a> 2091=item B<\E]20;mona.jpg;100\a>
2052 2092
2053load B<mona.xpm> with a scaling of 100% 2093load B<mona.jpg> with a scaling of 100%
2054 2094
2055=item B<\E]20;;200;?\a> 2095=item B<\E]20;;200;?\a>
2056 2096
2057rescale the current pixmap to 200% and display the image geometry in 2097rescale the current pixmap to 200% and display the image geometry in
2058the title 2098the title
2059 2099
2060=back 2100=back
2101
2061X<Mouse> 2102X<Mouse>
2062 2103
2063=head1 Mouse Reporting 2104=head1 Mouse Reporting
2064 2105
2065=over 4 2106=over 4
2097=begin table 2138=begin table
2098 2139
2099 4 Shift 2140 4 Shift
2100 8 Meta 2141 8 Meta
2101 16 Control 2142 16 Control
2102 32 Double Click I<(Rxvt extension)> 2143 32 Double Click I<(rxvt extension)>
2103 2144
2104=end table 2145=end table
2105 2146
2106Col = B<< C<< <x> - SPACE >> >> 2147Col = B<< C<< <x> - SPACE >> >>
2107 2148
2108Row = B<< C<< <y> - SPACE >> >> 2149Row = B<< C<< <y> - SPACE >> >>
2109 2150
2110=back 2151=back
2152
2153=head1 Key Codes
2154
2111X<KeyCodes> 2155X<KeyCodes>
2112
2113=head1 Key Codes
2114 2156
2115Note: B<Shift> + B<F1>-B<F10> generates B<F11>-B<F20> 2157Note: B<Shift> + B<F1>-B<F10> generates B<F11>-B<F20>
2116 2158
2117For the keypad, use B<Shift> to temporarily override Application-Keypad 2159For the keypad, use B<Shift> to temporarily override Application-Keypad
2118setting use B<Num_Lock> to toggle Application-Keypad setting if 2160setting use B<Num_Lock> to toggle Application-Keypad setting if
2119B<Num_Lock> is off, toggle Application-Keypad setting. Also note that 2161B<Num_Lock> is off, toggle Application-Keypad setting. Also note that
2120values of B<Home>, B<End>, B<Delete> may have been compiled differently on 2162values of B<BackSpace>, B<Delete> may have been compiled differently on
2121your system. 2163your system.
2122 2164
2123=begin table 2165=begin table
2124 2166
2125 B<Normal> B<Shift> B<Control> B<Ctrl+Shift> 2167 B<Normal> B<Shift> B<Control> B<Ctrl+Shift>
2184=end table 2226=end table
2185 2227
2186=head1 CONFIGURE OPTIONS 2228=head1 CONFIGURE OPTIONS
2187 2229
2188General hint: if you get compile errors, then likely your configuration 2230General hint: if you get compile errors, then likely your configuration
2189hasn't been tested well. Either try with --enable-everything or use the 2231hasn't been tested well. Either try with C<--enable-everything> or use
2190./reconf script as a base for experiments. ./reconf is used by myself, 2232the default configuration (i.e. no C<--enable-xxx> or C<--disable-xxx>
2191so it should generally be a working config. Of course, you should always 2233switches). Of course, you should always report when a combination doesn't
2192report when a combination doesn't work, so it can be fixed. Marc Lehmann 2234work, so it can be fixed. Marc Lehmann <rxvt@schmorp.de>.
2193<rxvt@schmorp.de>. 2235
2236All
2194 2237
2195=over 4 2238=over 4
2196 2239
2197=item --enable-everything 2240=item --enable-everything
2198 2241
2199Add support for all non-multichoice options listed in "./configure 2242Add (or remove) support for all non-multichoice options listed
2200--help". Note that unlike other enable options this is order dependant. 2243in C<./configure --help>, except for C<--enable-assert> and
2244C<--enable-256-color>.
2245
2201You can specify this and then disable options which this enables by 2246You can specify this and then disable options you do not like by
2202I<following> this with the appropriate commands. 2247I<following> this with the appropriate C<--disable-...> arguments,
2248or you can start with a minimal configuration by specifying
2249C<--disable-everything> and than adding just the C<--enable-...> arguments
2250you want.
2203 2251
2204=item --enable-xft 2252=item --enable-xft (default: enabled)
2205 2253
2206Add support for Xft (anti-aliases, among others) fonts. Xft fonts are 2254Add support for Xft (anti-aliases, among others) fonts. Xft fonts are
2207slower and require lots of memory, but as long as you don't use them, you 2255slower and require lots of memory, but as long as you don't use them, you
2208don't pay for them. 2256don't pay for them.
2209 2257
2210=item --enable-font-styles 2258=item --enable-font-styles (default: on)
2211 2259
2212Add support for B<bold>, I<italic> and B<< I<bold italic> >> font 2260Add support for B<bold>, I<italic> and B<< I<bold italic> >> font
2213styles. The fonts can be set manually or automatically. 2261styles. The fonts can be set manually or automatically.
2214 2262
2215=item --with-codesets=NAME,... 2263=item --with-codesets=NAME,... (default: all)
2216 2264
2217Compile in support for additional codeset (encoding) groups (C<eu>, C<vn> 2265Compile in support for additional codeset (encoding) groups (C<eu>, C<vn>
2218are always compiled in, which includes most 8-bit character sets). These 2266are always compiled in, which includes most 8-bit character sets). These
2219codeset tables are used for driving X11 core fonts, they are not required 2267codeset tables are used for driving X11 core fonts, they are not required
2220for Xft fonts, although having them compiled in lets rxvt-unicode choose 2268for Xft fonts, although having them compiled in lets rxvt-unicode choose
2224 2272
2225=begin table 2273=begin table
2226 2274
2227 all all available codeset groups 2275 all all available codeset groups
2228 zh common chinese encodings 2276 zh common chinese encodings
2229 zh_ext rarely used but very big chinese encodigs 2277 zh_ext rarely used but very big chinese encodings
2230 jp common japanese encodings 2278 jp common japanese encodings
2231 jp_ext rarely used but big japanese encodings 2279 jp_ext rarely used but big japanese encodings
2232 kr korean encodings 2280 kr korean encodings
2233 2281
2234=end table 2282=end table
2235 2283
2236=item --enable-xim 2284=item --enable-xim (default: on)
2237 2285
2238Add support for XIM (X Input Method) protocol. This allows using 2286Add support for XIM (X Input Method) protocol. This allows using
2239alternative input methods (e.g. kinput2) and will also correctly 2287alternative input methods (e.g. kinput2) and will also correctly
2240set up the input for people using dead keys or compose keys. 2288set up the input for people using dead keys or compose keys.
2241 2289
2242=item --enable-unicode3 2290=item --enable-unicode3 (default: off)
2291
2292Recommended to stay off unless you really need non-BMP characters.
2243 2293
2244Enable direct support for displaying unicode codepoints above 2294Enable direct support for displaying unicode codepoints above
224565535 (the basic multilingual page). This increases storage 229565535 (the basic multilingual page). This increases storage
2246requirements per character from 2 to 4 bytes. X11 fonts do not yet 2296requirements per character from 2 to 4 bytes. X11 fonts do not yet
2247support these extra characters, but Xft does. 2297support these extra characters, but Xft does.
2248 2298
2249Please note that rxvt-unicode can store unicode code points >65535 2299Please note that rxvt-unicode can store unicode code points >65535
2250even without this flag, but the number of such characters is 2300even without this flag, but the number of such characters is
2251limited to a view thousand (shared with combining characters, 2301limited to a few thousand (shared with combining characters,
2252see next switch), and right now rxvt-unicode cannot display them 2302see next switch), and right now rxvt-unicode cannot display them
2253(input/output and cut&paste still work, though). 2303(input/output and cut&paste still work, though).
2254 2304
2255=item --enable-combining 2305=item --enable-combining (default: on)
2256 2306
2257Enable automatic composition of combining characters into 2307Enable automatic composition of combining characters into
2258composite characters. This is required for proper viewing of text 2308composite characters. This is required for proper viewing of text
2259where accents are encoded as seperate unicode characters. This is 2309where accents are encoded as separate unicode characters. This is
2260done by using precomposited characters when available or creating 2310done by using precomposited characters when available or creating
2261new pseudo-characters when no precomposed form exists. 2311new pseudo-characters when no precomposed form exists.
2262 2312
2263Without --enable-unicode3, the number of additional precomposed characters 2313Without --enable-unicode3, the number of additional precomposed
2264is rather limited (2048, if this is full, rxvt-unicode will use the 2314characters is somewhat limited (the 6400 private use characters will be
2265private use area, extending the number of combinations to 8448). With
2266--enable-unicode3, no practical limit exists. 2315(ab-)used). With --enable-unicode3, no practical limit exists.
2267 2316
2268This option will also enable storage (but not display) of characters 2317This option will also enable storage (but not display) of characters
2269beyond plane 0 (>65535) when --enable-unicode3 was not specified. 2318beyond plane 0 (>65535) when --enable-unicode3 was not specified.
2270 2319
2271The combining table also contains entries for arabic presentation forms, 2320The combining table also contains entries for arabic presentation forms,
2272but these are not currently used. Bug me if you want these to be used (and 2321but these are not currently used. Bug me if you want these to be used (and
2273tell me how these are to be used...). 2322tell me how these are to be used...).
2274 2323
2275=item --enable-fallback(=CLASS) 2324=item --enable-fallback(=CLASS) (default: Rxvt)
2276 2325
2277When reading resource settings, also read settings for class CLASS 2326When reading resource settings, also read settings for class CLASS. To
2278(default: Rxvt). To disable resource fallback use --disable-fallback. 2327disable resource fallback use --disable-fallback.
2279 2328
2280=item --with-res-name=NAME 2329=item --with-res-name=NAME (default: urxvt)
2281 2330
2282Use the given name (default: urxvt) as default application name when 2331Use the given name as default application name when
2283reading resources. Specify --with-res-name=rxvt to replace rxvt. 2332reading resources. Specify --with-res-name=rxvt to replace rxvt.
2284 2333
2285=item --with-res-class=CLASS 2334=item --with-res-class=CLASS (default: URxvt)
2286 2335
2287Use the given class (default: URxvt) as default application class 2336Use the given class as default application class
2288when reading resources. Specify --with-res-class=Rxvt to replace 2337when reading resources. Specify --with-res-class=Rxvt to replace
2289rxvt. 2338rxvt.
2290 2339
2291=item --enable-utmp 2340=item --enable-utmp (default: on)
2292 2341
2293Write user and tty to utmp file (used by programs like F<w>) at 2342Write user and tty to utmp file (used by programs like F<w>) at
2294start of rxvt execution and delete information when rxvt exits. 2343start of rxvt execution and delete information when rxvt exits.
2295 2344
2296=item --enable-wtmp 2345=item --enable-wtmp (default: on)
2297 2346
2298Write user and tty to wtmp file (used by programs like F<last>) at 2347Write user and tty to wtmp file (used by programs like F<last>) at
2299start of rxvt execution and write logout when rxvt exits. This 2348start of rxvt execution and write logout when rxvt exits. This
2300option requires --enable-utmp to also be specified. 2349option requires --enable-utmp to also be specified.
2301 2350
2302=item --enable-lastlog 2351=item --enable-lastlog (default: on)
2303 2352
2304Write user and tty to lastlog file (used by programs like 2353Write user and tty to lastlog file (used by programs like
2305F<lastlogin>) at start of rxvt execution. This option requires 2354F<lastlogin>) at start of rxvt execution. This option requires
2306--enable-utmp to also be specified. 2355--enable-utmp to also be specified.
2307 2356
2308=item --enable-xpm-background 2357=item --enable-afterimage (default: on)
2309 2358
2310Add support for XPM background pixmaps. 2359Add support for libAfterImage to be used for background
2360images. It adds support for many file formats including JPG, PNG,
2361SVG, TIFF, GIF, XPM, BMP, ICO, XCF, TGA and AfterStep image XML
2362(L<http://www.afterstep.org/visualdoc.php?show=asimagexml>).
2311 2363
2364Note that with this option enabled, @@RXVT_NAME@@'s memory footprint might
2365increase by a few megabytes even if no extra features are used (mostly due
2366to third-party libraries used by libAI). Memory footprint may somewhat be
2367lowered if libAfterImage is configured without support for SVG.
2368
2369=item --enable-pixbuf (default: off)
2370
2371Add support for GDK-PixBuf to be used for background images.
2372It adds support for many file formats including JPG, PNG,
2373TIFF, GIF, XPM, BMP, ICO and TGA.
2374
2312=item --enable-transparency 2375=item --enable-transparency (default: on)
2313 2376
2314Add support for inheriting parent backgrounds thus giving a fake 2377Add support for using the root pixmap as background to simulate transparency.
2315transparency to the term. 2378Note that tint, blur and blend effects depend on libAfterImage or on
2379libXrender and on the availability of the RENDER extension in the X
2380server.
2316 2381
2317=item --enable-fading 2382=item --enable-fading (default: on)
2318 2383
2319Add support for fading the text when focus is lost. 2384Add support for fading the text when focus is lost.
2320 2385
2321=item --enable-tinting
2322
2323Add support for tinting of transparent backgrounds.
2324
2325=item --enable-menubar
2326
2327Add support for our menu bar system (this interacts badly with
2328dynamic locale switching currently).
2329
2330=item --enable-rxvt-scroll 2386=item --enable-rxvt-scroll (default: on)
2331 2387
2332Add support for the original rxvt scrollbar. 2388Add support for the original rxvt scrollbar.
2333 2389
2334=item --enable-next-scroll 2390=item --enable-next-scroll (default: on)
2335 2391
2336Add support for a NeXT-like scrollbar. 2392Add support for a NeXT-like scrollbar.
2337 2393
2338=item --enable-xterm-scroll 2394=item --enable-xterm-scroll (default: on)
2339 2395
2340Add support for an Xterm-like scrollbar. 2396Add support for an Xterm-like scrollbar.
2341 2397
2342=item --enable-plain-scroll
2343
2344Add support for a very unobtrusive, plain-looking scrollbar that
2345is the favourite of the rxvt-unicode author, having used it for
2346many years.
2347
2348=item --enable-half-shadow
2349
2350Make shadows on the scrollbar only half the normal width & height.
2351only applicable to rxvt scrollbars.
2352
2353=item --enable-ttygid
2354
2355Change tty device setting to group "tty" - only use this if
2356your system uses this type of security.
2357
2358=item --disable-backspace-key 2398=item --disable-backspace-key
2359 2399
2360Disable any handling of the backspace key by us - let the X server 2400Removes any handling of the backspace key by us - let the X server do it.
2401
2402=item --disable-delete-key
2403
2404Removes any handling of the delete key by us - let the X server
2361do it. 2405do it.
2362 2406
2363=item --disable-delete-key
2364
2365Disable any handling of the delete key by us - let the X server
2366do it.
2367
2368=item --disable-resources 2407=item --disable-resources
2369 2408
2370Remove all resources checking. 2409Removes any support for resource checking.
2371
2372=item --enable-xgetdefault
2373
2374Make resources checking via XGetDefault() instead of our small
2375version which only checks ~/.Xdefaults, or if that doesn't exist then
2376~/.Xresources.
2377
2378Please note that nowadays, things like XIM will automatically pull in and
2379use the full X resource manager, so the overhead of using it might be very
2380small, if nonexistant.
2381
2382=item --enable-strings
2383
2384Add support for our possibly faster memset() function and other
2385various routines, overriding your system's versions which may
2386have been hand-crafted in assembly or may require extra libraries
2387to link in. (this breaks ANSI-C rules and has problems on many
2388GNU/Linux systems).
2389 2410
2390=item --disable-swapscreen 2411=item --disable-swapscreen
2391 2412
2392Remove support for swap screen. 2413Remove support for secondary/swap screen.
2393 2414
2394=item --enable-frills 2415=item --enable-frills (default: on)
2395 2416
2396Add support for many small features that are not essential but nice to 2417Add support for many small features that are not essential but nice to
2397have. Normally you want this, but for very small binaries you may want to 2418have. Normally you want this, but for very small binaries you may want to
2398disable this. 2419disable this.
2399 2420
2400A non-exhaustive list of features enabled by C<--enable-frills> (possibly 2421A non-exhaustive list of features enabled by C<--enable-frills> (possibly
2401in combination with other switches) is: 2422in combination with other switches) is:
2402 2423
2403 MWM-hints 2424 MWM-hints
2404 EWMH-hints (pid, utf8 names) and protocols (ping) 2425 EWMH-hints (pid, utf8 names) and protocols (ping)
2405 seperate underline colour 2426 urgency hint
2427 separate underline colour (-underlineColor)
2406 settable border widths and borderless switch 2428 settable border widths and borderless switch (-w, -b, -bl)
2429 visual depth selection (-depth)
2407 settable extra linespacing 2430 settable extra linespacing (-lsp)
2408 iso-14755-2 and -3, and visual feedback 2431 iso-14755 5.1 (basic) support
2432 tripleclickwords (-tcw)
2433 settable insecure mode (-insecure)
2434 keysym remapping support
2435 cursor blinking and underline cursor (-bc, -uc)
2436 XEmbed support (-embed)
2437 user-pty (-pty-fd)
2438 hold on exit (-hold)
2439 compile in built-in block graphics
2440 skip builtin block graphics (-sbg)
2441 separate highlight colour (-highlightColor, -highlightTextColor)
2442
2443It also enables some non-essential features otherwise disabled, such as:
2444
2445 some round-trip time optimisations
2446 nearest colour allocation on pseudocolor screens
2447 UTF8_STRING support for selection
2448 sgr modes 90..97 and 100..107
2409 backindex and forwardindex escape sequence 2449 backindex and forwardindex escape sequences
2450 view change/zero scrollback escape sequences
2451 locale switching escape sequence
2410 window op and some xterm/OSC escape sequences 2452 window op and some xterm/OSC escape sequences
2411 tripleclickwords 2453 rectangular selections
2412 settable insecure mode 2454 trailing space removal for selections
2413 keysym remapping support 2455 verbose X error handling
2414 cursor blinking and underline cursor
2415 -embed and -pty-fd options
2416 2456
2417=item --enable-iso14755 2457=item --enable-iso14755 (default: on)
2418 2458
2419Enable extended ISO 14755 support (see @@RXVT_NAME@@(1), or 2459Enable extended ISO 14755 support (see @@RXVT_NAME@@(1)).
2420F<doc/rxvt.1.txt>). Basic support (section 5.1) is enabled by 2460Basic support (section 5.1) is enabled by C<--enable-frills>, while
2421C<--enable-frills>, while support for 5.2, 5.3 and 5.4 is enabled with 2461support for 5.2, 5.3 and 5.4 is enabled with this switch.
2422this switch.
2423 2462
2424=item --enable-keepscrolling 2463=item --enable-keepscrolling (default: on)
2425 2464
2426Add support for continual scrolling of the display when you hold 2465Add support for continual scrolling of the display when you hold
2427the mouse button down on a scrollbar arrow. 2466the mouse button down on a scrollbar arrow.
2428 2467
2468=item --enable-selectionscrolling (default: on)
2469
2470Add support for scrolling when the selection moves to the top or
2471bottom of the screen.
2472
2429=item --enable-mousewheel 2473=item --enable-mousewheel (default: on)
2430 2474
2431Add support for scrolling via mouse wheel or buttons 4 & 5. 2475Add support for scrolling via mouse wheel or buttons 4 & 5.
2432 2476
2433=item --enable-slipwheeling 2477=item --enable-slipwheeling (default: on)
2434 2478
2435Add support for continual scrolling (using the mouse wheel as an 2479Add support for continual scrolling (using the mouse wheel as an
2436accelerator) while the control key is held down. This option 2480accelerator) while the control key is held down. This option
2437requires --enable-mousewheel to also be specified. 2481requires --enable-mousewheel to also be specified.
2438 2482
2439=item --disable-new-selection
2440
2441Remove support for mouse selection style like that of xterm.
2442
2443=item --enable-dmalloc
2444
2445Use Gray Watson's malloc - which is good for debugging See
2446http://www.letters.com/dmalloc/ for details If you use either this or the
2447next option, you may need to edit src/Makefile after compiling to point
2448DINCLUDE and DLIB to the right places.
2449
2450You can only use either this option and the following (should
2451you use either) .
2452
2453=item --enable-dlmalloc
2454
2455Use Doug Lea's malloc - which is good for a production version
2456See L<http://g.oswego.edu/dl/html/malloc.html> for details.
2457
2458=item --enable-smart-resize 2483=item --enable-smart-resize (default: off)
2459 2484
2460Add smart growth/shrink behaviour when changing font size via from hot 2485Add smart growth/shrink behaviour when resizing.
2461keys. This should keep in a fixed position the rxvt corner which is 2486This should keep the window corner which is closest to a corner of
2462closest to a corner of the screen. 2487the screen in a fixed position.
2463 2488
2489=item --enable-text-blink (default: on)
2490
2491Add support for blinking text.
2492
2464=item --enable-pointer-blank 2493=item --enable-pointer-blank (default: on)
2465 2494
2466Add support to have the pointer disappear when typing or inactive. 2495Add support to have the pointer disappear when typing or inactive.
2467 2496
2468=item --with-name=NAME 2497=item --enable-perl (default: on)
2469 2498
2499Enable an embedded perl interpreter. See the B<@@RXVT_NAME@@perl(3)>
2500manpage for more info on this feature, or the files in F<src/perl/>
2501for the extensions that are installed by default.
2502The perl interpreter that is used can be specified via the C<PERL>
2503environment variable when running configure. Even when compiled in,
2504perl will I<not> be initialised when all extensions have been disabled
2505C<-pe "" --perl-ext-common "">, so it should be safe to enable from a
2506resource standpoint.
2507
2508=item --enable-assert (default: off)
2509
2510Enables the assertions in the code, normally disabled. This switch is only
2511useful when developing rxvt-unicode.
2512
2513=item --enable-256-color (default: off)
2514
2515Force use of so-called 256 colour mode, to work around buggy applications
2516that do not support termcap/terminfo, or simply improve support for
2517applications hardcoding the xterm 256 colour table.
2518
2519This switch breaks termcap/terminfo compatibility to C<TERM=rxvt-unicode>,
2520and consequently sets C<TERM> to C<rxvt-unicode-256color> by default
2521(F<doc/etc/> contains termcap/terminfo definitions for both).
2522
2523It also results in higher memory usage and can slow down @@RXVT_NAME@@
2524dramatically when more than six fonts are in use by a terminal instance.
2525
2526=item --with-afterimage-config=DIR
2527
2528Look for the libAfterImage config script in DIR.
2529
2530=item --with-name=NAME (default: urxvt)
2531
2470Set the basename for the installed binaries (default: C<urxvt>, resulting 2532Set the basename for the installed binaries, resulting
2471in C<urxvt>, C<urxvtd> etc.). Specify C<--with-name=rxvt> to replace with 2533in C<urxvt>, C<urxvtd> etc.). Specify C<--with-name=rxvt> to replace with
2472C<rxvt>. 2534C<rxvt>.
2473 2535
2474=item --with-term=NAME 2536=item --with-term=NAME (default: rxvt-unicode)
2475 2537
2476Change the environmental variable for the terminal to NAME (default 2538Change the environmental variable for the terminal to NAME.
2477C<rxvt-unicode>)
2478 2539
2479=item --with-terminfo=PATH 2540=item --with-terminfo=PATH
2480 2541
2481Change the environmental variable for the path to the terminfo tree to 2542Change the environmental variable for the path to the terminfo tree to
2482PATH. 2543PATH.
2483 2544
2484=item --with-x 2545=item --with-x
2485 2546
2486Use the X Window System (pretty much default, eh?). 2547Use the X Window System (pretty much default, eh?).
2487
2488=item --with-xpm-includes=DIR
2489
2490Look for the XPM includes in DIR.
2491
2492=item --with-xpm-library=DIR
2493
2494Look for the XPM library in DIR.
2495
2496=item --with-xpm
2497
2498Not needed - define via --enable-xpm-background.
2499 2548
2500=back 2549=back
2501 2550
2502=head1 AUTHORS 2551=head1 AUTHORS
2503 2552

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines