Files
podman/docs/podman-stop.1.md
W. Trevor King f2462ca59e docs: Follow man-pages(7) suggestions for SYNOPSIS
man-pages(7) has [1]:

> For commands, this shows the syntax of the command and its arguments
> (including options); boldface is used for as-is text and italics are
> used to indicate replaceable arguments. Brackets ([]) surround
> optional arguments, vertical bars (|) separate choices, and ellipses
> (...) can be repeated.

I've adjusted our SYNOPSIS entries to match that formatting, and
generally tried to make them more consistent with the precedent set by
the man-pages project.  Outside of the SYNOPSIS entry, I prefer using
backticks for literals, although in some places I've left the **
bolding to keep things visually similar to a nearby SYNOPSIS entry.

[1]: http://man7.org/linux/man-pages/man7/man-pages.7.html

Signed-off-by: W. Trevor King <wking@tremily.us>

Closes: #1027
Approved by: rhatdan
2018-07-04 09:40:37 +00:00

50 lines
1.3 KiB
Markdown

% podman-stop "1"
## NAME
podman\-stop - Stop one or more containers
## SYNOPSIS
**podman 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
**--timeout, --time, t**
Timeout to wait before forcibly stopping the container
**--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.
## EXAMPLE
podman stop mywebserver
podman stop 860a4b23
podman stop mywebserver 860a4b23
podman stop --timeout 2 860a4b23
podman stop -a
podman stop --latest
## SEE ALSO
podman(1), podman-rm(1)
## HISTORY
September 2018, Originally compiled by Brent Baude <bbaude@redhat.com>