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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines