mirror of
https://github.com/opencontainers/runc.git
synced 2026-07-11 06:03:57 +08:00
Adrian Reber
1712af0e80
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>
557 B
557 B
% 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>
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