summaryrefslogtreecommitdiff
path: root/docs/cmdline-opts/head.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/head.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/head.d')
-rw-r--r--docs/cmdline-opts/head.d1
1 files changed, 1 insertions, 0 deletions
diff --git a/docs/cmdline-opts/head.d b/docs/cmdline-opts/head.d
index 6fe468511..06d2489d5 100644
--- a/docs/cmdline-opts/head.d
+++ b/docs/cmdline-opts/head.d
@@ -3,6 +3,7 @@ Short: I
Help: Show document info only
Protocols: HTTP FTP FILE
Category: http ftp file
+Example: -I $URL
---
Fetch the headers only! HTTP-servers feature the command HEAD which this uses
to get nothing but the header of a document. When used on an FTP or FILE file,