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.207 by sf-exg, Tue Nov 22 13:35:10 2011 UTC vs.
Revision 1.215 by sf-exg, Sun May 20 16:34:42 2012 UTC

150=item B<-sh> I<number> 150=item B<-sh> I<number>
151 151
152Darken (0 .. 99) or lighten (101 .. 200) the transparent background. 152Darken (0 .. 99) or lighten (101 .. 200) the transparent background.
153A value of 100 means no shading; resource I<shading>. 153A value of 100 means no shading; resource I<shading>.
154 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> 155=item B<-blr> I<HxV>
166 156
167Apply Gaussian Blur with the specified radii to the transparent 157Apply Gaussian Blur with the specified radii to the transparent
168background. If a single number is specified - both vertical and 158background. If a single number is specified, the vertical and
169horizontal radii are considered to be the same. Setting one of the 159horizontal radii are considered to be the same. Setting one of the
170radii to 1 and another to a large number creates interesting effects 160radii to 1 and the other to a large number creates interesting effects
171on some backgrounds. Maximum radius value is 128; 161on some backgrounds. The maximum radius value is 128. An horizontal or
162vertical radius of 0 disables blurring;
172resource I<blurRadius>. 163resource I<blurRadius>.
173 164
174=item B<-icon> I<file> 165=item B<-icon> I<file>
175 166
176Compile I<afterimage> or I<pixbuf>: Use the specified image as application icon. This 167Compile I<pixbuf>: Use the specified image as application icon. This
177is used by many window managers, taskbars and pagers to represent the 168is used by many window managers, taskbars and pagers to represent the
178application window; resource I<iconFile>. 169application window; resource I<iconFile>.
179 170
180=item B<-bg> I<colour> 171=item B<-bg> I<colour>
181 172
185 176
186Window foreground colour; resource B<foreground>. 177Window foreground colour; resource B<foreground>.
187 178
188=item B<-pixmap> I<file[;oplist]> 179=item B<-pixmap> I<file[;oplist]>
189 180
190Compile I<afterimage> or I<pixbuf>: Specify image file for the background and also 181Compile I<pixbuf>: Specify image file for the background and also
191optionally specify a list of operations to modify it. Note you may need to 182optionally 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 183add quotes to avoid special shell interpretation of the C<;> in the
193command-line; for more details see resource B<backgroundPixmap>. 184command-line; for more details see resource B<backgroundPixmap>.
194 185
195=item B<-cr> I<colour> 186=item B<-cr> I<colour>
716=item B<shading:> I<number> 707=item B<shading:> I<number>
717 708
718Darken (0 .. 99) or lighten (101 .. 200) the transparent background. 709Darken (0 .. 99) or lighten (101 .. 200) the transparent background.
719A value of 100 means no shading; option B<-sh>. 710A value of 100 means no shading; option B<-sh>.
720 711
721=item B<blendType:> I<string>
722
723Specify background blending type; option B<-blt>.
724
725=item B<blurRadius:> I<number> 712=item B<blurRadius:> I<number>
726 713
727Apply gaussian blur with the specified radius to the transparent 714Apply gaussian blur with the specified radius to the transparent
728background; option B<-blr>. 715background; option B<-blr>.
729 716
755 742
756=item B<WxH+X+Y> 743=item B<WxH+X+Y>
757 744
758sets scale and position. B<"W" / "H"> specify the horizontal/vertical 745sets scale and position. B<"W" / "H"> specify the horizontal/vertical
759scale (percent), and B<"X" / "Y"> locate the image centre (percent). A 746scale (percent), and B<"X" / "Y"> locate the image centre (percent). A
760scale of 0 disables scaling. The maximum permitted scale is 1000. 747scale of 0 disables scaling.
761 748
762=item B<op=tile> 749=item B<op=tile>
763 750
764enables tiling 751enables tiling
765 752
766=item B<op=pscale> 753=item B<op=keep-aspect>
767 754
768enables proportional scaling 755maintain the image aspect ratio when scaling
769 756
770=item B<op=root> 757=item B<op=root-align>
771 758
772use the position of the terminal window relative to the root window as 759use the position of the terminal window relative to the root window as
773the image offset, simulating a root window background 760the image offset, simulating a root window background
774 761
775=back 762=back
785the image is tiled with no scaling. Equivalent to 0x0+0+0:op=tile 772the image is tiled with no scaling. Equivalent to 0x0+0+0:op=tile
786 773
787=item B<style=aspect-stretched> 774=item B<style=aspect-stretched>
788 775
789the image is scaled to fill the whole window maintaining the aspect 776the image is scaled to fill the whole window maintaining the aspect
790ratio and centered. Equivalent to 100x100+50+50:op=pscale 777ratio and centered. Equivalent to 100x100+50+50:op=keep-aspect
791 778
792=item B<style=stretched> 779=item B<style=stretched>
793 780
794the image is scaled to fill the whole window. Equivalent to 100x100 781the image is scaled to fill the whole window. Equivalent to 100x100
795 782
798the image is centered with no scaling. Equivalent to 0x0+50+50 785the image is centered with no scaling. Equivalent to 0x0+50+50
799 786
800=item B<style=root-tiled> 787=item B<style=root-tiled>
801 788
802the image is tiled with no scaling and using 'root' positioning. 789the image is tiled with no scaling and using 'root' positioning.
803Equivalent to 0x0:op=tile:op=root 790Equivalent to 0x0:op=tile:op=root-align
804 791
805=back 792=back
806 793
807If multiple templates are specified the last one wins. Note that a 794If multiple templates are specified the last one wins. Note that a
808template overrides all the scale, position and operations settings. 795template overrides all the scale, position and operations settings.
809 796
810If used in conjunction with B<-tr> option, the specified pixmap will be 797If used in conjunction with B<-tr> option, the specified pixmap will be
811blended over the transparent background using alpha-blending. If I<afterimage> 798blended 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 799
815=item B<path:> I<path> 800=item B<path:> I<path>
816 801
817Specify the colon-delimited search path for finding background image files. 802Specify the colon-delimited search path for finding background image files.
818 803
1204performed in an exact manner; however, the closest match is assured. 1189performed in an exact manner; however, the closest match is assured.
1205 1190
1206I<string> may contain escape values (C<\n>: newline, C<\000>: octal 1191I<string> may contain escape values (C<\n>: newline, C<\000>: octal
1207number), see RESOURCES in C<man 7 X> for further details. 1192number), see RESOURCES in C<man 7 X> for further details.
1208 1193
1209You can define a range of keysyms in one shot by providing a I<string> 1194You can define a range of keysyms in one shot by
1195loading the C<keysym-list> perl extension and providing a I<string>
1210with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimiter `/' 1196with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimiter `/'
1211should be a character not used by the strings. 1197should be a character not used by the strings.
1212 1198
1213Its usage can be demonstrated by an example: 1199Its usage can be demonstrated by an example:
1214 1200
1559White. 1545White.
1560 1546
1561=head2 ALPHA CHANNEL SUPPORT 1547=head2 ALPHA CHANNEL SUPPORT
1562 1548
1563If Xft support has been compiled in and as long as Xft/Xrender/X don't get 1549If 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: 1550their act together, rxvt-unicode will do its own alpha channel management:
1565 1551
1566You can prefix any colour with an opaqueness percentage enclosed in 1552You can prefix any colour with an opaqueness percentage enclosed in
1567brackets, i.e. C<[percent]>, where C<percent> is a decimal percentage 1553brackets, 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 1554(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 1555transparent and C<100> is completely opaque. For example, C<[50]red> is a

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines