From bc48211924bd8f88263149f8b5d047a52f8d1733 Mon Sep 17 00:00:00 2001 From: Paul Holzinger Date: Mon, 29 Mar 2021 13:52:59 +0200 Subject: Fix long option format on docs.podman.io Escape the two dashes, otherwise they are combined into one long dash. I tested that this change is safe and still renders correctly on github and with the man pages. This commit also contains a small change to make it build locally. Assuming you have the dependencies installed you can do: ``` cd docs make html ``` Preview the html files in docs/build/html with `python -m http.server 8000 --directory build/html`. Fixes containers/podman.io#373 Signed-off-by: Paul Holzinger --- docs/source/markdown/podman-stats.1.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) (limited to 'docs/source/markdown/podman-stats.1.md') diff --git a/docs/source/markdown/podman-stats.1.md b/docs/source/markdown/podman-stats.1.md index 300106796..a4f4f68a3 100644 --- a/docs/source/markdown/podman-stats.1.md +++ b/docs/source/markdown/podman-stats.1.md @@ -20,24 +20,24 @@ about their networking usage. ## 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. (This option is not available with the remote Podman client) -#### **--no-reset** +#### **\-\-no-reset** Do not clear the terminal/screen in between reporting intervals -#### **--no-stream** +#### **\-\-no-stream** 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 -- cgit v1.2.3-54-g00ecf