luo980/curl
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

curl: list categories in --help

Browse Source 
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
This commit is contained in:
Dan Fandrich 2024-06-28 14:41:29 -07:00 committed by Daniel Stenberg
parent ac7035925a
commit 6483813be2
No known key found for this signature in database
GPG Key ID: 5CC908FDB71E12C2
2 changed files with 37 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

36
src/tool_help.c
View File

@ -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...] <url>");
/* 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"))

6
tests/data/test1461
View File

@ -45,8 +45,10 @@ Usage: curl [options...] <url>
-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".
</stdout>
</verify>