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.98 by root, Tue Jan 31 00:56:07 2006 UTC vs.
Revision 1.135 by ayin, Sun Jun 24 23:30:17 2007 UTC

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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines