summaryrefslogtreecommitdiff
path: root/docs/source/markdown/podman-container-restore.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-restore.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-restore.1.md')
-rw-r--r--docs/source/markdown/podman-container-restore.1.md56
1 files changed, 28 insertions, 28 deletions
diff --git a/docs/source/markdown/podman-container-restore.1.md b/docs/source/markdown/podman-container-restore.1.md
index 3b517fb3d..ef8722279 100644
--- a/docs/source/markdown/podman-container-restore.1.md
+++ b/docs/source/markdown/podman-container-restore.1.md
@@ -10,7 +10,7 @@ podman\-container\-restore - Restores one or more containers from a checkpoint
Restores a container from a checkpoint. 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 as well as restoring. These files are not deleted if restoring
@@ -21,18 +21,18 @@ files created during checkpointing. The size required by the checkpoint
directory is roughly the same as the amount of memory required by the
processes in the checkpointed container.
-Without the **-k**, **\-\-keep** option the checkpoint will be consumed and cannot be used
+Without the **-k**, **--keep** option the checkpoint will be consumed and cannot be used
again.
-#### **\-\-all**, **-a**
+#### **--all**, **-a**
Restore all checkpointed containers.
-#### **\-\-latest**, **-l**
+#### **--latest**, **-l**
Instead of providing the container name or ID, restore the last created container. (This option is not available with the remote Podman client)
-#### **\-\-tcp-established**
+#### **--tcp-established**
Restore a container with established TCP connections. If the checkpoint image
contains established TCP connections, this option is required during restore.
@@ -40,58 +40,58 @@ If the checkpoint image does not contain established TCP connections this
option is ignored. Defaults to not restoring containers with established TCP
connections.
-#### **\-\-import**, **-i**
+#### **--import**, **-i**
Import a checkpoint tar.gz file, which was exported by Podman. This can be used
to import a checkpointed container from another host. Do not specify a *container*
argument when using this option.
-#### **\-\-import-previous**
+#### **--import-previous**
Import a pre-checkpoint tar.gz file which was exported by Podman. This option
-must be used with **-i** or **\-\-import**. It only works on runc 1.0-rc3 or higher.
+must be used with **-i** or **--import**. It only works on runc 1.0-rc3 or higher.
-#### **\-\-name**, **-n**
+#### **--name**, **-n**
-This is only available in combination with **\-\-import, -i**. If a container is restored
-from a checkpoint tar.gz file it is possible to rename it with **\-\-name, -n**. This
+This is only available in combination with **--import, -i**. If a container is restored
+from a checkpoint tar.gz file it is possible to rename it with **--name, -n**. This
way it is possible to restore a container from a checkpoint multiple times with different
names.
-If the **\-\-name, -n** option is used, Podman will not attempt to assign the same IP
+If the **--name, -n** option is used, Podman will not attempt to assign the same IP
address to the container it was using before checkpointing as each IP address can only
be used once and the restored container will have another IP address. This also means
-that **\-\-name, -n** cannot be used in combination with **\-\-tcp-established**.
+that **--name, -n** cannot be used in combination with **--tcp-established**.
-#### **\-\-ignore-rootfs**
+#### **--ignore-rootfs**
-This is only available in combination with **\-\-import, -i**. If a container is restored
+This is only available in combination with **--import, -i**. If a container is restored
from a checkpoint tar.gz file it is possible that it also contains all root file-system
-changes. With **\-\-ignore-rootfs** it is possible to explicitly disable applying these
+changes. With **--ignore-rootfs** it is possible to explicitly disable applying these
root file-system changes to the restored container.
-#### **\-\-ignore-static-ip**
+#### **--ignore-static-ip**
-If the container was started with **\-\-ip** the restored container also tries to use that
+If the container was started with **--ip** the restored container also tries to use that
IP address and restore fails if that IP address is already in use. This can happen, if
-a container is restored multiple times from an exported checkpoint with **\-\-name, -n**.
+a container is restored multiple times from an exported checkpoint with **--name, -n**.
-Using **\-\-ignore-static-ip** tells Podman to ignore the IP address if it was configured
-with **\-\-ip** during container creation.
+Using **--ignore-static-ip** tells Podman to ignore the IP address if it was configured
+with **--ip** during container creation.
-#### **\-\-ignore-static-mac**
+#### **--ignore-static-mac**
-If the container was started with **\-\-mac-address** the restored container also
+If the container was started with **--mac-address** the restored container also
tries to use that MAC address and restore fails if that MAC address is already
in use. This can happen, if a container is restored multiple times from an
-exported checkpoint with **\-\-name, -n**.
+exported checkpoint with **--name, -n**.
-Using **\-\-ignore-static-mac** tells Podman to ignore the MAC address if it was
-configured with **\-\-mac-address** during container creation.
+Using **--ignore-static-mac** tells Podman to ignore the MAC address if it was
+configured with **--mac-address** during container creation.
-#### **\-\-ignore-volumes**
+#### **--ignore-volumes**
-This option must be used in combination with the **\-\-import, -i** option.
+This option must be used in combination with the **--import, -i** option.
When restoring containers from a checkpoint tar.gz file with this option,
the content of associated volumes will not be restored.