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