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>
This commit is contained in:
Adrian Reber
2019-08-06 18:11:13 +00:00
committed by Adrian Reber
parent 2e94378464
commit 1712af0e80
17 changed files with 176 additions and 140 deletions
+4 -2
View File
@@ -1,10 +1,12 @@
% runc-start "8"
# NAME
runc start - start executes the user defined process in a created container
# SYNOPSIS
runc start <container-id>
runc start `<container-id>`
Where "<container-id>" is your name for the instance of the container that you
Where "`<container-id>`" is your name for the instance of the container that you
are starting. The name you provide for the container instance must be unique on
your host.