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.113 by root, Thu Feb 2 18:04:45 2006 UTC vs.
Revision 1.143 by ayin, Thu Aug 2 00:09:54 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
90This tries to create a new terminal, and if fails with exit status 2, 90This tries to create a new terminal, and if fails with exit status 2,
91meaning it couldn't connect to the daemon, it will start the daemon and 91meaning it couldn't connect to the daemon, it will start the daemon and
92re-run the command. Subsequent invocations of the script will re-use the 92re-run the command. Subsequent invocations of the script will re-use the
93existing daemon. 93existing daemon.
94 94
95=head3 How do I distinguish wether I'm running rxvt-unicode or a regular xterm? I need this to decide about setting colors etc. 95=head3 How do I distinguish whether I'm running rxvt-unicode or a regular xterm? I need this to decide about setting colors etc.
96 96
97The original rxvt and rxvt-unicode always export the variable "COLORTERM", 97The original rxvt and rxvt-unicode always export the variable "COLORTERM",
98so you can check and see if that is set. Note that several programs, JED, 98so you can check and see if that is set. Note that several programs, JED,
99slrn, Midnight Commander automatically check this variable to decide 99slrn, Midnight Commander automatically check this variable to decide
100whether or not to use color. 100whether or not to use color.
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
144 98398 1664 24 15695 1824 rxvt --disable-everything 144 98398 1664 24 15695 1824 rxvt --disable-everything
145 188985 9048 66616 18222 1788 urxvt --disable-everything 145 188985 9048 66616 18222 1788 urxvt --disable-everything
146 146
147When you C<--enable-everything> (which I<is> unfair, as this involves xft 147When you C<--enable-everything> (which I<is> unfair, as this involves xft
148and full locale/XIM support which are quite bloaty inside libX11 and my 148and full locale/XIM support which are quite bloaty inside libX11 and my
149libc), the two diverge, but not unreasnobaly so. 149libc), the two diverge, but not unreasonably so.
150 150
151 text data bss drs rss filename 151 text data bss drs rss filename
152 163431 2152 24 20123 2060 rxvt --enable-everything 152 163431 2152 24 20123 2060 rxvt --enable-everything
153 1035683 49680 66648 29096 3680 urxvt --enable-everything 153 1035683 49680 66648 29096 3680 urxvt --enable-everything
154 154
241 241
242 @@URXVT_NAME@@ -depth 32 -fg grey90 -bg rgba:0000/0000/4444/cccc 242 @@URXVT_NAME@@ -depth 32 -fg grey90 -bg rgba:0000/0000/4444/cccc
243 243
244This requires XFT support, and the support of your X-server. If that 244This requires XFT support, and the support of your X-server. If that
245doesn't work for you, blame Xorg and Keith Packard. ARGB visuals aren't 245doesn't work for you, blame Xorg and Keith Packard. ARGB visuals aren't
246there yet, no matter what they claim. Rxvt-Unicode contains the neccessary 246there yet, no matter what they claim. Rxvt-Unicode contains the necessary
247bugfixes and workarounds for Xft and Xlib to make it work, but that 247bugfixes and workarounds for Xft and Xlib to make it work, but that
248doesn't mean that your WM has the required kludges in place. 248doesn't mean that your WM has the required kludges in place.
249 249
2504. Use xcompmgr and let it do the job: 2504. Use xcompmgr and let it do the job:
251 251
268however: Xft fonts often draw glyphs larger than their acclaimed bounding 268however: Xft fonts often draw glyphs larger than their acclaimed bounding
269box, and rxvt-unicode has no way of detecting this (the correct way is to 269box, and rxvt-unicode has no way of detecting this (the correct way is to
270ask for the character bounding box, which unfortunately is wrong in these 270ask for the character bounding box, which unfortunately is wrong in these
271cases). 271cases).
272 272
273It's not clear (to me at least), wether this is a bug in Xft, freetype, 273It's not clear (to me at least), whether this is a bug in Xft, freetype,
274or the respective font. If you encounter this problem you might try using 274or the respective font. If you encounter this problem you might try using
275the C<-lsp> option to give the font more height. If that doesn't work, you 275the C<-lsp> option to give the font more height. If that doesn't work, you
276might be forced to use a different font. 276might be forced to use a different font.
277 277
278All of this is not a problem when using X11 core fonts, as their bounding 278All of this is not a problem when using X11 core fonts, as their bounding
302=head3 Can I switch the fonts at runtime? 302=head3 Can I switch the fonts at runtime?
303 303
304Yes, using an escape sequence. Try something like this, which has the same 304Yes, using an escape sequence. Try something like this, which has the same
305effect as using the C<-fn> switch, and takes effect immediately: 305effect as using the C<-fn> switch, and takes effect immediately:
306 306
307 printf '\e]50;%s\007' "9x15bold,xft:Kochi Gothic" 307 printf '\33]50;%s\007' "9x15bold,xft:Kochi Gothic"
308 308
309This is useful if you e.g. work primarily with japanese (and prefer a 309This is useful if you e.g. work primarily with japanese (and prefer a
310japanese font), but you have to switch to chinese temporarily, where 310japanese font), but you have to switch to chinese temporarily, where
311japanese fonts would only be in your way. 311japanese fonts would only be in your way.
312 312
314 314
315=head3 Why do italic characters look as if clipped? 315=head3 Why do italic characters look as if clipped?
316 316
317Many fonts have difficulties with italic characters and hinting. For 317Many fonts have difficulties with italic characters and hinting. For
318example, the otherwise very nicely hinted font C<xft:Bitstream Vera Sans 318example, the otherwise very nicely hinted font C<xft:Bitstream Vera Sans
319Mono> completely fails in it's italic face. A workaround might be to 319Mono> completely fails in its italic face. A workaround might be to
320enable freetype autohinting, i.e. like this: 320enable freetype autohinting, i.e. like this:
321 321
322 URxvt.italicFont: xft:Bitstream Vera Sans Mono:italic:autohint=true 322 URxvt.italicFont: xft:Bitstream Vera Sans Mono:italic:autohint=true
323 URxvt.boldItalicFont: xft:Bitstream Vera Sans Mono:bold:italic:autohint=true 323 URxvt.boldItalicFont: xft:Bitstream Vera Sans Mono:bold:italic:autohint=true
324 324
330memory and also speeds up rendering considerably. 330memory and also speeds up rendering considerably.
331 331
332=head3 Rxvt-unicode doesn't seem to anti-alias its fonts, what is wrong? 332=head3 Rxvt-unicode doesn't seem to anti-alias its fonts, what is wrong?
333 333
334Rxvt-unicode will use whatever you specify as a font. If it needs to 334Rxvt-unicode will use whatever you specify as a font. If it needs to
335fall back to it's default font search list it will prefer X11 core 335fall back to its default font search list it will prefer X11 core
336fonts, because they are small and fast, and then use Xft fonts. It has 336fonts, because they are small and fast, and then use Xft fonts. It has
337antialiasing disabled for most of them, because the author thinks they 337antialiasing disabled for most of them, because the author thinks they
338look best that way. 338look best that way.
339 339
340If you want antialiasing, you have to specify the fonts manually. 340If you want antialiasing, you have to specify the fonts manually.
512circumstances, it will move your cursor around when you click into the 512circumstances, it will move your cursor around when you click into the
513line that contains it. It tries hard not to do this at the wrong moment, 513line that contains it. It tries hard not to do this at the wrong moment,
514but when running a program that doesn't parse cursor movements or in some 514but when running a program that doesn't parse cursor movements or in some
515cases during rlogin sessions, it fails to detect this properly. 515cases during rlogin sessions, it fails to detect this properly.
516 516
517You can permamently switch this feature off by disabling the C<readline> 517You can permanently switch this feature off by disabling the C<readline>
518extension: 518extension:
519 519
520 URxvt.perl-ext-common: default,-readline 520 URxvt.perl-ext-common: default,-readline
521 521
522=head3 My numerical keypad acts weird and generates differing output? 522=head3 My numerical keypad acts weird and generates differing output?
523 523
524Some Debian GNUL/Linux users seem to have this problem, although no 524Some Debian GNUL/Linux users seem to have this problem, although no
525specific details were reported so far. It is possible that this is caused 525specific details were reported so far. It is possible that this is caused
526by the wrong C<TERM> setting, although the details of wether and how 526by the wrong C<TERM> setting, although the details of whether and how
527this can happen are unknown, as C<TERM=rxvt> should offer a compatible 527this can happen are unknown, as C<TERM=rxvt> should offer a compatible
528keymap. See the answer to the previous question, and please report if that 528keymap. See the answer to the previous question, and please report if that
529helped. 529helped.
530 530
531=head3 My Compose (Multi_key) key is no longer working. 531=head3 My Compose (Multi_key) key is no longer working.
557depressed. 557depressed.
558 558
559=head3 What's with the strange Backspace/Delete key behaviour? 559=head3 What's with the strange Backspace/Delete key behaviour?
560 560
561Assuming that the physical Backspace key corresponds to the 561Assuming that the physical Backspace key corresponds to the
562BackSpace keysym (not likely for Linux ... see the following 562Backspace keysym (not likely for Linux ... see the following
563question) there are two standard values that can be used for 563question) there are two standard values that can be used for
564Backspace: C<^H> and C<^?>. 564Backspace: C<^H> and C<^?>.
565 565
566Historically, either value is correct, but rxvt-unicode adopts the debian 566Historically, either value is correct, but rxvt-unicode adopts the debian
567policy of using C<^?> when unsure, because it's the one only only correct 567policy of using C<^?> when unsure, because it's the one and only correct
568choice :). 568choice :).
569 569
570Rxvt-unicode tries to inherit the current stty settings and uses the value 570Rxvt-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 571of `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 572started from a terminal (say, from a menu or by remote shell), then the
658 658
659 659
660 660
661=head2 Terminal Configuration 661=head2 Terminal Configuration
662 662
663=head3 Can I see a typical configuration?
664
665The default configuration tries to be xterm-like, which I don't like that
666much, but it's least surprise to regular users.
667
668As a rxvt or rxvt-unicode user, you are practically supposed to invest
669time into customising your terminal. To get you started, here is the
670author's .Xdefaults entries, with comments on what they do. It's certainly
671not I<typical>, but what's typical...
672
673 URxvt.cutchars: "()*,<>[]{}|'
674 URxvt.print-pipe: cat >/tmp/xxx
675
676These are just for testing stuff.
677
678 URxvt.imLocale: ja_JP.UTF-8
679 URxvt.preeditType: OnTheSpot,None
680
681This tells rxvt-unicode to use a special locale when communicating with
682the X Input Method, and also tells it to only use the OnTheSpot pre-edit
683type, which requires the C<xim-onthespot> perl extension but rewards me
684with correct-looking fonts.
685
686 URxvt.perl-lib: /root/lib/urxvt
687 URxvt.perl-ext-common: default,selection-autotransform,selection-pastebin,xim-onthespot,remote-clipboard
688 URxvt.selection.pattern-0: ( at .*? line \\d+)
689 URxvt.selection.pattern-1: ^(/[^:]+):\
690 URxvt.selection-autotransform.0: s/^([^:[:space:]]+):(\\d+):?$/:e \\Q$1\\E\\x0d:$2\\x0d/
691 URxvt.selection-autotransform.1: s/^ at (.*?) line (\\d+)$/:e \\Q$1\\E\\x0d:$2\\x0d/
692
693This is my perl configuration. The first two set the perl library
694directory and also tells urxvt to use a large number of extensions. I
695develop for myself mostly, so I actually use most of the extensions I
696write.
697
698The selection stuff mainly makes the selection perl-error-message aware
699and tells it to convert perl error messages into vi-commands to load the
700relevant file and go tot he error line number.
701
702 URxvt.scrollstyle: plain
703 URxvt.secondaryScroll: true
704
705As the documentation says: plain is the preferred scrollbar for the
706author. The C<secondaryScroll> configures urxvt to scroll in full-screen
707apps, like screen, so lines scrolled out of screen end up in urxvt's
708scrollback buffer.
709
710 URxvt.background: #000000
711 URxvt.foreground: gray90
712 URxvt.color7: gray90
713 URxvt.colorBD: #ffffff
714 URxvt.cursorColor: #e0e080
715 URxvt.throughColor: #8080f0
716 URxvt.highlightColor: #f0f0f0
717
718Some colours. Not sure which ones are being used or even non-defaults, but
719these are in my .Xdefaults. Most notably, they set foreground/background
720to light gray/black, and also make sure that the colour 7 matches the
721default foreground colour.
722
723 URxvt.underlineColor: yellow
724
725Another colour, makes underline lines look different. Sometimes hurts, but
726is mostly a nice effect.
727
728 URxvt.geometry: 154x36
729 URxvt.loginShell: false
730 URxvt.meta: ignore
731 URxvt.utmpInhibit: true
732
733Uh, well, should be mostly self-explanatory. By specifying some defaults
734manually, I can quickly switch them for testing.
735
736 URxvt.saveLines: 8192
737
738A large scrollback buffer is essential. Really.
739
740 URxvt.mapAlert: true
741
742The only case I use it is for my IRC window, which I like to keep
743iconified till people msg me (which beeps).
744
745 URxvt.visualBell: true
746
747The audible bell is often annoying, especially when in a crowd.
748
749 URxvt.insecure: true
750
751Please don't hack my mutt! Ooops...
752
753 URxvt.pastableTabs: false
754
755I once thought this is a great idea.
756
757 urxvt.font: 9x15bold,\
758 -misc-fixed-bold-r-normal--15-140-75-75-c-90-iso10646-1,\
759 -misc-fixed-medium-r-normal--15-140-75-75-c-90-iso10646-1, \
760 [codeset=JISX0208]xft:Kochi Gothic, \
761 xft:Bitstream Vera Sans Mono:autohint=true, \
762 xft:Code2000:antialias=false
763 urxvt.boldFont: -xos4-terminus-bold-r-normal--14-140-72-72-c-80-iso8859-15
764 urxvt.italicFont: xft:Bitstream Vera Sans Mono:italic:autohint=true
765 urxvt.boldItalicFont: xft:Bitstream Vera Sans Mono:bold:italic:autohint=true
766
767I wrote rxvt-unicode to be able to specify fonts exactly. So don't be
768overwhelmed. A special note: the C<9x15bold> mentioned above is actually
769the version from XFree-3.3, as XFree-4 replaced it by a totally different
770font (different glyphs for C<;> and many other harmless characters),
771while the second font is actually the C<9x15bold> from XFree4/XOrg. The
772bold version has less chars than the medium version, so I use it for rare
773characters, too. When editing sources with vim, I use italic for comments
774and other stuff, which looks quite good with Bitstream Vera anti-aliased.
775
776Terminus is a quite bad font (many very wrong glyphs), but for most of my
777purposes, 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
779normal fonts.
780
781Please 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,
783for example, my IRC window is started with C<-name IRC>, and uses these
784defaults:
785
786 IRC*title: IRC
787 IRC*geometry: 87x12+535+542
788 IRC*saveLines: 0
789 IRC*mapAlert: true
790 IRC*font: suxuseuro
791 IRC*boldFont: suxuseuro
792 IRC*colorBD: white
793 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
795
796C<Alt-Shift-1> and C<Alt-Shift-2> switch between two different font
797sizes. C<suxuseuro> allows me to keep an eye (and actually read)
798stuff while keeping a very small window. If somebody pastes something
799complicated (e.g. japanese), I temporarily switch to a larger font.
800
801The above is all in my C<.Xdefaults> (I don't use C<.Xresources> nor
802C<xrdb>). I also have some resources in a separate C<.Xdefaults-hostname>
803file for different hosts, for example, on ym main desktop, I use:
804
805 URxvt.keysym.C-M-q: command:\033[3;5;5t
806 URxvt.keysym.C-M-y: command:\033[3;5;606t
807 URxvt.keysym.C-M-e: command:\033[3;1605;5t
808 URxvt.keysym.C-M-c: command:\033[3;1605;606t
809 URxvt.keysym.C-M-p: perl:test
810
811The first for keysym definitions allow me to quickly bring some windows
812in the layout I like most. Ion users might start laughing but will stop
813immediately when I tell them that I use my own Fvwm2 module for much the
814same effect as Ion provides, and I only very rarely use the above key
815combinations :->
816
663=head3 Why doesn't rxvt-unicode read my resources? 817=head3 Why doesn't rxvt-unicode read my resources?
664 818
665Well, why, indeed? It does, in a way very similar to other X 819Well, why, indeed? It does, in a way very similar to other X
666applications. Most importantly, this means that if you or your OS loads 820applications. Most importantly, this means that if you or your OS loads
667resources into the X display (the right way to do it), rxvt-unicode will 821resources into the X display (the right way to do it), rxvt-unicode will
675Also consider the form resources have to use: 829Also consider the form resources have to use:
676 830
677 URxvt.resource: value 831 URxvt.resource: value
678 832
679If you want to use another form (there are lots of different ways of 833If you want to use another form (there are lots of different ways of
680specifying resources), make sure you understand wether and why it 834specifying resources), make sure you understand whether and why it
681works. If unsure, use the form above. 835works. If unsure, use the form above.
682 836
683=head3 When I log-in to another system it tells me about missing terminfo data? 837=head3 When I log-in to another system it tells me about missing terminfo data?
684 838
685The terminal description used by rxvt-unicode is not as widely available 839The terminal description used by rxvt-unicode is not as widely available
686as that for xterm, or even rxvt (for which the same problem often arises). 840as that for xterm, or even rxvt (for which the same problem often arises).
687 841
688The correct solution for this problem is to install the terminfo, this can 842The correct solution for this problem is to install the terminfo, this can
689be done like this (with ncurses' infocmp): 843be done like this (with ncurses' infocmp and works as user and admin):
690 844
691 REMOTE=remotesystem.domain 845 REMOTE=remotesystem.domain
692 infocmp rxvt-unicode | ssh $REMOTE "cat >/tmp/ti && tic /tmp/ti" 846 infocmp rxvt-unicode | ssh $REMOTE "mkdir -p .terminfo && cat >/tmp/ti && tic /tmp/ti"
693 847
694... or by installing rxvt-unicode normally on the remote system, 848... or by installing rxvt-unicode normally on the remote system,
849
850One some systems you might need to set C<$TERMINFO> to the full path of
851F<$HOME/.terminfo> for this to work.
695 852
696If you cannot or do not want to do this, then you can simply set 853If you cannot or do not want to do this, then you can simply set
697C<TERM=rxvt> or even C<TERM=xterm>, and live with the small number of 854C<TERM=rxvt> or even C<TERM=xterm>, and live with the small number of
698problems arising, which includes wrong keymapping, less and different 855problems arising, which includes wrong keymapping, less and different
699colours and some refresh errors in fullscreen applications. It's a nice 856colours and some refresh errors in fullscreen applications. It's a nice
722One reason you might want this is that some distributions or operating 879One reason you might want this is that some distributions or operating
723systems still compile some programs using the long-obsoleted termcap 880systems still compile some programs using the long-obsoleted termcap
724library (Fedora Core's bash is one example) and rely on a termcap entry 881library (Fedora Core's bash is one example) and rely on a termcap entry
725for C<rxvt-unicode>. 882for C<rxvt-unicode>.
726 883
727You could use rxvt's termcap entry with resonable results in many cases. 884You could use rxvt's termcap entry with reasonable results in many cases.
728You can also create a termcap entry by using terminfo's infocmp program 885You can also create a termcap entry by using terminfo's infocmp program
729like this: 886like this:
730 887
731 infocmp -C rxvt-unicode 888 infocmp -C rxvt-unicode
732 889
754 :vs=\E[?25h: 911 :vs=\E[?25h:
755 912
756=head3 Why does C<ls> no longer have coloured output? 913=head3 Why does C<ls> no longer have coloured output?
757 914
758The C<ls> in the GNU coreutils unfortunately doesn't use terminfo to 915The C<ls> in the GNU coreutils unfortunately doesn't use terminfo to
759decide wether a terminal has colour, but uses it's own configuration 916decide whether a terminal has colour, but uses its own configuration
760file. Needless to say, C<rxvt-unicode> is not in it's default file (among 917file. Needless to say, C<rxvt-unicode> is not in its default file (among
761with most other terminals supporting colour). Either add: 918with most other terminals supporting colour). Either add:
762 919
763 TERM rxvt-unicode 920 TERM rxvt-unicode
764 921
765to C</etc/DIR_COLORS> or simply add: 922to C</etc/DIR_COLORS> or simply add:
799If you encounter strange problems like typing an accented character but 956If you encounter strange problems like typing an accented character but
800getting two unrelated other characters or similar, or if program output is 957getting two unrelated other characters or similar, or if program output is
801subtly garbled, then you should check your locale settings. 958subtly garbled, then you should check your locale settings.
802 959
803Rxvt-unicode must be started with the same C<LC_CTYPE> setting as the 960Rxvt-unicode must be started with the same C<LC_CTYPE> setting as the
804programs. Often rxvt-unicode is started in the C<C> locale, while the 961programs running in it. Often rxvt-unicode is started in the C<C> locale,
805login script running within the rxvt-unicode window changes the locale to 962while the login script running within the rxvt-unicode window changes the
806something else, e.g. C<en_GB.UTF-8>. Needless to say, this is not going to work. 963locale to something else, e.g. C<en_GB.UTF-8>. Needless to say, this is
964not going to work, and is the most common cause for problems.
807 965
808The best thing is to fix your startup environment, as you will likely run 966The best thing is to fix your startup environment, as you will likely run
809into other problems. If nothing works you can try this in your .profile. 967into other problems. If nothing works you can try this in your .profile.
810 968
811 printf '\e]701;%s\007' "$LC_CTYPE" 969 printf '\33]701;%s\007' "$LC_CTYPE" # $LANG or $LC_ALL are worth a try, too
812 970
813If this doesn't work, then maybe you use a C<LC_CTYPE> specification not 971If this doesn't work, then maybe you use a C<LC_CTYPE> specification not
814supported on your systems. Some systems have a C<locale> command which 972supported on your systems. Some systems have a C<locale> command which
815displays this (also, C<perl -e0> can be used to check locale settings, as 973displays this (also, C<perl -e0> can be used to check locale settings, as
816it will complain loudly if it cannot set the locale). If it displays something 974it will complain loudly if it cannot set the locale). If it displays something
837The reasons is that there exists a perfectly fine mechanism for selecting 995The reasons is that there exists a perfectly fine mechanism for selecting
838the encoding, doing I/O and (most important) communicating this to all 996the encoding, doing I/O and (most important) communicating this to all
839applications so everybody agrees on character properties such as width 997applications so everybody agrees on character properties such as width
840and code number. This mechanism is the I<locale>. Applications not using 998and code number. This mechanism is the I<locale>. Applications not using
841that info will have problems (for example, C<xterm> gets the width of 999that info will have problems (for example, C<xterm> gets the width of
842characters wrong as it uses it's own, locale-independent table under all 1000characters wrong as it uses its own, locale-independent table under all
843locales). 1001locales).
844 1002
845Rxvt-unicode uses the C<LC_CTYPE> locale category to select encoding. All 1003Rxvt-unicode uses the C<LC_CTYPE> locale category to select encoding. All
846programs doing the same (that is, most) will automatically agree in the 1004programs doing the same (that is, most) will automatically agree in the
847interpretation of characters. 1005interpretation of characters.
866=head3 Can I switch locales at runtime? 1024=head3 Can I switch locales at runtime?
867 1025
868Yes, using an escape sequence. Try something like this, which sets 1026Yes, using an escape sequence. Try something like this, which sets
869rxvt-unicode's idea of C<LC_CTYPE>. 1027rxvt-unicode's idea of C<LC_CTYPE>.
870 1028
871 printf '\e]701;%s\007' ja_JP.SJIS 1029 printf '\33]701;%s\007' ja_JP.SJIS
872 1030
873See also the previous answer. 1031See also the previous answer.
874 1032
875Sometimes this capability is rather handy when you want to work in 1033Sometimes this capability is rather handy when you want to work in
876one locale (e.g. C<de_DE.UTF-8>) but some programs don't support it 1034one locale (e.g. C<de_DE.UTF-8>) but some programs don't support it
877(e.g. UTF-8). For example, I use this script to start C<xjdic>, which 1035(e.g. UTF-8). For example, I use this script to start C<xjdic>, which
878first switches to a locale supported by xjdic and back later: 1036first switches to a locale supported by xjdic and back later:
879 1037
880 printf '\e]701;%s\007' ja_JP.SJIS 1038 printf '\33]701;%s\007' ja_JP.SJIS
881 xjdic -js 1039 xjdic -js
882 printf '\e]701;%s\007' de_DE.UTF-8 1040 printf '\33]701;%s\007' de_DE.UTF-8
883 1041
884You can also use xterm's C<luit> program, which usually works fine, except 1042You can also use xterm's C<luit> program, which usually works fine, except
885for some locales where character width differs between program- and 1043for some locales where character width differs between program- and
886rxvt-unicode-locales. 1044rxvt-unicode-locales.
887 1045
905=item - Make sure your XIM server is actually running. 1063=item - Make sure your XIM server is actually running.
906 1064
907=item - Make sure the C<XMODIFIERS> environment variable is set correctly when I<starting> rxvt-unicode. 1065=item - Make sure the C<XMODIFIERS> environment variable is set correctly when I<starting> rxvt-unicode.
908 1066
909When you want to use e.g. B<kinput2>, it must be set to 1067When you want to use e.g. B<kinput2>, it must be set to
910C<@im=kinput2>. For B<scim>, use C<@im=SCIM>. Youc an see what input 1068C<@im=kinput2>. For B<scim>, use C<@im=SCIM>. You can see what input
911method servers are running with this command: 1069method servers are running with this command:
912 1070
913 xprop -root XIM_SERVERS 1071 xprop -root XIM_SERVERS
914 1072
915=item 1073=item
960 1118
961=head3 I am maintaining rxvt-unicode for distribution/OS XXX, any recommendation? 1119=head3 I am maintaining rxvt-unicode for distribution/OS XXX, any recommendation?
962 1120
963You should build one binary with the default options. F<configure> 1121You should build one binary with the default options. F<configure>
964now enables most useful options, and the trend goes to making them 1122now enables most useful options, and the trend goes to making them
965runtime-switchable, too, so there is usually no drawback to enbaling them, 1123runtime-switchable, too, so there is usually no drawback to enabling them,
966except higher disk and possibly memory usage. The perl interpreter should 1124except higher disk and possibly memory usage. The perl interpreter should
967be enabled, as important functionality (menus, selection, likely more in 1125be enabled, as important functionality (menus, selection, likely more in
968the future) depends on it. 1126the future) depends on it.
969 1127
970You should not overwrite the C<perl-ext-common> snd C<perl-ext> resources 1128You should not overwrite the C<perl-ext-common> snd C<perl-ext> resources
993This forking is done as the very first within main(), which is very early 1151This forking is done as the very first within main(), which is very early
994and reduces possible bugs to initialisation code run before main(), or 1152and reduces possible bugs to initialisation code run before main(), or
995things like the dynamic loader of your system, which should result in very 1153things like the dynamic loader of your system, which should result in very
996little risk. 1154little risk.
997 1155
998=head3 On Solaris 9, many line-drawing characters are too wide.
999
1000Seems to be a known bug, read
1001L<http://nixdoc.net/files/forum/about34198.html>. Some people use the
1002following ugly workaround to get non-double-wide-characters working:
1003
1004 #define wcwidth(x) wcwidth(x) > 1 ? 1 : wcwidth(x)
1005
1006=head3 I am on FreeBSD and rxvt-unicode does not seem to work at all. 1156=head3 I am on FreeBSD and rxvt-unicode does not seem to work at all.
1007 1157
1008Rxvt-unicode requires the symbol C<__STDC_ISO_10646__> to be defined 1158Rxvt-unicode requires the symbol C<__STDC_ISO_10646__> to be defined
1009in your compile environment, or an implementation that implements it, 1159in your compile environment, or an implementation that implements it,
1010wether it defines the symbol or not. C<__STDC_ISO_10646__> requires that 1160whether it defines the symbol or not. C<__STDC_ISO_10646__> requires that
1011B<wchar_t> is represented as unicode. 1161B<wchar_t> is represented as unicode.
1012 1162
1013As you might have guessed, FreeBSD does neither define this symobl nor 1163As you might have guessed, FreeBSD does neither define this symbol nor
1014does it support it. Instead, it uses it's own internal representation of 1164does it support it. Instead, it uses its own internal representation of
1015B<wchar_t>. This is, of course, completely fine with respect to standards. 1165B<wchar_t>. This is, of course, completely fine with respect to standards.
1016 1166
1017However, that means rxvt-unicode only works in C<POSIX>, C<ISO-8859-1> and 1167However, that means rxvt-unicode only works in C<POSIX>, C<ISO-8859-1> and
1018C<UTF-8> locales under FreeBSD (which all use Unicode as B<wchar_t>. 1168C<UTF-8> locales under FreeBSD (which all use Unicode as B<wchar_t>.
1019 1169
1033 1183
1034The rxvt-unicode author insists that the right way to fix this is in the 1184The rxvt-unicode author insists that the right way to fix this is in the
1035system libraries once and for all, instead of forcing every app to carry 1185system libraries once and for all, instead of forcing every app to carry
1036complete replacements for them :) 1186complete replacements for them :)
1037 1187
1038=head3 I use Solaris 9 and it doesn't compile/work/etc.
1039
1040Try the diff in F<doc/solaris9.patch> as a base. It fixes the worst
1041problems with C<wcwidth> and a compile problem.
1042
1043=head3 How can I use rxvt-unicode under cygwin? 1188=head3 How can I use rxvt-unicode under cygwin?
1044 1189
1045rxvt-unicode should compile and run out of the box on cygwin, using 1190rxvt-unicode should compile and run out of the box on cygwin, using
1046the X11 libraries that come with cygwin. libW11 emulation is no 1191the X11 libraries that come with cygwin. libW11 emulation is no
1047longer supported (and makes no sense, either, as it only supported a 1192longer supported (and makes no sense, either, as it only supported a
1050old libW11 emulation. 1195old libW11 emulation.
1051 1196
1052At the time of this writing, cygwin didn't seem to support any multi-byte 1197At the time of this writing, cygwin didn't seem to support any multi-byte
1053encodings (you might try C<LC_CTYPE=C-UTF-8>), so you are likely limited 1198encodings (you might try C<LC_CTYPE=C-UTF-8>), so you are likely limited
1054to 8-bit encodings. 1199to 8-bit encodings.
1200
1201=head3 Character widths are not correct.
1202
1203urxvt uses the system wcwidth function to know the information about
1204the width of characters, so on systems with incorrect locale data you
1205will likely get bad results. Two notorious examples are Solaris 9,
1206where single-width characters like U+2514 are reported as double-width,
1207and Darwin 8, where combining chars are reported having width 1.
1208
1209The solution is to upgrade your system or switch to a better one. A
1210possibly working workaround is to use a wcwidth implementation like
1211
1212http://www.cl.cam.ac.uk/~mgk25/ucs/wcwidth.c
1055 1213
1056=head1 RXVT-UNICODE TECHNICAL REFERENCE 1214=head1 RXVT-UNICODE TECHNICAL REFERENCE
1057 1215
1058The rest of this document describes various technical aspects of 1216The rest of this document describes various technical aspects of
1059B<rxvt-unicode>. First the description of supported command sequences, 1217B<rxvt-unicode>. First the description of supported command sequences,
1553 1711
1554Toggle DEC Private Mode Values (rxvt extension). I<where> 1712Toggle DEC Private Mode Values (rxvt extension). I<where>
1555 1713
1556=over 4 1714=over 4
1557 1715
1558=item B<< C<Ps = 1> >> (DECCKM) 1716=item B<< C<Pm = 1> >> (DECCKM)
1559 1717
1560=begin table 1718=begin table
1561 1719
1562 B<< C<h> >> Application Cursor Keys 1720 B<< C<h> >> Application Cursor Keys
1563 B<< C<l> >> Normal Cursor Keys 1721 B<< C<l> >> Normal Cursor Keys
1564 1722
1565=end table 1723=end table
1566 1724
1567=item B<< C<Ps = 2> >> (ANSI/VT52 mode) 1725=item B<< C<Pm = 2> >> (ANSI/VT52 mode)
1568 1726
1569=begin table 1727=begin table
1570 1728
1571 B<< C<h> >> Enter VT52 mode 1729 B<< C<h> >> Enter VT52 mode
1572 B<< C<l> >> Enter VT52 mode 1730 B<< C<l> >> Enter VT52 mode
1573 1731
1574=end table 1732=end table
1575 1733
1576=item B<< C<Ps = 3> >> 1734=item B<< C<Pm = 3> >>
1577 1735
1578=begin table 1736=begin table
1579 1737
1580 B<< C<h> >> 132 Column Mode (DECCOLM) 1738 B<< C<h> >> 132 Column Mode (DECCOLM)
1581 B<< C<l> >> 80 Column Mode (DECCOLM) 1739 B<< C<l> >> 80 Column Mode (DECCOLM)
1582 1740
1583=end table 1741=end table
1584 1742
1585=item B<< C<Ps = 4> >> 1743=item B<< C<Pm = 4> >>
1586 1744
1587=begin table 1745=begin table
1588 1746
1589 B<< C<h> >> Smooth (Slow) Scroll (DECSCLM) 1747 B<< C<h> >> Smooth (Slow) Scroll (DECSCLM)
1590 B<< C<l> >> Jump (Fast) Scroll (DECSCLM) 1748 B<< C<l> >> Jump (Fast) Scroll (DECSCLM)
1591 1749
1592=end table 1750=end table
1593 1751
1594=item B<< C<Ps = 5> >> 1752=item B<< C<Pm = 5> >>
1595 1753
1596=begin table 1754=begin table
1597 1755
1598 B<< C<h> >> Reverse Video (DECSCNM) 1756 B<< C<h> >> Reverse Video (DECSCNM)
1599 B<< C<l> >> Normal Video (DECSCNM) 1757 B<< C<l> >> Normal Video (DECSCNM)
1600 1758
1601=end table 1759=end table
1602 1760
1603=item B<< C<Ps = 6> >> 1761=item B<< C<Pm = 6> >>
1604 1762
1605=begin table 1763=begin table
1606 1764
1607 B<< C<h> >> Origin Mode (DECOM) 1765 B<< C<h> >> Origin Mode (DECOM)
1608 B<< C<l> >> Normal Cursor Mode (DECOM) 1766 B<< C<l> >> Normal Cursor Mode (DECOM)
1609 1767
1610=end table 1768=end table
1611 1769
1612=item B<< C<Ps = 7> >> 1770=item B<< C<Pm = 7> >>
1613 1771
1614=begin table 1772=begin table
1615 1773
1616 B<< C<h> >> Wraparound Mode (DECAWM) 1774 B<< C<h> >> Wraparound Mode (DECAWM)
1617 B<< C<l> >> No Wraparound Mode (DECAWM) 1775 B<< C<l> >> No Wraparound Mode (DECAWM)
1618 1776
1619=end table 1777=end table
1620 1778
1621=item B<< C<Ps = 8> >> I<unimplemented> 1779=item B<< C<Pm = 8> >> I<unimplemented>
1622 1780
1623=begin table 1781=begin table
1624 1782
1625 B<< C<h> >> Auto-repeat Keys (DECARM) 1783 B<< C<h> >> Auto-repeat Keys (DECARM)
1626 B<< C<l> >> No Auto-repeat Keys (DECARM) 1784 B<< C<l> >> No Auto-repeat Keys (DECARM)
1627 1785
1628=end table 1786=end table
1629 1787
1630=item B<< C<Ps = 9> >> X10 XTerm 1788=item B<< C<Pm = 9> >> X10 XTerm
1631 1789
1632=begin table 1790=begin table
1633 1791
1634 B<< C<h> >> Send Mouse X & Y on button press. 1792 B<< C<h> >> Send Mouse X & Y on button press.
1635 B<< C<l> >> No mouse reporting. 1793 B<< C<l> >> No mouse reporting.
1636 1794
1637=end table 1795=end table
1638 1796
1639=item B<< C<Ps = 25> >> 1797=item B<< C<Pm = 25> >>
1640 1798
1641=begin table 1799=begin table
1642 1800
1643 B<< C<h> >> Visible cursor {cnorm/cvvis} 1801 B<< C<h> >> Visible cursor {cnorm/cvvis}
1644 B<< C<l> >> Invisible cursor {civis} 1802 B<< C<l> >> Invisible cursor {civis}
1645 1803
1646=end table 1804=end table
1647 1805
1648=item B<< C<Ps = 30> >> 1806=item B<< C<Pm = 30> >>
1649 1807
1650=begin table 1808=begin table
1651 1809
1652 B<< C<h> >> scrollBar visisble 1810 B<< C<h> >> scrollBar visisble
1653 B<< C<l> >> scrollBar invisisble 1811 B<< C<l> >> scrollBar invisisble
1654 1812
1655=end table 1813=end table
1656 1814
1657=item B<< C<Ps = 35> >> (B<rxvt>) 1815=item B<< C<Pm = 35> >> (B<rxvt>)
1658 1816
1659=begin table 1817=begin table
1660 1818
1661 B<< C<h> >> Allow XTerm Shift+key sequences 1819 B<< C<h> >> Allow XTerm Shift+key sequences
1662 B<< C<l> >> Disallow XTerm Shift+key sequences 1820 B<< C<l> >> Disallow XTerm Shift+key sequences
1663 1821
1664=end table 1822=end table
1665 1823
1666=item B<< C<Ps = 38> >> I<unimplemented> 1824=item B<< C<Pm = 38> >> I<unimplemented>
1667 1825
1668Enter Tektronix Mode (DECTEK) 1826Enter Tektronix Mode (DECTEK)
1669 1827
1670=item B<< C<Ps = 40> >> 1828=item B<< C<Pm = 40> >>
1671 1829
1672=begin table 1830=begin table
1673 1831
1674 B<< C<h> >> Allow 80/132 Mode 1832 B<< C<h> >> Allow 80/132 Mode
1675 B<< C<l> >> Disallow 80/132 Mode 1833 B<< C<l> >> Disallow 80/132 Mode
1676 1834
1677=end table 1835=end table
1678 1836
1679=item B<< C<Ps = 44> >> I<unimplemented> 1837=item B<< C<Pm = 44> >> I<unimplemented>
1680 1838
1681=begin table 1839=begin table
1682 1840
1683 B<< C<h> >> Turn On Margin Bell 1841 B<< C<h> >> Turn On Margin Bell
1684 B<< C<l> >> Turn Off Margin Bell 1842 B<< C<l> >> Turn Off Margin Bell
1685 1843
1686=end table 1844=end table
1687 1845
1688=item B<< C<Ps = 45> >> I<unimplemented> 1846=item B<< C<Pm = 45> >> I<unimplemented>
1689 1847
1690=begin table 1848=begin table
1691 1849
1692 B<< C<h> >> Reverse-wraparound Mode 1850 B<< C<h> >> Reverse-wraparound Mode
1693 B<< C<l> >> No Reverse-wraparound Mode 1851 B<< C<l> >> No Reverse-wraparound Mode
1694 1852
1695=end table 1853=end table
1696 1854
1697=item B<< C<Ps = 46> >> I<unimplemented> 1855=item B<< C<Pm = 46> >> I<unimplemented>
1698 1856
1699=item B<< C<Ps = 47> >> 1857=item B<< C<Pm = 47> >>
1700 1858
1701=begin table 1859=begin table
1702 1860
1703 B<< C<h> >> Use Alternate Screen Buffer 1861 B<< C<h> >> Use Alternate Screen Buffer
1704 B<< C<l> >> Use Normal Screen Buffer 1862 B<< C<l> >> Use Normal Screen Buffer
1705 1863
1706=end table 1864=end table
1707 1865
1708X<Priv66> 1866X<Priv66>
1709 1867
1710=item B<< C<Ps = 66> >> 1868=item B<< C<Pm = 66> >>
1711 1869
1712=begin table 1870=begin table
1713 1871
1714 B<< C<h> >> Application Keypad (DECPAM) == C<ESC => 1872 B<< C<h> >> Application Keypad (DECPAM) == C<ESC =>
1715 B<< C<l> >> Normal Keypad (DECPNM) == C<< ESC > >> 1873 B<< C<l> >> Normal Keypad (DECPNM) == C<< ESC > >>
1716 1874
1717=end table 1875=end table
1718 1876
1719=item B<< C<Ps = 67> >> 1877=item B<< C<Pm = 67> >>
1720 1878
1721=begin table 1879=begin table
1722 1880
1723 B<< C<h> >> Backspace key sends B<< C<BS> (DECBKM) >> 1881 B<< C<h> >> Backspace key sends B<< C<BS> (DECBKM) >>
1724 B<< C<l> >> Backspace key sends B<< C<DEL> >> 1882 B<< C<l> >> Backspace key sends B<< C<DEL> >>
1725 1883
1726=end table 1884=end table
1727 1885
1728=item B<< C<Ps = 1000> >> (X11 XTerm) 1886=item B<< C<Pm = 1000> >> (X11 XTerm)
1729 1887
1730=begin table 1888=begin table
1731 1889
1732 B<< C<h> >> Send Mouse X & Y on button press and release. 1890 B<< C<h> >> Send Mouse X & Y on button press and release.
1733 B<< C<l> >> No mouse reporting. 1891 B<< C<l> >> No mouse reporting.
1734 1892
1735=end table 1893=end table
1736 1894
1737=item B<< C<Ps = 1001> >> (X11 XTerm) I<unimplemented> 1895=item B<< C<Pm = 1001> >> (X11 XTerm) I<unimplemented>
1738 1896
1739=begin table 1897=begin table
1740 1898
1741 B<< C<h> >> Use Hilite Mouse Tracking. 1899 B<< C<h> >> Use Hilite Mouse Tracking.
1742 B<< C<l> >> No mouse reporting. 1900 B<< C<l> >> No mouse reporting.
1743 1901
1744=end table 1902=end table
1745 1903
1746=item B<< C<Ps = 1010> >> (B<rxvt>) 1904=item B<< C<Pm = 1010> >> (B<rxvt>)
1747 1905
1748=begin table 1906=begin table
1749 1907
1750 B<< C<h> >> Don't scroll to bottom on TTY output 1908 B<< C<h> >> Don't scroll to bottom on TTY output
1751 B<< C<l> >> Scroll to bottom on TTY output 1909 B<< C<l> >> Scroll to bottom on TTY output
1752 1910
1753=end table 1911=end table
1754 1912
1755=item B<< C<Ps = 1011> >> (B<rxvt>) 1913=item B<< C<Pm = 1011> >> (B<rxvt>)
1756 1914
1757=begin table 1915=begin table
1758 1916
1759 B<< C<h> >> Scroll to bottom when a key is pressed 1917 B<< C<h> >> Scroll to bottom when a key is pressed
1760 B<< C<l> >> Don't scroll to bottom when a key is pressed 1918 B<< C<l> >> Don't scroll to bottom when a key is pressed
1761 1919
1762=end table 1920=end table
1763 1921
1764=item B<< C<Ps = 1021> >> (B<rxvt>) 1922=item B<< C<Pm = 1021> >> (B<rxvt>)
1765 1923
1766=begin table 1924=begin table
1767 1925
1768 B<< C<h> >> Bold/italic implies high intensity (see option B<-is>) 1926 B<< C<h> >> Bold/italic implies high intensity (see option B<-is>)
1769 B<< C<l> >> Font styles have no effect on intensity (Compile styles) 1927 B<< C<l> >> Font styles have no effect on intensity (Compile styles)
1770 1928
1771=end table 1929=end table
1772 1930
1773=item B<< C<Ps = 1047> >> 1931=item B<< C<Pm = 1047> >>
1774 1932
1775=begin table 1933=begin table
1776 1934
1777 B<< C<h> >> Use Alternate Screen Buffer 1935 B<< C<h> >> Use Alternate Screen Buffer
1778 B<< C<l> >> Use Normal Screen Buffer - clear Alternate Screen Buffer if returning from it 1936 B<< C<l> >> Use Normal Screen Buffer - clear Alternate Screen Buffer if returning from it
1779 1937
1780=end table 1938=end table
1781 1939
1782=item B<< C<Ps = 1048> >> 1940=item B<< C<Pm = 1048> >>
1783 1941
1784=begin table 1942=begin table
1785 1943
1786 B<< C<h> >> Save cursor position 1944 B<< C<h> >> Save cursor position
1787 B<< C<l> >> Restore cursor position 1945 B<< C<l> >> Restore cursor position
1788 1946
1789=end table 1947=end table
1790 1948
1791=item B<< C<Ps = 1049> >> 1949=item B<< C<Pm = 1049> >>
1792 1950
1793=begin table 1951=begin table
1794 1952
1795 B<< C<h> >> Use Alternate Screen Buffer - clear Alternate Screen Buffer if switching to it 1953 B<< C<h> >> Use Alternate Screen Buffer - clear Alternate Screen Buffer if switching to it
1796 B<< C<l> >> Use Normal Screen Buffer 1954 B<< C<l> >> Use Normal Screen Buffer
2043 2201
2044=head1 CONFIGURE OPTIONS 2202=head1 CONFIGURE OPTIONS
2045 2203
2046General hint: if you get compile errors, then likely your configuration 2204General hint: if you get compile errors, then likely your configuration
2047hasn't been tested well. Either try with C<--enable-everything> or use 2205hasn't been tested well. Either try with C<--enable-everything> or use
2048the F<./reconf> script as a base for experiments. F<./reconf> is used by 2206the default configuration (i.e. C<--enable-xxx> or C<--disable-xxx>). Of
2049myself, so it should generally be a working config. Of course, you should 2207course, you should always report when a combination doesn't work, so it
2050always report when a combination doesn't work, so it can be fixed. Marc 2208can be fixed. Marc Lehmann <rxvt@schmorp.de>.
2051Lehmann <rxvt@schmorp.de>.
2052 2209
2053All 2210All
2054 2211
2055=over 4 2212=over 4
2056 2213
2088 2245
2089=begin table 2246=begin table
2090 2247
2091 all all available codeset groups 2248 all all available codeset groups
2092 zh common chinese encodings 2249 zh common chinese encodings
2093 zh_ext rarely used but very big chinese encodigs 2250 zh_ext rarely used but very big chinese encodings
2094 jp common japanese encodings 2251 jp common japanese encodings
2095 jp_ext rarely used but big japanese encodings 2252 jp_ext rarely used but big japanese encodings
2096 kr korean encodings 2253 kr korean encodings
2097 2254
2098=end table 2255=end table
2112requirements per character from 2 to 4 bytes. X11 fonts do not yet 2269requirements per character from 2 to 4 bytes. X11 fonts do not yet
2113support these extra characters, but Xft does. 2270support these extra characters, but Xft does.
2114 2271
2115Please note that rxvt-unicode can store unicode code points >65535 2272Please note that rxvt-unicode can store unicode code points >65535
2116even without this flag, but the number of such characters is 2273even without this flag, but the number of such characters is
2117limited to a view thousand (shared with combining characters, 2274limited to a few thousand (shared with combining characters,
2118see next switch), and right now rxvt-unicode cannot display them 2275see next switch), and right now rxvt-unicode cannot display them
2119(input/output and cut&paste still work, though). 2276(input/output and cut&paste still work, though).
2120 2277
2121=item --enable-combining (default: on) 2278=item --enable-combining (default: on)
2122 2279
2168 2325
2169Write user and tty to lastlog file (used by programs like 2326Write user and tty to lastlog file (used by programs like
2170F<lastlogin>) at start of rxvt execution. This option requires 2327F<lastlogin>) at start of rxvt execution. This option requires
2171--enable-utmp to also be specified. 2328--enable-utmp to also be specified.
2172 2329
2173=item --enable-xpm-background (default: on) 2330=item --enable-afterimage (default: on)
2174 2331
2175Add support for XPM background pixmaps. 2332Add support for libAfterImage to be used for transparency and background
2333images. It adds support for many file formats including JPG, PNG,
2334SVG, TIFF, GIF, XPM, BMP, ICO, XCF, TGA and AfterStep image XML
2335(L<http://www.afterstep.org/visualdoc.php?show=asimagexml>).
2336
2337This option also adds such eye candy as blending an image over the root
2338background, as well as dynamic scaling and bluring of background images.
2339
2340Note that with this option enabled, @@RXVT_NAME@@'s memory footprint might
2341increase by a few megabytes even if no extra features are used (mostly due
2342to third-party libraries used by libAI). Memory footprint may somewhat be
2343lowered if libAfterImage is configured without support for SVG.
2176 2344
2177=item --enable-transparency (default: on) 2345=item --enable-transparency (default: on)
2178 2346
2179Add support for inheriting parent backgrounds thus giving a fake 2347Add support for inheriting parent backgrounds thus giving a fake
2180transparency to the term. 2348transparency to the term.
2181 2349
2182=item --enable-fading (default: on) 2350=item --enable-fading (default: on)
2183 2351
2184Add support for fading the text when focus is lost (requires C<--enable-transparency>). 2352Add support for fading the text when focus is lost.
2185 2353
2186=item --enable-tinting (default: on) 2354=item --enable-tinting (default: on)
2187 2355
2188Add support for tinting of transparent backgrounds (requires C<--enable-transparency>). 2356Add support for tinting of transparent backgrounds (requires C<--enable-transparency>).
2189 2357
2236A non-exhaustive list of features enabled by C<--enable-frills> (possibly 2404A non-exhaustive list of features enabled by C<--enable-frills> (possibly
2237in combination with other switches) is: 2405in combination with other switches) is:
2238 2406
2239 MWM-hints 2407 MWM-hints
2240 EWMH-hints (pid, utf8 names) and protocols (ping) 2408 EWMH-hints (pid, utf8 names) and protocols (ping)
2409 urgency hint
2241 seperate underline colour (-underlineColor) 2410 seperate underline colour (-underlineColor)
2242 settable border widths and borderless switch (-w, -b, -bl) 2411 settable border widths and borderless switch (-w, -b, -bl)
2243 visual depth selection (-depth) 2412 visual depth selection (-depth)
2244 settable extra linespacing /-lsp) 2413 settable extra linespacing /-lsp)
2245 iso-14755-2 and -3, and visual feedback 2414 iso-14755 5.1 (basic) support
2246 tripleclickwords (-tcw) 2415 tripleclickwords (-tcw)
2247 settable insecure mode (-insecure) 2416 settable insecure mode (-insecure)
2248 keysym remapping support 2417 keysym remapping support
2249 cursor blinking and underline cursor (-cb, -uc) 2418 cursor blinking and underline cursor (-cb, -uc)
2250 XEmbed support (-embed) 2419 XEmbed support (-embed)
2251 user-pty (-pty-fd) 2420 user-pty (-pty-fd)
2252 hold on exit (-hold) 2421 hold on exit (-hold)
2253 skip builtin block graphics (-sbg) 2422 skip builtin block graphics (-sbg)
2423 separate highlightcolor support (-hc)
2254 2424
2255It also enabled some non-essential features otherwise disabled, such as: 2425It also enables some non-essential features otherwise disabled, such as:
2256 2426
2257 some round-trip time optimisations 2427 some round-trip time optimisations
2258 nearest color allocation on pseudocolor screens 2428 nearest color allocation on pseudocolor screens
2259 UTF8_STRING supporr for selection 2429 UTF8_STRING support for selection
2260 sgr modes 90..97 and 100..107 2430 sgr modes 90..97 and 100..107
2261 backindex and forwardindex escape sequences 2431 backindex and forwardindex escape sequences
2262 view change/zero scorllback esacpe sequences 2432 view change/zero scrollback escape sequences
2263 locale switching escape sequence 2433 locale switching escape sequence
2264 window op and some xterm/OSC escape sequences 2434 window op and some xterm/OSC escape sequences
2265 rectangular selections 2435 rectangular selections
2266 trailing space removal for selections 2436 trailing space removal for selections
2267 verbose X error handling 2437 verbose X error handling
2276=item --enable-keepscrolling (default: on) 2446=item --enable-keepscrolling (default: on)
2277 2447
2278Add support for continual scrolling of the display when you hold 2448Add support for continual scrolling of the display when you hold
2279the mouse button down on a scrollbar arrow. 2449the mouse button down on a scrollbar arrow.
2280 2450
2451=item --enable-selectionscrolling (default: on)
2452
2453Add support for scrolling when the selection moves to the top or
2454bottom of the screen.
2455
2281=item --enable-mousewheel (default: on) 2456=item --enable-mousewheel (default: on)
2282 2457
2283Add support for scrolling via mouse wheel or buttons 4 & 5. 2458Add support for scrolling via mouse wheel or buttons 4 & 5.
2284 2459
2285=item --enable-slipwheeling (default: on) 2460=item --enable-slipwheeling (default: on)
2286 2461
2287Add support for continual scrolling (using the mouse wheel as an 2462Add support for continual scrolling (using the mouse wheel as an
2288accelerator) while the control key is held down. This option 2463accelerator) while the control key is held down. This option
2289requires --enable-mousewheel to also be specified. 2464requires --enable-mousewheel to also be specified.
2290 2465
2291=item --disable-new-selection
2292
2293Remove support for mouse selection style like that of xterm.
2294
2295=item --enable-dmalloc (default: off)
2296
2297Use Gray Watson's malloc - which is good for debugging See
2298L<http://www.letters.com/dmalloc/> for details If you use either this or the
2299next option, you may need to edit src/Makefile after compiling to point
2300DINCLUDE and DLIB to the right places.
2301
2302You can only use either this option and the following (should
2303you use either) .
2304
2305=item --enable-dlmalloc (default: off)
2306
2307Use Doug Lea's malloc - which is good for a production version
2308See L<http://g.oswego.edu/dl/html/malloc.html> for details.
2309
2310=item --enable-smart-resize (default: on) 2466=item --enable-smart-resize (default: off)
2311 2467
2312Add smart growth/shrink behaviour when changing font size via hot 2468Add smart growth/shrink behaviour when resizing.
2313keys. This should keep the window corner which is closest to a corner of 2469This should keep the window corner which is closest to a corner of
2314the screen in a fixed position. 2470the screen in a fixed position.
2315 2471
2316=item --enable-pointer-blank (default: on) 2472=item --enable-pointer-blank (default: on)
2317 2473
2318Add support to have the pointer disappear when typing or inactive. 2474Add support to have the pointer disappear when typing or inactive.
2319 2475
2320=item --enable-perl (default: on) 2476=item --enable-perl (default: on)
2321 2477
2322Enable an embedded perl interpreter. See the B<@@RXVT_NAME@@perl(3)> 2478Enable an embedded perl interpreter. See the B<@@RXVT_NAME@@perl(3)>
2323manpage (F<doc/rxvtperl.txt>) for more info on this feature, or the files 2479manpage (F<doc/rxvtperl.txt>) for more info on this feature, or the
2324in F<src/perl-ext/> for the extensions that are installed by default. The 2480files in F<src/perl-ext/> for the extensions that are installed by
2325perl interpreter that is used can be specified via the C<PERL> environment 2481default. The perl interpreter that is used can be specified via the
2326variable when running configure. 2482C<PERL> environment variable when running configure. Even when compiled
2483in, perl will I<not> be initialised when all extensions have been disabled
2484C<-pe "" --perl-ext-common "">, so it should be safe to enable from a
2485resource standpoint.
2486
2487=item --with-afterimage-config=DIR
2488
2489Look for the libAfterImage config script in DIR.
2327 2490
2328=item --with-name=NAME (default: urxvt) 2491=item --with-name=NAME (default: urxvt)
2329 2492
2330Set the basename for the installed binaries, resulting 2493Set the basename for the installed binaries, resulting
2331in C<urxvt>, C<urxvtd> etc.). Specify C<--with-name=rxvt> to replace with 2494in C<urxvt>, C<urxvtd> etc.). Specify C<--with-name=rxvt> to replace with
2341PATH. 2504PATH.
2342 2505
2343=item --with-x 2506=item --with-x
2344 2507
2345Use the X Window System (pretty much default, eh?). 2508Use the X Window System (pretty much default, eh?).
2346
2347=item --with-xpm-includes=DIR
2348
2349Look for the XPM includes in DIR.
2350
2351=item --with-xpm-library=DIR
2352
2353Look for the XPM library in DIR.
2354
2355=item --with-xpm
2356
2357Not needed - define via --enable-xpm-background.
2358 2509
2359=back 2510=back
2360 2511
2361=head1 AUTHORS 2512=head1 AUTHORS
2362 2513

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines