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.149 by sasha, Mon Oct 29 13:40:41 2007 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://cvs.schmorp.de/browse/rxvt-unicode/doc/rxvt.7.html>.
23 23
24=head1 FREQUENTLY ASKED QUESTIONS 24=head1 RXVT-UNICODE/URXVT FREQUENTLY ASKED QUESTIONS
25 25
26 26
27=head2 Meta, Features & Commandline Issues 27=head2 Meta, Features & Commandline Issues
28 28
29=head3 My question isn't answered here, can I ask a human? 29=head3 My question isn't answered here, can I ask a human?
36 36
37Beginning with version 7.3, there is a perl extension that implements a 37Beginning with version 7.3, there is a perl extension that implements a
38simple tabbed terminal. It is installed by default, so any of these should 38simple tabbed terminal. It is installed by default, so any of these should
39give you tabs: 39give you tabs:
40 40
41 @@RXVT_NAME@@ -pe tabbed 41 @@URXVT_NAME@@ -pe tabbed
42 42
43 URxvt.perl-ext-common: default,tabbed 43 URxvt.perl-ext-common: default,tabbed
44 44
45It will also work fine with tabbing functionality of many window managers 45It will also work fine with tabbing functionality of many window managers
46or similar tabbing programs, and its embedding-features allow it to be 46or similar tabbing programs, and its embedding-features allow it to be
50 50
51=head3 How do I know which rxvt-unicode version I'm using? 51=head3 How do I know which rxvt-unicode version I'm using?
52 52
53The version number is displayed with the usage (-h). Also the escape 53The 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 54sequence 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 55using the @@URXVT_NAME@@c client, the version displayed is that of the
56daemon. 56daemon.
57 57
58=head3 Rxvt-unicode uses gobs of memory, how can I reduce that? 58=head3 Rxvt-unicode uses gobs of memory, how can I reduce that?
59 59
60Rxvt-unicode tries to obey the rule of not charging you for something you 60Rxvt-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 686 bytes per screen cell. For a 160x?? window this amounts to almost a
69kilobyte per line. A scrollback buffer of 10000 lines will then (if full) 69kilobyte per line. A scrollback buffer of 10000 lines will then (if full)
70use 10 Megabytes of memory. With C<--enable-unicode3> it gets worse, as 70use 10 Megabytes of memory. With C<--enable-unicode3> it gets worse, as
71rxvt-unicode then uses 8 bytes per screen cell. 71rxvt-unicode then uses 8 bytes per screen cell.
72 72
73=head3 How can I start @@RXVT_NAME@@d in a race-free way? 73=head3 How can I start @@URXVT_NAME@@d in a race-free way?
74 74
75Try C<@@RXVT_NAME@@d -f -o>, which tells @@RXVT_NAME@@d to open the 75Try C<@@URXVT_NAME@@d -f -o>, which tells @@URXVT_NAME@@d to open the
76display, create the listening socket and then fork. 76display, create the listening socket and then fork.
77 77
78=head3 How can I start @@URXVT_NAME@@d automatically when I run @@URXVT_NAME@@c?
79
80If you want to start @@URXVT_NAME@@d automatically whenever you run
81@@URXVT_NAME@@c and the daemon isn't running yet, use this script:
82
83 #!/bin/sh
84 @@URXVT_NAME@@c "$@"
85 if [ $? -eq 2 ]; then
86 @@URXVT_NAME@@d -q -o -f
87 @@URXVT_NAME@@c "$@"
88 fi
89
90This tries to create a new terminal, and if fails with exit status 2,
91meaning it couldn't connect to the daemon, it will start the daemon and
92re-run the command. Subsequent invocations of the script will re-use the
93existing daemon.
94
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. 95=head3 How do I distinguish whether I'm running rxvt-unicode or a regular xterm? I need this to decide about setting colors etc.
79 96
80rxvt and rxvt-unicode always export the variable "COLORTERM", so you can 97The original rxvt and rxvt-unicode always export the variable "COLORTERM",
81check and see if that is set. Note that several programs, JED, slrn, 98so you can check and see if that is set. Note that several programs, JED,
82Midnight Commander automatically check this variable to decide whether or 99slrn, Midnight Commander automatically check this variable to decide
83not to use color. 100whether or not to use color.
84 101
85=head3 How do I set the correct, full IP address for the DISPLAY variable? 102=head3 How do I set the correct, full IP address for the DISPLAY variable?
86 103
87If you've compiled rxvt-unicode with DISPLAY_IS_IP and have enabled 104If you've compiled rxvt-unicode with DISPLAY_IS_IP and have enabled
88insecure mode then it is possible to use the following shell script 105insecure mode then it is possible to use the following shell script
108 fi 125 fi
109 126
110=head3 How do I compile the manual pages on my own? 127=head3 How do I compile the manual pages on my own?
111 128
112You need to have a recent version of perl installed as F</usr/bin/perl>, 129You 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 130one that comes with F<pod2man>, F<pod2text> and F<pod2xhtml> (from
114the doc subdirectory and enter C<make alldoc>. 131F<Pod::Xhtml>). Then go to the doc subdirectory and enter C<make alldoc>.
115 132
116=head3 Isn't rxvt-unicode supposed to be small? Don't all those features bloat? 133=head3 Isn't rxvt-unicode supposed to be small? Don't all those features bloat?
117 134
118I often get asked about this, and I think, no, they didn't cause extra 135I often get asked about this, and I think, no, they didn't cause extra
119bloat. If you compare a minimal rxvt and a minimal urxvt, you can see 136bloat. If you compare a minimal rxvt and a minimal urxvt, you can see
125 142
126 text data bss drs rss filename 143 text data bss drs rss filename
127 98398 1664 24 15695 1824 rxvt --disable-everything 144 98398 1664 24 15695 1824 rxvt --disable-everything
128 188985 9048 66616 18222 1788 urxvt --disable-everything 145 188985 9048 66616 18222 1788 urxvt --disable-everything
129 146
130When you C<--enable-everything> (which _is_ unfair, as this involves xft 147When 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 148and full locale/XIM support which are quite bloaty inside libX11 and my
132libc), the two diverge, but not unreasnobaly so. 149libc), the two diverge, but not unreasonably so.
133 150
134 text data bss drs rss filename 151 text data bss drs rss filename
135 163431 2152 24 20123 2060 rxvt --enable-everything 152 163431 2152 24 20123 2060 rxvt --enable-everything
136 1035683 49680 66648 29096 3680 urxvt --enable-everything 153 1035683 49680 66648 29096 3680 urxvt --enable-everything
137 154
192 209
193=head2 Rendering, Font & Look and Feel Issues 210=head2 Rendering, Font & Look and Feel Issues
194 211
195=head3 I can't get transparency working, what am I doing wrong? 212=head3 I can't get transparency working, what am I doing wrong?
196 213
197First of all, transparency isn't officially supported in rxvt-unicode, so 214First of all, please address all transparency related issues to Sasha Vasko at
198you are mostly on your own. Do not bug the author about it (but you may 215sasha@aftercode.net and do not bug the author about it. Also, if you can't
199bug everybody else). Also, if you can't get it working consider it a rite 216get it working consider it a rite of passage: ... and you failed.
200of passage: ... and you failed.
201 217
202Here are four ways to get transparency. B<Do> read the manpage and option 218Here are four ways to get transparency. B<Do> read the manpage and option
203descriptions for the programs mentioned and rxvt-unicode. Really, do it! 219descriptions for the programs mentioned and rxvt-unicode. Really, do it!
204 220
2051. Use inheritPixmap: 2211. Use transparent mode:
206 222
207 Esetroot wallpaper.jpg 223 Esetroot wallpaper.jpg
208 @@RXVT_NAME@@ -ip -tint red -sh 40 224 @@URXVT_NAME@@ -tr -tint red -sh 40
209 225
210That works. If you think it doesn't, you lack transparency and tinting 226That works. If you think it doesn't, you lack transparency and tinting
211support, or you are unable to read. 227support, or you are unable to read.
212 228
2132. Use a simple pixmap and emulate pseudo-transparency. This enables you 2292. Use a simple pixmap and emulate pseudo-transparency. This enables you
214to use effects other than tinting and shading: Just shade/tint/whatever 230to use effects other than tinting and shading: Just shade/tint/whatever
215your picture with gimp or any other tool: 231your picture with gimp or any other tool:
216 232
217 convert wallpaper.jpg -blur 20x20 -modulate 30 background.xpm 233 convert wallpaper.jpg -blur 20x20 -modulate 30 background.jpg
218 @@RXVT_NAME@@ -pixmap background.xpm -pe automove-background 234 @@URXVT_NAME@@ -pixmap background.jpg -pe automove-background
219 235
220That works. If you think it doesn't, you lack XPM and Perl support, or you 236That works. If you think it doesn't, you lack AfterImage and Perl support, or you
221are unable to read. 237are unable to read.
222 238
2233. Use an ARGB visual: 2393. Use an ARGB visual:
224 240
225 @@RXVT_NAME@@ -depth 32 -fg grey90 -bg rgba:0000/0000/4444/cccc 241 @@URXVT_NAME@@ -depth 32 -fg grey90 -bg rgba:0000/0000/4444/cccc
226 242
227This requires XFT support, and the support of your X-server. If that 243This 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 244doesn'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 245there yet, no matter what they claim. Rxvt-Unicode contains the necessary
230bugfixes and workarounds for Xft and Xlib to make it work, but that 246bugfixes and workarounds for Xft and Xlib to make it work, but that
231doesn't mean that your WM has the required kludges in place. 247doesn't mean that your WM has the required kludges in place.
232 248
2334. Use xcompmgr and let it do the job: 2494. Use xcompmgr and let it do the job:
234 250
236 -set _NET_WM_WINDOW_OPACITY 0xc0000000 252 -set _NET_WM_WINDOW_OPACITY 0xc0000000
237 253
238Then click on a window you want to make transparent. Replace C<0xc0000000> 254Then 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 255by other values to change the degree of opacity. If it doesn't work and
240your server crashes, you got to keep the pieces. 256your 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 257
267=head3 Why does rxvt-unicode sometimes leave pixel droppings? 258=head3 Why does rxvt-unicode sometimes leave pixel droppings?
268 259
269Most fonts were not designed for terminal use, which means that character 260Most 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 261size varies a lot. A font that is otherwise fine for terminal use might
276however: Xft fonts often draw glyphs larger than their acclaimed bounding 267however: 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 268box, 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 269ask for the character bounding box, which unfortunately is wrong in these
279cases). 270cases).
280 271
281It's not clear (to me at least), wether this is a bug in Xft, freetype, 272It'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 273or 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 274the C<-lsp> option to give the font more height. If that doesn't work, you
284might be forced to use a different font. 275might be forced to use a different font.
285 276
286All of this is not a problem when using X11 core fonts, as their bounding 277All of this is not a problem when using X11 core fonts, as their bounding
310=head3 Can I switch the fonts at runtime? 301=head3 Can I switch the fonts at runtime?
311 302
312Yes, using an escape sequence. Try something like this, which has the same 303Yes, using an escape sequence. Try something like this, which has the same
313effect as using the C<-fn> switch, and takes effect immediately: 304effect as using the C<-fn> switch, and takes effect immediately:
314 305
315 printf '\e]50;%s\007' "9x15bold,xft:Kochi Gothic" 306 printf '\33]50;%s\007' "9x15bold,xft:Kochi Gothic"
316 307
317This is useful if you e.g. work primarily with japanese (and prefer a 308This is useful if you e.g. work primarily with japanese (and prefer a
318japanese font), but you have to switch to chinese temporarily, where 309japanese font), but you have to switch to chinese temporarily, where
319japanese fonts would only be in your way. 310japanese fonts would only be in your way.
320 311
322 313
323=head3 Why do italic characters look as if clipped? 314=head3 Why do italic characters look as if clipped?
324 315
325Many fonts have difficulties with italic characters and hinting. For 316Many fonts have difficulties with italic characters and hinting. For
326example, the otherwise very nicely hinted font C<xft:Bitstream Vera Sans 317example, the otherwise very nicely hinted font C<xft:Bitstream Vera Sans
327Mono> completely fails in it's italic face. A workaround might be to 318Mono> completely fails in its italic face. A workaround might be to
328enable freetype autohinting, i.e. like this: 319enable freetype autohinting, i.e. like this:
329 320
330 URxvt.italicFont: xft:Bitstream Vera Sans Mono:italic:autohint=true 321 URxvt.italicFont: xft:Bitstream Vera Sans Mono:italic:autohint=true
331 URxvt.boldItalicFont: xft:Bitstream Vera Sans Mono:bold:italic:autohint=true 322 URxvt.boldItalicFont: xft:Bitstream Vera Sans Mono:bold:italic:autohint=true
332 323
338memory and also speeds up rendering considerably. 329memory and also speeds up rendering considerably.
339 330
340=head3 Rxvt-unicode doesn't seem to anti-alias its fonts, what is wrong? 331=head3 Rxvt-unicode doesn't seem to anti-alias its fonts, what is wrong?
341 332
342Rxvt-unicode will use whatever you specify as a font. If it needs to 333Rxvt-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 334fall 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 335fonts, because they are small and fast, and then use Xft fonts. It has
345antialiasing disabled for most of them, because the author thinks they 336antialiasing disabled for most of them, because the author thinks they
346look best that way. 337look best that way.
347 338
348If you want antialiasing, you have to specify the fonts manually. 339If you want antialiasing, you have to specify the fonts manually.
388 URxvt.color12: #0000FF 379 URxvt.color12: #0000FF
389 URxvt.color13: #FF00FF 380 URxvt.color13: #FF00FF
390 URxvt.color14: #00FFFF 381 URxvt.color14: #00FFFF
391 URxvt.color15: #FFFFFF 382 URxvt.color15: #FFFFFF
392 383
393And here is a more complete set of non-standard colors described (not by 384And here is a more complete set of non-standard colors.
394me) as "pretty girly".
395 385
396 URxvt.cursorColor: #dc74d1 386 URxvt.cursorColor: #dc74d1
397 URxvt.pointerColor: #dc74d1 387 URxvt.pointerColor: #dc74d1
398 URxvt.background: #0e0e0e 388 URxvt.background: #0e0e0e
399 URxvt.foreground: #4ad5e1 389 URxvt.foreground: #4ad5e1
410 URxvt.color6: #73f7ff 400 URxvt.color6: #73f7ff
411 URxvt.color14: #73f7ff 401 URxvt.color14: #73f7ff
412 URxvt.color7: #e1dddd 402 URxvt.color7: #e1dddd
413 URxvt.color15: #e1dddd 403 URxvt.color15: #e1dddd
414 404
405They have been described (not by me) as "pretty girly".
406
415=head3 Why do some characters look so much different than others? 407=head3 Why do some characters look so much different than others?
416 408
417See next entry. 409See next entry.
418 410
419=head3 How does rxvt-unicode choose fonts? 411=head3 How does rxvt-unicode choose fonts?
420 412
421Most fonts do not contain the full range of Unicode, which is 413Most fonts do not contain the full range of Unicode, which is
422fine. Chances are that the font you (or the admin/package maintainer of 414fine. 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 415your system/os) have specified does not cover all the characters you want
424to display. 416to display.
425 417
426B<rxvt-unicode> makes a best-effort try at finding a replacement 418B<rxvt-unicode> makes a best-effort try at finding a replacement
427font. Often the result is fine, but sometimes the chosen font looks 419font. Often the result is fine, but sometimes the chosen font looks
428bad/ugly/wrong. Some fonts have totally strange characters that don't 420bad/ugly/wrong. Some fonts have totally strange characters that don't
429resemble the correct glyph at all, and rxvt-unicode lacks the artificial 421resemble the correct glyph at all, and rxvt-unicode lacks the artificial
430intelligence to detect that a specific glyph is wrong: it has to believe 422intelligence to detect that a specific glyph is wrong: it has to believe
431the font that the characters it claims to contain indeed look correct. 423the font that the characters it claims to contain indeed look correct.
432 424
433In that case, select a font of your taste and add it to the font list, 425In that case, select a font of your taste and add it to the font list,
434e.g.: 426e.g.:
435 427
436 @@RXVT_NAME@@ -fn basefont,font2,font3... 428 @@URXVT_NAME@@ -fn basefont,font2,font3...
437 429
438When rxvt-unicode sees a character, it will first look at the base 430When 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 431font. 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 432next 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. 433search and use less resources within rxvt-unicode and the X-server.
442 434
443The only limitation is that none of the fonts may be larger than the base 435The 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 436font, as the base font defines the terminal character cell size, which
445must be the same due to the way terminals work. 437must be the same due to the way terminals work.
446 438
439=head3 Why do some chinese characters look so different than others?
440
441This is because there is a difference between script and language --
442rxvt-unicode does not know which language the text that is output is,
443as it only knows the unicode character codes. If rxvt-unicode first
444sees a japanese/chinese character, it might choose a japanese font for
445display. Subsequent japanese characters will use that font. Now, many
446chinese characters aren't represented in japanese fonts, so when the first
447non-japanese character comes up, rxvt-unicode will look for a chinese font
448-- unfortunately at this point, it will still use the japanese font for
449chinese characters that are also in the japanese font.
450
451The workaround is easy: just tag a chinese font at the end of your font
452list (see the previous question). The key is to view the font list as
453a preference list: If you expect more japanese, list a japanese font
454first. If you expect more chinese, put a chinese font first.
455
456In the future it might be possible to switch language preferences at
457runtime (the internal data structure has no problem with using different
458fonts for the same character at the same time, but no interface for this
459has been designed yet).
460
461Until then, you might get away with switching fonts at runtime (see L<Can
462I switch the fonts at runtime?> later in this document).
463
464=head3 How can I make mplayer display video correctly?
465
466We are working on it, in the meantime, as a workaround, use something like:
467
468 @@URXVT_NAME@@ -b 600 -geometry 20x1 -e sh -c 'mplayer -wid $WINDOWID file...'
469
447 470
448=head2 Keyboard, Mouse & User Interaction 471=head2 Keyboard, Mouse & User Interaction
449 472
450=head3 The new selection selects pieces that are too big, how can I select single words? 473=head3 The new selection selects pieces that are too big, how can I select single words?
451 474
470B<perl-ext-common> resource to the empty string, which also keeps 493B<perl-ext-common> resource to the empty string, which also keeps
471rxvt-unicode from initialising perl, saving memory. 494rxvt-unicode from initialising perl, saving memory.
472 495
473If you only want to disable specific features, you first have to 496If you only want to disable specific features, you first have to
474identify which perl extension is responsible. For this, read the section 497identify which perl extension is responsible. For this, read the section
475B<PREPACKAGED EXTENSIONS> in the @@RXVT_NAME@@perl(3) manpage. For 498B<PREPACKAGED EXTENSIONS> in the @@URXVT_NAME@@perl(3) manpage. For
476example, to disable the B<selection-popup> and B<option-popup>, specify 499example, to disable the B<selection-popup> and B<option-popup>, specify
477this B<perl-ext-common> resource: 500this B<perl-ext-common> resource:
478 501
479 URxvt.perl-ext-common: default,-selection-popup,-option-popup 502 URxvt.perl-ext-common: default,-selection-popup,-option-popup
480 503
495circumstances, it will move your cursor around when you click into the 518circumstances, 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, 519line 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 520but when running a program that doesn't parse cursor movements or in some
498cases during rlogin sessions, it fails to detect this properly. 521cases during rlogin sessions, it fails to detect this properly.
499 522
500You can permamently switch this feature off by disabling the C<readline> 523You can permanently switch this feature off by disabling the C<readline>
501extension: 524extension:
502 525
503 URxvt.perl-ext-common: default,-readline 526 URxvt.perl-ext-common: default,-readline
504 527
505=head3 My numerical keypad acts weird and generates differing output? 528=head3 My numerical keypad acts weird and generates differing output?
506 529
507Some Debian GNUL/Linux users seem to have this problem, although no 530Some Debian GNUL/Linux users seem to have this problem, although no
508specific details were reported so far. It is possible that this is caused 531specific 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 532by 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 533this 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 534keymap. See the answer to the previous question, and please report if that
512helped. 535helped.
513 536
514=head3 My Compose (Multi_key) key is no longer working. 537=head3 My Compose (Multi_key) key is no longer working.
540depressed. 563depressed.
541 564
542=head3 What's with the strange Backspace/Delete key behaviour? 565=head3 What's with the strange Backspace/Delete key behaviour?
543 566
544Assuming that the physical Backspace key corresponds to the 567Assuming that the physical Backspace key corresponds to the
545BackSpace keysym (not likely for Linux ... see the following 568Backspace keysym (not likely for Linux ... see the following
546question) there are two standard values that can be used for 569question) there are two standard values that can be used for
547Backspace: C<^H> and C<^?>. 570Backspace: C<^H> and C<^?>.
548 571
549Historically, either value is correct, but rxvt-unicode adopts the debian 572Historically, either value is correct, but rxvt-unicode adopts the debian
550policy of using C<^?> when unsure, because it's the one only only correct 573policy of using C<^?> when unsure, because it's the one and only correct
551choice :). 574choice :).
552 575
553Rxvt-unicode tries to inherit the current stty settings and uses the value 576Rxvt-unicode tries to inherit the current stty settings and uses the value
554of `erase' to guess the value for backspace. If rxvt-unicode wasn't 577of `erase' to guess the value for backspace. If rxvt-unicode wasn't
555started from a terminal (say, from a menu or by remote shell), then the 578started from a terminal (say, from a menu or by remote shell), then the
558 581
559For starting a new rxvt-unicode: 582For starting a new rxvt-unicode:
560 583
561 # use Backspace = ^H 584 # use Backspace = ^H
562 $ stty erase ^H 585 $ stty erase ^H
563 $ @@RXVT_NAME@@ 586 $ @@URXVT_NAME@@
564 587
565 # use Backspace = ^? 588 # use Backspace = ^?
566 $ stty erase ^? 589 $ stty erase ^?
567 $ @@RXVT_NAME@@ 590 $ @@URXVT_NAME@@
568 591
569Toggle with C<ESC [ 36 h> / C<ESC [ 36 l>. 592Toggle with C<ESC [ 36 h> / C<ESC [ 36 l>.
570 593
571For an existing rxvt-unicode: 594For an existing rxvt-unicode:
572 595
599 622
600There are some compile-time selections available via configure. Unless 623There are some compile-time selections available via configure. Unless
601you have run "configure" with the C<--disable-resources> option you can 624you have run "configure" with the C<--disable-resources> option you can
602use the `keysym' resource to alter the keystrings associated with keysyms. 625use the `keysym' resource to alter the keystrings associated with keysyms.
603 626
604Here's an example for a URxvt session started using C<@@RXVT_NAME@@ -name URxvt> 627Here's an example for a URxvt session started using C<@@URXVT_NAME@@ -name URxvt>
605 628
606 URxvt.keysym.Home: \033[1~ 629 URxvt.keysym.Home: \033[1~
607 URxvt.keysym.End: \033[4~ 630 URxvt.keysym.End: \033[4~
608 URxvt.keysym.C-apostrophe: \033<C-'> 631 URxvt.keysym.C-apostrophe: \033<C-'>
609 URxvt.keysym.C-slash: \033<C-/> 632 URxvt.keysym.C-slash: \033<C-/>
638Rather than have rxvt-unicode try to accommodate all the various possible 661Rather than have rxvt-unicode try to accommodate all the various possible
639keyboard mappings, it is better to use `xmodmap' to remap the keys as 662keyboard mappings, it is better to use `xmodmap' to remap the keys as
640required for your particular machine. 663required for your particular machine.
641 664
642 665
643
644=head2 Terminal Configuration 666=head2 Terminal Configuration
667
668=head3 Can I see a typical configuration?
669
670The default configuration tries to be xterm-like, which I don't like that
671much, but it's least surprise to regular users.
672
673As a rxvt or rxvt-unicode user, you are practically supposed to invest
674time into customising your terminal. To get you started, here is the
675author's .Xdefaults entries, with comments on what they do. It's certainly
676not I<typical>, but what's typical...
677
678 URxvt.cutchars: "()*,<>[]{}|'
679 URxvt.print-pipe: cat >/tmp/xxx
680
681These are just for testing stuff.
682
683 URxvt.imLocale: ja_JP.UTF-8
684 URxvt.preeditType: OnTheSpot,None
685
686This tells rxvt-unicode to use a special locale when communicating with
687the X Input Method, and also tells it to only use the OnTheSpot pre-edit
688type, which requires the C<xim-onthespot> perl extension but rewards me
689with correct-looking fonts.
690
691 URxvt.perl-lib: /root/lib/urxvt
692 URxvt.perl-ext-common: default,selection-autotransform,selection-pastebin,xim-onthespot,remote-clipboard
693 URxvt.selection.pattern-0: ( at .*? line \\d+)
694 URxvt.selection.pattern-1: ^(/[^:]+):\
695 URxvt.selection-autotransform.0: s/^([^:[:space:]]+):(\\d+):?$/:e \\Q$1\\E\\x0d:$2\\x0d/
696 URxvt.selection-autotransform.1: s/^ at (.*?) line (\\d+)$/:e \\Q$1\\E\\x0d:$2\\x0d/
697
698This is my perl configuration. The first two set the perl library
699directory and also tells urxvt to use a large number of extensions. I
700develop for myself mostly, so I actually use most of the extensions I
701write.
702
703The selection stuff mainly makes the selection perl-error-message aware
704and tells it to convert perl error messages into vi-commands to load the
705relevant file and go tot he error line number.
706
707 URxvt.scrollstyle: plain
708 URxvt.secondaryScroll: true
709
710As the documentation says: plain is the preferred scrollbar for the
711author. The C<secondaryScroll> configures urxvt to scroll in full-screen
712apps, like screen, so lines scrolled out of screen end up in urxvt's
713scrollback buffer.
714
715 URxvt.background: #000000
716 URxvt.foreground: gray90
717 URxvt.color7: gray90
718 URxvt.colorBD: #ffffff
719 URxvt.cursorColor: #e0e080
720 URxvt.throughColor: #8080f0
721 URxvt.highlightColor: #f0f0f0
722
723Some colours. Not sure which ones are being used or even non-defaults, but
724these are in my .Xdefaults. Most notably, they set foreground/background
725to light gray/black, and also make sure that the colour 7 matches the
726default foreground colour.
727
728 URxvt.underlineColor: yellow
729
730Another colour, makes underline lines look different. Sometimes hurts, but
731is mostly a nice effect.
732
733 URxvt.geometry: 154x36
734 URxvt.loginShell: false
735 URxvt.meta: ignore
736 URxvt.utmpInhibit: true
737
738Uh, well, should be mostly self-explanatory. By specifying some defaults
739manually, I can quickly switch them for testing.
740
741 URxvt.saveLines: 8192
742
743A large scrollback buffer is essential. Really.
744
745 URxvt.mapAlert: true
746
747The only case I use it is for my IRC window, which I like to keep
748iconified till people msg me (which beeps).
749
750 URxvt.visualBell: true
751
752The audible bell is often annoying, especially when in a crowd.
753
754 URxvt.insecure: true
755
756Please don't hack my mutt! Ooops...
757
758 URxvt.pastableTabs: false
759
760I once thought this is a great idea.
761
762 urxvt.font: 9x15bold,\
763 -misc-fixed-bold-r-normal--15-140-75-75-c-90-iso10646-1,\
764 -misc-fixed-medium-r-normal--15-140-75-75-c-90-iso10646-1, \
765 [codeset=JISX0208]xft:Kochi Gothic, \
766 xft:Bitstream Vera Sans Mono:autohint=true, \
767 xft:Code2000:antialias=false
768 urxvt.boldFont: -xos4-terminus-bold-r-normal--14-140-72-72-c-80-iso8859-15
769 urxvt.italicFont: xft:Bitstream Vera Sans Mono:italic:autohint=true
770 urxvt.boldItalicFont: xft:Bitstream Vera Sans Mono:bold:italic:autohint=true
771
772I wrote rxvt-unicode to be able to specify fonts exactly. So don't be
773overwhelmed. A special note: the C<9x15bold> mentioned above is actually
774the version from XFree-3.3, as XFree-4 replaced it by a totally different
775font (different glyphs for C<;> and many other harmless characters),
776while the second font is actually the C<9x15bold> from XFree4/XOrg. The
777bold version has less chars than the medium version, so I use it for rare
778characters, too. When editing sources with vim, I use italic for comments
779and other stuff, which looks quite good with Bitstream Vera anti-aliased.
780
781Terminus is a quite bad font (many very wrong glyphs), but for most of my
782purposes, it works, and gives a different look, as my normal (Non-bold)
783font is already bold, and I want to see a difference between bold and
784normal fonts.
785
786Please note that I used the C<urxvt> instance name and not the C<URxvt>
787class name. Thats because I use different configs for different purposes,
788for example, my IRC window is started with C<-name IRC>, and uses these
789defaults:
790
791 IRC*title: IRC
792 IRC*geometry: 87x12+535+542
793 IRC*saveLines: 0
794 IRC*mapAlert: true
795 IRC*font: suxuseuro
796 IRC*boldFont: suxuseuro
797 IRC*colorBD: white
798 IRC*keysym.M-C-1: command:\033]710;suxuseuro\007\033]711;suxuseuro\007
799 IRC*keysym.M-C-2: command:\033]710;9x15bold\007\033]711;9x15bold\007
800
801C<Alt-Shift-1> and C<Alt-Shift-2> switch between two different font
802sizes. C<suxuseuro> allows me to keep an eye (and actually read)
803stuff while keeping a very small window. If somebody pastes something
804complicated (e.g. japanese), I temporarily switch to a larger font.
805
806The above is all in my C<.Xdefaults> (I don't use C<.Xresources> nor
807C<xrdb>). I also have some resources in a separate C<.Xdefaults-hostname>
808file for different hosts, for example, on ym main desktop, I use:
809
810 URxvt.keysym.C-M-q: command:\033[3;5;5t
811 URxvt.keysym.C-M-y: command:\033[3;5;606t
812 URxvt.keysym.C-M-e: command:\033[3;1605;5t
813 URxvt.keysym.C-M-c: command:\033[3;1605;606t
814 URxvt.keysym.C-M-p: perl:test
815
816The first for keysym definitions allow me to quickly bring some windows
817in the layout I like most. Ion users might start laughing but will stop
818immediately when I tell them that I use my own Fvwm2 module for much the
819same effect as Ion provides, and I only very rarely use the above key
820combinations :->
645 821
646=head3 Why doesn't rxvt-unicode read my resources? 822=head3 Why doesn't rxvt-unicode read my resources?
647 823
648Well, why, indeed? It does, in a way very similar to other X 824Well, why, indeed? It does, in a way very similar to other X
649applications. Most importantly, this means that if you or your OS loads 825applications. Most importantly, this means that if you or your OS loads
658Also consider the form resources have to use: 834Also consider the form resources have to use:
659 835
660 URxvt.resource: value 836 URxvt.resource: value
661 837
662If you want to use another form (there are lots of different ways of 838If you want to use another form (there are lots of different ways of
663specifying resources), make sure you understand wether and why it 839specifying resources), make sure you understand whether and why it
664works. If unsure, use the form above. 840works. If unsure, use the form above.
665 841
666=head3 When I log-in to another system it tells me about missing terminfo data? 842=head3 When I log-in to another system it tells me about missing terminfo data?
667 843
668The terminal description used by rxvt-unicode is not as widely available 844The 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). 845as that for xterm, or even rxvt (for which the same problem often arises).
670 846
671The correct solution for this problem is to install the terminfo, this can 847The correct solution for this problem is to install the terminfo, this can
672be done like this (with ncurses' infocmp): 848be done like this (with ncurses' infocmp and works as user and admin):
673 849
674 REMOTE=remotesystem.domain 850 REMOTE=remotesystem.domain
675 infocmp rxvt-unicode | ssh $REMOTE "cat >/tmp/ti && tic /tmp/ti" 851 infocmp rxvt-unicode | ssh $REMOTE "mkdir -p .terminfo && cat >/tmp/ti && tic /tmp/ti"
676 852
677... or by installing rxvt-unicode normally on the remote system, 853... or by installing rxvt-unicode normally on the remote system,
854
855One some systems you might need to set C<$TERMINFO> to the full path of
856F<$HOME/.terminfo> for this to work.
678 857
679If you cannot or do not want to do this, then you can simply set 858If you cannot or do not want to do this, then you can simply set
680C<TERM=rxvt> or even C<TERM=xterm>, and live with the small number of 859C<TERM=rxvt> or even C<TERM=xterm>, and live with the small number of
681problems arising, which includes wrong keymapping, less and different 860problems arising, which includes wrong keymapping, less and different
682colours and some refresh errors in fullscreen applications. It's a nice 861colours and some refresh errors in fullscreen applications. It's a nice
687resource to set it: 866resource to set it:
688 867
689 URxvt.termName: rxvt 868 URxvt.termName: rxvt
690 869
691If you don't plan to use B<rxvt> (quite common...) you could also replace 870If you don't plan to use B<rxvt> (quite common...) you could also replace
692the rxvt terminfo file with the rxvt-unicode one. 871the rxvt terminfo file with the rxvt-unicode one and use C<TERM=rxvt>.
693 872
694=head3 C<tic> outputs some error when compiling the terminfo entry. 873=head3 C<tic> outputs some error when compiling the terminfo entry.
695 874
696Most likely it's the empty definition for C<enacs=>. Just replace it by 875Most likely it's the empty definition for C<enacs=>. Just replace it by
697C<enacs=\E[0@> and try again. 876C<enacs=\E[0@> and try again.
698 877
699=head3 C<bash>'s readline does not work correctly under @@RXVT_NAME@@. 878=head3 C<bash>'s readline does not work correctly under @@URXVT_NAME@@.
700 879
701See next entry. 880See next entry.
702 881
703=head3 I need a termcap file entry. 882=head3 I need a termcap file entry.
704 883
705One reason you might want this is that some distributions or operating 884One reason you might want this is that some distributions or operating
706systems still compile some programs using the long-obsoleted termcap 885systems still compile some programs using the long-obsoleted termcap
707library (Fedora Core's bash is one example) and rely on a termcap entry 886library (Fedora Core's bash is one example) and rely on a termcap entry
708for C<rxvt-unicode>. 887for C<rxvt-unicode>.
709 888
710You could use rxvt's termcap entry with resonable results in many cases. 889You could use rxvt's termcap entry with reasonable results in many cases.
711You can also create a termcap entry by using terminfo's infocmp program 890You can also create a termcap entry by using terminfo's infocmp program
712like this: 891like this:
713 892
714 infocmp -C rxvt-unicode 893 infocmp -C rxvt-unicode
715 894
737 :vs=\E[?25h: 916 :vs=\E[?25h:
738 917
739=head3 Why does C<ls> no longer have coloured output? 918=head3 Why does C<ls> no longer have coloured output?
740 919
741The C<ls> in the GNU coreutils unfortunately doesn't use terminfo to 920The C<ls> in the GNU coreutils unfortunately doesn't use terminfo to
742decide wether a terminal has colour, but uses it's own configuration 921decide 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 922file. Needless to say, C<rxvt-unicode> is not in its default file (among
744with most other terminals supporting colour). Either add: 923with most other terminals supporting colour). Either add:
745 924
746 TERM rxvt-unicode 925 TERM rxvt-unicode
747 926
748to C</etc/DIR_COLORS> or simply add: 927to C</etc/DIR_COLORS> or simply add:
782If you encounter strange problems like typing an accented character but 961If you encounter strange problems like typing an accented character but
783getting two unrelated other characters or similar, or if program output is 962getting two unrelated other characters or similar, or if program output is
784subtly garbled, then you should check your locale settings. 963subtly garbled, then you should check your locale settings.
785 964
786Rxvt-unicode must be started with the same C<LC_CTYPE> setting as the 965Rxvt-unicode must be started with the same C<LC_CTYPE> setting as the
787programs. Often rxvt-unicode is started in the C<C> locale, while the 966programs running in it. Often rxvt-unicode is started in the C<C> locale,
788login script running within the rxvt-unicode window changes the locale to 967while 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. 968locale to something else, e.g. C<en_GB.UTF-8>. Needless to say, this is
969not going to work, and is the most common cause for problems.
790 970
791The best thing is to fix your startup environment, as you will likely run 971The best thing is to fix your startup environment, as you will likely run
792into other problems. If nothing works you can try this in your .profile. 972into other problems. If nothing works you can try this in your .profile.
793 973
794 printf '\e]701;%s\007' "$LC_CTYPE" 974 printf '\33]701;%s\007' "$LC_CTYPE" # $LANG or $LC_ALL are worth a try, too
795 975
796If this doesn't work, then maybe you use a C<LC_CTYPE> specification not 976If this doesn't work, then maybe you use a C<LC_CTYPE> specification not
797supported on your systems. Some systems have a C<locale> command which 977supported 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 978displays 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 979it 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 1000The reasons is that there exists a perfectly fine mechanism for selecting
821the encoding, doing I/O and (most important) communicating this to all 1001the encoding, doing I/O and (most important) communicating this to all
822applications so everybody agrees on character properties such as width 1002applications so everybody agrees on character properties such as width
823and code number. This mechanism is the I<locale>. Applications not using 1003and code number. This mechanism is the I<locale>. Applications not using
824that info will have problems (for example, C<xterm> gets the width of 1004that 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 1005characters wrong as it uses its own, locale-independent table under all
826locales). 1006locales).
827 1007
828Rxvt-unicode uses the C<LC_CTYPE> locale category to select encoding. All 1008Rxvt-unicode uses the C<LC_CTYPE> locale category to select encoding. All
829programs doing the same (that is, most) will automatically agree in the 1009programs doing the same (that is, most) will automatically agree in the
830interpretation of characters. 1010interpretation of characters.
849=head3 Can I switch locales at runtime? 1029=head3 Can I switch locales at runtime?
850 1030
851Yes, using an escape sequence. Try something like this, which sets 1031Yes, using an escape sequence. Try something like this, which sets
852rxvt-unicode's idea of C<LC_CTYPE>. 1032rxvt-unicode's idea of C<LC_CTYPE>.
853 1033
854 printf '\e]701;%s\007' ja_JP.SJIS 1034 printf '\33]701;%s\007' ja_JP.SJIS
855 1035
856See also the previous answer. 1036See also the previous answer.
857 1037
858Sometimes this capability is rather handy when you want to work in 1038Sometimes 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 1039one 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 1040(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: 1041first switches to a locale supported by xjdic and back later:
862 1042
863 printf '\e]701;%s\007' ja_JP.SJIS 1043 printf '\33]701;%s\007' ja_JP.SJIS
864 xjdic -js 1044 xjdic -js
865 printf '\e]701;%s\007' de_DE.UTF-8 1045 printf '\33]701;%s\007' de_DE.UTF-8
866 1046
867You can also use xterm's C<luit> program, which usually works fine, except 1047You can also use xterm's C<luit> program, which usually works fine, except
868for some locales where character width differs between program- and 1048for some locales where character width differs between program- and
869rxvt-unicode-locales. 1049rxvt-unicode-locales.
870 1050
1051=head3 I have problems getting my input method working.
1052
1053Try a search engine, as this is slightly different for every input method server.
1054
1055Here is a checklist:
1056
1057=over 4
1058
1059=item - Make sure your locale I<and> the imLocale are supported on your OS.
1060
1061Try C<locale -a> or check the documentation for your OS.
1062
1063=item - Make sure your locale or imLocale matches a locale supported by your XIM.
1064
1065For example, B<kinput2> does not support UTF-8 locales, you should use
1066C<ja_JP.EUC-JP> or equivalent.
1067
1068=item - Make sure your XIM server is actually running.
1069
1070=item - Make sure the C<XMODIFIERS> environment variable is set correctly when I<starting> rxvt-unicode.
1071
1072When you want to use e.g. B<kinput2>, it must be set to
1073C<@im=kinput2>. For B<scim>, use C<@im=SCIM>. You can see what input
1074method servers are running with this command:
1075
1076 xprop -root XIM_SERVERS
1077
1078=item
1079
1080=back
1081
871=head3 My input method wants <some encoding> but I want UTF-8, what can I do? 1082=head3 My input method wants <some encoding> but I want UTF-8, what can I do?
872 1083
873You can specify separate locales for the input method and the rest of the 1084You can specify separate locales for the input method and the rest of the
874terminal, using the resource C<imlocale>: 1085terminal, using the resource C<imlocale>:
875 1086
876 URxvt.imlocale: ja_JP.EUC-JP 1087 URxvt.imlocale: ja_JP.EUC-JP
877 1088
878Now you can start your terminal with C<LC_CTYPE=ja_JP.UTF-8> and still 1089Now 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 1090use 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 1091version, you may not be able to input characters outside C<EUC-JP> in a
881method limits you. 1092normal way then, as your input method limits you.
882 1093
883=head3 Rxvt-unicode crashes when the X Input Method changes or exits. 1094=head3 Rxvt-unicode crashes when the X Input Method changes or exits.
884 1095
885Unfortunately, this is unavoidable, as the XIM protocol is racy by 1096Unfortunately, this is unavoidable, as the XIM protocol is racy by
886design. Applications can avoid some crashes at the expense of memory 1097design. Applications can avoid some crashes at the expense of memory
912 1123
913=head3 I am maintaining rxvt-unicode for distribution/OS XXX, any recommendation? 1124=head3 I am maintaining rxvt-unicode for distribution/OS XXX, any recommendation?
914 1125
915You should build one binary with the default options. F<configure> 1126You should build one binary with the default options. F<configure>
916now enables most useful options, and the trend goes to making them 1127now enables most useful options, and the trend goes to making them
917runtime-switchable, too, so there is usually no drawback to enbaling them, 1128runtime-switchable, too, so there is usually no drawback to enabling them,
918except higher disk and possibly memory usage. The perl interpreter should 1129except higher disk and possibly memory usage. The perl interpreter should
919be enabled, as important functionality (menus, selection, likely more in 1130be enabled, as important functionality (menus, selection, likely more in
920the future) depends on it. 1131the future) depends on it.
921 1132
922You should not overwrite the C<perl-ext-common> snd C<perl-ext> resources 1133You should not overwrite the C<perl-ext-common> snd C<perl-ext> resources
945This forking is done as the very first within main(), which is very early 1156This forking is done as the very first within main(), which is very early
946and reduces possible bugs to initialisation code run before main(), or 1157and reduces possible bugs to initialisation code run before main(), or
947things like the dynamic loader of your system, which should result in very 1158things like the dynamic loader of your system, which should result in very
948little risk. 1159little risk.
949 1160
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. 1161=head3 I am on FreeBSD and rxvt-unicode does not seem to work at all.
959 1162
960Rxvt-unicode requires the symbol C<__STDC_ISO_10646__> to be defined 1163Rxvt-unicode requires the symbol C<__STDC_ISO_10646__> to be defined
961in your compile environment, or an implementation that implements it, 1164in your compile environment, or an implementation that implements it,
962wether it defines the symbol or not. C<__STDC_ISO_10646__> requires that 1165whether it defines the symbol or not. C<__STDC_ISO_10646__> requires that
963B<wchar_t> is represented as unicode. 1166B<wchar_t> is represented as unicode.
964 1167
965As you might have guessed, FreeBSD does neither define this symobl nor 1168As you might have guessed, FreeBSD does neither define this symbol nor
966does it support it. Instead, it uses it's own internal representation of 1169does it support it. Instead, it uses its own internal representation of
967B<wchar_t>. This is, of course, completely fine with respect to standards. 1170B<wchar_t>. This is, of course, completely fine with respect to standards.
968 1171
969However, that means rxvt-unicode only works in C<POSIX>, C<ISO-8859-1> and 1172However, that means rxvt-unicode only works in C<POSIX>, C<ISO-8859-1> and
970C<UTF-8> locales under FreeBSD (which all use Unicode as B<wchar_t>. 1173C<UTF-8> locales under FreeBSD (which all use Unicode as B<wchar_t>.
971 1174
985 1188
986The rxvt-unicode author insists that the right way to fix this is in the 1189The rxvt-unicode author insists that the right way to fix this is in the
987system libraries once and for all, instead of forcing every app to carry 1190system libraries once and for all, instead of forcing every app to carry
988complete replacements for them :) 1191complete replacements for them :)
989 1192
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? 1193=head3 How can I use rxvt-unicode under cygwin?
996 1194
997rxvt-unicode should compile and run out of the box on cygwin, using 1195rxvt-unicode should compile and run out of the box on cygwin, using
998the X11 libraries that come with cygwin. libW11 emulation is no 1196the X11 libraries that come with cygwin. libW11 emulation is no
999longer supported (and makes no sense, either, as it only supported a 1197longer supported (and makes no sense, either, as it only supported a
1003 1201
1004At the time of this writing, cygwin didn't seem to support any multi-byte 1202At the time of this writing, cygwin didn't seem to support any multi-byte
1005encodings (you might try C<LC_CTYPE=C-UTF-8>), so you are likely limited 1203encodings (you might try C<LC_CTYPE=C-UTF-8>), so you are likely limited
1006to 8-bit encodings. 1204to 8-bit encodings.
1007 1205
1206=head3 Character widths are not correct.
1207
1208urxvt uses the system wcwidth function to know the information about
1209the width of characters, so on systems with incorrect locale data you
1210will likely get bad results. Two notorious examples are Solaris 9,
1211where single-width characters like U+2514 are reported as double-width,
1212and Darwin 8, where combining chars are reported having width 1.
1213
1214The solution is to upgrade your system or switch to a better one. A
1215possibly working workaround is to use a wcwidth implementation like
1216
1217http://www.cl.cam.ac.uk/~mgk25/ucs/wcwidth.c
1218
1008=head1 RXVT TECHNICAL REFERENCE 1219=head1 RXVT-UNICODE TECHNICAL REFERENCE
1009
1010=head1 DESCRIPTION
1011 1220
1012The rest of this document describes various technical aspects of 1221The rest of this document describes various technical aspects of
1013B<rxvt-unicode>. First the description of supported command sequences, 1222B<rxvt-unicode>. First the description of supported command sequences,
1014followed by pixmap support and last by a description of all features 1223followed by pixmap support and last by a description of all features
1015selectable at C<configure> time. 1224selectable at C<configure> time.
1016 1225
1017=head1 Definitions 1226=head2 Definitions
1018 1227
1019=over 4 1228=over 4
1020 1229
1021=item B<< C<c> >> 1230=item B<< C<c> >>
1022 1231
1040 1249
1041A text parameter composed of printable characters. 1250A text parameter composed of printable characters.
1042 1251
1043=back 1252=back
1044 1253
1045=head1 Values 1254=head2 Values
1046 1255
1047=over 4 1256=over 4
1048 1257
1049=item B<< C<ENQ> >> 1258=item B<< C<ENQ> >>
1050 1259
1093 1302
1094Space Character 1303Space Character
1095 1304
1096=back 1305=back
1097 1306
1098=head1 Escape Sequences 1307=head2 Escape Sequences
1099 1308
1100=over 4 1309=over 4
1101 1310
1102=item B<< C<ESC # 8> >> 1311=item B<< C<ESC # 8> >>
1103 1312
1201 1410
1202=back 1411=back
1203 1412
1204X<CSI> 1413X<CSI>
1205 1414
1206=head1 CSI (Command Sequence Introducer) Sequences 1415=head2 CSI (Command Sequence Introducer) Sequences
1207 1416
1208=over 4 1417=over 4
1209 1418
1210=item B<< C<ESC [ Ps @> >> 1419=item B<< C<ESC [ Ps @> >>
1211 1420
1481 1690
1482=back 1691=back
1483 1692
1484X<PrivateModes> 1693X<PrivateModes>
1485 1694
1486=head1 DEC Private Modes 1695=head2 DEC Private Modes
1487 1696
1488=over 4 1697=over 4
1489 1698
1490=item B<< C<ESC [ ? Pm h> >> 1699=item B<< C<ESC [ ? Pm h> >>
1491 1700
1507 1716
1508Toggle DEC Private Mode Values (rxvt extension). I<where> 1717Toggle DEC Private Mode Values (rxvt extension). I<where>
1509 1718
1510=over 4 1719=over 4
1511 1720
1512=item B<< C<Ps = 1> >> (DECCKM) 1721=item B<< C<Pm = 1> >> (DECCKM)
1513 1722
1514=begin table 1723=begin table
1515 1724
1516 B<< C<h> >> Application Cursor Keys 1725 B<< C<h> >> Application Cursor Keys
1517 B<< C<l> >> Normal Cursor Keys 1726 B<< C<l> >> Normal Cursor Keys
1518 1727
1519=end table 1728=end table
1520 1729
1521=item B<< C<Ps = 2> >> (ANSI/VT52 mode) 1730=item B<< C<Pm = 2> >> (ANSI/VT52 mode)
1522 1731
1523=begin table 1732=begin table
1524 1733
1525 B<< C<h> >> Enter VT52 mode 1734 B<< C<h> >> Enter VT52 mode
1526 B<< C<l> >> Enter VT52 mode 1735 B<< C<l> >> Enter VT52 mode
1527 1736
1528=end table 1737=end table
1529 1738
1530=item B<< C<Ps = 3> >> 1739=item B<< C<Pm = 3> >>
1531 1740
1532=begin table 1741=begin table
1533 1742
1534 B<< C<h> >> 132 Column Mode (DECCOLM) 1743 B<< C<h> >> 132 Column Mode (DECCOLM)
1535 B<< C<l> >> 80 Column Mode (DECCOLM) 1744 B<< C<l> >> 80 Column Mode (DECCOLM)
1536 1745
1537=end table 1746=end table
1538 1747
1539=item B<< C<Ps = 4> >> 1748=item B<< C<Pm = 4> >>
1540 1749
1541=begin table 1750=begin table
1542 1751
1543 B<< C<h> >> Smooth (Slow) Scroll (DECSCLM) 1752 B<< C<h> >> Smooth (Slow) Scroll (DECSCLM)
1544 B<< C<l> >> Jump (Fast) Scroll (DECSCLM) 1753 B<< C<l> >> Jump (Fast) Scroll (DECSCLM)
1545 1754
1546=end table 1755=end table
1547 1756
1548=item B<< C<Ps = 5> >> 1757=item B<< C<Pm = 5> >>
1549 1758
1550=begin table 1759=begin table
1551 1760
1552 B<< C<h> >> Reverse Video (DECSCNM) 1761 B<< C<h> >> Reverse Video (DECSCNM)
1553 B<< C<l> >> Normal Video (DECSCNM) 1762 B<< C<l> >> Normal Video (DECSCNM)
1554 1763
1555=end table 1764=end table
1556 1765
1557=item B<< C<Ps = 6> >> 1766=item B<< C<Pm = 6> >>
1558 1767
1559=begin table 1768=begin table
1560 1769
1561 B<< C<h> >> Origin Mode (DECOM) 1770 B<< C<h> >> Origin Mode (DECOM)
1562 B<< C<l> >> Normal Cursor Mode (DECOM) 1771 B<< C<l> >> Normal Cursor Mode (DECOM)
1563 1772
1564=end table 1773=end table
1565 1774
1566=item B<< C<Ps = 7> >> 1775=item B<< C<Pm = 7> >>
1567 1776
1568=begin table 1777=begin table
1569 1778
1570 B<< C<h> >> Wraparound Mode (DECAWM) 1779 B<< C<h> >> Wraparound Mode (DECAWM)
1571 B<< C<l> >> No Wraparound Mode (DECAWM) 1780 B<< C<l> >> No Wraparound Mode (DECAWM)
1572 1781
1573=end table 1782=end table
1574 1783
1575=item B<< C<Ps = 8> >> I<unimplemented> 1784=item B<< C<Pm = 8> >> I<unimplemented>
1576 1785
1577=begin table 1786=begin table
1578 1787
1579 B<< C<h> >> Auto-repeat Keys (DECARM) 1788 B<< C<h> >> Auto-repeat Keys (DECARM)
1580 B<< C<l> >> No Auto-repeat Keys (DECARM) 1789 B<< C<l> >> No Auto-repeat Keys (DECARM)
1581 1790
1582=end table 1791=end table
1583 1792
1584=item B<< C<Ps = 9> >> X10 XTerm 1793=item B<< C<Pm = 9> >> X10 XTerm
1585 1794
1586=begin table 1795=begin table
1587 1796
1588 B<< C<h> >> Send Mouse X & Y on button press. 1797 B<< C<h> >> Send Mouse X & Y on button press.
1589 B<< C<l> >> No mouse reporting. 1798 B<< C<l> >> No mouse reporting.
1590 1799
1591=end table 1800=end table
1592 1801
1593=item B<< C<Ps = 25> >> 1802=item B<< C<Pm = 25> >>
1594 1803
1595=begin table 1804=begin table
1596 1805
1597 B<< C<h> >> Visible cursor {cnorm/cvvis} 1806 B<< C<h> >> Visible cursor {cnorm/cvvis}
1598 B<< C<l> >> Invisible cursor {civis} 1807 B<< C<l> >> Invisible cursor {civis}
1599 1808
1600=end table 1809=end table
1601 1810
1602=item B<< C<Ps = 30> >> 1811=item B<< C<Pm = 30> >>
1603 1812
1604=begin table 1813=begin table
1605 1814
1606 B<< C<h> >> scrollBar visisble 1815 B<< C<h> >> scrollBar visisble
1607 B<< C<l> >> scrollBar invisisble 1816 B<< C<l> >> scrollBar invisisble
1608 1817
1609=end table 1818=end table
1610 1819
1611=item B<< C<Ps = 35> >> (B<rxvt>) 1820=item B<< C<Pm = 35> >> (B<rxvt>)
1612 1821
1613=begin table 1822=begin table
1614 1823
1615 B<< C<h> >> Allow XTerm Shift+key sequences 1824 B<< C<h> >> Allow XTerm Shift+key sequences
1616 B<< C<l> >> Disallow XTerm Shift+key sequences 1825 B<< C<l> >> Disallow XTerm Shift+key sequences
1617 1826
1618=end table 1827=end table
1619 1828
1620=item B<< C<Ps = 38> >> I<unimplemented> 1829=item B<< C<Pm = 38> >> I<unimplemented>
1621 1830
1622Enter Tektronix Mode (DECTEK) 1831Enter Tektronix Mode (DECTEK)
1623 1832
1624=item B<< C<Ps = 40> >> 1833=item B<< C<Pm = 40> >>
1625 1834
1626=begin table 1835=begin table
1627 1836
1628 B<< C<h> >> Allow 80/132 Mode 1837 B<< C<h> >> Allow 80/132 Mode
1629 B<< C<l> >> Disallow 80/132 Mode 1838 B<< C<l> >> Disallow 80/132 Mode
1630 1839
1631=end table 1840=end table
1632 1841
1633=item B<< C<Ps = 44> >> I<unimplemented> 1842=item B<< C<Pm = 44> >> I<unimplemented>
1634 1843
1635=begin table 1844=begin table
1636 1845
1637 B<< C<h> >> Turn On Margin Bell 1846 B<< C<h> >> Turn On Margin Bell
1638 B<< C<l> >> Turn Off Margin Bell 1847 B<< C<l> >> Turn Off Margin Bell
1639 1848
1640=end table 1849=end table
1641 1850
1642=item B<< C<Ps = 45> >> I<unimplemented> 1851=item B<< C<Pm = 45> >> I<unimplemented>
1643 1852
1644=begin table 1853=begin table
1645 1854
1646 B<< C<h> >> Reverse-wraparound Mode 1855 B<< C<h> >> Reverse-wraparound Mode
1647 B<< C<l> >> No Reverse-wraparound Mode 1856 B<< C<l> >> No Reverse-wraparound Mode
1648 1857
1649=end table 1858=end table
1650 1859
1651=item B<< C<Ps = 46> >> I<unimplemented> 1860=item B<< C<Pm = 46> >> I<unimplemented>
1652 1861
1653=item B<< C<Ps = 47> >> 1862=item B<< C<Pm = 47> >>
1654 1863
1655=begin table 1864=begin table
1656 1865
1657 B<< C<h> >> Use Alternate Screen Buffer 1866 B<< C<h> >> Use Alternate Screen Buffer
1658 B<< C<l> >> Use Normal Screen Buffer 1867 B<< C<l> >> Use Normal Screen Buffer
1659 1868
1660=end table 1869=end table
1661 1870
1662X<Priv66> 1871X<Priv66>
1663 1872
1664=item B<< C<Ps = 66> >> 1873=item B<< C<Pm = 66> >>
1665 1874
1666=begin table 1875=begin table
1667 1876
1668 B<< C<h> >> Application Keypad (DECPAM) == C<ESC => 1877 B<< C<h> >> Application Keypad (DECPAM) == C<ESC =>
1669 B<< C<l> >> Normal Keypad (DECPNM) == C<< ESC > >> 1878 B<< C<l> >> Normal Keypad (DECPNM) == C<< ESC > >>
1670 1879
1671=end table 1880=end table
1672 1881
1673=item B<< C<Ps = 67> >> 1882=item B<< C<Pm = 67> >>
1674 1883
1675=begin table 1884=begin table
1676 1885
1677 B<< C<h> >> Backspace key sends B<< C<BS> (DECBKM) >> 1886 B<< C<h> >> Backspace key sends B<< C<BS> (DECBKM) >>
1678 B<< C<l> >> Backspace key sends B<< C<DEL> >> 1887 B<< C<l> >> Backspace key sends B<< C<DEL> >>
1679 1888
1680=end table 1889=end table
1681 1890
1682=item B<< C<Ps = 1000> >> (X11 XTerm) 1891=item B<< C<Pm = 1000> >> (X11 XTerm)
1683 1892
1684=begin table 1893=begin table
1685 1894
1686 B<< C<h> >> Send Mouse X & Y on button press and release. 1895 B<< C<h> >> Send Mouse X & Y on button press and release.
1687 B<< C<l> >> No mouse reporting. 1896 B<< C<l> >> No mouse reporting.
1688 1897
1689=end table 1898=end table
1690 1899
1691=item B<< C<Ps = 1001> >> (X11 XTerm) I<unimplemented> 1900=item B<< C<Pm = 1001> >> (X11 XTerm) I<unimplemented>
1692 1901
1693=begin table 1902=begin table
1694 1903
1695 B<< C<h> >> Use Hilite Mouse Tracking. 1904 B<< C<h> >> Use Hilite Mouse Tracking.
1696 B<< C<l> >> No mouse reporting. 1905 B<< C<l> >> No mouse reporting.
1697 1906
1698=end table 1907=end table
1699 1908
1909=item B<< C<Pm = 1002> >> (X11 XTerm)
1910
1911=begin table
1912
1913 B<< C<h> >> Send Mouse X & Y on button press and release, and motion with a button pressed.
1914 B<< C<l> >> No mouse reporting.
1915
1916=end table
1917
1918=item B<< C<Pm = 1003> >> (X11 XTerm)
1919
1920=begin table
1921
1922 B<< C<h> >> Send Mouse X & Y on button press and release, and motion.
1923 B<< C<l> >> No mouse reporting.
1924
1925=end table
1926
1700=item B<< C<Ps = 1010> >> (B<rxvt>) 1927=item B<< C<Pm = 1010> >> (B<rxvt>)
1701 1928
1702=begin table 1929=begin table
1703 1930
1704 B<< C<h> >> Don't scroll to bottom on TTY output 1931 B<< C<h> >> Don't scroll to bottom on TTY output
1705 B<< C<l> >> Scroll to bottom on TTY output 1932 B<< C<l> >> Scroll to bottom on TTY output
1706 1933
1707=end table 1934=end table
1708 1935
1709=item B<< C<Ps = 1011> >> (B<rxvt>) 1936=item B<< C<Pm = 1011> >> (B<rxvt>)
1710 1937
1711=begin table 1938=begin table
1712 1939
1713 B<< C<h> >> Scroll to bottom when a key is pressed 1940 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 1941 B<< C<l> >> Don't scroll to bottom when a key is pressed
1715 1942
1716=end table 1943=end table
1717 1944
1718=item B<< C<Ps = 1021> >> (B<rxvt>) 1945=item B<< C<Pm = 1021> >> (B<rxvt>)
1719 1946
1720=begin table 1947=begin table
1721 1948
1722 B<< C<h> >> Bold/italic implies high intensity (see option B<-is>) 1949 B<< C<h> >> Bold/italic implies high intensity (see option B<-is>)
1723 B<< C<l> >> Font styles have no effect on intensity (Compile styles) 1950 B<< C<l> >> Font styles have no effect on intensity (Compile styles)
1724 1951
1725=end table 1952=end table
1726 1953
1727=item B<< C<Ps = 1047> >> 1954=item B<< C<Pm = 1047> >>
1728 1955
1729=begin table 1956=begin table
1730 1957
1731 B<< C<h> >> Use Alternate Screen Buffer 1958 B<< C<h> >> Use Alternate Screen Buffer
1732 B<< C<l> >> Use Normal Screen Buffer - clear Alternate Screen Buffer if returning from it 1959 B<< C<l> >> Use Normal Screen Buffer - clear Alternate Screen Buffer if returning from it
1733 1960
1734=end table 1961=end table
1735 1962
1736=item B<< C<Ps = 1048> >> 1963=item B<< C<Pm = 1048> >>
1737 1964
1738=begin table 1965=begin table
1739 1966
1740 B<< C<h> >> Save cursor position 1967 B<< C<h> >> Save cursor position
1741 B<< C<l> >> Restore cursor position 1968 B<< C<l> >> Restore cursor position
1742 1969
1743=end table 1970=end table
1744 1971
1745=item B<< C<Ps = 1049> >> 1972=item B<< C<Pm = 1049> >>
1746 1973
1747=begin table 1974=begin table
1748 1975
1749 B<< C<h> >> Use Alternate Screen Buffer - clear Alternate Screen Buffer if switching to it 1976 B<< C<h> >> Use Alternate Screen Buffer - clear Alternate Screen Buffer if switching to it
1750 B<< C<l> >> Use Normal Screen Buffer 1977 B<< C<l> >> Use Normal Screen Buffer
1755 1982
1756=back 1983=back
1757 1984
1758X<XTerm> 1985X<XTerm>
1759 1986
1760=head1 XTerm Operating System Commands 1987=head2 XTerm Operating System Commands
1761 1988
1762=over 4 1989=over 4
1763 1990
1764=item B<< C<ESC ] Ps;Pt ST> >> 1991=item B<< C<ESC ] Ps;Pt ST> >>
1765 1992
1779 B<< C<Ps = 12> >> Change colour of text cursor foreground to B<< C<Pt> >> 2006 B<< C<Ps = 12> >> Change colour of text cursor foreground to B<< C<Pt> >>
1780 B<< C<Ps = 13> >> Change colour of mouse foreground to B<< C<Pt> >> 2007 B<< C<Ps = 13> >> Change colour of mouse foreground to B<< C<Pt> >>
1781 B<< C<Ps = 17> >> Change colour of highlight characters to B<< C<Pt> >> 2008 B<< C<Ps = 17> >> Change colour of highlight characters to B<< C<Pt> >>
1782 B<< C<Ps = 18> >> Change colour of bold characters to B<< C<Pt> >> [deprecated, see 706] 2009 B<< C<Ps = 18> >> Change colour of bold characters to B<< C<Pt> >> [deprecated, see 706]
1783 B<< C<Ps = 19> >> Change colour of underlined characters to B<< C<Pt> >> [deprecated, see 707] 2010 B<< C<Ps = 19> >> Change colour of underlined characters to B<< C<Pt> >> [deprecated, see 707]
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).
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> >>.
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> >>.
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> >>
1803 2030
1804=end table 2031=end table
1805 2032
1806=back 2033=back
1807 2034
1808X<XPM> 2035=head1 BACKGROUND IMAGE
1809 2036
1810=head1 XPM
1811
1812For the XPM XTerm escape sequence B<< C<ESC ] 20 ; Pt ST> >> then value 2037For the BACGROUND IMAGE XTerm escape sequence B<< C<ESC ] 20 ; Pt ST> >> then value
1813of B<< C<Pt> >> can be the name of the background pixmap followed by a 2038of B<< C<Pt> >> can be the name of the background image file followed by a
1814sequence of scaling/positioning commands separated by semi-colons. The 2039sequence of scaling/positioning commands separated by semi-colons. The
1815scaling/positioning commands are as follows: 2040scaling/positioning commands are as follows:
1816 2041
1817=over 4 2042=over 4
1818 2043
1856 2081
1857For example: 2082For example:
1858 2083
1859=over 4 2084=over 4
1860 2085
1861=item B<\E]20;funky\a> 2086=item B<\E]20;funky.jpg\a>
1862 2087
1863load B<funky.xpm> as a tiled image 2088load B<funky.jpg> as a tiled image
1864 2089
1865=item B<\E]20;mona;100\a> 2090=item B<\E]20;mona.jpg;100\a>
1866 2091
1867load B<mona.xpm> with a scaling of 100% 2092load B<mona.jpg> with a scaling of 100%
1868 2093
1869=item B<\E]20;;200;?\a> 2094=item B<\E]20;;200;?\a>
1870 2095
1871rescale the current pixmap to 200% and display the image geometry in 2096rescale the current pixmap to 200% and display the image geometry in
1872the title 2097the title
1911=begin table 2136=begin table
1912 2137
1913 4 Shift 2138 4 Shift
1914 8 Meta 2139 8 Meta
1915 16 Control 2140 16 Control
1916 32 Double Click I<(Rxvt extension)> 2141 32 Double Click I<(rxvt extension)>
1917 2142
1918=end table 2143=end table
1919 2144
1920Col = B<< C<< <x> - SPACE >> >> 2145Col = B<< C<< <x> - SPACE >> >>
1921 2146
1999 2224
2000=head1 CONFIGURE OPTIONS 2225=head1 CONFIGURE OPTIONS
2001 2226
2002General hint: if you get compile errors, then likely your configuration 2227General hint: if you get compile errors, then likely your configuration
2003hasn't been tested well. Either try with C<--enable-everything> or use 2228hasn't been tested well. Either try with C<--enable-everything> or use
2004the F<./reconf> script as a base for experiments. F<./reconf> is used by 2229the default configuration (i.e. no C<--enable-xxx> or C<--disable-xxx>
2005myself, so it should generally be a working config. Of course, you should 2230switches). 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 2231work, so it can be fixed. Marc Lehmann <rxvt@schmorp.de>.
2007Lehmann <rxvt@schmorp.de>.
2008 2232
2009All 2233All
2010 2234
2011=over 4 2235=over 4
2012 2236
2044 2268
2045=begin table 2269=begin table
2046 2270
2047 all all available codeset groups 2271 all all available codeset groups
2048 zh common chinese encodings 2272 zh common chinese encodings
2049 zh_ext rarely used but very big chinese encodigs 2273 zh_ext rarely used but very big chinese encodings
2050 jp common japanese encodings 2274 jp common japanese encodings
2051 jp_ext rarely used but big japanese encodings 2275 jp_ext rarely used but big japanese encodings
2052 kr korean encodings 2276 kr korean encodings
2053 2277
2054=end table 2278=end table
2068requirements per character from 2 to 4 bytes. X11 fonts do not yet 2292requirements per character from 2 to 4 bytes. X11 fonts do not yet
2069support these extra characters, but Xft does. 2293support these extra characters, but Xft does.
2070 2294
2071Please note that rxvt-unicode can store unicode code points >65535 2295Please note that rxvt-unicode can store unicode code points >65535
2072even without this flag, but the number of such characters is 2296even without this flag, but the number of such characters is
2073limited to a view thousand (shared with combining characters, 2297limited to a few thousand (shared with combining characters,
2074see next switch), and right now rxvt-unicode cannot display them 2298see next switch), and right now rxvt-unicode cannot display them
2075(input/output and cut&paste still work, though). 2299(input/output and cut&paste still work, though).
2076 2300
2077=item --enable-combining (default: on) 2301=item --enable-combining (default: on)
2078 2302
2124 2348
2125Write user and tty to lastlog file (used by programs like 2349Write user and tty to lastlog file (used by programs like
2126F<lastlogin>) at start of rxvt execution. This option requires 2350F<lastlogin>) at start of rxvt execution. This option requires
2127--enable-utmp to also be specified. 2351--enable-utmp to also be specified.
2128 2352
2129=item --enable-xpm-background (default: on) 2353=item --enable-afterimage (default: on)
2130 2354
2131Add support for XPM background pixmaps. 2355Add support for libAfterImage to be used for transparency and background
2356images. It adds support for many file formats including JPG, PNG,
2357SVG, TIFF, GIF, XPM, BMP, ICO, XCF, TGA and AfterStep image XML
2358(L<http://www.afterstep.org/visualdoc.php?show=asimagexml>).
2359
2360This option also adds such eye candy as blending an image over the root
2361background, as well as dynamic scaling and bluring of background images.
2362
2363Note that with this option enabled, @@RXVT_NAME@@'s memory footprint might
2364increase by a few megabytes even if no extra features are used (mostly due
2365to third-party libraries used by libAI). Memory footprint may somewhat be
2366lowered if libAfterImage is configured without support for SVG.
2132 2367
2133=item --enable-transparency (default: on) 2368=item --enable-transparency (default: on)
2134 2369
2135Add support for inheriting parent backgrounds thus giving a fake 2370Add support for backgrounds, creating illusion of transparency in the term.
2136transparency to the term.
2137 2371
2138=item --enable-fading (default: on) 2372=item --enable-fading (default: on)
2139 2373
2140Add support for fading the text when focus is lost (requires C<--enable-transparency>). 2374Add 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 2375
2146=item --enable-rxvt-scroll (default: on) 2376=item --enable-rxvt-scroll (default: on)
2147 2377
2148Add support for the original rxvt scrollbar. 2378Add support for the original rxvt scrollbar.
2149 2379
2192A non-exhaustive list of features enabled by C<--enable-frills> (possibly 2422A non-exhaustive list of features enabled by C<--enable-frills> (possibly
2193in combination with other switches) is: 2423in combination with other switches) is:
2194 2424
2195 MWM-hints 2425 MWM-hints
2196 EWMH-hints (pid, utf8 names) and protocols (ping) 2426 EWMH-hints (pid, utf8 names) and protocols (ping)
2427 urgency hint
2197 seperate underline colour (-underlineColor) 2428 seperate underline colour (-underlineColor)
2198 settable border widths and borderless switch (-w, -b, -bl) 2429 settable border widths and borderless switch (-w, -b, -bl)
2199 visual depth selection (-depth) 2430 visual depth selection (-depth)
2200 settable extra linespacing /-lsp) 2431 settable extra linespacing /-lsp)
2201 iso-14755-2 and -3, and visual feedback 2432 iso-14755 5.1 (basic) support
2202 tripleclickwords (-tcw) 2433 tripleclickwords (-tcw)
2203 settable insecure mode (-insecure) 2434 settable insecure mode (-insecure)
2204 keysym remapping support 2435 keysym remapping support
2205 cursor blinking and underline cursor (-cb, -uc) 2436 cursor blinking and underline cursor (-cb, -uc)
2206 XEmbed support (-embed) 2437 XEmbed support (-embed)
2207 user-pty (-pty-fd) 2438 user-pty (-pty-fd)
2208 hold on exit (-hold) 2439 hold on exit (-hold)
2209 skip builtin block graphics (-sbg) 2440 skip builtin block graphics (-sbg)
2441 separate highlightcolor support (-hc)
2210 2442
2211It also enabled some non-essential features otherwise disabled, such as: 2443It also enables some non-essential features otherwise disabled, such as:
2212 2444
2213 some round-trip time optimisations 2445 some round-trip time optimisations
2214 nearest color allocation on pseudocolor screens 2446 nearest color allocation on pseudocolor screens
2215 UTF8_STRING supporr for selection 2447 UTF8_STRING support for selection
2216 sgr modes 90..97 and 100..107 2448 sgr modes 90..97 and 100..107
2217 backindex and forwardindex escape sequences 2449 backindex and forwardindex escape sequences
2218 view change/zero scorllback esacpe sequences 2450 view change/zero scrollback escape sequences
2219 locale switching escape sequence 2451 locale switching escape sequence
2220 window op and some xterm/OSC escape sequences 2452 window op and some xterm/OSC escape sequences
2221 rectangular selections 2453 rectangular selections
2222 trailing space removal for selections 2454 trailing space removal for selections
2223 verbose X error handling 2455 verbose X error handling
2232=item --enable-keepscrolling (default: on) 2464=item --enable-keepscrolling (default: on)
2233 2465
2234Add support for continual scrolling of the display when you hold 2466Add support for continual scrolling of the display when you hold
2235the mouse button down on a scrollbar arrow. 2467the mouse button down on a scrollbar arrow.
2236 2468
2469=item --enable-selectionscrolling (default: on)
2470
2471Add support for scrolling when the selection moves to the top or
2472bottom of the screen.
2473
2237=item --enable-mousewheel (default: on) 2474=item --enable-mousewheel (default: on)
2238 2475
2239Add support for scrolling via mouse wheel or buttons 4 & 5. 2476Add support for scrolling via mouse wheel or buttons 4 & 5.
2240 2477
2241=item --enable-slipwheeling (default: on) 2478=item --enable-slipwheeling (default: on)
2242 2479
2243Add support for continual scrolling (using the mouse wheel as an 2480Add support for continual scrolling (using the mouse wheel as an
2244accelerator) while the control key is held down. This option 2481accelerator) while the control key is held down. This option
2245requires --enable-mousewheel to also be specified. 2482requires --enable-mousewheel to also be specified.
2246 2483
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) 2484=item --enable-smart-resize (default: off)
2267 2485
2268Add smart growth/shrink behaviour when changing font size via hot 2486Add smart growth/shrink behaviour when resizing.
2269keys. This should keep the window corner which is closest to a corner of 2487This should keep the window corner which is closest to a corner of
2270the screen in a fixed position. 2488the screen in a fixed position.
2271 2489
2272=item --enable-pointer-blank (default: on) 2490=item --enable-pointer-blank (default: on)
2273 2491
2274Add support to have the pointer disappear when typing or inactive. 2492Add support to have the pointer disappear when typing or inactive.
2275 2493
2276=item --enable-perl (default: on) 2494=item --enable-perl (default: on)
2277 2495
2278Enable an embedded perl interpreter. See the B<@@RXVT_NAME@@perl(3)> 2496Enable 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 2497manpage (F<doc/rxvtperl.txt>) for more info on this feature, or the
2280in F<src/perl-ext/> for the extensions that are installed by default. The 2498files in F<src/perl-ext/> for the extensions that are installed by
2281perl interpreter that is used can be specified via the C<PERL> environment 2499default. The perl interpreter that is used can be specified via the
2282variable when running configure. 2500C<PERL> environment variable when running configure. Even when compiled
2501in, perl will I<not> be initialised when all extensions have been disabled
2502C<-pe "" --perl-ext-common "">, so it should be safe to enable from a
2503resource standpoint.
2504
2505=item --with-afterimage-config=DIR
2506
2507Look for the libAfterImage config script in DIR.
2283 2508
2284=item --with-name=NAME (default: urxvt) 2509=item --with-name=NAME (default: urxvt)
2285 2510
2286Set the basename for the installed binaries, resulting 2511Set the basename for the installed binaries, resulting
2287in C<urxvt>, C<urxvtd> etc.). Specify C<--with-name=rxvt> to replace with 2512in C<urxvt>, C<urxvtd> etc.). Specify C<--with-name=rxvt> to replace with
2297PATH. 2522PATH.
2298 2523
2299=item --with-x 2524=item --with-x
2300 2525
2301Use the X Window System (pretty much default, eh?). 2526Use 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 2527
2315=back 2528=back
2316 2529
2317=head1 AUTHORS 2530=head1 AUTHORS
2318 2531

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines