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.188 by sf-exg, Thu Nov 4 12:13:20 2010 UTC vs.
Revision 1.202 by sf-exg, Thu Aug 11 08:37:17 2011 UTC

… …
147Tint the transparent background with the given colour; 147Tint the transparent background with the given colour;
148resource I<tintColor>. 148resource I<tintColor>.
149 149
150=item B<-sh> I<number> 150=item B<-sh> I<number>
151 151
152Darken (0 .. 100) or lighten (100 .. 200) the transparent background; 152Darken (0 .. 99) or lighten (101 .. 200) the transparent background.
153resource I<shading>. 153A value of 100 means no shading; resource I<shading>.
154 154
155=item B<-blt> I<string> 155=item B<-blt> I<string>
156 156
157Specify background blending type. If background pixmap is specified 157Specify background blending type. If background pixmap is specified
158at the same time as transparency - such pixmap will be blended over 158at the same time as transparency - such pixmap will be blended over
… …
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
… …
705Fade to this colour, when fading is used (see B<fading:>). The default 705Fade to this colour, when fading is used (see B<fading:>). The default
706colour is black; option B<-fadecolor>. 706colour is black; option B<-fadecolor>.
707 707
708=item B<tintColor:> I<colour> 708=item B<tintColor:> I<colour>
709 709
710Tint the transparent background with the given colour; option 710Tint the transparent background with the given colour. If the RENDER
711B<-tint>. 711extension is not available only black, red, green, yellow, blue,
712magenta, cyan and white tints can be performed server-side. Note that
713a black tint yields a completely black image while a white tint yields
714the image unchanged; option B<-tint>.
712 715
713=item B<shading:> I<number> 716=item B<shading:> I<number>
714 717
715Darken (0 .. 100) or lighten (100 .. 200) the transparent background; 718Darken (0 .. 99) or lighten (101 .. 200) the transparent background.
716option B<-sh>. 719A value of 100 means no shading; option B<-sh>.
717 720
718=item B<blendType:> I<string> 721=item B<blendType:> I<string>
719 722
720Specify background blending type; option B<-blt>. 723Specify background blending type; option B<-blt>.
721 724
… …
746 749
747Use the specified image file for the background and also 750Use the specified image file for the background and also
748optionally specify its scaling with a geometry string B<WxH+X+Y>, 751optionally specify its scaling with a geometry string B<WxH+X+Y>,
749(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
750horizontal/vertical scale (percent), and B<"X" / "Y"> locate the image 753horizontal/vertical scale (percent), and B<"X" / "Y"> locate the image
751centre (percent). A scale of 0 displays the image with tiling. 754centre (percent). A scale of 0 disables scaling.
752The maximum permitted scale is 1000. 755The maximum permitted scale is 1000.
753Additional operations can be specified after colon B<:op1:op2...>. 756Additional operations can be specified after colon B<:op1:op2...>.
754Supported operations are: 757Supported operations are:
755 758
756 tile force background image to be tiled and not scaled. Equivalent to 0x0 759 op=tile enables tiling
757 propscale will scale image keeping proportions 760 op=pscale enables proportional scaling
758 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
759 hscale will scale image horizontally to the window size 762 window as the image offset, simulating a root window background
760 vscale will scale image vertically to the window size 763
761 scale will scale image to match window size 764Alternatively, a predefined set of templates can be used to achieve
762 root will tile image as if it was a root window background, auto-adjusting 765the most common setups:
763 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
764 784
765If 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
766blended over the transparent background using alpha-blending. If I<afterimage> 786blended over the transparent background using alpha-blending. If I<afterimage>
767support has been compiled in it is possible to choose other blending 787support has been compiled in it is possible to choose other blending
768types with B<-blt "type"> option. 788types with B<-blt "type"> option.
… …
900=item B<scrollstyle:> I<mode> 920=item B<scrollstyle:> I<mode>
901 921
902Set 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
903the author's favourite. 923the author's favourite.
904 924
925=item B<thickness:> I<number>
926
927Set the scrollbar width in pixels.
928
905=item B<scrollBar:> I<boolean> 929=item B<scrollBar:> I<boolean>
906 930
907B<True>: enable the scrollbar [default]; option B<-sb>. B<False>: 931B<True>: enable the scrollbar [default]; option B<-sb>. B<False>:
908disable the scrollbar; option B<+sb>. 932disable the scrollbar; option B<+sb>.
909 933
… …
928B<False>: do not scroll to bottom when tty receives output; option 952B<False>: do not scroll to bottom when tty receives output; option
929B<+si>. 953B<+si>.
930 954
931=item B<scrollWithBuffer:> I<boolean> 955=item B<scrollWithBuffer:> I<boolean>
932 956
933B<True>: scroll with scrollback buffer when tty receives new lines (and 957B<True>: scroll with scrollback buffer when tty receives new lines (i.e.
934B<scrollTtyOutput> is False); option B<-sw>. B<False>: do not scroll 958try to show the same lines) and B<scrollTtyOutput> is False; option
935with 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>.
936 961
937=item B<scrollTtyKeypress:> I<boolean> 962=item B<scrollTtyKeypress:> I<boolean>
938 963
939B<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
940are those which are intercepted by rxvt-unicode for special handling and 965are those which are intercepted by rxvt-unicode for special handling and
… …
1160with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimiter `/' 1185with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimiter `/'
1161should be a character not used by the strings. 1186should be a character not used by the strings.
1162 1187
1163Its usage can be demonstrated by an example: 1188Its usage can be demonstrated by an example:
1164 1189
1165 URxvt.keysym.M-C-0x61: list|\033<M-C-|abc|> 1190 URxvt.keysym.M-C-0x61: list|\033<|abc|>
1166 1191
1167The above line is equivalent to the following three lines: 1192The above line is equivalent to the following three lines:
1168 1193
1169 URxvt.keysym.Meta-Control-0x61: \033<M-C-a> 1194 URxvt.keysym.Meta-Control-0x61: \033<a>
1170 URxvt.keysym.Meta-Control-0x62: \033<M-C-b> 1195 URxvt.keysym.Meta-Control-0x62: \033<b>
1171 URxvt.keysym.Meta-Control-0x63: \033<M-C-c> 1196 URxvt.keysym.Meta-Control-0x63: \033<c>
1172 1197
1173If 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>
1174is interpreted and executed as @@RXVT_NAME@@'s control sequence. For 1199is interpreted and executed as @@RXVT_NAME@@'s control sequence. For
1175example 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>
1176when Control-Meta-c is being pressed": 1201when Control-Meta-c is being pressed":
… …
1606=item B<RXVT_SOCKET> 1631=item B<RXVT_SOCKET>
1607 1632
1608The unix domain socket path used by @@RXVT_NAME@@c(1) and 1633The unix domain socket path used by @@RXVT_NAME@@c(1) and
1609@@RXVT_NAME@@d(1). 1634@@RXVT_NAME@@d(1).
1610 1635
1611Default F<<< $HOME/.rxvt-unicode-I<< <nodename >> >>>. 1636Default F<<< $HOME/.rxvt-unicode-I<< <nodename> >> >>>.
1612 1637
1613=item B<HOME> 1638=item B<HOME>
1614 1639
1615Used to locate the default directory for the unix domain socket for 1640Used to locate the default directory for the unix domain socket for
1616daemon communications and to locate various resource files (such as 1641daemon communications and to locate various resource files (such as
1617C<.Xdefaults>) 1642C<.Xdefaults>)
1618 1643
1619=item B<XAPPLRESDIR> 1644=item B<XAPPLRESDIR>
1620 1645
1621Directory where various X resource files are being located. 1646Directory where application-specific X resource files are located.
1622 1647
1623=item B<XENVIRONMENT> 1648=item B<XENVIRONMENT>
1624 1649
1625If set and accessible, gives the name of a X resource file to be loaded by 1650If set and accessible, gives the name of a X resource file to be loaded by
1626@@RXVT_NAME@@. 1651@@RXVT_NAME@@.
… …
1692 1717
1693Project Coordinator (Changes 1.0 -) 1718Project Coordinator (Changes 1.0 -)
1694 1719
1695=item Emanuele Giaquinta L<< <e.giaquinta@glauco.it> >> 1720=item Emanuele Giaquinta L<< <e.giaquinta@glauco.it> >>
1696 1721
1697Pty/tty/utmp/wtmp rewrite, lots of random hacking and bugfixing. 1722pty/utmp code rewrite, image code improvements, many random hacks and bugfixes.
1698 1723
1699=back 1724=back
1700 1725

Diff Legend

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