aboutsummaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorPatrycja Guzik <patrycja.k.guzik@gmail.com>2022-02-15 23:54:45 +0100
committerPatrycja Guzik <patrycja.k.guzik@gmail.com>2022-02-15 23:54:45 +0100
commit10580ec1983b8946676d1eaddf733253ca99a392 (patch)
tree6efc67a7b52de80f7e9140c8df7b32adaf72a319 /docs
parent60b0acb7dc6b5bbe05a9556d80e33217b10dde9b (diff)
downloadpodman-10580ec1983b8946676d1eaddf733253ca99a392.tar.gz
podman-10580ec1983b8946676d1eaddf733253ca99a392.tar.bz2
podman-10580ec1983b8946676d1eaddf733253ca99a392.zip
Unify ls --filter docs for networks and pods
Signed-off-by: Patrycja Guzik <patrycja.k.guzik@gmail.com> #13078 follow-up
Diffstat (limited to 'docs')
-rw-r--r--docs/source/markdown/podman-network-ls.1.md34
-rw-r--r--docs/source/markdown/podman-pod-ps.1.md48
2 files changed, 49 insertions, 33 deletions
diff --git a/docs/source/markdown/podman-network-ls.1.md b/docs/source/markdown/podman-network-ls.1.md
index 72a3b05e2..d5bdb6a39 100644
--- a/docs/source/markdown/podman-network-ls.1.md
+++ b/docs/source/markdown/podman-network-ls.1.md
@@ -12,20 +12,26 @@ Displays a list of existing podman networks.
## OPTIONS
#### **--filter**, **-f**=*filter=value*
-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.
-
-Valid filters are listed below:
-
-| **Filter** | **Description** |
-| ---------- | ----------------------------------------------------------------- |
-| name | [Name] Network name (accepts regex) |
-| id | [ID] Full or partial network ID |
-| label | [Key] or [Key=Value] Label assigned to a network |
-| driver | [Driver] `bridge` or ,`macvlan` is supported |
-| until | [Until] Show all networks that were created before the given time |
+Provide filter values.
+
+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** |
+| ---------- | ------------------------------------------------------------------------------------------------ |
+| driver | Filter by driver type. |
+| id | Filter by full or partial network ID. |
+| label | Filter by network with (or without, in the case of label!=[...] is used) the specified labels. |
+| name | Filter by network name (accepts `regex`). |
+| until | Filter by networks created before given timestamp. |
+
+
+The `driver` filter accepts values: `bridge`, `macvlan`, `ipvlan`.
+
+The `label` *filter* accepts two formats. One is the `label`=*key* or `label`=*key*=*value*, which shows images with the specified labels. The other format is the `label!`=*key* or `label!`=*key*=*value*, which shows 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.
#### **--format**=*format*
diff --git a/docs/source/markdown/podman-pod-ps.1.md b/docs/source/markdown/podman-pod-ps.1.md
index a0581df50..8a9c3f7cc 100644
--- a/docs/source/markdown/podman-pod-ps.1.md
+++ b/docs/source/markdown/podman-pod-ps.1.md
@@ -86,25 +86,35 @@ Default: created
#### **--filter**, **-f**=*filter*
-Filter output based on conditions given.
-Multiple filters can be given with multiple uses of the --filter flag.
-Filters with the same key work inclusive with the only exception being
-`label` which is exclusive. Filters with different keys always work exclusive.
-
-Valid filters are listed below:
-
-| **Filter** | **Description** |
-| ---------- | ------------------------------------------------------------------------------------- |
-| id | [ID] Pod's ID (accepts regex) |
-| name | [Name] Pod's name (accepts regex) |
-| label | [Key] or [Key=Value] Label assigned to a container |
-| until | Only list pods created before given timestamp |
-| status | Pod's status: `stopped`, `running`, `paused`, `exited`, `dead`, `created`, `degraded` |
-| network | [Network] name or full ID of network |
-| ctr-names | Container name within the pod (accepts regex) |
-| ctr-ids | Container ID within the pod (accepts regex) |
-| ctr-status | Container status within the pod |
-| ctr-number | Number of containers in the pod |
+Provide filter values.
+
+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 |
+| ---------- | -------------------------------------------------------------------------------------------------- |
+| *ctr-ids* | Filter by container ID within the pod. |
+| *ctr-names* | Filter by container name within the pod. |
+| *ctr-number*| Filter by number of containers in the pod. |
+| *ctr-status*| Filter by container status within the pod. |
+| *id* | Filter by pod ID. |
+| *label* | Filter by container with (or without, in the case of label!=[...] is used) the specified labels. |
+| *name* | Filter by pod name. |
+| *network* | Filter by network name or full ID of network. |
+| *status* | Filter by pod status. |
+| *until* | Filter by pods created before given timestamp. |
+
+The `ctr-ids`, `ctr-names`, `id`, `name` filters accept `regex` format.
+
+The `ctr-status` filter accepts values: `created`, `running`, `paused`, `stopped`, `exited`, `unknown`.
+
+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.
+
+The `status` filter accepts values: `stopped`, `running`, `paused`, `exited`, `dead`, `created`, `degraded`.
+
#### **--help**, **-h**