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.212 by sf-exg, Sun Jan 1 14:31:28 2012 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, the vertical and
169horizontal radii are considered to be the same. Setting one of the
170radii to 1 and the other to a large number creates interesting effects
171on some backgrounds. The maximum radius value is 128. An horizontal or
172vertical radius of 0 disables blurring;
173resource I<blurRadius>.
174
175=item B<-icon> I<file> 143=item B<-icon> I<file>
176 144
177Compile I<afterimage> or I<pixbuf>: Use the specified image as application icon. This 145Compile I<pixbuf>: Use the specified image as application icon. This
178is used by many window managers, taskbars and pagers to represent the 146is used by many window managers, taskbars and pagers to represent the
179application window; resource I<iconFile>. 147application window; resource I<iconFile>.
180 148
181=item B<-bg> I<colour> 149=item B<-bg> I<colour>
182 150
183Window background colour; resource B<background>. 151Window background colour; resource B<background>.
184 152
185=item B<-fg> I<colour> 153=item B<-fg> I<colour>
186 154
187Window foreground colour; resource B<foreground>. 155Window foreground colour; resource B<foreground>.
188
189=item B<-pixmap> I<file[;oplist]>
190
191Compile I<afterimage> or I<pixbuf>: Specify image file for the background and also
192optionally specify a list of operations to modify it. Note you may need to
193add quotes to avoid special shell interpretation of the C<;> in the
194command-line; for more details see resource B<backgroundPixmap>.
195 156
196=item B<-cr> I<colour> 157=item B<-cr> I<colour>
197 158
198The cursor colour; resource B<cursorColor>. 159The cursor colour; resource B<cursorColor>.
199 160
… …
688 649
689B<False>: specify that everything is to be displayed, even 650B<False>: specify that everything is to be displayed, even
690if 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
691monitor to display anything); option B<+ss>. 652monitor to display anything); option B<+ss>.
692 653
693=item B<transparent:> I<boolean>
694
695Turn on/off pseudo-transparency by using the root pixmap as background.
696
697B<inheritPixmap> is still accepted as an obsolete alias but will be removed in
698future versions.
699
700=item B<fading:> I<number> 654=item B<fading:> I<number>
701 655
702Fade 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>.
703 657
704=item B<fadeColor:> I<colour> 658=item B<fadeColor:> I<colour>
705 659
706Fade 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
707colour is black; option B<-fadecolor>. 661colour is black; option B<-fadecolor>.
708 662
709=item B<tintColor:> I<colour>
710
711Tint the transparent background with the given colour. If the RENDER
712extension is not available only black, red, green, yellow, blue,
713magenta, cyan and white tints can be performed server-side. Note that
714a black tint yields a completely black image while a white tint yields
715the image unchanged; option B<-tint>.
716
717=item B<shading:> I<number>
718
719Darken (0 .. 99) or lighten (101 .. 200) the transparent background.
720A value of 100 means no shading; option B<-sh>.
721
722=item B<blendType:> I<string>
723
724Specify background blending type; option B<-blt>.
725
726=item B<blurRadius:> I<number>
727
728Apply gaussian blur with the specified radius to the transparent
729background; option B<-blr>.
730
731=item B<iconFile:> I<file> 663=item B<iconFile:> I<file>
732 664
733Set the application icon pixmap; option B<-icon>. 665Set the application icon pixmap; option B<-icon>.
734 666
735=item B<scrollColor:> I<colour> 667=item B<scrollColor:> I<colour>
… …
743 675
744=item B<borderColor:> I<colour> 676=item B<borderColor:> I<colour>
745 677
746The 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
747and the text. 679and the text.
748
749=item B<backgroundPixmap:> I<file[;oplist]>
750
751Use the specified image file for the background and also
752optionally specify a colon separated list of operations to modify it.
753Supported operations are:
754
755=over 4
756
757=item B<WxH+X+Y>
758
759sets scale and position. B<"W" / "H"> specify the horizontal/vertical
760scale (percent), and B<"X" / "Y"> locate the image centre (percent). A
761scale of 0 disables scaling. The maximum permitted scale is 1000.
762
763=item B<op=tile>
764
765enables tiling
766
767=item B<op=keep-aspect>
768
769maintain the image aspect ratio when scaling
770
771=item B<op=root-align>
772
773use the position of the terminal window relative to the root window as
774the image offset, simulating a root window background
775
776=back
777
778The default scale and position setting is C<100x100+50+50>.
779Alternatively, a predefined set of templates can be used to achieve
780the most common setups:
781
782=over 4
783
784=item B<style=tiled>
785
786the image is tiled with no scaling. Equivalent to 0x0+0+0:op=tile
787
788=item B<style=aspect-stretched>
789
790the image is scaled to fill the whole window maintaining the aspect
791ratio and centered. Equivalent to 100x100+50+50:op=keep-aspect
792
793=item B<style=stretched>
794
795the image is scaled to fill the whole window. Equivalent to 100x100
796
797=item B<style=centered>
798
799the image is centered with no scaling. Equivalent to 0x0+50+50
800
801=item B<style=root-tiled>
802
803the image is tiled with no scaling and using 'root' positioning.
804Equivalent to 0x0:op=tile:op=root-align
805
806=back
807
808If multiple templates are specified the last one wins. Note that a
809template overrides all the scale, position and operations settings.
810
811If used in conjunction with B<-tr> option, the specified pixmap will be
812blended over the transparent background using alpha-blending. If I<afterimage>
813support has been compiled in it is possible to choose other blending
814types with B<-blt "type"> option.
815
816=item B<path:> I<path>
817
818Specify the colon-delimited search path for finding background image files.
819 680
820=item B<font:> I<fontlist> 681=item B<font:> I<fontlist>
821 682
822Select 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
823that 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
… …
1301the @@RXVT_NAME@@perl(3) manpage. 1162the @@RXVT_NAME@@perl(3) manpage.
1302 1163
1303=item B<perl-lib>: I<path> 1164=item B<perl-lib>: I<path>
1304 1165
1305Colon-separated list of additional directories that hold extension 1166Colon-separated list of additional directories that hold extension
1306scripts. When looking for perl extensions, @@RXVT_NAME@@ will first 1167scripts. When looking for perl extensions, @@RXVT_NAME@@ will first look
1307look in these directories, then in $HOME/.urxvt/ext and lastly in 1168in these directories, then in C<$URXVT_PERL_LIB>, F<$HOME/.urxvt/ext> and
1308F<@@RXVT_LIBDIR@@/urxvt/perl/>. 1169lastly in F<@@RXVT_LIBDIR@@/urxvt/perl/>.
1309 1170
1310See the @@RXVT_NAME@@perl(3) manpage. 1171See the @@RXVT_NAME@@perl(3) manpage.
1311 1172
1312=item B<< selection.pattern-I<idx> >>: I<perl-regex> 1173=item B<< selection.pattern-I<idx> >>: I<perl-regex>
1313 1174
… …
1322=item B<searchable-scrollback:> I<keysym> 1183=item B<searchable-scrollback:> I<keysym>
1323 1184
1324Sets the hotkey that starts the incremental scrollback buffer search 1185Sets the hotkey that starts the incremental scrollback buffer search
1325(default: C<M-s>). 1186(default: C<M-s>).
1326 1187
1327=item B<urlLauncher>: I<string> 1188=item B<url-launcher>: I<string>
1328 1189
1329Specifies 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
1330C<selection-popup> and C<matcher> perl extensions. 1191C<selection-popup> and C<matcher> perl extensions.
1331 1192
1332=item B<transient-for>: I<windowid> 1193=item B<transient-for>: I<windowid>
… …
1343Turn on/off ISO 14755 (default enabled). 1204Turn on/off ISO 14755 (default enabled).
1344 1205
1345=item B<iso14755_52:> I<boolean> 1206=item B<iso14755_52:> I<boolean>
1346 1207
1347Turn 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.
1348 1323
1349=back 1324=back
1350 1325
1351=head1 THE SCROLLBAR 1326=head1 THE SCROLLBAR
1352 1327
… …
1653 1628
1654=item B<SHELL> 1629=item B<SHELL>
1655 1630
1656The 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>.
1657 1632
1658=item B<RXVT_SOCKET> 1633=item B<RXVT_SOCKET> [I<sic>]
1659 1634
1660The unix domain socket path used by @@RXVT_NAME@@c(1) and 1635The unix domain socket path used by @@RXVT_NAME@@c(1) and
1661@@RXVT_NAME@@d(1). 1636@@RXVT_NAME@@d(1).
1662 1637
1663Default F<<< $HOME/.urxvt/urxvtd-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).
1664 1649
1665=item B<HOME> 1650=item B<HOME>
1666 1651
1667Used to locate the default directory for the unix domain socket for 1652Used to locate the default directory for the unix domain socket for
1668daemon communications and to locate various resource files (such as 1653daemon communications and to locate various resource files (such as
… …
1689 1674
1690=back 1675=back
1691 1676
1692=head1 SEE ALSO 1677=head1 SEE ALSO
1693 1678
1679@@RXVT_NAME@@(7), @@RXVT_NAME@@c(1), @@RXVT_NAME@@d(1), @@RXVT_NAME@@-extensions(1),
1694@@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)
1695 1681
1696=head1 CURRENT PROJECT COORDINATOR 1682=head1 CURRENT PROJECT COORDINATOR
1697 1683
1698=over 4 1684=over 4
1699 1685
1700=item Project Coordinator 1686=item Project Coordinator
1701 1687
1702Marc A. Lehmann L<< <rxvt-unicode@schmorp.de> >> 1688Marc A. Lehmann <rxvt-unicode@schmorp.de>.
1703 1689
1704L<http://software.schmorp.de/pkg/rxvt-unicode.html> 1690L<http://software.schmorp.de/pkg/rxvt-unicode.html>
1705 1691
1706=back 1692=back
1707 1693
… …
1711 1697
1712=item John Bovey 1698=item John Bovey
1713 1699
1714University of Kent, 1992, wrote the original Xvt. 1700University of Kent, 1992, wrote the original Xvt.
1715 1701
1716=item Rob Nation L<< <nation@rocket.sanders.lockheed.com> >> 1702=item Rob Nation <nation@rocket.sanders.lockheed.com>
1717 1703
1718very heavily modified Xvt and came up with Rxvt 1704very heavily modified Xvt and came up with Rxvt
1719 1705
1720=item Angelo Haritsis L<< <ah@doc.ic.ac.uk> >> 1706=item Angelo Haritsis <ah@doc.ic.ac.uk>
1721 1707
1722wrote the Greek Keyboard Input (no longer in code) 1708wrote the Greek Keyboard Input (no longer in code)
1723 1709
1724=item mj olesen L<< <olesen@me.QueensU.CA> >> 1710=item mj olesen <olesen@me.QueensU.CA>
1725 1711
1726Wrote the menu system. 1712Wrote the menu system.
1727 1713
1728Project Coordinator (changes.txt 2.11 to 2.21) 1714Project Coordinator (changes.txt 2.11 to 2.21)
1729 1715
1730=item Oezguer Kesim L<< <kesim@math.fu-berlin.de> >> 1716=item Oezguer Kesim <kesim@math.fu-berlin.de>
1731 1717
1732Project Coordinator (changes.txt 2.21a to 2.4.5) 1718Project Coordinator (changes.txt 2.21a to 2.4.5)
1733 1719
1734=item Geoff Wing L<< <gcw@pobox.com> >> 1720=item Geoff Wing <gcw@pobox.com>
1735 1721
1736Rewrote screen display and text selection routines. 1722Rewrote screen display and text selection routines.
1737 1723
1738Project Coordinator (changes.txt 2.4.6 - rxvt-unicode) 1724Project Coordinator (changes.txt 2.4.6 - rxvt-unicode)
1739 1725
1740=item Marc Alexander Lehmann L<< <rxvt-unicode@schmorp.de> >> 1726=item Marc Alexander Lehmann <rxvt-unicode@schmorp.de>
1741 1727
1742Forked rxvt-unicode, unicode support, rewrote almost all the code, perl 1728Forked rxvt-unicode, unicode support, rewrote almost all the code, perl
1743extension, random hacks, numerous bugfixes and extensions. 1729extension, random hacks, numerous bugfixes and extensions.
1744 1730
1745Project Coordinator (Changes 1.0 -) 1731Project Coordinator (Changes 1.0 -)
1746 1732
1747=item Emanuele Giaquinta L<< <e.giaquinta@glauco.it> >> 1733=item Emanuele Giaquinta <emanuele.giaquinta@gmail.com>
1748 1734
1749pty/utmp code rewrite, image code improvements, many random hacks and bugfixes. 1735pty/utmp code rewrite, image code improvements, many random hacks and bugfixes.
1750 1736
1751=back 1737=back
1752 1738

Diff Legend

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