diff options
author | Ashley Cui <ashleycui16@gmail.com> | 2019-05-31 15:21:47 -0400 |
---|---|---|
committer | Ashley Cui <ashleycui16@gmail.com> | 2019-06-10 11:48:02 -0400 |
commit | 19e0928037e2d9c6fb0941e2ac40b8cea731e22d (patch) | |
tree | 1b5b10718e2c27c690ae789392fe1d46535a4401 /docs/podman-stats.1.md | |
parent | 7b0d6fcf0e3ce59f842273f670d742aaf597bf2f (diff) | |
download | podman-19e0928037e2d9c6fb0941e2ac40b8cea731e22d.tar.gz podman-19e0928037e2d9c6fb0941e2ac40b8cea731e22d.tar.bz2 podman-19e0928037e2d9c6fb0941e2ac40b8cea731e22d.zip |
standardize documentation formatting
Signed-off-by: Ashley Cui <ashleycui16@gmail.com>
Diffstat (limited to 'docs/podman-stats.1.md')
-rw-r--r-- | docs/podman-stats.1.md | 9 |
1 files changed, 5 insertions, 4 deletions
diff --git a/docs/podman-stats.1.md b/docs/podman-stats.1.md index 97a9be961..b817662a8 100644 --- a/docs/podman-stats.1.md +++ b/docs/podman-stats.1.md @@ -1,4 +1,4 @@ -% podman-stats "1" +% podman-stats(1) ## NAME podman\-stats - Display a live stream of 1 or more containers' resource usage statistics @@ -11,11 +11,11 @@ Display a live stream of one or more containers' resource usage statistics ## OPTIONS -**--all, -a** +**--all**, **-a** Show all containers. Only running containers are shown by default -**--latest, -l** +**--latest**, **-l** Instead of providing the container name or ID, use the last created container. If you use methods other than Podman to run containers such as CRI-O, the last started container could be from either of those methods. @@ -30,7 +30,7 @@ Do not clear the terminal/screen in between reporting intervals Disable streaming stats and only pull the first result, default setting is false -**--format="TEMPLATE"** +**--format**=*template* Pretty-print container statistics to JSON or using a Go template @@ -49,6 +49,7 @@ Valid placeholders for the Go template are listed below: | .PIDS | Number of PIDs | When using a GO template, you may preceed the format with `table` to print headers. + ## EXAMPLE ``` |