docs: rename cli reference aliases to canonical

Signed-off-by: David Karlsson <35727626+dvdksn@users.noreply.github.com>
This commit is contained in:
David Karlsson
2024-01-15 11:27:58 +01:00
parent cf9d3692a3
commit a6774de682
37 changed files with 70 additions and 72 deletions

View File

@ -1,31 +0,0 @@
# stop
<!---MARKER_GEN_START-->
Stop one or more running containers
### Aliases
`docker container stop`, `docker stop`
### Options
| Name | Type | Default | Description |
|:-----------------|:---------|:--------|:---------------------------------------------|
| `-s`, `--signal` | `string` | | Signal to send to the container |
| `-t`, `--time` | `int` | `0` | Seconds to wait before killing the container |
<!---MARKER_GEN_END-->
## Description
The main process inside the container will receive `SIGTERM`, and after a grace
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`.
## Examples
```console
$ docker stop my_container
```