Artifactspublic-v0

curl

master
ply4 git calls152 ms288 KiB2 cachedprotocol v2
91 lines2.1 KiBRaw

NAME

CURLOPT_DIRLISTONLY - ask for names only in a directory listing

SYNOPSIS

c
#include <curl/curl.h>

CURLcode curl_easy_setopt(CURL *handle, CURLOPT_DIRLISTONLY, long listonly);

DESCRIPTION

For FTP and SFTP based URLs a parameter set to 1 tells the library to list the names of files in a directory, rather than performing a full directory listing that would normally include file sizes, dates etc.

For POP3 a parameter of 1 tells the library to list the email message or messages on the POP3 server. This can be used to change the default behavior of libcurl, when combined with a URL that contains a message ID, to perform a "scan listing" which can then be used to determine the size of an email.

For FILE, this option has no effect yet as directories are always listed in this mode.

Note: For FTP this causes a NLST command to be sent to the FTP server. Beware that some FTP servers list only files in their response to NLST; they might not include subdirectories and symbolic links.

Setting this option to 1 also implies a directory listing even if the URL does not end with a slash, which otherwise is necessary.

Do not use this option if you also use CURLOPT_WILDCARDMATCH(3) as it effectively breaks that feature.

DEFAULT

0, disabled

%PROTOCOLS%

EXAMPLE

c
int main(void)
{
  CURL *curl = curl_easy_init();
  if(curl) {
    CURLcode result;
    curl_easy_setopt(curl, CURLOPT_URL, "ftp://example.com/dir/");

    /* list only */
    curl_easy_setopt(curl, CURLOPT_DIRLISTONLY, 1L);

    result = curl_easy_perform(curl);

    curl_easy_cleanup(curl);
  }
}

HISTORY

This option was known as CURLOPT_FTPLISTONLY up to 7.16.4. POP3 is supported since 7.21.5.

%AVAILABILITY%

RETURN VALUE

curl_easy_setopt(3) returns a CURLcode indicating success or error.

CURLE_OK (0) means everything was OK, non-zero means an error occurred, see libcurl-errors(3).

