Debian Codegraph @

deps/curl/docs/libcurl/opts/CURLOPT_FTP_USE_PRET.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_FTP_USE_PRET 3 "19 Jun 2014" "libcurl 7.37.0" "curl_easy_setopt options"
24 .SH NAME
25 CURLOPT_FTP_USE_PRET \- enable the PRET command
26 .SH SYNOPSIS
27 #include <curl/curl.h>
28
29 CURLcode curl_easy_setopt(CURL *handle, CURLOPT_FTP_USE_PRET, long enable);
30 .SH DESCRIPTION
31 Pass a long. If the value is 1, it tells curl to send a PRET command before
32 PASV (and EPSV). Certain FTP servers, mainly drftpd, require this non-standard
33 command for directory listings as well as up and downloads in PASV mode. Has
34 no effect when using the active FTP transfers mode.
35 .SH DEFAULT
36 0
37 .SH PROTOCOLS
38 FTP
39 .SH EXAMPLE
40 .nf
41 CURL *curl = curl_easy_init();
42 if(curl) {
43 curl_easy_setopt(curl, CURLOPT_URL, "ftp://example.com/old-server/file.txt");
44
45 /* a drftpd server, do it! */
46 curl_easy_setopt(curl, CURLOPT_FTP_USE_PRET, 1L);
47
48 ret = curl_easy_perform(curl);
49
50 curl_easy_cleanup(curl);
51 }
52 .fi
53 .SH AVAILABILITY
54 Added in 7.20.0
55 .SH RETURN VALUE
56 Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not.
57 .SH "SEE ALSO"
58 .BR CURLOPT_FTP_USE_EPRT "(3), " CURLOPT_FTP_USE_EPSV "(3), "