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.192 by sf-exg, Sat Dec 18 12:20:18 2010 UTC vs.
Revision 1.216 by root, Tue Jun 5 21:29:51 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
558You can set and change the resources using X11 tools like B<xrdb>. Many 549You can set and change the resources using X11 tools like B<xrdb>. Many
559distribution do also load settings from the B<~/.Xresources> file when X 550distribution do also load settings from the B<~/.Xresources> file when X
560starts. @@RXVT_NAME@@ will consult the following files/resources in order, 551starts. @@RXVT_NAME@@ will consult the following files/resources in order,
561with later settings overwriting earlier ones: 552with later settings overwriting earlier ones:
562 553
563 1. system-wide app-defaults file, either locale-dependent OR global
564 2. app-defaults file in $XAPPLRESDIR 554 1. app-defaults file in $XAPPLRESDIR
555 2. $HOME/.Xdefaults
565 3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults 556 3. RESOURCE_MANAGER property on root-window of screen 0
566 4. SCREEN_RESOURCES for the current screen 557 4. SCREEN_RESOURCES property on root-window of the current screen
567 5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename> 558 5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename>
568 6. resources specified via -xrm on the commandline 559 6. resources specified via -xrm on the commandline
569 560
570Note that when reading X resources, B<@@RXVT_NAME@@> recognizes two class 561Note that when reading X resources, B<@@RXVT_NAME@@> recognizes two class
571names: B<Rxvt> and B<URxvt>. The class name B<Rxvt> allows resources 562names: B<Rxvt> and B<URxvt>. The class name B<Rxvt> allows resources
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 displays the image with tiling.
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 force background image to be tiled and not scaled. Equivalent to 0x0 741=over 4
760 propscale will scale image keeping proportions 742
761 auto will scale image to match window size. Equivalent to 100x100 743=item B<WxH+X+Y>
762 hscale will scale image horizontally to the window size 744
763 vscale will scale image vertically to the window size 745sets scale and position. B<"W" / "H"> specify the horizontal/vertical
764 scale will scale image to match window size 746scale (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 747scale of 0 disables scaling.
766 whenever terminal window moves 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.
767 796
768If 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
769blended over the transparent background using alpha-blending. If I<afterimage> 798blended over the transparent background using alpha-blending.
770support has been compiled in it is possible to choose other blending
771types with B<-blt "type"> option.
772 799
773=item B<path:> I<path> 800=item B<path:> I<path>
774 801
775Specify the colon-delimited search path for finding background image files. 802Specify the colon-delimited search path for finding background image files.
776 803
903=item B<scrollstyle:> I<mode> 930=item B<scrollstyle:> I<mode>
904 931
905Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is 932Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is
906the author's favourite. 933the author's favourite.
907 934
935=item B<thickness:> I<number>
936
937Set the scrollbar width in pixels.
938
908=item B<scrollBar:> I<boolean> 939=item B<scrollBar:> I<boolean>
909 940
910B<True>: enable the scrollbar [default]; option B<-sb>. B<False>: 941B<True>: enable the scrollbar [default]; option B<-sb>. B<False>:
911disable the scrollbar; option B<+sb>. 942disable the scrollbar; option B<+sb>.
912 943
931B<False>: do not scroll to bottom when tty receives output; option 962B<False>: do not scroll to bottom when tty receives output; option
932B<+si>. 963B<+si>.
933 964
934=item B<scrollWithBuffer:> I<boolean> 965=item B<scrollWithBuffer:> I<boolean>
935 966
936B<True>: scroll with scrollback buffer when tty receives new lines (and 967B<True>: scroll with scrollback buffer when tty receives new lines (i.e.
937B<scrollTtyOutput> is False); option B<-sw>. B<False>: do not scroll 968try to show the same lines) and B<scrollTtyOutput> is False; option
938with scrollback buffer when tty receives new lines; option B<+sw>. 969B<-sw>. B<False>: do not scroll with scrollback buffer when tty receives
970new lines; option B<+sw>.
939 971
940=item B<scrollTtyKeypress:> I<boolean> 972=item B<scrollTtyKeypress:> I<boolean>
941 973
942B<True>: scroll to bottom when a non-special key is pressed. Special keys 974B<True>: scroll to bottom when a non-special key is pressed. Special keys
943are those which are intercepted by rxvt-unicode for special handling and 975are those which are intercepted by rxvt-unicode for special handling and
1157performed in an exact manner; however, the closest match is assured. 1189performed in an exact manner; however, the closest match is assured.
1158 1190
1159I<string> may contain escape values (C<\n>: newline, C<\000>: octal 1191I<string> may contain escape values (C<\n>: newline, C<\000>: octal
1160number), see RESOURCES in C<man 7 X> for further details. 1192number), see RESOURCES in C<man 7 X> for further details.
1161 1193
1162You 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>
1163with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimiter `/' 1196with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimiter `/'
1164should be a character not used by the strings. 1197should be a character not used by the strings.
1165 1198
1166Its usage can be demonstrated by an example: 1199Its usage can be demonstrated by an example:
1167 1200
1168 URxvt.keysym.M-C-0x61: list|\033<M-C-|abc|> 1201 URxvt.keysym.M-C-0x61: list|\033<|abc|>
1169 1202
1170The above line is equivalent to the following three lines: 1203The above line is equivalent to the following three lines:
1171 1204
1172 URxvt.keysym.Meta-Control-0x61: \033<M-C-a> 1205 URxvt.keysym.Meta-Control-0x61: \033<a>
1173 URxvt.keysym.Meta-Control-0x62: \033<M-C-b> 1206 URxvt.keysym.Meta-Control-0x62: \033<b>
1174 URxvt.keysym.Meta-Control-0x63: \033<M-C-c> 1207 URxvt.keysym.Meta-Control-0x63: \033<c>
1175 1208
1176If I<string> takes the form of C<command:STRING>, the specified B<STRING> 1209If I<string> takes the form of C<command:STRING>, the specified B<STRING>
1177is interpreted and executed as @@RXVT_NAME@@'s control sequence. For 1210is interpreted and executed as @@RXVT_NAME@@'s control sequence. For
1178example the following means "change the current locale to C<zh_CN.GBK> 1211example the following means "change the current locale to C<zh_CN.GBK>
1179when Control-Meta-c is being pressed": 1212when Control-Meta-c is being pressed":
1252the @@RXVT_NAME@@perl(3) manpage. 1285the @@RXVT_NAME@@perl(3) manpage.
1253 1286
1254=item B<perl-lib>: I<path> 1287=item B<perl-lib>: I<path>
1255 1288
1256Colon-separated list of additional directories that hold extension 1289Colon-separated list of additional directories that hold extension
1257scripts. When looking for extensions specified by the C<perl> resource, 1290scripts. When looking for perl extensions, @@RXVT_NAME@@ will first look
1258@@RXVT_NAME@@ will first look in these directories and then in 1291in these directories, then in C<$RXVT_PERL_LIB>, F<$HOME/.urxvt/ext> and
1259F<@@RXVT_LIBDIR@@/urxvt/perl/>. 1292lastly in F<@@RXVT_LIBDIR@@/urxvt/perl/>.
1260 1293
1261See the @@RXVT_NAME@@perl(3) manpage. 1294See the @@RXVT_NAME@@perl(3) manpage.
1262 1295
1263=item B<< selection.pattern-I<idx> >>: I<perl-regex> 1296=item B<< selection.pattern-I<idx> >>: I<perl-regex>
1264 1297
1512White. 1545White.
1513 1546
1514=head2 ALPHA CHANNEL SUPPORT 1547=head2 ALPHA CHANNEL SUPPORT
1515 1548
1516If 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
1517their act together, rxvt-unicode will do it's own alpha channel management: 1550their act together, rxvt-unicode will do its own alpha channel management:
1518 1551
1519You can prefix any colour with an opaqueness percentage enclosed in 1552You can prefix any colour with an opaqueness percentage enclosed in
1520brackets, i.e. C<[percent]>, where C<percent> is a decimal percentage 1553brackets, i.e. C<[percent]>, where C<percent> is a decimal percentage
1521(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
1522transparent 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
1604 1637
1605=item B<SHELL> 1638=item B<SHELL>
1606 1639
1607The 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>.
1608 1641
1609=item B<RXVT_SOCKET> 1642=item B<RXVT_SOCKET> (sic)
1610 1643
1611The unix domain socket path used by @@RXVT_NAME@@c(1) and 1644The unix domain socket path used by @@RXVT_NAME@@c(1) and
1612@@RXVT_NAME@@d(1). 1645@@RXVT_NAME@@d(1).
1613 1646
1614Default F<<< $HOME/.rxvt-unicode-I<< <nodename> >> >>>. 1647Default F<<< $HOME/.urxvt/urxvtd-I<< <nodename> >> >>>.
1648
1649=item B<RXVT_PERL_LIB> (sic)
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.
1615 1654
1616=item B<HOME> 1655=item B<HOME>
1617 1656
1618Used to locate the default directory for the unix domain socket for 1657Used to locate the default directory for the unix domain socket for
1619daemon communications and to locate various resource files (such as 1658daemon communications and to locate various resource files (such as

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines