browser/external/curl-8.3.0/docs/cmdline-opts/list-only.d
2023-09-27 13:43:06 -04:00

37 lines
1.4 KiB
Makefile

c: Copyright (C) Daniel Stenberg, <daniel@haxx.se>, et al.
SPDX-License-Identifier: curl
Long: list-only
Short: l
Protocols: FTP POP3 SFTP
Help: List only mode
Added: 4.0
Category: ftp pop3 sftp
Example: --list-only ftp://example.com/dir/
See-also: quote request
Multi: boolean
---
(FTP)
When listing an FTP directory, this switch forces a name-only view. This is
especially useful if the user wants to machine-parse the contents of an FTP
directory since the normal directory view does not use a standard look or
format. When used like this, the option causes an NLST command to be sent to
the server instead of LIST.
Note: Some FTP servers list only files in their response to NLST; they do not
include sub-directories and symbolic links.
(SFTP)
When listing an SFTP directory, this switch forces a name-only view, one per line.
This is especially useful if the user wants to machine-parse the contents of an
SFTP directory since the normal directory view provides more information than just
file names.
(POP3)
When retrieving a specific email from POP3, this switch forces a LIST command
to be performed instead of RETR. This is particularly useful if the user wants
to see if a specific message-id exists on the server and what size it is.
Note: When combined with --request, this option can be used to send a UIDL
command instead, so the user may use the email's unique identifier rather than
its message-id to make the request.