Home Explore Help
Register Sign In
apple
/
External
1
0
Fork 0
Files Issues 0 Pull Requests 0 Wiki
Tree: 9488874a0f
Branches Tags
External
/
Libraries
/
CURL
/
share
/
man
/
man3
/
CURLOPT_TRANSFERTEXT.3

CURLOPT_TRANSFERTEXT.3 2.3 KB
History Raw

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364 
  1. .\" **************************************************************************
    2. 

  2. .\" *                                  _   _ ____  _
    3. 

  3. .\" *  Project                     ___| | | |  _ \| |
    4. 

  4. .\" *                             / __| | | | |_) | |
    5. 

  5. .\" *                            | (__| |_| |  _ <| |___
    6. 

  6. .\" *                             \___|\___/|_| \_\_____|
    7. 

  7. .\" *
    8. 

  8. .\" * Copyright (C) Daniel Stenberg, <daniel@haxx.se>, et al.
    9. 

  9. .\" *
    10. 

  10. .\" * This software is licensed as described in the file COPYING, which
    11. 

  11. .\" * you should have received as part of this distribution. The terms
    12. 

  12. .\" * are also available at https://curl.se/docs/copyright.html.
    13. 

  13. .\" *
    14. 

  14. .\" * You may opt to use, copy, modify, merge, publish, distribute and/or sell
    15. 

  15. .\" * copies of the Software, and permit persons to whom the Software is
    16. 

  16. .\" * furnished to do so, under the terms of the COPYING file.
    17. 

  17. .\" *
    18. 

  18. .\" * This software is distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY
    19. 

  19. .\" * KIND, either express or implied.
    20. 

  20. .\" *
    21. 

  21. .\" * SPDX-License-Identifier: curl
    22. 

  22. .\" *
    23. 

  23. .\" **************************************************************************
    24. 

  24. .\"
    25. 

  25. .TH CURLOPT_TRANSFERTEXT 3 "January 02, 2023" "libcurl 7.88.1" "curl_easy_setopt options"
    26. 

  26. 

  27. .SH NAME
    28. 

  28. CURLOPT_TRANSFERTEXT \- request a text based transfer for FTP
    29. 

  29. .SH SYNOPSIS
    30. 

  30. .nf
    31. 

  31. #include <curl/curl.h>
    32. 

  32. 

  33. CURLcode curl_easy_setopt(CURL *handle, CURLOPT_TRANSFERTEXT, long text);
    34. 

  34. .fi
    35. 

  35. .SH DESCRIPTION
    36. 

  36. A parameter set to 1 tells the library to use ASCII mode for FTP transfers,
    37. 

  37. instead of the default binary transfer. For win32 systems it does not set the
    38. 

  38. stdout to binary mode. This option can be usable when transferring text data
    39. 

  39. between systems with different views on certain characters, such as newlines
    40. 

  40. or similar.
    41. 

  41. 

  42. libcurl does not do a complete ASCII conversion when doing ASCII transfers
    43. 

  43. over FTP. This is a known limitation/flaw that nobody has rectified. libcurl
    44. 

  44. simply sets the mode to ASCII and performs a standard transfer.
    45. 

  45. .SH DEFAULT
    46. 

  46. 0, disabled
    47. 

  47. .SH PROTOCOLS
    48. 

  48. FTP
    49. 

  49. .SH EXAMPLE
    50. 

  50. .nf
    51. 

  51. CURL *curl = curl_easy_init();
    52. 

  52. if(curl) {
    53. 

  53.   curl_easy_setopt(curl, CURLOPT_URL, "ftp://example.com/textfile");
    54. 

  54.   curl_easy_setopt(curl, CURLOPT_TRANSFERTEXT, 1L);
    55. 

  55.   ret = curl_easy_perform(curl);
    56. 

  56.   curl_easy_cleanup(curl);
    57. 

  57. }
    58. 

  58. .fi
    59. 

  59. .SH AVAILABILITY
    60. 

  60. Along with FTP
    61. 

  61. .SH RETURN VALUE
    62. 

  62. Returns CURLE_OK if FTP is supported, and CURLE_UNKNOWN_OPTION if not.
    63. 

  63. .SH "SEE ALSO"
    64. 

  64. .BR CURLOPT_CRLF "(3), "
    65.