diff options
author | Paul Holzinger <paul.holzinger@web.de> | 2021-03-29 13:52:59 +0200 |
---|---|---|
committer | Paul Holzinger <paul.holzinger@web.de> | 2021-03-29 14:38:25 +0200 |
commit | bc48211924bd8f88263149f8b5d047a52f8d1733 (patch) | |
tree | 9e9d01ba112981055b9d5351af35c38b3b3bc20e /docs/source/markdown/podman-volume-ls.1.md | |
parent | 7e4b13b94699ee688c146afab727d2dec991376a (diff) | |
download | podman-bc48211924bd8f88263149f8b5d047a52f8d1733.tar.gz podman-bc48211924bd8f88263149f8b5d047a52f8d1733.tar.bz2 podman-bc48211924bd8f88263149f8b5d047a52f8d1733.zip |
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 <paul.holzinger@web.de>
Diffstat (limited to 'docs/source/markdown/podman-volume-ls.1.md')
-rw-r--r-- | docs/source/markdown/podman-volume-ls.1.md | 14 |
1 files changed, 7 insertions, 7 deletions
diff --git a/docs/source/markdown/podman-volume-ls.1.md b/docs/source/markdown/podman-volume-ls.1.md index 48853bdfd..5214980a3 100644 --- a/docs/source/markdown/podman-volume-ls.1.md +++ b/docs/source/markdown/podman-volume-ls.1.md @@ -8,25 +8,25 @@ podman\-volume\-ls - List all the available volumes ## DESCRIPTION -Lists all the volumes that exist. The output can be filtered using the **--filter** -flag and can be formatted to either JSON or a Go template using the **--format** -flag. Use the **--quiet** flag to print only the volume names. +Lists all the volumes that exist. The output can be filtered using the **\-\-filter** +flag and can be formatted to either JSON or a Go template using the **\-\-format** +flag. Use the **\-\-quiet** flag to print only the volume names. ## OPTIONS -#### **--filter**=*filter*, **-f** +#### **\-\-filter**=*filter*, **-f** Filter volume output. -#### **--format**=*format* +#### **\-\-format**=*format* Format volume output using Go template. -#### **--help** +#### **\-\-help** Print usage statement. -#### **--quiet**, **-q** +#### **\-\-quiet**, **-q** Print volume output in quiet mode. Only print the volume names. |