Merge pull request #6537 from vrothberg/events-docs

podman-events: clarify streaming behaviour
containers · Jun 10, 2020 · 37c9078 · 37c9078
2 parents 6346846 + 99cbe59
commit 37c9078
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 2 deletions.
diff --git 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
@@ -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