81 lines
2.7 KiB
Groff
81 lines
2.7 KiB
Groff
|
.\" **************************************************************************
|
||
|
|
.\" * _ _ ____ _
|
||
|
|
.\" * Project ___| | | | _ \| |
|
||
|
|
.\" * / __| | | | |_) | |
|
||
|
|
.\" * | (__| |_| | _ <| |___
|
||
|
|
.\" * \___|\___/|_| \_\_____|
|
||
|
|
.\" *
|
||
|
|
.\" * Copyright (C) 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 https://curl.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.
|
||
|
|
.\" *
|
||
|
|
.\" * SPDX-License-Identifier: curl
|
||
|
|
.\" *
|
||
|
|
.\" **************************************************************************
|
||
|
|
.\"
|
||
|
|
.TH CURLOPT_INFILESIZE 3 "17 Jun 2014" libcurl libcurl
|
||
|
|
.SH NAME
|
||
|
|
CURLOPT_INFILESIZE \- size of the input file to send off
|
||
|
|
.SH SYNOPSIS
|
||
|
|
.nf
|
||
|
|
#include <curl/curl.h>
|
||
|
|
|
||
|
|
CURLcode curl_easy_setopt(CURL *handle, CURLOPT_INFILESIZE, long filesize);
|
||
|
|
.fi
|
||
|
|
.SH DESCRIPTION
|
||
|
|
When uploading a file to a remote site, \fIfilesize\fP should be used to tell
|
||
|
|
libcurl what the expected size of the input file is. This value must be passed
|
||
|
|
as a long. See also \fICURLOPT_INFILESIZE_LARGE(3)\fP for sending files larger
|
||
|
|
than 2GB.
|
||
|
|
|
||
|
|
For uploading using SCP, this option or \fICURLOPT_INFILESIZE_LARGE(3)\fP is
|
||
|
|
mandatory.
|
||
|
|
|
||
|
|
To unset this value again, set it to -1.
|
||
|
|
|
||
|
|
Using \fICURLOPT_UPLOAD(3)\fP to a HTTP/1.1 server and this value set to -1,
|
||
|
|
makes libcurl do a chunked transfer-encoded upload.
|
||
|
|
|
||
|
|
When sending emails using SMTP, this command can be used to specify the
|
||
|
|
optional SIZE parameter for the MAIL FROM command.
|
||
|
|
|
||
|
|
This option does not limit how much data libcurl actually sends, as that is
|
||
|
|
controlled entirely by what the read callback returns, but telling one value
|
||
|
|
and sending a different amount may lead to errors.
|
||
|
|
.SH DEFAULT
|
||
|
|
Unset
|
||
|
|
.SH PROTOCOLS
|
||
|
|
Many
|
||
|
|
.SH EXAMPLE
|
||
|
|
.nf
|
||
|
|
CURL *curl = curl_easy_init();
|
||
|
|
if(curl) {
|
||
|
|
long uploadsize = FILE_SIZE;
|
||
|
|
|
||
|
|
curl_easy_setopt(curl, CURLOPT_URL, "ftp://example.com/destination.tar.gz");
|
||
|
|
|
||
|
|
curl_easy_setopt(curl, CURLOPT_UPLOAD, 1L);
|
||
|
|
|
||
|
|
curl_easy_setopt(curl, CURLOPT_INFILESIZE, uploadsize);
|
||
|
|
|
||
|
|
curl_easy_perform(curl);
|
||
|
|
}
|
||
|
|
.fi
|
||
|
|
.SH AVAILABILITY
|
||
|
|
SMTP support added in 7.23.0
|
||
|
|
.SH RETURN VALUE
|
||
|
|
Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not.
|
||
|
|
.SH "SEE ALSO"
|
||
|
|
.BR CURLINFO_CONTENT_LENGTH_UPLOAD_T (3),
|
||
|
|
.BR CURLOPT_INFILESIZE_LARGE (3),
|
||
|
|
.BR CURLOPT_UPLOAD (3)
|