| martin f. krafft | 8acd49d | 2013-08-26 21:22:25 +0200 | [diff] [blame] | 1 | =============== |
| 2 | reclass manpage |
| 3 | =============== |
| 4 | |
| 5 | Synopsis |
| 6 | -------- |
| 7 | | |reclass| --help |
| 8 | | |reclass| *[options]* --inventory |
| 9 | | |reclass| *[options]* --nodeinfo=NODENAME |
| 10 | |
| 11 | Description |
| 12 | ----------- |
| 13 | .. include:: intro.inc |
| 14 | |
| 15 | |reclass| will be used indirectly through adapters most of the time. However, |
| 16 | there exists a command-line interface that allows querying the database. This |
| 17 | manual page describes this interface. |
| 18 | |
| 19 | Options |
| 20 | ------- |
| 21 | Please see the output of ``reclass --help`` for the default values of these |
| 22 | options: |
| 23 | |
| 24 | Database options |
| 25 | '''''''''''''''' |
| 26 | -s, --storage-type The type of storage backend to use |
| 27 | -b, --inventory-base-uri The base URI to prepend to nodes and classes |
| 28 | -u, --nodes-uri The URI to the nodes storage |
| 29 | -c, --classes-uri The URI to the classes storage |
| 30 | |
| 31 | Output options |
| 32 | '''''''''''''' |
| 33 | -o, --output The output format to use (yaml or json) |
| 34 | -y, --pretty-print Try to make the output prettier |
| 35 | |
| 36 | Modes |
| 37 | ''''' |
| 38 | -i, --inventory Output the entire inventory |
| 39 | -n, --nodeinfo Output information for a specific node |
| 40 | |
| 41 | Information |
| 42 | ''''''''''' |
| 43 | -h, --help Help output |
| 44 | --version Display version number |
| 45 | |
| 46 | See also |
| 47 | -------- |
| 48 | Please visit http://madduck.github.io/reclass for more information about |
| 49 | |reclass|. |
| 50 | |
| 51 | The documentation is also available from the ``./doc`` subtree in the source |
| 52 | checkout, or from ``/usr/share/doc/reclass-doc``. |
| 53 | |
| 54 | .. include:: substs.inc |
| 55 | .. include:: extrefs.inc |