]> git.tuebingen.mpg.de Git - dss.git/commitdiff
Implement help subommand.
authorAndre Noll <maan@tuebingen.mpg.de>
Sun, 28 Apr 2024 02:01:50 +0000 (04:01 +0200)
committerAndre Noll <maan@tuebingen.mpg.de>
Mon, 20 May 2024 18:00:17 +0000 (20:00 +0200)
dss.c
dss.suite

diff --git a/dss.c b/dss.c
index 0992ec6fd18651f85c2bab2c7d8d45603b3a786c..06e0d6a11612e0706d1b4e22495512f2a8cba779 100644 (file)
--- a/dss.c
+++ b/dss.c
@@ -1824,15 +1824,18 @@ static void handle_version_and_help(void)
 {
        char *txt;
 
+       if (OPT_GIVEN(DSS, VERSION)) {
+               printf(VERSION_STRING "\n");
+               exit(EXIT_SUCCESS);
+       }
        if (OPT_GIVEN(DSS, DETAILED_HELP))
                txt = lls_long_help(CMD_PTR(DSS));
        else if (OPT_GIVEN(DSS, HELP))
                txt = lls_short_help(CMD_PTR(DSS));
-       else if (OPT_GIVEN(DSS, VERSION))
-               txt = make_message("%s\n", VERSION_STRING);
        else
                return;
        printf("%s", txt);
+       printf("\nRun dss help for help on subcommands.\n");
        free(txt);
        exit(EXIT_SUCCESS);
 }
@@ -1848,8 +1851,39 @@ static void show_subcommand_summary(void)
                const char *purpose = lls_purpose(cmd);
                printf("%-11s%s\n", name, purpose);
        }
-       exit(EXIT_SUCCESS);
+       printf("\nRun dss help <subcmd> for help on <subcmd>.\n");
+}
+
+static int com_help(void)
+{
+       int ret;
+       char *errctx, *help;
+       const char *arg;
+       const struct lls_command *cmd;
+
+       ret = lls_check_arg_count(sublpr, 0, 1, &errctx);
+       if (ret < 0)
+               return lopsub_error(ret, &errctx);
+       if (lls_num_inputs(sublpr) == 0) {
+               show_subcommand_summary();
+               return 0;
+       }
+       arg = lls_input(0, sublpr);
+       ret = lls_lookup_subcmd(arg, dss_suite, &errctx);
+       if (ret < 0)
+               return lopsub_error(ret, &errctx);
+       cmd = lls_cmd(ret, dss_suite);
+       if (OPT_GIVEN(HELP, LONG))
+               help = lls_long_help(cmd);
+       else
+               help = lls_short_help(cmd);
+       printf("%s", help);
+       free(help);
+       if (!OPT_GIVEN(HELP, LONG))
+               printf("\nRun dss -- help -l %s for long help.\n", arg);
+       return 0;
 }
+EXPORT_CMD_HANDLER(help);
 
 int main(int argc, char **argv)
 {
@@ -1869,8 +1903,11 @@ int main(int argc, char **argv)
                goto out;
        handle_version_and_help();
        num_inputs = lls_num_inputs(lpr);
-       if (num_inputs == 0)
+       if (num_inputs == 0) {
                show_subcommand_summary();
+               ret = 0;
+               goto out;
+       }
        ret = lls_lookup_subcmd(argv[argc - num_inputs], dss_suite, &errctx);
        if (ret < 0) {
                ret = lopsub_error(ret, &errctx);
index f9cf8af5993345452fddc7b3d9790d0d7e6d7a13..94b48677dff67bb01b1fe67e09767d27f3a30cd1 100644 (file)
--- a/dss.suite
+++ b/dss.suite
@@ -540,7 +540,23 @@ caption = Subcommands
                exits successfully or prints information about the first syntax error
                detected and terminates with exit code 1.
        [/description]
-
+[subcommand help]
+       purpose = list available subcommands or print subcommand-specific help
+       non-opts-name = [subcommand]
+       [description]
+               If the optional subcommand argument is given, the help text of that
+               subcommand is shown. Without the argument the available subcommands
+               are listed instead.
+       [/description]
+       [option long]
+               short_opt = l
+               summary = show the long help text of a subcommand
+               [help]
+                       If this option is given, the command also shows the description of
+                       the subcommand and the help text of each option, Otherwise only the
+                       purpose, the synopsis and the option list of the subcommand is shown.
+                       If no subcommand is supplied, the option has no effect.
+               [/help]
 [section copyright]
        Written by Andre Noll
        .br