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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines