diff options
| author | Paul Holzinger <paul.holzinger@web.de> | 2021-03-29 13:52:59 +0200 |
|---|---|---|
| committer | Matthew Heon <mheon@redhat.com> | 2021-03-29 13:53:50 -0400 |
| commit | ac4bdd265308f549c4db775c1674077a6c669b30 (patch) | |
| tree | a95f579c2d855ea2e4797fe04ee55aa20ec03372 /docs/source/markdown/podman-container-cleanup.1.md | |
| parent | 96ffce2198785c9d5717e3104f0afd8a0c38b6af (diff) | |
| download | podman-ac4bdd265308f549c4db775c1674077a6c669b30.tar.gz podman-ac4bdd265308f549c4db775c1674077a6c669b30.tar.bz2 podman-ac4bdd265308f549c4db775c1674077a6c669b30.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>
<MH: Fixed cherry-pick conflicts>
Signed-off-by: Matthew Heon <mheon@redhat.com>
Diffstat (limited to 'docs/source/markdown/podman-container-cleanup.1.md')
| -rw-r--r-- | docs/source/markdown/podman-container-cleanup.1.md | 16 |
1 files changed, 8 insertions, 8 deletions
diff --git a/docs/source/markdown/podman-container-cleanup.1.md b/docs/source/markdown/podman-container-cleanup.1.md index 8fd267b47..bd650c6af 100644 --- a/docs/source/markdown/podman-container-cleanup.1.md +++ b/docs/source/markdown/podman-container-cleanup.1.md @@ -12,26 +12,26 @@ Sometimes container's mount points and network stacks can remain if the podman c ## OPTIONS -#### **--all**, **-a** +#### **\-\-all**, **-a** Cleanup all containers. -#### **--exec**=_session_ +#### **\-\-exec**=_session_ Clean up an exec session for a single container. -Can only be specified if a single container is being cleaned up (conflicts with **--all** as such). -If **--rm** is not specified, temporary files for the exec session will be cleaned up; if it is, the exec session will be removed from the container. -Conflicts with **--rmi** as the container is not being cleaned up so the image cannot be removed. +Can only be specified if a single container is being cleaned up (conflicts with **\-\-all** as such). +If **\-\-rm** is not specified, temporary files for the exec session will be cleaned up; if it is, the exec session will be removed from the container. +Conflicts with **\-\-rmi** as the container is not being cleaned up so the image cannot be removed. -#### **--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) -#### **--rm** +#### **\-\-rm** After cleanup, remove the container entirely. -#### **--rmi** +#### **\-\-rmi** After cleanup, remove the image entirely. |