Fix format in doc/source/cli/*
Current indentation is wrongly interpreted as quotation. Also fixed some minor formatting issues. Change-Id: Ie29e71f0394a432c255804b0d549aba56d1d5a1d
This commit is contained in:
David Rabel
parent
9df90bd538
commit
7e60fc6e05
@ -1,33 +1,33 @@
|
||||
|
||||
**-h, --help**
|
||||
``-h, --help``
|
||||
Show the help message and exit
|
||||
|
||||
**--version**
|
||||
``--version``
|
||||
Print the version number and exit
|
||||
|
||||
**-v, --verbose**
|
||||
``-v, --verbose``
|
||||
Print more verbose output
|
||||
|
||||
**--noverbose**
|
||||
``--noverbose``
|
||||
Disable verbose output
|
||||
|
||||
**-d, --debug**
|
||||
``-d, --debug``
|
||||
Print debugging output (set logging level to DEBUG instead of
|
||||
default WARNING level)
|
||||
|
||||
**--nodebug**
|
||||
``--nodebug``
|
||||
Disable debugging output
|
||||
|
||||
**--use-syslog**
|
||||
``--use-syslog``
|
||||
Use syslog for logging
|
||||
|
||||
**--nouse-syslog**
|
||||
``--nouse-syslog``
|
||||
Disable the use of syslog for logging
|
||||
|
||||
**--syslog-log-facility SYSLOG_LOG_FACILITY**
|
||||
``--syslog-log-facility SYSLOG_LOG_FACILITY``
|
||||
syslog facility to receive log lines
|
||||
|
||||
**--config-dir DIR**
|
||||
``--config-dir DIR``
|
||||
Path to a config directory to pull \*.conf files from. This
|
||||
file set is sorted, to provide a predictable parse order
|
||||
if individual options are over-ridden. The set is parsed after
|
||||
@ -37,13 +37,13 @@
|
||||
always take precedence over configuration from files specified
|
||||
by --config-file, regardless to argument order.
|
||||
|
||||
**--config-file PATH**
|
||||
``--config-file PATH``
|
||||
Path to a config file to use. Multiple config files can be
|
||||
specified by using this flag multiple times, for example,
|
||||
--config-file <file1> --config-file <file2>. Values in latter
|
||||
files take precedence.
|
||||
|
||||
**--log-config-append PATH** **--log-config PATH**
|
||||
``--log-config-append PATH`` ``--log-config PATH``
|
||||
The name of logging configuration file. It does not
|
||||
disable existing loggers, but just appends specified
|
||||
logging configuration to any other existing logging
|
||||
@ -51,17 +51,17 @@
|
||||
for details on logging configuration files. The log-config
|
||||
name for this option is deprecated.
|
||||
|
||||
**--log-format FORMAT**
|
||||
``--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**
|
||||
``--log-date-format DATE_FORMAT``
|
||||
Format string for %(asctime)s in log records. Default: None
|
||||
|
||||
**--log-file PATH, --logfile PATH**
|
||||
``--log-file PATH, --logfile PATH``
|
||||
(Optional) Name of log file to output to. If not set, logging
|
||||
will go to stdout.
|
||||
|
||||
**--log-dir LOG_DIR, --logdir LOG_DIR**
|
||||
``--log-dir LOG_DIR, --logdir LOG_DIR``
|
||||
(Optional) The directory to keep log files in (will be prepended
|
||||
to --log-file)
|
||||
|
||||
@ -11,6 +11,8 @@ Server for the Glance Image Service API
|
||||
SYNOPSIS
|
||||
========
|
||||
|
||||
::
|
||||
|
||||
glance-api [options]
|
||||
|
||||
DESCRIPTION
|
||||
|
||||
@ -11,6 +11,8 @@ Glance Image Cache Invalid Cache Entry and Stalled Image cleaner
|
||||
SYNOPSIS
|
||||
========
|
||||
|
||||
::
|
||||
|
||||
glance-cache-cleaner [options]
|
||||
|
||||
DESCRIPTION
|
||||
|
||||
@ -11,71 +11,73 @@ Cache management utility
|
||||
SYNOPSIS
|
||||
========
|
||||
|
||||
::
|
||||
|
||||
glance-cache-manage <command> [options] [args]
|
||||
|
||||
COMMANDS
|
||||
========
|
||||
|
||||
**help <command>**
|
||||
``help <command>``
|
||||
Output help for one of the commands below
|
||||
|
||||
**list-cached**
|
||||
``list-cached``
|
||||
List all images currently cached
|
||||
|
||||
**list-queued**
|
||||
``list-queued``
|
||||
List all images currently queued for caching
|
||||
|
||||
**queue-image**
|
||||
``queue-image``
|
||||
Queue an image for caching
|
||||
|
||||
**delete-cached-image**
|
||||
``delete-cached-image``
|
||||
Purges an image from the cache
|
||||
|
||||
**delete-all-cached-images**
|
||||
``delete-all-cached-images``
|
||||
Removes all images from the cache
|
||||
|
||||
**delete-queued-image**
|
||||
``delete-queued-image``
|
||||
Deletes an image from the cache queue
|
||||
|
||||
**delete-all-queued-images**
|
||||
``delete-all-queued-images``
|
||||
Deletes all images from the cache queue
|
||||
|
||||
OPTIONS
|
||||
=======
|
||||
|
||||
**--version**
|
||||
``--version``
|
||||
show program's version number and exit
|
||||
|
||||
**-h, --help**
|
||||
``-h, --help``
|
||||
show this help message and exit
|
||||
|
||||
**-v, --verbose**
|
||||
``-v, --verbose``
|
||||
Print more verbose output
|
||||
|
||||
**-d, --debug**
|
||||
``-d, --debug``
|
||||
Print more verbose output
|
||||
|
||||
**-H ADDRESS, --host=ADDRESS**
|
||||
``-H ADDRESS, --host=ADDRESS``
|
||||
Address of Glance API host.
|
||||
Default: 0.0.0.0
|
||||
|
||||
**-p PORT, --port=PORT**
|
||||
``-p PORT, --port=PORT``
|
||||
Port the Glance API host listens on.
|
||||
Default: 9292
|
||||
|
||||
**-k, --insecure**
|
||||
``-k, --insecure``
|
||||
Explicitly allow glance to perform "insecure" SSL
|
||||
(https) requests. The server's certificate will not be
|
||||
verified against any certificate authorities. This
|
||||
option should be used with caution.
|
||||
|
||||
**-A TOKEN, --auth_token=TOKEN**
|
||||
``-A TOKEN, --auth_token=TOKEN``
|
||||
Authentication token to use to identify the client to the glance server
|
||||
|
||||
**-f, --force**
|
||||
``-f, --force``
|
||||
Prevent select actions from requesting user confirmation
|
||||
|
||||
**-S STRATEGY, --os-auth-strategy=STRATEGY**
|
||||
``-S STRATEGY, --os-auth-strategy=STRATEGY``
|
||||
Authentication strategy (keystone or noauth)
|
||||
|
||||
.. include:: openstack_options.txt
|
||||
|
||||
@ -11,6 +11,8 @@ Glance Image Cache Pre-fetcher
|
||||
SYNOPSIS
|
||||
========
|
||||
|
||||
::
|
||||
|
||||
glance-cache-prefetcher [options]
|
||||
|
||||
DESCRIPTION
|
||||
|
||||
@ -11,6 +11,8 @@ Glance cache pruner
|
||||
SYNOPSIS
|
||||
========
|
||||
|
||||
::
|
||||
|
||||
glance-cache-pruner [options]
|
||||
|
||||
DESCRIPTION
|
||||
|
||||
@ -11,17 +11,21 @@ Glance daemon start/stop/reload helper
|
||||
SYNOPSIS
|
||||
========
|
||||
|
||||
glance-control [options] <SERVER> <COMMAND> [CONFPATH]
|
||||
::
|
||||
|
||||
glance-control [options] <SERVER> <COMMAND> [<CONFPATH>]
|
||||
|
||||
Where <SERVER> is one of:
|
||||
|
||||
all, api, glance-api, registry, glance-registry, scrubber, glance-scrubber
|
||||
``all``, ``api``, ``glance-api``, ``registry``, ``glance-registry``,
|
||||
``scrubber``, ``glance-scrubber``
|
||||
|
||||
And command is one of:
|
||||
And <COMMAND> is one of:
|
||||
|
||||
start, status, stop, shutdown, restart, reload, force-reload
|
||||
``start``, ``status``, ``stop``, ``shutdown``, ``restart``, ``reload``,
|
||||
``force-reload``
|
||||
|
||||
And CONFPATH is the optional configuration file to use.
|
||||
And <CONFPATH> is the optional configuration file to use.
|
||||
|
||||
OPTIONS
|
||||
=======
|
||||
@ -30,24 +34,24 @@ OPTIONS
|
||||
|
||||
.. include:: general_options.txt
|
||||
|
||||
**--pid-file=PATH**
|
||||
``--pid-file=PATH``
|
||||
File to use as pid file. Default:
|
||||
/var/run/glance/$server.pid
|
||||
|
||||
**--await-child DELAY**
|
||||
``--await-child DELAY``
|
||||
Period to wait for service death in order to report
|
||||
exit code (default is to not wait at all)
|
||||
|
||||
**--capture-output**
|
||||
``--capture-output``
|
||||
Capture stdout/err in syslog instead of discarding
|
||||
|
||||
**--nocapture-output**
|
||||
``--nocapture-output``
|
||||
The inverse of --capture-output
|
||||
|
||||
**--norespawn**
|
||||
``--norespawn``
|
||||
The inverse of --respawn
|
||||
|
||||
**--respawn**
|
||||
``--respawn``
|
||||
Restart service on unexpected death
|
||||
|
||||
.. include:: footer.txt
|
||||
|
||||
@ -11,6 +11,8 @@ Glance Management Utility
|
||||
SYNOPSIS
|
||||
========
|
||||
|
||||
::
|
||||
|
||||
glance-manage [options]
|
||||
|
||||
DESCRIPTION
|
||||
@ -34,47 +36,47 @@ or with the db commands concatenated, like this::
|
||||
COMMANDS
|
||||
========
|
||||
|
||||
**db**
|
||||
``db``
|
||||
This is the prefix for the commands below when used with a space
|
||||
rather than a _. For example "db version".
|
||||
|
||||
**db_version**
|
||||
``db_version``
|
||||
This will print the current migration level of a glance database.
|
||||
|
||||
**db_upgrade [VERSION]**
|
||||
``db_upgrade [VERSION]``
|
||||
This will take an existing database and upgrade it to the
|
||||
specified VERSION.
|
||||
|
||||
**db_version_control**
|
||||
``db_version_control``
|
||||
Place the database under migration control.
|
||||
|
||||
**db_sync [VERSION]**
|
||||
``db_sync [VERSION]``
|
||||
Place an existing database under migration control and upgrade it to
|
||||
the specified VERSION.
|
||||
|
||||
**db_expand**
|
||||
``db_expand``
|
||||
Run this command to expand the database as the first step of a rolling
|
||||
upgrade process.
|
||||
|
||||
**db_migrate**
|
||||
``db_migrate``
|
||||
Run this command to migrate the database as the second step of a
|
||||
rolling upgrade process.
|
||||
|
||||
**db_contract**
|
||||
``db_contract``
|
||||
Run this command to contract the database as the last step of a rolling
|
||||
upgrade process.
|
||||
|
||||
**db_export_metadefs [PATH | PREFIX]**
|
||||
``db_export_metadefs [PATH | PREFIX]``
|
||||
Export the metadata definitions into json format. By default the
|
||||
definitions are exported to /etc/glance/metadefs directory.
|
||||
**Note: this command will overwrite existing files in the supplied or
|
||||
default path.**
|
||||
``Note: this command will overwrite existing files in the supplied or
|
||||
default path.``
|
||||
|
||||
**db_load_metadefs [PATH]**
|
||||
``db_load_metadefs [PATH]``
|
||||
Load the metadata definitions into glance database. By default the
|
||||
definitions are imported from /etc/glance/metadefs directory.
|
||||
|
||||
**db_unload_metadefs**
|
||||
``db_unload_metadefs``
|
||||
Unload the metadata definitions. Clears the contents of all the glance
|
||||
db tables including metadef_namespace_resource_types, metadef_tags,
|
||||
metadef_objects, metadef_resource_types, metadef_namespaces and
|
||||
|
||||
@ -14,6 +14,8 @@ Server for the Glance Registry Service
|
||||
SYNOPSIS
|
||||
========
|
||||
|
||||
::
|
||||
|
||||
glance-registry [options]
|
||||
|
||||
DESCRIPTION
|
||||
|
||||
@ -11,6 +11,8 @@ Replicate images across multiple data centers
|
||||
SYNOPSIS
|
||||
========
|
||||
|
||||
::
|
||||
|
||||
glance-replicator <command> [options] [args]
|
||||
|
||||
DESCRIPTION
|
||||
@ -24,62 +26,62 @@ data from the original.
|
||||
COMMANDS
|
||||
========
|
||||
|
||||
**help <command>**
|
||||
``help <command>``
|
||||
Output help for one of the commands below
|
||||
|
||||
**compare**
|
||||
``compare``
|
||||
What is missing from the slave glance?
|
||||
|
||||
**dump**
|
||||
``dump``
|
||||
Dump the contents of a glance instance to local disk.
|
||||
|
||||
**livecopy**
|
||||
``livecopy``
|
||||
Load the contents of one glance instance into another.
|
||||
|
||||
**load**
|
||||
``load``
|
||||
Load the contents of a local directory into glance.
|
||||
|
||||
**size**
|
||||
``size``
|
||||
Determine the size of a glance instance if dumped to disk.
|
||||
|
||||
OPTIONS
|
||||
=======
|
||||
|
||||
**-h, --help**
|
||||
``-h, --help``
|
||||
Show this help message and exit
|
||||
|
||||
**-c CHUNKSIZE, --chunksize=CHUNKSIZE**
|
||||
``-c CHUNKSIZE, --chunksize=CHUNKSIZE``
|
||||
Amount of data to transfer per HTTP write
|
||||
|
||||
**-d, --debug**
|
||||
``-d, --debug``
|
||||
Print debugging information
|
||||
|
||||
**-D DONTREPLICATE, --dontreplicate=DONTREPLICATE**
|
||||
``-D DONTREPLICATE, --dontreplicate=DONTREPLICATE``
|
||||
List of fields to not replicate
|
||||
|
||||
**-m, --metaonly**
|
||||
``-m, --metaonly``
|
||||
Only replicate metadata, not images
|
||||
|
||||
**-l LOGFILE, --logfile=LOGFILE**
|
||||
``-l LOGFILE, --logfile=LOGFILE``
|
||||
Path of file to log to
|
||||
|
||||
**-s, --syslog**
|
||||
``-s, --syslog``
|
||||
Log to syslog instead of a file
|
||||
|
||||
**-t TOKEN, --token=TOKEN**
|
||||
``-t TOKEN, --token=TOKEN``
|
||||
Pass in your authentication token if you have one. If
|
||||
you use this option the same token is used for both
|
||||
the master and the slave.
|
||||
|
||||
**-M MASTERTOKEN, --mastertoken=MASTERTOKEN**
|
||||
``-M MASTERTOKEN, --mastertoken=MASTERTOKEN``
|
||||
Pass in your authentication token if you have one.
|
||||
This is the token used for the master.
|
||||
|
||||
**-S SLAVETOKEN, --slavetoken=SLAVETOKEN**
|
||||
``-S SLAVETOKEN, --slavetoken=SLAVETOKEN``
|
||||
Pass in your authentication token if you have one.
|
||||
This is the token used for the slave.
|
||||
|
||||
**-v, --verbose**
|
||||
``-v, --verbose``
|
||||
Print more verbose output
|
||||
|
||||
.. include:: footer.txt
|
||||
|
||||
@ -11,6 +11,8 @@ Glance scrub service
|
||||
SYNOPSIS
|
||||
========
|
||||
|
||||
::
|
||||
|
||||
glance-scrubber [options]
|
||||
|
||||
DESCRIPTION
|
||||
|
||||
@ -1,23 +1,23 @@
|
||||
|
||||
**-os-auth-token=OS_AUTH_TOKEN**
|
||||
``-os-auth-token=OS_AUTH_TOKEN``
|
||||
Defaults to env[OS_AUTH_TOKEN]
|
||||
|
||||
**--os-username=OS_USERNAME**
|
||||
``--os-username=OS_USERNAME``
|
||||
Defaults to env[OS_USERNAME]
|
||||
|
||||
**--os-password=OS_PASSWORD**
|
||||
``--os-password=OS_PASSWORD``
|
||||
Defaults to env[OS_PASSWORD]
|
||||
|
||||
**--os-region-name=OS_REGION_NAME**
|
||||
``--os-region-name=OS_REGION_NAME``
|
||||
Defaults to env[OS_REGION_NAME]
|
||||
|
||||
**--os-tenant-id=OS_TENANT_ID**
|
||||
``--os-tenant-id=OS_TENANT_ID``
|
||||
Defaults to env[OS_TENANT_ID]
|
||||
|
||||
**--os-tenant-name=OS_TENANT_NAME**
|
||||
``--os-tenant-name=OS_TENANT_NAME``
|
||||
Defaults to env[OS_TENANT_NAME]
|
||||
|
||||
**--os-auth-url=OS_AUTH_URL**
|
||||
``--os-auth-url=OS_AUTH_URL``
|
||||
Defaults to env[OS_AUTH_URL]
|
||||
|
||||
|
||||
|
||||
Loading…
Reference in New Issue
Block a user