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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines