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.118 by root, Thu Jul 6 18:56:10 2006 UTC vs.
Revision 1.123 by root, Sat Dec 16 03:48:49 2006 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.
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
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 only only correct
694directory and also tells urxvt to use a large number of extensions. I 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 695develop for myself mostly, so I actually use most of the extensions I
696write. 696write.
697 697
698The selection stuff mainly makes the selection perl-error-message aware 698The selection stuff mainly makes the selection perl-error-message aware
699and tells it to convert pelr error mssages into vi-commands to load the 699and tells it to convert perl error messages into vi-commands to load the
700relevant file and go tot he error line number. 700relevant file and go tot he error line number.
701 701
702 URxvt.scrollstyle: plain 702 URxvt.scrollstyle: plain
703 URxvt.secondaryScroll: true 703 URxvt.secondaryScroll: true
704 704
705As the documentation says: plain is the preferred scrollbar for the 705As the documentation says: plain is the preferred scrollbar for the
706author. The C<secondaryScroll> confgiures urxvt to scroll in full-screen 706author. The C<secondaryScroll> configures urxvt to scroll in full-screen
707apps, like screen, so lines scorlled out of screen end up in urxvt's 707apps, like screen, so lines scrolled out of screen end up in urxvt's
708scrollback buffer. 708scrollback buffer.
709 709
710 URxvt.background: #000000 710 URxvt.background: #000000
711 URxvt.foreground: gray90 711 URxvt.foreground: gray90
712 URxvt.color7: gray90 712 URxvt.color7: gray90
763 urxvt.boldFont: -xos4-terminus-bold-r-normal--14-140-72-72-c-80-iso8859-15 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 764 urxvt.italicFont: xft:Bitstream Vera Sans Mono:italic:autohint=true
765 urxvt.boldItalicFont: xft:Bitstream Vera Sans Mono:bold:italic:autohint=true 765 urxvt.boldItalicFont: xft:Bitstream Vera Sans Mono:bold:italic:autohint=true
766 766
767I wrote rxvt-unicode to be able to specify fonts exactly. So don't be 767I wrote rxvt-unicode to be able to specify fonts exactly. So don't be
768overwhelmed. A special note: the C<9x15bold> mentioend above is actually 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 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), 770font (different glyphs for C<;> and many other harmless characters),
771while the second font is actually the C<9x15bold> from XFree4/XOrg. The 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 772bold version has less chars than the medium version, so I use it for rare
773characters, too. Whene ditign sources with vim, I use italic for comments 773characters, too. When editing sources with vim, I use italic for comments
774and other stuff, which looks quite good with Bitstream Vera anti-aliased. 774and other stuff, which looks quite good with Bitstream Vera anti-aliased.
775 775
776Terminus is a quite bad font (many very wrong glyphs), but for most of my 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) 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 778font is already bold, and I want to see a difference between bold and
829Also consider the form resources have to use: 829Also consider the form resources have to use:
830 830
831 URxvt.resource: value 831 URxvt.resource: value
832 832
833If 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
834specifying resources), make sure you understand wether and why it 834specifying resources), make sure you understand whether and why it
835works. If unsure, use the form above. 835works. If unsure, use the form above.
836 836
837=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?
838 838
839The terminal description used by rxvt-unicode is not as widely available 839The 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). 840as that for xterm, or even rxvt (for which the same problem often arises).
841 841
842The 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
843be done like this (with ncurses' infocmp): 843be done like this (with ncurses' infocmp and works as user and admin):
844 844
845 REMOTE=remotesystem.domain 845 REMOTE=remotesystem.domain
846 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"
847 847
848... 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.
849 852
850If 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
851C<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
852problems arising, which includes wrong keymapping, less and different 855problems arising, which includes wrong keymapping, less and different
853colours and some refresh errors in fullscreen applications. It's a nice 856colours and some refresh errors in fullscreen applications. It's a nice
876One reason you might want this is that some distributions or operating 879One reason you might want this is that some distributions or operating
877systems still compile some programs using the long-obsoleted termcap 880systems still compile some programs using the long-obsoleted termcap
878library (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
879for C<rxvt-unicode>. 882for C<rxvt-unicode>.
880 883
881You 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.
882You 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
883like this: 886like this:
884 887
885 infocmp -C rxvt-unicode 888 infocmp -C rxvt-unicode
886 889
908 :vs=\E[?25h: 911 :vs=\E[?25h:
909 912
910=head3 Why does C<ls> no longer have coloured output? 913=head3 Why does C<ls> no longer have coloured output?
911 914
912The 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
913decide wether a terminal has colour, but uses it's own configuration 916decide whether a terminal has colour, but uses its own configuration
914file. 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
915with most other terminals supporting colour). Either add: 918with most other terminals supporting colour). Either add:
916 919
917 TERM rxvt-unicode 920 TERM rxvt-unicode
918 921
919to C</etc/DIR_COLORS> or simply add: 922to C</etc/DIR_COLORS> or simply add:
991The reasons is that there exists a perfectly fine mechanism for selecting 994The reasons is that there exists a perfectly fine mechanism for selecting
992the encoding, doing I/O and (most important) communicating this to all 995the encoding, doing I/O and (most important) communicating this to all
993applications so everybody agrees on character properties such as width 996applications so everybody agrees on character properties such as width
994and code number. This mechanism is the I<locale>. Applications not using 997and code number. This mechanism is the I<locale>. Applications not using
995that info will have problems (for example, C<xterm> gets the width of 998that info will have problems (for example, C<xterm> gets the width of
996characters wrong as it uses it's own, locale-independent table under all 999characters wrong as it uses its own, locale-independent table under all
997locales). 1000locales).
998 1001
999Rxvt-unicode uses the C<LC_CTYPE> locale category to select encoding. All 1002Rxvt-unicode uses the C<LC_CTYPE> locale category to select encoding. All
1000programs doing the same (that is, most) will automatically agree in the 1003programs doing the same (that is, most) will automatically agree in the
1001interpretation of characters. 1004interpretation of characters.
1059=item - Make sure your XIM server is actually running. 1062=item - Make sure your XIM server is actually running.
1060 1063
1061=item - Make sure the C<XMODIFIERS> environment variable is set correctly when I<starting> rxvt-unicode. 1064=item - Make sure the C<XMODIFIERS> environment variable is set correctly when I<starting> rxvt-unicode.
1062 1065
1063When you want to use e.g. B<kinput2>, it must be set to 1066When you want to use e.g. B<kinput2>, it must be set to
1064C<@im=kinput2>. For B<scim>, use C<@im=SCIM>. Youc an see what input 1067C<@im=kinput2>. For B<scim>, use C<@im=SCIM>. You can see what input
1065method servers are running with this command: 1068method servers are running with this command:
1066 1069
1067 xprop -root XIM_SERVERS 1070 xprop -root XIM_SERVERS
1068 1071
1069=item 1072=item
1114 1117
1115=head3 I am maintaining rxvt-unicode for distribution/OS XXX, any recommendation? 1118=head3 I am maintaining rxvt-unicode for distribution/OS XXX, any recommendation?
1116 1119
1117You should build one binary with the default options. F<configure> 1120You should build one binary with the default options. F<configure>
1118now enables most useful options, and the trend goes to making them 1121now enables most useful options, and the trend goes to making them
1119runtime-switchable, too, so there is usually no drawback to enbaling them, 1122runtime-switchable, too, so there is usually no drawback to enabling them,
1120except higher disk and possibly memory usage. The perl interpreter should 1123except higher disk and possibly memory usage. The perl interpreter should
1121be enabled, as important functionality (menus, selection, likely more in 1124be enabled, as important functionality (menus, selection, likely more in
1122the future) depends on it. 1125the future) depends on it.
1123 1126
1124You should not overwrite the C<perl-ext-common> snd C<perl-ext> resources 1127You should not overwrite the C<perl-ext-common> snd C<perl-ext> resources
1159 1162
1160=head3 I am on FreeBSD and rxvt-unicode does not seem to work at all. 1163=head3 I am on FreeBSD and rxvt-unicode does not seem to work at all.
1161 1164
1162Rxvt-unicode requires the symbol C<__STDC_ISO_10646__> to be defined 1165Rxvt-unicode requires the symbol C<__STDC_ISO_10646__> to be defined
1163in your compile environment, or an implementation that implements it, 1166in your compile environment, or an implementation that implements it,
1164wether it defines the symbol or not. C<__STDC_ISO_10646__> requires that 1167whether it defines the symbol or not. C<__STDC_ISO_10646__> requires that
1165B<wchar_t> is represented as unicode. 1168B<wchar_t> is represented as unicode.
1166 1169
1167As you might have guessed, FreeBSD does neither define this symobl nor 1170As you might have guessed, FreeBSD does neither define this symbol nor
1168does it support it. Instead, it uses it's own internal representation of 1171does it support it. Instead, it uses its own internal representation of
1169B<wchar_t>. This is, of course, completely fine with respect to standards. 1172B<wchar_t>. This is, of course, completely fine with respect to standards.
1170 1173
1171However, that means rxvt-unicode only works in C<POSIX>, C<ISO-8859-1> and 1174However, 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>. 1175C<UTF-8> locales under FreeBSD (which all use Unicode as B<wchar_t>.
1173 1176

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines