summaryrefslogtreecommitdiffstats
path: root/hacks/xscreensaver-getimage-file.man
blob: 2525d161939096f2a1580a55f3437e7fb69ab781 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
.TH XScreenSaver 1 "20-Mar-2005 (4.21)" "X Version 11"
.SH NAME
xscreensaver-getimage-file - select a random image file for use by screen savers
.SH SYNOPSIS
.B xscreensaver-getimage-file
[\--verbose]
[\--no-cache]
[\--flush-caches]
directory-or-URL
.SH DESCRIPTION
The \fIxscreensaver\-getimage\-file\fP program is a helper program
for the xscreensaver hacks that manipulate images.  It is invoked by
.BR xscreensaver\-getimage (MANSUFFIX)
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.

.SH OPTIONS
.I xscreensaver-getimage-file
accepts the following options:
.TP 4
.B --verbose
Print diagnostics.
.TP 4
.B --no-cache
Ignore the cache when searching for images.  This may be slow.
.TP 4
.B --flush-caches
Discard all caches immediately.  They will be re-generated as needed.
.TP 4
.I directory-or-URL
If a pathname it is the directory tree whose images should be used.

If a URL is specified, it should be the URL of an RSS or Atom feed
containing images.  The first time it is accessed, all of the images
in the feed will be downloaded to a local cache directory.  The URL
will be polled again when the cache times out.  Any new images will
be downloaded and cached, and any images no longer in the feed will
be discarded.
.SH SEE ALSO
.BR X (1),
.BR xscreensaver (1),
.BR xscreensaver\-settings (1),
.BR xscreensaver\-getimage (MANSUFFIX)
.SH COPYRIGHT
Copyright \(co 2001-2021 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.
.SH AUTHOR
Jamie Zawinski <jwz@jwz.org>, 14-Apr-2001.