14 .TH XScreenSaver 1 "17-Jun-99" "X Version 11"
16 webcollage - decorate the screen with random images from the web
19 [\-display \fIhost:display.screen\fP]
21 [\-window\-id \fIid\fP]
23 [\-timeout \fIsecs\fP]
25 [\-background \fIbg\fP]
28 [\-imagemap \fIfilename-base\fP]
30 [\-opacity \fIratio\fP]
31 [\-filter \fIcommand\fP]
32 [\-filter2 \fIcommand\fP]
33 [\-http\-proxy host[:port]]
34 [\-dictionary \fIdictionary-file\fP]
35 [\-driftnet [\fIcmd\fP]]
38 The \fIwebcollage\fP program pulls random image off of the World Wide Web
39 and scatters them on the root window. One satisfied customer described it
40 as "a nonstop pop culture brainbath." This program finds its images by
41 doing random web searches, and extracting images from the returned pages.
43 \fIwebcollage\fP is written in
47 It will be an order of magnitude faster if you also have
48 the \fIwebcollage-helper\fP program installed (a GDK/JPEG image
49 compositor), but \fIwebcollage\fP works without it as well.
51 \fIwebcollage\fP can be used in conjunction with the
53 program (the Unix equivalent of EtherPEG) to snoop images from traffic
54 on your local subnet, instead of getting images from search engines.
57 accepts the following options:
60 Draw on the root window. This option is mandatory, if output is being
61 produced: drawing to a window other than the root window is not yet
64 Images are placed on the root window by using one of the
65 .BR xscreensaver-getimage (1),
71 programs (whichever is available.)
73 .B \-window\-id \fIid\fP
74 Draw to the indicated window instead; this only works if the
75 .BR xscreensaver-getimage (1)
78 .B \-verbose \fRor\fP \-v
79 Print diagnostics to stderr. Multiple \fI-v\fP switches increase the
80 amount of output. \fI-v\fP will print out the URLs of the images,
81 and where they were placed; \fI-vv\fP will print out any warnings,
82 and all URLs being loaded; \fI-vvv\fP will print information on
83 what URLs were rejected; and so on.
85 .B \-timeout \fIseconds\fP
86 How long to wait for a URL to complete before giving up on it and
87 moving on to the next one.
90 .B \-delay \fIseconds\fP
91 How long to sleep between images. Default 2 seconds. (Remember that
92 this program probably spends a lot of time waiting for the network.)
94 .B \-background \fIcolor-or-ppm\fP
95 What to use for the background onto which images are pasted. This may be
96 a color name, a hexadecimal RGB specification in the form '#rrggbb', or
97 the name of a PPM file.
100 Normally, the output image will be made to be the size of the
101 screen (or target window.) This lets you specify the desired size.
103 .B \-opacity \fIratio\fP
104 How transparently to paste the images together, with 0.0 meaning
105 "completely transparent" and 1.0 meaning "opaque." Default 0.85.
106 A value of around 0.3 will produce an interestingly blurry image
110 If this option is specified, then no composite output image will be
111 generated. This is only useful when used in conjunction
112 with \fB\-verbose\fP.
115 If this option is specified, then no composite output image will be
116 generated: instead, a list of image URLs will be printed on stdout.
118 .B \-imagemap \fIfilename-base\fP
119 If this option is specified, then instead of writing an image to the
120 root window, two files will be created: "\fIbase\fP.html" and "\fIbase\fP.jpg".
121 The JPEG will be the collage; the HTML file will include that image, and
122 an image-map making the sub-images be linked to the pages on which they
123 were found (just like \fIhttp://www.jwz.org/webcollage/\fP.)
125 .B \-filter \fIcommand\fP
126 Filter all source images through this command. The command must take
127 a PPM file on stdin, and write a new PPM file to stdout. One good
128 choice for a filter would be:
130 webcollage -root -filter 'vidwhacker -stdin -stdout'
133 .B \-filter2 \fIcommand\fP
134 Filter the \fIcomposite\fP image through this command. The \fI-filter\fP
135 option applies to the sub-images; the \fI-filter2\fP applies to the
136 final, full-screen image.
138 .B \-http\-proxy \fIhost:port\fP
139 If you must go through a proxy to connect to the web, you can specify it
140 with this option, or with the \fB$http_proxy\fP or \fB$HTTP_PROXY\fP
141 environment variables.
143 .B \-dictionary \fIfile\fP
144 Webcollage normally looks at the system's default spell-check dictionary
145 to generate words to feed into the search engines. You can specify an
146 alternate dictionary with this option.
148 Note that by default, webcollage searches for images using several
149 different methods, not all of which involve dictionary words, so
150 using a "topical" dictionary file will not, in itself, be as effective
151 as you might be hoping.
153 .B \-driftnet \fI[ args ]\fP
155 is a program that snoops your local ethernet for packets that look
156 like they might be image files. It can be used in conjunction
157 with \fIwebcollage\fP to generate a collage of what other people on
158 your network are looking at, instead of a search-engine collage.
159 If you have \fIdriftnet\fP installed on your $PATH, just use
160 the \fI\-driftnet\fP option. You can also specify the location
161 of the program like this:
163 -driftnet /path/to/driftnet
165 or, you can provide extra arguments like this:
167 -driftnet '/path/to/driftnet -extra -args'
169 Driftnet version 0.1.5 or later is required. Note that
170 the \fIdriftnet\fP program requires root access, so you'll have
171 to make \fIdriftnet\fP be setuid-root for this to work.
172 Please exercise caution.
175 Display the current frame rate and CPU load.
180 to get the default host and display number.
183 to get the name of a resource file that overrides the global resources
184 stored in the RESOURCE_MANAGER property.
186 .B http_proxy\fR or \fPHTTP_PROXY
187 to get the default HTTP proxy host and port.
190 .I /usr/share/lib/dict/words,\fP
192 .I /usr/share/dict/words
193 to find the random words to feed to certain search engines.
195 \fIhttp://www.altavista.com/image/randomlink\fP,
196 \fIhttp://random.yahoo.com/fast/ryl\fP,
197 \fIhttp://www.livejournal.com/stats/latest-img.bml\fP, and
198 \fIhttp://www.google.com/\fP
199 to find random web pages.
201 The Internet being what it is, absolutely anything might show up in the
202 collage including -- quite possibly -- pornography, or even nudity.
204 Animating GIFs are not supported: only the first frame will be used.
206 The latest version of webcollage can be found as a part of
208 .B http://www.jwz.org/xscreensaver/,
209 or on the WebCollage page at
210 .B http://www.jwz.org/webcollage/.
213 .B http://www.ex-parrot.com/~chris/driftnet/
216 .BR xscreensaver (1),
228 .BR vidwhacker (MANSUFFIX),
234 Copyright \(co 1998-2005 by Jamie Zawinski. Permission to use, copy, modify,
235 distribute, and sell this software and its documentation for any purpose is
236 hereby granted without fee, provided that the above copyright notice appear
237 in all copies and that both that copyright notice and this permission notice
238 appear in supporting documentation. No representations are made about the
239 suitability of this software for any purpose. It is provided "as is" without
240 express or implied warranty.
242 Jamie Zawinski <jwz@jwz.org>, 24-May-1998.