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

CURLOPT_HTTPHEADER.md: rephrases

Browse Source 
An attempt to use better language

Closes #16461
This commit is contained in:
Daniel Stenberg 2025-02-24 22:03:38 +01:00
parent 413b2a44a8
commit b930142d12
No known key found for this signature in database
GPG Key ID: 5CC908FDB71E12C2
1 changed files with 17 additions and 14 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

31
docs/libcurl/opts/CURLOPT_HTTPHEADER.md
View File

@ -42,21 +42,24 @@ header list establishes the document-level MIME headers to prepend to the
uploaded document described by CURLOPT_MIMEPOST(3). This does not affect raw uploaded document described by CURLOPT_MIMEPOST(3). This does not affect raw
mail uploads. mail uploads.
The linked list should be a fully valid list of **struct curl_slist** structs When used with HTTP, this option can add new headers, replace internal headers
properly filled in. Use curl_slist_append(3) to create the list and and remove internal headers.
curl_slist_free_all(3) to clean up an entire list. If you add a header that is
otherwise generated and used by libcurl internally, your added header is used
instead. If you add a header with no content as in 'Accept:' (no data on the
right side of the colon), the internally used header is disabled/removed. With
this option you can add new headers, replace internal headers and remove
internal headers. To add a header with no content (nothing to the right side
of the colon), use the form 'name;' (note the ending semicolon).
The headers included in the linked list **must not** be CRLF-terminated, The linked list should be a valid list of **struct curl_slist** entries
because libcurl adds CRLF after each header item itself. Failure to comply properly filled in. Use curl_slist_append(3) to create the list and
with this might result in strange behavior. libcurl passes on the verbatim curl_slist_free_all(3) to free it again after use.
strings you give it, without any filter or other safe guards. That includes
white space and control characters. If you provide a header that is otherwise generated and used by libcurl
internally, your header alternative is used instead. If you provide a header
without content (no data on the right side of the colon) as in `Accept:`, the
internally used header is removed. To forcibly add a header without content
(nothing after the colon), use the form `name;` (using a trailing semicolon).
The headers included in the linked list **must not** be CRLF-terminated, since
libcurl adds CRLF after each header item itself. Failure to comply with this
might result in strange behavior. libcurl passes on the verbatim strings you
give it, without any filter or other safe guards. That includes white space
and control characters.
The first line in an HTTP request (containing the method, usually a GET or The first line in an HTTP request (containing the method, usually a GET or
POST) is not a header and cannot be replaced using this option. Only the lines POST) is not a header and cannot be replaced using this option. Only the lines