summaryrefslogtreecommitdiff
path: root/docs/source/markdown/podman-pod-stats.1.md
diff options
context:
space:
mode:
authorEd Santiago <santiago@redhat.com>2022-03-23 12:29:08 -0600
committerEd Santiago <santiago@redhat.com>2022-03-23 13:49:42 -0600
commit9b0c8d23bddd0fccd6a1faa3fa7f5b7e0373f541 (patch)
tree37dad6631948e2cfa28165a423c6bf22f9ab4d1e /docs/source/markdown/podman-pod-stats.1.md
parent73713062806aa4c2db25dc62e2fff47406085dc8 (diff)
downloadpodman-9b0c8d23bddd0fccd6a1faa3fa7f5b7e0373f541.tar.gz
podman-9b0c8d23bddd0fccd6a1faa3fa7f5b7e0373f541.tar.bz2
podman-9b0c8d23bddd0fccd6a1faa3fa7f5b7e0373f541.zip
man pages: sort flags, and keep them that way
Command flags (OPTIONS) in man pages have to date been in haphazard order. Sometimes that order is sensible, e.g., most-important options first, but more often they're just in arbitrary places. This makes life hard for users. Here, I update the man-page-check Makefile script so it checks and enforces alphabetical order in OPTIONS sections. Then -- the hard part -- update all existing man pages to conform to this requirement. Signed-off-by: Ed Santiago <santiago@redhat.com>
Diffstat (limited to 'docs/source/markdown/podman-pod-stats.1.md')
-rw-r--r--docs/source/markdown/podman-pod-stats.1.md25
1 files changed, 13 insertions, 12 deletions
diff --git a/docs/source/markdown/podman-pod-stats.1.md b/docs/source/markdown/podman-pod-stats.1.md
index 460571add..389540fdf 100644
--- a/docs/source/markdown/podman-pod-stats.1.md
+++ b/docs/source/markdown/podman-pod-stats.1.md
@@ -15,18 +15,6 @@ Display a live stream of containers in one or more pods resource usage statistic
Show all containers. Only running containers are shown by default
-#### **--latest**, **-l**
-
-Instead of providing the pod name or ID, use the last created pod. (This option is not available with the remote Podman client, including Mac and Windows (excluding WSL2) machines)
-
-#### **--no-reset**
-
-Do not clear the terminal/screen in between reporting intervals
-
-#### **--no-stream**
-
-Disable streaming pod stats and only pull the first result, default setting is false
-
#### **--format**=*template*
Pretty-print container statistics to JSON or using a Go template
@@ -47,6 +35,19 @@ Valid placeholders for the Go template are listed below:
| .PIDS | Number of PIDs |
When using a GO template, you may precede the format with `table` to print headers.
+
+#### **--latest**, **-l**
+
+Instead of providing the pod name or ID, use the last created pod. (This option is not available with the remote Podman client, including Mac and Windows (excluding WSL2) machines)
+
+#### **--no-reset**
+
+Do not clear the terminal/screen in between reporting intervals
+
+#### **--no-stream**
+
+Disable streaming pod stats and only pull the first result, default setting is false
+
## EXAMPLE
```