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.190 by sf-exg, Sun May 23 07:37:25 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 595Rxvt-unicode tries to inherit the current stty settings and uses the value
554of `erase' to guess the value for backspace. If rxvt-unicode wasn't 596of `erase' to guess the value for backspace. If rxvt-unicode wasn't
555started from a terminal (say, from a menu or by remote shell), then the 597started from a terminal (say, from a menu or by remote shell), then the
558 600
559For starting a new rxvt-unicode: 601For starting a new rxvt-unicode:
560 602
561 # use Backspace = ^H 603 # use Backspace = ^H
562 $ stty erase ^H 604 $ stty erase ^H
563 $ @@RXVT_NAME@@ 605 $ @@URXVT_NAME@@
564 606
565 # use Backspace = ^? 607 # use Backspace = ^?
566 $ stty erase ^? 608 $ stty erase ^?
567 $ @@RXVT_NAME@@ 609 $ @@URXVT_NAME@@
568 610
569Toggle with C<ESC [ 36 h> / C<ESC [ 36 l>. 611Toggle with C<ESC [ 36 h> / C<ESC [ 36 l>.
570 612
571For an existing rxvt-unicode: 613For an existing rxvt-unicode:
572 614
587key has been assigned an escape sequence to match the vt100 for Execute 629key has been assigned an escape sequence to match the vt100 for Execute
588(C<ESC [ 3 ~>) and is in the supplied termcap/terminfo. 630(C<ESC [ 3 ~>) and is in the supplied termcap/terminfo.
589 631
590Some other Backspace problems: 632Some other Backspace problems:
591 633
592some editors use termcap/terminfo, 634some editors use termcap/terminfo,
593some editors (vim I'm told) expect Backspace = ^H, 635some editors (vim I'm told) expect Backspace = ^H,
594GNU Emacs (and Emacs-like editors) use ^H for help. 636GNU Emacs (and Emacs-like editors) use ^H for help.
595 637
596Perhaps someday this will all be resolved in a consistent manner. 638Perhaps someday this will all be resolved in a consistent manner.
597 639
599 641
600There are some compile-time selections available via configure. Unless 642There are some compile-time selections available via configure. Unless
601you have run "configure" with the C<--disable-resources> option you can 643you have run "configure" with the C<--disable-resources> option you can
602use the `keysym' resource to alter the keystrings associated with keysyms. 644use the `keysym' resource to alter the keystrings associated with keysyms.
603 645
604Here's an example for a URxvt session started using C<@@RXVT_NAME@@ -name URxvt> 646Here's an example for a URxvt session started using C<@@URXVT_NAME@@ -name URxvt>
605 647
606 URxvt.keysym.Home: \033[1~ 648 URxvt.keysym.Home: \033[1~
607 URxvt.keysym.End: \033[4~ 649 URxvt.keysym.End: \033[4~
608 URxvt.keysym.C-apostrophe: \033<C-'> 650 URxvt.keysym.C-apostrophe: \033<C-'>
609 URxvt.keysym.C-slash: \033<C-/> 651 URxvt.keysym.C-slash: \033<C-/>
638Rather than have rxvt-unicode try to accommodate all the various possible 680Rather than have rxvt-unicode try to accommodate all the various possible
639keyboard mappings, it is better to use `xmodmap' to remap the keys as 681keyboard mappings, it is better to use `xmodmap' to remap the keys as
640required for your particular machine. 682required for your particular machine.
641 683
642 684
643
644=head2 Terminal Configuration 685=head2 Terminal Configuration
686
687=head3 Can I see a typical configuration?
688
689The default configuration tries to be xterm-like, which I don't like that
690much, but it's least surprise to regular users.
691
692As a rxvt or rxvt-unicode user, you are practically supposed to invest
693time into customising your terminal. To get you started, here is the
694author's .Xdefaults entries, with comments on what they do. It's certainly
695not I<typical>, but what's typical...
696
697 URxvt.cutchars: "()*,<>[]{}|'
698 URxvt.print-pipe: cat >/tmp/xxx
699
700These are just for testing stuff.
701
702 URxvt.imLocale: ja_JP.UTF-8
703 URxvt.preeditType: OnTheSpot,None
704
705This tells rxvt-unicode to use a special locale when communicating with
706the X Input Method, and also tells it to only use the OnTheSpot pre-edit
707type, which requires the C<xim-onthespot> perl extension but rewards me
708with correct-looking fonts.
709
710 URxvt.perl-lib: /root/lib/urxvt
711 URxvt.perl-ext-common: default,selection-autotransform,selection-pastebin,xim-onthespot,remote-clipboard
712 URxvt.selection.pattern-0: ( at .*? line \\d+)
713 URxvt.selection.pattern-1: ^(/[^:]+):\
714 URxvt.selection-autotransform.0: s/^([^:[:space:]]+):(\\d+):?$/:e \\Q$1\\E\\x0d:$2\\x0d/
715 URxvt.selection-autotransform.1: s/^ at (.*?) line (\\d+)$/:e \\Q$1\\E\\x0d:$2\\x0d/
716
717This is my perl configuration. The first two set the perl library
718directory and also tells urxvt to use a large number of extensions. I
719develop for myself mostly, so I actually use most of the extensions I
720write.
721
722The selection stuff mainly makes the selection perl-error-message aware
723and tells it to convert perl error messages into vi-commands to load the
724relevant file and go to the error line number.
725
726 URxvt.scrollstyle: plain
727 URxvt.secondaryScroll: true
728
729As the documentation says: plain is the preferred scrollbar for the
730author. The C<secondaryScroll> configures urxvt to scroll in full-screen
731apps, like screen, so lines scrolled out of screen end up in urxvt's
732scrollback buffer.
733
734 URxvt.background: #000000
735 URxvt.foreground: gray90
736 URxvt.color7: gray90
737 URxvt.colorBD: #ffffff
738 URxvt.cursorColor: #e0e080
739 URxvt.throughColor: #8080f0
740 URxvt.highlightColor: #f0f0f0
741
742Some colours. Not sure which ones are being used or even non-defaults, but
743these are in my .Xdefaults. Most notably, they set foreground/background
744to light gray/black, and also make sure that the colour 7 matches the
745default foreground colour.
746
747 URxvt.underlineColor: yellow
748
749Another colour, makes underline lines look different. Sometimes hurts, but
750is mostly a nice effect.
751
752 URxvt.geometry: 154x36
753 URxvt.loginShell: false
754 URxvt.meta: ignore
755 URxvt.utmpInhibit: true
756
757Uh, well, should be mostly self-explanatory. By specifying some defaults
758manually, I can quickly switch them for testing.
759
760 URxvt.saveLines: 8192
761
762A large scrollback buffer is essential. Really.
763
764 URxvt.mapAlert: true
765
766The only case I use it is for my IRC window, which I like to keep
767iconified till people msg me (which beeps).
768
769 URxvt.visualBell: true
770
771The audible bell is often annoying, especially when in a crowd.
772
773 URxvt.insecure: true
774
775Please don't hack my mutt! Ooops...
776
777 URxvt.pastableTabs: false
778
779I once thought this is a great idea.
780
781 urxvt.font: 9x15bold,\
782 -misc-fixed-bold-r-normal--15-140-75-75-c-90-iso10646-1,\
783 -misc-fixed-medium-r-normal--15-140-75-75-c-90-iso10646-1, \
784 [codeset=JISX0208]xft:Kochi Gothic, \
785 xft:Bitstream Vera Sans Mono:autohint=true, \
786 xft:Code2000:antialias=false
787 urxvt.boldFont: -xos4-terminus-bold-r-normal--14-140-72-72-c-80-iso8859-15
788 urxvt.italicFont: xft:Bitstream Vera Sans Mono:italic:autohint=true
789 urxvt.boldItalicFont: xft:Bitstream Vera Sans Mono:bold:italic:autohint=true
790
791I wrote rxvt-unicode to be able to specify fonts exactly. So don't be
792overwhelmed. A special note: the C<9x15bold> mentioned above is actually
793the version from XFree-3.3, as XFree-4 replaced it by a totally different
794font (different glyphs for C<;> and many other harmless characters),
795while the second font is actually the C<9x15bold> from XFree4/XOrg. The
796bold version has less chars than the medium version, so I use it for rare
797characters, too. When editing sources with vim, I use italic for comments
798and other stuff, which looks quite good with Bitstream Vera anti-aliased.
799
800Terminus is a quite bad font (many very wrong glyphs), but for most of my
801purposes, it works, and gives a different look, as my normal (Non-bold)
802font is already bold, and I want to see a difference between bold and
803normal fonts.
804
805Please note that I used the C<urxvt> instance name and not the C<URxvt>
806class name. That is because I use different configs for different purposes,
807for example, my IRC window is started with C<-name IRC>, and uses these
808defaults:
809
810 IRC*title: IRC
811 IRC*geometry: 87x12+535+542
812 IRC*saveLines: 0
813 IRC*mapAlert: true
814 IRC*font: suxuseuro
815 IRC*boldFont: suxuseuro
816 IRC*colorBD: white
817 IRC*keysym.M-C-1: command:\033]710;suxuseuro\007\033]711;suxuseuro\007
818 IRC*keysym.M-C-2: command:\033]710;9x15bold\007\033]711;9x15bold\007
819
820C<Alt-Ctrl-1> and C<Alt-Ctrl-2> switch between two different font
821sizes. C<suxuseuro> allows me to keep an eye (and actually read)
822stuff while keeping a very small window. If somebody pastes something
823complicated (e.g. japanese), I temporarily switch to a larger font.
824
825The above is all in my C<.Xdefaults> (I don't use C<.Xresources> nor
826C<xrdb>). I also have some resources in a separate C<.Xdefaults-hostname>
827file for different hosts, for example, on ym main desktop, I use:
828
829 URxvt.keysym.C-M-q: command:\033[3;5;5t
830 URxvt.keysym.C-M-y: command:\033[3;5;606t
831 URxvt.keysym.C-M-e: command:\033[3;1605;5t
832 URxvt.keysym.C-M-c: command:\033[3;1605;606t
833 URxvt.keysym.C-M-p: perl:test
834
835The first for keysym definitions allow me to quickly bring some windows
836in the layout I like most. Ion users might start laughing but will stop
837immediately when I tell them that I use my own Fvwm2 module for much the
838same effect as Ion provides, and I only very rarely use the above key
839combinations :->
645 840
646=head3 Why doesn't rxvt-unicode read my resources? 841=head3 Why doesn't rxvt-unicode read my resources?
647 842
648Well, why, indeed? It does, in a way very similar to other X 843Well, why, indeed? It does, in a way very similar to other X
649applications. Most importantly, this means that if you or your OS loads 844applications. Most importantly, this means that if you or your OS loads
658Also consider the form resources have to use: 853Also consider the form resources have to use:
659 854
660 URxvt.resource: value 855 URxvt.resource: value
661 856
662If you want to use another form (there are lots of different ways of 857If you want to use another form (there are lots of different ways of
663specifying resources), make sure you understand wether and why it 858specifying resources), make sure you understand whether and why it
664works. If unsure, use the form above. 859works. If unsure, use the form above.
665 860
666=head3 When I log-in to another system it tells me about missing terminfo data? 861=head3 When I log-in to another system it tells me about missing terminfo data?
667 862
668The terminal description used by rxvt-unicode is not as widely available 863The 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). 864as that for xterm, or even rxvt (for which the same problem often arises).
670 865
671The correct solution for this problem is to install the terminfo, this can 866The correct solution for this problem is to install the terminfo, this can
672be done like this (with ncurses' infocmp): 867be done by simply installing rxvt-unicode on the remote system as well
868(in case you have a nice package manager ready), or you can install the
869terminfo database manually like this (with ncurses infocmp. works as
870user and root):
673 871
674 REMOTE=remotesystem.domain 872 REMOTE=remotesystem.domain
675 infocmp rxvt-unicode | ssh $REMOTE "cat >/tmp/ti && tic /tmp/ti" 873 infocmp rxvt-unicode | ssh $REMOTE "mkdir -p .terminfo && cat >/tmp/ti && tic /tmp/ti"
676 874
677... or by installing rxvt-unicode normally on the remote system, 875One some systems you might need to set C<$TERMINFO> to the full path of
876F<$HOME/.terminfo> for this to work.
678 877
679If you cannot or do not want to do this, then you can simply set 878If 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 879C<TERM=rxvt> or even C<TERM=xterm>, and live with the small number of
681problems arising, which includes wrong keymapping, less and different 880problems arising, which includes wrong keymapping, less and different
682colours and some refresh errors in fullscreen applications. It's a nice 881colours and some refresh errors in fullscreen applications. It's a nice
687resource to set it: 886resource to set it:
688 887
689 URxvt.termName: rxvt 888 URxvt.termName: rxvt
690 889
691If you don't plan to use B<rxvt> (quite common...) you could also replace 890If you don't plan to use B<rxvt> (quite common...) you could also replace
692the rxvt terminfo file with the rxvt-unicode one. 891the rxvt terminfo file with the rxvt-unicode one and use C<TERM=rxvt>.
892
893=head3 nano fails with "Error opening terminal: rxvt-unicode"
894
895This exceptionally confusing and useless error message is printed by nano
896when it can't find the terminfo database. Nothing is wrong with your
897terminal, read the previous answer for a solution.
693 898
694=head3 C<tic> outputs some error when compiling the terminfo entry. 899=head3 C<tic> outputs some error when compiling the terminfo entry.
695 900
696Most likely it's the empty definition for C<enacs=>. Just replace it by 901Most likely it's the empty definition for C<enacs=>. Just replace it by
697C<enacs=\E[0@> and try again. 902C<enacs=\E[0@> and try again.
698 903
699=head3 C<bash>'s readline does not work correctly under @@RXVT_NAME@@. 904=head3 C<bash>'s readline does not work correctly under @@URXVT_NAME@@.
700 905
701See next entry. 906See next entry.
702 907
703=head3 I need a termcap file entry. 908=head3 I need a termcap file entry.
704 909
705One reason you might want this is that some distributions or operating 910One reason you might want this is that some distributions or operating
706systems still compile some programs using the long-obsoleted termcap 911systems still compile some programs using the long-obsoleted termcap
707library (Fedora Core's bash is one example) and rely on a termcap entry 912library (Fedora Core's bash is one example) and rely on a termcap entry
708for C<rxvt-unicode>. 913for C<rxvt-unicode>.
709 914
710You could use rxvt's termcap entry with resonable results in many cases. 915You 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 916You can also create a termcap entry by using terminfo's infocmp program
712like this: 917like this:
713 918
714 infocmp -C rxvt-unicode 919 infocmp -C rxvt-unicode
715 920
716Or you could use this termcap entry, generated by the command above: 921Or you could use the termcap entry in doc/etc/rxvt-unicode.termcap,
717 922generated 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 923
739=head3 Why does C<ls> no longer have coloured output? 924=head3 Why does C<ls> no longer have coloured output?
740 925
741The C<ls> in the GNU coreutils unfortunately doesn't use terminfo to 926The C<ls> in the GNU coreutils unfortunately doesn't use terminfo to
742decide wether a terminal has colour, but uses it's own configuration 927decide 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 928file. Needless to say, C<rxvt-unicode> is not in its default file (among
744with most other terminals supporting colour). Either add: 929with most other terminals supporting colour). Either add:
745 930
746 TERM rxvt-unicode 931 TERM rxvt-unicode
747 932
748to C</etc/DIR_COLORS> or simply add: 933to C</etc/DIR_COLORS> or simply add:
782If you encounter strange problems like typing an accented character but 967If you encounter strange problems like typing an accented character but
783getting two unrelated other characters or similar, or if program output is 968getting two unrelated other characters or similar, or if program output is
784subtly garbled, then you should check your locale settings. 969subtly garbled, then you should check your locale settings.
785 970
786Rxvt-unicode must be started with the same C<LC_CTYPE> setting as the 971Rxvt-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 972programs 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 973while 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. 974locale to something else, e.g. C<en_GB.UTF-8>. Needless to say, this is
975not going to work, and is the most common cause for problems.
790 976
791The best thing is to fix your startup environment, as you will likely run 977The 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. 978into other problems. If nothing works you can try this in your .profile.
793 979
794 printf '\e]701;%s\007' "$LC_CTYPE" 980 printf '\33]701;%s\007' "$LC_CTYPE" # $LANG or $LC_ALL are worth a try, too
795 981
796If this doesn't work, then maybe you use a C<LC_CTYPE> specification not 982If 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 983supported 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 984displays 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 985it 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 1006The reasons is that there exists a perfectly fine mechanism for selecting
821the encoding, doing I/O and (most important) communicating this to all 1007the encoding, doing I/O and (most important) communicating this to all
822applications so everybody agrees on character properties such as width 1008applications so everybody agrees on character properties such as width
823and code number. This mechanism is the I<locale>. Applications not using 1009and code number. This mechanism is the I<locale>. Applications not using
824that info will have problems (for example, C<xterm> gets the width of 1010that 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 1011characters wrong as it uses its own, locale-independent table under all
826locales). 1012locales).
827 1013
828Rxvt-unicode uses the C<LC_CTYPE> locale category to select encoding. All 1014Rxvt-unicode uses the C<LC_CTYPE> locale category to select encoding. All
829programs doing the same (that is, most) will automatically agree in the 1015programs doing the same (that is, most) will automatically agree in the
830interpretation of characters. 1016interpretation of characters.
849=head3 Can I switch locales at runtime? 1035=head3 Can I switch locales at runtime?
850 1036
851Yes, using an escape sequence. Try something like this, which sets 1037Yes, using an escape sequence. Try something like this, which sets
852rxvt-unicode's idea of C<LC_CTYPE>. 1038rxvt-unicode's idea of C<LC_CTYPE>.
853 1039
854 printf '\e]701;%s\007' ja_JP.SJIS 1040 printf '\33]701;%s\007' ja_JP.SJIS
855 1041
856See also the previous answer. 1042See also the previous answer.
857 1043
858Sometimes this capability is rather handy when you want to work in 1044Sometimes 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 1045one 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 1046(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: 1047first switches to a locale supported by xjdic and back later:
862 1048
863 printf '\e]701;%s\007' ja_JP.SJIS 1049 printf '\33]701;%s\007' ja_JP.SJIS
864 xjdic -js 1050 xjdic -js
865 printf '\e]701;%s\007' de_DE.UTF-8 1051 printf '\33]701;%s\007' de_DE.UTF-8
866 1052
867You can also use xterm's C<luit> program, which usually works fine, except 1053You can also use xterm's C<luit> program, which usually works fine, except
868for some locales where character width differs between program- and 1054for some locales where character width differs between program- and
869rxvt-unicode-locales. 1055rxvt-unicode-locales.
870 1056
1057=head3 I have problems getting my input method working.
1058
1059Try a search engine, as this is slightly different for every input method server.
1060
1061Here is a checklist:
1062
1063=over 4
1064
1065=item - Make sure your locale I<and> the imLocale are supported on your OS.
1066
1067Try C<locale -a> or check the documentation for your OS.
1068
1069=item - Make sure your locale or imLocale matches a locale supported by your XIM.
1070
1071For example, B<kinput2> does not support UTF-8 locales, you should use
1072C<ja_JP.EUC-JP> or equivalent.
1073
1074=item - Make sure your XIM server is actually running.
1075
1076=item - Make sure the C<XMODIFIERS> environment variable is set correctly when I<starting> rxvt-unicode.
1077
1078When you want to use e.g. B<kinput2>, it must be set to
1079C<@im=kinput2>. For B<scim>, use C<@im=SCIM>. You can see what input
1080method servers are running with this command:
1081
1082 xprop -root XIM_SERVERS
1083
1084=item
1085
1086=back
1087
871=head3 My input method wants <some encoding> but I want UTF-8, what can I do? 1088=head3 My input method wants <some encoding> but I want UTF-8, what can I do?
872 1089
873You can specify separate locales for the input method and the rest of the 1090You can specify separate locales for the input method and the rest of the
874terminal, using the resource C<imlocale>: 1091terminal, using the resource C<imlocale>:
875 1092
876 URxvt.imlocale: ja_JP.EUC-JP 1093 URxvt.imlocale: ja_JP.EUC-JP
877 1094
878Now you can start your terminal with C<LC_CTYPE=ja_JP.UTF-8> and still 1095Now 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 1096use 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 1097version, you may not be able to input characters outside C<EUC-JP> in a
881method limits you. 1098normal way then, as your input method limits you.
882 1099
883=head3 Rxvt-unicode crashes when the X Input Method changes or exits. 1100=head3 Rxvt-unicode crashes when the X Input Method changes or exits.
884 1101
885Unfortunately, this is unavoidable, as the XIM protocol is racy by 1102Unfortunately, this is unavoidable, as the XIM protocol is racy by
886design. Applications can avoid some crashes at the expense of memory 1103design. Applications can avoid some crashes at the expense of memory
912 1129
913=head3 I am maintaining rxvt-unicode for distribution/OS XXX, any recommendation? 1130=head3 I am maintaining rxvt-unicode for distribution/OS XXX, any recommendation?
914 1131
915You should build one binary with the default options. F<configure> 1132You should build one binary with the default options. F<configure>
916now enables most useful options, and the trend goes to making them 1133now enables most useful options, and the trend goes to making them
917runtime-switchable, too, so there is usually no drawback to enbaling them, 1134runtime-switchable, too, so there is usually no drawback to enabling them,
918except higher disk and possibly memory usage. The perl interpreter should 1135except higher disk and possibly memory usage. The perl interpreter should
919be enabled, as important functionality (menus, selection, likely more in 1136be enabled, as important functionality (menus, selection, likely more in
920the future) depends on it. 1137the future) depends on it.
921 1138
922You should not overwrite the C<perl-ext-common> snd C<perl-ext> resources 1139You 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 1140system-wide (except maybe with C<defaults>). This will result in useful
924behaviour. If your distribution aims at low memory, add an empty 1141behaviour. If your distribution aims at low memory, add an empty
925C<perl-ext-common> resource to the app-defaults file. This will keep the 1142C<perl-ext-common> resource to the app-defaults file. This will keep the
926perl interpreter disabled until the user enables it. 1143perl interpreter disabled until the user enables it.
927 1144
945This forking is done as the very first within main(), which is very early 1162This forking is done as the very first within main(), which is very early
946and reduces possible bugs to initialisation code run before main(), or 1163and reduces possible bugs to initialisation code run before main(), or
947things like the dynamic loader of your system, which should result in very 1164things like the dynamic loader of your system, which should result in very
948little risk. 1165little risk.
949 1166
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. 1167=head3 I am on FreeBSD and rxvt-unicode does not seem to work at all.
959 1168
960Rxvt-unicode requires the symbol C<__STDC_ISO_10646__> to be defined 1169Rxvt-unicode requires the symbol C<__STDC_ISO_10646__> to be defined
961in your compile environment, or an implementation that implements it, 1170in your compile environment, or an implementation that implements it,
962wether it defines the symbol or not. C<__STDC_ISO_10646__> requires that 1171whether it defines the symbol or not. C<__STDC_ISO_10646__> requires that
963B<wchar_t> is represented as unicode. 1172B<wchar_t> is represented as unicode.
964 1173
965As you might have guessed, FreeBSD does neither define this symobl nor 1174As you might have guessed, FreeBSD does neither define this symbol nor
966does it support it. Instead, it uses it's own internal representation of 1175does it support it. Instead, it uses its own internal representation of
967B<wchar_t>. This is, of course, completely fine with respect to standards. 1176B<wchar_t>. This is, of course, completely fine with respect to standards.
968 1177
969However, that means rxvt-unicode only works in C<POSIX>, C<ISO-8859-1> and 1178However, 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>. 1179C<UTF-8> locales under FreeBSD (which all use Unicode as B<wchar_t>).
971 1180
972C<__STDC_ISO_10646__> is the only sane way to support multi-language 1181C<__STDC_ISO_10646__> is the only sane way to support multi-language
973apps in an OS, as using a locale-dependent (and non-standardized) 1182apps in an OS, as using a locale-dependent (and non-standardized)
974representation of B<wchar_t> makes it impossible to convert between 1183representation of B<wchar_t> makes it impossible to convert between
975B<wchar_t> (as used by X11 and your applications) and any other encoding 1184B<wchar_t> (as used by X11 and your applications) and any other encoding
985 1194
986The rxvt-unicode author insists that the right way to fix this is in the 1195The 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 1196system libraries once and for all, instead of forcing every app to carry
988complete replacements for them :) 1197complete replacements for them :)
989 1198
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? 1199=head3 How can I use rxvt-unicode under cygwin?
996 1200
997rxvt-unicode should compile and run out of the box on cygwin, using 1201rxvt-unicode should compile and run out of the box on cygwin, using
998the X11 libraries that come with cygwin. libW11 emulation is no 1202the X11 libraries that come with cygwin. libW11 emulation is no
999longer supported (and makes no sense, either, as it only supported a 1203longer supported (and makes no sense, either, as it only supported a
1003 1207
1004At the time of this writing, cygwin didn't seem to support any multi-byte 1208At 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 1209encodings (you might try C<LC_CTYPE=C-UTF-8>), so you are likely limited
1006to 8-bit encodings. 1210to 8-bit encodings.
1007 1211
1212=head3 Character widths are not correct.
1213
1214urxvt uses the system wcwidth function to know the information about
1215the width of characters, so on systems with incorrect locale data you
1216will likely get bad results. Two notorious examples are Solaris 9,
1217where single-width characters like U+2514 are reported as double-width,
1218and Darwin 8, where combining chars are reported having width 1.
1219
1220The solution is to upgrade your system or switch to a better one. A
1221possibly working workaround is to use a wcwidth implementation like
1222
1223http://www.cl.cam.ac.uk/~mgk25/ucs/wcwidth.c
1224
1008=head1 RXVT TECHNICAL REFERENCE 1225=head1 RXVT-UNICODE TECHNICAL REFERENCE
1009
1010=head1 DESCRIPTION
1011 1226
1012The rest of this document describes various technical aspects of 1227The rest of this document describes various technical aspects of
1013B<rxvt-unicode>. First the description of supported command sequences, 1228B<rxvt-unicode>. First the description of supported command sequences,
1014followed by pixmap support and last by a description of all features 1229followed by pixmap support and last by a description of all features
1015selectable at C<configure> time. 1230selectable at C<configure> time.
1016 1231
1017=head1 Definitions 1232=head2 Definitions
1018 1233
1019=over 4 1234=over 4
1020 1235
1021=item B<< C<c> >> 1236=item B<< C<c> >>
1022 1237
1040 1255
1041A text parameter composed of printable characters. 1256A text parameter composed of printable characters.
1042 1257
1043=back 1258=back
1044 1259
1045=head1 Values 1260=head2 Values
1046 1261
1047=over 4 1262=over 4
1048 1263
1049=item B<< C<ENQ> >> 1264=item B<< C<ENQ> >>
1050 1265
1093 1308
1094Space Character 1309Space Character
1095 1310
1096=back 1311=back
1097 1312
1098=head1 Escape Sequences 1313=head2 Escape Sequences
1099 1314
1100=over 4 1315=over 4
1101 1316
1102=item B<< C<ESC # 8> >> 1317=item B<< C<ESC # 8> >>
1103 1318
1113 1328
1114=item B<< C<ESC => >> 1329=item B<< C<ESC => >>
1115 1330
1116Application Keypad (SMKX). See also next sequence. 1331Application Keypad (SMKX). See also next sequence.
1117 1332
1118=item B<<< C<< ESC >> >>> 1333=item B<<< C<< ESC > >> >>>
1119 1334
1120Normal Keypad (RMKX) 1335Normal Keypad (RMKX)
1121 1336
1122B<Note:> If the numeric keypad is activated, eg, B<Num_Lock> has been 1337B<Note:> If the numeric keypad is activated, eg, B<Num_Lock> has been
1123pressed, numbers or control functions are generated by the numeric keypad 1338pressed, numbers or control functions are generated by the numeric keypad
1201 1416
1202=back 1417=back
1203 1418
1204X<CSI> 1419X<CSI>
1205 1420
1206=head1 CSI (Command Sequence Introducer) Sequences 1421=head2 CSI (Command Sequence Introducer) Sequences
1207 1422
1208=over 4 1423=over 4
1209 1424
1210=item B<< C<ESC [ Ps @> >> 1425=item B<< C<ESC [ Ps @> >>
1211 1426
1266=begin table 1481=begin table
1267 1482
1268 B<< C<Ps = 0> >> Clear to Right (default) 1483 B<< C<Ps = 0> >> Clear to Right (default)
1269 B<< C<Ps = 1> >> Clear to Left 1484 B<< C<Ps = 1> >> Clear to Left
1270 B<< C<Ps = 2> >> Clear All 1485 B<< C<Ps = 2> >> Clear All
1486 B<< C<Ps = 3> >> Like Ps = 0, but is ignored when wrapped
1487 (@@RXVT_NAME@@ extension)
1271 1488
1272=end table 1489=end table
1273 1490
1274=item B<< C<ESC [ Ps L> >> 1491=item B<< C<ESC [ Ps L> >>
1275 1492
1407 B<< C<Ps = 32 / 42> >> fg/bg Green 1624 B<< C<Ps = 32 / 42> >> fg/bg Green
1408 B<< C<Ps = 33 / 43> >> fg/bg Yellow 1625 B<< C<Ps = 33 / 43> >> fg/bg Yellow
1409 B<< C<Ps = 34 / 44> >> fg/bg Blue 1626 B<< C<Ps = 34 / 44> >> fg/bg Blue
1410 B<< C<Ps = 35 / 45> >> fg/bg Magenta 1627 B<< C<Ps = 35 / 45> >> fg/bg Magenta
1411 B<< C<Ps = 36 / 46> >> fg/bg Cyan 1628 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) 1629 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 1630 B<< C<Ps = 37 / 47> >> fg/bg White
1414 B<< C<Ps = 39 / 49> >> fg/bg Default 1631 B<< C<Ps = 39 / 49> >> fg/bg Default
1415 B<< C<Ps = 90 / 100> >> fg/bg Bright Black 1632 B<< C<Ps = 90 / 100> >> fg/bg Bright Black
1416 B<< C<Ps = 91 / 101> >> fg/bg Bright Red 1633 B<< C<Ps = 91 / 101> >> fg/bg Bright Red
1417 B<< C<Ps = 92 / 102> >> fg/bg Bright Green 1634 B<< C<Ps = 92 / 102> >> fg/bg Bright Green
1481 1698
1482=back 1699=back
1483 1700
1484X<PrivateModes> 1701X<PrivateModes>
1485 1702
1486=head1 DEC Private Modes 1703=head2 DEC Private Modes
1487 1704
1488=over 4 1705=over 4
1489 1706
1490=item B<< C<ESC [ ? Pm h> >> 1707=item B<< C<ESC [ ? Pm h> >>
1491 1708
1507 1724
1508Toggle DEC Private Mode Values (rxvt extension). I<where> 1725Toggle DEC Private Mode Values (rxvt extension). I<where>
1509 1726
1510=over 4 1727=over 4
1511 1728
1512=item B<< C<Ps = 1> >> (DECCKM) 1729=item B<< C<Pm = 1> >> (DECCKM)
1513 1730
1514=begin table 1731=begin table
1515 1732
1516 B<< C<h> >> Application Cursor Keys 1733 B<< C<h> >> Application Cursor Keys
1517 B<< C<l> >> Normal Cursor Keys 1734 B<< C<l> >> Normal Cursor Keys
1518 1735
1519=end table 1736=end table
1520 1737
1521=item B<< C<Ps = 2> >> (ANSI/VT52 mode) 1738=item B<< C<Pm = 2> >> (ANSI/VT52 mode)
1522 1739
1523=begin table 1740=begin table
1524 1741
1525 B<< C<h> >> Enter VT52 mode 1742 B<< C<h> >> Enter VT52 mode
1526 B<< C<l> >> Enter VT52 mode 1743 B<< C<l> >> Enter VT52 mode
1527 1744
1528=end table 1745=end table
1529 1746
1530=item B<< C<Ps = 3> >> 1747=item B<< C<Pm = 3> >>
1531 1748
1532=begin table 1749=begin table
1533 1750
1534 B<< C<h> >> 132 Column Mode (DECCOLM) 1751 B<< C<h> >> 132 Column Mode (DECCOLM)
1535 B<< C<l> >> 80 Column Mode (DECCOLM) 1752 B<< C<l> >> 80 Column Mode (DECCOLM)
1536 1753
1537=end table 1754=end table
1538 1755
1539=item B<< C<Ps = 4> >> 1756=item B<< C<Pm = 4> >>
1540 1757
1541=begin table 1758=begin table
1542 1759
1543 B<< C<h> >> Smooth (Slow) Scroll (DECSCLM) 1760 B<< C<h> >> Smooth (Slow) Scroll (DECSCLM)
1544 B<< C<l> >> Jump (Fast) Scroll (DECSCLM) 1761 B<< C<l> >> Jump (Fast) Scroll (DECSCLM)
1545 1762
1546=end table 1763=end table
1547 1764
1548=item B<< C<Ps = 5> >> 1765=item B<< C<Pm = 5> >>
1549 1766
1550=begin table 1767=begin table
1551 1768
1552 B<< C<h> >> Reverse Video (DECSCNM) 1769 B<< C<h> >> Reverse Video (DECSCNM)
1553 B<< C<l> >> Normal Video (DECSCNM) 1770 B<< C<l> >> Normal Video (DECSCNM)
1554 1771
1555=end table 1772=end table
1556 1773
1557=item B<< C<Ps = 6> >> 1774=item B<< C<Pm = 6> >>
1558 1775
1559=begin table 1776=begin table
1560 1777
1561 B<< C<h> >> Origin Mode (DECOM) 1778 B<< C<h> >> Origin Mode (DECOM)
1562 B<< C<l> >> Normal Cursor Mode (DECOM) 1779 B<< C<l> >> Normal Cursor Mode (DECOM)
1563 1780
1564=end table 1781=end table
1565 1782
1566=item B<< C<Ps = 7> >> 1783=item B<< C<Pm = 7> >>
1567 1784
1568=begin table 1785=begin table
1569 1786
1570 B<< C<h> >> Wraparound Mode (DECAWM) 1787 B<< C<h> >> Wraparound Mode (DECAWM)
1571 B<< C<l> >> No Wraparound Mode (DECAWM) 1788 B<< C<l> >> No Wraparound Mode (DECAWM)
1572 1789
1573=end table 1790=end table
1574 1791
1575=item B<< C<Ps = 8> >> I<unimplemented> 1792=item B<< C<Pm = 8> >> I<unimplemented>
1576 1793
1577=begin table 1794=begin table
1578 1795
1579 B<< C<h> >> Auto-repeat Keys (DECARM) 1796 B<< C<h> >> Auto-repeat Keys (DECARM)
1580 B<< C<l> >> No Auto-repeat Keys (DECARM) 1797 B<< C<l> >> No Auto-repeat Keys (DECARM)
1581 1798
1582=end table 1799=end table
1583 1800
1584=item B<< C<Ps = 9> >> X10 XTerm 1801=item B<< C<Pm = 9> >> X10 XTerm
1585 1802
1586=begin table 1803=begin table
1587 1804
1588 B<< C<h> >> Send Mouse X & Y on button press. 1805 B<< C<h> >> Send Mouse X & Y on button press.
1589 B<< C<l> >> No mouse reporting. 1806 B<< C<l> >> No mouse reporting.
1590 1807
1591=end table 1808=end table
1592 1809
1593=item B<< C<Ps = 25> >> 1810=item B<< C<Pm = 25> >>
1594 1811
1595=begin table 1812=begin table
1596 1813
1597 B<< C<h> >> Visible cursor {cnorm/cvvis} 1814 B<< C<h> >> Visible cursor {cnorm/cvvis}
1598 B<< C<l> >> Invisible cursor {civis} 1815 B<< C<l> >> Invisible cursor {civis}
1599 1816
1600=end table 1817=end table
1601 1818
1602=item B<< C<Ps = 30> >> 1819=item B<< C<Pm = 30> >>
1603 1820
1604=begin table 1821=begin table
1605 1822
1606 B<< C<h> >> scrollBar visisble 1823 B<< C<h> >> scrollBar visible
1607 B<< C<l> >> scrollBar invisisble 1824 B<< C<l> >> scrollBar invisible
1608 1825
1609=end table 1826=end table
1610 1827
1611=item B<< C<Ps = 35> >> (B<rxvt>) 1828=item B<< C<Pm = 35> >> (B<rxvt>)
1612 1829
1613=begin table 1830=begin table
1614 1831
1615 B<< C<h> >> Allow XTerm Shift+key sequences 1832 B<< C<h> >> Allow XTerm Shift+key sequences
1616 B<< C<l> >> Disallow XTerm Shift+key sequences 1833 B<< C<l> >> Disallow XTerm Shift+key sequences
1617 1834
1618=end table 1835=end table
1619 1836
1620=item B<< C<Ps = 38> >> I<unimplemented> 1837=item B<< C<Pm = 38> >> I<unimplemented>
1621 1838
1622Enter Tektronix Mode (DECTEK) 1839Enter Tektronix Mode (DECTEK)
1623 1840
1624=item B<< C<Ps = 40> >> 1841=item B<< C<Pm = 40> >>
1625 1842
1626=begin table 1843=begin table
1627 1844
1628 B<< C<h> >> Allow 80/132 Mode 1845 B<< C<h> >> Allow 80/132 Mode
1629 B<< C<l> >> Disallow 80/132 Mode 1846 B<< C<l> >> Disallow 80/132 Mode
1630 1847
1631=end table 1848=end table
1632 1849
1633=item B<< C<Ps = 44> >> I<unimplemented> 1850=item B<< C<Pm = 44> >> I<unimplemented>
1634 1851
1635=begin table 1852=begin table
1636 1853
1637 B<< C<h> >> Turn On Margin Bell 1854 B<< C<h> >> Turn On Margin Bell
1638 B<< C<l> >> Turn Off Margin Bell 1855 B<< C<l> >> Turn Off Margin Bell
1639 1856
1640=end table 1857=end table
1641 1858
1642=item B<< C<Ps = 45> >> I<unimplemented> 1859=item B<< C<Pm = 45> >> I<unimplemented>
1643 1860
1644=begin table 1861=begin table
1645 1862
1646 B<< C<h> >> Reverse-wraparound Mode 1863 B<< C<h> >> Reverse-wraparound Mode
1647 B<< C<l> >> No Reverse-wraparound Mode 1864 B<< C<l> >> No Reverse-wraparound Mode
1648 1865
1649=end table 1866=end table
1650 1867
1651=item B<< C<Ps = 46> >> I<unimplemented> 1868=item B<< C<Pm = 46> >> I<unimplemented>
1652 1869
1653=item B<< C<Ps = 47> >> 1870=item B<< C<Pm = 47> >>
1654 1871
1655=begin table 1872=begin table
1656 1873
1657 B<< C<h> >> Use Alternate Screen Buffer 1874 B<< C<h> >> Use Alternate Screen Buffer
1658 B<< C<l> >> Use Normal Screen Buffer 1875 B<< C<l> >> Use Normal Screen Buffer
1659 1876
1660=end table 1877=end table
1661 1878
1662X<Priv66> 1879X<Priv66>
1663 1880
1664=item B<< C<Ps = 66> >> 1881=item B<< C<Pm = 66> >>
1665 1882
1666=begin table 1883=begin table
1667 1884
1668 B<< C<h> >> Application Keypad (DECPAM) == C<ESC => 1885 B<< C<h> >> Application Keypad (DECKPAM/DECPAM) == C<ESC =>
1669 B<< C<l> >> Normal Keypad (DECPNM) == C<< ESC > >> 1886 B<< C<l> >> Normal Keypad (DECKPNM/DECPNM) == C<< ESC > >>
1670 1887
1671=end table 1888=end table
1672 1889
1673=item B<< C<Ps = 67> >> 1890=item B<< C<Pm = 67> >>
1674 1891
1675=begin table 1892=begin table
1676 1893
1677 B<< C<h> >> Backspace key sends B<< C<BS> (DECBKM) >> 1894 B<< C<h> >> Backspace key sends B<< C<BS> (DECBKM) >>
1678 B<< C<l> >> Backspace key sends B<< C<DEL> >> 1895 B<< C<l> >> Backspace key sends B<< C<DEL> >>
1679 1896
1680=end table 1897=end table
1681 1898
1682=item B<< C<Ps = 1000> >> (X11 XTerm) 1899=item B<< C<Pm = 1000> >> (X11 XTerm)
1683 1900
1684=begin table 1901=begin table
1685 1902
1686 B<< C<h> >> Send Mouse X & Y on button press and release. 1903 B<< C<h> >> Send Mouse X & Y on button press and release.
1687 B<< C<l> >> No mouse reporting. 1904 B<< C<l> >> No mouse reporting.
1688 1905
1689=end table 1906=end table
1690 1907
1691=item B<< C<Ps = 1001> >> (X11 XTerm) I<unimplemented> 1908=item B<< C<Pm = 1001> >> (X11 XTerm) I<unimplemented>
1692 1909
1693=begin table 1910=begin table
1694 1911
1695 B<< C<h> >> Use Hilite Mouse Tracking. 1912 B<< C<h> >> Use Hilite Mouse Tracking.
1696 B<< C<l> >> No mouse reporting. 1913 B<< C<l> >> No mouse reporting.
1697 1914
1698=end table 1915=end table
1699 1916
1917=item B<< C<Pm = 1002> >> (X11 XTerm)
1918
1919=begin table
1920
1921 B<< C<h> >> Send Mouse X & Y on button press and release, and motion with a button pressed.
1922 B<< C<l> >> No mouse reporting.
1923
1924=end table
1925
1926=item B<< C<Pm = 1003> >> (X11 XTerm)
1927
1928=begin table
1929
1930 B<< C<h> >> Send Mouse X & Y on button press and release, and motion.
1931 B<< C<l> >> No mouse reporting.
1932
1933=end table
1934
1700=item B<< C<Ps = 1010> >> (B<rxvt>) 1935=item B<< C<Pm = 1010> >> (B<rxvt>)
1701 1936
1702=begin table 1937=begin table
1703 1938
1704 B<< C<h> >> Don't scroll to bottom on TTY output 1939 B<< C<h> >> Don't scroll to bottom on TTY output
1705 B<< C<l> >> Scroll to bottom on TTY output 1940 B<< C<l> >> Scroll to bottom on TTY output
1706 1941
1707=end table 1942=end table
1708 1943
1709=item B<< C<Ps = 1011> >> (B<rxvt>) 1944=item B<< C<Pm = 1011> >> (B<rxvt>)
1710 1945
1711=begin table 1946=begin table
1712 1947
1713 B<< C<h> >> Scroll to bottom when a key is pressed 1948 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 1949 B<< C<l> >> Don't scroll to bottom when a key is pressed
1715 1950
1716=end table 1951=end table
1717 1952
1718=item B<< C<Ps = 1021> >> (B<rxvt>) 1953=item B<< C<Pm = 1021> >> (B<rxvt>)
1719 1954
1720=begin table 1955=begin table
1721 1956
1722 B<< C<h> >> Bold/italic implies high intensity (see option B<-is>) 1957 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) 1958 B<< C<l> >> Font styles have no effect on intensity (Compile styles)
1724 1959
1725=end table 1960=end table
1726 1961
1727=item B<< C<Ps = 1047> >> 1962=item B<< C<Pm = 1047> >>
1728 1963
1729=begin table 1964=begin table
1730 1965
1731 B<< C<h> >> Use Alternate Screen Buffer 1966 B<< C<h> >> Use Alternate Screen Buffer
1732 B<< C<l> >> Use Normal Screen Buffer - clear Alternate Screen Buffer if returning from it 1967 B<< C<l> >> Use Normal Screen Buffer - clear Alternate Screen Buffer if returning from it
1733 1968
1734=end table 1969=end table
1735 1970
1736=item B<< C<Ps = 1048> >> 1971=item B<< C<Pm = 1048> >>
1737 1972
1738=begin table 1973=begin table
1739 1974
1740 B<< C<h> >> Save cursor position 1975 B<< C<h> >> Save cursor position
1741 B<< C<l> >> Restore cursor position 1976 B<< C<l> >> Restore cursor position
1742 1977
1743=end table 1978=end table
1744 1979
1745=item B<< C<Ps = 1049> >> 1980=item B<< C<Pm = 1049> >>
1746 1981
1747=begin table 1982=begin table
1748 1983
1749 B<< C<h> >> Use Alternate Screen Buffer - clear Alternate Screen Buffer if switching to it 1984 B<< C<h> >> Use Alternate Screen Buffer - clear Alternate Screen Buffer if switching to it
1750 B<< C<l> >> Use Normal Screen Buffer 1985 B<< C<l> >> Use Normal Screen Buffer
1751 1986
1752=end table 1987=end table
1753 1988
1989=item B<< C<Pm = 2004> >>
1990
1991=begin table
1992
1993 B<< C<h> >> Enable bracketed paste mode - prepend / append to the pasted text the control sequences C<ESC [ 200 ~> / C<ESC [ 201 ~>
1994 B<< C<l> >> Disable bracketed paste mode
1995
1996=end table
1997
1754=back 1998=back
1755 1999
1756=back 2000=back
1757 2001
1758X<XTerm> 2002X<XTerm>
1759 2003
1760=head1 XTerm Operating System Commands 2004=head2 XTerm Operating System Commands
1761 2005
1762=over 4 2006=over 4
1763 2007
1764=item B<< C<ESC ] Ps;Pt ST> >> 2008=item B<< C<ESC ] Ps;Pt ST> >>
1765 2009
1772 B<< C<Ps = 0> >> Change Icon Name and Window Title to B<< C<Pt> >> 2016 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> >> 2017 B<< C<Ps = 1> >> Change Icon Name to B<< C<Pt> >>
1774 B<< C<Ps = 2> >> Change Window Title to B<< C<Pt> >> 2018 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. 2019 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 2020 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)> 2021 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)> 2022 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> >> 2023 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> >> 2024 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> >> 2025 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] 2026 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). 2027 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> >>. 2028 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> 2029 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> >>. 2030 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> >> 2031 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> >> 2032 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). 2033 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>. 2034 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> >> 2035 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). 2036 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> >> 2037 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> >> 2038 B<< C<Ps = 707> >> Change colour of underlined characters to B<< C<Pt> >>
2039 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>. 2040 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). 2041 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). 2042 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). 2043 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). 2044 B<< C<Ps = 720> >> Move viewing window up by B<< C<Pt> >> lines, or clear scrollback buffer if C<Pt = 0> (Compile frills).
1803 2047
1804=end table 2048=end table
1805 2049
1806=back 2050=back
1807 2051
1808X<XPM> 2052=head1 BACKGROUND IMAGE
1809 2053
1810=head1 XPM
1811
1812For the XPM XTerm escape sequence B<< C<ESC ] 20 ; Pt ST> >> then value 2054For 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 2055of 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 2056sequence of scaling/positioning commands separated by semi-colons. The
1815scaling/positioning commands are as follows: 2057scaling/positioning commands are as follows:
1816 2058
1817=over 4 2059=over 4
1818 2060
1856 2098
1857For example: 2099For example:
1858 2100
1859=over 4 2101=over 4
1860 2102
1861=item B<\E]20;funky\a> 2103=item B<\E]20;funky.jpg\a>
1862 2104
1863load B<funky.xpm> as a tiled image 2105load B<funky.jpg> as a tiled image
1864 2106
1865=item B<\E]20;mona;100\a> 2107=item B<\E]20;mona.jpg;100\a>
1866 2108
1867load B<mona.xpm> with a scaling of 100% 2109load B<mona.jpg> with a scaling of 100%
1868 2110
1869=item B<\E]20;;200;?\a> 2111=item B<\E]20;;200;?\a>
1870 2112
1871rescale the current pixmap to 200% and display the image geometry in 2113rescale the current pixmap to 200% and display the image geometry in
1872the title 2114the title
1873 2115
1874=back 2116=back
2117
1875X<Mouse> 2118X<Mouse>
1876 2119
1877=head1 Mouse Reporting 2120=head1 Mouse Reporting
1878 2121
1879=over 4 2122=over 4
1911=begin table 2154=begin table
1912 2155
1913 4 Shift 2156 4 Shift
1914 8 Meta 2157 8 Meta
1915 16 Control 2158 16 Control
1916 32 Double Click I<(Rxvt extension)> 2159 32 Double Click I<(rxvt extension)>
1917 2160
1918=end table 2161=end table
1919 2162
1920Col = B<< C<< <x> - SPACE >> >> 2163Col = B<< C<< <x> - SPACE >> >>
1921 2164
1922Row = B<< C<< <y> - SPACE >> >> 2165Row = B<< C<< <y> - SPACE >> >>
1923 2166
1924=back 2167=back
2168
2169=head1 Key Codes
2170
1925X<KeyCodes> 2171X<KeyCodes>
1926
1927=head1 Key Codes
1928 2172
1929Note: B<Shift> + B<F1>-B<F10> generates B<F11>-B<F20> 2173Note: B<Shift> + B<F1>-B<F10> generates B<F11>-B<F20>
1930 2174
1931For the keypad, use B<Shift> to temporarily override Application-Keypad 2175For the keypad, use B<Shift> to temporarily override Application-Keypad
1932setting use B<Num_Lock> to toggle Application-Keypad setting if 2176setting use B<Num_Lock> to toggle Application-Keypad setting if
1999 2243
2000=head1 CONFIGURE OPTIONS 2244=head1 CONFIGURE OPTIONS
2001 2245
2002General hint: if you get compile errors, then likely your configuration 2246General hint: if you get compile errors, then likely your configuration
2003hasn't been tested well. Either try with C<--enable-everything> or use 2247hasn'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 2248the 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 2249switches). 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 2250work, so it can be fixed. Marc Lehmann <rxvt@schmorp.de>.
2007Lehmann <rxvt@schmorp.de>.
2008 2251
2009All 2252All
2010 2253
2011=over 4 2254=over 4
2012 2255
2013=item --enable-everything 2256=item --enable-everything
2014 2257
2015Add (or remove) support for all non-multichoice options listed in "./configure 2258Add (or remove) support for all non-multichoice options listed
2016--help". 2259in C<./configure --help>, except for C<--enable-assert> and
2260C<--enable-256-color>.
2017 2261
2018You can specify this and then disable options you do not like by 2262You can specify this and then disable options you do not like by
2019I<following> this with the appropriate C<--disable-...> arguments, 2263I<following> this with the appropriate C<--disable-...> arguments,
2020or you can start with a minimal configuration by specifying 2264or you can start with a minimal configuration by specifying
2021C<--disable-everything> and than adding just the C<--enable-...> arguments 2265C<--disable-everything> and than adding just the C<--enable-...> arguments
2044 2288
2045=begin table 2289=begin table
2046 2290
2047 all all available codeset groups 2291 all all available codeset groups
2048 zh common chinese encodings 2292 zh common chinese encodings
2049 zh_ext rarely used but very big chinese encodigs 2293 zh_ext rarely used but very big chinese encodings
2050 jp common japanese encodings 2294 jp common japanese encodings
2051 jp_ext rarely used but big japanese encodings 2295 jp_ext rarely used but big japanese encodings
2052 kr korean encodings 2296 kr korean encodings
2053 2297
2054=end table 2298=end table
2068requirements per character from 2 to 4 bytes. X11 fonts do not yet 2312requirements per character from 2 to 4 bytes. X11 fonts do not yet
2069support these extra characters, but Xft does. 2313support these extra characters, but Xft does.
2070 2314
2071Please note that rxvt-unicode can store unicode code points >65535 2315Please note that rxvt-unicode can store unicode code points >65535
2072even without this flag, but the number of such characters is 2316even without this flag, but the number of such characters is
2073limited to a view thousand (shared with combining characters, 2317limited to a few thousand (shared with combining characters,
2074see next switch), and right now rxvt-unicode cannot display them 2318see next switch), and right now rxvt-unicode cannot display them
2075(input/output and cut&paste still work, though). 2319(input/output and cut&paste still work, though).
2076 2320
2077=item --enable-combining (default: on) 2321=item --enable-combining (default: on)
2078 2322
2079Enable automatic composition of combining characters into 2323Enable automatic composition of combining characters into
2080composite characters. This is required for proper viewing of text 2324composite characters. This is required for proper viewing of text
2081where accents are encoded as seperate unicode characters. This is 2325where accents are encoded as separate unicode characters. This is
2082done by using precomposited characters when available or creating 2326done by using precomposited characters when available or creating
2083new pseudo-characters when no precomposed form exists. 2327new pseudo-characters when no precomposed form exists.
2084 2328
2085Without --enable-unicode3, the number of additional precomposed 2329Without --enable-unicode3, the number of additional precomposed
2086characters is somewhat limited (the 6400 private use characters will be 2330characters is somewhat limited (the 6400 private use characters will be
2101=item --with-res-name=NAME (default: urxvt) 2345=item --with-res-name=NAME (default: urxvt)
2102 2346
2103Use the given name as default application name when 2347Use the given name as default application name when
2104reading resources. Specify --with-res-name=rxvt to replace rxvt. 2348reading resources. Specify --with-res-name=rxvt to replace rxvt.
2105 2349
2106=item --with-res-class=CLASS /default: URxvt) 2350=item --with-res-class=CLASS (default: URxvt)
2107 2351
2108Use the given class as default application class 2352Use the given class as default application class
2109when reading resources. Specify --with-res-class=Rxvt to replace 2353when reading resources. Specify --with-res-class=Rxvt to replace
2110rxvt. 2354rxvt.
2111 2355
2124 2368
2125Write user and tty to lastlog file (used by programs like 2369Write user and tty to lastlog file (used by programs like
2126F<lastlogin>) at start of rxvt execution. This option requires 2370F<lastlogin>) at start of rxvt execution. This option requires
2127--enable-utmp to also be specified. 2371--enable-utmp to also be specified.
2128 2372
2129=item --enable-xpm-background (default: on) 2373=item --enable-afterimage (default: on)
2130 2374
2131Add support for XPM background pixmaps. 2375Add support for libAfterImage to be used for transparency and background
2376images. It adds support for many file formats including JPG, PNG,
2377SVG, TIFF, GIF, XPM, BMP, ICO, XCF, TGA and AfterStep image XML
2378(L<http://www.afterstep.org/visualdoc.php?show=asimagexml>).
2379
2380This option also adds such eye candy as blending an image over the root
2381background, as well as dynamic scaling and bluring of background images.
2382
2383Note that with this option enabled, @@RXVT_NAME@@'s memory footprint might
2384increase by a few megabytes even if no extra features are used (mostly due
2385to third-party libraries used by libAI). Memory footprint may somewhat be
2386lowered if libAfterImage is configured without support for SVG.
2132 2387
2133=item --enable-transparency (default: on) 2388=item --enable-transparency (default: on)
2134 2389
2135Add support for inheriting parent backgrounds thus giving a fake 2390Add support for backgrounds, creating illusion of transparency in the term.
2136transparency to the term.
2137 2391
2138=item --enable-fading (default: on) 2392=item --enable-fading (default: on)
2139 2393
2140Add support for fading the text when focus is lost (requires C<--enable-transparency>). 2394Add 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 2395
2146=item --enable-rxvt-scroll (default: on) 2396=item --enable-rxvt-scroll (default: on)
2147 2397
2148Add support for the original rxvt scrollbar. 2398Add support for the original rxvt scrollbar.
2149 2399
2152Add support for a NeXT-like scrollbar. 2402Add support for a NeXT-like scrollbar.
2153 2403
2154=item --enable-xterm-scroll (default: on) 2404=item --enable-xterm-scroll (default: on)
2155 2405
2156Add support for an Xterm-like scrollbar. 2406Add 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 2407
2169=item --disable-backspace-key 2408=item --disable-backspace-key
2170 2409
2171Removes any handling of the backspace key by us - let the X server do it. 2410Removes any handling of the backspace key by us - let the X server do it.
2172 2411
2192A non-exhaustive list of features enabled by C<--enable-frills> (possibly 2431A non-exhaustive list of features enabled by C<--enable-frills> (possibly
2193in combination with other switches) is: 2432in combination with other switches) is:
2194 2433
2195 MWM-hints 2434 MWM-hints
2196 EWMH-hints (pid, utf8 names) and protocols (ping) 2435 EWMH-hints (pid, utf8 names) and protocols (ping)
2436 urgency hint
2197 seperate underline colour (-underlineColor) 2437 separate underline colour (-underlineColor)
2198 settable border widths and borderless switch (-w, -b, -bl) 2438 settable border widths and borderless switch (-w, -b, -bl)
2199 visual depth selection (-depth) 2439 visual depth selection (-depth)
2200 settable extra linespacing /-lsp) 2440 settable extra linespacing (-lsp)
2201 iso-14755-2 and -3, and visual feedback 2441 iso-14755 5.1 (basic) support
2202 tripleclickwords (-tcw) 2442 tripleclickwords (-tcw)
2203 settable insecure mode (-insecure) 2443 settable insecure mode (-insecure)
2204 keysym remapping support 2444 keysym remapping support
2205 cursor blinking and underline cursor (-cb, -uc) 2445 cursor blinking and underline cursor (-bc, -uc)
2206 XEmbed support (-embed) 2446 XEmbed support (-embed)
2207 user-pty (-pty-fd) 2447 user-pty (-pty-fd)
2208 hold on exit (-hold) 2448 hold on exit (-hold)
2449 compile in built-in block graphics
2209 skip builtin block graphics (-sbg) 2450 skip builtin block graphics (-sbg)
2451 separate highlight colour (-highlightColor, -highlightTextColor)
2210 2452
2211It also enabled some non-essential features otherwise disabled, such as: 2453It also enables some non-essential features otherwise disabled, such as:
2212 2454
2213 some round-trip time optimisations 2455 some round-trip time optimisations
2214 nearest color allocation on pseudocolor screens 2456 nearest colour allocation on pseudocolor screens
2215 UTF8_STRING supporr for selection 2457 UTF8_STRING support for selection
2216 sgr modes 90..97 and 100..107 2458 sgr modes 90..97 and 100..107
2217 backindex and forwardindex escape sequences 2459 backindex and forwardindex escape sequences
2218 view change/zero scorllback esacpe sequences 2460 view change/zero scrollback escape sequences
2219 locale switching escape sequence 2461 locale switching escape sequence
2220 window op and some xterm/OSC escape sequences 2462 window op and some xterm/OSC escape sequences
2221 rectangular selections 2463 rectangular selections
2222 trailing space removal for selections 2464 trailing space removal for selections
2223 verbose X error handling 2465 verbose X error handling
2224 2466
2225=item --enable-iso14755 (default: on) 2467=item --enable-iso14755 (default: on)
2226 2468
2227Enable extended ISO 14755 support (see @@RXVT_NAME@@(1), or 2469Enable extended ISO 14755 support (see @@RXVT_NAME@@(1)).
2228F<doc/rxvt.1.txt>). Basic support (section 5.1) is enabled by 2470Basic 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 2471support for 5.2, 5.3 and 5.4 is enabled with this switch.
2230this switch.
2231 2472
2232=item --enable-keepscrolling (default: on) 2473=item --enable-keepscrolling (default: on)
2233 2474
2234Add support for continual scrolling of the display when you hold 2475Add support for continual scrolling of the display when you hold
2235the mouse button down on a scrollbar arrow. 2476the mouse button down on a scrollbar arrow.
2477
2478=item --enable-selectionscrolling (default: on)
2479
2480Add support for scrolling when the selection moves to the top or
2481bottom of the screen.
2236 2482
2237=item --enable-mousewheel (default: on) 2483=item --enable-mousewheel (default: on)
2238 2484
2239Add support for scrolling via mouse wheel or buttons 4 & 5. 2485Add support for scrolling via mouse wheel or buttons 4 & 5.
2240 2486
2242 2488
2243Add support for continual scrolling (using the mouse wheel as an 2489Add support for continual scrolling (using the mouse wheel as an
2244accelerator) while the control key is held down. This option 2490accelerator) while the control key is held down. This option
2245requires --enable-mousewheel to also be specified. 2491requires --enable-mousewheel to also be specified.
2246 2492
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) 2493=item --enable-smart-resize (default: off)
2267 2494
2268Add smart growth/shrink behaviour when changing font size via hot 2495Add smart growth/shrink behaviour when resizing.
2269keys. This should keep the window corner which is closest to a corner of 2496This should keep the window corner which is closest to a corner of
2270the screen in a fixed position. 2497the screen in a fixed position.
2271 2498
2499=item --enable-text-blink (default: on)
2500
2501Add support for blinking text.
2502
2272=item --enable-pointer-blank (default: on) 2503=item --enable-pointer-blank (default: on)
2273 2504
2274Add support to have the pointer disappear when typing or inactive. 2505Add support to have the pointer disappear when typing or inactive.
2275 2506
2276=item --enable-perl (default: on) 2507=item --enable-perl (default: on)
2277 2508
2278Enable an embedded perl interpreter. See the B<@@RXVT_NAME@@perl(3)> 2509Enable 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 2510manpage 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 2511for the extensions that are installed by default.
2281perl interpreter that is used can be specified via the C<PERL> environment 2512The perl interpreter that is used can be specified via the C<PERL>
2282variable when running configure. 2513environment variable when running configure. Even when compiled in,
2514perl will I<not> be initialised when all extensions have been disabled
2515C<-pe "" --perl-ext-common "">, so it should be safe to enable from a
2516resource standpoint.
2517
2518=item --enable-assert (default: off)
2519
2520Enables the assertions in the code, normally disabled. This switch is only
2521useful when developing rxvt-unicode.
2522
2523=item --enable-256-color (default: off)
2524
2525Force use of so-called 256 colour mode, to work around buggy applications
2526that do not support termcap/terminfo, or simply improve support for
2527applications hardcoding the xterm 256 colour table.
2528
2529This switch breaks termcap/terminfo compatibility to C<TERM=rxvt-unicode>,
2530and consequently sets C<TERM> to C<rxvt-unicode-256color> by default
2531(F<doc/etc/> contains termcap/terminfo definitions for both).
2532
2533It also results in higher memory usage and can slow down @@RXVT_NAME@@
2534dramatically when more than six fonts are in use by a terminal instance.
2535
2536=item --with-afterimage-config=DIR
2537
2538Look for the libAfterImage config script in DIR.
2283 2539
2284=item --with-name=NAME (default: urxvt) 2540=item --with-name=NAME (default: urxvt)
2285 2541
2286Set the basename for the installed binaries, resulting 2542Set the basename for the installed binaries, resulting
2287in C<urxvt>, C<urxvtd> etc.). Specify C<--with-name=rxvt> to replace with 2543in C<urxvt>, C<urxvtd> etc.). Specify C<--with-name=rxvt> to replace with
2297PATH. 2553PATH.
2298 2554
2299=item --with-x 2555=item --with-x
2300 2556
2301Use the X Window System (pretty much default, eh?). 2557Use 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 2558
2315=back 2559=back
2316 2560
2317=head1 AUTHORS 2561=head1 AUTHORS
2318 2562

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines