ftp://ftp.krokus.ru/pub/OpenBSD/distfiles/xscreensaver-4.22.tar.gz
[xscreensaver] / hacks / decayscreen.man
index b5493c7b1c86b63b5f59acd23a3de268ad5010de..17f43329df5af0767e3956a8d70b5c0352e57a9a 100644 (file)
@@ -1,12 +1,22 @@
-.TH XScreenSaver 1 "24-Nov-97" "X Version 11"
+.TH XScreenSaver 1 "05-Apr-1999" "X Version 11"
 .SH NAME
 decayscreen - make a screen meltdown.
 .SH SYNOPSIS
 .B decayscreen
-[\-display \fIhost:display.screen\fP] [\-window] [\-root] [\-mono] [\-install] [\-visual \fIvisual\fP] [\-delay \fIusecs\fP] [\-mode \fImode\fP]
+[\-display \fIhost:display.screen\fP] [\-window] [\-root] [\-mono] [\-install]
+[\-visual \fIvisual\fP] [\-delay \fIusecs\fP] [\-mode \fImode\fP]
 .SH DESCRIPTION
 The \fIdecayscreen\fP program creates a melting effect by randomly
 shifting rectangles around the screen.
+
+The image that it manipulates will be grabbed from the portion of
+the screen underlying the window, or from the system's video input, 
+or from a random file on disk, as indicated by 
+the \fIgrabDesktopImages\fP, \fIgrabVideoFrames\fP, 
+and \fIchooseRandomImages\fP options in the \fI~/.xscreensaver\fP
+file; see
+.BR xscreensaver-demo (1)
+for more details.
 .SH OPTIONS
 .I decayscreen
 accepts the following options:
@@ -34,33 +44,11 @@ Slow it down.
 The direction in which the image should tend to slide.  Legal values are
 \fIrandom\fP (meaning pick one), \fIup\fP, \fIleft\fP, \fIright\fP, 
 \fIdown\fP, \fIupleft\fP, \fIdownleft\fP, \fIupright\fP, \fIdownright\fP, 
-\fIshuffle\fP (meaning perfer no particular direction), \fIin\fP (meaning
-move things toward the center), and \fIout\fP (meaing move things away
-from the center).
-.SH RESOURCES
-On some systems (currently, only SGIs), this program can, instead of grabbing
-a desktop image, grab a frame of video from an external camera and manipulate
-that instead.  The following resources control that.
-.PP
-.TP 8
-.B grabVideoProbability \fR(Float)\fP
-What portion of the time to grab video rather than a screen image, 
-between 0.0 and 1.0.  Defaults to 0.5, or half the time.
-.TP 8
-.B videoDevice \fR(Integer)\fP
-The number of the default video input device to check first.  If unspecified, 
-the default camera (from videopanel(1)) will be checked first.  After that, all
-other available video input devices will be checked in order.  
-
-The first one which produces a non-black image will be used.  If all images
-are black, the others will be re-checked a few times before giving up and
-falling back to simply grabbing a desktop image (but note that this takes a
-few seconds, so if you don't actually have any video sources hooked up, you
-should consider turning off video grabbing by setting
-\fBgrabVideoProbability\fP to 0.0.)
-.TP 8
-.B videoGain \fR(Float)\fP
-The amount by which to brighten the grabbed image.  This defaults to 2.2.
+\fIshuffle\fP (meaning prefer no particular direction), \fIin\fP (meaning
+move things toward the center), \fIout\fP (meaning move things away
+from the center), \fImelt\fP (meaning melt straight 
+downward),  \fIstretch\fP (meaning stretch the screen downward),
+and \fIfuzz\fP (meaning go blurry instead of melty).
 .SH ENVIRONMENT
 .PP
 .TP 8
@@ -71,8 +59,10 @@ to get the default host and display number.
 to get the name of a resource file that overrides the global resources
 stored in the RESOURCE_MANAGER property.
 .SH "SEE ALSO"
-X(1),
-xscreensaver(1)
+.BR X (1),
+.BR xscreensaver (1),
+.BR xscreensaver\-demo (1),
+.BR xscreensaver\-getimage (1)
 .SH COPYRIGHT
 Copyright 1992 by Vivek Khera.  Permission to use, copy, modify, distribute, 
 and sell this software and its documentation for any purpose is hereby granted
@@ -83,4 +73,6 @@ of this software for any purpose.  It is provided "as is" without express or
 implied warranty.
 .SH AUTHOR
 Vivek Khera <khera@cs.duke.edu>, 05-Aug-93; based on code by David Wald, 1988.
-Modified by jwz, 28-Nov-97.
+Modified by jwz, 28-Nov-1997.
+Modified by Rick Schultz <rick@skapunx.net> 05-Apr-1999.
+Modified by Vince Levey <vincel@vincel.org> 25-Oct-2001.