aboutsummaryrefslogtreecommitdiffstats
path: root/docs/libcurl/opts/CURLOPT_ACCEPT_ENCODING.3
diff options
context:
space:
mode:
authorTreehugger Robot <treehugger-gerrit@google.com>2018-10-30 23:00:37 +0000
committerGerrit Code Review <noreply-gerritcodereview@google.com>2018-10-30 23:00:37 +0000
commit849332cb73701636b19b97f3d82e8e9fa0d51a30 (patch)
tree24facefd22d2ca56694f740049660701da90ee9a /docs/libcurl/opts/CURLOPT_ACCEPT_ENCODING.3
parent8c49d19ccbe7df4ce7b150f5d92eaddcc7f369df (diff)
parentb1ef70f7d9fdfa1431b948df6ae7bb0b15966dee (diff)
downloadexternal_curl-849332cb73701636b19b97f3d82e8e9fa0d51a30.tar.gz
external_curl-849332cb73701636b19b97f3d82e8e9fa0d51a30.tar.bz2
external_curl-849332cb73701636b19b97f3d82e8e9fa0d51a30.zip
Diffstat (limited to 'docs/libcurl/opts/CURLOPT_ACCEPT_ENCODING.3')
-rw-r--r--docs/libcurl/opts/CURLOPT_ACCEPT_ENCODING.316
1 files changed, 12 insertions, 4 deletions
diff --git a/docs/libcurl/opts/CURLOPT_ACCEPT_ENCODING.3 b/docs/libcurl/opts/CURLOPT_ACCEPT_ENCODING.3
index 6b3e0fc1..9b7044f5 100644
--- a/docs/libcurl/opts/CURLOPT_ACCEPT_ENCODING.3
+++ b/docs/libcurl/opts/CURLOPT_ACCEPT_ENCODING.3
@@ -20,7 +20,7 @@
.\" *
.\" **************************************************************************
.\"
-.TH CURLOPT_ACCEPT_ENCODING 3 "May 22, 2018" "libcurl 7.61.0" "curl_easy_setopt options"
+.TH CURLOPT_ACCEPT_ENCODING 3 "August 27, 2018" "libcurl 7.61.1" "curl_easy_setopt options"
.SH NAME
CURLOPT_ACCEPT_ENCODING \- enables automatic decompression of HTTP downloads
@@ -46,10 +46,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
@@ -89,6 +93,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.