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.213 by sf-exg, Sat Feb 4 21:47:06 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>
… …
749 740
750Use the specified image file for the background and also 741Use the specified image file for the background and also
751optionally specify a colon separated list of operations to modify it. 742optionally specify a colon separated list of operations to modify it.
752Supported operations are: 743Supported operations are:
753 744
754 B<WxH+X+Y> sets scale and position. B<"W" / "H"> specify the 745=over 4
755 horizontal/vertical scale (percent), and B<"X" / "Y"> 746
756 locate the image centre (percent). A scale of 0 disables 747=item B<WxH+X+Y>
757 scaling. The maximum permitted scale is 1000. 748
758 op=tile enables tiling 749sets scale and position. B<"W" / "H"> specify the horizontal/vertical
759 op=pscale enables proportional scaling 750scale (percent), and B<"X" / "Y"> locate the image centre (percent). A
751scale of 0 disables scaling. The maximum permitted scale is 1000.
752
753=item B<op=tile>
754
755enables tiling
756
757=item B<op=keep-aspect>
758
759maintain the image aspect ratio when scaling
760
761=item B<op=root-align>
762
760 op=root use the position of the terminal window relative to the root 763use the position of the terminal window relative to the root window as
761 window as the image offset, simulating a root window background 764the image offset, simulating a root window background
765
766=back
762 767
763The default scale and position setting is C<100x100+50+50>. 768The default scale and position setting is C<100x100+50+50>.
764Alternatively, a predefined set of templates can be used to achieve 769Alternatively, a predefined set of templates can be used to achieve
765the most common setups: 770the most common setups:
766 771
767 style=tiled the image is tiled with no scaling 772=over 4
768 style=aspect-stretched the image is scaled to fill the whole window maintaining 773
769 the aspect ratio and centered 774=item B<style=tiled>
770 style=stretched the image is scaled to fill the whole window 775
771 style=centered the image is centered with no scaling 776the 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 777
778=item B<style=aspect-stretched>
779
780the image is scaled to fill the whole window maintaining the aspect
781ratio and centered. Equivalent to 100x100+50+50:op=keep-aspect
782
783=item B<style=stretched>
784
785the image is scaled to fill the whole window. Equivalent to 100x100
786
787=item B<style=centered>
788
789the image is centered with no scaling. Equivalent to 0x0+50+50
790
791=item B<style=root-tiled>
792
793the image is tiled with no scaling and using 'root' positioning.
794Equivalent to 0x0:op=tile:op=root-align
795
796=back
773 797
774If multiple templates are specified the last one wins. Note that a 798If multiple templates are specified the last one wins. Note that a
775template overrides all the scale, position and operations settings. 799template 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 800
785If used in conjunction with B<-tr> option, the specified pixmap will be 801If used in conjunction with B<-tr> option, the specified pixmap will be
786blended over the transparent background using alpha-blending. If I<afterimage> 802blended 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 803
790=item B<path:> I<path> 804=item B<path:> I<path>
791 805
792Specify the colon-delimited search path for finding background image files. 806Specify the colon-delimited search path for finding background image files.
793 807
… …
1179performed in an exact manner; however, the closest match is assured. 1193performed in an exact manner; however, the closest match is assured.
1180 1194
1181I<string> may contain escape values (C<\n>: newline, C<\000>: octal 1195I<string> may contain escape values (C<\n>: newline, C<\000>: octal
1182number), see RESOURCES in C<man 7 X> for further details. 1196number), see RESOURCES in C<man 7 X> for further details.
1183 1197
1184You can define a range of keysyms in one shot by providing a I<string> 1198You can define a range of keysyms in one shot by
1199loading the C<keysym-list> perl extension and providing a I<string>
1185with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimiter `/' 1200with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimiter `/'
1186should be a character not used by the strings. 1201should be a character not used by the strings.
1187 1202
1188Its usage can be demonstrated by an example: 1203Its usage can be demonstrated by an example:
1189 1204
… …
1274the @@RXVT_NAME@@perl(3) manpage. 1289the @@RXVT_NAME@@perl(3) manpage.
1275 1290
1276=item B<perl-lib>: I<path> 1291=item B<perl-lib>: I<path>
1277 1292
1278Colon-separated list of additional directories that hold extension 1293Colon-separated list of additional directories that hold extension
1279scripts. When looking for extensions specified by the C<perl> resource, 1294scripts. When looking for perl extensions, @@RXVT_NAME@@ will first
1280@@RXVT_NAME@@ will first look in these directories and then in 1295look in these directories, then in $HOME/.urxvt/ext and lastly in
1281F<@@RXVT_LIBDIR@@/urxvt/perl/>. 1296F<@@RXVT_LIBDIR@@/urxvt/perl/>.
1282 1297
1283See the @@RXVT_NAME@@perl(3) manpage. 1298See the @@RXVT_NAME@@perl(3) manpage.
1284 1299
1285=item B<< selection.pattern-I<idx> >>: I<perl-regex> 1300=item B<< selection.pattern-I<idx> >>: I<perl-regex>
… …
1534White. 1549White.
1535 1550
1536=head2 ALPHA CHANNEL SUPPORT 1551=head2 ALPHA CHANNEL SUPPORT
1537 1552
1538If Xft support has been compiled in and as long as Xft/Xrender/X don't get 1553If 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: 1554their act together, rxvt-unicode will do its own alpha channel management:
1540 1555
1541You can prefix any colour with an opaqueness percentage enclosed in 1556You can prefix any colour with an opaqueness percentage enclosed in
1542brackets, i.e. C<[percent]>, where C<percent> is a decimal percentage 1557brackets, 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 1558(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 1559transparent and C<100> is completely opaque. For example, C<[50]red> is a
… …
1631=item B<RXVT_SOCKET> 1646=item B<RXVT_SOCKET>
1632 1647
1633The unix domain socket path used by @@RXVT_NAME@@c(1) and 1648The unix domain socket path used by @@RXVT_NAME@@c(1) and
1634@@RXVT_NAME@@d(1). 1649@@RXVT_NAME@@d(1).
1635 1650
1636Default F<<< $HOME/.rxvt-unicode-I<< <nodename> >> >>>. 1651Default F<<< $HOME/.urxvt/urxvtd-I<< <nodename> >> >>>.
1637 1652
1638=item B<HOME> 1653=item B<HOME>
1639 1654
1640Used to locate the default directory for the unix domain socket for 1655Used to locate the default directory for the unix domain socket for
1641daemon communications and to locate various resource files (such as 1656daemon communications and to locate various resource files (such as

Diff Legend

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