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.1 by root, Thu Aug 12 20:42:12 2004 UTC vs.
Revision 1.45 by root, Sun Feb 13 11:07:57 2005 UTC

1=head1 Rxvt Technical Reference 1=head1 NAME
2 2
3Marc Lehmann <rxvt@schmorp.de>, converted to pod and reworked from the 3RXVT REFERENCE - FAQ, command sequences and other background information
4original Rxvt documentation by Geoff Wing <gcw@pobox.com>, who in turn used 4
5the XTerm documentation and other sources. 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 crashes when the X Input Method changes or exits.
427
428Unfortunately, this is unavoidable, as the XIM protocol is racy by
429design. Applications can avoid some crashes at the expense of memory
430leaks, and Input Methods can avoid some crashes by careful ordering at
431exit time. B<kinput2> (and derived input methods) generally succeeds,
432while B<SCIM> (or similar input methods) fails. In the end, however,
433crashes cannot be completely avoided even if both sides cooperate.
434
435So the only workaround is not to kill your Input Method Servers.
436
437=item Rxvt-unicode uses gobs of memory, how can I reduce that?
438
439Rxvt-unicode tries to obey the rule of not charging you for something you
440don't use. One thing you should try is to configure out all settings that
441you don't need, for example, Xft support is a resource hog by design,
442when used. Compiling it out ensures that no Xft font will be loaded
443accidentally when rxvt-unicode tries to find a font for your characters.
444
445Also, many people (me included) like large windows and even larger
446scrollback buffers: Without C<--enable-unicode3>, rxvt-unicode will use
4476 bytes per screen cell. For a 160x?? window this amounts to almost a
448kilobyte per line. A scrollback buffer of 10000 lines will then (if full)
449use 10 Megabytes of memory. With C<--enable-unicode3> it gets worse, as
450rxvt-unicode then uses 8 bytes per screen cell.
451
452=item Can I speed up Xft rendering somehow?
453
454Yes, the most obvious way to speed it up is to avoid Xft entirely, as
455it is simply slow. If you still want Xft fonts you might try to disable
456antialiasing (by appending C<:antialiasing=false>), which saves lots of
457memory and also speeds up rendering considerably.
458
459=item Rxvt-unicode doesn't seem to anti-alias its fonts, what is wrong?
460
461Rxvt-unicode will use whatever you specify as a font. If it needs to
462fall back to it's default font search list it will prefer X11 core
463fonts, because they are small and fast, and then use Xft fonts. It has
464antialiasing disabled for most of them, because the author thinks they
465look best that way.
466
467If you want antialiasing, you have to specify the fonts manually.
468
469=item Mouse cut/paste suddenly no longer works.
470
471Make sure that mouse reporting is actually turned off since killing
472some editors prematurely may leave the mouse in mouse report mode. I've
473heard that tcsh may use mouse reporting unless it otherwise specified. A
474quick check is to see if cut/paste works when the Alt or Shift keys are
475depressed. See @@RXVT_NAME@@(7)
476
477=item What's with this bold/blink stuff?
478
479If no bold colour is set via C<colorBD:>, bold will invert text using the
480standard foreground colour.
481
482For the standard background colour, blinking will actually make the
483text blink when compiled with C<--enable-blinking>. with standard
484colours. Without C<--enable-blinking>, the blink attribute will be
485ignored.
486
487On ANSI colours, bold/blink attributes are used to set high-intensity
488foreground/background colors.
489
490color0-7 are the low-intensity colors.
491
492color8-15 are the corresponding high-intensity colors.
493
494=item I don't like the screen colors. How do I change them?
495
496You can change the screen colors at run-time using F<~/.Xdefaults>
497resources (or as long-options).
498
499Here are values that are supposed to resemble a VGA screen,
500including the murky brown that passes for low-intensity yellow:
501
502 URxvt.color0: #000000
503 URxvt.color1: #A80000
504 URxvt.color2: #00A800
505 URxvt.color3: #A8A800
506 URxvt.color4: #0000A8
507 URxvt.color5: #A800A8
508 URxvt.color6: #00A8A8
509 URxvt.color7: #A8A8A8
510
511 URxvt.color8: #000054
512 URxvt.color9: #FF0054
513 URxvt.color10: #00FF54
514 URxvt.color11: #FFFF54
515 URxvt.color12: #0000FF
516 URxvt.color13: #FF00FF
517 URxvt.color14: #00FFFF
518 URxvt.color15: #FFFFFF
519
520And here is a more complete set of non-standard colors described (not by
521me) as "pretty girly".
522
523 URxvt.cursorColor: #dc74d1
524 URxvt.pointerColor: #dc74d1
525 URxvt.background: #0e0e0e
526 URxvt.foreground: #4ad5e1
527 URxvt.color0: #000000
528 URxvt.color8: #8b8f93
529 URxvt.color1: #dc74d1
530 URxvt.color9: #dc74d1
531 URxvt.color2: #0eb8c7
532 URxvt.color10: #0eb8c7
533 URxvt.color3: #dfe37e
534 URxvt.color11: #dfe37e
535 URxvt.color5: #9e88f0
536 URxvt.color13: #9e88f0
537 URxvt.color6: #73f7ff
538 URxvt.color14: #73f7ff
539 URxvt.color7: #e1dddd
540 URxvt.color15: #e1dddd
541
542=item How can I start @@RXVT_NAME@@d in a race-free way?
543
544Despite it's name, @@RXVT_NAME@@d is not a real daemon, but more like a
545server that answers @@RXVT_NAME@@c's requests, so it doesn't background
546itself.
547
548To ensure @@RXVT_NAME@@d is listening on it's socket, you can use the
549following method to wait for the startup message before continuing:
550
551 { @@RXVT_NAME@@d & } | read
552
553=item What's with the strange Backspace/Delete key behaviour?
554
555Assuming that the physical Backspace key corresponds to the
556BackSpace keysym (not likely for Linux ... see the following
557question) there are two standard values that can be used for
558Backspace: C<^H> and C<^?>.
559
560Historically, either value is correct, but rxvt-unicode adopts the debian
561policy of using C<^?> when unsure, because it's the one only only correct
562choice :).
563
564Rxvt-unicode tries to inherit the current stty settings and uses the value
565of `erase' to guess the value for backspace. If rxvt-unicode wasn't
566started from a terminal (say, from a menu or by remote shell), then the
567system value of `erase', which corresponds to CERASE in <termios.h>, will
568be used (which may not be the same as your stty setting).
569
570For starting a new rxvt-unicode:
571
572 # use Backspace = ^H
573 $ stty erase ^H
574 $ @@RXVT_NAME@@
575
576 # use Backspace = ^?
577 $ stty erase ^?
578 $ @@RXVT_NAME@@
579
580Toggle with C<ESC [ 36 h> / C<ESC [ 36 l> as documented in @@RXVT_NAME@@(7).
581
582For an existing rxvt-unicode:
583
584 # use Backspace = ^H
585 $ stty erase ^H
586 $ echo -n "^[[36h"
587
588 # use Backspace = ^?
589 $ stty erase ^?
590 $ echo -n "^[[36l"
591
592This helps satisfy some of the Backspace discrepancies that occur, but
593if you use Backspace = C<^H>, make sure that the termcap/terminfo value
594properly reflects that.
595
596The Delete key is a another casualty of the ill-defined Backspace problem.
597To avoid confusion between the Backspace and Delete keys, the Delete
598key has been assigned an escape sequence to match the vt100 for Execute
599(C<ESC [ 3 ~>) and is in the supplied termcap/terminfo.
600
601Some other Backspace problems:
602
603some editors use termcap/terminfo,
604some editors (vim I'm told) expect Backspace = ^H,
605GNU Emacs (and Emacs-like editors) use ^H for help.
606
607Perhaps someday this will all be resolved in a consistent manner.
608
609=item I don't like the key-bindings. How do I change them?
610
611There are some compile-time selections available via configure. Unless
612you have run "configure" with the C<--disable-resources> option you can
613use the `keysym' resource to alter the keystrings associated with keysyms.
614
615Here's an example for a URxvt session started using C<@@RXVT_NAME@@ -name URxvt>
616
617 URxvt.keysym.Home: \033[1~
618 URxvt.keysym.End: \033[4~
619 URxvt.keysym.C-apostrophe: \033<C-'>
620 URxvt.keysym.C-slash: \033<C-/>
621 URxvt.keysym.C-semicolon: \033<C-;>
622 URxvt.keysym.C-grave: \033<C-`>
623 URxvt.keysym.C-comma: \033<C-,>
624 URxvt.keysym.C-period: \033<C-.>
625 URxvt.keysym.C-0x60: \033<C-`>
626 URxvt.keysym.C-Tab: \033<C-Tab>
627 URxvt.keysym.C-Return: \033<C-Return>
628 URxvt.keysym.S-Return: \033<S-Return>
629 URxvt.keysym.S-space: \033<S-Space>
630 URxvt.keysym.M-Up: \033<M-Up>
631 URxvt.keysym.M-Down: \033<M-Down>
632 URxvt.keysym.M-Left: \033<M-Left>
633 URxvt.keysym.M-Right: \033<M-Right>
634 URxvt.keysym.M-C-0: list \033<M-C- 0123456789 >
635 URxvt.keysym.M-C-a: list \033<M-C- abcdefghijklmnopqrstuvwxyz >
636 URxvt.keysym.F12: command:\033]701;zh_CN.GBK\007
637
638See some more examples in the documentation for the B<keysym> resource.
639
640=item I'm using keyboard model XXX that has extra Prior/Next/Insert keys.
641How do I make use of them? For example, the Sun Keyboard type 4
642has the following mappings that rxvt-unicode doesn't recognize.
643
644 KP_Insert == Insert
645 F22 == Print
646 F27 == Home
647 F29 == Prior
648 F33 == End
649 F35 == Next
650
651Rather than have rxvt-unicode try to accommodate all the various possible
652keyboard mappings, it is better to use `xmodmap' to remap the keys as
653required for your particular machine.
654
655=item How do I distinguish wether I'm running rxvt-unicode or a regular xterm?
656I need this to decide about setting colors etc.
657
658rxvt and rxvt-unicode always export the variable "COLORTERM", so you can
659check and see if that is set. Note that several programs, JED, slrn,
660Midnight Commander automatically check this variable to decide whether or
661not to use color.
662
663=item How do I set the correct, full IP address for the DISPLAY variable?
664
665If you've compiled rxvt-unicode with DISPLAY_IS_IP and have enabled
666insecure mode then it is possible to use the following shell script
667snippets to correctly set the display. If your version of rxvt-unicode
668wasn't also compiled with ESCZ_ANSWER (as assumed in these snippets) then
669the COLORTERM variable can be used to distinguish rxvt-unicode from a
670regular xterm.
671
672Courtesy of Chuck Blake <cblake@BBN.COM> with the following shell script
673snippets:
674
675 # Bourne/Korn/POSIX family of shells:
676 [ ${TERM:-foo} = foo ] && TERM=xterm # assume an xterm if we don't know
677 if [ ${TERM:-foo} = xterm ]; then
678 stty -icanon -echo min 0 time 15 # see if enhanced rxvt or not
679 echo -n '^[Z'
680 read term_id
681 stty icanon echo
682 if [ ""${term_id} = '^[[?1;2C' -a ${DISPLAY:-foo} = foo ]; then
683 echo -n '^[[7n' # query the rxvt we are in for the DISPLAY string
684 read DISPLAY # set it in our local shell
685 fi
686 fi
687
688=item How do I compile the manual pages for myself?
689
690You need to have a recent version of perl installed as F</usr/bin/perl>,
691one that comes with F<pod2man>, F<pod2text> and F<pod2html>. Then go to
692the doc subdirectory and enter C<make alldoc>.
693
694=item My question isn't answered here, can I ask a human?
695
696Before sending me mail, you could go to IRC: C<irc.freenode.net>,
697channel C<#rxvt-unicode> has some rxvt-unicode enthusiasts that might be
698interested in learning about new and exciting problems (but not FAQs :).
699
700=back
701
702=head1 RXVT TECHNICAL REFERENCE
703
704=head1 DESCRIPTION
705
706The rest of this document describes various technical aspects of
707B<rxvt-unicode>. First the description of supported command sequences,
708followed by menu and pixmap support and last by a description of all
709features selectable at C<configure> time.
6 710
7=head1 Definitions 711=head1 Definitions
8 712
9=over 4 713=over 4
10 714
37=over 4 741=over 4
38 742
39=item B<< C<ENQ> >> 743=item B<< C<ENQ> >>
40 744
41Enquiry (Ctrl-E) = Send Device Attributes (DA) 745Enquiry (Ctrl-E) = Send Device Attributes (DA)
42request attributes from terminal == 746request attributes from terminal. See B<< C<ESC [ Ps c> >>.
43 747
44=item B<< C<BEL> >> 748=item B<< C<BEL> >>
45 749
46Bell (Ctrl-G) 750Bell (Ctrl-G)
47 751
139Single Shift Select of G3 Character Set (SS3): affects next character 843Single Shift Select of G3 Character Set (SS3): affects next character
140only I<unimplemented> 844only I<unimplemented>
141 845
142=item B<< C<ESC Z> >> 846=item B<< C<ESC Z> >>
143 847
144Obsolete form of returns: B<< C<ESC[?1;2C> >> I<rxvt compile-time option> 848Obsolete form of returns: B<< C<ESC [ ? 1 ; 2 C> >> I<rxvt-unicode compile-time option>
145 849
146=item B<< C<ESC c> >> 850=item B<< C<ESC c> >>
147 851
148Full reset (RIS) 852Full reset (RIS)
149 853
153 857
154=item B<< C<ESC o> >> 858=item B<< C<ESC o> >>
155 859
156Invoke the G3 Character Set (LS3) 860Invoke the G3 Character Set (LS3)
157 861
158=item B<< C<ESC>(C<C> >> 862=item B<< C<ESC ( C> >>
159 863
160Designate G0 Character Set (ISO 2022), see below for values of C<C>. 864Designate G0 Character Set (ISO 2022), see below for values of C<C>.
161 865
162=item B<< C<ESC>)C<C> >> 866=item B<< C<ESC ) C> >>
163 867
164Designate G1 Character Set (ISO 2022), see below for values of C<C>. 868Designate G1 Character Set (ISO 2022), see below for values of C<C>.
165 869
166=item B<< C<ESC * C> >> 870=item B<< C<ESC * C> >>
167 871
191 895
192=back 896=back
193 897
194X<CSI> 898X<CSI>
195 899
196=head1 CSI (Code Sequence Introducer) Sequences 900=head1 CSI (Command Sequence Introducer) Sequences
197 901
198=over 4 902=over 4
199 903
200=item B<< C<ESC [ Ps @> >> 904=item B<< C<ESC [ Ps @> >>
201 905
298 1002
299Move backward B<< C<Ps> >> [default: 1] tab stops 1003Move backward B<< C<Ps> >> [default: 1] tab stops
300 1004
301=item B<< C<ESC [ Ps '> >> 1005=item B<< C<ESC [ Ps '> >>
302 1006
303== 1007See B<< C<ESC [ Ps G> >>
304 1008
305=item B<< C<ESC [ Ps a> >> 1009=item B<< C<ESC [ Ps a> >>
306 1010
307==X<ESCOBPsc> 1011See B<< C<ESC [ Ps C> >>
308 1012
309=item B<< C<ESC [ Ps c> >> 1013=item B<< C<ESC [ Ps c> >>
310 1014
311Send Device Attributes (DA) 1015Send Device Attributes (DA)
312B<< C<Ps = 0> >> (or omitted): request attributes from terminal 1016B<< C<Ps = 0> >> (or omitted): request attributes from terminal
313returns: B<< C<ESC[?1;2c> >> (``I am a VT100 with Advanced Video 1017returns: B<< C<ESC [ ? 1 ; 2 c> >> (``I am a VT100 with Advanced Video
314Option'') 1018Option'')
315 1019
316=item B<< C<ESC [ Ps d> >> 1020=item B<< C<ESC [ Ps d> >>
317 1021
318Cursor to Line B<< C<Ps> >> (VPA) 1022Cursor to Line B<< C<Ps> >> (VPA)
319 1023
320=item B<< C<ESC [ Ps e> >> 1024=item B<< C<ESC [ Ps e> >>
321 1025
322== 1026See B<< C<ESC [ Ps A> >>
323 1027
324=item B<< C<ESC [ Ps;Ps f> >> 1028=item B<< C<ESC [ Ps;Ps f> >>
325 1029
326Horizontal and Vertical Position [row;column] (HVP) [default: 1;1] 1030Horizontal and Vertical Position [row;column] (HVP) [default: 1;1]
327 1031
334 B<< C<Ps = 0> >> Clear Current Column (default) 1038 B<< C<Ps = 0> >> Clear Current Column (default)
335 B<< C<Ps = 3> >> Clear All (TBC) 1039 B<< C<Ps = 3> >> Clear All (TBC)
336 1040
337=end table 1041=end table
338 1042
1043=item B<< C<ESC [ Pm h> >>
1044
1045Set Mode (SM). See B<< C<ESC [ Pm l> >> sequence for description of C<Pm>.
1046
339=item B<< C<ESC [ Ps i> >> 1047=item B<< C<ESC [ Ps i> >>
340 1048
341Printing 1049Printing. See also the C<print-pipe> resource.
342 1050
343=begin table 1051=begin table
344 1052
1053 B<< C<Ps = 0> >> print screen (MC0)
345 B<< C<Ps = 4> >> disable transparent print mode (MC4) 1054 B<< C<Ps = 4> >> disable transparent print mode (MC4)
346 B<< C<Ps = 5> >> enable transparent print mode (MC5) I<unimplemented> 1055 B<< C<Ps = 5> >> enable transparent print mode (MC5)
347 1056
348=end table 1057=end table
349
350=item B<< C<ESC [ Pm h> >>
351
352Set Mode (SM). See next sequence for description of C<Pm>.
353 1058
354=item B<< C<ESC [ Pm l> >> 1059=item B<< C<ESC [ Pm l> >>
355 1060
356Reset Mode (RM) 1061Reset Mode (RM)
357 1062
364 B<< C<h> >> Insert Mode (SMIR) 1069 B<< C<h> >> Insert Mode (SMIR)
365 B<< C<l> >> Replace Mode (RMIR) 1070 B<< C<l> >> Replace Mode (RMIR)
366 1071
367=end table 1072=end table
368 1073
369=item B<< C<Ps = 20> >> I<unimplemented> 1074=item B<< C<Ps = 20> >> (partially implemented)
370 1075
371=begin table 1076=begin table
372 1077
373 B<< C<h> >> Automatic Newline (LNM) 1078 B<< C<h> >> Automatic Newline (LNM)
374 B<< C<h> >> Normal Linefeed (LNM) 1079 B<< C<l> >> Normal Linefeed (LNM)
375 1080
376=end table 1081=end table
377 1082
378=back 1083=back
379 1084
382Character Attributes (SGR) 1087Character Attributes (SGR)
383 1088
384=begin table 1089=begin table
385 1090
386 B<< C<Ps = 0> >> Normal (default) 1091 B<< C<Ps = 0> >> Normal (default)
387 B<< C<Ps = 1 / 22> >> On / Off Bold (bright fg) 1092 B<< C<Ps = 1 / 21> >> On / Off Bold (bright fg)
1093 B<< C<Ps = 3 / 23> >> On / Off Italic
388 B<< C<Ps = 4 / 24> >> On / Off Underline 1094 B<< C<Ps = 4 / 24> >> On / Off Underline
389 B<< C<Ps = 5 / 25> >> On / Off Blink (bright bg) 1095 B<< C<Ps = 5 / 25> >> On / Off Slow Blink (bright bg)
1096 B<< C<Ps = 6 / 26> >> On / Off Rapid Blink (bright bg)
390 B<< C<Ps = 7 / 27> >> On / Off Inverse 1097 B<< C<Ps = 7 / 27> >> On / Off Inverse
1098 B<< C<Ps = 8 / 27> >> On / Off Invisible (NYI)
391 B<< C<Ps = 30 / 40> >> fg/bg Black 1099 B<< C<Ps = 30 / 40> >> fg/bg Black
392 B<< C<Ps = 31 / 41> >> fg/bg Red 1100 B<< C<Ps = 31 / 41> >> fg/bg Red
393 B<< C<Ps = 32 / 42> >> fg/bg Green 1101 B<< C<Ps = 32 / 42> >> fg/bg Green
394 B<< C<Ps = 33 / 43> >> fg/bg Yellow 1102 B<< C<Ps = 33 / 43> >> fg/bg Yellow
395 B<< C<Ps = 34 / 44> >> fg/bg Blue 1103 B<< C<Ps = 34 / 44> >> fg/bg Blue
396 B<< C<Ps = 35 / 45> >> fg/bg Magenta 1104 B<< C<Ps = 35 / 45> >> fg/bg Magenta
397 B<< C<Ps = 36 / 46> >> fg/bg Cyan 1105 B<< C<Ps = 36 / 46> >> fg/bg Cyan
1106 B<< C<Ps = 38;5 / 48;5> >> set fg/bg to color #m (ISO 8613-6)
398 B<< C<Ps = 37 / 47> >> fg/bg White 1107 B<< C<Ps = 37 / 47> >> fg/bg White
399 B<< C<Ps = 39 / 49> >> fg/bg Default 1108 B<< C<Ps = 39 / 49> >> fg/bg Default
1109 B<< C<Ps = 90 / 100> >> fg/bg Bright Black
1110 B<< C<Ps = 91 / 101> >> fg/bg Bright Red
1111 B<< C<Ps = 92 / 102> >> fg/bg Bright Green
1112 B<< C<Ps = 93 / 103> >> fg/bg Bright Yellow
1113 B<< C<Ps = 94 / 104> >> fg/bg Bright Blue
1114 B<< C<Ps = 95 / 105> >> fg/bg Bright Magenta
1115 B<< C<Ps = 96 / 106> >> fg/bg Bright Cyan
1116 B<< C<Ps = 97 / 107> >> fg/bg Bright White
1117 B<< C<Ps = 99 / 109> >> fg/bg Bright Default
400 1118
401=end table 1119=end table
402 1120
403=item B<< C<ESC [ Ps n> >> 1121=item B<< C<ESC [ Ps n> >>
404 1122
420 1138
421=item B<< C<ESC [ s> >> 1139=item B<< C<ESC [ s> >>
422 1140
423Save Cursor (SC) 1141Save Cursor (SC)
424 1142
1143=item B<< C<ESC [ Ps;Pt t> >>
1144
1145Window Operations
1146
1147=begin table
1148
1149 B<< C<Ps = 1> >> Deiconify (map) window
1150 B<< C<Ps = 2> >> Iconify window
1151 B<< C<Ps = 3> >> B<< C<ESC [ 3 ; X ; Y t> >> Move window to (X|Y)
1152 B<< C<Ps = 4> >> B<< C<ESC [ 4 ; H ; W t> >> Resize to WxH pixels
1153 B<< C<Ps = 5> >> Raise window
1154 B<< C<Ps = 6> >> Lower window
1155 B<< C<Ps = 7> >> Refresh screen once
1156 B<< C<Ps = 8> >> B<< C<ESC [ 8 ; R ; C t> >> Resize to R rows and C columns
1157 B<< C<Ps = 11> >> Report window state (responds with C<Ps = 1> or C<Ps = 2>)
1158 B<< C<Ps = 13> >> Report window position (responds with C<Ps = 3>)
1159 B<< C<Ps = 14> >> Report window pixel size (responds with C<Ps = 4>)
1160 B<< C<Ps = 18> >> Report window text size (responds with C<Ps = 7>)
1161 B<< C<Ps = 19> >> Currently the same as C<Ps = 18>, but responds with C<Ps = 9>
1162 B<< C<Ps = 20> >> Reports icon label (B<< C<ESC ] L NAME \234> >>)
1163 B<< C<Ps = 21> >> Reports window title (B<< C<ESC ] l NAME \234> >>)
1164 B<< C<Ps = 24..> >> Set window height to C<Ps> rows
1165
1166=end table
1167
1168=item B<< C<ESC [ u> >>
1169
1170Restore Cursor
1171
425=item B<< C<ESC [ Ps x> >> 1172=item B<< C<ESC [ Ps x> >>
426 1173
427Request Terminal Parameters (DECREQTPARM) 1174Request Terminal Parameters (DECREQTPARM)
428
429=item B<< C<ESC [ u> >>
430
431Restore Cursor
432 1175
433=back 1176=back
434 1177
435X<PrivateModes> 1178X<PrivateModes>
436 1179
539 B<< C<h> >> Send Mouse X & Y on button press. 1282 B<< C<h> >> Send Mouse X & Y on button press.
540 B<< C<l> >> No mouse reporting. 1283 B<< C<l> >> No mouse reporting.
541 1284
542=end table 1285=end table
543 1286
544)X<Priv10>
545
546=item B<< C<Ps = 10> >> (B<rxvt>) 1287=item B<< C<Ps = 10> >> (B<rxvt>)
547 1288
548=begin table 1289=begin table
549 1290
550 B<< C<h> >> visible 1291 B<< C<h> >> menuBar visible
551 B<< C<l> >> invisible 1292 B<< C<l> >> menuBar invisible
552 1293
553=end table 1294=end table
554 1295
555=item B<< C<Ps = 25> >> 1296=item B<< C<Ps = 25> >>
556 1297
625 1366
626=item B<< C<Ps = 66> >> 1367=item B<< C<Ps = 66> >>
627 1368
628=begin table 1369=begin table
629 1370
630 B<< C<h> >> Application Keypad (DECPAM) == 1371 B<< C<h> >> Application Keypad (DECPAM) == C<ESC =>
631 B<< C<l> >> Normal Keypad (DECPNM) == 1372 B<< C<l> >> Normal Keypad (DECPNM) == C<< ESC > >>
632 1373
633=end table 1374=end table
634 1375
635=item B<< C<Ps = 67> >> 1376=item B<< C<Ps = 67> >>
636 1377
657 B<< C<h> >> Use Hilite Mouse Tracking. 1398 B<< C<h> >> Use Hilite Mouse Tracking.
658 B<< C<l> >> No mouse reporting. 1399 B<< C<l> >> No mouse reporting.
659 1400
660=end table 1401=end table
661 1402
662=item B<< C<Ps = 1010> >> 1403=item B<< C<Ps = 1010> >> (B<rxvt>)
663 1404
664=begin table 1405=begin table
665 1406
666 B<< C<h> >> Don't scroll to bottom on TTY output 1407 B<< C<h> >> Don't scroll to bottom on TTY output
667 B<< C<l> >> Scroll to bottom on TTY output 1408 B<< C<l> >> Scroll to bottom on TTY output
668 1409
669=end table 1410=end table
670 1411
671=item B<< C<Ps = 1011> >> 1412=item B<< C<Ps = 1011> >> (B<rxvt>)
672 1413
673=begin table 1414=begin table
674 1415
675 B<< C<h> >> Scroll to bottom when a key is pressed 1416 B<< C<h> >> Scroll to bottom when a key is pressed
676 B<< C<l> >> Don't scroll to bottom when a key is pressed 1417 B<< C<l> >> Don't scroll to bottom when a key is pressed
690 1431
691=begin table 1432=begin table
692 1433
693 B<< C<h> >> Save cursor position 1434 B<< C<h> >> Save cursor position
694 B<< C<l> >> Restore cursor position 1435 B<< C<l> >> Restore cursor position
1436
1437=end table
1438
1439=item B<< C<Ps = 1049> >>
1440
1441=begin table
1442
1443 B<< C<h> >> Use Alternate Screen Buffer - clear Alternate Screen Buffer if switching to it
1444 B<< C<l> >> Use Normal Screen Buffer
695 1445
696=end table 1446=end table
697 1447
698=back 1448=back
699 1449
729 B<< C<Ps = 39> >> Change default foreground colour to B<< C<Pt> >> I<rxvt compile-time option> 1479 B<< C<Ps = 39> >> Change default foreground colour to B<< C<Pt> >> I<rxvt compile-time option>
730 B<< C<Ps = 46> >> Change Log File to B<< C<Pt> >> I<unimplemented> 1480 B<< C<Ps = 46> >> Change Log File to B<< C<Pt> >> I<unimplemented>
731 B<< C<Ps = 49> >> Change default background colour to B<< C<Pt> >> I<rxvt compile-time option> 1481 B<< C<Ps = 49> >> Change default background colour to B<< C<Pt> >> I<rxvt compile-time option>
732 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> >> 1482 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> >>
733 B<< C<Ps = 55> >> Log all scrollback buffer and all of screen to B<< C<Pt> >> 1483 B<< C<Ps = 55> >> Log all scrollback buffer and all of screen to B<< C<Pt> >>
734 B<< C<Ps = 701> >> Change current locale to B<< C<Pt> >>, or, if B<< C<Pt> >> is B<< C<?> >>, return the current locale (@@RXVTNAME@@ extension) 1484 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)
735 B<< C<Ps = 702> >> find font for character, used for debugging (@@RXVTNAME@@ extension)
736 B<< C<Ps = 703> >> command B<< C<Pt> >> I<rxvt compile-time option> (@@RXVTNAME@@ extension) 1485 B<< C<Ps = 703> >> Menubar command B<< C<Pt> >> I<rxvt compile-time option> (rxvt-unicode extension)
1486 B<< C<Ps = 704> >> Change colour of italic characters to B<< C<Pt> >>
1487 B<< C<Ps = 705> >> Change background pixmap tint colour to B<< C<Pt> >>
1488 B<< C<Ps = 710> >> Set normal fontset to B<< C<Pt> >>. Same as C<Ps = 50>.
1489 B<< C<Ps = 711> >> Set bold fontset to B<< C<Pt> >>. Similar to C<Ps = 50>.
1490 B<< C<Ps = 712> >> Set italic fontset to B<< C<Pt> >>. Similar to C<Ps = 50>.
1491 B<< C<Ps = 713> >> Set bold-italic fontset to B<< C<Pt> >>. Similar to C<Ps = 50>.
737 1492
738=end table 1493=end table
739 1494
740=back 1495=back
741 1496
951 1706
952As a convenience for the many Emacs-type editors, I<action> may start 1707As a convenience for the many Emacs-type editors, I<action> may start
953with B<M-> (eg, B<M-$> is equivalent to B<\E$>) and a B<CR> will be 1708with B<M-> (eg, B<M-$> is equivalent to B<\E$>) and a B<CR> will be
954appended if missed from B<M-x> commands. 1709appended if missed from B<M-x> commands.
955 1710
956As a convenience for issuing XTerm B<ESC]> sequences from a menubar (or 1711As a convenience for issuing XTerm B<ESC ]> sequences from a menubar (or
957quick arrow), a B<BEL> (B<^G>) will be appended if needed. 1712quick arrow), a B<BEL> (B<^G>) will be appended if needed.
958 1713
959=over 4 1714=over 4
960 1715
961=item For example, 1716=item For example,
1320 2075
1321Row = B<< C<< <y> - SPACE >> >> 2076Row = B<< C<< <y> - SPACE >> >>
1322 2077
1323=back 2078=back
1324X<KeyCodes> 2079X<KeyCodes>
1325
1326=head1 ISO 14755 support
1327
1328Partial ISO 14755-support is implemented. that means that pressing
1329
1330section 5.1: Control and Shift together enters unicode input
1331mode. Entering hex digits composes a Unicode character, pressing space or
1332releasing the modifiers commits the keycode and every other key cancels
1333the current input character.
1334
1335section 5.2: Pressing and immediately releasing Control and Shift together
1336enters keycap entry mode for the next key: pressing a function key (tab,
1337return etc..) will enter the unicode character corresponding to the given
1338key.
1339 2080
1340=head1 Key Codes 2081=head1 Key Codes
1341 2082
1342Note: B<Shift> + B<F1>-B<F10> generates B<F11>-B<F20> 2083Note: B<Shift> + B<F1>-B<F10> generates B<F11>-B<F20>
1343 2084
1408 XK_KP_8 8 ESC O x 2149 XK_KP_8 8 ESC O x
1409 XK_KP_9 9 ESC O y 2150 XK_KP_9 9 ESC O y
1410 2151
1411=end table 2152=end table
1412 2153
2154=head1 CONFIGURE OPTIONS
2155
2156General hint: if you get compile errors, then likely your configuration
2157hasn't been tested well. Either try with --enable-everything or use the
2158./reconf script as a base for experiments. ./reconf is used by myself,
2159so it should generally be a working config. Of course, you should always
2160report when a combination doesn't work, so it can be fixed. Marc Lehmann
2161<rxvt@schmorp.de>.
2162
2163=over 4
2164
2165=item --enable-everything
2166
2167Add support for all non-multichoice options listed in "./configure
2168--help". Note that unlike other enable options this is order dependant.
2169You can specify this and then disable options which this enables by
2170I<following> this with the appropriate commands.
2171
2172=item --enable-xft
2173
2174Add support for Xft (anti-aliases, among others) fonts. Xft fonts are
2175slower and require lots of memory, but as long as you don't use them, you
2176don't pay for them.
2177
2178=item --enable-font-styles
2179
2180Add support for B<bold>, I<italic> and B<< I<bold italic> >> font
2181styles. The fonts can be set manually or automatically.
2182
2183=item --with-codesets=NAME,...
2184
2185Compile in support for additional codeset (encoding) groups (eu, vn are
2186always compiled in, which includes most 8-bit character sets). These
2187codeset tables are currently only used for driving X11 core fonts, they
2188are not required for Xft fonts. Compiling them in will make your binary
2189bigger (together about 700kB), but it doesn't increase memory usage unless
2190you use an X11 font requiring one of these encodings.
2191
2192=begin table
2193
2194 all all available codeset groups
2195 zh common chinese encodings
2196 zh_ext rarely used but very big chinese encodigs
2197 jp common japanese encodings
2198 jp_ext rarely used but big japanese encodings
2199 kr korean encodings
2200
2201=end table
2202
2203=item --enable-xim
2204
2205Add support for XIM (X Input Method) protocol. This allows using
2206alternative input methods (e.g. kinput2) and will also correctly
2207set up the input for people using dead keys or compose keys.
2208
2209=item --enable-unicode3
2210
2211Enable direct support for displaying unicode codepoints above
221265535 (the basic multilingual page). This increases storage
2213requirements per character from 2 to 4 bytes. X11 fonts do not yet
2214support these extra characters, but Xft does.
2215
2216Please note that rxvt-unicode can store unicode code points >65535
2217even without this flag, but the number of such characters is
2218limited to a view thousand (shared with combining characters,
2219see next switch), and right now rxvt-unicode cannot display them
2220(input/output and cut&paste still work, though).
2221
2222=item --enable-combining
2223
2224Enable automatic composition of combining characters into
2225composite characters. This is required for proper viewing of text
2226where accents are encoded as seperate unicode characters. This is
2227done by using precomposited characters when available or creating
2228new pseudo-characters when no precomposed form exists.
2229
2230Without --enable-unicode3, the number of additional precomposed
2231characters is rather limited (2048, if this is full, rxvt will use the
2232private use area, extending the number of combinations to 8448). With
2233--enable-unicode3, no practical limit exists. This will also enable
2234storage of characters >65535.
2235
2236The combining table also contains entries for arabic presentation forms,
2237but these are not currently used. Bug me if you want these to be used.
2238
2239=item --enable-fallback(=CLASS)
2240
2241When reading resource settings, also read settings for class CLASS
2242(default: Rxvt). To disable resource fallback use --disable-fallback.
2243
2244=item --with-res-name=NAME
2245
2246Use the given name (default: urxvt) as default application name when
2247reading resources. Specify --with-res-name=rxvt to replace rxvt.
2248
2249=item --with-res-class=CLASS
2250
2251Use the given class (default: URxvt) as default application class
2252when reading resources. Specify --with-res-class=Rxvt to replace
2253rxvt.
2254
2255=item --enable-utmp
2256
2257Write user and tty to utmp file (used by programs like F<w>) at
2258start of rxvt execution and delete information when rxvt exits.
2259
2260=item --enable-wtmp
2261
2262Write user and tty to wtmp file (used by programs like F<last>) at
2263start of rxvt execution and write logout when rxvt exits. This
2264option requires --enable-utmp to also be specified.
2265
2266=item --enable-lastlog
2267
2268Write user and tty to lastlog file (used by programs like
2269F<lastlogin>) at start of rxvt execution. This option requires
2270--enable-utmp to also be specified.
2271
2272=item --enable-xpm-background
2273
2274Add support for XPM background pixmaps.
2275
2276=item --enable-transparency
2277
2278Add support for inheriting parent backgrounds thus giving a fake
2279transparency to the term.
2280
2281=item --enable-fading
2282
2283Add support for fading the text when focus is lost.
2284
2285=item --enable-tinting
2286
2287Add support for tinting of transparent backgrounds.
2288
2289=item --enable-menubar
2290
2291Add support for our menu bar system (this interacts badly with
2292dynamic locale switching currently).
2293
2294=item --enable-rxvt-scroll
2295
2296Add support for the original rxvt scrollbar.
2297
2298=item --enable-next-scroll
2299
2300Add support for a NeXT-like scrollbar.
2301
2302=item --enable-xterm-scroll
2303
2304Add support for an Xterm-like scrollbar.
2305
2306=item --enable-plain-scroll
2307
2308Add support for a very unobtrusive, plain-looking scrollbar that
2309is the favourite of the rxvt-unicode author, having used it for
2310many years.
2311
2312=item --enable-half-shadow
2313
2314Make shadows on the scrollbar only half the normal width & height.
2315only applicable to rxvt scrollbars.
2316
2317=item --enable-ttygid
2318
2319Change tty device setting to group "tty" - only use this if
2320your system uses this type of security.
2321
2322=item --disable-backspace-key
2323
2324Disable any handling of the backspace key by us - let the X server
2325do it.
2326
2327=item --disable-delete-key
2328
2329Disable any handling of the delete key by us - let the X server
2330do it.
2331
2332=item --disable-resources
2333
2334Remove all resources checking.
2335
2336=item --enable-xgetdefault
2337
2338Make resources checking via XGetDefault() instead of our small
2339version which only checks ~/.Xdefaults, or if that doesn't exist then
2340~/.Xresources.
2341
2342Please note that nowadays, things like XIM will automatically pull in and
2343use the full X resource manager, so the overhead of using it might be very
2344small, if nonexistant.
2345
2346=item --enable-strings
2347
2348Add support for our possibly faster memset() function and other
2349various routines, overriding your system's versions which may
2350have been hand-crafted in assembly or may require extra libraries
2351to link in. (this breaks ANSI-C rules and has problems on many
2352GNU/Linux systems).
2353
2354=item --disable-swapscreen
2355
2356Remove support for swap screen.
2357
2358=item --enable-frills
2359
2360Add support for many small features that are not essential but nice to
2361have. Normally you want this, but for very small binaries you may want to
2362disable this.
2363
2364A non-exhaustive list of features enabled by C<--enable-frills> (possibly
2365in combination with other switches) is:
2366
2367 MWM-hints
2368 seperate underline colour
2369 settable border widths and borderless switch
2370 settable extra linespacing
2371 extra window properties (e.g. UTF-8 window names and PID)
2372 iso-14755-2 and -3, and visual feedback
2373 backindex and forwardindex escape sequence
2374 window op and locale change escape sequences
2375 tripleclickwords
2376 settable insecure mode
2377 keysym remapping support
2378
2379=item --enable-iso14755
2380
2381Enable extended ISO 14755 support (see @@RXVT_NAME@@(1), or
2382F<doc/rxvt.1.txt>). Basic support (section 5.1) is enabled by
2383C<--enable-frills>, while support for 5.2, 5.3 and 5.4 is enabled with
2384this switch.
2385
2386=item --enable-keepscrolling
2387
2388Add support for continual scrolling of the display when you hold
2389the mouse button down on a scrollbar arrow.
2390
2391=item --enable-mousewheel
2392
2393Add support for scrolling via mouse wheel or buttons 4 & 5.
2394
2395=item --enable-slipwheeling
2396
2397Add support for continual scrolling (using the mouse wheel as an
2398accelerator) while the control key is held down. This option
2399requires --enable-mousewheel to also be specified.
2400
2401=item --disable-new-selection
2402
2403Remove support for mouse selection style like that of xterm.
2404
2405=item --enable-dmalloc
2406
2407Use Gray Watson's malloc - which is good for debugging See
2408http://www.letters.com/dmalloc/ for details If you use either this or the
2409next option, you may need to edit src/Makefile after compiling to point
2410DINCLUDE and DLIB to the right places.
2411
2412You can only use either this option and the following (should
2413you use either) .
2414
2415=item --enable-dlmalloc
2416
2417Use Doug Lea's malloc - which is good for a production version
2418See L<http://g.oswego.edu/dl/html/malloc.html> for details.
2419
2420=item --enable-smart-resize
2421
2422Add smart growth/shrink behaviour when changing font size via from hot
2423keys. This should keep in a fixed position the rxvt corner which is
2424closest to a corner of the screen.
2425
2426=item --enable-cursor-blink
2427
2428Add support for a blinking cursor.
2429
2430=item --enable-pointer-blank
2431
2432Add support to have the pointer disappear when typing or inactive.
2433
2434=item --with-name=NAME
2435
2436Set the basename for the installed binaries (default: C<urxvt>, resulting
2437in C<urxvt>, C<urxvtd> etc.). Specify C<--with-name=rxvt> to replace with
2438C<rxvt>.
2439
2440=item --with-term=NAME
2441
2442Change the environmental variable for the terminal to NAME (default
2443C<rxvt-unicode>)
2444
2445=item --with-terminfo=PATH
2446
2447Change the environmental variable for the path to the terminfo tree to
2448PATH.
2449
2450=item --with-x
2451
2452Use the X Window System (pretty much default, eh?).
2453
2454=item --with-xpm-includes=DIR
2455
2456Look for the XPM includes in DIR.
2457
2458=item --with-xpm-library=DIR
2459
2460Look for the XPM library in DIR.
2461
2462=item --with-xpm
2463
2464Not needed - define via --enable-xpm-background.
2465
2466=back
2467
2468=head1 AUTHORS
2469
2470Marc Lehmann <rxvt@schmorp.de> converted this document to pod and
2471reworked it from the original Rxvt documentation, which was done by Geoff
2472Wing <gcw@pobox.com>, who in turn used the XTerm documentation and other
2473sources.
2474

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines