]> granicus.if.org Git - curl/commitdiff
CURLOPT_ACCEPT_ENCODING.3: list them comma-separated [ci skip]
authorDaniel Stenberg <daniel@haxx.se>
Mon, 27 Aug 2018 09:15:21 +0000 (11:15 +0200)
committerDaniel Stenberg <daniel@haxx.se>
Mon, 27 Aug 2018 09:16:23 +0000 (11:16 +0200)
docs/libcurl/opts/CURLOPT_ACCEPT_ENCODING.3

index 9427a6b1d813b8c36bb36e0ca8a2793bd06a3d13..abd4734abc15c5345d3a63c3967b350ff2973d56 100644 (file)
@@ -45,10 +45,14 @@ Alternatively, you can specify exactly the encoding or list of encodings you
 want in the response. Four encodings are supported: \fIidentity\fP, meaning
 non-compressed, \fIdeflate\fP which requests the server to compress its
 response using the zlib algorithm, \fIgzip\fP which requests the gzip
-algorithm and (since curl 7.57.0) \fIbr\fP which is brotli.
+algorithm and (since curl 7.57.0) \fIbr\fP which is brotli.  Provide them in
+the string as a comma-separated list of accepted encodings, like:
 
-Set this option to NULL to explicitly disable it, which makes libcurl not send
-an Accept-Encoding: header and not decompress contents automatically.
+  "br, gzip, deflate".
+
+Set \fICURLOPT_ACCEPT_ENCODING(3)\fP to NULL to explicitly disable it, which
+makes libcurl not send an Accept-Encoding: header and not decompress received
+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
@@ -88,6 +92,10 @@ if(curl) {
 .fi
 .SH AVAILABILITY
 This option was called CURLOPT_ENCODING before 7.21.6
+
+The specific libcurl you're using must have been built with zlib to be able to
+decompress gzip and deflate responses and with the brotli library to
+decompress brotli responses.
 .SH RETURN VALUE
 Returns CURLE_OK if the option is supported, CURLE_UNKNOWN_OPTION if not, or
 CURLE_OUT_OF_MEMORY if there was insufficient heap space.