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.196 by root, Fri May 6 10:18:00 2011 UTC vs.
Revision 1.211 by sf-exg, Sat Dec 31 17:17:12 2011 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;
172resource I<blurRadius>. 172resource I<blurRadius>.
173 173
174=item B<-icon> I<file> 174=item B<-icon> I<file>
175 175
176Compile I<afterimage> or I<pixbuf>: Use the specified image as application icon. This 176Compile I<afterimage> or I<pixbuf>: Use the specified image as application icon. This
… …
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 displays the image with tiling.
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 tile force background image to be tiled and not scaled. Equivalent to 0x0 754=over 4
760 propscale will scale image keeping proportions 755
761 auto will scale image to match window size. Equivalent to 100x100 756=item B<WxH+X+Y>
762 hscale will scale image horizontally to the window size 757
763 vscale will scale image vertically to the window size 758sets scale and position. B<"W" / "H"> specify the horizontal/vertical
764 scale will scale image to match window size 759scale (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 760scale of 0 disables scaling. The maximum permitted scale is 1000.
766 whenever terminal window moves 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
772use the position of the terminal window relative to the root window as
773the image offset, simulating a root window background
774
775=back
776
777The default scale and position setting is C<100x100+50+50>.
778Alternatively, a predefined set of templates can be used to achieve
779the most common setups:
780
781=over 4
782
783=item B<style=tiled>
784
785the image is tiled with no scaling. Equivalent to 0x0+0+0:op=tile
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
806
807If multiple templates are specified the last one wins. Note that a
808template overrides all the scale, position and operations settings.
767 809
768If 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
769blended over the transparent background using alpha-blending. If I<afterimage> 811blended over the transparent background using alpha-blending. If I<afterimage>
770support has been compiled in it is possible to choose other blending 812support has been compiled in it is possible to choose other blending
771types with B<-blt "type"> option. 813types with B<-blt "type"> option.
… …
1162performed in an exact manner; however, the closest match is assured. 1204performed in an exact manner; however, the closest match is assured.
1163 1205
1164I<string> may contain escape values (C<\n>: newline, C<\000>: octal 1206I<string> may contain escape values (C<\n>: newline, C<\000>: octal
1165number), see RESOURCES in C<man 7 X> for further details. 1207number), see RESOURCES in C<man 7 X> for further details.
1166 1208
1209You can define a range of keysyms in one shot by
1210loading the C<keysym-list> perl extension and providing a I<string>
1211with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimiter `/'
1212should be a character not used by the strings.
1213
1214Its usage can be demonstrated by an example:
1215
1216 URxvt.keysym.M-C-0x61: list|\033<|abc|>
1217
1218The above line is equivalent to the following three lines:
1219
1220 URxvt.keysym.Meta-Control-0x61: \033<a>
1221 URxvt.keysym.Meta-Control-0x62: \033<b>
1222 URxvt.keysym.Meta-Control-0x63: \033<c>
1223
1167If I<string> takes the form of C<command:STRING>, the specified B<STRING> 1224If I<string> takes the form of C<command:STRING>, the specified B<STRING>
1168is interpreted and executed as @@RXVT_NAME@@'s control sequence. For 1225is interpreted and executed as @@RXVT_NAME@@'s control sequence. For
1169example the following means "change the current locale to C<zh_CN.GBK> 1226example the following means "change the current locale to C<zh_CN.GBK>
1170when Control-Meta-c is being pressed": 1227when Control-Meta-c is being pressed":
1171 1228
… …
1243the @@RXVT_NAME@@perl(3) manpage. 1300the @@RXVT_NAME@@perl(3) manpage.
1244 1301
1245=item B<perl-lib>: I<path> 1302=item B<perl-lib>: I<path>
1246 1303
1247Colon-separated list of additional directories that hold extension 1304Colon-separated list of additional directories that hold extension
1248scripts. When looking for extensions specified by the C<perl> resource, 1305scripts. When looking for perl extensions, @@RXVT_NAME@@ will first
1249@@RXVT_NAME@@ will first look in these directories and then in 1306look in these directories, then in $HOME/.urxvt/ext and lastly in
1250F<@@RXVT_LIBDIR@@/urxvt/perl/>. 1307F<@@RXVT_LIBDIR@@/urxvt/perl/>.
1251 1308
1252See the @@RXVT_NAME@@perl(3) manpage. 1309See the @@RXVT_NAME@@perl(3) manpage.
1253 1310
1254=item B<< selection.pattern-I<idx> >>: I<perl-regex> 1311=item B<< selection.pattern-I<idx> >>: I<perl-regex>
… …
1503White. 1560White.
1504 1561
1505=head2 ALPHA CHANNEL SUPPORT 1562=head2 ALPHA CHANNEL SUPPORT
1506 1563
1507If Xft support has been compiled in and as long as Xft/Xrender/X don't get 1564If Xft support has been compiled in and as long as Xft/Xrender/X don't get
1508their act together, rxvt-unicode will do it's own alpha channel management: 1565their act together, rxvt-unicode will do its own alpha channel management:
1509 1566
1510You can prefix any colour with an opaqueness percentage enclosed in 1567You can prefix any colour with an opaqueness percentage enclosed in
1511brackets, i.e. C<[percent]>, where C<percent> is a decimal percentage 1568brackets, i.e. C<[percent]>, where C<percent> is a decimal percentage
1512(0-100) that specifies the opacity of the colour, where C<0> is completely 1569(0-100) that specifies the opacity of the colour, where C<0> is completely
1513transparent and C<100> is completely opaque. For example, C<[50]red> is a 1570transparent and C<100> is completely opaque. For example, C<[50]red> is a
… …
1600=item B<RXVT_SOCKET> 1657=item B<RXVT_SOCKET>
1601 1658
1602The unix domain socket path used by @@RXVT_NAME@@c(1) and 1659The unix domain socket path used by @@RXVT_NAME@@c(1) and
1603@@RXVT_NAME@@d(1). 1660@@RXVT_NAME@@d(1).
1604 1661
1605Default F<<< $HOME/.rxvt-unicode-I<< <nodename> >> >>>. 1662Default F<<< $HOME/.urxvt/urxvtd-I<< <nodename> >> >>>.
1606 1663
1607=item B<HOME> 1664=item B<HOME>
1608 1665
1609Used to locate the default directory for the unix domain socket for 1666Used to locate the default directory for the unix domain socket for
1610daemon 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