summaryrefslogtreecommitdiff
path: root/docs/cmdline-opts/proto-default.d
diff options
context:
space:
mode:
authorDaniel Stenberg <daniel@haxx.se>2021-08-31 16:37:14 +0200
committerDaniel Stenberg <daniel@haxx.se>2021-09-01 14:02:43 +0200
commit68784d73c3f8bc0d14502b4e1e930b1741c41699 (patch)
treeb1d7a129e2d43da0bfac6bba56a0b53912a9b026 /docs/cmdline-opts/proto-default.d
parentc905459e878690942e9a0a8cd7f9ad57b6898efb (diff)
downloadcurl-68784d73c3f8bc0d14502b4e1e930b1741c41699.tar.gz
curl.1: provide examples for each option
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
Diffstat (limited to 'docs/cmdline-opts/proto-default.d')
-rw-r--r--docs/cmdline-opts/proto-default.d9
1 files changed, 3 insertions, 6 deletions
diff --git a/docs/cmdline-opts/proto-default.d b/docs/cmdline-opts/proto-default.d
index 74d3932cf..a659b840d 100644
--- a/docs/cmdline-opts/proto-default.d
+++ b/docs/cmdline-opts/proto-default.d
@@ -3,17 +3,14 @@ Help: Use PROTOCOL for any URL missing a scheme
Arg: <protocol>
Added: 7.45.0
Category: connection curl
+Example: --proto-default https ftp.example.com
---
Tells curl to use *protocol* for any URL missing a scheme name.
-Example:
-
- curl --proto-default https ftp.mozilla.org
-
An unknown or unsupported protocol causes error
*CURLE_UNSUPPORTED_PROTOCOL* (1).
This option does not change the default proxy protocol (http).
-Without this option curl would make a guess based on the host, see --url for
-details.
+Without this option set, curl guesses protocol based on the host name, see
+--url for details.