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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines