mirror/podman
1
0
Fork 0
mirror of https://github.com/containers/podman.git synced 2026-07-13 08:41:44 -04:00
Code Issues Packages Projects Releases Wiki Activity

docs: Update filter options and add podman ps documentation

Browse Source 
Signed-off-by: MayorFaj <mayorfaj@gmail.com>
This commit is contained in:
MayorFaj
2025-12-06 10:44:47 +00:00
committed by Matt Heon
parent e70bfff716
commit faedb9c911
15 changed files with 12 additions and 146 deletions
Download Patch File Download Diff File Expand all files Collapse all files

1
docs/source/markdown/.gitignore vendored
View File

@@ -50,6 +50,7 @@ podman-pod-stats.1.md
podman-pod-stop.1.md
podman-pod-top.1.md
podman-port.1.md
podman-ps.1.md
podman-pull.1.md
podman-push.1.md
podman-restart.1.md

16
docs/source/markdown/options/filter.container-prune.md
View File

@@ -1,16 +0,0 @@
#### **--filter**=*filters*
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 |
|:------:|------------------------------------------------------------------------------------------------------|
| label | Only remove containers, with (or without, in the case of label!=[...] is used) the specified labels. |
| 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.

6
docs/source/markdown/options/filter.container.md
View File

@@ -1,5 +1,5 @@
####> This option file is used in:
####> podman pause, restart, start, stop, unpause
####> podman pause, ps, restart, rm, start, stop, unpause
####> If file is edited, make sure the changes
####> are applicable to all of those.
#### **--filter**, **-f**=*filter*
@@ -19,7 +19,7 @@ Valid filters are listed below:
| label! | [Key] or [Key=Value] Label NOT assigned to a container |
| exited | [Int] Container's exit code |
| status | [Status] Container's status: 'created', 'initialized', 'exited', 'paused', 'running', 'unknown' |
| ancestor | [ImageName] Image or descendant used to create container |
| ancestor | [ImageName] Image or descendant used to create container (accepts regex) |
| before | [ID] or [Name] Containers created before this container |
| since | [ID] or [Name] Containers created since this container |
| volume | [VolumeName] or [MountpointDestination] Volume mounted in container |
@@ -28,5 +28,5 @@ Valid filters are listed below:
| network | [Network] name or full ID of network |
| restart-policy | [Policy] Container's restart policy (e.g., 'no', 'on-failure', 'always', 'unless-stopped') |
| until | [DateTime] Containers created before the given duration or time. |
| command | [Command] the command the container is executing, only argv[0] is taken |
| command | [Command] the command the container is executing, only argv[0] is taken |
| should-start-on-boot | [Bool] Containers that need to be restarted after system reboot. True for containers with restart policy 'always', or 'unless-stopped' that were not explicitly stopped by the user |

1
docs/source/markdown/options/filter.events.md
View File

@@ -10,4 +10,5 @@ filters are supported:
| image | [Name or ID] Image name or ID |
| label | [key] or [key=value] label |
| pod | [Name or ID] Pod name or ID |
| type | Event type (e.g., container, image, pod, volume, network) |
| volume | [Name or ID] Volume name or ID |

17
docs/source/markdown/options/filter.image-prune.md
View File

