1xscreensaver-getimage(6x)     XScreenSaver manual    xscreensaver-getimage(6x)
2
3
4

NAME

6       xscreensaver-getimage  -  loads  a  randomly-selected image onto an X11
7       Drawable for use by screen savers
8

SYNOPSIS

10       xscreensaver-getimage [--display host:display.screen] [--verbose]  win‐
11       dow-id [pixmap-id]
12

DESCRIPTION

14       The  xscreensaver-getimage program is a helper program for the xscreen‐
15       saver hacks that manipulate images.
16
17       This program selects a random image, and puts it on the specified  win‐
18       dow  or  pixmap.   This  image might be a snapshot of the desktop; or a
19       frame captured from the system's video input;  or  a  randomly-selected
20       image from disk.
21
22       If  only a window ID is specified, the image will be painted there.  If
23       both a window ID and a pixmap ID are specified, then the image will  be
24       painted on the pixmap; and the window may be modified as a side-effect.
25

OPTIONS

27       xscreensaver-getimage  reads the ~/.xscreensaver file for configuration
28       information.  It uses these settings:
29
30       grabDesktopImages
31           Whether it is acceptable to grab snapshots of the desktop.  The se‐
32           curity  paranoid might want to turn this off, to avoid letting peo‐
33           ple see (but not touch!) your desktop while the screen is locked.
34
35       grabVideoFrames
36           Whether it is acceptable to grab frames of video from the  system's
37           video  input.   Grabbing  of video is done by invoking the xscreen‐
38           saver-getimage-video(6x) program.
39
40       chooseRandomImages
41           Whether it is acceptable to display random images  found  on  disk.
42           Selection  and  loading  of images is done by invoking the xscreen‐
43           saver-getimage-file(6x) program.
44
45       imageDirectory
46           When loading images from disk, this is the directory to  find  them
47           in.  The directory will be searched recursively for images.
48
49           It may also be the URL of an RSS or Atom feed, in which case a ran‐
50           dom image from that feed will be selected instead.  The contents of
51           the  feed  will  be  cached  locally  and refreshed periodically as
52           needed.
53
54       If none of the three options are set to True, then video colorbars will
55       be displayed instead.
56

BUGS

58       When  grabbing desktop images, the window argument will be unmapped and
59       have its contents modified, causing flicker.   (This  does  not  happen
60       when loading image files or video frames.)
61

SEE ALSO

63       X(1),   xscreensaver(1)   xscreensaver-settings(1)  xscreensaver-getim‐
64       age-file(6x) xscreensaver-getimage-video(6x)
65
67       Copyright © 2001-2021 by Jamie Zawinski.  Permission to use, copy, mod‐
68       ify,  distribute,  and sell this software and its documentation for any
69       purpose is hereby granted without fee, provided that  the  above  copy‐
70       right  notice  appear in all copies and that both that copyright notice
71       and this permission notice appear in supporting documentation.  No rep‐
72       resentations  are  made  about the suitability of this software for any
73       purpose.  It is provided "as is" without express or implied warranty.
74

AUTHOR

76       Jamie Zawinski <jwz@jwz.org>, 14-Apr-2001
77
78
79
80X Version 11               6.06-1.fc37 (12-Dec-2022) xscreensaver-getimage(6x)
Impressum