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.110 by root, Tue Jan 31 21:10:44 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
251however: Xft fonts often draw glyphs larger than their acclaimed bounding 282however: Xft fonts often draw glyphs larger than their acclaimed bounding
252box, 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
253ask for the character bounding box, which unfortunately is wrong in these 284ask for the character bounding box, which unfortunately is wrong in these
254cases). 285cases).
255 286
256It'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,
257or 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
258the 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
259might be forced to use a different font. 290might be forced to use a different font.
260 291
261All 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
285=head3 Can I switch the fonts at runtime? 316=head3 Can I switch the fonts at runtime?
286 317
287Yes, 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
288effect as using the C<-fn> switch, and takes effect immediately: 319effect as using the C<-fn> switch, and takes effect immediately:
289 320
290 printf '\e]50;%s\007' "9x15bold,xft:Kochi Gothic" 321 printf '\33]50;%s\007' "9x15bold,xft:Kochi Gothic"
291 322
292This 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
293japanese font), but you have to switch to chinese temporarily, where 324japanese font), but you have to switch to chinese temporarily, where
294japanese fonts would only be in your way. 325japanese fonts would only be in your way.
295 326
297 328
298=head3 Why do italic characters look as if clipped? 329=head3 Why do italic characters look as if clipped?
299 330
300Many fonts have difficulties with italic characters and hinting. For 331Many fonts have difficulties with italic characters and hinting. For
301example, the otherwise very nicely hinted font C<xft:Bitstream Vera Sans 332example, the otherwise very nicely hinted font C<xft:Bitstream Vera Sans
302Mono> completely fails in it's italic face. A workaround might be to 333Mono> completely fails in its italic face. A workaround might be to
303enable freetype autohinting, i.e. like this: 334enable freetype autohinting, i.e. like this:
304 335
305 URxvt.italicFont: xft:Bitstream Vera Sans Mono:italic:autohint=true 336 URxvt.italicFont: xft:Bitstream Vera Sans Mono:italic:autohint=true
306 URxvt.boldItalicFont: xft:Bitstream Vera Sans Mono:bold:italic:autohint=true 337 URxvt.boldItalicFont: xft:Bitstream Vera Sans Mono:bold:italic:autohint=true
307 338
313memory and also speeds up rendering considerably. 344memory and also speeds up rendering considerably.
314 345
315=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?
316 347
317Rxvt-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
318fall 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
319fonts, 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
320antialiasing disabled for most of them, because the author thinks they 351antialiasing disabled for most of them, because the author thinks they
321look best that way. 352look best that way.
322 353
323If you want antialiasing, you have to specify the fonts manually. 354If you want antialiasing, you have to specify the fonts manually.
325=head3 What's with this bold/blink stuff? 356=head3 What's with this bold/blink stuff?
326 357
327If 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
328standard foreground colour. 359standard foreground colour.
329 360
330For the standard background colour, blinking will actually make the 361For the standard background colour, blinking will actually make
331text blink when compiled with C<--enable-blinking>. with standard 362the text blink when compiled with C<--enable-text-blink>. Without
332colours. Without C<--enable-blinking>, the blink attribute will be 363C<--enable-text-blink>, the blink attribute will be ignored.
333ignored.
334 364
335On ANSI colours, bold/blink attributes are used to set high-intensity 365On ANSI colours, bold/blink attributes are used to set high-intensity
336foreground/background colors. 366foreground/background colors.
337 367
338color0-7 are the low-intensity colors. 368color0-7 are the low-intensity colors.
443has been designed yet). 473has been designed yet).
444 474
445Until then, you might get away with switching fonts at runtime (see L<Can 475Until then, you might get away with switching fonts at runtime (see L<Can
446I switch the fonts at runtime?> later in this document). 476I switch the fonts at runtime?> later in this document).
447 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
484
448=head2 Keyboard, Mouse & User Interaction 485=head2 Keyboard, Mouse & User Interaction
449 486
450=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?
451 488
452If you want to select e.g. alphanumeric words, you can use the following 489If you want to select e.g. alphanumeric words, you can use the following
459 496
460To 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:
461 498
462 URxvt.selection.pattern-0: ([^"&'()*,;<=>?@[\\\\]^`{|})]+) 499 URxvt.selection.pattern-0: ([^"&'()*,;<=>?@[\\\\]^`{|})]+)
463 500
464Please also note that the I<LeftClick Shift-LeftClik> combination also 501Please also note that the I<LeftClick Shift-LeftClick> combination also
465selects words like the old code. 502selects words like the old code.
466 503
467=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?
468 505
469You can disable the perl extension completely by setting the 506You can disable the perl extension completely by setting the
495circumstances, it will move your cursor around when you click into the 532circumstances, it will move your cursor around when you click into the
496line that contains it. It tries hard not to do this at the wrong moment, 533line that contains it. It tries hard not to do this at the wrong moment,
497but when running a program that doesn't parse cursor movements or in some 534but when running a program that doesn't parse cursor movements or in some
498cases during rlogin sessions, it fails to detect this properly. 535cases during rlogin sessions, it fails to detect this properly.
499 536
500You can permamently switch this feature off by disabling the C<readline> 537You can permanently switch this feature off by disabling the C<readline>
501extension: 538extension:
502 539
503 URxvt.perl-ext-common: default,-readline 540 URxvt.perl-ext-common: default,-readline
504 541
505=head3 My numerical keypad acts weird and generates differing output? 542=head3 My numerical keypad acts weird and generates differing output?
506 543
507Some Debian GNUL/Linux users seem to have this problem, although no 544Some Debian GNUL/Linux users seem to have this problem, although no
508specific 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
509by 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
510this 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
511keymap. 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
512helped. 549helped.
513 550
514=head3 My Compose (Multi_key) key is no longer working. 551=head3 My Compose (Multi_key) key is no longer working.
540depressed. 577depressed.
541 578
542=head3 What's with the strange Backspace/Delete key behaviour? 579=head3 What's with the strange Backspace/Delete key behaviour?
543 580
544Assuming that the physical Backspace key corresponds to the 581Assuming that the physical Backspace key corresponds to the
545BackSpace keysym (not likely for Linux ... see the following 582Backspace keysym (not likely for Linux ... see the following
546question) there are two standard values that can be used for 583question) there are two standard values that can be used for
547Backspace: C<^H> and C<^?>. 584Backspace: C<^H> and C<^?>.
548 585
549Historically, either value is correct, but rxvt-unicode adopts the debian 586Historically, either value is correct, but rxvt-unicode adopts the debian
550policy 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
551choice :). 588choice :).
552 589
553Rxvt-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
554of `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
555started 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
587key 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
588(C<ESC [ 3 ~>) and is in the supplied termcap/terminfo. 625(C<ESC [ 3 ~>) and is in the supplied termcap/terminfo.
589 626
590Some other Backspace problems: 627Some other Backspace problems:
591 628
592some editors use termcap/terminfo, 629some editors use termcap/terminfo,
593some editors (vim I'm told) expect Backspace = ^H, 630some editors (vim I'm told) expect Backspace = ^H,
594GNU Emacs (and Emacs-like editors) use ^H for help. 631GNU Emacs (and Emacs-like editors) use ^H for help.
595 632
596Perhaps someday this will all be resolved in a consistent manner. 633Perhaps someday this will all be resolved in a consistent manner.
597 634
638Rather than have rxvt-unicode try to accommodate all the various possible 675Rather than have rxvt-unicode try to accommodate all the various possible
639keyboard 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
640required for your particular machine. 677required for your particular machine.
641 678
642 679
643
644=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 :->
645 835
646=head3 Why doesn't rxvt-unicode read my resources? 836=head3 Why doesn't rxvt-unicode read my resources?
647 837
648Well, 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
649applications. Most importantly, this means that if you or your OS loads 839applications. Most importantly, this means that if you or your OS loads
658Also consider the form resources have to use: 848Also consider the form resources have to use:
659 849
660 URxvt.resource: value 850 URxvt.resource: value
661 851
662If 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
663specifying resources), make sure you understand wether and why it 853specifying resources), make sure you understand whether and why it
664works. If unsure, use the form above. 854works. If unsure, use the form above.
665 855
666=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?
667 857
668The terminal description used by rxvt-unicode is not as widely available 858The terminal description used by rxvt-unicode is not as widely available
669as that for xterm, or even rxvt (for which the same problem often arises). 859as that for xterm, or even rxvt (for which the same problem often arises).
670 860
671The 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
672be 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):
673 866
674 REMOTE=remotesystem.domain 867 REMOTE=remotesystem.domain
675 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"
676 869
677... 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.
678 872
679If 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
680C<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
681problems arising, which includes wrong keymapping, less and different 875problems arising, which includes wrong keymapping, less and different
682colours and some refresh errors in fullscreen applications. It's a nice 876colours and some refresh errors in fullscreen applications. It's a nice
689 URxvt.termName: rxvt 883 URxvt.termName: rxvt
690 884
691If 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
692the 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>.
693 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
694=head3 C<tic> outputs some error when compiling the terminfo entry. 894=head3 C<tic> outputs some error when compiling the terminfo entry.
695 895
696Most 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
697C<enacs=\E[0@> and try again. 897C<enacs=\E[0@> and try again.
698 898
705One reason you might want this is that some distributions or operating 905One reason you might want this is that some distributions or operating
706systems still compile some programs using the long-obsoleted termcap 906systems still compile some programs using the long-obsoleted termcap
707library (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
708for C<rxvt-unicode>. 908for C<rxvt-unicode>.
709 909
710You 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.
711You 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
712like this: 912like this:
713 913
714 infocmp -C rxvt-unicode 914 infocmp -C rxvt-unicode
715 915
716Or you could use this termcap entry, generated by the command above: 916Or you could use the termcap entry in doc/etc/rxvt-unicode.termcap,
717 917generated by the command above.
718 rxvt-unicode|rxvt-unicode terminal (X Window System):\
719 :am:bw:eo:km:mi:ms:xn:xo:\
720 :co#80:it#8:li#24:lm#0:\
721 :AL=\E[%dL:DC=\E[%dP:DL=\E[%dM:DO=\E[%dB:IC=\E[%d@:\
722 :K1=\EOw:K2=\EOu:K3=\EOy:K4=\EOq:K5=\EOs:LE=\E[%dD:\
723 :RI=\E[%dC:SF=\E[%dS:SR=\E[%dT:UP=\E[%dA:ae=\E(B:al=\E[L:\
724 :as=\E(0:bl=^G:cd=\E[J:ce=\E[K:cl=\E[H\E[2J:\
725 :cm=\E[%i%d;%dH:cr=^M:cs=\E[%i%d;%dr:ct=\E[3g:dc=\E[P:\
726 :dl=\E[M:do=^J:ec=\E[%dX:ei=\E[4l:ho=\E[H:\
727 :i1=\E[?47l\E=\E[?1l:ic=\E[@:im=\E[4h:\
728 :is=\E[r\E[m\E[2J\E[H\E[?7h\E[?1;3;4;6l\E[4l:\
729 :k1=\E[11~:k2=\E[12~:k3=\E[13~:k4=\E[14~:k5=\E[15~:\
730 :k6=\E[17~:k7=\E[18~:k8=\E[19~:k9=\E[20~:kD=\E[3~:\
731 :kI=\E[2~:kN=\E[6~:kP=\E[5~:kb=\177:kd=\EOB:ke=\E[?1l\E>:\
732 :kh=\E[7~:kl=\EOD:kr=\EOC:ks=\E[?1h\E=:ku=\EOA:le=^H:\
733 :mb=\E[5m:md=\E[1m:me=\E[m\017:mr=\E[7m:nd=\E[C:rc=\E8:\
734 :sc=\E7:se=\E[27m:sf=^J:so=\E[7m:sr=\EM:st=\EH:ta=^I:\
735 :te=\E[r\E[?1049l:ti=\E[?1049h:ue=\E[24m:up=\E[A:\
736 :us=\E[4m:vb=\E[?5h\E[?5l:ve=\E[?25h:vi=\E[?25l:\
737 :vs=\E[?25h:
738 918
739=head3 Why does C<ls> no longer have coloured output? 919=head3 Why does C<ls> no longer have coloured output?
740 920
741The 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
742decide wether a terminal has colour, but uses it's own configuration 922decide whether a terminal has colour, but uses its own configuration
743file. Needless to say, C<rxvt-unicode> is not in it's default file (among 923file. Needless to say, C<rxvt-unicode> is not in its default file (among
744with most other terminals supporting colour). Either add: 924with most other terminals supporting colour). Either add:
745 925
746 TERM rxvt-unicode 926 TERM rxvt-unicode
747 927
748to C</etc/DIR_COLORS> or simply add: 928to C</etc/DIR_COLORS> or simply add:
782If you encounter strange problems like typing an accented character but 962If you encounter strange problems like typing an accented character but
783getting two unrelated other characters or similar, or if program output is 963getting two unrelated other characters or similar, or if program output is
784subtly garbled, then you should check your locale settings. 964subtly garbled, then you should check your locale settings.
785 965
786Rxvt-unicode must be started with the same C<LC_CTYPE> setting as the 966Rxvt-unicode must be started with the same C<LC_CTYPE> setting as the
787programs. Often rxvt-unicode is started in the C<C> locale, while the 967programs running in it. Often rxvt-unicode is started in the C<C> locale,
788login script running within the rxvt-unicode window changes the locale to 968while the login script running within the rxvt-unicode window changes the
789something else, e.g. C<en_GB.UTF-8>. Needless to say, this is not going to work. 969locale to something else, e.g. C<en_GB.UTF-8>. Needless to say, this is
970not going to work, and is the most common cause for problems.
790 971
791The best thing is to fix your startup environment, as you will likely run 972The best thing is to fix your startup environment, as you will likely run
792into other problems. If nothing works you can try this in your .profile. 973into other problems. If nothing works you can try this in your .profile.
793 974
794 printf '\e]701;%s\007' "$LC_CTYPE" 975 printf '\33]701;%s\007' "$LC_CTYPE" # $LANG or $LC_ALL are worth a try, too
795 976
796If this doesn't work, then maybe you use a C<LC_CTYPE> specification not 977If this doesn't work, then maybe you use a C<LC_CTYPE> specification not
797supported on your systems. Some systems have a C<locale> command which 978supported on your systems. Some systems have a C<locale> command which
798displays this (also, C<perl -e0> can be used to check locale settings, as 979displays this (also, C<perl -e0> can be used to check locale settings, as
799it will complain loudly if it cannot set the locale). If it displays something 980it will complain loudly if it cannot set the locale). If it displays something
820The reasons is that there exists a perfectly fine mechanism for selecting 1001The reasons is that there exists a perfectly fine mechanism for selecting
821the encoding, doing I/O and (most important) communicating this to all 1002the encoding, doing I/O and (most important) communicating this to all
822applications so everybody agrees on character properties such as width 1003applications so everybody agrees on character properties such as width
823and code number. This mechanism is the I<locale>. Applications not using 1004and code number. This mechanism is the I<locale>. Applications not using
824that info will have problems (for example, C<xterm> gets the width of 1005that info will have problems (for example, C<xterm> gets the width of
825characters wrong as it uses it's own, locale-independent table under all 1006characters wrong as it uses its own, locale-independent table under all
826locales). 1007locales).
827 1008
828Rxvt-unicode uses the C<LC_CTYPE> locale category to select encoding. All 1009Rxvt-unicode uses the C<LC_CTYPE> locale category to select encoding. All
829programs doing the same (that is, most) will automatically agree in the 1010programs doing the same (that is, most) will automatically agree in the
830interpretation of characters. 1011interpretation of characters.
849=head3 Can I switch locales at runtime? 1030=head3 Can I switch locales at runtime?
850 1031
851Yes, using an escape sequence. Try something like this, which sets 1032Yes, using an escape sequence. Try something like this, which sets
852rxvt-unicode's idea of C<LC_CTYPE>. 1033rxvt-unicode's idea of C<LC_CTYPE>.
853 1034
854 printf '\e]701;%s\007' ja_JP.SJIS 1035 printf '\33]701;%s\007' ja_JP.SJIS
855 1036
856See also the previous answer. 1037See also the previous answer.
857 1038
858Sometimes this capability is rather handy when you want to work in 1039Sometimes this capability is rather handy when you want to work in
859one locale (e.g. C<de_DE.UTF-8>) but some programs don't support it 1040one locale (e.g. C<de_DE.UTF-8>) but some programs don't support it
860(e.g. UTF-8). For example, I use this script to start C<xjdic>, which 1041(e.g. UTF-8). For example, I use this script to start C<xjdic>, which
861first switches to a locale supported by xjdic and back later: 1042first switches to a locale supported by xjdic and back later:
862 1043
863 printf '\e]701;%s\007' ja_JP.SJIS 1044 printf '\33]701;%s\007' ja_JP.SJIS
864 xjdic -js 1045 xjdic -js
865 printf '\e]701;%s\007' de_DE.UTF-8 1046 printf '\33]701;%s\007' de_DE.UTF-8
866 1047
867You can also use xterm's C<luit> program, which usually works fine, except 1048You can also use xterm's C<luit> program, which usually works fine, except
868for some locales where character width differs between program- and 1049for some locales where character width differs between program- and
869rxvt-unicode-locales. 1050rxvt-unicode-locales.
870 1051
1052=head3 I have problems getting my input method working.
1053
1054Try a search engine, as this is slightly different for every input method server.
1055
1056Here is a checklist:
1057
1058=over 4
1059
1060=item - Make sure your locale I<and> the imLocale are supported on your OS.
1061
1062Try C<locale -a> or check the documentation for your OS.
1063
1064=item - Make sure your locale or imLocale matches a locale supported by your XIM.
1065
1066For example, B<kinput2> does not support UTF-8 locales, you should use
1067C<ja_JP.EUC-JP> or equivalent.
1068
1069=item - Make sure your XIM server is actually running.
1070
1071=item - Make sure the C<XMODIFIERS> environment variable is set correctly when I<starting> rxvt-unicode.
1072
1073When you want to use e.g. B<kinput2>, it must be set to
1074C<@im=kinput2>. For B<scim>, use C<@im=SCIM>. You can see what input
1075method servers are running with this command:
1076
1077 xprop -root XIM_SERVERS
1078
1079=item
1080
1081=back
1082
871=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?
872 1084
873You 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
874terminal, using the resource C<imlocale>: 1086terminal, using the resource C<imlocale>:
875 1087
876 URxvt.imlocale: ja_JP.EUC-JP 1088 URxvt.imlocale: ja_JP.EUC-JP
877 1089
878Now 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
879use 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
880input 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
881method limits you. 1093normal way then, as your input method limits you.
882 1094
883=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.
884 1096
885Unfortunately, this is unavoidable, as the XIM protocol is racy by 1097Unfortunately, this is unavoidable, as the XIM protocol is racy by
886design. Applications can avoid some crashes at the expense of memory 1098design. Applications can avoid some crashes at the expense of memory
912 1124
913=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?
914 1126
915You should build one binary with the default options. F<configure> 1127You should build one binary with the default options. F<configure>
916now enables most useful options, and the trend goes to making them 1128now enables most useful options, and the trend goes to making them
917runtime-switchable, too, so there is usually no drawback to enbaling them, 1129runtime-switchable, too, so there is usually no drawback to enabling them,
918except higher disk and possibly memory usage. The perl interpreter should 1130except higher disk and possibly memory usage. The perl interpreter should
919be enabled, as important functionality (menus, selection, likely more in 1131be enabled, as important functionality (menus, selection, likely more in
920the future) depends on it. 1132the future) depends on it.
921 1133
922You 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
945This 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
946and reduces possible bugs to initialisation code run before main(), or 1158and reduces possible bugs to initialisation code run before main(), or
947things 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
948little risk. 1160little risk.
949 1161
950=head3 On Solaris 9, many line-drawing characters are too wide.
951
952Seems to be a known bug, read
953L<http://nixdoc.net/files/forum/about34198.html>. Some people use the
954following ugly workaround to get non-double-wide-characters working:
955
956 #define wcwidth(x) wcwidth(x) > 1 ? 1 : wcwidth(x)
957
958=head3 I am on FreeBSD and rxvt-unicode does not seem to work at all. 1162=head3 I am on FreeBSD and rxvt-unicode does not seem to work at all.
959 1163
960Rxvt-unicode requires the symbol C<__STDC_ISO_10646__> to be defined 1164Rxvt-unicode requires the symbol C<__STDC_ISO_10646__> to be defined
961in your compile environment, or an implementation that implements it, 1165in your compile environment, or an implementation that implements it,
962wether 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
963B<wchar_t> is represented as unicode. 1167B<wchar_t> is represented as unicode.
964 1168
965As you might have guessed, FreeBSD does neither define this symobl nor 1169As you might have guessed, FreeBSD does neither define this symbol nor
966does it support it. Instead, it uses it's own internal representation of 1170does it support it. Instead, it uses its own internal representation of
967B<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.
968 1172
969However, 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
970C<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>).
971 1175
972C<__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
973apps in an OS, as using a locale-dependent (and non-standardized) 1177apps in an OS, as using a locale-dependent (and non-standardized)
974representation of B<wchar_t> makes it impossible to convert between 1178representation of B<wchar_t> makes it impossible to convert between
975B<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
985 1189
986The 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
987system 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
988complete replacements for them :) 1192complete replacements for them :)
989 1193
990=head3 I use Solaris 9 and it doesn't compile/work/etc.
991
992Try the diff in F<doc/solaris9.patch> as a base. It fixes the worst
993problems with C<wcwidth> and a compile problem.
994
995=head3 How can I use rxvt-unicode under cygwin? 1194=head3 How can I use rxvt-unicode under cygwin?
996 1195
997rxvt-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
998the X11 libraries that come with cygwin. libW11 emulation is no 1197the X11 libraries that come with cygwin. libW11 emulation is no
999longer supported (and makes no sense, either, as it only supported a 1198longer supported (and makes no sense, either, as it only supported a
1002old libW11 emulation. 1201old libW11 emulation.
1003 1202
1004At 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
1005encodings (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
1006to 8-bit encodings. 1205to 8-bit encodings.
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.
1007 1225
1008=head1 RXVT-UNICODE TECHNICAL REFERENCE 1226=head1 RXVT-UNICODE TECHNICAL REFERENCE
1009 1227
1010The rest of this document describes various technical aspects of 1228The rest of this document describes various technical aspects of
1011B<rxvt-unicode>. First the description of supported command sequences, 1229B<rxvt-unicode>. First the description of supported command sequences,
1264=begin table 1482=begin table
1265 1483
1266 B<< C<Ps = 0> >> Clear to Right (default) 1484 B<< C<Ps = 0> >> Clear to Right (default)
1267 B<< C<Ps = 1> >> Clear to Left 1485 B<< C<Ps = 1> >> Clear to Left
1268 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)
1269 1489
1270=end table 1490=end table
1271 1491
1272=item B<< C<ESC [ Ps L> >> 1492=item B<< C<ESC [ Ps L> >>
1273 1493
1505 1725
1506Toggle DEC Private Mode Values (rxvt extension). I<where> 1726Toggle DEC Private Mode Values (rxvt extension). I<where>
1507 1727
1508=over 4 1728=over 4
1509 1729
1510=item B<< C<Ps = 1> >> (DECCKM) 1730=item B<< C<Pm = 1> >> (DECCKM)
1511 1731
1512=begin table 1732=begin table
1513 1733
1514 B<< C<h> >> Application Cursor Keys 1734 B<< C<h> >> Application Cursor Keys
1515 B<< C<l> >> Normal Cursor Keys 1735 B<< C<l> >> Normal Cursor Keys
1516 1736
1517=end table 1737=end table
1518 1738
1519=item B<< C<Ps = 2> >> (ANSI/VT52 mode) 1739=item B<< C<Pm = 2> >> (ANSI/VT52 mode)
1520 1740
1521=begin table 1741=begin table
1522 1742
1523 B<< C<h> >> Enter VT52 mode 1743 B<< C<h> >> Enter VT52 mode
1524 B<< C<l> >> Enter VT52 mode 1744 B<< C<l> >> Enter VT52 mode
1525 1745
1526=end table 1746=end table
1527 1747
1528=item B<< C<Ps = 3> >> 1748=item B<< C<Pm = 3> >>
1529 1749
1530=begin table 1750=begin table
1531 1751
1532 B<< C<h> >> 132 Column Mode (DECCOLM) 1752 B<< C<h> >> 132 Column Mode (DECCOLM)
1533 B<< C<l> >> 80 Column Mode (DECCOLM) 1753 B<< C<l> >> 80 Column Mode (DECCOLM)
1534 1754
1535=end table 1755=end table
1536 1756
1537=item B<< C<Ps = 4> >> 1757=item B<< C<Pm = 4> >>
1538 1758
1539=begin table 1759=begin table
1540 1760
1541 B<< C<h> >> Smooth (Slow) Scroll (DECSCLM) 1761 B<< C<h> >> Smooth (Slow) Scroll (DECSCLM)
1542 B<< C<l> >> Jump (Fast) Scroll (DECSCLM) 1762 B<< C<l> >> Jump (Fast) Scroll (DECSCLM)
1543 1763
1544=end table 1764=end table
1545 1765
1546=item B<< C<Ps = 5> >> 1766=item B<< C<Pm = 5> >>
1547 1767
1548=begin table 1768=begin table
1549 1769
1550 B<< C<h> >> Reverse Video (DECSCNM) 1770 B<< C<h> >> Reverse Video (DECSCNM)
1551 B<< C<l> >> Normal Video (DECSCNM) 1771 B<< C<l> >> Normal Video (DECSCNM)
1552 1772
1553=end table 1773=end table
1554 1774
1555=item B<< C<Ps = 6> >> 1775=item B<< C<Pm = 6> >>
1556 1776
1557=begin table 1777=begin table
1558 1778
1559 B<< C<h> >> Origin Mode (DECOM) 1779 B<< C<h> >> Origin Mode (DECOM)
1560 B<< C<l> >> Normal Cursor Mode (DECOM) 1780 B<< C<l> >> Normal Cursor Mode (DECOM)
1561 1781
1562=end table 1782=end table
1563 1783
1564=item B<< C<Ps = 7> >> 1784=item B<< C<Pm = 7> >>
1565 1785
1566=begin table 1786=begin table
1567 1787
1568 B<< C<h> >> Wraparound Mode (DECAWM) 1788 B<< C<h> >> Wraparound Mode (DECAWM)
1569 B<< C<l> >> No Wraparound Mode (DECAWM) 1789 B<< C<l> >> No Wraparound Mode (DECAWM)
1570 1790
1571=end table 1791=end table
1572 1792
1573=item B<< C<Ps = 8> >> I<unimplemented> 1793=item B<< C<Pm = 8> >> I<unimplemented>
1574 1794
1575=begin table 1795=begin table
1576 1796
1577 B<< C<h> >> Auto-repeat Keys (DECARM) 1797 B<< C<h> >> Auto-repeat Keys (DECARM)
1578 B<< C<l> >> No Auto-repeat Keys (DECARM) 1798 B<< C<l> >> No Auto-repeat Keys (DECARM)
1579 1799
1580=end table 1800=end table
1581 1801
1582=item B<< C<Ps = 9> >> X10 XTerm 1802=item B<< C<Pm = 9> >> X10 XTerm
1583 1803
1584=begin table 1804=begin table
1585 1805
1586 B<< C<h> >> Send Mouse X & Y on button press. 1806 B<< C<h> >> Send Mouse X & Y on button press.
1587 B<< C<l> >> No mouse reporting. 1807 B<< C<l> >> No mouse reporting.
1588 1808
1589=end table 1809=end table
1590 1810
1591=item B<< C<Ps = 25> >> 1811=item B<< C<Pm = 25> >>
1592 1812
1593=begin table 1813=begin table
1594 1814
1595 B<< C<h> >> Visible cursor {cnorm/cvvis} 1815 B<< C<h> >> Visible cursor {cnorm/cvvis}
1596 B<< C<l> >> Invisible cursor {civis} 1816 B<< C<l> >> Invisible cursor {civis}
1597 1817
1598=end table 1818=end table
1599 1819
1600=item B<< C<Ps = 30> >> 1820=item B<< C<Pm = 30> >>
1601 1821
1602=begin table 1822=begin table
1603 1823
1604 B<< C<h> >> scrollBar visisble 1824 B<< C<h> >> scrollBar visible
1605 B<< C<l> >> scrollBar invisisble 1825 B<< C<l> >> scrollBar invisible
1606 1826
1607=end table 1827=end table
1608 1828
1609=item B<< C<Ps = 35> >> (B<rxvt>) 1829=item B<< C<Pm = 35> >> (B<rxvt>)
1610 1830
1611=begin table 1831=begin table
1612 1832
1613 B<< C<h> >> Allow XTerm Shift+key sequences 1833 B<< C<h> >> Allow XTerm Shift+key sequences
1614 B<< C<l> >> Disallow XTerm Shift+key sequences 1834 B<< C<l> >> Disallow XTerm Shift+key sequences
1615 1835
1616=end table 1836=end table
1617 1837
1618=item B<< C<Ps = 38> >> I<unimplemented> 1838=item B<< C<Pm = 38> >> I<unimplemented>
1619 1839
1620Enter Tektronix Mode (DECTEK) 1840Enter Tektronix Mode (DECTEK)
1621 1841
1622=item B<< C<Ps = 40> >> 1842=item B<< C<Pm = 40> >>
1623 1843
1624=begin table 1844=begin table
1625 1845
1626 B<< C<h> >> Allow 80/132 Mode 1846 B<< C<h> >> Allow 80/132 Mode
1627 B<< C<l> >> Disallow 80/132 Mode 1847 B<< C<l> >> Disallow 80/132 Mode
1628 1848
1629=end table 1849=end table
1630 1850
1631=item B<< C<Ps = 44> >> I<unimplemented> 1851=item B<< C<Pm = 44> >> I<unimplemented>
1632 1852
1633=begin table 1853=begin table
1634 1854
1635 B<< C<h> >> Turn On Margin Bell 1855 B<< C<h> >> Turn On Margin Bell
1636 B<< C<l> >> Turn Off Margin Bell 1856 B<< C<l> >> Turn Off Margin Bell
1637 1857
1638=end table 1858=end table
1639 1859
1640=item B<< C<Ps = 45> >> I<unimplemented> 1860=item B<< C<Pm = 45> >> I<unimplemented>
1641 1861
1642=begin table 1862=begin table
1643 1863
1644 B<< C<h> >> Reverse-wraparound Mode 1864 B<< C<h> >> Reverse-wraparound Mode
1645 B<< C<l> >> No Reverse-wraparound Mode 1865 B<< C<l> >> No Reverse-wraparound Mode
1646 1866
1647=end table 1867=end table
1648 1868
1649=item B<< C<Ps = 46> >> I<unimplemented> 1869=item B<< C<Pm = 46> >> I<unimplemented>
1650 1870
1651=item B<< C<Ps = 47> >> 1871=item B<< C<Pm = 47> >>
1652 1872
1653=begin table 1873=begin table
1654 1874
1655 B<< C<h> >> Use Alternate Screen Buffer 1875 B<< C<h> >> Use Alternate Screen Buffer
1656 B<< C<l> >> Use Normal Screen Buffer 1876 B<< C<l> >> Use Normal Screen Buffer
1657 1877
1658=end table 1878=end table
1659 1879
1660X<Priv66> 1880X<Priv66>
1661 1881
1662=item B<< C<Ps = 66> >> 1882=item B<< C<Pm = 66> >>
1663 1883
1664=begin table 1884=begin table
1665 1885
1666 B<< C<h> >> Application Keypad (DECPAM) == C<ESC => 1886 B<< C<h> >> Application Keypad (DECPAM) == C<ESC =>
1667 B<< C<l> >> Normal Keypad (DECPNM) == C<< ESC > >> 1887 B<< C<l> >> Normal Keypad (DECPNM) == C<< ESC > >>
1668 1888
1669=end table 1889=end table
1670 1890
1671=item B<< C<Ps = 67> >> 1891=item B<< C<Pm = 67> >>
1672 1892
1673=begin table 1893=begin table
1674 1894
1675 B<< C<h> >> Backspace key sends B<< C<BS> (DECBKM) >> 1895 B<< C<h> >> Backspace key sends B<< C<BS> (DECBKM) >>
1676 B<< C<l> >> Backspace key sends B<< C<DEL> >> 1896 B<< C<l> >> Backspace key sends B<< C<DEL> >>
1677 1897
1678=end table 1898=end table
1679 1899
1680=item B<< C<Ps = 1000> >> (X11 XTerm) 1900=item B<< C<Pm = 1000> >> (X11 XTerm)
1681 1901
1682=begin table 1902=begin table
1683 1903
1684 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.
1685 B<< C<l> >> No mouse reporting. 1905 B<< C<l> >> No mouse reporting.
1686 1906
1687=end table 1907=end table
1688 1908
1689=item B<< C<Ps = 1001> >> (X11 XTerm) I<unimplemented> 1909=item B<< C<Pm = 1001> >> (X11 XTerm) I<unimplemented>
1690 1910
1691=begin table 1911=begin table
1692 1912
1693 B<< C<h> >> Use Hilite Mouse Tracking. 1913 B<< C<h> >> Use Hilite Mouse Tracking.
1694 B<< C<l> >> No mouse reporting. 1914 B<< C<l> >> No mouse reporting.
1695 1915
1696=end table 1916=end table
1697 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
1698=item B<< C<Ps = 1010> >> (B<rxvt>) 1936=item B<< C<Pm = 1010> >> (B<rxvt>)
1699 1937
1700=begin table 1938=begin table
1701 1939
1702 B<< C<h> >> Don't scroll to bottom on TTY output 1940 B<< C<h> >> Don't scroll to bottom on TTY output
1703 B<< C<l> >> Scroll to bottom on TTY output 1941 B<< C<l> >> Scroll to bottom on TTY output
1704 1942
1705=end table 1943=end table
1706 1944
1707=item B<< C<Ps = 1011> >> (B<rxvt>) 1945=item B<< C<Pm = 1011> >> (B<rxvt>)
1708 1946
1709=begin table 1947=begin table
1710 1948
1711 B<< C<h> >> Scroll to bottom when a key is pressed 1949 B<< C<h> >> Scroll to bottom when a key is pressed
1712 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
1713 1951
1714=end table 1952=end table
1715 1953
1716=item B<< C<Ps = 1021> >> (B<rxvt>) 1954=item B<< C<Pm = 1021> >> (B<rxvt>)
1717 1955
1718=begin table 1956=begin table
1719 1957
1720 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>)
1721 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)
1722 1960
1723=end table 1961=end table
1724 1962
1725=item B<< C<Ps = 1047> >> 1963=item B<< C<Pm = 1047> >>
1726 1964
1727=begin table 1965=begin table
1728 1966
1729 B<< C<h> >> Use Alternate Screen Buffer 1967 B<< C<h> >> Use Alternate Screen Buffer
1730 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
1731 1969
1732=end table 1970=end table
1733 1971
1734=item B<< C<Ps = 1048> >> 1972=item B<< C<Pm = 1048> >>
1735 1973
1736=begin table 1974=begin table
1737 1975
1738 B<< C<h> >> Save cursor position 1976 B<< C<h> >> Save cursor position
1739 B<< C<l> >> Restore cursor position 1977 B<< C<l> >> Restore cursor position
1740 1978
1741=end table 1979=end table
1742 1980
1743=item B<< C<Ps = 1049> >> 1981=item B<< C<Pm = 1049> >>
1744 1982
1745=begin table 1983=begin table
1746 1984
1747 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
1748 B<< C<l> >> Use Normal Screen Buffer 1986 B<< C<l> >> Use Normal Screen Buffer
1987
1988=end table
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
1749 1996
1750=end table 1997=end table
1751 1998
1752=back 1999=back
1753 2000
1770 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> >>
1771 B<< C<Ps = 1> >> Change Icon Name to B<< C<Pt> >> 2018 B<< C<Ps = 1> >> Change Icon Name to B<< C<Pt> >>
1772 B<< C<Ps = 2> >> Change Window Title to B<< C<Pt> >> 2019 B<< C<Ps = 2> >> Change Window Title to B<< C<Pt> >>
1773 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.
1774 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
1775 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> >>
1776 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> >>
1777 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> >>
1778 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> >>
1779 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> >>
1780 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]
1781 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]
1782 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).
1783 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]
1784 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>
1785 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]
1786 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> >>
1787 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]
1788 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).
1789 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>.
1790 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> >>
1791 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).
1792 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> >>
1793 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> >>
1794 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>.
1795 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).
1796 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).
1797 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).
1798 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).
1801 2049
1802=end table 2050=end table
1803 2051
1804=back 2052=back
1805 2053
1806=head1 XPM 2054=head1 BACKGROUND IMAGE
1807 2055
1808For 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
1809of 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
1810sequence of scaling/positioning commands separated by semi-colons. The 2058sequence of scaling/positioning commands separated by semi-colons. The
1811scaling/positioning commands are as follows: 2059scaling/positioning commands are as follows:
1812 2060
1813=over 4 2061=over 4
1814 2062
1852 2100
1853For example: 2101For example:
1854 2102
1855=over 4 2103=over 4
1856 2104
1857=item B<\E]20;funky\a> 2105=item B<\E]20;funky.jpg\a>
1858 2106
1859load B<funky.xpm> as a tiled image 2107load B<funky.jpg> as a tiled image
1860 2108
1861=item B<\E]20;mona;100\a> 2109=item B<\E]20;mona.jpg;100\a>
1862 2110
1863load B<mona.xpm> with a scaling of 100% 2111load B<mona.jpg> with a scaling of 100%
1864 2112
1865=item B<\E]20;;200;?\a> 2113=item B<\E]20;;200;?\a>
1866 2114
1867rescale the current pixmap to 200% and display the image geometry in 2115rescale the current pixmap to 200% and display the image geometry in
1868the title 2116the title
1869 2117
1870=back 2118=back
2119
1871X<Mouse> 2120X<Mouse>
1872 2121
1873=head1 Mouse Reporting 2122=head1 Mouse Reporting
1874 2123
1875=over 4 2124=over 4
1916Col = B<< C<< <x> - SPACE >> >> 2165Col = B<< C<< <x> - SPACE >> >>
1917 2166
1918Row = B<< C<< <y> - SPACE >> >> 2167Row = B<< C<< <y> - SPACE >> >>
1919 2168
1920=back 2169=back
2170
2171=head1 Key Codes
2172
1921X<KeyCodes> 2173X<KeyCodes>
1922
1923=head1 Key Codes
1924 2174
1925Note: B<Shift> + B<F1>-B<F10> generates B<F11>-B<F20> 2175Note: B<Shift> + B<F1>-B<F10> generates B<F11>-B<F20>
1926 2176
1927For the keypad, use B<Shift> to temporarily override Application-Keypad 2177For the keypad, use B<Shift> to temporarily override Application-Keypad
1928setting use B<Num_Lock> to toggle Application-Keypad setting if 2178setting use B<Num_Lock> to toggle Application-Keypad setting if
1995 2245
1996=head1 CONFIGURE OPTIONS 2246=head1 CONFIGURE OPTIONS
1997 2247
1998General hint: if you get compile errors, then likely your configuration 2248General hint: if you get compile errors, then likely your configuration
1999hasn'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
2000the 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>
2001myself, so it should generally be a working config. Of course, you should 2251switches). Of course, you should always report when a combination doesn't
2002always report when a combination doesn't work, so it can be fixed. Marc 2252work, so it can be fixed. Marc Lehmann <rxvt@schmorp.de>.
2003Lehmann <rxvt@schmorp.de>.
2004 2253
2005All 2254All
2006 2255
2007=over 4 2256=over 4
2008 2257
2040 2289
2041=begin table 2290=begin table
2042 2291
2043 all all available codeset groups 2292 all all available codeset groups
2044 zh common chinese encodings 2293 zh common chinese encodings
2045 zh_ext rarely used but very big chinese encodigs 2294 zh_ext rarely used but very big chinese encodings
2046 jp common japanese encodings 2295 jp common japanese encodings
2047 jp_ext rarely used but big japanese encodings 2296 jp_ext rarely used but big japanese encodings
2048 kr korean encodings 2297 kr korean encodings
2049 2298
2050=end table 2299=end table
2064requirements 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
2065support these extra characters, but Xft does. 2314support these extra characters, but Xft does.
2066 2315
2067Please note that rxvt-unicode can store unicode code points >65535 2316Please note that rxvt-unicode can store unicode code points >65535
2068even without this flag, but the number of such characters is 2317even without this flag, but the number of such characters is
2069limited to a view thousand (shared with combining characters, 2318limited to a few thousand (shared with combining characters,
2070see next switch), and right now rxvt-unicode cannot display them 2319see next switch), and right now rxvt-unicode cannot display them
2071(input/output and cut&paste still work, though). 2320(input/output and cut&paste still work, though).
2072 2321
2073=item --enable-combining (default: on) 2322=item --enable-combining (default: on)
2074 2323
2097=item --with-res-name=NAME (default: urxvt) 2346=item --with-res-name=NAME (default: urxvt)
2098 2347
2099Use the given name as default application name when 2348Use the given name as default application name when
2100reading resources. Specify --with-res-name=rxvt to replace rxvt. 2349reading resources. Specify --with-res-name=rxvt to replace rxvt.
2101 2350
2102=item --with-res-class=CLASS /default: URxvt) 2351=item --with-res-class=CLASS (default: URxvt)
2103 2352
2104Use the given class as default application class 2353Use the given class as default application class
2105when reading resources. Specify --with-res-class=Rxvt to replace 2354when reading resources. Specify --with-res-class=Rxvt to replace
2106rxvt. 2355rxvt.
2107 2356
2120 2369
2121Write user and tty to lastlog file (used by programs like 2370Write user and tty to lastlog file (used by programs like
2122F<lastlogin>) at start of rxvt execution. This option requires 2371F<lastlogin>) at start of rxvt execution. This option requires
2123--enable-utmp to also be specified. 2372--enable-utmp to also be specified.
2124 2373
2125=item --enable-xpm-background (default: on) 2374=item --enable-afterimage (default: on)
2126 2375
2127Add 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.
2128 2388
2129=item --enable-transparency (default: on) 2389=item --enable-transparency (default: on)
2130 2390
2131Add support for inheriting parent backgrounds thus giving a fake 2391Add support for backgrounds, creating illusion of transparency in the term.
2132transparency to the term.
2133 2392
2134=item --enable-fading (default: on) 2393=item --enable-fading (default: on)
2135 2394
2136Add support for fading the text when focus is lost (requires C<--enable-transparency>). 2395Add support for fading the text when focus is lost.
2137
2138=item --enable-tinting (default: on)
2139
2140Add support for tinting of transparent backgrounds (requires C<--enable-transparency>).
2141 2396
2142=item --enable-rxvt-scroll (default: on) 2397=item --enable-rxvt-scroll (default: on)
2143 2398
2144Add support for the original rxvt scrollbar. 2399Add support for the original rxvt scrollbar.
2145 2400
2148Add support for a NeXT-like scrollbar. 2403Add support for a NeXT-like scrollbar.
2149 2404
2150=item --enable-xterm-scroll (default: on) 2405=item --enable-xterm-scroll (default: on)
2151 2406
2152Add support for an Xterm-like scrollbar. 2407Add support for an Xterm-like scrollbar.
2153
2154=item --enable-plain-scroll (default: on)
2155
2156Add support for a very unobtrusive, plain-looking scrollbar that
2157is the favourite of the rxvt-unicode author, having used it for
2158many years.
2159
2160=item --enable-ttygid (default: off)
2161
2162Change tty device setting to group "tty" - only use this if
2163your system uses this type of security.
2164 2408
2165=item --disable-backspace-key 2409=item --disable-backspace-key
2166 2410
2167Removes 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.
2168 2412
2188A non-exhaustive list of features enabled by C<--enable-frills> (possibly 2432A non-exhaustive list of features enabled by C<--enable-frills> (possibly
2189in combination with other switches) is: 2433in combination with other switches) is:
2190 2434
2191 MWM-hints 2435 MWM-hints
2192 EWMH-hints (pid, utf8 names) and protocols (ping) 2436 EWMH-hints (pid, utf8 names) and protocols (ping)
2437 urgency hint
2193 seperate underline colour (-underlineColor) 2438 seperate underline colour (-underlineColor)
2194 settable border widths and borderless switch (-w, -b, -bl) 2439 settable border widths and borderless switch (-w, -b, -bl)
2195 visual depth selection (-depth) 2440 visual depth selection (-depth)
2196 settable extra linespacing /-lsp) 2441 settable extra linespacing /-lsp)
2197 iso-14755-2 and -3, and visual feedback 2442 iso-14755 5.1 (basic) support
2198 tripleclickwords (-tcw) 2443 tripleclickwords (-tcw)
2199 settable insecure mode (-insecure) 2444 settable insecure mode (-insecure)
2200 keysym remapping support 2445 keysym remapping support
2201 cursor blinking and underline cursor (-cb, -uc) 2446 cursor blinking and underline cursor (-bc, -uc)
2202 XEmbed support (-embed) 2447 XEmbed support (-embed)
2203 user-pty (-pty-fd) 2448 user-pty (-pty-fd)
2204 hold on exit (-hold) 2449 hold on exit (-hold)
2450 compile in built-in block graphics
2205 skip builtin block graphics (-sbg) 2451 skip builtin block graphics (-sbg)
2452 separate highlightcolor support (-hc)
2206 2453
2207It also enabled some non-essential features otherwise disabled, such as: 2454It also enables some non-essential features otherwise disabled, such as:
2208 2455
2209 some round-trip time optimisations 2456 some round-trip time optimisations
2210 nearest color allocation on pseudocolor screens 2457 nearest color allocation on pseudocolor screens
2211 UTF8_STRING supporr for selection 2458 UTF8_STRING support for selection
2212 sgr modes 90..97 and 100..107 2459 sgr modes 90..97 and 100..107
2213 backindex and forwardindex escape sequences 2460 backindex and forwardindex escape sequences
2214 view change/zero scorllback esacpe sequences 2461 view change/zero scrollback escape sequences
2215 locale switching escape sequence 2462 locale switching escape sequence
2216 window op and some xterm/OSC escape sequences 2463 window op and some xterm/OSC escape sequences
2217 rectangular selections 2464 rectangular selections
2218 trailing space removal for selections 2465 trailing space removal for selections
2219 verbose X error handling 2466 verbose X error handling
2220 2467
2221=item --enable-iso14755 (default: on) 2468=item --enable-iso14755 (default: on)
2222 2469
2223Enable extended ISO 14755 support (see @@RXVT_NAME@@(1), or 2470Enable extended ISO 14755 support (see @@RXVT_NAME@@(1)).
2224F<doc/rxvt.1.txt>). Basic support (section 5.1) is enabled by 2471Basic support (section 5.1) is enabled by C<--enable-frills>, while
2225C<--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.
2226this switch.
2227 2473
2228=item --enable-keepscrolling (default: on) 2474=item --enable-keepscrolling (default: on)
2229 2475
2230Add support for continual scrolling of the display when you hold 2476Add support for continual scrolling of the display when you hold
2231the 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.
2232 2483
2233=item --enable-mousewheel (default: on) 2484=item --enable-mousewheel (default: on)
2234 2485
2235Add support for scrolling via mouse wheel or buttons 4 & 5. 2486Add support for scrolling via mouse wheel or buttons 4 & 5.
2236 2487
2238 2489
2239Add support for continual scrolling (using the mouse wheel as an 2490Add support for continual scrolling (using the mouse wheel as an
2240accelerator) while the control key is held down. This option 2491accelerator) while the control key is held down. This option
2241requires --enable-mousewheel to also be specified. 2492requires --enable-mousewheel to also be specified.
2242 2493
2243=item --disable-new-selection
2244
2245Remove support for mouse selection style like that of xterm.
2246
2247=item --enable-dmalloc (default: off)
2248
2249Use Gray Watson's malloc - which is good for debugging See
2250http://www.letters.com/dmalloc/ for details If you use either this or the
2251next option, you may need to edit src/Makefile after compiling to point
2252DINCLUDE and DLIB to the right places.
2253
2254You can only use either this option and the following (should
2255you use either) .
2256
2257=item --enable-dlmalloc (default: off)
2258
2259Use Doug Lea's malloc - which is good for a production version
2260See L<http://g.oswego.edu/dl/html/malloc.html> for details.
2261
2262=item --enable-smart-resize (default: on) 2494=item --enable-smart-resize (default: off)
2263 2495
2264Add smart growth/shrink behaviour when changing font size via hot 2496Add smart growth/shrink behaviour when resizing.
2265keys. 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
2266the screen in a fixed position. 2498the screen in a fixed position.
2267 2499
2500=item --enable-text-blink (default: on)
2501
2502Add support for blinking text.
2503
2268=item --enable-pointer-blank (default: on) 2504=item --enable-pointer-blank (default: on)
2269 2505
2270Add support to have the pointer disappear when typing or inactive. 2506Add support to have the pointer disappear when typing or inactive.
2271 2507
2272=item --enable-perl (default: on) 2508=item --enable-perl (default: on)
2273 2509
2274Enable an embedded perl interpreter. See the B<@@RXVT_NAME@@perl(3)> 2510Enable an embedded perl interpreter. See the B<@@RXVT_NAME@@perl(3)>
2275manpage (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/>
2276in F<src/perl-ext/> for the extensions that are installed by default. The 2512for the extensions that are installed by default.
2277perl 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>
2278variable 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.
2279 2522
2280=item --with-name=NAME (default: urxvt) 2523=item --with-name=NAME (default: urxvt)
2281 2524
2282Set the basename for the installed binaries, resulting 2525Set the basename for the installed binaries, resulting
2283in 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
2293PATH. 2536PATH.
2294 2537
2295=item --with-x 2538=item --with-x
2296 2539
2297Use the X Window System (pretty much default, eh?). 2540Use the X Window System (pretty much default, eh?).
2298
2299=item --with-xpm-includes=DIR
2300
2301Look for the XPM includes in DIR.
2302
2303=item --with-xpm-library=DIR
2304
2305Look for the XPM library in DIR.
2306
2307=item --with-xpm
2308
2309Not needed - define via --enable-xpm-background.
2310 2541
2311=back 2542=back
2312 2543
2313=head1 AUTHORS 2544=head1 AUTHORS
2314 2545

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines