summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
Diffstat (limited to 'docs')
-rw-r--r--docs/podman-pod-kill.1.md43
-rw-r--r--docs/podman-pod.1.md1
2 files changed, 44 insertions, 0 deletions
diff --git a/docs/podman-pod-kill.1.md b/docs/podman-pod-kill.1.md
new file mode 100644
index 000000000..2f4d37f92
--- /dev/null
+++ b/docs/podman-pod-kill.1.md
@@ -0,0 +1,43 @@
+% podman-pod-kill "1"
+
+## NAME
+podman\-pod\-kill - Kills all containers in one or more pods with a signal
+
+## 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.
+
+**--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>
diff --git a/docs/podman-pod.1.md b/docs/podman-pod.1.md
index 9aee75e81..74b6d75b5 100644
--- a/docs/podman-pod.1.md
+++ b/docs/podman-pod.1.md
@@ -14,6 +14,7 @@ podman pod is a set of subcommands that manage pods, or groups of containers.
| Subcommand | Description |
| ------------------------------------------------- | ------------------------------------------------------------------------------ |
| [podman-pod-create(1)](podman-pod-create.1.md) | Create a new pod. |
+| [podman-pod-kill(1)](podman-pod-kill.1.md) | Kill the main process of each container in pod. |
| [podman-pod-ps(1)](podman-pod-ps.1.md) | Prints out information about pods. |
| [podman-pod-rm(1)](podman-pod-rm.1.md) | Remove one or more pods. |
| [podman-pod-start(1)](podman-pod-start.1.md) | Start one or more pods. |