git.hungrycats.org Git - xscreensaver/blob - driver/xscreensaver-getimage-file.man

   1 .TH XScreenSaver 1 "20-Mar-2005 (4.21)" "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]
   7 [\--verbose]
   8 [\--name]
   9 [\--no-cache]
  10 directory-or-URL
  11 .SH DESCRIPTION
  12 The \fIxscreensaver\-getimage\-file\fP program is a helper program
  13 for the xscreensaver hacks that manipulate images.  Specifically, it
  14 is invoked by
  15 .BR xscreensaver\-getimage (1)
  16 as needed.  This is not a user-level command.
  17
  18 This program selects a random image from disk, and loads it on the root
  19 window.  It does this by figuring out which image-loading programs are
  20 installed on the system, and invoking the first one it finds.
  21 .SH OPTIONS
  22 .I xscreensaver-getimage-file
  23 accepts the following options:
  24 .TP 4
  25 .B --verbose
  26 Print diagnostics.
  27 .TP 4
  28 .B --name
  29 Don't load an image: instead just print the file name to stdout.
  30 .TP 4
  31 .I directory-or-URL
  32 If a directory is specified, it will be searched recursively for
  33 images.  Any images found will eligible for display.  For efficiency,
  34 the contents of the directory are cached for a few hours before it
  35 is re-scanned.
  36
  37 If a URL is specified, it should be the URL of an RSS or Atom feed
  38 containing images.  The first time it is accessed, all of the images
  39 in the feed will be downloaded to a local cache directory.  If a few
  40 hours have elapsed since last time, the URL will be polled again, and
  41 any new images will be cached, any images no longer in the feed
  42 will be expired.
  43 .TP 4
  44 .B --no-cache
  45 Update the cache immediately, even if it is not time yet.  This
  46 will re-scan the directory, or re-poll the RSS feed.
  47 .SH SEE ALSO
  48 .BR X (1),
  49 .BR xscreensaver (1),
  50 .BR xscreensaver\-demo (1),
  51 .BR xscreensaver\-getimage (1),
  52 .BR xv (1),
  53 .BR xli (1),
  54 .BR xloadimage (1),
  55 .BR chbg (1)
  56 .SH COPYRIGHT
  57 Copyright \(co 2001-2012 by Jamie Zawinski.  Permission to use, copy,
  58 modify, distribute, and sell this software and its documentation for
  59 any purpose is hereby granted without fee, provided that the above
  60 copyright notice appear in all copies and that both that copyright
  61 notice and this permission notice appear in supporting documentation.
  62 No representations are made about the suitability of this software for
  63 any purpose.  It is provided "as is" without express or implied
  64 warranty.
  65 .SH AUTHOR
  66 Jamie Zawinski <jwz@jwz.org>, 14-Apr-01