Skip to content

Commit d0a0ff7

Browse files
committed
Document openstack complete help and usage
Currently we have no documentation for the `complete` command. Change-Id: I9faf38341bb57a61869ddbef406a022219a7c62c Closes-Bug: 1623860
1 parent 15069ef commit d0a0ff7

1 file changed

Lines changed: 25 additions & 0 deletions

File tree

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
========
2+
complete
3+
========
4+
5+
The ``complete`` command is inherited from the `python-cliff` library, it can
6+
be used to generate a bash-completion script. Currently, the command will
7+
generate a script for bash versions 3 or 4. The bash-completion script is
8+
printed directly to standard out.
9+
10+
Typical usage for this command is::
11+
12+
openstack complete | sudo tee /etc/bash_completion.d/osc.bash_completion > /dev/null
13+
14+
If installing ``python-openstackclient`` from a package (``apt-get`` or ``yum``),
15+
then this command will likely be run for you.
16+
17+
complete
18+
--------
19+
20+
print bash completion command
21+
22+
.. program:: complete
23+
.. code:: bash
24+
25+
os complete

0 commit comments

Comments
 (0)