git.hungrycats.org Git - xscreensaver/blob - 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] [\-root] [\-verbose]
  20 [\-delay \fIsecs\fP] [\-timeout \fIsecs\fP] [\-background \fIbg\fP]
  21 [\-filter \fIcommand\fP] [\-filter2 \fIcommand\fP]
  22 [\-http\-proxy host[:port]]
  23 .SH DESCRIPTION
  24 The \fIwebcollage\fP program pulls random image off of the World Wide Web
  25 and scatters them on the root window.  One satisfied customer described it
  26 as "a nonstop pop culture brainbath."  This program finds its images by
  27 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
  38 \fIwebcollage\fP is written in
  39 .BR perl (1)
  40 and requires Perl 5.
  41 .SH OPTIONS
  42 .I webcollage
  43 accepts the following options:
  44 .TP 8
  45 .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.
  48 .TP 8
  49 .B \-verbose \fRor\fP \-v
  50 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.
  54 .TP 8
  55 .B \-delay \fIseconds\fP
  56 How long to sleep between images.  Default 1 second.  (Remember that
  57 this program probably spends a lot of time waiting for the network.)
  58 .TP 8
  59 .B \-background \fIcolor-or-ppm\fP
  60 What to use for the background onto which images are pasted.  This may be
  61 a color name, a hexadecimal RGB specification in the form '#rrggbb', or
  62 the name of a PPM file.
  63 .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.
  68 .TP 8
  69 .B \-filter \fIcommand\fP
  70 Filter all source images through this command.  The command must take
  71 a PPM file on stdin, and write a new PPM file to stdout.  One good
  72 choice for a filter would be:
  73 .EX
  74 webcollage -root -filter 'vidwhacker -stdin -stdout'
  75 .EE
  76 .TP 8
  77 .B \-filter2 \fIcommand\fP
  78 Filter the \fIcomposite\fP image through this command.  The \fI-filter\fP
  79 option applies to the sub-images; the \fI-filter2\fP applies to the
  80 final, full-screen image.
  81 .TP 8
  82 .B \-http\-proxy \fIhost:port\fP
  83 If you must go through a proxy to connect to the web, you can specify it
  84 with this option, or with the \fB$http_proxy\fP or \fB$HTTP_PROXY\fP
  85 environment variables.
  86 .SH ENVIRONMENT
  87 .PP
  88 .TP 8
  89 .B DISPLAY
  90 to get the default host and display number.
  91 .TP 8
  92 .B XENVIRONMENT
  93 to get the name of a resource file that overrides the global resources
  94 stored in the RESOURCE_MANAGER property.
  95 .TP 8
  96 .B http_proxy\fR or \fPHTTP_PROXY
  97 to get the default HTTP proxy host and port.
  98 .SH FILES AND URLS
  99 .TP
 100 .I /usr/dict/words \fRor\fP /usr/share/lib/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.
 105 .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.
 121 .SH SEE ALSO
 122 .BR X (1),
 123 .BR xscreensaver (1),
 124 .BR xli (1),
 125 .BR xv (1),
 126 .BR xloadimage (1),
 127 .BR ppmmake (1),
 128 .BR giftopnm (1),
 129 .BR pnmpaste (1),
 130 .BR pnmscale (1),
 131 .BR djpeg (1),
 132 .BR cjpeg (1),
 133 .BR xdpyinfo (1),
 134 .BR perl (1),
 135 .BR vidwhacker (1),
 136 .BR dadadodo (1)
 137 .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
 141 in all copies and that both that copyright notice and this permission notice
 142 appear in supporting documentation.  No representations are made about the
 143 suitability of this software for any purpose.  It is provided "as is" without
 144 express or implied warranty.
 145 .SH AUTHOR
 146 Jamie Zawinski <jwz@jwz.org>, 24-May-98.