CURLOPT_FTP_USE_EPSV.3 2.2 KB

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