ViewVC Help
View File | Revision Log | Show Annotations | Download File
/cvs/rxvt-unicode/README.FAQ
(Generate patch)

Comparing rxvt-unicode/README.FAQ (file contents):
Revision 1.2 by root, Sun Jan 16 15:59:45 2005 UTC vs.
Revision 1.70 by root, Fri Dec 26 22:52:22 2014 UTC

1FREQUENTLY ASKED QUESTIONS 1RXVT-UNICODE/URXVT FREQUENTLY ASKED QUESTIONS
2 Meta, Features & Commandline Issues
3 My question isn't answered here, can I ask a human?
4 Before sending me mail, you could go to IRC: "irc.freenode.net", channel
5 "#rxvt-unicode" has some rxvt-unicode enthusiasts that might be
6 interested in learning about new and exciting problems (but not FAQs :).
7
8 I use Gentoo, and I have a problem...
9 There are two big problems with Gentoo Linux: first, most if not all
10 Gentoo systems are completely broken (missing or mismatched header
11 files, broken compiler etc. are just the tip of the iceberg); secondly,
12 it should be called Gentoo GNU/Linux.
13
14 For these reasons, it is impossible to support rxvt-unicode on Gentoo.
15 Problems appearing on Gentoo systems will usually simply be ignored
16 unless they can be reproduced on non-Gentoo systems.
17
18 Does it support tabs, can I have a tabbed rxvt-unicode?
19 Beginning with version 7.3, there is a perl extension that implements a
20 simple tabbed terminal. It is installed by default, so any of these
21 should give you tabs:
22
23 urxvt -pe tabbed
24
25 URxvt.perl-ext-common: default,tabbed
26
27 It will also work fine with tabbing functionality of many window
28 managers or similar tabbing programs, and its embedding-features allow
29 it to be embedded into other programs, as witnessed by doc/rxvt-tabbed
30 or the upcoming "Gtk2::URxvt" perl module, which features a tabbed urxvt
31 (murxvt) terminal as an example embedding application.
32
2 How do I know which rxvt-unicode version I'm using? 33 How do I know which rxvt-unicode version I'm using?
3 The version number is displayed with the usage (-h). Also the escape 34 The version number is displayed with the usage (-h). Also the escape
4 sequence "ESC[8n" sets the window title to the version number. 35 sequence "ESC [ 8 n" sets the window title to the version number. When
36 using the urxvtc client, the version displayed is that of the daemon.
5 37
38 Rxvt-unicode uses gobs of memory, how can I reduce that?
39 Rxvt-unicode tries to obey the rule of not charging you for something
40 you don't use. One thing you should try is to configure out all settings
41 that you don't need, for example, Xft support is a resource hog by
42 design, when used. Compiling it out ensures that no Xft font will be
43 loaded accidentally when rxvt-unicode tries to find a font for your
44 characters.
45
46 Also, many people (me included) like large windows and even larger
47 scrollback buffers: Without "--enable-unicode3", rxvt-unicode will use 6
48 bytes per screen cell. For a 160x?? window this amounts to almost a
49 kilobyte per line. A scrollback buffer of 10000 lines will then (if
50 full) use 10 Megabytes of memory. With "--enable-unicode3" it gets
51 worse, as rxvt-unicode then uses 8 bytes per screen cell.
52
53 How can I start urxvtd in a race-free way?
54 Try "urxvtd -f -o", which tells urxvtd to open the display, create the
55 listening socket and then fork.
56
57 How can I start urxvtd automatically when I run urxvtc?
58 If you want to start urxvtd automatically whenever you run urxvtc and
59 the daemon isn't running yet, use this script:
60
61 #!/bin/sh
62 urxvtc "$@"
63 if [ $? -eq 2 ]; then
64 urxvtd -q -o -f
65 urxvtc "$@"
66 fi
67
68 This tries to create a new terminal, and if fails with exit status 2,
69 meaning it couldn't connect to the daemon, it will start the daemon and
70 re-run the command. Subsequent invocations of the script will re-use the
71 existing daemon.
72
73 How do I distinguish whether I'm running rxvt-unicode or a regular
74xterm? I need this to decide about setting colours etc.
75 The original rxvt and rxvt-unicode always export the variable
76 "COLORTERM", so you can check and see if that is set. Note that several
77 programs, JED, slrn, Midnight Commander automatically check this
78 variable to decide whether or not to use colour.
79
80 How do I set the correct, full IP address for the DISPLAY variable?
81 If you've compiled rxvt-unicode with DISPLAY_IS_IP and have enabled
82 insecure mode then it is possible to use the following shell script
83 snippets to correctly set the display. If your version of rxvt-unicode
84 wasn't also compiled with ESCZ_ANSWER (as assumed in these snippets)
85 then the COLORTERM variable can be used to distinguish rxvt-unicode from
86 a regular xterm.
87
88 Courtesy of Chuck Blake <cblake@BBN.COM> with the following shell script
89 snippets:
90
91 # Bourne/Korn/POSIX family of shells:
92 [ ${TERM:-foo} = foo ] && TERM=xterm # assume an xterm if we don't know
93 if [ ${TERM:-foo} = xterm ]; then
94 stty -icanon -echo min 0 time 15 # see if enhanced rxvt or not
95 printf "\eZ"
96 read term_id
97 stty icanon echo
98 if [ ""${term_id} = '^[[?1;2C' -a ${DISPLAY:-foo} = foo ]; then
99 printf '\e[7n' # query the rxvt we are in for the DISPLAY string
100 read DISPLAY # set it in our local shell
101 fi
102 fi
103
104 How do I compile the manual pages on my own?
105 You need to have a recent version of perl installed as /usr/bin/perl,
106 one that comes with pod2man, pod2text and pod2xhtml (from Pod::Xhtml).
107 Then go to the doc subdirectory and enter "make alldoc".
108
109 Isn't rxvt-unicode supposed to be small? Don't all those features bloat?
110 I often get asked about this, and I think, no, they didn't cause extra
111 bloat. If you compare a minimal rxvt and a minimal urxvt, you can see
112 that the urxvt binary is larger (due to some encoding tables always
113 being compiled in), but it actually uses less memory (RSS) after
114 startup. Even with "--disable-everything", this comparison is a bit
115 unfair, as many features unique to urxvt (locale, encoding conversion,
116 iso14755 etc.) are already in use in this mode.
117
118 text data bss drs rss filename
119 98398 1664 24 15695 1824 rxvt --disable-everything
120 188985 9048 66616 18222 1788 urxvt --disable-everything
121
122 When you "--enable-everything" (which *is* unfair, as this involves xft
123 and full locale/XIM support which are quite bloaty inside libX11 and my
124 libc), the two diverge, but not unreasonably so.
125
126 text data bss drs rss filename
127 163431 2152 24 20123 2060 rxvt --enable-everything
128 1035683 49680 66648 29096 3680 urxvt --enable-everything
129
130 The very large size of the text section is explained by the east-asian
131 encoding tables, which, if unused, take up disk space but nothing else
132 and can be compiled out unless you rely on X11 core fonts that use those
133 encodings. The BSS size comes from the 64k emergency buffer that my c++
134 compiler allocates (but of course doesn't use unless you are out of
135 memory). Also, using an xft font instead of a core font immediately adds
136 a few megabytes of RSS. Xft indeed is responsible for a lot of RSS even
137 when not used.
138
139 Of course, due to every character using two or four bytes instead of
140 one, a large scrollback buffer will ultimately make rxvt-unicode use
141 more memory.
142
143 Compared to e.g. Eterm (5112k), aterm (3132k) and xterm (4680k), this
144 still fares rather well. And compared to some monsters like
145 gnome-terminal (21152k + extra 4204k in separate processes) or konsole
146 (22200k + extra 43180k in daemons that stay around after exit, plus half
147 a minute of startup time, including the hundreds of warnings it spits
148 out), it fares extremely well *g*.
149
150 Why C++, isn't that unportable/bloated/uncool?
151 Is this a question? :) It comes up very often. The simple answer is: I
152 had to write it, and C++ allowed me to write and maintain it in a
153 fraction of the time and effort (which is a scarce resource for me). Put
154 even shorter: It simply wouldn't exist without C++.
155
156 My personal stance on this is that C++ is less portable than C, but in
157 the case of rxvt-unicode this hardly matters, as its portability limits
158 are defined by things like X11, pseudo terminals, locale support and
159 unix domain sockets, which are all less portable than C++ itself.
160
161 Regarding the bloat, see the above question: It's easy to write programs
162 in C that use gobs of memory, and certainly possible to write programs
163 in C++ that don't. C++ also often comes with large libraries, but this
164 is not necessarily the case with GCC. Here is what rxvt links against on
165 my system with a minimal config:
166
167 libX11.so.6 => /usr/X11R6/lib/libX11.so.6 (0x00002aaaaabc3000)
168 libc.so.6 => /lib/libc.so.6 (0x00002aaaaadde000)
169 libdl.so.2 => /lib/libdl.so.2 (0x00002aaaab01d000)
170 /lib64/ld-linux-x86-64.so.2 (0x00002aaaaaaab000)
171
172 And here is rxvt-unicode:
173
174 libX11.so.6 => /usr/X11R6/lib/libX11.so.6 (0x00002aaaaabc3000)
175 libgcc_s.so.1 => /lib/libgcc_s.so.1 (0x00002aaaaada2000)
176 libc.so.6 => /lib/libc.so.6 (0x00002aaaaaeb0000)
177 libdl.so.2 => /lib/libdl.so.2 (0x00002aaaab0ee000)
178 /lib64/ld-linux-x86-64.so.2 (0x00002aaaaaaab000)
179
180 No large bloated libraries (of course, none were linked in statically),
181 except maybe libX11 :)
182
183 Rendering, Font & Look and Feel Issues
184 I can't get transparency working, what am I doing wrong?
185 First of all, transparency isn't officially supported in rxvt-unicode,
186 so you are mostly on your own. Do not bug the author about it (but you
187 may bug everybody else). Also, if you can't get it working consider it a
188 rite of passage: ... and you failed.
189
190 Here are four ways to get transparency. Do read the manpage and option
191 descriptions for the programs mentioned and rxvt-unicode. Really, do it!
192
193 1. Use transparent mode:
194
195 Esetroot wallpaper.jpg
196 urxvt -tr -tint red -sh 40
197
198 That works. If you think it doesn't, you lack transparency and tinting
199 support, or you are unable to read. This method requires that the
200 background-setting program sets the _XROOTPMAP_ID or ESETROOT_PMAP_ID
201 property. Compatible programs are Esetroot, hsetroot and feh.
202
203 2. Use a simple pixmap and emulate pseudo-transparency. This enables you
204 to use effects other than tinting and shading: Just shade/tint/whatever
205 your picture with gimp or any other tool:
206
207 convert wallpaper.jpg -blur 20x20 -modulate 30 background.jpg
208 urxvt -pixmap "background.jpg;:root"
209
210 That works. If you think it doesn't, you lack GDK-PixBuf support, or you
211 are unable to read.
212
213 3. Use an ARGB visual:
214
215 urxvt -depth 32 -fg grey90 -bg rgba:0000/0000/4444/cccc
216
217 This requires XFT support, and the support of your X-server. If that
218 doesn't work for you, blame Xorg and Keith Packard. ARGB visuals aren't
219 there yet, no matter what they claim. Rxvt-Unicode contains the
220 necessary bugfixes and workarounds for Xft and Xlib to make it work, but
221 that doesn't mean that your WM has the required kludges in place.
222
223 4. Use xcompmgr and let it do the job:
224
225 xprop -frame -f _NET_WM_WINDOW_OPACITY 32c \
226 -set _NET_WM_WINDOW_OPACITY 0xc0000000
227
228 Then click on a window you want to make transparent. Replace 0xc0000000
229 by other values to change the degree of opacity. If it doesn't work and
230 your server crashes, you got to keep the pieces.
231
232 Why does rxvt-unicode sometimes leave pixel droppings?
233 Most fonts were not designed for terminal use, which means that
234 character size varies a lot. A font that is otherwise fine for terminal
235 use might contain some characters that are simply too wide. Rxvt-unicode
236 will avoid these characters. For characters that are just "a bit" too
237 wide a special "careful" rendering mode is used that redraws adjacent
238 characters.
239
240 All of this requires that fonts do not lie about character sizes,
241 however: Xft fonts often draw glyphs larger than their acclaimed
242 bounding box, and rxvt-unicode has no way of detecting this (the correct
243 way is to ask for the character bounding box, which unfortunately is
244 wrong in these cases).
245
246 It's not clear (to me at least), whether this is a bug in Xft, freetype,
247 or the respective font. If you encounter this problem you might try
248 using the "-lsp" option to give the font more height. If that doesn't
249 work, you might be forced to use a different font.
250
251 All of this is not a problem when using X11 core fonts, as their
252 bounding box data is correct.
253
254 How can I keep rxvt-unicode from using reverse video so much?
255 First of all, make sure you are running with the right terminal settings
256 ("TERM=rxvt-unicode"), which will get rid of most of these effects. Then
257 make sure you have specified colours for italic and bold, as otherwise
258 rxvt-unicode might use reverse video to simulate the effect:
259
260 URxvt.colorBD: white
261 URxvt.colorIT: green
262
263 Some programs assume totally weird colours (red instead of blue), how can I fix that?
264 For some unexplainable reason, some rare programs assume a very weird
265 colour palette when confronted with a terminal with more than the
266 standard 8 colours (rxvt-unicode supports 88). The right fix is, of
267 course, to fix these programs not to assume non-ISO colours without very
268 good reasons.
269
270 In the meantime, you can either edit your "rxvt-unicode" terminfo
271 definition to only claim 8 colour support or use "TERM=rxvt", which will
272 fix colours but keep you from using other rxvt-unicode features.
273
274 Can I switch the fonts at runtime?
275 Yes, using an escape sequence. Try something like this, which has the
276 same effect as using the "-fn" switch, and takes effect immediately:
277
278 printf '\33]50;%s\007' "9x15bold,xft:Kochi Gothic"
279
280 This is useful if you e.g. work primarily with japanese (and prefer a
281 japanese font), but you have to switch to chinese temporarily, where
282 japanese fonts would only be in your way.
283
284 You can think of this as a kind of manual ISO-2022 switching.
285
286 Why do italic characters look as if clipped?
287 Many fonts have difficulties with italic characters and hinting. For
288 example, the otherwise very nicely hinted font "xft:Bitstream Vera Sans
289 Mono" completely fails in its italic face. A workaround might be to
290 enable freetype autohinting, i.e. like this:
291
292 URxvt.italicFont: xft:Bitstream Vera Sans Mono:italic:autohint=true
293 URxvt.boldItalicFont: xft:Bitstream Vera Sans Mono:bold:italic:autohint=true
294
295 Can I speed up Xft rendering somehow?
296 Yes, the most obvious way to speed it up is to avoid Xft entirely, as it
297 is simply slow. If you still want Xft fonts you might try to disable
298 antialiasing (by appending ":antialias=false"), which saves lots of
299 memory and also speeds up rendering considerably.
300
301 Rxvt-unicode doesn't seem to anti-alias its fonts, what is wrong?
302 Rxvt-unicode will use whatever you specify as a font. If it needs to
303 fall back to its default font search list it will prefer X11 core fonts,
304 because they are small and fast, and then use Xft fonts. It has
305 antialiasing disabled for most of them, because the author thinks they
306 look best that way.
307
308 If you want antialiasing, you have to specify the fonts manually.
309
310 What's with this bold/blink stuff?
311 If no bold colour is set via "colorBD:", bold will invert text using the
312 standard foreground colour.
313
314 For the standard background colour, blinking will actually make the text
315 blink when compiled with "--enable-text-blink". Without
316 "--enable-text-blink", the blink attribute will be ignored.
317
318 On ANSI colours, bold/blink attributes are used to set high-intensity
319 foreground/background colours.
320
321 color0-7 are the low-intensity colours.
322
323 color8-15 are the corresponding high-intensity colours.
324
325 I don't like the screen colours. How do I change them?
326 You can change the screen colours at run-time using ~/.Xdefaults
327 resources (or as long-options).
328
329 Here are values that are supposed to resemble a VGA screen, including
330 the murky brown that passes for low-intensity yellow:
331
332 URxvt.color0: #000000
333 URxvt.color1: #A80000
334 URxvt.color2: #00A800
335 URxvt.color3: #A8A800
336 URxvt.color4: #0000A8
337 URxvt.color5: #A800A8
338 URxvt.color6: #00A8A8
339 URxvt.color7: #A8A8A8
340
341 URxvt.color8: #000054
342 URxvt.color9: #FF0054
343 URxvt.color10: #00FF54
344 URxvt.color11: #FFFF54
345 URxvt.color12: #0000FF
346 URxvt.color13: #FF00FF
347 URxvt.color14: #00FFFF
348 URxvt.color15: #FFFFFF
349
350 And here is a more complete set of non-standard colours.
351
352 URxvt.cursorColor: #dc74d1
353 URxvt.pointerColor: #dc74d1
354 URxvt.background: #0e0e0e
355 URxvt.foreground: #4ad5e1
356 URxvt.color0: #000000
357 URxvt.color8: #8b8f93
358 URxvt.color1: #dc74d1
359 URxvt.color9: #dc74d1
360 URxvt.color2: #0eb8c7
361 URxvt.color10: #0eb8c7
362 URxvt.color3: #dfe37e
363 URxvt.color11: #dfe37e
364 URxvt.color5: #9e88f0
365 URxvt.color13: #9e88f0
366 URxvt.color6: #73f7ff
367 URxvt.color14: #73f7ff
368 URxvt.color7: #e1dddd
369 URxvt.color15: #e1dddd
370
371 They have been described (not by me) as "pretty girly".
372
373 Why do some characters look so much different than others?
374 See next entry.
375
376 How does rxvt-unicode choose fonts?
377 Most fonts do not contain the full range of Unicode, which is fine.
378 Chances are that the font you (or the admin/package maintainer of your
379 system/os) have specified does not cover all the characters you want to
380 display.
381
382 rxvt-unicode makes a best-effort try at finding a replacement font.
383 Often the result is fine, but sometimes the chosen font looks
384 bad/ugly/wrong. Some fonts have totally strange characters that don't
385 resemble the correct glyph at all, and rxvt-unicode lacks the artificial
386 intelligence to detect that a specific glyph is wrong: it has to believe
387 the font that the characters it claims to contain indeed look correct.
388
389 In that case, select a font of your taste and add it to the font list,
390 e.g.:
391
392 urxvt -fn basefont,font2,font3...
393
394 When rxvt-unicode sees a character, it will first look at the base font.
395 If the base font does not contain the character, it will go to the next
396 font, and so on. Specifying your own fonts will also speed up this
397 search and use less resources within rxvt-unicode and the X-server.
398
399 The only limitation is that none of the fonts may be larger than the
400 base font, as the base font defines the terminal character cell size,
401 which must be the same due to the way terminals work.
402
403 Why do some chinese characters look so different than others?
404 This is because there is a difference between script and language --
405 rxvt-unicode does not know which language the text that is output is, as
406 it only knows the unicode character codes. If rxvt-unicode first sees a
407 japanese/chinese character, it might choose a japanese font for display.
408 Subsequent japanese characters will use that font. Now, many chinese
409 characters aren't represented in japanese fonts, so when the first
410 non-japanese character comes up, rxvt-unicode will look for a chinese
411 font -- unfortunately at this point, it will still use the japanese font
412 for chinese characters that are also in the japanese font.
413
414 The workaround is easy: just tag a chinese font at the end of your font
415 list (see the previous question). The key is to view the font list as a
416 preference list: If you expect more japanese, list a japanese font
417 first. If you expect more chinese, put a chinese font first.
418
419 In the future it might be possible to switch language preferences at
420 runtime (the internal data structure has no problem with using different
421 fonts for the same character at the same time, but no interface for this
422 has been designed yet).
423
424 Until then, you might get away with switching fonts at runtime (see "Can
425 I switch the fonts at runtime?" later in this document).
426
427 How can I make mplayer display video correctly?
428 We are working on it, in the meantime, as a workaround, use something
429 like:
430
431 urxvt -b 600 -geometry 20x1 -e sh -c 'mplayer -wid $WINDOWID file...'
432
433 Keyboard, Mouse & User Interaction
434 The new selection selects pieces that are too big, how can I select single words?
435 If you want to select e.g. alphanumeric words, you can use the following
436 setting:
437
438 URxvt.selection.pattern-0: ([[:word:]]+)
439
440 If you click more than twice, the selection will be extended more and
441 more.
442
443 To get a selection that is very similar to the old code, try this
444 pattern:
445
446 URxvt.selection.pattern-0: ([^"&'()*,;<=>?@[\\\\]^`{|})]+)
447
448 Please also note that the *LeftClick Shift-LeftClick* combination also
449 selects words like the old code.
450
451 I don't like the new selection/popups/hotkeys/perl, how do I change/disable it?
452 You can disable the perl extension completely by setting the
453 perl-ext-common resource to the empty string, which also keeps
454 rxvt-unicode from initialising perl, saving memory.
455
456 If you only want to disable specific features, you first have to
457 identify which perl extension is responsible. For this, read the section
458 PREPACKAGED EXTENSIONS in the urxvtperl(3) manpage. For example, to
459 disable the selection-popup and option-popup, specify this
460 perl-ext-common resource:
461
462 URxvt.perl-ext-common: default,-selection-popup,-option-popup
463
464 This will keep the default extensions, but disable the two popup
465 extensions. Some extensions can also be configured, for example,
466 scrollback search mode is triggered by M-s. You can move it to any other
467 combination either by setting the searchable-scrollback resource:
468
469 URxvt.searchable-scrollback: CM-s
470
471 The cursor moves when selecting text in the current input line, how do I switch this off?
472 See next entry.
473
474 During rlogin/ssh/telnet/etc. sessions, clicking near the cursor outputs strange escape sequences, how do I fix this?
475 These are caused by the "readline" perl extension. Under normal
476 circumstances, it will move your cursor around when you click into the
477 line that contains it. It tries hard not to do this at the wrong moment,
478 but when running a program that doesn't parse cursor movements or in
479 some cases during rlogin sessions, it fails to detect this properly.
480
481 You can permanently switch this feature off by disabling the "readline"
482 extension:
483
484 URxvt.perl-ext-common: default,-readline
485
486 My numeric keypad acts weird and generates differing output?
487 Some Debian GNU/Linux users seem to have this problem, although no
488 specific details were reported so far. It is possible that this is
489 caused by the wrong "TERM" setting, although the details of whether and
490 how this can happen are unknown, as "TERM=rxvt" should offer a
491 compatible keymap. See the answer to the previous question, and please
492 report if that helped.
493
494 My Compose (Multi_key) key is no longer working.
495 The most common causes for this are that either your locale is not set
496 correctly, or you specified a preeditType that is not supported by your
497 input method. For example, if you specified OverTheSpot and your input
498 method (e.g. the default input method handling Compose keys) does not
499 support this (for instance because it is not visual), then rxvt-unicode
500 will continue without an input method.
501
502 In this case either do not specify a preeditType or specify more than
503 one pre-edit style, such as OverTheSpot,Root,None.
504
505 If it still doesn't work, then maybe your input method doesn't support
506 compose sequences - to fall back to the built-in one, make sure you
507 don't specify an input method via "-im" or "XMODIFIERS".
508
509 I cannot type "Ctrl-Shift-2" to get an ASCII NUL character due to ISO 14755
510 Either try "Ctrl-2" alone (it often is mapped to ASCII NUL even on
511 international keyboards) or simply use ISO 14755 support to your
512 advantage, typing <Ctrl-Shift-0> to get a ASCII NUL. This works for
513 other codes, too, such as "Ctrl-Shift-1-d" to type the default telnet
514 escape character and so on.
515
516 Mouse cut/paste suddenly no longer works.
517 Make sure that mouse reporting is actually turned off since killing some
518 editors prematurely may leave it active. I've heard that tcsh may use
519 mouse reporting unless it is otherwise specified. A quick check is to
520 see if cut/paste works when the Alt or Shift keys are pressed.
521
522 What's with the strange Backspace/Delete key behaviour?
523 Assuming that the physical Backspace key corresponds to the Backspace
524 keysym (not likely for Linux ... see the following question) there are
525 two standard values that can be used for Backspace: "^H" and "^?".
526
527 Historically, either value is correct, but rxvt-unicode adopts the
528 debian policy of using "^?" when unsure, because it's the one and only
529 correct choice :).
530
531 It is possible to toggle between "^H" and "^?" with the DECBKM private
532 mode:
533
534 # use Backspace = ^H
535 $ stty erase ^H
536 $ printf "\e[?67h"
537
538 # use Backspace = ^?
539 $ stty erase ^?
540 $ printf "\e[?67l"
541
542 This helps satisfy some of the Backspace discrepancies that occur, but
543 if you use Backspace = "^H", make sure that the termcap/terminfo value
544 properly reflects that.
545
546 The Delete key is a another casualty of the ill-defined Backspace
547 problem. To avoid confusion between the Backspace and Delete keys, the
548 Delete key has been assigned an escape sequence to match the vt100 for
549 Execute ("ESC [ 3 ~") and is in the supplied termcap/terminfo.
550
551 Some other Backspace problems:
552
553 some editors use termcap/terminfo, some editors (vim I'm told) expect
554 Backspace = ^H, GNU Emacs (and Emacs-like editors) use ^H for help.
555
556 Perhaps someday this will all be resolved in a consistent manner.
557
558 I don't like the key-bindings. How do I change them?
559 There are some compile-time selections available via configure. Unless
560 you have run "configure" with the "--disable-resources" option you can
561 use the `keysym' resource to alter the keystrings associated with
562 keysyms.
563
564 Here's an example for a URxvt session started using "urxvt -name URxvt"
565
566 URxvt.keysym.Prior: \033[5~
567 URxvt.keysym.Next: \033[6~
568 URxvt.keysym.Home: \033[7~
569 URxvt.keysym.End: \033[8~
570 URxvt.keysym.Up: \033[A
571 URxvt.keysym.Down: \033[B
572 URxvt.keysym.Right: \033[C
573 URxvt.keysym.Left: \033[D
574
575 See some more examples in the documentation for the keysym resource.
576
577 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
578 KP_Insert == Insert
579 F22 == Print
580 F27 == Home
581 F29 == Prior
582 F33 == End
583 F35 == Next
584
585 Rather than have rxvt-unicode try to accommodate all the various
586 possible keyboard mappings, it is better to use `xmodmap' to remap the
587 keys as required for your particular machine.
588
589 Terminal Configuration
590 Can I see a typical configuration?
591 The default configuration tries to be xterm-like, which I don't like
592 that much, but it's least surprise to regular users.
593
594 As a rxvt or rxvt-unicode user, you are practically supposed to invest
595 time into customising your terminal. To get you started, here is the
596 author's .Xdefaults entries, with comments on what they do. It's
597 certainly not *typical*, but what's typical...
598
599 URxvt.cutchars: "()*,<>[]{}|'
600 URxvt.print-pipe: cat >/tmp/xxx
601
602 These are just for testing stuff.
603
604 URxvt.imLocale: ja_JP.UTF-8
605 URxvt.preeditType: OnTheSpot,None
606
607 This tells rxvt-unicode to use a special locale when communicating with
608 the X Input Method, and also tells it to only use the OnTheSpot pre-edit
609 type, which requires the "xim-onthespot" perl extension but rewards me
610 with correct-looking fonts.
611
612 URxvt.perl-lib: /root/lib/urxvt
613 URxvt.perl-ext-common: default,selection-autotransform,selection-pastebin,xim-onthespot,remote-clipboard
614 URxvt.selection.pattern-0: ( at .*? line \\d+)
615 URxvt.selection.pattern-1: ^(/[^:]+):\
616 URxvt.selection-autotransform.0: s/^([^:[:space:]]+):(\\d+):?$/:e \\Q$1\\E\\x0d:$2\\x0d/
617 URxvt.selection-autotransform.1: s/^ at (.*?) line (\\d+)$/:e \\Q$1\\E\\x0d:$2\\x0d/
618
619 This is my perl configuration. The first two set the perl library
620 directory and also tells urxvt to use a large number of extensions. I
621 develop for myself mostly, so I actually use most of the extensions I
622 write.
623
624 The selection stuff mainly makes the selection perl-error-message aware
625 and tells it to convert perl error messages into vi-commands to load the
626 relevant file and go to the error line number.
627
628 URxvt.scrollstyle: plain
629 URxvt.secondaryScroll: true
630
631 As the documentation says: plain is the preferred scrollbar for the
632 author. The "secondaryScroll" configures urxvt to scroll in full-screen
633 apps, like screen, so lines scrolled out of screen end up in urxvt's
634 scrollback buffer.
635
636 URxvt.background: #000000
637 URxvt.foreground: gray90
638 URxvt.color7: gray90
639 URxvt.colorBD: #ffffff
640 URxvt.cursorColor: #e0e080
641 URxvt.throughColor: #8080f0
642 URxvt.highlightColor: #f0f0f0
643
644 Some colours. Not sure which ones are being used or even non-defaults,
645 but these are in my .Xdefaults. Most notably, they set
646 foreground/background to light gray/black, and also make sure that the
647 colour 7 matches the default foreground colour.
648
649 URxvt.underlineColor: yellow
650
651 Another colour, makes underline lines look different. Sometimes hurts,
652 but is mostly a nice effect.
653
654 URxvt.geometry: 154x36
655 URxvt.loginShell: false
656 URxvt.meta: ignore
657 URxvt.utmpInhibit: true
658
659 Uh, well, should be mostly self-explanatory. By specifying some defaults
660 manually, I can quickly switch them for testing.
661
662 URxvt.saveLines: 8192
663
664 A large scrollback buffer is essential. Really.
665
666 URxvt.mapAlert: true
667
668 The only case I use it is for my IRC window, which I like to keep
669 iconified till people msg me (which beeps).
670
671 URxvt.visualBell: true
672
673 The audible bell is often annoying, especially when in a crowd.
674
675 URxvt.insecure: true
676
677 Please don't hack my mutt! Ooops...
678
679 URxvt.pastableTabs: false
680
681 I once thought this is a great idea.
682
683 urxvt.font: 9x15bold,\
684 -misc-fixed-bold-r-normal--15-140-75-75-c-90-iso10646-1,\
685 -misc-fixed-medium-r-normal--15-140-75-75-c-90-iso10646-1, \
686 [codeset=JISX0208]xft:Kochi Gothic, \
687 xft:Bitstream Vera Sans Mono:autohint=true, \
688 xft:Code2000:antialias=false
689 urxvt.boldFont: -xos4-terminus-bold-r-normal--14-140-72-72-c-80-iso8859-15
690 urxvt.italicFont: xft:Bitstream Vera Sans Mono:italic:autohint=true
691 urxvt.boldItalicFont: xft:Bitstream Vera Sans Mono:bold:italic:autohint=true
692
693 I wrote rxvt-unicode to be able to specify fonts exactly. So don't be
694 overwhelmed. A special note: the "9x15bold" mentioned above is actually
695 the version from XFree-3.3, as XFree-4 replaced it by a totally
696 different font (different glyphs for ";" and many other harmless
697 characters), while the second font is actually the "9x15bold" from
698 XFree4/XOrg. The bold version has less chars than the medium version, so
699 I use it for rare characters, too. When editing sources with vim, I use
700 italic for comments and other stuff, which looks quite good with
701 Bitstream Vera anti-aliased.
702
703 Terminus is a quite bad font (many very wrong glyphs), but for most of
704 my purposes, it works, and gives a different look, as my normal
705 (Non-bold) font is already bold, and I want to see a difference between
706 bold and normal fonts.
707
708 Please note that I used the "urxvt" instance name and not the "URxvt"
709 class name. That is because I use different configs for different
710 purposes, for example, my IRC window is started with "-name IRC", and
711 uses these defaults:
712
713 IRC*title: IRC
714 IRC*geometry: 87x12+535+542
715 IRC*saveLines: 0
716 IRC*mapAlert: true
717 IRC*font: suxuseuro
718 IRC*boldFont: suxuseuro
719 IRC*colorBD: white
720 IRC*keysym.M-C-1: command:\033]710;suxuseuro\007\033]711;suxuseuro\007
721 IRC*keysym.M-C-2: command:\033]710;9x15bold\007\033]711;9x15bold\007
722
723 "Alt-Ctrl-1" and "Alt-Ctrl-2" switch between two different font sizes.
724 "suxuseuro" allows me to keep an eye (and actually read) stuff while
725 keeping a very small window. If somebody pastes something complicated
726 (e.g. japanese), I temporarily switch to a larger font.
727
728 The above is all in my ".Xdefaults" (I don't use ".Xresources" nor
729 "xrdb"). I also have some resources in a separate ".Xdefaults-hostname"
730 file for different hosts, for example, on my main desktop, I use:
731
732 URxvt.keysym.C-M-q: command:\033[3;5;5t
733 URxvt.keysym.C-M-y: command:\033[3;5;606t
734 URxvt.keysym.C-M-e: command:\033[3;1605;5t
735 URxvt.keysym.C-M-c: command:\033[3;1605;606t
736 URxvt.keysym.C-M-p: perl:test
737
738 The first for keysym definitions allow me to quickly bring some windows
739 in the layout I like most. Ion users might start laughing but will stop
740 immediately when I tell them that I use my own Fvwm2 module for much the
741 same effect as Ion provides, and I only very rarely use the above key
742 combinations :->
743
744 Why doesn't rxvt-unicode read my resources?
745 Well, why, indeed? It does, in a way very similar to other X
746 applications. Most importantly, this means that if you or your OS loads
747 resources into the X display (the right way to do it), rxvt-unicode will
748 ignore any resource files in your home directory. It will only read
749 $HOME/.Xdefaults when no resources are attached to the display.
750
751 If you have or use an $HOME/.Xresources file, chances are that resources
752 are loaded into your X-server. In this case, you have to re-login after
753 every change (or run xrdb -merge $HOME/.Xresources).
754
755 Also consider the form resources have to use:
756
757 URxvt.resource: value
758
759 If you want to use another form (there are lots of different ways of
760 specifying resources), make sure you understand whether and why it
761 works. If unsure, use the form above.
762
6 When I log-in to another system it tells me about missing terminfo data? 763 When I log-in to another system it tells me about missing terminfo data?
7 The terminal description used by rxvt-unicode is not as widely 764 The terminal description used by rxvt-unicode is not as widely available
8 available as that for xterm, or even rxvt (for which the same 765 as that for xterm, or even rxvt (for which the same problem often
9 problem often arises). 766 arises).
10 767
11 The correct solution for this problem is to install the terminfo, 768 The correct solution for this problem is to install the terminfo, this
12 this can be done like this (with ncurses' infocmp): 769 can be done by simply installing rxvt-unicode on the remote system as
770 well (in case you have a nice package manager ready), or you can install
771 the terminfo database manually like this (with ncurses infocmp. works as
772 user and root):
13 773
14 REMOTE=remotesystem.domain 774 REMOTE=remotesystem.domain
15 infocmp rxvt-unicode | ssh $REMOTE "cat >/tmp/ti && tic /tmp/ti" 775 infocmp rxvt-unicode | ssh $REMOTE "mkdir -p .terminfo && cat >/tmp/ti && tic /tmp/ti"
16 776
17 ... or by installing rxvt-unicode normally on the remote system, 777 One some systems you might need to set $TERMINFO to the full path of
778 $HOME/.terminfo for this to work.
18 779
19 If you cannot or do not want to do this, then you can simply set 780 If you cannot or do not want to do this, then you can simply set
20 "TERM=rxvt" or even "TERM=xterm", and live with the small number of 781 "TERM=rxvt" or even "TERM=xterm", and live with the small number of
21 problems arising, which includes wrong keymapping, less and 782 problems arising, which includes wrong keymapping, less and different
22 different colours and some refresh errors in fullscreen 783 colours and some refresh errors in fullscreen applications. It's a nice
23 applications. It's a nice quick-and-dirty workaround for rare cases, 784 quick-and-dirty workaround for rare cases, though.
24 though.
25 785
26 If you always want to do this you can either recompile rxvt-unicode 786 If you always want to do this (and are fine with the consequences) you
27 with the desired TERM value or use a resource to set it: 787 can either recompile rxvt-unicode with the desired TERM value or use a
788 resource to set it:
28 789
29 URxvt.termName: rxvt 790 URxvt.termName: rxvt
30 791
31 If you don't plan to use rxvt (quite common...) you could also 792 If you don't plan to use rxvt (quite common...) you could also replace
32 replace the rxvt terminfo file with the rxvt-unicode one. 793 the rxvt terminfo file with the rxvt-unicode one and use "TERM=rxvt".
33 794
795 nano fails with "Error opening terminal: rxvt-unicode"
796 This exceptionally confusing and useless error message is printed by
797 nano when it can't find the terminfo database. Nothing is wrong with
798 your terminal, read the previous answer for a solution.
799
800 "tic" outputs some error when compiling the terminfo entry.
801 Most likely it's the empty definition for "enacs=". Just replace it by
802 "enacs=\E[0@" and try again.
803
804 "bash"'s readline does not work correctly under urxvt.
805 See next entry.
806
34 I need a termcap file entry. 807 I need a termcap file entry.
808 One reason you might want this is that some distributions or operating
809 systems still compile some programs using the long-obsoleted termcap
810 library (Fedora Core's bash is one example) and rely on a termcap entry
811 for "rxvt-unicode".
812
35 You could use rxvt's termcap entry with resonable results in many 813 You could use rxvt's termcap entry with reasonable results in many
36 cases. You can also create a termcap entry by using terminfo's 814 cases. You can also create a termcap entry by using terminfo's infocmp
37 infocmp program like this: 815 program like this:
38 816
39 infocmp -C rxvt-unicode 817 infocmp -C rxvt-unicode
40 818
41 OR you could this termcap entry: 819 Or you could use the termcap entry in doc/etc/rxvt-unicode.termcap,
820 generated by the command above.
42 821
43 rxvt-unicode|rxvt-unicode terminal (X Window System):\
44 :am:bw:eo:km:mi:ms:xn:xo:\
45 :co#80:it#8:li#24:\
46 :AL=\E[%dL:DC=\E[%dP:DL=\E[%dM:DO=\E[%dB:IC=\E[%d@:\
47 :K1=\EOw:K2=\EOu:K3=\EOy:K4=\EOq:K5=\EOs:LE=\E[%dD:\
48 :RI=\E[%dC:SF=\E[%dS:SR=\E[%dT:UP=\E[%dA:ae=^O:al=\E[L:\
49 :as=^N:bl=^G:cd=\E[J:ce=\E[K:cl=\E[H\E[2J:cm=\E[%i%d;%dH:\
50 :cr=^M:cs=\E[%i%d;%dr:ct=\E[3g:dc=\E[P:dl=\E[M:do=^J:\
51 :ec=\E[%dX:ei=\E[4l:ho=\E[H:i1=\E[?47l\E=\E[?1l:ic=\E[@:\
52 :im=\E[4h:is=\E[r\E[m\E[2J\E[H\E[?7h\E[?1;3;4;6l\E[4l:\
53 :k0=\E[21~:k1=\E[11~:k2=\E[12~:k3=\E[13~:k4=\E[14~:\
54 :k5=\E[15~:k6=\E[17~:k7=\E[18~:k8=\E[19~:k9=\E[20~:\
55 :kD=\E[3~:kI=\E[2~:kN=\E[6~:kP=\E[5~:kb=\177:kd=\EOB:\
56 :ke=\E[?1l\E>:kh=\E[7~:kl=\EOD:kr=\EOC:ks=\E[?1h\E=:\
57 :ku=\EOA:le=^H:mb=\E[5m:md=\E[1m:me=\E[m\017:mr=\E[7m:\
58 :nd=\E[C:rc=\E8:sc=\E7:se=\E[27m:sf=^J:so=\E[7m:sr=\EM:\
59 :st=\EH:ta=^I:te=\E[r\E[?1049l:ti=\E[?1049h:ue=\E[24m:\
60 :up=\E[A:us=\E[4m:vb=\E[?5h\E[?5l:ve=\E[?25h:vi=\E[?25l:\
61 :vs=\E[?25h:
62
63 Why does "ls" no longer have coloured output? 822 Why does "ls" no longer have coloured output?
64 The "ls" in the GNU coreutils unfortunately doesn't use terminfo to 823 The "ls" in the GNU coreutils unfortunately doesn't use terminfo to
65 decide wether a terminal has colour, but uses it's own configuration 824 decide whether a terminal has colour, but uses its own configuration
66 file. Needless to say, "rxvt-unicode" is not in it's default file 825 file. Needless to say, "rxvt-unicode" is not in its default file (among
67 (among with most other terminals supporting colour). Either add: 826 with most other terminals supporting colour). Either add:
68 827
69 TERM rxvt-unicode 828 TERM rxvt-unicode
70 829
71 to "/etc/DIR_COLORS" or simply add: 830 to "/etc/DIR_COLORS" or simply add:
72 831
73 alias ls='ls --color=auto' 832 alias ls='ls --color=auto'
74 833
75 to your ".profile" or ".bashrc". 834 to your ".profile" or ".bashrc".
76 835
77 Why doesn't vim/emacs etc. use the 88 colour mode? 836 Why doesn't vim/emacs etc. use the 88 colour mode?
837 See next entry.
838
78 Why doesn't vim/emacs etc. make use of italic? 839 Why doesn't vim/emacs etc. make use of italic?
840 See next entry.
841
79 Why are the secondary screen-related options not working properly? 842 Why are the secondary screen-related options not working properly?
80 Make sure you are using "TERM=rxvt-unicode". Some pre-packaged 843 Make sure you are using "TERM=rxvt-unicode". Some pre-packaged
81 distributions (most notably Debian GNU/Linux) break rxvt-unicode by 844 distributions break rxvt-unicode by setting "TERM" to "rxvt", which
82 setting "TERM" to "rxvt", which doesn't have these extra features. 845 doesn't have these extra features. Unfortunately, some of these
83 Unfortunately, some of these (most notably, again, Debian GNU/Linux)
84 furthermore fail to even install the "rxvt-unicode" terminfo file, 846 furthermore fail to even install the "rxvt-unicode" terminfo file, so
85 so you will need to install it on your own (See the question When I 847 you will need to install it on your own (See the question When I log-in
86 log-in to another system it tells me about missing terminfo data? on 848 to another system it tells me about missing terminfo data? on how to do
87 how to do this). 849 this).
88 850
851 Encoding / Locale / Input Method Issues
89 Rxvt-unicode does not seem to understand the selected encoding? 852 Rxvt-unicode does not seem to understand the selected encoding?
853 See next entry.
854
90 Unicode does not seem to work? 855 Unicode does not seem to work?
91 If you encounter strange problems like typing an accented character 856 If you encounter strange problems like typing an accented character but
92 but getting two unrelated other characters or similar, or if program 857 getting two unrelated other characters or similar, or if program output
93 output is subtly garbled, then you should check your locale 858 is subtly garbled, then you should check your locale settings.
94 settings.
95 859
96 Rxvt-unicode must be started with the same "LC_CTYPE" setting as the 860 Rxvt-unicode must be started with the same "LC_CTYPE" setting as the
97 programs. Often rxvt-unicode is started in the "C" locale, while the 861 programs running in it. Often rxvt-unicode is started in the "C" locale,
98 login script running within the rxvt-unicode window changes the 862 while the login script running within the rxvt-unicode window changes
99 locale to sth. else, e.h. "en_GB.UTF-8". Needless to say, this is 863 the locale to something else, e.g. "en_GB.UTF-8". Needless to say, this
100 not going to work. 864 is not going to work, and is the most common cause for problems.
101 865
102 The best thing is to fix your startup environment, as you will 866 The best thing is to fix your startup environment, as you will likely
103 likely run into other problems. If nothing works you can try this in 867 run into other problems. If nothing works you can try this in your
104 your .profile. 868 .profile.
105 869
106 printf '\e]701;%s\007' "$LC_CTYPE" 870 printf '\33]701;%s\007' "$LC_CTYPE" # $LANG or $LC_ALL are worth a try, too
107 871
108 If this doesn't work, then maybe you use a "LC_CTYPE" specification 872 If this doesn't work, then maybe you use a "LC_CTYPE" specification not
109 not supported on your systems. Some systems have a "locale" command 873 supported on your systems. Some systems have a "locale" command which
110 which displays this. If it displays sth. like: 874 displays this (also, "perl -e0" can be used to check locale settings, as
875 it will complain loudly if it cannot set the locale). If it displays
876 something like:
111 877
112 locale: Cannot set LC_CTYPE to default locale: ... 878 locale: Cannot set LC_CTYPE to default locale: ...
113 879
114 Then the locale you specified is not supported on your system. 880 Then the locale you specified is not supported on your system.
115 881
116 If nothing works and you are sure that everything is set correctly 882 If nothing works and you are sure that everything is set correctly then
117 then you will need to remember a little known fact: Some programs 883 you will need to remember a little known fact: Some programs just don't
118 just don't support locales :( 884 support locales :(
119 885
120 Why do some characters look so much different than others?
121 How does rxvt-unicode choose fonts?
122 Most fonts do not contain the full range of Unicode, which is fine.
123 Chances are that the font you (or the admin/package maintainer of
124 your system/os) have specified does not cover all the characters you
125 want to display.
126
127 rxvt-unicode makes a best-effort try at finding a replacement font.
128 Often the result is fine, but sometimes the chosen font looks bad.
129 Many fonts have totally strange characters that don't resemble the
130 correct glyph at all, and rxvt-unicode lacks the artificial
131 intelligence to detect that a specific glyph is wrong: it has to
132 believe the font that the characters it contains indeed look
133 correct.
134
135 In that case, select a font of your taste and add it to the font
136 list, e.g.:
137
138 rxvt -fn basefont,font2,font3...
139
140 When rxvt-unicode sees a character, it will first look at the base
141 font. If the base font does not contain the character, it will go to
142 the next font, and so on. Specifying your own fonts will also speed
143 up this search and use less resources within rxvt-unicode and the
144 X-server.
145
146 The only limitation is that all the fonts must not be larger than
147 the base font, as the base font defines the principal cell size,
148 which must be the same due to the way terminals work.
149
150 Why do some chinese characters look so different than others?
151 This is because there is a difference between script and language --
152 rxvt-unicode does not know which language the text that is output
153 is, as it only knows the unicode character codes. If rxvt-unicode
154 first sees a japanese character, it might choose a japanese font for
155 it. Subsequent japanese characters will take that font. Now, many
156 chinese characters aren't represented in japanese fonts, so when the
157 first non-japanese character comes up, rxvt-unicode will look for a
158 chinese font -- unfortunately at this point, it will still use the
159 japanese font for japanese characters that are also chinese.
160
161 The workaround is easy: just tag a chinese font at the end of your
162 font list (see the previous question). The key is to view the font
163 list as a preference list: If you expect more japanese, list a
164 japanese font first. If you expect more chinese, put a chinese font
165 first.
166
167 In the future it might be possible to switch preferences at runtime
168 (the internal data structure has no problem with using different
169 fonts for the same character at the same time, but no interface for
170 this has been designed yet).
171
172 Why does rxvt-unicode sometimes leave pixel droppings?
173 Most fonts were not designed for terminal use, which means that
174 character size varies a lot. A font that is otherwise fine for
175 terminal use might contain some characters that are simply too wide.
176 Rxvt-unicode will avoid these characters. For characters that are
177 just "a bit" too wide a special "careful" rendering mode is used
178 that redraws adjacent characters.
179
180 All of this requires that fonts do not lie about character sizes,
181 however: Xft fonts often draw glyphs larger than their acclaimed
182 bounding box, and rxvt-unicode has no way of detecting this (the
183 correct way is to ask for the character bounding box, which
184 unfortunately is wrong in these cases).
185
186 It's not clear (to me at least), wether this is a bug in Xft,
187 freetype, or the respective font. If you encounter this problem you
188 might try using the "-lsp" option to give the font more height. If
189 that doesn't work, you might be forced to use a different font.
190
191 All of this is not a problem when using X11 core fonts, as their
192 bounding box data is correct.
193
194 My Compose (Multi_key) key is no longer working.
195 The most common causes for this are that either your locale is not
196 set correctly, or you specified a preeditStyle that is not supported
197 by your input method. For example, if you specified OverTheSpot and
198 your input method (e.g. the default input method handling Compose
199 keys) does not support this (for instance because it is not visual),
200 then rxvt-unicode will continue without an input method.
201
202 In this case either do not specify a preeditStyle or specify more
203 than one pre-edit style, such as OverTheSpot,Root,None.
204
205 I cannot type "Ctrl-Shift-2" to get an ASCII NUL character due to ISO
206 14755
207 Either try "Ctrl-2" alone (it often is mapped to ASCII NUL even on
208 international keyboards) or simply use ISO 14755 support to your
209 advantage, typing <Ctrl-Shift-0> to get a ASCII NUL. This works for
210 other codes, too, such as "Ctrl-Shift-1-d" to type the default
211 telnet escape character and so on.
212
213 How can I keep rxvt-unicode from using reverse video so much?
214 First of all, make sure you are running with the right terminfo
215 ("urxvt"), which will get rid of most of these effects. Then make
216 sure you have specified colours for italic and bold, as otherwise
217 rxvt-unicode might use reverse video to simulate the effect:
218
219 URxvt*colorBD: white
220 URxvt*colorIT: green
221
222 Some programs assume totally weird colours (red instead of blue), how
223 can I fix that?
224 For some unexplainable reason, some programs (i.e. irssi) assume a
225 very weird colour palette when confronted with a terminal with more
226 than the standard 8 colours (rxvt-unicode supports 88). The right
227 fix is, of course, to fix these programs not to assume non-ISO
228 colours without very good reasons.
229
230 In the meantime, you can either edit your "urxvt" terminfo
231 definition to only claim 8 colour support or use "TERM=rxvt", which
232 will fix colours but keep you from using other rxvt-unicode
233 features.
234
235 I am on FreeBSD and rxvt-unicode does not seem to work at all.
236 Rxvt-unicode requires the symbol "__STDC_ISO_10646__" to be defined
237 in your compile environment, or an implementation that implements
238 it, wether it defines the symbol or not. "__STDC_ISO_10646__"
239 requires that wchar_t is represented as unicode.
240
241 As you might have guessed, FreeBSD does neither define this symobl
242 nor does it support it. Instead, it uses it's own internal
243 representation of wchar_t. This is, of course, completely legal.
244
245 However, "__STDC_ISO_10646__" is the only sane way to support
246 multi-language apps in an OS, as using a locale-dependent (and
247 non-standardized) representation of wchar_t makes it impossible to
248 convert between wchar_t (as used by X11 and your applications) and
249 any other encoding without implementing OS-specific-wrappers for
250 each and every locale. There simply are no APIs to convert wchar_t
251 into anything except the current locale encoding.
252
253 Some applications (such as the formidable mlterm) work around this
254 by carrying their own replacement functions for character set
255 handling with them, and either implementing OS-dependent hacks or
256 doing multiple conversions (which is slow and unreliable in case the
257 OS implements encodings slightly different than the terminal
258 emulator).
259
260 The rxvt-unicode author insists that the right way to fix this is in
261 the system libraries once and for all, instead of forcing every app
262 to carry complete replacements.
263
264 How does rxvt-unicode determine the encoding to use? 886 How does rxvt-unicode determine the encoding to use?
887 See next entry.
888
265 Is there an option to switch encodings? 889 Is there an option to switch encodings?
266 Unlike some other terminals, rxvt-unicode has no encoding switch, 890 Unlike some other terminals, rxvt-unicode has no encoding switch, and no
267 and no specific "utf-8" mode, such as xterm. In fact, it doesn't 891 specific "utf-8" mode, such as xterm. In fact, it doesn't even know
268 even know about UTF-8 or any other encodings with respect to 892 about UTF-8 or any other encodings with respect to terminal I/O.
269 terminal I/O.
270 893
271 The reasons is that there exists a perfectly fine mechanism for 894 The reasons is that there exists a perfectly fine mechanism for
272 selecting the encoding, doing I/O and (most important) communicating 895 selecting the encoding, doing I/O and (most important) communicating
273 this to all applications so everybody agrees on character properties 896 this to all applications so everybody agrees on character properties
274 such as width and code number. This mechanism is the *locale*. 897 such as width and code number. This mechanism is the *locale*.
898 Applications not using that info will have problems (for example,
899 "xterm" gets the width of characters wrong as it uses its own,
900 locale-independent table under all locales).
275 901
276 Rxvt-unicode uses the "LC_CTYPE" locale category to select encoding. 902 Rxvt-unicode uses the "LC_CTYPE" locale category to select encoding. All
277 All programs doing the same (that is, most) will automatically agree 903 programs doing the same (that is, most) will automatically agree in the
278 in the interpretation of characters. 904 interpretation of characters.
279 905
280 Unfortunately, there is no system-independent way to select locales, 906 Unfortunately, there is no system-independent way to select locales, nor
281 nor is there a standard on how locale specifiers will look like. 907 is there a standard on how locale specifiers will look like.
282 908
283 On most systems, the content of the "LC_CTYPE" environment variable 909 On most systems, the content of the "LC_CTYPE" environment variable
284 contains an arbitrary string which corresponds to an 910 contains an arbitrary string which corresponds to an already-installed
285 already-installed locale. Common names for locales are 911 locale. Common names for locales are "en_US.UTF-8", "de_DE.ISO-8859-15",
286 "en_US.UTF-8", "de_DE.ISO-8859-15", "ja_JP.EUC-JP", i.e. 912 "ja_JP.EUC-JP", i.e. "language_country.encoding", but other forms (i.e.
287 "language_country.encoding", but other forms (i.e. "de" or "german") 913 "de" or "german") are also common.
288 are also common.
289 914
290 Rxvt-unicode ignores all other locale categories, and except for the 915 Rxvt-unicode ignores all other locale categories, and except for the
291 encoding, ignores country or language-specific settings, i.e. 916 encoding, ignores country or language-specific settings, i.e.
292 "de_DE.UTF-8" and "ja_JP.UTF-8" are the same for rxvt-unicode. 917 "de_DE.UTF-8" and "ja_JP.UTF-8" are the normally same to rxvt-unicode.
293 918
294 If you want to use a specific encoding you have to make sure you 919 If you want to use a specific encoding you have to make sure you start
295 start rxvt-unicode with the correct "LC_CTYPE" category. 920 rxvt-unicode with the correct "LC_CTYPE" category.
296 921
297 Can I switch locales at runtime? 922 Can I switch locales at runtime?
298 Yes, using an escape sequence. Try sth. like this, which sets 923 Yes, using an escape sequence. Try something like this, which sets
299 rxvt-unicode's idea of "LC_CTYPE". 924 rxvt-unicode's idea of "LC_CTYPE".
300 925
301 printf '\e]701;%s\007' ja_JP.SJIS 926 printf '\33]701;%s\007' ja_JP.SJIS
302 927
303 See also the previous question. 928 See also the previous answer.
304 929
305 Sometimes this capability is rather handy when you want to work in 930 Sometimes this capability is rather handy when you want to work in one
306 one locale (e.g. "de_DE.UTF-8") but some programs don't support 931 locale (e.g. "de_DE.UTF-8") but some programs don't support it (e.g.
307 UTF-8. For example, I use this script to start "xjdic", which first 932 UTF-8). For example, I use this script to start "xjdic", which first
308 switches to a locale supported by xjdic and back later: 933 switches to a locale supported by xjdic and back later:
309 934
310 printf '\e]701;%s\007' ja_JP.SJIS 935 printf '\33]701;%s\007' ja_JP.SJIS
311 xjdic -js 936 xjdic -js
312 printf '\e]701;%s\007' de_DE.UTF-8 937 printf '\33]701;%s\007' de_DE.UTF-8
313 938
314 Can I switch the fonts at runtime? 939 You can also use xterm's "luit" program, which usually works fine,
315 Yes, using an escape sequence. Try sth. like this, which has the 940 except for some locales where character width differs between program-
316 same effect as using the "-fn" switch, and takes effect immediately: 941 and rxvt-unicode-locales.
317 942
318 printf '\e]50;%s\007' "9x15bold,xft:Kochi Gothic" 943 I have problems getting my input method working.
944 Try a search engine, as this is slightly different for every input
945 method server.
319 946
320 This is useful if you e.g. work primarily with japanese (and prefer 947 Here is a checklist:
321 a japanese font), but you have to switch to chinese temporarily,
322 where japanese fonts would only be in your way.
323 948
324 You can think of this as a kind of manual ISO-2022 switching. 949 - Make sure your locale *and* the imLocale are supported on your OS.
950 Try "locale -a" or check the documentation for your OS.
325 951
326 Why do italic characters look as if clipped? 952 - Make sure your locale or imLocale matches a locale supported by your
327 Many fonts have difficulties with italic characters and hinting. For 953 XIM.
328 example, the otherwise very nicely hinted font "xft:Bitstream Vera 954 For example, kinput2 does not support UTF-8 locales, you should use
329 Sans Mono" completely fails in it's italic face. A workaround is to 955 "ja_JP.EUC-JP" or equivalent.
330 enable freetype autohinting, i.e. like this:
331 956
332 URxvt*italicFont: xft:Bitstream Vera Sans Mono:italic:autohint=true 957 - Make sure your XIM server is actually running.
333 URxvt*boldItalicFont: xft:Bitstream Vera Sans Mono:bold:italic:autohint=true 958 - Make sure the "XMODIFIERS" environment variable is set correctly when
959 *starting* rxvt-unicode.
960 When you want to use e.g. kinput2, it must be set to "@im=kinput2".
961 For scim, use "@im=SCIM". You can see what input method servers are
962 running with this command:
334 963
964 xprop -root XIM_SERVERS
965
335 My input method wants <some encoding> but I want UTF-8, what can I do? 966 My input method wants <some encoding> but I want UTF-8, what can I do?
336 You can specify separate locales for the input method and the rest 967 You can specify separate locales for the input method and the rest of
337 of the terminal, using the resource "imlocale": 968 the terminal, using the resource "imlocale":
338 969
339 URxvt*imlocale: ja_JP.EUC-JP 970 URxvt.imlocale: ja_JP.EUC-JP
340 971
341 Now you can start your terminal with "LC_CTYPE=ja_JP.UTF-8" and 972 Now you can start your terminal with "LC_CTYPE=ja_JP.UTF-8" and still
342 still use your input method. Please note, however, that you will not 973 use your input method. Please note, however, that, depending on your
343 be able to input characters outside "EUC-JP" in a normal way then, 974 Xlib version, you may not be able to input characters outside "EUC-JP"
344 as your input method limits you. 975 in a normal way then, as your input method limits you.
345 976
346 Rxvt-unicode uses gobs of memory, how can I reduce that? 977 Rxvt-unicode crashes when the X Input Method changes or exits.
347 Rxvt-unicode tries to obey the rule of not charging you for sth. you 978 Unfortunately, this is unavoidable, as the XIM protocol is racy by
348 don't use. One thing you should try is to configure out all settings 979 design. Applications can avoid some crashes at the expense of memory
349 that you don't need, for example, Xft support is a resource hog by 980 leaks, and Input Methods can avoid some crashes by careful ordering at
350 design, when used. Compiling it out ensures that no Xft font will be 981 exit time. kinput2 (and derived input methods) generally succeeds, while
351 loaded accidentally when rxvt-unicode tries to find a font for your 982 SCIM (or similar input methods) fails. In the end, however, crashes
352 characters. 983 cannot be completely avoided even if both sides cooperate.
353 984
354 Also, many people (me included) like large windows and even larger 985 So the only workaround is not to kill your Input Method Servers.
355 scrollback buffers: Without "--enable-unicode3", rxvt-unicode will
356 use 6 bytes per screen cell. For a 160x?? window this amounts to
357 almost a kilobyte per line. A scrollback buffer of 10000 lines will
358 then (if full) use 10 Megabytes of memory. With "--enable-unicode3"
359 it gets worse, as rxvt-unicode then uses 8 bytes per screen cell.
360 986
361 Can I speed up Xft rendering somehow? 987 Operating Systems / Package Maintaining
362 Yes, the most obvious way to speed it up is to avoid Xft entirely, 988 I am maintaining rxvt-unicode for distribution/OS XXX, any recommendation?
363 as it is simply slow. If you still want Xft fonts you might try to 989 You should build one binary with the default options. configure now
364 disable antialiasing (by appending ":antialiasing=false"), which 990 enables most useful options, and the trend goes to making them
365 saves lots of memory and also speeds up rendering considerably. 991 runtime-switchable, too, so there is usually no drawback to enabling
992 them, except higher disk and possibly memory usage. The perl interpreter
993 should be enabled, as important functionality (menus, selection, likely
994 more in the future) depends on it.
366 995
367 Rxvt-unicode doesn't seem to anti-alias its fonts, what is wrong? 996 You should not overwrite the "perl-ext-common" and "perl-ext" resources
368 Rxvt-unicode will use whatever you specify as a font. If it needs to 997 system-wide (except maybe with "defaults"). This will result in useful
369 fall back to it's default font search list it will prefer X11 core 998 behaviour. If your distribution aims at low memory, add an empty
370 fonts, because they are small and fast, and then use Xft fonts. It 999 "perl-ext-common" resource to the app-defaults file. This will keep the
371 has antialiasing disabled for most of them, because the author 1000 perl interpreter disabled until the user enables it.
372 thinks they look best that way.
373 1001
374 If you want antialiasing, you have to specify the fonts manually. 1002 If you can/want build more binaries, I recommend building a minimal one
1003 with "--disable-everything" (very useful) and a maximal one with
1004 "--enable-everything" (less useful, it will be very big due to a lot of
1005 encodings built-in that increase download times and are rarely used).
375 1006
376 Mouse cut/paste suddenly no longer works. 1007 I need to make it setuid/setgid to support utmp/ptys on my OS, is this safe?
377 Make sure that mouse reporting is actually turned off since killing 1008 It should be, starting with release 7.1. You are encouraged to properly
378 some editors prematurely may leave the mouse in mouse report mode. 1009 install urxvt with privileges necessary for your OS now.
379 I've heard that tcsh may use mouse reporting unless it otherwise
380 specified. A quick check is to see if cut/paste works when the Alt
381 or Shift keys are depressed. See rxvt(7)
382 1010
383 What's with this bold/blink stuff? 1011 When rxvt-unicode detects that it runs setuid or setgid, it will fork
384 If no bold colour is set via "colorBD:", bold will invert text using 1012 into a helper process for privileged operations (pty handling on some
385 the standard foreground colour. 1013 systems, utmp/wtmp/lastlog handling on others) and drop privileges
1014 immediately. This is much safer than most other terminals that keep
1015 privileges while running (but is more relevant to urxvt, as it contains
1016 things as perl interpreters, which might be "helpful" to attackers).
386 1017
387 For the standard background colour, blinking will actually make the 1018 This forking is done as the very first within main(), which is very
388 text blink when compiled with "--enable-blinking". with standard 1019 early and reduces possible bugs to initialisation code run before
389 colours. Without "--enable-blinking", the blink attribute will be 1020 main(), or things like the dynamic loader of your system, which should
390 ignored. 1021 result in very little risk.
391 1022
392 On ANSI colours, bold/blink attributes are used to set 1023 I am on FreeBSD and rxvt-unicode does not seem to work at all.
393 high-intensity foreground/background colors. 1024 Rxvt-unicode requires the symbol "__STDC_ISO_10646__" to be defined in
1025 your compile environment, or an implementation that implements it,
1026 whether it defines the symbol or not. "__STDC_ISO_10646__" requires that
1027 wchar_t is represented as unicode.
394 1028
395 color0-7 are the low-intensity colors. 1029 As you might have guessed, FreeBSD does neither define this symbol nor
1030 does it support it. Instead, it uses its own internal representation of
1031 wchar_t. This is, of course, completely fine with respect to standards.
396 1032
397 color8-15 are the corresponding high-intensity colors. 1033 However, that means rxvt-unicode only works in "POSIX", "ISO-8859-1" and
1034 "UTF-8" locales under FreeBSD (which all use Unicode as wchar_t).
398 1035
399 I don't like the screen colors. How do I change them? 1036 "__STDC_ISO_10646__" is the only sane way to support multi-language apps
400 You can change the screen colors at run-time using ~/.Xdefaults 1037 in an OS, as using a locale-dependent (and non-standardized)
401 resources (or as long-options). 1038 representation of wchar_t makes it impossible to convert between wchar_t
1039 (as used by X11 and your applications) and any other encoding without
1040 implementing OS-specific-wrappers for each and every locale. There
1041 simply are no APIs to convert wchar_t into anything except the current
1042 locale encoding.
402 1043
403 Here are values that are supposed to resemble a VGA screen, 1044 Some applications (such as the formidable mlterm) work around this by
404 including the murky brown that passes for low-intensity yellow: 1045 carrying their own replacement functions for character set handling with
1046 them, and either implementing OS-dependent hacks or doing multiple
1047 conversions (which is slow and unreliable in case the OS implements
1048 encodings slightly different than the terminal emulator).
405 1049
406 URxvt*color0: #000000 1050 The rxvt-unicode author insists that the right way to fix this is in the
407 URxvt*color1: #A80000 1051 system libraries once and for all, instead of forcing every app to carry
408 URxvt*color2: #00A800 1052 complete replacements for them :)
409 URxvt*color3: #A8A800
410 URxvt*color4: #0000A8
411 URxvt*color5: #A800A8
412 URxvt*color6: #00A8A8
413 URxvt*color7: #A8A8A8
414 1053
415 URxvt*color8: #000054 1054 How can I use rxvt-unicode under cygwin?
416 URxvt*color9: #FF0054 1055 rxvt-unicode should compile and run out of the box on cygwin, using the
417 URxvt*color10: #00FF54 1056 X11 libraries that come with cygwin. libW11 emulation is no longer
418 URxvt*color11: #FFFF54 1057 supported (and makes no sense, either, as it only supported a single
419 URxvt*color12: #0000FF 1058 font). I recommend starting the X-server in "-multiwindow" or
420 URxvt*color13: #FF00FF 1059 "-rootless" mode instead, which will result in similar look&feel as the
421 URxvt*color14: #00FFFF 1060 old libW11 emulation.
422 URxvt*color15: #FFFFFF
423 1061
424 And here is a more complete set of non-standard colors described as 1062 At the time of this writing, cygwin didn't seem to support any
425 "pretty girly": 1063 multi-byte encodings (you might try "LC_CTYPE=C-UTF-8"), so you are
1064 likely limited to 8-bit encodings.
426 1065
427 URxvt.cursorColor: #dc74d1 1066 Character widths are not correct.
428 URxvt.pointerColor: #dc74d1 1067 urxvt uses the system wcwidth function to know the information about the
429 URxvt.background: #0e0e0e 1068 width of characters, so on systems with incorrect locale data you will
430 URxvt.foreground: #4ad5e1 1069 likely get bad results. Two notorious examples are Solaris 9, where
431 URxvt.color0: #000000 1070 single-width characters like U+2514 are reported as double-width, and
432 URxvt.color8: #8b8f93 1071 Darwin 8, where combining chars are reported having width 1.
433 URxvt.color1: #dc74d1
434 URxvt.color9: #dc74d1
435 URxvt.color2: #0eb8c7
436 URxvt.color10: #0eb8c7
437 URxvt.color3: #dfe37e
438 URxvt.color11: #dfe37e
439 URxvt.color5: #9e88f0
440 URxvt.color13: #9e88f0
441 URxvt.color6: #73f7ff
442 URxvt.color14: #73f7ff
443 URxvt.color7: #e1dddd
444 URxvt.color15: #e1dddd
445 1072
446 What's with the strange Backspace/Delete key behaviour? 1073 The solution is to upgrade your system or switch to a better one. A
447 Assuming that the physical Backspace key corresponds to the 1074 possibly working workaround is to use a wcwidth implementation like
448 BackSpace keysym (not likely for Linux ... see the following
449 question) there are two standard values that can be used for
450 Backspace: "^H" and "^?".
451 1075
452 Historically, either value is correct, but rxvt-unicode adopts the 1076 http://www.cl.cam.ac.uk/~mgk25/ucs/wcwidth.c
453 debian policy of using "^?" when unsure, because it's the one only
454 only correct choice :).
455 1077
456 Rxvt-unicode tries to inherit the current stty settings and uses the
457 value of `erase' to guess the value for backspace. If rxvt-unicode
458 wasn't started from a terminal (say, from a menu or by remote
459 shell), then the system value of `erase', which corresponds to
460 CERASE in <termios.h>, will be used (which may not be the same as
461 your stty setting).
462
463 For starting a new rxvt-unicode:
464
465 # use Backspace = ^H
466 $ stty erase ^H
467 $ rxvt
468
469 # use Backspace = ^?
470 $ stty erase ^?
471 $ rxvt
472
473 Toggle with "ESC[36h" / "ESC[36l" as documented in rxvt(7).
474
475 For an existing rxvt-unicode:
476
477 # use Backspace = ^H
478 $ stty erase ^H
479 $ echo -n "^[[36h"
480
481 # use Backspace = ^?
482 $ stty erase ^?
483 $ echo -n "^[[36l"
484
485 This helps satisfy some of the Backspace discrepancies that occur,
486 but if you use Backspace = "^H", make sure that the termcap/terminfo
487 value properly reflects that.
488
489 The Delete key is a another casualty of the ill-defined Backspace
490 problem. To avoid confusion between the Backspace and Delete keys,
491 the Delete key has been assigned an escape sequence to match the
492 vt100 for Execute (ESC[3~) and is in the supplied termcap/terminfo.
493
494 Some other Backspace problems:
495
496 some editors use termcap/terminfo, some editors (vim I'm told)
497 expect Backspace = ^H, GNU Emacs (and Emacs-like editors) use ^H for
498 help.
499
500 Perhaps someday this will all be resolved in a consistent manner.
501
502 I don't like the key-bindings. How do I change them?
503 There are some compile-time selections available via configure.
504 Unless you have run "configure" with the "--disable-resources"
505 option you can use the `keysym' resource to alter the keystrings
506 associated with keysyms.
507
508 Here's an example for a URxvt session started using `rxvt -name
509 URxvt'
510
511 URxvt*keysym.Home: \e[1~
512 URxvt*keysym.End: \e[4~
513 URxvt*keysym.C-apostrophe: \e<C-'>
514 URxvt*keysym.C-slash: \e<C-/>
515 URxvt*keysym.C-semicolon: \e<C-;>
516 URxvt*keysym.C-grave: \e<C-`>
517 URxvt*keysym.C-comma: \e<C-,>
518 URxvt*keysym.C-period: \e<C-.>
519 URxvt*keysym.C-0x60: \e<C-`>
520 URxvt*keysym.C-Tab: \e<C-Tab>
521 URxvt*keysym.C-Return: \e<C-Return>
522 URxvt*keysym.S-Return: \e<S-Return>
523 URxvt*keysym.S-space: \e<S-Space>
524 URxvt*keysym.M-Up: \e<M-Up>
525 URxvt*keysym.M-Down: \e<M-Down>
526 URxvt*keysym.M-Left: \e<M-Left>
527 URxvt*keysym.M-Right: \e<M-Right>
528 URxvt*keysym.M-C-0: list.0123456789.\e<M-C-.>
529 URxvt*keysym.M-C-a: list.abcdefghijklmnopqrstuvwxyz.\033<M-C-.>
530 URxvt*keysym.F12: proto:\033]701;zh_CN.GBK\007
531
532 I'm using keyboard model XXX that has extra Prior/Next/Insert keys. How
533 do I make use of them? For example, the Sun Keyboard type 4 has the
534 following mappings that rxvt-unicode doesn't recognize.
535 KP_Insert == Insert
536 F22 == Print
537 F27 == Home
538 F29 == Prior
539 F33 == End
540 F35 == Next
541
542 Rather than have rxvt-unicode try to accommodate all the various
543 possible keyboard mappings, it is better to use `xmodmap' to remap
544 the keys as required for your particular machine.
545
546 How do I distinguish if I'm running rxvt-unicode or a regular xterm? I
547 need this to decide about setting colors etc.
548 rxvt and rxvt-unicode always export the variable "COLORTERM", so you
549 can check and see if that is set. Note that several programs, JED,
550 slrn, Midnight Commander automatically check this variable to decide
551 whether or not to use color.
552
553 How do I set the correct, full IP address for the DISPLAY variable?
554 If you've compiled rxvt-unicode with DISPLAY_IS_IP and have enabled
555 insecure mode then it is possible to use the following shell script
556 snippets to correctly set the display. If your version of
557 rxvt-unicode wasn't also compiled with ESCZ_ANSWER (as assumed in
558 these snippets) then the COLORTERM variable can be used to
559 distinguish rxvt-unicode from a regular xterm.
560
561 Courtesy of Chuck Blake <cblake@BBN.COM> with the following shell
562 script snippets:
563
564 # Bourne/Korn/POSIX family of shells:
565 [ ${TERM:-foo} = foo ] && TERM=xterm # assume an xterm if we don't know
566 if [ ${TERM:-foo} = xterm ]; then
567 stty -icanon -echo min 0 time 15 # see if enhanced rxvt or not
568 echo -n '^[Z'
569 read term_id
570 stty icanon echo
571 if [ ""${term_id} = '^[[?1;2C' -a ${DISPLAY:-foo} = foo ]; then
572 echo -n '^[[7n' # query the rxvt we are in for the DISPLAY string
573 read DISPLAY # set it in our local shell
574 fi
575 fi
576
577 How do I compile the manual pages for myself?
578 You need to have a recent version of perl installed as
579 /usr/bin/perl, one that comes with pod2man, pod2text and pod2html.
580 Then go to the doc subdirectory and enter "make alldoc".
581
582 My question isn't answered here, can I ask a human?
583 Before sending me mail, you could go to IRC: "irc.freenode.net",
584 channel "#rxvt-unicode" has some rxvt-unicode enthusiasts that might
585 be interested in learning about new and exciting problems (but not
586 FAQs :).
587

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines