Skip to content

Instantly share code, notes, and snippets.

@deshion
Last active February 3, 2024 19:40
Show Gist options
  • Star 24 You must be signed in to star a gist
  • Fork 1 You must be signed in to fork a gist
  • Save deshion/10d3cb5f88a21671e17a to your computer and use it in GitHub Desktop.
Save deshion/10d3cb5f88a21671e17a to your computer and use it in GitHub Desktop.
Parse command line options for a shell script (POSIX)
#!/bin/sh
# POSIX
# Reset all variables that might be set
file=
verbose=0 # Variables to be evaluated as shell arithmetic should be initialized to a default or validated beforehand.
while :; do
case $1 in
-h|-\?|--help) # Call a "show_help" function to display a synopsis, then exit.
show_help
exit
;;
-f|--file) # Takes an option argument, ensuring it has been specified.
if [ -n "$2" ]; then
file=$2
shift
else
printf 'ERROR: "--file" requires a non-empty option argument.\n' >&2
exit 1
fi
;;
--file=?*)
file=${1#*=} # Delete everything up to "=" and assign the remainder.
;;
--file=) # Handle the case of an empty --file=
printf 'ERROR: "--file" requires a non-empty option argument.\n' >&2
exit 1
;;
-v|--verbose)
verbose=$((verbose + 1)) # Each -v argument adds 1 to verbosity.
;;
--) # End of all options.
shift
break
;;
-?*)
printf 'WARN: Unknown option (ignored): %s\n' "$1" >&2
;;
*) # Default case: If no more options then break out of the loop.
break
esac
shift
done
# if --file was provided, open it for writing, else duplicate stdout
if [ -n "$file" ]; then
exec 3> "$file"
else
exec 3>&1
fi
# Rest of the program here.
# If there are input files (for example) that follow the options, they
# will remain in the "$@" positional parameters.
@w3irdrobot
Copy link

Does this require options to be specified before positional arguments?

@jarnos
Copy link

jarnos commented Oct 1, 2020

Does this require options to be specified before positional arguments?

Yes

@jarnos
Copy link

jarnos commented Oct 1, 2020

Actually, POSIX does not allow long options: "Each option name should be a single alphanumeric character". Besides, "One or more options without option-arguments, followed by at most one option that takes an option-argument, should be accepted when grouped behind one '-' delimiter." (reference)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment