78 lines
2.9 KiB
Groff
78 lines
2.9 KiB
Groff
|
.\" **************************************************************************
|
||
|
|
.\" * _ _ ____ _
|
||
|
|
.\" * Project ___| | | | _ \| |
|
||
|
|
.\" * / __| | | | |_) | |
|
||
|
|
.\" * | (__| |_| | _ <| |___
|
||
|
|
.\" * \___|\___/|_| \_\_____|
|
||
|
|
.\" *
|
||
|
|
.\" * Copyright (C) Daniel Stenberg, <daniel@haxx.se>, et al.
|
||
|
|
.\" *
|
||
|
|
.\" * This software is licensed as described in the file COPYING, which
|
||
|
|
.\" * you should have received as part of this distribution. The terms
|
||
|
|
.\" * are also available at https://curl.se/docs/copyright.html.
|
||
|
|
.\" *
|
||
|
|
.\" * You may opt to use, copy, modify, merge, publish, distribute and/or sell
|
||
|
|
.\" * copies of the Software, and permit persons to whom the Software is
|
||
|
|
.\" * furnished to do so, under the terms of the COPYING file.
|
||
|
|
.\" *
|
||
|
|
.\" * This software is distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY
|
||
|
|
.\" * KIND, either express or implied.
|
||
|
|
.\" *
|
||
|
|
.\" * SPDX-License-Identifier: curl
|
||
|
|
.\" *
|
||
|
|
.\" **************************************************************************
|
||
|
|
.\"
|
||
|
|
.TH CURLOPT_FTP_FILEMETHOD 3 "August 22, 2023" "ibcurl 8.3.0" libcurl
|
||
|
|
|
||
|
|
.SH NAME
|
||
|
|
CURLOPT_FTP_FILEMETHOD \- select directory traversing method for FTP
|
||
|
|
.SH SYNOPSIS
|
||
|
|
.nf
|
||
|
|
#include <curl/curl.h>
|
||
|
|
|
||
|
|
CURLcode curl_easy_setopt(CURL *handle, CURLOPT_FTP_FILEMETHOD,
|
||
|
|
long method);
|
||
|
|
.SH DESCRIPTION
|
||
|
|
Pass a long telling libcurl which \fImethod\fP to use to reach a file on a
|
||
|
|
FTP(S) server.
|
||
|
|
|
||
|
|
This option exists because some server implementations are not compliant to
|
||
|
|
what the standards say should work.
|
||
|
|
|
||
|
|
The argument should be one of the following alternatives:
|
||
|
|
.IP CURLFTPMETHOD_MULTICWD
|
||
|
|
libcurl does a single CWD operation for each path part in the given URL. For
|
||
|
|
deep hierarchies this means many commands. This is how RFC 1738 says it should
|
||
|
|
be done. This is the default but the slowest behavior.
|
||
|
|
.IP CURLFTPMETHOD_NOCWD
|
||
|
|
libcurl makes no CWD at all. libcurl does SIZE, RETR, STOR etc and gives a
|
||
|
|
full path to the server for all these commands. This is the fastest behavior
|
||
|
|
since it skips having to change directories.
|
||
|
|
.IP CURLFTPMETHOD_SINGLECWD
|
||
|
|
libcurl does one CWD with the full target directory and then operates on the
|
||
|
|
file \&"normally" (like in the multicwd case). This is somewhat more standards
|
||
|
|
compliant than 'nocwd' but without the full penalty of 'multicwd'.
|
||
|
|
.SH DEFAULT
|
||
|
|
CURLFTPMETHOD_MULTICWD
|
||
|
|
.SH PROTOCOLS
|
||
|
|
FTP
|
||
|
|
.SH EXAMPLE
|
||
|
|
.nf
|
||
|
|
CURL *curl = curl_easy_init();
|
||
|
|
if(curl) {
|
||
|
|
curl_easy_setopt(curl, CURLOPT_URL, "ftp://example.com/1/2/3/4/new.txt");
|
||
|
|
curl_easy_setopt(curl, CURLOPT_FTP_FILEMETHOD,
|
||
|
|
(long)CURLFTPMETHOD_SINGLECWD);
|
||
|
|
|
||
|
|
ret = curl_easy_perform(curl);
|
||
|
|
|
||
|
|
curl_easy_cleanup(curl);
|
||
|
|
}
|
||
|
|
.fi
|
||
|
|
.SH AVAILABILITY
|
||
|
|
Added in 7.15.1
|
||
|
|
.SH RETURN VALUE
|
||
|
|
Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not.
|
||
|
|
.SH "SEE ALSO"
|
||
|
|
.BR CURLOPT_DIRLISTONLY "(3), " CURLOPT_FTP_SKIP_PASV_IP "(3), "
|