aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorOpenShift Merge Robot <openshift-merge-robot@users.noreply.github.com>2022-09-19 20:03:27 +0200
committerGitHub <noreply@github.com>2022-09-19 20:03:27 +0200
commit30231d0da7e6dcf3d6d1f45b10150baae35aaf28 (patch)
tree53f1eee91b3398833c442aaedb37e4c18873e6d0
parent5f5d40084c71a5adabc029c97d682c33cab07353 (diff)
parent6790deb1b15ff51be75bc2e276f906f73b1a506c (diff)
downloadpodman-30231d0da7e6dcf3d6d1f45b10150baae35aaf28.tar.gz
podman-30231d0da7e6dcf3d6d1f45b10150baae35aaf28.tar.bz2
podman-30231d0da7e6dcf3d6d1f45b10150baae35aaf28.zip
Merge pull request #15859 from edsantiago/docs_format_events
[CI:DOCS] man pages: document some --format options
-rw-r--r--docs/source/markdown/podman-events.1.md14
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.