-
Notifications
You must be signed in to change notification settings - Fork 2.1k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
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>
- Loading branch information
1 parent
2e94378
commit 0f79d99
Showing
17 changed files
with
176 additions
and
140 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,28 +1,30 @@ | ||
% runc-checkpoint "8" | ||
|
||
# NAME | ||
runc checkpoint - checkpoint a running container | ||
|
||
# SYNOPSIS | ||
runc checkpoint [command options] <container-id> | ||
runc checkpoint [command options] `<container-id>` | ||
|
||
Where "<container-id>" is the name for the instance of the container to be | ||
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 | ||
--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 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,15 +1,17 @@ | ||
% runc-events "8" | ||
|
||
# NAME | ||
runc events - display container events such as OOM notifications, cpu, memory, and IO usage statistics | ||
|
||
# SYNOPSIS | ||
runc events [command options] <container-id> | ||
runc events [command options] `<container-id>` | ||
|
||
Where "<container-id>" is the name for the instance of the container. | ||
Where "`<container-id>`" is the name for the instance of the container. | ||
|
||
# DESCRIPTION | ||
The events command displays information about the container. By default the | ||
information is displayed once every 5 seconds. | ||
|
||
# OPTIONS | ||
--interval value set the stats collection interval (default: 5s) | ||
--stats display the container's stats then exit | ||
--interval value set the stats collection interval (default: 5s) | ||
--stats display the container's stats then exit |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,13 +1,15 @@ | ||
% runc-ps "8" | ||
|
||
# NAME | ||
runc ps - ps displays the processes running inside a container | ||
|
||
# SYNOPSIS | ||
runc ps [command options] <container-id> [ps options] | ||
runc ps [command options] `<container-id>` [ps options] | ||
|
||
# OPTIONS | ||
--format value, -f value select one of: table(default) or json | ||
--format value, -f value select one of: table(default) or json | ||
|
||
The default format is table. The following will output the processes of a container | ||
The default format is table. The following will output the processes of a container | ||
in json format: | ||
|
||
# runc ps -f json <container-id> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,26 +1,28 @@ | ||
% runc-restore "8" | ||
|
||
# NAME | ||
runc restore - restore a container from a previous checkpoint | ||
|
||
# SYNOPSIS | ||
runc restore [command options] <container-id> | ||
runc restore [command options] `<container-id>` | ||
|
||
Where "<container-id>" is the name for the instance of the container to be | ||
Where "`<container-id>`" is the name for the instance of the container to be | ||
restored. | ||
|
||
# DESCRIPTION | ||
Restores the saved state of the container instance that was previously saved | ||
using the runc checkpoint command. | ||
|
||
# OPTIONS | ||
--image-path value path to criu image files for restoring | ||
--work-path value path for saving work files and logs | ||
--tcp-established allow open tcp connections | ||
--ext-unix-sk allow external unix sockets | ||
--shell-job allow shell jobs | ||
--file-locks handle file locks, for safety | ||
--manage-cgroups-mode value cgroups mode: 'soft' (default), 'full' and 'strict' | ||
--bundle value, -b value path to the root of the bundle directory | ||
--detach, -d detach from the container's process | ||
--pid-file value specify the file to write the process id to | ||
--no-subreaper disable the use of the subreaper used to reap reparented processes | ||
--no-pivot do not use pivot root to jail process inside rootfs. This should be used whenever the rootfs is on top of a ramdisk | ||
--image-path value path to criu image files for restoring | ||
--work-path value path for saving work files and logs | ||
--tcp-established allow open tcp connections | ||
--ext-unix-sk allow external unix sockets | ||
--shell-job allow shell jobs | ||
--file-locks handle file locks, for safety | ||
--manage-cgroups-mode value cgroups mode: 'soft' (default), 'full' and 'strict' | ||
--bundle value, -b value path to the root of the bundle directory | ||
--detach, -d detach from the container's process | ||
--pid-file value specify the file to write the process id to | ||
--no-subreaper disable the use of the subreaper used to reap reparented processes | ||
--no-pivot do not use pivot root to jail process inside rootfs. This should be used whenever the rootfs is on top of a ramdisk |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.