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

Diff Legend

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