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.100 by root, Tue Jan 31 01:00:49 2006 UTC vs.
Revision 1.162 by ayin, Sat Jan 19 15:00:49 2008 UTC

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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines