rename "synopsis" to "usage".
[paraslash.git] / command_util.sh
index d6626c253057675cceedb689d82957d607911a20..326bb032abfa827b21ea4d09f524cc7266938680 100755 (executable)
@@ -15,7 +15,7 @@ dump_array_member()
                echo ".perms = $perms_txt,"
        fi
        echo ".description = \"$desc_txt\","
-       echo ".synopsis = \"$syn_txt\","
+       echo ".usage = \"$usage_txt\","
        echo ".help = "
        echo "$help_txt" | sed -e 's/^/\"/g' -e 's/$/\\n\"/g'
        echo '},'
@@ -68,7 +68,7 @@ read_one_command()
 
        name_txt=""
        desc_txt=""
-       syn_txt=""
+       usage_txt=""
        help_txt=""
        perms_txt=""
        line_handler=0
@@ -90,8 +90,8 @@ read_one_command()
                L:)
                        line_handler=1
                        ;;
-               S:)
-                       syn_txt="$value"
+               U:)
+                       usage_txt="$value"
                        ;;
                H:)
                        help_txt="${value}"
@@ -107,12 +107,12 @@ ${line# }"
                        ;;
                esac
        done
-       if test -n "$name_txt" -a -n "$desc_txt" -a -n "$syn_txt" \
+       if test -n "$name_txt" -a -n "$desc_txt" -a -n "$usage_txt" \
                        -a -n "$help_txt"; then
                ret=1
                return
        fi
-       if test -z "$name_txt" -a -z "$desc_txt" -a -z "$syn_txt" \
+       if test -z "$name_txt" -a -z "$desc_txt" -a -z "$usage_txt" \
                        -a -z "$help_txt"; then
                ret=0
                return
@@ -122,7 +122,7 @@ ${line# }"
        echo "!ERROR!"
        echo "N: $name_txt"
        echo "D: $desc_txt"
-       echo "S: $syn_txt"
+       echo "S: $usage_txt"
        echo "P: $perms_txt"
        echo "H: $help_txt"
 }
@@ -132,7 +132,7 @@ dump_man()
        echo ".SS \"$name_txt\""
        echo "$desc_txt"
        echo
-       echo "\\fBusage: \\fP$syn_txt"
+       echo "\\fBusage: \\fP$usage_txt"
        echo
        echo "$help_txt"
        echo
@@ -150,7 +150,6 @@ dump_man()
 
 com_man()
 {
-       local n
        echo "[$section_name]"
        echo
        while : ; do
@@ -161,10 +160,7 @@ com_man()
                if test $ret -eq 0; then
                        break
                fi
-               dump_man #> $txtdir/$n.txt
-#              txt2man -t "$n" -r "$r"  < $txtdir/$n.txt \
-#                      | sed -e 1d > $mandir/$n.1
-#              man2html $mandir/$n.1 > $htmldir/$n.html
+               dump_man
        done
 }
 
@@ -199,7 +195,7 @@ dump_proto()
                echo ' * \param cmdline the full command line'
        fi
        echo ' * '
-       echo " * synopsis: $syn_txt"
+       echo " * usage: $usage_txt"
        echo ' * '
        echo "$help_txt" | sed -e 's/^/ * /g'
        echo ' */'