Document default User-Agent
#15608
Closed
Document default User-Agent
#15608
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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 will document 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.
bagder
reviewed
Nov 17, 2024
docs/TheArtOfHttpScripting.md
Outdated
| @@ -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/`%VERSION`. | |||
There was a problem hiding this comment.
The %VERSION variable expansion does not work in this document. It should probably spell out an example version verbatim.
There was a problem hiding this comment.
@bagder thank you for clarifying. Updated with hard-coded example version number.
bagder
approved these changes
Nov 17, 2024
|
Thanks! |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
curl offers a
--user-agentoption for modifying theUser-Agentheader supplied in its requests.The man page section for this option explains how to use the
--user-agentoption, but does not explain whichUser-Agentcurl uses by default.By default, curl uses curl/VERSION, such as
User-Agent: curl/8.11.0.curl/src/tool_paramhlp.c
Lines 638 to 644 in ca6d3d2
curl/scripts/mk-ca-bundle.pl
Line 357 in ca6d3d2
Note that this appears to be different from the libcurl default (no header).
curl/docs/libcurl/opts/CURLOPT_USERAGENT.md
Lines 41 to 43 in ca6d3d2
Changes
This pull request will document the default
User-Agentin the man page section for the--user-agentoption, as well as on the "Art of Scripting" page.The
%VERSIONplaceholder will be used to insert the current version as described in the man page generator docs.curl/docs/cmdline-opts/MANPAGE.md
Lines 98 to 102 in ca6d3d2
Related