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.186 by sf-exg, Wed Oct 13 23:36:00 2010 UTC vs.
Revision 1.220 by root, Fri Sep 21 23:31:43 2012 UTC

98is still respected. but deprecated). In the absence of this option, the 98is still respected. but deprecated). In the absence of this option, the
99display specified by the B<DISPLAY> environment variable is used. 99display specified by the B<DISPLAY> environment variable is used.
100 100
101=item B<-depth> I<bitdepth> 101=item B<-depth> I<bitdepth>
102 102
103Compile I<xft>: Attempt to find a visual with the given bit depth; 103Compile I<frills>: Attempt to find a visual with the given bit depth;
104resource B<depth>. 104resource B<depth>.
105 105
106[Please note that many X servers (and libXft) are buggy with 106[Please note that many X servers (and libXft) are buggy with
107respect to C<-depth 32> and/or alpha channels, and will cause all sorts 107respect to C<-depth 32> and/or alpha channels, and will cause all sorts
108of graphical corruption. This is harmless, but we can't do anything about 108of graphical corruption. This is harmless, but we can't do anything about
109this, so watch out] 109this, so watch out]
110 110
111=item B<-visual> I<visualID>
112
113Compile I<frills>: Use the given visual (see e.g. C<xdpyinfo> for possible
114visual ids).
115
111=item B<-geometry> I<geom> 116=item B<-geometry> I<geom>
112 117
113Window geometry (B<-g> still respected); resource B<geometry>. 118Window geometry (B<-g> still respected); resource B<geometry>.
114 119
115=item B<-rv>|B<+rv> 120=item B<-rv>|B<+rv>
124 129
125Turn on/off skip scrolling (allow multiple screens per refresh); resource B<skipScroll>. 130Turn on/off skip scrolling (allow multiple screens per refresh); resource B<skipScroll>.
126 131
127=item B<-tr>|B<+tr> 132=item B<-tr>|B<+tr>
128 133
129Turn on/off illusion of a transparent window background; resource B<transparent>. 134Turn on/off pseudo-transparency by using the root pixmap as background; resource B<transparent>.
130 135
131B<-ip> is still accepted as an obsolete alias but will be removed in 136B<-ip> is still accepted as an obsolete alias but will be removed in
132future versions. 137future versions.
133
134I<Please address all transparency related issues to Sasha Vasko at
135sasha@aftercode.net. Read the FAQ (man 7 @@RXVT_NAME@@)!>
136 138
137=item B<-fade> I<number> 139=item B<-fade> I<number>
138 140
139Fade the text by the given percentage when focus is lost. Small values 141Fade the text by the given percentage when focus is lost. Small values
140fade a little only, 100 completely replaces all colours by the fade 142fade 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 147Fade to this colour when fading is used (see B<-fade>). The default colour
146is opaque black. resource B<fadeColor>. 148is opaque black. resource B<fadeColor>.
147 149
148=item B<-tint> I<colour> 150=item B<-tint> I<colour>
149 151
150Tint the transparent background pixmap with the given colour when 152Tint the transparent background with the given colour;
151transparency is enabled with B<-tr>. This only works for 153resource 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 154
162=item B<-sh> I<number> 155=item B<-sh> I<number>
163 156
164Darken (0 .. 100) or lighten (100 .. 200) the transparent 157Darken (0 .. 99) or lighten (101 .. 200) the transparent background.
165background image in addition to (or instead of) tinting it; 158A value of 100 means no shading; resource I<shading>.
166resource I<shading>.
167
168=item B<-blt> I<string>
169
170Specify background blending type. If background pixmap is specified
171at the same time as transparency - such pixmap will be blended over
172transparency image, using method specified. Supported values are :
173B<add>, B<alphablend>, B<allanon> - colour values averaging, B<colorize>,
174B<darken>, B<diff>, B<dissipate>, B<hue>, B<lighten>, B<overlay>,
175B<saturate>, B<screen>, B<sub>, B<tint>, B<value>. The default is
176alpha-blending. Compile I<afterimage>; resource I<blendType>.
177 159
178=item B<-blr> I<HxV> 160=item B<-blr> I<HxV>
179 161
180Apply Gaussian Blur with the specified radii to the transparent 162Apply Gaussian Blur with the specified radii to the transparent
181background image. If single number is specified - both vertical and 163background. If a single number is specified, the vertical and
182horizontal radii are considered to be the same. Setting one of the 164horizontal radii are considered to be the same. Setting one of the
183radii to 1 and another to a large number creates interesting effects 165radii to 1 and the other to a large number creates interesting effects
184on some backgrounds. Maximum radius value is 128. Compile I<afterimage> or I<xft>; 166on some backgrounds. The maximum radius value is 128. An horizontal or
167vertical radius of 0 disables blurring;
185resource I<blurRadius>. 168resource I<blurRadius>.
186 169
187=item B<-icon> I<file> 170=item B<-icon> I<file>
188 171
189Compile I<afterimage> or I<pixbuf>: Use the specified image as application icon. This 172Compile I<pixbuf>: Use the specified image as application icon. This
190is used by many window managers, taskbars and pagers to represent the 173is used by many window managers, taskbars and pagers to represent the
191application window; resource I<iconFile>. 174application window; resource I<iconFile>.
192 175
193=item B<-bg> I<colour> 176=item B<-bg> I<colour>
194 177
196 179
197=item B<-fg> I<colour> 180=item B<-fg> I<colour>
198 181
199Window foreground colour; resource B<foreground>. 182Window foreground colour; resource B<foreground>.
200 183
201=item B<-pixmap> I<file[;geom[:op1][:op2][...]]> 184=item B<-pixmap> I<file[;oplist]>
202 185
203Compile I<afterimage> or I<pixbuf>: Specify image file for the background and also 186Compile I<pixbuf>: Specify image file for the background and also
204optionally specify its scaling with a geometry string. Note you may need to 187optionally specify a list of operations to modify it. Note you may need to
205add quotes to avoid special shell interpretation of the C<;> in the 188add quotes to avoid special shell interpretation of the C<;> in the
206command-line; for more details see resource B<backgroundPixmap>. 189command-line; for more details see resource B<backgroundPixmap>.
207 190
208=item B<-cr> I<colour> 191=item B<-cr> I<colour>
209 192
571You can set and change the resources using X11 tools like B<xrdb>. Many 554You 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 555distribution do also load settings from the B<~/.Xresources> file when X
573starts. @@RXVT_NAME@@ will consult the following files/resources in order, 556starts. @@RXVT_NAME@@ will consult the following files/resources in order,
574with later settings overwriting earlier ones: 557with later settings overwriting earlier ones:
575 558
576 1. system-wide app-defaults file, either locale-dependent OR global
577 2. app-defaults file in $XAPPLRESDIR 559 1. app-defaults file in $XAPPLRESDIR
560 2. $HOME/.Xdefaults
578 3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults 561 3. RESOURCE_MANAGER property on root-window of screen 0
579 4. SCREEN_RESOURCES for the current screen 562 4. SCREEN_RESOURCES property on root-window of the current screen
580 5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename> 563 5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename>
581 6. resources specified via -xrm on the commandline 564 6. resources specified via -xrm on the commandline
582 565
583Note that when reading X resources, B<@@RXVT_NAME@@> recognizes two class 566Note that when reading X resources, B<@@RXVT_NAME@@> recognizes two class
584names: B<Rxvt> and B<URxvt>. The class name B<Rxvt> allows resources 567names: 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 685if the refresh is too fast for the human eye to read anything (or the
703monitor to display anything); option B<+ss>. 686monitor to display anything); option B<+ss>.
704 687
705=item B<transparent:> I<boolean> 688=item B<transparent:> I<boolean>
706 689
707Turn on/off illusion of a transparent window background. 690Turn on/off pseudo-transparency by using the root pixmap as background.
708 691
709B<inheritPixmap> is still accepted as an obsolete alias but will be removed in 692B<inheritPixmap> is still accepted as an obsolete alias but will be removed in
710future versions. 693future versions.
711 694
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> 695=item B<fading:> I<number>
716 696
717Fade the text by the given percentage when focus is lost; option B<-fade>. 697Fade the text by the given percentage when focus is lost; option B<-fade>.
718 698
719=item B<fadeColor:> I<colour> 699=item B<fadeColor:> I<colour>
721Fade to this colour, when fading is used (see B<fading:>). The default 701Fade to this colour, when fading is used (see B<fading:>). The default
722colour is black; option B<-fadecolor>. 702colour is black; option B<-fadecolor>.
723 703
724=item B<tintColor:> I<colour> 704=item B<tintColor:> I<colour>
725 705
726Tint the transparent background pixmap with the given colour; option 706Tint the transparent background with the given colour. If the RENDER
727B<-tint>. 707extension is not available only black, red, green, yellow, blue,
708magenta, cyan and white tints can be performed server-side. Note that
709a black tint yields a completely black image while a white tint yields
710the image unchanged; option B<-tint>.
728 711
729=item B<shading:> I<number> 712=item B<shading:> I<number>
730 713
731Darken (0 .. 100) or lighten (-1 .. -100) the transparent background image 714Darken (0 .. 99) or lighten (101 .. 200) the transparent background.
732in addition to tinting it; option B<-sh>. 715A value of 100 means no shading; option B<-sh>.
733
734=item B<blendType:> I<string>
735
736Specify background blending type; option B<-blt>.
737 716
738=item B<blurRadius:> I<number> 717=item B<blurRadius:> I<number>
739 718
740Apply gaussian blur with the specified radius to the transparent 719Apply gaussian blur with the specified radius to the transparent
741background image; option B<-blr>. 720background; option B<-blr>.
742 721
743=item B<iconFile:> I<file> 722=item B<iconFile:> I<file>
744 723
745Set the application icon pixmap; option B<-icon>. 724Set the application icon pixmap; option B<-icon>.
746 725
756=item B<borderColor:> I<colour> 735=item B<borderColor:> I<colour>
757 736
758The colour of the border around the text area and between the scrollbar 737The colour of the border around the text area and between the scrollbar
759and the text. 738and the text.
760 739
761=item B<backgroundPixmap:> I<file[;geom[:op1][:op2][...]]> 740=item B<backgroundPixmap:> I<file[;oplist]>
762 741
763Use the specified image file for the background and also 742Use the specified image file for the background and also
764optionally specify its scaling with a geometry string B<WxH+X+Y>, 743optionally specify a colon separated list of operations to modify it.
765(default C<100x100+50+50>) in which B<"W" / "H"> specify the
766horizontal/vertical scale (percent), and B<"X" / "Y"> locate the image
767centre (percent). A scale of 0 displays the image with tiling.
768The maximum permitted scale is 1000.
769Additional operations can be specified after colon B<:op1:op2...>.
770Supported operations are: 744Supported operations are:
771 745
772 tile force background image to be tiled and not scaled. Equivalent to 0x0 746=over 4
773 propscale will scale image keeping proportions 747
774 auto will scale image to match window size. Equivalent to 100x100 748=item B<WxH+X+Y>
775 hscale will scale image horizontally to the window size 749
776 vscale will scale image vertically to the window size 750sets scale and position. B<"W" / "H"> specify the horizontal/vertical
777 scale will scale image to match window size 751scale (percent), and B<"X" / "Y"> locate the image centre (percent). A
778 root will tile image as if it was a root window background, auto-adjusting 752scale of 0 disables scaling.
779 whenever terminal window moves 753
754=item B<op=tile>
755
756enables tiling
757
758=item B<op=keep-aspect>
759
760maintain the image aspect ratio when scaling
761
762=item B<op=root-align>
763
764use the position of the terminal window relative to the root window as
765the image offset, simulating a root window background
766
767=back
768
769The default scale and position setting is C<100x100+50+50>.
770Alternatively, a predefined set of templates can be used to achieve
771the most common setups:
772
773=over 4
774
775=item B<style=tiled>
776
777the image is tiled with no scaling. Equivalent to 0x0+0+0:op=tile
778
779=item B<style=aspect-stretched>
780
781the image is scaled to fill the whole window maintaining the aspect
782ratio and centered. Equivalent to 100x100+50+50:op=keep-aspect
783
784=item B<style=stretched>
785
786the image is scaled to fill the whole window. Equivalent to 100x100
787
788=item B<style=centered>
789
790the image is centered with no scaling. Equivalent to 0x0+50+50
791
792=item B<style=root-tiled>
793
794the image is tiled with no scaling and using 'root' positioning.
795Equivalent to 0x0:op=tile:op=root-align
796
797=back
798
799If multiple templates are specified the last one wins. Note that a
800template overrides all the scale, position and operations settings.
780 801
781If used in conjunction with B<-tr> option, the specified pixmap will be 802If used in conjunction with B<-tr> option, the specified pixmap will be
782blended over transparency image using alpha-blending. If I<afterimage> 803blended over the transparent background using alpha-blending.
783support has been compiled in it is possible to choose other blending
784types with B<-blt "type"> option.
785 804
786=item B<path:> I<path> 805=item B<path:> I<path>
787 806
788Specify the colon-delimited search path for finding background image files. 807Specify the colon-delimited search path for finding background image files.
789 808
916=item B<scrollstyle:> I<mode> 935=item B<scrollstyle:> I<mode>
917 936
918Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is 937Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is
919the author's favourite. 938the author's favourite.
920 939
940=item B<thickness:> I<number>
941
942Set the scrollbar width in pixels.
943
921=item B<scrollBar:> I<boolean> 944=item B<scrollBar:> I<boolean>
922 945
923B<True>: enable the scrollbar [default]; option B<-sb>. B<False>: 946B<True>: enable the scrollbar [default]; option B<-sb>. B<False>:
924disable the scrollbar; option B<+sb>. 947disable the scrollbar; option B<+sb>.
925 948
944B<False>: do not scroll to bottom when tty receives output; option 967B<False>: do not scroll to bottom when tty receives output; option
945B<+si>. 968B<+si>.
946 969
947=item B<scrollWithBuffer:> I<boolean> 970=item B<scrollWithBuffer:> I<boolean>
948 971
949B<True>: scroll with scrollback buffer when tty receives new lines (and 972B<True>: scroll with scrollback buffer when tty receives new lines (i.e.
950B<scrollTtyOutput> is False); option B<-sw>. B<False>: do not scroll 973try to show the same lines) and B<scrollTtyOutput> is False; option
951with scrollback buffer when tty receives new lines; option B<+sw>. 974B<-sw>. B<False>: do not scroll with scrollback buffer when tty receives
975new lines; option B<+sw>.
952 976
953=item B<scrollTtyKeypress:> I<boolean> 977=item B<scrollTtyKeypress:> I<boolean>
954 978
955B<True>: scroll to bottom when a non-special key is pressed. Special keys 979B<True>: scroll to bottom when a non-special key is pressed. Special keys
956are those which are intercepted by rxvt-unicode for special handling and 980are those which are intercepted by rxvt-unicode for special handling and
1170performed in an exact manner; however, the closest match is assured. 1194performed in an exact manner; however, the closest match is assured.
1171 1195
1172I<string> may contain escape values (C<\n>: newline, C<\000>: octal 1196I<string> may contain escape values (C<\n>: newline, C<\000>: octal
1173number), see RESOURCES in C<man 7 X> for further details. 1197number), see RESOURCES in C<man 7 X> for further details.
1174 1198
1175You can define a range of keysyms in one shot by providing a I<string> 1199You can define a range of keysyms in one shot by
1200loading the C<keysym-list> perl extension and providing a I<string>
1176with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimiter `/' 1201with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimiter `/'
1177should be a character not used by the strings. 1202should be a character not used by the strings.
1178 1203
1179Its usage can be demonstrated by an example: 1204Its usage can be demonstrated by an example:
1180 1205
1181 URxvt.keysym.M-C-0x61: list|\033<M-C-|abc|> 1206 URxvt.keysym.M-C-0x61: list|\033<|abc|>
1182 1207
1183The above line is equivalent to the following three lines: 1208The above line is equivalent to the following three lines:
1184 1209
1185 URxvt.keysym.Meta-Control-0x61: \033<M-C-a> 1210 URxvt.keysym.Meta-Control-0x61: \033<a>
1186 URxvt.keysym.Meta-Control-0x62: \033<M-C-b> 1211 URxvt.keysym.Meta-Control-0x62: \033<b>
1187 URxvt.keysym.Meta-Control-0x63: \033<M-C-c> 1212 URxvt.keysym.Meta-Control-0x63: \033<c>
1188 1213
1189If I<string> takes the form of C<command:STRING>, the specified B<STRING> 1214If I<string> takes the form of C<command:STRING>, the specified B<STRING>
1190is interpreted and executed as @@RXVT_NAME@@'s control sequence. For 1215is interpreted and executed as @@RXVT_NAME@@'s control sequence. For
1191example the following means "change the current locale to C<zh_CN.GBK> 1216example the following means "change the current locale to C<zh_CN.GBK>
1192when Control-Meta-c is being pressed": 1217when Control-Meta-c is being pressed":
1265the @@RXVT_NAME@@perl(3) manpage. 1290the @@RXVT_NAME@@perl(3) manpage.
1266 1291
1267=item B<perl-lib>: I<path> 1292=item B<perl-lib>: I<path>
1268 1293
1269Colon-separated list of additional directories that hold extension 1294Colon-separated list of additional directories that hold extension
1270scripts. When looking for extensions specified by the C<perl> resource, 1295scripts. When looking for perl extensions, @@RXVT_NAME@@ will first look
1271@@RXVT_NAME@@ will first look in these directories and then in 1296in these directories, then in C<$URXVT_PERL_LIB>, F<$HOME/.urxvt/ext> and
1272F<@@RXVT_LIBDIR@@/urxvt/perl/>. 1297lastly in F<@@RXVT_LIBDIR@@/urxvt/perl/>.
1273 1298
1274See the @@RXVT_NAME@@perl(3) manpage. 1299See the @@RXVT_NAME@@perl(3) manpage.
1275 1300
1276=item B<< selection.pattern-I<idx> >>: I<perl-regex> 1301=item B<< selection.pattern-I<idx> >>: I<perl-regex>
1277 1302
1525White. 1550White.
1526 1551
1527=head2 ALPHA CHANNEL SUPPORT 1552=head2 ALPHA CHANNEL SUPPORT
1528 1553
1529If Xft support has been compiled in and as long as Xft/Xrender/X don't get 1554If Xft support has been compiled in and as long as Xft/Xrender/X don't get
1530their act together, rxvt-unicode will do it's own alpha channel management: 1555their act together, rxvt-unicode will do its own alpha channel management:
1531 1556
1532You can prefix any colour with an opaqueness percentage enclosed in 1557You can prefix any colour with an opaqueness percentage enclosed in
1533brackets, i.e. C<[percent]>, where C<percent> is a decimal percentage 1558brackets, i.e. C<[percent]>, where C<percent> is a decimal percentage
1534(0-100) that specifies the opacity of the colour, where C<0> is completely 1559(0-100) that specifies the opacity of the colour, where C<0> is completely
1535transparent and C<100> is completely opaque. For example, C<[50]red> is a 1560transparent and C<100> is completely opaque. For example, C<[50]red> is a
1617 1642
1618=item B<SHELL> 1643=item B<SHELL>
1619 1644
1620The shell to be used for command execution, defaults to C</bin/sh>. 1645The shell to be used for command execution, defaults to C</bin/sh>.
1621 1646
1622=item B<RXVT_SOCKET> 1647=item B<RXVT_SOCKET> [I<sic>]
1623 1648
1624The unix domain socket path used by @@RXVT_NAME@@c(1) and 1649The unix domain socket path used by @@RXVT_NAME@@c(1) and
1625@@RXVT_NAME@@d(1). 1650@@RXVT_NAME@@d(1).
1626 1651
1627Default F<<< $HOME/.rxvt-unicode-I<< <nodename >> >>>. 1652Default F<<< $HOME/.urxvt/urxvtd-I<< <nodename> >> >>>.
1653
1654=item B<URXVT_PERL_LIB>
1655
1656Additional F<:>-separated library search path for perl extensions. Will be
1657searched after B<-perl-lib> but before F<~/.urxvt/ext> and the system library
1658directory.
1659
1660=item B<URXVT_PERL_VERBOSITY>
1661
1662See L<@@RXVT_NAME@@perl>(3).
1628 1663
1629=item B<HOME> 1664=item B<HOME>
1630 1665
1631Used to locate the default directory for the unix domain socket for 1666Used to locate the default directory for the unix domain socket for
1632daemon communications and to locate various resource files (such as 1667daemon communications and to locate various resource files (such as
1633C<.Xdefaults>) 1668C<.Xdefaults>)
1634 1669
1635=item B<XAPPLRESDIR> 1670=item B<XAPPLRESDIR>
1636 1671
1637Directory where various X resource files are being located. 1672Directory where application-specific X resource files are located.
1638 1673
1639=item B<XENVIRONMENT> 1674=item B<XENVIRONMENT>
1640 1675
1641If set and accessible, gives the name of a X resource file to be loaded by 1676If set and accessible, gives the name of a X resource file to be loaded by
1642@@RXVT_NAME@@. 1677@@RXVT_NAME@@.
1653 1688
1654=back 1689=back
1655 1690
1656=head1 SEE ALSO 1691=head1 SEE ALSO
1657 1692
1693@@RXVT_NAME@@(7), @@RXVT_NAME@@c(1), @@RXVT_NAME@@d(1), @@RXVT_NAME@@-extensions(1),
1658@@RXVT_NAME@@(7), @@RXVT_NAME@@c(1), @@RXVT_NAME@@d(1), xterm(1), sh(1), resize(1), X(1), pty(4), tty(4), utmp(5) 1694@@RXVT_NAME@@perl(3), xterm(1), sh(1), resize(1), X(1), pty(4), tty(4), utmp(5)
1659 1695
1660=head1 CURRENT PROJECT COORDINATOR 1696=head1 CURRENT PROJECT COORDINATOR
1661 1697
1662=over 4 1698=over 4
1663 1699
1708 1744
1709Project Coordinator (Changes 1.0 -) 1745Project Coordinator (Changes 1.0 -)
1710 1746
1711=item Emanuele Giaquinta L<< <e.giaquinta@glauco.it> >> 1747=item Emanuele Giaquinta L<< <e.giaquinta@glauco.it> >>
1712 1748
1713Pty/tty/utmp/wtmp rewrite, lots of random hacking and bugfixing. 1749pty/utmp code rewrite, image code improvements, many random hacks and bugfixes.
1714 1750
1715=back 1751=back
1716 1752

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines