diff options
| author | Jenkins <jenkins@review.openstack.org> | 2016-10-06 23:41:38 +0000 |
|---|---|---|
| committer | Gerrit Code Review <review@openstack.org> | 2016-10-06 23:41:38 +0000 |
| commit | 4aaa9da8c98394d9aa2b4ff6f2ebdd1a44e77102 (patch) | |
| tree | a488879ebcc9e28a2a0ba57caebc372efd36a414 /doc/source/command-objects | |
| parent | 55c4290403874ed8d05b40b90350e05f84b9f8e0 (diff) | |
| parent | d0a0ff77a8b59371ba9181f55955822b141709ec (diff) | |
| download | python-openstackclient-4aaa9da8c98394d9aa2b4ff6f2ebdd1a44e77102.tar.gz | |
Merge "Document `openstack complete` help and usage"
Diffstat (limited to 'doc/source/command-objects')
| -rw-r--r-- | doc/source/command-objects/complete.rst | 25 |
1 files changed, 25 insertions, 0 deletions
diff --git a/doc/source/command-objects/complete.rst b/doc/source/command-objects/complete.rst new file mode 100644 index 00000000..8f84eec1 --- /dev/null +++ b/doc/source/command-objects/complete.rst @@ -0,0 +1,25 @@ +======== +complete +======== + +The ``complete`` command is inherited from the `python-cliff` library, it can +be used to generate a bash-completion script. Currently, the command will +generate a script for bash versions 3 or 4. The bash-completion script is +printed directly to standard out. + +Typical usage for this command is:: + + openstack complete | sudo tee /etc/bash_completion.d/osc.bash_completion > /dev/null + +If installing ``python-openstackclient`` from a package (``apt-get`` or ``yum``), +then this command will likely be run for you. + +complete +-------- + +print bash completion command + +.. program:: complete +.. code:: bash + + os complete |