summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorDaniel J Walsh <dwalsh@redhat.com>2018-09-02 07:51:50 -0400
committerAtomic Bot <atomic-devel@projectatomic.io>2018-09-05 14:04:50 +0000
commit1ee466eee4f224cfa7e57b7556b5119b2f02f653 (patch)
tree1d2370e52677039e078d5d11e22c86f438aec5e1 /docs
parent7ffb8a79007414e510ac14ac0d682e1bbfe30c7c (diff)
downloadpodman-1ee466eee4f224cfa7e57b7556b5119b2f02f653.tar.gz
podman-1ee466eee4f224cfa7e57b7556b5119b2f02f653.tar.bz2
podman-1ee466eee4f224cfa7e57b7556b5119b2f02f653.zip
We should fail Podman with ExitCode 125 by default
$ ./bin/podman --foo $ echo $? 125 $ ./bin/podman foo Command "foo" not found. See `podman --help`. $ echo $? 1 After this change $ ./bin/podman foo Command "foo" not found. See `podman --help`. $ echo $? 125 Signed-off-by: Daniel J Walsh <dwalsh@redhat.com> Closes: #1398 Approved by: vrothberg
Diffstat (limited to 'docs')
-rw-r--r--docs/podman.1.md32
1 files changed, 32 insertions, 0 deletions
diff --git a/docs/podman.1.md b/docs/podman.1.md
index 057ba95bb..31aeeccdb 100644
--- a/docs/podman.1.md
+++ b/docs/podman.1.md
@@ -75,6 +75,38 @@ output logging information to syslog as well as the console
Print the version
+## Exit Status
+
+The exit code from `podman gives information about why the container
+failed to run or why it exited. When `podman` commands exit with a non-zero code,
+the exit codes follow the `chroot` standard, see below:
+
+**_125_** if the error is with podman **_itself_**
+
+ $ podman run --foo busybox; echo $?
+ # flag provided but not defined: --foo
+ See 'podman run --help'.
+ 125
+
+**_126_** if executing a **_container command_** and the the **_command_** cannot be invoked
+
+ $ podman run busybox /etc; echo $?
+ # exec: "/etc": permission denied
+ podman: Error response from daemon: Contained command could not be invoked
+ 126
+
+**_127_** if executing a **_container command_** and the the **_command_** cannot be found
+ $ podman run busybox foo; echo $?
+ # exec: "foo": executable file not found in $PATH
+ podman: Error response from daemon: Contained command not found or does not exist
+ 127
+
+**_Exit code_** of **_container command_** otherwise
+
+ $ podman run busybox /bin/sh -c 'exit 3'
+ # 3
+
+
## COMMANDS
| Command | Description |