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.23 by root, Wed Aug 25 03:47:20 2004 UTC vs.
Revision 1.86 by root, Mon Jan 16 17:24:29 2006 UTC

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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines