Imported Upstream version 7.59.0
[platform/upstream/curl.git] / docs / libcurl / opts / CURLOPT_HTTP_CONTENT_DECODING.3
1 .\" **************************************************************************
2 .\" *                                  _   _ ____  _
3 .\" *  Project                     ___| | | |  _ \| |
4 .\" *                             / __| | | | |_) | |
5 .\" *                            | (__| |_| |  _ <| |___
6 .\" *                             \___|\___/|_| \_\_____|
7 .\" *
8 .\" * Copyright (C) 1998 - 2017, 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.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_HTTP_CONTENT_DECODING 3 "May 31, 2017" "libcurl 7.59.0" "curl_easy_setopt options"
24
25 .SH NAME
26 CURLOPT_HTTP_CONTENT_DECODING \- enable/disable HTTP content decoding
27 .SH SYNOPSIS
28 .nf
29 #include <curl/curl.h>
30
31 CURLcode curl_easy_setopt(CURL *handle, CURLOPT_HTTP_CONTENT_DECODING,
32                           long enabled);
33 .SH DESCRIPTION
34 Pass a long to tell libcurl how to act on content decoding. If set to zero,
35 content decoding will be disabled. If set to 1 it is enabled. Libcurl has no
36 default content decoding but requires you to use
37 \fICURLOPT_ACCEPT_ENCODING(3)\fP for that.
38 .SH DEFAULT
39 1
40 .SH PROTOCOLS
41 HTTP
42 .SH EXAMPLE
43 .nf
44 CURL *curl = curl_easy_init();
45 if(curl) {
46   CURLcode ret;
47   curl_easy_setopt(curl, CURLOPT_URL, "https://example.com/");
48   curl_easy_setopt(curl, CURLOPT_HTTP_CONTENT_DECODING, 0L);
49   ret = curl_easy_perform(curl);
50 }
51 .fi
52 .SH AVAILABILITY
53 Added in 7.16.2
54 .SH RETURN VALUE
55 Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not.
56 .SH "SEE ALSO"
57 .BR CURLOPT_STDERR "(3), " CURLOPT_DEBUGFUNCTION "(3), "
58 .BR CURLOPT_ACCEPT_ENCODING "(3) "