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.202 by sf-exg, Thu Aug 11 08:37:17 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
183 179
184=item B<-fg> I<colour> 180=item B<-fg> I<colour>
185 181
186Window foreground colour; resource B<foreground>. 182Window foreground colour; resource B<foreground>.
187 183
188=item B<-pixmap> I<file[;geom[:op1][:op2][...]]> 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 its scaling with a geometry string. 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>
196 192
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
743=item B<borderColor:> I<colour> 735=item B<borderColor:> I<colour>
744 736
745The colour of the border around the text area and between the scrollbar 737The colour of the border around the text area and between the scrollbar
746and the text. 738and the text.
747 739
748=item B<backgroundPixmap:> I<file[;geom[:op1][:op2][...]]> 740=item B<backgroundPixmap:> I<file[;oplist]>
749 741
750Use the specified image file for the background and also 742Use the specified image file for the background and also
751optionally specify its scaling with a geometry string B<WxH+X+Y>, 743optionally specify a colon separated list of operations to modify it.
752(default C<100x100+50+50>) in which B<"W" / "H"> specify the
753horizontal/vertical scale (percent), and B<"X" / "Y"> locate the image
754centre (percent). A scale of 0 disables scaling.
755The maximum permitted scale is 1000.
756Additional operations can be specified after colon B<:op1:op2...>.
757Supported operations are: 744Supported operations are:
758 745
759 op=tile enables tiling 746=over 4
760 op=pscale enables proportional scaling 747
748=item B<WxH+X+Y>
749
750sets scale and position. B<"W" / "H"> specify the horizontal/vertical
751scale (percent), and B<"X" / "Y"> locate the image centre (percent). A
752scale of 0 disables scaling.
753
754=item B<op=tile>
755
756enables tiling
757
758=item B<op=keep-aspect>
759
760maintain the image aspect ratio when scaling
761
762=item B<op=root-align>
763
761 op=root use the position of the terminal window relative to the root 764use the position of the terminal window relative to the root window as
762 window as the image offset, simulating a root window background 765the image offset, simulating a root window background
763 766
767=back
768
769The default scale and position setting is C<100x100+50+50>.
764Alternatively, a predefined set of templates can be used to achieve 770Alternatively, a predefined set of templates can be used to achieve
765the most common setups: 771the most common setups:
766 772
767 style=tiled the image is tiled with no scaling 773=over 4
768 style=aspect-stretched the image is scaled to fill the whole window maintaining 774
769 the aspect ratio and centered 775=item B<style=tiled>
770 style=stretched the image is scaled to fill the whole window 776
771 style=centered the image is centered with no scaling 777the image is tiled with no scaling. Equivalent to 0x0+0+0:op=tile
772 style=root-tiled the image is tiled with no scaling and using 'op=root' positioning 778
779=item B<style=aspect-stretched>
780
781the image is scaled to fill the whole window maintaining the aspect
782ratio and centered. Equivalent to 100x100+50+50:op=keep-aspect
783
784=item B<style=stretched>
785
786the image is scaled to fill the whole window. Equivalent to 100x100
787
788=item B<style=centered>
789
790the image is centered with no scaling. Equivalent to 0x0+50+50
791
792=item B<style=root-tiled>
793
794the image is tiled with no scaling and using 'root' positioning.
795Equivalent to 0x0:op=tile:op=root-align
796
797=back
773 798
774If multiple templates are specified the last one wins. Note that a 799If multiple templates are specified the last one wins. Note that a
775template overrides all the scale, position and operations settings. 800template 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 +50+50:op=pscale
781 style=stretched 100x100
782 style=centered 0x0+50+50
783 style=root-tiled 0x0:op=tile:op=root
784 801
785If 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
786blended over the transparent background using alpha-blending. If I<afterimage> 803blended over the transparent background using alpha-blending.
787support has been compiled in it is possible to choose other blending
788types with B<-blt "type"> option.
789 804
790=item B<path:> I<path> 805=item B<path:> I<path>
791 806
792Specify the colon-delimited search path for finding background image files. 807Specify the colon-delimited search path for finding background image files.
793 808
1179performed in an exact manner; however, the closest match is assured. 1194performed in an exact manner; however, the closest match is assured.
1180 1195
1181I<string> may contain escape values (C<\n>: newline, C<\000>: octal 1196I<string> may contain escape values (C<\n>: newline, C<\000>: octal
1182number), see RESOURCES in C<man 7 X> for further details. 1197number), see RESOURCES in C<man 7 X> for further details.
1183 1198
1184You 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>
1185with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimiter `/' 1201with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimiter `/'
1186should be a character not used by the strings. 1202should be a character not used by the strings.
1187 1203
1188Its usage can be demonstrated by an example: 1204Its usage can be demonstrated by an example:
1189 1205
1274the @@RXVT_NAME@@perl(3) manpage. 1290the @@RXVT_NAME@@perl(3) manpage.
1275 1291
1276=item B<perl-lib>: I<path> 1292=item B<perl-lib>: I<path>
1277 1293
1278Colon-separated list of additional directories that hold extension 1294Colon-separated list of additional directories that hold extension
1279scripts. When looking for extensions specified by the C<perl> resource, 1295scripts. When looking for perl extensions, @@RXVT_NAME@@ will first look
1280@@RXVT_NAME@@ will first look in these directories and then in 1296in these directories, then in C<$URXVT_PERL_LIB>, F<$HOME/.urxvt/ext> and
1281F<@@RXVT_LIBDIR@@/urxvt/perl/>. 1297lastly in F<@@RXVT_LIBDIR@@/urxvt/perl/>.
1282 1298
1283See the @@RXVT_NAME@@perl(3) manpage. 1299See the @@RXVT_NAME@@perl(3) manpage.
1284 1300
1285=item B<< selection.pattern-I<idx> >>: I<perl-regex> 1301=item B<< selection.pattern-I<idx> >>: I<perl-regex>
1286 1302
1534White. 1550White.
1535 1551
1536=head2 ALPHA CHANNEL SUPPORT 1552=head2 ALPHA CHANNEL SUPPORT
1537 1553
1538If 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
1539their act together, rxvt-unicode will do it's own alpha channel management: 1555their act together, rxvt-unicode will do its own alpha channel management:
1540 1556
1541You can prefix any colour with an opaqueness percentage enclosed in 1557You can prefix any colour with an opaqueness percentage enclosed in
1542brackets, i.e. C<[percent]>, where C<percent> is a decimal percentage 1558brackets, 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 1559(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 1560transparent and C<100> is completely opaque. For example, C<[50]red> is a
1626 1642
1627=item B<SHELL> 1643=item B<SHELL>
1628 1644
1629The 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>.
1630 1646
1631=item B<RXVT_SOCKET> 1647=item B<RXVT_SOCKET> [I<sic>]
1632 1648
1633The unix domain socket path used by @@RXVT_NAME@@c(1) and 1649The unix domain socket path used by @@RXVT_NAME@@c(1) and
1634@@RXVT_NAME@@d(1). 1650@@RXVT_NAME@@d(1).
1635 1651
1636Default 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).
1637 1663
1638=item B<HOME> 1664=item B<HOME>
1639 1665
1640Used to locate the default directory for the unix domain socket for 1666Used to locate the default directory for the unix domain socket for
1641daemon communications and to locate various resource files (such as 1667daemon communications and to locate various resource files (such as
1662 1688
1663=back 1689=back
1664 1690
1665=head1 SEE ALSO 1691=head1 SEE ALSO
1666 1692
1693@@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) 1694@@RXVT_NAME@@perl(3), xterm(1), sh(1), resize(1), X(1), pty(4), tty(4), utmp(5)
1668 1695
1669=head1 CURRENT PROJECT COORDINATOR 1696=head1 CURRENT PROJECT COORDINATOR
1670 1697
1671=over 4 1698=over 4
1672 1699

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines