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.194 by sf-exg, Wed Mar 9 13:24:30 2011 UTC vs.
Revision 1.213 by sf-exg, Sat Feb 4 21:47:06 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
743=item B<borderColor:> I<colour> 734=item B<borderColor:> I<colour>
744 735
745The colour of the border around the text area and between the scrollbar 736The colour of the border around the text area and between the scrollbar
746and the text. 737and the text.
747 738
748=item B<backgroundPixmap:> I<file[;geom[:op1][:op2][...]]> 739=item B<backgroundPixmap:> I<file[;oplist]>
749 740
750Use the specified image file for the background and also 741Use the specified image file for the background and also
751optionally specify its scaling with a geometry string B<WxH+X+Y>, 742optionally 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: 743Supported operations are:
758 744
759 tile force background image to be tiled and not scaled. Equivalent to 0x0 745=over 4
760 propscale will scale image keeping proportions 746
761 auto will scale image to match window size. Equivalent to 100x100 747=item B<WxH+X+Y>
762 hscale will scale image horizontally to the window size 748
763 vscale will scale image vertically to the window size 749sets scale and position. B<"W" / "H"> specify the horizontal/vertical
764 scale will scale image to match window size 750scale (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 751scale of 0 disables scaling. The maximum permitted scale is 1000.
766 whenever terminal window moves 752
753=item B<op=tile>
754
755enables tiling
756
757=item B<op=keep-aspect>
758
759maintain the image aspect ratio when scaling
760
761=item B<op=root-align>
762
763use the position of the terminal window relative to the root window as
764the image offset, simulating a root window background
765
766=back
767
768The default scale and position setting is C<100x100+50+50>.
769Alternatively, a predefined set of templates can be used to achieve
770the most common setups:
771
772=over 4
773
774=item B<style=tiled>
775
776the image is tiled with no scaling. Equivalent to 0x0+0+0:op=tile
777
778=item B<style=aspect-stretched>
779
780the image is scaled to fill the whole window maintaining the aspect
781ratio and centered. Equivalent to 100x100+50+50:op=keep-aspect
782
783=item B<style=stretched>
784
785the image is scaled to fill the whole window. Equivalent to 100x100
786
787=item B<style=centered>
788
789the image is centered with no scaling. Equivalent to 0x0+50+50
790
791=item B<style=root-tiled>
792
793the image is tiled with no scaling and using 'root' positioning.
794Equivalent to 0x0:op=tile:op=root-align
795
796=back
797
798If multiple templates are specified the last one wins. Note that a
799template overrides all the scale, position and operations settings.
767 800
768If used in conjunction with B<-tr> option, the specified pixmap will be 801If used in conjunction with B<-tr> option, the specified pixmap will be
769blended over the transparent background using alpha-blending. If I<afterimage> 802blended 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 803
773=item B<path:> I<path> 804=item B<path:> I<path>
774 805
775Specify the colon-delimited search path for finding background image files. 806Specify the colon-delimited search path for finding background image files.
776 807
935B<False>: do not scroll to bottom when tty receives output; option 966B<False>: do not scroll to bottom when tty receives output; option
936B<+si>. 967B<+si>.
937 968
938=item B<scrollWithBuffer:> I<boolean> 969=item B<scrollWithBuffer:> I<boolean>
939 970
940B<True>: scroll with scrollback buffer when tty receives new lines (and 971B<True>: scroll with scrollback buffer when tty receives new lines (i.e.
941B<scrollTtyOutput> is False); option B<-sw>. B<False>: do not scroll 972try to show the same lines) and B<scrollTtyOutput> is False; option
942with scrollback buffer when tty receives new lines; option B<+sw>. 973B<-sw>. B<False>: do not scroll with scrollback buffer when tty receives
974new lines; option B<+sw>.
943 975
944=item B<scrollTtyKeypress:> I<boolean> 976=item B<scrollTtyKeypress:> I<boolean>
945 977
946B<True>: scroll to bottom when a non-special key is pressed. Special keys 978B<True>: scroll to bottom when a non-special key is pressed. Special keys
947are those which are intercepted by rxvt-unicode for special handling and 979are those which are intercepted by rxvt-unicode for special handling and
1161performed in an exact manner; however, the closest match is assured. 1193performed in an exact manner; however, the closest match is assured.
1162 1194
1163I<string> may contain escape values (C<\n>: newline, C<\000>: octal 1195I<string> may contain escape values (C<\n>: newline, C<\000>: octal
1164number), see RESOURCES in C<man 7 X> for further details. 1196number), see RESOURCES in C<man 7 X> for further details.
1165 1197
1166You can define a range of keysyms in one shot by providing a I<string> 1198You can define a range of keysyms in one shot by
1199loading the C<keysym-list> perl extension and providing a I<string>
1167with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimiter `/' 1200with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimiter `/'
1168should be a character not used by the strings. 1201should be a character not used by the strings.
1169 1202
1170Its usage can be demonstrated by an example: 1203Its usage can be demonstrated by an example:
1171 1204
1172 URxvt.keysym.M-C-0x61: list|\033<M-C-|abc|> 1205 URxvt.keysym.M-C-0x61: list|\033<|abc|>
1173 1206
1174The above line is equivalent to the following three lines: 1207The above line is equivalent to the following three lines:
1175 1208
1176 URxvt.keysym.Meta-Control-0x61: \033<M-C-a> 1209 URxvt.keysym.Meta-Control-0x61: \033<a>
1177 URxvt.keysym.Meta-Control-0x62: \033<M-C-b> 1210 URxvt.keysym.Meta-Control-0x62: \033<b>
1178 URxvt.keysym.Meta-Control-0x63: \033<M-C-c> 1211 URxvt.keysym.Meta-Control-0x63: \033<c>
1179 1212
1180If I<string> takes the form of C<command:STRING>, the specified B<STRING> 1213If I<string> takes the form of C<command:STRING>, the specified B<STRING>
1181is interpreted and executed as @@RXVT_NAME@@'s control sequence. For 1214is interpreted and executed as @@RXVT_NAME@@'s control sequence. For
1182example the following means "change the current locale to C<zh_CN.GBK> 1215example the following means "change the current locale to C<zh_CN.GBK>
1183when Control-Meta-c is being pressed": 1216when Control-Meta-c is being pressed":
1256the @@RXVT_NAME@@perl(3) manpage. 1289the @@RXVT_NAME@@perl(3) manpage.
1257 1290
1258=item B<perl-lib>: I<path> 1291=item B<perl-lib>: I<path>
1259 1292
1260Colon-separated list of additional directories that hold extension 1293Colon-separated list of additional directories that hold extension
1261scripts. When looking for extensions specified by the C<perl> resource, 1294scripts. When looking for perl extensions, @@RXVT_NAME@@ will first
1262@@RXVT_NAME@@ will first look in these directories and then in 1295look in these directories, then in $HOME/.urxvt/ext and lastly in
1263F<@@RXVT_LIBDIR@@/urxvt/perl/>. 1296F<@@RXVT_LIBDIR@@/urxvt/perl/>.
1264 1297
1265See the @@RXVT_NAME@@perl(3) manpage. 1298See the @@RXVT_NAME@@perl(3) manpage.
1266 1299
1267=item B<< selection.pattern-I<idx> >>: I<perl-regex> 1300=item B<< selection.pattern-I<idx> >>: I<perl-regex>
1516White. 1549White.
1517 1550
1518=head2 ALPHA CHANNEL SUPPORT 1551=head2 ALPHA CHANNEL SUPPORT
1519 1552
1520If Xft support has been compiled in and as long as Xft/Xrender/X don't get 1553If Xft support has been compiled in and as long as Xft/Xrender/X don't get
1521their act together, rxvt-unicode will do it's own alpha channel management: 1554their act together, rxvt-unicode will do its own alpha channel management:
1522 1555
1523You can prefix any colour with an opaqueness percentage enclosed in 1556You can prefix any colour with an opaqueness percentage enclosed in
1524brackets, i.e. C<[percent]>, where C<percent> is a decimal percentage 1557brackets, i.e. C<[percent]>, where C<percent> is a decimal percentage
1525(0-100) that specifies the opacity of the colour, where C<0> is completely 1558(0-100) that specifies the opacity of the colour, where C<0> is completely
1526transparent and C<100> is completely opaque. For example, C<[50]red> is a 1559transparent and C<100> is completely opaque. For example, C<[50]red> is a
1613=item B<RXVT_SOCKET> 1646=item B<RXVT_SOCKET>
1614 1647
1615The unix domain socket path used by @@RXVT_NAME@@c(1) and 1648The unix domain socket path used by @@RXVT_NAME@@c(1) and
1616@@RXVT_NAME@@d(1). 1649@@RXVT_NAME@@d(1).
1617 1650
1618Default F<<< $HOME/.rxvt-unicode-I<< <nodename> >> >>>. 1651Default F<<< $HOME/.urxvt/urxvtd-I<< <nodename> >> >>>.
1619 1652
1620=item B<HOME> 1653=item B<HOME>
1621 1654
1622Used to locate the default directory for the unix domain socket for 1655Used to locate the default directory for the unix domain socket for
1623daemon communications and to locate various resource files (such as 1656daemon communications and to locate various resource files (such as

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines