http://www.jwz.org/xscreensaver/xscreensaver-5.07.tar.gz

[xscreensaver] / hacks / distort.man

diff --git a/hacks/distort.man b/hacks/distort.man
index a4b3dcdbc0fc1fba1e7c66bdf252341210f1df47..eedb924e80f41b6dc135da5f2f26d8f7c01fe8d5 100644 (file)
--- a/hacks/distort.man
+++ b/hacks/distort.man
@@ -3,12 +3,36 @@
 distort \- distort the content of the screen in interesting ways
 .SH SYNOPSIS
 .B distort
-[\-root] [\-window] [\-mono] [\-install] [\-noinstall] [\-visual \fIvisual\fP] [\-window\-id \fIwindow\-id\fP] [\-delay \fIusecs\fP] [\-radius \fIpixels\fP] [\-speed \fIfloat\fP] [\-number \fIint\fP] [\-swamp] [\-bounce] [\-reflect] [\-vortex] [\-magnify] [\-blackhole] [\-slow] [\-shm] [\-no\-shm]
+[\-root] [\-window] [\-mono] [\-install] [\-noinstall] [\-visual \fIvisual\fP]
+[\-window\-id \fIwindow\-id\fP]
+[\-delay \fIusecs\fP]
+[\-duration \fIsecs\fP]
+[\-radius \fIpixels\fP]
+[\-speed \fIint\fP]
+[\-number \fIint\fP]
+[\-swamp]
+[\-bounce]
+[\-reflect]
+[\-vortex]
+[\-magnify]
+[\-blackhole]
+[\-slow]
+[\-shm] [\-no\-shm]
+[\-fps]
 .SH DESCRIPTION
-The \fIdistort\fP program lets circular zones of distortion wander
-randomly around its window, apparently distorting what is under them
-due to the window's pseudo-transparency. The mode of distortion and
-the overall behaviour of the zones can be influenced in various ways.
+The \fIdistort\fP program takes an image and lets circular zones of
+distortion wander randomly around it, distorting what is under them.
+The mode of distortion and the overall behaviour of the zones can be
+influenced in various ways.
+
+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 distort
 accepts the following options:
@@ -38,19 +62,24 @@ Specify which window id to use.
 .B \-delay \fIusecs\fP
 Specify the delay between subsequent animation frames in microseconds.
 .TP 8
+.B \-duration \fIseconds\fP
+How long to run before loading a new image.  Default 120 seconds.
+.TP 8
 .B \-radius \fIpixels\fP
 Specify the radius of the distortion zone in pixels.
 .TP 8
-.B \-speed \fIfloat\fP
-Specify the speed of the distortion zone, where 1.0 is kind of slow,
-0.5 is twice as slow and 2.0 is twice as fast.
+.B \-speed \fIint\fP
+Specify the speed at which the distortion zone moves, where 0 is slow,
+higher numbers are faster (10 is pretty fast.)
 .TP 8
 .B \-number \fIint\fP
 Specify the number of distortion zones.
 .TP 8
 .B \-swamp
 Instead of letting zones wander around, let small zones pop up like
-bubbles in a swamp and leave permanent distortion.
+bubbles in a swamp and leave permanent distortion.  \fBWARNING:\fP
+this option uses a \fIcolossal\fP amount of memory: keep the \fI\-radius\fP
+small when using \fI\-swamp\fP.
 .TP 8
 .B \-bounce
 Let zones wander around and bounce off the window border. This is the
@@ -77,6 +106,9 @@ Use shared memory extension.
 .TP 8
 .B \-no\-shm
 Don't use shared memory extension.
+.TP 8
+.B \-fps
+Display the current frame rate and CPU load.
 .SH ENVIRONMENT
 .PP
 .TP 8
@@ -88,7 +120,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 1998 by Jonas Munsin and Jamie Zawinski.  Permission to use, 
 copy, modify, distribute, and sell this software and its documentation for