summaryrefslogtreecommitdiff
path: root/docs/podman-container-exists.1.md
diff options
context:
space:
mode:
authorOpenShift Merge Robot <openshift-merge-robot@users.noreply.github.com>2018-11-26 10:03:37 -0800
committerGitHub <noreply@github.com>2018-11-26 10:03:37 -0800
commitf4db780beaa7c7ae6cc9749905246151955bffaf (patch)
tree581d8a9bf1875426c4e3ebafe8f0bddd36559031 /docs/podman-container-exists.1.md
parente3ece3bb907145110408c54f70b839777b09da44 (diff)
parent9d883d2032b112d5c65040629313cfba0de6c479 (diff)
downloadpodman-f4db780beaa7c7ae6cc9749905246151955bffaf.tar.gz
podman-f4db780beaa7c7ae6cc9749905246151955bffaf.tar.bz2
podman-f4db780beaa7c7ae6cc9749905246151955bffaf.zip
Merge pull request #1865 from baude/exists
add podman container|image exists
Diffstat (limited to 'docs/podman-container-exists.1.md')
-rw-r--r--docs/podman-container-exists.1.md40
1 files changed, 40 insertions, 0 deletions
diff --git a/docs/podman-container-exists.1.md b/docs/podman-container-exists.1.md
new file mode 100644
index 000000000..76701e2c2
--- /dev/null
+++ b/docs/podman-container-exists.1.md
@@ -0,0 +1,40 @@
+% PODMAN(1) Podman Man Pages
+% Brent Baude
+% November 2018
+# NAME
+podman-container-exists- Check if a container exists in local storage
+
+# SYNOPSIS
+**podman container exists**
+[**-h**|**--help**]
+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.
+
+## 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)