Annotation of embedaddon/curl/docs/libcurl/opts/CURLOPT_TRANSFER_ENCODING.3, revision 1.1.1.1
1.1 misho 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_TRANSFER_ENCODING 3 "May 15, 2017" "libcurl 7.70.0" "curl_easy_setopt options"
24:
25: .SH NAME
26: CURLOPT_TRANSFER_ENCODING \- ask for HTTP Transfer Encoding
27: .SH SYNOPSIS
28: #include <curl/curl.h>
29:
30: CURLcode curl_easy_setopt(CURL *handle, CURLOPT_TRANSFER_ENCODING, long enable);
31: .SH DESCRIPTION
32: Pass a long set to 1L to \fIenable\fP or 0 to disable.
33:
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:
39: Transfer-Encoding differs slightly from the Content-Encoding you ask for with
40: \fICURLOPT_ACCEPT_ENCODING(3)\fP in that a Transfer-Encoding is strictly meant
41: to be for the transfer and thus MUST be decoded before the data arrives in the
42: client. Traditionally, Transfer-Encoding has been much less used and supported
43: by both HTTP clients and HTTP servers.
44: .SH DEFAULT
45: 0
46: .SH PROTOCOLS
47: HTTP
48: .SH EXAMPLE
49: .nf
50: CURL *curl = curl_easy_init();
51: if(curl) {
52: curl_easy_setopt(curl, CURLOPT_URL, "http://example.com");
53: curl_easy_setopt(curl, CURLOPT_TRANSFER_ENCODING, 1L);
54: curl_easy_perform(curl);
55: }
56: .fi
57: .SH AVAILABILITY
58: Added in 7.21.6
59: .SH RETURN VALUE
60: Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not.
61: .SH "SEE ALSO"
62: .BR CURLOPT_ACCEPT_ENCODING "(3), " CURLOPT_HTTP_TRANSFER_DECODING "(3), "
FreeBSD-CVSweb <freebsd-cvsweb@FreeBSD.org>