git.hungrycats.org Git - xscreensaver/blob - local/man/man.1/webcollage.1

   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 .SH DESCRIPTION
  23 The \fIwebcollage\fP program pulls random image off of the World Wide Web
  24 and scatters them on the root window.  It finds these images by doing
  25 random web searches, and extracting images from the returned pages.
  26 It places the images on the root window by using the
  27 .BR xv (1),
  28 .BR giftopnm (1),
  29 and
  30 .BR djpeg (1)
  31 tools.
  32
  33 \fIwebcollage\fP also works as a CGI program: simply make a symbolic
  34 link to the \fIwebcollage\fP executable called \fInph-webcollage.cgi\fP.
  35 If this program sees that it is being run as a CGI, then it will behave
  36 appropriately.  (The generated web page will list the images one after
  37 another, rather than tiling them together.)
  38
  39 \fIwebcollage\fP is written in
  40 .BR perl (1)
  41 and requires Perl 5.
  42 .SH OPTIONS
  43 .I webcollage
  44 accepts the following options:
  45 .TP 8
  46 .B \-root
  47 Draw on the root window.  This option is manditory: drawing to a window
  48 other than the root window is not yet supported.
  49 .TP 8
  50 .B \-verbose \fRor\fP \-v
  51 Print diagnostics to stderr.  Multiple \fI-v\fP switches increase the
  52 amount of output.  \fI-v\fP will print out only the URLs of the
  53 images; \fI-vv\fP will print all the commands being run; and \fI-vvv\fP
  54 will print more than you care about.
  55 .TP 8
  56 .B \-delay \fIseconds\fP
  57 How long to sleep between images.  Default 1 second.  (Remember that
  58 this program probably spends a lot of time waiting for the network.)
  59 .TP 8
  60 .B \-background \fIcolor-or-ppm\fP
  61 What to use for the background onto which images are pasted.  This may be
  62 a color name, a hexadecimal RGB specification in the form '#rrggbb', or
  63 the name of a PPM file.
  64 .TP 8
  65 .B \-timeout \fIseconds\fP
  66 How long to wait for a URL to complete before giving up on it and
  67 moving on to the next one.
  68 Default 30 seconds.
  69 .TP 8
  70 .B \-filter \fIcommand\fP
  71 Filter all source images through this command.  The command must take
  72 a PPM file on stdin, and write a new PPM file to stdout.  One good
  73 choice for a filter would be:
  74 .EX
  75 webcollage -root -filter 'vidwhacker -stdin -stdout'
  76 .EE
  77 .TP 8
  78 .B \-filter2 \fIcommand\fP
  79 Filter the \fIcomposite\fP image through this command.  The \fI-filter\fP
  80 option applies to the sub-images; the \fI-filter2\fP applies to the
  81 final, full-screen image.
  82 .SH ENVIRONMENT
  83 .PP
  84 .TP 8
  85 .B DISPLAY
  86 to get the default host and display number.
  87 .TP 8
  88 .B XENVIRONMENT
  89 to get the name of a resource file that overrides the global resources
  90 stored in the RESOURCE_MANAGER property.
  91 .SH FILES AND URLS
  92 .TP
  93 .I /usr/dict/words \fRor\fP /usr/share/lib/dict/words
  94 To find the random words to feed to search engines.
  95 .PP
  96 .I http://random.yahoo.com/bin/ryl, http://image.altavista.com/
  97 To find random web pages.
  98 .SH BUGS
  99 When drawing on the root window, it always uses the default colormap.
 100 This is actually a limitation of xv.  But regardless, when using this
 101 program with xscreensaver, it must be given the \fBdefault-n\fP
 102 visual specification (see the
 103 .BR xscreensaver (1)
 104 manual for more details.)
 105
 106 Only the GIF and JPEG image formats are supported.
 107
 108 Transparent and animating GIFs are not supported.
 109
 110 It's slow.
 111 .SH SEE ALSO
 112 .BR X (1),
 113 .BR xscreensaver (1),
 114 .BR xv (1),
 115 .BR giftopnm (1),
 116 .BR djpeg (1),
 117 .BR vidwhacker (1),
 118 .BR perl (1)
 119 .SH COPYRIGHT
 120 Copyright \(co 1998, 1999 by Jamie Zawinski.  Permission to use, copy, modify,
 121 distribute, and sell this software and its documentation for any purpose is
 122 hereby granted without fee, provided that the above copyright notice appear
 123 in all copies and that both that copyright notice and this permission notice
 124 appear in supporting documentation.  No representations are made about the
 125 suitability of this software for any purpose.  It is provided "as is" without
 126 express or implied warranty.
 127 .SH AUTHOR
 128 Jamie Zawinski <jwz@jwz.org>, 24-May-98.