From 0e4eeb52ec6326ee6ae41f06e0d5b90ba9a5606b Mon Sep 17 00:00:00 2001 From: Ed Santiago Date: Mon, 19 Sep 2022 13:30:05 -0600 Subject: [PATCH] man pages: document some --format options: images Baby steps toward merging #14046: document Go format options for podman images. Signed-off-by: Ed Santiago --- docs/source/markdown/podman-images.1.md | 36 ++++++++++++++++++------- 1 file changed, 26 insertions(+), 10 deletions(-) diff --git a/docs/source/markdown/podman-images.1.md b/docs/source/markdown/podman-images.1.md index 63e4479603..183cbf73d5 100644 --- a/docs/source/markdown/podman-images.1.md +++ b/docs/source/markdown/podman-images.1.md @@ -73,16 +73,32 @@ Change the default output format. This can be of a supported type like 'json' or a Go template. Valid placeholders for the Go template are listed below: -| **Placeholder** | **Description** | -| --------------- | ----------------------------------------------------------------------------- | -| .ID | Image ID | -| .Repository | Image repository | -| .Tag | Image tag | -| .Digest | Image digest | -| .CreatedSince | Elapsed time since the image was created | -| .CreatedAt | Time when the image was created | -| .Size | Size of layer on disk | -| .History | History of the image layer | +| **Placeholder** | **Description** | +|-----------------|------------------------------------------------------------| +| .Containers | Number of containers using this image | +| .Created | Elapsed time since the image was created | +| .CreatedAt | Time when the image was created, YYYY-MM-DD HH:MM:SS +nnnn | +| .CreatedSince | Same as .Created | +| .CreatedTime | Same as .CreatedAt | +| .Dangling | Same as .IsDangling | +| .Digest | Image digest | +| .History | History of the image layer | +| .ID | Image ID (truncated) | +| .Id | Image ID (full SHA) | +| .ImageSummary | Internal data structure, not actually useful | +| .IsDangling | Is image dangling? (true/false) | +| .IsReadOnly | Is unage read-only? (true/false) | +| .Labels | map[] of labels | +| .Names | Image FQIN | +| .ParentId | Full SHA of parent image ID, or null (string) | +| .ReadOnly | Same as .IsReadOnly | +| .RepoDigests | map[] of zero or more repo/name@sha256:SHA strings | +| .Repository | Image repository | +| .RepoTags | map[] of zero or more FQIN strings for this image | +| .SharedSize | Always seems to be 0 | +| .Size | Size of layer on disk (human-friendly string) | +| .Tag | Image tag | +| .VirtualSize | Size of layer on disk (bytes) | #### **--history**