summaryrefslogtreecommitdiff
path: root/docs/source/markdown/podman-volume-rm.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-volume-rm.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-volume-rm.1.md')
-rw-r--r--docs/source/markdown/podman-volume-rm.1.md10
1 files changed, 5 insertions, 5 deletions
diff --git a/docs/source/markdown/podman-volume-rm.1.md b/docs/source/markdown/podman-volume-rm.1.md
index c066d1c6e..2727ea640 100644
--- a/docs/source/markdown/podman-volume-rm.1.md
+++ b/docs/source/markdown/podman-volume-rm.1.md
@@ -9,22 +9,22 @@ podman\-volume\-rm - Remove one or more volumes
## DESCRIPTION
Removes one or more volumes. Only volumes that are not being used will be removed.
-If a volume is being used by a container, an error will be returned unless the **--force**
-flag is being used. To remove all volumes, use the **--all** flag.
+If a volume is being used by a container, an error will be returned unless the **\-\-force**
+flag is being used. To remove all volumes, use the **\-\-all** flag.
Volumes can be removed individually by providing their full name or a unique partial name.
## OPTIONS
-#### **--all**, **-a**
+#### **\-\-all**, **-a**
Remove all volumes.
-#### **--force**, **-f**
+#### **\-\-force**, **-f**
Remove a volume by force.
If it is being used by containers, the containers will be removed first.
-#### **--help**
+#### **\-\-help**
Print usage statement