summaryrefslogtreecommitdiff
path: root/docs/podman-exec.1.md
diff options
context:
space:
mode:
authorDaniel J Walsh <dwalsh@redhat.com>2019-06-12 05:06:00 -0400
committerDaniel J Walsh <dwalsh@redhat.com>2019-06-13 23:38:10 -0400
commitc7ee7f868df7170bae2d65a1831a52ce851dc49d (patch)
tree03982149875dff358d5db91b4a58c5f1345294df /docs/podman-exec.1.md
parent56957db468a018063af34489f671274498b1ef28 (diff)
downloadpodman-c7ee7f868df7170bae2d65a1831a52ce851dc49d.tar.gz
podman-c7ee7f868df7170bae2d65a1831a52ce851dc49d.tar.bz2
podman-c7ee7f868df7170bae2d65a1831a52ce851dc49d.zip
Document exit codes for podman exec
Also fix podman run exit codes to show real messages when failures happen. Signed-off-by: Daniel J Walsh <dwalsh@redhat.com>
Diffstat (limited to 'docs/podman-exec.1.md')
-rw-r--r--docs/podman-exec.1.md28
1 files changed, 28 insertions, 0 deletions
diff --git a/docs/podman-exec.1.md b/docs/podman-exec.1.md
index a6a58df01..07d24e295 100644
--- a/docs/podman-exec.1.md
+++ b/docs/podman-exec.1.md
@@ -52,6 +52,34 @@ The default working directory for running binaries within a container is the roo
The image developer can set a different default with the WORKDIR instruction, which can be overridden
when creating the container.
+## Exit Status
+
+The exit code from `podman exec` gives information about why the command within the container failed to run or why it exited. When `podman exec` exits with a
+non-zero code, the exit codes follow the `chroot` standard, see below:
+
+**_125_** if the error is with podman **_itself_**
+
+ $ podman exec --foo ctrID /bin/sh; echo $?
+ Error: unknown flag: --foo
+ 125
+
+**_126_** if the **_contained command_** cannot be invoked
+
+ $ podman exec ctrID /etc; echo $?
+ Error: container_linux.go:346: starting container process caused "exec: \"/etc\": permission denied": OCI runtime error
+ 126
+
+**_127_** if the **_contained command_** cannot be found
+
+ $ podman exec ctrID foo; echo $?
+ Error: container_linux.go:346: starting container process caused "exec: \"foo\": executable file not found in $PATH": OCI runtime error
+ 127
+
+**_Exit code_** of **_contained command_** otherwise
+
+ $ podman exec ctrID /bin/sh -c 'exit 3'
+ # 3
+
## EXAMPLES
$ podman exec -it ctrID ls