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.192 by sf-exg, Sat Dec 18 12:20:18 2010 UTC vs.
Revision 1.202 by sf-exg, Thu Aug 11 08:37:17 2011 UTC

558You can set and change the resources using X11 tools like B<xrdb>. Many 558You can set and change the resources using X11 tools like B<xrdb>. Many
559distribution do also load settings from the B<~/.Xresources> file when X 559distribution do also load settings from the B<~/.Xresources> file when X
560starts. @@RXVT_NAME@@ will consult the following files/resources in order, 560starts. @@RXVT_NAME@@ will consult the following files/resources in order,
561with later settings overwriting earlier ones: 561with later settings overwriting earlier ones:
562 562
563 1. system-wide app-defaults file, either locale-dependent OR global
564 2. app-defaults file in $XAPPLRESDIR 563 1. app-defaults file in $XAPPLRESDIR
564 2. $HOME/.Xdefaults
565 3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults 565 3. RESOURCE_MANAGER property on root-window of screen 0
566 4. SCREEN_RESOURCES for the current screen 566 4. SCREEN_RESOURCES property on root-window of the current screen
567 5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename> 567 5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename>
568 6. resources specified via -xrm on the commandline 568 6. resources specified via -xrm on the commandline
569 569
570Note that when reading X resources, B<@@RXVT_NAME@@> recognizes two class 570Note that when reading X resources, B<@@RXVT_NAME@@> recognizes two class
571names: B<Rxvt> and B<URxvt>. The class name B<Rxvt> allows resources 571names: B<Rxvt> and B<URxvt>. The class name B<Rxvt> allows resources
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 its scaling with a geometry string B<WxH+X+Y>,
752(default C<100x100+50+50>) in which B<"W" / "H"> specify the 752(default C<100x100+50+50>) in which B<"W" / "H"> specify the
753horizontal/vertical scale (percent), and B<"X" / "Y"> locate the image 753horizontal/vertical scale (percent), and B<"X" / "Y"> locate the image
754centre (percent). A scale of 0 displays the image with tiling. 754centre (percent). A scale of 0 disables scaling.
755The maximum permitted scale is 1000. 755The maximum permitted scale is 1000.
756Additional operations can be specified after colon B<:op1:op2...>. 756Additional operations can be specified after colon B<:op1:op2...>.
757Supported operations are: 757Supported operations are:
758 758
759 tile force background image to be tiled and not scaled. Equivalent to 0x0 759 op=tile enables tiling
760 propscale will scale image keeping proportions 760 op=pscale enables proportional scaling
761 auto will scale image to match window size. Equivalent to 100x100 761 op=root use the position of the terminal window relative to the root
762 hscale will scale image horizontally to the window size 762 window as the image offset, simulating a root window background
763 vscale will scale image vertically to the window size 763
764 scale will scale image to match window size 764Alternatively, a predefined set of templates can be used to achieve
765 root will tile image as if it was a root window background, auto-adjusting 765the most common setups:
766 whenever terminal window moves 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.
903=item B<scrollstyle:> I<mode> 920=item B<scrollstyle:> I<mode>
904 921
905Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is 922Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is
906the author's favourite. 923the author's favourite.
907 924
925=item B<thickness:> I<number>
926
927Set the scrollbar width in pixels.
928
908=item B<scrollBar:> I<boolean> 929=item B<scrollBar:> I<boolean>
909 930
910B<True>: enable the scrollbar [default]; option B<-sb>. B<False>: 931B<True>: enable the scrollbar [default]; option B<-sb>. B<False>:
911disable the scrollbar; option B<+sb>. 932disable the scrollbar; option B<+sb>.
912 933
931B<False>: do not scroll to bottom when tty receives output; option 952B<False>: do not scroll to bottom when tty receives output; option
932B<+si>. 953B<+si>.
933 954
934=item B<scrollWithBuffer:> I<boolean> 955=item B<scrollWithBuffer:> I<boolean>
935 956
936B<True>: scroll with scrollback buffer when tty receives new lines (and 957B<True>: scroll with scrollback buffer when tty receives new lines (i.e.
937B<scrollTtyOutput> is False); option B<-sw>. B<False>: do not scroll 958try to show the same lines) and B<scrollTtyOutput> is False; option
938with scrollback buffer when tty receives new lines; option B<+sw>. 959B<-sw>. B<False>: do not scroll with scrollback buffer when tty receives
960new lines; option B<+sw>.
939 961
940=item B<scrollTtyKeypress:> I<boolean> 962=item B<scrollTtyKeypress:> I<boolean>
941 963
942B<True>: scroll to bottom when a non-special key is pressed. Special keys 964B<True>: scroll to bottom when a non-special key is pressed. Special keys
943are those which are intercepted by rxvt-unicode for special handling and 965are those which are intercepted by rxvt-unicode for special handling and
1163with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimiter `/' 1185with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimiter `/'
1164should be a character not used by the strings. 1186should be a character not used by the strings.
1165 1187
1166Its usage can be demonstrated by an example: 1188Its usage can be demonstrated by an example:
1167 1189
1168 URxvt.keysym.M-C-0x61: list|\033<M-C-|abc|> 1190 URxvt.keysym.M-C-0x61: list|\033<|abc|>
1169 1191
1170The above line is equivalent to the following three lines: 1192The above line is equivalent to the following three lines:
1171 1193
1172 URxvt.keysym.Meta-Control-0x61: \033<M-C-a> 1194 URxvt.keysym.Meta-Control-0x61: \033<a>
1173 URxvt.keysym.Meta-Control-0x62: \033<M-C-b> 1195 URxvt.keysym.Meta-Control-0x62: \033<b>
1174 URxvt.keysym.Meta-Control-0x63: \033<M-C-c> 1196 URxvt.keysym.Meta-Control-0x63: \033<c>
1175 1197
1176If 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>
1177is interpreted and executed as @@RXVT_NAME@@'s control sequence. For 1199is interpreted and executed as @@RXVT_NAME@@'s control sequence. For
1178example 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>
1179when Control-Meta-c is being pressed": 1201when Control-Meta-c is being pressed":

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines