Skip to content

Commit 7446e70

Browse files
authored
Merge pull request #939 from mikebrow/additional-list-docs
address issue #797 by adding additional documentation
2 parents 4eb8c2f + 50dbe5f commit 7446e70

File tree

1 file changed

+12
-0
lines changed

1 file changed

+12
-0
lines changed

list.go

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -38,6 +38,18 @@ type containerState struct {
3838
var listCommand = cli.Command{
3939
Name: "list",
4040
Usage: "lists containers started by runc with the given root",
41+
ArgsUsage: `
42+
43+
Where the given root is specified via the global option "--root"
44+
(default: "/run/runc").
45+
46+
EXAMPLE 1:
47+
To list containers created via the default "--root":
48+
runc list
49+
50+
EXAMPLE 2:
51+
To list containers created using a non-default value for "--root":
52+
runc --root value list`,
4153
Flags: []cli.Flag{
4254
cli.StringFlag{
4355
Name: "format, f",

0 commit comments

Comments
 (0)