Files
podman/docs/source/markdown/podman-volume-ls.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

50 lines
922 B
Markdown

% podman-volume-ls(1)
## NAME
podman\-volume\-ls - List all the available volumes
## SYNOPSIS
**podman volume ls** [*options*]
## DESCRIPTION
Lists all the volumes that exist. The output can be filtered using the **--filter**
flag and can be formatted to either JSON or a Go template using the **--format**
flag. Use the **--quiet** flag to print only the volume names.
## OPTIONS
**-f**, **--filter**=*filter*
Filter volume output.
**--format**=*format*
Format volume output using Go template.
**--help**
Print usage statement.
**-q**, **--quiet**
Print volume output in quiet mode. Only print the volume names.
## EXAMPLES
```
$ podman volume ls
$ podman volume ls --format json
$ podman volume ls --format "{{.Driver}} {{.Scope}}"
$ podman volume ls --filter name=foo,label=blue
```
## SEE ALSO
podman-volume(1)
## HISTORY
November 2018, Originally compiled by Urvashi Mohnani <umohnani@redhat.com>