You've already forked runc
mirror of
https://github.com/opencontainers/runc.git
synced 2025-11-02 04:13:26 +03:00
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>
560 B
560 B
% runc-list "8"
NAME
runc list - lists containers started by runc with the given root
SYNOPSIS
runc list [command options]
EXAMPLE
Where the given root is specified via the global option "--root" (default: "/run/runc").
To list containers created via the default "--root": # runc list
To list containers created using a non-default value for "--root": # runc --root value list
OPTIONS
--format value, -f value select one of: table or json (default: "table")
--quiet, -q display only container IDs