Imported Upstream version 7.48.0
[platform/upstream/curl.git] / docs / libcurl / opts / CURLOPT_FTP_USE_EPSV.3
1 .\" **************************************************************************
2 .\" *                                  _   _ ____  _
3 .\" *  Project                     ___| | | |  _ \| |
4 .\" *                             / __| | | | |_) | |
5 .\" *                            | (__| |_| |  _ <| |___
6 .\" *                             \___|\___/|_| \_\_____|
7 .\" *
8 .\" * Copyright (C) 1998 - 2014, 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_USE_EPSV 3 "17 Jun 2014" "libcurl 7.37.0" "curl_easy_setopt options"
24 .SH NAME
25 CURLOPT_FTP_USE_EPSV \- enable/disable use of EPSV
26 .SH SYNOPSIS
27 #include <curl/curl.h>
28
29 CURLcode curl_easy_setopt(CURL *handle, CURLOPT_FTP_USE_EPSV, long epsv);
30 .SH DESCRIPTION
31 Pass \fIepsv\fP as a long. If the value is 1, it tells curl to use the EPSV
32 command when doing passive FTP downloads (which it does by default). Using
33 EPSV means that it will first attempt to use EPSV before using PASV, but if
34 you pass zero to this option, it will not try using EPSV, only plain PASV.
35
36 If the server is an IPv6 host, this option will have no effect as of 7.12.3.
37 .SH DEFAULT
38 1
39 .SH PROTOCOLS
40 FTP
41 .SH EXAMPLE
42 TODO
43 .SH AVAILABILITY
44 Along with FTP
45 .SH RETURN VALUE
46 Returns CURLE_OK if FTP is supported, and CURLE_UNKNOWN_OPTION if not.
47 .SH "SEE ALSO"
48 .BR CURLOPT_FTP_USE_EPRT "(3), " CURLOPT_FTPPORT "(3), "