summaryrefslogtreecommitdiff
path: root/docs/source/man/podman-pod-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-pod-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-pod-stop.1.md')
-rw-r--r--docs/source/man/podman-pod-stop.1.md71
1 files changed, 71 insertions, 0 deletions
diff --git a/docs/source/man/podman-pod-stop.1.md b/docs/source/man/podman-pod-stop.1.md
new file mode 100644
index 000000000..b3ce47d72
--- /dev/null
+++ b/docs/source/man/podman-pod-stop.1.md
@@ -0,0 +1,71 @@
+% podman-pod-stop(1)
+
+## NAME
+podman\-pod\-stop - Stop one or more pods
+
+## SYNOPSIS
+**podman pod stop** [*options*] *pod* ...
+
+## DESCRIPTION
+Stop containers in one or more pods. You may use pod IDs or names as input.
+
+## OPTIONS
+
+**--all**, **-a**
+
+Stops all pods
+
+**--latest**, **-l**
+
+Instead of providing the pod name or ID, stop the last created pod.
+
+The latest option is not supported on the remote client.
+
+**--timeout**, **--time**, **-t**=*time*
+
+Timeout to wait before forcibly stopping the containers in the pod.
+
+## EXAMPLE
+
+Stop a pod called *mywebserverpod*
+```
+$ podman pod stop mywebserverpod
+cc8f0bea67b1a1a11aec1ecd38102a1be4b145577f21fc843c7c83b77fc28907
+```
+
+Stop two pods by their short IDs.
+```
+$ podman pod stop 490eb 3557fb
+490eb241aaf704d4dd2629904410fe4aa31965d9310a735f8755267f4ded1de5
+3557fbea6ad61569de0506fe037479bd9896603c31d3069a6677f23833916fab
+```
+
+Stop the most recent pod
+```
+$ podman pod stop --latest
+3557fbea6ad61569de0506fe037479bd9896603c31d3069a6677f23833916fab
+```
+
+Stop all pods
+```
+$ podman pod stop --all
+19456b4cd557eaf9629825113a552681a6013f8c8cad258e36ab825ef536e818
+3557fbea6ad61569de0506fe037479bd9896603c31d3069a6677f23833916fab
+490eb241aaf704d4dd2629904410fe4aa31965d9310a735f8755267f4ded1de5
+70c358daecf71ef9be8f62404f926080ca0133277ef7ce4f6aa2d5af6bb2d3e9
+cc8f0bea67b1a1a11aec1ecd38102a1be4b145577f21fc843c7c83b77fc28907
+```
+
+Stop all pods with a timeout of 1 second.
+```
+$ podman pod stop -a -t 1
+3557fbea6ad61569de0506fe037479bd9896603c31d3069a6677f23833916fab
+490eb241aaf704d4dd2629904410fe4aa31965d9310a735f8755267f4ded1de5
+70c358daecf71ef9be8f62404f926080ca0133277ef7ce4f6aa2d5af6bb2d3e9
+```
+
+## SEE ALSO
+podman-pod(1), podman-pod-start(1), podman-stop(1)
+
+## HISTORY
+July 2018, Originally compiled by Peter Hunt <pehunt@redhat.com>