diff --git a/components/engine/docs/man/docker-pause.1.md b/components/engine/docs/man/docker-pause.1.md index e6c0c2455d..7b4b091a06 100644 --- a/components/engine/docs/man/docker-pause.1.md +++ b/components/engine/docs/man/docker-pause.1.md @@ -8,6 +8,18 @@ docker-pause - Pause all processes within a container **docker pause** CONTAINER +# DESCRIPTION + +The `docker pause` command uses the cgroups freezer to suspend all processes in +a container. 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. + +See the [cgroups freezer documentation] +(https://www.kernel.org/doc/Documentation/cgroups/freezer-subsystem.txt) for +further details. + # OPTIONS There are no available options. diff --git a/components/engine/docs/man/docker-unpause.1.md b/components/engine/docs/man/docker-unpause.1.md index 8949548b67..dfce16324e 100644 --- a/components/engine/docs/man/docker-unpause.1.md +++ b/components/engine/docs/man/docker-unpause.1.md @@ -8,6 +8,15 @@ docker-unpause - Unpause all processes within a container **docker unpause** CONTAINER +# DESCRIPTION + +The `docker unpause` command uses the cgroups freezer to un-suspend all +processes in a container. + +See the [cgroups freezer documentation] +(https://www.kernel.org/doc/Documentation/cgroups/freezer-subsystem.txt) for +further details. + # OPTIONS There are no available options. diff --git a/components/engine/docs/sources/reference/commandline/cli.md b/components/engine/docs/sources/reference/commandline/cli.md index e9d21cac47..dac7c1610b 100644 --- a/components/engine/docs/sources/reference/commandline/cli.md +++ b/components/engine/docs/sources/reference/commandline/cli.md @@ -760,6 +760,22 @@ log entry. Lookup the public-facing port that is NAT-ed to PRIVATE_PORT +## pause + + Usage: docker pause CONTAINER + + Pause all processes within a container + +The `docker pause` command uses the cgroups freezer to suspend all processes in +a container. 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. + +See the [cgroups freezer documentation] +(https://www.kernel.org/doc/Documentation/cgroups/freezer-subsystem.txt) for +further details. + ## ps Usage: docker ps [OPTIONS] @@ -1263,6 +1279,19 @@ them to [*Share Images via Repositories*]( Display the running processes of a container +## unpause + + Usage: docker unpause CONTAINER + + Resumes a paused container. + +The `docker unpause` command uses the cgroups freezer to un-suspend all +processes in a container. + +See the [cgroups freezer documentation] +(https://www.kernel.org/doc/Documentation/cgroups/freezer-subsystem.txt) for +further details. + ## version Usage: docker version