~ubuntu-branches/ubuntu/dapper/xscreensaver/dapper

« back to all changes in this revision

Viewing changes to hacks/webcollage.man

  • Committer: Bazaar Package Importer
  • Author(s): Oliver Grawert
  • Date: 2005-10-11 21:00:42 UTC
  • mfrom: (2.1.1 sarge)
  • Revision ID: james.westby@ubuntu.com-20051011210042-u7q6zslgevdxspr3
Tags: 4.21-4ubuntu17
updated pt_BR again, fixed to UTF-8 

Show diffs side-by-side

added added

removed removed

Lines of Context:
16
16
webcollage - decorate the screen with random images from the web
17
17
.SH SYNOPSIS
18
18
.B webcollage
19
 
[\-display \fIhost:display.screen\fP] [\-root] [\-verbose]
20
 
[\-delay \fIsecs\fP] [\-timeout \fIsecs\fP] [\-background \fIbg\fP]
21
 
[\-filter \fIcommand\fP] [\-filter2 \fIcommand\fP]
 
19
[\-display \fIhost:display.screen\fP]
 
20
[\-root]
 
21
[\-window\-id \fIid\fP]
 
22
[\-verbose]
 
23
[\-timeout \fIsecs\fP]
 
24
[\-delay \fIsecs\fP]
 
25
[\-background \fIbg\fP]
 
26
[\-no-output]
 
27
[\-urls-only]
 
28
[\-imagemap \fIfilename-base\fP]
 
29
[\-size \fIWxH\fP]
 
30
[\-opacity \fIratio\fP]
 
31
[\-filter \fIcommand\fP]
 
32
[\-filter2 \fIcommand\fP]
22
33
[\-http\-proxy host[:port]]
 
34
[\-dictionary \fIdictionary-file\fP]
 
35
[\-driftnet [\fIcmd\fP]]
23
36
.SH DESCRIPTION
24
37
The \fIwebcollage\fP program pulls random image off of the World Wide Web
25
38
and scatters them on the root window.  One satisfied customer described it
26
39
as "a nonstop pop culture brainbath."  This program finds its images by
27
40
doing random web searches, and extracting images from the returned pages.
28
 
It places the images on the root window by using the
29
 
.BR giftopnm (1),
30
 
.BR djpeg (1),
31
 
and
32
 
.BR xli (1),
33
 
.BR xv (1),
34
 
or
35
 
.BR xloadimage (1)
36
 
tools.
37
41
 
38
42
\fIwebcollage\fP is written in
39
43
.BR perl (1)
40
44
and requires Perl 5.
 
45
 
 
46
It will be an order of magnitude faster if you also have
 
47
the \fIwebcollage-helper\fP program installed (a GDK/JPEG image
 
48
compositor), but \fIwebcollage\fP works without it as well.
 
49
 
 
50
\fIwebcollage\fP can be used in conjunction with the
 
51
.BR driftnet (1)
 
52
program (the Unix equivalent of EtherPEG) to snoop images from traffic
 
53
on your local subnet, instead of getting images from search engines.
41
54
.SH OPTIONS
42
55
.I webcollage
43
56
accepts the following options:
44
57
.TP 8
45
58
.B \-root
46
 
Draw on the root window.  This option is manditory: drawing to a window
47
 
other than the root window is not yet supported.
 
59
Draw on the root window.  This option is manditory, if output is being
 
60
produced: drawing to a window other than the root window is not yet
 
61
supported.
 
62
 
 
63
Images are placed on the root window by using one of the
 
64
.BR xscreensaver-getimage (1),
 
65
.BR chbg (1),
 
66
.BR xv (1),
 
67
.BR xli (1),
 
68
or
 
69
.BR xloadimage (1)
 
70
programs (whichever is available.)
 
71
.TP 8
 
72
.B \-window\-id \fIid\fP
 
73
Draw to the indicated window instead; this only works if the
 
74
.BR xscreensaver-getimage (1)
 
75
program is installed.
48
76
.TP 8
49
77
.B \-verbose \fRor\fP \-v
50
78
Print diagnostics to stderr.  Multiple \fI-v\fP switches increase the
51
 
