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

Comparing rxvt-unicode/doc/rxvt.7.pod (file contents):
Revision 1.5 by root, Thu Aug 12 22:29:28 2004 UTC vs.
Revision 1.44 by root, Fri Feb 11 18:06:44 2005 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
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 How do I know which rxvt-unicode version I'm using?
30
31The version number is displayed with the usage (-h). Also the escape
32sequence C<ESC [ 8 n> sets the window title to the version number.
33
34=item I am using Debian GNU/Linux and have a problem...
35
36The Debian GNU/Linux package of rxvt-unicode contains large patches that
37considerably change the behaviour of rxvt-unicode. Before reporting a
38bug to the original rxvt-unicode author please download and install the
39genuine version (L<http://software.schmorp.de#rxvt-unicode>) and try to
40reproduce the problem. If you cannot, chances are that the problems are
41specific to Debian GNU/Linux, in which case it should be reported via the
42Debian Bug Tracking System (use C<reportbug> to report the bug).
43
44For other problems that also affect the Debian package, you can and
45probably should use the Debian BTS, too, because, after all, it's also a
46bug in the Debian version and it serves as a reminder for other users that
47might encounter the same issue.
48
49=item When I log-in to another system it tells me about missing terminfo data?
50
51The terminal description used by rxvt-unicode is not as widely available
52as that for xterm, or even rxvt (for which the same problem often arises).
53
54The correct solution for this problem is to install the terminfo, this can
55be done like this (with ncurses' infocmp):
56
57 REMOTE=remotesystem.domain
58 infocmp rxvt-unicode | ssh $REMOTE "cat >/tmp/ti && tic /tmp/ti"
59
60... or by installing rxvt-unicode normally on the remote system,
61
62If you cannot or do not want to do this, then you can simply set
63C<TERM=rxvt> or even C<TERM=xterm>, and live with the small number of
64problems arising, which includes wrong keymapping, less and different
65colours and some refresh errors in fullscreen applications. It's a nice
66quick-and-dirty workaround for rare cases, though.
67
68If you always want to do this (and are fine with the consequences) you
69can either recompile rxvt-unicode with the desired TERM value or use a
70resource to set it:
71
72 URxvt.termName: rxvt
73
74If you don't plan to use B<rxvt> (quite common...) you could also replace
75the rxvt terminfo file with the rxvt-unicode one.
76
77=item C<bash>'s readline does not work correctly under @@RXVT_NAME@@.
78
79=item I need a termcap file entry.
80
81One reason you might want this is that some distributions or operating
82systems still compile some programs using the long-obsoleted termcap
83(Fedora Core's bash is one example) and rely on a termcap entry for
84C<rxvt-unicode>.
85
86You could use rxvt's termcap entry with resonable results in many cases.
87You can also create a termcap entry by using terminfo's infocmp program
88like this:
89
90 infocmp -C rxvt-unicode
91
92Or you could use this termcap entry, generated by the command above:
93
94 rxvt-unicode|rxvt-unicode terminal (X Window System):\
95 :am:bw:eo:km:mi:ms:xn:xo:\
96 :co#80:it#8:li#24:\
97 :AL=\E[%dL:DC=\E[%dP:DL=\E[%dM:DO=\E[%dB:IC=\E[%d@:\
98 :K1=\EOw:K2=\EOu:K3=\EOy:K4=\EOq:K5=\EOs:LE=\E[%dD:\
99 :RI=\E[%dC:SF=\E[%dS:SR=\E[%dT:UP=\E[%dA:ae=^O:al=\E[L:\
100 :as=^N:bl=^G:cd=\E[J:ce=\E[K:cl=\E[H\E[2J:cm=\E[%i%d;%dH:\
101 :cr=^M:cs=\E[%i%d;%dr:ct=\E[3g:dc=\E[P:dl=\E[M:do=^J:\
102 :ec=\E[%dX:ei=\E[4l:ho=\E[H:i1=\E[?47l\E=\E[?1l:ic=\E[@:\
103 :im=\E[4h:is=\E[r\E[m\E[2J\E[H\E[?7h\E[?1;3;4;6l\E[4l:\
104 :k0=\E[21~:k1=\E[11~:k2=\E[12~:k3=\E[13~:k4=\E[14~:\
105 :k5=\E[15~:k6=\E[17~:k7=\E[18~:k8=\E[19~:k9=\E[20~:\
106 :kD=\E[3~:kI=\E[2~:kN=\E[6~:kP=\E[5~:kb=\177:kd=\EOB:\
107 :ke=\E[?1l\E>:kh=\E[7~:kl=\EOD:kr=\EOC:ks=\E[?1h\E=:\
108 :ku=\EOA:le=^H:mb=\E[5m:md=\E[1m:me=\E[m\017:mr=\E[7m:\
109 :nd=\E[C:rc=\E8:sc=\E7:se=\E[27m:sf=^J:so=\E[7m:sr=\EM:\
110 :st=\EH:ta=^I:te=\E[r\E[?1049l:ti=\E[?1049h:ue=\E[24m:\
111 :up=\E[A:us=\E[4m:vb=\E[?5h\E[?5l:ve=\E[?25h:vi=\E[?25l:\
112 :vs=\E[?25h:
113
114=item Why does C<ls> no longer have coloured output?
115
116The C<ls> in the GNU coreutils unfortunately doesn't use terminfo to
117decide wether a terminal has colour, but uses it's own configuration
118file. Needless to say, C<rxvt-unicode> is not in it's default file (among
119with most other terminals supporting colour). Either add:
120
121 TERM rxvt-unicode
122
123to C</etc/DIR_COLORS> or simply add:
124
125 alias ls='ls --color=auto'
126
127to your C<.profile> or C<.bashrc>.
128
129=item Why doesn't vim/emacs etc. use the 88 colour mode?
130
131=item Why doesn't vim/emacs etc. make use of italic?
132
133=item Why are the secondary screen-related options not working properly?
134
135Make sure you are using C<TERM=rxvt-unicode>. Some pre-packaged
136distributions (most notably Debian GNU/Linux) break rxvt-unicode
137by setting C<TERM> to C<rxvt>, which doesn't have these extra
138features. Unfortunately, some of these (most notably, again, Debian
139GNU/Linux) furthermore fail to even install the C<rxvt-unicode> terminfo
140file, so you will need to install it on your own (See the question B<When
141I log-in to another system it tells me about missing terminfo data?> on
142how to do this).
143
144=item My numerical keypad acts weird and generates differing output?
145
146Some Debian GNUL/Linux users seem to have this problem, although no
147specific details were reported so far. It is possible that this is caused
148by the wrong C<TERM> setting, although the details of wether and how
149this can happen are unknown, as C<TERM=rxvt> should offer a compatible
150keymap. See the answer to the previous question, and please report if that
151helped.
152
153=item Rxvt-unicode does not seem to understand the selected encoding?
154
155=item Unicode does not seem to work?
156
157If you encounter strange problems like typing an accented character but
158getting two unrelated other characters or similar, or if program output is
159subtly garbled, then you should check your locale settings.
160
161Rxvt-unicode must be started with the same C<LC_CTYPE> setting as the
162programs. Often rxvt-unicode is started in the C<C> locale, while the
163login script running within the rxvt-unicode window changes the locale to
164something else, e.g. C<en_GB.UTF-8>. Needless to say, this is not going to work.
165
166The best thing is to fix your startup environment, as you will likely run
167into other problems. If nothing works you can try this in your .profile.
168
169 printf '\e]701;%s\007' "$LC_CTYPE"
170
171If this doesn't work, then maybe you use a C<LC_CTYPE> specification not
172supported on your systems. Some systems have a C<locale> command which
173displays this (also, C<perl -e0> can be used to check locale settings, as
174it will complain loudly if it cannot set the locale). If it displays something
175like:
176
177 locale: Cannot set LC_CTYPE to default locale: ...
178
179Then the locale you specified is not supported on your system.
180
181If nothing works and you are sure that everything is set correctly then
182you will need to remember a little known fact: Some programs just don't
183support locales :(
184
185=item Why do some characters look so much different than others?
186
187=item How does rxvt-unicode choose fonts?
188
189Most fonts do not contain the full range of Unicode, which is
190fine. Chances are that the font you (or the admin/package maintainer of
191your system/os) have specified does not cover all the characters you want
192to display.
193
194B<rxvt-unicode> makes a best-effort try at finding a replacement
195font. Often the result is fine, but sometimes the chosen font looks
196bad/ugly/wrong. Some fonts have totally strange characters that don't
197resemble the correct glyph at all, and rxvt-unicode lacks the artificial
198intelligence to detect that a specific glyph is wrong: it has to believe
199the font that the characters it claims to contain indeed look correct.
200
201In that case, select a font of your taste and add it to the font list,
202e.g.:
203
204 @@RXVT_NAME@@ -fn basefont,font2,font3...
205
206When rxvt-unicode sees a character, it will first look at the base
207font. If the base font does not contain the character, it will go to the
208next font, and so on. Specifying your own fonts will also speed up this
209search and use less resources within rxvt-unicode and the X-server.
210
211The only limitation is that none of the fonts may be larger than the base
212font, as the base font defines the terminal character cell size, which
213must be the same due to the way terminals work.
214
215=item Why do some chinese characters look so different than others?
216
217This is because there is a difference between script and language --
218rxvt-unicode does not know which language the text that is output is,
219as it only knows the unicode character codes. If rxvt-unicode first
220sees a japanese/chinese character, it might choose a japanese font for
221display. Subsequent japanese characters will use that font. Now, many
222chinese characters aren't represented in japanese fonts, so when the first
223non-japanese character comes up, rxvt-unicode will look for a chinese font
224-- unfortunately at this point, it will still use the japanese font for
225chinese characters that are also in the japanese font.
226
227The workaround is easy: just tag a chinese font at the end of your font
228list (see the previous question). The key is to view the font list as
229a preference list: If you expect more japanese, list a japanese font
230first. If you expect more chinese, put a chinese font first.
231
232In the future it might be possible to switch language preferences at
233runtime (the internal data structure has no problem with using different
234fonts for the same character at the same time, but no interface for this
235has been designed yet).
236
237Until then, you might get away with switching fonts at runtime (see L<Can
238I switch the fonts at runtime?> later in this document).
239
240=item Why does rxvt-unicode sometimes leave pixel droppings?
241
242Most fonts were not designed for terminal use, which means that character
243size varies a lot. A font that is otherwise fine for terminal use might
244contain some characters that are simply too wide. Rxvt-unicode will avoid
245these characters. For characters that are just "a bit" too wide a special
246"careful" rendering mode is used that redraws adjacent characters.
247
248All of this requires that fonts do not lie about character sizes,
249however: Xft fonts often draw glyphs larger than their acclaimed bounding
250box, and rxvt-unicode has no way of detecting this (the correct way is to
251ask for the character bounding box, which unfortunately is wrong in these
252cases).
253
254It's not clear (to me at least), wether this is a bug in Xft, freetype,
255or the respective font. If you encounter this problem you might try using
256the C<-lsp> option to give the font more height. If that doesn't work, you
257might be forced to use a different font.
258
259All of this is not a problem when using X11 core fonts, as their bounding
260box data is correct.
261
262=item My Compose (Multi_key) key is no longer working.
263
264The most common causes for this are that either your locale is not set
265correctly, or you specified a B<preeditStyle> that is not supported by
266your input method. For example, if you specified B<OverTheSpot> and
267your input method (e.g. the default input method handling Compose keys)
268does not support this (for instance because it is not visual), then
269rxvt-unicode will continue without an input method.
270
271In this case either do not specify a B<preeditStyle> or specify more than
272one pre-edit style, such as B<OverTheSpot,Root,None>.
273
274=item I cannot type C<Ctrl-Shift-2> to get an ASCII NUL character due to ISO 14755
275
276Either try C<Ctrl-2> alone (it often is mapped to ASCII NUL even on
277international keyboards) or simply use ISO 14755 support to your
278advantage, typing <Ctrl-Shift-0> to get a ASCII NUL. This works for other
279codes, too, such as C<Ctrl-Shift-1-d> to type the default telnet escape
280character and so on.
281
282=item How can I keep rxvt-unicode from using reverse video so much?
283
284First of all, make sure you are running with the right terminal settings
285(C<TERM=rxvt-unicode>), which will get rid of most of these effects. Then
286make sure you have specified colours for italic and bold, as otherwise
287rxvt-unicode might use reverse video to simulate the effect:
288
289 URxvt.colorBD: white
290 URxvt.colorIT: green
291
292=item Some programs assume totally weird colours (red instead of blue), how can I fix that?
293
294For some unexplainable reason, some rare programs assume a very weird
295colour palette when confronted with a terminal with more than the standard
2968 colours (rxvt-unicode supports 88). The right fix is, of course, to fix
297these programs not to assume non-ISO colours without very good reasons.
298
299In the meantime, you can either edit your C<rxvt-unicode> terminfo
300definition to only claim 8 colour support or use C<TERM=rxvt>, which will
301fix colours but keep you from using other rxvt-unicode features.
302
303=item I am on FreeBSD and rxvt-unicode does not seem to work at all.
304
305Rxvt-unicode requires the symbol C<__STDC_ISO_10646__> to be defined
306in your compile environment, or an implementation that implements it,
307wether it defines the symbol or not. C<__STDC_ISO_10646__> requires that
308B<wchar_t> is represented as unicode.
309
310As you might have guessed, FreeBSD does neither define this symobl nor
311does it support it. Instead, it uses it's own internal representation of
312B<wchar_t>. This is, of course, completely fine with respect to standards.
313
314However, C<__STDC_ISO_10646__> is the only sane way to support
315multi-language apps in an OS, as using a locale-dependent (and
316non-standardized) representation of B<wchar_t> makes it impossible to
317convert between B<wchar_t> (as used by X11 and your applications) and any
318other encoding without implementing OS-specific-wrappers for each and
319every locale. There simply are no APIs to convert B<wchar_t> into anything
320except the current locale encoding.
321
322Some applications (such as the formidable B<mlterm>) work around this
323by carrying their own replacement functions for character set handling
324with them, and either implementing OS-dependent hacks or doing multiple
325conversions (which is slow and unreliable in case the OS implements
326encodings slightly different than the terminal emulator).
327
328The rxvt-unicode author insists that the right way to fix this is in the
329system libraries once and for all, instead of forcing every app to carry
330complete replacements for them :)
331
332=item How does rxvt-unicode determine the encoding to use?
333
334=item Is there an option to switch encodings?
335
336Unlike some other terminals, rxvt-unicode has no encoding switch, and no
337specific "utf-8" mode, such as xterm. In fact, it doesn't even know about
338UTF-8 or any other encodings with respect to terminal I/O.
339
340The reasons is that there exists a perfectly fine mechanism for selecting
341the encoding, doing I/O and (most important) communicating this to all
342applications so everybody agrees on character properties such as width
343and code number. This mechanism is the I<locale>. Applications not using
344that info will have problems (for example, C<xterm> gets the width of
345characters wrong as it uses it's own, locale-independent table under all
346locales).
347
348Rxvt-unicode uses the C<LC_CTYPE> locale category to select encoding. All
349programs doing the same (that is, most) will automatically agree in the
350interpretation of characters.
351
352Unfortunately, there is no system-independent way to select locales, nor
353is there a standard on how locale specifiers will look like.
354
355On most systems, the content of the C<LC_CTYPE> environment variable
356contains an arbitrary string which corresponds to an already-installed
357locale. Common names for locales are C<en_US.UTF-8>, C<de_DE.ISO-8859-15>,
358C<ja_JP.EUC-JP>, i.e. C<language_country.encoding>, but other forms
359(i.e. C<de> or C<german>) are also common.
360
361Rxvt-unicode ignores all other locale categories, and except for
362the encoding, ignores country or language-specific settings,
363i.e. C<de_DE.UTF-8> and C<ja_JP.UTF-8> are the normally same to
364rxvt-unicode.
365
366If you want to use a specific encoding you have to make sure you start
367rxvt-unicode with the correct C<LC_CTYPE> category.
368
369=item Can I switch locales at runtime?
370
371Yes, using an escape sequence. Try something like this, which sets
372rxvt-unicode's idea of C<LC_CTYPE>.
373
374 printf '\e]701;%s\007' ja_JP.SJIS
375
376See also the previous answer.
377
378Sometimes this capability is rather handy when you want to work in
379one locale (e.g. C<de_DE.UTF-8>) but some programs don't support it
380(e.g. UTF-8). For example, I use this script to start C<xjdic>, which
381first switches to a locale supported by xjdic and back later:
382
383 printf '\e]701;%s\007' ja_JP.SJIS
384 xjdic -js
385 printf '\e]701;%s\007' de_DE.UTF-8
386
387You can also use xterm's C<luit> program, which usually works fine, except
388for some locales where character width differs between program- and
389rxvt-unicode-locales.
390
391=item Can I switch the fonts at runtime?
392
393Yes, using an escape sequence. Try something like this, which has the same
394effect as using the C<-fn> switch, and takes effect immediately:
395
396 printf '\e]50;%s\007' "9x15bold,xft:Kochi Gothic"
397
398This is useful if you e.g. work primarily with japanese (and prefer a
399japanese font), but you have to switch to chinese temporarily, where
400japanese fonts would only be in your way.
401
402You can think of this as a kind of manual ISO-2022 switching.
403
404=item Why do italic characters look as if clipped?
405
406Many fonts have difficulties with italic characters and hinting. For
407example, the otherwise very nicely hinted font C<xft:Bitstream Vera Sans
408Mono> completely fails in it's italic face. A workaround might be to
409enable freetype autohinting, i.e. like this:
410
411 URxvt.italicFont: xft:Bitstream Vera Sans Mono:italic:autohint=true
412 URxvt.boldItalicFont: xft:Bitstream Vera Sans Mono:bold:italic:autohint=true
413
414=item My input method wants <some encoding> but I want UTF-8, what can I do?
415
416You can specify separate locales for the input method and the rest of the
417terminal, using the resource C<imlocale>:
418
419 URxvt*imlocale: ja_JP.EUC-JP
420
421Now you can start your terminal with C<LC_CTYPE=ja_JP.UTF-8> and still
422use your input method. Please note, however, that you will not be able to
423input characters outside C<EUC-JP> in a normal way then, as your input
424method limits you.
425
426=item Rxvt-unicode uses gobs of memory, how can I reduce that?
427
428Rxvt-unicode tries to obey the rule of not charging you for something you
429don't use. One thing you should try is to configure out all settings that
430you don't need, for example, Xft support is a resource hog by design,
431when used. Compiling it out ensures that no Xft font will be loaded
432accidentally when rxvt-unicode tries to find a font for your characters.
433
434Also, many people (me included) like large windows and even larger
435scrollback buffers: Without C<--enable-unicode3>, rxvt-unicode will use
4366 bytes per screen cell. For a 160x?? window this amounts to almost a
437kilobyte per line. A scrollback buffer of 10000 lines will then (if full)
438use 10 Megabytes of memory. With C<--enable-unicode3> it gets worse, as
439rxvt-unicode then uses 8 bytes per screen cell.
440
441=item Can I speed up Xft rendering somehow?
442
443Yes, the most obvious way to speed it up is to avoid Xft entirely, as
444it is simply slow. If you still want Xft fonts you might try to disable
445antialiasing (by appending C<:antialiasing=false>), which saves lots of
446memory and also speeds up rendering considerably.
447
448=item Rxvt-unicode doesn't seem to anti-alias its fonts, what is wrong?
449
450Rxvt-unicode will use whatever you specify as a font. If it needs to
451fall back to it's default font search list it will prefer X11 core
452fonts, because they are small and fast, and then use Xft fonts. It has
453antialiasing disabled for most of them, because the author thinks they
454look best that way.
455
456If you want antialiasing, you have to specify the fonts manually.
457
458=item Mouse cut/paste suddenly no longer works.
459
460Make sure that mouse reporting is actually turned off since killing
461some editors prematurely may leave the mouse in mouse report mode. I've
462heard that tcsh may use mouse reporting unless it otherwise specified. A
463quick check is to see if cut/paste works when the Alt or Shift keys are
464depressed. See @@RXVT_NAME@@(7)
465
466=item What's with this bold/blink stuff?
467
468If no bold colour is set via C<colorBD:>, bold will invert text using the
469standard foreground colour.
470
471For the standard background colour, blinking will actually make the
472text blink when compiled with C<--enable-blinking>. with standard
473colours. Without C<--enable-blinking>, the blink attribute will be
474ignored.
475
476On ANSI colours, bold/blink attributes are used to set high-intensity
477foreground/background colors.
478
479color0-7 are the low-intensity colors.
480
481color8-15 are the corresponding high-intensity colors.
482
483=item I don't like the screen colors. How do I change them?
484
485You can change the screen colors at run-time using F<~/.Xdefaults>
486resources (or as long-options).
487
488Here are values that are supposed to resemble a VGA screen,
489including the murky brown that passes for low-intensity yellow:
490
491 URxvt.color0: #000000
492 URxvt.color1: #A80000
493 URxvt.color2: #00A800
494 URxvt.color3: #A8A800
495 URxvt.color4: #0000A8
496 URxvt.color5: #A800A8
497 URxvt.color6: #00A8A8
498 URxvt.color7: #A8A8A8
499
500 URxvt.color8: #000054
501 URxvt.color9: #FF0054
502 URxvt.color10: #00FF54
503 URxvt.color11: #FFFF54
504 URxvt.color12: #0000FF
505 URxvt.color13: #FF00FF
506 URxvt.color14: #00FFFF
507 URxvt.color15: #FFFFFF
508
509And here is a more complete set of non-standard colors described (not by
510me) as "pretty girly".
511
512 URxvt.cursorColor: #dc74d1
513 URxvt.pointerColor: #dc74d1
514 URxvt.background: #0e0e0e
515 URxvt.foreground: #4ad5e1
516 URxvt.color0: #000000
517 URxvt.color8: #8b8f93
518 URxvt.color1: #dc74d1
519 URxvt.color9: #dc74d1
520 URxvt.color2: #0eb8c7
521 URxvt.color10: #0eb8c7
522 URxvt.color3: #dfe37e
523 URxvt.color11: #dfe37e
524 URxvt.color5: #9e88f0
525 URxvt.color13: #9e88f0
526 URxvt.color6: #73f7ff
527 URxvt.color14: #73f7ff
528 URxvt.color7: #e1dddd
529 URxvt.color15: #e1dddd
530
531=item How can I start @@RXVT_NAME@@d in a race-free way?
532
533Despite it's name, @@RXVT_NAME@@d is not a real daemon, but more like a
534server that answers @@RXVT_NAME@@c's requests, so it doesn't background
535itself.
536
537To ensure @@RXVT_NAME@@d is listening on it's socket, you can use the
538following method to wait for the startup message before continuing:
539
540 { @@RXVT_NAME@@d & } | read
541
542=item What's with the strange Backspace/Delete key behaviour?
543
544Assuming that the physical Backspace key corresponds to the
545BackSpace keysym (not likely for Linux ... see the following
546question) there are two standard values that can be used for
547Backspace: C<^H> and C<^?>.
548
549Historically, either value is correct, but rxvt-unicode adopts the debian
550policy of using C<^?> when unsure, because it's the one only only correct
551choice :).
552
553Rxvt-unicode tries to inherit the current stty settings and uses the value
554of `erase' to guess the value for backspace. If rxvt-unicode wasn't
555started from a terminal (say, from a menu or by remote shell), then the
556system value of `erase', which corresponds to CERASE in <termios.h>, will
557be used (which may not be the same as your stty setting).
558
559For starting a new rxvt-unicode:
560
561 # use Backspace = ^H
562 $ stty erase ^H
563 $ @@RXVT_NAME@@
564
565 # use Backspace = ^?
566 $ stty erase ^?
567 $ @@RXVT_NAME@@
568
569Toggle with C<ESC [ 36 h> / C<ESC [ 36 l> as documented in @@RXVT_NAME@@(7).
570
571For an existing rxvt-unicode:
572
573 # use Backspace = ^H
574 $ stty erase ^H
575 $ echo -n "^[[36h"
576
577 # use Backspace = ^?
578 $ stty erase ^?
579 $ echo -n "^[[36l"
580
581This helps satisfy some of the Backspace discrepancies that occur, but
582if you use Backspace = C<^H>, make sure that the termcap/terminfo value
583properly reflects that.
584
585The Delete key is a another casualty of the ill-defined Backspace problem.
586To avoid confusion between the Backspace and Delete keys, the Delete
587key has been assigned an escape sequence to match the vt100 for Execute
588(C<ESC [ 3 ~>) and is in the supplied termcap/terminfo.
589
590Some other Backspace problems:
591
592some editors use termcap/terminfo,
593some editors (vim I'm told) expect Backspace = ^H,
594GNU Emacs (and Emacs-like editors) use ^H for help.
595
596Perhaps someday this will all be resolved in a consistent manner.
597
598=item I don't like the key-bindings. How do I change them?
599
600There are some compile-time selections available via configure. Unless
601you have run "configure" with the C<--disable-resources> option you can
602use the `keysym' resource to alter the keystrings associated with keysyms.
603
604Here's an example for a URxvt session started using C<@@RXVT_NAME@@ -name URxvt>
605
606 URxvt.keysym.Home: \033[1~
607 URxvt.keysym.End: \033[4~
608 URxvt.keysym.C-apostrophe: \033<C-'>
609 URxvt.keysym.C-slash: \033<C-/>
610 URxvt.keysym.C-semicolon: \033<C-;>
611 URxvt.keysym.C-grave: \033<C-`>
612 URxvt.keysym.C-comma: \033<C-,>
613 URxvt.keysym.C-period: \033<C-.>
614 URxvt.keysym.C-0x60: \033<C-`>
615 URxvt.keysym.C-Tab: \033<C-Tab>
616 URxvt.keysym.C-Return: \033<C-Return>
617 URxvt.keysym.S-Return: \033<S-Return>
618 URxvt.keysym.S-space: \033<S-Space>
619 URxvt.keysym.M-Up: \033<M-Up>
620 URxvt.keysym.M-Down: \033<M-Down>
621 URxvt.keysym.M-Left: \033<M-Left>
622 URxvt.keysym.M-Right: \033<M-Right>
623 URxvt.keysym.M-C-0: list \033<M-C- 0123456789 >
624 URxvt.keysym.M-C-a: list \033<M-C- abcdefghijklmnopqrstuvwxyz >
625 URxvt.keysym.F12: command:\033]701;zh_CN.GBK\007
626
627See some more examples in the documentation for the B<keysym> resource.
628
629=item I'm using keyboard model XXX that has extra Prior/Next/Insert keys.
630How do I make use of them? For example, the Sun Keyboard type 4
631has the following mappings that rxvt-unicode doesn't recognize.
632
633 KP_Insert == Insert
634 F22 == Print
635 F27 == Home
636 F29 == Prior
637 F33 == End
638 F35 == Next
639
640Rather than have rxvt-unicode try to accommodate all the various possible
641keyboard mappings, it is better to use `xmodmap' to remap the keys as
642required for your particular machine.
643
644=item How do I distinguish wether I'm running rxvt-unicode or a regular xterm?
645I need this to decide about setting colors etc.
646
647rxvt and rxvt-unicode always export the variable "COLORTERM", so you can
648check and see if that is set. Note that several programs, JED, slrn,
649Midnight Commander automatically check this variable to decide whether or
650not to use color.
651
652=item How do I set the correct, full IP address for the DISPLAY variable?
653
654If you've compiled rxvt-unicode with DISPLAY_IS_IP and have enabled
655insecure mode then it is possible to use the following shell script
656snippets to correctly set the display. If your version of rxvt-unicode
657wasn't also compiled with ESCZ_ANSWER (as assumed in these snippets) then
658the COLORTERM variable can be used to distinguish rxvt-unicode from a
659regular xterm.
660
661Courtesy of Chuck Blake <cblake@BBN.COM> with the following shell script
662snippets:
663
664 # Bourne/Korn/POSIX family of shells:
665 [ ${TERM:-foo} = foo ] && TERM=xterm # assume an xterm if we don't know
666 if [ ${TERM:-foo} = xterm ]; then
667 stty -icanon -echo min 0 time 15 # see if enhanced rxvt or not
668 echo -n '^[Z'
669 read term_id
670 stty icanon echo
671 if [ ""${term_id} = '^[[?1;2C' -a ${DISPLAY:-foo} = foo ]; then
672 echo -n '^[[7n' # query the rxvt we are in for the DISPLAY string
673 read DISPLAY # set it in our local shell
674 fi
675 fi
676
677=item How do I compile the manual pages for myself?
678
679You need to have a recent version of perl installed as F</usr/bin/perl>,
680one that comes with F<pod2man>, F<pod2text> and F<pod2html>. Then go to
681the doc subdirectory and enter C<make alldoc>.
682
683=item My question isn't answered here, can I ask a human?
684
685Before sending me mail, you could go to IRC: C<irc.freenode.net>,
686channel C<#rxvt-unicode> has some rxvt-unicode enthusiasts that might be
687interested in learning about new and exciting problems (but not FAQs :).
688
689=back
690
1=head1 RXVT TECHNICAL REFERENCE 691=head1 RXVT TECHNICAL REFERENCE
692
693=head1 DESCRIPTION
694
695The rest of this document describes various technical aspects of
696B<rxvt-unicode>. First the description of supported command sequences,
697followed by menu and pixmap support and last by a description of all
698features selectable at C<configure> time.
2 699
3=head1 Definitions 700=head1 Definitions
4 701
5=over 4 702=over 4
6 703
135Single Shift Select of G3 Character Set (SS3): affects next character 832Single Shift Select of G3 Character Set (SS3): affects next character
136only I<unimplemented> 833only I<unimplemented>
137 834
138=item B<< C<ESC Z> >> 835=item B<< C<ESC Z> >>
139 836
140Obsolete form of returns: B<< C<ESC[?1;2C> >> I<rxvt-unicode compile-time option> 837Obsolete form of returns: B<< C<ESC [ ? 1 ; 2 C> >> I<rxvt-unicode compile-time option>
141 838
142=item B<< C<ESC c> >> 839=item B<< C<ESC c> >>
143 840
144Full reset (RIS) 841Full reset (RIS)
145 842
149 846
150=item B<< C<ESC o> >> 847=item B<< C<ESC o> >>
151 848
152Invoke the G3 Character Set (LS3) 849Invoke the G3 Character Set (LS3)
153 850
154=item B<< C<ESC>(C<C> >> 851=item B<< C<ESC ( C> >>
155 852
156Designate G0 Character Set (ISO 2022), see below for values of C<C>. 853Designate G0 Character Set (ISO 2022), see below for values of C<C>.
157 854
158=item B<< C<ESC>)C<C> >> 855=item B<< C<ESC ) C> >>
159 856
160Designate G1 Character Set (ISO 2022), see below for values of C<C>. 857Designate G1 Character Set (ISO 2022), see below for values of C<C>.
161 858
162=item B<< C<ESC * C> >> 859=item B<< C<ESC * C> >>
163 860
187 884
188=back 885=back
189 886
190X<CSI> 887X<CSI>
191 888
192=head1 CSI (Code Sequence Introducer) Sequences 889=head1 CSI (Command Sequence Introducer) Sequences
193 890
194=over 4 891=over 4
195 892
196=item B<< C<ESC [ Ps @> >> 893=item B<< C<ESC [ Ps @> >>
197 894
304 1001
305=item B<< C<ESC [ Ps c> >> 1002=item B<< C<ESC [ Ps c> >>
306 1003
307Send Device Attributes (DA) 1004Send Device Attributes (DA)
308B<< C<Ps = 0> >> (or omitted): request attributes from terminal 1005B<< C<Ps = 0> >> (or omitted): request attributes from terminal
309returns: B<< C<ESC[?1;2c> >> (``I am a VT100 with Advanced Video 1006returns: B<< C<ESC [ ? 1 ; 2 c> >> (``I am a VT100 with Advanced Video
310Option'') 1007Option'')
311 1008
312=item B<< C<ESC [ Ps d> >> 1009=item B<< C<ESC [ Ps d> >>
313 1010
314Cursor to Line B<< C<Ps> >> (VPA) 1011Cursor to Line B<< C<Ps> >> (VPA)
330 B<< C<Ps = 0> >> Clear Current Column (default) 1027 B<< C<Ps = 0> >> Clear Current Column (default)
331 B<< C<Ps = 3> >> Clear All (TBC) 1028 B<< C<Ps = 3> >> Clear All (TBC)
332 1029
333=end table 1030=end table
334 1031
1032=item B<< C<ESC [ Pm h> >>
1033
1034Set Mode (SM). See B<< C<ESC [ Pm l> >> sequence for description of C<Pm>.
1035
335=item B<< C<ESC [ Ps i> >> 1036=item B<< C<ESC [ Ps i> >>
336 1037
337Printing 1038Printing. See also the C<print-pipe> resource.
338 1039
339=begin table 1040=begin table
340 1041
1042 B<< C<Ps = 0> >> print screen (MC0)
341 B<< C<Ps = 4> >> disable transparent print mode (MC4) 1043 B<< C<Ps = 4> >> disable transparent print mode (MC4)
342 B<< C<Ps = 5> >> enable transparent print mode (MC5) I<unimplemented> 1044 B<< C<Ps = 5> >> enable transparent print mode (MC5)
343 1045
344=end table 1046=end table
345
346=item B<< C<ESC [ Pm h> >>
347
348Set Mode (SM). See next sequence for description of C<Pm>.
349 1047
350=item B<< C<ESC [ Pm l> >> 1048=item B<< C<ESC [ Pm l> >>
351 1049
352Reset Mode (RM) 1050Reset Mode (RM)
353 1051
360 B<< C<h> >> Insert Mode (SMIR) 1058 B<< C<h> >> Insert Mode (SMIR)
361 B<< C<l> >> Replace Mode (RMIR) 1059 B<< C<l> >> Replace Mode (RMIR)
362 1060
363=end table 1061=end table
364 1062
365=item B<< C<Ps = 20> >> I<unimplemented> 1063=item B<< C<Ps = 20> >> (partially implemented)
366 1064
367=begin table 1065=begin table
368 1066
369 B<< C<h> >> Automatic Newline (LNM) 1067 B<< C<h> >> Automatic Newline (LNM)
370 B<< C<h> >> Normal Linefeed (LNM) 1068 B<< C<l> >> Normal Linefeed (LNM)
371 1069
372=end table 1070=end table
373 1071
374=back 1072=back
375 1073
378Character Attributes (SGR) 1076Character Attributes (SGR)
379 1077
380=begin table 1078=begin table
381 1079
382 B<< C<Ps = 0> >> Normal (default) 1080 B<< C<Ps = 0> >> Normal (default)
383 B<< C<Ps = 1 / 22> >> On / Off Bold (bright fg) 1081 B<< C<Ps = 1 / 21> >> On / Off Bold (bright fg)
1082 B<< C<Ps = 3 / 23> >> On / Off Italic
384 B<< C<Ps = 4 / 24> >> On / Off Underline 1083 B<< C<Ps = 4 / 24> >> On / Off Underline
385 B<< C<Ps = 5 / 25> >> On / Off Blink (bright bg) 1084 B<< C<Ps = 5 / 25> >> On / Off Slow Blink (bright bg)
1085 B<< C<Ps = 6 / 26> >> On / Off Rapid Blink (bright bg)
386 B<< C<Ps = 7 / 27> >> On / Off Inverse 1086 B<< C<Ps = 7 / 27> >> On / Off Inverse
1087 B<< C<Ps = 8 / 27> >> On / Off Invisible (NYI)
387 B<< C<Ps = 30 / 40> >> fg/bg Black 1088 B<< C<Ps = 30 / 40> >> fg/bg Black
388 B<< C<Ps = 31 / 41> >> fg/bg Red 1089 B<< C<Ps = 31 / 41> >> fg/bg Red
389 B<< C<Ps = 32 / 42> >> fg/bg Green 1090 B<< C<Ps = 32 / 42> >> fg/bg Green
390 B<< C<Ps = 33 / 43> >> fg/bg Yellow 1091 B<< C<Ps = 33 / 43> >> fg/bg Yellow
391 B<< C<Ps = 34 / 44> >> fg/bg Blue 1092 B<< C<Ps = 34 / 44> >> fg/bg Blue
392 B<< C<Ps = 35 / 45> >> fg/bg Magenta 1093 B<< C<Ps = 35 / 45> >> fg/bg Magenta
393 B<< C<Ps = 36 / 46> >> fg/bg Cyan 1094 B<< C<Ps = 36 / 46> >> fg/bg Cyan
1095 B<< C<Ps = 38;5 / 48;5> >> set fg/bg to color #m (ISO 8613-6)
394 B<< C<Ps = 37 / 47> >> fg/bg White 1096 B<< C<Ps = 37 / 47> >> fg/bg White
395 B<< C<Ps = 39 / 49> >> fg/bg Default 1097 B<< C<Ps = 39 / 49> >> fg/bg Default
1098 B<< C<Ps = 90 / 100> >> fg/bg Bright Black
1099 B<< C<Ps = 91 / 101> >> fg/bg Bright Red
1100 B<< C<Ps = 92 / 102> >> fg/bg Bright Green
1101 B<< C<Ps = 93 / 103> >> fg/bg Bright Yellow
1102 B<< C<Ps = 94 / 104> >> fg/bg Bright Blue
1103 B<< C<Ps = 95 / 105> >> fg/bg Bright Magenta
1104 B<< C<Ps = 96 / 106> >> fg/bg Bright Cyan
1105 B<< C<Ps = 97 / 107> >> fg/bg Bright White
1106 B<< C<Ps = 99 / 109> >> fg/bg Bright Default
396 1107
397=end table 1108=end table
398 1109
399=item B<< C<ESC [ Ps n> >> 1110=item B<< C<ESC [ Ps n> >>
400 1111
416 1127
417=item B<< C<ESC [ s> >> 1128=item B<< C<ESC [ s> >>
418 1129
419Save Cursor (SC) 1130Save Cursor (SC)
420 1131
1132=item B<< C<ESC [ Ps;Pt t> >>
1133
1134Window Operations
1135
1136=begin table
1137
1138 B<< C<Ps = 1> >> Deiconify (map) window
1139 B<< C<Ps = 2> >> Iconify window
1140 B<< C<Ps = 3> >> B<< C<ESC [ 3 ; X ; Y t> >> Move window to (X|Y)
1141 B<< C<Ps = 4> >> B<< C<ESC [ 4 ; H ; W t> >> Resize to WxH pixels
1142 B<< C<Ps = 5> >> Raise window
1143 B<< C<Ps = 6> >> Lower window
1144 B<< C<Ps = 7> >> Refresh screen once
1145 B<< C<Ps = 8> >> B<< C<ESC [ 8 ; R ; C t> >> Resize to R rows and C columns
1146 B<< C<Ps = 11> >> Report window state (responds with C<Ps = 1> or C<Ps = 2>)
1147 B<< C<Ps = 13> >> Report window position (responds with C<Ps = 3>)
1148 B<< C<Ps = 14> >> Report window pixel size (responds with C<Ps = 4>)
1149 B<< C<Ps = 18> >> Report window text size (responds with C<Ps = 7>)
1150 B<< C<Ps = 19> >> Currently the same as C<Ps = 18>, but responds with C<Ps = 9>
1151 B<< C<Ps = 20> >> Reports icon label (B<< C<ESC ] L NAME \234> >>)
1152 B<< C<Ps = 21> >> Reports window title (B<< C<ESC ] l NAME \234> >>)
1153 B<< C<Ps = 24..> >> Set window height to C<Ps> rows
1154
1155=end table
1156
1157=item B<< C<ESC [ u> >>
1158
1159Restore Cursor
1160
421=item B<< C<ESC [ Ps x> >> 1161=item B<< C<ESC [ Ps x> >>
422 1162
423Request Terminal Parameters (DECREQTPARM) 1163Request Terminal Parameters (DECREQTPARM)
424
425=item B<< C<ESC [ u> >>
426
427Restore Cursor
428 1164
429=back 1165=back
430 1166
431X<PrivateModes> 1167X<PrivateModes>
432 1168
535 B<< C<h> >> Send Mouse X & Y on button press. 1271 B<< C<h> >> Send Mouse X & Y on button press.
536 B<< C<l> >> No mouse reporting. 1272 B<< C<l> >> No mouse reporting.
537 1273
538=end table 1274=end table
539 1275
540X<Priv10>
541
542=item B<< C<Ps = 10> >> (B<rxvt>) 1276=item B<< C<Ps = 10> >> (B<rxvt>)
543 1277
544=begin table 1278=begin table
545 1279
546 B<< C<h> >> visible 1280 B<< C<h> >> menuBar visible
547 B<< C<l> >> invisible 1281 B<< C<l> >> menuBar invisible
548 1282
549=end table 1283=end table
550 1284
551=item B<< C<Ps = 25> >> 1285=item B<< C<Ps = 25> >>
552 1286
653 B<< C<h> >> Use Hilite Mouse Tracking. 1387 B<< C<h> >> Use Hilite Mouse Tracking.
654 B<< C<l> >> No mouse reporting. 1388 B<< C<l> >> No mouse reporting.
655 1389
656=end table 1390=end table
657 1391
658=item B<< C<Ps = 1010> >> 1392=item B<< C<Ps = 1010> >> (B<rxvt>)
659 1393
660=begin table 1394=begin table
661 1395
662 B<< C<h> >> Don't scroll to bottom on TTY output 1396 B<< C<h> >> Don't scroll to bottom on TTY output
663 B<< C<l> >> Scroll to bottom on TTY output 1397 B<< C<l> >> Scroll to bottom on TTY output
664 1398
665=end table 1399=end table
666 1400
667=item B<< C<Ps = 1011> >> 1401=item B<< C<Ps = 1011> >> (B<rxvt>)
668 1402
669=begin table 1403=begin table
670 1404
671 B<< C<h> >> Scroll to bottom when a key is pressed 1405 B<< C<h> >> Scroll to bottom when a key is pressed
672 B<< C<l> >> Don't scroll to bottom when a key is pressed 1406 B<< C<l> >> Don't scroll to bottom when a key is pressed
686 1420
687=begin table 1421=begin table
688 1422
689 B<< C<h> >> Save cursor position 1423 B<< C<h> >> Save cursor position
690 B<< C<l> >> Restore cursor position 1424 B<< C<l> >> Restore cursor position
1425
1426=end table
1427
1428=item B<< C<Ps = 1049> >>
1429
1430=begin table
1431
1432 B<< C<h> >> Use Alternate Screen Buffer - clear Alternate Screen Buffer if switching to it
1433 B<< C<l> >> Use Normal Screen Buffer
691 1434
692=end table 1435=end table
693 1436
694=back 1437=back
695 1438
726 B<< C<Ps = 46> >> Change Log File to B<< C<Pt> >> I<unimplemented> 1469 B<< C<Ps = 46> >> Change Log File to B<< C<Pt> >> I<unimplemented>
727 B<< C<Ps = 49> >> Change default background colour to B<< C<Pt> >> I<rxvt compile-time option> 1470 B<< C<Ps = 49> >> Change default background colour to B<< C<Pt> >> I<rxvt compile-time option>
728 B<< C<Ps = 50> >> Set fontset to B<< C<Pt> >>, with the following special values of B<< C<Pt> >> (B<rxvt>) B<< C<#+n> >> change up B<< C<n> >> B<< C<#-n> >> change down B<< C<n> >> if B<< C<n> >> is missing of 0, a value of 1 is used I<empty> change to font0 B<< C<n> >> change to font B<< C<n> >> 1471 B<< C<Ps = 50> >> Set fontset to B<< C<Pt> >>, with the following special values of B<< C<Pt> >> (B<rxvt>) B<< C<#+n> >> change up B<< C<n> >> B<< C<#-n> >> change down B<< C<n> >> if B<< C<n> >> is missing of 0, a value of 1 is used I<empty> change to font0 B<< C<n> >> change to font B<< C<n> >>
729 B<< C<Ps = 55> >> Log all scrollback buffer and all of screen to B<< C<Pt> >> 1472 B<< C<Ps = 55> >> Log all scrollback buffer and all of screen to B<< C<Pt> >>
730 B<< C<Ps = 701> >> Change current locale to B<< C<Pt> >>, or, if B<< C<Pt> >> is B<< C<?> >>, return the current locale (@@RXVT_NAME@@ extension) 1473 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)
731 B<< C<Ps = 702> >> find font for character, used for debugging (@@RXVT_NAME@@ extension)
732 B<< C<Ps = 703> >> command B<< C<Pt> >> I<rxvt compile-time option> (@@RXVT_NAME@@ extension) 1474 B<< C<Ps = 703> >> Menubar command B<< C<Pt> >> I<rxvt compile-time option> (rxvt-unicode extension)
1475 B<< C<Ps = 704> >> Change colour of italic characters to B<< C<Pt> >>
1476 B<< C<Ps = 705> >> Change background pixmap tint colour to B<< C<Pt> >>
1477 B<< C<Ps = 710> >> Set normal fontset to B<< C<Pt> >>. Same as C<Ps = 50>.
1478 B<< C<Ps = 711> >> Set bold fontset to B<< C<Pt> >>. Similar to C<Ps = 50>.
1479 B<< C<Ps = 712> >> Set italic fontset to B<< C<Pt> >>. Similar to C<Ps = 50>.
1480 B<< C<Ps = 713> >> Set bold-italic fontset to B<< C<Pt> >>. Similar to C<Ps = 50>.
733 1481
734=end table 1482=end table
735 1483
736=back 1484=back
737 1485
947 1695
948As a convenience for the many Emacs-type editors, I<action> may start 1696As a convenience for the many Emacs-type editors, I<action> may start
949with B<M-> (eg, B<M-$> is equivalent to B<\E$>) and a B<CR> will be 1697with B<M-> (eg, B<M-$> is equivalent to B<\E$>) and a B<CR> will be
950appended if missed from B<M-x> commands. 1698appended if missed from B<M-x> commands.
951 1699
952As a convenience for issuing XTerm B<ESC]> sequences from a menubar (or 1700As a convenience for issuing XTerm B<ESC ]> sequences from a menubar (or
953quick arrow), a B<BEL> (B<^G>) will be appended if needed. 1701quick arrow), a B<BEL> (B<^G>) will be appended if needed.
954 1702
955=over 4 1703=over 4
956 1704
957=item For example, 1705=item For example,
1390 XK_KP_8 8 ESC O x 2138 XK_KP_8 8 ESC O x
1391 XK_KP_9 9 ESC O y 2139 XK_KP_9 9 ESC O y
1392 2140
1393=end table 2141=end table
1394 2142
2143=head1 CONFIGURE OPTIONS
2144
2145General hint: if you get compile errors, then likely your configuration
2146hasn't been tested well. Either try with --enable-everything or use the
2147./reconf script as a base for experiments. ./reconf is used by myself,
2148so it should generally be a working config. Of course, you should always
2149report when a combination doesn't work, so it can be fixed. Marc Lehmann
2150<rxvt@schmorp.de>.
2151
2152=over 4
2153
2154=item --enable-everything
2155
2156Add support for all non-multichoice options listed in "./configure
2157--help". Note that unlike other enable options this is order dependant.
2158You can specify this and then disable options which this enables by
2159I<following> this with the appropriate commands.
2160
2161=item --enable-xft
2162
2163Add support for Xft (anti-aliases, among others) fonts. Xft fonts are
2164slower and require lots of memory, but as long as you don't use them, you
2165don't pay for them.
2166
2167=item --enable-font-styles
2168
2169Add support for B<bold>, I<italic> and B<< I<bold italic> >> font
2170styles. The fonts can be set manually or automatically.
2171
2172=item --with-codesets=NAME,...
2173
2174Compile in support for additional codeset (encoding) groups (eu, vn are
2175always compiled in, which includes most 8-bit character sets). These
2176codeset tables are currently only used for driving X11 core fonts, they
2177are not required for Xft fonts. Compiling them in will make your binary
2178bigger (together about 700kB), but it doesn't increase memory usage unless
2179you use an X11 font requiring one of these encodings.
2180
2181=begin table
2182
2183 all all available codeset groups
2184 zh common chinese encodings
2185 zh_ext rarely used but very big chinese encodigs
2186 jp common japanese encodings
2187 jp_ext rarely used but big japanese encodings
2188 kr korean encodings
2189
2190=end table
2191
2192=item --enable-xim
2193
2194Add support for XIM (X Input Method) protocol. This allows using
2195alternative input methods (e.g. kinput2) and will also correctly
2196set up the input for people using dead keys or compose keys.
2197
2198=item --enable-unicode3
2199
2200Enable direct support for displaying unicode codepoints above
220165535 (the basic multilingual page). This increases storage
2202requirements per character from 2 to 4 bytes. X11 fonts do not yet
2203support these extra characters, but Xft does.
2204
2205Please note that rxvt-unicode can store unicode code points >65535
2206even without this flag, but the number of such characters is
2207limited to a view thousand (shared with combining characters,
2208see next switch), and right now rxvt-unicode cannot display them
2209(input/output and cut&paste still work, though).
2210
2211=item --enable-combining
2212
2213Enable automatic composition of combining characters into
2214composite characters. This is required for proper viewing of text
2215where accents are encoded as seperate unicode characters. This is
2216done by using precomposited characters when available or creating
2217new pseudo-characters when no precomposed form exists.
2218
2219Without --enable-unicode3, the number of additional precomposed
2220characters is rather limited (2048, if this is full, rxvt will use the
2221private use area, extending the number of combinations to 8448). With
2222--enable-unicode3, no practical limit exists. This will also enable
2223storage of characters >65535.
2224
2225The combining table also contains entries for arabic presentation forms,
2226but these are not currently used. Bug me if you want these to be used.
2227
2228=item --enable-fallback(=CLASS)
2229
2230When reading resource settings, also read settings for class CLASS
2231(default: Rxvt). To disable resource fallback use --disable-fallback.
2232
2233=item --with-res-name=NAME
2234
2235Use the given name (default: urxvt) as default application name when
2236reading resources. Specify --with-res-name=rxvt to replace rxvt.
2237
2238=item --with-res-class=CLASS
2239
2240Use the given class (default: URxvt) as default application class
2241when reading resources. Specify --with-res-class=Rxvt to replace
2242rxvt.
2243
2244=item --enable-utmp
2245
2246Write user and tty to utmp file (used by programs like F<w>) at
2247start of rxvt execution and delete information when rxvt exits.
2248
2249=item --enable-wtmp
2250
2251Write user and tty to wtmp file (used by programs like F<last>) at
2252start of rxvt execution and write logout when rxvt exits. This
2253option requires --enable-utmp to also be specified.
2254
2255=item --enable-lastlog
2256
2257Write user and tty to lastlog file (used by programs like
2258F<lastlogin>) at start of rxvt execution. This option requires
2259--enable-utmp to also be specified.
2260
2261=item --enable-xpm-background
2262
2263Add support for XPM background pixmaps.
2264
2265=item --enable-transparency
2266
2267Add support for inheriting parent backgrounds thus giving a fake
2268transparency to the term.
2269
2270=item --enable-fading
2271
2272Add support for fading the text when focus is lost.
2273
2274=item --enable-tinting
2275
2276Add support for tinting of transparent backgrounds.
2277
2278=item --enable-menubar
2279
2280Add support for our menu bar system (this interacts badly with
2281dynamic locale switching currently).
2282
2283=item --enable-rxvt-scroll
2284
2285Add support for the original rxvt scrollbar.
2286
2287=item --enable-next-scroll
2288
2289Add support for a NeXT-like scrollbar.
2290
2291=item --enable-xterm-scroll
2292
2293Add support for an Xterm-like scrollbar.
2294
2295=item --enable-plain-scroll
2296
2297Add support for a very unobtrusive, plain-looking scrollbar that
2298is the favourite of the rxvt-unicode author, having used it for
2299many years.
2300
2301=item --enable-half-shadow
2302
2303Make shadows on the scrollbar only half the normal width & height.
2304only applicable to rxvt scrollbars.
2305
2306=item --enable-ttygid
2307
2308Change tty device setting to group "tty" - only use this if
2309your system uses this type of security.
2310
2311=item --disable-backspace-key
2312
2313Disable any handling of the backspace key by us - let the X server
2314do it.
2315
2316=item --disable-delete-key
2317
2318Disable any handling of the delete key by us - let the X server
2319do it.
2320
2321=item --disable-resources
2322
2323Remove all resources checking.
2324
2325=item --enable-xgetdefault
2326
2327Make resources checking via XGetDefault() instead of our small
2328version which only checks ~/.Xdefaults, or if that doesn't exist then
2329~/.Xresources.
2330
2331Please note that nowadays, things like XIM will automatically pull in and
2332use the full X resource manager, so the overhead of using it might be very
2333small, if nonexistant.
2334
2335=item --enable-strings
2336
2337Add support for our possibly faster memset() function and other
2338various routines, overriding your system's versions which may
2339have been hand-crafted in assembly or may require extra libraries
2340to link in. (this breaks ANSI-C rules and has problems on many
2341GNU/Linux systems).
2342
2343=item --disable-swapscreen
2344
2345Remove support for swap screen.
2346
2347=item --enable-frills
2348
2349Add support for many small features that are not essential but nice to
2350have. Normally you want this, but for very small binaries you may want to
2351disable this.
2352
2353A non-exhaustive list of features enabled by C<--enable-frills> (possibly
2354in combination with other switches) is:
2355
2356 MWM-hints
2357 seperate underline colour
2358 settable border widths and borderless switch
2359 settable extra linespacing
2360 extra window properties (e.g. UTF-8 window names and PID)
2361 iso-14755-2 and -3, and visual feedback
2362 backindex and forwardindex escape sequence
2363 window op and locale change escape sequences
2364 tripleclickwords
2365 settable insecure mode
2366 keysym remapping support
2367
2368=item --enable-iso14755
2369
2370Enable extended ISO 14755 support (see @@RXVT_NAME@@(1), or
2371F<doc/rxvt.1.txt>). Basic support (section 5.1) is enabled by
2372C<--enable-frills>, while support for 5.2, 5.3 and 5.4 is enabled with
2373this switch.
2374
2375=item --enable-keepscrolling
2376
2377Add support for continual scrolling of the display when you hold
2378the mouse button down on a scrollbar arrow.
2379
2380=item --enable-mousewheel
2381
2382Add support for scrolling via mouse wheel or buttons 4 & 5.
2383
2384=item --enable-slipwheeling
2385
2386Add support for continual scrolling (using the mouse wheel as an
2387accelerator) while the control key is held down. This option
2388requires --enable-mousewheel to also be specified.
2389
2390=item --disable-new-selection
2391
2392Remove support for mouse selection style like that of xterm.
2393
2394=item --enable-dmalloc
2395
2396Use Gray Watson's malloc - which is good for debugging See
2397http://www.letters.com/dmalloc/ for details If you use either this or the
2398next option, you may need to edit src/Makefile after compiling to point
2399DINCLUDE and DLIB to the right places.
2400
2401You can only use either this option and the following (should
2402you use either) .
2403
2404=item --enable-dlmalloc
2405
2406Use Doug Lea's malloc - which is good for a production version
2407See L<http://g.oswego.edu/dl/html/malloc.html> for details.
2408
2409=item --enable-smart-resize
2410
2411Add smart growth/shrink behaviour when changing font size via from hot
2412keys. This should keep in a fixed position the rxvt corner which is
2413closest to a corner of the screen.
2414
2415=item --enable-cursor-blink
2416
2417Add support for a blinking cursor.
2418
2419=item --enable-pointer-blank
2420
2421Add support to have the pointer disappear when typing or inactive.
2422
2423=item --with-name=NAME
2424
2425Set the basename for the installed binaries (default: C<urxvt>, resulting
2426in C<urxvt>, C<urxvtd> etc.). Specify C<--with-name=rxvt> to replace with
2427C<rxvt>.
2428
2429=item --with-term=NAME
2430
2431Change the environmental variable for the terminal to NAME (default
2432C<rxvt-unicode>)
2433
2434=item --with-terminfo=PATH
2435
2436Change the environmental variable for the path to the terminfo tree to
2437PATH.
2438
2439=item --with-x
2440
2441Use the X Window System (pretty much default, eh?).
2442
2443=item --with-xpm-includes=DIR
2444
2445Look for the XPM includes in DIR.
2446
2447=item --with-xpm-library=DIR
2448
2449Look for the XPM library in DIR.
2450
2451=item --with-xpm
2452
2453Not needed - define via --enable-xpm-background.
2454
2455=back
2456
1395=head1 AUTHORS 2457=head1 AUTHORS
1396 2458
1397Marc Lehmann <rxvt@schmorp.de> converted this document to pod and 2459Marc Lehmann <rxvt@schmorp.de> converted this document to pod and
1398reworked it from the original Rxvt documentation, which was done by Geoff 2460reworked it from the original Rxvt documentation, which was done by Geoff
1399Wing <gcw@pobox.com>, who in turn used the XTerm documentation and other 2461Wing <gcw@pobox.com>, who in turn used the XTerm documentation and other

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines