compose/docs/reference/docker_compose_kill.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: remove-orphans
      value_type: bool
      default_value: "false"
      description: Remove containers for services not defined in the Compose file
      deprecated: false
      hidden: false
      experimental: false
      experimentalcli: false
      kubernetes: false
      swarm: false
    - 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
inherited_options:
    - option: dry-run
      value_type: bool
      default_value: "false"
      description: Execute command in dry run mode
      deprecated: false
      hidden: false
      experimental: false
      experimentalcli: false
      kubernetes: false
      swarm: false
deprecated: false
hidden: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
generate reference documentation Signed-off-by: Nicolas De Loof <nicolas.deloof@gmail.com> 2021-03-08 15:47:24 +01:00			`command: docker compose kill`
docs: unify no trailing dots in docstrings and help (#11301) 2024-02-14 20:02:37 +01:00			`short: Force stop service containers`
reference documentation Signed-off-by: Nicolas De Loof <nicolas.deloof@gmail.com> 2021-03-11 16:20:30 +01:00			`long: \|-`
update cli-doc-tool and update the doc with this new version Signed-off-by: Guillaume Lours <guillaume.lours@docker.com> 2022-07-26 14:58:08 +02:00			Forces running containers to stop by sending a `SIGKILL` signal. Optionally the signal can be passed, for example:
reference documentation Signed-off-by: Nicolas De Loof <nicolas.deloof@gmail.com> 2021-03-11 16:20:30 +01:00
update cli-doc-tool and update the doc with this new version Signed-off-by: Guillaume Lours <guillaume.lours@docker.com> 2022-07-26 14:58:08 +02:00			```console
docs: Update docker compose kill usage Signed-off-by: Jan Brasna <1784648+janbrasna@users.noreply.github.com> 2024-08-02 19:42:23 +02:00			`$ docker compose kill -s SIGINT`
update cli-doc-tool and update the doc with this new version Signed-off-by: Guillaume Lours <guillaume.lours@docker.com> 2022-07-26 14:58:08 +02:00			```
update usage strings for consistency 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> 2022-08-02 13:11:57 +02:00			`usage: docker compose kill [OPTIONS] [SERVICE...]`
generate reference documentation Signed-off-by: Nicolas De Loof <nicolas.deloof@gmail.com> 2021-03-08 15:47:24 +01:00			`pname: docker compose`
			`plink: docker_compose.yaml`
			`options:`
Update docs for new `compose kill` `--remove-orphans` option Signed-off-by: Laura Brehm <laurabrehm@hey.com> 2022-08-19 04:29:51 +02:00			`- option: remove-orphans`
			`value_type: bool`
			`default_value: "false"`
docs: unify no trailing dots in docstrings and help (#11301) 2024-02-14 20:02:37 +01:00			`description: Remove containers for services not defined in the Compose file`
Update docs for new `compose kill` `--remove-orphans` option Signed-off-by: Laura Brehm <laurabrehm@hey.com> 2022-08-19 04:29:51 +02:00			`deprecated: false`
			`hidden: false`
			`experimental: false`
			`experimentalcli: false`
			`kubernetes: false`
			`swarm: false`
update cli-doc-tool and update the doc with this new version Signed-off-by: Guillaume Lours <guillaume.lours@docker.com> 2022-07-26 14:58:08 +02:00			`- option: signal`
			`shorthand: s`
			`value_type: string`
			`default_value: SIGKILL`
docs: unify no trailing dots in docstrings and help (#11301) 2024-02-14 20:02:37 +01:00			`description: SIGNAL to send to the container`
update cli-doc-tool and update the doc with this new version Signed-off-by: Guillaume Lours <guillaume.lours@docker.com> 2022-07-26 14:58:08 +02:00			`deprecated: false`
			`hidden: false`
			`experimental: false`
			`experimentalcli: false`
			`kubernetes: false`
			`swarm: false`
Update dry-run documentation Co-authored-by: Allie Sadler <102604716+aevesdocker@users.noreply.github.com> Signed-off-by: Guillaume Lours <705411+glours@users.noreply.github.com> 2023-05-05 12:43:27 +02:00			`inherited_options:`
			`- option: dry-run`
			`value_type: bool`
			`default_value: "false"`
			`description: Execute command in dry run mode`
			`deprecated: false`
			`hidden: false`
			`experimental: false`
			`experimentalcli: false`
			`kubernetes: false`
			`swarm: false`
generate reference documentation Signed-off-by: Nicolas De Loof <nicolas.deloof@gmail.com> 2021-03-08 15:47:24 +01:00			`deprecated: false`
deps: bump docker/cli-docs-tool to v0.6.0 Required re-running `make docs` to pick up changes. Signed-off-by: Milas Bowman <milas.bowman@docker.com> 2023-07-07 14:27:14 +02:00			`hidden: false`
generate reference documentation Signed-off-by: Nicolas De Loof <nicolas.deloof@gmail.com> 2021-03-08 15:47:24 +01:00			`experimental: false`
			`experimentalcli: false`
			`kubernetes: false`
			`swarm: false`