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.84 by root, Mon Jan 16 15:07:27 2006 UTC vs.
Revision 1.151 by sasha, Thu Nov 15 18:40:10 2007 UTC

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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines