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.139 by ayin, Wed Oct 17 13:53:42 2007 UTC vs.
Revision 1.146 by ayin, Mon Nov 19 09:41:09 2007 UTC

… …
114 114
115=item B<-ss>|B<+ss> 115=item B<-ss>|B<+ss>
116 116
117Turn on/off skip scrolling (allow multiple screens per refresh); resource B<skipScroll>. 117Turn on/off skip scrolling (allow multiple screens per refresh); resource B<skipScroll>.
118 118
119=item B<-ip>|B<+ip> | B<-tr>|B<+tr> 119=item B<-tr>|B<+tr>
120 120
121Turn on/off inheriting parent window's pixmap. Alternative form is 121Turn on/off illusion of a transparent window background. Obsolete form of it is
122B<-tr>; resource B<inheritPixmap>. 122B<-ip> and it should not be used anymore; resource B<transparent>.
123 123
124I<Please note that old resource name of B<inheritPixmap> is obsolete and should be
125changed to B<transparent>. Backwards compatibility support for B<inheritPixmap> will
126be phased out in future versions of rxvt!>
127
124I<Please address all transparency related issues to Sasha Vasko at 128I<Please address all transparency related issues to Sasha Vasko at
125sasha@aftercode.net. Read the FAQ (man 7 @@RXVT_NAME@@)!> 129sasha@aftercode.net. Read the FAQ (man 7 @@RXVT_NAME@@)!>
126 130
127=item B<-fade> I<number> 131=item B<-fade> I<number>
128 132
129Fade the text by the given percentage when focus is lost. Small values 133Fade the text by the given percentage when focus is lost. Small values
… …
136is opaque black. resource B<fadeColor>. 140is opaque black. resource B<fadeColor>.
137 141
138=item B<-tint> I<colour> 142=item B<-tint> I<colour>
139 143
140Tint the transparent background pixmap with the given colour when 144Tint the transparent background pixmap with the given colour when
141transparency is enabled with B<-tr> or B<-ip>. This only works for 145transparency is enabled with B<-tr>. This only works for
142non-tiled backgrounds, currently. See also the B<-sh> option that can be 146non-tiled backgrounds, currently. See also the B<-sh> option that can be
143used to brighten or darken the image in addition to tinting it. 147used to brighten or darken the image in addition to tinting it.
144Please note that certain tint colours can be applied on the server-side, 148Please note that certain tint colours can be applied on the server-side,
145thus yielding performance gain of two orders of magnitude. These colours are: 149thus yielding performance gain of two orders of magnitude. These colours are:
146blue, red, green, cyan, magenta, yellow, and those close to them; resource 150blue, red, green, cyan, magenta, yellow, and those close to them. Also
151pure black and pure white colors essentially mean no tinting; resource
147I<tintColor>. Example: 152I<tintColor>. Example:
148 153
149 @@RXVT_NAME@@ -tr -tint blue -sh 40 154 @@RXVT_NAME@@ -tr -tint blue -sh 40
150 155
151=item B<-sh> I<number> 156=item B<-sh> I<number>
152 157
153Darken (0 .. 100) or lighten (-1 .. -100) the transparent 158Darken (0 .. 100) or lighten (100 .. 200) the transparent
154background image in addition to (or instead of) tinting it; 159background image in addition to (or instead of) tinting it;
155resource I<shading>. 160resource I<shading>.
156 161
157=item B<-blt> I<string> 162=item B<-blt> I<string>
158 163
… …
160at the same time as transparency - such pixmap will be blended over 165at the same time as transparency - such pixmap will be blended over
161transparency image, using method specified. Supported values are : 166transparency image, using method specified. Supported values are :
162B<add>, B<alphablend>, B<allanon> - color values averaging, B<colorize>, 167B<add>, B<alphablend>, B<allanon> - color values averaging, B<colorize>,
163B<darken>, B<diff>, B<dissipate>, B<hue>, B<lighten>, B<overlay>, 168B<darken>, B<diff>, B<dissipate>, B<hue>, B<lighten>, B<overlay>,
164B<saturate>, B<screen>, B<sub>, B<tint>, B<value>. The default is 169B<saturate>, B<screen>, B<sub>, B<tint>, B<value>. The default is
165alpha-blending; resource I<blendType>. 170alpha-blending. Compile I<afterimage>; resource I<blendType>.
166 171
167=item B<-blr> I<HxV> 172=item B<-blr> I<HxV>
168 173
169Apply Gaussian Blur with the specified radii to the transparent 174Apply Gaussian Blur with the specified radii to the transparent
170background image. If single number is specified - both vertical and 175background image. If single number is specified - both vertical and
171horizontal radii are considered to be the same. Setting one of the 176horizontal radii are considered to be the same. Setting one of the
172radii to 1 and another to a large number creates interesting effects 177radii to 1 and another to a large number creates interesting effects
173on some backgrounds. Maximum radius value is 128; resource I<blurRadius>. 178on some backgrounds. Maximum radius value is 128. Compile I<afterimage>;
179resource I<blurRadius>.
174 180
175=item B<-bg> I<colour> 181=item B<-bg> I<colour>
176 182
177Window background colour; resource B<background>. 183Window background colour; resource B<background>.
178 184
179=item B<-fg> I<colour> 185=item B<-fg> I<colour>
180 186
181Window foreground colour; resource B<foreground>. 187Window foreground colour; resource B<foreground>.
182 188
183=item B<-pixmap> I<file[;geom]> 189=item B<-pixmap> I<file[;geom[:op1][:op2][...]]>
184 190
185Compile I<afterimage>: Specify image file for the background and also 191Compile I<afterimage>: Specify image file for the background and also
186optionally specify its scaling with a geometry string. Note you may need to 192optionally specify its scaling with a geometry string. Note you may need to
187add quotes to avoid special shell interpretation of the C<;> in the 193add quotes to avoid special shell interpretation of the C<;> in the
188command-line; for more details see resource B<backgroundPixmap>. 194command-line; for more details see resource B<backgroundPixmap>.
189 195
190=item B<-cr> I<colour> 196=item B<-cr> I<colour>
… …
670 676
671Specify background blending type; option B<-blt>. 677Specify background blending type; option B<-blt>.
672 678
673=item B<blurRadius:> I<number> 679=item B<blurRadius:> I<number>
674 680
675Apply Gaussian Blurr with the specified radius to the transparent 681Apply Gaussian Blurr with the specified radius to the transparent
676background image; option B<-blr>. 682background image; option B<-blr>.
677 683
678=item B<scrollColor:> I<colour> 684=item B<scrollColor:> I<colour>
679 685
680Use the specified colour for the scrollbar [default #B2B2B2]. 686Use the specified colour for the scrollbar [default #B2B2B2].
… …
687=item B<borderColor:> I<colour> 693=item B<borderColor:> I<colour>
688 694
689The colour of the border around the text area and between the scrollbar 695The colour of the border around the text area and between the scrollbar
690and the text. 696and the text.
691 697
692=item B<backgroundPixmap:> I<file[;geom]> 698=item B<backgroundPixmap:> I<file[;geom[:op1][:op2][...]]>
693 699
694Use the specified image file for the background and also optionally 700Use the specified image file for the background and also
695specify its scaling with a geometry string B<WxH+X+Y>, 701optionally specify its scaling with a geometry string B<WxH+X+Y>,
696in which B<"W" / "H"> specify the horizontal/vertical scale (percent), 702(default C<0x0+50+50>) in which B<"W" / "H"> specify the
697and B<"X" / "Y"> locate the image centre (percent). 703horizontal/vertical scale (percent), and B<"X" / "Y"> locate the image
698A scale of 0 displays the image with tiling. A scale of 1 displays the 704centre (percent). A scale of 0 displays the image with tiling. A scale
699image without any scaling. A scale of 2 to 9 specifies an integer 705of 1 displays the image without any scaling. A scale of 2 to 9 specifies
700number of images in that direction. No image will be magnified beyond 706an integer number of images in that direction. No image will be magnified
70110 times its original size. The maximum permitted scale is 1000. 707beyond 10 times its original size. The maximum permitted scale is 1000.
702Special string of B<"auto"> used as a geometry will cause image to be 708Additional operations can be specified after colon B<:op1:op2...>.
703automatically scaled to match window size. 709Supported operations are:
710
711 tile force background image to be tiled and not scaled. Equivalent to 0x0,
712 propscale will scale image keeping proportions,
713 auto will scale image to match window size. Equivalent to 100x100;
714 hscale will scale image horizontally to the window size;
715 vscale will scale image vertically to the window size;
716 scale will scale image to match window size;
717 root will tile image as if it was a root window background, auto-adjusting
718 whenever terminal window moves.
719
704If used in conjunction with B<-tr> option - specified pixmap will be 720If used in conjunction with B<-tr> option, the specified pixmap will be
705blended over transparency image using either alpha-blending, or any 721blended over transparency image using either alpha-blending, or any
706other blending type, specified with B<-blt "type"> option. 722other blending type, specified with B<-blt "type"> option.
707[default 0x0+50+50]
708 723
709=item B<path:> I<path> 724=item B<path:> I<path>
710 725
711Specify the colon-delimited search path for finding background image files. 726Specify the colon-delimited search path for finding background image files.
712 727
… …
985will be created). In this mode, characters outside ISO-8859-1 can be used. 1000will be created). In this mode, characters outside ISO-8859-1 can be used.
986 1001
987When the selection extension is not used, only ISO-8859-1 characters can 1002When the selection extension is not used, only ISO-8859-1 characters can
988be used. If not specified, the built-in default is used: 1003be used. If not specified, the built-in default is used:
989 1004
990B<< BACKSLASH `"'&()*,;<=>?@[]{|} >> 1005B<< BACKSLASH `"'&()*,;<=>?@[]^{|} >>
991 1006
992=item B<preeditType:> I<style> 1007=item B<preeditType:> I<style>
993 1008
994B<OverTheSpot>, B<OffTheSpot>, B<Root>; option B<-pt>. 1009B<OverTheSpot>, B<OffTheSpot>, B<Root>; option B<-pt>.
995 1010
… …
1465resources or on the command line. 1480resources or on the command line.
1466 1481
1467=item B<COLORTERM> 1482=item B<COLORTERM>
1468 1483
1469Either C<rxvt>, C<rxvt-xpm>, depending on whether @@RXVT_NAME@@ was 1484Either C<rxvt>, C<rxvt-xpm>, depending on whether @@RXVT_NAME@@ was
1470compiled with background image support, and optionally with the added 1485compiled with background image support, and optionally with the added
1471extension C<-mono> to indicate that rxvt-unicode runs on a monochrome 1486extension C<-mono> to indicate that rxvt-unicode runs on a monochrome
1472screen. 1487screen.
1473 1488
1474=item B<COLORFGBG> 1489=item B<COLORFGBG>
1475 1490
1476Set to a string of the form C<fg;bg> or C<fg;xpm;bg>, where C<fg> is 1491Set to a string of the form C<fg;bg> or C<fg;xpm;bg>, where C<fg> is
1477the colour code used as default foreground/text colour (or the string 1492the colour code used as default foreground/text colour (or the string
1478C<default> to indicate that the default-colour escape sequence is to be 1493C<default> to indicate that the default-colour escape sequence is to be
1479used), C<bg> is the colour code used as default background colour (or the 1494used), C<bg> is the colour code used as default background colour (or the
1480string C<default>), and C<xpm> is the string C<default> if @@RXVT_NAME@@ 1495string C<default>), and C<xpm> is the string C<default> if @@RXVT_NAME@@
1481was compiled with background image support. Libraries like C<ncurses> 1496was compiled with background image support. Libraries like C<ncurses>
1482and C<slang> can (and do) use this information to optimize screen output. 1497and C<slang> can (and do) use this information to optimize screen output.
1483 1498
1484=item B<WINDOWID> 1499=item B<WINDOWID>
1485 1500
1486Set to the (decimal) X Window ID of the @@RXVT_NAME@@ window (the toplevel 1501Set to the (decimal) X Window ID of the @@RXVT_NAME@@ window (the toplevel
… …
1578Project Coordinator (changes.txt 2.21a to 2.4.5) 1593Project Coordinator (changes.txt 2.21a to 2.4.5)
1579 1594
1580=item Geoff Wing L<< <gcw@pobox.com> >> 1595=item Geoff Wing L<< <gcw@pobox.com> >>
1581 1596
1582Rewrote screen display and text selection routines. 1597Rewrote screen display and text selection routines.
1583 1598
1584Project Coordinator (changes.txt 2.4.6 - rxvt-unicode) 1599Project Coordinator (changes.txt 2.4.6 - rxvt-unicode)
1585 1600
1586=item Marc Alexander Lehmann L<< <rxvt-unicode@schmorp.de> >> 1601=item Marc Alexander Lehmann L<< <rxvt-unicode@schmorp.de> >>
1587 1602
1588Forked rxvt-unicode, unicode support, rewrote almost all the code, perl 1603Forked rxvt-unicode, unicode support, rewrote almost all the code, perl

Diff Legend

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