ftp://ftp.krokus.ru/pub/OpenBSD/distfiles/xscreensaver-4.22.tar.gz
[xscreensaver] / hacks / slidescreen.man
index 9dc86fc07dfbcf18e7008ef44ec481faaf827f11..ea38835570531f3c8a2cd6e15a983813a8fca2ca 100644 (file)
@@ -1,13 +1,32 @@
-.TH XScreenSaver 1 "3-dec-92" "X Version 11"
+.TH XScreenSaver 1 "24-Nov-97" "X Version 11"
 .SH NAME
 slidescreen - permute the screen image like an 8-puzzle
 .SH SYNOPSIS
 .B slidescreen
-[\-display \fIhost:display.screen\fP] [\-background \fIcolor\fP] [\-grid-size \fIpixels\fP] [\-ibw \fIpixels\fP] [\-increment \fIpixels\fP] [\-delay \fIusecs\fP] [\-delay2 \fIusecs\fP] [\-window] [\-root] [\-install] [\-visual \fIvisual\fP]
+[\-display \fIhost:display.screen\fP]
+[\-background \fIcolor\fP]
+[\-grid-size \fIpixels\fP]
+[\-ibw \fIpixels\fP]
+[\-increment \fIpixels\fP]
+[\-delay \fIusecs\fP]
+[\-delay2 \fIusecs\fP]
+[\-window]
+[\-root]
+[\-install]
+[\-visual \fIvisual\fP]
 .SH DESCRIPTION
-The \fIslidescreen\fP program takes an image of the screen, divides it into
+The \fIslidescreen\fP program takes an image, divides it into
 a grid, deletes a random square of that grid, and then randomly slides 
 one of the neighbors of this "hole" into the hole (and repeat.)
+
+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 slidescreen
 accepts the following options:
@@ -40,10 +59,10 @@ How much of a delay should be introduced between steps of the animation of
 the motion of each segment.  Default 50000, which is 0.05 seconds.  This
 is closely related to the \fI\-increment\fP parameter.
 .TP 8
-.B \-delay \fImicroseconds\fP
+.B \-delay2 \fImicroseconds\fP
 How much of a delay should be introduced between the end of the motion of
 one segment and the beginning of the motion of another.  Default 1000000,
-which isone second.
+which is one second.
 .SH ENVIRONMENT
 .PP
 .TP 8
@@ -55,7 +74,9 @@ to get the name of a resource file that overrides the global resources
 stored in the RESOURCE_MANAGER property.
 .SH SEE ALSO
 .BR X (1),
-.BR xscreensaver (1)
+.BR xscreensaver (1),
+.BR xscreensaver\-demo (1),
+.BR xscreensaver\-getimage (1)
 .SH COPYRIGHT
 Copyright \(co 1992 by Jamie Zawinski.  Permission to use, copy, modify, 
 distribute, and sell this software and its documentation for any purpose is 
@@ -65,4 +86,4 @@ appear in supporting documentation.  No representations are made about the
 suitability of this software for any purpose.  It is provided "as is" without
 express or implied warranty.
 .SH AUTHOR
-Jamie Zawinski <jwz@mcom.com>, 3-dec-92.
+Jamie Zawinski <jwz@jwz.org>, 3-dec-92.