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

Comparing rxvt-unicode/doc/rxvt.7.pod (file contents):
Revision 1.1 by root, Thu Aug 12 20:42:12 2004 UTC vs.
Revision 1.55 by root, Sun Jun 26 20:11:22 2005 UTC

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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines