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.140 by sasha, Fri Oct 26 18:27:29 2007 UTC vs.
Revision 1.145 by root, Fri Nov 16 11:14:12 2007 UTC

… …
119=item B<-tr>|B<+tr> 119=item B<-tr>|B<+tr>
120 120
121Turn on/off illusion of a transparent window background. Obsolete form of it is 121Turn on/off illusion of a transparent window background. Obsolete form of it is
122B<-ip> and it should not be used anymore; resource B<transparent>. 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 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 125changed to B<transparent>. Backwards compatibility support for B<inheritPixmap> will
126be phased out in future versions of rxvt!> 126be phased out in future versions of rxvt!>
127 127
128I<Please address all transparency related issues to Sasha Vasko at 128I<Please address all transparency related issues to Sasha Vasko at
129sasha@aftercode.net. Read the FAQ (man 7 @@RXVT_NAME@@)!> 129sasha@aftercode.net. Read the FAQ (man 7 @@RXVT_NAME@@)!>
130 130
131=item B<-fade> I<number> 131=item B<-fade> I<number>
132 132
133Fade 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
… …
145transparency is enabled with B<-tr>. This only works for 145transparency is enabled with B<-tr>. This only works for
146non-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
147used to brighten or darken the image in addition to tinting it. 147used to brighten or darken the image in addition to tinting it.
148Please 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,
149thus yielding performance gain of two orders of magnitude. These colours are: 149thus yielding performance gain of two orders of magnitude. These colours are:
150blue, 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
151I<tintColor>. Example: 152I<tintColor>. Example:
152 153
153 @@RXVT_NAME@@ -tr -tint blue -sh 40 154 @@RXVT_NAME@@ -tr -tint blue -sh 40
154 155
155=item B<-sh> I<number> 156=item B<-sh> I<number>
156 157
157Darken (0 .. 100) or lighten (-1 .. -100) the transparent 158Darken (0 .. 100) or lighten (100 .. 200) the transparent
158background image in addition to (or instead of) tinting it; 159background image in addition to (or instead of) tinting it;
159resource I<shading>. 160resource I<shading>.
160 161
161=item B<-blt> I<string> 162=item B<-blt> I<string>
162 163
… …
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]> 189=item B<-pixmap> I<file[;geom[:op1][:op2][...]]>
189 190
190Compile I<afterimage>: Specify image file for the background and also 191Compile I<afterimage>: Specify image file for the background and also
191optionally 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
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>
… …
675 676
676Specify background blending type; option B<-blt>. 677Specify background blending type; option B<-blt>.
677 678
678=item B<blurRadius:> I<number> 679=item B<blurRadius:> I<number>
679 680
680Apply Gaussian Blurr with the specified radius to the transparent 681Apply Gaussian Blurr with the specified radius to the transparent
681background image; option B<-blr>. 682background image; option B<-blr>.
682 683
683=item B<scrollColor:> I<colour> 684=item B<scrollColor:> I<colour>
684 685
685Use the specified colour for the scrollbar [default #B2B2B2]. 686Use the specified colour for the scrollbar [default #B2B2B2].
… …
692=item B<borderColor:> I<colour> 693=item B<borderColor:> I<colour>
693 694
694The 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
695and the text. 696and the text.
696 697
697=item B<backgroundPixmap:> I<file[;geom]> 698=item B<backgroundPixmap:> I<file[;geom[:op1][:op2][...]]>
698 699
699Use the specified image file for the background and also optionally 700Use the specified image file for the background and also
700specify its scaling with a geometry string B<WxH+X+Y>, 701optionally specify its scaling with a geometry string B<WxH+X+Y>,
701in which B<"W" / "H"> specify the horizontal/vertical scale (percent), 702(default C<0x0+50+50>) in which B<"W" / "H"> specify the
702and B<"X" / "Y"> locate the image centre (percent). 703horizontal/vertical scale (percent), and B<"X" / "Y"> locate the image
703A 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
704image 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
705number of images in that direction. No image will be magnified beyond 706an integer number of images in that direction. No image will be magnified
70610 times its original size. The maximum permitted scale is 1000. 707beyond 10 times its original size. The maximum permitted scale is 1000.
707Special string of B<"auto"> used as a geometry will cause image to be 708Additional operations can be specified after colon B<:op1:op2...>.
708automatically 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
709If used in conjunction with B<-tr> option - specified pixmap will be 720If used in conjunction with B<-tr> option, the specified pixmap will be
710blended over transparency image using either alpha-blending, or any 721blended over transparency image using either alpha-blending, or any
711other blending type, specified with B<-blt "type"> option. 722other blending type, specified with B<-blt "type"> option.
712[default 0x0+50+50]
713 723
714=item B<path:> I<path> 724=item B<path:> I<path>
715 725
716Specify the colon-delimited search path for finding background image files. 726Specify the colon-delimited search path for finding background image files.
717 727
… …
1470resources or on the command line. 1480resources or on the command line.
1471 1481
1472=item B<COLORTERM> 1482=item B<COLORTERM>
1473 1483
1474Either C<rxvt>, C<rxvt-xpm>, depending on whether @@RXVT_NAME@@ was 1484Either C<rxvt>, C<rxvt-xpm>, depending on whether @@RXVT_NAME@@ was
1475compiled with background image support, and optionally with the added 1485compiled with background image support, and optionally with the added
1476extension C<-mono> to indicate that rxvt-unicode runs on a monochrome 1486extension C<-mono> to indicate that rxvt-unicode runs on a monochrome
1477screen. 1487screen.
1478 1488
1479=item B<COLORFGBG> 1489=item B<COLORFGBG>
1480 1490
1481Set 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
1482the colour code used as default foreground/text colour (or the string 1492the colour code used as default foreground/text colour (or the string
1483C<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
1484used), 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
1485string 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@@
1486was compiled with background image support. Libraries like C<ncurses> 1496was compiled with background image support. Libraries like C<ncurses>
1487and 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.
1488 1498
1489=item B<WINDOWID> 1499=item B<WINDOWID>
1490 1500
1491Set 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
… …
1583Project Coordinator (changes.txt 2.21a to 2.4.5) 1593Project Coordinator (changes.txt 2.21a to 2.4.5)
1584 1594
1585=item Geoff Wing L<< <gcw@pobox.com> >> 1595=item Geoff Wing L<< <gcw@pobox.com> >>
1586 1596
1587Rewrote screen display and text selection routines. 1597Rewrote screen display and text selection routines.
1588 1598
1589Project Coordinator (changes.txt 2.4.6 - rxvt-unicode) 1599Project Coordinator (changes.txt 2.4.6 - rxvt-unicode)
1590 1600
1591=item Marc Alexander Lehmann L<< <rxvt-unicode@schmorp.de> >> 1601=item Marc Alexander Lehmann L<< <rxvt-unicode@schmorp.de> >>
1592 1602
1593Forked 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