aboutsummaryrefslogtreecommitdiff
path: root/docs/source/man/podman-stop.1.md
diff options
context:
space:
mode:
authorbaude <bbaude@redhat.com>2019-10-24 14:54:57 -0500
committerbaude <bbaude@redhat.com>2019-10-31 12:31:39 -0500
commit52b92023edeba3a5e2c466d92d742e54b14a85cb (patch)
tree44e6193d49afd1277b7d07b0df41fc80d31b3adb /docs/source/man/podman-stop.1.md
parent5af166ff513265b17aee92a9ce3a1522090d7dec (diff)
downloadpodman-52b92023edeba3a5e2c466d92d742e54b14a85cb.tar.gz
podman-52b92023edeba3a5e2c466d92d742e54b14a85cb.tar.bz2
podman-52b92023edeba3a5e2c466d92d742e54b14a85cb.zip
Restructure documentation dir
Restructuring the docs dir to make integration with sphinx easier. man pages now exist in docs/source/man and the sphinx make files exists in docs. Signed-off-by: baude <bbaude@redhat.com>
Diffstat (limited to 'docs/source/man/podman-stop.1.md')
-rw-r--r--docs/source/man/podman-stop.1.md53
1 files changed, 53 insertions, 0 deletions
diff --git a/docs/source/man/podman-stop.1.md b/docs/source/man/podman-stop.1.md
new file mode 100644
index 000000000..b5ea670b0
--- /dev/null
+++ b/docs/source/man/podman-stop.1.md
@@ -0,0 +1,53 @@
+% podman-stop(1)
+
+## NAME
+podman\-stop - Stop one or more running containers
+
+## SYNOPSIS
+**podman stop** [*options*] *container* ...
+
+**podman container stop** [*options*] *container* ...
+
+## DESCRIPTION
+Stops one or more containers. You may use container IDs or names as input. The **--timeout** switch
+allows you to specify the number of seconds to wait before forcibly stopping the container after the stop command
+is issued to the container. The default is 10 seconds. By default, containers are stopped with SIGTERM
+and then SIGKILL after the timeout. The SIGTERM default can be overridden by the image used to create the
+container and also via command line when creating the container.
+
+## OPTIONS
+
+**--all**, **-a**
+
+Stop all running containers. This does not include paused containers.
+
+**--latest**, **-l**
+
+Instead of providing the container name or ID, use the last created container. If you use methods other than Podman
+to run containers such as CRI-O, the last started container could be from either of those methods.
+
+The latest option is not supported on the remote client.
+
+**--timeout**, **--time**, **t**=*time*
+
+Timeout to wait before forcibly stopping the container
+
+## EXAMPLE
+
+podman stop mywebserver
+
+podman stop 860a4b235279
+
+podman stop mywebserver 860a4b235279
+
+podman stop --timeout 2 860a4b235279
+
+podman stop -a
+
+podman stop --latest
+
+## SEE ALSO
+podman(1), podman-rm(1)
+
+## HISTORY
+September 2018, Originally compiled by Brent Baude <bbaude@redhat.com>