docs/data/engine-cli/docker_container_wait.yaml

54 lines
1.3 KiB
YAML

command: docker container wait
aliases: docker container wait, docker wait
short: Block until one or more containers stop, then print their exit codes
long: Block until one or more containers stop, then print their exit codes
usage: docker container wait CONTAINER [CONTAINER...]
pname: docker container
plink: docker_container.yaml
inherited_options:
- option: help
value_type: bool
default_value: "false"
description: Print usage
deprecated: false
hidden: true
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
examples: |-
Start a container in the background.
```console
$ docker run -dit --name=my_container ubuntu bash
```
Run `docker wait`, which should block until the container exits.
```console
$ docker wait my_container
```
In another terminal, stop the first container. The `docker wait` command above
returns the exit code.
```console
$ docker stop my_container
```
This is the same `docker wait` command from above, but it now exits, returning
`0`.
```console
$ docker wait my_container
0
```
deprecated: false
hidden: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false