diff options
author | Ed Santiago <santiago@redhat.com> | 2022-08-22 10:18:36 -0600 |
---|---|---|
committer | Ed Santiago <santiago@redhat.com> | 2022-08-22 12:17:20 -0600 |
commit | 46f31361f88317d405d7f7b41c5d644328cd2e5b (patch) | |
tree | 3b9a4afd32e106865422d4f777689804454a29a3 /docs/source/markdown/podman-kill.1.md.in | |
parent | aefd0aed3990848e77b706d673c23108092594a0 (diff) | |
download | podman-46f31361f88317d405d7f7b41c5d644328cd2e5b.tar.gz podman-46f31361f88317d405d7f7b41c5d644328cd2e5b.tar.bz2 podman-46f31361f88317d405d7f7b41c5d644328cd2e5b.zip |
Man pages: refactor common options: --cidfile
There are two meanings: one writes a cidfile, the other reads.
Split into two .md files.
This can be reviewed with hack/markdown-preprocess-review .
The main differences you'll see are all in cidfile.read:
1) I use the <<subcommand>> feature. This works nicely for
kill, pause/unpause, and stop. It works less nicely for
rm, because the man page will show "...and rm the container"
(a human might prefer to see "REMOVE the container"). Given
the benefit of this cleanup, I think this is a fine tradeoff.
2) I choose to include the "multiple times" text even on man pages
where it wasn't present before. I tested to make sure it works.
3) The #### line I choose is IMHO the best one.
Minor differences:
* I believe the "remove the container" text in podman-kill
and podman-stop is a copy/paste error. This PR fixes it.
* The only differences between the cidfile.write texts is
the #### line (my version is best) and a final period.
Signed-off-by: Ed Santiago <santiago@redhat.com>
Diffstat (limited to 'docs/source/markdown/podman-kill.1.md.in')
-rw-r--r-- | docs/source/markdown/podman-kill.1.md.in | 68 |
1 files changed, 68 insertions, 0 deletions
diff --git a/docs/source/markdown/podman-kill.1.md.in b/docs/source/markdown/podman-kill.1.md.in new file mode 100644 index 000000000..2788cc694 --- /dev/null +++ b/docs/source/markdown/podman-kill.1.md.in @@ -0,0 +1,68 @@ +% podman-kill(1) + +## NAME +podman\-kill - Kill the main process in one or more containers + +## SYNOPSIS +**podman kill** [*options*] [*container* ...] + +**podman container kill** [*options*] [*container* ...] + +## DESCRIPTION +The main process inside each container specified will be sent SIGKILL, or any signal specified with option --signal. + +## OPTIONS +#### **--all**, **-a** + +Signal all running and paused containers. + +@@option cidfile.read + +#### **--latest**, **-l** + +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)*. + + +## EXAMPLE + +Kill container with a given name +``` +podman kill mywebserver +``` + +Kill container with a given ID +``` +podman kill 860a4b23 +``` + +Terminate container by sending `TERM` signal +``` +podman kill --signal TERM 860a4b23 +``` + +Kill the latest container created by Podman +``` +podman kill --latest +``` + +Terminate all containers by sending `KILL` signal +``` +podman kill --signal KILL -a +``` + +Kill container using ID specified in a given files +``` +podman kill --cidfile /home/user/cidfile-1 +podman kill --cidfile /home/user/cidfile-1 --cidfile ./cidfile-2 +``` + +## SEE ALSO +**[podman(1)](podman.1.md)**, **[podman-stop(1)](podman-stop.1.md)** + +## HISTORY +September 2017, Originally compiled by Brent Baude <bbaude@redhat.com> |