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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines