CURLOPT_RESUME_FROM.3 2.6 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576
  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_RESUME_FROM 3 "17 Jun 2014" libcurl libcurl
  26. .SH NAME
  27. CURLOPT_RESUME_FROM \- offset to resume transfer from
  28. .SH SYNOPSIS
  29. .nf
  30. #include <curl/curl.h>
  31. CURLcode curl_easy_setopt(CURL *handle, CURLOPT_RESUME_FROM, long from);
  32. .fi
  33. .SH DESCRIPTION
  34. Pass a long as parameter. It contains the offset in number of bytes that you
  35. want the transfer to start from. Set this option to 0 to make the transfer
  36. start from the beginning (effectively disabling resume). For FTP, set this
  37. option to -1 to make the transfer start from the end of the target file
  38. (useful to continue an interrupted upload).
  39. When doing uploads with FTP, the resume position is where in the local/source
  40. file libcurl should try to resume the upload from and it will then append the
  41. source file to the remote target file.
  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. /* resume upload at byte index 200 */
  54. curl_easy_setopt(curl, CURLOPT_RESUME_FROM, 200L);
  55. /* ask for upload */
  56. curl_easy_setopt(curl, CURLOPT_UPLOAD, 1L);
  57. /* set total data amount to expect */
  58. curl_easy_setopt(curl, CURLOPT_INFILESIZE, size_of_file);
  59. /* Perform the request */
  60. curl_easy_perform(curl);
  61. }
  62. .fi
  63. .SH AVAILABILITY
  64. Always
  65. .SH RETURN VALUE
  66. Returns CURLE_OK
  67. .SH "SEE ALSO"
  68. .BR CURLOPT_RESUME_FROM_LARGE "(3), " CURLOPT_RANGE "(3), "
  69. .BR CURLOPT_INFILESIZE "(3), "