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.76 by root, Wed Jan 11 19:55:34 2006 UTC vs.
Revision 1.150 by ayin, Sat Nov 10 09:40:51 2007 UTC

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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines