source: trunk/third/xscreensaver/hacks/spotlight.man @ 20148

Revision 20148, 2.3 KB checked in by ghudson, 21 years ago (diff)
This commit was generated by cvs2svn to compensate for changes in r20147, which included commits to RCS files with non-trunk default branches.
Line 
1.TH XScreenSaver 1 "05-Apr-1999" "X Version 11"
2.SH NAME
3spotlight - move spotlight around desktop
4.SH SYNOPSIS
5.B spotlight
6[\-display \fIhost:display.screen\fP] [\-foreground \fIcolor\fP]
7[\-background \fIcolor\fP] [\-window] [\-root] [\-mono] [\-install]
8[\-visual \fIvisual\fP] [\-delay \fIusecs\fP] [\-radius \fIpixels\fP]
9.SH DESCRIPTION
10The \fIspotlight\fP program takes an image and exposes small sections
11of it as if through a wandering spotlight beam.
12
13The image that it manipulates will be grabbed from the portion of
14the screen underlying the window, or from the system's video input,
15or from a random file on disk, as indicated by
16the \fIgrabDesktopImages\fP, \fIgrabVideoFrames\fP,
17and \fIchooseRandomImages\fP options in the \fI~/.xscreensaver\fP
18file; see
19.BR xscreensaver-demo (1)
20for more details.
21.SH OPTIONS
22.I spotlight
23accepts the following options:
24.TP 8
25.B \-window
26Draw on a newly-created window.  This is the default.
27.TP 8
28.B \-root
29Draw on the root window.
30.TP 8
31.B \-mono
32If on a color display, pretend we're on a monochrome display.
33.TP 8
34.B \-install
35Install a private colormap for the window.
36.TP 8
37.B \-visual \fIvisual\fP
38Specify which visual to use.  Legal values are the name of a visual class,
39or the id number (decimal or hex) of a specific visual.
40.TP 8
41.B \-delay \fImicroseconds\fP
42Slow it down.
43.TP 8
44.B \-radius \fIpixels\fP
45Radius of the spotlight in pixels.
46.SH ENVIRONMENT
47.PP
48.TP 8
49.B DISPLAY
50to get the default host and display number.
51.TP 8
52.B XENVIRONMENT
53to get the name of a resource file that overrides the global resources
54stored in the RESOURCE_MANAGER property.
55.SH SEE ALSO
56.BR X (1),
57.BR xscreensaver (1),
58.BR xscreensaver\-demo (1),
59.BR xscreensaver\-getimage (1)
60.SH COPYRIGHT
61Copyright \(co 1999 by Rick Schultz.  Permission to use, copy, modify,
62distribute, and sell this software and its documentation for any purpose is
63hereby granted without fee, provided that the above copyright notice appear
64in all copies and that both that copyright notice and this permission notice
65appear in supporting documentation.  No representations are made about the
66suitability of this software for any purpose.  It is provided "as is" without
67express or implied warranty.
68.SH CREDITS
69Hacked together by Rick Schultz <rick@skapunx.net>, based on StefView for
70BackSpace by Darcy Brockbank and on several other xscreensaver hacks.
Note: See TracBrowser for help on using the repository browser.