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.190 by sf-exg, Thu Dec 9 10:03:56 2010 UTC vs.
Revision 1.212 by sf-exg, Sun Jan 1 14:31:28 2012 UTC

163alpha-blending. Compile I<afterimage>; resource I<blendType>. 163alpha-blending. Compile I<afterimage>; resource I<blendType>.
164 164
165=item B<-blr> I<HxV> 165=item B<-blr> I<HxV>
166 166
167Apply Gaussian Blur with the specified radii to the transparent 167Apply Gaussian Blur with the specified radii to the transparent
168background. If a single number is specified - both vertical and 168background. If a single number is specified, the vertical and
169horizontal radii are considered to be the same. Setting one of the 169horizontal radii are considered to be the same. Setting one of the
170radii to 1 and another to a large number creates interesting effects 170radii to 1 and the other to a large number creates interesting effects
171on some backgrounds. Maximum radius value is 128; 171on some backgrounds. The maximum radius value is 128. An horizontal or
172vertical radius of 0 disables blurring;
172resource I<blurRadius>. 173resource I<blurRadius>.
173 174
174=item B<-icon> I<file> 175=item B<-icon> I<file>
175 176
176Compile I<afterimage> or I<pixbuf>: Use the specified image as application icon. This 177Compile I<afterimage> or I<pixbuf>: Use the specified image as application icon. This
183 184
184=item B<-fg> I<colour> 185=item B<-fg> I<colour>
185 186
186Window foreground colour; resource B<foreground>. 187Window foreground colour; resource B<foreground>.
187 188
188=item B<-pixmap> I<file[;geom[:op1][:op2][...]]> 189=item B<-pixmap> I<file[;oplist]>
189 190
190Compile I<afterimage> or I<pixbuf>: Specify image file for the background and also 191Compile I<afterimage> or I<pixbuf>: Specify image file for the background and also
191optionally specify its scaling with a geometry string. Note you may need to 192optionally specify a list of operations to modify it. Note you may need to
192add quotes to avoid special shell interpretation of the C<;> in the 193add quotes to avoid special shell interpretation of the C<;> in the
193command-line; for more details see resource B<backgroundPixmap>. 194command-line; for more details see resource B<backgroundPixmap>.
194 195
195=item B<-cr> I<colour> 196=item B<-cr> I<colour>
196 197
558You can set and change the resources using X11 tools like B<xrdb>. Many 559You 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 560distribution do also load settings from the B<~/.Xresources> file when X
560starts. @@RXVT_NAME@@ will consult the following files/resources in order, 561starts. @@RXVT_NAME@@ will consult the following files/resources in order,
561with later settings overwriting earlier ones: 562with later settings overwriting earlier ones:
562 563
563 1. system-wide app-defaults file, either locale-dependent OR global
564 2. app-defaults file in $XAPPLRESDIR 564 1. app-defaults file in $XAPPLRESDIR
565 2. $HOME/.Xdefaults
565 3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults 566 3. RESOURCE_MANAGER property on root-window of screen 0
566 4. SCREEN_RESOURCES for the current screen 567 4. SCREEN_RESOURCES property on root-window of the current screen
567 5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename> 568 5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename>
568 6. resources specified via -xrm on the commandline 569 6. resources specified via -xrm on the commandline
569 570
570Note that when reading X resources, B<@@RXVT_NAME@@> recognizes two class 571Note that when reading X resources, B<@@RXVT_NAME@@> recognizes two class
571names: B<Rxvt> and B<URxvt>. The class name B<Rxvt> allows resources 572names: B<Rxvt> and B<URxvt>. The class name B<Rxvt> allows resources
743=item B<borderColor:> I<colour> 744=item B<borderColor:> I<colour>
744 745
745The colour of the border around the text area and between the scrollbar 746The colour of the border around the text area and between the scrollbar
746and the text. 747and the text.
747 748
748=item B<backgroundPixmap:> I<file[;geom[:op1][:op2][...]]> 749=item B<backgroundPixmap:> I<file[;oplist]>
749 750
750Use the specified image file for the background and also 751Use the specified image file for the background and also
751optionally specify its scaling with a geometry string B<WxH+X+Y>, 752optionally specify a colon separated list of operations to modify it.
752(default C<100x100+50+50>) in which B<"W" / "H"> specify the
753horizontal/vertical scale (percent), and B<"X" / "Y"> locate the image
754centre (percent). A scale of 0 displays the image with tiling.
755The maximum permitted scale is 1000.
756Additional operations can be specified after colon B<:op1:op2...>.
757Supported operations are: 753Supported operations are:
758 754
759 tile force background image to be tiled and not scaled. Equivalent to 0x0 755=over 4
760 propscale will scale image keeping proportions 756
761 auto will scale image to match window size. Equivalent to 100x100 757=item B<WxH+X+Y>
762 hscale will scale image horizontally to the window size 758
763 vscale will scale image vertically to the window size 759sets scale and position. B<"W" / "H"> specify the horizontal/vertical
764 scale will scale image to match window size 760scale (percent), and B<"X" / "Y"> locate the image centre (percent). A
765 root will tile image as if it was a root window background, auto-adjusting 761scale of 0 disables scaling. The maximum permitted scale is 1000.
766 whenever terminal window moves 762
763=item B<op=tile>
764
765enables tiling
766
767=item B<op=keep-aspect>
768
769maintain the image aspect ratio when scaling
770
771=item B<op=root-align>
772
773use the position of the terminal window relative to the root window as
774the image offset, simulating a root window background
775
776=back
777
778The default scale and position setting is C<100x100+50+50>.
779Alternatively, a predefined set of templates can be used to achieve
780the most common setups:
781
782=over 4
783
784=item B<style=tiled>
785
786the image is tiled with no scaling. Equivalent to 0x0+0+0:op=tile
787
788=item B<style=aspect-stretched>
789
790the image is scaled to fill the whole window maintaining the aspect
791ratio and centered. Equivalent to 100x100+50+50:op=keep-aspect
792
793=item B<style=stretched>
794
795the image is scaled to fill the whole window. Equivalent to 100x100
796
797=item B<style=centered>
798
799the image is centered with no scaling. Equivalent to 0x0+50+50
800
801=item B<style=root-tiled>
802
803the image is tiled with no scaling and using 'root' positioning.
804Equivalent to 0x0:op=tile:op=root-align
805
806=back
807
808If multiple templates are specified the last one wins. Note that a
809template overrides all the scale, position and operations settings.
767 810
768If used in conjunction with B<-tr> option, the specified pixmap will be 811If used in conjunction with B<-tr> option, the specified pixmap will be
769blended over the transparent background using alpha-blending. If I<afterimage> 812blended over the transparent background using alpha-blending. If I<afterimage>
770support has been compiled in it is possible to choose other blending 813support has been compiled in it is possible to choose other blending
771types with B<-blt "type"> option. 814types with B<-blt "type"> option.
903=item B<scrollstyle:> I<mode> 946=item B<scrollstyle:> I<mode>
904 947
905Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is 948Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is
906the author's favourite. 949the author's favourite.
907 950
951=item B<thickness:> I<number>
952
953Set the scrollbar width in pixels.
954
908=item B<scrollBar:> I<boolean> 955=item B<scrollBar:> I<boolean>
909 956
910B<True>: enable the scrollbar [default]; option B<-sb>. B<False>: 957B<True>: enable the scrollbar [default]; option B<-sb>. B<False>:
911disable the scrollbar; option B<+sb>. 958disable the scrollbar; option B<+sb>.
912 959
931B<False>: do not scroll to bottom when tty receives output; option 978B<False>: do not scroll to bottom when tty receives output; option
932B<+si>. 979B<+si>.
933 980
934=item B<scrollWithBuffer:> I<boolean> 981=item B<scrollWithBuffer:> I<boolean>
935 982
936B<True>: scroll with scrollback buffer when tty receives new lines (and 983B<True>: scroll with scrollback buffer when tty receives new lines (i.e.
937B<scrollTtyOutput> is False); option B<-sw>. B<False>: do not scroll 984try to show the same lines) and B<scrollTtyOutput> is False; option
938with scrollback buffer when tty receives new lines; option B<+sw>. 985B<-sw>. B<False>: do not scroll with scrollback buffer when tty receives
986new lines; option B<+sw>.
939 987
940=item B<scrollTtyKeypress:> I<boolean> 988=item B<scrollTtyKeypress:> I<boolean>
941 989
942B<True>: scroll to bottom when a non-special key is pressed. Special keys 990B<True>: scroll to bottom when a non-special key is pressed. Special keys
943are those which are intercepted by rxvt-unicode for special handling and 991are those which are intercepted by rxvt-unicode for special handling and
1157performed in an exact manner; however, the closest match is assured. 1205performed in an exact manner; however, the closest match is assured.
1158 1206
1159I<string> may contain escape values (C<\n>: newline, C<\000>: octal 1207I<string> may contain escape values (C<\n>: newline, C<\000>: octal
1160number), see RESOURCES in C<man 7 X> for further details. 1208number), see RESOURCES in C<man 7 X> for further details.
1161 1209
1162You can define a range of keysyms in one shot by providing a I<string> 1210You can define a range of keysyms in one shot by
1211loading the C<keysym-list> perl extension and providing a I<string>
1163with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimiter `/' 1212with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimiter `/'
1164should be a character not used by the strings. 1213should be a character not used by the strings.
1165 1214
1166Its usage can be demonstrated by an example: 1215Its usage can be demonstrated by an example:
1167 1216
1168 URxvt.keysym.M-C-0x61: list|\033<M-C-|abc|> 1217 URxvt.keysym.M-C-0x61: list|\033<|abc|>
1169 1218
1170The above line is equivalent to the following three lines: 1219The above line is equivalent to the following three lines:
1171 1220
1172 URxvt.keysym.Meta-Control-0x61: \033<M-C-a> 1221 URxvt.keysym.Meta-Control-0x61: \033<a>
1173 URxvt.keysym.Meta-Control-0x62: \033<M-C-b> 1222 URxvt.keysym.Meta-Control-0x62: \033<b>
1174 URxvt.keysym.Meta-Control-0x63: \033<M-C-c> 1223 URxvt.keysym.Meta-Control-0x63: \033<c>
1175 1224
1176If I<string> takes the form of C<command:STRING>, the specified B<STRING> 1225If I<string> takes the form of C<command:STRING>, the specified B<STRING>
1177is interpreted and executed as @@RXVT_NAME@@'s control sequence. For 1226is interpreted and executed as @@RXVT_NAME@@'s control sequence. For
1178example the following means "change the current locale to C<zh_CN.GBK> 1227example the following means "change the current locale to C<zh_CN.GBK>
1179when Control-Meta-c is being pressed": 1228when Control-Meta-c is being pressed":
1252the @@RXVT_NAME@@perl(3) manpage. 1301the @@RXVT_NAME@@perl(3) manpage.
1253 1302
1254=item B<perl-lib>: I<path> 1303=item B<perl-lib>: I<path>
1255 1304
1256Colon-separated list of additional directories that hold extension 1305Colon-separated list of additional directories that hold extension
1257scripts. When looking for extensions specified by the C<perl> resource, 1306scripts. When looking for perl extensions, @@RXVT_NAME@@ will first
1258@@RXVT_NAME@@ will first look in these directories and then in 1307look in these directories, then in $HOME/.urxvt/ext and lastly in
1259F<@@RXVT_LIBDIR@@/urxvt/perl/>. 1308F<@@RXVT_LIBDIR@@/urxvt/perl/>.
1260 1309
1261See the @@RXVT_NAME@@perl(3) manpage. 1310See the @@RXVT_NAME@@perl(3) manpage.
1262 1311
1263=item B<< selection.pattern-I<idx> >>: I<perl-regex> 1312=item B<< selection.pattern-I<idx> >>: I<perl-regex>
1512White. 1561White.
1513 1562
1514=head2 ALPHA CHANNEL SUPPORT 1563=head2 ALPHA CHANNEL SUPPORT
1515 1564
1516If Xft support has been compiled in and as long as Xft/Xrender/X don't get 1565If Xft support has been compiled in and as long as Xft/Xrender/X don't get
1517their act together, rxvt-unicode will do it's own alpha channel management: 1566their act together, rxvt-unicode will do its own alpha channel management:
1518 1567
1519You can prefix any colour with an opaqueness percentage enclosed in 1568You can prefix any colour with an opaqueness percentage enclosed in
1520brackets, i.e. C<[percent]>, where C<percent> is a decimal percentage 1569brackets, i.e. C<[percent]>, where C<percent> is a decimal percentage
1521(0-100) that specifies the opacity of the colour, where C<0> is completely 1570(0-100) that specifies the opacity of the colour, where C<0> is completely
1522transparent and C<100> is completely opaque. For example, C<[50]red> is a 1571transparent and C<100> is completely opaque. For example, C<[50]red> is a
1609=item B<RXVT_SOCKET> 1658=item B<RXVT_SOCKET>
1610 1659
1611The unix domain socket path used by @@RXVT_NAME@@c(1) and 1660The unix domain socket path used by @@RXVT_NAME@@c(1) and
1612@@RXVT_NAME@@d(1). 1661@@RXVT_NAME@@d(1).
1613 1662
1614Default F<<< $HOME/.rxvt-unicode-I<< <nodename >> >>>. 1663Default F<<< $HOME/.urxvt/urxvtd-I<< <nodename> >> >>>.
1615 1664
1616=item B<HOME> 1665=item B<HOME>
1617 1666
1618Used to locate the default directory for the unix domain socket for 1667Used to locate the default directory for the unix domain socket for
1619daemon communications and to locate various resource files (such as 1668daemon communications and to locate various resource files (such as
1620C<.Xdefaults>) 1669C<.Xdefaults>)
1621 1670
1622=item B<XAPPLRESDIR> 1671=item B<XAPPLRESDIR>
1623 1672
1624Directory where various X resource files are being located. 1673Directory where application-specific X resource files are located.
1625 1674
1626=item B<XENVIRONMENT> 1675=item B<XENVIRONMENT>
1627 1676
1628If set and accessible, gives the name of a X resource file to be loaded by 1677If set and accessible, gives the name of a X resource file to be loaded by
1629@@RXVT_NAME@@. 1678@@RXVT_NAME@@.
1695 1744
1696Project Coordinator (Changes 1.0 -) 1745Project Coordinator (Changes 1.0 -)
1697 1746
1698=item Emanuele Giaquinta L<< <e.giaquinta@glauco.it> >> 1747=item Emanuele Giaquinta L<< <e.giaquinta@glauco.it> >>
1699 1748
1700Pty/tty/utmp/wtmp rewrite, lots of random hacking and bugfixing. 1749pty/utmp code rewrite, image code improvements, many random hacks and bugfixes.
1701 1750
1702=back 1751=back
1703 1752

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines