aboutsummaryrefslogtreecommitdiff
path: root/docs/source/markdown/podman-container-restore.1.md
diff options
context:
space:
mode:
authorOpenShift Merge Robot <openshift-merge-robot@users.noreply.github.com>2022-03-23 23:19:15 +0100
committerGitHub <noreply@github.com>2022-03-23 23:19:15 +0100
commit80123ca505081fca513fc0865cf6e2daf43ff854 (patch)
tree37dad6631948e2cfa28165a423c6bf22f9ab4d1e /docs/source/markdown/podman-container-restore.1.md
parent73713062806aa4c2db25dc62e2fff47406085dc8 (diff)
parent9b0c8d23bddd0fccd6a1faa3fa7f5b7e0373f541 (diff)
downloadpodman-80123ca505081fca513fc0865cf6e2daf43ff854.tar.gz
podman-80123ca505081fca513fc0865cf6e2daf43ff854.tar.bz2
podman-80123ca505081fca513fc0865cf6e2daf43ff854.zip
Merge pull request #13625 from edsantiago/cdo
[CI:DOCS] man pages: sort flags, and keep them that way
Diffstat (limited to 'docs/source/markdown/podman-container-restore.1.md')
-rw-r--r--docs/source/markdown/podman-container-restore.1.md48
1 files changed, 24 insertions, 24 deletions
diff --git a/docs/source/markdown/podman-container-restore.1.md b/docs/source/markdown/podman-container-restore.1.md
index 4016eb1cb..5b1bf82c5 100644
--- a/docs/source/markdown/podman-container-restore.1.md
+++ b/docs/source/markdown/podman-container-restore.1.md
@@ -16,25 +16,14 @@ Restore all checkpointed *containers*.\
The default is **false**.\
*IMPORTANT: This OPTION does not need a container name or ID as input argument.*
-#### **--keep**, **-k**
+#### **--file-locks**
-Keep all temporary log and statistics files created by `CRIU` during
-checkpointing as well as restoring. These files are not deleted if restoring
-fails for further debugging. If restoring succeeds these files are
-theoretically not needed, but if these files are needed Podman can keep the
-files for further analysis. This includes the checkpoint directory with all
-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 **--keep**, **-k** option the checkpoint will be consumed and cannot be used again.\
+Restore a *container* with file locks. This option is required to
+restore file locks from a checkpoint image. If the checkpoint image
+does not contain file locks, this option is ignored. Defaults to not
+restoring file locks.\
The default is **false**.
-#### **--latest**, **-l**
-
-Instead of providing the *container ID* or *name*, use the last created *container*. If other tools than Podman are used to run *containers* such as `CRI-O`, the last started *container* could be from either tool.\
-The default is **false**.\
-*IMPORTANT: This OPTION is not available with the remote Podman client, including Mac and Windows (excluding WSL2) machines. This OPTION does not need a container name or ID as input argument.*
-
#### **--ignore-rootfs**
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 root file-system changes to the restored *container*.\
@@ -89,6 +78,25 @@ 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`.
*IMPORTANT: This OPTION is not supported on the remote client, including Mac and Windows (excluding WSL2) machines.*
+#### **--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
+fails for further debugging. If restoring succeeds these files are
+theoretically not needed, but if these files are needed Podman can keep the
+files for further analysis. This includes the checkpoint directory with all
+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 **--keep**, **-k** option the checkpoint will be consumed and cannot be used again.\
+The default is **false**.
+
+#### **--latest**, **-l**
+
+Instead of providing the *container ID* or *name*, use the last created *container*. If other tools than Podman are used to run *containers* such as `CRI-O`, the last started *container* could be from either tool.\
+The default is **false**.\
+*IMPORTANT: This OPTION is not available with the remote Podman client, including Mac and Windows (excluding WSL2) machines. This OPTION does not need a container name or ID as input argument.*
+
#### **--name**, **-n**=*name*
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
@@ -149,14 +157,6 @@ option is ignored. Defaults to not restoring *containers* with established TCP
connections.\
The default is **false**.
-#### **--file-locks**
-
-Restore a *container* with file locks. This option is required to
-restore file locks from a checkpoint image. If the checkpoint image
-does not contain file locks, this option is ignored. Defaults to not
-restoring file locks.\
-The default is **false**.
-
## EXAMPLE
Restores the container "mywebserver".
```