From: Brendon Smith <bws@bws.bio>
Date: Sun, 17 Nov 2024 21:38:31 +0000 (-0500)
Subject: docs: document default `User-Agent`
X-Git-Tag: curl-8_11_1~59
X-Git-Url: http://git.ipfire.org/?a=commitdiff_plain;h=dada880fc52f9cfb48bc652a42c06bfb26a91482;p=thirdparty%2Fcurl.git

docs: document default `User-Agent`

curl offers a `--user-agent` option for modifying the `User-Agent`
header supplied in its requests.

The man page section for this option explains how to use the
`--user-agent` option, but does not explain which `User-Agent` curl uses
by default.

By default, curl uses curl/VERSION, such as `User-Agent: curl/8.11.0`.

Note that this appears to be different from the libcurl default (no
User-Agent header).

This commit documents the default `User-Agent` in the man page section
for the `--user-agent` option, as well as on the "Art of Scripting"
page.

The `%VERSION` placeholder will be used to insert the current version
as described in the man page generator docs.

Closes #15608
---

diff --git a/docs/TheArtOfHttpScripting.md b/docs/TheArtOfHttpScripting.md
index f4efd11bb2..28314ea909 100644
--- a/docs/TheArtOfHttpScripting.md
+++ b/docs/TheArtOfHttpScripting.md
@@ -456,6 +456,8 @@ SPDX-License-Identifier: curl
  it is time to set the User Agent field to fool the server into thinking you
  are one of those browsers.
 
+ By default, curl uses curl/VERSION, such as User-Agent: curl/8.11.0.
+
  To make curl look like Internet Explorer 5 on a Windows 2000 box:
 
     curl --user-agent "Mozilla/4.0 (compatible; MSIE 5.01; Windows NT 5.0)" [URL]
diff --git a/docs/cmdline-opts/user-agent.md b/docs/cmdline-opts/user-agent.md
index 29b475857a..a24bd28449 100644
--- a/docs/cmdline-opts/user-agent.md
+++ b/docs/cmdline-opts/user-agent.md
@@ -25,3 +25,5 @@ be set with the --header or the --proxy-header options.
 If you give an empty argument to --user-agent (""), it removes the header
 completely from the request. If you prefer a blank header, you can set it to a
 single space (" ").
+
+By default, curl uses curl/VERSION, such as User-Agent: curl/`%VERSION`.