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.143 by ayin, Thu Aug 2 00:09:54 2007 UTC vs.
Revision 1.183 by sf-exg, Thu Apr 1 08:10:22 2010 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/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
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
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
538rxvt-unicode will continue without an input method. 558rxvt-unicode will continue without an input method.
539 559
540In this case either do not specify a B<preeditStyle> or specify more than 560In this case either do not specify a B<preeditStyle> or specify more than
541one pre-edit style, such as B<OverTheSpot,Root,None>. 561one pre-edit style, such as B<OverTheSpot,Root,None>.
542 562
563If it still doesn't work, then maybe your input method doesn't support
564compose sequences - to fall back to the built-in one, make sure you don't
565specify an input method via C<-im> or C<XMODIFIERS>.
566
543=head3 I cannot type C<Ctrl-Shift-2> to get an ASCII NUL character due to ISO 14755 567=head3 I cannot type C<Ctrl-Shift-2> to get an ASCII NUL character due to ISO 14755
544 568
545Either try C<Ctrl-2> alone (it often is mapped to ASCII NUL even on 569Either try C<Ctrl-2> alone (it often is mapped to ASCII NUL even on
546international keyboards) or simply use ISO 14755 support to your 570international keyboards) or simply use ISO 14755 support to your
547advantage, typing <Ctrl-Shift-0> to get a ASCII NUL. This works for other 571advantage, typing <Ctrl-Shift-0> to get a ASCII NUL. This works for other
604key has been assigned an escape sequence to match the vt100 for Execute 628key has been assigned an escape sequence to match the vt100 for Execute
605(C<ESC [ 3 ~>) and is in the supplied termcap/terminfo. 629(C<ESC [ 3 ~>) and is in the supplied termcap/terminfo.
606 630
607Some other Backspace problems: 631Some other Backspace problems:
608 632
609some editors use termcap/terminfo, 633some editors use termcap/terminfo,
610some editors (vim I'm told) expect Backspace = ^H, 634some editors (vim I'm told) expect Backspace = ^H,
611GNU Emacs (and Emacs-like editors) use ^H for help. 635GNU Emacs (and Emacs-like editors) use ^H for help.
612 636
613Perhaps someday this will all be resolved in a consistent manner. 637Perhaps someday this will all be resolved in a consistent manner.
614 638
655Rather than have rxvt-unicode try to accommodate all the various possible 679Rather than have rxvt-unicode try to accommodate all the various possible
656keyboard mappings, it is better to use `xmodmap' to remap the keys as 680keyboard mappings, it is better to use `xmodmap' to remap the keys as
657required for your particular machine. 681required for your particular machine.
658 682
659 683
660
661=head2 Terminal Configuration 684=head2 Terminal Configuration
662 685
663=head3 Can I see a typical configuration? 686=head3 Can I see a typical configuration?
664 687
665The default configuration tries to be xterm-like, which I don't like that 688The default configuration tries to be xterm-like, which I don't like that
695develop for myself mostly, so I actually use most of the extensions I 718develop for myself mostly, so I actually use most of the extensions I
696write. 719write.
697 720
698The selection stuff mainly makes the selection perl-error-message aware 721The selection stuff mainly makes the selection perl-error-message aware
699and tells it to convert perl error messages into vi-commands to load the 722and tells it to convert perl error messages into vi-commands to load the
700relevant file and go tot he error line number. 723relevant file and go to the error line number.
701 724
702 URxvt.scrollstyle: plain 725 URxvt.scrollstyle: plain
703 URxvt.secondaryScroll: true 726 URxvt.secondaryScroll: true
704 727
705As the documentation says: plain is the preferred scrollbar for the 728As the documentation says: plain is the preferred scrollbar for the
777purposes, it works, and gives a different look, as my normal (Non-bold) 800purposes, it works, and gives a different look, as my normal (Non-bold)
778font is already bold, and I want to see a difference between bold and 801font is already bold, and I want to see a difference between bold and
779normal fonts. 802normal fonts.
780 803
781Please note that I used the C<urxvt> instance name and not the C<URxvt> 804Please note that I used the C<urxvt> instance name and not the C<URxvt>
782class name. Thats because I use different configs for different purposes, 805class name. That is because I use different configs for different purposes,
783for example, my IRC window is started with C<-name IRC>, and uses these 806for example, my IRC window is started with C<-name IRC>, and uses these
784defaults: 807defaults:
785 808
786 IRC*title: IRC 809 IRC*title: IRC
787 IRC*geometry: 87x12+535+542 810 IRC*geometry: 87x12+535+542
791 IRC*boldFont: suxuseuro 814 IRC*boldFont: suxuseuro
792 IRC*colorBD: white 815 IRC*colorBD: white
793 IRC*keysym.M-C-1: command:\033]710;suxuseuro\007\033]711;suxuseuro\007 816 IRC*keysym.M-C-1: command:\033]710;suxuseuro\007\033]711;suxuseuro\007
794 IRC*keysym.M-C-2: command:\033]710;9x15bold\007\033]711;9x15bold\007 817 IRC*keysym.M-C-2: command:\033]710;9x15bold\007\033]711;9x15bold\007
795 818
796C<Alt-Shift-1> and C<Alt-Shift-2> switch between two different font 819C<Alt-Ctrl-1> and C<Alt-Ctrl-2> switch between two different font
797sizes. C<suxuseuro> allows me to keep an eye (and actually read) 820sizes. C<suxuseuro> allows me to keep an eye (and actually read)
798stuff while keeping a very small window. If somebody pastes something 821stuff while keeping a very small window. If somebody pastes something
799complicated (e.g. japanese), I temporarily switch to a larger font. 822complicated (e.g. japanese), I temporarily switch to a larger font.
800 823
801The above is all in my C<.Xdefaults> (I don't use C<.Xresources> nor 824The above is all in my C<.Xdefaults> (I don't use C<.Xresources> nor
838 861
839The terminal description used by rxvt-unicode is not as widely available 862The terminal description used by rxvt-unicode is not as widely available
840as that for xterm, or even rxvt (for which the same problem often arises). 863as that for xterm, or even rxvt (for which the same problem often arises).
841 864
842The correct solution for this problem is to install the terminfo, this can 865The correct solution for this problem is to install the terminfo, this can
843be done like this (with ncurses' infocmp and works as user and admin): 866be done by simply installing rxvt-unicode on the remote system as well
867(in case you have a nice package manager ready), or you can install the
868terminfo database manually like this (with ncurses infocmp. works as
869user and root):
844 870
845 REMOTE=remotesystem.domain 871 REMOTE=remotesystem.domain
846 infocmp rxvt-unicode | ssh $REMOTE "mkdir -p .terminfo && cat >/tmp/ti && tic /tmp/ti" 872 infocmp rxvt-unicode | ssh $REMOTE "mkdir -p .terminfo && cat >/tmp/ti && tic /tmp/ti"
847
848... or by installing rxvt-unicode normally on the remote system,
849 873
850One some systems you might need to set C<$TERMINFO> to the full path of 874One some systems you might need to set C<$TERMINFO> to the full path of
851F<$HOME/.terminfo> for this to work. 875F<$HOME/.terminfo> for this to work.
852 876
853If you cannot or do not want to do this, then you can simply set 877If you cannot or do not want to do this, then you can simply set
863 URxvt.termName: rxvt 887 URxvt.termName: rxvt
864 888
865If you don't plan to use B<rxvt> (quite common...) you could also replace 889If you don't plan to use B<rxvt> (quite common...) you could also replace
866the rxvt terminfo file with the rxvt-unicode one and use C<TERM=rxvt>. 890the rxvt terminfo file with the rxvt-unicode one and use C<TERM=rxvt>.
867 891
892=head3 nano fails with "Error opening terminal: rxvt-unicode"
893
894This exceptionally confusing and useless error message is printed by nano
895when it can't find the terminfo database. Nothing is wrong with your
896terminal, read the previous answer for a solution.
897
868=head3 C<tic> outputs some error when compiling the terminfo entry. 898=head3 C<tic> outputs some error when compiling the terminfo entry.
869 899
870Most likely it's the empty definition for C<enacs=>. Just replace it by 900Most likely it's the empty definition for C<enacs=>. Just replace it by
871C<enacs=\E[0@> and try again. 901C<enacs=\E[0@> and try again.
872 902
885You can also create a termcap entry by using terminfo's infocmp program 915You can also create a termcap entry by using terminfo's infocmp program
886like this: 916like this:
887 917
888 infocmp -C rxvt-unicode 918 infocmp -C rxvt-unicode
889 919
890Or you could use this termcap entry, generated by the command above: 920Or you could use the termcap entry in doc/etc/rxvt-unicode.termcap,
891 921generated by the command above.
892 rxvt-unicode|rxvt-unicode terminal (X Window System):\
893 :am:bw:eo:km:mi:ms:xn:xo:\
894 :co#80:it#8:li#24:lm#0:\
895 :AL=\E[%dL:DC=\E[%dP:DL=\E[%dM:DO=\E[%dB:IC=\E[%d@:\
896 :K1=\EOw:K2=\EOu:K3=\EOy:K4=\EOq:K5=\EOs:LE=\E[%dD:\
897 :RI=\E[%dC:SF=\E[%dS:SR=\E[%dT:UP=\E[%dA:ae=\E(B:al=\E[L:\
898 :as=\E(0:bl=^G:cd=\E[J:ce=\E[K:cl=\E[H\E[2J:\
899 :cm=\E[%i%d;%dH:cr=^M:cs=\E[%i%d;%dr:ct=\E[3g:dc=\E[P:\
900 :dl=\E[M:do=^J:ec=\E[%dX:ei=\E[4l:ho=\E[H:\
901 :i1=\E[?47l\E=\E[?1l:ic=\E[@:im=\E[4h:\
902 :is=\E[r\E[m\E[2J\E[H\E[?7h\E[?1;3;4;6l\E[4l:\
903 :k1=\E[11~:k2=\E[12~:k3=\E[13~:k4=\E[14~:k5=\E[15~:\
904 :k6=\E[17~:k7=\E[18~:k8=\E[19~:k9=\E[20~:kD=\E[3~:\
905 :kI=\E[2~:kN=\E[6~:kP=\E[5~:kb=\177:kd=\EOB:ke=\E[?1l\E>:\
906 :kh=\E[7~:kl=\EOD:kr=\EOC:ks=\E[?1h\E=:ku=\EOA:le=^H:\
907 :mb=\E[5m:md=\E[1m:me=\E[m\017:mr=\E[7m:nd=\E[C:rc=\E8:\
908 :sc=\E7:se=\E[27m:sf=^J:so=\E[7m:sr=\EM:st=\EH:ta=^I:\
909 :te=\E[r\E[?1049l:ti=\E[?1049h:ue=\E[24m:up=\E[A:\
910 :us=\E[4m:vb=\E[?5h\E[?5l:ve=\E[?25h:vi=\E[?25l:\
911 :vs=\E[?25h:
912 922
913=head3 Why does C<ls> no longer have coloured output? 923=head3 Why does C<ls> no longer have coloured output?
914 924
915The C<ls> in the GNU coreutils unfortunately doesn't use terminfo to 925The C<ls> in the GNU coreutils unfortunately doesn't use terminfo to
916decide whether a terminal has colour, but uses its own configuration 926decide whether a terminal has colour, but uses its own configuration
1068C<@im=kinput2>. For B<scim>, use C<@im=SCIM>. You can see what input 1078C<@im=kinput2>. For B<scim>, use C<@im=SCIM>. You can see what input
1069method servers are running with this command: 1079method servers are running with this command:
1070 1080
1071 xprop -root XIM_SERVERS 1081 xprop -root XIM_SERVERS
1072 1082
1073=item 1083=item
1074 1084
1075=back 1085=back
1076 1086
1077=head3 My input method wants <some encoding> but I want UTF-8, what can I do? 1087=head3 My input method wants <some encoding> but I want UTF-8, what can I do?
1078 1088
1123runtime-switchable, too, so there is usually no drawback to enabling them, 1133runtime-switchable, too, so there is usually no drawback to enabling them,
1124except higher disk and possibly memory usage. The perl interpreter should 1134except higher disk and possibly memory usage. The perl interpreter should
1125be enabled, as important functionality (menus, selection, likely more in 1135be enabled, as important functionality (menus, selection, likely more in
1126the future) depends on it. 1136the future) depends on it.
1127 1137
1128You should not overwrite the C<perl-ext-common> snd C<perl-ext> resources 1138You should not overwrite the C<perl-ext-common> and C<perl-ext> resources
1129system-wide (except maybe with C<defaults>). This will result in useful 1139system-wide (except maybe with C<defaults>). This will result in useful
1130behaviour. If your distribution aims at low memory, add an empty 1140behaviour. If your distribution aims at low memory, add an empty
1131C<perl-ext-common> resource to the app-defaults file. This will keep the 1141C<perl-ext-common> resource to the app-defaults file. This will keep the
1132perl interpreter disabled until the user enables it. 1142perl interpreter disabled until the user enables it.
1133 1143
1163As you might have guessed, FreeBSD does neither define this symbol nor 1173As you might have guessed, FreeBSD does neither define this symbol nor
1164does it support it. Instead, it uses its own internal representation of 1174does it support it. Instead, it uses its own internal representation of
1165B<wchar_t>. This is, of course, completely fine with respect to standards. 1175B<wchar_t>. This is, of course, completely fine with respect to standards.
1166 1176
1167However, that means rxvt-unicode only works in C<POSIX>, C<ISO-8859-1> and 1177However, that means rxvt-unicode only works in C<POSIX>, C<ISO-8859-1> and
1168C<UTF-8> locales under FreeBSD (which all use Unicode as B<wchar_t>. 1178C<UTF-8> locales under FreeBSD (which all use Unicode as B<wchar_t>).
1169 1179
1170C<__STDC_ISO_10646__> is the only sane way to support multi-language 1180C<__STDC_ISO_10646__> is the only sane way to support multi-language
1171apps in an OS, as using a locale-dependent (and non-standardized) 1181apps in an OS, as using a locale-dependent (and non-standardized)
1172representation of B<wchar_t> makes it impossible to convert between 1182representation of B<wchar_t> makes it impossible to convert between
1173B<wchar_t> (as used by X11 and your applications) and any other encoding 1183B<wchar_t> (as used by X11 and your applications) and any other encoding
1317 1327
1318=item B<< C<ESC => >> 1328=item B<< C<ESC => >>
1319 1329
1320Application Keypad (SMKX). See also next sequence. 1330Application Keypad (SMKX). See also next sequence.
1321 1331
1322=item B<<< C<< ESC >> >>> 1332=item B<<< C<< ESC > >> >>>
1323 1333
1324Normal Keypad (RMKX) 1334Normal Keypad (RMKX)
1325 1335
1326B<Note:> If the numeric keypad is activated, eg, B<Num_Lock> has been 1336B<Note:> If the numeric keypad is activated, eg, B<Num_Lock> has been
1327pressed, numbers or control functions are generated by the numeric keypad 1337pressed, numbers or control functions are generated by the numeric keypad
1470=begin table 1480=begin table
1471 1481
1472 B<< C<Ps = 0> >> Clear to Right (default) 1482 B<< C<Ps = 0> >> Clear to Right (default)
1473 B<< C<Ps = 1> >> Clear to Left 1483 B<< C<Ps = 1> >> Clear to Left
1474 B<< C<Ps = 2> >> Clear All 1484 B<< C<Ps = 2> >> Clear All
1485 B<< C<Ps = 3> >> Like Ps = 0, but is ignored when wrapped
1486 (@@RXVT_NAME@@ extension)
1475 1487
1476=end table 1488=end table
1477 1489
1478=item B<< C<ESC [ Ps L> >> 1490=item B<< C<ESC [ Ps L> >>
1479 1491
1805 1817
1806=item B<< C<Pm = 30> >> 1818=item B<< C<Pm = 30> >>
1807 1819
1808=begin table 1820=begin table
1809 1821
1810 B<< C<h> >> scrollBar visisble 1822 B<< C<h> >> scrollBar visible
1811 B<< C<l> >> scrollBar invisisble 1823 B<< C<l> >> scrollBar invisible
1812 1824
1813=end table 1825=end table
1814 1826
1815=item B<< C<Pm = 35> >> (B<rxvt>) 1827=item B<< C<Pm = 35> >> (B<rxvt>)
1816 1828
1899 B<< C<h> >> Use Hilite Mouse Tracking. 1911 B<< C<h> >> Use Hilite Mouse Tracking.
1900 B<< C<l> >> No mouse reporting. 1912 B<< C<l> >> No mouse reporting.
1901 1913
1902=end table 1914=end table
1903 1915
1916=item B<< C<Pm = 1002> >> (X11 XTerm)
1917
1918=begin table
1919
1920 B<< C<h> >> Send Mouse X & Y on button press and release, and motion with a button pressed.
1921 B<< C<l> >> No mouse reporting.
1922
1923=end table
1924
1925=item B<< C<Pm = 1003> >> (X11 XTerm)
1926
1927=begin table
1928
1929 B<< C<h> >> Send Mouse X & Y on button press and release, and motion.
1930 B<< C<l> >> No mouse reporting.
1931
1932=end table
1933
1904=item B<< C<Pm = 1010> >> (B<rxvt>) 1934=item B<< C<Pm = 1010> >> (B<rxvt>)
1905 1935
1906=begin table 1936=begin table
1907 1937
1908 B<< C<h> >> Don't scroll to bottom on TTY output 1938 B<< C<h> >> Don't scroll to bottom on TTY output
1950 1980
1951=begin table 1981=begin table
1952 1982
1953 B<< C<h> >> Use Alternate Screen Buffer - clear Alternate Screen Buffer if switching to it 1983 B<< C<h> >> Use Alternate Screen Buffer - clear Alternate Screen Buffer if switching to it
1954 B<< C<l> >> Use Normal Screen Buffer 1984 B<< C<l> >> Use Normal Screen Buffer
1985
1986=end table
1987
1988=item B<< C<Pm = 2004> >>
1989
1990=begin table
1991
1992 B<< C<h> >> Enable bracketed paste mode - prepend / append to the pasted text the control sequences C<ESC [ 200 ~> / C<ESC [ 201 ~>
1993 B<< C<l> >> Disable bracketed paste mode
1955 1994
1956=end table 1995=end table
1957 1996
1958=back 1997=back
1959 1998
1976 B<< C<Ps = 0> >> Change Icon Name and Window Title to B<< C<Pt> >> 2015 B<< C<Ps = 0> >> Change Icon Name and Window Title to B<< C<Pt> >>
1977 B<< C<Ps = 1> >> Change Icon Name to B<< C<Pt> >> 2016 B<< C<Ps = 1> >> Change Icon Name to B<< C<Pt> >>
1978 B<< C<Ps = 2> >> Change Window Title to B<< C<Pt> >> 2017 B<< C<Ps = 2> >> Change Window Title to B<< C<Pt> >>
1979 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. 2018 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.
1980 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 2019 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
1981 B<< C<Ps = 10> >> Change colour of text foreground to B<< C<Pt> >> B<(NB: may change in future)> 2020 B<< C<Ps = 10> >> Change colour of text foreground to B<< C<Pt> >>
1982 B<< C<Ps = 11> >> Change colour of text background to B<< C<Pt> >> B<(NB: may change in future)> 2021 B<< C<Ps = 11> >> Change colour of text background to B<< C<Pt> >>
1983 B<< C<Ps = 12> >> Change colour of text cursor foreground to B<< C<Pt> >> 2022 B<< C<Ps = 12> >> Change colour of text cursor foreground to B<< C<Pt> >>
1984 B<< C<Ps = 13> >> Change colour of mouse foreground to B<< C<Pt> >> 2023 B<< C<Ps = 13> >> Change colour of mouse foreground to B<< C<Pt> >>
1985 B<< C<Ps = 17> >> Change colour of highlight characters to B<< C<Pt> >> 2024 B<< C<Ps = 17> >> Change colour of highlight characters to B<< C<Pt> >>
1986 B<< C<Ps = 18> >> Change colour of bold characters to B<< C<Pt> >> [deprecated, see 706] 2025 B<< C<Ps = 18> >> Change colour of bold characters to B<< C<Pt> >> [deprecated, see 706]
1987 B<< C<Ps = 19> >> Change colour of underlined characters to B<< C<Pt> >> [deprecated, see 707] 2026 B<< C<Ps = 19> >> Change colour of underlined characters to B<< C<Pt> >> [deprecated, see 707]
1988 B<< C<Ps = 20> >> Change background pixmap parameters (see section XPM) (Compile XPM). 2027 B<< C<Ps = 20> >> Change background pixmap parameters (see section BACKGROUND IMAGE) (Compile AfterImage).
1989 B<< C<Ps = 39> >> Change default foreground colour to B<< C<Pt> >>. 2028 B<< C<Ps = 39> >> Change default foreground colour to B<< C<Pt> >>. [deprecated, use 10]
1990 B<< C<Ps = 46> >> Change Log File to B<< C<Pt> >> I<unimplemented> 2029 B<< C<Ps = 46> >> Change Log File to B<< C<Pt> >> I<unimplemented>
1991 B<< C<Ps = 49> >> Change default background colour to B<< C<Pt> >>. 2030 B<< C<Ps = 49> >> Change default background colour to B<< C<Pt> >>. [deprecated, use 11]
1992 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> >> 2031 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> >>
1993 B<< C<Ps = 55> >> Log all scrollback buffer and all of screen to B<< C<Pt> >> 2032 B<< C<Ps = 55> >> Log all scrollback buffer and all of screen to B<< C<Pt> >> [disabled]
1994 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). 2033 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).
1995 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>. 2034 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>.
1996 B<< C<Ps = 704> >> Change colour of italic characters to B<< C<Pt> >> 2035 B<< C<Ps = 704> >> Change colour of italic characters to B<< C<Pt> >>
1997 B<< C<Ps = 705> >> Change background pixmap tint colour to B<< C<Pt> >> (Compile transparency). 2036 B<< C<Ps = 705> >> Change background pixmap tint colour to B<< C<Pt> >> (Compile transparency).
1998 B<< C<Ps = 706> >> Change colour of bold characters to B<< C<Pt> >> 2037 B<< C<Ps = 706> >> Change colour of bold characters to B<< C<Pt> >>
1999 B<< C<Ps = 707> >> Change colour of underlined characters to B<< C<Pt> >> 2038 B<< C<Ps = 707> >> Change colour of underlined characters to B<< C<Pt> >>
2039 B<< C<Ps = 708> >> Change colour of the border to B<< C<Pt> >>
2000 B<< C<Ps = 710> >> Set normal fontset to B<< C<Pt> >>. Same as C<Ps = 50>. 2040 B<< C<Ps = 710> >> Set normal fontset to B<< C<Pt> >>. Same as C<Ps = 50>.
2001 B<< C<Ps = 711> >> Set bold fontset to B<< C<Pt> >>. Similar to C<Ps = 50> (Compile styles). 2041 B<< C<Ps = 711> >> Set bold fontset to B<< C<Pt> >>. Similar to C<Ps = 50> (Compile styles).
2002 B<< C<Ps = 712> >> Set italic fontset to B<< C<Pt> >>. Similar to C<Ps = 50> (Compile styles). 2042 B<< C<Ps = 712> >> Set italic fontset to B<< C<Pt> >>. Similar to C<Ps = 50> (Compile styles).
2003 B<< C<Ps = 713> >> Set bold-italic fontset to B<< C<Pt> >>. Similar to C<Ps = 50> (Compile styles). 2043 B<< C<Ps = 713> >> Set bold-italic fontset to B<< C<Pt> >>. Similar to C<Ps = 50> (Compile styles).
2004 B<< C<Ps = 720> >> Move viewing window up by B<< C<Pt> >> lines, or clear scrollback buffer if C<Pt = 0> (Compile frills). 2044 B<< C<Ps = 720> >> Move viewing window up by B<< C<Pt> >> lines, or clear scrollback buffer if C<Pt = 0> (Compile frills).
2007 2047
2008=end table 2048=end table
2009 2049
2010=back 2050=back
2011 2051
2012=head1 XPM 2052=head1 BACKGROUND IMAGE
2013 2053
2014For the XPM XTerm escape sequence B<< C<ESC ] 20 ; Pt ST> >> then value 2054For the BACKGROUND IMAGE XTerm escape sequence B<< C<ESC ] 20 ; Pt ST> >> the value
2015of B<< C<Pt> >> can be the name of the background pixmap followed by a 2055of B<< C<Pt> >> can be the name of the background image file followed by a
2016sequence of scaling/positioning commands separated by semi-colons. The 2056sequence of scaling/positioning commands separated by semi-colons. The
2017scaling/positioning commands are as follows: 2057scaling/positioning commands are as follows:
2018 2058
2019=over 4 2059=over 4
2020 2060
2058 2098
2059For example: 2099For example:
2060 2100
2061=over 4 2101=over 4
2062 2102
2063=item B<\E]20;funky\a> 2103=item B<\E]20;funky.jpg\a>
2064 2104
2065load B<funky.xpm> as a tiled image 2105load B<funky.jpg> as a tiled image
2066 2106
2067=item B<\E]20;mona;100\a> 2107=item B<\E]20;mona.jpg;100\a>
2068 2108
2069load B<mona.xpm> with a scaling of 100% 2109load B<mona.jpg> with a scaling of 100%
2070 2110
2071=item B<\E]20;;200;?\a> 2111=item B<\E]20;;200;?\a>
2072 2112
2073rescale the current pixmap to 200% and display the image geometry in 2113rescale the current pixmap to 200% and display the image geometry in
2074the title 2114the title
2075 2115
2076=back 2116=back
2117
2077X<Mouse> 2118X<Mouse>
2078 2119
2079=head1 Mouse Reporting 2120=head1 Mouse Reporting
2080 2121
2081=over 4 2122=over 4
2122Col = B<< C<< <x> - SPACE >> >> 2163Col = B<< C<< <x> - SPACE >> >>
2123 2164
2124Row = B<< C<< <y> - SPACE >> >> 2165Row = B<< C<< <y> - SPACE >> >>
2125 2166
2126=back 2167=back
2168
2169=head1 Key Codes
2170
2127X<KeyCodes> 2171X<KeyCodes>
2128
2129=head1 Key Codes
2130 2172
2131Note: B<Shift> + B<F1>-B<F10> generates B<F11>-B<F20> 2173Note: B<Shift> + B<F1>-B<F10> generates B<F11>-B<F20>
2132 2174
2133For the keypad, use B<Shift> to temporarily override Application-Keypad 2175For the keypad, use B<Shift> to temporarily override Application-Keypad
2134setting use B<Num_Lock> to toggle Application-Keypad setting if 2176setting use B<Num_Lock> to toggle Application-Keypad setting if
2201 2243
2202=head1 CONFIGURE OPTIONS 2244=head1 CONFIGURE OPTIONS
2203 2245
2204General hint: if you get compile errors, then likely your configuration 2246General hint: if you get compile errors, then likely your configuration
2205hasn't been tested well. Either try with C<--enable-everything> or use 2247hasn't been tested well. Either try with C<--enable-everything> or use
2206the default configuration (i.e. C<--enable-xxx> or C<--disable-xxx>). Of 2248the default configuration (i.e. no C<--enable-xxx> or C<--disable-xxx>
2207course, you should always report when a combination doesn't work, so it 2249switches). Of course, you should always report when a combination doesn't
2208can be fixed. Marc Lehmann <rxvt@schmorp.de>. 2250work, so it can be fixed. Marc Lehmann <rxvt@schmorp.de>.
2209 2251
2210All 2252All
2211 2253
2212=over 4 2254=over 4
2213 2255
2214=item --enable-everything 2256=item --enable-everything
2215 2257
2216Add (or remove) support for all non-multichoice options listed in "./configure 2258Add (or remove) support for all non-multichoice options listed in
2217--help". 2259C<./configure --help>, except for C<--enable-assert>.
2218 2260
2219You can specify this and then disable options you do not like by 2261You can specify this and then disable options you do not like by
2220I<following> this with the appropriate C<--disable-...> arguments, 2262I<following> this with the appropriate C<--disable-...> arguments,
2221or you can start with a minimal configuration by specifying 2263or you can start with a minimal configuration by specifying
2222C<--disable-everything> and than adding just the C<--enable-...> arguments 2264C<--disable-everything> and than adding just the C<--enable-...> arguments
2223you want. 2265you want.
2266
2267=item --enable-256-color (default: off)
2268
2269Add support for 256 colors.
2224 2270
2225=item --enable-xft (default: enabled) 2271=item --enable-xft (default: enabled)
2226 2272
2227Add support for Xft (anti-aliases, among others) fonts. Xft fonts are 2273Add support for Xft (anti-aliases, among others) fonts. Xft fonts are
2228slower and require lots of memory, but as long as you don't use them, you 2274slower and require lots of memory, but as long as you don't use them, you
2277 2323
2278=item --enable-combining (default: on) 2324=item --enable-combining (default: on)
2279 2325
2280Enable automatic composition of combining characters into 2326Enable automatic composition of combining characters into
2281composite characters. This is required for proper viewing of text 2327composite characters. This is required for proper viewing of text
2282where accents are encoded as seperate unicode characters. This is 2328where accents are encoded as separate unicode characters. This is
2283done by using precomposited characters when available or creating 2329done by using precomposited characters when available or creating
2284new pseudo-characters when no precomposed form exists. 2330new pseudo-characters when no precomposed form exists.
2285 2331
2286Without --enable-unicode3, the number of additional precomposed 2332Without --enable-unicode3, the number of additional precomposed
2287characters is somewhat limited (the 6400 private use characters will be 2333characters is somewhat limited (the 6400 private use characters will be
2302=item --with-res-name=NAME (default: urxvt) 2348=item --with-res-name=NAME (default: urxvt)
2303 2349
2304Use the given name as default application name when 2350Use the given name as default application name when
2305reading resources. Specify --with-res-name=rxvt to replace rxvt. 2351reading resources. Specify --with-res-name=rxvt to replace rxvt.
2306 2352
2307=item --with-res-class=CLASS /default: URxvt) 2353=item --with-res-class=CLASS (default: URxvt)
2308 2354
2309Use the given class as default application class 2355Use the given class as default application class
2310when reading resources. Specify --with-res-class=Rxvt to replace 2356when reading resources. Specify --with-res-class=Rxvt to replace
2311rxvt. 2357rxvt.
2312 2358
2342to third-party libraries used by libAI). Memory footprint may somewhat be 2388to third-party libraries used by libAI). Memory footprint may somewhat be
2343lowered if libAfterImage is configured without support for SVG. 2389lowered if libAfterImage is configured without support for SVG.
2344 2390
2345=item --enable-transparency (default: on) 2391=item --enable-transparency (default: on)
2346 2392
2347Add support for inheriting parent backgrounds thus giving a fake 2393Add support for backgrounds, creating illusion of transparency in the term.
2348transparency to the term.
2349 2394
2350=item --enable-fading (default: on) 2395=item --enable-fading (default: on)
2351 2396
2352Add support for fading the text when focus is lost. 2397Add support for fading the text when focus is lost.
2353 2398
2354=item --enable-tinting (default: on)
2355
2356Add support for tinting of transparent backgrounds (requires C<--enable-transparency>).
2357
2358=item --enable-rxvt-scroll (default: on) 2399=item --enable-rxvt-scroll (default: on)
2359 2400
2360Add support for the original rxvt scrollbar. 2401Add support for the original rxvt scrollbar.
2361 2402
2362=item --enable-next-scroll (default: on) 2403=item --enable-next-scroll (default: on)
2364Add support for a NeXT-like scrollbar. 2405Add support for a NeXT-like scrollbar.
2365 2406
2366=item --enable-xterm-scroll (default: on) 2407=item --enable-xterm-scroll (default: on)
2367 2408
2368Add support for an Xterm-like scrollbar. 2409Add support for an Xterm-like scrollbar.
2369
2370=item --enable-plain-scroll (default: on)
2371
2372Add support for a very unobtrusive, plain-looking scrollbar that
2373is the favourite of the rxvt-unicode author, having used it for
2374many years.
2375
2376=item --enable-ttygid (default: off)
2377
2378Change tty device setting to group "tty" - only use this if
2379your system uses this type of security.
2380 2410
2381=item --disable-backspace-key 2411=item --disable-backspace-key
2382 2412
2383Removes any handling of the backspace key by us - let the X server do it. 2413Removes any handling of the backspace key by us - let the X server do it.
2384 2414
2405in combination with other switches) is: 2435in combination with other switches) is:
2406 2436
2407 MWM-hints 2437 MWM-hints
2408 EWMH-hints (pid, utf8 names) and protocols (ping) 2438 EWMH-hints (pid, utf8 names) and protocols (ping)
2409 urgency hint 2439 urgency hint
2410 seperate underline colour (-underlineColor) 2440 separate underline colour (-underlineColor)
2411 settable border widths and borderless switch (-w, -b, -bl) 2441 settable border widths and borderless switch (-w, -b, -bl)
2412 visual depth selection (-depth) 2442 visual depth selection (-depth)
2413 settable extra linespacing /-lsp) 2443 settable extra linespacing /-lsp)
2414 iso-14755 5.1 (basic) support 2444 iso-14755 5.1 (basic) support
2415 tripleclickwords (-tcw) 2445 tripleclickwords (-tcw)
2416 settable insecure mode (-insecure) 2446 settable insecure mode (-insecure)
2417 keysym remapping support 2447 keysym remapping support
2418 cursor blinking and underline cursor (-cb, -uc) 2448 cursor blinking and underline cursor (-bc, -uc)
2419 XEmbed support (-embed) 2449 XEmbed support (-embed)
2420 user-pty (-pty-fd) 2450 user-pty (-pty-fd)
2421 hold on exit (-hold) 2451 hold on exit (-hold)
2452 compile in built-in block graphics
2422 skip builtin block graphics (-sbg) 2453 skip builtin block graphics (-sbg)
2423 separate highlightcolor support (-hc) 2454 separate highlightcolor support (-hc)
2424 2455
2425It also enables some non-essential features otherwise disabled, such as: 2456It also enables some non-essential features otherwise disabled, such as:
2426 2457
2436 trailing space removal for selections 2467 trailing space removal for selections
2437 verbose X error handling 2468 verbose X error handling
2438 2469
2439=item --enable-iso14755 (default: on) 2470=item --enable-iso14755 (default: on)
2440 2471
2441Enable extended ISO 14755 support (see @@RXVT_NAME@@(1), or 2472Enable extended ISO 14755 support (see @@RXVT_NAME@@(1)).
2442F<doc/rxvt.1.txt>). Basic support (section 5.1) is enabled by 2473Basic support (section 5.1) is enabled by C<--enable-frills>, while
2443C<--enable-frills>, while support for 5.2, 5.3 and 5.4 is enabled with 2474support for 5.2, 5.3 and 5.4 is enabled with this switch.
2444this switch.
2445 2475
2446=item --enable-keepscrolling (default: on) 2476=item --enable-keepscrolling (default: on)
2447 2477
2448Add support for continual scrolling of the display when you hold 2478Add support for continual scrolling of the display when you hold
2449the mouse button down on a scrollbar arrow. 2479the mouse button down on a scrollbar arrow.
2467 2497
2468Add smart growth/shrink behaviour when resizing. 2498Add smart growth/shrink behaviour when resizing.
2469This should keep the window corner which is closest to a corner of 2499This should keep the window corner which is closest to a corner of
2470the screen in a fixed position. 2500the screen in a fixed position.
2471 2501
2502=item --enable-text-blink (default: on)
2503
2504Add support for blinking text.
2505
2472=item --enable-pointer-blank (default: on) 2506=item --enable-pointer-blank (default: on)
2473 2507
2474Add support to have the pointer disappear when typing or inactive. 2508Add support to have the pointer disappear when typing or inactive.
2475 2509
2476=item --enable-perl (default: on) 2510=item --enable-perl (default: on)
2477 2511
2478Enable an embedded perl interpreter. See the B<@@RXVT_NAME@@perl(3)> 2512Enable an embedded perl interpreter. See the B<@@RXVT_NAME@@perl(3)>
2479manpage (F<doc/rxvtperl.txt>) for more info on this feature, or the 2513manpage for more info on this feature, or the files in F<src/perl/>
2480files in F<src/perl-ext/> for the extensions that are installed by 2514for the extensions that are installed by default.
2481default. The perl interpreter that is used can be specified via the 2515The perl interpreter that is used can be specified via the C<PERL>
2482C<PERL> environment variable when running configure. Even when compiled 2516environment variable when running configure. Even when compiled in,
2483in, perl will I<not> be initialised when all extensions have been disabled 2517perl will I<not> be initialised when all extensions have been disabled
2484C<-pe "" --perl-ext-common "">, so it should be safe to enable from a 2518C<-pe "" --perl-ext-common "">, so it should be safe to enable from a
2485resource standpoint. 2519resource standpoint.
2520
2521=item --enable-assert (default: off)
2522
2523Enables the assertions in the code, normally disabled. This switch is only
2524useful when developing rxvt-unicode.
2486 2525
2487=item --with-afterimage-config=DIR 2526=item --with-afterimage-config=DIR
2488 2527
2489Look for the libAfterImage config script in DIR. 2528Look for the libAfterImage config script in DIR.
2490 2529

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines