.nh
.TH runc "8"

.SH NAME
.PP
\fBrunc\fP - Open Container Initiative runtime


.SH SYNOPSIS
.PP
\fBrunc\fP [\fIglobal-option\fP ...] \fIcommand\fP [\fIcommand-option\fP ...] [\fIargument\fP ...]


.SH DESCRIPTION
.PP
runc is a command line client for running applications packaged according to
the Open Container Initiative (OCI) format and is a compliant implementation of the
Open Container Initiative specification.

.PP
runc integrates well with existing process supervisors to provide a production
container runtime environment for applications. It can be used with your
existing process monitoring tools and the container will be spawned as a
direct child of the process supervisor.

.PP
Containers are configured using bundles. A bundle for a container is a directory
that includes a specification file named \fIconfig.json\fP and a root filesystem.
The root filesystem contains the contents of the container.

.PP
To run a new instance of a container:

.PP
.RS

.nf
# runc run [ -b bundle ] container-id

.fi
.RE

.PP
Where \fIcontainer-id\fP 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.

.PP
Providing the bundle directory using \fB-b\fP is optional. The default
value for \fIbundle\fP is the current directory.


.SH COMMANDS
.TP
\fBcheckpoint\fP
Checkpoint a running container. See \fBrunc-checkpoint\fP(8).

.TP
\fBcreate\fP
Create a container. See \fBrunc-create\fP(8).

.TP
\fBdelete\fP
Delete any resources held by the container often used with detached
containers. See \fBrunc-delete\fP(8).

.TP
\fBevents\fP
Display container events such as OOM notifications, cpu, memory, IO and
network stats. See \fBrunc-events\fP(8).

.TP
\fBexec\fP
Execute a new process inside the container. See \fBrunc-exec\fP(8).

.TP
\fBinit\fP
Initialize the namespaces and launch the container init process. This command
is not supposed to be used directly.

.TP
\fBkill\fP
Send a specified signal to the container's init process. See
\fBrunc-kill\fP(8).

.TP
\fBlist\fP
List containers started by runc with the given \fB--root\fP\&. See
\fBrunc-list\fP(8).

.TP
\fBpause\fP
Suspend all processes inside the container. See \fBrunc-pause\fP(8).

.TP
\fBps\fP
Show processes running inside the container. See \fBrunc-ps\fP(8).

.TP
\fBrestore\fP
Restore a container from a previous checkpoint. See \fBrunc-restore\fP(8).

.TP
\fBresume\fP
Resume all processes that have been previously paused. See \fBrunc-resume\fP(8).

.TP
\fBrun\fP
Create and start a container. See \fBrunc-run\fP(8).

.TP
\fBspec\fP
Create a new specification file (\fIconfig.json\fP). See \fBrunc-spec\fP(8).

.TP
\fBstart\fP
Start a container previously created by \fBrunc create\fP\&. See \fBrunc-start\fP(8).

.TP
\fBstate\fP
Show the container state. See \fBrunc-state\fP(8).

.TP
\fBupdate\fP
Update container resource constraints. See \fBrunc-update\fP(8).

.TP
\fBhelp\fP, \fBh\fP
Show a list of commands or help for a particular command.


.SH GLOBAL OPTIONS
.PP
These options can be used with any command, and must precede the \fBcommand\fP\&.

.TP
\fB--debug\fP
Enable debug logging.

.TP
\fB--log\fP \fIpath\fP
Set the log destination to \fIpath\fP\&. The default is to log to stderr.

.TP
\fB--log-format\fP \fBtext\fP|\fBjson\fP
Set the log format (default is \fBtext\fP).

.TP
\fB--root\fP \fIpath\fP
Set the root directory to store containers' state. The \fIpath\fP should be
located on tmpfs. Default is \fI/run/runc\fP, or \fI$XDG_RUNTIME_DIR/runc\fP for
rootless containers.

.TP
\fB--criu\fP \fIpath\fP
Set the path to the \fBcriu\fP(8) binary used for checkpoint and restore.
Default is \fBcriu\fP\&.

.TP
\fB--systemd-cgroup\fP
Enable systemd cgroup support. If this is set, the container spec
(\fIconfig.json\fP) is expected to have \fBcgroupsPath\fP value in the
\fIslice:prefix:name\fP form (e.g. \fBsystem.slice:runc:434234\fP).

.TP
\fB--rootless\fP \fBtrue\fP|\fBfalse\fP|\fBauto\fP
Enable or disable rootless mode. Default is \fBauto\fP, meaning to auto-detect
whether rootless should be enabled.

.TP
\fB--help\fP|\fB-h\fP
Show help.

.TP
\fB--version\fP|\fB-v\fP
Show version.


.SH SEE ALSO
.PP
\fBrunc-checkpoint\fP(8),
\fBrunc-create\fP(8),
\fBrunc-delete\fP(8),
\fBrunc-events\fP(8),
\fBrunc-exec\fP(8),
\fBrunc-kill\fP(8),
\fBrunc-list\fP(8),
\fBrunc-pause\fP(8),
\fBrunc-ps\fP(8),
\fBrunc-restore\fP(8),
\fBrunc-resume\fP(8),
\fBrunc-run\fP(8),
\fBrunc-spec\fP(8),
\fBrunc-start\fP(8),
\fBrunc-state\fP(8),
\fBrunc-update\fP(8).