2014-06-18 17:45:22 +08:00
|
|
|
.\" **************************************************************************
|
|
|
|
.\" * _ _ ____ _
|
|
|
|
.\" * Project ___| | | | _ \| |
|
|
|
|
.\" * / __| | | | |_) | |
|
|
|
|
.\" * | (__| |_| | _ <| |___
|
|
|
|
.\" * \___|\___/|_| \_\_____|
|
|
|
|
.\" *
|
2023-01-02 20:51:48 +08:00
|
|
|
.\" * Copyright (C) Daniel Stenberg, <daniel@haxx.se>, et al.
|
2014-06-18 17:45:22 +08:00
|
|
|
.\" *
|
|
|
|
.\" * This software is licensed as described in the file COPYING, which
|
|
|
|
.\" * you should have received as part of this distribution. The terms
|
2020-11-04 21:02:01 +08:00
|
|
|
.\" * are also available at https://curl.se/docs/copyright.html.
|
2014-06-18 17:45:22 +08:00
|
|
|
.\" *
|
|
|
|
.\" * 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
|
2022-05-17 17:16:50 +08:00
|
|
|
.\" *
|
2014-06-18 17:45:22 +08:00
|
|
|
.\" **************************************************************************
|
|
|
|
.\"
|
2023-04-26 14:58:35 +08:00
|
|
|
.TH CURLOPT_TRANSFERTEXT 3 "17 Jun 2014" libcurl libcurl
|
2014-06-18 17:45:22 +08:00
|
|
|
.SH NAME
|
|
|
|
CURLOPT_TRANSFERTEXT \- request a text based transfer for FTP
|
|
|
|
.SH SYNOPSIS
|
2021-11-26 21:20:18 +08:00
|
|
|
.nf
|
2014-06-18 17:45:22 +08:00
|
|
|
#include <curl/curl.h>
|
|
|
|
|
|
|
|
CURLcode curl_easy_setopt(CURL *handle, CURLOPT_TRANSFERTEXT, long text);
|
2021-11-26 21:20:18 +08:00
|
|
|
.fi
|
2014-06-18 17:45:22 +08:00
|
|
|
.SH DESCRIPTION
|
|
|
|
A parameter set to 1 tells the library to use ASCII mode for FTP transfers,
|
|
|
|
instead of the default binary transfer. For win32 systems it does not set the
|
|
|
|
stdout to binary mode. This option can be usable when transferring text data
|
|
|
|
between systems with different views on certain characters, such as newlines
|
|
|
|
or similar.
|
|
|
|
|
|
|
|
libcurl does not do a complete ASCII conversion when doing ASCII transfers
|
|
|
|
over FTP. This is a known limitation/flaw that nobody has rectified. libcurl
|
|
|
|
simply sets the mode to ASCII and performs a standard transfer.
|
|
|
|
.SH DEFAULT
|
|
|
|
0, disabled
|
|
|
|
.SH PROTOCOLS
|
|
|
|
FTP
|
|
|
|
.SH EXAMPLE
|
2017-05-31 17:56:28 +08:00
|
|
|
.nf
|
|
|
|
CURL *curl = curl_easy_init();
|
|
|
|
if(curl) {
|
|
|
|
curl_easy_setopt(curl, CURLOPT_URL, "ftp://example.com/textfile");
|
|
|
|
curl_easy_setopt(curl, CURLOPT_TRANSFERTEXT, 1L);
|
|
|
|
ret = curl_easy_perform(curl);
|
|
|
|
curl_easy_cleanup(curl);
|
|
|
|
}
|
|
|
|
.fi
|
2014-06-18 17:45:22 +08:00
|
|
|
.SH AVAILABILITY
|
|
|
|
Along with FTP
|
|
|
|
.SH RETURN VALUE
|
|
|
|
Returns CURLE_OK if FTP is supported, and CURLE_UNKNOWN_OPTION if not.
|
|
|
|
.SH "SEE ALSO"
|
|
|
|
.BR CURLOPT_CRLF "(3), "
|