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.198 by sf-exg, Tue Aug 9 18:41:31 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
… …
183 184
184=item B<-fg> I<colour> 185=item B<-fg> I<colour>
185 186
186Window foreground colour; resource B<foreground>. 187Window foreground colour; resource B<foreground>.
187 188
188=item B<-pixmap> I<file[;geom[:op1][:op2][...]]> 189=item B<-pixmap> I<file[;oplist]>
189 190
190Compile I<afterimage> or I<pixbuf>: Specify image file for the background and also 191Compile I<afterimage> or I<pixbuf>: Specify image file for the background and also
191optionally specify its scaling with a geometry string. Note you may need to 192optionally 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 193add quotes to avoid special shell interpretation of the C<;> in the
193command-line; for more details see resource B<backgroundPixmap>. 194command-line; for more details see resource B<backgroundPixmap>.
194 195
195=item B<-cr> I<colour> 196=item B<-cr> I<colour>
196 197
… …
743=item B<borderColor:> I<colour> 744=item B<borderColor:> I<colour>
744 745
745The colour of the border around the text area and between the scrollbar 746The colour of the border around the text area and between the scrollbar
746and the text. 747and the text.
747 748
748=item B<backgroundPixmap:> I<file[;geom[:op1][:op2][...]]> 749=item B<backgroundPixmap:> I<file[;oplist]>
749 750
750Use the specified image file for the background and also 751Use the specified image file for the background and also
751optionally specify its scaling with a geometry string B<WxH+X+Y>, 752optionally 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: 753Supported operations are:
758 754
759 tile will tile image 755=over 4
760 propscale will scale image keeping proportions 756
761 auto will scale image to match window size. Equivalent to 100x100 757=item B<WxH+X+Y>
762 hscale will scale image horizontally to the window size 758
763 vscale will scale image vertically to the window size 759sets scale and position. B<"W" / "H"> specify the horizontal/vertical
764 scale will scale image to match window size 760scale (percent), and B<"X" / "Y"> locate the image centre (percent). A
765 root will tile image as if it was a root window background, auto-adjusting 761scale of 0 disables scaling. The maximum permitted scale is 1000.
766 whenever terminal window moves 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
773use the position of the terminal window relative to the root window as
774the image offset, simulating a root window background
775
776=back
777
778The default scale and position setting is C<100x100+50+50>.
779Alternatively, a predefined set of templates can be used to achieve
780the most common setups:
781
782=over 4
783
784=item B<style=tiled>
785
786the image is tiled with no scaling. Equivalent to 0x0+0+0:op=tile
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
807
808If multiple templates are specified the last one wins. Note that a
809template overrides all the scale, position and operations settings.
767 810
768If 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
769blended over the transparent background using alpha-blending. If I<afterimage> 812blended over the transparent background using alpha-blending. If I<afterimage>
770support has been compiled in it is possible to choose other blending 813support has been compiled in it is possible to choose other blending
771types with B<-blt "type"> option. 814types with B<-blt "type"> option.
… …
1162performed in an exact manner; however, the closest match is assured. 1205performed in an exact manner; however, the closest match is assured.
1163 1206
1164I<string> may contain escape values (C<\n>: newline, C<\000>: octal 1207I<string> may contain escape values (C<\n>: newline, C<\000>: octal
1165number), see RESOURCES in C<man 7 X> for further details. 1208number), see RESOURCES in C<man 7 X> for further details.
1166 1209
1167You 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>
1168with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimiter `/' 1212with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimiter `/'
1169should be a character not used by the strings. 1213should be a character not used by the strings.
1170 1214
1171Its usage can be demonstrated by an example: 1215Its usage can be demonstrated by an example:
1172 1216
… …
1257the @@RXVT_NAME@@perl(3) manpage. 1301the @@RXVT_NAME@@perl(3) manpage.
1258 1302
1259=item B<perl-lib>: I<path> 1303=item B<perl-lib>: I<path>
1260 1304
1261Colon-separated list of additional directories that hold extension 1305Colon-separated list of additional directories that hold extension
1262scripts. When looking for extensions specified by the C<perl> resource, 1306scripts. When looking for perl extensions, @@RXVT_NAME@@ will first
1263@@RXVT_NAME@@ will first look in these directories and then in 1307look in these directories, then in $HOME/.urxvt/ext and lastly in
1264F<@@RXVT_LIBDIR@@/urxvt/perl/>. 1308F<@@RXVT_LIBDIR@@/urxvt/perl/>.
1265 1309
1266See the @@RXVT_NAME@@perl(3) manpage. 1310See the @@RXVT_NAME@@perl(3) manpage.
1267 1311
1268=item B<< selection.pattern-I<idx> >>: I<perl-regex> 1312=item B<< selection.pattern-I<idx> >>: I<perl-regex>
… …
1517White. 1561White.
1518 1562
1519=head2 ALPHA CHANNEL SUPPORT 1563=head2 ALPHA CHANNEL SUPPORT
1520 1564
1521If 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
1522their act together, rxvt-unicode will do it's own alpha channel management: 1566their act together, rxvt-unicode will do its own alpha channel management:
1523 1567
1524You can prefix any colour with an opaqueness percentage enclosed in 1568You can prefix any colour with an opaqueness percentage enclosed in
1525brackets, i.e. C<[percent]>, where C<percent> is a decimal percentage 1569brackets, i.e. C<[percent]>, where C<percent> is a decimal percentage
1526(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
1527transparent 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
… …
1614=item B<RXVT_SOCKET> 1658=item B<RXVT_SOCKET>
1615 1659
1616The unix domain socket path used by @@RXVT_NAME@@c(1) and 1660The unix domain socket path used by @@RXVT_NAME@@c(1) and
1617@@RXVT_NAME@@d(1). 1661@@RXVT_NAME@@d(1).
1618 1662
1619Default F<<< $HOME/.rxvt-unicode-I<< <nodename> >> >>>. 1663Default F<<< $HOME/.urxvt/urxvtd-I<< <nodename> >> >>>.
1620 1664
1621=item B<HOME> 1665=item B<HOME>
1622 1666
1623Used to locate the default directory for the unix domain socket for 1667Used to locate the default directory for the unix domain socket for
1624daemon 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