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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines