romenskiy2012/curl
1
0
Fork 0
mirror of https://github.com/curl/curl.git synced 2026-07-27 03:57:16 +03:00
Code Issues Projects Releases Packages Wiki Activity

curl.1: provide examples for each option

Browse source 
The file format for each option now features a "Example:" header that
can provide one or more examples that get rendered appropriately in the
output. All options MUST have at least one example or gen.pl complains
at build-time.

This fix also does a few other minor format and consistency cleanups.

Closes #7654
This commit is contained in:
Daniel Stenberg 2021-08-31 16:37:14 +02:00
parent c905459e87
commit 68784d73c3
No known key found for this signature in database
GPG key ID: 5CC908FDB71E12C2
245 changed files with 348 additions and 53 deletions
Download patch file Download diff file Expand all files Collapse all files

6
src/tool_help.c
View file

@ -169,7 +169,7 @@ static const struct helptxt helptext[] = {
{"-K, --config <file>",
"Read config from a file",
CURLHELP_CURL},
{" --connect-timeout <seconds>",
{" --connect-timeout <fractional seconds>",
"Maximum time allowed for connection",
CURLHELP_CONNECTION},
{" --connect-to <HOST1:PORT1:HOST2:PORT2>",
@ -194,7 +194,7 @@ static const struct helptxt helptext[] = {
"Convert LF to CRLF in upload",
CURLHELP_FTP | CURLHELP_SMTP},
{" --crlfile <file>",
"Get a CRL list in PEM format from the given file",
"Use this CRL list",
CURLHELP_TLS},
{" --curves <algorithm list>",
"(EC) TLS key exchange algorithm(s) to request",
@ -442,7 +442,7 @@ static const struct helptxt helptext[] = {
{" --max-redirs <num>",
"Maximum number of redirects allowed",
CURLHELP_HTTP},
{"-m, --max-time <seconds>",
{"-m, --max-time <fractional seconds>",
"Maximum time allowed for the transfer",
CURLHELP_CONNECTION},
{" --metalink",