mirror of https://github.com/docker/cli.git
Merge pull request #264 from thaJeztah/carry-moby-32803
Update docker kill reference docs
This commit is contained in:
commit
bbe7f84540
|
@ -27,9 +27,45 @@ Options:
|
||||||
|
|
||||||
## Description
|
## Description
|
||||||
|
|
||||||
The main process inside the container will be sent `SIGKILL`, or any
|
The `docker kill` subcommand kills one or more containers. The main process
|
||||||
signal specified with option `--signal`.
|
inside the container is sent `SIGKILL` signal (default), or the signal that is
|
||||||
|
specified with the `--signal` option. You can kill a container using the
|
||||||
|
container's ID, ID-prefix, or name.
|
||||||
|
|
||||||
> **Note**: `ENTRYPOINT` and `CMD` in the *shell* form run as a subcommand of
|
> **Note**: `ENTRYPOINT` and `CMD` in the *shell* form run as a subcommand of
|
||||||
> `/bin/sh -c`, which does not pass signals. This means that the executable is
|
> `/bin/sh -c`, which does not pass signals. This means that the executable is
|
||||||
> not the container’s PID 1 and does not receive Unix signals.
|
> not the container’s PID 1 and does not receive Unix signals.
|
||||||
|
|
||||||
|
## Examples
|
||||||
|
|
||||||
|
|
||||||
|
### Send a KILL signal to a container
|
||||||
|
|
||||||
|
The following example sends the default `KILL` signal to the container named
|
||||||
|
`my_container`:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
$ docker kill my_container
|
||||||
|
```
|
||||||
|
|
||||||
|
### Send a custom signal to a container
|
||||||
|
|
||||||
|
The following example sends a `SIGHUP` signal to the container named
|
||||||
|
`my_container`:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
$ docker kill --signal=SIGHUP my_container
|
||||||
|
```
|
||||||
|
|
||||||
|
|
||||||
|
You can specify a custom signal either by _name_, or _number_. The `SIG` prefix
|
||||||
|
is optional, so the following examples are equivalent:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
$ docker kill --signal=SIGHUP my_container
|
||||||
|
$ docker kill --signal=HUP my_container
|
||||||
|
$ docker kill --signal=1 my_container
|
||||||
|
```
|
||||||
|
|
||||||
|
Refer to the [`signal(7)`](http://man7.org/linux/man-pages/man7/signal.7.html)
|
||||||
|
man-page for a list of standard Linux signals.
|
||||||
|
|
Loading…
Reference in New Issue