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.187 by sf-exg, Fri Oct 15 10:46:57 2010 UTC vs.
Revision 1.203 by sf-exg, Sat Aug 13 09:05:43 2011 UTC

… …
124 124
125Turn on/off skip scrolling (allow multiple screens per refresh); resource B<skipScroll>. 125Turn on/off skip scrolling (allow multiple screens per refresh); resource B<skipScroll>.
126 126
127=item B<-tr>|B<+tr> 127=item B<-tr>|B<+tr>
128 128
129Turn on/off illusion of a transparent window background; resource B<transparent>. 129Turn on/off pseudo-transparency by using the root pixmap as background; resource B<transparent>.
130 130
131B<-ip> is still accepted as an obsolete alias but will be removed in 131B<-ip> is still accepted as an obsolete alias but will be removed in
132future versions. 132future versions.
133 133
134=item B<-fade> I<number> 134=item B<-fade> I<number>
… …
142Fade to this colour when fading is used (see B<-fade>). The default colour 142Fade to this colour when fading is used (see B<-fade>). The default colour
143is opaque black. resource B<fadeColor>. 143is opaque black. resource B<fadeColor>.
144 144
145=item B<-tint> I<colour> 145=item B<-tint> I<colour>
146 146
147Tint the transparent background pixmap with the given colour when 147Tint the transparent background with the given colour;
148transparency is enabled with B<-tr>. This only works for 148resource I<tintColor>.
149non-tiled backgrounds, currently. See also the B<-sh> option that can be
150used to brighten or darken the image in addition to tinting it.
151Please note that certain tint colours can be applied on the server-side,
152thus yielding performance gain of two orders of magnitude. These colours are:
153blue, red, green, cyan, magenta, yellow, and those close to them. Also
154pure black and pure white colours essentially mean no tinting; resource
155I<tintColor>. Example:
156
157 @@RXVT_NAME@@ -tr -tint blue -sh 40
158 149
159=item B<-sh> I<number> 150=item B<-sh> I<number>
160 151
161Darken (0 .. 100) or lighten (100 .. 200) the transparent 152Darken (0 .. 99) or lighten (101 .. 200) the transparent background.
162background image in addition to (or instead of) tinting it; 153A value of 100 means no shading; resource I<shading>.
163resource I<shading>.
164 154
165=item B<-blt> I<string> 155=item B<-blt> I<string>
166 156
167Specify background blending type. If background pixmap is specified 157Specify background blending type. If background pixmap is specified
168at the same time as transparency - such pixmap will be blended over 158at the same time as transparency - such pixmap will be blended over
169transparency image, using method specified. Supported values are : 159the transparent background, using the method specified. Supported values are:
170B<add>, B<alphablend>, B<allanon> - colour values averaging, B<colorize>, 160B<add>, B<alphablend>, B<allanon> - colour values averaging, B<colorize>,
171B<darken>, B<diff>, B<dissipate>, B<hue>, B<lighten>, B<overlay>, 161B<darken>, B<diff>, B<dissipate>, B<hue>, B<lighten>, B<overlay>,
172B<saturate>, B<screen>, B<sub>, B<tint>, B<value>. The default is 162B<saturate>, B<screen>, B<sub>, B<tint>, B<value>. The default is
173alpha-blending. Compile I<afterimage>; resource I<blendType>. 163alpha-blending. Compile I<afterimage>; resource I<blendType>.
174 164
175=item B<-blr> I<HxV> 165=item B<-blr> I<HxV>
176 166
177Apply Gaussian Blur with the specified radii to the transparent 167Apply Gaussian Blur with the specified radii to the transparent
178background image. If single number is specified - both vertical and 168background. If a single number is specified - both vertical and
179horizontal radii are considered to be the same. Setting one of the 169horizontal radii are considered to be the same. Setting one of the
180radii to 1 and another to a large number creates interesting effects 170radii to 1 and another to a large number creates interesting effects
181on some backgrounds. Maximum radius value is 128. Compile I<afterimage> or I<xft>; 171on some backgrounds. Maximum radius value is 128;
182resource I<blurRadius>. 172resource I<blurRadius>.
183 173
184=item B<-icon> I<file> 174=item B<-icon> I<file>
185 175
186Compile I<afterimage> or I<pixbuf>: Use the specified image as application icon. This 176Compile I<afterimage> or I<pixbuf>: Use the specified image as application icon. This
… …
193 183
194=item B<-fg> I<colour> 184=item B<-fg> I<colour>
195 185
196Window foreground colour; resource B<foreground>. 186Window foreground colour; resource B<foreground>.
197 187
198=item B<-pixmap> I<file[;geom[:op1][:op2][...]]> 188=item B<-pixmap> I<file[;oplist]>
199 189
200Compile 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
201optionally 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
202add quotes to avoid special shell interpretation of the C<;> in the 192add quotes to avoid special shell interpretation of the C<;> in the
203command-line; for more details see resource B<backgroundPixmap>. 193command-line; for more details see resource B<backgroundPixmap>.
204 194
205=item B<-cr> I<colour> 195=item B<-cr> I<colour>
206 196
… …
568You 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
569distribution do also load settings from the B<~/.Xresources> file when X 559distribution do also load settings from the B<~/.Xresources> file when X
570starts. @@RXVT_NAME@@ will consult the following files/resources in order, 560starts. @@RXVT_NAME@@ will consult the following files/resources in order,
571with later settings overwriting earlier ones: 561with later settings overwriting earlier ones:
572 562
573 1. system-wide app-defaults file, either locale-dependent OR global
574 2. app-defaults file in $XAPPLRESDIR 563 1. app-defaults file in $XAPPLRESDIR
564 2. $HOME/.Xdefaults
575 3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults 565 3. RESOURCE_MANAGER property on root-window of screen 0
576 4. SCREEN_RESOURCES for the current screen 566 4. SCREEN_RESOURCES property on root-window of the current screen
577 5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename> 567 5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename>
578 6. resources specified via -xrm on the commandline 568 6. resources specified via -xrm on the commandline
579 569
580Note that when reading X resources, B<@@RXVT_NAME@@> recognizes two class 570Note that when reading X resources, B<@@RXVT_NAME@@> recognizes two class
581names: 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
… …
699if the refresh is too fast for the human eye to read anything (or the 689if the refresh is too fast for the human eye to read anything (or the
700monitor to display anything); option B<+ss>. 690monitor to display anything); option B<+ss>.
701 691
702=item B<transparent:> I<boolean> 692=item B<transparent:> I<boolean>
703 693
704Turn on/off illusion of a transparent window background. 694Turn on/off pseudo-transparency by using the root pixmap as background.
705 695
706B<inheritPixmap> is still accepted as an obsolete alias but will be removed in 696B<inheritPixmap> is still accepted as an obsolete alias but will be removed in
707future versions. 697future versions.
708 698
709=item B<fading:> I<number> 699=item B<fading:> I<number>
… …
715Fade 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
716colour is black; option B<-fadecolor>. 706colour is black; option B<-fadecolor>.
717 707
718=item B<tintColor:> I<colour> 708=item B<tintColor:> I<colour>
719 709
720Tint the transparent background pixmap with the given colour; option 710Tint the transparent background with the given colour. If the RENDER
721B<-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>.
722 715
723=item B<shading:> I<number> 716=item B<shading:> I<number>
724 717
725Darken (0 .. 100) or lighten (-1 .. -100) the transparent background image 718Darken (0 .. 99) or lighten (101 .. 200) the transparent background.
726in addition to tinting it; option B<-sh>. 719A value of 100 means no shading; option B<-sh>.
727 720
728=item B<blendType:> I<string> 721=item B<blendType:> I<string>
729 722
730Specify background blending type; option B<-blt>. 723Specify background blending type; option B<-blt>.
731 724
732=item B<blurRadius:> I<number> 725=item B<blurRadius:> I<number>
733 726
734Apply gaussian blur with the specified radius to the transparent 727Apply gaussian blur with the specified radius to the transparent
735background image; option B<-blr>. 728background; option B<-blr>.
736 729
737=item B<iconFile:> I<file> 730=item B<iconFile:> I<file>
738 731
739Set the application icon pixmap; option B<-icon>. 732Set the application icon pixmap; option B<-icon>.
740 733
… …
750=item B<borderColor:> I<colour> 743=item B<borderColor:> I<colour>
751 744
752The 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
753and the text. 746and the text.
754 747
755=item B<backgroundPixmap:> I<file[;geom[:op1][:op2][...]]> 748=item B<backgroundPixmap:> I<file[;oplist]>
756 749
757Use the specified image file for the background and also 750Use the specified image file for the background and also
758optionally specify its scaling with a geometry string B<WxH+X+Y>, 751optionally specify a colon separated list of operations to modify it.
759(default C<100x100+50+50>) in which B<"W" / "H"> specify the
760horizontal/vertical scale (percent), and B<"X" / "Y"> locate the image
761centre (percent). A scale of 0 displays the image with tiling.
762The maximum permitted scale is 1000.
763Additional operations can be specified after colon B<:op1:op2...>.
764Supported operations are: 752Supported operations are:
765 753
766 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
767 propscale will scale image keeping proportions 755 horizontal/vertical scale (percent), and B<"X" / "Y">
768 auto will scale image to match window size. Equivalent to 100x100 756 locate the image centre (percent). A scale of 0 disables
769 hscale will scale image horizontally to the window size 757 scaling. The maximum permitted scale is 1000.
770 vscale will scale image vertically to the window size 758 op=tile enables tiling
771 scale will scale image to match window size 759 op=pscale enables proportional scaling
772 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
773 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
774 784
775If 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
776blended over transparency image using alpha-blending. If I<afterimage> 786blended over the transparent background using alpha-blending. If I<afterimage>
777support has been compiled in it is possible to choose other blending 787support has been compiled in it is possible to choose other blending
778types with B<-blt "type"> option. 788types with B<-blt "type"> option.
779 789
780=item B<path:> I<path> 790=item B<path:> I<path>
781 791
… …
910=item B<scrollstyle:> I<mode> 920=item B<scrollstyle:> I<mode>
911 921
912Set 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
913the author's favourite. 923the author's favourite.
914 924
925=item B<thickness:> I<number>
926
927Set the scrollbar width in pixels.
928
915=item B<scrollBar:> I<boolean> 929=item B<scrollBar:> I<boolean>
916 930
917B<True>: enable the scrollbar [default]; option B<-sb>. B<False>: 931B<True>: enable the scrollbar [default]; option B<-sb>. B<False>:
918disable the scrollbar; option B<+sb>. 932disable the scrollbar; option B<+sb>.
919 933
… …
938B<False>: do not scroll to bottom when tty receives output; option 952B<False>: do not scroll to bottom when tty receives output; option
939B<+si>. 953B<+si>.
940 954
941=item B<scrollWithBuffer:> I<boolean> 955=item B<scrollWithBuffer:> I<boolean>
942 956
943B<True>: scroll with scrollback buffer when tty receives new lines (and 957B<True>: scroll with scrollback buffer when tty receives new lines (i.e.
944B<scrollTtyOutput> is False); option B<-sw>. B<False>: do not scroll 958try to show the same lines) and B<scrollTtyOutput> is False; option
945with 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>.
946 961
947=item B<scrollTtyKeypress:> I<boolean> 962=item B<scrollTtyKeypress:> I<boolean>
948 963
949B<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
950are those which are intercepted by rxvt-unicode for special handling and 965are those which are intercepted by rxvt-unicode for special handling and
… …
1170with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimiter `/' 1185with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimiter `/'
1171should be a character not used by the strings. 1186should be a character not used by the strings.
1172 1187
1173Its usage can be demonstrated by an example: 1188Its usage can be demonstrated by an example:
1174 1189
1175 URxvt.keysym.M-C-0x61: list|\033<M-C-|abc|> 1190 URxvt.keysym.M-C-0x61: list|\033<|abc|>
1176 1191
1177The above line is equivalent to the following three lines: 1192The above line is equivalent to the following three lines:
1178 1193
1179 URxvt.keysym.Meta-Control-0x61: \033<M-C-a> 1194 URxvt.keysym.Meta-Control-0x61: \033<a>
1180 URxvt.keysym.Meta-Control-0x62: \033<M-C-b> 1195 URxvt.keysym.Meta-Control-0x62: \033<b>
1181 URxvt.keysym.Meta-Control-0x63: \033<M-C-c> 1196 URxvt.keysym.Meta-Control-0x63: \033<c>
1182 1197
1183If 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>
1184is interpreted and executed as @@RXVT_NAME@@'s control sequence. For 1199is interpreted and executed as @@RXVT_NAME@@'s control sequence. For
1185example 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>
1186when Control-Meta-c is being pressed": 1201when Control-Meta-c is being pressed":
… …
1616=item B<RXVT_SOCKET> 1631=item B<RXVT_SOCKET>
1617 1632
1618The unix domain socket path used by @@RXVT_NAME@@c(1) and 1633The unix domain socket path used by @@RXVT_NAME@@c(1) and
1619@@RXVT_NAME@@d(1). 1634@@RXVT_NAME@@d(1).
1620 1635
1621Default F<<< $HOME/.rxvt-unicode-I<< <nodename >> >>>. 1636Default F<<< $HOME/.rxvt-unicode-I<< <nodename> >> >>>.
1622 1637
1623=item B<HOME> 1638=item B<HOME>
1624 1639
1625Used to locate the default directory for the unix domain socket for 1640Used to locate the default directory for the unix domain socket for
1626daemon communications and to locate various resource files (such as 1641daemon communications and to locate various resource files (such as
1627C<.Xdefaults>) 1642C<.Xdefaults>)
1628 1643
1629=item B<XAPPLRESDIR> 1644=item B<XAPPLRESDIR>
1630 1645
1631Directory where various X resource files are being located. 1646Directory where application-specific X resource files are located.
1632 1647
1633=item B<XENVIRONMENT> 1648=item B<XENVIRONMENT>
1634 1649
1635If 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
1636@@RXVT_NAME@@. 1651@@RXVT_NAME@@.
… …
1702 1717
1703Project Coordinator (Changes 1.0 -) 1718Project Coordinator (Changes 1.0 -)
1704 1719
1705=item Emanuele Giaquinta L<< <e.giaquinta@glauco.it> >> 1720=item Emanuele Giaquinta L<< <e.giaquinta@glauco.it> >>
1706 1721
1707Pty/tty/utmp/wtmp rewrite, lots of random hacking and bugfixing. 1722pty/utmp code rewrite, image code improvements, many random hacks and bugfixes.
1708 1723
1709=back 1724=back
1710 1725

Diff Legend

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