amount of output.  \fI-v\fP will print out only the URLs of the 
52
 
images; \fI-vv\fP will print all the commands being run; and \fI-vvv\fP
53
 
will print more than you care about.
 
79
amount of output.  \fI-v\fP will print out the URLs of the images,
 
80
and where they were placed; \fI-vv\fP will print out any warnings,
 
81
and all URLs being loaded; \fI-vvv\fP will print information on
 
82
what URLs were rejected; and so on.
 
83
.TP 8
 
84
.B \-timeout \fIseconds\fP
 
85
How long to wait for a URL to complete before giving up on it and
 
86
moving on to the next one.
 
87
Default 30 seconds.
54
88
.TP 8
55
89
.B \-delay \fIseconds\fP
56
 
How long to sleep between images.  Default 1 second.  (Remember that
 
90
How long to sleep between images.  Default 2 seconds.  (Remember that
57
91
this program probably spends a lot of time waiting for the network.)
58
92
.TP 8
59
93
.B \-background \fIcolor-or-ppm\fP
61
95
a color name, a hexadecimal RGB specification in the form '#rrggbb', or 
62
96
the name of a PPM file.
63
97
.TP 8
64
 
.B \-timeout \fIseconds\fP
65
 
How long to wait for a URL to complete before giving up on it and
66
 
moving on to the next one.
67
 
Default 30 seconds.
 
98
.B \-size \fIWxH\fP
 
99
Normally, the output image will be made to be the size of the
 
100
screen (or target window.)  This lets you specify the desired size.
 
101
.TP 8
 
102
.B \-opacity \fIratio\fP
 
103
How transparently to paste the images together, with 0.0 meaning
 
104
"completely transparent" and 1.0 meaning "opaque."  Default 0.85.
 
105
A value of around 0.3 will produce an interestingly blurry image
 
106
after a while.
 
107
.TP 8
 
108
.B \-no-output
 
109
If this option is specified, then no composite output image will be
 
110
generated.  This is only useful when used in conjunction 
 
111
with \fB\-verbose\fP.
 
112
.TP 8
 
113
.B \-urls-only
 
114
If this option is specified, then no composite output image will be
 
115
generated: instead, a list of image URLs will be printed on stdout.
 
116
.TP 8
 
117
.B \-imagemap \fIfilename-base\fP
 
118
If this option is specified, then instead of writing an image to the
 
119
root window, two files will be created: "\fIbase\fP.html" and "\fIbase\fP.jpg".
 
120
The JPEG will be the collage; the HTML file will include that image, and
 
121
an image-map making the sub-images be linked to the pages on which they
 
122
were found (just like \fIhttp://www.jwz.org/webcollage/\fP.)
68
123
.TP 8
69
124
.B \-filter \fIcommand\fP
70
125
Filter all source images through this command.  The command must take
83
138
If you must go through a proxy to connect to the web, you can specify it 
84
139
with this option, or with the \fB$http_proxy\fP or \fB$HTTP_PROXY\fP 
85
140
environment variables.
 
141
.TP 8
 
142
.B \-dictionary \fIfile\fP
 
143
Webcollage normally looks at the system's default spell-check dictionary
 
144
to generate words to feed into the search engines.  You can specify an
 
145
alternate dictionary with this option.
 
146
 
 
147
Note that by default, webcollage searches for images using several
 
148
different methods, not all of which involve dictionary words, so
 
149
using a "topical" dictionary file will not, in itself, be as effective
 
150
as you might be hoping.
 
151
.TP 8
 
152
.B \-driftnet \fI[ args ]\fP
 
153
.BR driftnet (1)
 
154
is a program that snoops your local ethernet for packets that look
 
155
like they might be image files.  It can be used in conjunction 
 
156
with \fIwebcollage\fP to generate a collage of what other people on
 
157
your network are looking at, instead of a search-engine collage.
 
158
If you have \fIdriftnet\fP installed on your $PATH, just use 
 
159
the \fI\-driftnet\fP option.  You can also specify the location
 
160
of the program like this:
 
161
.EX
 
162
-driftnet /path/to/driftnet
 
163
.EE
 
164
or, you can provide extra arguments like this:
 
165
.EX
 
166
-driftnet '/path/to/driftnet -extra -args'
 
167
.EE
 
168
Driftnet version 0.1.5 or later is required.  Note that 
 
169
the \fIdriftnet\fP program requires root access, so you'll have
 
170
to make \fIdriftnet\fP be setuid-root for this to work.
 
171
Please exercise caution.
86
172
.SH ENVIRONMENT
87
173
.PP
88
174
.TP 8
96
182
.B http_proxy\fR or \fPHTTP_PROXY
97
183
to get the default HTTP proxy host and port.
98
184
.SH FILES AND URLS
99
 
.TP
100
 
.I /usr/dict/words \fRor\fP /usr/share/lib/dict/words \fRor\fP /usr/share/dict/words
101
 
To find the random words to feed to search engines.
102
 
.PP
103
 
.I http://random.yahoo.com/bin/ryl, http://image.altavista.com/
104
 
To find random web pages.
 
185
.I /usr/dict/words,
 
186
.I /usr/share/lib/dict/words,\fP
 
187
or
 
188
.I /usr/share/dict/words
 
189
to find the random words to feed to certain search engines.
 
190
 
 
191
    \fIhttp://www.altavista.com/image/randomlink\fP,
 
192
    \fIhttp://random.yahoo.com/fast/ryl\fP,
 
193
    \fIhttp://www.livejournal.com/stats/latest-img.bml\fP, and
 
194
    \fIhttp://www.google.com/\fP
 
195
to find random web pages.
 
196
.SH BOOBIES
 
197
The Internet being what it is, absolutely anything might show up in the
 
198
collage including -- quite possibly -- pornography, or even nudity.
105
199
.SH BUGS
106
 
When drawing on the root window, it always uses the default colormap.
107
 
This is actually a limitation of xv.  But regardless, when using this
108
 
program with xscreensaver, it must be given the \fBdefault-n\fP 
109
 
visual specification (see the
110
 
.BR xscreensaver (1)
111
 
manual for more details.)
112
 
 
113
 
Only the GIF and JPEG image formats are supported.
114
 
 
115
 
Transparent and animating GIFs are not supported.
116
 
 
117
 
It's slow.
118
 
 
119
 
Too many of the images that it finds are text, not pictures.  This is 
120
 
because most of the web is pictures of text.  Which is pretty sad.
 
200
Animating GIFs are not supported: only the first frame will be used.
 
201
.SH UPGRADES
 
202
The latest version of webcollage can be found as a part of
 
203
xscreensaver, at 
 
204
.B http://www.jwz.org/xscreensaver/,
 
205
or on the WebCollage page at 
 
206
.B http://www.jwz.org/webcollage/.
 
207
 
 
208
DriftNet:
 
209
.B http://www.ex-parrot.com/~chris/driftnet/
121
210
.SH SEE ALSO
122
211
.BR X (1),
123
212
.BR xscreensaver (1),
133
222
.BR xdpyinfo (1),
134
223
.BR perl (1),
135
224
.BR vidwhacker (1),
136
 
.BR dadadodo (1)
 
225
.BR dadadodo (1),
 
226
.BR driftnet (1)
 
227
.BR EtherPEG ,
 
228
.BR EtherPeek
137
229
.SH COPYRIGHT
138
 
Copyright \(co 1998, 1999 by Jamie Zawinski.  Permission to use, copy, modify, 
139
 
distribute, and sell this software and its documentation for any purpose is 
140
 
hereby granted without fee, provided that the above copyright notice appear 
 
230
Copyright \(co 1998-2005 by Jamie Zawinski.  Permission to use, copy, modify,
 
231
distribute, and sell this software and its documentation for any purpose is
 
232
hereby granted without fee, provided that the above copyright notice appear
141
233
in all copies and that both that copyright notice and this permission notice
142
 
appear in supporting documentation.  No representations are made about the 
 
234
appear in supporting documentation.  No representations are made about the
143
235
suitability of this software for any purpose.  It is provided "as is" without
144
236
express or implied warranty.
145
237
.SH AUTHOR
146
 
Jamie Zawinski <jwz@jwz.org>, 24-May-98.
 
238
Jamie Zawinski <jwz@jwz.org>, 24-May-1998.