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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines