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.102 by root, Tue Jan 31 20:50:48 2006 UTC vs.
Revision 1.187 by sf-exg, Mon Apr 19 11:02:34 2010 UTC

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 also available on the World Wide Web at 21The newest version of this document is also available on the World Wide Web at
22L<http://cvs.schmorp.de/browse/*checkout*/rxvt-unicode/doc/rxvt.7.html>. 22L<http://pod.tst.eu/http://cvs.schmorp.de/rxvt-unicode/doc/rxvt.7.pod>.
23 23
24The main manual page for @@RXVT_NAME@@ itself is available at
25L<http://pod.tst.eu/http://cvs.schmorp.de/rxvt-unicode/doc/rxvt.1.pod>.
26
24=head1 FREQUENTLY ASKED QUESTIONS 27=head1 RXVT-UNICODE/URXVT FREQUENTLY ASKED QUESTIONS
25 28
26 29
27=head2 Meta, Features & Commandline Issues 30=head2 Meta, Features & Commandline Issues
28 31
29=head3 My question isn't answered here, can I ask a human? 32=head3 My question isn't answered here, can I ask a human?
30 33
31Before sending me mail, you could go to IRC: C<irc.freenode.net>, 34Before sending me mail, you could go to IRC: C<irc.freenode.net>,
32channel C<#rxvt-unicode> has some rxvt-unicode enthusiasts that might be 35channel C<#rxvt-unicode> has some rxvt-unicode enthusiasts that might be
33interested in learning about new and exciting problems (but not FAQs :). 36interested in learning about new and exciting problems (but not FAQs :).
34 37
38=head3 I use Gentoo, and I have a problem...
39
40There are three big problems with Gentoo Linux: first of all, most if not
41all Gentoo systems are completely broken (missing or mismatched header
42files, broken compiler etc. are just the tip of the iceberg); secondly,
43the Gentoo maintainer thinks it is a good idea to add broken patches to
44the code; and lastly, it should be called Gentoo GNU/Linux.
45
46For these reasons, it is impossible to support rxvt-unicode on
47Gentoo. Problems appearing on Gentoo systems will usually simply be
48ignored unless they can be reproduced on non-Gentoo systems.
49
35=head3 Does it support tabs, can I have a tabbed rxvt-unicode? 50=head3 Does it support tabs, can I have a tabbed rxvt-unicode?
36 51
37Beginning with version 7.3, there is a perl extension that implements a 52Beginning 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 53simple tabbed terminal. It is installed by default, so any of these should
39give you tabs: 54give you tabs:
40 55
41 @@RXVT_NAME@@ -pe tabbed 56 @@URXVT_NAME@@ -pe tabbed
42 57
43 URxvt.perl-ext-common: default,tabbed 58 URxvt.perl-ext-common: default,tabbed
44 59
45It will also work fine with tabbing functionality of many window managers 60It will also work fine with tabbing functionality of many window managers
46or similar tabbing programs, and its embedding-features allow it to be 61or similar tabbing programs, and its embedding-features allow it to be
50 65
51=head3 How do I know which rxvt-unicode version I'm using? 66=head3 How do I know which rxvt-unicode version I'm using?
52 67
53The version number is displayed with the usage (-h). Also the escape 68The version number is displayed with the usage (-h). Also the escape
54sequence C<ESC [ 8 n> sets the window title to the version number. When 69sequence C<ESC [ 8 n> sets the window title to the version number. When
55using the @@RXVT_NAME@@c client, the version displayed is that of the 70using the @@URXVT_NAME@@c client, the version displayed is that of the
56daemon. 71daemon.
57 72
58=head3 Rxvt-unicode uses gobs of memory, how can I reduce that? 73=head3 Rxvt-unicode uses gobs of memory, how can I reduce that?
59 74
60Rxvt-unicode tries to obey the rule of not charging you for something you 75Rxvt-unicode tries to obey the rule of not charging you for something you
686 bytes per screen cell. For a 160x?? window this amounts to almost a 836 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) 84kilobyte 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 85use 10 Megabytes of memory. With C<--enable-unicode3> it gets worse, as
71rxvt-unicode then uses 8 bytes per screen cell. 86rxvt-unicode then uses 8 bytes per screen cell.
72 87
73=head3 How can I start @@RXVT_NAME@@d in a race-free way? 88=head3 How can I start @@URXVT_NAME@@d in a race-free way?
74 89
75Try C<@@RXVT_NAME@@d -f -o>, which tells @@RXVT_NAME@@d to open the 90Try C<@@URXVT_NAME@@d -f -o>, which tells @@URXVT_NAME@@d to open the
76display, create the listening socket and then fork. 91display, create the listening socket and then fork.
77 92
93=head3 How can I start @@URXVT_NAME@@d automatically when I run @@URXVT_NAME@@c?
94
95If you want to start @@URXVT_NAME@@d automatically whenever you run
96@@URXVT_NAME@@c and the daemon isn't running yet, use this script:
97
98 #!/bin/sh
99 @@URXVT_NAME@@c "$@"
100 if [ $? -eq 2 ]; then
101 @@URXVT_NAME@@d -q -o -f
102 @@URXVT_NAME@@c "$@"
103 fi
104
105This tries to create a new terminal, and if fails with exit status 2,
106meaning it couldn't connect to the daemon, it will start the daemon and
107re-run the command. Subsequent invocations of the script will re-use the
108existing daemon.
109
78=head3 How do I distinguish wether I'm running rxvt-unicode or a regular xterm? I need this to decide about setting colors etc. 110=head3 How do I distinguish whether I'm running rxvt-unicode or a regular xterm? I need this to decide about setting colors etc.
79 111
80rxvt and rxvt-unicode always export the variable "COLORTERM", so you can 112The original rxvt and rxvt-unicode always export the variable "COLORTERM",
81check and see if that is set. Note that several programs, JED, slrn, 113so you can check and see if that is set. Note that several programs, JED,
82Midnight Commander automatically check this variable to decide whether or 114slrn, Midnight Commander automatically check this variable to decide
83not to use color. 115whether or not to use color.
84 116
85=head3 How do I set the correct, full IP address for the DISPLAY variable? 117=head3 How do I set the correct, full IP address for the DISPLAY variable?
86 118
87If you've compiled rxvt-unicode with DISPLAY_IS_IP and have enabled 119If you've compiled rxvt-unicode with DISPLAY_IS_IP and have enabled
88insecure mode then it is possible to use the following shell script 120insecure mode then it is possible to use the following shell script
108 fi 140 fi
109 141
110=head3 How do I compile the manual pages on my own? 142=head3 How do I compile the manual pages on my own?
111 143
112You need to have a recent version of perl installed as F</usr/bin/perl>, 144You need to have a recent version of perl installed as F</usr/bin/perl>,
113one that comes with F<pod2man>, F<pod2text> and F<pod2html>. Then go to 145one that comes with F<pod2man>, F<pod2text> and F<pod2xhtml> (from
114the doc subdirectory and enter C<make alldoc>. 146F<Pod::Xhtml>). Then go to the doc subdirectory and enter C<make alldoc>.
115 147
116=head3 Isn't rxvt-unicode supposed to be small? Don't all those features bloat? 148=head3 Isn't rxvt-unicode supposed to be small? Don't all those features bloat?
117 149
118I often get asked about this, and I think, no, they didn't cause extra 150I often get asked about this, and I think, no, they didn't cause extra
119bloat. If you compare a minimal rxvt and a minimal urxvt, you can see 151bloat. If you compare a minimal rxvt and a minimal urxvt, you can see
125 157
126 text data bss drs rss filename 158 text data bss drs rss filename
127 98398 1664 24 15695 1824 rxvt --disable-everything 159 98398 1664 24 15695 1824 rxvt --disable-everything
128 188985 9048 66616 18222 1788 urxvt --disable-everything 160 188985 9048 66616 18222 1788 urxvt --disable-everything
129 161
130When you C<--enable-everything> (which _is_ unfair, as this involves xft 162When you C<--enable-everything> (which I<is> unfair, as this involves xft
131and full locale/XIM support which are quite bloaty inside libX11 and my 163and full locale/XIM support which are quite bloaty inside libX11 and my
132libc), the two diverge, but not unreasnobaly so. 164libc), the two diverge, but not unreasonably so.
133 165
134 text data bss drs rss filename 166 text data bss drs rss filename
135 163431 2152 24 20123 2060 rxvt --enable-everything 167 163431 2152 24 20123 2060 rxvt --enable-everything
136 1035683 49680 66648 29096 3680 urxvt --enable-everything 168 1035683 49680 66648 29096 3680 urxvt --enable-everything
137 169
180 212
181And here is rxvt-unicode: 213And here is rxvt-unicode:
182 214
183 libX11.so.6 => /usr/X11R6/lib/libX11.so.6 (0x00002aaaaabc3000) 215 libX11.so.6 => /usr/X11R6/lib/libX11.so.6 (0x00002aaaaabc3000)
184 libgcc_s.so.1 => /lib/libgcc_s.so.1 (0x00002aaaaada2000) 216 libgcc_s.so.1 => /lib/libgcc_s.so.1 (0x00002aaaaada2000)
185 libc.so.6 => /lib/libc.so.6 (0x00002aaaaaeb0000) 217 libc.so.6 => /lib/libc.so.6 (0x00002aaaaaeb0000)
186 libdl.so.2 => /lib/libdl.so.2 (0x00002aaaab0ee000) 218 libdl.so.2 => /lib/libdl.so.2 (0x00002aaaab0ee000)
187 /lib64/ld-linux-x86-64.so.2 (0x00002aaaaaaab000) 219 /lib64/ld-linux-x86-64.so.2 (0x00002aaaaaaab000)
188 220
189No large bloated libraries (of course, none were linked in statically), 221No large bloated libraries (of course, none were linked in statically),
190except maybe libX11 :) 222except maybe libX11 :)
191 223
192 224
193=head2 Rendering, Font & Look and Feel Issues 225=head2 Rendering, Font & Look and Feel Issues
194 226
195=head3 I can't get transparency working, what am I doing wrong? 227=head3 I can't get transparency working, what am I doing wrong?
196 228
197First of all, transparency isn't officially supported in rxvt-unicode, so 229First of all, please address all transparency related issues to Sasha Vasko at
198you are mostly on your own. Do not bug the author about it (but you may 230sasha@aftercode.net and do not bug the author about it. Also, if you can't
199bug everybody else). Also, if you can't get it working consider it a rite 231get it working consider it a rite of passage: ... and you failed.
200of passage: ... and you failed.
201 232
202Here are four ways to get transparency. B<Do> read the manpage and option 233Here are four ways to get transparency. B<Do> read the manpage and option
203descriptions for the programs mentioned and rxvt-unicode. Really, do it! 234descriptions for the programs mentioned and rxvt-unicode. Really, do it!
204 235
2051. Use inheritPixmap: 2361. Use transparent mode:
206 237
207 Esetroot wallpaper.jpg 238 Esetroot wallpaper.jpg
208 @@RXVT_NAME@@ -ip -tint red -sh 40 239 @@URXVT_NAME@@ -tr -tint red -sh 40
209 240
210That works. If you think it doesn't, you lack transparency and tinting 241That works. If you think it doesn't, you lack transparency and tinting
211support, or you are unable to read. 242support, or you are unable to read.
212 243
2132. Use a simple pixmap and emulate pseudo-transparency. This enables you 2442. Use a simple pixmap and emulate pseudo-transparency. This enables you
214to use effects other than tinting and shading: Just shade/tint/whatever 245to use effects other than tinting and shading: Just shade/tint/whatever
215your picture with gimp or any other tool: 246your picture with gimp or any other tool:
216 247
217 convert wallpaper.jpg -blur 20x20 -modulate 30 background.xpm 248 convert wallpaper.jpg -blur 20x20 -modulate 30 background.jpg
218 @@RXVT_NAME@@ -pixmap background.xpm -pe automove-background 249 @@URXVT_NAME@@ -pixmap "background.jpg;:root"
219 250
220That works. If you think it doesn't, you lack XPM and Perl support, or you 251That works. If you think it doesn't, you lack AfterImage support, or you
221are unable to read. 252are unable to read.
222 253
2233. Use an ARGB visual: 2543. Use an ARGB visual:
224 255
225 @@RXVT_NAME@@ -depth 32 -fg grey90 -bg rgba:0000/0000/4444/cccc 256 @@URXVT_NAME@@ -depth 32 -fg grey90 -bg rgba:0000/0000/4444/cccc
226 257
227This requires XFT support, and the support of your X-server. If that 258This requires XFT support, and the support of your X-server. If that
228doesn't work for you, blame Xorg and Keith Packard. ARGB visuals aren't 259doesn't work for you, blame Xorg and Keith Packard. ARGB visuals aren't
229there yet, no matter what they claim. Rxvt-Unicode contains the neccessary 260there yet, no matter what they claim. Rxvt-Unicode contains the necessary
230bugfixes and workarounds for Xft and Xlib to make it work, but that 261bugfixes and workarounds for Xft and Xlib to make it work, but that
231doesn't mean that your WM has the required kludges in place. 262doesn't mean that your WM has the required kludges in place.
232 263
2334. Use xcompmgr and let it do the job: 2644. Use xcompmgr and let it do the job:
234 265
236 -set _NET_WM_WINDOW_OPACITY 0xc0000000 267 -set _NET_WM_WINDOW_OPACITY 0xc0000000
237 268
238Then click on a window you want to make transparent. Replace C<0xc0000000> 269Then click on a window you want to make transparent. Replace C<0xc0000000>
239by other values to change the degree of opacity. If it doesn't work and 270by other values to change the degree of opacity. If it doesn't work and
240your server crashes, you got to keep the pieces. 271your server crashes, you got to keep the pieces.
241
242=head3 Why do some chinese characters look so different than others?
243
244This is because there is a difference between script and language --
245rxvt-unicode does not know which language the text that is output is,
246as it only knows the unicode character codes. If rxvt-unicode first
247sees a japanese/chinese character, it might choose a japanese font for
248display. Subsequent japanese characters will use that font. Now, many
249chinese characters aren't represented in japanese fonts, so when the first
250non-japanese character comes up, rxvt-unicode will look for a chinese font
251-- unfortunately at this point, it will still use the japanese font for
252chinese characters that are also in the japanese font.
253
254The workaround is easy: just tag a chinese font at the end of your font
255list (see the previous question). The key is to view the font list as
256a preference list: If you expect more japanese, list a japanese font
257first. If you expect more chinese, put a chinese font first.
258
259In the future it might be possible to switch language preferences at
260runtime (the internal data structure has no problem with using different
261fonts for the same character at the same time, but no interface for this
262has been designed yet).
263
264Until then, you might get away with switching fonts at runtime (see L<Can
265I switch the fonts at runtime?> later in this document).
266 272
267=head3 Why does rxvt-unicode sometimes leave pixel droppings? 273=head3 Why does rxvt-unicode sometimes leave pixel droppings?
268 274
269Most fonts were not designed for terminal use, which means that character 275Most fonts were not designed for terminal use, which means that character
270size varies a lot. A font that is otherwise fine for terminal use might 276size varies a lot. A font that is otherwise fine for terminal use might
276however: Xft fonts often draw glyphs larger than their acclaimed bounding 282however: Xft fonts often draw glyphs larger than their acclaimed bounding
277box, and rxvt-unicode has no way of detecting this (the correct way is to 283box, and rxvt-unicode has no way of detecting this (the correct way is to
278ask for the character bounding box, which unfortunately is wrong in these 284ask for the character bounding box, which unfortunately is wrong in these
279cases). 285cases).
280 286
281It's not clear (to me at least), wether this is a bug in Xft, freetype, 287It's not clear (to me at least), whether this is a bug in Xft, freetype,
282or the respective font. If you encounter this problem you might try using 288or the respective font. If you encounter this problem you might try using
283the C<-lsp> option to give the font more height. If that doesn't work, you 289the C<-lsp> option to give the font more height. If that doesn't work, you
284might be forced to use a different font. 290might be forced to use a different font.
285 291
286All of this is not a problem when using X11 core fonts, as their bounding 292All of this is not a problem when using X11 core fonts, as their bounding
310=head3 Can I switch the fonts at runtime? 316=head3 Can I switch the fonts at runtime?
311 317
312Yes, using an escape sequence. Try something like this, which has the same 318Yes, using an escape sequence. Try something like this, which has the same
313effect as using the C<-fn> switch, and takes effect immediately: 319effect as using the C<-fn> switch, and takes effect immediately:
314 320
315 printf '\e]50;%s\007' "9x15bold,xft:Kochi Gothic" 321 printf '\33]50;%s\007' "9x15bold,xft:Kochi Gothic"
316 322
317This is useful if you e.g. work primarily with japanese (and prefer a 323This is useful if you e.g. work primarily with japanese (and prefer a
318japanese font), but you have to switch to chinese temporarily, where 324japanese font), but you have to switch to chinese temporarily, where
319japanese fonts would only be in your way. 325japanese fonts would only be in your way.
320 326
322 328
323=head3 Why do italic characters look as if clipped? 329=head3 Why do italic characters look as if clipped?
324 330
325Many fonts have difficulties with italic characters and hinting. For 331Many fonts have difficulties with italic characters and hinting. For
326example, the otherwise very nicely hinted font C<xft:Bitstream Vera Sans 332example, the otherwise very nicely hinted font C<xft:Bitstream Vera Sans
327Mono> completely fails in it's italic face. A workaround might be to 333Mono> completely fails in its italic face. A workaround might be to
328enable freetype autohinting, i.e. like this: 334enable freetype autohinting, i.e. like this:
329 335
330 URxvt.italicFont: xft:Bitstream Vera Sans Mono:italic:autohint=true 336 URxvt.italicFont: xft:Bitstream Vera Sans Mono:italic:autohint=true
331 URxvt.boldItalicFont: xft:Bitstream Vera Sans Mono:bold:italic:autohint=true 337 URxvt.boldItalicFont: xft:Bitstream Vera Sans Mono:bold:italic:autohint=true
332 338
338memory and also speeds up rendering considerably. 344memory and also speeds up rendering considerably.
339 345
340=head3 Rxvt-unicode doesn't seem to anti-alias its fonts, what is wrong? 346=head3 Rxvt-unicode doesn't seem to anti-alias its fonts, what is wrong?
341 347
342Rxvt-unicode will use whatever you specify as a font. If it needs to 348Rxvt-unicode will use whatever you specify as a font. If it needs to
343fall back to it's default font search list it will prefer X11 core 349fall back to its default font search list it will prefer X11 core
344fonts, because they are small and fast, and then use Xft fonts. It has 350fonts, because they are small and fast, and then use Xft fonts. It has
345antialiasing disabled for most of them, because the author thinks they 351antialiasing disabled for most of them, because the author thinks they
346look best that way. 352look best that way.
347 353
348If you want antialiasing, you have to specify the fonts manually. 354If you want antialiasing, you have to specify the fonts manually.
350=head3 What's with this bold/blink stuff? 356=head3 What's with this bold/blink stuff?
351 357
352If no bold colour is set via C<colorBD:>, bold will invert text using the 358If no bold colour is set via C<colorBD:>, bold will invert text using the
353standard foreground colour. 359standard foreground colour.
354 360
355For the standard background colour, blinking will actually make the 361For the standard background colour, blinking will actually make
356text blink when compiled with C<--enable-blinking>. with standard 362the text blink when compiled with C<--enable-text-blink>. Without
357colours. Without C<--enable-blinking>, the blink attribute will be 363C<--enable-text-blink>, the blink attribute will be ignored.
358ignored.
359 364
360On ANSI colours, bold/blink attributes are used to set high-intensity 365On ANSI colours, bold/blink attributes are used to set high-intensity
361foreground/background colors. 366foreground/background colors.
362 367
363color0-7 are the low-intensity colors. 368color0-7 are the low-intensity colors.
388 URxvt.color12: #0000FF 393 URxvt.color12: #0000FF
389 URxvt.color13: #FF00FF 394 URxvt.color13: #FF00FF
390 URxvt.color14: #00FFFF 395 URxvt.color14: #00FFFF
391 URxvt.color15: #FFFFFF 396 URxvt.color15: #FFFFFF
392 397
393And here is a more complete set of non-standard colors described (not by 398And here is a more complete set of non-standard colors.
394me) as "pretty girly".
395 399
396 URxvt.cursorColor: #dc74d1 400 URxvt.cursorColor: #dc74d1
397 URxvt.pointerColor: #dc74d1 401 URxvt.pointerColor: #dc74d1
398 URxvt.background: #0e0e0e 402 URxvt.background: #0e0e0e
399 URxvt.foreground: #4ad5e1 403 URxvt.foreground: #4ad5e1
410 URxvt.color6: #73f7ff 414 URxvt.color6: #73f7ff
411 URxvt.color14: #73f7ff 415 URxvt.color14: #73f7ff
412 URxvt.color7: #e1dddd 416 URxvt.color7: #e1dddd
413 URxvt.color15: #e1dddd 417 URxvt.color15: #e1dddd
414 418
419They have been described (not by me) as "pretty girly".
420
415=head3 Why do some characters look so much different than others? 421=head3 Why do some characters look so much different than others?
416 422
417See next entry. 423See next entry.
418 424
419=head3 How does rxvt-unicode choose fonts? 425=head3 How does rxvt-unicode choose fonts?
420 426
421Most fonts do not contain the full range of Unicode, which is 427Most fonts do not contain the full range of Unicode, which is
422fine. Chances are that the font you (or the admin/package maintainer of 428fine. Chances are that the font you (or the admin/package maintainer of
423your system/os) have specified does not cover all the characters you want 429your system/os) have specified does not cover all the characters you want
424to display. 430to display.
425 431
426B<rxvt-unicode> makes a best-effort try at finding a replacement 432B<rxvt-unicode> makes a best-effort try at finding a replacement
427font. Often the result is fine, but sometimes the chosen font looks 433font. Often the result is fine, but sometimes the chosen font looks
428bad/ugly/wrong. Some fonts have totally strange characters that don't 434bad/ugly/wrong. Some fonts have totally strange characters that don't
429resemble the correct glyph at all, and rxvt-unicode lacks the artificial 435resemble the correct glyph at all, and rxvt-unicode lacks the artificial
430intelligence to detect that a specific glyph is wrong: it has to believe 436intelligence to detect that a specific glyph is wrong: it has to believe
431the font that the characters it claims to contain indeed look correct. 437the font that the characters it claims to contain indeed look correct.
432 438
433In that case, select a font of your taste and add it to the font list, 439In that case, select a font of your taste and add it to the font list,
434e.g.: 440e.g.:
435 441
436 @@RXVT_NAME@@ -fn basefont,font2,font3... 442 @@URXVT_NAME@@ -fn basefont,font2,font3...
437 443
438When rxvt-unicode sees a character, it will first look at the base 444When rxvt-unicode sees a character, it will first look at the base
439font. If the base font does not contain the character, it will go to the 445font. If the base font does not contain the character, it will go to the
440next font, and so on. Specifying your own fonts will also speed up this 446next font, and so on. Specifying your own fonts will also speed up this
441search and use less resources within rxvt-unicode and the X-server. 447search and use less resources within rxvt-unicode and the X-server.
442 448
443The only limitation is that none of the fonts may be larger than the base 449The only limitation is that none of the fonts may be larger than the base
444font, as the base font defines the terminal character cell size, which 450font, as the base font defines the terminal character cell size, which
445must be the same due to the way terminals work. 451must be the same due to the way terminals work.
446 452
453=head3 Why do some chinese characters look so different than others?
454
455This is because there is a difference between script and language --
456rxvt-unicode does not know which language the text that is output is,
457as it only knows the unicode character codes. If rxvt-unicode first
458sees a japanese/chinese character, it might choose a japanese font for
459display. Subsequent japanese characters will use that font. Now, many
460chinese characters aren't represented in japanese fonts, so when the first
461non-japanese character comes up, rxvt-unicode will look for a chinese font
462-- unfortunately at this point, it will still use the japanese font for
463chinese characters that are also in the japanese font.
464
465The workaround is easy: just tag a chinese font at the end of your font
466list (see the previous question). The key is to view the font list as
467a preference list: If you expect more japanese, list a japanese font
468first. If you expect more chinese, put a chinese font first.
469
470In the future it might be possible to switch language preferences at
471runtime (the internal data structure has no problem with using different
472fonts for the same character at the same time, but no interface for this
473has been designed yet).
474
475Until then, you might get away with switching fonts at runtime (see L<Can
476I switch the fonts at runtime?> later in this document).
477
478=head3 How can I make mplayer display video correctly?
479
480We are working on it, in the meantime, as a workaround, use something like:
481
482 @@URXVT_NAME@@ -b 600 -geometry 20x1 -e sh -c 'mplayer -wid $WINDOWID file...'
483
447 484
448=head2 Keyboard, Mouse & User Interaction 485=head2 Keyboard, Mouse & User Interaction
449 486
450=head3 The new selection selects pieces that are too big, how can I select single words? 487=head3 The new selection selects pieces that are too big, how can I select single words?
451 488
459 496
460To get a selection that is very similar to the old code, try this pattern: 497To get a selection that is very similar to the old code, try this pattern:
461 498
462 URxvt.selection.pattern-0: ([^"&'()*,;<=>?@[\\\\]^`{|})]+) 499 URxvt.selection.pattern-0: ([^"&'()*,;<=>?@[\\\\]^`{|})]+)
463 500
464Please also note that the I<LeftClick Shift-LeftClik> combination also 501Please also note that the I<LeftClick Shift-LeftClick> combination also
465selects words like the old code. 502selects words like the old code.
466 503
467=head3 I don't like the new selection/popups/hotkeys/perl, how do I change/disable it? 504=head3 I don't like the new selection/popups/hotkeys/perl, how do I change/disable it?
468 505
469You can disable the perl extension completely by setting the 506You can disable the perl extension completely by setting the
470B<perl-ext-common> resource to the empty string, which also keeps 507B<perl-ext-common> resource to the empty string, which also keeps
471rxvt-unicode from initialising perl, saving memory. 508rxvt-unicode from initialising perl, saving memory.
472 509
473If you only want to disable specific features, you first have to 510If you only want to disable specific features, you first have to
474identify which perl extension is responsible. For this, read the section 511identify which perl extension is responsible. For this, read the section
475B<PREPACKAGED EXTENSIONS> in the @@RXVT_NAME@@perl(3) manpage. For 512B<PREPACKAGED EXTENSIONS> in the @@URXVT_NAME@@perl(3) manpage. For
476example, to disable the B<selection-popup> and B<option-popup>, specify 513example, to disable the B<selection-popup> and B<option-popup>, specify
477this B<perl-ext-common> resource: 514this B<perl-ext-common> resource:
478 515
479 URxvt.perl-ext-common: default,-selection-popup,-option-popup 516 URxvt.perl-ext-common: default,-selection-popup,-option-popup
480 517
495circumstances, it will move your cursor around when you click into the 532circumstances, it will move your cursor around when you click into the
496line that contains it. It tries hard not to do this at the wrong moment, 533line that contains it. It tries hard not to do this at the wrong moment,
497but when running a program that doesn't parse cursor movements or in some 534but when running a program that doesn't parse cursor movements or in some
498cases during rlogin sessions, it fails to detect this properly. 535cases during rlogin sessions, it fails to detect this properly.
499 536
500You can permamently switch this feature off by disabling the C<readline> 537You can permanently switch this feature off by disabling the C<readline>
501extension: 538extension:
502 539
503 URxvt.perl-ext-common: default,-readline 540 URxvt.perl-ext-common: default,-readline
504 541
505=head3 My numerical keypad acts weird and generates differing output? 542=head3 My numerical keypad acts weird and generates differing output?
506 543
507Some Debian GNUL/Linux users seem to have this problem, although no 544Some Debian GNUL/Linux users seem to have this problem, although no
508specific details were reported so far. It is possible that this is caused 545specific details were reported so far. It is possible that this is caused
509by the wrong C<TERM> setting, although the details of wether and how 546by the wrong C<TERM> setting, although the details of whether and how
510this can happen are unknown, as C<TERM=rxvt> should offer a compatible 547this can happen are unknown, as C<TERM=rxvt> should offer a compatible
511keymap. See the answer to the previous question, and please report if that 548keymap. See the answer to the previous question, and please report if that
512helped. 549helped.
513 550
514=head3 My Compose (Multi_key) key is no longer working. 551=head3 My Compose (Multi_key) key is no longer working.
521rxvt-unicode will continue without an input method. 558rxvt-unicode will continue without an input method.
522 559
523In this case either do not specify a B<preeditStyle> or specify more than 560In this case either do not specify a B<preeditStyle> or specify more than
524one pre-edit style, such as B<OverTheSpot,Root,None>. 561one pre-edit style, such as B<OverTheSpot,Root,None>.
525 562
563If it still doesn't work, then maybe your input method doesn't support
564compose sequences - to fall back to the built-in one, make sure you don't
565specify an input method via C<-im> or C<XMODIFIERS>.
566
526=head3 I cannot type C<Ctrl-Shift-2> to get an ASCII NUL character due to ISO 14755 567=head3 I cannot type C<Ctrl-Shift-2> to get an ASCII NUL character due to ISO 14755
527 568
528Either try C<Ctrl-2> alone (it often is mapped to ASCII NUL even on 569Either try C<Ctrl-2> alone (it often is mapped to ASCII NUL even on
529international keyboards) or simply use ISO 14755 support to your 570international keyboards) or simply use ISO 14755 support to your
530advantage, typing <Ctrl-Shift-0> to get a ASCII NUL. This works for other 571advantage, typing <Ctrl-Shift-0> to get a ASCII NUL. This works for other
540depressed. 581depressed.
541 582
542=head3 What's with the strange Backspace/Delete key behaviour? 583=head3 What's with the strange Backspace/Delete key behaviour?
543 584
544Assuming that the physical Backspace key corresponds to the 585Assuming that the physical Backspace key corresponds to the
545BackSpace keysym (not likely for Linux ... see the following 586Backspace keysym (not likely for Linux ... see the following
546question) there are two standard values that can be used for 587question) there are two standard values that can be used for
547Backspace: C<^H> and C<^?>. 588Backspace: C<^H> and C<^?>.
548 589
549Historically, either value is correct, but rxvt-unicode adopts the debian 590Historically, either value is correct, but rxvt-unicode adopts the debian
550policy of using C<^?> when unsure, because it's the one only only correct 591policy of using C<^?> when unsure, because it's the one and only correct
551choice :). 592choice :).
552 593
553Rxvt-unicode tries to inherit the current stty settings and uses the value 594Rxvt-unicode tries to inherit the current stty settings and uses the value
554of `erase' to guess the value for backspace. If rxvt-unicode wasn't 595of `erase' to guess the value for backspace. If rxvt-unicode wasn't
555started from a terminal (say, from a menu or by remote shell), then the 596started from a terminal (say, from a menu or by remote shell), then the
558 599
559For starting a new rxvt-unicode: 600For starting a new rxvt-unicode:
560 601
561 # use Backspace = ^H 602 # use Backspace = ^H
562 $ stty erase ^H 603 $ stty erase ^H
563 $ @@RXVT_NAME@@ 604 $ @@URXVT_NAME@@
564 605
565 # use Backspace = ^? 606 # use Backspace = ^?
566 $ stty erase ^? 607 $ stty erase ^?
567 $ @@RXVT_NAME@@ 608 $ @@URXVT_NAME@@
568 609
569Toggle with C<ESC [ 36 h> / C<ESC [ 36 l>. 610Toggle with C<ESC [ 36 h> / C<ESC [ 36 l>.
570 611
571For an existing rxvt-unicode: 612For an existing rxvt-unicode:
572 613
587key has been assigned an escape sequence to match the vt100 for Execute 628key has been assigned an escape sequence to match the vt100 for Execute
588(C<ESC [ 3 ~>) and is in the supplied termcap/terminfo. 629(C<ESC [ 3 ~>) and is in the supplied termcap/terminfo.
589 630
590Some other Backspace problems: 631Some other Backspace problems:
591 632
592some editors use termcap/terminfo, 633some editors use termcap/terminfo,
593some editors (vim I'm told) expect Backspace = ^H, 634some editors (vim I'm told) expect Backspace = ^H,
594GNU Emacs (and Emacs-like editors) use ^H for help. 635GNU Emacs (and Emacs-like editors) use ^H for help.
595 636
596Perhaps someday this will all be resolved in a consistent manner. 637Perhaps someday this will all be resolved in a consistent manner.
597 638
599 640
600There are some compile-time selections available via configure. Unless 641There are some compile-time selections available via configure. Unless
601you have run "configure" with the C<--disable-resources> option you can 642you have run "configure" with the C<--disable-resources> option you can
602use the `keysym' resource to alter the keystrings associated with keysyms. 643use the `keysym' resource to alter the keystrings associated with keysyms.
603 644
604Here's an example for a URxvt session started using C<@@RXVT_NAME@@ -name URxvt> 645Here's an example for a URxvt session started using C<@@URXVT_NAME@@ -name URxvt>
605 646
606 URxvt.keysym.Home: \033[1~ 647 URxvt.keysym.Home: \033[1~
607 URxvt.keysym.End: \033[4~ 648 URxvt.keysym.End: \033[4~
608 URxvt.keysym.C-apostrophe: \033<C-'> 649 URxvt.keysym.C-apostrophe: \033<C-'>
609 URxvt.keysym.C-slash: \033<C-/> 650 URxvt.keysym.C-slash: \033<C-/>
638Rather than have rxvt-unicode try to accommodate all the various possible 679Rather than have rxvt-unicode try to accommodate all the various possible
639keyboard mappings, it is better to use `xmodmap' to remap the keys as 680keyboard mappings, it is better to use `xmodmap' to remap the keys as
640required for your particular machine. 681required for your particular machine.
641 682
642 683
643
644=head2 Terminal Configuration 684=head2 Terminal Configuration
685
686=head3 Can I see a typical configuration?
687
688The default configuration tries to be xterm-like, which I don't like that
689much, but it's least surprise to regular users.
690
691As a rxvt or rxvt-unicode user, you are practically supposed to invest
692time into customising your terminal. To get you started, here is the
693author's .Xdefaults entries, with comments on what they do. It's certainly
694not I<typical>, but what's typical...
695
696 URxvt.cutchars: "()*,<>[]{}|'
697 URxvt.print-pipe: cat >/tmp/xxx
698
699These are just for testing stuff.
700
701 URxvt.imLocale: ja_JP.UTF-8
702 URxvt.preeditType: OnTheSpot,None
703
704This tells rxvt-unicode to use a special locale when communicating with
705the X Input Method, and also tells it to only use the OnTheSpot pre-edit
706type, which requires the C<xim-onthespot> perl extension but rewards me
707with correct-looking fonts.
708
709 URxvt.perl-lib: /root/lib/urxvt
710 URxvt.perl-ext-common: default,selection-autotransform,selection-pastebin,xim-onthespot,remote-clipboard
711 URxvt.selection.pattern-0: ( at .*? line \\d+)
712 URxvt.selection.pattern-1: ^(/[^:]+):\
713 URxvt.selection-autotransform.0: s/^([^:[:space:]]+):(\\d+):?$/:e \\Q$1\\E\\x0d:$2\\x0d/
714 URxvt.selection-autotransform.1: s/^ at (.*?) line (\\d+)$/:e \\Q$1\\E\\x0d:$2\\x0d/
715
716This is my perl configuration. The first two set the perl library
717directory and also tells urxvt to use a large number of extensions. I
718develop for myself mostly, so I actually use most of the extensions I
719write.
720
721The selection stuff mainly makes the selection perl-error-message aware
722and tells it to convert perl error messages into vi-commands to load the
723relevant file and go to the error line number.
724
725 URxvt.scrollstyle: plain
726 URxvt.secondaryScroll: true
727
728As the documentation says: plain is the preferred scrollbar for the
729author. The C<secondaryScroll> configures urxvt to scroll in full-screen
730apps, like screen, so lines scrolled out of screen end up in urxvt's
731scrollback buffer.
732
733 URxvt.background: #000000
734 URxvt.foreground: gray90
735 URxvt.color7: gray90
736 URxvt.colorBD: #ffffff
737 URxvt.cursorColor: #e0e080
738 URxvt.throughColor: #8080f0
739 URxvt.highlightColor: #f0f0f0
740
741Some colours. Not sure which ones are being used or even non-defaults, but
742these are in my .Xdefaults. Most notably, they set foreground/background
743to light gray/black, and also make sure that the colour 7 matches the
744default foreground colour.
745
746 URxvt.underlineColor: yellow
747
748Another colour, makes underline lines look different. Sometimes hurts, but
749is mostly a nice effect.
750
751 URxvt.geometry: 154x36
752 URxvt.loginShell: false
753 URxvt.meta: ignore
754 URxvt.utmpInhibit: true
755
756Uh, well, should be mostly self-explanatory. By specifying some defaults
757manually, I can quickly switch them for testing.
758
759 URxvt.saveLines: 8192
760
761A large scrollback buffer is essential. Really.
762
763 URxvt.mapAlert: true
764
765The only case I use it is for my IRC window, which I like to keep
766iconified till people msg me (which beeps).
767
768 URxvt.visualBell: true
769
770The audible bell is often annoying, especially when in a crowd.
771
772 URxvt.insecure: true
773
774Please don't hack my mutt! Ooops...
775
776 URxvt.pastableTabs: false
777
778I once thought this is a great idea.
779
780 urxvt.font: 9x15bold,\
781 -misc-fixed-bold-r-normal--15-140-75-75-c-90-iso10646-1,\
782 -misc-fixed-medium-r-normal--15-140-75-75-c-90-iso10646-1, \
783 [codeset=JISX0208]xft:Kochi Gothic, \
784 xft:Bitstream Vera Sans Mono:autohint=true, \
785 xft:Code2000:antialias=false
786 urxvt.boldFont: -xos4-terminus-bold-r-normal--14-140-72-72-c-80-iso8859-15
787 urxvt.italicFont: xft:Bitstream Vera Sans Mono:italic:autohint=true
788 urxvt.boldItalicFont: xft:Bitstream Vera Sans Mono:bold:italic:autohint=true
789
790I wrote rxvt-unicode to be able to specify fonts exactly. So don't be
791overwhelmed. A special note: the C<9x15bold> mentioned above is actually
792the version from XFree-3.3, as XFree-4 replaced it by a totally different
793font (different glyphs for C<;> and many other harmless characters),
794while the second font is actually the C<9x15bold> from XFree4/XOrg. The
795bold version has less chars than the medium version, so I use it for rare
796characters, too. When editing sources with vim, I use italic for comments
797and other stuff, which looks quite good with Bitstream Vera anti-aliased.
798
799Terminus is a quite bad font (many very wrong glyphs), but for most of my
800purposes, it works, and gives a different look, as my normal (Non-bold)
801font is already bold, and I want to see a difference between bold and
802normal fonts.
803
804Please note that I used the C<urxvt> instance name and not the C<URxvt>
805class name. That is because I use different configs for different purposes,
806for example, my IRC window is started with C<-name IRC>, and uses these
807defaults:
808
809 IRC*title: IRC
810 IRC*geometry: 87x12+535+542
811 IRC*saveLines: 0
812 IRC*mapAlert: true
813 IRC*font: suxuseuro
814 IRC*boldFont: suxuseuro
815 IRC*colorBD: white
816 IRC*keysym.M-C-1: command:\033]710;suxuseuro\007\033]711;suxuseuro\007
817 IRC*keysym.M-C-2: command:\033]710;9x15bold\007\033]711;9x15bold\007
818
819C<Alt-Ctrl-1> and C<Alt-Ctrl-2> switch between two different font
820sizes. C<suxuseuro> allows me to keep an eye (and actually read)
821stuff while keeping a very small window. If somebody pastes something
822complicated (e.g. japanese), I temporarily switch to a larger font.
823
824The above is all in my C<.Xdefaults> (I don't use C<.Xresources> nor
825C<xrdb>). I also have some resources in a separate C<.Xdefaults-hostname>
826file for different hosts, for example, on ym main desktop, I use:
827
828 URxvt.keysym.C-M-q: command:\033[3;5;5t
829 URxvt.keysym.C-M-y: command:\033[3;5;606t
830 URxvt.keysym.C-M-e: command:\033[3;1605;5t
831 URxvt.keysym.C-M-c: command:\033[3;1605;606t
832 URxvt.keysym.C-M-p: perl:test
833
834The first for keysym definitions allow me to quickly bring some windows
835in the layout I like most. Ion users might start laughing but will stop
836immediately when I tell them that I use my own Fvwm2 module for much the
837same effect as Ion provides, and I only very rarely use the above key
838combinations :->
645 839
646=head3 Why doesn't rxvt-unicode read my resources? 840=head3 Why doesn't rxvt-unicode read my resources?
647 841
648Well, why, indeed? It does, in a way very similar to other X 842Well, why, indeed? It does, in a way very similar to other X
649applications. Most importantly, this means that if you or your OS loads 843applications. Most importantly, this means that if you or your OS loads
658Also consider the form resources have to use: 852Also consider the form resources have to use:
659 853
660 URxvt.resource: value 854 URxvt.resource: value
661 855
662If you want to use another form (there are lots of different ways of 856If you want to use another form (there are lots of different ways of
663specifying resources), make sure you understand wether and why it 857specifying resources), make sure you understand whether and why it
664works. If unsure, use the form above. 858works. If unsure, use the form above.
665 859
666=head3 When I log-in to another system it tells me about missing terminfo data? 860=head3 When I log-in to another system it tells me about missing terminfo data?
667 861
668The terminal description used by rxvt-unicode is not as widely available 862The terminal description used by rxvt-unicode is not as widely available
669as that for xterm, or even rxvt (for which the same problem often arises). 863as that for xterm, or even rxvt (for which the same problem often arises).
670 864
671The correct solution for this problem is to install the terminfo, this can 865The correct solution for this problem is to install the terminfo, this can
672be done like this (with ncurses' infocmp): 866be done by simply installing rxvt-unicode on the remote system as well
867(in case you have a nice package manager ready), or you can install the
868terminfo database manually like this (with ncurses infocmp. works as
869user and root):
673 870
674 REMOTE=remotesystem.domain 871 REMOTE=remotesystem.domain
675 infocmp rxvt-unicode | ssh $REMOTE "cat >/tmp/ti && tic /tmp/ti" 872 infocmp rxvt-unicode | ssh $REMOTE "mkdir -p .terminfo && cat >/tmp/ti && tic /tmp/ti"
676 873
677... or by installing rxvt-unicode normally on the remote system, 874One some systems you might need to set C<$TERMINFO> to the full path of
875F<$HOME/.terminfo> for this to work.
678 876
679If you cannot or do not want to do this, then you can simply set 877If you cannot or do not want to do this, then you can simply set
680C<TERM=rxvt> or even C<TERM=xterm>, and live with the small number of 878C<TERM=rxvt> or even C<TERM=xterm>, and live with the small number of
681problems arising, which includes wrong keymapping, less and different 879problems arising, which includes wrong keymapping, less and different
682colours and some refresh errors in fullscreen applications. It's a nice 880colours and some refresh errors in fullscreen applications. It's a nice
687resource to set it: 885resource to set it:
688 886
689 URxvt.termName: rxvt 887 URxvt.termName: rxvt
690 888
691If you don't plan to use B<rxvt> (quite common...) you could also replace 889If you don't plan to use B<rxvt> (quite common...) you could also replace
692the rxvt terminfo file with the rxvt-unicode one. 890the rxvt terminfo file with the rxvt-unicode one and use C<TERM=rxvt>.
891
892=head3 nano fails with "Error opening terminal: rxvt-unicode"
893
894This exceptionally confusing and useless error message is printed by nano
895when it can't find the terminfo database. Nothing is wrong with your
896terminal, read the previous answer for a solution.
693 897
694=head3 C<tic> outputs some error when compiling the terminfo entry. 898=head3 C<tic> outputs some error when compiling the terminfo entry.
695 899
696Most likely it's the empty definition for C<enacs=>. Just replace it by 900Most likely it's the empty definition for C<enacs=>. Just replace it by
697C<enacs=\E[0@> and try again. 901C<enacs=\E[0@> and try again.
698 902
699=head3 C<bash>'s readline does not work correctly under @@RXVT_NAME@@. 903=head3 C<bash>'s readline does not work correctly under @@URXVT_NAME@@.
700 904
701See next entry. 905See next entry.
702 906
703=head3 I need a termcap file entry. 907=head3 I need a termcap file entry.
704 908
705One reason you might want this is that some distributions or operating 909One reason you might want this is that some distributions or operating
706systems still compile some programs using the long-obsoleted termcap 910systems still compile some programs using the long-obsoleted termcap
707library (Fedora Core's bash is one example) and rely on a termcap entry 911library (Fedora Core's bash is one example) and rely on a termcap entry
708for C<rxvt-unicode>. 912for C<rxvt-unicode>.
709 913
710You could use rxvt's termcap entry with resonable results in many cases. 914You could use rxvt's termcap entry with reasonable results in many cases.
711You can also create a termcap entry by using terminfo's infocmp program 915You can also create a termcap entry by using terminfo's infocmp program
712like this: 916like this:
713 917
714 infocmp -C rxvt-unicode 918 infocmp -C rxvt-unicode
715 919
716Or you could use this termcap entry, generated by the command above: 920Or you could use the termcap entry in doc/etc/rxvt-unicode.termcap,
717 921generated by the command above.
718 rxvt-unicode|rxvt-unicode terminal (X Window System):\
719 :am:bw:eo:km:mi:ms:xn:xo:\
720 :co#80:it#8:li#24:lm#0:\
721 :AL=\E[%dL:DC=\E[%dP:DL=\E[%dM:DO=\E[%dB:IC=\E[%d@:\
722 :K1=\EOw:K2=\EOu:K3=\EOy:K4=\EOq:K5=\EOs:LE=\E[%dD:\
723 :RI=\E[%dC:SF=\E[%dS:SR=\E[%dT:UP=\E[%dA:ae=\E(B:al=\E[L:\
724 :as=\E(0:bl=^G:cd=\E[J:ce=\E[K:cl=\E[H\E[2J:\
725 :cm=\E[%i%d;%dH:cr=^M:cs=\E[%i%d;%dr:ct=\E[3g:dc=\E[P:\
726 :dl=\E[M:do=^J:ec=\E[%dX:ei=\E[4l:ho=\E[H:\
727 :i1=\E[?47l\E=\E[?1l:ic=\E[@:im=\E[4h:\
728 :is=\E[r\E[m\E[2J\E[H\E[?7h\E[?1;3;4;6l\E[4l:\
729 :k1=\E[11~:k2=\E[12~:k3=\E[13~:k4=\E[14~:k5=\E[15~:\
730 :k6=\E[17~:k7=\E[18~:k8=\E[19~:k9=\E[20~:kD=\E[3~:\
731 :kI=\E[2~:kN=\E[6~:kP=\E[5~:kb=\177:kd=\EOB:ke=\E[?1l\E>:\
732 :kh=\E[7~:kl=\EOD:kr=\EOC:ks=\E[?1h\E=:ku=\EOA:le=^H:\
733 :mb=\E[5m:md=\E[1m:me=\E[m\017:mr=\E[7m:nd=\E[C:rc=\E8:\
734 :sc=\E7:se=\E[27m:sf=^J:so=\E[7m:sr=\EM:st=\EH:ta=^I:\
735 :te=\E[r\E[?1049l:ti=\E[?1049h:ue=\E[24m:up=\E[A:\
736 :us=\E[4m:vb=\E[?5h\E[?5l:ve=\E[?25h:vi=\E[?25l:\
737 :vs=\E[?25h:
738 922
739=head3 Why does C<ls> no longer have coloured output? 923=head3 Why does C<ls> no longer have coloured output?
740 924
741The C<ls> in the GNU coreutils unfortunately doesn't use terminfo to 925The C<ls> in the GNU coreutils unfortunately doesn't use terminfo to
742decide wether a terminal has colour, but uses it's own configuration 926decide whether a terminal has colour, but uses its own configuration
743file. Needless to say, C<rxvt-unicode> is not in it's default file (among 927file. Needless to say, C<rxvt-unicode> is not in its default file (among
744with most other terminals supporting colour). Either add: 928with most other terminals supporting colour). Either add:
745 929
746 TERM rxvt-unicode 930 TERM rxvt-unicode
747 931
748to C</etc/DIR_COLORS> or simply add: 932to C</etc/DIR_COLORS> or simply add:
782If you encounter strange problems like typing an accented character but 966If you encounter strange problems like typing an accented character but
783getting two unrelated other characters or similar, or if program output is 967getting two unrelated other characters or similar, or if program output is
784subtly garbled, then you should check your locale settings. 968subtly garbled, then you should check your locale settings.
785 969
786Rxvt-unicode must be started with the same C<LC_CTYPE> setting as the 970Rxvt-unicode must be started with the same C<LC_CTYPE> setting as the
787programs. Often rxvt-unicode is started in the C<C> locale, while the 971programs running in it. Often rxvt-unicode is started in the C<C> locale,
788login script running within the rxvt-unicode window changes the locale to 972while the login script running within the rxvt-unicode window changes the
789something else, e.g. C<en_GB.UTF-8>. Needless to say, this is not going to work. 973locale to something else, e.g. C<en_GB.UTF-8>. Needless to say, this is
974not going to work, and is the most common cause for problems.
790 975
791The best thing is to fix your startup environment, as you will likely run 976The best thing is to fix your startup environment, as you will likely run
792into other problems. If nothing works you can try this in your .profile. 977into other problems. If nothing works you can try this in your .profile.
793 978
794 printf '\e]701;%s\007' "$LC_CTYPE" 979 printf '\33]701;%s\007' "$LC_CTYPE" # $LANG or $LC_ALL are worth a try, too
795 980
796If this doesn't work, then maybe you use a C<LC_CTYPE> specification not 981If this doesn't work, then maybe you use a C<LC_CTYPE> specification not
797supported on your systems. Some systems have a C<locale> command which 982supported on your systems. Some systems have a C<locale> command which
798displays this (also, C<perl -e0> can be used to check locale settings, as 983displays this (also, C<perl -e0> can be used to check locale settings, as
799it will complain loudly if it cannot set the locale). If it displays something 984it will complain loudly if it cannot set the locale). If it displays something
820The reasons is that there exists a perfectly fine mechanism for selecting 1005The reasons is that there exists a perfectly fine mechanism for selecting
821the encoding, doing I/O and (most important) communicating this to all 1006the encoding, doing I/O and (most important) communicating this to all
822applications so everybody agrees on character properties such as width 1007applications so everybody agrees on character properties such as width
823and code number. This mechanism is the I<locale>. Applications not using 1008and code number. This mechanism is the I<locale>. Applications not using
824that info will have problems (for example, C<xterm> gets the width of 1009that info will have problems (for example, C<xterm> gets the width of
825characters wrong as it uses it's own, locale-independent table under all 1010characters wrong as it uses its own, locale-independent table under all
826locales). 1011locales).
827 1012
828Rxvt-unicode uses the C<LC_CTYPE> locale category to select encoding. All 1013Rxvt-unicode uses the C<LC_CTYPE> locale category to select encoding. All
829programs doing the same (that is, most) will automatically agree in the 1014programs doing the same (that is, most) will automatically agree in the
830interpretation of characters. 1015interpretation of characters.
849=head3 Can I switch locales at runtime? 1034=head3 Can I switch locales at runtime?
850 1035
851Yes, using an escape sequence. Try something like this, which sets 1036Yes, using an escape sequence. Try something like this, which sets
852rxvt-unicode's idea of C<LC_CTYPE>. 1037rxvt-unicode's idea of C<LC_CTYPE>.
853 1038
854 printf '\e]701;%s\007' ja_JP.SJIS 1039 printf '\33]701;%s\007' ja_JP.SJIS
855 1040
856See also the previous answer. 1041See also the previous answer.
857 1042
858Sometimes this capability is rather handy when you want to work in 1043Sometimes this capability is rather handy when you want to work in
859one locale (e.g. C<de_DE.UTF-8>) but some programs don't support it 1044one locale (e.g. C<de_DE.UTF-8>) but some programs don't support it
860(e.g. UTF-8). For example, I use this script to start C<xjdic>, which 1045(e.g. UTF-8). For example, I use this script to start C<xjdic>, which
861first switches to a locale supported by xjdic and back later: 1046first switches to a locale supported by xjdic and back later:
862 1047
863 printf '\e]701;%s\007' ja_JP.SJIS 1048 printf '\33]701;%s\007' ja_JP.SJIS
864 xjdic -js 1049 xjdic -js
865 printf '\e]701;%s\007' de_DE.UTF-8 1050 printf '\33]701;%s\007' de_DE.UTF-8
866 1051
867You can also use xterm's C<luit> program, which usually works fine, except 1052You can also use xterm's C<luit> program, which usually works fine, except
868for some locales where character width differs between program- and 1053for some locales where character width differs between program- and
869rxvt-unicode-locales. 1054rxvt-unicode-locales.
870 1055
1056=head3 I have problems getting my input method working.
1057
1058Try a search engine, as this is slightly different for every input method server.
1059
1060Here is a checklist:
1061
1062=over 4
1063
1064=item - Make sure your locale I<and> the imLocale are supported on your OS.
1065
1066Try C<locale -a> or check the documentation for your OS.
1067
1068=item - Make sure your locale or imLocale matches a locale supported by your XIM.
1069
1070For example, B<kinput2> does not support UTF-8 locales, you should use
1071C<ja_JP.EUC-JP> or equivalent.
1072
1073=item - Make sure your XIM server is actually running.
1074
1075=item - Make sure the C<XMODIFIERS> environment variable is set correctly when I<starting> rxvt-unicode.
1076
1077When you want to use e.g. B<kinput2>, it must be set to
1078C<@im=kinput2>. For B<scim>, use C<@im=SCIM>. You can see what input
1079method servers are running with this command:
1080
1081 xprop -root XIM_SERVERS
1082
1083=item
1084
1085=back
1086
871=head3 My input method wants <some encoding> but I want UTF-8, what can I do? 1087=head3 My input method wants <some encoding> but I want UTF-8, what can I do?
872 1088
873You can specify separate locales for the input method and the rest of the 1089You can specify separate locales for the input method and the rest of the
874terminal, using the resource C<imlocale>: 1090terminal, using the resource C<imlocale>:
875 1091
876 URxvt.imlocale: ja_JP.EUC-JP 1092 URxvt.imlocale: ja_JP.EUC-JP
877 1093
878Now you can start your terminal with C<LC_CTYPE=ja_JP.UTF-8> and still 1094Now you can start your terminal with C<LC_CTYPE=ja_JP.UTF-8> and still
879use your input method. Please note, however, that you will not be able to 1095use your input method. Please note, however, that, depending on your Xlib
880input characters outside C<EUC-JP> in a normal way then, as your input 1096version, you may not be able to input characters outside C<EUC-JP> in a
881method limits you. 1097normal way then, as your input method limits you.
882 1098
883=head3 Rxvt-unicode crashes when the X Input Method changes or exits. 1099=head3 Rxvt-unicode crashes when the X Input Method changes or exits.
884 1100
885Unfortunately, this is unavoidable, as the XIM protocol is racy by 1101Unfortunately, this is unavoidable, as the XIM protocol is racy by
886design. Applications can avoid some crashes at the expense of memory 1102design. Applications can avoid some crashes at the expense of memory
912 1128
913=head3 I am maintaining rxvt-unicode for distribution/OS XXX, any recommendation? 1129=head3 I am maintaining rxvt-unicode for distribution/OS XXX, any recommendation?
914 1130
915You should build one binary with the default options. F<configure> 1131You should build one binary with the default options. F<configure>
916now enables most useful options, and the trend goes to making them 1132now enables most useful options, and the trend goes to making them
917runtime-switchable, too, so there is usually no drawback to enbaling them, 1133runtime-switchable, too, so there is usually no drawback to enabling them,
918except higher disk and possibly memory usage. The perl interpreter should 1134except higher disk and possibly memory usage. The perl interpreter should
919be enabled, as important functionality (menus, selection, likely more in 1135be enabled, as important functionality (menus, selection, likely more in
920the future) depends on it. 1136the future) depends on it.
921 1137
922You should not overwrite the C<perl-ext-common> snd C<perl-ext> resources 1138You should not overwrite the C<perl-ext-common> and C<perl-ext> resources
923system-wide (except maybe with C<defaults>). This will result in useful 1139system-wide (except maybe with C<defaults>). This will result in useful
924behaviour. If your distribution aims at low memory, add an empty 1140behaviour. If your distribution aims at low memory, add an empty
925C<perl-ext-common> resource to the app-defaults file. This will keep the 1141C<perl-ext-common> resource to the app-defaults file. This will keep the
926perl interpreter disabled until the user enables it. 1142perl interpreter disabled until the user enables it.
927 1143
945This forking is done as the very first within main(), which is very early 1161This forking is done as the very first within main(), which is very early
946and reduces possible bugs to initialisation code run before main(), or 1162and reduces possible bugs to initialisation code run before main(), or
947things like the dynamic loader of your system, which should result in very 1163things like the dynamic loader of your system, which should result in very
948little risk. 1164little risk.
949 1165
950=head3 On Solaris 9, many line-drawing characters are too wide.
951
952Seems to be a known bug, read
953L<http://nixdoc.net/files/forum/about34198.html>. Some people use the
954following ugly workaround to get non-double-wide-characters working:
955
956 #define wcwidth(x) wcwidth(x) > 1 ? 1 : wcwidth(x)
957
958=head3 I am on FreeBSD and rxvt-unicode does not seem to work at all. 1166=head3 I am on FreeBSD and rxvt-unicode does not seem to work at all.
959 1167
960Rxvt-unicode requires the symbol C<__STDC_ISO_10646__> to be defined 1168Rxvt-unicode requires the symbol C<__STDC_ISO_10646__> to be defined
961in your compile environment, or an implementation that implements it, 1169in your compile environment, or an implementation that implements it,
962wether it defines the symbol or not. C<__STDC_ISO_10646__> requires that 1170whether it defines the symbol or not. C<__STDC_ISO_10646__> requires that
963B<wchar_t> is represented as unicode. 1171B<wchar_t> is represented as unicode.
964 1172
965As you might have guessed, FreeBSD does neither define this symobl nor 1173As you might have guessed, FreeBSD does neither define this symbol nor
966does it support it. Instead, it uses it's own internal representation of 1174does it support it. Instead, it uses its own internal representation of
967B<wchar_t>. This is, of course, completely fine with respect to standards. 1175B<wchar_t>. This is, of course, completely fine with respect to standards.
968 1176
969However, that means rxvt-unicode only works in C<POSIX>, C<ISO-8859-1> and 1177However, that means rxvt-unicode only works in C<POSIX>, C<ISO-8859-1> and
970C<UTF-8> locales under FreeBSD (which all use Unicode as B<wchar_t>. 1178C<UTF-8> locales under FreeBSD (which all use Unicode as B<wchar_t>).
971 1179
972C<__STDC_ISO_10646__> is the only sane way to support multi-language 1180C<__STDC_ISO_10646__> is the only sane way to support multi-language
973apps in an OS, as using a locale-dependent (and non-standardized) 1181apps in an OS, as using a locale-dependent (and non-standardized)
974representation of B<wchar_t> makes it impossible to convert between 1182representation of B<wchar_t> makes it impossible to convert between
975B<wchar_t> (as used by X11 and your applications) and any other encoding 1183B<wchar_t> (as used by X11 and your applications) and any other encoding
985 1193
986The rxvt-unicode author insists that the right way to fix this is in the 1194The rxvt-unicode author insists that the right way to fix this is in the
987system libraries once and for all, instead of forcing every app to carry 1195system libraries once and for all, instead of forcing every app to carry
988complete replacements for them :) 1196complete replacements for them :)
989 1197
990=head3 I use Solaris 9 and it doesn't compile/work/etc.
991
992Try the diff in F<doc/solaris9.patch> as a base. It fixes the worst
993problems with C<wcwidth> and a compile problem.
994
995=head3 How can I use rxvt-unicode under cygwin? 1198=head3 How can I use rxvt-unicode under cygwin?
996 1199
997rxvt-unicode should compile and run out of the box on cygwin, using 1200rxvt-unicode should compile and run out of the box on cygwin, using
998the X11 libraries that come with cygwin. libW11 emulation is no 1201the X11 libraries that come with cygwin. libW11 emulation is no
999longer supported (and makes no sense, either, as it only supported a 1202longer supported (and makes no sense, either, as it only supported a
1003 1206
1004At the time of this writing, cygwin didn't seem to support any multi-byte 1207At the time of this writing, cygwin didn't seem to support any multi-byte
1005encodings (you might try C<LC_CTYPE=C-UTF-8>), so you are likely limited 1208encodings (you might try C<LC_CTYPE=C-UTF-8>), so you are likely limited
1006to 8-bit encodings. 1209to 8-bit encodings.
1007 1210
1211=head3 Character widths are not correct.
1212
1213urxvt uses the system wcwidth function to know the information about
1214the width of characters, so on systems with incorrect locale data you
1215will likely get bad results. Two notorious examples are Solaris 9,
1216where single-width characters like U+2514 are reported as double-width,
1217and Darwin 8, where combining chars are reported having width 1.
1218
1219The solution is to upgrade your system or switch to a better one. A
1220possibly working workaround is to use a wcwidth implementation like
1221
1222http://www.cl.cam.ac.uk/~mgk25/ucs/wcwidth.c
1223
1008=head1 RXVT TECHNICAL REFERENCE 1224=head1 RXVT-UNICODE TECHNICAL REFERENCE
1009
1010=head1 DESCRIPTION
1011 1225
1012The rest of this document describes various technical aspects of 1226The rest of this document describes various technical aspects of
1013B<rxvt-unicode>. First the description of supported command sequences, 1227B<rxvt-unicode>. First the description of supported command sequences,
1014followed by pixmap support and last by a description of all features 1228followed by pixmap support and last by a description of all features
1015selectable at C<configure> time. 1229selectable at C<configure> time.
1016 1230
1017=head1 Definitions 1231=head2 Definitions
1018 1232
1019=over 4 1233=over 4
1020 1234
1021=item B<< C<c> >> 1235=item B<< C<c> >>
1022 1236
1040 1254
1041A text parameter composed of printable characters. 1255A text parameter composed of printable characters.
1042 1256
1043=back 1257=back
1044 1258
1045=head1 Values 1259=head2 Values
1046 1260
1047=over 4 1261=over 4
1048 1262
1049=item B<< C<ENQ> >> 1263=item B<< C<ENQ> >>
1050 1264
1093 1307
1094Space Character 1308Space Character
1095 1309
1096=back 1310=back
1097 1311
1098=head1 Escape Sequences 1312=head2 Escape Sequences
1099 1313
1100=over 4 1314=over 4
1101 1315
1102=item B<< C<ESC # 8> >> 1316=item B<< C<ESC # 8> >>
1103 1317
1113 1327
1114=item B<< C<ESC => >> 1328=item B<< C<ESC => >>
1115 1329
1116Application Keypad (SMKX). See also next sequence. 1330Application Keypad (SMKX). See also next sequence.
1117 1331
1118=item B<<< C<< ESC >> >>> 1332=item B<<< C<< ESC > >> >>>
1119 1333
1120Normal Keypad (RMKX) 1334Normal Keypad (RMKX)
1121 1335
1122B<Note:> If the numeric keypad is activated, eg, B<Num_Lock> has been 1336B<Note:> If the numeric keypad is activated, eg, B<Num_Lock> has been
1123pressed, numbers or control functions are generated by the numeric keypad 1337pressed, numbers or control functions are generated by the numeric keypad
1201 1415
1202=back 1416=back
1203 1417
1204X<CSI> 1418X<CSI>
1205 1419
1206=head1 CSI (Command Sequence Introducer) Sequences 1420=head2 CSI (Command Sequence Introducer) Sequences
1207 1421
1208=over 4 1422=over 4
1209 1423
1210=item B<< C<ESC [ Ps @> >> 1424=item B<< C<ESC [ Ps @> >>
1211 1425
1266=begin table 1480=begin table
1267 1481
1268 B<< C<Ps = 0> >> Clear to Right (default) 1482 B<< C<Ps = 0> >> Clear to Right (default)
1269 B<< C<Ps = 1> >> Clear to Left 1483 B<< C<Ps = 1> >> Clear to Left
1270 B<< C<Ps = 2> >> Clear All 1484 B<< C<Ps = 2> >> Clear All
1485 B<< C<Ps = 3> >> Like Ps = 0, but is ignored when wrapped
1486 (@@RXVT_NAME@@ extension)
1271 1487
1272=end table 1488=end table
1273 1489
1274=item B<< C<ESC [ Ps L> >> 1490=item B<< C<ESC [ Ps L> >>
1275 1491
1481 1697
1482=back 1698=back
1483 1699
1484X<PrivateModes> 1700X<PrivateModes>
1485 1701
1486=head1 DEC Private Modes 1702=head2 DEC Private Modes
1487 1703
1488=over 4 1704=over 4
1489 1705
1490=item B<< C<ESC [ ? Pm h> >> 1706=item B<< C<ESC [ ? Pm h> >>
1491 1707
1507 1723
1508Toggle DEC Private Mode Values (rxvt extension). I<where> 1724Toggle DEC Private Mode Values (rxvt extension). I<where>
1509 1725
1510=over 4 1726=over 4
1511 1727
1512=item B<< C<Ps = 1> >> (DECCKM) 1728=item B<< C<Pm = 1> >> (DECCKM)
1513 1729
1514=begin table 1730=begin table
1515 1731
1516 B<< C<h> >> Application Cursor Keys 1732 B<< C<h> >> Application Cursor Keys
1517 B<< C<l> >> Normal Cursor Keys 1733 B<< C<l> >> Normal Cursor Keys
1518 1734
1519=end table 1735=end table
1520 1736
1521=item B<< C<Ps = 2> >> (ANSI/VT52 mode) 1737=item B<< C<Pm = 2> >> (ANSI/VT52 mode)
1522 1738
1523=begin table 1739=begin table
1524 1740
1525 B<< C<h> >> Enter VT52 mode 1741 B<< C<h> >> Enter VT52 mode
1526 B<< C<l> >> Enter VT52 mode 1742 B<< C<l> >> Enter VT52 mode
1527 1743
1528=end table 1744=end table
1529 1745
1530=item B<< C<Ps = 3> >> 1746=item B<< C<Pm = 3> >>
1531 1747
1532=begin table 1748=begin table
1533 1749
1534 B<< C<h> >> 132 Column Mode (DECCOLM) 1750 B<< C<h> >> 132 Column Mode (DECCOLM)
1535 B<< C<l> >> 80 Column Mode (DECCOLM) 1751 B<< C<l> >> 80 Column Mode (DECCOLM)
1536 1752
1537=end table 1753=end table
1538 1754
1539=item B<< C<Ps = 4> >> 1755=item B<< C<Pm = 4> >>
1540 1756
1541=begin table 1757=begin table
1542 1758
1543 B<< C<h> >> Smooth (Slow) Scroll (DECSCLM) 1759 B<< C<h> >> Smooth (Slow) Scroll (DECSCLM)
1544 B<< C<l> >> Jump (Fast) Scroll (DECSCLM) 1760 B<< C<l> >> Jump (Fast) Scroll (DECSCLM)
1545 1761
1546=end table 1762=end table
1547 1763
1548=item B<< C<Ps = 5> >> 1764=item B<< C<Pm = 5> >>
1549 1765
1550=begin table 1766=begin table
1551 1767
1552 B<< C<h> >> Reverse Video (DECSCNM) 1768 B<< C<h> >> Reverse Video (DECSCNM)
1553 B<< C<l> >> Normal Video (DECSCNM) 1769 B<< C<l> >> Normal Video (DECSCNM)
1554 1770
1555=end table 1771=end table
1556 1772
1557=item B<< C<Ps = 6> >> 1773=item B<< C<Pm = 6> >>
1558 1774
1559=begin table 1775=begin table
1560 1776
1561 B<< C<h> >> Origin Mode (DECOM) 1777 B<< C<h> >> Origin Mode (DECOM)
1562 B<< C<l> >> Normal Cursor Mode (DECOM) 1778 B<< C<l> >> Normal Cursor Mode (DECOM)
1563 1779
1564=end table 1780=end table
1565 1781
1566=item B<< C<Ps = 7> >> 1782=item B<< C<Pm = 7> >>
1567 1783
1568=begin table 1784=begin table
1569 1785
1570 B<< C<h> >> Wraparound Mode (DECAWM) 1786 B<< C<h> >> Wraparound Mode (DECAWM)
1571 B<< C<l> >> No Wraparound Mode (DECAWM) 1787 B<< C<l> >> No Wraparound Mode (DECAWM)
1572 1788
1573=end table 1789=end table
1574 1790
1575=item B<< C<Ps = 8> >> I<unimplemented> 1791=item B<< C<Pm = 8> >> I<unimplemented>
1576 1792
1577=begin table 1793=begin table
1578 1794
1579 B<< C<h> >> Auto-repeat Keys (DECARM) 1795 B<< C<h> >> Auto-repeat Keys (DECARM)
1580 B<< C<l> >> No Auto-repeat Keys (DECARM) 1796 B<< C<l> >> No Auto-repeat Keys (DECARM)
1581 1797
1582=end table 1798=end table
1583 1799
1584=item B<< C<Ps = 9> >> X10 XTerm 1800=item B<< C<Pm = 9> >> X10 XTerm
1585 1801
1586=begin table 1802=begin table
1587 1803
1588 B<< C<h> >> Send Mouse X & Y on button press. 1804 B<< C<h> >> Send Mouse X & Y on button press.
1589 B<< C<l> >> No mouse reporting. 1805 B<< C<l> >> No mouse reporting.
1590 1806
1591=end table 1807=end table
1592 1808
1593=item B<< C<Ps = 25> >> 1809=item B<< C<Pm = 25> >>
1594 1810
1595=begin table 1811=begin table
1596 1812
1597 B<< C<h> >> Visible cursor {cnorm/cvvis} 1813 B<< C<h> >> Visible cursor {cnorm/cvvis}
1598 B<< C<l> >> Invisible cursor {civis} 1814 B<< C<l> >> Invisible cursor {civis}
1599 1815
1600=end table 1816=end table
1601 1817
1602=item B<< C<Ps = 30> >> 1818=item B<< C<Pm = 30> >>
1603 1819
1604=begin table 1820=begin table
1605 1821
1606 B<< C<h> >> scrollBar visisble 1822 B<< C<h> >> scrollBar visible
1607 B<< C<l> >> scrollBar invisisble 1823 B<< C<l> >> scrollBar invisible
1608 1824
1609=end table 1825=end table
1610 1826
1611=item B<< C<Ps = 35> >> (B<rxvt>) 1827=item B<< C<Pm = 35> >> (B<rxvt>)
1612 1828
1613=begin table 1829=begin table
1614 1830
1615 B<< C<h> >> Allow XTerm Shift+key sequences 1831 B<< C<h> >> Allow XTerm Shift+key sequences
1616 B<< C<l> >> Disallow XTerm Shift+key sequences 1832 B<< C<l> >> Disallow XTerm Shift+key sequences
1617 1833
1618=end table 1834=end table
1619 1835
1620=item B<< C<Ps = 38> >> I<unimplemented> 1836=item B<< C<Pm = 38> >> I<unimplemented>
1621 1837
1622Enter Tektronix Mode (DECTEK) 1838Enter Tektronix Mode (DECTEK)
1623 1839
1624=item B<< C<Ps = 40> >> 1840=item B<< C<Pm = 40> >>
1625 1841
1626=begin table 1842=begin table
1627 1843
1628 B<< C<h> >> Allow 80/132 Mode 1844 B<< C<h> >> Allow 80/132 Mode
1629 B<< C<l> >> Disallow 80/132 Mode 1845 B<< C<l> >> Disallow 80/132 Mode
1630 1846
1631=end table 1847=end table
1632 1848
1633=item B<< C<Ps = 44> >> I<unimplemented> 1849=item B<< C<Pm = 44> >> I<unimplemented>
1634 1850
1635=begin table 1851=begin table
1636 1852
1637 B<< C<h> >> Turn On Margin Bell 1853 B<< C<h> >> Turn On Margin Bell
1638 B<< C<l> >> Turn Off Margin Bell 1854 B<< C<l> >> Turn Off Margin Bell
1639 1855
1640=end table 1856=end table
1641 1857
1642=item B<< C<Ps = 45> >> I<unimplemented> 1858=item B<< C<Pm = 45> >> I<unimplemented>
1643 1859
1644=begin table 1860=begin table
1645 1861
1646 B<< C<h> >> Reverse-wraparound Mode 1862 B<< C<h> >> Reverse-wraparound Mode
1647 B<< C<l> >> No Reverse-wraparound Mode 1863 B<< C<l> >> No Reverse-wraparound Mode
1648 1864
1649=end table 1865=end table
1650 1866
1651=item B<< C<Ps = 46> >> I<unimplemented> 1867=item B<< C<Pm = 46> >> I<unimplemented>
1652 1868
1653=item B<< C<Ps = 47> >> 1869=item B<< C<Pm = 47> >>
1654 1870
1655=begin table 1871=begin table
1656 1872
1657 B<< C<h> >> Use Alternate Screen Buffer 1873 B<< C<h> >> Use Alternate Screen Buffer
1658 B<< C<l> >> Use Normal Screen Buffer 1874 B<< C<l> >> Use Normal Screen Buffer
1659 1875
1660=end table 1876=end table
1661 1877
1662X<Priv66> 1878X<Priv66>
1663 1879
1664=item B<< C<Ps = 66> >> 1880=item B<< C<Pm = 66> >>
1665 1881
1666=begin table 1882=begin table
1667 1883
1668 B<< C<h> >> Application Keypad (DECPAM) == C<ESC => 1884 B<< C<h> >> Application Keypad (DECKPAM/DECPAM) == C<ESC =>
1669 B<< C<l> >> Normal Keypad (DECPNM) == C<< ESC > >> 1885 B<< C<l> >> Normal Keypad (DECKPNM/DECPNM) == C<< ESC > >>
1670 1886
1671=end table 1887=end table
1672 1888
1673=item B<< C<Ps = 67> >> 1889=item B<< C<Pm = 67> >>
1674 1890
1675=begin table 1891=begin table
1676 1892
1677 B<< C<h> >> Backspace key sends B<< C<BS> (DECBKM) >> 1893 B<< C<h> >> Backspace key sends B<< C<BS> (DECBKM) >>
1678 B<< C<l> >> Backspace key sends B<< C<DEL> >> 1894 B<< C<l> >> Backspace key sends B<< C<DEL> >>
1679 1895
1680=end table 1896=end table
1681 1897
1682=item B<< C<Ps = 1000> >> (X11 XTerm) 1898=item B<< C<Pm = 1000> >> (X11 XTerm)
1683 1899
1684=begin table 1900=begin table
1685 1901
1686 B<< C<h> >> Send Mouse X & Y on button press and release. 1902 B<< C<h> >> Send Mouse X & Y on button press and release.
1687 B<< C<l> >> No mouse reporting. 1903 B<< C<l> >> No mouse reporting.
1688 1904
1689=end table 1905=end table
1690 1906
1691=item B<< C<Ps = 1001> >> (X11 XTerm) I<unimplemented> 1907=item B<< C<Pm = 1001> >> (X11 XTerm) I<unimplemented>
1692 1908
1693=begin table 1909=begin table
1694 1910
1695 B<< C<h> >> Use Hilite Mouse Tracking. 1911 B<< C<h> >> Use Hilite Mouse Tracking.
1696 B<< C<l> >> No mouse reporting. 1912 B<< C<l> >> No mouse reporting.
1697 1913
1698=end table 1914=end table
1699 1915
1916=item B<< C<Pm = 1002> >> (X11 XTerm)
1917
1918=begin table
1919
1920 B<< C<h> >> Send Mouse X & Y on button press and release, and motion with a button pressed.
1921 B<< C<l> >> No mouse reporting.
1922
1923=end table
1924
1925=item B<< C<Pm = 1003> >> (X11 XTerm)
1926
1927=begin table
1928
1929 B<< C<h> >> Send Mouse X & Y on button press and release, and motion.
1930 B<< C<l> >> No mouse reporting.
1931
1932=end table
1933
1700=item B<< C<Ps = 1010> >> (B<rxvt>) 1934=item B<< C<Pm = 1010> >> (B<rxvt>)
1701 1935
1702=begin table 1936=begin table
1703 1937
1704 B<< C<h> >> Don't scroll to bottom on TTY output 1938 B<< C<h> >> Don't scroll to bottom on TTY output
1705 B<< C<l> >> Scroll to bottom on TTY output 1939 B<< C<l> >> Scroll to bottom on TTY output
1706 1940
1707=end table 1941=end table
1708 1942
1709=item B<< C<Ps = 1011> >> (B<rxvt>) 1943=item B<< C<Pm = 1011> >> (B<rxvt>)
1710 1944
1711=begin table 1945=begin table
1712 1946
1713 B<< C<h> >> Scroll to bottom when a key is pressed 1947 B<< C<h> >> Scroll to bottom when a key is pressed
1714 B<< C<l> >> Don't scroll to bottom when a key is pressed 1948 B<< C<l> >> Don't scroll to bottom when a key is pressed
1715 1949
1716=end table 1950=end table
1717 1951
1718=item B<< C<Ps = 1021> >> (B<rxvt>) 1952=item B<< C<Pm = 1021> >> (B<rxvt>)
1719 1953
1720=begin table 1954=begin table
1721 1955
1722 B<< C<h> >> Bold/italic implies high intensity (see option B<-is>) 1956 B<< C<h> >> Bold/italic implies high intensity (see option B<-is>)
1723 B<< C<l> >> Font styles have no effect on intensity (Compile styles) 1957 B<< C<l> >> Font styles have no effect on intensity (Compile styles)
1724 1958
1725=end table 1959=end table
1726 1960
1727=item B<< C<Ps = 1047> >> 1961=item B<< C<Pm = 1047> >>
1728 1962
1729=begin table 1963=begin table
1730 1964
1731 B<< C<h> >> Use Alternate Screen Buffer 1965 B<< C<h> >> Use Alternate Screen Buffer
1732 B<< C<l> >> Use Normal Screen Buffer - clear Alternate Screen Buffer if returning from it 1966 B<< C<l> >> Use Normal Screen Buffer - clear Alternate Screen Buffer if returning from it
1733 1967
1734=end table 1968=end table
1735 1969
1736=item B<< C<Ps = 1048> >> 1970=item B<< C<Pm = 1048> >>
1737 1971
1738=begin table 1972=begin table
1739 1973
1740 B<< C<h> >> Save cursor position 1974 B<< C<h> >> Save cursor position
1741 B<< C<l> >> Restore cursor position 1975 B<< C<l> >> Restore cursor position
1742 1976
1743=end table 1977=end table
1744 1978
1745=item B<< C<Ps = 1049> >> 1979=item B<< C<Pm = 1049> >>
1746 1980
1747=begin table 1981=begin table
1748 1982
1749 B<< C<h> >> Use Alternate Screen Buffer - clear Alternate Screen Buffer if switching to it 1983 B<< C<h> >> Use Alternate Screen Buffer - clear Alternate Screen Buffer if switching to it
1750 B<< C<l> >> Use Normal Screen Buffer 1984 B<< C<l> >> Use Normal Screen Buffer
1751 1985
1752=end table 1986=end table
1753 1987
1988=item B<< C<Pm = 2004> >>
1989
1990=begin table
1991
1992 B<< C<h> >> Enable bracketed paste mode - prepend / append to the pasted text the control sequences C<ESC [ 200 ~> / C<ESC [ 201 ~>
1993 B<< C<l> >> Disable bracketed paste mode
1994
1995=end table
1996
1754=back 1997=back
1755 1998
1756=back 1999=back
1757 2000
1758X<XTerm> 2001X<XTerm>
1759 2002
1760=head1 XTerm Operating System Commands 2003=head2 XTerm Operating System Commands
1761 2004
1762=over 4 2005=over 4
1763 2006
1764=item B<< C<ESC ] Ps;Pt ST> >> 2007=item B<< C<ESC ] Ps;Pt ST> >>
1765 2008
1772 B<< C<Ps = 0> >> Change Icon Name and Window Title to B<< C<Pt> >> 2015 B<< C<Ps = 0> >> Change Icon Name and Window Title to B<< C<Pt> >>
1773 B<< C<Ps = 1> >> Change Icon Name to B<< C<Pt> >> 2016 B<< C<Ps = 1> >> Change Icon Name to B<< C<Pt> >>
1774 B<< C<Ps = 2> >> Change Window Title to B<< C<Pt> >> 2017 B<< C<Ps = 2> >> Change Window Title to B<< C<Pt> >>
1775 B<< C<Ps = 3> >> If B<< C<Pt> >> starts with a B<< C<?> >>, query the (STRING) property of the window and return it. If B<< C<Pt> >> contains a B<< C<=> >>, set the named property to the given value, else delete the specified property. 2018 B<< C<Ps = 3> >> If B<< C<Pt> >> starts with a B<< C<?> >>, query the (STRING) property of the window and return it. If B<< C<Pt> >> contains a B<< C<=> >>, set the named property to the given value, else delete the specified property.
1776 B<< C<Ps = 4> >> B<< C<Pt> >> is a semi-colon separated sequence of one or more semi-colon separated B<number>/B<name> pairs, where B<number> is an index to a colour and B<name> is the name of a colour. Each pair causes the B<number>ed colour to be changed to B<name>. Numbers 0-7 corresponds to low-intensity (normal) colours and 8-15 corresponds to high-intensity colours. 0=black, 1=red, 2=green, 3=yellow, 4=blue, 5=magenta, 6=cyan, 7=white 2019 B<< C<Ps = 4> >> B<< C<Pt> >> is a semi-colon separated sequence of one or more semi-colon separated B<number>/B<name> pairs, where B<number> is an index to a colour and B<name> is the name of a colour. Each pair causes the B<number>ed colour to be changed to B<name>. Numbers 0-7 corresponds to low-intensity (normal) colours and 8-15 corresponds to high-intensity colours. 0=black, 1=red, 2=green, 3=yellow, 4=blue, 5=magenta, 6=cyan, 7=white
1777 B<< C<Ps = 10> >> Change colour of text foreground to B<< C<Pt> >> B<(NB: may change in future)> 2020 B<< C<Ps = 10> >> Change colour of text foreground to B<< C<Pt> >>
1778 B<< C<Ps = 11> >> Change colour of text background to B<< C<Pt> >> B<(NB: may change in future)> 2021 B<< C<Ps = 11> >> Change colour of text background to B<< C<Pt> >>
1779 B<< C<Ps = 12> >> Change colour of text cursor foreground to B<< C<Pt> >> 2022 B<< C<Ps = 12> >> Change colour of text cursor foreground to B<< C<Pt> >>
1780 B<< C<Ps = 13> >> Change colour of mouse foreground to B<< C<Pt> >> 2023 B<< C<Ps = 13> >> Change colour of mouse foreground to B<< C<Pt> >>
1781 B<< C<Ps = 17> >> Change colour of highlight characters to B<< C<Pt> >> 2024 B<< C<Ps = 17> >> Change background colour of highlight characters to B<< C<Pt> >>
1782 B<< C<Ps = 18> >> Change colour of bold characters to B<< C<Pt> >> [deprecated, see 706] 2025 B<< C<Ps = 19> >> Change foreground colour of highlight characters to B<< C<Pt> >>
1783 B<< C<Ps = 19> >> Change colour of underlined characters to B<< C<Pt> >> [deprecated, see 707]
1784 B<< C<Ps = 20> >> Change background pixmap parameters (see section XPM) (Compile XPM). 2026 B<< C<Ps = 20> >> Change background pixmap parameters (see section BACKGROUND IMAGE) (Compile AfterImage).
1785 B<< C<Ps = 39> >> Change default foreground colour to B<< C<Pt> >>. 2027 B<< C<Ps = 39> >> Change default foreground colour to B<< C<Pt> >>. [deprecated, use 10]
1786 B<< C<Ps = 46> >> Change Log File to B<< C<Pt> >> I<unimplemented> 2028 B<< C<Ps = 46> >> Change Log File to B<< C<Pt> >> I<unimplemented>
1787 B<< C<Ps = 49> >> Change default background colour to B<< C<Pt> >>. 2029 B<< C<Ps = 49> >> Change default background colour to B<< C<Pt> >>. [deprecated, use 11]
1788 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> >> 2030 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> >>
1789 B<< C<Ps = 55> >> Log all scrollback buffer and all of screen to B<< C<Pt> >> 2031 B<< C<Ps = 55> >> Log all scrollback buffer and all of screen to B<< C<Pt> >> [disabled]
1790 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). 2032 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).
1791 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>. 2033 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>.
1792 B<< C<Ps = 704> >> Change colour of italic characters to B<< C<Pt> >> 2034 B<< C<Ps = 704> >> Change colour of italic characters to B<< C<Pt> >>
1793 B<< C<Ps = 705> >> Change background pixmap tint colour to B<< C<Pt> >> (Compile transparency). 2035 B<< C<Ps = 705> >> Change background pixmap tint colour to B<< C<Pt> >> (Compile transparency).
1794 B<< C<Ps = 706> >> Change colour of bold characters to B<< C<Pt> >> 2036 B<< C<Ps = 706> >> Change colour of bold characters to B<< C<Pt> >>
1795 B<< C<Ps = 707> >> Change colour of underlined characters to B<< C<Pt> >> 2037 B<< C<Ps = 707> >> Change colour of underlined characters to B<< C<Pt> >>
2038 B<< C<Ps = 708> >> Change colour of the border to B<< C<Pt> >>
1796 B<< C<Ps = 710> >> Set normal fontset to B<< C<Pt> >>. Same as C<Ps = 50>. 2039 B<< C<Ps = 710> >> Set normal fontset to B<< C<Pt> >>. Same as C<Ps = 50>.
1797 B<< C<Ps = 711> >> Set bold fontset to B<< C<Pt> >>. Similar to C<Ps = 50> (Compile styles). 2040 B<< C<Ps = 711> >> Set bold fontset to B<< C<Pt> >>. Similar to C<Ps = 50> (Compile styles).
1798 B<< C<Ps = 712> >> Set italic fontset to B<< C<Pt> >>. Similar to C<Ps = 50> (Compile styles). 2041 B<< C<Ps = 712> >> Set italic fontset to B<< C<Pt> >>. Similar to C<Ps = 50> (Compile styles).
1799 B<< C<Ps = 713> >> Set bold-italic fontset to B<< C<Pt> >>. Similar to C<Ps = 50> (Compile styles). 2042 B<< C<Ps = 713> >> Set bold-italic fontset to B<< C<Pt> >>. Similar to C<Ps = 50> (Compile styles).
1800 B<< C<Ps = 720> >> Move viewing window up by B<< C<Pt> >> lines, or clear scrollback buffer if C<Pt = 0> (Compile frills). 2043 B<< C<Ps = 720> >> Move viewing window up by B<< C<Pt> >> lines, or clear scrollback buffer if C<Pt = 0> (Compile frills).
1803 2046
1804=end table 2047=end table
1805 2048
1806=back 2049=back
1807 2050
1808X<XPM> 2051=head1 BACKGROUND IMAGE
1809 2052
1810=head1 XPM
1811
1812For the XPM XTerm escape sequence B<< C<ESC ] 20 ; Pt ST> >> then value 2053For the BACKGROUND IMAGE XTerm escape sequence B<< C<ESC ] 20 ; Pt ST> >> the value
1813of B<< C<Pt> >> can be the name of the background pixmap followed by a 2054of B<< C<Pt> >> can be the name of the background image file followed by a
1814sequence of scaling/positioning commands separated by semi-colons. The 2055sequence of scaling/positioning commands separated by semi-colons. The
1815scaling/positioning commands are as follows: 2056scaling/positioning commands are as follows:
1816 2057
1817=over 4 2058=over 4
1818 2059
1856 2097
1857For example: 2098For example:
1858 2099
1859=over 4 2100=over 4
1860 2101
1861=item B<\E]20;funky\a> 2102=item B<\E]20;funky.jpg\a>
1862 2103
1863load B<funky.xpm> as a tiled image 2104load B<funky.jpg> as a tiled image
1864 2105
1865=item B<\E]20;mona;100\a> 2106=item B<\E]20;mona.jpg;100\a>
1866 2107
1867load B<mona.xpm> with a scaling of 100% 2108load B<mona.jpg> with a scaling of 100%
1868 2109
1869=item B<\E]20;;200;?\a> 2110=item B<\E]20;;200;?\a>
1870 2111
1871rescale the current pixmap to 200% and display the image geometry in 2112rescale the current pixmap to 200% and display the image geometry in
1872the title 2113the title
1873 2114
1874=back 2115=back
2116
1875X<Mouse> 2117X<Mouse>
1876 2118
1877=head1 Mouse Reporting 2119=head1 Mouse Reporting
1878 2120
1879=over 4 2121=over 4
1911=begin table 2153=begin table
1912 2154
1913 4 Shift 2155 4 Shift
1914 8 Meta 2156 8 Meta
1915 16 Control 2157 16 Control
1916 32 Double Click I<(Rxvt extension)> 2158 32 Double Click I<(rxvt extension)>
1917 2159
1918=end table 2160=end table
1919 2161
1920Col = B<< C<< <x> - SPACE >> >> 2162Col = B<< C<< <x> - SPACE >> >>
1921 2163
1922Row = B<< C<< <y> - SPACE >> >> 2164Row = B<< C<< <y> - SPACE >> >>
1923 2165
1924=back 2166=back
2167
2168=head1 Key Codes
2169
1925X<KeyCodes> 2170X<KeyCodes>
1926
1927=head1 Key Codes
1928 2171
1929Note: B<Shift> + B<F1>-B<F10> generates B<F11>-B<F20> 2172Note: B<Shift> + B<F1>-B<F10> generates B<F11>-B<F20>
1930 2173
1931For the keypad, use B<Shift> to temporarily override Application-Keypad 2174For the keypad, use B<Shift> to temporarily override Application-Keypad
1932setting use B<Num_Lock> to toggle Application-Keypad setting if 2175setting use B<Num_Lock> to toggle Application-Keypad setting if
1999 2242
2000=head1 CONFIGURE OPTIONS 2243=head1 CONFIGURE OPTIONS
2001 2244
2002General hint: if you get compile errors, then likely your configuration 2245General hint: if you get compile errors, then likely your configuration
2003hasn't been tested well. Either try with C<--enable-everything> or use 2246hasn't been tested well. Either try with C<--enable-everything> or use
2004the F<./reconf> script as a base for experiments. F<./reconf> is used by 2247the default configuration (i.e. no C<--enable-xxx> or C<--disable-xxx>
2005myself, so it should generally be a working config. Of course, you should 2248switches). Of course, you should always report when a combination doesn't
2006always report when a combination doesn't work, so it can be fixed. Marc 2249work, so it can be fixed. Marc Lehmann <rxvt@schmorp.de>.
2007Lehmann <rxvt@schmorp.de>.
2008 2250
2009All 2251All
2010 2252
2011=over 4 2253=over 4
2012 2254
2013=item --enable-everything 2255=item --enable-everything
2014 2256
2015Add (or remove) support for all non-multichoice options listed in "./configure 2257Add (or remove) support for all non-multichoice options listed in
2016--help". 2258C<./configure --help>, except for C<--enable-assert>.
2017 2259
2018You can specify this and then disable options you do not like by 2260You can specify this and then disable options you do not like by
2019I<following> this with the appropriate C<--disable-...> arguments, 2261I<following> this with the appropriate C<--disable-...> arguments,
2020or you can start with a minimal configuration by specifying 2262or you can start with a minimal configuration by specifying
2021C<--disable-everything> and than adding just the C<--enable-...> arguments 2263C<--disable-everything> and than adding just the C<--enable-...> arguments
2022you want. 2264you want.
2265
2266=item --enable-256-color (default: off)
2267
2268Add support for 256 colors.
2023 2269
2024=item --enable-xft (default: enabled) 2270=item --enable-xft (default: enabled)
2025 2271
2026Add support for Xft (anti-aliases, among others) fonts. Xft fonts are 2272Add support for Xft (anti-aliases, among others) fonts. Xft fonts are
2027slower and require lots of memory, but as long as you don't use them, you 2273slower and require lots of memory, but as long as you don't use them, you
2044 2290
2045=begin table 2291=begin table
2046 2292
2047 all all available codeset groups 2293 all all available codeset groups
2048 zh common chinese encodings 2294 zh common chinese encodings
2049 zh_ext rarely used but very big chinese encodigs 2295 zh_ext rarely used but very big chinese encodings
2050 jp common japanese encodings 2296 jp common japanese encodings
2051 jp_ext rarely used but big japanese encodings 2297 jp_ext rarely used but big japanese encodings
2052 kr korean encodings 2298 kr korean encodings
2053 2299
2054=end table 2300=end table
2068requirements per character from 2 to 4 bytes. X11 fonts do not yet 2314requirements per character from 2 to 4 bytes. X11 fonts do not yet
2069support these extra characters, but Xft does. 2315support these extra characters, but Xft does.
2070 2316
2071Please note that rxvt-unicode can store unicode code points >65535 2317Please note that rxvt-unicode can store unicode code points >65535
2072even without this flag, but the number of such characters is 2318even without this flag, but the number of such characters is
2073limited to a view thousand (shared with combining characters, 2319limited to a few thousand (shared with combining characters,
2074see next switch), and right now rxvt-unicode cannot display them 2320see next switch), and right now rxvt-unicode cannot display them
2075(input/output and cut&paste still work, though). 2321(input/output and cut&paste still work, though).
2076 2322
2077=item --enable-combining (default: on) 2323=item --enable-combining (default: on)
2078 2324
2079Enable automatic composition of combining characters into 2325Enable automatic composition of combining characters into
2080composite characters. This is required for proper viewing of text 2326composite characters. This is required for proper viewing of text
2081where accents are encoded as seperate unicode characters. This is 2327where accents are encoded as separate unicode characters. This is
2082done by using precomposited characters when available or creating 2328done by using precomposited characters when available or creating
2083new pseudo-characters when no precomposed form exists. 2329new pseudo-characters when no precomposed form exists.
2084 2330
2085Without --enable-unicode3, the number of additional precomposed 2331Without --enable-unicode3, the number of additional precomposed
2086characters is somewhat limited (the 6400 private use characters will be 2332characters is somewhat limited (the 6400 private use characters will be
2101=item --with-res-name=NAME (default: urxvt) 2347=item --with-res-name=NAME (default: urxvt)
2102 2348
2103Use the given name as default application name when 2349Use the given name as default application name when
2104reading resources. Specify --with-res-name=rxvt to replace rxvt. 2350reading resources. Specify --with-res-name=rxvt to replace rxvt.
2105 2351
2106=item --with-res-class=CLASS /default: URxvt) 2352=item --with-res-class=CLASS (default: URxvt)
2107 2353
2108Use the given class as default application class 2354Use the given class as default application class
2109when reading resources. Specify --with-res-class=Rxvt to replace 2355when reading resources. Specify --with-res-class=Rxvt to replace
2110rxvt. 2356rxvt.
2111 2357
2124 2370
2125Write user and tty to lastlog file (used by programs like 2371Write user and tty to lastlog file (used by programs like
2126F<lastlogin>) at start of rxvt execution. This option requires 2372F<lastlogin>) at start of rxvt execution. This option requires
2127--enable-utmp to also be specified. 2373--enable-utmp to also be specified.
2128 2374
2129=item --enable-xpm-background (default: on) 2375=item --enable-afterimage (default: on)
2130 2376
2131Add support for XPM background pixmaps. 2377Add support for libAfterImage to be used for transparency and background
2378images. It adds support for many file formats including JPG, PNG,
2379SVG, TIFF, GIF, XPM, BMP, ICO, XCF, TGA and AfterStep image XML
2380(L<http://www.afterstep.org/visualdoc.php?show=asimagexml>).
2381
2382This option also adds such eye candy as blending an image over the root
2383background, as well as dynamic scaling and bluring of background images.
2384
2385Note that with this option enabled, @@RXVT_NAME@@'s memory footprint might
2386increase by a few megabytes even if no extra features are used (mostly due
2387to third-party libraries used by libAI). Memory footprint may somewhat be
2388lowered if libAfterImage is configured without support for SVG.
2132 2389
2133=item --enable-transparency (default: on) 2390=item --enable-transparency (default: on)
2134 2391
2135Add support for inheriting parent backgrounds thus giving a fake 2392Add support for backgrounds, creating illusion of transparency in the term.
2136transparency to the term.
2137 2393
2138=item --enable-fading (default: on) 2394=item --enable-fading (default: on)
2139 2395
2140Add support for fading the text when focus is lost (requires C<--enable-transparency>). 2396Add support for fading the text when focus is lost.
2141
2142=item --enable-tinting (default: on)
2143
2144Add support for tinting of transparent backgrounds (requires C<--enable-transparency>).
2145 2397
2146=item --enable-rxvt-scroll (default: on) 2398=item --enable-rxvt-scroll (default: on)
2147 2399
2148Add support for the original rxvt scrollbar. 2400Add support for the original rxvt scrollbar.
2149 2401
2152Add support for a NeXT-like scrollbar. 2404Add support for a NeXT-like scrollbar.
2153 2405
2154=item --enable-xterm-scroll (default: on) 2406=item --enable-xterm-scroll (default: on)
2155 2407
2156Add support for an Xterm-like scrollbar. 2408Add support for an Xterm-like scrollbar.
2157
2158=item --enable-plain-scroll (default: on)
2159
2160Add support for a very unobtrusive, plain-looking scrollbar that
2161is the favourite of the rxvt-unicode author, having used it for
2162many years.
2163
2164=item --enable-ttygid (default: off)
2165
2166Change tty device setting to group "tty" - only use this if
2167your system uses this type of security.
2168 2409
2169=item --disable-backspace-key 2410=item --disable-backspace-key
2170 2411
2171Removes any handling of the backspace key by us - let the X server do it. 2412Removes any handling of the backspace key by us - let the X server do it.
2172 2413
2192A non-exhaustive list of features enabled by C<--enable-frills> (possibly 2433A non-exhaustive list of features enabled by C<--enable-frills> (possibly
2193in combination with other switches) is: 2434in combination with other switches) is:
2194 2435
2195 MWM-hints 2436 MWM-hints
2196 EWMH-hints (pid, utf8 names) and protocols (ping) 2437 EWMH-hints (pid, utf8 names) and protocols (ping)
2438 urgency hint
2197 seperate underline colour (-underlineColor) 2439 separate underline colour (-underlineColor)
2198 settable border widths and borderless switch (-w, -b, -bl) 2440 settable border widths and borderless switch (-w, -b, -bl)
2199 visual depth selection (-depth) 2441 visual depth selection (-depth)
2200 settable extra linespacing /-lsp) 2442 settable extra linespacing /-lsp)
2201 iso-14755-2 and -3, and visual feedback 2443 iso-14755 5.1 (basic) support
2202 tripleclickwords (-tcw) 2444 tripleclickwords (-tcw)
2203 settable insecure mode (-insecure) 2445 settable insecure mode (-insecure)
2204 keysym remapping support 2446 keysym remapping support
2205 cursor blinking and underline cursor (-cb, -uc) 2447 cursor blinking and underline cursor (-bc, -uc)
2206 XEmbed support (-embed) 2448 XEmbed support (-embed)
2207 user-pty (-pty-fd) 2449 user-pty (-pty-fd)
2208 hold on exit (-hold) 2450 hold on exit (-hold)
2451 compile in built-in block graphics
2209 skip builtin block graphics (-sbg) 2452 skip builtin block graphics (-sbg)
2453 separate highlight colour (-highlightColor, -highlightTextColor)
2210 2454
2211It also enabled some non-essential features otherwise disabled, such as: 2455It also enables some non-essential features otherwise disabled, such as:
2212 2456
2213 some round-trip time optimisations 2457 some round-trip time optimisations
2214 nearest color allocation on pseudocolor screens 2458 nearest color allocation on pseudocolor screens
2215 UTF8_STRING supporr for selection 2459 UTF8_STRING support for selection
2216 sgr modes 90..97 and 100..107 2460 sgr modes 90..97 and 100..107
2217 backindex and forwardindex escape sequences 2461 backindex and forwardindex escape sequences
2218 view change/zero scorllback esacpe sequences 2462 view change/zero scrollback escape sequences
2219 locale switching escape sequence 2463 locale switching escape sequence
2220 window op and some xterm/OSC escape sequences 2464 window op and some xterm/OSC escape sequences
2221 rectangular selections 2465 rectangular selections
2222 trailing space removal for selections 2466 trailing space removal for selections
2223 verbose X error handling 2467 verbose X error handling
2224 2468
2225=item --enable-iso14755 (default: on) 2469=item --enable-iso14755 (default: on)
2226 2470
2227Enable extended ISO 14755 support (see @@RXVT_NAME@@(1), or 2471Enable extended ISO 14755 support (see @@RXVT_NAME@@(1)).
2228F<doc/rxvt.1.txt>). Basic support (section 5.1) is enabled by 2472Basic support (section 5.1) is enabled by C<--enable-frills>, while
2229C<--enable-frills>, while support for 5.2, 5.3 and 5.4 is enabled with 2473support for 5.2, 5.3 and 5.4 is enabled with this switch.
2230this switch.
2231 2474
2232=item --enable-keepscrolling (default: on) 2475=item --enable-keepscrolling (default: on)
2233 2476
2234Add support for continual scrolling of the display when you hold 2477Add support for continual scrolling of the display when you hold
2235the mouse button down on a scrollbar arrow. 2478the mouse button down on a scrollbar arrow.
2479
2480=item --enable-selectionscrolling (default: on)
2481
2482Add support for scrolling when the selection moves to the top or
2483bottom of the screen.
2236 2484
2237=item --enable-mousewheel (default: on) 2485=item --enable-mousewheel (default: on)
2238 2486
2239Add support for scrolling via mouse wheel or buttons 4 & 5. 2487Add support for scrolling via mouse wheel or buttons 4 & 5.
2240 2488
2242 2490
2243Add support for continual scrolling (using the mouse wheel as an 2491Add support for continual scrolling (using the mouse wheel as an
2244accelerator) while the control key is held down. This option 2492accelerator) while the control key is held down. This option
2245requires --enable-mousewheel to also be specified. 2493requires --enable-mousewheel to also be specified.
2246 2494
2247=item --disable-new-selection
2248
2249Remove support for mouse selection style like that of xterm.
2250
2251=item --enable-dmalloc (default: off)
2252
2253Use Gray Watson's malloc - which is good for debugging See
2254http://www.letters.com/dmalloc/ for details If you use either this or the
2255next option, you may need to edit src/Makefile after compiling to point
2256DINCLUDE and DLIB to the right places.
2257
2258You can only use either this option and the following (should
2259you use either) .
2260
2261=item --enable-dlmalloc (default: off)
2262
2263Use Doug Lea's malloc - which is good for a production version
2264See L<http://g.oswego.edu/dl/html/malloc.html> for details.
2265
2266=item --enable-smart-resize (default: on) 2495=item --enable-smart-resize (default: off)
2267 2496
2268Add smart growth/shrink behaviour when changing font size via hot 2497Add smart growth/shrink behaviour when resizing.
2269keys. This should keep the window corner which is closest to a corner of 2498This should keep the window corner which is closest to a corner of
2270the screen in a fixed position. 2499the screen in a fixed position.
2271 2500
2501=item --enable-text-blink (default: on)
2502
2503Add support for blinking text.
2504
2272=item --enable-pointer-blank (default: on) 2505=item --enable-pointer-blank (default: on)
2273 2506
2274Add support to have the pointer disappear when typing or inactive. 2507Add support to have the pointer disappear when typing or inactive.
2275 2508
2276=item --enable-perl (default: on) 2509=item --enable-perl (default: on)
2277 2510
2278Enable an embedded perl interpreter. See the B<@@RXVT_NAME@@perl(3)> 2511Enable an embedded perl interpreter. See the B<@@RXVT_NAME@@perl(3)>
2279manpage (F<doc/rxvtperl.txt>) for more info on this feature, or the files 2512manpage for more info on this feature, or the files in F<src/perl/>
2280in F<src/perl-ext/> for the extensions that are installed by default. The 2513for the extensions that are installed by default.
2281perl interpreter that is used can be specified via the C<PERL> environment 2514The perl interpreter that is used can be specified via the C<PERL>
2282variable when running configure. 2515environment variable when running configure. Even when compiled in,
2516perl will I<not> be initialised when all extensions have been disabled
2517C<-pe "" --perl-ext-common "">, so it should be safe to enable from a
2518resource standpoint.
2519
2520=item --enable-assert (default: off)
2521
2522Enables the assertions in the code, normally disabled. This switch is only
2523useful when developing rxvt-unicode.
2524
2525=item --with-afterimage-config=DIR
2526
2527Look for the libAfterImage config script in DIR.
2283 2528
2284=item --with-name=NAME (default: urxvt) 2529=item --with-name=NAME (default: urxvt)
2285 2530
2286Set the basename for the installed binaries, resulting 2531Set the basename for the installed binaries, resulting
2287in C<urxvt>, C<urxvtd> etc.). Specify C<--with-name=rxvt> to replace with 2532in C<urxvt>, C<urxvtd> etc.). Specify C<--with-name=rxvt> to replace with
2297PATH. 2542PATH.
2298 2543
2299=item --with-x 2544=item --with-x
2300 2545
2301Use the X Window System (pretty much default, eh?). 2546Use the X Window System (pretty much default, eh?).
2302
2303=item --with-xpm-includes=DIR
2304
2305Look for the XPM includes in DIR.
2306
2307=item --with-xpm-library=DIR
2308
2309Look for the XPM library in DIR.
2310
2311=item --with-xpm
2312
2313Not needed - define via --enable-xpm-background.
2314 2547
2315=back 2548=back
2316 2549
2317=head1 AUTHORS 2550=head1 AUTHORS
2318 2551

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines