gsu com_help(): Be more strict when looking for command documentation.

[gsu.git] / funcs / gsu

diff --git a/funcs/gsu b/funcs/gsu
index cef33b2f903e5e88c3d7187246a502ae4a4b8bd2..df25bf63c429ca9873024a2dd4e8283be161143c 100644 (file)
--- a/funcs/gsu
+++ b/funcs/gsu
@@ -98,13 +98,13 @@ export -f gsu_date_msg
 
 _gsu_banner_msg()
 {
-       local txt="*** $_gsu_self --"
+       local txt="### $_gsu_self --"
        if test -z "$gsu_banner_txt"; then
                txt="$txt set \$gsu_banner_txt to customize this message"
        else
                txt="$txt $gsu_banner_txt"
        fi
-       gsu_short_msg "$txt ***"
+       gsu_short_msg "$txt ###"
 }
 export -f _gsu_banner_msg
 
@@ -133,7 +133,7 @@ export -f gsu_err_msg
 
 _gsu_usage()
 {
-       gsu_short_msg "Usage: $_gsu_self command [options]"
+       gsu_short_msg "# Usage: $_gsu_self command [options]"
 }
 export -f _gsu_usage
 
@@ -175,7 +175,7 @@ Usage: prefs
 
 Print out a list of all cmt config variables, together with their current value
 and the default value."
-com_prefs()
+_com_prefs()
 {
        local i
 
@@ -203,14 +203,14 @@ com_prefs()
                echo
        done
 }
-export -f com_prefs
+export -f _com_prefs
 
 export gsu_man_txt="
 Print the manual.
 
 Usage: man"
 
-com_man()
+_com_man()
 {
        local equal_signs="=================================================="
        local minus_signs="--------------------------------------------------"
@@ -247,7 +247,7 @@ com_man()
         done
         ret=$GSU_SUCCESS
 }
-export -f com_man
+export -f _com_man
 
 export gsu_help_txt="
 Print online help.
@@ -257,19 +257,18 @@ Usage: help [command]
 Without arguments, print the list of available commands. Otherwise,
 print the help text for the given command."
 
-com_help()
+_com_help()
 {
        local a b
        if test -z "$1"; then
                _gsu_banner_msg 2>&1
                _gsu_usage 2>&1
-               # sed is magic, baby
-               (printf "com_help()\n$gsu_help_txt" | head -n 4; echo "--"
-               printf "com_man()\n$gsu_man_txt" | head -n 4; echo "--"
-               printf "com_prefs()\n$gsu_prefs_txt" | head -n 4; echo "--"
-
-               grep -A 2 "^com_\([a-zA-Z_0-9]\+\)()" $0) \
-                       | grep -v -- '--' \
+               {
+                       printf "com_help()\n$gsu_help_txt" | head -n 4; echo "--"
+                       printf "com_man()\n$gsu_man_txt" | head -n 4; echo "--"
+                       printf "com_prefs()\n$gsu_prefs_txt" | head -n 4; echo "--"
+                       grep -A 2 "^com_\([a-zA-Z_0-9]\+\)()" $0
+               } | grep -v -- '--' \
                        | sed -e '/^com_\([a-zA-Z_0-9]\+\)()/bs' \
                                -e 'H;$!d;x;s/\n//g;b' \
                                -e :s \
@@ -284,7 +283,7 @@ com_help()
                                echo "$b"
                         done
                echo
-               echo "Try $_gsu_self help <command> for info on <command>."
+               echo "# Try $_gsu_self help <command> for info on <command>."
                ret=$GSU_SUCCESS
                return
        fi
@@ -305,14 +304,14 @@ com_help()
        fi
        ret=$GSU_SUCCESS
        if grep -q "^com_$1()" $0; then
-               sed -e "1,/com_$1()/d" -e '/^{/,$d' -e 's/^## *//' $0
+               sed -e "1,/^com_$1()$/d" -e '/^{/,$d' -e 's/^## *//' $0
                return
        fi
        _gsu_print_available_commands
        result="$1"
        ret=-$E_GSU_BAD_COMMAND
 }
-export -f com_help
+export -f _com_help
 
 # internal gsu function that syntactically checks the gsu_options array
 # for errors and parses the config file.
@@ -419,6 +418,17 @@ gsu()
        fi
        arg="$1"
        shift
+       # check internal commands
+       if [[ "$arg" = "help" || "$arg" = "man" || "$arg" = "prefs" ]]; then
+               _com_$arg "$@"
+               if [[ "$ret" -lt 0 ]]; then
+                       gsu_err_msg
+                       exit 1
+               fi
+               exit 0
+       fi
+
+       # external commands
        for i in $gsu_cmds; do
                if test "$arg" = "$i"; then
                        com_$arg "$@"
@@ -429,6 +439,7 @@ gsu()
                        exit 0
                fi
        done
+
        ret=-$E_GSU_BAD_COMMAND
        result="$arg"
        gsu_err_msg