summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
-rw-r--r--cmd/podman/system/events.go6
-rw-r--r--docs/source/markdown/podman-events.1.md2
2 files changed, 6 insertions, 2 deletions
diff --git a/cmd/podman/system/events.go b/cmd/podman/system/events.go
index 27e80138e..c401c5a92 100644
--- a/cmd/podman/system/events.go
+++ b/cmd/podman/system/events.go
@@ -17,8 +17,10 @@ import (
)
var (
- eventsDescription = "Monitor podman events"
- eventsCommand = &cobra.Command{
+ eventsDescription = `Monitor podman events.
+
+ By default, streaming mode is used, printing new events as they occur. Previous events can be listed via --since and --until.`
+ eventsCommand = &cobra.Command{
Use: "events",
Args: validate.NoArgs,
Short: "Show podman events",
diff --git a/docs/source/markdown/podman-events.1.md b/docs/source/markdown/podman-events.1.md
index a05047684..abfc6e9c1 100644
--- a/docs/source/markdown/podman-events.1.md
+++ b/docs/source/markdown/podman-events.1.md
@@ -15,6 +15,8 @@ value to `file`. Only `file` and `journald` are accepted. A `none` logger is al
available but this logging mechanism completely disables events; nothing will be reported by
`podman events`.
+By default, streaming mode is used, printing new events as they occur. Previous events can be listed via `--since` and `--until`.
+
The *container* event type will report the follow statuses:
* attach
* checkpoint