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.88 by root, Wed Jan 18 17:49:46 2006 UTC vs.
Revision 1.96 by root, Tue Jan 31 00:25:16 2006 UTC

… …
16=head1 DESCRIPTION 16=head1 DESCRIPTION
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 21The newest version of this document is also available on the World Wide Web at
22also available on the World Wide Web at
23L<http://cvs.schmorp.de/browse/*checkout*/rxvt-unicode/doc/rxvt.7.html>. 22L<http://cvs.schmorp.de/browse/*checkout*/rxvt-unicode/doc/rxvt.7.html>.
24 23
25=head1 FREQUENTLY ASKED QUESTIONS 24=head1 FREQUENTLY ASKED QUESTIONS
26 25
27=over 4 26=over 4
… …
63extensions. Some extensions can also be configured, for example, 62extensions. Some extensions can also be configured, for example,
64scrollback search mode is triggered by B<M-s>. You can move it to any 63scrollback search mode is triggered by B<M-s>. You can move it to any
65other combination either by setting the B<searchable-scrollback> resource: 64other combination either by setting the B<searchable-scrollback> resource:
66 65
67 URxvt.searchable-scrollback: CM-s 66 URxvt.searchable-scrollback: CM-s
67
68=item Why doesn't rxvt-unicode read my resources?
69
70Well, why, indeed? It does, in a way very similar to other X
71applications. Most importantly, this means that if you or your OS loads
72resources into the X display (the right way to do it), rxvt-unicode will
73ignore any resource files in your home directory. It will only read
74F<$HOME/.Xdefaults> when no resources are attached to the display.
75
76If you have or use an F<$HOME/.Xresources> file, chances are that
77resources are loaded into your X-server. In this case, you have to
78re-login after every change (or run F<xrdb -merge $HOME/.Xresources>).
79
80Also consider the form resources have to use:
81
82 URxvt.resource: value
83
84If you want to use another form (there are lots of different ways of
85specifying resources), make sure you understand wether and why it
86works. If unsure, use the form above.
87
88=item I can't get transparency working, what am I doing wrong?
89
90First of all, transparency isn't officially supported in rxvt-unicode, so
91you are mostly on your own. Do not bug the author about it (but you may
92bug everybody else). Also, if you can't get it working consider it a rite
93of passage: ... and you failed.
94
95Here are four ways to get transparency. B<Do> read the manpage and option
96descriptions for the programs mentioned and rxvt-unicode. Really, do it!
97
981. Use inheritPixmap:
99
100 Esetroot wallpaper.jpg
101 @@RXVT_NAME@@ -ip -tint red -sh 40
102
103That works. If you think it doesn't, you lack transparency and tinting
104support, or you are unable to read.
105
1062. Use a simple pixmap and emulate pseudo-transparency. This enables you
107to use effects other than tinting and shading: Just shade/tint/whatever
108your picture with gimp:
109
110 convert wallpaper.jpg -blur 20x20 -modulate 30 background.xpm
111 @@RXVT_NAME@@ -pixmap background.xpm -pe automove-background
112
113That works. If you think it doesn't, you lack XPM and Perl support, or you
114are unable to read.
115
1163. Use an ARGB visual:
117
118 @@RXVT_NAME@@ -depth 32 -fg grey90 -bg rgba:0000/0000/4444/cccc
119
120This requires XFT support, and the support of your X-server. If that
121doesn't work for you, blame Xorg and Keith Packard. ARGB visuals aren't
122there yet, no matter what they claim. Rxvt-Unicode contains the neccessary
123bugfixes and workarounds for Xft and Xlib to make it work, but that
124doesn't mean that your WM has the required kludges in place.
125
1264. Use xcompmgr and let it do the job:
127
128 xprop -frame -f _NET_WM_WINDOW_OPACITY 32c \
129 -set _NET_WM_WINDOW_OPACITY 0xc0000000
130
131Then click on a window you want to make transparent. Replace C<0xc0000000>
132by other values to change the degree of opacity. If it doesn't work and
133your server crashes, you got to keep the pieces.
68 134
69=item Isn't rxvt supposed to be small? Don't all those features bloat? 135=item Isn't rxvt supposed to be small? Don't all those features bloat?
70 136
71I often get asked about this, and I think, no, they didn't cause extra 137I often get asked about this, and I think, no, they didn't cause extra
72bloat. If you compare a minimal rxvt and a minimal urxvt, you can see 138bloat. If you compare a minimal rxvt and a minimal urxvt, you can see
… …
142No large bloated libraries (of course, none were linked in statically), 208No large bloated libraries (of course, none were linked in statically),
143except maybe libX11 :) 209except maybe libX11 :)
144 210
145=item Does it support tabs, can I have a tabbed rxvt-unicode? 211=item Does it support tabs, can I have a tabbed rxvt-unicode?
146 212
147rxvt-unicode does not directly support tabs. It will work fine with 213Beginning with version 7.3, there is a perl extension that implements a
148tabbing functionality of many window managers or similar tabbing programs, 214simple tabbed terminal. It is installed by default, so any of these should
149and its embedding-features allow it to be embedded into other programs, 215give you tabs:
150as witnessed by F<doc/rxvt-tabbed> or the upcoming C<Gtk2::URxvt> perl 216
151module, which features a tabbed urxvt (murxvt) terminal as an example 217 @@RXVT_NAME@@ -pe tabbed
152embedding application. 218
219 URxvt.perl-ext-common: default,tabbed
220
221It will also work fine with tabbing functionality of many window managers
222or similar tabbing programs, and its embedding-features allow it to be
223embedded into other programs, as witnessed by F<doc/rxvt-tabbed> or
224the upcoming C<Gtk2::URxvt> perl module, which features a tabbed urxvt
225(murxvt) terminal as an example embedding application.
153 226
154=item How do I know which rxvt-unicode version I'm using? 227=item How do I know which rxvt-unicode version I'm using?
155 228
156The version number is displayed with the usage (-h). Also the escape 229The version number is displayed with the usage (-h). Also the escape
157sequence C<ESC [ 8 n> sets the window title to the version number. When 230sequence C<ESC [ 8 n> sets the window title to the version number. When
… …
159daemon. 232daemon.
160 233
161=item I am using Debian GNU/Linux and have a problem... 234=item I am using Debian GNU/Linux and have a problem...
162 235
163The Debian GNU/Linux package of rxvt-unicode in sarge contains large 236The Debian GNU/Linux package of rxvt-unicode in sarge contains large
164patches that considerably change the behaviour of rxvt-unicode. Before 237patches that considerably change the behaviour of rxvt-unicode (but
165reporting a bug to the original rxvt-unicode author please download and 238unfortunately this notice has been removed). Before reporting a bug to
166install the genuine version (L<http://software.schmorp.de#rxvt-unicode>) 239the original rxvt-unicode author please download and install the genuine
167and try to reproduce the problem. If you cannot, chances are that the 240version (L<http://software.schmorp.de#rxvt-unicode>) and try to reproduce
168problems are specific to Debian GNU/Linux, in which case it should be 241the problem. If you cannot, chances are that the problems are specific to
169reported via the Debian Bug Tracking System (use C<reportbug> to report 242Debian GNU/Linux, in which case it should be reported via the Debian Bug
170the bug). 243Tracking System (use C<reportbug> to report the bug).
171 244
172For other problems that also affect the Debian package, you can and 245For other problems that also affect the Debian package, you can and
173probably should use the Debian BTS, too, because, after all, it's also a 246probably should use the Debian BTS, too, because, after all, it's also a
174bug in the Debian version and it serves as a reminder for other users that 247bug in the Debian version and it serves as a reminder for other users that
175might encounter the same issue. 248might encounter the same issue.
176 249
177=item I am maintaining rxvt-unicode for distribution/OS XXX, any recommendation? 250=item I am maintaining rxvt-unicode for distribution/OS XXX, any
251recommendation?
178 252
179You should build one binary with the default options. F<configure> 253You should build one binary with the default options. F<configure>
180now enables most useful options, and the trend goes to making them 254now enables most useful options, and the trend goes to making them
181runtime-switchable, too, so there is usually no drawback to enbaling them, 255runtime-switchable, too, so there is usually no drawback to enbaling them,
182except higher disk and possibly memory usage. The perl interpreter should 256except higher disk and possibly memory usage. The perl interpreter should
… …
1674 B<< C<Ps = 46> >> Change Log File to B<< C<Pt> >> I<unimplemented> 1748 B<< C<Ps = 46> >> Change Log File to B<< C<Pt> >> I<unimplemented>
1675 B<< C<Ps = 49> >> Change default background colour to B<< C<Pt> >>. 1749 B<< C<Ps = 49> >> Change default background colour to B<< C<Pt> >>.
1676 B<< C<Ps = 50> >> Set fontset to B<< C<Pt> >>, with the following special values of B<< C<Pt> >> (B<rxvt>) B<< C<#+n> >> change up B<< C<n> >> B<< C<#-n> >> change down B<< C<n> >> if B<< C<n> >> is missing of 0, a value of 1 is used I<empty> change to font0 B<< C<n> >> change to font B<< C<n> >> 1750 B<< C<Ps = 50> >> Set fontset to B<< C<Pt> >>, with the following special values of B<< C<Pt> >> (B<rxvt>) B<< C<#+n> >> change up B<< C<n> >> B<< C<#-n> >> change down B<< C<n> >> if B<< C<n> >> is missing of 0, a value of 1 is used I<empty> change to font0 B<< C<n> >> change to font B<< C<n> >>
1677 B<< C<Ps = 55> >> Log all scrollback buffer and all of screen to B<< C<Pt> >> 1751 B<< C<Ps = 55> >> Log all scrollback buffer and all of screen to B<< C<Pt> >>
1678 B<< C<Ps = 701> >> Change current locale to B<< C<Pt> >>, or, if B<< C<Pt> >> is B<< C<?> >>, return the current locale (Compile frills). 1752 B<< C<Ps = 701> >> Change current locale to B<< C<Pt> >>, or, if B<< C<Pt> >> is B<< C<?> >>, return the current locale (Compile frills).
1753 B<< C<Ps = 702> >> Request version if B<< C<Pt> >> is B<< C<?> >>, returning C<rxvt-unicode>, the resource name, the major and minor version numbers, e.g. C<ESC ] 702 ; rxvt-unicode ; urxvt ; 7 ; 4 ST>.
1679 B<< C<Ps = 704> >> Change colour of italic characters to B<< C<Pt> >> 1754 B<< C<Ps = 704> >> Change colour of italic characters to B<< C<Pt> >>
1680 B<< C<Ps = 705> >> Change background pixmap tint colour to B<< C<Pt> >> (Compile transparency). 1755 B<< C<Ps = 705> >> Change background pixmap tint colour to B<< C<Pt> >> (Compile transparency).
1681 B<< C<Ps = 706> >> Change colour of bold characters to B<< C<Pt> >> 1756 B<< C<Ps = 706> >> Change colour of bold characters to B<< C<Pt> >>
1682 B<< C<Ps = 707> >> Change colour of underlined characters to B<< C<Pt> >> 1757 B<< C<Ps = 707> >> Change colour of underlined characters to B<< C<Pt> >>
1683 B<< C<Ps = 710> >> Set normal fontset to B<< C<Pt> >>. Same as C<Ps = 50>. 1758 B<< C<Ps = 710> >> Set normal fontset to B<< C<Pt> >>. Same as C<Ps = 50>.
… …
1946alternative input methods (e.g. kinput2) and will also correctly 2021alternative input methods (e.g. kinput2) and will also correctly
1947set up the input for people using dead keys or compose keys. 2022set up the input for people using dead keys or compose keys.
1948 2023
1949=item --enable-unicode3 (default: off) 2024=item --enable-unicode3 (default: off)
1950 2025
2026Recommended to stay off unless you really need non-BMP characters.
2027
1951Enable direct support for displaying unicode codepoints above 2028Enable direct support for displaying unicode codepoints above
195265535 (the basic multilingual page). This increases storage 202965535 (the basic multilingual page). This increases storage
1953requirements per character from 2 to 4 bytes. X11 fonts do not yet 2030requirements per character from 2 to 4 bytes. X11 fonts do not yet
1954support these extra characters, but Xft does. 2031support these extra characters, but Xft does.
1955 2032
… …
1965composite characters. This is required for proper viewing of text 2042composite characters. This is required for proper viewing of text
1966where accents are encoded as seperate unicode characters. This is 2043where accents are encoded as seperate unicode characters. This is
1967done by using precomposited characters when available or creating 2044done by using precomposited characters when available or creating
1968new pseudo-characters when no precomposed form exists. 2045new pseudo-characters when no precomposed form exists.
1969 2046
1970Without --enable-unicode3, the number of additional precomposed characters 2047Without --enable-unicode3, the number of additional precomposed
1971is rather limited (2048, if this is full, rxvt-unicode will use the 2048characters is somewhat limited (the 6400 private use characters will be
1972private use area, extending the number of combinations to 8448). With
1973--enable-unicode3, no practical limit exists. 2049(ab-)used). With --enable-unicode3, no practical limit exists.
1974 2050
1975This option will also enable storage (but not display) of characters 2051This option will also enable storage (but not display) of characters
1976beyond plane 0 (>65535) when --enable-unicode3 was not specified. 2052beyond plane 0 (>65535) when --enable-unicode3 was not specified.
1977 2053
1978The combining table also contains entries for arabic presentation forms, 2054The combining table also contains entries for arabic presentation forms,
1979but these are not currently used. Bug me if you want these to be used (and 2055but these are not currently used. Bug me if you want these to be used (and
1980tell me how these are to be used...). 2056tell me how these are to be used...).
1981 2057
1982=item --enable-fallback(=CLASS) (default: Rxvt) 2058=item --enable-fallback(=CLASS) (default: Rxvt)
1983 2059
1984When reading resource settings, also read settings for class CLASS. To disable resource fallback use --disable-fallback. 2060When reading resource settings, also read settings for class CLASS. To
2061disable resource fallback use --disable-fallback.
1985 2062
1986=item --with-res-name=NAME (default: urxvt) 2063=item --with-res-name=NAME (default: urxvt)
1987 2064
1988Use the given name as default application name when 2065Use the given name as default application name when
1989reading resources. Specify --with-res-name=rxvt to replace rxvt. 2066reading resources. Specify --with-res-name=rxvt to replace rxvt.
… …
2079 2156
2080 MWM-hints 2157 MWM-hints
2081 EWMH-hints (pid, utf8 names) and protocols (ping) 2158 EWMH-hints (pid, utf8 names) and protocols (ping)
2082 seperate underline colour (-underlineColor) 2159 seperate underline colour (-underlineColor)
2083 settable border widths and borderless switch (-w, -b, -bl) 2160 settable border widths and borderless switch (-w, -b, -bl)
2161 visual depth selection (-depth)
2084 settable extra linespacing /-lsp) 2162 settable extra linespacing /-lsp)
2085 iso-14755-2 and -3, and visual feedback 2163 iso-14755-2 and -3, and visual feedback
2086 backindex and forwardindex escape sequence
2087 window op and some xterm/OSC escape sequences
2088 tripleclickwords (-tcw) 2164 tripleclickwords (-tcw)
2089 settable insecure mode (-insecure) 2165 settable insecure mode (-insecure)
2090 keysym remapping support 2166 keysym remapping support
2091 cursor blinking and underline cursor (-cb, -uc) 2167 cursor blinking and underline cursor (-cb, -uc)
2092 XEmbed support (-embed) 2168 XEmbed support (-embed)
2093 user-pty (-pty-fd) 2169 user-pty (-pty-fd)
2094 hold on exit (-hold) 2170 hold on exit (-hold)
2095 skip builtin block graphics (-sbg) 2171 skip builtin block graphics (-sbg)
2172
2173It also enabled some non-essential features otherwise disabled, such as:
2174
2175 some round-trip time optimisations
2176 nearest color allocation on pseudocolor screens
2177 UTF8_STRING supporr for selection
2096 sgr modes 90..97 and 100..107 2178 sgr modes 90..97 and 100..107
2179 backindex and forwardindex escape sequences
2180 view change/zero scorllback esacpe sequences
2181 locale switching escape sequence
2182 window op and some xterm/OSC escape sequences
2183 rectangular selections
2184 trailing space removal for selections
2185 verbose X error handling
2097 2186
2098=item --enable-iso14755 (default: on) 2187=item --enable-iso14755 (default: on)
2099 2188
2100Enable extended ISO 14755 support (see @@RXVT_NAME@@(1), or 2189Enable extended ISO 14755 support (see @@RXVT_NAME@@(1), or
2101F<doc/rxvt.1.txt>). Basic support (section 5.1) is enabled by 2190F<doc/rxvt.1.txt>). Basic support (section 5.1) is enabled by
… …
2144 2233
2145=item --enable-pointer-blank (default: on) 2234=item --enable-pointer-blank (default: on)
2146 2235
2147Add support to have the pointer disappear when typing or inactive. 2236Add support to have the pointer disappear when typing or inactive.
2148 2237
2149=item --enable-perl (default: off) 2238=item --enable-perl (default: on)
2150 2239
2151Enable an embedded perl interpreter. See the B<@@RXVT_NAME@@perl(3)> 2240Enable an embedded perl interpreter. See the B<@@RXVT_NAME@@perl(3)>
2152manpage (F<doc/rxvtperl.txt>) for more info on this feature, or the files 2241manpage (F<doc/rxvtperl.txt>) for more info on this feature, or the files
2153in F<src/perl-ext/> for the extensions that are installed by default. The 2242in F<src/perl-ext/> for the extensions that are installed by default. The
2154perl interpreter that is used can be specified via the C<PERL> environment 2243perl interpreter that is used can be specified via the C<PERL> environment

Diff Legend

– Removed lines
+ Added lines
< Changed lines
> Changed lines