~kklimonda/ubuntu/lucid/rxvt-unicode/lp-514821

« back to all changes in this revision

Viewing changes to doc/rxvt.7.pod

  • Committer: Bazaar Package Importer
  • Author(s): Decklin Foster
  • Date: 2006-09-01 14:44:58 UTC
  • mfrom: (1.1.8 upstream) (3.1.1 etch)
  • Revision ID: james.westby@ubuntu.com-20060901144458-98hrz8zg01w8a3vy
Tags: 7.9-2
* Edit the comments in the app-defaults file, and disable all settings by
  default. If font autoselection fails, I would prefer to open a new bug
  specifically for that. (Closes: #385481)
* Reorganize and edit README.Debian, pushing as much as possible into FAQ
  format (with resource setting issues first).

Show diffs side-by-side

added added

removed removed

Lines of Context:
92
92
re-run the command. Subsequent invocations of the script will re-use the
93
93
existing 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
 
97
97
The original rxvt and rxvt-unicode always export the variable "COLORTERM",
98
98
so you can check and see if that is set. Note that several programs, JED,
146
146
 
147
147
When you C<--enable-everything> (which I<is> unfair, as this involves xft
148
148
and full locale/XIM support which are quite bloaty inside libX11 and my
149
 
libc), the two diverge, but not unreasnobaly so.
 
149
libc), the two diverge, but not unreasonably so.
150
150
 
151
151
    text    data     bss     drs     rss filename
152
152
  163431    2152      24   20123    2060 rxvt --enable-everything
243
243
 
244
244
This requires XFT support, and the support of your X-server. If that
245
245
doesn't work for you, blame Xorg and Keith Packard. ARGB visuals aren't
246
 
there yet, no matter what they claim. Rxvt-Unicode contains the neccessary
 
246
there yet, no matter what they claim. Rxvt-Unicode contains the necessary
247
247
bugfixes and workarounds for Xft and Xlib to make it work, but that
248
248
doesn't mean that your WM has the required kludges in place.
249
249
 
270
270
ask for the character bounding box, which unfortunately is wrong in these
271
271
cases).
272
272
 
273
 
It's not clear (to me at least), wether this is a bug in Xft, freetype,
 
273
It's not clear (to me at least), whether this is a bug in Xft, freetype,
274
274
or the respective font. If you encounter this problem you might try using
275
275
the C<-lsp> option to give the font more height. If that doesn't work, you
276
276
might be forced to use a different font.
304
304
Yes, using an escape sequence. Try something like this, which has the same
305
305
effect 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
 
309
309
This is useful if you e.g. work primarily with japanese (and prefer a
310
310
japanese font), but you have to switch to chinese temporarily, where
316
316
 
317
317
Many fonts have difficulties with italic characters and hinting. For
318
318
example, the otherwise very nicely hinted font C<xft:Bitstream Vera Sans
319
 
Mono> completely fails in it's italic face. A workaround might be to
 
319
Mono> completely fails in its italic face. A workaround might be to
320
320
enable freetype autohinting, i.e. like this:
321
321
 
322
322
   URxvt.italicFont:        xft:Bitstream Vera Sans Mono:italic:autohint=true
332
332
=head3 Rxvt-unicode doesn't seem to anti-alias its fonts, what is wrong?
333
333
 
334
334
Rxvt-unicode will use whatever you specify as a font. If it needs to
335
 
fall back to it's default font search list it will prefer X11 core
 
335
fall back to its default font search list it will prefer X11 core
336
336
fonts, because they are small and fast, and then use Xft fonts. It has
337
337
antialiasing disabled for most of them, because the author thinks they
338
338
look best that way.
514
514
but when running a program that doesn't parse cursor movements or in some
515
515
cases during rlogin sessions, it fails to detect this properly.
516
516
 
517
 
You can permamently switch this feature off by disabling the C<readline>
 
517
You can permanently switch this feature off by disabling the C<readline>
518
518
extension:
519
519
 
