docs/libcurl/opts/CURLOPT_TRANSFER_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_TRANSFER_ENCODING 3 "19 Jun 2014" "libcurl 7.37.0" "curl_easy_setopt options"
  24 .SH NAME
  25 CURLOPT_TRANSFER_ENCODING \- ask for HTTP Transfer Encoding
  26 .SH SYNOPSIS
  27 #include <curl/curl.h>
  28
  29 CURLcode curl_easy_setopt(CURL *handle, CURLOPT_TRANSFER_ENCODING, long enable);
  30 .SH DESCRIPTION
  31 Pass a long set to 1 to \fIenable\fP or 0 to disable.
  32
  33 Adds a request for compressed Transfer Encoding in the outgoing HTTP
  34 request. If the server supports this and so desires, it can respond with the
  35 HTTP response sent using a compressed Transfer-Encoding that will be
  36 automatically uncompressed by libcurl on reception.
  37
  38 Transfer-Encoding differs slightly from the Content-Encoding you ask for with
  39 \fBCURLOPT_ACCEPT_ENCODING(3)\fP in that a Transfer-Encoding is strictly meant
  40 to be for the transfer and thus MUST be decoded before the data arrives in the
  41 client. Traditionally, Transfer-Encoding has been much less used and supported
  42 by both HTTP clients and HTTP servers.
  43 .SH DEFAULT
  44 0
  45 .SH PROTOCOLS
  46 HTTP
  47 .SH EXAMPLE
  48 TODO
  49 .SH AVAILABILITY
  50 Added in 7.21.6
  51 .SH RETURN VALUE
  52 Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not.
  53 .SH "SEE ALSO"
  54 .BR CURLOPT_ACCEPT_ENCODING "(3), " CURLOPT_HTTP_TRANSFER_DECODING "(3), "