git.hungrycats.org Git - xscreensaver/blob - driver/xscreensaver-getimage.man

   1 .TH XScreenSaver 1 "23-Jun-2003 (4.11)" "X Version 11"
   2 .SH NAME
   3 xscreensaver-getimage - put some randomly-selected image on the root window
   4 .SH SYNOPSIS
   5 .B xscreensaver-getimage
   6 [\-display \fIhost:display.screen\fP] [\--verbose] window-id
   7 .SH DESCRIPTION
   8 The \fIxscreensaver\-getimage\fP program is a helper program for the
   9 xscreensaver hacks that manipulate images.  This is not a user-level
  10 command.
  11
  12 This program selects a random image, and puts it on the specified
  13 window.  This image might be a snapshot of the desktop; or a frame
  14 captured from the system's video input; or a randomly-selected image
  15 from disk.
  16 .SH OPTIONS
  17 .I xscreensaver-getimage
  18 reads the \fI~/.xscreensaver\fP file for configuration information.
  19 It uses these settings:
  20 .TP 4
  21 .B grabDesktopImages
  22 Whether it is acceptable to grab snapshots of the desktop.
  23 The security paranoid might want to turn this off, to avoid letting
  24 people see (but not touch!) your desktop while the screen is locked.
  25 .TP 4
  26 .B grabVideoFrames
  27 Whether it is acceptable to grab frames of video from the system's video
  28 input.  Grabbing of video is done by invoking the
  29 .BR xscreensaver-getimage-video (1)
  30 program.
  31 .TP 4
  32 .B chooseRandomImages
  33 Whether it is acceptable to display random images found on disk.
  34 Selection and loading of images is done by invoking the
  35 .BR xscreensaver-getimage-file (1)
  36 program.
  37 .TP 4
  38 .B imageDirectory
  39 When loading images from disk, this is the directory to search.
  40 The directory will be searched recursively, and all files in it are
  41 assumed to be images.
  42 .PP
  43 If none of the three options are set to True, then video
  44 colorbars will be displayed instead.
  45 .SH BUGS
  46 If the target window is not the root window, then this program
  47 will \fIalways\fP grab a desktop image.  This means that if an
  48 image-manipulating xscreensaver mode is run in a normal window,
  49 it will always operate on a desktop image; it's only when it is
  50 run in \fI-root\fP mode (or when invoked by xscreensaver) that
  51 it will load image files or grab video.
  52 .SH SEE ALSO
  53 .BR X (1),
  54 .BR xscreensaver (1)
  55 .BR xscreensaver\-demo (1)
  56 .BR xscreensaver\-getimage\-file (1)
  57 .BR xscreensaver\-getimage\-video (1)
  58 .SH COPYRIGHT
  59 Copyright \(co 2001 by Jamie Zawinski.  Permission to use, copy,
  60 modify, distribute, and sell this software and its documentation for
  61 any purpose is hereby granted without fee, provided that the above
  62 copyright notice appear in all copies and that both that copyright
  63 notice and this permission notice appear in supporting documentation.
  64 No representations are made about the suitability of this software for
  65 any purpose.  It is provided "as is" without express or implied
  66 warranty.
  67 .SH AUTHOR
  68 Jamie Zawinski <jwz@jwz.org>, 14-Apr-01