-.TH XScreenSaver 1 "03-Feb-2003 (4.07)" "X Version 11"
+.TH XScreenSaver 1 "20-Mar-2005 (4.21)" "X Version 11"
.SH NAME
xscreensaver-getimage - put some randomly-selected image on the root window
.SH SYNOPSIS
.B xscreensaver-getimage
-[\-display \fIhost:display.screen\fP] [\--verbose] window-id
+[\-display \fIhost:display.screen\fP] [\--verbose] window-id [pixmap-id]
.SH DESCRIPTION
The \fIxscreensaver\-getimage\fP 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.
+window or pixmap. 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.
+
+If only a window ID is specified, the image will be painted there.
+If both a window ID and a pixmap ID are specified, then the image will
+be painted on the pixmap; and the window \fImay\fP be modified as a
+side-effect.
.SH OPTIONS
.I xscreensaver-getimage
reads the \fI~/.xscreensaver\fP file for configuration information.
program.
.TP 4
.B imageDirectory
-When loading images from disk, this is the directory to search.
-The directory will be searched recursively, and all files in it are
-assumed to be images.
+When loading images from disk, this is the directory to find them in.
+The directory will be searched recursively for images.
+
+It may also be the URL of an RSS or Atom feed, in which case a
+random image from that feed will be selected instead. The contents
+of the feed will be cached locally and refreshed periodically as needed.
.PP
If none of the three options are set to True, then video
colorbars will be displayed instead.
.SH BUGS
-If the target window is not the root window, then this program
-will \fIalways\fP 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 \fI-root\fP mode (or when invoked by xscreensaver) that
-it will load image files or grab video.
+When grabbing desktop images, the \fIwindow\fP argument will be unmapped
+and have its contents modified, causing flicker. (This does not happen
+when loading image files or video frames.)
.SH SEE ALSO
.BR X (1),
.BR xscreensaver (1)
.BR xscreensaver\-getimage\-file (1)
.BR xscreensaver\-getimage\-video (1)
.SH COPYRIGHT
-Copyright \(co 2001 by Jamie Zawinski. Permission to use, copy,
+Copyright \(co 2001-2011 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
projects / xscreensaver / blobdiff