diff options
author | baude <bbaude@redhat.com> | 2019-10-24 14:54:57 -0500 |
---|---|---|
committer | Matthew Heon <mheon@redhat.com> | 2019-10-31 16:34:21 -0400 |
commit | 27e79f55407b9e46cee06c97ba53bc3a485f5c03 (patch) | |
tree | 033af31204e22a15378508403faa23fdbc1a3d6e /docs/source/man/podman-volume-ls.1.md | |
parent | d4ee76aae5959dfd36d277b72d1c0c9566a60c9f (diff) | |
download | podman-27e79f55407b9e46cee06c97ba53bc3a485f5c03.tar.gz podman-27e79f55407b9e46cee06c97ba53bc3a485f5c03.tar.bz2 podman-27e79f55407b9e46cee06c97ba53bc3a485f5c03.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-ls.1.md')
-rw-r--r-- | docs/source/man/podman-volume-ls.1.md | 49 |
1 files changed, 49 insertions, 0 deletions
diff --git a/docs/source/man/podman-volume-ls.1.md b/docs/source/man/podman-volume-ls.1.md new file mode 100644 index 000000000..d431c7c6e --- /dev/null +++ b/docs/source/man/podman-volume-ls.1.md @@ -0,0 +1,49 @@ +% 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 + +**--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> |