mirror of
https://github.com/opencontainers/runc.git
synced 2025-10-18 21:34:40 +08:00
dfc0f0695a
Current runc man pages are ugly (no proper man page formatting) and very short (mostly just a copy-paste from the "runc <command> --help" output. They are also somewhat obsoleted as not all CLI updates were propagated to man/*. This commits makes the first step to solving this. In short: - added some more information about some options; - lots of formatting fixes; - use references to other man pages and web pages; - fix SYNOPSYS (formatting, mostly); - removed the repeated description of <container_id> from every page; - added SEE ALSO; - something else I forgot. Signed-off-by: Kir Kolyshkin <kolyshkin@gmail.com>
40 lines
777 B
Markdown
40 lines
777 B
Markdown
% runc-list "8"
|
|
|
|
# NAME
|
|
**runc-list** - lists containers
|
|
|
|
# SYNOPSIS
|
|
**runc list** [_option_ ...]
|
|
|
|
# DESCRIPTION
|
|
|
|
The **list** commands lists containers. Note that a global **--root**
|
|
option can be specified to change the default root. For the description
|
|
of **--root**, see **runc**(8).
|
|
|
|
# OPTIONS
|
|
**--format**|**-f** **table**|**json**
|
|
: Specify the format. Default is **table**. The **json** format provides
|
|
more details.
|
|
|
|
**--quiet**|**-q**
|
|
: Only display container IDs.
|
|
|
|
# EXAMPLES
|
|
To list containers created with the default root:
|
|
|
|
# runc list
|
|
|
|
To list containers in a human-readable JSON (with the help of **jq**(1)
|
|
utility):
|
|
|
|
# runc list -f json | jq
|
|
|
|
To list containers created with the root of **/tmp/myroot**:
|
|
|
|
# runc --root /tmp/myroot
|
|
|
|
# SEE ALSO
|
|
|
|
**runc**(8).
|