http://www.tienza.es/crux/src/www.jwz.org/xscreensaver/xscreensaver-5.06.tar.gz
[xscreensaver] / hacks / zoom.man
index ec21d3c2bdcad43dcf8f6b1b18ae4ecdb825a40f..85cac1b2038212388d45e5f3d255a51b2bdecac2 100644 (file)
@@ -1,11 +1,29 @@
 .TH XScreenSaver 1 "20-Nov-2000" "X Version 11"
 .SH NAME
-zoom - wander around magified desktop
+zoom - wander around magnified desktop
 .SH SYNOPSIS
 .B zoom
-[\-display \fIhost:display.screen\fP] [\-foreground \fIcolor\fP] [\-background \fIcolor\fP] [\-window] [\-root] [\-mono] [\-install] [\-visual \fIvisual\fP] [\-delay \fIusecs\fP] [\-lenses] [\-pixwidth \fIpixels\fP] [\-pixheight \fIpixels\fP] [\-pixspacex \fIpixels\fP] [\-pixspacey \fIpixels\fP] [\-lensoffsetx \fIpixels\fP] [\-lensoffsety \fIpixels\fP]
+[\-display \fIhost:display.screen\fP] [\-foreground \fIcolor\fP]
+[\-background \fIcolor\fP] [\-window] [\-root] [\-mono] [\-install]
+[\-visual \fIvisual\fP]
+[\-delay \fIusecs\fP]
+[\-duration \fIsecs\fP]
+[\-lenses]
+[\-pixwidth \fIpixels\fP] [\-pixheight \fIpixels\fP]
+[\-pixspacex \fIpixels\fP] [\-pixspacey \fIpixels\fP]
+[\-lensoffsetx \fIpixels\fP] [\-lensoffsety \fIpixels\fP]
 .SH DESCRIPTION
-The \fIzoom\fP program magnifies a portion of the desktop and moves around.
+The \fIzoom\fP program takes an image, magnifies it, and scrolls around
+it, fatbits-style.
+
+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 zoom
 accepts the following options:
@@ -29,6 +47,9 @@ or the id number (decimal or hex) of a specific visual.
 .B \-delay \fImicroseconds\fP
 Slow it down.
 .TP 8
+.B \-duration \fIseconds\fP
+How long to run before loading a new image.  Default 120 seconds.
+.TP 8
 .B \-lenses
 Instead of doing magnification we just copy an offset region from the original
 image.  If lensoffsetx < pixwidth (and similarly for Y) then consecutive
@@ -48,13 +69,13 @@ Amount of black space between magnified pixels (X direction).
 Amount of black space between magnified pixels (Y direction).
 .TP 8
 .B \-lensoffsetx \fIpixels\fP
-Distance in X direction between consective copied regions (only effective
+Distance in X direction between consecutive copied regions (only effective
 when 
 .I -lenses
 used).
 .TP 8
 .B \-lensoffsety \fIpixels\fP
-Distance in Y direction between consective copied regions (only effective
+Distance in Y direction between consecutive copied regions (only effective
 when 
 .I -lenses
 used).
@@ -70,7 +91,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 2000 by James Macnicol.  Permission to use, copy, modify, 
 distribute, and sell this software and its documentation for any purpose is