520
520
   URxvt.perl-ext-common: default,-readline
523
523
 
524
524
Some Debian GNUL/Linux users seem to have this problem, although no
525
525
specific details were reported so far. It is possible that this is caused
526
 
by the wrong C<TERM> setting, although the details of wether and how
 
526
by the wrong C<TERM> setting, although the details of whether and how
527
527
this can happen are unknown, as C<TERM=rxvt> should offer a compatible
528
528
keymap. See the answer to the previous question, and please report if that
529
529
helped.
559
559
=head3 What's with the strange Backspace/Delete key behaviour?
560
560
 
561
561
Assuming that the physical Backspace key corresponds to the
562
 
BackSpace keysym (not likely for Linux ... see the following
 
562
Backspace keysym (not likely for Linux ... see the following
563
563
question) there are two standard values that can be used for
564
564
Backspace: C<^H> and C<^?>.
565
565
 
696
696
write.
697
697
 
698
698
The selection stuff mainly makes the selection perl-error-message aware
699
 
and tells it to convert pelr error mssages into vi-commands to load the
 
699
and tells it to convert perl error messages into vi-commands to load the
700
700
relevant file and go tot he error line number.
701
701
 
702
702
   URxvt.scrollstyle:      plain
703
703
   URxvt.secondaryScroll:  true
704
704
 
705
705
As the documentation says: plain is the preferred scrollbar for the
706
 
author. The C<secondaryScroll> confgiures urxvt to scroll in full-screen
707
 
apps, like screen, so lines scorlled out of screen end up in urxvt's
 
706
author. The C<secondaryScroll> configures urxvt to scroll in full-screen
 
707
apps, like screen, so lines scrolled out of screen end up in urxvt's
708
708
scrollback buffer.
709
709
 
710
710
   URxvt.background:       #000000
765
765
   urxvt.boldItalicFont:   xft:Bitstream Vera Sans Mono:bold:italic:autohint=true
766
766
 
767
767
I wrote rxvt-unicode to be able to specify fonts exactly. So don't be
768
 
overwhelmed. A special note: the C<9x15bold> mentioend above is actually
 
768
overwhelmed. A special note: the C<9x15bold> mentioned above is actually
769
769
the version from XFree-3.3, as XFree-4 replaced it by a totally different
770
770
font (different glyphs for C<;> and many other harmless characters),
771
771
while the second font is actually the C<9x15bold> from XFree4/XOrg. The
772
772
bold version has less chars than the medium version, so I use it for rare
773
 
characters, too. Whene ditign sources with vim, I use italic for comments
 
773
characters, too. When editing sources with vim, I use italic for comments
774
774
and other stuff, which looks quite good with Bitstream Vera anti-aliased.
775
775
 
776
776
Terminus is a quite bad font (many very wrong glyphs), but for most of my
831
831
  URxvt.resource: value
832
832
 
833
833
If you want to use another form (there are lots of different ways of
834
 
specifying resources), make sure you understand wether and why it
 
834
specifying resources), make sure you understand whether and why it
835
835
works. If unsure, use the form above.
836
836
 
