summaryrefslogtreecommitdiff
path: root/docs/source/man/podman-wait.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-wait.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-wait.1.md')
-rw-r--r--docs/source/man/podman-wait.1.md48
1 files changed, 48 insertions, 0 deletions
diff --git a/docs/source/man/podman-wait.1.md b/docs/source/man/podman-wait.1.md
new file mode 100644
index 000000000..ce1c70a5f
--- /dev/null
+++ b/docs/source/man/podman-wait.1.md
@@ -0,0 +1,48 @@
+% podman-wait(1)
+
+## NAME
+podman\-wait - Wait on one or more containers to stop and print their exit codes
+
+## SYNOPSIS
+**podman wait** [*options*] *container*
+
+**podman container wait** [*options*] *container*
+
+## DESCRIPTION
+Waits on one or more containers to stop. The container can be referred to by its
+name or ID. In the case of multiple containers, podman will wait on each consecutively.
+After the container stops, the container's return code is printed.
+
+## OPTIONS
+
+**--help**, **-h**
+
+ Print usage statement
+
+**--interval**, **-i**=*microseconds*
+ Microseconds to wait before polling for completion
+
+**--latest**, **-l**
+
+Instead of providing the container name or ID, use the last created container. If you use methods other than Podman
+to run containers such as CRI-O, the last started container could be from either of those methods.
+
+The latest option is not supported on the remote client.
+
+## EXAMPLES
+
+```
+$ podman wait mywebserver
+
+$ podman wait --latest
+
+$ podman wait 860a4b23
+
+$ podman wait mywebserver myftpserver
+```
+
+## SEE ALSO
+podman(1)
+
+## HISTORY
+September 2017, Originally compiled by Brent Baude<bbaude@redhat.com>