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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines