git.hungrycats.org Git - xscreensaver/blob - hacks/vidwhacker.man

   1 .TH XScreenSaver 1 "17-Jun-99" "X Version 11"
   2 .SH NAME
   3 vidwhacker - grab images and apply random filters to them
   4 .SH SYNOPSIS
   5 .B vidwhacker
   6 [\-display \fIhost:display.screen\fP] [\-root] [\-verbose]
   7 [\-stdin] [\-stdout] [\-delay seconds]
   8 [-directory \fIdirectory\fP]
   9 .SH DESCRIPTION
  10 The \fIvidwhacker\fP program grabs an image from disk, or  from the
  11 system's video input, then applies random image filters to it, and
  12 displays the result.  The \fIvidwhacker\fP program does not terminate
  13 until killed.
  14
  15 It depends heavily on the various PBM tools (e.g.,
  16 .BR ppmrelief (1).)
  17
  18 Selection of random image files is done by running the
  19 .BR xscreensaver-getimage-file (1)
  20 program.  Capture of video frames (if requested) is done by running the
  21 .BR xscreensaver-getimage-video (1)
  22 program.  The options of whether to do video, and which directory to
  23 search for images, are specified in the \fI~/.xscreensaver\fP file.
  24 .SH OPTIONS
  25 .I vidwhacker
  26 accepts the following options:
  27 .TP 8
  28 .B \-root
  29 Draw on the root window.  This is the default.
  30 .TP 8
  31 .B \-verbose
  32 Print diagnostics.
  33 .TP 8
  34 .B \-stdin
  35 Instead of grabbing an image from disk or video, read an image
  36 to maniupulate from stdin.  This image must be in
  37 .BR ppm (5)
  38 format.  The program will still perform repeated random image
  39 transformations, but it will always use this one image as its starting point.
  40 .TP 8
  41 .B \-delay \fIseconds\fP
  42 How long to sleep between images.  Default 5 seconds (the actual
  43 elapsed time is significantly longer, due to processing time.)
  44 .TP 8
  45 .B \-stdout
  46 Instead of displaying the image on a window or on the root, write the new
  47 image on stdout, and exit.
  48 .TP 8
  49 .B \-directory \fIdirectory\fP
  50 Use this directory instead of the \fBimageDirectory\fP specified in
  51 the \fI~/.xscreensaver\fP file.
  52 .SH ENVIRONMENT
  53 .PP
  54 .TP 8
  55 .B DISPLAY
  56 to get the default host and display number.
  57 .TP 8
  58 .B XENVIRONMENT
  59 to get the name of a resource file that overrides the global resources
  60 stored in the RESOURCE_MANAGER property.
  61 .SH BUGS
  62 It's slow.
  63 .SH TO DO
  64 It might be interesting to rewrite this to use
  65 .BR gimp (1)
  66 plugins instead of the pbm tools.  It probably wouldn't be any faster,
  67 but there would be a wider variety of effects available.
  68 .SH SEE ALSO
  69 .BR X (1),
  70 .BR xscreensaver (1),
  71 .BR xscreensaver-getimage-file (1),
  72 .BR xscreensaver-getimage-video (1),
  73 .BR xv (1),
  74 .BR ppmtogif (1),
  75 .BR cjpeg (1)
  76 .SH COPYRIGHT
  77 Copyright \(co 1998-2001 by Jamie Zawinski.  Permission to use, copy, modify,
  78 distribute, and sell this software and its documentation for any purpose is
  79 hereby granted without fee, provided that the above copyright notice appear
  80 in all copies and that both that copyright notice and this permission notice
  81 appear in supporting documentation.  No representations are made about the
  82 suitability of this software for any purpose.  It is provided "as is" without
  83 express or implied warranty.
  84 .SH AUTHOR
  85 Jamie Zawinski <jwz@jwz.org>, 18-Jan-98.