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.25 by root, Mon Sep 6 06:20:40 2004 UTC vs.
Revision 1.155 by ayin, Sun Dec 9 12:15:39 2007 UTC

1=head1 NAME 1=head1 NAME
2 2
3RXVT REFERENCE - FAQ, command sequences and other background information 3RXVT REFERENCE - FAQ, command sequences and other background information
4 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 also available on the World Wide Web at
22L<http://cvs.schmorp.de/browse/rxvt-unicode/doc/rxvt.7.html>.
23
5=head1 FREQUENTLY ASKED QUESTIONS 24=head1 RXVT-UNICODE/URXVT FREQUENTLY ASKED QUESTIONS
6 25
7=over 4
8 26
27=head2 Meta, Features & Commandline Issues
28
29=head3 My question isn't answered here, can I ask a human?
30
31Before sending me mail, you could go to IRC: C<irc.freenode.net>,
32channel C<#rxvt-unicode> has some rxvt-unicode enthusiasts that might be
33interested in learning about new and exciting problems (but not FAQs :).
34
35=head3 Does it support tabs, can I have a tabbed rxvt-unicode?
36
37Beginning with version 7.3, there is a perl extension that implements a
38simple tabbed terminal. It is installed by default, so any of these should
39give you tabs:
40
41 @@URXVT_NAME@@ -pe tabbed
42
43 URxvt.perl-ext-common: default,tabbed
44
45It will also work fine with tabbing functionality of many window managers
46or similar tabbing programs, and its embedding-features allow it to be
47embedded into other programs, as witnessed by F<doc/rxvt-tabbed> or
48the upcoming C<Gtk2::URxvt> perl module, which features a tabbed urxvt
49(murxvt) terminal as an example embedding application.
50
9=item How do I know which rxvt-unicode version I'm using? 51=head3 How do I know which rxvt-unicode version I'm using?
10 52
11The version number is displayed with the usage (-h). Also the escape 53The version number is displayed with the usage (-h). Also the escape
12sequence C<ESC[8n> sets the window title to the version number. 54sequence C<ESC [ 8 n> sets the window title to the version number. When
55using the @@URXVT_NAME@@c client, the version displayed is that of the
56daemon.
13 57
14=item When I log-in to another system it tells me about missing terminfo data?
15
16The terminal description used by rxvt-unicode is not as widely available
17as that for xterm, or even rxvt (for which the same problem often arises).
18
19The correct solution for this problem is to install the terminfo, this can
20be done like this (with ncurses' infocmp):
21
22 REMOTE=remotesystem.domain
23 infocmp rxvt-unicode | ssh $REMOTE "cat >/tmp/ti && tic /tmp/ti"
24
25... or by installing rxvt-unicode normally on the remote system,
26
27If you cannot or do not want to do this, then you can simply set
28C<TERM=rxvt> or even C<TERM=xterm>, and live with the small number of
29problems arising, which includes wrong keymapping, less and different
30colours and some refresh errors in fullscreen applications. It's a nice
31quick-and-dirty workaround for rare cases, though.
32
33If you always want to do this you can either recompile rxvt-unicode with
34the desired TERM value or use a resource to set it:
35
36 URxvt.termName: rxvt
37
38If you don't plan to use B<rxvt> (quite common...) you could also replace
39the rxvt terminfo file with the rxvt-unicode one.
40
41=item I need a termcap file entry.
42
43You could use rxvt's termcap entry with resonable results in many cases.
44You can also create a termcap entry by using terminfo's infocmp program
45like this:
46
47 infocmp -C rxvt-unicode
48
49OR you could this termcap entry:
50
51 rxvt-unicode|rxvt-unicode terminal (X Window System):\
52 :am:bw:eo:km:mi:ms:xn:xo:\
53 :co#80:it#8:li#24:\
54 :AL=\E[%dL:DC=\E[%dP:DL=\E[%dM:DO=\E[%dB:IC=\E[%d@:\
55 :K1=\EOw:K2=\EOu:K3=\EOy:K4=\EOq:K5=\EOs:LE=\E[%dD:\
56 :RI=\E[%dC:SF=\E[%dS:SR=\E[%dT:UP=\E[%dA:ae=^O:al=\E[L:\
57 :as=^N:bl=^G:cd=\E[J:ce=\E[K:cl=\E[H\E[2J:cm=\E[%i%d;%dH:\
58 :cr=^M:cs=\E[%i%d;%dr:ct=\E[3g:dc=\E[P:dl=\E[M:do=^J:\
59 :ec=\E[%dX:ei=\E[4l:ho=\E[H:i1=\E[?47l\E=\E[?1l:ic=\E[@:\
60 :im=\E[4h:is=\E[r\E[m\E[2J\E[H\E[?7h\E[?1;3;4;6l\E[4l:\
61 :k0=\E[21~:k1=\E[11~:k2=\E[12~:k3=\E[13~:k4=\E[14~:\
62 :k5=\E[15~:k6=\E[17~:k7=\E[18~:k8=\E[19~:k9=\E[20~:\
63 :kD=\E[3~:kI=\E[2~:kN=\E[6~:kP=\E[5~:kb=\177:kd=\EOB:\
64 :ke=\E[?1l\E>:kh=\E[7~:kl=\EOD:kr=\EOC:ks=\E[?1h\E=:\
65 :ku=\EOA:le=^H:mb=\E[5m:md=\E[1m:me=\E[m\017:mr=\E[7m:\
66 :nd=\E[C:rc=\E8:sc=\E7:se=\E[27m:sf=^J:so=\E[7m:sr=\EM:\
67 :st=\EH:ta=^I:te=\E[r\E[?1049l:ti=\E[?1049h:ue=\E[24m:\
68 :up=\E[A:us=\E[4m:vb=\E[?5h\E[?5l:ve=\E[?25h:vi=\E[?25l:\
69 :vs=\E[?25h:
70
71=item How can I configure rxvt-unicode so that it looks similar to the original rxvt?
72
73Felix von Leitner says that these two lines, in your F<.Xdefaults>, will make rxvt-unicode
74behave similar to the original rxvt:
75
76 URxvt.font: -misc-fixed-medium-r-semicondensed--13-120-75-75-c-60-iso8859-1
77 URxvt.boldFont: -misc-fixed-bold-r-semicondensed--13-120-75-75-c-60-iso8859-1
78
79=item Rxvt-unicode does not seem to understand the selected encoding?
80
81=item Unicode does not seem to work?
82
83If you encounter strange problems like typing an accented character but
84getting two unrelated other characters or similar, or if program output is
85subtly garbled, then you should check your locale settings.
86
87Rxvt-unicode must be started with the same C<LC_CTYPE> setting as the
88programs. Often rxvt-unicode is started in the C<C> locale, while the
89login script running within the rxvt-unicode window changes the locale to
90sth. else, e.h. C<en_GB.UTF-8>. Needless to say, this is not going to work.
91
92The best thing is to fix your startup environment, as you will likely run
93into other problems. If nothing works you can try this in your .profile.
94
95 printf '\e]701;%s\007' "$LC_CTYPE"
96
97If this doesn't work, then maybe you use a C<LC_CTYPE> specification not
98supported on your systems. Some systems have a C<locale> command which
99displays this. If it displays sth. like:
100
101 locale: Cannot set LC_CTYPE to default locale: ...
102
103Then the locale you specified is not supported on your system.
104
105If nothing works and you are sure that everything is set correctly then
106you will need to remember a little known fact: Some programs just don't
107support locales :(
108
109=item Why do some characters look so much different than others?
110
111=item How does rxvt-unicode choose fonts?
112
113Most fonts do not contain the full range of Unicode, which is
114fine. Chances are that the font you (or the admin/package maintainer of
115your system/os) have specified does not cover all the characters you want
116to display.
117
118B<rxvt-unicode> makes a best-effort try at finding a replacement
119font. Often the result is fine, but sometimes the chosen font looks
120bad. Many fonts have totally strange characters that don't resemble the
121correct glyph at all, and rxvt-unicode lacks the artificial intelligence
122to detect that a specific glyph is wrong: it has to believe the font that
123the characters it contains indeed look correct.
124
125In that case, select a font of your taste and add it to the font list,
126e.g.:
127
128 @@RXVT_NAME@@ -fn basefont,font2,font3...
129
130When rxvt-unicode sees a character, it will first look at the base
131font. If the base font does not contain the character, it will go to the
132next font, and so on. Specifying your own fonts will also speed up this
133search and use less resources within rxvt-unicode and the X-server.
134
135The only limitation is that all the fonts must not be larger than the base
136font, as the base font defines the principal cell size, which must be the
137same due to the way terminals work.
138
139=item Why do some chinese characters look so different than others?
140
141This is because there is a difference between script and language --
142rxvt-unicode does not know which language the text that is output
143is, as it only knows the unicode character codes. If rxvt-unicode
144first sees a japanese character, it might choose a japanese font for
145it. Subsequent japanese characters will take that font. Now, many chinese
146characters aren't represented in japanese fonts, so when the first
147non-japanese character comes up, rxvt-unicode will look for a chinese font
148-- unfortunately at this point, it will still use the japanese font for
149japanese characters that are also chinese.
150
151The workaround is easy: just tag a chinese font at the end of your font
152list (see the previous question). The key is to view the font list as
153a preference list: If you expect more japanese, list a japanese font
154first. If you expect more chinese, put a chinese font first.
155
156In the future it might be possible to switch preferences at runtime (the
157internal data structure has no problem with using different fonts for
158the same character at the same time, but no interface for this has been
159designed yet).
160
161=item Why does rxvt-unicode sometimes leave pixel droppings?
162
163Most fonts were not designed for terminal use, which means that character
164size varies a lot. A font that is otherwise fine for terminal use might
165contain some characters that are simply too wide. Rxvt-unicode will avoid
166these characters. For characters that are just "a bit" too wide a special
167"careful" rendering mode is used that redraws adjacent characters.
168
169All of this requires that fonts do not lie about character sizes,
170however: Xft fonts often draw glyphs larger than their acclaimed bounding
171box, and rxvt-unicode has no way of detecting this (the correct way is to
172ask for the character bounding box, which unfortunately is wrong in these
173cases).
174
175It's not clear (to me at least), wether this is a bug in Xft, freetype, or
176the respective font. If you encounter this problem there is no way to work
177around this except by using a different font.
178
179All of this is not a problem when using X11 core fonts, as their bounding
180box data is correct.
181
182=item My Compose (Multi_key) key is no longer working.
183
184The most common causes for this are that either your locale is not set
185correctly, or you specified a B<preeditStyle> that is not supported by
186your input method. For example, if you specified B<OverTheSpot> and
187your input method (e.g. the default input method handling Compose keys)
188does not support this (for instance because it is not visual), then
189rxvt-unicode will continue without an input method.
190
191In this case either do not specify a B<preeditStyle> or specify more than
192one pre-edit style, such as B<OverTheSpot,Root,None>.
193
194=item How can I keep rxvt-unicode from using reverse video so much?
195
196First of all, make sure you are running with the right terminfo
197(C<urxvt>), which will get rid of most of these effects. Then make sure
198you have specified colours for italic and bold, as otherwise rxvt-unicode
199might use reverse video to simulate the effect:
200
201 URxvt*colorBD: white
202 URxvt*colorIT: green
203
204=item Some programs assume totally weird colours (red instead of blue), how can I fix that?
205
206For some unexplainable reason, some programs (i.e. irssi) assume a very
207weird colour palette when confronted with a terminal with more than the
208standard 8 colours (rxvt-unicode supports 88). The right fix is, of
209course, to fix these programs not to assume non-ISO colours without very
210good reasons.
211
212In the meantime, you can either edit your C<urxvt> terminfo definition to
213only claim 8 colour support or use C<TERM=rxvt>, which will fix colours
214but keep you from using other rxvt-unicode features.
215
216=item I am on FreeBSD and rxvt-unicode does not seem to work at all.
217
218Rxvt-unicode requires the symbol C<__STDC_ISO_10646__> to be defined
219in your compile environment, or an implementation that implements it,
220wether it defines the symbol or not. C<__STDC_ISO_10646__> requires that
221B<wchar_t> is represented as unicode.
222
223As you might have guessed, FreeBSD does neither define this symobl nor
224does it support it. Instead, it uses it's own internal representation of
225B<wchar_t>. This is, of course, completely legal.
226
227However, C<__STDC_ISO_10646__> is the only sane way to support
228multi-language apps in an OS, as using a locale-dependent (and
229non-standardized) representation of B<wchar_t> makes it impossible to
230convert between B<wchar_t> (as used by X11 and your applications) and any
231other encoding without implementing OS-specific-wrappers for each and
232every locale. There simply are no APIs to convert B<wchar_t> into anything
233except the current locale encoding.
234
235Some applications (such as the formidable B<mlterm>) work around this
236by carrying their own replacement functions for character set handling
237with them, and either implementing OS-dependent hacks or doing multiple
238conversions (which is slow and unreliable in case the OS implements
239encodings slightly different than the terminal emulator).
240
241The rxvt-unicode author insists that the right way to fix this is in the
242system libraries once and for all, instead of forcing every app to carry
243complete replacements.
244
245=item How does rxvt-unicode determine the encoding to use?
246
247=item Is there an option to switch encodings?
248
249Unlike some other terminals, rxvt-unicode has no encoding switch, and no
250specific "utf-8" mode, such as xterm. In fact, it doesn't even know about
251UTF-8 or any other encodings with respect to terminal I/O.
252
253The reasons is that there exists a perfectly fine mechanism for selecting
254the encoding, doing I/O and (most important) communicating this to all
255applications so everybody agrees on character properties such as width and
256code number. This mechanism is the I<locale>.
257
258Rxvt-unicode uses the C<LC_CTYPE> locale category to select encoding. All
259programs doing the same (that is, most) will automatically agree in the
260interpretation of characters.
261
262Unfortunately, there is no system-independent way to select locales, nor
263is there a standard on how locale specifiers will look like.
264
265On most systems, the content of the C<LC_CTYPE> environment variable
266contains an arbitrary string which corresponds to an already-installed
267locale. Common names for locales are C<en_US.UTF-8>, C<de_DE.ISO-8859-15>,
268C<ja_JP.EUC-JP>, i.e. C<language_country.encoding>, but other forms
269(i.e. C<de> or C<german>) are also common.
270
271Rxvt-unicode ignores all other locale categories, and except for
272the encoding, ignores country or language-specific settings,
273i.e. C<de_DE.UTF-8> and C<ja_JP.UTF-8> are the same for rxvt-unicode.
274
275If you want to use a specific encoding you have to make sure you start
276rxvt-unicode with the correct C<LC_CTYPE> category.
277
278=item Can I switch locales at runtime?
279
280Yes, using an escape sequence. Try sth. like this, which sets
281rxvt-unicode's idea of C<LC_CTYPE>.
282
283 printf '\e]701;%s\007' ja_JP.SJIS
284
285See also the previous question.
286
287Sometimes this capability is rather handy when you want to work in one
288locale (e.g. C<de_DE.UTF-8>) but some programs don't support UTF-8. For
289example, I use this script to start C<xjdic>, which first switches to a
290locale supported by xjdic and back later:
291
292 printf '\e]701;%s\007' ja_JP.SJIS
293 xjdic -js
294 printf '\e]701;%s\007' de_DE.UTF-8
295
296=item Can I switch the fonts at runtime?
297
298Yes, using an escape sequence. Try sth. like this, which has the same
299effect as using the C<-fn> switch, and takes effect immediately:
300
301 printf '\e]50;%s\007' "9x15bold,xft:Kochi Gothic"
302
303This is useful if you e.g. work primarily with japanese (and prefer a
304japanese font), but you have to switch to chinese temporarily, where
305japanese fonts would only be in your way.
306
307You can think of this as a kind of manual ISO-2022 switching.
308
309=item Why do italic characters look as if clipped?
310
311Many fonts have difficulties with italic characters and hinting. For
312example, the otherwise very nicely hinted font C<xft:Bitstream Vera Sans
313Mono> completely fails in it's italic face. A workaround is to enable
314freetype autohinting, i.e. like this:
315
316 URxvt*italicFont: xft:Bitstream Vera Sans Mono:italic:autohint=true
317 URxvt*boldItalicFont: xft:Bitstream Vera Sans Mono:bold:italic:autohint=true
318
319=item My input method wants <some encoding> but I want UTF-8, what can I do?
320
321You can specify separate locales for the input method and the rest of the
322terminal, using the resource C<imlocale>:
323
324 URxvt*imlocale: ja_JP.EUC-JP
325
326Now you can start your terminal with C<LC_CTYPE=ja_JP.UTF-8> and still
327use your input method. Please note, however, that you will not be able to
328input characters outside C<EUC-JP> in a normal way then, as your input
329method limits you.
330
331=item Rxvt-unicode uses gobs of memory, how can I reduce that? 58=head3 Rxvt-unicode uses gobs of memory, how can I reduce that?
332 59
333Rxvt-unicode tries to obey the rule of not charging you for sth. you 60Rxvt-unicode tries to obey the rule of not charging you for something you
334don't use. One thing you should try is to configure out all settings that 61don't use. One thing you should try is to configure out all settings that
335you don't need, for example, Xft support is a resource hog by design, 62you don't need, for example, Xft support is a resource hog by design,
336when used. Compiling it out ensures that no Xft font will be loaded 63when used. Compiling it out ensures that no Xft font will be loaded
337accidentally when rxvt-unicode tries to find a font for your characters. 64accidentally when rxvt-unicode tries to find a font for your characters.
338 65
3416 bytes per screen cell. For a 160x?? window this amounts to almost a 686 bytes per screen cell. For a 160x?? window this amounts to almost a
342kilobyte per line. A scrollback buffer of 10000 lines will then (if full) 69kilobyte per line. A scrollback buffer of 10000 lines will then (if full)
343use 10 Megabytes of memory. With C<--enable-unicode3> it gets worse, as 70use 10 Megabytes of memory. With C<--enable-unicode3> it gets worse, as
344rxvt-unicode then uses 8 bytes per screen cell. 71rxvt-unicode then uses 8 bytes per screen cell.
345 72
346=item Can I speed up Xft rendering somehow? 73=head3 How can I start @@URXVT_NAME@@d in a race-free way?
347 74
348Yes, the most obvious way to speed it up is to avoid Xft entirely, as 75Try C<@@URXVT_NAME@@d -f -o>, which tells @@URXVT_NAME@@d to open the
349it is simply slow. If you still want Xft fonts you might try to disable 76display, create the listening socket and then fork.
350antialiasing (by appending C<:antialiasing=false>), which saves lots of
351memory and also speeds up rendering considerably.
352 77
353=item Rxvt-unicode doesn't seem to anti-alias its fonts, what is wrong? 78=head3 How can I start @@URXVT_NAME@@d automatically when I run @@URXVT_NAME@@c?
354 79
355Rxvt-unicode will use whatever you specify as a font. If it needs to 80If you want to start @@URXVT_NAME@@d automatically whenever you run
356fall back to it's default font search list it will prefer X11 core 81@@URXVT_NAME@@c and the daemon isn't running yet, use this script:
357fonts, because they are small and fast, and then use Xft fonts. It has
358antialiasing disabled for most of them, because the author thinks they
359look best that way.
360 82
361If you want antialiasing, you have to specify the fonts manually. 83 #!/bin/sh
362
363=item Mouse cut/paste suddenly no longer works.
364
365Make sure that mouse reporting is actually turned off since killing
366some editors prematurely may leave the mouse in mouse report mode. I've
367heard that tcsh may use mouse reporting unless it otherwise specified. A
368quick check is to see if cut/paste works when the Alt or Shift keys are
369depressed. See @@RXVT_NAME@@(7)
370
371=item What's with this bold/blink stuff?
372
373If no bold colour is set via C<colorBD:>, bold will invert text using the
374standard foreground colour.
375
376For the standard background colour, blinking will actually make the
377text blink when compiled with C<--enable-blinking>. with standard
378colours. Without C<--enable-blinking>, the blink attribute will be
379ignored.
380
381On ANSI colours, bold/blink attributes are used to set high-intensity
382foreground/background colors.
383
384color0-7 are the low-intensity colors.
385
386color8-15 are the corresponding high-intensity colors.
387
388=item I don't like the screen colors. How do I change them?
389
390You can change the screen colors at run-time using F<~/.Xdefaults>
391resources (or as long-options).
392
393Here are values that are supposed to resemble a VGA screen,
394including the murky brown that passes for low-intensity yellow:
395
396 Rxvt*color0: #000000
397 Rxvt*color1: #A80000
398 Rxvt*color2: #00A800
399 Rxvt*color3: #A8A800
400 Rxvt*color4: #0000A8
401 Rxvt*color5: #A800A8
402 Rxvt*color6: #00A8A8
403 Rxvt*color7: #A8A8A8
404
405 Rxvt*color8: #000054
406 Rxvt*color9: #FF0054
407 Rxvt*color10: #00FF54
408 Rxvt*color11: #FFFF54
409 Rxvt*color12: #0000FF
410 Rxvt*color13: #FF00FF
411 Rxvt*color14: #00FFFF
412 Rxvt*color15: #FFFFFF
413
414=item What's with the strange Backspace/Delete key behaviour?
415
416Assuming that the physical Backspace key corresponds to the
417BackSpace keysym (not likely for Linux ... see the following
418question) there are two standard values that can be used for
419Backspace: C<^H> and C<^?>.
420
421Historically, either value is correct, but rxvt-unicode adopts the debian
422policy of using C<^?> when unsure, because it's the one only only correct
423choice :).
424
425Rxvt-unicode tries to inherit the current stty settings and uses the value
426of `erase' to guess the value for backspace. If rxvt-unicode wasn't
427started from a terminal (say, from a menu or by remote shell), then the
428system value of `erase', which corresponds to CERASE in <termios.h>, will
429be used (which may not be the same as your stty setting).
430
431For starting a new rxvt-unicode:
432
433 # use Backspace = ^H
434 $ stty erase ^H
435 $ @@RXVT_NAME@@ 84 @@URXVT_NAME@@c "$@"
436 85 if [ $? -eq 2 ]; then
437 # use Backspace = ^? 86 @@URXVT_NAME@@d -q -o -f
438 $ stty erase ^?
439 $ @@RXVT_NAME@@ 87 @@URXVT_NAME@@c "$@"
88 fi
440 89
441Toggle with "ESC[36h" / "ESC[36l" as documented in @@RXVT_NAME@@(7). 90This tries to create a new terminal, and if fails with exit status 2,
91meaning it couldn't connect to the daemon, it will start the daemon and
92re-run the command. Subsequent invocations of the script will re-use the
93existing daemon.
442 94
443For an existing rxvt-unicode: 95=head3 How do I distinguish whether I'm running rxvt-unicode or a regular xterm? I need this to decide about setting colors etc.
444 96
445 # use Backspace = ^H
446 $ stty erase ^H
447 $ echo -n "^[[36h"
448
449 # use Backspace = ^?
450 $ stty erase ^?
451 $ echo -n "^[[36l"
452
453This helps satisfy some of the Backspace discrepancies that occur, but
454if you use Backspace = C<^H>, make sure that the termcap/terminfo value
455properly reflects that.
456
457The Delete key is a another casualty of the ill-defined Backspace problem.
458To avoid confusion between the Backspace and Delete keys, the Delete
459key has been assigned an escape sequence to match the vt100 for Execute
460(ESC[3~) and is in the supplied termcap/terminfo.
461
462Some other Backspace problems:
463
464some editors use termcap/terminfo,
465some editors (vim I'm told) expect Backspace = ^H,
466GNU Emacs (and Emacs-like editors) use ^H for help.
467
468Perhaps someday this will all be resolved in a consistent manner.
469
470=item I don't like the key-bindings. How do I change them?
471
472There are some compile-time selections available via configure. Unless
473you have run "configure" with the C<--disable-resources> option you can
474use the `keysym' resource to alter the keystrings associated with keysym
4750xFF00 - 0xFFFF (function, cursor keys, etc).
476
477Here's an example for a tn3270 session started using `@@RXVT_NAME@@ -name tn3270'
478
479 !# ----- special uses ------:
480 ! tn3270 login, remap function and arrow keys.
481 tn3270*font: *clean-bold-*-*--15-*
482
483 ! keysym - used by rxvt only
484 ! Delete - ^D
485 tn3270*keysym.0xFFFF: \004
486
487 ! Home - ^A
488 tn3270*keysym.0xFF50: \001
489 ! Left - ^B
490 tn3270*keysym.0xFF51: \002
491 ! Up - ^P
492 tn3270*keysym.0xFF52: \020
493 ! Right - ^F
494 tn3270*keysym.0xFF53: \006
495 ! Down - ^N
496 tn3270*keysym.0xFF54: \016
497 ! End - ^E
498 tn3270*keysym.0xFF57: \005
499
500 ! F1 - F12
501 tn3270*keysym.0xFFBE: \e1
502 tn3270*keysym.0xFFBF: \e2
503 tn3270*keysym.0xFFC0: \e3
504 tn3270*keysym.0xFFC1: \e4
505 tn3270*keysym.0xFFC2: \e5
506 tn3270*keysym.0xFFC3: \e6
507 tn3270*keysym.0xFFC4: \e7
508 tn3270*keysym.0xFFC5: \e8
509 tn3270*keysym.0xFFC6: \e9
510 tn3270*keysym.0xFFC7: \e0
511 tn3270*keysym.0xFFC8: \e-
512 tn3270*keysym.0xFFC9: \e=
513
514 ! map Prior/Next to F7/F8
515 tn3270*keysym.0xFF55: \e7
516 tn3270*keysym.0xFF56: \e8
517
518=item I'm using keyboard model XXX that has extra Prior/Next/Insert keys.
519How do I make use of them? For example, the Sun Keyboard type 4
520has the following mappings that rxvt-unicode doesn't recognize.
521
522 KP_Insert == Insert
523 F22 == Print
524 F27 == Home
525 F29 == Prior
526 F33 == End
527 F35 == Next
528
529Rather than have rxvt-unicode try to accommodate all the various possible keyboard
530mappings, it is better to use `xmodmap' to remap the keys as required for
531your particular machine.
532
533=item How do I distinguish if I'm running rxvt-unicode or a regular xterm?
534I need this to decide about setting colors etc.
535
536rxvt and rxvt-unicode always export the variable "COLORTERM", so you can 97The original rxvt and rxvt-unicode always export the variable "COLORTERM",
537check and see if that is set. Note that several programs, JED, slrn, 98so you can check and see if that is set. Note that several programs, JED,
538Midnight Commander automatically check this variable to decide whether or 99slrn, Midnight Commander automatically check this variable to decide
539not to use color. 100whether or not to use color.
540 101
541=item How do I set the correct, full IP address for the DISPLAY variable? 102=head3 How do I set the correct, full IP address for the DISPLAY variable?
542 103
543If you've compiled rxvt-unicode with DISPLAY_IS_IP and have enabled 104If you've compiled rxvt-unicode with DISPLAY_IS_IP and have enabled
544insecure mode then it is possible to use the following shell script 105insecure mode then it is possible to use the following shell script
545snippets to correctly set the display. If your version of rxvt-unicode 106snippets to correctly set the display. If your version of rxvt-unicode
546wasn't also compiled with ESCZ_ANSWER (as assumed in these snippets) then 107wasn't also compiled with ESCZ_ANSWER (as assumed in these snippets) then
556 stty -icanon -echo min 0 time 15 # see if enhanced rxvt or not 117 stty -icanon -echo min 0 time 15 # see if enhanced rxvt or not
557 echo -n '^[Z' 118 echo -n '^[Z'
558 read term_id 119 read term_id
559 stty icanon echo 120 stty icanon echo
560 if [ ""${term_id} = '^[[?1;2C' -a ${DISPLAY:-foo} = foo ]; then 121 if [ ""${term_id} = '^[[?1;2C' -a ${DISPLAY:-foo} = foo ]; then
561 echo -n '^[[7n' # query the rxvt we are in for the DISPLAY string 122 echo -n '^[[7n' # query the rxvt we are in for the DISPLAY string
562 read DISPLAY # set it in our local shell 123 read DISPLAY # set it in our local shell
563 fi 124 fi
564 fi 125 fi
565 126
566=item How do I compile the manual pages for myself? 127=head3 How do I compile the manual pages on my own?
567 128
568You need to have a recent version of perl installed as F</usr/bin/perl>, 129You need to have a recent version of perl installed as F</usr/bin/perl>,
569one that comes with F<pod2man>, F<pod2text> and F<pod2html>. Then go to 130one that comes with F<pod2man>, F<pod2text> and F<pod2xhtml> (from
570the doc subdirectory and enter C<make alldoc>. 131F<Pod::Xhtml>). Then go to the doc subdirectory and enter C<make alldoc>.
132
133=head3 Isn't rxvt-unicode supposed to be small? Don't all those features bloat?
134
135I often get asked about this, and I think, no, they didn't cause extra
136bloat. If you compare a minimal rxvt and a minimal urxvt, you can see
137that the urxvt binary is larger (due to some encoding tables always being
138compiled in), but it actually uses less memory (RSS) after startup. Even
139with C<--disable-everything>, this comparison is a bit unfair, as many
140features unique to urxvt (locale, encoding conversion, iso14755 etc.) are
141already in use in this mode.
142
143 text data bss drs rss filename
144 98398 1664 24 15695 1824 rxvt --disable-everything
145 188985 9048 66616 18222 1788 urxvt --disable-everything
146
147When you C<--enable-everything> (which I<is> unfair, as this involves xft
148and full locale/XIM support which are quite bloaty inside libX11 and my
149libc), the two diverge, but not unreasonably so.
150
151 text data bss drs rss filename
152 163431 2152 24 20123 2060 rxvt --enable-everything
153 1035683 49680 66648 29096 3680 urxvt --enable-everything
154
155The very large size of the text section is explained by the east-asian
156encoding tables, which, if unused, take up disk space but nothing else
157and can be compiled out unless you rely on X11 core fonts that use those
158encodings. The BSS size comes from the 64k emergency buffer that my c++
159compiler allocates (but of course doesn't use unless you are out of
160memory). Also, using an xft font instead of a core font immediately adds a
161few megabytes of RSS. Xft indeed is responsible for a lot of RSS even when
162not used.
163
164Of course, due to every character using two or four bytes instead of one,
165a large scrollback buffer will ultimately make rxvt-unicode use more
166memory.
167
168Compared to e.g. Eterm (5112k), aterm (3132k) and xterm (4680k), this
169still fares rather well. And compared to some monsters like gnome-terminal
170(21152k + extra 4204k in separate processes) or konsole (22200k + extra
17143180k in daemons that stay around after exit, plus half a minute of
172startup time, including the hundreds of warnings it spits out), it fares
173extremely well *g*.
174
175=head3 Why C++, isn't that unportable/bloated/uncool?
176
177Is this a question? :) It comes up very often. The simple answer is: I had
178to write it, and C++ allowed me to write and maintain it in a fraction
179of the time and effort (which is a scarce resource for me). Put even
180shorter: It simply wouldn't exist without C++.
181
182My personal stance on this is that C++ is less portable than C, but in
183the case of rxvt-unicode this hardly matters, as its portability limits
184are defined by things like X11, pseudo terminals, locale support and unix
185domain sockets, which are all less portable than C++ itself.
186
187Regarding the bloat, see the above question: It's easy to write programs
188in C that use gobs of memory, an certainly possible to write programs in
189C++ that don't. C++ also often comes with large libraries, but this is
190not necessarily the case with GCC. Here is what rxvt links against on my
191system with a minimal config:
192
193 libX11.so.6 => /usr/X11R6/lib/libX11.so.6 (0x00002aaaaabc3000)
194 libc.so.6 => /lib/libc.so.6 (0x00002aaaaadde000)
195 libdl.so.2 => /lib/libdl.so.2 (0x00002aaaab01d000)
196 /lib64/ld-linux-x86-64.so.2 (0x00002aaaaaaab000)
197
198And here is rxvt-unicode:
199
200 libX11.so.6 => /usr/X11R6/lib/libX11.so.6 (0x00002aaaaabc3000)
201 libgcc_s.so.1 => /lib/libgcc_s.so.1 (0x00002aaaaada2000)
202 libc.so.6 => /lib/libc.so.6 (0x00002aaaaaeb0000)
203 libdl.so.2 => /lib/libdl.so.2 (0x00002aaaab0ee000)
204 /lib64/ld-linux-x86-64.so.2 (0x00002aaaaaaab000)
205
206No large bloated libraries (of course, none were linked in statically),
207except maybe libX11 :)
208
209
210=head2 Rendering, Font & Look and Feel Issues
211
212=head3 I can't get transparency working, what am I doing wrong?
213
214First of all, please address all transparency related issues to Sasha Vasko at
215sasha@aftercode.net and do not bug the author about it. Also, if you can't
216get it working consider it a rite of passage: ... and you failed.
217
218Here are four ways to get transparency. B<Do> read the manpage and option
219descriptions for the programs mentioned and rxvt-unicode. Really, do it!
220
2211. Use transparent mode:
222
223 Esetroot wallpaper.jpg
224 @@URXVT_NAME@@ -tr -tint red -sh 40
225
226That works. If you think it doesn't, you lack transparency and tinting
227support, or you are unable to read.
228
2292. Use a simple pixmap and emulate pseudo-transparency. This enables you
230to use effects other than tinting and shading: Just shade/tint/whatever
231your picture with gimp or any other tool:
232
233 convert wallpaper.jpg -blur 20x20 -modulate 30 background.jpg
234 @@URXVT_NAME@@ -pixmap "background.jpg;:root"
235
236That works. If you think it doesn't, you lack AfterImage support, or you
237are unable to read.
238
2393. Use an ARGB visual:
240
241 @@URXVT_NAME@@ -depth 32 -fg grey90 -bg rgba:0000/0000/4444/cccc
242
243This requires XFT support, and the support of your X-server. If that
244doesn't work for you, blame Xorg and Keith Packard. ARGB visuals aren't
245there yet, no matter what they claim. Rxvt-Unicode contains the necessary
246bugfixes and workarounds for Xft and Xlib to make it work, but that
247doesn't mean that your WM has the required kludges in place.
248
2494. Use xcompmgr and let it do the job:
250
251 xprop -frame -f _NET_WM_WINDOW_OPACITY 32c \
252 -set _NET_WM_WINDOW_OPACITY 0xc0000000
253
254Then click on a window you want to make transparent. Replace C<0xc0000000>
255by other values to change the degree of opacity. If it doesn't work and
256your server crashes, you got to keep the pieces.
257
258=head3 Why does rxvt-unicode sometimes leave pixel droppings?
259
260Most fonts were not designed for terminal use, which means that character
261size varies a lot. A font that is otherwise fine for terminal use might
262contain some characters that are simply too wide. Rxvt-unicode will avoid
263these characters. For characters that are just "a bit" too wide a special
264"careful" rendering mode is used that redraws adjacent characters.
265
266All of this requires that fonts do not lie about character sizes,
267however: Xft fonts often draw glyphs larger than their acclaimed bounding
268box, and rxvt-unicode has no way of detecting this (the correct way is to
269ask for the character bounding box, which unfortunately is wrong in these
270cases).
271
272It's not clear (to me at least), whether this is a bug in Xft, freetype,
273or the respective font. If you encounter this problem you might try using
274the C<-lsp> option to give the font more height. If that doesn't work, you
275might be forced to use a different font.
276
277All of this is not a problem when using X11 core fonts, as their bounding
278box data is correct.
279
280=head3 How can I keep rxvt-unicode from using reverse video so much?
281
282First of all, make sure you are running with the right terminal settings
283(C<TERM=rxvt-unicode>), which will get rid of most of these effects. Then
284make sure you have specified colours for italic and bold, as otherwise
285rxvt-unicode might use reverse video to simulate the effect:
286
287 URxvt.colorBD: white
288 URxvt.colorIT: green
289
290=head3 Some programs assume totally weird colours (red instead of blue), how can I fix that?
291
292For some unexplainable reason, some rare programs assume a very weird
293colour palette when confronted with a terminal with more than the standard
2948 colours (rxvt-unicode supports 88). The right fix is, of course, to fix
295these programs not to assume non-ISO colours without very good reasons.
296
297In the meantime, you can either edit your C<rxvt-unicode> terminfo
298definition to only claim 8 colour support or use C<TERM=rxvt>, which will
299fix colours but keep you from using other rxvt-unicode features.
300
301=head3 Can I switch the fonts at runtime?
302
303Yes, using an escape sequence. Try something like this, which has the same
304effect as using the C<-fn> switch, and takes effect immediately:
305
306 printf '\33]50;%s\007' "9x15bold,xft:Kochi Gothic"
307
308This is useful if you e.g. work primarily with japanese (and prefer a
309japanese font), but you have to switch to chinese temporarily, where
310japanese fonts would only be in your way.
311
312You can think of this as a kind of manual ISO-2022 switching.
313
314=head3 Why do italic characters look as if clipped?
315
316Many fonts have difficulties with italic characters and hinting. For
317example, the otherwise very nicely hinted font C<xft:Bitstream Vera Sans
318Mono> completely fails in its italic face. A workaround might be to
319enable freetype autohinting, i.e. like this:
320
321 URxvt.italicFont: xft:Bitstream Vera Sans Mono:italic:autohint=true
322 URxvt.boldItalicFont: xft:Bitstream Vera Sans Mono:bold:italic:autohint=true
323
324=head3 Can I speed up Xft rendering somehow?
325
326Yes, the most obvious way to speed it up is to avoid Xft entirely, as
327it is simply slow. If you still want Xft fonts you might try to disable
328antialiasing (by appending C<:antialias=false>), which saves lots of
329memory and also speeds up rendering considerably.
330
331=head3 Rxvt-unicode doesn't seem to anti-alias its fonts, what is wrong?
332
333Rxvt-unicode will use whatever you specify as a font. If it needs to
334fall back to its default font search list it will prefer X11 core
335fonts, because they are small and fast, and then use Xft fonts. It has
336antialiasing disabled for most of them, because the author thinks they
337look best that way.
338
339If you want antialiasing, you have to specify the fonts manually.
340
341=head3 What's with this bold/blink stuff?
342
343If no bold colour is set via C<colorBD:>, bold will invert text using the
344standard foreground colour.
345
346For the standard background colour, blinking will actually make
347the text blink when compiled with C<--enable-text-blink>. Without
348C<--enable-text-blink>, the blink attribute will be ignored.
349
350On ANSI colours, bold/blink attributes are used to set high-intensity
351foreground/background colors.
352
353color0-7 are the low-intensity colors.
354
355color8-15 are the corresponding high-intensity colors.
356
357=head3 I don't like the screen colors. How do I change them?
358
359You can change the screen colors at run-time using F<~/.Xdefaults>
360resources (or as long-options).
361
362Here are values that are supposed to resemble a VGA screen,
363including the murky brown that passes for low-intensity yellow:
364
365 URxvt.color0: #000000
366 URxvt.color1: #A80000
367 URxvt.color2: #00A800
368 URxvt.color3: #A8A800
369 URxvt.color4: #0000A8
370 URxvt.color5: #A800A8
371 URxvt.color6: #00A8A8
372 URxvt.color7: #A8A8A8
373
374 URxvt.color8: #000054
375 URxvt.color9: #FF0054
376 URxvt.color10: #00FF54
377 URxvt.color11: #FFFF54
378 URxvt.color12: #0000FF
379 URxvt.color13: #FF00FF
380 URxvt.color14: #00FFFF
381 URxvt.color15: #FFFFFF
382
383And here is a more complete set of non-standard colors.
384
385 URxvt.cursorColor: #dc74d1
386 URxvt.pointerColor: #dc74d1
387 URxvt.background: #0e0e0e
388 URxvt.foreground: #4ad5e1
389 URxvt.color0: #000000
390 URxvt.color8: #8b8f93
391 URxvt.color1: #dc74d1
392 URxvt.color9: #dc74d1
393 URxvt.color2: #0eb8c7
394 URxvt.color10: #0eb8c7
395 URxvt.color3: #dfe37e
396 URxvt.color11: #dfe37e
397 URxvt.color5: #9e88f0
398 URxvt.color13: #9e88f0
399 URxvt.color6: #73f7ff
400 URxvt.color14: #73f7ff
401 URxvt.color7: #e1dddd
402 URxvt.color15: #e1dddd
403
404They have been described (not by me) as "pretty girly".
405
406=head3 Why do some characters look so much different than others?
407
408See next entry.
409
410=head3 How does rxvt-unicode choose fonts?
411
412Most fonts do not contain the full range of Unicode, which is
413fine. Chances are that the font you (or the admin/package maintainer of
414your system/os) have specified does not cover all the characters you want
415to display.
416
417B<rxvt-unicode> makes a best-effort try at finding a replacement
418font. Often the result is fine, but sometimes the chosen font looks
419bad/ugly/wrong. Some fonts have totally strange characters that don't
420resemble the correct glyph at all, and rxvt-unicode lacks the artificial
421intelligence to detect that a specific glyph is wrong: it has to believe
422the font that the characters it claims to contain indeed look correct.
423
424In that case, select a font of your taste and add it to the font list,
425e.g.:
426
427 @@URXVT_NAME@@ -fn basefont,font2,font3...
428
429When rxvt-unicode sees a character, it will first look at the base
430font. If the base font does not contain the character, it will go to the
431next font, and so on. Specifying your own fonts will also speed up this
432search and use less resources within rxvt-unicode and the X-server.
433
434The only limitation is that none of the fonts may be larger than the base
435font, as the base font defines the terminal character cell size, which
436must be the same due to the way terminals work.
437
438=head3 Why do some chinese characters look so different than others?
439
440This is because there is a difference between script and language --
441rxvt-unicode does not know which language the text that is output is,
442as it only knows the unicode character codes. If rxvt-unicode first
443sees a japanese/chinese character, it might choose a japanese font for
444display. Subsequent japanese characters will use that font. Now, many
445chinese characters aren't represented in japanese fonts, so when the first
446non-japanese character comes up, rxvt-unicode will look for a chinese font
447-- unfortunately at this point, it will still use the japanese font for
448chinese characters that are also in the japanese font.
449
450The workaround is easy: just tag a chinese font at the end of your font
451list (see the previous question). The key is to view the font list as
452a preference list: If you expect more japanese, list a japanese font
453first. If you expect more chinese, put a chinese font first.
454
455In the future it might be possible to switch language preferences at
456runtime (the internal data structure has no problem with using different
457fonts for the same character at the same time, but no interface for this
458has been designed yet).
459
460Until then, you might get away with switching fonts at runtime (see L<Can
461I switch the fonts at runtime?> later in this document).
462
463=head3 How can I make mplayer display video correctly?
464
465We are working on it, in the meantime, as a workaround, use something like:
466
467 @@URXVT_NAME@@ -b 600 -geometry 20x1 -e sh -c 'mplayer -wid $WINDOWID file...'
468
469
470=head2 Keyboard, Mouse & User Interaction
471
472=head3 The new selection selects pieces that are too big, how can I select single words?
473
474If you want to select e.g. alphanumeric words, you can use the following
475setting:
476
477 URxvt.selection.pattern-0: ([[:word:]]+)
478
479If you click more than twice, the selection will be extended
480more and more.
481
482To get a selection that is very similar to the old code, try this pattern:
483
484 URxvt.selection.pattern-0: ([^"&'()*,;<=>?@[\\\\]^`{|})]+)
485
486Please also note that the I<LeftClick Shift-LeftClik> combination also
487selects words like the old code.
488
489=head3 I don't like the new selection/popups/hotkeys/perl, how do I change/disable it?
490
491You can disable the perl extension completely by setting the
492B<perl-ext-common> resource to the empty string, which also keeps
493rxvt-unicode from initialising perl, saving memory.
494
495If you only want to disable specific features, you first have to
496identify which perl extension is responsible. For this, read the section
497B<PREPACKAGED EXTENSIONS> in the @@URXVT_NAME@@perl(3) manpage. For
498example, to disable the B<selection-popup> and B<option-popup>, specify
499this B<perl-ext-common> resource:
500
501 URxvt.perl-ext-common: default,-selection-popup,-option-popup
502
503This will keep the default extensions, but disable the two popup
504extensions. Some extensions can also be configured, for example,
505scrollback search mode is triggered by B<M-s>. You can move it to any
506other combination either by setting the B<searchable-scrollback> resource:
507
508 URxvt.searchable-scrollback: CM-s
509
510=head3 The cursor moves when selecting text in the current input line, how do I switch this off?
511
512See next entry.
513
514=head3 During rlogin/ssh/telnet/etc. sessions, clicking near the cursor outputs strange escape sequences, how do I fix this?
515
516These are caused by the C<readline> perl extension. Under normal
517circumstances, it will move your cursor around when you click into the
518line that contains it. It tries hard not to do this at the wrong moment,
519but when running a program that doesn't parse cursor movements or in some
520cases during rlogin sessions, it fails to detect this properly.
521
522You can permanently switch this feature off by disabling the C<readline>
523extension:
524
525 URxvt.perl-ext-common: default,-readline
526
527=head3 My numerical keypad acts weird and generates differing output?
528
529Some Debian GNUL/Linux users seem to have this problem, although no
530specific details were reported so far. It is possible that this is caused
531by the wrong C<TERM> setting, although the details of whether and how
532this can happen are unknown, as C<TERM=rxvt> should offer a compatible
533keymap. See the answer to the previous question, and please report if that
534helped.
535
536=head3 My Compose (Multi_key) key is no longer working.
537
538The most common causes for this are that either your locale is not set
539correctly, or you specified a B<preeditStyle> that is not supported by
540your input method. For example, if you specified B<OverTheSpot> and
541your input method (e.g. the default input method handling Compose keys)
542does not support this (for instance because it is not visual), then
543rxvt-unicode will continue without an input method.
544
545In this case either do not specify a B<preeditStyle> or specify more than
546one pre-edit style, such as B<OverTheSpot,Root,None>.
547
548=head3 I cannot type C<Ctrl-Shift-2> to get an ASCII NUL character due to ISO 14755
549
550Either try C<Ctrl-2> alone (it often is mapped to ASCII NUL even on
551international keyboards) or simply use ISO 14755 support to your
552advantage, typing <Ctrl-Shift-0> to get a ASCII NUL. This works for other
553codes, too, such as C<Ctrl-Shift-1-d> to type the default telnet escape
554character and so on.
555
556=head3 Mouse cut/paste suddenly no longer works.
557
558Make sure that mouse reporting is actually turned off since killing
559some editors prematurely may leave the mouse in mouse report mode. I've
560heard that tcsh may use mouse reporting unless it otherwise specified. A
561quick check is to see if cut/paste works when the Alt or Shift keys are
562depressed.
563
564=head3 What's with the strange Backspace/Delete key behaviour?
565
566Assuming that the physical Backspace key corresponds to the
567Backspace keysym (not likely for Linux ... see the following
568question) there are two standard values that can be used for
569Backspace: C<^H> and C<^?>.
570
571Historically, either value is correct, but rxvt-unicode adopts the debian
572policy of using C<^?> when unsure, because it's the one and only correct
573choice :).
574
575Rxvt-unicode tries to inherit the current stty settings and uses the value
576of `erase' to guess the value for backspace. If rxvt-unicode wasn't
577started from a terminal (say, from a menu or by remote shell), then the
578system value of `erase', which corresponds to CERASE in <termios.h>, will
579be used (which may not be the same as your stty setting).
580
581For starting a new rxvt-unicode:
582
583 # use Backspace = ^H
584 $ stty erase ^H
585 $ @@URXVT_NAME@@
586
587 # use Backspace = ^?
588 $ stty erase ^?
589 $ @@URXVT_NAME@@
590
591Toggle with C<ESC [ 36 h> / C<ESC [ 36 l>.
592
593For an existing rxvt-unicode:
594
595 # use Backspace = ^H
596 $ stty erase ^H
597 $ echo -n "^[[36h"
598
599 # use Backspace = ^?
600 $ stty erase ^?
601 $ echo -n "^[[36l"
602
603This helps satisfy some of the Backspace discrepancies that occur, but
604if you use Backspace = C<^H>, make sure that the termcap/terminfo value
605properly reflects that.
606
607The Delete key is a another casualty of the ill-defined Backspace problem.
608To avoid confusion between the Backspace and Delete keys, the Delete
609key has been assigned an escape sequence to match the vt100 for Execute
610(C<ESC [ 3 ~>) and is in the supplied termcap/terminfo.
611
612Some other Backspace problems:
613
614some editors use termcap/terminfo,
615some editors (vim I'm told) expect Backspace = ^H,
616GNU Emacs (and Emacs-like editors) use ^H for help.
617
618Perhaps someday this will all be resolved in a consistent manner.
619
620=head3 I don't like the key-bindings. How do I change them?
621
622There are some compile-time selections available via configure. Unless
623you have run "configure" with the C<--disable-resources> option you can
624use the `keysym' resource to alter the keystrings associated with keysyms.
625
626Here's an example for a URxvt session started using C<@@URXVT_NAME@@ -name URxvt>
627
628 URxvt.keysym.Home: \033[1~
629 URxvt.keysym.End: \033[4~
630 URxvt.keysym.C-apostrophe: \033<C-'>
631 URxvt.keysym.C-slash: \033<C-/>
632 URxvt.keysym.C-semicolon: \033<C-;>
633 URxvt.keysym.C-grave: \033<C-`>
634 URxvt.keysym.C-comma: \033<C-,>
635 URxvt.keysym.C-period: \033<C-.>
636 URxvt.keysym.C-0x60: \033<C-`>
637 URxvt.keysym.C-Tab: \033<C-Tab>
638 URxvt.keysym.C-Return: \033<C-Return>
639 URxvt.keysym.S-Return: \033<S-Return>
640 URxvt.keysym.S-space: \033<S-Space>
641 URxvt.keysym.M-Up: \033<M-Up>
642 URxvt.keysym.M-Down: \033<M-Down>
643 URxvt.keysym.M-Left: \033<M-Left>
644 URxvt.keysym.M-Right: \033<M-Right>
645 URxvt.keysym.M-C-0: list \033<M-C- 0123456789 >
646 URxvt.keysym.M-C-a: list \033<M-C- abcdefghijklmnopqrstuvwxyz >
647 URxvt.keysym.F12: command:\033]701;zh_CN.GBK\007
648
649See some more examples in the documentation for the B<keysym> resource.
650
651=head3 I'm using keyboard model XXX that has extra Prior/Next/Insert keys. How do I make use of them? For example, the Sun Keyboard type 4 has the following map
652
653 KP_Insert == Insert
654 F22 == Print
655 F27 == Home
656 F29 == Prior
657 F33 == End
658 F35 == Next
659
660Rather than have rxvt-unicode try to accommodate all the various possible
661keyboard mappings, it is better to use `xmodmap' to remap the keys as
662required for your particular machine.
663
664
665=head2 Terminal Configuration
666
667=head3 Can I see a typical configuration?
668
669The default configuration tries to be xterm-like, which I don't like that
670much, but it's least surprise to regular users.
671
672As a rxvt or rxvt-unicode user, you are practically supposed to invest
673time into customising your terminal. To get you started, here is the
674author's .Xdefaults entries, with comments on what they do. It's certainly
675not I<typical>, but what's typical...
676
677 URxvt.cutchars: "()*,<>[]{}|'
678 URxvt.print-pipe: cat >/tmp/xxx
679
680These are just for testing stuff.
681
682 URxvt.imLocale: ja_JP.UTF-8
683 URxvt.preeditType: OnTheSpot,None
684
685This tells rxvt-unicode to use a special locale when communicating with
686the X Input Method, and also tells it to only use the OnTheSpot pre-edit
687type, which requires the C<xim-onthespot> perl extension but rewards me
688with correct-looking fonts.
689
690 URxvt.perl-lib: /root/lib/urxvt
691 URxvt.perl-ext-common: default,selection-autotransform,selection-pastebin,xim-onthespot,remote-clipboard
692 URxvt.selection.pattern-0: ( at .*? line \\d+)
693 URxvt.selection.pattern-1: ^(/[^:]+):\
694 URxvt.selection-autotransform.0: s/^([^:[:space:]]+):(\\d+):?$/:e \\Q$1\\E\\x0d:$2\\x0d/
695 URxvt.selection-autotransform.1: s/^ at (.*?) line (\\d+)$/:e \\Q$1\\E\\x0d:$2\\x0d/
696
697This is my perl configuration. The first two set the perl library
698directory and also tells urxvt to use a large number of extensions. I
699develop for myself mostly, so I actually use most of the extensions I
700write.
701
702The selection stuff mainly makes the selection perl-error-message aware
703and tells it to convert perl error messages into vi-commands to load the
704relevant file and go tot he error line number.
705
706 URxvt.scrollstyle: plain
707 URxvt.secondaryScroll: true
708
709As the documentation says: plain is the preferred scrollbar for the
710author. The C<secondaryScroll> configures urxvt to scroll in full-screen
711apps, like screen, so lines scrolled out of screen end up in urxvt's
712scrollback buffer.
713
714 URxvt.background: #000000
715 URxvt.foreground: gray90
716 URxvt.color7: gray90
717 URxvt.colorBD: #ffffff
718 URxvt.cursorColor: #e0e080
719 URxvt.throughColor: #8080f0
720 URxvt.highlightColor: #f0f0f0
721
722Some colours. Not sure which ones are being used or even non-defaults, but
723these are in my .Xdefaults. Most notably, they set foreground/background
724to light gray/black, and also make sure that the colour 7 matches the
725default foreground colour.
726
727 URxvt.underlineColor: yellow
728
729Another colour, makes underline lines look different. Sometimes hurts, but
730is mostly a nice effect.
731
732 URxvt.geometry: 154x36
733 URxvt.loginShell: false
734 URxvt.meta: ignore
735 URxvt.utmpInhibit: true
736
737Uh, well, should be mostly self-explanatory. By specifying some defaults
738manually, I can quickly switch them for testing.
739
740 URxvt.saveLines: 8192
741
742A large scrollback buffer is essential. Really.
743
744 URxvt.mapAlert: true
745
746The only case I use it is for my IRC window, which I like to keep
747iconified till people msg me (which beeps).
748
749 URxvt.visualBell: true
750
751The audible bell is often annoying, especially when in a crowd.
752
753 URxvt.insecure: true
754
755Please don't hack my mutt! Ooops...
756
757 URxvt.pastableTabs: false
758
759I once thought this is a great idea.
760
761 urxvt.font: 9x15bold,\
762 -misc-fixed-bold-r-normal--15-140-75-75-c-90-iso10646-1,\
763 -misc-fixed-medium-r-normal--15-140-75-75-c-90-iso10646-1, \
764 [codeset=JISX0208]xft:Kochi Gothic, \
765 xft:Bitstream Vera Sans Mono:autohint=true, \
766 xft:Code2000:antialias=false
767 urxvt.boldFont: -xos4-terminus-bold-r-normal--14-140-72-72-c-80-iso8859-15
768 urxvt.italicFont: xft:Bitstream Vera Sans Mono:italic:autohint=true
769 urxvt.boldItalicFont: xft:Bitstream Vera Sans Mono:bold:italic:autohint=true
770
771I wrote rxvt-unicode to be able to specify fonts exactly. So don't be
772overwhelmed. A special note: the C<9x15bold> mentioned above is actually
773the version from XFree-3.3, as XFree-4 replaced it by a totally different
774font (different glyphs for C<;> and many other harmless characters),
775while the second font is actually the C<9x15bold> from XFree4/XOrg. The
776bold version has less chars than the medium version, so I use it for rare
777characters, too. When editing sources with vim, I use italic for comments
778and other stuff, which looks quite good with Bitstream Vera anti-aliased.
779
780Terminus is a quite bad font (many very wrong glyphs), but for most of my
781purposes, it works, and gives a different look, as my normal (Non-bold)
782font is already bold, and I want to see a difference between bold and
783normal fonts.
784
785Please note that I used the C<urxvt> instance name and not the C<URxvt>
786class name. Thats because I use different configs for different purposes,
787for example, my IRC window is started with C<-name IRC>, and uses these
788defaults:
789
790 IRC*title: IRC
791 IRC*geometry: 87x12+535+542
792 IRC*saveLines: 0
793 IRC*mapAlert: true
794 IRC*font: suxuseuro
795 IRC*boldFont: suxuseuro
796 IRC*colorBD: white
797 IRC*keysym.M-C-1: command:\033]710;suxuseuro\007\033]711;suxuseuro\007
798 IRC*keysym.M-C-2: command:\033]710;9x15bold\007\033]711;9x15bold\007
799
800C<Alt-Shift-1> and C<Alt-Shift-2> switch between two different font
801sizes. C<suxuseuro> allows me to keep an eye (and actually read)
802stuff while keeping a very small window. If somebody pastes something
803complicated (e.g. japanese), I temporarily switch to a larger font.
804
805The above is all in my C<.Xdefaults> (I don't use C<.Xresources> nor
806C<xrdb>). I also have some resources in a separate C<.Xdefaults-hostname>
807file for different hosts, for example, on ym main desktop, I use:
808
809 URxvt.keysym.C-M-q: command:\033[3;5;5t
810 URxvt.keysym.C-M-y: command:\033[3;5;606t
811 URxvt.keysym.C-M-e: command:\033[3;1605;5t
812 URxvt.keysym.C-M-c: command:\033[3;1605;606t
813 URxvt.keysym.C-M-p: perl:test
814
815The first for keysym definitions allow me to quickly bring some windows
816in the layout I like most. Ion users might start laughing but will stop
817immediately when I tell them that I use my own Fvwm2 module for much the
818same effect as Ion provides, and I only very rarely use the above key
819combinations :->
820
821=head3 Why doesn't rxvt-unicode read my resources?
822
823Well, why, indeed? It does, in a way very similar to other X
824applications. Most importantly, this means that if you or your OS loads
825resources into the X display (the right way to do it), rxvt-unicode will
826ignore any resource files in your home directory. It will only read
827F<$HOME/.Xdefaults> when no resources are attached to the display.
828
829If you have or use an F<$HOME/.Xresources> file, chances are that
830resources are loaded into your X-server. In this case, you have to
831re-login after every change (or run F<xrdb -merge $HOME/.Xresources>).
832
833Also consider the form resources have to use:
834
835 URxvt.resource: value
836
837If you want to use another form (there are lots of different ways of
838specifying resources), make sure you understand whether and why it
839works. If unsure, use the form above.
840
841=head3 When I log-in to another system it tells me about missing terminfo data?
842
843The terminal description used by rxvt-unicode is not as widely available
844as that for xterm, or even rxvt (for which the same problem often arises).
845
846The correct solution for this problem is to install the terminfo, this can
847be done like this (with ncurses' infocmp and works as user and admin):
848
849 REMOTE=remotesystem.domain
850 infocmp rxvt-unicode | ssh $REMOTE "mkdir -p .terminfo && cat >/tmp/ti && tic /tmp/ti"
851
852... or by installing rxvt-unicode normally on the remote system,
853
854One some systems you might need to set C<$TERMINFO> to the full path of
855F<$HOME/.terminfo> for this to work.
856
857If you cannot or do not want to do this, then you can simply set
858C<TERM=rxvt> or even C<TERM=xterm>, and live with the small number of
859problems arising, which includes wrong keymapping, less and different
860colours and some refresh errors in fullscreen applications. It's a nice
861quick-and-dirty workaround for rare cases, though.
862
863If you always want to do this (and are fine with the consequences) you
864can either recompile rxvt-unicode with the desired TERM value or use a
865resource to set it:
866
867 URxvt.termName: rxvt
868
869If you don't plan to use B<rxvt> (quite common...) you could also replace
870the rxvt terminfo file with the rxvt-unicode one and use C<TERM=rxvt>.
871
872=head3 C<tic> outputs some error when compiling the terminfo entry.
873
874Most likely it's the empty definition for C<enacs=>. Just replace it by
875C<enacs=\E[0@> and try again.
876
877=head3 C<bash>'s readline does not work correctly under @@URXVT_NAME@@.
878
879See next entry.
880
881=head3 I need a termcap file entry.
882
883One reason you might want this is that some distributions or operating
884systems still compile some programs using the long-obsoleted termcap
885library (Fedora Core's bash is one example) and rely on a termcap entry
886for C<rxvt-unicode>.
887
888You could use rxvt's termcap entry with reasonable results in many cases.
889You can also create a termcap entry by using terminfo's infocmp program
890like this:
891
892 infocmp -C rxvt-unicode
893
894Or you could use this termcap entry, generated by the command above:
895
896 rxvt-unicode|rxvt-unicode terminal (X Window System):\
897 :am:bw:eo:km:mi:ms:xn:xo:\
898 :co#80:it#8:li#24:lm#0:\
899 :AL=\E[%dL:DC=\E[%dP:DL=\E[%dM:DO=\E[%dB:IC=\E[%d@:\
900 :K1=\EOw:K2=\EOu:K3=\EOy:K4=\EOq:K5=\EOs:LE=\E[%dD:\
901 :RI=\E[%dC:SF=\E[%dS:SR=\E[%dT:UP=\E[%dA:ae=\E(B:al=\E[L:\
902 :as=\E(0:bl=^G:cd=\E[J:ce=\E[K:cl=\E[H\E[2J:\
903 :cm=\E[%i%d;%dH:cr=^M:cs=\E[%i%d;%dr:ct=\E[3g:dc=\E[P:\
904 :dl=\E[M:do=^J:ec=\E[%dX:ei=\E[4l:ho=\E[H:\
905 :i1=\E[?47l\E=\E[?1l:ic=\E[@:im=\E[4h:\
906 :is=\E[r\E[m\E[2J\E[H\E[?7h\E[?1;3;4;6l\E[4l:\
907 :k1=\E[11~:k2=\E[12~:k3=\E[13~:k4=\E[14~:k5=\E[15~:\
908 :k6=\E[17~:k7=\E[18~:k8=\E[19~:k9=\E[20~:kD=\E[3~:\
909 :kI=\E[2~:kN=\E[6~:kP=\E[5~:kb=\177:kd=\EOB:ke=\E[?1l\E>:\
910 :kh=\E[7~:kl=\EOD:kr=\EOC:ks=\E[?1h\E=:ku=\EOA:le=^H:\
911 :mb=\E[5m:md=\E[1m:me=\E[m\017:mr=\E[7m:nd=\E[C:rc=\E8:\
912 :sc=\E7:se=\E[27m:sf=^J:so=\E[7m:sr=\EM:st=\EH:ta=^I:\
913 :te=\E[r\E[?1049l:ti=\E[?1049h:ue=\E[24m:up=\E[A:\
914 :us=\E[4m:vb=\E[?5h\E[?5l:ve=\E[?25h:vi=\E[?25l:\
915 :vs=\E[?25h:
916
917=head3 Why does C<ls> no longer have coloured output?
918
919The C<ls> in the GNU coreutils unfortunately doesn't use terminfo to
920decide whether a terminal has colour, but uses its own configuration
921file. Needless to say, C<rxvt-unicode> is not in its default file (among
922with most other terminals supporting colour). Either add:
923
924 TERM rxvt-unicode
925
926to C</etc/DIR_COLORS> or simply add:
927
928 alias ls='ls --color=auto'
929
930to your C<.profile> or C<.bashrc>.
931
932=head3 Why doesn't vim/emacs etc. use the 88 colour mode?
933
934See next entry.
935
936=head3 Why doesn't vim/emacs etc. make use of italic?
937
938See next entry.
939
940=head3 Why are the secondary screen-related options not working properly?
941
942Make sure you are using C<TERM=rxvt-unicode>. Some pre-packaged
943distributions (most notably Debian GNU/Linux) break rxvt-unicode
944by setting C<TERM> to C<rxvt>, which doesn't have these extra
945features. Unfortunately, some of these (most notably, again, Debian
946GNU/Linux) furthermore fail to even install the C<rxvt-unicode> terminfo
947file, so you will need to install it on your own (See the question B<When
948I log-in to another system it tells me about missing terminfo data?> on
949how to do this).
950
951
952=head2 Encoding / Locale / Input Method Issues
953
954=head3 Rxvt-unicode does not seem to understand the selected encoding?
955
956See next entry.
957
958=head3 Unicode does not seem to work?
959
960If you encounter strange problems like typing an accented character but
961getting two unrelated other characters or similar, or if program output is
962subtly garbled, then you should check your locale settings.
963
964Rxvt-unicode must be started with the same C<LC_CTYPE> setting as the
965programs running in it. Often rxvt-unicode is started in the C<C> locale,
966while the login script running within the rxvt-unicode window changes the
967locale to something else, e.g. C<en_GB.UTF-8>. Needless to say, this is
968not going to work, and is the most common cause for problems.
969
970The best thing is to fix your startup environment, as you will likely run
971into other problems. If nothing works you can try this in your .profile.
972
973 printf '\33]701;%s\007' "$LC_CTYPE" # $LANG or $LC_ALL are worth a try, too
974
975If this doesn't work, then maybe you use a C<LC_CTYPE> specification not
976supported on your systems. Some systems have a C<locale> command which
977displays this (also, C<perl -e0> can be used to check locale settings, as
978it will complain loudly if it cannot set the locale). If it displays something
979like:
980
981 locale: Cannot set LC_CTYPE to default locale: ...
982
983Then the locale you specified is not supported on your system.
984
985If nothing works and you are sure that everything is set correctly then
986you will need to remember a little known fact: Some programs just don't
987support locales :(
988
989=head3 How does rxvt-unicode determine the encoding to use?
990
991See next entry.
992
993=head3 Is there an option to switch encodings?
994
995Unlike some other terminals, rxvt-unicode has no encoding switch, and no
996specific "utf-8" mode, such as xterm. In fact, it doesn't even know about
997UTF-8 or any other encodings with respect to terminal I/O.
998
999The reasons is that there exists a perfectly fine mechanism for selecting
1000the encoding, doing I/O and (most important) communicating this to all
1001applications so everybody agrees on character properties such as width
1002and code number. This mechanism is the I<locale>. Applications not using
1003that info will have problems (for example, C<xterm> gets the width of
1004characters wrong as it uses its own, locale-independent table under all
1005locales).
1006
1007Rxvt-unicode uses the C<LC_CTYPE> locale category to select encoding. All
1008programs doing the same (that is, most) will automatically agree in the
1009interpretation of characters.
1010
1011Unfortunately, there is no system-independent way to select locales, nor
1012is there a standard on how locale specifiers will look like.
1013
1014On most systems, the content of the C<LC_CTYPE> environment variable
1015contains an arbitrary string which corresponds to an already-installed
1016locale. Common names for locales are C<en_US.UTF-8>, C<de_DE.ISO-8859-15>,
1017C<ja_JP.EUC-JP>, i.e. C<language_country.encoding>, but other forms
1018(i.e. C<de> or C<german>) are also common.
1019
1020Rxvt-unicode ignores all other locale categories, and except for
1021the encoding, ignores country or language-specific settings,
1022i.e. C<de_DE.UTF-8> and C<ja_JP.UTF-8> are the normally same to
1023rxvt-unicode.
1024
1025If you want to use a specific encoding you have to make sure you start
1026rxvt-unicode with the correct C<LC_CTYPE> category.
1027
1028=head3 Can I switch locales at runtime?
1029
1030Yes, using an escape sequence. Try something like this, which sets
1031rxvt-unicode's idea of C<LC_CTYPE>.
1032
1033 printf '\33]701;%s\007' ja_JP.SJIS
1034
1035See also the previous answer.
1036
1037Sometimes this capability is rather handy when you want to work in
1038one locale (e.g. C<de_DE.UTF-8>) but some programs don't support it
1039(e.g. UTF-8). For example, I use this script to start C<xjdic>, which
1040first switches to a locale supported by xjdic and back later:
1041
1042 printf '\33]701;%s\007' ja_JP.SJIS
1043 xjdic -js
1044 printf '\33]701;%s\007' de_DE.UTF-8
1045
1046You can also use xterm's C<luit> program, which usually works fine, except
1047for some locales where character width differs between program- and
1048rxvt-unicode-locales.
1049
1050=head3 I have problems getting my input method working.
1051
1052Try a search engine, as this is slightly different for every input method server.
1053
1054Here is a checklist:
1055
1056=over 4
1057
1058=item - Make sure your locale I<and> the imLocale are supported on your OS.
1059
1060Try C<locale -a> or check the documentation for your OS.
1061
1062=item - Make sure your locale or imLocale matches a locale supported by your XIM.
1063
1064For example, B<kinput2> does not support UTF-8 locales, you should use
1065C<ja_JP.EUC-JP> or equivalent.
1066
1067=item - Make sure your XIM server is actually running.
1068
1069=item - Make sure the C<XMODIFIERS> environment variable is set correctly when I<starting> rxvt-unicode.
1070
1071When you want to use e.g. B<kinput2>, it must be set to
1072C<@im=kinput2>. For B<scim>, use C<@im=SCIM>. You can see what input
1073method servers are running with this command:
1074
1075 xprop -root XIM_SERVERS
1076
1077=item
571 1078
572=back 1079=back
573 1080
574=head1 SYNOPSIS 1081=head3 My input method wants <some encoding> but I want UTF-8, what can I do?
575 1082
576 # set a new font set 1083You can specify separate locales for the input method and the rest of the
577 printf '\33]50;%s\007' 9x15,xft:Kochi" Mincho" 1084terminal, using the resource C<imlocale>:
578 1085
579 # change the locale and tell rxvt-unicode about it 1086 URxvt.imlocale: ja_JP.EUC-JP
580 export LC_CTYPE=ja_JP.EUC-JP; printf "\33]701;$LC_CTYPE\007"
581 1087
582 # set window title 1088Now you can start your terminal with C<LC_CTYPE=ja_JP.UTF-8> and still
583 printf '\33]2;%s\007' "new window title" 1089use your input method. Please note, however, that, depending on your Xlib
1090version, you may not be able to input characters outside C<EUC-JP> in a
1091normal way then, as your input method limits you.
584 1092
585=head1 DESCRIPTION 1093=head3 Rxvt-unicode crashes when the X Input Method changes or exits.
1094
1095Unfortunately, this is unavoidable, as the XIM protocol is racy by
1096design. Applications can avoid some crashes at the expense of memory
1097leaks, and Input Methods can avoid some crashes by careful ordering at
1098exit time. B<kinput2> (and derived input methods) generally succeeds,
1099while B<SCIM> (or similar input methods) fails. In the end, however,
1100crashes cannot be completely avoided even if both sides cooperate.
1101
1102So the only workaround is not to kill your Input Method Servers.
1103
1104
1105=head2 Operating Systems / Package Maintaining
1106
1107=head3 I am using Debian GNU/Linux and have a problem...
1108
1109The Debian GNU/Linux package of rxvt-unicode in sarge contains large
1110patches that considerably change the behaviour of rxvt-unicode (but
1111unfortunately this notice has been removed). Before reporting a bug to
1112the original rxvt-unicode author please download and install the genuine
1113version (L<http://software.schmorp.de#rxvt-unicode>) and try to reproduce
1114the problem. If you cannot, chances are that the problems are specific to
1115Debian GNU/Linux, in which case it should be reported via the Debian Bug
1116Tracking System (use C<reportbug> to report the bug).
1117
1118For other problems that also affect the Debian package, you can and
1119probably should use the Debian BTS, too, because, after all, it's also a
1120bug in the Debian version and it serves as a reminder for other users that
1121might encounter the same issue.
1122
1123=head3 I am maintaining rxvt-unicode for distribution/OS XXX, any recommendation?
1124
1125You should build one binary with the default options. F<configure>
1126now enables most useful options, and the trend goes to making them
1127runtime-switchable, too, so there is usually no drawback to enabling them,
1128except higher disk and possibly memory usage. The perl interpreter should
1129be enabled, as important functionality (menus, selection, likely more in
1130the future) depends on it.
1131
1132You should not overwrite the C<perl-ext-common> snd C<perl-ext> resources
1133system-wide (except maybe with C<defaults>). This will result in useful
1134behaviour. If your distribution aims at low memory, add an empty
1135C<perl-ext-common> resource to the app-defaults file. This will keep the
1136perl interpreter disabled until the user enables it.
1137
1138If you can/want build more binaries, I recommend building a minimal
1139one with C<--disable-everything> (very useful) and a maximal one with
1140C<--enable-everything> (less useful, it will be very big due to a lot of
1141encodings built-in that increase download times and are rarely used).
1142
1143=head3 I need to make it setuid/setgid to support utmp/ptys on my OS, is this safe?
1144
1145It should be, starting with release 7.1. You are encouraged to properly
1146install urxvt with privileges necessary for your OS now.
1147
1148When rxvt-unicode detects that it runs setuid or setgid, it will fork
1149into a helper process for privileged operations (pty handling on some
1150systems, utmp/wtmp/lastlog handling on others) and drop privileges
1151immediately. This is much safer than most other terminals that keep
1152privileges while running (but is more relevant to urxvt, as it contains
1153things as perl interpreters, which might be "helpful" to attackers).
1154
1155This forking is done as the very first within main(), which is very early
1156and reduces possible bugs to initialisation code run before main(), or
1157things like the dynamic loader of your system, which should result in very
1158little risk.
1159
1160=head3 I am on FreeBSD and rxvt-unicode does not seem to work at all.
1161
1162Rxvt-unicode requires the symbol C<__STDC_ISO_10646__> to be defined
1163in your compile environment, or an implementation that implements it,
1164whether it defines the symbol or not. C<__STDC_ISO_10646__> requires that
1165B<wchar_t> is represented as unicode.
1166
1167As you might have guessed, FreeBSD does neither define this symbol nor
1168does it support it. Instead, it uses its own internal representation of
1169B<wchar_t>. This is, of course, completely fine with respect to standards.
1170
1171However, that means rxvt-unicode only works in C<POSIX>, C<ISO-8859-1> and
1172C<UTF-8> locales under FreeBSD (which all use Unicode as B<wchar_t>.
1173
1174C<__STDC_ISO_10646__> is the only sane way to support multi-language
1175apps in an OS, as using a locale-dependent (and non-standardized)
1176representation of B<wchar_t> makes it impossible to convert between
1177B<wchar_t> (as used by X11 and your applications) and any other encoding
1178without implementing OS-specific-wrappers for each and every locale. There
1179simply are no APIs to convert B<wchar_t> into anything except the current
1180locale encoding.
1181
1182Some applications (such as the formidable B<mlterm>) work around this
1183by carrying their own replacement functions for character set handling
1184with them, and either implementing OS-dependent hacks or doing multiple
1185conversions (which is slow and unreliable in case the OS implements
1186encodings slightly different than the terminal emulator).
1187
1188The rxvt-unicode author insists that the right way to fix this is in the
1189system libraries once and for all, instead of forcing every app to carry
1190complete replacements for them :)
1191
1192=head3 How can I use rxvt-unicode under cygwin?
1193
1194rxvt-unicode should compile and run out of the box on cygwin, using
1195the X11 libraries that come with cygwin. libW11 emulation is no
1196longer supported (and makes no sense, either, as it only supported a
1197single font). I recommend starting the X-server in C<-multiwindow> or
1198C<-rootless> mode instead, which will result in similar look&feel as the
1199old libW11 emulation.
1200
1201At the time of this writing, cygwin didn't seem to support any multi-byte
1202encodings (you might try C<LC_CTYPE=C-UTF-8>), so you are likely limited
1203to 8-bit encodings.
1204
1205=head3 Character widths are not correct.
1206
1207urxvt uses the system wcwidth function to know the information about
1208the width of characters, so on systems with incorrect locale data you
1209will likely get bad results. Two notorious examples are Solaris 9,
1210where single-width characters like U+2514 are reported as double-width,
1211and Darwin 8, where combining chars are reported having width 1.
1212
1213The solution is to upgrade your system or switch to a better one. A
1214possibly working workaround is to use a wcwidth implementation like
1215
1216http://www.cl.cam.ac.uk/~mgk25/ucs/wcwidth.c
1217
1218=head1 RXVT-UNICODE TECHNICAL REFERENCE
586 1219
587The rest of this document describes various technical aspects of 1220The rest of this document describes various technical aspects of
588B<rxvt-unicode>. First the description of supported command sequences, 1221B<rxvt-unicode>. First the description of supported command sequences,
589followed by menu and pixmap support and last by a description of all 1222followed by pixmap support and last by a description of all features
590features selectable at C<configure> time. 1223selectable at C<configure> time.
591 1224
592=head1 RXVT TECHNICAL REFERENCE
593
594=head1 Definitions 1225=head2 Definitions
595 1226
596=over 4 1227=over 4
597 1228
598=item B<< C<c> >> 1229=item B<< C<c> >>
599 1230
617 1248
618A text parameter composed of printable characters. 1249A text parameter composed of printable characters.
619 1250
620=back 1251=back
621 1252
622=head1 Values 1253=head2 Values
623 1254
624=over 4 1255=over 4
625 1256
626=item B<< C<ENQ> >> 1257=item B<< C<ENQ> >>
627 1258
670 1301
671Space Character 1302Space Character
672 1303
673=back 1304=back
674 1305
675=head1 Escape Sequences 1306=head2 Escape Sequences
676 1307
677=over 4 1308=over 4
678 1309
679=item B<< C<ESC # 8> >> 1310=item B<< C<ESC # 8> >>
680 1311
726Single Shift Select of G3 Character Set (SS3): affects next character 1357Single Shift Select of G3 Character Set (SS3): affects next character
727only I<unimplemented> 1358only I<unimplemented>
728 1359
729=item B<< C<ESC Z> >> 1360=item B<< C<ESC Z> >>
730 1361
731Obsolete form of returns: B<< C<ESC[?1;2C> >> I<rxvt-unicode compile-time option> 1362Obsolete form of returns: B<< C<ESC [ ? 1 ; 2 C> >> I<rxvt-unicode compile-time option>
732 1363
733=item B<< C<ESC c> >> 1364=item B<< C<ESC c> >>
734 1365
735Full reset (RIS) 1366Full reset (RIS)
736 1367
740 1371
741=item B<< C<ESC o> >> 1372=item B<< C<ESC o> >>
742 1373
743Invoke the G3 Character Set (LS3) 1374Invoke the G3 Character Set (LS3)
744 1375
745=item B<< C<ESC> ( C> >> 1376=item B<< C<ESC ( C> >>
746 1377
747Designate G0 Character Set (ISO 2022), see below for values of C<C>. 1378Designate G0 Character Set (ISO 2022), see below for values of C<C>.
748 1379
749=item B<< C<ESC> ) C> >> 1380=item B<< C<ESC ) C> >>
750 1381
751Designate G1 Character Set (ISO 2022), see below for values of C<C>. 1382Designate G1 Character Set (ISO 2022), see below for values of C<C>.
752 1383
753=item B<< C<ESC * C> >> 1384=item B<< C<ESC * C> >>
754 1385
778 1409
779=back 1410=back
780 1411
781X<CSI> 1412X<CSI>
782 1413
783=head1 CSI (Command Sequence Introducer) Sequences 1414=head2 CSI (Command Sequence Introducer) Sequences
784 1415
785=over 4 1416=over 4
786 1417
787=item B<< C<ESC [ Ps @> >> 1418=item B<< C<ESC [ Ps @> >>
788 1419
895 1526
896=item B<< C<ESC [ Ps c> >> 1527=item B<< C<ESC [ Ps c> >>
897 1528
898Send Device Attributes (DA) 1529Send Device Attributes (DA)
899B<< C<Ps = 0> >> (or omitted): request attributes from terminal 1530B<< C<Ps = 0> >> (or omitted): request attributes from terminal
900returns: B<< C<ESC[?1;2c> >> (``I am a VT100 with Advanced Video 1531returns: B<< C<ESC [ ? 1 ; 2 c> >> (``I am a VT100 with Advanced Video
901Option'') 1532Option'')
902 1533
903=item B<< C<ESC [ Ps d> >> 1534=item B<< C<ESC [ Ps d> >>
904 1535
905Cursor to Line B<< C<Ps> >> (VPA) 1536Cursor to Line B<< C<Ps> >> (VPA)
1021 1652
1022=item B<< C<ESC [ s> >> 1653=item B<< C<ESC [ s> >>
1023 1654
1024Save Cursor (SC) 1655Save Cursor (SC)
1025 1656
1657=item B<< C<ESC [ Ps;Pt t> >>
1658
1659Window Operations
1660
1661=begin table
1662
1663 B<< C<Ps = 1> >> Deiconify (map) window
1664 B<< C<Ps = 2> >> Iconify window
1665 B<< C<Ps = 3> >> B<< C<ESC [ 3 ; X ; Y t> >> Move window to (X|Y)
1666 B<< C<Ps = 4> >> B<< C<ESC [ 4 ; H ; W t> >> Resize to WxH pixels
1667 B<< C<Ps = 5> >> Raise window
1668 B<< C<Ps = 6> >> Lower window
1669 B<< C<Ps = 7> >> Refresh screen once
1670 B<< C<Ps = 8> >> B<< C<ESC [ 8 ; R ; C t> >> Resize to R rows and C columns
1671 B<< C<Ps = 11> >> Report window state (responds with C<Ps = 1> or C<Ps = 2>)
1672 B<< C<Ps = 13> >> Report window position (responds with C<Ps = 3>)
1673 B<< C<Ps = 14> >> Report window pixel size (responds with C<Ps = 4>)
1674 B<< C<Ps = 18> >> Report window text size (responds with C<Ps = 7>)
1675 B<< C<Ps = 19> >> Currently the same as C<Ps = 18>, but responds with C<Ps = 9>
1676 B<< C<Ps = 20> >> Reports icon label (B<< C<ESC ] L NAME \234> >>)
1677 B<< C<Ps = 21> >> Reports window title (B<< C<ESC ] l NAME \234> >>)
1678 B<< C<Ps = 24..> >> Set window height to C<Ps> rows
1679
1680=end table
1681
1682=item B<< C<ESC [ u> >>
1683
1684Restore Cursor
1685
1026=item B<< C<ESC [ Ps x> >> 1686=item B<< C<ESC [ Ps x> >>
1027 1687
1028Request Terminal Parameters (DECREQTPARM) 1688Request Terminal Parameters (DECREQTPARM)
1029 1689
1030=item B<< C<ESC [ u> >>
1031
1032Restore Cursor
1033
1034=back 1690=back
1035 1691
1036X<PrivateModes> 1692X<PrivateModes>
1037 1693
1038=head1 DEC Private Modes 1694=head2 DEC Private Modes
1039 1695
1040=over 4 1696=over 4
1041 1697
1042=item B<< C<ESC [ ? Pm h> >> 1698=item B<< C<ESC [ ? Pm h> >>
1043 1699
1059 1715
1060Toggle DEC Private Mode Values (rxvt extension). I<where> 1716Toggle DEC Private Mode Values (rxvt extension). I<where>
1061 1717
1062=over 4 1718=over 4
1063 1719
1064=item B<< C<Ps = 1> >> (DECCKM) 1720=item B<< C<Pm = 1> >> (DECCKM)
1065 1721
1066=begin table 1722=begin table
1067 1723
1068 B<< C<h> >> Application Cursor Keys 1724 B<< C<h> >> Application Cursor Keys
1069 B<< C<l> >> Normal Cursor Keys 1725 B<< C<l> >> Normal Cursor Keys
1070 1726
1071=end table 1727=end table
1072 1728
1073=item B<< C<Ps = 2> >> (ANSI/VT52 mode) 1729=item B<< C<Pm = 2> >> (ANSI/VT52 mode)
1074 1730
1075=begin table 1731=begin table
1076 1732
1077 B<< C<h> >> Enter VT52 mode 1733 B<< C<h> >> Enter VT52 mode
1078 B<< C<l> >> Enter VT52 mode 1734 B<< C<l> >> Enter VT52 mode
1079 1735
1080=end table 1736=end table
1081 1737
1082=item B<< C<Ps = 3> >> 1738=item B<< C<Pm = 3> >>
1083 1739
1084=begin table 1740=begin table
1085 1741
1086 B<< C<h> >> 132 Column Mode (DECCOLM) 1742 B<< C<h> >> 132 Column Mode (DECCOLM)
1087 B<< C<l> >> 80 Column Mode (DECCOLM) 1743 B<< C<l> >> 80 Column Mode (DECCOLM)
1088 1744
1089=end table 1745=end table
1090 1746
1091=item B<< C<Ps = 4> >> 1747=item B<< C<Pm = 4> >>
1092 1748
1093=begin table 1749=begin table
1094 1750
1095 B<< C<h> >> Smooth (Slow) Scroll (DECSCLM) 1751 B<< C<h> >> Smooth (Slow) Scroll (DECSCLM)
1096 B<< C<l> >> Jump (Fast) Scroll (DECSCLM) 1752 B<< C<l> >> Jump (Fast) Scroll (DECSCLM)
1097 1753
1098=end table 1754=end table
1099 1755
1100=item B<< C<Ps = 5> >> 1756=item B<< C<Pm = 5> >>
1101 1757
1102=begin table 1758=begin table
1103 1759
1104 B<< C<h> >> Reverse Video (DECSCNM) 1760 B<< C<h> >> Reverse Video (DECSCNM)
1105 B<< C<l> >> Normal Video (DECSCNM) 1761 B<< C<l> >> Normal Video (DECSCNM)
1106 1762
1107=end table 1763=end table
1108 1764
1109=item B<< C<Ps = 6> >> 1765=item B<< C<Pm = 6> >>
1110 1766
1111=begin table 1767=begin table
1112 1768
1113 B<< C<h> >> Origin Mode (DECOM) 1769 B<< C<h> >> Origin Mode (DECOM)
1114 B<< C<l> >> Normal Cursor Mode (DECOM) 1770 B<< C<l> >> Normal Cursor Mode (DECOM)
1115 1771
1116=end table 1772=end table
1117 1773
1118=item B<< C<Ps = 7> >> 1774=item B<< C<Pm = 7> >>
1119 1775
1120=begin table 1776=begin table
1121 1777
1122 B<< C<h> >> Wraparound Mode (DECAWM) 1778 B<< C<h> >> Wraparound Mode (DECAWM)
1123 B<< C<l> >> No Wraparound Mode (DECAWM) 1779 B<< C<l> >> No Wraparound Mode (DECAWM)
1124 1780
1125=end table 1781=end table
1126 1782
1127=item B<< C<Ps = 8> >> I<unimplemented> 1783=item B<< C<Pm = 8> >> I<unimplemented>
1128 1784
1129=begin table 1785=begin table
1130 1786
1131 B<< C<h> >> Auto-repeat Keys (DECARM) 1787 B<< C<h> >> Auto-repeat Keys (DECARM)
1132 B<< C<l> >> No Auto-repeat Keys (DECARM) 1788 B<< C<l> >> No Auto-repeat Keys (DECARM)
1133 1789
1134=end table 1790=end table
1135 1791
1136=item B<< C<Ps = 9> >> X10 XTerm 1792=item B<< C<Pm = 9> >> X10 XTerm
1137 1793
1138=begin table 1794=begin table
1139 1795
1140 B<< C<h> >> Send Mouse X & Y on button press. 1796 B<< C<h> >> Send Mouse X & Y on button press.
1141 B<< C<l> >> No mouse reporting. 1797 B<< C<l> >> No mouse reporting.
1142 1798
1143=end table 1799=end table
1144 1800
1145=item B<< C<Ps = 10> >> (B<rxvt>)
1146
1147=begin table
1148
1149 B<< C<h> >> menuBar visible
1150 B<< C<l> >> menuBar invisible
1151
1152=end table
1153
1154=item B<< C<Ps = 25> >> 1801=item B<< C<Pm = 25> >>
1155 1802
1156=begin table 1803=begin table
1157 1804
1158 B<< C<h> >> Visible cursor {cnorm/cvvis} 1805 B<< C<h> >> Visible cursor {cnorm/cvvis}
1159 B<< C<l> >> Invisible cursor {civis} 1806 B<< C<l> >> Invisible cursor {civis}
1160 1807
1161=end table 1808=end table
1162 1809
1163=item B<< C<Ps = 30> >> 1810=item B<< C<Pm = 30> >>
1164 1811
1165=begin table 1812=begin table
1166 1813
1167 B<< C<h> >> scrollBar visisble 1814 B<< C<h> >> scrollBar visisble
1168 B<< C<l> >> scrollBar invisisble 1815 B<< C<l> >> scrollBar invisisble
1169 1816
1170=end table 1817=end table
1171 1818
1172=item B<< C<Ps = 35> >> (B<rxvt>) 1819=item B<< C<Pm = 35> >> (B<rxvt>)
1173 1820
1174=begin table 1821=begin table
1175 1822
1176 B<< C<h> >> Allow XTerm Shift+key sequences 1823 B<< C<h> >> Allow XTerm Shift+key sequences
1177 B<< C<l> >> Disallow XTerm Shift+key sequences 1824 B<< C<l> >> Disallow XTerm Shift+key sequences
1178 1825
1179=end table 1826=end table
1180 1827
1181=item B<< C<Ps = 38> >> I<unimplemented> 1828=item B<< C<Pm = 38> >> I<unimplemented>
1182 1829
1183Enter Tektronix Mode (DECTEK) 1830Enter Tektronix Mode (DECTEK)
1184 1831
1185=item B<< C<Ps = 40> >> 1832=item B<< C<Pm = 40> >>
1186 1833
1187=begin table 1834=begin table
1188 1835
1189 B<< C<h> >> Allow 80/132 Mode 1836 B<< C<h> >> Allow 80/132 Mode
1190 B<< C<l> >> Disallow 80/132 Mode 1837 B<< C<l> >> Disallow 80/132 Mode
1191 1838
1192=end table 1839=end table
1193 1840
1194=item B<< C<Ps = 44> >> I<unimplemented> 1841=item B<< C<Pm = 44> >> I<unimplemented>
1195 1842
1196=begin table 1843=begin table
1197 1844
1198 B<< C<h> >> Turn On Margin Bell 1845 B<< C<h> >> Turn On Margin Bell
1199 B<< C<l> >> Turn Off Margin Bell 1846 B<< C<l> >> Turn Off Margin Bell
1200 1847
1201=end table 1848=end table
1202 1849
1203=item B<< C<Ps = 45> >> I<unimplemented> 1850=item B<< C<Pm = 45> >> I<unimplemented>
1204 1851
1205=begin table 1852=begin table
1206 1853
1207 B<< C<h> >> Reverse-wraparound Mode 1854 B<< C<h> >> Reverse-wraparound Mode
1208 B<< C<l> >> No Reverse-wraparound Mode 1855 B<< C<l> >> No Reverse-wraparound Mode
1209 1856
1210=end table 1857=end table
1211 1858
1212=item B<< C<Ps = 46> >> I<unimplemented> 1859=item B<< C<Pm = 46> >> I<unimplemented>
1213 1860
1214=item B<< C<Ps = 47> >> 1861=item B<< C<Pm = 47> >>
1215 1862
1216=begin table 1863=begin table
1217 1864
1218 B<< C<h> >> Use Alternate Screen Buffer 1865 B<< C<h> >> Use Alternate Screen Buffer
1219 B<< C<l> >> Use Normal Screen Buffer 1866 B<< C<l> >> Use Normal Screen Buffer
1220 1867
1221=end table 1868=end table
1222 1869
1223X<Priv66> 1870X<Priv66>
1224 1871
1225=item B<< C<Ps = 66> >> 1872=item B<< C<Pm = 66> >>
1226 1873
1227=begin table 1874=begin table
1228 1875
1229 B<< C<h> >> Application Keypad (DECPAM) == C<ESC => 1876 B<< C<h> >> Application Keypad (DECPAM) == C<ESC =>
1230 B<< C<l> >> Normal Keypad (DECPNM) == C<< ESC > >> 1877 B<< C<l> >> Normal Keypad (DECPNM) == C<< ESC > >>
1231 1878
1232=end table 1879=end table
1233 1880
1234=item B<< C<Ps = 67> >> 1881=item B<< C<Pm = 67> >>
1235 1882
1236=begin table 1883=begin table
1237 1884
1238 B<< C<h> >> Backspace key sends B<< C<BS> (DECBKM) >> 1885 B<< C<h> >> Backspace key sends B<< C<BS> (DECBKM) >>
1239 B<< C<l> >> Backspace key sends B<< C<DEL> >> 1886 B<< C<l> >> Backspace key sends B<< C<DEL> >>
1240 1887
1241=end table 1888=end table
1242 1889
1243=item B<< C<Ps = 1000> >> (X11 XTerm) 1890=item B<< C<Pm = 1000> >> (X11 XTerm)
1244 1891
1245=begin table 1892=begin table
1246 1893
1247 B<< C<h> >> Send Mouse X & Y on button press and release. 1894 B<< C<h> >> Send Mouse X & Y on button press and release.
1248 B<< C<l> >> No mouse reporting. 1895 B<< C<l> >> No mouse reporting.
1249 1896
1250=end table 1897=end table
1251 1898
1252=item B<< C<Ps = 1001> >> (X11 XTerm) I<unimplemented> 1899=item B<< C<Pm = 1001> >> (X11 XTerm) I<unimplemented>
1253 1900
1254=begin table 1901=begin table
1255 1902
1256 B<< C<h> >> Use Hilite Mouse Tracking. 1903 B<< C<h> >> Use Hilite Mouse Tracking.
1257 B<< C<l> >> No mouse reporting. 1904 B<< C<l> >> No mouse reporting.
1258 1905
1259=end table 1906=end table
1260 1907
1908=item B<< C<Pm = 1002> >> (X11 XTerm)
1909
1910=begin table
1911
1912 B<< C<h> >> Send Mouse X & Y on button press and release, and motion with a button pressed.
1913 B<< C<l> >> No mouse reporting.
1914
1915=end table
1916
1917=item B<< C<Pm = 1003> >> (X11 XTerm)
1918
1919=begin table
1920
1921 B<< C<h> >> Send Mouse X & Y on button press and release, and motion.
1922 B<< C<l> >> No mouse reporting.
1923
1924=end table
1925
1261=item B<< C<Ps = 1010> >> (B<rxvt>) 1926=item B<< C<Pm = 1010> >> (B<rxvt>)
1262 1927
1263=begin table 1928=begin table
1264 1929
1265 B<< C<h> >> Don't scroll to bottom on TTY output 1930 B<< C<h> >> Don't scroll to bottom on TTY output
1266 B<< C<l> >> Scroll to bottom on TTY output 1931 B<< C<l> >> Scroll to bottom on TTY output
1267 1932
1268=end table 1933=end table
1269 1934
1270=item B<< C<Ps = 1011> >> (B<rxvt>) 1935=item B<< C<Pm = 1011> >> (B<rxvt>)
1271 1936
1272=begin table 1937=begin table
1273 1938
1274 B<< C<h> >> Scroll to bottom when a key is pressed 1939 B<< C<h> >> Scroll to bottom when a key is pressed
1275 B<< C<l> >> Don't scroll to bottom when a key is pressed 1940 B<< C<l> >> Don't scroll to bottom when a key is pressed
1276 1941
1277=end table 1942=end table
1278 1943
1944=item B<< C<Pm = 1021> >> (B<rxvt>)
1945
1946=begin table
1947
1948 B<< C<h> >> Bold/italic implies high intensity (see option B<-is>)
1949 B<< C<l> >> Font styles have no effect on intensity (Compile styles)
1950
1951=end table
1952
1279=item B<< C<Ps = 1047> >> 1953=item B<< C<Pm = 1047> >>
1280 1954
1281=begin table 1955=begin table
1282 1956
1283 B<< C<h> >> Use Alternate Screen Buffer 1957 B<< C<h> >> Use Alternate Screen Buffer
1284 B<< C<l> >> Use Normal Screen Buffer - clear Alternate Screen Buffer if returning from it 1958 B<< C<l> >> Use Normal Screen Buffer - clear Alternate Screen Buffer if returning from it
1285 1959
1286=end table 1960=end table
1287 1961
1288=item B<< C<Ps = 1048> >> 1962=item B<< C<Pm = 1048> >>
1289 1963
1290=begin table 1964=begin table
1291 1965
1292 B<< C<h> >> Save cursor position 1966 B<< C<h> >> Save cursor position
1293 B<< C<l> >> Restore cursor position 1967 B<< C<l> >> Restore cursor position
1294 1968
1295=end table 1969=end table
1296 1970
1297=item B<< C<Ps = 1049> >> 1971=item B<< C<Pm = 1049> >>
1298 1972
1299=begin table 1973=begin table
1300 1974
1301 B<< C<h> >> Use Alternate Screen Buffer - clear Alternate Screen Buffer if switching to it 1975 B<< C<h> >> Use Alternate Screen Buffer - clear Alternate Screen Buffer if switching to it
1302 B<< C<l> >> Use Normal Screen Buffer 1976 B<< C<l> >> Use Normal Screen Buffer
1307 1981
1308=back 1982=back
1309 1983
1310X<XTerm> 1984X<XTerm>
1311 1985
1312=head1 XTerm Operating System Commands 1986=head2 XTerm Operating System Commands
1313 1987
1314=over 4 1988=over 4
1315 1989
1316=item B<< C<ESC ] Ps;Pt ST> >> 1990=item B<< C<ESC ] Ps;Pt ST> >>
1317 1991
1329 B<< C<Ps = 10> >> Change colour of text foreground to B<< C<Pt> >> B<(NB: may change in future)> 2003 B<< C<Ps = 10> >> Change colour of text foreground to B<< C<Pt> >> B<(NB: may change in future)>
1330 B<< C<Ps = 11> >> Change colour of text background to B<< C<Pt> >> B<(NB: may change in future)> 2004 B<< C<Ps = 11> >> Change colour of text background to B<< C<Pt> >> B<(NB: may change in future)>
1331 B<< C<Ps = 12> >> Change colour of text cursor foreground to B<< C<Pt> >> 2005 B<< C<Ps = 12> >> Change colour of text cursor foreground to B<< C<Pt> >>
1332 B<< C<Ps = 13> >> Change colour of mouse foreground to B<< C<Pt> >> 2006 B<< C<Ps = 13> >> Change colour of mouse foreground to B<< C<Pt> >>
1333 B<< C<Ps = 17> >> Change colour of highlight characters to B<< C<Pt> >> 2007 B<< C<Ps = 17> >> Change colour of highlight characters to B<< C<Pt> >>
1334 B<< C<Ps = 18> >> Change colour of bold characters to B<< C<Pt> >> 2008 B<< C<Ps = 18> >> Change colour of bold characters to B<< C<Pt> >> [deprecated, see 706]
1335 B<< C<Ps = 19> >> Change colour of underlined characters to B<< C<Pt> >> 2009 B<< C<Ps = 19> >> Change colour of underlined characters to B<< C<Pt> >> [deprecated, see 707]
2010 B<< C<Ps = 20> >> Change background pixmap parameters (see section BACKGROUND IMAGE) (Compile AfterImage).
1336 B<< C<Ps = 20> >> Change default background to B<< C<Pt> >> 2011 B<< C<Ps = 39> >> Change default foreground colour to B<< C<Pt> >>.
1337 B<< C<Ps = 39> >> Change default foreground colour to B<< C<Pt> >> I<rxvt compile-time option>
1338 B<< C<Ps = 46> >> Change Log File to B<< C<Pt> >> I<unimplemented> 2012 B<< C<Ps = 46> >> Change Log File to B<< C<Pt> >> I<unimplemented>
1339 B<< C<Ps = 49> >> Change default background colour to B<< C<Pt> >> I<rxvt compile-time option> 2013 B<< C<Ps = 49> >> Change default background colour to B<< C<Pt> >>.
1340 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> >> 2014 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> >>
1341 B<< C<Ps = 55> >> Log all scrollback buffer and all of screen to B<< C<Pt> >> 2015 B<< C<Ps = 55> >> Log all scrollback buffer and all of screen to B<< C<Pt> >>
1342 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) 2016 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).
1343 B<< C<Ps = 703> >> Menubar command B<< C<Pt> >> I<rxvt compile-time option> (rxvt-unicode extension) 2017 B<< C<Ps = 702> >> Request version if B<< C<Pt> >> is B<< C<?> >>, returning C<rxvt-unicode>, the resource name, the major and minor version numbers, e.g. C<ESC ] 702 ; rxvt-unicode ; urxvt ; 7 ; 4 ST>.
1344 B<< C<Ps = 704> >> Change colour of italic characters to B<< C<Pt> >> 2018 B<< C<Ps = 704> >> Change colour of italic characters to B<< C<Pt> >>
1345 B<< C<Ps = 705> >> Change background pixmap tint colour to B<< C<Pt> >> 2019 B<< C<Ps = 705> >> Change background pixmap tint colour to B<< C<Pt> >> (Compile transparency).
2020 B<< C<Ps = 706> >> Change colour of bold characters to B<< C<Pt> >>
2021 B<< C<Ps = 707> >> Change colour of underlined characters to B<< C<Pt> >>
1346 B<< C<Ps = 710> >> Set normal fontset to B<< C<Pt> >>. Same as C<Ps = 50>. 2022 B<< C<Ps = 710> >> Set normal fontset to B<< C<Pt> >>. Same as C<Ps = 50>.
1347 B<< C<Ps = 711> >> Set bold fontset to B<< C<Pt> >>. Similar to C<Ps = 50>. 2023 B<< C<Ps = 711> >> Set bold fontset to B<< C<Pt> >>. Similar to C<Ps = 50> (Compile styles).
1348 B<< C<Ps = 712> >> Set italic fontset to B<< C<Pt> >>. Similar to C<Ps = 50>. 2024 B<< C<Ps = 712> >> Set italic fontset to B<< C<Pt> >>. Similar to C<Ps = 50> (Compile styles).
1349 B<< C<Ps = 713> >> Set bold-italic fontset to B<< C<Pt> >>. Similar to C<Ps = 50>. 2025 B<< C<Ps = 713> >> Set bold-italic fontset to B<< C<Pt> >>. Similar to C<Ps = 50> (Compile styles).
2026 B<< C<Ps = 720> >> Move viewing window up by B<< C<Pt> >> lines, or clear scrollback buffer if C<Pt = 0> (Compile frills).
2027 B<< C<Ps = 721> >> Move viewing window down by B<< C<Pt> >> lines, or clear scrollback buffer if C<Pt = 0> (Compile frills).
2028 B<< C<Ps = 777> >> Call the perl extension with the given string, which should be of the form C<extension:parameters> (Compile perl).
1350 2029
1351=end table 2030=end table
1352 2031
1353=back 2032=back
1354 2033
1355X<menuBar> 2034=head1 BACKGROUND IMAGE
1356 2035
1357=head1 menuBar
1358
1359B<< The exact syntax used is I<almost> solidified. >>
1360In the menus, B<DON'T> try to use menuBar commands that add or remove a
1361menuBar.
1362
1363Note that in all of the commands, the B<< I</path/> >> I<cannot> be
1364omitted: use B<./> to specify a menu relative to the current menu.
1365
1366=head2 Overview of menuBar operation
1367
1368For the menuBar XTerm escape sequence C<ESC ] 703 ; Pt ST>, the syntax
1369of C<Pt> can be used for a variety of tasks:
1370
1371At the top level is the current menuBar which is a member of a circular
1372linked-list of other such menuBars.
1373
1374The menuBar acts as a parent for the various drop-down menus, which in
1375turn, may have labels, separator lines, menuItems and subMenus.
1376
1377The menuItems are the useful bits: you can use them to mimic keyboard
1378input or even to send text or escape sequences back to rxvt.
1379
1380The menuBar syntax is intended to provide a simple yet robust method of
1381constructing and manipulating menus and navigating through the
1382menuBars.
1383
1384The first step is to use the tag B<< [menu:I<name>] >> which creates
1385the menuBar called I<name> and allows access. You may now or menus,
1386subMenus, and menuItems. Finally, use the tag B<[done]> to set the
1387menuBar access as B<readonly> to prevent accidental corruption of the
1388menus. To re-access the current menuBar for alterations, use the tag
1389B<[menu]>, make the alterations and then use B<[done]>
1390
1391X<menuBarCommands>
1392
1393=head2 Commands
1394
1395=over 4
1396
1397=item B<< [menu:+I<name>] >>
1398
1399access the named menuBar for creation or alteration. If a new menuBar
1400is created, it is called I<name> (max of 15 chars) and the current
1401menuBar is pushed onto the stack
1402
1403=item B<[menu]>
1404
1405access the current menuBar for alteration
1406
1407=item B<< [title:+I<string>] >>
1408
1409set the current menuBar's title to I<string>, which may contain the
1410following format specifiers:
1411B<%%> : literal B<%> character
1412B<%n> : rxvt name (as per the B<-name> command-line option)
1413B<%v> : rxvt version
1414
1415=item B<[done]>
1416
1417set menuBar access as B<readonly>.
1418End-of-file tag for B<< [read:+I<file>] >> operations.
1419
1420=item B<< [read:+I<file>] >>
1421
1422read menu commands directly from I<file> (extension ".menu" will be
1423appended if required.) Start reading at a line with B<[menu]> or B<<
1424[menu:+I<name> >> and continuing until B<[done]> is encountered.
1425
1426Blank and comment lines (starting with B<#>) are ignored. Actually,
1427since any invalid menu commands are also ignored, almost anything could
1428be construed as a comment line, but this may be tightened up in the
1429future ... so don't count on it!.
1430
1431=item B<< [read:+I<file>;+I<name>] >>
1432
1433The same as B<< [read:+I<file>] >>, but start reading at a line with
1434B<< [menu:+I<name>] >> and continuing until B<< [done:+I<name>] >> or
1435B<[done]> is encountered.
1436
1437=item B<[dump]>
1438
1439dump all menuBars to the file B</tmp/rxvt-PID> in a format suitable for
1440later rereading.
1441
1442=item B<[rm:name]>
1443
1444remove the named menuBar
1445
1446=item B<[rm] [rm:]>
1447
1448remove the current menuBar
1449
1450=item B<[rm*] [rm:*]>
1451
1452remove all menuBars
1453
1454=item B<[swap]>
1455
1456swap the top two menuBars
1457
1458=item B<[prev]>
1459
1460access the previous menuBar
1461
1462=item B<[next]>
1463
1464access the next menuBar
1465
1466=item B<[show]>
1467
1468Enable display of the menuBar
1469
1470=item B<[hide]>
1471
1472Disable display of the menuBar
1473
1474=item B<< [pixmap:+I<name>] >>
1475
1476=item B<< [pixmap:+I<name>;I<scaling>] >>
1477
1478(set the background pixmap globally
1479
1480B<< A Future implementation I<may> make this local to the menubar >>)
1481
1482=item B<< [:+I<command>:] >>
1483
1484ignore the menu readonly status and issue a I<command> to or a menu or
1485menuitem or change the ; a useful shortcut for setting the quick arrows
1486from a menuBar.
1487
1488=back
1489
1490X<menuBarAdd>
1491
1492=head2 Adding and accessing menus
1493
1494The following commands may also be B<+> prefixed.
1495
1496=over 4
1497
1498=item B</+>
1499
1500access menuBar top level
1501
1502=item B<./+>
1503
1504access current menu level
1505
1506=item B<../+>
1507
1508access parent menu (1 level up)
1509
1510=item B<../../>
1511
1512access parent menu (multiple levels up)
1513
1514=item B<< I</path/>menu >>
1515
1516add/access menu
1517
1518=item B<< I</path/>menu/* >>
1519
1520add/access menu and clear it if it exists
1521
1522=item B<< I</path/>{-} >>
1523
1524add separator
1525
1526=item B<< I</path/>{item} >>
1527
1528add B<item> as a label
1529
1530=item B<< I</path/>{item} action >>
1531
1532add/alter I<menuitem> with an associated I<action>
1533
1534=item B<< I</path/>{item}{right-text} >>
1535
1536add/alter I<menuitem> with B<right-text> as the right-justified text
1537and as the associated I<action>
1538
1539=item B<< I</path/>{item}{rtext} action >>
1540
1541add/alter I<menuitem> with an associated I<action> and with B<rtext> as
1542the right-justified text.
1543
1544=back
1545
1546=over 4
1547
1548=item Special characters in I<action> must be backslash-escaped:
1549
1550B<\a \b \E \e \n \r \t \octal>
1551
1552=item or in control-character notation:
1553
1554B<^@, ^A .. ^Z .. ^_, ^?>
1555
1556=back
1557
1558To send a string starting with a B<NUL> (B<^@>) character to the
1559program, start I<action> with a pair of B<NUL> characters (B<^@^@>),
1560the first of which will be stripped off and the balance directed to the
1561program. Otherwise if I<action> begins with B<NUL> followed by
1562non-+B<NUL> characters, the leading B<NUL> is stripped off and the
1563balance is sent back to rxvt.
1564
1565As a convenience for the many Emacs-type editors, I<action> may start
1566with B<M-> (eg, B<M-$> is equivalent to B<\E$>) and a B<CR> will be
1567appended if missed from B<M-x> commands.
1568
1569As a convenience for issuing XTerm B<ESC]> sequences from a menubar (or
1570quick arrow), a B<BEL> (B<^G>) will be appended if needed.
1571
1572=over 4
1573
1574=item For example,
1575
1576B<M-xapropos> is equivalent to B<\Exapropos\r>
1577
1578=item and
1579
1580B<\E]703;mona;100> is equivalent to B<\E]703;mona;100\a>
1581
1582=back
1583
1584The option B<< {I<right-rtext>} >> will be right-justified. In the
1585absence of a specified action, this text will be used as the I<action>
1586as well.
1587
1588=over 4
1589
1590=item For example,
1591
1592B</File/{Open}{^X^F}> is equivalent to B</File/{Open}{^X^F} ^X^F>
1593
1594=back
1595
1596The left label I<is> necessary, since it's used for matching, but
1597implicitly hiding the left label (by using same name for both left and
1598right labels), or explicitly hiding the left label (by preceeding it
1599with a dot), makes it possible to have right-justified text only.
1600
1601=over 4
1602
1603=item For example,
1604
1605B</File/{Open}{Open} Open-File-Action>
1606
1607=item or hiding it
1608
1609B</File/{.anylabel}{Open} Open-File-Action>
1610
1611=back
1612
1613X<menuBarRemove>
1614
1615=head2 Removing menus
1616
1617=over 4
1618
1619=item B<< -/*+ >>
1620
1621remove all menus from the menuBar, the same as B<[clear]>
1622
1623=item B<< -+I</path>menu+ >>
1624
1625remove menu
1626
1627=item B<< -+I</path>{item}+ >>
1628
1629remove item
1630
1631=item B<< -+I</path>{-} >>
1632
1633remove separator)
1634
1635=item B<-/path/menu/*>
1636
1637remove all items, separators and submenus from menu
1638
1639=back
1640
1641X<menuBarArrows>
1642
1643=head2 Quick Arrows
1644
1645The menus also provide a hook for I<quick arrows> to provide easier
1646user access. If nothing has been explicitly set, the default is to
1647emulate the curror keys. The syntax permits each arrow to be altered
1648individually or all four at once without re-entering their common
1649beginning/end text. For example, to explicitly associate cursor actions
1650with the arrows, any of the following forms could be used:
1651
1652=over 4
1653
1654=item B<< <r>+I<Right> >>
1655
1656=item B<< <l>+I<Left> >>
1657
1658=item B<< <u>+I<Up> >>
1659
1660=item B<< <d>+I<Down> >>
1661
1662Define actions for the respective arrow buttons
1663
1664=item B<< <b>+I<Begin> >>
1665
1666=item B<< <e>+I<End> >>
1667
1668Define common beginning/end parts for I<quick arrows> which used in
1669conjunction with the above <r> <l> <u> <d> constructs
1670
1671=back
1672
1673=over 4
1674
1675=item For example, define arrows individually,
1676
1677 <u>\E[A
1678
1679 <d>\E[B
1680
1681 <r>\E[C
1682
1683 <l>\E[D
1684
1685=item or all at once
1686
1687 <u>\E[AZ<><d>\E[BZ<><r>\E[CZ<><l>\E[D
1688
1689=item or more compactly (factoring out common parts)
1690
1691 <b>\E[<u>AZ<><d>BZ<><r>CZ<><l>D
1692
1693=back
1694
1695X<menuBarSummary>
1696
1697=head2 Command Summary
1698
1699A short summary of the most I<common> commands:
1700
1701=over 4
1702
1703=item [menu:name]
1704
1705use an existing named menuBar or start a new one
1706
1707=item [menu]
1708
1709use the current menuBar
1710
1711=item [title:string]
1712
1713set menuBar title
1714
1715=item [done]
1716
1717set menu access to readonly and, if reading from a file, signal EOF
1718
1719=item [done:name]
1720
1721if reading from a file using [read:file;name] signal EOF
1722
1723=item [rm:name]
1724
1725remove named menuBar(s)
1726
1727=item [rm] [rm:]
1728
1729remove current menuBar
1730
1731=item [rm*] [rm:*]
1732
1733remove all menuBar(s)
1734
1735=item [swap]
1736
1737swap top two menuBars
1738
1739=item [prev]
1740
1741access the previous menuBar
1742
1743=item [next]
1744
1745access the next menuBar
1746
1747=item [show]
1748
1749map menuBar
1750
1751=item [hide]
1752
1753unmap menuBar
1754
1755=item [pixmap;file]
1756
1757=item [pixmap;file;scaling]
1758
1759set a background pixmap
1760
1761=item [read:file]
1762
1763=item [read:file;name]
1764
1765read in a menu from a file
1766
1767=item [dump]
1768
1769dump out all menuBars to /tmp/rxvt-PID
1770
1771=item /
1772
1773access menuBar top level
1774
1775=item ./
1776
1777=item ../
1778
1779=item ../../
1780
1781access current or parent menu level
1782
1783=item /path/menu
1784
1785add/access menu
1786
1787=item /path/{-}
1788
1789add separator
1790
1791=item /path/{item}{rtext} action
1792
1793add/alter menu item
1794
1795=item -/*
1796
1797remove all menus from the menuBar
1798
1799=item -/path/menu
1800
1801remove menu items, separators and submenus from menu
1802
1803=item -/path/menu
1804
1805remove menu
1806
1807=item -/path/{item}
1808
1809remove item
1810
1811=item -/path/{-}
1812
1813remove separator
1814
1815=item <b>Begin<r>Right<l>Left<u>Up<d>Down<e>End
1816
1817menu quick arrows
1818
1819=back
1820X<XPM>
1821
1822=head1 XPM
1823
1824For the XPM XTerm escape sequence B<< C<ESC ] 20 ; Pt ST> >> then value 2036For the BACGROUND IMAGE XTerm escape sequence B<< C<ESC ] 20 ; Pt ST> >> then value
1825of B<< C<Pt> >> can be the name of the background pixmap followed by a 2037of B<< C<Pt> >> can be the name of the background image file followed by a
1826sequence of scaling/positioning commands separated by semi-colons. The 2038sequence of scaling/positioning commands separated by semi-colons. The
1827scaling/positioning commands are as follows: 2039scaling/positioning commands are as follows:
1828 2040
1829=over 4 2041=over 4
1830 2042
1868 2080
1869For example: 2081For example:
1870 2082
1871=over 4 2083=over 4
1872 2084
1873=item B<\E]20;funky\a> 2085=item B<\E]20;funky.jpg\a>
1874 2086
1875load B<funky.xpm> as a tiled image 2087load B<funky.jpg> as a tiled image
1876 2088
1877=item B<\E]20;mona;100\a> 2089=item B<\E]20;mona.jpg;100\a>
1878 2090
1879load B<mona.xpm> with a scaling of 100% 2091load B<mona.jpg> with a scaling of 100%
1880 2092
1881=item B<\E]20;;200;?\a> 2093=item B<\E]20;;200;?\a>
1882 2094
1883rescale the current pixmap to 200% and display the image geometry in 2095rescale the current pixmap to 200% and display the image geometry in
1884the title 2096the title
1923=begin table 2135=begin table
1924 2136
1925 4 Shift 2137 4 Shift
1926 8 Meta 2138 8 Meta
1927 16 Control 2139 16 Control
1928 32 Double Click I<(Rxvt extension)> 2140 32 Double Click I<(rxvt extension)>
1929 2141
1930=end table 2142=end table
1931 2143
1932Col = B<< C<< <x> - SPACE >> >> 2144Col = B<< C<< <x> - SPACE >> >>
1933 2145
2010=end table 2222=end table
2011 2223
2012=head1 CONFIGURE OPTIONS 2224=head1 CONFIGURE OPTIONS
2013 2225
2014General hint: if you get compile errors, then likely your configuration 2226General hint: if you get compile errors, then likely your configuration
2015hasn't been tested well. Either try with --enable-everything or use the 2227hasn't been tested well. Either try with C<--enable-everything> or use
2016./reconf script as a base for experiments. ./reconf is used by myself, 2228the default configuration (i.e. no C<--enable-xxx> or C<--disable-xxx>
2017so it should generally be a working config. Of course, you should always 2229switches). Of course, you should always report when a combination doesn't
2018report when a combination doesn't work, so it can be fixed. Marc Lehmann 2230work, so it can be fixed. Marc Lehmann <rxvt@schmorp.de>.
2019<rxvt@schmorp.de>. 2231
2232All
2020 2233
2021=over 4 2234=over 4
2022 2235
2023=item --enable-everything 2236=item --enable-everything
2024 2237
2025Add support for all non-multichoice options listed in "./configure 2238Add (or remove) support for all non-multichoice options listed in "./configure
2026--help". Note that unlike other enable options this is order dependant. 2239--help".
2240
2027You can specify this and then disable options which this enables by 2241You can specify this and then disable options you do not like by
2028I<following> this with the appropriate commands. 2242I<following> this with the appropriate C<--disable-...> arguments,
2243or you can start with a minimal configuration by specifying
2244C<--disable-everything> and than adding just the C<--enable-...> arguments
2245you want.
2029 2246
2030=item --enable-xft 2247=item --enable-xft (default: enabled)
2031 2248
2032Add support for Xft (anti-aliases, among others) fonts. Xft fonts are 2249Add support for Xft (anti-aliases, among others) fonts. Xft fonts are
2033slower and require lots of memory, but as long as you don't use them, you 2250slower and require lots of memory, but as long as you don't use them, you
2034don't pay for them. 2251don't pay for them.
2035 2252
2036=item --enable-font-styles 2253=item --enable-font-styles (default: on)
2037 2254
2038Add support for B<bold>, I<italic> and B<< I<bold italic> >> font 2255Add support for B<bold>, I<italic> and B<< I<bold italic> >> font
2039styles. The fonts can be set manually or automatically. 2256styles. The fonts can be set manually or automatically.
2040 2257
2041=item --with-codesets=NAME,... 2258=item --with-codesets=NAME,... (default: all)
2042 2259
2043Compile in support for additional codeset (encoding) groups (eu, vn are 2260Compile in support for additional codeset (encoding) groups (C<eu>, C<vn>
2044always compiled in, which includes most 8-bit character sets). These 2261are always compiled in, which includes most 8-bit character sets). These
2045codeset tables are currently only used for driving X11 core fonts, they 2262codeset tables are used for driving X11 core fonts, they are not required
2046are not required for Xft fonts. Compiling them in will make your binary 2263for Xft fonts, although having them compiled in lets rxvt-unicode choose
2047bigger (together about 700kB), but it doesn't increase memory usage unless 2264replacement fonts more intelligently. Compiling them in will make your
2265binary bigger (all of together cost about 700kB), but it doesn't increase
2048you use an X11 font requiring one of these encodings. 2266memory usage unless you use a font requiring one of these encodings.
2049 2267
2050=begin table 2268=begin table
2051 2269
2052 all all available codeset groups 2270 all all available codeset groups
2053 cn common chinese encodings 2271 zh common chinese encodings
2054 cn_ext rarely used but very big chinese encodigs 2272 zh_ext rarely used but very big chinese encodings
2055 jp common japanese encodings 2273 jp common japanese encodings
2056 jp_ext rarely used but big japanese encodings 2274 jp_ext rarely used but big japanese encodings
2057 kr korean encodings 2275 kr korean encodings
2058 2276
2059=end table 2277=end table
2060 2278
2061=item --enable-xim 2279=item --enable-xim (default: on)
2062 2280
2063Add support for XIM (X Input Method) protocol. This allows using 2281Add support for XIM (X Input Method) protocol. This allows using
2064alternative input methods (e.g. kinput2) and will also correctly 2282alternative input methods (e.g. kinput2) and will also correctly
2065set up the input for people using dead keys or compose keys. 2283set up the input for people using dead keys or compose keys.
2066 2284
2067=item --enable-unicode3 2285=item --enable-unicode3 (default: off)
2286
2287Recommended to stay off unless you really need non-BMP characters.
2068 2288
2069Enable direct support for displaying unicode codepoints above 2289Enable direct support for displaying unicode codepoints above
207065535 (the basic multilingual page). This increases storage 229065535 (the basic multilingual page). This increases storage
2071requirements per character from 2 to 4 bytes. X11 fonts do not yet 2291requirements per character from 2 to 4 bytes. X11 fonts do not yet
2072support these extra characters, but Xft does. 2292support these extra characters, but Xft does.
2073 2293
2074Please note that rxvt-unicode can store unicode code points >65535 2294Please note that rxvt-unicode can store unicode code points >65535
2075even without this flag, but the number of such characters is 2295even without this flag, but the number of such characters is
2076limited to a view thousand (shared with combining characters, 2296limited to a few thousand (shared with combining characters,
2077see next switch), and right now rxvt-unicode cannot display them 2297see next switch), and right now rxvt-unicode cannot display them
2078(input/output and cut&paste still work, though). 2298(input/output and cut&paste still work, though).
2079 2299
2080=item --enable-combining 2300=item --enable-combining (default: on)
2081 2301
2082Enable automatic composition of combining characters into 2302Enable automatic composition of combining characters into
2083composite characters. This is required for proper viewing of text 2303composite characters. This is required for proper viewing of text
2084where accents are encoded as seperate unicode characters. This is 2304where accents are encoded as seperate unicode characters. This is
2085done by using precomposited characters when available or creating 2305done by using precomposited characters when available or creating
2086new pseudo-characters when no precomposed form exists. 2306new pseudo-characters when no precomposed form exists.
2087 2307
2088Without --enable-unicode3, the number of additional precomposed 2308Without --enable-unicode3, the number of additional precomposed
2089characters is rather limited (2048, if this is full, rxvt will use the 2309characters is somewhat limited (the 6400 private use characters will be
2090private use area, extending the number of combinations to 8448). With 2310(ab-)used). With --enable-unicode3, no practical limit exists.
2091--enable-unicode3, no practical limit exists. This will also enable 2311
2092storage of characters >65535. 2312This option will also enable storage (but not display) of characters
2313beyond plane 0 (>65535) when --enable-unicode3 was not specified.
2093 2314
2094The combining table also contains entries for arabic presentation forms, 2315The combining table also contains entries for arabic presentation forms,
2095but these are not currently used. Bug me if you want these to be used. 2316but these are not currently used. Bug me if you want these to be used (and
2317tell me how these are to be used...).
2096 2318
2097=item --enable-fallback(=CLASS) 2319=item --enable-fallback(=CLASS) (default: Rxvt)
2098 2320
2099When reading resource settings, also read settings for class CLASS 2321When reading resource settings, also read settings for class CLASS. To
2100(default: Rxvt). To disable resource fallback use --disable-fallback. 2322disable resource fallback use --disable-fallback.
2101 2323
2102=item --with-res-name=NAME 2324=item --with-res-name=NAME (default: urxvt)
2103 2325
2104Use the given name (default: urxvt) as default application name when 2326Use the given name as default application name when
2105reading resources. Specify --with-res-name=rxvt to replace rxvt. 2327reading resources. Specify --with-res-name=rxvt to replace rxvt.
2106 2328
2107=item --with-res-class=CLASS 2329=item --with-res-class=CLASS (default: URxvt)
2108 2330
2109Use the given class (default: URxvt) as default application class 2331Use the given class as default application class
2110when reading resources. Specify --with-res-class=Rxvt to replace 2332when reading resources. Specify --with-res-class=Rxvt to replace
2111rxvt. 2333rxvt.
2112 2334
2113=item --enable-utmp 2335=item --enable-utmp (default: on)
2114 2336
2115Write user and tty to utmp file (used by programs like F<w>) at 2337Write user and tty to utmp file (used by programs like F<w>) at
2116start of rxvt execution and delete information when rxvt exits. 2338start of rxvt execution and delete information when rxvt exits.
2117 2339
2118=item --enable-wtmp 2340=item --enable-wtmp (default: on)
2119 2341
2120Write user and tty to wtmp file (used by programs like F<last>) at 2342Write user and tty to wtmp file (used by programs like F<last>) at
2121start of rxvt execution and write logout when rxvt exits. This 2343start of rxvt execution and write logout when rxvt exits. This
2122option requires --enable-utmp to also be specified. 2344option requires --enable-utmp to also be specified.
2123 2345
2124=item --enable-lastlog 2346=item --enable-lastlog (default: on)
2125 2347
2126Write user and tty to lastlog file (used by programs like 2348Write user and tty to lastlog file (used by programs like
2127F<lastlogin>) at start of rxvt execution. This option requires 2349F<lastlogin>) at start of rxvt execution. This option requires
2128--enable-utmp to also be specified. 2350--enable-utmp to also be specified.
2129 2351
2130=item --enable-xpm-background 2352=item --enable-afterimage (default: on)
2131 2353
2132Add support for XPM background pixmaps. 2354Add support for libAfterImage to be used for transparency and background
2355images. It adds support for many file formats including JPG, PNG,
2356SVG, TIFF, GIF, XPM, BMP, ICO, XCF, TGA and AfterStep image XML
2357(L<http://www.afterstep.org/visualdoc.php?show=asimagexml>).
2133 2358
2359This option also adds such eye candy as blending an image over the root
2360background, as well as dynamic scaling and bluring of background images.
2361
2362Note that with this option enabled, @@RXVT_NAME@@'s memory footprint might
2363increase by a few megabytes even if no extra features are used (mostly due
2364to third-party libraries used by libAI). Memory footprint may somewhat be
2365lowered if libAfterImage is configured without support for SVG.
2366
2134=item --enable-transparency 2367=item --enable-transparency (default: on)
2135 2368
2136Add support for inheriting parent backgrounds thus giving a fake 2369Add support for backgrounds, creating illusion of transparency in the term.
2137transparency to the term.
2138 2370
2139=item --enable-fading 2371=item --enable-fading (default: on)
2140 2372
2141Add support for fading the text when focus is lost. 2373Add support for fading the text when focus is lost.
2142 2374
2143=item --enable-tinting
2144
2145Add support for tinting of transparent backgrounds.
2146
2147=item --enable-menubar
2148
2149Add support for our menu bar system (this interacts badly with
2150dynamic locale switching currently).
2151
2152=item --enable-rxvt-scroll 2375=item --enable-rxvt-scroll (default: on)
2153 2376
2154Add support for the original rxvt scrollbar. 2377Add support for the original rxvt scrollbar.
2155 2378
2156=item --enable-next-scroll 2379=item --enable-next-scroll (default: on)
2157 2380
2158Add support for a NeXT-like scrollbar. 2381Add support for a NeXT-like scrollbar.
2159 2382
2160=item --enable-xterm-scroll 2383=item --enable-xterm-scroll (default: on)
2161 2384
2162Add support for an Xterm-like scrollbar. 2385Add support for an Xterm-like scrollbar.
2163 2386
2164=item --enable-plain-scroll 2387=item --enable-plain-scroll (default: on)
2165 2388
2166Add support for a very unobtrusive, plain-looking scrollbar that 2389Add support for a very unobtrusive, plain-looking scrollbar that
2167is the favourite of the rxvt-unicode author, having used it for 2390is the favourite of the rxvt-unicode author, having used it for
2168many years. 2391many years.
2169 2392
2170=item --enable-half-shadow 2393=item --enable-ttygid (default: off)
2171
2172Make shadows on the scrollbar only half the normal width & height.
2173only applicable to rxvt scrollbars.
2174
2175=item --enable-ttygid
2176 2394
2177Change tty device setting to group "tty" - only use this if 2395Change tty device setting to group "tty" - only use this if
2178your system uses this type of security. 2396your system uses this type of security.
2179 2397
2180=item --disable-backspace-key 2398=item --disable-backspace-key
2181 2399
2182Disable any handling of the backspace key by us - let the X server 2400Removes any handling of the backspace key by us - let the X server do it.
2401
2402=item --disable-delete-key
2403
2404Removes any handling of the delete key by us - let the X server
2183do it. 2405do it.
2184 2406
2185=item --disable-delete-key
2186
2187Disable any handling of the delete key by us - let the X server
2188do it.
2189
2190=item --disable-resources 2407=item --disable-resources
2191 2408
2192Remove all resources checking. 2409Removes any support for resource checking.
2193
2194=item --enable-xgetdefault
2195
2196Make resources checking via XGetDefault() instead of our small
2197version which only checks ~/.Xdefaults, or if that doesn't exist
2198then ~/.Xresources.
2199
2200=item --enable-strings
2201
2202Add support for our possibly faster memset() function and other
2203various routines, overriding your system's versions which may
2204have been hand-crafted in assembly or may require extra libraries
2205to link in. (this breaks ANSI-C rules and has problems on many
2206GNU/Linux systems).
2207 2410
2208=item --disable-swapscreen 2411=item --disable-swapscreen
2209 2412
2210Remove support for swap screen. 2413Remove support for secondary/swap screen.
2211 2414
2212=item --enable-frills 2415=item --enable-frills (default: on)
2213 2416
2214Add support for many small features that are not essential but nice to 2417Add support for many small features that are not essential but nice to
2215have. Normally you want this, but for very small binaries you may want to 2418have. Normally you want this, but for very small binaries you may want to
2216disable this. 2419disable this.
2217 2420
2421A non-exhaustive list of features enabled by C<--enable-frills> (possibly
2422in combination with other switches) is:
2423
2424 MWM-hints
2425 EWMH-hints (pid, utf8 names) and protocols (ping)
2426 urgency hint
2427 seperate underline colour (-underlineColor)
2428 settable border widths and borderless switch (-w, -b, -bl)
2429 visual depth selection (-depth)
2430 settable extra linespacing /-lsp)
2431 iso-14755 5.1 (basic) support
2432 tripleclickwords (-tcw)
2433 settable insecure mode (-insecure)
2434 keysym remapping support
2435 cursor blinking and underline cursor (-cb, -uc)
2436 XEmbed support (-embed)
2437 user-pty (-pty-fd)
2438 hold on exit (-hold)
2439 compile in built-in block graphics
2440 skip builtin block graphics (-sbg)
2441 separate highlightcolor support (-hc)
2442
2443It also enables some non-essential features otherwise disabled, such as:
2444
2445 some round-trip time optimisations
2446 nearest color allocation on pseudocolor screens
2447 UTF8_STRING support for selection
2448 sgr modes 90..97 and 100..107
2449 backindex and forwardindex escape sequences
2450 view change/zero scrollback escape sequences
2451 locale switching escape sequence
2452 window op and some xterm/OSC escape sequences
2453 rectangular selections
2454 trailing space removal for selections
2455 verbose X error handling
2456
2218=item --enable-iso14755 2457=item --enable-iso14755 (default: on)
2219 2458
2220Enable extended ISO 14755 support (see @@RXVT_NAME@@(1), or 2459Enable extended ISO 14755 support (see @@RXVT_NAME@@(1), or
2221F<doc/rxvt.1.txt>). Basic support (section 5.1) is enabled by 2460F<doc/rxvt.1.txt>). Basic support (section 5.1) is enabled by
2222C<--enable-frills>, while support for 5.2, 5.3 and 5.4 is enabled with 2461C<--enable-frills>, while support for 5.2, 5.3 and 5.4 is enabled with
2223this switch. 2462this switch.
2224 2463
2225=item --enable-linespace
2226
2227Add support to provide user specified line spacing between text rows.
2228
2229=item --enable-keepscrolling 2464=item --enable-keepscrolling (default: on)
2230 2465
2231Add support for continual scrolling of the display when you hold 2466Add support for continual scrolling of the display when you hold
2232the mouse button down on a scrollbar arrow. 2467the mouse button down on a scrollbar arrow.
2233 2468
2469=item --enable-selectionscrolling (default: on)
2470
2471Add support for scrolling when the selection moves to the top or
2472bottom of the screen.
2473
2234=item --enable-mousewheel 2474=item --enable-mousewheel (default: on)
2235 2475
2236Add support for scrolling via mouse wheel or buttons 4 & 5. 2476Add support for scrolling via mouse wheel or buttons 4 & 5.
2237 2477
2238=item --enable-slipwheeling 2478=item --enable-slipwheeling (default: on)
2239 2479
2240Add support for continual scrolling (using the mouse wheel as an 2480Add support for continual scrolling (using the mouse wheel as an
2241accelerator) while the control key is held down. This option 2481accelerator) while the control key is held down. This option
2242requires --enable-mousewheel to also be specified. 2482requires --enable-mousewheel to also be specified.
2243 2483
2244=item --disable-new-selection
2245
2246Remove support for mouse selection style like that of xterm.
2247
2248=item --enable-dmalloc
2249
2250Use Gray Watson's malloc - which is good for debugging See
2251http://www.letters.com/dmalloc/ for details If you use either this or the
2252next option, you may need to edit src/Makefile after compiling to point
2253DINCLUDE and DLIB to the right places.
2254
2255You can only use either this option and the following (should
2256you use either) .
2257
2258=item --enable-dlmalloc
2259
2260Use Doug Lea's malloc - which is good for a production version
2261See L<http://g.oswego.edu/dl/html/malloc.html> for details.
2262
2263=item --enable-smart-resize 2484=item --enable-smart-resize (default: off)
2264 2485
2265Add smart growth/shrink behaviour when changing font size via from hot 2486Add smart growth/shrink behaviour when resizing.
2266keys. This should keep in a fixed position the rxvt corner which is 2487This should keep the window corner which is closest to a corner of
2267closest to a corner of the screen. 2488the screen in a fixed position.
2268 2489
2269=item --enable-cursor-blink
2270
2271Add support for a blinking cursor.
2272
2273=item --enable-pointer-blank 2490=item --enable-pointer-blank (default: on)
2274 2491
2275Add support to have the pointer disappear when typing or inactive. 2492Add support to have the pointer disappear when typing or inactive.
2276 2493
2277=item --with-name=NAME 2494=item --enable-perl (default: on)
2278 2495
2496Enable an embedded perl interpreter. See the B<@@RXVT_NAME@@perl(3)>
2497manpage (F<doc/rxvtperl.txt>) for more info on this feature, or the
2498files in F<src/perl-ext/> for the extensions that are installed by
2499default. The perl interpreter that is used can be specified via the
2500C<PERL> environment variable when running configure. Even when compiled
2501in, perl will I<not> be initialised when all extensions have been disabled
2502C<-pe "" --perl-ext-common "">, so it should be safe to enable from a
2503resource standpoint.
2504
2505=item --with-afterimage-config=DIR
2506
2507Look for the libAfterImage config script in DIR.
2508
2509=item --with-name=NAME (default: urxvt)
2510
2279Set the basename for the installed binaries (default: urxvt, resulting in 2511Set the basename for the installed binaries, resulting
2280urxvt, urxvtd etc.). Specify --with-name=rxvt to replace rxvt. 2512in C<urxvt>, C<urxvtd> etc.). Specify C<--with-name=rxvt> to replace with
2513C<rxvt>.
2281 2514
2282=item --with-term=NAME 2515=item --with-term=NAME (default: rxvt-unicode)
2283 2516
2284Change the environmental variable for the terminal to NAME (default 2517Change the environmental variable for the terminal to NAME.
2285"rxvt")
2286 2518
2287=item --with-terminfo=PATH 2519=item --with-terminfo=PATH
2288 2520
2289Change the environmental variable for the path to the terminfo tree to 2521Change the environmental variable for the path to the terminfo tree to
2290PATH. 2522PATH.
2291 2523
2292=item --with-x 2524=item --with-x
2293 2525
2294Use the X Window System (pretty much default, eh?). 2526Use the X Window System (pretty much default, eh?).
2295
2296=item --with-xpm-includes=DIR
2297
2298Look for the XPM includes in DIR.
2299
2300=item --with-xpm-library=DIR
2301
2302Look for the XPM library in DIR.
2303
2304=item --with-xpm
2305
2306Not needed - define via --enable-xpm-background.
2307 2527
2308=back 2528=back
2309 2529
2310=head1 AUTHORS 2530=head1 AUTHORS
2311 2531

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines