CURLOPT_FTP_FILEMETHOD.3 2.8 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273
  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.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_FILEMETHOD 3 "19 Jun 2014" "libcurl 7.37.0" "curl_easy_setopt options"
  24. .SH NAME
  25. CURLOPT_FTP_FILEMETHOD \- select directory traversing method for FTP
  26. .SH SYNOPSIS
  27. .nf
  28. #include <curl/curl.h>
  29. CURLcode curl_easy_setopt(CURL *handle, CURLOPT_FTP_FILEMETHOD,
  30. long method);
  31. .SH DESCRIPTION
  32. Pass a long telling libcurl which \fImethod\fP to use to reach a file on a
  33. FTP(S) server.
  34. This option exists because some server implementations are not compliant to
  35. what the standards say should work.
  36. The argument should be one of the following alternatives:
  37. .IP CURLFTPMETHOD_MULTICWD
  38. libcurl does a single CWD operation for each path part in the given URL. For
  39. deep hierarchies this means many commands. This is how RFC1738 says it should
  40. be done. This is the default but the slowest behavior.
  41. .IP CURLFTPMETHOD_NOCWD
  42. libcurl does no CWD at all. libcurl will do SIZE, RETR, STOR etc and give a
  43. full path to the server for all these commands. This is the fastest behavior.
  44. .IP CURLFTPMETHOD_SINGLECWD
  45. libcurl does one CWD with the full target directory and then operates on the
  46. file \&"normally" (like in the multicwd case). This is somewhat more standards
  47. compliant than 'nocwd' but without the full penalty of 'multicwd'.
  48. .SH DEFAULT
  49. CURLFTPMETHOD_MULTICWD
  50. .SH PROTOCOLS
  51. FTP
  52. .SH EXAMPLE
  53. .nf
  54. CURL *curl = curl_easy_init();
  55. if(curl) {
  56. curl_easy_setopt(curl, CURLOPT_URL, "ftp://example.com/1/2/3/4/new.txt");
  57. curl_easy_setopt(curl, CURLOPT_FTP_FILEMETHOD,
  58. CURLFTPMETHOD_SINGLECWD);
  59. ret = curl_easy_perform(curl);
  60. curl_easy_cleanup(curl);
  61. }
  62. .fi
  63. .SH AVAILABILITY
  64. Added in 7.15.1
  65. .SH RETURN VALUE
  66. Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not.
  67. .SH "SEE ALSO"
  68. .BR CURLOPT_DIRLISTONLY "(3), " CURLOPT_FTP_SKIP_PASV_IP "(3), "