diff options
| author | Ed Santiago <santiago@redhat.com> | 2022-09-19 08:34:38 -0600 |
|---|---|---|
| committer | Ed Santiago <santiago@redhat.com> | 2022-09-19 08:34:38 -0600 |
| commit | 6790deb1b15ff51be75bc2e276f906f73b1a506c (patch) | |
| tree | 5c6b610856bd22cb7fd55cf5a1fd59d375860053 /docs | |
| parent | 541655f31a5301ea042d04782d1635ad51e9f434 (diff) | |
| download | podman-6790deb1b15ff51be75bc2e276f906f73b1a506c.tar.gz podman-6790deb1b15ff51be75bc2e276f906f73b1a506c.tar.bz2 podman-6790deb1b15ff51be75bc2e276f906f73b1a506c.zip | |
man pages: document some --format options
Baby steps toward merging #14046: document Go format options
for podman events.
This is deliberately imperfect. I am not the right person
to document these. I am simply the person who is getting
a skeleton framework in place.
Signed-off-by: Ed Santiago <santiago@redhat.com>
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/source/markdown/podman-events.1.md | 14 |
1 files changed, 14 insertions, 0 deletions
diff --git a/docs/source/markdown/podman-events.1.md b/docs/source/markdown/podman-events.1.md index d0c95fe06..dd62ef5a2 100644 --- a/docs/source/markdown/podman-events.1.md +++ b/docs/source/markdown/podman-events.1.md @@ -95,6 +95,20 @@ In the case where an ID is used, the ID may be in its full or shortened form. Format the output to JSON Lines or using the given Go template. +| **Placeholder** | **Description** | +|--------------------|-----------------------------------------------| +| .Attributes | created_at, _by, labels, and more (map[]) | +| .ContainerExitCode | Exit code (int) | +| .Details ... | Internal structure, not actually useful | +| .HealthStatus | Health Status (string) | +| .ID | Container ID (full 64-bit SHA) | +| .Image | Name of image being run (string) | +| .Name | Container name (string) | +| .Network | Name of network being used (string) | +| .Status | Event status (e.g., create, start, died, ...) | +| .Time | Event timestamp (string) | +| .Type | Event type (e.g., image, container, pod, ...) | + #### **--help** Print usage statement. |