1---
2c: Copyright (C) Daniel Stenberg, <daniel@haxx.se>, et al.
3SPDX-License-Identifier: curl
4Title: CURLOPT_DIRLISTONLY
5Section: 3
6Source: libcurl
7See-also:
8 - CURLOPT_CUSTOMREQUEST (3)
9 - CURLOPT_WILDCARDMATCH (3)
10Protocol:
11 - FTP
12 - SFTP
13 - POP3
14Added-in: 7.17.0
15---
17# NAME
19CURLOPT_DIRLISTONLY - ask for names only in a directory listing
21# SYNOPSIS
23~~~c
24#include <curl/curl.h>
26CURLcode curl_easy_setopt(CURL *handle, CURLOPT_DIRLISTONLY, long listonly);
27~~~
29# DESCRIPTION
31For FTP and SFTP based URLs a parameter set to 1 tells the library to list the
32names of files in a directory, rather than performing a full directory listing
33that would normally include file sizes, dates etc.
35For POP3 a parameter of 1 tells the library to list the email message or
36messages on the POP3 server. This can be used to change the default behavior
37of 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.
40For FILE, this option has no effect yet as directories are always listed in
41this mode.
43Note: For FTP this causes a NLST command to be sent to the FTP server. Beware
44that some FTP servers list only files in their response to NLST; they might
45not include subdirectories and symbolic links.
47Setting this option to 1 also implies a directory listing even if the URL
48does not end with a slash, which otherwise is necessary.
50Do not use this option if you also use CURLOPT_WILDCARDMATCH(3) as it
51effectively breaks that feature.
53# DEFAULT
550, disabled
57# %PROTOCOLS%
59# EXAMPLE
61~~~c
62int main(void)
64 CURL *curl = curl_easy_init();
65 if(curl) {
66 CURLcode result;
67 curl_easy_setopt(curl, CURLOPT_URL, "ftp://example.com/dir/");
69 /* list only */
70 curl_easy_setopt(curl, CURLOPT_DIRLISTONLY, 1L);
72 result = curl_easy_perform(curl);
74 curl_easy_cleanup(curl);
75 }
77~~~
79# HISTORY
81This option was known as CURLOPT_FTPLISTONLY up to 7.16.4. POP3 is supported
82since 7.21.5.
84# %AVAILABILITY%
86# RETURN VALUE
88curl_easy_setopt(3) returns a CURLcode indicating success or error.
90CURLE_OK (0) means everything was OK, non-zero means an error occurred, see
91libcurl-errors(3).
Diagnostics4 git calls · 152 ms
CallStatusSizeTime0152 ms
discover200152 B2 ms
git.upload-pack discover
http.response.status_code=200
git.upstream.cf_ray=-
git.upstream.phase=fetch
git.upstream.dur_ms=2
git.response.bytes=152
git.server.agent=gitty/1.0
git.server.object_format=sha1
git.server.caps=agent ls-refs fetch object-format
git.server.fetch=shallow filter sideband-all
git.protocol.version=2
git.pkt.frames=8
git.pkt.data=6
git.pkt.flush=2
git.pkt.delim=0
git.pkt.bytes=152
git.pkt.payload.max=34
ls-refs200149 B · hit2 ms
git.upload-pack ls-refs
http.response.status_code=200
git.upstream.cf_ray=-
git.upstream.phase=ls-refs
git.upstream.dur_ms=2
git.response.bytes=149
git.response.cache=HIT
git.response.duration_ms=2
git.protocol.version=2
git.pkt.frames=3
git.pkt.data=2
git.pkt.flush=1
git.pkt.delim=0
git.pkt.bytes=149
git.pkt.payload.max=78
git.ls_refs.count=2
git.ls_refs.head=refs/heads/master
fetchblob:none · deepen 10200287 KiB · hit2 ms
git.upload-pack fetch
http.response.status_code=200
git.upstream.cf_ray=-
git.upstream.phase=fetch
git.upstream.dur_ms=148
git.response.bytes=293470
git.response.cache=HIT
git.response.duration_ms=2
git.fetch.filter=blob:none
git.fetch.filter.requested=tree:0
git.fetch.filter.fallback=blob:none
git.fetch.filter.learned=false
git.fetch.wants=31c911efe5652725e930f4d2e60c9060e5f6646d
git.fetch.haves.count=0
git.fetch.deepen=10
git.fetch.thin_pack=false
git.fetch.ofs_delta=true
git.protocol.version=2
git.pkt.frames=10
git.pkt.data=8
git.pkt.flush=1
git.pkt.delim=1
git.pkt.bytes=293470
git.pkt.payload.max=65516
git.sideband.band1.bytes=293354
git.sideband.band2.bytes=0
git.sideband.band3.bytes=0
git.pack.objects=87
git.pack.bytes=293354
git.pack.ofs_delta=0
git.pack.ref_delta=1
git.pack.chain.max=1
git.pack.trailer=6a646bcda6740bab42e321b51998b52ea15146c0
git.pack.full=86
Open pack map
fetch2001.2 KiB148 ms
git.upload-pack fetch
http.response.status_code=200
git.response.bytes=1230
git.response.cache=MISS
git.response.duration_ms=148
git.fetch.wants=548d1f0bf6eea47e582ffcad3276ac4eb1549f89
git.fetch.haves.count=0
git.fetch.deepen=0
git.fetch.thin_pack=false
git.fetch.ofs_delta=true
git.protocol.version=2
git.pkt.frames=3
git.pkt.data=2
git.pkt.flush=1
git.pkt.delim=0
git.pkt.bytes=1230
git.pkt.payload.max=1209
git.sideband.band1.bytes=1208
git.sideband.band2.bytes=0
git.sideband.band3.bytes=0

Each row is one HTTP round trip ply made to the git server for this page, on one timeline. discover asks what the server speaks, ls-refs lists branch tips, fetch brings objects by id. A hit was served by Workers Cache. Tap a row for its wire details.

Remote
https://5ad2236b39de4c8bd8f6270ea63f3ea9.artifacts.cloudflare.net/git/public-v0/curl.git
Ref
refs/heads/master
Commit
31c911efe5652725e930f4d2e60c9060e5f6646d
cf-ray
a5e365036a85b23b
Request
88efecf2…
Protocol
v2 · sha1
Agent
gitty/1.0
Filter
advertised
Fetch
shallow filter sideband-all
Capabilities
agent ls-refs fetch object-format