p4u1/docker-cli
0
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
Files
61c68f6c04de45f1f32ca14936ee9113bdd2cdf9
docker-cli/components/cli/docs/reference/commandline/pause.md
Misty Stanley-Jones 020523b38b Standardized formatting of CLI reference commands 
Command name should be a H1

Only Description, Examples, and Related Commands should be H2

Changed 'Related information' heading to 'Related commands' since 99% it is only linking commands

Added some examples where relevant

Signed-off-by: Misty Stanley-Jones <misty@docker.com>
Upstream-commit: ddadd3db49
Component: cli
2017-06-02 00:10:53 +00:00

1.3 KiB
Raw Blame History

title, description, keywords
title description keywords
pause The pause command description and usage cgroups, container, suspend, SIGSTOP

pause

Usage:  docker pause CONTAINER [CONTAINER...]

Pause all processes within one or more containers

Options:
      --help   Print usage

Description

The docker pause command suspends all processes in the specified containers. On Linux, this uses the cgroups freezer. Traditionally, when suspending a process the SIGSTOP signal is used, which is observable by the process being suspended. With the cgroups freezer 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 cgroups freezer documentation for further details.

Examples

$ docker pause my_container

Related commands