CURLOPT_TFTP_BLKSIZE.3 2.2 KB

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