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.134 by ayin, Sun Jun 24 23:13:21 2007 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/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
… …
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
662 681
663=head3 Can I see a typical configuration? 682=head3 Can I see a typical configuration?
664 683
665The default configuration tries to be xterm-like, which I don't like that 684The default configuration tries to be xterm-like, which I don't like that
… …
791 IRC*boldFont: suxuseuro 810 IRC*boldFont: suxuseuro
792 IRC*colorBD: white 811 IRC*colorBD: white
793 IRC*keysym.M-C-1: command:\033]710;suxuseuro\007\033]711;suxuseuro\007 812 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 813 IRC*keysym.M-C-2: command:\033]710;9x15bold\007\033]711;9x15bold\007
795 814
796C<Alt-Shift-1> and C<Alt-Shift-2> switch between two different font 815C<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) 816sizes. C<suxuseuro> allows me to keep an eye (and actually read)
798stuff while keeping a very small window. If somebody pastes something 817stuff while keeping a very small window. If somebody pastes something
799complicated (e.g. japanese), I temporarily switch to a larger font. 818complicated (e.g. japanese), I temporarily switch to a larger font.
800 819
801The above is all in my C<.Xdefaults> (I don't use C<.Xresources> nor 820The above is all in my C<.Xdefaults> (I don't use C<.Xresources> nor
… …
838 857
839The terminal description used by rxvt-unicode is not as widely available 858The 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). 859as that for xterm, or even rxvt (for which the same problem often arises).
841 860
842The 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
843be done like this (with ncurses' infocmp and works as user and admin): 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):
844 866
845 REMOTE=remotesystem.domain 867 REMOTE=remotesystem.domain
846 infocmp rxvt-unicode | ssh $REMOTE "mkdir -p .terminfo && cat >/tmp/ti && tic /tmp/ti" 868 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 869
850One some systems you might need to set C<$TERMINFO> to the full path of 870One some systems you might need to set C<$TERMINFO> to the full path of
851F<$HOME/.terminfo> for this to work. 871F<$HOME/.terminfo> for this to work.
852 872
853If 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
… …
863 URxvt.termName: rxvt 883 URxvt.termName: rxvt
864 884
865If 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
866the 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>.
867 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
868=head3 C<tic> outputs some error when compiling the terminfo entry. 894=head3 C<tic> outputs some error when compiling the terminfo entry.
869 895
870Most 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
871C<enacs=\E[0@> and try again. 897C<enacs=\E[0@> and try again.
872 898
… …
885You 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
886like this: 912like this:
887 913
888 infocmp -C rxvt-unicode 914 infocmp -C rxvt-unicode
889 915
890Or you could use this termcap entry, generated by the command above: 916Or you could use the termcap entry in doc/etc/rxvt-unicode.termcap,
891 917generated 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 918
913=head3 Why does C<ls> no longer have coloured output? 919=head3 Why does C<ls> no longer have coloured output?
914 920
915The 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
916decide whether a terminal has colour, but uses its own configuration 922decide 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 1074C<@im=kinput2>. For B<scim>, use C<@im=SCIM>. You can see what input
1069method servers are running with this command: 1075method servers are running with this command:
1070 1076
1071 xprop -root XIM_SERVERS 1077 xprop -root XIM_SERVERS
1072 1078
1073=item 1079=item
1074 1080
1075=back 1081=back
1076 1082
1077=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?
1078 1084
… …
1151This 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
1152and reduces possible bugs to initialisation code run before main(), or 1158and reduces possible bugs to initialisation code run before main(), or
1153things 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
1154little risk. 1160little risk.
1155 1161
1156=head3 On Solaris 9, many line-drawing characters are too wide.
1157
1158Seems to be a known bug, read
1159L<http://nixdoc.net/files/forum/about34198.html>. Some people use the
1160following ugly workaround to get non-double-wide-characters working:
1161
1162 #define wcwidth(x) wcwidth(x) > 1 ? 1 : wcwidth(x)
1163
1164=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.
1165 1163
1166Rxvt-unicode requires the symbol C<__STDC_ISO_10646__> to be defined 1164Rxvt-unicode requires the symbol C<__STDC_ISO_10646__> to be defined
1167in your compile environment, or an implementation that implements it, 1165in your compile environment, or an implementation that implements it,
1168whether 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
… …
1171As you might have guessed, FreeBSD does neither define this symbol nor 1169As you might have guessed, FreeBSD does neither define this symbol nor
1172does it support it. Instead, it uses its own internal representation of 1170does it support it. Instead, it uses its own internal representation of
1173B<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.
1174 1172
1175However, 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
1176C<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>).
1177 1175
1178C<__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
1179apps in an OS, as using a locale-dependent (and non-standardized) 1177apps in an OS, as using a locale-dependent (and non-standardized)
1180representation of B<wchar_t> makes it impossible to convert between 1178representation of B<wchar_t> makes it impossible to convert between
1181B<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
… …
1191 1189
1192The 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
1193system 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
1194complete replacements for them :) 1192complete replacements for them :)
1195 1193
1196=head3 I use Solaris 9 and it doesn't compile/work/etc.
1197
1198Try the diff in F<doc/solaris9.patch> as a base. It fixes the worst
1199problems with C<wcwidth> and a compile problem.
1200
1201=head3 How can I use rxvt-unicode under cygwin? 1194=head3 How can I use rxvt-unicode under cygwin?
1202 1195
1203rxvt-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
1204the X11 libraries that come with cygwin. libW11 emulation is no 1197the X11 libraries that come with cygwin. libW11 emulation is no
1205longer supported (and makes no sense, either, as it only supported a 1198longer supported (and makes no sense, either, as it only supported a
… …
1208old libW11 emulation. 1201old libW11 emulation.
1209 1202
1210At 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
1211encodings (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
1212to 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.
1213 1225
1214=head1 RXVT-UNICODE TECHNICAL REFERENCE 1226=head1 RXVT-UNICODE TECHNICAL REFERENCE
1215 1227
1216The rest of this document describes various technical aspects of 1228The rest of this document describes various technical aspects of
1217B<rxvt-unicode>. First the description of supported command sequences, 1229B<rxvt-unicode>. First the description of supported command sequences,
… …
1470=begin table 1482=begin table
1471 1483
1472 B<< C<Ps = 0> >> Clear to Right (default) 1484 B<< C<Ps = 0> >> Clear to Right (default)
1473 B<< C<Ps = 1> >> Clear to Left 1485 B<< C<Ps = 1> >> Clear to Left
1474 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)
1475 1489
1476=end table 1490=end table
1477 1491
1478=item B<< C<ESC [ Ps L> >> 1492=item B<< C<ESC [ Ps L> >>
1479 1493
… …
1805 1819
1806=item B<< C<Pm = 30> >> 1820=item B<< C<Pm = 30> >>
1807 1821
1808=begin table 1822=begin table
1809 1823
1810 B<< C<h> >> scrollBar visisble 1824 B<< C<h> >> scrollBar visible
1811 B<< C<l> >> scrollBar invisisble 1825 B<< C<l> >> scrollBar invisible
1812 1826
1813=end table 1827=end table
1814 1828
1815=item B<< C<Pm = 35> >> (B<rxvt>) 1829=item B<< C<Pm = 35> >> (B<rxvt>)
1816 1830
… …
1899 B<< C<h> >> Use Hilite Mouse Tracking. 1913 B<< C<h> >> Use Hilite Mouse Tracking.
1900 B<< C<l> >> No mouse reporting. 1914 B<< C<l> >> No mouse reporting.
1901 1915
1902=end table 1916=end table
1903 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
1904=item B<< C<Pm = 1010> >> (B<rxvt>) 1936=item B<< C<Pm = 1010> >> (B<rxvt>)
1905 1937
1906=begin table 1938=begin table
1907 1939
1908 B<< C<h> >> Don't scroll to bottom on TTY output 1940 B<< C<h> >> Don't scroll to bottom on TTY output
… …
1950 1982
1951=begin table 1983=begin table
1952 1984
1953 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
1954 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
1955 1996
1956=end table 1997=end table
1957 1998
1958=back 1999=back
1959 2000
… …
1976 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> >>
1977 B<< C<Ps = 1> >> Change Icon Name to B<< C<Pt> >> 2018 B<< C<Ps = 1> >> Change Icon Name to B<< C<Pt> >>
1978 B<< C<Ps = 2> >> Change Window Title to B<< C<Pt> >> 2019 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. 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.
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 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
1981 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> >>
1982 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> >>
1983 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> >>
1984 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> >>
1985 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> >>
1986 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]
1987 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]
1988 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).
1989 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]
1990 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>
1991 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]
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> >> 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> >>
1993 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]
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). 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).
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>. 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>.
1996 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> >>
1997 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).
1998 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> >>
1999 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> >>
2000 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>.
2001 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).
2002 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).
2003 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).
2004 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).
… …
2007 2049
2008=end table 2050=end table
2009 2051
2010=back 2052=back
2011 2053
2012=head1 XPM 2054=head1 BACKGROUND IMAGE
2013 2055
2014For 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
2015of 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
2016sequence of scaling/positioning commands separated by semi-colons. The 2058sequence of scaling/positioning commands separated by semi-colons. The
2017scaling/positioning commands are as follows: 2059scaling/positioning commands are as follows:
2018 2060
2019=over 4 2061=over 4
2020 2062
… …
2058 2100
2059For example: 2101For example:
2060 2102
2061=over 4 2103=over 4
2062 2104
2063=item B<\E]20;funky\a> 2105=item B<\E]20;funky.jpg\a>
2064 2106
2065load B<funky.xpm> as a tiled image 2107load B<funky.jpg> as a tiled image
2066 2108
2067=item B<\E]20;mona;100\a> 2109=item B<\E]20;mona.jpg;100\a>
2068 2110
2069load B<mona.xpm> with a scaling of 100% 2111load B<mona.jpg> with a scaling of 100%
2070 2112
2071=item B<\E]20;;200;?\a> 2113=item B<\E]20;;200;?\a>
2072 2114
2073rescale the current pixmap to 200% and display the image geometry in 2115rescale the current pixmap to 200% and display the image geometry in
2074the title 2116the title
2075 2117
2076=back 2118=back
2119
2077X<Mouse> 2120X<Mouse>
2078 2121
2079=head1 Mouse Reporting 2122=head1 Mouse Reporting
2080 2123
2081=over 4 2124=over 4
… …
2122Col = B<< C<< <x> - SPACE >> >> 2165Col = B<< C<< <x> - SPACE >> >>
2123 2166
2124Row = B<< C<< <y> - SPACE >> >> 2167Row = B<< C<< <y> - SPACE >> >>
2125 2168
2126=back 2169=back
2170
2171=head1 Key Codes
2172
2127X<KeyCodes> 2173X<KeyCodes>
2128
2129=head1 Key Codes
2130 2174
2131Note: B<Shift> + B<F1>-B<F10> generates B<F11>-B<F20> 2175Note: B<Shift> + B<F1>-B<F10> generates B<F11>-B<F20>
2132 2176
2133For the keypad, use B<Shift> to temporarily override Application-Keypad 2177For the keypad, use B<Shift> to temporarily override Application-Keypad
2134setting use B<Num_Lock> to toggle Application-Keypad setting if 2178setting use B<Num_Lock> to toggle Application-Keypad setting if
… …
2201 2245
2202=head1 CONFIGURE OPTIONS 2246=head1 CONFIGURE OPTIONS
2203 2247
2204General hint: if you get compile errors, then likely your configuration 2248General hint: if you get compile errors, then likely your configuration
2205hasn'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
2206the default configuration (i.e. C<--enable-xxx> or C<--disable-xxx>). Of 2250the 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 2251switches). Of course, you should always report when a combination doesn't
2208can be fixed. Marc Lehmann <rxvt@schmorp.de>. 2252work, so it can be fixed. Marc Lehmann <rxvt@schmorp.de>.
2209 2253
2210All 2254All
2211 2255
2212=over 4 2256=over 4
2213 2257
… …
2302=item --with-res-name=NAME (default: urxvt) 2346=item --with-res-name=NAME (default: urxvt)
2303 2347
2304Use the given name as default application name when 2348Use the given name as default application name when
2305reading resources. Specify --with-res-name=rxvt to replace rxvt. 2349reading resources. Specify --with-res-name=rxvt to replace rxvt.
2306 2350
2307=item --with-res-class=CLASS /default: URxvt) 2351=item --with-res-class=CLASS (default: URxvt)
2308 2352
2309Use the given class as default application class 2353Use the given class as default application class
2310when reading resources. Specify --with-res-class=Rxvt to replace 2354when reading resources. Specify --with-res-class=Rxvt to replace
2311rxvt. 2355rxvt.
2312 2356
… …
2325 2369
2326Write user and tty to lastlog file (used by programs like 2370Write user and tty to lastlog file (used by programs like
2327F<lastlogin>) at start of rxvt execution. This option requires 2371F<lastlogin>) at start of rxvt execution. This option requires
2328--enable-utmp to also be specified. 2372--enable-utmp to also be specified.
2329 2373
2330=item --enable-xpm-background (default: on) 2374=item --enable-afterimage (default: on)
2331 2375
2332Add 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.
2333 2388
2334=item --enable-transparency (default: on) 2389=item --enable-transparency (default: on)
2335 2390
2336Add support for inheriting parent backgrounds thus giving a fake 2391Add support for backgrounds, creating illusion of transparency in the term.
2337transparency to the term.
2338 2392
2339=item --enable-fading (default: on) 2393=item --enable-fading (default: on)
2340 2394
2341Add support for fading the text when focus is lost (requires C<--enable-transparency>). 2395Add support for fading the text when focus is lost.
2342
2343=item --enable-tinting (default: on)
2344
2345Add support for tinting of transparent backgrounds (requires C<--enable-transparency>).
2346 2396
2347=item --enable-rxvt-scroll (default: on) 2397=item --enable-rxvt-scroll (default: on)
2348 2398
2349Add support for the original rxvt scrollbar. 2399Add support for the original rxvt scrollbar.
2350 2400
… …
2353Add support for a NeXT-like scrollbar. 2403Add support for a NeXT-like scrollbar.
2354 2404
2355=item --enable-xterm-scroll (default: on) 2405=item --enable-xterm-scroll (default: on)
2356 2406
2357Add support for an Xterm-like scrollbar. 2407Add support for an Xterm-like scrollbar.
2358
2359=item --enable-plain-scroll (default: on)
2360
2361Add support for a very unobtrusive, plain-looking scrollbar that
2362is the favourite of the rxvt-unicode author, having used it for
2363many years.
2364
2365=item --enable-ttygid (default: off)
2366
2367Change tty device setting to group "tty" - only use this if
2368your system uses this type of security.
2369 2408
2370=item --disable-backspace-key 2409=item --disable-backspace-key
2371 2410
2372Removes 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.
2373 2412
… …
2402 settable extra linespacing /-lsp) 2441 settable extra linespacing /-lsp)
2403 iso-14755 5.1 (basic) support 2442 iso-14755 5.1 (basic) support
2404 tripleclickwords (-tcw) 2443 tripleclickwords (-tcw)
2405 settable insecure mode (-insecure) 2444 settable insecure mode (-insecure)
2406 keysym remapping support 2445 keysym remapping support
2407 cursor blinking and underline cursor (-cb, -uc) 2446 cursor blinking and underline cursor (-bc, -uc)
2408 XEmbed support (-embed) 2447 XEmbed support (-embed)
2409 user-pty (-pty-fd) 2448 user-pty (-pty-fd)
2410 hold on exit (-hold) 2449 hold on exit (-hold)
2450 compile in built-in block graphics
2411 skip builtin block graphics (-sbg) 2451 skip builtin block graphics (-sbg)
2412 separate highlightcolor support (-hc) 2452 separate highlightcolor support (-hc)
2413 2453
2414It also enables some non-essential features otherwise disabled, such as: 2454It also enables some non-essential features otherwise disabled, such as:
2415 2455
… …
2425 trailing space removal for selections 2465 trailing space removal for selections
2426 verbose X error handling 2466 verbose X error handling
2427 2467
2428=item --enable-iso14755 (default: on) 2468=item --enable-iso14755 (default: on)
2429 2469
2430Enable extended ISO 14755 support (see @@RXVT_NAME@@(1), or 2470Enable extended ISO 14755 support (see @@RXVT_NAME@@(1)).
2431F<doc/rxvt.1.txt>). Basic support (section 5.1) is enabled by 2471Basic support (section 5.1) is enabled by C<--enable-frills>, while
2432C<--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.
2433this switch.
2434 2473
2435=item --enable-keepscrolling (default: on) 2474=item --enable-keepscrolling (default: on)
2436 2475
2437Add support for continual scrolling of the display when you hold 2476Add support for continual scrolling of the display when you hold
2438the 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.
2439 2483
2440=item --enable-mousewheel (default: on) 2484=item --enable-mousewheel (default: on)
2441 2485
2442Add support for scrolling via mouse wheel or buttons 4 & 5. 2486Add support for scrolling via mouse wheel or buttons 4 & 5.
2443 2487
… …
2445 2489
2446Add support for continual scrolling (using the mouse wheel as an 2490Add support for continual scrolling (using the mouse wheel as an
2447accelerator) while the control key is held down. This option 2491accelerator) while the control key is held down. This option
2448requires --enable-mousewheel to also be specified. 2492requires --enable-mousewheel to also be specified.
2449 2493
2450=item --disable-new-selection
2451
2452Remove support for mouse selection style like that of xterm.
2453
2454=item --enable-smart-resize (default: on) 2494=item --enable-smart-resize (default: off)
2455 2495
2456Add smart growth/shrink behaviour when changing font size via hot 2496Add smart growth/shrink behaviour when resizing.
2457keys. 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
2458the screen in a fixed position. 2498the screen in a fixed position.
2459 2499
2500=item --enable-text-blink (default: on)
2501
2502Add support for blinking text.
2503
2460=item --enable-pointer-blank (default: on) 2504=item --enable-pointer-blank (default: on)
2461 2505
2462Add support to have the pointer disappear when typing or inactive. 2506Add support to have the pointer disappear when typing or inactive.
2463 2507
2464=item --enable-perl (default: on) 2508=item --enable-perl (default: on)
2465 2509
2466Enable an embedded perl interpreter. See the B<@@RXVT_NAME@@perl(3)> 2510Enable an embedded perl interpreter. See the B<@@RXVT_NAME@@perl(3)>
2467manpage (F<doc/rxvtperl.txt>) for more info on this feature, or the 2511manpage for more info on this feature, or the files in F<src/perl/>
2468files in F<src/perl-ext/> for the extensions that are installed by 2512for the extensions that are installed by default.
2469default. The perl interpreter that is used can be specified via the 2513The perl interpreter that is used can be specified via the C<PERL>
2470C<PERL> environment variable when running configure. Even when compiled 2514environment variable when running configure. Even when compiled in,
2471in, perl will I<not> be initialised when all extensions have been disabled 2515perl will I<not> be initialised when all extensions have been disabled
2472C<-pe "" --perl-ext-common "">, so it should be safe to enable from a 2516C<-pe "" --perl-ext-common "">, so it should be safe to enable from a
2473resource standpoint. 2517resource standpoint.
2518
2519=item --with-afterimage-config=DIR
2520
2521Look for the libAfterImage config script in DIR.
2474 2522
2475=item --with-name=NAME (default: urxvt) 2523=item --with-name=NAME (default: urxvt)
2476 2524
2477Set the basename for the installed binaries, resulting 2525Set the basename for the installed binaries, resulting
2478in 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
… …
2488PATH. 2536PATH.
2489 2537
2490=item --with-x 2538=item --with-x
2491 2539
2492Use the X Window System (pretty much default, eh?). 2540Use the X Window System (pretty much default, eh?).
2493
2494=item --with-xpm-includes=DIR
2495
2496Look for the XPM includes in DIR.
2497
2498=item --with-xpm-library=DIR
2499
2500Look for the XPM library in DIR.
2501
2502=item --with-xpm
2503
2504Not needed - define via --enable-xpm-background.
2505 2541
2506=back 2542=back
2507 2543
2508=head1 AUTHORS 2544=head1 AUTHORS
2509 2545

Diff Legend

– Removed lines
+ Added lines
< Changed lines
> Changed lines