1
0
mirror of https://github.com/opencontainers/runc.git synced 2025-11-02 04:13:26 +03:00
Files
runc/man/runc-checkpoint.8.md
Adrian Reber 1712af0e80 man: fix man-pages
The man-pages are using pre-formatted section to display the options for
all commands. The result on my system never looked correct:

OPTIONS
       --bundle value, -b value  path to the root [...]
          --console-socket value    path to an AF_UNIX [...]

The first line was always indented less than the other lines.

This commit makes the option block a pre-formatted block (as intended???) by
using 4 spaces instead of 3 spaces.

In addition the man-pages did not specify their name and section
correctly. This adds something like '% runc-run "8"' to all man-pages to
have correct title 'runc-run(8)' instead of 'NAME()' and it also adds
the section to the title: 'System Manager's Manual'.

This also fixes the use of '>' and '<' at multiple places. The markdown
source files were using "<container-id>" and similar which was (most of
the time) rendered as '""'. On some systems it was rendered correctly.

Signed-off-by: Adrian Reber <areber@redhat.com>
2019-08-06 21:29:31 +02:00

1.4 KiB

% runc-checkpoint "8"

NAME

runc checkpoint - checkpoint a running container

SYNOPSIS

runc checkpoint [command options] <container-id>

Where "<container-id>" is the name for the instance of the container to be checkpointed.

DESCRIPTION

The checkpoint command saves the state of the container instance.

OPTIONS

--image-path value           path for saving criu image files
--work-path value            path for saving work files and logs
--parent-path value          path for previous criu image files in pre-dump
--leave-running              leave the process running after checkpointing
--tcp-established            allow open tcp connections
--ext-unix-sk                allow external unix sockets
--shell-job                  allow shell jobs
--lazy-pages                 use userfaultfd to lazily restore memory pages
--status-fd value            criu writes \0 to this FD once lazy-pages is ready
--page-server value          ADDRESS:PORT of the page server
--file-locks                 handle file locks, for safety
--pre-dump                   dump container's memory information only, leave the container running after this
--manage-cgroups-mode value  cgroups mode: 'soft' (default), 'full' and 'strict'
--empty-ns value             create a namespace, but don't restore its properties
--auto-dedup                 enable auto deduplication of memory images