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.212 by sf-exg, Sun Jan 1 14:31:28 2012 UTC

163alpha-blending. Compile I<afterimage>; resource I<blendType>. 163alpha-blending. Compile I<afterimage>; resource I<blendType>.
164 164
165=item B<-blr> I<HxV> 165=item B<-blr> I<HxV>
166 166
167Apply Gaussian Blur with the specified radii to the transparent 167Apply Gaussian Blur with the specified radii to the transparent
168background. If a single number is specified - both vertical and 168background. If a single number is specified, the vertical and
169horizontal radii are considered to be the same. Setting one of the 169horizontal radii are considered to be the same. Setting one of the
170radii to 1 and another to a large number creates interesting effects 170radii to 1 and the other to a large number creates interesting effects
171on some backgrounds. Maximum radius value is 128; 171on some backgrounds. The maximum radius value is 128. An horizontal or
172vertical radius of 0 disables blurring;
172resource I<blurRadius>. 173resource I<blurRadius>.
173 174
174=item B<-icon> I<file> 175=item B<-icon> I<file>
175 176
176Compile I<afterimage> or I<pixbuf>: Use the specified image as application icon. This 177Compile I<afterimage> or I<pixbuf>: Use the specified image as application icon. This
749 750
750Use the specified image file for the background and also 751Use the specified image file for the background and also
751optionally specify a colon separated list of operations to modify it. 752optionally specify a colon separated list of operations to modify it.
752Supported operations are: 753Supported operations are:
753 754
754 B<WxH+X+Y> sets scale and position. B<"W" / "H"> specify the 755=over 4
755 horizontal/vertical scale (percent), and B<"X" / "Y"> 756
756 locate the image centre (percent). A scale of 0 disables 757=item B<WxH+X+Y>
757 scaling. The maximum permitted scale is 1000. 758
758 op=tile enables tiling 759sets scale and position. B<"W" / "H"> specify the horizontal/vertical
759 op=pscale enables proportional scaling 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
760 op=root use the position of the terminal window relative to the root 773use the position of the terminal window relative to the root window as
761 window as the image offset, simulating a root window background 774the image offset, simulating a root window background
775
776=back
762 777
763The default scale and position setting is C<100x100+50+50>. 778The default scale and position setting is C<100x100+50+50>.
764Alternatively, a predefined set of templates can be used to achieve 779Alternatively, a predefined set of templates can be used to achieve
765the most common setups: 780the most common setups:
766 781
767 style=tiled the image is tiled with no scaling 782=over 4
768 style=aspect-stretched the image is scaled to fill the whole window maintaining 783
769 the aspect ratio and centered 784=item B<style=tiled>
770 style=stretched the image is scaled to fill the whole window 785
771 style=centered the image is centered with no scaling 786the 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 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
773 807
774If multiple templates are specified the last one wins. Note that a 808If multiple templates are specified the last one wins. Note that a
775template overrides all the scale, position and operations settings. 809template 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 810
785If used in conjunction with B<-tr> option, the specified pixmap will be 811If used in conjunction with B<-tr> option, the specified pixmap will be
786blended over the transparent background using alpha-blending. If I<afterimage> 812blended over the transparent background using alpha-blending. If I<afterimage>
787support has been compiled in it is possible to choose other blending 813support has been compiled in it is possible to choose other blending
788types with B<-blt "type"> option. 814types with B<-blt "type"> option.
1179performed in an exact manner; however, the closest match is assured. 1205performed in an exact manner; however, the closest match is assured.
1180 1206
1181I<string> may contain escape values (C<\n>: newline, C<\000>: octal 1207I<string> may contain escape values (C<\n>: newline, C<\000>: octal
1182number), see RESOURCES in C<man 7 X> for further details. 1208number), see RESOURCES in C<man 7 X> for further details.
1183 1209
1184You can define a range of keysyms in one shot by providing a I<string> 1210You can define a range of keysyms in one shot by
1211loading the C<keysym-list> perl extension and providing a I<string>
1185with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimiter `/' 1212with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimiter `/'
1186should be a character not used by the strings. 1213should be a character not used by the strings.
1187 1214
1188Its usage can be demonstrated by an example: 1215Its usage can be demonstrated by an example:
1189 1216
1274the @@RXVT_NAME@@perl(3) manpage. 1301the @@RXVT_NAME@@perl(3) manpage.
1275 1302
1276=item B<perl-lib>: I<path> 1303=item B<perl-lib>: I<path>
1277 1304
1278Colon-separated list of additional directories that hold extension 1305Colon-separated list of additional directories that hold extension
1279scripts. When looking for extensions specified by the C<perl> resource, 1306scripts. When looking for perl extensions, @@RXVT_NAME@@ will first
1280@@RXVT_NAME@@ will first look in these directories and then in 1307look in these directories, then in $HOME/.urxvt/ext and lastly in
1281F<@@RXVT_LIBDIR@@/urxvt/perl/>. 1308F<@@RXVT_LIBDIR@@/urxvt/perl/>.
1282 1309
1283See the @@RXVT_NAME@@perl(3) manpage. 1310See the @@RXVT_NAME@@perl(3) manpage.
1284 1311
1285=item B<< selection.pattern-I<idx> >>: I<perl-regex> 1312=item B<< selection.pattern-I<idx> >>: I<perl-regex>
1534White. 1561White.
1535 1562
1536=head2 ALPHA CHANNEL SUPPORT 1563=head2 ALPHA CHANNEL SUPPORT
1537 1564
1538If Xft support has been compiled in and as long as Xft/Xrender/X don't get 1565If 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: 1566their act together, rxvt-unicode will do its own alpha channel management:
1540 1567
1541You can prefix any colour with an opaqueness percentage enclosed in 1568You can prefix any colour with an opaqueness percentage enclosed in
1542brackets, i.e. C<[percent]>, where C<percent> is a decimal percentage 1569brackets, 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 1570(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 1571transparent and C<100> is completely opaque. For example, C<[50]red> is a
1631=item B<RXVT_SOCKET> 1658=item B<RXVT_SOCKET>
1632 1659
1633The unix domain socket path used by @@RXVT_NAME@@c(1) and 1660The unix domain socket path used by @@RXVT_NAME@@c(1) and
1634@@RXVT_NAME@@d(1). 1661@@RXVT_NAME@@d(1).
1635 1662
1636Default F<<< $HOME/.rxvt-unicode-I<< <nodename> >> >>>. 1663Default F<<< $HOME/.urxvt/urxvtd-I<< <nodename> >> >>>.
1637 1664
1638=item B<HOME> 1665=item B<HOME>
1639 1666
1640Used to locate the default directory for the unix domain socket for 1667Used to locate the default directory for the unix domain socket for
1641daemon communications and to locate various resource files (such as 1668daemon communications and to locate various resource files (such as

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines