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.113 by root, Thu Feb 2 18:04:45 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
78=head3 How can I start @@URXVT_NAME@@d automatically when I run URXVT_NAME@@c? 93=head3 How can I start @@URXVT_NAME@@d automatically when I run @@URXVT_NAME@@c?
79 94
80If you want to start @@URXVT_NAME@@d automatically whenever you run 95If you want to start @@URXVT_NAME@@d automatically whenever you run
81@@URXVT_NAME@@c and the daemon isn't running yet, use this script: 96@@URXVT_NAME@@c and the daemon isn't running yet, use this script:
82 97
83 #!/bin/sh 98 #!/bin/sh
90This tries to create a new terminal, and if fails with exit status 2, 105This tries to create a new terminal, and if fails with exit status 2,
91meaning it couldn't connect to the daemon, it will start the daemon and 106meaning it couldn't connect to the daemon, it will start the daemon and
92re-run the command. Subsequent invocations of the script will re-use the 107re-run the command. Subsequent invocations of the script will re-use the
93existing daemon. 108existing daemon.
94 109
95=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.
96 111
97The original rxvt and rxvt-unicode always export the variable "COLORTERM", 112The original rxvt and rxvt-unicode always export the variable "COLORTERM",
98so 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,
99slrn, Midnight Commander automatically check this variable to decide 114slrn, Midnight Commander automatically check this variable to decide
100whether or not to use color. 115whether or not to use color.
125 fi 140 fi
126 141
127=head3 How do I compile the manual pages on my own? 142=head3 How do I compile the manual pages on my own?
128 143
129You 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>,
130one 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
131the doc subdirectory and enter C<make alldoc>. 146F<Pod::Xhtml>). Then go to the doc subdirectory and enter C<make alldoc>.
132 147
133=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?
134 149
135I 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
136bloat. 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
144 98398 1664 24 15695 1824 rxvt --disable-everything 159 98398 1664 24 15695 1824 rxvt --disable-everything
145 188985 9048 66616 18222 1788 urxvt --disable-everything 160 188985 9048 66616 18222 1788 urxvt --disable-everything
146 161
147When 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
148and 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
149libc), the two diverge, but not unreasnobaly so. 164libc), the two diverge, but not unreasonably so.
150 165
151 text data bss drs rss filename 166 text data bss drs rss filename
152 163431 2152 24 20123 2060 rxvt --enable-everything 167 163431 2152 24 20123 2060 rxvt --enable-everything
153 1035683 49680 66648 29096 3680 urxvt --enable-everything 168 1035683 49680 66648 29096 3680 urxvt --enable-everything
154 169
197 212
198And here is rxvt-unicode: 213And here is rxvt-unicode:
199 214
200 libX11.so.6 => /usr/X11R6/lib/libX11.so.6 (0x00002aaaaabc3000) 215 libX11.so.6 => /usr/X11R6/lib/libX11.so.6 (0x00002aaaaabc3000)
201 libgcc_s.so.1 => /lib/libgcc_s.so.1 (0x00002aaaaada2000) 216 libgcc_s.so.1 => /lib/libgcc_s.so.1 (0x00002aaaaada2000)
202 libc.so.6 => /lib/libc.so.6 (0x00002aaaaaeb0000) 217 libc.so.6 => /lib/libc.so.6 (0x00002aaaaaeb0000)
203 libdl.so.2 => /lib/libdl.so.2 (0x00002aaaab0ee000) 218 libdl.so.2 => /lib/libdl.so.2 (0x00002aaaab0ee000)
204 /lib64/ld-linux-x86-64.so.2 (0x00002aaaaaaab000) 219 /lib64/ld-linux-x86-64.so.2 (0x00002aaaaaaab000)
205 220
206No large bloated libraries (of course, none were linked in statically), 221No large bloated libraries (of course, none were linked in statically),
207except maybe libX11 :) 222except maybe libX11 :)
208 223
209 224
210=head2 Rendering, Font & Look and Feel Issues 225=head2 Rendering, Font & Look and Feel Issues
211 226
212=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?
213 228
214First of all, transparency isn't officially supported in rxvt-unicode, so 229First of all, please address all transparency related issues to Sasha Vasko at
215you 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
216bug 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.
217of passage: ... and you failed.
218 232
219Here 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
220descriptions for the programs mentioned and rxvt-unicode. Really, do it! 234descriptions for the programs mentioned and rxvt-unicode. Really, do it!
221 235
2221. Use inheritPixmap: 2361. Use transparent mode:
223 237
224 Esetroot wallpaper.jpg 238 Esetroot wallpaper.jpg
225 @@URXVT_NAME@@ -ip -tint red -sh 40 239 @@URXVT_NAME@@ -tr -tint red -sh 40
226 240
227That 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
228support, or you are unable to read. 242support, or you are unable to read.
229 243
2302. Use a simple pixmap and emulate pseudo-transparency. This enables you 2442. Use a simple pixmap and emulate pseudo-transparency. This enables you
231to use effects other than tinting and shading: Just shade/tint/whatever 245to use effects other than tinting and shading: Just shade/tint/whatever
232your picture with gimp or any other tool: 246your picture with gimp or any other tool:
233 247
234 convert wallpaper.jpg -blur 20x20 -modulate 30 background.xpm 248 convert wallpaper.jpg -blur 20x20 -modulate 30 background.jpg
235 @@URXVT_NAME@@ -pixmap background.xpm -pe automove-background 249 @@URXVT_NAME@@ -pixmap "background.jpg;:root"
236 250
237That 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
238are unable to read. 252are unable to read.
239 253
2403. Use an ARGB visual: 2543. Use an ARGB visual:
241 255
242 @@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
243 257
244This 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
245doesn'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
246there yet, no matter what they claim. Rxvt-Unicode contains the neccessary 260there yet, no matter what they claim. Rxvt-Unicode contains the necessary
247bugfixes 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
248doesn't mean that your WM has the required kludges in place. 262doesn't mean that your WM has the required kludges in place.
249 263
2504. Use xcompmgr and let it do the job: 2644. Use xcompmgr and let it do the job:
251 265
268however: Xft fonts often draw glyphs larger than their acclaimed bounding 282however: Xft fonts often draw glyphs larger than their acclaimed bounding
269box, 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
270ask for the character bounding box, which unfortunately is wrong in these 284ask for the character bounding box, which unfortunately is wrong in these
271cases). 285cases).
272 286
273It'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,
274or 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
275the 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
276might be forced to use a different font. 290might be forced to use a different font.
277 291
278All 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
302=head3 Can I switch the fonts at runtime? 316=head3 Can I switch the fonts at runtime?
303 317
304Yes, 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
305effect as using the C<-fn> switch, and takes effect immediately: 319effect as using the C<-fn> switch, and takes effect immediately:
306 320
307 printf '\e]50;%s\007' "9x15bold,xft:Kochi Gothic" 321 printf '\33]50;%s\007' "9x15bold,xft:Kochi Gothic"
308 322
309This 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
310japanese font), but you have to switch to chinese temporarily, where 324japanese font), but you have to switch to chinese temporarily, where
311japanese fonts would only be in your way. 325japanese fonts would only be in your way.
312 326
314 328
315=head3 Why do italic characters look as if clipped? 329=head3 Why do italic characters look as if clipped?
316 330
317Many fonts have difficulties with italic characters and hinting. For 331Many fonts have difficulties with italic characters and hinting. For
318example, the otherwise very nicely hinted font C<xft:Bitstream Vera Sans 332example, the otherwise very nicely hinted font C<xft:Bitstream Vera Sans
319Mono> completely fails in it's italic face. A workaround might be to 333Mono> completely fails in its italic face. A workaround might be to
320enable freetype autohinting, i.e. like this: 334enable freetype autohinting, i.e. like this:
321 335
322 URxvt.italicFont: xft:Bitstream Vera Sans Mono:italic:autohint=true 336 URxvt.italicFont: xft:Bitstream Vera Sans Mono:italic:autohint=true
323 URxvt.boldItalicFont: xft:Bitstream Vera Sans Mono:bold:italic:autohint=true 337 URxvt.boldItalicFont: xft:Bitstream Vera Sans Mono:bold:italic:autohint=true
324 338
330memory and also speeds up rendering considerably. 344memory and also speeds up rendering considerably.
331 345
332=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?
333 347
334Rxvt-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
335fall 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
336fonts, 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
337antialiasing disabled for most of them, because the author thinks they 351antialiasing disabled for most of them, because the author thinks they
338look best that way. 352look best that way.
339 353
340If you want antialiasing, you have to specify the fonts manually. 354If you want antialiasing, you have to specify the fonts manually.
342=head3 What's with this bold/blink stuff? 356=head3 What's with this bold/blink stuff?
343 357
344If 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
345standard foreground colour. 359standard foreground colour.
346 360
347For the standard background colour, blinking will actually make the 361For the standard background colour, blinking will actually make
348text blink when compiled with C<--enable-blinking>. with standard 362the text blink when compiled with C<--enable-text-blink>. Without
349colours. Without C<--enable-blinking>, the blink attribute will be 363C<--enable-text-blink>, the blink attribute will be ignored.
350ignored.
351 364
352On ANSI colours, bold/blink attributes are used to set high-intensity 365On ANSI colours, bold/blink attributes are used to set high-intensity
353foreground/background colors. 366foreground/background colors.
354 367
355color0-7 are the low-intensity colors. 368color0-7 are the low-intensity colors.
460has been designed yet). 473has been designed yet).
461 474
462Until 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
463I switch the fonts at runtime?> later in this document). 476I switch the fonts at runtime?> later in this document).
464 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
465=head2 Keyboard, Mouse & User Interaction 485=head2 Keyboard, Mouse & User Interaction
466 486
467=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?
468 488
469If 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
476 496
477To 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:
478 498
479 URxvt.selection.pattern-0: ([^"&'()*,;<=>?@[\\\\]^`{|})]+) 499 URxvt.selection.pattern-0: ([^"&'()*,;<=>?@[\\\\]^`{|})]+)
480 500
481Please also note that the I<LeftClick Shift-LeftClik> combination also 501Please also note that the I<LeftClick Shift-LeftClick> combination also
482selects words like the old code. 502selects words like the old code.
483 503
484=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?
485 505
486You can disable the perl extension completely by setting the 506You can disable the perl extension completely by setting the
512circumstances, it will move your cursor around when you click into the 532circumstances, it will move your cursor around when you click into the
513line 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,
514but 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
515cases during rlogin sessions, it fails to detect this properly. 535cases during rlogin sessions, it fails to detect this properly.
516 536
517You can permamently switch this feature off by disabling the C<readline> 537You can permanently switch this feature off by disabling the C<readline>
518extension: 538extension:
519 539
520 URxvt.perl-ext-common: default,-readline 540 URxvt.perl-ext-common: default,-readline
521 541
522=head3 My numerical keypad acts weird and generates differing output? 542=head3 My numerical keypad acts weird and generates differing output?
523 543
524Some Debian GNUL/Linux users seem to have this problem, although no 544Some Debian GNUL/Linux users seem to have this problem, although no
525specific 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
526by 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
527this 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
528keymap. 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
529helped. 549helped.
530 550
531=head3 My Compose (Multi_key) key is no longer working. 551=head3 My Compose (Multi_key) key is no longer working.
557depressed. 577depressed.
558 578
559=head3 What's with the strange Backspace/Delete key behaviour? 579=head3 What's with the strange Backspace/Delete key behaviour?
560 580
561Assuming that the physical Backspace key corresponds to the 581Assuming that the physical Backspace key corresponds to the
562BackSpace keysym (not likely for Linux ... see the following 582Backspace keysym (not likely for Linux ... see the following
563question) there are two standard values that can be used for 583question) there are two standard values that can be used for
564Backspace: C<^H> and C<^?>. 584Backspace: C<^H> and C<^?>.
565 585
566Historically, either value is correct, but rxvt-unicode adopts the debian 586Historically, either value is correct, but rxvt-unicode adopts the debian
567policy 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
568choice :). 588choice :).
569 589
570Rxvt-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
571of `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
572started 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
604key 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
605(C<ESC [ 3 ~>) and is in the supplied termcap/terminfo. 625(C<ESC [ 3 ~>) and is in the supplied termcap/terminfo.
606 626
607Some other Backspace problems: 627Some other Backspace problems:
608 628
609some editors use termcap/terminfo, 629some editors use termcap/terminfo,
610some editors (vim I'm told) expect Backspace = ^H, 630some editors (vim I'm told) expect Backspace = ^H,
611GNU Emacs (and Emacs-like editors) use ^H for help. 631GNU Emacs (and Emacs-like editors) use ^H for help.
612 632
613Perhaps someday this will all be resolved in a consistent manner. 633Perhaps someday this will all be resolved in a consistent manner.
614 634
655Rather than have rxvt-unicode try to accommodate all the various possible 675Rather than have rxvt-unicode try to accommodate all the various possible
656keyboard 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
657required for your particular machine. 677required for your particular machine.
658 678
659 679
660
661=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 :->
662 835
663=head3 Why doesn't rxvt-unicode read my resources? 836=head3 Why doesn't rxvt-unicode read my resources?
664 837
665Well, 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
666applications. Most importantly, this means that if you or your OS loads 839applications. Most importantly, this means that if you or your OS loads
675Also consider the form resources have to use: 848Also consider the form resources have to use:
676 849
677 URxvt.resource: value 850 URxvt.resource: value
678 851
679If 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
680specifying resources), make sure you understand wether and why it 853specifying resources), make sure you understand whether and why it
681works. If unsure, use the form above. 854works. If unsure, use the form above.
682 855
683=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?
684 857
685The terminal description used by rxvt-unicode is not as widely available 858The terminal description used by rxvt-unicode is not as widely available
686as 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).
687 860
688The 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
689be 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):
690 866
691 REMOTE=remotesystem.domain 867 REMOTE=remotesystem.domain
692 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"
693 869
694... 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.
695 872
696If 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
697C<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
698problems arising, which includes wrong keymapping, less and different 875problems arising, which includes wrong keymapping, less and different
699colours and some refresh errors in fullscreen applications. It's a nice 876colours and some refresh errors in fullscreen applications. It's a nice
706 URxvt.termName: rxvt 883 URxvt.termName: rxvt
707 884
708If 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
709the 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>.
710 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
711=head3 C<tic> outputs some error when compiling the terminfo entry. 894=head3 C<tic> outputs some error when compiling the terminfo entry.
712 895
713Most 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
714C<enacs=\E[0@> and try again. 897C<enacs=\E[0@> and try again.
715 898
722One reason you might want this is that some distributions or operating 905One reason you might want this is that some distributions or operating
723systems still compile some programs using the long-obsoleted termcap 906systems still compile some programs using the long-obsoleted termcap
724library (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
725for C<rxvt-unicode>. 908for C<rxvt-unicode>.
726 909
727You 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.
728You 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
729like this: 912like this:
730 913
731 infocmp -C rxvt-unicode 914 infocmp -C rxvt-unicode
732 915
733Or you could use this termcap entry, generated by the command above: 916Or you could use the termcap entry in doc/etc/rxvt-unicode.termcap,
734 917generated by the command above.
735 rxvt-unicode|rxvt-unicode terminal (X Window System):\
736 :am:bw:eo:km:mi:ms:xn:xo:\
737 :co#80:it#8:li#24:lm#0:\
738 :AL=\E[%dL:DC=\E[%dP:DL=\E[%dM:DO=\E[%dB:IC=\E[%d@:\
739 :K1=\EOw:K2=\EOu:K3=\EOy:K4=\EOq:K5=\EOs:LE=\E[%dD:\
740 :RI=\E[%dC:SF=\E[%dS:SR=\E[%dT:UP=\E[%dA:ae=\E(B:al=\E[L:\
741 :as=\E(0:bl=^G:cd=\E[J:ce=\E[K:cl=\E[H\E[2J:\
742 :cm=\E[%i%d;%dH:cr=^M:cs=\E[%i%d;%dr:ct=\E[3g:dc=\E[P:\
743 :dl=\E[M:do=^J:ec=\E[%dX:ei=\E[4l:ho=\E[H:\
744 :i1=\E[?47l\E=\E[?1l:ic=\E[@:im=\E[4h:\
745 :is=\E[r\E[m\E[2J\E[H\E[?7h\E[?1;3;4;6l\E[4l:\
746 :k1=\E[11~:k2=\E[12~:k3=\E[13~:k4=\E[14~:k5=\E[15~:\
747 :k6=\E[17~:k7=\E[18~:k8=\E[19~:k9=\E[20~:kD=\E[3~:\
748 :kI=\E[2~:kN=\E[6~:kP=\E[5~:kb=\177:kd=\EOB:ke=\E[?1l\E>:\
749 :kh=\E[7~:kl=\EOD:kr=\EOC:ks=\E[?1h\E=:ku=\EOA:le=^H:\
750 :mb=\E[5m:md=\E[1m:me=\E[m\017:mr=\E[7m:nd=\E[C:rc=\E8:\
751 :sc=\E7:se=\E[27m:sf=^J:so=\E[7m:sr=\EM:st=\EH:ta=^I:\
752 :te=\E[r\E[?1049l:ti=\E[?1049h:ue=\E[24m:up=\E[A:\
753 :us=\E[4m:vb=\E[?5h\E[?5l:ve=\E[?25h:vi=\E[?25l:\
754 :vs=\E[?25h:
755 918
756=head3 Why does C<ls> no longer have coloured output? 919=head3 Why does C<ls> no longer have coloured output?
757 920
758The 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
759decide wether a terminal has colour, but uses it's own configuration 922decide whether a terminal has colour, but uses its own configuration
760file. 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
761with most other terminals supporting colour). Either add: 924with most other terminals supporting colour). Either add:
762 925
763 TERM rxvt-unicode 926 TERM rxvt-unicode
764 927
765to C</etc/DIR_COLORS> or simply add: 928to C</etc/DIR_COLORS> or simply add:
799If you encounter strange problems like typing an accented character but 962If you encounter strange problems like typing an accented character but
800getting two unrelated other characters or similar, or if program output is 963getting two unrelated other characters or similar, or if program output is
801subtly garbled, then you should check your locale settings. 964subtly garbled, then you should check your locale settings.
802 965
803Rxvt-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
804programs. 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,
805login script running within the rxvt-unicode window changes the locale to 968while the login script running within the rxvt-unicode window changes the
806something 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.
807 971
808The 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
809into 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.
810 974
811 printf '\e]701;%s\007' "$LC_CTYPE" 975 printf '\33]701;%s\007' "$LC_CTYPE" # $LANG or $LC_ALL are worth a try, too
812 976
813If 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
814supported on your systems. Some systems have a C<locale> command which 978supported on your systems. Some systems have a C<locale> command which
815displays 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
816it 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
837The reasons is that there exists a perfectly fine mechanism for selecting 1001The reasons is that there exists a perfectly fine mechanism for selecting
838the encoding, doing I/O and (most important) communicating this to all 1002the encoding, doing I/O and (most important) communicating this to all
839applications so everybody agrees on character properties such as width 1003applications so everybody agrees on character properties such as width
840and code number. This mechanism is the I<locale>. Applications not using 1004and code number. This mechanism is the I<locale>. Applications not using
841that 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
842characters wrong as it uses it's own, locale-independent table under all 1006characters wrong as it uses its own, locale-independent table under all
843locales). 1007locales).
844 1008
845Rxvt-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
846programs doing the same (that is, most) will automatically agree in the 1010programs doing the same (that is, most) will automatically agree in the
847interpretation of characters. 1011interpretation of characters.
866=head3 Can I switch locales at runtime? 1030=head3 Can I switch locales at runtime?
867 1031
868Yes, using an escape sequence. Try something like this, which sets 1032Yes, using an escape sequence. Try something like this, which sets
869rxvt-unicode's idea of C<LC_CTYPE>. 1033rxvt-unicode's idea of C<LC_CTYPE>.
870 1034
871 printf '\e]701;%s\007' ja_JP.SJIS 1035 printf '\33]701;%s\007' ja_JP.SJIS
872 1036
873See also the previous answer. 1037See also the previous answer.
874 1038
875Sometimes this capability is rather handy when you want to work in 1039Sometimes this capability is rather handy when you want to work in
876one 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
877(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
878first switches to a locale supported by xjdic and back later: 1042first switches to a locale supported by xjdic and back later:
879 1043
880 printf '\e]701;%s\007' ja_JP.SJIS 1044 printf '\33]701;%s\007' ja_JP.SJIS
881 xjdic -js 1045 xjdic -js
882 printf '\e]701;%s\007' de_DE.UTF-8 1046 printf '\33]701;%s\007' de_DE.UTF-8
883 1047
884You 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
885for some locales where character width differs between program- and 1049for some locales where character width differs between program- and
886rxvt-unicode-locales. 1050rxvt-unicode-locales.
887 1051
905=item - Make sure your XIM server is actually running. 1069=item - Make sure your XIM server is actually running.
906 1070
907=item - Make sure the C<XMODIFIERS> environment variable is set correctly when I<starting> rxvt-unicode. 1071=item - Make sure the C<XMODIFIERS> environment variable is set correctly when I<starting> rxvt-unicode.
908 1072
909When you want to use e.g. B<kinput2>, it must be set to 1073When you want to use e.g. B<kinput2>, it must be set to
910C<@im=kinput2>. For B<scim>, use C<@im=SCIM>. Youc an see what input 1074C<@im=kinput2>. For B<scim>, use C<@im=SCIM>. You can see what input
911method servers are running with this command: 1075method servers are running with this command:
912 1076
913 xprop -root XIM_SERVERS 1077 xprop -root XIM_SERVERS
914 1078
915=item 1079=item
916 1080
917=back 1081=back
918 1082
919=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?
920 1084
960 1124
961=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?
962 1126
963You should build one binary with the default options. F<configure> 1127You should build one binary with the default options. F<configure>
964now enables most useful options, and the trend goes to making them 1128now enables most useful options, and the trend goes to making them
965runtime-switchable, too, so there is usually no drawback to enbaling them, 1129runtime-switchable, too, so there is usually no drawback to enabling them,
966except higher disk and possibly memory usage. The perl interpreter should 1130except higher disk and possibly memory usage. The perl interpreter should
967be enabled, as important functionality (menus, selection, likely more in 1131be enabled, as important functionality (menus, selection, likely more in
968the future) depends on it. 1132the future) depends on it.
969 1133
970You 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
993This 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
994and reduces possible bugs to initialisation code run before main(), or 1158and reduces possible bugs to initialisation code run before main(), or
995things 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
996little risk. 1160little risk.
997 1161
998=head3 On Solaris 9, many line-drawing characters are too wide.
999
1000Seems to be a known bug, read
1001L<http://nixdoc.net/files/forum/about34198.html>. Some people use the
1002following ugly workaround to get non-double-wide-characters working:
1003
1004 #define wcwidth(x) wcwidth(x) > 1 ? 1 : wcwidth(x)
1005
1006=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.
1007 1163
1008Rxvt-unicode requires the symbol C<__STDC_ISO_10646__> to be defined 1164Rxvt-unicode requires the symbol C<__STDC_ISO_10646__> to be defined
1009in your compile environment, or an implementation that implements it, 1165in your compile environment, or an implementation that implements it,
1010wether 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
1011B<wchar_t> is represented as unicode. 1167B<wchar_t> is represented as unicode.
1012 1168
1013As you might have guessed, FreeBSD does neither define this symobl nor 1169As you might have guessed, FreeBSD does neither define this symbol nor
1014does it support it. Instead, it uses it's own internal representation of 1170does it support it. Instead, it uses its own internal representation of
1015B<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.
1016 1172
1017However, 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
1018C<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>).
1019 1175
1020C<__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
1021apps in an OS, as using a locale-dependent (and non-standardized) 1177apps in an OS, as using a locale-dependent (and non-standardized)
1022representation of B<wchar_t> makes it impossible to convert between 1178representation of B<wchar_t> makes it impossible to convert between
1023B<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
1033 1189
1034The 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
1035system 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
1036complete replacements for them :) 1192complete replacements for them :)
1037 1193
1038=head3 I use Solaris 9 and it doesn't compile/work/etc.
1039
1040Try the diff in F<doc/solaris9.patch> as a base. It fixes the worst
1041problems with C<wcwidth> and a compile problem.
1042
1043=head3 How can I use rxvt-unicode under cygwin? 1194=head3 How can I use rxvt-unicode under cygwin?
1044 1195
1045rxvt-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
1046the X11 libraries that come with cygwin. libW11 emulation is no 1197the X11 libraries that come with cygwin. libW11 emulation is no
1047longer supported (and makes no sense, either, as it only supported a 1198longer supported (and makes no sense, either, as it only supported a
1050old libW11 emulation. 1201old libW11 emulation.
1051 1202
1052At 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
1053encodings (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
1054to 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.
1055 1225
1056=head1 RXVT-UNICODE TECHNICAL REFERENCE 1226=head1 RXVT-UNICODE TECHNICAL REFERENCE
1057 1227
1058The rest of this document describes various technical aspects of 1228The rest of this document describes various technical aspects of
1059B<rxvt-unicode>. First the description of supported command sequences, 1229B<rxvt-unicode>. First the description of supported command sequences,
1312=begin table 1482=begin table
1313 1483
1314 B<< C<Ps = 0> >> Clear to Right (default) 1484 B<< C<Ps = 0> >> Clear to Right (default)
1315 B<< C<Ps = 1> >> Clear to Left 1485 B<< C<Ps = 1> >> Clear to Left
1316 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)
1317 1489
1318=end table 1490=end table
1319 1491
1320=item B<< C<ESC [ Ps L> >> 1492=item B<< C<ESC [ Ps L> >>
1321 1493
1553 1725
1554Toggle DEC Private Mode Values (rxvt extension). I<where> 1726Toggle DEC Private Mode Values (rxvt extension). I<where>
1555 1727
1556=over 4 1728=over 4
1557 1729
1558=item B<< C<Ps = 1> >> (DECCKM) 1730=item B<< C<Pm = 1> >> (DECCKM)
1559 1731
1560=begin table 1732=begin table
1561 1733
1562 B<< C<h> >> Application Cursor Keys 1734 B<< C<h> >> Application Cursor Keys
1563 B<< C<l> >> Normal Cursor Keys 1735 B<< C<l> >> Normal Cursor Keys
1564 1736
1565=end table 1737=end table
1566 1738
1567=item B<< C<Ps = 2> >> (ANSI/VT52 mode) 1739=item B<< C<Pm = 2> >> (ANSI/VT52 mode)
1568 1740
1569=begin table 1741=begin table
1570 1742
1571 B<< C<h> >> Enter VT52 mode 1743 B<< C<h> >> Enter VT52 mode
1572 B<< C<l> >> Enter VT52 mode 1744 B<< C<l> >> Enter VT52 mode
1573 1745
1574=end table 1746=end table
1575 1747
1576=item B<< C<Ps = 3> >> 1748=item B<< C<Pm = 3> >>
1577 1749
1578=begin table 1750=begin table
1579 1751
1580 B<< C<h> >> 132 Column Mode (DECCOLM) 1752 B<< C<h> >> 132 Column Mode (DECCOLM)
1581 B<< C<l> >> 80 Column Mode (DECCOLM) 1753 B<< C<l> >> 80 Column Mode (DECCOLM)
1582 1754
1583=end table 1755=end table
1584 1756
1585=item B<< C<Ps = 4> >> 1757=item B<< C<Pm = 4> >>
1586 1758
1587=begin table 1759=begin table
1588 1760
1589 B<< C<h> >> Smooth (Slow) Scroll (DECSCLM) 1761 B<< C<h> >> Smooth (Slow) Scroll (DECSCLM)
1590 B<< C<l> >> Jump (Fast) Scroll (DECSCLM) 1762 B<< C<l> >> Jump (Fast) Scroll (DECSCLM)
1591 1763
1592=end table 1764=end table
1593 1765
1594=item B<< C<Ps = 5> >> 1766=item B<< C<Pm = 5> >>
1595 1767
1596=begin table 1768=begin table
1597 1769
1598 B<< C<h> >> Reverse Video (DECSCNM) 1770 B<< C<h> >> Reverse Video (DECSCNM)
1599 B<< C<l> >> Normal Video (DECSCNM) 1771 B<< C<l> >> Normal Video (DECSCNM)
1600 1772
1601=end table 1773=end table
1602 1774
1603=item B<< C<Ps = 6> >> 1775=item B<< C<Pm = 6> >>
1604 1776
1605=begin table 1777=begin table
1606 1778
1607 B<< C<h> >> Origin Mode (DECOM) 1779 B<< C<h> >> Origin Mode (DECOM)
1608 B<< C<l> >> Normal Cursor Mode (DECOM) 1780 B<< C<l> >> Normal Cursor Mode (DECOM)
1609 1781
1610=end table 1782=end table
1611 1783
1612=item B<< C<Ps = 7> >> 1784=item B<< C<Pm = 7> >>
1613 1785
1614=begin table 1786=begin table
1615 1787
1616 B<< C<h> >> Wraparound Mode (DECAWM) 1788 B<< C<h> >> Wraparound Mode (DECAWM)
1617 B<< C<l> >> No Wraparound Mode (DECAWM) 1789 B<< C<l> >> No Wraparound Mode (DECAWM)
1618 1790
1619=end table 1791=end table
1620 1792
1621=item B<< C<Ps = 8> >> I<unimplemented> 1793=item B<< C<Pm = 8> >> I<unimplemented>
1622 1794
1623=begin table 1795=begin table
1624 1796
1625 B<< C<h> >> Auto-repeat Keys (DECARM) 1797 B<< C<h> >> Auto-repeat Keys (DECARM)
1626 B<< C<l> >> No Auto-repeat Keys (DECARM) 1798 B<< C<l> >> No Auto-repeat Keys (DECARM)
1627 1799
1628=end table 1800=end table
1629 1801
1630=item B<< C<Ps = 9> >> X10 XTerm 1802=item B<< C<Pm = 9> >> X10 XTerm
1631 1803
1632=begin table 1804=begin table
1633 1805
1634 B<< C<h> >> Send Mouse X & Y on button press. 1806 B<< C<h> >> Send Mouse X & Y on button press.
1635 B<< C<l> >> No mouse reporting. 1807 B<< C<l> >> No mouse reporting.
1636 1808
1637=end table 1809=end table
1638 1810
1639=item B<< C<Ps = 25> >> 1811=item B<< C<Pm = 25> >>
1640 1812
1641=begin table 1813=begin table
1642 1814
1643 B<< C<h> >> Visible cursor {cnorm/cvvis} 1815 B<< C<h> >> Visible cursor {cnorm/cvvis}
1644 B<< C<l> >> Invisible cursor {civis} 1816 B<< C<l> >> Invisible cursor {civis}
1645 1817
1646=end table 1818=end table
1647 1819
1648=item B<< C<Ps = 30> >> 1820=item B<< C<Pm = 30> >>
1649 1821
1650=begin table 1822=begin table
1651 1823
1652 B<< C<h> >> scrollBar visisble 1824 B<< C<h> >> scrollBar visible
1653 B<< C<l> >> scrollBar invisisble 1825 B<< C<l> >> scrollBar invisible
1654 1826
1655=end table 1827=end table
1656 1828
1657=item B<< C<Ps = 35> >> (B<rxvt>) 1829=item B<< C<Pm = 35> >> (B<rxvt>)
1658 1830
1659=begin table 1831=begin table
1660 1832
1661 B<< C<h> >> Allow XTerm Shift+key sequences 1833 B<< C<h> >> Allow XTerm Shift+key sequences
1662 B<< C<l> >> Disallow XTerm Shift+key sequences 1834 B<< C<l> >> Disallow XTerm Shift+key sequences
1663 1835
1664=end table 1836=end table
1665 1837
1666=item B<< C<Ps = 38> >> I<unimplemented> 1838=item B<< C<Pm = 38> >> I<unimplemented>
1667 1839
1668Enter Tektronix Mode (DECTEK) 1840Enter Tektronix Mode (DECTEK)
1669 1841
1670=item B<< C<Ps = 40> >> 1842=item B<< C<Pm = 40> >>
1671 1843
1672=begin table 1844=begin table
1673 1845
1674 B<< C<h> >> Allow 80/132 Mode 1846 B<< C<h> >> Allow 80/132 Mode
1675 B<< C<l> >> Disallow 80/132 Mode 1847 B<< C<l> >> Disallow 80/132 Mode
1676 1848
1677=end table 1849=end table
1678 1850
1679=item B<< C<Ps = 44> >> I<unimplemented> 1851=item B<< C<Pm = 44> >> I<unimplemented>
1680 1852
1681=begin table 1853=begin table
1682 1854
1683 B<< C<h> >> Turn On Margin Bell 1855 B<< C<h> >> Turn On Margin Bell
1684 B<< C<l> >> Turn Off Margin Bell 1856 B<< C<l> >> Turn Off Margin Bell
1685 1857
1686=end table 1858=end table
1687 1859
1688=item B<< C<Ps = 45> >> I<unimplemented> 1860=item B<< C<Pm = 45> >> I<unimplemented>
1689 1861
1690=begin table 1862=begin table
1691 1863
1692 B<< C<h> >> Reverse-wraparound Mode 1864 B<< C<h> >> Reverse-wraparound Mode
1693 B<< C<l> >> No Reverse-wraparound Mode 1865 B<< C<l> >> No Reverse-wraparound Mode
1694 1866
1695=end table 1867=end table
1696 1868
1697=item B<< C<Ps = 46> >> I<unimplemented> 1869=item B<< C<Pm = 46> >> I<unimplemented>
1698 1870
1699=item B<< C<Ps = 47> >> 1871=item B<< C<Pm = 47> >>
1700 1872
1701=begin table 1873=begin table
1702 1874
1703 B<< C<h> >> Use Alternate Screen Buffer 1875 B<< C<h> >> Use Alternate Screen Buffer
1704 B<< C<l> >> Use Normal Screen Buffer 1876 B<< C<l> >> Use Normal Screen Buffer
1705 1877
1706=end table 1878=end table
1707 1879
1708X<Priv66> 1880X<Priv66>
1709 1881
1710=item B<< C<Ps = 66> >> 1882=item B<< C<Pm = 66> >>
1711 1883
1712=begin table 1884=begin table
1713 1885
1714 B<< C<h> >> Application Keypad (DECPAM) == C<ESC => 1886 B<< C<h> >> Application Keypad (DECPAM) == C<ESC =>
1715 B<< C<l> >> Normal Keypad (DECPNM) == C<< ESC > >> 1887 B<< C<l> >> Normal Keypad (DECPNM) == C<< ESC > >>
1716 1888
1717=end table 1889=end table
1718 1890
1719=item B<< C<Ps = 67> >> 1891=item B<< C<Pm = 67> >>
1720 1892
1721=begin table 1893=begin table
1722 1894
1723 B<< C<h> >> Backspace key sends B<< C<BS> (DECBKM) >> 1895 B<< C<h> >> Backspace key sends B<< C<BS> (DECBKM) >>
1724 B<< C<l> >> Backspace key sends B<< C<DEL> >> 1896 B<< C<l> >> Backspace key sends B<< C<DEL> >>
1725 1897
1726=end table 1898=end table
1727 1899
1728=item B<< C<Ps = 1000> >> (X11 XTerm) 1900=item B<< C<Pm = 1000> >> (X11 XTerm)
1729 1901
1730=begin table 1902=begin table
1731 1903
1732 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.
1733 B<< C<l> >> No mouse reporting. 1905 B<< C<l> >> No mouse reporting.
1734 1906
1735=end table 1907=end table
1736 1908
1737=item B<< C<Ps = 1001> >> (X11 XTerm) I<unimplemented> 1909=item B<< C<Pm = 1001> >> (X11 XTerm) I<unimplemented>
1738 1910
1739=begin table 1911=begin table
1740 1912
1741 B<< C<h> >> Use Hilite Mouse Tracking. 1913 B<< C<h> >> Use Hilite Mouse Tracking.
1742 B<< C<l> >> No mouse reporting. 1914 B<< C<l> >> No mouse reporting.
1743 1915
1744=end table 1916=end table
1745 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
1746=item B<< C<Ps = 1010> >> (B<rxvt>) 1936=item B<< C<Pm = 1010> >> (B<rxvt>)
1747 1937
1748=begin table 1938=begin table
1749 1939
1750 B<< C<h> >> Don't scroll to bottom on TTY output 1940 B<< C<h> >> Don't scroll to bottom on TTY output
1751 B<< C<l> >> Scroll to bottom on TTY output 1941 B<< C<l> >> Scroll to bottom on TTY output
1752 1942
1753=end table 1943=end table
1754 1944
1755=item B<< C<Ps = 1011> >> (B<rxvt>) 1945=item B<< C<Pm = 1011> >> (B<rxvt>)
1756 1946
1757=begin table 1947=begin table
1758 1948
1759 B<< C<h> >> Scroll to bottom when a key is pressed 1949 B<< C<h> >> Scroll to bottom when a key is pressed
1760 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
1761 1951
1762=end table 1952=end table
1763 1953
1764=item B<< C<Ps = 1021> >> (B<rxvt>) 1954=item B<< C<Pm = 1021> >> (B<rxvt>)
1765 1955
1766=begin table 1956=begin table
1767 1957
1768 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>)
1769 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)
1770 1960
1771=end table 1961=end table
1772 1962
1773=item B<< C<Ps = 1047> >> 1963=item B<< C<Pm = 1047> >>
1774 1964
1775=begin table 1965=begin table
1776 1966
1777 B<< C<h> >> Use Alternate Screen Buffer 1967 B<< C<h> >> Use Alternate Screen Buffer
1778 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
1779 1969
1780=end table 1970=end table
1781 1971
1782=item B<< C<Ps = 1048> >> 1972=item B<< C<Pm = 1048> >>
1783 1973
1784=begin table 1974=begin table
1785 1975
1786 B<< C<h> >> Save cursor position 1976 B<< C<h> >> Save cursor position
1787 B<< C<l> >> Restore cursor position 1977 B<< C<l> >> Restore cursor position
1788 1978
1789=end table 1979=end table
1790 1980
1791=item B<< C<Ps = 1049> >> 1981=item B<< C<Pm = 1049> >>
1792 1982
1793=begin table 1983=begin table
1794 1984
1795 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
1796 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
1797 1996
1798=end table 1997=end table
1799 1998
1800=back 1999=back
1801 2000
1818 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> >>
1819 B<< C<Ps = 1> >> Change Icon Name to B<< C<Pt> >> 2018 B<< C<Ps = 1> >> Change Icon Name to B<< C<Pt> >>
1820 B<< C<Ps = 2> >> Change Window Title to B<< C<Pt> >> 2019 B<< C<Ps = 2> >> Change Window Title to B<< C<Pt> >>
1821 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.
1822 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
1823 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> >>
1824 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> >>
1825 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> >>
1826 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> >>
1827 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> >>
1828 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]
1829 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]
1830 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).
1831 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]
1832 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>
1833 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]
1834 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> >>
1835 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]
1836 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).
1837 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>.
1838 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> >>
1839 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).
1840 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> >>
1841 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> >>
1842 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>.
1843 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).
1844 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).
1845 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).
1846 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).
1849 2049
1850=end table 2050=end table
1851 2051
1852=back 2052=back
1853 2053
1854=head1 XPM 2054=head1 BACKGROUND IMAGE
1855 2055
1856For 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
1857of 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
1858sequence of scaling/positioning commands separated by semi-colons. The 2058sequence of scaling/positioning commands separated by semi-colons. The
1859scaling/positioning commands are as follows: 2059scaling/positioning commands are as follows:
1860 2060
1861=over 4 2061=over 4
1862 2062
1900 2100
1901For example: 2101For example:
1902 2102
1903=over 4 2103=over 4
1904 2104
1905=item B<\E]20;funky\a> 2105=item B<\E]20;funky.jpg\a>
1906 2106
1907load B<funky.xpm> as a tiled image 2107load B<funky.jpg> as a tiled image
1908 2108
1909=item B<\E]20;mona;100\a> 2109=item B<\E]20;mona.jpg;100\a>
1910 2110
1911load B<mona.xpm> with a scaling of 100% 2111load B<mona.jpg> with a scaling of 100%
1912 2112
1913=item B<\E]20;;200;?\a> 2113=item B<\E]20;;200;?\a>
1914 2114
1915rescale the current pixmap to 200% and display the image geometry in 2115rescale the current pixmap to 200% and display the image geometry in
1916the title 2116the title
1917 2117
1918=back 2118=back
2119
1919X<Mouse> 2120X<Mouse>
1920 2121
1921=head1 Mouse Reporting 2122=head1 Mouse Reporting
1922 2123
1923=over 4 2124=over 4
1964Col = B<< C<< <x> - SPACE >> >> 2165Col = B<< C<< <x> - SPACE >> >>
1965 2166
1966Row = B<< C<< <y> - SPACE >> >> 2167Row = B<< C<< <y> - SPACE >> >>
1967 2168
1968=back 2169=back
2170
2171=head1 Key Codes
2172
1969X<KeyCodes> 2173X<KeyCodes>
1970
1971=head1 Key Codes
1972 2174
1973Note: B<Shift> + B<F1>-B<F10> generates B<F11>-B<F20> 2175Note: B<Shift> + B<F1>-B<F10> generates B<F11>-B<F20>
1974 2176
1975For the keypad, use B<Shift> to temporarily override Application-Keypad 2177For the keypad, use B<Shift> to temporarily override Application-Keypad
1976setting use B<Num_Lock> to toggle Application-Keypad setting if 2178setting use B<Num_Lock> to toggle Application-Keypad setting if
2043 2245
2044=head1 CONFIGURE OPTIONS 2246=head1 CONFIGURE OPTIONS
2045 2247
2046General hint: if you get compile errors, then likely your configuration 2248General hint: if you get compile errors, then likely your configuration
2047hasn'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
2048the 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>
2049myself, so it should generally be a working config. Of course, you should 2251switches). Of course, you should always report when a combination doesn't
2050always report when a combination doesn't work, so it can be fixed. Marc 2252work, so it can be fixed. Marc Lehmann <rxvt@schmorp.de>.
2051Lehmann <rxvt@schmorp.de>.
2052 2253
2053All 2254All
2054 2255
2055=over 4 2256=over 4
2056 2257
2088 2289
2089=begin table 2290=begin table
2090 2291
2091 all all available codeset groups 2292 all all available codeset groups
2092 zh common chinese encodings 2293 zh common chinese encodings
2093 zh_ext rarely used but very big chinese encodigs 2294 zh_ext rarely used but very big chinese encodings
2094 jp common japanese encodings 2295 jp common japanese encodings
2095 jp_ext rarely used but big japanese encodings 2296 jp_ext rarely used but big japanese encodings
2096 kr korean encodings 2297 kr korean encodings
2097 2298
2098=end table 2299=end table
2112requirements 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
2113support these extra characters, but Xft does. 2314support these extra characters, but Xft does.
2114 2315
2115Please note that rxvt-unicode can store unicode code points >65535 2316Please note that rxvt-unicode can store unicode code points >65535
2116even without this flag, but the number of such characters is 2317even without this flag, but the number of such characters is
2117limited to a view thousand (shared with combining characters, 2318limited to a few thousand (shared with combining characters,
2118see next switch), and right now rxvt-unicode cannot display them 2319see next switch), and right now rxvt-unicode cannot display them
2119(input/output and cut&paste still work, though). 2320(input/output and cut&paste still work, though).
2120 2321
2121=item --enable-combining (default: on) 2322=item --enable-combining (default: on)
2122 2323
2145=item --with-res-name=NAME (default: urxvt) 2346=item --with-res-name=NAME (default: urxvt)
2146 2347
2147Use the given name as default application name when 2348Use the given name as default application name when
2148reading resources. Specify --with-res-name=rxvt to replace rxvt. 2349reading resources. Specify --with-res-name=rxvt to replace rxvt.
2149 2350
2150=item --with-res-class=CLASS /default: URxvt) 2351=item --with-res-class=CLASS (default: URxvt)
2151 2352
2152Use the given class as default application class 2353Use the given class as default application class
2153when reading resources. Specify --with-res-class=Rxvt to replace 2354when reading resources. Specify --with-res-class=Rxvt to replace
2154rxvt. 2355rxvt.
2155 2356
2168 2369
2169Write user and tty to lastlog file (used by programs like 2370Write user and tty to lastlog file (used by programs like
2170F<lastlogin>) at start of rxvt execution. This option requires 2371F<lastlogin>) at start of rxvt execution. This option requires
2171--enable-utmp to also be specified. 2372--enable-utmp to also be specified.
2172 2373
2173=item --enable-xpm-background (default: on) 2374=item --enable-afterimage (default: on)
2174 2375
2175Add 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.
2176 2388
2177=item --enable-transparency (default: on) 2389=item --enable-transparency (default: on)
2178 2390
2179Add support for inheriting parent backgrounds thus giving a fake 2391Add support for backgrounds, creating illusion of transparency in the term.
2180transparency to the term.
2181 2392
2182=item --enable-fading (default: on) 2393=item --enable-fading (default: on)
2183 2394
2184Add support for fading the text when focus is lost (requires C<--enable-transparency>). 2395Add support for fading the text when focus is lost.
2185
2186=item --enable-tinting (default: on)
2187
2188Add support for tinting of transparent backgrounds (requires C<--enable-transparency>).
2189 2396
2190=item --enable-rxvt-scroll (default: on) 2397=item --enable-rxvt-scroll (default: on)
2191 2398
2192Add support for the original rxvt scrollbar. 2399Add support for the original rxvt scrollbar.
2193 2400
2196Add support for a NeXT-like scrollbar. 2403Add support for a NeXT-like scrollbar.
2197 2404
2198=item --enable-xterm-scroll (default: on) 2405=item --enable-xterm-scroll (default: on)
2199 2406
2200Add support for an Xterm-like scrollbar. 2407Add support for an Xterm-like scrollbar.
2201
2202=item --enable-plain-scroll (default: on)
2203
2204Add support for a very unobtrusive, plain-looking scrollbar that
2205is the favourite of the rxvt-unicode author, having used it for
2206many years.
2207
2208=item --enable-ttygid (default: off)
2209
2210Change tty device setting to group "tty" - only use this if
2211your system uses this type of security.
2212 2408
2213=item --disable-backspace-key 2409=item --disable-backspace-key
2214 2410
2215Removes 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.
2216 2412
2236A non-exhaustive list of features enabled by C<--enable-frills> (possibly 2432A non-exhaustive list of features enabled by C<--enable-frills> (possibly
2237in combination with other switches) is: 2433in combination with other switches) is:
2238 2434
2239 MWM-hints 2435 MWM-hints
2240 EWMH-hints (pid, utf8 names) and protocols (ping) 2436 EWMH-hints (pid, utf8 names) and protocols (ping)
2437 urgency hint
2241 seperate underline colour (-underlineColor) 2438 seperate underline colour (-underlineColor)
2242 settable border widths and borderless switch (-w, -b, -bl) 2439 settable border widths and borderless switch (-w, -b, -bl)
2243 visual depth selection (-depth) 2440 visual depth selection (-depth)
2244 settable extra linespacing /-lsp) 2441 settable extra linespacing /-lsp)
2245 iso-14755-2 and -3, and visual feedback 2442 iso-14755 5.1 (basic) support
2246 tripleclickwords (-tcw) 2443 tripleclickwords (-tcw)
2247 settable insecure mode (-insecure) 2444 settable insecure mode (-insecure)
2248 keysym remapping support 2445 keysym remapping support
2249 cursor blinking and underline cursor (-cb, -uc) 2446 cursor blinking and underline cursor (-bc, -uc)
2250 XEmbed support (-embed) 2447 XEmbed support (-embed)
2251 user-pty (-pty-fd) 2448 user-pty (-pty-fd)
2252 hold on exit (-hold) 2449 hold on exit (-hold)
2450 compile in built-in block graphics
2253 skip builtin block graphics (-sbg) 2451 skip builtin block graphics (-sbg)
2452 separate highlightcolor support (-hc)
2254 2453
2255It also enabled some non-essential features otherwise disabled, such as: 2454It also enables some non-essential features otherwise disabled, such as:
2256 2455
2257 some round-trip time optimisations 2456 some round-trip time optimisations
2258 nearest color allocation on pseudocolor screens 2457 nearest color allocation on pseudocolor screens
2259 UTF8_STRING supporr for selection 2458 UTF8_STRING support for selection
2260 sgr modes 90..97 and 100..107 2459 sgr modes 90..97 and 100..107
2261 backindex and forwardindex escape sequences 2460 backindex and forwardindex escape sequences
2262 view change/zero scorllback esacpe sequences 2461 view change/zero scrollback escape sequences
2263 locale switching escape sequence 2462 locale switching escape sequence
2264 window op and some xterm/OSC escape sequences 2463 window op and some xterm/OSC escape sequences
2265 rectangular selections 2464 rectangular selections
2266 trailing space removal for selections 2465 trailing space removal for selections
2267 verbose X error handling 2466 verbose X error handling
2268 2467
2269=item --enable-iso14755 (default: on) 2468=item --enable-iso14755 (default: on)
2270 2469
2271Enable extended ISO 14755 support (see @@RXVT_NAME@@(1), or 2470Enable extended ISO 14755 support (see @@RXVT_NAME@@(1)).
2272F<doc/rxvt.1.txt>). Basic support (section 5.1) is enabled by 2471Basic support (section 5.1) is enabled by C<--enable-frills>, while
2273C<--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.
2274this switch.
2275 2473
2276=item --enable-keepscrolling (default: on) 2474=item --enable-keepscrolling (default: on)
2277 2475
2278Add support for continual scrolling of the display when you hold 2476Add support for continual scrolling of the display when you hold
2279the 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.
2280 2483
2281=item --enable-mousewheel (default: on) 2484=item --enable-mousewheel (default: on)
2282 2485
2283Add support for scrolling via mouse wheel or buttons 4 & 5. 2486Add support for scrolling via mouse wheel or buttons 4 & 5.
2284 2487
2286 2489
2287Add support for continual scrolling (using the mouse wheel as an 2490Add support for continual scrolling (using the mouse wheel as an
2288accelerator) while the control key is held down. This option 2491accelerator) while the control key is held down. This option
2289requires --enable-mousewheel to also be specified. 2492requires --enable-mousewheel to also be specified.
2290 2493
2291=item --disable-new-selection
2292
2293Remove support for mouse selection style like that of xterm.
2294
2295=item --enable-dmalloc (default: off)
2296
2297Use Gray Watson's malloc - which is good for debugging See
2298L<http://www.letters.com/dmalloc/> for details If you use either this or the
2299next option, you may need to edit src/Makefile after compiling to point
2300DINCLUDE and DLIB to the right places.
2301
2302You can only use either this option and the following (should
2303you use either) .
2304
2305=item --enable-dlmalloc (default: off)
2306
2307Use Doug Lea's malloc - which is good for a production version
2308See L<http://g.oswego.edu/dl/html/malloc.html> for details.
2309
2310=item --enable-smart-resize (default: on) 2494=item --enable-smart-resize (default: off)
2311 2495
2312Add smart growth/shrink behaviour when changing font size via hot 2496Add smart growth/shrink behaviour when resizing.
2313keys. 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
2314the screen in a fixed position. 2498the screen in a fixed position.
2315 2499
2500=item --enable-text-blink (default: on)
2501
2502Add support for blinking text.
2503
2316=item --enable-pointer-blank (default: on) 2504=item --enable-pointer-blank (default: on)
2317 2505
2318Add support to have the pointer disappear when typing or inactive. 2506Add support to have the pointer disappear when typing or inactive.
2319 2507
2320=item --enable-perl (default: on) 2508=item --enable-perl (default: on)
2321 2509
2322Enable an embedded perl interpreter. See the B<@@RXVT_NAME@@perl(3)> 2510Enable an embedded perl interpreter. See the B<@@RXVT_NAME@@perl(3)>
2323manpage (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/>
2324in F<src/perl-ext/> for the extensions that are installed by default. The 2512for the extensions that are installed by default.
2325perl 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>
2326variable 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.
2327 2522
2328=item --with-name=NAME (default: urxvt) 2523=item --with-name=NAME (default: urxvt)
2329 2524
2330Set the basename for the installed binaries, resulting 2525Set the basename for the installed binaries, resulting
2331in 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
2341PATH. 2536PATH.
2342 2537
2343=item --with-x 2538=item --with-x
2344 2539
2345Use the X Window System (pretty much default, eh?). 2540Use the X Window System (pretty much default, eh?).
2346
2347=item --with-xpm-includes=DIR
2348
2349Look for the XPM includes in DIR.
2350
2351=item --with-xpm-library=DIR
2352
2353Look for the XPM library in DIR.
2354
2355=item --with-xpm
2356
2357Not needed - define via --enable-xpm-background.
2358 2541
2359=back 2542=back
2360 2543
2361=head1 AUTHORS 2544=head1 AUTHORS
2362 2545

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines