Imported Upstream version 7.40.0
[platform/upstream/curl.git] / docs / libcurl / opts / CURLOPT_RANGE.3
1 .\" **************************************************************************
2 .\" *                                  _   _ ____  _
3 .\" *  Project                     ___| | | |  _ \| |
4 .\" *                             / __| | | | |_) | |
5 .\" *                            | (__| |_| |  _ <| |___
6 .\" *                             \___|\___/|_| \_\_____|
7 .\" *
8 .\" * Copyright (C) 1998 - 2014, 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 http://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 "17 Jun 2014" "libcurl 7.37.0" "curl_easy_setopt options"
24 .SH NAME
25 CURLOPT_RANGE \- set byte range to request
26 .SH SYNOPSIS
27 #include <curl/curl.h>
28
29 CURLcode curl_easy_setopt(CURL *handle, CURLOPT_RANGE, char *range);
30 .SH DESCRIPTION
31 Pass a char * as parameter, which should contain the specified range you want
32 to retrieve. It should be in the format "X-Y", where either X or Y may be left
33 out and X and Y are byte indexes.
34
35 HTTP transfers also support several intervals, separated with commas as in
36 \fI"X-Y,N-M"\fP. Using this kind of multiple intervals will cause the HTTP
37 server to send the response document in pieces (using standard MIME separation
38 techniques). For RTSP, the formatting of a range should follow RFC2326 Section
39 12.29. For RTSP, byte ranges are \fBnot\fP permitted. Instead, ranges should
40 be given in npt, utc, or smpte formats.
41
42 Pass a NULL to this option to disable the use of ranges.
43 .SH DEFAULT
44 NULL
45 .SH PROTOCOLS
46 HTTP, FTP, FILE, RTSP and SFTP.
47 .SH EXAMPLE
48 .nf
49 CURL *curl = curl_easy_init();
50 if(curl) {
51   curl_easy_setopt(curl, CURLOPT_URL, "http://example.com");
52
53   /* get the first 200 bytes */
54   curl_easy_setopt(curl, CURLOPT_RANGE, "0-199");
55
56   /* Perform the request */
57   curl_easy_perform(curl);
58 }
59 .fi
60 .SH AVAILABILITY
61 FILE since 7.18.0, RTSP since 7.20.0
62 .SH RETURN VALUE
63 Returns CURLE_OK on success or
64 CURLE_OUT_OF_MEMORY if there was insufficient heap space.
65 .SH "SEE ALSO"
66 .BR CURLOPT_RESUME_FROM "(3), "