mirror of
https://github.com/containers/podman.git
synced 2025-12-14 19:10:16 +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>
66 lines
2.0 KiB
Markdown
66 lines
2.0 KiB
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
|
|
|
|
#### **--filter**, **-f**=*filter*
|
|
|
|
Volumes can be filtered by the following attributes:
|
|
|
|
| **Filter** | **Description** |
|
|
| ---------- | ------------------------------------------------------------------------------------- |
|
|
| dangling | [Dangling] Matches all volumes not referenced by any containers |
|
|
| driver | [Driver] Matches volumes based on their driver |
|
|
| label | [Key] or [Key=Value] Label assigned to a volume |
|
|
| name | [Name] Volume name (accepts regex) |
|
|
| opt | Matches a storage driver options |
|
|
| scope | Filters volume by scope |
|
|
| until | Only remove volumes created before given timestamp |
|
|
|
|
#### **--format**=*format*
|
|
|
|
Format volume output using Go template.
|
|
|
|
#### **--help**
|
|
|
|
Print usage statement.
|
|
|
|
#### **--noheading**
|
|
|
|
Omit the table headings from the listing of volumes.
|
|
|
|
#### **--quiet**, **-q**
|
|
|
|
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
|
|
|
|
$ podman volume ls --filter label=key=value
|
|
```
|
|
|
|
## SEE ALSO
|
|
**[podman(1)](podman.1.md)**, **[podman-volume(1)](podman-volume.1.md)**
|
|
|
|
## HISTORY
|
|
November 2018, Originally compiled by Urvashi Mohnani <umohnani@redhat.com>
|