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

Diff Legend

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