| 1234567891011121314151617181920212223242526272829303132333435363738394041424344 |
- .\" generated by cd2nroff 0.1 from CURLOPT_TRANSFERTEXT.md
- .TH CURLOPT_TRANSFERTEXT 3 "2025-01-17" libcurl
- .SH NAME
- CURLOPT_TRANSFERTEXT \- request a text based transfer for FTP
- .SH SYNOPSIS
- .nf
- #include <curl/curl.h>
- CURLcode curl_easy_setopt(CURL *handle, CURLOPT_TRANSFERTEXT, long text);
- .fi
- .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
- This functionality affects all supported protocols
- .SH EXAMPLE
- .nf
- int main(void)
- {
- CURL *curl = curl_easy_init();
- if(curl) {
- CURLcode res;
- curl_easy_setopt(curl, CURLOPT_URL, "ftp://example.com/textfile");
- curl_easy_setopt(curl, CURLOPT_TRANSFERTEXT, 1L);
- res = curl_easy_perform(curl);
- curl_easy_cleanup(curl);
- }
- }
- .fi
- .SH AVAILABILITY
- Added in curl 7.1.1
- .SH RETURN VALUE
- Returns CURLE_OK if FTP is supported, and CURLE_UNKNOWN_OPTION if not.
- .SH SEE ALSO
- .BR CURLOPT_CRLF (3)
|
