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

   1 .TH XScreenSaver 1 "20-Mar-2005 (4.21)" "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 [pixmap-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 or pixmap.  This image might be a snapshot of the desktop; or
  14 a frame captured from the system's video input; or a randomly-selected
  15 image from disk.
  16
  17 If only a window ID is specified, the image will be painted there.
  18 If both a window ID and a pixmap ID are specified, then the image will
  19 be painted on the pixmap; and the window \fImay\fP be modified as a
  20 side-effect.
  21 .SH OPTIONS
  22 .I xscreensaver-getimage
  23 reads the \fI~/.xscreensaver\fP file for configuration information.
  24 It uses these settings:
  25 .TP 4
  26 .B grabDesktopImages
  27 Whether it is acceptable to grab snapshots of the desktop.
  28 The security paranoid might want to turn this off, to avoid letting
  29 people see (but not touch!) your desktop while the screen is locked.
  30 .TP 4
  31 .B grabVideoFrames
  32 Whether it is acceptable to grab frames of video from the system's video
  33 input.  Grabbing of video is done by invoking the
  34 .BR xscreensaver-getimage-video (1)
  35 program.
  36 .TP 4
  37 .B chooseRandomImages
  38 Whether it is acceptable to display random images found on disk.
  39 Selection and loading of images is done by invoking the
  40 .BR xscreensaver-getimage-file (1)
  41 program.
  42 .TP 4
  43 .B imageDirectory
  44 When loading images from disk, this is the directory to find them in.
  45 The directory will be searched recursively for images.
  46
  47 It may also be the URL of an RSS or Atom feed, in which case a
  48 random image from that feed will be selected instead.  The contents
  49 of the feed will be cached locally and refreshed periodically as needed.
  50 .PP
  51 If none of the three options are set to True, then video
  52 colorbars will be displayed instead.
  53 .SH BUGS
  54 When grabbing desktop images, the \fIwindow\fP argument will be unmapped
  55 and have its contents modified, causing flicker.  (This does not happen
  56 when loading image files or video frames.)
  57 .SH SEE ALSO
  58 .BR X (1),
  59 .BR xscreensaver (1)
  60 .BR xscreensaver\-demo (1)
  61 .BR xscreensaver\-getimage\-file (1)
  62 .BR xscreensaver\-getimage\-video (1)
  63 .SH COPYRIGHT
  64 Copyright \(co 2001-2011 by Jamie Zawinski.  Permission to use, copy,
  65 modify, distribute, and sell this software and its documentation for
  66 any purpose is hereby granted without fee, provided that the above
  67 copyright notice appear in all copies and that both that copyright
  68 notice and this permission notice appear in supporting documentation.
  69 No representations are made about the suitability of this software for
  70 any purpose.  It is provided "as is" without express or implied
  71 warranty.
  72 .SH AUTHOR
  73 Jamie Zawinski <jwz@jwz.org>, 14-Apr-01