summaryrefslogtreecommitdiff
path: root/docs/source/markdown/podman-pod-kill.1.md
diff options
context:
space:
mode:
authorOpenShift Merge Robot <openshift-merge-robot@users.noreply.github.com>2019-10-31 19:39:44 +0100
committerGitHub <noreply@github.com>2019-10-31 19:39:44 +0100
commitffe36ea9964242235571ad1d21a0c4d825ef5971 (patch)
treeb38d2d9c492ab2b2ad951135fde7e90c37344711 /docs/source/markdown/podman-pod-kill.1.md
parent3e2d9f8662663f2f703bf674408d5255e493e18e (diff)
parent486fcd4e1e6f00424f1016d8e331582523bd2c68 (diff)
downloadpodman-ffe36ea9964242235571ad1d21a0c4d825ef5971.tar.gz
podman-ffe36ea9964242235571ad1d21a0c4d825ef5971.tar.bz2
podman-ffe36ea9964242235571ad1d21a0c4d825ef5971.zip
Merge pull request #4354 from baude/newdocsstruct
Restructure documentation dir
Diffstat (limited to 'docs/source/markdown/podman-pod-kill.1.md')
-rw-r--r--docs/source/markdown/podman-pod-kill.1.md45
1 files changed, 45 insertions, 0 deletions
diff --git a/docs/source/markdown/podman-pod-kill.1.md b/docs/source/markdown/podman-pod-kill.1.md
new file mode 100644
index 000000000..596e15cea
--- /dev/null
+++ b/docs/source/markdown/podman-pod-kill.1.md
@@ -0,0 +1,45 @@
+% podman-pod-kill(1)
+
+## NAME
+podman\-pod\-kill - Kill the main process of each container in one or more pods
+
+## SYNOPSIS
+**podman pod kill** [*options*] *pod* ...
+
+## DESCRIPTION
+The main process of each container inside the pods specified will be sent SIGKILL, or any signal specified with option --signal.
+
+## OPTIONS
+**--all**, **-a**
+
+Sends signal to all containers associated with a pod.
+
+**--latest**, **-l**
+
+Instead of providing the pod name or ID, use the last created pod. If you use methods other than Podman
+to run pods such as CRI-O, the last started pod could be from either of those methods.
+
+The latest option is not supported on the remote client.
+
+**--signal**, **-s**
+
+Signal to send to the containers in the pod. For more information on Linux signals, refer to *man signal(7)*.
+
+
+## EXAMPLE
+
+podman pod kill mywebserver
+
+podman pod kill 860a4b23
+
+podman pod kill --signal TERM 860a4b23
+
+podman pod kill --latest
+
+podman pod kill --all
+
+## SEE ALSO
+podman-pod(1), podman-pod-stop(1)
+
+## HISTORY
+July 2018, Originally compiled by Peter Hunt <pehunt@redhat.com>