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.205 by sf-exg, Fri Nov 18 02:15:22 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=over 4
760 propscale will scale image keeping proportions 755
761 auto will scale image to match window size. Equivalent to 100x100 756=item B<WxH+X+Y>
762 hscale will scale image horizontally to the window size 757
763 vscale will scale image vertically to the window size 758sets scale and position. B<"W" / "H"> specify the horizontal/vertical
764 scale will scale image to match window size 759scale (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 760scale of 0 disables scaling. The maximum permitted scale is 1000.
766 whenever terminal window moves 761
762=item B<op=tile>
763
764enables tiling
765
766=item B<op=pscale>
767
768enables proportional scaling
769
770=item B<op=root>
771
772use the position of the terminal window relative to the root window as
773the image offset, simulating a root window background
774
775=back
776
777The default scale and position setting is C<100x100+50+50>.
778Alternatively, a predefined set of templates can be used to achieve
779the most common setups:
780
781=over 4
782
783=item B<style=tiled>
784
785the image is tiled with no scaling. Equivalent to 0x0+0+0:op=tile
786
787=item B<style=aspect-stretched>
788
789the image is scaled to fill the whole window maintaining the aspect
790ratio and centered. Equivalent to 100x100+50+50:op=pscale
791
792=item B<style=stretched>
793
794the image is scaled to fill the whole window. Equivalent to 100x100
795
796=item B<style=centered>
797
798the image is centered with no scaling. Equivalent to 0x0+50+50
799
800=item B<style=root-tiled>
801
802the image is tiled with no scaling and using 'root' positioning.
803Equivalent to 0x0:op=tile:op=root
804
805=back
806
807If multiple templates are specified the last one wins. Note that a
808template overrides all the scale, position and operations settings.
767 809
768If used in conjunction with B<-tr> option, the specified pixmap will be 810If used in conjunction with B<-tr> option, the specified pixmap will be
769blended over the transparent background using alpha-blending. If I<afterimage> 811blended over the transparent background using alpha-blending. If I<afterimage>
770support has been compiled in it is possible to choose other blending 812support has been compiled in it is possible to choose other blending
771types with B<-blt "type"> option. 813types with B<-blt "type"> option.
… …
935B<False>: do not scroll to bottom when tty receives output; option 977B<False>: do not scroll to bottom when tty receives output; option
936B<+si>. 978B<+si>.
937 979
938=item B<scrollWithBuffer:> I<boolean> 980=item B<scrollWithBuffer:> I<boolean>
939 981
940B<True>: scroll with scrollback buffer when tty receives new lines (and 982B<True>: scroll with scrollback buffer when tty receives new lines (i.e.
941B<scrollTtyOutput> is False); option B<-sw>. B<False>: do not scroll 983try to show the same lines) and B<scrollTtyOutput> is False; option
942with scrollback buffer when tty receives new lines; option B<+sw>. 984B<-sw>. B<False>: do not scroll with scrollback buffer when tty receives
985new lines; option B<+sw>.
943 986
944=item B<scrollTtyKeypress:> I<boolean> 987=item B<scrollTtyKeypress:> I<boolean>
945 988
946B<True>: scroll to bottom when a non-special key is pressed. Special keys 989B<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 990are those which are intercepted by rxvt-unicode for special handling and
… …
1160keysym value (B<0x0000 - 0xFFFF>). Note that the lookup of I<sym>s is not 1203keysym value (B<0x0000 - 0xFFFF>). Note that the lookup of I<sym>s is not
1161performed in an exact manner; however, the closest match is assured. 1204performed in an exact manner; however, the closest match is assured.
1162 1205
1163I<string> may contain escape values (C<\n>: newline, C<\000>: octal 1206I<string> may contain escape values (C<\n>: newline, C<\000>: octal
1164number), see RESOURCES in C<man 7 X> for further details. 1207number), see RESOURCES in C<man 7 X> for further details.
1208
1209You can define a range of keysyms in one shot by providing a I<string>
1210with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimiter `/'
1211should be a character not used by the strings.
1212
1213Its usage can be demonstrated by an example:
1214
1215 URxvt.keysym.M-C-0x61: list|\033<|abc|>
1216
1217The above line is equivalent to the following three lines:
1218
1219 URxvt.keysym.Meta-Control-0x61: \033<a>
1220 URxvt.keysym.Meta-Control-0x62: \033<b>
1221 URxvt.keysym.Meta-Control-0x63: \033<c>
1165 1222
1166If I<string> takes the form of C<command:STRING>, the specified B<STRING> 1223If I<string> takes the form of C<command:STRING>, the specified B<STRING>
1167is interpreted and executed as @@RXVT_NAME@@'s control sequence. For 1224is interpreted and executed as @@RXVT_NAME@@'s control sequence. For
1168example the following means "change the current locale to C<zh_CN.GBK> 1225example the following means "change the current locale to C<zh_CN.GBK>
1169when Control-Meta-c is being pressed": 1226when Control-Meta-c is being pressed":

Diff Legend

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