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.187 by sf-exg, Mon Apr 19 11:02:34 2010 UTC

17 17
18This document contains the FAQ, the RXVT TECHNICAL REFERENCE documenting 18This document contains the FAQ, the RXVT TECHNICAL REFERENCE documenting
19all escape sequences, and other background information. 19all escape sequences, and other background information.
20 20
21The newest version of this document is also available on the World Wide Web at 21The newest version of this document is also available on the World Wide Web at
22L<http://cvs.schmorp.de/browse/*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
29=head3 My question isn't answered here, can I ask a human? 32=head3 My question isn't answered here, can I ask a human?
30 33
31Before sending me mail, you could go to IRC: C<irc.freenode.net>, 34Before sending me mail, you could go to IRC: C<irc.freenode.net>,
32channel C<#rxvt-unicode> has some rxvt-unicode enthusiasts that might be 35channel C<#rxvt-unicode> has some rxvt-unicode enthusiasts that might be
33interested in learning about new and exciting problems (but not FAQs :). 36interested in learning about new and exciting problems (but not FAQs :).
37
38=head3 I use Gentoo, and I have a problem...
39
40There are three big problems with Gentoo Linux: first of all, most if not
41all Gentoo systems are completely broken (missing or mismatched header
42files, broken compiler etc. are just the tip of the iceberg); secondly,
43the Gentoo maintainer thinks it is a good idea to add broken patches to
44the code; and lastly, it should be called Gentoo GNU/Linux.
45
46For these reasons, it is impossible to support rxvt-unicode on
47Gentoo. Problems appearing on Gentoo systems will usually simply be
48ignored unless they can be reproduced on non-Gentoo systems.
34 49
35=head3 Does it support tabs, can I have a tabbed rxvt-unicode? 50=head3 Does it support tabs, can I have a tabbed rxvt-unicode?
36 51
37Beginning with version 7.3, there is a perl extension that implements a 52Beginning with version 7.3, there is a perl extension that implements a
38simple tabbed terminal. It is installed by default, so any of these should 53simple tabbed terminal. It is installed by default, so any of these should
73=head3 How can I start @@URXVT_NAME@@d in a race-free way? 88=head3 How can I start @@URXVT_NAME@@d in a race-free way?
74 89
75Try C<@@URXVT_NAME@@d -f -o>, which tells @@URXVT_NAME@@d to open the 90Try C<@@URXVT_NAME@@d -f -o>, which tells @@URXVT_NAME@@d to open the
76display, create the listening socket and then fork. 91display, create the listening socket and then fork.
77 92
78=head3 How can I start @@URXVT_NAME@@d automatically when I run URXVT_NAME@@c? 93=head3 How can I start @@URXVT_NAME@@d automatically when I run @@URXVT_NAME@@c?
79 94
80If you want to start @@URXVT_NAME@@d automatically whenever you run 95If 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: 96@@URXVT_NAME@@c and the daemon isn't running yet, use this script:
82 97
83 #!/bin/sh 98 #!/bin/sh
125 fi 140 fi
126 141
127=head3 How do I compile the manual pages on my own? 142=head3 How do I compile the manual pages on my own?
128 143
129You need to have a recent version of perl installed as F</usr/bin/perl>, 144You 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 145one that comes with F<pod2man>, F<pod2text> and F<pod2xhtml> (from
131the doc subdirectory and enter C<make alldoc>. 146F<Pod::Xhtml>). Then go to the doc subdirectory and enter C<make alldoc>.
132 147
133=head3 Isn't rxvt-unicode supposed to be small? Don't all those features bloat? 148=head3 Isn't rxvt-unicode supposed to be small? Don't all those features bloat?
134 149
135I often get asked about this, and I think, no, they didn't cause extra 150I 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 151bloat. If you compare a minimal rxvt and a minimal urxvt, you can see
197 212
198And here is rxvt-unicode: 213And here is rxvt-unicode:
199 214
200 libX11.so.6 => /usr/X11R6/lib/libX11.so.6 (0x00002aaaaabc3000) 215 libX11.so.6 => /usr/X11R6/lib/libX11.so.6 (0x00002aaaaabc3000)
201 libgcc_s.so.1 => /lib/libgcc_s.so.1 (0x00002aaaaada2000) 216 libgcc_s.so.1 => /lib/libgcc_s.so.1 (0x00002aaaaada2000)
202 libc.so.6 => /lib/libc.so.6 (0x00002aaaaaeb0000) 217 libc.so.6 => /lib/libc.so.6 (0x00002aaaaaeb0000)
203 libdl.so.2 => /lib/libdl.so.2 (0x00002aaaab0ee000) 218 libdl.so.2 => /lib/libdl.so.2 (0x00002aaaab0ee000)
204 /lib64/ld-linux-x86-64.so.2 (0x00002aaaaaaab000) 219 /lib64/ld-linux-x86-64.so.2 (0x00002aaaaaaab000)
205 220
206No large bloated libraries (of course, none were linked in statically), 221No large bloated libraries (of course, none were linked in statically),
207except maybe libX11 :) 222except maybe libX11 :)
208 223
209 224
210=head2 Rendering, Font & Look and Feel Issues 225=head2 Rendering, Font & Look and Feel Issues
211 226
212=head3 I can't get transparency working, what am I doing wrong? 227=head3 I can't get transparency working, what am I doing wrong?
213 228
214First of all, transparency isn't officially supported in rxvt-unicode, so 229First of all, please address all transparency related issues to Sasha Vasko at
215you are mostly on your own. Do not bug the author about it (but you may 230sasha@aftercode.net and do not bug the author about it. Also, if you can't
216bug everybody else). Also, if you can't get it working consider it a rite 231get it working consider it a rite of passage: ... and you failed.
217of passage: ... and you failed.
218 232
219Here are four ways to get transparency. B<Do> read the manpage and option 233Here are four ways to get transparency. B<Do> read the manpage and option
220descriptions for the programs mentioned and rxvt-unicode. Really, do it! 234descriptions for the programs mentioned and rxvt-unicode. Really, do it!
221 235
2221. Use inheritPixmap: 2361. Use transparent mode:
223 237
224 Esetroot wallpaper.jpg 238 Esetroot wallpaper.jpg
225 @@URXVT_NAME@@ -ip -tint red -sh 40 239 @@URXVT_NAME@@ -tr -tint red -sh 40
226 240
227That works. If you think it doesn't, you lack transparency and tinting 241That works. If you think it doesn't, you lack transparency and tinting
228support, or you are unable to read. 242support, or you are unable to read.
229 243
2302. Use a simple pixmap and emulate pseudo-transparency. This enables you 2442. Use a simple pixmap and emulate pseudo-transparency. This enables you
231to use effects other than tinting and shading: Just shade/tint/whatever 245to use effects other than tinting and shading: Just shade/tint/whatever
232your picture with gimp or any other tool: 246your picture with gimp or any other tool:
233 247
234 convert wallpaper.jpg -blur 20x20 -modulate 30 background.xpm 248 convert wallpaper.jpg -blur 20x20 -modulate 30 background.jpg
235 @@URXVT_NAME@@ -pixmap background.xpm -pe automove-background 249 @@URXVT_NAME@@ -pixmap "background.jpg;:root"
236 250
237That works. If you think it doesn't, you lack XPM and Perl support, or you 251That works. If you think it doesn't, you lack AfterImage support, or you
238are unable to read. 252are unable to read.
239 253
2403. Use an ARGB visual: 2543. Use an ARGB visual:
241 255
242 @@URXVT_NAME@@ -depth 32 -fg grey90 -bg rgba:0000/0000/4444/cccc 256 @@URXVT_NAME@@ -depth 32 -fg grey90 -bg rgba:0000/0000/4444/cccc
342=head3 What's with this bold/blink stuff? 356=head3 What's with this bold/blink stuff?
343 357
344If no bold colour is set via C<colorBD:>, bold will invert text using the 358If no bold colour is set via C<colorBD:>, bold will invert text using the
345standard foreground colour. 359standard foreground colour.
346 360
347For the standard background colour, blinking will actually make the 361For the standard background colour, blinking will actually make
348text blink when compiled with C<--enable-blinking>. with standard 362the text blink when compiled with C<--enable-text-blink>. Without
349colours. Without C<--enable-blinking>, the blink attribute will be 363C<--enable-text-blink>, the blink attribute will be ignored.
350ignored.
351 364
352On ANSI colours, bold/blink attributes are used to set high-intensity 365On ANSI colours, bold/blink attributes are used to set high-intensity
353foreground/background colors. 366foreground/background colors.
354 367
355color0-7 are the low-intensity colors. 368color0-7 are the low-intensity colors.
460has been designed yet). 473has been designed yet).
461 474
462Until then, you might get away with switching fonts at runtime (see L<Can 475Until then, you might get away with switching fonts at runtime (see L<Can
463I switch the fonts at runtime?> later in this document). 476I switch the fonts at runtime?> later in this document).
464 477
478=head3 How can I make mplayer display video correctly?
479
480We are working on it, in the meantime, as a workaround, use something like:
481
482 @@URXVT_NAME@@ -b 600 -geometry 20x1 -e sh -c 'mplayer -wid $WINDOWID file...'
483
484
465=head2 Keyboard, Mouse & User Interaction 485=head2 Keyboard, Mouse & User Interaction
466 486
467=head3 The new selection selects pieces that are too big, how can I select single words? 487=head3 The new selection selects pieces that are too big, how can I select single words?
468 488
469If you want to select e.g. alphanumeric words, you can use the following 489If you want to select e.g. alphanumeric words, you can use the following
476 496
477To get a selection that is very similar to the old code, try this pattern: 497To get a selection that is very similar to the old code, try this pattern:
478 498
479 URxvt.selection.pattern-0: ([^"&'()*,;<=>?@[\\\\]^`{|})]+) 499 URxvt.selection.pattern-0: ([^"&'()*,;<=>?@[\\\\]^`{|})]+)
480 500
481Please also note that the I<LeftClick Shift-LeftClik> combination also 501Please also note that the I<LeftClick Shift-LeftClick> combination also
482selects words like the old code. 502selects words like the old code.
483 503
484=head3 I don't like the new selection/popups/hotkeys/perl, how do I change/disable it? 504=head3 I don't like the new selection/popups/hotkeys/perl, how do I change/disable it?
485 505
486You can disable the perl extension completely by setting the 506You can disable the perl extension completely by setting the
538rxvt-unicode will continue without an input method. 558rxvt-unicode will continue without an input method.
539 559
540In this case either do not specify a B<preeditStyle> or specify more than 560In this case either do not specify a B<preeditStyle> or specify more than
541one pre-edit style, such as B<OverTheSpot,Root,None>. 561one pre-edit style, such as B<OverTheSpot,Root,None>.
542 562
563If it still doesn't work, then maybe your input method doesn't support
564compose sequences - to fall back to the built-in one, make sure you don't
565specify an input method via C<-im> or C<XMODIFIERS>.
566
543=head3 I cannot type C<Ctrl-Shift-2> to get an ASCII NUL character due to ISO 14755 567=head3 I cannot type C<Ctrl-Shift-2> to get an ASCII NUL character due to ISO 14755
544 568
545Either try C<Ctrl-2> alone (it often is mapped to ASCII NUL even on 569Either try C<Ctrl-2> alone (it often is mapped to ASCII NUL even on
546international keyboards) or simply use ISO 14755 support to your 570international keyboards) or simply use ISO 14755 support to your
547advantage, typing <Ctrl-Shift-0> to get a ASCII NUL. This works for other 571advantage, typing <Ctrl-Shift-0> to get a ASCII NUL. This works for other
562Backspace keysym (not likely for Linux ... see the following 586Backspace keysym (not likely for Linux ... see the following
563question) there are two standard values that can be used for 587question) there are two standard values that can be used for
564Backspace: C<^H> and C<^?>. 588Backspace: C<^H> and C<^?>.
565 589
566Historically, either value is correct, but rxvt-unicode adopts the debian 590Historically, either value is correct, but rxvt-unicode adopts the debian
567policy of using C<^?> when unsure, because it's the one only only correct 591policy of using C<^?> when unsure, because it's the one and only correct
568choice :). 592choice :).
569 593
570Rxvt-unicode tries to inherit the current stty settings and uses the value 594Rxvt-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 595of `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 596started 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 628key has been assigned an escape sequence to match the vt100 for Execute
605(C<ESC [ 3 ~>) and is in the supplied termcap/terminfo. 629(C<ESC [ 3 ~>) and is in the supplied termcap/terminfo.
606 630
607Some other Backspace problems: 631Some other Backspace problems:
608 632
609some editors use termcap/terminfo, 633some editors use termcap/terminfo,
610some editors (vim I'm told) expect Backspace = ^H, 634some editors (vim I'm told) expect Backspace = ^H,
611GNU Emacs (and Emacs-like editors) use ^H for help. 635GNU Emacs (and Emacs-like editors) use ^H for help.
612 636
613Perhaps someday this will all be resolved in a consistent manner. 637Perhaps someday this will all be resolved in a consistent manner.
614 638
655Rather than have rxvt-unicode try to accommodate all the various possible 679Rather than have rxvt-unicode try to accommodate all the various possible
656keyboard mappings, it is better to use `xmodmap' to remap the keys as 680keyboard mappings, it is better to use `xmodmap' to remap the keys as
657required for your particular machine. 681required for your particular machine.
658 682
659 683
660
661=head2 Terminal Configuration 684=head2 Terminal Configuration
662 685
663=head3 Can I see a typical configuration? 686=head3 Can I see a typical configuration?
664 687
665The default configuration tries to be xterm-like, which I don't like that 688The default configuration tries to be xterm-like, which I don't like that
695develop for myself mostly, so I actually use most of the extensions I 718develop for myself mostly, so I actually use most of the extensions I
696write. 719write.
697 720
698The selection stuff mainly makes the selection perl-error-message aware 721The selection stuff mainly makes the selection perl-error-message aware
699and tells it to convert perl error messages into vi-commands to load the 722and tells it to convert perl error messages into vi-commands to load the
700relevant file and go tot he error line number. 723relevant file and go to the error line number.
701 724
702 URxvt.scrollstyle: plain 725 URxvt.scrollstyle: plain
703 URxvt.secondaryScroll: true 726 URxvt.secondaryScroll: true
704 727
705As the documentation says: plain is the preferred scrollbar for the 728As the documentation says: plain is the preferred scrollbar for the
777purposes, it works, and gives a different look, as my normal (Non-bold) 800purposes, it works, and gives a different look, as my normal (Non-bold)
778font is already bold, and I want to see a difference between bold and 801font is already bold, and I want to see a difference between bold and
779normal fonts. 802normal fonts.
780 803
781Please note that I used the C<urxvt> instance name and not the C<URxvt> 804Please note that I used the C<urxvt> instance name and not the C<URxvt>
782class name. Thats because I use different configs for different purposes, 805class name. That is because I use different configs for different purposes,
783for example, my IRC window is started with C<-name IRC>, and uses these 806for example, my IRC window is started with C<-name IRC>, and uses these
784defaults: 807defaults:
785 808
786 IRC*title: IRC 809 IRC*title: IRC
787 IRC*geometry: 87x12+535+542 810 IRC*geometry: 87x12+535+542
791 IRC*boldFont: suxuseuro 814 IRC*boldFont: suxuseuro
792 IRC*colorBD: white 815 IRC*colorBD: white
793 IRC*keysym.M-C-1: command:\033]710;suxuseuro\007\033]711;suxuseuro\007 816 IRC*keysym.M-C-1: command:\033]710;suxuseuro\007\033]711;suxuseuro\007
794 IRC*keysym.M-C-2: command:\033]710;9x15bold\007\033]711;9x15bold\007 817 IRC*keysym.M-C-2: command:\033]710;9x15bold\007\033]711;9x15bold\007
795 818
796C<Alt-Shift-1> and C<Alt-Shift-2> switch between two different font 819C<Alt-Ctrl-1> and C<Alt-Ctrl-2> switch between two different font
797sizes. C<suxuseuro> allows me to keep an eye (and actually read) 820sizes. C<suxuseuro> allows me to keep an eye (and actually read)
798stuff while keeping a very small window. If somebody pastes something 821stuff while keeping a very small window. If somebody pastes something
799complicated (e.g. japanese), I temporarily switch to a larger font. 822complicated (e.g. japanese), I temporarily switch to a larger font.
800 823
801The above is all in my C<.Xdefaults> (I don't use C<.Xresources> nor 824The above is all in my C<.Xdefaults> (I don't use C<.Xresources> nor
838 861
839The terminal description used by rxvt-unicode is not as widely available 862The terminal description used by rxvt-unicode is not as widely available
840as that for xterm, or even rxvt (for which the same problem often arises). 863as that for xterm, or even rxvt (for which the same problem often arises).
841 864
842The correct solution for this problem is to install the terminfo, this can 865The correct solution for this problem is to install the terminfo, this can
843be done like this (with ncurses' infocmp): 866be done by simply installing rxvt-unicode on the remote system as well
867(in case you have a nice package manager ready), or you can install the
868terminfo database manually like this (with ncurses infocmp. works as
869user and root):
844 870
845 REMOTE=remotesystem.domain 871 REMOTE=remotesystem.domain
846 infocmp rxvt-unicode | ssh $REMOTE "cat >/tmp/ti && tic /tmp/ti" 872 infocmp rxvt-unicode | ssh $REMOTE "mkdir -p .terminfo && cat >/tmp/ti && tic /tmp/ti"
847 873
848... or by installing rxvt-unicode normally on the remote system, 874One some systems you might need to set C<$TERMINFO> to the full path of
875F<$HOME/.terminfo> for this to work.
849 876
850If you cannot or do not want to do this, then you can simply set 877If you cannot or do not want to do this, then you can simply set
851C<TERM=rxvt> or even C<TERM=xterm>, and live with the small number of 878C<TERM=rxvt> or even C<TERM=xterm>, and live with the small number of
852problems arising, which includes wrong keymapping, less and different 879problems arising, which includes wrong keymapping, less and different
853colours and some refresh errors in fullscreen applications. It's a nice 880colours and some refresh errors in fullscreen applications. It's a nice
860 URxvt.termName: rxvt 887 URxvt.termName: rxvt
861 888
862If you don't plan to use B<rxvt> (quite common...) you could also replace 889If you don't plan to use B<rxvt> (quite common...) you could also replace
863the rxvt terminfo file with the rxvt-unicode one and use C<TERM=rxvt>. 890the rxvt terminfo file with the rxvt-unicode one and use C<TERM=rxvt>.
864 891
892=head3 nano fails with "Error opening terminal: rxvt-unicode"
893
894This exceptionally confusing and useless error message is printed by nano
895when it can't find the terminfo database. Nothing is wrong with your
896terminal, read the previous answer for a solution.
897
865=head3 C<tic> outputs some error when compiling the terminfo entry. 898=head3 C<tic> outputs some error when compiling the terminfo entry.
866 899
867Most likely it's the empty definition for C<enacs=>. Just replace it by 900Most likely it's the empty definition for C<enacs=>. Just replace it by
868C<enacs=\E[0@> and try again. 901C<enacs=\E[0@> and try again.
869 902
882You can also create a termcap entry by using terminfo's infocmp program 915You can also create a termcap entry by using terminfo's infocmp program
883like this: 916like this:
884 917
885 infocmp -C rxvt-unicode 918 infocmp -C rxvt-unicode
886 919
887Or you could use this termcap entry, generated by the command above: 920Or you could use the termcap entry in doc/etc/rxvt-unicode.termcap,
888 921generated by the command above.
889 rxvt-unicode|rxvt-unicode terminal (X Window System):\
890 :am:bw:eo:km:mi:ms:xn:xo:\
891 :co#80:it#8:li#24:lm#0:\
892 :AL=\E[%dL:DC=\E[%dP:DL=\E[%dM:DO=\E[%dB:IC=\E[%d@:\
893 :K1=\EOw:K2=\EOu:K3=\EOy:K4=\EOq:K5=\EOs:LE=\E[%dD:\
894 :RI=\E[%dC:SF=\E[%dS:SR=\E[%dT:UP=\E[%dA:ae=\E(B:al=\E[L:\
895 :as=\E(0:bl=^G:cd=\E[J:ce=\E[K:cl=\E[H\E[2J:\
896 :cm=\E[%i%d;%dH:cr=^M:cs=\E[%i%d;%dr:ct=\E[3g:dc=\E[P:\
897 :dl=\E[M:do=^J:ec=\E[%dX:ei=\E[4l:ho=\E[H:\
898 :i1=\E[?47l\E=\E[?1l:ic=\E[@:im=\E[4h:\
899 :is=\E[r\E[m\E[2J\E[H\E[?7h\E[?1;3;4;6l\E[4l:\
900 :k1=\E[11~:k2=\E[12~:k3=\E[13~:k4=\E[14~:k5=\E[15~:\
901 :k6=\E[17~:k7=\E[18~:k8=\E[19~:k9=\E[20~:kD=\E[3~:\
902 :kI=\E[2~:kN=\E[6~:kP=\E[5~:kb=\177:kd=\EOB:ke=\E[?1l\E>:\
903 :kh=\E[7~:kl=\EOD:kr=\EOC:ks=\E[?1h\E=:ku=\EOA:le=^H:\
904 :mb=\E[5m:md=\E[1m:me=\E[m\017:mr=\E[7m:nd=\E[C:rc=\E8:\
905 :sc=\E7:se=\E[27m:sf=^J:so=\E[7m:sr=\EM:st=\EH:ta=^I:\
906 :te=\E[r\E[?1049l:ti=\E[?1049h:ue=\E[24m:up=\E[A:\
907 :us=\E[4m:vb=\E[?5h\E[?5l:ve=\E[?25h:vi=\E[?25l:\
908 :vs=\E[?25h:
909 922
910=head3 Why does C<ls> no longer have coloured output? 923=head3 Why does C<ls> no longer have coloured output?
911 924
912The C<ls> in the GNU coreutils unfortunately doesn't use terminfo to 925The C<ls> in the GNU coreutils unfortunately doesn't use terminfo to
913decide whether a terminal has colour, but uses its own configuration 926decide whether a terminal has colour, but uses its own configuration
953If you encounter strange problems like typing an accented character but 966If you encounter strange problems like typing an accented character but
954getting two unrelated other characters or similar, or if program output is 967getting two unrelated other characters or similar, or if program output is
955subtly garbled, then you should check your locale settings. 968subtly garbled, then you should check your locale settings.
956 969
957Rxvt-unicode must be started with the same C<LC_CTYPE> setting as the 970Rxvt-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 971programs 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 972while 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. 973locale to something else, e.g. C<en_GB.UTF-8>. Needless to say, this is
974not going to work, and is the most common cause for problems.
961 975
962The best thing is to fix your startup environment, as you will likely run 976The 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. 977into other problems. If nothing works you can try this in your .profile.
964 978
965 printf '\33]701;%s\007' "$LC_CTYPE" 979 printf '\33]701;%s\007' "$LC_CTYPE" # $LANG or $LC_ALL are worth a try, too
966 980
967If this doesn't work, then maybe you use a C<LC_CTYPE> specification not 981If 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 982supported 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 983displays 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 984it 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 1078C<@im=kinput2>. For B<scim>, use C<@im=SCIM>. You can see what input
1065method servers are running with this command: 1079method servers are running with this command:
1066 1080
1067 xprop -root XIM_SERVERS 1081 xprop -root XIM_SERVERS
1068 1082
1069=item 1083=item
1070 1084
1071=back 1085=back
1072 1086
1073=head3 My input method wants <some encoding> but I want UTF-8, what can I do? 1087=head3 My input method wants <some encoding> but I want UTF-8, what can I do?
1074 1088
1119runtime-switchable, too, so there is usually no drawback to enabling them, 1133runtime-switchable, too, so there is usually no drawback to enabling them,
1120except higher disk and possibly memory usage. The perl interpreter should 1134except higher disk and possibly memory usage. The perl interpreter should
1121be enabled, as important functionality (menus, selection, likely more in 1135be enabled, as important functionality (menus, selection, likely more in
1122the future) depends on it. 1136the future) depends on it.
1123 1137
1124You should not overwrite the C<perl-ext-common> snd C<perl-ext> resources 1138You should not overwrite the C<perl-ext-common> and C<perl-ext> resources
1125system-wide (except maybe with C<defaults>). This will result in useful 1139system-wide (except maybe with C<defaults>). This will result in useful
1126behaviour. If your distribution aims at low memory, add an empty 1140behaviour. If your distribution aims at low memory, add an empty
1127C<perl-ext-common> resource to the app-defaults file. This will keep the 1141C<perl-ext-common> resource to the app-defaults file. This will keep the
1128perl interpreter disabled until the user enables it. 1142perl interpreter disabled until the user enables it.
1129 1143
1147This forking is done as the very first within main(), which is very early 1161This forking is done as the very first within main(), which is very early
1148and reduces possible bugs to initialisation code run before main(), or 1162and reduces possible bugs to initialisation code run before main(), or
1149things like the dynamic loader of your system, which should result in very 1163things like the dynamic loader of your system, which should result in very
1150little risk. 1164little risk.
1151 1165
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. 1166=head3 I am on FreeBSD and rxvt-unicode does not seem to work at all.
1161 1167
1162Rxvt-unicode requires the symbol C<__STDC_ISO_10646__> to be defined 1168Rxvt-unicode requires the symbol C<__STDC_ISO_10646__> to be defined
1163in your compile environment, or an implementation that implements it, 1169in your compile environment, or an implementation that implements it,
1164whether it defines the symbol or not. C<__STDC_ISO_10646__> requires that 1170whether it defines the symbol or not. C<__STDC_ISO_10646__> requires that
1167As you might have guessed, FreeBSD does neither define this symbol nor 1173As you might have guessed, FreeBSD does neither define this symbol nor
1168does it support it. Instead, it uses its own internal representation of 1174does it support it. Instead, it uses its own internal representation of
1169B<wchar_t>. This is, of course, completely fine with respect to standards. 1175B<wchar_t>. This is, of course, completely fine with respect to standards.
1170 1176
1171However, that means rxvt-unicode only works in C<POSIX>, C<ISO-8859-1> and 1177However, that means rxvt-unicode only works in C<POSIX>, C<ISO-8859-1> and
1172C<UTF-8> locales under FreeBSD (which all use Unicode as B<wchar_t>. 1178C<UTF-8> locales under FreeBSD (which all use Unicode as B<wchar_t>).
1173 1179
1174C<__STDC_ISO_10646__> is the only sane way to support multi-language 1180C<__STDC_ISO_10646__> is the only sane way to support multi-language
1175apps in an OS, as using a locale-dependent (and non-standardized) 1181apps in an OS, as using a locale-dependent (and non-standardized)
1176representation of B<wchar_t> makes it impossible to convert between 1182representation of B<wchar_t> makes it impossible to convert between
1177B<wchar_t> (as used by X11 and your applications) and any other encoding 1183B<wchar_t> (as used by X11 and your applications) and any other encoding
1187 1193
1188The rxvt-unicode author insists that the right way to fix this is in the 1194The 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 1195system libraries once and for all, instead of forcing every app to carry
1190complete replacements for them :) 1196complete replacements for them :)
1191 1197
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? 1198=head3 How can I use rxvt-unicode under cygwin?
1198 1199
1199rxvt-unicode should compile and run out of the box on cygwin, using 1200rxvt-unicode should compile and run out of the box on cygwin, using
1200the X11 libraries that come with cygwin. libW11 emulation is no 1201the X11 libraries that come with cygwin. libW11 emulation is no
1201longer supported (and makes no sense, either, as it only supported a 1202longer supported (and makes no sense, either, as it only supported a
1205 1206
1206At the time of this writing, cygwin didn't seem to support any multi-byte 1207At 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 1208encodings (you might try C<LC_CTYPE=C-UTF-8>), so you are likely limited
1208to 8-bit encodings. 1209to 8-bit encodings.
1209 1210
1211=head3 Character widths are not correct.
1212
1213urxvt uses the system wcwidth function to know the information about
1214the width of characters, so on systems with incorrect locale data you
1215will likely get bad results. Two notorious examples are Solaris 9,
1216where single-width characters like U+2514 are reported as double-width,
1217and Darwin 8, where combining chars are reported having width 1.
1218
1219The solution is to upgrade your system or switch to a better one. A
1220possibly working workaround is to use a wcwidth implementation like
1221
1222http://www.cl.cam.ac.uk/~mgk25/ucs/wcwidth.c
1223
1210=head1 RXVT-UNICODE TECHNICAL REFERENCE 1224=head1 RXVT-UNICODE TECHNICAL REFERENCE
1211 1225
1212The rest of this document describes various technical aspects of 1226The rest of this document describes various technical aspects of
1213B<rxvt-unicode>. First the description of supported command sequences, 1227B<rxvt-unicode>. First the description of supported command sequences,
1214followed by pixmap support and last by a description of all features 1228followed by pixmap support and last by a description of all features
1313 1327
1314=item B<< C<ESC => >> 1328=item B<< C<ESC => >>
1315 1329
1316Application Keypad (SMKX). See also next sequence. 1330Application Keypad (SMKX). See also next sequence.
1317 1331
1318=item B<<< C<< ESC >> >>> 1332=item B<<< C<< ESC > >> >>>
1319 1333
1320Normal Keypad (RMKX) 1334Normal Keypad (RMKX)
1321 1335
1322B<Note:> If the numeric keypad is activated, eg, B<Num_Lock> has been 1336B<Note:> If the numeric keypad is activated, eg, B<Num_Lock> has been
1323pressed, numbers or control functions are generated by the numeric keypad 1337pressed, numbers or control functions are generated by the numeric keypad
1466=begin table 1480=begin table
1467 1481
1468 B<< C<Ps = 0> >> Clear to Right (default) 1482 B<< C<Ps = 0> >> Clear to Right (default)
1469 B<< C<Ps = 1> >> Clear to Left 1483 B<< C<Ps = 1> >> Clear to Left
1470 B<< C<Ps = 2> >> Clear All 1484 B<< C<Ps = 2> >> Clear All
1485 B<< C<Ps = 3> >> Like Ps = 0, but is ignored when wrapped
1486 (@@RXVT_NAME@@ extension)
1471 1487
1472=end table 1488=end table
1473 1489
1474=item B<< C<ESC [ Ps L> >> 1490=item B<< C<ESC [ Ps L> >>
1475 1491
1801 1817
1802=item B<< C<Pm = 30> >> 1818=item B<< C<Pm = 30> >>
1803 1819
1804=begin table 1820=begin table
1805 1821
1806 B<< C<h> >> scrollBar visisble 1822 B<< C<h> >> scrollBar visible
1807 B<< C<l> >> scrollBar invisisble 1823 B<< C<l> >> scrollBar invisible
1808 1824
1809=end table 1825=end table
1810 1826
1811=item B<< C<Pm = 35> >> (B<rxvt>) 1827=item B<< C<Pm = 35> >> (B<rxvt>)
1812 1828
1863 1879
1864=item B<< C<Pm = 66> >> 1880=item B<< C<Pm = 66> >>
1865 1881
1866=begin table 1882=begin table
1867 1883
1868 B<< C<h> >> Application Keypad (DECPAM) == C<ESC => 1884 B<< C<h> >> Application Keypad (DECKPAM/DECPAM) == C<ESC =>
1869 B<< C<l> >> Normal Keypad (DECPNM) == C<< ESC > >> 1885 B<< C<l> >> Normal Keypad (DECKPNM/DECPNM) == C<< ESC > >>
1870 1886
1871=end table 1887=end table
1872 1888
1873=item B<< C<Pm = 67> >> 1889=item B<< C<Pm = 67> >>
1874 1890
1895 B<< C<h> >> Use Hilite Mouse Tracking. 1911 B<< C<h> >> Use Hilite Mouse Tracking.
1896 B<< C<l> >> No mouse reporting. 1912 B<< C<l> >> No mouse reporting.
1897 1913
1898=end table 1914=end table
1899 1915
1916=item B<< C<Pm = 1002> >> (X11 XTerm)
1917
1918=begin table
1919
1920 B<< C<h> >> Send Mouse X & Y on button press and release, and motion with a button pressed.
1921 B<< C<l> >> No mouse reporting.
1922
1923=end table
1924
1925=item B<< C<Pm = 1003> >> (X11 XTerm)
1926
1927=begin table
1928
1929 B<< C<h> >> Send Mouse X & Y on button press and release, and motion.
1930 B<< C<l> >> No mouse reporting.
1931
1932=end table
1933
1900=item B<< C<Pm = 1010> >> (B<rxvt>) 1934=item B<< C<Pm = 1010> >> (B<rxvt>)
1901 1935
1902=begin table 1936=begin table
1903 1937
1904 B<< C<h> >> Don't scroll to bottom on TTY output 1938 B<< C<h> >> Don't scroll to bottom on TTY output
1946 1980
1947=begin table 1981=begin table
1948 1982
1949 B<< C<h> >> Use Alternate Screen Buffer - clear Alternate Screen Buffer if switching to it 1983 B<< C<h> >> Use Alternate Screen Buffer - clear Alternate Screen Buffer if switching to it
1950 B<< C<l> >> Use Normal Screen Buffer 1984 B<< C<l> >> Use Normal Screen Buffer
1985
1986=end table
1987
1988=item B<< C<Pm = 2004> >>
1989
1990=begin table
1991
1992 B<< C<h> >> Enable bracketed paste mode - prepend / append to the pasted text the control sequences C<ESC [ 200 ~> / C<ESC [ 201 ~>
1993 B<< C<l> >> Disable bracketed paste mode
1951 1994
1952=end table 1995=end table
1953 1996
1954=back 1997=back
1955 1998
1972 B<< C<Ps = 0> >> Change Icon Name and Window Title to B<< C<Pt> >> 2015 B<< C<Ps = 0> >> Change Icon Name and Window Title to B<< C<Pt> >>
1973 B<< C<Ps = 1> >> Change Icon Name to B<< C<Pt> >> 2016 B<< C<Ps = 1> >> Change Icon Name to B<< C<Pt> >>
1974 B<< C<Ps = 2> >> Change Window Title to B<< C<Pt> >> 2017 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. 2018 B<< C<Ps = 3> >> If B<< C<Pt> >> starts with a B<< C<?> >>, query the (STRING) property of the window and return it. If B<< C<Pt> >> contains a B<< C<=> >>, set the named property to the given value, else delete the specified property.
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 2019 B<< C<Ps = 4> >> B<< C<Pt> >> is a semi-colon separated sequence of one or more semi-colon separated B<number>/B<name> pairs, where B<number> is an index to a colour and B<name> is the name of a colour. Each pair causes the B<number>ed colour to be changed to B<name>. Numbers 0-7 corresponds to low-intensity (normal) colours and 8-15 corresponds to high-intensity colours. 0=black, 1=red, 2=green, 3=yellow, 4=blue, 5=magenta, 6=cyan, 7=white
1977 B<< C<Ps = 10> >> Change colour of text foreground to B<< C<Pt> >> B<(NB: may change in future)> 2020 B<< C<Ps = 10> >> Change colour of text foreground to B<< C<Pt> >>
1978 B<< C<Ps = 11> >> Change colour of text background to B<< C<Pt> >> B<(NB: may change in future)> 2021 B<< C<Ps = 11> >> Change colour of text background to B<< C<Pt> >>
1979 B<< C<Ps = 12> >> Change colour of text cursor foreground to B<< C<Pt> >> 2022 B<< C<Ps = 12> >> Change colour of text cursor foreground to B<< C<Pt> >>
1980 B<< C<Ps = 13> >> Change colour of mouse foreground to B<< C<Pt> >> 2023 B<< C<Ps = 13> >> Change colour of mouse foreground to B<< C<Pt> >>
1981 B<< C<Ps = 17> >> Change colour of highlight characters to B<< C<Pt> >> 2024 B<< C<Ps = 17> >> Change background 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] 2025 B<< C<Ps = 19> >> Change foreground colour of highlight characters to B<< C<Pt> >>
1983 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). 2026 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> >>. 2027 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> 2028 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> >>. 2029 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> >> 2030 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> >> 2031 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). 2032 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>. 2033 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> >> 2034 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). 2035 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> >> 2036 B<< C<Ps = 706> >> Change colour of bold characters to B<< C<Pt> >>
1995 B<< C<Ps = 707> >> Change colour of underlined characters to B<< C<Pt> >> 2037 B<< C<Ps = 707> >> Change colour of underlined characters to B<< C<Pt> >>
2038 B<< C<Ps = 708> >> Change colour of the border to B<< C<Pt> >>
1996 B<< C<Ps = 710> >> Set normal fontset to B<< C<Pt> >>. Same as C<Ps = 50>. 2039 B<< C<Ps = 710> >> Set normal fontset to B<< C<Pt> >>. Same as C<Ps = 50>.
1997 B<< C<Ps = 711> >> Set bold fontset to B<< C<Pt> >>. Similar to C<Ps = 50> (Compile styles). 2040 B<< C<Ps = 711> >> Set bold fontset to B<< C<Pt> >>. Similar to C<Ps = 50> (Compile styles).
1998 B<< C<Ps = 712> >> Set italic fontset to B<< C<Pt> >>. Similar to C<Ps = 50> (Compile styles). 2041 B<< C<Ps = 712> >> Set italic fontset to B<< C<Pt> >>. Similar to C<Ps = 50> (Compile styles).
1999 B<< C<Ps = 713> >> Set bold-italic fontset to B<< C<Pt> >>. Similar to C<Ps = 50> (Compile styles). 2042 B<< C<Ps = 713> >> Set bold-italic fontset to B<< C<Pt> >>. Similar to C<Ps = 50> (Compile styles).
2000 B<< C<Ps = 720> >> Move viewing window up by B<< C<Pt> >> lines, or clear scrollback buffer if C<Pt = 0> (Compile frills). 2043 B<< C<Ps = 720> >> Move viewing window up by B<< C<Pt> >> lines, or clear scrollback buffer if C<Pt = 0> (Compile frills).
2003 2046
2004=end table 2047=end table
2005 2048
2006=back 2049=back
2007 2050
2008=head1 XPM 2051=head1 BACKGROUND IMAGE
2009 2052
2010For the XPM XTerm escape sequence B<< C<ESC ] 20 ; Pt ST> >> then value 2053For 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 2054of 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 2055sequence of scaling/positioning commands separated by semi-colons. The
2013scaling/positioning commands are as follows: 2056scaling/positioning commands are as follows:
2014 2057
2015=over 4 2058=over 4
2016 2059
2054 2097
2055For example: 2098For example:
2056 2099
2057=over 4 2100=over 4
2058 2101
2059=item B<\E]20;funky\a> 2102=item B<\E]20;funky.jpg\a>
2060 2103
2061load B<funky.xpm> as a tiled image 2104load B<funky.jpg> as a tiled image
2062 2105
2063=item B<\E]20;mona;100\a> 2106=item B<\E]20;mona.jpg;100\a>
2064 2107
2065load B<mona.xpm> with a scaling of 100% 2108load B<mona.jpg> with a scaling of 100%
2066 2109
2067=item B<\E]20;;200;?\a> 2110=item B<\E]20;;200;?\a>
2068 2111
2069rescale the current pixmap to 200% and display the image geometry in 2112rescale the current pixmap to 200% and display the image geometry in
2070the title 2113the title
2071 2114
2072=back 2115=back
2116
2073X<Mouse> 2117X<Mouse>
2074 2118
2075=head1 Mouse Reporting 2119=head1 Mouse Reporting
2076 2120
2077=over 4 2121=over 4
2118Col = B<< C<< <x> - SPACE >> >> 2162Col = B<< C<< <x> - SPACE >> >>
2119 2163
2120Row = B<< C<< <y> - SPACE >> >> 2164Row = B<< C<< <y> - SPACE >> >>
2121 2165
2122=back 2166=back
2167
2168=head1 Key Codes
2169
2123X<KeyCodes> 2170X<KeyCodes>
2124
2125=head1 Key Codes
2126 2171
2127Note: B<Shift> + B<F1>-B<F10> generates B<F11>-B<F20> 2172Note: B<Shift> + B<F1>-B<F10> generates B<F11>-B<F20>
2128 2173
2129For the keypad, use B<Shift> to temporarily override Application-Keypad 2174For the keypad, use B<Shift> to temporarily override Application-Keypad
2130setting use B<Num_Lock> to toggle Application-Keypad setting if 2175setting use B<Num_Lock> to toggle Application-Keypad setting if
2197 2242
2198=head1 CONFIGURE OPTIONS 2243=head1 CONFIGURE OPTIONS
2199 2244
2200General hint: if you get compile errors, then likely your configuration 2245General hint: if you get compile errors, then likely your configuration
2201hasn't been tested well. Either try with C<--enable-everything> or use 2246hasn'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 2247the 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 2248switches). 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 2249work, so it can be fixed. Marc Lehmann <rxvt@schmorp.de>.
2205Lehmann <rxvt@schmorp.de>.
2206 2250
2207All 2251All
2208 2252
2209=over 4 2253=over 4
2210 2254
2211=item --enable-everything 2255=item --enable-everything
2212 2256
2213Add (or remove) support for all non-multichoice options listed in "./configure 2257Add (or remove) support for all non-multichoice options listed in
2214--help". 2258C<./configure --help>, except for C<--enable-assert>.
2215 2259
2216You can specify this and then disable options you do not like by 2260You can specify this and then disable options you do not like by
2217I<following> this with the appropriate C<--disable-...> arguments, 2261I<following> this with the appropriate C<--disable-...> arguments,
2218or you can start with a minimal configuration by specifying 2262or you can start with a minimal configuration by specifying
2219C<--disable-everything> and than adding just the C<--enable-...> arguments 2263C<--disable-everything> and than adding just the C<--enable-...> arguments
2220you want. 2264you want.
2265
2266=item --enable-256-color (default: off)
2267
2268Add support for 256 colors.
2221 2269
2222=item --enable-xft (default: enabled) 2270=item --enable-xft (default: enabled)
2223 2271
2224Add support for Xft (anti-aliases, among others) fonts. Xft fonts are 2272Add support for Xft (anti-aliases, among others) fonts. Xft fonts are
2225slower and require lots of memory, but as long as you don't use them, you 2273slower and require lots of memory, but as long as you don't use them, you
2242 2290
2243=begin table 2291=begin table
2244 2292
2245 all all available codeset groups 2293 all all available codeset groups
2246 zh common chinese encodings 2294 zh common chinese encodings
2247 zh_ext rarely used but very big chinese encodigs 2295 zh_ext rarely used but very big chinese encodings
2248 jp common japanese encodings 2296 jp common japanese encodings
2249 jp_ext rarely used but big japanese encodings 2297 jp_ext rarely used but big japanese encodings
2250 kr korean encodings 2298 kr korean encodings
2251 2299
2252=end table 2300=end table
2266requirements per character from 2 to 4 bytes. X11 fonts do not yet 2314requirements per character from 2 to 4 bytes. X11 fonts do not yet
2267support these extra characters, but Xft does. 2315support these extra characters, but Xft does.
2268 2316
2269Please note that rxvt-unicode can store unicode code points >65535 2317Please note that rxvt-unicode can store unicode code points >65535
2270even without this flag, but the number of such characters is 2318even without this flag, but the number of such characters is
2271limited to a view thousand (shared with combining characters, 2319limited to a few thousand (shared with combining characters,
2272see next switch), and right now rxvt-unicode cannot display them 2320see next switch), and right now rxvt-unicode cannot display them
2273(input/output and cut&paste still work, though). 2321(input/output and cut&paste still work, though).
2274 2322
2275=item --enable-combining (default: on) 2323=item --enable-combining (default: on)
2276 2324
2277Enable automatic composition of combining characters into 2325Enable automatic composition of combining characters into
2278composite characters. This is required for proper viewing of text 2326composite characters. This is required for proper viewing of text
2279where accents are encoded as seperate unicode characters. This is 2327where accents are encoded as separate unicode characters. This is
2280done by using precomposited characters when available or creating 2328done by using precomposited characters when available or creating
2281new pseudo-characters when no precomposed form exists. 2329new pseudo-characters when no precomposed form exists.
2282 2330
2283Without --enable-unicode3, the number of additional precomposed 2331Without --enable-unicode3, the number of additional precomposed
2284characters is somewhat limited (the 6400 private use characters will be 2332characters is somewhat limited (the 6400 private use characters will be
2299=item --with-res-name=NAME (default: urxvt) 2347=item --with-res-name=NAME (default: urxvt)
2300 2348
2301Use the given name as default application name when 2349Use the given name as default application name when
2302reading resources. Specify --with-res-name=rxvt to replace rxvt. 2350reading resources. Specify --with-res-name=rxvt to replace rxvt.
2303 2351
2304=item --with-res-class=CLASS /default: URxvt) 2352=item --with-res-class=CLASS (default: URxvt)
2305 2353
2306Use the given class as default application class 2354Use the given class as default application class
2307when reading resources. Specify --with-res-class=Rxvt to replace 2355when reading resources. Specify --with-res-class=Rxvt to replace
2308rxvt. 2356rxvt.
2309 2357
2322 2370
2323Write user and tty to lastlog file (used by programs like 2371Write user and tty to lastlog file (used by programs like
2324F<lastlogin>) at start of rxvt execution. This option requires 2372F<lastlogin>) at start of rxvt execution. This option requires
2325--enable-utmp to also be specified. 2373--enable-utmp to also be specified.
2326 2374
2327=item --enable-xpm-background (default: on) 2375=item --enable-afterimage (default: on)
2328 2376
2329Add support for XPM background pixmaps. 2377Add support for libAfterImage to be used for transparency and background
2378images. It adds support for many file formats including JPG, PNG,
2379SVG, TIFF, GIF, XPM, BMP, ICO, XCF, TGA and AfterStep image XML
2380(L<http://www.afterstep.org/visualdoc.php?show=asimagexml>).
2381
2382This option also adds such eye candy as blending an image over the root
2383background, as well as dynamic scaling and bluring of background images.
2384
2385Note that with this option enabled, @@RXVT_NAME@@'s memory footprint might
2386increase by a few megabytes even if no extra features are used (mostly due
2387to third-party libraries used by libAI). Memory footprint may somewhat be
2388lowered if libAfterImage is configured without support for SVG.
2330 2389
2331=item --enable-transparency (default: on) 2390=item --enable-transparency (default: on)
2332 2391
2333Add support for inheriting parent backgrounds thus giving a fake 2392Add support for backgrounds, creating illusion of transparency in the term.
2334transparency to the term.
2335 2393
2336=item --enable-fading (default: on) 2394=item --enable-fading (default: on)
2337 2395
2338Add support for fading the text when focus is lost (requires C<--enable-transparency>). 2396Add 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 2397
2344=item --enable-rxvt-scroll (default: on) 2398=item --enable-rxvt-scroll (default: on)
2345 2399
2346Add support for the original rxvt scrollbar. 2400Add support for the original rxvt scrollbar.
2347 2401
2350Add support for a NeXT-like scrollbar. 2404Add support for a NeXT-like scrollbar.
2351 2405
2352=item --enable-xterm-scroll (default: on) 2406=item --enable-xterm-scroll (default: on)
2353 2407
2354Add support for an Xterm-like scrollbar. 2408Add 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 2409
2367=item --disable-backspace-key 2410=item --disable-backspace-key
2368 2411
2369Removes any handling of the backspace key by us - let the X server do it. 2412Removes any handling of the backspace key by us - let the X server do it.
2370 2413
2390A non-exhaustive list of features enabled by C<--enable-frills> (possibly 2433A non-exhaustive list of features enabled by C<--enable-frills> (possibly
2391in combination with other switches) is: 2434in combination with other switches) is:
2392 2435
2393 MWM-hints 2436 MWM-hints
2394 EWMH-hints (pid, utf8 names) and protocols (ping) 2437 EWMH-hints (pid, utf8 names) and protocols (ping)
2438 urgency hint
2395 seperate underline colour (-underlineColor) 2439 separate underline colour (-underlineColor)
2396 settable border widths and borderless switch (-w, -b, -bl) 2440 settable border widths and borderless switch (-w, -b, -bl)
2397 visual depth selection (-depth) 2441 visual depth selection (-depth)
2398 settable extra linespacing /-lsp) 2442 settable extra linespacing /-lsp)
2399 iso-14755-2 and -3, and visual feedback 2443 iso-14755 5.1 (basic) support
2400 tripleclickwords (-tcw) 2444 tripleclickwords (-tcw)
2401 settable insecure mode (-insecure) 2445 settable insecure mode (-insecure)
2402 keysym remapping support 2446 keysym remapping support
2403 cursor blinking and underline cursor (-cb, -uc) 2447 cursor blinking and underline cursor (-bc, -uc)
2404 XEmbed support (-embed) 2448 XEmbed support (-embed)
2405 user-pty (-pty-fd) 2449 user-pty (-pty-fd)
2406 hold on exit (-hold) 2450 hold on exit (-hold)
2451 compile in built-in block graphics
2407 skip builtin block graphics (-sbg) 2452 skip builtin block graphics (-sbg)
2408 separate highlightcolor support (-hc) 2453 separate highlight colour (-highlightColor, -highlightTextColor)
2409 2454
2410It also enables some non-essential features otherwise disabled, such as: 2455It also enables some non-essential features otherwise disabled, such as:
2411 2456
2412 some round-trip time optimisations 2457 some round-trip time optimisations
2413 nearest color allocation on pseudocolor screens 2458 nearest color allocation on pseudocolor screens
2414 UTF8_STRING supporr for selection 2459 UTF8_STRING support for selection
2415 sgr modes 90..97 and 100..107 2460 sgr modes 90..97 and 100..107
2416 backindex and forwardindex escape sequences 2461 backindex and forwardindex escape sequences
2417 view change/zero scorllback esacpe sequences 2462 view change/zero scrollback escape sequences
2418 locale switching escape sequence 2463 locale switching escape sequence
2419 window op and some xterm/OSC escape sequences 2464 window op and some xterm/OSC escape sequences
2420 rectangular selections 2465 rectangular selections
2421 trailing space removal for selections 2466 trailing space removal for selections
2422 verbose X error handling 2467 verbose X error handling
2423 2468
2424=item --enable-iso14755 (default: on) 2469=item --enable-iso14755 (default: on)
2425 2470
2426Enable extended ISO 14755 support (see @@RXVT_NAME@@(1), or 2471Enable extended ISO 14755 support (see @@RXVT_NAME@@(1)).
2427F<doc/rxvt.1.txt>). Basic support (section 5.1) is enabled by 2472Basic support (section 5.1) is enabled by C<--enable-frills>, while
2428C<--enable-frills>, while support for 5.2, 5.3 and 5.4 is enabled with 2473support for 5.2, 5.3 and 5.4 is enabled with this switch.
2429this switch.
2430 2474
2431=item --enable-keepscrolling (default: on) 2475=item --enable-keepscrolling (default: on)
2432 2476
2433Add support for continual scrolling of the display when you hold 2477Add support for continual scrolling of the display when you hold
2434the mouse button down on a scrollbar arrow. 2478the mouse button down on a scrollbar arrow.
2479
2480=item --enable-selectionscrolling (default: on)
2481
2482Add support for scrolling when the selection moves to the top or
2483bottom of the screen.
2435 2484
2436=item --enable-mousewheel (default: on) 2485=item --enable-mousewheel (default: on)
2437 2486
2438Add support for scrolling via mouse wheel or buttons 4 & 5. 2487Add support for scrolling via mouse wheel or buttons 4 & 5.
2439 2488
2441 2490
2442Add support for continual scrolling (using the mouse wheel as an 2491Add support for continual scrolling (using the mouse wheel as an
2443accelerator) while the control key is held down. This option 2492accelerator) while the control key is held down. This option
2444requires --enable-mousewheel to also be specified. 2493requires --enable-mousewheel to also be specified.
2445 2494
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) 2495=item --enable-smart-resize (default: off)
2466 2496
2467Add smart growth/shrink behaviour when changing font size via hot 2497Add smart growth/shrink behaviour when resizing.
2468keys. This should keep the window corner which is closest to a corner of 2498This should keep the window corner which is closest to a corner of
2469the screen in a fixed position. 2499the screen in a fixed position.
2470 2500
2501=item --enable-text-blink (default: on)
2502
2503Add support for blinking text.
2504
2471=item --enable-pointer-blank (default: on) 2505=item --enable-pointer-blank (default: on)
2472 2506
2473Add support to have the pointer disappear when typing or inactive. 2507Add support to have the pointer disappear when typing or inactive.
2474 2508
2475=item --enable-perl (default: on) 2509=item --enable-perl (default: on)
2476 2510
2477Enable an embedded perl interpreter. See the B<@@RXVT_NAME@@perl(3)> 2511Enable 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 2512manpage for more info on this feature, or the files in F<src/perl/>
2479in F<src/perl-ext/> for the extensions that are installed by default. The 2513for the extensions that are installed by default.
2480perl interpreter that is used can be specified via the C<PERL> environment 2514The perl interpreter that is used can be specified via the C<PERL>
2481variable when running configure. 2515environment variable when running configure. Even when compiled in,
2516perl will I<not> be initialised when all extensions have been disabled
2517C<-pe "" --perl-ext-common "">, so it should be safe to enable from a
2518resource standpoint.
2519
2520=item --enable-assert (default: off)
2521
2522Enables the assertions in the code, normally disabled. This switch is only
2523useful when developing rxvt-unicode.
2524
2525=item --with-afterimage-config=DIR
2526
2527Look for the libAfterImage config script in DIR.
2482 2528
2483=item --with-name=NAME (default: urxvt) 2529=item --with-name=NAME (default: urxvt)
2484 2530
2485Set the basename for the installed binaries, resulting 2531Set the basename for the installed binaries, resulting
2486in C<urxvt>, C<urxvtd> etc.). Specify C<--with-name=rxvt> to replace with 2532in C<urxvt>, C<urxvtd> etc.). Specify C<--with-name=rxvt> to replace with
2496PATH. 2542PATH.
2497 2543
2498=item --with-x 2544=item --with-x
2499 2545
2500Use the X Window System (pretty much default, eh?). 2546Use 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 2547
2514=back 2548=back
2515 2549
2516=head1 AUTHORS 2550=head1 AUTHORS
2517 2551

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines