Debian Codegraph @

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