Return to CURLOPT_FTPPORT.3 CVS log

Up to [ELWIX - Embedded LightWeight unIX -] / embedaddon / curl / docs / libcurl / opts

Annotation of embedaddon/curl/docs/libcurl/opts/CURLOPT_FTPPORT.3, revision 1.1

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