glance/doc/source/man/glancecachecleaner.rst
Russell Bryant 58532a4373 Add more man pages.
A few man pages were already in place.  This patch uses the --help
output from each executable to seed a man page for the rest of the
executables, which include:

  - glance
  - glance-cache-cleaner
  - glance-cache-manage
  - glance-cache-prefetcher
  - glance-cache-pruner
  - glance-cache-queue-image
  - glance-control
  - glance-scrubber

Fixes bug 911291.

Change-Id: Ie0de990ff6617e7eb953f270a089c99bc340b4fe
2012-01-03 19:23:44 -05:00

102 lines
2.6 KiB
ReStructuredText

====================
glance-cache-cleaner
====================
----------------------------------------------------------------
Glance Image Cache Invalid Cache Entry and Stalled Image cleaner
----------------------------------------------------------------
:Author: glance@lists.launchpad.net
:Date: 2012-01-03
:Copyright: OpenStack LLC
:Version: 2012.1-dev
:Manual section: 1
:Manual group: cloud computing
SYNOPSIS
========
glance-cache-cleaner [options]
DESCRIPTION
===========
This is meant to be run as a periodic task from cron.
If something goes wrong while we're caching an image (for example the fetch
times out, or an exception is raised), we create an 'invalid' entry. These
entires are left around for debugging purposes. However, after some period of
time, we want to clean these up.
Also, if an incomplete image hangs around past the image_cache_stall_time
period, we automatically sweep it up.
OPTIONS
=======
**--version**
show program's version number and exit
**-h, --help**
show this help message and exit
**--config-file=PATH**
Path to a config file to use. Multiple config files can be specified,
with values in later files taking precedence.
The default files used are: []
**-d, --debug**
Print debugging output
**--nodebug**
Do not print debugging output
**-v, --verbose**
Print more verbose output
**--noverbose**
Do not print verbose output
**--log-config=PATH**
If this option is specified, the logging configuration
file specified is used and overrides any other logging
options specified. Please see the Python logging
module documentation for details on logging
configuration files.
**--log-format=FORMAT**
A logging.Formatter log message format string which
may use any of the available logging.LogRecord
attributes.
Default: none
**--log-date-format=DATE_FORMAT**
Format string for %(asctime)s in log records. Default: none
**--log-file=PATH**
(Optional) Name of log file to output to. If not set,
logging will go to stdout.
**--log-dir=LOG_DIR**
(Optional) The directory to keep log files in (will be
prepended to --logfile)
**--use-syslog**
Use syslog for logging.
**--nouse-syslog**
Do not use syslog for logging.
**--syslog-log-facility=SYSLOG_LOG_FACILITY**
syslog facility to receive log lines
SEE ALSO
========
* `OpenStack Glance <http://glance.openstack.org>`__
BUGS
====
* Glance is sourced in Launchpad so you can view current bugs at `OpenStack Glance <http://glance.openstack.org>`__