summaryrefslogtreecommitdiff
path: root/docs/source/markdown/podman-container-exists.1.md
diff options
context:
space:
mode:
authorOpenShift Merge Robot <openshift-merge-robot@users.noreply.github.com>2019-10-31 19:39:44 +0100
committerGitHub <noreply@github.com>2019-10-31 19:39:44 +0100
commitffe36ea9964242235571ad1d21a0c4d825ef5971 (patch)
treeb38d2d9c492ab2b2ad951135fde7e90c37344711 /docs/source/markdown/podman-container-exists.1.md
parent3e2d9f8662663f2f703bf674408d5255e493e18e (diff)
parent486fcd4e1e6f00424f1016d8e331582523bd2c68 (diff)
downloadpodman-ffe36ea9964242235571ad1d21a0c4d825ef5971.tar.gz
podman-ffe36ea9964242235571ad1d21a0c4d825ef5971.tar.bz2
podman-ffe36ea9964242235571ad1d21a0c4d825ef5971.zip
Merge pull request #4354 from baude/newdocsstruct
Restructure documentation dir
Diffstat (limited to 'docs/source/markdown/podman-container-exists.1.md')
-rw-r--r--docs/source/markdown/podman-container-exists.1.md42
1 files changed, 42 insertions, 0 deletions
diff --git a/docs/source/markdown/podman-container-exists.1.md b/docs/source/markdown/podman-container-exists.1.md
new file mode 100644
index 000000000..4d988132b
--- /dev/null
+++ b/docs/source/markdown/podman-container-exists.1.md
@@ -0,0 +1,42 @@
+% podman-container-exists(1)
+
+## NAME
+podman-container-exists - Check if a container exists in local storage
+
+## SYNOPSIS
+**podman container exists** [*options*] *container*
+
+## DESCRIPTION
+**podman container exists** checks if a container exists in local storage. The **ID** or **Name**
+of the container may be used as input. Podman will return an exit code
+of `0` when the container is found. A `1` will be returned otherwise. An exit code of `125` indicates there
+was an issue accessing the local storage.
+
+## OPTIONS
+
+**-h**, **--help**
+Print usage statement
+
+## Examples
+
+Check if an container called `webclient` exists in local storage (the container does actually exist).
+```
+$ sudo podman container exists webclient
+$ echo $?
+0
+$
+```
+
+Check if an container called `webbackend` exists in local storage (the container does not actually exist).
+```
+$ sudo podman container exists webbackend
+$ echo $?
+1
+$
+```
+
+## SEE ALSO
+podman(1)
+
+## HISTORY
+November 2018, Originally compiled by Brent Baude (bbaude at redhat dot com)