diff options
author | Ed Santiago <santiago@redhat.com> | 2022-09-14 13:05:32 -0600 |
---|---|---|
committer | Ed Santiago <santiago@redhat.com> | 2022-09-15 05:17:25 -0600 |
commit | 9ba034293d28970734755d510a2df41290b8176d (patch) | |
tree | 96184a5a2bf98b30f4abdf85cc802944a475392e /docs | |
parent | 2a8df49c2a65831fa2c253afa1ad2b5e1d618b09 (diff) | |
download | podman-9ba034293d28970734755d510a2df41290b8176d.tar.gz podman-9ba034293d28970734755d510a2df41290b8176d.tar.bz2 podman-9ba034293d28970734755d510a2df41290b8176d.zip |
Man pages: refactor common options: 2 stats opts
--no-reset and --no-stream, in podman-stats and pod-stats.
Very minor tweak to --no-stream to account for pods.
Signed-off-by: Ed Santiago <santiago@redhat.com>
Diffstat (limited to 'docs')
-rw-r--r-- | docs/source/markdown/.gitignore | 2 | ||||
-rw-r--r-- | docs/source/markdown/options/no-reset.md | 3 | ||||
-rw-r--r-- | docs/source/markdown/options/no-stream.md | 3 | ||||
-rw-r--r-- | docs/source/markdown/podman-pod-stats.1.md.in (renamed from docs/source/markdown/podman-pod-stats.1.md) | 8 | ||||
-rw-r--r-- | docs/source/markdown/podman-stats.1.md.in (renamed from docs/source/markdown/podman-stats.1.md) | 8 |
5 files changed, 12 insertions, 12 deletions
diff --git a/docs/source/markdown/.gitignore b/docs/source/markdown/.gitignore index 69911b5b8..af4c5360b 100644 --- a/docs/source/markdown/.gitignore +++ b/docs/source/markdown/.gitignore @@ -20,6 +20,7 @@ podman-pod-kill.1.md podman-pod-logs.1.md podman-pod-rm.1.md podman-pod-start.1.md +podman-pod-stats.1.md podman-pod-stop.1.md podman-pull.1.md podman-push.1.md @@ -27,6 +28,7 @@ podman-rm.1.md podman-run.1.md podman-search.1.md podman-start.1.md +podman-stats.1.md podman-stop.1.md podman-unpause.1.md podman-update.1.md diff --git a/docs/source/markdown/options/no-reset.md b/docs/source/markdown/options/no-reset.md new file mode 100644 index 000000000..ce5b95057 --- /dev/null +++ b/docs/source/markdown/options/no-reset.md @@ -0,0 +1,3 @@ +#### **--no-reset** + +Do not clear the terminal/screen in between reporting intervals diff --git a/docs/source/markdown/options/no-stream.md b/docs/source/markdown/options/no-stream.md new file mode 100644 index 000000000..a9d548ba0 --- /dev/null +++ b/docs/source/markdown/options/no-stream.md @@ -0,0 +1,3 @@ +#### **--no-stream** + +Disable streaming <<|pod >>stats and only pull the first result, default setting is false diff --git a/docs/source/markdown/podman-pod-stats.1.md b/docs/source/markdown/podman-pod-stats.1.md.in index c71159f09..83a4b7a1e 100644 --- a/docs/source/markdown/podman-pod-stats.1.md +++ b/docs/source/markdown/podman-pod-stats.1.md.in @@ -40,13 +40,9 @@ When using a GO template, you may precede the format with `table` to print heade 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** +@@option 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 +@@option no-stream ## EXAMPLE diff --git a/docs/source/markdown/podman-stats.1.md b/docs/source/markdown/podman-stats.1.md.in index a1a0f6a93..f06bd3fcc 100644 --- a/docs/source/markdown/podman-stats.1.md +++ b/docs/source/markdown/podman-stats.1.md.in @@ -53,13 +53,9 @@ Time in seconds between stats reports, defaults to 5 seconds. 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. (This option is not available with the remote Podman client, including Mac and Windows (excluding WSL2) machines) -#### **--no-reset** +@@option no-reset -Do not clear the terminal/screen in between reporting intervals - -#### **--no-stream** - -Disable streaming stats and only pull the first result, default setting is false +@@option no-stream #### **--no-trunc** |