summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorValentin Rothberg <rothberg@redhat.com>2020-06-09 16:28:13 +0200
committerValentin Rothberg <rothberg@redhat.com>2020-06-10 11:09:12 +0200
commit99cbe59917ada7896b3f4c3252d91af6768c2e9b (patch)
treef3b96df35749696b3199e7abb8d0f624f7499584
parent9967f28339dc43c97966bc07345af53a374faf67 (diff)
downloadpodman-99cbe59917ada7896b3f4c3252d91af6768c2e9b.tar.gz
podman-99cbe59917ada7896b3f4c3252d91af6768c2e9b.tar.bz2
podman-99cbe59917ada7896b3f4c3252d91af6768c2e9b.zip
podman-events: clarify streaming behaviour
Unless `--since` or `--until` is specified, `podman events` will stream new events. Clarify this behavior in the `--help` message and man page to avoid confusion. Fixes: #6536 Signed-off-by: Valentin Rothberg <rothberg@redhat.com>
-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