113cd72ea8
This patch adds the initial Sphinx layout for building docs. It also contains a bare set of initial pages that will be fleshed out in following patches. Change-Id: Iceedcd268816cab9675795e107a5905de093e2d9 Implements: blueprint create-initial-documentation
57 lines
775 B
ReStructuredText
57 lines
775 B
ReStructuredText
======
|
|
Tuskar
|
|
======
|
|
|
|
.. program:: tuskar
|
|
|
|
SYNOPSIS
|
|
========
|
|
|
|
`tuskar` [options] <command> [command-options]
|
|
|
|
`tuskar help`
|
|
|
|
`tuskar help` <command>
|
|
|
|
|
|
DESCRIPTION
|
|
===========
|
|
|
|
`tuskar` is a command line client for controlling OpenStack Tuskar.
|
|
|
|
|
|
|
|
OPTIONS
|
|
=======
|
|
|
|
To get a list of available commands and options run::
|
|
|
|
tuskar help
|
|
|
|
To get usage and options of a command run::
|
|
|
|
tuskar help <command>
|
|
|
|
|
|
EXAMPLES
|
|
========
|
|
|
|
Get information about overcloud-create command::
|
|
|
|
tuskar help overcloud-create
|
|
|
|
List available overcloud-list::
|
|
|
|
tuskar overcloud-list
|
|
|
|
List available Overcloud Roles::
|
|
|
|
tuskar overcloud-roles-list
|
|
|
|
|
|
BUGS
|
|
====
|
|
|
|
Tuskar client is hosted in Launchpad so you can view current bugs at
|
|
https://bugs.launchpad.net/python-tuskarclient/.
|