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.215 by sf-exg, Sun May 20 16:34:42 2012 UTC vs.
Revision 1.224 by root, Thu May 30 18:54:44 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<-blr> I<HxV>
156
157Apply Gaussian Blur with the specified radii to the transparent
158background. If a single number is specified, the vertical and
159horizontal radii are considered to be the same. Setting one of the
160radii to 1 and the other to a large number creates interesting effects
161on some backgrounds. The maximum radius value is 128. An horizontal or
162vertical radius of 0 disables blurring;
163resource I<blurRadius>.
164
165=item B<-icon> I<file> 143=item B<-icon> I<file>
166 144
167Compile I<pixbuf>: Use the specified image as application icon. This 145Compile I<pixbuf>: Use the specified image as application icon. This
168is used by many window managers, taskbars and pagers to represent the 146is used by many window managers, taskbars and pagers to represent the
169application window; resource I<iconFile>. 147application window; resource I<iconFile>.
… …
173Window background colour; resource B<background>. 151Window background colour; resource B<background>.
174 152
175=item B<-fg> I<colour> 153=item B<-fg> I<colour>
176 154
177Window foreground colour; resource B<foreground>. 155Window foreground colour; resource B<foreground>.
178
179=item B<-pixmap> I<file[;oplist]>
180
181Compile I<pixbuf>: Specify image file for the background and also
182optionally specify a list of operations to modify it. Note you may need to
183add quotes to avoid special shell interpretation of the C<;> in the
184command-line; for more details see resource B<backgroundPixmap>.
185 156
186=item B<-cr> I<colour> 157=item B<-cr> I<colour>
187 158
188The cursor colour; resource B<cursorColor>. 159The cursor colour; resource B<cursorColor>.
189 160
… …
678 649
679B<False>: specify that everything is to be displayed, even 650B<False>: specify that everything is to be displayed, even
680if 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
681monitor to display anything); option B<+ss>. 652monitor to display anything); option B<+ss>.
682 653
683=item B<transparent:> I<boolean>
684
685Turn on/off pseudo-transparency by using the root pixmap as background.
686
687B<inheritPixmap> is still accepted as an obsolete alias but will be removed in
688future versions.
689
690=item B<fading:> I<number> 654=item B<fading:> I<number>
691 655
692Fade 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>.
693 657
694=item B<fadeColor:> I<colour> 658=item B<fadeColor:> I<colour>
695 659
696Fade 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
697colour is black; option B<-fadecolor>. 661colour is black; option B<-fadecolor>.
698 662
699=item B<tintColor:> I<colour>
700
701Tint the transparent background with the given colour. If the RENDER
702extension is not available only black, red, green, yellow, blue,
703magenta, cyan and white tints can be performed server-side. Note that
704a black tint yields a completely black image while a white tint yields
705the image unchanged; option B<-tint>.
706
707=item B<shading:> I<number>
708
709Darken (0 .. 99) or lighten (101 .. 200) the transparent background.
710A value of 100 means no shading; option B<-sh>.
711
712=item B<blurRadius:> I<number>
713
714Apply gaussian blur with the specified radius to the transparent
715background; option B<-blr>.
716
717=item B<iconFile:> I<file> 663=item B<iconFile:> I<file>
718 664
719Set the application icon pixmap; option B<-icon>. 665Set the application icon pixmap; option B<-icon>.
720 666
721=item B<scrollColor:> I<colour> 667=item B<scrollColor:> I<colour>
… …
729 675
730=item B<borderColor:> I<colour> 676=item B<borderColor:> I<colour>
731 677
732The 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
733and the text. 679and the text.
734
735=item B<backgroundPixmap:> I<file[;oplist]>
736
737Use the specified image file for the background and also
738optionally specify a colon separated list of operations to modify it.
739Supported operations are:
740
741=over 4
742
743=item B<WxH+X+Y>
744
745sets scale and position. B<"W" / "H"> specify the horizontal/vertical
746scale (percent), and B<"X" / "Y"> locate the image centre (percent). A
747scale of 0 disables scaling.
748
749=item B<op=tile>
750
751enables tiling
752
753=item B<op=keep-aspect>
754
755maintain the image aspect ratio when scaling
756
757=item B<op=root-align>
758
759use the position of the terminal window relative to the root window as
760the image offset, simulating a root window background
761
762=back
763
764The default scale and position setting is C<100x100+50+50>.
765Alternatively, a predefined set of templates can be used to achieve
766the most common setups:
767
768=over 4
769
770=item B<style=tiled>
771
772the image is tiled with no scaling. Equivalent to 0x0+0+0:op=tile
773
774=item B<style=aspect-stretched>
775
776the image is scaled to fill the whole window maintaining the aspect
777ratio and centered. Equivalent to 100x100+50+50:op=keep-aspect
778
779=item B<style=stretched>
780
781the image is scaled to fill the whole window. Equivalent to 100x100
782
783=item B<style=centered>
784
785the image is centered with no scaling. Equivalent to 0x0+50+50
786
787=item B<style=root-tiled>
788
789the image is tiled with no scaling and using 'root' positioning.
790Equivalent to 0x0:op=tile:op=root-align
791
792=back
793
794If multiple templates are specified the last one wins. Note that a
795template overrides all the scale, position and operations settings.
796
797If used in conjunction with B<-tr> option, the specified pixmap will be
798blended over the transparent background using alpha-blending.
799
800=item B<path:> I<path>
801
802Specify the colon-delimited search path for finding background image files.
803 680
804=item B<font:> I<fontlist> 681=item B<font:> I<fontlist>
805 682
806Select 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
807that 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
… …
1285the @@RXVT_NAME@@perl(3) manpage. 1162the @@RXVT_NAME@@perl(3) manpage.
1286 1163
1287=item B<perl-lib>: I<path> 1164=item B<perl-lib>: I<path>
1288 1165
1289Colon-separated list of additional directories that hold extension 1166Colon-separated list of additional directories that hold extension
1290scripts. When looking for perl extensions, @@RXVT_NAME@@ will first 1167scripts. When looking for perl extensions, @@RXVT_NAME@@ will first look
1291look 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
1292F<@@RXVT_LIBDIR@@/urxvt/perl/>. 1169lastly in F<@@RXVT_LIBDIR@@/urxvt/perl/>.
1293 1170
1294See the @@RXVT_NAME@@perl(3) manpage. 1171See the @@RXVT_NAME@@perl(3) manpage.
1295 1172
1296=item B<< selection.pattern-I<idx> >>: I<perl-regex> 1173=item B<< selection.pattern-I<idx> >>: I<perl-regex>
1297 1174
… …
1306=item B<searchable-scrollback:> I<keysym> 1183=item B<searchable-scrollback:> I<keysym>
1307 1184
1308Sets the hotkey that starts the incremental scrollback buffer search 1185Sets the hotkey that starts the incremental scrollback buffer search
1309(default: C<M-s>). 1186(default: C<M-s>).
1310 1187
1311=item B<urlLauncher>: I<string> 1188=item B<url-launcher>: I<string>
1312 1189
1313Specifies 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
1314C<selection-popup> and C<matcher> perl extensions. 1191C<selection-popup> and C<matcher> perl extensions.
1315 1192
1316=item B<transient-for>: I<windowid> 1193=item B<transient-for>: I<windowid>
… …
1327Turn on/off ISO 14755 (default enabled). 1204Turn on/off ISO 14755 (default enabled).
1328 1205
1329=item B<iso14755_52:> I<boolean> 1206=item B<iso14755_52:> I<boolean>
1330 1207
1331Turn 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.
1332 1323
1333=back 1324=back
1334 1325
1335=head1 THE SCROLLBAR 1326=head1 THE SCROLLBAR
1336 1327
… …
1637 1628
1638=item B<SHELL> 1629=item B<SHELL>
1639 1630
1640The 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>.
1641 1632
1642=item B<RXVT_SOCKET> 1633=item B<RXVT_SOCKET> [I<sic>]
1643 1634
1644The unix domain socket path used by @@RXVT_NAME@@c(1) and 1635The unix domain socket path used by @@RXVT_NAME@@c(1) and
1645@@RXVT_NAME@@d(1). 1636@@RXVT_NAME@@d(1).
1646 1637
1647Default 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).
1648 1649
1649=item B<HOME> 1650=item B<HOME>
1650 1651
1651Used to locate the default directory for the unix domain socket for 1652Used to locate the default directory for the unix domain socket for
1652daemon communications and to locate various resource files (such as 1653daemon communications and to locate various resource files (such as
… …
1673 1674
1674=back 1675=back
1675 1676
1676=head1 SEE ALSO 1677=head1 SEE ALSO
1677 1678
1679@@RXVT_NAME@@(7), @@RXVT_NAME@@c(1), @@RXVT_NAME@@d(1), @@RXVT_NAME@@-extensions(1),
1678@@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)
1679 1681
1680=head1 CURRENT PROJECT COORDINATOR 1682=head1 CURRENT PROJECT COORDINATOR
1681 1683
1682=over 4 1684=over 4
1683 1685
1684=item Project Coordinator 1686=item Project Coordinator
1685 1687
1686Marc A. Lehmann L<< <rxvt-unicode@schmorp.de> >> 1688Marc A. Lehmann <rxvt-unicode@schmorp.de>.
1687 1689
1688L<http://software.schmorp.de/pkg/rxvt-unicode.html> 1690L<http://software.schmorp.de/pkg/rxvt-unicode.html>
1689 1691
1690=back 1692=back
1691 1693
… …
1695 1697
1696=item John Bovey 1698=item John Bovey
1697 1699
1698University of Kent, 1992, wrote the original Xvt. 1700University of Kent, 1992, wrote the original Xvt.
1699 1701
1700=item Rob Nation L<< <nation@rocket.sanders.lockheed.com> >> 1702=item Rob Nation <nation@rocket.sanders.lockheed.com>
1701 1703
1702very heavily modified Xvt and came up with Rxvt 1704very heavily modified Xvt and came up with Rxvt
1703 1705
1704=item Angelo Haritsis L<< <ah@doc.ic.ac.uk> >> 1706=item Angelo Haritsis <ah@doc.ic.ac.uk>
1705 1707
1706wrote the Greek Keyboard Input (no longer in code) 1708wrote the Greek Keyboard Input (no longer in code)
1707 1709
1708=item mj olesen L<< <olesen@me.QueensU.CA> >> 1710=item mj olesen <olesen@me.QueensU.CA>
1709 1711
1710Wrote the menu system. 1712Wrote the menu system.
1711 1713
1712Project Coordinator (changes.txt 2.11 to 2.21) 1714Project Coordinator (changes.txt 2.11 to 2.21)
1713 1715
1714=item Oezguer Kesim L<< <kesim@math.fu-berlin.de> >> 1716=item Oezguer Kesim <kesim@math.fu-berlin.de>
1715 1717
1716Project Coordinator (changes.txt 2.21a to 2.4.5) 1718Project Coordinator (changes.txt 2.21a to 2.4.5)
1717 1719
1718=item Geoff Wing L<< <gcw@pobox.com> >> 1720=item Geoff Wing <gcw@pobox.com>
1719 1721
1720Rewrote screen display and text selection routines. 1722Rewrote screen display and text selection routines.
1721 1723
1722Project Coordinator (changes.txt 2.4.6 - rxvt-unicode) 1724Project Coordinator (changes.txt 2.4.6 - rxvt-unicode)
1723 1725
1724=item Marc Alexander Lehmann L<< <rxvt-unicode@schmorp.de> >> 1726=item Marc Alexander Lehmann <rxvt-unicode@schmorp.de>
1725 1727
1726Forked rxvt-unicode, unicode support, rewrote almost all the code, perl 1728Forked rxvt-unicode, unicode support, rewrote almost all the code, perl
1727extension, random hacks, numerous bugfixes and extensions. 1729extension, random hacks, numerous bugfixes and extensions.
1728 1730
1729Project Coordinator (Changes 1.0 -) 1731Project Coordinator (Changes 1.0 -)
1730 1732
1731=item Emanuele Giaquinta L<< <e.giaquinta@glauco.it> >> 1733=item Emanuele Giaquinta <e.giaquinta@glauco.it>
1732 1734
1733pty/utmp code rewrite, image code improvements, many random hacks and bugfixes. 1735pty/utmp code rewrite, image code improvements, many random hacks and bugfixes.
1734 1736
1735=back 1737=back
1736 1738

Diff Legend

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