update README

README.org

@@ -23,7 +23,7 @@
     sftrst=$'\e[0m';sftbf=$'\e[1m';sftdim=$'\e[2m';sftul=$'\e[4m';sftblink=$'\e[5m';sftinv=$'\e[7m';sfthide=$'\e[8m';sftk=$'\e[30m';sftr=$'\e[31m';sftg=$'\e[32m';sfty=$'\e[33m';sftb=$'\e[34m';sftm=$'\e[35m';sftc=$'\e[36m';sftw=$'\e[97m';function _sferr { echo -e "${sftbf}${sftr}SF PARSE ERROR${sftrst} $1";exit 1;};function sferr { echo -e "${sftbf}${sftr}ERROR${sftrst} $1";if [ -z "$2" ];then exit 1;fi;};function sfwarn { echo -e "${sftbf}${sfty}WARNING${sftrst} $1";};OLDIFS=$IFS;IFS=";";_sfphead="";_sfpdesc="";_sfodesc="";_sfexamples="";_sfpargs=();declare -A _sfflags;declare -A _sfargs;for a in "${sfargs[@]}";do _sfsubst=${a//";"};_sfcount="$(((${#a} - ${#_sfsubst})))";if [ $_sfcount -eq 1 ];then read -r -a _sfparsearr<<<"${a}";_sfpargs+=("${_sfparsearr[0]}");_sfphead="$_sfphead ${_sfparsearr[0]}";_sfpdesc="$_sfpdesc  ${_sfparsearr[0]};${_sfparsearr[1]}\n";elif [ $_sfcount -eq 2 ];then read -r -a _sfparsearr<<<"${a}";_sfflags["-${_sfparsearr[1]}"]="${_sfparsearr[0]}";_sfflags["--${_sfparsearr[0]}"]="${_sfparsearr[0]}";declare ${_sfparsearr[0]}=false;_sfodesc="$_sfodesc  -${_sfparsearr[1]}, --${_sfparsearr[0]};${_sfparsearr[2]}\n";elif [ $_sfcount -eq 4 ];then read -r -a _sfparsearr<<<"${a}";_sfargs["-${_sfparsearr[1]}"]="${_sfparsearr[0]}";_sfargs["--${_sfparsearr[0]}"]="${_sfparsearr[0]}";declare ${_sfparsearr[0]}="${_sfparsearr[3]}";_sfodesc="$_sfodesc  -${_sfparsearr[1]}, --${_sfparsearr[0]} ${_sfparsearr[2]};${_sfparsearr[4]} (default: ${_sfparsearr[3]})\n";else _sferr "Wrong argument declaration: $a";fi;done;for e in "${sfexamples[@]}";do _sfsubst=${e//";"};_sfcount="$(((${#e} - ${#_sfsubst})))";if [ $_sfcount -eq 1 ];then read -r -a _sfparsearr<<<"${e}";_sfexamples="$_sfexamples  ${_sfparsearr[0]};${_sfparsearr[1]}\n";else _sferr "Wrong example declaration: $e";fi;done;IFS=$OLDIFS;function sfusage { echo -n "Usage: $(basename $0)";if [ "$_sfodesc" != "" ];then echo -n " OPTIONS";fi;echo -e "$_sfphead";if [ ! -z ${sfdesc+x} ];then echo -e "\n$sfdesc";fi;if [ "$_sfpdesc" != "" ];then echo -e "\nPOSITIONAL ARGUMENTS";echo -e "$_sfpdesc"|column -c 80 -s ";" -t -W 2;fi;if [ "$_sfodesc" != "" ];then echo -e "\nOPTIONS";echo -e "$_sfodesc"|column -c 80 -s ";" -t -W 2;fi;if [ "$_sfexamples" != "" ];then echo -e "\nEXAMPLES";echo -e "$_sfexamples"|column -c 80 -s ";" -t -W 2;fi;if [ ! -z ${sfextra+x} ];then echo -e "\n$sfextra";fi;exit 0;};for a in "$@";do if [ "$a" == "-h" ]||[ "$a" == "--help" ];then sfusage;fi;done;while(("$#"));do if [ ! -z ${_sfflags["$1"]} ];then declare ${_sfflags["$1"]}=true;elif [ ! -z ${_sfargs["$1"]} ];then if [ -n "$2" ]&&[ "${2:0:1}" != "-" ];then declare ${_sfargs["$1"]}="$2";shift;else sferr "Argument for '$1' missing";fi;else if [ "${1:0:1}" == "-" ];then sferr "Unsupported argument: $1";else if [ "${#_sfpargs[@]}" != 0 ];then declare ${_sfpargs[0]}="$1";_sfpargs=("${_sfpargs[@]:1}");else sferr "Too many positional arguments";fi;fi;fi;shift;done;if [ ${#_sfpargs[@]} != 0 ];then for p in "${_sfpargs[@]}";do sferr "Positional argument '$p' missing" 0;done;exit 1;fi
   #+end_src
 
-* Usage
+** Usage
 
    The general usage for writing a script with /sf/ is:
 
@@ -31,7 +31,7 @@
    2. Include /sf/
    3. Write your script with already parsed arguments and useful output functions/text formatting variables
 
-** 1. /sf/-variables
+*** 1. /sf/-variables
 
     This is the list of variables which can be set *before* including /sf/.
     Every variable is optional.
@@ -45,7 +45,7 @@
 
     A complete example which uses every variable can be found [[#example][below]].
 
-*** =sfargs=
+**** =sfargs=
      :properties:
      :custom_id: sfargs
      :end:
@@ -62,7 +62,7 @@
 
      The order of declaration defines the order in the usage output.
 
-*** =sfexamples=
+**** =sfexamples=
      :properties:
      :custom_id: sfexamples
      :end:
@@ -72,7 +72,7 @@
 
      : sfexamples+=("count 8;Count to eight")
 
-** 2. Including /sf/
+*** 2. Include /sf/
 
     Grab the =sf= file from the repo, place it next to your script and source it with
 
@@ -82,7 +82,7 @@
 
     *Or* just copy and paste the oneliner from above.
 
-** 3. Write your script
+*** 3. Write your script
 
     /sf/ deals with missing inputs and handles the parsing of arguments.
     This means that after /sf/ was included *you can be sure that all variables have assigned values*.
@@ -97,7 +97,7 @@
 
     Then the variable =$verbose= exists with a value of either =false= or =true=.
 
-*** Output functions
+**** Output functions
 
      /sf/ provides two output functions which can be used to throw warnings and errors.
 
@@ -108,7 +108,7 @@
 
      | =sfusage= | Output the usage of the script and exit with code 0 |
 
-*** Text formatting variables
+**** Text formatting variables
 
      The following text formatting variables can be used to modify the output:
 
@@ -135,7 +135,7 @@
        echo "${sftbf}${sftr}framework${sftrst}"
      #+end_src
 
-* Example
+** Example
    :properties:
    :custom_id: example
    :end: