From bc48211924bd8f88263149f8b5d047a52f8d1733 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>
---
 .../markdown/podman-container-checkpoint.1.md      | 30 +++++++++++-----------
 1 file changed, 15 insertions(+), 15 deletions(-)

(limited to 'docs/source/markdown/podman-container-checkpoint.1.md')

diff --git a/docs/source/markdown/podman-container-checkpoint.1.md b/docs/source/markdown/podman-container-checkpoint.1.md
index 46b6cb646..a93464508 100644
--- a/docs/source/markdown/podman-container-checkpoint.1.md
+++ b/docs/source/markdown/podman-container-checkpoint.1.md
@@ -10,61 +10,61 @@ podman\-container\-checkpoint - Checkpoints one or more running containers
 Checkpoints all the processes in one or more containers. You may use container IDs or names as input.
 
 ## OPTIONS
-#### **--keep**, **-k**
+#### **\-\-keep**, **-k**
 
 Keep all temporary log and statistics files created by CRIU during checkpointing. These files
 are not deleted if checkpointing fails for further debugging. If checkpointing succeeds these
 files are theoretically not needed, but if these files are needed Podman can keep the files
 for further analysis.
 
-#### **--all**, **-a**
+#### **\-\-all**, **-a**
 
 Checkpoint all running containers.
 
-#### **--latest**, **-l**
+#### **\-\-latest**, **-l**
 
 Instead of providing the container name or ID, checkpoint the last created container. (This option is not available with the remote Podman client)
 
-#### **--leave-running**, **-R**
+#### **\-\-leave-running**, **-R**
 
 Leave the container running after checkpointing instead of stopping it.
 
-#### **--tcp-established**
+#### **\-\-tcp-established**
 
 Checkpoint a container with established TCP connections. If the checkpoint
 image contains established TCP connections, this options is required during
 restore. Defaults to not checkpointing containers with established TCP
 connections.
 
-#### **--export**, **-e**
+#### **\-\-export**, **-e**
 
 Export the checkpoint to a tar.gz file. The exported checkpoint can be used
 to import the container on another system and thus enabling container live
 migration. This checkpoint archive also includes all changes to the container's
-root file-system, if not explicitly disabled using **--ignore-rootfs**
+root file-system, if not explicitly disabled using **\-\-ignore-rootfs**
 
-#### **--ignore-rootfs**
+#### **\-\-ignore-rootfs**
 
-This only works in combination with **--export, -e**. If a checkpoint is
-exported to a tar.gz file it is possible with the help of **--ignore-rootfs**
+This only works in combination with **\-\-export, -e**. If a checkpoint is
+exported to a tar.gz file it is possible with the help of **\-\-ignore-rootfs**
 to explicitly disable including changes to the root file-system into
 the checkpoint archive file.
 
-#### **--ignore-volumes**
+#### **\-\-ignore-volumes**
 
-This option must be used in combination with the **--export, -e** option.
+This option must be used in combination with the **\-\-export, -e** option.
 When this option is specified, the content of volumes associated with
 the container will not be included into the checkpoint tar.gz file.
 
-#### **--pre-checkpoint**, **-P**
+#### **\-\-pre-checkpoint**, **-P**
 
 Dump the container's memory information only, leaving the container running. Later
 operations will supersede prior dumps. It only works on runc 1.0-rc3 or higher.
 
-#### **--with-previous**
+#### **\-\-with-previous**
 
 Check out the container with previous criu image files in pre-dump. It only works
-without **--pre-checkpoint** or **-P**. It only works on runc 1.0-rc3 or higher.
+without **\-\-pre-checkpoint** or **-P**. It only works on runc 1.0-rc3 or higher.
 
 ## EXAMPLE
 
-- 
cgit v1.2.3-54-g00ecf