From c31e6d223a0f3d40d952fd478d06ad2e53eb3dcf Mon Sep 17 00:00:00 2001 From: Daniel Stenberg Date: Thu, 19 Jun 2014 13:53:13 +0200 Subject: opts: more man pages --- docs/libcurl/opts/CURLOPT_MAXFILESIZE_LARGE.3 | 52 +++++++++++++++++++++++++++ 1 file changed, 52 insertions(+) create mode 100644 docs/libcurl/opts/CURLOPT_MAXFILESIZE_LARGE.3 (limited to 'docs/libcurl/opts/CURLOPT_MAXFILESIZE_LARGE.3') diff --git a/docs/libcurl/opts/CURLOPT_MAXFILESIZE_LARGE.3 b/docs/libcurl/opts/CURLOPT_MAXFILESIZE_LARGE.3 new file mode 100644 index 000000000..b31300180 --- /dev/null +++ b/docs/libcurl/opts/CURLOPT_MAXFILESIZE_LARGE.3 @@ -0,0 +1,52 @@ +.\" ************************************************************************** +.\" * _ _ ____ _ +.\" * Project ___| | | | _ \| | +.\" * / __| | | | |_) | | +.\" * | (__| |_| | _ <| |___ +.\" * \___|\___/|_| \_\_____| +.\" * +.\" * Copyright (C) 1998 - 2014, Daniel Stenberg, , 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_MAXFILESIZE_LARGE 3 "19 Jun 2014" "libcurl 7.37.0" "curl_easy_setopt options" +.SH NAME +CURLOPT_MAXFILESIZE_LARGE \- maximum file size allowed to download +.SH SYNOPSIS +.nf +#include + +CURLcode curl_easy_setopt(CURL *handle, CURLOPT_MAXFILESIZE_LARGE, + curl_off_t size); +.SH DESCRIPTION +Pass a curl_off_t as parameter. This allows you to specify the maximum +\fIsize\fP (in bytes) of a file to download. If the file requested is found +larger than this value, the transfer will not start and +\fICURLE_FILESIZE_EXCEEDED\fP will be returned. + +The file size is not always known prior to download, and for such files this +option has no effect even if the file transfer ends up being larger than this +given limit. This concerns both FTP and HTTP transfers. +.SH DEFAULT +None +.SH PROTOCOLS +FTP and HTTP +.SH EXAMPLE +TODO +.SH AVAILABILITY +Added in 7.11.0 +.SH RETURN VALUE +Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not. +.SH "SEE ALSO" +.BR CURLOPT_MAXFILESIZE "(3), " CURLOPT_MAX_RECV_SPEED_LARGE "(3), " -- cgit v1.2.3