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

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

Diff Legend

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