From ac4bdd265308f549c4db775c1674077a6c669b30 Mon Sep 17 00:00:00 2001
From: Paul Holzinger <paul.holzinger@web.de>
Date: Mon, 29 Mar 2021 13:52:59 +0200
Subject: 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>
---
 docs/source/markdown/podman-pod-ps.1.md | 22 +++++++++++-----------
 1 file changed, 11 insertions(+), 11 deletions(-)

(limited to 'docs/source/markdown/podman-pod-ps.1.md')

diff --git a/docs/source/markdown/podman-pod-ps.1.md b/docs/source/markdown/podman-pod-ps.1.md
index 7c1c4a0b4..0be22c2b1 100644
--- a/docs/source/markdown/podman-pod-ps.1.md
+++ b/docs/source/markdown/podman-pod-ps.1.md
@@ -26,35 +26,35 @@ By default it lists:
 
 ## OPTIONS
 
-#### **--ctr-names**
+#### **\-\-ctr-names**
 
 Includes the container names in the container info field
 
-#### **--ctr-ids**
+#### **\-\-ctr-ids**
 
 Includes the container IDs in the container info field
 
-#### **--ctr-status**
+#### **\-\-ctr-status**
 
 Includes the container statuses in the container info field
 
-#### **--latest**, **-l**
+#### **\-\-latest**, **-l**
 
 Show the latest pod created (all states) (This option is not available with the remote Podman client)
 
-#### **--no-trunc**
+#### **\-\-no-trunc**
 
 Display the extended information
 
-#### **--ns**
+#### **\-\-ns**
 
 Display namespace information of the pod
 
-#### **--quiet**, **-q**
+#### **\-\-quiet**, **-q**
 
 Print the numeric IDs of the pods only
 
-#### **--format**=*format*
+#### **\-\-format**=*format*
 
 Pretty-print containers to JSON or using a Go template
 
@@ -72,13 +72,13 @@ Valid placeholders for the Go template are listed below:
 | .InfraID            | Pod infra container ID                                                                          |
 | .Networks           | Show all networks connected to the infra container                                              |
 
-#### **--sort**
+#### **\-\-sort**
 
 Sort by created, ID, name, status, or number of containers
 
 Default: created
 
-#### **--filter**, **-f**=*filter*
+#### **\-\-filter**, **-f**=*filter*
 
 Filter output based on conditions given.
 Multiple filters can be given with multiple uses of the --filter flag.
@@ -99,7 +99,7 @@ Valid filters are listed below:
 | ctr-status | Container status within the pod                                                       |
 | ctr-number | Number of containers in the pod                                                       |
 
-#### **--help**, **-h**
+#### **\-\-help**, **-h**
 
 Print usage statement
 
-- 
cgit v1.2.3-54-g00ecf