From 6483813be2278644600434866f04406d3af81adf Mon Sep 17 00:00:00 2001 From: Dan Fandrich Date: Fri, 28 Jun 2024 14:41:29 -0700 Subject: [PATCH] curl: list categories in --help This eliminates the need to run an extra help subcommand to get the possible categories, reducing the friction in getting relevant help. The help wording was also slightly tweaked for grammatical accuracy. Closes #14055 --- src/tool_help.c | 36 +++++++++++++++++++++++++++++++++--- tests/data/test1461 | 6 ++++-- 2 files changed, 37 insertions(+), 5 deletions(-) diff --git a/src/tool_help.c b/src/tool_help.c index bd231eb14b..a3df3b14b6 100644 --- a/src/tool_help.c +++ b/src/tool_help.c @@ -129,6 +129,33 @@ static void get_categories(void) printf(" %-11s %s\n", categories[i].opt, categories[i].desc); } +/* Prints all categories as a comma-separated list of given width */ +static void get_categories_list(unsigned int width) +{ + unsigned int i; + size_t col = 0; + for(i = 0; categories[i].opt; ++i) { + size_t len = strlen(categories[i].opt); + if(!categories[i + 1].opt) { + /* final category */ + if(col + len + 1 < width) + printf("%s.\n", categories[i].opt); + else + /* start a new line first */ + printf("\n%s.\n", categories[i].opt); + } + else if(col + len + 2 < width) { + printf("%s, ", categories[i].opt); + col += len + 2; + } + else { + /* start a new line first */ + printf("\n%s, ", categories[i].opt); + col = len + 2; + } + } +} + void tool_help(char *category) { @@ -136,12 +163,15 @@ void tool_help(char *category) puts("Usage: curl [options...] "); /* If no category was provided */ if(!category) { - const char *category_note = "\nThis is not the full help, this " - "menu is stripped into categories.\nUse \"--help category\" to get " - "an overview of all categories.\nFor all options use the manual" + const char *category_note = "\nThis is not the full help; this " + "menu is split into categories.\nUse \"--help category\" to get " + "an overview of all categories, which are:"; + const char *category_note2 = "For all options use the manual" " or \"--help all\"."; print_category(CURLHELP_IMPORTANT, cols); puts(category_note); + get_categories_list(cols); + puts(category_note2); } /* Lets print everything if "all" was provided */ else if(curl_strequal(category, "all")) diff --git a/tests/data/test1461 b/tests/data/test1461 index 424af943fc..e9a93b5a97 100644 --- a/tests/data/test1461 +++ b/tests/data/test1461 @@ -45,8 +45,10 @@ Usage: curl [options...] -v, --verbose Make the operation more talkative -V, --version Show version number and quit -This is not the full help, this menu is stripped into categories. -Use "--help category" to get an overview of all categories. +This is not the full help; this menu is split into categories. +Use "--help category" to get an overview of all categories, which are: +auth, connection, curl, dns, file, ftp, http, imap, misc, output, pop3, post, +proxy, scp, sftp, smtp, ssh, telnet, tftp, tls, ech, upload, verbose. For all options use the manual or "--help all". -- 2.47.3