xscreensaver-getimage-file(6) XScreenSaver manual

NAME

xscreensaver-getimage-file - select a random image file for use by
screen savers

SYNOPSIS

xscreensaver-getimage-file [--verbose] [--no-cache] [--flush-caches]
directory-or-URL

DESCRIPTION

The xscreensaver-getimage-file program is a helper program for the
xscreensaver hacks that manipulate images. It is invoked by
xscreensaver-getimage(6) as needed.

It prints the name of a randomly-selected image file. The directory
is searched recursively. Non-image files and images smaller than
500x500 are excluded.

The directory may also be the URL of an RSS/Atom feed. Enclosed
images will be downloaded and cached locally.

The contents of the directory are cached, for performance. The cache
is re-generated if 3 hours have passed.

OPTIONS

xscreensaver-getimage-file accepts the following options:

--verbose
Print diagnostics.

--no-cache
Ignore the cache when searching for images. This may be slow.

--flush-cache
Discard all caches immediately. They will be re-generated as
needed.

directory-or-URL
If it is a pathname, it will be searched recursively for images.

If it is a URL, it should be an RSS or Atom feed, or an HTML page
whose metadata links to its feed. All of the feed's images will
be downloaded to a local cache. The URL will be re-polled
periodically, downloading any new images and removing expired
ones.

FILES

Depending on your operating system, the filename cache will be one
of:

$HOME/.cache/xscreensaver/xscreensaver-getimage.cache
$HOME/tmp/.xscreensaver-getimage.cache
$HOME/.xscreensaver-getimage.cache
$HOME/Library/Caches/org.jwz.xscreensaver.getimage.cache

Images from feeds will be downloaded and cached at one of:

$HOME/.cache/xscreensaver/SUBDIR/
$HOME/tmp/.xscreensaver-feeds/SUBDIR/
$HOME/.xscreensaver-feeds/SUBDIR/
$HOME/Library/Caches/org.jwz.xscreensaver.feeds/SUBDIR/

SEE ALSO

X(1), xscreensaver(1), xscreensaver-settings(1),
xscreensaver-getimage(6)

COPYRIGHT

Copyright (C) 2001-2022 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-2001.

X Version 11 6.09 (07-Jun-2024)
xscreensaver-getimage-file(6)