git.hungrycats.org Git - xscreensaver/blob - hacks/spotlight.man

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