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

Comparing rxvt-unicode/doc/rxvt.7.pod (file contents):
Revision 1.5 by root, Thu Aug 12 22:29:28 2004 UTC vs.
Revision 1.54 by root, Tue Jun 21 18:25:09 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 On Solaris 9, many line-drawing characters are too wide.
264
265Seems to be a known bug, read
266L<http://nixdoc.net/files/forum/about34198.html>. Some people use the
267following ugly workaround to get non-double-wide-characters working:
268
269 #define wcwidth(x) wcwidth(x) > 1 ? 1 : wcwidth(x)
270
271=item My Compose (Multi_key) key is no longer working.
272
273The most common causes for this are that either your locale is not set
274correctly, or you specified a B<preeditStyle> that is not supported by
275your input method. For example, if you specified B<OverTheSpot> and
276your input method (e.g. the default input method handling Compose keys)
277does not support this (for instance because it is not visual), then
278rxvt-unicode will continue without an input method.
279
280In this case either do not specify a B<preeditStyle> or specify more than
281one pre-edit style, such as B<OverTheSpot,Root,None>.
282
283=item I cannot type C<Ctrl-Shift-2> to get an ASCII NUL character due to ISO 14755
284
285Either try C<Ctrl-2> alone (it often is mapped to ASCII NUL even on
286international keyboards) or simply use ISO 14755 support to your
287advantage, typing <Ctrl-Shift-0> to get a ASCII NUL. This works for other
288codes, too, such as C<Ctrl-Shift-1-d> to type the default telnet escape
289character and so on.
290
291=item How can I keep rxvt-unicode from using reverse video so much?
292
293First of all, make sure you are running with the right terminal settings
294(C<TERM=rxvt-unicode>), which will get rid of most of these effects. Then
295make sure you have specified colours for italic and bold, as otherwise
296rxvt-unicode might use reverse video to simulate the effect:
297
298 URxvt.colorBD: white
299 URxvt.colorIT: green
300
301=item Some programs assume totally weird colours (red instead of blue), how can I fix that?
302
303For some unexplainable reason, some rare programs assume a very weird
304colour palette when confronted with a terminal with more than the standard
3058 colours (rxvt-unicode supports 88). The right fix is, of course, to fix
306these programs not to assume non-ISO colours without very good reasons.
307
308In the meantime, you can either edit your C<rxvt-unicode> terminfo
309definition to only claim 8 colour support or use C<TERM=rxvt>, which will
310fix colours but keep you from using other rxvt-unicode features.
311
312=item I am on FreeBSD and rxvt-unicode does not seem to work at all.
313
314Rxvt-unicode requires the symbol C<__STDC_ISO_10646__> to be defined
315in your compile environment, or an implementation that implements it,
316wether it defines the symbol or not. C<__STDC_ISO_10646__> requires that
317B<wchar_t> is represented as unicode.
318
319As you might have guessed, FreeBSD does neither define this symobl nor
320does it support it. Instead, it uses it's own internal representation of
321B<wchar_t>. This is, of course, completely fine with respect to standards.
322
323However, that means rxvt-unicode only works in C<POSIX>, C<ISO-8859-1> and
324C<UTF-8> locales under FreeBSD (which all use Unicode as B<wchar_t>.
325
326C<__STDC_ISO_10646__> is the only sane way to support multi-language
327apps in an OS, as using a locale-dependent (and non-standardized)
328representation of B<wchar_t> makes it impossible to convert between
329B<wchar_t> (as used by X11 and your applications) and any other encoding
330without implementing OS-specific-wrappers for each and every locale. There
331simply are no APIs to convert B<wchar_t> into anything except the current
332locale encoding.
333
334Some applications (such as the formidable B<mlterm>) work around this
335by carrying their own replacement functions for character set handling
336with them, and either implementing OS-dependent hacks or doing multiple
337conversions (which is slow and unreliable in case the OS implements
338encodings slightly different than the terminal emulator).
339
340The rxvt-unicode author insists that the right way to fix this is in the
341system libraries once and for all, instead of forcing every app to carry
342complete replacements for them :)
343
344=item How does rxvt-unicode determine the encoding to use?
345
346=item Is there an option to switch encodings?
347
348Unlike some other terminals, rxvt-unicode has no encoding switch, and no
349specific "utf-8" mode, such as xterm. In fact, it doesn't even know about
350UTF-8 or any other encodings with respect to terminal I/O.
351
352The reasons is that there exists a perfectly fine mechanism for selecting
353the encoding, doing I/O and (most important) communicating this to all
354applications so everybody agrees on character properties such as width
355and code number. This mechanism is the I<locale>. Applications not using
356that info will have problems (for example, C<xterm> gets the width of
357characters wrong as it uses it's own, locale-independent table under all
358locales).
359
360Rxvt-unicode uses the C<LC_CTYPE> locale category to select encoding. All
361programs doing the same (that is, most) will automatically agree in the
362interpretation of characters.
363
364Unfortunately, there is no system-independent way to select locales, nor
365is there a standard on how locale specifiers will look like.
366
367On most systems, the content of the C<LC_CTYPE> environment variable
368contains an arbitrary string which corresponds to an already-installed
369locale. Common names for locales are C<en_US.UTF-8>, C<de_DE.ISO-8859-15>,
370C<ja_JP.EUC-JP>, i.e. C<language_country.encoding>, but other forms
371(i.e. C<de> or C<german>) are also common.
372
373Rxvt-unicode ignores all other locale categories, and except for
374the encoding, ignores country or language-specific settings,
375i.e. C<de_DE.UTF-8> and C<ja_JP.UTF-8> are the normally same to
376rxvt-unicode.
377
378If you want to use a specific encoding you have to make sure you start
379rxvt-unicode with the correct C<LC_CTYPE> category.
380
381=item Can I switch locales at runtime?
382
383Yes, using an escape sequence. Try something like this, which sets
384rxvt-unicode's idea of C<LC_CTYPE>.
385
386 printf '\e]701;%s\007' ja_JP.SJIS
387
388See also the previous answer.
389
390Sometimes this capability is rather handy when you want to work in
391one locale (e.g. C<de_DE.UTF-8>) but some programs don't support it
392(e.g. UTF-8). For example, I use this script to start C<xjdic>, which
393first switches to a locale supported by xjdic and back later:
394
395 printf '\e]701;%s\007' ja_JP.SJIS
396 xjdic -js
397 printf '\e]701;%s\007' de_DE.UTF-8
398
399You can also use xterm's C<luit> program, which usually works fine, except
400for some locales where character width differs between program- and
401rxvt-unicode-locales.
402
403=item Can I switch the fonts at runtime?
404
405Yes, using an escape sequence. Try something like this, which has the same
406effect as using the C<-fn> switch, and takes effect immediately:
407
408 printf '\e]50;%s\007' "9x15bold,xft:Kochi Gothic"
409
410This is useful if you e.g. work primarily with japanese (and prefer a
411japanese font), but you have to switch to chinese temporarily, where
412japanese fonts would only be in your way.
413
414You can think of this as a kind of manual ISO-2022 switching.
415
416=item Why do italic characters look as if clipped?
417
418Many fonts have difficulties with italic characters and hinting. For
419example, the otherwise very nicely hinted font C<xft:Bitstream Vera Sans
420Mono> completely fails in it's italic face. A workaround might be to
421enable freetype autohinting, i.e. like this:
422
423 URxvt.italicFont: xft:Bitstream Vera Sans Mono:italic:autohint=true
424 URxvt.boldItalicFont: xft:Bitstream Vera Sans Mono:bold:italic:autohint=true
425
426=item My input method wants <some encoding> but I want UTF-8, what can I do?
427
428You can specify separate locales for the input method and the rest of the
429terminal, using the resource C<imlocale>:
430
431 URxvt*imlocale: ja_JP.EUC-JP
432
433Now you can start your terminal with C<LC_CTYPE=ja_JP.UTF-8> and still
434use your input method. Please note, however, that you will not be able to
435input characters outside C<EUC-JP> in a normal way then, as your input
436method limits you.
437
438=item Rxvt-unicode crashes when the X Input Method changes or exits.
439
440Unfortunately, this is unavoidable, as the XIM protocol is racy by
441design. Applications can avoid some crashes at the expense of memory
442leaks, and Input Methods can avoid some crashes by careful ordering at
443exit time. B<kinput2> (and derived input methods) generally succeeds,
444while B<SCIM> (or similar input methods) fails. In the end, however,
445crashes cannot be completely avoided even if both sides cooperate.
446
447So the only workaround is not to kill your Input Method Servers.
448
449=item Rxvt-unicode uses gobs of memory, how can I reduce that?
450
451Rxvt-unicode tries to obey the rule of not charging you for something you
452don't use. One thing you should try is to configure out all settings that
453you don't need, for example, Xft support is a resource hog by design,
454when used. Compiling it out ensures that no Xft font will be loaded
455accidentally when rxvt-unicode tries to find a font for your characters.
456
457Also, many people (me included) like large windows and even larger
458scrollback buffers: Without C<--enable-unicode3>, rxvt-unicode will use
4596 bytes per screen cell. For a 160x?? window this amounts to almost a
460kilobyte per line. A scrollback buffer of 10000 lines will then (if full)
461use 10 Megabytes of memory. With C<--enable-unicode3> it gets worse, as
462rxvt-unicode then uses 8 bytes per screen cell.
463
464=item Can I speed up Xft rendering somehow?
465
466Yes, the most obvious way to speed it up is to avoid Xft entirely, as
467it is simply slow. If you still want Xft fonts you might try to disable
468antialiasing (by appending C<:antialiasing=false>), which saves lots of
469memory and also speeds up rendering considerably.
470
471=item Rxvt-unicode doesn't seem to anti-alias its fonts, what is wrong?
472
473Rxvt-unicode will use whatever you specify as a font. If it needs to
474fall back to it's default font search list it will prefer X11 core
475fonts, because they are small and fast, and then use Xft fonts. It has
476antialiasing disabled for most of them, because the author thinks they
477look best that way.
478
479If you want antialiasing, you have to specify the fonts manually.
480
481=item Mouse cut/paste suddenly no longer works.
482
483Make sure that mouse reporting is actually turned off since killing
484some editors prematurely may leave the mouse in mouse report mode. I've
485heard that tcsh may use mouse reporting unless it otherwise specified. A
486quick check is to see if cut/paste works when the Alt or Shift keys are
487depressed. See @@RXVT_NAME@@(7)
488
489=item What's with this bold/blink stuff?
490
491If no bold colour is set via C<colorBD:>, bold will invert text using the
492standard foreground colour.
493
494For the standard background colour, blinking will actually make the
495text blink when compiled with C<--enable-blinking>. with standard
496colours. Without C<--enable-blinking>, the blink attribute will be
497ignored.
498
499On ANSI colours, bold/blink attributes are used to set high-intensity
500foreground/background colors.
501
502color0-7 are the low-intensity colors.
503
504color8-15 are the corresponding high-intensity colors.
505
506=item I don't like the screen colors. How do I change them?
507
508You can change the screen colors at run-time using F<~/.Xdefaults>
509resources (or as long-options).
510
511Here are values that are supposed to resemble a VGA screen,
512including the murky brown that passes for low-intensity yellow:
513
514 URxvt.color0: #000000
515 URxvt.color1: #A80000
516 URxvt.color2: #00A800
517 URxvt.color3: #A8A800
518 URxvt.color4: #0000A8
519 URxvt.color5: #A800A8
520 URxvt.color6: #00A8A8
521 URxvt.color7: #A8A8A8
522
523 URxvt.color8: #000054
524 URxvt.color9: #FF0054
525 URxvt.color10: #00FF54
526 URxvt.color11: #FFFF54
527 URxvt.color12: #0000FF
528 URxvt.color13: #FF00FF
529 URxvt.color14: #00FFFF
530 URxvt.color15: #FFFFFF
531
532And here is a more complete set of non-standard colors described (not by
533me) as "pretty girly".
534
535 URxvt.cursorColor: #dc74d1
536 URxvt.pointerColor: #dc74d1
537 URxvt.background: #0e0e0e
538 URxvt.foreground: #4ad5e1
539 URxvt.color0: #000000
540 URxvt.color8: #8b8f93
541 URxvt.color1: #dc74d1
542 URxvt.color9: #dc74d1
543 URxvt.color2: #0eb8c7
544 URxvt.color10: #0eb8c7
545 URxvt.color3: #dfe37e
546 URxvt.color11: #dfe37e
547 URxvt.color5: #9e88f0
548 URxvt.color13: #9e88f0
549 URxvt.color6: #73f7ff
550 URxvt.color14: #73f7ff
551 URxvt.color7: #e1dddd
552 URxvt.color15: #e1dddd
553
554=item How can I start @@RXVT_NAME@@d in a race-free way?
555
556Despite it's name, @@RXVT_NAME@@d is not a real daemon, but more like a
557server that answers @@RXVT_NAME@@c's requests, so it doesn't background
558itself.
559
560To ensure @@RXVT_NAME@@d is listening on it's socket, you can use the
561following method to wait for the startup message before continuing:
562
563 { @@RXVT_NAME@@d & } | read
564
565=item What's with the strange Backspace/Delete key behaviour?
566
567Assuming that the physical Backspace key corresponds to the
568BackSpace keysym (not likely for Linux ... see the following
569question) there are two standard values that can be used for
570Backspace: C<^H> and C<^?>.
571
572Historically, either value is correct, but rxvt-unicode adopts the debian
573policy of using C<^?> when unsure, because it's the one only only correct
574choice :).
575
576Rxvt-unicode tries to inherit the current stty settings and uses the value
577of `erase' to guess the value for backspace. If rxvt-unicode wasn't
578started from a terminal (say, from a menu or by remote shell), then the
579system value of `erase', which corresponds to CERASE in <termios.h>, will
580be used (which may not be the same as your stty setting).
581
582For starting a new rxvt-unicode:
583
584 # use Backspace = ^H
585 $ stty erase ^H
586 $ @@RXVT_NAME@@
587
588 # use Backspace = ^?
589 $ stty erase ^?
590 $ @@RXVT_NAME@@
591
592Toggle with C<ESC [ 36 h> / C<ESC [ 36 l> as documented in @@RXVT_NAME@@(7).
593
594For an existing rxvt-unicode:
595
596 # use Backspace = ^H
597 $ stty erase ^H
598 $ echo -n "^[[36h"
599
600 # use Backspace = ^?
601 $ stty erase ^?
602 $ echo -n "^[[36l"
603
604This helps satisfy some of the Backspace discrepancies that occur, but
605if you use Backspace = C<^H>, make sure that the termcap/terminfo value
606properly reflects that.
607
608The Delete key is a another casualty of the ill-defined Backspace problem.
609To avoid confusion between the Backspace and Delete keys, the Delete
610key has been assigned an escape sequence to match the vt100 for Execute
611(C<ESC [ 3 ~>) and is in the supplied termcap/terminfo.
612
613Some other Backspace problems:
614
615some editors use termcap/terminfo,
616some editors (vim I'm told) expect Backspace = ^H,
617GNU Emacs (and Emacs-like editors) use ^H for help.
618
619Perhaps someday this will all be resolved in a consistent manner.
620
621=item I don't like the key-bindings. How do I change them?
622
623There are some compile-time selections available via configure. Unless
624you have run "configure" with the C<--disable-resources> option you can
625use the `keysym' resource to alter the keystrings associated with keysyms.
626
627Here's an example for a URxvt session started using C<@@RXVT_NAME@@ -name URxvt>
628
629 URxvt.keysym.Home: \033[1~
630 URxvt.keysym.End: \033[4~
631 URxvt.keysym.C-apostrophe: \033<C-'>
632 URxvt.keysym.C-slash: \033<C-/>
633 URxvt.keysym.C-semicolon: \033<C-;>
634 URxvt.keysym.C-grave: \033<C-`>
635 URxvt.keysym.C-comma: \033<C-,>
636 URxvt.keysym.C-period: \033<C-.>
637 URxvt.keysym.C-0x60: \033<C-`>
638 URxvt.keysym.C-Tab: \033<C-Tab>
639 URxvt.keysym.C-Return: \033<C-Return>
640 URxvt.keysym.S-Return: \033<S-Return>
641 URxvt.keysym.S-space: \033<S-Space>
642 URxvt.keysym.M-Up: \033<M-Up>
643 URxvt.keysym.M-Down: \033<M-Down>
644 URxvt.keysym.M-Left: \033<M-Left>
645 URxvt.keysym.M-Right: \033<M-Right>
646 URxvt.keysym.M-C-0: list \033<M-C- 0123456789 >
647 URxvt.keysym.M-C-a: list \033<M-C- abcdefghijklmnopqrstuvwxyz >
648 URxvt.keysym.F12: command:\033]701;zh_CN.GBK\007
649
650See some more examples in the documentation for the B<keysym> resource.
651
652=item I'm using keyboard model XXX that has extra Prior/Next/Insert keys.
653How do I make use of them? For example, the Sun Keyboard type 4
654has the following mappings that rxvt-unicode doesn't recognize.
655
656 KP_Insert == Insert
657 F22 == Print
658 F27 == Home
659 F29 == Prior
660 F33 == End
661 F35 == Next
662
663Rather than have rxvt-unicode try to accommodate all the various possible
664keyboard mappings, it is better to use `xmodmap' to remap the keys as
665required for your particular machine.
666
667=item How do I distinguish wether I'm running rxvt-unicode or a regular xterm?
668I need this to decide about setting colors etc.
669
670rxvt and rxvt-unicode always export the variable "COLORTERM", so you can
671check and see if that is set. Note that several programs, JED, slrn,
672Midnight Commander automatically check this variable to decide whether or
673not to use color.
674
675=item How do I set the correct, full IP address for the DISPLAY variable?
676
677If you've compiled rxvt-unicode with DISPLAY_IS_IP and have enabled
678insecure mode then it is possible to use the following shell script
679snippets to correctly set the display. If your version of rxvt-unicode
680wasn't also compiled with ESCZ_ANSWER (as assumed in these snippets) then
681the COLORTERM variable can be used to distinguish rxvt-unicode from a
682regular xterm.
683
684Courtesy of Chuck Blake <cblake@BBN.COM> with the following shell script
685snippets:
686
687 # Bourne/Korn/POSIX family of shells:
688 [ ${TERM:-foo} = foo ] && TERM=xterm # assume an xterm if we don't know
689 if [ ${TERM:-foo} = xterm ]; then
690 stty -icanon -echo min 0 time 15 # see if enhanced rxvt or not
691 echo -n '^[Z'
692 read term_id
693 stty icanon echo
694 if [ ""${term_id} = '^[[?1;2C' -a ${DISPLAY:-foo} = foo ]; then
695 echo -n '^[[7n' # query the rxvt we are in for the DISPLAY string
696 read DISPLAY # set it in our local shell
697 fi
698 fi
699
700=item How do I compile the manual pages for myself?
701
702You need to have a recent version of perl installed as F</usr/bin/perl>,
703one that comes with F<pod2man>, F<pod2text> and F<pod2html>. Then go to
704the doc subdirectory and enter C<make alldoc>.
705
706=item My question isn't answered here, can I ask a human?
707
708Before sending me mail, you could go to IRC: C<irc.freenode.net>,
709channel C<#rxvt-unicode> has some rxvt-unicode enthusiasts that might be
710interested in learning about new and exciting problems (but not FAQs :).
711
712=back
713
1=head1 RXVT TECHNICAL REFERENCE 714=head1 RXVT TECHNICAL REFERENCE
715
716=head1 DESCRIPTION
717
718The rest of this document describes various technical aspects of
719B<rxvt-unicode>. First the description of supported command sequences,
720followed by menu and pixmap support and last by a description of all
721features selectable at C<configure> time.
2 722
3=head1 Definitions 723=head1 Definitions
4 724
5=over 4 725=over 4
6 726
135Single Shift Select of G3 Character Set (SS3): affects next character 855Single Shift Select of G3 Character Set (SS3): affects next character
136only I<unimplemented> 856only I<unimplemented>
137 857
138=item B<< C<ESC Z> >> 858=item B<< C<ESC Z> >>
139 859
140Obsolete form of returns: B<< C<ESC[?1;2C> >> I<rxvt-unicode compile-time option> 860Obsolete form of returns: B<< C<ESC [ ? 1 ; 2 C> >> I<rxvt-unicode compile-time option>
141 861
142=item B<< C<ESC c> >> 862=item B<< C<ESC c> >>
143 863
144Full reset (RIS) 864Full reset (RIS)
145 865
149 869
150=item B<< C<ESC o> >> 870=item B<< C<ESC o> >>
151 871
152Invoke the G3 Character Set (LS3) 872Invoke the G3 Character Set (LS3)
153 873
154=item B<< C<ESC>(C<C> >> 874=item B<< C<ESC ( C> >>
155 875
156Designate G0 Character Set (ISO 2022), see below for values of C<C>. 876Designate G0 Character Set (ISO 2022), see below for values of C<C>.
157 877
158=item B<< C<ESC>)C<C> >> 878=item B<< C<ESC ) C> >>
159 879
160Designate G1 Character Set (ISO 2022), see below for values of C<C>. 880Designate G1 Character Set (ISO 2022), see below for values of C<C>.
161 881
162=item B<< C<ESC * C> >> 882=item B<< C<ESC * C> >>
163 883
187 907
188=back 908=back
189 909
190X<CSI> 910X<CSI>
191 911
192=head1 CSI (Code Sequence Introducer) Sequences 912=head1 CSI (Command Sequence Introducer) Sequences
193 913
194=over 4 914=over 4
195 915
196=item B<< C<ESC [ Ps @> >> 916=item B<< C<ESC [ Ps @> >>
197 917
304 1024
305=item B<< C<ESC [ Ps c> >> 1025=item B<< C<ESC [ Ps c> >>
306 1026
307Send Device Attributes (DA) 1027Send Device Attributes (DA)
308B<< C<Ps = 0> >> (or omitted): request attributes from terminal 1028B<< C<Ps = 0> >> (or omitted): request attributes from terminal
309returns: B<< C<ESC[?1;2c> >> (``I am a VT100 with Advanced Video 1029returns: B<< C<ESC [ ? 1 ; 2 c> >> (``I am a VT100 with Advanced Video
310Option'') 1030Option'')
311 1031
312=item B<< C<ESC [ Ps d> >> 1032=item B<< C<ESC [ Ps d> >>
313 1033
314Cursor to Line B<< C<Ps> >> (VPA) 1034Cursor to Line B<< C<Ps> >> (VPA)
330 B<< C<Ps = 0> >> Clear Current Column (default) 1050 B<< C<Ps = 0> >> Clear Current Column (default)
331 B<< C<Ps = 3> >> Clear All (TBC) 1051 B<< C<Ps = 3> >> Clear All (TBC)
332 1052
333=end table 1053=end table
334 1054
1055=item B<< C<ESC [ Pm h> >>
1056
1057Set Mode (SM). See B<< C<ESC [ Pm l> >> sequence for description of C<Pm>.
1058
335=item B<< C<ESC [ Ps i> >> 1059=item B<< C<ESC [ Ps i> >>
336 1060
337Printing 1061Printing. See also the C<print-pipe> resource.
338 1062
339=begin table 1063=begin table
340 1064
1065 B<< C<Ps = 0> >> print screen (MC0)
341 B<< C<Ps = 4> >> disable transparent print mode (MC4) 1066 B<< C<Ps = 4> >> disable transparent print mode (MC4)
342 B<< C<Ps = 5> >> enable transparent print mode (MC5) I<unimplemented> 1067 B<< C<Ps = 5> >> enable transparent print mode (MC5)
343 1068
344=end table 1069=end table
345
346=item B<< C<ESC [ Pm h> >>
347
348Set Mode (SM). See next sequence for description of C<Pm>.
349 1070
350=item B<< C<ESC [ Pm l> >> 1071=item B<< C<ESC [ Pm l> >>
351 1072
352Reset Mode (RM) 1073Reset Mode (RM)
353 1074
360 B<< C<h> >> Insert Mode (SMIR) 1081 B<< C<h> >> Insert Mode (SMIR)
361 B<< C<l> >> Replace Mode (RMIR) 1082 B<< C<l> >> Replace Mode (RMIR)
362 1083
363=end table 1084=end table
364 1085
365=item B<< C<Ps = 20> >> I<unimplemented> 1086=item B<< C<Ps = 20> >> (partially implemented)
366 1087
367=begin table 1088=begin table
368 1089
369 B<< C<h> >> Automatic Newline (LNM) 1090 B<< C<h> >> Automatic Newline (LNM)
370 B<< C<h> >> Normal Linefeed (LNM) 1091 B<< C<l> >> Normal Linefeed (LNM)
371 1092
372=end table 1093=end table
373 1094
374=back 1095=back
375 1096
378Character Attributes (SGR) 1099Character Attributes (SGR)
379 1100
380=begin table 1101=begin table
381 1102
382 B<< C<Ps = 0> >> Normal (default) 1103 B<< C<Ps = 0> >> Normal (default)
383 B<< C<Ps = 1 / 22> >> On / Off Bold (bright fg) 1104 B<< C<Ps = 1 / 21> >> On / Off Bold (bright fg)
1105 B<< C<Ps = 3 / 23> >> On / Off Italic
384 B<< C<Ps = 4 / 24> >> On / Off Underline 1106 B<< C<Ps = 4 / 24> >> On / Off Underline
385 B<< C<Ps = 5 / 25> >> On / Off Blink (bright bg) 1107 B<< C<Ps = 5 / 25> >> On / Off Slow Blink (bright bg)
1108 B<< C<Ps = 6 / 26> >> On / Off Rapid Blink (bright bg)
386 B<< C<Ps = 7 / 27> >> On / Off Inverse 1109 B<< C<Ps = 7 / 27> >> On / Off Inverse
1110 B<< C<Ps = 8 / 27> >> On / Off Invisible (NYI)
387 B<< C<Ps = 30 / 40> >> fg/bg Black 1111 B<< C<Ps = 30 / 40> >> fg/bg Black
388 B<< C<Ps = 31 / 41> >> fg/bg Red 1112 B<< C<Ps = 31 / 41> >> fg/bg Red
389 B<< C<Ps = 32 / 42> >> fg/bg Green 1113 B<< C<Ps = 32 / 42> >> fg/bg Green
390 B<< C<Ps = 33 / 43> >> fg/bg Yellow 1114 B<< C<Ps = 33 / 43> >> fg/bg Yellow
391 B<< C<Ps = 34 / 44> >> fg/bg Blue 1115 B<< C<Ps = 34 / 44> >> fg/bg Blue
392 B<< C<Ps = 35 / 45> >> fg/bg Magenta 1116 B<< C<Ps = 35 / 45> >> fg/bg Magenta
393 B<< C<Ps = 36 / 46> >> fg/bg Cyan 1117 B<< C<Ps = 36 / 46> >> fg/bg Cyan
1118 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 1119 B<< C<Ps = 37 / 47> >> fg/bg White
395 B<< C<Ps = 39 / 49> >> fg/bg Default 1120 B<< C<Ps = 39 / 49> >> fg/bg Default
1121 B<< C<Ps = 90 / 100> >> fg/bg Bright Black
1122 B<< C<Ps = 91 / 101> >> fg/bg Bright Red
1123 B<< C<Ps = 92 / 102> >> fg/bg Bright Green
1124 B<< C<Ps = 93 / 103> >> fg/bg Bright Yellow
1125 B<< C<Ps = 94 / 104> >> fg/bg Bright Blue
1126 B<< C<Ps = 95 / 105> >> fg/bg Bright Magenta
1127 B<< C<Ps = 96 / 106> >> fg/bg Bright Cyan
1128 B<< C<Ps = 97 / 107> >> fg/bg Bright White
1129 B<< C<Ps = 99 / 109> >> fg/bg Bright Default
396 1130
397=end table 1131=end table
398 1132
399=item B<< C<ESC [ Ps n> >> 1133=item B<< C<ESC [ Ps n> >>
400 1134
416 1150
417=item B<< C<ESC [ s> >> 1151=item B<< C<ESC [ s> >>
418 1152
419Save Cursor (SC) 1153Save Cursor (SC)
420 1154
1155=item B<< C<ESC [ Ps;Pt t> >>
1156
1157Window Operations
1158
1159=begin table
1160
1161 B<< C<Ps = 1> >> Deiconify (map) window
1162 B<< C<Ps = 2> >> Iconify window
1163 B<< C<Ps = 3> >> B<< C<ESC [ 3 ; X ; Y t> >> Move window to (X|Y)
1164 B<< C<Ps = 4> >> B<< C<ESC [ 4 ; H ; W t> >> Resize to WxH pixels
1165 B<< C<Ps = 5> >> Raise window
1166 B<< C<Ps = 6> >> Lower window
1167 B<< C<Ps = 7> >> Refresh screen once
1168 B<< C<Ps = 8> >> B<< C<ESC [ 8 ; R ; C t> >> Resize to R rows and C columns
1169 B<< C<Ps = 11> >> Report window state (responds with C<Ps = 1> or C<Ps = 2>)
1170 B<< C<Ps = 13> >> Report window position (responds with C<Ps = 3>)
1171 B<< C<Ps = 14> >> Report window pixel size (responds with C<Ps = 4>)
1172 B<< C<Ps = 18> >> Report window text size (responds with C<Ps = 7>)
1173 B<< C<Ps = 19> >> Currently the same as C<Ps = 18>, but responds with C<Ps = 9>
1174 B<< C<Ps = 20> >> Reports icon label (B<< C<ESC ] L NAME \234> >>)
1175 B<< C<Ps = 21> >> Reports window title (B<< C<ESC ] l NAME \234> >>)
1176 B<< C<Ps = 24..> >> Set window height to C<Ps> rows
1177
1178=end table
1179
1180=item B<< C<ESC [ u> >>
1181
1182Restore Cursor
1183
421=item B<< C<ESC [ Ps x> >> 1184=item B<< C<ESC [ Ps x> >>
422 1185
423Request Terminal Parameters (DECREQTPARM) 1186Request Terminal Parameters (DECREQTPARM)
424
425=item B<< C<ESC [ u> >>
426
427Restore Cursor
428 1187
429=back 1188=back
430 1189
431X<PrivateModes> 1190X<PrivateModes>
432 1191
535 B<< C<h> >> Send Mouse X & Y on button press. 1294 B<< C<h> >> Send Mouse X & Y on button press.
536 B<< C<l> >> No mouse reporting. 1295 B<< C<l> >> No mouse reporting.
537 1296
538=end table 1297=end table
539 1298
540X<Priv10>
541
542=item B<< C<Ps = 10> >> (B<rxvt>) 1299=item B<< C<Ps = 10> >> (B<rxvt>)
543 1300
544=begin table 1301=begin table
545 1302
546 B<< C<h> >> visible 1303 B<< C<h> >> menuBar visible
547 B<< C<l> >> invisible 1304 B<< C<l> >> menuBar invisible
548 1305
549=end table 1306=end table
550 1307
551=item B<< C<Ps = 25> >> 1308=item B<< C<Ps = 25> >>
552 1309
653 B<< C<h> >> Use Hilite Mouse Tracking. 1410 B<< C<h> >> Use Hilite Mouse Tracking.
654 B<< C<l> >> No mouse reporting. 1411 B<< C<l> >> No mouse reporting.
655 1412
656=end table 1413=end table
657 1414
658=item B<< C<Ps = 1010> >> 1415=item B<< C<Ps = 1010> >> (B<rxvt>)
659 1416
660=begin table 1417=begin table
661 1418
662 B<< C<h> >> Don't scroll to bottom on TTY output 1419 B<< C<h> >> Don't scroll to bottom on TTY output
663 B<< C<l> >> Scroll to bottom on TTY output 1420 B<< C<l> >> Scroll to bottom on TTY output
664 1421
665=end table 1422=end table
666 1423
667=item B<< C<Ps = 1011> >> 1424=item B<< C<Ps = 1011> >> (B<rxvt>)
668 1425
669=begin table 1426=begin table
670 1427
671 B<< C<h> >> Scroll to bottom when a key is pressed 1428 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 1429 B<< C<l> >> Don't scroll to bottom when a key is pressed
686 1443
687=begin table 1444=begin table
688 1445
689 B<< C<h> >> Save cursor position 1446 B<< C<h> >> Save cursor position
690 B<< C<l> >> Restore cursor position 1447 B<< C<l> >> Restore cursor position
1448
1449=end table
1450
1451=item B<< C<Ps = 1049> >>
1452
1453=begin table
1454
1455 B<< C<h> >> Use Alternate Screen Buffer - clear Alternate Screen Buffer if switching to it
1456 B<< C<l> >> Use Normal Screen Buffer
691 1457
692=end table 1458=end table
693 1459
694=back 1460=back
695 1461
720 B<< C<Ps = 13> >> Change colour of mouse foreground to B<< C<Pt> >> 1486 B<< C<Ps = 13> >> Change colour of mouse foreground to B<< C<Pt> >>
721 B<< C<Ps = 17> >> Change colour of highlight characters to B<< C<Pt> >> 1487 B<< C<Ps = 17> >> Change colour of highlight characters to B<< C<Pt> >>
722 B<< C<Ps = 18> >> Change colour of bold characters to B<< C<Pt> >> 1488 B<< C<Ps = 18> >> Change colour of bold characters to B<< C<Pt> >>
723 B<< C<Ps = 19> >> Change colour of underlined characters to B<< C<Pt> >> 1489 B<< C<Ps = 19> >> Change colour of underlined characters to B<< C<Pt> >>
724 B<< C<Ps = 20> >> Change default background to B<< C<Pt> >> 1490 B<< C<Ps = 20> >> Change default background to B<< C<Pt> >>
725 B<< C<Ps = 39> >> Change default foreground colour to B<< C<Pt> >> I<rxvt compile-time option> 1491 B<< C<Ps = 39> >> Change default foreground colour to B<< C<Pt> >>.
726 B<< C<Ps = 46> >> Change Log File to B<< C<Pt> >> I<unimplemented> 1492 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> 1493 B<< C<Ps = 49> >> Change default background colour to B<< C<Pt> >>.
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> >> 1494 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> >> 1495 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) 1496 B<< C<Ps = 701> >> Change current locale to B<< C<Pt> >>, or, if B<< C<Pt> >> is B<< C<?> >>, return the current locale (Compile frills).
731 B<< C<Ps = 702> >> find font for character, used for debugging (@@RXVT_NAME@@ extension) 1497 B<< C<Ps = 703> >> Menubar command B<< C<Pt> >> (Compile menubar).
732 B<< C<Ps = 703> >> command B<< C<Pt> >> I<rxvt compile-time option> (@@RXVT_NAME@@ extension) 1498 B<< C<Ps = 704> >> Change colour of italic characters to B<< C<Pt> >>
1499 B<< C<Ps = 705> >> Change background pixmap tint colour to B<< C<Pt> >> (Compile transparency).
1500 B<< C<Ps = 710> >> Set normal fontset to B<< C<Pt> >>. Same as C<Ps = 50>.
1501 B<< C<Ps = 711> >> Set bold fontset to B<< C<Pt> >>. Similar to C<Ps = 50> (Compile styles).
1502 B<< C<Ps = 712> >> Set italic fontset to B<< C<Pt> >>. Similar to C<Ps = 50> (Compile styles).
1503 B<< C<Ps = 713> >> Set bold-italic fontset to B<< C<Pt> >>. Similar to C<Ps = 50> (Compile styles).
1504 B<< C<Ps = 720> >> Move viewing window up by B<< C<Pt> >> lines, or clear scrollback buffer if C<Pt = 0> (Compile frills).
1505 B<< C<Ps = 721> >> Move viewing window down by B<< C<Pt> >> lines, or clear scrollback buffer if C<Pt = 0> (Compile frills).
733 1506
734=end table 1507=end table
735 1508
736=back 1509=back
737 1510
789 1562
790=item B<< [title:+I<string>] >> 1563=item B<< [title:+I<string>] >>
791 1564
792set the current menuBar's title to I<string>, which may contain the 1565set the current menuBar's title to I<string>, which may contain the
793following format specifiers: 1566following format specifiers:
794B<%%> : literal B<%> character 1567
795B<%n> : rxvt name (as per the B<-name> command-line option) 1568 B<%n> rxvt name (as per the B<-name> command-line option)
796B<%v> : rxvt version 1569 B<%v> rxvt version
1570 B<%%> literal B<%> character
797 1571
798=item B<[done]> 1572=item B<[done]>
799 1573
800set menuBar access as B<readonly>. 1574set menuBar access as B<readonly>.
801End-of-file tag for B<< [read:+I<file>] >> operations. 1575End-of-file tag for B<< [read:+I<file>] >> operations.
947 1721
948As a convenience for the many Emacs-type editors, I<action> may start 1722As 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 1723with B<M-> (eg, B<M-$> is equivalent to B<\E$>) and a B<CR> will be
950appended if missed from B<M-x> commands. 1724appended if missed from B<M-x> commands.
951 1725
952As a convenience for issuing XTerm B<ESC]> sequences from a menubar (or 1726As a convenience for issuing XTerm B<ESC ]> sequences from a menubar (or
953quick arrow), a B<BEL> (B<^G>) will be appended if needed. 1727quick arrow), a B<BEL> (B<^G>) will be appended if needed.
954 1728
955=over 4 1729=over 4
956 1730
957=item For example, 1731=item For example,
1390 XK_KP_8 8 ESC O x 2164 XK_KP_8 8 ESC O x
1391 XK_KP_9 9 ESC O y 2165 XK_KP_9 9 ESC O y
1392 2166
1393=end table 2167=end table
1394 2168
2169=head1 CONFIGURE OPTIONS
2170
2171General hint: if you get compile errors, then likely your configuration
2172hasn't been tested well. Either try with --enable-everything or use the
2173./reconf script as a base for experiments. ./reconf is used by myself,
2174so it should generally be a working config. Of course, you should always
2175report when a combination doesn't work, so it can be fixed. Marc Lehmann
2176<rxvt@schmorp.de>.
2177
2178=over 4
2179
2180=item --enable-everything
2181
2182Add support for all non-multichoice options listed in "./configure
2183--help". Note that unlike other enable options this is order dependant.
2184You can specify this and then disable options which this enables by
2185I<following> this with the appropriate commands.
2186
2187=item --enable-xft
2188
2189Add support for Xft (anti-aliases, among others) fonts. Xft fonts are
2190slower and require lots of memory, but as long as you don't use them, you
2191don't pay for them.
2192
2193=item --enable-font-styles
2194
2195Add support for B<bold>, I<italic> and B<< I<bold italic> >> font
2196styles. The fonts can be set manually or automatically.
2197
2198=item --with-codesets=NAME,...
2199
2200Compile in support for additional codeset (encoding) groups (C<eu>, C<vn>
2201are always compiled in, which includes most 8-bit character sets). These
2202codeset tables are used for driving X11 core fonts, they are not required
2203for Xft fonts, although having them compiled in lets rxvt-unicode choose
2204replacement fonts more intelligently. Compiling them in will make your
2205binary bigger (all of together cost about 700kB), but it doesn't increase
2206memory usage unless you use a font requiring one of these encodings.
2207
2208=begin table
2209
2210 all all available codeset groups
2211 zh common chinese encodings
2212 zh_ext rarely used but very big chinese encodigs
2213 jp common japanese encodings
2214 jp_ext rarely used but big japanese encodings
2215 kr korean encodings
2216
2217=end table
2218
2219=item --enable-xim
2220
2221Add support for XIM (X Input Method) protocol. This allows using
2222alternative input methods (e.g. kinput2) and will also correctly
2223set up the input for people using dead keys or compose keys.
2224
2225=item --enable-unicode3
2226
2227Enable direct support for displaying unicode codepoints above
222865535 (the basic multilingual page). This increases storage
2229requirements per character from 2 to 4 bytes. X11 fonts do not yet
2230support these extra characters, but Xft does.
2231
2232Please note that rxvt-unicode can store unicode code points >65535
2233even without this flag, but the number of such characters is
2234limited to a view thousand (shared with combining characters,
2235see next switch), and right now rxvt-unicode cannot display them
2236(input/output and cut&paste still work, though).
2237
2238=item --enable-combining
2239
2240Enable automatic composition of combining characters into
2241composite characters. This is required for proper viewing of text
2242where accents are encoded as seperate unicode characters. This is
2243done by using precomposited characters when available or creating
2244new pseudo-characters when no precomposed form exists.
2245
2246Without --enable-unicode3, the number of additional precomposed characters
2247is rather limited (2048, if this is full, rxvt-unicode will use the
2248private use area, extending the number of combinations to 8448). With
2249--enable-unicode3, no practical limit exists.
2250
2251This option will also enable storage (but not display) of characters
2252beyond plane 0 (>65535) when --enable-unicode3 was not specified.
2253
2254The combining table also contains entries for arabic presentation forms,
2255but these are not currently used. Bug me if you want these to be used (and
2256tell me how these are to be used...).
2257
2258=item --enable-fallback(=CLASS)
2259
2260When reading resource settings, also read settings for class CLASS
2261(default: Rxvt). To disable resource fallback use --disable-fallback.
2262
2263=item --with-res-name=NAME
2264
2265Use the given name (default: urxvt) as default application name when
2266reading resources. Specify --with-res-name=rxvt to replace rxvt.
2267
2268=item --with-res-class=CLASS
2269
2270Use the given class (default: URxvt) as default application class
2271when reading resources. Specify --with-res-class=Rxvt to replace
2272rxvt.
2273
2274=item --enable-utmp
2275
2276Write user and tty to utmp file (used by programs like F<w>) at
2277start of rxvt execution and delete information when rxvt exits.
2278
2279=item --enable-wtmp
2280
2281Write user and tty to wtmp file (used by programs like F<last>) at
2282start of rxvt execution and write logout when rxvt exits. This
2283option requires --enable-utmp to also be specified.
2284
2285=item --enable-lastlog
2286
2287Write user and tty to lastlog file (used by programs like
2288F<lastlogin>) at start of rxvt execution. This option requires
2289--enable-utmp to also be specified.
2290
2291=item --enable-xpm-background
2292
2293Add support for XPM background pixmaps.
2294
2295=item --enable-transparency
2296
2297Add support for inheriting parent backgrounds thus giving a fake
2298transparency to the term.
2299
2300=item --enable-fading
2301
2302Add support for fading the text when focus is lost.
2303
2304=item --enable-tinting
2305
2306Add support for tinting of transparent backgrounds.
2307
2308=item --enable-menubar
2309
2310Add support for our menu bar system (this interacts badly with
2311dynamic locale switching currently).
2312
2313=item --enable-rxvt-scroll
2314
2315Add support for the original rxvt scrollbar.
2316
2317=item --enable-next-scroll
2318
2319Add support for a NeXT-like scrollbar.
2320
2321=item --enable-xterm-scroll
2322
2323Add support for an Xterm-like scrollbar.
2324
2325=item --enable-plain-scroll
2326
2327Add support for a very unobtrusive, plain-looking scrollbar that
2328is the favourite of the rxvt-unicode author, having used it for
2329many years.
2330
2331=item --enable-half-shadow
2332
2333Make shadows on the scrollbar only half the normal width & height.
2334only applicable to rxvt scrollbars.
2335
2336=item --enable-ttygid
2337
2338Change tty device setting to group "tty" - only use this if
2339your system uses this type of security.
2340
2341=item --disable-backspace-key
2342
2343Disable any handling of the backspace key by us - let the X server
2344do it.
2345
2346=item --disable-delete-key
2347
2348Disable any handling of the delete key by us - let the X server
2349do it.
2350
2351=item --disable-resources
2352
2353Remove all resources checking.
2354
2355=item --enable-xgetdefault
2356
2357Make resources checking via XGetDefault() instead of our small
2358version which only checks ~/.Xdefaults, or if that doesn't exist then
2359~/.Xresources.
2360
2361Please note that nowadays, things like XIM will automatically pull in and
2362use the full X resource manager, so the overhead of using it might be very
2363small, if nonexistant.
2364
2365=item --enable-strings
2366
2367Add support for our possibly faster memset() function and other
2368various routines, overriding your system's versions which may
2369have been hand-crafted in assembly or may require extra libraries
2370to link in. (this breaks ANSI-C rules and has problems on many
2371GNU/Linux systems).
2372
2373=item --disable-swapscreen
2374
2375Remove support for swap screen.
2376
2377=item --enable-frills
2378
2379Add support for many small features that are not essential but nice to
2380have. Normally you want this, but for very small binaries you may want to
2381disable this.
2382
2383A non-exhaustive list of features enabled by C<--enable-frills> (possibly
2384in combination with other switches) is:
2385
2386 MWM-hints
2387 EWMH-hints (pid, utf8 names) and protocols (ping)
2388 seperate underline colour
2389 settable border widths and borderless switch
2390 settable extra linespacing
2391 iso-14755-2 and -3, and visual feedback
2392 backindex and forwardindex escape sequence
2393 window op and some xterm/OSC escape sequences
2394 tripleclickwords
2395 settable insecure mode
2396 keysym remapping support
2397 cursor blinking and underline cursor
2398 -embed and -pty-fd options
2399
2400=item --enable-iso14755
2401
2402Enable extended ISO 14755 support (see @@RXVT_NAME@@(1), or
2403F<doc/rxvt.1.txt>). Basic support (section 5.1) is enabled by
2404C<--enable-frills>, while support for 5.2, 5.3 and 5.4 is enabled with
2405this switch.
2406
2407=item --enable-keepscrolling
2408
2409Add support for continual scrolling of the display when you hold
2410the mouse button down on a scrollbar arrow.
2411
2412=item --enable-mousewheel
2413
2414Add support for scrolling via mouse wheel or buttons 4 & 5.
2415
2416=item --enable-slipwheeling
2417
2418Add support for continual scrolling (using the mouse wheel as an
2419accelerator) while the control key is held down. This option
2420requires --enable-mousewheel to also be specified.
2421
2422=item --disable-new-selection
2423
2424Remove support for mouse selection style like that of xterm.
2425
2426=item --enable-dmalloc
2427
2428Use Gray Watson's malloc - which is good for debugging See
2429http://www.letters.com/dmalloc/ for details If you use either this or the
2430next option, you may need to edit src/Makefile after compiling to point
2431DINCLUDE and DLIB to the right places.
2432
2433You can only use either this option and the following (should
2434you use either) .
2435
2436=item --enable-dlmalloc
2437
2438Use Doug Lea's malloc - which is good for a production version
2439See L<http://g.oswego.edu/dl/html/malloc.html> for details.
2440
2441=item --enable-smart-resize
2442
2443Add smart growth/shrink behaviour when changing font size via from hot
2444keys. This should keep in a fixed position the rxvt corner which is
2445closest to a corner of the screen.
2446
2447=item --enable-pointer-blank
2448
2449Add support to have the pointer disappear when typing or inactive.
2450
2451=item --with-name=NAME
2452
2453Set the basename for the installed binaries (default: C<urxvt>, resulting
2454in C<urxvt>, C<urxvtd> etc.). Specify C<--with-name=rxvt> to replace with
2455C<rxvt>.
2456
2457=item --with-term=NAME
2458
2459Change the environmental variable for the terminal to NAME (default
2460C<rxvt-unicode>)
2461
2462=item --with-terminfo=PATH
2463
2464Change the environmental variable for the path to the terminfo tree to
2465PATH.
2466
2467=item --with-x
2468
2469Use the X Window System (pretty much default, eh?).
2470
2471=item --with-xpm-includes=DIR
2472
2473Look for the XPM includes in DIR.
2474
2475=item --with-xpm-library=DIR
2476
2477Look for the XPM library in DIR.
2478
2479=item --with-xpm
2480
2481Not needed - define via --enable-xpm-background.
2482
2483=back
2484
1395=head1 AUTHORS 2485=head1 AUTHORS
1396 2486
1397Marc Lehmann <rxvt@schmorp.de> converted this document to pod and 2487Marc Lehmann <rxvt@schmorp.de> converted this document to pod and
1398reworked it from the original Rxvt documentation, which was done by Geoff 2488reworked it from the original Rxvt documentation, which was done by Geoff
1399Wing <gcw@pobox.com>, who in turn used the XTerm documentation and other 2489Wing <gcw@pobox.com>, who in turn used the XTerm documentation and other

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines