docs/libcurl/opts/CURLOPT_TRANSFERTEXT.3

   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.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_TRANSFERTEXT 3 "May 31, 2017" "libcurl 7.59.0" "curl_easy_setopt options"
  24
  25 .SH NAME
  26 CURLOPT_TRANSFERTEXT \- request a text based transfer for FTP
  27 .SH SYNOPSIS
  28 #include <curl/curl.h>
  29
  30 CURLcode curl_easy_setopt(CURL *handle, CURLOPT_TRANSFERTEXT, long text);
  31 .SH DESCRIPTION
  32 A parameter set to 1 tells the library to use ASCII mode for FTP transfers,
  33 instead of the default binary transfer. For win32 systems it does not set the
  34 stdout to binary mode. This option can be usable when transferring text data
  35 between systems with different views on certain characters, such as newlines
  36 or similar.
  37
  38 libcurl does not do a complete ASCII conversion when doing ASCII transfers
  39 over FTP. This is a known limitation/flaw that nobody has rectified. libcurl
  40 simply sets the mode to ASCII and performs a standard transfer.
  41 .SH DEFAULT
  42 0, disabled
  43 .SH PROTOCOLS
  44 FTP
  45 .SH EXAMPLE
  46 .nf
  47 CURL *curl = curl_easy_init();
  48 if(curl) {
  49   curl_easy_setopt(curl, CURLOPT_URL, "ftp://example.com/textfile");
  50   curl_easy_setopt(curl, CURLOPT_TRANSFERTEXT, 1L);
  51   ret = curl_easy_perform(curl);
  52   curl_easy_cleanup(curl);
  53 }
  54 .fi
  55 .SH AVAILABILITY
  56 Along with FTP
  57 .SH RETURN VALUE
  58 Returns CURLE_OK if FTP is supported, and CURLE_UNKNOWN_OPTION if not.
  59 .SH "SEE ALSO"
  60 .BR CURLOPT_CRLF "(3), "