1
0
mirror of https://github.com/opencontainers/runc.git synced 2025-11-02 04:13:26 +03:00
Files
runc/man/runc-delete.8.md
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

622 B

% runc-delete "8"

NAME

runc delete - delete any resources held by the container often used with detached container

SYNOPSIS

runc delete [command options] <container-id>

Where "<container-id>" is the name for the instance of the container.

OPTIONS

--force, -f		Forcibly deletes the container if it is still running (uses SIGKILL)

EXAMPLE

For example, if the container id is "ubuntu01" and runc list currently shows the status of "ubuntu01" as "stopped" the following will delete resources held for "ubuntu01" removing "ubuntu01" from the runc list of containers:

   # runc delete ubuntu01