Files
podman/docs/source/markdown/podman-volume-inspect.1.md
Ed Santiago 281def2647 man pages: fix inconsistencies
I wrote a script to cross-reference podman --help against
man pages. It found a bunch of inconsistencies fix them:

 * options missing from man pages
 * options misspelled or misformatted in man pages (usually
   misplaced asterisks or missing dashes, but see --dns-opt)
 * one spurious comma in the actual source file --help

This is a fix in which I iterate over 'podman CMD --help'
and check for presence in man pages. The other way around
(look for flags in man pages, check podman CMD --help)
is probably impossible: there are too many special cases

Signed-off-by: Ed Santiago <santiago@redhat.com>
2020-03-10 15:03:59 -06:00

47 lines
923 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
**-a**, **--all**
Inspect all volumes.
**-f**, **--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>