Guest24897
/
DockerCLI
mirror of https://github.com/docker/cli.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
DockerCLI/docs/reference/commandline/stop.md

31 lines
679 B
Markdown
Raw Normal View History

Convert Markdown frontmatter to YAML Some frontmatter such as the weights, menu stuff, etc is no longer used 'draft=true' becomes 'published: false' Signed-off-by: Misty Stanley-Jones <misty@docker.com>
2016-10-14 18:30:36 -04:00
---
title: "stop"
description: "The stop command description and usage"
fix frontmatter keywords value type (string, instead of []string) in /docs/reference Signed-off-by: Gaetan de Villele <gdevillele@gmail.com>
2016-11-03 18:48:30 -04:00
keywords: "stop, SIGKILL, SIGTERM"
Convert Markdown frontmatter to YAML Some frontmatter such as the weights, menu stuff, etc is no longer used 'draft=true' becomes 'published: false' Signed-off-by: Misty Stanley-Jones <misty@docker.com>
2016-10-14 18:30:36 -04:00
---
Splitting out the cli command into parts. Signed-off-by: Mary Anthony <mary@docker.com>
2015-06-21 16:41:38 -04:00
# stop
Updates on cli reference documentation - Update ps with `--last` flag - Update commands with current output - Make sure hugo does not detect the wrong language - Update usage for `tag` command to be more coherent with the other ones Signed-off-by: Vincent Demeester <vincent@sbr.pm>
2016-07-07 14:43:18 -04:00
```markdown
Usage: docker stop [OPTIONS] CONTAINER [CONTAINER...]
Splitting out the cli command into parts. Signed-off-by: Mary Anthony <mary@docker.com>
2015-06-21 16:41:38 -04:00
Updates on cli reference documentation - Update ps with `--last` flag - Update commands with current output - Make sure hugo does not detect the wrong language - Update usage for `tag` command to be more coherent with the other ones Signed-off-by: Vincent Demeester <vincent@sbr.pm>
2016-07-07 14:43:18 -04:00
Stop one or more running containers
Splitting out the cli command into parts. Signed-off-by: Mary Anthony <mary@docker.com>
2015-06-21 16:41:38 -04:00
Updates on cli reference documentation - Update ps with `--last` flag - Update commands with current output - Make sure hugo does not detect the wrong language - Update usage for `tag` command to be more coherent with the other ones Signed-off-by: Vincent Demeester <vincent@sbr.pm>
2016-07-07 14:43:18 -04:00
Options:
add --signal option to stop and restart Wording and documentation still need to be updated, but will do so in a follow-up. Also removing the default "10 seconds" from the timeout flags, as this default is not actually used, and may not match the actual default (which is defined on the daemon side). Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
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
Updates on cli reference documentation - Update ps with `--last` flag - Update commands with current output - Make sure hugo does not detect the wrong language - Update usage for `tag` command to be more coherent with the other ones Signed-off-by: Vincent Demeester <vincent@sbr.pm>
2016-07-07 14:43:18 -04:00
```
Splitting out the cli command into parts. Signed-off-by: Mary Anthony <mary@docker.com>
2015-06-21 16:41:38 -04:00
Standardized formatting of CLI reference commands Command name should be a H1 Only Description, Examples, and Related Commands should be H2 Changed 'Related information' heading to 'Related commands' since 99% it is only linking commands Added some examples where relevant Signed-off-by: Misty Stanley-Jones <misty@docker.com>
2017-02-07 18:42:48 -05:00
## Description
Splitting out the cli command into parts. Signed-off-by: Mary Anthony <mary@docker.com>
2015-06-21 16:41:38 -04:00
The main process inside the container will receive `SIGTERM`, and after a grace
Update stop.md Updates the stop.md doc to mention that the stop signal can be changed, either with the Dockerfile or via `docker run --stop-signal`. This is a real gotcha if you're not familiar with this feature and build a container that extends a container that uses `STOPSIGNAL`. Signed-off-by: Christopher Vermilion <christopher.vermilion@gmail.com>
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`.
Standardized formatting of CLI reference commands Command name should be a H1 Only Description, Examples, and Related Commands should be H2 Changed 'Related information' heading to 'Related commands' since 99% it is only linking commands Added some examples where relevant Signed-off-by: Misty Stanley-Jones <misty@docker.com>
2017-02-07 18:42:48 -05:00
## Examples
docs: use "console" code-hint for shell examples This replaces the use of bash where suitable, to allow easier copy/pasting of shell examples without copying the prompt or process output. Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2021-08-21 08:54:14 -04:00
```console
Standardized formatting of CLI reference commands Command name should be a H1 Only Description, Examples, and Related Commands should be H2 Changed 'Related information' heading to 'Related commands' since 99% it is only linking commands Added some examples where relevant Signed-off-by: Misty Stanley-Jones <misty@docker.com>
2017-02-07 18:42:48 -05:00
$ docker stop my_container
```