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 [\-fps]
  16 .SH DESCRIPTION
  17 The \fIdecayscreen\fP program creates a melting effect by randomly
  18 shifting rectangles around the screen.
  19
  20 The image that it manipulates will be grabbed from the portion of
  21 the screen underlying the window, or from the system's video input,
  22 or from a random file on disk, as indicated by
  23 the \fIgrabDesktopImages\fP, \fIgrabVideoFrames\fP,
  24 and \fIchooseRandomImages\fP options in the \fI~/.xscreensaver\fP
  25 file; see
  26 .BR xscreensaver-demo (1)
  27 for more details.
  28 .SH OPTIONS
  29 .I decayscreen
  30 accepts the following options:
  31 .TP 8
  32 .B \-window
  33 Draw on a newly-created window.  This is the default.
  34 .TP 8
  35 .B \-root
  36 Draw on the root window.
  37 .TP 8
  38 .B \-mono
  39 If on a color display, pretend we're on a monochrome display.
  40 .TP 8
  41 .B \-install
  42 Install a private colormap for the window.
  43 .TP 8
  44 .B \-visual \fIvisual\fP
  45 Specify which visual to use.  Legal values are the name of a visual class,
  46 or the id number (decimal or hex) of a specific visual.
  47 .TP 8
  48 .B \-delay \fImicroseconds\fP
  49 Slow it down.
  50 .TP 8
  51 .B \-duration \fIseconds\fP
  52 How long to run before loading a new image.  Default 120 seconds.
  53 .TP 8
  54 .B \-mode \fImode\fP
  55 The direction in which the image should tend to slide.  Legal values are
  56 \fIrandom\fP (meaning pick one), \fIup\fP, \fIleft\fP, \fIright\fP,
  57 \fIdown\fP, \fIupleft\fP, \fIdownleft\fP, \fIupright\fP, \fIdownright\fP,
  58 \fIshuffle\fP (meaning prefer no particular direction), \fIin\fP (meaning
  59 move things toward the center), \fIout\fP (meaning move things away
  60 from the center), \fImelt\fP (meaning melt straight
  61 downward),  \fIstretch\fP (meaning stretch the screen downward),
  62 and \fIfuzz\fP (meaning go blurry instead of melty).
  63 .TP 8
  64 .B \-fps
  65 Display the current frame rate and CPU load.
  66 .SH ENVIRONMENT
  67 .PP
  68 .TP 8
  69 .B DISPLAY
  70 to get the default host and display number.
  71 .TP 8
  72 .B XENVIRONMENT
  73 to get the name of a resource file that overrides the global resources
  74 stored in the RESOURCE_MANAGER property.
  75 .SH "SEE ALSO"
  76 .BR X (1),
  77 .BR xscreensaver (1),
  78 .BR xscreensaver\-demo (1),
  79 .BR xscreensaver\-getimage (1)
  80 .SH COPYRIGHT
  81 Copyright 1992 by Vivek Khera.  Permission to use, copy, modify, distribute,
  82 and sell this software and its documentation for any purpose is hereby granted
  83 without fee, provided that the above copyright notice appear in all copies and
  84 that both that copyright notice and this permission notice appear in
  85 supporting documentation.  No representations are made about the suitability
  86 of this software for any purpose.  It is provided "as is" without express or
  87 implied warranty.
  88 .SH AUTHOR
  89 Vivek Khera <khera@cs.duke.edu>, 05-Aug-93; based on code by David Wald, 1988.
  90 Modified by jwz, 28-Nov-1997.
  91 Modified by Rick Schultz <rick@skapunx.net> 05-Apr-1999.
  92 Modified by Vince Levey <vincel@vincel.org> 25-Oct-2001.