@@ -1,17 +0,0 @@
#### **--filter**=*filters*
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 |
|:------:|--------------------------------------------------------------------------------------------------|
| 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 `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.

2
docs/source/markdown/options/filter.network-ls.md
View File

@@ -22,7 +22,7 @@ Supported filters:
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 `label` *filter* accepts two formats. One is the `label`=*key* or `label`=*key*=*value*, which shows networks with the specified labels. The other format is the `label!`=*key* or `label!`=*key*=*value*, which shows 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.

2
docs/source/markdown/options/filter.network-prune.md
View File

@@ -1,4 +1,4 @@
#### **--filter**
#### **--filter**=*filters*
Provide filter values.

28
docs/source/markdown/options/filter.ps.md
View File

@@ -1,28 +0,0 @@
#### **--filter**, **-f**
Filter what containers are shown in the output.
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] Container's ID (CID prefix match by default; accepts regex) |
| name | [Name] Container's name (accepts regex) |
| label | [Key] or [Key=Value] Label assigned to a container |
| label! | [Key] or [Key=Value] Label NOT assigned to a container |
| exited | [Int] Container's exit code |
| status | [Status] Container's status: 'created', 'initialized', 'exited', 'paused', 'running', 'unknown' |
| ancestor | [ImageName] Image or descendant used to create container (accepts regex) |
| before | [ID] or [Name] Containers created before this container |
| since | [ID] or [Name] Containers created since this container |
| volume | [VolumeName] or [MountpointDestination] Volume mounted in container |
| health | [Status] healthy or unhealthy |
| pod | [Pod] name or full or partial ID of pod |
| network | [Network] name or full ID of network |
| until | [DateTime] container created before the given duration or time. |
| command | [Command] the command the container is executing, only argv[0] is taken |
| restart-policy | [Policy] Container's restart policy (e.g., 'no', 'on-failure', 'always', 'unless-stopped') |
| should-start-on-boot | [Bool] Containers that need to be restarted after system reboot. True for containers with restart policy 'always', or 'unless-stopped' that were not explicitly stopped by the user |

2
docs/source/markdown/options/filter.quadlet-list.md
View File

@@ -1,6 +1,6 @@
#### **--filter**, **-f**=*filter*
Filter output based on conditions give.
Filter output based on conditions given.
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*.

32
docs/source/markdown/options/filter.rm.md
View File

@@ -1,32 +0,0 @@
####> This option file is used in:
####> podman rm
####> If file is edited, make sure the changes
####> are applicable to all of those.
#### **--filter**=*filter*
Filter what containers remove.
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] Container's ID (CID prefix match by default; accepts regex) |
| name | [Name] Container's name (accepts regex) |
| label | [Key] or [Key=Value] Label assigned to a container |
| label! | [Key] or [Key=Value] Label NOT assigned to a container |
| exited | [Int] Container's exit code |
| status | [Status] Container's status: 'created', 'initialized', 'exited', 'paused', 'running', 'unknown' |
| ancestor | [ImageName] Image or descendant used to create container |
| before | [ID] or [Name] Containers created before this container |
| since | [ID] or [Name] Containers created since this container |
| volume | [VolumeName] or [MountpointDestination] Volume mounted in container |
| health | [Status] healthy or unhealthy |
| pod | [Pod] name or full or partial ID of pod |
| network | [Network] name or full ID of network |
| restart-policy | [Policy] Container's restart policy (e.g., 'no', 'on-failure', 'always', 'unless-stopped') |
| until | [DateTime] Containers created before the given duration or time. |
| command | [Command] the command the container is executing, only argv[0] is taken |
| should-start-on-boot | [Bool] Containers that need to be restarted after system reboot. True for containers with restart policy 'always', or 'unless-stopped' that were not explicitly stopped by the user |

16
docs/source/markdown/options/filter.system-prune.md
View File

@@ -1,16 +0,0 @@
#### **--filter**=*filters*
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 |
|:------:|-----------------------------------------------------------------------------------------------------------------|
| 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 `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 `until` *filter* can be Unix timestamps, date formatted timestamps, or Go duration strings (e.g. 10m, 1h30m) computed relative to the machine's time.

2
docs/source/markdown/options/filter.volume-ls.md
View File

@@ -20,4 +20,4 @@ Volumes can be filtered by the following attributes:
| opt | Matches a storage driver options |
| scope | Filters volume by scope |
| after/since | Filter by volumes created after the given VOLUME (name or tag) |
| until | Only remove volumes created before given timestamp |
| until | Filter by volumes created before given timestamp |

2
docs/source/markdown/options/filter.volume-prune.md
View File

@@ -1,4 +1,4 @@
#### **--filter**
#### **--filter**=*filters*
Provide filter values.

29
docs/source/markdown/podman-ps.1.md → docs/source/markdown/podman-ps.1.md.in
View File

@@ -36,34 +36,7 @@ Note: Podman shares containers storage with other tools such as Buildah and CRI-
Display external containers that are not controlled by Podman but are stored in containers storage. These external containers are generally created via other container technology such as Buildah or CRI-O and may depend on the same container images that Podman is also using. External containers are denoted with either a 'buildah' or 'storage' in the COMMAND and STATUS column of the ps output.
#### **--filter**, **-f**
Filter what containers are shown in the output.
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] Container's ID (CID prefix match by default; accepts regex) |
| name | [Name] Container's name (accepts regex) |
| label | [Key] or [Key=Value] Label assigned to a container |
| label! | [Key] or [Key=Value] Label NOT assigned to a container |
| exited | [Int] Container's exit code |
| status | [Status] Container's status: 'created', 'initialized', 'exited', 'paused', 'running', 'unknown' |
| ancestor | [ImageName] Image or descendant used to create container (accepts regex) |
| before | [ID] or [Name] Containers created before this container |
| since | [ID] or [Name] Containers created since this container |
| volume | [VolumeName] or [MountpointDestination] Volume mounted in container |
| health | [Status] healthy or unhealthy |
| pod | [Pod] name or full or partial ID of pod |
| network | [Network] name or full ID of network |
| until | [DateTime] container created before the given duration or time. |
| command | [Command] the command the container is executing, only argv[0] is taken |
| restart-policy | [Policy] Container's restart policy (e.g., 'no', 'on-failure', 'always', 'unless-stopped') |
| should-start-on-boot | [Bool] Containers that need to be restarted after system reboot. True for containers with restart policy 'always', or 'unless-stopped' that were not explicitly stopped by the user |
@@option filter.container
#### **--format**=*format*

2
docs/source/markdown/podman-rm.1.md.in
View File

@@ -26,7 +26,7 @@ Command does not fail when *file* is missing and user specified --ignore.
Remove selected container and recursively remove all containers that depend on it.
@@option filter.rm
@@option filter.container
#### **--force**, **-f**