From 52b92023edeba3a5e2c466d92d742e54b14a85cb Mon Sep 17 00:00:00 2001 From: baude Date: Thu, 24 Oct 2019 14:54:57 -0500 Subject: 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 --- docs/source/man/podman-stop.1.md | 53 ++++++++++++++++++++++++++++++++++++++++ 1 file changed, 53 insertions(+) create mode 100644 docs/source/man/podman-stop.1.md (limited to 'docs/source/man/podman-stop.1.md') diff --git a/docs/source/man/podman-stop.1.md b/docs/source/man/podman-stop.1.md new file mode 100644 index 000000000..b5ea670b0 --- /dev/null +++ b/docs/source/man/podman-stop.1.md @@ -0,0 +1,53 @@ +% podman-stop(1) + +## NAME +podman\-stop - Stop one or more running containers + +## SYNOPSIS +**podman stop** [*options*] *container* ... + +**podman container stop** [*options*] *container* ... + +## DESCRIPTION +Stops one or more containers. You may use container IDs or names as input. The **--timeout** switch +allows you to specify the number of seconds to wait before forcibly stopping the container after the stop command +is issued to the container. The default is 10 seconds. By default, containers are stopped with SIGTERM +and then SIGKILL after the timeout. The SIGTERM default can be overridden by the image used to create the +container and also via command line when creating the container. + +## OPTIONS + +**--all**, **-a** + +Stop 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. + +**--timeout**, **--time**, **t**=*time* + +Timeout to wait before forcibly stopping the container + +## EXAMPLE + +podman stop mywebserver + +podman stop 860a4b235279 + +podman stop mywebserver 860a4b235279 + +podman stop --timeout 2 860a4b235279 + +podman stop -a + +podman stop --latest + +## SEE ALSO +podman(1), podman-rm(1) + +## HISTORY +September 2018, Originally compiled by Brent Baude -- cgit v1.2.3-54-g00ecf