diff options
author | baude <bbaude@redhat.com> | 2019-10-24 14:54:57 -0500 |
---|---|---|
committer | Matthew Heon <mheon@redhat.com> | 2019-10-31 16:34:21 -0400 |
commit | 27e79f55407b9e46cee06c97ba53bc3a485f5c03 (patch) | |
tree | 033af31204e22a15378508403faa23fdbc1a3d6e /docs/source/man/podman-pod-exists.1.md | |
parent | d4ee76aae5959dfd36d277b72d1c0c9566a60c9f (diff) | |
download | podman-27e79f55407b9e46cee06c97ba53bc3a485f5c03.tar.gz podman-27e79f55407b9e46cee06c97ba53bc3a485f5c03.tar.bz2 podman-27e79f55407b9e46cee06c97ba53bc3a485f5c03.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-pod-exists.1.md')
-rw-r--r-- | docs/source/man/podman-pod-exists.1.md | 37 |
1 files changed, 37 insertions, 0 deletions
diff --git a/docs/source/man/podman-pod-exists.1.md b/docs/source/man/podman-pod-exists.1.md new file mode 100644 index 000000000..cf2852934 --- /dev/null +++ b/docs/source/man/podman-pod-exists.1.md @@ -0,0 +1,37 @@ +% podman-pod-exists(1) + +## NAME +podman-pod-exists - Check if a pod exists in local storage + +## SYNOPSIS +**podman pod exists** *pod* + +## DESCRIPTION +**podman pod exists** checks if a pod exists in local storage. The **ID** or **Name** +of the pod may be used as input. Podman will return an exit code +of `0` when the pod is found. A `1` will be returned otherwise. An exit code of `125` indicates there +was an issue accessing the local storage. + +## Examples ## + +Check if a pod called `web` exists in local storage (the pod does actually exist). +``` +$ sudo podman pod exists web +$ echo $? +0 +$ +``` + +Check if a pod called `backend` exists in local storage (the pod does not actually exist). +``` +$ sudo podman pod exists backend +$ echo $? +1 +$ +``` + +## SEE ALSO +podman-pod(1), podman(1) + +## HISTORY +December 2018, Originally compiled by Brent Baude (bbaude at redhat dot com) |