summaryrefslogtreecommitdiff
path: root/docs/source/man/podman-volume-inspect.1.md
diff options
context:
space:
mode:
authorbaude <bbaude@redhat.com>2019-10-24 14:54:57 -0500
committerbaude <bbaude@redhat.com>2019-10-31 12:31:39 -0500
commit52b92023edeba3a5e2c466d92d742e54b14a85cb (patch)
tree44e6193d49afd1277b7d07b0df41fc80d31b3adb /docs/source/man/podman-volume-inspect.1.md
parent5af166ff513265b17aee92a9ce3a1522090d7dec (diff)
downloadpodman-52b92023edeba3a5e2c466d92d742e54b14a85cb.tar.gz
podman-52b92023edeba3a5e2c466d92d742e54b14a85cb.tar.bz2
podman-52b92023edeba3a5e2c466d92d742e54b14a85cb.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-volume-inspect.1.md')
-rw-r--r--docs/source/man/podman-volume-inspect.1.md46
1 files changed, 46 insertions, 0 deletions
diff --git a/docs/source/man/podman-volume-inspect.1.md b/docs/source/man/podman-volume-inspect.1.md
new file mode 100644
index 000000000..ac5b6c977
--- /dev/null
+++ b/docs/source/man/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>