diff options
| author | Steve Martinelli <s.martinelli@gmail.com> | 2016-09-30 01:16:22 -0400 |
|---|---|---|
| committer | Steve Martinelli <s.martinelli@gmail.com> | 2016-09-30 01:16:22 -0400 |
| commit | d0a0ff77a8b59371ba9181f55955822b141709ec (patch) | |
| tree | f9141b8847cb660bed5ee2a1a723ebebaa580bff /doc/source/command-objects/complete.rst | |
| parent | 15069ef50e609dca769d6a50f6af92b2c8211238 (diff) | |
| download | python-openstackclient-d0a0ff77a8b59371ba9181f55955822b141709ec.tar.gz | |
Document `openstack complete` help and usage
Currently we have no documentation for the `complete` command.
Change-Id: I9faf38341bb57a61869ddbef406a022219a7c62c
Closes-Bug: 1623860
Diffstat (limited to 'doc/source/command-objects/complete.rst')
| -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 |