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 .SH DESCRIPTION
  23 The \fIwebcollage\fP program pulls random image off of the World Wide Web
  24 and scatters them on the root window.  One satisfied customer described it
  25 as "a nonstop pop culture brainbath."  This program finds its images by
  26 doing random web searches, and extracting images from the returned pages.
  27 It places the images on the root window by using the
  28 .BR xv (1),
  29 .BR giftopnm (1),
  30 and
  31 .BR djpeg (1)
  32 tools.
  33
  34 \fIwebcollage\fP also works as a CGI program, that will add images to the
  35 collage on a web page each time the page is loaded.  See the comments at
  36 the top of the source code for installation instructions.
  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 .SH ENVIRONMENT
  82 .PP
  83 .TP 8
  84 .B DISPLAY
  85 to get the default host and display number.
  86 .TP 8
  87 .B XENVIRONMENT
  88 to get the name of a resource file that overrides the global resources
  89 stored in the RESOURCE_MANAGER property.
  90 .SH FILES AND URLS
  91 .TP
  92 .I /usr/dict/words \fRor\fP /usr/share/lib/dict/words
  93 To find the random words to feed to search engines.
  94 .PP
  95 .I http://random.yahoo.com/bin/ryl, http://image.altavista.com/
  96 To find random web pages.
  97 .SH BUGS
  98 When drawing on the root window, it always uses the default colormap.
  99 This is actually a limitation of xv.  But regardless, when using this
 100 program with xscreensaver, it must be given the \fBdefault-n\fP
 101 visual specification (see the
 102 .BR xscreensaver (1)
 103 manual for more details.)
 104
 105 Only the GIF and JPEG image formats are supported.
 106
 107 Transparent and animating GIFs are not supported.
 108
 109 It's slow.
 110
 111 Too many of the images that it finds are text, not pictures.  This is
 112 because most of the web is pictures of text.  Which is pretty sad.
 113 .SH SEE ALSO
 114 .BR X (1),
 115 .BR xscreensaver (1),
 116 .BR xv (1),
 117 .BR ppmmake (1),
 118 .BR giftopnm (1),
 119 .BR pnmpaste (1),
 120 .BR pnmscale (1),
 121 .BR djpeg (1),
 122 .BR cjpeg (1),
 123 .BR xdpyinfo (1),
 124 .BR perl (1),
 125 .BR vidwhacker (1),
 126 .BR dadadodo (1)
 127 .SH COPYRIGHT
 128 Copyright \(co 1998, 1999 by Jamie Zawinski.  Permission to use, copy, modify,
 129 distribute, and sell this software and its documentation for any purpose is
 130 hereby granted without fee, provided that the above copyright notice appear
 131 in all copies and that both that copyright notice and this permission notice
 132 appear in supporting documentation.  No representations are made about the
 133 suitability of this software for any purpose.  It is provided "as is" without
 134 express or implied warranty.
 135 .SH AUTHOR
 136 Jamie Zawinski <jwz@jwz.org>, 24-May-98.