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.57 by root, Wed Jul 13 01:24: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 I use Solaris 9 and it doesn't compile/work/etc.
345
346Try the diff in F<doc/solaris9.patch> as a base. It fixes the worst
347problems with C<wcwidth> and a compile problem.
348
349=item How can I use rxvt-unicode under cygwin?
350
351rxvt-unicode should compile and run out of the box on cygwin, using
352the X11 libraries that come with cygwin. libW11 emulation is no
353longer supported (and makes no sense, either, as it only supported a
354single font). I recommend starting the X-server in C<-multiwindow> or
355C<-rootless> mode instead, which will result in similar look&feel as the
356old libW11 emulation.
357
358At the time of this writing, cygwin didn't seem to support any multi-byte
359encodings (you might try C<LC_CTYPE=C-UTF-8>), so you are likely limited
360to 8-bit encodings.
361
362=item How does rxvt-unicode determine the encoding to use?
363
364=item Is there an option to switch encodings?
365
366Unlike some other terminals, rxvt-unicode has no encoding switch, and no
367specific "utf-8" mode, such as xterm. In fact, it doesn't even know about
368UTF-8 or any other encodings with respect to terminal I/O.
369
370The reasons is that there exists a perfectly fine mechanism for selecting
371the encoding, doing I/O and (most important) communicating this to all
372applications so everybody agrees on character properties such as width
373and code number. This mechanism is the I<locale>. Applications not using
374that info will have problems (for example, C<xterm> gets the width of
375characters wrong as it uses it's own, locale-independent table under all
376locales).
377
378Rxvt-unicode uses the C<LC_CTYPE> locale category to select encoding. All
379programs doing the same (that is, most) will automatically agree in the
380interpretation of characters.
381
382Unfortunately, there is no system-independent way to select locales, nor
383is there a standard on how locale specifiers will look like.
384
385On most systems, the content of the C<LC_CTYPE> environment variable
386contains an arbitrary string which corresponds to an already-installed
387locale. Common names for locales are C<en_US.UTF-8>, C<de_DE.ISO-8859-15>,
388C<ja_JP.EUC-JP>, i.e. C<language_country.encoding>, but other forms
389(i.e. C<de> or C<german>) are also common.
390
391Rxvt-unicode ignores all other locale categories, and except for
392the encoding, ignores country or language-specific settings,
393i.e. C<de_DE.UTF-8> and C<ja_JP.UTF-8> are the normally same to
394rxvt-unicode.
395
396If you want to use a specific encoding you have to make sure you start
397rxvt-unicode with the correct C<LC_CTYPE> category.
398
399=item Can I switch locales at runtime?
400
401Yes, using an escape sequence. Try something like this, which sets
402rxvt-unicode's idea of C<LC_CTYPE>.
403
404 printf '\e]701;%s\007' ja_JP.SJIS
405
406See also the previous answer.
407
408Sometimes this capability is rather handy when you want to work in
409one locale (e.g. C<de_DE.UTF-8>) but some programs don't support it
410(e.g. UTF-8). For example, I use this script to start C<xjdic>, which
411first switches to a locale supported by xjdic and back later:
412
413 printf '\e]701;%s\007' ja_JP.SJIS
414 xjdic -js
415 printf '\e]701;%s\007' de_DE.UTF-8
416
417You can also use xterm's C<luit> program, which usually works fine, except
418for some locales where character width differs between program- and
419rxvt-unicode-locales.
420
421=item Can I switch the fonts at runtime?
422
423Yes, using an escape sequence. Try something like this, which has the same
424effect as using the C<-fn> switch, and takes effect immediately:
425
426 printf '\e]50;%s\007' "9x15bold,xft:Kochi Gothic"
427
428This is useful if you e.g. work primarily with japanese (and prefer a
429japanese font), but you have to switch to chinese temporarily, where
430japanese fonts would only be in your way.
431
432You can think of this as a kind of manual ISO-2022 switching.
433
434=item Why do italic characters look as if clipped?
435
436Many fonts have difficulties with italic characters and hinting. For
437example, the otherwise very nicely hinted font C<xft:Bitstream Vera Sans
438Mono> completely fails in it's italic face. A workaround might be to
439enable freetype autohinting, i.e. like this:
440
441 URxvt.italicFont: xft:Bitstream Vera Sans Mono:italic:autohint=true
442 URxvt.boldItalicFont: xft:Bitstream Vera Sans Mono:bold:italic:autohint=true
443
444=item My input method wants <some encoding> but I want UTF-8, what can I do?
445
446You can specify separate locales for the input method and the rest of the
447terminal, using the resource C<imlocale>:
448
449 URxvt*imlocale: ja_JP.EUC-JP
450
451Now you can start your terminal with C<LC_CTYPE=ja_JP.UTF-8> and still
452use your input method. Please note, however, that you will not be able to
453input characters outside C<EUC-JP> in a normal way then, as your input
454method limits you.
455
456=item Rxvt-unicode crashes when the X Input Method changes or exits.
457
458Unfortunately, this is unavoidable, as the XIM protocol is racy by
459design. Applications can avoid some crashes at the expense of memory
460leaks, and Input Methods can avoid some crashes by careful ordering at
461exit time. B<kinput2> (and derived input methods) generally succeeds,
462while B<SCIM> (or similar input methods) fails. In the end, however,
463crashes cannot be completely avoided even if both sides cooperate.
464
465So the only workaround is not to kill your Input Method Servers.
466
467=item Rxvt-unicode uses gobs of memory, how can I reduce that?
468
469Rxvt-unicode tries to obey the rule of not charging you for something you
470don't use. One thing you should try is to configure out all settings that
471you don't need, for example, Xft support is a resource hog by design,
472when used. Compiling it out ensures that no Xft font will be loaded
473accidentally when rxvt-unicode tries to find a font for your characters.
474
475Also, many people (me included) like large windows and even larger
476scrollback buffers: Without C<--enable-unicode3>, rxvt-unicode will use
4776 bytes per screen cell. For a 160x?? window this amounts to almost a
478kilobyte per line. A scrollback buffer of 10000 lines will then (if full)
479use 10 Megabytes of memory. With C<--enable-unicode3> it gets worse, as
480rxvt-unicode then uses 8 bytes per screen cell.
481
482=item Can I speed up Xft rendering somehow?
483
484Yes, the most obvious way to speed it up is to avoid Xft entirely, as
485it is simply slow. If you still want Xft fonts you might try to disable
486antialiasing (by appending C<:antialiasing=false>), which saves lots of
487memory and also speeds up rendering considerably.
488
489=item Rxvt-unicode doesn't seem to anti-alias its fonts, what is wrong?
490
491Rxvt-unicode will use whatever you specify as a font. If it needs to
492fall back to it's default font search list it will prefer X11 core
493fonts, because they are small and fast, and then use Xft fonts. It has
494antialiasing disabled for most of them, because the author thinks they
495look best that way.
496
497If you want antialiasing, you have to specify the fonts manually.
498
499=item Mouse cut/paste suddenly no longer works.
500
501Make sure that mouse reporting is actually turned off since killing
502some editors prematurely may leave the mouse in mouse report mode. I've
503heard that tcsh may use mouse reporting unless it otherwise specified. A
504quick check is to see if cut/paste works when the Alt or Shift keys are
505depressed. See @@RXVT_NAME@@(7)
506
507=item What's with this bold/blink stuff?
508
509If no bold colour is set via C<colorBD:>, bold will invert text using the
510standard foreground colour.
511
512For the standard background colour, blinking will actually make the
513text blink when compiled with C<--enable-blinking>. with standard
514colours. Without C<--enable-blinking>, the blink attribute will be
515ignored.
516
517On ANSI colours, bold/blink attributes are used to set high-intensity
518foreground/background colors.
519
520color0-7 are the low-intensity colors.
521
522color8-15 are the corresponding high-intensity colors.
523
524=item I don't like the screen colors. How do I change them?
525
526You can change the screen colors at run-time using F<~/.Xdefaults>
527resources (or as long-options).
528
529Here are values that are supposed to resemble a VGA screen,
530including the murky brown that passes for low-intensity yellow:
531
532 URxvt.color0: #000000
533 URxvt.color1: #A80000
534 URxvt.color2: #00A800
535 URxvt.color3: #A8A800
536 URxvt.color4: #0000A8
537 URxvt.color5: #A800A8
538 URxvt.color6: #00A8A8
539 URxvt.color7: #A8A8A8
540
541 URxvt.color8: #000054
542 URxvt.color9: #FF0054
543 URxvt.color10: #00FF54
544 URxvt.color11: #FFFF54
545 URxvt.color12: #0000FF
546 URxvt.color13: #FF00FF
547 URxvt.color14: #00FFFF
548 URxvt.color15: #FFFFFF
549
550And here is a more complete set of non-standard colors described (not by
551me) as "pretty girly".
552
553 URxvt.cursorColor: #dc74d1
554 URxvt.pointerColor: #dc74d1
555 URxvt.background: #0e0e0e
556 URxvt.foreground: #4ad5e1
557 URxvt.color0: #000000
558 URxvt.color8: #8b8f93
559 URxvt.color1: #dc74d1
560 URxvt.color9: #dc74d1
561 URxvt.color2: #0eb8c7
562 URxvt.color10: #0eb8c7
563 URxvt.color3: #dfe37e
564 URxvt.color11: #dfe37e
565 URxvt.color5: #9e88f0
566 URxvt.color13: #9e88f0
567 URxvt.color6: #73f7ff
568 URxvt.color14: #73f7ff
569 URxvt.color7: #e1dddd
570 URxvt.color15: #e1dddd
571
572=item How can I start @@RXVT_NAME@@d in a race-free way?
573
574Despite it's name, @@RXVT_NAME@@d is not a real daemon, but more like a
575server that answers @@RXVT_NAME@@c's requests, so it doesn't background
576itself.
577
578To ensure @@RXVT_NAME@@d is listening on it's socket, you can use the
579following method to wait for the startup message before continuing:
580
581 { @@RXVT_NAME@@d & } | read
582
583=item What's with the strange Backspace/Delete key behaviour?
584
585Assuming that the physical Backspace key corresponds to the
586BackSpace keysym (not likely for Linux ... see the following
587question) there are two standard values that can be used for
588Backspace: C<^H> and C<^?>.
589
590Historically, either value is correct, but rxvt-unicode adopts the debian
591policy of using C<^?> when unsure, because it's the one only only correct
592choice :).
593
594Rxvt-unicode tries to inherit the current stty settings and uses the value
595of `erase' to guess the value for backspace. If rxvt-unicode wasn't
596started from a terminal (say, from a menu or by remote shell), then the
597system value of `erase', which corresponds to CERASE in <termios.h>, will
598be used (which may not be the same as your stty setting).
599
600For starting a new rxvt-unicode:
601
602 # use Backspace = ^H
603 $ stty erase ^H
604 $ @@RXVT_NAME@@
605
606 # use Backspace = ^?
607 $ stty erase ^?
608 $ @@RXVT_NAME@@
609
610Toggle with C<ESC [ 36 h> / C<ESC [ 36 l> as documented in @@RXVT_NAME@@(7).
611
612For an existing rxvt-unicode:
613
614 # use Backspace = ^H
615 $ stty erase ^H
616 $ echo -n "^[[36h"
617
618 # use Backspace = ^?
619 $ stty erase ^?
620 $ echo -n "^[[36l"
621
622This helps satisfy some of the Backspace discrepancies that occur, but
623if you use Backspace = C<^H>, make sure that the termcap/terminfo value
624properly reflects that.
625
626The Delete key is a another casualty of the ill-defined Backspace problem.
627To avoid confusion between the Backspace and Delete keys, the Delete
628key has been assigned an escape sequence to match the vt100 for Execute
629(C<ESC [ 3 ~>) and is in the supplied termcap/terminfo.
630
631Some other Backspace problems:
632
633some editors use termcap/terminfo,
634some editors (vim I'm told) expect Backspace = ^H,
635GNU Emacs (and Emacs-like editors) use ^H for help.
636
637Perhaps someday this will all be resolved in a consistent manner.
638
639=item I don't like the key-bindings. How do I change them?
640
641There are some compile-time selections available via configure. Unless
642you have run "configure" with the C<--disable-resources> option you can
643use the `keysym' resource to alter the keystrings associated with keysyms.
644
645Here's an example for a URxvt session started using C<@@RXVT_NAME@@ -name URxvt>
646
647 URxvt.keysym.Home: \033[1~
648 URxvt.keysym.End: \033[4~
649 URxvt.keysym.C-apostrophe: \033<C-'>
650 URxvt.keysym.C-slash: \033<C-/>
651 URxvt.keysym.C-semicolon: \033<C-;>
652 URxvt.keysym.C-grave: \033<C-`>
653 URxvt.keysym.C-comma: \033<C-,>
654 URxvt.keysym.C-period: \033<C-.>
655 URxvt.keysym.C-0x60: \033<C-`>
656 URxvt.keysym.C-Tab: \033<C-Tab>
657 URxvt.keysym.C-Return: \033<C-Return>
658 URxvt.keysym.S-Return: \033<S-Return>
659 URxvt.keysym.S-space: \033<S-Space>
660 URxvt.keysym.M-Up: \033<M-Up>
661 URxvt.keysym.M-Down: \033<M-Down>
662 URxvt.keysym.M-Left: \033<M-Left>
663 URxvt.keysym.M-Right: \033<M-Right>
664 URxvt.keysym.M-C-0: list \033<M-C- 0123456789 >
665 URxvt.keysym.M-C-a: list \033<M-C- abcdefghijklmnopqrstuvwxyz >
666 URxvt.keysym.F12: command:\033]701;zh_CN.GBK\007
667
668See some more examples in the documentation for the B<keysym> resource.
669
670=item I'm using keyboard model XXX that has extra Prior/Next/Insert keys.
671How do I make use of them? For example, the Sun Keyboard type 4
672has the following mappings that rxvt-unicode doesn't recognize.
673
674 KP_Insert == Insert
675 F22 == Print
676 F27 == Home
677 F29 == Prior
678 F33 == End
679 F35 == Next
680
681Rather than have rxvt-unicode try to accommodate all the various possible
682keyboard mappings, it is better to use `xmodmap' to remap the keys as
683required for your particular machine.
684
685=item How do I distinguish wether I'm running rxvt-unicode or a regular xterm?
686I need this to decide about setting colors etc.
687
688rxvt and rxvt-unicode always export the variable "COLORTERM", so you can
689check and see if that is set. Note that several programs, JED, slrn,
690Midnight Commander automatically check this variable to decide whether or
691not to use color.
692
693=item How do I set the correct, full IP address for the DISPLAY variable?
694
695If you've compiled rxvt-unicode with DISPLAY_IS_IP and have enabled
696insecure mode then it is possible to use the following shell script
697snippets to correctly set the display. If your version of rxvt-unicode
698wasn't also compiled with ESCZ_ANSWER (as assumed in these snippets) then
699the COLORTERM variable can be used to distinguish rxvt-unicode from a
700regular xterm.
701
702Courtesy of Chuck Blake <cblake@BBN.COM> with the following shell script
703snippets:
704
705 # Bourne/Korn/POSIX family of shells:
706 [ ${TERM:-foo} = foo ] && TERM=xterm # assume an xterm if we don't know
707 if [ ${TERM:-foo} = xterm ]; then
708 stty -icanon -echo min 0 time 15 # see if enhanced rxvt or not
709 echo -n '^[Z'
710 read term_id
711 stty icanon echo
712 if [ ""${term_id} = '^[[?1;2C' -a ${DISPLAY:-foo} = foo ]; then
713 echo -n '^[[7n' # query the rxvt we are in for the DISPLAY string
714 read DISPLAY # set it in our local shell
715 fi
716 fi
717
718=item How do I compile the manual pages for myself?
719
720You need to have a recent version of perl installed as F</usr/bin/perl>,
721one that comes with F<pod2man>, F<pod2text> and F<pod2html>. Then go to
722the doc subdirectory and enter C<make alldoc>.
723
724=item My question isn't answered here, can I ask a human?
725
726Before sending me mail, you could go to IRC: C<irc.freenode.net>,
727channel C<#rxvt-unicode> has some rxvt-unicode enthusiasts that might be
728interested in learning about new and exciting problems (but not FAQs :).
729
730=back
731
1=head1 RXVT TECHNICAL REFERENCE 732=head1 RXVT TECHNICAL REFERENCE
733
734=head1 DESCRIPTION
735
736The rest of this document describes various technical aspects of
737B<rxvt-unicode>. First the description of supported command sequences,
738followed by menu and pixmap support and last by a description of all
739features selectable at C<configure> time.
2 740
3=head1 Definitions 741=head1 Definitions
4 742
5=over 4 743=over 4
6 744
135Single Shift Select of G3 Character Set (SS3): affects next character 873Single Shift Select of G3 Character Set (SS3): affects next character
136only I<unimplemented> 874only I<unimplemented>
137 875
138=item B<< C<ESC Z> >> 876=item B<< C<ESC Z> >>
139 877
140Obsolete form of returns: B<< C<ESC[?1;2C> >> I<rxvt-unicode compile-time option> 878Obsolete form of returns: B<< C<ESC [ ? 1 ; 2 C> >> I<rxvt-unicode compile-time option>
141 879
142=item B<< C<ESC c> >> 880=item B<< C<ESC c> >>
143 881
144Full reset (RIS) 882Full reset (RIS)
145 883
149 887
150=item B<< C<ESC o> >> 888=item B<< C<ESC o> >>
151 889
152Invoke the G3 Character Set (LS3) 890Invoke the G3 Character Set (LS3)
153 891
154=item B<< C<ESC>(C<C> >> 892=item B<< C<ESC ( C> >>
155 893
156Designate G0 Character Set (ISO 2022), see below for values of C<C>. 894Designate G0 Character Set (ISO 2022), see below for values of C<C>.
157 895
158=item B<< C<ESC>)C<C> >> 896=item B<< C<ESC ) C> >>
159 897
160Designate G1 Character Set (ISO 2022), see below for values of C<C>. 898Designate G1 Character Set (ISO 2022), see below for values of C<C>.
161 899
162=item B<< C<ESC * C> >> 900=item B<< C<ESC * C> >>
163 901
187 925
188=back 926=back
189 927
190X<CSI> 928X<CSI>
191 929
192=head1 CSI (Code Sequence Introducer) Sequences 930=head1 CSI (Command Sequence Introducer) Sequences
193 931
194=over 4 932=over 4
195 933
196=item B<< C<ESC [ Ps @> >> 934=item B<< C<ESC [ Ps @> >>
197 935
304 1042
305=item B<< C<ESC [ Ps c> >> 1043=item B<< C<ESC [ Ps c> >>
306 1044
307Send Device Attributes (DA) 1045Send Device Attributes (DA)
308B<< C<Ps = 0> >> (or omitted): request attributes from terminal 1046B<< C<Ps = 0> >> (or omitted): request attributes from terminal
309returns: B<< C<ESC[?1;2c> >> (``I am a VT100 with Advanced Video 1047returns: B<< C<ESC [ ? 1 ; 2 c> >> (``I am a VT100 with Advanced Video
310Option'') 1048Option'')
311 1049
312=item B<< C<ESC [ Ps d> >> 1050=item B<< C<ESC [ Ps d> >>
313 1051
314Cursor to Line B<< C<Ps> >> (VPA) 1052Cursor to Line B<< C<Ps> >> (VPA)
330 B<< C<Ps = 0> >> Clear Current Column (default) 1068 B<< C<Ps = 0> >> Clear Current Column (default)
331 B<< C<Ps = 3> >> Clear All (TBC) 1069 B<< C<Ps = 3> >> Clear All (TBC)
332 1070
333=end table 1071=end table
334 1072
1073=item B<< C<ESC [ Pm h> >>
1074
1075Set Mode (SM). See B<< C<ESC [ Pm l> >> sequence for description of C<Pm>.
1076
335=item B<< C<ESC [ Ps i> >> 1077=item B<< C<ESC [ Ps i> >>
336 1078
337Printing 1079Printing. See also the C<print-pipe> resource.
338 1080
339=begin table 1081=begin table
340 1082
1083 B<< C<Ps = 0> >> print screen (MC0)
341 B<< C<Ps = 4> >> disable transparent print mode (MC4) 1084 B<< C<Ps = 4> >> disable transparent print mode (MC4)
342 B<< C<Ps = 5> >> enable transparent print mode (MC5) I<unimplemented> 1085 B<< C<Ps = 5> >> enable transparent print mode (MC5)
343 1086
344=end table 1087=end table
345
346=item B<< C<ESC [ Pm h> >>
347
348Set Mode (SM). See next sequence for description of C<Pm>.
349 1088
350=item B<< C<ESC [ Pm l> >> 1089=item B<< C<ESC [ Pm l> >>
351 1090
352Reset Mode (RM) 1091Reset Mode (RM)
353 1092
360 B<< C<h> >> Insert Mode (SMIR) 1099 B<< C<h> >> Insert Mode (SMIR)
361 B<< C<l> >> Replace Mode (RMIR) 1100 B<< C<l> >> Replace Mode (RMIR)
362 1101
363=end table 1102=end table
364 1103
365=item B<< C<Ps = 20> >> I<unimplemented> 1104=item B<< C<Ps = 20> >> (partially implemented)
366 1105
367=begin table 1106=begin table
368 1107
369 B<< C<h> >> Automatic Newline (LNM) 1108 B<< C<h> >> Automatic Newline (LNM)
370 B<< C<h> >> Normal Linefeed (LNM) 1109 B<< C<l> >> Normal Linefeed (LNM)
371 1110
372=end table 1111=end table
373 1112
374=back 1113=back
375 1114
378Character Attributes (SGR) 1117Character Attributes (SGR)
379 1118
380=begin table 1119=begin table
381 1120
382 B<< C<Ps = 0> >> Normal (default) 1121 B<< C<Ps = 0> >> Normal (default)
383 B<< C<Ps = 1 / 22> >> On / Off Bold (bright fg) 1122 B<< C<Ps = 1 / 21> >> On / Off Bold (bright fg)
1123 B<< C<Ps = 3 / 23> >> On / Off Italic
384 B<< C<Ps = 4 / 24> >> On / Off Underline 1124 B<< C<Ps = 4 / 24> >> On / Off Underline
385 B<< C<Ps = 5 / 25> >> On / Off Blink (bright bg) 1125 B<< C<Ps = 5 / 25> >> On / Off Slow Blink (bright bg)
1126 B<< C<Ps = 6 / 26> >> On / Off Rapid Blink (bright bg)
386 B<< C<Ps = 7 / 27> >> On / Off Inverse 1127 B<< C<Ps = 7 / 27> >> On / Off Inverse
1128 B<< C<Ps = 8 / 27> >> On / Off Invisible (NYI)
387 B<< C<Ps = 30 / 40> >> fg/bg Black 1129 B<< C<Ps = 30 / 40> >> fg/bg Black
388 B<< C<Ps = 31 / 41> >> fg/bg Red 1130 B<< C<Ps = 31 / 41> >> fg/bg Red
389 B<< C<Ps = 32 / 42> >> fg/bg Green 1131 B<< C<Ps = 32 / 42> >> fg/bg Green
390 B<< C<Ps = 33 / 43> >> fg/bg Yellow 1132 B<< C<Ps = 33 / 43> >> fg/bg Yellow
391 B<< C<Ps = 34 / 44> >> fg/bg Blue 1133 B<< C<Ps = 34 / 44> >> fg/bg Blue
392 B<< C<Ps = 35 / 45> >> fg/bg Magenta 1134 B<< C<Ps = 35 / 45> >> fg/bg Magenta
393 B<< C<Ps = 36 / 46> >> fg/bg Cyan 1135 B<< C<Ps = 36 / 46> >> fg/bg Cyan
1136 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 1137 B<< C<Ps = 37 / 47> >> fg/bg White
395 B<< C<Ps = 39 / 49> >> fg/bg Default 1138 B<< C<Ps = 39 / 49> >> fg/bg Default
1139 B<< C<Ps = 90 / 100> >> fg/bg Bright Black
1140 B<< C<Ps = 91 / 101> >> fg/bg Bright Red
1141 B<< C<Ps = 92 / 102> >> fg/bg Bright Green
1142 B<< C<Ps = 93 / 103> >> fg/bg Bright Yellow
1143 B<< C<Ps = 94 / 104> >> fg/bg Bright Blue
1144 B<< C<Ps = 95 / 105> >> fg/bg Bright Magenta
1145 B<< C<Ps = 96 / 106> >> fg/bg Bright Cyan
1146 B<< C<Ps = 97 / 107> >> fg/bg Bright White
1147 B<< C<Ps = 99 / 109> >> fg/bg Bright Default
396 1148
397=end table 1149=end table
398 1150
399=item B<< C<ESC [ Ps n> >> 1151=item B<< C<ESC [ Ps n> >>
400 1152
416 1168
417=item B<< C<ESC [ s> >> 1169=item B<< C<ESC [ s> >>
418 1170
419Save Cursor (SC) 1171Save Cursor (SC)
420 1172
1173=item B<< C<ESC [ Ps;Pt t> >>
1174
1175Window Operations
1176
1177=begin table
1178
1179 B<< C<Ps = 1> >> Deiconify (map) window
1180 B<< C<Ps = 2> >> Iconify window
1181 B<< C<Ps = 3> >> B<< C<ESC [ 3 ; X ; Y t> >> Move window to (X|Y)
1182 B<< C<Ps = 4> >> B<< C<ESC [ 4 ; H ; W t> >> Resize to WxH pixels
1183 B<< C<Ps = 5> >> Raise window
1184 B<< C<Ps = 6> >> Lower window
1185 B<< C<Ps = 7> >> Refresh screen once
1186 B<< C<Ps = 8> >> B<< C<ESC [ 8 ; R ; C t> >> Resize to R rows and C columns
1187 B<< C<Ps = 11> >> Report window state (responds with C<Ps = 1> or C<Ps = 2>)
1188 B<< C<Ps = 13> >> Report window position (responds with C<Ps = 3>)
1189 B<< C<Ps = 14> >> Report window pixel size (responds with C<Ps = 4>)
1190 B<< C<Ps = 18> >> Report window text size (responds with C<Ps = 7>)
1191 B<< C<Ps = 19> >> Currently the same as C<Ps = 18>, but responds with C<Ps = 9>
1192 B<< C<Ps = 20> >> Reports icon label (B<< C<ESC ] L NAME \234> >>)
1193 B<< C<Ps = 21> >> Reports window title (B<< C<ESC ] l NAME \234> >>)
1194 B<< C<Ps = 24..> >> Set window height to C<Ps> rows
1195
1196=end table
1197
1198=item B<< C<ESC [ u> >>
1199
1200Restore Cursor
1201
421=item B<< C<ESC [ Ps x> >> 1202=item B<< C<ESC [ Ps x> >>
422 1203
423Request Terminal Parameters (DECREQTPARM) 1204Request Terminal Parameters (DECREQTPARM)
424
425=item B<< C<ESC [ u> >>
426
427Restore Cursor
428 1205
429=back 1206=back
430 1207
431X<PrivateModes> 1208X<PrivateModes>
432 1209
535 B<< C<h> >> Send Mouse X & Y on button press. 1312 B<< C<h> >> Send Mouse X & Y on button press.
536 B<< C<l> >> No mouse reporting. 1313 B<< C<l> >> No mouse reporting.
537 1314
538=end table 1315=end table
539 1316
540X<Priv10>
541
542=item B<< C<Ps = 10> >> (B<rxvt>) 1317=item B<< C<Ps = 10> >> (B<rxvt>)
543 1318
544=begin table 1319=begin table
545 1320
546 B<< C<h> >> visible 1321 B<< C<h> >> menuBar visible
547 B<< C<l> >> invisible 1322 B<< C<l> >> menuBar invisible
548 1323
549=end table 1324=end table
550 1325
551=item B<< C<Ps = 25> >> 1326=item B<< C<Ps = 25> >>
552 1327
653 B<< C<h> >> Use Hilite Mouse Tracking. 1428 B<< C<h> >> Use Hilite Mouse Tracking.
654 B<< C<l> >> No mouse reporting. 1429 B<< C<l> >> No mouse reporting.
655 1430
656=end table 1431=end table
657 1432
658=item B<< C<Ps = 1010> >> 1433=item B<< C<Ps = 1010> >> (B<rxvt>)
659 1434
660=begin table 1435=begin table
661 1436
662 B<< C<h> >> Don't scroll to bottom on TTY output 1437 B<< C<h> >> Don't scroll to bottom on TTY output
663 B<< C<l> >> Scroll to bottom on TTY output 1438 B<< C<l> >> Scroll to bottom on TTY output
664 1439
665=end table 1440=end table
666 1441
667=item B<< C<Ps = 1011> >> 1442=item B<< C<Ps = 1011> >> (B<rxvt>)
668 1443
669=begin table 1444=begin table
670 1445
671 B<< C<h> >> Scroll to bottom when a key is pressed 1446 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 1447 B<< C<l> >> Don't scroll to bottom when a key is pressed
686 1461
687=begin table 1462=begin table
688 1463
689 B<< C<h> >> Save cursor position 1464 B<< C<h> >> Save cursor position
690 B<< C<l> >> Restore cursor position 1465 B<< C<l> >> Restore cursor position
1466
1467=end table
1468
1469=item B<< C<Ps = 1049> >>
1470
1471=begin table
1472
1473 B<< C<h> >> Use Alternate Screen Buffer - clear Alternate Screen Buffer if switching to it
1474 B<< C<l> >> Use Normal Screen Buffer
691 1475
692=end table 1476=end table
693 1477
694=back 1478=back
695 1479
720 B<< C<Ps = 13> >> Change colour of mouse foreground to B<< C<Pt> >> 1504 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> >> 1505 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> >> 1506 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> >> 1507 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> >> 1508 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> 1509 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> 1510 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> 1511 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> >> 1512 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> >> 1513 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) 1514 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) 1515 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) 1516 B<< C<Ps = 704> >> Change colour of italic characters to B<< C<Pt> >>
1517 B<< C<Ps = 705> >> Change background pixmap tint colour to B<< C<Pt> >> (Compile transparency).
1518 B<< C<Ps = 710> >> Set normal fontset to B<< C<Pt> >>. Same as C<Ps = 50>.
1519 B<< C<Ps = 711> >> Set bold fontset to B<< C<Pt> >>. Similar to C<Ps = 50> (Compile styles).
1520 B<< C<Ps = 712> >> Set italic fontset to B<< C<Pt> >>. Similar to C<Ps = 50> (Compile styles).
1521 B<< C<Ps = 713> >> Set bold-italic fontset to B<< C<Pt> >>. Similar to C<Ps = 50> (Compile styles).
1522 B<< C<Ps = 720> >> Move viewing window up by B<< C<Pt> >> lines, or clear scrollback buffer if C<Pt = 0> (Compile frills).
1523 B<< C<Ps = 721> >> Move viewing window down by B<< C<Pt> >> lines, or clear scrollback buffer if C<Pt = 0> (Compile frills).
733 1524
734=end table 1525=end table
735 1526
736=back 1527=back
737 1528
789 1580
790=item B<< [title:+I<string>] >> 1581=item B<< [title:+I<string>] >>
791 1582
792set the current menuBar's title to I<string>, which may contain the 1583set the current menuBar's title to I<string>, which may contain the
793following format specifiers: 1584following format specifiers:
794B<%%> : literal B<%> character 1585
795B<%n> : rxvt name (as per the B<-name> command-line option) 1586 B<%n> rxvt name (as per the B<-name> command-line option)
796B<%v> : rxvt version 1587 B<%v> rxvt version
1588 B<%%> literal B<%> character
797 1589
798=item B<[done]> 1590=item B<[done]>
799 1591
800set menuBar access as B<readonly>. 1592set menuBar access as B<readonly>.
801End-of-file tag for B<< [read:+I<file>] >> operations. 1593End-of-file tag for B<< [read:+I<file>] >> operations.
947 1739
948As a convenience for the many Emacs-type editors, I<action> may start 1740As 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 1741with B<M-> (eg, B<M-$> is equivalent to B<\E$>) and a B<CR> will be
950appended if missed from B<M-x> commands. 1742appended if missed from B<M-x> commands.
951 1743
952As a convenience for issuing XTerm B<ESC]> sequences from a menubar (or 1744As a convenience for issuing XTerm B<ESC ]> sequences from a menubar (or
953quick arrow), a B<BEL> (B<^G>) will be appended if needed. 1745quick arrow), a B<BEL> (B<^G>) will be appended if needed.
954 1746
955=over 4 1747=over 4
956 1748
957=item For example, 1749=item For example,
1390 XK_KP_8 8 ESC O x 2182 XK_KP_8 8 ESC O x
1391 XK_KP_9 9 ESC O y 2183 XK_KP_9 9 ESC O y
1392 2184
1393=end table 2185=end table
1394 2186
2187=head1 CONFIGURE OPTIONS
2188
2189General hint: if you get compile errors, then likely your configuration
2190hasn't been tested well. Either try with --enable-everything or use the
2191./reconf script as a base for experiments. ./reconf is used by myself,
2192so it should generally be a working config. Of course, you should always
2193report when a combination doesn't work, so it can be fixed. Marc Lehmann
2194<rxvt@schmorp.de>.
2195
2196=over 4
2197
2198=item --enable-everything
2199
2200Add support for all non-multichoice options listed in "./configure
2201--help". Note that unlike other enable options this is order dependant.
2202You can specify this and then disable options which this enables by
2203I<following> this with the appropriate commands.
2204
2205=item --enable-xft
2206
2207Add support for Xft (anti-aliases, among others) fonts. Xft fonts are
2208slower and require lots of memory, but as long as you don't use them, you
2209don't pay for them.
2210
2211=item --enable-font-styles
2212
2213Add support for B<bold>, I<italic> and B<< I<bold italic> >> font
2214styles. The fonts can be set manually or automatically.
2215
2216=item --with-codesets=NAME,...
2217
2218Compile in support for additional codeset (encoding) groups (C<eu>, C<vn>
2219are always compiled in, which includes most 8-bit character sets). These
2220codeset tables are used for driving X11 core fonts, they are not required
2221for Xft fonts, although having them compiled in lets rxvt-unicode choose
2222replacement fonts more intelligently. Compiling them in will make your
2223binary bigger (all of together cost about 700kB), but it doesn't increase
2224memory usage unless you use a font requiring one of these encodings.
2225
2226=begin table
2227
2228 all all available codeset groups
2229 zh common chinese encodings
2230 zh_ext rarely used but very big chinese encodigs
2231 jp common japanese encodings
2232 jp_ext rarely used but big japanese encodings
2233 kr korean encodings
2234
2235=end table
2236
2237=item --enable-xim
2238
2239Add support for XIM (X Input Method) protocol. This allows using
2240alternative input methods (e.g. kinput2) and will also correctly
2241set up the input for people using dead keys or compose keys.
2242
2243=item --enable-unicode3
2244
2245Enable direct support for displaying unicode codepoints above
224665535 (the basic multilingual page). This increases storage
2247requirements per character from 2 to 4 bytes. X11 fonts do not yet
2248support these extra characters, but Xft does.
2249
2250Please note that rxvt-unicode can store unicode code points >65535
2251even without this flag, but the number of such characters is
2252limited to a view thousand (shared with combining characters,
2253see next switch), and right now rxvt-unicode cannot display them
2254(input/output and cut&paste still work, though).
2255
2256=item --enable-combining
2257
2258Enable automatic composition of combining characters into
2259composite characters. This is required for proper viewing of text
2260where accents are encoded as seperate unicode characters. This is
2261done by using precomposited characters when available or creating
2262new pseudo-characters when no precomposed form exists.
2263
2264Without --enable-unicode3, the number of additional precomposed characters
2265is rather limited (2048, if this is full, rxvt-unicode will use the
2266private use area, extending the number of combinations to 8448). With
2267--enable-unicode3, no practical limit exists.
2268
2269This option will also enable storage (but not display) of characters
2270beyond plane 0 (>65535) when --enable-unicode3 was not specified.
2271
2272The combining table also contains entries for arabic presentation forms,
2273but these are not currently used. Bug me if you want these to be used (and
2274tell me how these are to be used...).
2275
2276=item --enable-fallback(=CLASS)
2277
2278When reading resource settings, also read settings for class CLASS
2279(default: Rxvt). To disable resource fallback use --disable-fallback.
2280
2281=item --with-res-name=NAME
2282
2283Use the given name (default: urxvt) as default application name when
2284reading resources. Specify --with-res-name=rxvt to replace rxvt.
2285
2286=item --with-res-class=CLASS
2287
2288Use the given class (default: URxvt) as default application class
2289when reading resources. Specify --with-res-class=Rxvt to replace
2290rxvt.
2291
2292=item --enable-utmp
2293
2294Write user and tty to utmp file (used by programs like F<w>) at
2295start of rxvt execution and delete information when rxvt exits.
2296
2297=item --enable-wtmp
2298
2299Write user and tty to wtmp file (used by programs like F<last>) at
2300start of rxvt execution and write logout when rxvt exits. This
2301option requires --enable-utmp to also be specified.
2302
2303=item --enable-lastlog
2304
2305Write user and tty to lastlog file (used by programs like
2306F<lastlogin>) at start of rxvt execution. This option requires
2307--enable-utmp to also be specified.
2308
2309=item --enable-xpm-background
2310
2311Add support for XPM background pixmaps.
2312
2313=item --enable-transparency
2314
2315Add support for inheriting parent backgrounds thus giving a fake
2316transparency to the term.
2317
2318=item --enable-fading
2319
2320Add support for fading the text when focus is lost.
2321
2322=item --enable-tinting
2323
2324Add support for tinting of transparent backgrounds.
2325
2326=item --enable-menubar
2327
2328Add support for our menu bar system (this interacts badly with
2329dynamic locale switching currently).
2330
2331=item --enable-rxvt-scroll
2332
2333Add support for the original rxvt scrollbar.
2334
2335=item --enable-next-scroll
2336
2337Add support for a NeXT-like scrollbar.
2338
2339=item --enable-xterm-scroll
2340
2341Add support for an Xterm-like scrollbar.
2342
2343=item --enable-plain-scroll
2344
2345Add support for a very unobtrusive, plain-looking scrollbar that
2346is the favourite of the rxvt-unicode author, having used it for
2347many years.
2348
2349=item --enable-half-shadow
2350
2351Make shadows on the scrollbar only half the normal width & height.
2352only applicable to rxvt scrollbars.
2353
2354=item --enable-ttygid
2355
2356Change tty device setting to group "tty" - only use this if
2357your system uses this type of security.
2358
2359=item --disable-backspace-key
2360
2361Disable any handling of the backspace key by us - let the X server
2362do it.
2363
2364=item --disable-delete-key
2365
2366Disable any handling of the delete key by us - let the X server
2367do it.
2368
2369=item --disable-resources
2370
2371Remove all resources checking.
2372
2373=item --enable-xgetdefault
2374
2375Make resources checking via XGetDefault() instead of our small
2376version which only checks ~/.Xdefaults, or if that doesn't exist then
2377~/.Xresources.
2378
2379Please note that nowadays, things like XIM will automatically pull in and
2380use the full X resource manager, so the overhead of using it might be very
2381small, if nonexistant.
2382
2383=item --enable-strings
2384
2385Add support for our possibly faster memset() function and other
2386various routines, overriding your system's versions which may
2387have been hand-crafted in assembly or may require extra libraries
2388to link in. (this breaks ANSI-C rules and has problems on many
2389GNU/Linux systems).
2390
2391=item --disable-swapscreen
2392
2393Remove support for swap screen.
2394
2395=item --enable-frills
2396
2397Add support for many small features that are not essential but nice to
2398have. Normally you want this, but for very small binaries you may want to
2399disable this.
2400
2401A non-exhaustive list of features enabled by C<--enable-frills> (possibly
2402in combination with other switches) is:
2403
2404 MWM-hints
2405 EWMH-hints (pid, utf8 names) and protocols (ping)
2406 seperate underline colour
2407 settable border widths and borderless switch
2408 settable extra linespacing
2409 iso-14755-2 and -3, and visual feedback
2410 backindex and forwardindex escape sequence
2411 window op and some xterm/OSC escape sequences
2412 tripleclickwords
2413 settable insecure mode
2414 keysym remapping support
2415 cursor blinking and underline cursor
2416 -embed and -pty-fd options
2417
2418=item --enable-iso14755
2419
2420Enable extended ISO 14755 support (see @@RXVT_NAME@@(1), or
2421F<doc/rxvt.1.txt>). Basic support (section 5.1) is enabled by
2422C<--enable-frills>, while support for 5.2, 5.3 and 5.4 is enabled with
2423this switch.
2424
2425=item --enable-keepscrolling
2426
2427Add support for continual scrolling of the display when you hold
2428the mouse button down on a scrollbar arrow.
2429
2430=item --enable-mousewheel
2431
2432Add support for scrolling via mouse wheel or buttons 4 & 5.
2433
2434=item --enable-slipwheeling
2435
2436Add support for continual scrolling (using the mouse wheel as an
2437accelerator) while the control key is held down. This option
2438requires --enable-mousewheel to also be specified.
2439
2440=item --disable-new-selection
2441
2442Remove support for mouse selection style like that of xterm.
2443
2444=item --enable-dmalloc
2445
2446Use Gray Watson's malloc - which is good for debugging See
2447http://www.letters.com/dmalloc/ for details If you use either this or the
2448next option, you may need to edit src/Makefile after compiling to point
2449DINCLUDE and DLIB to the right places.
2450
2451You can only use either this option and the following (should
2452you use either) .
2453
2454=item --enable-dlmalloc
2455
2456Use Doug Lea's malloc - which is good for a production version
2457See L<http://g.oswego.edu/dl/html/malloc.html> for details.
2458
2459=item --enable-smart-resize
2460
2461Add smart growth/shrink behaviour when changing font size via from hot
2462keys. This should keep in a fixed position the rxvt corner which is
2463closest to a corner of the screen.
2464
2465=item --enable-pointer-blank
2466
2467Add support to have the pointer disappear when typing or inactive.
2468
2469=item --with-name=NAME
2470
2471Set the basename for the installed binaries (default: C<urxvt>, resulting
2472in C<urxvt>, C<urxvtd> etc.). Specify C<--with-name=rxvt> to replace with
2473C<rxvt>.
2474
2475=item --with-term=NAME
2476
2477Change the environmental variable for the terminal to NAME (default
2478C<rxvt-unicode>)
2479
2480=item --with-terminfo=PATH
2481
2482Change the environmental variable for the path to the terminfo tree to
2483PATH.
2484
2485=item --with-x
2486
2487Use the X Window System (pretty much default, eh?).
2488
2489=item --with-xpm-includes=DIR
2490
2491Look for the XPM includes in DIR.
2492
2493=item --with-xpm-library=DIR
2494
2495Look for the XPM library in DIR.
2496
2497=item --with-xpm
2498
2499Not needed - define via --enable-xpm-background.
2500
2501=back
2502
1395=head1 AUTHORS 2503=head1 AUTHORS
1396 2504
1397Marc Lehmann <rxvt@schmorp.de> converted this document to pod and 2505Marc Lehmann <rxvt@schmorp.de> converted this document to pod and
1398reworked it from the original Rxvt documentation, which was done by Geoff 2506reworked it from the original Rxvt documentation, which was done by Geoff
1399Wing <gcw@pobox.com>, who in turn used the XTerm documentation and other 2507Wing <gcw@pobox.com>, who in turn used the XTerm documentation and other

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines