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.89 by root, Wed Jan 18 21:00:39 2006 UTC vs.
Revision 1.149 by sasha, Mon Oct 29 13:40:41 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 The new selection selects pieces that are too big, how can I select 27=head2 Meta, Features & Commandline Issues
30single words?
31 28
32Yes. For example, if you want to select alphanumeric words, you can use 29=head3 My question isn't answered here, can I ask a human?
33the following resource:
34 30
35 URxvt.selection.pattern-0: ([[:word:]]+) 31Before sending me mail, you could go to IRC: C<irc.freenode.net>,
32channel C<#rxvt-unicode> has some rxvt-unicode enthusiasts that might be
33interested in learning about new and exciting problems (but not FAQs :).
36 34
37If you click more than twice, the selection will be extended 35=head3 Does it support tabs, can I have a tabbed rxvt-unicode?
38more and more.
39 36
40To get a selection that is very similar to the old code, try this pattern: 37Beginning with version 7.3, there is a perl extension that implements a
38simple tabbed terminal. It is installed by default, so any of these should
39give you tabs:
41 40
42 URxvt.selection.pattern-0: ([^"&'()*,;<=>?@[\\\\]^`{|})]+) 41 @@URXVT_NAME@@ -pe tabbed
43 42
44Please also note that the I<LeftClick Shift-LeftClik> combination also 43 URxvt.perl-ext-common: default,tabbed
45selects words like the old code.
46 44
47=item I don't like the new selection/popups/hotkeys/perl, how do I 45It will also work fine with tabbing functionality of many window managers
48change/disable it? 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.
49 50
50You can disable the perl extension completely by setting the 51=head3 How do I know which rxvt-unicode version I'm using?
51B<perl-ext-common> resource to the empty string, which also keeps
52rxvt-unicode from initialising perl, saving memory.
53 52
54If you only want to disable specific features, you first have to 53The version number is displayed with the usage (-h). Also the escape
55identify which perl extension is responsible. For this, read the section 54sequence C<ESC [ 8 n> sets the window title to the version number. When
56B<PREPACKAGED EXTENSIONS> in the @@RXVT_NAME@@perl(3) manpage. For 55using the @@URXVT_NAME@@c client, the version displayed is that of the
57example, to disable the B<selection-popup> and B<option-popup>, specify 56daemon.
58this B<perl-ext-common> resource:
59 57
60 URxvt.perl-ext-common: default,-selection-popup,-option-popup 58=head3 Rxvt-unicode uses gobs of memory, how can I reduce that?
61 59
62This will keep the default extensions, but disable the two popup 60Rxvt-unicode tries to obey the rule of not charging you for something you
63extensions. Some extensions can also be configured, for example, 61don't use. One thing you should try is to configure out all settings that
64scrollback search mode is triggered by B<M-s>. You can move it to any 62you don't need, for example, Xft support is a resource hog by design,
65other combination either by setting the B<searchable-scrollback> resource: 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.
66 65
67 URxvt.searchable-scrollback: CM-s 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.
68 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
69=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?
70 134
71I 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
72bloat. 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
73that 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
74compiled in), but it actually uses less memory (RSS) after startup. Even 138compiled in), but it actually uses less memory (RSS) after startup. Even
78 142
79 text data bss drs rss filename 143 text data bss drs rss filename
80 98398 1664 24 15695 1824 rxvt --disable-everything 144 98398 1664 24 15695 1824 rxvt --disable-everything
81 188985 9048 66616 18222 1788 urxvt --disable-everything 145 188985 9048 66616 18222 1788 urxvt --disable-everything
82 146
83When you C<--enable-everything> (which _is_ unfair, as this involves xft 147When you C<--enable-everything> (which I<is> unfair, as this involves xft
84and 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
85libc), the two diverge, but not unreasnobaly so. 149libc), the two diverge, but not unreasonably so.
86 150
87 text data bss drs rss filename 151 text data bss drs rss filename
88 163431 2152 24 20123 2060 rxvt --enable-everything 152 163431 2152 24 20123 2060 rxvt --enable-everything
89 1035683 49680 66648 29096 3680 urxvt --enable-everything 153 1035683 49680 66648 29096 3680 urxvt --enable-everything
90 154
106(21152k + extra 4204k in separate processes) or konsole (22200k + extra 170(21152k + extra 4204k in separate processes) or konsole (22200k + extra
10743180k 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
108startup time, including the hundreds of warnings it spits out), it fares 172startup time, including the hundreds of warnings it spits out), it fares
109extremely well *g*. 173extremely well *g*.
110 174
111=item Why C++, isn't that unportable/bloated/uncool? 175=head3 Why C++, isn't that unportable/bloated/uncool?
112 176
113Is 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
114to 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
115of 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
116shorter: It simply wouldn't exist without C++. 180shorter: It simply wouldn't exist without C++.
140 /lib64/ld-linux-x86-64.so.2 (0x00002aaaaaaab000) 204 /lib64/ld-linux-x86-64.so.2 (0x00002aaaaaaab000)
141 205
142No large bloated libraries (of course, none were linked in statically), 206No large bloated libraries (of course, none were linked in statically),
143except maybe libX11 :) 207except maybe libX11 :)
144 208
145=item Does it support tabs, can I have a tabbed rxvt-unicode?
146 209
147rxvt-unicode does not directly support tabs. It will work fine with 210=head2 Rendering, Font & Look and Feel Issues
148tabbing functionality of many window managers or similar tabbing programs,
149and its embedding-features allow it to be embedded into other programs,
150as witnessed by F<doc/rxvt-tabbed> or the upcoming C<Gtk2::URxvt> perl
151module, which features a tabbed urxvt (murxvt) terminal as an example
152embedding application.
153 211
154=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?
155 213
156The version number is displayed with the usage (-h). Also the escape 214First of all, please address all transparency related issues to Sasha Vasko at
157sequence 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
158using the @@RXVT_NAME@@c client, the version displayed is that of the 216get it working consider it a rite of passage: ... and you failed.
159daemon.
160 217
161=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!
162 220
163The Debian GNU/Linux package of rxvt-unicode in sarge contains large 2211. Use transparent mode:
164patches that considerably change the behaviour of rxvt-unicode (but
165unfortunately this notice has been removed). Before reporting a bug to
166the original rxvt-unicode author please download and install the genuine
167version (L<http://software.schmorp.de#rxvt-unicode>) and try to reproduce
168the problem. If you cannot, chances are that the problems are specific to
169Debian GNU/Linux, in which case it should be reported via the Debian Bug
170Tracking System (use C<reportbug> to report the bug).
171 222
172For other problems that also affect the Debian package, you can and 223 Esetroot wallpaper.jpg
173probably should use the Debian BTS, too, because, after all, it's also a 224 @@URXVT_NAME@@ -tr -tint red -sh 40
174bug in the Debian version and it serves as a reminder for other users that
175might encounter the same issue.
176 225
177=item I am maintaining rxvt-unicode for distribution/OS XXX, any 226That works. If you think it doesn't, you lack transparency and tinting
178recommendation? 227support, or you are unable to read.
179 228
180You should build one binary with the default options. F<configure> 2292. Use a simple pixmap and emulate pseudo-transparency. This enables you
181now enables most useful options, and the trend goes to making them 230to use effects other than tinting and shading: Just shade/tint/whatever
182runtime-switchable, too, so there is usually no drawback to enbaling them, 231your picture with gimp or any other tool:
183except higher disk and possibly memory usage. The perl interpreter should
184be enabled, as important functionality (menus, selection, likely more in
185the future) depends on it.
186 232
187You should not overwrite the C<perl-ext-common> snd C<perl-ext> resources 233 convert wallpaper.jpg -blur 20x20 -modulate 30 background.jpg
188system-wide (except maybe with C<defaults>). This will result in useful 234 @@URXVT_NAME@@ -pixmap background.jpg -pe automove-background
189behaviour. If your distribution aims at low memory, add an empty
190C<perl-ext-common> resource to the app-defaults file. This will keep the
191perl interpreter disabled until the user enables it.
192 235
193If you can/want build more binaries, I recommend building a minimal 236That works. If you think it doesn't, you lack AfterImage and Perl support, or you
194one with C<--disable-everything> (very useful) and a maximal one with 237are unable to read.
195C<--enable-everything> (less useful, it will be very big due to a lot of
196encodings built-in that increase download times and are rarely used).
197 238
198=item I need to make it setuid/setgid to support utmp/ptys on my OS, is this safe? 2393. Use an ARGB visual:
199 240
200It should be, starting with release 7.1. You are encouraged to properly 241 @@URXVT_NAME@@ -depth 32 -fg grey90 -bg rgba:0000/0000/4444/cccc
201install urxvt with privileges necessary for your OS now.
202 242
203When rxvt-unicode detects that it runs setuid or setgid, it will fork 243This requires XFT support, and the support of your X-server. If that
204into a helper process for privileged operations (pty handling on some 244doesn't work for you, blame Xorg and Keith Packard. ARGB visuals aren't
205systems, utmp/wtmp/lastlog handling on others) and drop privileges 245there yet, no matter what they claim. Rxvt-Unicode contains the necessary
206immediately. This is much safer than most other terminals that keep 246bugfixes and workarounds for Xft and Xlib to make it work, but that
207privileges while running (but is more relevant to urxvt, as it contains 247doesn't mean that your WM has the required kludges in place.
208things as perl interpreters, which might be "helpful" to attackers).
209 248
210This forking is done as the very first within main(), which is very early 2494. Use xcompmgr and let it do the job:
211and reduces possible bugs to initialisation code run before main(), or
212things like the dynamic loader of your system, which should result in very
213little risk.
214 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
215=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?
216 843
217The terminal description used by rxvt-unicode is not as widely available 844The terminal description used by rxvt-unicode is not as widely available
218as 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).
219 846
220The 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
221be done like this (with ncurses' infocmp): 848be done like this (with ncurses' infocmp and works as user and admin):
222 849
223 REMOTE=remotesystem.domain 850 REMOTE=remotesystem.domain
224 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"
225 852
226... 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.
227 857
228If 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
229C<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
230problems arising, which includes wrong keymapping, less and different 860problems arising, which includes wrong keymapping, less and different
231colours and some refresh errors in fullscreen applications. It's a nice 861colours and some refresh errors in fullscreen applications. It's a nice
236resource to set it: 866resource to set it:
237 867
238 URxvt.termName: rxvt 868 URxvt.termName: rxvt
239 869
240If 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
241the rxvt terminfo file with the rxvt-unicode one. 871the rxvt terminfo file with the rxvt-unicode one and use C<TERM=rxvt>.
242 872
243=item C<tic> outputs some error when compiling the terminfo entry. 873=head3 C<tic> outputs some error when compiling the terminfo entry.
244 874
245Most 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
246C<enacs=\E[0@> and try again. 876C<enacs=\E[0@> and try again.
247 877
248=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@@.
249 879
880See next entry.
881
250=item I need a termcap file entry. 882=head3 I need a termcap file entry.
251 883
252One reason you might want this is that some distributions or operating 884One reason you might want this is that some distributions or operating
253systems still compile some programs using the long-obsoleted termcap 885systems still compile some programs using the long-obsoleted termcap
254library (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
255for C<rxvt-unicode>. 887for C<rxvt-unicode>.
256 888
257You 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.
258You 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
259like this: 891like this:
260 892
261 infocmp -C rxvt-unicode 893 infocmp -C rxvt-unicode
262 894
281 :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:\
282 :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:\
283 :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:\
284 :vs=\E[?25h: 916 :vs=\E[?25h:
285 917
286=item Why does C<ls> no longer have coloured output? 918=head3 Why does C<ls> no longer have coloured output?
287 919
288The 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
289decide wether a terminal has colour, but uses it's own configuration 921decide whether a terminal has colour, but uses its own configuration
290file. 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
291with most other terminals supporting colour). Either add: 923with most other terminals supporting colour). Either add:
292 924
293 TERM rxvt-unicode 925 TERM rxvt-unicode
294 926
295to C</etc/DIR_COLORS> or simply add: 927to C</etc/DIR_COLORS> or simply add:
296 928
297 alias ls='ls --color=auto' 929 alias ls='ls --color=auto'
298 930
299to your C<.profile> or C<.bashrc>. 931to your C<.profile> or C<.bashrc>.
300 932
301=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?
302 934
935See next entry.
936
303=item Why doesn't vim/emacs etc. make use of italic? 937=head3 Why doesn't vim/emacs etc. make use of italic?
304 938
939See next entry.
940
305=item Why are the secondary screen-related options not working properly? 941=head3 Why are the secondary screen-related options not working properly?
306 942
307Make sure you are using C<TERM=rxvt-unicode>. Some pre-packaged 943Make sure you are using C<TERM=rxvt-unicode>. Some pre-packaged
308distributions (most notably Debian GNU/Linux) break rxvt-unicode 944distributions (most notably Debian GNU/Linux) break rxvt-unicode
309by 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
310features. Unfortunately, some of these (most notably, again, Debian 946features. Unfortunately, some of these (most notably, again, Debian
311GNU/Linux) furthermore fail to even install the C<rxvt-unicode> terminfo 947GNU/Linux) furthermore fail to even install the C<rxvt-unicode> terminfo
312file, 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
313I 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
314how to do this). 950how to do this).
315 951
316=item My numerical keypad acts weird and generates differing output?
317 952
318Some Debian GNUL/Linux users seem to have this problem, although no 953=head2 Encoding / Locale / Input Method Issues
319specific details were reported so far. It is possible that this is caused
320by the wrong C<TERM> setting, although the details of wether and how
321this can happen are unknown, as C<TERM=rxvt> should offer a compatible
322keymap. See the answer to the previous question, and please report if that
323helped.
324 954
325=item Rxvt-unicode does not seem to understand the selected encoding? 955=head3 Rxvt-unicode does not seem to understand the selected encoding?
326 956
957See next entry.
958
327=item Unicode does not seem to work? 959=head3 Unicode does not seem to work?
328 960
329If you encounter strange problems like typing an accented character but 961If you encounter strange problems like typing an accented character but
330getting two unrelated other characters or similar, or if program output is 962getting two unrelated other characters or similar, or if program output is
331subtly garbled, then you should check your locale settings. 963subtly garbled, then you should check your locale settings.
332 964
333Rxvt-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
334programs. 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,
335login script running within the rxvt-unicode window changes the locale to 967while the login script running within the rxvt-unicode window changes the
336something 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.
337 970
338The 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
339into 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.
340 973
341 printf '\e]701;%s\007' "$LC_CTYPE" 974 printf '\33]701;%s\007' "$LC_CTYPE" # $LANG or $LC_ALL are worth a try, too
342 975
343If 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
344supported on your systems. Some systems have a C<locale> command which 977supported on your systems. Some systems have a C<locale> command which
345displays 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
346it 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
352 985
353If 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
354you 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
355support locales :( 988support locales :(
356 989
357=item Why do some characters look so much different than others? 990=head3 How does rxvt-unicode determine the encoding to use?
358 991
359=item How does rxvt-unicode choose fonts? 992See next entry.
360 993
361Most fonts do not contain the full range of Unicode, which is 994=head3 Is there an option to switch encodings?
362fine. Chances are that the font you (or the admin/package maintainer of
363your system/os) have specified does not cover all the characters you want
364to display.
365 995
366B<rxvt-unicode> makes a best-effort try at finding a replacement 996Unlike some other terminals, rxvt-unicode has no encoding switch, and no
367font. 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
368bad/ugly/wrong. Some fonts have totally strange characters that don't 998UTF-8 or any other encodings with respect to terminal I/O.
369resemble the correct glyph at all, and rxvt-unicode lacks the artificial
370intelligence to detect that a specific glyph is wrong: it has to believe
371the font that the characters it claims to contain indeed look correct.
372 999
373In 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
374e.g.: 1001the encoding, doing I/O and (most important) communicating this to all
375 1002applications so everybody agrees on character properties such as width
376 @@RXVT_NAME@@ -fn basefont,font2,font3... 1003and code number. This mechanism is the I<locale>. Applications not using
377 1004that info will have problems (for example, C<xterm> gets the width of
378When rxvt-unicode sees a character, it will first look at the base 1005characters wrong as it uses its own, locale-independent table under all
379font. If the base font does not contain the character, it will go to the
380next font, and so on. Specifying your own fonts will also speed up this
381search and use less resources within rxvt-unicode and the X-server.
382
383The only limitation is that none of the fonts may be larger than the base
384font, as the base font defines the terminal character cell size, which
385must be the same due to the way terminals work.
386
387=item Why do some chinese characters look so different than others?
388
389This is because there is a difference between script and language --
390rxvt-unicode does not know which language the text that is output is,
391as it only knows the unicode character codes. If rxvt-unicode first
392sees a japanese/chinese character, it might choose a japanese font for
393display. Subsequent japanese characters will use that font. Now, many
394chinese characters aren't represented in japanese fonts, so when the first
395non-japanese character comes up, rxvt-unicode will look for a chinese font
396-- unfortunately at this point, it will still use the japanese font for
397chinese characters that are also in the japanese font.
398
399The workaround is easy: just tag a chinese font at the end of your font
400list (see the previous question). The key is to view the font list as
401a preference list: If you expect more japanese, list a japanese font
402first. If you expect more chinese, put a chinese font first.
403
404In the future it might be possible to switch language preferences at
405runtime (the internal data structure has no problem with using different
406fonts for the same character at the same time, but no interface for this
407has been designed yet).
408
409Until then, you might get away with switching fonts at runtime (see L<Can
410I switch the fonts at runtime?> later in this document).
411
412=item Why does rxvt-unicode sometimes leave pixel droppings?
413
414Most fonts were not designed for terminal use, which means that character
415size varies a lot. A font that is otherwise fine for terminal use might
416contain some characters that are simply too wide. Rxvt-unicode will avoid
417these characters. For characters that are just "a bit" too wide a special
418"careful" rendering mode is used that redraws adjacent characters.
419
420All of this requires that fonts do not lie about character sizes,
421however: Xft fonts often draw glyphs larger than their acclaimed bounding
422box, and rxvt-unicode has no way of detecting this (the correct way is to
423ask for the character bounding box, which unfortunately is wrong in these
424cases). 1006locales).
425 1007
426It'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
427or the respective font. If you encounter this problem you might try using 1009programs doing the same (that is, most) will automatically agree in the
428the C<-lsp> option to give the font more height. If that doesn't work, you 1010interpretation of characters.
429might be forced to use a different font.
430 1011
431All 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
432box data is correct. 1013is there a standard on how locale specifiers will look like.
433 1014
434=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.
435 1020
436Seems to be a known bug, read 1021Rxvt-unicode ignores all other locale categories, and except for
437L<http://nixdoc.net/files/forum/about34198.html>. Some people use the 1022the encoding, ignores country or language-specific settings,
438following 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.
439 1025
440 #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.
441 1028
442=item My Compose (Multi_key) key is no longer working. 1029=head3 Can I switch locales at runtime?
443 1030
444The most common causes for this are that either your locale is not set 1031Yes, using an escape sequence. Try something like this, which sets
445correctly, or you specified a B<preeditStyle> that is not supported by 1032rxvt-unicode's idea of C<LC_CTYPE>.
446your input method. For example, if you specified B<OverTheSpot> and
447your input method (e.g. the default input method handling Compose keys)
448does not support this (for instance because it is not visual), then
449rxvt-unicode will continue without an input method.
450 1033
451In this case either do not specify a B<preeditStyle> or specify more than 1034 printf '\33]701;%s\007' ja_JP.SJIS
452one pre-edit style, such as B<OverTheSpot,Root,None>.
453 1035
454=item I cannot type C<Ctrl-Shift-2> to get an ASCII NUL character due to ISO 14755 1036See also the previous answer.
455 1037
456Either 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
457international 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
458advantage, 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
459codes, 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:
460character and so on.
461 1042
462=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
463 1046
464First 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
465(C<TERM=rxvt-unicode>), which will get rid of most of these effects. Then 1048for some locales where character width differs between program- and
466make sure you have specified colours for italic and bold, as otherwise 1049rxvt-unicode-locales.
467rxvt-unicode might use reverse video to simulate the effect:
468 1050
469 URxvt.colorBD: white 1051=head3 I have problems getting my input method working.
470 URxvt.colorIT: green
471 1052
472=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.
473 1054
474For some unexplainable reason, some rare programs assume a very weird 1055Here is a checklist:
475colour palette when confronted with a terminal with more than the standard
4768 colours (rxvt-unicode supports 88). The right fix is, of course, to fix
477these programs not to assume non-ISO colours without very good reasons.
478 1056
479In the meantime, you can either edit your C<rxvt-unicode> terminfo 1057=over 4
480definition to only claim 8 colour support or use C<TERM=rxvt>, which will
481fix colours but keep you from using other rxvt-unicode features.
482 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
483=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.
484 1162
485Rxvt-unicode requires the symbol C<__STDC_ISO_10646__> to be defined 1163Rxvt-unicode requires the symbol C<__STDC_ISO_10646__> to be defined
486in your compile environment, or an implementation that implements it, 1164in your compile environment, or an implementation that implements it,
487wether 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
488B<wchar_t> is represented as unicode. 1166B<wchar_t> is represented as unicode.
489 1167
490As you might have guessed, FreeBSD does neither define this symobl nor 1168As you might have guessed, FreeBSD does neither define this symbol nor
491does it support it. Instead, it uses it's own internal representation of 1169does it support it. Instead, it uses its own internal representation of
492B<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.
493 1171
494However, 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
495C<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>.
496 1174
510 1188
511The 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
512system 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
513complete replacements for them :) 1191complete replacements for them :)
514 1192
515=item I use Solaris 9 and it doesn't compile/work/etc.
516
517Try the diff in F<doc/solaris9.patch> as a base. It fixes the worst
518problems with C<wcwidth> and a compile problem.
519
520=item How can I use rxvt-unicode under cygwin? 1193=head3 How can I use rxvt-unicode under cygwin?
521 1194
522rxvt-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
523the X11 libraries that come with cygwin. libW11 emulation is no 1196the X11 libraries that come with cygwin. libW11 emulation is no
524longer supported (and makes no sense, either, as it only supported a 1197longer supported (and makes no sense, either, as it only supported a
525single font). I recommend starting the X-server in C<-multiwindow> or 1198single font). I recommend starting the X-server in C<-multiwindow> or
528 1201
529At 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
530encodings (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
531to 8-bit encodings. 1204to 8-bit encodings.
532 1205
533=item How does rxvt-unicode determine the encoding to use? 1206=head3 Character widths are not correct.
534 1207
535=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.
536 1213
537Unlike 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
538specific "utf-8" mode, such as xterm. In fact, it doesn't even know about 1215possibly working workaround is to use a wcwidth implementation like
539UTF-8 or any other encodings with respect to terminal I/O.
540 1216
541The reasons is that there exists a perfectly fine mechanism for selecting 1217http://www.cl.cam.ac.uk/~mgk25/ucs/wcwidth.c
542the encoding, doing I/O and (most important) communicating this to all
543applications so everybody agrees on character properties such as width
544and code number. This mechanism is the I<locale>. Applications not using
545that info will have problems (for example, C<xterm> gets the width of
546characters wrong as it uses it's own, locale-independent table under all
547locales).
548 1218
549Rxvt-unicode uses the C<LC_CTYPE> locale category to select encoding. All
550programs doing the same (that is, most) will automatically agree in the
551interpretation of characters.
552
553Unfortunately, there is no system-independent way to select locales, nor
554is there a standard on how locale specifiers will look like.
555
556On most systems, the content of the C<LC_CTYPE> environment variable
557contains an arbitrary string which corresponds to an already-installed
558locale. Common names for locales are C<en_US.UTF-8>, C<de_DE.ISO-8859-15>,
559C<ja_JP.EUC-JP>, i.e. C<language_country.encoding>, but other forms
560(i.e. C<de> or C<german>) are also common.
561
562Rxvt-unicode ignores all other locale categories, and except for
563the encoding, ignores country or language-specific settings,
564i.e. C<de_DE.UTF-8> and C<ja_JP.UTF-8> are the normally same to
565rxvt-unicode.
566
567If you want to use a specific encoding you have to make sure you start
568rxvt-unicode with the correct C<LC_CTYPE> category.
569
570=item Can I switch locales at runtime?
571
572Yes, using an escape sequence. Try something like this, which sets
573rxvt-unicode's idea of C<LC_CTYPE>.
574
575 printf '\e]701;%s\007' ja_JP.SJIS
576
577See also the previous answer.
578
579Sometimes this capability is rather handy when you want to work in
580one locale (e.g. C<de_DE.UTF-8>) but some programs don't support it
581(e.g. UTF-8). For example, I use this script to start C<xjdic>, which
582first switches to a locale supported by xjdic and back later:
583
584 printf '\e]701;%s\007' ja_JP.SJIS
585 xjdic -js
586 printf '\e]701;%s\007' de_DE.UTF-8
587
588You can also use xterm's C<luit> program, which usually works fine, except
589for some locales where character width differs between program- and
590rxvt-unicode-locales.
591
592=item Can I switch the fonts at runtime?
593
594Yes, using an escape sequence. Try something like this, which has the same
595effect as using the C<-fn> switch, and takes effect immediately:
596
597 printf '\e]50;%s\007' "9x15bold,xft:Kochi Gothic"
598
599This is useful if you e.g. work primarily with japanese (and prefer a
600japanese font), but you have to switch to chinese temporarily, where
601japanese fonts would only be in your way.
602
603You can think of this as a kind of manual ISO-2022 switching.
604
605=item Why do italic characters look as if clipped?
606
607Many fonts have difficulties with italic characters and hinting. For
608example, the otherwise very nicely hinted font C<xft:Bitstream Vera Sans
609Mono> completely fails in it's italic face. A workaround might be to
610enable freetype autohinting, i.e. like this:
611
612 URxvt.italicFont: xft:Bitstream Vera Sans Mono:italic:autohint=true
613 URxvt.boldItalicFont: xft:Bitstream Vera Sans Mono:bold:italic:autohint=true
614
615=item My input method wants <some encoding> but I want UTF-8, what can I do?
616
617You can specify separate locales for the input method and the rest of the
618terminal, using the resource C<imlocale>:
619
620 URxvt.imlocale: ja_JP.EUC-JP
621
622Now you can start your terminal with C<LC_CTYPE=ja_JP.UTF-8> and still
623use your input method. Please note, however, that you will not be able to
624input characters outside C<EUC-JP> in a normal way then, as your input
625method limits you.
626
627=item Rxvt-unicode crashes when the X Input Method changes or exits.
628
629Unfortunately, this is unavoidable, as the XIM protocol is racy by
630design. Applications can avoid some crashes at the expense of memory
631leaks, and Input Methods can avoid some crashes by careful ordering at
632exit time. B<kinput2> (and derived input methods) generally succeeds,
633while B<SCIM> (or similar input methods) fails. In the end, however,
634crashes cannot be completely avoided even if both sides cooperate.
635
636So the only workaround is not to kill your Input Method Servers.
637
638=item Rxvt-unicode uses gobs of memory, how can I reduce that?
639
640Rxvt-unicode tries to obey the rule of not charging you for something you
641don't use. One thing you should try is to configure out all settings that
642you don't need, for example, Xft support is a resource hog by design,
643when used. Compiling it out ensures that no Xft font will be loaded
644accidentally when rxvt-unicode tries to find a font for your characters.
645
646Also, many people (me included) like large windows and even larger
647scrollback buffers: Without C<--enable-unicode3>, rxvt-unicode will use
6486 bytes per screen cell. For a 160x?? window this amounts to almost a
649kilobyte per line. A scrollback buffer of 10000 lines will then (if full)
650use 10 Megabytes of memory. With C<--enable-unicode3> it gets worse, as
651rxvt-unicode then uses 8 bytes per screen cell.
652
653=item Can I speed up Xft rendering somehow?
654
655Yes, the most obvious way to speed it up is to avoid Xft entirely, as
656it is simply slow. If you still want Xft fonts you might try to disable
657antialiasing (by appending C<:antialias=false>), which saves lots of
658memory and also speeds up rendering considerably.
659
660=item Rxvt-unicode doesn't seem to anti-alias its fonts, what is wrong?
661
662Rxvt-unicode will use whatever you specify as a font. If it needs to
663fall back to it's default font search list it will prefer X11 core
664fonts, because they are small and fast, and then use Xft fonts. It has
665antialiasing disabled for most of them, because the author thinks they
666look best that way.
667
668If you want antialiasing, you have to specify the fonts manually.
669
670=item Mouse cut/paste suddenly no longer works.
671
672Make sure that mouse reporting is actually turned off since killing
673some editors prematurely may leave the mouse in mouse report mode. I've
674heard that tcsh may use mouse reporting unless it otherwise specified. A
675quick check is to see if cut/paste works when the Alt or Shift keys are
676depressed.
677
678=item What's with this bold/blink stuff?
679
680If no bold colour is set via C<colorBD:>, bold will invert text using the
681standard foreground colour.
682
683For the standard background colour, blinking will actually make the
684text blink when compiled with C<--enable-blinking>. with standard
685colours. Without C<--enable-blinking>, the blink attribute will be
686ignored.
687
688On ANSI colours, bold/blink attributes are used to set high-intensity
689foreground/background colors.
690
691color0-7 are the low-intensity colors.
692
693color8-15 are the corresponding high-intensity colors.
694
695=item I don't like the screen colors. How do I change them?
696
697You can change the screen colors at run-time using F<~/.Xdefaults>
698resources (or as long-options).
699
700Here are values that are supposed to resemble a VGA screen,
701including the murky brown that passes for low-intensity yellow:
702
703 URxvt.color0: #000000
704 URxvt.color1: #A80000
705 URxvt.color2: #00A800
706 URxvt.color3: #A8A800
707 URxvt.color4: #0000A8
708 URxvt.color5: #A800A8
709 URxvt.color6: #00A8A8
710 URxvt.color7: #A8A8A8
711
712 URxvt.color8: #000054
713 URxvt.color9: #FF0054
714 URxvt.color10: #00FF54
715 URxvt.color11: #FFFF54
716 URxvt.color12: #0000FF
717 URxvt.color13: #FF00FF
718 URxvt.color14: #00FFFF
719 URxvt.color15: #FFFFFF
720
721And here is a more complete set of non-standard colors described (not by
722me) as "pretty girly".
723
724 URxvt.cursorColor: #dc74d1
725 URxvt.pointerColor: #dc74d1
726 URxvt.background: #0e0e0e
727 URxvt.foreground: #4ad5e1
728 URxvt.color0: #000000
729 URxvt.color8: #8b8f93
730 URxvt.color1: #dc74d1
731 URxvt.color9: #dc74d1
732 URxvt.color2: #0eb8c7
733 URxvt.color10: #0eb8c7
734 URxvt.color3: #dfe37e
735 URxvt.color11: #dfe37e
736 URxvt.color5: #9e88f0
737 URxvt.color13: #9e88f0
738 URxvt.color6: #73f7ff
739 URxvt.color14: #73f7ff
740 URxvt.color7: #e1dddd
741 URxvt.color15: #e1dddd
742
743=item How can I start @@RXVT_NAME@@d in a race-free way?
744
745Try C<@@RXVT_NAME@@d -f -o>, which tells @@RXVT_NAME@@d to open the
746display, create the listening socket and then fork.
747
748=item What's with the strange Backspace/Delete key behaviour?
749
750Assuming that the physical Backspace key corresponds to the
751BackSpace keysym (not likely for Linux ... see the following
752question) there are two standard values that can be used for
753Backspace: C<^H> and C<^?>.
754
755Historically, either value is correct, but rxvt-unicode adopts the debian
756policy of using C<^?> when unsure, because it's the one only only correct
757choice :).
758
759Rxvt-unicode tries to inherit the current stty settings and uses the value
760of `erase' to guess the value for backspace. If rxvt-unicode wasn't
761started from a terminal (say, from a menu or by remote shell), then the
762system value of `erase', which corresponds to CERASE in <termios.h>, will
763be used (which may not be the same as your stty setting).
764
765For starting a new rxvt-unicode:
766
767 # use Backspace = ^H
768 $ stty erase ^H
769 $ @@RXVT_NAME@@
770
771 # use Backspace = ^?
772 $ stty erase ^?
773 $ @@RXVT_NAME@@
774
775Toggle with C<ESC [ 36 h> / C<ESC [ 36 l>.
776
777For an existing rxvt-unicode:
778
779 # use Backspace = ^H
780 $ stty erase ^H
781 $ echo -n "^[[36h"
782
783 # use Backspace = ^?
784 $ stty erase ^?
785 $ echo -n "^[[36l"
786
787This helps satisfy some of the Backspace discrepancies that occur, but
788if you use Backspace = C<^H>, make sure that the termcap/terminfo value
789properly reflects that.
790
791The Delete key is a another casualty of the ill-defined Backspace problem.
792To avoid confusion between the Backspace and Delete keys, the Delete
793key has been assigned an escape sequence to match the vt100 for Execute
794(C<ESC [ 3 ~>) and is in the supplied termcap/terminfo.
795
796Some other Backspace problems:
797
798some editors use termcap/terminfo,
799some editors (vim I'm told) expect Backspace = ^H,
800GNU Emacs (and Emacs-like editors) use ^H for help.
801
802Perhaps someday this will all be resolved in a consistent manner.
803
804=item I don't like the key-bindings. How do I change them?
805
806There are some compile-time selections available via configure. Unless
807you have run "configure" with the C<--disable-resources> option you can
808use the `keysym' resource to alter the keystrings associated with keysyms.
809
810Here's an example for a URxvt session started using C<@@RXVT_NAME@@ -name URxvt>
811
812 URxvt.keysym.Home: \033[1~
813 URxvt.keysym.End: \033[4~
814 URxvt.keysym.C-apostrophe: \033<C-'>
815 URxvt.keysym.C-slash: \033<C-/>
816 URxvt.keysym.C-semicolon: \033<C-;>
817 URxvt.keysym.C-grave: \033<C-`>
818 URxvt.keysym.C-comma: \033<C-,>
819 URxvt.keysym.C-period: \033<C-.>
820 URxvt.keysym.C-0x60: \033<C-`>
821 URxvt.keysym.C-Tab: \033<C-Tab>
822 URxvt.keysym.C-Return: \033<C-Return>
823 URxvt.keysym.S-Return: \033<S-Return>
824 URxvt.keysym.S-space: \033<S-Space>
825 URxvt.keysym.M-Up: \033<M-Up>
826 URxvt.keysym.M-Down: \033<M-Down>
827 URxvt.keysym.M-Left: \033<M-Left>
828 URxvt.keysym.M-Right: \033<M-Right>
829 URxvt.keysym.M-C-0: list \033<M-C- 0123456789 >
830 URxvt.keysym.M-C-a: list \033<M-C- abcdefghijklmnopqrstuvwxyz >
831 URxvt.keysym.F12: command:\033]701;zh_CN.GBK\007
832
833See some more examples in the documentation for the B<keysym> resource.
834
835=item I'm using keyboard model XXX that has extra Prior/Next/Insert keys.
836How do I make use of them? For example, the Sun Keyboard type 4
837has the following mappings that rxvt-unicode doesn't recognize.
838
839 KP_Insert == Insert
840 F22 == Print
841 F27 == Home
842 F29 == Prior
843 F33 == End
844 F35 == Next
845
846Rather than have rxvt-unicode try to accommodate all the various possible
847keyboard mappings, it is better to use `xmodmap' to remap the keys as
848required for your particular machine.
849
850=item How do I distinguish wether I'm running rxvt-unicode or a regular xterm?
851I need this to decide about setting colors etc.
852
853rxvt and rxvt-unicode always export the variable "COLORTERM", so you can
854check and see if that is set. Note that several programs, JED, slrn,
855Midnight Commander automatically check this variable to decide whether or
856not to use color.
857
858=item How do I set the correct, full IP address for the DISPLAY variable?
859
860If you've compiled rxvt-unicode with DISPLAY_IS_IP and have enabled
861insecure mode then it is possible to use the following shell script
862snippets to correctly set the display. If your version of rxvt-unicode
863wasn't also compiled with ESCZ_ANSWER (as assumed in these snippets) then
864the COLORTERM variable can be used to distinguish rxvt-unicode from a
865regular xterm.
866
867Courtesy of Chuck Blake <cblake@BBN.COM> with the following shell script
868snippets:
869
870 # Bourne/Korn/POSIX family of shells:
871 [ ${TERM:-foo} = foo ] && TERM=xterm # assume an xterm if we don't know
872 if [ ${TERM:-foo} = xterm ]; then
873 stty -icanon -echo min 0 time 15 # see if enhanced rxvt or not
874 echo -n '^[Z'
875 read term_id
876 stty icanon echo
877 if [ ""${term_id} = '^[[?1;2C' -a ${DISPLAY:-foo} = foo ]; then
878 echo -n '^[[7n' # query the rxvt we are in for the DISPLAY string
879 read DISPLAY # set it in our local shell
880 fi
881 fi
882
883=item How do I compile the manual pages for myself?
884
885You need to have a recent version of perl installed as F</usr/bin/perl>,
886one that comes with F<pod2man>, F<pod2text> and F<pod2html>. Then go to
887the doc subdirectory and enter C<make alldoc>.
888
889=item My question isn't answered here, can I ask a human?
890
891Before sending me mail, you could go to IRC: C<irc.freenode.net>,
892channel C<#rxvt-unicode> has some rxvt-unicode enthusiasts that might be
893interested in learning about new and exciting problems (but not FAQs :).
894
895=back
896
897=head1 RXVT TECHNICAL REFERENCE 1219=head1 RXVT-UNICODE TECHNICAL REFERENCE
898
899=head1 DESCRIPTION
900 1220
901The rest of this document describes various technical aspects of 1221The rest of this document describes various technical aspects of
902B<rxvt-unicode>. First the description of supported command sequences, 1222B<rxvt-unicode>. First the description of supported command sequences,
903followed by pixmap support and last by a description of all features 1223followed by pixmap support and last by a description of all features
904selectable at C<configure> time. 1224selectable at C<configure> time.
905 1225
906=head1 Definitions 1226=head2 Definitions
907 1227
908=over 4 1228=over 4
909 1229
910=item B<< C<c> >> 1230=item B<< C<c> >>
911 1231
929 1249
930A text parameter composed of printable characters. 1250A text parameter composed of printable characters.
931 1251
932=back 1252=back
933 1253
934=head1 Values 1254=head2 Values
935 1255
936=over 4 1256=over 4
937 1257
938=item B<< C<ENQ> >> 1258=item B<< C<ENQ> >>
939 1259
982 1302
983Space Character 1303Space Character
984 1304
985=back 1305=back
986 1306
987=head1 Escape Sequences 1307=head2 Escape Sequences
988 1308
989=over 4 1309=over 4
990 1310
991=item B<< C<ESC # 8> >> 1311=item B<< C<ESC # 8> >>
992 1312
1090 1410
1091=back 1411=back
1092 1412
1093X<CSI> 1413X<CSI>
1094 1414
1095=head1 CSI (Command Sequence Introducer) Sequences 1415=head2 CSI (Command Sequence Introducer) Sequences
1096 1416
1097=over 4 1417=over 4
1098 1418
1099=item B<< C<ESC [ Ps @> >> 1419=item B<< C<ESC [ Ps @> >>
1100 1420
1370 1690
1371=back 1691=back
1372 1692
1373X<PrivateModes> 1693X<PrivateModes>
1374 1694
1375=head1 DEC Private Modes 1695=head2 DEC Private Modes
1376 1696
1377=over 4 1697=over 4
1378 1698
1379=item B<< C<ESC [ ? Pm h> >> 1699=item B<< C<ESC [ ? Pm h> >>
1380 1700
1396 1716
1397Toggle DEC Private Mode Values (rxvt extension). I<where> 1717Toggle DEC Private Mode Values (rxvt extension). I<where>
1398 1718
1399=over 4 1719=over 4
1400 1720
1401=item B<< C<Ps = 1> >> (DECCKM) 1721=item B<< C<Pm = 1> >> (DECCKM)
1402 1722
1403=begin table 1723=begin table
1404 1724
1405 B<< C<h> >> Application Cursor Keys 1725 B<< C<h> >> Application Cursor Keys
1406 B<< C<l> >> Normal Cursor Keys 1726 B<< C<l> >> Normal Cursor Keys
1407 1727
1408=end table 1728=end table
1409 1729
1410=item B<< C<Ps = 2> >> (ANSI/VT52 mode) 1730=item B<< C<Pm = 2> >> (ANSI/VT52 mode)
1411 1731
1412=begin table 1732=begin table
1413 1733
1414 B<< C<h> >> Enter VT52 mode 1734 B<< C<h> >> Enter VT52 mode
1415 B<< C<l> >> Enter VT52 mode 1735 B<< C<l> >> Enter VT52 mode
1416 1736
1417=end table 1737=end table
1418 1738
1419=item B<< C<Ps = 3> >> 1739=item B<< C<Pm = 3> >>
1420 1740
1421=begin table 1741=begin table
1422 1742
1423 B<< C<h> >> 132 Column Mode (DECCOLM) 1743 B<< C<h> >> 132 Column Mode (DECCOLM)
1424 B<< C<l> >> 80 Column Mode (DECCOLM) 1744 B<< C<l> >> 80 Column Mode (DECCOLM)
1425 1745
1426=end table 1746=end table
1427 1747
1428=item B<< C<Ps = 4> >> 1748=item B<< C<Pm = 4> >>
1429 1749
1430=begin table 1750=begin table
1431 1751
1432 B<< C<h> >> Smooth (Slow) Scroll (DECSCLM) 1752 B<< C<h> >> Smooth (Slow) Scroll (DECSCLM)
1433 B<< C<l> >> Jump (Fast) Scroll (DECSCLM) 1753 B<< C<l> >> Jump (Fast) Scroll (DECSCLM)
1434 1754
1435=end table 1755=end table
1436 1756
1437=item B<< C<Ps = 5> >> 1757=item B<< C<Pm = 5> >>
1438 1758
1439=begin table 1759=begin table
1440 1760
1441 B<< C<h> >> Reverse Video (DECSCNM) 1761 B<< C<h> >> Reverse Video (DECSCNM)
1442 B<< C<l> >> Normal Video (DECSCNM) 1762 B<< C<l> >> Normal Video (DECSCNM)
1443 1763
1444=end table 1764=end table
1445 1765
1446=item B<< C<Ps = 6> >> 1766=item B<< C<Pm = 6> >>
1447 1767
1448=begin table 1768=begin table
1449 1769
1450 B<< C<h> >> Origin Mode (DECOM) 1770 B<< C<h> >> Origin Mode (DECOM)
1451 B<< C<l> >> Normal Cursor Mode (DECOM) 1771 B<< C<l> >> Normal Cursor Mode (DECOM)
1452 1772
1453=end table 1773=end table
1454 1774
1455=item B<< C<Ps = 7> >> 1775=item B<< C<Pm = 7> >>
1456 1776
1457=begin table 1777=begin table
1458 1778
1459 B<< C<h> >> Wraparound Mode (DECAWM) 1779 B<< C<h> >> Wraparound Mode (DECAWM)
1460 B<< C<l> >> No Wraparound Mode (DECAWM) 1780 B<< C<l> >> No Wraparound Mode (DECAWM)
1461 1781
1462=end table 1782=end table
1463 1783
1464=item B<< C<Ps = 8> >> I<unimplemented> 1784=item B<< C<Pm = 8> >> I<unimplemented>
1465 1785
1466=begin table 1786=begin table
1467 1787
1468 B<< C<h> >> Auto-repeat Keys (DECARM) 1788 B<< C<h> >> Auto-repeat Keys (DECARM)
1469 B<< C<l> >> No Auto-repeat Keys (DECARM) 1789 B<< C<l> >> No Auto-repeat Keys (DECARM)
1470 1790
1471=end table 1791=end table
1472 1792
1473=item B<< C<Ps = 9> >> X10 XTerm 1793=item B<< C<Pm = 9> >> X10 XTerm
1474 1794
1475=begin table 1795=begin table
1476 1796
1477 B<< C<h> >> Send Mouse X & Y on button press. 1797 B<< C<h> >> Send Mouse X & Y on button press.
1478 B<< C<l> >> No mouse reporting. 1798 B<< C<l> >> No mouse reporting.
1479 1799
1480=end table 1800=end table
1481 1801
1482=item B<< C<Ps = 25> >> 1802=item B<< C<Pm = 25> >>
1483 1803
1484=begin table 1804=begin table
1485 1805
1486 B<< C<h> >> Visible cursor {cnorm/cvvis} 1806 B<< C<h> >> Visible cursor {cnorm/cvvis}
1487 B<< C<l> >> Invisible cursor {civis} 1807 B<< C<l> >> Invisible cursor {civis}
1488 1808
1489=end table 1809=end table
1490 1810
1491=item B<< C<Ps = 30> >> 1811=item B<< C<Pm = 30> >>
1492 1812
1493=begin table 1813=begin table
1494 1814
1495 B<< C<h> >> scrollBar visisble 1815 B<< C<h> >> scrollBar visisble
1496 B<< C<l> >> scrollBar invisisble 1816 B<< C<l> >> scrollBar invisisble
1497 1817
1498=end table 1818=end table
1499 1819
1500=item B<< C<Ps = 35> >> (B<rxvt>) 1820=item B<< C<Pm = 35> >> (B<rxvt>)
1501 1821
1502=begin table 1822=begin table
1503 1823
1504 B<< C<h> >> Allow XTerm Shift+key sequences 1824 B<< C<h> >> Allow XTerm Shift+key sequences
1505 B<< C<l> >> Disallow XTerm Shift+key sequences 1825 B<< C<l> >> Disallow XTerm Shift+key sequences
1506 1826
1507=end table 1827=end table
1508 1828
1509=item B<< C<Ps = 38> >> I<unimplemented> 1829=item B<< C<Pm = 38> >> I<unimplemented>
1510 1830
1511Enter Tektronix Mode (DECTEK) 1831Enter Tektronix Mode (DECTEK)
1512 1832
1513=item B<< C<Ps = 40> >> 1833=item B<< C<Pm = 40> >>
1514 1834
1515=begin table 1835=begin table
1516 1836
1517 B<< C<h> >> Allow 80/132 Mode 1837 B<< C<h> >> Allow 80/132 Mode
1518 B<< C<l> >> Disallow 80/132 Mode 1838 B<< C<l> >> Disallow 80/132 Mode
1519 1839
1520=end table 1840=end table
1521 1841
1522=item B<< C<Ps = 44> >> I<unimplemented> 1842=item B<< C<Pm = 44> >> I<unimplemented>
1523 1843
1524=begin table 1844=begin table
1525 1845
1526 B<< C<h> >> Turn On Margin Bell 1846 B<< C<h> >> Turn On Margin Bell
1527 B<< C<l> >> Turn Off Margin Bell 1847 B<< C<l> >> Turn Off Margin Bell
1528 1848
1529=end table 1849=end table
1530 1850
1531=item B<< C<Ps = 45> >> I<unimplemented> 1851=item B<< C<Pm = 45> >> I<unimplemented>
1532 1852
1533=begin table 1853=begin table
1534 1854
1535 B<< C<h> >> Reverse-wraparound Mode 1855 B<< C<h> >> Reverse-wraparound Mode
1536 B<< C<l> >> No Reverse-wraparound Mode 1856 B<< C<l> >> No Reverse-wraparound Mode
1537 1857
1538=end table 1858=end table
1539 1859
1540=item B<< C<Ps = 46> >> I<unimplemented> 1860=item B<< C<Pm = 46> >> I<unimplemented>
1541 1861
1542=item B<< C<Ps = 47> >> 1862=item B<< C<Pm = 47> >>
1543 1863
1544=begin table 1864=begin table
1545 1865
1546 B<< C<h> >> Use Alternate Screen Buffer 1866 B<< C<h> >> Use Alternate Screen Buffer
1547 B<< C<l> >> Use Normal Screen Buffer 1867 B<< C<l> >> Use Normal Screen Buffer
1548 1868
1549=end table 1869=end table
1550 1870
1551X<Priv66> 1871X<Priv66>
1552 1872
1553=item B<< C<Ps = 66> >> 1873=item B<< C<Pm = 66> >>
1554 1874
1555=begin table 1875=begin table
1556 1876
1557 B<< C<h> >> Application Keypad (DECPAM) == C<ESC => 1877 B<< C<h> >> Application Keypad (DECPAM) == C<ESC =>
1558 B<< C<l> >> Normal Keypad (DECPNM) == C<< ESC > >> 1878 B<< C<l> >> Normal Keypad (DECPNM) == C<< ESC > >>
1559 1879
1560=end table 1880=end table
1561 1881
1562=item B<< C<Ps = 67> >> 1882=item B<< C<Pm = 67> >>
1563 1883
1564=begin table 1884=begin table
1565 1885
1566 B<< C<h> >> Backspace key sends B<< C<BS> (DECBKM) >> 1886 B<< C<h> >> Backspace key sends B<< C<BS> (DECBKM) >>
1567 B<< C<l> >> Backspace key sends B<< C<DEL> >> 1887 B<< C<l> >> Backspace key sends B<< C<DEL> >>
1568 1888
1569=end table 1889=end table
1570 1890
1571=item B<< C<Ps = 1000> >> (X11 XTerm) 1891=item B<< C<Pm = 1000> >> (X11 XTerm)
1572 1892
1573=begin table 1893=begin table
1574 1894
1575 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.
1576 B<< C<l> >> No mouse reporting. 1896 B<< C<l> >> No mouse reporting.
1577 1897
1578=end table 1898=end table
1579 1899
1580=item B<< C<Ps = 1001> >> (X11 XTerm) I<unimplemented> 1900=item B<< C<Pm = 1001> >> (X11 XTerm) I<unimplemented>
1581 1901
1582=begin table 1902=begin table
1583 1903
1584 B<< C<h> >> Use Hilite Mouse Tracking. 1904 B<< C<h> >> Use Hilite Mouse Tracking.
1585 B<< C<l> >> No mouse reporting. 1905 B<< C<l> >> No mouse reporting.
1586 1906
1587=end table 1907=end table
1588 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
1589=item B<< C<Ps = 1010> >> (B<rxvt>) 1927=item B<< C<Pm = 1010> >> (B<rxvt>)
1590 1928
1591=begin table 1929=begin table
1592 1930
1593 B<< C<h> >> Don't scroll to bottom on TTY output 1931 B<< C<h> >> Don't scroll to bottom on TTY output
1594 B<< C<l> >> Scroll to bottom on TTY output 1932 B<< C<l> >> Scroll to bottom on TTY output
1595 1933
1596=end table 1934=end table
1597 1935
1598=item B<< C<Ps = 1011> >> (B<rxvt>) 1936=item B<< C<Pm = 1011> >> (B<rxvt>)
1599 1937
1600=begin table 1938=begin table
1601 1939
1602 B<< C<h> >> Scroll to bottom when a key is pressed 1940 B<< C<h> >> Scroll to bottom when a key is pressed
1603 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
1604 1942
1605=end table 1943=end table
1606 1944
1607=item B<< C<Ps = 1021> >> (B<rxvt>) 1945=item B<< C<Pm = 1021> >> (B<rxvt>)
1608 1946
1609=begin table 1947=begin table
1610 1948
1611 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>)
1612 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)
1613 1951
1614=end table 1952=end table
1615 1953
1616=item B<< C<Ps = 1047> >> 1954=item B<< C<Pm = 1047> >>
1617 1955
1618=begin table 1956=begin table
1619 1957
1620 B<< C<h> >> Use Alternate Screen Buffer 1958 B<< C<h> >> Use Alternate Screen Buffer
1621 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
1622 1960
1623=end table 1961=end table
1624 1962
1625=item B<< C<Ps = 1048> >> 1963=item B<< C<Pm = 1048> >>
1626 1964
1627=begin table 1965=begin table
1628 1966
1629 B<< C<h> >> Save cursor position 1967 B<< C<h> >> Save cursor position
1630 B<< C<l> >> Restore cursor position 1968 B<< C<l> >> Restore cursor position
1631 1969
1632=end table 1970=end table
1633 1971
1634=item B<< C<Ps = 1049> >> 1972=item B<< C<Pm = 1049> >>
1635 1973
1636=begin table 1974=begin table
1637 1975
1638 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
1639 B<< C<l> >> Use Normal Screen Buffer 1977 B<< C<l> >> Use Normal Screen Buffer
1644 1982
1645=back 1983=back
1646 1984
1647X<XTerm> 1985X<XTerm>
1648 1986
1649=head1 XTerm Operating System Commands 1987=head2 XTerm Operating System Commands
1650 1988
1651=over 4 1989=over 4
1652 1990
1653=item B<< C<ESC ] Ps;Pt ST> >> 1991=item B<< C<ESC ] Ps;Pt ST> >>
1654 1992
1668 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> >>
1669 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> >>
1670 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> >>
1671 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]
1672 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]
1673 B<< C<Ps = 20> >> Change background pixmap parameters (see section XPM) (Compile XPM). 2011 B<< C<Ps = 20> >> Change background pixmap parameters (see section BACKGROUND IMAGE) (Compile AfterImage).
1674 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> >>.
1675 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>
1676 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> >>.
1677 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> >>
1678 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> >>
1679 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).
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>.
1680 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> >>
1681 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).
1682 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> >>
1683 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> >>
1684 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>.
1691 2030
1692=end table 2031=end table
1693 2032
1694=back 2033=back
1695 2034
1696X<XPM> 2035=head1 BACKGROUND IMAGE
1697 2036
1698=head1 XPM
1699
1700For 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
1701of 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
1702sequence of scaling/positioning commands separated by semi-colons. The 2039sequence of scaling/positioning commands separated by semi-colons. The
1703scaling/positioning commands are as follows: 2040scaling/positioning commands are as follows:
1704 2041
1705=over 4 2042=over 4
1706 2043
1744 2081
1745For example: 2082For example:
1746 2083
1747=over 4 2084=over 4
1748 2085
1749=item B<\E]20;funky\a> 2086=item B<\E]20;funky.jpg\a>
1750 2087
1751load B<funky.xpm> as a tiled image 2088load B<funky.jpg> as a tiled image
1752 2089
1753=item B<\E]20;mona;100\a> 2090=item B<\E]20;mona.jpg;100\a>
1754 2091
1755load B<mona.xpm> with a scaling of 100% 2092load B<mona.jpg> with a scaling of 100%
1756 2093
1757=item B<\E]20;;200;?\a> 2094=item B<\E]20;;200;?\a>
1758 2095
1759rescale the current pixmap to 200% and display the image geometry in 2096rescale the current pixmap to 200% and display the image geometry in
1760the title 2097the title
1799=begin table 2136=begin table
1800 2137
1801 4 Shift 2138 4 Shift
1802 8 Meta 2139 8 Meta
1803 16 Control 2140 16 Control
1804 32 Double Click I<(Rxvt extension)> 2141 32 Double Click I<(rxvt extension)>
1805 2142
1806=end table 2143=end table
1807 2144
1808Col = B<< C<< <x> - SPACE >> >> 2145Col = B<< C<< <x> - SPACE >> >>
1809 2146
1887 2224
1888=head1 CONFIGURE OPTIONS 2225=head1 CONFIGURE OPTIONS
1889 2226
1890General hint: if you get compile errors, then likely your configuration 2227General hint: if you get compile errors, then likely your configuration
1891hasn'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
1892the 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>
1893myself, so it should generally be a working config. Of course, you should 2230switches). Of course, you should always report when a combination doesn't
1894always report when a combination doesn't work, so it can be fixed. Marc 2231work, so it can be fixed. Marc Lehmann <rxvt@schmorp.de>.
1895Lehmann <rxvt@schmorp.de>.
1896 2232
1897All 2233All
1898 2234
1899=over 4 2235=over 4
1900 2236
1932 2268
1933=begin table 2269=begin table
1934 2270
1935 all all available codeset groups 2271 all all available codeset groups
1936 zh common chinese encodings 2272 zh common chinese encodings
1937 zh_ext rarely used but very big chinese encodigs 2273 zh_ext rarely used but very big chinese encodings
1938 jp common japanese encodings 2274 jp common japanese encodings
1939 jp_ext rarely used but big japanese encodings 2275 jp_ext rarely used but big japanese encodings
1940 kr korean encodings 2276 kr korean encodings
1941 2277
1942=end table 2278=end table
1946Add support for XIM (X Input Method) protocol. This allows using 2282Add support for XIM (X Input Method) protocol. This allows using
1947alternative input methods (e.g. kinput2) and will also correctly 2283alternative input methods (e.g. kinput2) and will also correctly
1948set up the input for people using dead keys or compose keys. 2284set up the input for people using dead keys or compose keys.
1949 2285
1950=item --enable-unicode3 (default: off) 2286=item --enable-unicode3 (default: off)
2287
2288Recommended to stay off unless you really need non-BMP characters.
1951 2289
1952Enable direct support for displaying unicode codepoints above 2290Enable direct support for displaying unicode codepoints above
195365535 (the basic multilingual page). This increases storage 229165535 (the basic multilingual page). This increases storage
1954requirements 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
1955support these extra characters, but Xft does. 2293support these extra characters, but Xft does.
1956 2294
1957Please note that rxvt-unicode can store unicode code points >65535 2295Please note that rxvt-unicode can store unicode code points >65535
1958even without this flag, but the number of such characters is 2296even without this flag, but the number of such characters is
1959limited to a view thousand (shared with combining characters, 2297limited to a few thousand (shared with combining characters,
1960see next switch), and right now rxvt-unicode cannot display them 2298see next switch), and right now rxvt-unicode cannot display them
1961(input/output and cut&paste still work, though). 2299(input/output and cut&paste still work, though).
1962 2300
1963=item --enable-combining (default: on) 2301=item --enable-combining (default: on)
1964 2302
1966composite characters. This is required for proper viewing of text 2304composite characters. This is required for proper viewing of text
1967where accents are encoded as seperate unicode characters. This is 2305where accents are encoded as seperate unicode characters. This is
1968done by using precomposited characters when available or creating 2306done by using precomposited characters when available or creating
1969new pseudo-characters when no precomposed form exists. 2307new pseudo-characters when no precomposed form exists.
1970 2308
1971Without --enable-unicode3, the number of additional precomposed characters 2309Without --enable-unicode3, the number of additional precomposed
1972is rather limited (2048, if this is full, rxvt-unicode will use the 2310characters is somewhat limited (the 6400 private use characters will be
1973private use area, extending the number of combinations to 8448). With
1974--enable-unicode3, no practical limit exists. 2311(ab-)used). With --enable-unicode3, no practical limit exists.
1975 2312
1976This option will also enable storage (but not display) of characters 2313This option will also enable storage (but not display) of characters
1977beyond plane 0 (>65535) when --enable-unicode3 was not specified. 2314beyond plane 0 (>65535) when --enable-unicode3 was not specified.
1978 2315
1979The combining table also contains entries for arabic presentation forms, 2316The combining table also contains entries for arabic presentation forms,
1980but 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
1981tell me how these are to be used...). 2318tell me how these are to be used...).
1982 2319
1983=item --enable-fallback(=CLASS) (default: Rxvt) 2320=item --enable-fallback(=CLASS) (default: Rxvt)
1984 2321
1985When 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.
1986 2324
1987=item --with-res-name=NAME (default: urxvt) 2325=item --with-res-name=NAME (default: urxvt)
1988 2326
1989Use the given name as default application name when 2327Use the given name as default application name when
1990reading resources. Specify --with-res-name=rxvt to replace rxvt. 2328reading resources. Specify --with-res-name=rxvt to replace rxvt.
2010 2348
2011Write user and tty to lastlog file (used by programs like 2349Write user and tty to lastlog file (used by programs like
2012F<lastlogin>) at start of rxvt execution. This option requires 2350F<lastlogin>) at start of rxvt execution. This option requires
2013--enable-utmp to also be specified. 2351--enable-utmp to also be specified.
2014 2352
2015=item --enable-xpm-background (default: on) 2353=item --enable-afterimage (default: on)
2016 2354
2017Add 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.
2018 2367
2019=item --enable-transparency (default: on) 2368=item --enable-transparency (default: on)
2020 2369
2021Add support for inheriting parent backgrounds thus giving a fake 2370Add support for backgrounds, creating illusion of transparency in the term.
2022transparency to the term.
2023 2371
2024=item --enable-fading (default: on) 2372=item --enable-fading (default: on)
2025 2373
2026Add support for fading the text when focus is lost (requires C<--enable-transparency>). 2374Add support for fading the text when focus is lost.
2027
2028=item --enable-tinting (default: on)
2029
2030Add support for tinting of transparent backgrounds (requires C<--enable-transparency>).
2031 2375
2032=item --enable-rxvt-scroll (default: on) 2376=item --enable-rxvt-scroll (default: on)
2033 2377
2034Add support for the original rxvt scrollbar. 2378Add support for the original rxvt scrollbar.
2035 2379
2078A non-exhaustive list of features enabled by C<--enable-frills> (possibly 2422A non-exhaustive list of features enabled by C<--enable-frills> (possibly
2079in combination with other switches) is: 2423in combination with other switches) is:
2080 2424
2081 MWM-hints 2425 MWM-hints
2082 EWMH-hints (pid, utf8 names) and protocols (ping) 2426 EWMH-hints (pid, utf8 names) and protocols (ping)
2427 urgency hint
2083 seperate underline colour (-underlineColor) 2428 seperate underline colour (-underlineColor)
2084 settable border widths and borderless switch (-w, -b, -bl) 2429 settable border widths and borderless switch (-w, -b, -bl)
2430 visual depth selection (-depth)
2085 settable extra linespacing /-lsp) 2431 settable extra linespacing /-lsp)
2086 iso-14755-2 and -3, and visual feedback 2432 iso-14755 5.1 (basic) support
2087 backindex and forwardindex escape sequence
2088 window op and some xterm/OSC escape sequences
2089 tripleclickwords (-tcw) 2433 tripleclickwords (-tcw)
2090 settable insecure mode (-insecure) 2434 settable insecure mode (-insecure)
2091 keysym remapping support 2435 keysym remapping support
2092 cursor blinking and underline cursor (-cb, -uc) 2436 cursor blinking and underline cursor (-cb, -uc)
2093 XEmbed support (-embed) 2437 XEmbed support (-embed)
2094 user-pty (-pty-fd) 2438 user-pty (-pty-fd)
2095 hold on exit (-hold) 2439 hold on exit (-hold)
2096 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
2097 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
2098 2456
2099=item --enable-iso14755 (default: on) 2457=item --enable-iso14755 (default: on)
2100 2458
2101Enable extended ISO 14755 support (see @@RXVT_NAME@@(1), or 2459Enable extended ISO 14755 support (see @@RXVT_NAME@@(1), or
2102F<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
2106=item --enable-keepscrolling (default: on) 2464=item --enable-keepscrolling (default: on)
2107 2465
2108Add support for continual scrolling of the display when you hold 2466Add support for continual scrolling of the display when you hold
2109the mouse button down on a scrollbar arrow. 2467the mouse button down on a scrollbar arrow.
2110 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
2111=item --enable-mousewheel (default: on) 2474=item --enable-mousewheel (default: on)
2112 2475
2113Add support for scrolling via mouse wheel or buttons 4 & 5. 2476Add support for scrolling via mouse wheel or buttons 4 & 5.
2114 2477
2115=item --enable-slipwheeling (default: on) 2478=item --enable-slipwheeling (default: on)
2116 2479
2117Add support for continual scrolling (using the mouse wheel as an 2480Add support for continual scrolling (using the mouse wheel as an
2118accelerator) while the control key is held down. This option 2481accelerator) while the control key is held down. This option
2119requires --enable-mousewheel to also be specified. 2482requires --enable-mousewheel to also be specified.
2120 2483
2121=item --disable-new-selection
2122
2123Remove support for mouse selection style like that of xterm.
2124
2125=item --enable-dmalloc (default: off)
2126
2127Use Gray Watson's malloc - which is good for debugging See
2128http://www.letters.com/dmalloc/ for details If you use either this or the
2129next option, you may need to edit src/Makefile after compiling to point
2130DINCLUDE and DLIB to the right places.
2131
2132You can only use either this option and the following (should
2133you use either) .
2134
2135=item --enable-dlmalloc (default: off)
2136
2137Use Doug Lea's malloc - which is good for a production version
2138See L<http://g.oswego.edu/dl/html/malloc.html> for details.
2139
2140=item --enable-smart-resize (default: on) 2484=item --enable-smart-resize (default: off)
2141 2485
2142Add smart growth/shrink behaviour when changing font size via hot 2486Add smart growth/shrink behaviour when resizing.
2143keys. 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
2144the screen in a fixed position. 2488the screen in a fixed position.
2145 2489
2146=item --enable-pointer-blank (default: on) 2490=item --enable-pointer-blank (default: on)
2147 2491
2148Add support to have the pointer disappear when typing or inactive. 2492Add support to have the pointer disappear when typing or inactive.
2149 2493
2150=item --enable-perl (default: off) 2494=item --enable-perl (default: on)
2151 2495
2152Enable an embedded perl interpreter. See the B<@@RXVT_NAME@@perl(3)> 2496Enable an embedded perl interpreter. See the B<@@RXVT_NAME@@perl(3)>
2153manpage (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
2154in 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
2155perl interpreter that is used can be specified via the C<PERL> environment 2499default. The perl interpreter that is used can be specified via the
2156variable 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.
2157 2508
2158=item --with-name=NAME (default: urxvt) 2509=item --with-name=NAME (default: urxvt)
2159 2510
2160Set the basename for the installed binaries, resulting 2511Set the basename for the installed binaries, resulting
2161in 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
2171PATH. 2522PATH.
2172 2523
2173=item --with-x 2524=item --with-x
2174 2525
2175Use the X Window System (pretty much default, eh?). 2526Use the X Window System (pretty much default, eh?).
2176
2177=item --with-xpm-includes=DIR
2178
2179Look for the XPM includes in DIR.
2180
2181=item --with-xpm-library=DIR
2182
2183Look for the XPM library in DIR.
2184
2185=item --with-xpm
2186
2187Not needed - define via --enable-xpm-background.
2188 2527
2189=back 2528=back
2190 2529
2191=head1 AUTHORS 2530=head1 AUTHORS
2192 2531

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines