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.105 by root, Tue Jan 31 21:00:26 2006 UTC vs.
Revision 1.247 by root, Sat Aug 8 23:39:25 2020 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
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>.
23 26
24=head1 RXVT-UNICODE/URXVT 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
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 :).
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.
34 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
73=head3 How can I start @@URXVT_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<@@URXVT_NAME@@d -f -o>, which tells @@URXVT_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?
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.
79 111
80The original rxvt and rxvt-unicode always export the variable "COLORTERM", 112The original rxvt and rxvt-unicode always export the variable "COLORTERM",
81so you can check and see if that is set. Note that several programs, JED, 113so you can check and see if that is set. Note that several programs, JED,
82slrn, Midnight Commander automatically check this variable to decide 114slrn, Midnight Commander automatically check this variable to decide
83whether or not 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 @@URXVT_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 @@URXVT_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 @@URXVT_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 @@URXVT_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
488=head3 Why is the cursor now blinking in emacs/vi/...?
489
490This is likely caused by your editor/program's use of the C<cvvis>
491terminfo capability. Emacs uses it by default, as well as some versions of
492vi and possibly other programs.
493
494In emacs, you can switch that off by adding this to your C<.emacs> file:
495
496 (setq visible-cursor nil)
497
498For other programs, if they do not have an option, your have to remove the
499C<cvvis> capability from the terminfo description.
500
501When @@URXVT_NAME@@ first added the blinking cursor option, it didn't
502add a C<cvvis> capability, which served no purpose before. Version 9.21
503introduced C<cvvis> (and the ability to control blinking independent of
504cursor shape) for compatibility with other terminals, which traditionally
505use a blinking cursor for C<cvvis>. This also reflects the intent of
506programs such as emacs, who expect C<cvvis> to enable a blinking cursor.
447 507
448=head2 Keyboard, Mouse & User Interaction 508=head2 Keyboard, Mouse & User Interaction
449 509
450=head3 The new selection selects pieces that are too big, how can I select single words? 510=head3 The new selection selects pieces that are too big, how can I select single words?
451 511
459 519
460To get a selection that is very similar to the old code, try this pattern: 520To get a selection that is very similar to the old code, try this pattern:
461 521
462 URxvt.selection.pattern-0: ([^"&'()*,;<=>?@[\\\\]^`{|})]+) 522 URxvt.selection.pattern-0: ([^"&'()*,;<=>?@[\\\\]^`{|})]+)
463 523
464Please also note that the I<LeftClick Shift-LeftClik> combination also 524Please also note that the I<LeftClick Shift-LeftClick> combination also
465selects words like the old code. 525selects words like the old code.
466 526
467=head3 I don't like the new selection/popups/hotkeys/perl, how do I change/disable it? 527=head3 I don't like the new selection/popups/hotkeys/perl, how do I change/disable it?
468 528
469You can disable the perl extension completely by setting the 529You can disable the perl extension completely by setting the
479 URxvt.perl-ext-common: default,-selection-popup,-option-popup 539 URxvt.perl-ext-common: default,-selection-popup,-option-popup
480 540
481This will keep the default extensions, but disable the two popup 541This will keep the default extensions, but disable the two popup
482extensions. Some extensions can also be configured, for example, 542extensions. Some extensions can also be configured, for example,
483scrollback search mode is triggered by B<M-s>. You can move it to any 543scrollback search mode is triggered by B<M-s>. You can move it to any
484other combination either by setting the B<searchable-scrollback> resource: 544other combination by adding a B<keysym> resource that binds the desired
545combination to the C<start> action of C<searchable-scrollback> and another
546one that binds B<M-s> to the C<builtin:> action:
485 547
486 URxvt.searchable-scrollback: CM-s 548 URxvt.keysym.CM-s: searchable-scrollback:start
549 URxvt.keysym.M-s: builtin:
487 550
488=head3 The cursor moves when selecting text in the current input line, how do I switch this off? 551=head3 The cursor moves when selecting text in the current input line, how do I switch this off?
489 552
490See next entry. 553See next entry.
491 554
495circumstances, it will move your cursor around when you click into the 558circumstances, 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, 559line 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 560but when running a program that doesn't parse cursor movements or in some
498cases during rlogin sessions, it fails to detect this properly. 561cases during rlogin sessions, it fails to detect this properly.
499 562
500You can permamently switch this feature off by disabling the C<readline> 563You can permanently switch this feature off by disabling the C<readline>
501extension: 564extension:
502 565
503 URxvt.perl-ext-common: default,-readline 566 URxvt.perl-ext-common: default,-readline
504 567
505=head3 My numerical keypad acts weird and generates differing output? 568=head3 My numeric keypad acts weird and generates differing output?
506 569
507Some Debian GNUL/Linux users seem to have this problem, although no 570Some Debian GNU/Linux users seem to have this problem, although no
508specific details were reported so far. It is possible that this is caused 571specific 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 572by 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 573this 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 574keymap. See the answer to the previous question, and please report if that
512helped. 575helped.
513 576
514=head3 My Compose (Multi_key) key is no longer working. 577=head3 My Compose (Multi_key) key is no longer working.
515 578
516The most common causes for this are that either your locale is not set 579The 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 580correctly, or you specified a B<preeditType> that is not supported by
518your input method. For example, if you specified B<OverTheSpot> and 581your input method. For example, if you specified B<OverTheSpot> and
519your input method (e.g. the default input method handling Compose keys) 582your input method (e.g. the default input method handling Compose keys)
520does not support this (for instance because it is not visual), then 583does not support this (for instance because it is not visual), then
521rxvt-unicode will continue without an input method. 584rxvt-unicode will continue without an input method.
522 585
523In this case either do not specify a B<preeditStyle> or specify more than 586In this case either do not specify a B<preeditType> or specify more than
524one pre-edit style, such as B<OverTheSpot,Root,None>. 587one pre-edit style, such as B<OverTheSpot,Root,None>.
588
589If it still doesn't work, then maybe your input method doesn't support
590compose sequences - to fall back to the built-in one, make sure you don't
591specify an input method via C<-im> or C<XMODIFIERS>.
525 592
526=head3 I cannot type C<Ctrl-Shift-2> to get an ASCII NUL character due to ISO 14755 593=head3 I cannot type C<Ctrl-Shift-2> to get an ASCII NUL character due to ISO 14755
527 594
528Either try C<Ctrl-2> alone (it often is mapped to ASCII NUL even on 595Either try C<Ctrl-2> alone (it often is mapped to ASCII NUL even on
529international keyboards) or simply use ISO 14755 support to your 596international keyboards) or simply use ISO 14755 support to your
532character and so on. 599character and so on.
533 600
534=head3 Mouse cut/paste suddenly no longer works. 601=head3 Mouse cut/paste suddenly no longer works.
535 602
536Make sure that mouse reporting is actually turned off since killing 603Make sure that mouse reporting is actually turned off since killing
537some editors prematurely may leave the mouse in mouse report mode. I've 604some editors prematurely may leave it active. I've
538heard that tcsh may use mouse reporting unless it otherwise specified. A 605heard 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 606quick check is to see if cut/paste works when the Alt or Shift keys are
540depressed. 607pressed.
541 608
542=head3 What's with the strange Backspace/Delete key behaviour? 609=head3 What's with the strange Backspace/Delete key behaviour?
543 610
544Assuming that the physical Backspace key corresponds to the 611Assuming that the physical Backspace key corresponds to the
545BackSpace keysym (not likely for Linux ... see the following 612Backspace keysym (not likely for Linux ... see the following
546question) there are two standard values that can be used for 613question) there are two standard values that can be used for
547Backspace: C<^H> and C<^?>. 614Backspace: C<^H> and C<^?>.
548 615
549Historically, either value is correct, but rxvt-unicode adopts the debian 616Historically, either value is correct, but rxvt-unicode adopts the debian
550policy of using C<^?> when unsure, because it's the one only only correct 617policy of using C<^?> when unsure, because it's the one and only correct
551choice :). 618choice :).
552 619
553Rxvt-unicode tries to inherit the current stty settings and uses the value 620It 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 621private 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 622
561 # use Backspace = ^H 623 # use Backspace = ^H
562 $ stty erase ^H 624 $ stty erase ^H
563 $ @@URXVT_NAME@@ 625 $ printf "\e[?67h"
564 626
565 # use Backspace = ^? 627 # use Backspace = ^?
566 $ stty erase ^? 628 $ stty erase ^?
567 $ @@URXVT_NAME@@ 629 $ 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 630
581This helps satisfy some of the Backspace discrepancies that occur, but 631This helps satisfy some of the Backspace discrepancies that occur, but
582if you use Backspace = C<^H>, make sure that the termcap/terminfo value 632if you use Backspace = C<^H>, make sure that the termcap/terminfo value
583properly reflects that. 633properly reflects that.
584 634
587key has been assigned an escape sequence to match the vt100 for Execute 637key has been assigned an escape sequence to match the vt100 for Execute
588(C<ESC [ 3 ~>) and is in the supplied termcap/terminfo. 638(C<ESC [ 3 ~>) and is in the supplied termcap/terminfo.
589 639
590Some other Backspace problems: 640Some other Backspace problems:
591 641
592some editors use termcap/terminfo, 642some editors use termcap/terminfo,
593some editors (vim I'm told) expect Backspace = ^H, 643some editors (vim I'm told) expect Backspace = ^H,
594GNU Emacs (and Emacs-like editors) use ^H for help. 644GNU Emacs (and Emacs-like editors) use ^H for help.
595 645
596Perhaps someday this will all be resolved in a consistent manner. 646Perhaps someday this will all be resolved in a consistent manner.
597 647
601you have run "configure" with the C<--disable-resources> option you can 651you have run "configure" with the C<--disable-resources> option you can
602use the `keysym' resource to alter the keystrings associated with keysyms. 652use the `keysym' resource to alter the keystrings associated with keysyms.
603 653
604Here's an example for a URxvt session started using C<@@URXVT_NAME@@ -name URxvt> 654Here's an example for a URxvt session started using C<@@URXVT_NAME@@ -name URxvt>
605 655
656 URxvt.keysym.Prior: \033[5~
657 URxvt.keysym.Next: \033[6~
606 URxvt.keysym.Home: \033[1~ 658 URxvt.keysym.Home: \033[7~
607 URxvt.keysym.End: \033[4~ 659 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> 660 URxvt.keysym.Up: \033[A
620 URxvt.keysym.M-Down: \033<M-Down> 661 URxvt.keysym.Down: \033[B
662 URxvt.keysym.Right: \033[C
621 URxvt.keysym.M-Left: \033<M-Left> 663 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 664
627See some more examples in the documentation for the B<keysym> resource. 665See some more examples in the documentation for the B<keysym> resource.
628 666
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 667=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 668
638Rather than have rxvt-unicode try to accommodate all the various possible 676Rather than have rxvt-unicode try to accommodate all the various possible
639keyboard mappings, it is better to use `xmodmap' to remap the keys as 677keyboard mappings, it is better to use `xmodmap' to remap the keys as
640required for your particular machine. 678required for your particular machine.
641 679
642 680
643
644=head2 Terminal Configuration 681=head2 Terminal Configuration
682
683=head3 Can I see a typical configuration?
684
685The default configuration tries to be xterm-like, which I don't like that
686much, but it's least surprise to regular users.
687
688As a rxvt or rxvt-unicode user, you are practically supposed to invest
689time into customising your terminal. To get you started, here is the
690author's .Xdefaults entries, with comments on what they do. It's certainly
691not I<typical>, but what's typical...
692
693 URxvt.cutchars: "()*,<>[]{}|'
694 URxvt.print-pipe: cat >/some/path
695
696These are just for testing stuff.
697
698 URxvt.imLocale: ja_JP.UTF-8
699 URxvt.preeditType: OnTheSpot,None
700
701This tells rxvt-unicode to use a special locale when communicating with
702the X Input Method, and also tells it to only use the OnTheSpot pre-edit
703type, which requires the C<xim-onthespot> perl extension but rewards me
704with correct-looking fonts.
705
706 URxvt.perl-lib: /root/lib/urxvt
707 URxvt.perl-ext-common: default,selection-autotransform,selection-pastebin,xim-onthespot,remote-clipboard
708 URxvt.selection.pattern-0: ( at .*? line \\d+)
709 URxvt.selection.pattern-1: ^(/[^:]+):\
710 URxvt.selection-autotransform.0: s/^([^:[:space:]]+):(\\d+):?$/:e \\Q$1\\E\\x0d:$2\\x0d/
711 URxvt.selection-autotransform.1: s/^ at (.*?) line (\\d+)$/:e \\Q$1\\E\\x0d:$2\\x0d/
712
713This is my perl configuration. The first two set the perl library
714directory and also tells urxvt to use a large number of extensions. I
715develop for myself mostly, so I actually use most of the extensions I
716write.
717
718The selection stuff mainly makes the selection perl-error-message aware
719and tells it to convert perl error messages into vi-commands to load the
720relevant file and go to the error line number.
721
722 URxvt.scrollstyle: plain
723 URxvt.secondaryScroll: true
724
725As the documentation says: plain is the preferred scrollbar for the
726author. The C<secondaryScroll> configures urxvt to scroll in full-screen
727apps, like screen, so lines scrolled out of screen end up in urxvt's
728scrollback buffer.
729
730 URxvt.background: #000000
731 URxvt.foreground: gray90
732 URxvt.color7: gray90
733 URxvt.colorBD: #ffffff
734 URxvt.cursorColor: #e0e080
735 URxvt.throughColor: #8080f0
736 URxvt.highlightColor: #f0f0f0
737
738Some colours. Not sure which ones are being used or even non-defaults, but
739these are in my .Xdefaults. Most notably, they set foreground/background
740to light gray/black, and also make sure that the colour 7 matches the
741default foreground colour.
742
743 URxvt.underlineColor: yellow
744
745Another colour, makes underline lines look different. Sometimes hurts, but
746is mostly a nice effect.
747
748 URxvt.geometry: 154x36
749 URxvt.loginShell: false
750 URxvt.meta: ignore
751 URxvt.utmpInhibit: true
752
753Uh, well, should be mostly self-explanatory. By specifying some defaults
754manually, I can quickly switch them for testing.
755
756 URxvt.saveLines: 8192
757
758A large scrollback buffer is essential. Really.
759
760 URxvt.mapAlert: true
761
762The only case I use it is for my IRC window, which I like to keep
763iconified till people msg me (which beeps).
764
765 URxvt.visualBell: true
766
767The audible bell is often annoying, especially when in a crowd.
768
769 URxvt.insecure: true
770
771Please don't hack my mutt! Ooops...
772
773 URxvt.pastableTabs: false
774
775I once thought this is a great idea.
776
777 urxvt.font: 9x15bold,\
778 -misc-fixed-bold-r-normal--15-140-75-75-c-90-iso10646-1,\
779 -misc-fixed-medium-r-normal--15-140-75-75-c-90-iso10646-1, \
780 [codeset=JISX0208]xft:Kochi Gothic, \
781 xft:Bitstream Vera Sans Mono:autohint=true, \
782 xft:Code2000:antialias=false
783 urxvt.boldFont: -xos4-terminus-bold-r-normal--14-140-72-72-c-80-iso8859-15
784 urxvt.italicFont: xft:Bitstream Vera Sans Mono:italic:autohint=true
785 urxvt.boldItalicFont: xft:Bitstream Vera Sans Mono:bold:italic:autohint=true
786
787I wrote rxvt-unicode to be able to specify fonts exactly. So don't be
788overwhelmed. A special note: the C<9x15bold> mentioned above is actually
789the version from XFree-3.3, as XFree-4 replaced it by a totally different
790font (different glyphs for C<;> and many other harmless characters),
791while the second font is actually the C<9x15bold> from XFree4/XOrg. The
792bold version has less chars than the medium version, so I use it for rare
793characters, too. When editing sources with vim, I use italic for comments
794and other stuff, which looks quite good with Bitstream Vera anti-aliased.
795
796Terminus is a quite bad font (many very wrong glyphs), but for most of my
797purposes, it works, and gives a different look, as my normal (Non-bold)
798font is already bold, and I want to see a difference between bold and
799normal fonts.
800
801Please note that I used the C<urxvt> instance name and not the C<URxvt>
802class name. That is because I use different configs for different purposes,
803for example, my IRC window is started with C<-name IRC>, and uses these
804defaults:
805
806 IRC*title: IRC
807 IRC*geometry: 87x12+535+542
808 IRC*saveLines: 0
809 IRC*mapAlert: true
810 IRC*font: suxuseuro
811 IRC*boldFont: suxuseuro
812 IRC*colorBD: white
813 IRC*keysym.M-C-1: command:\033]710;suxuseuro\007\033]711;suxuseuro\007
814 IRC*keysym.M-C-2: command:\033]710;9x15bold\007\033]711;9x15bold\007
815
816C<Alt-Ctrl-1> and C<Alt-Ctrl-2> switch between two different font
817sizes. C<suxuseuro> allows me to keep an eye (and actually read)
818stuff while keeping a very small window. If somebody pastes something
819complicated (e.g. japanese), I temporarily switch to a larger font.
820
821The above is all in my C<.Xdefaults> (I don't use C<.Xresources> nor
822C<xrdb>). I also have some resources in a separate C<.Xdefaults-hostname>
823file for different hosts, for example, on my main desktop, I use:
824
825 URxvt.keysym.C-M-q: command:\033[3;5;5t
826 URxvt.keysym.C-M-y: command:\033[3;5;606t
827 URxvt.keysym.C-M-e: command:\033[3;1605;5t
828 URxvt.keysym.C-M-c: command:\033[3;1605;606t
829 URxvt.keysym.C-M-p: perl:test
830
831The first for keysym definitions allow me to quickly bring some windows
832in the layout I like most. Ion users might start laughing but will stop
833immediately when I tell them that I use my own Fvwm2 module for much the
834same effect as Ion provides, and I only very rarely use the above key
835combinations :->
645 836
646=head3 Why doesn't rxvt-unicode read my resources? 837=head3 Why doesn't rxvt-unicode read my resources?
647 838
648Well, why, indeed? It does, in a way very similar to other X 839Well, why, indeed? It does, in a way very similar to other X
649applications. Most importantly, this means that if you or your OS loads 840applications. Most importantly, this means that if you or your OS loads
658Also consider the form resources have to use: 849Also consider the form resources have to use:
659 850
660 URxvt.resource: value 851 URxvt.resource: value
661 852
662If you want to use another form (there are lots of different ways of 853If you want to use another form (there are lots of different ways of
663specifying resources), make sure you understand wether and why it 854specifying resources), make sure you understand whether and why it
664works. If unsure, use the form above. 855works. If unsure, use the form above.
665 856
666=head3 When I log-in to another system it tells me about missing terminfo data? 857=head3 When I log-in to another system it tells me about missing terminfo data?
667 858
668The terminal description used by rxvt-unicode is not as widely available 859The 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). 860as that for xterm, or even rxvt (for which the same problem often arises).
670 861
671The correct solution for this problem is to install the terminfo, this can 862The correct solution for this problem is to install the terminfo, this can
672be done like this (with ncurses' infocmp): 863be done by simply installing rxvt-unicode on the remote system as well
864(in case you have a nice package manager ready), or you can install the
865terminfo database manually like this (with ncurses infocmp. works as
866user and root):
673 867
674 REMOTE=remotesystem.domain 868 REMOTE=remotesystem.domain
675 infocmp rxvt-unicode | ssh $REMOTE "cat >/tmp/ti && tic /tmp/ti" 869 infocmp rxvt-unicode | ssh $REMOTE "mkdir -p .terminfo && cat >/tmp/ti && tic /tmp/ti"
676 870
677... or by installing rxvt-unicode normally on the remote system, 871One some systems you might need to set C<$TERMINFO> to the full path of
872F<$HOME/.terminfo> for this to work.
678 873
679If you cannot or do not want to do this, then you can simply set 874If 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 875C<TERM=rxvt> or even C<TERM=xterm>, and live with the small number of
681problems arising, which includes wrong keymapping, less and different 876problems arising, which includes wrong keymapping, less and different
682colours and some refresh errors in fullscreen applications. It's a nice 877colours and some refresh errors in fullscreen applications. It's a nice
689 URxvt.termName: rxvt 884 URxvt.termName: rxvt
690 885
691If you don't plan to use B<rxvt> (quite common...) you could also replace 886If you don't plan to use B<rxvt> (quite common...) you could also replace
692the rxvt terminfo file with the rxvt-unicode one and use C<TERM=rxvt>. 887the rxvt terminfo file with the rxvt-unicode one and use C<TERM=rxvt>.
693 888
889=head3 nano fails with "Error opening terminal: rxvt-unicode"
890
891This exceptionally confusing and useless error message is printed by nano
892when it can't find the terminfo database. Nothing is wrong with your
893terminal, read the previous answer for a solution.
894
694=head3 C<tic> outputs some error when compiling the terminfo entry. 895=head3 C<tic> outputs some error when compiling the terminfo entry.
695 896
696Most likely it's the empty definition for C<enacs=>. Just replace it by 897Most likely it's the empty definition for C<enacs=>. Just replace it by
697C<enacs=\E[0@> and try again. 898C<enacs=\E[0@> and try again.
698 899
702 903
703=head3 I need a termcap file entry. 904=head3 I need a termcap file entry.
704 905
705One reason you might want this is that some distributions or operating 906One reason you might want this is that some distributions or operating
706systems still compile some programs using the long-obsoleted termcap 907systems still compile some programs using the long-obsoleted termcap
707library (Fedora Core's bash is one example) and rely on a termcap entry 908library (Fedora's bash is one example) and rely on a termcap entry
708for C<rxvt-unicode>. 909for C<rxvt-unicode>.
709 910
710You could use rxvt's termcap entry with resonable results in many cases. 911You 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 912You can also create a termcap entry by using terminfo's infocmp program
712like this: 913like this:
713 914
714 infocmp -C rxvt-unicode 915 infocmp -C rxvt-unicode
715 916
716Or you could use this termcap entry, generated by the command above: 917Or you could use the termcap entry in doc/etc/rxvt-unicode.termcap,
717 918generated 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 919
739=head3 Why does C<ls> no longer have coloured output? 920=head3 Why does C<ls> no longer have coloured output?
740 921
741The C<ls> in the GNU coreutils unfortunately doesn't use terminfo to 922The C<ls> in the GNU coreutils unfortunately doesn't use terminfo to
742decide wether a terminal has colour, but uses it's own configuration 923decide 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 924file. Needless to say, C<rxvt-unicode> is not in its default file (among
744with most other terminals supporting colour). Either add: 925with most other terminals supporting colour). Either add:
745 926
746 TERM rxvt-unicode 927 TERM rxvt-unicode
747 928
748to C</etc/DIR_COLORS> or simply add: 929to C</etc/DIR_COLORS> or simply add:
760See next entry. 941See next entry.
761 942
762=head3 Why are the secondary screen-related options not working properly? 943=head3 Why are the secondary screen-related options not working properly?
763 944
764Make sure you are using C<TERM=rxvt-unicode>. Some pre-packaged 945Make sure you are using C<TERM=rxvt-unicode>. Some pre-packaged
765distributions (most notably Debian GNU/Linux) break rxvt-unicode 946distributions break rxvt-unicode by setting C<TERM> to C<rxvt>, which
766by setting C<TERM> to C<rxvt>, which doesn't have these extra 947doesn'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 948furthermore 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 949you 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 950log-in to another system it tells me about missing terminfo data?> on
771how to do this). 951how to do this).
772 952
773 953
774=head2 Encoding / Locale / Input Method Issues 954=head2 Encoding / Locale / Input Method Issues
775 955
782If you encounter strange problems like typing an accented character but 962If you encounter strange problems like typing an accented character but
783getting two unrelated other characters or similar, or if program output is 963getting two unrelated other characters or similar, or if program output is
784subtly garbled, then you should check your locale settings. 964subtly garbled, then you should check your locale settings.
785 965
786Rxvt-unicode must be started with the same C<LC_CTYPE> setting as the 966Rxvt-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 967programs 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 968while 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. 969locale to something else, e.g. C<en_GB.UTF-8>. Needless to say, this is
970not going to work, and is the most common cause for problems.
790 971
791The best thing is to fix your startup environment, as you will likely run 972The 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. 973into other problems. If nothing works you can try this in your .profile.
793 974
794 printf '\e]701;%s\007' "$LC_CTYPE" 975 printf '\33]701;%s\007' "$LC_CTYPE" # $LANG or $LC_ALL are worth a try, too
795 976
796If this doesn't work, then maybe you use a C<LC_CTYPE> specification not 977If 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 978supported 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 979displays 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 980it 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 1001The reasons is that there exists a perfectly fine mechanism for selecting
821the encoding, doing I/O and (most important) communicating this to all 1002the encoding, doing I/O and (most important) communicating this to all
822applications so everybody agrees on character properties such as width 1003applications so everybody agrees on character properties such as width
823and code number. This mechanism is the I<locale>. Applications not using 1004and code number. This mechanism is the I<locale>. Applications not using
824that info will have problems (for example, C<xterm> gets the width of 1005that 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 1006characters wrong as it uses its own, locale-independent table under all
826locales). 1007locales).
827 1008
828Rxvt-unicode uses the C<LC_CTYPE> locale category to select encoding. All 1009Rxvt-unicode uses the C<LC_CTYPE> locale category to select encoding. All
829programs doing the same (that is, most) will automatically agree in the 1010programs doing the same (that is, most) will automatically agree in the
830interpretation of characters. 1011interpretation of characters.
849=head3 Can I switch locales at runtime? 1030=head3 Can I switch locales at runtime?
850 1031
851Yes, using an escape sequence. Try something like this, which sets 1032Yes, using an escape sequence. Try something like this, which sets
852rxvt-unicode's idea of C<LC_CTYPE>. 1033rxvt-unicode's idea of C<LC_CTYPE>.
853 1034
854 printf '\e]701;%s\007' ja_JP.SJIS 1035 printf '\33]701;%s\007' ja_JP.SJIS
855 1036
856See also the previous answer. 1037See also the previous answer.
857 1038
858Sometimes this capability is rather handy when you want to work in 1039Sometimes 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 1040one 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 1041(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: 1042first switches to a locale supported by xjdic and back later:
862 1043
863 printf '\e]701;%s\007' ja_JP.SJIS 1044 printf '\33]701;%s\007' ja_JP.SJIS
864 xjdic -js 1045 xjdic -js
865 printf '\e]701;%s\007' de_DE.UTF-8 1046 printf '\33]701;%s\007' de_DE.UTF-8
866 1047
867You can also use xterm's C<luit> program, which usually works fine, except 1048You can also use xterm's C<luit> program, which usually works fine, except
868for some locales where character width differs between program- and 1049for some locales where character width differs between program- and
869rxvt-unicode-locales. 1050rxvt-unicode-locales.
870 1051
1052=head3 I have problems getting my input method working.
1053
1054Try a search engine, as this is slightly different for every input method server.
1055
1056Here is a checklist:
1057
1058=over 4
1059
1060=item - Make sure your locale I<and> the imLocale are supported on your OS.
1061
1062Try C<locale -a> or check the documentation for your OS.
1063
1064=item - Make sure your locale or imLocale matches a locale supported by your XIM.
1065
1066For example, B<kinput2> does not support UTF-8 locales, you should use
1067C<ja_JP.EUC-JP> or equivalent.
1068
1069=item - Make sure your XIM server is actually running.
1070
1071=item - Make sure the C<XMODIFIERS> environment variable is set correctly when I<starting> rxvt-unicode.
1072
1073When you want to use e.g. B<kinput2>, it must be set to
1074C<@im=kinput2>. For B<scim>, use C<@im=SCIM>. You can see what input
1075method servers are running with this command:
1076
1077 xprop -root XIM_SERVERS
1078
1079=back
1080
871=head3 My input method wants <some encoding> but I want UTF-8, what can I do? 1081=head3 My input method wants <some encoding> but I want UTF-8, what can I do?
872 1082
873You can specify separate locales for the input method and the rest of the 1083You can specify separate locales for the input method and the rest of the
874terminal, using the resource C<imlocale>: 1084terminal, using the resource C<imlocale>:
875 1085
876 URxvt.imlocale: ja_JP.EUC-JP 1086 URxvt.imlocale: ja_JP.EUC-JP
877 1087
878Now you can start your terminal with C<LC_CTYPE=ja_JP.UTF-8> and still 1088Now 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 1089use 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 1090version, you may not be able to input characters outside C<EUC-JP> in a
881method limits you. 1091normal way then, as your input method limits you.
882 1092
883=head3 Rxvt-unicode crashes when the X Input Method changes or exits. 1093=head3 Rxvt-unicode crashes when the X Input Method changes or exits.
884 1094
885Unfortunately, this is unavoidable, as the XIM protocol is racy by 1095Unfortunately, this is unavoidable, as the XIM protocol is racy by
886design. Applications can avoid some crashes at the expense of memory 1096design. Applications can avoid some crashes at the expense of memory
892So the only workaround is not to kill your Input Method Servers. 1102So the only workaround is not to kill your Input Method Servers.
893 1103
894 1104
895=head2 Operating Systems / Package Maintaining 1105=head2 Operating Systems / Package Maintaining
896 1106
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? 1107=head3 I am maintaining rxvt-unicode for distribution/OS XXX, any recommendation?
914 1108
915You should build one binary with the default options. F<configure> 1109You should build one binary with the default options. F<configure>
916now enables most useful options, and the trend goes to making them 1110now enables most useful options, and the trend goes to making them
917runtime-switchable, too, so there is usually no drawback to enbaling them, 1111runtime-switchable, too, so there is usually no drawback to enabling them,
918except higher disk and possibly memory usage. The perl interpreter should 1112except higher disk and possibly memory usage. The perl interpreter should
919be enabled, as important functionality (menus, selection, likely more in 1113be enabled, as important functionality (menus, selection, likely more in
920the future) depends on it. 1114the future) depends on it.
921 1115
922You should not overwrite the C<perl-ext-common> snd C<perl-ext> resources 1116You 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 1117system-wide (except maybe with C<defaults>). This will result in useful
924behaviour. If your distribution aims at low memory, add an empty 1118behaviour. If your distribution aims at low memory, add an empty
925C<perl-ext-common> resource to the app-defaults file. This will keep the 1119C<perl-ext-common> resource to the app-defaults file. This will keep the
926perl interpreter disabled until the user enables it. 1120perl interpreter disabled until the user enables it.
927 1121
945This forking is done as the very first within main(), which is very early 1139This forking is done as the very first within main(), which is very early
946and reduces possible bugs to initialisation code run before main(), or 1140and reduces possible bugs to initialisation code run before main(), or
947things like the dynamic loader of your system, which should result in very 1141things like the dynamic loader of your system, which should result in very
948little risk. 1142little risk.
949 1143
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. 1144=head3 I am on FreeBSD and rxvt-unicode does not seem to work at all.
959 1145
960Rxvt-unicode requires the symbol C<__STDC_ISO_10646__> to be defined 1146Rxvt-unicode requires the symbol C<__STDC_ISO_10646__> to be defined
961in your compile environment, or an implementation that implements it, 1147in your compile environment, or an implementation that implements it,
962wether it defines the symbol or not. C<__STDC_ISO_10646__> requires that 1148whether it defines the symbol or not. C<__STDC_ISO_10646__> requires that
963B<wchar_t> is represented as unicode. 1149B<wchar_t> is represented as unicode.
964 1150
965As you might have guessed, FreeBSD does neither define this symobl nor 1151As you might have guessed, FreeBSD does neither define this symbol nor
966does it support it. Instead, it uses it's own internal representation of 1152does it support it. Instead, it uses its own internal representation of
967B<wchar_t>. This is, of course, completely fine with respect to standards. 1153B<wchar_t>. This is, of course, completely fine with respect to standards.
968 1154
969However, that means rxvt-unicode only works in C<POSIX>, C<ISO-8859-1> and 1155However, 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>. 1156C<UTF-8> locales under FreeBSD (which all use Unicode as B<wchar_t>).
971 1157
972C<__STDC_ISO_10646__> is the only sane way to support multi-language 1158C<__STDC_ISO_10646__> is the only sane way to support multi-language
973apps in an OS, as using a locale-dependent (and non-standardized) 1159apps in an OS, as using a locale-dependent (and non-standardized)
974representation of B<wchar_t> makes it impossible to convert between 1160representation of B<wchar_t> makes it impossible to convert between
975B<wchar_t> (as used by X11 and your applications) and any other encoding 1161B<wchar_t> (as used by X11 and your applications) and any other encoding
985 1171
986The rxvt-unicode author insists that the right way to fix this is in the 1172The 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 1173system libraries once and for all, instead of forcing every app to carry
988complete replacements for them :) 1174complete replacements for them :)
989 1175
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? 1176=head3 How can I use rxvt-unicode under cygwin?
996 1177
997rxvt-unicode should compile and run out of the box on cygwin, using 1178rxvt-unicode should compile and run out of the box on cygwin, using
998the X11 libraries that come with cygwin. libW11 emulation is no 1179the X11 libraries that come with cygwin. libW11 emulation is no
999longer supported (and makes no sense, either, as it only supported a 1180longer supported (and makes no sense, either, as it only supported a
1003 1184
1004At the time of this writing, cygwin didn't seem to support any multi-byte 1185At 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 1186encodings (you might try C<LC_CTYPE=C-UTF-8>), so you are likely limited
1006to 8-bit encodings. 1187to 8-bit encodings.
1007 1188
1189=head3 Character widths are not correct.
1190
1191urxvt uses the system wcwidth function to know the information about
1192the width of characters, so on systems with incorrect locale data you
1193will likely get bad results. Two notorious examples are Solaris 9,
1194where single-width characters like U+2514 are reported as double-width,
1195and Darwin 8, where combining chars are reported having width 1.
1196
1197The solution is to upgrade your system or switch to a better one. A
1198possibly working workaround is to use a wcwidth implementation like
1199
1200http://www.cl.cam.ac.uk/~mgk25/ucs/wcwidth.c
1201
1008=head1 RXVT-UNICODE TECHNICAL REFERENCE 1202=head1 RXVT-UNICODE TECHNICAL REFERENCE
1009
1010=head1 DESCRIPTION
1011 1203
1012The rest of this document describes various technical aspects of 1204The rest of this document describes various technical aspects of
1013B<rxvt-unicode>. First the description of supported command sequences, 1205B<rxvt-unicode>. First the description of supported command sequences,
1014followed by pixmap support and last by a description of all features 1206followed by pixmap support and last by a description of all features
1015selectable at C<configure> time. 1207selectable at C<configure> time.
1016 1208
1209When some functionality is marked as (insecure mode), then it requires
1210insecure mode to be enabled to work fully, e.g. by using the B<insecure>
1211resource or command line switch. As that name implies, a terminal running
1212in insecure mode might not be secure against attackers that can output
1213arbitrary sequences to the terminal.
1214
1017=head1 Definitions 1215=head2 Definitions
1018 1216
1019=over 4 1217=over 4
1020 1218
1021=item B<< C<c> >> 1219=item B<< C<c> >>
1022 1220
1023The literal character c. 1221The literal character c (potentially a multi-byte character).
1024 1222
1025=item B<< C<C> >> 1223=item B<< C<C> >>
1026 1224
1027A single (required) character. 1225A single (required) character.
1028 1226
1040 1238
1041A text parameter composed of printable characters. 1239A text parameter composed of printable characters.
1042 1240
1043=back 1241=back
1044 1242
1045=head1 Values 1243=head2 Values
1046 1244
1047=over 4 1245=over 4
1048 1246
1049=item B<< C<ENQ> >> 1247=item B<< C<ENQ> >>
1050 1248
1087=item B<< C<SI> >> 1285=item B<< C<SI> >>
1088 1286
1089Shift In (Ctrl-O), invokes the G0 character set (the default). 1287Shift In (Ctrl-O), invokes the G0 character set (the default).
1090Switch to Standard Character Set 1288Switch to Standard Character Set
1091 1289
1092=item B<< C<SPC> >> 1290=item B<< C<SP> >>
1093 1291
1094Space Character 1292Space Character
1095 1293
1096=back 1294=back
1097 1295
1098=head1 Escape Sequences 1296=head2 Escape Sequences
1099 1297
1100=over 4 1298=over 4
1101 1299
1102=item B<< C<ESC # 8> >> 1300=item B<< C<ESC # 8> >>
1103 1301
1113 1311
1114=item B<< C<ESC => >> 1312=item B<< C<ESC => >>
1115 1313
1116Application Keypad (SMKX). See also next sequence. 1314Application Keypad (SMKX). See also next sequence.
1117 1315
1118=item B<<< C<< ESC >> >>> 1316=item B<<< C<< ESC > >> >>>
1119 1317
1120Normal Keypad (RMKX) 1318Normal Keypad (RMKX)
1121 1319
1122B<Note:> If the numeric keypad is activated, eg, B<Num_Lock> has been
1123pressed, numbers or control functions are generated by the numeric keypad 1320B<Note:> numbers or control functions are generated by the numeric
1124(see Key Codes). 1321keypad in normal or application mode, respectively (see Key Codes).
1322
1125 1323
1126=item B<< C<ESC D> >> 1324=item B<< C<ESC D> >>
1127 1325
1128Index (IND) 1326Index (IND)
1129 1327
1187 1385
1188Where B<< C<C> >> is one of: 1386Where B<< C<C> >> is one of:
1189 1387
1190=begin table 1388=begin table
1191 1389
1192 C = C<0> DEC Special Character and Line Drawing Set 1390 C = C<0> DEC Special Character and Line Drawing Set
1193 C = C<A> United Kingdom (UK) 1391 C = C<A> United Kingdom (UK)
1194 C = C<B> United States (USASCII) 1392 C = C<B> United States (USASCII)
1195 C = C<< < >> Multinational character set I<unimplemented> 1393 C = C<< < >> Multinational character set I<unimplemented>
1196 C = C<5> Finnish character set I<unimplemented> 1394 C = C<5> Finnish character set I<unimplemented>
1197 C = C<C> Finnish character set I<unimplemented> 1395 C = C<C> Finnish character set I<unimplemented>
1198 C = C<K> German character set I<unimplemented> 1396 C = C<K> German character set I<unimplemented>
1199 1397
1200=end table 1398=end table
1201 1399
1202=back 1400=back
1203 1401
1204X<CSI> 1402X<CSI>
1205 1403
1206=head1 CSI (Command Sequence Introducer) Sequences 1404=head2 CSI (Command Sequence Introducer) Sequences
1207 1405
1208=over 4 1406=over 4
1209 1407
1210=item B<< C<ESC [ Ps @> >> 1408=item B<< C<ESC [ Ps @> >>
1211 1409
1251 1449
1252Erase in Display (ED) 1450Erase in Display (ED)
1253 1451
1254=begin table 1452=begin table
1255 1453
1256 B<< C<Ps = 0> >> Clear Below (default) 1454 B<< C<Ps = 0> >> Clear Right and Below (default)
1257 B<< C<Ps = 1> >> Clear Above 1455 B<< C<Ps = 1> >> Clear Left and Above
1258 B<< C<Ps = 2> >> Clear All 1456 B<< C<Ps = 2> >> Clear All
1259 1457
1260=end table 1458=end table
1261 1459
1262=item B<< C<ESC [ Ps K> >> 1460=item B<< C<ESC [ Ps K> >>
1266=begin table 1464=begin table
1267 1465
1268 B<< C<Ps = 0> >> Clear to Right (default) 1466 B<< C<Ps = 0> >> Clear to Right (default)
1269 B<< C<Ps = 1> >> Clear to Left 1467 B<< C<Ps = 1> >> Clear to Left
1270 B<< C<Ps = 2> >> Clear All 1468 B<< C<Ps = 2> >> Clear All
1469 B<< C<Ps = 3> >> Like Ps = 0, but is ignored when wrapped
1470 (@@RXVT_NAME@@ extension)
1271 1471
1272=end table 1472=end table
1273 1473
1274=item B<< C<ESC [ Ps L> >> 1474=item B<< C<ESC [ Ps L> >>
1275 1475
1392 1592
1393Character Attributes (SGR) 1593Character Attributes (SGR)
1394 1594
1395=begin table 1595=begin table
1396 1596
1397 B<< C<Ps = 0> >> Normal (default) 1597 B<< C<Pm = 0> >> Normal (default)
1398 B<< C<Ps = 1 / 21> >> On / Off Bold (bright fg) 1598 B<< C<Pm = 1 / 21> >> On / Off Bold (bright fg)
1399 B<< C<Ps = 3 / 23> >> On / Off Italic 1599 B<< C<Pm = 3 / 23> >> On / Off Italic
1400 B<< C<Ps = 4 / 24> >> On / Off Underline 1600 B<< C<Pm = 4 / 24> >> On / Off Underline
1401 B<< C<Ps = 5 / 25> >> On / Off Slow Blink (bright bg) 1601 B<< C<Pm = 5 / 25> >> On / Off Slow Blink (bright bg)
1402 B<< C<Ps = 6 / 26> >> On / Off Rapid Blink (bright bg) 1602 B<< C<Pm = 6 / 26> >> On / Off Rapid Blink (bright bg)
1403 B<< C<Ps = 7 / 27> >> On / Off Inverse 1603 B<< C<Pm = 7 / 27> >> On / Off Inverse
1404 B<< C<Ps = 8 / 27> >> On / Off Invisible (NYI) 1604 B<< C<Pm = 8 / 27> >> On / Off Invisible (NYI)
1405 B<< C<Ps = 30 / 40> >> fg/bg Black 1605 B<< C<Pm = 30 / 40> >> fg/bg Black
1406 B<< C<Ps = 31 / 41> >> fg/bg Red 1606 B<< C<Pm = 31 / 41> >> fg/bg Red
1407 B<< C<Ps = 32 / 42> >> fg/bg Green 1607 B<< C<Pm = 32 / 42> >> fg/bg Green
1408 B<< C<Ps = 33 / 43> >> fg/bg Yellow 1608 B<< C<Pm = 33 / 43> >> fg/bg Yellow
1409 B<< C<Ps = 34 / 44> >> fg/bg Blue 1609 B<< C<Pm = 34 / 44> >> fg/bg Blue
1410 B<< C<Ps = 35 / 45> >> fg/bg Magenta 1610 B<< C<Pm = 35 / 45> >> fg/bg Magenta
1411 B<< C<Ps = 36 / 46> >> fg/bg Cyan 1611 B<< C<Pm = 36 / 46> >> fg/bg Cyan
1612 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) 1613 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 1614 B<< C<Pm = 38;2;R;G;B> >> set fg to 24-bit colour #RGB (ISO 8613-3)
1615 B<< C<Pm = 48;2;R;G;B> >> set bg to 24-bit colour #RGB (ISO 8613-3)
1414 B<< C<Ps = 39 / 49> >> fg/bg Default 1616 B<< C<Pm = 39 / 49> >> fg/bg Default
1415 B<< C<Ps = 90 / 100> >> fg/bg Bright Black 1617 B<< C<Pm = 90 / 100> >> fg/bg Bright Black
1416 B<< C<Ps = 91 / 101> >> fg/bg Bright Red 1618 B<< C<Pm = 91 / 101> >> fg/bg Bright Red
1417 B<< C<Ps = 92 / 102> >> fg/bg Bright Green 1619 B<< C<Pm = 92 / 102> >> fg/bg Bright Green
1418 B<< C<Ps = 93 / 103> >> fg/bg Bright Yellow 1620 B<< C<Pm = 93 / 103> >> fg/bg Bright Yellow
1419 B<< C<Ps = 94 / 104> >> fg/bg Bright Blue 1621 B<< C<Pm = 94 / 104> >> fg/bg Bright Blue
1420 B<< C<Ps = 95 / 105> >> fg/bg Bright Magenta 1622 B<< C<Pm = 95 / 105> >> fg/bg Bright Magenta
1421 B<< C<Ps = 96 / 106> >> fg/bg Bright Cyan 1623 B<< C<Pm = 96 / 106> >> fg/bg Bright Cyan
1422 B<< C<Ps = 97 / 107> >> fg/bg Bright White 1624 B<< C<Pm = 97 / 107> >> fg/bg Bright White
1423 B<< C<Ps = 99 / 109> >> fg/bg Bright Default 1625 B<< C<Pm = 99 / 109> >> fg/bg Bright Default
1424 1626
1425=end table 1627=end table
1426 1628
1427=item B<< C<ESC [ Ps n> >> 1629=item B<< C<ESC [ Ps n> >>
1428 1630
1430 1632
1431=begin table 1633=begin table
1432 1634
1433 B<< C<Ps = 5> >> Status Report B<< C<ESC [ 0 n> >> (``OK'') 1635 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> >> 1636 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 1637 B<< C<Ps = 7> >> Request Display Name (insecure mode)
1436 B<< C<Ps = 8> >> Request Version Number (place in window title) 1638 B<< C<Ps = 8> >> Request Version Number (place in window title)
1639
1640=end table
1641
1642=item B<< C<ESC [ Ps SP q> >>
1643
1644Set Cursor Style (DECSCUSR)
1645
1646=begin table
1647
1648 B<< C<Ps = 0> >> Blink Block
1649 B<< C<Ps = 1> >> Blink Block
1650 B<< C<Ps = 2> >> Steady Block
1651 B<< C<Ps = 3> >> Blink Underline
1652 B<< C<Ps = 4> >> Steady Underline
1653 B<< C<Ps = 5> >> Blink Bar (XTerm)
1654 B<< C<Ps = 6> >> Steady Bar (XTerm)
1437 1655
1438=end table 1656=end table
1439 1657
1440=item B<< C<ESC [ Ps;Ps r> >> 1658=item B<< C<ESC [ Ps;Ps r> >>
1441 1659
1463 B<< C<Ps = 11> >> Report window state (responds with C<Ps = 1> or C<Ps = 2>) 1681 B<< C<Ps = 11> >> Report window state (responds with C<Ps = 1> or C<Ps = 2>)
1464 B<< C<Ps = 13> >> Report window position (responds with C<Ps = 3>) 1682 B<< C<Ps = 13> >> Report window position (responds with C<Ps = 3>)
1465 B<< C<Ps = 14> >> Report window pixel size (responds with C<Ps = 4>) 1683 B<< C<Ps = 14> >> Report window pixel size (responds with C<Ps = 4>)
1466 B<< C<Ps = 18> >> Report window text size (responds with C<Ps = 7>) 1684 B<< C<Ps = 18> >> Report window text size (responds with C<Ps = 7>)
1467 B<< C<Ps = 19> >> Currently the same as C<Ps = 18>, but responds with C<Ps = 9> 1685 B<< C<Ps = 19> >> Currently the same as C<Ps = 18>, but responds with C<Ps = 9>
1468 B<< C<Ps = 20> >> Reports icon label (B<< C<ESC ] L NAME \234> >>) 1686 B<< C<Ps = 20> >> Reports icon label (B<< C<ESC ] L NAME \234> >>) (insecure mode)
1469 B<< C<Ps = 21> >> Reports window title (B<< C<ESC ] l NAME \234> >>) 1687 B<< C<Ps = 21> >> Reports window title (B<< C<ESC ] l NAME \234> >>) (insecure mode)
1470 B<< C<Ps = 24..> >> Set window height to C<Ps> rows 1688 B<< C<Ps = 24..> >> Set window height to C<Ps> rows
1471 1689
1472=end table 1690=end table
1473 1691
1474=item B<< C<ESC [ u> >> 1692=item B<< C<ESC [ u> >>
1481 1699
1482=back 1700=back
1483 1701
1484X<PrivateModes> 1702X<PrivateModes>
1485 1703
1486=head1 DEC Private Modes 1704=head2 DEC Private Modes
1487 1705
1488=over 4 1706=over 4
1489 1707
1490=item B<< C<ESC [ ? Pm h> >> 1708=item B<< C<ESC [ ? Pm h> >>
1491 1709
1507 1725
1508Toggle DEC Private Mode Values (rxvt extension). I<where> 1726Toggle DEC Private Mode Values (rxvt extension). I<where>
1509 1727
1510=over 4 1728=over 4
1511 1729
1512=item B<< C<Ps = 1> >> (DECCKM) 1730=item B<< C<Pm = 1> >> (DECCKM)
1513 1731
1514=begin table 1732=begin table
1515 1733
1516 B<< C<h> >> Application Cursor Keys 1734 B<< C<h> >> Application Cursor Keys
1517 B<< C<l> >> Normal Cursor Keys 1735 B<< C<l> >> Normal Cursor Keys
1518 1736
1519=end table 1737=end table
1520 1738
1521=item B<< C<Ps = 2> >> (ANSI/VT52 mode) 1739=item B<< C<Pm = 2> >> (DECANM)
1522 1740
1523=begin table 1741=begin table
1524 1742
1525 B<< C<h> >> Enter VT52 mode 1743 B<< C<h> >> Enter VT52 mode
1526 B<< C<l> >> Enter VT52 mode 1744 B<< C<l> >> Enter VT52 mode
1527 1745
1528=end table 1746=end table
1529 1747
1530=item B<< C<Ps = 3> >> 1748=item B<< C<Pm = 3> >> (DECCOLM)
1531 1749
1532=begin table 1750=begin table
1533 1751
1534 B<< C<h> >> 132 Column Mode (DECCOLM) 1752 B<< C<h> >> 132 Column Mode
1535 B<< C<l> >> 80 Column Mode (DECCOLM) 1753 B<< C<l> >> 80 Column Mode
1536 1754
1537=end table
1538
1539=item B<< C<Ps = 4> >>
1540
1541=begin table 1755=end table
1542 1756
1757=item B<< C<Pm = 4> >> (DECSCLM)
1758
1759=begin table
1760
1543 B<< C<h> >> Smooth (Slow) Scroll (DECSCLM) 1761 B<< C<h> >> Smooth (Slow) Scroll
1544 B<< C<l> >> Jump (Fast) Scroll (DECSCLM) 1762 B<< C<l> >> Jump (Fast) Scroll
1545 1763
1546=end table
1547
1548=item B<< C<Ps = 5> >>
1549
1550=begin table 1764=end table
1551 1765
1766=item B<< C<Pm = 5> >> (DECSCNM)
1767
1768=begin table
1769
1552 B<< C<h> >> Reverse Video (DECSCNM) 1770 B<< C<h> >> Reverse Video
1553 B<< C<l> >> Normal Video (DECSCNM) 1771 B<< C<l> >> Normal Video
1554 1772
1555=end table
1556
1557=item B<< C<Ps = 6> >>
1558
1559=begin table 1773=end table
1560 1774
1775=item B<< C<Pm = 6> >> (DECOM)
1776
1777=begin table
1778
1561 B<< C<h> >> Origin Mode (DECOM) 1779 B<< C<h> >> Origin Mode
1562 B<< C<l> >> Normal Cursor Mode (DECOM) 1780 B<< C<l> >> Normal Cursor Mode
1563 1781
1564=end table
1565
1566=item B<< C<Ps = 7> >>
1567
1568=begin table 1782=end table
1569 1783
1784=item B<< C<Pm = 7> >> (DECAWM)
1785
1786=begin table
1787
1570 B<< C<h> >> Wraparound Mode (DECAWM) 1788 B<< C<h> >> Wraparound Mode
1571 B<< C<l> >> No Wraparound Mode (DECAWM) 1789 B<< C<l> >> No Wraparound Mode
1572 1790
1573=end table 1791=end table
1574 1792
1575=item B<< C<Ps = 8> >> I<unimplemented> 1793=item B<< C<Pm = 8> >> (DECARM) I<unimplemented>
1576 1794
1577=begin table 1795=begin table
1578 1796
1579 B<< C<h> >> Auto-repeat Keys (DECARM) 1797 B<< C<h> >> Auto-repeat Keys
1580 B<< C<l> >> No Auto-repeat Keys (DECARM) 1798 B<< C<l> >> No Auto-repeat Keys
1581 1799
1582=end table 1800=end table
1583 1801
1584=item B<< C<Ps = 9> >> X10 XTerm 1802=item B<< C<Pm = 9> >> (X10 XTerm mouse protocol)
1585 1803
1586=begin table 1804=begin table
1587 1805
1588 B<< C<h> >> Send Mouse X & Y on button press. 1806 B<< C<h> >> Send Mouse X & Y on button press.
1589 B<< C<l> >> No mouse reporting. 1807 B<< C<l> >> No mouse reporting.
1590 1808
1591=end table 1809=end table
1592 1810
1811=item B<< C<Pm = 12> >> (AT&T 610, XTerm)
1812
1813=begin table
1814
1815 B<< C<h> >> Blinking cursor (cvvis)
1816 B<< C<l> >> Steady cursor (cnorm)
1817
1818=end table
1819
1593=item B<< C<Ps = 25> >> 1820=item B<< C<Pm = 25> >> (DECTCEM)
1594 1821
1595=begin table 1822=begin table
1596 1823
1597 B<< C<h> >> Visible cursor {cnorm/cvvis} 1824 B<< C<h> >> Visible cursor {cnorm/cvvis}
1598 B<< C<l> >> Invisible cursor {civis} 1825 B<< C<l> >> Invisible cursor {civis}
1599 1826
1600=end table 1827=end table
1601 1828
1602=item B<< C<Ps = 30> >> 1829=item B<< C<Pm = 30> >> (B<rxvt>)
1603 1830
1604=begin table 1831=begin table
1605 1832
1606 B<< C<h> >> scrollBar visisble 1833 B<< C<h> >> scrollBar visible
1607 B<< C<l> >> scrollBar invisisble 1834 B<< C<l> >> scrollBar invisible
1608 1835
1609=end table 1836=end table
1610 1837
1611=item B<< C<Ps = 35> >> (B<rxvt>) 1838=item B<< C<Pm = 35> >> (B<rxvt>)
1612 1839
1613=begin table 1840=begin table
1614 1841
1615 B<< C<h> >> Allow XTerm Shift+key sequences 1842 B<< C<h> >> Allow XTerm Shift+key sequences
1616 B<< C<l> >> Disallow XTerm Shift+key sequences 1843 B<< C<l> >> Disallow XTerm Shift+key sequences
1617 1844
1618=end table 1845=end table
1619 1846
1620=item B<< C<Ps = 38> >> I<unimplemented> 1847=item B<< C<Pm = 38> >> I<unimplemented>
1621 1848
1622Enter Tektronix Mode (DECTEK) 1849Enter Tektronix Mode (DECTEK)
1623 1850
1624=item B<< C<Ps = 40> >> 1851=item B<< C<Pm = 40> >>
1625 1852
1626=begin table 1853=begin table
1627 1854
1628 B<< C<h> >> Allow 80/132 Mode 1855 B<< C<h> >> Allow 80/132 Mode
1629 B<< C<l> >> Disallow 80/132 Mode 1856 B<< C<l> >> Disallow 80/132 Mode
1630 1857
1631=end table 1858=end table
1632 1859
1633=item B<< C<Ps = 44> >> I<unimplemented> 1860=item B<< C<Pm = 44> >> I<unimplemented>
1634 1861
1635=begin table 1862=begin table
1636 1863
1637 B<< C<h> >> Turn On Margin Bell 1864 B<< C<h> >> Turn On Margin Bell
1638 B<< C<l> >> Turn Off Margin Bell 1865 B<< C<l> >> Turn Off Margin Bell
1639 1866
1640=end table 1867=end table
1641 1868
1642=item B<< C<Ps = 45> >> I<unimplemented> 1869=item B<< C<Pm = 45> >> I<unimplemented>
1643 1870
1644=begin table 1871=begin table
1645 1872
1646 B<< C<h> >> Reverse-wraparound Mode 1873 B<< C<h> >> Reverse-wraparound Mode
1647 B<< C<l> >> No Reverse-wraparound Mode 1874 B<< C<l> >> No Reverse-wraparound Mode
1648 1875
1649=end table 1876=end table
1650 1877
1651=item B<< C<Ps = 46> >> I<unimplemented> 1878=item B<< C<Pm = 46> >> I<unimplemented>
1652 1879
1653=item B<< C<Ps = 47> >> 1880=item B<< C<Pm = 47> >>
1654 1881
1655=begin table 1882=begin table
1656 1883
1657 B<< C<h> >> Use Alternate Screen Buffer 1884 B<< C<h> >> Use Alternate Screen Buffer
1658 B<< C<l> >> Use Normal Screen Buffer 1885 B<< C<l> >> Use Normal Screen Buffer
1659 1886
1660=end table 1887=end table
1661 1888
1662X<Priv66> 1889X<Priv66>
1663 1890
1664=item B<< C<Ps = 66> >> 1891=item B<< C<Pm = 66> >> (DECNKM)
1665 1892
1666=begin table 1893=begin table
1667 1894
1668 B<< C<h> >> Application Keypad (DECPAM) == C<ESC => 1895 B<< C<h> >> Application Keypad (DECKPAM/DECPAM) == C<ESC =>
1669 B<< C<l> >> Normal Keypad (DECPNM) == C<< ESC > >> 1896 B<< C<l> >> Normal Keypad (DECKPNM/DECPNM) == C<< ESC > >>
1670 1897
1671=end table
1672
1673=item B<< C<Ps = 67> >>
1674
1675=begin table 1898=end table
1676 1899
1900=item B<< C<Pm = 67> >> (DECBKM)
1901
1902=begin table
1903
1677 B<< C<h> >> Backspace key sends B<< C<BS> (DECBKM) >> 1904 B<< C<h> >> Backspace key sends B<< C<BS> >>
1678 B<< C<l> >> Backspace key sends B<< C<DEL> >> 1905 B<< C<l> >> Backspace key sends B<< C<DEL> >>
1679 1906
1680=end table 1907=end table
1681 1908
1682=item B<< C<Ps = 1000> >> (X11 XTerm) 1909=item B<< C<Pm = 1000> >> (X11 XTerm mouse protocol)
1683 1910
1684=begin table 1911=begin table
1685 1912
1686 B<< C<h> >> Send Mouse X & Y on button press and release. 1913 B<< C<h> >> Send Mouse X & Y on button press and release.
1687 B<< C<l> >> No mouse reporting. 1914 B<< C<l> >> No mouse reporting.
1688 1915
1689=end table 1916=end table
1690 1917
1691=item B<< C<Ps = 1001> >> (X11 XTerm) I<unimplemented> 1918=item B<< C<Pm = 1001> >> (X11 XTerm) I<unimplemented>
1692 1919
1693=begin table 1920=begin table
1694 1921
1695 B<< C<h> >> Use Hilite Mouse Tracking. 1922 B<< C<h> >> Use Hilite Mouse Tracking.
1696 B<< C<l> >> No mouse reporting. 1923 B<< C<l> >> No mouse reporting.
1697 1924
1698=end table 1925=end table
1699 1926
1927=item B<< C<Pm = 1002> >> (X11 XTerm cell motion mouse tracking)
1928
1929=begin table
1930
1931 B<< C<h> >> Send Mouse X & Y on button press and release, and motion with a button pressed.
1932 B<< C<l> >> No mouse reporting.
1933
1934=end table
1935
1936=item B<< C<Pm = 1003> >> (X11 XTerm all motion mouse tracking)
1937
1938=begin table
1939
1940 B<< C<h> >> Send Mouse X & Y on button press and release, and motion.
1941 B<< C<l> >> No mouse reporting.
1942
1943=end table
1944
1945=item B<< C<Pm = 1004> >> (X11 XTerm focus in/focus out events)
1946
1947=begin table
1948
1949 B<< C<h> >> Send Mouse focus in/focus out events.
1950 B<< C<l> >> Don't send focus events.
1951
1952=end table
1953
1954=item B<< C<Pm = 1005> >> (X11 XTerm UTF-8 mouse mode) (Compile frills)
1955
1956Try to avoid this mode, it doesn't work sensibly in non-UTF-8 locales. Use
1957mode C<1015> instead.
1958
1959Unlike XTerm, coordinates larger than 2015 will work fine.
1960
1961=begin table
1962
1963 B<< C<h> >> Enable mouse coordinates in locale-specific encoding.
1964 B<< C<l> >> Enable mouse coordinates as binary octets.
1965
1966=end table
1967
1700=item B<< C<Ps = 1010> >> (B<rxvt>) 1968=item B<< C<Pm = 1010> >> (B<rxvt>)
1701 1969
1702=begin table 1970=begin table
1703 1971
1704 B<< C<h> >> Don't scroll to bottom on TTY output 1972 B<< C<h> >> Don't scroll to bottom on TTY output
1705 B<< C<l> >> Scroll to bottom on TTY output 1973 B<< C<l> >> Scroll to bottom on TTY output
1706 1974
1707=end table 1975=end table
1708 1976
1709=item B<< C<Ps = 1011> >> (B<rxvt>) 1977=item B<< C<Pm = 1011> >> (B<rxvt>)
1710 1978
1711=begin table 1979=begin table
1712 1980
1713 B<< C<h> >> Scroll to bottom when a key is pressed 1981 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 1982 B<< C<l> >> Don't scroll to bottom when a key is pressed
1715 1983
1716=end table 1984=end table
1717 1985
1986=item B<< C<Pm = 1015> >> (B<rxvt-unicode>) (Compile frills)
1987
1988=begin table
1989
1990 B<< C<h> >> Enable urxvt mouse coordinate reporting.
1991 B<< C<l> >> Use old-style C<CSI M C C C> encoding.
1992
1993=end table
1994
1995Changes all mouse reporting codes to use decimal parameters instead of
1996octets or characters.
1997
1998This mode should be enabled I<before> actually enabling mouse reporting,
1999for semi-obvious reasons.
2000
2001The sequences received for various modes are as follows:
2002
2003 ESC [ M o o o !1005, !1015 (three octets)
2004 ESC [ M c c c 1005, !1015 (three characters)
2005 ESC [ Pm M 1015 (three or more numeric parameters)
2006
2007The first three parameters are C<code>, C<x> and C<y>. Code is the numeric
2008code as for the other modes (but encoded as a decimal number, including
2009the additional offset of 32, so you have to subtract 32 first), C<x> and
2010C<y> are the coordinates (1|1 is the upper left corner, just as with
2011cursor positioning).
2012
2013Example: Shift-Button-1 press at top row, column 80.
2014
2015 ESC [ 37 ; 80 ; 1 M
2016
2017One can use this feature by simply enabling it and then looking for
2018parameters to the C<ESC [ M> reply - if there are any, this mode is
2019active, otherwise one of the old reporting styles is used.
2020
2021Other (to be implemented) reply sequences will use a similar encoding.
2022
2023In the future, more parameters might get added (pixel coordinates for
2024example - anybody out there who needs this?).
2025
1718=item B<< C<Ps = 1021> >> (B<rxvt>) 2026=item B<< C<Pm = 1021> >> (B<rxvt>)
1719 2027
1720=begin table 2028=begin table
1721 2029
1722 B<< C<h> >> Bold/italic implies high intensity (see option B<-is>) 2030 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) 2031 B<< C<l> >> Font styles have no effect on intensity (Compile styles)
1724 2032
1725=end table 2033=end table
1726 2034
1727=item B<< C<Ps = 1047> >> 2035=item B<< C<Pm = 1047> >> (X11 XTerm alternate screen buffer)
1728 2036
1729=begin table 2037=begin table
1730 2038
1731 B<< C<h> >> Use Alternate Screen Buffer 2039 B<< C<h> >> Use Alternate Screen Buffer
1732 B<< C<l> >> Use Normal Screen Buffer - clear Alternate Screen Buffer if returning from it 2040 B<< C<l> >> Use Normal Screen Buffer - clear Alternate Screen Buffer if returning from it
1733 2041
1734=end table 2042=end table
1735 2043
1736=item B<< C<Ps = 1048> >> 2044=item B<< C<Pm = 1048> >> (X11 XTerm alternate DECSC)
1737 2045
1738=begin table 2046=begin table
1739 2047
1740 B<< C<h> >> Save cursor position 2048 B<< C<h> >> Save cursor position
1741 B<< C<l> >> Restore cursor position 2049 B<< C<l> >> Restore cursor position
1742 2050
1743=end table 2051=end table
1744 2052
1745=item B<< C<Ps = 1049> >> 2053=item B<< C<Pm = 1049> >> (X11 XTerm 1047 + 1048)
1746 2054
1747=begin table 2055=begin table
1748 2056
1749 B<< C<h> >> Use Alternate Screen Buffer - clear Alternate Screen Buffer if switching to it 2057 B<< C<h> >> Use Alternate Screen Buffer - clear Alternate Screen Buffer if switching to it
1750 B<< C<l> >> Use Normal Screen Buffer 2058 B<< C<l> >> Use Normal Screen Buffer
1751 2059
1752=end table 2060=end table
1753 2061
2062=item B<< C<Pm = 2004> >> (X11 XTerm bracketed paste mode)
2063
2064=begin table
2065
2066 B<< C<h> >> Enable bracketed paste mode - prepend / append to the pasted text the control sequences C<ESC [ 200 ~> / C<ESC [ 201 ~>
2067 B<< C<l> >> Disable bracketed paste mode
2068
2069=end table
2070
1754=back 2071=back
1755 2072
1756=back 2073=back
1757 2074
1758X<XTerm> 2075X<XTerm>
1759 2076
1760=head1 XTerm Operating System Commands 2077=head2 XTerm Operating System Commands
1761 2078
1762=over 4 2079=over 4
1763 2080
1764=item B<< C<ESC ] Ps;Pt ST> >> 2081=item B<< C<ESC ] Ps;Pt ST> >>
1765 2082
1766Set XTerm Parameters. 8-bit ST: 0x9c, 7-bit ST sequence: ESC \ (0x1b, 2083Set XTerm Parameters. 8-bit ST: 0x9c, 7-bit ST sequence: ESC \ (0x1b,
17670x5c), backwards compatible terminator BEL (0x07) is also accepted. any 20840x5c), backwards compatible terminator BEL (0x07) is also accepted. any
1768B<octet> can be escaped by prefixing it with SYN (0x16, ^V). 2085B<octet> can be escaped by prefixing it with SYN (0x16, ^V).
1769 2086
2087Many of these settings can be queried by specifying C<?> as parameter, but
2088this requires insecure mode to be enabled for most of these.
2089
1770=begin table 2090=begin table
1771 2091
1772 B<< C<Ps = 0> >> Change Icon Name and Window Title to B<< C<Pt> >> 2092 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> >> 2093 B<< C<Ps = 1> >> Change Icon Name to B<< C<Pt> >>
1774 B<< C<Ps = 2> >> Change Window Title to B<< C<Pt> >> 2094 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. 2095 B<< C<Ps = 3> >> If B<< C<Pt> >> starts with a B<< C<?> >>, query the (STRING) property of the window and return it (insecure mode). 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 2096 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)> 2097 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)> 2098 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> >> 2099 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> >> 2100 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> >> 2101 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] 2102 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] 2103 B<< C<Ps = 20> >> Change background image to B<< C<Pt> >> (see the L<urxvt-background>) extension documentation)
1784 B<< C<Ps = 20> >> Change background pixmap parameters (see section XPM) (Compile XPM).
1785 B<< C<Ps = 39> >> Change default foreground colour to B<< C<Pt> >>. 2104 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> 2105 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> >>. 2106 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> >> 2107 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> >> 2108 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). 2109 B<< C<Ps = 701> >> Change current locale to B<< C<Pt> >>, or, if B<< C<Pt> >> is B<< C<?> >>, return the current locale (insecure mode, 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>. 2110 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> >> 2111 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). 2112 B<< C<Ps = 705> >> Change background tint color to B<< C<Pt> >> (see the L<urxvt-background>) extension documentation)
1794 B<< C<Ps = 706> >> Change colour of bold characters to B<< C<Pt> >> 2113 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> >> 2114 B<< C<Ps = 707> >> Change colour of underlined characters to B<< C<Pt> >>
2115 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>. 2116 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). 2117 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). 2118 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). 2119 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). 2120 B<< C<Ps = 720> >> Move viewing window up by B<< C<Pt> >> lines, or clear scrollback buffer if C<Pt = 0> (Compile frills).
1803 2123
1804=end table 2124=end table
1805 2125
1806=back 2126=back
1807 2127
1808X<XPM>
1809
1810=head1 XPM
1811
1812For the XPM XTerm escape sequence B<< C<ESC ] 20 ; Pt ST> >> then value
1813of B<< C<Pt> >> can be the name of the background pixmap followed by a
1814sequence of scaling/positioning commands separated by semi-colons. The
1815scaling/positioning commands are as follows:
1816
1817=over 4
1818
1819=item query scale/position
1820
1821B<?>
1822
1823=item change scale and position
1824
1825B<WxH+X+Y>
1826
1827B<WxH+X> (== B<WxH+X+X>)
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
1855=back
1856
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> 2128X<Mouse>
1876 2129
1877=head1 Mouse Reporting 2130=head1 Mouse Reporting
1878 2131
1879=over 4 2132=over 4
1904The upper bits of B<< C<< <b> >> >> indicate the modifiers when the 2157The upper bits of B<< C<< <b> >> >> indicate the modifiers when the
1905button was pressed and are added together (X11 mouse report only): 2158button was pressed and are added together (X11 mouse report only):
1906 2159
1907=over 4 2160=over 4
1908 2161
1909=item State = B<< C<< (<b> - SPACE) & 60 >> >> 2162=item State = B<< C<< (<b> - SPACE) & ~3 >> >>
1910 2163
1911=begin table 2164=begin table
1912 2165
1913 4 Shift 2166 4 Shift
1914 8 Meta 2167 8 Meta
1915 16 Control 2168 16 Control
2169 32 Motion Notify
1916 32 Double Click I<(rxvt extension)> 2170 32 Double Click I<(rxvt extension)>, disabled by default
2171 64 Button1 is actually Button4, Button2 is actually Button5 etc.
1917 2172
1918=end table 2173=end table
1919 2174
1920Col = B<< C<< <x> - SPACE >> >> 2175Col = B<< C<< <x> - SPACE >> >>
1921 2176
1922Row = B<< C<< <y> - SPACE >> >> 2177Row = B<< C<< <y> - SPACE >> >>
1923 2178
1924=back 2179=back
2180
2181=head1 Key Codes
2182
1925X<KeyCodes> 2183X<KeyCodes>
1926 2184
1927=head1 Key Codes
1928
1929Note: B<Shift> + B<F1>-B<F10> generates B<F11>-B<F20> 2185Note: B<Shift> + B<F1>-B<F10> generates B<F11>-B<F20>
1930 2186
1931For the keypad, use B<Shift> to temporarily override Application-Keypad 2187For the keypad, use B<Shift> to temporarily toggle Application Keypad
1932setting use B<Num_Lock> to toggle Application-Keypad setting if 2188mode 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 2189B<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 2190values of B<BackSpace>, B<Delete> may have been compiled differently
1935your system. 2191on your system.
1936 2192
1937=begin table 2193=begin table
1938 2194
1939 B<Normal> B<Shift> B<Control> B<Ctrl+Shift> 2195 B<Normal> B<Shift> B<Control> B<Ctrl+Shift>
1940 Tab ^I ESC [ Z ^I ESC [ Z 2196 Tab ^I ESC [ Z ^I ESC [ Z
1941 BackSpace ^H ^? ^? ^? 2197 BackSpace ^? ^? ^H ^H
1942 Find ESC [ 1 ~ ESC [ 1 $ ESC [ 1 ^ ESC [ 1 @ 2198 Find ESC [ 1 ~ ESC [ 1 $ ESC [ 1 ^ ESC [ 1 @
1943 Insert ESC [ 2 ~ I<paste> ESC [ 2 ^ ESC [ 2 @ 2199 Insert ESC [ 2 ~ I<paste> ESC [ 2 ^ ESC [ 2 @
1944 Execute ESC [ 3 ~ ESC [ 3 $ ESC [ 3 ^ ESC [ 3 @ 2200 Execute ESC [ 3 ~ ESC [ 3 $ ESC [ 3 ^ ESC [ 3 @
1945 Select ESC [ 4 ~ ESC [ 4 $ ESC [ 4 ^ ESC [ 4 @ 2201 Select ESC [ 4 ~ ESC [ 4 $ ESC [ 4 ^ ESC [ 4 @
1946 Prior ESC [ 5 ~ I<scroll-up> ESC [ 5 ^ ESC [ 5 @ 2202 Prior ESC [ 5 ~ I<scroll-up> ESC [ 5 ^ ESC [ 5 @
1976 KP_Enter ^M ESC O M 2232 KP_Enter ^M ESC O M
1977 KP_F1 ESC O P ESC O P 2233 KP_F1 ESC O P ESC O P
1978 KP_F2 ESC O Q ESC O Q 2234 KP_F2 ESC O Q ESC O Q
1979 KP_F3 ESC O R ESC O R 2235 KP_F3 ESC O R ESC O R
1980 KP_F4 ESC O S ESC O S 2236 KP_F4 ESC O S ESC O S
1981 XK_KP_Multiply * ESC O j 2237 KP_Multiply * ESC O j
1982 XK_KP_Add + ESC O k 2238 KP_Add + ESC O k
1983 XK_KP_Separator , ESC O l 2239 KP_Separator , ESC O l
1984 XK_KP_Subtract - ESC O m 2240 KP_Subtract - ESC O m
1985 XK_KP_Decimal . ESC O n 2241 KP_Decimal . ESC O n
1986 XK_KP_Divide / ESC O o 2242 KP_Divide / ESC O o
1987 XK_KP_0 0 ESC O p 2243 KP_0 0 ESC O p
1988 XK_KP_1 1 ESC O q 2244 KP_1 1 ESC O q
1989 XK_KP_2 2 ESC O r 2245 KP_2 2 ESC O r
1990 XK_KP_3 3 ESC O s 2246 KP_3 3 ESC O s
1991 XK_KP_4 4 ESC O t 2247 KP_4 4 ESC O t
1992 XK_KP_5 5 ESC O u 2248 KP_5 5 ESC O u
1993 XK_KP_6 6 ESC O v 2249 KP_6 6 ESC O v
1994 XK_KP_7 7 ESC O w 2250 KP_7 7 ESC O w
1995 XK_KP_8 8 ESC O x 2251 KP_8 8 ESC O x
1996 XK_KP_9 9 ESC O y 2252 KP_9 9 ESC O y
1997 2253
1998=end table 2254=end table
1999 2255
2000=head1 CONFIGURE OPTIONS 2256=head1 CONFIGURE OPTIONS
2001 2257
2002General hint: if you get compile errors, then likely your configuration 2258General hint: if you get compile errors, then likely your configuration
2003hasn't been tested well. Either try with C<--enable-everything> or use 2259hasn'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 2260the 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 2261switches). 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 2262work, so it can be fixed. Marc Lehmann <rxvt@schmorp.de>.
2007Lehmann <rxvt@schmorp.de>.
2008 2263
2009All 2264All
2010 2265
2011=over 4 2266=over 4
2012 2267
2013=item --enable-everything 2268=item --enable-everything
2014 2269
2015Add (or remove) support for all non-multichoice options listed in "./configure 2270Add (or remove) support for all non-multichoice options listed
2016--help". 2271in C<./configure --help>, except for C<--enable-assert> and
2272C<--enable-256-color>.
2017 2273
2018You can specify this and then disable options you do not like by 2274You can specify this and then disable options you do not like by
2019I<following> this with the appropriate C<--disable-...> arguments, 2275I<following> this with the appropriate C<--disable-...> arguments,
2020or you can start with a minimal configuration by specifying 2276or you can start with a minimal configuration by specifying
2021C<--disable-everything> and than adding just the C<--enable-...> arguments 2277C<--disable-everything> and than adding just the C<--enable-...> arguments
2022you want. 2278you want.
2023 2279
2024=item --enable-xft (default: enabled) 2280=item --enable-xft (default: on)
2025 2281
2026Add support for Xft (anti-aliases, among others) fonts. Xft fonts are 2282Add 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 2283slower and require lots of memory, but as long as you don't use them, you
2028don't pay for them. 2284don't pay for them.
2029 2285
2030=item --enable-font-styles (default: on) 2286=item --enable-font-styles (default: on)
2031 2287
2032Add support for B<bold>, I<italic> and B<< I<bold italic> >> font 2288Add support for B<bold>, I<italic> and B<< I<bold italic> >> font
2033styles. The fonts can be set manually or automatically. 2289styles. The fonts can be set manually or automatically.
2034 2290
2035=item --with-codesets=NAME,... (default: all) 2291=item --with-codesets=CS,... (default: all)
2036 2292
2037Compile in support for additional codeset (encoding) groups (C<eu>, C<vn> 2293Compile in support for additional codeset (encoding) groups (C<eu>, C<vn>
2038are always compiled in, which includes most 8-bit character sets). These 2294are always compiled in, which includes most 8-bit character sets). These
2039codeset tables are used for driving X11 core fonts, they are not required 2295codeset tables are used for driving X11 core fonts, they are not required
2040for Xft fonts, although having them compiled in lets rxvt-unicode choose 2296for Xft fonts, although having them compiled in lets rxvt-unicode choose
2044 2300
2045=begin table 2301=begin table
2046 2302
2047 all all available codeset groups 2303 all all available codeset groups
2048 zh common chinese encodings 2304 zh common chinese encodings
2049 zh_ext rarely used but very big chinese encodigs 2305 zh_ext rarely used but very big chinese encodings
2050 jp common japanese encodings 2306 jp common japanese encodings
2051 jp_ext rarely used but big japanese encodings 2307 jp_ext rarely used but big japanese encodings
2052 kr korean encodings 2308 kr korean encodings
2053 2309
2054=end table 2310=end table
2068requirements per character from 2 to 4 bytes. X11 fonts do not yet 2324requirements per character from 2 to 4 bytes. X11 fonts do not yet
2069support these extra characters, but Xft does. 2325support these extra characters, but Xft does.
2070 2326
2071Please note that rxvt-unicode can store unicode code points >65535 2327Please note that rxvt-unicode can store unicode code points >65535
2072even without this flag, but the number of such characters is 2328even without this flag, but the number of such characters is
2073limited to a view thousand (shared with combining characters, 2329limited to a few thousand (shared with combining characters,
2074see next switch), and right now rxvt-unicode cannot display them 2330see next switch), and right now rxvt-unicode cannot display them
2075(input/output and cut&paste still work, though). 2331(input/output and cut&paste still work, though).
2076 2332
2077=item --enable-combining (default: on) 2333=item --enable-combining (default: on)
2078 2334
2079Enable automatic composition of combining characters into 2335Enable automatic composition of combining characters into
2080composite characters. This is required for proper viewing of text 2336composite characters. This is required for proper viewing of text
2081where accents are encoded as seperate unicode characters. This is 2337where accents are encoded as separate unicode characters. This is
2082done by using precomposited characters when available or creating 2338done by using precomposed characters when available or creating
2083new pseudo-characters when no precomposed form exists. 2339new pseudo-characters when no precomposed form exists.
2084 2340
2085Without --enable-unicode3, the number of additional precomposed 2341Without --enable-unicode3, the number of additional precomposed
2086characters is somewhat limited (the 6400 private use characters will be 2342characters is somewhat limited (the 6400 private use characters will be
2087(ab-)used). With --enable-unicode3, no practical limit exists. 2343(ab-)used). With --enable-unicode3, no practical limit exists.
2091 2347
2092The combining table also contains entries for arabic presentation forms, 2348The 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 2349but these are not currently used. Bug me if you want these to be used (and
2094tell me how these are to be used...). 2350tell me how these are to be used...).
2095 2351
2096=item --enable-fallback(=CLASS) (default: Rxvt) 2352=item --enable-fallback[=CLASS] (default: Rxvt)
2097 2353
2098When reading resource settings, also read settings for class CLASS. To 2354When reading resource settings, also read settings for class CLASS. To
2099disable resource fallback use --disable-fallback. 2355disable resource fallback use --disable-fallback.
2100 2356
2101=item --with-res-name=NAME (default: urxvt) 2357=item --with-res-name=NAME (default: urxvt)
2102 2358
2103Use the given name as default application name when 2359Use the given name as default application name when
2104reading resources. Specify --with-res-name=rxvt to replace rxvt. 2360reading resources. Specify --with-res-name=rxvt to replace rxvt.
2105 2361
2106=item --with-res-class=CLASS /default: URxvt) 2362=item --with-res-class=CLASS (default: URxvt)
2107 2363
2108Use the given class as default application class 2364Use the given class as default application class
2109when reading resources. Specify --with-res-class=Rxvt to replace 2365when reading resources. Specify --with-res-class=Rxvt to replace
2110rxvt. 2366rxvt.
2111 2367
2124 2380
2125Write user and tty to lastlog file (used by programs like 2381Write user and tty to lastlog file (used by programs like
2126F<lastlogin>) at start of rxvt execution. This option requires 2382F<lastlogin>) at start of rxvt execution. This option requires
2127--enable-utmp to also be specified. 2383--enable-utmp to also be specified.
2128 2384
2129=item --enable-xpm-background (default: on) 2385=item --enable-pixbuf (default: on)
2130 2386
2131Add support for XPM background pixmaps. 2387Add support for GDK-PixBuf to be used for background images.
2388It adds support for many file formats including JPG, PNG,
2389TIFF, GIF, XPM, BMP, ICO and TGA.
2390
2391=item --enable-startup-notification (default: on)
2392
2393Add support for freedesktop startup notifications. This allows window managers
2394to display some kind of progress indicator during startup.
2132 2395
2133=item --enable-transparency (default: on) 2396=item --enable-transparency (default: on)
2134 2397
2135Add support for inheriting parent backgrounds thus giving a fake 2398Add support for using the root pixmap as background to simulate transparency.
2136transparency to the term. 2399Note that this feature depends on libXrender and on the availability
2400of the RENDER extension in the X server.
2137 2401
2138=item --enable-fading (default: on) 2402=item --enable-fading (default: on)
2139 2403
2140Add support for fading the text when focus is lost (requires C<--enable-transparency>). 2404Add 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 2405
2146=item --enable-rxvt-scroll (default: on) 2406=item --enable-rxvt-scroll (default: on)
2147 2407
2148Add support for the original rxvt scrollbar. 2408Add support for the original rxvt scrollbar.
2149 2409
2152Add support for a NeXT-like scrollbar. 2412Add support for a NeXT-like scrollbar.
2153 2413
2154=item --enable-xterm-scroll (default: on) 2414=item --enable-xterm-scroll (default: on)
2155 2415
2156Add support for an Xterm-like scrollbar. 2416Add 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 2417
2169=item --disable-backspace-key 2418=item --disable-backspace-key
2170 2419
2171Removes any handling of the backspace key by us - let the X server do it. 2420Removes any handling of the backspace key by us - let the X server do it.
2172 2421
2192A non-exhaustive list of features enabled by C<--enable-frills> (possibly 2441A non-exhaustive list of features enabled by C<--enable-frills> (possibly
2193in combination with other switches) is: 2442in combination with other switches) is:
2194 2443
2195 MWM-hints 2444 MWM-hints
2196 EWMH-hints (pid, utf8 names) and protocols (ping) 2445 EWMH-hints (pid, utf8 names) and protocols (ping)
2446 urgency hint
2197 seperate underline colour (-underlineColor) 2447 separate underline colour (-underlineColor)
2198 settable border widths and borderless switch (-w, -b, -bl) 2448 settable border widths and borderless switch (-w, -b, -bl)
2199 visual depth selection (-depth) 2449 visual depth selection (-depth)
2200 settable extra linespacing /-lsp) 2450 settable extra linespacing (-lsp)
2201 iso-14755-2 and -3, and visual feedback 2451 iso-14755 5.1 (basic) support
2202 tripleclickwords (-tcw) 2452 tripleclickwords (-tcw)
2203 settable insecure mode (-insecure) 2453 settable insecure mode (-insecure)
2204 keysym remapping support 2454 keysym remapping support
2205 cursor blinking and underline cursor (-cb, -uc) 2455 cursor blinking and underline cursor (-bc, -uc)
2206 XEmbed support (-embed) 2456 XEmbed support (-embed)
2207 user-pty (-pty-fd) 2457 user-pty (-pty-fd)
2208 hold on exit (-hold) 2458 hold on exit (-hold)
2459 compile in built-in block graphics
2209 skip builtin block graphics (-sbg) 2460 skip builtin block graphics (-sbg)
2461 separate highlight colour (-highlightColor, -highlightTextColor)
2462 focus reporting mode (1004).
2463 extended mouse reporting modes (1005 and 1015).
2464 visual selection via -visual and -depth.
2210 2465
2211It also enabled some non-essential features otherwise disabled, such as: 2466It also enables some non-essential features otherwise disabled, such as:
2212 2467
2213 some round-trip time optimisations 2468 some round-trip time optimisations
2214 nearest color allocation on pseudocolor screens 2469 nearest colour allocation on pseudocolor screens
2215 UTF8_STRING supporr for selection 2470 UTF8_STRING support for selection
2216 sgr modes 90..97 and 100..107 2471 sgr modes 90..97 and 100..107
2217 backindex and forwardindex escape sequences 2472 backindex and forwardindex escape sequences
2218 view change/zero scorllback esacpe sequences 2473 view change/zero scrollback escape sequences
2219 locale switching escape sequence 2474 locale switching escape sequence
2220 window op and some xterm/OSC escape sequences 2475 window op and some xterm/OSC escape sequences
2221 rectangular selections 2476 rectangular selections
2222 trailing space removal for selections 2477 trailing space removal for selections
2223 verbose X error handling 2478 verbose X error handling
2224 2479
2225=item --enable-iso14755 (default: on) 2480=item --enable-iso14755 (default: on)
2226 2481
2227Enable extended ISO 14755 support (see @@RXVT_NAME@@(1), or 2482Enable extended ISO 14755 support (see @@RXVT_NAME@@(1)).
2228F<doc/rxvt.1.txt>). Basic support (section 5.1) is enabled by 2483Basic 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 2484support for 5.2, 5.3 and 5.4 is enabled with this switch.
2230this switch.
2231 2485
2232=item --enable-keepscrolling (default: on) 2486=item --enable-keepscrolling (default: on)
2233 2487
2234Add support for continual scrolling of the display when you hold 2488Add support for continual scrolling of the display when you hold
2235the mouse button down on a scrollbar arrow. 2489the mouse button down on a scrollbar arrow.
2490
2491=item --enable-selectionscrolling (default: on)
2492
2493Add support for scrolling when the selection moves to the top or
2494bottom of the screen.
2236 2495
2237=item --enable-mousewheel (default: on) 2496=item --enable-mousewheel (default: on)
2238 2497
2239Add support for scrolling via mouse wheel or buttons 4 & 5. 2498Add support for scrolling via mouse wheel or buttons 4 & 5.
2240 2499
2242 2501
2243Add support for continual scrolling (using the mouse wheel as an 2502Add support for continual scrolling (using the mouse wheel as an
2244accelerator) while the control key is held down. This option 2503accelerator) while the control key is held down. This option
2245requires --enable-mousewheel to also be specified. 2504requires --enable-mousewheel to also be specified.
2246 2505
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) 2506=item --enable-smart-resize (default: off)
2267 2507
2268Add smart growth/shrink behaviour when changing font size via hot 2508Add smart growth/shrink behaviour when resizing.
2269keys. This should keep the window corner which is closest to a corner of 2509This should keep the window corner which is closest to a corner of
2270the screen in a fixed position. 2510the screen in a fixed position.
2271 2511
2512=item --enable-text-blink (default: on)
2513
2514Add support for blinking text.
2515
2272=item --enable-pointer-blank (default: on) 2516=item --enable-pointer-blank (default: on)
2273 2517
2274Add support to have the pointer disappear when typing or inactive. 2518Add support to have the pointer disappear when typing or inactive.
2275 2519
2276=item --enable-perl (default: on) 2520=item --enable-perl (default: on)
2277 2521
2278Enable an embedded perl interpreter. See the B<@@RXVT_NAME@@perl(3)> 2522Enable 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 2523manpage 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 2524for the extensions that are installed by default.
2281perl interpreter that is used can be specified via the C<PERL> environment 2525The perl interpreter that is used can be specified via the C<PERL>
2282variable when running configure. 2526environment variable when running configure. Even when compiled in,
2527perl will I<not> be initialised when all extensions have been disabled
2528C<-pe "" --perl-ext-common "">, so it should be safe to enable from a
2529resource standpoint.
2530
2531=item --enable-assert (default: off)
2532
2533Enables the assertions in the code, normally disabled. This switch is only
2534useful when developing rxvt-unicode.
2535
2536=item --enable-256-color (default: off)
2537
2538Force use of so-called 256 colour mode, to work around buggy applications
2539that do not support termcap/terminfo, or simply improve support for
2540applications hardcoding the xterm 256 colour table.
2541
2542This switch breaks termcap/terminfo compatibility to C<TERM=rxvt-unicode>,
2543and consequently sets C<TERM> to C<rxvt-unicode-256color> by default
2544(F<doc/etc/> contains termcap/terminfo definitions for both).
2545
2546It also results in higher memory usage and can slow down @@RXVT_NAME@@
2547dramatically when more than six fonts are in use by a terminal instance.
2283 2548
2284=item --with-name=NAME (default: urxvt) 2549=item --with-name=NAME (default: urxvt)
2285 2550
2286Set the basename for the installed binaries, resulting 2551Set the basename for the installed binaries, resulting
2287in C<urxvt>, C<urxvtd> etc.). Specify C<--with-name=rxvt> to replace with 2552in C<urxvt>, C<urxvtd> etc.). Specify C<--with-name=rxvt> to replace with
2297PATH. 2562PATH.
2298 2563
2299=item --with-x 2564=item --with-x
2300 2565
2301Use the X Window System (pretty much default, eh?). 2566Use 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 2567
2315=back 2568=back
2316 2569
2317=head1 AUTHORS 2570=head1 AUTHORS
2318 2571

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines