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.196 by root, Fri May 6 10:18:00 2011 UTC vs.
Revision 1.203 by sf-exg, Sat Aug 13 09:05:43 2011 UTC

… …
183 183
184=item B<-fg> I<colour> 184=item B<-fg> I<colour>
185 185
186Window foreground colour; resource B<foreground>. 186Window foreground colour; resource B<foreground>.
187 187
188=item B<-pixmap> I<file[;geom[:op1][:op2][...]]> 188=item B<-pixmap> I<file[;oplist]>
189 189
190Compile I<afterimage> or I<pixbuf>: Specify image file for the background and also 190Compile 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 191optionally 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 192add quotes to avoid special shell interpretation of the C<;> in the
193command-line; for more details see resource B<backgroundPixmap>. 193command-line; for more details see resource B<backgroundPixmap>.
194 194
195=item B<-cr> I<colour> 195=item B<-cr> I<colour>
196 196
… …
743=item B<borderColor:> I<colour> 743=item B<borderColor:> I<colour>
744 744
745The colour of the border around the text area and between the scrollbar 745The colour of the border around the text area and between the scrollbar
746and the text. 746and the text.
747 747
748=item B<backgroundPixmap:> I<file[;geom[:op1][:op2][...]]> 748=item B<backgroundPixmap:> I<file[;oplist]>
749 749
750Use the specified image file for the background and also 750Use the specified image file for the background and also
751optionally specify its scaling with a geometry string B<WxH+X+Y>, 751optionally 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: 752Supported operations are:
758 753
759 tile force background image to be tiled and not scaled. Equivalent to 0x0 754 B<WxH+X+Y> sets scale and position. B<"W" / "H"> specify the
760 propscale will scale image keeping proportions 755 horizontal/vertical scale (percent), and B<"X" / "Y">
761 auto will scale image to match window size. Equivalent to 100x100 756 locate the image centre (percent). A scale of 0 disables
762 hscale will scale image horizontally to the window size 757 scaling. The maximum permitted scale is 1000.
763 vscale will scale image vertically to the window size 758 op=tile enables tiling
764 scale will scale image to match window size 759 op=pscale enables proportional scaling
765 root will tile image as if it was a root window background, auto-adjusting 760 op=root use the position of the terminal window relative to the root
766 whenever terminal window moves 761 window as the image offset, simulating a root window background
762
763The default scale and position setting is C<100x100+50+50>.
764Alternatively, a predefined set of templates can be used to achieve
765the most common setups:
766
767 style=tiled the image is tiled with no scaling
768 style=aspect-stretched the image is scaled to fill the whole window maintaining
769 the aspect ratio and centered
770 style=stretched the image is scaled to fill the whole window
771 style=centered the image is centered with no scaling
772 style=root-tiled the image is tiled with no scaling and using 'op=root' positioning
773
774If multiple templates are specified the last one wins. Note that a
775template overrides all the scale, position and operations settings.
776Indeed, the templates can be specified in terms of low level settings
777as follows:
778
779 style=tiled 0x0+0+0:op=tile
780 style=aspect-stretched +50+50:op=pscale
781 style=stretched 100x100
782 style=centered 0x0+50+50
783 style=root-tiled 0x0:op=tile:op=root
767 784
768If used in conjunction with B<-tr> option, the specified pixmap will be 785If used in conjunction with B<-tr> option, the specified pixmap will be
769blended over the transparent background using alpha-blending. If I<afterimage> 786blended over the transparent background using alpha-blending. If I<afterimage>
770support has been compiled in it is possible to choose other blending 787support has been compiled in it is possible to choose other blending
771types with B<-blt "type"> option. 788types with B<-blt "type"> option.
… …
1161keysym value (B<0x0000 - 0xFFFF>). Note that the lookup of I<sym>s is not 1178keysym value (B<0x0000 - 0xFFFF>). Note that the lookup of I<sym>s is not
1162performed in an exact manner; however, the closest match is assured. 1179performed in an exact manner; however, the closest match is assured.
1163 1180
1164I<string> may contain escape values (C<\n>: newline, C<\000>: octal 1181I<string> may contain escape values (C<\n>: newline, C<\000>: octal
1165number), see RESOURCES in C<man 7 X> for further details. 1182number), see RESOURCES in C<man 7 X> for further details.
1183
1184You can define a range of keysyms in one shot by providing a I<string>
1185with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimiter `/'
1186should be a character not used by the strings.
1187
1188Its usage can be demonstrated by an example:
1189
1190 URxvt.keysym.M-C-0x61: list|\033<|abc|>
1191
1192The above line is equivalent to the following three lines:
1193
1194 URxvt.keysym.Meta-Control-0x61: \033<a>
1195 URxvt.keysym.Meta-Control-0x62: \033<b>
1196 URxvt.keysym.Meta-Control-0x63: \033<c>
1166 1197
1167If I<string> takes the form of C<command:STRING>, the specified B<STRING> 1198If I<string> takes the form of C<command:STRING>, the specified B<STRING>
1168is interpreted and executed as @@RXVT_NAME@@'s control sequence. For 1199is interpreted and executed as @@RXVT_NAME@@'s control sequence. For
1169example the following means "change the current locale to C<zh_CN.GBK> 1200example the following means "change the current locale to C<zh_CN.GBK>
1170when Control-Meta-c is being pressed": 1201when Control-Meta-c is being pressed":

Diff Legend

– Removed lines
+ Added lines
< Changed lines
> Changed lines