diff options
| author | OpenShift Merge Robot <openshift-merge-robot@users.noreply.github.com> | 2020-06-10 09:32:56 -0400 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2020-06-10 09:32:56 -0400 |
| commit | 37c907868db51ce8357eedd818e5962cd3adf99d (patch) | |
| tree | a41953543eeafcca120f0ed2a2c85f140a5e3ec7 | |
| parent | 63468464e8365adefebee7127be888ea649edd8e (diff) | |
| parent | 99cbe59917ada7896b3f4c3252d91af6768c2e9b (diff) | |
| download | podman-37c907868db51ce8357eedd818e5962cd3adf99d.tar.gz podman-37c907868db51ce8357eedd818e5962cd3adf99d.tar.bz2 podman-37c907868db51ce8357eedd818e5962cd3adf99d.zip | |
Merge pull request #6537 from vrothberg/events-docs
podman-events: clarify streaming behaviour
| -rw-r--r-- | cmd/podman/system/events.go | 6 | ||||
| -rw-r--r-- | docs/source/markdown/podman-events.1.md | 2 |
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 |