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.206 by sf-exg, Sun Nov 20 10:58:58 2011 UTC vs.
Revision 1.220 by root, Fri Sep 21 23:31:43 2012 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>
… …
150=item B<-sh> I<number> 155=item B<-sh> I<number>
151 156
152Darken (0 .. 99) or lighten (101 .. 200) the transparent background. 157Darken (0 .. 99) or lighten (101 .. 200) the transparent background.
153A value of 100 means no shading; resource I<shading>. 158A value of 100 means no shading; resource I<shading>.
154 159
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> 160=item B<-blr> I<HxV>
166 161
167Apply Gaussian Blur with the specified radii to the transparent 162Apply Gaussian Blur with the specified radii to the transparent
168background. If a single number is specified - both vertical and 163background. If a single number is specified, the vertical and
169horizontal radii are considered to be the same. Setting one of the 164horizontal radii are considered to be the same. Setting one of the
170radii to 1 and another to a large number creates interesting effects 165radii to 1 and the other to a large number creates interesting effects
171on some backgrounds. Maximum radius value is 128; 166on some backgrounds. The maximum radius value is 128. An horizontal or
167vertical radius of 0 disables blurring;
172resource I<blurRadius>. 168resource I<blurRadius>.
173 169
174=item B<-icon> I<file> 170=item B<-icon> I<file>
175 171
176Compile I<afterimage> or I<pixbuf>: Use the specified image as application icon. This 172Compile I<pixbuf>: Use the specified image as application icon. This
177is used by many window managers, taskbars and pagers to represent the 173is used by many window managers, taskbars and pagers to represent the
178application window; resource I<iconFile>. 174application window; resource I<iconFile>.
179 175
180=item B<-bg> I<colour> 176=item B<-bg> I<colour>
181 177
… …
185 181
186Window foreground colour; resource B<foreground>. 182Window foreground colour; resource B<foreground>.
187 183
188=item B<-pixmap> I<file[;oplist]> 184=item B<-pixmap> I<file[;oplist]>
189 185
190Compile I<afterimage> or I<pixbuf>: Specify image file for the background and also 186Compile I<pixbuf>: Specify image file for the background and also
191optionally specify a list of operations to modify it. Note you may need to 187optionally 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 188add quotes to avoid special shell interpretation of the C<;> in the
193command-line; for more details see resource B<backgroundPixmap>. 189command-line; for more details see resource B<backgroundPixmap>.
194 190
195=item B<-cr> I<colour> 191=item B<-cr> I<colour>
… …
716=item B<shading:> I<number> 712=item B<shading:> I<number>
717 713
718Darken (0 .. 99) or lighten (101 .. 200) the transparent background. 714Darken (0 .. 99) or lighten (101 .. 200) the transparent background.
719A value of 100 means no shading; option B<-sh>. 715A value of 100 means no shading; option B<-sh>.
720 716
721=item B<blendType:> I<string>
722
723Specify background blending type; option B<-blt>.
724
725=item B<blurRadius:> I<number> 717=item B<blurRadius:> I<number>
726 718
727Apply gaussian blur with the specified radius to the transparent 719Apply gaussian blur with the specified radius to the transparent
728background; option B<-blr>. 720background; option B<-blr>.
729 721
… …
755 747
756=item B<WxH+X+Y> 748=item B<WxH+X+Y>
757 749
758sets scale and position. B<"W" / "H"> specify the horizontal/vertical 750sets scale and position. B<"W" / "H"> specify the horizontal/vertical
759scale (percent), and B<"X" / "Y"> locate the image centre (percent). A 751scale (percent), and B<"X" / "Y"> locate the image centre (percent). A
760scale of 0 disables scaling. The maximum permitted scale is 1000. 752scale of 0 disables scaling.
761 753
762=item B<op=tile> 754=item B<op=tile>
763 755
764enables tiling 756enables tiling
765 757
766=item B<op=pscale> 758=item B<op=keep-aspect>
767 759
768enables proportional scaling 760maintain the image aspect ratio when scaling
769 761
770=item B<op=root> 762=item B<op=root-align>
771 763
772use the position of the terminal window relative to the root window as 764use the position of the terminal window relative to the root window as
773the image offset, simulating a root window background 765the image offset, simulating a root window background
774 766
775=back 767=back
… …
785the image is tiled with no scaling. Equivalent to 0x0+0+0:op=tile 777the image is tiled with no scaling. Equivalent to 0x0+0+0:op=tile
786 778
787=item B<style=aspect-stretched> 779=item B<style=aspect-stretched>
788 780
789the image is scaled to fill the whole window maintaining the aspect 781the image is scaled to fill the whole window maintaining the aspect
790ratio and centered. Equivalent to 100x100+50+50:op=pscale 782ratio and centered. Equivalent to 100x100+50+50:op=keep-aspect
791 783
792=item B<style=stretched> 784=item B<style=stretched>
793 785
794the image is scaled to fill the whole window. Equivalent to 100x100 786the image is scaled to fill the whole window. Equivalent to 100x100
795 787
… …
798the image is centered with no scaling. Equivalent to 0x0+50+50 790the image is centered with no scaling. Equivalent to 0x0+50+50
799 791
800=item B<style=root-tiled> 792=item B<style=root-tiled>
801 793
802the image is tiled with no scaling and using 'root' positioning. 794the image is tiled with no scaling and using 'root' positioning.
803Equivalent to 0x0:op=tile:op=root 795Equivalent to 0x0:op=tile:op=root-align
804 796
805=back 797=back
806 798
807If multiple templates are specified the last one wins. Note that a 799If multiple templates are specified the last one wins. Note that a
808template overrides all the scale, position and operations settings. 800template overrides all the scale, position and operations settings.
809 801
810If used in conjunction with B<-tr> option, the specified pixmap will be 802If used in conjunction with B<-tr> option, the specified pixmap will be
811blended over the transparent background using alpha-blending. If I<afterimage> 803blended over the transparent background using alpha-blending.
812support has been compiled in it is possible to choose other blending
813types with B<-blt "type"> option.
814 804
815=item B<path:> I<path> 805=item B<path:> I<path>
816 806
817Specify the colon-delimited search path for finding background image files. 807Specify the colon-delimited search path for finding background image files.
818 808
… …
1204performed in an exact manner; however, the closest match is assured. 1194performed in an exact manner; however, the closest match is assured.
1205 1195
1206I<string> may contain escape values (C<\n>: newline, C<\000>: octal 1196I<string> may contain escape values (C<\n>: newline, C<\000>: octal
1207number), see RESOURCES in C<man 7 X> for further details. 1197number), see RESOURCES in C<man 7 X> for further details.
1208 1198
1209You can define a range of keysyms in one shot by providing a I<string> 1199You can define a range of keysyms in one shot by
1200loading the C<keysym-list> perl extension and providing a I<string>
1210with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimiter `/' 1201with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimiter `/'
1211should be a character not used by the strings. 1202should be a character not used by the strings.
1212 1203
1213Its usage can be demonstrated by an example: 1204Its usage can be demonstrated by an example:
1214 1205
… …
1299the @@RXVT_NAME@@perl(3) manpage. 1290the @@RXVT_NAME@@perl(3) manpage.
1300 1291
1301=item B<perl-lib>: I<path> 1292=item B<perl-lib>: I<path>
1302 1293
1303Colon-separated list of additional directories that hold extension 1294Colon-separated list of additional directories that hold extension
1304scripts. When looking for perl extensions, @@RXVT_NAME@@ will first 1295scripts. When looking for perl extensions, @@RXVT_NAME@@ will first look
1305look in these directories, then in $HOME/.urxvt/ext and lastly in 1296in these directories, then in C<$URXVT_PERL_LIB>, F<$HOME/.urxvt/ext> and
1306F<@@RXVT_LIBDIR@@/urxvt/perl/>. 1297lastly in F<@@RXVT_LIBDIR@@/urxvt/perl/>.
1307 1298
1308See the @@RXVT_NAME@@perl(3) manpage. 1299See the @@RXVT_NAME@@perl(3) manpage.
1309 1300
1310=item B<< selection.pattern-I<idx> >>: I<perl-regex> 1301=item B<< selection.pattern-I<idx> >>: I<perl-regex>
1311 1302
… …
1559White. 1550White.
1560 1551
1561=head2 ALPHA CHANNEL SUPPORT 1552=head2 ALPHA CHANNEL SUPPORT
1562 1553
1563If Xft support has been compiled in and as long as Xft/Xrender/X don't get 1554If Xft support has been compiled in and as long as Xft/Xrender/X don't get
1564their act together, rxvt-unicode will do it's own alpha channel management: 1555their act together, rxvt-unicode will do its own alpha channel management:
1565 1556
1566You can prefix any colour with an opaqueness percentage enclosed in 1557You can prefix any colour with an opaqueness percentage enclosed in
1567brackets, i.e. C<[percent]>, where C<percent> is a decimal percentage 1558brackets, i.e. C<[percent]>, where C<percent> is a decimal percentage
1568(0-100) that specifies the opacity of the colour, where C<0> is completely 1559(0-100) that specifies the opacity of the colour, where C<0> is completely
1569transparent and C<100> is completely opaque. For example, C<[50]red> is a 1560transparent and C<100> is completely opaque. For example, C<[50]red> is a
… …
1651 1642
1652=item B<SHELL> 1643=item B<SHELL>
1653 1644
1654The shell to be used for command execution, defaults to C</bin/sh>. 1645The shell to be used for command execution, defaults to C</bin/sh>.
1655 1646
1656=item B<RXVT_SOCKET> 1647=item B<RXVT_SOCKET> [I<sic>]
1657 1648
1658The unix domain socket path used by @@RXVT_NAME@@c(1) and 1649The unix domain socket path used by @@RXVT_NAME@@c(1) and
1659@@RXVT_NAME@@d(1). 1650@@RXVT_NAME@@d(1).
1660 1651
1661Default F<<< $HOME/.rxvt-unicode-I<< <nodename> >> >>>. 1652Default F<<< $HOME/.urxvt/urxvtd-I<< <nodename> >> >>>.
1653
1654=item B<URXVT_PERL_LIB>
1655
1656Additional F<:>-separated library search path for perl extensions. Will be
1657searched after B<-perl-lib> but before F<~/.urxvt/ext> and the system library
1658directory.
1659
1660=item B<URXVT_PERL_VERBOSITY>
1661
1662See L<@@RXVT_NAME@@perl>(3).
1662 1663
1663=item B<HOME> 1664=item B<HOME>
1664 1665
1665Used to locate the default directory for the unix domain socket for 1666Used to locate the default directory for the unix domain socket for
1666daemon communications and to locate various resource files (such as 1667daemon communications and to locate various resource files (such as
… …
1687 1688
1688=back 1689=back
1689 1690
1690=head1 SEE ALSO 1691=head1 SEE ALSO
1691 1692
1693@@RXVT_NAME@@(7), @@RXVT_NAME@@c(1), @@RXVT_NAME@@d(1), @@RXVT_NAME@@-extensions(1),
1692@@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) 1694@@RXVT_NAME@@perl(3), xterm(1), sh(1), resize(1), X(1), pty(4), tty(4), utmp(5)
1693 1695
1694=head1 CURRENT PROJECT COORDINATOR 1696=head1 CURRENT PROJECT COORDINATOR
1695 1697
1696=over 4 1698=over 4
1697 1699

Diff Legend

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