summaryrefslogtreecommitdiff
path: root/docs/source
diff options
context:
space:
mode:
authorPatrycja Guzik <patrycja.k.guzik@gmail.com>2022-01-25 22:20:48 +0100
committerDaniel J Walsh <dwalsh@redhat.com>2022-01-27 07:13:06 -0500
commit63b1557a256a53e1729ecfc9bcadf10f67a90ba2 (patch)
tree52131f32a8e976c7b071109ee3652aa906c83773 /docs/source
parent09589fccfdd27478defc3e3e3827265d50fa9e33 (diff)
downloadpodman-63b1557a256a53e1729ecfc9bcadf10f67a90ba2.tar.gz
podman-63b1557a256a53e1729ecfc9bcadf10f67a90ba2.tar.bz2
podman-63b1557a256a53e1729ecfc9bcadf10f67a90ba2.zip
Unify podman prune filter description: volumes, networks, system
follow up of #12976 Signed-off-by: Patrycja Guzik <patrycja.k.guzik@gmail.com>
Diffstat (limited to 'docs/source')
-rw-r--r--docs/source/markdown/podman-network-prune.1.md21
-rw-r--r--docs/source/markdown/podman-system-prune.1.md12
-rw-r--r--docs/source/markdown/podman-volume-prune.1.md18
3 files changed, 32 insertions, 19 deletions
diff --git a/docs/source/markdown/podman-network-prune.1.md b/docs/source/markdown/podman-network-prune.1.md
index d35decb1b..7696f9dc3 100644
--- a/docs/source/markdown/podman-network-prune.1.md
+++ b/docs/source/markdown/podman-network-prune.1.md
@@ -18,17 +18,20 @@ Do not prompt for confirmation
#### **--filter**
-Filter output based on conditions given.
-Multiple filters can be given with multiple uses of the --filter option.
-Filters with the same key work inclusive with the only exception being
-`label` which is exclusive. Filters with different keys always work exclusive.
+Provide filter values.
-Valid filters are listed below:
+The *filters* argument format is of `key=value`. If there is more than one *filter*, then pass multiple OPTIONS: **--filter** *foo=bar* **--filter** *bif=baz*.
-| **Filter** | **Description** |
-| ---------- | ------------------------------------------------------------------------------------- |
-| label | [Key] or [Key=Value] Label assigned to a network |
-| until | only remove networks created before given timestamp |
+Supported filters:
+
+| Filter | Description |
+| :----------------: | --------------------------------------------------------------------------- |
+| *until* | Only remove networks created before given timestamp. |
+| *label* | Only remove networks, with (or without, in the case of label!=[...] is used) the specified labels. |
+
+The `until` *filter* can be Unix timestamps, date formatted timestamps, or Go duration strings (e.g. 10m, 1h30m) computed relative to the machine’s time.
+
+The `label` *filter* accepts two formats. One is the `label`=*key* or `label`=*key*=*value*, which removes networks with the specified labels. The other format is the `label!`=*key* or `label!`=*key*=*value*, which removes networks without the specified labels.
## EXAMPLE
Prune networks
diff --git a/docs/source/markdown/podman-system-prune.1.md b/docs/source/markdown/podman-system-prune.1.md
index d8b218db2..c00a3be78 100644
--- a/docs/source/markdown/podman-system-prune.1.md
+++ b/docs/source/markdown/podman-system-prune.1.md
@@ -22,16 +22,18 @@ Recursively remove all unused pod, container, image and volume data (Maximum 50
Provide filter values.
-The --filter flag format is of “key=value”. If there is more than one filter, then pass multiple flags (e.g., --filter "foo=bar" --filter "bif=baz")
+The *filters* argument format is of `key=value`. If there is more than one *filter*, then pass multiple OPTIONS: **--filter** *foo=bar* **--filter** *bif=baz*.
Supported filters:
-- `until` (_timestamp_) - only remove containers and images created before given timestamp
-- `label` (label=_key_, label=_key=value_, label!=_key_, or label!=_key=value_) - only remove containers and images, with (or without, in case label!=... is used) the specified labels.
+| Filter | Description |
+| :----------------: | --------------------------------------------------------------------------- |
+| *until* | Only remove containers and images created before given timestamp. |
+| *label* | Only remove containers and images, with (or without, in the case of label!=[...] is used) the specified labels. |
-The until filter can be Unix timestamps, date formatted timestamps, or Go duration strings (e.g. 10m, 1h30m) computed relative to the machine’s time.
+The `until` *filter* can be Unix timestamps, date formatted timestamps, or Go duration strings (e.g. 10m, 1h30m) computed relative to the machine’s time.
-The label filter accepts two formats. One is the label=... (label=_key_ or label=_key=value_), which removes containers and images with the specified labels. The other format is the label!=... (label!=_key_ or label!=_key=value_), which removes containers and images without the specified labels.
+The `label` *filter* accepts two formats. One is the `label`=*key* or `label`=*key*=*value*, which removes containers and images with the specified labels. The other format is the `label!`=*key* or `label!`=*key*=*value*, which removes containers and images without the specified labels.
#### **--force**, **-f**
diff --git a/docs/source/markdown/podman-volume-prune.1.md b/docs/source/markdown/podman-volume-prune.1.md
index 012567957..00b6f922a 100644
--- a/docs/source/markdown/podman-volume-prune.1.md
+++ b/docs/source/markdown/podman-volume-prune.1.md
@@ -21,12 +21,20 @@ Do not prompt for confirmation.
#### **--filter**
-Filter volumes to be pruned. Volumes can be filtered by the following attributes:
+Provide filter values.
-| **Filter** | **Description** |
-| ---------- | ------------------------------------------------------------------------------------- |
-| label | [Key] or [Key=Value] Label assigned to a volume |
-| until | Only remove volumes created before given timestamp |
+The *filters* argument format is of `key=value`. If there is more than one *filter*, then pass multiple OPTIONS: **--filter** *foo=bar* **--filter** *bif=baz*.
+
+Supported filters:
+
+| Filter | Description |
+| :----------------: | --------------------------------------------------------------------------- |
+| *until* | Only remove volumes created before given timestamp. |
+| *label* | Only remove volumes, with (or without, in the case of label!=[...] is used) the specified labels. |
+
+The `until` *filter* can be Unix timestamps, date formatted timestamps, or Go duration strings (e.g. 10m, 1h30m) computed relative to the machine’s time.
+
+The `label` *filter* accepts two formats. One is the `label`=*key* or `label`=*key*=*value*, which removes volumes with the specified labels. The other format is the `label!`=*key* or `label!`=*key*=*value*, which removes volumes without the specified labels.
#### **--help**