summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorOpenShift Merge Robot <openshift-merge-robot@users.noreply.github.com>2022-01-31 07:06:32 -0500
committerGitHub <noreply@github.com>2022-01-31 07:06:32 -0500
commitcb0f31624ce5a04af5958e386b5256c86784ad54 (patch)
tree41c7d11cd4fbe9684bef0c7458cf6ad4c0f2cf49
parentc2f4747fea508a6c6b0fdbf7a51eb6c80ba57f02 (diff)
parenta8fb8f52c7d6fd9629f3d1c9104a0333884090b1 (diff)
downloadpodman-cb0f31624ce5a04af5958e386b5256c86784ad54.tar.gz
podman-cb0f31624ce5a04af5958e386b5256c86784ad54.tar.bz2
podman-cb0f31624ce5a04af5958e386b5256c86784ad54.zip
Merge pull request #13078 from patrycja-guzik/podman-image-ls-filters
[CI:DOCS] Adapt podman images ls filters docs to be aligned with prune filters docs
-rw-r--r--docs/source/markdown/podman-images.1.md33
1 files changed, 19 insertions, 14 deletions
diff --git a/docs/source/markdown/podman-images.1.md b/docs/source/markdown/podman-images.1.md
index 8db291fb4..f1d9d4816 100644
--- a/docs/source/markdown/podman-images.1.md
+++ b/docs/source/markdown/podman-images.1.md
@@ -25,27 +25,32 @@ Show image digests
#### **--filter**=*filter*, **-f**
-Filter output based on conditions provided
+Provide filter values.
- Filters:
+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*.
- **since=IMAGE**
- Filter on images created after the given IMAGE (name or tag).
+Supported filters:
- **before=IMAGE**
- Filter on images created before the given IMAGE (name or tag).
+| Filter | Description |
+| :----------------: | --------------------------------------------------------------------------------------------- |
+| *before* | Filter by images created before the given IMAGE (name or tag). |
+| *dangling* | Filter by dangling (unused) images. |
+| *label* | Filter by images with (or without, in the case of label!=[...] is used) the specified labels. |
+| *readonly* | Filter by read-only or read/write images. |
+| *reference* | Filter by image name. |
+| *since* | Filter by images created after the given IMAGE (name or tag). |
- **dangling
- Show dangling images. Dangling images are 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 `<none>` tag, consume disk space and serve no active purpose.
+The `before` *filter* accepts formats: `<image-name>[:<tag>]`, `<image id>` or `<image@digest>`.
- **label**
- Filter by images labels key and/or value.
+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 `<none>` tag, consume disk space and serve no active purpose.
- **readonly
- Show only read only images or Read/Write images. The default is to show both. Read/Only images can be configured by modifying the "additionalimagestores" in the /etc/containers/storage.conf file.
+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.
- **reference=**
- Filter by image name, specified as regular expressions.
+The `readonly` *filter* shows, as a default, both read-only and read/write images. Read-only images can be configured by modifying the `additionalimagestores` in the `/etc/containers/storage.conf` file.
+
+The `reference` *filter* accepts the pattern of an image reference `<image-name>[:<tag>]`.
+
+The `since` *filter* accepts formats: `<image-name>[:<tag>]`, `<image id>` or `<image@digest>`.
#### **--format**=*format*