diff --git a/delete.go b/delete.go index e9751669..17d5c2fa 100644 --- a/delete.go +++ b/delete.go @@ -16,7 +16,8 @@ var deleteCommand = cli.Command{ ArgsUsage: ` Where "" is the name for the instance of the container. - + +EXAMPLE: For example, if the container id is "ubuntu01" and runc list currently shows the status of "ubuntu01" as "destroyed" the following will delete resources held for "ubuntu01" removing "ubuntu01" from the runc list of containers: diff --git a/exec.go b/exec.go index d4ca6274..11cfceff 100644 --- a/exec.go +++ b/exec.go @@ -22,6 +22,7 @@ var execCommand = cli.Command{ Where "" is the name for the instance of the container and "" is the command to be executed in the container. +EXAMPLE: For example, if the container is configured to run the linux ps command the following will output a list of processes running in the container: diff --git a/kill.go b/kill.go index 104354d8..e311bedd 100644 --- a/kill.go +++ b/kill.go @@ -56,7 +56,8 @@ var killCommand = cli.Command{ Where "" is the name for the instance of the container and "" is the signal to be sent to the init process. - + +EXAMPLE: For example, if the container id is "ubuntu01" the following will send a "KILL" signal to the init process of the "ubuntu01" container: diff --git a/list.go b/list.go index 5b1d464e..627310d6 100644 --- a/list.go +++ b/list.go @@ -16,7 +16,7 @@ import ( "github.com/opencontainers/runc/libcontainer/utils" ) -const formatOptions = `table or json` +const formatOptions = `table(default) or json` // containerState represents the platform agnostic pieces relating to a // running container's status and state @@ -40,12 +40,7 @@ var listCommand = cli.Command{ cli.StringFlag{ Name: "format, f", Value: "", - Usage: `select one of: ` + formatOptions + `. - -The default format is table. The following will output the list of containers -in json format: - - # runc list -f json`, + Usage: `select one of: ` + formatOptions, }, cli.BoolFlag{ Name: "quiet, q", diff --git a/man/runc-checkpoint.8.md b/man/runc-checkpoint.8.md index 6dc7b889..44fbedee 100644 --- a/man/runc-checkpoint.8.md +++ b/man/runc-checkpoint.8.md @@ -1,7 +1,7 @@ # NAME runc checkpoint - checkpoint a running container -# USAGE +# SYNOPSIS runc checkpoint [command options] Where "" is the name for the instance of the container to be diff --git a/man/runc-events.8.md b/man/runc-events.8.md index 10385e9b..f61eb883 100644 --- a/man/runc-events.8.md +++ b/man/runc-events.8.md @@ -1,5 +1,5 @@ # NAME - runc events - display container events such as OOM notifications, cpu, memory, IO and network stats + runc events - display container events such as OOM notifications, cpu, memory, and IO usage statistics # SYNOPSIS runc events [command options] @@ -13,4 +13,3 @@ information is displayed once every 5 seconds. # OPTIONS --interval "5s" set the stats collection interval --stats display the container's stats then exit - diff --git a/man/runc-exec.8.md b/man/runc-exec.8.md index d75db78b..c428bbd6 100644 --- a/man/runc-exec.8.md +++ b/man/runc-exec.8.md @@ -26,3 +26,4 @@ following will output a list of processes running in the container: --apparmor set the apparmor profile for the process --no-new-privs set the no new privileges value for the process --cap, -c [--cap option --cap option] add a capability to the bounding set for the process + --no-subreaper disable the use of the subreaper used to reap reparented processes diff --git a/man/runc-list.8.md b/man/runc-list.8.md index a41a6526..61696238 100644 --- a/man/runc-list.8.md +++ b/man/runc-list.8.md @@ -4,12 +4,6 @@ # SYNOPSIS runc list [command options] [arguments...] -# DESCRIPTION - The default format is table. The following will output the list of containers -in json format: - - # runc list -f json - # OPTIONS - --format, -f select one of: table or json. + --format, -f select one of: table(default) or json. --quiet, -q display only container IDs diff --git a/man/runc-ps.8.md b/man/runc-ps.8.md new file mode 100644 index 00000000..abfca412 --- /dev/null +++ b/man/runc-ps.8.md @@ -0,0 +1,13 @@ +# NAME + runc ps - ps displays the processes running inside a container + +# SYNOPSIS + runc ps [command options] + +# OPTIONS + --format, -f select one of: table(default) or json + +The default format is table. The following will output the processes of a container +in json format: + + # runc ps -f json diff --git a/man/runc-restore.8.md b/man/runc-restore.8.md index b0dec455..b10ae110 100644 --- a/man/runc-restore.8.md +++ b/man/runc-restore.8.md @@ -22,3 +22,5 @@ using the runc checkpoint command. --bundle, -b path to the root of the bundle directory --detach, -d detach from the container's process --pid-file specify the file to write the process id to + --no-subreaper disable the use of the subreaper used to reap reparented processes + --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 diff --git a/man/runc-spec.8.md b/man/runc-spec.8.md index 482c8c3a..831f699a 100644 --- a/man/runc-spec.8.md +++ b/man/runc-spec.8.md @@ -14,7 +14,7 @@ parameter that is initially set to call the "sh" command when the container is started. Calling "sh" may work for an ubuntu container or busybox, but will not work for containers that do not include the "sh" program. -EXAMPLE: +# EXAMPLE To run docker's hello-world container one needs to set the args parameter in the spec to call hello. This can be done using the sed command or a text editor. The following commands create a bundle for hello-world, change the diff --git a/ps.go b/ps.go index 9b10af0c..0b6ed167 100644 --- a/ps.go +++ b/ps.go @@ -21,12 +21,7 @@ var psCommand = cli.Command{ cli.StringFlag{ Name: "format, f", Value: "", - Usage: `select one of: ` + formatOptions + `. - -The default format is table. The following will output the processes of a container -in json format: - - # runc ps -f json`, + Usage: `select one of: ` + formatOptions, }, }, Action: func(context *cli.Context) error { diff --git a/update.go b/update.go index 815d6533..02b8a151 100644 --- a/update.go +++ b/update.go @@ -32,7 +32,8 @@ The accepted format is as follow (unchanged values can be omitted): "limit": 0, "reservation": 0, "swap": 0, - "kernel": 0 + "kernel": 0, + "kernelTCP": 0 }, "cpu": { "shares": 0,