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.94 by root, Mon Jan 30 20:12:37 2006 UTC vs.
Revision 1.155 by ayin, Sun Dec 9 12:15:39 2007 UTC

16=head1 DESCRIPTION 16=head1 DESCRIPTION
17 17
18This document contains the FAQ, the RXVT TECHNICAL REFERENCE documenting 18This document contains the FAQ, the RXVT TECHNICAL REFERENCE documenting
19all escape sequences, and other background information. 19all escape sequences, and other background information.
20 20
21The newest version of this document is 21The newest version of this document is also available on the World Wide Web at
22also available on the World Wide Web at
23L<http://cvs.schmorp.de/browse/*checkout*/rxvt-unicode/doc/rxvt.7.html>. 22L<http://cvs.schmorp.de/browse/rxvt-unicode/doc/rxvt.7.html>.
24 23
25=head1 FREQUENTLY ASKED QUESTIONS 24=head1 RXVT-UNICODE/URXVT FREQUENTLY ASKED QUESTIONS
26 25
27=over 4
28 26
29=item The new selection selects pieces that are too big, how can I select 27=head2 Meta, Features & Commandline Issues
30single words?
31 28
32Yes. For example, if you want to select alphanumeric words, you can use 29=head3 My question isn't answered here, can I ask a human?
33the following resource:
34 30
35 URxvt.selection.pattern-0: ([[:word:]]+) 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 :).
36 34
37If you click more than twice, the selection will be extended 35=head3 Does it support tabs, can I have a tabbed rxvt-unicode?
38more and more.
39 36
40To get a selection that is very similar to the old code, try this pattern: 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:
41 40
42 URxvt.selection.pattern-0: ([^"&'()*,;<=>?@[\\\\]^`{|})]+) 41 @@URXVT_NAME@@ -pe tabbed
43 42
44Please also note that the I<LeftClick Shift-LeftClik> combination also 43 URxvt.perl-ext-common: default,tabbed
45selects words like the old code.
46 44
47=item I don't like the new selection/popups/hotkeys/perl, how do I 45It will also work fine with tabbing functionality of many window managers
48change/disable it? 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.
49 50
50You can disable the perl extension completely by setting the 51=head3 How do I know which rxvt-unicode version I'm using?
51B<perl-ext-common> resource to the empty string, which also keeps
52rxvt-unicode from initialising perl, saving memory.
53 52
54If you only want to disable specific features, you first have to 53The version number is displayed with the usage (-h). Also the escape
55identify which perl extension is responsible. For this, read the section 54sequence C<ESC [ 8 n> sets the window title to the version number. When
56B<PREPACKAGED EXTENSIONS> in the @@RXVT_NAME@@perl(3) manpage. For 55using the @@URXVT_NAME@@c client, the version displayed is that of the
57example, to disable the B<selection-popup> and B<option-popup>, specify 56daemon.
58this B<perl-ext-common> resource:
59 57
60 URxvt.perl-ext-common: default,-selection-popup,-option-popup 58=head3 Rxvt-unicode uses gobs of memory, how can I reduce that?
61 59
62This will keep the default extensions, but disable the two popup 60Rxvt-unicode tries to obey the rule of not charging you for something you
63extensions. Some extensions can also be configured, for example, 61don't use. One thing you should try is to configure out all settings that
64scrollback search mode is triggered by B<M-s>. You can move it to any 62you don't need, for example, Xft support is a resource hog by design,
65other combination either by setting the B<searchable-scrollback> resource: 63when used. Compiling it out ensures that no Xft font will be loaded
64accidentally when rxvt-unicode tries to find a font for your characters.
66 65
67 URxvt.searchable-scrollback: CM-s 66Also, many people (me included) like large windows and even larger
67scrollback buffers: Without C<--enable-unicode3>, rxvt-unicode will use
686 bytes per screen cell. For a 160x?? window this amounts to almost a
69kilobyte per line. A scrollback buffer of 10000 lines will then (if full)
70use 10 Megabytes of memory. With C<--enable-unicode3> it gets worse, as
71rxvt-unicode then uses 8 bytes per screen cell.
68 72
73=head3 How can I start @@URXVT_NAME@@d in a race-free way?
74
75Try C<@@URXVT_NAME@@d -f -o>, which tells @@URXVT_NAME@@d to open the
76display, create the listening socket and then fork.
77
78=head3 How can I start @@URXVT_NAME@@d automatically when I run @@URXVT_NAME@@c?
79
80If you want to start @@URXVT_NAME@@d automatically whenever you run
81@@URXVT_NAME@@c and the daemon isn't running yet, use this script:
82
83 #!/bin/sh
84 @@URXVT_NAME@@c "$@"
85 if [ $? -eq 2 ]; then
86 @@URXVT_NAME@@d -q -o -f
87 @@URXVT_NAME@@c "$@"
88 fi
89
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.
94
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.
96
97The original rxvt and rxvt-unicode always export the variable "COLORTERM",
98so you can check and see if that is set. Note that several programs, JED,
99slrn, Midnight Commander automatically check this variable to decide
100whether or not to use color.
101
102=head3 How do I set the correct, full IP address for the DISPLAY variable?
103
104If you've compiled rxvt-unicode with DISPLAY_IS_IP and have enabled
105insecure mode then it is possible to use the following shell script
106snippets to correctly set the display. If your version of rxvt-unicode
107wasn't also compiled with ESCZ_ANSWER (as assumed in these snippets) then
108the COLORTERM variable can be used to distinguish rxvt-unicode from a
109regular xterm.
110
111Courtesy of Chuck Blake <cblake@BBN.COM> with the following shell script
112snippets:
113
114 # Bourne/Korn/POSIX family of shells:
115 [ ${TERM:-foo} = foo ] && TERM=xterm # assume an xterm if we don't know
116 if [ ${TERM:-foo} = xterm ]; then
117 stty -icanon -echo min 0 time 15 # see if enhanced rxvt or not
118 echo -n '^[Z'
119 read term_id
120 stty icanon echo
121 if [ ""${term_id} = '^[[?1;2C' -a ${DISPLAY:-foo} = foo ]; then
122 echo -n '^[[7n' # query the rxvt we are in for the DISPLAY string
123 read DISPLAY # set it in our local shell
124 fi
125 fi
126
127=head3 How do I compile the manual pages on my own?
128
129You need to have a recent version of perl installed as F</usr/bin/perl>,
130one that comes with F<pod2man>, F<pod2text> and F<pod2xhtml> (from
131F<Pod::Xhtml>). Then go to the doc subdirectory and enter C<make alldoc>.
132
69=item Isn't rxvt supposed to be small? Don't all those features bloat? 133=head3 Isn't rxvt-unicode supposed to be small? Don't all those features bloat?
70 134
71I often get asked about this, and I think, no, they didn't cause extra 135I often get asked about this, and I think, no, they didn't cause extra
72bloat. If you compare a minimal rxvt and a minimal urxvt, you can see 136bloat. If you compare a minimal rxvt and a minimal urxvt, you can see
73that the urxvt binary is larger (due to some encoding tables always being 137that the urxvt binary is larger (due to some encoding tables always being
74compiled in), but it actually uses less memory (RSS) after startup. Even 138compiled in), but it actually uses less memory (RSS) after startup. Even
78 142
79 text data bss drs rss filename 143 text data bss drs rss filename
80 98398 1664 24 15695 1824 rxvt --disable-everything 144 98398 1664 24 15695 1824 rxvt --disable-everything
81 188985 9048 66616 18222 1788 urxvt --disable-everything 145 188985 9048 66616 18222 1788 urxvt --disable-everything
82 146
83When you C<--enable-everything> (which _is_ unfair, as this involves xft 147When you C<--enable-everything> (which I<is> unfair, as this involves xft
84and full locale/XIM support which are quite bloaty inside libX11 and my 148and full locale/XIM support which are quite bloaty inside libX11 and my
85libc), the two diverge, but not unreasnobaly so. 149libc), the two diverge, but not unreasonably so.
86 150
87 text data bss drs rss filename 151 text data bss drs rss filename
88 163431 2152 24 20123 2060 rxvt --enable-everything 152 163431 2152 24 20123 2060 rxvt --enable-everything
89 1035683 49680 66648 29096 3680 urxvt --enable-everything 153 1035683 49680 66648 29096 3680 urxvt --enable-everything
90 154
106(21152k + extra 4204k in separate processes) or konsole (22200k + extra 170(21152k + extra 4204k in separate processes) or konsole (22200k + extra
10743180k in daemons that stay around after exit, plus half a minute of 17143180k in daemons that stay around after exit, plus half a minute of
108startup time, including the hundreds of warnings it spits out), it fares 172startup time, including the hundreds of warnings it spits out), it fares
109extremely well *g*. 173extremely well *g*.
110 174
111=item Why C++, isn't that unportable/bloated/uncool? 175=head3 Why C++, isn't that unportable/bloated/uncool?
112 176
113Is this a question? :) It comes up very often. The simple answer is: I had 177Is this a question? :) It comes up very often. The simple answer is: I had
114to write it, and C++ allowed me to write and maintain it in a fraction 178to write it, and C++ allowed me to write and maintain it in a fraction
115of the time and effort (which is a scarce resource for me). Put even 179of the time and effort (which is a scarce resource for me). Put even
116shorter: It simply wouldn't exist without C++. 180shorter: It simply wouldn't exist without C++.
133 197
134And here is rxvt-unicode: 198And here is rxvt-unicode:
135 199
136 libX11.so.6 => /usr/X11R6/lib/libX11.so.6 (0x00002aaaaabc3000) 200 libX11.so.6 => /usr/X11R6/lib/libX11.so.6 (0x00002aaaaabc3000)
137 libgcc_s.so.1 => /lib/libgcc_s.so.1 (0x00002aaaaada2000) 201 libgcc_s.so.1 => /lib/libgcc_s.so.1 (0x00002aaaaada2000)
138 libc.so.6 => /lib/libc.so.6 (0x00002aaaaaeb0000) 202 libc.so.6 => /lib/libc.so.6 (0x00002aaaaaeb0000)
139 libdl.so.2 => /lib/libdl.so.2 (0x00002aaaab0ee000) 203 libdl.so.2 => /lib/libdl.so.2 (0x00002aaaab0ee000)
140 /lib64/ld-linux-x86-64.so.2 (0x00002aaaaaaab000) 204 /lib64/ld-linux-x86-64.so.2 (0x00002aaaaaaab000)
141 205
142No large bloated libraries (of course, none were linked in statically), 206No large bloated libraries (of course, none were linked in statically),
143except maybe libX11 :) 207except maybe libX11 :)
144 208
145=item Does it support tabs, can I have a tabbed rxvt-unicode?
146 209
147Beginning with version 7.3, there is a perl extension that implements a 210=head2 Rendering, Font & Look and Feel Issues
148simple tabbed terminal. It is installed by default, so any of these should
149give you tabs:
150 211
151 @@RXVT_NAME@@ -pe tabbed 212=head3 I can't get transparency working, what am I doing wrong?
152 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
153 URxvt.perl-ext-common: default,tabbed 525 URxvt.perl-ext-common: default,-readline
154 526
155It will also work fine with tabbing functionality of many window managers 527=head3 My numerical keypad acts weird and generates differing output?
156or similar tabbing programs, and its embedding-features allow it to be
157embedded into other programs, as witnessed by F<doc/rxvt-tabbed> or
158the upcoming C<Gtk2::URxvt> perl module, which features a tabbed urxvt
159(murxvt) terminal as an example embedding application.
160 528
161=item How do I know which rxvt-unicode version I'm using? 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.
162 535
163The version number is displayed with the usage (-h). Also the escape 536=head3 My Compose (Multi_key) key is no longer working.
164sequence C<ESC [ 8 n> sets the window title to the version number. When
165using the @@RXVT_NAME@@c client, the version displayed is that of the
166daemon.
167 537
168=item I am using Debian GNU/Linux and have a problem... 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.
169 544
170The Debian GNU/Linux package of rxvt-unicode in sarge contains large 545In this case either do not specify a B<preeditStyle> or specify more than
171patches that considerably change the behaviour of rxvt-unicode (but 546one pre-edit style, such as B<OverTheSpot,Root,None>.
172unfortunately this notice has been removed). Before reporting a bug to
173the original rxvt-unicode author please download and install the genuine
174version (L<http://software.schmorp.de#rxvt-unicode>) and try to reproduce
175the problem. If you cannot, chances are that the problems are specific to
176Debian GNU/Linux, in which case it should be reported via the Debian Bug
177Tracking System (use C<reportbug> to report the bug).
178 547
179For other problems that also affect the Debian package, you can and 548=head3 I cannot type C<Ctrl-Shift-2> to get an ASCII NUL character due to ISO 14755
180probably should use the Debian BTS, too, because, after all, it's also a
181bug in the Debian version and it serves as a reminder for other users that
182might encounter the same issue.
183 549
184=item I am maintaining rxvt-unicode for distribution/OS XXX, any 550Either try C<Ctrl-2> alone (it often is mapped to ASCII NUL even on
185recommendation? 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.
186 555
187You should build one binary with the default options. F<configure> 556=head3 Mouse cut/paste suddenly no longer works.
188now enables most useful options, and the trend goes to making them
189runtime-switchable, too, so there is usually no drawback to enbaling them,
190except higher disk and possibly memory usage. The perl interpreter should
191be enabled, as important functionality (menus, selection, likely more in
192the future) depends on it.
193 557
194You should not overwrite the C<perl-ext-common> snd C<perl-ext> resources 558Make sure that mouse reporting is actually turned off since killing
195system-wide (except maybe with C<defaults>). This will result in useful 559some editors prematurely may leave the mouse in mouse report mode. I've
196behaviour. If your distribution aims at low memory, add an empty 560heard that tcsh may use mouse reporting unless it otherwise specified. A
197C<perl-ext-common> resource to the app-defaults file. This will keep the 561quick check is to see if cut/paste works when the Alt or Shift keys are
198perl interpreter disabled until the user enables it. 562depressed.
199 563
200If you can/want build more binaries, I recommend building a minimal 564=head3 What's with the strange Backspace/Delete key behaviour?
201one with C<--disable-everything> (very useful) and a maximal one with
202C<--enable-everything> (less useful, it will be very big due to a lot of
203encodings built-in that increase download times and are rarely used).
204 565
205=item I need to make it setuid/setgid to support utmp/ptys on my OS, is this safe? 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<^?>.
206 570
207It should be, starting with release 7.1. You are encouraged to properly 571Historically, either value is correct, but rxvt-unicode adopts the debian
208install urxvt with privileges necessary for your OS now. 572policy of using C<^?> when unsure, because it's the one and only correct
573choice :).
209 574
210When rxvt-unicode detects that it runs setuid or setgid, it will fork 575Rxvt-unicode tries to inherit the current stty settings and uses the value
211into a helper process for privileged operations (pty handling on some 576of `erase' to guess the value for backspace. If rxvt-unicode wasn't
212systems, utmp/wtmp/lastlog handling on others) and drop privileges 577started from a terminal (say, from a menu or by remote shell), then the
213immediately. This is much safer than most other terminals that keep 578system value of `erase', which corresponds to CERASE in <termios.h>, will
214privileges while running (but is more relevant to urxvt, as it contains 579be used (which may not be the same as your stty setting).
215things as perl interpreters, which might be "helpful" to attackers).
216 580
217This forking is done as the very first within main(), which is very early 581For starting a new rxvt-unicode:
218and reduces possible bugs to initialisation code run before main(), or
219things like the dynamic loader of your system, which should result in very
220little risk.
221 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
222=item When I log-in to another system it tells me about missing terminfo data? 841=head3 When I log-in to another system it tells me about missing terminfo data?
223 842
224The terminal description used by rxvt-unicode is not as widely available 843The terminal description used by rxvt-unicode is not as widely available
225as that for xterm, or even rxvt (for which the same problem often arises). 844as that for xterm, or even rxvt (for which the same problem often arises).
226 845
227The correct solution for this problem is to install the terminfo, this can 846The correct solution for this problem is to install the terminfo, this can
228be done like this (with ncurses' infocmp): 847be done like this (with ncurses' infocmp and works as user and admin):
229 848
230 REMOTE=remotesystem.domain 849 REMOTE=remotesystem.domain
231 infocmp rxvt-unicode | ssh $REMOTE "cat >/tmp/ti && tic /tmp/ti" 850 infocmp rxvt-unicode | ssh $REMOTE "mkdir -p .terminfo && cat >/tmp/ti && tic /tmp/ti"
232 851
233... or by installing rxvt-unicode normally on the remote system, 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.
234 856
235If you cannot or do not want to do this, then you can simply set 857If you cannot or do not want to do this, then you can simply set
236C<TERM=rxvt> or even C<TERM=xterm>, and live with the small number of 858C<TERM=rxvt> or even C<TERM=xterm>, and live with the small number of
237problems arising, which includes wrong keymapping, less and different 859problems arising, which includes wrong keymapping, less and different
238colours and some refresh errors in fullscreen applications. It's a nice 860colours and some refresh errors in fullscreen applications. It's a nice
243resource to set it: 865resource to set it:
244 866
245 URxvt.termName: rxvt 867 URxvt.termName: rxvt
246 868
247If you don't plan to use B<rxvt> (quite common...) you could also replace 869If you don't plan to use B<rxvt> (quite common...) you could also replace
248the rxvt terminfo file with the rxvt-unicode one. 870the rxvt terminfo file with the rxvt-unicode one and use C<TERM=rxvt>.
249 871
250=item C<tic> outputs some error when compiling the terminfo entry. 872=head3 C<tic> outputs some error when compiling the terminfo entry.
251 873
252Most likely it's the empty definition for C<enacs=>. Just replace it by 874Most likely it's the empty definition for C<enacs=>. Just replace it by
253C<enacs=\E[0@> and try again. 875C<enacs=\E[0@> and try again.
254 876
255=item C<bash>'s readline does not work correctly under @@RXVT_NAME@@. 877=head3 C<bash>'s readline does not work correctly under @@URXVT_NAME@@.
256 878
879See next entry.
880
257=item I need a termcap file entry. 881=head3 I need a termcap file entry.
258 882
259One reason you might want this is that some distributions or operating 883One reason you might want this is that some distributions or operating
260systems still compile some programs using the long-obsoleted termcap 884systems still compile some programs using the long-obsoleted termcap
261library (Fedora Core's bash is one example) and rely on a termcap entry 885library (Fedora Core's bash is one example) and rely on a termcap entry
262for C<rxvt-unicode>. 886for C<rxvt-unicode>.
263 887
264You could use rxvt's termcap entry with resonable results in many cases. 888You could use rxvt's termcap entry with reasonable results in many cases.
265You can also create a termcap entry by using terminfo's infocmp program 889You can also create a termcap entry by using terminfo's infocmp program
266like this: 890like this:
267 891
268 infocmp -C rxvt-unicode 892 infocmp -C rxvt-unicode
269 893
288 :sc=\E7:se=\E[27m:sf=^J:so=\E[7m:sr=\EM:st=\EH:ta=^I:\ 912 :sc=\E7:se=\E[27m:sf=^J:so=\E[7m:sr=\EM:st=\EH:ta=^I:\
289 :te=\E[r\E[?1049l:ti=\E[?1049h:ue=\E[24m:up=\E[A:\ 913 :te=\E[r\E[?1049l:ti=\E[?1049h:ue=\E[24m:up=\E[A:\
290 :us=\E[4m:vb=\E[?5h\E[?5l:ve=\E[?25h:vi=\E[?25l:\ 914 :us=\E[4m:vb=\E[?5h\E[?5l:ve=\E[?25h:vi=\E[?25l:\
291 :vs=\E[?25h: 915 :vs=\E[?25h:
292 916
293=item Why does C<ls> no longer have coloured output? 917=head3 Why does C<ls> no longer have coloured output?
294 918
295The C<ls> in the GNU coreutils unfortunately doesn't use terminfo to 919The C<ls> in the GNU coreutils unfortunately doesn't use terminfo to
296decide wether a terminal has colour, but uses it's own configuration 920decide whether a terminal has colour, but uses its own configuration
297file. Needless to say, C<rxvt-unicode> is not in it's default file (among 921file. Needless to say, C<rxvt-unicode> is not in its default file (among
298with most other terminals supporting colour). Either add: 922with most other terminals supporting colour). Either add:
299 923
300 TERM rxvt-unicode 924 TERM rxvt-unicode
301 925
302to C</etc/DIR_COLORS> or simply add: 926to C</etc/DIR_COLORS> or simply add:
303 927
304 alias ls='ls --color=auto' 928 alias ls='ls --color=auto'
305 929
306to your C<.profile> or C<.bashrc>. 930to your C<.profile> or C<.bashrc>.
307 931
308=item Why doesn't vim/emacs etc. use the 88 colour mode? 932=head3 Why doesn't vim/emacs etc. use the 88 colour mode?
309 933
934See next entry.
935
310=item Why doesn't vim/emacs etc. make use of italic? 936=head3 Why doesn't vim/emacs etc. make use of italic?
311 937
938See next entry.
939
312=item Why are the secondary screen-related options not working properly? 940=head3 Why are the secondary screen-related options not working properly?
313 941
314Make sure you are using C<TERM=rxvt-unicode>. Some pre-packaged 942Make sure you are using C<TERM=rxvt-unicode>. Some pre-packaged
315distributions (most notably Debian GNU/Linux) break rxvt-unicode 943distributions (most notably Debian GNU/Linux) break rxvt-unicode
316by setting C<TERM> to C<rxvt>, which doesn't have these extra 944by setting C<TERM> to C<rxvt>, which doesn't have these extra
317features. Unfortunately, some of these (most notably, again, Debian 945features. Unfortunately, some of these (most notably, again, Debian
318GNU/Linux) furthermore fail to even install the C<rxvt-unicode> terminfo 946GNU/Linux) furthermore fail to even install the C<rxvt-unicode> terminfo
319file, so you will need to install it on your own (See the question B<When 947file, so you will need to install it on your own (See the question B<When
320I log-in to another system it tells me about missing terminfo data?> on 948I log-in to another system it tells me about missing terminfo data?> on
321how to do this). 949how to do this).
322 950
323=item My numerical keypad acts weird and generates differing output?
324 951
325Some Debian GNUL/Linux users seem to have this problem, although no 952=head2 Encoding / Locale / Input Method Issues
326specific details were reported so far. It is possible that this is caused
327by the wrong C<TERM> setting, although the details of wether and how
328this can happen are unknown, as C<TERM=rxvt> should offer a compatible
329keymap. See the answer to the previous question, and please report if that
330helped.
331 953
332=item Rxvt-unicode does not seem to understand the selected encoding? 954=head3 Rxvt-unicode does not seem to understand the selected encoding?
333 955
956See next entry.
957
334=item Unicode does not seem to work? 958=head3 Unicode does not seem to work?
335 959
336If you encounter strange problems like typing an accented character but 960If you encounter strange problems like typing an accented character but
337getting two unrelated other characters or similar, or if program output is 961getting two unrelated other characters or similar, or if program output is
338subtly garbled, then you should check your locale settings. 962subtly garbled, then you should check your locale settings.
339 963
340Rxvt-unicode must be started with the same C<LC_CTYPE> setting as the 964Rxvt-unicode must be started with the same C<LC_CTYPE> setting as the
341programs. Often rxvt-unicode is started in the C<C> locale, while the 965programs running in it. Often rxvt-unicode is started in the C<C> locale,
342login script running within the rxvt-unicode window changes the locale to 966while the login script running within the rxvt-unicode window changes the
343something else, e.g. C<en_GB.UTF-8>. Needless to say, this is not going to work. 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.
344 969
345The best thing is to fix your startup environment, as you will likely run 970The best thing is to fix your startup environment, as you will likely run
346into other problems. If nothing works you can try this in your .profile. 971into other problems. If nothing works you can try this in your .profile.
347 972
348 printf '\e]701;%s\007' "$LC_CTYPE" 973 printf '\33]701;%s\007' "$LC_CTYPE" # $LANG or $LC_ALL are worth a try, too
349 974
350If this doesn't work, then maybe you use a C<LC_CTYPE> specification not 975If this doesn't work, then maybe you use a C<LC_CTYPE> specification not
351supported on your systems. Some systems have a C<locale> command which 976supported on your systems. Some systems have a C<locale> command which
352displays this (also, C<perl -e0> can be used to check locale settings, as 977displays this (also, C<perl -e0> can be used to check locale settings, as
353it will complain loudly if it cannot set the locale). If it displays something 978it will complain loudly if it cannot set the locale). If it displays something
359 984
360If nothing works and you are sure that everything is set correctly then 985If nothing works and you are sure that everything is set correctly then
361you will need to remember a little known fact: Some programs just don't 986you will need to remember a little known fact: Some programs just don't
362support locales :( 987support locales :(
363 988
364=item Why do some characters look so much different than others? 989=head3 How does rxvt-unicode determine the encoding to use?
365 990
366=item How does rxvt-unicode choose fonts? 991See next entry.
367 992
368Most fonts do not contain the full range of Unicode, which is 993=head3 Is there an option to switch encodings?
369fine. Chances are that the font you (or the admin/package maintainer of
370your system/os) have specified does not cover all the characters you want
371to display.
372 994
373B<rxvt-unicode> makes a best-effort try at finding a replacement 995Unlike some other terminals, rxvt-unicode has no encoding switch, and no
374font. Often the result is fine, but sometimes the chosen font looks 996specific "utf-8" mode, such as xterm. In fact, it doesn't even know about
375bad/ugly/wrong. Some fonts have totally strange characters that don't 997UTF-8 or any other encodings with respect to terminal I/O.
376resemble the correct glyph at all, and rxvt-unicode lacks the artificial
377intelligence to detect that a specific glyph is wrong: it has to believe
378the font that the characters it claims to contain indeed look correct.
379 998
380In that case, select a font of your taste and add it to the font list, 999The reasons is that there exists a perfectly fine mechanism for selecting
381e.g.: 1000the encoding, doing I/O and (most important) communicating this to all
382 1001applications so everybody agrees on character properties such as width
383 @@RXVT_NAME@@ -fn basefont,font2,font3... 1002and code number. This mechanism is the I<locale>. Applications not using
384 1003that info will have problems (for example, C<xterm> gets the width of
385When rxvt-unicode sees a character, it will first look at the base 1004characters wrong as it uses its own, locale-independent table under all
386font. If the base font does not contain the character, it will go to the
387next font, and so on. Specifying your own fonts will also speed up this
388search and use less resources within rxvt-unicode and the X-server.
389
390The only limitation is that none of the fonts may be larger than the base
391font, as the base font defines the terminal character cell size, which
392must be the same due to the way terminals work.
393
394=item Why do some chinese characters look so different than others?
395
396This is because there is a difference between script and language --
397rxvt-unicode does not know which language the text that is output is,
398as it only knows the unicode character codes. If rxvt-unicode first
399sees a japanese/chinese character, it might choose a japanese font for
400display. Subsequent japanese characters will use that font. Now, many
401chinese characters aren't represented in japanese fonts, so when the first
402non-japanese character comes up, rxvt-unicode will look for a chinese font
403-- unfortunately at this point, it will still use the japanese font for
404chinese characters that are also in the japanese font.
405
406The workaround is easy: just tag a chinese font at the end of your font
407list (see the previous question). The key is to view the font list as
408a preference list: If you expect more japanese, list a japanese font
409first. If you expect more chinese, put a chinese font first.
410
411In the future it might be possible to switch language preferences at
412runtime (the internal data structure has no problem with using different
413fonts for the same character at the same time, but no interface for this
414has been designed yet).
415
416Until then, you might get away with switching fonts at runtime (see L<Can
417I switch the fonts at runtime?> later in this document).
418
419=item Why does rxvt-unicode sometimes leave pixel droppings?
420
421Most fonts were not designed for terminal use, which means that character
422size varies a lot. A font that is otherwise fine for terminal use might
423contain some characters that are simply too wide. Rxvt-unicode will avoid
424these characters. For characters that are just "a bit" too wide a special
425"careful" rendering mode is used that redraws adjacent characters.
426
427All of this requires that fonts do not lie about character sizes,
428however: Xft fonts often draw glyphs larger than their acclaimed bounding
429box, and rxvt-unicode has no way of detecting this (the correct way is to
430ask for the character bounding box, which unfortunately is wrong in these
431cases). 1005locales).
432 1006
433It's not clear (to me at least), wether this is a bug in Xft, freetype, 1007Rxvt-unicode uses the C<LC_CTYPE> locale category to select encoding. All
434or the respective font. If you encounter this problem you might try using 1008programs doing the same (that is, most) will automatically agree in the
435the C<-lsp> option to give the font more height. If that doesn't work, you 1009interpretation of characters.
436might be forced to use a different font.
437 1010
438All of this is not a problem when using X11 core fonts, as their bounding 1011Unfortunately, there is no system-independent way to select locales, nor
439box data is correct. 1012is there a standard on how locale specifiers will look like.
440 1013
441=item On Solaris 9, many line-drawing characters are too wide. 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.
442 1019
443Seems to be a known bug, read 1020Rxvt-unicode ignores all other locale categories, and except for
444L<http://nixdoc.net/files/forum/about34198.html>. Some people use the 1021the encoding, ignores country or language-specific settings,
445following ugly workaround to get non-double-wide-characters working: 1022i.e. C<de_DE.UTF-8> and C<ja_JP.UTF-8> are the normally same to
1023rxvt-unicode.
446 1024
447 #define wcwidth(x) wcwidth(x) > 1 ? 1 : wcwidth(x) 1025If you want to use a specific encoding you have to make sure you start
1026rxvt-unicode with the correct C<LC_CTYPE> category.
448 1027
449=item My Compose (Multi_key) key is no longer working. 1028=head3 Can I switch locales at runtime?
450 1029
451The most common causes for this are that either your locale is not set 1030Yes, using an escape sequence. Try something like this, which sets
452correctly, or you specified a B<preeditStyle> that is not supported by 1031rxvt-unicode's idea of C<LC_CTYPE>.
453your input method. For example, if you specified B<OverTheSpot> and
454your input method (e.g. the default input method handling Compose keys)
455does not support this (for instance because it is not visual), then
456rxvt-unicode will continue without an input method.
457 1032
458In this case either do not specify a B<preeditStyle> or specify more than 1033 printf '\33]701;%s\007' ja_JP.SJIS
459one pre-edit style, such as B<OverTheSpot,Root,None>.
460 1034
461=item I cannot type C<Ctrl-Shift-2> to get an ASCII NUL character due to ISO 14755 1035See also the previous answer.
462 1036
463Either try C<Ctrl-2> alone (it often is mapped to ASCII NUL even on 1037Sometimes this capability is rather handy when you want to work in
464international keyboards) or simply use ISO 14755 support to your 1038one locale (e.g. C<de_DE.UTF-8>) but some programs don't support it
465advantage, typing <Ctrl-Shift-0> to get a ASCII NUL. This works for other 1039(e.g. UTF-8). For example, I use this script to start C<xjdic>, which
466codes, too, such as C<Ctrl-Shift-1-d> to type the default telnet escape 1040first switches to a locale supported by xjdic and back later:
467character and so on.
468 1041
469=item How can I keep rxvt-unicode from using reverse video so much? 1042 printf '\33]701;%s\007' ja_JP.SJIS
1043 xjdic -js
1044 printf '\33]701;%s\007' de_DE.UTF-8
470 1045
471First of all, make sure you are running with the right terminal settings 1046You can also use xterm's C<luit> program, which usually works fine, except
472(C<TERM=rxvt-unicode>), which will get rid of most of these effects. Then 1047for some locales where character width differs between program- and
473make sure you have specified colours for italic and bold, as otherwise 1048rxvt-unicode-locales.
474rxvt-unicode might use reverse video to simulate the effect:
475 1049
476 URxvt.colorBD: white 1050=head3 I have problems getting my input method working.
477 URxvt.colorIT: green
478 1051
479=item Some programs assume totally weird colours (red instead of blue), how can I fix that? 1052Try a search engine, as this is slightly different for every input method server.
480 1053
481For some unexplainable reason, some rare programs assume a very weird 1054Here is a checklist:
482colour palette when confronted with a terminal with more than the standard
4838 colours (rxvt-unicode supports 88). The right fix is, of course, to fix
484these programs not to assume non-ISO colours without very good reasons.
485 1055
486In the meantime, you can either edit your C<rxvt-unicode> terminfo 1056=over 4
487definition to only claim 8 colour support or use C<TERM=rxvt>, which will
488fix colours but keep you from using other rxvt-unicode features.
489 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
1078
1079=back
1080
1081=head3 My input method wants <some encoding> but I want UTF-8, what can I do?
1082
1083You can specify separate locales for the input method and the rest of the
1084terminal, using the resource C<imlocale>:
1085
1086 URxvt.imlocale: ja_JP.EUC-JP
1087
1088Now you can start your terminal with C<LC_CTYPE=ja_JP.UTF-8> and still
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.
1092
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
490=item I am on FreeBSD and rxvt-unicode does not seem to work at all. 1160=head3 I am on FreeBSD and rxvt-unicode does not seem to work at all.
491 1161
492Rxvt-unicode requires the symbol C<__STDC_ISO_10646__> to be defined 1162Rxvt-unicode requires the symbol C<__STDC_ISO_10646__> to be defined
493in your compile environment, or an implementation that implements it, 1163in your compile environment, or an implementation that implements it,
494wether it defines the symbol or not. C<__STDC_ISO_10646__> requires that 1164whether it defines the symbol or not. C<__STDC_ISO_10646__> requires that
495B<wchar_t> is represented as unicode. 1165B<wchar_t> is represented as unicode.
496 1166
497As you might have guessed, FreeBSD does neither define this symobl nor 1167As you might have guessed, FreeBSD does neither define this symbol nor
498does it support it. Instead, it uses it's own internal representation of 1168does it support it. Instead, it uses its own internal representation of
499B<wchar_t>. This is, of course, completely fine with respect to standards. 1169B<wchar_t>. This is, of course, completely fine with respect to standards.
500 1170
501However, that means rxvt-unicode only works in C<POSIX>, C<ISO-8859-1> and 1171However, that means rxvt-unicode only works in C<POSIX>, C<ISO-8859-1> and
502C<UTF-8> locales under FreeBSD (which all use Unicode as B<wchar_t>. 1172C<UTF-8> locales under FreeBSD (which all use Unicode as B<wchar_t>.
503 1173
517 1187
518The rxvt-unicode author insists that the right way to fix this is in the 1188The rxvt-unicode author insists that the right way to fix this is in the
519system libraries once and for all, instead of forcing every app to carry 1189system libraries once and for all, instead of forcing every app to carry
520complete replacements for them :) 1190complete replacements for them :)
521 1191
522=item I use Solaris 9 and it doesn't compile/work/etc.
523
524Try the diff in F<doc/solaris9.patch> as a base. It fixes the worst
525problems with C<wcwidth> and a compile problem.
526
527=item How can I use rxvt-unicode under cygwin? 1192=head3 How can I use rxvt-unicode under cygwin?
528 1193
529rxvt-unicode should compile and run out of the box on cygwin, using 1194rxvt-unicode should compile and run out of the box on cygwin, using
530the X11 libraries that come with cygwin. libW11 emulation is no 1195the X11 libraries that come with cygwin. libW11 emulation is no
531longer supported (and makes no sense, either, as it only supported a 1196longer supported (and makes no sense, either, as it only supported a
532single font). I recommend starting the X-server in C<-multiwindow> or 1197single font). I recommend starting the X-server in C<-multiwindow> or
535 1200
536At the time of this writing, cygwin didn't seem to support any multi-byte 1201At the time of this writing, cygwin didn't seem to support any multi-byte
537encodings (you might try C<LC_CTYPE=C-UTF-8>), so you are likely limited 1202encodings (you might try C<LC_CTYPE=C-UTF-8>), so you are likely limited
538to 8-bit encodings. 1203to 8-bit encodings.
539 1204
540=item How does rxvt-unicode determine the encoding to use? 1205=head3 Character widths are not correct.
541 1206
542=item Is there an option to switch encodings? 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.
543 1212
544Unlike some other terminals, rxvt-unicode has no encoding switch, and no 1213The solution is to upgrade your system or switch to a better one. A
545specific "utf-8" mode, such as xterm. In fact, it doesn't even know about 1214possibly working workaround is to use a wcwidth implementation like
546UTF-8 or any other encodings with respect to terminal I/O.
547 1215
548The reasons is that there exists a perfectly fine mechanism for selecting 1216http://www.cl.cam.ac.uk/~mgk25/ucs/wcwidth.c
549the encoding, doing I/O and (most important) communicating this to all
550applications so everybody agrees on character properties such as width
551and code number. This mechanism is the I<locale>. Applications not using
552that info will have problems (for example, C<xterm> gets the width of
553characters wrong as it uses it's own, locale-independent table under all
554locales).
555 1217
556Rxvt-unicode uses the C<LC_CTYPE> locale category to select encoding. All
557programs doing the same (that is, most) will automatically agree in the
558interpretation of characters.
559
560Unfortunately, there is no system-independent way to select locales, nor
561is there a standard on how locale specifiers will look like.
562
563On most systems, the content of the C<LC_CTYPE> environment variable
564contains an arbitrary string which corresponds to an already-installed
565locale. Common names for locales are C<en_US.UTF-8>, C<de_DE.ISO-8859-15>,
566C<ja_JP.EUC-JP>, i.e. C<language_country.encoding>, but other forms
567(i.e. C<de> or C<german>) are also common.
568
569Rxvt-unicode ignores all other locale categories, and except for
570the encoding, ignores country or language-specific settings,
571i.e. C<de_DE.UTF-8> and C<ja_JP.UTF-8> are the normally same to
572rxvt-unicode.
573
574If you want to use a specific encoding you have to make sure you start
575rxvt-unicode with the correct C<LC_CTYPE> category.
576
577=item Can I switch locales at runtime?
578
579Yes, using an escape sequence. Try something like this, which sets
580rxvt-unicode's idea of C<LC_CTYPE>.
581
582 printf '\e]701;%s\007' ja_JP.SJIS
583
584See also the previous answer.
585
586Sometimes this capability is rather handy when you want to work in
587one locale (e.g. C<de_DE.UTF-8>) but some programs don't support it
588(e.g. UTF-8). For example, I use this script to start C<xjdic>, which
589first switches to a locale supported by xjdic and back later:
590
591 printf '\e]701;%s\007' ja_JP.SJIS
592 xjdic -js
593 printf '\e]701;%s\007' de_DE.UTF-8
594
595You can also use xterm's C<luit> program, which usually works fine, except
596for some locales where character width differs between program- and
597rxvt-unicode-locales.
598
599=item Can I switch the fonts at runtime?
600
601Yes, using an escape sequence. Try something like this, which has the same
602effect as using the C<-fn> switch, and takes effect immediately:
603
604 printf '\e]50;%s\007' "9x15bold,xft:Kochi Gothic"
605
606This is useful if you e.g. work primarily with japanese (and prefer a
607japanese font), but you have to switch to chinese temporarily, where
608japanese fonts would only be in your way.
609
610You can think of this as a kind of manual ISO-2022 switching.
611
612=item Why do italic characters look as if clipped?
613
614Many fonts have difficulties with italic characters and hinting. For
615example, the otherwise very nicely hinted font C<xft:Bitstream Vera Sans
616Mono> completely fails in it's italic face. A workaround might be to
617enable freetype autohinting, i.e. like this:
618
619 URxvt.italicFont: xft:Bitstream Vera Sans Mono:italic:autohint=true
620 URxvt.boldItalicFont: xft:Bitstream Vera Sans Mono:bold:italic:autohint=true
621
622=item My input method wants <some encoding> but I want UTF-8, what can I do?
623
624You can specify separate locales for the input method and the rest of the
625terminal, using the resource C<imlocale>:
626
627 URxvt.imlocale: ja_JP.EUC-JP
628
629Now you can start your terminal with C<LC_CTYPE=ja_JP.UTF-8> and still
630use your input method. Please note, however, that you will not be able to
631input characters outside C<EUC-JP> in a normal way then, as your input
632method limits you.
633
634=item Rxvt-unicode crashes when the X Input Method changes or exits.
635
636Unfortunately, this is unavoidable, as the XIM protocol is racy by
637design. Applications can avoid some crashes at the expense of memory
638leaks, and Input Methods can avoid some crashes by careful ordering at
639exit time. B<kinput2> (and derived input methods) generally succeeds,
640while B<SCIM> (or similar input methods) fails. In the end, however,
641crashes cannot be completely avoided even if both sides cooperate.
642
643So the only workaround is not to kill your Input Method Servers.
644
645=item Rxvt-unicode uses gobs of memory, how can I reduce that?
646
647Rxvt-unicode tries to obey the rule of not charging you for something you
648don't use. One thing you should try is to configure out all settings that
649you don't need, for example, Xft support is a resource hog by design,
650when used. Compiling it out ensures that no Xft font will be loaded
651accidentally when rxvt-unicode tries to find a font for your characters.
652
653Also, many people (me included) like large windows and even larger
654scrollback buffers: Without C<--enable-unicode3>, rxvt-unicode will use
6556 bytes per screen cell. For a 160x?? window this amounts to almost a
656kilobyte per line. A scrollback buffer of 10000 lines will then (if full)
657use 10 Megabytes of memory. With C<--enable-unicode3> it gets worse, as
658rxvt-unicode then uses 8 bytes per screen cell.
659
660=item Can I speed up Xft rendering somehow?
661
662Yes, the most obvious way to speed it up is to avoid Xft entirely, as
663it is simply slow. If you still want Xft fonts you might try to disable
664antialiasing (by appending C<:antialias=false>), which saves lots of
665memory and also speeds up rendering considerably.
666
667=item Rxvt-unicode doesn't seem to anti-alias its fonts, what is wrong?
668
669Rxvt-unicode will use whatever you specify as a font. If it needs to
670fall back to it's default font search list it will prefer X11 core
671fonts, because they are small and fast, and then use Xft fonts. It has
672antialiasing disabled for most of them, because the author thinks they
673look best that way.
674
675If you want antialiasing, you have to specify the fonts manually.
676
677=item Mouse cut/paste suddenly no longer works.
678
679Make sure that mouse reporting is actually turned off since killing
680some editors prematurely may leave the mouse in mouse report mode. I've
681heard that tcsh may use mouse reporting unless it otherwise specified. A
682quick check is to see if cut/paste works when the Alt or Shift keys are
683depressed.
684
685=item What's with this bold/blink stuff?
686
687If no bold colour is set via C<colorBD:>, bold will invert text using the
688standard foreground colour.
689
690For the standard background colour, blinking will actually make the
691text blink when compiled with C<--enable-blinking>. with standard
692colours. Without C<--enable-blinking>, the blink attribute will be
693ignored.
694
695On ANSI colours, bold/blink attributes are used to set high-intensity
696foreground/background colors.
697
698color0-7 are the low-intensity colors.
699
700color8-15 are the corresponding high-intensity colors.
701
702=item I don't like the screen colors. How do I change them?
703
704You can change the screen colors at run-time using F<~/.Xdefaults>
705resources (or as long-options).
706
707Here are values that are supposed to resemble a VGA screen,
708including the murky brown that passes for low-intensity yellow:
709
710 URxvt.color0: #000000
711 URxvt.color1: #A80000
712 URxvt.color2: #00A800
713 URxvt.color3: #A8A800
714 URxvt.color4: #0000A8
715 URxvt.color5: #A800A8
716 URxvt.color6: #00A8A8
717 URxvt.color7: #A8A8A8
718
719 URxvt.color8: #000054
720 URxvt.color9: #FF0054
721 URxvt.color10: #00FF54
722 URxvt.color11: #FFFF54
723 URxvt.color12: #0000FF
724 URxvt.color13: #FF00FF
725 URxvt.color14: #00FFFF
726 URxvt.color15: #FFFFFF
727
728And here is a more complete set of non-standard colors described (not by
729me) as "pretty girly".
730
731 URxvt.cursorColor: #dc74d1
732 URxvt.pointerColor: #dc74d1
733 URxvt.background: #0e0e0e
734 URxvt.foreground: #4ad5e1
735 URxvt.color0: #000000
736 URxvt.color8: #8b8f93
737 URxvt.color1: #dc74d1
738 URxvt.color9: #dc74d1
739 URxvt.color2: #0eb8c7
740 URxvt.color10: #0eb8c7
741 URxvt.color3: #dfe37e
742 URxvt.color11: #dfe37e
743 URxvt.color5: #9e88f0
744 URxvt.color13: #9e88f0
745 URxvt.color6: #73f7ff
746 URxvt.color14: #73f7ff
747 URxvt.color7: #e1dddd
748 URxvt.color15: #e1dddd
749
750=item How can I start @@RXVT_NAME@@d in a race-free way?
751
752Try C<@@RXVT_NAME@@d -f -o>, which tells @@RXVT_NAME@@d to open the
753display, create the listening socket and then fork.
754
755=item What's with the strange Backspace/Delete key behaviour?
756
757Assuming that the physical Backspace key corresponds to the
758BackSpace keysym (not likely for Linux ... see the following
759question) there are two standard values that can be used for
760Backspace: C<^H> and C<^?>.
761
762Historically, either value is correct, but rxvt-unicode adopts the debian
763policy of using C<^?> when unsure, because it's the one only only correct
764choice :).
765
766Rxvt-unicode tries to inherit the current stty settings and uses the value
767of `erase' to guess the value for backspace. If rxvt-unicode wasn't
768started from a terminal (say, from a menu or by remote shell), then the
769system value of `erase', which corresponds to CERASE in <termios.h>, will
770be used (which may not be the same as your stty setting).
771
772For starting a new rxvt-unicode:
773
774 # use Backspace = ^H
775 $ stty erase ^H
776 $ @@RXVT_NAME@@
777
778 # use Backspace = ^?
779 $ stty erase ^?
780 $ @@RXVT_NAME@@
781
782Toggle with C<ESC [ 36 h> / C<ESC [ 36 l>.
783
784For an existing rxvt-unicode:
785
786 # use Backspace = ^H
787 $ stty erase ^H
788 $ echo -n "^[[36h"
789
790 # use Backspace = ^?
791 $ stty erase ^?
792 $ echo -n "^[[36l"
793
794This helps satisfy some of the Backspace discrepancies that occur, but
795if you use Backspace = C<^H>, make sure that the termcap/terminfo value
796properly reflects that.
797
798The Delete key is a another casualty of the ill-defined Backspace problem.
799To avoid confusion between the Backspace and Delete keys, the Delete
800key has been assigned an escape sequence to match the vt100 for Execute
801(C<ESC [ 3 ~>) and is in the supplied termcap/terminfo.
802
803Some other Backspace problems:
804
805some editors use termcap/terminfo,
806some editors (vim I'm told) expect Backspace = ^H,
807GNU Emacs (and Emacs-like editors) use ^H for help.
808
809Perhaps someday this will all be resolved in a consistent manner.
810
811=item I don't like the key-bindings. How do I change them?
812
813There are some compile-time selections available via configure. Unless
814you have run "configure" with the C<--disable-resources> option you can
815use the `keysym' resource to alter the keystrings associated with keysyms.
816
817Here's an example for a URxvt session started using C<@@RXVT_NAME@@ -name URxvt>
818
819 URxvt.keysym.Home: \033[1~
820 URxvt.keysym.End: \033[4~
821 URxvt.keysym.C-apostrophe: \033<C-'>
822 URxvt.keysym.C-slash: \033<C-/>
823 URxvt.keysym.C-semicolon: \033<C-;>
824 URxvt.keysym.C-grave: \033<C-`>
825 URxvt.keysym.C-comma: \033<C-,>
826 URxvt.keysym.C-period: \033<C-.>
827 URxvt.keysym.C-0x60: \033<C-`>
828 URxvt.keysym.C-Tab: \033<C-Tab>
829 URxvt.keysym.C-Return: \033<C-Return>
830 URxvt.keysym.S-Return: \033<S-Return>
831 URxvt.keysym.S-space: \033<S-Space>
832 URxvt.keysym.M-Up: \033<M-Up>
833 URxvt.keysym.M-Down: \033<M-Down>
834 URxvt.keysym.M-Left: \033<M-Left>
835 URxvt.keysym.M-Right: \033<M-Right>
836 URxvt.keysym.M-C-0: list \033<M-C- 0123456789 >
837 URxvt.keysym.M-C-a: list \033<M-C- abcdefghijklmnopqrstuvwxyz >
838 URxvt.keysym.F12: command:\033]701;zh_CN.GBK\007
839
840See some more examples in the documentation for the B<keysym> resource.
841
842=item I'm using keyboard model XXX that has extra Prior/Next/Insert keys.
843How do I make use of them? For example, the Sun Keyboard type 4
844has the following mappings that rxvt-unicode doesn't recognize.
845
846 KP_Insert == Insert
847 F22 == Print
848 F27 == Home
849 F29 == Prior
850 F33 == End
851 F35 == Next
852
853Rather than have rxvt-unicode try to accommodate all the various possible
854keyboard mappings, it is better to use `xmodmap' to remap the keys as
855required for your particular machine.
856
857=item How do I distinguish wether I'm running rxvt-unicode or a regular xterm?
858I need this to decide about setting colors etc.
859
860rxvt and rxvt-unicode always export the variable "COLORTERM", so you can
861check and see if that is set. Note that several programs, JED, slrn,
862Midnight Commander automatically check this variable to decide whether or
863not to use color.
864
865=item How do I set the correct, full IP address for the DISPLAY variable?
866
867If you've compiled rxvt-unicode with DISPLAY_IS_IP and have enabled
868insecure mode then it is possible to use the following shell script
869snippets to correctly set the display. If your version of rxvt-unicode
870wasn't also compiled with ESCZ_ANSWER (as assumed in these snippets) then
871the COLORTERM variable can be used to distinguish rxvt-unicode from a
872regular xterm.
873
874Courtesy of Chuck Blake <cblake@BBN.COM> with the following shell script
875snippets:
876
877 # Bourne/Korn/POSIX family of shells:
878 [ ${TERM:-foo} = foo ] && TERM=xterm # assume an xterm if we don't know
879 if [ ${TERM:-foo} = xterm ]; then
880 stty -icanon -echo min 0 time 15 # see if enhanced rxvt or not
881 echo -n '^[Z'
882 read term_id
883 stty icanon echo
884 if [ ""${term_id} = '^[[?1;2C' -a ${DISPLAY:-foo} = foo ]; then
885 echo -n '^[[7n' # query the rxvt we are in for the DISPLAY string
886 read DISPLAY # set it in our local shell
887 fi
888 fi
889
890=item How do I compile the manual pages for myself?
891
892You need to have a recent version of perl installed as F</usr/bin/perl>,
893one that comes with F<pod2man>, F<pod2text> and F<pod2html>. Then go to
894the doc subdirectory and enter C<make alldoc>.
895
896=item My question isn't answered here, can I ask a human?
897
898Before sending me mail, you could go to IRC: C<irc.freenode.net>,
899channel C<#rxvt-unicode> has some rxvt-unicode enthusiasts that might be
900interested in learning about new and exciting problems (but not FAQs :).
901
902=back
903
904=head1 RXVT TECHNICAL REFERENCE 1218=head1 RXVT-UNICODE TECHNICAL REFERENCE
905
906=head1 DESCRIPTION
907 1219
908The rest of this document describes various technical aspects of 1220The rest of this document describes various technical aspects of
909B<rxvt-unicode>. First the description of supported command sequences, 1221B<rxvt-unicode>. First the description of supported command sequences,
910followed by pixmap support and last by a description of all features 1222followed by pixmap support and last by a description of all features
911selectable at C<configure> time. 1223selectable at C<configure> time.
912 1224
913=head1 Definitions 1225=head2 Definitions
914 1226
915=over 4 1227=over 4
916 1228
917=item B<< C<c> >> 1229=item B<< C<c> >>
918 1230
936 1248
937A text parameter composed of printable characters. 1249A text parameter composed of printable characters.
938 1250
939=back 1251=back
940 1252
941=head1 Values 1253=head2 Values
942 1254
943=over 4 1255=over 4
944 1256
945=item B<< C<ENQ> >> 1257=item B<< C<ENQ> >>
946 1258
989 1301
990Space Character 1302Space Character
991 1303
992=back 1304=back
993 1305
994=head1 Escape Sequences 1306=head2 Escape Sequences
995 1307
996=over 4 1308=over 4
997 1309
998=item B<< C<ESC # 8> >> 1310=item B<< C<ESC # 8> >>
999 1311
1097 1409
1098=back 1410=back
1099 1411
1100X<CSI> 1412X<CSI>
1101 1413
1102=head1 CSI (Command Sequence Introducer) Sequences 1414=head2 CSI (Command Sequence Introducer) Sequences
1103 1415
1104=over 4 1416=over 4
1105 1417
1106=item B<< C<ESC [ Ps @> >> 1418=item B<< C<ESC [ Ps @> >>
1107 1419
1377 1689
1378=back 1690=back
1379 1691
1380X<PrivateModes> 1692X<PrivateModes>
1381 1693
1382=head1 DEC Private Modes 1694=head2 DEC Private Modes
1383 1695
1384=over 4 1696=over 4
1385 1697
1386=item B<< C<ESC [ ? Pm h> >> 1698=item B<< C<ESC [ ? Pm h> >>
1387 1699
1403 1715
1404Toggle DEC Private Mode Values (rxvt extension). I<where> 1716Toggle DEC Private Mode Values (rxvt extension). I<where>
1405 1717
1406=over 4 1718=over 4
1407 1719
1408=item B<< C<Ps = 1> >> (DECCKM) 1720=item B<< C<Pm = 1> >> (DECCKM)
1409 1721
1410=begin table 1722=begin table
1411 1723
1412 B<< C<h> >> Application Cursor Keys 1724 B<< C<h> >> Application Cursor Keys
1413 B<< C<l> >> Normal Cursor Keys 1725 B<< C<l> >> Normal Cursor Keys
1414 1726
1415=end table 1727=end table
1416 1728
1417=item B<< C<Ps = 2> >> (ANSI/VT52 mode) 1729=item B<< C<Pm = 2> >> (ANSI/VT52 mode)
1418 1730
1419=begin table 1731=begin table
1420 1732
1421 B<< C<h> >> Enter VT52 mode 1733 B<< C<h> >> Enter VT52 mode
1422 B<< C<l> >> Enter VT52 mode 1734 B<< C<l> >> Enter VT52 mode
1423 1735
1424=end table 1736=end table
1425 1737
1426=item B<< C<Ps = 3> >> 1738=item B<< C<Pm = 3> >>
1427 1739
1428=begin table 1740=begin table
1429 1741
1430 B<< C<h> >> 132 Column Mode (DECCOLM) 1742 B<< C<h> >> 132 Column Mode (DECCOLM)
1431 B<< C<l> >> 80 Column Mode (DECCOLM) 1743 B<< C<l> >> 80 Column Mode (DECCOLM)
1432 1744
1433=end table 1745=end table
1434 1746
1435=item B<< C<Ps = 4> >> 1747=item B<< C<Pm = 4> >>
1436 1748
1437=begin table 1749=begin table
1438 1750
1439 B<< C<h> >> Smooth (Slow) Scroll (DECSCLM) 1751 B<< C<h> >> Smooth (Slow) Scroll (DECSCLM)
1440 B<< C<l> >> Jump (Fast) Scroll (DECSCLM) 1752 B<< C<l> >> Jump (Fast) Scroll (DECSCLM)
1441 1753
1442=end table 1754=end table
1443 1755
1444=item B<< C<Ps = 5> >> 1756=item B<< C<Pm = 5> >>
1445 1757
1446=begin table 1758=begin table
1447 1759
1448 B<< C<h> >> Reverse Video (DECSCNM) 1760 B<< C<h> >> Reverse Video (DECSCNM)
1449 B<< C<l> >> Normal Video (DECSCNM) 1761 B<< C<l> >> Normal Video (DECSCNM)
1450 1762
1451=end table 1763=end table
1452 1764
1453=item B<< C<Ps = 6> >> 1765=item B<< C<Pm = 6> >>
1454 1766
1455=begin table 1767=begin table
1456 1768
1457 B<< C<h> >> Origin Mode (DECOM) 1769 B<< C<h> >> Origin Mode (DECOM)
1458 B<< C<l> >> Normal Cursor Mode (DECOM) 1770 B<< C<l> >> Normal Cursor Mode (DECOM)
1459 1771
1460=end table 1772=end table
1461 1773
1462=item B<< C<Ps = 7> >> 1774=item B<< C<Pm = 7> >>
1463 1775
1464=begin table 1776=begin table
1465 1777
1466 B<< C<h> >> Wraparound Mode (DECAWM) 1778 B<< C<h> >> Wraparound Mode (DECAWM)
1467 B<< C<l> >> No Wraparound Mode (DECAWM) 1779 B<< C<l> >> No Wraparound Mode (DECAWM)
1468 1780
1469=end table 1781=end table
1470 1782
1471=item B<< C<Ps = 8> >> I<unimplemented> 1783=item B<< C<Pm = 8> >> I<unimplemented>
1472 1784
1473=begin table 1785=begin table
1474 1786
1475 B<< C<h> >> Auto-repeat Keys (DECARM) 1787 B<< C<h> >> Auto-repeat Keys (DECARM)
1476 B<< C<l> >> No Auto-repeat Keys (DECARM) 1788 B<< C<l> >> No Auto-repeat Keys (DECARM)
1477 1789
1478=end table 1790=end table
1479 1791
1480=item B<< C<Ps = 9> >> X10 XTerm 1792=item B<< C<Pm = 9> >> X10 XTerm
1481 1793
1482=begin table 1794=begin table
1483 1795
1484 B<< C<h> >> Send Mouse X & Y on button press. 1796 B<< C<h> >> Send Mouse X & Y on button press.
1485 B<< C<l> >> No mouse reporting. 1797 B<< C<l> >> No mouse reporting.
1486 1798
1487=end table 1799=end table
1488 1800
1489=item B<< C<Ps = 25> >> 1801=item B<< C<Pm = 25> >>
1490 1802
1491=begin table 1803=begin table
1492 1804
1493 B<< C<h> >> Visible cursor {cnorm/cvvis} 1805 B<< C<h> >> Visible cursor {cnorm/cvvis}
1494 B<< C<l> >> Invisible cursor {civis} 1806 B<< C<l> >> Invisible cursor {civis}
1495 1807
1496=end table 1808=end table
1497 1809
1498=item B<< C<Ps = 30> >> 1810=item B<< C<Pm = 30> >>
1499 1811
1500=begin table 1812=begin table
1501 1813
1502 B<< C<h> >> scrollBar visisble 1814 B<< C<h> >> scrollBar visisble
1503 B<< C<l> >> scrollBar invisisble 1815 B<< C<l> >> scrollBar invisisble
1504 1816
1505=end table 1817=end table
1506 1818
1507=item B<< C<Ps = 35> >> (B<rxvt>) 1819=item B<< C<Pm = 35> >> (B<rxvt>)
1508 1820
1509=begin table 1821=begin table
1510 1822
1511 B<< C<h> >> Allow XTerm Shift+key sequences 1823 B<< C<h> >> Allow XTerm Shift+key sequences
1512 B<< C<l> >> Disallow XTerm Shift+key sequences 1824 B<< C<l> >> Disallow XTerm Shift+key sequences
1513 1825
1514=end table 1826=end table
1515 1827
1516=item B<< C<Ps = 38> >> I<unimplemented> 1828=item B<< C<Pm = 38> >> I<unimplemented>
1517 1829
1518Enter Tektronix Mode (DECTEK) 1830Enter Tektronix Mode (DECTEK)
1519 1831
1520=item B<< C<Ps = 40> >> 1832=item B<< C<Pm = 40> >>
1521 1833
1522=begin table 1834=begin table
1523 1835
1524 B<< C<h> >> Allow 80/132 Mode 1836 B<< C<h> >> Allow 80/132 Mode
1525 B<< C<l> >> Disallow 80/132 Mode 1837 B<< C<l> >> Disallow 80/132 Mode
1526 1838
1527=end table 1839=end table
1528 1840
1529=item B<< C<Ps = 44> >> I<unimplemented> 1841=item B<< C<Pm = 44> >> I<unimplemented>
1530 1842
1531=begin table 1843=begin table
1532 1844
1533 B<< C<h> >> Turn On Margin Bell 1845 B<< C<h> >> Turn On Margin Bell
1534 B<< C<l> >> Turn Off Margin Bell 1846 B<< C<l> >> Turn Off Margin Bell
1535 1847
1536=end table 1848=end table
1537 1849
1538=item B<< C<Ps = 45> >> I<unimplemented> 1850=item B<< C<Pm = 45> >> I<unimplemented>
1539 1851
1540=begin table 1852=begin table
1541 1853
1542 B<< C<h> >> Reverse-wraparound Mode 1854 B<< C<h> >> Reverse-wraparound Mode
1543 B<< C<l> >> No Reverse-wraparound Mode 1855 B<< C<l> >> No Reverse-wraparound Mode
1544 1856
1545=end table 1857=end table
1546 1858
1547=item B<< C<Ps = 46> >> I<unimplemented> 1859=item B<< C<Pm = 46> >> I<unimplemented>
1548 1860
1549=item B<< C<Ps = 47> >> 1861=item B<< C<Pm = 47> >>
1550 1862
1551=begin table 1863=begin table
1552 1864
1553 B<< C<h> >> Use Alternate Screen Buffer 1865 B<< C<h> >> Use Alternate Screen Buffer
1554 B<< C<l> >> Use Normal Screen Buffer 1866 B<< C<l> >> Use Normal Screen Buffer
1555 1867
1556=end table 1868=end table
1557 1869
1558X<Priv66> 1870X<Priv66>
1559 1871
1560=item B<< C<Ps = 66> >> 1872=item B<< C<Pm = 66> >>
1561 1873
1562=begin table 1874=begin table
1563 1875
1564 B<< C<h> >> Application Keypad (DECPAM) == C<ESC => 1876 B<< C<h> >> Application Keypad (DECPAM) == C<ESC =>
1565 B<< C<l> >> Normal Keypad (DECPNM) == C<< ESC > >> 1877 B<< C<l> >> Normal Keypad (DECPNM) == C<< ESC > >>
1566 1878
1567=end table 1879=end table
1568 1880
1569=item B<< C<Ps = 67> >> 1881=item B<< C<Pm = 67> >>
1570 1882
1571=begin table 1883=begin table
1572 1884
1573 B<< C<h> >> Backspace key sends B<< C<BS> (DECBKM) >> 1885 B<< C<h> >> Backspace key sends B<< C<BS> (DECBKM) >>
1574 B<< C<l> >> Backspace key sends B<< C<DEL> >> 1886 B<< C<l> >> Backspace key sends B<< C<DEL> >>
1575 1887
1576=end table 1888=end table
1577 1889
1578=item B<< C<Ps = 1000> >> (X11 XTerm) 1890=item B<< C<Pm = 1000> >> (X11 XTerm)
1579 1891
1580=begin table 1892=begin table
1581 1893
1582 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.
1583 B<< C<l> >> No mouse reporting. 1895 B<< C<l> >> No mouse reporting.
1584 1896
1585=end table 1897=end table
1586 1898
1587=item B<< C<Ps = 1001> >> (X11 XTerm) I<unimplemented> 1899=item B<< C<Pm = 1001> >> (X11 XTerm) I<unimplemented>
1588 1900
1589=begin table 1901=begin table
1590 1902
1591 B<< C<h> >> Use Hilite Mouse Tracking. 1903 B<< C<h> >> Use Hilite Mouse Tracking.
1592 B<< C<l> >> No mouse reporting. 1904 B<< C<l> >> No mouse reporting.
1593 1905
1594=end table 1906=end table
1595 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
1596=item B<< C<Ps = 1010> >> (B<rxvt>) 1926=item B<< C<Pm = 1010> >> (B<rxvt>)
1597 1927
1598=begin table 1928=begin table
1599 1929
1600 B<< C<h> >> Don't scroll to bottom on TTY output 1930 B<< C<h> >> Don't scroll to bottom on TTY output
1601 B<< C<l> >> Scroll to bottom on TTY output 1931 B<< C<l> >> Scroll to bottom on TTY output
1602 1932
1603=end table 1933=end table
1604 1934
1605=item B<< C<Ps = 1011> >> (B<rxvt>) 1935=item B<< C<Pm = 1011> >> (B<rxvt>)
1606 1936
1607=begin table 1937=begin table
1608 1938
1609 B<< C<h> >> Scroll to bottom when a key is pressed 1939 B<< C<h> >> Scroll to bottom when a key is pressed
1610 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
1611 1941
1612=end table 1942=end table
1613 1943
1614=item B<< C<Ps = 1021> >> (B<rxvt>) 1944=item B<< C<Pm = 1021> >> (B<rxvt>)
1615 1945
1616=begin table 1946=begin table
1617 1947
1618 B<< C<h> >> Bold/italic implies high intensity (see option B<-is>) 1948 B<< C<h> >> Bold/italic implies high intensity (see option B<-is>)
1619 B<< C<l> >> Font styles have no effect on intensity (Compile styles) 1949 B<< C<l> >> Font styles have no effect on intensity (Compile styles)
1620 1950
1621=end table 1951=end table
1622 1952
1623=item B<< C<Ps = 1047> >> 1953=item B<< C<Pm = 1047> >>
1624 1954
1625=begin table 1955=begin table
1626 1956
1627 B<< C<h> >> Use Alternate Screen Buffer 1957 B<< C<h> >> Use Alternate Screen Buffer
1628 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
1629 1959
1630=end table 1960=end table
1631 1961
1632=item B<< C<Ps = 1048> >> 1962=item B<< C<Pm = 1048> >>
1633 1963
1634=begin table 1964=begin table
1635 1965
1636 B<< C<h> >> Save cursor position 1966 B<< C<h> >> Save cursor position
1637 B<< C<l> >> Restore cursor position 1967 B<< C<l> >> Restore cursor position
1638 1968
1639=end table 1969=end table
1640 1970
1641=item B<< C<Ps = 1049> >> 1971=item B<< C<Pm = 1049> >>
1642 1972
1643=begin table 1973=begin table
1644 1974
1645 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
1646 B<< C<l> >> Use Normal Screen Buffer 1976 B<< C<l> >> Use Normal Screen Buffer
1651 1981
1652=back 1982=back
1653 1983
1654X<XTerm> 1984X<XTerm>
1655 1985
1656=head1 XTerm Operating System Commands 1986=head2 XTerm Operating System Commands
1657 1987
1658=over 4 1988=over 4
1659 1989
1660=item B<< C<ESC ] Ps;Pt ST> >> 1990=item B<< C<ESC ] Ps;Pt ST> >>
1661 1991
1675 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> >>
1676 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> >>
1677 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> >>
1678 B<< C<Ps = 18> >> Change colour of bold characters to B<< C<Pt> >> [deprecated, see 706] 2008 B<< C<Ps = 18> >> Change colour of bold characters to B<< C<Pt> >> [deprecated, see 706]
1679 B<< C<Ps = 19> >> Change colour of underlined characters to B<< C<Pt> >> [deprecated, see 707] 2009 B<< C<Ps = 19> >> Change colour of underlined characters to B<< C<Pt> >> [deprecated, see 707]
1680 B<< C<Ps = 20> >> Change background pixmap parameters (see section XPM) (Compile XPM). 2010 B<< C<Ps = 20> >> Change background pixmap parameters (see section BACKGROUND IMAGE) (Compile AfterImage).
1681 B<< C<Ps = 39> >> Change default foreground colour to B<< C<Pt> >>. 2011 B<< C<Ps = 39> >> Change default foreground colour to B<< C<Pt> >>.
1682 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>
1683 B<< C<Ps = 49> >> Change default background colour to B<< C<Pt> >>. 2013 B<< C<Ps = 49> >> Change default background colour to B<< C<Pt> >>.
1684 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> >>
1685 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> >>
1699 2029
1700=end table 2030=end table
1701 2031
1702=back 2032=back
1703 2033
1704X<XPM> 2034=head1 BACKGROUND IMAGE
1705 2035
1706=head1 XPM
1707
1708For 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
1709of 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
1710sequence of scaling/positioning commands separated by semi-colons. The 2038sequence of scaling/positioning commands separated by semi-colons. The
1711scaling/positioning commands are as follows: 2039scaling/positioning commands are as follows:
1712 2040
1713=over 4 2041=over 4
1714 2042
1752 2080
1753For example: 2081For example:
1754 2082
1755=over 4 2083=over 4
1756 2084
1757=item B<\E]20;funky\a> 2085=item B<\E]20;funky.jpg\a>
1758 2086
1759load B<funky.xpm> as a tiled image 2087load B<funky.jpg> as a tiled image
1760 2088
1761=item B<\E]20;mona;100\a> 2089=item B<\E]20;mona.jpg;100\a>
1762 2090
1763load B<mona.xpm> with a scaling of 100% 2091load B<mona.jpg> with a scaling of 100%
1764 2092
1765=item B<\E]20;;200;?\a> 2093=item B<\E]20;;200;?\a>
1766 2094
1767rescale the current pixmap to 200% and display the image geometry in 2095rescale the current pixmap to 200% and display the image geometry in
1768the title 2096the title
1807=begin table 2135=begin table
1808 2136
1809 4 Shift 2137 4 Shift
1810 8 Meta 2138 8 Meta
1811 16 Control 2139 16 Control
1812 32 Double Click I<(Rxvt extension)> 2140 32 Double Click I<(rxvt extension)>
1813 2141
1814=end table 2142=end table
1815 2143
1816Col = B<< C<< <x> - SPACE >> >> 2144Col = B<< C<< <x> - SPACE >> >>
1817 2145
1895 2223
1896=head1 CONFIGURE OPTIONS 2224=head1 CONFIGURE OPTIONS
1897 2225
1898General hint: if you get compile errors, then likely your configuration 2226General hint: if you get compile errors, then likely your configuration
1899hasn't been tested well. Either try with C<--enable-everything> or use 2227hasn't been tested well. Either try with C<--enable-everything> or use
1900the F<./reconf> script as a base for experiments. F<./reconf> is used by 2228the default configuration (i.e. no C<--enable-xxx> or C<--disable-xxx>
1901myself, so it should generally be a working config. Of course, you should 2229switches). Of course, you should always report when a combination doesn't
1902always report when a combination doesn't work, so it can be fixed. Marc 2230work, so it can be fixed. Marc Lehmann <rxvt@schmorp.de>.
1903Lehmann <rxvt@schmorp.de>.
1904 2231
1905All 2232All
1906 2233
1907=over 4 2234=over 4
1908 2235
1940 2267
1941=begin table 2268=begin table
1942 2269
1943 all all available codeset groups 2270 all all available codeset groups
1944 zh common chinese encodings 2271 zh common chinese encodings
1945 zh_ext rarely used but very big chinese encodigs 2272 zh_ext rarely used but very big chinese encodings
1946 jp common japanese encodings 2273 jp common japanese encodings
1947 jp_ext rarely used but big japanese encodings 2274 jp_ext rarely used but big japanese encodings
1948 kr korean encodings 2275 kr korean encodings
1949 2276
1950=end table 2277=end table
1964requirements 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
1965support these extra characters, but Xft does. 2292support these extra characters, but Xft does.
1966 2293
1967Please note that rxvt-unicode can store unicode code points >65535 2294Please note that rxvt-unicode can store unicode code points >65535
1968even without this flag, but the number of such characters is 2295even without this flag, but the number of such characters is
1969limited to a view thousand (shared with combining characters, 2296limited to a few thousand (shared with combining characters,
1970see next switch), and right now rxvt-unicode cannot display them 2297see next switch), and right now rxvt-unicode cannot display them
1971(input/output and cut&paste still work, though). 2298(input/output and cut&paste still work, though).
1972 2299
1973=item --enable-combining (default: on) 2300=item --enable-combining (default: on)
1974 2301
1997=item --with-res-name=NAME (default: urxvt) 2324=item --with-res-name=NAME (default: urxvt)
1998 2325
1999Use the given name as default application name when 2326Use the given name as default application name when
2000reading resources. Specify --with-res-name=rxvt to replace rxvt. 2327reading resources. Specify --with-res-name=rxvt to replace rxvt.
2001 2328
2002=item --with-res-class=CLASS /default: URxvt) 2329=item --with-res-class=CLASS (default: URxvt)
2003 2330
2004Use the given class as default application class 2331Use the given class as default application class
2005when reading resources. Specify --with-res-class=Rxvt to replace 2332when reading resources. Specify --with-res-class=Rxvt to replace
2006rxvt. 2333rxvt.
2007 2334
2020 2347
2021Write user and tty to lastlog file (used by programs like 2348Write user and tty to lastlog file (used by programs like
2022F<lastlogin>) at start of rxvt execution. This option requires 2349F<lastlogin>) at start of rxvt execution. This option requires
2023--enable-utmp to also be specified. 2350--enable-utmp to also be specified.
2024 2351
2025=item --enable-xpm-background (default: on) 2352=item --enable-afterimage (default: on)
2026 2353
2027Add 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>).
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.
2028 2366
2029=item --enable-transparency (default: on) 2367=item --enable-transparency (default: on)
2030 2368
2031Add support for inheriting parent backgrounds thus giving a fake 2369Add support for backgrounds, creating illusion of transparency in the term.
2032transparency to the term.
2033 2370
2034=item --enable-fading (default: on) 2371=item --enable-fading (default: on)
2035 2372
2036Add support for fading the text when focus is lost (requires C<--enable-transparency>). 2373Add support for fading the text when focus is lost.
2037
2038=item --enable-tinting (default: on)
2039
2040Add support for tinting of transparent backgrounds (requires C<--enable-transparency>).
2041 2374
2042=item --enable-rxvt-scroll (default: on) 2375=item --enable-rxvt-scroll (default: on)
2043 2376
2044Add support for the original rxvt scrollbar. 2377Add support for the original rxvt scrollbar.
2045 2378
2088A non-exhaustive list of features enabled by C<--enable-frills> (possibly 2421A non-exhaustive list of features enabled by C<--enable-frills> (possibly
2089in combination with other switches) is: 2422in combination with other switches) is:
2090 2423
2091 MWM-hints 2424 MWM-hints
2092 EWMH-hints (pid, utf8 names) and protocols (ping) 2425 EWMH-hints (pid, utf8 names) and protocols (ping)
2426 urgency hint
2093 seperate underline colour (-underlineColor) 2427 seperate underline colour (-underlineColor)
2094 settable border widths and borderless switch (-w, -b, -bl) 2428 settable border widths and borderless switch (-w, -b, -bl)
2095 visual depth selection (-depth) 2429 visual depth selection (-depth)
2096 settable extra linespacing /-lsp) 2430 settable extra linespacing /-lsp)
2097 iso-14755-2 and -3, and visual feedback 2431 iso-14755 5.1 (basic) support
2098 tripleclickwords (-tcw) 2432 tripleclickwords (-tcw)
2099 settable insecure mode (-insecure) 2433 settable insecure mode (-insecure)
2100 keysym remapping support 2434 keysym remapping support
2101 cursor blinking and underline cursor (-cb, -uc) 2435 cursor blinking and underline cursor (-cb, -uc)
2102 XEmbed support (-embed) 2436 XEmbed support (-embed)
2103 user-pty (-pty-fd) 2437 user-pty (-pty-fd)
2104 hold on exit (-hold) 2438 hold on exit (-hold)
2439 compile in built-in block graphics
2105 skip builtin block graphics (-sbg) 2440 skip builtin block graphics (-sbg)
2441 separate highlightcolor support (-hc)
2106 2442
2107It also enabled some non-essential features otherwise disabled, such as: 2443It also enables some non-essential features otherwise disabled, such as:
2108 2444
2109 some round-trip time optimisations 2445 some round-trip time optimisations
2110 nearest color allocation on pseudocolor screens 2446 nearest color allocation on pseudocolor screens
2111 UTF8_STRING supporr for selection 2447 UTF8_STRING support for selection
2112 sgr modes 90..97 and 100..107 2448 sgr modes 90..97 and 100..107
2113 backindex and forwardindex escape sequences 2449 backindex and forwardindex escape sequences
2114 view change/zero scorllback esacpe sequences 2450 view change/zero scrollback escape sequences
2115 locale switching escape sequence 2451 locale switching escape sequence
2116 window op and some xterm/OSC escape sequences 2452 window op and some xterm/OSC escape sequences
2117 rectangular selections 2453 rectangular selections
2118 trailing space removal for selections 2454 trailing space removal for selections
2119 verbose X error handling 2455 verbose X error handling
2128=item --enable-keepscrolling (default: on) 2464=item --enable-keepscrolling (default: on)
2129 2465
2130Add support for continual scrolling of the display when you hold 2466Add support for continual scrolling of the display when you hold
2131the mouse button down on a scrollbar arrow. 2467the mouse button down on a scrollbar arrow.
2132 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
2133=item --enable-mousewheel (default: on) 2474=item --enable-mousewheel (default: on)
2134 2475
2135Add support for scrolling via mouse wheel or buttons 4 & 5. 2476Add support for scrolling via mouse wheel or buttons 4 & 5.
2136 2477
2137=item --enable-slipwheeling (default: on) 2478=item --enable-slipwheeling (default: on)
2138 2479
2139Add support for continual scrolling (using the mouse wheel as an 2480Add support for continual scrolling (using the mouse wheel as an
2140accelerator) while the control key is held down. This option 2481accelerator) while the control key is held down. This option
2141requires --enable-mousewheel to also be specified. 2482requires --enable-mousewheel to also be specified.
2142 2483
2143=item --disable-new-selection
2144
2145Remove support for mouse selection style like that of xterm.
2146
2147=item --enable-dmalloc (default: off)
2148
2149Use Gray Watson's malloc - which is good for debugging See
2150http://www.letters.com/dmalloc/ for details If you use either this or the
2151next option, you may need to edit src/Makefile after compiling to point
2152DINCLUDE and DLIB to the right places.
2153
2154You can only use either this option and the following (should
2155you use either) .
2156
2157=item --enable-dlmalloc (default: off)
2158
2159Use Doug Lea's malloc - which is good for a production version
2160See L<http://g.oswego.edu/dl/html/malloc.html> for details.
2161
2162=item --enable-smart-resize (default: on) 2484=item --enable-smart-resize (default: off)
2163 2485
2164Add smart growth/shrink behaviour when changing font size via hot 2486Add smart growth/shrink behaviour when resizing.
2165keys. This should keep the window corner which is closest to a corner of 2487This should keep the window corner which is closest to a corner of
2166the screen in a fixed position. 2488the screen in a fixed position.
2167 2489
2168=item --enable-pointer-blank (default: on) 2490=item --enable-pointer-blank (default: on)
2169 2491
2170Add support to have the pointer disappear when typing or inactive. 2492Add support to have the pointer disappear when typing or inactive.
2171 2493
2172=item --enable-perl (default: on) 2494=item --enable-perl (default: on)
2173 2495
2174Enable an embedded perl interpreter. See the B<@@RXVT_NAME@@perl(3)> 2496Enable an embedded perl interpreter. See the B<@@RXVT_NAME@@perl(3)>
2175manpage (F<doc/rxvtperl.txt>) for more info on this feature, or the files 2497manpage (F<doc/rxvtperl.txt>) for more info on this feature, or the
2176in F<src/perl-ext/> for the extensions that are installed by default. The 2498files in F<src/perl-ext/> for the extensions that are installed by
2177perl interpreter that is used can be specified via the C<PERL> environment 2499default. The perl interpreter that is used can be specified via the
2178variable when running configure. 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.
2179 2508
2180=item --with-name=NAME (default: urxvt) 2509=item --with-name=NAME (default: urxvt)
2181 2510
2182Set the basename for the installed binaries, resulting 2511Set the basename for the installed binaries, resulting
2183in C<urxvt>, C<urxvtd> etc.). Specify C<--with-name=rxvt> to replace with 2512in C<urxvt>, C<urxvtd> etc.). Specify C<--with-name=rxvt> to replace with
2193PATH. 2522PATH.
2194 2523
2195=item --with-x 2524=item --with-x
2196 2525
2197Use the X Window System (pretty much default, eh?). 2526Use the X Window System (pretty much default, eh?).
2198
2199=item --with-xpm-includes=DIR
2200
2201Look for the XPM includes in DIR.
2202
2203=item --with-xpm-library=DIR
2204
2205Look for the XPM library in DIR.
2206
2207=item --with-xpm
2208
2209Not needed - define via --enable-xpm-background.
2210 2527
2211=back 2528=back
2212 2529
2213=head1 AUTHORS 2530=head1 AUTHORS
2214 2531

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines