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.200 by sf-exg, Wed Aug 10 07:28:35 2011 UTC vs.
Revision 1.218 by root, Tue Jun 5 22:26:55 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
183 174
184=item B<-fg> I<colour> 175=item B<-fg> I<colour>
185 176
186Window foreground colour; resource B<foreground>. 177Window foreground colour; resource B<foreground>.
187 178
188=item B<-pixmap> I<file[;geom[:op1][:op2][...]]> 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 its scaling with a geometry string. 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>
196 187
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
743=item B<borderColor:> I<colour> 730=item B<borderColor:> I<colour>
744 731
745The colour of the border around the text area and between the scrollbar 732The colour of the border around the text area and between the scrollbar
746and the text. 733and the text.
747 734
748=item B<backgroundPixmap:> I<file[;geom[:op1][:op2][...]]> 735=item B<backgroundPixmap:> I<file[;oplist]>
749 736
750Use the specified image file for the background and also 737Use the specified image file for the background and also
751optionally specify its scaling with a geometry string B<WxH+X+Y>, 738optionally 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: 739Supported operations are:
758 740
759 tile will tile image 741=over 4
760 propscale will scale image keeping proportions 742
761 scale will scale image to match window size 743=item B<WxH+X+Y>
762 root will tile image as if it was a root window background, auto-adjusting 744
763 whenever terminal window moves 745sets scale and position. B<"W" / "H"> specify the horizontal/vertical
746scale (percent), and B<"X" / "Y"> locate the image centre (percent). A
747scale of 0 disables scaling.
748
749=item B<op=tile>
750
751enables tiling
752
753=item B<op=keep-aspect>
754
755maintain the image aspect ratio when scaling
756
757=item B<op=root-align>
758
759use the position of the terminal window relative to the root window as
760the image offset, simulating a root window background
761
762=back
763
764The default scale and position setting is C<100x100+50+50>.
765Alternatively, a predefined set of templates can be used to achieve
766the most common setups:
767
768=over 4
769
770=item B<style=tiled>
771
772the image is tiled with no scaling. Equivalent to 0x0+0+0:op=tile
773
774=item B<style=aspect-stretched>
775
776the image is scaled to fill the whole window maintaining the aspect
777ratio and centered. Equivalent to 100x100+50+50:op=keep-aspect
778
779=item B<style=stretched>
780
781the image is scaled to fill the whole window. Equivalent to 100x100
782
783=item B<style=centered>
784
785the image is centered with no scaling. Equivalent to 0x0+50+50
786
787=item B<style=root-tiled>
788
789the image is tiled with no scaling and using 'root' positioning.
790Equivalent to 0x0:op=tile:op=root-align
791
792=back
793
794If multiple templates are specified the last one wins. Note that a
795template overrides all the scale, position and operations settings.
764 796
765If 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
766blended over the transparent background using alpha-blending. If I<afterimage> 798blended over the transparent background using alpha-blending.
767support has been compiled in it is possible to choose other blending
768types with B<-blt "type"> option.
769 799
770=item B<path:> I<path> 800=item B<path:> I<path>
771 801
772Specify the colon-delimited search path for finding background image files. 802Specify the colon-delimited search path for finding background image files.
773 803
1159performed in an exact manner; however, the closest match is assured. 1189performed in an exact manner; however, the closest match is assured.
1160 1190
1161I<string> may contain escape values (C<\n>: newline, C<\000>: octal 1191I<string> may contain escape values (C<\n>: newline, C<\000>: octal
1162number), see RESOURCES in C<man 7 X> for further details. 1192number), see RESOURCES in C<man 7 X> for further details.
1163 1193
1164You 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>
1165with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimiter `/' 1196with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimiter `/'
1166should be a character not used by the strings. 1197should be a character not used by the strings.
1167 1198
1168Its usage can be demonstrated by an example: 1199Its usage can be demonstrated by an example:
1169 1200
1254the @@RXVT_NAME@@perl(3) manpage. 1285the @@RXVT_NAME@@perl(3) manpage.
1255 1286
1256=item B<perl-lib>: I<path> 1287=item B<perl-lib>: I<path>
1257 1288
1258Colon-separated list of additional directories that hold extension 1289Colon-separated list of additional directories that hold extension
1259scripts. When looking for extensions specified by the C<perl> resource, 1290scripts. When looking for perl extensions, @@RXVT_NAME@@ will first look
1260@@RXVT_NAME@@ will first look in these directories and then in 1291in these directories, then in C<$URXVT_PERL_LIB>, F<$HOME/.urxvt/ext> and
1261F<@@RXVT_LIBDIR@@/urxvt/perl/>. 1292lastly in F<@@RXVT_LIBDIR@@/urxvt/perl/>.
1262 1293
1263See the @@RXVT_NAME@@perl(3) manpage. 1294See the @@RXVT_NAME@@perl(3) manpage.
1264 1295
1265=item B<< selection.pattern-I<idx> >>: I<perl-regex> 1296=item B<< selection.pattern-I<idx> >>: I<perl-regex>
1266 1297
1514White. 1545White.
1515 1546
1516=head2 ALPHA CHANNEL SUPPORT 1547=head2 ALPHA CHANNEL SUPPORT
1517 1548
1518If 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
1519their act together, rxvt-unicode will do it's own alpha channel management: 1550their act together, rxvt-unicode will do its own alpha channel management:
1520 1551
1521You can prefix any colour with an opaqueness percentage enclosed in 1552You can prefix any colour with an opaqueness percentage enclosed in
1522brackets, i.e. C<[percent]>, where C<percent> is a decimal percentage 1553brackets, i.e. C<[percent]>, where C<percent> is a decimal percentage
1523(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
1524transparent 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
1606 1637
1607=item B<SHELL> 1638=item B<SHELL>
1608 1639
1609The shell to be used for command execution, defaults to C</bin/sh>. 1640The shell to be used for command execution, defaults to C</bin/sh>.
1610 1641
1611=item B<RXVT_SOCKET> 1642=item B<RXVT_SOCKET> [I<sic>]
1612 1643
1613The unix domain socket path used by @@RXVT_NAME@@c(1) and 1644The unix domain socket path used by @@RXVT_NAME@@c(1) and
1614@@RXVT_NAME@@d(1). 1645@@RXVT_NAME@@d(1).
1615 1646
1616Default F<<< $HOME/.rxvt-unicode-I<< <nodename> >> >>>. 1647Default F<<< $HOME/.urxvt/urxvtd-I<< <nodename> >> >>>.
1648
1649=item B<URXVT_PERL_LIB>
1650
1651Additional F<:>-separated library search path for perl extensions. Will be
1652searched after B<-perl-lib> but before F<~/.urxvt/ext> and the system library
1653directory.
1654
1655=item B<URXVT_PERL_VERBOSITY>
1656
1657See L<@@RXVT_NAME@@perl>(3).
1617 1658
1618=item B<HOME> 1659=item B<HOME>
1619 1660
1620Used to locate the default directory for the unix domain socket for 1661Used to locate the default directory for the unix domain socket for
1621daemon communications and to locate various resource files (such as 1662daemon communications and to locate various resource files (such as
1642 1683
1643=back 1684=back
1644 1685
1645=head1 SEE ALSO 1686=head1 SEE ALSO
1646 1687
1647@@RXVT_NAME@@(7), @@RXVT_NAME@@c(1), @@RXVT_NAME@@d(1), xterm(1), sh(1), resize(1), X(1), pty(4), tty(4), utmp(5) 1688@@RXVT_NAME@@(7), @@RXVT_NAME@@c(1), @@RXVT_NAME@@d(1), @@RXVT_NAME@@perl(3), xterm(1), sh(1), resize(1), X(1), pty(4), tty(4), utmp(5)
1648 1689
1649=head1 CURRENT PROJECT COORDINATOR 1690=head1 CURRENT PROJECT COORDINATOR
1650 1691
1651=over 4 1692=over 4
1652 1693

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines