CURLOPT_PROXY_TRANSFER_MODE.3 2.4 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263
  1. .\" **************************************************************************
  2. .\" * _ _ ____ _
  3. .\" * Project ___| | | | _ \| |
  4. .\" * / __| | | | |_) | |
  5. .\" * | (__| |_| | _ <| |___
  6. .\" * \___|\___/|_| \_\_____|
  7. .\" *
  8. .\" * Copyright (C) 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.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. .\" * SPDX-License-Identifier: curl
  22. .\" *
  23. .\" **************************************************************************
  24. .\"
  25. .TH CURLOPT_PROXY_TRANSFER_MODE 3 "19 Jun 2014" libcurl libcurl
  26. .SH NAME
  27. CURLOPT_PROXY_TRANSFER_MODE \- append FTP transfer mode to URL for proxy
  28. .SH SYNOPSIS
  29. .nf
  30. #include <curl/curl.h>
  31. CURLcode curl_easy_setopt(CURL *handle, CURLOPT_PROXY_TRANSFER_MODE,
  32. long enabled);
  33. .fi
  34. .SH DESCRIPTION
  35. Pass a long. If the value is set to 1 (one), it tells libcurl to set the
  36. transfer mode (binary or ASCII) for FTP transfers done via an HTTP proxy, by
  37. appending ;type=a or ;type=i to the URL. Without this setting, or it being set
  38. to 0 (zero, the default), \fICURLOPT_TRANSFERTEXT(3)\fP has no effect when
  39. doing FTP via a proxy. Beware that not all proxies support this feature.
  40. .SH DEFAULT
  41. 0, disabled
  42. .SH PROTOCOLS
  43. FTP over proxy
  44. .SH EXAMPLE
  45. .nf
  46. CURL *curl = curl_easy_init();
  47. if(curl) {
  48. curl_easy_setopt(curl, CURLOPT_URL, "ftp://example.com/old-server/file.txt");
  49. curl_easy_setopt(curl, CURLOPT_PROXY, "http://localhost:80");
  50. curl_easy_setopt(curl, CURLOPT_PROXY_TRANSFER_MODE, 1L);
  51. curl_easy_setopt(curl, CURLOPT_TRANSFERTEXT, 1L);
  52. ret = curl_easy_perform(curl);
  53. curl_easy_cleanup(curl);
  54. }
  55. .fi
  56. .SH AVAILABILITY
  57. Added in 7.18.0
  58. .SH RETURN VALUE
  59. Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if the
  60. enabled value is not supported.
  61. .SH "SEE ALSO"
  62. .BR CURLOPT_PROXY "(3), " CURLOPT_HTTPPROXYTUNNEL "(3), "