File: xscreensaver-getimage-file.man

package info (click to toggle)
xscreensaver 6.09%2Bdfsg1-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 63,852 kB
  • sloc: ansic: 503,539; xml: 10,207; makefile: 10,016; perl: 7,146; sh: 4,316; asm: 3,513; objc: 3,359
file content (79 lines) | stat: -rw-r--r-- 2,744 bytes parent folder | download | duplicates (3)
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
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
.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-cache
Discard all caches immediately.  They will be re-generated as needed.
.TP 4
.I 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.
.SH FILES
Depending on your operating system, the filename cache will be one of:
.nf
.sp
        $HOME/.cache/xscreensaver/xscreensaver-getimage.cache
        $HOME/tmp/.xscreensaver-getimage.cache
        $HOME/.xscreensaver-getimage.cache
        $HOME/Library/Caches/org.jwz.xscreensaver.getimage.cache
.fi

Images from feeds will be downloaded and cached at one of:
.nf
.sp
        $HOME/.cache/xscreensaver/\fISUBDIR\fP/
        $HOME/tmp/.xscreensaver-feeds/\fISUBDIR\fP/
        $HOME/.xscreensaver-feeds/\fISUBDIR\fP/
        $HOME/Library/Caches/org.jwz.xscreensaver.feeds/\fISUBDIR\fP/
.fi
.SH SEE ALSO
.BR X (1),
.BR xscreensaver (1),
.BR xscreensaver\-settings (1),
.BR xscreensaver\-getimage (MANSUFFIX)
.SH COPYRIGHT
Copyright \(co 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.
.SH AUTHOR
Jamie Zawinski <jwz@jwz.org>, 14-Apr-2001.