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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines