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

   1 .TH XScreenSaver 1 "24-Nov-97" "X Version 11"
   2 .SH NAME
   3 decayscreen - make a screen meltdown.
   4 .SH SYNOPSIS
   5 .B decayscreen
   6 [\-display \fIhost:display.screen\fP] [\-window] [\-root] [\-mono] [\-install] [\-visual \fIvisual\fP] [\-delay \fIusecs\fP] [\-mode \fImode\fP]
   7 .SH DESCRIPTION
   8 The \fIdecayscreen\fP program creates a melting effect by randomly
   9 shifting rectangles around the screen.
  10 .SH OPTIONS
  11 .I decayscreen
  12 accepts the following options:
  13 .TP 8
  14 .B \-window
  15 Draw on a newly-created window.  This is the default.
  16 .TP 8
  17 .B \-root
  18 Draw on the root window.
  19 .TP 8
  20 .B \-mono
  21 If on a color display, pretend we're on a monochrome display.
  22 .TP 8
  23 .B \-install
  24 Install a private colormap for the window.
  25 .TP 8
  26 .B \-visual \fIvisual\fP
  27 Specify which visual to use.  Legal values are the name of a visual class,
  28 or the id number (decimal or hex) of a specific visual.
  29 .TP 8
  30 .B \-delay \fImicroseconds\fP
  31 Slow it down.
  32 .TP 8
  33 .B \-mode \fImode\fP
  34 The direction in which the image should tend to slide.  Legal values are
  35 \fIrandom\fP (meaning pick one), \fIup\fP, \fIleft\fP, \fIright\fP,
  36 \fIdown\fP, \fIupleft\fP, \fIdownleft\fP, \fIupright\fP, \fIdownright\fP,
  37 \fIshuffle\fP (meaning perfer no particular direction), \fIin\fP (meaning
  38 move things toward the center), and \fIout\fP (meaing move things away
  39 from the center).
  40 .SH RESOURCES
  41 On some systems (currently, only SGIs), this program can, instead of grabbing
  42 a desktop image, grab a frame of video from an external camera and manipulate
  43 that instead.  The following resources control that.
  44 .PP
  45 .TP 8
  46 .B grabVideoProbability \fR(Float)\fP
  47 What portion of the time to grab video rather than a screen image,
  48 between 0.0 and 1.0.  Defaults to 0.5, or half the time.
  49 .TP 8
  50 .B videoDevice \fR(Integer)\fP
  51 The number of the default video input device to check first.  If unspecified,
  52 the default camera (from videopanel(1)) will be checked first.  After that, all
  53 other available video input devices will be checked in order.
  54
  55 The first one which produces a non-black image will be used.  If all images
  56 are black, the others will be re-checked a few times before giving up and
  57 falling back to simply grabbing a desktop image (but note that this takes a
  58 few seconds, so if you don't actually have any video sources hooked up, you
  59 should consider turning off video grabbing by setting
  60 \fBgrabVideoProbability\fP to 0.0.)
  61 .TP 8
  62 .B videoGain \fR(Float)\fP
  63 The amount by which to brighten the grabbed image.  This defaults to 2.2.
  64 .SH ENVIRONMENT
  65 .PP
  66 .TP 8
  67 .B DISPLAY
  68 to get the default host and display number.
  69 .TP 8
  70 .B XENVIRONMENT
  71 to get the name of a resource file that overrides the global resources
  72 stored in the RESOURCE_MANAGER property.
  73 .SH "SEE ALSO"
  74 X(1),
  75 xscreensaver(1)
  76 .SH COPYRIGHT
  77 Copyright 1992 by Vivek Khera.  Permission to use, copy, modify, distribute,
  78 and sell this software and its documentation for any purpose is hereby granted
  79 without fee, provided that the above copyright notice appear in all copies and
  80 that both that copyright notice and this permission notice appear in
  81 supporting documentation.  No representations are made about the suitability
  82 of this software for any purpose.  It is provided "as is" without express or
  83 implied warranty.
  84 .SH AUTHOR
  85 Vivek Khera <khera@cs.duke.edu>, 05-Aug-93; based on code by David Wald, 1988.
  86 Modified by jwz, 28-Nov-97.