summaryrefslogtreecommitdiff
path: root/docs/reference/commandline/pause.md
diff options
context:
space:
mode:
authorMisty Stanley-Jones <misty@apache.org>2017-04-03 16:54:34 -0700
committerGitHub <noreply@github.com>2017-04-03 16:54:34 -0700
commit473c5701cb66403b0535a5c01845cb0f27fbeb47 (patch)
tree9a40326ad4b426655abca7377dc30da003847d4d /docs/reference/commandline/pause.md
parentce07fb6b0f1b8765b92022e45f96bd4349812e06 (diff)
parent71e6babfa2598669218177b5b429e873b7f35e8f (diff)
downloaddocker-1.13.x.tar.gz
Merge pull request #32332 from mstanleyjones/1.13.x1.13.x
Cherry-pick command-line ref improvements
Diffstat (limited to 'docs/reference/commandline/pause.md')
-rw-r--r--docs/reference/commandline/pause.md10
1 files changed, 9 insertions, 1 deletions
diff --git a/docs/reference/commandline/pause.md b/docs/reference/commandline/pause.md
index e2dd800d5f..5bb652b923 100644
--- a/docs/reference/commandline/pause.md
+++ b/docs/reference/commandline/pause.md
@@ -24,6 +24,8 @@ 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.
@@ -35,6 +37,12 @@ See the
[cgroups freezer documentation](https://www.kernel.org/doc/Documentation/cgroup-v1/freezer-subsystem.txt)
for further details.
-## Related information
+## Examples
+
+```bash
+$ docker pause my_container
+```
+
+## Related commands
* [unpause](unpause.md)