summaryrefslogtreecommitdiff
path: root/docs/podman-container-exists.1.md
diff options
context:
space:
mode:
authorAshley Cui <ashleycui16@gmail.com>2019-05-31 15:21:47 -0400
committerAshley Cui <ashleycui16@gmail.com>2019-06-10 11:48:02 -0400
commit19e0928037e2d9c6fb0941e2ac40b8cea731e22d (patch)
tree1b5b10718e2c27c690ae789392fe1d46535a4401 /docs/podman-container-exists.1.md
parent7b0d6fcf0e3ce59f842273f670d742aaf597bf2f (diff)
downloadpodman-19e0928037e2d9c6fb0941e2ac40b8cea731e22d.tar.gz
podman-19e0928037e2d9c6fb0941e2ac40b8cea731e22d.tar.bz2
podman-19e0928037e2d9c6fb0941e2ac40b8cea731e22d.zip
standardize documentation formatting
Signed-off-by: Ashley Cui <ashleycui16@gmail.com>
Diffstat (limited to 'docs/podman-container-exists.1.md')
-rw-r--r--docs/podman-container-exists.1.md22
1 files changed, 13 insertions, 9 deletions
diff --git a/docs/podman-container-exists.1.md b/docs/podman-container-exists.1.md
index 8feb736f8..4d988132b 100644
--- a/docs/podman-container-exists.1.md
+++ b/docs/podman-container-exists.1.md
@@ -1,19 +1,23 @@
-% PODMAN(1) Podman Man Pages
-% Brent Baude
-% November 2018
-# NAME
+% podman-container-exists(1)
+
+## NAME
podman-container-exists - Check if a container exists in local storage
-# SYNOPSIS
-**podman container exists** [*-h*|*--help*] *container*
+## SYNOPSIS
+**podman container exists** [*options*] *container*
-# DESCRIPTION
+## 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 ##
+## OPTIONS
+
+**-h**, **--help**
+Print usage statement
+
+## Examples
Check if an container called `webclient` exists in local storage (the container does actually exist).
```
@@ -34,5 +38,5 @@ $
## SEE ALSO
podman(1)
-# HISTORY
+## HISTORY
November 2018, Originally compiled by Brent Baude (bbaude at redhat dot com)