mirror of
https://github.com/containers/podman.git
synced 2025-06-03 12:17:13 +08:00
ad7c54e13a
Followup to #14906, in which a nonexistent option was found in a man page. The xref script was designed to catch that, but I was too lax in my parsing: the option was documented using wrong syntax, and the script didn't catch it. Solution: do not allow *any* unrecognized cruft in the option description lines. And fix all improperly-written entries to conform to the rule: **--option**=*value(s)* Two asterisks around option, which must have two dashes. One asterisk around value(s). This is going to cause headaches for some people adding new options, but I don't think I can fix that: there are many factors that make an unparseable line. Adding 'hint' code would make the script even more complex than it is. I have to assume that our contributors are smart enough to look at surrounding context and figure out the right way to specify options. Signed-off-by: Ed Santiago <santiago@redhat.com>
47 lines
1.0 KiB
Markdown
47 lines
1.0 KiB
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**, **-f**=*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(1)](podman.1.md)**, **[podman-volume(1)](podman-volume.1.md)**, **[podman-inspect(1)](podman-inspect.1.md)**
|
|
|
|
## HISTORY
|
|
November 2018, Originally compiled by Urvashi Mohnani <umohnani@redhat.com>
|