CURLOPT_TRANSFER_ENCODING.3 2.5 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364
  1. .\" **************************************************************************
  2. .\" * _ _ ____ _
  3. .\" * Project ___| | | | _ \| |
  4. .\" * / __| | | | |_) | |
  5. .\" * | (__| |_| | _ <| |___
  6. .\" * \___|\___/|_| \_\_____|
  7. .\" *
  8. .\" * Copyright (C) 1998 - 2021, 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.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. .nf
  28. #include <curl/curl.h>
  29. CURLcode curl_easy_setopt(CURL *handle, CURLOPT_TRANSFER_ENCODING,
  30. long enable);
  31. .fi
  32. .SH DESCRIPTION
  33. Pass a long set to 1L to \fIenable\fP or 0 to disable.
  34. Adds a request for compressed Transfer Encoding in the outgoing HTTP
  35. request. If the server supports this and so desires, it can respond with the
  36. HTTP response sent using a compressed Transfer-Encoding that will be
  37. automatically uncompressed by libcurl on reception.
  38. Transfer-Encoding differs slightly from the Content-Encoding you ask for with
  39. \fICURLOPT_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. .nf
  49. CURL *curl = curl_easy_init();
  50. if(curl) {
  51. curl_easy_setopt(curl, CURLOPT_URL, "https://example.com");
  52. curl_easy_setopt(curl, CURLOPT_TRANSFER_ENCODING, 1L);
  53. curl_easy_perform(curl);
  54. }
  55. .fi
  56. .SH AVAILABILITY
  57. Added in 7.21.6
  58. .SH RETURN VALUE
  59. Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not.
  60. .SH "SEE ALSO"
  61. .BR CURLOPT_ACCEPT_ENCODING "(3), " CURLOPT_HTTP_TRANSFER_DECODING "(3), "