summaryrefslogtreecommitdiff
path: root/doc/source
diff options
context:
space:
mode:
authorDean Troyer <dtroyer@gmail.com>2012-06-28 11:53:44 -0500
committerDean Troyer <dtroyer@gmail.com>2012-06-28 15:59:27 -0500
commit1fa29109c2194102b4c79fa7fd7328843af6998e (patch)
treee84fb9cff96542de4708b798b372112186aecf6e /doc/source
parent3ed4007e1136c7a0266f51c5b6b98e88997a5f60 (diff)
downloadpython-keystoneclient-1fa29109c2194102b4c79fa7fd7328843af6998e.tar.gz
Change CLI options to use dashes
Change documented options to use dashes instead of underscores in option names. Continue to support old underscore names for backward compatibility for a release or two (TBD). Blueprint: command-options Change-Id: Ied0d325a9fdd32f80bf8c993887e1975aa6adf16
Diffstat (limited to 'doc/source')
-rw-r--r--doc/source/shell.rst4
1 files changed, 2 insertions, 2 deletions
diff --git a/doc/source/shell.rst b/doc/source/shell.rst
index c44d6b3..f86af72 100644
--- a/doc/source/shell.rst
+++ b/doc/source/shell.rst
@@ -12,8 +12,8 @@ First, you'll need an OpenStack Keystone account. You get this by using the
`keystone-manage` command in OpenStack Keystone.
You'll need to provide :program:`keystone` with your OpenStack username and
-password. You can do this with the :option:`--os_username`, :option:`--os_password`.
-You can optionally specify a :option:`--os_tenant_id` or :option:`--os_tenant_name`,
+password. You can do this with the :option:`--os-username`, :option:`--os-password`.
+You can optionally specify a :option:`--os-tenant-id` or :option:`--os-tenant-name`,
to scope your token to a specific tenant. If you don't specify a tenant, you
will be scoped to your default tenant if you have one. Instead of using
options, it is easier to just set them as environment variables: