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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines