summaryrefslogtreecommitdiff
path: root/docs/source/markdown/podman-network-ls.1.md
diff options
context:
space:
mode:
authorPaul Holzinger <paul.holzinger@web.de>2021-03-29 13:52:59 +0200
committerPaul Holzinger <paul.holzinger@web.de>2021-03-29 14:38:25 +0200
commitbc48211924bd8f88263149f8b5d047a52f8d1733 (patch)
tree9e9d01ba112981055b9d5351af35c38b3b3bc20e /docs/source/markdown/podman-network-ls.1.md
parent7e4b13b94699ee688c146afab727d2dec991376a (diff)
downloadpodman-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-network-ls.1.md')
-rw-r--r--docs/source/markdown/podman-network-ls.1.md10
1 files changed, 5 insertions, 5 deletions
diff --git a/docs/source/markdown/podman-network-ls.1.md b/docs/source/markdown/podman-network-ls.1.md
index 9d2dd52a8..12dbb01d3 100644
--- a/docs/source/markdown/podman-network-ls.1.md
+++ b/docs/source/markdown/podman-network-ls.1.md
@@ -10,7 +10,7 @@ podman\-network\-ls - Display a summary of CNI networks
Displays a list of existing podman networks.
## OPTIONS
-#### **--filter**, **-f**
+#### **\-\-filter**, **-f**
Filter output based on conditions given.
Multiple filters can be given with multiple uses of the --filter flag.
@@ -27,7 +27,7 @@ Valid filters are listed below:
| plugin | [Plugin] CNI plugins included in a network (e.g `bridge`,`portmap`,`firewall`,`tuning`,`dnsname`,`macvlan`) |
| driver | [Driver] Only `bridge` is supported |
-#### **--format**
+#### **\-\-format**
Change the default output format. This can be of a supported type like 'json'
or a Go template.
@@ -41,11 +41,11 @@ Valid placeholders for the Go template are listed below:
| .Labels | Network labels |
| .Version | CNI Version of the config file |
-#### **--no-trunc**
+#### **\-\-no-trunc**
-Do not truncate the network ID. The network ID is not displayed by default and must be specified with **--format**.
+Do not truncate the network ID. The network ID is not displayed by default and must be specified with **\-\-format**.
-#### **--quiet**, **-q**
+#### **\-\-quiet**, **-q**
The `quiet` option will restrict the output to only the network names.