docs/libcurl/opts/CURLOPT_DIRLISTONLY.3

   1 .\" **************************************************************************
   2 .\" *                                  _   _ ____  _
   3 .\" *  Project                     ___| | | |  _ \| |
   4 .\" *                             / __| | | | |_) | |
   5 .\" *                            | (__| |_| |  _ <| |___
   6 .\" *                             \___|\___/|_| \_\_____|
   7 .\" *
   8 .\" * Copyright (C) 1998 - 2014, 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 http://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 "17 Jun 2014" "libcurl 7.37.0" "curl_easy_setopt options"
  24 .SH NAME
  25 CURLOPT_DIRLISTONLY \- ask for names only in a directory listing
  26 .SH SYNOPSIS
  27 #include <curl/curl.h>
  28
  29 CURLcode curl_easy_setopt(CURL *handle, CURLOPT_DIRLISTONLY, long listonly);
  30 .SH DESCRIPTION
  31 A parameter set to 1 tells the library to just list the names of files in a
  32 directory, instead of doing a full directory listing that would include file
  33 sizes, dates etc. This works for FTP and SFTP URLs.
  34
  35 This causes an FTP NLST command to be sent on an FTP server.  Beware that some
  36 FTP servers list only files in their response to NLST; they might not include
  37 subdirectories and symbolic links.
  38
  39 Setting this option to 1 also implies a directory listing even if the URL
  40 doesn't end with a slash, which otherwise is necessary.
  41
  42 Do NOT use this option if you also use \fICURLOPT_WILDCARDMATCH(3)\fP as it
  43 will effectively break that feature then.
  44 .SH DEFAULT
  45 0, disabled
  46 .SH PROTOCOLS
  47 FTP and SFTP
  48 .SH EXAMPLE
  49 TODO
  50 .SH AVAILABILITY
  51 This option was known as CURLOPT_FTPLISTONLY up to 7.16.4
  52 .SH RETURN VALUE
  53 Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not.
  54 .SH "SEE ALSO"
  55 .BR CURLOPT_CUSTOMREQUEST "(3), "