mirror of
https://github.com/opencontainers/runc.git
synced 2026-07-12 09:46:25 +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>
30 lines
1.5 KiB
Markdown
30 lines
1.5 KiB
Markdown
% runc-create "8"
|
|
|
|
# NAME
|
|
runc create - create a container
|
|
|
|
# SYNOPSIS
|
|
runc create [command options] `<container-id>`
|
|
|
|
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.
|
|
|
|
# DESCRIPTION
|
|
The create command creates an instance of a container for a bundle. The bundle
|
|
is a directory with a specification file named "config.json" and a root
|
|
filesystem.
|
|
|
|
The specification file includes an args parameter. The args parameter is used
|
|
to specify command(s) that get run when the container is started. To change the
|
|
command(s) that get executed on start, edit the args parameter of the spec. See
|
|
"runc spec --help" for more explanation.
|
|
|
|
# OPTIONS
|
|
--bundle value, -b value path to the root of the bundle directory, defaults to the current directory
|
|
--console-socket value path to an AF_UNIX socket which will receive a file descriptor referencing the master end of the console's pseudoterminal
|
|
--pid-file value specify the file to write the process id to
|
|
--no-pivot do not use pivot root to jail process inside rootfs. This should be used whenever the rootfs is on top of a ramdisk
|
|
--no-new-keyring do not create a new session keyring for the container. This will cause the container to inherit the calling processes session key
|
|
--preserve-fds value Pass N additional file descriptors to the container (stdio + $LISTEN_FDS + N in total) (default: 0)
|