updated docs to reflect changes in support for transparency and background images
authorsasha <sasha>
Thu, 20 Sep 2007 15:56:41 +0000 (15:56 +0000)
committersasha <sasha>
Thu, 20 Sep 2007 15:56:41 +0000 (15:56 +0000)
doc/rxvt.1.pod
doc/rxvt.7.pod

index 1b13215b5c0f214fee4b89f582299dcd6e78176e..7d513afac120666dbdc0bb5c9119afccc5784118 100644 (file)
@@ -121,9 +121,8 @@ Turn on/off skip scrolling (allow multiple screens per refresh); resource B<skip
 Turn on/off inheriting parent window's pixmap. Alternative form is
 B<-tr>; resource B<inheritPixmap>.
 
-I<Please note that transparency of any kind if completely unsupported by
-the author. Don't bug him with installation questions! Read the FAQ (man 7
-@@RXVT_NAME@@)!>
+I<Please address all transparency related issues to Sasha Vasko at 
+sasha@aftercode.net. Read the FAQ (man 7 @@RXVT_NAME@@)!>
 
 =item B<-fade> I<number>
 
@@ -709,7 +708,7 @@ other blending type, specified with B<-blt "type"> option.
 
 =item B<path:> I<path>
 
-Specify the colon-delimited search path for finding XPM files.
+Specify the colon-delimited search path for finding background image files.
 
 =item B<font:> I<fontlist>
 
@@ -1477,8 +1476,9 @@ resources or on the command line.
 =item B<COLORTERM>
 
 Either C<rxvt>, C<rxvt-xpm>, depending on whether @@RXVT_NAME@@ was
-compiled with XPM support, and optionally with the added extension
-C<-mono> to indicate that rxvt-unicode runs on a monochrome screen.
+compiled with background image support, and optionally with the added 
+extension C<-mono> to indicate that rxvt-unicode runs on a monochrome 
+screen.
 
 =item B<COLORFGBG>
 
@@ -1487,8 +1487,8 @@ the colour code used as default foreground/text colour (or the string
 C<default> to indicate that the default-colour escape sequence is to be
 used), C<bg> is the colour code used as default background colour (or the
 string C<default>), and C<xpm> is the string C<default> if @@RXVT_NAME@@
-was compiled with XPM support. Libraries like C<ncurses> and C<slang> can
-(and do) use this information to optimize screen output.
+was compiled with background image support. Libraries like C<ncurses> 
+and C<slang> can (and do) use this information to optimize screen output.
 
 =item B<WINDOWID>
 
index 4bd036ff92e7eea15e53a8f19baf50079fce5275..72a6f0d453dae005a20da9c30050ee8b33d8b1f9 100644 (file)
@@ -211,10 +211,9 @@ except maybe libX11 :)
 
 =head3 I can't get transparency working, what am I doing wrong?
 
-First of all, transparency isn't officially supported in rxvt-unicode, so
-you are mostly on your own. Do not bug the author about it (but you may
-bug everybody else). Also, if you can't get it working consider it a rite
-of passage: ... and you failed.
+First of all, please address all transparency related issues to Sasha Vasko at 
+sasha@aftercode.net and do not bug the author about it. Also, if you can't 
+get it working consider it a rite of passage: ... and you failed.
 
 Here are four ways to get transparency. B<Do> read the manpage and option
 descriptions for the programs mentioned and rxvt-unicode. Really, do it!
@@ -231,10 +230,10 @@ support, or you are unable to read.
 to use effects other than tinting and shading: Just shade/tint/whatever
 your picture with gimp or any other tool:
 
-   convert wallpaper.jpg -blur 20x20 -modulate 30 background.xpm
-   @@URXVT_NAME@@ -pixmap background.xpm -pe automove-background
+   convert wallpaper.jpg -blur 20x20 -modulate 30 background.jpg
+   @@URXVT_NAME@@ -pixmap background.jpg -pe automove-background
 
-That works. If you think it doesn't, you lack XPM and Perl support, or you
+That works. If you think it doesn't, you lack AfterImage and Perl support, or you
 are unable to read.
 
 3. Use an ARGB visual:
@@ -1991,7 +1990,7 @@ B<octet> can be escaped by prefixing it with SYN (0x16, ^V).
        B<< C<Ps = 17> >>       Change colour of highlight characters to B<< C<Pt> >>
        B<< C<Ps = 18> >>       Change colour of bold characters to B<< C<Pt> >> [deprecated, see 706]
        B<< C<Ps = 19> >>       Change colour of underlined characters to B<< C<Pt> >> [deprecated, see 707]
-       B<< C<Ps = 20> >>       Change background pixmap parameters (see section XPM) (Compile XPM).
+       B<< C<Ps = 20> >>       Change background pixmap parameters (see section BACKGROUND IMAGE) (Compile AfterImage).
        B<< C<Ps = 39> >>       Change default foreground colour to B<< C<Pt> >>.
        B<< C<Ps = 46> >>       Change Log File to B<< C<Pt> >> I<unimplemented>
        B<< C<Ps = 49> >>       Change default background colour to B<< C<Pt> >>.
@@ -2015,10 +2014,10 @@ B<octet> can be escaped by prefixing it with SYN (0x16, ^V).
 
 =back
 
-=head1 XPM
+=head1 BACKGROUND IMAGE
 
-For the XPM XTerm escape sequence B<< C<ESC ] 20 ; Pt ST> >> then value
-of B<< C<Pt> >> can be the name of the background pixmap followed by a
+For the BACGROUND IMAGE XTerm escape sequence B<< C<ESC ] 20 ; Pt ST> >> then value
+of B<< C<Pt> >> can be the name of the background image file followed by a
 sequence of scaling/positioning commands separated by semi-colons. The
 scaling/positioning commands are as follows:
 
@@ -2066,13 +2065,13 @@ For example:
 
 =over 4
 
-=item B<\E]20;funky\a>
+=item B<\E]20;funky.jpg\a>
 
-load B<funky.xpm> as a tiled image
+load B<funky.jpg> as a tiled image
 
-=item B<\E]20;mona;100\a>
+=item B<\E]20;mona.jpg;100\a>
 
-load B<mona.xpm> with a scaling of 100%
+load B<mona.jpg> with a scaling of 100%
 
 =item B<\E]20;;200;?\a>