summaryrefslogtreecommitdiff
path: root/docs/source/markdown/podman-pod-ps.1.md
diff options
context:
space:
mode:
authorOpenShift Merge Robot <openshift-merge-robot@users.noreply.github.com>2020-11-18 21:16:21 +0100
committerGitHub <noreply@github.com>2020-11-18 21:16:21 +0100
commit4434bd797842c3015c0e6132eaf2509fed370c26 (patch)
tree07576e5d9c5b37f06a48bc027ce1c1d73852c8e7 /docs/source/markdown/podman-pod-ps.1.md
parent8672c4dea05366ae65c609a4d7f7d848d1cf04e0 (diff)
parente7fd9234cd0e6a23e32dd31c912ac47883b59738 (diff)
downloadpodman-4434bd797842c3015c0e6132eaf2509fed370c26.tar.gz
podman-4434bd797842c3015c0e6132eaf2509fed370c26.tar.bz2
podman-4434bd797842c3015c0e6132eaf2509fed370c26.zip
Merge pull request #8395 from Luap99/podman-pod-ps-filters
Align the podman pod ps --filter behavior with podman ps
Diffstat (limited to 'docs/source/markdown/podman-pod-ps.1.md')
-rw-r--r--docs/source/markdown/podman-pod-ps.1.md24
1 files changed, 14 insertions, 10 deletions
diff --git a/docs/source/markdown/podman-pod-ps.1.md b/docs/source/markdown/podman-pod-ps.1.md
index 94747cd10..e1d60d765 100644
--- a/docs/source/markdown/podman-pod-ps.1.md
+++ b/docs/source/markdown/podman-pod-ps.1.md
@@ -80,19 +80,23 @@ Default: created
#### **--filter**, **-f**=*filter*
-Filter output based on conditions given
+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 |
-| name | [Name] Pod's name |
-| label | [Key] or [Key=Value] Label assigned to a container |
-| ctr-names | Container name within the pod |
-| ctr-ids | Container ID within the pod |
-| ctr-status | Container status within the pod |
-| ctr-number | Number of containers in the pod |
+| **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 |
+| status | Pod's status: `stopped`, `running`, `paused`, `exited`, `dead`, `created`, `degraded` |
+| 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 |
#### **--help**, **-h**