summaryrefslogtreecommitdiff
path: root/docs/source/man/podman-pause.1.md
diff options
context:
space:
mode:
authorbaude <bbaude@redhat.com>2019-10-24 14:54:57 -0500
committerbaude <bbaude@redhat.com>2019-10-31 12:31:39 -0500
commit52b92023edeba3a5e2c466d92d742e54b14a85cb (patch)
tree44e6193d49afd1277b7d07b0df41fc80d31b3adb /docs/source/man/podman-pause.1.md
parent5af166ff513265b17aee92a9ce3a1522090d7dec (diff)
downloadpodman-52b92023edeba3a5e2c466d92d742e54b14a85cb.tar.gz
podman-52b92023edeba3a5e2c466d92d742e54b14a85cb.tar.bz2
podman-52b92023edeba3a5e2c466d92d742e54b14a85cb.zip
Restructure documentation dir
Restructuring the docs dir to make integration with sphinx easier. man pages now exist in docs/source/man and the sphinx make files exists in docs. Signed-off-by: baude <bbaude@redhat.com>
Diffstat (limited to 'docs/source/man/podman-pause.1.md')
-rw-r--r--docs/source/man/podman-pause.1.md41
1 files changed, 41 insertions, 0 deletions
diff --git a/docs/source/man/podman-pause.1.md b/docs/source/man/podman-pause.1.md
new file mode 100644
index 000000000..dfd4da416
--- /dev/null
+++ b/docs/source/man/podman-pause.1.md
@@ -0,0 +1,41 @@
+% podman-pause(1)
+
+## NAME
+podman\-pause - Pause one or more containers
+
+## SYNOPSIS
+**podman pause** [*options*] [*container*...]
+
+**podman container pause** [*options*] [*container*...]
+
+## DESCRIPTION
+Pauses all the processes in one or more containers. You may use container IDs or names as input.
+
+## OPTIONS
+
+**--all**, **-a**
+
+Pause all running containers.
+
+## EXAMPLE
+
+Pause a container named 'mywebserver'
+```
+podman pause mywebserver
+```
+
+Pause a container by partial container ID.
+```
+podman pause 860a4b23
+```
+
+Pause all **running** containers.
+```
+podman stop -a
+```
+
+## SEE ALSO
+podman(1), podman-unpause(1)
+
+## HISTORY
+September 2017, Originally compiled by Dan Walsh <dwalsh@redhat.com>