Files
podman/docs/source/markdown/podman-volume-inspect.1.md
Paul Holzinger bc48211924 Fix long option format on docs.podman.io
Escape the two dashes, otherwise they are combined into one long dash.
I tested that this change is safe and still renders correctly on github
and with the man pages.

This commit also contains a small change to make it build locally.
Assuming you have the dependencies installed you can do:
```
cd docs
make html
```
Preview the html files in docs/build/html with
`python -m http.server 8000 --directory build/html`.

Fixes containers/podman.io#373

Signed-off-by: Paul Holzinger <paul.holzinger@web.de>
2021-03-29 14:38:25 +02:00

47 lines
948 B
Markdown

% 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
#### **\-\-all**, **-a**
Inspect all volumes.
#### **\-\-format**=*format*, **-f**
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>