Merge pull request #939 from mikebrow/additional-list-docs
address issue #797 by adding additional documentation
This commit is contained in:
commit
7446e70f42
12
list.go
12
list.go
|
@ -38,6 +38,18 @@ type containerState struct {
|
||||||
var listCommand = cli.Command{
|
var listCommand = cli.Command{
|
||||||
Name: "list",
|
Name: "list",
|
||||||
Usage: "lists containers started by runc with the given root",
|
Usage: "lists containers started by runc with the given root",
|
||||||
|
ArgsUsage: `
|
||||||
|
|
||||||
|
Where the given root is specified via the global option "--root"
|
||||||
|
(default: "/run/runc").
|
||||||
|
|
||||||
|
EXAMPLE 1:
|
||||||
|
To list containers created via the default "--root":
|
||||||
|
runc list
|
||||||
|
|
||||||
|
EXAMPLE 2:
|
||||||
|
To list containers created using a non-default value for "--root":
|
||||||
|
runc --root value list`,
|
||||||
Flags: []cli.Flag{
|
Flags: []cli.Flag{
|
||||||
cli.StringFlag{
|
cli.StringFlag{
|
||||||
Name: "format, f",
|
Name: "format, f",
|
||||||
|
|
Loading…
Reference in New Issue