ViewVC Help
View File | Revision Log | Show Annotations | Download File
/cvs/rxvt-unicode/doc/rxvt.1.pod
(Generate patch)

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents):
Revision 1.204 by sf-exg, Sun Aug 14 22:01:25 2011 UTC vs.
Revision 1.225 by sf-exg, Wed Jun 5 07:58:17 2013 UTC

… …
98is still respected. but deprecated). In the absence of this option, the 98is still respected. but deprecated). In the absence of this option, the
99display specified by the B<DISPLAY> environment variable is used. 99display specified by the B<DISPLAY> environment variable is used.
100 100
101=item B<-depth> I<bitdepth> 101=item B<-depth> I<bitdepth>
102 102
103Compile I<xft>: Attempt to find a visual with the given bit depth; 103Compile I<frills>: Attempt to find a visual with the given bit depth;
104resource B<depth>. 104resource B<depth>.
105 105
106[Please note that many X servers (and libXft) are buggy with 106[Please note that many X servers (and libXft) are buggy with
107respect to C<-depth 32> and/or alpha channels, and will cause all sorts 107respect to C<-depth 32> and/or alpha channels, and will cause all sorts
108of graphical corruption. This is harmless, but we can't do anything about 108of graphical corruption. This is harmless, but we can't do anything about
109this, so watch out] 109this, so watch out]
110 110
111=item B<-visual> I<visualID>
112
113Compile I<frills>: Use the given visual (see e.g. C<xdpyinfo> for possible
114visual ids).
115
111=item B<-geometry> I<geom> 116=item B<-geometry> I<geom>
112 117
113Window geometry (B<-g> still respected); resource B<geometry>. 118Window geometry (B<-g> still respected); resource B<geometry>.
114 119
115=item B<-rv>|B<+rv> 120=item B<-rv>|B<+rv>
… …
121Turn on/off jump scrolling (allow multiple lines per refresh); resource B<jumpScroll>. 126Turn on/off jump scrolling (allow multiple lines per refresh); resource B<jumpScroll>.
122 127
123=item B<-ss>|B<+ss> 128=item B<-ss>|B<+ss>
124 129
125Turn on/off skip scrolling (allow multiple screens per refresh); resource B<skipScroll>. 130Turn on/off skip scrolling (allow multiple screens per refresh); resource B<skipScroll>.
126
127=item B<-tr>|B<+tr>
128
129Turn on/off pseudo-transparency by using the root pixmap as background; resource B<transparent>.
130
131B<-ip> is still accepted as an obsolete alias but will be removed in
132future versions.
133 131
134=item B<-fade> I<number> 132=item B<-fade> I<number>
135 133
136Fade the text by the given percentage when focus is lost. Small values 134Fade the text by the given percentage when focus is lost. Small values
137fade a little only, 100 completely replaces all colours by the fade 135fade a little only, 100 completely replaces all colours by the fade
… …
140=item B<-fadecolor> I<colour> 138=item B<-fadecolor> I<colour>
141 139
142Fade to this colour when fading is used (see B<-fade>). The default colour 140Fade to this colour when fading is used (see B<-fade>). The default colour
143is opaque black. resource B<fadeColor>. 141is opaque black. resource B<fadeColor>.
144 142
145=item B<-tint> I<colour>
146
147Tint the transparent background with the given colour;
148resource I<tintColor>.
149
150=item B<-sh> I<number>
151
152Darken (0 .. 99) or lighten (101 .. 200) the transparent background.
153A value of 100 means no shading; resource I<shading>.
154
155=item B<-blt> I<string>
156
157Specify background blending type. If background pixmap is specified
158at the same time as transparency - such pixmap will be blended over
159the transparent background, using the method specified. Supported values are:
160B<add>, B<alphablend>, B<allanon> - colour values averaging, B<colorize>,
161B<darken>, B<diff>, B<dissipate>, B<hue>, B<lighten>, B<overlay>,
162B<saturate>, B<screen>, B<sub>, B<tint>, B<value>. The default is
163alpha-blending. Compile I<afterimage>; resource I<blendType>.
164
165=item B<-blr> I<HxV>
166
167Apply Gaussian Blur with the specified radii to the transparent
168background. If a single number is specified - both vertical and
169horizontal radii are considered to be the same. Setting one of the
170radii to 1 and another to a large number creates interesting effects
171on some backgrounds. Maximum radius value is 128;
172resource I<blurRadius>.
173
174=item B<-icon> I<file> 143=item B<-icon> I<file>
175 144
176Compile I<afterimage> or I<pixbuf>: Use the specified image as application icon. This 145Compile I<pixbuf>: Use the specified image as application icon. This
177is used by many window managers, taskbars and pagers to represent the 146is used by many window managers, taskbars and pagers to represent the
178application window; resource I<iconFile>. 147application window; resource I<iconFile>.
179 148
180=item B<-bg> I<colour> 149=item B<-bg> I<colour>
181 150
182Window background colour; resource B<background>. 151Window background colour; resource B<background>.
183 152
184=item B<-fg> I<colour> 153=item B<-fg> I<colour>
185 154
186Window foreground colour; resource B<foreground>. 155Window foreground colour; resource B<foreground>.
187
188=item B<-pixmap> I<file[;oplist]>
189
190Compile I<afterimage> or I<pixbuf>: Specify image file for the background and also
191optionally specify a list of operations to modify it. Note you may need to
192add quotes to avoid special shell interpretation of the C<;> in the
193command-line; for more details see resource B<backgroundPixmap>.
194 156
195=item B<-cr> I<colour> 157=item B<-cr> I<colour>
196 158
197The cursor colour; resource B<cursorColor>. 159The cursor colour; resource B<cursorColor>.
198 160
… …
687 649
688B<False>: specify that everything is to be displayed, even 650B<False>: specify that everything is to be displayed, even
689if the refresh is too fast for the human eye to read anything (or the 651if the refresh is too fast for the human eye to read anything (or the
690monitor to display anything); option B<+ss>. 652monitor to display anything); option B<+ss>.
691 653
692=item B<transparent:> I<boolean>
693
694Turn on/off pseudo-transparency by using the root pixmap as background.
695
696B<inheritPixmap> is still accepted as an obsolete alias but will be removed in
697future versions.
698
699=item B<fading:> I<number> 654=item B<fading:> I<number>
700 655
701Fade the text by the given percentage when focus is lost; option B<-fade>. 656Fade the text by the given percentage when focus is lost; option B<-fade>.
702 657
703=item B<fadeColor:> I<colour> 658=item B<fadeColor:> I<colour>
704 659
705Fade to this colour, when fading is used (see B<fading:>). The default 660Fade to this colour, when fading is used (see B<fading:>). The default
706colour is black; option B<-fadecolor>. 661colour is black; option B<-fadecolor>.
707 662
708=item B<tintColor:> I<colour>
709
710Tint the transparent background with the given colour. If the RENDER
711extension is not available only black, red, green, yellow, blue,
712magenta, cyan and white tints can be performed server-side. Note that
713a black tint yields a completely black image while a white tint yields
714the image unchanged; option B<-tint>.
715
716=item B<shading:> I<number>
717
718Darken (0 .. 99) or lighten (101 .. 200) the transparent background.
719A value of 100 means no shading; option B<-sh>.
720
721=item B<blendType:> I<string>
722
723Specify background blending type; option B<-blt>.
724
725=item B<blurRadius:> I<number>
726
727Apply gaussian blur with the specified radius to the transparent
728background; option B<-blr>.
729
730=item B<iconFile:> I<file> 663=item B<iconFile:> I<file>
731 664
732Set the application icon pixmap; option B<-icon>. 665Set the application icon pixmap; option B<-icon>.
733 666
734=item B<scrollColor:> I<colour> 667=item B<scrollColor:> I<colour>
… …
742 675
743=item B<borderColor:> I<colour> 676=item B<borderColor:> I<colour>
744 677
745The colour of the border around the text area and between the scrollbar 678The colour of the border around the text area and between the scrollbar
746and the text. 679and the text.
747
748=item B<backgroundPixmap:> I<file[;oplist]>
749
750Use the specified image file for the background and also
751optionally specify a colon separated list of operations to modify it.
752Supported operations are:
753
754 B<WxH+X+Y> sets scale and position. B<"W" / "H"> specify the
755 horizontal/vertical scale (percent), and B<"X" / "Y">
756 locate the image centre (percent). A scale of 0 disables
757 scaling. The maximum permitted scale is 1000.
758 op=tile enables tiling
759 op=pscale enables proportional scaling
760 op=root use the position of the terminal window relative to the root
761 window as the image offset, simulating a root window background
762
763The default scale and position setting is C<100x100+50+50>.
764Alternatively, a predefined set of templates can be used to achieve
765the most common setups:
766
767 style=tiled the image is tiled with no scaling
768 style=aspect-stretched the image is scaled to fill the whole window maintaining
769 the aspect ratio and centered
770 style=stretched the image is scaled to fill the whole window
771 style=centered the image is centered with no scaling
772 style=root-tiled the image is tiled with no scaling and using 'op=root' positioning
773
774If multiple templates are specified the last one wins. Note that a
775template overrides all the scale, position and operations settings.
776Indeed, the templates can be specified in terms of low level settings
777as follows:
778
779 style=tiled 0x0+0+0:op=tile
780 style=aspect-stretched 100x100+50+50:op=pscale
781 style=stretched 100x100
782 style=centered 0x0+50+50
783 style=root-tiled 0x0:op=tile:op=root
784
785If used in conjunction with B<-tr> option, the specified pixmap will be
786blended over the transparent background using alpha-blending. If I<afterimage>
787support has been compiled in it is possible to choose other blending
788types with B<-blt "type"> option.
789
790=item B<path:> I<path>
791
792Specify the colon-delimited search path for finding background image files.
793 680
794=item B<font:> I<fontlist> 681=item B<font:> I<fontlist>
795 682
796Select the fonts to be used. This is a comma separated list of font names 683Select the fonts to be used. This is a comma separated list of font names
797that are checked in order when trying to find glyphs for characters. The 684that are checked in order when trying to find glyphs for characters. The
… …
1179performed in an exact manner; however, the closest match is assured. 1066performed in an exact manner; however, the closest match is assured.
1180 1067
1181I<string> may contain escape values (C<\n>: newline, C<\000>: octal 1068I<string> may contain escape values (C<\n>: newline, C<\000>: octal
1182number), see RESOURCES in C<man 7 X> for further details. 1069number), see RESOURCES in C<man 7 X> for further details.
1183 1070
1184You can define a range of keysyms in one shot by providing a I<string> 1071You can define a range of keysyms in one shot by
1072loading the C<keysym-list> perl extension and providing a I<string>
1185with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimiter `/' 1073with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimiter `/'
1186should be a character not used by the strings. 1074should be a character not used by the strings.
1187 1075
1188Its usage can be demonstrated by an example: 1076Its usage can be demonstrated by an example:
1189 1077
… …
1274the @@RXVT_NAME@@perl(3) manpage. 1162the @@RXVT_NAME@@perl(3) manpage.
1275 1163
1276=item B<perl-lib>: I<path> 1164=item B<perl-lib>: I<path>
1277 1165
1278Colon-separated list of additional directories that hold extension 1166Colon-separated list of additional directories that hold extension
1279scripts. When looking for extensions specified by the C<perl> resource, 1167scripts. When looking for perl extensions, @@RXVT_NAME@@ will first look
1280@@RXVT_NAME@@ will first look in these directories and then in 1168in these directories, then in C<$URXVT_PERL_LIB>, F<$HOME/.urxvt/ext> and
1281F<@@RXVT_LIBDIR@@/urxvt/perl/>. 1169lastly in F<@@RXVT_LIBDIR@@/urxvt/perl/>.
1282 1170
1283See the @@RXVT_NAME@@perl(3) manpage. 1171See the @@RXVT_NAME@@perl(3) manpage.
1284 1172
1285=item B<< selection.pattern-I<idx> >>: I<perl-regex> 1173=item B<< selection.pattern-I<idx> >>: I<perl-regex>
1286 1174
… …
1295=item B<searchable-scrollback:> I<keysym> 1183=item B<searchable-scrollback:> I<keysym>
1296 1184
1297Sets the hotkey that starts the incremental scrollback buffer search 1185Sets the hotkey that starts the incremental scrollback buffer search
1298(default: C<M-s>). 1186(default: C<M-s>).
1299 1187
1300=item B<urlLauncher>: I<string> 1188=item B<url-launcher>: I<string>
1301 1189
1302Specifies the program to be started with a URL argument. Used by the 1190Specifies the program to be started with a URL argument. Used by the
1303C<selection-popup> and C<matcher> perl extensions. 1191C<selection-popup> and C<matcher> perl extensions.
1304 1192
1305=item B<transient-for>: I<windowid> 1193=item B<transient-for>: I<windowid>
… …
1316Turn on/off ISO 14755 (default enabled). 1204Turn on/off ISO 14755 (default enabled).
1317 1205
1318=item B<iso14755_52:> I<boolean> 1206=item B<iso14755_52:> I<boolean>
1319 1207
1320Turn on/off ISO 14755 5.2 mode (default enabled). 1208Turn on/off ISO 14755 5.2 mode (default enabled).
1209
1210=back
1211
1212=head1 BACKGROUND IMAGE OPTIONS AND RESOURCES
1213
1214=over 4
1215
1216=item B<-pixmap> I<file[;oplist]>
1217
1218=item B<backgroundPixmap:> I<file[;oplist]>
1219
1220Compile I<pixbuf>: Use the specified image file as the window's
1221background and also optionally specify a colon separated list of
1222operations to modify it. Note that you may need to quote the C<;>
1223character when using the command line option, as C<;> is usually a
1224metacharacter in shells. Supported operations are:
1225
1226=over 4
1227
1228=item B<WxH+X+Y>
1229
1230sets scale and position. B<"W" / "H"> specify the horizontal/vertical
1231scale (percent), and B<"X" / "Y"> locate the image centre (percent). A
1232scale of 0 disables scaling.
1233
1234=item B<op=tile>
1235
1236enables tiling
1237
1238=item B<op=keep-aspect>
1239
1240maintain the image aspect ratio when scaling
1241
1242=item B<op=root-align>
1243
1244use the position of the terminal window relative to the root window as
1245the image offset, simulating a root window background
1246
1247=back
1248
1249The default scale and position setting is C<100x100+50+50>.
1250Alternatively, a predefined set of templates can be used to achieve
1251the most common setups:
1252
1253=over 4
1254
1255=item B<style=tiled>
1256
1257the image is tiled with no scaling. Equivalent to 0x0+0+0:op=tile
1258
1259=item B<style=aspect-stretched>
1260
1261the image is scaled to fill the whole window maintaining the aspect
1262ratio and centered. Equivalent to 100x100+50+50:op=keep-aspect
1263
1264=item B<style=stretched>
1265
1266the image is scaled to fill the whole window. Equivalent to 100x100
1267
1268=item B<style=centered>
1269
1270the image is centered with no scaling. Equivalent to 0x0+50+50
1271
1272=item B<style=root-tiled>
1273
1274the image is tiled with no scaling and using 'root' positioning.
1275Equivalent to 0x0:op=tile:op=root-align
1276
1277=back
1278
1279If multiple templates are specified the last one wins. Note that a
1280template overrides all the scale, position and operations settings.
1281
1282If used in conjunction with pseudo-transparency, the specified pixmap
1283will be blended over the transparent background using alpha-blending.
1284
1285=item B<-tr>|B<+tr>
1286
1287=item B<transparent:> I<boolean>
1288
1289Turn on/off pseudo-transparency by using the root pixmap as background.
1290
1291B<-ip> (B<inheritPixmap>) is still accepted as an obsolete alias but
1292will be removed in future versions.
1293
1294=item B<-tint> I<colour>
1295
1296=item B<tintColor:> I<colour>
1297
1298Tint the transparent background with the given colour. Note that a
1299black tint yields a completely black image while a white tint yields
1300the image unchanged.
1301
1302=item B<-sh> I<number>
1303
1304=item B<shading:> I<number>
1305
1306Darken (0 .. 99) or lighten (101 .. 200) the transparent background.
1307A value of 100 means no shading.
1308
1309=item B<-blr> I<HxV>
1310
1311=item B<blurRadius:> I<HxV>
1312
1313Apply gaussian blur with the specified radius to the transparent
1314background. If a single number is specified, the vertical and
1315horizontal radii are considered to be the same. Setting one of the
1316radii to 1 and the other to a large number creates interesting effects
1317on some backgrounds. The maximum radius value is 128. An horizontal or
1318vertical radius of 0 disables blurring.
1319
1320=item B<path:> I<path>
1321
1322Specify the colon-delimited search path for finding background image files.
1321 1323
1322=back 1324=back
1323 1325
1324=head1 THE SCROLLBAR 1326=head1 THE SCROLLBAR
1325 1327
… …
1534White. 1536White.
1535 1537
1536=head2 ALPHA CHANNEL SUPPORT 1538=head2 ALPHA CHANNEL SUPPORT
1537 1539
1538If Xft support has been compiled in and as long as Xft/Xrender/X don't get 1540If Xft support has been compiled in and as long as Xft/Xrender/X don't get
1539their act together, rxvt-unicode will do it's own alpha channel management: 1541their act together, rxvt-unicode will do its own alpha channel management:
1540 1542
1541You can prefix any colour with an opaqueness percentage enclosed in 1543You can prefix any colour with an opaqueness percentage enclosed in
1542brackets, i.e. C<[percent]>, where C<percent> is a decimal percentage 1544brackets, i.e. C<[percent]>, where C<percent> is a decimal percentage
1543(0-100) that specifies the opacity of the colour, where C<0> is completely 1545(0-100) that specifies the opacity of the colour, where C<0> is completely
1544transparent and C<100> is completely opaque. For example, C<[50]red> is a 1546transparent and C<100> is completely opaque. For example, C<[50]red> is a
… …
1626 1628
1627=item B<SHELL> 1629=item B<SHELL>
1628 1630
1629The shell to be used for command execution, defaults to C</bin/sh>. 1631The shell to be used for command execution, defaults to C</bin/sh>.
1630 1632
1631=item B<RXVT_SOCKET> 1633=item B<RXVT_SOCKET> [I<sic>]
1632 1634
1633The unix domain socket path used by @@RXVT_NAME@@c(1) and 1635The unix domain socket path used by @@RXVT_NAME@@c(1) and
1634@@RXVT_NAME@@d(1). 1636@@RXVT_NAME@@d(1).
1635 1637
1636Default F<<< $HOME/.rxvt-unicode-I<< <nodename> >> >>>. 1638Default F<<< $HOME/.urxvt/urxvtd-I<< <nodename> >> >>>.
1639
1640=item B<URXVT_PERL_LIB>
1641
1642Additional F<:>-separated library search path for perl extensions. Will be
1643searched after B<-perl-lib> but before F<~/.urxvt/ext> and the system library
1644directory.
1645
1646=item B<URXVT_PERL_VERBOSITY>
1647
1648See L<@@RXVT_NAME@@perl>(3).
1637 1649
1638=item B<HOME> 1650=item B<HOME>
1639 1651
1640Used to locate the default directory for the unix domain socket for 1652Used to locate the default directory for the unix domain socket for
1641daemon communications and to locate various resource files (such as 1653daemon communications and to locate various resource files (such as
… …
1662 1674
1663=back 1675=back
1664 1676
1665=head1 SEE ALSO 1677=head1 SEE ALSO
1666 1678
1679@@RXVT_NAME@@(7), @@RXVT_NAME@@c(1), @@RXVT_NAME@@d(1), @@RXVT_NAME@@-extensions(1),
1667@@RXVT_NAME@@(7), @@RXVT_NAME@@c(1), @@RXVT_NAME@@d(1), xterm(1), sh(1), resize(1), X(1), pty(4), tty(4), utmp(5) 1680@@RXVT_NAME@@perl(3), xterm(1), sh(1), resize(1), X(1), pty(4), tty(4), utmp(5)
1668 1681
1669=head1 CURRENT PROJECT COORDINATOR 1682=head1 CURRENT PROJECT COORDINATOR
1670 1683
1671=over 4 1684=over 4
1672 1685
1673=item Project Coordinator 1686=item Project Coordinator
1674 1687
1675Marc A. Lehmann L<< <rxvt-unicode@schmorp.de> >> 1688Marc A. Lehmann <rxvt-unicode@schmorp.de>.
1676 1689
1677L<http://software.schmorp.de/pkg/rxvt-unicode.html> 1690L<http://software.schmorp.de/pkg/rxvt-unicode.html>
1678 1691
1679=back 1692=back
1680 1693
… …
1684 1697
1685=item John Bovey 1698=item John Bovey
1686 1699
1687University of Kent, 1992, wrote the original Xvt. 1700University of Kent, 1992, wrote the original Xvt.
1688 1701
1689=item Rob Nation L<< <nation@rocket.sanders.lockheed.com> >> 1702=item Rob Nation <nation@rocket.sanders.lockheed.com>
1690 1703
1691very heavily modified Xvt and came up with Rxvt 1704very heavily modified Xvt and came up with Rxvt
1692 1705
1693=item Angelo Haritsis L<< <ah@doc.ic.ac.uk> >> 1706=item Angelo Haritsis <ah@doc.ic.ac.uk>
1694 1707
1695wrote the Greek Keyboard Input (no longer in code) 1708wrote the Greek Keyboard Input (no longer in code)
1696 1709
1697=item mj olesen L<< <olesen@me.QueensU.CA> >> 1710=item mj olesen <olesen@me.QueensU.CA>
1698 1711
1699Wrote the menu system. 1712Wrote the menu system.
1700 1713
1701Project Coordinator (changes.txt 2.11 to 2.21) 1714Project Coordinator (changes.txt 2.11 to 2.21)
1702 1715
1703=item Oezguer Kesim L<< <kesim@math.fu-berlin.de> >> 1716=item Oezguer Kesim <kesim@math.fu-berlin.de>
1704 1717
1705Project Coordinator (changes.txt 2.21a to 2.4.5) 1718Project Coordinator (changes.txt 2.21a to 2.4.5)
1706 1719
1707=item Geoff Wing L<< <gcw@pobox.com> >> 1720=item Geoff Wing <gcw@pobox.com>
1708 1721
1709Rewrote screen display and text selection routines. 1722Rewrote screen display and text selection routines.
1710 1723
1711Project Coordinator (changes.txt 2.4.6 - rxvt-unicode) 1724Project Coordinator (changes.txt 2.4.6 - rxvt-unicode)
1712 1725
1713=item Marc Alexander Lehmann L<< <rxvt-unicode@schmorp.de> >> 1726=item Marc Alexander Lehmann <rxvt-unicode@schmorp.de>
1714 1727
1715Forked rxvt-unicode, unicode support, rewrote almost all the code, perl 1728Forked rxvt-unicode, unicode support, rewrote almost all the code, perl
1716extension, random hacks, numerous bugfixes and extensions. 1729extension, random hacks, numerous bugfixes and extensions.
1717 1730
1718Project Coordinator (Changes 1.0 -) 1731Project Coordinator (Changes 1.0 -)
1719 1732
1720=item Emanuele Giaquinta L<< <e.giaquinta@glauco.it> >> 1733=item Emanuele Giaquinta <emanuele.giaquinta@gmail.com>
1721 1734
1722pty/utmp code rewrite, image code improvements, many random hacks and bugfixes. 1735pty/utmp code rewrite, image code improvements, many random hacks and bugfixes.
1723 1736
1724=back 1737=back
1725 1738

Diff Legend

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