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