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

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

Diff Legend

– Removed lines
+ Added lines
< Changed lines
> Changed lines