Imported Upstream version 7.59.0
[platform/upstream/curl.git] / docs / libcurl / opts / CURLOPT_FTP_SKIP_PASV_IP.3
1 .\" **************************************************************************
2 .\" *                                  _   _ ____  _
3 .\" *  Project                     ___| | | |  _ \| |
4 .\" *                             / __| | | | |_) | |
5 .\" *                            | (__| |_| |  _ <| |___
6 .\" *                             \___|\___/|_| \_\_____|
7 .\" *
8 .\" * Copyright (C) 1998 - 2017, 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_FTP_SKIP_PASV_IP 3 "May 05, 2017" "libcurl 7.59.0" "curl_easy_setopt options"
24
25 .SH NAME
26 CURLOPT_FTP_SKIP_PASV_IP \- ignore the IP address in the PASV response
27 .SH SYNOPSIS
28 #include <curl/curl.h>
29
30 CURLcode curl_easy_setopt(CURL *handle, CURLOPT_FTP_SKIP_PASV_IP, long skip);
31 .SH DESCRIPTION
32 Pass a long. If \fIskip\fP is set to 1, it instructs libcurl to not use the IP
33 address the server suggests in its 227-response to libcurl's PASV command when
34 libcurl connects the data connection. Instead libcurl will re-use the same IP
35 address it already uses for the control connection. But it will use the port
36 number from the 227-response.
37
38 This option thus allows libcurl to work around broken server installations
39 that due to NATs, firewalls or incompetence report the wrong IP address back.
40
41 This option has no effect if PORT, EPRT or EPSV is used instead of PASV.
42 .SH DEFAULT
43 0
44 .SH PROTOCOLS
45 FTP
46 .SH EXAMPLE
47 .nf
48 CURL *curl = curl_easy_init();
49 if(curl) {
50   curl_easy_setopt(curl, CURLOPT_URL, "ftp://example.com/file.txt");
51
52   /* please ignore the IP in the PASV response */
53   curl_easy_setopt(curl, CURLOPT_FTP_SKIP_PASV_IP, 1L);
54   ret = curl_easy_perform(curl);
55
56   curl_easy_cleanup(curl);
57 }
58 .fi
59 .SH AVAILABILITY
60 Added in 7.14.2
61 .SH RETURN VALUE
62 Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not.
63 .SH "SEE ALSO"
64 .BR CURLOPT_FTPPORT "(3), " CURLOPT_FTP_USE_EPRT "(3), "