Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

internals/content-encoding.md: fix the markdown links #526

Closed
wants to merge 1 commit into from
Closed

internals/content-encoding.md: fix the markdown links #526

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
26 changes: 13 additions & 13 deletions internals/content-encoding.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

## About content encodings

[HTTP/1.1][4] specifies that a client may request that a server encode its
HTTP/1.1 specifies that a client may request that a server encode its
response. This is usually used to compress a response using one (or more)
encodings from a set of commonly available compression techniques. These
schemes include `deflate` (the zlib algorithm), `gzip`, `br` (brotli) and
Expand Down Expand Up @@ -30,28 +30,28 @@

## The libcurl interface

To cause libcurl to request a content encoding use:
To ask libcurl make a request using content encoding, use:

[`curl_easy_setopt`][1](curl, [`CURLOPT_ACCEPT_ENCODING`][5], string)
curl_easy_setopt(curl, CURLOPT_ACCEPT_ENCODING, string);

where string is the intended value of the `Accept-Encoding` header.

Currently, libcurl does support multiple encodings but only understands how
to process responses that use the `deflate`, `gzip`, `zstd` and/or `br`
content encodings, so the only values for [`CURLOPT_ACCEPT_ENCODING`][5] that
work (besides `identity`, which does nothing) are `deflate`, `gzip`, `zstd`
and `br`. If a response is encoded using the `compress` or methods, libcurl
libcurl supports multiple encodings but only understands how to process
responses that use the `deflate`, `gzip`, `zstd` and/or `br` content
encodings, so the only values for `CURLOPT_ACCEPT_ENCODING` that work
(besides `identity`, which does nothing) are `deflate`, `gzip`, `zstd` and
`br`. If a response is encoded using the `compress` or methods, libcurl
returns an error indicating that the response could not be decoded. If
`<string>` is NULL no `Accept-Encoding` header is generated. If `<string>` is
a zero-length string, then an `Accept-Encoding` header containing all
supported encodings is generated.

The [`CURLOPT_ACCEPT_ENCODING`][5] must be set to any non-NULL value for
content to be automatically decoded. If it is not set and the server still
sends encoded content (despite not having been asked), the data is returned
in its raw form and the `Content-Encoding` type is not checked.
The `CURLOPT_ACCEPT_ENCODING` must be set to any non-NULL value for content
to be automatically decoded. If it is not set and the server still sends
encoded content (despite not having been asked), the data is returned in its
raw form and the `Content-Encoding` type is not checked.

## The curl interface

Use the [`--compressed`][6] option with curl to cause it to ask servers to
Use the `--compressed` option with curl to cause it to ask servers to
compress responses using any format supported by curl.
Loading