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.184 by sf-exg, Sat Sep 11 21:28:59 2010 UTC vs.
Revision 1.198 by sf-exg, Tue Aug 9 18:41:31 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
134I<Please address all transparency related issues to Sasha Vasko at
135sasha@aftercode.net. Read the FAQ (man 7 @@RXVT_NAME@@)!>
136 133
137=item B<-fade> I<number> 134=item B<-fade> I<number>
138 135
139Fade the text by the given percentage when focus is lost. Small values 136Fade the text by the given percentage when focus is lost. Small values
140fade a little only, 100 completely replaces all colours by the fade 137fade a little only, 100 completely replaces all colours by the fade
… …
145Fade 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
146is opaque black. resource B<fadeColor>. 143is opaque black. resource B<fadeColor>.
147 144
148=item B<-tint> I<colour> 145=item B<-tint> I<colour>
149 146
150Tint the transparent background pixmap with the given colour when 147Tint the transparent background with the given colour;
151transparency is enabled with B<-tr>. This only works for 148resource I<tintColor>.
152non-tiled backgrounds, currently. See also the B<-sh> option that can be
153used to brighten or darken the image in addition to tinting it.
154Please note that certain tint colours can be applied on the server-side,
155thus yielding performance gain of two orders of magnitude. These colours are:
156blue, red, green, cyan, magenta, yellow, and those close to them. Also
157pure black and pure white colours essentially mean no tinting; resource
158I<tintColor>. Example:
159
160 @@RXVT_NAME@@ -tr -tint blue -sh 40
161 149
162=item B<-sh> I<number> 150=item B<-sh> I<number>
163 151
164Darken (0 .. 100) or lighten (100 .. 200) the transparent 152Darken (0 .. 99) or lighten (101 .. 200) the transparent background.
165background image in addition to (or instead of) tinting it; 153A value of 100 means no shading; resource I<shading>.
166resource I<shading>.
167 154
168=item B<-blt> I<string> 155=item B<-blt> I<string>
169 156
170Specify background blending type. If background pixmap is specified 157Specify background blending type. If background pixmap is specified
171at the same time as transparency - such pixmap will be blended over 158at the same time as transparency - such pixmap will be blended over
172transparency image, using method specified. Supported values are : 159the transparent background, using the method specified. Supported values are:
173B<add>, B<alphablend>, B<allanon> - colour values averaging, B<colorize>, 160B<add>, B<alphablend>, B<allanon> - colour values averaging, B<colorize>,
174B<darken>, B<diff>, B<dissipate>, B<hue>, B<lighten>, B<overlay>, 161B<darken>, B<diff>, B<dissipate>, B<hue>, B<lighten>, B<overlay>,
175B<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
176alpha-blending. Compile I<afterimage>; resource I<blendType>. 163alpha-blending. Compile I<afterimage>; resource I<blendType>.
177 164
178=item B<-blr> I<HxV> 165=item B<-blr> I<HxV>
179 166
180Apply Gaussian Blur with the specified radii to the transparent 167Apply Gaussian Blur with the specified radii to the transparent
181background image. If single number is specified - both vertical and 168background. If a single number is specified - both vertical and
182horizontal radii are considered to be the same. Setting one of the 169horizontal radii are considered to be the same. Setting one of the
183radii to 1 and another to a large number creates interesting effects 170radii to 1 and another to a large number creates interesting effects
184on some backgrounds. Maximum radius value is 128. Compile I<afterimage>; 171on some backgrounds. Maximum radius value is 128;
185resource I<blurRadius>. 172resource I<blurRadius>.
186 173
187=item B<-icon> I<file> 174=item B<-icon> I<file>
188 175
189Compile 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
… …
571You 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
572distribution do also load settings from the B<~/.Xresources> file when X 559distribution do also load settings from the B<~/.Xresources> file when X
573starts. @@RXVT_NAME@@ will consult the following files/resources in order, 560starts. @@RXVT_NAME@@ will consult the following files/resources in order,
574with later settings overwriting earlier ones: 561with later settings overwriting earlier ones:
575 562
576 1. system-wide app-defaults file, either locale-dependent OR global
577 2. app-defaults file in $XAPPLRESDIR 563 1. app-defaults file in $XAPPLRESDIR
564 2. $HOME/.Xdefaults
578 3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults 565 3. RESOURCE_MANAGER property on root-window of screen 0
579 4. SCREEN_RESOURCES for the current screen 566 4. SCREEN_RESOURCES property on root-window of the current screen
580 5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename> 567 5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename>
581 6. resources specified via -xrm on the commandline 568 6. resources specified via -xrm on the commandline
582 569
583Note that when reading X resources, B<@@RXVT_NAME@@> recognizes two class 570Note that when reading X resources, B<@@RXVT_NAME@@> recognizes two class
584names: 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
… …
702if 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
703monitor to display anything); option B<+ss>. 690monitor to display anything); option B<+ss>.
704 691
705=item B<transparent:> I<boolean> 692=item B<transparent:> I<boolean>
706 693
707Turn on/off illusion of a transparent window background. 694Turn on/off pseudo-transparency by using the root pixmap as background.
708 695
709B<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
710future versions. 697future versions.
711 698
712I<Please address all transparency related issues to Sasha Vasko at
713sasha@aftercode.net. Read the FAQ (man 7 @@RXVT_NAME@@)!>
714
715=item B<fading:> I<number> 699=item B<fading:> I<number>
716 700
717Fade the text by the given percentage when focus is lost; option B<-fade>. 701Fade the text by the given percentage when focus is lost; option B<-fade>.
718 702
719=item B<fadeColor:> I<colour> 703=item B<fadeColor:> I<colour>
… …
721Fade 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
722colour is black; option B<-fadecolor>. 706colour is black; option B<-fadecolor>.
723 707
724=item B<tintColor:> I<colour> 708=item B<tintColor:> I<colour>
725 709
726Tint the transparent background pixmap with the given colour; option 710Tint the transparent background with the given colour. If the RENDER
727B<-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>.
728 715
729=item B<shading:> I<number> 716=item B<shading:> I<number>
730 717
731Darken (0 .. 100) or lighten (-1 .. -100) the transparent background image 718Darken (0 .. 99) or lighten (101 .. 200) the transparent background.
732in addition to tinting it; option B<-sh>. 719A value of 100 means no shading; option B<-sh>.
733 720
734=item B<blendType:> I<string> 721=item B<blendType:> I<string>
735 722
736Specify background blending type; option B<-blt>. 723Specify background blending type; option B<-blt>.
737 724
738=item B<blurRadius:> I<number> 725=item B<blurRadius:> I<number>
739 726
740Apply gaussian blur with the specified radius to the transparent 727Apply gaussian blur with the specified radius to the transparent
741background image; option B<-blr>. 728background; option B<-blr>.
742 729
743=item B<iconFile:> I<file> 730=item B<iconFile:> I<file>
744 731
745Set the application icon pixmap; option B<-icon>. 732Set the application icon pixmap; option B<-icon>.
746 733
… …
762 749
763Use the specified image file for the background and also 750Use the specified image file for the background and also
764optionally specify its scaling with a geometry string B<WxH+X+Y>, 751optionally specify its scaling with a geometry string B<WxH+X+Y>,
765(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
766horizontal/vertical scale (percent), and B<"X" / "Y"> locate the image 753horizontal/vertical scale (percent), and B<"X" / "Y"> locate the image
767centre (percent). A scale of 0 displays the image with tiling. 754centre (percent). A scale of 0 disables scaling.
768The maximum permitted scale is 1000. 755The maximum permitted scale is 1000.
769Additional operations can be specified after colon B<:op1:op2...>. 756Additional operations can be specified after colon B<:op1:op2...>.
770Supported operations are: 757Supported operations are:
771 758
772 tile force background image to be tiled and not scaled. Equivalent to 0x0 759 tile will tile image
773 propscale will scale image keeping proportions 760 propscale will scale image keeping proportions
774 auto will scale image to match window size. Equivalent to 100x100 761 auto will scale image to match window size. Equivalent to 100x100
775 hscale will scale image horizontally to the window size 762 hscale will scale image horizontally to the window size
776 vscale will scale image vertically to the window size 763 vscale will scale image vertically to the window size
777 scale will scale image to match window size 764 scale will scale image to match window size
778 root will tile image as if it was a root window background, auto-adjusting 765 root will tile image as if it was a root window background, auto-adjusting
779 whenever terminal window moves 766 whenever terminal window moves
780 767
781If used in conjunction with B<-tr> option, the specified pixmap will be 768If used in conjunction with B<-tr> option, the specified pixmap will be
782blended over transparency image using either alpha-blending, or any 769blended over the transparent background using alpha-blending. If I<afterimage>
783other blending type, specified with B<-blt "type"> option. 770support has been compiled in it is possible to choose other blending
771types with B<-blt "type"> option.
784 772
785=item B<path:> I<path> 773=item B<path:> I<path>
786 774
787Specify the colon-delimited search path for finding background image files. 775Specify the colon-delimited search path for finding background image files.
788 776
… …
915=item B<scrollstyle:> I<mode> 903=item B<scrollstyle:> I<mode>
916 904
917Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is 905Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is
918the author's favourite. 906the author's favourite.
919 907
908=item B<thickness:> I<number>
909
910Set the scrollbar width in pixels.
911
920=item B<scrollBar:> I<boolean> 912=item B<scrollBar:> I<boolean>
921 913
922B<True>: enable the scrollbar [default]; option B<-sb>. B<False>: 914B<True>: enable the scrollbar [default]; option B<-sb>. B<False>:
923disable the scrollbar; option B<+sb>. 915disable the scrollbar; option B<+sb>.
924 916
… …
943B<False>: do not scroll to bottom when tty receives output; option 935B<False>: do not scroll to bottom when tty receives output; option
944B<+si>. 936B<+si>.
945 937
946=item B<scrollWithBuffer:> I<boolean> 938=item B<scrollWithBuffer:> I<boolean>
947 939
948B<True>: scroll with scrollback buffer when tty receives new lines (and 940B<True>: scroll with scrollback buffer when tty receives new lines (i.e.
949B<scrollTtyOutput> is False); option B<-sw>. B<False>: do not scroll 941try to show the same lines) and B<scrollTtyOutput> is False; option
950with scrollback buffer when tty receives new lines; option B<+sw>. 942B<-sw>. B<False>: do not scroll with scrollback buffer when tty receives
943new lines; option B<+sw>.
951 944
952=item B<scrollTtyKeypress:> I<boolean> 945=item B<scrollTtyKeypress:> I<boolean>
953 946
954B<True>: scroll to bottom when a non-special key is pressed. Special keys 947B<True>: scroll to bottom when a non-special key is pressed. Special keys
955are those which are intercepted by rxvt-unicode for special handling and 948are those which are intercepted by rxvt-unicode for special handling and
… …
1175with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimiter `/' 1168with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimiter `/'
1176should be a character not used by the strings. 1169should be a character not used by the strings.
1177 1170
1178Its usage can be demonstrated by an example: 1171Its usage can be demonstrated by an example:
1179 1172
1180 URxvt.keysym.M-C-0x61: list|\033<M-C-|abc|> 1173 URxvt.keysym.M-C-0x61: list|\033<|abc|>
1181 1174
1182The above line is equivalent to the following three lines: 1175The above line is equivalent to the following three lines:
1183 1176
1184 URxvt.keysym.Meta-Control-0x61: \033<M-C-a> 1177 URxvt.keysym.Meta-Control-0x61: \033<a>
1185 URxvt.keysym.Meta-Control-0x62: \033<M-C-b> 1178 URxvt.keysym.Meta-Control-0x62: \033<b>
1186 URxvt.keysym.Meta-Control-0x63: \033<M-C-c> 1179 URxvt.keysym.Meta-Control-0x63: \033<c>
1187 1180
1188If I<string> takes the form of C<command:STRING>, the specified B<STRING> 1181If I<string> takes the form of C<command:STRING>, the specified B<STRING>
1189is interpreted and executed as @@RXVT_NAME@@'s control sequence. For 1182is interpreted and executed as @@RXVT_NAME@@'s control sequence. For
1190example the following means "change the current locale to C<zh_CN.GBK> 1183example the following means "change the current locale to C<zh_CN.GBK>
1191when Control-Meta-c is being pressed": 1184when Control-Meta-c is being pressed":
… …
1198C<@@RXVT_NAME@@ -pe selection>) listens for C<selection:rot13> events: 1191C<@@RXVT_NAME@@ -pe selection>) listens for C<selection:rot13> events:
1199 1192
1200 URxvt.keysym.M-C-c: perl:selection:rot13 1193 URxvt.keysym.M-C-c: perl:selection:rot13
1201 1194
1202Due the the large number of modifier combinations, a defined key mapping 1195Due the the large number of modifier combinations, a defined key mapping
1203will match if at I<at least> the specified identifiers are being set, and 1196will match if I<at least> the specified identifiers are being set, and
1204no other key mappings with those and more bits are being defined. That 1197no other key mappings with those and more bits are being defined. That
1205means that defining a key map for C<a> will automatically provide 1198means that defining a key map for C<a> will automatically provide
1206definitions for C<Meta-a>, C<Shift-a> and so on, unless some of those are defined 1199definitions for C<Meta-a>, C<Shift-a> and so on, unless some of those are defined
1207mappings themselves. 1200mappings themselves.
1208 1201
… …
1621=item B<RXVT_SOCKET> 1614=item B<RXVT_SOCKET>
1622 1615
1623The unix domain socket path used by @@RXVT_NAME@@c(1) and 1616The unix domain socket path used by @@RXVT_NAME@@c(1) and
1624@@RXVT_NAME@@d(1). 1617@@RXVT_NAME@@d(1).
1625 1618
1626Default F<<< $HOME/.rxvt-unicode-I<< <nodename >> >>>. 1619Default F<<< $HOME/.rxvt-unicode-I<< <nodename> >> >>>.
1627 1620
1628=item B<HOME> 1621=item B<HOME>
1629 1622
1630Used to locate the default directory for the unix domain socket for 1623Used to locate the default directory for the unix domain socket for
1631daemon communications and to locate various resource files (such as 1624daemon communications and to locate various resource files (such as
1632C<.Xdefaults>) 1625C<.Xdefaults>)
1633 1626
1634=item B<XAPPLRESDIR> 1627=item B<XAPPLRESDIR>
1635 1628
1636Directory where various X resource files are being located. 1629Directory where application-specific X resource files are located.
1637 1630
1638=item B<XENVIRONMENT> 1631=item B<XENVIRONMENT>
1639 1632
1640If set and accessible, gives the name of a X resource file to be loaded by 1633If set and accessible, gives the name of a X resource file to be loaded by
1641@@RXVT_NAME@@. 1634@@RXVT_NAME@@.
… …
1707 1700
1708Project Coordinator (Changes 1.0 -) 1701Project Coordinator (Changes 1.0 -)
1709 1702
1710=item Emanuele Giaquinta L<< <e.giaquinta@glauco.it> >> 1703=item Emanuele Giaquinta L<< <e.giaquinta@glauco.it> >>
1711 1704
1712Pty/tty/utmp/wtmp rewrite, lots of random hacking and bugfixing. 1705pty/utmp code rewrite, image code improvements, many random hacks and bugfixes.
1713 1706
1714=back 1707=back
1715 1708

Diff Legend

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