f69bffb17a69c9c2e0185eba96e9aed3ebfa81af
[xscreensaver] / driver / xscreensaver-getimage-file.man
1 .TH XScreenSaver 1 "23-Jun-2003 (4.11)" "X Version 11"
2 .SH NAME
3 xscreensaver-getimage-file - put a randomly-selected image on the root window
4 .SH SYNOPSIS
5 .B xscreensaver-getimage-file
6 [\-display \fIhost:display.screen\fP] [\--verbose] [\--name] directory
7 .SH DESCRIPTION
8 The \fIxscreensaver\-getimage\-file\fP program is a helper program
9 for the xscreensaver hacks that manipulate images.  Specifically, it
10 is invoked by
11 .BR xscreensaver\-getimage (1)
12 as needed.  This is not a user-level command.
13
14 This program selects a random image from disk, and loads it on the root
15 window.  It does this by figuring out which image-loading programs are
16 installed on the system, and invoking the first one it finds.
17 .SH OPTIONS
18 .I xscreensaver-getimage-file
19 accepts the following options:
20 .TP 4
21 .B --verbose
22 Print diagnostics.
23 .TP 4
24 .B --name
25 Don't load an image: instead just print the file name to stdout.
26 .TP 4
27 .I directory
28 The directory to search.   The directory will be searched recursively,
29 and all files in it are assumed to be images.
30 .SH SEE ALSO
31 .BR X (1),
32 .BR xscreensaver (1),
33 .BR xscreensaver\-demo (1),
34 .BR xscreensaver\-getimage (1),
35 .BR xv (1),
36 .BR xli (1),
37 .BR xloadimage (1),
38 .BR chbg (1)
39 .SH COPYRIGHT
40 Copyright \(co 2001 by Jamie Zawinski.  Permission to use, copy,
41 modify, distribute, and sell this software and its documentation for
42 any purpose is hereby granted without fee, provided that the above
43 copyright notice appear in all copies and that both that copyright
44 notice and this permission notice appear in supporting documentation.
45 No representations are made about the suitability of this software for
46 any purpose.  It is provided "as is" without express or implied
47 warranty.
48 .SH AUTHOR
49 Jamie Zawinski <jwz@jwz.org>, 14-Apr-01