1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162 |
- .\" **************************************************************************
- .\" * _ _ ____ _
- .\" * Project ___| | | | _ \| |
- .\" * / __| | | | |_) | |
- .\" * | (__| |_| | _ <| |___
- .\" * \___|\___/|_| \_\_____|
- .\" *
- .\" * Copyright (C) 1998 - 2014, Daniel Stenberg, <daniel@haxx.se>, et al.
- .\" *
- .\" * This software is licensed as described in the file COPYING, which
- .\" * you should have received as part of this distribution. The terms
- .\" * are also available at http://curl.haxx.se/docs/copyright.html.
- .\" *
- .\" * You may opt to use, copy, modify, merge, publish, distribute and/or sell
- .\" * copies of the Software, and permit persons to whom the Software is
- .\" * furnished to do so, under the terms of the COPYING file.
- .\" *
- .\" * This software is distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY
- .\" * KIND, either express or implied.
- .\" *
- .\" **************************************************************************
- .\"
- .TH CURLOPT_ACCEPT_ENCODING 3 "17 Jun 2014" "libcurl 7.37.0" "curl_easy_setopt options"
- .SH NAME
- CURLOPT_ACCEPT_ENCODING \- enables automatic decompression of HTTP downloads
- .SH SYNOPSIS
- #include <curl/curl.h>
- CURLcode curl_easy_setopt(CURL *handle, CURLOPT_ACCEPT_ENCODING, char *enc);
- .SH DESCRIPTION
- Pass a char * argument specifying what encoding you'd like.
- Sets the contents of the Accept-Encoding: header sent in a HTTP request, and
- enables decoding of a response when a Content-Encoding: header is received.
- Three encodings are supported: \fIidentity\fP, which does nothing,
- \fIdeflate\fP which requests the server to compress its response using the
- zlib algorithm, and \fIgzip\fP which requests the gzip algorithm.
- If a zero-length string is set like "", then an Accept-Encoding: header
- containing all built-in supported encodings is sent.
- You can also opt to just include the Accept-Encoding: header in your request
- with \fICURLOPT_HTTPHEADER(3)\fP but then there will be no automatic
- decompressing when receiving data.
- This is a request, not an order; the server may or may not do it. This option
- must be set (to any non-NULL value) or else any unsolicited encoding done by
- the server is ignored. See the special file lib/README.encoding for further
- details.
- .SH DEFAULT
- NULL
- .SH PROTOCOLS
- HTTP
- .SH EXAMPLE
- TODO
- .SH AVAILABILITY
- This option was called CURLOPT_ENCODING before 7.21.6
- .SH RETURN VALUE
- Returns CURLE_OK if the option is supported, CURLE_UNKNOWN_OPTION if not, or
- CURLE_OUT_OF_MEMORY if there was insufficient heap space.
- .SH "SEE ALSO"
- .BR CURLOPT_TRANSFER_ENCODING "(3), " CURLOPT_HTTPHEADER "(3), "
|