CURLOPT_ACCEPT_ENCODING.3 2.7 KB

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