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