Annotation of embedaddon/curl/docs/libcurl/opts/CURLOPT_RESUME_FROM.3, revision 1.1.1.1
1.1 misho 1: .\" **************************************************************************
2: .\" * _ _ ____ _
3: .\" * Project ___| | | | _ \| |
4: .\" * / __| | | | |_) | |
5: .\" * | (__| |_| | _ <| |___
6: .\" * \___|\___/|_| \_\_____|
7: .\" *
8: .\" * Copyright (C) 1998 - 2020, 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_RESUME_FROM 3 "March 23, 2020" "libcurl 7.70.0" "curl_easy_setopt options"
24:
25: .SH NAME
26: CURLOPT_RESUME_FROM \- set a point to resume transfer from
27: .SH SYNOPSIS
28: #include <curl/curl.h>
29:
30: CURLcode curl_easy_setopt(CURL *handle, CURLOPT_RESUME_FROM, long from);
31: .SH DESCRIPTION
32: Pass a long as parameter. It contains the offset in number of bytes that you
33: want the transfer to start from. Set this option to 0 to make the transfer
34: start from the beginning (effectively disabling resume). For FTP, set this
35: option to -1 to make the transfer start from the end of the target file
36: (useful to continue an interrupted upload).
37:
38: When doing uploads with FTP, the resume position is where in the local/source
39: file libcurl should try to resume the upload from and it will then append the
40: source file to the remote target file.
41:
42: If you need to resume a transfer beyond the 2GB limit, use
43: \fICURLOPT_RESUME_FROM_LARGE(3)\fP instead.
44: .SH DEFAULT
45: 0, not used
46: .SH PROTOCOLS
47: HTTP, FTP, SFTP, FILE
48: .SH EXAMPLE
49: .nf
50: CURL *curl = curl_easy_init();
51: if(curl) {
52: curl_easy_setopt(curl, CURLOPT_URL, "ftp://example.com");
53:
54: /* resume upload at byte index 200 */
55: curl_easy_setopt(curl, CURLOPT_RESUME_FROM, 200L);
56:
57: /* ask for upload */
58: curl_easy_setopt(curl, CURLOPT_UPLOAD, 1L);
59:
60: /* set total data amount to expect */
61: curl_easy_setopt(curl, CURLOPT_INFILESIZE, size_of_file);
62:
63: /* Perform the request */
64: curl_easy_perform(curl);
65: }
66: .fi
67: .SH AVAILABILITY
68: Always
69: .SH RETURN VALUE
70: Returns CURLE_OK
71: .SH "SEE ALSO"
72: .BR CURLOPT_RESUME_FROM_LARGE "(3), " CURLOPT_RANGE "(3), "
73: .BR CURLOPT_INFILESIZE "(3), "
FreeBSD-CVSweb <freebsd-cvsweb@FreeBSD.org>