aboutsummaryrefslogtreecommitdiff
path: root/docs/source
diff options
context:
space:
mode:
authorPaul Holzinger <paul.holzinger@web.de>2020-11-18 11:23:30 +0100
committerPaul Holzinger <paul.holzinger@web.de>2020-11-18 19:31:25 +0100
commite7fd9234cd0e6a23e32dd31c912ac47883b59738 (patch)
tree7befe4ca3c1e47c52aec7eaaec26204d729ae849 /docs/source
parent6ece1d97c428f1641cb35972357cd037562fd06e (diff)
downloadpodman-e7fd9234cd0e6a23e32dd31c912ac47883b59738.tar.gz
podman-e7fd9234cd0e6a23e32dd31c912ac47883b59738.tar.bz2
podman-e7fd9234cd0e6a23e32dd31c912ac47883b59738.zip
Align the podman pod ps --filter behavior with podman ps
Filters with the same key work inclusive with the only exception being `label` which is exclusive. Filters with different keys always work exclusive. Also update the documentation with the new behavior. Signed-off-by: Paul Holzinger <paul.holzinger@web.de>
Diffstat (limited to 'docs/source')
-rw-r--r--docs/source/markdown/podman-pod-ps.1.md24
-rw-r--r--docs/source/markdown/podman-ps.1.md8
2 files changed, 18 insertions, 14 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**
diff --git a/docs/source/markdown/podman-ps.1.md b/docs/source/markdown/podman-ps.1.md
index 5869f2307..f542daf4c 100644
--- a/docs/source/markdown/podman-ps.1.md
+++ b/docs/source/markdown/podman-ps.1.md
@@ -44,15 +44,15 @@ Display external containers that are not controlled by Podman but are stored in
Filter what containers are shown in the output.
Multiple filters can be given with multiple uses of the --filter flag.
-If multiple filters are given, only containers which match all of the given filters will be shown.
-Results will be drawn from all containers, regardless of whether --all was given.
+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] Container's ID |
-| name | [Name] Container's name |
+| id | [ID] Container's ID (accepts regex) |
+| name | [Name] Container's name (accepts regex) |
| label | [Key] or [Key=Value] Label assigned to a container |
| exited | [Int] Container's exit code |
| status | [Status] Container's status: 'created', 'exited', 'paused', 'running', 'unknown' |