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.209 by sf-exg, Mon Dec 12 13:56:03 2011 UTC

… …
183 183
184=item B<-fg> I<colour> 184=item B<-fg> I<colour>
185 185
186Window foreground colour; resource B<foreground>. 186Window foreground colour; resource B<foreground>.
187 187
188=item B<-pixmap> I<file[;geom[:op1][:op2][...]]> 188=item B<-pixmap> I<file[;oplist]>
189 189
190Compile I<afterimage> or I<pixbuf>: Specify image file for the background and also 190Compile 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 191optionally 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 192add quotes to avoid special shell interpretation of the C<;> in the
193command-line; for more details see resource B<backgroundPixmap>. 193command-line; for more details see resource B<backgroundPixmap>.
194 194
195=item B<-cr> I<colour> 195=item B<-cr> I<colour>
196 196
… …
743=item B<borderColor:> I<colour> 743=item B<borderColor:> I<colour>
744 744
745The colour of the border around the text area and between the scrollbar 745The colour of the border around the text area and between the scrollbar
746and the text. 746and the text.
747 747
748=item B<backgroundPixmap:> I<file[;geom[:op1][:op2][...]]> 748=item B<backgroundPixmap:> I<file[;oplist]>
749 749
750Use the specified image file for the background and also 750Use the specified image file for the background and also
751optionally specify its scaling with a geometry string B<WxH+X+Y>, 751optionally 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: 752Supported operations are:
758 753
759 op=tile enables tiling 754=over 4
760 op=pscale enables proportional scaling 755
756=item B<WxH+X+Y>
757
758sets scale and position. B<"W" / "H"> specify the horizontal/vertical
759scale (percent), and B<"X" / "Y"> locate the image centre (percent). A
760scale of 0 disables scaling. The maximum permitted scale is 1000.
761
762=item B<op=tile>
763
764enables tiling
765
766=item B<op=keep-aspect>
767
768maintain the image aspect ratio when scaling
769
770=item B<op=root-align>
771
761 op=root use the position of the terminal window relative to the root 772use the position of the terminal window relative to the root window as
762 window as the image offset, simulating a root window background 773the image offset, simulating a root window background
763 774
775=back
776
777The default scale and position setting is C<100x100+50+50>.
764Alternatively, a predefined set of templates can be used to achieve 778Alternatively, a predefined set of templates can be used to achieve
765the most common setups: 779the most common setups:
766 780
767 style=tiled the image is tiled with no scaling 781=over 4
768 style=aspect-stretched the image is scaled to fill the whole window maintaining 782
769 the aspect ratio and centered 783=item B<style=tiled>
770 style=stretched the image is scaled to fill the whole window 784
771 style=centered the image is centered with no scaling 785the 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 786
787=item B<style=aspect-stretched>
788
789the image is scaled to fill the whole window maintaining the aspect
790ratio and centered. Equivalent to 100x100+50+50:op=keep-aspect
791
792=item B<style=stretched>
793
794the image is scaled to fill the whole window. Equivalent to 100x100
795
796=item B<style=centered>
797
798the image is centered with no scaling. Equivalent to 0x0+50+50
799
800=item B<style=root-tiled>
801
802the image is tiled with no scaling and using 'root' positioning.
803Equivalent to 0x0:op=tile:op=root-align
804
805=back
773 806
774If multiple templates are specified the last one wins. Note that a 807If multiple templates are specified the last one wins. Note that a
775template overrides all the scale, position and operations settings. 808template 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 809
785If used in conjunction with B<-tr> option, the specified pixmap will be 810If used in conjunction with B<-tr> option, the specified pixmap will be
786blended over the transparent background using alpha-blending. If I<afterimage> 811blended over the transparent background using alpha-blending. If I<afterimage>
787support has been compiled in it is possible to choose other blending 812support has been compiled in it is possible to choose other blending
788types with B<-blt "type"> option. 813types with B<-blt "type"> option.
… …
1179performed in an exact manner; however, the closest match is assured. 1204performed in an exact manner; however, the closest match is assured.
1180 1205
1181I<string> may contain escape values (C<\n>: newline, C<\000>: octal 1206I<string> may contain escape values (C<\n>: newline, C<\000>: octal
1182number), see RESOURCES in C<man 7 X> for further details. 1207number), see RESOURCES in C<man 7 X> for further details.
1183 1208
1184You can define a range of keysyms in one shot by providing a I<string> 1209You can define a range of keysyms in one shot by
1210loading the C<keysym-list> perl extension and providing a I<string>
1185with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimiter `/' 1211with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimiter `/'
1186should be a character not used by the strings. 1212should be a character not used by the strings.
1187 1213
1188Its usage can be demonstrated by an example: 1214Its usage can be demonstrated by an example:
1189 1215
… …
1274the @@RXVT_NAME@@perl(3) manpage. 1300the @@RXVT_NAME@@perl(3) manpage.
1275 1301
1276=item B<perl-lib>: I<path> 1302=item B<perl-lib>: I<path>
1277 1303
1278Colon-separated list of additional directories that hold extension 1304Colon-separated list of additional directories that hold extension
1279scripts. When looking for extensions specified by the C<perl> resource, 1305scripts. When looking for perl extensions, @@RXVT_NAME@@ will first
1280@@RXVT_NAME@@ will first look in these directories and then in 1306look in these directories, then in $HOME/.urxvt/ext and lastly in
1281F<@@RXVT_LIBDIR@@/urxvt/perl/>. 1307F<@@RXVT_LIBDIR@@/urxvt/perl/>.
1282 1308
1283See the @@RXVT_NAME@@perl(3) manpage. 1309See the @@RXVT_NAME@@perl(3) manpage.
1284 1310
1285=item B<< selection.pattern-I<idx> >>: I<perl-regex> 1311=item B<< selection.pattern-I<idx> >>: I<perl-regex>
… …
1631=item B<RXVT_SOCKET> 1657=item B<RXVT_SOCKET>
1632 1658
1633The unix domain socket path used by @@RXVT_NAME@@c(1) and 1659The unix domain socket path used by @@RXVT_NAME@@c(1) and
1634@@RXVT_NAME@@d(1). 1660@@RXVT_NAME@@d(1).
1635 1661
1636Default F<<< $HOME/.rxvt-unicode-I<< <nodename> >> >>>. 1662Default F<<< $HOME/.urxvt/urxvtd-I<< <nodename> >> >>>.
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

Diff Legend

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