Differences between revisions 88 and 89
Revision 88 as of 2014-08-07 09:52:57
Size: 6147
Editor: geirha
Comment: increment verbose
Revision 89 as of 2015-01-04 23:36:49
Size: 5606
Editor: JarnoSuni
Comment: Make the script work even with set -o nounset (or set -u)
Deletions are marked like this. Additions are marked like this.
Line 3: Line 3:
Line 17: Line 18:
set -o nounset
Line 21: Line 23:
while :; do while [ "$#" -gt 0 ]; do
Line 28: Line 30:
            if [ "$2" ]; then             if [ "$#" -gt 1 ]; then
Line 71: Line 73:
Line 73: Line 74:

Some Bash programmers like to write this at the beginning of their scripts to guard against unused variables:

{{{
    set -u # or, set -o nounset
}}}
The use of this breaks the loop above, as "$1" may not be set upon entering the loop. There are four solutions to this issue:

 1. Stop using `-u`.
 1. Replace `case $1 in` with `case ${1+$1} in` (as well as bandaging all the other code that `set -u` breaks).
 1. Replace `case $1 in` with `case ${1-} in` (every potentially undeclared variable could be written as ${variable-} to prevent `set -u` tripping).
 1. Stop using `-u`.
Line 100: Line 89:
    
Line 106: Line 95:
} }
Line 149: Line 138:
Line 154: Line 142:

----
CategoryBashguide CategoryBashguide

How can I handle command-line arguments (options) to my script easily?

Well, that depends a great deal on what you want to do with them. There are several approaches, each with its strengths and weaknesses.

Manual loop

This approach handles any arbitrary set of options, because you're writing the parser yourself. For 90% of programs, this is the simplest approach (because you rarely need fancy stuff).

This example will handle a combination of short and long options. Notice how both "--file" and "--file=FILE" are handled.

   1 #!/bin/sh
   2 # (POSIX shell syntax)
   3 
   4 set -o nounset
   5 # Reset all variables that might be set
   6 file=
   7 verbose=0
   8 
   9 while [ "$#" -gt 0 ]; do
  10     case $1 in
  11         -h|-\?|--help)   # Call a "show_help" function to display a synopsis, then exit.
  12             show_help
  13             exit
  14             ;;
  15         -f|--file)       # Takes an option argument, ensuring it has been specified.
  16             if [ "$#" -gt 1 ]; then
  17                 file=$2
  18                 shift 2
  19                 continue
  20             else
  21                 echo 'ERROR: Must specify a non-empty "--file FILE" argument.' >&2
  22                 exit 1
  23             fi
  24             ;;
  25         --file=?*)
  26             file=${1#*=} # Delete everything up to "=" and assign the remainder.
  27             ;;
  28         --file=)         # Handle the case of an empty --file=
  29             echo 'ERROR: Must specify a non-empty "--file FILE" argument.' >&2
  30             exit 1
  31             ;;
  32         -v|--verbose)
  33             verbose=$((verbose + 1)) # Each -v argument adds 1 to verbosity.
  34             ;;
  35         --)              # End of all options.
  36             shift
  37             break
  38             ;;
  39         -?*)
  40             printf 'WARN: Unknown option (ignored): %s\n' "$1" >&2
  41             ;;
  42         *)               # Default case: If no more options then break out of the loop.
  43             break
  44     esac
  45 
  46     shift
  47 done
  48 
  49 # Suppose --file is a required option. Check that it has been set.
  50 if [ ! "$file" ]; then
  51     echo 'ERROR: option "--file FILE" not given. See --help.' >&2
  52     exit 1
  53 fi
  54 
  55 # Rest of the program here.
  56 # If there are input files (for example) that follow the options, they
  57 # will remain in the "$@" positional parameters.

This parser does not handle separate options concatenated together (like -xvf being understood as -x -v -f). This could be added with effort, but this is left as an exercise for the reader.

getopts

Unless it's the version from util-linux, and you use its advanced mode, never use getopt(1). Traditional versions of getopt cannot handle empty argument strings, or arguments with embedded whitespace.

The POSIX shell (and others) offer getopts which is safe to use instead. Here is a simplistic getopts example:

   1 #!/bin/sh
   2 
   3 # Usage info
   4 show_help() {
   5 cat << EOF
   6 Usage: ${0##*/} [-hv] [-f OUTFILE] [FILE]...
   7 Do stuff with FILE and write the result to standard output. With no FILE
   8 or when FILE is -, read standard input.
   9 
  10     -h          display this help and exit
  11     -f OUTFILE  write the result to OUTFILE instead of standard output.
  12     -v          verbose mode. Can be used multiple times for increased
  13                 verbosity.
  14 EOF
  15 }
  16 
  17 # Initialize our own variables:
  18 output_file=""
  19 verbose=0
  20 
  21 OPTIND=1 # Reset is necessary if getopts was used previously in the script.  It is a good idea to make this local in a function.
  22 while getopts "hvf:" opt; do
  23     case "$opt" in
  24         h)
  25             show_help
  26             exit 0
  27             ;;
  28         v)  verbose=$((verbose+1))
  29             ;;
  30         f)  output_file=$OPTARG
  31             ;;
  32         '?')
  33             show_help >&2
  34             exit 1
  35             ;;
  36     esac
  37 done
  38 shift "$((OPTIND-1))" # Shift off the options and optional --.
  39 
  40 printf 'verbose=<%d>\noutput_file=<%s>\nLeftovers:\n' "$verbose" "$output_file"
  41 printf '<%s>\n' "$@"
  42 
  43 # End of file

The advantages of getopts are:

  1. It's portable, and will work in any POSIX shell e.g. dash.
  2. It can handle things like -vf filename in the expected Unix way, automatically.

  3. It understands -- as the option terminator and more generally makes sure, options are parsed like for any standard command.

  4. With some implementations, the error messages will be localised in the language of the user.

The disadvantage of getopts is that (except for ksh93 getopts) it can only handle short options (-h, not --help) without trickery and cannot handle options with optional arguments à la GNU.

There is a getopts tutorial which explains what all of the syntax and variables mean. In bash, there is also help getopts, which might be informative.

There is also still the disadvantage that options are coded in at least 2, probably 3 places - in the call to getopts, in the case statement that processes them and presumably in the help message that you are going to get around to writing one of these days. This is a classic opportunity for errors to creep in as the code is written and maintained - often not discovered till much, much later. This can be avoided by using callback functions, but this approach kind of defeats the purpose of using getopts at all.

For other, more complicated ways of option parsing, see ComplexOptionParsing.


CategoryShell


CategoryBashguide CategoryBashguide

BashFAQ/035 (last edited 2024-02-26 07:51:38 by larryv)