CURLOPT_PROXY_TRANSFER_MODE.3 2.4 KB

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