deb-heat/doc/source/man/heat-api-cfn.rst
Kanagaraj Manickam 493acbec79 Adds --version into command docs
Adds --version option in the heat command help
documents.

Change-Id: I8c71391893a1c9697abd57344e04f88e6a2bcd4c
2015-04-17 17:47:05 +05:30

45 lines
1.1 KiB
ReStructuredText

============
heat-api-cfn
============
.. program:: heat-api-cfn
SYNOPSIS
========
``heat-api-cfn [options]``
DESCRIPTION
===========
heat-api-cfn is a CloudFormation compatible API service to the heat project.
INVENTORY
=========
heat-api-cfn is a service that exposes an external REST based api to the
heat-engine service. The communication between the heat-api-cfn and
heat-engine uses message queue based RPC.
OPTIONS
=======
.. cmdoption:: --config-file
Path to a config file to use. Multiple config files can be specified, with
values in later files taking precedence.
.. cmdoption:: --config-dir
Path to a config directory to pull .conf files from. This file set is
sorted, so as to provide a predictable parse order if individual options are
over-ridden. The set is parsed after the file(s), if any, specified via
--config-file, hence over-ridden options in the directory take precedence.
.. cmdoption:: --version
Show program's version number and exit. The output could be empty if
the distribution didn't specify any version information.
FILES
========
* /etc/heat/heat.conf