From f7357b7fe78b7d7afe099a867d1dca14b19f8bc1 Mon Sep 17 00:00:00 2001
From: Dean Troyer <dtroyer@gmail.com>
Date: Sat, 6 Sep 2014 14:32:47 -0500
Subject: Update docs and release notes for 0.4.1 release

Closes-Bug: 1365505
Change-Id: I027d263ba9980715454b034a37733c5ff23fd169
---
 doc/source/man/openstack.rst | 66 ++++++++++++++++++++++++++++----------------
 1 file changed, 42 insertions(+), 24 deletions(-)

(limited to 'doc/source/man/openstack.rst')

diff --git a/doc/source/man/openstack.rst b/doc/source/man/openstack.rst
index 9af1c425..b8dcbd6b 100644
--- a/doc/source/man/openstack.rst
+++ b/doc/source/man/openstack.rst
@@ -56,18 +56,24 @@ OPTIONS
 :option:`--os-username` <auth-username>
     Authentication username
 
+:option:`--os-password` <auth-password>
+    Authentication password
+
 :option:`--os-user-domain-name` <auth-user-domain-name> | :option:`--os-user-domain-id` <auth-user-domain-id>
     Domain name or id containing user
 
-:option:`--os-password` <auth-password>
-    Authentication password
+:option:`--os-user-domain-name` <auth-user-domain-name> | :option:`--os-user-domain-id` <auth-user-domain-id>
+    Domain name or ID containing user
 
-:option:`--os-region-name` <auth-region-name>
-    Authentication region name
+:option:`--os-trust-id` <trust-id>
+    id of the trust to use as a trustee user
 
 :option:`--os-default-domain` <auth-domain>
     Default domain ID (Default: 'default')
 
+:option:`--os-region-name` <auth-region-name>
+    Authentication region name
+
 :option:`--os-cacert` <ca-bundle-file>
     CA certificate bundle file
 
@@ -80,9 +86,6 @@ OPTIONS
 :option:`--os-XXXX-api-version` <XXXX-api-version>
     Additional API version options will be available depending on the installed API libraries.
 
-:option:`--os-trust-id` <trust-id>
-    id of the trust to use as a trustee user
-
 COMMANDS
 ========
 
@@ -94,6 +97,11 @@ To get a description of a specific command::
 
     openstack help <command>
 
+Note that the set of commands shown will vary depending on the API versions
+that are in effect at that time.  For example, to force the display of the
+Identity v3 commands:
+
+    openstack --os-identity-api-version 3 --help
 
 :option:`complete`
     Print the bash completion functions for the current command set.
@@ -101,6 +109,25 @@ To get a description of a specific command::
 :option:`help <command>`
     Print help for an individual command
 
+Additional information on the OpenStackClient command structure and arguments
+is available in the `OpenStackClient Commands`_ wiki page.
+
+.. _`OpenStackClient Commands`: https://wiki.openstack.org/wiki/OpenStackClient/Commands
+
+Command Objects
+---------------
+
+The list of command objects is growing longer with the addition of OpenStack
+project support.  The object names may consist of multiple words to compose a
+unique name.  Occasionally when multiple APIs have a common name with common
+overlapping purposes there will be options to select which object to use, or
+the API resources will be merged, as in the ``quota`` object that has options
+referring to both Compute and Volume quotas.
+
+Command Actions
+---------------
+
+The actions used by OpenStackClient are defined with specific meaning to provide a consistent behavior for each object.  Some actions have logical opposite actions, and those pairs will always match for any object that uses them.
 
 NOTES
 =====
@@ -162,39 +189,30 @@ The following environment variables can be set to alter the behaviour of :progra
 :envvar:`OS_USERNAME`
     Authentication username
 
-:envvar:`OS_USER_DOMAIN_NAME`
-    Domain name or id containing user
-
 :envvar:`OS_PASSWORD`
     Authentication password
 
-:envvar:`OS_REGION_NAME`
-    Authentication region name
+:envvar:`OS_USER_DOMAIN_NAME`
+    Domain name or id containing user
+
+:envvar:`OS_TRUST_ID`
+    id of the trust to use as a trustee user
 
 :envvar:`OS_DEFAULT_DOMAIN`
     Default domain ID (Default: 'default')
 
+:envvar:`OS_REGION_NAME`
+    Authentication region name
+
 :envvar:`OS_CACERT`
     CA certificate bundle file
 
-:envvar:`OS_COMPUTE_API_VERSION`
-    Compute API version (Default: 2)
-
 :envvar:`OS_IDENTITY_API_VERSION`
     Identity API version (Default: 2.0)
 
-:envvar:`OS_IMAGE_API_VERSION`
-    Image API version (Default: 1)
-
-:envvar:`OS_VOLUME_API_VERSION`
-    Volume API version (Default: 1)
-
 :envvar:`OS_XXXX_API_VERSION`
     Additional API version options will be available depending on the installed API libraries.
 
-:envvar:`OS_TRUST_ID`
-    id of the trust to use as a trustee user
-
 BUGS
 ====
 
-- 
cgit v1.2.1