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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines