runc/man
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
..
README.md Add README.md for generating man pages 2016-03-04 11:14:12 -08:00
md2man-all.sh Warning message if 'go-md2man' is not yet installed 2018-02-02 21:51:57 +09:00
runc-checkpoint.8.md man: fix man-pages 2019-08-06 21:29:31 +02:00
runc-create.8.md man: fix man-pages 2019-08-06 21:29:31 +02:00
runc-delete.8.md man: fix man-pages 2019-08-06 21:29:31 +02:00
runc-events.8.md man: fix man-pages 2019-08-06 21:29:31 +02:00
runc-exec.8.md man: fix man-pages 2019-08-06 21:29:31 +02:00
runc-kill.8.md man: fix man-pages 2019-08-06 21:29:31 +02:00
runc-list.8.md man: fix man-pages 2019-08-06 21:29:31 +02:00
runc-pause.8.md man: fix man-pages 2019-08-06 21:29:31 +02:00
runc-ps.8.md man: fix man-pages 2019-08-06 21:29:31 +02:00
runc-restore.8.md man: fix man-pages 2019-08-06 21:29:31 +02:00
runc-resume.8.md man: fix man-pages 2019-08-06 21:29:31 +02:00
runc-run.8.md man: fix man-pages 2019-08-06 21:29:31 +02:00
runc-spec.8.md man: fix man-pages 2019-08-06 21:29:31 +02:00
runc-start.8.md man: fix man-pages 2019-08-06 21:29:31 +02:00
runc-state.8.md man: fix man-pages 2019-08-06 21:29:31 +02:00
runc-update.8.md man: fix man-pages 2019-08-06 21:29:31 +02:00
runc.8.md man: fix man-pages 2019-08-06 21:29:31 +02:00

README.md

runc man pages

This directory contains man pages for runc in markdown format.

To generate man pages from it, use this command

./md2man-all.sh

You will see man pages generated under the man8 directory.