From e70bfff7162d975e0438816045fca2aa58eb9c1d Mon Sep 17 00:00:00 2001 From: MayorFaj Date: Fri, 5 Dec 2025 00:36:53 +0000 Subject: [PATCH] docs: Deduplicate --filter descriptions Signed-off-by: MayorFaj --- .../options/filter.container-prune.md | 16 +++++++ .../markdown/options/filter.container.md | 32 +++++++++++++ docs/source/markdown/options/filter.events.md | 13 +++++ .../markdown/options/filter.image-prune.md | 17 +++++++ docs/source/markdown/options/filter.images.md | 48 +++++++++++++++++++ .../markdown/options/filter.network-ls.md | 29 +++++++++++ .../markdown/options/filter.network-prune.md | 16 +++++++ docs/source/markdown/options/filter.pod-ps.md | 34 +++++++++++++ docs/source/markdown/options/filter.ps.md | 28 +++++++++++ .../markdown/options/filter.quadlet-list.md | 11 +++++ docs/source/markdown/options/filter.rm.md | 32 +++++++++++++ docs/source/markdown/options/filter.search.md | 13 +++++ .../markdown/options/filter.secret-ls.md | 15 ++++++ .../markdown/options/filter.system-prune.md | 16 +++++++ .../markdown/options/filter.volume-ls.md | 23 +++++++++ .../markdown/options/filter.volume-prune.md | 22 +++++++++ docs/source/markdown/podman-images.1.md.in | 35 +------------- .../source/markdown/podman-network-ls.1.md.in | 26 +--------- docs/source/markdown/podman-pause.1.md.in | 29 +---------- docs/source/markdown/podman-pod-ps.1.md.in | 31 +----------- docs/source/markdown/podman-ps.1.md | 2 +- docs/source/markdown/podman-restart.1.md.in | 29 +---------- docs/source/markdown/podman-rm.1.md.in | 29 +---------- docs/source/markdown/podman-search.1.md.in | 10 +--- docs/source/markdown/podman-secret-ls.1.md.in | 12 +---- docs/source/markdown/podman-start.1.md.in | 29 +---------- docs/source/markdown/podman-stop.1.md.in | 29 +---------- docs/source/markdown/podman-unpause.1.md.in | 29 +---------- docs/source/markdown/podman-volume-ls.1.md.in | 20 +------- 29 files changed, 378 insertions(+), 297 deletions(-) create mode 100644 docs/source/markdown/options/filter.container-prune.md create mode 100644 docs/source/markdown/options/filter.container.md create mode 100644 docs/source/markdown/options/filter.events.md create mode 100644 docs/source/markdown/options/filter.image-prune.md create mode 100644 docs/source/markdown/options/filter.images.md create mode 100644 docs/source/markdown/options/filter.network-ls.md create mode 100644 docs/source/markdown/options/filter.network-prune.md create mode 100644 docs/source/markdown/options/filter.pod-ps.md create mode 100644 docs/source/markdown/options/filter.ps.md create mode 100644 docs/source/markdown/options/filter.quadlet-list.md create mode 100644 docs/source/markdown/options/filter.rm.md create mode 100644 docs/source/markdown/options/filter.search.md create mode 100644 docs/source/markdown/options/filter.secret-ls.md create mode 100644 docs/source/markdown/options/filter.system-prune.md create mode 100644 docs/source/markdown/options/filter.volume-ls.md create mode 100644 docs/source/markdown/options/filter.volume-prune.md diff --git a/docs/source/markdown/options/filter.container-prune.md b/docs/source/markdown/options/filter.container-prune.md new file mode 100644 index 0000000000..66be3c548f --- /dev/null +++ b/docs/source/markdown/options/filter.container-prune.md @@ -0,0 +1,16 @@ +#### **--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. diff --git a/docs/source/markdown/options/filter.container.md b/docs/source/markdown/options/filter.container.md new file mode 100644 index 0000000000..5085f7bab7 --- /dev/null +++ b/docs/source/markdown/options/filter.container.md @@ -0,0 +1,32 @@ +####> This option file is used in: +####> podman pause, restart, start, stop, unpause +####> If file is edited, make sure the changes +####> are applicable to all of those. +#### **--filter**, **-f**=*filter* + +Filter what containers <>. +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 | diff --git a/docs/source/markdown/options/filter.events.md b/docs/source/markdown/options/filter.events.md new file mode 100644 index 0000000000..e695e6c613 --- /dev/null +++ b/docs/source/markdown/options/filter.events.md @@ -0,0 +1,13 @@ +#### **--filter**, **-f**=*filter* + +Filter events that are displayed. They must be in the format of "filter=value". The following +filters are supported: + +| **Filter** | **Description** | +|------------|-------------------------------------| +| container | [Name or ID] Container's name or ID | +| event | event_status (described above) | +| image | [Name or ID] Image name or ID | +| label | [key] or [key=value] label | +| pod | [Name or ID] Pod name or ID | +| volume | [Name or ID] Volume name or ID | diff --git a/docs/source/markdown/options/filter.image-prune.md b/docs/source/markdown/options/filter.image-prune.md new file mode 100644 index 0000000000..c572f15bcb --- /dev/null +++ b/docs/source/markdown/options/filter.image-prune.md @@ -0,0 +1,17 @@ +#### **--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. diff --git a/docs/source/markdown/options/filter.images.md b/docs/source/markdown/options/filter.images.md new file mode 100644 index 0000000000..15f988f9c6 --- /dev/null +++ b/docs/source/markdown/options/filter.images.md @@ -0,0 +1,48 @@ +####> This option file is used in: +####> podman images +####> If file is edited, make sure the changes +####> are applicable to all of those. +#### **--filter**, **-f**=*filter* + +Provide filter values. + +The *filters* argument format is of `key=value` or `key!=value`. If there is more than one *filter*, then pass multiple OPTIONS: **--filter** *foo=bar* **--filter** *bif=baz*. + +Supported filters: + +| Filter | Description | +|:------------:|-----------------------------------------------------------------------------------------------| +| id | Filter by image ID. | +| before | Filter by images created before the given IMAGE (name or tag). | +| containers | Filter by images with a running container. | +| dangling | Filter by dangling (unused) images. | +| digest | Filter by digest. | +| intermediate | Filter by images that are dangling and have no children | +| label | Filter by images with (or without, in the case of label!=[...] is used) the specified labels. | +| manifest | Filter by images that are manifest lists. | +| readonly | Filter by read-only or read/write images. | +| reference | Filter by image name. | +| after/since | Filter by images created after the given IMAGE (name or tag). | +| until | Filter by images created until the given duration or time. | + +The `id` *filter* accepts the image ID string. + +The `before` *filter* accepts formats: `[:]`, `` or ``. + +The `containers` *filter* shows images that have a running container based on that image. + +The `dangling` *filter* shows images that are taking up disk space and serve no purpose. Dangling image is a file system layer that was used in a previous build of an image and is no longer referenced by any image. They are denoted with the `` tag, consume disk space and serve no active purpose. + +The `digest` *filter* accepts the image digest string. + +The `intermediate` *filter* shows images that are dangling and have no children. + +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 `readonly` *filter* accepts `true` or `false`. + +The `reference` *filter* accepts regex expressions like `image:.*-alpine`. + +The `after/since` *filter* accepts formats: `[:]`, `` or ``. + +The `until` *filter* shows images created before the given date/time. The `` can be Unix timestamps, date formatted timestamps (e.g. `2020-12-31`, `2021-01-01T10:00:00`), or Go duration strings (e.g. `10m`, `1h30m`). diff --git a/docs/source/markdown/options/filter.network-ls.md b/docs/source/markdown/options/filter.network-ls.md new file mode 100644 index 0000000000..09f1c2af48 --- /dev/null +++ b/docs/source/markdown/options/filter.network-ls.md @@ -0,0 +1,29 @@ +####> This option file is used in: +####> podman network ls +####> If file is edited, make sure the changes +####> are applicable to all of those. +#### **--filter**, **-f**=*filter=value* + +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. | +| dangling | Filter by networks with no containers attached. | + + +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. + +The `dangling` *filter* accepts values `true` or `false`. diff --git a/docs/source/markdown/options/filter.network-prune.md b/docs/source/markdown/options/filter.network-prune.md new file mode 100644 index 0000000000..d98e043eb3 --- /dev/null +++ b/docs/source/markdown/options/filter.network-prune.md @@ -0,0 +1,16 @@ +#### **--filter** + +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 networks with (or without, in case label!=[...] is used) 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. diff --git a/docs/source/markdown/options/filter.pod-ps.md b/docs/source/markdown/options/filter.pod-ps.md new file mode 100644 index 0000000000..b08e6190bc --- /dev/null +++ b/docs/source/markdown/options/filter.pod-ps.md @@ -0,0 +1,34 @@ +####> This option file is used in: +####> podman pod ps +####> If file is edited, make sure the changes +####> are applicable to all of those. +#### **--filter**, **-f**=*filter* + +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. (CID prefix match by default; accepts regex) | +| 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. (Prefix match by default; accepts regex) | +| 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`. diff --git a/docs/source/markdown/options/filter.ps.md b/docs/source/markdown/options/filter.ps.md new file mode 100644 index 0000000000..5c69c6004e --- /dev/null +++ b/docs/source/markdown/options/filter.ps.md @@ -0,0 +1,28 @@ +#### **--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 | diff --git a/docs/source/markdown/options/filter.quadlet-list.md b/docs/source/markdown/options/filter.quadlet-list.md new file mode 100644 index 0000000000..fe17974db0 --- /dev/null +++ b/docs/source/markdown/options/filter.quadlet-list.md @@ -0,0 +1,11 @@ +#### **--filter**, **-f**=*filter* + +Filter output based on conditions give. + +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 | +|------------|--------------------------------------------------------------------------------------------------| +| name | Filter by quadlet name. | diff --git a/docs/source/markdown/options/filter.rm.md b/docs/source/markdown/options/filter.rm.md new file mode 100644 index 0000000000..3e5d88f118 --- /dev/null +++ b/docs/source/markdown/options/filter.rm.md @@ -0,0 +1,32 @@ +####> 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 | diff --git a/docs/source/markdown/options/filter.search.md b/docs/source/markdown/options/filter.search.md new file mode 100644 index 0000000000..2ffc4ee57f --- /dev/null +++ b/docs/source/markdown/options/filter.search.md @@ -0,0 +1,13 @@ +####> This option file is used in: +####> podman search +####> If file is edited, make sure the changes +####> are applicable to all of those. +#### **--filter**, **-f**=*filter* + +Filter output based on conditions provided (default []) + +Supported filters are: + +* stars (int) - minimum number of stars required for images to show +* is-automated (boolean - true | false) - is the image automated or not +* is-official (boolean - true | false) - is the image official or not diff --git a/docs/source/markdown/options/filter.secret-ls.md b/docs/source/markdown/options/filter.secret-ls.md new file mode 100644 index 0000000000..eef9525624 --- /dev/null +++ b/docs/source/markdown/options/filter.secret-ls.md @@ -0,0 +1,15 @@ +####> This option file is used in: +####> podman secret ls +####> If file is edited, make sure the changes +####> are applicable to all of those. +#### **--filter**, **-f**=*filter=value* + +Filter output based on conditions given. +Multiple filters can be given with multiple uses of the --filter option. + +Valid filters are listed below: + +| **Filter** | **Description** | +| ---------- | ----------------------------------------------------------------- | +| name | [Name] Secret name (accepts regex) | +| id | [ID] Full or partial secret ID | diff --git a/docs/source/markdown/options/filter.system-prune.md b/docs/source/markdown/options/filter.system-prune.md new file mode 100644 index 0000000000..f3d8942a67 --- /dev/null +++ b/docs/source/markdown/options/filter.system-prune.md @@ -0,0 +1,16 @@ +#### **--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. diff --git a/docs/source/markdown/options/filter.volume-ls.md b/docs/source/markdown/options/filter.volume-ls.md new file mode 100644 index 0000000000..acce3db6a6 --- /dev/null +++ b/docs/source/markdown/options/filter.volume-ls.md @@ -0,0 +1,23 @@ +####> This option file is used in: +####> podman volume ls +####> If file is edited, make sure the changes +####> are applicable to all of those. +#### **--filter**, **-f**=*filter* + +Filter what volumes 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. + +Volumes can be filtered by the following attributes: + +| **Filter** | **Description** | +| ---------- | ------------------------------------------------------------------------------------- | +| dangling | [Dangling] Matches all volumes not referenced by any containers | +| driver | [Driver] Matches volumes based on their driver | +| label | [Key] or [Key=Value] Label assigned to a volume | +| name | [Name] Volume name (accepts regex) | +| 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 | diff --git a/docs/source/markdown/options/filter.volume-prune.md b/docs/source/markdown/options/filter.volume-prune.md new file mode 100644 index 0000000000..30795cd3e9 --- /dev/null +++ b/docs/source/markdown/options/filter.volume-prune.md @@ -0,0 +1,22 @@ +#### **--filter** + +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 | +|:-----------:|------------------------------------------------------------------------------------------------------------| +| dangling | [Bool] Only remove volumes not referenced by any containers | +| driver | [String] Only remove volumes with the given driver | +| label | [String] Only remove volumes, with (or without, in the case of label!=[...] is used) the specified labels. | +| name | [String] Only remove volume with the given name | +| opt | [String] Only remove volumes created with the given options | +| scope | [String] Only remove volumes with the given scope | +| until | [DateTime] Only remove volumes created before given timestamp. | +| after/since | [Volume] Filter by volumes created after the given VOLUME (name or tag) | + +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. diff --git a/docs/source/markdown/podman-images.1.md.in b/docs/source/markdown/podman-images.1.md.in index 2072d84741..b04ce306c0 100644 --- a/docs/source/markdown/podman-images.1.md.in +++ b/docs/source/markdown/podman-images.1.md.in @@ -23,40 +23,7 @@ Show all images (by default filter out the intermediate image layers). The defau Show image digests -#### **--filter**, **-f**=*filter* - -Provide filter values. - -The *filters* argument format is of `key=value` or `key!=value`. If there is more than one *filter*, then pass multiple OPTIONS: **--filter** *foo=bar* **--filter** *bif=baz*. - -Supported filters: - -| Filter | Description | -|:------------:|-----------------------------------------------------------------------------------------------| -| id | Filter by image ID. | -| before | Filter by images created before the given IMAGE (name or tag). | -| containers | Filter by images with a running container. | -| dangling | Filter by dangling (unused) images. | -| digest | Filter by digest. | -| intermediate | Filter by images that are dangling and have no children | -| label | Filter by images with (or without, in the case of label!=[...] is used) the specified labels. | -| manifest | Filter by images that are manifest lists. | -| readonly | Filter by read-only or read/write images. | -| reference | Filter by image name. | -| after/since | Filter by images created after the given IMAGE (name or tag). | -| until | Filter by images created until the given duration or time. | - -The `id` *filter* accepts the image ID string. - -The `before` *filter* accepts formats: `[:]`, `` or ``. - -The `containers` *filter* shows images that have a running container based on that image. - -The `dangling` *filter* shows images that are taking up disk space and serve no purpose. Dangling image is a file system layer that was used in a previous build of an image and is no longer referenced by any image. They are denoted with the `` tag, consume disk space and serve no active purpose. - -The `digest` *filter* accepts the image digest string. - -The `intermediate` *filter* shows images that are dangling and have no children. +@@option filter.images 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. diff --git a/docs/source/markdown/podman-network-ls.1.md.in b/docs/source/markdown/podman-network-ls.1.md.in index 1187bea4c7..e1fe52a1d7 100644 --- a/docs/source/markdown/podman-network-ls.1.md.in +++ b/docs/source/markdown/podman-network-ls.1.md.in @@ -10,31 +10,7 @@ podman\-network\-ls - Display a summary of networks Displays a list of existing podman networks. ## OPTIONS -#### **--filter**, **-f**=*filter=value* - -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. | -| dangling | Filter by networks with no containers attached. | - - -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. - -The `dangling` *filter* accepts values `true` or `false`. +@@option filter.network-ls #### **--format**=*format* diff --git a/docs/source/markdown/podman-pause.1.md.in b/docs/source/markdown/podman-pause.1.md.in index 3cec850fed..e5d1bd6229 100644 --- a/docs/source/markdown/podman-pause.1.md.in +++ b/docs/source/markdown/podman-pause.1.md.in @@ -19,34 +19,7 @@ Pause all running containers. @@option cidfile.read -#### **--filter**, **-f**=*filter* - -Filter what containers pause. -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 | +@@option filter.container @@option latest diff --git a/docs/source/markdown/podman-pod-ps.1.md.in b/docs/source/markdown/podman-pod-ps.1.md.in index 86aee9265b..d7281b2bde 100644 --- a/docs/source/markdown/podman-pod-ps.1.md.in +++ b/docs/source/markdown/podman-pod-ps.1.md.in @@ -40,36 +40,7 @@ Display the container names Display the container statuses -#### **--filter**, **-f**=*filter* - -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. (CID prefix match by default; accepts regex) | -| 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. (Prefix match by default; accepts regex) | -| 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`. +@@option filter.pod-ps #### **--format**=*format* diff --git a/docs/source/markdown/podman-ps.1.md b/docs/source/markdown/podman-ps.1.md index 95d62a78cf..0b3d372509 100644 --- a/docs/source/markdown/podman-ps.1.md +++ b/docs/source/markdown/podman-ps.1.md @@ -61,7 +61,7 @@ Valid filters are listed below: | 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 | +| 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 | diff --git a/docs/source/markdown/podman-restart.1.md.in b/docs/source/markdown/podman-restart.1.md.in index 7f315a0ef5..df2a8cfbc9 100644 --- a/docs/source/markdown/podman-restart.1.md.in +++ b/docs/source/markdown/podman-restart.1.md.in @@ -22,34 +22,7 @@ Restart all containers regardless of their current state. Read container ID from the specified file and restart the container. Can be specified multiple times. -#### **--filter**, **-f**=*filter* - -Filter what containers restart. -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 | +@@option filter.container @@option latest diff --git a/docs/source/markdown/podman-rm.1.md.in b/docs/source/markdown/podman-rm.1.md.in index 209bf9d12b..d72661f630 100644 --- a/docs/source/markdown/podman-rm.1.md.in +++ b/docs/source/markdown/podman-rm.1.md.in @@ -26,34 +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. -#### **--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 | +@@option filter.rm #### **--force**, **-f** diff --git a/docs/source/markdown/podman-search.1.md.in b/docs/source/markdown/podman-search.1.md.in index f999e6f728..3c7d45401c 100644 --- a/docs/source/markdown/podman-search.1.md.in +++ b/docs/source/markdown/podman-search.1.md.in @@ -41,15 +41,7 @@ Podman does not show these descriptors by default since they are not supported b @@option creds -#### **--filter**, **-f**=*filter* - -Filter output based on conditions provided (default []) - -Supported filters are: - -* stars (int) - minimum number of stars required for images to show -* is-automated (boolean - true | false) - is the image automated or not -* is-official (boolean - true | false) - is the image official or not +@@option filter.search #### **--format**=*format* diff --git a/docs/source/markdown/podman-secret-ls.1.md.in b/docs/source/markdown/podman-secret-ls.1.md.in index f6c5dfa395..f7c8db67d9 100644 --- a/docs/source/markdown/podman-secret-ls.1.md.in +++ b/docs/source/markdown/podman-secret-ls.1.md.in @@ -12,17 +12,7 @@ Lists all the secrets that exist. The output can be formatted to a Go template u ## OPTIONS -#### **--filter**, **-f**=*filter=value* - -Filter output based on conditions given. -Multiple filters can be given with multiple uses of the --filter option. - -Valid filters are listed below: - -| **Filter** | **Description** | -| ---------- | ----------------------------------------------------------------- | -| name | [Name] Secret name (accepts regex) | -| id | [ID] Full or partial secret ID | +@@option filter.secret-ls #### **--format**=*format* diff --git a/docs/source/markdown/podman-start.1.md.in b/docs/source/markdown/podman-start.1.md.in index 522636a933..1eab3d629d 100644 --- a/docs/source/markdown/podman-start.1.md.in +++ b/docs/source/markdown/podman-start.1.md.in @@ -27,34 +27,7 @@ starting multiple containers. @@option detach-keys -#### **--filter**, **-f**=*filter* - -Filter what containers are going to be started from the given arguments. -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 | +@@option filter.container @@option interactive diff --git a/docs/source/markdown/podman-stop.1.md.in b/docs/source/markdown/podman-stop.1.md.in index 86d5dd720d..e8a2a3aaa8 100644 --- a/docs/source/markdown/podman-stop.1.md.in +++ b/docs/source/markdown/podman-stop.1.md.in @@ -25,34 +25,7 @@ Stop all running containers. This does not include paused containers. Command does not fail when *file* is missing and user specified --ignore. -#### **--filter**, **-f**=*filter* - -Filter what containers are going to be stopped. -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 | +@@option filter.container @@option ignore diff --git a/docs/source/markdown/podman-unpause.1.md.in b/docs/source/markdown/podman-unpause.1.md.in index 89fbb2df89..6c08072313 100644 --- a/docs/source/markdown/podman-unpause.1.md.in +++ b/docs/source/markdown/podman-unpause.1.md.in @@ -19,34 +19,7 @@ Unpause all paused containers. @@option cidfile.read -#### **--filter**, **-f**=*filter* - -Filter what containers unpause. -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 | +@@option filter.container @@option latest diff --git a/docs/source/markdown/podman-volume-ls.1.md.in b/docs/source/markdown/podman-volume-ls.1.md.in index 64e84b518e..317c074aa4 100644 --- a/docs/source/markdown/podman-volume-ls.1.md.in +++ b/docs/source/markdown/podman-volume-ls.1.md.in @@ -14,25 +14,7 @@ flag. Use the **--quiet** flag to print only the volume names. ## OPTIONS -#### **--filter**, **-f**=*filter* - -Filter what volumes 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. - -Volumes can be filtered by the following attributes: - -| **Filter** | **Description** | -| ---------- | ------------------------------------------------------------------------------------- | -| dangling | [Dangling] Matches all volumes not referenced by any containers | -| driver | [Driver] Matches volumes based on their driver | -| label | [Key] or [Key=Value] Label assigned to a volume | -| name | [Name] Volume name (accepts regex) | -| 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 | +@@option filter.volume-ls #### **--format**=*format*