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