CURLOPT_FTP_USE_PRET.3 2.1 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859
  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_FTP_USE_PRET 3 "May 05, 2017" "libcurl 7.61.1" "curl_easy_setopt options"
  24. .SH NAME
  25. CURLOPT_FTP_USE_PRET \- enable the PRET command
  26. .SH SYNOPSIS
  27. #include <curl/curl.h>
  28. CURLcode curl_easy_setopt(CURL *handle, CURLOPT_FTP_USE_PRET, long enable);
  29. .SH DESCRIPTION
  30. Pass a long. If the value is 1, it tells curl to send a PRET command before
  31. PASV (and EPSV). Certain FTP servers, mainly drftpd, require this non-standard
  32. command for directory listings as well as up and downloads in PASV mode. Has
  33. no effect when using the active FTP transfers mode.
  34. .SH DEFAULT
  35. 0
  36. .SH PROTOCOLS
  37. FTP
  38. .SH EXAMPLE
  39. .nf
  40. CURL *curl = curl_easy_init();
  41. if(curl) {
  42. curl_easy_setopt(curl, CURLOPT_URL, "ftp://example.com/old-server/file.txt");
  43. /* a drftpd server, do it! */
  44. curl_easy_setopt(curl, CURLOPT_FTP_USE_PRET, 1L);
  45. ret = curl_easy_perform(curl);
  46. curl_easy_cleanup(curl);
  47. }
  48. .fi
  49. .SH AVAILABILITY
  50. Added in 7.20.0
  51. .SH RETURN VALUE
  52. Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not.
  53. .SH "SEE ALSO"
  54. .BR CURLOPT_FTP_USE_EPRT "(3), " CURLOPT_FTP_USE_EPSV "(3), "