diff options
| author | Jakub Guzik <jakubmguzik@gmail.com> | 2021-08-23 23:13:49 +0200 |
|---|---|---|
| committer | Matthew Heon <mheon@redhat.com> | 2021-08-30 13:36:58 -0400 |
| commit | 77948c8b44451aa592d270e6d174d68b8e74f51e (patch) | |
| tree | 4605a5fd2978a026bb6223ee11c9fc2d06ebd1c6 | |
| parent | aa754c7e2193e6f82a8c14f482bc58a7a5b07550 (diff) | |
| download | podman-77948c8b44451aa592d270e6d174d68b8e74f51e.tar.gz podman-77948c8b44451aa592d270e6d174d68b8e74f51e.tar.bz2 podman-77948c8b44451aa592d270e6d174d68b8e74f51e.zip | |
Add filter params description to volume list/prune docs
Description adjusted to the standard seen in other man pages.
[CI:DOCS]
Signed-off-by: Jakub Guzik <jakubmguzik@gmail.com>
| -rw-r--r-- | docs/source/markdown/podman-volume-ls.1.md | 16 | ||||
| -rw-r--r-- | docs/source/markdown/podman-volume-prune.1.md | 6 |
2 files changed, 13 insertions, 9 deletions
diff --git a/docs/source/markdown/podman-volume-ls.1.md b/docs/source/markdown/podman-volume-ls.1.md index b562aff61..6c80ec152 100644 --- a/docs/source/markdown/podman-volume-ls.1.md +++ b/docs/source/markdown/podman-volume-ls.1.md @@ -18,13 +18,15 @@ flag. Use the **--quiet** flag to print only the volume names. Volumes can be filtered by the following attributes: -- dangling -- driver -- label -- name -- opt -- scope -- until +| **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* diff --git a/docs/source/markdown/podman-volume-prune.1.md b/docs/source/markdown/podman-volume-prune.1.md index b9599c200..cfdfc1a44 100644 --- a/docs/source/markdown/podman-volume-prune.1.md +++ b/docs/source/markdown/podman-volume-prune.1.md @@ -23,8 +23,10 @@ Do not prompt for confirmation. Filter volumes to be pruned. Volumes can be filtered by the following attributes: -- label -- until +| **Filter** | **Description** | +| ---------- | ------------------------------------------------------------------------------------- | +| label | [Key] or [Key=Value] Label assigned to a volume | +| until | Only remove volumes created before given timestamp | #### **--help** |