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-system-prune.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-system-prune.1.md')
| -rw-r--r-- | docs/source/markdown/podman-system-prune.1.md | 14 |
1 files changed, 7 insertions, 7 deletions
diff --git a/docs/source/markdown/podman-system-prune.1.md b/docs/source/markdown/podman-system-prune.1.md index 791503a2c..50a25bf6d 100644 --- a/docs/source/markdown/podman-system-prune.1.md +++ b/docs/source/markdown/podman-system-prune.1.md @@ -9,16 +9,16 @@ podman\-system\-prune - Remove all unused pod, container, image and volume data ## DESCRIPTION **podman system prune** removes all unused containers (both dangling and unreferenced), pods and optionally, volumes from local storage. -With the **--all** option, you can delete all unused images. Unused images are dangling images as well as any image that does not have any containers based on it. +With the **\-\-all** option, you can delete all unused images. Unused images are dangling images as well as any image that does not have any containers based on it. -By default, volumes are not removed to prevent important data from being deleted if there is currently no container using the volume. Use the **--volumes** flag when running the command to prune volumes as well. +By default, volumes are not removed to prevent important data from being deleted if there is currently no container using the volume. Use the **\-\-volumes** flag when running the command to prune volumes as well. ## OPTIONS -#### **--all**, **-a** +#### **\-\-all**, **-a** Recursively remove all unused pod, container, image and volume data (Maximum 50 iterations.) -#### **--filter**=*filters* +#### **\-\-filter**=*filters* Provide filter values. @@ -33,15 +33,15 @@ The until filter can be Unix timestamps, date formatted timestamps, or Go durati The label filter accepts two formats. One is the label=... (label=_key_ or label=_key=value_), which removes containers and images with the specified labels. The other format is the label!=... (label!=_key_ or label!=_key=value_), which removes containers and images without the specified labels. -#### **--force**, **-f** +#### **\-\-force**, **-f** Do not prompt for confirmation -#### **--help**, **-h** +#### **\-\-help**, **-h** Print usage statement -#### **--volumes** +#### **\-\-volumes** Prune volumes currently unused by any container |