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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines