;type=text/html\(aq \\
\-F \(aq=)\(aq \-F \(aq=@textfile.txt\(aq ... smtp://example.com
.fi
Data can be encoded for transfer using encoder=. Available encodings are
\fIbinary\fP and \fI8bit\fP that do nothing else than adding the corresponding
Content\-Transfer\-Encoding header, \fI7bit\fP that only rejects 8\-bit characters
with a transfer error, \fIquoted\-printable\fP and \fIbase64\fP that encodes data
according to the corresponding schemes, limiting lines length to 76
characters.
Example: send multipart mail with a quoted\-printable text message and a
base64 attached file:
.nf
curl \-F \(aq=text message;encoder=quoted\-printable\(aq \\
\-F \(aq=@localfile;encoder=base64\(aq ... smtp://example.com
.fi
See further examples and details in the MANUAL.
--form can be used several times in a command line
Example:
.nf
curl --form "name=curl" --form "file=@loadthis" https://example.com
.fi
This option is mutually exclusive with \fI-d, \-\-data\fP, \fI-I, \-\-head\fP and \fI-T, \-\-upload\-file\fP.
See also \fI-d, \-\-data\fP, \fI\-\-form\-string\fP and \fI\-\-form\-escape\fP.
.IP "\-\-form\-escape"
(HTTP imap smtp) Pass on names of multipart form fields and files using backslash\-escaping
instead of percent\-encoding.
If --form-escape is provided several times, the last set value is used.
Example:
.nf
curl --form-escape -F 'field\\name=curl' -F 'file=@load"this' https://example.com
.fi
Added in 7.81.0. See also \fI-F, \-\-form\fP.
.IP "\-\-form\-string "
(HTTP SMTP IMAP) Similar to \fI\-F, \-\-form\fP except that the value string for the named parameter is used
literally. Leading @ and < characters, and the ";type=" string in the value
have no special meaning. Use this in preference to \fI\-F, \-\-form\fP if there is any
possibility that the string value may accidentally trigger the @ or <
features of \fI\-F, \-\-form\fP.
--form-string can be used several times in a command line
Example:
.nf
curl --form-string "name=data" https://example.com
.fi
See also \fI-F, \-\-form\fP.
.IP "\-\-ftp\-account "
(FTP) When an FTP server asks for "account data" after username and password has
been provided, this data is sent off using the ACCT command.
If --ftp-account is provided several times, the last set value is used.
Example:
.nf
curl --ftp-account "mr.robot" ftp://example.com/
.fi
See also \fI-u, \-\-user\fP.
.IP "\-\-ftp\-alternative\-to\-user "
(FTP) If authenticating with the USER and PASS commands fails, send this command.
When connecting to Tumbleweed\(aqs Secure Transport server over FTPS using a
client certificate, using "SITE AUTH" tells the server to retrieve the
username from the certificate.
If --ftp-alternative-to-user is provided several times, the last set value is used.
Example:
.nf
curl --ftp-alternative-to-user "U53r" ftp://example.com
.fi
See also \fI\-\-ftp\-account\fP and \fI-u, \-\-user\fP.
.IP "\-\-ftp\-create\-dirs"
(FTP SFTP) When an FTP or SFTP URL/operation uses a path that does not currently exist on
the server, the standard behavior of curl is to fail. Using this option, curl
instead attempts to create missing directories.
Providing --ftp-create-dirs multiple times has no extra effect.
Disable it again with \-\-no-ftp-create-dirs.
Example:
.nf
curl --ftp-create-dirs -T file ftp://example.com/remote/path/file
.fi
See also \fI\-\-create\-dirs\fP.
.IP "\-\-ftp\-method "
(FTP) Control what method curl should use to reach a file on an FTP(S)
server. The method argument should be one of the following alternatives:
.RS
.IP multicwd
Do a single CWD operation for each path part in the given URL. For deep
hierarchies this means many commands. This is how RFC 1738 says it should be
done. This is the default but the slowest behavior.
.IP nocwd
Do no CWD at all. curl does SIZE, RETR, STOR etc and gives the full path to
the server for each of these commands. This is the fastest behavior.
.IP singlecwd
Do one CWD with the full target directory and then operate on the file
\&"normally" (like in the multicwd case). This is somewhat more standards
compliant than "nocwd" but without the full penalty of "multicwd".
.RE
.IP
If --ftp-method is provided several times, the last set value is used.
Examples:
.nf
curl --ftp-method multicwd ftp://example.com/dir1/dir2/file
curl --ftp-method nocwd ftp://example.com/dir1/dir2/file
curl --ftp-method singlecwd ftp://example.com/dir1/dir2/file
.fi
See also \fI-l, \-\-list\-only\fP.
.IP "\-\-ftp\-pasv"
(FTP) Use passive mode for the data connection. Passive is the internal default
behavior, but using this option can be used to override a previous \fI\-P, \-\-ftp\-port\fP
option.
Reversing an enforced passive really is not doable but you must then instead
enforce the correct \fI\-P, \-\-ftp\-port\fP again.
Passive mode means that curl tries the EPSV command first and then PASV,
unless \fI\-\-disable\-epsv\fP is used.
Providing --ftp-pasv multiple times has no extra effect.
Disable it again with \-\-no-ftp-pasv.
Example:
.nf
curl --ftp-pasv ftp://example.com/
.fi
See also \fI\-\-disable\-epsv\fP.
.IP "\-P, \-\-ftp\-port "
(FTP) Reverse the default initiator/listener roles when connecting with FTP. This
option makes curl use active mode. curl then commands the server to connect
back to the client\(aqs specified address and port, while passive mode asks the
server to setup an IP address and port for it to connect to.
should be one of:
.RS
.IP interface
e.g. \fBeth0\fP to specify which interface\(aqs IP address you want to use (Unix only)
.IP "IP address"
e.g. \fB192.168.10.1\fP to specify the exact IP address
.IP hostname
e.g. \fBmy.host.domain\fP to specify the machine
.IP -
make curl pick the same IP address that is already used for the control
connection. This is the recommended choice.
.RE
.IP
Disable the use of PORT with \fI\-\-ftp\-pasv\fP. Disable the attempt to use the EPRT
command instead of PORT by using \fI\-\-disable\-eprt\fP. EPRT is really PORT++.
You can also append ":[start]\-[end]" to the right of the address, to tell
curl what TCP port range to use. That means you specify a port range, from a
lower to a higher number. A single number works as well, but do note that it
increases the risk of failure since the port may not be available.
If --ftp-port is provided several times, the last set value is used.
Examples:
.nf
curl -P - ftp:/example.com
curl -P eth0 ftp:/example.com
curl -P 192.168.0.2 ftp:/example.com
.fi
See also \fI\-\-ftp\-pasv\fP and \fI\-\-disable\-eprt\fP.
.IP "\-\-ftp\-pret"
(FTP) Send a PRET command before PASV (and EPSV). Certain FTP servers, mainly
drftpd, require this non\-standard command for directory listings as well as up
and downloads in PASV mode.
Providing --ftp-pret multiple times has no extra effect.
Disable it again with \-\-no-ftp-pret.
Example:
.nf
curl --ftp-pret ftp://example.com/
.fi
See also \fI-P, \-\-ftp\-port\fP and \fI\-\-ftp\-pasv\fP.
.IP "\-\-ftp\-skip\-pasv\-ip"
(FTP) Do not use the IP address the server suggests in its response to curl\(aqs PASV
command when curl connects the data connection. Instead curl reuses the same
IP address it already uses for the control connection.
This option is enabled by default (added in 7.74.0).
This option has no effect if PORT, EPRT or EPSV is used instead of PASV.
Providing --ftp-skip-pasv-ip multiple times has no extra effect.
Disable it again with \-\-no-ftp-skip-pasv-ip.
Example:
.nf
curl --ftp-skip-pasv-ip ftp://example.com/
.fi
See also \fI\-\-ftp\-pasv\fP.
.IP "\-\-ftp\-ssl\-ccc"
(FTP) Use CCC (Clear Command Channel) Shuts down the SSL/TLS layer after
authenticating. The rest of the control channel communication is be
unencrypted. This allows NAT routers to follow the FTP transaction. The
default mode is passive.
Providing --ftp-ssl-ccc multiple times has no extra effect.
Disable it again with \-\-no-ftp-ssl-ccc.
Example:
.nf
curl --ftp-ssl-ccc ftps://example.com/
.fi
See also \fI\-\-ssl\fP and \fI\-\-ftp\-ssl\-ccc\-mode\fP.
.IP "\-\-ftp\-ssl\-ccc\-mode "
(FTP) Set the CCC mode. The passive mode does not initiate the shutdown, but instead
waits for the server to do it, and does not reply to the shutdown from the
server. The active mode initiates the shutdown and waits for a reply from the
server.
Providing --ftp-ssl-ccc-mode multiple times has no extra effect.
Disable it again with \-\-no-ftp-ssl-ccc-mode.
Example:
.nf
curl --ftp-ssl-ccc-mode active --ftp-ssl-ccc ftps://example.com/
.fi
See also \fI\-\-ftp\-ssl\-ccc\fP.
.IP "\-\-ftp\-ssl\-control"
(FTP) Require SSL/TLS for the FTP login, clear for transfer. Allows secure
authentication, but non\-encrypted data transfers for efficiency. Fails the
transfer if the server does not support SSL/TLS.
Providing --ftp-ssl-control multiple times has no extra effect.
Disable it again with \-\-no-ftp-ssl-control.
Example:
.nf
curl --ftp-ssl-control ftp://example.com
.fi
See also \fI\-\-ssl\fP.
.IP "\-G, \-\-get"
(HTTP) When used, this option makes all data specified with \fI\-d, \-\-data\fP, \fI\-\-data\-binary\fP or
\fI\-\-data\-urlencode\fP to be used in an HTTP GET request instead of the POST request
that otherwise would be used. curl appends the provided data to the URL as a
query string.
If used in combination with \fI\-I, \-\-head\fP, the POST data is instead appended to the
URL with a HEAD request.
Providing --get multiple times has no extra effect.
Disable it again with \-\-no-get.
Examples:
.nf
curl --get https://example.com
curl --get -d "tool=curl" -d "age=old" https://example.com
curl --get -I -d "tool=curl" https://example.com
.fi
See also \fI-d, \-\-data\fP and \fI-X, \-\-request\fP.
.IP "\-g, \-\-globoff"
Switch off the URL globbing function. When you set this option, you can
specify URLs that contain the letters {}[] without having curl itself
interpret them. Note that these letters are not normal legal URL contents but
they should be encoded according to the URI standard.
Providing --globoff multiple times has no extra effect.
Disable it again with \-\-no-globoff.
Example:
.nf
curl -g "https://example.com/{[]}}}}"
.fi
See also \fI-K, \-\-config\fP and \fI-q, \-\-disable\fP.
.IP "\-\-happy\-eyeballs\-timeout\-ms "
Set the timeout for Happy Eyeballs.
Happy Eyeballs is an algorithm that attempts to connect to both IPv4 and IPv6
addresses for dual\-stack hosts, giving IPv6 a head\-start of the specified
number of milliseconds. If the IPv6 address cannot be connected to within that
time, then a connection attempt is made to the IPv4 address in parallel. The
first connection to be established is the one that is used.
The range of suggested useful values is limited. Happy Eyeballs RFC 6555 says
\&"It is RECOMMENDED that connection attempts be paced 150\-250 ms apart to
balance human factors against network load." libcurl currently defaults to
200 ms. Firefox and Chrome currently default to 300 ms.
If --happy-eyeballs-timeout-ms is provided several times, the last set value is used.
Example:
.nf
curl --happy-eyeballs-timeout-ms 500 https://example.com
.fi
See also \fI-m, \-\-max\-time\fP and \fI\-\-connect\-timeout\fP.
.IP "\-\-haproxy\-clientip "
(HTTP) Set a client IP in HAProxy PROXY protocol v1 header at the beginning of the
connection.
For valid requests, IPv4 addresses must be indicated as a series of exactly
4 integers in the range [0..255] inclusive written in decimal representation
separated by exactly one dot between each other. Heading zeroes are not
permitted in front of numbers in order to avoid any possible confusion
with octal numbers. IPv6 addresses must be indicated as series of 4 hexadecimal
digits (upper or lower case) delimited by colons between each other, with the
acceptance of one double colon sequence to replace the largest acceptable range
of consecutive zeroes. The total number of decoded bits must exactly be 128.
Otherwise, any string can be accepted for the client IP and get sent.
It replaces \fI\-\-haproxy\-protocol\fP if used, it is not necessary to specify both flags.
If --haproxy-clientip is provided several times, the last set value is used.
Example:
.nf
curl --haproxy-clientip $IP
.fi
Added in 8.2.0. See also \fI-x, \-\-proxy\fP.
.IP "\-\-haproxy\-protocol"
(HTTP) Send a HAProxy PROXY protocol v1 header at the beginning of the connection.
This is used by some load balancers and reverse proxies to indicate the
client\(aqs true IP address and port.
This option is primarily useful when sending test requests to a service that
expects this header.
Providing --haproxy-protocol multiple times has no extra effect.
Disable it again with \-\-no-haproxy-protocol.
Example:
.nf
curl --haproxy-protocol https://example.com
.fi
Added in 7.60.0. See also \fI-x, \-\-proxy\fP.
.IP "\-I, \-\-head"
(HTTP FTP FILE) Fetch the headers only. HTTP\-servers feature the command HEAD which this uses
to get nothing but the header of a document. When used on an FTP or FILE URL,
curl displays the file size and last modification time only.
Providing --head multiple times has no extra effect.
Disable it again with \-\-no-head.
Example:
.nf
curl -I https://example.com
.fi
See also \fI-G, \-\-get\fP, \fI-v, \-\-verbose\fP and \fI\-\-trace\-ascii\fP.
.IP "\-H, \-\-header "
(HTTP IMAP SMTP) Extra header to include in information sent. When used within an HTTP request,
it is added to the regular request headers.
For an IMAP or SMTP MIME uploaded mail built with \fI\-F, \-\-form\fP options, it is
prepended to the resulting MIME document, effectively including it at the mail
global level. It does not affect raw uploaded mails.
You may specify any number of extra headers. Note that if you should add a
custom header that has the same name as one of the internal ones curl would
use, your externally set header is used instead of the internal one. This
allows you to make even trickier stuff than curl would normally do. You should
not replace internally set headers without knowing perfectly well what you are
doing. Remove an internal header by giving a replacement without content on
the right side of the colon, as in: \-H "Host:". If you send the custom header
with no\-value then its header must be terminated with a semicolon, such as \-H
\&"X\-Custom\-Header;" to send "X\-Custom\-Header:".
curl makes sure that each header you add/replace is sent with the proper
end\-of\-line marker, you should thus \fBnot\fP add that as a part of the header
content: do not add newlines or carriage returns, they only mess things up for
you. curl passes on the verbatim string you give it without any filter or
other safe guards. That includes white space and control characters.
This option can take an argument in @filename style, which then adds a header
for each line in the input file. Using @\- makes curl read the header file from
stdin.
Please note that most anti\-spam utilities check the presence and value of
several MIME mail headers: these are "From:", "To:", "Date:" and "Subject:"
among others and should be added with this option.
You need \fI\-\-proxy\-header\fP to send custom headers intended for an HTTP proxy.
Passing on a "Transfer\-Encoding: chunked" header when doing an HTTP request
with a request body, makes curl send the data using chunked encoding.
\fBWARNING\fP: headers set with this option are set in all HTTP requests \- even
after redirects are followed, like when told with \fI\-L, \-\-location\fP. This can lead to
the header being sent to other hosts than the original host, so sensitive
headers should be used with caution combined with following redirects.
\&"Authorization:" and "Cookie:" headers are explicitly \fInot\fP passed on in HTTP
requests when following redirects to other origins, unless \fI\-\-location\-trusted\fP
is used.
--header can be used several times in a command line
Examples:
.nf
curl -H "X-First-Name: Joe" https://example.com
curl -H "User-Agent: yes-please/2000" https://example.com
curl -H "Host:" https://example.com
curl -H @headers.txt https://example.com
.fi
See also \fI-A, \-\-user\-agent\fP and \fI-e, \-\-referer\fP.
.IP "\-h, \-\-help "
Usage help. Provide help for the subject given as an optional argument.
If no argument is provided, curl displays the most important command line
arguments.
The argument can either be a \fBcategory\fP or a \fBcommand line option\fP. When a
category is provided, curl shows all command line options within the given
category. Specify category "all" to list all available options.
If "category" is specified, curl displays all available help categories.
If the provided subject is instead an existing command line option, specified
either in its short form with a single dash and a single letter, or in the
long form with two dashes and a longer name, curl displays a help text for
that option in the terminal.
The help output is extensive for some options.
If the provided command line option is not known, curl says so.
Examples:
.nf
curl --help all
curl --help --insecure
curl --help -f
.fi
See also \fI-v, \-\-verbose\fP.
.IP "\-\-hostpubmd5 "
(SFTP SCP) Pass a string containing 32 hexadecimal digits. The string should be the 128
bit \fBMD5\fP checksum of the remote host\(aqs public key, curl refuses the
connection with the host unless the checksums match.
If --hostpubmd5 is provided several times, the last set value is used.
Example:
.nf
curl --hostpubmd5 e5c1c49020640a5ab0f2034854c321a8 sftp://example.com/
.fi
See also \fI\-\-hostpubsha256\fP.
.IP "\-\-hostpubsha256 "
(SFTP SCP) Pass a string containing a Base64\-encoded SHA256 hash of the remote host\(aqs
public key. curl refuses the connection with the host unless the hashes match.
This feature requires libcurl to be built with libssh2 and does not work with
other SSH backends.
If --hostpubsha256 is provided several times, the last set value is used.
Example:
.nf
curl --hostpubsha256 NDVkMTQxMGQ1ODdmMjQ3MjczYjAyOTY5MmRkMjVmNDQ= sftp://example.com/
.fi
Added in 7.80.0. See also \fI\-\-hostpubmd5\fP.
.IP "\-\-hsts "
(HTTPS) Enable HSTS for the transfer. If the filename points to an existing HSTS cache
file, that is used. After a completed transfer, the cache is saved to the
filename again if it has been modified.
If curl is told to use HTTP:// for a transfer involving a hostname that exists
in the HSTS cache, it upgrades the transfer to use HTTPS. Each HSTS cache
entry has an individual life time after which the upgrade is no longer
performed.
Specify a "" filename (zero length) to avoid loading/saving and make curl just
handle HSTS in memory.
If this option is used several times, curl loads contents from all the
files but the last one is used for saving.
--hsts can be used several times in a command line
Example:
.nf
curl --hsts cache.txt https://example.com
.fi
Added in 7.74.0. See also \fI\-\-proto\fP.
.IP "\-\-http0.9"
(HTTP) Accept an HTTP version 0.9 response.
HTTP/0.9 is a response without headers and therefore you can also connect with
this to non\-HTTP servers and still get a response since curl simply
transparently downgrades \- if allowed.
HTTP/0.9 is disabled by default (added in 7.66.0)
Providing --http0.9 multiple times has no extra effect.
Disable it again with \-\-no-http0.9.
Example:
.nf
curl --http0.9 https://example.com
.fi
Added in 7.64.0. See also \fI\-\-http1.1\fP, \fI\-\-http2\fP and \fI\-\-http3\fP.
.IP "\-0, \-\-http1.0"
(HTTP) Use HTTP version 1.0 instead of using its internally preferred HTTP version.
Providing --http1.0 multiple times has no extra effect.
Example:
.nf
curl --http1.0 https://example.com
.fi
This option is mutually exclusive with \fI\-\-http1.1\fP, \fI\-\-http2\fP, \fI\-\-http2\-prior\-knowledge\fP and \fI\-\-http3\fP.
See also \fI\-\-http0.9\fP and \fI\-\-http1.1\fP.
.IP "\-\-http1.1"
(HTTP) Use HTTP version 1.1. This is the default with HTTP:// URLs.
Providing --http1.1 multiple times has no extra effect.
Example:
.nf
curl --http1.1 https://example.com
.fi
This option is mutually exclusive with \fI\-\-http1.0\fP, \fI\-\-http2\fP, \fI\-\-http2\-prior\-knowledge\fP and \fI\-\-http3\fP.
See also \fI\-\-http1.0\fP and \fI\-\-http0.9\fP.
.IP "\-\-http2"
(HTTP) Use HTTP/2.
For HTTPS, this means curl negotiates HTTP/2 in the TLS handshake. curl does
this by default.
For HTTP, this means curl attempts to upgrade the request to HTTP/2 using the
Upgrade: request header.
When curl uses HTTP/2 over HTTPS, it does not itself insist on TLS 1.2 or
higher even though that is required by the specification. A user can add this
version requirement with \fI\-\-tlsv1.2\fP.
Providing --http2 multiple times has no extra effect.
Example:
.nf
curl --http2 https://example.com
.fi
\fI\-\-http2\fP requires that libcurl is built to support HTTP/2.
This option is mutually exclusive with \fI\-\-http1.1\fP, \fI\-\-http1.0\fP, \fI\-\-http2\-prior\-knowledge\fP and \fI\-\-http3\fP.
See also \fI\-\-http1.1\fP, \fI\-\-http3\fP and \fI\-\-no\-alpn\fP.
.IP "\-\-http2\-prior\-knowledge"
(HTTP) Issue a non\-TLS HTTP requests using HTTP/2 directly without HTTP/1.1 Upgrade.
It requires prior knowledge that the server supports HTTP/2 straight away.
HTTPS requests still do HTTP/2 the standard way with negotiated protocol
version in the TLS handshake.
Since 8.10.0 if this option is set for an HTTPS request then the application
layer protocol version (ALPN) offered to the server is only HTTP/2. Prior to
that both HTTP/1.1 and HTTP/2 were offered.
Providing --http2-prior-knowledge multiple times has no extra effect.
Disable it again with \-\-no-http2-prior-knowledge.
Example:
.nf
curl --http2-prior-knowledge https://example.com
.fi
\fI\-\-http2\-prior\-knowledge\fP requires that libcurl is built to support HTTP/2.
This option is mutually exclusive with \fI\-\-http1.1\fP, \fI\-\-http1.0\fP, \fI\-\-http2\fP and \fI\-\-http3\fP.
See also \fI\-\-http2\fP and \fI\-\-http3\fP.
.IP "\-\-http3"
(HTTP) Attempt HTTP/3 to the host in the URL, but fallback to earlier HTTP versions
if the HTTP/3 connection establishment fails or is slow. HTTP/3 is only
available for HTTPS and not for HTTP URLs.
This option allows a user to avoid using the Alt\-Svc method of upgrading to
HTTP/3 when you know or suspect that the target speaks HTTP/3 on the given
host and port.
When asked to use HTTP/3, curl issues a separate attempt to use older HTTP
versions with a slight delay, so if the HTTP/3 transfer fails or is slow, curl
still tries to proceed with an older HTTP version. The fallback performs the
regular negotiation between HTTP/1 and HTTP/2.
Use \fI\-\-http3\-only\fP for similar functionality \fIwithout\fP a fallback.
Providing --http3 multiple times has no extra effect.
Example:
.nf
curl --http3 https://example.com
.fi
\fI\-\-http3\fP requires that libcurl is built to support HTTP/3.
This option is mutually exclusive with \fI\-\-http1.1\fP, \fI\-\-http1.0\fP, \fI\-\-http2\fP, \fI\-\-http2\-prior\-knowledge\fP and \fI\-\-http3\-only\fP.
Added in 7.66.0. See also \fI\-\-http1.1\fP and \fI\-\-http2\fP.
.IP "\-\-http3\-only"
(HTTP) Instruct curl to use HTTP/3 to the host in the URL, with no fallback to
earlier HTTP versions. HTTP/3 can only be used for HTTPS and not for HTTP
URLs. For HTTP, this option triggers an error.
This option allows a user to avoid using the Alt\-Svc method of upgrading to
HTTP/3 when you know that the target speaks HTTP/3 on the given host and port.
This option makes curl fail if a QUIC connection cannot be established, it
does not attempt any other HTTP versions on its own. Use \fI\-\-http3\fP for similar
functionality \fIwith\fP a fallback.
Providing --http3-only multiple times has no extra effect.
Example:
.nf
curl --http3-only https://example.com
.fi
\fI\-\-http3\-only\fP requires that libcurl is built to support HTTP/3.
This option is mutually exclusive with \fI\-\-http1.1\fP, \fI\-\-http1.0\fP, \fI\-\-http2\fP, \fI\-\-http2\-prior\-knowledge\fP and \fI\-\-http3\fP.
Added in 7.88.0. See also \fI\-\-http1.1\fP, \fI\-\-http2\fP and \fI\-\-http3\fP.
.IP "\-\-ignore\-content\-length"
(FTP HTTP) For HTTP, ignore the Content\-Length header. This is particularly useful for
servers running Apache 1.x, which reports incorrect Content\-Length for files
larger than 2 gigabytes.
For FTP, this makes curl skip the SIZE command to figure out the size before
downloading a file.
Providing --ignore-content-length multiple times has no extra effect.
Disable it again with \-\-no-ignore-content-length.
Example:
.nf
curl --ignore-content-length https://example.com
.fi
See also \fI\-\-ftp\-skip\-pasv\-ip\fP.
.IP "\-k, \-\-insecure"
(TLS SFTP SCP) By default, every secure connection curl makes is verified to be secure before
the transfer takes place. This option makes curl skip the verification step
and proceed without checking.
When this option is not used for protocols using TLS, curl verifies the
server\(aqs TLS certificate before it continues: that the certificate contains
the right name which matches the hostname used in the URL and that the
certificate has been signed by a CA certificate present in the cert store. See
this online resource for further details:
\fBhttps://curl.se/docs/sslcerts.html\fP
For SFTP and SCP, this option makes curl skip the \fIknown_hosts\fP verification.
\fIknown_hosts\fP is a file normally stored in the user\(aqs home directory in the
\&".ssh" subdirectory, which contains hostnames and their public keys.
\fBWARNING\fP: using this option makes the transfer insecure.
When curl uses secure protocols it trusts responses and allows for example
HSTS and Alt\-Svc information to be stored and used subsequently. Using
\fI\-k, \-\-insecure\fP can make curl trust and use such information from malicious
servers.
Providing --insecure multiple times has no extra effect.
Disable it again with \-\-no-insecure.
Example:
.nf
curl --insecure https://example.com
.fi
See also \fI\-\-proxy\-insecure\fP, \fI\-\-cacert\fP and \fI\-\-capath\fP.
.IP "\-\-interface "
Perform the operation using a specified interface. You can enter interface
name, IP address or hostname. If you prefer to be specific, you can use the
following special syntax:
.RS
.IP if!
Interface name. If the provided name does not match an existing interface,
curl returns with error 45.
.IP host!
IP address or hostname.
.IP ifhost!!
Interface name and IP address or hostname. This syntax requires libcurl 8.9.0
or later.
If the provided name does not match an existing interface, curl returns with
error 45.
.RE
.IP
curl does not support using network interface names for this option on
Windows.
That name resolve operation if a hostname is provided does \fBnot\fP use
DNS\-over\-HTTPS even if \fI\-\-doh\-url\fP is set.
On Linux this option can be used to specify a \fBVRF\fP (Virtual Routing and
Forwarding) device, but the binary then needs to either have the
\fBCAP_NET_RAW\fP capability set or to be run as root.
If --interface is provided several times, the last set value is used.
Examples:
.nf
curl --interface eth0 https://example.com
curl --interface "host!10.0.0.1" https://example.com
curl --interface "if!enp3s0" https://example.com
.fi
See also \fI\-\-dns\-interface\fP.
.IP "\-\-ip\-tos "
(All) Set Type of Service (TOS) for IPv4 or Traffic Class for IPv6.
The values allowed for can be a numeric value between 1 and 255
or one of the following:
CS0, CS1, CS2, CS3, CS4, CS5, CS6, CS7, AF11, AF12, AF13, AF21, AF22, AF23,
AF31, AF32, AF33, AF41, AF42, AF43, EF, VOICE\-ADMIT, ECT1, ECT0, CE, LE,
LOWCOST, LOWDELAY, THROUGHPUT, RELIABILITY, MINCOST
If --ip-tos is provided several times, the last set value is used.
Example:
.nf
curl --ip-tos CS5 https://example.com
.fi
Added in 8.9.0. See also \fI\-\-tcp\-nodelay\fP and \fI\-\-vlan\-priority\fP.
.IP "\-\-ipfs\-gateway "
(IPFS) Specify which gateway to use for IPFS and IPNS URLs. Not specifying this
instead makes curl check if the IPFS_GATEWAY environment variable is set, or
if a "~/.ipfs/gateway" file holding the gateway URL exists.
If you run a local IPFS node, this gateway is by default available under
\&"http://localhost:8080". A full example URL would look like:
.nf
curl \--ipfs\-gateway http://localhost:8080 \\
ipfs://bafybeigagd5nmnn2iys2f3
.fi
There are many public IPFS gateways. See for example:
https://ipfs.github.io/public\-gateway\-checker/
If you opt to go for a remote gateway you need to be aware that you completely
trust the gateway. This might be fine in local gateways that you host
yourself. With remote gateways there could potentially be malicious actors
returning you data that does not match the request you made, inspect or even
interfere with the request. You may not notice this when using curl. A
mitigation could be to go for a "trustless" gateway. This means you locally
verify that the data. Consult the docs page on trusted vs trustless:
https://docs.ipfs.tech/reference/http/gateway/#trusted\-vs\-trustless
If --ipfs-gateway is provided several times, the last set value is used.
Example:
.nf
curl --ipfs-gateway https://example.com ipfs://
.fi
Added in 8.4.0. See also \fI-h, \-\-help\fP and \fI-M, \-\-manual\fP.
.IP "\-4, \-\-ipv4"
Use IPv4 addresses only when resolving hostnames, and not for example try
IPv6.
Providing --ipv4 multiple times has no extra effect.
Example:
.nf
curl --ipv4 https://example.com
.fi
This option is mutually exclusive with \fI-6, \-\-ipv6\fP.
See also \fI\-\-http1.1\fP and \fI\-\-http2\fP.
.IP "\-6, \-\-ipv6"
Use IPv6 addresses only when resolving hostnames, and not for example try
IPv4.
Your resolver may respond to an IPv6\-only resolve request by returning IPv6
addresses that contain "mapped" IPv4 addresses for compatibility purposes.
macOS is known to do this.
Providing --ipv6 multiple times has no extra effect.
Example:
.nf
curl --ipv6 https://example.com
.fi
This option is mutually exclusive with \fI-4, \-\-ipv4\fP.
See also \fI\-\-http1.1\fP and \fI\-\-http2\fP.
.IP "\-\-json "
(HTTP) Send the specified JSON data in a POST request to the HTTP server. \fI\-\-json\fP
works as a shortcut for passing on these three options:
.nf
-\-data\-binary [arg]
-\-header "Content\-Type: application/json"
-\-header "Accept: application/json"
.fi
There is \fBno verification\fP that the passed in data is actual JSON or that
the syntax is correct.
If you start the data with the letter @, the rest should be a filename to read
the data from, or a single dash (\-) if you want curl to read the data from
stdin. Posting data from a file named \(aqfoobar\(aq would thus be done with \fI\-\-json\fP
@foobar and to instead read the data from stdin, use \fI\-\-json\fP @\-.
If this option is used more than once on the same command line, the additional
data pieces are concatenated to the previous before sending.
The headers this option sets can be overridden with \fI\-H, \-\-header\fP as usual.
--json can be used several times in a command line
Examples:
.nf
curl --json '{ "drink": "coffe" }' https://example.com
curl --json '{ "drink":' --json ' "coffe" }' https://example.com
curl --json @prepared https://example.com
curl --json @- https://example.com < json.txt
.fi
This option is mutually exclusive with \fI-F, \-\-form\fP, \fI-I, \-\-head\fP and \fI-T, \-\-upload\-file\fP.
Added in 7.82.0. See also \fI\-\-data\-binary\fP and \fI\-\-data\-raw\fP.
.IP "\-j, \-\-junk\-session\-cookies"
(HTTP) When curl is told to read cookies from a given file, this option makes it
discard all "session cookies". This has the same effect as if a new session is
started. Typical browsers discard session cookies when they are closed down.
Providing --junk-session-cookies multiple times has no extra effect.
Disable it again with \-\-no-junk-session-cookies.
Example:
.nf
curl --junk-session-cookies -b cookies.txt https://example.com
.fi
See also \fI-b, \-\-cookie\fP and \fI-c, \-\-cookie\-jar\fP.
.IP "\-\-keepalive\-cnt "
Set the maximum number of keepalive probes TCP should send but get no response
before dropping the connection. This option is usually used in conjunction
with \fI\-\-keepalive\-time\fP.
This option is supported on Linux, *BSD/macOS, Windows >=10.0.16299, Solaris
11.4, and recent AIX, HP\-UX and more. This option has no effect if
\fI\-\-no\-keepalive\fP is used.
If unspecified, the option defaults to 9.
If --keepalive-cnt is provided several times, the last set value is used.
Example:
.nf
curl --keepalive-cnt 3 https://example.com
.fi
Added in 8.9.0. See also \fI\-\-keepalive\-time\fP and \fI\-\-no\-keepalive\fP.
.IP "\-\-keepalive\-time "
Set the time a connection needs to remain idle before sending keepalive probes
and the time between individual keepalive probes. It is currently effective on
operating systems offering the "TCP_KEEPIDLE" and "TCP_KEEPINTVL" socket
options (meaning Linux, *BSD/macOS, Windows, Solaris, and recent AIX, HP\-UX and more).
Keepalive is used by the TCP stack to detect broken networks on idle connections.
The number of missed keepalive probes before declaring the connection down is OS
dependent and is commonly 8 (*BSD/macOS/AIX), 9 (Linux/AIX) or 5/10 (Windows), and
this number can be changed by specifying the curl option "keepalive\-cnt".
Note that this option has no effect if \fI\-\-no\-keepalive\fP is used.
If unspecified, the option defaults to 60 seconds.
If --keepalive-time is provided several times, the last set value is used.
Example:
.nf
curl --keepalive-time 20 https://example.com
.fi
See also \fI\-\-no\-keepalive\fP, \fI\-\-keepalive\-cnt\fP and \fI-m, \-\-max\-time\fP.
.IP "\-\-key "
(TLS SSH) Private key filename. Allows you to provide your private key in this separate
file. For SSH, if not specified, curl tries the following candidates in order:
\&"~/.ssh/id_rsa", "~/.ssh/id_dsa", "./id_rsa", "./id_dsa".
If curl is built against OpenSSL library, and the engine pkcs11 or pkcs11
provider is available, then a PKCS#11 URI (RFC 7512) can be used to specify a
private key located in a PKCS#11 device. A string beginning with "pkcs11:" is
interpreted as a PKCS#11 URI. If a PKCS#11 URI is provided, then the \fI\-\-engine\fP
option is set as "pkcs11" if none was provided and the \fI\-\-key\-type\fP option is
set as "ENG" or "PROV" if none was provided (depending on OpenSSL version).
If curl is built against Secure Transport or Schannel then this option is
ignored for TLS protocols (HTTPS, etc). Those backends expect the private key
to be already present in the keychain or PKCS#12 file containing the
certificate.
If --key is provided several times, the last set value is used.
Example:
.nf
curl --cert certificate --key here https://example.com
.fi
See also \fI\-\-key\-type\fP and \fI-E, \-\-cert\fP.
.IP "\-\-key\-type "
(TLS) Private key file type. Specify which type your \fI\-\-key\fP provided private key
is. DER, PEM, and ENG are supported. If not specified, PEM is assumed.
If --key-type is provided several times, the last set value is used.
Example:
.nf
curl --key-type DER --key here https://example.com
.fi
See also \fI\-\-key\fP.
.IP "\-\-krb "
(FTP) Enable Kerberos authentication and use. The level must be entered and should
be one of \(aqclear\(aq, \(aqsafe\(aq, \(aqconfidential\(aq, or \(aqprivate\(aq. Should you use a
level that is not one of these, \(aqprivate\(aq is used.
If --krb is provided several times, the last set value is used.
Example:
.nf
curl --krb clear ftp://example.com/
.fi
\fI\-\-krb\fP requires that libcurl is built to support Kerberos.
See also \fI\-\-delegation\fP and \fI\-\-ssl\fP.
.IP "\-\-libcurl "
Append this option to any ordinary curl command line, and you get
libcurl\-using C source code written to the file that does the equivalent of
what your command\-line operation does.
This option is global and does not need to be specified for each use of --next.
If --libcurl is provided several times, the last set value is used.
Example:
.nf
curl --libcurl client.c https://example.com
.fi
See also \fI-v, \-\-verbose\fP.
.IP "\-\-limit\-rate "
Specify the maximum transfer rate you want curl to use \- for both downloads
and uploads. This feature is useful if you have a limited pipe and you would
like your transfer not to use your entire bandwidth. To make it slower than it
otherwise would be.
The given speed is measured in bytes/second, unless a suffix is appended.
Appending \(aqk\(aq or \(aqK\(aq counts the number as kilobytes, \(aqm\(aq or \(aqM\(aq makes it
megabytes, while \(aqg\(aq or \(aqG\(aq makes it gigabytes. The suffixes (k, M, G, T, P)
are 1024 based. For example 1k is 1024. Examples: 200K, 3m and 1G.
The rate limiting logic works on averaging the transfer speed to no more than
the set threshold over a period of multiple seconds.
If you also use the \fI\-Y, \-\-speed\-limit\fP option, that option takes precedence and
might cripple the rate\-limiting slightly, to help keeping the speed\-limit
logic working.
If --limit-rate is provided several times, the last set value is used.
Examples:
.nf
curl --limit-rate 100K https://example.com
curl --limit-rate 1000 https://example.com
curl --limit-rate 10M https://example.com
.fi
See also \fI\-\-rate\fP, \fI-Y, \-\-speed\-limit\fP and \fI-y, \-\-speed\-time\fP.
.IP "\-l, \-\-list\-only"
(FTP POP3 SFTP FILE) When listing an FTP directory, force a name\-only view. Maybe particularly
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.
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 filenames.
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.
For FILE, this option has no effect yet as directories are always listed in
this mode.
Note: When combined with \fI\-X, \-\-request\fP, this option can be used to send a UIDL
command instead, so the user may use the email\(aqs unique identifier rather than
its message\-id to make the request.
Providing --list-only multiple times has no extra effect.
Disable it again with \-\-no-list-only.
Example:
.nf
curl --list-only ftp://example.com/dir/
.fi
See also \fI-Q, \-\-quote\fP and \fI-X, \-\-request\fP.
.IP "\-\-local\-port "
Set a preferred single number or range (FROM\-TO) of local port numbers to use
for the connection(s). Note that port numbers by nature are a scarce resource
so setting this range to something too narrow might cause unnecessary
connection setup failures.
If --local-port is provided several times, the last set value is used.
Example:
.nf
curl --local-port 1000-3000 https://example.com
.fi
See also \fI-g, \-\-globoff\fP.
.IP "\-L, \-\-location"
(HTTP) If the server reports that the requested page has moved to a different
location (indicated with a Location: header and a 3XX response code), this
option makes curl redo the request to the new place. If used together with
\fI\-i, \-\-show\-headers\fP or \fI\-I, \-\-head\fP, headers from all requested pages are shown.
When authentication is used, or when sending a cookie with "\-H Cookie:", curl
only sends its credentials to the initial host. If a redirect takes curl to a
different host, it does not get the credentials passed on. See
\fI\-\-location\-trusted\fP on how to change this.
Limit the amount of redirects to follow by using the \fI\-\-max\-redirs\fP option.
When curl follows a redirect and if the request is a POST, it sends the
following request with a GET if the HTTP response was 301, 302, or 303. If the
response code was any other 3xx code, curl resends the following request using
the same unmodified method.
You can tell curl to not change POST requests to GET after a 30x response by
using the dedicated options for that: \fI\-\-post301\fP, \fI\-\-post302\fP and \fI\-\-post303\fP.
The method set with \fI\-X, \-\-request\fP overrides the method curl would otherwise select
to use.
Providing --location multiple times has no extra effect.
Disable it again with \-\-no-location.
Example:
.nf
curl -L https://example.com
.fi
See also \fI\-\-resolve\fP and \fI\-\-alt\-svc\fP.
.IP "\-\-location\-trusted"
(HTTP) Instruct curl to follow HTTP redirects like \fI\-L, \-\-location\fP, but permit curl to
send credentials and other secrets along to other hosts than the initial one.
This may or may not introduce a security breach if the site redirects you to a
site to which you send this sensitive data to. Another host means that one or
more of hostname, protocol scheme or port number changed.
This option also allows curl to pass long cookies set explicitly with \fI\-H, \-\-header\fP.
Providing --location-trusted multiple times has no extra effect.
Disable it again with \-\-no-location-trusted.
Examples:
.nf
curl --location-trusted -u user:password https://example.com
curl --location-trusted -H "Cookie: session=abc" https://example.com
.fi
See also \fI-u, \-\-user\fP.
.IP "\-\-login\-options "
(IMAP LDAP POP3 SMTP) Specify the login options to use during server authentication.
You can use login options to specify protocol specific options that may be
used during authentication. At present only IMAP, POP3 and SMTP support login
options. For more information about login options please see RFC 2384,
RFC 5092 and the IETF draft
https://datatracker.ietf.org/doc/html/draft\-earhart\-url\-smtp\-00
Since 8.2.0, IMAP supports the login option "AUTH=+LOGIN". With this option,
curl uses the plain (not SASL) "LOGIN IMAP" command even if the server
advertises SASL authentication. Care should be taken in using this option, as
it sends your password over the network in plain text. This does not work if
the IMAP server disables the plain "LOGIN" (e.g. to prevent password
snooping).
If --login-options is provided several times, the last set value is used.
Example:
.nf
curl --login-options 'AUTH=*' imap://example.com
.fi
See also \fI-u, \-\-user\fP.
.IP "\-\-mail\-auth "
(SMTP) Specify a single address. This is used to specify the authentication address
(identity) of a submitted message that is being relayed to another server.
If --mail-auth is provided several times, the last set value is used.
Example:
.nf
curl --mail-auth user@example.com -T mail smtp://example.com/
.fi
See also \fI\-\-mail\-rcpt\fP and \fI\-\-mail\-from\fP.
.IP "\-\-mail\-from "
(SMTP) Specify a single address that the given mail should get sent from.
If --mail-from is provided several times, the last set value is used.
Example:
.nf
curl --mail-from user@example.com -T mail smtp://example.com/
.fi
See also \fI\-\-mail\-rcpt\fP and \fI\-\-mail\-auth\fP.
.IP "\-\-mail\-rcpt "
(SMTP) Specify a single email address, username or mailing list name. Repeat this
option several times to send to multiple recipients.
When performing an address verification (\fBVRFY\fP command), the recipient
should be specified as the username or username and domain (as per Section 3.5
of RFC 5321).
When performing a mailing list expand (EXPN command), the recipient should be
specified using the mailing list name, such as "Friends" or "London\-Office".
--mail-rcpt can be used several times in a command line
Example:
.nf
curl --mail-rcpt user@example.net smtp://example.com
.fi
See also \fI\-\-mail\-rcpt\-allowfails\fP.
.IP "\-\-mail\-rcpt\-allowfails"
(SMTP) When sending data to multiple recipients, by default curl aborts SMTP
conversation if at least one of the recipients causes RCPT TO command to
return an error.
The default behavior can be changed by passing \fI\-\-mail\-rcpt\-allowfails\fP
command\-line option which makes curl ignore errors and proceed with the
remaining valid recipients.
If all recipients trigger RCPT TO failures and this flag is specified, curl
still aborts the SMTP conversation and returns the error received from to the
last RCPT TO command.
Providing --mail-rcpt-allowfails multiple times has no extra effect.
Disable it again with \-\-no-mail-rcpt-allowfails.
Example:
.nf
curl --mail-rcpt-allowfails --mail-rcpt dest@example.com smtp://example.com
.fi
Added in 7.69.0. See also \fI\-\-mail\-rcpt\fP.
.IP "\-M, \-\-manual"
Manual. Display the huge help text.
Example:
.nf
curl --manual
.fi
See also \fI-v, \-\-verbose\fP, \fI\-\-libcurl\fP and \fI\-\-trace\fP.
.IP "\-\-max\-filesize "
(FTP HTTP MQTT) When set to a non\-zero value, it specifies the maximum size (in bytes) of a
file to download. If the file requested is larger than this value, the
transfer does not start and curl returns with exit code 63.
Setting the maximum value to zero disables the limit.
A size modifier may be used. For example, Appending \(aqk\(aq or \(aqK\(aq counts the
number as kilobytes, \(aqm\(aq or \(aqM\(aq makes it megabytes, while \(aqg\(aq or \(aqG\(aq makes it
gigabytes. Examples: 200K, 3m and 1G.
\fBNOTE\fP: before curl 8.4.0, when the file size is not known prior to
download, for such files this option has no effect even if the file transfer
ends up being larger than this given limit.
Starting with curl 8.4.0, this option aborts the transfer if it reaches the
threshold during transfer.
If --max-filesize is provided several times, the last set value is used.
Example:
.nf
curl --max-filesize 100K https://example.com
.fi
See also \fI\-\-limit\-rate\fP.
.IP "\-\-max\-redirs "
(HTTP) Set maximum number of redirections to follow. When \fI\-L, \-\-location\fP is used, to
prevent curl from following too many redirects, by default, the limit is
set to 50 redirects. Set this option to \-1 to make it unlimited.
If --max-redirs is provided several times, the last set value is used.
Example:
.nf
curl --max-redirs 3 --location https://example.com
.fi
See also \fI-L, \-\-location\fP.
.IP "\-m, \-\-max\-time "
Set maximum time in seconds that you allow each transfer to take. Prevents
your batch jobs from hanging for hours due to slow networks or links going
down. This option accepts decimal values.
If you enable retrying the transfer (\fI\-\-retry\fP) then the maximum time counter is
reset each time the transfer is retried. You can use \fI\-\-retry\-max\-time\fP to limit
the retry time.
The decimal value needs to be provided using a dot (.) as decimal separator \-
not the local version even if it might be using another separator.
If --max-time is provided several times, the last set value is used.
Examples:
.nf
curl --max-time 10 https://example.com
curl --max-time 2.92 https://example.com
.fi
See also \fI\-\-connect\-timeout\fP and \fI\-\-retry\-max\-time\fP.
.IP "\-\-metalink"
This option was previously used to specify a Metalink resource. Metalink
support is disabled in curl for security reasons (added in 7.78.0).
If --metalink is provided several times, the last set value is used.
Example:
.nf
curl --metalink file https://example.com
.fi
See also \fI-Z, \-\-parallel\fP.
.IP "\-\-mptcp"
Enable the use of Multipath TCP (MPTCP) for connections. MPTCP is an extension
to the standard TCP that allows multiple TCP streams over different network
paths between the same source and destination. This can enhance bandwidth and
improve reliability by using multiple paths simultaneously.
MPTCP is beneficial in networks where multiple paths exist between clients and
servers, such as mobile networks where a device may switch between WiFi and
cellular data or in wired networks with multiple Internet Service Providers.
This option is currently only supported on Linux starting from kernel 5.6. Only
TCP connections are modified, hence this option does not effect HTTP/3 (QUIC)
or UDP connections.
The server curl connects to must also support MPTCP. If not, the connection
seamlessly falls back to TCP.
Providing --mptcp multiple times has no extra effect.
Disable it again with \-\-no-mptcp.
Example:
.nf
curl --mptcp https://example.com
.fi
Added in 8.9.0. See also \fI\-\-tcp\-fastopen\fP.
.IP "\-\-negotiate"
(HTTP) Enable Negotiate (SPNEGO) authentication.
This option requires a library built with GSS\-API or SSPI support. Use
\fI\-V, \-\-version\fP to see if your curl supports GSS\-API/SSPI or SPNEGO.
When using this option, you must also provide a fake \fI\-u, \-\-user\fP option to activate
the authentication code properly. Sending a \(aq\-u :\(aq is enough as the username
and password from the \fI\-u, \-\-user\fP option are not actually used.
Providing --negotiate multiple times has no extra effect.
Example:
.nf
curl --negotiate -u : https://example.com
.fi
See also \fI\-\-basic\fP, \fI\-\-ntlm\fP, \fI\-\-anyauth\fP and \fI\-\-proxy\-negotiate\fP.
.IP "\-n, \-\-netrc"
Make curl scan the \fI.netrc\fP file in the user\(aqs home directory for login name
and password. This is typically used for FTP on Unix. If used with HTTP, curl
enables user authentication. See \fInetrc(5)\fP and \fIftp(1)\fP for details on the
file format. curl does not complain if that file does not have the right
permissions (it should be neither world\- nor group\-readable). The environment
variable "HOME" is used to find the home directory.
On Windows two filenames in the home directory are checked: \fI.netrc\fP and
\fI_netrc\fP, preferring the former. Older versions on Windows checked for \fI_netrc\fP
only.
A quick and simple example of how to setup a \fI.netrc\fP to allow curl to FTP to
the machine host.example.com with username \(aqmyself\(aq and password \(aqsecret\(aq could
look similar to:
.nf
machine host.example.com
login myself
password secret
.fi
Providing --netrc multiple times has no extra effect.
Disable it again with \-\-no-netrc.
Example:
.nf
curl --netrc https://example.com
.fi
This option is mutually exclusive with \fI\-\-netrc\-file\fP and \fI\-\-netrc\-optional\fP.
See also \fI\-\-netrc\-file\fP, \fI-K, \-\-config\fP and \fI-u, \-\-user\fP.
.IP "\-\-netrc\-file "
Set the netrc file to use. Similar to \fI\-n, \-\-netrc\fP, except that you also provide
the path (absolute or relative).
It abides by \fI\-\-netrc\-optional\fP if specified.
If --netrc-file is provided several times, the last set value is used.
Example:
.nf
curl --netrc-file netrc https://example.com
.fi
This option is mutually exclusive with \fI-n, \-\-netrc\fP.
See also \fI-n, \-\-netrc\fP, \fI-u, \-\-user\fP and \fI-K, \-\-config\fP.
.IP "\-\-netrc\-optional"
Similar to \fI\-n, \-\-netrc\fP, but this option makes the .netrc usage \fBoptional\fP
and not mandatory as the \fI\-n, \-\-netrc\fP option does.
Providing --netrc-optional multiple times has no extra effect.
Disable it again with \-\-no-netrc-optional.
Example:
.nf
curl --netrc-optional https://example.com
.fi
This option is mutually exclusive with \fI-n, \-\-netrc\fP.
See also \fI\-\-netrc\-file\fP.
.IP "\-:, \-\-next"
Use a separate operation for the following URL and associated options. This
allows you to send several URL requests, each with their own specific options,
for example, such as different usernames or custom requests for each.
\fI\-:, \-\-next\fP resets all local options and only global ones have their values survive
over to the operation following the \fI\-:, \-\-next\fP instruction. Global options include
\fI\-v, \-\-verbose\fP, \fI\-\-trace\fP, \fI\-\-trace\-ascii\fP and \fI\-\-fail\-early\fP.
For example, you can do both a GET and a POST in a single command line:
.nf
curl www1.example.com \--next \-d postthis www2.example.com
.fi
--next can be used several times in a command line
Examples:
.nf
curl https://example.com --next -d postthis www2.example.com
curl -I https://example.com --next https://example.net/
.fi
See also \fI-Z, \-\-parallel\fP and \fI-K, \-\-config\fP.
.IP "\-\-no\-alpn"
(HTTPS) Disable the ALPN TLS extension. ALPN is enabled by default if libcurl was built
with an SSL library that supports ALPN. ALPN is used by a libcurl that supports
HTTP/2 to negotiate HTTP/2 support with the server during https sessions.
Note that this is the negated option name documented. You can use \fI\-\-alpn\fP to
enable ALPN.
Providing --no-alpn multiple times has no extra effect.
Disable it again with \-\-alpn.
Example:
.nf
curl --no-alpn https://example.com
.fi
\fI\-\-no\-alpn\fP requires that libcurl is built to support TLS.
See also \fI\-\-no\-npn\fP and \fI\-\-http2\fP.
.IP "\-N, \-\-no\-buffer"
Disable the buffering of the output stream. In normal work situations, curl
uses a standard buffered output stream that has the effect that it outputs the
data in chunks, not necessarily exactly when the data arrives. Using this
option disables that buffering.
Note that this is the negated option name documented. You can use \fI\-\-buffer\fP to
enable buffering again.
Providing --no-buffer multiple times has no extra effect.
Disable it again with \-\-buffer.
Example:
.nf
curl --no-buffer https://example.com
.fi
See also \fI-#, \-\-progress\-bar\fP.
.IP "\-\-no\-clobber"
When used in conjunction with the \fI\-o, \-\-output\fP, \fI\-J, \-\-remote\-header\-name\fP,
\fI\-O, \-\-remote\-name\fP, or \fI\-\-remote\-name\-all\fP options, curl avoids overwriting files
that already exist. Instead, a dot and a number gets appended to the name of
the file that would be created, up to filename.100 after which it does not
create any file.
Note that this is the negated option name documented. You can thus use
\fI\-\-clobber\fP to enforce the clobbering, even if \fI\-J, \-\-remote\-header\-name\fP is
specified.
The \fI\-C, \-\-continue\-at\fP option cannot be used together with \fI\-\-no\-clobber\fP.
Providing --no-clobber multiple times has no extra effect.
Disable it again with \-\-clobber.
Example:
.nf
curl --no-clobber --output local/dir/file https://example.com
.fi
Added in 7.83.0. See also \fI-o, \-\-output\fP and \fI-O, \-\-remote\-name\fP.
.IP "\-\-no\-keepalive"
Disable the use of keepalive messages on the TCP connection. curl otherwise
enables them by default.
Note that this is the negated option name documented. You can thus use
\fI\-\-keepalive\fP to enforce keepalive.
Providing --no-keepalive multiple times has no extra effect.
Disable it again with \-\-keepalive.
Example:
.nf
curl --no-keepalive https://example.com
.fi
See also \fI\-\-keepalive\-time\fP and \fI\-\-keepalive\-cnt\fP.
.IP "\-\-no\-npn"
(HTTPS) curl never uses NPN, this option has no effect (added in 7.86.0).
Disable the NPN TLS extension. NPN is enabled by default if libcurl was built
with an SSL library that supports NPN. NPN is used by a libcurl that supports
HTTP/2 to negotiate HTTP/2 support with the server during https sessions.
Providing --no-npn multiple times has no extra effect.
Disable it again with \-\-npn.
Example:
.nf
curl --no-npn https://example.com
.fi
\fI\-\-no\-npn\fP requires that libcurl is built to support TLS.
See also \fI\-\-no\-alpn\fP and \fI\-\-http2\fP.
.IP "\-\-no\-progress\-meter"
Option to switch off the progress meter output without muting or otherwise
affecting warning and informational messages like \fI\-s, \-\-silent\fP does.
Note that this is the negated option name documented. You can thus use
\fI\-\-progress\-meter\fP to enable the progress meter again.
Providing --no-progress-meter multiple times has no extra effect.
Disable it again with \-\-progress-meter.
Example:
.nf
curl --no-progress-meter -o store https://example.com
.fi
Added in 7.67.0. See also \fI-v, \-\-verbose\fP and \fI-s, \-\-silent\fP.
.IP "\-\-no\-sessionid"
(TLS) Disable curl\(aqs use of SSL session\-ID caching. By default all transfers are
done using the cache. Note that while nothing should ever get hurt by
attempting to reuse SSL session\-IDs, there seem to be broken SSL
implementations in the wild that may require you to disable this in order for
you to succeed.
Note that this is the negated option name documented. You can thus use
\fI\-\-sessionid\fP to enforce session\-ID caching.
Providing --no-sessionid multiple times has no extra effect.
Disable it again with \-\-sessionid.
Example:
.nf
curl --no-sessionid https://example.com
.fi
See also \fI-k, \-\-insecure\fP.
.IP "\-\-noproxy "
Comma\-separated list of hosts for which not to use a proxy, if one is
specified. The only wildcard is a single "*" character, which matches all
hosts, and effectively disables the proxy. Each name in this list is matched
as either a domain which contains the hostname, or the hostname itself. For
example, "local.com" would match "local.com", "local.com:80", and
\&"www.local.com", but not "www.notlocal.com".
This option overrides the environment variables that disable the proxy
("no_proxy" and "NO_PROXY"). If there is an environment
variable disabling a proxy, you can set the no proxy list to "" to override
it.
IP addresses specified to this option can be provided using CIDR notation
(added in 7.86.0): an appended slash and number specifies the number of
network bits out of the address to use in the comparison. For example
\&"192.168.0.0/16" would match all addresses starting with "192.168".
If --noproxy is provided several times, the last set value is used.
Example:
.nf
curl --noproxy "www.example" https://example.com
.fi
See also \fI-x, \-\-proxy\fP.
.IP "\-\-ntlm"
(HTTP) Use NTLM authentication. The NTLM authentication method was designed by
Microsoft and is used by IIS web servers. It is a proprietary protocol,
reverse\-engineered by clever people and implemented in curl based on their
efforts. This kind of behavior should not be endorsed, you should encourage
everyone who uses NTLM to switch to a public and documented authentication
method instead, such as Digest.
If you want to enable NTLM for your proxy authentication, then use
\fI\-\-proxy\-ntlm\fP.
Providing --ntlm multiple times has no extra effect.
Example:
.nf
curl --ntlm -u user:password https://example.com
.fi
\fI\-\-ntlm\fP requires that libcurl is built to support TLS.
This option is mutually exclusive with \fI\-\-basic\fP, \fI\-\-negotiate\fP, \fI\-\-digest\fP and \fI\-\-anyauth\fP.
See also \fI\-\-proxy\-ntlm\fP.
.IP "\-\-ntlm\-wb"
(HTTP) Deprecated option (added in 8.8.0).
Enabled NTLM much in the style \fI\-\-ntlm\fP does, but handed over the authentication
to a separate executable that was executed when needed.
Providing --ntlm-wb multiple times has no extra effect.
Example:
.nf
curl --ntlm-wb -u user:password https://example.com
.fi
See also \fI\-\-ntlm\fP and \fI\-\-proxy\-ntlm\fP.
.IP "\-\-oauth2\-bearer "
(IMAP LDAP POP3 SMTP HTTP) Specify the Bearer Token for OAUTH 2.0 server authentication. The Bearer Token
is used in conjunction with the username which can be specified as part of the
\fI\-\-url\fP or \fI\-u, \-\-user\fP options.
The Bearer Token and username are formatted according to RFC 6750.
If --oauth2-bearer is provided several times, the last set value is used.
Example:
.nf
curl --oauth2-bearer "mF_9.B5f-4.1JqM" https://example.com
.fi
See also \fI\-\-basic\fP, \fI\-\-ntlm\fP and \fI\-\-digest\fP.
.IP "\-o, \-\-output "
Write output to the given file instead of stdout. If you are using globbing to
fetch multiple documents, you should quote the URL and you can use "#"
followed by a number in the filename. That variable is then replaced with the
current string for the URL being fetched. Like in:
.nf
curl "http://{one,two}.example.com" \-o "file_#1.txt"
.fi
or use several variables like:
.nf
curl "http://{site,host}.host[1\-5].example" \-o "#1_#2"
.fi
You may use this option as many times as the number of URLs you have. For
example, if you specify two URLs on the same command line, you can use it like
this:
.nf
curl \-o aa example.com \-o bb example.net
.fi
and the order of the \-o options and the URLs does not matter, just that the
first \-o is for the first URL and so on, so the above command line can also be
written as
.nf
curl example.com example.net \-o aa \-o bb
.fi
See also the \fI\-\-create\-dirs\fP option to create the local directories
dynamically. Specifying the output as \(aq\-\(aq (a single dash) passes the output to
stdout.
To suppress response bodies, you can redirect output to /dev/null:
.nf
curl example.com \-o /dev/null
.fi
Or for Windows:
.nf
curl example.com \-o nul
.fi
Specify the filename as single minus to force the output to stdout, to
override curl\(aqs internal binary output in terminal prevention:
.nf
curl https://example.com/jpeg \-o \-
.fi
--output is associated with a single URL. Use it once per URL when you use several URLs in a command line.
Examples:
.nf
curl -o file https://example.com
curl "http://{one,two}.example.com" -o "file_#1.txt"
curl "http://{site,host}.host[1-5].example" -o "#1_#2"
curl -o file https://example.com -o file2 https://example.net
.fi
See also \fI-O, \-\-remote\-name\fP, \fI\-\-remote\-name\-all\fP and \fI-J, \-\-remote\-header\-name\fP.
.IP "\-\-output\-dir "
Specify the directory in which files should be stored, when \fI\-O, \-\-remote\-name\fP or
\fI\-o, \-\-output\fP are used.
The given output directory is used for all URLs and output options on the
command line, up until the first \fI\-:, \-\-next\fP.
If the specified target directory does not exist, the operation fails unless
\fI\-\-create\-dirs\fP is also used.
If --output-dir is provided several times, the last set value is used.
Example:
.nf
curl --output-dir "tmp" -O https://example.com
.fi
Added in 7.73.0. See also \fI-O, \-\-remote\-name\fP and \fI-J, \-\-remote\-header\-name\fP.
.IP "\-Z, \-\-parallel"
Make curl perform all transfers in parallel as compared to the regular serial
manner. Parallel transfer means that curl runs up to N concurrent transfers
simultaneously and if there are more than N transfers to handle, it starts new
ones when earlier transfers finish.
With parallel transfers, the progress meter output is different than when
doing serial transfers, as it then displays the transfer status for multiple
transfers in a single line.
The maximum amount of concurrent transfers is set with \fI\-\-parallel\-max\fP and it
defaults to 50.
This option is global and does not need to be specified for each use of --next.
Providing --parallel multiple times has no extra effect.
Disable it again with \-\-no-parallel.
Example:
.nf
curl --parallel https://example.com -o file1 https://example.com -o file2
.fi
Added in 7.66.0. See also \fI-:, \-\-next\fP, \fI-v, \-\-verbose\fP, \fI\-\-parallel\-max\fP and \fI\-\-parallel\-immediate\fP.
.IP "\-\-parallel\-immediate"
When doing parallel transfers, this option instructs curl to prefer opening up
more connections in parallel at once rather than waiting to see if new
transfers can be added as multiplexed streams on another connection.
By default, without this option set, curl prefers to wait a little and
multiplex new transfers over existing connections. It keeps the number of
connections low at the expense of risking a slightly slower transfer startup.
This option is global and does not need to be specified for each use of --next.
Providing --parallel-immediate multiple times has no extra effect.
Disable it again with \-\-no-parallel-immediate.
Example:
.nf
curl --parallel-immediate -Z https://example.com -o file1 https://example.com -o file2
.fi
Added in 7.68.0. See also \fI-Z, \-\-parallel\fP and \fI\-\-parallel\-max\fP.
.IP "\-\-parallel\-max "
When asked to do parallel transfers, using \fI\-Z, \-\-parallel\fP, this option controls
the maximum amount of transfers to do simultaneously.
The default is 50. 300 is the largest supported value.
This option is global and does not need to be specified for each use of --next.
If --parallel-max is provided several times, the last set value is used.
Example:
.nf
curl --parallel-max 100 -Z https://example.com ftp://example.com/
.fi
Added in 7.66.0. See also \fI-Z, \-\-parallel\fP.
.IP "\-\-pass "
(SSH TLS) Passphrase for the private key used for SSH or TLS.
If --pass is provided several times, the last set value is used.
Example:
.nf
curl --pass secret --key file https://example.com
.fi
See also \fI\-\-key\fP and \fI-u, \-\-user\fP.
.IP "\-\-path\-as\-is"
Do not handle sequences of /../ or /./ in the given URL path. Normally curl
squashes or merges them according to standards but with this option set you
tell it not to do that.
Providing --path-as-is multiple times has no extra effect.
Disable it again with \-\-no-path-as-is.
Example:
.nf
curl --path-as-is https://example.com/../../etc/passwd
.fi
See also \fI\-\-request\-target\fP.
.IP "\-\-pinnedpubkey "
(TLS) Use the specified public key file (or hashes) to verify the peer. This can be
a path to a file which contains a single public key in PEM or DER format, or
any number of base64 encoded sha256 hashes preceded by \(aqsha256//\(aq and
separated by \(aq;\(aq.
When negotiating a TLS or SSL connection, the server sends a certificate
indicating its identity. A public key is extracted from this certificate and
if it does not exactly match the public key provided to this option, curl
aborts the connection before sending or receiving any data.
This option is independent of option \fI\-k, \-\-insecure\fP. If you use both options
together then the peer is still verified by public key.
PEM/DER support:
OpenSSL and GnuTLS, wolfSSL, mbedTLS
, Secure Transport macOS 10.7+/iOS 10+,
Schannel
sha256 support:
OpenSSL, GnuTLS and wolfSSL, mbedTLS,
Secure Transport macOS 10.7+/iOS 10+, Schannel
Other SSL backends not supported.
If --pinnedpubkey is provided several times, the last set value is used.
Examples:
.nf
curl --pinnedpubkey keyfile https://example.com
curl --pinnedpubkey 'sha256//ce118b51897f4452dc' https://example.com
.fi
See also \fI\-\-hostpubsha256\fP.
.IP "\-\-post301"
(HTTP) Respect RFC 7231/6.4.2 and do not convert POST requests into GET requests when
following a 301 redirect. The non\-RFC behavior is ubiquitous in web browsers,
so curl does the conversion by default to maintain consistency. However, a
server may require a POST to remain a POST after such a redirection. This
option is meaningful only when using \fI\-L, \-\-location\fP.
Providing --post301 multiple times has no extra effect.
Disable it again with \-\-no-post301.
Example:
.nf
curl --post301 --location -d "data" https://example.com
.fi
See also \fI\-\-post302\fP, \fI\-\-post303\fP and \fI-L, \-\-location\fP.
.IP "\-\-post302"
(HTTP) Respect RFC 7231/6.4.3 and do not convert POST requests into GET requests when
following a 302 redirect. The non\-RFC behavior is ubiquitous in web browsers,
so curl does the conversion by default to maintain consistency. However, a
server may require a POST to remain a POST after such a redirection. This
option is meaningful only when using \fI\-L, \-\-location\fP.
Providing --post302 multiple times has no extra effect.
Disable it again with \-\-no-post302.
Example:
.nf
curl --post302 --location -d "data" https://example.com
.fi
See also \fI\-\-post301\fP, \fI\-\-post303\fP and \fI-L, \-\-location\fP.
.IP "\-\-post303"
(HTTP) Violate RFC 7231/6.4.4 and do not convert POST requests into GET requests when
following 303 redirect. A server may require a POST to remain a POST after a
303 redirection. This option is meaningful only when using \fI\-L, \-\-location\fP.
Providing --post303 multiple times has no extra effect.
Disable it again with \-\-no-post303.
Example:
.nf
curl --post303 --location -d "data" https://example.com
.fi
See also \fI\-\-post302\fP, \fI\-\-post301\fP and \fI-L, \-\-location\fP.
.IP "\-\-preproxy <[protocol://]host[:port]>"
Use the specified SOCKS proxy before connecting to an HTTP or HTTPS \fI\-x, \-\-proxy\fP. In
such a case curl first connects to the SOCKS proxy and then connects (through
SOCKS) to the HTTP or HTTPS proxy. Hence pre proxy.
The pre proxy string should be specified with a protocol:// prefix to specify
alternative proxy protocols. Use socks4://, socks4a://, socks5:// or
socks5h:// to request the specific SOCKS version to be used. No protocol
specified makes curl default to SOCKS4.
If the port number is not specified in the proxy string, it is assumed to be
1080.
User and password that might be provided in the proxy string are URL decoded
by curl. This allows you to pass in special characters such as @ by using %40
or pass in a colon with %3a.
If --preproxy is provided several times, the last set value is used.
Example:
.nf
curl --preproxy socks5://proxy.example -x http://http.example https://example.com
.fi
See also \fI-x, \-\-proxy\fP and \fI\-\-socks5\fP.
.IP "\-#, \-\-progress\-bar"
Make curl display transfer progress as a simple progress bar instead of the
standard, more informational, meter.
This progress bar draws a single line of \(aq#\(aq characters across the screen and
shows a percentage if the transfer size is known. For transfers without a
known size, there is a space ship (\-=o=\-) that moves back and forth but only
while data is being transferred, with a set of flying hash sign symbols on
top.
This option is global and does not need to be specified for each use of --next.
Providing --progress-bar multiple times has no extra effect.
Disable it again with \-\-no-progress-bar.
Example:
.nf
curl -# -O https://example.com
.fi
See also \fI\-\-styled\-output\fP.
.IP "\-\-proto "
Limit what protocols to allow for transfers. Protocols are evaluated left to
right, are comma separated, and are each a protocol name or \(aqall\(aq, optionally
prefixed by zero or more modifiers. Available modifiers are:
.RS
.IP +
Permit this protocol in addition to protocols already permitted (this is
the default if no modifier is used).
.IP -
Deny this protocol, removing it from the list of protocols already permitted.
.IP =
Permit only this protocol (ignoring the list already permitted), though
subject to later modification by subsequent entries in the comma separated
list.
.RE
.IP
For example: \fI\-\-proto\fP \-ftps uses the default protocols, but disables ftps
\fI\-\-proto\fP \-all,https,+http only enables http and https
\fI\-\-proto\fP =http,https also only enables http and https
Unknown and disabled protocols produce a warning. This allows scripts to
safely rely on being able to disable potentially dangerous protocols, without
relying upon support for that protocol being built into curl to avoid an error.
This option can be used multiple times, in which case the effect is the same
as concatenating the protocols into one instance of the option.
If --proto is provided several times, the last set value is used.
Example:
.nf
curl --proto =http,https,sftp https://example.com
.fi
See also \fI\-\-proto\-redir\fP and \fI\-\-proto\-default\fP.
.IP "\-\-proto\-default "
Use \fIprotocol\fP for any provided URL missing a scheme.
An unknown or unsupported protocol causes error \fICURLE_UNSUPPORTED_PROTOCOL\fP.
This option does not change the default proxy protocol (http).
Without this option set, curl guesses protocol based on the hostname, see
\fI\-\-url\fP for details.
If --proto-default is provided several times, the last set value is used.
Example:
.nf
curl --proto-default https ftp.example.com
.fi
See also \fI\-\-proto\fP and \fI\-\-proto\-redir\fP.
.IP "\-\-proto\-redir "
Limit what protocols to allow on redirects. Protocols denied by \fI\-\-proto\fP are
not overridden by this option. See \fI\-\-proto\fP for how protocols are represented.
Example, allow only HTTP and HTTPS on redirect:
.nf
curl \--proto\-redir \-all,http,https http://example.com
.fi
By default curl only allows HTTP, HTTPS, FTP and FTPS on redirects
(added in 7.65.2). Specifying \fIall\fP or \fI+all\fP enables all protocols on
redirects, which is not good for security.
If --proto-redir is provided several times, the last set value is used.
Example:
.nf
curl --proto-redir =http,https https://example.com
.fi
See also \fI\-\-proto\fP.
.IP "\-x, \-\-proxy <[protocol://]host[:port]>"
Use the specified proxy.
The proxy string can be specified with a protocol:// prefix. No protocol
specified or http:// it is treated as an HTTP proxy. Use socks4://,
socks4a://, socks5:// or socks5h:// to request a specific SOCKS version to be
used.
Unix domain sockets are supported for socks proxy. Set localhost for the host
part. e.g. socks5h://localhost/path/to/socket.sock
HTTPS proxy support works set with the https:// protocol prefix for OpenSSL
and GnuTLS. It also works for BearSSL, mbedTLS, Rustls,
Schannel, Secure Transport and wolfSSL (added in 7.87.0).
Unrecognized and unsupported proxy protocols cause an error.
Ancient curl versions ignored unknown schemes and used http:// instead.
If the port number is not specified in the proxy string, it is assumed to be
1080.
This option overrides existing environment variables that set the proxy to
use. If there is an environment variable setting a proxy, you can set proxy to
\&"" to override it.
All operations that are performed over an HTTP proxy are transparently
converted to HTTP. It means that certain protocol specific operations might
not be available. This is not the case if you can tunnel through the proxy, as
one with the \fI\-p, \-\-proxytunnel\fP option.
User and password that might be provided in the proxy string are URL decoded
by curl. This allows you to pass in special characters such as @ by using %40
or pass in a colon with %3a.
The proxy host can be specified the same way as the proxy environment
variables, including the protocol prefix (http://) and the embedded user +
password.
When a proxy is used, the active FTP mode as set with \fI\-P, \-\-ftp\-port\fP, cannot be
used.
Doing FTP over an HTTP proxy without \fI\-p, \-\-proxytunnel\fP makes curl do HTTP with an
FTP URL over the proxy. For such transfers, common FTP specific options do not
work, including \fI\-\-ssl\-reqd\fP and \fI\-\-ftp\-ssl\-control\fP.
If --proxy is provided several times, the last set value is used.
Example:
.nf
curl --proxy http://proxy.example https://example.com
.fi
See also \fI\-\-socks5\fP and \fI\-\-proxy\-basic\fP.
.IP "\-\-proxy\-anyauth"
Automatically pick a suitable authentication method when communicating with
the given HTTP proxy. This might cause an extra request/response round\-trip.
Providing --proxy-anyauth multiple times has no extra effect.
Example:
.nf
curl --proxy-anyauth --proxy-user user:passwd -x proxy https://example.com
.fi
See also \fI-x, \-\-proxy\fP, \fI\-\-proxy\-basic\fP and \fI\-\-proxy\-digest\fP.
.IP "\-\-proxy\-basic"
Use HTTP Basic authentication when communicating with the given proxy. Use
\fI\-\-basic\fP for enabling HTTP Basic with a remote host. Basic is the default
authentication method curl uses with proxies.
Providing --proxy-basic multiple times has no extra effect.
Example:
.nf
curl --proxy-basic --proxy-user user:passwd -x proxy https://example.com
.fi
See also \fI-x, \-\-proxy\fP, \fI\-\-proxy\-anyauth\fP and \fI\-\-proxy\-digest\fP.
.IP "\-\-proxy\-ca\-native"
(TLS) Use the operating system\(aqs native CA store for certificate verification of the
HTTPS proxy.
This option is independent of other HTTPS proxy CA certificate locations set at
run time or build time. Those locations are searched in addition to the native
CA store.
Equivalent to \fI\-\-ca\-native\fP but used in HTTPS proxy context. Refer to \fI\-\-ca\-native\fP
for TLS backend limitations.
Providing --proxy-ca-native multiple times has no extra effect.
Disable it again with \-\-no-proxy-ca-native.
Example:
.nf
curl --proxy-ca-native https://example.com
.fi
Added in 8.2.0. See also \fI\-\-ca\-native\fP, \fI\-\-cacert\fP, \fI\-\-capath\fP, \fI\-\-dump\-ca\-embed\fP and \fI-k, \-\-insecure\fP.
.IP "\-\-proxy\-cacert "
Use the specified certificate file to verify the HTTPS proxy. The file may
contain multiple CA certificates. The certificate(s) must be in PEM format.
This allows you to use a different trust for the proxy compared to the remote
server connected to via the proxy.
Equivalent to \fI\-\-cacert\fP but used in HTTPS proxy context.
If --proxy-cacert is provided several times, the last set value is used.
Example:
.nf
curl --proxy-cacert CA-file.txt -x https://proxy https://example.com
.fi
See also \fI\-\-proxy\-capath\fP, \fI\-\-cacert\fP, \fI\-\-capath\fP, \fI\-\-dump\-ca\-embed\fP and \fI-x, \-\-proxy\fP.
.IP "\-\-proxy\-capath "
Same as \fI\-\-capath\fP but used in HTTPS proxy context.
Use the specified certificate directory to verify the proxy. Multiple paths
can be provided by separated with colon (":") (e.g. "path1:path2:path3"). The
certificates must be in PEM format, and if curl is built against OpenSSL, the
directory must have been processed using the c_rehash utility supplied with
OpenSSL. Using \fI\-\-proxy\-capath\fP can allow OpenSSL\-powered curl to make
SSL\-connections much more efficiently than using \fI\-\-proxy\-cacert\fP if the
\fI\-\-proxy\-cacert\fP file contains many CA certificates.
If this option is set, the default capath value is ignored.
If --proxy-capath is provided several times, the last set value is used.
Example:
.nf
curl --proxy-capath /local/directory -x https://proxy https://example.com
.fi
See also \fI\-\-proxy\-cacert\fP, \fI-x, \-\-proxy\fP, \fI\-\-capath\fP and \fI\-\-dump\-ca\-embed\fP.
.IP "\-\-proxy\-cert "
Use the specified client certificate file when communicating with an HTTPS
proxy. The certificate must be in PKCS#12 format if using Secure Transport, or
PEM format if using any other engine. If the optional password is not
specified, it is queried for on the terminal. Use \fI\-\-proxy\-key\fP to provide the
private key.
This option is the equivalent to \fI\-E, \-\-cert\fP but used in HTTPS proxy context.
If --proxy-cert is provided several times, the last set value is used.
Example:
.nf
curl --proxy-cert file -x https://proxy https://example.com
.fi
See also \fI-x, \-\-proxy\fP, \fI\-\-proxy\-key\fP and \fI\-\-proxy\-cert\-type\fP.
.IP "\-\-proxy\-cert\-type "
Set type of the provided client certificate when using HTTPS proxy. PEM, DER,
ENG, PROV and P12 are recognized types.
The default type depends on the TLS backend and is usually PEM, however for
Secure Transport and Schannel it is P12. If \fI\-\-proxy\-cert\fP is a pkcs11: URI then
ENG or PROV is the default type (depending on OpenSSL version).
Equivalent to \fI\-\-cert\-type\fP but used in HTTPS proxy context.
If --proxy-cert-type is provided several times, the last set value is used.
Example:
.nf
curl --proxy-cert-type PEM --proxy-cert file -x https://proxy https://example.com
.fi
See also \fI\-\-proxy\-cert\fP and \fI\-\-proxy\-key\fP.
.IP "\-\-proxy\-ciphers "
(TLS) Same as \fI\-\-ciphers\fP but used in HTTPS proxy context.
Specify which cipher suites to use in the connection to your HTTPS proxy when
it negotiates TLS 1.2 (1.1, 1.0). The list of ciphers suites must specify
valid ciphers. Read up on cipher suite details on this URL:
https://curl.se/docs/ssl\-ciphers.html
If --proxy-ciphers is provided several times, the last set value is used.
Example:
.nf
curl --proxy-ciphers ECDHE-ECDSA-AES128-GCM-SHA256:ECDHE-RSA-AES128-GCM-SHA256 -x https://proxy https://example.com
.fi
See also \fI\-\-proxy\-tls13\-ciphers\fP, \fI\-\-ciphers\fP and \fI-x, \-\-proxy\fP.
.IP "\-\-proxy\-crlfile "
Provide filename for a PEM formatted file with a Certificate Revocation List
that specifies peer certificates that are considered revoked when
communicating with an HTTPS proxy.
Equivalent to \fI\-\-crlfile\fP but only used in HTTPS proxy context.
If --proxy-crlfile is provided several times, the last set value is used.
Example:
.nf
curl --proxy-crlfile rejects.txt -x https://proxy https://example.com
.fi
See also \fI\-\-crlfile\fP and \fI-x, \-\-proxy\fP.
.IP "\-\-proxy\-digest"
Use HTTP Digest authentication when communicating with the given proxy. Use
\fI\-\-digest\fP for enabling HTTP Digest with a remote host.
Providing --proxy-digest multiple times has no extra effect.
Example:
.nf
curl --proxy-digest --proxy-user user:passwd -x proxy https://example.com
.fi
See also \fI-x, \-\-proxy\fP, \fI\-\-proxy\-anyauth\fP and \fI\-\-proxy\-basic\fP.
.IP "\-\-proxy\-header "
(HTTP) Extra header to include in the request when sending HTTP to a proxy. You may
specify any number of extra headers. This is the equivalent option to \fI\-H, \-\-header\fP
but is for proxy communication only like in CONNECT requests when you want a
separate header sent to the proxy to what is sent to the actual remote host.
curl makes sure that each header you add/replace is sent with the proper
end\-of\-line marker, you should thus \fBnot\fP add that as a part of the header
content: do not add newlines or carriage returns, they only mess things up for
you.
Headers specified with this option are not included in requests that curl
knows are not be sent to a proxy.
This option can take an argument in @filename style, which then adds a header
for each line in the input file. Using @\- makes curl read
the headers from stdin.
This option can be used multiple times to add/replace/remove multiple headers.
--proxy-header can be used several times in a command line
Examples:
.nf
curl --proxy-header "X-First-Name: Joe" -x http://proxy https://example.com
curl --proxy-header "User-Agent: surprise" -x http://proxy https://example.com
curl --proxy-header "Host:" -x http://proxy https://example.com
.fi
See also \fI-x, \-\-proxy\fP.
.IP "\-\-proxy\-http2"
(HTTP) Negotiate HTTP/2 with an HTTPS proxy. The proxy might still only offer HTTP/1
and then curl sticks to using that version.
This has no effect for any other kinds of proxies.
Providing --proxy-http2 multiple times has no extra effect.
Disable it again with \-\-no-proxy-http2.
Example:
.nf
curl --proxy-http2 -x proxy https://example.com
.fi
\fI\-\-proxy\-http2\fP requires that libcurl is built to support HTTP/2.
Added in 8.1.0. See also \fI-x, \-\-proxy\fP.
.IP "\-\-proxy\-insecure"
Same as \fI\-k, \-\-insecure\fP but used in HTTPS proxy context.
Every secure connection curl makes is verified to be secure before the
transfer takes place. This option makes curl skip the verification step with a
proxy and proceed without checking.
When this option is not used for a proxy using HTTPS, curl verifies the
proxy\(aqs TLS certificate before it continues: that the certificate contains the
right name which matches the hostname and that the certificate has been signed
by a CA certificate present in the cert store. See this online resource for
further details: \fBhttps://curl.se/docs/sslcerts.html\fP
\fBWARNING\fP: using this option makes the transfer to the proxy insecure.
Providing --proxy-insecure multiple times has no extra effect.
Disable it again with \-\-no-proxy-insecure.
Example:
.nf
curl --proxy-insecure -x https://proxy https://example.com
.fi
See also \fI-x, \-\-proxy\fP and \fI-k, \-\-insecure\fP.
.IP "\-\-proxy\-key "
Specify the filename for your private key when using client certificates with
your HTTPS proxy. This option is the equivalent to \fI\-\-key\fP but used in HTTPS
proxy context.
If --proxy-key is provided several times, the last set value is used.
Example:
.nf
curl --proxy-key here -x https://proxy https://example.com
.fi
See also \fI\-\-proxy\-key\-type\fP and \fI-x, \-\-proxy\fP.
.IP "\-\-proxy\-key\-type "
Specify the private key file type your \fI\-\-proxy\-key\fP provided private key uses.
DER, PEM, and ENG are supported. If not specified, PEM is assumed.
Equivalent to \fI\-\-key\-type\fP but used in HTTPS proxy context.
If --proxy-key-type is provided several times, the last set value is used.
Example:
.nf
curl --proxy-key-type DER --proxy-key here -x https://proxy https://example.com
.fi
See also \fI\-\-proxy\-key\fP and \fI-x, \-\-proxy\fP.
.IP "\-\-proxy\-negotiate"
Use HTTP Negotiate (SPNEGO) authentication when communicating with the given
proxy. Use \fI\-\-negotiate\fP for enabling HTTP Negotiate (SPNEGO) with a remote
host.
Providing --proxy-negotiate multiple times has no extra effect.
Example:
.nf
curl --proxy-negotiate --proxy-user user:passwd -x proxy https://example.com
.fi
See also \fI\-\-proxy\-anyauth\fP, \fI\-\-proxy\-basic\fP and \fI\-\-proxy\-service\-name\fP.
.IP "\-\-proxy\-ntlm"
Use HTTP NTLM authentication when communicating with the given proxy. Use
\fI\-\-ntlm\fP for enabling NTLM with a remote host.
Providing --proxy-ntlm multiple times has no extra effect.
Example:
.nf
curl --proxy-ntlm --proxy-user user:passwd -x http://proxy https://example.com
.fi
See also \fI\-\-proxy\-negotiate\fP, \fI\-\-proxy\-anyauth\fP and \fI-U, \-\-proxy\-user\fP.
.IP "\-\-proxy\-pass "
Passphrase for the private key for HTTPS proxy client certificate.
Equivalent to \fI\-\-pass\fP but used in HTTPS proxy context.
If --proxy-pass is provided several times, the last set value is used.
Example:
.nf
curl --proxy-pass secret --proxy-key here -x https://proxy https://example.com
.fi
See also \fI-x, \-\-proxy\fP and \fI\-\-proxy\-key\fP.
.IP "\-\-proxy\-pinnedpubkey "
(TLS) Use the specified public key file (or hashes) to verify the proxy. This can be
a path to a file which contains a single public key in PEM or DER format, or
any number of base64 encoded sha256 hashes preceded by \(aqsha256//\(aq and
separated by \(aq;\(aq.
When negotiating a TLS or SSL connection, the server sends a certificate
indicating its identity. A public key is extracted from this certificate and
if it does not exactly match the public key provided to this option, curl
aborts the connection before sending or receiving any data.
Before curl 8.10.0 this option did not work due to a bug.
If --proxy-pinnedpubkey is provided several times, the last set value is used.
Examples:
.nf
curl --proxy-pinnedpubkey keyfile https://example.com
curl --proxy-pinnedpubkey 'sha256//ce118b51897f4452dc' https://example.com
.fi
See also \fI\-\-pinnedpubkey\fP and \fI-x, \-\-proxy\fP.
.IP "\-\-proxy\-service\-name "
Set the service name for SPNEGO when doing proxy authentication.
If --proxy-service-name is provided several times, the last set value is used.
Example:
.nf
curl --proxy-service-name "shrubbery" -x proxy https://example.com
.fi
See also \fI\-\-service\-name\fP, \fI-x, \-\-proxy\fP and \fI\-\-proxy\-negotiate\fP.
.IP "\-\-proxy\-ssl\-allow\-beast"
Do not work around a security flaw in the TLS1.0 protocol known as BEAST when
communicating to an HTTPS proxy. If this option is not used, the TLS layer may
use workarounds known to cause interoperability problems with some older
server implementations.
This option only changes how curl does TLS 1.0 with an HTTPS proxy and has no
effect on later TLS versions.
\fBWARNING\fP: this option loosens the TLS security, and by using this flag you
ask for exactly that.
Equivalent to \fI\-\-ssl\-allow\-beast\fP but used in HTTPS proxy context.
Providing --proxy-ssl-allow-beast multiple times has no extra effect.
Disable it again with \-\-no-proxy-ssl-allow-beast.
Example:
.nf
curl --proxy-ssl-allow-beast -x https://proxy https://example.com
.fi
See also \fI\-\-ssl\-allow\-beast\fP and \fI-x, \-\-proxy\fP.
.IP "\-\-proxy\-ssl\-auto\-client\-cert"
Same as \fI\-\-ssl\-auto\-client\-cert\fP but used in HTTPS proxy context.
This is only supported by Schannel.
Providing --proxy-ssl-auto-client-cert multiple times has no extra effect.
Disable it again with \-\-no-proxy-ssl-auto-client-cert.
Example:
.nf
curl --proxy-ssl-auto-client-cert -x https://proxy https://example.com
.fi
Added in 7.77.0. See also \fI\-\-ssl\-auto\-client\-cert\fP and \fI-x, \-\-proxy\fP.
.IP "\-\-proxy\-tls13\-ciphers "
(TLS) Same as \fI\-\-tls13\-ciphers\fP but used in HTTPS proxy context.
Specify which cipher suites to use in the connection to your HTTPS proxy when
it negotiates TLS 1.3. The list of ciphers suites must specify valid ciphers.
Read up on TLS 1.3 cipher suite details on this URL:
https://curl.se/docs/ssl\-ciphers.html
This option is used when curl is built to use OpenSSL 1.1.1 or later,
Schannel, wolfSSL, or mbedTLS 3.6.0 or later.
Before curl 8.10.0 with mbedTLS or wolfSSL, TLS 1.3 cipher suites were set
by using the \fI\-\-proxy\-ciphers\fP option.
If --proxy-tls13-ciphers is provided several times, the last set value is used.
Example:
.nf
curl --proxy-tls13-ciphers TLS_AES_128_GCM_SHA256 -x proxy https://example.com
.fi
Added in 7.61.0. See also \fI\-\-proxy\-ciphers\fP, \fI\-\-tls13\-ciphers\fP and \fI-x, \-\-proxy\fP.
.IP "\-\-proxy\-tlsauthtype "
Set TLS authentication type with HTTPS proxy. The only supported option is
\&"SRP", for TLS\-SRP (RFC 5054). This option works only if the underlying
libcurl is built with TLS\-SRP support.
Equivalent to \fI\-\-tlsauthtype\fP but used in HTTPS proxy context.
If --proxy-tlsauthtype is provided several times, the last set value is used.
Example:
.nf
curl --proxy-tlsauthtype SRP -x https://proxy https://example.com
.fi
See also \fI-x, \-\-proxy\fP, \fI\-\-proxy\-tlsuser\fP and \fI\-\-proxy\-tlspassword\fP.
.IP "\-\-proxy\-tlspassword "
Set password to use with the TLS authentication method specified with
\fI\-\-proxy\-tlsauthtype\fP when using HTTPS proxy. Requires that \fI\-\-proxy\-tlsuser\fP is
set.
This option does not work with TLS 1.3.
Equivalent to \fI\-\-tlspassword\fP but used in HTTPS proxy context.
If --proxy-tlspassword is provided several times, the last set value is used.
Example:
.nf
curl --proxy-tlspassword passwd -x https://proxy https://example.com
.fi
See also \fI-x, \-\-proxy\fP and \fI\-\-proxy\-tlsuser\fP.
.IP "\-\-proxy\-tlsuser "
Set username for use for HTTPS proxy with the TLS authentication method
specified with \fI\-\-proxy\-tlsauthtype\fP. Requires that \fI\-\-proxy\-tlspassword\fP also is
set.
This option does not work with TLS 1.3.
If --proxy-tlsuser is provided several times, the last set value is used.
Example:
.nf
curl --proxy-tlsuser smith -x https://proxy https://example.com
.fi
See also \fI-x, \-\-proxy\fP and \fI\-\-proxy\-tlspassword\fP.
.IP "\-\-proxy\-tlsv1"
Use at least TLS version 1.x when negotiating with an HTTPS proxy. That means
TLS version 1.0 or higher
Equivalent to \fI\-1, \-\-tlsv1\fP but for an HTTPS proxy context.
Providing --proxy-tlsv1 multiple times has no extra effect.
Example:
.nf
curl --proxy-tlsv1 -x https://proxy https://example.com
.fi
See also \fI-x, \-\-proxy\fP.
.IP "\-U, \-\-proxy\-user "
Specify the username and password to use for proxy authentication.
If you use a Windows SSPI\-enabled curl binary and do either Negotiate or NTLM
authentication then you can tell curl to select the username and password from
your environment by specifying a single colon with this option: "\-U :".
On systems where it works, curl hides the given option argument from process
listings. This is not enough to protect credentials from possibly getting seen
by other users on the same system as they still are visible for a moment
before cleared. Such sensitive data should be retrieved from a file instead or
similar and never used in clear text in a command line.
If --proxy-user is provided several times, the last set value is used.
Example:
.nf
curl --proxy-user smith:secret -x proxy https://example.com
.fi
See also \fI\-\-proxy\-pass\fP.
.IP "\-\-proxy1.0 "
Use the specified HTTP 1.0 proxy. If the port number is not specified, it is
assumed at port 1080.
The only difference between this and the HTTP proxy option \fI\-x, \-\-proxy\fP, is that
attempts to use CONNECT through the proxy specifies an HTTP 1.0 protocol
instead of the default HTTP 1.1.
Providing --proxy1.0 multiple times has no extra effect.
Example:
.nf
curl --proxy1.0 http://proxy https://example.com
.fi
See also \fI-x, \-\-proxy\fP, \fI\-\-socks5\fP and \fI\-\-preproxy\fP.
.IP "\-p, \-\-proxytunnel"
When an HTTP proxy is used \fI\-x, \-\-proxy\fP, this option makes curl tunnel the traffic
through the proxy. The tunnel approach is made with the HTTP proxy CONNECT
request and requires that the proxy allows direct connect to the remote port
number curl wants to tunnel through to.
To suppress proxy CONNECT response headers when curl is set to output headers
use \fI\-\-suppress\-connect\-headers\fP.
Providing --proxytunnel multiple times has no extra effect.
Disable it again with \-\-no-proxytunnel.
Example:
.nf
curl --proxytunnel -x http://proxy https://example.com
.fi
See also \fI-x, \-\-proxy\fP.
.IP "\-\-pubkey "
(SFTP SCP) Public key filename. Allows you to provide your public key in this separate
file.
curl attempts to automatically extract the public key from the private key
file, so passing this option is generally not required. Note that this public
key extraction requires libcurl to be linked against a copy of libssh2 1.2.8
or higher that is itself linked against OpenSSL.
If --pubkey is provided several times, the last set value is used.
Example:
.nf
curl --pubkey file.pub sftp://example.com/
.fi
See also \fI\-\-pass\fP.
.IP "\-Q, \-\-quote "
(FTP SFTP) Send an arbitrary command to the remote FTP or SFTP server. Quote commands are
sent BEFORE the transfer takes place (just after the initial \fBPWD\fP command
in an FTP transfer, to be exact). To make commands take place after a
successful transfer, prefix them with a dash \(aq\-\(aq.
(FTP only) To make commands be sent after curl has changed the working
directory, just before the file transfer command(s), prefix the command with a
\(aq+\(aq. This is not performed when a directory listing is performed.
You may specify any number of commands.
By default curl stops at first failure. To make curl continue even if the
command fails, prefix the command with an asterisk (*). Otherwise, if the
server returns failure for one of the commands, the entire operation is
aborted.
You must send syntactically correct FTP commands as RFC 959 defines to FTP
servers, or one of the commands listed below to SFTP servers.
SFTP is a binary protocol. Unlike for FTP, curl interprets SFTP quote commands
itself before sending them to the server. Filenames may be quoted shell\-style
to embed spaces or special characters. Following is the list of all supported
SFTP quote commands:
.RS
.IP "atime date file"
The atime command sets the last access time of the file named by the file
operand. The date expression can be all sorts of date strings, see the
\fIcurl_getdate(3)\fP man page for date expression details. (Added in 7.73.0)
.IP "chgrp group file"
The chgrp command sets the group ID of the file named by the file operand to
the group ID specified by the group operand. The group operand is a decimal
integer group ID.
.IP "chmod mode file"
The chmod command modifies the file mode bits of the specified file. The
mode operand is an octal integer mode number.
.IP "chown user file"
The chown command sets the owner of the file named by the file operand to the
user ID specified by the user operand. The user operand is a decimal
integer user ID.
.IP "ln source_file target_file"
The ln and symlink commands create a symbolic link at the target_file location
pointing to the source_file location.
.IP "mkdir directory_name"
The mkdir command creates the directory named by the directory_name operand.
.IP "mtime date file"
The mtime command sets the last modification time of the file named by the
file operand. The date expression can be all sorts of date strings, see the
\fIcurl_getdate(3)\fP man page for date expression details. (Added in 7.73.0)
.IP pwd
The pwd command returns the absolute path name of the current working directory.
.IP "rename source target"
The rename command renames the file or directory named by the source
operand to the destination path named by the target operand.
.IP "rm file"
The rm command removes the file specified by the file operand.
.IP "rmdir directory"
The rmdir command removes the directory entry specified by the directory
operand, provided it is empty.
.IP "symlink source_file target_file"
See ln.
.RE
.IP
--quote can be used several times in a command line
Example:
.nf
curl --quote "DELE file" ftp://example.com/foo
.fi
See also \fI-X, \-\-request\fP.
.IP "\-\-random\-file "
Deprecated option. This option is ignored (added in 7.84.0). Prior to that it
only had an effect on curl if built to use old versions of OpenSSL.
Specify the path name to file containing random data. The data may be used to
seed the random engine for SSL connections.
If --random-file is provided several times, the last set value is used.
Example:
.nf
curl --random-file rubbish https://example.com
.fi
See also \fI\-\-egd\-file\fP.
.IP "\-r, \-\-range "
(HTTP FTP SFTP FILE) Retrieve a byte range (i.e. a partial document) from an HTTP/1.1, FTP or SFTP
server or a local FILE. Ranges can be specified in a number of ways.
.RS
.IP 0-499
specifies the first 500 bytes
.IP 500-999
specifies the second 500 bytes
.IP -500
specifies the last 500 bytes
.IP 9500-
specifies the bytes from offset 9500 and forward
.IP 0-0,-1
specifies the first and last byte only(*)(HTTP)
.IP 100-199,500-599
specifies two separate 100\-byte ranges(*) (HTTP)
.RE
.IP
(*) = NOTE that if specifying multiple ranges and the server supports it then
it replies with a multiple part response that curl returns as\-is. It
contains meta information in addition to the requested bytes. Parsing or
otherwise transforming this response is the responsibility of the caller.
Only digit characters (0\-9) are valid in the \(aqstart\(aq and \(aqstop\(aq fields of the
\(aqstart\-stop\(aq range syntax. If a non\-digit character is given in the range, the
server\(aqs response is unspecified, depending on the server\(aqs configuration.
Many HTTP/1.1 servers do not have this feature enabled, so that when you
attempt to get a range, curl instead gets the whole document.
FTP and SFTP range downloads only support the simple \(aqstart\-stop\(aq syntax
(optionally with one of the numbers omitted). FTP use depends on the extended
FTP command SIZE.
This command line option is mutually exclusive with \fI\-C, \-\-continue\-at\fP: you can only
use one of them for a single transfer.
If --range is provided several times, the last set value is used.
Example:
.nf
curl --range 22-44 https://example.com
.fi
See also \fI-C, \-\-continue\-at\fP and \fI-a, \-\-append\fP.
.IP "\-\-rate "
Specify the maximum transfer frequency you allow curl to use \- in number of
transfer starts per time unit (sometimes called request rate). Without this
option, curl starts the next transfer as fast as possible.
If given several URLs and a transfer completes faster than the allowed rate,
curl waits until the next transfer is started to maintain the requested
rate. This option has no effect when \fI\-Z, \-\-parallel\fP is used.
The request rate is provided as "N/U" where N is an integer number and U is a
time unit. Supported units are \(aqs\(aq (second), \(aqm\(aq (minute), \(aqh\(aq (hour) and \(aqd\(aq
/(day, as in a 24 hour unit). The default time unit, if no "/U" is provided,
is number of transfers per hour.
If curl is told to allow 10 requests per minute, it does not start the next
request until 6 seconds have elapsed since the previous transfer was started.
This function uses millisecond resolution. If the allowed frequency is set
more than 1000 per second, it instead runs unrestricted.
When retrying transfers, enabled with \fI\-\-retry\fP, the separate retry delay logic
is used and not this setting.
Starting in version 8.10.0, you can specify number of time units in the rate
expression. Make curl do no more than 5 transfers per 15 seconds with "5/15s"
or limit it to 3 transfers per 4 hours with "3/4h". No spaces allowed.
This option is global and does not need to be specified for each use of --next.
If --rate is provided several times, the last set value is used.
Examples:
.nf
curl --rate 2/s https://example.com ...
curl --rate 3/h https://example.com ...
curl --rate 14/m https://example.com ...
.fi
Added in 7.84.0. See also \fI\-\-limit\-rate\fP and \fI\-\-retry\-delay\fP.
.IP "\-\-raw"
(HTTP) When used, it disables all internal HTTP decoding of content or transfer
encodings and instead makes them passed on unaltered, raw.
Providing --raw multiple times has no extra effect.
Disable it again with \-\-no-raw.
Example:
.nf
curl --raw https://example.com
.fi
See also \fI\-\-tr\-encoding\fP.
.IP "\-e, \-\-referer "
(HTTP) Set the referrer URL in the HTTP request. This can also be set with the
\fI\-H, \-\-header\fP flag of course. When used with \fI\-L, \-\-location\fP you can append ";auto"" to
the \fI\-e, \-\-referer\fP URL to make curl automatically set the previous URL when it
follows a Location: header. The ";auto" string can be used alone, even if you
do not set an initial \fI\-e, \-\-referer\fP.
If --referer is provided several times, the last set value is used.
Examples:
.nf
curl --referer "https://fake.example" https://example.com
curl --referer "https://fake.example;auto" -L https://example.com
curl --referer ";auto" -L https://example.com
.fi
See also \fI-A, \-\-user\-agent\fP and \fI-H, \-\-header\fP.
.IP "\-J, \-\-remote\-header\-name"
(HTTP) Tell the \fI\-O, \-\-remote\-name\fP option to use the server\-specified Content\-Disposition
filename instead of extracting a filename from the URL. If the server\-provided
filename contains a path, that is stripped off before the filename is used.
The file is saved in the current directory, or in the directory specified with
\fI\-\-output\-dir\fP.
If the server specifies a filename and a file with that name already exists in
the destination directory, it is not overwritten and an error occurs \- unless
you allow it by using the \fI\-\-clobber\fP option. If the server does not specify a
filename then this option has no effect.
There is no attempt to decode %\-sequences (yet) in the provided filename, so
this option may provide you with rather unexpected filenames.
This feature uses the name from the "filename" field, it does not yet support
the "filename*" field (filenames with explicit character sets).
\fBWARNING\fP: Exercise judicious use of this option, especially on Windows. A
rogue server could send you the name of a DLL or other file that could be
loaded automatically by Windows or some third party software.
Providing --remote-header-name multiple times has no extra effect.
Disable it again with \-\-no-remote-header-name.
Example:
.nf
curl -OJ https://example.com/file
.fi
See also \fI-O, \-\-remote\-name\fP.
.IP "\-O, \-\-remote\-name"
Write output to a local file named like the remote file we get. (Only the file
part of the remote file is used, the path is cut off.)
The file is saved in the current working directory. If you want the file saved
in a different directory, make sure you change the current working directory
before invoking curl with this option or use \fI\-\-output\-dir\fP.
The remote filename to use for saving is extracted from the given URL, nothing
else, and if it already exists it is overwritten. If you want the server to be
able to choose the filename refer to \fI\-J, \-\-remote\-header\-name\fP which can be used in
addition to this option. If the server chooses a filename and that name
already exists it is not overwritten.
There is no URL decoding done on the filename. If it has %20 or other URL
encoded parts of the name, they end up as\-is as filename.
You may use this option as many times as the number of URLs you have.
Before curl 8.10.0, curl returned an error if the URL ended with a slash,
which means that there is no filename part in the URL. Starting in 8.10.0,
curl sets the filename to the last directory part of the URL or if that also
is missing to "curl_response" (without extension) for this situation.
--remote-name is associated with a single URL. Use it once per URL when you use several URLs in a command line.
Examples:
.nf
curl -O https://example.com/filename
curl -O https://example.com/filename -O https://example.com/file2
.fi
See also \fI\-\-remote\-name\-all\fP, \fI\-\-output\-dir\fP and \fI-J, \-\-remote\-header\-name\fP.
.IP "\-\-remote\-name\-all"
Change the default action for all given URLs to be dealt with as if
\fI\-O, \-\-remote\-name\fP were used for each one. If you want to disable that for a
specific URL after \fI\-\-remote\-name\-all\fP has been used, you must use "\-o \-" or
\fI\-\-no\-remote\-name\fP.
Providing --remote-name-all multiple times has no extra effect.
Disable it again with \-\-no-remote-name-all.
Example:
.nf
curl --remote-name-all ftp://example.com/file1 ftp://example.com/file2
.fi
See also \fI-O, \-\-remote\-name\fP.
.IP "\-R, \-\-remote\-time"
Make curl attempt to figure out the timestamp of the remote file that is
getting downloaded, and if that is available make the local file get that same
timestamp.
Providing --remote-time multiple times has no extra effect.
Disable it again with \-\-no-remote-time.
Example:
.nf
curl --remote-time -o foo https://example.com
.fi
See also \fI-O, \-\-remote\-name\fP and \fI-z, \-\-time\-cond\fP.
.IP "\-\-remove\-on\-error"
Remove output file if an error occurs. If curl returns an error when told to
save output in a local file. This prevents curl from leaving a partial file in
the case of an error during transfer.
If the output is not a regular file, this option has no effect.
The \fI\-C, \-\-continue\-at\fP option cannot be used together with \fI\-\-remove\-on\-error\fP.
Providing --remove-on-error multiple times has no extra effect.
Disable it again with \-\-no-remove-on-error.
Example:
.nf
curl --remove-on-error -o output https://example.com
.fi
Added in 7.83.0. See also \fI-f, \-\-fail\fP.
.IP "\-X, \-\-request "
Change the method to use when starting the transfer.
curl passes on the verbatim string you give it in the request without any
filter or other safe guards. That includes white space and control characters.
.RS
.IP HTTP
Specifies a custom request method to use when communicating with the HTTP
server. The specified request method is used instead of the method otherwise
used (which defaults to \fIGET\fP). Read the HTTP 1.1 specification for details
and explanations. Common additional HTTP requests include \fIPUT\fP and \fIDELETE\fP,
while related technologies like WebDAV offers \fIPROPFIND\fP, \fICOPY\fP, \fIMOVE\fP and
more.
Normally you do not need this option. All sorts of \fIGET\fP, \fIHEAD\fP, \fIPOST\fP and
\fIPUT\fP requests are rather invoked by using dedicated command line options.
This option only changes the actual word used in the HTTP request, it does not
alter the way curl behaves. For example if you want to make a proper HEAD
request, using \-X HEAD does not suffice. You need to use the \fI\-I, \-\-head\fP option.
The method string you set with \fI\-X, \-\-request\fP is used for all requests, which
if you for example use \fI\-L, \-\-location\fP may cause unintended side\-effects when curl
does not change request method according to the HTTP 30x response codes \- and
similar.
.IP FTP
Specifies a custom FTP command to use instead of \fILIST\fP when doing file lists
with FTP.
.IP POP3
Specifies a custom POP3 command to use instead of \fILIST\fP or \fIRETR\fP.
.IP IMAP
Specifies a custom IMAP command to use instead of \fILIST\fP.
.IP SMTP
Specifies a custom SMTP command to use instead of \fIHELP\fP or \fBVRFY\fP.
.RE
.IP
If --request is provided several times, the last set value is used.
Examples:
.nf
curl -X "DELETE" https://example.com
curl -X NLST ftp://example.com/
.fi
See also \fI\-\-request\-target\fP.
.IP "\-\-request\-target "
(HTTP) Use an alternative target (path) instead of using the path as provided in the
URL. Particularly useful when wanting to issue HTTP requests without leading
slash or other data that does not follow the regular URL pattern, like
\&"OPTIONS *".
curl passes on the verbatim string you give it its the request without any
filter or other safe guards. That includes white space and control characters.
If --request-target is provided several times, the last set value is used.
Example:
.nf
curl --request-target "*" -X OPTIONS https://example.com
.fi
See also \fI-X, \-\-request\fP.
.IP "\-\-resolve <[+]host:port:addr[,addr]...>"
Provide a custom address for a specific host and port pair. Using this, you
can make the curl requests(s) use a specified address and prevent the
otherwise normally resolved address to be used. Consider it a sort of
/etc/hosts alternative provided on the command line. The port number should be
the number used for the specific protocol the host is used for. It means you
need several entries if you want to provide addresses for the same host but
different ports.
By specifying "*" as host you can tell curl to resolve any host and specific
port pair to the specified address. Wildcard is resolved last so any \fI\-\-resolve\fP
with a specific host and port is used first.
The provided address set by this option is used even if \fI\-4, \-\-ipv4\fP or \fI\-6, \-\-ipv6\fP is
set to make curl use another IP version.
By prefixing the host with a \(aq+\(aq you can make the entry time out after curl\(aqs
default timeout (1 minute). Note that this only makes sense for long running
parallel transfers with a lot of files. In such cases, if this option is used
curl tries to resolve the host as it normally would once the timeout has
expired.
Provide IPv6 addresses within [brackets].
To redirect connects from a specific hostname or any hostname, independently
of port number, consider the \fI\-\-connect\-to\fP option.
Support for resolving with wildcard was added in 7.64.0.
Support for the \(aq+\(aq prefix was added in 7.75.0.
Support for specifying the host component as an IPv6 address was added in 8.13.0.
--resolve can be used several times in a command line
Examples:
.nf
curl --resolve example.com:443:127.0.0.1 https://example.com
curl --resolve example.com:443:[2001:db8::252f:efd6] https://example.com
.fi
See also \fI\-\-connect\-to\fP and \fI\-\-alt\-svc\fP.
.IP "\-\-retry "
If a transient error is returned when curl tries to perform a transfer, it
retries this number of times before giving up. Setting the number to 0
makes curl do no retries (which is the default). Transient error means either:
a timeout, an FTP 4xx response code or an HTTP 408, 429, 500, 502, 503 or 504
response code.
When curl is about to retry a transfer, it first waits one second and then for
all forthcoming retries it doubles the waiting time until it reaches 10
minutes which then remains delay between the rest of the retries. By using
\fI\-\-retry\-delay\fP you disable this exponential backoff algorithm. See also
\fI\-\-retry\-max\-time\fP to limit the total time allowed for retries.
curl complies with the Retry\-After: response header if one was present to know
when to issue the next retry (added in 7.66.0).
If --retry is provided several times, the last set value is used.
Example:
.nf
curl --retry 7 https://example.com
.fi
See also \fI\-\-retry\-max\-time\fP.
.IP "\-\-retry\-all\-errors"
Retry on any error. This option is used together with \fI\-\-retry\fP.
This option is the "sledgehammer" of retrying. Do not use this option by
default (for example in your \fBcurlrc\fP), there may be unintended consequences
such as sending or receiving duplicate data. Do not use with redirected input
or output. You might be better off handling your unique problems in a shell
script. Please read the example below.
\fBWARNING\fP: For server compatibility curl attempts to retry failed flaky
transfers as close as possible to how they were started, but this is not
possible with redirected input or output. For example, before retrying it
removes output data from a failed partial transfer that was written to an
output file. However this is not true of data redirected to a | pipe or >
file, which are not reset. We strongly suggest you do not parse or record
output via redirect in combination with this option, since you may receive
duplicate data.
By default curl does not return error for transfers with an HTTP response code
that indicates an HTTP error, if the transfer was successful. For example, if
a server replies 404 Not Found and the reply is fully received then that is
not an error. When \fI\-\-retry\fP is used then curl retries on some HTTP response
codes that indicate transient HTTP errors, but that does not include most 4xx
response codes such as 404. If you want to retry on all response codes that
indicate HTTP errors (4xx and 5xx) then combine with \fI\-f, \-\-fail\fP.
Providing --retry-all-errors multiple times has no extra effect.
Disable it again with \-\-no-retry-all-errors.
Example:
.nf
curl --retry 5 --retry-all-errors https://example.com
.fi
Added in 7.71.0. See also \fI\-\-retry\fP.
.IP "\-\-retry\-connrefused"
In addition to the other conditions, consider ECONNREFUSED as a transient
error too for \fI\-\-retry\fP. This option is used together with \fI\-\-retry\fP.
Providing --retry-connrefused multiple times has no extra effect.
Disable it again with \-\-no-retry-connrefused.
Example:
.nf
curl --retry-connrefused --retry 7 https://example.com
.fi
See also \fI\-\-retry\fP and \fI\-\-retry\-all\-errors\fP.
.IP "\-\-retry\-delay "
Make curl sleep this amount of time before each retry when a transfer has
failed with a transient error (it changes the default backoff time algorithm
between retries). This option is only interesting if \fI\-\-retry\fP is also
used. Setting this delay to zero makes curl use the default backoff time.
If --retry-delay is provided several times, the last set value is used.
Example:
.nf
curl --retry-delay 5 --retry 7 https://example.com
.fi
See also \fI\-\-retry\fP.
.IP "\-\-retry\-max\-time "
The retry timer is reset before the first transfer attempt. Retries are done
as usual (see \fI\-\-retry\fP) as long as the timer has not reached this given
limit. Notice that if the timer has not reached the limit, the request is
made and while performing, it may take longer than this given time period. To
limit a single request\(aqs maximum time, use \fI\-m, \-\-max\-time\fP. Set this option to zero
to not timeout retries.
If --retry-max-time is provided several times, the last set value is used.
Example:
.nf
curl --retry-max-time 30 --retry 10 https://example.com
.fi
See also \fI\-\-retry\fP.
.IP "\-\-sasl\-authzid "
Use this authorization identity (\fBauthzid\fP), during SASL PLAIN
authentication, in addition to the authentication identity (\fBauthcid\fP) as
specified by \fI\-u, \-\-user\fP.
If the option is not specified, the server derives the \fBauthzid\fP from the
\fBauthcid\fP, but if specified, and depending on the server implementation, it
may be used to access another user\(aqs inbox, that the user has been granted
access to, or a shared mailbox for example.
If --sasl-authzid is provided several times, the last set value is used.
Example:
.nf
curl --sasl-authzid zid imap://example.com/
.fi
Added in 7.66.0. See also \fI\-\-login\-options\fP.
.IP "\-\-sasl\-ir"
Enable initial response in SASL authentication.
Providing --sasl-ir multiple times has no extra effect.
Disable it again with \-\-no-sasl-ir.
Example:
.nf
curl --sasl-ir imap://example.com/
.fi
See also \fI\-\-sasl\-authzid\fP.
.IP "\-\-service\-name "
Set the service name for SPNEGO.
If --service-name is provided several times, the last set value is used.
Example:
.nf
curl --service-name sockd/server https://example.com
.fi
See also \fI\-\-negotiate\fP and \fI\-\-proxy\-service\-name\fP.
.IP "\-S, \-\-show\-error"
When used with \fI\-s, \-\-silent\fP, it makes curl show an error message if it fails.
This option is global and does not need to be specified for each use of --next.
Providing --show-error multiple times has no extra effect.
Disable it again with \-\-no-show-error.
Example:
.nf
curl --show-error --silent https://example.com
.fi
See also \fI\-\-no\-progress\-meter\fP.
.IP "\-i, \-\-show\-headers"
(HTTP FTP) Show response headers in the output. HTTP response headers can include things
like server name, cookies, date of the document, HTTP version and more. With
non\-HTTP protocols, the "headers" are other server communication.
This option makes the response headers get saved in the same stream/output as
the data. \fI\-D, \-\-dump\-header\fP exists to save headers in a separate stream.
To view the request headers, consider the \fI\-v, \-\-verbose\fP option.
Prior to 7.75.0 curl did not print the headers if \fI\-f, \-\-fail\fP was used in
combination with this option and there was error reported by server.
This option was called \fI\-\-include\fP before 8.10.0. The previous name remains
functional.
Providing --show-headers multiple times has no extra effect.
Disable it again with \-\-no-show-headers.
Example:
.nf
curl -i https://example.com
.fi
See also \fI-v, \-\-verbose\fP and \fI-D, \-\-dump\-header\fP.
.IP "\-s, \-\-silent"
Silent or quiet mode. Do not show progress meter or error messages. Makes curl
mute. It still outputs the data you ask for, potentially even to the
terminal/stdout unless you redirect it.
Use \fI\-S, \-\-show\-error\fP in addition to this option to disable progress meter but
still show error messages.
Providing --silent multiple times has no extra effect.
Disable it again with \-\-no-silent.
Example:
.nf
curl -s https://example.com
.fi
See also \fI-v, \-\-verbose\fP, \fI\-\-stderr\fP and \fI\-\-no\-progress\-meter\fP.
.IP "\-\-skip\-existing"
If there is a local file present when a download is requested, the operation
is skipped. Note that curl cannot know if the local file was previously
downloaded fine, or if it is incomplete etc, it just knows if there is a
filename present in the file system or not and it skips the transfer if it is.
Providing --skip-existing multiple times has no extra effect.
Disable it again with \-\-no-skip-existing.
Example:
.nf
curl --skip-existing --output local/dir/file https://example.com
.fi
Added in 8.10.0. See also \fI-o, \-\-output\fP, \fI-O, \-\-remote\-name\fP and \fI\-\-no\-clobber\fP.
.IP "\-\-socks4 "
Use the specified SOCKS4 proxy. If the port number is not specified, it is
assumed at port 1080. Using this socket type make curl resolve the hostname
and passing the address on to the proxy.
To specify proxy on a Unix domain socket, use localhost for host, e.g.
\&"socks4://localhost/path/to/socket.sock"
This option overrides any previous use of \fI\-x, \-\-proxy\fP, as they are mutually
exclusive.
This option is superfluous since you can specify a socks4 proxy with \fI\-x, \-\-proxy\fP
using a socks4:// protocol prefix.
\fI\-\-preproxy\fP can be used to specify a SOCKS proxy at the same time proxy is used
with an HTTP/HTTPS proxy. In such a case, curl first
connects to the SOCKS proxy and then connects (through SOCKS) to the HTTP or
HTTPS proxy.
If --socks4 is provided several times, the last set value is used.
Example:
.nf
curl --socks4 hostname:4096 https://example.com
.fi
See also \fI\-\-socks4a\fP, \fI\-\-socks5\fP and \fI\-\-socks5\-hostname\fP.
.IP "\-\-socks4a "
Use the specified SOCKS4a proxy. If the port number is not specified, it is
assumed at port 1080. This asks the proxy to resolve the hostname.
To specify proxy on a Unix domain socket, use localhost for host, e.g.
\&"socks4a://localhost/path/to/socket.sock"
This option overrides any previous use of \fI\-x, \-\-proxy\fP, as they are mutually
exclusive.
This option is superfluous since you can specify a socks4a proxy with \fI\-x, \-\-proxy\fP
using a socks4a:// protocol prefix.
\fI\-\-preproxy\fP can be used to specify a SOCKS proxy at the same time \fI\-x, \-\-proxy\fP is
used with an HTTP/HTTPS proxy. In such a case, curl first
connects to the SOCKS proxy and then connects (through SOCKS) to the HTTP or
HTTPS proxy.
If --socks4a is provided several times, the last set value is used.
Example:
.nf
curl --socks4a hostname:4096 https://example.com
.fi
See also \fI\-\-socks4\fP, \fI\-\-socks5\fP and \fI\-\-socks5\-hostname\fP.
.IP "\-\-socks5 "
Use the specified SOCKS5 proxy \- but resolve the hostname locally. If the
port number is not specified, it is assumed at port 1080.
To specify proxy on a Unix domain socket, use localhost for host, e.g.
\&"socks5://localhost/path/to/socket.sock"
This option overrides any previous use of \fI\-x, \-\-proxy\fP, as they are mutually
exclusive.
This option is superfluous since you can specify a socks5 proxy with \fI\-x, \-\-proxy\fP
using a socks5:// protocol prefix.
\fI\-\-preproxy\fP can be used to specify a SOCKS proxy at the same time \fI\-x, \-\-proxy\fP is
used with an HTTP/HTTPS proxy. In such a case, curl first
connects to the SOCKS proxy and then connects (through SOCKS) to the HTTP or
HTTPS proxy.
This option does not work with FTPS or LDAP.
If --socks5 is provided several times, the last set value is used.
Example:
.nf
curl --socks5 proxy.example:7000 https://example.com
.fi
See also \fI\-\-socks5\-hostname\fP and \fI\-\-socks4a\fP.
.IP "\-\-socks5\-basic"
Use username/password authentication when connecting to a SOCKS5 proxy. The
username/password authentication is enabled by default. Use \fI\-\-socks5\-gssapi\fP to
force GSS\-API authentication to SOCKS5 proxies.
Providing --socks5-basic multiple times has no extra effect.
Example:
.nf
curl --socks5-basic --socks5 hostname:4096 https://example.com
.fi
See also \fI\-\-socks5\fP.
.IP "\-\-socks5\-gssapi"
Use GSS\-API authentication when connecting to a SOCKS5 proxy. The GSS\-API
authentication is enabled by default (if curl is compiled with GSS\-API
support). Use \fI\-\-socks5\-basic\fP to force username/password authentication to
SOCKS5 proxies.
Providing --socks5-gssapi multiple times has no extra effect.
Disable it again with \-\-no-socks5-gssapi.
Example:
.nf
curl --socks5-gssapi --socks5 hostname:4096 https://example.com
.fi
See also \fI\-\-socks5\fP.
.IP "\-\-socks5\-gssapi\-nec"
As part of the GSS\-API negotiation a protection mode is negotiated. RFC 1961
says in section 4.3/4.4 it should be protected, but the NEC reference
implementation does not. The option \fI\-\-socks5\-gssapi\-nec\fP allows the
unprotected exchange of the protection mode negotiation.
Providing --socks5-gssapi-nec multiple times has no extra effect.
Disable it again with \-\-no-socks5-gssapi-nec.
Example:
.nf
curl --socks5-gssapi-nec --socks5 hostname:4096 https://example.com
.fi
See also \fI\-\-socks5\fP.
.IP "\-\-socks5\-gssapi\-service "
Set the service name for a socks server. Default is \fBrcmd/server\-fqdn\fP.
If --socks5-gssapi-service is provided several times, the last set value is used.
Example:
.nf
curl --socks5-gssapi-service sockd --socks5 hostname:4096 https://example.com
.fi
See also \fI\-\-socks5\fP.
.IP "\-\-socks5\-hostname "
Use the specified SOCKS5 proxy (and let the proxy resolve the hostname). If
the port number is not specified, it is assumed at port 1080.
To specify proxy on a Unix domain socket, use localhost for host, e.g.
\&"socks5h://localhost/path/to/socket.sock"
This option overrides any previous use of \fI\-x, \-\-proxy\fP, as they are mutually
exclusive.
This option is superfluous since you can specify a socks5 hostname proxy with
\fI\-x, \-\-proxy\fP using a socks5h:// protocol prefix.
\fI\-\-preproxy\fP can be used to specify a SOCKS proxy at the same time \fI\-x, \-\-proxy\fP is
used with an HTTP/HTTPS proxy. In such a case, curl first
connects to the SOCKS proxy and then connects (through SOCKS) to the HTTP or
HTTPS proxy.
If --socks5-hostname is provided several times, the last set value is used.
Example:
.nf
curl --socks5-hostname proxy.example:7000 https://example.com
.fi
See also \fI\-\-socks5\fP and \fI\-\-socks4a\fP.
.IP "\-Y, \-\-speed\-limit "
If a transfer is slower than this set speed (in bytes per second) for a given
number of seconds, it gets aborted. The time period is set with \fI\-y, \-\-speed\-time\fP
and is 30 seconds by default.
If --speed-limit is provided several times, the last set value is used.
Example:
.nf
curl --speed-limit 300 --speed-time 10 https://example.com
.fi
See also \fI-y, \-\-speed\-time\fP, \fI\-\-limit\-rate\fP and \fI-m, \-\-max\-time\fP.
.IP "\-y, \-\-speed\-time "
If a transfer runs slower than speed\-limit bytes per second during a
speed\-time period, the transfer is aborted. If speed\-time is used, the default
speed\-limit is 1 unless set with \fI\-Y, \-\-speed\-limit\fP.
This option controls transfers (in both directions) but does not affect slow
connects etc. If this is a concern for you, try the \fI\-\-connect\-timeout\fP option.
If --speed-time is provided several times, the last set value is used.
Example:
.nf
curl --speed-limit 300 --speed-time 10 https://example.com
.fi
See also \fI-Y, \-\-speed\-limit\fP and \fI\-\-limit\-rate\fP.
.IP "\-\-ssl"
(FTP IMAP POP3 SMTP LDAP) Warning: this is considered an insecure option. Consider using \fI\-\-ssl\-reqd\fP
instead to be sure curl upgrades to a secure connection.
Try to use SSL/TLS for the connection \- often referred to as STARTTLS or STLS
because of the involved commands. Reverts to a non\-secure connection if the
server does not support SSL/TLS. See also \fI\-\-ftp\-ssl\-control\fP and \fI\-\-ssl\-reqd\fP for
different levels of encryption required.
This option is handled in LDAP (added in 7.81.0). It is fully supported by the
OpenLDAP backend and ignored by the generic ldap backend.
Please note that a server may close the connection if the negotiation does
not succeed.
This option was formerly known as \fI\-\-ftp\-ssl\fP. That option
name can still be used but might be removed in a future version.
Providing --ssl multiple times has no extra effect.
Disable it again with \-\-no-ssl.
Example:
.nf
curl --ssl pop3://example.com/
.fi
See also \fI\-\-ssl\-reqd\fP, \fI-k, \-\-insecure\fP and \fI\-\-ciphers\fP.
.IP "\-\-ssl\-allow\-beast"
(TLS) Do not work around a security flaw in the TLS1.0 protocol known as BEAST. If
this option is not used, the TLS layer may use workarounds known to cause
interoperability problems with some older server implementations.
This option only changes how curl does TLS 1.0 and has no effect on later TLS
versions.
\fBWARNING\fP: this option loosens the TLS security, and by using this flag you
ask for exactly that.
Providing --ssl-allow-beast multiple times has no extra effect.
Disable it again with \-\-no-ssl-allow-beast.
Example:
.nf
curl --ssl-allow-beast https://example.com
.fi
See also \fI\-\-proxy\-ssl\-allow\-beast\fP and \fI-k, \-\-insecure\fP.
.IP "\-\-ssl\-auto\-client\-cert"
(TLS) (Schannel) Automatically locate and use a client certificate for
authentication, when requested by the server. Since the server can request any
certificate that supports client authentication in the OS certificate store it
could be a privacy violation and unexpected.
Providing --ssl-auto-client-cert multiple times has no extra effect.
Disable it again with \-\-no-ssl-auto-client-cert.
Example:
.nf
curl --ssl-auto-client-cert https://example.com
.fi
Added in 7.77.0. See also \fI\-\-proxy\-ssl\-auto\-client\-cert\fP.
.IP "\-\-ssl\-no\-revoke"
(TLS) (Schannel) Disable certificate revocation checks. WARNING: this option loosens
the SSL security, and by using this flag you ask for exactly that.
Providing --ssl-no-revoke multiple times has no extra effect.
Disable it again with \-\-no-ssl-no-revoke.
Example:
.nf
curl --ssl-no-revoke https://example.com
.fi
See also \fI\-\-crlfile\fP.
.IP "\-\-ssl\-reqd"
(FTP IMAP POP3 SMTP LDAP) Require SSL/TLS for the connection \- often referred to as STARTTLS or STLS
because of the involved commands. Terminates the connection if the transfer
cannot be upgraded to use SSL/TLS.
This option is handled in LDAP (added in 7.81.0). It is fully supported by the
OpenLDAP backend and rejected by the generic ldap backend if explicit TLS is
required.
This option is unnecessary if you use a URL scheme that in itself implies
immediate and implicit use of TLS, like for FTPS, IMAPS, POP3S, SMTPS and
LDAPS. Such a transfer always fails if the TLS handshake does not work.
This option was formerly known as \fI\-\-ftp\-ssl\-reqd\fP.
Providing --ssl-reqd multiple times has no extra effect.
Disable it again with \-\-no-ssl-reqd.
Example:
.nf
curl --ssl-reqd ftp://example.com
.fi
See also \fI\-\-ssl\fP and \fI-k, \-\-insecure\fP.
.IP "\-\-ssl\-revoke\-best\-effort"
(TLS) (Schannel) Ignore certificate revocation checks when they failed due to
missing/offline distribution points for the revocation check lists.
Providing --ssl-revoke-best-effort multiple times has no extra effect.
Disable it again with \-\-no-ssl-revoke-best-effort.
Example:
.nf
curl --ssl-revoke-best-effort https://example.com
.fi
Added in 7.70.0. See also \fI\-\-crlfile\fP and \fI-k, \-\-insecure\fP.
.IP "\-\-ssl\-sessions "
(TLS) Use the given file to load SSL session tickets into curl\(aqs cache before
starting any transfers. At the end of a successful curl run, the cached
SSL sessions tickets are save to the file, replacing any previous content.
The file does not have to exist, but curl reports an error if it is
unable to create it. Unused loaded tickets are saved again, unless they
get replaced or purged from the cache for space reasons.
Using a session file allows "\fI\-\-tls\-earlydata\fP" to send the first request
in "0\-RTT" mode, should an SSL session with the feature be found. Note that
a server may not support early data. Also note that early data does
not provide forward secrecy, e.g. is not as secure.
The SSL session tickets are stored as base64 encoded text, each ticket on
its own line. The hostnames are cryptographically salted and hashed. While
this prevents someone to easily see the hosts you contacted, they could still
check if a specific hostname matches one of the values.
If --ssl-sessions is provided several times, the last set value is used.
Example:
.nf
curl --ssl-sessions sessions.txt https://example.com
.fi
Added in 8.12.0. See also \fI\-\-tls\-earlydata\fP.
.IP "\-2, \-\-sslv2"
(SSL) This option previously asked curl to use SSLv2, but is now ignored
(added in 7.77.0). SSLv2 is widely considered insecure (see RFC 6176).
Providing --sslv2 multiple times has no extra effect.
Example:
.nf
curl --sslv2 https://example.com
.fi
\fI-2, \-\-sslv2\fP requires that libcurl is built to support TLS.
This option is mutually exclusive with \fI-3, \-\-sslv3\fP, \fI-1, \-\-tlsv1\fP, \fI\-\-tlsv1.1\fP and \fI\-\-tlsv1.2\fP.
See also \fI\-\-http1.1\fP and \fI\-\-http2\fP.
.IP "\-3, \-\-sslv3"
(SSL) This option previously asked curl to use SSLv3, but is now ignored
(added in 7.77.0). SSLv3 is widely considered insecure (see RFC 7568).
Providing --sslv3 multiple times has no extra effect.
Example:
.nf
curl --sslv3 https://example.com
.fi
\fI-3, \-\-sslv3\fP requires that libcurl is built to support TLS.
This option is mutually exclusive with \fI-2, \-\-sslv2\fP, \fI-1, \-\-tlsv1\fP, \fI\-\-tlsv1.1\fP and \fI\-\-tlsv1.2\fP.
See also \fI\-\-http1.1\fP and \fI\-\-http2\fP.
.IP "\-\-stderr "
Redirect all writes to stderr to the specified file instead. If the filename
is a plain \(aq\-\(aq, it is instead written to stdout.
This option is global and does not need to be specified for each use of --next.
If --stderr is provided several times, the last set value is used.
Example:
.nf
curl --stderr output.txt https://example.com
.fi
See also \fI-v, \-\-verbose\fP and \fI-s, \-\-silent\fP.
.IP "\-\-styled\-output"
Enable automatic use of bold font styles when writing HTTP headers to the
terminal. Use \fI\-\-no\-styled\-output\fP to switch them off.
Styled output requires a terminal that supports bold fonts. This feature is
not present on curl for Windows due to lack of this capability.
This option is global and does not need to be specified for each use of --next.
Providing --styled-output multiple times has no extra effect.
Disable it again with \-\-no-styled-output.
Example:
.nf
curl --styled-output -I https://example.com
.fi
Added in 7.61.0. See also \fI-I, \-\-head\fP and \fI-v, \-\-verbose\fP.
.IP "\-\-suppress\-connect\-headers"
When \fI\-p, \-\-proxytunnel\fP is used and a CONNECT request is made do not output proxy
CONNECT response headers. This option is meant to be used with \fI\-D, \-\-dump\-header\fP
or \fI\-i, \-\-show\-headers\fP which are used to show protocol headers in the output. It
has no effect on debug options such as \fI\-v, \-\-verbose\fP or \fI\-\-trace\fP, or any
statistics.
Providing --suppress-connect-headers multiple times has no extra effect.
Disable it again with \-\-no-suppress-connect-headers.
Example:
.nf
curl --suppress-connect-headers --show-headers -x proxy https://example.com
.fi
See also \fI-D, \-\-dump\-header\fP, \fI-i, \-\-show\-headers\fP and \fI-p, \-\-proxytunnel\fP.
.IP "\-\-tcp\-fastopen"
Enable use of TCP Fast Open (RFC 7413). TCP Fast Open is a TCP extension that
allows data to get sent earlier over the connection (before the final
handshake ACK) if the client and server have been connected previously.
Providing --tcp-fastopen multiple times has no extra effect.
Disable it again with \-\-no-tcp-fastopen.
Example:
.nf
curl --tcp-fastopen https://example.com
.fi
See also \fI\-\-false\-start\fP.
.IP "\-\-tcp\-nodelay"
Turn on the TCP_NODELAY option. See the \fIcurl_easy_setopt(3)\fP man page for
details about this option.
curl sets this option by default and you need to explicitly switch it off if
you do not want it on.
Providing --tcp-nodelay multiple times has no extra effect.
Disable it again with \-\-no-tcp-nodelay.
Example:
.nf
curl --tcp-nodelay https://example.com
.fi
See also \fI-N, \-\-no\-buffer\fP.
.IP "\-t, \-\-telnet\-option "
Pass options to the telnet protocol. Supported options are:
.RS
.IP TTYPE=
Sets the terminal type.
.IP "XDISPLOC="
Sets the X display location.
.IP NEW_ENV=
Sets an environment variable.
.RE
.IP
--telnet-option can be used several times in a command line
Example:
.nf
curl -t TTYPE=vt100 telnet://example.com/
.fi
See also \fI-K, \-\-config\fP.
.IP "\-\-tftp\-blksize "
(TFTP) Set the TFTP \fBBLKSIZE\fP option (must be 512 or larger). This is the block
size that curl tries to use when transferring data to or from a TFTP
server. By default 512 bytes are used.
If --tftp-blksize is provided several times, the last set value is used.
Example:
.nf
curl --tftp-blksize 1024 tftp://example.com/file
.fi
See also \fI\-\-tftp\-no\-options\fP.
.IP "\-\-tftp\-no\-options"
(TFTP) Do not to send TFTP options requests. This improves interop with some legacy
servers that do not acknowledge or properly implement TFTP options. When this
option is used \fI\-\-tftp\-blksize\fP is ignored.
Providing --tftp-no-options multiple times has no extra effect.
Disable it again with \-\-no-tftp-no-options.
Example:
.nf
curl --tftp-no-options tftp://192.168.0.1/
.fi
See also \fI\-\-tftp\-blksize\fP.
.IP "\-z, \-\-time\-cond