summaryrefslogtreecommitdiff
path: root/docs/source/markdown
diff options
context:
space:
mode:
authorrvandernoort <s.r.vandernoort@student.tudelft.nl>2022-03-23 13:06:53 +0100
committerrvandernoort <s.r.vandernoort@student.tudelft.nl>2022-03-27 12:59:22 +0200
commitab41037c8712c3552e147476000a7f16e5c64b18 (patch)
treece374e01167a5f74f6b10b3d726c6a3022f86a99 /docs/source/markdown
parent9d8972e0ee665325a2519eb168423d773856d563 (diff)
downloadpodman-ab41037c8712c3552e147476000a7f16e5c64b18.tar.gz
podman-ab41037c8712c3552e147476000a7f16e5c64b18.tar.bz2
podman-ab41037c8712c3552e147476000a7f16e5c64b18.zip
Update filter docs with missing entries and add negation option.
[NO NEW TESTS NEEDED] Signed-off-by: rvandernoort <s.r.vandernoort@student.tudelft.nl>
Diffstat (limited to 'docs/source/markdown')
-rw-r--r--docs/source/markdown/podman-images.1.md21
1 files changed, 18 insertions, 3 deletions
diff --git a/docs/source/markdown/podman-images.1.md b/docs/source/markdown/podman-images.1.md
index f1d9d4816..6bd9715be 100644
--- a/docs/source/markdown/podman-images.1.md
+++ b/docs/source/markdown/podman-images.1.md
@@ -27,30 +27,45 @@ Show image digests
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*.
+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. |
+| *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. |
-| *since* | Filter by images created after the given IMAGE (name or tag). |
+| *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: `<image-name>[:<tag>]`, `<image id>` or `<image@digest>`.
+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 `<none>` tag, consume disk space and serve no active purpose.
+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 `manifest` *filter* shows images that are manifest lists.
+
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>`.
+The `after` or `since` *filter* accepts formats: `<image-name>[:<tag>]`, `<image id>` or `<image@digest>`.
+
+The `until` *filter* accepts formats: golang duration, RFC3339 time, or a Unix timestamp and shows all images that are created until that time.
#### **--format**=*format*