Annotation of embedaddon/curl/docs/libcurl/opts/CURLOPT_RANGE.3, revision 1.1.1.1
1.1 misho 1: .\" **************************************************************************
2: .\" * _ _ ____ _
3: .\" * Project ___| | | | _ \| |
4: .\" * / __| | | | |_) | |
5: .\" * | (__| |_| | _ <| |___
6: .\" * \___|\___/|_| \_\_____|
7: .\" *
8: .\" * Copyright (C) 1998 - 2019, 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_RANGE 3 "October 31, 2019" "libcurl 7.70.0" "curl_easy_setopt options"
24:
25: .SH NAME
26: CURLOPT_RANGE \- set byte range to request
27: .SH SYNOPSIS
28: #include <curl/curl.h>
29:
30: CURLcode curl_easy_setopt(CURL *handle, CURLOPT_RANGE, char *range);
31: .SH DESCRIPTION
32: Pass a char * as parameter, which should contain the specified range you want
33: to retrieve. It should be in the format "X-Y", where either X or Y may be left
34: out and X and Y are byte indexes.
35:
36: HTTP transfers also support several intervals, separated with commas as in
37: \fI"X-Y,N-M"\fP. Using this kind of multiple intervals will cause the HTTP
38: server to send the response document in pieces (using standard MIME separation
39: techniques). Unfortunately, the HTTP standard (RFC 7233 section 3.1) allows
40: servers to ignore range requests so even when you set \fICURLOPT_RANGE(3)\fP
41: for a request, you may end up getting the full response sent back.
42:
43: For RTSP, the formatting of a range should follow RFC2326 Section 12.29. For
44: RTSP, byte ranges are \fBnot\fP permitted. Instead, ranges should be given in
45: npt, utc, or smpte formats.
46:
47: For HTTP PUT uploads this option should not be used, since it may conflict with
48: other options. If you need to upload arbitrary parts of a file (like for
49: Amazon's web services) support is limited. We suggest set resume position using
50: \fICURLOPT_RESUME_FROM(3)\fP, set end (resume+size) position using
51: \fICURLOPT_INFILESIZE(3)\fP and seek to the resume position before initiating
52: the transfer for each part. For more information refer to
53: https://curl.haxx.se/mail/lib-2019-05/0012.html
54:
55: Pass a NULL to this option to disable the use of ranges.
56:
57: The application does not have to keep the string around after setting this
58: option.
59: .SH DEFAULT
60: NULL
61: .SH PROTOCOLS
62: HTTP, FTP, FILE, RTSP and SFTP.
63: .SH EXAMPLE
64: .nf
65: CURL *curl = curl_easy_init();
66: if(curl) {
67: curl_easy_setopt(curl, CURLOPT_URL, "http://example.com");
68:
69: /* get the first 200 bytes */
70: curl_easy_setopt(curl, CURLOPT_RANGE, "0-199");
71:
72: /* Perform the request */
73: curl_easy_perform(curl);
74: }
75: .fi
76: .SH AVAILABILITY
77: FILE since 7.18.0, RTSP since 7.20.0
78: .SH RETURN VALUE
79: Returns CURLE_OK on success or
80: CURLE_OUT_OF_MEMORY if there was insufficient heap space.
81: .SH "SEE ALSO"
82: .BR CURLOPT_RESUME_FROM "(3), "
FreeBSD-CVSweb <freebsd-cvsweb@FreeBSD.org>