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.102 by root, Tue Jan 31 20:50:48 2006 UTC

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/*checkout*/rxvt-unicode/doc/rxvt.7.html>.
23 23
24=head1 FREQUENTLY ASKED QUESTIONS 24=head1 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 @@RXVT_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 @@RXVT_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 @@RXVT_NAME@@d in a race-free way?
69 74
70Well, why, indeed? It does, in a way very similar to other X 75Try C<@@RXVT_NAME@@d -f -o>, which tells @@RXVT_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 do I distinguish wether I'm running rxvt-unicode or a regular xterm? I need this to decide about setting colors etc.
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: 80rxvt and rxvt-unicode always export the variable "COLORTERM", so you can
81check and see if that is set. Note that several programs, JED, slrn,
82Midnight Commander automatically check this variable to decide whether or
83not to use color.
81 84
82 URxvt.resource: value 85=head3 How do I set the correct, full IP address for the DISPLAY variable?
83 86
84If you want to use another form (there are lots of different ways of 87If you've compiled rxvt-unicode with DISPLAY_IS_IP and have enabled
85specifying resources), make sure you understand wether and why it 88insecure mode then it is possible to use the following shell script
86works. If unsure, use the form above. 89snippets to correctly set the display. If your version of rxvt-unicode
90wasn't also compiled with ESCZ_ANSWER (as assumed in these snippets) then
91the COLORTERM variable can be used to distinguish rxvt-unicode from a
92regular xterm.
87 93
88=item I can't get transparency working, what am I doing wrong? 94Courtesy of Chuck Blake <cblake@BBN.COM> with the following shell script
95snippets:
89 96
90First of all, transparency isn't officially supported in rxvt-unicode, so 97 # Bourne/Korn/POSIX family of shells:
91you are mostly on your own. Do not bug the author about it (but you may 98 [ ${TERM:-foo} = foo ] && TERM=xterm # assume an xterm if we don't know
92bug everybody else). Also, if you can't get it working consider it a rite 99 if [ ${TERM:-foo} = xterm ]; then
93of passage: ... and you failed. 100 stty -icanon -echo min 0 time 15 # see if enhanced rxvt or not
101 echo -n '^[Z'
102 read term_id
103 stty icanon echo
104 if [ ""${term_id} = '^[[?1;2C' -a ${DISPLAY:-foo} = foo ]; then
105 echo -n '^[[7n' # query the rxvt we are in for the DISPLAY string
106 read DISPLAY # set it in our local shell
107 fi
108 fi
94 109
95Here are four ways to get transparency. B<Do> read the manpage and option 110=head3 How do I compile the manual pages on my own?
96descriptions for the programs mentioned and rxvt-unicode. Really, do it!
97 111
981. Use inheritPixmap: 112You need to have a recent version of perl installed as F</usr/bin/perl>,
113one that comes with F<pod2man>, F<pod2text> and F<pod2html>. Then go to
114the doc subdirectory and enter C<make alldoc>.
99 115
100 Esetroot wallpaper.jpg
101 @@RXVT_NAME@@ -ip -tint red -sh 40
102
103That works. If you think it doesn't, you lack transparency and tinting
104support, or you are unable to read.
105
1062. Use a simple pixmap and emulate pseudo-transparency. This enables you
107to use effects other than tinting and shading: Just shade/tint/whatever
108your picture with gimp:
109
110 convert wallpaper.jpg -blur 20x20 -modulate 30 background.xpm
111 @@RXVT_NAME@@ -pixmap background.xpm -pe automove-background
112
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? 116=head3 Isn't rxvt-unicode supposed to be small? Don't all those features bloat?
136 117
137I often get asked about this, and I think, no, they didn't cause extra 118I 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 119bloat. 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 120that the urxvt binary is larger (due to some encoding tables always being
140compiled in), but it actually uses less memory (RSS) after startup. Even 121compiled in), but it actually uses less memory (RSS) after startup. Even
172(21152k + extra 4204k in separate processes) or konsole (22200k + extra 153(21152k + extra 4204k in separate processes) or konsole (22200k + extra
17343180k in daemons that stay around after exit, plus half a minute of 15443180k in daemons that stay around after exit, plus half a minute of
174startup time, including the hundreds of warnings it spits out), it fares 155startup time, including the hundreds of warnings it spits out), it fares
175extremely well *g*. 156extremely well *g*.
176 157
177=item Why C++, isn't that unportable/bloated/uncool? 158=head3 Why C++, isn't that unportable/bloated/uncool?
178 159
179Is this a question? :) It comes up very often. The simple answer is: I had 160Is 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 161to 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 162of the time and effort (which is a scarce resource for me). Put even
182shorter: It simply wouldn't exist without C++. 163shorter: It simply wouldn't exist without C++.
206 /lib64/ld-linux-x86-64.so.2 (0x00002aaaaaaab000) 187 /lib64/ld-linux-x86-64.so.2 (0x00002aaaaaaab000)
207 188
208No large bloated libraries (of course, none were linked in statically), 189No large bloated libraries (of course, none were linked in statically),
209except maybe libX11 :) 190except maybe libX11 :)
210 191
211=item Does it support tabs, can I have a tabbed rxvt-unicode?
212 192
213Beginning with version 7.3, there is a perl extension that implements a 193=head2 Rendering, Font & Look and Feel Issues
214simple tabbed terminal. It is installed by default, so any of these should
215give you tabs:
216 194
217 @@RXVT_NAME@@ -pe tabbed 195=head3 I can't get transparency working, what am I doing wrong?
218 196
197First of all, transparency isn't officially supported in rxvt-unicode, so
198you are mostly on your own. Do not bug the author about it (but you may
199bug everybody else). Also, if you can't get it working consider it a rite
200of passage: ... and you failed.
201
202Here are four ways to get transparency. B<Do> read the manpage and option
203descriptions for the programs mentioned and rxvt-unicode. Really, do it!
204
2051. Use inheritPixmap:
206
207 Esetroot wallpaper.jpg
208 @@RXVT_NAME@@ -ip -tint red -sh 40
209
210That works. If you think it doesn't, you lack transparency and tinting
211support, or you are unable to read.
212
2132. Use a simple pixmap and emulate pseudo-transparency. This enables you
214to use effects other than tinting and shading: Just shade/tint/whatever
215your picture with gimp or any other tool:
216
217 convert wallpaper.jpg -blur 20x20 -modulate 30 background.xpm
218 @@RXVT_NAME@@ -pixmap background.xpm -pe automove-background
219
220That works. If you think it doesn't, you lack XPM and Perl support, or you
221are unable to read.
222
2233. Use an ARGB visual:
224
225 @@RXVT_NAME@@ -depth 32 -fg grey90 -bg rgba:0000/0000/4444/cccc
226
227This requires XFT support, and the support of your X-server. If that
228doesn't work for you, blame Xorg and Keith Packard. ARGB visuals aren't
229there yet, no matter what they claim. Rxvt-Unicode contains the neccessary
230bugfixes and workarounds for Xft and Xlib to make it work, but that
231doesn't mean that your WM has the required kludges in place.
232
2334. Use xcompmgr and let it do the job:
234
235 xprop -frame -f _NET_WM_WINDOW_OPACITY 32c \
236 -set _NET_WM_WINDOW_OPACITY 0xc0000000
237
238Then click on a window you want to make transparent. Replace C<0xc0000000>
239by other values to change the degree of opacity. If it doesn't work and
240your server crashes, you got to keep the pieces.
241
242=head3 Why do some chinese characters look so different than others?
243
244This is because there is a difference between script and language --
245rxvt-unicode does not know which language the text that is output is,
246as it only knows the unicode character codes. If rxvt-unicode first
247sees a japanese/chinese character, it might choose a japanese font for
248display. Subsequent japanese characters will use that font. Now, many
249chinese characters aren't represented in japanese fonts, so when the first
250non-japanese character comes up, rxvt-unicode will look for a chinese font
251-- unfortunately at this point, it will still use the japanese font for
252chinese characters that are also in the japanese font.
253
254The workaround is easy: just tag a chinese font at the end of your font
255list (see the previous question). The key is to view the font list as
256a preference list: If you expect more japanese, list a japanese font
257first. If you expect more chinese, put a chinese font first.
258
259In the future it might be possible to switch language preferences at
260runtime (the internal data structure has no problem with using different
261fonts for the same character at the same time, but no interface for this
262has been designed yet).
263
264Until then, you might get away with switching fonts at runtime (see L<Can
265I switch the fonts at runtime?> later in this document).
266
267=head3 Why does rxvt-unicode sometimes leave pixel droppings?
268
269Most fonts were not designed for terminal use, which means that character
270size varies a lot. A font that is otherwise fine for terminal use might
271contain some characters that are simply too wide. Rxvt-unicode will avoid
272these characters. For characters that are just "a bit" too wide a special
273"careful" rendering mode is used that redraws adjacent characters.
274
275All of this requires that fonts do not lie about character sizes,
276however: Xft fonts often draw glyphs larger than their acclaimed bounding
277box, and rxvt-unicode has no way of detecting this (the correct way is to
278ask for the character bounding box, which unfortunately is wrong in these
279cases).
280
281It's not clear (to me at least), wether this is a bug in Xft, freetype,
282or the respective font. If you encounter this problem you might try using
283the C<-lsp> option to give the font more height. If that doesn't work, you
284might be forced to use a different font.
285
286All of this is not a problem when using X11 core fonts, as their bounding
287box data is correct.
288
289=head3 How can I keep rxvt-unicode from using reverse video so much?
290
291First of all, make sure you are running with the right terminal settings
292(C<TERM=rxvt-unicode>), which will get rid of most of these effects. Then
293make sure you have specified colours for italic and bold, as otherwise
294rxvt-unicode might use reverse video to simulate the effect:
295
296 URxvt.colorBD: white
297 URxvt.colorIT: green
298
299=head3 Some programs assume totally weird colours (red instead of blue), how can I fix that?
300
301For some unexplainable reason, some rare programs assume a very weird
302colour palette when confronted with a terminal with more than the standard
3038 colours (rxvt-unicode supports 88). The right fix is, of course, to fix
304these programs not to assume non-ISO colours without very good reasons.
305
306In the meantime, you can either edit your C<rxvt-unicode> terminfo
307definition to only claim 8 colour support or use C<TERM=rxvt>, which will
308fix colours but keep you from using other rxvt-unicode features.
309
310=head3 Can I switch the fonts at runtime?
311
312Yes, using an escape sequence. Try something like this, which has the same
313effect as using the C<-fn> switch, and takes effect immediately:
314
315 printf '\e]50;%s\007' "9x15bold,xft:Kochi Gothic"
316
317This is useful if you e.g. work primarily with japanese (and prefer a
318japanese font), but you have to switch to chinese temporarily, where
319japanese fonts would only be in your way.
320
321You can think of this as a kind of manual ISO-2022 switching.
322
323=head3 Why do italic characters look as if clipped?
324
325Many fonts have difficulties with italic characters and hinting. For
326example, the otherwise very nicely hinted font C<xft:Bitstream Vera Sans
327Mono> completely fails in it's italic face. A workaround might be to
328enable freetype autohinting, i.e. like this:
329
330 URxvt.italicFont: xft:Bitstream Vera Sans Mono:italic:autohint=true
331 URxvt.boldItalicFont: xft:Bitstream Vera Sans Mono:bold:italic:autohint=true
332
333=head3 Can I speed up Xft rendering somehow?
334
335Yes, the most obvious way to speed it up is to avoid Xft entirely, as
336it is simply slow. If you still want Xft fonts you might try to disable
337antialiasing (by appending C<:antialias=false>), which saves lots of
338memory and also speeds up rendering considerably.
339
340=head3 Rxvt-unicode doesn't seem to anti-alias its fonts, what is wrong?
341
342Rxvt-unicode will use whatever you specify as a font. If it needs to
343fall back to it's default font search list it will prefer X11 core
344fonts, because they are small and fast, and then use Xft fonts. It has
345antialiasing disabled for most of them, because the author thinks they
346look best that way.
347
348If you want antialiasing, you have to specify the fonts manually.
349
350=head3 What's with this bold/blink stuff?
351
352If no bold colour is set via C<colorBD:>, bold will invert text using the
353standard foreground colour.
354
355For the standard background colour, blinking will actually make the
356text blink when compiled with C<--enable-blinking>. with standard
357colours. Without C<--enable-blinking>, the blink attribute will be
358ignored.
359
360On ANSI colours, bold/blink attributes are used to set high-intensity
361foreground/background colors.
362
363color0-7 are the low-intensity colors.
364
365color8-15 are the corresponding high-intensity colors.
366
367=head3 I don't like the screen colors. How do I change them?
368
369You can change the screen colors at run-time using F<~/.Xdefaults>
370resources (or as long-options).
371
372Here are values that are supposed to resemble a VGA screen,
373including the murky brown that passes for low-intensity yellow:
374
375 URxvt.color0: #000000
376 URxvt.color1: #A80000
377 URxvt.color2: #00A800
378 URxvt.color3: #A8A800
379 URxvt.color4: #0000A8
380 URxvt.color5: #A800A8
381 URxvt.color6: #00A8A8
382 URxvt.color7: #A8A8A8
383
384 URxvt.color8: #000054
385 URxvt.color9: #FF0054
386 URxvt.color10: #00FF54
387 URxvt.color11: #FFFF54
388 URxvt.color12: #0000FF
389 URxvt.color13: #FF00FF
390 URxvt.color14: #00FFFF
391 URxvt.color15: #FFFFFF
392
393And here is a more complete set of non-standard colors described (not by
394me) as "pretty girly".
395
396 URxvt.cursorColor: #dc74d1
397 URxvt.pointerColor: #dc74d1
398 URxvt.background: #0e0e0e
399 URxvt.foreground: #4ad5e1
400 URxvt.color0: #000000
401 URxvt.color8: #8b8f93
402 URxvt.color1: #dc74d1
403 URxvt.color9: #dc74d1
404 URxvt.color2: #0eb8c7
405 URxvt.color10: #0eb8c7
406 URxvt.color3: #dfe37e
407 URxvt.color11: #dfe37e
408 URxvt.color5: #9e88f0
409 URxvt.color13: #9e88f0
410 URxvt.color6: #73f7ff
411 URxvt.color14: #73f7ff
412 URxvt.color7: #e1dddd
413 URxvt.color15: #e1dddd
414
415=head3 Why do some characters look so much different than others?
416
417See next entry.
418
419=head3 How does rxvt-unicode choose fonts?
420
421Most fonts do not contain the full range of Unicode, which is
422fine. Chances are that the font you (or the admin/package maintainer of
423your system/os) have specified does not cover all the characters you want
424to display.
425
426B<rxvt-unicode> makes a best-effort try at finding a replacement
427font. Often the result is fine, but sometimes the chosen font looks
428bad/ugly/wrong. Some fonts have totally strange characters that don't
429resemble the correct glyph at all, and rxvt-unicode lacks the artificial
430intelligence to detect that a specific glyph is wrong: it has to believe
431the font that the characters it claims to contain indeed look correct.
432
433In that case, select a font of your taste and add it to the font list,
434e.g.:
435
436 @@RXVT_NAME@@ -fn basefont,font2,font3...
437
438When rxvt-unicode sees a character, it will first look at the base
439font. If the base font does not contain the character, it will go to the
440next font, and so on. Specifying your own fonts will also speed up this
441search and use less resources within rxvt-unicode and the X-server.
442
443The only limitation is that none of the fonts may be larger than the base
444font, as the base font defines the terminal character cell size, which
445must be the same due to the way terminals work.
446
447
448=head2 Keyboard, Mouse & User Interaction
449
450=head3 The new selection selects pieces that are too big, how can I select single words?
451
452If you want to select e.g. alphanumeric words, you can use the following
453setting:
454
455 URxvt.selection.pattern-0: ([[:word:]]+)
456
457If you click more than twice, the selection will be extended
458more and more.
459
460To get a selection that is very similar to the old code, try this pattern:
461
462 URxvt.selection.pattern-0: ([^"&'()*,;<=>?@[\\\\]^`{|})]+)
463
464Please also note that the I<LeftClick Shift-LeftClik> combination also
465selects words like the old code.
466
467=head3 I don't like the new selection/popups/hotkeys/perl, how do I change/disable it?
468
469You can disable the perl extension completely by setting the
470B<perl-ext-common> resource to the empty string, which also keeps
471rxvt-unicode from initialising perl, saving memory.
472
473If you only want to disable specific features, you first have to
474identify which perl extension is responsible. For this, read the section
475B<PREPACKAGED EXTENSIONS> in the @@RXVT_NAME@@perl(3) manpage. For
476example, to disable the B<selection-popup> and B<option-popup>, specify
477this B<perl-ext-common> resource:
478
479 URxvt.perl-ext-common: default,-selection-popup,-option-popup
480
481This will keep the default extensions, but disable the two popup
482extensions. Some extensions can also be configured, for example,
483scrollback search mode is triggered by B<M-s>. You can move it to any
484other combination either by setting the B<searchable-scrollback> resource:
485
486 URxvt.searchable-scrollback: CM-s
487
488=head3 The cursor moves when selecting text in the current input line, how do I switch this off?
489
490See next entry.
491
492=head3 During rlogin/ssh/telnet/etc. sessions, clicking near the cursor outputs strange escape sequences, how do I fix this?
493
494These are caused by the C<readline> perl extension. Under normal
495circumstances, it will move your cursor around when you click into the
496line that contains it. It tries hard not to do this at the wrong moment,
497but when running a program that doesn't parse cursor movements or in some
498cases during rlogin sessions, it fails to detect this properly.
499
500You can permamently switch this feature off by disabling the C<readline>
501extension:
502
219 URxvt.perl-ext-common: default,tabbed 503 URxvt.perl-ext-common: default,-readline
220 504
221It will also work fine with tabbing functionality of many window managers 505=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 506
227=item How do I know which rxvt-unicode version I'm using? 507Some Debian GNUL/Linux users seem to have this problem, although no
508specific details were reported so far. It is possible that this is caused
509by the wrong C<TERM> setting, although the details of wether and how
510this can happen are unknown, as C<TERM=rxvt> should offer a compatible
511keymap. See the answer to the previous question, and please report if that
512helped.
228 513
229The version number is displayed with the usage (-h). Also the escape 514=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 515
234=item I am using Debian GNU/Linux and have a problem... 516The most common causes for this are that either your locale is not set
517correctly, or you specified a B<preeditStyle> that is not supported by
518your input method. For example, if you specified B<OverTheSpot> and
519your input method (e.g. the default input method handling Compose keys)
520does not support this (for instance because it is not visual), then
521rxvt-unicode will continue without an input method.
235 522
236The Debian GNU/Linux package of rxvt-unicode in sarge contains large 523In this case either do not specify a B<preeditStyle> or specify more than
237patches that considerably change the behaviour of rxvt-unicode (but 524one 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 525
245For other problems that also affect the Debian package, you can and 526=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 527
250=item I am maintaining rxvt-unicode for distribution/OS XXX, any 528Either try C<Ctrl-2> alone (it often is mapped to ASCII NUL even on
251recommendation? 529international keyboards) or simply use ISO 14755 support to your
530advantage, typing <Ctrl-Shift-0> to get a ASCII NUL. This works for other
531codes, too, such as C<Ctrl-Shift-1-d> to type the default telnet escape
532character and so on.
252 533
253You should build one binary with the default options. F<configure> 534=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 535
260You should not overwrite the C<perl-ext-common> snd C<perl-ext> resources 536Make sure that mouse reporting is actually turned off since killing
261system-wide (except maybe with C<defaults>). This will result in useful 537some editors prematurely may leave the mouse in mouse report mode. I've
262behaviour. If your distribution aims at low memory, add an empty 538heard 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 539quick check is to see if cut/paste works when the Alt or Shift keys are
264perl interpreter disabled until the user enables it. 540depressed.
265 541
266If you can/want build more binaries, I recommend building a minimal 542=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 543
271=item I need to make it setuid/setgid to support utmp/ptys on my OS, is this safe? 544Assuming that the physical Backspace key corresponds to the
545BackSpace keysym (not likely for Linux ... see the following
546question) there are two standard values that can be used for
547Backspace: C<^H> and C<^?>.
272 548
273It should be, starting with release 7.1. You are encouraged to properly 549Historically, either value is correct, but rxvt-unicode adopts the debian
274install urxvt with privileges necessary for your OS now. 550policy of using C<^?> when unsure, because it's the one only only correct
551choice :).
275 552
276When rxvt-unicode detects that it runs setuid or setgid, it will fork 553Rxvt-unicode tries to inherit the current stty settings and uses the value
277into a helper process for privileged operations (pty handling on some 554of `erase' to guess the value for backspace. If rxvt-unicode wasn't
278systems, utmp/wtmp/lastlog handling on others) and drop privileges 555started from a terminal (say, from a menu or by remote shell), then the
279immediately. This is much safer than most other terminals that keep 556system value of `erase', which corresponds to CERASE in <termios.h>, will
280privileges while running (but is more relevant to urxvt, as it contains 557be used (which may not be the same as your stty setting).
281things as perl interpreters, which might be "helpful" to attackers).
282 558
283This forking is done as the very first within main(), which is very early 559For 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 560
561 # use Backspace = ^H
562 $ stty erase ^H
563 $ @@RXVT_NAME@@
564
565 # use Backspace = ^?
566 $ stty erase ^?
567 $ @@RXVT_NAME@@
568
569Toggle with C<ESC [ 36 h> / C<ESC [ 36 l>.
570
571For an existing rxvt-unicode:
572
573 # use Backspace = ^H
574 $ stty erase ^H
575 $ echo -n "^[[36h"
576
577 # use Backspace = ^?
578 $ stty erase ^?
579 $ echo -n "^[[36l"
580
581This helps satisfy some of the Backspace discrepancies that occur, but
582if you use Backspace = C<^H>, make sure that the termcap/terminfo value
583properly reflects that.
584
585The Delete key is a another casualty of the ill-defined Backspace problem.
586To avoid confusion between the Backspace and Delete keys, the Delete
587key has been assigned an escape sequence to match the vt100 for Execute
588(C<ESC [ 3 ~>) and is in the supplied termcap/terminfo.
589
590Some other Backspace problems:
591
592some editors use termcap/terminfo,
593some editors (vim I'm told) expect Backspace = ^H,
594GNU Emacs (and Emacs-like editors) use ^H for help.
595
596Perhaps someday this will all be resolved in a consistent manner.
597
598=head3 I don't like the key-bindings. How do I change them?
599
600There are some compile-time selections available via configure. Unless
601you have run "configure" with the C<--disable-resources> option you can
602use the `keysym' resource to alter the keystrings associated with keysyms.
603
604Here's an example for a URxvt session started using C<@@RXVT_NAME@@ -name URxvt>
605
606 URxvt.keysym.Home: \033[1~
607 URxvt.keysym.End: \033[4~
608 URxvt.keysym.C-apostrophe: \033<C-'>
609 URxvt.keysym.C-slash: \033<C-/>
610 URxvt.keysym.C-semicolon: \033<C-;>
611 URxvt.keysym.C-grave: \033<C-`>
612 URxvt.keysym.C-comma: \033<C-,>
613 URxvt.keysym.C-period: \033<C-.>
614 URxvt.keysym.C-0x60: \033<C-`>
615 URxvt.keysym.C-Tab: \033<C-Tab>
616 URxvt.keysym.C-Return: \033<C-Return>
617 URxvt.keysym.S-Return: \033<S-Return>
618 URxvt.keysym.S-space: \033<S-Space>
619 URxvt.keysym.M-Up: \033<M-Up>
620 URxvt.keysym.M-Down: \033<M-Down>
621 URxvt.keysym.M-Left: \033<M-Left>
622 URxvt.keysym.M-Right: \033<M-Right>
623 URxvt.keysym.M-C-0: list \033<M-C- 0123456789 >
624 URxvt.keysym.M-C-a: list \033<M-C- abcdefghijklmnopqrstuvwxyz >
625 URxvt.keysym.F12: command:\033]701;zh_CN.GBK\007
626
627See some more examples in the documentation for the B<keysym> resource.
628
629=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
630
631 KP_Insert == Insert
632 F22 == Print
633 F27 == Home
634 F29 == Prior
635 F33 == End
636 F35 == Next
637
638Rather than have rxvt-unicode try to accommodate all the various possible
639keyboard mappings, it is better to use `xmodmap' to remap the keys as
640required for your particular machine.
641
642
643
644=head2 Terminal Configuration
645
646=head3 Why doesn't rxvt-unicode read my resources?
647
648Well, why, indeed? It does, in a way very similar to other X
649applications. Most importantly, this means that if you or your OS loads
650resources into the X display (the right way to do it), rxvt-unicode will
651ignore any resource files in your home directory. It will only read
652F<$HOME/.Xdefaults> when no resources are attached to the display.
653
654If you have or use an F<$HOME/.Xresources> file, chances are that
655resources are loaded into your X-server. In this case, you have to
656re-login after every change (or run F<xrdb -merge $HOME/.Xresources>).
657
658Also consider the form resources have to use:
659
660 URxvt.resource: value
661
662If you want to use another form (there are lots of different ways of
663specifying resources), make sure you understand wether and why it
664works. If unsure, use the form above.
665
288=item When I log-in to another system it tells me about missing terminfo data? 666=head3 When I log-in to another system it tells me about missing terminfo data?
289 667
290The terminal description used by rxvt-unicode is not as widely available 668The 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). 669as that for xterm, or even rxvt (for which the same problem often arises).
292 670
293The correct solution for this problem is to install the terminfo, this can 671The correct solution for this problem is to install the terminfo, this can
311 URxvt.termName: rxvt 689 URxvt.termName: rxvt
312 690
313If you don't plan to use B<rxvt> (quite common...) you could also replace 691If you don't plan to use B<rxvt> (quite common...) you could also replace
314the rxvt terminfo file with the rxvt-unicode one. 692the rxvt terminfo file with the rxvt-unicode one.
315 693
316=item C<tic> outputs some error when compiling the terminfo entry. 694=head3 C<tic> outputs some error when compiling the terminfo entry.
317 695
318Most likely it's the empty definition for C<enacs=>. Just replace it by 696Most likely it's the empty definition for C<enacs=>. Just replace it by
319C<enacs=\E[0@> and try again. 697C<enacs=\E[0@> and try again.
320 698
321=item C<bash>'s readline does not work correctly under @@RXVT_NAME@@. 699=head3 C<bash>'s readline does not work correctly under @@RXVT_NAME@@.
322 700
701See next entry.
702
323=item I need a termcap file entry. 703=head3 I need a termcap file entry.
324 704
325One reason you might want this is that some distributions or operating 705One reason you might want this is that some distributions or operating
326systems still compile some programs using the long-obsoleted termcap 706systems still compile some programs using the long-obsoleted termcap
327library (Fedora Core's bash is one example) and rely on a termcap entry 707library (Fedora Core's bash is one example) and rely on a termcap entry
328for C<rxvt-unicode>. 708for C<rxvt-unicode>.
354 :sc=\E7:se=\E[27m:sf=^J:so=\E[7m:sr=\EM:st=\EH:ta=^I:\ 734 :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:\ 735 :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:\ 736 :us=\E[4m:vb=\E[?5h\E[?5l:ve=\E[?25h:vi=\E[?25l:\
357 :vs=\E[?25h: 737 :vs=\E[?25h:
358 738
359=item Why does C<ls> no longer have coloured output? 739=head3 Why does C<ls> no longer have coloured output?
360 740
361The C<ls> in the GNU coreutils unfortunately doesn't use terminfo to 741The C<ls> in the GNU coreutils unfortunately doesn't use terminfo to
362decide wether a terminal has colour, but uses it's own configuration 742decide wether a terminal has colour, but uses it's own configuration
363file. Needless to say, C<rxvt-unicode> is not in it's default file (among 743file. Needless to say, C<rxvt-unicode> is not in it's default file (among
364with most other terminals supporting colour). Either add: 744with most other terminals supporting colour). Either add:
369 749
370 alias ls='ls --color=auto' 750 alias ls='ls --color=auto'
371 751
372to your C<.profile> or C<.bashrc>. 752to your C<.profile> or C<.bashrc>.
373 753
374=item Why doesn't vim/emacs etc. use the 88 colour mode? 754=head3 Why doesn't vim/emacs etc. use the 88 colour mode?
375 755
756See next entry.
757
376=item Why doesn't vim/emacs etc. make use of italic? 758=head3 Why doesn't vim/emacs etc. make use of italic?
377 759
760See next entry.
761
378=item Why are the secondary screen-related options not working properly? 762=head3 Why are the secondary screen-related options not working properly?
379 763
380Make sure you are using C<TERM=rxvt-unicode>. Some pre-packaged 764Make sure you are using C<TERM=rxvt-unicode>. Some pre-packaged
381distributions (most notably Debian GNU/Linux) break rxvt-unicode 765distributions (most notably Debian GNU/Linux) break rxvt-unicode
382by setting C<TERM> to C<rxvt>, which doesn't have these extra 766by setting C<TERM> to C<rxvt>, which doesn't have these extra
383features. Unfortunately, some of these (most notably, again, Debian 767features. Unfortunately, some of these (most notably, again, Debian
384GNU/Linux) furthermore fail to even install the C<rxvt-unicode> terminfo 768GNU/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 769file, 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 770I log-in to another system it tells me about missing terminfo data?> on
387how to do this). 771how to do this).
388 772
389=item My numerical keypad acts weird and generates differing output?
390 773
391Some Debian GNUL/Linux users seem to have this problem, although no 774=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 775
398=item Rxvt-unicode does not seem to understand the selected encoding? 776=head3 Rxvt-unicode does not seem to understand the selected encoding?
399 777
778See next entry.
779
400=item Unicode does not seem to work? 780=head3 Unicode does not seem to work?
401 781
402If you encounter strange problems like typing an accented character but 782If you encounter strange problems like typing an accented character but
403getting two unrelated other characters or similar, or if program output is 783getting two unrelated other characters or similar, or if program output is
404subtly garbled, then you should check your locale settings. 784subtly garbled, then you should check your locale settings.
405 785
425 805
426If nothing works and you are sure that everything is set correctly then 806If 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 807you will need to remember a little known fact: Some programs just don't
428support locales :( 808support locales :(
429 809
430=item Why do some characters look so much different than others? 810=head3 How does rxvt-unicode determine the encoding to use?
431 811
432=item How does rxvt-unicode choose fonts? 812See next entry.
433 813
434Most fonts do not contain the full range of Unicode, which is 814=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 815
439B<rxvt-unicode> makes a best-effort try at finding a replacement 816Unlike some other terminals, rxvt-unicode has no encoding switch, and no
440font. Often the result is fine, but sometimes the chosen font looks 817specific "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 818UTF-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 819
446In that case, select a font of your taste and add it to the font list, 820The reasons is that there exists a perfectly fine mechanism for selecting
447e.g.: 821the encoding, doing I/O and (most important) communicating this to all
448 822applications so everybody agrees on character properties such as width
449 @@RXVT_NAME@@ -fn basefont,font2,font3... 823and code number. This mechanism is the I<locale>. Applications not using
450 824that 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 825characters wrong as it uses it's 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). 826locales).
498 827
499It's not clear (to me at least), wether this is a bug in Xft, freetype, 828Rxvt-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 829programs 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 830interpretation of characters.
502might be forced to use a different font.
503 831
504All of this is not a problem when using X11 core fonts, as their bounding 832Unfortunately, there is no system-independent way to select locales, nor
505box data is correct. 833is there a standard on how locale specifiers will look like.
506 834
835On most systems, the content of the C<LC_CTYPE> environment variable
836contains an arbitrary string which corresponds to an already-installed
837locale. Common names for locales are C<en_US.UTF-8>, C<de_DE.ISO-8859-15>,
838C<ja_JP.EUC-JP>, i.e. C<language_country.encoding>, but other forms
839(i.e. C<de> or C<german>) are also common.
840
841Rxvt-unicode ignores all other locale categories, and except for
842the encoding, ignores country or language-specific settings,
843i.e. C<de_DE.UTF-8> and C<ja_JP.UTF-8> are the normally same to
844rxvt-unicode.
845
846If you want to use a specific encoding you have to make sure you start
847rxvt-unicode with the correct C<LC_CTYPE> category.
848
849=head3 Can I switch locales at runtime?
850
851Yes, using an escape sequence. Try something like this, which sets
852rxvt-unicode's idea of C<LC_CTYPE>.
853
854 printf '\e]701;%s\007' ja_JP.SJIS
855
856See also the previous answer.
857
858Sometimes this capability is rather handy when you want to work in
859one locale (e.g. C<de_DE.UTF-8>) but some programs don't support it
860(e.g. UTF-8). For example, I use this script to start C<xjdic>, which
861first switches to a locale supported by xjdic and back later:
862
863 printf '\e]701;%s\007' ja_JP.SJIS
864 xjdic -js
865 printf '\e]701;%s\007' de_DE.UTF-8
866
867You can also use xterm's C<luit> program, which usually works fine, except
868for some locales where character width differs between program- and
869rxvt-unicode-locales.
870
871=head3 My input method wants <some encoding> but I want UTF-8, what can I do?
872
873You can specify separate locales for the input method and the rest of the
874terminal, using the resource C<imlocale>:
875
876 URxvt.imlocale: ja_JP.EUC-JP
877
878Now you can start your terminal with C<LC_CTYPE=ja_JP.UTF-8> and still
879use your input method. Please note, however, that you will not be able to
880input characters outside C<EUC-JP> in a normal way then, as your input
881method limits you.
882
883=head3 Rxvt-unicode crashes when the X Input Method changes or exits.
884
885Unfortunately, this is unavoidable, as the XIM protocol is racy by
886design. Applications can avoid some crashes at the expense of memory
887leaks, and Input Methods can avoid some crashes by careful ordering at
888exit time. B<kinput2> (and derived input methods) generally succeeds,
889while B<SCIM> (or similar input methods) fails. In the end, however,
890crashes cannot be completely avoided even if both sides cooperate.
891
892So the only workaround is not to kill your Input Method Servers.
893
894
895=head2 Operating Systems / Package Maintaining
896
897=head3 I am using Debian GNU/Linux and have a problem...
898
899The Debian GNU/Linux package of rxvt-unicode in sarge contains large
900patches that considerably change the behaviour of rxvt-unicode (but
901unfortunately this notice has been removed). Before reporting a bug to
902the original rxvt-unicode author please download and install the genuine
903version (L<http://software.schmorp.de#rxvt-unicode>) and try to reproduce
904the problem. If you cannot, chances are that the problems are specific to
905Debian GNU/Linux, in which case it should be reported via the Debian Bug
906Tracking System (use C<reportbug> to report the bug).
907
908For other problems that also affect the Debian package, you can and
909probably should use the Debian BTS, too, because, after all, it's also a
910bug in the Debian version and it serves as a reminder for other users that
911might encounter the same issue.
912
913=head3 I am maintaining rxvt-unicode for distribution/OS XXX, any recommendation?
914
915You should build one binary with the default options. F<configure>
916now enables most useful options, and the trend goes to making them
917runtime-switchable, too, so there is usually no drawback to enbaling them,
918except higher disk and possibly memory usage. The perl interpreter should
919be enabled, as important functionality (menus, selection, likely more in
920the future) depends on it.
921
922You should not overwrite the C<perl-ext-common> snd C<perl-ext> resources
923system-wide (except maybe with C<defaults>). This will result in useful
924behaviour. If your distribution aims at low memory, add an empty
925C<perl-ext-common> resource to the app-defaults file. This will keep the
926perl interpreter disabled until the user enables it.
927
928If you can/want build more binaries, I recommend building a minimal
929one with C<--disable-everything> (very useful) and a maximal one with
930C<--enable-everything> (less useful, it will be very big due to a lot of
931encodings built-in that increase download times and are rarely used).
932
933=head3 I need to make it setuid/setgid to support utmp/ptys on my OS, is this safe?
934
935It should be, starting with release 7.1. You are encouraged to properly
936install urxvt with privileges necessary for your OS now.
937
938When rxvt-unicode detects that it runs setuid or setgid, it will fork
939into a helper process for privileged operations (pty handling on some
940systems, utmp/wtmp/lastlog handling on others) and drop privileges
941immediately. This is much safer than most other terminals that keep
942privileges while running (but is more relevant to urxvt, as it contains
943things as perl interpreters, which might be "helpful" to attackers).
944
945This forking is done as the very first within main(), which is very early
946and reduces possible bugs to initialisation code run before main(), or
947things like the dynamic loader of your system, which should result in very
948little risk.
949
507=item On Solaris 9, many line-drawing characters are too wide. 950=head3 On Solaris 9, many line-drawing characters are too wide.
508 951
509Seems to be a known bug, read 952Seems to be a known bug, read
510L<http://nixdoc.net/files/forum/about34198.html>. Some people use the 953L<http://nixdoc.net/files/forum/about34198.html>. Some people use the
511following ugly workaround to get non-double-wide-characters working: 954following ugly workaround to get non-double-wide-characters working:
512 955
513 #define wcwidth(x) wcwidth(x) > 1 ? 1 : wcwidth(x) 956 #define wcwidth(x) wcwidth(x) > 1 ? 1 : wcwidth(x)
514 957
515=item My Compose (Multi_key) key is no longer working.
516
517The most common causes for this are that either your locale is not set
518correctly, or you specified a B<preeditStyle> that is not supported by
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
524In this case either do not specify a B<preeditStyle> or specify more than
525one pre-edit style, such as B<OverTheSpot,Root,None>.
526
527=item I cannot type C<Ctrl-Shift-2> to get an ASCII NUL character due to ISO 14755
528
529Either try C<Ctrl-2> alone (it often is mapped to ASCII NUL even on
530international keyboards) or simply use ISO 14755 support to your
531advantage, typing <Ctrl-Shift-0> to get a ASCII NUL. This works for other
532codes, too, such as C<Ctrl-Shift-1-d> to type the default telnet escape
533character and so on.
534
535=item How can I keep rxvt-unicode from using reverse video so much?
536
537First of all, make sure you are running with the right terminal settings
538(C<TERM=rxvt-unicode>), which will get rid of most of these effects. Then
539make sure you have specified colours for italic and bold, as otherwise
540rxvt-unicode might use reverse video to simulate the effect:
541
542 URxvt.colorBD: white
543 URxvt.colorIT: green
544
545=item Some programs assume totally weird colours (red instead of blue), how can I fix that?
546
547For some unexplainable reason, some rare programs assume a very weird
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
552In the meantime, you can either edit your C<rxvt-unicode> terminfo
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
556=item I am on FreeBSD and rxvt-unicode does not seem to work at all. 958=head3 I am on FreeBSD and rxvt-unicode does not seem to work at all.
557 959
558Rxvt-unicode requires the symbol C<__STDC_ISO_10646__> to be defined 960Rxvt-unicode requires the symbol C<__STDC_ISO_10646__> to be defined
559in your compile environment, or an implementation that implements it, 961in your compile environment, or an implementation that implements it,
560wether it defines the symbol or not. C<__STDC_ISO_10646__> requires that 962wether it defines the symbol or not. C<__STDC_ISO_10646__> requires that
561B<wchar_t> is represented as unicode. 963B<wchar_t> is represented as unicode.
583 985
584The rxvt-unicode author insists that the right way to fix this is in the 986The 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 987system libraries once and for all, instead of forcing every app to carry
586complete replacements for them :) 988complete replacements for them :)
587 989
588=item I use Solaris 9 and it doesn't compile/work/etc. 990=head3 I use Solaris 9 and it doesn't compile/work/etc.
589 991
590Try the diff in F<doc/solaris9.patch> as a base. It fixes the worst 992Try the diff in F<doc/solaris9.patch> as a base. It fixes the worst
591problems with C<wcwidth> and a compile problem. 993problems with C<wcwidth> and a compile problem.
592 994
593=item How can I use rxvt-unicode under cygwin? 995=head3 How can I use rxvt-unicode under cygwin?
594 996
595rxvt-unicode should compile and run out of the box on cygwin, using 997rxvt-unicode should compile and run out of the box on cygwin, using
596the X11 libraries that come with cygwin. libW11 emulation is no 998the X11 libraries that come with cygwin. libW11 emulation is no
597longer supported (and makes no sense, either, as it only supported a 999longer supported (and makes no sense, either, as it only supported a
598single font). I recommend starting the X-server in C<-multiwindow> or 1000single font). I recommend starting the X-server in C<-multiwindow> or
600old libW11 emulation. 1002old libW11 emulation.
601 1003
602At the time of this writing, cygwin didn't seem to support any multi-byte 1004At 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 1005encodings (you might try C<LC_CTYPE=C-UTF-8>), so you are likely limited
604to 8-bit encodings. 1006to 8-bit encodings.
605
606=item How does rxvt-unicode determine the encoding to use?
607
608=item Is there an option to switch encodings?
609
610Unlike some other terminals, rxvt-unicode has no encoding switch, and no
611specific "utf-8" mode, such as xterm. In fact, it doesn't even know about
612UTF-8 or any other encodings with respect to terminal I/O.
613
614The reasons is that there exists a perfectly fine mechanism for selecting
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
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 1007
970=head1 RXVT TECHNICAL REFERENCE 1008=head1 RXVT TECHNICAL REFERENCE
971 1009
972=head1 DESCRIPTION 1010=head1 DESCRIPTION
973 1011

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines