From http://www.jwz.org/xscreensaver/xscreensaver-5.35.tar.gz
[xscreensaver] / hacks / webcollage.man
index 51dbb18a1c0e633aa6840d15d77fdf739bf28f6d..335aa3f65133fcec4fd971ad4adc635c2222c8fb 100644 (file)
@@ -18,32 +18,28 @@ webcollage - decorate the screen with random images from the web
 .B webcollage
 [\-display \fIhost:display.screen\fP]
 [\-root]
+[\-window\-id \fIid\fP]
 [\-verbose]
 [\-timeout \fIsecs\fP]
 [\-delay \fIsecs\fP]
 [\-background \fIbg\fP]
 [\-no-output]
 [\-urls-only]
+[\-imagemap \fIfilename-base\fP]
 [\-size \fIWxH\fP]
+[\-opacity \fIratio\fP]
 [\-filter \fIcommand\fP]
 [\-filter2 \fIcommand\fP]
 [\-http\-proxy host[:port]]
 [\-dictionary \fIdictionary-file\fP]
 [\-driftnet [\fIcmd\fP]]
+[\-directory \fIdir\fP]
+[\-fps]
 .SH DESCRIPTION
 The \fIwebcollage\fP program pulls random image off of the World Wide Web
 and scatters them on the root window.  One satisfied customer described it
 as "a nonstop pop culture brainbath."  This program finds its images by
 doing random web searches, and extracting images from the returned pages.
-It places the images on the root window by using the
-.BR giftopnm (1),
-.BR djpeg (1),
-and
-.BR xli (1),
-.BR xv (1),
-or
-.BR xloadimage (1)
-tools.
 
 \fIwebcollage\fP is written in
 .BR perl (1)
@@ -52,14 +48,33 @@ and requires Perl 5.
 It will be an order of magnitude faster if you also have
 the \fIwebcollage-helper\fP program installed (a GDK/JPEG image
 compositor), but \fIwebcollage\fP works without it as well.
+
+\fIwebcollage\fP can be used in conjunction with the
+.BR driftnet (1)
+program (the Unix equivalent of EtherPEG) to snoop images from traffic
+on your local subnet, instead of getting images from search engines.
 .SH OPTIONS
 .I webcollage
 accepts the following options:
 .TP 8
 .B \-root
-Draw on the root window.  This option is manditory, if output is being
+Draw on the root window.  This option is mandatory, if output is being
 produced: drawing to a window other than the root window is not yet
 supported.
+
+Images are placed on the root window by using one of the
+.BR xscreensaver-getimage (1),
+.BR chbg (1),
+.BR xv (1),
+.BR xli (1),
+or
+.BR xloadimage (1)
+programs (whichever is available.)
+.TP 8
+.B \-window\-id \fIid\fP
+Draw to the indicated window instead; this only works if the
+.BR xscreensaver-getimage (1)
+program is installed.
 .TP 8
 .B \-verbose \fRor\fP \-v
 Print diagnostics to stderr.  Multiple \fI-v\fP switches increase the
@@ -83,8 +98,14 @@ a color name, a hexadecimal RGB specification in the form '#rrggbb', or
 the name of a PPM file.
 .TP 8
 .B \-size \fIWxH\fP
-Normally, the output image will be made to be the size of the screen.
-This lets you specify the desired size.
+Normally, the output image will be made to be the size of the
+screen (or target window.)  This lets you specify the desired size.
+.TP 8
+.B \-opacity \fIratio\fP
+How transparently to paste the images together, with 0.0 meaning
+"completely transparent" and 1.0 meaning "opaque."  Default 0.85.
+A value of around 0.3 will produce an interestingly blurry image
+after a while.
 .TP 8
 .B \-no-output
 If this option is specified, then no composite output image will be
@@ -95,6 +116,13 @@ with \fB\-verbose\fP.
 If this option is specified, then no composite output image will be
 generated: instead, a list of image URLs will be printed on stdout.
 .TP 8
