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.88 by root, Wed Jan 18 17:49:46 2006 UTC vs.
Revision 1.151 by sasha, Thu Nov 15 18:40:10 2007 UTC

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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines