From 27e79f55407b9e46cee06c97ba53bc3a485f5c03 Mon Sep 17 00:00:00 2001 From: baude Date: Thu, 24 Oct 2019 14:54:57 -0500 Subject: 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 --- docs/source/man/podman-volume-ls.1.md | 49 +++++++++++++++++++++++++++++++++++ 1 file changed, 49 insertions(+) create mode 100644 docs/source/man/podman-volume-ls.1.md (limited to 'docs/source/man/podman-volume-ls.1.md') 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 -- cgit v1.2.3-54-g00ecf