CURLOPT_FTP_USE_EPSV.3 2.2 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061
  1. .\" **************************************************************************
  2. .\" * _ _ ____ _
  3. .\" * Project ___| | | | _ \| |
  4. .\" * / __| | | | |_) | |
  5. .\" * | (__| |_| | _ <| |___
  6. .\" * \___|\___/|_| \_\_____|
  7. .\" *
  8. .\" * Copyright (C) 1998 - 2014, 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_FTP_USE_EPSV 3 "May 05, 2017" "libcurl 7.61.1" "curl_easy_setopt options"
  24. .SH NAME
  25. CURLOPT_FTP_USE_EPSV \- enable/disable use of EPSV
  26. .SH SYNOPSIS
  27. #include <curl/curl.h>
  28. CURLcode curl_easy_setopt(CURL *handle, CURLOPT_FTP_USE_EPSV, long epsv);
  29. .SH DESCRIPTION
  30. Pass \fIepsv\fP as a long. If the value is 1, it tells curl to use the EPSV
  31. command when doing passive FTP downloads (which it does by default). Using
  32. EPSV means that it will first attempt to use EPSV before using PASV, but if
  33. you pass zero to this option, it will not try using EPSV, only plain PASV.
  34. If the server is an IPv6 host, this option will have no effect as of 7.12.3.
  35. .SH DEFAULT
  36. 1
  37. .SH PROTOCOLS
  38. FTP
  39. .SH EXAMPLE
  40. .nf
  41. CURL *curl = curl_easy_init();
  42. if(curl) {
  43. curl_easy_setopt(curl, CURLOPT_URL, "ftp://example.com/old-server/file.txt");
  44. /* let's shut off this modern feature */
  45. curl_easy_setopt(curl, CURLOPT_FTP_USE_EPSV, 0L);
  46. ret = curl_easy_perform(curl);
  47. curl_easy_cleanup(curl);
  48. }
  49. .fi
  50. .SH AVAILABILITY
  51. Along with FTP
  52. .SH RETURN VALUE
  53. Returns CURLE_OK if FTP is supported, and CURLE_UNKNOWN_OPTION if not.
  54. .SH "SEE ALSO"
  55. .BR CURLOPT_FTP_USE_EPRT "(3), " CURLOPT_FTPPORT "(3), "