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

docs: document default User-Agent

Browse Source 
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
This commit is contained in:
Brendon Smith 2024-11-17 16:38:31 -05:00 committed by Daniel Stenberg
parent ca6d3d2e9b
commit dada880fc5
No known key found for this signature in database
GPG Key ID: 5CC908FDB71E12C2
2 changed files with 4 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
docs/TheArtOfHttpScripting.md
View File

@ -456,6 +456,8 @@ SPDX-License-Identifier: curl
it is time to set the User Agent field to fool the server into thinking you it is time to set the User Agent field to fool the server into thinking you
are one of those browsers. 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: 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] curl --user-agent "Mozilla/4.0 (compatible; MSIE 5.01; Windows NT 5.0)" [URL]

2
docs/cmdline-opts/user-agent.md
View File

@ -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 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 completely from the request. If you prefer a blank header, you can set it to a
single space (" "). single space (" ").
By default, curl uses curl/VERSION, such as User-Agent: curl/`%VERSION`.