Debian Codegraph @

deps/curl/docs/libcurl/opts/CURLOPT_PROXY_TRANSFER_MODE.3

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