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.195 by sf-exg, Sat Apr 30 18:45:38 2011 UTC vs.
Revision 1.212 by sf-exg, Sun Jan 1 14:31:28 2012 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. An horizontal or
172vertical radius of 0 disables blurring;
172resource I<blurRadius>. 173resource I<blurRadius>.
173 174
174=item B<-icon> I<file> 175=item B<-icon> I<file>
175 176
176Compile I<afterimage> or I<pixbuf>: Use the specified image as application icon. This 177Compile I<afterimage> or I<pixbuf>: Use the specified image as application icon. This
183 184
184=item B<-fg> I<colour> 185=item B<-fg> I<colour>
185 186
186Window foreground colour; resource B<foreground>. 187Window foreground colour; resource B<foreground>.
187 188
188=item B<-pixmap> I<file[;geom[:op1][:op2][...]]> 189=item B<-pixmap> I<file[;oplist]>
189 190
190Compile I<afterimage> or I<pixbuf>: Specify image file for the background and also 191Compile 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 192optionally 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 193add quotes to avoid special shell interpretation of the C<;> in the
193command-line; for more details see resource B<backgroundPixmap>. 194command-line; for more details see resource B<backgroundPixmap>.
194 195
195=item B<-cr> I<colour> 196=item B<-cr> I<colour>
196 197
743=item B<borderColor:> I<colour> 744=item B<borderColor:> I<colour>
744 745
745The colour of the border around the text area and between the scrollbar 746The colour of the border around the text area and between the scrollbar
746and the text. 747and the text.
747 748
748=item B<backgroundPixmap:> I<file[;geom[:op1][:op2][...]]> 749=item B<backgroundPixmap:> I<file[;oplist]>
749 750
750Use the specified image file for the background and also 751Use the specified image file for the background and also
751optionally specify its scaling with a geometry string B<WxH+X+Y>, 752optionally 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: 753Supported operations are:
758 754
759 tile force background image to be tiled and not scaled. Equivalent to 0x0 755=over 4
760 propscale will scale image keeping proportions 756
761 auto will scale image to match window size. Equivalent to 100x100 757=item B<WxH+X+Y>
762 hscale will scale image horizontally to the window size 758
763 vscale will scale image vertically to the window size 759sets scale and position. B<"W" / "H"> specify the horizontal/vertical
764 scale will scale image to match window size 760scale (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 761scale of 0 disables scaling. The maximum permitted scale is 1000.
766 whenever terminal window moves 762
763=item B<op=tile>
764
765enables tiling
766
767=item B<op=keep-aspect>
768
769maintain the image aspect ratio when scaling
770
771=item B<op=root-align>
772
773use the position of the terminal window relative to the root window as
774the image offset, simulating a root window background
775
776=back
777
778The default scale and position setting is C<100x100+50+50>.
779Alternatively, a predefined set of templates can be used to achieve
780the most common setups:
781
782=over 4
783
784=item B<style=tiled>
785
786the image is tiled with no scaling. Equivalent to 0x0+0+0:op=tile
787
788=item B<style=aspect-stretched>
789
790the image is scaled to fill the whole window maintaining the aspect
791ratio and centered. Equivalent to 100x100+50+50:op=keep-aspect
792
793=item B<style=stretched>
794
795the image is scaled to fill the whole window. Equivalent to 100x100
796
797=item B<style=centered>
798
799the image is centered with no scaling. Equivalent to 0x0+50+50
800
801=item B<style=root-tiled>
802
803the image is tiled with no scaling and using 'root' positioning.
804Equivalent to 0x0:op=tile:op=root-align
805
806=back
807
808If multiple templates are specified the last one wins. Note that a
809template overrides all the scale, position and operations settings.
767 810
768If used in conjunction with B<-tr> option, the specified pixmap will be 811If used in conjunction with B<-tr> option, the specified pixmap will be
769blended over the transparent background using alpha-blending. If I<afterimage> 812blended over the transparent background using alpha-blending. If I<afterimage>
770support has been compiled in it is possible to choose other blending 813support has been compiled in it is possible to choose other blending
771types with B<-blt "type"> option. 814types with B<-blt "type"> option.
935B<False>: do not scroll to bottom when tty receives output; option 978B<False>: do not scroll to bottom when tty receives output; option
936B<+si>. 979B<+si>.
937 980
938=item B<scrollWithBuffer:> I<boolean> 981=item B<scrollWithBuffer:> I<boolean>
939 982
940B<True>: scroll with scrollback buffer when tty receives new lines (and 983B<True>: scroll with scrollback buffer when tty receives new lines (i.e.
941B<scrollTtyOutput> is False); option B<-sw>. B<False>: do not scroll 984try to show the same lines) and B<scrollTtyOutput> is False; option
942with scrollback buffer when tty receives new lines; option B<+sw>. 985B<-sw>. B<False>: do not scroll with scrollback buffer when tty receives
986new lines; option B<+sw>.
943 987
944=item B<scrollTtyKeypress:> I<boolean> 988=item B<scrollTtyKeypress:> I<boolean>
945 989
946B<True>: scroll to bottom when a non-special key is pressed. Special keys 990B<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 991are those which are intercepted by rxvt-unicode for special handling and
1161performed in an exact manner; however, the closest match is assured. 1205performed in an exact manner; however, the closest match is assured.
1162 1206
1163I<string> may contain escape values (C<\n>: newline, C<\000>: octal 1207I<string> may contain escape values (C<\n>: newline, C<\000>: octal
1164number), see RESOURCES in C<man 7 X> for further details. 1208number), see RESOURCES in C<man 7 X> for further details.
1165 1209
1210You can define a range of keysyms in one shot by
1211loading the C<keysym-list> perl extension and providing a I<string>
1212with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimiter `/'
1213should be a character not used by the strings.
1214
1215Its usage can be demonstrated by an example:
1216
1217 URxvt.keysym.M-C-0x61: list|\033<|abc|>
1218
1219The above line is equivalent to the following three lines:
1220
1221 URxvt.keysym.Meta-Control-0x61: \033<a>
1222 URxvt.keysym.Meta-Control-0x62: \033<b>
1223 URxvt.keysym.Meta-Control-0x63: \033<c>
1224
1166If I<string> takes the form of C<command:STRING>, the specified B<STRING> 1225If I<string> takes the form of C<command:STRING>, the specified B<STRING>
1167is interpreted and executed as @@RXVT_NAME@@'s control sequence. For 1226is interpreted and executed as @@RXVT_NAME@@'s control sequence. For
1168example the following means "change the current locale to C<zh_CN.GBK> 1227example the following means "change the current locale to C<zh_CN.GBK>
1169when Control-Meta-c is being pressed": 1228when Control-Meta-c is being pressed":
1170 1229
1242the @@RXVT_NAME@@perl(3) manpage. 1301the @@RXVT_NAME@@perl(3) manpage.
1243 1302
1244=item B<perl-lib>: I<path> 1303=item B<perl-lib>: I<path>
1245 1304
1246Colon-separated list of additional directories that hold extension 1305Colon-separated list of additional directories that hold extension
1247scripts. When looking for extensions specified by the C<perl> resource, 1306scripts. When looking for perl extensions, @@RXVT_NAME@@ will first
1248@@RXVT_NAME@@ will first look in these directories and then in 1307look in these directories, then in $HOME/.urxvt/ext and lastly in
1249F<@@RXVT_LIBDIR@@/urxvt/perl/>. 1308F<@@RXVT_LIBDIR@@/urxvt/perl/>.
1250 1309
1251See the @@RXVT_NAME@@perl(3) manpage. 1310See the @@RXVT_NAME@@perl(3) manpage.
1252 1311
1253=item B<< selection.pattern-I<idx> >>: I<perl-regex> 1312=item B<< selection.pattern-I<idx> >>: I<perl-regex>
1502White. 1561White.
1503 1562
1504=head2 ALPHA CHANNEL SUPPORT 1563=head2 ALPHA CHANNEL SUPPORT
1505 1564
1506If Xft support has been compiled in and as long as Xft/Xrender/X don't get 1565If Xft support has been compiled in and as long as Xft/Xrender/X don't get
1507their act together, rxvt-unicode will do it's own alpha channel management: 1566their act together, rxvt-unicode will do its own alpha channel management:
1508 1567
1509You can prefix any colour with an opaqueness percentage enclosed in 1568You can prefix any colour with an opaqueness percentage enclosed in
1510brackets, i.e. C<[percent]>, where C<percent> is a decimal percentage 1569brackets, i.e. C<[percent]>, where C<percent> is a decimal percentage
1511(0-100) that specifies the opacity of the colour, where C<0> is completely 1570(0-100) that specifies the opacity of the colour, where C<0> is completely
1512transparent and C<100> is completely opaque. For example, C<[50]red> is a 1571transparent and C<100> is completely opaque. For example, C<[50]red> is a
1599=item B<RXVT_SOCKET> 1658=item B<RXVT_SOCKET>
1600 1659
1601The unix domain socket path used by @@RXVT_NAME@@c(1) and 1660The unix domain socket path used by @@RXVT_NAME@@c(1) and
1602@@RXVT_NAME@@d(1). 1661@@RXVT_NAME@@d(1).
1603 1662
1604Default F<<< $HOME/.rxvt-unicode-I<< <nodename> >> >>>. 1663Default F<<< $HOME/.urxvt/urxvtd-I<< <nodename> >> >>>.
1605 1664
1606=item B<HOME> 1665=item B<HOME>
1607 1666
1608Used to locate the default directory for the unix domain socket for 1667Used to locate the default directory for the unix domain socket for
1609daemon communications and to locate various resource files (such as 1668daemon communications and to locate various resource files (such as

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines