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] [\-window] [\-verbose] [\-stdin] [\-stdout] [\-delay seconds]
   7 .SH DESCRIPTION
   8 The \fIvidwhacker\fP program grabs a image from the system's video input,
   9 applies random image filters to it, and displays the result.
  10 The \fIvidwhacker\fP program does not terminate until killed.
  11 It depends heavily on
  12 .BR xv (1)
  13 and the various PBM tools
  14 (e.g.,
  15 .BR ppmrelief (1).)
  16 .SH OPTIONS
  17 .I vidwhacker
  18 accepts the following options:
  19 .TP 8
  20 .B \-root
  21 Draw on the root window.
  22 .TP 8
  23 .B \-window
  24 Pop up a new window displaying the image.  When a new image has been fully
  25 processed, destroy that window and pop up a new one.  This is the default.
  26 .TP 8
  27 .B \-verbose
  28 Print diagnostics.
  29 .TP 8
  30 .B \-stdin
  31 Instead of grabbing an image from the system's video input, read an image
  32 to maniupulate from stdin.  This image must be in
  33 .TP 8
  34 .B \-delay \fIseconds\fP
  35 How long to sleep between images.  Default 3 seconds (the actual
  36 elapsed time is significantly longer, due to processing time.)
  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 \-stdout
  42 Instead of displaying the image on a window or on the root, write the new
  43 image on stdout, and exit.
  44 .SH ENVIRONMENT
  45 .PP
  46 .TP 8
  47 .B DISPLAY
  48 to get the default host and display number.
  49 .TP 8
  50 .B XENVIRONMENT
  51 to get the name of a resource file that overrides the global resources
  52 stored in the RESOURCE_MANAGER property.
  53 .SH BUGS
  54 Grabbing video images is, of course, very system-dependent.  It works
  55 on SGIs, and on Linux systems that have the
  56 .BR qcam (1)
  57 program.  If your system does things differently, you'll need to edit
  58 the vidwhacker script (look for the \fIgrab()\fP function.)
  59
  60 It's slow.
  61 .SH TO DO
  62 It might be interesting to rewrite this to use
  63 .BR gimp (1)
  64 plugins instead of the pbm tools.  It probably wouldn't be any faster,
  65 but there would be a wider variety of effects available.
  66 .SH SEE ALSO
  67 .BR X (1),
  68 .BR xscreensaver (1),
  69 .BR xv (1),
  70 .BR ppmtogif (1),
  71 .BR cjpeg (1)
  72 .SH COPYRIGHT
  73 Copyright \(co 1998, 1999 by Jamie Zawinski.  Permission to use, copy, modify,
  74 distribute, and sell this software and its documentation for any purpose is
  75 hereby granted without fee, provided that the above copyright notice appear
  76 in all copies and that both that copyright notice and this permission notice
  77 appear in supporting documentation.  No representations are made about the
  78 suitability of this software for any purpose.  It is provided "as is" without
  79 express or implied warranty.
  80 .SH AUTHOR
  81 Jamie Zawinski <jwz@jwz.org>, 18-Jan-98.