Imported Upstream version 7.59.0
[platform/upstream/curl.git] / docs / libcurl / opts / CURLOPT_TFTP_BLKSIZE.3
1 .\" **************************************************************************
2 .\" *                                  _   _ ____  _
3 .\" *  Project                     ___| | | |  _ \| |
4 .\" *                             / __| | | | |_) | |
5 .\" *                            | (__| |_| |  _ <| |___
6 .\" *                             \___|\___/|_| \_\_____|
7 .\" *
8 .\" * Copyright (C) 1998 - 2017, 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_TFTP_BLKSIZE 3 "May 31, 2017" "libcurl 7.59.0" "curl_easy_setopt options"
24
25 .SH NAME
26 CURLOPT_TFTP_BLKSIZE \- TFTP block size
27 .SH SYNOPSIS
28 #include <curl/curl.h>
29
30 CURLcode curl_easy_setopt(CURL *handle, CURLOPT_TFTP_BLKSIZE, long blocksize);
31 .SH DESCRIPTION
32 Specify \fIblocksize\fP to use for TFTP data transmission. Valid range as per
33 RFC2348 is 8-65464 bytes. The default of 512 bytes will be used if this option
34 is not specified. The specified block size will only be used pending support
35 by the remote server. If the server does not return an option acknowledgement
36 or returns an option acknowledgement with no blksize, the default of 512 bytes
37 will be used.
38 .SH DEFAULT
39 512
40 .SH PROTOCOLS
41 TFTP
42 .SH EXAMPLE
43 .nf
44 CURL *curl = curl_easy_init();
45 if(curl) {
46   curl_easy_setopt(curl, CURLOPT_URL, "tftp://example.com/bootimage");
47   /* try using larger blocks */
48   curl_easy_setopt(curl, CURLOPT_TFTP_BLKSIZE, 2048L);
49   ret = curl_easy_perform(curl);
50   curl_easy_cleanup(curl);
51 }
52 .fi
53 .SH AVAILABILITY
54 Added in 7.19.4
55 .SH RETURN VALUE
56 Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not.
57 .SH "SEE ALSO"
58 .BR CURLOPT_MAXFILESIZE "(3), "