scripts/library/README

   1 This folder contains code snippets that can be reused by multiple
   2 scripts.  A brief description of each file follows.
   3
   4 output_format.sh:
   5 Provides basic output formatting functions with levels 'msg', 'msg2',
   6 'warning' and 'error'.  The 'msg' amd 'msg2' functions print to stdout
   7 and can be silenced by defining 'QUIET'.  The 'warning' and 'error'
   8 functions print to stderr with the appropriate prefix added to the
   9 message.
  10
  11 parse_options.sh:
  12 A getopt replacement to avoids portability issues, in particular the
  13 lack of long option name support in the default getopt provided by some
  14 platforms.
  15 Usage: parse_option $SHORT_OPTS $LONG_OPTS "$@"
  16
  17 parseopts.sh:
  18 A getopt_long-like parser which portably supports longopts and shortopts
  19 with some GNU extensions. It does not allow for options with optional
  20 arguments. For both short and long opts, options requiring an argument
  21 should be suffixed with a colon. After the first argument containing
  22 the short opts, any number of valid long opts may be be passed. The end
  23 of the options delimiter must then be added, followed by the user arguments
  24 to the calling program.
  25
  26 Reccommended Usage:
  27   OPT_SHORT='fb:z'
  28   OPT_LONG=('foo' 'bar:' 'baz')
  29   if ! parseopts "$OPT_SHORT" "${OPT_LONG[@]}" -- "$@"; then
  30     exit 1
  31   fi
  32   set -- "${OPTRET[@]}"
  33 Returns:
  34   0: parse success
  35   1: parse failure (error message supplied)