Provide keystone CLI man page.

Resolves: bug 1185142
Implements blueprint: clients-man-pages

Provide basic but hopefully useful man page.

shell.rst was merged into and replaced by the man page in HTML docs.

Change-Id: I0a90e4638cc7e4ed9c02c5abd7d84a4079e5f50d

doc/source/conf.py

@@ -14,6 +14,7 @@
 
 import os
 import sys
+import pbr.version
 
 sys.path.insert(0, os.path.abspath(os.path.join(os.path.dirname(__file__),
                 '..', '..')))
@@ -49,16 +50,16 @@ master_doc = 'index'
 
 # General information about the project.
 project = u'python-keystoneclient'
-copyright = u'Rackspace, based on work by Jacob Kaplan-Moss'
+copyright = u'OpenStack Contributors'
 
 # The version info for the project you're documenting, acts as replacement for
 # |version| and |release|, also used in various other places throughout the
 # built documents.
-#
+version_info = pbr.version.VersionInfo('python-keystoneclient')
-# The short XXXX.Y version.
+# The short X.Y version.
-version = '2012.3'
+version = version_info.version_string()
 # The full version, including alpha/beta/rc tags.
-release = '2012.3-dev'
+release = version_info.release_string()
 
 # The language for content autogenerated by Sphinx. Refer to documentation
 # for a list of supported languages.
@@ -98,6 +99,13 @@ pygments_style = 'sphinx'
 # A list of ignored prefixes for module index sorting.
 #modindex_common_prefix = []
 
+# Grouping the document tree for man pages.
+# List of tuples 'sourcefile', 'target', u'title', u'Authors name', 'manual'
+
+man_pages = [
+    ('man/keystone', 'keystone', u'Client for OpenStack Identity API',
+     [u'OpenStack Contributors'], 1),
+]
 
 # -- Options for HTML output --------------------------------------------------
 

doc/source/index.rst

@@ -11,7 +11,7 @@ Contents:
    :maxdepth: 1
 
    releases
-   shell
+   man/keystone
    using-api
 
    api/autoindex

doc/source/man/keystone.rst

@@ -1,12 +1,25 @@
-The :program:`keystone` shell utility
+=======================================
-=====================================
+:program:`keystone` command line utility
+=======================================
 
 .. program:: keystone
 .. highlight:: bash
 
+SYNOPSIS
+========
 
-The :program:`keystone` shell utility interacts with OpenStack Identity API
+:program:`keystone` [options] <command> [command-options]
-from the command line. It supports the entirety of the OpenStack Identity API.
+
+:program:`keystone help`
+
+:program:`keystone help` <command>
+
+
+DESCRIPTION
+===========
+
+The :program:`keystone` command line utility interacts with services providing
+OpenStack Identity API (e.g. Keystone).
 
 To communicate with the API, you will need to be authenticated - and the
 :program:`keystone` provides multiple options for this.
@@ -32,9 +45,10 @@ If you already have accounts, you can use your OpenStack username and
 password. You can do this with the :option:`--os-username`,
 :option:`--os-password`.
 
-Keystone allows a user to be associated with one or more tenants. To specify
+Keystone allows a user to be associated with one or more projects which are
-the tenant for which you want to authorize against, you may optionally
+historically called tenants.  To specify the project for which you want to
-specify a :option:`--os-tenant-id` or :option:`--os-tenant-name`.
+authorize against, you may optionally specify a :option:`--os-tenant-id` or
+:option:`--os-tenant-name`.
 
 Instead of using options, it is easier to just set them as environment
 variables:
@@ -49,7 +63,7 @@ variables:
 
 .. envvar:: OS_TENANT_NAME
 
-    Name of Keystone Tenant.
+    Name of Keystone project.
 
 .. envvar:: OS_TENANT_ID
 
@@ -90,10 +104,47 @@ For example, in Bash you'd use::
     export OS_CERT=/etc/keystone/yourpublickey.pem
     export OS_KEY=/etc/keystone/yourprivatekey.pem
 
-From there, all shell commands take the form::
 
-    keystone <command> [arguments...]
+OPTIONS
+=======
 
-Run :program:`keystone help` to get a full list of all possible commands,
+To get a list of available commands and options run::
-and run :program:`keystone help <command>` to get detailed help for that
+
-command.
+    keystone help
+
+To get usage and options of a command::
+
+    keystone help <command>
+
+
+EXAMPLES
+========
+
+Get information about endpoint-create command::
+
+    keystone help endpoint-create
+
+View endpoints of OpenStack services::
+
+    keystone catalog
+
+Create a 'service' project::
+
+    keystone tenant-create --name=service
+
+Create service user for nova::
+
+    keystone user-create --name=nova \
+                         --tenant_id=<project ID> \
+                         --email=nova@nothing.com
+
+View roles::
+
+    keystone role-list
+
+
+BUGS
+====
+
+Keystone client is hosted in Launchpad so you can view current bugs at
+https://bugs.launchpad.net/python-keystoneclient/.