diff options
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/kpod-exec.1.md | 43 | ||||
| -rw-r--r-- | docs/kpod-rename.1.md | 24 | ||||
| -rw-r--r-- | docs/kpod.1.md | 3 |
3 files changed, 46 insertions, 24 deletions
diff --git a/docs/kpod-exec.1.md b/docs/kpod-exec.1.md new file mode 100644 index 000000000..1de5da39b --- /dev/null +++ b/docs/kpod-exec.1.md @@ -0,0 +1,43 @@ +% kpod(1) kpod-exec - Execute a command in a running container +% Brent Baude +# kpod-exec "1" "December 2017" "kpod" + +## NAME +kpod-exec - Execute a command in a running container + +## SYNOPSIS +**kpod exec** +**CONTAINER** +[COMMAND] [ARG...] +[**--help**|**-h**] + +## DESCRIPTION +**kpod exec** executes a command in a running container. + +## OPTIONS +**--env, e** +You may specify arbitrary environment variables that are available for the +command to be executed. + +**--interactive, -i** +Not supported. All exec commands are interactive by default. + +**--privileged** +Give the process extended Linux capabilities when running the command in container. + +**--tty, -t** +Allocate a pseudo-TTY. + +**--user, -u** +Sets the username or UID used and optionally the groupname or GID for the specified command. +The following examples are all valid: +--user [user | user:group | uid | uid:gid | user:gid | uid:group ] + +## EXAMPLES + + +## SEE ALSO +kpod(1), kpod-run(1) + +## HISTORY +December 2017, Originally compiled by Brent Baude<bbaude@redhat.com> diff --git a/docs/kpod-rename.1.md b/docs/kpod-rename.1.md deleted file mode 100644 index e59dbd991..000000000 --- a/docs/kpod-rename.1.md +++ /dev/null @@ -1,24 +0,0 @@ -% kpod(1) kpod-rename - Rename a container -% Ryan Cole -# kpod-images "1" "March 2017" "kpod" - -## NAME -kpod rename - Rename a container - -## SYNOPSIS -**kpod** **rename** CONTAINER NEW-NAME - -## DESCRIPTION -Rename a container. Container may be created, running, paused, or stopped - -## EXAMPLE - -kpod rename redis-container webserver - -kpod rename a236b9a4 mycontainer - -## SEE ALSO -kpod(1) - -## HISTORY -March 2017, Originally compiled by Ryan Cole <rycole@redhat.com> diff --git a/docs/kpod.1.md b/docs/kpod.1.md index 7009289c7..dec29e395 100644 --- a/docs/kpod.1.md +++ b/docs/kpod.1.md @@ -61,6 +61,9 @@ create a new container ### diff Inspect changes on a container or image's filesystem +## exec +Execute a command in a running container. + ### export Export container's filesystem contents as a tar archive |