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.108 by root, Tue Jan 31 21:04:56 2006 UTC vs.
Revision 1.177 by root, Sat May 30 08:53:48 2009 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 three big problems with Gentoo Linux: first of all, most if not
41all Gentoo systems are completely broken (missing or mismatched header
42files, broken compiler etc. are just the tip of the iceberg); secondly,
43the Gentoo maintainer thinks it is a good idea to add broken patches to
44the code; and lastly, it should be called Gentoo GNU/Linux.
45
46For these reasons, it is impossible to support rxvt-unicode on
47Gentoo. Problems appearing on Gentoo systems will usually simply be
48ignored unless they can be reproduced on non-Gentoo systems.
34 49
35=head3 Does it support tabs, can I have a tabbed rxvt-unicode? 50=head3 Does it support tabs, can I have a tabbed rxvt-unicode?
36 51
37Beginning with version 7.3, there is a perl extension that implements a 52Beginning with version 7.3, there is a perl extension that implements a
38simple tabbed terminal. It is installed by default, so any of these should 53simple tabbed terminal. It is installed by default, so any of these should
73=head3 How can I start @@URXVT_NAME@@d in a race-free way? 88=head3 How can I start @@URXVT_NAME@@d in a race-free way?
74 89
75Try C<@@URXVT_NAME@@d -f -o>, which tells @@URXVT_NAME@@d to open the 90Try C<@@URXVT_NAME@@d -f -o>, which tells @@URXVT_NAME@@d to open the
76display, create the listening socket and then fork. 91display, create the listening socket and then fork.
77 92
93=head3 How can I start @@URXVT_NAME@@d automatically when I run @@URXVT_NAME@@c?
94
95If you want to start @@URXVT_NAME@@d automatically whenever you run
96@@URXVT_NAME@@c and the daemon isn't running yet, use this script:
97
98 #!/bin/sh
99 @@URXVT_NAME@@c "$@"
100 if [ $? -eq 2 ]; then
101 @@URXVT_NAME@@d -q -o -f
102 @@URXVT_NAME@@c "$@"
103 fi
104
105This tries to create a new terminal, and if fails with exit status 2,
106meaning it couldn't connect to the daemon, it will start the daemon and
107re-run the command. Subsequent invocations of the script will re-use the
108existing daemon.
109
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. 110=head3 How do I distinguish whether I'm running rxvt-unicode or a regular xterm? I need this to decide about setting colors 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 color.
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
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 I<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
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
193=head2 Rendering, Font & Look and Feel Issues 225=head2 Rendering, Font & Look and Feel Issues
194 226
195=head3 I can't get transparency working, what am I doing wrong? 227=head3 I can't get transparency working, what am I doing wrong?
196 228
197First of all, transparency isn't officially supported in rxvt-unicode, so 229First of all, please address all transparency related issues to Sasha Vasko at
198you are mostly on your own. Do not bug the author about it (but you may 230sasha@aftercode.net and do not bug the author about it. Also, if you can't
199bug everybody else). Also, if you can't get it working consider it a rite 231get it working consider it a rite of passage: ... and you failed.
200of passage: ... and you failed.
201 232
202Here are four ways to get transparency. B<Do> read the manpage and option 233Here are four ways to get transparency. B<Do> read the manpage and option
203descriptions for the programs mentioned and rxvt-unicode. Really, do it! 234descriptions for the programs mentioned and rxvt-unicode. Really, do it!
204 235
2051. Use inheritPixmap: 2361. Use transparent mode:
206 237
207 Esetroot wallpaper.jpg 238 Esetroot wallpaper.jpg
208 @@URXVT_NAME@@ -ip -tint red -sh 40 239 @@URXVT_NAME@@ -tr -tint red -sh 40
209 240
210That works. If you think it doesn't, you lack transparency and tinting 241That works. If you think it doesn't, you lack transparency and tinting
211support, or you are unable to read. 242support, or you are unable to read.
212 243
2132. Use a simple pixmap and emulate pseudo-transparency. This enables you 2442. Use a simple pixmap and emulate pseudo-transparency. This enables you
214to use effects other than tinting and shading: Just shade/tint/whatever 245to use effects other than tinting and shading: Just shade/tint/whatever
215your picture with gimp or any other tool: 246your picture with gimp or any other tool:
216 247
217 convert wallpaper.jpg -blur 20x20 -modulate 30 background.xpm 248 convert wallpaper.jpg -blur 20x20 -modulate 30 background.jpg
218 @@URXVT_NAME@@ -pixmap background.xpm -pe automove-background 249 @@URXVT_NAME@@ -pixmap "background.jpg;:root"
219 250
220That works. If you think it doesn't, you lack XPM and Perl support, or you 251That works. If you think it doesn't, you lack AfterImage support, or you
221are unable to read. 252are unable to read.
222 253
2233. Use an ARGB visual: 2543. Use an ARGB visual:
224 255
225 @@URXVT_NAME@@ -depth 32 -fg grey90 -bg rgba:0000/0000/4444/cccc 256 @@URXVT_NAME@@ -depth 32 -fg grey90 -bg rgba:0000/0000/4444/cccc
226 257
227This requires XFT support, and the support of your X-server. If that 258This 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 259doesn'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 260there yet, no matter what they claim. Rxvt-Unicode contains the necessary
230bugfixes and workarounds for Xft and Xlib to make it work, but that 261bugfixes and workarounds for Xft and Xlib to make it work, but that
231doesn't mean that your WM has the required kludges in place. 262doesn't mean that your WM has the required kludges in place.
232 263
2334. Use xcompmgr and let it do the job: 2644. Use xcompmgr and let it do the job:
234 265
236 -set _NET_WM_WINDOW_OPACITY 0xc0000000 267 -set _NET_WM_WINDOW_OPACITY 0xc0000000
237 268
238Then click on a window you want to make transparent. Replace C<0xc0000000> 269Then 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 270by other values to change the degree of opacity. If it doesn't work and
240your server crashes, you got to keep the pieces. 271your 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 272
267=head3 Why does rxvt-unicode sometimes leave pixel droppings? 273=head3 Why does rxvt-unicode sometimes leave pixel droppings?
268 274
269Most fonts were not designed for terminal use, which means that character 275Most 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 276size varies a lot. A font that is otherwise fine for terminal use might
276however: Xft fonts often draw glyphs larger than their acclaimed bounding 282however: 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 283box, 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 284ask for the character bounding box, which unfortunately is wrong in these
279cases). 285cases).
280 286
281It's not clear (to me at least), wether this is a bug in Xft, freetype, 287It'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 288or 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 289the C<-lsp> option to give the font more height. If that doesn't work, you
284might be forced to use a different font. 290might be forced to use a different font.
285 291
286All of this is not a problem when using X11 core fonts, as their bounding 292All of this is not a problem when using X11 core fonts, as their bounding
310=head3 Can I switch the fonts at runtime? 316=head3 Can I switch the fonts at runtime?
311 317
312Yes, using an escape sequence. Try something like this, which has the same 318Yes, using an escape sequence. Try something like this, which has the same
313effect as using the C<-fn> switch, and takes effect immediately: 319effect as using the C<-fn> switch, and takes effect immediately:
314 320
315 printf '\e]50;%s\007' "9x15bold,xft:Kochi Gothic" 321 printf '\33]50;%s\007' "9x15bold,xft:Kochi Gothic"
316 322
317This is useful if you e.g. work primarily with japanese (and prefer a 323This is useful if you e.g. work primarily with japanese (and prefer a
318japanese font), but you have to switch to chinese temporarily, where 324japanese font), but you have to switch to chinese temporarily, where
319japanese fonts would only be in your way. 325japanese fonts would only be in your way.
320 326
322 328
323=head3 Why do italic characters look as if clipped? 329=head3 Why do italic characters look as if clipped?
324 330
325Many fonts have difficulties with italic characters and hinting. For 331Many fonts have difficulties with italic characters and hinting. For
326example, the otherwise very nicely hinted font C<xft:Bitstream Vera Sans 332example, the otherwise very nicely hinted font C<xft:Bitstream Vera Sans
327Mono> completely fails in it's italic face. A workaround might be to 333Mono> completely fails in its italic face. A workaround might be to
328enable freetype autohinting, i.e. like this: 334enable freetype autohinting, i.e. like this:
329 335
330 URxvt.italicFont: xft:Bitstream Vera Sans Mono:italic:autohint=true 336 URxvt.italicFont: xft:Bitstream Vera Sans Mono:italic:autohint=true
331 URxvt.boldItalicFont: xft:Bitstream Vera Sans Mono:bold:italic:autohint=true 337 URxvt.boldItalicFont: xft:Bitstream Vera Sans Mono:bold:italic:autohint=true
332 338
338memory and also speeds up rendering considerably. 344memory and also speeds up rendering considerably.
339 345
340=head3 Rxvt-unicode doesn't seem to anti-alias its fonts, what is wrong? 346=head3 Rxvt-unicode doesn't seem to anti-alias its fonts, what is wrong?
341 347
342Rxvt-unicode will use whatever you specify as a font. If it needs to 348Rxvt-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 349fall 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 350fonts, because they are small and fast, and then use Xft fonts. It has
345antialiasing disabled for most of them, because the author thinks they 351antialiasing disabled for most of them, because the author thinks they
346look best that way. 352look best that way.
347 353
348If you want antialiasing, you have to specify the fonts manually. 354If you want antialiasing, you have to specify the fonts manually.
350=head3 What's with this bold/blink stuff? 356=head3 What's with this bold/blink stuff?
351 357
352If no bold colour is set via C<colorBD:>, bold will invert text using the 358If no bold colour is set via C<colorBD:>, bold will invert text using the
353standard foreground colour. 359standard foreground colour.
354 360
355For the standard background colour, blinking will actually make the 361For the standard background colour, blinking will actually make
356text blink when compiled with C<--enable-blinking>. with standard 362the text blink when compiled with C<--enable-text-blink>. Without
357colours. Without C<--enable-blinking>, the blink attribute will be 363C<--enable-text-blink>, the blink attribute will be ignored.
358ignored.
359 364
360On ANSI colours, bold/blink attributes are used to set high-intensity 365On ANSI colours, bold/blink attributes are used to set high-intensity
361foreground/background colors. 366foreground/background colors.
362 367
363color0-7 are the low-intensity colors. 368color0-7 are the low-intensity colors.
409 URxvt.color6: #73f7ff 414 URxvt.color6: #73f7ff
410 URxvt.color14: #73f7ff 415 URxvt.color14: #73f7ff
411 URxvt.color7: #e1dddd 416 URxvt.color7: #e1dddd
412 URxvt.color15: #e1dddd 417 URxvt.color15: #e1dddd
413 418
414(They were described (not by me) as "pretty girly"). 419They have been described (not by me) as "pretty girly".
420
421=head3 Why do some characters look so much different than others?
422
423See next entry.
415 424
416=head3 How does rxvt-unicode choose fonts? 425=head3 How does rxvt-unicode choose fonts?
417 426
418Most fonts do not contain the full range of Unicode, which is 427Most fonts do not contain the full range of Unicode, which is
419fine. Chances are that the font you (or the admin/package maintainer of 428fine. Chances are that the font you (or the admin/package maintainer of
420your system/os) have specified does not cover all the characters you want 429your system/os) have specified does not cover all the characters you want
421to display. 430to display.
422 431
423B<rxvt-unicode> makes a best-effort try at finding a replacement 432B<rxvt-unicode> makes a best-effort try at finding a replacement
424font. Often the result is fine, but sometimes the chosen font looks 433font. Often the result is fine, but sometimes the chosen font looks
425bad/ugly/wrong. Some fonts have totally strange characters that don't 434bad/ugly/wrong. Some fonts have totally strange characters that don't
426resemble the correct glyph at all, and rxvt-unicode lacks the artificial 435resemble the correct glyph at all, and rxvt-unicode lacks the artificial
427intelligence to detect that a specific glyph is wrong: it has to believe 436intelligence to detect that a specific glyph is wrong: it has to believe
428the font that the characters it claims to contain indeed look correct. 437the font that the characters it claims to contain indeed look correct.
429 438
430In that case, select a font of your taste and add it to the font list, 439In that case, select a font of your taste and add it to the font list,
431e.g.: 440e.g.:
432 441
433 @@URXVT_NAME@@ -fn basefont,font2,font3... 442 @@URXVT_NAME@@ -fn basefont,font2,font3...
434 443
435When rxvt-unicode sees a character, it will first look at the base 444When rxvt-unicode sees a character, it will first look at the base
436font. If the base font does not contain the character, it will go to the 445font. If the base font does not contain the character, it will go to the
437next font, and so on. Specifying your own fonts will also speed up this 446next font, and so on. Specifying your own fonts will also speed up this
438search and use less resources within rxvt-unicode and the X-server. 447search and use less resources within rxvt-unicode and the X-server.
439 448
440The only limitation is that none of the fonts may be larger than the base 449The only limitation is that none of the fonts may be larger than the base
441font, as the base font defines the terminal character cell size, which 450font, as the base font defines the terminal character cell size, which
442must be the same due to the way terminals work. 451must be the same due to the way terminals work.
443 452
453=head3 Why do some chinese characters look so different than others?
454
455This is because there is a difference between script and language --
456rxvt-unicode does not know which language the text that is output is,
457as it only knows the unicode character codes. If rxvt-unicode first
458sees a japanese/chinese character, it might choose a japanese font for
459display. Subsequent japanese characters will use that font. Now, many
460chinese characters aren't represented in japanese fonts, so when the first
461non-japanese character comes up, rxvt-unicode will look for a chinese font
462-- unfortunately at this point, it will still use the japanese font for
463chinese characters that are also in the japanese font.
464
465The workaround is easy: just tag a chinese font at the end of your font
466list (see the previous question). The key is to view the font list as
467a preference list: If you expect more japanese, list a japanese font
468first. If you expect more chinese, put a chinese font first.
469
470In the future it might be possible to switch language preferences at
471runtime (the internal data structure has no problem with using different
472fonts for the same character at the same time, but no interface for this
473has been designed yet).
474
475Until then, you might get away with switching fonts at runtime (see L<Can
476I switch the fonts at runtime?> later in this document).
477
478=head3 How can I make mplayer display video correctly?
479
480We are working on it, in the meantime, as a workaround, use something like:
481
482 @@URXVT_NAME@@ -b 600 -geometry 20x1 -e sh -c 'mplayer -wid $WINDOWID file...'
483
444 484
445=head2 Keyboard, Mouse & User Interaction 485=head2 Keyboard, Mouse & User Interaction
446 486
447=head3 The new selection selects pieces that are too big, how can I select single words? 487=head3 The new selection selects pieces that are too big, how can I select single words?
448 488
456 496
457To get a selection that is very similar to the old code, try this pattern: 497To get a selection that is very similar to the old code, try this pattern:
458 498
459 URxvt.selection.pattern-0: ([^"&'()*,;<=>?@[\\\\]^`{|})]+) 499 URxvt.selection.pattern-0: ([^"&'()*,;<=>?@[\\\\]^`{|})]+)
460 500
461Please also note that the I<LeftClick Shift-LeftClik> combination also 501Please also note that the I<LeftClick Shift-LeftClick> combination also
462selects words like the old code. 502selects words like the old code.
463 503
464=head3 I don't like the new selection/popups/hotkeys/perl, how do I change/disable it? 504=head3 I don't like the new selection/popups/hotkeys/perl, how do I change/disable it?
465 505
466You can disable the perl extension completely by setting the 506You can disable the perl extension completely by setting the
492circumstances, it will move your cursor around when you click into the 532circumstances, it will move your cursor around when you click into the
493line that contains it. It tries hard not to do this at the wrong moment, 533line that contains it. It tries hard not to do this at the wrong moment,
494but when running a program that doesn't parse cursor movements or in some 534but when running a program that doesn't parse cursor movements or in some
495cases during rlogin sessions, it fails to detect this properly. 535cases during rlogin sessions, it fails to detect this properly.
496 536
497You can permamently switch this feature off by disabling the C<readline> 537You can permanently switch this feature off by disabling the C<readline>
498extension: 538extension:
499 539
500 URxvt.perl-ext-common: default,-readline 540 URxvt.perl-ext-common: default,-readline
501 541
502=head3 My numerical keypad acts weird and generates differing output? 542=head3 My numerical keypad acts weird and generates differing output?
503 543
504Some Debian GNUL/Linux users seem to have this problem, although no 544Some Debian GNUL/Linux users seem to have this problem, although no
505specific details were reported so far. It is possible that this is caused 545specific details were reported so far. It is possible that this is caused
506by the wrong C<TERM> setting, although the details of wether and how 546by the wrong C<TERM> setting, although the details of whether and how
507this can happen are unknown, as C<TERM=rxvt> should offer a compatible 547this can happen are unknown, as C<TERM=rxvt> should offer a compatible
508keymap. See the answer to the previous question, and please report if that 548keymap. See the answer to the previous question, and please report if that
509helped. 549helped.
510 550
511=head3 My Compose (Multi_key) key is no longer working. 551=head3 My Compose (Multi_key) key is no longer working.
537depressed. 577depressed.
538 578
539=head3 What's with the strange Backspace/Delete key behaviour? 579=head3 What's with the strange Backspace/Delete key behaviour?
540 580
541Assuming that the physical Backspace key corresponds to the 581Assuming that the physical Backspace key corresponds to the
542BackSpace keysym (not likely for Linux ... see the following 582Backspace keysym (not likely for Linux ... see the following
543question) there are two standard values that can be used for 583question) there are two standard values that can be used for
544Backspace: C<^H> and C<^?>. 584Backspace: C<^H> and C<^?>.
545 585
546Historically, either value is correct, but rxvt-unicode adopts the debian 586Historically, either value is correct, but rxvt-unicode adopts the debian
547policy of using C<^?> when unsure, because it's the one only only correct 587policy of using C<^?> when unsure, because it's the one and only correct
548choice :). 588choice :).
549 589
550Rxvt-unicode tries to inherit the current stty settings and uses the value 590Rxvt-unicode tries to inherit the current stty settings and uses the value
551of `erase' to guess the value for backspace. If rxvt-unicode wasn't 591of `erase' to guess the value for backspace. If rxvt-unicode wasn't
552started from a terminal (say, from a menu or by remote shell), then the 592started from a terminal (say, from a menu or by remote shell), then the
584key has been assigned an escape sequence to match the vt100 for Execute 624key has been assigned an escape sequence to match the vt100 for Execute
585(C<ESC [ 3 ~>) and is in the supplied termcap/terminfo. 625(C<ESC [ 3 ~>) and is in the supplied termcap/terminfo.
586 626
587Some other Backspace problems: 627Some other Backspace problems:
588 628
589some editors use termcap/terminfo, 629some editors use termcap/terminfo,
590some editors (vim I'm told) expect Backspace = ^H, 630some editors (vim I'm told) expect Backspace = ^H,
591GNU Emacs (and Emacs-like editors) use ^H for help. 631GNU Emacs (and Emacs-like editors) use ^H for help.
592 632
593Perhaps someday this will all be resolved in a consistent manner. 633Perhaps someday this will all be resolved in a consistent manner.
594 634
635Rather than have rxvt-unicode try to accommodate all the various possible 675Rather than have rxvt-unicode try to accommodate all the various possible
636keyboard mappings, it is better to use `xmodmap' to remap the keys as 676keyboard mappings, it is better to use `xmodmap' to remap the keys as
637required for your particular machine. 677required for your particular machine.
638 678
639 679
640
641=head2 Terminal Configuration 680=head2 Terminal Configuration
681
682=head3 Can I see a typical configuration?
683
684The default configuration tries to be xterm-like, which I don't like that
685much, but it's least surprise to regular users.
686
687As a rxvt or rxvt-unicode user, you are practically supposed to invest
688time into customising your terminal. To get you started, here is the
689author's .Xdefaults entries, with comments on what they do. It's certainly
690not I<typical>, but what's typical...
691
692 URxvt.cutchars: "()*,<>[]{}|'
693 URxvt.print-pipe: cat >/tmp/xxx
694
695These are just for testing stuff.
696
697 URxvt.imLocale: ja_JP.UTF-8
698 URxvt.preeditType: OnTheSpot,None
699
700This tells rxvt-unicode to use a special locale when communicating with
701the X Input Method, and also tells it to only use the OnTheSpot pre-edit
702type, which requires the C<xim-onthespot> perl extension but rewards me
703with correct-looking fonts.
704
705 URxvt.perl-lib: /root/lib/urxvt
706 URxvt.perl-ext-common: default,selection-autotransform,selection-pastebin,xim-onthespot,remote-clipboard
707 URxvt.selection.pattern-0: ( at .*? line \\d+)
708 URxvt.selection.pattern-1: ^(/[^:]+):\
709 URxvt.selection-autotransform.0: s/^([^:[:space:]]+):(\\d+):?$/:e \\Q$1\\E\\x0d:$2\\x0d/
710 URxvt.selection-autotransform.1: s/^ at (.*?) line (\\d+)$/:e \\Q$1\\E\\x0d:$2\\x0d/
711
712This is my perl configuration. The first two set the perl library
713directory and also tells urxvt to use a large number of extensions. I
714develop for myself mostly, so I actually use most of the extensions I
715write.
716
717The selection stuff mainly makes the selection perl-error-message aware
718and tells it to convert perl error messages into vi-commands to load the
719relevant file and go tot he error line number.
720
721 URxvt.scrollstyle: plain
722 URxvt.secondaryScroll: true
723
724As the documentation says: plain is the preferred scrollbar for the
725author. The C<secondaryScroll> configures urxvt to scroll in full-screen
726apps, like screen, so lines scrolled out of screen end up in urxvt's
727scrollback buffer.
728
729 URxvt.background: #000000
730 URxvt.foreground: gray90
731 URxvt.color7: gray90
732 URxvt.colorBD: #ffffff
733 URxvt.cursorColor: #e0e080
734 URxvt.throughColor: #8080f0
735 URxvt.highlightColor: #f0f0f0
736
737Some colours. Not sure which ones are being used or even non-defaults, but
738these are in my .Xdefaults. Most notably, they set foreground/background
739to light gray/black, and also make sure that the colour 7 matches the
740default foreground colour.
741
742 URxvt.underlineColor: yellow
743
744Another colour, makes underline lines look different. Sometimes hurts, but
745is mostly a nice effect.
746
747 URxvt.geometry: 154x36
748 URxvt.loginShell: false
749 URxvt.meta: ignore
750 URxvt.utmpInhibit: true
751
752Uh, well, should be mostly self-explanatory. By specifying some defaults
753manually, I can quickly switch them for testing.
754
755 URxvt.saveLines: 8192
756
757A large scrollback buffer is essential. Really.
758
759 URxvt.mapAlert: true
760
761The only case I use it is for my IRC window, which I like to keep
762iconified till people msg me (which beeps).
763
764 URxvt.visualBell: true
765
766The audible bell is often annoying, especially when in a crowd.
767
768 URxvt.insecure: true
769
770Please don't hack my mutt! Ooops...
771
772 URxvt.pastableTabs: false
773
774I once thought this is a great idea.
775
776 urxvt.font: 9x15bold,\
777 -misc-fixed-bold-r-normal--15-140-75-75-c-90-iso10646-1,\
778 -misc-fixed-medium-r-normal--15-140-75-75-c-90-iso10646-1, \
779 [codeset=JISX0208]xft:Kochi Gothic, \
780 xft:Bitstream Vera Sans Mono:autohint=true, \
781 xft:Code2000:antialias=false
782 urxvt.boldFont: -xos4-terminus-bold-r-normal--14-140-72-72-c-80-iso8859-15
783 urxvt.italicFont: xft:Bitstream Vera Sans Mono:italic:autohint=true
784 urxvt.boldItalicFont: xft:Bitstream Vera Sans Mono:bold:italic:autohint=true
785
786I wrote rxvt-unicode to be able to specify fonts exactly. So don't be
787overwhelmed. A special note: the C<9x15bold> mentioned above is actually
788the version from XFree-3.3, as XFree-4 replaced it by a totally different
789font (different glyphs for C<;> and many other harmless characters),
790while the second font is actually the C<9x15bold> from XFree4/XOrg. The
791bold version has less chars than the medium version, so I use it for rare
792characters, too. When editing sources with vim, I use italic for comments
793and other stuff, which looks quite good with Bitstream Vera anti-aliased.
794
795Terminus is a quite bad font (many very wrong glyphs), but for most of my
796purposes, it works, and gives a different look, as my normal (Non-bold)
797font is already bold, and I want to see a difference between bold and
798normal fonts.
799
800Please note that I used the C<urxvt> instance name and not the C<URxvt>
801class name. Thats because I use different configs for different purposes,
802for example, my IRC window is started with C<-name IRC>, and uses these
803defaults:
804
805 IRC*title: IRC
806 IRC*geometry: 87x12+535+542
807 IRC*saveLines: 0
808 IRC*mapAlert: true
809 IRC*font: suxuseuro
810 IRC*boldFont: suxuseuro
811 IRC*colorBD: white
812 IRC*keysym.M-C-1: command:\033]710;suxuseuro\007\033]711;suxuseuro\007
813 IRC*keysym.M-C-2: command:\033]710;9x15bold\007\033]711;9x15bold\007
814
815C<Alt-Ctrl-1> and C<Alt-Ctrl-2> switch between two different font
816sizes. C<suxuseuro> allows me to keep an eye (and actually read)
817stuff while keeping a very small window. If somebody pastes something
818complicated (e.g. japanese), I temporarily switch to a larger font.
819
820The above is all in my C<.Xdefaults> (I don't use C<.Xresources> nor
821C<xrdb>). I also have some resources in a separate C<.Xdefaults-hostname>
822file for different hosts, for example, on ym main desktop, I use:
823
824 URxvt.keysym.C-M-q: command:\033[3;5;5t
825 URxvt.keysym.C-M-y: command:\033[3;5;606t
826 URxvt.keysym.C-M-e: command:\033[3;1605;5t
827 URxvt.keysym.C-M-c: command:\033[3;1605;606t
828 URxvt.keysym.C-M-p: perl:test
829
830The first for keysym definitions allow me to quickly bring some windows
831in the layout I like most. Ion users might start laughing but will stop
832immediately when I tell them that I use my own Fvwm2 module for much the
833same effect as Ion provides, and I only very rarely use the above key
834combinations :->
642 835
643=head3 Why doesn't rxvt-unicode read my resources? 836=head3 Why doesn't rxvt-unicode read my resources?
644 837
645Well, why, indeed? It does, in a way very similar to other X 838Well, why, indeed? It does, in a way very similar to other X
646applications. Most importantly, this means that if you or your OS loads 839applications. Most importantly, this means that if you or your OS loads
655Also consider the form resources have to use: 848Also consider the form resources have to use:
656 849
657 URxvt.resource: value 850 URxvt.resource: value
658 851
659If you want to use another form (there are lots of different ways of 852If you want to use another form (there are lots of different ways of
660specifying resources), make sure you understand wether and why it 853specifying resources), make sure you understand whether and why it
661works. If unsure, use the form above. 854works. If unsure, use the form above.
662 855
663=head3 When I log-in to another system it tells me about missing terminfo data? 856=head3 When I log-in to another system it tells me about missing terminfo data?
664 857
665The terminal description used by rxvt-unicode is not as widely available 858The terminal description used by rxvt-unicode is not as widely available
666as that for xterm, or even rxvt (for which the same problem often arises). 859as that for xterm, or even rxvt (for which the same problem often arises).
667 860
668The correct solution for this problem is to install the terminfo, this can 861The correct solution for this problem is to install the terminfo, this can
669be done like this (with ncurses' infocmp): 862be done by simply installing rxvt-unicode on the remote system as well
863(in case you have a nice package manager ready), or you can install the
864terminfo database manually like this (with ncurses infocmp. works as
865user and root):
670 866
671 REMOTE=remotesystem.domain 867 REMOTE=remotesystem.domain
672 infocmp rxvt-unicode | ssh $REMOTE "cat >/tmp/ti && tic /tmp/ti" 868 infocmp rxvt-unicode | ssh $REMOTE "mkdir -p .terminfo && cat >/tmp/ti && tic /tmp/ti"
673 869
674... or by installing rxvt-unicode normally on the remote system, 870One some systems you might need to set C<$TERMINFO> to the full path of
871F<$HOME/.terminfo> for this to work.
675 872
676If you cannot or do not want to do this, then you can simply set 873If you cannot or do not want to do this, then you can simply set
677C<TERM=rxvt> or even C<TERM=xterm>, and live with the small number of 874C<TERM=rxvt> or even C<TERM=xterm>, and live with the small number of
678problems arising, which includes wrong keymapping, less and different 875problems arising, which includes wrong keymapping, less and different
679colours and some refresh errors in fullscreen applications. It's a nice 876colours and some refresh errors in fullscreen applications. It's a nice
686 URxvt.termName: rxvt 883 URxvt.termName: rxvt
687 884
688If you don't plan to use B<rxvt> (quite common...) you could also replace 885If you don't plan to use B<rxvt> (quite common...) you could also replace
689the rxvt terminfo file with the rxvt-unicode one and use C<TERM=rxvt>. 886the rxvt terminfo file with the rxvt-unicode one and use C<TERM=rxvt>.
690 887
888=head3 nano fails with "Error opening terminal: rxvt-unicode"
889
890This exceptionally confusing and useless error message is printed by nano
891when it can't find the terminfo database. Nothing is wrong with your
892terminal, read the previous answer for a solution.
893
691=head3 C<tic> outputs some error when compiling the terminfo entry. 894=head3 C<tic> outputs some error when compiling the terminfo entry.
692 895
693Most likely it's the empty definition for C<enacs=>. Just replace it by 896Most likely it's the empty definition for C<enacs=>. Just replace it by
694C<enacs=\E[0@> and try again. 897C<enacs=\E[0@> and try again.
695 898
702One reason you might want this is that some distributions or operating 905One reason you might want this is that some distributions or operating
703systems still compile some programs using the long-obsoleted termcap 906systems still compile some programs using the long-obsoleted termcap
704library (Fedora Core's bash is one example) and rely on a termcap entry 907library (Fedora Core's bash is one example) and rely on a termcap entry
705for C<rxvt-unicode>. 908for C<rxvt-unicode>.
706 909
707You could use rxvt's termcap entry with resonable results in many cases. 910You could use rxvt's termcap entry with reasonable results in many cases.
708You can also create a termcap entry by using terminfo's infocmp program 911You can also create a termcap entry by using terminfo's infocmp program
709like this: 912like this:
710 913
711 infocmp -C rxvt-unicode 914 infocmp -C rxvt-unicode
712 915
713Or you could use this termcap entry, generated by the command above: 916Or you could use the termcap entry in doc/etc/rxvt-unicode.termcap,
714 917generated by the command above.
715 rxvt-unicode|rxvt-unicode terminal (X Window System):\
716 :am:bw:eo:km:mi:ms:xn:xo:\
717 :co#80:it#8:li#24:lm#0:\
718 :AL=\E[%dL:DC=\E[%dP:DL=\E[%dM:DO=\E[%dB:IC=\E[%d@:\
719 :K1=\EOw:K2=\EOu:K3=\EOy:K4=\EOq:K5=\EOs:LE=\E[%dD:\
720 :RI=\E[%dC:SF=\E[%dS:SR=\E[%dT:UP=\E[%dA:ae=\E(B:al=\E[L:\
721 :as=\E(0:bl=^G:cd=\E[J:ce=\E[K:cl=\E[H\E[2J:\
722 :cm=\E[%i%d;%dH:cr=^M:cs=\E[%i%d;%dr:ct=\E[3g:dc=\E[P:\
723 :dl=\E[M:do=^J:ec=\E[%dX:ei=\E[4l:ho=\E[H:\
724 :i1=\E[?47l\E=\E[?1l:ic=\E[@:im=\E[4h:\
725 :is=\E[r\E[m\E[2J\E[H\E[?7h\E[?1;3;4;6l\E[4l:\
726 :k1=\E[11~:k2=\E[12~:k3=\E[13~:k4=\E[14~:k5=\E[15~:\
727 :k6=\E[17~:k7=\E[18~:k8=\E[19~:k9=\E[20~:kD=\E[3~:\
728 :kI=\E[2~:kN=\E[6~:kP=\E[5~:kb=\177:kd=\EOB:ke=\E[?1l\E>:\
729 :kh=\E[7~:kl=\EOD:kr=\EOC:ks=\E[?1h\E=:ku=\EOA:le=^H:\
730 :mb=\E[5m:md=\E[1m:me=\E[m\017:mr=\E[7m:nd=\E[C:rc=\E8:\
731 :sc=\E7:se=\E[27m:sf=^J:so=\E[7m:sr=\EM:st=\EH:ta=^I:\
732 :te=\E[r\E[?1049l:ti=\E[?1049h:ue=\E[24m:up=\E[A:\
733 :us=\E[4m:vb=\E[?5h\E[?5l:ve=\E[?25h:vi=\E[?25l:\
734 :vs=\E[?25h:
735 918
736=head3 Why does C<ls> no longer have coloured output? 919=head3 Why does C<ls> no longer have coloured output?
737 920
738The C<ls> in the GNU coreutils unfortunately doesn't use terminfo to 921The C<ls> in the GNU coreutils unfortunately doesn't use terminfo to
739decide wether a terminal has colour, but uses it's own configuration 922decide whether a terminal has colour, but uses its own configuration
740file. Needless to say, C<rxvt-unicode> is not in it's default file (among 923file. Needless to say, C<rxvt-unicode> is not in its default file (among
741with most other terminals supporting colour). Either add: 924with most other terminals supporting colour). Either add:
742 925
743 TERM rxvt-unicode 926 TERM rxvt-unicode
744 927
745to C</etc/DIR_COLORS> or simply add: 928to C</etc/DIR_COLORS> or simply add:
779If you encounter strange problems like typing an accented character but 962If you encounter strange problems like typing an accented character but
780getting two unrelated other characters or similar, or if program output is 963getting two unrelated other characters or similar, or if program output is
781subtly garbled, then you should check your locale settings. 964subtly garbled, then you should check your locale settings.
782 965
783Rxvt-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
784programs. 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,
785login script running within the rxvt-unicode window changes the locale to 968while the login script running within the rxvt-unicode window changes the
786something 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.
787 971
788The 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
789into 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.
790 974
791 printf '\e]701;%s\007' "$LC_CTYPE" 975 printf '\33]701;%s\007' "$LC_CTYPE" # $LANG or $LC_ALL are worth a try, too
792 976
793If 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
794supported on your systems. Some systems have a C<locale> command which 978supported on your systems. Some systems have a C<locale> command which
795displays 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
796it 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
817The reasons is that there exists a perfectly fine mechanism for selecting 1001The reasons is that there exists a perfectly fine mechanism for selecting
818the encoding, doing I/O and (most important) communicating this to all 1002the encoding, doing I/O and (most important) communicating this to all
819applications so everybody agrees on character properties such as width 1003applications so everybody agrees on character properties such as width
820and code number. This mechanism is the I<locale>. Applications not using 1004and code number. This mechanism is the I<locale>. Applications not using
821that 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
822characters wrong as it uses it's own, locale-independent table under all 1006characters wrong as it uses its own, locale-independent table under all
823locales). 1007locales).
824 1008
825Rxvt-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
826programs doing the same (that is, most) will automatically agree in the 1010programs doing the same (that is, most) will automatically agree in the
827interpretation of characters. 1011interpretation of characters.
846=head3 Can I switch locales at runtime? 1030=head3 Can I switch locales at runtime?
847 1031
848Yes, using an escape sequence. Try something like this, which sets 1032Yes, using an escape sequence. Try something like this, which sets
849rxvt-unicode's idea of C<LC_CTYPE>. 1033rxvt-unicode's idea of C<LC_CTYPE>.
850 1034
851 printf '\e]701;%s\007' ja_JP.SJIS 1035 printf '\33]701;%s\007' ja_JP.SJIS
852 1036
853See also the previous answer. 1037See also the previous answer.
854 1038
855Sometimes this capability is rather handy when you want to work in 1039Sometimes this capability is rather handy when you want to work in
856one 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
857(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
858first switches to a locale supported by xjdic and back later: 1042first switches to a locale supported by xjdic and back later:
859 1043
860 printf '\e]701;%s\007' ja_JP.SJIS 1044 printf '\33]701;%s\007' ja_JP.SJIS
861 xjdic -js 1045 xjdic -js
862 printf '\e]701;%s\007' de_DE.UTF-8 1046 printf '\33]701;%s\007' de_DE.UTF-8
863 1047
864You 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
865for some locales where character width differs between program- and 1049for some locales where character width differs between program- and
866rxvt-unicode-locales. 1050rxvt-unicode-locales.
867 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=item
1080
1081=back
1082
868=head3 My input method wants <some encoding> but I want UTF-8, what can I do? 1083=head3 My input method wants <some encoding> but I want UTF-8, what can I do?
869 1084
870You can specify separate locales for the input method and the rest of the 1085You can specify separate locales for the input method and the rest of the
871terminal, using the resource C<imlocale>: 1086terminal, using the resource C<imlocale>:
872 1087
873 URxvt.imlocale: ja_JP.EUC-JP 1088 URxvt.imlocale: ja_JP.EUC-JP
874 1089
875Now you can start your terminal with C<LC_CTYPE=ja_JP.UTF-8> and still 1090Now you can start your terminal with C<LC_CTYPE=ja_JP.UTF-8> and still
876use your input method. Please note, however, that you will not be able to 1091use your input method. Please note, however, that, depending on your Xlib
877input characters outside C<EUC-JP> in a normal way then, as your input 1092version, you may not be able to input characters outside C<EUC-JP> in a
878method limits you. 1093normal way then, as your input method limits you.
879 1094
880=head3 Rxvt-unicode crashes when the X Input Method changes or exits. 1095=head3 Rxvt-unicode crashes when the X Input Method changes or exits.
881 1096
882Unfortunately, this is unavoidable, as the XIM protocol is racy by 1097Unfortunately, this is unavoidable, as the XIM protocol is racy by
883design. Applications can avoid some crashes at the expense of memory 1098design. Applications can avoid some crashes at the expense of memory
909 1124
910=head3 I am maintaining rxvt-unicode for distribution/OS XXX, any recommendation? 1125=head3 I am maintaining rxvt-unicode for distribution/OS XXX, any recommendation?
911 1126
912You should build one binary with the default options. F<configure> 1127You should build one binary with the default options. F<configure>
913now enables most useful options, and the trend goes to making them 1128now enables most useful options, and the trend goes to making them
914runtime-switchable, too, so there is usually no drawback to enbaling them, 1129runtime-switchable, too, so there is usually no drawback to enabling them,
915except higher disk and possibly memory usage. The perl interpreter should 1130except higher disk and possibly memory usage. The perl interpreter should
916be enabled, as important functionality (menus, selection, likely more in 1131be enabled, as important functionality (menus, selection, likely more in
917the future) depends on it. 1132the future) depends on it.
918 1133
919You should not overwrite the C<perl-ext-common> snd C<perl-ext> resources 1134You should not overwrite the C<perl-ext-common> snd C<perl-ext> resources
942This forking is done as the very first within main(), which is very early 1157This forking is done as the very first within main(), which is very early
943and reduces possible bugs to initialisation code run before main(), or 1158and reduces possible bugs to initialisation code run before main(), or
944things like the dynamic loader of your system, which should result in very 1159things like the dynamic loader of your system, which should result in very
945little risk. 1160little risk.
946 1161
947=head3 On Solaris 9, many line-drawing characters are too wide.
948
949Seems to be a known bug, read
950L<http://nixdoc.net/files/forum/about34198.html>. Some people use the
951following ugly workaround to get non-double-wide-characters working:
952
953 #define wcwidth(x) wcwidth(x) > 1 ? 1 : wcwidth(x)
954
955=head3 I am on FreeBSD and rxvt-unicode does not seem to work at all. 1162=head3 I am on FreeBSD and rxvt-unicode does not seem to work at all.
956 1163
957Rxvt-unicode requires the symbol C<__STDC_ISO_10646__> to be defined 1164Rxvt-unicode requires the symbol C<__STDC_ISO_10646__> to be defined
958in your compile environment, or an implementation that implements it, 1165in your compile environment, or an implementation that implements it,
959wether it defines the symbol or not. C<__STDC_ISO_10646__> requires that 1166whether it defines the symbol or not. C<__STDC_ISO_10646__> requires that
960B<wchar_t> is represented as unicode. 1167B<wchar_t> is represented as unicode.
961 1168
962As you might have guessed, FreeBSD does neither define this symobl nor 1169As you might have guessed, FreeBSD does neither define this symbol nor
963does it support it. Instead, it uses it's own internal representation of 1170does it support it. Instead, it uses its own internal representation of
964B<wchar_t>. This is, of course, completely fine with respect to standards. 1171B<wchar_t>. This is, of course, completely fine with respect to standards.
965 1172
966However, that means rxvt-unicode only works in C<POSIX>, C<ISO-8859-1> and 1173However, that means rxvt-unicode only works in C<POSIX>, C<ISO-8859-1> and
967C<UTF-8> locales under FreeBSD (which all use Unicode as B<wchar_t>. 1174C<UTF-8> locales under FreeBSD (which all use Unicode as B<wchar_t>).
968 1175
969C<__STDC_ISO_10646__> is the only sane way to support multi-language 1176C<__STDC_ISO_10646__> is the only sane way to support multi-language
970apps in an OS, as using a locale-dependent (and non-standardized) 1177apps in an OS, as using a locale-dependent (and non-standardized)
971representation of B<wchar_t> makes it impossible to convert between 1178representation of B<wchar_t> makes it impossible to convert between
972B<wchar_t> (as used by X11 and your applications) and any other encoding 1179B<wchar_t> (as used by X11 and your applications) and any other encoding
982 1189
983The rxvt-unicode author insists that the right way to fix this is in the 1190The rxvt-unicode author insists that the right way to fix this is in the
984system libraries once and for all, instead of forcing every app to carry 1191system libraries once and for all, instead of forcing every app to carry
985complete replacements for them :) 1192complete replacements for them :)
986 1193
987=head3 I use Solaris 9 and it doesn't compile/work/etc.
988
989Try the diff in F<doc/solaris9.patch> as a base. It fixes the worst
990problems with C<wcwidth> and a compile problem.
991
992=head3 How can I use rxvt-unicode under cygwin? 1194=head3 How can I use rxvt-unicode under cygwin?
993 1195
994rxvt-unicode should compile and run out of the box on cygwin, using 1196rxvt-unicode should compile and run out of the box on cygwin, using
995the X11 libraries that come with cygwin. libW11 emulation is no 1197the X11 libraries that come with cygwin. libW11 emulation is no
996longer supported (and makes no sense, either, as it only supported a 1198longer supported (and makes no sense, either, as it only supported a
1000 1202
1001At the time of this writing, cygwin didn't seem to support any multi-byte 1203At the time of this writing, cygwin didn't seem to support any multi-byte
1002encodings (you might try C<LC_CTYPE=C-UTF-8>), so you are likely limited 1204encodings (you might try C<LC_CTYPE=C-UTF-8>), so you are likely limited
1003to 8-bit encodings. 1205to 8-bit encodings.
1004 1206
1207=head3 Character widths are not correct.
1208
1209urxvt uses the system wcwidth function to know the information about
1210the width of characters, so on systems with incorrect locale data you
1211will likely get bad results. Two notorious examples are Solaris 9,
1212where single-width characters like U+2514 are reported as double-width,
1213and Darwin 8, where combining chars are reported having width 1.
1214
1215The solution is to upgrade your system or switch to a better one. A
1216possibly working workaround is to use a wcwidth implementation like
1217
1218http://www.cl.cam.ac.uk/~mgk25/ucs/wcwidth.c
1219
1220=head3 I want 256 colors
1221
1222Are you sure you need 256 colors? 88 colors should be enough for most
1223purposes. If you really need more, there is an unsupported patch for
1224it in the doc directory, but please do not ask for it to be applied.
1225
1005=head1 RXVT-UNICODE TECHNICAL REFERENCE 1226=head1 RXVT-UNICODE TECHNICAL REFERENCE
1006
1007=head1 DESCRIPTION
1008 1227
1009The rest of this document describes various technical aspects of 1228The rest of this document describes various technical aspects of
1010B<rxvt-unicode>. First the description of supported command sequences, 1229B<rxvt-unicode>. First the description of supported command sequences,
1011followed by pixmap support and last by a description of all features 1230followed by pixmap support and last by a description of all features
1012selectable at C<configure> time. 1231selectable at C<configure> time.
1013 1232
1014=head1 Definitions 1233=head2 Definitions
1015 1234
1016=over 4 1235=over 4
1017 1236
1018=item B<< C<c> >> 1237=item B<< C<c> >>
1019 1238
1037 1256
1038A text parameter composed of printable characters. 1257A text parameter composed of printable characters.
1039 1258
1040=back 1259=back
1041 1260
1042=head1 Values 1261=head2 Values
1043 1262
1044=over 4 1263=over 4
1045 1264
1046=item B<< C<ENQ> >> 1265=item B<< C<ENQ> >>
1047 1266
1090 1309
1091Space Character 1310Space Character
1092 1311
1093=back 1312=back
1094 1313
1095=head1 Escape Sequences 1314=head2 Escape Sequences
1096 1315
1097=over 4 1316=over 4
1098 1317
1099=item B<< C<ESC # 8> >> 1318=item B<< C<ESC # 8> >>
1100 1319
1198 1417
1199=back 1418=back
1200 1419
1201X<CSI> 1420X<CSI>
1202 1421
1203=head1 CSI (Command Sequence Introducer) Sequences 1422=head2 CSI (Command Sequence Introducer) Sequences
1204 1423
1205=over 4 1424=over 4
1206 1425
1207=item B<< C<ESC [ Ps @> >> 1426=item B<< C<ESC [ Ps @> >>
1208 1427
1263=begin table 1482=begin table
1264 1483
1265 B<< C<Ps = 0> >> Clear to Right (default) 1484 B<< C<Ps = 0> >> Clear to Right (default)
1266 B<< C<Ps = 1> >> Clear to Left 1485 B<< C<Ps = 1> >> Clear to Left
1267 B<< C<Ps = 2> >> Clear All 1486 B<< C<Ps = 2> >> Clear All
1487 B<< C<Ps = 3> >> Like Ps = 0, but is ignored when wrapped
1488 (@@RXVT_NAME@@ extension)
1268 1489
1269=end table 1490=end table
1270 1491
1271=item B<< C<ESC [ Ps L> >> 1492=item B<< C<ESC [ Ps L> >>
1272 1493
1478 1699
1479=back 1700=back
1480 1701
1481X<PrivateModes> 1702X<PrivateModes>
1482 1703
1483=head1 DEC Private Modes 1704=head2 DEC Private Modes
1484 1705
1485=over 4 1706=over 4
1486 1707
1487=item B<< C<ESC [ ? Pm h> >> 1708=item B<< C<ESC [ ? Pm h> >>
1488 1709
1504 1725
1505Toggle DEC Private Mode Values (rxvt extension). I<where> 1726Toggle DEC Private Mode Values (rxvt extension). I<where>
1506 1727
1507=over 4 1728=over 4
1508 1729
1509=item B<< C<Ps = 1> >> (DECCKM) 1730=item B<< C<Pm = 1> >> (DECCKM)
1510 1731
1511=begin table 1732=begin table
1512 1733
1513 B<< C<h> >> Application Cursor Keys 1734 B<< C<h> >> Application Cursor Keys
1514 B<< C<l> >> Normal Cursor Keys 1735 B<< C<l> >> Normal Cursor Keys
1515 1736
1516=end table 1737=end table
1517 1738
1518=item B<< C<Ps = 2> >> (ANSI/VT52 mode) 1739=item B<< C<Pm = 2> >> (ANSI/VT52 mode)
1519 1740
1520=begin table 1741=begin table
1521 1742
1522 B<< C<h> >> Enter VT52 mode 1743 B<< C<h> >> Enter VT52 mode
1523 B<< C<l> >> Enter VT52 mode 1744 B<< C<l> >> Enter VT52 mode
1524 1745
1525=end table 1746=end table
1526 1747
1527=item B<< C<Ps = 3> >> 1748=item B<< C<Pm = 3> >>
1528 1749
1529=begin table 1750=begin table
1530 1751
1531 B<< C<h> >> 132 Column Mode (DECCOLM) 1752 B<< C<h> >> 132 Column Mode (DECCOLM)
1532 B<< C<l> >> 80 Column Mode (DECCOLM) 1753 B<< C<l> >> 80 Column Mode (DECCOLM)
1533 1754
1534=end table 1755=end table
1535 1756
1536=item B<< C<Ps = 4> >> 1757=item B<< C<Pm = 4> >>
1537 1758
1538=begin table 1759=begin table
1539 1760
1540 B<< C<h> >> Smooth (Slow) Scroll (DECSCLM) 1761 B<< C<h> >> Smooth (Slow) Scroll (DECSCLM)
1541 B<< C<l> >> Jump (Fast) Scroll (DECSCLM) 1762 B<< C<l> >> Jump (Fast) Scroll (DECSCLM)
1542 1763
1543=end table 1764=end table
1544 1765
1545=item B<< C<Ps = 5> >> 1766=item B<< C<Pm = 5> >>
1546 1767
1547=begin table 1768=begin table
1548 1769
1549 B<< C<h> >> Reverse Video (DECSCNM) 1770 B<< C<h> >> Reverse Video (DECSCNM)
1550 B<< C<l> >> Normal Video (DECSCNM) 1771 B<< C<l> >> Normal Video (DECSCNM)
1551 1772
1552=end table 1773=end table
1553 1774
1554=item B<< C<Ps = 6> >> 1775=item B<< C<Pm = 6> >>
1555 1776
1556=begin table 1777=begin table
1557 1778
1558 B<< C<h> >> Origin Mode (DECOM) 1779 B<< C<h> >> Origin Mode (DECOM)
1559 B<< C<l> >> Normal Cursor Mode (DECOM) 1780 B<< C<l> >> Normal Cursor Mode (DECOM)
1560 1781
1561=end table 1782=end table
1562 1783
1563=item B<< C<Ps = 7> >> 1784=item B<< C<Pm = 7> >>
1564 1785
1565=begin table 1786=begin table
1566 1787
1567 B<< C<h> >> Wraparound Mode (DECAWM) 1788 B<< C<h> >> Wraparound Mode (DECAWM)
1568 B<< C<l> >> No Wraparound Mode (DECAWM) 1789 B<< C<l> >> No Wraparound Mode (DECAWM)
1569 1790
1570=end table 1791=end table
1571 1792
1572=item B<< C<Ps = 8> >> I<unimplemented> 1793=item B<< C<Pm = 8> >> I<unimplemented>
1573 1794
1574=begin table 1795=begin table
1575 1796
1576 B<< C<h> >> Auto-repeat Keys (DECARM) 1797 B<< C<h> >> Auto-repeat Keys (DECARM)
1577 B<< C<l> >> No Auto-repeat Keys (DECARM) 1798 B<< C<l> >> No Auto-repeat Keys (DECARM)
1578 1799
1579=end table 1800=end table
1580 1801
1581=item B<< C<Ps = 9> >> X10 XTerm 1802=item B<< C<Pm = 9> >> X10 XTerm
1582 1803
1583=begin table 1804=begin table
1584 1805
1585 B<< C<h> >> Send Mouse X & Y on button press. 1806 B<< C<h> >> Send Mouse X & Y on button press.
1586 B<< C<l> >> No mouse reporting. 1807 B<< C<l> >> No mouse reporting.
1587 1808
1588=end table 1809=end table
1589 1810
1590=item B<< C<Ps = 25> >> 1811=item B<< C<Pm = 25> >>
1591 1812
1592=begin table 1813=begin table
1593 1814
1594 B<< C<h> >> Visible cursor {cnorm/cvvis} 1815 B<< C<h> >> Visible cursor {cnorm/cvvis}
1595 B<< C<l> >> Invisible cursor {civis} 1816 B<< C<l> >> Invisible cursor {civis}
1596 1817
1597=end table 1818=end table
1598 1819
1599=item B<< C<Ps = 30> >> 1820=item B<< C<Pm = 30> >>
1600 1821
1601=begin table 1822=begin table
1602 1823
1603 B<< C<h> >> scrollBar visisble 1824 B<< C<h> >> scrollBar visible
1604 B<< C<l> >> scrollBar invisisble 1825 B<< C<l> >> scrollBar invisible
1605 1826
1606=end table 1827=end table
1607 1828
1608=item B<< C<Ps = 35> >> (B<rxvt>) 1829=item B<< C<Pm = 35> >> (B<rxvt>)
1609 1830
1610=begin table 1831=begin table
1611 1832
1612 B<< C<h> >> Allow XTerm Shift+key sequences 1833 B<< C<h> >> Allow XTerm Shift+key sequences
1613 B<< C<l> >> Disallow XTerm Shift+key sequences 1834 B<< C<l> >> Disallow XTerm Shift+key sequences
1614 1835
1615=end table 1836=end table
1616 1837
1617=item B<< C<Ps = 38> >> I<unimplemented> 1838=item B<< C<Pm = 38> >> I<unimplemented>
1618 1839
1619Enter Tektronix Mode (DECTEK) 1840Enter Tektronix Mode (DECTEK)
1620 1841
1621=item B<< C<Ps = 40> >> 1842=item B<< C<Pm = 40> >>
1622 1843
1623=begin table 1844=begin table
1624 1845
1625 B<< C<h> >> Allow 80/132 Mode 1846 B<< C<h> >> Allow 80/132 Mode
1626 B<< C<l> >> Disallow 80/132 Mode 1847 B<< C<l> >> Disallow 80/132 Mode
1627 1848
1628=end table 1849=end table
1629 1850
1630=item B<< C<Ps = 44> >> I<unimplemented> 1851=item B<< C<Pm = 44> >> I<unimplemented>
1631 1852
1632=begin table 1853=begin table
1633 1854
1634 B<< C<h> >> Turn On Margin Bell 1855 B<< C<h> >> Turn On Margin Bell
1635 B<< C<l> >> Turn Off Margin Bell 1856 B<< C<l> >> Turn Off Margin Bell
1636 1857
1637=end table 1858=end table
1638 1859
1639=item B<< C<Ps = 45> >> I<unimplemented> 1860=item B<< C<Pm = 45> >> I<unimplemented>
1640 1861
1641=begin table 1862=begin table
1642 1863
1643 B<< C<h> >> Reverse-wraparound Mode 1864 B<< C<h> >> Reverse-wraparound Mode
1644 B<< C<l> >> No Reverse-wraparound Mode 1865 B<< C<l> >> No Reverse-wraparound Mode
1645 1866
1646=end table 1867=end table
1647 1868
1648=item B<< C<Ps = 46> >> I<unimplemented> 1869=item B<< C<Pm = 46> >> I<unimplemented>
1649 1870
1650=item B<< C<Ps = 47> >> 1871=item B<< C<Pm = 47> >>
1651 1872
1652=begin table 1873=begin table
1653 1874
1654 B<< C<h> >> Use Alternate Screen Buffer 1875 B<< C<h> >> Use Alternate Screen Buffer
1655 B<< C<l> >> Use Normal Screen Buffer 1876 B<< C<l> >> Use Normal Screen Buffer
1656 1877
1657=end table 1878=end table
1658 1879
1659X<Priv66> 1880X<Priv66>
1660 1881
1661=item B<< C<Ps = 66> >> 1882=item B<< C<Pm = 66> >>
1662 1883
1663=begin table 1884=begin table
1664 1885
1665 B<< C<h> >> Application Keypad (DECPAM) == C<ESC => 1886 B<< C<h> >> Application Keypad (DECPAM) == C<ESC =>
1666 B<< C<l> >> Normal Keypad (DECPNM) == C<< ESC > >> 1887 B<< C<l> >> Normal Keypad (DECPNM) == C<< ESC > >>
1667 1888
1668=end table 1889=end table
1669 1890
1670=item B<< C<Ps = 67> >> 1891=item B<< C<Pm = 67> >>
1671 1892
1672=begin table 1893=begin table
1673 1894
1674 B<< C<h> >> Backspace key sends B<< C<BS> (DECBKM) >> 1895 B<< C<h> >> Backspace key sends B<< C<BS> (DECBKM) >>
1675 B<< C<l> >> Backspace key sends B<< C<DEL> >> 1896 B<< C<l> >> Backspace key sends B<< C<DEL> >>
1676 1897
1677=end table 1898=end table
1678 1899
1679=item B<< C<Ps = 1000> >> (X11 XTerm) 1900=item B<< C<Pm = 1000> >> (X11 XTerm)
1680 1901
1681=begin table 1902=begin table
1682 1903
1683 B<< C<h> >> Send Mouse X & Y on button press and release. 1904 B<< C<h> >> Send Mouse X & Y on button press and release.
1684 B<< C<l> >> No mouse reporting. 1905 B<< C<l> >> No mouse reporting.
1685 1906
1686=end table 1907=end table
1687 1908
1688=item B<< C<Ps = 1001> >> (X11 XTerm) I<unimplemented> 1909=item B<< C<Pm = 1001> >> (X11 XTerm) I<unimplemented>
1689 1910
1690=begin table 1911=begin table
1691 1912
1692 B<< C<h> >> Use Hilite Mouse Tracking. 1913 B<< C<h> >> Use Hilite Mouse Tracking.
1693 B<< C<l> >> No mouse reporting. 1914 B<< C<l> >> No mouse reporting.
1694 1915
1695=end table 1916=end table
1696 1917
1918=item B<< C<Pm = 1002> >> (X11 XTerm)
1919
1920=begin table
1921
1922 B<< C<h> >> Send Mouse X & Y on button press and release, and motion with a button pressed.
1923 B<< C<l> >> No mouse reporting.
1924
1925=end table
1926
1927=item B<< C<Pm = 1003> >> (X11 XTerm)
1928
1929=begin table
1930
1931 B<< C<h> >> Send Mouse X & Y on button press and release, and motion.
1932 B<< C<l> >> No mouse reporting.
1933
1934=end table
1935
1697=item B<< C<Ps = 1010> >> (B<rxvt>) 1936=item B<< C<Pm = 1010> >> (B<rxvt>)
1698 1937
1699=begin table 1938=begin table
1700 1939
1701 B<< C<h> >> Don't scroll to bottom on TTY output 1940 B<< C<h> >> Don't scroll to bottom on TTY output
1702 B<< C<l> >> Scroll to bottom on TTY output 1941 B<< C<l> >> Scroll to bottom on TTY output
1703 1942
1704=end table 1943=end table
1705 1944
1706=item B<< C<Ps = 1011> >> (B<rxvt>) 1945=item B<< C<Pm = 1011> >> (B<rxvt>)
1707 1946
1708=begin table 1947=begin table
1709 1948
1710 B<< C<h> >> Scroll to bottom when a key is pressed 1949 B<< C<h> >> Scroll to bottom when a key is pressed
1711 B<< C<l> >> Don't scroll to bottom when a key is pressed 1950 B<< C<l> >> Don't scroll to bottom when a key is pressed
1712 1951
1713=end table 1952=end table
1714 1953
1715=item B<< C<Ps = 1021> >> (B<rxvt>) 1954=item B<< C<Pm = 1021> >> (B<rxvt>)
1716 1955
1717=begin table 1956=begin table
1718 1957
1719 B<< C<h> >> Bold/italic implies high intensity (see option B<-is>) 1958 B<< C<h> >> Bold/italic implies high intensity (see option B<-is>)
1720 B<< C<l> >> Font styles have no effect on intensity (Compile styles) 1959 B<< C<l> >> Font styles have no effect on intensity (Compile styles)
1721 1960
1722=end table 1961=end table
1723 1962
1724=item B<< C<Ps = 1047> >> 1963=item B<< C<Pm = 1047> >>
1725 1964
1726=begin table 1965=begin table
1727 1966
1728 B<< C<h> >> Use Alternate Screen Buffer 1967 B<< C<h> >> Use Alternate Screen Buffer
1729 B<< C<l> >> Use Normal Screen Buffer - clear Alternate Screen Buffer if returning from it 1968 B<< C<l> >> Use Normal Screen Buffer - clear Alternate Screen Buffer if returning from it
1730 1969
1731=end table 1970=end table
1732 1971
1733=item B<< C<Ps = 1048> >> 1972=item B<< C<Pm = 1048> >>
1734 1973
1735=begin table 1974=begin table
1736 1975
1737 B<< C<h> >> Save cursor position 1976 B<< C<h> >> Save cursor position
1738 B<< C<l> >> Restore cursor position 1977 B<< C<l> >> Restore cursor position
1739 1978
1740=end table 1979=end table
1741 1980
1742=item B<< C<Ps = 1049> >> 1981=item B<< C<Pm = 1049> >>
1743 1982
1744=begin table 1983=begin table
1745 1984
1746 B<< C<h> >> Use Alternate Screen Buffer - clear Alternate Screen Buffer if switching to it 1985 B<< C<h> >> Use Alternate Screen Buffer - clear Alternate Screen Buffer if switching to it
1747 B<< C<l> >> Use Normal Screen Buffer 1986 B<< C<l> >> Use Normal Screen Buffer
1748 1987
1749=end table 1988=end table
1750 1989
1990=item B<< C<Pm = 2004> >>
1991
1992=begin table
1993
1994 B<< C<h> >> Enable bracketed paste mode - prepend / append to the pasted text the control sequences C<ESC [ 200 ~> / C<ESC [ 201 ~>
1995 B<< C<l> >> Disable bracketed paste mode
1996
1997=end table
1998
1751=back 1999=back
1752 2000
1753=back 2001=back
1754 2002
1755X<XTerm> 2003X<XTerm>
1756 2004
1757=head1 XTerm Operating System Commands 2005=head2 XTerm Operating System Commands
1758 2006
1759=over 4 2007=over 4
1760 2008
1761=item B<< C<ESC ] Ps;Pt ST> >> 2009=item B<< C<ESC ] Ps;Pt ST> >>
1762 2010
1769 B<< C<Ps = 0> >> Change Icon Name and Window Title to B<< C<Pt> >> 2017 B<< C<Ps = 0> >> Change Icon Name and Window Title to B<< C<Pt> >>
1770 B<< C<Ps = 1> >> Change Icon Name to B<< C<Pt> >> 2018 B<< C<Ps = 1> >> Change Icon Name to B<< C<Pt> >>
1771 B<< C<Ps = 2> >> Change Window Title to B<< C<Pt> >> 2019 B<< C<Ps = 2> >> Change Window Title to B<< C<Pt> >>
1772 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. 2020 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.
1773 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 2021 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
1774 B<< C<Ps = 10> >> Change colour of text foreground to B<< C<Pt> >> B<(NB: may change in future)> 2022 B<< C<Ps = 10> >> Change colour of text foreground to B<< C<Pt> >>
1775 B<< C<Ps = 11> >> Change colour of text background to B<< C<Pt> >> B<(NB: may change in future)> 2023 B<< C<Ps = 11> >> Change colour of text background to B<< C<Pt> >>
1776 B<< C<Ps = 12> >> Change colour of text cursor foreground to B<< C<Pt> >> 2024 B<< C<Ps = 12> >> Change colour of text cursor foreground to B<< C<Pt> >>
1777 B<< C<Ps = 13> >> Change colour of mouse foreground to B<< C<Pt> >> 2025 B<< C<Ps = 13> >> Change colour of mouse foreground to B<< C<Pt> >>
1778 B<< C<Ps = 17> >> Change colour of highlight characters to B<< C<Pt> >> 2026 B<< C<Ps = 17> >> Change colour of highlight characters to B<< C<Pt> >>
1779 B<< C<Ps = 18> >> Change colour of bold characters to B<< C<Pt> >> [deprecated, see 706] 2027 B<< C<Ps = 18> >> Change colour of bold characters to B<< C<Pt> >> [deprecated, see 706]
1780 B<< C<Ps = 19> >> Change colour of underlined characters to B<< C<Pt> >> [deprecated, see 707] 2028 B<< C<Ps = 19> >> Change colour of underlined characters to B<< C<Pt> >> [deprecated, see 707]
1781 B<< C<Ps = 20> >> Change background pixmap parameters (see section XPM) (Compile XPM). 2029 B<< C<Ps = 20> >> Change background pixmap parameters (see section BACKGROUND IMAGE) (Compile AfterImage).
1782 B<< C<Ps = 39> >> Change default foreground colour to B<< C<Pt> >>. 2030 B<< C<Ps = 39> >> Change default foreground colour to B<< C<Pt> >>. [deprecated, use 10]
1783 B<< C<Ps = 46> >> Change Log File to B<< C<Pt> >> I<unimplemented> 2031 B<< C<Ps = 46> >> Change Log File to B<< C<Pt> >> I<unimplemented>
1784 B<< C<Ps = 49> >> Change default background colour to B<< C<Pt> >>. 2032 B<< C<Ps = 49> >> Change default background colour to B<< C<Pt> >>. [deprecated, use 11]
1785 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> >> 2033 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> >>
1786 B<< C<Ps = 55> >> Log all scrollback buffer and all of screen to B<< C<Pt> >> 2034 B<< C<Ps = 55> >> Log all scrollback buffer and all of screen to B<< C<Pt> >> [disabled]
1787 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). 2035 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).
1788 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>. 2036 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>.
1789 B<< C<Ps = 704> >> Change colour of italic characters to B<< C<Pt> >> 2037 B<< C<Ps = 704> >> Change colour of italic characters to B<< C<Pt> >>
1790 B<< C<Ps = 705> >> Change background pixmap tint colour to B<< C<Pt> >> (Compile transparency). 2038 B<< C<Ps = 705> >> Change background pixmap tint colour to B<< C<Pt> >> (Compile transparency).
1791 B<< C<Ps = 706> >> Change colour of bold characters to B<< C<Pt> >> 2039 B<< C<Ps = 706> >> Change colour of bold characters to B<< C<Pt> >>
1792 B<< C<Ps = 707> >> Change colour of underlined characters to B<< C<Pt> >> 2040 B<< C<Ps = 707> >> Change colour of underlined characters to B<< C<Pt> >>
2041 B<< C<Ps = 708> >> Change colour of the border to B<< C<Pt> >>
1793 B<< C<Ps = 710> >> Set normal fontset to B<< C<Pt> >>. Same as C<Ps = 50>. 2042 B<< C<Ps = 710> >> Set normal fontset to B<< C<Pt> >>. Same as C<Ps = 50>.
1794 B<< C<Ps = 711> >> Set bold fontset to B<< C<Pt> >>. Similar to C<Ps = 50> (Compile styles). 2043 B<< C<Ps = 711> >> Set bold fontset to B<< C<Pt> >>. Similar to C<Ps = 50> (Compile styles).
1795 B<< C<Ps = 712> >> Set italic fontset to B<< C<Pt> >>. Similar to C<Ps = 50> (Compile styles). 2044 B<< C<Ps = 712> >> Set italic fontset to B<< C<Pt> >>. Similar to C<Ps = 50> (Compile styles).
1796 B<< C<Ps = 713> >> Set bold-italic fontset to B<< C<Pt> >>. Similar to C<Ps = 50> (Compile styles). 2045 B<< C<Ps = 713> >> Set bold-italic fontset to B<< C<Pt> >>. Similar to C<Ps = 50> (Compile styles).
1797 B<< C<Ps = 720> >> Move viewing window up by B<< C<Pt> >> lines, or clear scrollback buffer if C<Pt = 0> (Compile frills). 2046 B<< C<Ps = 720> >> Move viewing window up by B<< C<Pt> >> lines, or clear scrollback buffer if C<Pt = 0> (Compile frills).
1800 2049
1801=end table 2050=end table
1802 2051
1803=back 2052=back
1804 2053
1805X<XPM> 2054=head1 BACKGROUND IMAGE
1806 2055
1807=head1 XPM
1808
1809For the XPM XTerm escape sequence B<< C<ESC ] 20 ; Pt ST> >> then value 2056For the BACKGROUND IMAGE XTerm escape sequence B<< C<ESC ] 20 ; Pt ST> >> the value
1810of B<< C<Pt> >> can be the name of the background pixmap followed by a 2057of B<< C<Pt> >> can be the name of the background image file followed by a
1811sequence of scaling/positioning commands separated by semi-colons. The 2058sequence of scaling/positioning commands separated by semi-colons. The
1812scaling/positioning commands are as follows: 2059scaling/positioning commands are as follows:
1813 2060
1814=over 4 2061=over 4
1815 2062
1853 2100
1854For example: 2101For example:
1855 2102
1856=over 4 2103=over 4
1857 2104
1858=item B<\E]20;funky\a> 2105=item B<\E]20;funky.jpg\a>
1859 2106
1860load B<funky.xpm> as a tiled image 2107load B<funky.jpg> as a tiled image
1861 2108
1862=item B<\E]20;mona;100\a> 2109=item B<\E]20;mona.jpg;100\a>
1863 2110
1864load B<mona.xpm> with a scaling of 100% 2111load B<mona.jpg> with a scaling of 100%
1865 2112
1866=item B<\E]20;;200;?\a> 2113=item B<\E]20;;200;?\a>
1867 2114
1868rescale the current pixmap to 200% and display the image geometry in 2115rescale the current pixmap to 200% and display the image geometry in
1869the title 2116the title
1870 2117
1871=back 2118=back
2119
1872X<Mouse> 2120X<Mouse>
1873 2121
1874=head1 Mouse Reporting 2122=head1 Mouse Reporting
1875 2123
1876=over 4 2124=over 4
1917Col = B<< C<< <x> - SPACE >> >> 2165Col = B<< C<< <x> - SPACE >> >>
1918 2166
1919Row = B<< C<< <y> - SPACE >> >> 2167Row = B<< C<< <y> - SPACE >> >>
1920 2168
1921=back 2169=back
2170
2171=head1 Key Codes
2172
1922X<KeyCodes> 2173X<KeyCodes>
1923
1924=head1 Key Codes
1925 2174
1926Note: B<Shift> + B<F1>-B<F10> generates B<F11>-B<F20> 2175Note: B<Shift> + B<F1>-B<F10> generates B<F11>-B<F20>
1927 2176
1928For the keypad, use B<Shift> to temporarily override Application-Keypad 2177For the keypad, use B<Shift> to temporarily override Application-Keypad
1929setting use B<Num_Lock> to toggle Application-Keypad setting if 2178setting use B<Num_Lock> to toggle Application-Keypad setting if
1996 2245
1997=head1 CONFIGURE OPTIONS 2246=head1 CONFIGURE OPTIONS
1998 2247
1999General hint: if you get compile errors, then likely your configuration 2248General hint: if you get compile errors, then likely your configuration
2000hasn't been tested well. Either try with C<--enable-everything> or use 2249hasn't been tested well. Either try with C<--enable-everything> or use
2001the F<./reconf> script as a base for experiments. F<./reconf> is used by 2250the default configuration (i.e. no C<--enable-xxx> or C<--disable-xxx>
2002myself, so it should generally be a working config. Of course, you should 2251switches). Of course, you should always report when a combination doesn't
2003always report when a combination doesn't work, so it can be fixed. Marc 2252work, so it can be fixed. Marc Lehmann <rxvt@schmorp.de>.
2004Lehmann <rxvt@schmorp.de>.
2005 2253
2006All 2254All
2007 2255
2008=over 4 2256=over 4
2009 2257
2041 2289
2042=begin table 2290=begin table
2043 2291
2044 all all available codeset groups 2292 all all available codeset groups
2045 zh common chinese encodings 2293 zh common chinese encodings
2046 zh_ext rarely used but very big chinese encodigs 2294 zh_ext rarely used but very big chinese encodings
2047 jp common japanese encodings 2295 jp common japanese encodings
2048 jp_ext rarely used but big japanese encodings 2296 jp_ext rarely used but big japanese encodings
2049 kr korean encodings 2297 kr korean encodings
2050 2298
2051=end table 2299=end table
2065requirements per character from 2 to 4 bytes. X11 fonts do not yet 2313requirements per character from 2 to 4 bytes. X11 fonts do not yet
2066support these extra characters, but Xft does. 2314support these extra characters, but Xft does.
2067 2315
2068Please note that rxvt-unicode can store unicode code points >65535 2316Please note that rxvt-unicode can store unicode code points >65535
2069even without this flag, but the number of such characters is 2317even without this flag, but the number of such characters is
2070limited to a view thousand (shared with combining characters, 2318limited to a few thousand (shared with combining characters,
2071see next switch), and right now rxvt-unicode cannot display them 2319see next switch), and right now rxvt-unicode cannot display them
2072(input/output and cut&paste still work, though). 2320(input/output and cut&paste still work, though).
2073 2321
2074=item --enable-combining (default: on) 2322=item --enable-combining (default: on)
2075 2323
2098=item --with-res-name=NAME (default: urxvt) 2346=item --with-res-name=NAME (default: urxvt)
2099 2347
2100Use the given name as default application name when 2348Use the given name as default application name when
2101reading resources. Specify --with-res-name=rxvt to replace rxvt. 2349reading resources. Specify --with-res-name=rxvt to replace rxvt.
2102 2350
2103=item --with-res-class=CLASS /default: URxvt) 2351=item --with-res-class=CLASS (default: URxvt)
2104 2352
2105Use the given class as default application class 2353Use the given class as default application class
2106when reading resources. Specify --with-res-class=Rxvt to replace 2354when reading resources. Specify --with-res-class=Rxvt to replace
2107rxvt. 2355rxvt.
2108 2356
2121 2369
2122Write user and tty to lastlog file (used by programs like 2370Write user and tty to lastlog file (used by programs like
2123F<lastlogin>) at start of rxvt execution. This option requires 2371F<lastlogin>) at start of rxvt execution. This option requires
2124--enable-utmp to also be specified. 2372--enable-utmp to also be specified.
2125 2373
2126=item --enable-xpm-background (default: on) 2374=item --enable-afterimage (default: on)
2127 2375
2128Add support for XPM background pixmaps. 2376Add support for libAfterImage to be used for transparency and background
2377images. It adds support for many file formats including JPG, PNG,
2378SVG, TIFF, GIF, XPM, BMP, ICO, XCF, TGA and AfterStep image XML
2379(L<http://www.afterstep.org/visualdoc.php?show=asimagexml>).
2380
2381This option also adds such eye candy as blending an image over the root
2382background, as well as dynamic scaling and bluring of background images.
2383
2384Note that with this option enabled, @@RXVT_NAME@@'s memory footprint might
2385increase by a few megabytes even if no extra features are used (mostly due
2386to third-party libraries used by libAI). Memory footprint may somewhat be
2387lowered if libAfterImage is configured without support for SVG.
2129 2388
2130=item --enable-transparency (default: on) 2389=item --enable-transparency (default: on)
2131 2390
2132Add support for inheriting parent backgrounds thus giving a fake 2391Add support for backgrounds, creating illusion of transparency in the term.
2133transparency to the term.
2134 2392
2135=item --enable-fading (default: on) 2393=item --enable-fading (default: on)
2136 2394
2137Add support for fading the text when focus is lost (requires C<--enable-transparency>). 2395Add support for fading the text when focus is lost.
2138
2139=item --enable-tinting (default: on)
2140
2141Add support for tinting of transparent backgrounds (requires C<--enable-transparency>).
2142 2396
2143=item --enable-rxvt-scroll (default: on) 2397=item --enable-rxvt-scroll (default: on)
2144 2398
2145Add support for the original rxvt scrollbar. 2399Add support for the original rxvt scrollbar.
2146 2400
2149Add support for a NeXT-like scrollbar. 2403Add support for a NeXT-like scrollbar.
2150 2404
2151=item --enable-xterm-scroll (default: on) 2405=item --enable-xterm-scroll (default: on)
2152 2406
2153Add support for an Xterm-like scrollbar. 2407Add support for an Xterm-like scrollbar.
2154
2155=item --enable-plain-scroll (default: on)
2156
2157Add support for a very unobtrusive, plain-looking scrollbar that
2158is the favourite of the rxvt-unicode author, having used it for
2159many years.
2160
2161=item --enable-ttygid (default: off)
2162
2163Change tty device setting to group "tty" - only use this if
2164your system uses this type of security.
2165 2408
2166=item --disable-backspace-key 2409=item --disable-backspace-key
2167 2410
2168Removes any handling of the backspace key by us - let the X server do it. 2411Removes any handling of the backspace key by us - let the X server do it.
2169 2412
2189A non-exhaustive list of features enabled by C<--enable-frills> (possibly 2432A non-exhaustive list of features enabled by C<--enable-frills> (possibly
2190in combination with other switches) is: 2433in combination with other switches) is:
2191 2434
2192 MWM-hints 2435 MWM-hints
2193 EWMH-hints (pid, utf8 names) and protocols (ping) 2436 EWMH-hints (pid, utf8 names) and protocols (ping)
2437 urgency hint
2194 seperate underline colour (-underlineColor) 2438 seperate underline colour (-underlineColor)
2195 settable border widths and borderless switch (-w, -b, -bl) 2439 settable border widths and borderless switch (-w, -b, -bl)
2196 visual depth selection (-depth) 2440 visual depth selection (-depth)
2197 settable extra linespacing /-lsp) 2441 settable extra linespacing /-lsp)
2198 iso-14755-2 and -3, and visual feedback 2442 iso-14755 5.1 (basic) support
2199 tripleclickwords (-tcw) 2443 tripleclickwords (-tcw)
2200 settable insecure mode (-insecure) 2444 settable insecure mode (-insecure)
2201 keysym remapping support 2445 keysym remapping support
2202 cursor blinking and underline cursor (-cb, -uc) 2446 cursor blinking and underline cursor (-bc, -uc)
2203 XEmbed support (-embed) 2447 XEmbed support (-embed)
2204 user-pty (-pty-fd) 2448 user-pty (-pty-fd)
2205 hold on exit (-hold) 2449 hold on exit (-hold)
2450 compile in built-in block graphics
2206 skip builtin block graphics (-sbg) 2451 skip builtin block graphics (-sbg)
2452 separate highlightcolor support (-hc)
2207 2453
2208It also enabled some non-essential features otherwise disabled, such as: 2454It also enables some non-essential features otherwise disabled, such as:
2209 2455
2210 some round-trip time optimisations 2456 some round-trip time optimisations
2211 nearest color allocation on pseudocolor screens 2457 nearest color allocation on pseudocolor screens
2212 UTF8_STRING supporr for selection 2458 UTF8_STRING support for selection
2213 sgr modes 90..97 and 100..107 2459 sgr modes 90..97 and 100..107
2214 backindex and forwardindex escape sequences 2460 backindex and forwardindex escape sequences
2215 view change/zero scorllback esacpe sequences 2461 view change/zero scrollback escape sequences
2216 locale switching escape sequence 2462 locale switching escape sequence
2217 window op and some xterm/OSC escape sequences 2463 window op and some xterm/OSC escape sequences
2218 rectangular selections 2464 rectangular selections
2219 trailing space removal for selections 2465 trailing space removal for selections
2220 verbose X error handling 2466 verbose X error handling
2221 2467
2222=item --enable-iso14755 (default: on) 2468=item --enable-iso14755 (default: on)
2223 2469
2224Enable extended ISO 14755 support (see @@RXVT_NAME@@(1), or 2470Enable extended ISO 14755 support (see @@RXVT_NAME@@(1)).
2225F<doc/rxvt.1.txt>). Basic support (section 5.1) is enabled by 2471Basic support (section 5.1) is enabled by C<--enable-frills>, while
2226C<--enable-frills>, while support for 5.2, 5.3 and 5.4 is enabled with 2472support for 5.2, 5.3 and 5.4 is enabled with this switch.
2227this switch.
2228 2473
2229=item --enable-keepscrolling (default: on) 2474=item --enable-keepscrolling (default: on)
2230 2475
2231Add support for continual scrolling of the display when you hold 2476Add support for continual scrolling of the display when you hold
2232the mouse button down on a scrollbar arrow. 2477the mouse button down on a scrollbar arrow.
2478
2479=item --enable-selectionscrolling (default: on)
2480
2481Add support for scrolling when the selection moves to the top or
2482bottom of the screen.
2233 2483
2234=item --enable-mousewheel (default: on) 2484=item --enable-mousewheel (default: on)
2235 2485
2236Add support for scrolling via mouse wheel or buttons 4 & 5. 2486Add support for scrolling via mouse wheel or buttons 4 & 5.
2237 2487
2239 2489
2240Add support for continual scrolling (using the mouse wheel as an 2490Add support for continual scrolling (using the mouse wheel as an
2241accelerator) while the control key is held down. This option 2491accelerator) while the control key is held down. This option
2242requires --enable-mousewheel to also be specified. 2492requires --enable-mousewheel to also be specified.
2243 2493
2244=item --disable-new-selection
2245
2246Remove support for mouse selection style like that of xterm.
2247
2248=item --enable-dmalloc (default: off)
2249
2250Use Gray Watson's malloc - which is good for debugging See
2251http://www.letters.com/dmalloc/ for details If you use either this or the
2252next option, you may need to edit src/Makefile after compiling to point
2253DINCLUDE and DLIB to the right places.
2254
2255You can only use either this option and the following (should
2256you use either) .
2257
2258=item --enable-dlmalloc (default: off)
2259
2260Use Doug Lea's malloc - which is good for a production version
2261See L<http://g.oswego.edu/dl/html/malloc.html> for details.
2262
2263=item --enable-smart-resize (default: on) 2494=item --enable-smart-resize (default: off)
2264 2495
2265Add smart growth/shrink behaviour when changing font size via hot 2496Add smart growth/shrink behaviour when resizing.
2266keys. This should keep the window corner which is closest to a corner of 2497This should keep the window corner which is closest to a corner of
2267the screen in a fixed position. 2498the screen in a fixed position.
2268 2499
2500=item --enable-text-blink (default: on)
2501
2502Add support for blinking text.
2503
2269=item --enable-pointer-blank (default: on) 2504=item --enable-pointer-blank (default: on)
2270 2505
2271Add support to have the pointer disappear when typing or inactive. 2506Add support to have the pointer disappear when typing or inactive.
2272 2507
2273=item --enable-perl (default: on) 2508=item --enable-perl (default: on)
2274 2509
2275Enable an embedded perl interpreter. See the B<@@RXVT_NAME@@perl(3)> 2510Enable an embedded perl interpreter. See the B<@@RXVT_NAME@@perl(3)>
2276manpage (F<doc/rxvtperl.txt>) for more info on this feature, or the files 2511manpage for more info on this feature, or the files in F<src/perl/>
2277in F<src/perl-ext/> for the extensions that are installed by default. The 2512for the extensions that are installed by default.
2278perl interpreter that is used can be specified via the C<PERL> environment 2513The perl interpreter that is used can be specified via the C<PERL>
2279variable when running configure. 2514environment variable when running configure. Even when compiled in,
2515perl will I<not> be initialised when all extensions have been disabled
2516C<-pe "" --perl-ext-common "">, so it should be safe to enable from a
2517resource standpoint.
2518
2519=item --with-afterimage-config=DIR
2520
2521Look for the libAfterImage config script in DIR.
2280 2522
2281=item --with-name=NAME (default: urxvt) 2523=item --with-name=NAME (default: urxvt)
2282 2524
2283Set the basename for the installed binaries, resulting 2525Set the basename for the installed binaries, resulting
2284in C<urxvt>, C<urxvtd> etc.). Specify C<--with-name=rxvt> to replace with 2526in C<urxvt>, C<urxvtd> etc.). Specify C<--with-name=rxvt> to replace with
2294PATH. 2536PATH.
2295 2537
2296=item --with-x 2538=item --with-x
2297 2539
2298Use the X Window System (pretty much default, eh?). 2540Use the X Window System (pretty much default, eh?).
2299
2300=item --with-xpm-includes=DIR
2301
2302Look for the XPM includes in DIR.
2303
2304=item --with-xpm-library=DIR
2305
2306Look for the XPM library in DIR.
2307
2308=item --with-xpm
2309
2310Not needed - define via --enable-xpm-background.
2311 2541
2312=back 2542=back
2313 2543
2314=head1 AUTHORS 2544=head1 AUTHORS
2315 2545

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines