core-admin-client/doc/manpages/qvm-shutdown.rst
Marek Marczykowski-Górecki 54d992f727
doc: import man pages
Most of them are moved from core-admin repository, even if tool is not
implemented yet. Some are generated using skel-manpage.py script.
This way we have complete man pages list, and sphinx will properly
warn/error about inconsistencies.
2017-05-11 21:13:57 +02:00

65 lines
1.4 KiB
ReStructuredText

.. program:: qvm-shutdown
:program:`qvm-shutdown` -- Gracefully shut down a qube
======================================================
.. warning::
This page was autogenerated from command-line parser. It shouldn't be 1:1
conversion, because it would add little value. Please revise it and add
more descriptive help, which normally won't fit in standard ``--help``
option.
After rewrite, please remove this admonition.
Synopsis
--------
:command:`qvm-shutdown` [-h] [--verbose] [--quiet] [--all] [--exclude *EXCLUDE*] [--force] [--wait] [--timeout *TIMEOUT*] [*VMNAME*]
Options
-------
.. option:: --help, -h
show the help message and exit
.. option:: --verbose, -v
increase verbosity
.. option:: --quiet, -q
decrease verbosity
.. option:: --all
perform the action on all qubes
.. option:: --exclude=EXCLUDE
exclude the qube from :option:`--all`
.. option:: --force
force operation, even if may damage other VMs (eg. shutdown of network
provider)
.. option:: --wait
wait for the VMs to shut down
.. option:: --timeout
timeout after which domains are killed when using :option:`--wait`
Authors
-------
| Joanna Rutkowska <joanna at invisiblethingslab dot com>
| Rafal Wojtczuk <rafal at invisiblethingslab dot com>
| Marek Marczykowski <marmarek at invisiblethingslab dot com>
| Wojtek Porczyk <woju at invisiblethingslab dot com>
.. vim: ts=3 sw=3 et tw=80