summaryrefslogtreecommitdiff
path: root/docs/source/markdown/podman-volume-inspect.1.md
diff options
context:
space:
mode:
authorJhon Honce <jhonce@redhat.com>2019-10-29 17:27:12 -0700
committerbaude <bbaude@redhat.com>2019-10-31 12:31:39 -0500
commit486fcd4e1e6f00424f1016d8e331582523bd2c68 (patch)
treea1aff46e1f585a9e7a99e7a61a7cca63a4a1b507 /docs/source/markdown/podman-volume-inspect.1.md
parent52b92023edeba3a5e2c466d92d742e54b14a85cb (diff)
downloadpodman-486fcd4e1e6f00424f1016d8e331582523bd2c68.tar.gz
podman-486fcd4e1e6f00424f1016d8e331582523bd2c68.tar.bz2
podman-486fcd4e1e6f00424f1016d8e331582523bd2c68.zip
Update document formatting and packaging code
* Refactored code and Makefile to support new docs layout * Removed some old code packaging code * Add Readme.md to document what we're doing Signed-off-by: Jhon Honce <jhonce@redhat.com> Signed-off-by: baude <bbaude@redhat.com>
Diffstat (limited to 'docs/source/markdown/podman-volume-inspect.1.md')
-rw-r--r--docs/source/markdown/podman-volume-inspect.1.md46
1 files changed, 46 insertions, 0 deletions
diff --git a/docs/source/markdown/podman-volume-inspect.1.md b/docs/source/markdown/podman-volume-inspect.1.md
new file mode 100644
index 000000000..ac5b6c977
--- /dev/null
+++ b/docs/source/markdown/podman-volume-inspect.1.md
@@ -0,0 +1,46 @@
+% podman-volume-inspect(1)
+
+## NAME
+podman\-volume\-inspect - Get detailed information on one or more volumes
+
+## SYNOPSIS
+**podman volume inspect** [*options*] *volume* [...]
+
+## DESCRIPTION
+
+Display detailed information on one or more volumes. The output can be formatted using
+the **--format** flag and a Go template. To get detailed information about all the
+existing volumes, use the **--all** flag.
+Volumes can be queried individually by providing their full name or a unique partial name.
+
+
+## OPTIONS
+
+**-a**, **--all**
+
+Inspect all volumes.
+
+**--format**=*format*
+
+Format volume output using Go template
+
+**--help**
+
+Print usage statement
+
+
+## EXAMPLES
+
+```
+$ podman volume inspect myvol
+
+$ podman volume inspect --all
+
+$ podman volume inspect --format "{{.Driver}} {{.Scope}}" myvol
+```
+
+## SEE ALSO
+podman-volume(1)
+
+## HISTORY
+November 2018, Originally compiled by Urvashi Mohnani <umohnani@redhat.com>