Merge pull request containers#21713 from rhatdan/docs18

[CI:DOCS] Fix up example description of podman-images.1.md.in
baude · Feb 20, 2024 · 9f1a9b1 · 9f1a9b1
2 parents 5435130 + 62148bf
commit 9f1a9b1
Showing 1 changed file with 10 additions and 0 deletions.
diff --git a/docs/source/markdown/podman-images.1.md.in b/docs/source/markdown/podman-images.1.md.in
@@ -122,6 +122,7 @@ Sort by *created*, *id*, *repository*, *size* or *tag* (default: **created**)
 
 ## EXAMPLE
 
+List all non-dangling images in local storage:
 ```
 $ podman images
 REPOSITORY                         TAG         IMAGE ID      CREATED       SIZE
@@ -131,26 +132,30 @@ registry.fedoraproject.org/fedora  latest      2ecb6df95994  3 weeks ago   169 M
 quay.io/libpod/testimage           20220615    f26aa69bb3f3  2 months ago  8.4 MB
 ```
 
+List all images matching the specified name:
 ```
 $ podman images stable
 REPOSITORY             TAG         IMAGE ID      CREATED       SIZE
 quay.io/podman/stable  latest      e0b7dabc3352  22 hours ago  331 MB
 ```
 
+List image ids of all images in containers storage:
 ```
 # podman image ls --quiet
 e3d42bcaf643
 ebb91b73692b
 4526339ae51c
 ```
 
+List all images without showing the headers:
 ```
 # podman images --noheading
 docker.io/kubernetes/pause                   latest   e3d42bcaf643   3 years ago   251 kB
 <none>                                       <none>   ebb91b73692b   4 weeks ago   27.2 MB
 docker.io/library/ubuntu                     latest   4526339ae51c   6 weeks ago   126 MB
 ```
 
+List all images without truncating output:
 ```
 # podman image list --no-trunc
 REPOSITORY                                   TAG      IMAGE ID                                                                  CREATED       SIZE
@@ -159,6 +164,7 @@ docker.io/kubernetes/pause                   latest   sha256:e3d42bcaf643097dd1b
 docker.io/library/ubuntu                     latest   sha256:4526339ae51c3cdc97956a7a961c193c39dfc6bd9733b0d762a36c6881b5583a   6 weeks ago   126 MB
 ```
 
+List all image content with the formatted content:
 ```
 # podman images --format "table {{.ID}} {{.Repository}} {{.Tag}}"
 IMAGE ID       REPOSITORY                                   TAG
@@ -167,12 +173,14 @@ ebb91b73692b   <none>                                       <none>
 4526339ae51c   docker.io/library/ubuntu                     latest
 ```
 
+List any image that is not tagged with a name (dangling):
 ```
 # podman images --filter dangling=true
 REPOSITORY   TAG      IMAGE ID       CREATED       SIZE
 <none>       <none>   ebb91b73692b   4 weeks ago   27.2 MB
 ```
 
+List all images in JSON format:
 ```
 # podman images --format json
 [
@@ -206,6 +214,7 @@ REPOSITORY   TAG      IMAGE ID       CREATED       SIZE
 ]
 ```
 
+List all images sorted by the specified column:
 ```
 # podman images --sort repository
 REPOSITORY                                   TAG      IMAGE ID       CREATED       SIZE
@@ -216,6 +225,7 @@ registry.access.redhat.com/rhel7            latest   7a840db7f020   2 weeks ago
 registry.fedoraproject.org/fedora           27       801894bc0e43   6 weeks ago          246 MB
 ```
 
+Show the difference between listed images in use versus all images, including dangling images:
 ```
 # podman images
 REPOSITORY                 TAG      IMAGE ID       CREATED         SIZE