summaryrefslogtreecommitdiff
path: root/docs/source/man/podman-kill.1.md
diff options
context:
space:
mode:
authorbaude <bbaude@redhat.com>2019-10-24 14:54:57 -0500
committerbaude <bbaude@redhat.com>2019-10-31 12:31:39 -0500
commit52b92023edeba3a5e2c466d92d742e54b14a85cb (patch)
tree44e6193d49afd1277b7d07b0df41fc80d31b3adb /docs/source/man/podman-kill.1.md
parent5af166ff513265b17aee92a9ce3a1522090d7dec (diff)
downloadpodman-52b92023edeba3a5e2c466d92d742e54b14a85cb.tar.gz
podman-52b92023edeba3a5e2c466d92d742e54b14a85cb.tar.bz2
podman-52b92023edeba3a5e2c466d92d742e54b14a85cb.zip
Restructure documentation dir
Restructuring the docs dir to make integration with sphinx easier. man pages now exist in docs/source/man and the sphinx make files exists in docs. Signed-off-by: baude <bbaude@redhat.com>
Diffstat (limited to 'docs/source/man/podman-kill.1.md')
-rw-r--r--docs/source/man/podman-kill.1.md47
1 files changed, 47 insertions, 0 deletions
diff --git a/docs/source/man/podman-kill.1.md b/docs/source/man/podman-kill.1.md
new file mode 100644
index 000000000..617d25b85
--- /dev/null
+++ b/docs/source/man/podman-kill.1.md
@@ -0,0 +1,47 @@
+% 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 containers. This does not include paused containers.
+
+**--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.
+
+The latest option is not supported on the remote client.
+
+**--signal**, **s**
+
+Signal to send to the container. For more information on Linux signals, refer to *man signal(7)*.
+
+
+## EXAMPLE
+
+podman kill mywebserver
+
+podman kill 860a4b23
+
+podman kill --signal TERM 860a4b23
+
+podman kill --latest
+
+podman kill --signal KILL -a
+
+## SEE ALSO
+podman(1), podman-stop(1)
+
+## HISTORY
+September 2017, Originally compiled by Brent Baude <bbaude@redhat.com>