Document caveats

README.md

@@ -61,6 +61,7 @@ For more information on SemVer, please visit [http://semver.org](http://semver.o
 
 ### v1.2.0 (Unreleased)
 
+- Enable errexit, nounset and pipefail at the top
 - More refined colors (thanks @arathai)
 - Add Changelog
 - Add `__base` magic var

main.sh

@@ -42,6 +42,9 @@ LOG_LEVEL="${LOG_LEVEL:-6}" # 7 = debug -> 0 = emergency
 
 # Commandline options. This defines the usage page, and is used to parse cli
 # opts & defaults from. The parsing is unforgiving so be precise in your syntax
+# - A short option must be preset for every long option; but every short option
+#   need not have a long option
+# - `--` is respected as the separator between options and arguments
 read -r -d '' usage <<-'EOF' || true # exits non-zero when EOF encountered
   -f --file  [arg] Filename to process. Required.
   -t --temp  [arg] Location of tempfile. Default="/tmp/bar"