xscreensaver-getimage
XScreenSaver(r)                                   XScreenSaver(r)



NAME
       xscreensaver-getimage  -  put some randomly-selected image
       on the root window

SYNOPSIS
       xscreensaver-getimage    [-display    host:display.screen]
       [--verbose] window-id

DESCRIPTION
       The  xscreensaver-getimage program is a helper program for
       the xscreensaver hacks that manipulate  images.   This  is
       not a user-level command.

       This  program  selects  a random image, and puts it on the
       specified window.  This image might be a snapshot  of  the
       desktop;  or  a  frame  captured  from  the system's video
       input; or a randomly-selected image from disk.

OPTIONS
       xscreensaver-getimage reads the ~/.xscreensaver  file  for
       configuration information.  It uses these settings:

       grabDesktopImages
           Whether  it  is  acceptable  to  grab snapshots of the
           desktop.  The security paranoid  might  want  to  turn
           this off, to avoid letting people see (but not touch!)
           your desktop while the screen is locked.

       grabVideoFrames
           Whether it is acceptable to grab frames of video  from
           the  system's  video input.  Grabbing of video is done
           by invoking  the  xscreensaver-getimage-video(o)  pro-
           gram.

       chooseRandomImages
           Whether  it  is  acceptable  to  display random images
           found on disk.  Selection and  loading  of  images  is
           done  by  invoking  the  xscreensaver-getimage-file(e)
           program.

       imageDirectory
           When loading images from disk, this is  the  directory
           to  search.   The  directory  will  be searched recur-
           sively, and all files in it are assumed to be  images.

       If  none  of the three options are set to True, then video
       colorbars will be displayed instead.

BUGS
       If the target window is not the  root  window,  then  this
       program will always grab a desktop image.  This means that
       if an image-manipulating xscreensaver mode  is  run  in  a
       normal  window, it will always operate on a desktop image;
       it's only when it is run in -root mode (or when invoked by
       xscreensaver) that it will load image files or grab video.

SEE ALSO
       X(X),   xscreensaver(r)   xscreensaver-demo(o)    xscreen-
       saver-getimage-file(e) xscreensaver-getimage-video(o)

COPYRIGHT
       Copyright  (C) 2001 by Jamie Zawinski.  Permission to use,
       copy, modify, distribute, and sell this software  and  its
       documentation  for  any  purpose is hereby granted without
       fee, provided that the above copyright  notice  appear  in
       all  copies  and  that both that copyright notice and this
       permission notice appear in supporting documentation.   No
       representations  are  made  about  the suitability of this
       software for any purpose.  It is provided "as is"  without
       express or implied warranty.

AUTHOR
       Jamie Zawinski <jwz@jwz.org>, 14-Apr-01



X Version 11            25-Oct-2001 (3.34)        XScreenSaver(r)