docs/data/engine-cli/docker_container_pause.yaml

40 lines
1.2 KiB
YAML

command: docker container pause
aliases: docker container pause, docker pause
short: Pause all processes within one or more containers
long: |-
The `docker pause` command suspends all processes in the specified containers.
On Linux, this uses the freezer cgroup. Traditionally, when suspending a process
the `SIGSTOP` signal is used, which is observable by the process being suspended.
With the freezer cgroup the process is unaware, and unable to capture,
that it is being suspended, and subsequently resumed. On Windows, only Hyper-V
containers can be paused.
See the
[freezer cgroup documentation](https://www.kernel.org/doc/Documentation/cgroup-v1/freezer-subsystem.txt)
for further details.
usage: docker container pause 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: |-
```console
$ docker pause my_container
```
deprecated: false
hidden: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false