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.123 by root, Sat Dec 16 03:48:49 2006 UTC vs.
Revision 1.165 by ayin, Sun Jan 27 22:48:32 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/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
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
956If you encounter strange problems like typing an accented character but 963If you encounter strange problems like typing an accented character but
957getting two unrelated other characters or similar, or if program output is 964getting two unrelated other characters or similar, or if program output is
958subtly garbled, then you should check your locale settings. 965subtly garbled, then you should check your locale settings.
959 966
960Rxvt-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
961programs. 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,
962login script running within the rxvt-unicode window changes the locale to 969while the login script running within the rxvt-unicode window changes the
963something 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.
964 972
965The 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
966into 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.
967 975
968 printf '\33]701;%s\007' "$LC_CTYPE" 976 printf '\33]701;%s\007' "$LC_CTYPE" # $LANG or $LC_ALL are worth a try, too
969 977
970If 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
971supported on your systems. Some systems have a C<locale> command which 979supported on your systems. Some systems have a C<locale> command which
972displays 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
973it 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
1067C<@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
1068method servers are running with this command: 1076method servers are running with this command:
1069 1077
1070 xprop -root XIM_SERVERS 1078 xprop -root XIM_SERVERS
1071 1079
1072=item 1080=item
1073 1081
1074=back 1082=back
1075 1083
1076=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?
1077 1085
1150This 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
1151and reduces possible bugs to initialisation code run before main(), or 1159and reduces possible bugs to initialisation code run before main(), or
1152things 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
1153little risk. 1161little risk.
1154 1162
1155=head3 On Solaris 9, many line-drawing characters are too wide.
1156
1157Seems to be a known bug, read
1158L<http://nixdoc.net/files/forum/about34198.html>. Some people use the
1159following ugly workaround to get non-double-wide-characters working:
1160
1161 #define wcwidth(x) wcwidth(x) > 1 ? 1 : wcwidth(x)
1162
1163=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.
1164 1164
1165Rxvt-unicode requires the symbol C<__STDC_ISO_10646__> to be defined 1165Rxvt-unicode requires the symbol C<__STDC_ISO_10646__> to be defined
1166in your compile environment, or an implementation that implements it, 1166in your compile environment, or an implementation that implements it,
1167whether 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
1190 1190
1191The 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
1192system 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
1193complete replacements for them :) 1193complete replacements for them :)
1194 1194
1195=head3 I use Solaris 9 and it doesn't compile/work/etc.
1196
1197Try the diff in F<doc/solaris9.patch> as a base. It fixes the worst
1198problems with C<wcwidth> and a compile problem.
1199
1200=head3 How can I use rxvt-unicode under cygwin? 1195=head3 How can I use rxvt-unicode under cygwin?
1201 1196
1202rxvt-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
1203the X11 libraries that come with cygwin. libW11 emulation is no 1198the X11 libraries that come with cygwin. libW11 emulation is no
1204longer supported (and makes no sense, either, as it only supported a 1199longer supported (and makes no sense, either, as it only supported a
1207old libW11 emulation. 1202old libW11 emulation.
1208 1203
1209At 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
1210encodings (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
1211to 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
1212 1220
1213=head1 RXVT-UNICODE TECHNICAL REFERENCE 1221=head1 RXVT-UNICODE TECHNICAL REFERENCE
1214 1222
1215The rest of this document describes various technical aspects of 1223The rest of this document describes various technical aspects of
1216B<rxvt-unicode>. First the description of supported command sequences, 1224B<rxvt-unicode>. First the description of supported command sequences,
1804 1812
1805=item B<< C<Pm = 30> >> 1813=item B<< C<Pm = 30> >>
1806 1814
1807=begin table 1815=begin table
1808 1816
1809 B<< C<h> >> scrollBar visisble 1817 B<< C<h> >> scrollBar visible
1810 B<< C<l> >> scrollBar invisisble 1818 B<< C<l> >> scrollBar invisible
1811 1819
1812=end table 1820=end table
1813 1821
1814=item B<< C<Pm = 35> >> (B<rxvt>) 1822=item B<< C<Pm = 35> >> (B<rxvt>)
1815 1823
1898 B<< C<h> >> Use Hilite Mouse Tracking. 1906 B<< C<h> >> Use Hilite Mouse Tracking.
1899 B<< C<l> >> No mouse reporting. 1907 B<< C<l> >> No mouse reporting.
1900 1908
1901=end table 1909=end table
1902 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
1903=item B<< C<Pm = 1010> >> (B<rxvt>) 1929=item B<< C<Pm = 1010> >> (B<rxvt>)
1904 1930
1905=begin table 1931=begin table
1906 1932
1907 B<< C<h> >> Don't scroll to bottom on TTY output 1933 B<< C<h> >> Don't scroll to bottom on TTY output
1949 1975
1950=begin table 1976=begin table
1951 1977
1952 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
1953 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
1954 1989
1955=end table 1990=end table
1956 1991
1957=back 1992=back
1958 1993
1975 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> >>
1976 B<< C<Ps = 1> >> Change Icon Name to B<< C<Pt> >> 2011 B<< C<Ps = 1> >> Change Icon Name to B<< C<Pt> >>
1977 B<< C<Ps = 2> >> Change Window Title to B<< C<Pt> >> 2012 B<< C<Ps = 2> >> Change Window Title to B<< C<Pt> >>
1978 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.
1979 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
1980 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> >>
1981 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> >>
1982 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> >>
1983 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> >>
1984 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> >>
1985 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]
1986 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]
1987 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).
1988 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]
1989 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>
1990 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]
1991 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> >>
1992 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]
1993 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).
1994 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>.
1995 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> >>
1996 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).
1997 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> >>
2006 2041
2007=end table 2042=end table
2008 2043
2009=back 2044=back
2010 2045
2011=head1 XPM 2046=head1 BACKGROUND IMAGE
2012 2047
2013For 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
2014of 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
2015sequence of scaling/positioning commands separated by semi-colons. The 2050sequence of scaling/positioning commands separated by semi-colons. The
2016scaling/positioning commands are as follows: 2051scaling/positioning commands are as follows:
2017 2052
2018=over 4 2053=over 4
2019 2054
2057 2092
2058For example: 2093For example:
2059 2094
2060=over 4 2095=over 4
2061 2096
2062=item B<\E]20;funky\a> 2097=item B<\E]20;funky.jpg\a>
2063 2098
2064load B<funky.xpm> as a tiled image 2099load B<funky.jpg> as a tiled image
2065 2100
2066=item B<\E]20;mona;100\a> 2101=item B<\E]20;mona.jpg;100\a>
2067 2102
2068load B<mona.xpm> with a scaling of 100% 2103load B<mona.jpg> with a scaling of 100%
2069 2104
2070=item B<\E]20;;200;?\a> 2105=item B<\E]20;;200;?\a>
2071 2106
2072rescale the current pixmap to 200% and display the image geometry in 2107rescale the current pixmap to 200% and display the image geometry in
2073the title 2108the title
2200 2235
2201=head1 CONFIGURE OPTIONS 2236=head1 CONFIGURE OPTIONS
2202 2237
2203General hint: if you get compile errors, then likely your configuration 2238General hint: if you get compile errors, then likely your configuration
2204hasn't been tested well. Either try with C<--enable-everything> or use 2239hasn't been tested well. Either try with C<--enable-everything> or use
2205the F<./reconf> script as a base for experiments. F<./reconf> is used by 2240the default configuration (i.e. no C<--enable-xxx> or C<--disable-xxx>
2206myself, so it should generally be a working config. Of course, you should 2241switches). Of course, you should always report when a combination doesn't
2207always report when a combination doesn't work, so it can be fixed. Marc 2242work, so it can be fixed. Marc Lehmann <rxvt@schmorp.de>.
2208Lehmann <rxvt@schmorp.de>.
2209 2243
2210All 2244All
2211 2245
2212=over 4 2246=over 4
2213 2247
2245 2279
2246=begin table 2280=begin table
2247 2281
2248 all all available codeset groups 2282 all all available codeset groups
2249 zh common chinese encodings 2283 zh common chinese encodings
2250 zh_ext rarely used but very big chinese encodigs 2284 zh_ext rarely used but very big chinese encodings
2251 jp common japanese encodings 2285 jp common japanese encodings
2252 jp_ext rarely used but big japanese encodings 2286 jp_ext rarely used but big japanese encodings
2253 kr korean encodings 2287 kr korean encodings
2254 2288
2255=end table 2289=end table
2269requirements per character from 2 to 4 bytes. X11 fonts do not yet 2303requirements per character from 2 to 4 bytes. X11 fonts do not yet
2270support these extra characters, but Xft does. 2304support these extra characters, but Xft does.
2271 2305
2272Please note that rxvt-unicode can store unicode code points >65535 2306Please note that rxvt-unicode can store unicode code points >65535
2273even without this flag, but the number of such characters is 2307even without this flag, but the number of such characters is
2274limited to a view thousand (shared with combining characters, 2308limited to a few thousand (shared with combining characters,
2275see next switch), and right now rxvt-unicode cannot display them 2309see next switch), and right now rxvt-unicode cannot display them
2276(input/output and cut&paste still work, though). 2310(input/output and cut&paste still work, though).
2277 2311
2278=item --enable-combining (default: on) 2312=item --enable-combining (default: on)
2279 2313
2302=item --with-res-name=NAME (default: urxvt) 2336=item --with-res-name=NAME (default: urxvt)
2303 2337
2304Use the given name as default application name when 2338Use the given name as default application name when
2305reading resources. Specify --with-res-name=rxvt to replace rxvt. 2339reading resources. Specify --with-res-name=rxvt to replace rxvt.
2306 2340
2307=item --with-res-class=CLASS /default: URxvt) 2341=item --with-res-class=CLASS (default: URxvt)
2308 2342
2309Use the given class as default application class 2343Use the given class as default application class
2310when reading resources. Specify --with-res-class=Rxvt to replace 2344when reading resources. Specify --with-res-class=Rxvt to replace
2311rxvt. 2345rxvt.
2312 2346
2325 2359
2326Write user and tty to lastlog file (used by programs like 2360Write user and tty to lastlog file (used by programs like
2327F<lastlogin>) at start of rxvt execution. This option requires 2361F<lastlogin>) at start of rxvt execution. This option requires
2328--enable-utmp to also be specified. 2362--enable-utmp to also be specified.
2329 2363
2330=item --enable-xpm-background (default: on) 2364=item --enable-afterimage (default: on)
2331 2365
2332Add support for XPM background pixmaps. 2366Add support for libAfterImage to be used for transparency and background
2367images. It adds support for many file formats including JPG, PNG,
2368SVG, TIFF, GIF, XPM, BMP, ICO, XCF, TGA and AfterStep image XML
2369(L<http://www.afterstep.org/visualdoc.php?show=asimagexml>).
2370
2371This option also adds such eye candy as blending an image over the root
2372background, as well as dynamic scaling and bluring of background images.
2373
2374Note that with this option enabled, @@RXVT_NAME@@'s memory footprint might
2375increase by a few megabytes even if no extra features are used (mostly due
2376to third-party libraries used by libAI). Memory footprint may somewhat be
2377lowered if libAfterImage is configured without support for SVG.
2333 2378
2334=item --enable-transparency (default: on) 2379=item --enable-transparency (default: on)
2335 2380
2336Add support for inheriting parent backgrounds thus giving a fake 2381Add support for backgrounds, creating illusion of transparency in the term.
2337transparency to the term.
2338 2382
2339=item --enable-fading (default: on) 2383=item --enable-fading (default: on)
2340 2384
2341Add support for fading the text when focus is lost (requires C<--enable-transparency>). 2385Add 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 2386
2347=item --enable-rxvt-scroll (default: on) 2387=item --enable-rxvt-scroll (default: on)
2348 2388
2349Add support for the original rxvt scrollbar. 2389Add support for the original rxvt scrollbar.
2350 2390
2353Add support for a NeXT-like scrollbar. 2393Add support for a NeXT-like scrollbar.
2354 2394
2355=item --enable-xterm-scroll (default: on) 2395=item --enable-xterm-scroll (default: on)
2356 2396
2357Add support for an Xterm-like scrollbar. 2397Add 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 2398
2370=item --disable-backspace-key 2399=item --disable-backspace-key
2371 2400
2372Removes any handling of the backspace key by us - let the X server do it. 2401Removes any handling of the backspace key by us - let the X server do it.
2373 2402
2393A non-exhaustive list of features enabled by C<--enable-frills> (possibly 2422A non-exhaustive list of features enabled by C<--enable-frills> (possibly
2394in combination with other switches) is: 2423in combination with other switches) is:
2395 2424
2396 MWM-hints 2425 MWM-hints
2397 EWMH-hints (pid, utf8 names) and protocols (ping) 2426 EWMH-hints (pid, utf8 names) and protocols (ping)
2427 urgency hint
2398 seperate underline colour (-underlineColor) 2428 seperate underline colour (-underlineColor)
2399 settable border widths and borderless switch (-w, -b, -bl) 2429 settable border widths and borderless switch (-w, -b, -bl)
2400 visual depth selection (-depth) 2430 visual depth selection (-depth)
2401 settable extra linespacing /-lsp) 2431 settable extra linespacing /-lsp)
2402 iso-14755-2 and -3, and visual feedback 2432 iso-14755 5.1 (basic) support
2403 tripleclickwords (-tcw) 2433 tripleclickwords (-tcw)
2404 settable insecure mode (-insecure) 2434 settable insecure mode (-insecure)
2405 keysym remapping support 2435 keysym remapping support
2406 cursor blinking and underline cursor (-cb, -uc) 2436 cursor blinking and underline cursor (-cb, -uc)
2407 XEmbed support (-embed) 2437 XEmbed support (-embed)
2408 user-pty (-pty-fd) 2438 user-pty (-pty-fd)
2409 hold on exit (-hold) 2439 hold on exit (-hold)
2440 compile in built-in block graphics
2410 skip builtin block graphics (-sbg) 2441 skip builtin block graphics (-sbg)
2411 separate highlightcolor support (-hc) 2442 separate highlightcolor support (-hc)
2412 2443
2413It also enables some non-essential features otherwise disabled, such as: 2444It also enables some non-essential features otherwise disabled, such as:
2414 2445
2415 some round-trip time optimisations 2446 some round-trip time optimisations
2416 nearest color allocation on pseudocolor screens 2447 nearest color allocation on pseudocolor screens
2417 UTF8_STRING supporr for selection 2448 UTF8_STRING support for selection
2418 sgr modes 90..97 and 100..107 2449 sgr modes 90..97 and 100..107
2419 backindex and forwardindex escape sequences 2450 backindex and forwardindex escape sequences
2420 view change/zero scorllback esacpe sequences 2451 view change/zero scrollback escape sequences
2421 locale switching escape sequence 2452 locale switching escape sequence
2422 window op and some xterm/OSC escape sequences 2453 window op and some xterm/OSC escape sequences
2423 rectangular selections 2454 rectangular selections
2424 trailing space removal for selections 2455 trailing space removal for selections
2425 verbose X error handling 2456 verbose X error handling
2434=item --enable-keepscrolling (default: on) 2465=item --enable-keepscrolling (default: on)
2435 2466
2436Add support for continual scrolling of the display when you hold 2467Add support for continual scrolling of the display when you hold
2437the mouse button down on a scrollbar arrow. 2468the mouse button down on a scrollbar arrow.
2438 2469
2470=item --enable-selectionscrolling (default: on)
2471
2472Add support for scrolling when the selection moves to the top or
2473bottom of the screen.
2474
2439=item --enable-mousewheel (default: on) 2475=item --enable-mousewheel (default: on)
2440 2476
2441Add support for scrolling via mouse wheel or buttons 4 & 5. 2477Add support for scrolling via mouse wheel or buttons 4 & 5.
2442 2478
2443=item --enable-slipwheeling (default: on) 2479=item --enable-slipwheeling (default: on)
2444 2480
2445Add support for continual scrolling (using the mouse wheel as an 2481Add support for continual scrolling (using the mouse wheel as an
2446accelerator) while the control key is held down. This option 2482accelerator) while the control key is held down. This option
2447requires --enable-mousewheel to also be specified. 2483requires --enable-mousewheel to also be specified.
2448 2484
2449=item --disable-new-selection
2450
2451Remove support for mouse selection style like that of xterm.
2452
2453=item --enable-dmalloc (default: off)
2454
2455Use Gray Watson's malloc - which is good for debugging See
2456L<http://www.letters.com/dmalloc/> for details If you use either this or the
2457next option, you may need to edit src/Makefile after compiling to point
2458DINCLUDE and DLIB to the right places.
2459
2460You can only use either this option and the following (should
2461you use either) .
2462
2463=item --enable-dlmalloc (default: off)
2464
2465Use Doug Lea's malloc - which is good for a production version
2466See L<http://g.oswego.edu/dl/html/malloc.html> for details.
2467
2468=item --enable-smart-resize (default: on) 2485=item --enable-smart-resize (default: off)
2469 2486
2470Add smart growth/shrink behaviour when changing font size via hot 2487Add smart growth/shrink behaviour when resizing.
2471keys. This should keep the window corner which is closest to a corner of 2488This should keep the window corner which is closest to a corner of
2472the screen in a fixed position. 2489the screen in a fixed position.
2473 2490
2491=item --enable-text-blink (default: on)
2492
2493Add support for blinking text.
2494
2474=item --enable-pointer-blank (default: on) 2495=item --enable-pointer-blank (default: on)
2475 2496
2476Add support to have the pointer disappear when typing or inactive. 2497Add support to have the pointer disappear when typing or inactive.
2477 2498
2478=item --enable-perl (default: on) 2499=item --enable-perl (default: on)
2479 2500
2480Enable an embedded perl interpreter. See the B<@@RXVT_NAME@@perl(3)> 2501Enable an embedded perl interpreter. See the B<@@RXVT_NAME@@perl(3)>
2481manpage (F<doc/rxvtperl.txt>) for more info on this feature, or the files 2502manpage (F<doc/rxvtperl.txt>) for more info on this feature, or the
2482in F<src/perl-ext/> for the extensions that are installed by default. The 2503files in F<src/perl-ext/> for the extensions that are installed by
2483perl interpreter that is used can be specified via the C<PERL> environment 2504default. The perl interpreter that is used can be specified via the
2484variable when running configure. 2505C<PERL> environment variable when running configure. Even when compiled
2506in, perl will I<not> be initialised when all extensions have been disabled
2507C<-pe "" --perl-ext-common "">, so it should be safe to enable from a
2508resource standpoint.
2509
2510=item --with-afterimage-config=DIR
2511
2512Look for the libAfterImage config script in DIR.
2485 2513
2486=item --with-name=NAME (default: urxvt) 2514=item --with-name=NAME (default: urxvt)
2487 2515
2488Set the basename for the installed binaries, resulting 2516Set the basename for the installed binaries, resulting
2489in C<urxvt>, C<urxvtd> etc.). Specify C<--with-name=rxvt> to replace with 2517in C<urxvt>, C<urxvtd> etc.). Specify C<--with-name=rxvt> to replace with
2499PATH. 2527PATH.
2500 2528
2501=item --with-x 2529=item --with-x
2502 2530
2503Use the X Window System (pretty much default, eh?). 2531Use the X Window System (pretty much default, eh?).
2504
2505=item --with-xpm-includes=DIR
2506
2507Look for the XPM includes in DIR.
2508
2509=item --with-xpm-library=DIR
2510
2511Look for the XPM library in DIR.
2512
2513=item --with-xpm
2514
2515Not needed - define via --enable-xpm-background.
2516 2532
2517=back 2533=back
2518 2534
2519=head1 AUTHORS 2535=head1 AUTHORS
2520 2536

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines