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.219 by root, Thu Jun 7 16:06:23 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 138
134=item B<-fade> I<number> 139=item B<-fade> I<number>
142Fade 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
143is opaque black. resource B<fadeColor>. 148is opaque black. resource B<fadeColor>.
144 149
145=item B<-tint> I<colour> 150=item B<-tint> I<colour>
146 151
147Tint the transparent background pixmap with the given colour when 152Tint the transparent background with the given colour;
148transparency is enabled with B<-tr>. This only works for 153resource 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 154
159=item B<-sh> I<number> 155=item B<-sh> I<number>
160 156
161Darken (0 .. 100) or lighten (100 .. 200) the transparent 157Darken (0 .. 99) or lighten (101 .. 200) the transparent background.
162background image in addition to (or instead of) tinting it; 158A value of 100 means no shading; resource I<shading>.
163resource I<shading>.
164
165=item B<-blt> I<string>
166
167Specify background blending type. If background pixmap is specified
168at the same time as transparency - such pixmap will be blended over
169transparency image, using method specified. Supported values are :
170B<add>, B<alphablend>, B<allanon> - colour values averaging, B<colorize>,
171B<darken>, B<diff>, B<dissipate>, B<hue>, B<lighten>, B<overlay>,
172B<saturate>, B<screen>, B<sub>, B<tint>, B<value>. The default is
173alpha-blending. Compile I<afterimage>; resource I<blendType>.
174 159
175=item B<-blr> I<HxV> 160=item B<-blr> I<HxV>
176 161
177Apply Gaussian Blur with the specified radii to the transparent 162Apply Gaussian Blur with the specified radii to the transparent
178background image. If single number is specified - both vertical and 163background. If a single number is specified, the vertical and
179horizontal radii are considered to be the same. Setting one of the 164horizontal radii are considered to be the same. Setting one of the
180radii to 1 and another to a large number creates interesting effects 165radii to 1 and the other to a large number creates interesting effects
181on 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;
182resource I<blurRadius>. 168resource I<blurRadius>.
183 169
184=item B<-icon> I<file> 170=item B<-icon> I<file>
185 171
186Compile I<afterimage> or I<pixbuf>: Use the specified image as application icon. This 172Compile I<pixbuf>: Use the specified image as application icon. This
187is used by many window managers, taskbars and pagers to represent the 173is used by many window managers, taskbars and pagers to represent the
188application window; resource I<iconFile>. 174application window; resource I<iconFile>.
189 175
190=item B<-bg> I<colour> 176=item B<-bg> I<colour>
191 177
193 179
194=item B<-fg> I<colour> 180=item B<-fg> I<colour>
195 181
196Window foreground colour; resource B<foreground>. 182Window foreground colour; resource B<foreground>.
197 183
198=item B<-pixmap> I<file[;geom[:op1][:op2][...]]> 184=item B<-pixmap> I<file[;oplist]>
199 185
200Compile I<afterimage> or I<pixbuf>: Specify image file for the background and also 186Compile I<pixbuf>: Specify image file for the background and also
201optionally 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
202add quotes to avoid special shell interpretation of the C<;> in the 188add quotes to avoid special shell interpretation of the C<;> in the
203command-line; for more details see resource B<backgroundPixmap>. 189command-line; for more details see resource B<backgroundPixmap>.
204 190
205=item B<-cr> I<colour> 191=item B<-cr> I<colour>
206 192
568You 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
569distribution do also load settings from the B<~/.Xresources> file when X 555distribution do also load settings from the B<~/.Xresources> file when X
570starts. @@RXVT_NAME@@ will consult the following files/resources in order, 556starts. @@RXVT_NAME@@ will consult the following files/resources in order,
571with later settings overwriting earlier ones: 557with later settings overwriting earlier ones:
572 558
573 1. system-wide app-defaults file, either locale-dependent OR global
574 2. app-defaults file in $XAPPLRESDIR 559 1. app-defaults file in $XAPPLRESDIR
560 2. $HOME/.Xdefaults
575 3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults 561 3. RESOURCE_MANAGER property on root-window of screen 0
576 4. SCREEN_RESOURCES for the current screen 562 4. SCREEN_RESOURCES property on root-window of the current screen
577 5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename> 563 5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename>
578 6. resources specified via -xrm on the commandline 564 6. resources specified via -xrm on the commandline
579 565
580Note that when reading X resources, B<@@RXVT_NAME@@> recognizes two class 566Note that when reading X resources, B<@@RXVT_NAME@@> recognizes two class
581names: 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
699if 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
700monitor to display anything); option B<+ss>. 686monitor to display anything); option B<+ss>.
701 687
702=item B<transparent:> I<boolean> 688=item B<transparent:> I<boolean>
703 689
704Turn on/off illusion of a transparent window background. 690Turn on/off pseudo-transparency by using the root pixmap as background.
705 691
706B<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
707future versions. 693future versions.
708 694
709=item B<fading:> I<number> 695=item B<fading:> I<number>
715Fade 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
716colour is black; option B<-fadecolor>. 702colour is black; option B<-fadecolor>.
717 703
718=item B<tintColor:> I<colour> 704=item B<tintColor:> I<colour>
719 705
720Tint the transparent background pixmap with the given colour; option 706Tint the transparent background with the given colour. If the RENDER
721B<-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>.
722 711
723=item B<shading:> I<number> 712=item B<shading:> I<number>
724 713
725Darken (0 .. 100) or lighten (-1 .. -100) the transparent background image 714Darken (0 .. 99) or lighten (101 .. 200) the transparent background.
726in addition to tinting it; option B<-sh>. 715A value of 100 means no shading; option B<-sh>.
727
728=item B<blendType:> I<string>
729
730Specify background blending type; option B<-blt>.
731 716
732=item B<blurRadius:> I<number> 717=item B<blurRadius:> I<number>
733 718
734Apply gaussian blur with the specified radius to the transparent 719Apply gaussian blur with the specified radius to the transparent
735background image; option B<-blr>. 720background; option B<-blr>.
736 721
737=item B<iconFile:> I<file> 722=item B<iconFile:> I<file>
738 723
739Set the application icon pixmap; option B<-icon>. 724Set the application icon pixmap; option B<-icon>.
740 725
750=item B<borderColor:> I<colour> 735=item B<borderColor:> I<colour>
751 736
752The 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
753and the text. 738and the text.
754 739
755=item B<backgroundPixmap:> I<file[;geom[:op1][:op2][...]]> 740=item B<backgroundPixmap:> I<file[;oplist]>
756 741
757Use the specified image file for the background and also 742Use the specified image file for the background and also
758optionally specify its scaling with a geometry string B<WxH+X+Y>, 743optionally 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: 744Supported operations are:
765 745
766 tile force background image to be tiled and not scaled. Equivalent to 0x0 746=over 4
767 propscale will scale image keeping proportions 747
768 auto will scale image to match window size. Equivalent to 100x100 748=item B<WxH+X+Y>
769 hscale will scale image horizontally to the window size 749
770 vscale will scale image vertically to the window size 750sets scale and position. B<"W" / "H"> specify the horizontal/vertical
771 scale will scale image to match window size 751scale (percent), and B<"X" / "Y"> locate the image centre (percent). A
772 root will tile image as if it was a root window background, auto-adjusting 752scale of 0 disables scaling.
773 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.
774 801
775If 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
776blended over transparency image using alpha-blending. If I<afterimage> 803blended over the transparent background using alpha-blending.
777support has been compiled in it is possible to choose other blending
778types with B<-blt "type"> option.
779 804
780=item B<path:> I<path> 805=item B<path:> I<path>
781 806
782Specify the colon-delimited search path for finding background image files. 807Specify the colon-delimited search path for finding background image files.
783 808
910=item B<scrollstyle:> I<mode> 935=item B<scrollstyle:> I<mode>
911 936
912Set 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
913the author's favourite. 938the author's favourite.
914 939
940=item B<thickness:> I<number>
941
942Set the scrollbar width in pixels.
943
915=item B<scrollBar:> I<boolean> 944=item B<scrollBar:> I<boolean>
916 945
917B<True>: enable the scrollbar [default]; option B<-sb>. B<False>: 946B<True>: enable the scrollbar [default]; option B<-sb>. B<False>:
918disable the scrollbar; option B<+sb>. 947disable the scrollbar; option B<+sb>.
919 948
938B<False>: do not scroll to bottom when tty receives output; option 967B<False>: do not scroll to bottom when tty receives output; option
939B<+si>. 968B<+si>.
940 969
941=item B<scrollWithBuffer:> I<boolean> 970=item B<scrollWithBuffer:> I<boolean>
942 971
943B<True>: scroll with scrollback buffer when tty receives new lines (and 972B<True>: scroll with scrollback buffer when tty receives new lines (i.e.
944B<scrollTtyOutput> is False); option B<-sw>. B<False>: do not scroll 973try to show the same lines) and B<scrollTtyOutput> is False; option
945with 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>.
946 976
947=item B<scrollTtyKeypress:> I<boolean> 977=item B<scrollTtyKeypress:> I<boolean>
948 978
949B<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
950are those which are intercepted by rxvt-unicode for special handling and 980are those which are intercepted by rxvt-unicode for special handling and
1164performed in an exact manner; however, the closest match is assured. 1194performed in an exact manner; however, the closest match is assured.
1165 1195
1166I<string> may contain escape values (C<\n>: newline, C<\000>: octal 1196I<string> may contain escape values (C<\n>: newline, C<\000>: octal
1167number), see RESOURCES in C<man 7 X> for further details. 1197number), see RESOURCES in C<man 7 X> for further details.
1168 1198
1169You 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>
1170with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimiter `/' 1201with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimiter `/'
1171should be a character not used by the strings. 1202should be a character not used by the strings.
1172 1203
1173Its usage can be demonstrated by an example: 1204Its usage can be demonstrated by an example:
1174 1205
1175 URxvt.keysym.M-C-0x61: list|\033<M-C-|abc|> 1206 URxvt.keysym.M-C-0x61: list|\033<|abc|>
1176 1207
1177The above line is equivalent to the following three lines: 1208The above line is equivalent to the following three lines:
1178 1209
1179 URxvt.keysym.Meta-Control-0x61: \033<M-C-a> 1210 URxvt.keysym.Meta-Control-0x61: \033<a>
1180 URxvt.keysym.Meta-Control-0x62: \033<M-C-b> 1211 URxvt.keysym.Meta-Control-0x62: \033<b>
1181 URxvt.keysym.Meta-Control-0x63: \033<M-C-c> 1212 URxvt.keysym.Meta-Control-0x63: \033<c>
1182 1213
1183If 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>
1184is interpreted and executed as @@RXVT_NAME@@'s control sequence. For 1215is interpreted and executed as @@RXVT_NAME@@'s control sequence. For
1185example 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>
1186when Control-Meta-c is being pressed": 1217when Control-Meta-c is being pressed":
1259the @@RXVT_NAME@@perl(3) manpage. 1290the @@RXVT_NAME@@perl(3) manpage.
1260 1291
1261=item B<perl-lib>: I<path> 1292=item B<perl-lib>: I<path>
1262 1293
1263Colon-separated list of additional directories that hold extension 1294Colon-separated list of additional directories that hold extension
1264scripts. When looking for extensions specified by the C<perl> resource, 1295scripts. When looking for perl extensions, @@RXVT_NAME@@ will first look
1265@@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
1266F<@@RXVT_LIBDIR@@/urxvt/perl/>. 1297lastly in F<@@RXVT_LIBDIR@@/urxvt/perl/>.
1267 1298
1268See the @@RXVT_NAME@@perl(3) manpage. 1299See the @@RXVT_NAME@@perl(3) manpage.
1269 1300
1270=item B<< selection.pattern-I<idx> >>: I<perl-regex> 1301=item B<< selection.pattern-I<idx> >>: I<perl-regex>
1271 1302
1519White. 1550White.
1520 1551
1521=head2 ALPHA CHANNEL SUPPORT 1552=head2 ALPHA CHANNEL SUPPORT
1522 1553
1523If 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
1524their act together, rxvt-unicode will do it's own alpha channel management: 1555their act together, rxvt-unicode will do its own alpha channel management:
1525 1556
1526You can prefix any colour with an opaqueness percentage enclosed in 1557You can prefix any colour with an opaqueness percentage enclosed in
1527brackets, i.e. C<[percent]>, where C<percent> is a decimal percentage 1558brackets, i.e. C<[percent]>, where C<percent> is a decimal percentage
1528(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
1529transparent 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
1611 1642
1612=item B<SHELL> 1643=item B<SHELL>
1613 1644
1614The 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>.
1615 1646
1616=item B<RXVT_SOCKET> 1647=item B<RXVT_SOCKET> [I<sic>]
1617 1648
1618The unix domain socket path used by @@RXVT_NAME@@c(1) and 1649The unix domain socket path used by @@RXVT_NAME@@c(1) and
1619@@RXVT_NAME@@d(1). 1650@@RXVT_NAME@@d(1).
1620 1651
1621Default 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).
1622 1663
1623=item B<HOME> 1664=item B<HOME>
1624 1665
1625Used to locate the default directory for the unix domain socket for 1666Used to locate the default directory for the unix domain socket for
1626daemon communications and to locate various resource files (such as 1667daemon communications and to locate various resource files (such as
1627C<.Xdefaults>) 1668C<.Xdefaults>)
1628 1669
1629=item B<XAPPLRESDIR> 1670=item B<XAPPLRESDIR>
1630 1671
1631Directory where various X resource files are being located. 1672Directory where application-specific X resource files are located.
1632 1673
1633=item B<XENVIRONMENT> 1674=item B<XENVIRONMENT>
1634 1675
1635If 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
1636@@RXVT_NAME@@. 1677@@RXVT_NAME@@.
1647 1688
1648=back 1689=back
1649 1690
1650=head1 SEE ALSO 1691=head1 SEE ALSO
1651 1692
1652@@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) 1693@@RXVT_NAME@@(7), @@RXVT_NAME@@c(1), @@RXVT_NAME@@d(1), @@RXVT_NAME@@perl(3), xterm(1), sh(1), resize(1), X(1), pty(4), tty(4), utmp(5)
1653 1694
1654=head1 CURRENT PROJECT COORDINATOR 1695=head1 CURRENT PROJECT COORDINATOR
1655 1696
1656=over 4 1697=over 4
1657 1698
1702 1743
1703Project Coordinator (Changes 1.0 -) 1744Project Coordinator (Changes 1.0 -)
1704 1745
1705=item Emanuele Giaquinta L<< <e.giaquinta@glauco.it> >> 1746=item Emanuele Giaquinta L<< <e.giaquinta@glauco.it> >>
1706 1747
1707Pty/tty/utmp/wtmp rewrite, lots of random hacking and bugfixing. 1748pty/utmp code rewrite, image code improvements, many random hacks and bugfixes.
1708 1749
1709=back 1750=back
1710 1751

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines