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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines