docs/libcurl/opts/CURLOPT_ACCEPT_ENCODING.3

   1 .\" **************************************************************************
   2 .\" *                                  _   _ ____  _
   3 .\" *  Project                     ___| | | |  _ \| |
   4 .\" *                             / __| | | | |_) | |
   5 .\" *                            | (__| |_| |  _ <| |___
   6 .\" *                             \___|\___/|_| \_\_____|
   7 .\" *
   8 .\" * Copyright (C) 1998 - 2014, 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 http://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 "17 Jun 2014" "libcurl 7.37.0" "curl_easy_setopt options"
  24 .SH NAME
  25 CURLOPT_ACCEPT_ENCODING \- enables automatic decompression of HTTP downloads
  26 .SH SYNOPSIS
  27 #include <curl/curl.h>
  28
  29 CURLcode curl_easy_setopt(CURL *handle, CURLOPT_ACCEPT_ENCODING, char *enc);
  30 .SH DESCRIPTION
  31 Pass a char * argument specifying what encoding you'd like.
  32
  33 Sets the contents of the Accept-Encoding: header sent in a HTTP request, and
  34 enables decoding of a response when a Content-Encoding: header is received.
  35 Three encodings are supported: \fIidentity\fP, which does nothing,
  36 \fIdeflate\fP which requests the server to compress its response using the
  37 zlib algorithm, and \fIgzip\fP which requests the gzip algorithm.
  38
  39 If a zero-length string is set like "", then an Accept-Encoding: header
  40 containing all built-in supported encodings is sent.
  41
  42 You can also opt to just include the Accept-Encoding: header in your request
  43 with \fICURLOPT_HTTPHEADER(3)\fP but then there will be no automatic
  44 decompressing when receiving data.
  45
  46 This is a request, not an order; the server may or may not do it.  This option
  47 must be set (to any non-NULL value) or else any unsolicited encoding done by
  48 the server is ignored. See the special file lib/README.encoding for further
  49 details.
  50 .SH DEFAULT
  51 NULL
  52 .SH PROTOCOLS
  53 HTTP
  54 .SH EXAMPLE
  55 TODO
  56 .SH AVAILABILITY
  57 This option was called CURLOPT_ENCODING before 7.21.6
  58 .SH RETURN VALUE
  59 Returns CURLE_OK if the option is supported, CURLE_UNKNOWN_OPTION if not, or
  60 CURLE_OUT_OF_MEMORY if there was insufficient heap space.
  61 .SH "SEE ALSO"
  62 .BR CURLOPT_TRANSFER_ENCODING "(3), " CURLOPT_HTTPHEADER "(3), "
  63 .BR CURLOPT_HTTP_CONTENT_DECODING "(3), "