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

Comparing rxvt-unicode/doc/rxvt.7.pod (file contents):
Revision 1.65 by root, Sat Dec 31 17:16:17 2005 UTC vs.
Revision 1.155 by ayin, Sun Dec 9 12:15:39 2007 UTC

16=head1 DESCRIPTION 16=head1 DESCRIPTION
17 17
18This document contains the FAQ, the RXVT TECHNICAL REFERENCE documenting 18This document contains the FAQ, the RXVT TECHNICAL REFERENCE documenting
19all escape sequences, and other background information. 19all escape sequences, and other background information.
20 20
21The newest version of this document is 21The newest version of this document is also available on the World Wide Web at
22also available on the World Wide Web at
23L<http://cvs.schmorp.de/browse/*checkout*/rxvt-unicode/doc/rxvt.7.html>. 22L<http://cvs.schmorp.de/browse/rxvt-unicode/doc/rxvt.7.html>.
24 23
25=head1 FREQUENTLY ASKED QUESTIONS 24=head1 RXVT-UNICODE/URXVT FREQUENTLY ASKED QUESTIONS
26 25
27=over 4
28 26
27=head2 Meta, Features & Commandline Issues
28
29=head3 My question isn't answered here, can I ask a human?
30
31Before sending me mail, you could go to IRC: C<irc.freenode.net>,
32channel C<#rxvt-unicode> has some rxvt-unicode enthusiasts that might be
33interested in learning about new and exciting problems (but not FAQs :).
34
35=head3 Does it support tabs, can I have a tabbed rxvt-unicode?
36
37Beginning with version 7.3, there is a perl extension that implements a
38simple tabbed terminal. It is installed by default, so any of these should
39give you tabs:
40
41 @@URXVT_NAME@@ -pe tabbed
42
43 URxvt.perl-ext-common: default,tabbed
44
45It will also work fine with tabbing functionality of many window managers
46or similar tabbing programs, and its embedding-features allow it to be
47embedded into other programs, as witnessed by F<doc/rxvt-tabbed> or
48the upcoming C<Gtk2::URxvt> perl module, which features a tabbed urxvt
49(murxvt) terminal as an example embedding application.
50
51=head3 How do I know which rxvt-unicode version I'm using?
52
53The version number is displayed with the usage (-h). Also the escape
54sequence C<ESC [ 8 n> sets the window title to the version number. When
55using the @@URXVT_NAME@@c client, the version displayed is that of the
56daemon.
57
58=head3 Rxvt-unicode uses gobs of memory, how can I reduce that?
59
60Rxvt-unicode tries to obey the rule of not charging you for something you
61don't use. One thing you should try is to configure out all settings that
62you don't need, for example, Xft support is a resource hog by design,
63when used. Compiling it out ensures that no Xft font will be loaded
64accidentally when rxvt-unicode tries to find a font for your characters.
65
66Also, many people (me included) like large windows and even larger
67scrollback buffers: Without C<--enable-unicode3>, rxvt-unicode will use
686 bytes per screen cell. For a 160x?? window this amounts to almost a
69kilobyte per line. A scrollback buffer of 10000 lines will then (if full)
70use 10 Megabytes of memory. With C<--enable-unicode3> it gets worse, as
71rxvt-unicode then uses 8 bytes per screen cell.
72
73=head3 How can I start @@URXVT_NAME@@d in a race-free way?
74
75Try C<@@URXVT_NAME@@d -f -o>, which tells @@URXVT_NAME@@d to open the
76display, create the listening socket and then fork.
77
78=head3 How can I start @@URXVT_NAME@@d automatically when I run @@URXVT_NAME@@c?
79
80If you want to start @@URXVT_NAME@@d automatically whenever you run
81@@URXVT_NAME@@c and the daemon isn't running yet, use this script:
82
83 #!/bin/sh
84 @@URXVT_NAME@@c "$@"
85 if [ $? -eq 2 ]; then
86 @@URXVT_NAME@@d -q -o -f
87 @@URXVT_NAME@@c "$@"
88 fi
89
90This tries to create a new terminal, and if fails with exit status 2,
91meaning it couldn't connect to the daemon, it will start the daemon and
92re-run the command. Subsequent invocations of the script will re-use the
93existing daemon.
94
95=head3 How do I distinguish whether I'm running rxvt-unicode or a regular xterm? I need this to decide about setting colors etc.
96
97The original rxvt and rxvt-unicode always export the variable "COLORTERM",
98so you can check and see if that is set. Note that several programs, JED,
99slrn, Midnight Commander automatically check this variable to decide
100whether or not to use color.
101
102=head3 How do I set the correct, full IP address for the DISPLAY variable?
103
104If you've compiled rxvt-unicode with DISPLAY_IS_IP and have enabled
105insecure mode then it is possible to use the following shell script
106snippets to correctly set the display. If your version of rxvt-unicode
107wasn't also compiled with ESCZ_ANSWER (as assumed in these snippets) then
108the COLORTERM variable can be used to distinguish rxvt-unicode from a
109regular xterm.
110
111Courtesy of Chuck Blake <cblake@BBN.COM> with the following shell script
112snippets:
113
114 # Bourne/Korn/POSIX family of shells:
115 [ ${TERM:-foo} = foo ] && TERM=xterm # assume an xterm if we don't know
116 if [ ${TERM:-foo} = xterm ]; then
117 stty -icanon -echo min 0 time 15 # see if enhanced rxvt or not
118 echo -n '^[Z'
119 read term_id
120 stty icanon echo
121 if [ ""${term_id} = '^[[?1;2C' -a ${DISPLAY:-foo} = foo ]; then
122 echo -n '^[[7n' # query the rxvt we are in for the DISPLAY string
123 read DISPLAY # set it in our local shell
124 fi
125 fi
126
127=head3 How do I compile the manual pages on my own?
128
129You need to have a recent version of perl installed as F</usr/bin/perl>,
130one that comes with F<pod2man>, F<pod2text> and F<pod2xhtml> (from
131F<Pod::Xhtml>). Then go to the doc subdirectory and enter C<make alldoc>.
132
29=item Isn't rxvt supposed to be small? Don't all those features bloat? 133=head3 Isn't rxvt-unicode supposed to be small? Don't all those features bloat?
30 134
31I often get asked about this, and I think, no, they didn't cause extra 135I often get asked about this, and I think, no, they didn't cause extra
32bloat. If you compare a minimal rxvt and a minimal urxvt, you can see 136bloat. If you compare a minimal rxvt and a minimal urxvt, you can see
33that the urxvt binary is larger (due to some encoding tables always being 137that the urxvt binary is larger (due to some encoding tables always being
34compiled in), but it actually uses less memory (RSS) after startup. Even 138compiled in), but it actually uses less memory (RSS) after startup. Even
38 142
39 text data bss drs rss filename 143 text data bss drs rss filename
40 98398 1664 24 15695 1824 rxvt --disable-everything 144 98398 1664 24 15695 1824 rxvt --disable-everything
41 188985 9048 66616 18222 1788 urxvt --disable-everything 145 188985 9048 66616 18222 1788 urxvt --disable-everything
42 146
43When you C<--enable-everything> (which _is_ unfair, as this involves xft 147When you C<--enable-everything> (which I<is> unfair, as this involves xft
44and full locale/XIM support which are quite bloaty inside libX11 and my 148and full locale/XIM support which are quite bloaty inside libX11 and my
45libc), the two diverge, but not unreasnobaly so. 149libc), the two diverge, but not unreasonably so.
46 150
47 text data bss drs rss filename 151 text data bss drs rss filename
48 163431 2152 24 20123 2060 rxvt --enable-everything 152 163431 2152 24 20123 2060 rxvt --enable-everything
49 1035683 49680 66648 29096 3680 urxvt --enable-everything 153 1035683 49680 66648 29096 3680 urxvt --enable-everything
50 154
62memory. 166memory.
63 167
64Compared to e.g. Eterm (5112k), aterm (3132k) and xterm (4680k), this 168Compared to e.g. Eterm (5112k), aterm (3132k) and xterm (4680k), this
65still fares rather well. And compared to some monsters like gnome-terminal 169still fares rather well. And compared to some monsters like gnome-terminal
66(21152k + extra 4204k in separate processes) or konsole (22200k + extra 170(21152k + extra 4204k in separate processes) or konsole (22200k + extra
6743180k in daemons that stay around after exit, plus half aminute of 17143180k in daemons that stay around after exit, plus half a minute of
68startup time, including the hundreds of warnings it spits out), it fares 172startup time, including the hundreds of warnings it spits out), it fares
69extremely well *g*. 173extremely well *g*.
70 174
71=item Why C++, isn't that unportable/bloated/uncool? 175=head3 Why C++, isn't that unportable/bloated/uncool?
72 176
73Is this a question? :) It comes up very often. The simple answer is: I had 177Is this a question? :) It comes up very often. The simple answer is: I had
74to write it, and C++ allowed me to write and maintain it in a fraction 178to write it, and C++ allowed me to write and maintain it in a fraction
75of the time and effort (which is a scarce resource for me). Put even 179of the time and effort (which is a scarce resource for me). Put even
76shorter: It simply wouldn't exist without C++. 180shorter: It simply wouldn't exist without C++.
93 197
94And here is rxvt-unicode: 198And here is rxvt-unicode:
95 199
96 libX11.so.6 => /usr/X11R6/lib/libX11.so.6 (0x00002aaaaabc3000) 200 libX11.so.6 => /usr/X11R6/lib/libX11.so.6 (0x00002aaaaabc3000)
97 libgcc_s.so.1 => /lib/libgcc_s.so.1 (0x00002aaaaada2000) 201 libgcc_s.so.1 => /lib/libgcc_s.so.1 (0x00002aaaaada2000)
98 libc.so.6 => /lib/libc.so.6 (0x00002aaaaaeb0000) 202 libc.so.6 => /lib/libc.so.6 (0x00002aaaaaeb0000)
99 libdl.so.2 => /lib/libdl.so.2 (0x00002aaaab0ee000) 203 libdl.so.2 => /lib/libdl.so.2 (0x00002aaaab0ee000)
100 /lib64/ld-linux-x86-64.so.2 (0x00002aaaaaaab000) 204 /lib64/ld-linux-x86-64.so.2 (0x00002aaaaaaab000)
101 205
102No large bloated libraries (of course, none were linked in statically), 206No large bloated libraries (of course, none were linked in statically),
103except maybe libX11 :) 207except maybe libX11 :)
104 208
105=item Does it support tabs, can I have a tabbed rxvt-unicode?
106 209
107rxvt-unicode does not directly support tabs. It will work fine with 210=head2 Rendering, Font & Look and Feel Issues
108tabbing functionality of many window managers or similar tabbing programs,
109and its embedding-features allow it to be embedded into other programs,
110as witnessed by F<doc/rxvt-tabbed> or the upcoming C<Gtk2::URxvt> perl
111module, which features a tabbed urxvt (murxvt) terminal as an example
112embedding application.
113 211
114=item How do I know which rxvt-unicode version I'm using? 212=head3 I can't get transparency working, what am I doing wrong?
115 213
116The version number is displayed with the usage (-h). Also the escape 214First of all, please address all transparency related issues to Sasha Vasko at
117sequence C<ESC [ 8 n> sets the window title to the version number. When 215sasha@aftercode.net and do not bug the author about it. Also, if you can't
118using the @@RXVT_NAME@@c client, the version displayed is that of the 216get it working consider it a rite of passage: ... and you failed.
119daemon.
120 217
121=item I am using Debian GNU/Linux and have a problem... 218Here are four ways to get transparency. B<Do> read the manpage and option
219descriptions for the programs mentioned and rxvt-unicode. Really, do it!
122 220
123The Debian GNU/Linux package of rxvt-unicode in sarge contains large 2211. Use transparent mode:
124patches that considerably change the behaviour of rxvt-unicode. Before
125reporting a bug to the original rxvt-unicode author please download and
126install the genuine version (L<http://software.schmorp.de#rxvt-unicode>)
127and try to reproduce the problem. If you cannot, chances are that the
128problems are specific to Debian GNU/Linux, in which case it should be
129reported via the Debian Bug Tracking System (use C<reportbug> to report
130the bug).
131 222
132For other problems that also affect the Debian package, you can and 223 Esetroot wallpaper.jpg
133probably should use the Debian BTS, too, because, after all, it's also a 224 @@URXVT_NAME@@ -tr -tint red -sh 40
134bug in the Debian version and it serves as a reminder for other users that
135might encounter the same issue.
136 225
226That works. If you think it doesn't, you lack transparency and tinting
227support, or you are unable to read.
228
2292. Use a simple pixmap and emulate pseudo-transparency. This enables you
230to use effects other than tinting and shading: Just shade/tint/whatever
231your picture with gimp or any other tool:
232
233 convert wallpaper.jpg -blur 20x20 -modulate 30 background.jpg
234 @@URXVT_NAME@@ -pixmap "background.jpg;:root"
235
236That works. If you think it doesn't, you lack AfterImage support, or you
237are unable to read.
238
2393. Use an ARGB visual:
240
241 @@URXVT_NAME@@ -depth 32 -fg grey90 -bg rgba:0000/0000/4444/cccc
242
243This requires XFT support, and the support of your X-server. If that
244doesn't work for you, blame Xorg and Keith Packard. ARGB visuals aren't
245there yet, no matter what they claim. Rxvt-Unicode contains the necessary
246bugfixes and workarounds for Xft and Xlib to make it work, but that
247doesn't mean that your WM has the required kludges in place.
248
2494. Use xcompmgr and let it do the job:
250
251 xprop -frame -f _NET_WM_WINDOW_OPACITY 32c \
252 -set _NET_WM_WINDOW_OPACITY 0xc0000000
253
254Then click on a window you want to make transparent. Replace C<0xc0000000>
255by other values to change the degree of opacity. If it doesn't work and
256your server crashes, you got to keep the pieces.
257
258=head3 Why does rxvt-unicode sometimes leave pixel droppings?
259
260Most fonts were not designed for terminal use, which means that character
261size varies a lot. A font that is otherwise fine for terminal use might
262contain some characters that are simply too wide. Rxvt-unicode will avoid
263these characters. For characters that are just "a bit" too wide a special
264"careful" rendering mode is used that redraws adjacent characters.
265
266All of this requires that fonts do not lie about character sizes,
267however: Xft fonts often draw glyphs larger than their acclaimed bounding
268box, and rxvt-unicode has no way of detecting this (the correct way is to
269ask for the character bounding box, which unfortunately is wrong in these
270cases).
271
272It's not clear (to me at least), whether this is a bug in Xft, freetype,
273or the respective font. If you encounter this problem you might try using
274the C<-lsp> option to give the font more height. If that doesn't work, you
275might be forced to use a different font.
276
277All of this is not a problem when using X11 core fonts, as their bounding
278box data is correct.
279
280=head3 How can I keep rxvt-unicode from using reverse video so much?
281
282First of all, make sure you are running with the right terminal settings
283(C<TERM=rxvt-unicode>), which will get rid of most of these effects. Then
284make sure you have specified colours for italic and bold, as otherwise
285rxvt-unicode might use reverse video to simulate the effect:
286
287 URxvt.colorBD: white
288 URxvt.colorIT: green
289
290=head3 Some programs assume totally weird colours (red instead of blue), how can I fix that?
291
292For some unexplainable reason, some rare programs assume a very weird
293colour palette when confronted with a terminal with more than the standard
2948 colours (rxvt-unicode supports 88). The right fix is, of course, to fix
295these programs not to assume non-ISO colours without very good reasons.
296
297In the meantime, you can either edit your C<rxvt-unicode> terminfo
298definition to only claim 8 colour support or use C<TERM=rxvt>, which will
299fix colours but keep you from using other rxvt-unicode features.
300
301=head3 Can I switch the fonts at runtime?
302
303Yes, using an escape sequence. Try something like this, which has the same
304effect as using the C<-fn> switch, and takes effect immediately:
305
306 printf '\33]50;%s\007' "9x15bold,xft:Kochi Gothic"
307
308This is useful if you e.g. work primarily with japanese (and prefer a
309japanese font), but you have to switch to chinese temporarily, where
310japanese fonts would only be in your way.
311
312You can think of this as a kind of manual ISO-2022 switching.
313
314=head3 Why do italic characters look as if clipped?
315
316Many fonts have difficulties with italic characters and hinting. For
317example, the otherwise very nicely hinted font C<xft:Bitstream Vera Sans
318Mono> completely fails in its italic face. A workaround might be to
319enable freetype autohinting, i.e. like this:
320
321 URxvt.italicFont: xft:Bitstream Vera Sans Mono:italic:autohint=true
322 URxvt.boldItalicFont: xft:Bitstream Vera Sans Mono:bold:italic:autohint=true
323
324=head3 Can I speed up Xft rendering somehow?
325
326Yes, the most obvious way to speed it up is to avoid Xft entirely, as
327it is simply slow. If you still want Xft fonts you might try to disable
328antialiasing (by appending C<:antialias=false>), which saves lots of
329memory and also speeds up rendering considerably.
330
331=head3 Rxvt-unicode doesn't seem to anti-alias its fonts, what is wrong?
332
333Rxvt-unicode will use whatever you specify as a font. If it needs to
334fall back to its default font search list it will prefer X11 core
335fonts, because they are small and fast, and then use Xft fonts. It has
336antialiasing disabled for most of them, because the author thinks they
337look best that way.
338
339If you want antialiasing, you have to specify the fonts manually.
340
341=head3 What's with this bold/blink stuff?
342
343If no bold colour is set via C<colorBD:>, bold will invert text using the
344standard foreground colour.
345
346For the standard background colour, blinking will actually make
347the text blink when compiled with C<--enable-text-blink>. Without
348C<--enable-text-blink>, the blink attribute will be ignored.
349
350On ANSI colours, bold/blink attributes are used to set high-intensity
351foreground/background colors.
352
353color0-7 are the low-intensity colors.
354
355color8-15 are the corresponding high-intensity colors.
356
357=head3 I don't like the screen colors. How do I change them?
358
359You can change the screen colors at run-time using F<~/.Xdefaults>
360resources (or as long-options).
361
362Here are values that are supposed to resemble a VGA screen,
363including the murky brown that passes for low-intensity yellow:
364
365 URxvt.color0: #000000
366 URxvt.color1: #A80000
367 URxvt.color2: #00A800
368 URxvt.color3: #A8A800
369 URxvt.color4: #0000A8
370 URxvt.color5: #A800A8
371 URxvt.color6: #00A8A8
372 URxvt.color7: #A8A8A8
373
374 URxvt.color8: #000054
375 URxvt.color9: #FF0054
376 URxvt.color10: #00FF54
377 URxvt.color11: #FFFF54
378 URxvt.color12: #0000FF
379 URxvt.color13: #FF00FF
380 URxvt.color14: #00FFFF
381 URxvt.color15: #FFFFFF
382
383And here is a more complete set of non-standard colors.
384
385 URxvt.cursorColor: #dc74d1
386 URxvt.pointerColor: #dc74d1
387 URxvt.background: #0e0e0e
388 URxvt.foreground: #4ad5e1
389 URxvt.color0: #000000
390 URxvt.color8: #8b8f93
391 URxvt.color1: #dc74d1
392 URxvt.color9: #dc74d1
393 URxvt.color2: #0eb8c7
394 URxvt.color10: #0eb8c7
395 URxvt.color3: #dfe37e
396 URxvt.color11: #dfe37e
397 URxvt.color5: #9e88f0
398 URxvt.color13: #9e88f0
399 URxvt.color6: #73f7ff
400 URxvt.color14: #73f7ff
401 URxvt.color7: #e1dddd
402 URxvt.color15: #e1dddd
403
404They have been described (not by me) as "pretty girly".
405
406=head3 Why do some characters look so much different than others?
407
408See next entry.
409
410=head3 How does rxvt-unicode choose fonts?
411
412Most fonts do not contain the full range of Unicode, which is
413fine. Chances are that the font you (or the admin/package maintainer of
414your system/os) have specified does not cover all the characters you want
415to display.
416
417B<rxvt-unicode> makes a best-effort try at finding a replacement
418font. Often the result is fine, but sometimes the chosen font looks
419bad/ugly/wrong. Some fonts have totally strange characters that don't
420resemble the correct glyph at all, and rxvt-unicode lacks the artificial
421intelligence to detect that a specific glyph is wrong: it has to believe
422the font that the characters it claims to contain indeed look correct.
423
424In that case, select a font of your taste and add it to the font list,
425e.g.:
426
427 @@URXVT_NAME@@ -fn basefont,font2,font3...
428
429When rxvt-unicode sees a character, it will first look at the base
430font. If the base font does not contain the character, it will go to the
431next font, and so on. Specifying your own fonts will also speed up this
432search and use less resources within rxvt-unicode and the X-server.
433
434The only limitation is that none of the fonts may be larger than the base
435font, as the base font defines the terminal character cell size, which
436must be the same due to the way terminals work.
437
438=head3 Why do some chinese characters look so different than others?
439
440This is because there is a difference between script and language --
441rxvt-unicode does not know which language the text that is output is,
442as it only knows the unicode character codes. If rxvt-unicode first
443sees a japanese/chinese character, it might choose a japanese font for
444display. Subsequent japanese characters will use that font. Now, many
445chinese characters aren't represented in japanese fonts, so when the first
446non-japanese character comes up, rxvt-unicode will look for a chinese font
447-- unfortunately at this point, it will still use the japanese font for
448chinese characters that are also in the japanese font.
449
450The workaround is easy: just tag a chinese font at the end of your font
451list (see the previous question). The key is to view the font list as
452a preference list: If you expect more japanese, list a japanese font
453first. If you expect more chinese, put a chinese font first.
454
455In the future it might be possible to switch language preferences at
456runtime (the internal data structure has no problem with using different
457fonts for the same character at the same time, but no interface for this
458has been designed yet).
459
460Until then, you might get away with switching fonts at runtime (see L<Can
461I switch the fonts at runtime?> later in this document).
462
463=head3 How can I make mplayer display video correctly?
464
465We are working on it, in the meantime, as a workaround, use something like:
466
467 @@URXVT_NAME@@ -b 600 -geometry 20x1 -e sh -c 'mplayer -wid $WINDOWID file...'
468
469
470=head2 Keyboard, Mouse & User Interaction
471
472=head3 The new selection selects pieces that are too big, how can I select single words?
473
474If you want to select e.g. alphanumeric words, you can use the following
475setting:
476
477 URxvt.selection.pattern-0: ([[:word:]]+)
478
479If you click more than twice, the selection will be extended
480more and more.
481
482To get a selection that is very similar to the old code, try this pattern:
483
484 URxvt.selection.pattern-0: ([^"&'()*,;<=>?@[\\\\]^`{|})]+)
485
486Please also note that the I<LeftClick Shift-LeftClik> combination also
487selects words like the old code.
488
489=head3 I don't like the new selection/popups/hotkeys/perl, how do I change/disable it?
490
491You can disable the perl extension completely by setting the
492B<perl-ext-common> resource to the empty string, which also keeps
493rxvt-unicode from initialising perl, saving memory.
494
495If you only want to disable specific features, you first have to
496identify which perl extension is responsible. For this, read the section
497B<PREPACKAGED EXTENSIONS> in the @@URXVT_NAME@@perl(3) manpage. For
498example, to disable the B<selection-popup> and B<option-popup>, specify
499this B<perl-ext-common> resource:
500
501 URxvt.perl-ext-common: default,-selection-popup,-option-popup
502
503This will keep the default extensions, but disable the two popup
504extensions. Some extensions can also be configured, for example,
505scrollback search mode is triggered by B<M-s>. You can move it to any
506other combination either by setting the B<searchable-scrollback> resource:
507
508 URxvt.searchable-scrollback: CM-s
509
510=head3 The cursor moves when selecting text in the current input line, how do I switch this off?
511
512See next entry.
513
514=head3 During rlogin/ssh/telnet/etc. sessions, clicking near the cursor outputs strange escape sequences, how do I fix this?
515
516These are caused by the C<readline> perl extension. Under normal
517circumstances, it will move your cursor around when you click into the
518line that contains it. It tries hard not to do this at the wrong moment,
519but when running a program that doesn't parse cursor movements or in some
520cases during rlogin sessions, it fails to detect this properly.
521
522You can permanently switch this feature off by disabling the C<readline>
523extension:
524
525 URxvt.perl-ext-common: default,-readline
526
527=head3 My numerical keypad acts weird and generates differing output?
528
529Some Debian GNUL/Linux users seem to have this problem, although no
530specific details were reported so far. It is possible that this is caused
531by the wrong C<TERM> setting, although the details of whether and how
532this can happen are unknown, as C<TERM=rxvt> should offer a compatible
533keymap. See the answer to the previous question, and please report if that
534helped.
535
536=head3 My Compose (Multi_key) key is no longer working.
537
538The most common causes for this are that either your locale is not set
539correctly, or you specified a B<preeditStyle> that is not supported by
540your input method. For example, if you specified B<OverTheSpot> and
541your input method (e.g. the default input method handling Compose keys)
542does not support this (for instance because it is not visual), then
543rxvt-unicode will continue without an input method.
544
545In this case either do not specify a B<preeditStyle> or specify more than
546one pre-edit style, such as B<OverTheSpot,Root,None>.
547
548=head3 I cannot type C<Ctrl-Shift-2> to get an ASCII NUL character due to ISO 14755
549
550Either try C<Ctrl-2> alone (it often is mapped to ASCII NUL even on
551international keyboards) or simply use ISO 14755 support to your
552advantage, typing <Ctrl-Shift-0> to get a ASCII NUL. This works for other
553codes, too, such as C<Ctrl-Shift-1-d> to type the default telnet escape
554character and so on.
555
556=head3 Mouse cut/paste suddenly no longer works.
557
558Make sure that mouse reporting is actually turned off since killing
559some editors prematurely may leave the mouse in mouse report mode. I've
560heard that tcsh may use mouse reporting unless it otherwise specified. A
561quick check is to see if cut/paste works when the Alt or Shift keys are
562depressed.
563
564=head3 What's with the strange Backspace/Delete key behaviour?
565
566Assuming that the physical Backspace key corresponds to the
567Backspace keysym (not likely for Linux ... see the following
568question) there are two standard values that can be used for
569Backspace: C<^H> and C<^?>.
570
571Historically, either value is correct, but rxvt-unicode adopts the debian
572policy of using C<^?> when unsure, because it's the one and only correct
573choice :).
574
575Rxvt-unicode tries to inherit the current stty settings and uses the value
576of `erase' to guess the value for backspace. If rxvt-unicode wasn't
577started from a terminal (say, from a menu or by remote shell), then the
578system value of `erase', which corresponds to CERASE in <termios.h>, will
579be used (which may not be the same as your stty setting).
580
581For starting a new rxvt-unicode:
582
583 # use Backspace = ^H
584 $ stty erase ^H
585 $ @@URXVT_NAME@@
586
587 # use Backspace = ^?
588 $ stty erase ^?
589 $ @@URXVT_NAME@@
590
591Toggle with C<ESC [ 36 h> / C<ESC [ 36 l>.
592
593For an existing rxvt-unicode:
594
595 # use Backspace = ^H
596 $ stty erase ^H
597 $ echo -n "^[[36h"
598
599 # use Backspace = ^?
600 $ stty erase ^?
601 $ echo -n "^[[36l"
602
603This helps satisfy some of the Backspace discrepancies that occur, but
604if you use Backspace = C<^H>, make sure that the termcap/terminfo value
605properly reflects that.
606
607The Delete key is a another casualty of the ill-defined Backspace problem.
608To avoid confusion between the Backspace and Delete keys, the Delete
609key has been assigned an escape sequence to match the vt100 for Execute
610(C<ESC [ 3 ~>) and is in the supplied termcap/terminfo.
611
612Some other Backspace problems:
613
614some editors use termcap/terminfo,
615some editors (vim I'm told) expect Backspace = ^H,
616GNU Emacs (and Emacs-like editors) use ^H for help.
617
618Perhaps someday this will all be resolved in a consistent manner.
619
620=head3 I don't like the key-bindings. How do I change them?
621
622There are some compile-time selections available via configure. Unless
623you have run "configure" with the C<--disable-resources> option you can
624use the `keysym' resource to alter the keystrings associated with keysyms.
625
626Here's an example for a URxvt session started using C<@@URXVT_NAME@@ -name URxvt>
627
628 URxvt.keysym.Home: \033[1~
629 URxvt.keysym.End: \033[4~
630 URxvt.keysym.C-apostrophe: \033<C-'>
631 URxvt.keysym.C-slash: \033<C-/>
632 URxvt.keysym.C-semicolon: \033<C-;>
633 URxvt.keysym.C-grave: \033<C-`>
634 URxvt.keysym.C-comma: \033<C-,>
635 URxvt.keysym.C-period: \033<C-.>
636 URxvt.keysym.C-0x60: \033<C-`>
637 URxvt.keysym.C-Tab: \033<C-Tab>
638 URxvt.keysym.C-Return: \033<C-Return>
639 URxvt.keysym.S-Return: \033<S-Return>
640 URxvt.keysym.S-space: \033<S-Space>
641 URxvt.keysym.M-Up: \033<M-Up>
642 URxvt.keysym.M-Down: \033<M-Down>
643 URxvt.keysym.M-Left: \033<M-Left>
644 URxvt.keysym.M-Right: \033<M-Right>
645 URxvt.keysym.M-C-0: list \033<M-C- 0123456789 >
646 URxvt.keysym.M-C-a: list \033<M-C- abcdefghijklmnopqrstuvwxyz >
647 URxvt.keysym.F12: command:\033]701;zh_CN.GBK\007
648
649See some more examples in the documentation for the B<keysym> resource.
650
651=head3 I'm using keyboard model XXX that has extra Prior/Next/Insert keys. How do I make use of them? For example, the Sun Keyboard type 4 has the following map
652
653 KP_Insert == Insert
654 F22 == Print
655 F27 == Home
656 F29 == Prior
657 F33 == End
658 F35 == Next
659
660Rather than have rxvt-unicode try to accommodate all the various possible
661keyboard mappings, it is better to use `xmodmap' to remap the keys as
662required for your particular machine.
663
664
665=head2 Terminal Configuration
666
667=head3 Can I see a typical configuration?
668
669The default configuration tries to be xterm-like, which I don't like that
670much, but it's least surprise to regular users.
671
672As a rxvt or rxvt-unicode user, you are practically supposed to invest
673time into customising your terminal. To get you started, here is the
674author's .Xdefaults entries, with comments on what they do. It's certainly
675not I<typical>, but what's typical...
676
677 URxvt.cutchars: "()*,<>[]{}|'
678 URxvt.print-pipe: cat >/tmp/xxx
679
680These are just for testing stuff.
681
682 URxvt.imLocale: ja_JP.UTF-8
683 URxvt.preeditType: OnTheSpot,None
684
685This tells rxvt-unicode to use a special locale when communicating with
686the X Input Method, and also tells it to only use the OnTheSpot pre-edit
687type, which requires the C<xim-onthespot> perl extension but rewards me
688with correct-looking fonts.
689
690 URxvt.perl-lib: /root/lib/urxvt
691 URxvt.perl-ext-common: default,selection-autotransform,selection-pastebin,xim-onthespot,remote-clipboard
692 URxvt.selection.pattern-0: ( at .*? line \\d+)
693 URxvt.selection.pattern-1: ^(/[^:]+):\
694 URxvt.selection-autotransform.0: s/^([^:[:space:]]+):(\\d+):?$/:e \\Q$1\\E\\x0d:$2\\x0d/
695 URxvt.selection-autotransform.1: s/^ at (.*?) line (\\d+)$/:e \\Q$1\\E\\x0d:$2\\x0d/
696
697This is my perl configuration. The first two set the perl library
698directory and also tells urxvt to use a large number of extensions. I
699develop for myself mostly, so I actually use most of the extensions I
700write.
701
702The selection stuff mainly makes the selection perl-error-message aware
703and tells it to convert perl error messages into vi-commands to load the
704relevant file and go tot he error line number.
705
706 URxvt.scrollstyle: plain
707 URxvt.secondaryScroll: true
708
709As the documentation says: plain is the preferred scrollbar for the
710author. The C<secondaryScroll> configures urxvt to scroll in full-screen
711apps, like screen, so lines scrolled out of screen end up in urxvt's
712scrollback buffer.
713
714 URxvt.background: #000000
715 URxvt.foreground: gray90
716 URxvt.color7: gray90
717 URxvt.colorBD: #ffffff
718 URxvt.cursorColor: #e0e080
719 URxvt.throughColor: #8080f0
720 URxvt.highlightColor: #f0f0f0
721
722Some colours. Not sure which ones are being used or even non-defaults, but
723these are in my .Xdefaults. Most notably, they set foreground/background
724to light gray/black, and also make sure that the colour 7 matches the
725default foreground colour.
726
727 URxvt.underlineColor: yellow
728
729Another colour, makes underline lines look different. Sometimes hurts, but
730is mostly a nice effect.
731
732 URxvt.geometry: 154x36
733 URxvt.loginShell: false
734 URxvt.meta: ignore
735 URxvt.utmpInhibit: true
736
737Uh, well, should be mostly self-explanatory. By specifying some defaults
738manually, I can quickly switch them for testing.
739
740 URxvt.saveLines: 8192
741
742A large scrollback buffer is essential. Really.
743
744 URxvt.mapAlert: true
745
746The only case I use it is for my IRC window, which I like to keep
747iconified till people msg me (which beeps).
748
749 URxvt.visualBell: true
750
751The audible bell is often annoying, especially when in a crowd.
752
753 URxvt.insecure: true
754
755Please don't hack my mutt! Ooops...
756
757 URxvt.pastableTabs: false
758
759I once thought this is a great idea.
760
761 urxvt.font: 9x15bold,\
762 -misc-fixed-bold-r-normal--15-140-75-75-c-90-iso10646-1,\
763 -misc-fixed-medium-r-normal--15-140-75-75-c-90-iso10646-1, \
764 [codeset=JISX0208]xft:Kochi Gothic, \
765 xft:Bitstream Vera Sans Mono:autohint=true, \
766 xft:Code2000:antialias=false
767 urxvt.boldFont: -xos4-terminus-bold-r-normal--14-140-72-72-c-80-iso8859-15
768 urxvt.italicFont: xft:Bitstream Vera Sans Mono:italic:autohint=true
769 urxvt.boldItalicFont: xft:Bitstream Vera Sans Mono:bold:italic:autohint=true
770
771I wrote rxvt-unicode to be able to specify fonts exactly. So don't be
772overwhelmed. A special note: the C<9x15bold> mentioned above is actually
773the version from XFree-3.3, as XFree-4 replaced it by a totally different
774font (different glyphs for C<;> and many other harmless characters),
775while the second font is actually the C<9x15bold> from XFree4/XOrg. The
776bold version has less chars than the medium version, so I use it for rare
777characters, too. When editing sources with vim, I use italic for comments
778and other stuff, which looks quite good with Bitstream Vera anti-aliased.
779
780Terminus is a quite bad font (many very wrong glyphs), but for most of my
781purposes, it works, and gives a different look, as my normal (Non-bold)
782font is already bold, and I want to see a difference between bold and
783normal fonts.
784
785Please note that I used the C<urxvt> instance name and not the C<URxvt>
786class name. Thats because I use different configs for different purposes,
787for example, my IRC window is started with C<-name IRC>, and uses these
788defaults:
789
790 IRC*title: IRC
791 IRC*geometry: 87x12+535+542
792 IRC*saveLines: 0
793 IRC*mapAlert: true
794 IRC*font: suxuseuro
795 IRC*boldFont: suxuseuro
796 IRC*colorBD: white
797 IRC*keysym.M-C-1: command:\033]710;suxuseuro\007\033]711;suxuseuro\007
798 IRC*keysym.M-C-2: command:\033]710;9x15bold\007\033]711;9x15bold\007
799
800C<Alt-Shift-1> and C<Alt-Shift-2> switch between two different font
801sizes. C<suxuseuro> allows me to keep an eye (and actually read)
802stuff while keeping a very small window. If somebody pastes something
803complicated (e.g. japanese), I temporarily switch to a larger font.
804
805The above is all in my C<.Xdefaults> (I don't use C<.Xresources> nor
806C<xrdb>). I also have some resources in a separate C<.Xdefaults-hostname>
807file for different hosts, for example, on ym main desktop, I use:
808
809 URxvt.keysym.C-M-q: command:\033[3;5;5t
810 URxvt.keysym.C-M-y: command:\033[3;5;606t
811 URxvt.keysym.C-M-e: command:\033[3;1605;5t
812 URxvt.keysym.C-M-c: command:\033[3;1605;606t
813 URxvt.keysym.C-M-p: perl:test
814
815The first for keysym definitions allow me to quickly bring some windows
816in the layout I like most. Ion users might start laughing but will stop
817immediately when I tell them that I use my own Fvwm2 module for much the
818same effect as Ion provides, and I only very rarely use the above key
819combinations :->
820
821=head3 Why doesn't rxvt-unicode read my resources?
822
823Well, why, indeed? It does, in a way very similar to other X
824applications. Most importantly, this means that if you or your OS loads
825resources into the X display (the right way to do it), rxvt-unicode will
826ignore any resource files in your home directory. It will only read
827F<$HOME/.Xdefaults> when no resources are attached to the display.
828
829If you have or use an F<$HOME/.Xresources> file, chances are that
830resources are loaded into your X-server. In this case, you have to
831re-login after every change (or run F<xrdb -merge $HOME/.Xresources>).
832
833Also consider the form resources have to use:
834
835 URxvt.resource: value
836
837If you want to use another form (there are lots of different ways of
838specifying resources), make sure you understand whether and why it
839works. If unsure, use the form above.
840
137=item When I log-in to another system it tells me about missing terminfo data? 841=head3 When I log-in to another system it tells me about missing terminfo data?
138 842
139The terminal description used by rxvt-unicode is not as widely available 843The terminal description used by rxvt-unicode is not as widely available
140as that for xterm, or even rxvt (for which the same problem often arises). 844as that for xterm, or even rxvt (for which the same problem often arises).
141 845
142The correct solution for this problem is to install the terminfo, this can 846The correct solution for this problem is to install the terminfo, this can
143be done like this (with ncurses' infocmp): 847be done like this (with ncurses' infocmp and works as user and admin):
144 848
145 REMOTE=remotesystem.domain 849 REMOTE=remotesystem.domain
146 infocmp rxvt-unicode | ssh $REMOTE "cat >/tmp/ti && tic /tmp/ti" 850 infocmp rxvt-unicode | ssh $REMOTE "mkdir -p .terminfo && cat >/tmp/ti && tic /tmp/ti"
147 851
148... or by installing rxvt-unicode normally on the remote system, 852... or by installing rxvt-unicode normally on the remote system,
853
854One some systems you might need to set C<$TERMINFO> to the full path of
855F<$HOME/.terminfo> for this to work.
149 856
150If you cannot or do not want to do this, then you can simply set 857If you cannot or do not want to do this, then you can simply set
151C<TERM=rxvt> or even C<TERM=xterm>, and live with the small number of 858C<TERM=rxvt> or even C<TERM=xterm>, and live with the small number of
152problems arising, which includes wrong keymapping, less and different 859problems arising, which includes wrong keymapping, less and different
153colours and some refresh errors in fullscreen applications. It's a nice 860colours and some refresh errors in fullscreen applications. It's a nice
158resource to set it: 865resource to set it:
159 866
160 URxvt.termName: rxvt 867 URxvt.termName: rxvt
161 868
162If you don't plan to use B<rxvt> (quite common...) you could also replace 869If you don't plan to use B<rxvt> (quite common...) you could also replace
163the rxvt terminfo file with the rxvt-unicode one. 870the rxvt terminfo file with the rxvt-unicode one and use C<TERM=rxvt>.
164 871
165=item C<tic> outputs some error when compiling the terminfo entry. 872=head3 C<tic> outputs some error when compiling the terminfo entry.
166 873
167Most likely it's the empty definition for C<enacs=>. Just replace it by 874Most likely it's the empty definition for C<enacs=>. Just replace it by
168C<enacs=\E[0@> and try again. 875C<enacs=\E[0@> and try again.
169 876
170=item C<bash>'s readline does not work correctly under @@RXVT_NAME@@. 877=head3 C<bash>'s readline does not work correctly under @@URXVT_NAME@@.
171 878
879See next entry.
880
172=item I need a termcap file entry. 881=head3 I need a termcap file entry.
173 882
174One reason you might want this is that some distributions or operating 883One reason you might want this is that some distributions or operating
175systems still compile some programs using the long-obsoleted termcap 884systems still compile some programs using the long-obsoleted termcap
176library (Fedora Core's bash is one example) and rely on a termcap entry 885library (Fedora Core's bash is one example) and rely on a termcap entry
177for C<rxvt-unicode>. 886for C<rxvt-unicode>.
178 887
179You could use rxvt's termcap entry with resonable results in many cases. 888You could use rxvt's termcap entry with reasonable results in many cases.
180You can also create a termcap entry by using terminfo's infocmp program 889You can also create a termcap entry by using terminfo's infocmp program
181like this: 890like this:
182 891
183 infocmp -C rxvt-unicode 892 infocmp -C rxvt-unicode
184 893
203 :sc=\E7:se=\E[27m:sf=^J:so=\E[7m:sr=\EM:st=\EH:ta=^I:\ 912 :sc=\E7:se=\E[27m:sf=^J:so=\E[7m:sr=\EM:st=\EH:ta=^I:\
204 :te=\E[r\E[?1049l:ti=\E[?1049h:ue=\E[24m:up=\E[A:\ 913 :te=\E[r\E[?1049l:ti=\E[?1049h:ue=\E[24m:up=\E[A:\
205 :us=\E[4m:vb=\E[?5h\E[?5l:ve=\E[?25h:vi=\E[?25l:\ 914 :us=\E[4m:vb=\E[?5h\E[?5l:ve=\E[?25h:vi=\E[?25l:\
206 :vs=\E[?25h: 915 :vs=\E[?25h:
207 916
208=item Why does C<ls> no longer have coloured output? 917=head3 Why does C<ls> no longer have coloured output?
209 918
210The C<ls> in the GNU coreutils unfortunately doesn't use terminfo to 919The C<ls> in the GNU coreutils unfortunately doesn't use terminfo to
211decide wether a terminal has colour, but uses it's own configuration 920decide whether a terminal has colour, but uses its own configuration
212file. Needless to say, C<rxvt-unicode> is not in it's default file (among 921file. Needless to say, C<rxvt-unicode> is not in its default file (among
213with most other terminals supporting colour). Either add: 922with most other terminals supporting colour). Either add:
214 923
215 TERM rxvt-unicode 924 TERM rxvt-unicode
216 925
217to C</etc/DIR_COLORS> or simply add: 926to C</etc/DIR_COLORS> or simply add:
218 927
219 alias ls='ls --color=auto' 928 alias ls='ls --color=auto'
220 929
221to your C<.profile> or C<.bashrc>. 930to your C<.profile> or C<.bashrc>.
222 931
223=item Why doesn't vim/emacs etc. use the 88 colour mode? 932=head3 Why doesn't vim/emacs etc. use the 88 colour mode?
224 933
934See next entry.
935
225=item Why doesn't vim/emacs etc. make use of italic? 936=head3 Why doesn't vim/emacs etc. make use of italic?
226 937
938See next entry.
939
227=item Why are the secondary screen-related options not working properly? 940=head3 Why are the secondary screen-related options not working properly?
228 941
229Make sure you are using C<TERM=rxvt-unicode>. Some pre-packaged 942Make sure you are using C<TERM=rxvt-unicode>. Some pre-packaged
230distributions (most notably Debian GNU/Linux) break rxvt-unicode 943distributions (most notably Debian GNU/Linux) break rxvt-unicode
231by setting C<TERM> to C<rxvt>, which doesn't have these extra 944by setting C<TERM> to C<rxvt>, which doesn't have these extra
232features. Unfortunately, some of these (most notably, again, Debian 945features. Unfortunately, some of these (most notably, again, Debian
233GNU/Linux) furthermore fail to even install the C<rxvt-unicode> terminfo 946GNU/Linux) furthermore fail to even install the C<rxvt-unicode> terminfo
234file, so you will need to install it on your own (See the question B<When 947file, so you will need to install it on your own (See the question B<When
235I log-in to another system it tells me about missing terminfo data?> on 948I log-in to another system it tells me about missing terminfo data?> on
236how to do this). 949how to do this).
237 950
238=item My numerical keypad acts weird and generates differing output?
239 951
240Some Debian GNUL/Linux users seem to have this problem, although no 952=head2 Encoding / Locale / Input Method Issues
241specific details were reported so far. It is possible that this is caused
242by the wrong C<TERM> setting, although the details of wether and how
243this can happen are unknown, as C<TERM=rxvt> should offer a compatible
244keymap. See the answer to the previous question, and please report if that
245helped.
246 953
247=item Rxvt-unicode does not seem to understand the selected encoding? 954=head3 Rxvt-unicode does not seem to understand the selected encoding?
248 955
956See next entry.
957
249=item Unicode does not seem to work? 958=head3 Unicode does not seem to work?
250 959
251If you encounter strange problems like typing an accented character but 960If you encounter strange problems like typing an accented character but
252getting two unrelated other characters or similar, or if program output is 961getting two unrelated other characters or similar, or if program output is
253subtly garbled, then you should check your locale settings. 962subtly garbled, then you should check your locale settings.
254 963
255Rxvt-unicode must be started with the same C<LC_CTYPE> setting as the 964Rxvt-unicode must be started with the same C<LC_CTYPE> setting as the
256programs. Often rxvt-unicode is started in the C<C> locale, while the 965programs running in it. Often rxvt-unicode is started in the C<C> locale,
257login script running within the rxvt-unicode window changes the locale to 966while the login script running within the rxvt-unicode window changes the
258something else, e.g. C<en_GB.UTF-8>. Needless to say, this is not going to work. 967locale to something else, e.g. C<en_GB.UTF-8>. Needless to say, this is
968not going to work, and is the most common cause for problems.
259 969
260The best thing is to fix your startup environment, as you will likely run 970The best thing is to fix your startup environment, as you will likely run
261into other problems. If nothing works you can try this in your .profile. 971into other problems. If nothing works you can try this in your .profile.
262 972
263 printf '\e]701;%s\007' "$LC_CTYPE" 973 printf '\33]701;%s\007' "$LC_CTYPE" # $LANG or $LC_ALL are worth a try, too
264 974
265If this doesn't work, then maybe you use a C<LC_CTYPE> specification not 975If this doesn't work, then maybe you use a C<LC_CTYPE> specification not
266supported on your systems. Some systems have a C<locale> command which 976supported on your systems. Some systems have a C<locale> command which
267displays this (also, C<perl -e0> can be used to check locale settings, as 977displays this (also, C<perl -e0> can be used to check locale settings, as
268it will complain loudly if it cannot set the locale). If it displays something 978it will complain loudly if it cannot set the locale). If it displays something
274 984
275If nothing works and you are sure that everything is set correctly then 985If nothing works and you are sure that everything is set correctly then
276you will need to remember a little known fact: Some programs just don't 986you will need to remember a little known fact: Some programs just don't
277support locales :( 987support locales :(
278 988
279=item Why do some characters look so much different than others? 989=head3 How does rxvt-unicode determine the encoding to use?
280 990
281=item How does rxvt-unicode choose fonts? 991See next entry.
282 992
283Most fonts do not contain the full range of Unicode, which is 993=head3 Is there an option to switch encodings?
284fine. Chances are that the font you (or the admin/package maintainer of
285your system/os) have specified does not cover all the characters you want
286to display.
287 994
288B<rxvt-unicode> makes a best-effort try at finding a replacement 995Unlike some other terminals, rxvt-unicode has no encoding switch, and no
289font. Often the result is fine, but sometimes the chosen font looks 996specific "utf-8" mode, such as xterm. In fact, it doesn't even know about
290bad/ugly/wrong. Some fonts have totally strange characters that don't 997UTF-8 or any other encodings with respect to terminal I/O.
291resemble the correct glyph at all, and rxvt-unicode lacks the artificial
292intelligence to detect that a specific glyph is wrong: it has to believe
293the font that the characters it claims to contain indeed look correct.
294 998
295In that case, select a font of your taste and add it to the font list, 999The reasons is that there exists a perfectly fine mechanism for selecting
296e.g.: 1000the encoding, doing I/O and (most important) communicating this to all
297 1001applications so everybody agrees on character properties such as width
298 @@RXVT_NAME@@ -fn basefont,font2,font3... 1002and code number. This mechanism is the I<locale>. Applications not using
299 1003that info will have problems (for example, C<xterm> gets the width of
300When rxvt-unicode sees a character, it will first look at the base 1004characters wrong as it uses its own, locale-independent table under all
301font. If the base font does not contain the character, it will go to the
302next font, and so on. Specifying your own fonts will also speed up this
303search and use less resources within rxvt-unicode and the X-server.
304
305The only limitation is that none of the fonts may be larger than the base
306font, as the base font defines the terminal character cell size, which
307must be the same due to the way terminals work.
308
309=item Why do some chinese characters look so different than others?
310
311This is because there is a difference between script and language --
312rxvt-unicode does not know which language the text that is output is,
313as it only knows the unicode character codes. If rxvt-unicode first
314sees a japanese/chinese character, it might choose a japanese font for
315display. Subsequent japanese characters will use that font. Now, many
316chinese characters aren't represented in japanese fonts, so when the first
317non-japanese character comes up, rxvt-unicode will look for a chinese font
318-- unfortunately at this point, it will still use the japanese font for
319chinese characters that are also in the japanese font.
320
321The workaround is easy: just tag a chinese font at the end of your font
322list (see the previous question). The key is to view the font list as
323a preference list: If you expect more japanese, list a japanese font
324first. If you expect more chinese, put a chinese font first.
325
326In the future it might be possible to switch language preferences at
327runtime (the internal data structure has no problem with using different
328fonts for the same character at the same time, but no interface for this
329has been designed yet).
330
331Until then, you might get away with switching fonts at runtime (see L<Can
332I switch the fonts at runtime?> later in this document).
333
334=item Why does rxvt-unicode sometimes leave pixel droppings?
335
336Most fonts were not designed for terminal use, which means that character
337size varies a lot. A font that is otherwise fine for terminal use might
338contain some characters that are simply too wide. Rxvt-unicode will avoid
339these characters. For characters that are just "a bit" too wide a special
340"careful" rendering mode is used that redraws adjacent characters.
341
342All of this requires that fonts do not lie about character sizes,
343however: Xft fonts often draw glyphs larger than their acclaimed bounding
344box, and rxvt-unicode has no way of detecting this (the correct way is to
345ask for the character bounding box, which unfortunately is wrong in these
346cases). 1005locales).
347 1006
348It's not clear (to me at least), wether this is a bug in Xft, freetype, 1007Rxvt-unicode uses the C<LC_CTYPE> locale category to select encoding. All
349or the respective font. If you encounter this problem you might try using 1008programs doing the same (that is, most) will automatically agree in the
350the C<-lsp> option to give the font more height. If that doesn't work, you 1009interpretation of characters.
351might be forced to use a different font.
352 1010
353All of this is not a problem when using X11 core fonts, as their bounding 1011Unfortunately, there is no system-independent way to select locales, nor
354box data is correct. 1012is there a standard on how locale specifiers will look like.
355 1013
356=item On Solaris 9, many line-drawing characters are too wide. 1014On most systems, the content of the C<LC_CTYPE> environment variable
1015contains an arbitrary string which corresponds to an already-installed
1016locale. Common names for locales are C<en_US.UTF-8>, C<de_DE.ISO-8859-15>,
1017C<ja_JP.EUC-JP>, i.e. C<language_country.encoding>, but other forms
1018(i.e. C<de> or C<german>) are also common.
357 1019
358Seems to be a known bug, read 1020Rxvt-unicode ignores all other locale categories, and except for
359L<http://nixdoc.net/files/forum/about34198.html>. Some people use the 1021the encoding, ignores country or language-specific settings,
360following ugly workaround to get non-double-wide-characters working: 1022i.e. C<de_DE.UTF-8> and C<ja_JP.UTF-8> are the normally same to
1023rxvt-unicode.
361 1024
362 #define wcwidth(x) wcwidth(x) > 1 ? 1 : wcwidth(x) 1025If you want to use a specific encoding you have to make sure you start
1026rxvt-unicode with the correct C<LC_CTYPE> category.
363 1027
364=item My Compose (Multi_key) key is no longer working. 1028=head3 Can I switch locales at runtime?
365 1029
366The most common causes for this are that either your locale is not set 1030Yes, using an escape sequence. Try something like this, which sets
367correctly, or you specified a B<preeditStyle> that is not supported by 1031rxvt-unicode's idea of C<LC_CTYPE>.
368your input method. For example, if you specified B<OverTheSpot> and
369your input method (e.g. the default input method handling Compose keys)
370does not support this (for instance because it is not visual), then
371rxvt-unicode will continue without an input method.
372 1032
373In this case either do not specify a B<preeditStyle> or specify more than 1033 printf '\33]701;%s\007' ja_JP.SJIS
374one pre-edit style, such as B<OverTheSpot,Root,None>.
375 1034
376=item I cannot type C<Ctrl-Shift-2> to get an ASCII NUL character due to ISO 14755 1035See also the previous answer.
377 1036
378Either try C<Ctrl-2> alone (it often is mapped to ASCII NUL even on 1037Sometimes this capability is rather handy when you want to work in
379international keyboards) or simply use ISO 14755 support to your 1038one locale (e.g. C<de_DE.UTF-8>) but some programs don't support it
380advantage, typing <Ctrl-Shift-0> to get a ASCII NUL. This works for other 1039(e.g. UTF-8). For example, I use this script to start C<xjdic>, which
381codes, too, such as C<Ctrl-Shift-1-d> to type the default telnet escape 1040first switches to a locale supported by xjdic and back later:
382character and so on.
383 1041
384=item How can I keep rxvt-unicode from using reverse video so much? 1042 printf '\33]701;%s\007' ja_JP.SJIS
1043 xjdic -js
1044 printf '\33]701;%s\007' de_DE.UTF-8
385 1045
386First of all, make sure you are running with the right terminal settings 1046You can also use xterm's C<luit> program, which usually works fine, except
387(C<TERM=rxvt-unicode>), which will get rid of most of these effects. Then 1047for some locales where character width differs between program- and
388make sure you have specified colours for italic and bold, as otherwise 1048rxvt-unicode-locales.
389rxvt-unicode might use reverse video to simulate the effect:
390 1049
391 URxvt.colorBD: white 1050=head3 I have problems getting my input method working.
392 URxvt.colorIT: green
393 1051
394=item Some programs assume totally weird colours (red instead of blue), how can I fix that? 1052Try a search engine, as this is slightly different for every input method server.
395 1053
396For some unexplainable reason, some rare programs assume a very weird 1054Here is a checklist:
397colour palette when confronted with a terminal with more than the standard
3988 colours (rxvt-unicode supports 88). The right fix is, of course, to fix
399these programs not to assume non-ISO colours without very good reasons.
400 1055
401In the meantime, you can either edit your C<rxvt-unicode> terminfo 1056=over 4
402definition to only claim 8 colour support or use C<TERM=rxvt>, which will
403fix colours but keep you from using other rxvt-unicode features.
404 1057
1058=item - Make sure your locale I<and> the imLocale are supported on your OS.
1059
1060Try C<locale -a> or check the documentation for your OS.
1061
1062=item - Make sure your locale or imLocale matches a locale supported by your XIM.
1063
1064For example, B<kinput2> does not support UTF-8 locales, you should use
1065C<ja_JP.EUC-JP> or equivalent.
1066
1067=item - Make sure your XIM server is actually running.
1068
1069=item - Make sure the C<XMODIFIERS> environment variable is set correctly when I<starting> rxvt-unicode.
1070
1071When you want to use e.g. B<kinput2>, it must be set to
1072C<@im=kinput2>. For B<scim>, use C<@im=SCIM>. You can see what input
1073method servers are running with this command:
1074
1075 xprop -root XIM_SERVERS
1076
1077=item
1078
1079=back
1080
1081=head3 My input method wants <some encoding> but I want UTF-8, what can I do?
1082
1083You can specify separate locales for the input method and the rest of the
1084terminal, using the resource C<imlocale>:
1085
1086 URxvt.imlocale: ja_JP.EUC-JP
1087
1088Now you can start your terminal with C<LC_CTYPE=ja_JP.UTF-8> and still
1089use your input method. Please note, however, that, depending on your Xlib
1090version, you may not be able to input characters outside C<EUC-JP> in a
1091normal way then, as your input method limits you.
1092
1093=head3 Rxvt-unicode crashes when the X Input Method changes or exits.
1094
1095Unfortunately, this is unavoidable, as the XIM protocol is racy by
1096design. Applications can avoid some crashes at the expense of memory
1097leaks, and Input Methods can avoid some crashes by careful ordering at
1098exit time. B<kinput2> (and derived input methods) generally succeeds,
1099while B<SCIM> (or similar input methods) fails. In the end, however,
1100crashes cannot be completely avoided even if both sides cooperate.
1101
1102So the only workaround is not to kill your Input Method Servers.
1103
1104
1105=head2 Operating Systems / Package Maintaining
1106
1107=head3 I am using Debian GNU/Linux and have a problem...
1108
1109The Debian GNU/Linux package of rxvt-unicode in sarge contains large
1110patches that considerably change the behaviour of rxvt-unicode (but
1111unfortunately this notice has been removed). Before reporting a bug to
1112the original rxvt-unicode author please download and install the genuine
1113version (L<http://software.schmorp.de#rxvt-unicode>) and try to reproduce
1114the problem. If you cannot, chances are that the problems are specific to
1115Debian GNU/Linux, in which case it should be reported via the Debian Bug
1116Tracking System (use C<reportbug> to report the bug).
1117
1118For other problems that also affect the Debian package, you can and
1119probably should use the Debian BTS, too, because, after all, it's also a
1120bug in the Debian version and it serves as a reminder for other users that
1121might encounter the same issue.
1122
1123=head3 I am maintaining rxvt-unicode for distribution/OS XXX, any recommendation?
1124
1125You should build one binary with the default options. F<configure>
1126now enables most useful options, and the trend goes to making them
1127runtime-switchable, too, so there is usually no drawback to enabling them,
1128except higher disk and possibly memory usage. The perl interpreter should
1129be enabled, as important functionality (menus, selection, likely more in
1130the future) depends on it.
1131
1132You should not overwrite the C<perl-ext-common> snd C<perl-ext> resources
1133system-wide (except maybe with C<defaults>). This will result in useful
1134behaviour. If your distribution aims at low memory, add an empty
1135C<perl-ext-common> resource to the app-defaults file. This will keep the
1136perl interpreter disabled until the user enables it.
1137
1138If you can/want build more binaries, I recommend building a minimal
1139one with C<--disable-everything> (very useful) and a maximal one with
1140C<--enable-everything> (less useful, it will be very big due to a lot of
1141encodings built-in that increase download times and are rarely used).
1142
1143=head3 I need to make it setuid/setgid to support utmp/ptys on my OS, is this safe?
1144
1145It should be, starting with release 7.1. You are encouraged to properly
1146install urxvt with privileges necessary for your OS now.
1147
1148When rxvt-unicode detects that it runs setuid or setgid, it will fork
1149into a helper process for privileged operations (pty handling on some
1150systems, utmp/wtmp/lastlog handling on others) and drop privileges
1151immediately. This is much safer than most other terminals that keep
1152privileges while running (but is more relevant to urxvt, as it contains
1153things as perl interpreters, which might be "helpful" to attackers).
1154
1155This forking is done as the very first within main(), which is very early
1156and reduces possible bugs to initialisation code run before main(), or
1157things like the dynamic loader of your system, which should result in very
1158little risk.
1159
405=item I am on FreeBSD and rxvt-unicode does not seem to work at all. 1160=head3 I am on FreeBSD and rxvt-unicode does not seem to work at all.
406 1161
407Rxvt-unicode requires the symbol C<__STDC_ISO_10646__> to be defined 1162Rxvt-unicode requires the symbol C<__STDC_ISO_10646__> to be defined
408in your compile environment, or an implementation that implements it, 1163in your compile environment, or an implementation that implements it,
409wether it defines the symbol or not. C<__STDC_ISO_10646__> requires that 1164whether it defines the symbol or not. C<__STDC_ISO_10646__> requires that
410B<wchar_t> is represented as unicode. 1165B<wchar_t> is represented as unicode.
411 1166
412As you might have guessed, FreeBSD does neither define this symobl nor 1167As you might have guessed, FreeBSD does neither define this symbol nor
413does it support it. Instead, it uses it's own internal representation of 1168does it support it. Instead, it uses its own internal representation of
414B<wchar_t>. This is, of course, completely fine with respect to standards. 1169B<wchar_t>. This is, of course, completely fine with respect to standards.
415 1170
416However, that means rxvt-unicode only works in C<POSIX>, C<ISO-8859-1> and 1171However, that means rxvt-unicode only works in C<POSIX>, C<ISO-8859-1> and
417C<UTF-8> locales under FreeBSD (which all use Unicode as B<wchar_t>. 1172C<UTF-8> locales under FreeBSD (which all use Unicode as B<wchar_t>.
418 1173
432 1187
433The rxvt-unicode author insists that the right way to fix this is in the 1188The rxvt-unicode author insists that the right way to fix this is in the
434system libraries once and for all, instead of forcing every app to carry 1189system libraries once and for all, instead of forcing every app to carry
435complete replacements for them :) 1190complete replacements for them :)
436 1191
437=item I use Solaris 9 and it doesn't compile/work/etc.
438
439Try the diff in F<doc/solaris9.patch> as a base. It fixes the worst
440problems with C<wcwidth> and a compile problem.
441
442=item How can I use rxvt-unicode under cygwin? 1192=head3 How can I use rxvt-unicode under cygwin?
443 1193
444rxvt-unicode should compile and run out of the box on cygwin, using 1194rxvt-unicode should compile and run out of the box on cygwin, using
445the X11 libraries that come with cygwin. libW11 emulation is no 1195the X11 libraries that come with cygwin. libW11 emulation is no
446longer supported (and makes no sense, either, as it only supported a 1196longer supported (and makes no sense, either, as it only supported a
447single font). I recommend starting the X-server in C<-multiwindow> or 1197single font). I recommend starting the X-server in C<-multiwindow> or
450 1200
451At the time of this writing, cygwin didn't seem to support any multi-byte 1201At the time of this writing, cygwin didn't seem to support any multi-byte
452encodings (you might try C<LC_CTYPE=C-UTF-8>), so you are likely limited 1202encodings (you might try C<LC_CTYPE=C-UTF-8>), so you are likely limited
453to 8-bit encodings. 1203to 8-bit encodings.
454 1204
455=item How does rxvt-unicode determine the encoding to use? 1205=head3 Character widths are not correct.
456 1206
457=item Is there an option to switch encodings? 1207urxvt uses the system wcwidth function to know the information about
1208the width of characters, so on systems with incorrect locale data you
1209will likely get bad results. Two notorious examples are Solaris 9,
1210where single-width characters like U+2514 are reported as double-width,
1211and Darwin 8, where combining chars are reported having width 1.
458 1212
459Unlike some other terminals, rxvt-unicode has no encoding switch, and no 1213The solution is to upgrade your system or switch to a better one. A
460specific "utf-8" mode, such as xterm. In fact, it doesn't even know about 1214possibly working workaround is to use a wcwidth implementation like
461UTF-8 or any other encodings with respect to terminal I/O.
462 1215
463The reasons is that there exists a perfectly fine mechanism for selecting 1216http://www.cl.cam.ac.uk/~mgk25/ucs/wcwidth.c
464the encoding, doing I/O and (most important) communicating this to all
465applications so everybody agrees on character properties such as width
466and code number. This mechanism is the I<locale>. Applications not using
467that info will have problems (for example, C<xterm> gets the width of
468characters wrong as it uses it's own, locale-independent table under all
469locales).
470 1217
471Rxvt-unicode uses the C<LC_CTYPE> locale category to select encoding. All
472programs doing the same (that is, most) will automatically agree in the
473interpretation of characters.
474
475Unfortunately, there is no system-independent way to select locales, nor
476is there a standard on how locale specifiers will look like.
477
478On most systems, the content of the C<LC_CTYPE> environment variable
479contains an arbitrary string which corresponds to an already-installed
480locale. Common names for locales are C<en_US.UTF-8>, C<de_DE.ISO-8859-15>,
481C<ja_JP.EUC-JP>, i.e. C<language_country.encoding>, but other forms
482(i.e. C<de> or C<german>) are also common.
483
484Rxvt-unicode ignores all other locale categories, and except for
485the encoding, ignores country or language-specific settings,
486i.e. C<de_DE.UTF-8> and C<ja_JP.UTF-8> are the normally same to
487rxvt-unicode.
488
489If you want to use a specific encoding you have to make sure you start
490rxvt-unicode with the correct C<LC_CTYPE> category.
491
492=item Can I switch locales at runtime?
493
494Yes, using an escape sequence. Try something like this, which sets
495rxvt-unicode's idea of C<LC_CTYPE>.
496
497 printf '\e]701;%s\007' ja_JP.SJIS
498
499See also the previous answer.
500
501Sometimes this capability is rather handy when you want to work in
502one locale (e.g. C<de_DE.UTF-8>) but some programs don't support it
503(e.g. UTF-8). For example, I use this script to start C<xjdic>, which
504first switches to a locale supported by xjdic and back later:
505
506 printf '\e]701;%s\007' ja_JP.SJIS
507 xjdic -js
508 printf '\e]701;%s\007' de_DE.UTF-8
509
510You can also use xterm's C<luit> program, which usually works fine, except
511for some locales where character width differs between program- and
512rxvt-unicode-locales.
513
514=item Can I switch the fonts at runtime?
515
516Yes, using an escape sequence. Try something like this, which has the same
517effect as using the C<-fn> switch, and takes effect immediately:
518
519 printf '\e]50;%s\007' "9x15bold,xft:Kochi Gothic"
520
521This is useful if you e.g. work primarily with japanese (and prefer a
522japanese font), but you have to switch to chinese temporarily, where
523japanese fonts would only be in your way.
524
525You can think of this as a kind of manual ISO-2022 switching.
526
527=item Why do italic characters look as if clipped?
528
529Many fonts have difficulties with italic characters and hinting. For
530example, the otherwise very nicely hinted font C<xft:Bitstream Vera Sans
531Mono> completely fails in it's italic face. A workaround might be to
532enable freetype autohinting, i.e. like this:
533
534 URxvt.italicFont: xft:Bitstream Vera Sans Mono:italic:autohint=true
535 URxvt.boldItalicFont: xft:Bitstream Vera Sans Mono:bold:italic:autohint=true
536
537=item My input method wants <some encoding> but I want UTF-8, what can I do?
538
539You can specify separate locales for the input method and the rest of the
540terminal, using the resource C<imlocale>:
541
542 URxvt*imlocale: ja_JP.EUC-JP
543
544Now you can start your terminal with C<LC_CTYPE=ja_JP.UTF-8> and still
545use your input method. Please note, however, that you will not be able to
546input characters outside C<EUC-JP> in a normal way then, as your input
547method limits you.
548
549=item Rxvt-unicode crashes when the X Input Method changes or exits.
550
551Unfortunately, this is unavoidable, as the XIM protocol is racy by
552design. Applications can avoid some crashes at the expense of memory
553leaks, and Input Methods can avoid some crashes by careful ordering at
554exit time. B<kinput2> (and derived input methods) generally succeeds,
555while B<SCIM> (or similar input methods) fails. In the end, however,
556crashes cannot be completely avoided even if both sides cooperate.
557
558So the only workaround is not to kill your Input Method Servers.
559
560=item Rxvt-unicode uses gobs of memory, how can I reduce that?
561
562Rxvt-unicode tries to obey the rule of not charging you for something you
563don't use. One thing you should try is to configure out all settings that
564you don't need, for example, Xft support is a resource hog by design,
565when used. Compiling it out ensures that no Xft font will be loaded
566accidentally when rxvt-unicode tries to find a font for your characters.
567
568Also, many people (me included) like large windows and even larger
569scrollback buffers: Without C<--enable-unicode3>, rxvt-unicode will use
5706 bytes per screen cell. For a 160x?? window this amounts to almost a
571kilobyte per line. A scrollback buffer of 10000 lines will then (if full)
572use 10 Megabytes of memory. With C<--enable-unicode3> it gets worse, as
573rxvt-unicode then uses 8 bytes per screen cell.
574
575=item Can I speed up Xft rendering somehow?
576
577Yes, the most obvious way to speed it up is to avoid Xft entirely, as
578it is simply slow. If you still want Xft fonts you might try to disable
579antialiasing (by appending C<:antialias=false>), which saves lots of
580memory and also speeds up rendering considerably.
581
582=item Rxvt-unicode doesn't seem to anti-alias its fonts, what is wrong?
583
584Rxvt-unicode will use whatever you specify as a font. If it needs to
585fall back to it's default font search list it will prefer X11 core
586fonts, because they are small and fast, and then use Xft fonts. It has
587antialiasing disabled for most of them, because the author thinks they
588look best that way.
589
590If you want antialiasing, you have to specify the fonts manually.
591
592=item Mouse cut/paste suddenly no longer works.
593
594Make sure that mouse reporting is actually turned off since killing
595some editors prematurely may leave the mouse in mouse report mode. I've
596heard that tcsh may use mouse reporting unless it otherwise specified. A
597quick check is to see if cut/paste works when the Alt or Shift keys are
598depressed. See @@RXVT_NAME@@(7)
599
600=item What's with this bold/blink stuff?
601
602If no bold colour is set via C<colorBD:>, bold will invert text using the
603standard foreground colour.
604
605For the standard background colour, blinking will actually make the
606text blink when compiled with C<--enable-blinking>. with standard
607colours. Without C<--enable-blinking>, the blink attribute will be
608ignored.
609
610On ANSI colours, bold/blink attributes are used to set high-intensity
611foreground/background colors.
612
613color0-7 are the low-intensity colors.
614
615color8-15 are the corresponding high-intensity colors.
616
617=item I don't like the screen colors. How do I change them?
618
619You can change the screen colors at run-time using F<~/.Xdefaults>
620resources (or as long-options).
621
622Here are values that are supposed to resemble a VGA screen,
623including the murky brown that passes for low-intensity yellow:
624
625 URxvt.color0: #000000
626 URxvt.color1: #A80000
627 URxvt.color2: #00A800
628 URxvt.color3: #A8A800
629 URxvt.color4: #0000A8
630 URxvt.color5: #A800A8
631 URxvt.color6: #00A8A8
632 URxvt.color7: #A8A8A8
633
634 URxvt.color8: #000054
635 URxvt.color9: #FF0054
636 URxvt.color10: #00FF54
637 URxvt.color11: #FFFF54
638 URxvt.color12: #0000FF
639 URxvt.color13: #FF00FF
640 URxvt.color14: #00FFFF
641 URxvt.color15: #FFFFFF
642
643And here is a more complete set of non-standard colors described (not by
644me) as "pretty girly".
645
646 URxvt.cursorColor: #dc74d1
647 URxvt.pointerColor: #dc74d1
648 URxvt.background: #0e0e0e
649 URxvt.foreground: #4ad5e1
650 URxvt.color0: #000000
651 URxvt.color8: #8b8f93
652 URxvt.color1: #dc74d1
653 URxvt.color9: #dc74d1
654 URxvt.color2: #0eb8c7
655 URxvt.color10: #0eb8c7
656 URxvt.color3: #dfe37e
657 URxvt.color11: #dfe37e
658 URxvt.color5: #9e88f0
659 URxvt.color13: #9e88f0
660 URxvt.color6: #73f7ff
661 URxvt.color14: #73f7ff
662 URxvt.color7: #e1dddd
663 URxvt.color15: #e1dddd
664
665=item How can I start @@RXVT_NAME@@d in a race-free way?
666
667Try C<@@RXVT_NAME@@d -f -o>, which tells @@RXVT_NAME@@d to open the
668display, create the listening socket and then fork.
669
670=item What's with the strange Backspace/Delete key behaviour?
671
672Assuming that the physical Backspace key corresponds to the
673BackSpace keysym (not likely for Linux ... see the following
674question) there are two standard values that can be used for
675Backspace: C<^H> and C<^?>.
676
677Historically, either value is correct, but rxvt-unicode adopts the debian
678policy of using C<^?> when unsure, because it's the one only only correct
679choice :).
680
681Rxvt-unicode tries to inherit the current stty settings and uses the value
682of `erase' to guess the value for backspace. If rxvt-unicode wasn't
683started from a terminal (say, from a menu or by remote shell), then the
684system value of `erase', which corresponds to CERASE in <termios.h>, will
685be used (which may not be the same as your stty setting).
686
687For starting a new rxvt-unicode:
688
689 # use Backspace = ^H
690 $ stty erase ^H
691 $ @@RXVT_NAME@@
692
693 # use Backspace = ^?
694 $ stty erase ^?
695 $ @@RXVT_NAME@@
696
697Toggle with C<ESC [ 36 h> / C<ESC [ 36 l> as documented in @@RXVT_NAME@@(7).
698
699For an existing rxvt-unicode:
700
701 # use Backspace = ^H
702 $ stty erase ^H
703 $ echo -n "^[[36h"
704
705 # use Backspace = ^?
706 $ stty erase ^?
707 $ echo -n "^[[36l"
708
709This helps satisfy some of the Backspace discrepancies that occur, but
710if you use Backspace = C<^H>, make sure that the termcap/terminfo value
711properly reflects that.
712
713The Delete key is a another casualty of the ill-defined Backspace problem.
714To avoid confusion between the Backspace and Delete keys, the Delete
715key has been assigned an escape sequence to match the vt100 for Execute
716(C<ESC [ 3 ~>) and is in the supplied termcap/terminfo.
717
718Some other Backspace problems:
719
720some editors use termcap/terminfo,
721some editors (vim I'm told) expect Backspace = ^H,
722GNU Emacs (and Emacs-like editors) use ^H for help.
723
724Perhaps someday this will all be resolved in a consistent manner.
725
726=item I don't like the key-bindings. How do I change them?
727
728There are some compile-time selections available via configure. Unless
729you have run "configure" with the C<--disable-resources> option you can
730use the `keysym' resource to alter the keystrings associated with keysyms.
731
732Here's an example for a URxvt session started using C<@@RXVT_NAME@@ -name URxvt>
733
734 URxvt.keysym.Home: \033[1~
735 URxvt.keysym.End: \033[4~
736 URxvt.keysym.C-apostrophe: \033<C-'>
737 URxvt.keysym.C-slash: \033<C-/>
738 URxvt.keysym.C-semicolon: \033<C-;>
739 URxvt.keysym.C-grave: \033<C-`>
740 URxvt.keysym.C-comma: \033<C-,>
741 URxvt.keysym.C-period: \033<C-.>
742 URxvt.keysym.C-0x60: \033<C-`>
743 URxvt.keysym.C-Tab: \033<C-Tab>
744 URxvt.keysym.C-Return: \033<C-Return>
745 URxvt.keysym.S-Return: \033<S-Return>
746 URxvt.keysym.S-space: \033<S-Space>
747 URxvt.keysym.M-Up: \033<M-Up>
748 URxvt.keysym.M-Down: \033<M-Down>
749 URxvt.keysym.M-Left: \033<M-Left>
750 URxvt.keysym.M-Right: \033<M-Right>
751 URxvt.keysym.M-C-0: list \033<M-C- 0123456789 >
752 URxvt.keysym.M-C-a: list \033<M-C- abcdefghijklmnopqrstuvwxyz >
753 URxvt.keysym.F12: command:\033]701;zh_CN.GBK\007
754
755See some more examples in the documentation for the B<keysym> resource.
756
757=item I'm using keyboard model XXX that has extra Prior/Next/Insert keys.
758How do I make use of them? For example, the Sun Keyboard type 4
759has the following mappings that rxvt-unicode doesn't recognize.
760
761 KP_Insert == Insert
762 F22 == Print
763 F27 == Home
764 F29 == Prior
765 F33 == End
766 F35 == Next
767
768Rather than have rxvt-unicode try to accommodate all the various possible
769keyboard mappings, it is better to use `xmodmap' to remap the keys as
770required for your particular machine.
771
772=item How do I distinguish wether I'm running rxvt-unicode or a regular xterm?
773I need this to decide about setting colors etc.
774
775rxvt and rxvt-unicode always export the variable "COLORTERM", so you can
776check and see if that is set. Note that several programs, JED, slrn,
777Midnight Commander automatically check this variable to decide whether or
778not to use color.
779
780=item How do I set the correct, full IP address for the DISPLAY variable?
781
782If you've compiled rxvt-unicode with DISPLAY_IS_IP and have enabled
783insecure mode then it is possible to use the following shell script
784snippets to correctly set the display. If your version of rxvt-unicode
785wasn't also compiled with ESCZ_ANSWER (as assumed in these snippets) then
786the COLORTERM variable can be used to distinguish rxvt-unicode from a
787regular xterm.
788
789Courtesy of Chuck Blake <cblake@BBN.COM> with the following shell script
790snippets:
791
792 # Bourne/Korn/POSIX family of shells:
793 [ ${TERM:-foo} = foo ] && TERM=xterm # assume an xterm if we don't know
794 if [ ${TERM:-foo} = xterm ]; then
795 stty -icanon -echo min 0 time 15 # see if enhanced rxvt or not
796 echo -n '^[Z'
797 read term_id
798 stty icanon echo
799 if [ ""${term_id} = '^[[?1;2C' -a ${DISPLAY:-foo} = foo ]; then
800 echo -n '^[[7n' # query the rxvt we are in for the DISPLAY string
801 read DISPLAY # set it in our local shell
802 fi
803 fi
804
805=item How do I compile the manual pages for myself?
806
807You need to have a recent version of perl installed as F</usr/bin/perl>,
808one that comes with F<pod2man>, F<pod2text> and F<pod2html>. Then go to
809the doc subdirectory and enter C<make alldoc>.
810
811=item My question isn't answered here, can I ask a human?
812
813Before sending me mail, you could go to IRC: C<irc.freenode.net>,
814channel C<#rxvt-unicode> has some rxvt-unicode enthusiasts that might be
815interested in learning about new and exciting problems (but not FAQs :).
816
817=back
818
819=head1 RXVT TECHNICAL REFERENCE 1218=head1 RXVT-UNICODE TECHNICAL REFERENCE
820
821=head1 DESCRIPTION
822 1219
823The rest of this document describes various technical aspects of 1220The rest of this document describes various technical aspects of
824B<rxvt-unicode>. First the description of supported command sequences, 1221B<rxvt-unicode>. First the description of supported command sequences,
825followed by menu and pixmap support and last by a description of all 1222followed by pixmap support and last by a description of all features
826features selectable at C<configure> time. 1223selectable at C<configure> time.
827 1224
828=head1 Definitions 1225=head2 Definitions
829 1226
830=over 4 1227=over 4
831 1228
832=item B<< C<c> >> 1229=item B<< C<c> >>
833 1230
851 1248
852A text parameter composed of printable characters. 1249A text parameter composed of printable characters.
853 1250
854=back 1251=back
855 1252
856=head1 Values 1253=head2 Values
857 1254
858=over 4 1255=over 4
859 1256
860=item B<< C<ENQ> >> 1257=item B<< C<ENQ> >>
861 1258
904 1301
905Space Character 1302Space Character
906 1303
907=back 1304=back
908 1305
909=head1 Escape Sequences 1306=head2 Escape Sequences
910 1307
911=over 4 1308=over 4
912 1309
913=item B<< C<ESC # 8> >> 1310=item B<< C<ESC # 8> >>
914 1311
1012 1409
1013=back 1410=back
1014 1411
1015X<CSI> 1412X<CSI>
1016 1413
1017=head1 CSI (Command Sequence Introducer) Sequences 1414=head2 CSI (Command Sequence Introducer) Sequences
1018 1415
1019=over 4 1416=over 4
1020 1417
1021=item B<< C<ESC [ Ps @> >> 1418=item B<< C<ESC [ Ps @> >>
1022 1419
1292 1689
1293=back 1690=back
1294 1691
1295X<PrivateModes> 1692X<PrivateModes>
1296 1693
1297=head1 DEC Private Modes 1694=head2 DEC Private Modes
1298 1695
1299=over 4 1696=over 4
1300 1697
1301=item B<< C<ESC [ ? Pm h> >> 1698=item B<< C<ESC [ ? Pm h> >>
1302 1699
1318 1715
1319Toggle DEC Private Mode Values (rxvt extension). I<where> 1716Toggle DEC Private Mode Values (rxvt extension). I<where>
1320 1717
1321=over 4 1718=over 4
1322 1719
1323=item B<< C<Ps = 1> >> (DECCKM) 1720=item B<< C<Pm = 1> >> (DECCKM)
1324 1721
1325=begin table 1722=begin table
1326 1723
1327 B<< C<h> >> Application Cursor Keys 1724 B<< C<h> >> Application Cursor Keys
1328 B<< C<l> >> Normal Cursor Keys 1725 B<< C<l> >> Normal Cursor Keys
1329 1726
1330=end table 1727=end table
1331 1728
1332=item B<< C<Ps = 2> >> (ANSI/VT52 mode) 1729=item B<< C<Pm = 2> >> (ANSI/VT52 mode)
1333 1730
1334=begin table 1731=begin table
1335 1732
1336 B<< C<h> >> Enter VT52 mode 1733 B<< C<h> >> Enter VT52 mode
1337 B<< C<l> >> Enter VT52 mode 1734 B<< C<l> >> Enter VT52 mode
1338 1735
1339=end table 1736=end table
1340 1737
1341=item B<< C<Ps = 3> >> 1738=item B<< C<Pm = 3> >>
1342 1739
1343=begin table 1740=begin table
1344 1741
1345 B<< C<h> >> 132 Column Mode (DECCOLM) 1742 B<< C<h> >> 132 Column Mode (DECCOLM)
1346 B<< C<l> >> 80 Column Mode (DECCOLM) 1743 B<< C<l> >> 80 Column Mode (DECCOLM)
1347 1744
1348=end table 1745=end table
1349 1746
1350=item B<< C<Ps = 4> >> 1747=item B<< C<Pm = 4> >>
1351 1748
1352=begin table 1749=begin table
1353 1750
1354 B<< C<h> >> Smooth (Slow) Scroll (DECSCLM) 1751 B<< C<h> >> Smooth (Slow) Scroll (DECSCLM)
1355 B<< C<l> >> Jump (Fast) Scroll (DECSCLM) 1752 B<< C<l> >> Jump (Fast) Scroll (DECSCLM)
1356 1753
1357=end table 1754=end table
1358 1755
1359=item B<< C<Ps = 5> >> 1756=item B<< C<Pm = 5> >>
1360 1757
1361=begin table 1758=begin table
1362 1759
1363 B<< C<h> >> Reverse Video (DECSCNM) 1760 B<< C<h> >> Reverse Video (DECSCNM)
1364 B<< C<l> >> Normal Video (DECSCNM) 1761 B<< C<l> >> Normal Video (DECSCNM)
1365 1762
1366=end table 1763=end table
1367 1764
1368=item B<< C<Ps = 6> >> 1765=item B<< C<Pm = 6> >>
1369 1766
1370=begin table 1767=begin table
1371 1768
1372 B<< C<h> >> Origin Mode (DECOM) 1769 B<< C<h> >> Origin Mode (DECOM)
1373 B<< C<l> >> Normal Cursor Mode (DECOM) 1770 B<< C<l> >> Normal Cursor Mode (DECOM)
1374 1771
1375=end table 1772=end table
1376 1773
1377=item B<< C<Ps = 7> >> 1774=item B<< C<Pm = 7> >>
1378 1775
1379=begin table 1776=begin table
1380 1777
1381 B<< C<h> >> Wraparound Mode (DECAWM) 1778 B<< C<h> >> Wraparound Mode (DECAWM)
1382 B<< C<l> >> No Wraparound Mode (DECAWM) 1779 B<< C<l> >> No Wraparound Mode (DECAWM)
1383 1780
1384=end table 1781=end table
1385 1782
1386=item B<< C<Ps = 8> >> I<unimplemented> 1783=item B<< C<Pm = 8> >> I<unimplemented>
1387 1784
1388=begin table 1785=begin table
1389 1786
1390 B<< C<h> >> Auto-repeat Keys (DECARM) 1787 B<< C<h> >> Auto-repeat Keys (DECARM)
1391 B<< C<l> >> No Auto-repeat Keys (DECARM) 1788 B<< C<l> >> No Auto-repeat Keys (DECARM)
1392 1789
1393=end table 1790=end table
1394 1791
1395=item B<< C<Ps = 9> >> X10 XTerm 1792=item B<< C<Pm = 9> >> X10 XTerm
1396 1793
1397=begin table 1794=begin table
1398 1795
1399 B<< C<h> >> Send Mouse X & Y on button press. 1796 B<< C<h> >> Send Mouse X & Y on button press.
1400 B<< C<l> >> No mouse reporting. 1797 B<< C<l> >> No mouse reporting.
1401 1798
1402=end table 1799=end table
1403 1800
1404=item B<< C<Ps = 10> >> (B<rxvt>)
1405
1406=begin table
1407
1408 B<< C<h> >> menuBar visible
1409 B<< C<l> >> menuBar invisible
1410
1411=end table
1412
1413=item B<< C<Ps = 25> >> 1801=item B<< C<Pm = 25> >>
1414 1802
1415=begin table 1803=begin table
1416 1804
1417 B<< C<h> >> Visible cursor {cnorm/cvvis} 1805 B<< C<h> >> Visible cursor {cnorm/cvvis}
1418 B<< C<l> >> Invisible cursor {civis} 1806 B<< C<l> >> Invisible cursor {civis}
1419 1807
1420=end table 1808=end table
1421 1809
1422=item B<< C<Ps = 30> >> 1810=item B<< C<Pm = 30> >>
1423 1811
1424=begin table 1812=begin table
1425 1813
1426 B<< C<h> >> scrollBar visisble 1814 B<< C<h> >> scrollBar visisble
1427 B<< C<l> >> scrollBar invisisble 1815 B<< C<l> >> scrollBar invisisble
1428 1816
1429=end table 1817=end table
1430 1818
1431=item B<< C<Ps = 35> >> (B<rxvt>) 1819=item B<< C<Pm = 35> >> (B<rxvt>)
1432 1820
1433=begin table 1821=begin table
1434 1822
1435 B<< C<h> >> Allow XTerm Shift+key sequences 1823 B<< C<h> >> Allow XTerm Shift+key sequences
1436 B<< C<l> >> Disallow XTerm Shift+key sequences 1824 B<< C<l> >> Disallow XTerm Shift+key sequences
1437 1825
1438=end table 1826=end table
1439 1827
1440=item B<< C<Ps = 38> >> I<unimplemented> 1828=item B<< C<Pm = 38> >> I<unimplemented>
1441 1829
1442Enter Tektronix Mode (DECTEK) 1830Enter Tektronix Mode (DECTEK)
1443 1831
1444=item B<< C<Ps = 40> >> 1832=item B<< C<Pm = 40> >>
1445 1833
1446=begin table 1834=begin table
1447 1835
1448 B<< C<h> >> Allow 80/132 Mode 1836 B<< C<h> >> Allow 80/132 Mode
1449 B<< C<l> >> Disallow 80/132 Mode 1837 B<< C<l> >> Disallow 80/132 Mode
1450 1838
1451=end table 1839=end table
1452 1840
1453=item B<< C<Ps = 44> >> I<unimplemented> 1841=item B<< C<Pm = 44> >> I<unimplemented>
1454 1842
1455=begin table 1843=begin table
1456 1844
1457 B<< C<h> >> Turn On Margin Bell 1845 B<< C<h> >> Turn On Margin Bell
1458 B<< C<l> >> Turn Off Margin Bell 1846 B<< C<l> >> Turn Off Margin Bell
1459 1847
1460=end table 1848=end table
1461 1849
1462=item B<< C<Ps = 45> >> I<unimplemented> 1850=item B<< C<Pm = 45> >> I<unimplemented>
1463 1851
1464=begin table 1852=begin table
1465 1853
1466 B<< C<h> >> Reverse-wraparound Mode 1854 B<< C<h> >> Reverse-wraparound Mode
1467 B<< C<l> >> No Reverse-wraparound Mode 1855 B<< C<l> >> No Reverse-wraparound Mode
1468 1856
1469=end table 1857=end table
1470 1858
1471=item B<< C<Ps = 46> >> I<unimplemented> 1859=item B<< C<Pm = 46> >> I<unimplemented>
1472 1860
1473=item B<< C<Ps = 47> >> 1861=item B<< C<Pm = 47> >>
1474 1862
1475=begin table 1863=begin table
1476 1864
1477 B<< C<h> >> Use Alternate Screen Buffer 1865 B<< C<h> >> Use Alternate Screen Buffer
1478 B<< C<l> >> Use Normal Screen Buffer 1866 B<< C<l> >> Use Normal Screen Buffer
1479 1867
1480=end table 1868=end table
1481 1869
1482X<Priv66> 1870X<Priv66>
1483 1871
1484=item B<< C<Ps = 66> >> 1872=item B<< C<Pm = 66> >>
1485 1873
1486=begin table 1874=begin table
1487 1875
1488 B<< C<h> >> Application Keypad (DECPAM) == C<ESC => 1876 B<< C<h> >> Application Keypad (DECPAM) == C<ESC =>
1489 B<< C<l> >> Normal Keypad (DECPNM) == C<< ESC > >> 1877 B<< C<l> >> Normal Keypad (DECPNM) == C<< ESC > >>
1490 1878
1491=end table 1879=end table
1492 1880
1493=item B<< C<Ps = 67> >> 1881=item B<< C<Pm = 67> >>
1494 1882
1495=begin table 1883=begin table
1496 1884
1497 B<< C<h> >> Backspace key sends B<< C<BS> (DECBKM) >> 1885 B<< C<h> >> Backspace key sends B<< C<BS> (DECBKM) >>
1498 B<< C<l> >> Backspace key sends B<< C<DEL> >> 1886 B<< C<l> >> Backspace key sends B<< C<DEL> >>
1499 1887
1500=end table 1888=end table
1501 1889
1502=item B<< C<Ps = 1000> >> (X11 XTerm) 1890=item B<< C<Pm = 1000> >> (X11 XTerm)
1503 1891
1504=begin table 1892=begin table
1505 1893
1506 B<< C<h> >> Send Mouse X & Y on button press and release. 1894 B<< C<h> >> Send Mouse X & Y on button press and release.
1507 B<< C<l> >> No mouse reporting. 1895 B<< C<l> >> No mouse reporting.
1508 1896
1509=end table 1897=end table
1510 1898
1511=item B<< C<Ps = 1001> >> (X11 XTerm) I<unimplemented> 1899=item B<< C<Pm = 1001> >> (X11 XTerm) I<unimplemented>
1512 1900
1513=begin table 1901=begin table
1514 1902
1515 B<< C<h> >> Use Hilite Mouse Tracking. 1903 B<< C<h> >> Use Hilite Mouse Tracking.
1516 B<< C<l> >> No mouse reporting. 1904 B<< C<l> >> No mouse reporting.
1517 1905
1518=end table 1906=end table
1519 1907
1908=item B<< C<Pm = 1002> >> (X11 XTerm)
1909
1910=begin table
1911
1912 B<< C<h> >> Send Mouse X & Y on button press and release, and motion with a button pressed.
1913 B<< C<l> >> No mouse reporting.
1914
1915=end table
1916
1917=item B<< C<Pm = 1003> >> (X11 XTerm)
1918
1919=begin table
1920
1921 B<< C<h> >> Send Mouse X & Y on button press and release, and motion.
1922 B<< C<l> >> No mouse reporting.
1923
1924=end table
1925
1520=item B<< C<Ps = 1010> >> (B<rxvt>) 1926=item B<< C<Pm = 1010> >> (B<rxvt>)
1521 1927
1522=begin table 1928=begin table
1523 1929
1524 B<< C<h> >> Don't scroll to bottom on TTY output 1930 B<< C<h> >> Don't scroll to bottom on TTY output
1525 B<< C<l> >> Scroll to bottom on TTY output 1931 B<< C<l> >> Scroll to bottom on TTY output
1526 1932
1527=end table 1933=end table
1528 1934
1529=item B<< C<Ps = 1011> >> (B<rxvt>) 1935=item B<< C<Pm = 1011> >> (B<rxvt>)
1530 1936
1531=begin table 1937=begin table
1532 1938
1533 B<< C<h> >> Scroll to bottom when a key is pressed 1939 B<< C<h> >> Scroll to bottom when a key is pressed
1534 B<< C<l> >> Don't scroll to bottom when a key is pressed 1940 B<< C<l> >> Don't scroll to bottom when a key is pressed
1535 1941
1536=end table 1942=end table
1537 1943
1538=item B<< C<Ps = 1021> >> (B<rxvt>) 1944=item B<< C<Pm = 1021> >> (B<rxvt>)
1539 1945
1540=begin table 1946=begin table
1541 1947
1542 B<< C<h> >> Bold/italic implies high intensity (see option B<-is>) 1948 B<< C<h> >> Bold/italic implies high intensity (see option B<-is>)
1543 B<< C<l> >> Font styles have no effect on intensity. 1949 B<< C<l> >> Font styles have no effect on intensity (Compile styles)
1544 1950
1545=end table 1951=end table
1546 1952
1547=item B<< C<Ps = 1047> >> 1953=item B<< C<Pm = 1047> >>
1548 1954
1549=begin table 1955=begin table
1550 1956
1551 B<< C<h> >> Use Alternate Screen Buffer 1957 B<< C<h> >> Use Alternate Screen Buffer
1552 B<< C<l> >> Use Normal Screen Buffer - clear Alternate Screen Buffer if returning from it 1958 B<< C<l> >> Use Normal Screen Buffer - clear Alternate Screen Buffer if returning from it
1553 1959
1554=end table 1960=end table
1555 1961
1556=item B<< C<Ps = 1048> >> 1962=item B<< C<Pm = 1048> >>
1557 1963
1558=begin table 1964=begin table
1559 1965
1560 B<< C<h> >> Save cursor position 1966 B<< C<h> >> Save cursor position
1561 B<< C<l> >> Restore cursor position 1967 B<< C<l> >> Restore cursor position
1562 1968
1563=end table 1969=end table
1564 1970
1565=item B<< C<Ps = 1049> >> 1971=item B<< C<Pm = 1049> >>
1566 1972
1567=begin table 1973=begin table
1568 1974
1569 B<< C<h> >> Use Alternate Screen Buffer - clear Alternate Screen Buffer if switching to it 1975 B<< C<h> >> Use Alternate Screen Buffer - clear Alternate Screen Buffer if switching to it
1570 B<< C<l> >> Use Normal Screen Buffer 1976 B<< C<l> >> Use Normal Screen Buffer
1575 1981
1576=back 1982=back
1577 1983
1578X<XTerm> 1984X<XTerm>
1579 1985
1580=head1 XTerm Operating System Commands 1986=head2 XTerm Operating System Commands
1581 1987
1582=over 4 1988=over 4
1583 1989
1584=item B<< C<ESC ] Ps;Pt ST> >> 1990=item B<< C<ESC ] Ps;Pt ST> >>
1585 1991
1597 B<< C<Ps = 10> >> Change colour of text foreground to B<< C<Pt> >> B<(NB: may change in future)> 2003 B<< C<Ps = 10> >> Change colour of text foreground to B<< C<Pt> >> B<(NB: may change in future)>
1598 B<< C<Ps = 11> >> Change colour of text background to B<< C<Pt> >> B<(NB: may change in future)> 2004 B<< C<Ps = 11> >> Change colour of text background to B<< C<Pt> >> B<(NB: may change in future)>
1599 B<< C<Ps = 12> >> Change colour of text cursor foreground to B<< C<Pt> >> 2005 B<< C<Ps = 12> >> Change colour of text cursor foreground to B<< C<Pt> >>
1600 B<< C<Ps = 13> >> Change colour of mouse foreground to B<< C<Pt> >> 2006 B<< C<Ps = 13> >> Change colour of mouse foreground to B<< C<Pt> >>
1601 B<< C<Ps = 17> >> Change colour of highlight characters to B<< C<Pt> >> 2007 B<< C<Ps = 17> >> Change colour of highlight characters to B<< C<Pt> >>
1602 B<< C<Ps = 18> >> Change colour of bold characters to B<< C<Pt> >> 2008 B<< C<Ps = 18> >> Change colour of bold characters to B<< C<Pt> >> [deprecated, see 706]
1603 B<< C<Ps = 19> >> Change colour of underlined characters to B<< C<Pt> >> 2009 B<< C<Ps = 19> >> Change colour of underlined characters to B<< C<Pt> >> [deprecated, see 707]
1604 B<< C<Ps = 20> >> Change default background to B<< C<Pt> >> 2010 B<< C<Ps = 20> >> Change background pixmap parameters (see section BACKGROUND IMAGE) (Compile AfterImage).
1605 B<< C<Ps = 39> >> Change default foreground colour to B<< C<Pt> >>. 2011 B<< C<Ps = 39> >> Change default foreground colour to B<< C<Pt> >>.
1606 B<< C<Ps = 46> >> Change Log File to B<< C<Pt> >> I<unimplemented> 2012 B<< C<Ps = 46> >> Change Log File to B<< C<Pt> >> I<unimplemented>
1607 B<< C<Ps = 49> >> Change default background colour to B<< C<Pt> >>. 2013 B<< C<Ps = 49> >> Change default background colour to B<< C<Pt> >>.
1608 B<< C<Ps = 50> >> Set fontset to B<< C<Pt> >>, with the following special values of B<< C<Pt> >> (B<rxvt>) B<< C<#+n> >> change up B<< C<n> >> B<< C<#-n> >> change down B<< C<n> >> if B<< C<n> >> is missing of 0, a value of 1 is used I<empty> change to font0 B<< C<n> >> change to font B<< C<n> >> 2014 B<< C<Ps = 50> >> Set fontset to B<< C<Pt> >>, with the following special values of B<< C<Pt> >> (B<rxvt>) B<< C<#+n> >> change up B<< C<n> >> B<< C<#-n> >> change down B<< C<n> >> if B<< C<n> >> is missing of 0, a value of 1 is used I<empty> change to font0 B<< C<n> >> change to font B<< C<n> >>
1609 B<< C<Ps = 55> >> Log all scrollback buffer and all of screen to B<< C<Pt> >> 2015 B<< C<Ps = 55> >> Log all scrollback buffer and all of screen to B<< C<Pt> >>
1610 B<< C<Ps = 701> >> Change current locale to B<< C<Pt> >>, or, if B<< C<Pt> >> is B<< C<?> >>, return the current locale (Compile frills). 2016 B<< C<Ps = 701> >> Change current locale to B<< C<Pt> >>, or, if B<< C<Pt> >> is B<< C<?> >>, return the current locale (Compile frills).
1611 B<< C<Ps = 703> >> Menubar command B<< C<Pt> >> (Compile menubar). 2017 B<< C<Ps = 702> >> Request version if B<< C<Pt> >> is B<< C<?> >>, returning C<rxvt-unicode>, the resource name, the major and minor version numbers, e.g. C<ESC ] 702 ; rxvt-unicode ; urxvt ; 7 ; 4 ST>.
1612 B<< C<Ps = 704> >> Change colour of italic characters to B<< C<Pt> >> 2018 B<< C<Ps = 704> >> Change colour of italic characters to B<< C<Pt> >>
1613 B<< C<Ps = 705> >> Change background pixmap tint colour to B<< C<Pt> >> (Compile transparency). 2019 B<< C<Ps = 705> >> Change background pixmap tint colour to B<< C<Pt> >> (Compile transparency).
2020 B<< C<Ps = 706> >> Change colour of bold characters to B<< C<Pt> >>
2021 B<< C<Ps = 707> >> Change colour of underlined characters to B<< C<Pt> >>
1614 B<< C<Ps = 710> >> Set normal fontset to B<< C<Pt> >>. Same as C<Ps = 50>. 2022 B<< C<Ps = 710> >> Set normal fontset to B<< C<Pt> >>. Same as C<Ps = 50>.
1615 B<< C<Ps = 711> >> Set bold fontset to B<< C<Pt> >>. Similar to C<Ps = 50> (Compile styles). 2023 B<< C<Ps = 711> >> Set bold fontset to B<< C<Pt> >>. Similar to C<Ps = 50> (Compile styles).
1616 B<< C<Ps = 712> >> Set italic fontset to B<< C<Pt> >>. Similar to C<Ps = 50> (Compile styles). 2024 B<< C<Ps = 712> >> Set italic fontset to B<< C<Pt> >>. Similar to C<Ps = 50> (Compile styles).
1617 B<< C<Ps = 713> >> Set bold-italic fontset to B<< C<Pt> >>. Similar to C<Ps = 50> (Compile styles). 2025 B<< C<Ps = 713> >> Set bold-italic fontset to B<< C<Pt> >>. Similar to C<Ps = 50> (Compile styles).
1618 B<< C<Ps = 720> >> Move viewing window up by B<< C<Pt> >> lines, or clear scrollback buffer if C<Pt = 0> (Compile frills). 2026 B<< C<Ps = 720> >> Move viewing window up by B<< C<Pt> >> lines, or clear scrollback buffer if C<Pt = 0> (Compile frills).
1619 B<< C<Ps = 721> >> Move viewing window down by B<< C<Pt> >> lines, or clear scrollback buffer if C<Pt = 0> (Compile frills). 2027 B<< C<Ps = 721> >> Move viewing window down by B<< C<Pt> >> lines, or clear scrollback buffer if C<Pt = 0> (Compile frills).
2028 B<< C<Ps = 777> >> Call the perl extension with the given string, which should be of the form C<extension:parameters> (Compile perl).
1620 2029
1621=end table 2030=end table
1622 2031
1623=back 2032=back
1624 2033
1625X<menuBar> 2034=head1 BACKGROUND IMAGE
1626 2035
1627=head1 menuBar
1628
1629B<< The exact syntax used is I<almost> solidified. >>
1630In the menus, B<DON'T> try to use menuBar commands that add or remove a
1631menuBar.
1632
1633Note that in all of the commands, the B<< I</path/> >> I<cannot> be
1634omitted: use B<./> to specify a menu relative to the current menu.
1635
1636=head2 Overview of menuBar operation
1637
1638For the menuBar XTerm escape sequence C<ESC ] 703 ; Pt ST>, the syntax
1639of C<Pt> can be used for a variety of tasks:
1640
1641At the top level is the current menuBar which is a member of a circular
1642linked-list of other such menuBars.
1643
1644The menuBar acts as a parent for the various drop-down menus, which in
1645turn, may have labels, separator lines, menuItems and subMenus.
1646
1647The menuItems are the useful bits: you can use them to mimic keyboard
1648input or even to send text or escape sequences back to rxvt.
1649
1650The menuBar syntax is intended to provide a simple yet robust method of
1651constructing and manipulating menus and navigating through the
1652menuBars.
1653
1654The first step is to use the tag B<< [menu:I<name>] >> which creates
1655the menuBar called I<name> and allows access. You may now or menus,
1656subMenus, and menuItems. Finally, use the tag B<[done]> to set the
1657menuBar access as B<readonly> to prevent accidental corruption of the
1658menus. To re-access the current menuBar for alterations, use the tag
1659B<[menu]>, make the alterations and then use B<[done]>
1660
1661X<menuBarCommands>
1662
1663=head2 Commands
1664
1665=over 4
1666
1667=item B<< [menu:+I<name>] >>
1668
1669access the named menuBar for creation or alteration. If a new menuBar
1670is created, it is called I<name> (max of 15 chars) and the current
1671menuBar is pushed onto the stack
1672
1673=item B<[menu]>
1674
1675access the current menuBar for alteration
1676
1677=item B<< [title:+I<string>] >>
1678
1679set the current menuBar's title to I<string>, which may contain the
1680following format specifiers:
1681
1682 B<%n> rxvt name (as per the B<-name> command-line option)
1683 B<%v> rxvt version
1684 B<%%> literal B<%> character
1685
1686=item B<[done]>
1687
1688set menuBar access as B<readonly>.
1689End-of-file tag for B<< [read:+I<file>] >> operations.
1690
1691=item B<< [read:+I<file>] >>
1692
1693read menu commands directly from I<file> (extension ".menu" will be
1694appended if required.) Start reading at a line with B<[menu]> or B<<
1695[menu:+I<name> >> and continuing until B<[done]> is encountered.
1696
1697Blank and comment lines (starting with B<#>) are ignored. Actually,
1698since any invalid menu commands are also ignored, almost anything could
1699be construed as a comment line, but this may be tightened up in the
1700future ... so don't count on it!.
1701
1702=item B<< [read:+I<file>;+I<name>] >>
1703
1704The same as B<< [read:+I<file>] >>, but start reading at a line with
1705B<< [menu:+I<name>] >> and continuing until B<< [done:+I<name>] >> or
1706B<[done]> is encountered.
1707
1708=item B<[dump]>
1709
1710dump all menuBars to the file B</tmp/rxvt-PID> in a format suitable for
1711later rereading.
1712
1713=item B<[rm:name]>
1714
1715remove the named menuBar
1716
1717=item B<[rm] [rm:]>
1718
1719remove the current menuBar
1720
1721=item B<[rm*] [rm:*]>
1722
1723remove all menuBars
1724
1725=item B<[swap]>
1726
1727swap the top two menuBars
1728
1729=item B<[prev]>
1730
1731access the previous menuBar
1732
1733=item B<[next]>
1734
1735access the next menuBar
1736
1737=item B<[show]>
1738
1739Enable display of the menuBar
1740
1741=item B<[hide]>
1742
1743Disable display of the menuBar
1744
1745=item B<< [pixmap:+I<name>] >>
1746
1747=item B<< [pixmap:+I<name>;I<scaling>] >>
1748
1749(set the background pixmap globally
1750
1751B<< A Future implementation I<may> make this local to the menubar >>)
1752
1753=item B<< [:+I<command>:] >>
1754
1755ignore the menu readonly status and issue a I<command> to or a menu or
1756menuitem or change the ; a useful shortcut for setting the quick arrows
1757from a menuBar.
1758
1759=back
1760
1761X<menuBarAdd>
1762
1763=head2 Adding and accessing menus
1764
1765The following commands may also be B<+> prefixed.
1766
1767=over 4
1768
1769=item B</+>
1770
1771access menuBar top level
1772
1773=item B<./+>
1774
1775access current menu level
1776
1777=item B<../+>
1778
1779access parent menu (1 level up)
1780
1781=item B<../../>
1782
1783access parent menu (multiple levels up)
1784
1785=item B<< I</path/>menu >>
1786
1787add/access menu
1788
1789=item B<< I</path/>menu/* >>
1790
1791add/access menu and clear it if it exists
1792
1793=item B<< I</path/>{-} >>
1794
1795add separator
1796
1797=item B<< I</path/>{item} >>
1798
1799add B<item> as a label
1800
1801=item B<< I</path/>{item} action >>
1802
1803add/alter I<menuitem> with an associated I<action>
1804
1805=item B<< I</path/>{item}{right-text} >>
1806
1807add/alter I<menuitem> with B<right-text> as the right-justified text
1808and as the associated I<action>
1809
1810=item B<< I</path/>{item}{rtext} action >>
1811
1812add/alter I<menuitem> with an associated I<action> and with B<rtext> as
1813the right-justified text.
1814
1815=back
1816
1817=over 4
1818
1819=item Special characters in I<action> must be backslash-escaped:
1820
1821B<\a \b \E \e \n \r \t \octal>
1822
1823=item or in control-character notation:
1824
1825B<^@, ^A .. ^Z .. ^_, ^?>
1826
1827=back
1828
1829To send a string starting with a B<NUL> (B<^@>) character to the
1830program, start I<action> with a pair of B<NUL> characters (B<^@^@>),
1831the first of which will be stripped off and the balance directed to the
1832program. Otherwise if I<action> begins with B<NUL> followed by
1833non-+B<NUL> characters, the leading B<NUL> is stripped off and the
1834balance is sent back to rxvt.
1835
1836As a convenience for the many Emacs-type editors, I<action> may start
1837with B<M-> (eg, B<M-$> is equivalent to B<\E$>) and a B<CR> will be
1838appended if missed from B<M-x> commands.
1839
1840As a convenience for issuing XTerm B<ESC ]> sequences from a menubar (or
1841quick arrow), a B<BEL> (B<^G>) will be appended if needed.
1842
1843=over 4
1844
1845=item For example,
1846
1847B<M-xapropos> is equivalent to B<\Exapropos\r>
1848
1849=item and
1850
1851B<\E]703;mona;100> is equivalent to B<\E]703;mona;100\a>
1852
1853=back
1854
1855The option B<< {I<right-rtext>} >> will be right-justified. In the
1856absence of a specified action, this text will be used as the I<action>
1857as well.
1858
1859=over 4
1860
1861=item For example,
1862
1863B</File/{Open}{^X^F}> is equivalent to B</File/{Open}{^X^F} ^X^F>
1864
1865=back
1866
1867The left label I<is> necessary, since it's used for matching, but
1868implicitly hiding the left label (by using same name for both left and
1869right labels), or explicitly hiding the left label (by preceeding it
1870with a dot), makes it possible to have right-justified text only.
1871
1872=over 4
1873
1874=item For example,
1875
1876B</File/{Open}{Open} Open-File-Action>
1877
1878=item or hiding it
1879
1880B</File/{.anylabel}{Open} Open-File-Action>
1881
1882=back
1883
1884X<menuBarRemove>
1885
1886=head2 Removing menus
1887
1888=over 4
1889
1890=item B<< -/*+ >>
1891
1892remove all menus from the menuBar, the same as B<[clear]>
1893
1894=item B<< -+I</path>menu+ >>
1895
1896remove menu
1897
1898=item B<< -+I</path>{item}+ >>
1899
1900remove item
1901
1902=item B<< -+I</path>{-} >>
1903
1904remove separator)
1905
1906=item B<-/path/menu/*>
1907
1908remove all items, separators and submenus from menu
1909
1910=back
1911
1912X<menuBarArrows>
1913
1914=head2 Quick Arrows
1915
1916The menus also provide a hook for I<quick arrows> to provide easier
1917user access. If nothing has been explicitly set, the default is to
1918emulate the curror keys. The syntax permits each arrow to be altered
1919individually or all four at once without re-entering their common
1920beginning/end text. For example, to explicitly associate cursor actions
1921with the arrows, any of the following forms could be used:
1922
1923=over 4
1924
1925=item B<< <r>+I<Right> >>
1926
1927=item B<< <l>+I<Left> >>
1928
1929=item B<< <u>+I<Up> >>
1930
1931=item B<< <d>+I<Down> >>
1932
1933Define actions for the respective arrow buttons
1934
1935=item B<< <b>+I<Begin> >>
1936
1937=item B<< <e>+I<End> >>
1938
1939Define common beginning/end parts for I<quick arrows> which used in
1940conjunction with the above <r> <l> <u> <d> constructs
1941
1942=back
1943
1944=over 4
1945
1946=item For example, define arrows individually,
1947
1948 <u>\E[A
1949
1950 <d>\E[B
1951
1952 <r>\E[C
1953
1954 <l>\E[D
1955
1956=item or all at once
1957
1958 <u>\E[AZ<><d>\E[BZ<><r>\E[CZ<><l>\E[D
1959
1960=item or more compactly (factoring out common parts)
1961
1962 <b>\E[<u>AZ<><d>BZ<><r>CZ<><l>D
1963
1964=back
1965
1966X<menuBarSummary>
1967
1968=head2 Command Summary
1969
1970A short summary of the most I<common> commands:
1971
1972=over 4
1973
1974=item [menu:name]
1975
1976use an existing named menuBar or start a new one
1977
1978=item [menu]
1979
1980use the current menuBar
1981
1982=item [title:string]
1983
1984set menuBar title
1985
1986=item [done]
1987
1988set menu access to readonly and, if reading from a file, signal EOF
1989
1990=item [done:name]
1991
1992if reading from a file using [read:file;name] signal EOF
1993
1994=item [rm:name]
1995
1996remove named menuBar(s)
1997
1998=item [rm] [rm:]
1999
2000remove current menuBar
2001
2002=item [rm*] [rm:*]
2003
2004remove all menuBar(s)
2005
2006=item [swap]
2007
2008swap top two menuBars
2009
2010=item [prev]
2011
2012access the previous menuBar
2013
2014=item [next]
2015
2016access the next menuBar
2017
2018=item [show]
2019
2020map menuBar
2021
2022=item [hide]
2023
2024unmap menuBar
2025
2026=item [pixmap;file]
2027
2028=item [pixmap;file;scaling]
2029
2030set a background pixmap
2031
2032=item [read:file]
2033
2034=item [read:file;name]
2035
2036read in a menu from a file
2037
2038=item [dump]
2039
2040dump out all menuBars to /tmp/rxvt-PID
2041
2042=item /
2043
2044access menuBar top level
2045
2046=item ./
2047
2048=item ../
2049
2050=item ../../
2051
2052access current or parent menu level
2053
2054=item /path/menu
2055
2056add/access menu
2057
2058=item /path/{-}
2059
2060add separator
2061
2062=item /path/{item}{rtext} action
2063
2064add/alter menu item
2065
2066=item -/*
2067
2068remove all menus from the menuBar
2069
2070=item -/path/menu
2071
2072remove menu items, separators and submenus from menu
2073
2074=item -/path/menu
2075
2076remove menu
2077
2078=item -/path/{item}
2079
2080remove item
2081
2082=item -/path/{-}
2083
2084remove separator
2085
2086=item <b>Begin<r>Right<l>Left<u>Up<d>Down<e>End
2087
2088menu quick arrows
2089
2090=back
2091X<XPM>
2092
2093=head1 XPM
2094
2095For the XPM XTerm escape sequence B<< C<ESC ] 20 ; Pt ST> >> then value 2036For the BACGROUND IMAGE XTerm escape sequence B<< C<ESC ] 20 ; Pt ST> >> then value
2096of B<< C<Pt> >> can be the name of the background pixmap followed by a 2037of B<< C<Pt> >> can be the name of the background image file followed by a
2097sequence of scaling/positioning commands separated by semi-colons. The 2038sequence of scaling/positioning commands separated by semi-colons. The
2098scaling/positioning commands are as follows: 2039scaling/positioning commands are as follows:
2099 2040
2100=over 4 2041=over 4
2101 2042
2139 2080
2140For example: 2081For example:
2141 2082
2142=over 4 2083=over 4
2143 2084
2144=item B<\E]20;funky\a> 2085=item B<\E]20;funky.jpg\a>
2145 2086
2146load B<funky.xpm> as a tiled image 2087load B<funky.jpg> as a tiled image
2147 2088
2148=item B<\E]20;mona;100\a> 2089=item B<\E]20;mona.jpg;100\a>
2149 2090
2150load B<mona.xpm> with a scaling of 100% 2091load B<mona.jpg> with a scaling of 100%
2151 2092
2152=item B<\E]20;;200;?\a> 2093=item B<\E]20;;200;?\a>
2153 2094
2154rescale the current pixmap to 200% and display the image geometry in 2095rescale the current pixmap to 200% and display the image geometry in
2155the title 2096the title
2194=begin table 2135=begin table
2195 2136
2196 4 Shift 2137 4 Shift
2197 8 Meta 2138 8 Meta
2198 16 Control 2139 16 Control
2199 32 Double Click I<(Rxvt extension)> 2140 32 Double Click I<(rxvt extension)>
2200 2141
2201=end table 2142=end table
2202 2143
2203Col = B<< C<< <x> - SPACE >> >> 2144Col = B<< C<< <x> - SPACE >> >>
2204 2145
2282 2223
2283=head1 CONFIGURE OPTIONS 2224=head1 CONFIGURE OPTIONS
2284 2225
2285General hint: if you get compile errors, then likely your configuration 2226General hint: if you get compile errors, then likely your configuration
2286hasn't been tested well. Either try with C<--enable-everything> or use 2227hasn't been tested well. Either try with C<--enable-everything> or use
2287the F<./reconf> script as a base for experiments. F<./reconf> is used by 2228the default configuration (i.e. no C<--enable-xxx> or C<--disable-xxx>
2288myself, so it should generally be a working config. Of course, you should 2229switches). Of course, you should always report when a combination doesn't
2289always report when a combination doesn't work, so it can be fixed. Marc 2230work, so it can be fixed. Marc Lehmann <rxvt@schmorp.de>.
2290Lehmann <rxvt@schmorp.de>.
2291 2231
2292All 2232All
2293 2233
2294=over 4 2234=over 4
2295 2235
2327 2267
2328=begin table 2268=begin table
2329 2269
2330 all all available codeset groups 2270 all all available codeset groups
2331 zh common chinese encodings 2271 zh common chinese encodings
2332 zh_ext rarely used but very big chinese encodigs 2272 zh_ext rarely used but very big chinese encodings
2333 jp common japanese encodings 2273 jp common japanese encodings
2334 jp_ext rarely used but big japanese encodings 2274 jp_ext rarely used but big japanese encodings
2335 kr korean encodings 2275 kr korean encodings
2336 2276
2337=end table 2277=end table
2341Add support for XIM (X Input Method) protocol. This allows using 2281Add support for XIM (X Input Method) protocol. This allows using
2342alternative input methods (e.g. kinput2) and will also correctly 2282alternative input methods (e.g. kinput2) and will also correctly
2343set up the input for people using dead keys or compose keys. 2283set up the input for people using dead keys or compose keys.
2344 2284
2345=item --enable-unicode3 (default: off) 2285=item --enable-unicode3 (default: off)
2286
2287Recommended to stay off unless you really need non-BMP characters.
2346 2288
2347Enable direct support for displaying unicode codepoints above 2289Enable direct support for displaying unicode codepoints above
234865535 (the basic multilingual page). This increases storage 229065535 (the basic multilingual page). This increases storage
2349requirements per character from 2 to 4 bytes. X11 fonts do not yet 2291requirements per character from 2 to 4 bytes. X11 fonts do not yet
2350support these extra characters, but Xft does. 2292support these extra characters, but Xft does.
2351 2293
2352Please note that rxvt-unicode can store unicode code points >65535 2294Please note that rxvt-unicode can store unicode code points >65535
2353even without this flag, but the number of such characters is 2295even without this flag, but the number of such characters is
2354limited to a view thousand (shared with combining characters, 2296limited to a few thousand (shared with combining characters,
2355see next switch), and right now rxvt-unicode cannot display them 2297see next switch), and right now rxvt-unicode cannot display them
2356(input/output and cut&paste still work, though). 2298(input/output and cut&paste still work, though).
2357 2299
2358=item --enable-combining (default: on) 2300=item --enable-combining (default: on)
2359 2301
2361composite characters. This is required for proper viewing of text 2303composite characters. This is required for proper viewing of text
2362where accents are encoded as seperate unicode characters. This is 2304where accents are encoded as seperate unicode characters. This is
2363done by using precomposited characters when available or creating 2305done by using precomposited characters when available or creating
2364new pseudo-characters when no precomposed form exists. 2306new pseudo-characters when no precomposed form exists.
2365 2307
2366Without --enable-unicode3, the number of additional precomposed characters 2308Without --enable-unicode3, the number of additional precomposed
2367is rather limited (2048, if this is full, rxvt-unicode will use the 2309characters is somewhat limited (the 6400 private use characters will be
2368private use area, extending the number of combinations to 8448). With
2369--enable-unicode3, no practical limit exists. 2310(ab-)used). With --enable-unicode3, no practical limit exists.
2370 2311
2371This option will also enable storage (but not display) of characters 2312This option will also enable storage (but not display) of characters
2372beyond plane 0 (>65535) when --enable-unicode3 was not specified. 2313beyond plane 0 (>65535) when --enable-unicode3 was not specified.
2373 2314
2374The combining table also contains entries for arabic presentation forms, 2315The combining table also contains entries for arabic presentation forms,
2375but these are not currently used. Bug me if you want these to be used (and 2316but these are not currently used. Bug me if you want these to be used (and
2376tell me how these are to be used...). 2317tell me how these are to be used...).
2377 2318
2378=item --enable-fallback(=CLASS) (default: Rxvt) 2319=item --enable-fallback(=CLASS) (default: Rxvt)
2379 2320
2380When reading resource settings, also read settings for class CLASS. To disable resource fallback use --disable-fallback. 2321When reading resource settings, also read settings for class CLASS. To
2322disable resource fallback use --disable-fallback.
2381 2323
2382=item --with-res-name=NAME (default: urxvt) 2324=item --with-res-name=NAME (default: urxvt)
2383 2325
2384Use the given name as default application name when 2326Use the given name as default application name when
2385reading resources. Specify --with-res-name=rxvt to replace rxvt. 2327reading resources. Specify --with-res-name=rxvt to replace rxvt.
2386 2328
2387=item --with-res-class=CLASS /default: URxvt) 2329=item --with-res-class=CLASS (default: URxvt)
2388 2330
2389Use the given class as default application class 2331Use the given class as default application class
2390when reading resources. Specify --with-res-class=Rxvt to replace 2332when reading resources. Specify --with-res-class=Rxvt to replace
2391rxvt. 2333rxvt.
2392 2334
2405 2347
2406Write user and tty to lastlog file (used by programs like 2348Write user and tty to lastlog file (used by programs like
2407F<lastlogin>) at start of rxvt execution. This option requires 2349F<lastlogin>) at start of rxvt execution. This option requires
2408--enable-utmp to also be specified. 2350--enable-utmp to also be specified.
2409 2351
2410=item --enable-xpm-background (default: off) 2352=item --enable-afterimage (default: on)
2411 2353
2412Add support for XPM background pixmaps. 2354Add support for libAfterImage to be used for transparency and background
2355images. It adds support for many file formats including JPG, PNG,
2356SVG, TIFF, GIF, XPM, BMP, ICO, XCF, TGA and AfterStep image XML
2357(L<http://www.afterstep.org/visualdoc.php?show=asimagexml>).
2413 2358
2359This option also adds such eye candy as blending an image over the root
2360background, as well as dynamic scaling and bluring of background images.
2361
2362Note that with this option enabled, @@RXVT_NAME@@'s memory footprint might
2363increase by a few megabytes even if no extra features are used (mostly due
2364to third-party libraries used by libAI). Memory footprint may somewhat be
2365lowered if libAfterImage is configured without support for SVG.
2366
2414=item --enable-transparency (default: off) 2367=item --enable-transparency (default: on)
2415 2368
2416Add support for inheriting parent backgrounds thus giving a fake 2369Add support for backgrounds, creating illusion of transparency in the term.
2417transparency to the term.
2418 2370
2419=item --enable-fading (default: on) 2371=item --enable-fading (default: on)
2420 2372
2421Add support for fading the text when focus is lost (requires C<--enable-transparency>). 2373Add support for fading the text when focus is lost.
2422
2423=item --enable-tinting (default: on)
2424
2425Add support for tinting of transparent backgrounds (requires C<--enable-transparency>).
2426
2427=item --enable-menubar (default: off)
2428
2429Add support for our menu bar system (this interacts badly with
2430dynamic locale switching currently).
2431 2374
2432=item --enable-rxvt-scroll (default: on) 2375=item --enable-rxvt-scroll (default: on)
2433 2376
2434Add support for the original rxvt scrollbar. 2377Add support for the original rxvt scrollbar.
2435 2378
2445 2388
2446Add support for a very unobtrusive, plain-looking scrollbar that 2389Add support for a very unobtrusive, plain-looking scrollbar that
2447is the favourite of the rxvt-unicode author, having used it for 2390is the favourite of the rxvt-unicode author, having used it for
2448many years. 2391many years.
2449 2392
2450=item --enable-half-shadow (default: off)
2451
2452Make shadows on the scrollbar only half the normal width & height.
2453only applicable to rxvt scrollbars.
2454
2455=item --enable-ttygid (default: off) 2393=item --enable-ttygid (default: off)
2456 2394
2457Change tty device setting to group "tty" - only use this if 2395Change tty device setting to group "tty" - only use this if
2458your system uses this type of security. 2396your system uses this type of security.
2459 2397
2467do it. 2405do it.
2468 2406
2469=item --disable-resources 2407=item --disable-resources
2470 2408
2471Removes any support for resource checking. 2409Removes any support for resource checking.
2472
2473=item --enable-xgetdefault
2474
2475Make resources checking via XGetDefault() instead of our small
2476version which only checks ~/.Xdefaults, or if that doesn't exist then
2477~/.Xresources.
2478
2479Please note that nowadays, things like XIM will automatically pull in and
2480use the full X resource manager, so the overhead of using it might be very
2481small, if nonexistant.
2482
2483=item --enable-strings (default: off)
2484
2485Add support for our possibly faster memset() function and other
2486various routines, overriding your system's versions which may
2487have been hand-crafted in assembly or may require extra libraries
2488to link in. (this breaks ANSI-C rules and has problems on many
2489GNU/Linux systems).
2490 2410
2491=item --disable-swapscreen 2411=item --disable-swapscreen
2492 2412
2493Remove support for secondary/swap screen. 2413Remove support for secondary/swap screen.
2494 2414
2501A non-exhaustive list of features enabled by C<--enable-frills> (possibly 2421A non-exhaustive list of features enabled by C<--enable-frills> (possibly
2502in combination with other switches) is: 2422in combination with other switches) is:
2503 2423
2504 MWM-hints 2424 MWM-hints
2505 EWMH-hints (pid, utf8 names) and protocols (ping) 2425 EWMH-hints (pid, utf8 names) and protocols (ping)
2426 urgency hint
2506 seperate underline colour 2427 seperate underline colour (-underlineColor)
2507 settable border widths and borderless switch 2428 settable border widths and borderless switch (-w, -b, -bl)
2429 visual depth selection (-depth)
2508 settable extra linespacing 2430 settable extra linespacing /-lsp)
2509 iso-14755-2 and -3, and visual feedback 2431 iso-14755 5.1 (basic) support
2432 tripleclickwords (-tcw)
2433 settable insecure mode (-insecure)
2434 keysym remapping support
2435 cursor blinking and underline cursor (-cb, -uc)
2436 XEmbed support (-embed)
2437 user-pty (-pty-fd)
2438 hold on exit (-hold)
2439 compile in built-in block graphics
2440 skip builtin block graphics (-sbg)
2441 separate highlightcolor support (-hc)
2442
2443It also enables some non-essential features otherwise disabled, such as:
2444
2445 some round-trip time optimisations
2446 nearest color allocation on pseudocolor screens
2447 UTF8_STRING support for selection
2448 sgr modes 90..97 and 100..107
2510 backindex and forwardindex escape sequence 2449 backindex and forwardindex escape sequences
2450 view change/zero scrollback escape sequences
2451 locale switching escape sequence
2511 window op and some xterm/OSC escape sequences 2452 window op and some xterm/OSC escape sequences
2512 tripleclickwords 2453 rectangular selections
2513 settable insecure mode 2454 trailing space removal for selections
2514 keysym remapping support 2455 verbose X error handling
2515 cursor blinking and underline cursor
2516 -embed, -pty-fd and -hold options
2517 2456
2518=item --enable-iso14755 (default: on) 2457=item --enable-iso14755 (default: on)
2519 2458
2520Enable extended ISO 14755 support (see @@RXVT_NAME@@(1), or 2459Enable extended ISO 14755 support (see @@RXVT_NAME@@(1), or
2521F<doc/rxvt.1.txt>). Basic support (section 5.1) is enabled by 2460F<doc/rxvt.1.txt>). Basic support (section 5.1) is enabled by
2525=item --enable-keepscrolling (default: on) 2464=item --enable-keepscrolling (default: on)
2526 2465
2527Add support for continual scrolling of the display when you hold 2466Add support for continual scrolling of the display when you hold
2528the mouse button down on a scrollbar arrow. 2467the mouse button down on a scrollbar arrow.
2529 2468
2469=item --enable-selectionscrolling (default: on)
2470
2471Add support for scrolling when the selection moves to the top or
2472bottom of the screen.
2473
2530=item --enable-mousewheel (default: on) 2474=item --enable-mousewheel (default: on)
2531 2475
2532Add support for scrolling via mouse wheel or buttons 4 & 5. 2476Add support for scrolling via mouse wheel or buttons 4 & 5.
2533 2477
2534=item --enable-slipwheeling (default: on) 2478=item --enable-slipwheeling (default: on)
2535 2479
2536Add support for continual scrolling (using the mouse wheel as an 2480Add support for continual scrolling (using the mouse wheel as an
2537accelerator) while the control key is held down. This option 2481accelerator) while the control key is held down. This option
2538requires --enable-mousewheel to also be specified. 2482requires --enable-mousewheel to also be specified.
2539 2483
2540=item --disable-new-selection
2541
2542Remove support for mouse selection style like that of xterm.
2543
2544=item --enable-dmalloc (default: off)
2545
2546Use Gray Watson's malloc - which is good for debugging See
2547http://www.letters.com/dmalloc/ for details If you use either this or the
2548next option, you may need to edit src/Makefile after compiling to point
2549DINCLUDE and DLIB to the right places.
2550
2551You can only use either this option and the following (should
2552you use either) .
2553
2554=item --enable-dlmalloc (default: off)
2555
2556Use Doug Lea's malloc - which is good for a production version
2557See L<http://g.oswego.edu/dl/html/malloc.html> for details.
2558
2559=item --enable-smart-resize (default: on) 2484=item --enable-smart-resize (default: off)
2560 2485
2561Add smart growth/shrink behaviour when changing font size via hot 2486Add smart growth/shrink behaviour when resizing.
2562keys. This should keep the window corner which is closest to a corner of 2487This should keep the window corner which is closest to a corner of
2563the screen in a fixed position. 2488the screen in a fixed position.
2564 2489
2565=item --enable-pointer-blank (default: on) 2490=item --enable-pointer-blank (default: on)
2566 2491
2567Add support to have the pointer disappear when typing or inactive. 2492Add support to have the pointer disappear when typing or inactive.
2493
2494=item --enable-perl (default: on)
2495
2496Enable an embedded perl interpreter. See the B<@@RXVT_NAME@@perl(3)>
2497manpage (F<doc/rxvtperl.txt>) for more info on this feature, or the
2498files in F<src/perl-ext/> for the extensions that are installed by
2499default. The perl interpreter that is used can be specified via the
2500C<PERL> environment variable when running configure. Even when compiled
2501in, perl will I<not> be initialised when all extensions have been disabled
2502C<-pe "" --perl-ext-common "">, so it should be safe to enable from a
2503resource standpoint.
2504
2505=item --with-afterimage-config=DIR
2506
2507Look for the libAfterImage config script in DIR.
2568 2508
2569=item --with-name=NAME (default: urxvt) 2509=item --with-name=NAME (default: urxvt)
2570 2510
2571Set the basename for the installed binaries, resulting 2511Set the basename for the installed binaries, resulting
2572in C<urxvt>, C<urxvtd> etc.). Specify C<--with-name=rxvt> to replace with 2512in C<urxvt>, C<urxvtd> etc.). Specify C<--with-name=rxvt> to replace with
2582PATH. 2522PATH.
2583 2523
2584=item --with-x 2524=item --with-x
2585 2525
2586Use the X Window System (pretty much default, eh?). 2526Use the X Window System (pretty much default, eh?).
2587
2588=item --with-xpm-includes=DIR
2589
2590Look for the XPM includes in DIR.
2591
2592=item --with-xpm-library=DIR
2593
2594Look for the XPM library in DIR.
2595
2596=item --with-xpm
2597
2598Not needed - define via --enable-xpm-background.
2599 2527
2600=back 2528=back
2601 2529
2602=head1 AUTHORS 2530=head1 AUTHORS
2603 2531

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines