summaryrefslogtreecommitdiff
path: root/docs/source/markdown/podman-container-checkpoint.1.md
diff options
context:
space:
mode:
authorPaul Holzinger <paul.holzinger@web.de>2021-05-07 18:30:00 +0200
committerPaul Holzinger <paul.holzinger@web.de>2021-05-07 18:30:00 +0200
commit30e731ecc8e439d038bbd2b7ab964a980579acf8 (patch)
treef17f242dca7395f83cbe7cc5aff22adf37bcc9d8 /docs/source/markdown/podman-container-checkpoint.1.md
parent5616887f62b4bed1031cdade8bd602bc2cb9d8f4 (diff)
downloadpodman-30e731ecc8e439d038bbd2b7ab964a980579acf8.tar.gz
podman-30e731ecc8e439d038bbd2b7ab964a980579acf8.tar.bz2
podman-30e731ecc8e439d038bbd2b7ab964a980579acf8.zip
Revert escaped double dash man page flag syntax
Commit 800a2e2d35 introduced a way to disable the conversion of `--`into an en dash on docs.podman.io, so the ugly workaround of escaping the dashes is no longer necessary. Signed-off-by: Paul Holzinger <paul.holzinger@web.de>
Diffstat (limited to 'docs/source/markdown/podman-container-checkpoint.1.md')
-rw-r--r--docs/source/markdown/podman-container-checkpoint.1.md30
1 files changed, 15 insertions, 15 deletions
diff --git a/docs/source/markdown/podman-container-checkpoint.1.md b/docs/source/markdown/podman-container-checkpoint.1.md
index a93464508..46b6cb646 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