X-Git-Url: http://git.hungrycats.org/cgi-bin/gitweb.cgi?a=blobdiff_plain;f=hacks%2Fspotlight.man;h=7984ff6b544d65cd8866b2dfbb68d1ba6e804022;hb=de460e831dc8578acfa8b72251ab9346c99c1f96;hp=31e9f71b9a6b9c71d87d94f0f816441a473532f1;hpb=a719ec12b8b2563112366a8ac3196816fd64d2c7;p=xscreensaver

diff --git a/hacks/spotlight.man b/hacks/spotlight.man
index 31e9f71b..7984ff6b 100644
--- a/hacks/spotlight.man
+++ b/hacks/spotlight.man
@@ -3,9 +3,24 @@
 spotlight - move spotlight around desktop
 .SH SYNOPSIS
 .B spotlight
-[\-display \fIhost:display.screen\fP] [\-foreground \fIcolor\fP] [\-background \fIcolor\fP] [\-window] [\-root] [\-mono] [\-install] [\-visual \fIvisual\fP] [\-delay \fIusecs\fP] [\-radius \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]
+[\-radius \fIpixels\fP]
 .SH DESCRIPTION
-The \fIspotlight\fP program draws random rectangles.
+The \fIspotlight\fP program takes an image and exposes small sections
+of it as if through a wandering spotlight beam.
+
+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 spotlight
 accepts the following options:
@@ -29,6 +44,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 \-radius \fIpixels\fP
 Radius of the spotlight in pixels.
 .SH ENVIRONMENT
@@ -42,7 +60,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 1999 by Rick Schultz.  Permission to use, copy, modify, 
 distribute, and sell this software and its documentation for any purpose is 
@@ -54,4 +74,3 @@ express or implied warranty.
 .SH CREDITS
 Hacked together by Rick Schultz <rick@skapunx.net>, based on StefView for
 BackSpace by Darcy Brockbank and on several other xscreensaver hacks.
-