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>
This commit is contained in:
Valentin Rothberg 2020-06-09 16:28:13 +02:00
parent 9967f28339
commit 99cbe59917
2 changed files with 6 additions and 2 deletions

View File

@ -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",

View File

@ -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