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.162 by ayin, Sat Jan 19 15:00:49 2008 UTC

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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines