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

   1 .TH XScreenSaver 1 "05-Apr-1999" "X Version 11"
   2 .SH NAME
   3 decayscreen - make a screen meltdown.
   4 .SH SYNOPSIS
   5 .B decayscreen
   6 [\-display \fIhost:display.screen\fP]
   7 [\-window]
   8 [\-root]
   9 [\-mono]
  10 [\-install]
  11 [\-visual \fIvisual\fP]
  12 [\-delay \fIusecs\fP]
  13 [\-duration \fIsecs\fP]
  14 [\-mode \fImode\fP]
  15 .SH DESCRIPTION
  16 The \fIdecayscreen\fP program creates a melting effect by randomly
  17 shifting rectangles around the screen.
  18
  19 The image that it manipulates will be grabbed from the portion of
  20 the screen underlying the window, or from the system's video input,
  21 or from a random file on disk, as indicated by
  22 the \fIgrabDesktopImages\fP, \fIgrabVideoFrames\fP,
  23 and \fIchooseRandomImages\fP options in the \fI~/.xscreensaver\fP
  24 file; see
  25 .BR xscreensaver-demo (1)
  26 for more details.
  27 .SH OPTIONS
  28 .I decayscreen
  29 accepts the following options:
  30 .TP 8
  31 .B \-window
  32 Draw on a newly-created window.  This is the default.
  33 .TP 8
  34 .B \-root
  35 Draw on the root window.
  36 .TP 8
  37 .B \-mono
  38 If on a color display, pretend we're on a monochrome display.
  39 .TP 8
  40 .B \-install
  41 Install a private colormap for the window.
  42 .TP 8
  43 .B \-visual \fIvisual\fP
  44 Specify which visual to use.  Legal values are the name of a visual class,
  45 or the id number (decimal or hex) of a specific visual.
  46 .TP 8
  47 .B \-delay \fImicroseconds\fP
  48 Slow it down.
  49 .TP 8
  50 .B \-duration \fIseconds\fP
  51 How long to run before loading a new image.  Default 120 seconds.
  52 .TP 8
  53 .B \-mode \fImode\fP
  54 The direction in which the image should tend to slide.  Legal values are
  55 \fIrandom\fP (meaning pick one), \fIup\fP, \fIleft\fP, \fIright\fP,
  56 \fIdown\fP, \fIupleft\fP, \fIdownleft\fP, \fIupright\fP, \fIdownright\fP,
  57 \fIshuffle\fP (meaning prefer no particular direction), \fIin\fP (meaning
  58 move things toward the center), \fIout\fP (meaning move things away
  59 from the center), \fImelt\fP (meaning melt straight
  60 downward),  \fIstretch\fP (meaning stretch the screen downward),
  61 and \fIfuzz\fP (meaning go blurry instead of melty).
  62 .SH ENVIRONMENT
  63 .PP
  64 .TP 8
  65 .B DISPLAY
  66 to get the default host and display number.
  67 .TP 8
  68 .B XENVIRONMENT
  69 to get the name of a resource file that overrides the global resources
  70 stored in the RESOURCE_MANAGER property.
  71 .SH "SEE ALSO"
  72 .BR X (1),
  73 .BR xscreensaver (1),
  74 .BR xscreensaver\-demo (1),
  75 .BR xscreensaver\-getimage (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-1997.
  87 Modified by Rick Schultz <rick@skapunx.net> 05-Apr-1999.
  88 Modified by Vince Levey <vincel@vincel.org> 25-Oct-2001.