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.120 by root, Mon Aug 7 15:59:44 2006 UTC vs.
Revision 1.166 by root, Sat Feb 2 14:59:48 2008 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
… …
73=head3 How can I start @@URXVT_NAME@@d in a race-free way? 76=head3 How can I start @@URXVT_NAME@@d in a race-free way?
74 77
75Try C<@@URXVT_NAME@@d -f -o>, which tells @@URXVT_NAME@@d to open the 78Try C<@@URXVT_NAME@@d -f -o>, which tells @@URXVT_NAME@@d to open the
76display, create the listening socket and then fork. 79display, create the listening socket and then fork.
77 80
78=head3 How can I start @@URXVT_NAME@@d automatically when I run URXVT_NAME@@c? 81=head3 How can I start @@URXVT_NAME@@d automatically when I run @@URXVT_NAME@@c?
79 82
80If you want to start @@URXVT_NAME@@d automatically whenever you run 83If 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: 84@@URXVT_NAME@@c and the daemon isn't running yet, use this script:
82 85
83 #!/bin/sh 86 #!/bin/sh
… …
125 fi 128 fi
126 129
127=head3 How do I compile the manual pages on my own? 130=head3 How do I compile the manual pages on my own?
128 131
129You need to have a recent version of perl installed as F</usr/bin/perl>, 132You 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 133one that comes with F<pod2man>, F<pod2text> and F<pod2xhtml> (from
131the doc subdirectory and enter C<make alldoc>. 134F<Pod::Xhtml>). Then go to the doc subdirectory and enter C<make alldoc>.
132 135
133=head3 Isn't rxvt-unicode supposed to be small? Don't all those features bloat? 136=head3 Isn't rxvt-unicode supposed to be small? Don't all those features bloat?
134 137
135I often get asked about this, and I think, no, they didn't cause extra 138I 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 139bloat. If you compare a minimal rxvt and a minimal urxvt, you can see
… …
197 200
198And here is rxvt-unicode: 201And here is rxvt-unicode:
199 202
200 libX11.so.6 => /usr/X11R6/lib/libX11.so.6 (0x00002aaaaabc3000) 203 libX11.so.6 => /usr/X11R6/lib/libX11.so.6 (0x00002aaaaabc3000)
201 libgcc_s.so.1 => /lib/libgcc_s.so.1 (0x00002aaaaada2000) 204 libgcc_s.so.1 => /lib/libgcc_s.so.1 (0x00002aaaaada2000)
202 libc.so.6 => /lib/libc.so.6 (0x00002aaaaaeb0000) 205 libc.so.6 => /lib/libc.so.6 (0x00002aaaaaeb0000)
203 libdl.so.2 => /lib/libdl.so.2 (0x00002aaaab0ee000) 206 libdl.so.2 => /lib/libdl.so.2 (0x00002aaaab0ee000)
204 /lib64/ld-linux-x86-64.so.2 (0x00002aaaaaaab000) 207 /lib64/ld-linux-x86-64.so.2 (0x00002aaaaaaab000)
205 208
206No large bloated libraries (of course, none were linked in statically), 209No large bloated libraries (of course, none were linked in statically),
207except maybe libX11 :) 210except maybe libX11 :)
208 211
209 212
210=head2 Rendering, Font & Look and Feel Issues 213=head2 Rendering, Font & Look and Feel Issues
211 214
212=head3 I can't get transparency working, what am I doing wrong? 215=head3 I can't get transparency working, what am I doing wrong?
213 216
214First of all, transparency isn't officially supported in rxvt-unicode, so 217First 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 218sasha@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 219get it working consider it a rite of passage: ... and you failed.
217of passage: ... and you failed.
218 220
219Here are four ways to get transparency. B<Do> read the manpage and option 221Here are four ways to get transparency. B<Do> read the manpage and option
220descriptions for the programs mentioned and rxvt-unicode. Really, do it! 222descriptions for the programs mentioned and rxvt-unicode. Really, do it!
221 223
2221. Use inheritPixmap: 2241. Use transparent mode:
223 225
224 Esetroot wallpaper.jpg 226 Esetroot wallpaper.jpg
225 @@URXVT_NAME@@ -ip -tint red -sh 40 227 @@URXVT_NAME@@ -tr -tint red -sh 40
226 228
227That works. If you think it doesn't, you lack transparency and tinting 229That works. If you think it doesn't, you lack transparency and tinting
228support, or you are unable to read. 230support, or you are unable to read.
229 231
2302. Use a simple pixmap and emulate pseudo-transparency. This enables you 2322. Use a simple pixmap and emulate pseudo-transparency. This enables you
231to use effects other than tinting and shading: Just shade/tint/whatever 233to use effects other than tinting and shading: Just shade/tint/whatever
232your picture with gimp or any other tool: 234your picture with gimp or any other tool:
233 235
234 convert wallpaper.jpg -blur 20x20 -modulate 30 background.xpm 236 convert wallpaper.jpg -blur 20x20 -modulate 30 background.jpg
235 @@URXVT_NAME@@ -pixmap background.xpm -pe automove-background 237 @@URXVT_NAME@@ -pixmap "background.jpg;:root"
236 238
237That works. If you think it doesn't, you lack XPM and Perl support, or you 239That works. If you think it doesn't, you lack AfterImage support, or you
238are unable to read. 240are unable to read.
239 241
2403. Use an ARGB visual: 2423. Use an ARGB visual:
241 243
242 @@URXVT_NAME@@ -depth 32 -fg grey90 -bg rgba:0000/0000/4444/cccc 244 @@URXVT_NAME@@ -depth 32 -fg grey90 -bg rgba:0000/0000/4444/cccc
… …
342=head3 What's with this bold/blink stuff? 344=head3 What's with this bold/blink stuff?
343 345
344If no bold colour is set via C<colorBD:>, bold will invert text using the 346If no bold colour is set via C<colorBD:>, bold will invert text using the
345standard foreground colour. 347standard foreground colour.
346 348
347For the standard background colour, blinking will actually make the 349For the standard background colour, blinking will actually make
348text blink when compiled with C<--enable-blinking>. with standard 350the text blink when compiled with C<--enable-text-blink>. Without
349colours. Without C<--enable-blinking>, the blink attribute will be 351C<--enable-text-blink>, the blink attribute will be ignored.
350ignored.
351 352
352On ANSI colours, bold/blink attributes are used to set high-intensity 353On ANSI colours, bold/blink attributes are used to set high-intensity
353foreground/background colors. 354foreground/background colors.
354 355
355color0-7 are the low-intensity colors. 356color0-7 are the low-intensity colors.
… …
460has been designed yet). 461has been designed yet).
461 462
462Until then, you might get away with switching fonts at runtime (see L<Can 463Until then, you might get away with switching fonts at runtime (see L<Can
463I switch the fonts at runtime?> later in this document). 464I switch the fonts at runtime?> later in this document).
464 465
466=head3 How can I make mplayer display video correctly?
467
468We are working on it, in the meantime, as a workaround, use something like:
469
470 @@URXVT_NAME@@ -b 600 -geometry 20x1 -e sh -c 'mplayer -wid $WINDOWID file...'
471
472
465=head2 Keyboard, Mouse & User Interaction 473=head2 Keyboard, Mouse & User Interaction
466 474
467=head3 The new selection selects pieces that are too big, how can I select single words? 475=head3 The new selection selects pieces that are too big, how can I select single words?
468 476
469If you want to select e.g. alphanumeric words, you can use the following 477If you want to select e.g. alphanumeric words, you can use the following
… …
476 484
477To get a selection that is very similar to the old code, try this pattern: 485To get a selection that is very similar to the old code, try this pattern:
478 486
479 URxvt.selection.pattern-0: ([^"&'()*,;<=>?@[\\\\]^`{|})]+) 487 URxvt.selection.pattern-0: ([^"&'()*,;<=>?@[\\\\]^`{|})]+)
480 488
481Please also note that the I<LeftClick Shift-LeftClik> combination also 489Please also note that the I<LeftClick Shift-LeftClick> combination also
482selects words like the old code. 490selects words like the old code.
483 491
484=head3 I don't like the new selection/popups/hotkeys/perl, how do I change/disable it? 492=head3 I don't like the new selection/popups/hotkeys/perl, how do I change/disable it?
485 493
486You can disable the perl extension completely by setting the 494You can disable the perl extension completely by setting the
… …
562Backspace keysym (not likely for Linux ... see the following 570Backspace keysym (not likely for Linux ... see the following
563question) there are two standard values that can be used for 571question) there are two standard values that can be used for
564Backspace: C<^H> and C<^?>. 572Backspace: C<^H> and C<^?>.
565 573
566Historically, either value is correct, but rxvt-unicode adopts the debian 574Historically, either value is correct, but rxvt-unicode adopts the debian
567policy of using C<^?> when unsure, because it's the one only only correct 575policy of using C<^?> when unsure, because it's the one and only correct
568choice :). 576choice :).
569 577
570Rxvt-unicode tries to inherit the current stty settings and uses the value 578Rxvt-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 579of `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 580started 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 612key has been assigned an escape sequence to match the vt100 for Execute
605(C<ESC [ 3 ~>) and is in the supplied termcap/terminfo. 613(C<ESC [ 3 ~>) and is in the supplied termcap/terminfo.
606 614
607Some other Backspace problems: 615Some other Backspace problems:
608 616
609some editors use termcap/terminfo, 617some editors use termcap/terminfo,
610some editors (vim I'm told) expect Backspace = ^H, 618some editors (vim I'm told) expect Backspace = ^H,
611GNU Emacs (and Emacs-like editors) use ^H for help. 619GNU Emacs (and Emacs-like editors) use ^H for help.
612 620
613Perhaps someday this will all be resolved in a consistent manner. 621Perhaps someday this will all be resolved in a consistent manner.
614 622
… …
655Rather than have rxvt-unicode try to accommodate all the various possible 663Rather than have rxvt-unicode try to accommodate all the various possible
656keyboard mappings, it is better to use `xmodmap' to remap the keys as 664keyboard mappings, it is better to use `xmodmap' to remap the keys as
657required for your particular machine. 665required for your particular machine.
658 666
659 667
660
661=head2 Terminal Configuration 668=head2 Terminal Configuration
662 669
663=head3 Can I see a typical configuration? 670=head3 Can I see a typical configuration?
664 671
665The default configuration tries to be xterm-like, which I don't like that 672The default configuration tries to be xterm-like, which I don't like that
… …
838 845
839The terminal description used by rxvt-unicode is not as widely available 846The 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). 847as that for xterm, or even rxvt (for which the same problem often arises).
841 848
842The correct solution for this problem is to install the terminfo, this can 849The correct solution for this problem is to install the terminfo, this can
843be done like this (with ncurses' infocmp): 850be done like this (with ncurses' infocmp and works as user and admin):
844 851
845 REMOTE=remotesystem.domain 852 REMOTE=remotesystem.domain
846 infocmp rxvt-unicode | ssh $REMOTE "cat >/tmp/ti && tic /tmp/ti" 853 infocmp rxvt-unicode | ssh $REMOTE "mkdir -p .terminfo && cat >/tmp/ti && tic /tmp/ti"
847 854
848... or by installing rxvt-unicode normally on the remote system, 855... or by installing rxvt-unicode normally on the remote system,
856
857One some systems you might need to set C<$TERMINFO> to the full path of
858F<$HOME/.terminfo> for this to work.
849 859
850If you cannot or do not want to do this, then you can simply set 860If you cannot or do not want to do this, then you can simply set
851C<TERM=rxvt> or even C<TERM=xterm>, and live with the small number of 861C<TERM=rxvt> or even C<TERM=xterm>, and live with the small number of
852problems arising, which includes wrong keymapping, less and different 862problems arising, which includes wrong keymapping, less and different
853colours and some refresh errors in fullscreen applications. It's a nice 863colours and some refresh errors in fullscreen applications. It's a nice
… …
953If you encounter strange problems like typing an accented character but 963If you encounter strange problems like typing an accented character but
954getting two unrelated other characters or similar, or if program output is 964getting two unrelated other characters or similar, or if program output is
955subtly garbled, then you should check your locale settings. 965subtly garbled, then you should check your locale settings.
956 966
957Rxvt-unicode must be started with the same C<LC_CTYPE> setting as the 967Rxvt-unicode must be started with the same C<LC_CTYPE> setting as the
958programs. Often rxvt-unicode is started in the C<C> locale, while the 968programs running in it. Often rxvt-unicode is started in the C<C> locale,
959login script running within the rxvt-unicode window changes the locale to 969while the login script running within the rxvt-unicode window changes the
960something else, e.g. C<en_GB.UTF-8>. Needless to say, this is not going to work. 970locale to something else, e.g. C<en_GB.UTF-8>. Needless to say, this is
971not going to work, and is the most common cause for problems.
961 972
962The best thing is to fix your startup environment, as you will likely run 973The best thing is to fix your startup environment, as you will likely run
963into other problems. If nothing works you can try this in your .profile. 974into other problems. If nothing works you can try this in your .profile.
964 975
965 printf '\33]701;%s\007' "$LC_CTYPE" 976 printf '\33]701;%s\007' "$LC_CTYPE" # $LANG or $LC_ALL are worth a try, too
966 977
967If this doesn't work, then maybe you use a C<LC_CTYPE> specification not 978If this doesn't work, then maybe you use a C<LC_CTYPE> specification not
968supported on your systems. Some systems have a C<locale> command which 979supported on your systems. Some systems have a C<locale> command which
969displays this (also, C<perl -e0> can be used to check locale settings, as 980displays this (also, C<perl -e0> can be used to check locale settings, as
970it will complain loudly if it cannot set the locale). If it displays something 981it will complain loudly if it cannot set the locale). If it displays something
… …
1064C<@im=kinput2>. For B<scim>, use C<@im=SCIM>. You can see what input 1075C<@im=kinput2>. For B<scim>, use C<@im=SCIM>. You can see what input
1065method servers are running with this command: 1076method servers are running with this command:
1066 1077
1067 xprop -root XIM_SERVERS 1078 xprop -root XIM_SERVERS
1068 1079
1069=item 1080=item
1070 1081
1071=back 1082=back
1072 1083
1073=head3 My input method wants <some encoding> but I want UTF-8, what can I do? 1084=head3 My input method wants <some encoding> but I want UTF-8, what can I do?
1074 1085
… …
1147This forking is done as the very first within main(), which is very early 1158This forking is done as the very first within main(), which is very early
1148and reduces possible bugs to initialisation code run before main(), or 1159and reduces possible bugs to initialisation code run before main(), or
1149things like the dynamic loader of your system, which should result in very 1160things like the dynamic loader of your system, which should result in very
1150little risk. 1161little risk.
1151 1162
1152=head3 On Solaris 9, many line-drawing characters are too wide.
1153
1154Seems to be a known bug, read
1155L<http://nixdoc.net/files/forum/about34198.html>. Some people use the
1156following ugly workaround to get non-double-wide-characters working:
1157
1158 #define wcwidth(x) wcwidth(x) > 1 ? 1 : wcwidth(x)
1159
1160=head3 I am on FreeBSD and rxvt-unicode does not seem to work at all. 1163=head3 I am on FreeBSD and rxvt-unicode does not seem to work at all.
1161 1164
1162Rxvt-unicode requires the symbol C<__STDC_ISO_10646__> to be defined 1165Rxvt-unicode requires the symbol C<__STDC_ISO_10646__> to be defined
1163in your compile environment, or an implementation that implements it, 1166in your compile environment, or an implementation that implements it,
1164whether it defines the symbol or not. C<__STDC_ISO_10646__> requires that 1167whether it defines the symbol or not. C<__STDC_ISO_10646__> requires that
… …
1187 1190
1188The rxvt-unicode author insists that the right way to fix this is in the 1191The rxvt-unicode author insists that the right way to fix this is in the
1189system libraries once and for all, instead of forcing every app to carry 1192system libraries once and for all, instead of forcing every app to carry
1190complete replacements for them :) 1193complete replacements for them :)
1191 1194
1192=head3 I use Solaris 9 and it doesn't compile/work/etc.
1193
1194Try the diff in F<doc/solaris9.patch> as a base. It fixes the worst
1195problems with C<wcwidth> and a compile problem.
1196
1197=head3 How can I use rxvt-unicode under cygwin? 1195=head3 How can I use rxvt-unicode under cygwin?
1198 1196
1199rxvt-unicode should compile and run out of the box on cygwin, using 1197rxvt-unicode should compile and run out of the box on cygwin, using
1200the X11 libraries that come with cygwin. libW11 emulation is no 1198the X11 libraries that come with cygwin. libW11 emulation is no
1201longer supported (and makes no sense, either, as it only supported a 1199longer supported (and makes no sense, either, as it only supported a
… …
1204old libW11 emulation. 1202old libW11 emulation.
1205 1203
1206At the time of this writing, cygwin didn't seem to support any multi-byte 1204At the time of this writing, cygwin didn't seem to support any multi-byte
1207encodings (you might try C<LC_CTYPE=C-UTF-8>), so you are likely limited 1205encodings (you might try C<LC_CTYPE=C-UTF-8>), so you are likely limited
1208to 8-bit encodings. 1206to 8-bit encodings.
1207
1208=head3 Character widths are not correct.
1209
1210urxvt uses the system wcwidth function to know the information about
1211the width of characters, so on systems with incorrect locale data you
1212will likely get bad results. Two notorious examples are Solaris 9,
1213where single-width characters like U+2514 are reported as double-width,
1214and Darwin 8, where combining chars are reported having width 1.
1215
1216The solution is to upgrade your system or switch to a better one. A
1217possibly working workaround is to use a wcwidth implementation like
1218
1219http://www.cl.cam.ac.uk/~mgk25/ucs/wcwidth.c
1209 1220
1210=head1 RXVT-UNICODE TECHNICAL REFERENCE 1221=head1 RXVT-UNICODE TECHNICAL REFERENCE
1211 1222
1212The rest of this document describes various technical aspects of 1223The rest of this document describes various technical aspects of
1213B<rxvt-unicode>. First the description of supported command sequences, 1224B<rxvt-unicode>. First the description of supported command sequences,
… …
1801 1812
1802=item B<< C<Pm = 30> >> 1813=item B<< C<Pm = 30> >>
1803 1814
1804=begin table 1815=begin table
1805 1816
1806 B<< C<h> >> scrollBar visisble 1817 B<< C<h> >> scrollBar visible
1807 B<< C<l> >> scrollBar invisisble 1818 B<< C<l> >> scrollBar invisible
1808 1819
1809=end table 1820=end table
1810 1821
1811=item B<< C<Pm = 35> >> (B<rxvt>) 1822=item B<< C<Pm = 35> >> (B<rxvt>)
1812 1823
… …
1895 B<< C<h> >> Use Hilite Mouse Tracking. 1906 B<< C<h> >> Use Hilite Mouse Tracking.
1896 B<< C<l> >> No mouse reporting. 1907 B<< C<l> >> No mouse reporting.
1897 1908
1898=end table 1909=end table
1899 1910
1911=item B<< C<Pm = 1002> >> (X11 XTerm)
1912
1913=begin table
1914
1915 B<< C<h> >> Send Mouse X & Y on button press and release, and motion with a button pressed.
1916 B<< C<l> >> No mouse reporting.
1917
1918=end table
1919
1920=item B<< C<Pm = 1003> >> (X11 XTerm)
1921
1922=begin table
1923
1924 B<< C<h> >> Send Mouse X & Y on button press and release, and motion.
1925 B<< C<l> >> No mouse reporting.
1926
1927=end table
1928
1900=item B<< C<Pm = 1010> >> (B<rxvt>) 1929=item B<< C<Pm = 1010> >> (B<rxvt>)
1901 1930
1902=begin table 1931=begin table
1903 1932
1904 B<< C<h> >> Don't scroll to bottom on TTY output 1933 B<< C<h> >> Don't scroll to bottom on TTY output
… …
1946 1975
1947=begin table 1976=begin table
1948 1977
1949 B<< C<h> >> Use Alternate Screen Buffer - clear Alternate Screen Buffer if switching to it 1978 B<< C<h> >> Use Alternate Screen Buffer - clear Alternate Screen Buffer if switching to it
1950 B<< C<l> >> Use Normal Screen Buffer 1979 B<< C<l> >> Use Normal Screen Buffer
1980
1981=end table
1982
1983=item B<< C<Pm = 2004> >>
1984
1985=begin table
1986
1987 B<< C<h> >> Enable bracketed paste mode - prepend / append to the pasted text the control sequences C<ESC [ 200 ~> / C<ESC [ 201 ~>
1988 B<< C<l> >> Disable bracketed paste mode
1951 1989
1952=end table 1990=end table
1953 1991
1954=back 1992=back
1955 1993
… …
1972 B<< C<Ps = 0> >> Change Icon Name and Window Title to B<< C<Pt> >> 2010 B<< C<Ps = 0> >> Change Icon Name and Window Title to B<< C<Pt> >>
1973 B<< C<Ps = 1> >> Change Icon Name to B<< C<Pt> >> 2011 B<< C<Ps = 1> >> Change Icon Name to B<< C<Pt> >>
1974 B<< C<Ps = 2> >> Change Window Title to B<< C<Pt> >> 2012 B<< C<Ps = 2> >> Change Window Title to B<< C<Pt> >>
1975 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. 2013 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.
1976 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 2014 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
1977 B<< C<Ps = 10> >> Change colour of text foreground to B<< C<Pt> >> B<(NB: may change in future)> 2015 B<< C<Ps = 10> >> Change colour of text foreground to B<< C<Pt> >>
1978 B<< C<Ps = 11> >> Change colour of text background to B<< C<Pt> >> B<(NB: may change in future)> 2016 B<< C<Ps = 11> >> Change colour of text background to B<< C<Pt> >>
1979 B<< C<Ps = 12> >> Change colour of text cursor foreground to B<< C<Pt> >> 2017 B<< C<Ps = 12> >> Change colour of text cursor foreground to B<< C<Pt> >>
1980 B<< C<Ps = 13> >> Change colour of mouse foreground to B<< C<Pt> >> 2018 B<< C<Ps = 13> >> Change colour of mouse foreground to B<< C<Pt> >>
1981 B<< C<Ps = 17> >> Change colour of highlight characters to B<< C<Pt> >> 2019 B<< C<Ps = 17> >> Change colour of highlight characters to B<< C<Pt> >>
1982 B<< C<Ps = 18> >> Change colour of bold characters to B<< C<Pt> >> [deprecated, see 706] 2020 B<< C<Ps = 18> >> Change colour of bold characters to B<< C<Pt> >> [deprecated, see 706]
1983 B<< C<Ps = 19> >> Change colour of underlined characters to B<< C<Pt> >> [deprecated, see 707] 2021 B<< C<Ps = 19> >> Change colour of underlined characters to B<< C<Pt> >> [deprecated, see 707]
1984 B<< C<Ps = 20> >> Change background pixmap parameters (see section XPM) (Compile XPM). 2022 B<< C<Ps = 20> >> Change background pixmap parameters (see section BACKGROUND IMAGE) (Compile AfterImage).
1985 B<< C<Ps = 39> >> Change default foreground colour to B<< C<Pt> >>. 2023 B<< C<Ps = 39> >> Change default foreground colour to B<< C<Pt> >>. [deprecated, use 10]
1986 B<< C<Ps = 46> >> Change Log File to B<< C<Pt> >> I<unimplemented> 2024 B<< C<Ps = 46> >> Change Log File to B<< C<Pt> >> I<unimplemented>
1987 B<< C<Ps = 49> >> Change default background colour to B<< C<Pt> >>. 2025 B<< C<Ps = 49> >> Change default background colour to B<< C<Pt> >>. [deprecated, use 11]
1988 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> >> 2026 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> >>
1989 B<< C<Ps = 55> >> Log all scrollback buffer and all of screen to B<< C<Pt> >> 2027 B<< C<Ps = 55> >> Log all scrollback buffer and all of screen to B<< C<Pt> >> [disabled]
1990 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). 2028 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).
1991 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>. 2029 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>.
1992 B<< C<Ps = 704> >> Change colour of italic characters to B<< C<Pt> >> 2030 B<< C<Ps = 704> >> Change colour of italic characters to B<< C<Pt> >>
1993 B<< C<Ps = 705> >> Change background pixmap tint colour to B<< C<Pt> >> (Compile transparency). 2031 B<< C<Ps = 705> >> Change background pixmap tint colour to B<< C<Pt> >> (Compile transparency).
1994 B<< C<Ps = 706> >> Change colour of bold characters to B<< C<Pt> >> 2032 B<< C<Ps = 706> >> Change colour of bold characters to B<< C<Pt> >>
… …
2003 2041
2004=end table 2042=end table
2005 2043
2006=back 2044=back
2007 2045
2008=head1 XPM 2046=head1 BACKGROUND IMAGE
2009 2047
2010For the XPM XTerm escape sequence B<< C<ESC ] 20 ; Pt ST> >> then value 2048For the BACKGROUND IMAGE XTerm escape sequence B<< C<ESC ] 20 ; Pt ST> >> the value
2011of B<< C<Pt> >> can be the name of the background pixmap followed by a 2049of B<< C<Pt> >> can be the name of the background image file followed by a
2012sequence of scaling/positioning commands separated by semi-colons. The 2050sequence of scaling/positioning commands separated by semi-colons. The
2013scaling/positioning commands are as follows: 2051scaling/positioning commands are as follows:
2014 2052
2015=over 4 2053=over 4
2016 2054
… …
2054 2092
2055For example: 2093For example:
2056 2094
2057=over 4 2095=over 4
2058 2096
2059=item B<\E]20;funky\a> 2097=item B<\E]20;funky.jpg\a>
2060 2098
2061load B<funky.xpm> as a tiled image 2099load B<funky.jpg> as a tiled image
2062 2100
2063=item B<\E]20;mona;100\a> 2101=item B<\E]20;mona.jpg;100\a>
2064 2102
2065load B<mona.xpm> with a scaling of 100% 2103load B<mona.jpg> with a scaling of 100%
2066 2104
2067=item B<\E]20;;200;?\a> 2105=item B<\E]20;;200;?\a>
2068 2106
2069rescale the current pixmap to 200% and display the image geometry in 2107rescale the current pixmap to 200% and display the image geometry in
2070the title 2108the title
2071 2109
2072=back 2110=back
2111
2073X<Mouse> 2112X<Mouse>
2074 2113
2075=head1 Mouse Reporting 2114=head1 Mouse Reporting
2076 2115
2077=over 4 2116=over 4
… …
2118Col = B<< C<< <x> - SPACE >> >> 2157Col = B<< C<< <x> - SPACE >> >>
2119 2158
2120Row = B<< C<< <y> - SPACE >> >> 2159Row = B<< C<< <y> - SPACE >> >>
2121 2160
2122=back 2161=back
2162
2163=head1 Key Codes
2164
2123X<KeyCodes> 2165X<KeyCodes>
2124
2125=head1 Key Codes
2126 2166
2127Note: B<Shift> + B<F1>-B<F10> generates B<F11>-B<F20> 2167Note: B<Shift> + B<F1>-B<F10> generates B<F11>-B<F20>
2128 2168
2129For the keypad, use B<Shift> to temporarily override Application-Keypad 2169For the keypad, use B<Shift> to temporarily override Application-Keypad
2130setting use B<Num_Lock> to toggle Application-Keypad setting if 2170setting use B<Num_Lock> to toggle Application-Keypad setting if
… …
2197 2237
2198=head1 CONFIGURE OPTIONS 2238=head1 CONFIGURE OPTIONS
2199 2239
2200General hint: if you get compile errors, then likely your configuration 2240General hint: if you get compile errors, then likely your configuration
2201hasn't been tested well. Either try with C<--enable-everything> or use 2241hasn't been tested well. Either try with C<--enable-everything> or use
2202the F<./reconf> script as a base for experiments. F<./reconf> is used by 2242the default configuration (i.e. no C<--enable-xxx> or C<--disable-xxx>
2203myself, so it should generally be a working config. Of course, you should 2243switches). Of course, you should always report when a combination doesn't
2204always report when a combination doesn't work, so it can be fixed. Marc 2244work, so it can be fixed. Marc Lehmann <rxvt@schmorp.de>.
2205Lehmann <rxvt@schmorp.de>.
2206 2245
2207All 2246All
2208 2247
2209=over 4 2248=over 4
2210 2249
… …
2242 2281
2243=begin table 2282=begin table
2244 2283
2245 all all available codeset groups 2284 all all available codeset groups
2246 zh common chinese encodings 2285 zh common chinese encodings
2247 zh_ext rarely used but very big chinese encodigs 2286 zh_ext rarely used but very big chinese encodings
2248 jp common japanese encodings 2287 jp common japanese encodings
2249 jp_ext rarely used but big japanese encodings 2288 jp_ext rarely used but big japanese encodings
2250 kr korean encodings 2289 kr korean encodings
2251 2290
2252=end table 2291=end table
… …
2266requirements per character from 2 to 4 bytes. X11 fonts do not yet 2305requirements per character from 2 to 4 bytes. X11 fonts do not yet
2267support these extra characters, but Xft does. 2306support these extra characters, but Xft does.
2268 2307
2269Please note that rxvt-unicode can store unicode code points >65535 2308Please note that rxvt-unicode can store unicode code points >65535
2270even without this flag, but the number of such characters is 2309even without this flag, but the number of such characters is
2271limited to a view thousand (shared with combining characters, 2310limited to a few thousand (shared with combining characters,
2272see next switch), and right now rxvt-unicode cannot display them 2311see next switch), and right now rxvt-unicode cannot display them
2273(input/output and cut&paste still work, though). 2312(input/output and cut&paste still work, though).
2274 2313
2275=item --enable-combining (default: on) 2314=item --enable-combining (default: on)
2276 2315
… …
2299=item --with-res-name=NAME (default: urxvt) 2338=item --with-res-name=NAME (default: urxvt)
2300 2339
2301Use the given name as default application name when 2340Use the given name as default application name when
2302reading resources. Specify --with-res-name=rxvt to replace rxvt. 2341reading resources. Specify --with-res-name=rxvt to replace rxvt.
2303 2342
2304=item --with-res-class=CLASS /default: URxvt) 2343=item --with-res-class=CLASS (default: URxvt)
2305 2344
2306Use the given class as default application class 2345Use the given class as default application class
2307when reading resources. Specify --with-res-class=Rxvt to replace 2346when reading resources. Specify --with-res-class=Rxvt to replace
2308rxvt. 2347rxvt.
2309 2348
… …
2322 2361
2323Write user and tty to lastlog file (used by programs like 2362Write user and tty to lastlog file (used by programs like
2324F<lastlogin>) at start of rxvt execution. This option requires 2363F<lastlogin>) at start of rxvt execution. This option requires
2325--enable-utmp to also be specified. 2364--enable-utmp to also be specified.
2326 2365
2327=item --enable-xpm-background (default: on) 2366=item --enable-afterimage (default: on)
2328 2367
2329Add support for XPM background pixmaps. 2368Add support for libAfterImage to be used for transparency and background
2369images. It adds support for many file formats including JPG, PNG,
2370SVG, TIFF, GIF, XPM, BMP, ICO, XCF, TGA and AfterStep image XML
2371(L<http://www.afterstep.org/visualdoc.php?show=asimagexml>).
2372
2373This option also adds such eye candy as blending an image over the root
2374background, as well as dynamic scaling and bluring of background images.
2375
2376Note that with this option enabled, @@RXVT_NAME@@'s memory footprint might
2377increase by a few megabytes even if no extra features are used (mostly due
2378to third-party libraries used by libAI). Memory footprint may somewhat be
2379lowered if libAfterImage is configured without support for SVG.
2330 2380
2331=item --enable-transparency (default: on) 2381=item --enable-transparency (default: on)
2332 2382
2333Add support for inheriting parent backgrounds thus giving a fake 2383Add support for backgrounds, creating illusion of transparency in the term.
2334transparency to the term.
2335 2384
2336=item --enable-fading (default: on) 2385=item --enable-fading (default: on)
2337 2386
2338Add support for fading the text when focus is lost (requires C<--enable-transparency>). 2387Add support for fading the text when focus is lost.
2339
2340=item --enable-tinting (default: on)
2341
2342Add support for tinting of transparent backgrounds (requires C<--enable-transparency>).
2343 2388
2344=item --enable-rxvt-scroll (default: on) 2389=item --enable-rxvt-scroll (default: on)
2345 2390
2346Add support for the original rxvt scrollbar. 2391Add support for the original rxvt scrollbar.
2347 2392
… …
2350Add support for a NeXT-like scrollbar. 2395Add support for a NeXT-like scrollbar.
2351 2396
2352=item --enable-xterm-scroll (default: on) 2397=item --enable-xterm-scroll (default: on)
2353 2398
2354Add support for an Xterm-like scrollbar. 2399Add support for an Xterm-like scrollbar.
2355
2356=item --enable-plain-scroll (default: on)
2357
2358Add support for a very unobtrusive, plain-looking scrollbar that
2359is the favourite of the rxvt-unicode author, having used it for
2360many years.
2361
2362=item --enable-ttygid (default: off)
2363
2364Change tty device setting to group "tty" - only use this if
2365your system uses this type of security.
2366 2400
2367=item --disable-backspace-key 2401=item --disable-backspace-key
2368 2402
2369Removes any handling of the backspace key by us - let the X server do it. 2403Removes any handling of the backspace key by us - let the X server do it.
2370 2404
… …
2390A non-exhaustive list of features enabled by C<--enable-frills> (possibly 2424A non-exhaustive list of features enabled by C<--enable-frills> (possibly
2391in combination with other switches) is: 2425in combination with other switches) is:
2392 2426
2393 MWM-hints 2427 MWM-hints
2394 EWMH-hints (pid, utf8 names) and protocols (ping) 2428 EWMH-hints (pid, utf8 names) and protocols (ping)
2429 urgency hint
2395 seperate underline colour (-underlineColor) 2430 seperate underline colour (-underlineColor)
2396 settable border widths and borderless switch (-w, -b, -bl) 2431 settable border widths and borderless switch (-w, -b, -bl)
2397 visual depth selection (-depth) 2432 visual depth selection (-depth)
2398 settable extra linespacing /-lsp) 2433 settable extra linespacing /-lsp)
2399 iso-14755-2 and -3, and visual feedback 2434 iso-14755 5.1 (basic) support
2400 tripleclickwords (-tcw) 2435 tripleclickwords (-tcw)
2401 settable insecure mode (-insecure) 2436 settable insecure mode (-insecure)
2402 keysym remapping support 2437 keysym remapping support
2403 cursor blinking and underline cursor (-cb, -uc) 2438 cursor blinking and underline cursor (-cb, -uc)
2404 XEmbed support (-embed) 2439 XEmbed support (-embed)
2405 user-pty (-pty-fd) 2440 user-pty (-pty-fd)
2406 hold on exit (-hold) 2441 hold on exit (-hold)
2442 compile in built-in block graphics
2407 skip builtin block graphics (-sbg) 2443 skip builtin block graphics (-sbg)
2408 separate highlightcolor support (-hc) 2444 separate highlightcolor support (-hc)
2409 2445
2410It also enables some non-essential features otherwise disabled, such as: 2446It also enables some non-essential features otherwise disabled, such as:
2411 2447
2412 some round-trip time optimisations 2448 some round-trip time optimisations
2413 nearest color allocation on pseudocolor screens 2449 nearest color allocation on pseudocolor screens
2414 UTF8_STRING supporr for selection 2450 UTF8_STRING support for selection
2415 sgr modes 90..97 and 100..107 2451 sgr modes 90..97 and 100..107
2416 backindex and forwardindex escape sequences 2452 backindex and forwardindex escape sequences
2417 view change/zero scorllback esacpe sequences 2453 view change/zero scrollback escape sequences
2418 locale switching escape sequence 2454 locale switching escape sequence
2419 window op and some xterm/OSC escape sequences 2455 window op and some xterm/OSC escape sequences
2420 rectangular selections 2456 rectangular selections
2421 trailing space removal for selections 2457 trailing space removal for selections
2422 verbose X error handling 2458 verbose X error handling
… …
2431=item --enable-keepscrolling (default: on) 2467=item --enable-keepscrolling (default: on)
2432 2468
2433Add support for continual scrolling of the display when you hold 2469Add support for continual scrolling of the display when you hold
2434the mouse button down on a scrollbar arrow. 2470the mouse button down on a scrollbar arrow.
2435 2471
2472=item --enable-selectionscrolling (default: on)
2473
2474Add support for scrolling when the selection moves to the top or
2475bottom of the screen.
2476
2436=item --enable-mousewheel (default: on) 2477=item --enable-mousewheel (default: on)
2437 2478
2438Add support for scrolling via mouse wheel or buttons 4 & 5. 2479Add support for scrolling via mouse wheel or buttons 4 & 5.
2439 2480
2440=item --enable-slipwheeling (default: on) 2481=item --enable-slipwheeling (default: on)
2441 2482
2442Add support for continual scrolling (using the mouse wheel as an 2483Add support for continual scrolling (using the mouse wheel as an
2443accelerator) while the control key is held down. This option 2484accelerator) while the control key is held down. This option
2444requires --enable-mousewheel to also be specified. 2485requires --enable-mousewheel to also be specified.
2445 2486
2446=item --disable-new-selection
2447
2448Remove support for mouse selection style like that of xterm.
2449
2450=item --enable-dmalloc (default: off)
2451
2452Use Gray Watson's malloc - which is good for debugging See
2453L<http://www.letters.com/dmalloc/> for details If you use either this or the
2454next option, you may need to edit src/Makefile after compiling to point
2455DINCLUDE and DLIB to the right places.
2456
2457You can only use either this option and the following (should
2458you use either) .
2459
2460=item --enable-dlmalloc (default: off)
2461
2462Use Doug Lea's malloc - which is good for a production version
2463See L<http://g.oswego.edu/dl/html/malloc.html> for details.
2464
2465=item --enable-smart-resize (default: on) 2487=item --enable-smart-resize (default: off)
2466 2488
2467Add smart growth/shrink behaviour when changing font size via hot 2489Add smart growth/shrink behaviour when resizing.
2468keys. This should keep the window corner which is closest to a corner of 2490This should keep the window corner which is closest to a corner of
2469the screen in a fixed position. 2491the screen in a fixed position.
2470 2492
2493=item --enable-text-blink (default: on)
2494
2495Add support for blinking text.
2496
2471=item --enable-pointer-blank (default: on) 2497=item --enable-pointer-blank (default: on)
2472 2498
2473Add support to have the pointer disappear when typing or inactive. 2499Add support to have the pointer disappear when typing or inactive.
2474 2500
2475=item --enable-perl (default: on) 2501=item --enable-perl (default: on)
2476 2502
2477Enable an embedded perl interpreter. See the B<@@RXVT_NAME@@perl(3)> 2503Enable an embedded perl interpreter. See the B<@@RXVT_NAME@@perl(3)>
2478manpage (F<doc/rxvtperl.txt>) for more info on this feature, or the files 2504manpage (F<doc/rxvtperl.txt>) for more info on this feature, or the
2479in F<src/perl-ext/> for the extensions that are installed by default. The 2505files in F<src/perl-ext/> for the extensions that are installed by
2480perl interpreter that is used can be specified via the C<PERL> environment 2506default. The perl interpreter that is used can be specified via the
2481variable when running configure. 2507C<PERL> environment variable when running configure. Even when compiled
2508in, perl will I<not> be initialised when all extensions have been disabled
2509C<-pe "" --perl-ext-common "">, so it should be safe to enable from a
2510resource standpoint.
2511
2512=item --with-afterimage-config=DIR
2513
2514Look for the libAfterImage config script in DIR.
2482 2515
2483=item --with-name=NAME (default: urxvt) 2516=item --with-name=NAME (default: urxvt)
2484 2517
2485Set the basename for the installed binaries, resulting 2518Set the basename for the installed binaries, resulting
2486in C<urxvt>, C<urxvtd> etc.). Specify C<--with-name=rxvt> to replace with 2519in C<urxvt>, C<urxvtd> etc.). Specify C<--with-name=rxvt> to replace with
… …
2496PATH. 2529PATH.
2497 2530
2498=item --with-x 2531=item --with-x
2499 2532
2500Use the X Window System (pretty much default, eh?). 2533Use the X Window System (pretty much default, eh?).
2501
2502=item --with-xpm-includes=DIR
2503
2504Look for the XPM includes in DIR.
2505
2506=item --with-xpm-library=DIR
2507
2508Look for the XPM library in DIR.
2509
2510=item --with-xpm
2511
2512Not needed - define via --enable-xpm-background.
2513 2534
2514=back 2535=back
2515 2536
2516=head1 AUTHORS 2537=head1 AUTHORS
2517 2538

Diff Legend

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