http://packetstormsecurity.org/UNIX/admin/xscreensaver-4.04.2.tar.gz
[xscreensaver] / hacks / webcollage.man
1 .de EX          \"Begin example
2 .ne 5
3 .if n .sp 1
4 .if t .sp .5
5 .nf
6 .in +.5i
7 ..
8 .de EE
9 .fi
10 .in -.5i
11 .if n .sp 1
12 .if t .sp .5
13 ..
14 .TH XScreenSaver 1 "17-Jun-99" "X Version 11"
15 .SH NAME
16 webcollage - decorate the screen with random images from the web
17 .SH SYNOPSIS
18 .B webcollage
19 [\-display \fIhost:display.screen\fP]
20 [\-root]
21 [\-verbose]
22 [\-timeout \fIsecs\fP]
23 [\-delay \fIsecs\fP]
24 [\-background \fIbg\fP]
25 [\-no-output]
26 [\-urls-only]
27 [\-size \fIWxH\fP]
28 [\-filter \fIcommand\fP]
29 [\-filter2 \fIcommand\fP]
30 [\-http\-proxy host[:port]]
31 [\-dictionary \fIdictionary-file\fP]
32 [\-driftnet [\fIcmd\fP]]
33 .SH DESCRIPTION
34 The \fIwebcollage\fP program pulls random image off of the World Wide Web
35 and scatters them on the root window.  One satisfied customer described it
36 as "a nonstop pop culture brainbath."  This program finds its images by
37 doing random web searches, and extracting images from the returned pages.
38 It places the images on the root window by using the
39 .BR giftopnm (1),
40 .BR djpeg (1),
41 and
42 .BR xli (1),
43 .BR xv (1),
44 or
45 .BR xloadimage (1)
46 tools.
47
48 \fIwebcollage\fP is written in
49 .BR perl (1)
50 and requires Perl 5.
51
52 It will be an order of magnitude faster if you also have
53 the \fIwebcollage-helper\fP program installed (a GDK/JPEG image
54 compositor), but \fIwebcollage\fP works without it as well.
55 .SH OPTIONS
56 .I webcollage
57 accepts the following options:
58 .TP 8
59 .B \-root
60 Draw on the root window.  This option is manditory, if output is being
61 produced: drawing to a window other than the root window is not yet
62 supported.
63 .TP 8
64 .B \-verbose \fRor\fP \-v
65 Print diagnostics to stderr.  Multiple \fI-v\fP switches increase the
66 amount of output.  \fI-v\fP will print out the URLs of the images,
67 and where they were placed; \fI-vv\fP will print out any warnings,
68 and all URLs being loaded; \fI-vvv\fP will print information on
69 what URLs were rejected; and so on.
70 .TP 8
71 .B \-timeout \fIseconds\fP
72 How long to wait for a URL to complete before giving up on it and
73 moving on to the next one.
74 Default 30 seconds.
75 .TP 8
76 .B \-delay \fIseconds\fP
77 How long to sleep between images.  Default 2 seconds.  (Remember that
78 this program probably spends a lot of time waiting for the network.)
79 .TP 8
80 .B \-background \fIcolor-or-ppm\fP
81 What to use for the background onto which images are pasted.  This may be
82 a color name, a hexadecimal RGB specification in the form '#rrggbb', or 
83 the name of a PPM file.
84 .TP 8
85 .B \-size \fIWxH\fP
86 Normally, the output image will be made to be the size of the screen.
87 This lets you specify the desired size.
88 .TP 8
89 .B \-no-output
90 If this option is specified, then no composite output image will be
91 generated.  This is only useful when used in conjunction 
92 with \fB\-verbose\fP.
93 .TP 8
94 .B \-urls-only
95 If this option is specified, then no composite output image will be
96 generated: instead, a list of image URLs will be printed on stdout.
97 .TP 8
98 .B \-filter \fIcommand\fP
99 Filter all source images through this command.  The command must take
100 a PPM file on stdin, and write a new PPM file to stdout.  One good 
101 choice for a filter would be:
102 .EX
103 webcollage -root -filter 'vidwhacker -stdin -stdout'
104 .EE
105 .TP 8
106 .B \-filter2 \fIcommand\fP
107 Filter the \fIcomposite\fP image through this command.  The \fI-filter\fP
108 option applies to the sub-images; the \fI-filter2\fP applies to the
109 final, full-screen image.
110 .TP 8
111 .B \-http\-proxy \fIhost:port\fP
112 If you must go through a proxy to connect to the web, you can specify it 
113 with this option, or with the \fB$http_proxy\fP or \fB$HTTP_PROXY\fP 
114 environment variables.
115 .TP 8
116 .B \-dictionary \fIfile\fP
117 Webcollage normally looks at the system's default spell-check dictionary
118 to generate words to feed into the search engines.  You can specify an
119 alternate dictionary with this option.
120 .TP 8
121 .B \-driftnet \fI[ args ]\fP
122 .BR driftnet (1)
123 is a program that snoops your local ethernet for packets that look
124 like they might be image files.  It can be used in conjunction 
125 with \fIwebcollage\fP to generate a collage of what other people on
126 your network are looking at, instead of a search-engine collage.
127 If you have \fIdriftnet\fP installed on your $PATH, just use 
128 the \fI\-driftnet\fP option.  You can also specify the location
129 of the program like this:
130 .EX
131 -driftnet /path/to/driftnet
132 .EE
133 or, you can provide extra arguments like this:
134 .EX
135 -driftnet '/path/to/driftnet -extra -args'
136 .EE
137 Driftnet version 0.1.5 or later is required.  Note that 
138 the \fIdriftnet\fP program requires root access, so you'll have
139 to make \fIdriftnet\fP be setuid-root for this to work.
140 Please exercise caution.
141 .SH ENVIRONMENT
142 .PP
143 .TP 8
144 .B DISPLAY
145 to get the default host and display number.
146 .TP 8
147 .B XENVIRONMENT
148 to get the name of a resource file that overrides the global resources
149 stored in the RESOURCE_MANAGER property.
150 .TP 8
151 .B http_proxy\fR or \fPHTTP_PROXY
152 to get the default HTTP proxy host and port.
153 .SH FILES AND URLS
154 .TP
155 .I /usr/dict/words \fRor\fP /usr/share/lib/dict/words \fRor\fP /usr/share/dict/words
156 To find the random words to feed to search engines.
157 .PP
158 .I http://random.yahoo.com/bin/ryl, http://image.altavista.com/
159 To find random web pages.
160 .SH BUGS
161 When drawing on the root window, it always uses the default colormap.
162 This is actually a limitation of xv.  But regardless, when using this
163 program with xscreensaver, it must be given the \fBdefault-n\fP 
164 visual specification (see the
165 .BR xscreensaver (1)
166 manual for more details.)
167
168 Animating GIFs are not supported.
169
170 Too many of the images that it finds are text, not pictures.  This is 
171 because most of the web is pictures of text.  Which is pretty sad.
172 .SH SEE ALSO
173 .BR X (1),
174 .BR xscreensaver (1),
175 .BR xli (1),
176 .BR xv (1),
177 .BR xloadimage (1),
178 .BR ppmmake (1),
179 .BR giftopnm (1),
180 .BR pnmpaste (1),
181 .BR pnmscale (1),
182 .BR djpeg (1),
183 .BR cjpeg (1),
184 .BR xdpyinfo (1),
185 .BR perl (1),
186 .BR vidwhacker (1),
187 .BR dadadodo (1),
188 .BR driftnet (1)
189 .SH COPYRIGHT
190 Copyright \(co 1998-2002 by Jamie Zawinski.  Permission to use, copy, modify, 
191 distribute, and sell this software and its documentation for any purpose is 
192 hereby granted without fee, provided that the above copyright notice appear 
193 in all copies and that both that copyright notice and this permission notice
194 appear in supporting documentation.  No representations are made about the 
195 suitability of this software for any purpose.  It is provided "as is" without
196 express or implied warranty.
197 .SH AUTHOR
198 Jamie Zawinski <jwz@jwz.org>, 24-May-98.