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.96 by root, Tue Jan 31 00:25:16 2006 UTC vs.
Revision 1.145 by root, Sun Sep 9 08:38:40 2007 UTC

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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines