| 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_FTPPORT 3 "17 Jun 2014" "libcurl 7.37.0" "curl_easy_setopt options" |
| 24 |
.SH NAME |
| 25 |
CURLOPT_FTPPORT \- make FTP transfer active |
| 26 |
.SH SYNOPSIS |
| 27 |
#include <curl/curl.h> |
| 28 |
|
| 29 |
CURLcode curl_easy_setopt(CURL *handle, CURLOPT_FTPPORT, char *spec); |
| 30 |
.SH DESCRIPTION |
| 31 |
Pass a pointer to a zero terminated string as parameter. It specifies that the |
| 32 |
FTP transfer will be made actively and the given string will be used to get |
| 33 |
the IP address to use for the FTP PORT instruction. |
| 34 |
|
| 35 |
The PORT instruction tells the remote server to connect to our specified IP |
| 36 |
address. The string may be a plain IP address, a host name, a network |
| 37 |
interface name (under Unix) or just a '-' symbol to let the library use your |
| 38 |
system's default IP address. Default FTP operations are passive, and thus |
| 39 |
won't use PORT. |
| 40 |
|
| 41 |
The address can be followed by a ':' to specify a port, optionally followed by |
| 42 |
a '-' to specify a port range. If the port specified is 0, the operating |
| 43 |
system will pick a free port. If a range is provided and all ports in the |
| 44 |
range are not available, libcurl will report CURLE_FTP_PORT_FAILED for the |
| 45 |
handle. Invalid port/range settings are ignored. IPv6 addresses followed by |
| 46 |
a port or portrange have to be in brackets. IPv6 addresses without port/range |
| 47 |
specifier can be in brackets. |
| 48 |
|
| 49 |
Examples with specified ports: |
| 50 |
|
| 51 |
.nf |
| 52 |
eth0:0 |
| 53 |
192.168.1.2:32000-33000 |
| 54 |
curl.se:32123 |
| 55 |
[::1]:1234-4567 |
| 56 |
.fi |
| 57 |
|
| 58 |
You disable PORT again and go back to using the passive version by setting |
| 59 |
this option to NULL. |
| 60 |
|
| 61 |
The application does not have to keep the string around after setting this |
| 62 |
option. |
| 63 |
.SH DEFAULT |
| 64 |
NULL |
| 65 |
.SH PROTOCOLS |
| 66 |
FTP |
| 67 |
.SH EXAMPLE |
| 68 |
.nf |
| 69 |
CURL *curl = curl_easy_init(); |
| 70 |
if(curl) { |
| 71 |
curl_easy_setopt(curl, CURLOPT_URL, "ftp://example.com/old-server/file.txt"); |
| 72 |
curl_easy_setopt(curl, CURLOPT_FTPPORT, "-"); |
| 73 |
ret = curl_easy_perform(curl); |
| 74 |
curl_easy_cleanup(curl); |
| 75 |
} |
| 76 |
.fi |
| 77 |
.SH AVAILABILITY |
| 78 |
Port range support was added in 7.19.5 |
| 79 |
.SH RETURN VALUE |
| 80 |
Returns CURLE_OK if the option is supported, CURLE_UNKNOWN_OPTION if not, or |
| 81 |
CURLE_OUT_OF_MEMORY if there was insufficient heap space. |
| 82 |
.SH "SEE ALSO" |
| 83 |
.BR CURLOPT_FTP_USE_EPRT "(3), " CURLOPT_FTP_USE_EPSV "(3), " |