Update docs for new `compose kill` `--remove-orphans` option

Signed-off-by: Laura Brehm <laurabrehm@hey.com>
This commit is contained in:
Laura Brehm 2022-08-19 04:29:51 +02:00
parent fcfcc1524e
commit a226fe9daf
No known key found for this signature in database
GPG Key ID: 526E3FC49260D47A
2 changed files with 11 additions and 0 deletions

View File

@ -7,6 +7,7 @@ Force stop service containers.
| Name | Type | Default | Description |
| --- | --- | --- | --- |
| `--remove-orphans` | | | Remove containers for services not defined in the Compose file. |
| `-s`, `--signal` | `string` | `SIGKILL` | SIGNAL to send to the container. |

View File

@ -10,6 +10,16 @@ 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