summaryrefslogtreecommitdiffstats
path: root/share/man/container-stop.1.rst
diff options
context:
space:
mode:
Diffstat (limited to 'share/man/container-stop.1.rst')
-rw-r--r--share/man/container-stop.1.rst108
1 files changed, 108 insertions, 0 deletions
diff --git a/share/man/container-stop.1.rst b/share/man/container-stop.1.rst
new file mode 100644
index 0000000..bf668be
--- /dev/null
+++ b/share/man/container-stop.1.rst
@@ -0,0 +1,108 @@
+.. Open Infrastructure: compute-tools
+
+.. Copyright (C) 2014-2022 Daniel Baumann <daniel.baumann@open-infrastructure.net>
+..
+.. SPDX-License-Identifier: GPL-3.0+
+..
+.. This program is free software: you can redistribute it and/or modify
+.. it under the terms of the GNU General Public License as published by
+.. the Free Software Foundation, either version 3 of the License, or
+.. (at your option) any later version.
+..
+.. This program is distributed in the hope that it will be useful,
+.. but WITHOUT ANY WARRANTY; without even the implied warranty of
+.. MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+.. GNU General Public License for more details.
+..
+.. You should have received a copy of the GNU General Public License
+.. along with this program. If not, see <https://www.gnu.org/licenses/>.
+
+==============
+container-stop
+==============
+
+----------------
+Stop a container
+----------------
+
+:manual section: 1
+:manual group: Open Infrastructure
+
+Synopsis
+========
+
+| **container stop** ['OPTIONS']
+| **cnt t** ['OPTIONS']
+
+Description
+===========
+
+The **container stop** command stops a container by running the proper shutdown
+sequence.
+
+Options
+=======
+
+The following **container stop** options are available:
+
+-n, --name='NAME':
+ Specify container name. Specifying 'ALL' will stop all started container.
+
+-f, --force:
+ Do not prompt before every stopping.
+
+-i, --interactive:
+ Prompt before every stopping (default).
+
+-k, --kill:
+ Instead of running the proper shutdown sequence, terminate all processes of the container imediatly.
+
+-v, --verbose:
+ Explain what is being done.
+
+Examples
+========
+
+Shutdown example.net container:
+
+ sudo container stop -n example.net
+
+Shutdown example.net container without prompting:
+
+ sudo container stop -n example.net -f
+
+Immediately stop example.net container:
+
+ sudo container stop -n example.net -k
+
+Stop all container:
+
+ sudo container stop -n ALL
+
+See also
+========
+
+| compute-tools(7),
+| container(1).
+
+Homepage
+========
+
+More information about compute-tools and the Open Infrastructure project can be
+found on the homepage (https://open-infrastructure.net).
+
+Contact
+=======
+
+Bug reports, feature requests, help, patches, support and everything else are
+welcome on the Open Infrastructure Software Mailing List
+<software@lists.open-infrastructure.net>.
+
+Debian specific bugs can also be reported in the Debian Bug Tracking System
+(https://bugs.debian.org).
+
+Authors
+=======
+
+compute-tools were written by Daniel Baumann
+<daniel.baumann@open-infrastructure.net> and others.