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