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.156 by ayin, Mon Dec 10 19:06:55 2007 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://cvs.schmorp.de/browse/rxvt-unicode/doc/rxvt.7.html>.
23 23
24=head1 RXVT-UNICODE/URXVT FREQUENTLY ASKED QUESTIONS 24=head1 RXVT-UNICODE/URXVT FREQUENTLY ASKED QUESTIONS
25 25
26 26
27=head2 Meta, Features & Commandline Issues 27=head2 Meta, Features & Commandline Issues
73=head3 How can I start @@URXVT_NAME@@d in a race-free way? 73=head3 How can I start @@URXVT_NAME@@d in a race-free way?
74 74
75Try C<@@URXVT_NAME@@d -f -o>, which tells @@URXVT_NAME@@d to open the 75Try C<@@URXVT_NAME@@d -f -o>, which tells @@URXVT_NAME@@d to open the
76display, create the listening socket and then fork. 76display, create the listening socket and then fork.
77 77
78=head3 How can I start @@URXVT_NAME@@d automatically when I run URXVT_NAME@@c? 78=head3 How can I start @@URXVT_NAME@@d automatically when I run @@URXVT_NAME@@c?
79 79
80If you want to start @@URXVT_NAME@@d automatically whenever you run 80If 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: 81@@URXVT_NAME@@c and the daemon isn't running yet, use this script:
82 82
83 #!/bin/sh 83 #!/bin/sh
125 fi 125 fi
126 126
127=head3 How do I compile the manual pages on my own? 127=head3 How do I compile the manual pages on my own?
128 128
129You need to have a recent version of perl installed as F</usr/bin/perl>, 129You 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 130one that comes with F<pod2man>, F<pod2text> and F<pod2xhtml> (from
131the doc subdirectory and enter C<make alldoc>. 131F<Pod::Xhtml>). Then go to the doc subdirectory and enter C<make alldoc>.
132 132
133=head3 Isn't rxvt-unicode supposed to be small? Don't all those features bloat? 133=head3 Isn't rxvt-unicode supposed to be small? Don't all those features bloat?
134 134
135I often get asked about this, and I think, no, they didn't cause extra 135I 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 136bloat. If you compare a minimal rxvt and a minimal urxvt, you can see
197 197
198And here is rxvt-unicode: 198And here is rxvt-unicode:
199 199
200 libX11.so.6 => /usr/X11R6/lib/libX11.so.6 (0x00002aaaaabc3000) 200 libX11.so.6 => /usr/X11R6/lib/libX11.so.6 (0x00002aaaaabc3000)
201 libgcc_s.so.1 => /lib/libgcc_s.so.1 (0x00002aaaaada2000) 201 libgcc_s.so.1 => /lib/libgcc_s.so.1 (0x00002aaaaada2000)
202 libc.so.6 => /lib/libc.so.6 (0x00002aaaaaeb0000) 202 libc.so.6 => /lib/libc.so.6 (0x00002aaaaaeb0000)
203 libdl.so.2 => /lib/libdl.so.2 (0x00002aaaab0ee000) 203 libdl.so.2 => /lib/libdl.so.2 (0x00002aaaab0ee000)
204 /lib64/ld-linux-x86-64.so.2 (0x00002aaaaaaab000) 204 /lib64/ld-linux-x86-64.so.2 (0x00002aaaaaaab000)
205 205
206No large bloated libraries (of course, none were linked in statically), 206No large bloated libraries (of course, none were linked in statically),
207except maybe libX11 :) 207except maybe libX11 :)
208 208
209 209
210=head2 Rendering, Font & Look and Feel Issues 210=head2 Rendering, Font & Look and Feel Issues
211 211
212=head3 I can't get transparency working, what am I doing wrong? 212=head3 I can't get transparency working, what am I doing wrong?
213 213
214First of all, transparency isn't officially supported in rxvt-unicode, so 214First 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 215sasha@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 216get it working consider it a rite of passage: ... and you failed.
217of passage: ... and you failed.
218 217
219Here are four ways to get transparency. B<Do> read the manpage and option 218Here are four ways to get transparency. B<Do> read the manpage and option
220descriptions for the programs mentioned and rxvt-unicode. Really, do it! 219descriptions for the programs mentioned and rxvt-unicode. Really, do it!
221 220
2221. Use inheritPixmap: 2211. Use transparent mode:
223 222
224 Esetroot wallpaper.jpg 223 Esetroot wallpaper.jpg
225 @@URXVT_NAME@@ -ip -tint red -sh 40 224 @@URXVT_NAME@@ -tr -tint red -sh 40
226 225
227That works. If you think it doesn't, you lack transparency and tinting 226That works. If you think it doesn't, you lack transparency and tinting
228support, or you are unable to read. 227support, or you are unable to read.
229 228
2302. Use a simple pixmap and emulate pseudo-transparency. This enables you 2292. Use a simple pixmap and emulate pseudo-transparency. This enables you
231to use effects other than tinting and shading: Just shade/tint/whatever 230to use effects other than tinting and shading: Just shade/tint/whatever
232your picture with gimp or any other tool: 231your picture with gimp or any other tool:
233 232
234 convert wallpaper.jpg -blur 20x20 -modulate 30 background.xpm 233 convert wallpaper.jpg -blur 20x20 -modulate 30 background.jpg
235 @@URXVT_NAME@@ -pixmap background.xpm -pe automove-background 234 @@URXVT_NAME@@ -pixmap "background.jpg;:root"
236 235
237That works. If you think it doesn't, you lack XPM and Perl support, or you 236That works. If you think it doesn't, you lack AfterImage support, or you
238are unable to read. 237are unable to read.
239 238
2403. Use an ARGB visual: 2393. Use an ARGB visual:
241 240
242 @@URXVT_NAME@@ -depth 32 -fg grey90 -bg rgba:0000/0000/4444/cccc 241 @@URXVT_NAME@@ -depth 32 -fg grey90 -bg rgba:0000/0000/4444/cccc
342=head3 What's with this bold/blink stuff? 341=head3 What's with this bold/blink stuff?
343 342
344If no bold colour is set via C<colorBD:>, bold will invert text using the 343If no bold colour is set via C<colorBD:>, bold will invert text using the
345standard foreground colour. 344standard foreground colour.
346 345
347For the standard background colour, blinking will actually make the 346For the standard background colour, blinking will actually make
348text blink when compiled with C<--enable-blinking>. with standard 347the text blink when compiled with C<--enable-text-blink>. Without
349colours. Without C<--enable-blinking>, the blink attribute will be 348C<--enable-text-blink>, the blink attribute will be ignored.
350ignored.
351 349
352On ANSI colours, bold/blink attributes are used to set high-intensity 350On ANSI colours, bold/blink attributes are used to set high-intensity
353foreground/background colors. 351foreground/background colors.
354 352
355color0-7 are the low-intensity colors. 353color0-7 are the low-intensity colors.
460has been designed yet). 458has been designed yet).
461 459
462Until then, you might get away with switching fonts at runtime (see L<Can 460Until then, you might get away with switching fonts at runtime (see L<Can
463I switch the fonts at runtime?> later in this document). 461I switch the fonts at runtime?> later in this document).
464 462
463=head3 How can I make mplayer display video correctly?
464
465We are working on it, in the meantime, as a workaround, use something like:
466
467 @@URXVT_NAME@@ -b 600 -geometry 20x1 -e sh -c 'mplayer -wid $WINDOWID file...'
468
469
465=head2 Keyboard, Mouse & User Interaction 470=head2 Keyboard, Mouse & User Interaction
466 471
467=head3 The new selection selects pieces that are too big, how can I select single words? 472=head3 The new selection selects pieces that are too big, how can I select single words?
468 473
469If you want to select e.g. alphanumeric words, you can use the following 474If you want to select e.g. alphanumeric words, you can use the following
562Backspace keysym (not likely for Linux ... see the following 567Backspace keysym (not likely for Linux ... see the following
563question) there are two standard values that can be used for 568question) there are two standard values that can be used for
564Backspace: C<^H> and C<^?>. 569Backspace: C<^H> and C<^?>.
565 570
566Historically, either value is correct, but rxvt-unicode adopts the debian 571Historically, either value is correct, but rxvt-unicode adopts the debian
567policy of using C<^?> when unsure, because it's the one only only correct 572policy of using C<^?> when unsure, because it's the one and only correct
568choice :). 573choice :).
569 574
570Rxvt-unicode tries to inherit the current stty settings and uses the value 575Rxvt-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 576of `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 577started 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 609key has been assigned an escape sequence to match the vt100 for Execute
605(C<ESC [ 3 ~>) and is in the supplied termcap/terminfo. 610(C<ESC [ 3 ~>) and is in the supplied termcap/terminfo.
606 611
607Some other Backspace problems: 612Some other Backspace problems:
608 613
609some editors use termcap/terminfo, 614some editors use termcap/terminfo,
610some editors (vim I'm told) expect Backspace = ^H, 615some editors (vim I'm told) expect Backspace = ^H,
611GNU Emacs (and Emacs-like editors) use ^H for help. 616GNU Emacs (and Emacs-like editors) use ^H for help.
612 617
613Perhaps someday this will all be resolved in a consistent manner. 618Perhaps someday this will all be resolved in a consistent manner.
614 619
655Rather than have rxvt-unicode try to accommodate all the various possible 660Rather than have rxvt-unicode try to accommodate all the various possible
656keyboard mappings, it is better to use `xmodmap' to remap the keys as 661keyboard mappings, it is better to use `xmodmap' to remap the keys as
657required for your particular machine. 662required for your particular machine.
658 663
659 664
660
661=head2 Terminal Configuration 665=head2 Terminal Configuration
662 666
663=head3 Can I see a typical configuration? 667=head3 Can I see a typical configuration?
664 668
665The default configuration tries to be xterm-like, which I don't like that 669The default configuration tries to be xterm-like, which I don't like that
838 842
839The terminal description used by rxvt-unicode is not as widely available 843The 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). 844as that for xterm, or even rxvt (for which the same problem often arises).
841 845
842The correct solution for this problem is to install the terminfo, this can 846The correct solution for this problem is to install the terminfo, this can
843be done like this (with ncurses' infocmp): 847be done like this (with ncurses' infocmp and works as user and admin):
844 848
845 REMOTE=remotesystem.domain 849 REMOTE=remotesystem.domain
846 infocmp rxvt-unicode | ssh $REMOTE "cat >/tmp/ti && tic /tmp/ti" 850 infocmp rxvt-unicode | ssh $REMOTE "mkdir -p .terminfo && cat >/tmp/ti && tic /tmp/ti"
847 851
848... or by installing rxvt-unicode normally on the remote system, 852... or by installing rxvt-unicode normally on the remote system,
853
854One some systems you might need to set C<$TERMINFO> to the full path of
855F<$HOME/.terminfo> for this to work.
849 856
850If you cannot or do not want to do this, then you can simply set 857If 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 858C<TERM=rxvt> or even C<TERM=xterm>, and live with the small number of
852problems arising, which includes wrong keymapping, less and different 859problems arising, which includes wrong keymapping, less and different
853colours and some refresh errors in fullscreen applications. It's a nice 860colours and some refresh errors in fullscreen applications. It's a nice
953If you encounter strange problems like typing an accented character but 960If you encounter strange problems like typing an accented character but
954getting two unrelated other characters or similar, or if program output is 961getting two unrelated other characters or similar, or if program output is
955subtly garbled, then you should check your locale settings. 962subtly garbled, then you should check your locale settings.
956 963
957Rxvt-unicode must be started with the same C<LC_CTYPE> setting as the 964Rxvt-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 965programs 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 966while 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. 967locale to something else, e.g. C<en_GB.UTF-8>. Needless to say, this is
968not going to work, and is the most common cause for problems.
961 969
962The best thing is to fix your startup environment, as you will likely run 970The 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. 971into other problems. If nothing works you can try this in your .profile.
964 972
965 printf '\33]701;%s\007' "$LC_CTYPE" 973 printf '\33]701;%s\007' "$LC_CTYPE" # $LANG or $LC_ALL are worth a try, too
966 974
967If this doesn't work, then maybe you use a C<LC_CTYPE> specification not 975If 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 976supported 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 977displays 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 978it 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 1072C<@im=kinput2>. For B<scim>, use C<@im=SCIM>. You can see what input
1065method servers are running with this command: 1073method servers are running with this command:
1066 1074
1067 xprop -root XIM_SERVERS 1075 xprop -root XIM_SERVERS
1068 1076
1069=item 1077=item
1070 1078
1071=back 1079=back
1072 1080
1073=head3 My input method wants <some encoding> but I want UTF-8, what can I do? 1081=head3 My input method wants <some encoding> but I want UTF-8, what can I do?
1074 1082
1147This forking is done as the very first within main(), which is very early 1155This forking is done as the very first within main(), which is very early
1148and reduces possible bugs to initialisation code run before main(), or 1156and reduces possible bugs to initialisation code run before main(), or
1149things like the dynamic loader of your system, which should result in very 1157things like the dynamic loader of your system, which should result in very
1150little risk. 1158little risk.
1151 1159
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. 1160=head3 I am on FreeBSD and rxvt-unicode does not seem to work at all.
1161 1161
1162Rxvt-unicode requires the symbol C<__STDC_ISO_10646__> to be defined 1162Rxvt-unicode requires the symbol C<__STDC_ISO_10646__> to be defined
1163in your compile environment, or an implementation that implements it, 1163in your compile environment, or an implementation that implements it,
1164whether it defines the symbol or not. C<__STDC_ISO_10646__> requires that 1164whether it defines the symbol or not. C<__STDC_ISO_10646__> requires that
1187 1187
1188The rxvt-unicode author insists that the right way to fix this is in the 1188The 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 1189system libraries once and for all, instead of forcing every app to carry
1190complete replacements for them :) 1190complete replacements for them :)
1191 1191
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? 1192=head3 How can I use rxvt-unicode under cygwin?
1198 1193
1199rxvt-unicode should compile and run out of the box on cygwin, using 1194rxvt-unicode should compile and run out of the box on cygwin, using
1200the X11 libraries that come with cygwin. libW11 emulation is no 1195the X11 libraries that come with cygwin. libW11 emulation is no
1201longer supported (and makes no sense, either, as it only supported a 1196longer supported (and makes no sense, either, as it only supported a
1204old libW11 emulation. 1199old libW11 emulation.
1205 1200
1206At the time of this writing, cygwin didn't seem to support any multi-byte 1201At 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 1202encodings (you might try C<LC_CTYPE=C-UTF-8>), so you are likely limited
1208to 8-bit encodings. 1203to 8-bit encodings.
1204
1205=head3 Character widths are not correct.
1206
1207urxvt uses the system wcwidth function to know the information about
1208the width of characters, so on systems with incorrect locale data you
1209will likely get bad results. Two notorious examples are Solaris 9,
1210where single-width characters like U+2514 are reported as double-width,
1211and Darwin 8, where combining chars are reported having width 1.
1212
1213The solution is to upgrade your system or switch to a better one. A
1214possibly working workaround is to use a wcwidth implementation like
1215
1216http://www.cl.cam.ac.uk/~mgk25/ucs/wcwidth.c
1209 1217
1210=head1 RXVT-UNICODE TECHNICAL REFERENCE 1218=head1 RXVT-UNICODE TECHNICAL REFERENCE
1211 1219
1212The rest of this document describes various technical aspects of 1220The rest of this document describes various technical aspects of
1213B<rxvt-unicode>. First the description of supported command sequences, 1221B<rxvt-unicode>. First the description of supported command sequences,
1895 B<< C<h> >> Use Hilite Mouse Tracking. 1903 B<< C<h> >> Use Hilite Mouse Tracking.
1896 B<< C<l> >> No mouse reporting. 1904 B<< C<l> >> No mouse reporting.
1897 1905
1898=end table 1906=end table
1899 1907
1908=item B<< C<Pm = 1002> >> (X11 XTerm)
1909
1910=begin table
1911
1912 B<< C<h> >> Send Mouse X & Y on button press and release, and motion with a button pressed.
1913 B<< C<l> >> No mouse reporting.
1914
1915=end table
1916
1917=item B<< C<Pm = 1003> >> (X11 XTerm)
1918
1919=begin table
1920
1921 B<< C<h> >> Send Mouse X & Y on button press and release, and motion.
1922 B<< C<l> >> No mouse reporting.
1923
1924=end table
1925
1900=item B<< C<Pm = 1010> >> (B<rxvt>) 1926=item B<< C<Pm = 1010> >> (B<rxvt>)
1901 1927
1902=begin table 1928=begin table
1903 1929
1904 B<< C<h> >> Don't scroll to bottom on TTY output 1930 B<< C<h> >> Don't scroll to bottom on TTY output
1979 B<< C<Ps = 12> >> Change colour of text cursor foreground to B<< C<Pt> >> 2005 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> >> 2006 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> >> 2007 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] 2008 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] 2009 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). 2010 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> >>. 2011 B<< C<Ps = 39> >> Change default foreground colour to B<< C<Pt> >>.
1986 B<< C<Ps = 46> >> Change Log File to B<< C<Pt> >> I<unimplemented> 2012 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> >>. 2013 B<< C<Ps = 49> >> Change default background colour to B<< C<Pt> >>.
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> >> 2014 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> >> 2015 B<< C<Ps = 55> >> Log all scrollback buffer and all of screen to B<< C<Pt> >>
2003 2029
2004=end table 2030=end table
2005 2031
2006=back 2032=back
2007 2033
2008=head1 XPM 2034=head1 BACKGROUND IMAGE
2009 2035
2010For the XPM XTerm escape sequence B<< C<ESC ] 20 ; Pt ST> >> then value 2036For the BACGROUND IMAGE XTerm escape sequence B<< C<ESC ] 20 ; Pt ST> >> then value
2011of B<< C<Pt> >> can be the name of the background pixmap followed by a 2037of 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 2038sequence of scaling/positioning commands separated by semi-colons. The
2013scaling/positioning commands are as follows: 2039scaling/positioning commands are as follows:
2014 2040
2015=over 4 2041=over 4
2016 2042
2054 2080
2055For example: 2081For example:
2056 2082
2057=over 4 2083=over 4
2058 2084
2059=item B<\E]20;funky\a> 2085=item B<\E]20;funky.jpg\a>
2060 2086
2061load B<funky.xpm> as a tiled image 2087load B<funky.jpg> as a tiled image
2062 2088
2063=item B<\E]20;mona;100\a> 2089=item B<\E]20;mona.jpg;100\a>
2064 2090
2065load B<mona.xpm> with a scaling of 100% 2091load B<mona.jpg> with a scaling of 100%
2066 2092
2067=item B<\E]20;;200;?\a> 2093=item B<\E]20;;200;?\a>
2068 2094
2069rescale the current pixmap to 200% and display the image geometry in 2095rescale the current pixmap to 200% and display the image geometry in
2070the title 2096the title
2197 2223
2198=head1 CONFIGURE OPTIONS 2224=head1 CONFIGURE OPTIONS
2199 2225
2200General hint: if you get compile errors, then likely your configuration 2226General hint: if you get compile errors, then likely your configuration
2201hasn't been tested well. Either try with C<--enable-everything> or use 2227hasn'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 2228the 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 2229switches). 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 2230work, so it can be fixed. Marc Lehmann <rxvt@schmorp.de>.
2205Lehmann <rxvt@schmorp.de>.
2206 2231
2207All 2232All
2208 2233
2209=over 4 2234=over 4
2210 2235
2242 2267
2243=begin table 2268=begin table
2244 2269
2245 all all available codeset groups 2270 all all available codeset groups
2246 zh common chinese encodings 2271 zh common chinese encodings
2247 zh_ext rarely used but very big chinese encodigs 2272 zh_ext rarely used but very big chinese encodings
2248 jp common japanese encodings 2273 jp common japanese encodings
2249 jp_ext rarely used but big japanese encodings 2274 jp_ext rarely used but big japanese encodings
2250 kr korean encodings 2275 kr korean encodings
2251 2276
2252=end table 2277=end table
2266requirements per character from 2 to 4 bytes. X11 fonts do not yet 2291requirements per character from 2 to 4 bytes. X11 fonts do not yet
2267support these extra characters, but Xft does. 2292support these extra characters, but Xft does.
2268 2293
2269Please note that rxvt-unicode can store unicode code points >65535 2294Please note that rxvt-unicode can store unicode code points >65535
2270even without this flag, but the number of such characters is 2295even without this flag, but the number of such characters is
2271limited to a view thousand (shared with combining characters, 2296limited to a few thousand (shared with combining characters,
2272see next switch), and right now rxvt-unicode cannot display them 2297see next switch), and right now rxvt-unicode cannot display them
2273(input/output and cut&paste still work, though). 2298(input/output and cut&paste still work, though).
2274 2299
2275=item --enable-combining (default: on) 2300=item --enable-combining (default: on)
2276 2301
2299=item --with-res-name=NAME (default: urxvt) 2324=item --with-res-name=NAME (default: urxvt)
2300 2325
2301Use the given name as default application name when 2326Use the given name as default application name when
2302reading resources. Specify --with-res-name=rxvt to replace rxvt. 2327reading resources. Specify --with-res-name=rxvt to replace rxvt.
2303 2328
2304=item --with-res-class=CLASS /default: URxvt) 2329=item --with-res-class=CLASS (default: URxvt)
2305 2330
2306Use the given class as default application class 2331Use the given class as default application class
2307when reading resources. Specify --with-res-class=Rxvt to replace 2332when reading resources. Specify --with-res-class=Rxvt to replace
2308rxvt. 2333rxvt.
2309 2334
2322 2347
2323Write user and tty to lastlog file (used by programs like 2348Write user and tty to lastlog file (used by programs like
2324F<lastlogin>) at start of rxvt execution. This option requires 2349F<lastlogin>) at start of rxvt execution. This option requires
2325--enable-utmp to also be specified. 2350--enable-utmp to also be specified.
2326 2351
2327=item --enable-xpm-background (default: on) 2352=item --enable-afterimage (default: on)
2328 2353
2329Add support for XPM background pixmaps. 2354Add support for libAfterImage to be used for transparency and background
2355images. It adds support for many file formats including JPG, PNG,
2356SVG, TIFF, GIF, XPM, BMP, ICO, XCF, TGA and AfterStep image XML
2357(L<http://www.afterstep.org/visualdoc.php?show=asimagexml>).
2358
2359This option also adds such eye candy as blending an image over the root
2360background, as well as dynamic scaling and bluring of background images.
2361
2362Note that with this option enabled, @@RXVT_NAME@@'s memory footprint might
2363increase by a few megabytes even if no extra features are used (mostly due
2364to third-party libraries used by libAI). Memory footprint may somewhat be
2365lowered if libAfterImage is configured without support for SVG.
2330 2366
2331=item --enable-transparency (default: on) 2367=item --enable-transparency (default: on)
2332 2368
2333Add support for inheriting parent backgrounds thus giving a fake 2369Add support for backgrounds, creating illusion of transparency in the term.
2334transparency to the term.
2335 2370
2336=item --enable-fading (default: on) 2371=item --enable-fading (default: on)
2337 2372
2338Add support for fading the text when focus is lost (requires C<--enable-transparency>). 2373Add 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 2374
2344=item --enable-rxvt-scroll (default: on) 2375=item --enable-rxvt-scroll (default: on)
2345 2376
2346Add support for the original rxvt scrollbar. 2377Add support for the original rxvt scrollbar.
2347 2378
2390A non-exhaustive list of features enabled by C<--enable-frills> (possibly 2421A non-exhaustive list of features enabled by C<--enable-frills> (possibly
2391in combination with other switches) is: 2422in combination with other switches) is:
2392 2423
2393 MWM-hints 2424 MWM-hints
2394 EWMH-hints (pid, utf8 names) and protocols (ping) 2425 EWMH-hints (pid, utf8 names) and protocols (ping)
2426 urgency hint
2395 seperate underline colour (-underlineColor) 2427 seperate underline colour (-underlineColor)
2396 settable border widths and borderless switch (-w, -b, -bl) 2428 settable border widths and borderless switch (-w, -b, -bl)
2397 visual depth selection (-depth) 2429 visual depth selection (-depth)
2398 settable extra linespacing /-lsp) 2430 settable extra linespacing /-lsp)
2399 iso-14755-2 and -3, and visual feedback 2431 iso-14755 5.1 (basic) support
2400 tripleclickwords (-tcw) 2432 tripleclickwords (-tcw)
2401 settable insecure mode (-insecure) 2433 settable insecure mode (-insecure)
2402 keysym remapping support 2434 keysym remapping support
2403 cursor blinking and underline cursor (-cb, -uc) 2435 cursor blinking and underline cursor (-cb, -uc)
2404 XEmbed support (-embed) 2436 XEmbed support (-embed)
2405 user-pty (-pty-fd) 2437 user-pty (-pty-fd)
2406 hold on exit (-hold) 2438 hold on exit (-hold)
2439 compile in built-in block graphics
2407 skip builtin block graphics (-sbg) 2440 skip builtin block graphics (-sbg)
2408 separate highlightcolor support (-hc) 2441 separate highlightcolor support (-hc)
2409 2442
2410It also enables some non-essential features otherwise disabled, such as: 2443It also enables some non-essential features otherwise disabled, such as:
2411 2444
2412 some round-trip time optimisations 2445 some round-trip time optimisations
2413 nearest color allocation on pseudocolor screens 2446 nearest color allocation on pseudocolor screens
2414 UTF8_STRING supporr for selection 2447 UTF8_STRING support for selection
2415 sgr modes 90..97 and 100..107 2448 sgr modes 90..97 and 100..107
2416 backindex and forwardindex escape sequences 2449 backindex and forwardindex escape sequences
2417 view change/zero scorllback esacpe sequences 2450 view change/zero scrollback escape sequences
2418 locale switching escape sequence 2451 locale switching escape sequence
2419 window op and some xterm/OSC escape sequences 2452 window op and some xterm/OSC escape sequences
2420 rectangular selections 2453 rectangular selections
2421 trailing space removal for selections 2454 trailing space removal for selections
2422 verbose X error handling 2455 verbose X error handling
2431=item --enable-keepscrolling (default: on) 2464=item --enable-keepscrolling (default: on)
2432 2465
2433Add support for continual scrolling of the display when you hold 2466Add support for continual scrolling of the display when you hold
2434the mouse button down on a scrollbar arrow. 2467the mouse button down on a scrollbar arrow.
2435 2468
2469=item --enable-selectionscrolling (default: on)
2470
2471Add support for scrolling when the selection moves to the top or
2472bottom of the screen.
2473
2436=item --enable-mousewheel (default: on) 2474=item --enable-mousewheel (default: on)
2437 2475
2438Add support for scrolling via mouse wheel or buttons 4 & 5. 2476Add support for scrolling via mouse wheel or buttons 4 & 5.
2439 2477
2440=item --enable-slipwheeling (default: on) 2478=item --enable-slipwheeling (default: on)
2441 2479
2442Add support for continual scrolling (using the mouse wheel as an 2480Add support for continual scrolling (using the mouse wheel as an
2443accelerator) while the control key is held down. This option 2481accelerator) while the control key is held down. This option
2444requires --enable-mousewheel to also be specified. 2482requires --enable-mousewheel to also be specified.
2445 2483
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) 2484=item --enable-smart-resize (default: off)
2466 2485
2467Add smart growth/shrink behaviour when changing font size via hot 2486Add smart growth/shrink behaviour when resizing.
2468keys. This should keep the window corner which is closest to a corner of 2487This should keep the window corner which is closest to a corner of
2469the screen in a fixed position. 2488the screen in a fixed position.
2470 2489
2490=item --enable-text-blink (default: on)
2491
2492Add support for blinking text.
2493
2471=item --enable-pointer-blank (default: on) 2494=item --enable-pointer-blank (default: on)
2472 2495
2473Add support to have the pointer disappear when typing or inactive. 2496Add support to have the pointer disappear when typing or inactive.
2474 2497
2475=item --enable-perl (default: on) 2498=item --enable-perl (default: on)
2476 2499
2477Enable an embedded perl interpreter. See the B<@@RXVT_NAME@@perl(3)> 2500Enable 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 2501manpage (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 2502files 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 2503default. The perl interpreter that is used can be specified via the
2481variable when running configure. 2504C<PERL> environment variable when running configure. Even when compiled
2505in, perl will I<not> be initialised when all extensions have been disabled
2506C<-pe "" --perl-ext-common "">, so it should be safe to enable from a
2507resource standpoint.
2508
2509=item --with-afterimage-config=DIR
2510
2511Look for the libAfterImage config script in DIR.
2482 2512
2483=item --with-name=NAME (default: urxvt) 2513=item --with-name=NAME (default: urxvt)
2484 2514
2485Set the basename for the installed binaries, resulting 2515Set the basename for the installed binaries, resulting
2486in C<urxvt>, C<urxvtd> etc.). Specify C<--with-name=rxvt> to replace with 2516in C<urxvt>, C<urxvtd> etc.). Specify C<--with-name=rxvt> to replace with
2496PATH. 2526PATH.
2497 2527
2498=item --with-x 2528=item --with-x
2499 2529
2500Use the X Window System (pretty much default, eh?). 2530Use 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 2531
2514=back 2532=back
2515 2533
2516=head1 AUTHORS 2534=head1 AUTHORS
2517 2535

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines