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