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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines