diff options
author | Ed Santiago <santiago@redhat.com> | 2022-08-29 15:05:50 -0600 |
---|---|---|
committer | Ed Santiago <santiago@redhat.com> | 2022-08-31 05:27:08 -0600 |
commit | 70a599b5717517d178cd2d4fce90e213e6abafaa (patch) | |
tree | 155e2ec2347cca6573351625213d10b7406fb154 /docs/source/markdown/podman-pod-kill.1.md.in | |
parent | 7503c5544d506826e2d8602d95433eef98208e83 (diff) | |
download | podman-70a599b5717517d178cd2d4fce90e213e6abafaa.tar.gz podman-70a599b5717517d178cd2d4fce90e213e6abafaa.tar.bz2 podman-70a599b5717517d178cd2d4fce90e213e6abafaa.zip |
Man pages: refactor common options: --signal
Would've been an easy one, except I decided to fix the text
to conform to our guidelines. I haven't been doing this,
but in this case it's only two man pages and the text is
short enough to make for easy review.
Signed-off-by: Ed Santiago <santiago@redhat.com>
Diffstat (limited to 'docs/source/markdown/podman-pod-kill.1.md.in')
-rw-r--r-- | docs/source/markdown/podman-pod-kill.1.md.in | 55 |
1 files changed, 55 insertions, 0 deletions
diff --git a/docs/source/markdown/podman-pod-kill.1.md.in b/docs/source/markdown/podman-pod-kill.1.md.in new file mode 100644 index 000000000..7f37661b0 --- /dev/null +++ b/docs/source/markdown/podman-pod-kill.1.md.in @@ -0,0 +1,55 @@ +% 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. (This option is not available with the remote Podman client, including Mac and Windows (excluding WSL2) machines) + +@@option signal + +## EXAMPLE + +Kill pod with a given name +``` +podman pod kill mywebserver +``` + +Kill pod with a given ID +``` +podman pod kill 860a4b23 +``` + +Terminate pod by sending `TERM` signal +``` +podman pod kill --signal TERM 860a4b23 +``` + +Kill the latest pod created by Podman +``` +podman pod kill --latest +``` + +Terminate all pods by sending `KILL` signal +``` +podman pod kill --all +``` + +## SEE ALSO +**[podman(1)](podman.1.md)**, **[podman-pod(1)](podman-pod.1.md)**, **[podman-pod-stop(1)](podman-pod-stop.1.md)** + +## HISTORY +July 2018, Originally compiled by Peter Hunt <pehunt@redhat.com> |