aboutsummaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorDaniel Stenberg <daniel@haxx.se>2016-05-01 13:29:11 +0200
committerDaniel Stenberg <daniel@haxx.se>2016-05-01 13:29:11 +0200
commitffd0e6193fceeccb2680088be023d2d1f7c5d49d (patch)
tree63e470c64b533139e9f6e3420d7db19ab874bb3d /docs
parent22aa34f74589cee68766f9d846e284115e12eb90 (diff)
CURLOPT_ACCEPT_ENCODING.3: clarified
As discussed in #785
Diffstat (limited to 'docs')
-rw-r--r--docs/libcurl/opts/CURLOPT_ACCEPT_ENCODING.316
1 files changed, 13 insertions, 3 deletions
diff --git a/docs/libcurl/opts/CURLOPT_ACCEPT_ENCODING.3 b/docs/libcurl/opts/CURLOPT_ACCEPT_ENCODING.3
index de3bc746f..3d172dcbe 100644
--- a/docs/libcurl/opts/CURLOPT_ACCEPT_ENCODING.3
+++ b/docs/libcurl/opts/CURLOPT_ACCEPT_ENCODING.3
@@ -32,21 +32,31 @@ Pass a char * argument specifying what encoding you'd like.
Sets the contents of the Accept-Encoding: header sent in a HTTP request, and
enables decoding of a response when a Content-Encoding: header is received.
-Three encodings are supported: \fIidentity\fP, which does nothing,
+Three encodings are supported: \fIidentity\fP, meaning non-compressed,
\fIdeflate\fP which requests the server to compress its response using the
zlib algorithm, and \fIgzip\fP which requests the gzip algorithm.
If a zero-length string is set like "", then an Accept-Encoding: header
containing all built-in supported encodings is sent.
+Set this option to NULL to explicitly disable it, which makes libcurl not send
+an Accept-Encoding: header and not decompress contents automatically.
+
You can also opt to just include the Accept-Encoding: header in your request
with \fICURLOPT_HTTPHEADER(3)\fP but then there will be no automatic
decompressing when receiving data.
This is a request, not an order; the server may or may not do it. This option
must be set (to any non-NULL value) or else any unsolicited encoding done by
-the server is ignored. See the special file lib/README.encoding for further
-details.
+the server is ignored.
+
+Servers might respond with Content-Encoding even without getting a
+Accept-Encoding: in the request. Servers might respond with a different
+Content-Encoding than what was asked for in the request.
+
+The Content-Length: servers send for a compressed response is supposed to be
+for the compressed content but sending the size for the non-compressed version
+of the resource is a very common mistake.
.SH DEFAULT
NULL
.SH PROTOCOLS