http://www.tienza.es/crux/src/www.jwz.org/xscreensaver/xscreensaver-5.06.tar.gz

[xscreensaver] / hacks / slidescreen.man

diff --git a/hacks/slidescreen.man b/hacks/slidescreen.man
index a3e9d902f5fc65aeff5ad9a978dc1c443d8c0251..f9bbac450c0adaf83f368af59e8d135e42c0c65f 100644 (file)
--- a/hacks/slidescreen.man
+++ b/hacks/slidescreen.man
@@ -3,11 +3,31 @@
 slidescreen - permute the screen image like an 8-puzzle
 .SH SYNOPSIS
 .B slidescreen
 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]
+[\-duration \fIsecs\fP]
+[\-window]
+[\-root]
+[\-install]
+[\-visual \fIvisual\fP]

 .SH DESCRIPTION
 .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.)
 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:
 .SH OPTIONS
 .I slidescreen
 accepts the following options:


@@ -29,7 +49,7 @@ or the id number (decimal or hex) of a specific visual.
 The size of the grid cells.  Default 70 pixels.
 .TP 8
 .B \-ibw \fIpixels\fP
 The size of the grid cells.  Default 70 pixels.
 .TP 8
 .B \-ibw \fIpixels\fP

-The size of the "gutter" between grid cells.  Default 1 pixel.
+The size of the "gutter" between grid cells.  Default 4 pixel.

 .TP 8
 .B \-increment \fIpixels\fP
 How many pixels by which a piece should be moved when sliding to a new 
 .TP 8
 .B \-increment \fIpixels\fP
 How many pixels by which a piece should be moved when sliding to a new 


@@ -40,34 +60,13 @@ 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
 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 is one second.
 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 is one second.

-.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
 .TP 8

-.B videoGain \fR(Float)\fP
-The amount by which to brighten the grabbed image.  This defaults to 2.2.
+.B \-duration \fIseconds\fP
+How long to run before loading a new image.  Default 120 seconds.

 .SH ENVIRONMENT
 .PP
 .TP 8
 .SH ENVIRONMENT
 .PP
 .TP 8


@@ -79,7 +78,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),
 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 
 .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