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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines