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.12 by root, Mon Aug 16 00:17:27 2004 UTC vs.
Revision 1.89 by root, Wed Jan 18 21:00:39 2006 UTC

1=head1 NAME
2
3RXVT REFERENCE - FAQ, command sequences and other background information
4
5=head1 SYNOPSIS
6
7 # set a new font set
8 printf '\33]50;%s\007' 9x15,xft:Kochi" Mincho"
9
10 # change the locale and tell rxvt-unicode about it
11 export LC_CTYPE=ja_JP.EUC-JP; printf "\33]701;$LC_CTYPE\007"
12
13 # set window title
14 printf '\33]2;%s\007' "new window title"
15
16=head1 DESCRIPTION
17
18This document contains the FAQ, the RXVT TECHNICAL REFERENCE documenting
19all escape sequences, and other background information.
20
21The newest version of this document is
22also available on the World Wide Web at
23L<http://cvs.schmorp.de/browse/*checkout*/rxvt-unicode/doc/rxvt.7.html>.
24
25=head1 FREQUENTLY ASKED QUESTIONS
26
27=over 4
28
29=item The new selection selects pieces that are too big, how can I select
30single words?
31
32Yes. For example, if you want to select alphanumeric words, you can use
33the following resource:
34
35 URxvt.selection.pattern-0: ([[:word:]]+)
36
37If you click more than twice, the selection will be extended
38more and more.
39
40To get a selection that is very similar to the old code, try this pattern:
41
42 URxvt.selection.pattern-0: ([^"&'()*,;<=>?@[\\\\]^`{|})]+)
43
44Please also note that the I<LeftClick Shift-LeftClik> combination also
45selects words like the old code.
46
47=item I don't like the new selection/popups/hotkeys/perl, how do I
48change/disable it?
49
50You can disable the perl extension completely by setting the
51B<perl-ext-common> resource to the empty string, which also keeps
52rxvt-unicode from initialising perl, saving memory.
53
54If you only want to disable specific features, you first have to
55identify which perl extension is responsible. For this, read the section
56B<PREPACKAGED EXTENSIONS> in the @@RXVT_NAME@@perl(3) manpage. For
57example, to disable the B<selection-popup> and B<option-popup>, specify
58this B<perl-ext-common> resource:
59
60 URxvt.perl-ext-common: default,-selection-popup,-option-popup
61
62This will keep the default extensions, but disable the two popup
63extensions. Some extensions can also be configured, for example,
64scrollback search mode is triggered by B<M-s>. You can move it to any
65other combination either by setting the B<searchable-scrollback> resource:
66
67 URxvt.searchable-scrollback: CM-s
68
69=item Isn't rxvt supposed to be small? Don't all those features bloat?
70
71I often get asked about this, and I think, no, they didn't cause extra
72bloat. If you compare a minimal rxvt and a minimal urxvt, you can see
73that the urxvt binary is larger (due to some encoding tables always being
74compiled in), but it actually uses less memory (RSS) after startup. Even
75with C<--disable-everything>, this comparison is a bit unfair, as many
76features unique to urxvt (locale, encoding conversion, iso14755 etc.) are
77already in use in this mode.
78
79 text data bss drs rss filename
80 98398 1664 24 15695 1824 rxvt --disable-everything
81 188985 9048 66616 18222 1788 urxvt --disable-everything
82
83When you C<--enable-everything> (which _is_ unfair, as this involves xft
84and full locale/XIM support which are quite bloaty inside libX11 and my
85libc), the two diverge, but not unreasnobaly so.
86
87 text data bss drs rss filename
88 163431 2152 24 20123 2060 rxvt --enable-everything
89 1035683 49680 66648 29096 3680 urxvt --enable-everything
90
91The very large size of the text section is explained by the east-asian
92encoding tables, which, if unused, take up disk space but nothing else
93and can be compiled out unless you rely on X11 core fonts that use those
94encodings. The BSS size comes from the 64k emergency buffer that my c++
95compiler allocates (but of course doesn't use unless you are out of
96memory). Also, using an xft font instead of a core font immediately adds a
97few megabytes of RSS. Xft indeed is responsible for a lot of RSS even when
98not used.
99
100Of course, due to every character using two or four bytes instead of one,
101a large scrollback buffer will ultimately make rxvt-unicode use more
102memory.
103
104Compared to e.g. Eterm (5112k), aterm (3132k) and xterm (4680k), this
105still fares rather well. And compared to some monsters like gnome-terminal
106(21152k + extra 4204k in separate processes) or konsole (22200k + extra
10743180k in daemons that stay around after exit, plus half a minute of
108startup time, including the hundreds of warnings it spits out), it fares
109extremely well *g*.
110
111=item Why C++, isn't that unportable/bloated/uncool?
112
113Is this a question? :) It comes up very often. The simple answer is: I had
114to write it, and C++ allowed me to write and maintain it in a fraction
115of the time and effort (which is a scarce resource for me). Put even
116shorter: It simply wouldn't exist without C++.
117
118My personal stance on this is that C++ is less portable than C, but in
119the case of rxvt-unicode this hardly matters, as its portability limits
120are defined by things like X11, pseudo terminals, locale support and unix
121domain sockets, which are all less portable than C++ itself.
122
123Regarding the bloat, see the above question: It's easy to write programs
124in C that use gobs of memory, an certainly possible to write programs in
125C++ that don't. C++ also often comes with large libraries, but this is
126not necessarily the case with GCC. Here is what rxvt links against on my
127system with a minimal config:
128
129 libX11.so.6 => /usr/X11R6/lib/libX11.so.6 (0x00002aaaaabc3000)
130 libc.so.6 => /lib/libc.so.6 (0x00002aaaaadde000)
131 libdl.so.2 => /lib/libdl.so.2 (0x00002aaaab01d000)
132 /lib64/ld-linux-x86-64.so.2 (0x00002aaaaaaab000)
133
134And here is rxvt-unicode:
135
136 libX11.so.6 => /usr/X11R6/lib/libX11.so.6 (0x00002aaaaabc3000)
137 libgcc_s.so.1 => /lib/libgcc_s.so.1 (0x00002aaaaada2000)
138 libc.so.6 => /lib/libc.so.6 (0x00002aaaaaeb0000)
139 libdl.so.2 => /lib/libdl.so.2 (0x00002aaaab0ee000)
140 /lib64/ld-linux-x86-64.so.2 (0x00002aaaaaaab000)
141
142No large bloated libraries (of course, none were linked in statically),
143except maybe libX11 :)
144
145=item Does it support tabs, can I have a tabbed rxvt-unicode?
146
147rxvt-unicode does not directly support tabs. It will work fine with
148tabbing functionality of many window managers or similar tabbing programs,
149and its embedding-features allow it to be embedded into other programs,
150as witnessed by F<doc/rxvt-tabbed> or the upcoming C<Gtk2::URxvt> perl
151module, which features a tabbed urxvt (murxvt) terminal as an example
152embedding application.
153
154=item How do I know which rxvt-unicode version I'm using?
155
156The version number is displayed with the usage (-h). Also the escape
157sequence C<ESC [ 8 n> sets the window title to the version number. When
158using the @@RXVT_NAME@@c client, the version displayed is that of the
159daemon.
160
161=item I am using Debian GNU/Linux and have a problem...
162
163The Debian GNU/Linux package of rxvt-unicode in sarge contains large
164patches that considerably change the behaviour of rxvt-unicode (but
165unfortunately this notice has been removed). Before reporting a bug to
166the original rxvt-unicode author please download and install the genuine
167version (L<http://software.schmorp.de#rxvt-unicode>) and try to reproduce
168the problem. If you cannot, chances are that the problems are specific to
169Debian GNU/Linux, in which case it should be reported via the Debian Bug
170Tracking System (use C<reportbug> to report the bug).
171
172For other problems that also affect the Debian package, you can and
173probably should use the Debian BTS, too, because, after all, it's also a
174bug in the Debian version and it serves as a reminder for other users that
175might encounter the same issue.
176
177=item I am maintaining rxvt-unicode for distribution/OS XXX, any
178recommendation?
179
180You should build one binary with the default options. F<configure>
181now enables most useful options, and the trend goes to making them
182runtime-switchable, too, so there is usually no drawback to enbaling them,
183except higher disk and possibly memory usage. The perl interpreter should
184be enabled, as important functionality (menus, selection, likely more in
185the future) depends on it.
186
187You should not overwrite the C<perl-ext-common> snd C<perl-ext> resources
188system-wide (except maybe with C<defaults>). This will result in useful
189behaviour. If your distribution aims at low memory, add an empty
190C<perl-ext-common> resource to the app-defaults file. This will keep the
191perl interpreter disabled until the user enables it.
192
193If you can/want build more binaries, I recommend building a minimal
194one with C<--disable-everything> (very useful) and a maximal one with
195C<--enable-everything> (less useful, it will be very big due to a lot of
196encodings built-in that increase download times and are rarely used).
197
198=item I need to make it setuid/setgid to support utmp/ptys on my OS, is this safe?
199
200It should be, starting with release 7.1. You are encouraged to properly
201install urxvt with privileges necessary for your OS now.
202
203When rxvt-unicode detects that it runs setuid or setgid, it will fork
204into a helper process for privileged operations (pty handling on some
205systems, utmp/wtmp/lastlog handling on others) and drop privileges
206immediately. This is much safer than most other terminals that keep
207privileges while running (but is more relevant to urxvt, as it contains
208things as perl interpreters, which might be "helpful" to attackers).
209
210This forking is done as the very first within main(), which is very early
211and reduces possible bugs to initialisation code run before main(), or
212things like the dynamic loader of your system, which should result in very
213little risk.
214
215=item When I log-in to another system it tells me about missing terminfo data?
216
217The terminal description used by rxvt-unicode is not as widely available
218as that for xterm, or even rxvt (for which the same problem often arises).
219
220The correct solution for this problem is to install the terminfo, this can
221be done like this (with ncurses' infocmp):
222
223 REMOTE=remotesystem.domain
224 infocmp rxvt-unicode | ssh $REMOTE "cat >/tmp/ti && tic /tmp/ti"
225
226... or by installing rxvt-unicode normally on the remote system,
227
228If you cannot or do not want to do this, then you can simply set
229C<TERM=rxvt> or even C<TERM=xterm>, and live with the small number of
230problems arising, which includes wrong keymapping, less and different
231colours and some refresh errors in fullscreen applications. It's a nice
232quick-and-dirty workaround for rare cases, though.
233
234If you always want to do this (and are fine with the consequences) you
235can either recompile rxvt-unicode with the desired TERM value or use a
236resource to set it:
237
238 URxvt.termName: rxvt
239
240If you don't plan to use B<rxvt> (quite common...) you could also replace
241the rxvt terminfo file with the rxvt-unicode one.
242
243=item C<tic> outputs some error when compiling the terminfo entry.
244
245Most likely it's the empty definition for C<enacs=>. Just replace it by
246C<enacs=\E[0@> and try again.
247
248=item C<bash>'s readline does not work correctly under @@RXVT_NAME@@.
249
250=item I need a termcap file entry.
251
252One reason you might want this is that some distributions or operating
253systems still compile some programs using the long-obsoleted termcap
254library (Fedora Core's bash is one example) and rely on a termcap entry
255for C<rxvt-unicode>.
256
257You could use rxvt's termcap entry with resonable results in many cases.
258You can also create a termcap entry by using terminfo's infocmp program
259like this:
260
261 infocmp -C rxvt-unicode
262
263Or you could use this termcap entry, generated by the command above:
264
265 rxvt-unicode|rxvt-unicode terminal (X Window System):\
266 :am:bw:eo:km:mi:ms:xn:xo:\
267 :co#80:it#8:li#24:lm#0:\
268 :AL=\E[%dL:DC=\E[%dP:DL=\E[%dM:DO=\E[%dB:IC=\E[%d@:\
269 :K1=\EOw:K2=\EOu:K3=\EOy:K4=\EOq:K5=\EOs:LE=\E[%dD:\
270 :RI=\E[%dC:SF=\E[%dS:SR=\E[%dT:UP=\E[%dA:ae=\E(B:al=\E[L:\
271 :as=\E(0:bl=^G:cd=\E[J:ce=\E[K:cl=\E[H\E[2J:\
272 :cm=\E[%i%d;%dH:cr=^M:cs=\E[%i%d;%dr:ct=\E[3g:dc=\E[P:\
273 :dl=\E[M:do=^J:ec=\E[%dX:ei=\E[4l:ho=\E[H:\
274 :i1=\E[?47l\E=\E[?1l:ic=\E[@:im=\E[4h:\
275 :is=\E[r\E[m\E[2J\E[H\E[?7h\E[?1;3;4;6l\E[4l:\
276 :k1=\E[11~:k2=\E[12~:k3=\E[13~:k4=\E[14~:k5=\E[15~:\
277 :k6=\E[17~:k7=\E[18~:k8=\E[19~:k9=\E[20~:kD=\E[3~:\
278 :kI=\E[2~:kN=\E[6~:kP=\E[5~:kb=\177:kd=\EOB:ke=\E[?1l\E>:\
279 :kh=\E[7~:kl=\EOD:kr=\EOC:ks=\E[?1h\E=:ku=\EOA:le=^H:\
280 :mb=\E[5m:md=\E[1m:me=\E[m\017:mr=\E[7m:nd=\E[C:rc=\E8:\
281 :sc=\E7:se=\E[27m:sf=^J:so=\E[7m:sr=\EM:st=\EH:ta=^I:\
282 :te=\E[r\E[?1049l:ti=\E[?1049h:ue=\E[24m:up=\E[A:\
283 :us=\E[4m:vb=\E[?5h\E[?5l:ve=\E[?25h:vi=\E[?25l:\
284 :vs=\E[?25h:
285
286=item Why does C<ls> no longer have coloured output?
287
288The C<ls> in the GNU coreutils unfortunately doesn't use terminfo to
289decide wether a terminal has colour, but uses it's own configuration
290file. Needless to say, C<rxvt-unicode> is not in it's default file (among
291with most other terminals supporting colour). Either add:
292
293 TERM rxvt-unicode
294
295to C</etc/DIR_COLORS> or simply add:
296
297 alias ls='ls --color=auto'
298
299to your C<.profile> or C<.bashrc>.
300
301=item Why doesn't vim/emacs etc. use the 88 colour mode?
302
303=item Why doesn't vim/emacs etc. make use of italic?
304
305=item Why are the secondary screen-related options not working properly?
306
307Make sure you are using C<TERM=rxvt-unicode>. Some pre-packaged
308distributions (most notably Debian GNU/Linux) break rxvt-unicode
309by setting C<TERM> to C<rxvt>, which doesn't have these extra
310features. Unfortunately, some of these (most notably, again, Debian
311GNU/Linux) furthermore fail to even install the C<rxvt-unicode> terminfo
312file, so you will need to install it on your own (See the question B<When
313I log-in to another system it tells me about missing terminfo data?> on
314how to do this).
315
316=item My numerical keypad acts weird and generates differing output?
317
318Some Debian GNUL/Linux users seem to have this problem, although no
319specific details were reported so far. It is possible that this is caused
320by the wrong C<TERM> setting, although the details of wether and how
321this can happen are unknown, as C<TERM=rxvt> should offer a compatible
322keymap. See the answer to the previous question, and please report if that
323helped.
324
325=item Rxvt-unicode does not seem to understand the selected encoding?
326
327=item Unicode does not seem to work?
328
329If you encounter strange problems like typing an accented character but
330getting two unrelated other characters or similar, or if program output is
331subtly garbled, then you should check your locale settings.
332
333Rxvt-unicode must be started with the same C<LC_CTYPE> setting as the
334programs. Often rxvt-unicode is started in the C<C> locale, while the
335login script running within the rxvt-unicode window changes the locale to
336something else, e.g. C<en_GB.UTF-8>. Needless to say, this is not going to work.
337
338The best thing is to fix your startup environment, as you will likely run
339into other problems. If nothing works you can try this in your .profile.
340
341 printf '\e]701;%s\007' "$LC_CTYPE"
342
343If this doesn't work, then maybe you use a C<LC_CTYPE> specification not
344supported on your systems. Some systems have a C<locale> command which
345displays this (also, C<perl -e0> can be used to check locale settings, as
346it will complain loudly if it cannot set the locale). If it displays something
347like:
348
349 locale: Cannot set LC_CTYPE to default locale: ...
350
351Then the locale you specified is not supported on your system.
352
353If nothing works and you are sure that everything is set correctly then
354you will need to remember a little known fact: Some programs just don't
355support locales :(
356
357=item Why do some characters look so much different than others?
358
359=item How does rxvt-unicode choose fonts?
360
361Most fonts do not contain the full range of Unicode, which is
362fine. Chances are that the font you (or the admin/package maintainer of
363your system/os) have specified does not cover all the characters you want
364to display.
365
366B<rxvt-unicode> makes a best-effort try at finding a replacement
367font. Often the result is fine, but sometimes the chosen font looks
368bad/ugly/wrong. Some fonts have totally strange characters that don't
369resemble the correct glyph at all, and rxvt-unicode lacks the artificial
370intelligence to detect that a specific glyph is wrong: it has to believe
371the font that the characters it claims to contain indeed look correct.
372
373In that case, select a font of your taste and add it to the font list,
374e.g.:
375
376 @@RXVT_NAME@@ -fn basefont,font2,font3...
377
378When rxvt-unicode sees a character, it will first look at the base
379font. If the base font does not contain the character, it will go to the
380next font, and so on. Specifying your own fonts will also speed up this
381search and use less resources within rxvt-unicode and the X-server.
382
383The only limitation is that none of the fonts may be larger than the base
384font, as the base font defines the terminal character cell size, which
385must be the same due to the way terminals work.
386
387=item Why do some chinese characters look so different than others?
388
389This is because there is a difference between script and language --
390rxvt-unicode does not know which language the text that is output is,
391as it only knows the unicode character codes. If rxvt-unicode first
392sees a japanese/chinese character, it might choose a japanese font for
393display. Subsequent japanese characters will use that font. Now, many
394chinese characters aren't represented in japanese fonts, so when the first
395non-japanese character comes up, rxvt-unicode will look for a chinese font
396-- unfortunately at this point, it will still use the japanese font for
397chinese characters that are also in the japanese font.
398
399The workaround is easy: just tag a chinese font at the end of your font
400list (see the previous question). The key is to view the font list as
401a preference list: If you expect more japanese, list a japanese font
402first. If you expect more chinese, put a chinese font first.
403
404In the future it might be possible to switch language preferences at
405runtime (the internal data structure has no problem with using different
406fonts for the same character at the same time, but no interface for this
407has been designed yet).
408
409Until then, you might get away with switching fonts at runtime (see L<Can
410I switch the fonts at runtime?> later in this document).
411
412=item Why does rxvt-unicode sometimes leave pixel droppings?
413
414Most fonts were not designed for terminal use, which means that character
415size varies a lot. A font that is otherwise fine for terminal use might
416contain some characters that are simply too wide. Rxvt-unicode will avoid
417these characters. For characters that are just "a bit" too wide a special
418"careful" rendering mode is used that redraws adjacent characters.
419
420All of this requires that fonts do not lie about character sizes,
421however: Xft fonts often draw glyphs larger than their acclaimed bounding
422box, and rxvt-unicode has no way of detecting this (the correct way is to
423ask for the character bounding box, which unfortunately is wrong in these
424cases).
425
426It's not clear (to me at least), wether this is a bug in Xft, freetype,
427or the respective font. If you encounter this problem you might try using
428the C<-lsp> option to give the font more height. If that doesn't work, you
429might be forced to use a different font.
430
431All of this is not a problem when using X11 core fonts, as their bounding
432box data is correct.
433
434=item On Solaris 9, many line-drawing characters are too wide.
435
436Seems to be a known bug, read
437L<http://nixdoc.net/files/forum/about34198.html>. Some people use the
438following ugly workaround to get non-double-wide-characters working:
439
440 #define wcwidth(x) wcwidth(x) > 1 ? 1 : wcwidth(x)
441
442=item My Compose (Multi_key) key is no longer working.
443
444The most common causes for this are that either your locale is not set
445correctly, or you specified a B<preeditStyle> that is not supported by
446your input method. For example, if you specified B<OverTheSpot> and
447your input method (e.g. the default input method handling Compose keys)
448does not support this (for instance because it is not visual), then
449rxvt-unicode will continue without an input method.
450
451In this case either do not specify a B<preeditStyle> or specify more than
452one pre-edit style, such as B<OverTheSpot,Root,None>.
453
454=item I cannot type C<Ctrl-Shift-2> to get an ASCII NUL character due to ISO 14755
455
456Either try C<Ctrl-2> alone (it often is mapped to ASCII NUL even on
457international keyboards) or simply use ISO 14755 support to your
458advantage, typing <Ctrl-Shift-0> to get a ASCII NUL. This works for other
459codes, too, such as C<Ctrl-Shift-1-d> to type the default telnet escape
460character and so on.
461
462=item How can I keep rxvt-unicode from using reverse video so much?
463
464First of all, make sure you are running with the right terminal settings
465(C<TERM=rxvt-unicode>), which will get rid of most of these effects. Then
466make sure you have specified colours for italic and bold, as otherwise
467rxvt-unicode might use reverse video to simulate the effect:
468
469 URxvt.colorBD: white
470 URxvt.colorIT: green
471
472=item Some programs assume totally weird colours (red instead of blue), how can I fix that?
473
474For some unexplainable reason, some rare programs assume a very weird
475colour palette when confronted with a terminal with more than the standard
4768 colours (rxvt-unicode supports 88). The right fix is, of course, to fix
477these programs not to assume non-ISO colours without very good reasons.
478
479In the meantime, you can either edit your C<rxvt-unicode> terminfo
480definition to only claim 8 colour support or use C<TERM=rxvt>, which will
481fix colours but keep you from using other rxvt-unicode features.
482
483=item I am on FreeBSD and rxvt-unicode does not seem to work at all.
484
485Rxvt-unicode requires the symbol C<__STDC_ISO_10646__> to be defined
486in your compile environment, or an implementation that implements it,
487wether it defines the symbol or not. C<__STDC_ISO_10646__> requires that
488B<wchar_t> is represented as unicode.
489
490As you might have guessed, FreeBSD does neither define this symobl nor
491does it support it. Instead, it uses it's own internal representation of
492B<wchar_t>. This is, of course, completely fine with respect to standards.
493
494However, that means rxvt-unicode only works in C<POSIX>, C<ISO-8859-1> and
495C<UTF-8> locales under FreeBSD (which all use Unicode as B<wchar_t>.
496
497C<__STDC_ISO_10646__> is the only sane way to support multi-language
498apps in an OS, as using a locale-dependent (and non-standardized)
499representation of B<wchar_t> makes it impossible to convert between
500B<wchar_t> (as used by X11 and your applications) and any other encoding
501without implementing OS-specific-wrappers for each and every locale. There
502simply are no APIs to convert B<wchar_t> into anything except the current
503locale encoding.
504
505Some applications (such as the formidable B<mlterm>) work around this
506by carrying their own replacement functions for character set handling
507with them, and either implementing OS-dependent hacks or doing multiple
508conversions (which is slow and unreliable in case the OS implements
509encodings slightly different than the terminal emulator).
510
511The rxvt-unicode author insists that the right way to fix this is in the
512system libraries once and for all, instead of forcing every app to carry
513complete replacements for them :)
514
515=item I use Solaris 9 and it doesn't compile/work/etc.
516
517Try the diff in F<doc/solaris9.patch> as a base. It fixes the worst
518problems with C<wcwidth> and a compile problem.
519
520=item How can I use rxvt-unicode under cygwin?
521
522rxvt-unicode should compile and run out of the box on cygwin, using
523the X11 libraries that come with cygwin. libW11 emulation is no
524longer supported (and makes no sense, either, as it only supported a
525single font). I recommend starting the X-server in C<-multiwindow> or
526C<-rootless> mode instead, which will result in similar look&feel as the
527old libW11 emulation.
528
529At the time of this writing, cygwin didn't seem to support any multi-byte
530encodings (you might try C<LC_CTYPE=C-UTF-8>), so you are likely limited
531to 8-bit encodings.
532
533=item How does rxvt-unicode determine the encoding to use?
534
535=item Is there an option to switch encodings?
536
537Unlike some other terminals, rxvt-unicode has no encoding switch, and no
538specific "utf-8" mode, such as xterm. In fact, it doesn't even know about
539UTF-8 or any other encodings with respect to terminal I/O.
540
541The reasons is that there exists a perfectly fine mechanism for selecting
542the encoding, doing I/O and (most important) communicating this to all
543applications so everybody agrees on character properties such as width
544and code number. This mechanism is the I<locale>. Applications not using
545that info will have problems (for example, C<xterm> gets the width of
546characters wrong as it uses it's own, locale-independent table under all
547locales).
548
549Rxvt-unicode uses the C<LC_CTYPE> locale category to select encoding. All
550programs doing the same (that is, most) will automatically agree in the
551interpretation of characters.
552
553Unfortunately, there is no system-independent way to select locales, nor
554is there a standard on how locale specifiers will look like.
555
556On most systems, the content of the C<LC_CTYPE> environment variable
557contains an arbitrary string which corresponds to an already-installed
558locale. Common names for locales are C<en_US.UTF-8>, C<de_DE.ISO-8859-15>,
559C<ja_JP.EUC-JP>, i.e. C<language_country.encoding>, but other forms
560(i.e. C<de> or C<german>) are also common.
561
562Rxvt-unicode ignores all other locale categories, and except for
563the encoding, ignores country or language-specific settings,
564i.e. C<de_DE.UTF-8> and C<ja_JP.UTF-8> are the normally same to
565rxvt-unicode.
566
567If you want to use a specific encoding you have to make sure you start
568rxvt-unicode with the correct C<LC_CTYPE> category.
569
570=item Can I switch locales at runtime?
571
572Yes, using an escape sequence. Try something like this, which sets
573rxvt-unicode's idea of C<LC_CTYPE>.
574
575 printf '\e]701;%s\007' ja_JP.SJIS
576
577See also the previous answer.
578
579Sometimes this capability is rather handy when you want to work in
580one locale (e.g. C<de_DE.UTF-8>) but some programs don't support it
581(e.g. UTF-8). For example, I use this script to start C<xjdic>, which
582first switches to a locale supported by xjdic and back later:
583
584 printf '\e]701;%s\007' ja_JP.SJIS
585 xjdic -js
586 printf '\e]701;%s\007' de_DE.UTF-8
587
588You can also use xterm's C<luit> program, which usually works fine, except
589for some locales where character width differs between program- and
590rxvt-unicode-locales.
591
592=item Can I switch the fonts at runtime?
593
594Yes, using an escape sequence. Try something like this, which has the same
595effect as using the C<-fn> switch, and takes effect immediately:
596
597 printf '\e]50;%s\007' "9x15bold,xft:Kochi Gothic"
598
599This is useful if you e.g. work primarily with japanese (and prefer a
600japanese font), but you have to switch to chinese temporarily, where
601japanese fonts would only be in your way.
602
603You can think of this as a kind of manual ISO-2022 switching.
604
605=item Why do italic characters look as if clipped?
606
607Many fonts have difficulties with italic characters and hinting. For
608example, the otherwise very nicely hinted font C<xft:Bitstream Vera Sans
609Mono> completely fails in it's italic face. A workaround might be to
610enable freetype autohinting, i.e. like this:
611
612 URxvt.italicFont: xft:Bitstream Vera Sans Mono:italic:autohint=true
613 URxvt.boldItalicFont: xft:Bitstream Vera Sans Mono:bold:italic:autohint=true
614
615=item My input method wants <some encoding> but I want UTF-8, what can I do?
616
617You can specify separate locales for the input method and the rest of the
618terminal, using the resource C<imlocale>:
619
620 URxvt.imlocale: ja_JP.EUC-JP
621
622Now you can start your terminal with C<LC_CTYPE=ja_JP.UTF-8> and still
623use your input method. Please note, however, that you will not be able to
624input characters outside C<EUC-JP> in a normal way then, as your input
625method limits you.
626
627=item Rxvt-unicode crashes when the X Input Method changes or exits.
628
629Unfortunately, this is unavoidable, as the XIM protocol is racy by
630design. Applications can avoid some crashes at the expense of memory
631leaks, and Input Methods can avoid some crashes by careful ordering at
632exit time. B<kinput2> (and derived input methods) generally succeeds,
633while B<SCIM> (or similar input methods) fails. In the end, however,
634crashes cannot be completely avoided even if both sides cooperate.
635
636So the only workaround is not to kill your Input Method Servers.
637
638=item Rxvt-unicode uses gobs of memory, how can I reduce that?
639
640Rxvt-unicode tries to obey the rule of not charging you for something you
641don't use. One thing you should try is to configure out all settings that
642you don't need, for example, Xft support is a resource hog by design,
643when used. Compiling it out ensures that no Xft font will be loaded
644accidentally when rxvt-unicode tries to find a font for your characters.
645
646Also, many people (me included) like large windows and even larger
647scrollback buffers: Without C<--enable-unicode3>, rxvt-unicode will use
6486 bytes per screen cell. For a 160x?? window this amounts to almost a
649kilobyte per line. A scrollback buffer of 10000 lines will then (if full)
650use 10 Megabytes of memory. With C<--enable-unicode3> it gets worse, as
651rxvt-unicode then uses 8 bytes per screen cell.
652
653=item Can I speed up Xft rendering somehow?
654
655Yes, the most obvious way to speed it up is to avoid Xft entirely, as
656it is simply slow. If you still want Xft fonts you might try to disable
657antialiasing (by appending C<:antialias=false>), which saves lots of
658memory and also speeds up rendering considerably.
659
660=item Rxvt-unicode doesn't seem to anti-alias its fonts, what is wrong?
661
662Rxvt-unicode will use whatever you specify as a font. If it needs to
663fall back to it's default font search list it will prefer X11 core
664fonts, because they are small and fast, and then use Xft fonts. It has
665antialiasing disabled for most of them, because the author thinks they
666look best that way.
667
668If you want antialiasing, you have to specify the fonts manually.
669
670=item Mouse cut/paste suddenly no longer works.
671
672Make sure that mouse reporting is actually turned off since killing
673some editors prematurely may leave the mouse in mouse report mode. I've
674heard that tcsh may use mouse reporting unless it otherwise specified. A
675quick check is to see if cut/paste works when the Alt or Shift keys are
676depressed.
677
678=item What's with this bold/blink stuff?
679
680If no bold colour is set via C<colorBD:>, bold will invert text using the
681standard foreground colour.
682
683For the standard background colour, blinking will actually make the
684text blink when compiled with C<--enable-blinking>. with standard
685colours. Without C<--enable-blinking>, the blink attribute will be
686ignored.
687
688On ANSI colours, bold/blink attributes are used to set high-intensity
689foreground/background colors.
690
691color0-7 are the low-intensity colors.
692
693color8-15 are the corresponding high-intensity colors.
694
695=item I don't like the screen colors. How do I change them?
696
697You can change the screen colors at run-time using F<~/.Xdefaults>
698resources (or as long-options).
699
700Here are values that are supposed to resemble a VGA screen,
701including the murky brown that passes for low-intensity yellow:
702
703 URxvt.color0: #000000
704 URxvt.color1: #A80000
705 URxvt.color2: #00A800
706 URxvt.color3: #A8A800
707 URxvt.color4: #0000A8
708 URxvt.color5: #A800A8
709 URxvt.color6: #00A8A8
710 URxvt.color7: #A8A8A8
711
712 URxvt.color8: #000054
713 URxvt.color9: #FF0054
714 URxvt.color10: #00FF54
715 URxvt.color11: #FFFF54
716 URxvt.color12: #0000FF
717 URxvt.color13: #FF00FF
718 URxvt.color14: #00FFFF
719 URxvt.color15: #FFFFFF
720
721And here is a more complete set of non-standard colors described (not by
722me) as "pretty girly".
723
724 URxvt.cursorColor: #dc74d1
725 URxvt.pointerColor: #dc74d1
726 URxvt.background: #0e0e0e
727 URxvt.foreground: #4ad5e1
728 URxvt.color0: #000000
729 URxvt.color8: #8b8f93
730 URxvt.color1: #dc74d1
731 URxvt.color9: #dc74d1
732 URxvt.color2: #0eb8c7
733 URxvt.color10: #0eb8c7
734 URxvt.color3: #dfe37e
735 URxvt.color11: #dfe37e
736 URxvt.color5: #9e88f0
737 URxvt.color13: #9e88f0
738 URxvt.color6: #73f7ff
739 URxvt.color14: #73f7ff
740 URxvt.color7: #e1dddd
741 URxvt.color15: #e1dddd
742
743=item How can I start @@RXVT_NAME@@d in a race-free way?
744
745Try C<@@RXVT_NAME@@d -f -o>, which tells @@RXVT_NAME@@d to open the
746display, create the listening socket and then fork.
747
748=item What's with the strange Backspace/Delete key behaviour?
749
750Assuming that the physical Backspace key corresponds to the
751BackSpace keysym (not likely for Linux ... see the following
752question) there are two standard values that can be used for
753Backspace: C<^H> and C<^?>.
754
755Historically, either value is correct, but rxvt-unicode adopts the debian
756policy of using C<^?> when unsure, because it's the one only only correct
757choice :).
758
759Rxvt-unicode tries to inherit the current stty settings and uses the value
760of `erase' to guess the value for backspace. If rxvt-unicode wasn't
761started from a terminal (say, from a menu or by remote shell), then the
762system value of `erase', which corresponds to CERASE in <termios.h>, will
763be used (which may not be the same as your stty setting).
764
765For starting a new rxvt-unicode:
766
767 # use Backspace = ^H
768 $ stty erase ^H
769 $ @@RXVT_NAME@@
770
771 # use Backspace = ^?
772 $ stty erase ^?
773 $ @@RXVT_NAME@@
774
775Toggle with C<ESC [ 36 h> / C<ESC [ 36 l>.
776
777For an existing rxvt-unicode:
778
779 # use Backspace = ^H
780 $ stty erase ^H
781 $ echo -n "^[[36h"
782
783 # use Backspace = ^?
784 $ stty erase ^?
785 $ echo -n "^[[36l"
786
787This helps satisfy some of the Backspace discrepancies that occur, but
788if you use Backspace = C<^H>, make sure that the termcap/terminfo value
789properly reflects that.
790
791The Delete key is a another casualty of the ill-defined Backspace problem.
792To avoid confusion between the Backspace and Delete keys, the Delete
793key has been assigned an escape sequence to match the vt100 for Execute
794(C<ESC [ 3 ~>) and is in the supplied termcap/terminfo.
795
796Some other Backspace problems:
797
798some editors use termcap/terminfo,
799some editors (vim I'm told) expect Backspace = ^H,
800GNU Emacs (and Emacs-like editors) use ^H for help.
801
802Perhaps someday this will all be resolved in a consistent manner.
803
804=item I don't like the key-bindings. How do I change them?
805
806There are some compile-time selections available via configure. Unless
807you have run "configure" with the C<--disable-resources> option you can
808use the `keysym' resource to alter the keystrings associated with keysyms.
809
810Here's an example for a URxvt session started using C<@@RXVT_NAME@@ -name URxvt>
811
812 URxvt.keysym.Home: \033[1~
813 URxvt.keysym.End: \033[4~
814 URxvt.keysym.C-apostrophe: \033<C-'>
815 URxvt.keysym.C-slash: \033<C-/>
816 URxvt.keysym.C-semicolon: \033<C-;>
817 URxvt.keysym.C-grave: \033<C-`>
818 URxvt.keysym.C-comma: \033<C-,>
819 URxvt.keysym.C-period: \033<C-.>
820 URxvt.keysym.C-0x60: \033<C-`>
821 URxvt.keysym.C-Tab: \033<C-Tab>
822 URxvt.keysym.C-Return: \033<C-Return>
823 URxvt.keysym.S-Return: \033<S-Return>
824 URxvt.keysym.S-space: \033<S-Space>
825 URxvt.keysym.M-Up: \033<M-Up>
826 URxvt.keysym.M-Down: \033<M-Down>
827 URxvt.keysym.M-Left: \033<M-Left>
828 URxvt.keysym.M-Right: \033<M-Right>
829 URxvt.keysym.M-C-0: list \033<M-C- 0123456789 >
830 URxvt.keysym.M-C-a: list \033<M-C- abcdefghijklmnopqrstuvwxyz >
831 URxvt.keysym.F12: command:\033]701;zh_CN.GBK\007
832
833See some more examples in the documentation for the B<keysym> resource.
834
835=item I'm using keyboard model XXX that has extra Prior/Next/Insert keys.
836How do I make use of them? For example, the Sun Keyboard type 4
837has the following mappings that rxvt-unicode doesn't recognize.
838
839 KP_Insert == Insert
840 F22 == Print
841 F27 == Home
842 F29 == Prior
843 F33 == End
844 F35 == Next
845
846Rather than have rxvt-unicode try to accommodate all the various possible
847keyboard mappings, it is better to use `xmodmap' to remap the keys as
848required for your particular machine.
849
850=item How do I distinguish wether I'm running rxvt-unicode or a regular xterm?
851I need this to decide about setting colors etc.
852
853rxvt and rxvt-unicode always export the variable "COLORTERM", so you can
854check and see if that is set. Note that several programs, JED, slrn,
855Midnight Commander automatically check this variable to decide whether or
856not to use color.
857
858=item How do I set the correct, full IP address for the DISPLAY variable?
859
860If you've compiled rxvt-unicode with DISPLAY_IS_IP and have enabled
861insecure mode then it is possible to use the following shell script
862snippets to correctly set the display. If your version of rxvt-unicode
863wasn't also compiled with ESCZ_ANSWER (as assumed in these snippets) then
864the COLORTERM variable can be used to distinguish rxvt-unicode from a
865regular xterm.
866
867Courtesy of Chuck Blake <cblake@BBN.COM> with the following shell script
868snippets:
869
870 # Bourne/Korn/POSIX family of shells:
871 [ ${TERM:-foo} = foo ] && TERM=xterm # assume an xterm if we don't know
872 if [ ${TERM:-foo} = xterm ]; then
873 stty -icanon -echo min 0 time 15 # see if enhanced rxvt or not
874 echo -n '^[Z'
875 read term_id
876 stty icanon echo
877 if [ ""${term_id} = '^[[?1;2C' -a ${DISPLAY:-foo} = foo ]; then
878 echo -n '^[[7n' # query the rxvt we are in for the DISPLAY string
879 read DISPLAY # set it in our local shell
880 fi
881 fi
882
883=item How do I compile the manual pages for myself?
884
885You need to have a recent version of perl installed as F</usr/bin/perl>,
886one that comes with F<pod2man>, F<pod2text> and F<pod2html>. Then go to
887the doc subdirectory and enter C<make alldoc>.
888
889=item My question isn't answered here, can I ask a human?
890
891Before sending me mail, you could go to IRC: C<irc.freenode.net>,
892channel C<#rxvt-unicode> has some rxvt-unicode enthusiasts that might be
893interested in learning about new and exciting problems (but not FAQs :).
894
895=back
896
1=head1 RXVT TECHNICAL REFERENCE 897=head1 RXVT TECHNICAL REFERENCE
898
899=head1 DESCRIPTION
900
901The rest of this document describes various technical aspects of
902B<rxvt-unicode>. First the description of supported command sequences,
903followed by pixmap support and last by a description of all features
904selectable at C<configure> time.
2 905
3=head1 Definitions 906=head1 Definitions
4 907
5=over 4 908=over 4
6 909
135Single Shift Select of G3 Character Set (SS3): affects next character 1038Single Shift Select of G3 Character Set (SS3): affects next character
136only I<unimplemented> 1039only I<unimplemented>
137 1040
138=item B<< C<ESC Z> >> 1041=item B<< C<ESC Z> >>
139 1042
140Obsolete form of returns: B<< C<ESC[?1;2C> >> I<rxvt-unicode compile-time option> 1043Obsolete form of returns: B<< C<ESC [ ? 1 ; 2 C> >> I<rxvt-unicode compile-time option>
141 1044
142=item B<< C<ESC c> >> 1045=item B<< C<ESC c> >>
143 1046
144Full reset (RIS) 1047Full reset (RIS)
145 1048
149 1052
150=item B<< C<ESC o> >> 1053=item B<< C<ESC o> >>
151 1054
152Invoke the G3 Character Set (LS3) 1055Invoke the G3 Character Set (LS3)
153 1056
154=item B<< C<ESC>(C<C> >> 1057=item B<< C<ESC ( C> >>
155 1058
156Designate G0 Character Set (ISO 2022), see below for values of C<C>. 1059Designate G0 Character Set (ISO 2022), see below for values of C<C>.
157 1060
158=item B<< C<ESC>)C<C> >> 1061=item B<< C<ESC ) C> >>
159 1062
160Designate G1 Character Set (ISO 2022), see below for values of C<C>. 1063Designate G1 Character Set (ISO 2022), see below for values of C<C>.
161 1064
162=item B<< C<ESC * C> >> 1065=item B<< C<ESC * C> >>
163 1066
304 1207
305=item B<< C<ESC [ Ps c> >> 1208=item B<< C<ESC [ Ps c> >>
306 1209
307Send Device Attributes (DA) 1210Send Device Attributes (DA)
308B<< C<Ps = 0> >> (or omitted): request attributes from terminal 1211B<< C<Ps = 0> >> (or omitted): request attributes from terminal
309returns: B<< C<ESC[?1;2c> >> (``I am a VT100 with Advanced Video 1212returns: B<< C<ESC [ ? 1 ; 2 c> >> (``I am a VT100 with Advanced Video
310Option'') 1213Option'')
311 1214
312=item B<< C<ESC [ Ps d> >> 1215=item B<< C<ESC [ Ps d> >>
313 1216
314Cursor to Line B<< C<Ps> >> (VPA) 1217Cursor to Line B<< C<Ps> >> (VPA)
330 B<< C<Ps = 0> >> Clear Current Column (default) 1233 B<< C<Ps = 0> >> Clear Current Column (default)
331 B<< C<Ps = 3> >> Clear All (TBC) 1234 B<< C<Ps = 3> >> Clear All (TBC)
332 1235
333=end table 1236=end table
334 1237
1238=item B<< C<ESC [ Pm h> >>
1239
1240Set Mode (SM). See B<< C<ESC [ Pm l> >> sequence for description of C<Pm>.
1241
335=item B<< C<ESC [ Ps i> >> 1242=item B<< C<ESC [ Ps i> >>
336 1243
337Printing 1244Printing. See also the C<print-pipe> resource.
338 1245
339=begin table 1246=begin table
340 1247
1248 B<< C<Ps = 0> >> print screen (MC0)
341 B<< C<Ps = 4> >> disable transparent print mode (MC4) 1249 B<< C<Ps = 4> >> disable transparent print mode (MC4)
342 B<< C<Ps = 5> >> enable transparent print mode (MC5) I<unimplemented> 1250 B<< C<Ps = 5> >> enable transparent print mode (MC5)
343 1251
344=end table 1252=end table
345
346=item B<< C<ESC [ Pm h> >>
347
348Set Mode (SM). See next sequence for description of C<Pm>.
349 1253
350=item B<< C<ESC [ Pm l> >> 1254=item B<< C<ESC [ Pm l> >>
351 1255
352Reset Mode (RM) 1256Reset Mode (RM)
353 1257
379 1283
380=begin table 1284=begin table
381 1285
382 B<< C<Ps = 0> >> Normal (default) 1286 B<< C<Ps = 0> >> Normal (default)
383 B<< C<Ps = 1 / 21> >> On / Off Bold (bright fg) 1287 B<< C<Ps = 1 / 21> >> On / Off Bold (bright fg)
384 B<< C<Ps = 3 / 23> >> On / Off Italic (NYI) 1288 B<< C<Ps = 3 / 23> >> On / Off Italic
385 B<< C<Ps = 4 / 24> >> On / Off Underline 1289 B<< C<Ps = 4 / 24> >> On / Off Underline
386 B<< C<Ps = 5 / 25> >> On / Off Slow Blink (bright bg) 1290 B<< C<Ps = 5 / 25> >> On / Off Slow Blink (bright bg)
387 B<< C<Ps = 6 / 26> >> On / Off Rapid Blink (bright bg) 1291 B<< C<Ps = 6 / 26> >> On / Off Rapid Blink (bright bg)
1292 B<< C<Ps = 7 / 27> >> On / Off Inverse
388 B<< C<Ps = 7 / 27> >> On / Off Invisible (NYI) 1293 B<< C<Ps = 8 / 27> >> On / Off Invisible (NYI)
389 B<< C<Ps = 8 / 27> >> On / Off Inverse
390 B<< C<Ps = 30 / 40> >> fg/bg Black 1294 B<< C<Ps = 30 / 40> >> fg/bg Black
391 B<< C<Ps = 31 / 41> >> fg/bg Red 1295 B<< C<Ps = 31 / 41> >> fg/bg Red
392 B<< C<Ps = 32 / 42> >> fg/bg Green 1296 B<< C<Ps = 32 / 42> >> fg/bg Green
393 B<< C<Ps = 33 / 43> >> fg/bg Yellow 1297 B<< C<Ps = 33 / 43> >> fg/bg Yellow
394 B<< C<Ps = 34 / 44> >> fg/bg Blue 1298 B<< C<Ps = 34 / 44> >> fg/bg Blue
395 B<< C<Ps = 35 / 45> >> fg/bg Magenta 1299 B<< C<Ps = 35 / 45> >> fg/bg Magenta
396 B<< C<Ps = 36 / 46> >> fg/bg Cyan 1300 B<< C<Ps = 36 / 46> >> fg/bg Cyan
1301 B<< C<Ps = 38;5 / 48;5> >> set fg/bg to color #m (ISO 8613-6)
397 B<< C<Ps = 37 / 47> >> fg/bg White 1302 B<< C<Ps = 37 / 47> >> fg/bg White
398 B<< C<Ps = 39 / 49> >> fg/bg Default 1303 B<< C<Ps = 39 / 49> >> fg/bg Default
399 B<< C<Ps = 90 / 100> >> fg/bg Bright Black 1304 B<< C<Ps = 90 / 100> >> fg/bg Bright Black
400 B<< C<Ps = 91 / 101> >> fg/bg Bright Red 1305 B<< C<Ps = 91 / 101> >> fg/bg Bright Red
401 B<< C<Ps = 92 / 102> >> fg/bg Bright Green 1306 B<< C<Ps = 92 / 102> >> fg/bg Bright Green
428 1333
429=item B<< C<ESC [ s> >> 1334=item B<< C<ESC [ s> >>
430 1335
431Save Cursor (SC) 1336Save Cursor (SC)
432 1337
1338=item B<< C<ESC [ Ps;Pt t> >>
1339
1340Window Operations
1341
1342=begin table
1343
1344 B<< C<Ps = 1> >> Deiconify (map) window
1345 B<< C<Ps = 2> >> Iconify window
1346 B<< C<Ps = 3> >> B<< C<ESC [ 3 ; X ; Y t> >> Move window to (X|Y)
1347 B<< C<Ps = 4> >> B<< C<ESC [ 4 ; H ; W t> >> Resize to WxH pixels
1348 B<< C<Ps = 5> >> Raise window
1349 B<< C<Ps = 6> >> Lower window
1350 B<< C<Ps = 7> >> Refresh screen once
1351 B<< C<Ps = 8> >> B<< C<ESC [ 8 ; R ; C t> >> Resize to R rows and C columns
1352 B<< C<Ps = 11> >> Report window state (responds with C<Ps = 1> or C<Ps = 2>)
1353 B<< C<Ps = 13> >> Report window position (responds with C<Ps = 3>)
1354 B<< C<Ps = 14> >> Report window pixel size (responds with C<Ps = 4>)
1355 B<< C<Ps = 18> >> Report window text size (responds with C<Ps = 7>)
1356 B<< C<Ps = 19> >> Currently the same as C<Ps = 18>, but responds with C<Ps = 9>
1357 B<< C<Ps = 20> >> Reports icon label (B<< C<ESC ] L NAME \234> >>)
1358 B<< C<Ps = 21> >> Reports window title (B<< C<ESC ] l NAME \234> >>)
1359 B<< C<Ps = 24..> >> Set window height to C<Ps> rows
1360
1361=end table
1362
1363=item B<< C<ESC [ u> >>
1364
1365Restore Cursor
1366
433=item B<< C<ESC [ Ps x> >> 1367=item B<< C<ESC [ Ps x> >>
434 1368
435Request Terminal Parameters (DECREQTPARM) 1369Request Terminal Parameters (DECREQTPARM)
436
437=item B<< C<ESC [ u> >>
438
439Restore Cursor
440 1370
441=back 1371=back
442 1372
443X<PrivateModes> 1373X<PrivateModes>
444 1374
547 B<< C<h> >> Send Mouse X & Y on button press. 1477 B<< C<h> >> Send Mouse X & Y on button press.
548 B<< C<l> >> No mouse reporting. 1478 B<< C<l> >> No mouse reporting.
549 1479
550=end table 1480=end table
551 1481
552=item B<< C<Ps = 10> >> (B<rxvt>)
553
554=begin table
555
556 B<< C<h> >> menuBar visible
557 B<< C<l> >> menuBar invisible
558
559=end table
560
561=item B<< C<Ps = 25> >> 1482=item B<< C<Ps = 25> >>
562 1483
563=begin table 1484=begin table
564 1485
565 B<< C<h> >> Visible cursor {cnorm/cvvis} 1486 B<< C<h> >> Visible cursor {cnorm/cvvis}
678 1599
679=begin table 1600=begin table
680 1601
681 B<< C<h> >> Scroll to bottom when a key is pressed 1602 B<< C<h> >> Scroll to bottom when a key is pressed
682 B<< C<l> >> Don't scroll to bottom when a key is pressed 1603 B<< C<l> >> Don't scroll to bottom when a key is pressed
1604
1605=end table
1606
1607=item B<< C<Ps = 1021> >> (B<rxvt>)
1608
1609=begin table
1610
1611 B<< C<h> >> Bold/italic implies high intensity (see option B<-is>)
1612 B<< C<l> >> Font styles have no effect on intensity (Compile styles)
683 1613
684=end table 1614=end table
685 1615
686=item B<< C<Ps = 1047> >> 1616=item B<< C<Ps = 1047> >>
687 1617
736 B<< C<Ps = 10> >> Change colour of text foreground to B<< C<Pt> >> B<(NB: may change in future)> 1666 B<< C<Ps = 10> >> Change colour of text foreground to B<< C<Pt> >> B<(NB: may change in future)>
737 B<< C<Ps = 11> >> Change colour of text background to B<< C<Pt> >> B<(NB: may change in future)> 1667 B<< C<Ps = 11> >> Change colour of text background to B<< C<Pt> >> B<(NB: may change in future)>
738 B<< C<Ps = 12> >> Change colour of text cursor foreground to B<< C<Pt> >> 1668 B<< C<Ps = 12> >> Change colour of text cursor foreground to B<< C<Pt> >>
739 B<< C<Ps = 13> >> Change colour of mouse foreground to B<< C<Pt> >> 1669 B<< C<Ps = 13> >> Change colour of mouse foreground to B<< C<Pt> >>
740 B<< C<Ps = 17> >> Change colour of highlight characters to B<< C<Pt> >> 1670 B<< C<Ps = 17> >> Change colour of highlight characters to B<< C<Pt> >>
741 B<< C<Ps = 18> >> Change colour of bold characters to B<< C<Pt> >> 1671 B<< C<Ps = 18> >> Change colour of bold characters to B<< C<Pt> >> [deprecated, see 706]
742 B<< C<Ps = 19> >> Change colour of underlined characters to B<< C<Pt> >> 1672 B<< C<Ps = 19> >> Change colour of underlined characters to B<< C<Pt> >> [deprecated, see 707]
1673 B<< C<Ps = 20> >> Change background pixmap parameters (see section XPM) (Compile XPM).
743 B<< C<Ps = 20> >> Change default background to B<< C<Pt> >> 1674 B<< C<Ps = 39> >> Change default foreground colour to B<< C<Pt> >>.
744 B<< C<Ps = 39> >> Change default foreground colour to B<< C<Pt> >> I<rxvt compile-time option>
745 B<< C<Ps = 46> >> Change Log File to B<< C<Pt> >> I<unimplemented> 1675 B<< C<Ps = 46> >> Change Log File to B<< C<Pt> >> I<unimplemented>
746 B<< C<Ps = 49> >> Change default background colour to B<< C<Pt> >> I<rxvt compile-time option> 1676 B<< C<Ps = 49> >> Change default background colour to B<< C<Pt> >>.
747 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> >> 1677 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> >>
748 B<< C<Ps = 55> >> Log all scrollback buffer and all of screen to B<< C<Pt> >> 1678 B<< C<Ps = 55> >> Log all scrollback buffer and all of screen to B<< C<Pt> >>
749 B<< C<Ps = 701> >> Change current locale to B<< C<Pt> >>, or, if B<< C<Pt> >> is B<< C<?> >>, return the current locale (@@RXVT_NAME@@ extension) 1679 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).
750 B<< C<Ps = 702> >> find font for character, used for debugging (@@RXVT_NAME@@ extension) 1680 B<< C<Ps = 704> >> Change colour of italic characters to B<< C<Pt> >>
751 B<< C<Ps = 703> >> menubar command B<< C<Pt> >> I<rxvt compile-time option> (@@RXVT_NAME@@ extension) 1681 B<< C<Ps = 705> >> Change background pixmap tint colour to B<< C<Pt> >> (Compile transparency).
1682 B<< C<Ps = 706> >> Change colour of bold characters to B<< C<Pt> >>
1683 B<< C<Ps = 707> >> Change colour of underlined characters to B<< C<Pt> >>
1684 B<< C<Ps = 710> >> Set normal fontset to B<< C<Pt> >>. Same as C<Ps = 50>.
1685 B<< C<Ps = 711> >> Set bold fontset to B<< C<Pt> >>. Similar to C<Ps = 50> (Compile styles).
1686 B<< C<Ps = 712> >> Set italic fontset to B<< C<Pt> >>. Similar to C<Ps = 50> (Compile styles).
1687 B<< C<Ps = 713> >> Set bold-italic fontset to B<< C<Pt> >>. Similar to C<Ps = 50> (Compile styles).
1688 B<< C<Ps = 720> >> Move viewing window up by B<< C<Pt> >> lines, or clear scrollback buffer if C<Pt = 0> (Compile frills).
1689 B<< C<Ps = 721> >> Move viewing window down by B<< C<Pt> >> lines, or clear scrollback buffer if C<Pt = 0> (Compile frills).
1690 B<< C<Ps = 777> >> Call the perl extension with the given string, which should be of the form C<extension:parameters> (Compile perl).
752 1691
753=end table 1692=end table
754 1693
755=back 1694=back
756 1695
757X<menuBar>
758
759=head1 menuBar
760
761B<< The exact syntax used is I<almost> solidified. >>
762In the menus, B<DON'T> try to use menuBar commands that add or remove a
763menuBar.
764
765Note that in all of the commands, the B<< I</path/> >> I<cannot> be
766omitted: use B<./> to specify a menu relative to the current menu.
767
768=head2 Overview of menuBar operation
769
770For the menuBar XTerm escape sequence C<ESC ] 703 ; Pt ST>, the syntax
771of C<Pt> can be used for a variety of tasks:
772
773At the top level is the current menuBar which is a member of a circular
774linked-list of other such menuBars.
775
776The menuBar acts as a parent for the various drop-down menus, which in
777turn, may have labels, separator lines, menuItems and subMenus.
778
779The menuItems are the useful bits: you can use them to mimic keyboard
780input or even to send text or escape sequences back to rxvt.
781
782The menuBar syntax is intended to provide a simple yet robust method of
783constructing and manipulating menus and navigating through the
784menuBars.
785
786The first step is to use the tag B<< [menu:I<name>] >> which creates
787the menuBar called I<name> and allows access. You may now or menus,
788subMenus, and menuItems. Finally, use the tag B<[done]> to set the
789menuBar access as B<readonly> to prevent accidental corruption of the
790menus. To re-access the current menuBar for alterations, use the tag
791B<[menu]>, make the alterations and then use B<[done]>
792
793X<menuBarCommands>
794
795=head2 Commands
796
797=over 4
798
799=item B<< [menu:+I<name>] >>
800
801access the named menuBar for creation or alteration. If a new menuBar
802is created, it is called I<name> (max of 15 chars) and the current
803menuBar is pushed onto the stack
804
805=item B<[menu]>
806
807access the current menuBar for alteration
808
809=item B<< [title:+I<string>] >>
810
811set the current menuBar's title to I<string>, which may contain the
812following format specifiers:
813B<%%> : literal B<%> character
814B<%n> : rxvt name (as per the B<-name> command-line option)
815B<%v> : rxvt version
816
817=item B<[done]>
818
819set menuBar access as B<readonly>.
820End-of-file tag for B<< [read:+I<file>] >> operations.
821
822=item B<< [read:+I<file>] >>
823
824read menu commands directly from I<file> (extension ".menu" will be
825appended if required.) Start reading at a line with B<[menu]> or B<<
826[menu:+I<name> >> and continuing until B<[done]> is encountered.
827
828Blank and comment lines (starting with B<#>) are ignored. Actually,
829since any invalid menu commands are also ignored, almost anything could
830be construed as a comment line, but this may be tightened up in the
831future ... so don't count on it!.
832
833=item B<< [read:+I<file>;+I<name>] >>
834
835The same as B<< [read:+I<file>] >>, but start reading at a line with
836B<< [menu:+I<name>] >> and continuing until B<< [done:+I<name>] >> or
837B<[done]> is encountered.
838
839=item B<[dump]>
840
841dump all menuBars to the file B</tmp/rxvt-PID> in a format suitable for
842later rereading.
843
844=item B<[rm:name]>
845
846remove the named menuBar
847
848=item B<[rm] [rm:]>
849
850remove the current menuBar
851
852=item B<[rm*] [rm:*]>
853
854remove all menuBars
855
856=item B<[swap]>
857
858swap the top two menuBars
859
860=item B<[prev]>
861
862access the previous menuBar
863
864=item B<[next]>
865
866access the next menuBar
867
868=item B<[show]>
869
870Enable display of the menuBar
871
872=item B<[hide]>
873
874Disable display of the menuBar
875
876=item B<< [pixmap:+I<name>] >>
877
878=item B<< [pixmap:+I<name>;I<scaling>] >>
879
880(set the background pixmap globally
881
882B<< A Future implementation I<may> make this local to the menubar >>)
883
884=item B<< [:+I<command>:] >>
885
886ignore the menu readonly status and issue a I<command> to or a menu or
887menuitem or change the ; a useful shortcut for setting the quick arrows
888from a menuBar.
889
890=back
891
892X<menuBarAdd>
893
894=head2 Adding and accessing menus
895
896The following commands may also be B<+> prefixed.
897
898=over 4
899
900=item B</+>
901
902access menuBar top level
903
904=item B<./+>
905
906access current menu level
907
908=item B<../+>
909
910access parent menu (1 level up)
911
912=item B<../../>
913
914access parent menu (multiple levels up)
915
916=item B<< I</path/>menu >>
917
918add/access menu
919
920=item B<< I</path/>menu/* >>
921
922add/access menu and clear it if it exists
923
924=item B<< I</path/>{-} >>
925
926add separator
927
928=item B<< I</path/>{item} >>
929
930add B<item> as a label
931
932=item B<< I</path/>{item} action >>
933
934add/alter I<menuitem> with an associated I<action>
935
936=item B<< I</path/>{item}{right-text} >>
937
938add/alter I<menuitem> with B<right-text> as the right-justified text
939and as the associated I<action>
940
941=item B<< I</path/>{item}{rtext} action >>
942
943add/alter I<menuitem> with an associated I<action> and with B<rtext> as
944the right-justified text.
945
946=back
947
948=over 4
949
950=item Special characters in I<action> must be backslash-escaped:
951
952B<\a \b \E \e \n \r \t \octal>
953
954=item or in control-character notation:
955
956B<^@, ^A .. ^Z .. ^_, ^?>
957
958=back
959
960To send a string starting with a B<NUL> (B<^@>) character to the
961program, start I<action> with a pair of B<NUL> characters (B<^@^@>),
962the first of which will be stripped off and the balance directed to the
963program. Otherwise if I<action> begins with B<NUL> followed by
964non-+B<NUL> characters, the leading B<NUL> is stripped off and the
965balance is sent back to rxvt.
966
967As a convenience for the many Emacs-type editors, I<action> may start
968with B<M-> (eg, B<M-$> is equivalent to B<\E$>) and a B<CR> will be
969appended if missed from B<M-x> commands.
970
971As a convenience for issuing XTerm B<ESC]> sequences from a menubar (or
972quick arrow), a B<BEL> (B<^G>) will be appended if needed.
973
974=over 4
975
976=item For example,
977
978B<M-xapropos> is equivalent to B<\Exapropos\r>
979
980=item and
981
982B<\E]703;mona;100> is equivalent to B<\E]703;mona;100\a>
983
984=back
985
986The option B<< {I<right-rtext>} >> will be right-justified. In the
987absence of a specified action, this text will be used as the I<action>
988as well.
989
990=over 4
991
992=item For example,
993
994B</File/{Open}{^X^F}> is equivalent to B</File/{Open}{^X^F} ^X^F>
995
996=back
997
998The left label I<is> necessary, since it's used for matching, but
999implicitly hiding the left label (by using same name for both left and
1000right labels), or explicitly hiding the left label (by preceeding it
1001with a dot), makes it possible to have right-justified text only.
1002
1003=over 4
1004
1005=item For example,
1006
1007B</File/{Open}{Open} Open-File-Action>
1008
1009=item or hiding it
1010
1011B</File/{.anylabel}{Open} Open-File-Action>
1012
1013=back
1014
1015X<menuBarRemove>
1016
1017=head2 Removing menus
1018
1019=over 4
1020
1021=item B<< -/*+ >>
1022
1023remove all menus from the menuBar, the same as B<[clear]>
1024
1025=item B<< -+I</path>menu+ >>
1026
1027remove menu
1028
1029=item B<< -+I</path>{item}+ >>
1030
1031remove item
1032
1033=item B<< -+I</path>{-} >>
1034
1035remove separator)
1036
1037=item B<-/path/menu/*>
1038
1039remove all items, separators and submenus from menu
1040
1041=back
1042
1043X<menuBarArrows>
1044
1045=head2 Quick Arrows
1046
1047The menus also provide a hook for I<quick arrows> to provide easier
1048user access. If nothing has been explicitly set, the default is to
1049emulate the curror keys. The syntax permits each arrow to be altered
1050individually or all four at once without re-entering their common
1051beginning/end text. For example, to explicitly associate cursor actions
1052with the arrows, any of the following forms could be used:
1053
1054=over 4
1055
1056=item B<< <r>+I<Right> >>
1057
1058=item B<< <l>+I<Left> >>
1059
1060=item B<< <u>+I<Up> >>
1061
1062=item B<< <d>+I<Down> >>
1063
1064Define actions for the respective arrow buttons
1065
1066=item B<< <b>+I<Begin> >>
1067
1068=item B<< <e>+I<End> >>
1069
1070Define common beginning/end parts for I<quick arrows> which used in
1071conjunction with the above <r> <l> <u> <d> constructs
1072
1073=back
1074
1075=over 4
1076
1077=item For example, define arrows individually,
1078
1079 <u>\E[A
1080
1081 <d>\E[B
1082
1083 <r>\E[C
1084
1085 <l>\E[D
1086
1087=item or all at once
1088
1089 <u>\E[AZ<><d>\E[BZ<><r>\E[CZ<><l>\E[D
1090
1091=item or more compactly (factoring out common parts)
1092
1093 <b>\E[<u>AZ<><d>BZ<><r>CZ<><l>D
1094
1095=back
1096
1097X<menuBarSummary>
1098
1099=head2 Command Summary
1100
1101A short summary of the most I<common> commands:
1102
1103=over 4
1104
1105=item [menu:name]
1106
1107use an existing named menuBar or start a new one
1108
1109=item [menu]
1110
1111use the current menuBar
1112
1113=item [title:string]
1114
1115set menuBar title
1116
1117=item [done]
1118
1119set menu access to readonly and, if reading from a file, signal EOF
1120
1121=item [done:name]
1122
1123if reading from a file using [read:file;name] signal EOF
1124
1125=item [rm:name]
1126
1127remove named menuBar(s)
1128
1129=item [rm] [rm:]
1130
1131remove current menuBar
1132
1133=item [rm*] [rm:*]
1134
1135remove all menuBar(s)
1136
1137=item [swap]
1138
1139swap top two menuBars
1140
1141=item [prev]
1142
1143access the previous menuBar
1144
1145=item [next]
1146
1147access the next menuBar
1148
1149=item [show]
1150
1151map menuBar
1152
1153=item [hide]
1154
1155unmap menuBar
1156
1157=item [pixmap;file]
1158
1159=item [pixmap;file;scaling]
1160
1161set a background pixmap
1162
1163=item [read:file]
1164
1165=item [read:file;name]
1166
1167read in a menu from a file
1168
1169=item [dump]
1170
1171dump out all menuBars to /tmp/rxvt-PID
1172
1173=item /
1174
1175access menuBar top level
1176
1177=item ./
1178
1179=item ../
1180
1181=item ../../
1182
1183access current or parent menu level
1184
1185=item /path/menu
1186
1187add/access menu
1188
1189=item /path/{-}
1190
1191add separator
1192
1193=item /path/{item}{rtext} action
1194
1195add/alter menu item
1196
1197=item -/*
1198
1199remove all menus from the menuBar
1200
1201=item -/path/menu
1202
1203remove menu items, separators and submenus from menu
1204
1205=item -/path/menu
1206
1207remove menu
1208
1209=item -/path/{item}
1210
1211remove item
1212
1213=item -/path/{-}
1214
1215remove separator
1216
1217=item <b>Begin<r>Right<l>Left<u>Up<d>Down<e>End
1218
1219menu quick arrows
1220
1221=back
1222X<XPM> 1696X<XPM>
1223 1697
1224=head1 XPM 1698=head1 XPM
1225 1699
1226For the XPM XTerm escape sequence B<< C<ESC ] 20 ; Pt ST> >> then value 1700For the XPM XTerm escape sequence B<< C<ESC ] 20 ; Pt ST> >> then value
1412=end table 1886=end table
1413 1887
1414=head1 CONFIGURE OPTIONS 1888=head1 CONFIGURE OPTIONS
1415 1889
1416General hint: if you get compile errors, then likely your configuration 1890General hint: if you get compile errors, then likely your configuration
1417hasn't been tested well. Either try with --enable-everything or use the 1891hasn't been tested well. Either try with C<--enable-everything> or use
1418./reconf script as a base for experiments. ./reconf is used by myself, 1892the F<./reconf> script as a base for experiments. F<./reconf> is used by
1419so it should generally be a working config. Of course, you should always 1893myself, so it should generally be a working config. Of course, you should
1420report when a combination doesn't work, so it can be fixed. Marc Lehmann 1894always report when a combination doesn't work, so it can be fixed. Marc
1421<rxvt@schmorp.de>. 1895Lehmann <rxvt@schmorp.de>.
1896
1897All
1422 1898
1423=over 4 1899=over 4
1424 1900
1425=item --enable-everything 1901=item --enable-everything
1426 1902
1427Add support for all non-multichoice options listed in "./configure 1903Add (or remove) support for all non-multichoice options listed in "./configure
1428--help". Note that unlike other enable options this is order dependant. 1904--help".
1905
1429You can specify this and then disable options which this enables by 1906You can specify this and then disable options you do not like by
1430I<following> this with the appropriate commands. 1907I<following> this with the appropriate C<--disable-...> arguments,
1908or you can start with a minimal configuration by specifying
1909C<--disable-everything> and than adding just the C<--enable-...> arguments
1910you want.
1431 1911
1432=item --enable-xft 1912=item --enable-xft (default: enabled)
1433 1913
1434Add support for Xft (anti-aliases, among others) fonts. Xft fonts are 1914Add support for Xft (anti-aliases, among others) fonts. Xft fonts are
1435slower and require lots of memory, but as long as you don't use them, you 1915slower and require lots of memory, but as long as you don't use them, you
1436don't pay for them. 1916don't pay for them.
1437 1917
1918=item --enable-font-styles (default: on)
1919
1920Add support for B<bold>, I<italic> and B<< I<bold italic> >> font
1921styles. The fonts can be set manually or automatically.
1922
1438=item --with-codesets=NAME,... 1923=item --with-codesets=NAME,... (default: all)
1439 1924
1440Compile in support for additional codeset (encoding) groups. These codeset 1925Compile in support for additional codeset (encoding) groups (C<eu>, C<vn>
1926are always compiled in, which includes most 8-bit character sets). These
1441tables are currently only used for driving X11 core fonts, they are not 1927codeset tables are used for driving X11 core fonts, they are not required
1442required for Xft fonts. Compiling them in will make your binary bigger 1928for Xft fonts, although having them compiled in lets rxvt-unicode choose
1443(together about 700kB), but it doesn't increase memory usage unless you 1929replacement fonts more intelligently. Compiling them in will make your
1930binary bigger (all of together cost about 700kB), but it doesn't increase
1444use an X11 font requiring one of these encodings. 1931memory usage unless you use a font requiring one of these encodings.
1445 1932
1446=begin table 1933=begin table
1447 1934
1448 all all available codeset groups 1935 all all available codeset groups
1449 cn common chinese encodings 1936 zh common chinese encodings
1450 cn_ext rarely used but very big chinese encodigs 1937 zh_ext rarely used but very big chinese encodigs
1451 jp common japanese encodings 1938 jp common japanese encodings
1452 jp_ext rarely used but big japanese encodings 1939 jp_ext rarely used but big japanese encodings
1453 kr korean encodings 1940 kr korean encodings
1454 1941
1455=end table 1942=end table
1456 1943
1457=item --enable-xim 1944=item --enable-xim (default: on)
1458 1945
1459Add support for XIM (X Input Method) protocol. This allows using 1946Add support for XIM (X Input Method) protocol. This allows using
1460alternative input methods (e.g. kinput2) and will also correctly 1947alternative input methods (e.g. kinput2) and will also correctly
1461set up the input for people using dead keys or compose keys. 1948set up the input for people using dead keys or compose keys.
1462 1949
1463=item --enable-unicode3 1950=item --enable-unicode3 (default: off)
1464 1951
1465Enable direct support for displaying unicode codepoints above 1952Enable direct support for displaying unicode codepoints above
146665535 (the basic multilingual page). This increases storage 195365535 (the basic multilingual page). This increases storage
1467requirements per character from 2 to 4 bytes. X11 fonts do not yet 1954requirements per character from 2 to 4 bytes. X11 fonts do not yet
1468support these extra characters, but Xft does. 1955support these extra characters, but Xft does.
1471even without this flag, but the number of such characters is 1958even without this flag, but the number of such characters is
1472limited to a view thousand (shared with combining characters, 1959limited to a view thousand (shared with combining characters,
1473see next switch), and right now rxvt-unicode cannot display them 1960see next switch), and right now rxvt-unicode cannot display them
1474(input/output and cut&paste still work, though). 1961(input/output and cut&paste still work, though).
1475 1962
1476=item --enable-combining 1963=item --enable-combining (default: on)
1477 1964
1478Enable automatic composition of combining characters into 1965Enable automatic composition of combining characters into
1479composite characters. This is required for proper viewing of text 1966composite characters. This is required for proper viewing of text
1480where accents are encoded as seperate unicode characters. This is 1967where accents are encoded as seperate unicode characters. This is
1481done by using precomposited characters when available or creating 1968done by using precomposited characters when available or creating
1482new pseudo-characters when no precomposed form exists. 1969new pseudo-characters when no precomposed form exists.
1483 1970
1484Without --enable-unicode3, the number of additional precomposed 1971Without --enable-unicode3, the number of additional precomposed characters
1485characters is rather limited (2048, if this is full, rxvt will use the 1972is rather limited (2048, if this is full, rxvt-unicode will use the
1486private use area, extending the number of combinations to 8448). With 1973private use area, extending the number of combinations to 8448). With
1487--enable-unicode3, no practical limit exists. This will also enable 1974--enable-unicode3, no practical limit exists.
1488storage of characters >65535. 1975
1976This option will also enable storage (but not display) of characters
1977beyond plane 0 (>65535) when --enable-unicode3 was not specified.
1489 1978
1490The combining table also contains entries for arabic presentation forms, 1979The combining table also contains entries for arabic presentation forms,
1491but these are not currently used. Bug me if you want these to be used. 1980but these are not currently used. Bug me if you want these to be used (and
1981tell me how these are to be used...).
1492 1982
1493=item --enable-fallback(=CLASS) 1983=item --enable-fallback(=CLASS) (default: Rxvt)
1494 1984
1495When reading resource settings, also read settings for class CLASS 1985When reading resource settings, also read settings for class CLASS. To disable resource fallback use --disable-fallback.
1496(default: Rxvt). To disable resource fallback use --disable-fallback.
1497 1986
1498=item --with-res-name=NAME 1987=item --with-res-name=NAME (default: urxvt)
1499 1988
1500Use the given name (default: urxvt) as default application name when 1989Use the given name as default application name when
1501reading resources. Specify --with-res-name=rxvt to replace rxvt. 1990reading resources. Specify --with-res-name=rxvt to replace rxvt.
1502 1991
1503=item --with-res-class=CLASS 1992=item --with-res-class=CLASS /default: URxvt)
1504 1993
1505Use the given class (default: URxvt) as default application class 1994Use the given class as default application class
1506when reading resources. Specify --with-res-class=Rxvt to replace 1995when reading resources. Specify --with-res-class=Rxvt to replace
1507rxvt. 1996rxvt.
1508 1997
1509=item --enable-utmp 1998=item --enable-utmp (default: on)
1510 1999
1511Write user and tty to utmp file (used by programs like F<w>) at 2000Write user and tty to utmp file (used by programs like F<w>) at
1512start of rxvt execution and delete information when rxvt exits. 2001start of rxvt execution and delete information when rxvt exits.
1513 2002
1514=item --enable-wtmp 2003=item --enable-wtmp (default: on)
1515 2004
1516Write user and tty to wtmp file (used by programs like F<last>) at 2005Write user and tty to wtmp file (used by programs like F<last>) at
1517start of rxvt execution and write logout when rxvt exits. This 2006start of rxvt execution and write logout when rxvt exits. This
1518option requires --enable-utmp to also be specified. 2007option requires --enable-utmp to also be specified.
1519 2008
1520=item --enable-lastlog 2009=item --enable-lastlog (default: on)
1521 2010
1522Write user and tty to lastlog file (used by programs like 2011Write user and tty to lastlog file (used by programs like
1523F<lastlogin>) at start of rxvt execution. This option requires 2012F<lastlogin>) at start of rxvt execution. This option requires
1524--enable-utmp to also be specified. 2013--enable-utmp to also be specified.
1525 2014
1526=item --enable-xpm-background 2015=item --enable-xpm-background (default: on)
1527 2016
1528Add support for XPM background pixmaps. 2017Add support for XPM background pixmaps.
1529 2018
1530=item --enable-transparency 2019=item --enable-transparency (default: on)
1531 2020
1532Add support for inheriting parent backgrounds thus giving a fake 2021Add support for inheriting parent backgrounds thus giving a fake
1533transparency to the term. 2022transparency to the term.
1534 2023
1535=item --enable-fading 2024=item --enable-fading (default: on)
1536 2025
1537Add support for fading the text when focus is lost. 2026Add support for fading the text when focus is lost (requires C<--enable-transparency>).
1538 2027
1539=item --enable-tinting 2028=item --enable-tinting (default: on)
1540 2029
1541Add support for tinting of transparent backgrounds. 2030Add support for tinting of transparent backgrounds (requires C<--enable-transparency>).
1542 2031
1543=item --enable-menubar
1544
1545Add support for our menu bar system (this interacts badly with
1546dynamic locale switching currently).
1547
1548=item --enable-rxvt-scroll 2032=item --enable-rxvt-scroll (default: on)
1549 2033
1550Add support for the original rxvt scrollbar. 2034Add support for the original rxvt scrollbar.
1551 2035
1552=item --enable-next-scroll 2036=item --enable-next-scroll (default: on)
1553 2037
1554Add support for a NeXT-like scrollbar. 2038Add support for a NeXT-like scrollbar.
1555 2039
1556=item --enable-xterm-scroll 2040=item --enable-xterm-scroll (default: on)
1557 2041
1558Add support for an Xterm-like scrollbar. 2042Add support for an Xterm-like scrollbar.
1559 2043
1560=item --enable-plain-scroll 2044=item --enable-plain-scroll (default: on)
1561 2045
1562Add support for a very unobtrusive, plain-looking scrollbar that 2046Add support for a very unobtrusive, plain-looking scrollbar that
1563is the favourite of the rxvt-unicode author, having used it for 2047is the favourite of the rxvt-unicode author, having used it for
1564many years. 2048many years.
1565 2049
1566=item --enable-half-shadow 2050=item --enable-ttygid (default: off)
1567
1568Make shadows on the scrollbar only half the normal width & height.
1569only applicable to rxvt scrollbars.
1570
1571=item --enable-ttygid
1572 2051
1573Change tty device setting to group "tty" - only use this if 2052Change tty device setting to group "tty" - only use this if
1574your system uses this type of security. 2053your system uses this type of security.
1575 2054
1576=item --disable-backspace-key 2055=item --disable-backspace-key
1577 2056
1578Disable any handling of the backspace key by us - let the X server 2057Removes any handling of the backspace key by us - let the X server do it.
2058
2059=item --disable-delete-key
2060
2061Removes any handling of the delete key by us - let the X server
1579do it. 2062do it.
1580 2063
1581=item --disable-delete-key
1582
1583Disable any handling of the delete key by us - let the X server
1584do it.
1585
1586=item --disable-resources 2064=item --disable-resources
1587 2065
1588Remove all resources checking. 2066Removes any support for resource checking.
1589
1590=item --enable-xgetdefault
1591
1592Make resources checking via XGetDefault() instead of our small
1593version which only checks ~/.Xdefaults, or if that doesn't exist
1594then ~/.Xresources.
1595
1596=item --enable-strings
1597
1598Add support for our possibly faster memset() function and other
1599various routines, overriding your system's versions which may
1600have been hand-crafted in assembly or may require extra libraries
1601to link in. (this breaks ANSI-C rules and has problems on many
1602GNU/Linux systems).
1603 2067
1604=item --disable-swapscreen 2068=item --disable-swapscreen
1605 2069
1606Remove support for swap screen. 2070Remove support for secondary/swap screen.
1607 2071
1608=item --enable-frills 2072=item --enable-frills (default: on)
1609 2073
1610Add support for many small features that are not essential but nice to 2074Add support for many small features that are not essential but nice to
1611have. Normally you want this, but for very small binaries you may want to 2075have. Normally you want this, but for very small binaries you may want to
1612disable this. 2076disable this.
1613 2077
2078A non-exhaustive list of features enabled by C<--enable-frills> (possibly
2079in combination with other switches) is:
2080
2081 MWM-hints
2082 EWMH-hints (pid, utf8 names) and protocols (ping)
2083 seperate underline colour (-underlineColor)
2084 settable border widths and borderless switch (-w, -b, -bl)
2085 settable extra linespacing /-lsp)
2086 iso-14755-2 and -3, and visual feedback
2087 backindex and forwardindex escape sequence
2088 window op and some xterm/OSC escape sequences
2089 tripleclickwords (-tcw)
2090 settable insecure mode (-insecure)
2091 keysym remapping support
2092 cursor blinking and underline cursor (-cb, -uc)
2093 XEmbed support (-embed)
2094 user-pty (-pty-fd)
2095 hold on exit (-hold)
2096 skip builtin block graphics (-sbg)
2097 sgr modes 90..97 and 100..107
2098
1614=item --enable-iso14755 2099=item --enable-iso14755 (default: on)
1615 2100
1616Enable extended ISO 14755 support (see @@RXVT_NAME@@(1), or 2101Enable extended ISO 14755 support (see @@RXVT_NAME@@(1), or
1617F<doc/rxvt.1.txt>). Basic support (section 5.1) is enabled by 2102F<doc/rxvt.1.txt>). Basic support (section 5.1) is enabled by
1618C<--enable-frills>, while support for 5.2, 5.3 and 5.4 is enabled with 2103C<--enable-frills>, while support for 5.2, 5.3 and 5.4 is enabled with
1619this switch. 2104this switch.
1620 2105
1621=item --enable-linespace
1622
1623Add support to provide user specified line spacing between text rows.
1624
1625=item --enable-keepscrolling 2106=item --enable-keepscrolling (default: on)
1626 2107
1627Add support for continual scrolling of the display when you hold 2108Add support for continual scrolling of the display when you hold
1628the mouse button down on a scrollbar arrow. 2109the mouse button down on a scrollbar arrow.
1629 2110
1630=item --enable-mousewheel 2111=item --enable-mousewheel (default: on)
1631 2112
1632Add support for scrolling via mouse wheel or buttons 4 & 5. 2113Add support for scrolling via mouse wheel or buttons 4 & 5.
1633 2114
1634=item --enable-slipwheeling 2115=item --enable-slipwheeling (default: on)
1635 2116
1636Add support for continual scrolling (using the mouse wheel as an 2117Add support for continual scrolling (using the mouse wheel as an
1637accelerator) while the control key is held down. This option 2118accelerator) while the control key is held down. This option
1638requires --enable-mousewheel to also be specified. 2119requires --enable-mousewheel to also be specified.
1639 2120
1640=item --disable-new-selection 2121=item --disable-new-selection
1641 2122
1642Remove support for mouse selection style like that of xterm. 2123Remove support for mouse selection style like that of xterm.
1643 2124
1644=item --enable-dmalloc 2125=item --enable-dmalloc (default: off)
1645 2126
1646Use Gray Watson's malloc - which is good for debugging See 2127Use Gray Watson's malloc - which is good for debugging See
1647http://www.letters.com/dmalloc/ for details If you use either this or the 2128http://www.letters.com/dmalloc/ for details If you use either this or the
1648next option, you may need to edit src/Makefile after compiling to point 2129next option, you may need to edit src/Makefile after compiling to point
1649DINCLUDE and DLIB to the right places. 2130DINCLUDE and DLIB to the right places.
1650 2131
1651You can only use either this option and the following (should 2132You can only use either this option and the following (should
1652you use either) . 2133you use either) .
1653 2134
1654=item --enable-dlmalloc 2135=item --enable-dlmalloc (default: off)
1655 2136
1656Use Doug Lea's malloc - which is good for a production version 2137Use Doug Lea's malloc - which is good for a production version
1657See L<http://g.oswego.edu/dl/html/malloc.html> for details. 2138See L<http://g.oswego.edu/dl/html/malloc.html> for details.
1658 2139
1659=item --enable-smart-resize 2140=item --enable-smart-resize (default: on)
1660 2141
1661Add smart growth/shrink behaviour when changing font size via from hot 2142Add smart growth/shrink behaviour when changing font size via hot
1662keys. This should keep in a fixed position the rxvt corner which is 2143keys. This should keep the window corner which is closest to a corner of
1663closest to a corner of the screen. 2144the screen in a fixed position.
1664 2145
1665=item --enable-256-color
1666
1667Add support for 256 colours rather than the base 16 colours.
1668
1669This option will likely go away in the future. Speak up if you don't want
1670this.
1671
1672=item --enable-cursor-blink
1673
1674Add support for a blinking cursor.
1675
1676=item --enable-pointer-blank 2146=item --enable-pointer-blank (default: on)
1677 2147
1678Add support to have the pointer disappear when typing or inactive. 2148Add support to have the pointer disappear when typing or inactive.
1679 2149
1680=item --with-name=NAME 2150=item --enable-perl (default: off)
1681 2151
2152Enable an embedded perl interpreter. See the B<@@RXVT_NAME@@perl(3)>
2153manpage (F<doc/rxvtperl.txt>) for more info on this feature, or the files
2154in F<src/perl-ext/> for the extensions that are installed by default. The
2155perl interpreter that is used can be specified via the C<PERL> environment
2156variable when running configure.
2157
2158=item --with-name=NAME (default: urxvt)
2159
1682Set the basename for the installed binaries (default: urxvt, resulting in 2160Set the basename for the installed binaries, resulting
1683urxvt, urxvtd etc.). Specify --with-name=rxvt to replace rxvt. 2161in C<urxvt>, C<urxvtd> etc.). Specify C<--with-name=rxvt> to replace with
2162C<rxvt>.
1684 2163
1685=item --with-term=NAME 2164=item --with-term=NAME (default: rxvt-unicode)
1686 2165
1687Change the environmental variable for the terminal to NAME (default 2166Change the environmental variable for the terminal to NAME.
1688"rxvt")
1689 2167
1690=item --with-terminfo=PATH 2168=item --with-terminfo=PATH
1691 2169
1692Change the environmental variable for the path to the terminfo tree to 2170Change the environmental variable for the path to the terminfo tree to
1693PATH. 2171PATH.

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines