ViewVC Help
View File | Revision Log | Show Annotations | Download File
/cvs/rxvt-unicode/doc/rxvt.7.txt
Revision: 1.70
Committed: Tue Feb 21 01:00:40 2006 UTC (18 years, 5 months ago) by root
Content type: text/plain
Branch: MAIN
Changes since 1.69: +153 -0 lines
Log Message:
*** empty log message ***

File Contents

# Content
1 NAME
2 RXVT REFERENCE - FAQ, command sequences and other background information
3
4 SYNOPSIS
5 # set a new font set
6 printf '\33]50;%s\007' 9x15,xft:Kochi" Mincho"
7
8 # change the locale and tell rxvt-unicode about it
9 export LC_CTYPE=ja_JP.EUC-JP; printf "\33]701;$LC_CTYPE\007"
10
11 # set window title
12 printf '\33]2;%s\007' "new window title"
13
14 DESCRIPTION
15 This document contains the FAQ, the RXVT TECHNICAL REFERENCE documenting
16 all escape sequences, and other background information.
17
18 The newest version of this document is also available on the World Wide
19 Web at
20 <http://cvs.schmorp.de/browse/*checkout*/rxvt-unicode/doc/rxvt.7.html>.
21
22 RXVT-UNICODE/URXVT FREQUENTLY ASKED QUESTIONS
23 Meta, Features & Commandline Issues
24 My question isn't answered here, can I ask a human?
25 Before sending me mail, you could go to IRC: "irc.freenode.net", channel
26 "#rxvt-unicode" has some rxvt-unicode enthusiasts that might be
27 interested in learning about new and exciting problems (but not FAQs :).
28
29 Does it support tabs, can I have a tabbed rxvt-unicode?
30 Beginning with version 7.3, there is a perl extension that implements a
31 simple tabbed terminal. It is installed by default, so any of these
32 should give you tabs:
33
34 urxvt -pe tabbed
35
36 URxvt.perl-ext-common: default,tabbed
37
38 It will also work fine with tabbing functionality of many window
39 managers or similar tabbing programs, and its embedding-features allow
40 it to be embedded into other programs, as witnessed by doc/rxvt-tabbed
41 or the upcoming "Gtk2::URxvt" perl module, which features a tabbed urxvt
42 (murxvt) terminal as an example embedding application.
43
44 How do I know which rxvt-unicode version I'm using?
45 The version number is displayed with the usage (-h). Also the escape
46 sequence "ESC [ 8 n" sets the window title to the version number. When
47 using the urxvtc client, the version displayed is that of the daemon.
48
49 Rxvt-unicode uses gobs of memory, how can I reduce that?
50 Rxvt-unicode tries to obey the rule of not charging you for something
51 you don't use. One thing you should try is to configure out all settings
52 that you don't need, for example, Xft support is a resource hog by
53 design, when used. Compiling it out ensures that no Xft font will be
54 loaded accidentally when rxvt-unicode tries to find a font for your
55 characters.
56
57 Also, many people (me included) like large windows and even larger
58 scrollback buffers: Without "--enable-unicode3", rxvt-unicode will use 6
59 bytes per screen cell. For a 160x?? window this amounts to almost a
60 kilobyte per line. A scrollback buffer of 10000 lines will then (if
61 full) use 10 Megabytes of memory. With "--enable-unicode3" it gets
62 worse, as rxvt-unicode then uses 8 bytes per screen cell.
63
64 How can I start urxvtd in a race-free way?
65 Try "urxvtd -f -o", which tells urxvtd to open the display, create the
66 listening socket and then fork.
67
68 How can I start urxvtd automatically when I run URXVT_NAME@@c?
69 If you want to start urxvtd automatically whenever you run urxvtc and
70 the daemon isn't running yet, use this script:
71
72 #!/bin/sh
73 urxvtc "$@"
74 if [ $? -eq 2 ]; then
75 urxvtd -q -o -f
76 urxvtc "$@"
77 fi
78
79 This tries to create a new terminal, and if fails with exit status 2,
80 meaning it couldn't connect to the daemon, it will start the daemon and
81 re-run the command. Subsequent invocations of the script will re-use the
82 existing daemon.
83
84 How do I distinguish wether I'm running rxvt-unicode or a regular xterm? I need this to decide about setting colors etc.
85 The original rxvt and rxvt-unicode always export the variable
86 "COLORTERM", so you can check and see if that is set. Note that several
87 programs, JED, slrn, Midnight Commander automatically check this
88 variable to decide whether or not to use color.
89
90 How do I set the correct, full IP address for the DISPLAY variable?
91 If you've compiled rxvt-unicode with DISPLAY_IS_IP and have enabled
92 insecure mode then it is possible to use the following shell script
93 snippets to correctly set the display. If your version of rxvt-unicode
94 wasn't also compiled with ESCZ_ANSWER (as assumed in these snippets)
95 then the COLORTERM variable can be used to distinguish rxvt-unicode from
96 a regular xterm.
97
98 Courtesy of Chuck Blake <cblake@BBN.COM> with the following shell script
99 snippets:
100
101 # Bourne/Korn/POSIX family of shells:
102 [ ${TERM:-foo} = foo ] && TERM=xterm # assume an xterm if we don't know
103 if [ ${TERM:-foo} = xterm ]; then
104 stty -icanon -echo min 0 time 15 # see if enhanced rxvt or not
105 echo -n '^[Z'
106 read term_id
107 stty icanon echo
108 if [ ""${term_id} = '^[[?1;2C' -a ${DISPLAY:-foo} = foo ]; then
109 echo -n '^[[7n' # query the rxvt we are in for the DISPLAY string
110 read DISPLAY # set it in our local shell
111 fi
112 fi
113
114 How do I compile the manual pages on my own?
115 You need to have a recent version of perl installed as /usr/bin/perl,
116 one that comes with pod2man, pod2text and pod2html. Then go to the doc
117 subdirectory and enter "make alldoc".
118
119 Isn't rxvt-unicode supposed to be small? Don't all those features bloat?
120 I often get asked about this, and I think, no, they didn't cause extra
121 bloat. If you compare a minimal rxvt and a minimal urxvt, you can see
122 that the urxvt binary is larger (due to some encoding tables always
123 being compiled in), but it actually uses less memory (RSS) after
124 startup. Even with "--disable-everything", this comparison is a bit
125 unfair, as many features unique to urxvt (locale, encoding conversion,
126 iso14755 etc.) are already in use in this mode.
127
128 text data bss drs rss filename
129 98398 1664 24 15695 1824 rxvt --disable-everything
130 188985 9048 66616 18222 1788 urxvt --disable-everything
131
132 When you "--enable-everything" (which *is* unfair, as this involves xft
133 and full locale/XIM support which are quite bloaty inside libX11 and my
134 libc), the two diverge, but not unreasnobaly so.
135
136 text data bss drs rss filename
137 163431 2152 24 20123 2060 rxvt --enable-everything
138 1035683 49680 66648 29096 3680 urxvt --enable-everything
139
140 The very large size of the text section is explained by the east-asian
141 encoding tables, which, if unused, take up disk space but nothing else
142 and can be compiled out unless you rely on X11 core fonts that use those
143 encodings. The BSS size comes from the 64k emergency buffer that my c++
144 compiler allocates (but of course doesn't use unless you are out of
145 memory). Also, using an xft font instead of a core font immediately adds
146 a few megabytes of RSS. Xft indeed is responsible for a lot of RSS even
147 when not used.
148
149 Of course, due to every character using two or four bytes instead of
150 one, a large scrollback buffer will ultimately make rxvt-unicode use
151 more memory.
152
153 Compared to e.g. Eterm (5112k), aterm (3132k) and xterm (4680k), this
154 still fares rather well. And compared to some monsters like
155 gnome-terminal (21152k + extra 4204k in separate processes) or konsole
156 (22200k + extra 43180k in daemons that stay around after exit, plus half
157 a minute of startup time, including the hundreds of warnings it spits
158 out), it fares extremely well *g*.
159
160 Why C++, isn't that unportable/bloated/uncool?
161 Is this a question? :) It comes up very often. The simple answer is: I
162 had to write it, and C++ allowed me to write and maintain it in a
163 fraction of the time and effort (which is a scarce resource for me). Put
164 even shorter: It simply wouldn't exist without C++.
165
166 My personal stance on this is that C++ is less portable than C, but in
167 the case of rxvt-unicode this hardly matters, as its portability limits
168 are defined by things like X11, pseudo terminals, locale support and
169 unix domain sockets, which are all less portable than C++ itself.
170
171 Regarding the bloat, see the above question: It's easy to write programs
172 in C that use gobs of memory, an certainly possible to write programs in
173 C++ that don't. C++ also often comes with large libraries, but this is
174 not necessarily the case with GCC. Here is what rxvt links against on my
175 system with a minimal config:
176
177 libX11.so.6 => /usr/X11R6/lib/libX11.so.6 (0x00002aaaaabc3000)
178 libc.so.6 => /lib/libc.so.6 (0x00002aaaaadde000)
179 libdl.so.2 => /lib/libdl.so.2 (0x00002aaaab01d000)
180 /lib64/ld-linux-x86-64.so.2 (0x00002aaaaaaab000)
181
182 And here is rxvt-unicode:
183
184 libX11.so.6 => /usr/X11R6/lib/libX11.so.6 (0x00002aaaaabc3000)
185 libgcc_s.so.1 => /lib/libgcc_s.so.1 (0x00002aaaaada2000)
186 libc.so.6 => /lib/libc.so.6 (0x00002aaaaaeb0000)
187 libdl.so.2 => /lib/libdl.so.2 (0x00002aaaab0ee000)
188 /lib64/ld-linux-x86-64.so.2 (0x00002aaaaaaab000)
189
190 No large bloated libraries (of course, none were linked in statically),
191 except maybe libX11 :)
192
193 Rendering, Font & Look and Feel Issues
194 I can't get transparency working, what am I doing wrong?
195 First of all, transparency isn't officially supported in rxvt-unicode,
196 so you are mostly on your own. Do not bug the author about it (but you
197 may bug everybody else). Also, if you can't get it working consider it a
198 rite of passage: ... and you failed.
199
200 Here are four ways to get transparency. Do read the manpage and option
201 descriptions for the programs mentioned and rxvt-unicode. Really, do it!
202
203 1. Use inheritPixmap:
204
205 Esetroot wallpaper.jpg
206 urxvt -ip -tint red -sh 40
207
208 That works. If you think it doesn't, you lack transparency and tinting
209 support, or you are unable to read.
210
211 2. Use a simple pixmap and emulate pseudo-transparency. This enables you
212 to use effects other than tinting and shading: Just shade/tint/whatever
213 your picture with gimp or any other tool:
214
215 convert wallpaper.jpg -blur 20x20 -modulate 30 background.xpm
216 urxvt -pixmap background.xpm -pe automove-background
217
218 That works. If you think it doesn't, you lack XPM and Perl support, or
219 you are unable to read.
220
221 3. Use an ARGB visual:
222
223 urxvt -depth 32 -fg grey90 -bg rgba:0000/0000/4444/cccc
224
225 This requires XFT support, and the support of your X-server. If that
226 doesn't work for you, blame Xorg and Keith Packard. ARGB visuals aren't
227 there yet, no matter what they claim. Rxvt-Unicode contains the
228 neccessary bugfixes and workarounds for Xft and Xlib to make it work,
229 but that doesn't mean that your WM has the required kludges in place.
230
231 4. Use xcompmgr and let it do the job:
232
233 xprop -frame -f _NET_WM_WINDOW_OPACITY 32c \
234 -set _NET_WM_WINDOW_OPACITY 0xc0000000
235
236 Then click on a window you want to make transparent. Replace 0xc0000000
237 by other values to change the degree of opacity. If it doesn't work and
238 your server crashes, you got to keep the pieces.
239
240 Why does rxvt-unicode sometimes leave pixel droppings?
241 Most fonts were not designed for terminal use, which means that
242 character size varies a lot. A font that is otherwise fine for terminal
243 use might contain some characters that are simply too wide. Rxvt-unicode
244 will avoid these characters. For characters that are just "a bit" too
245 wide a special "careful" rendering mode is used that redraws adjacent
246 characters.
247
248 All of this requires that fonts do not lie about character sizes,
249 however: Xft fonts often draw glyphs larger than their acclaimed
250 bounding box, and rxvt-unicode has no way of detecting this (the correct
251 way is to ask for the character bounding box, which unfortunately is
252 wrong in these cases).
253
254 It's not clear (to me at least), wether this is a bug in Xft, freetype,
255 or the respective font. If you encounter this problem you might try
256 using the "-lsp" option to give the font more height. If that doesn't
257 work, you might be forced to use a different font.
258
259 All of this is not a problem when using X11 core fonts, as their
260 bounding box data is correct.
261
262 How can I keep rxvt-unicode from using reverse video so much?
263 First of all, make sure you are running with the right terminal settings
264 ("TERM=rxvt-unicode"), which will get rid of most of these effects. Then
265 make sure you have specified colours for italic and bold, as otherwise
266 rxvt-unicode might use reverse video to simulate the effect:
267
268 URxvt.colorBD: white
269 URxvt.colorIT: green
270
271 Some programs assume totally weird colours (red instead of blue), how can I fix that?
272 For some unexplainable reason, some rare programs assume a very weird
273 colour palette when confronted with a terminal with more than the
274 standard 8 colours (rxvt-unicode supports 88). The right fix is, of
275 course, to fix these programs not to assume non-ISO colours without very
276 good reasons.
277
278 In the meantime, you can either edit your "rxvt-unicode" terminfo
279 definition to only claim 8 colour support or use "TERM=rxvt", which will
280 fix colours but keep you from using other rxvt-unicode features.
281
282 Can I switch the fonts at runtime?
283 Yes, using an escape sequence. Try something like this, which has the
284 same effect as using the "-fn" switch, and takes effect immediately:
285
286 printf '\e]50;%s\007' "9x15bold,xft:Kochi Gothic"
287
288 This is useful if you e.g. work primarily with japanese (and prefer a
289 japanese font), but you have to switch to chinese temporarily, where
290 japanese fonts would only be in your way.
291
292 You can think of this as a kind of manual ISO-2022 switching.
293
294 Why do italic characters look as if clipped?
295 Many fonts have difficulties with italic characters and hinting. For
296 example, the otherwise very nicely hinted font "xft:Bitstream Vera Sans
297 Mono" completely fails in it's italic face. A workaround might be to
298 enable freetype autohinting, i.e. like this:
299
300 URxvt.italicFont: xft:Bitstream Vera Sans Mono:italic:autohint=true
301 URxvt.boldItalicFont: xft:Bitstream Vera Sans Mono:bold:italic:autohint=true
302
303 Can I speed up Xft rendering somehow?
304 Yes, the most obvious way to speed it up is to avoid Xft entirely, as it
305 is simply slow. If you still want Xft fonts you might try to disable
306 antialiasing (by appending ":antialias=false"), which saves lots of
307 memory and also speeds up rendering considerably.
308
309 Rxvt-unicode doesn't seem to anti-alias its fonts, what is wrong?
310 Rxvt-unicode will use whatever you specify as a font. If it needs to
311 fall back to it's default font search list it will prefer X11 core
312 fonts, because they are small and fast, and then use Xft fonts. It has
313 antialiasing disabled for most of them, because the author thinks they
314 look best that way.
315
316 If you want antialiasing, you have to specify the fonts manually.
317
318 What's with this bold/blink stuff?
319 If no bold colour is set via "colorBD:", bold will invert text using the
320 standard foreground colour.
321
322 For the standard background colour, blinking will actually make the text
323 blink when compiled with "--enable-blinking". with standard colours.
324 Without "--enable-blinking", the blink attribute will be ignored.
325
326 On ANSI colours, bold/blink attributes are used to set high-intensity
327 foreground/background colors.
328
329 color0-7 are the low-intensity colors.
330
331 color8-15 are the corresponding high-intensity colors.
332
333 I don't like the screen colors. How do I change them?
334 You can change the screen colors at run-time using ~/.Xdefaults
335 resources (or as long-options).
336
337 Here are values that are supposed to resemble a VGA screen, including
338 the murky brown that passes for low-intensity yellow:
339
340 URxvt.color0: #000000
341 URxvt.color1: #A80000
342 URxvt.color2: #00A800
343 URxvt.color3: #A8A800
344 URxvt.color4: #0000A8
345 URxvt.color5: #A800A8
346 URxvt.color6: #00A8A8
347 URxvt.color7: #A8A8A8
348
349 URxvt.color8: #000054
350 URxvt.color9: #FF0054
351 URxvt.color10: #00FF54
352 URxvt.color11: #FFFF54
353 URxvt.color12: #0000FF
354 URxvt.color13: #FF00FF
355 URxvt.color14: #00FFFF
356 URxvt.color15: #FFFFFF
357
358 And here is a more complete set of non-standard colors.
359
360 URxvt.cursorColor: #dc74d1
361 URxvt.pointerColor: #dc74d1
362 URxvt.background: #0e0e0e
363 URxvt.foreground: #4ad5e1
364 URxvt.color0: #000000
365 URxvt.color8: #8b8f93
366 URxvt.color1: #dc74d1
367 URxvt.color9: #dc74d1
368 URxvt.color2: #0eb8c7
369 URxvt.color10: #0eb8c7
370 URxvt.color3: #dfe37e
371 URxvt.color11: #dfe37e
372 URxvt.color5: #9e88f0
373 URxvt.color13: #9e88f0
374 URxvt.color6: #73f7ff
375 URxvt.color14: #73f7ff
376 URxvt.color7: #e1dddd
377 URxvt.color15: #e1dddd
378
379 They have been described (not by me) as "pretty girly".
380
381 Why do some characters look so much different than others?
382 See next entry.
383
384 How does rxvt-unicode choose fonts?
385 Most fonts do not contain the full range of Unicode, which is fine.
386 Chances are that the font you (or the admin/package maintainer of your
387 system/os) have specified does not cover all the characters you want to
388 display.
389
390 rxvt-unicode makes a best-effort try at finding a replacement font.
391 Often the result is fine, but sometimes the chosen font looks
392 bad/ugly/wrong. Some fonts have totally strange characters that don't
393 resemble the correct glyph at all, and rxvt-unicode lacks the artificial
394 intelligence to detect that a specific glyph is wrong: it has to believe
395 the font that the characters it claims to contain indeed look correct.
396
397 In that case, select a font of your taste and add it to the font list,
398 e.g.:
399
400 urxvt -fn basefont,font2,font3...
401
402 When rxvt-unicode sees a character, it will first look at the base font.
403 If the base font does not contain the character, it will go to the next
404 font, and so on. Specifying your own fonts will also speed up this
405 search and use less resources within rxvt-unicode and the X-server.
406
407 The only limitation is that none of the fonts may be larger than the
408 base font, as the base font defines the terminal character cell size,
409 which must be the same due to the way terminals work.
410
411 Why do some chinese characters look so different than others?
412 This is because there is a difference between script and language --
413 rxvt-unicode does not know which language the text that is output is, as
414 it only knows the unicode character codes. If rxvt-unicode first sees a
415 japanese/chinese character, it might choose a japanese font for display.
416 Subsequent japanese characters will use that font. Now, many chinese
417 characters aren't represented in japanese fonts, so when the first
418 non-japanese character comes up, rxvt-unicode will look for a chinese
419 font -- unfortunately at this point, it will still use the japanese font
420 for chinese characters that are also in the japanese font.
421
422 The workaround is easy: just tag a chinese font at the end of your font
423 list (see the previous question). The key is to view the font list as a
424 preference list: If you expect more japanese, list a japanese font
425 first. If you expect more chinese, put a chinese font first.
426
427 In the future it might be possible to switch language preferences at
428 runtime (the internal data structure has no problem with using different
429 fonts for the same character at the same time, but no interface for this
430 has been designed yet).
431
432 Until then, you might get away with switching fonts at runtime (see "Can
433 I switch the fonts at runtime?" later in this document).
434
435 Keyboard, Mouse & User Interaction
436 The new selection selects pieces that are too big, how can I select single words?
437 If you want to select e.g. alphanumeric words, you can use the following
438 setting:
439
440 URxvt.selection.pattern-0: ([[:word:]]+)
441
442 If you click more than twice, the selection will be extended more and
443 more.
444
445 To get a selection that is very similar to the old code, try this
446 pattern:
447
448 URxvt.selection.pattern-0: ([^"&'()*,;<=>?@[\\\\]^`{|})]+)
449
450 Please also note that the *LeftClick Shift-LeftClik* combination also
451 selects words like the old code.
452
453 I don't like the new selection/popups/hotkeys/perl, how do I change/disable it?
454 You can disable the perl extension completely by setting the
455 perl-ext-common resource to the empty string, which also keeps
456 rxvt-unicode from initialising perl, saving memory.
457
458 If you only want to disable specific features, you first have to
459 identify which perl extension is responsible. For this, read the section
460 PREPACKAGED EXTENSIONS in the urxvtperl(3) manpage. For example, to
461 disable the selection-popup and option-popup, specify this
462 perl-ext-common resource:
463
464 URxvt.perl-ext-common: default,-selection-popup,-option-popup
465
466 This will keep the default extensions, but disable the two popup
467 extensions. Some extensions can also be configured, for example,
468 scrollback search mode is triggered by M-s. You can move it to any other
469 combination either by setting the searchable-scrollback resource:
470
471 URxvt.searchable-scrollback: CM-s
472
473 The cursor moves when selecting text in the current input line, how do I switch this off?
474 See next entry.
475
476 During rlogin/ssh/telnet/etc. sessions, clicking near the cursor outputs strange escape sequences, how do I fix this?
477 These are caused by the "readline" perl extension. Under normal
478 circumstances, it will move your cursor around when you click into the
479 line that contains it. It tries hard not to do this at the wrong moment,
480 but when running a program that doesn't parse cursor movements or in
481 some cases during rlogin sessions, it fails to detect this properly.
482
483 You can permamently switch this feature off by disabling the "readline"
484 extension:
485
486 URxvt.perl-ext-common: default,-readline
487
488 My numerical keypad acts weird and generates differing output?
489 Some Debian GNUL/Linux users seem to have this problem, although no
490 specific details were reported so far. It is possible that this is
491 caused by the wrong "TERM" setting, although the details of wether and
492 how this can happen are unknown, as "TERM=rxvt" should offer a
493 compatible keymap. See the answer to the previous question, and please
494 report if that helped.
495
496 My Compose (Multi_key) key is no longer working.
497 The most common causes for this are that either your locale is not set
498 correctly, or you specified a preeditStyle that is not supported by your
499 input method. For example, if you specified OverTheSpot and your input
500 method (e.g. the default input method handling Compose keys) does not
501 support this (for instance because it is not visual), then rxvt-unicode
502 will continue without an input method.
503
504 In this case either do not specify a preeditStyle or specify more than
505 one pre-edit style, such as OverTheSpot,Root,None.
506
507 I cannot type "Ctrl-Shift-2" to get an ASCII NUL character due to ISO 14755
508 Either try "Ctrl-2" alone (it often is mapped to ASCII NUL even on
509 international keyboards) or simply use ISO 14755 support to your
510 advantage, typing <Ctrl-Shift-0> to get a ASCII NUL. This works for
511 other codes, too, such as "Ctrl-Shift-1-d" to type the default telnet
512 escape character and so on.
513
514 Mouse cut/paste suddenly no longer works.
515 Make sure that mouse reporting is actually turned off since killing some
516 editors prematurely may leave the mouse in mouse report mode. I've heard
517 that tcsh may use mouse reporting unless it otherwise specified. A quick
518 check is to see if cut/paste works when the Alt or Shift keys are
519 depressed.
520
521 What's with the strange Backspace/Delete key behaviour?
522 Assuming that the physical Backspace key corresponds to the BackSpace
523 keysym (not likely for Linux ... see the following question) there are
524 two standard values that can be used for Backspace: "^H" and "^?".
525
526 Historically, either value is correct, but rxvt-unicode adopts the
527 debian policy of using "^?" when unsure, because it's the one only only
528 correct choice :).
529
530 Rxvt-unicode tries to inherit the current stty settings and uses the
531 value of `erase' to guess the value for backspace. If rxvt-unicode
532 wasn't started from a terminal (say, from a menu or by remote shell),
533 then the system value of `erase', which corresponds to CERASE in
534 <termios.h>, will be used (which may not be the same as your stty
535 setting).
536
537 For starting a new rxvt-unicode:
538
539 # use Backspace = ^H
540 $ stty erase ^H
541 $ urxvt
542
543 # use Backspace = ^?
544 $ stty erase ^?
545 $ urxvt
546
547 Toggle with "ESC [ 36 h" / "ESC [ 36 l".
548
549 For an existing rxvt-unicode:
550
551 # use Backspace = ^H
552 $ stty erase ^H
553 $ echo -n "^[[36h"
554
555 # use Backspace = ^?
556 $ stty erase ^?
557 $ echo -n "^[[36l"
558
559 This helps satisfy some of the Backspace discrepancies that occur, but
560 if you use Backspace = "^H", make sure that the termcap/terminfo value
561 properly reflects that.
562
563 The Delete key is a another casualty of the ill-defined Backspace
564 problem. To avoid confusion between the Backspace and Delete keys, the
565 Delete key has been assigned an escape sequence to match the vt100 for
566 Execute ("ESC [ 3 ~") and is in the supplied termcap/terminfo.
567
568 Some other Backspace problems:
569
570 some editors use termcap/terminfo, some editors (vim I'm told) expect
571 Backspace = ^H, GNU Emacs (and Emacs-like editors) use ^H for help.
572
573 Perhaps someday this will all be resolved in a consistent manner.
574
575 I don't like the key-bindings. How do I change them?
576 There are some compile-time selections available via configure. Unless
577 you have run "configure" with the "--disable-resources" option you can
578 use the `keysym' resource to alter the keystrings associated with
579 keysyms.
580
581 Here's an example for a URxvt session started using "urxvt -name URxvt"
582
583 URxvt.keysym.Home: \033[1~
584 URxvt.keysym.End: \033[4~
585 URxvt.keysym.C-apostrophe: \033<C-'>
586 URxvt.keysym.C-slash: \033<C-/>
587 URxvt.keysym.C-semicolon: \033<C-;>
588 URxvt.keysym.C-grave: \033<C-`>
589 URxvt.keysym.C-comma: \033<C-,>
590 URxvt.keysym.C-period: \033<C-.>
591 URxvt.keysym.C-0x60: \033<C-`>
592 URxvt.keysym.C-Tab: \033<C-Tab>
593 URxvt.keysym.C-Return: \033<C-Return>
594 URxvt.keysym.S-Return: \033<S-Return>
595 URxvt.keysym.S-space: \033<S-Space>
596 URxvt.keysym.M-Up: \033<M-Up>
597 URxvt.keysym.M-Down: \033<M-Down>
598 URxvt.keysym.M-Left: \033<M-Left>
599 URxvt.keysym.M-Right: \033<M-Right>
600 URxvt.keysym.M-C-0: list \033<M-C- 0123456789 >
601 URxvt.keysym.M-C-a: list \033<M-C- abcdefghijklmnopqrstuvwxyz >
602 URxvt.keysym.F12: command:\033]701;zh_CN.GBK\007
603
604 See some more examples in the documentation for the keysym resource.
605
606 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
607 KP_Insert == Insert
608 F22 == Print
609 F27 == Home
610 F29 == Prior
611 F33 == End
612 F35 == Next
613
614 Rather than have rxvt-unicode try to accommodate all the various
615 possible keyboard mappings, it is better to use `xmodmap' to remap the
616 keys as required for your particular machine.
617
618 Terminal Configuration
619 Can I see a typical configuration?
620 The default configuration tries to be xterm-like, which I don't like
621 that much, but it's least surprise to regular users.
622
623 As a rxvt or rxvt-unicode user, you are practically supposed to invest
624 time into customising your terminal. To get you started, here is the
625 author's .Xdefaults entries, with comments on what they do:
626
627 URxvt.cutchars: "()*,<>[]{}|'
628 URxvt.print-pipe: cat >/tmp/xxx
629
630 These are just for testing stuff.
631
632 URxvt.imLocale: ja_JP.UTF-8
633 URxvt.preeditType: OnTheSpot,None
634
635 This tells rxvt-unicode to use a special locale when communicating with
636 the X Input Method, and also tells it to only use the OnTheSpot pre-edit
637 type, which requires the "xim-onthespot" perl extension but rewards me
638 with correct-looking fonts.
639
640 URxvt.perl-lib: /root/lib/urxvt
641 URxvt.perl-ext-common: default,selection-autotransform,selection-pastebin,xim-onthespot,remote-clipboard
642 URxvt.selection.pattern-0: ( at .*? line \\d+)
643 URxvt.selection.pattern-1: ^(/[^:]+):\
644 URxvt.selection-autotransform.0: s/^([^:[:space:]]+):(\\d+):?$/:e \\Q$1\\E\\x0d:$2\\x0d/
645 URxvt.selection-autotransform.1: s/^ at (.*?) line (\\d+)$/:e \\Q$1\\E\\x0d:$2\\x0d/
646
647 This is my perl configuration. The first two set the perl library
648 directory and also tells urxvt to use a large number of extensions. I
649 develop for myself mostly, so I actually use most of the extensions I
650 write.
651
652 The selection stuff mainly makes the selection perl-error-message aware
653 and tells it to convert pelr error mssages into vi-commands to load the
654 relevant file and go tot he error line number.
655
656 URxvt.scrollstyle: plain
657 URxvt.secondaryScroll: true
658
659 As the documentation says: plain is the preferred scrollbar for the
660 author. The "secondaryScroll" confgiures urxvt to scroll in full-screen
661 apps, like screen, so lines scorlled out of screen end up in urxvt's
662 scrollback buffer.
663
664 URxvt.background: #000000
665 URxvt.foreground: gray90
666 URxvt.color7: gray90
667 URxvt.colorBD: #ffffff
668 URxvt.cursorColor: #e0e080
669 URxvt.throughColor: #8080f0
670 URxvt.highlightColor: #f0f0f0
671
672 Some colours. Not sure which ones are being used or even non-defaults,
673 but these are in my .Xdefaults. Most notably, they set
674 foreground/background to light gray/black, and also make sure that the
675 colour 7 matches the default foreground colour.
676
677 URxvt.underlineColor: yellow
678
679 Another colour, makes underline lines look different. Sometimes hurts,
680 but is mostly a nice effect.
681
682 URxvt.geometry: 154x36
683 URxvt.loginShell: false
684 URxvt.meta: ignore
685 URxvt.utmpInhibit: true
686
687 Uh, well, should be mostly self-explanatory. By specifying some defaults
688 manually, I can quickly switch them for testing.
689
690 URxvt.saveLines: 8192
691
692 A large scrollback buffer is essential. Really.
693
694 URxvt.mapAlert: true
695
696 The only case I use it is for my IRC window, which I like to keep
697 iconified till people msg me (which beeps).
698
699 URxvt.visualBell: true
700
701 The audible bell is often annoying, especially when in a crowd.
702
703 URxvt.insecure: true
704
705 Please don't hack my mutt! Ooops...
706
707 URxvt.pastableTabs: false
708
709 I once thought this is a great idea.
710
711 urxvt.font: 9x15bold,\
712 -misc-fixed-bold-r-normal--15-140-75-75-c-90-iso10646-1,\
713 -misc-fixed-medium-r-normal--15-140-75-75-c-90-iso10646-1, \
714 [codeset=JISX0208]xft:Kochi Gothic, \
715 xft:Bitstream Vera Sans Mono:autohint=true, \
716 xft:Code2000:antialias=false
717 urxvt.boldFont: -xos4-terminus-bold-r-normal--14-140-72-72-c-80-iso8859-15
718 urxvt.italicFont: xft:Bitstream Vera Sans Mono:italic:autohint=true
719 urxvt.boldItalicFont: xft:Bitstream Vera Sans Mono:bold:italic:autohint=true
720
721 I wrote rxvt-unicode to be able to specify fonts exactly. So don't be
722 overwhelmed. A special note: the "9x15bold" mentioend above is actually
723 the version from XFree-3.3, as XFree-4 replaced it by a totally
724 different font (different glyphs for ";" and many other harmless
725 characters), while the second font is actually the "9x15bold" from
726 XFree4/XOrg. The bold version has less chars than the medium version, so
727 I use it for rare characters, too. Whene ditign sources with vim, I use
728 italic for comments and other stuff, which looks quite good with
729 Bitstream Vera anti-aliased.
730
731 Terminus is a quite bad font (many very wrong glyphs), but for most of
732 my purposes, it works, and gives a different look, as my normal
733 (Non-bold) font is already bold, and I want to see a difference between
734 bold and normal fonts.
735
736 Please note that I used the "urxvt" instance name and not the "URxvt"
737 class name. Thats because I use different configs for different
738 purposes, for example, my IRC window is started with "-name IRC", and
739 uses these defaults:
740
741 IRC*title: IRC
742 IRC*geometry: 87x12+535+542
743 IRC*saveLines: 0
744 IRC*mapAlert: true
745 IRC*font: suxuseuro
746 IRC*boldFont: suxuseuro
747 IRC*colorBD: white
748 IRC*keysym.M-C-1: command:\033]710;suxuseuro\007\033]711;suxuseuro\007
749 IRC*keysym.M-C-2: command:\033]710;9x15bold\007\033]711;9x15bold\007
750
751 "Alt-Shift-1" and "Alt-Shift-2" switch between two different font sizes.
752 "suxuseuro" allows me to keep an eye (and actually read) stuff while
753 keeping a very small window. If somebody pastes something complicated
754 (e.g. japanese), I temporarily switch to a larger font.
755
756 The above is all in my ".Xdefaults" (I don't use ".Xresources" nor
757 "xrdb"). I also have some resources in a separate ".Xdefaults-hostname"
758 file for different hosts, for example, on ym main desktop, I use:
759
760 URxvt.keysym.C-M-q: command:\033[3;5;5t
761 URxvt.keysym.C-M-y: command:\033[3;5;606t
762 URxvt.keysym.C-M-e: command:\033[3;1605;5t
763 URxvt.keysym.C-M-c: command:\033[3;1605;606t
764 URxvt.keysym.C-M-p: perl:test
765
766 The first for keysym definitions allow me to quickly bring some windows
767 in the layout I like most. Ion users might start laughing but will stop
768 immediately when I tell them that I use my own Fvwm2 module for much the
769 same effect as Ion provides, and I only very rarely use the above key
770 combinations :->
771
772 Why doesn't rxvt-unicode read my resources?
773 Well, why, indeed? It does, in a way very similar to other X
774 applications. Most importantly, this means that if you or your OS loads
775 resources into the X display (the right way to do it), rxvt-unicode will
776 ignore any resource files in your home directory. It will only read
777 $HOME/.Xdefaults when no resources are attached to the display.
778
779 If you have or use an $HOME/.Xresources file, chances are that resources
780 are loaded into your X-server. In this case, you have to re-login after
781 every change (or run xrdb -merge $HOME/.Xresources).
782
783 Also consider the form resources have to use:
784
785 URxvt.resource: value
786
787 If you want to use another form (there are lots of different ways of
788 specifying resources), make sure you understand wether and why it works.
789 If unsure, use the form above.
790
791 When I log-in to another system it tells me about missing terminfo data?
792 The terminal description used by rxvt-unicode is not as widely available
793 as that for xterm, or even rxvt (for which the same problem often
794 arises).
795
796 The correct solution for this problem is to install the terminfo, this
797 can be done like this (with ncurses' infocmp):
798
799 REMOTE=remotesystem.domain
800 infocmp rxvt-unicode | ssh $REMOTE "cat >/tmp/ti && tic /tmp/ti"
801
802 ... or by installing rxvt-unicode normally on the remote system,
803
804 If you cannot or do not want to do this, then you can simply set
805 "TERM=rxvt" or even "TERM=xterm", and live with the small number of
806 problems arising, which includes wrong keymapping, less and different
807 colours and some refresh errors in fullscreen applications. It's a nice
808 quick-and-dirty workaround for rare cases, though.
809
810 If you always want to do this (and are fine with the consequences) you
811 can either recompile rxvt-unicode with the desired TERM value or use a
812 resource to set it:
813
814 URxvt.termName: rxvt
815
816 If you don't plan to use rxvt (quite common...) you could also replace
817 the rxvt terminfo file with the rxvt-unicode one and use "TERM=rxvt".
818
819 "tic" outputs some error when compiling the terminfo entry.
820 Most likely it's the empty definition for "enacs=". Just replace it by
821 "enacs=\E[0@" and try again.
822
823 "bash"'s readline does not work correctly under urxvt.
824 See next entry.
825
826 I need a termcap file entry.
827 One reason you might want this is that some distributions or operating
828 systems still compile some programs using the long-obsoleted termcap
829 library (Fedora Core's bash is one example) and rely on a termcap entry
830 for "rxvt-unicode".
831
832 You could use rxvt's termcap entry with resonable results in many cases.
833 You can also create a termcap entry by using terminfo's infocmp program
834 like this:
835
836 infocmp -C rxvt-unicode
837
838 Or you could use this termcap entry, generated by the command above:
839
840 rxvt-unicode|rxvt-unicode terminal (X Window System):\
841 :am:bw:eo:km:mi:ms:xn:xo:\
842 :co#80:it#8:li#24:lm#0:\
843 :AL=\E[%dL:DC=\E[%dP:DL=\E[%dM:DO=\E[%dB:IC=\E[%d@:\
844 :K1=\EOw:K2=\EOu:K3=\EOy:K4=\EOq:K5=\EOs:LE=\E[%dD:\
845 :RI=\E[%dC:SF=\E[%dS:SR=\E[%dT:UP=\E[%dA:ae=\E(B:al=\E[L:\
846 :as=\E(0:bl=^G:cd=\E[J:ce=\E[K:cl=\E[H\E[2J:\
847 :cm=\E[%i%d;%dH:cr=^M:cs=\E[%i%d;%dr:ct=\E[3g:dc=\E[P:\
848 :dl=\E[M:do=^J:ec=\E[%dX:ei=\E[4l:ho=\E[H:\
849 :i1=\E[?47l\E=\E[?1l:ic=\E[@:im=\E[4h:\
850 :is=\E[r\E[m\E[2J\E[H\E[?7h\E[?1;3;4;6l\E[4l:\
851 :k1=\E[11~:k2=\E[12~:k3=\E[13~:k4=\E[14~:k5=\E[15~:\
852 :k6=\E[17~:k7=\E[18~:k8=\E[19~:k9=\E[20~:kD=\E[3~:\
853 :kI=\E[2~:kN=\E[6~:kP=\E[5~:kb=\177:kd=\EOB:ke=\E[?1l\E>:\
854 :kh=\E[7~:kl=\EOD:kr=\EOC:ks=\E[?1h\E=:ku=\EOA:le=^H:\
855 :mb=\E[5m:md=\E[1m:me=\E[m\017:mr=\E[7m:nd=\E[C:rc=\E8:\
856 :sc=\E7:se=\E[27m:sf=^J:so=\E[7m:sr=\EM:st=\EH:ta=^I:\
857 :te=\E[r\E[?1049l:ti=\E[?1049h:ue=\E[24m:up=\E[A:\
858 :us=\E[4m:vb=\E[?5h\E[?5l:ve=\E[?25h:vi=\E[?25l:\
859 :vs=\E[?25h:
860
861 Why does "ls" no longer have coloured output?
862 The "ls" in the GNU coreutils unfortunately doesn't use terminfo to
863 decide wether a terminal has colour, but uses it's own configuration
864 file. Needless to say, "rxvt-unicode" is not in it's default file (among
865 with most other terminals supporting colour). Either add:
866
867 TERM rxvt-unicode
868
869 to "/etc/DIR_COLORS" or simply add:
870
871 alias ls='ls --color=auto'
872
873 to your ".profile" or ".bashrc".
874
875 Why doesn't vim/emacs etc. use the 88 colour mode?
876 See next entry.
877
878 Why doesn't vim/emacs etc. make use of italic?
879 See next entry.
880
881 Why are the secondary screen-related options not working properly?
882 Make sure you are using "TERM=rxvt-unicode". Some pre-packaged
883 distributions (most notably Debian GNU/Linux) break rxvt-unicode by
884 setting "TERM" to "rxvt", which doesn't have these extra features.
885 Unfortunately, some of these (most notably, again, Debian GNU/Linux)
886 furthermore fail to even install the "rxvt-unicode" terminfo file, so
887 you will need to install it on your own (See the question When I log-in
888 to another system it tells me about missing terminfo data? on how to do
889 this).
890
891 Encoding / Locale / Input Method Issues
892 Rxvt-unicode does not seem to understand the selected encoding?
893 See next entry.
894
895 Unicode does not seem to work?
896 If you encounter strange problems like typing an accented character but
897 getting two unrelated other characters or similar, or if program output
898 is subtly garbled, then you should check your locale settings.
899
900 Rxvt-unicode must be started with the same "LC_CTYPE" setting as the
901 programs. Often rxvt-unicode is started in the "C" locale, while the
902 login script running within the rxvt-unicode window changes the locale
903 to something else, e.g. "en_GB.UTF-8". Needless to say, this is not
904 going to work.
905
906 The best thing is to fix your startup environment, as you will likely
907 run into other problems. If nothing works you can try this in your
908 .profile.
909
910 printf '\e]701;%s\007' "$LC_CTYPE"
911
912 If this doesn't work, then maybe you use a "LC_CTYPE" specification not
913 supported on your systems. Some systems have a "locale" command which
914 displays this (also, "perl -e0" can be used to check locale settings, as
915 it will complain loudly if it cannot set the locale). If it displays
916 something like:
917
918 locale: Cannot set LC_CTYPE to default locale: ...
919
920 Then the locale you specified is not supported on your system.
921
922 If nothing works and you are sure that everything is set correctly then
923 you will need to remember a little known fact: Some programs just don't
924 support locales :(
925
926 How does rxvt-unicode determine the encoding to use?
927 See next entry.
928
929 Is there an option to switch encodings?
930 Unlike some other terminals, rxvt-unicode has no encoding switch, and no
931 specific "utf-8" mode, such as xterm. In fact, it doesn't even know
932 about UTF-8 or any other encodings with respect to terminal I/O.
933
934 The reasons is that there exists a perfectly fine mechanism for
935 selecting the encoding, doing I/O and (most important) communicating
936 this to all applications so everybody agrees on character properties
937 such as width and code number. This mechanism is the *locale*.
938 Applications not using that info will have problems (for example,
939 "xterm" gets the width of characters wrong as it uses it's own,
940 locale-independent table under all locales).
941
942 Rxvt-unicode uses the "LC_CTYPE" locale category to select encoding. All
943 programs doing the same (that is, most) will automatically agree in the
944 interpretation of characters.
945
946 Unfortunately, there is no system-independent way to select locales, nor
947 is there a standard on how locale specifiers will look like.
948
949 On most systems, the content of the "LC_CTYPE" environment variable
950 contains an arbitrary string which corresponds to an already-installed
951 locale. Common names for locales are "en_US.UTF-8", "de_DE.ISO-8859-15",
952 "ja_JP.EUC-JP", i.e. "language_country.encoding", but other forms (i.e.
953 "de" or "german") are also common.
954
955 Rxvt-unicode ignores all other locale categories, and except for the
956 encoding, ignores country or language-specific settings, i.e.
957 "de_DE.UTF-8" and "ja_JP.UTF-8" are the normally same to rxvt-unicode.
958
959 If you want to use a specific encoding you have to make sure you start
960 rxvt-unicode with the correct "LC_CTYPE" category.
961
962 Can I switch locales at runtime?
963 Yes, using an escape sequence. Try something like this, which sets
964 rxvt-unicode's idea of "LC_CTYPE".
965
966 printf '\e]701;%s\007' ja_JP.SJIS
967
968 See also the previous answer.
969
970 Sometimes this capability is rather handy when you want to work in one
971 locale (e.g. "de_DE.UTF-8") but some programs don't support it (e.g.
972 UTF-8). For example, I use this script to start "xjdic", which first
973 switches to a locale supported by xjdic and back later:
974
975 printf '\e]701;%s\007' ja_JP.SJIS
976 xjdic -js
977 printf '\e]701;%s\007' de_DE.UTF-8
978
979 You can also use xterm's "luit" program, which usually works fine,
980 except for some locales where character width differs between program-
981 and rxvt-unicode-locales.
982
983 I have problems getting my input method working.
984 Try a search engine, as this is slightly different for every input
985 method server.
986
987 Here is a checklist:
988
989 - Make sure your locale *and* the imLocale are supported on your OS.
990 Try "locale -a" or check the documentation for your OS.
991
992 - Make sure your locale or imLocale matches a locale supported by your
993 XIM.
994 For example, kinput2 does not support UTF-8 locales, you should use
995 "ja_JP.EUC-JP" or equivalent.
996
997 - Make sure your XIM server is actually running.
998 - Make sure the "XMODIFIERS" environment variable is set correctly when
999 *starting* rxvt-unicode.
1000 When you want to use e.g. kinput2, it must be set to "@im=kinput2".
1001 For scim, use "@im=SCIM". Youc an see what input method servers are
1002 running with this command:
1003
1004 xprop -root XIM_SERVERS
1005
1006 *
1007
1008 My input method wants <some encoding> but I want UTF-8, what can I do?
1009 You can specify separate locales for the input method and the rest of
1010 the terminal, using the resource "imlocale":
1011
1012 URxvt.imlocale: ja_JP.EUC-JP
1013
1014 Now you can start your terminal with "LC_CTYPE=ja_JP.UTF-8" and still
1015 use your input method. Please note, however, that, depending on your
1016 Xlib version, you may not be able to input characters outside "EUC-JP"
1017 in a normal way then, as your input method limits you.
1018
1019 Rxvt-unicode crashes when the X Input Method changes or exits.
1020 Unfortunately, this is unavoidable, as the XIM protocol is racy by
1021 design. Applications can avoid some crashes at the expense of memory
1022 leaks, and Input Methods can avoid some crashes by careful ordering at
1023 exit time. kinput2 (and derived input methods) generally succeeds, while
1024 SCIM (or similar input methods) fails. In the end, however, crashes
1025 cannot be completely avoided even if both sides cooperate.
1026
1027 So the only workaround is not to kill your Input Method Servers.
1028
1029 Operating Systems / Package Maintaining
1030 I am using Debian GNU/Linux and have a problem...
1031 The Debian GNU/Linux package of rxvt-unicode in sarge contains large
1032 patches that considerably change the behaviour of rxvt-unicode (but
1033 unfortunately this notice has been removed). Before reporting a bug to
1034 the original rxvt-unicode author please download and install the genuine
1035 version (<http://software.schmorp.de#rxvt-unicode>) and try to reproduce
1036 the problem. If you cannot, chances are that the problems are specific
1037 to Debian GNU/Linux, in which case it should be reported via the Debian
1038 Bug Tracking System (use "reportbug" to report the bug).
1039
1040 For other problems that also affect the Debian package, you can and
1041 probably should use the Debian BTS, too, because, after all, it's also a
1042 bug in the Debian version and it serves as a reminder for other users
1043 that might encounter the same issue.
1044
1045 I am maintaining rxvt-unicode for distribution/OS XXX, any recommendation?
1046 You should build one binary with the default options. configure now
1047 enables most useful options, and the trend goes to making them
1048 runtime-switchable, too, so there is usually no drawback to enbaling
1049 them, except higher disk and possibly memory usage. The perl interpreter
1050 should be enabled, as important functionality (menus, selection, likely
1051 more in the future) depends on it.
1052
1053 You should not overwrite the "perl-ext-common" snd "perl-ext" resources
1054 system-wide (except maybe with "defaults"). This will result in useful
1055 behaviour. If your distribution aims at low memory, add an empty
1056 "perl-ext-common" resource to the app-defaults file. This will keep the
1057 perl interpreter disabled until the user enables it.
1058
1059 If you can/want build more binaries, I recommend building a minimal one
1060 with "--disable-everything" (very useful) and a maximal one with
1061 "--enable-everything" (less useful, it will be very big due to a lot of
1062 encodings built-in that increase download times and are rarely used).
1063
1064 I need to make it setuid/setgid to support utmp/ptys on my OS, is this safe?
1065 It should be, starting with release 7.1. You are encouraged to properly
1066 install urxvt with privileges necessary for your OS now.
1067
1068 When rxvt-unicode detects that it runs setuid or setgid, it will fork
1069 into a helper process for privileged operations (pty handling on some
1070 systems, utmp/wtmp/lastlog handling on others) and drop privileges
1071 immediately. This is much safer than most other terminals that keep
1072 privileges while running (but is more relevant to urxvt, as it contains
1073 things as perl interpreters, which might be "helpful" to attackers).
1074
1075 This forking is done as the very first within main(), which is very
1076 early and reduces possible bugs to initialisation code run before
1077 main(), or things like the dynamic loader of your system, which should
1078 result in very little risk.
1079
1080 On Solaris 9, many line-drawing characters are too wide.
1081 Seems to be a known bug, read
1082 <http://nixdoc.net/files/forum/about34198.html>. Some people use the
1083 following ugly workaround to get non-double-wide-characters working:
1084
1085 #define wcwidth(x) wcwidth(x) > 1 ? 1 : wcwidth(x)
1086
1087 I am on FreeBSD and rxvt-unicode does not seem to work at all.
1088 Rxvt-unicode requires the symbol "__STDC_ISO_10646__" to be defined in
1089 your compile environment, or an implementation that implements it,
1090 wether it defines the symbol or not. "__STDC_ISO_10646__" requires that
1091 wchar_t is represented as unicode.
1092
1093 As you might have guessed, FreeBSD does neither define this symobl nor
1094 does it support it. Instead, it uses it's own internal representation of
1095 wchar_t. This is, of course, completely fine with respect to standards.
1096
1097 However, that means rxvt-unicode only works in "POSIX", "ISO-8859-1" and
1098 "UTF-8" locales under FreeBSD (which all use Unicode as wchar_t.
1099
1100 "__STDC_ISO_10646__" is the only sane way to support multi-language apps
1101 in an OS, as using a locale-dependent (and non-standardized)
1102 representation of wchar_t makes it impossible to convert between wchar_t
1103 (as used by X11 and your applications) and any other encoding without
1104 implementing OS-specific-wrappers for each and every locale. There
1105 simply are no APIs to convert wchar_t into anything except the current
1106 locale encoding.
1107
1108 Some applications (such as the formidable mlterm) work around this by
1109 carrying their own replacement functions for character set handling with
1110 them, and either implementing OS-dependent hacks or doing multiple
1111 conversions (which is slow and unreliable in case the OS implements
1112 encodings slightly different than the terminal emulator).
1113
1114 The rxvt-unicode author insists that the right way to fix this is in the
1115 system libraries once and for all, instead of forcing every app to carry
1116 complete replacements for them :)
1117
1118 I use Solaris 9 and it doesn't compile/work/etc.
1119 Try the diff in doc/solaris9.patch as a base. It fixes the worst
1120 problems with "wcwidth" and a compile problem.
1121
1122 How can I use rxvt-unicode under cygwin?
1123 rxvt-unicode should compile and run out of the box on cygwin, using the
1124 X11 libraries that come with cygwin. libW11 emulation is no longer
1125 supported (and makes no sense, either, as it only supported a single
1126 font). I recommend starting the X-server in "-multiwindow" or
1127 "-rootless" mode instead, which will result in similar look&feel as the
1128 old libW11 emulation.
1129
1130 At the time of this writing, cygwin didn't seem to support any
1131 multi-byte encodings (you might try "LC_CTYPE=C-UTF-8"), so you are
1132 likely limited to 8-bit encodings.
1133
1134 RXVT-UNICODE TECHNICAL REFERENCE
1135 The rest of this document describes various technical aspects of
1136 rxvt-unicode. First the description of supported command sequences,
1137 followed by pixmap support and last by a description of all features
1138 selectable at "configure" time.
1139
1140 Definitions
1141 "c" The literal character c.
1142
1143 "C" A single (required) character.
1144
1145 "Ps"
1146 A single (usually optional) numeric parameter, composed of one or
1147 more digits.
1148
1149 "Pm"
1150 A multiple numeric parameter composed of any number of single
1151 numeric parameters, separated by ";" character(s).
1152
1153 "Pt"
1154 A text parameter composed of printable characters.
1155
1156 Values
1157 "ENQ"
1158 Enquiry (Ctrl-E) = Send Device Attributes (DA) request attributes
1159 from terminal. See "ESC [ Ps c".
1160
1161 "BEL"
1162 Bell (Ctrl-G)
1163
1164 "BS"
1165 Backspace (Ctrl-H)
1166
1167 "TAB"
1168 Horizontal Tab (HT) (Ctrl-I)
1169
1170 "LF"
1171 Line Feed or New Line (NL) (Ctrl-J)
1172
1173 "VT"
1174 Vertical Tab (Ctrl-K) same as "LF"
1175
1176 "FF"
1177 Form Feed or New Page (NP) (Ctrl-L) same as "LF"
1178
1179 "CR"
1180 Carriage Return (Ctrl-M)
1181
1182 "SO"
1183 Shift Out (Ctrl-N), invokes the G1 character set. Switch to
1184 Alternate Character Set
1185
1186 "SI"
1187 Shift In (Ctrl-O), invokes the G0 character set (the default).
1188 Switch to Standard Character Set
1189
1190 "SPC"
1191 Space Character
1192
1193 Escape Sequences
1194 "ESC # 8"
1195 DEC Screen Alignment Test (DECALN)
1196
1197 "ESC 7"
1198 Save Cursor (SC)
1199
1200 "ESC 8"
1201 Restore Cursor
1202
1203 "ESC ="
1204 Application Keypad (SMKX). See also next sequence.
1205
1206 "ESC"
1207 Normal Keypad (RMKX)
1208
1209 Note: If the numeric keypad is activated, eg, Num_Lock has been
1210 pressed, numbers or control functions are generated by the numeric
1211 keypad (see Key Codes).
1212
1213 "ESC D"
1214 Index (IND)
1215
1216 "ESC E"
1217 Next Line (NEL)
1218
1219 "ESC H"
1220 Tab Set (HTS)
1221
1222 "ESC M"
1223 Reverse Index (RI)
1224
1225 "ESC N"
1226 Single Shift Select of G2 Character Set (SS2): affects next
1227 character only *unimplemented*
1228
1229 "ESC O"
1230 Single Shift Select of G3 Character Set (SS3): affects next
1231 character only *unimplemented*
1232
1233 "ESC Z"
1234 Obsolete form of returns: "ESC [ ? 1 ; 2 C" *rxvt-unicode
1235 compile-time option*
1236
1237 "ESC c"
1238 Full reset (RIS)
1239
1240 "ESC n"
1241 Invoke the G2 Character Set (LS2)
1242
1243 "ESC o"
1244 Invoke the G3 Character Set (LS3)
1245
1246 "ESC ( C"
1247 Designate G0 Character Set (ISO 2022), see below for values of "C".
1248
1249 "ESC ) C"
1250 Designate G1 Character Set (ISO 2022), see below for values of "C".
1251
1252 "ESC * C"
1253 Designate G2 Character Set (ISO 2022), see below for values of "C".
1254
1255 "ESC + C"
1256 Designate G3 Character Set (ISO 2022), see below for values of "C".
1257
1258 "ESC $ C"
1259 Designate Kanji Character Set
1260
1261 Where "C" is one of:
1262
1263 C = 0 DEC Special Character and Line Drawing Set
1264 C = A United Kingdom (UK)
1265 C = B United States (USASCII)
1266 C = < Multinational character set unimplemented
1267 C = 5 Finnish character set unimplemented
1268 C = C Finnish character set unimplemented
1269 C = K German character set unimplemented
1270
1271
1272
1273 CSI (Command Sequence Introducer) Sequences
1274 "ESC [ Ps @"
1275 Insert "Ps" (Blank) Character(s) [default: 1] (ICH)
1276
1277 "ESC [ Ps A"
1278 Cursor Up "Ps" Times [default: 1] (CUU)
1279
1280 "ESC [ Ps B"
1281 Cursor Down "Ps" Times [default: 1] (CUD)
1282
1283 "ESC [ Ps C"
1284 Cursor Forward "Ps" Times [default: 1] (CUF)
1285
1286 "ESC [ Ps D"
1287 Cursor Backward "Ps" Times [default: 1] (CUB)
1288
1289 "ESC [ Ps E"
1290 Cursor Down "Ps" Times [default: 1] and to first column
1291
1292 "ESC [ Ps F"
1293 Cursor Up "Ps" Times [default: 1] and to first column
1294
1295 "ESC [ Ps G"
1296 Cursor to Column "Ps" (HPA)
1297
1298 "ESC [ Ps;Ps H"
1299 Cursor Position [row;column] [default: 1;1] (CUP)
1300
1301 "ESC [ Ps I"
1302 Move forward "Ps" tab stops [default: 1]
1303
1304 "ESC [ Ps J"
1305 Erase in Display (ED)
1306
1307 Ps = 0 Clear Below (default)
1308 Ps = 1 Clear Above
1309 Ps = 2 Clear All
1310
1311 "ESC [ Ps K"
1312 Erase in Line (EL)
1313
1314 Ps = 0 Clear to Right (default)
1315 Ps = 1 Clear to Left
1316 Ps = 2 Clear All
1317
1318 "ESC [ Ps L"
1319 Insert "Ps" Line(s) [default: 1] (IL)
1320
1321 "ESC [ Ps M"
1322 Delete "Ps" Line(s) [default: 1] (DL)
1323
1324 "ESC [ Ps P"
1325 Delete "Ps" Character(s) [default: 1] (DCH)
1326
1327 "ESC [ Ps;Ps;Ps;Ps;Ps T"
1328 Initiate . *unimplemented* Parameters are
1329 [func;startx;starty;firstrow;lastrow].
1330
1331 "ESC [ Ps W"
1332 Tabulator functions
1333
1334 Ps = 0 Tab Set (HTS)
1335 Ps = 2 Tab Clear (TBC), Clear Current Column (default)
1336 Ps = 5 Tab Clear (TBC), Clear All
1337
1338 "ESC [ Ps X"
1339 Erase "Ps" Character(s) [default: 1] (ECH)
1340
1341 "ESC [ Ps Z"
1342 Move backward "Ps" [default: 1] tab stops
1343
1344 "ESC [ Ps '"
1345 See "ESC [ Ps G"
1346
1347 "ESC [ Ps a"
1348 See "ESC [ Ps C"
1349
1350 "ESC [ Ps c"
1351 Send Device Attributes (DA) "Ps = 0" (or omitted): request
1352 attributes from terminal returns: "ESC [ ? 1 ; 2 c" (``I am a VT100
1353 with Advanced Video Option'')
1354
1355 "ESC [ Ps d"
1356 Cursor to Line "Ps" (VPA)
1357
1358 "ESC [ Ps e"
1359 See "ESC [ Ps A"
1360
1361 "ESC [ Ps;Ps f"
1362 Horizontal and Vertical Position [row;column] (HVP) [default: 1;1]
1363
1364 "ESC [ Ps g"
1365 Tab Clear (TBC)
1366
1367 Ps = 0 Clear Current Column (default)
1368 Ps = 3 Clear All (TBC)
1369
1370 "ESC [ Pm h"
1371 Set Mode (SM). See "ESC [ Pm l" sequence for description of "Pm".
1372
1373 "ESC [ Ps i"
1374 Printing. See also the "print-pipe" resource.
1375
1376 Ps = 0 print screen (MC0)
1377 Ps = 4 disable transparent print mode (MC4)
1378 Ps = 5 enable transparent print mode (MC5)
1379
1380 "ESC [ Pm l"
1381 Reset Mode (RM)
1382
1383 "Ps = 4"
1384 h Insert Mode (SMIR)
1385 l Replace Mode (RMIR)
1386
1387 "Ps = 20" (partially implemented)
1388 h Automatic Newline (LNM)
1389 l Normal Linefeed (LNM)
1390
1391 "ESC [ Pm m"
1392 Character Attributes (SGR)
1393
1394 Ps = 0 Normal (default)
1395 Ps = 1 / 21 On / Off Bold (bright fg)
1396 Ps = 3 / 23 On / Off Italic
1397 Ps = 4 / 24 On / Off Underline
1398 Ps = 5 / 25 On / Off Slow Blink (bright bg)
1399 Ps = 6 / 26 On / Off Rapid Blink (bright bg)
1400 Ps = 7 / 27 On / Off Inverse
1401 Ps = 8 / 27 On / Off Invisible (NYI)
1402 Ps = 30 / 40 fg/bg Black
1403 Ps = 31 / 41 fg/bg Red
1404 Ps = 32 / 42 fg/bg Green
1405 Ps = 33 / 43 fg/bg Yellow
1406 Ps = 34 / 44 fg/bg Blue
1407 Ps = 35 / 45 fg/bg Magenta
1408 Ps = 36 / 46 fg/bg Cyan
1409 Ps = 38;5 / 48;5 set fg/bg to color #m (ISO 8613-6)
1410 Ps = 37 / 47 fg/bg White
1411 Ps = 39 / 49 fg/bg Default
1412 Ps = 90 / 100 fg/bg Bright Black
1413 Ps = 91 / 101 fg/bg Bright Red
1414 Ps = 92 / 102 fg/bg Bright Green
1415 Ps = 93 / 103 fg/bg Bright Yellow
1416 Ps = 94 / 104 fg/bg Bright Blue
1417 Ps = 95 / 105 fg/bg Bright Magenta
1418 Ps = 96 / 106 fg/bg Bright Cyan
1419 Ps = 97 / 107 fg/bg Bright White
1420 Ps = 99 / 109 fg/bg Bright Default
1421
1422 "ESC [ Ps n"
1423 Device Status Report (DSR)
1424
1425 Ps = 5 Status Report ESC [ 0 n (``OK'')
1426 Ps = 6 Report Cursor Position (CPR) [row;column] as ESC [ r ; c R
1427 Ps = 7 Request Display Name
1428 Ps = 8 Request Version Number (place in window title)
1429
1430 "ESC [ Ps;Ps r"
1431 Set Scrolling Region [top;bottom] [default: full size of window]
1432 (CSR)
1433
1434 "ESC [ s"
1435 Save Cursor (SC)
1436
1437 "ESC [ Ps;Pt t"
1438 Window Operations
1439
1440 Ps = 1 Deiconify (map) window
1441 Ps = 2 Iconify window
1442 Ps = 3 ESC [ 3 ; X ; Y t Move window to (X|Y)
1443 Ps = 4 ESC [ 4 ; H ; W t Resize to WxH pixels
1444 Ps = 5 Raise window
1445 Ps = 6 Lower window
1446 Ps = 7 Refresh screen once
1447 Ps = 8 ESC [ 8 ; R ; C t Resize to R rows and C columns
1448 Ps = 11 Report window state (responds with Ps = 1 or Ps = 2)
1449 Ps = 13 Report window position (responds with Ps = 3)
1450 Ps = 14 Report window pixel size (responds with Ps = 4)
1451 Ps = 18 Report window text size (responds with Ps = 7)
1452 Ps = 19 Currently the same as Ps = 18, but responds with Ps = 9
1453 Ps = 20 Reports icon label (ESC ] L NAME \234)
1454 Ps = 21 Reports window title (ESC ] l NAME \234)
1455 Ps = 24.. Set window height to Ps rows
1456
1457 "ESC [ u"
1458 Restore Cursor
1459
1460 "ESC [ Ps x"
1461 Request Terminal Parameters (DECREQTPARM)
1462
1463
1464
1465 DEC Private Modes
1466 "ESC [ ? Pm h"
1467 DEC Private Mode Set (DECSET)
1468
1469 "ESC [ ? Pm l"
1470 DEC Private Mode Reset (DECRST)
1471
1472 "ESC [ ? Pm r"
1473 Restore previously saved DEC Private Mode Values.
1474
1475 "ESC [ ? Pm s"
1476 Save DEC Private Mode Values.
1477
1478 "ESC [ ? Pm t"
1479 Toggle DEC Private Mode Values (rxvt extension). *where*
1480
1481 "Ps = 1" (DECCKM)
1482 h Application Cursor Keys
1483 l Normal Cursor Keys
1484
1485 "Ps = 2" (ANSI/VT52 mode)
1486 h Enter VT52 mode
1487 l Enter VT52 mode
1488
1489 "Ps = 3"
1490 h 132 Column Mode (DECCOLM)
1491 l 80 Column Mode (DECCOLM)
1492
1493 "Ps = 4"
1494 h Smooth (Slow) Scroll (DECSCLM)
1495 l Jump (Fast) Scroll (DECSCLM)
1496
1497 "Ps = 5"
1498 h Reverse Video (DECSCNM)
1499 l Normal Video (DECSCNM)
1500
1501 "Ps = 6"
1502 h Origin Mode (DECOM)
1503 l Normal Cursor Mode (DECOM)
1504
1505 "Ps = 7"
1506 h Wraparound Mode (DECAWM)
1507 l No Wraparound Mode (DECAWM)
1508
1509 "Ps = 8" *unimplemented*
1510 h Auto-repeat Keys (DECARM)
1511 l No Auto-repeat Keys (DECARM)
1512
1513 "Ps = 9" X10 XTerm
1514 h Send Mouse X & Y on button press.
1515 l No mouse reporting.
1516
1517 "Ps = 25"
1518 h Visible cursor {cnorm/cvvis}
1519 l Invisible cursor {civis}
1520
1521 "Ps = 30"
1522 h scrollBar visisble
1523 l scrollBar invisisble
1524
1525 "Ps = 35" (rxvt)
1526 h Allow XTerm Shift+key sequences
1527 l Disallow XTerm Shift+key sequences
1528
1529 "Ps = 38" *unimplemented*
1530 Enter Tektronix Mode (DECTEK)
1531
1532 "Ps = 40"
1533 h Allow 80/132 Mode
1534 l Disallow 80/132 Mode
1535
1536 "Ps = 44" *unimplemented*
1537 h Turn On Margin Bell
1538 l Turn Off Margin Bell
1539
1540 "Ps = 45" *unimplemented*
1541 h Reverse-wraparound Mode
1542 l No Reverse-wraparound Mode
1543
1544 "Ps = 46" *unimplemented*
1545 "Ps = 47"
1546 h Use Alternate Screen Buffer
1547 l Use Normal Screen Buffer
1548
1549
1550
1551 "Ps = 66"
1552 h Application Keypad (DECPAM) == ESC =
1553 l Normal Keypad (DECPNM) == ESC >
1554
1555 "Ps = 67"
1556 h Backspace key sends BS (DECBKM)
1557 l Backspace key sends DEL
1558
1559 "Ps = 1000" (X11 XTerm)
1560 h Send Mouse X & Y on button press and release.
1561 l No mouse reporting.
1562
1563 "Ps = 1001" (X11 XTerm) *unimplemented*
1564 h Use Hilite Mouse Tracking.
1565 l No mouse reporting.
1566
1567 "Ps = 1010" (rxvt)
1568 h Don't scroll to bottom on TTY output
1569 l Scroll to bottom on TTY output
1570
1571 "Ps = 1011" (rxvt)
1572 h Scroll to bottom when a key is pressed
1573 l Don't scroll to bottom when a key is pressed
1574
1575 "Ps = 1021" (rxvt)
1576 h Bold/italic implies high intensity (see option -is)
1577 l Font styles have no effect on intensity (Compile styles)
1578
1579 "Ps = 1047"
1580 h Use Alternate Screen Buffer
1581 l Use Normal Screen Buffer - clear Alternate Screen Buffer if returning from it
1582
1583 "Ps = 1048"
1584 h Save cursor position
1585 l Restore cursor position
1586
1587 "Ps = 1049"
1588 h Use Alternate Screen Buffer - clear Alternate Screen Buffer if switching to it
1589 l Use Normal Screen Buffer
1590
1591
1592
1593 XTerm Operating System Commands
1594 "ESC ] Ps;Pt ST"
1595 Set XTerm Parameters. 8-bit ST: 0x9c, 7-bit ST sequence: ESC \
1596 (0x1b, 0x5c), backwards compatible terminator BEL (0x07) is also
1597 accepted. any octet can be escaped by prefixing it with SYN (0x16,
1598 ^V).
1599
1600 Ps = 0 Change Icon Name and Window Title to Pt
1601 Ps = 1 Change Icon Name to Pt
1602 Ps = 2 Change Window Title to Pt
1603 Ps = 3 If Pt starts with a ?, query the (STRING) property of the window and return it. If Pt contains a =, set the named property to the given value, else delete the specified property.
1604 Ps = 4 Pt is a semi-colon separated sequence of one or more semi-colon separated number/name pairs, where number is an index to a colour and name is the name of a colour. Each pair causes the numbered colour to be changed to name. Numbers 0-7 corresponds to low-intensity (normal) colours and 8-15 corresponds to high-intensity colours. 0=black, 1=red, 2=green, 3=yellow, 4=blue, 5=magenta, 6=cyan, 7=white
1605 Ps = 10 Change colour of text foreground to Pt (NB: may change in future)
1606 Ps = 11 Change colour of text background to Pt (NB: may change in future)
1607 Ps = 12 Change colour of text cursor foreground to Pt
1608 Ps = 13 Change colour of mouse foreground to Pt
1609 Ps = 17 Change colour of highlight characters to Pt
1610 Ps = 18 Change colour of bold characters to Pt [deprecated, see 706]
1611 Ps = 19 Change colour of underlined characters to Pt [deprecated, see 707]
1612 Ps = 20 Change background pixmap parameters (see section XPM) (Compile XPM).
1613 Ps = 39 Change default foreground colour to Pt.
1614 Ps = 46 Change Log File to Pt unimplemented
1615 Ps = 49 Change default background colour to Pt.
1616 Ps = 50 Set fontset to Pt, with the following special values of Pt (rxvt) #+n change up n #-n change down n if n is missing of 0, a value of 1 is used empty change to font0 n change to font n
1617 Ps = 55 Log all scrollback buffer and all of screen to Pt
1618 Ps = 701 Change current locale to Pt, or, if Pt is ?, return the current locale (Compile frills).
1619 Ps = 702 Request version if Pt is ?, returning rxvt-unicode, the resource name, the major and minor version numbers, e.g. ESC ] 702 ; rxvt-unicode ; urxvt ; 7 ; 4 ST.
1620 Ps = 704 Change colour of italic characters to Pt
1621 Ps = 705 Change background pixmap tint colour to Pt (Compile transparency).
1622 Ps = 706 Change colour of bold characters to Pt
1623 Ps = 707 Change colour of underlined characters to Pt
1624 Ps = 710 Set normal fontset to Pt. Same as Ps = 50.
1625 Ps = 711 Set bold fontset to Pt. Similar to Ps = 50 (Compile styles).
1626 Ps = 712 Set italic fontset to Pt. Similar to Ps = 50 (Compile styles).
1627 Ps = 713 Set bold-italic fontset to Pt. Similar to Ps = 50 (Compile styles).
1628 Ps = 720 Move viewing window up by Pt lines, or clear scrollback buffer if Pt = 0 (Compile frills).
1629 Ps = 721 Move viewing window down by Pt lines, or clear scrollback buffer if Pt = 0 (Compile frills).
1630 Ps = 777 Call the perl extension with the given string, which should be of the form extension:parameters (Compile perl).
1631
1632 XPM
1633 For the XPM XTerm escape sequence "ESC ] 20 ; Pt ST" then value of "Pt"
1634 can be the name of the background pixmap followed by a sequence of
1635 scaling/positioning commands separated by semi-colons. The
1636 scaling/positioning commands are as follows:
1637
1638 query scale/position
1639 ?
1640
1641 change scale and position
1642 WxH+X+Y
1643
1644 WxH+X (== WxH+X+X)
1645
1646 WxH (same as WxH+50+50)
1647
1648 W+X+Y (same as WxW+X+Y)
1649
1650 W+X (same as WxW+X+X)
1651
1652 W (same as WxW+50+50)
1653
1654 change position (absolute)
1655 =+X+Y
1656
1657 =+X (same as =+X+Y)
1658
1659 change position (relative)
1660 +X+Y
1661
1662 +X (same as +X+Y)
1663
1664 rescale (relative)
1665 Wx0 -> W *= (W/100)
1666
1667 0xH -> H *= (H/100)
1668
1669 For example:
1670
1671 \E]20;funky\a
1672 load funky.xpm as a tiled image
1673
1674 \E]20;mona;100\a
1675 load mona.xpm with a scaling of 100%
1676
1677 \E]20;;200;?\a
1678 rescale the current pixmap to 200% and display the image geometry in
1679 the title
1680
1681 Mouse Reporting
1682 "ESC [ M <b> <x> <y>"
1683 report mouse position
1684
1685 The lower 2 bits of "<b>" indicate the button:
1686
1687 Button = "(<b> - SPACE) & 3"
1688 0 Button1 pressed
1689 1 Button2 pressed
1690 2 Button3 pressed
1691 3 button released (X11 mouse report)
1692
1693 The upper bits of "<b>" indicate the modifiers when the button was
1694 pressed and are added together (X11 mouse report only):
1695
1696 State = "(<b> - SPACE) & 60"
1697 4 Shift
1698 8 Meta
1699 16 Control
1700 32 Double Click (rxvt extension)
1701
1702 Col = "<x> - SPACE"
1703
1704 Row = "<y> - SPACE"
1705
1706 Key Codes
1707 Note: Shift + F1-F10 generates F11-F20
1708
1709 For the keypad, use Shift to temporarily override Application-Keypad
1710 setting use Num_Lock to toggle Application-Keypad setting if Num_Lock is
1711 off, toggle Application-Keypad setting. Also note that values of Home,
1712 End, Delete may have been compiled differently on your system.
1713
1714 Normal Shift Control Ctrl+Shift
1715 Tab ^I ESC [ Z ^I ESC [ Z
1716 BackSpace ^H ^? ^? ^?
1717 Find ESC [ 1 ~ ESC [ 1 $ ESC [ 1 ^ ESC [ 1 @
1718 Insert ESC [ 2 ~ paste ESC [ 2 ^ ESC [ 2 @
1719 Execute ESC [ 3 ~ ESC [ 3 $ ESC [ 3 ^ ESC [ 3 @
1720 Select ESC [ 4 ~ ESC [ 4 $ ESC [ 4 ^ ESC [ 4 @
1721 Prior ESC [ 5 ~ scroll-up ESC [ 5 ^ ESC [ 5 @
1722 Next ESC [ 6 ~ scroll-down ESC [ 6 ^ ESC [ 6 @
1723 Home ESC [ 7 ~ ESC [ 7 $ ESC [ 7 ^ ESC [ 7 @
1724 End ESC [ 8 ~ ESC [ 8 $ ESC [ 8 ^ ESC [ 8 @
1725 Delete ESC [ 3 ~ ESC [ 3 $ ESC [ 3 ^ ESC [ 3 @
1726 F1 ESC [ 11 ~ ESC [ 23 ~ ESC [ 11 ^ ESC [ 23 ^
1727 F2 ESC [ 12 ~ ESC [ 24 ~ ESC [ 12 ^ ESC [ 24 ^
1728 F3 ESC [ 13 ~ ESC [ 25 ~ ESC [ 13 ^ ESC [ 25 ^
1729 F4 ESC [ 14 ~ ESC [ 26 ~ ESC [ 14 ^ ESC [ 26 ^
1730 F5 ESC [ 15 ~ ESC [ 28 ~ ESC [ 15 ^ ESC [ 28 ^
1731 F6 ESC [ 17 ~ ESC [ 29 ~ ESC [ 17 ^ ESC [ 29 ^
1732 F7 ESC [ 18 ~ ESC [ 31 ~ ESC [ 18 ^ ESC [ 31 ^
1733 F8 ESC [ 19 ~ ESC [ 32 ~ ESC [ 19 ^ ESC [ 32 ^
1734 F9 ESC [ 20 ~ ESC [ 33 ~ ESC [ 20 ^ ESC [ 33 ^
1735 F10 ESC [ 21 ~ ESC [ 34 ~ ESC [ 21 ^ ESC [ 34 ^
1736 F11 ESC [ 23 ~ ESC [ 23 $ ESC [ 23 ^ ESC [ 23 @
1737 F12 ESC [ 24 ~ ESC [ 24 $ ESC [ 24 ^ ESC [ 24 @
1738 F13 ESC [ 25 ~ ESC [ 25 $ ESC [ 25 ^ ESC [ 25 @
1739 F14 ESC [ 26 ~ ESC [ 26 $ ESC [ 26 ^ ESC [ 26 @
1740 F15 (Help) ESC [ 28 ~ ESC [ 28 $ ESC [ 28 ^ ESC [ 28 @
1741 F16 (Menu) ESC [ 29 ~ ESC [ 29 $ ESC [ 29 ^ ESC [ 29 @
1742 F17 ESC [ 31 ~ ESC [ 31 $ ESC [ 31 ^ ESC [ 31 @
1743 F18 ESC [ 32 ~ ESC [ 32 $ ESC [ 32 ^ ESC [ 32 @
1744 F19 ESC [ 33 ~ ESC [ 33 $ ESC [ 33 ^ ESC [ 33 @
1745 F20 ESC [ 34 ~ ESC [ 34 $ ESC [ 34 ^ ESC [ 34 @
1746 Application
1747 Up ESC [ A ESC [ a ESC O a ESC O A
1748 Down ESC [ B ESC [ b ESC O b ESC O B
1749 Right ESC [ C ESC [ c ESC O c ESC O C
1750 Left ESC [ D ESC [ d ESC O d ESC O D
1751 KP_Enter ^M ESC O M
1752 KP_F1 ESC O P ESC O P
1753 KP_F2 ESC O Q ESC O Q
1754 KP_F3 ESC O R ESC O R
1755 KP_F4 ESC O S ESC O S
1756 XK_KP_Multiply * ESC O j
1757 XK_KP_Add + ESC O k
1758 XK_KP_Separator , ESC O l
1759 XK_KP_Subtract - ESC O m
1760 XK_KP_Decimal . ESC O n
1761 XK_KP_Divide / ESC O o
1762 XK_KP_0 0 ESC O p
1763 XK_KP_1 1 ESC O q
1764 XK_KP_2 2 ESC O r
1765 XK_KP_3 3 ESC O s
1766 XK_KP_4 4 ESC O t
1767 XK_KP_5 5 ESC O u
1768 XK_KP_6 6 ESC O v
1769 XK_KP_7 7 ESC O w
1770 XK_KP_8 8 ESC O x
1771 XK_KP_9 9 ESC O y
1772
1773 CONFIGURE OPTIONS
1774 General hint: if you get compile errors, then likely your configuration
1775 hasn't been tested well. Either try with "--enable-everything" or use
1776 the ./reconf script as a base for experiments. ./reconf is used by
1777 myself, so it should generally be a working config. Of course, you
1778 should always report when a combination doesn't work, so it can be
1779 fixed. Marc Lehmann <rxvt@schmorp.de>.
1780
1781 All
1782
1783 --enable-everything
1784 Add (or remove) support for all non-multichoice options listed in
1785 "./configure --help".
1786
1787 You can specify this and then disable options you do not like by
1788 *following* this with the appropriate "--disable-..." arguments, or
1789 you can start with a minimal configuration by specifying
1790 "--disable-everything" and than adding just the "--enable-..."
1791 arguments you want.
1792
1793 --enable-xft (default: enabled)
1794 Add support for Xft (anti-aliases, among others) fonts. Xft fonts
1795 are slower and require lots of memory, but as long as you don't use
1796 them, you don't pay for them.
1797
1798 --enable-font-styles (default: on)
1799 Add support for bold, *italic* and *bold italic* font styles. The
1800 fonts can be set manually or automatically.
1801
1802 --with-codesets=NAME,... (default: all)
1803 Compile in support for additional codeset (encoding) groups ("eu",
1804 "vn" are always compiled in, which includes most 8-bit character
1805 sets). These codeset tables are used for driving X11 core fonts,
1806 they are not required for Xft fonts, although having them compiled
1807 in lets rxvt-unicode choose replacement fonts more intelligently.
1808 Compiling them in will make your binary bigger (all of together cost
1809 about 700kB), but it doesn't increase memory usage unless you use a
1810 font requiring one of these encodings.
1811
1812 all all available codeset groups
1813 zh common chinese encodings
1814 zh_ext rarely used but very big chinese encodigs
1815 jp common japanese encodings
1816 jp_ext rarely used but big japanese encodings
1817 kr korean encodings
1818
1819 --enable-xim (default: on)
1820 Add support for XIM (X Input Method) protocol. This allows using
1821 alternative input methods (e.g. kinput2) and will also correctly set
1822 up the input for people using dead keys or compose keys.
1823
1824 --enable-unicode3 (default: off)
1825 Recommended to stay off unless you really need non-BMP characters.
1826
1827 Enable direct support for displaying unicode codepoints above 65535
1828 (the basic multilingual page). This increases storage requirements
1829 per character from 2 to 4 bytes. X11 fonts do not yet support these
1830 extra characters, but Xft does.
1831
1832 Please note that rxvt-unicode can store unicode code points >65535
1833 even without this flag, but the number of such characters is limited
1834 to a view thousand (shared with combining characters, see next
1835 switch), and right now rxvt-unicode cannot display them
1836 (input/output and cut&paste still work, though).
1837
1838 --enable-combining (default: on)
1839 Enable automatic composition of combining characters into composite
1840 characters. This is required for proper viewing of text where
1841 accents are encoded as seperate unicode characters. This is done by
1842 using precomposited characters when available or creating new
1843 pseudo-characters when no precomposed form exists.
1844
1845 Without --enable-unicode3, the number of additional precomposed
1846 characters is somewhat limited (the 6400 private use characters will
1847 be (ab-)used). With --enable-unicode3, no practical limit exists.
1848
1849 This option will also enable storage (but not display) of characters
1850 beyond plane 0 (>65535) when --enable-unicode3 was not specified.
1851
1852 The combining table also contains entries for arabic presentation
1853 forms, but these are not currently used. Bug me if you want these to
1854 be used (and tell me how these are to be used...).
1855
1856 --enable-fallback(=CLASS) (default: Rxvt)
1857 When reading resource settings, also read settings for class CLASS.
1858 To disable resource fallback use --disable-fallback.
1859
1860 --with-res-name=NAME (default: urxvt)
1861 Use the given name as default application name when reading
1862 resources. Specify --with-res-name=rxvt to replace rxvt.
1863
1864 --with-res-class=CLASS /default: URxvt)
1865 Use the given class as default application class when reading
1866 resources. Specify --with-res-class=Rxvt to replace rxvt.
1867
1868 --enable-utmp (default: on)
1869 Write user and tty to utmp file (used by programs like w) at start
1870 of rxvt execution and delete information when rxvt exits.
1871
1872 --enable-wtmp (default: on)
1873 Write user and tty to wtmp file (used by programs like last) at
1874 start of rxvt execution and write logout when rxvt exits. This
1875 option requires --enable-utmp to also be specified.
1876
1877 --enable-lastlog (default: on)
1878 Write user and tty to lastlog file (used by programs like lastlogin)
1879 at start of rxvt execution. This option requires --enable-utmp to
1880 also be specified.
1881
1882 --enable-xpm-background (default: on)
1883 Add support for XPM background pixmaps.
1884
1885 --enable-transparency (default: on)
1886 Add support for inheriting parent backgrounds thus giving a fake
1887 transparency to the term.
1888
1889 --enable-fading (default: on)
1890 Add support for fading the text when focus is lost (requires
1891 "--enable-transparency").
1892
1893 --enable-tinting (default: on)
1894 Add support for tinting of transparent backgrounds (requires
1895 "--enable-transparency").
1896
1897 --enable-rxvt-scroll (default: on)
1898 Add support for the original rxvt scrollbar.
1899
1900 --enable-next-scroll (default: on)
1901 Add support for a NeXT-like scrollbar.
1902
1903 --enable-xterm-scroll (default: on)
1904 Add support for an Xterm-like scrollbar.
1905
1906 --enable-plain-scroll (default: on)
1907 Add support for a very unobtrusive, plain-looking scrollbar that is
1908 the favourite of the rxvt-unicode author, having used it for many
1909 years.
1910
1911 --enable-ttygid (default: off)
1912 Change tty device setting to group "tty" - only use this if your
1913 system uses this type of security.
1914
1915 --disable-backspace-key
1916 Removes any handling of the backspace key by us - let the X server
1917 do it.
1918
1919 --disable-delete-key
1920 Removes any handling of the delete key by us - let the X server do
1921 it.
1922
1923 --disable-resources
1924 Removes any support for resource checking.
1925
1926 --disable-swapscreen
1927 Remove support for secondary/swap screen.
1928
1929 --enable-frills (default: on)
1930 Add support for many small features that are not essential but nice
1931 to have. Normally you want this, but for very small binaries you may
1932 want to disable this.
1933
1934 A non-exhaustive list of features enabled by "--enable-frills"
1935 (possibly in combination with other switches) is:
1936
1937 MWM-hints
1938 EWMH-hints (pid, utf8 names) and protocols (ping)
1939 seperate underline colour (-underlineColor)
1940 settable border widths and borderless switch (-w, -b, -bl)
1941 visual depth selection (-depth)
1942 settable extra linespacing /-lsp)
1943 iso-14755-2 and -3, and visual feedback
1944 tripleclickwords (-tcw)
1945 settable insecure mode (-insecure)
1946 keysym remapping support
1947 cursor blinking and underline cursor (-cb, -uc)
1948 XEmbed support (-embed)
1949 user-pty (-pty-fd)
1950 hold on exit (-hold)
1951 skip builtin block graphics (-sbg)
1952
1953 It also enabled some non-essential features otherwise disabled, such
1954 as:
1955
1956 some round-trip time optimisations
1957 nearest color allocation on pseudocolor screens
1958 UTF8_STRING supporr for selection
1959 sgr modes 90..97 and 100..107
1960 backindex and forwardindex escape sequences
1961 view change/zero scorllback esacpe sequences
1962 locale switching escape sequence
1963 window op and some xterm/OSC escape sequences
1964 rectangular selections
1965 trailing space removal for selections
1966 verbose X error handling
1967
1968 --enable-iso14755 (default: on)
1969 Enable extended ISO 14755 support (see rxvt(1), or doc/rxvt.1.txt).
1970 Basic support (section 5.1) is enabled by "--enable-frills", while
1971 support for 5.2, 5.3 and 5.4 is enabled with this switch.
1972
1973 --enable-keepscrolling (default: on)
1974 Add support for continual scrolling of the display when you hold the
1975 mouse button down on a scrollbar arrow.
1976
1977 --enable-mousewheel (default: on)
1978 Add support for scrolling via mouse wheel or buttons 4 & 5.
1979
1980 --enable-slipwheeling (default: on)
1981 Add support for continual scrolling (using the mouse wheel as an
1982 accelerator) while the control key is held down. This option
1983 requires --enable-mousewheel to also be specified.
1984
1985 --disable-new-selection
1986 Remove support for mouse selection style like that of xterm.
1987
1988 --enable-dmalloc (default: off)
1989 Use Gray Watson's malloc - which is good for debugging See
1990 <http://www.letters.com/dmalloc/> for details If you use either this
1991 or the next option, you may need to edit src/Makefile after
1992 compiling to point DINCLUDE and DLIB to the right places.
1993
1994 You can only use either this option and the following (should you
1995 use either) .
1996
1997 --enable-dlmalloc (default: off)
1998 Use Doug Lea's malloc - which is good for a production version See
1999 <http://g.oswego.edu/dl/html/malloc.html> for details.
2000
2001 --enable-smart-resize (default: on)
2002 Add smart growth/shrink behaviour when changing font size via hot
2003 keys. This should keep the window corner which is closest to a
2004 corner of the screen in a fixed position.
2005
2006 --enable-pointer-blank (default: on)
2007 Add support to have the pointer disappear when typing or inactive.
2008
2009 --enable-perl (default: on)
2010 Enable an embedded perl interpreter. See the rxvtperl(3) manpage
2011 (doc/rxvtperl.txt) for more info on this feature, or the files in
2012 src/perl-ext/ for the extensions that are installed by default. The
2013 perl interpreter that is used can be specified via the "PERL"
2014 environment variable when running configure.
2015
2016 --with-name=NAME (default: urxvt)
2017 Set the basename for the installed binaries, resulting in "urxvt",
2018 "urxvtd" etc.). Specify "--with-name=rxvt" to replace with "rxvt".
2019
2020 --with-term=NAME (default: rxvt-unicode)
2021 Change the environmental variable for the terminal to NAME.
2022
2023 --with-terminfo=PATH
2024 Change the environmental variable for the path to the terminfo tree
2025 to PATH.
2026
2027 --with-x
2028 Use the X Window System (pretty much default, eh?).
2029
2030 --with-xpm-includes=DIR
2031 Look for the XPM includes in DIR.
2032
2033 --with-xpm-library=DIR
2034 Look for the XPM library in DIR.
2035
2036 --with-xpm
2037 Not needed - define via --enable-xpm-background.
2038
2039 AUTHORS
2040 Marc Lehmann <rxvt@schmorp.de> converted this document to pod and
2041 reworked it from the original Rxvt documentation, which was done by
2042 Geoff Wing <gcw@pobox.com>, who in turn used the XTerm documentation and
2043 other sources.
2044