summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorbaude <bbaude@redhat.com>2017-11-28 16:25:01 -0600
committerbaude <bbaude@redhat.com>2017-12-11 08:24:30 -0600
commite8a32e3722e0b814c654cdb8809565a21fc120d3 (patch)
tree8b88407b645e9403f4fc7ebf2e4d62bc34785a20 /docs
parent8d31ec2ad775c97c4b860eb24a3481092b6e88e3 (diff)
downloadpodman-e8a32e3722e0b814c654cdb8809565a21fc120d3.tar.gz
podman-e8a32e3722e0b814c654cdb8809565a21fc120d3.tar.bz2
podman-e8a32e3722e0b814c654cdb8809565a21fc120d3.zip
kpod exec
Initial wiring of kpod exec. We wont support the following options for exec: * detach -- unsure of use case * detach-keys -- not supported by runc * interactive -- all terminals will be interactive Not adding exec tests as we need to think about how to support a test that requires console access but our CI tests have no console. Signed-off-by: baude <bbaude@redhat.com>
Diffstat (limited to 'docs')
-rw-r--r--docs/kpod-exec.1.md43
-rw-r--r--docs/kpod.1.md3
2 files changed, 46 insertions, 0 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.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