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

Diff Legend

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