From 70a599b5717517d178cd2d4fce90e213e6abafaa Mon Sep 17 00:00:00 2001 From: Ed Santiago Date: Mon, 29 Aug 2022 15:05:50 -0600 Subject: 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 --- docs/source/markdown/.gitignore | 1 + docs/source/markdown/options/signal.md | 4 ++ docs/source/markdown/podman-kill.1.md.in | 5 +-- docs/source/markdown/podman-pod-kill.1.md | 58 ---------------------------- docs/source/markdown/podman-pod-kill.1.md.in | 55 ++++++++++++++++++++++++++ 5 files changed, 61 insertions(+), 62 deletions(-) create mode 100644 docs/source/markdown/options/signal.md delete mode 100644 docs/source/markdown/podman-pod-kill.1.md create mode 100644 docs/source/markdown/podman-pod-kill.1.md.in (limited to 'docs/source/markdown') diff --git a/docs/source/markdown/.gitignore b/docs/source/markdown/.gitignore index 8a0d553ba..26509612d 100644 --- a/docs/source/markdown/.gitignore +++ b/docs/source/markdown/.gitignore @@ -15,6 +15,7 @@ podman-manifest-push.1.md podman-pause.1.md podman-pod-clone.1.md podman-pod-create.1.md +podman-pod-kill.1.md podman-pod-logs.1.md podman-pod-rm.1.md podman-pod-start.1.md diff --git a/docs/source/markdown/options/signal.md b/docs/source/markdown/options/signal.md new file mode 100644 index 000000000..6e6c03657 --- /dev/null +++ b/docs/source/markdown/options/signal.md @@ -0,0 +1,4 @@ +#### **--signal**, **-s**=**signal** + +Signal to send to the container<<|s in the pod>>. For more information on Linux signals, refer to *signal(7)*. +The default is **SIGKILL**. diff --git a/docs/source/markdown/podman-kill.1.md.in b/docs/source/markdown/podman-kill.1.md.in index 2788cc694..46d7f5c6b 100644 --- a/docs/source/markdown/podman-kill.1.md.in +++ b/docs/source/markdown/podman-kill.1.md.in @@ -23,10 +23,7 @@ Signal all running and paused containers. 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. (This option is not available with the remote Podman client, including Mac and Windows (excluding WSL2) machines) -#### **--signal**, **-s** - -Signal to send to the container. For more information on Linux signals, refer to *man signal(7)*. - +@@option signal ## EXAMPLE diff --git a/docs/source/markdown/podman-pod-kill.1.md b/docs/source/markdown/podman-pod-kill.1.md deleted file mode 100644 index 96ced68a7..000000000 --- a/docs/source/markdown/podman-pod-kill.1.md +++ /dev/null @@ -1,58 +0,0 @@ -% 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) - -#### **--signal**, **-s** - -Signal to send to the containers in the pod. For more information on Linux signals, refer to *man signal(7)*. - - -## 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 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 -- cgit v1.2.3-54-g00ecf