Imported Upstream version 7.59.0
[platform/upstream/curl.git] / docs / libcurl / opts / CURLOPT_IGNORE_CONTENT_LENGTH.3
1 .\" **************************************************************************
2 .\" *                                  _   _ ____  _
3 .\" *  Project                     ___| | | |  _ \| |
4 .\" *                             / __| | | | |_) | |
5 .\" *                            | (__| |_| |  _ <| |___
6 .\" *                             \___|\___/|_| \_\_____|
7 .\" *
8 .\" * Copyright (C) 1998 - 2015, 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_IGNORE_CONTENT_LENGTH 3 "February 03, 2016" "libcurl 7.59.0" "curl_easy_setopt options"
24
25 .SH NAME
26 CURLOPT_IGNORE_CONTENT_LENGTH \- ignore content length
27 .SH SYNOPSIS
28 .nf
29 #include <curl/curl.h>
30
31 CURLcode curl_easy_setopt(CURL *handle, CURLOPT_IGNORE_CONTENT_LENGTH,
32                           long ignore);
33 .SH DESCRIPTION
34 If \fIignore\fP is set to 1L, ignore the Content-Length header in the HTTP
35 response and ignore asking for or relying on it for FTP transfers.
36
37 This is useful for HTTP with Apache 1.x (and similar servers) which will
38 report incorrect content length for files over 2 gigabytes. If this option is
39 used, curl will not be able to accurately report progress, and will simply
40 stop the download when the server ends the connection.
41
42 It is also useful with FTP when for example the file is growing while the
43 transfer is in progress which otherwise will unconditionally cause libcurl to
44 report error.
45
46 Only use this option if strictly necessary.
47 .SH DEFAULT
48 0
49 .SH PROTOCOLS
50 HTTP
51 .SH EXAMPLE
52 .nf
53 CURL *curl = curl_easy_init();
54 if(curl) {
55   curl_easy_setopt(curl, CURLOPT_URL, "http://example.com");
56
57   /* we know the server is silly, ignore content-length */
58   curl_easy_setopt(curl, CURLOPT_IGNORE_CONTENT_LENGTH, 1L);
59
60   curl_easy_perform(curl);
61 }
62 .fi
63 .SH AVAILABILITY
64 Added in 7.14.1. Support for FTP added in 7.46.0.
65 .SH RETURN VALUE
66 Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not.
67 .SH "SEE ALSO"
68 .BR CURLOPT_HTTP_VERSION "(3), " CURLOPT_MAXFILESIZE_LARGE "(3), "