837
837
=head3 When I log-in to another system it tells me about missing terminfo data?
878
878
library (Fedora Core's bash is one example) and rely on a termcap entry
879
879
for C<rxvt-unicode>.
880
880
 
881
 
You could use rxvt's termcap entry with resonable results in many cases.
 
881
You could use rxvt's termcap entry with reasonable results in many cases.
882
882
You can also create a termcap entry by using terminfo's infocmp program
883
883
like this:
884
884
 
910
910
=head3 Why does C<ls> no longer have coloured output?
911
911
 
912
912
The C<ls> in the GNU coreutils unfortunately doesn't use terminfo to
913
 
decide wether a terminal has colour, but uses it's own configuration
914
 
file. Needless to say, C<rxvt-unicode> is not in it's default file (among
 
913
decide whether a terminal has colour, but uses its own configuration
 
914
file. Needless to say, C<rxvt-unicode> is not in its default file (among
915
915
with most other terminals supporting colour). Either add:
916
916
 
917
917
   TERM rxvt-unicode
962
962
The best thing is to fix your startup environment, as you will likely run
963
963
into other problems. If nothing works you can try this in your .profile.
964
964
 
965
 
  printf '\e]701;%s\007' "$LC_CTYPE"
 
965
  printf '\33]701;%s\007' "$LC_CTYPE"
966
966
 
967
967
If this doesn't work, then maybe you use a C<LC_CTYPE> specification not
968
968
supported on your systems. Some systems have a C<locale> command which
993
993
applications so everybody agrees on character properties such as width
994
994
and code number. This mechanism is the I<locale>. Applications not using
995
995
that info will have problems (for example, C<xterm> gets the width of
996
 
characters wrong as it uses it's own, locale-independent table under all
 
996
characters wrong as it uses its own, locale-independent table under all
997
997
locales).
998
998
 
999
999
Rxvt-unicode uses the C<LC_CTYPE> locale category to select encoding. All
1022
1022
Yes, using an escape sequence. Try something like this, which sets
1023
1023
rxvt-unicode's idea of C<LC_CTYPE>.
1024
1024
 
1025
 
  printf '\e]701;%s\007' ja_JP.SJIS
 
1025
  printf '\33]701;%s\007' ja_JP.SJIS
1026
1026
 
1027
1027
See also the previous answer.
1028
1028
 
1031
1031
(e.g. UTF-8). For example, I use this script to start C<xjdic>, which
1032
1032
first switches to a locale supported by xjdic and back later:
1033
1033
 
1034
 
   printf '\e]701;%s\007' ja_JP.SJIS
 
1034
   printf '\33]701;%s\007' ja_JP.SJIS
1035
1035
   xjdic -js
1036
 
   printf '\e]701;%s\007' de_DE.UTF-8
 
1036
   printf '\33]701;%s\007' de_DE.UTF-8
1037
1037
 
1038
1038
You can also use xterm's C<luit> program, which usually works fine, except
1039
1039
for some locales where character width differs between program- and
1061
1061
=item - Make sure the C<XMODIFIERS> environment variable is set correctly when I<starting> rxvt-unicode.
1062
1062
 
1063
1063
When you want to use e.g. B<kinput2>, it must be set to
1064
 
C<@im=kinput2>. For B<scim>, use C<@im=SCIM>. Youc an see what input
 
1064
C<@im=kinput2>. For B<scim>, use C<@im=SCIM>. You can see what input
1065
1065
method servers are running with this command:
1066
1066
 
1067
1067
   xprop -root XIM_SERVERS
1116
1116
 
1117
1117
You should build one binary with the default options. F<configure>
1118
1118
now enables most useful options, and the trend goes to making them
1119
 
runtime-switchable, too, so there is usually no drawback to enbaling them,
 
1119
runtime-switchable, too, so there is usually no drawback to enabling them,
1120
1120
except higher disk and possibly memory usage. The perl interpreter should
1121
1121
be enabled, as important functionality (menus, selection, likely more in
1122
1122
the future) depends on it.
1161
1161
 
1162
1162
Rxvt-unicode requires the symbol C<__STDC_ISO_10646__> to be defined
1163
1163
in your compile environment, or an implementation that implements it,
1164
 
wether it defines the symbol or not. C<__STDC_ISO_10646__> requires that
 
1164
whether it defines the symbol or not. C<__STDC_ISO_10646__> requires that
1165
1165
B<wchar_t> is represented as unicode.
1166
1166
 
1167
 
As you might have guessed, FreeBSD does neither define this symobl nor
1168
 
does it support it. Instead, it uses it's own internal representation of
 
1167
As you might have guessed, FreeBSD does neither define this symbol nor
 
1168
does it support it. Instead, it uses its own internal representation of
1169
1169
B<wchar_t>. This is, of course, completely fine with respect to standards.
1170
1170
 
1171
1171
However, that means rxvt-unicode only works in C<POSIX>, C<ISO-8859-1> and
1709
1709
 
1710
1710
=over 4
1711
1711
 
1712
 
=item B<< C<Ps = 1> >> (DECCKM)
 
1712
=item B<< C<Pm = 1> >> (DECCKM)
1713
1713
 
1714
1714
=begin table
1715
1715
 
1718
1718
 
1719
1719
=end table
1720
1720
 
1721
 
=item B<< C<Ps = 2> >> (ANSI/VT52 mode)
 
1721
=item B<< C<Pm = 2> >> (ANSI/VT52 mode)
1722
1722
 
1723
1723
=begin table
1724
1724
 
1727
1727
 
1728
1728
=end table
1729
1729
 
1730
 
=item B<< C<Ps = 3> >>
 
1730
=item B<< C<Pm = 3> >>
1731
1731
 
1732
1732
=begin table
1733
1733
 
1736
1736
 
1737
1737
=end table
1738
1738
 
1739
 
=item B<< C<Ps = 4> >>
 
1739
=item B<< C<Pm = 4> >>
1740
1740
 
1741
1741
=begin table
1742
1742
 
1745
1745
 
1746
1746
=end table
1747
1747
 
1748
 
=item B<< C<Ps = 5> >>
 
1748
=item B<< C<Pm = 5> >>
1749
1749
 
1750
1750
=begin table
1751
1751
 
1754
1754
 
1755
1755
=end table
1756
1756
 
1757
 
=item B<< C<Ps = 6> >>
 
1757
=item B<< C<Pm = 6> >>
1758
1758
 
1759
1759
=begin table
1760
1760
 
1763
1763
 
1764
1764
=end table
1765
1765
 
1766
 
=item B<< C<Ps = 7> >>
 
1766
=item B<< C<Pm = 7> >>
1767
1767
 
1768
1768
=begin table
1769
1769
 
1772
1772
 
1773
1773
=end table
1774
1774
 
1775
 
=item B<< C<Ps = 8> >> I<unimplemented>
 
1775
=item B<< C<Pm = 8> >> I<unimplemented>
1776
1776
 
1777
1777
=begin table
1778
1778
 
1781
1781
 
1782
1782
=end table
1783
1783
 
1784
 
=item B<< C<Ps = 9> >> X10 XTerm
 
1784
=item B<< C<Pm = 9> >> X10 XTerm
1785
1785
 
1786
1786
=begin table
1787
1787
 
1790
1790
 
1791
1791
=end table
1792
1792
 
1793
 
=item B<< C<Ps = 25> >>
 
1793
=item B<< C<Pm = 25> >>
1794
1794
 
1795
1795
=begin table
1796
1796
 
1799
1799
 
1800
1800
=end table
1801
1801
 
1802
 
=item B<< C<Ps = 30> >>
 
1802
=item B<< C<Pm = 30> >>
1803
1803
 
1804
1804
=begin table
1805
1805
 
1808
1808
 
1809
1809
=end table
1810
1810
 
1811
 
=item B<< C<Ps = 35> >> (B<rxvt>)
 
1811
=item B<< C<Pm = 35> >> (B<rxvt>)
1812
1812
 
1813
1813
=begin table
1814
1814
 
1817
1817
 
1818
1818
=end table
1819
1819
 
1820
 
=item B<< C<Ps = 38> >> I<unimplemented>
 
1820
=item B<< C<Pm = 38> >> I<unimplemented>
1821
1821
 
1822
1822
Enter Tektronix Mode (DECTEK)
1823
1823
 
1824
 
=item B<< C<Ps = 40> >>
 
1824
=item B<< C<Pm = 40> >>
1825
1825
 
1826
1826
=begin table
1827
1827
 
1830
1830
 
1831
1831
=end table
1832
1832
 
1833
 
=item B<< C<Ps = 44> >> I<unimplemented>
 
1833
=item B<< C<Pm = 44> >> I<unimplemented>
1834
1834
 
1835
1835
=begin table
1836
1836
 
1839
1839
 
1840
1840
=end table
1841
1841
 
1842
 
=item B<< C<Ps = 45> >> I<unimplemented>
 
1842
=item B<< C<Pm = 45> >> I<unimplemented>
1843
1843
 
1844
1844
=begin table
1845
1845
 
1848
1848
 
1849
1849
=end table
1850
1850
 
1851
 
=item B<< C<Ps = 46> >> I<unimplemented>
 
1851
=item B<< C<Pm = 46> >> I<unimplemented>
1852
1852
 
1853
 
=item B<< C<Ps = 47> >>
 
1853
=item B<< C<Pm = 47> >>
1854
1854
 
1855
1855
=begin table
1856
1856
 
1861
1861
 
1862
1862
X<Priv66>
1863
1863
 
1864
 
=item B<< C<Ps = 66> >>
 
1864
=item B<< C<Pm = 66> >>
1865
1865
 
1866
1866
=begin table
1867
1867
 
1870
1870
 
1871
1871
=end table
1872
1872
 
1873
 
=item B<< C<Ps = 67> >>
 
1873
=item B<< C<Pm = 67> >>
1874
1874
 
1875
1875
=begin table
1876
1876
 
1879
1879
 
1880
1880
=end table
1881
1881
 
1882
 
=item B<< C<Ps = 1000> >> (X11 XTerm)
 
1882
=item B<< C<Pm = 1000> >> (X11 XTerm)
1883
1883
 
1884
1884
=begin table
1885
1885
 
1888
1888
 
1889
1889
=end table
1890
1890
 
1891
 
=item B<< C<Ps = 1001> >> (X11 XTerm) I<unimplemented>
 
1891
=item B<< C<Pm = 1001> >> (X11 XTerm) I<unimplemented>
1892
1892
 
1893
1893
=begin table
1894
1894
 
1897
1897
 
1898
1898
=end table
1899
1899
 
1900
 
=item B<< C<Ps = 1010> >> (B<rxvt>)
 
1900
=item B<< C<Pm = 1010> >> (B<rxvt>)
1901
1901
 
1902
1902
=begin table
1903
1903
 
1906
1906
 
1907
1907
=end table
1908
1908
 
1909
 
=item B<< C<Ps = 1011> >> (B<rxvt>)
 
1909
=item B<< C<Pm = 1011> >> (B<rxvt>)
1910
1910
 
1911
1911
=begin table
1912
1912
 
1915
1915
 
1916
1916
=end table
1917
1917
 
1918
 
=item B<< C<Ps = 1021> >> (B<rxvt>)
 
1918
=item B<< C<Pm = 1021> >> (B<rxvt>)
1919
1919
 
1920
1920
=begin table
1921
1921
 
1924
1924
 
1925
1925
=end table
1926
1926
 
1927
 
=item B<< C<Ps = 1047> >>
 
1927
=item B<< C<Pm = 1047> >>
1928
1928
 
1929
1929
=begin table
1930
1930
 
1933
1933
 
1934
1934
=end table
1935
1935
 
1936
 
=item B<< C<Ps = 1048> >>
 
1936
=item B<< C<Pm = 1048> >>
1937
1937
 
1938
1938
=begin table
1939
1939
 
1942
1942
 
1943
1943
=end table
1944
1944
 
1945
 
=item B<< C<Ps = 1049> >>
 
1945
=item B<< C<Pm = 1049> >>
1946
1946
 
1947
1947
=begin table
1948
1948
 
2405
2405
  user-pty (-pty-fd)
2406
2406
  hold on exit (-hold)
2407
2407
  skip builtin block graphics (-sbg)
 
2408
  separate highlightcolor support (-hc)
2408
2409
 
2409
 
It also enabled some non-essential features otherwise disabled, such as:
 
2410
It also enables some non-essential features otherwise disabled, such as:
2410
2411
 
2411
2412
  some round-trip time optimisations
2412
2413
  nearest color allocation on pseudocolor screens