docs/libcurl/opts/CURLOPT_ACCEPT_ENCODING.3

   1 .\" **************************************************************************
   2 .\" *                                  _   _ ____  _
   3 .\" *  Project                     ___| | | |  _ \| |
   4 .\" *                             / __| | | | |_) | |
   5 .\" *                            | (__| |_| |  _ <| |___
   6 .\" *                             \___|\___/|_| \_\_____|
   7 .\" *
   8 .\" * Copyright (C) 1998 - 2016, Daniel Stenberg, <daniel@haxx.se>, et al.
   9 .\" *
  10 .\" * This software is licensed as described in the file COPYING, which
  11 .\" * you should have received as part of this distribution. The terms
  12 .\" * are also available at https://curl.haxx.se/docs/copyright.html.
  13 .\" *
  14 .\" * You may opt to use, copy, modify, merge, publish, distribute and/or sell
  15 .\" * copies of the Software, and permit persons to whom the Software is
  16 .\" * furnished to do so, under the terms of the COPYING file.
  17 .\" *
  18 .\" * This software is distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY
  19 .\" * KIND, either express or implied.
  20 .\" *
  21 .\" **************************************************************************
  22 .\"
  23 .TH CURLOPT_ACCEPT_ENCODING 3 "December 21, 2016" "libcurl 7.59.0" "curl_easy_setopt options"
  24
  25 .SH NAME
  26 CURLOPT_ACCEPT_ENCODING \- enables automatic decompression of HTTP downloads
  27 .SH SYNOPSIS
  28 #include <curl/curl.h>
  29
  30 CURLcode curl_easy_setopt(CURL *handle, CURLOPT_ACCEPT_ENCODING, char *enc);
  31 .SH DESCRIPTION
  32 Pass a char * argument specifying what encoding you'd like.
  33
  34 Sets the contents of the Accept-Encoding: header sent in a HTTP request, and
  35 enables decoding of a response when a Content-Encoding: header is received.
  36 Three encodings are supported: \fIidentity\fP, meaning non-compressed,
  37 \fIdeflate\fP which requests the server to compress its response using the
  38 zlib algorithm, and \fIgzip\fP which requests the gzip algorithm.
  39
  40 If a zero-length string is set like "", then an Accept-Encoding: header
  41 containing all built-in supported encodings is sent.
  42
  43 Set this option to NULL to explicitly disable it, which makes libcurl not send
  44 an Accept-Encoding: header and not decompress contents automatically.
  45
  46 You can also opt to just include the Accept-Encoding: header in your request
  47 with \fICURLOPT_HTTPHEADER(3)\fP but then there will be no automatic
  48 decompressing when receiving data.
  49
  50 This is a request, not an order; the server may or may not do it.  This option
  51 must be set (to any non-NULL value) or else any unsolicited encoding done by
  52 the server is ignored.
  53
  54 Servers might respond with Content-Encoding even without getting a
  55 Accept-Encoding: in the request. Servers might respond with a different
  56 Content-Encoding than what was asked for in the request.
  57
  58 The Content-Length: servers send for a compressed response is supposed to
  59 indicate the length of the compressed content so when auto decoding is enabled
  60 it may not match the sum of bytes reported by the write callbacks (although,
  61 sending the length of the non-compressed content is a common server mistake).
  62
  63 The application does not have to keep the string around after setting this
  64 option.
  65 .SH DEFAULT
  66 NULL
  67 .SH PROTOCOLS
  68 HTTP
  69 .SH EXAMPLE
  70 .nf
  71 CURL *curl = curl_easy_init();
  72 if(curl) {
  73   curl_easy_setopt(curl, CURLOPT_URL, "http://example.com");
  74
  75   /* enable all supported built-in compressions */
  76   curl_easy_setopt(curl, CURLOPT_ACCEPT_ENCODING, "");
  77
  78   /* Perform the request */
  79   curl_easy_perform(curl);
  80 }
  81 .fi
  82 .SH AVAILABILITY
  83 This option was called CURLOPT_ENCODING before 7.21.6
  84 .SH RETURN VALUE
  85 Returns CURLE_OK if the option is supported, CURLE_UNKNOWN_OPTION if not, or
  86 CURLE_OUT_OF_MEMORY if there was insufficient heap space.
  87 .SH "SEE ALSO"
  88 .BR CURLOPT_TRANSFER_ENCODING "(3), " CURLOPT_HTTPHEADER "(3), "
  89 .BR CURLOPT_HTTP_CONTENT_DECODING "(3), "