… | |
… | |
163 | alpha-blending. Compile I<afterimage>; resource I<blendType>. |
163 | alpha-blending. Compile I<afterimage>; resource I<blendType>. |
164 | |
164 | |
165 | =item B<-blr> I<HxV> |
165 | =item B<-blr> I<HxV> |
166 | |
166 | |
167 | Apply Gaussian Blur with the specified radii to the transparent |
167 | Apply Gaussian Blur with the specified radii to the transparent |
168 | background. If a single number is specified - both vertical and |
168 | background. If a single number is specified, the vertical and |
169 | horizontal radii are considered to be the same. Setting one of the |
169 | horizontal radii are considered to be the same. Setting one of the |
170 | radii to 1 and another to a large number creates interesting effects |
170 | radii to 1 and the other to a large number creates interesting effects |
171 | on some backgrounds. Maximum radius value is 128; |
171 | on some backgrounds. The maximum radius value is 128. An horizontal or |
|
|
172 | vertical radius of 0 disables blurring; |
172 | resource I<blurRadius>. |
173 | resource I<blurRadius>. |
173 | |
174 | |
174 | =item B<-icon> I<file> |
175 | =item B<-icon> I<file> |
175 | |
176 | |
176 | Compile I<afterimage> or I<pixbuf>: Use the specified image as application icon. This |
177 | Compile 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 | |
186 | Window foreground colour; resource B<foreground>. |
187 | Window 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 | |
190 | Compile I<afterimage> or I<pixbuf>: Specify image file for the background and also |
191 | Compile I<afterimage> or I<pixbuf>: Specify image file for the background and also |
191 | optionally specify its scaling with a geometry string. Note you may need to |
192 | optionally specify a list of operations to modify it. Note you may need to |
192 | add quotes to avoid special shell interpretation of the C<;> in the |
193 | add quotes to avoid special shell interpretation of the C<;> in the |
193 | command-line; for more details see resource B<backgroundPixmap>. |
194 | command-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 | |
745 | The colour of the border around the text area and between the scrollbar |
746 | The colour of the border around the text area and between the scrollbar |
746 | and the text. |
747 | and the text. |
747 | |
748 | |
748 | =item B<backgroundPixmap:> I<file[;geom[:op1][:op2][...]]> |
749 | =item B<backgroundPixmap:> I<file[;oplist]> |
749 | |
750 | |
750 | Use the specified image file for the background and also |
751 | Use the specified image file for the background and also |
751 | optionally specify its scaling with a geometry string B<WxH+X+Y>, |
752 | optionally specify a colon separated list of operations to modify it. |
752 | (default C<100x100+50+50>) in which B<"W" / "H"> specify the |
|
|
753 | horizontal/vertical scale (percent), and B<"X" / "Y"> locate the image |
|
|
754 | centre (percent). A scale of 0 displays the image with tiling. |
|
|
755 | The maximum permitted scale is 1000. |
|
|
756 | Additional operations can be specified after colon B<:op1:op2...>. |
|
|
757 | Supported operations are: |
753 | Supported 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 |
759 | sets scale and position. B<"W" / "H"> specify the horizontal/vertical |
764 | scale will scale image to match window size |
760 | scale (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 |
761 | scale of 0 disables scaling. The maximum permitted scale is 1000. |
766 | whenever terminal window moves |
762 | |
|
|
763 | =item B<op=tile> |
|
|
764 | |
|
|
765 | enables tiling |
|
|
766 | |
|
|
767 | =item B<op=keep-aspect> |
|
|
768 | |
|
|
769 | maintain the image aspect ratio when scaling |
|
|
770 | |
|
|
771 | =item B<op=root-align> |
|
|
772 | |
|
|
773 | use the position of the terminal window relative to the root window as |
|
|
774 | the image offset, simulating a root window background |
|
|
775 | |
|
|
776 | =back |
|
|
777 | |
|
|
778 | The default scale and position setting is C<100x100+50+50>. |
|
|
779 | Alternatively, a predefined set of templates can be used to achieve |
|
|
780 | the most common setups: |
|
|
781 | |
|
|
782 | =over 4 |
|
|
783 | |
|
|
784 | =item B<style=tiled> |
|
|
785 | |
|
|
786 | the image is tiled with no scaling. Equivalent to 0x0+0+0:op=tile |
|
|
787 | |
|
|
788 | =item B<style=aspect-stretched> |
|
|
789 | |
|
|
790 | the image is scaled to fill the whole window maintaining the aspect |
|
|
791 | ratio and centered. Equivalent to 100x100+50+50:op=keep-aspect |
|
|
792 | |
|
|
793 | =item B<style=stretched> |
|
|
794 | |
|
|
795 | the image is scaled to fill the whole window. Equivalent to 100x100 |
|
|
796 | |
|
|
797 | =item B<style=centered> |
|
|
798 | |
|
|
799 | the image is centered with no scaling. Equivalent to 0x0+50+50 |
|
|
800 | |
|
|
801 | =item B<style=root-tiled> |
|
|
802 | |
|
|
803 | the image is tiled with no scaling and using 'root' positioning. |
|
|
804 | Equivalent to 0x0:op=tile:op=root-align |
|
|
805 | |
|
|
806 | =back |
|
|
807 | |
|
|
808 | If multiple templates are specified the last one wins. Note that a |
|
|
809 | template overrides all the scale, position and operations settings. |
767 | |
810 | |
768 | If used in conjunction with B<-tr> option, the specified pixmap will be |
811 | If used in conjunction with B<-tr> option, the specified pixmap will be |
769 | blended over the transparent background using alpha-blending. If I<afterimage> |
812 | blended over the transparent background using alpha-blending. If I<afterimage> |
770 | support has been compiled in it is possible to choose other blending |
813 | support has been compiled in it is possible to choose other blending |
771 | types with B<-blt "type"> option. |
814 | types with B<-blt "type"> option. |
… | |
… | |
903 | =item B<scrollstyle:> I<mode> |
946 | =item B<scrollstyle:> I<mode> |
904 | |
947 | |
905 | Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is |
948 | Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is |
906 | the author's favourite. |
949 | the author's favourite. |
907 | |
950 | |
|
|
951 | =item B<thickness:> I<number> |
|
|
952 | |
|
|
953 | Set the scrollbar width in pixels. |
|
|
954 | |
908 | =item B<scrollBar:> I<boolean> |
955 | =item B<scrollBar:> I<boolean> |
909 | |
956 | |
910 | B<True>: enable the scrollbar [default]; option B<-sb>. B<False>: |
957 | B<True>: enable the scrollbar [default]; option B<-sb>. B<False>: |
911 | disable the scrollbar; option B<+sb>. |
958 | disable the scrollbar; option B<+sb>. |
912 | |
959 | |
… | |
… | |
931 | B<False>: do not scroll to bottom when tty receives output; option |
978 | B<False>: do not scroll to bottom when tty receives output; option |
932 | B<+si>. |
979 | B<+si>. |
933 | |
980 | |
934 | =item B<scrollWithBuffer:> I<boolean> |
981 | =item B<scrollWithBuffer:> I<boolean> |
935 | |
982 | |
936 | B<True>: scroll with scrollback buffer when tty receives new lines (and |
983 | B<True>: scroll with scrollback buffer when tty receives new lines (i.e. |
937 | B<scrollTtyOutput> is False); option B<-sw>. B<False>: do not scroll |
984 | try to show the same lines) and B<scrollTtyOutput> is False; option |
938 | with scrollback buffer when tty receives new lines; option B<+sw>. |
985 | B<-sw>. B<False>: do not scroll with scrollback buffer when tty receives |
|
|
986 | new lines; option B<+sw>. |
939 | |
987 | |
940 | =item B<scrollTtyKeypress:> I<boolean> |
988 | =item B<scrollTtyKeypress:> I<boolean> |
941 | |
989 | |
942 | B<True>: scroll to bottom when a non-special key is pressed. Special keys |
990 | B<True>: scroll to bottom when a non-special key is pressed. Special keys |
943 | are those which are intercepted by rxvt-unicode for special handling and |
991 | are those which are intercepted by rxvt-unicode for special handling and |
… | |
… | |
1157 | performed in an exact manner; however, the closest match is assured. |
1205 | performed in an exact manner; however, the closest match is assured. |
1158 | |
1206 | |
1159 | I<string> may contain escape values (C<\n>: newline, C<\000>: octal |
1207 | I<string> may contain escape values (C<\n>: newline, C<\000>: octal |
1160 | number), see RESOURCES in C<man 7 X> for further details. |
1208 | number), see RESOURCES in C<man 7 X> for further details. |
1161 | |
1209 | |
1162 | You can define a range of keysyms in one shot by providing a I<string> |
1210 | You can define a range of keysyms in one shot by |
|
|
1211 | loading the C<keysym-list> perl extension and providing a I<string> |
1163 | with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimiter `/' |
1212 | with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimiter `/' |
1164 | should be a character not used by the strings. |
1213 | should be a character not used by the strings. |
1165 | |
1214 | |
1166 | Its usage can be demonstrated by an example: |
1215 | Its usage can be demonstrated by an example: |
1167 | |
1216 | |
1168 | URxvt.keysym.M-C-0x61: list|\033<M-C-|abc|> |
1217 | URxvt.keysym.M-C-0x61: list|\033<|abc|> |
1169 | |
1218 | |
1170 | The above line is equivalent to the following three lines: |
1219 | The above line is equivalent to the following three lines: |
1171 | |
1220 | |
1172 | URxvt.keysym.Meta-Control-0x61: \033<M-C-a> |
1221 | URxvt.keysym.Meta-Control-0x61: \033<a> |
1173 | URxvt.keysym.Meta-Control-0x62: \033<M-C-b> |
1222 | URxvt.keysym.Meta-Control-0x62: \033<b> |
1174 | URxvt.keysym.Meta-Control-0x63: \033<M-C-c> |
1223 | URxvt.keysym.Meta-Control-0x63: \033<c> |
1175 | |
1224 | |
1176 | If I<string> takes the form of C<command:STRING>, the specified B<STRING> |
1225 | If I<string> takes the form of C<command:STRING>, the specified B<STRING> |
1177 | is interpreted and executed as @@RXVT_NAME@@'s control sequence. For |
1226 | is interpreted and executed as @@RXVT_NAME@@'s control sequence. For |
1178 | example the following means "change the current locale to C<zh_CN.GBK> |
1227 | example the following means "change the current locale to C<zh_CN.GBK> |
1179 | when Control-Meta-c is being pressed": |
1228 | when Control-Meta-c is being pressed": |
… | |
… | |
1252 | the @@RXVT_NAME@@perl(3) manpage. |
1301 | the @@RXVT_NAME@@perl(3) manpage. |
1253 | |
1302 | |
1254 | =item B<perl-lib>: I<path> |
1303 | =item B<perl-lib>: I<path> |
1255 | |
1304 | |
1256 | Colon-separated list of additional directories that hold extension |
1305 | Colon-separated list of additional directories that hold extension |
1257 | scripts. When looking for extensions specified by the C<perl> resource, |
1306 | scripts. When looking for perl extensions, @@RXVT_NAME@@ will first |
1258 | @@RXVT_NAME@@ will first look in these directories and then in |
1307 | look in these directories, then in $HOME/.urxvt/ext and lastly in |
1259 | F<@@RXVT_LIBDIR@@/urxvt/perl/>. |
1308 | F<@@RXVT_LIBDIR@@/urxvt/perl/>. |
1260 | |
1309 | |
1261 | See the @@RXVT_NAME@@perl(3) manpage. |
1310 | See the @@RXVT_NAME@@perl(3) manpage. |
1262 | |
1311 | |
1263 | =item B<< selection.pattern-I<idx> >>: I<perl-regex> |
1312 | =item B<< selection.pattern-I<idx> >>: I<perl-regex> |
… | |
… | |
1512 | White. |
1561 | White. |
1513 | |
1562 | |
1514 | =head2 ALPHA CHANNEL SUPPORT |
1563 | =head2 ALPHA CHANNEL SUPPORT |
1515 | |
1564 | |
1516 | If Xft support has been compiled in and as long as Xft/Xrender/X don't get |
1565 | If Xft support has been compiled in and as long as Xft/Xrender/X don't get |
1517 | their act together, rxvt-unicode will do it's own alpha channel management: |
1566 | their act together, rxvt-unicode will do its own alpha channel management: |
1518 | |
1567 | |
1519 | You can prefix any colour with an opaqueness percentage enclosed in |
1568 | You can prefix any colour with an opaqueness percentage enclosed in |
1520 | brackets, i.e. C<[percent]>, where C<percent> is a decimal percentage |
1569 | brackets, 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 |
1570 | (0-100) that specifies the opacity of the colour, where C<0> is completely |
1522 | transparent and C<100> is completely opaque. For example, C<[50]red> is a |
1571 | transparent and C<100> is completely opaque. For example, C<[50]red> is a |
… | |
… | |
1609 | =item B<RXVT_SOCKET> |
1658 | =item B<RXVT_SOCKET> |
1610 | |
1659 | |
1611 | The unix domain socket path used by @@RXVT_NAME@@c(1) and |
1660 | The unix domain socket path used by @@RXVT_NAME@@c(1) and |
1612 | @@RXVT_NAME@@d(1). |
1661 | @@RXVT_NAME@@d(1). |
1613 | |
1662 | |
1614 | Default F<<< $HOME/.rxvt-unicode-I<< <nodename> >> >>>. |
1663 | Default F<<< $HOME/.urxvt/urxvtd-I<< <nodename> >> >>>. |
1615 | |
1664 | |
1616 | =item B<HOME> |
1665 | =item B<HOME> |
1617 | |
1666 | |
1618 | Used to locate the default directory for the unix domain socket for |
1667 | Used to locate the default directory for the unix domain socket for |
1619 | daemon communications and to locate various resource files (such as |
1668 | daemon communications and to locate various resource files (such as |