summaryrefslogtreecommitdiff
path: root/docs/source/markdown
diff options
context:
space:
mode:
authorOpenShift Merge Robot <openshift-merge-robot@users.noreply.github.com>2022-01-27 09:42:50 -0500
committerGitHub <noreply@github.com>2022-01-27 09:42:50 -0500
commit9e7e91c13e32fc5897b336dbed8df1fd060a3ac4 (patch)
treea77d038a1d6e3fc461718d5564f7771dc4d3139e /docs/source/markdown
parent5b01dab618fc287df4e6c41fa88c4a64d31fa3f3 (diff)
parent24dc02064e6203958136d8ea3a354fc1329cb7b0 (diff)
downloadpodman-9e7e91c13e32fc5897b336dbed8df1fd060a3ac4.tar.gz
podman-9e7e91c13e32fc5897b336dbed8df1fd060a3ac4.tar.bz2
podman-9e7e91c13e32fc5897b336dbed8df1fd060a3ac4.zip
Merge pull request #13034 from rhatdan/docs
CI:DOCS: Unify podman prune filter description: volumes, networks, system
Diffstat (limited to 'docs/source/markdown')
-rw-r--r--docs/source/markdown/podman-container-prune.1.md6
-rw-r--r--docs/source/markdown/podman-image-prune.1.md5
-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
5 files changed, 38 insertions, 24 deletions
diff --git a/docs/source/markdown/podman-container-prune.1.md b/docs/source/markdown/podman-container-prune.1.md
index 6e4aa35ff..b20936c15 100644
--- a/docs/source/markdown/podman-container-prune.1.md
+++ b/docs/source/markdown/podman-container-prune.1.md
@@ -20,13 +20,13 @@ Supported filters:
| Filter | Description |
| :----------------: | --------------------------------------------------------------------------- |
-| *until* | Only remove containers created before given timestamp. |
| *label* | Only remove containers, 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.
+| *until* | Only remove containers created before given timestamp. |
The `label` *filter* accepts two formats. One is the `label`=*key* or `label`=*key*=*value*, which removes containers with the specified labels. The other format is the `label!`=*key* or `label!`=*key*=*value*, which removes containers without 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.
+
#### **--force**, **-f**
Do not provide an interactive prompt for container removal.\
diff --git a/docs/source/markdown/podman-image-prune.1.md b/docs/source/markdown/podman-image-prune.1.md
index 66edad207..db17f97fb 100644
--- a/docs/source/markdown/podman-image-prune.1.md
+++ b/docs/source/markdown/podman-image-prune.1.md
@@ -31,13 +31,14 @@ Supported filters:
| Filter | Description |
| :----------------: | --------------------------------------------------------------------------- |
-| *until* | Only remove images created before given timestamp. |
| *label* | Only remove images, with (or without, in the case of label!=[...] is used) the specified labels. |
+| *until* | Only remove images created before given timestamp. |
-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 containers with the specified labels. The other format is the `label!`=*key* or `label!`=*key*=*value*, which removes containers without 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.
+
#### **--force**, **-f**
Do not provide an interactive prompt for container removal.
diff --git a/docs/source/markdown/podman-network-prune.1.md b/docs/source/markdown/podman-network-prune.1.md
index d35decb1b..a1dc5d85c 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 |
+| :----------------: | --------------------------------------------------------------------------- |
+| *label* | Only remove networks, with (or without, in the case of label!=[...] is used) the specified labels. |
+| *until* | Only remove networks created before given timestamp. |
+
+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.
+
+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.
## 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..fb9ed44d6 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 |
+| :----------------: | --------------------------------------------------------------------------- |
+| *label* | Only remove containers and images, with (or without, in the case of label!=[...] is used) the specified labels. |
+| *until* | Only remove containers and images created before given timestamp. |
-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 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.
-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 `until` *filter* can be Unix timestamps, date formatted timestamps, or Go duration strings (e.g. 10m, 1h30m) computed relative to the machine’s time.
#### **--force**, **-f**
diff --git a/docs/source/markdown/podman-volume-prune.1.md b/docs/source/markdown/podman-volume-prune.1.md
index 012567957..2028e42f2 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 |
+| :----------------: | --------------------------------------------------------------------------- |
+| *label* | Only remove volumes, with (or without, in the case of label!=[...] is used) the specified labels. |
+| *until* | Only remove volumes created before given timestamp. |
+
+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.
+
+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.
#### **--help**