+.B \-imagemap \fIfilename-base\fP
+If this option is specified, then instead of writing an image to the
+root window, two files will be created: "\fIbase\fP.html" and "\fIbase\fP.jpg".
+The JPEG will be the collage; the HTML file will include that image, and
+an image-map making the sub-images be linked to the pages on which they
+were found (just like \fIhttps://www.jwz.org/webcollage/\fP.)
+.TP 8
 .B \-filter \fIcommand\fP
 Filter all source images through this command.  The command must take
 a PPM file on stdin, and write a new PPM file to stdout.  One good 
@@ -117,6 +145,11 @@ environment variables.
 Webcollage normally looks at the system's default spell-check dictionary
 to generate words to feed into the search engines.  You can specify an
 alternate dictionary with this option.
+
+Note that by default, webcollage searches for images using several
+different methods, not all of which involve dictionary words, so
+using a "topical" dictionary file will not, in itself, be as effective
+as you might be hoping.
 .TP 8
 .B \-driftnet \fI[ args ]\fP
 .BR driftnet (1)
@@ -138,6 +171,13 @@ Driftnet version 0.1.5 or later is required.  Note that
 the \fIdriftnet\fP program requires root access, so you'll have
 to make \fIdriftnet\fP be setuid-root for this to work.
 Please exercise caution.
+.TP 8
+.B \-directory \fIdir\fP
+Instead of searching the web for images, use the contents of
+the given directory.
+.TP 8
+.B \-fps
+Display the current frame rate and CPU load (MacOS only).
 .SH ENVIRONMENT
 .PP
 .TP 8
@@ -151,24 +191,31 @@ stored in the RESOURCE_MANAGER property.
 .B http_proxy\fR or \fPHTTP_PROXY
 to get the default HTTP proxy host and port.
 .SH FILES AND URLS
-.TP
-.I /usr/dict/words \fRor\fP /usr/share/lib/dict/words \fRor\fP /usr/share/dict/words
-To find the random words to feed to search engines.
-.PP
-.I http://random.yahoo.com/bin/ryl, http://image.altavista.com/
-To find random web pages.
-.SH BUGS
-When drawing on the root window, it always uses the default colormap.
-This is actually a limitation of xv.  But regardless, when using this
-program with xscreensaver, it must be given the \fBdefault-n\fP 
-visual specification (see the
-.BR xscreensaver (1)
-manual for more details.)
+.I /usr/dict/words,
+.I /usr/share/lib/dict/words,\fP
+or
+.I /usr/share/dict/words
+to find the random words to feed to certain search engines.
 
-Animating GIFs are not supported.
+    \fIhttp://www.altavista.com/image/randomlink\fP,
+    \fIhttp://random.yahoo.com/fast/ryl\fP,
+    \fIhttp://www.livejournal.com/stats/latest-img.bml\fP, and
+    \fIhttp://www.google.com/\fP
+to find random web pages.
+.SH BOOBIES
+The Internet being what it is, absolutely anything might show up in the
+collage including -- quite possibly -- pornography, or even nudity.
+.SH BUGS
+Animating GIFs are not supported: only the first frame will be used.
+.SH UPGRADES
+The latest version of webcollage can be found as a part of
+xscreensaver, at 
+.B https://www.jwz.org/xscreensaver/,
+or on the WebCollage page at 
+.B https://www.jwz.org/webcollage/.
 
-Too many of the images that it finds are text, not pictures.  This is 
-because most of the web is pictures of text.  Which is pretty sad.
+DriftNet:
+.B http://www.ex-parrot.com/~chris/driftnet/
 .SH SEE ALSO
 .BR X (1),
 .BR xscreensaver (1),
@@ -183,16 +230,18 @@ because most of the web is pictures of text.  Which is pretty sad.
 .BR cjpeg (1),
 .BR xdpyinfo (1),
 .BR perl (1),
-.BR vidwhacker (1),
+.BR vidwhacker (MANSUFFIX),
 .BR dadadodo (1),
 .BR driftnet (1)
+.BR EtherPEG ,
+.BR EtherPeek
 .SH COPYRIGHT
-Copyright \(co 1998-2002 by Jamie Zawinski.  Permission to use, copy, modify, 
-distribute, and sell this software and its documentation for any purpose is 
-hereby granted without fee, provided that the above copyright notice appear 
+Copyright \(co 1998-2005 by Jamie Zawinski.  Permission to use, copy, modify,
+distribute, and sell this software and its documentation for any purpose is
+hereby granted without fee, provided that the above copyright notice appear
 in all copies and that both that copyright notice and this permission notice
-appear in supporting documentation.  No representations are made about the 
+appear in supporting documentation.  No representations are made about the
 suitability of this software for any purpose.  It is provided "as is" without
 express or implied warranty.
 .SH AUTHOR
-Jamie Zawinski <jwz@jwz.org>, 24-May-98.
+Jamie Zawinski <jwz@jwz.org>, 24-May-1998.