summaryrefslogtreecommitdiff
path: root/docs/source/markdown/podman-pod-stop.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-pod-stop.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-pod-stop.1.md')
-rw-r--r--docs/source/markdown/podman-pod-stop.1.md10
1 files changed, 5 insertions, 5 deletions
diff --git a/docs/source/markdown/podman-pod-stop.1.md b/docs/source/markdown/podman-pod-stop.1.md
index 77f6af433..b68ee2377 100644
--- a/docs/source/markdown/podman-pod-stop.1.md
+++ b/docs/source/markdown/podman-pod-stop.1.md
@@ -11,25 +11,25 @@ Stop containers in one or more pods. You may use pod IDs or names as input.
## OPTIONS
-#### **--all**, **-a**
+#### **\-\-all**, **-a**
Stops all pods
-#### **--ignore**, **-i**
+#### **\-\-ignore**, **-i**
Ignore errors when specified pods are not in the container store. A user might
have decided to manually remove a pod which would lead to a failure during the
ExecStop directive of a systemd service referencing that pod.
-#### **--latest**, **-l**
+#### **\-\-latest**, **-l**
Instead of providing the pod name or ID, stop the last created pod. (This option is not available with the remote Podman client)
-#### **--time**, **-t**=*time*
+#### **\-\-time**, **-t**=*time*
Timeout to wait before forcibly stopping the containers in the pod.
-#### **--pod-id-file**
+#### **\-\-pod-id-file**
Read pod ID from the specified file and stop the pod. Can be specified multiple times.