2016-10-14 18:30:36 -04:00
|
|
|
---
|
|
|
|
|
title: "stop"
|
|
|
|
|
description: "The stop command description and usage"
|
2016-11-03 18:48:30 -04:00
|
|
|
keywords: "stop, SIGKILL, SIGTERM"
|
2016-10-14 18:30:36 -04:00
|
|
|
---
|
2015-06-21 16:41:38 -04:00
|
|
|
|
|
|
|
|
# stop
|
|
|
|
|
|
2016-07-07 14:43:18 -04:00
|
|
|
```markdown
|
|
|
|
|
Usage: docker stop [OPTIONS] CONTAINER [CONTAINER...]
|
2015-06-21 16:41:38 -04:00
|
|
|
|
2016-07-07 14:43:18 -04:00
|
|
|
Stop one or more running containers
|
2015-06-21 16:41:38 -04:00
|
|
|
|
cli: use custom annotation for aliases
Cobra allows for aliases to be defined for a command, but only allows these
to be defined at the same level (for example, `docker image ls` as alias for
`docker image list`). Our CLI has some commands that are available both as a
top-level shorthand as well as `docker <object> <verb>` subcommands. For example,
`docker ps` is a shorthand for `docker container ps` / `docker container ls`.
This patch introduces a custom "aliases" annotation that can be used to print
all available aliases for a command. While this requires these aliases to be
defined manually, in practice the list of aliases rarely changes, so maintenance
should be minimal.
As a convention, we could consider the first command in this list to be the
canonical command, so that we can use this information to add redirects in
our documentation in future.
Before this patch:
docker images --help
Usage: docker images [OPTIONS] [REPOSITORY[:TAG]]
List images
Options:
-a, --all Show all images (default hides intermediate images)
...
With this patch:
docker images --help
Usage: docker images [OPTIONS] [REPOSITORY[:TAG]]
List images
Aliases:
docker image ls, docker image list, docker images
Options:
-a, --all Show all images (default hides intermediate images)
...
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2022-06-28 04:52:25 -04:00
|
|
|
Aliases:
|
|
|
|
|
docker container stop, docker stop
|
|
|
|
|
|
2016-07-07 14:43:18 -04:00
|
|
|
Options:
|
2022-02-18 06:25:17 -05:00
|
|
|
-s, --signal string Signal to send to the container
|
|
|
|
|
-t, --time int Seconds to wait before killing the container
|
2016-07-07 14:43:18 -04:00
|
|
|
```
|
2015-06-21 16:41:38 -04:00
|
|
|
|
2017-02-07 18:42:48 -05:00
|
|
|
## Description
|
|
|
|
|
|
2015-06-21 16:41:38 -04:00
|
|
|
The main process inside the container will receive `SIGTERM`, and after a grace
|
2021-04-03 17:13:01 -04:00
|
|
|
period, `SIGKILL`. The first signal can be changed with the `STOPSIGNAL`
|
|
|
|
|
instruction in the container's Dockerfile, or the `--stop-signal` option to
|
|
|
|
|
`docker run`.
|
2017-02-07 18:42:48 -05:00
|
|
|
|
|
|
|
|
## Examples
|
|
|
|
|
|
2021-08-21 08:54:14 -04:00
|
|
|
```console
|
2017-02-07 18:42:48 -05:00
|
|
|
$ docker stop my_container
|
|
|
|
|
```
|
