diff options
| author | Daniel Stenberg <daniel@haxx.se> | 2018-05-22 08:23:30 +0200 |
|---|---|---|
| committer | Daniel Stenberg <daniel@haxx.se> | 2018-05-22 08:23:30 +0200 |
| commit | 2ceab09451ba85b1fc85b73dac2269e97f206e1e (patch) | |
| tree | eca43ecffc9a63afb7f22d7f9cbfa89434eb09fb | |
| parent | 3ba334f6e78d6409ea6918f4c2d5d6b999b29685 (diff) | |
CURLOPT_ACCEPT_ENCODING.3: add brotli and clarify a bit
| -rw-r--r-- | docs/libcurl/opts/CURLOPT_ACCEPT_ENCODING.3 | 20 |
1 files changed, 14 insertions, 6 deletions
diff --git a/docs/libcurl/opts/CURLOPT_ACCEPT_ENCODING.3 b/docs/libcurl/opts/CURLOPT_ACCEPT_ENCODING.3 index 1e1f76f45..9427a6b1d 100644 --- a/docs/libcurl/opts/CURLOPT_ACCEPT_ENCODING.3 +++ b/docs/libcurl/opts/CURLOPT_ACCEPT_ENCODING.3 @@ -5,7 +5,7 @@ .\" * | (__| |_| | _ <| |___ .\" * \___|\___/|_| \_\_____| .\" * -.\" * Copyright (C) 1998 - 2016, Daniel Stenberg, <daniel@haxx.se>, et al. +.\" * Copyright (C) 1998 - 2018, Daniel Stenberg, <daniel@haxx.se>, et al. .\" * .\" * This software is licensed as described in the file COPYING, which .\" * you should have received as part of this distribution. The terms @@ -32,12 +32,20 @@ Pass a char * argument specifying what encoding you'd like. Sets the contents of the Accept-Encoding: header sent in an HTTP request, and enables decoding of a response when a Content-Encoding: header is received. -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. +libcurl potentially supports several different compressed encodings depending +on what support that has been built-in. + +To aid applications not having to bother about what specific algorithms this +particular libcurl build supports, libcurl allows a zero-length string to be +set ("") to ask for an Accept-Encoding: header to be used that contains all +built-in supported encodings. + +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. Set this option to NULL to explicitly disable it, which makes libcurl not send an Accept-Encoding: header and not decompress contents automatically. |