Chapter 6. Exit and Exit Status

 

... there are dark corners in the Bourne shell, and people use all of them.

--Chet Ramey

The exit command terminates a script, just as in a C program. It can also return a value, which is available to the script's parent process.

Every command returns an exit status (sometimes referred to as a return status or exit code). A successful command returns a 0, while an unsuccessful one returns a non-zero value that usually can be interpreted as an error code. Well-behaved UNIX commands, programs, and utilities return a 0 exit code upon successful completion, though there are some exceptions.

Likewise, functions within a script and the script itself return an exit status. The last command executed in the function or script determines the exit status. Within a script, an exit nnn command may be used to deliver an nnn exit status to the shell (nnn must be an integer in the 0 - 255 range).

Note

When a script ends with an exit that has no parameter, the exit status of the script is the exit status of the last command executed in the script (previous to the exit).

   1 #!/bin/bash
   2 
   3 COMMAND_1
   4 
   5 . . .
   6 
   7 COMMAND_LAST
   8 
   9 # Will exit with status of last command.
  10 
  11 exit

The equivalent of a bare exit is exit $? or even just omitting the exit.

   1 #!/bin/bash
   2 
   3 COMMAND_1
   4 
   5 . . .
   6 
   7 COMMAND_LAST
   8 
   9 # Will exit with status of last command.
  10 
  11 exit $?

   1 #!/bin/bash
   2 
   3 COMMAND1
   4 
   5 . . . 
   6 
   7 COMMAND_LAST
   8 
   9 # Will exit with status of last command.

$? reads the exit status of the last command executed. After a function returns, $? gives the exit status of the last command executed in the function. This is Bash's way of giving functions a "return value." [1]

Following the execution of a pipe, a $? gives the exit status of the last command executed.

After a script terminates, a $? from the command-line gives the exit status of the script, that is, the last command executed in the script, which is, by convention, 0 on success or an integer in the range 1 - 255 on error.


Example 6-1. exit / exit status

   1 #!/bin/bash
   2 
   3 echo hello
   4 echo $?    # Exit status 0 returned because command executed successfully.
   5 
   6 lskdf      # Unrecognized command.
   7 echo $?    # Non-zero exit status returned -- command failed to execute.
   8 
   9 echo
  10 
  11 exit 113   # Will return 113 to shell.
  12            # To verify this, type "echo $?" after script terminates.
  13 
  14 #  By convention, an 'exit 0' indicates success,
  15 #+ while a non-zero exit value means an error or anomalous condition.
  16 #  See the "Exit Codes With Special Meanings" appendix.

$? is especially useful for testing the result of a command in a script (see Example 16-35 and Example 16-20).

Note

The !, the logical not qualifier, reverses the outcome of a test or command, and this affects its exit status.


Example 6-2. Negating a condition using !

   1 true    # The "true" builtin.
   2 echo "exit status of \"true\" = $?"     # 0
   3 
   4 ! true
   5 echo "exit status of \"! true\" = $?"   # 1
   6 # Note that the "!" needs a space between it and the command.
   7 #    !true   leads to a "command not found" error
   8 #
   9 # The '!' operator prefixing a command invokes the Bash history mechanism.
  10 
  11 true
  12 !true
  13 # No error this time, but no negation either.
  14 # It just repeats the previous command (true).
  15 
  16 
  17 # =========================================================== #
  18 # Preceding a _pipe_ with ! inverts the exit status returned.
  19 ls | bogus_command     # bash: bogus_command: command not found
  20 echo $?                # 127
  21 
  22 ! ls | bogus_command   # bash: bogus_command: command not found
  23 echo $?                # 0
  24 # Note that the ! does not change the execution of the pipe.
  25 # Only the exit status changes.
  26 # =========================================================== #
  27 
  28 # Thanks, Stéphane Chazelas and Kristopher Newsome.

Caution

Certain exit status codes have reserved meanings and should not be user-specified in a script.

Notes

[1]

In those instances when there is no return terminating the function.