mirror of
https://github.com/docker/compose.git
synced 2025-06-02 12:50:16 +02:00
9db79856be
This updates the format of various usage strings to be more consistent with other parts of the CLI. - Use `[OPTIONS]` to indicate where command-specific options should be added - Use `[SERVICE...]` to indicate zero-or-more services - Remove some usage strings for specific options (e.g. `-e NAME=VAL`), as that option is part of the already mentioned `[OPTIONS]` and we don't provide usage for each possible option that can be passed. - Remove `[--]`, which (I think) was needed for the Python implementation, but is a general feature to stop processing flag-options. Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
30 lines
744 B
YAML
30 lines
744 B
YAML
command: docker compose kill
|
|
short: Force stop service containers.
|
|
long: |-
|
|
Forces running containers to stop by sending a `SIGKILL` signal. Optionally the signal can be passed, for example:
|
|
|
|
```console
|
|
$ docker-compose kill -s SIGINT
|
|
```
|
|
usage: docker compose kill [OPTIONS] [SERVICE...]
|
|
pname: docker compose
|
|
plink: docker_compose.yaml
|
|
options:
|
|
- option: signal
|
|
shorthand: s
|
|
value_type: string
|
|
default_value: SIGKILL
|
|
description: SIGNAL to send to the container.
|
|
deprecated: false
|
|
hidden: false
|
|
experimental: false
|
|
experimentalcli: false
|
|
kubernetes: false
|
|
swarm: false
|
|
deprecated: false
|
|
experimental: false
|
|
experimentalcli: false
|
|
kubernetes: false
|
|
swarm: false
|
|
|