docs/libcurl/opts/CURLOPT_DIRLISTONLY.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_DIRLISTONLY 3 "May 05, 2017" "libcurl 7.59.0" "curl_easy_setopt options"
  24
  25 .SH NAME
  26 CURLOPT_DIRLISTONLY \- ask for names only in a directory listing
  27 .SH SYNOPSIS
  28 #include <curl/curl.h>
  29
  30 CURLcode curl_easy_setopt(CURL *handle, CURLOPT_DIRLISTONLY, long listonly);
  31 .SH DESCRIPTION
  32 For FTP and SFTP based URLs a parameter set to 1 tells the library to list the
  33 names of files in a directory, rather than performing a full directory listing
  34 that would normally include file sizes, dates etc.
  35
  36 For POP3 a parameter of 1 tells the library to list the email message or
  37 messages on the POP3 server. This can be used to change the default behaviour
  38 of libcurl, when combined with a URL that contains a message ID, to perform a
  39 "scan listing" which can then be used to determine the size of an email.
  40
  41 Note: For FTP this causes a NLST command to be sent to the FTP server.  Beware
  42 that some FTP servers list only files in their response to NLST; they might not
  43 include subdirectories and symbolic links.
  44
  45 Setting this option to 1 also implies a directory listing even if the URL
  46 doesn't end with a slash, which otherwise is necessary.
  47
  48 Do NOT use this option if you also use \fICURLOPT_WILDCARDMATCH(3)\fP as it
  49 will effectively break that feature then.
  50 .SH DEFAULT
  51 0, disabled
  52 .SH PROTOCOLS
  53 FTP, SFTP and POP3
  54 .SH EXAMPLE
  55 .nf
  56 CURL *curl = curl_easy_init();
  57 if(curl) {
  58   curl_easy_setopt(curl, CURLOPT_URL, "ftp://example.com/dir/");
  59
  60   /* list only */
  61   curl_easy_setopt(curl, CURLOPT_DIRLISTONLY, 1L);
  62
  63   ret = curl_easy_perform(curl);
  64
  65   curl_easy_cleanup(curl);
  66 }
  67 .fi
  68 .SH AVAILABILITY
  69 This option was known as CURLOPT_FTPLISTONLY up to 7.16.4. POP3 is supported
  70 since 7.21.5.
  71 .SH RETURN VALUE
  72 Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not.
  73 .SH "SEE ALSO"
  74 .BR CURLOPT_CUSTOMREQUEST "(3), "