docs/cmdline-opts/MANPAGE.md+1 -0
| @@ -28,6 +28,7 @@ Each file has a set of meta-data and a body of text. |
| Requires: (space separated list of features this requires, no dashes) |
| See-also: (space separated list of related options, no dashes) |
| Help: (short text for the --help output for this option) |
| + | Example: (example command line, without "curl" and can use `$URL`) |
| --- (end of meta-data) |
| |
| ### Body |
docs/cmdline-opts/abstract-unix-socket.d+1 -0
| @@ -4,6 +4,7 @@ Help: Connect via abstract Unix domain socket |
| Added: 7.53.0 |
| Protocols: HTTP |
| Category: connection |
| + | Example: --abstract-unix-socket socketpath $URL |
| --- |
| Connect through an abstract Unix domain socket, instead of using the network. |
| Note: netstat shows the path of an abstract socket prefixed with '@', however |
docs/cmdline-opts/alt-svc.d+1 -2
| @@ -4,9 +4,8 @@ Protocols: HTTPS |
| Help: Enable alt-svc with this cache file |
| Added: 7.64.1 |
| Category: http |
| + | Example: --alt-svc svc.txt $URL |
| --- |
| - | WARNING: this option is experimental. Do not use in production. |
| - | |
| This option enables the alt-svc parser in curl. If the file name points to an |
| existing alt-svc cache file, that will be used. After a completed transfer, |
| the cache will be saved to the file name again if it has been modified. |
docs/cmdline-opts/anyauth.d+1 -0
| @@ -3,6 +3,7 @@ Help: Pick any authentication method |
| Protocols: HTTP |
| See-also: proxy-anyauth basic digest |
| Category: http proxy auth |
| + | Example: --anyauth --user me:pwd $URL |
| --- |
| Tells curl to figure out authentication method by itself, and use the most |
| secure one the remote site claims to support. This is done by first doing a |
docs/cmdline-opts/append.d+1 -0
| @@ -3,6 +3,7 @@ Long: append |
| Help: Append to target file when uploading |
| Protocols: FTP SFTP |
| Category: ftp sftp |
| + | Example: --upload-file local --append ftp://example.com/ |
| --- |
| When used in an upload, this makes curl append to the target file instead of |
| overwriting it. If the remote file doesn't exist, it will be created. Note |
docs/cmdline-opts/aws-sigv4.d+1 -0
| @@ -3,6 +3,7 @@ Arg: <provider1[:provider2[:region[:service]]]> |
| Help: Use AWS V4 signature authentication |
| Category: auth http |
| Added: 7.75.0 |
| + | Example: --aws-sigv4 "aws:amz:east-2:es" --user "key:secret" $URL |
| --- |
| Use AWS V4 signature authentication in the transfer. |
| |
docs/cmdline-opts/basic.d+1 -0
| @@ -3,6 +3,7 @@ Help: Use HTTP Basic Authentication |
| See-also: proxy-basic |
| Protocols: HTTP |
| Category: auth |
| + | Example: -u name:password --basic $URL |
| --- |
| Tells curl to use HTTP Basic authentication with the remote host. This is the |
| default and this option is usually pointless, unless you use it to override a |
docs/cmdline-opts/cacert.d+5 -4
| @@ -3,6 +3,7 @@ Arg: <file> |
| Help: CA certificate to verify peer against |
| Protocols: TLS |
| Category: tls |
| + | Example: --cacert CA-file.txt $URL |
| --- |
| Tells curl to use the specified certificate file to verify the peer. The file |
| may contain multiple CA certificates. The certificate(s) must be in PEM |
| @@ -26,9 +27,9 @@ should not be set. If the option is not set, then curl will use the |
| certificates in the system and user Keychain to verify the peer, which is the |
| preferred method of verifying the peer's certificate chain. |
| |
| - | (Schannel only) This option is supported for Schannel in Windows 7 or later with |
| - | libcurl 7.60 or later. This option is supported for backward compatibility |
| - | with other SSL engines; instead it is recommended to use Windows' store of |
| - | root certificates (the default for Schannel). |
| + | (Schannel only) This option is supported for Schannel in Windows 7 or later |
| + | with libcurl 7.60 or later. This option is supported for backward |
| + | compatibility with other SSL engines; instead it is recommended to use |
| + | Windows' store of root certificates (the default for Schannel). |
| |
| If this option is used several times, the last one will be used. |
docs/cmdline-opts/capath.d+1 -0
| @@ -3,6 +3,7 @@ Arg: <dir> |
| Help: CA directory to verify peer against |
| Protocols: TLS |
| Category: tls |
| + | Example: --capath /local/directory $URL |
| --- |
| Tells curl to use the specified certificate directory to verify the |
| peer. Multiple paths can be provided by separating them with ":" (e.g. |
docs/cmdline-opts/cert-status.d+1 -0
| @@ -3,6 +3,7 @@ Protocols: TLS |
| Added: 7.41.0 |
| Help: Verify the status of the server cert via OCSP-staple |
| Category: tls |
| + | Example: --cert-status $URL |
| --- |
| Tells curl to verify the status of the server certificate by using the |
| Certificate Status Request (aka. OCSP stapling) TLS extension. |
docs/cmdline-opts/cert-type.d+1 -0
| @@ -4,6 +4,7 @@ Arg: <type> |
| Help: Certificate type (DER/PEM/ENG) |
| See-also: cert key key-type |
| Category: tls |
| + | Example: --cert-type PEM --cert file $URL |
| --- |
| Tells curl what type the provided client certificate is using. PEM, DER, ENG |
| and P12 are recognized types. If not specified, PEM is assumed. |
docs/cmdline-opts/cert.d+1 -0
| @@ -5,6 +5,7 @@ Help: Client certificate file and password |
| Protocols: TLS |
| See-also: cert-type key key-type |
| Category: tls |
| + | Example: --cert certfile --key keyfile $URL |
| --- |
| Tells curl to use the specified client certificate file when getting a file |
| with HTTPS, FTPS or another SSL-based protocol. The certificate must be in |
docs/cmdline-opts/ciphers.d+1 -0
| @@ -3,6 +3,7 @@ Arg: <list of ciphers> |
| Help: SSL ciphers to use |
| Protocols: TLS |
| Category: tls |
| + | Example: --ciphers ECDHE-ECDSA-AES256-CCM8 $URL |
| --- |
| Specifies which ciphers to use in the connection. The list of ciphers must |
| specify valid ciphers. Read up on SSL cipher list details on this URL: |
docs/cmdline-opts/compressed-ssh.d+1 -0
| @@ -3,6 +3,7 @@ Help: Enable SSH compression |
| Protocols: SCP SFTP |
| Added: 7.56.0 |
| Category: scp ssh |
| + | Example: --compressed-ssh sftp://example.com/ |
| --- |
| Enables built-in SSH compression. |
| This is a request, not an order; the server may or may not do it. |
docs/cmdline-opts/compressed.d+1 -0
| @@ -2,6 +2,7 @@ Long: compressed |
| Help: Request compressed response |
| Protocols: HTTP |
| Category: http |
| + | Example: --compressed $URL |
| --- |
| Request a compressed response using one of the algorithms curl supports, and |
| automatically decompress the content. Headers are not modified. |
docs/cmdline-opts/config.d+1 -0
| @@ -3,6 +3,7 @@ Arg: <file> |
| Help: Read config from a file |
| Short: K |
| Category: curl |
| + | Example: --config file.txt $URL |
| --- |
| |
| Specify a text file to read curl arguments from. The command line arguments |
docs/cmdline-opts/connect-timeout.d+3 -1
| @@ -1,8 +1,10 @@ |
| Long: connect-timeout |
| - | Arg: <seconds> |
| + | Arg: <fractional seconds> |
| Help: Maximum time allowed for connection |
| See-also: max-time |
| Category: connection |
| + | Example: --connect-timeout 20 $URL |
| + | Example: --connect-timeout 3.14 $URL |
| --- |
| Maximum time in seconds that you allow curl's connection to take. This only |
| limits the connection phase, so if curl connects within the given period it |
docs/cmdline-opts/connect-to.d+1 -0
| @@ -4,6 +4,7 @@ Help: Connect to host |
| Added: 7.49.0 |
| See-also: resolve header |
| Category: connection |
| + | Example: --connect-to example.com:443:example.net:8443 $URL |
| --- |
| |
| For a request to the given HOST1:PORT1 pair, connect to HOST2:PORT2 instead. |
docs/cmdline-opts/continue-at.d+2 -0
| @@ -4,6 +4,8 @@ Arg: <offset> |
| Help: Resumed transfer offset |
| See-also: range |
| Category: connection |
| + | Example: -C - $URL |
| + | Example: -C 400 $URL |
| --- |
| Continue/Resume a previous file transfer at the given offset. The given offset |
| is the exact number of bytes that will be skipped, counting from the beginning |
docs/cmdline-opts/cookie-jar.d+2 -0
| @@ -4,6 +4,8 @@ Arg: <filename> |
| Protocols: HTTP |
| Help: Write cookies to <filename> after operation |
| Category: http |
| + | Example: -c store-here.txt $URL |
| + | Example: -c store-here.txt -b read-these $URL |
| --- |
| Specify to which file you want curl to write all cookies after a completed |
| operation. Curl writes all cookies from its in-memory cookie storage to the |
docs/cmdline-opts/cookie.d+2 -0
| @@ -4,6 +4,8 @@ Arg: <data|filename> |
| Protocols: HTTP |
| Help: Send cookies from string/file |
| Category: http |
| + | Example: -b cookiefile $URL |
| + | Example: -b cookiefile -c cookiefile $URL |
| --- |
| Pass the data to the HTTP server in the Cookie header. It is supposedly |
| the data previously received from the server in a "Set-Cookie:" line. The |
docs/cmdline-opts/create-dirs.d+1 -0
| @@ -1,6 +1,7 @@ |
| Long: create-dirs |
| Help: Create necessary local directory hierarchy |
| Category: curl |
| + | Example: --create-dirs --output local/dir/file $URL |
| --- |
| When used in conjunction with the --output option, curl will create the |
| necessary local directory hierarchy as needed. This option creates the |
docs/cmdline-opts/create-file-mode.d+1 -0
| @@ -5,6 +5,7 @@ Protocols: SFTP SCP FILE |
| Category: sftp scp file upload |
| See-also: ftp-create-dirs |
| Added: 7.75.0 |
| + | Example: --create-file-mode 0777 -T localfile sftp://example.com/new |
| --- |
| When curl is used to create files remotely using one of the supported |
| protocols, this option allows the user to set which 'mode' to set on the file |
docs/cmdline-opts/crlf.d+1 -0
| @@ -2,6 +2,7 @@ Long: crlf |
| Help: Convert LF to CRLF in upload |
| Protocols: FTP SMTP |
| Category: ftp smtp |
| + | Example: --crlf -T file ftp://example.com/ |
| --- |
| Convert LF to CRLF in upload. Useful for MVS (OS/390). |
| |
docs/cmdline-opts/crlfile.d+2 -1
| @@ -1,9 +1,10 @@ |
| Long: crlfile |
| Arg: <file> |
| Protocols: TLS |
| - | Help: Get a CRL list in PEM format from the given file |
| + | Help: Use this CRL list |
| Added: 7.19.7 |
| Category: tls |
| + | Example: --crlfile rejects.txt $URL |
| --- |
| Provide a file using PEM format with a Certificate Revocation List that may |
| specify peer certificates that are to be considered revoked. |
docs/cmdline-opts/curves.d+1 -0
| @@ -4,6 +4,7 @@ Help: (EC) TLS key exchange algorithm(s) to request |
| Protocols: TLS |
| Added: 7.73.0 |
| Category: tls |
| + | Example: --curves X25519 $URL |
| --- |
| Tells curl to request specific curves to use during SSL session establishment |
| according to RFC 8422, 5.1. Multiple algorithms can be provided by separating |
docs/cmdline-opts/data-ascii.d+1 -0
| @@ -3,5 +3,6 @@ Arg: <data> |
| Help: HTTP POST ASCII data |
| Protocols: HTTP |
| Category: http post upload |
| + | Example: --data-ascii @file $URL |
| --- |
| This is just an alias for --data. |
docs/cmdline-opts/data-binary.d+1 -0
| @@ -3,6 +3,7 @@ Arg: <data> |
| Help: HTTP POST binary data |
| Protocols: HTTP |
| Category: http post upload |
| + | Example: --data-binary @filename $URL |
| --- |
| This posts data exactly as specified with no extra processing whatsoever. |
| |
docs/cmdline-opts/data-raw.d+2 -0
| @@ -5,6 +5,8 @@ Help: HTTP POST data, '@' allowed |
| Added: 7.43.0 |
| See-also: data |
| Category: http post upload |
| + | Example: --data-raw "hello" $URL |
| + | Example: --data-raw "@at@at@" $URL |
| --- |
| This posts data similarly to --data but without the special |
| interpretation of the @ character. |
docs/cmdline-opts/data-urlencode.d+4 -0
| @@ -5,6 +5,10 @@ Protocols: HTTP |
| See-also: data data-raw |
| Added: 7.18.0 |
| Category: http post upload |
| + | Example: --data-urlencode name=val $URL |
| + | Example: --data-urlencode =encodethis $URL |
| + | Example: --data-urlencode name@file $URL |
| + | Example: --data-urlencode @fileonly $URL |
| --- |
| This posts data, similar to the other --data options with the exception |
| that this performs URL-encoding. |
docs/cmdline-opts/data.d+3 -0
| @@ -6,6 +6,9 @@ Protocols: HTTP MQTT |
| See-also: data-binary data-urlencode data-raw |
| Mutexed: form head upload-file |
| Category: important http post upload |
| + | Example: -d "name=curl" $URL |
| + | Example: -d "name=curl" -d "tool=cmdline" $URL |
| + | Example: -d @filename $URL |
| --- |
| Sends the specified data in a POST request to the HTTP server, in the same way |
| that a browser does when a user has filled in an HTML form and presses the |
docs/cmdline-opts/delegation.d+1 -0
| @@ -3,6 +3,7 @@ Arg: <LEVEL> |
| Help: GSS-API delegation permission |
| Protocols: GSS/kerberos |
| Category: auth |
| + | Example: --delegation "none" $URL |
| --- |
| Set LEVEL to tell the server what it is allowed to delegate when it |
| comes to user credentials. |
docs/cmdline-opts/digest.d+1 -0
| @@ -4,6 +4,7 @@ Protocols: HTTP |
| Mutexed: basic ntlm negotiate |
| See-also: user proxy-digest anyauth |
| Category: proxy auth http |
| + | Example: -u name:password --digest $URL |
| --- |
| Enables HTTP Digest authentication. This is an authentication scheme that |
| prevents the password from being sent over the wire in clear text. Use this in |
docs/cmdline-opts/disable-eprt.d+1 -0
| @@ -2,6 +2,7 @@ Long: disable-eprt |
| Help: Inhibit using EPRT or LPRT |
| Protocols: FTP |
| Category: ftp |
| + | Example: --disable-eprt ftp://example.com/ |
| --- |
| Tell curl to disable the use of the EPRT and LPRT commands when doing active |
| FTP transfers. Curl will normally always first attempt to use EPRT, then LPRT |
docs/cmdline-opts/disable-epsv.d+1 -0
| @@ -2,6 +2,7 @@ Long: disable-epsv |
| Help: Inhibit using EPSV |
| Protocols: FTP |
| Category: ftp |
| + | Example: --disable-epsv ftp://example.com/ |
| --- |
| Tell curl to disable the use of the EPSV command when doing passive FTP |
| transfers. Curl will normally always first attempt to use EPSV before |
docs/cmdline-opts/disable.d+1 -0
| @@ -2,6 +2,7 @@ Long: disable |
| Short: q |
| Help: Disable .curlrc |
| Category: curl |
| + | Example: -q $URL |
| --- |
| If used as the first parameter on the command line, the *curlrc* config |
| file will not be read and used. See the --config for details on the default |
docs/cmdline-opts/disallow-username-in-url.d+3 -1
| @@ -4,5 +4,7 @@ Protocols: HTTP |
| Added: 7.61.0 |
| See-also: proto |
| Category: curl http |
| + | Example: --disallow-username-in-url $URL |
| --- |
| - | This tells curl to exit if passed a url containing a username. |
| + | This tells curl to exit if passed a url containing a username. This is probably |
| + | most useful when the URL is being provided at run-time or similar. |
docs/cmdline-opts/dns-interface.d+1 -0
| @@ -6,6 +6,7 @@ See-also: dns-ipv4-addr dns-ipv6-addr |
| Added: 7.33.0 |
| Requires: c-ares |
| Category: dns |
| + | Example: --dns-interface eth0 $URL |
| --- |
| Tell curl to send outgoing DNS requests through <interface>. This option is a |
| counterpart to --interface (which does not affect DNS). The supplied string |
docs/cmdline-opts/dns-ipv4-addr.d+1 -0
| @@ -6,6 +6,7 @@ See-also: dns-interface dns-ipv6-addr |
| Added: 7.33.0 |
| Requires: c-ares |
| Category: dns |
| + | Example: --dns-ipv4-addr 10.1.2.3 $URL |
| --- |
| Tell curl to bind to <ip-address> when making IPv4 DNS requests, so that |
| the DNS requests originate from this address. The argument should be a |
docs/cmdline-opts/dns-ipv6-addr.d+1 -0
| @@ -6,6 +6,7 @@ See-also: dns-interface dns-ipv4-addr |
| Added: 7.33.0 |
| Requires: c-ares |
| Category: dns |
| + | Example: --dns-ipv6-addr 2a04:4e42::561 $URL |
| --- |
| Tell curl to bind to <ip-address> when making IPv6 DNS requests, so that |
| the DNS requests originate from this address. The argument should be a |
docs/cmdline-opts/dns-servers.d+1 -0
| @@ -4,6 +4,7 @@ Help: DNS server addrs to use |
| Requires: c-ares |
| Added: 7.33.0 |
| Category: dns |
| + | Example: --dns-servers 192.168.0.1,192.168.0.2 $URL |
| --- |
| Set the list of DNS servers to be used instead of the system default. |
| The list of IP addresses should be separated with commas. Port numbers |
docs/cmdline-opts/doh-cert-status.d+1 -0
| @@ -3,5 +3,6 @@ Help: Verify the status of the DoH server cert via OCSP-staple |
| Protocols: all |
| Added: 7.76.0 |
| Category: dns tls |
| + | Example: --doh-cert-status --doh-url https://doh.example $URL |
| --- |
| Same as --cert-status but used for DoH (DNS-over-HTTPS). |
docs/cmdline-opts/doh-insecure.d+1 -0
| @@ -3,5 +3,6 @@ Help: Allow insecure DoH server connections |
| Protocols: all |
| Added: 7.76.0 |
| Category: dns tls |
| + | Example: --doh-insecure --doh-url https://doh.example $URL |
| --- |
| Same as --insecure but used for DoH (DNS-over-HTTPS). |
docs/cmdline-opts/doh-url.d+1 -0
| @@ -4,6 +4,7 @@ Help: Resolve host names over DoH |
| Protocols: all |
| Added: 7.62.0 |
| Category: dns |
| + | Example: --doh-url https://doh.example $URL |
| --- |
| Specifies which DNS-over-HTTPS (DoH) server to use to resolve hostnames, |
| instead of using the default name resolver mechanism. The URL must be HTTPS. |
docs/cmdline-opts/dump-header.d+1 -0
| @@ -5,6 +5,7 @@ Help: Write the received headers to <filename> |
| Protocols: HTTP FTP |
| See-also: output |
| Category: http ftp |
| + | Example: --dump-header store.txt $URL |
| --- |
| Write the received protocol headers to the specified file. If no headers are |
| received, the use of this option will create an empty file. |
docs/cmdline-opts/egd-file.d+1 -0
| @@ -4,6 +4,7 @@ Help: EGD socket path for random data |
| Protocols: TLS |
| See-also: random-file |
| Category: tls |
| + | Example: --egd-file /random/here $URL |
| --- |
| Specify the path name to the Entropy Gathering Daemon socket. The socket is |
| used to seed the random engine for SSL connections. |
docs/cmdline-opts/engine.d+1 -0
| @@ -3,6 +3,7 @@ Arg: <name> |
| Help: Crypto engine to use |
| Protocols: TLS |
| Category: tls |
| + | Example: --engine flavor $URL |
| --- |
| Select the OpenSSL crypto engine to use for cipher operations. Use --engine |
| list to print a list of build-time supported engines. Note that not all (and |
docs/cmdline-opts/etag-compare.d+1 -0
| @@ -4,6 +4,7 @@ Help: Pass an ETag from a file as a custom header |
| Protocols: HTTP |
| Added: 7.68.0 |
| Category: http |
| + | Example: --etag-compare etag.txt $URL |
| --- |
| This option makes a conditional HTTP request for the specific ETag read |
| from the given file by sending a custom If-None-Match header using the |
docs/cmdline-opts/etag-save.d+1 -0
| @@ -4,6 +4,7 @@ Help: Parse ETag from a request and save it to a file |
| Protocols: HTTP |
| Added: 7.68.0 |
| Category: http |
| + | Example: --etag-save storetag.txt $URL |
| --- |
| This option saves an HTTP ETag to the specified file. An ETag is a |
| caching related header, usually returned in a response. |
docs/cmdline-opts/expect100-timeout.d+1 -0
| @@ -5,6 +5,7 @@ Protocols: HTTP |
| Added: 7.47.0 |
| See-also: connect-timeout |
| Category: http |
| + | Example: --expect100-timeout 2.5 -T file $URL |
| --- |
| Maximum time in seconds that you allow curl to wait for a 100-continue |
| response when curl emits an Expects: 100-continue header in its request. By |
docs/cmdline-opts/fail-early.d+1 -0
| @@ -2,6 +2,7 @@ Long: fail-early |
| Help: Fail on first transfer error, do not continue |
| Added: 7.52.0 |
| Category: curl |
| + | Example: --fail-early $URL https://two.example |
| --- |
| Fail and exit on the first detected transfer error. |
| |
docs/cmdline-opts/fail-with-body.d+1 -0
| @@ -4,6 +4,7 @@ Help: Fail on HTTP errors but save the body |
| Category: http output |
| Added: 7.76.0 |
| See-also: fail |
| + | Example: --fail-with-body $URL |
| --- |
| Return an error on server errors where the HTTP response code is 400 or |
| greater). In normal cases when an HTTP server fails to deliver a document, it |
docs/cmdline-opts/fail.d+1 -0
| @@ -4,6 +4,7 @@ Protocols: HTTP |
| Help: Fail silently (no output at all) on HTTP errors |
| See-also: fail-with-body |
| Category: important http |
| + | Example: --fail $URL |
| --- |
| Fail silently (no output at all) on server errors. This is mostly done to |
| enable scripts etc to better deal with failed attempts. In normal cases |
docs/cmdline-opts/false-start.d+1 -0
| @@ -3,6 +3,7 @@ Help: Enable TLS False Start |
| Protocols: TLS |
| Added: 7.42.0 |
| Category: tls |
| + | Example: --false-start $URL |
| --- |
| Tells curl to use false start during the TLS handshake. False start is a mode |
| where a TLS client will start sending application data before verifying the |
docs/cmdline-opts/form-string.d+1 -0
| @@ -4,6 +4,7 @@ Protocols: HTTP SMTP IMAP |
| Arg: <name=string> |
| See-also: form |
| Category: http upload |
| + | Example: --form-string "data" $URL |
| --- |
| Similar to --form except that the value string for the named parameter is used |
| literally. Leading \&'@' and \&'<' characters, and the \&';type=' string in |
docs/cmdline-opts/form.d+1 -0
| @@ -5,6 +5,7 @@ Help: Specify multipart MIME data |
| Protocols: HTTP SMTP IMAP |
| Mutexed: data head upload-file |
| Category: http upload |
| + | Example: --form "name=curl" --form "file=@loadthis" $URL |
| --- |
| For HTTP protocol family, this lets curl emulate a filled-in form in which a |
| user has pressed the submit button. This causes curl to POST data using the |
docs/cmdline-opts/ftp-account.d+1 -0
| @@ -4,6 +4,7 @@ Help: Account data string |
| Protocols: FTP |
| Added: 7.13.0 |
| Category: ftp auth |
| + | Example: --ftp-account "mr.robot" ftp://example.com/ |
| --- |
| When an FTP server asks for "account data" after user name and password has |
| been provided, this data is sent off using the ACCT command. |
docs/cmdline-opts/ftp-alternative-to-user.d+1 -0
| @@ -4,6 +4,7 @@ Help: String to replace USER [name] |
| Protocols: FTP |
| Added: 7.15.5 |
| Category: ftp |
| + | Example: --ftp-alternative-to-user "U53r" ftp://example.com |
| --- |
| If authenticating with the USER and PASS commands fails, send this command. |
| When connecting to Tumbleweed's Secure Transport server over FTPS using a |
docs/cmdline-opts/ftp-create-dirs.d+1 -0
| @@ -3,6 +3,7 @@ Protocols: FTP SFTP |
| Help: Create the remote dirs if not present |
| See-also: create-dirs |
| Category: ftp sftp curl |
| + | Example: --ftp-create-dirs -T file ftp://example.com/remote/path/file |
| --- |
| When an FTP or SFTP URL/operation uses a path that doesn't currently exist on |
| the server, the standard behavior of curl is to fail. Using this option, curl |
docs/cmdline-opts/ftp-method.d+3 -0
| @@ -4,6 +4,9 @@ Help: Control CWD usage |
| Protocols: FTP |
| Added: 7.15.1 |
| Category: ftp |
| + | Example: --ftp-method multicwd ftp://example.com/dir1/dir2/file |
| + | Example: --ftp-method nocwd ftp://example.com/dir1/dir2/file |
| + | Example: --ftp-method singlecwd ftp://example.com/dir1/dir2/file |
| --- |
| 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: |
docs/cmdline-opts/ftp-pasv.d+1 -0
| @@ -4,6 +4,7 @@ Protocols: FTP |
| Added: 7.11.0 |
| See-also: disable-epsv |
| Category: ftp |
| + | Example: --ftp-pasv ftp://example.com/ |
| --- |
| Use passive mode for the data connection. Passive is the internal default |
| behavior, but using this option can be used to override a previous --ftp-port |
docs/cmdline-opts/ftp-port.d+3 -0
| @@ -5,6 +5,9 @@ Short: P |
| Protocols: FTP |
| See-also: ftp-pasv disable-eprt |
| Category: ftp |
| + | Example: -P - ftp:/example.com |
| + | Example: -P eth0 ftp:/example.com |
| + | Example: -P 192.168.0.2 ftp:/example.com |
| --- |
| Reverses the default initiator/listener roles when connecting with FTP. This |
| option makes curl use active mode. curl then tells the server to connect back |
docs/cmdline-opts/ftp-pret.d+1 -0
| @@ -3,6 +3,7 @@ Help: Send PRET before PASV |
| Protocols: FTP |
| Added: 7.20.0 |
| Category: ftp |
| + | Example: --ftp-pret ftp://example.com/ |
| --- |
| Tell curl to send a PRET command before PASV (and EPSV). Certain FTP servers, |
| mainly drftpd, require this non-standard command for directory listings as |
docs/cmdline-opts/ftp-skip-pasv-ip.d+1 -0
| @@ -4,6 +4,7 @@ Protocols: FTP |
| Added: 7.14.2 |
| See-also: ftp-pasv |
| Category: ftp |
| + | Example: --ftp-skip-pasv-ip ftp://example.com/ |
| --- |
| Tell curl to not use the IP address the server suggests in its response |
| to curl's PASV command when curl connects the data connection. Instead curl |
docs/cmdline-opts/ftp-ssl-ccc-mode.d+1 -0
| @@ -5,6 +5,7 @@ Protocols: FTP |
| Added: 7.16.2 |
| See-also: ftp-ssl-ccc |
| Category: ftp tls |
| + | Example: --ftp-ssl-ccc-mode active --ftp-ssl-ccc ftps://example.com/ |
| --- |
| Sets the CCC mode. The passive mode will not initiate the shutdown, but |
| instead wait for the server to do it, and will not reply to the shutdown from |
docs/cmdline-opts/ftp-ssl-ccc.d+1 -0
| @@ -4,6 +4,7 @@ Protocols: FTP |
| See-also: ssl ftp-ssl-ccc-mode |
| Added: 7.16.1 |
| Category: ftp tls |
| + | Example: --ftp-ssl-ccc ftps://example.com/ |
| --- |
| Use CCC (Clear Command Channel) Shuts down the SSL/TLS layer after |
| authenticating. The rest of the control channel communication will be |
docs/cmdline-opts/ftp-ssl-control.d+1 -0
| @@ -3,6 +3,7 @@ Help: Require SSL/TLS for FTP login, clear for transfer |
| Protocols: FTP |
| Added: 7.16.0 |
| Category: ftp tls |
| + | Example: --ftp-ssl-control ftp://example.com |
| --- |
| Require SSL/TLS for the FTP login, clear for transfer. Allows secure |
| authentication, but non-encrypted data transfers for efficiency. Fails the |
docs/cmdline-opts/gen.pl+20 -0
| @@ -138,8 +138,11 @@ sub single { |
| my $requires; |
| my $category; |
| my $seealso; |
| + | my @examples; # there can be more than one |
| my $magic; # cmdline special option |
| + | my $line; |
| while(<F>) { |
| + | $line++; |
| if(/^Short: *(.)/i) { |
| $short=$1; |
| } |
| @@ -173,6 +176,9 @@ sub single { |
| elsif(/^Category: *(.*)/i) { |
| $category=$1; |
| } |
| + | elsif(/^Example: *(.*)/i) { |
| + | push @examples, $1; |
| + | } |
| elsif(/^Help: *(.*)/i) { |
| ; |
| } |
| @@ -185,6 +191,10 @@ sub single { |
| print STDERR "ERROR: no 'Category:' in $f\n"; |
| exit 2; |
| } |
| + | if(!$examples[0]) { |
| + | print STDERR "$f:$line:1:ERROR: no 'Example:' present\n"; |
| + | exit 2; |
| + | } |
| last; |
| } |
| else { |
| @@ -276,6 +286,16 @@ sub single { |
| } |
| push @foot, overrides($standalone, "This option overrides $mstr. "); |
| } |
| + | if($examples[0]) { |
| + | my $s =""; |
| + | $s="s" if($examples[1]); |
| + | print "\nExample$s:\n.nf\n"; |
| + | foreach my $e (@examples) { |
| + | $e =~ s!\$URL!https://example.com!g; |
| + | print " curl $e\n"; |
| + | } |
| + | print ".fi\n"; |
| + | } |
| if($added) { |
| push @foot, added($standalone, $added); |
| } |
docs/cmdline-opts/get.d+1 -0
| @@ -2,6 +2,7 @@ Long: get |
| Short: G |
| Help: Put the post data in the URL and use GET |
| Category: http upload |
| + | Example: --get $URL |
| --- |
| When used, this option will make all data specified with --data, --data-binary |
| or --data-urlencode to be used in an HTTP GET request instead of the POST |
docs/cmdline-opts/globoff.d+1 -0
| @@ -2,6 +2,7 @@ Long: globoff |
| Short: g |
| Help: Disable URL sequences and ranges using {} and [] |
| Category: curl |
| + | Example: -g "https://example.com/{[]}}}}" |
| --- |
| This option switches off the "URL globbing parser". When you set this option, |
| you can specify URLs that contain the letters {}[] without having curl itself |
docs/cmdline-opts/happy-eyeballs-timeout-ms.d+1 -0
| @@ -3,6 +3,7 @@ Arg: <milliseconds> |
| Help: Time for IPv6 before trying IPv4 |
| Added: 7.59.0 |
| Category: connection |
| + | Example: --happy-eyeballs-timeout-ms 500 $URL |
| --- |
| 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 |
docs/cmdline-opts/haproxy-protocol.d+4 -3
| @@ -3,10 +3,11 @@ Help: Send HAProxy PROXY protocol v1 header |
| Protocols: HTTP |
| Added: 7.60.0 |
| Category: http proxy |
| + | Example: --haproxy-protocol $URL |
| --- |
| - | 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's |
| - | true IP address and port. |
| + | 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's true IP address and port. |
| |
| This option is primarily useful when sending test requests to a service that |
| expects this header. |
docs/cmdline-opts/head.d+1 -0
| @@ -3,6 +3,7 @@ Short: I |
| Help: Show document info only |
| Protocols: HTTP FTP FILE |
| Category: http ftp file |
| + | Example: -I $URL |
| --- |
| 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 file, |
docs/cmdline-opts/header.d+3 -4
| @@ -5,6 +5,9 @@ Help: Pass custom header(s) to server |
| Protocols: HTTP |
| Category: http |
| See-also: user-agent referer |
| + | Example: -H "X-First-Name: Joe" $URL |
| + | Example: -H "User-Agent: yes-please/2000" $URL |
| + | Example: -H "Host:" $URL |
| --- |
| Extra header to include in the request when sending HTTP to a server. You may |
| specify any number of extra headers. Note that if you should add a custom |
| @@ -32,10 +35,6 @@ proxy. Added in 7.37.0. |
| Passing on a "Transfer-Encoding: chunked" header when doing a HTTP request |
| with a request body, will make curl send the data using chunked encoding. |
| |
| - | Example: |
| - | |
| - | curl -H "X-First-Name: Joe" http://example.com/ |
| - | |
| **WARNING**: headers set with this option will be set in all requests - even |
| after redirects are followed, like when told with --location. This can lead to |
| the header being sent to other hosts than the original host, so sensitive |
docs/cmdline-opts/help.d+1 -0
| @@ -3,6 +3,7 @@ Arg: <category> |
| Short: h |
| Help: Get help for commands |
| Category: important curl |
| + | Example: --help all |
| --- |
| Usage help. This lists all commands of the <category>. |
| If no arg was provided, curl will display the most important |
docs/cmdline-opts/hostpubmd5.d+1 -0
| @@ -4,6 +4,7 @@ Help: Acceptable MD5 hash of the host public key |
| Protocols: SFTP SCP |
| Added: 7.17.1 |
| Category: sftp scp |
| + | Example: --hostpubmd5 e5c1c49020640a5ab0f2034854c321a8 sftp://example.com/ |
| --- |
| Pass a string containing 32 hexadecimal digits. The string should |
| be the 128 bit MD5 checksum of the remote host's public key, curl will refuse |
docs/cmdline-opts/hsts.d+1 -2
| @@ -4,9 +4,8 @@ Protocols: HTTPS |
| Help: Enable HSTS with this cache file |
| Added: 7.74.0 |
| Category: http |
| + | Example: --hsts cache.txt $URL |
| --- |
| - | WARNING: this option is experimental. Do not use in production. |
| - | |
| This option enables HSTS for the transfer. If the file name points to an |
| existing HSTS cache file, that will be used. After a completed transfer, the |
| cache will be saved to the file name again if it has been modified. |
docs/cmdline-opts/http0.9.d+1 -0
| @@ -4,6 +4,7 @@ Protocols: HTTP |
| Added: |
| Help: Allow HTTP 0.9 responses |
| Category: http |
| + | Example: --http0.9 $URL |
| --- |
| Tells curl to be fine with HTTP version 0.9 response. |
| |
docs/cmdline-opts/http1.0.d+1 -0
| @@ -6,6 +6,7 @@ Added: |
| Mutexed: http1.1 http2 |
| Help: Use HTTP 1.0 |
| Category: http |
| + | Example: --http1.0 $URL |
| --- |
| Tells curl to use HTTP version 1.0 instead of using its internally preferred |
| HTTP version. |
docs/cmdline-opts/http1.1.d+1 -0
| @@ -5,5 +5,6 @@ Added: 7.33.0 |
| Mutexed: http1.0 http2 |
| Help: Use HTTP 1.1 |
| Category: http |
| + | Example: --http1.1 $URL |
| --- |
| Tells curl to use HTTP version 1.1. |
docs/cmdline-opts/http2-prior-knowledge.d+1 -0
| @@ -6,6 +6,7 @@ Mutexed: http1.1 http1.0 http2 |
| Requires: HTTP/2 |
| Help: Use HTTP 2 without HTTP/1.1 Upgrade |
| Category: http |
| + | Example: --http2-prior-knowledge $URL |
| --- |
| Tells curl to issue its non-TLS HTTP requests using HTTP/2 without HTTP/1.1 |
| Upgrade. It requires prior knowledge that the server supports HTTP/2 straight |
docs/cmdline-opts/http2.d+7 -0
| @@ -8,5 +8,12 @@ See-also: no-alpn |
| Help: Use HTTP 2 |
| See-also: http1.1 http3 |
| Category: http |
| + | Example: --http2 $URL |
| --- |
| Tells curl to use HTTP version 2. |
| + | |
| + | For HTTPS, this means curl will attempt to negotiate HTTP/2 in the TLS |
| + | handshake. curl does this by default. |
| + | |
| + | For HTTP, this means curl will attempt to upgrade the request to HTTP/2 using |
| + | the Upgrade: request header. |
docs/cmdline-opts/http3.d+2 -1
| @@ -7,8 +7,9 @@ Requires: HTTP/3 |
| Help: Use HTTP v3 |
| See-also: http1.1 http2 |
| Category: http |
| + | Example: --http3 $URL |
| --- |
| - | WARNING: this option is experimental. Do not use in production. |
| + | **WARNING**: this option is experimental. Do not use in production. |
| |
| Tells curl to use HTTP version 3 directly to the host and port number used in |
| the URL. A normal HTTP/3 transaction will be done to a host and then get |
docs/cmdline-opts/ignore-content-length.d+1 -0
| @@ -2,6 +2,7 @@ Long: ignore-content-length |
| Help: Ignore the size of the remote resource |
| Protocols: FTP HTTP |
| Category: http ftp |
| + | Example: --ignore-content-length $URL |
| --- |
| For HTTP, Ignore the Content-Length header. This is particularly useful for |
| servers running Apache 1.x, which will report incorrect Content-Length for |
docs/cmdline-opts/include.d+1 -0
| @@ -3,6 +3,7 @@ Short: i |
| Help: Include protocol response headers in the output |
| See-also: verbose |
| Category: important verbose |
| + | Example: -i $URL |
| --- |
| Include the HTTP response headers in the output. The HTTP response headers can |
| include things like server name, cookies, date of the document, HTTP version |
docs/cmdline-opts/insecure.d+3 -0
| @@ -4,6 +4,7 @@ Help: Allow insecure server connections when using SSL |
| Protocols: TLS |
| See-also: proxy-insecure cacert |
| Category: tls |
| + | Example: --insecure $URL |
| --- |
| By default, every SSL connection curl makes is verified to be secure. This |
| option allows curl to proceed and operate even for server connections |
| @@ -14,3 +15,5 @@ contains the right name and verifies successfully using the cert store. |
| |
| See this online resource for further details: |
| https://curl.se/docs/sslcerts.html |
| + | |
| + | **WARNING**: this makes the transfer insecure. |
docs/cmdline-opts/interface.d+1 -0
| @@ -3,6 +3,7 @@ Arg: <name> |
| Help: Use network INTERFACE (or address) |
| See-also: dns-interface |
| Category: connection |
| + | Example: --interface eth0 $URL |
| --- |
| |
| Perform an operation using a specified interface. You can enter interface |
docs/cmdline-opts/ipv4.d+1 -0
| @@ -8,6 +8,7 @@ Requires: |
| See-also: http1.1 http2 |
| Help: Resolve names to IPv4 addresses |
| Category: connection dns |
| + | Example: --ipv4 $URL |
| --- |
| This option tells curl to resolve names to IPv4 addresses only, and not for |
| example try IPv6. |
docs/cmdline-opts/ipv6.d+1 -0
| @@ -8,6 +8,7 @@ Requires: |
| See-also: http1.1 http2 |
| Help: Resolve names to IPv6 addresses |
| Category: connection dns |
| + | Example: --ipv6 $URL |
| --- |
| This option tells curl to resolve names to IPv6 addresses only, and not for |
| example try IPv4. |
docs/cmdline-opts/junk-session-cookies.d+1 -0
| @@ -4,6 +4,7 @@ Help: Ignore session cookies read from file |
| Protocols: HTTP |
| See-also: cookie cookie-jar |
| Category: http |
| + | Example: --junk-session-cookies -b cookies.txt $URL |
| --- |
| When curl is told to read cookies from a given file, this option will make it |
| discard all "session cookies". This will basically have the same effect as if |
docs/cmdline-opts/keepalive-time.d+1 -0
| @@ -3,6 +3,7 @@ Arg: <seconds> |
| Help: Interval time for keepalive probes |
| Added: 7.18.0 |
| Category: connection |
| + | Example: --keepalive-time 20 $URL |
| --- |
| This option sets the time a connection needs to remain idle before sending |
| keepalive probes and the time between individual keepalive probes. It is |
docs/cmdline-opts/key-type.d+1 -0
| @@ -3,6 +3,7 @@ Arg: <type> |
| Help: Private key file type (DER/PEM/ENG) |
| Protocols: TLS |
| Category: tls |
| + | Example: --key-type DER --key here $URL |
| --- |
| Private key file type. Specify which type your --key provided private key |
| is. DER, PEM, and ENG are supported. If not specified, PEM is assumed. |
docs/cmdline-opts/key.d+1 -0
| @@ -3,6 +3,7 @@ Arg: <key> |
| Protocols: TLS SSH |
| Help: Private key file name |
| Category: tls ssh |
| + | Example: --cert certificate --key here $URL |
| --- |
| Private key file name. Allows you to provide your private key in this separate |
| file. For SSH, if not specified, curl tries the following candidates in order: |
docs/cmdline-opts/krb.d+1 -0
| @@ -4,6 +4,7 @@ Help: Enable Kerberos with security <level> |
| Protocols: FTP |
| Requires: Kerberos |
| Category: ftp |
| + | Example: --krb clear ftp://example.com/ |
| --- |
| Enable Kerberos authentication and use. The level must be entered and should |
| be one of 'clear', 'safe', 'confidential', or 'private'. Should you use a |
docs/cmdline-opts/libcurl.d+1 -0
| @@ -3,6 +3,7 @@ Arg: <file> |
| Help: Dump libcurl equivalent code of this command line |
| Added: 7.16.1 |
| Category: curl |
| + | Example: --libcurl client.c $URL |
| --- |
| Append this option to any ordinary curl command line, and you will get |
| libcurl-using C source code written to the file that does the equivalent |
docs/cmdline-opts/limit-rate.d+3 -0
| @@ -2,6 +2,9 @@ Long: limit-rate |
| Arg: <speed> |
| Help: Limit transfer speed to RATE |
| Category: connection |
| + | Example: --limit-rate 100K $URL |
| + | Example: --limit-rate 1000 $URL |
| + | Example: --limit-rate 10M $URL |
| --- |
| 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'd like |
docs/cmdline-opts/list-only.d+1 -0
| @@ -4,6 +4,7 @@ Protocols: FTP POP3 |
| Help: List only mode |
| Added: 4.0 |
| Category: ftp pop3 |
| + | Example: --list-only ftp://example.com/dir/ |
| --- |
| (FTP) |
| When listing an FTP directory, this switch forces a name-only view. This is |
docs/cmdline-opts/local-port.d+1 -0
| @@ -3,6 +3,7 @@ Arg: <num/range> |
| Help: Force use of RANGE for local port numbers |
| Added: 7.15.2 |
| Category: connection |
| + | Example: --local-port 1000-3000 $URL |
| --- |
| 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 |
docs/cmdline-opts/location-trusted.d+1 -0
| @@ -3,6 +3,7 @@ Help: Like --location, and send auth to other hosts |
| Protocols: HTTP |
| See-also: user |
| Category: http auth |
| + | Example: --location-trusted -u user:password $URL |
| --- |
| Like --location, but will allow sending the name + password to all hosts that |
| the site may redirect to. This may or may not introduce a security breach if |
docs/cmdline-opts/location.d+1 -0
| @@ -3,6 +3,7 @@ Short: L |
| Help: Follow redirects |
| Protocols: HTTP |
| Category: http |
| + | Example: -L $URL |
| --- |
| 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 |
docs/cmdline-opts/login-options.d+1 -0
| @@ -4,6 +4,7 @@ Protocols: IMAP POP3 SMTP |
| Help: Server login options |
| Added: 7.34.0 |
| Category: imap pop3 smtp auth |
| + | Example: --login-options 'AUTH=*' imap://example.com |
| --- |
| Specify the login options to use during server authentication. |
| |
docs/cmdline-opts/mail-auth.d+1 -0
| @@ -5,6 +5,7 @@ Help: Originator address of the original email |
| Added: 7.25.0 |
| See-also: mail-rcpt mail-from |
| Category: smtp |
| + | Example: --mail-auth [email protected] -T mail smtp://example.com/ |
| --- |
| Specify a single address. This will be used to specify the authentication |
| address (identity) of a submitted message that is being relayed to another |
docs/cmdline-opts/mail-from.d+1 -0
| @@ -5,5 +5,6 @@ Protocols: SMTP |
| Added: 7.20.0 |
| See-also: mail-rcpt mail-auth |
| Category: smtp |
| + | Example: --mail-from [email protected] -T mail smtp://example.com/ |
| --- |
| Specify a single address that the given mail should get sent from. |
docs/cmdline-opts/mail-rcpt-allowfails.d+1 -0
| @@ -3,6 +3,7 @@ Help: Allow RCPT TO command to fail for some recipients |
| Protocols: SMTP |
| Added: 7.69.0 |
| Category: smtp |
| + | Example: --mail-rcpt-allowfails --mail-rcpt [email protected] smtp://example.com |
| --- |
| When sending data to multiple recipients, by default curl will abort SMTP |
| conversation if at least one of the recipients causes RCPT TO command to |
docs/cmdline-opts/mail-rcpt.d+1 -0
| @@ -4,6 +4,7 @@ Help: Mail to this address |
| Protocols: SMTP |
| Added: 7.20.0 |
| Category: smtp |
| + | Example: --mail-rcpt [email protected] smtp://example.com |
| --- |
| Specify a single e-mail address, user name or mailing list name. Repeat this |
| option several times to send to multiple recipients. |
docs/cmdline-opts/manual.d+1 -0
| @@ -2,5 +2,6 @@ Long: manual |
| Short: M |
| Help: Display the full manual |
| Category: curl |
| + | Example: --manual |
| --- |
| Manual. Display the huge help text. |
docs/cmdline-opts/max-filesize.d+1 -0
| @@ -4,6 +4,7 @@ Help: Maximum file size to download |
| Protocols: FTP HTTP MQTT |
| See-also: limit-rate |
| Category: connection |
| + | Example: --max-filesize 100K $URL |
| --- |
| Specify the maximum size (in bytes) of a file to download. If the file |
| requested is larger than this value, the transfer will not start and curl will |
docs/cmdline-opts/max-redirs.d+1 -0
| @@ -3,6 +3,7 @@ Arg: <num> |
| Help: Maximum number of redirects allowed |
| Protocols: HTTP |
| Category: http |
| + | Example: --max-redirs 3 --location $URL |
| --- |
| Set maximum number of redirections to follow. When --location is used, to |
| prevent curl from following too many redirects, by default, the limit is |
docs/cmdline-opts/max-time.d+4 -2
| @@ -1,9 +1,11 @@ |
| Long: max-time |
| Short: m |
| - | Arg: <seconds> |
| - | Help: Maximum time allowed for the transfer |
| + | Arg: <fractional seconds> |
| + | Help: Maximum time allowed for transfer |
| See-also: connect-timeout |
| Category: connection |
| + | Example: --max-time 10 $URL |
| + | Example: --max-time 2.92 $URL |
| --- |
| Maximum time in seconds that you allow the whole operation to take. This is |
| useful for preventing your batch jobs from hanging for hours due to slow |
docs/cmdline-opts/metalink.d+1 -0
| @@ -2,6 +2,7 @@ Long: metalink |
| Help: Process given URLs as metalink XML file |
| Added: 7.27.0 |
| Category: misc |
| + | Example: --metalink file $URL |
| --- |
| This option was previously used to specify a metalink resource. Metalink |
| support has been disabled in curl since 7.78.0 for security reasons. |
docs/cmdline-opts/negotiate.d+1 -0
| @@ -3,6 +3,7 @@ Help: Use HTTP Negotiate (SPNEGO) authentication |
| Protocols: HTTP |
| See-also: basic ntlm anyauth proxy-negotiate |
| Category: auth http |
| + | Example: --negotiate -u : $URL |
| --- |
| Enables Negotiate (SPNEGO) authentication. |
| |
docs/cmdline-opts/netrc-file.d+1 -0
| @@ -4,6 +4,7 @@ Arg: <filename> |
| Added: 7.21.5 |
| Mutexed: netrc |
| Category: curl |
| + | Example: --netrc-file netrc $URL |
| --- |
| This option is similar to --netrc, except that you provide the path (absolute |
| or relative) to the netrc file that curl should use. You can only specify one |
docs/cmdline-opts/netrc-optional.d+1 -0
| @@ -3,6 +3,7 @@ Help: Use either .netrc or URL |
| Mutexed: netrc |
| See-also: netrc-file |
| Category: curl |
| + | Example: --netrc-optional $URL |
| --- |
| Very similar to --netrc, but this option makes the .netrc usage **optional** |
| and not mandatory as the --netrc option does. |
docs/cmdline-opts/netrc.d+1 -0
| @@ -2,6 +2,7 @@ Long: netrc |
| Short: n |
| Help: Must read .netrc for user name and password |
| Category: curl |
| + | Example: --netrc $URL |
| --- |
| Makes curl scan the *.netrc* (*_netrc* on Windows) file in the user's home |
| directory for login name and password. This is typically used for FTP on |
docs/cmdline-opts/next.d+4 -0
| @@ -6,6 +6,8 @@ Added: 7.36.0 |
| Magic: divider |
| Help: Make next URL use its separate set of options |
| Category: curl |
| + | Example: $URL --next -d postthis www2.example.com |
| + | Example: -I $URL --next https://example.net/ |
| --- |
| Tells curl to use a separate operation for the following URL and associated |
| options. This allows you to send several URL requests, each with their own |
| @@ -18,4 +20,6 @@ options include --verbose, --trace, --trace-ascii and --fail-early. |
| |
| 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 |
docs/cmdline-opts/no-alpn.d+1 -0
| @@ -6,6 +6,7 @@ See-also: no-npn http2 |
| Requires: TLS |
| Help: Disable the ALPN TLS extension |
| Category: tls http |
| + | Example: --no-alpn $URL |
| --- |
| 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 |
docs/cmdline-opts/no-buffer.d+1 -0
| @@ -2,6 +2,7 @@ Long: no-buffer |
| Short: N |
| Help: Disable buffering of the output stream |
| Category: curl |
| + | Example: --no-buffer $URL |
| --- |
| Disables the buffering of the output stream. In normal work situations, curl |
| will use a standard buffered output stream that will have the effect that it |
docs/cmdline-opts/no-keepalive.d+1 -0
| @@ -1,6 +1,7 @@ |
| Long: no-keepalive |
| Help: Disable TCP keepalive on the connection |
| Category: connection |
| + | Example: --no-keepalive $URL |
| --- |
| Disables the use of keepalive messages on the TCP connection. curl otherwise |
| enables them by default. |
docs/cmdline-opts/no-npn.d+1 -0
| @@ -7,6 +7,7 @@ See-also: no-alpn http2 |
| Requires: TLS |
| Help: Disable the NPN TLS extension |
| Category: tls http |
| + | Example: --no-npn $URL |
| --- |
| 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 |
docs/cmdline-opts/no-progress-meter.d+1 -0
| @@ -3,6 +3,7 @@ Help: Do not show the progress meter |
| See-also: verbose silent |
| Added: 7.67.0 |
| Category: verbose |
| + | Example: --no-progress-meter -o store $URL |
| --- |
| Option to switch off the progress meter output without muting or otherwise |
| affecting warning and informational messages like --silent does. |
docs/cmdline-opts/no-sessionid.d+1 -0
| @@ -3,6 +3,7 @@ Help: Disable SSL session-ID reusing |
| Protocols: TLS |
| Added: 7.16.0 |
| Category: tls |
| + | Example: --no-sessionid $URL |
| --- |
| Disable curl's use of SSL session-ID caching. By default all transfers are |
| done using the cache. Note that while nothing should ever get hurt by |
docs/cmdline-opts/noproxy.d+1 -0
| @@ -3,6 +3,7 @@ Arg: <no-proxy-list> |
| Help: List of hosts which do not use proxy |
| Added: 7.19.4 |
| Category: proxy |
| + | Example: --noproxy "www.example" $URL |
| --- |
| 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, |
docs/cmdline-opts/ntlm-wb.d+1 -0
| @@ -3,6 +3,7 @@ Help: Use HTTP NTLM authentication with winbind |
| Protocols: HTTP |
| See-also: ntlm proxy-ntlm |
| Category: auth http |
| + | Example: --ntlm-wb -u user:password $URL |
| --- |
| Enables NTLM much in the style --ntlm does, but hand over the authentication |
| to the separate binary ntlmauth application that is executed when needed. |
docs/cmdline-opts/ntlm.d+1 -0
| @@ -5,6 +5,7 @@ See-also: proxy-ntlm |
| Protocols: HTTP |
| Requires: TLS |
| Category: auth http |
| + | Example: --ntlm -u user:password $URL |
| --- |
| Enables NTLM authentication. The NTLM authentication method was designed by |
| Microsoft and is used by IIS web servers. It is a proprietary protocol, |
docs/cmdline-opts/oauth2-bearer.d+1 -0
| @@ -3,6 +3,7 @@ Help: OAuth 2 Bearer Token |
| Arg: <token> |
| Protocols: IMAP POP3 SMTP HTTP |
| Category: auth |
| + | Example: --oauth2-bearer "mF_9.B5f-4.1JqM" $URL |
| --- |
| Specify the Bearer Token for OAUTH 2.0 server authentication. The Bearer Token |
| is used in conjunction with the user name which can be specified as part of |
docs/cmdline-opts/output-dir.d+1 -0
| @@ -4,6 +4,7 @@ Help: Directory to save files in |
| Added: 7.73.0 |
| See-also: remote-name remote-header-name |
| Category: curl |
| + | Example: --output-dir "tmp" -O $URL |
| --- |
| |
| This option specifies the directory in which files should be stored, when |
docs/cmdline-opts/output.d+4 -0
| @@ -4,6 +4,10 @@ Short: o |
| Help: Write to file instead of stdout |
| See-also: remote-name remote-name-all remote-header-name |
| Category: important curl |
| + | Example: -o file $URL |
| + | Example: "http://{one,two}.example.com" -o "file_#1.txt" |
| + | Example: "http://{site,host}.host[1-5].com" -o "#1_#2" |
| + | Example: -o file $URL -o file2 https://example.net |
| --- |
| Write output to <file> instead of stdout. If you are using {} or [] to fetch |
| multiple documents, you should quote the URL and you can use '#' followed by a |
docs/cmdline-opts/parallel-immediate.d+1 -0
| @@ -3,6 +3,7 @@ Help: Do not wait for multiplexing (with --parallel) |
| Added: 7.68.0 |
| See-also: parallel parallel-max |
| Category: connection curl |
| + | Example: --parallel-immediate -Z $URL -o file1 $URL -o file2 |
| --- |
| When doing parallel transfers, this option will instruct curl that it should |
| rather prefer opening up more connections in parallel at once rather than |
docs/cmdline-opts/parallel-max.d+1 -0
| @@ -4,6 +4,7 @@ Help: Maximum concurrency for parallel transfers |
| Added: 7.66.0 |
| See-also: parallel |
| Category: connection curl |
| + | Example: --parallel-max 100 -Z $URL ftp://example.com/ |
| --- |
| When asked to do parallel transfers, using --parallel, this option controls |
| the maximum amount of transfers to do simultaneously. |
docs/cmdline-opts/parallel.d+1 -0
| @@ -3,6 +3,7 @@ Long: parallel |
| Help: Perform transfers in parallel |
| Added: 7.66.0 |
| Category: connection curl |
| + | Example: --parallel $URL -o file1 $URL -o file2 |
| --- |
| Makes curl perform its transfers in parallel as compared to the regular serial |
| manner. |
docs/cmdline-opts/pass.d+1 -0
| @@ -3,6 +3,7 @@ Arg: <phrase> |
| Help: Pass phrase for the private key |
| Protocols: SSH TLS |
| Category: ssh tls auth |
| + | Example: --pass secret --key file $URL |
| --- |
| Passphrase for the private key. |
| |
docs/cmdline-opts/path-as-is.d+1 -0
| @@ -2,6 +2,7 @@ Long: path-as-is |
| Help: Do not squash .. sequences in URL path |
| Added: 7.42.0 |
| Category: curl |
| + | Example: --path-as-is https://example.com/../../etc/passwd |
| --- |
| Tell curl to not handle sequences of /../ or /./ in the given URL |
| path. Normally curl will squash or merge them according to standards but with |
docs/cmdline-opts/pinnedpubkey.d+2 -0
| @@ -3,6 +3,8 @@ Arg: <hashes> |
| Help: FILE/HASHES Public key to verify peer against |
| Protocols: TLS |
| Category: tls |
| + | Example: --pinnedpubkey keyfile $URL |
| + | Example: --pinnedpubkey 'sha256//ce118b51897f4452dc' $URL |
| --- |
| Tells curl to 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 |
docs/cmdline-opts/post301.d+1 -0
| @@ -4,6 +4,7 @@ Protocols: HTTP |
| See-also: post302 post303 location |
| Added: 7.17.1 |
| Category: http post |
| + | Example: --post301 --location -d "data" $URL |
| --- |
| Tells curl to respect RFC 7231/6.4.2 and not convert POST requests into GET |
| requests when following a 301 redirection. The non-RFC behavior is ubiquitous |
docs/cmdline-opts/post302.d+1 -0
| @@ -4,6 +4,7 @@ Protocols: HTTP |
| See-also: post301 post303 location |
| Added: 7.19.1 |
| Category: http post |
| + | Example: --post302 --location -d "data" $URL |
| --- |
| Tells curl to respect RFC 7231/6.4.3 and not convert POST requests into GET |
| requests when following a 302 redirection. The non-RFC behavior is ubiquitous |
docs/cmdline-opts/post303.d+1 -0
| @@ -4,6 +4,7 @@ Protocols: HTTP |
| See-also: post302 post301 location |
| Added: 7.26.0 |
| Category: http post |
| + | Example: --post303 --location -d "data" $URL |
| --- |
| Tells curl to violate RFC 7231/6.4.4 and not convert POST requests into GET |
| requests when following 303 redirections. A server may require a POST to |
docs/cmdline-opts/preproxy.d+1 -0
| @@ -3,6 +3,7 @@ Arg: [protocol://]host[:port] |
| Help: Use this proxy first |
| Added: 7.52.0 |
| Category: proxy |
| + | Example: --preproxy socks5://proxy.example -x http://http.example $URL |
| --- |
| Use the specified SOCKS proxy before connecting to an HTTP or HTTPS --proxy. In |
| such a case curl first connects to the SOCKS proxy and then connects (through |
docs/cmdline-opts/progress-bar.d+1 -0
| @@ -2,6 +2,7 @@ Short: # |
| Long: progress-bar |
| Help: Display transfer progress as a bar |
| Category: verbose |
| + | Example: -# -O $URL |
| --- |
| Make curl display transfer progress as a simple progress bar instead of the |
| standard, more informational, meter. |
docs/cmdline-opts/proto-default.d+3 -6
| @@ -3,17 +3,14 @@ Help: Use PROTOCOL for any URL missing a scheme |
| Arg: <protocol> |
| Added: 7.45.0 |
| Category: connection curl |
| + | Example: --proto-default https ftp.example.com |
| --- |
| Tells curl to use *protocol* for any URL missing a scheme name. |
| |
| - | Example: |
| - | |
| - | curl --proto-default https ftp.mozilla.org |
| - | |
| An unknown or unsupported protocol causes error |
| *CURLE_UNSUPPORTED_PROTOCOL* (1). |
| |
| This option does not change the default proxy protocol (http). |
| |
| - | Without this option curl would make a guess based on the host, see --url for |
| - | details. |
| + | Without this option set, curl guesses protocol based on the host name, see |
| + | --url for details. |
docs/cmdline-opts/proto-redir.d+1 -0
| @@ -3,6 +3,7 @@ Arg: <protocols> |
| Help: Enable/disable PROTOCOLS on redirect |
| Added: 7.20.2 |
| Category: connection curl |
| + | Example: --proto-redir =http,https $URL |
| --- |
| Tells curl to limit what protocols it may use on redirect. Protocols denied by |
| --proto are not overridden by this option. See --proto for how protocols are |
docs/cmdline-opts/proto.d+1 -0
| @@ -4,6 +4,7 @@ Help: Enable/disable PROTOCOLS |
| See-also: proto-redir proto-default |
| Added: 7.20.2 |
| Category: connection curl |
| + | Example: --proto =http,https,sftp $URL |
| --- |
| Tells curl to limit what protocols it may use for transfers. Protocols are |
| evaluated left to right, are comma separated, and are each a protocol name or |
docs/cmdline-opts/proxy-anyauth.d+1 -0
| @@ -3,6 +3,7 @@ Help: Pick any proxy authentication method |
| Added: 7.13.2 |
| See-also: proxy proxy-basic proxy-digest |
| Category: proxy auth |
| + | Example: --proxy-anyauth --proxy-user user:passwd -x proxy $URL |
| --- |
| Tells curl to pick a suitable authentication method when communicating with |
| the given HTTP proxy. This might cause an extra request/response round-trip. |
docs/cmdline-opts/proxy-basic.d+1 -0
| @@ -2,6 +2,7 @@ Long: proxy-basic |
| Help: Use Basic authentication on the proxy |
| See-also: proxy proxy-anyauth proxy-digest |
| Category: proxy auth |
| + | Example: --proxy-basic --proxy-user user:passwd -x proxy $URL |
| --- |
| Tells curl to use HTTP Basic authentication when communicating with the given |
| proxy. Use --basic for enabling HTTP Basic with a remote host. Basic is the |
docs/cmdline-opts/proxy-cacert.d+1 -0
| @@ -4,5 +4,6 @@ Arg: <file> |
| Added: 7.52.0 |
| See-also: proxy-capath cacert capath proxy |
| Category: proxy tls |
| + | Example: --proxy-cacert CA-file.txt -x https://proxy $URL |
| --- |
| Same as --cacert but used in HTTPS proxy context. |
docs/cmdline-opts/proxy-capath.d+1 -0
| @@ -4,5 +4,6 @@ Arg: <dir> |
| Added: 7.52.0 |
| See-also: proxy-cacert proxy capath |
| Category: proxy tls |
| + | Example: --proxy-capath /local/directory -x https://proxy $URL |
| --- |
| Same as --capath but used in HTTPS proxy context. |
docs/cmdline-opts/proxy-cert-type.d+1 -0
| @@ -3,5 +3,6 @@ Arg: <type> |
| Added: 7.52.0 |
| Help: Client certificate type for HTTPS proxy |
| Category: proxy tls |
| + | Example: --proxy-cert-type PEM --proxy-cert file -x https://proxy $URL |
| --- |
| Same as --cert-type but used in HTTPS proxy context. |
docs/cmdline-opts/proxy-cert.d+1 -0
| @@ -3,5 +3,6 @@ Arg: <cert[:passwd]> |
| Help: Set client certificate for proxy |
| Added: 7.52.0 |
| Category: proxy tls |
| + | Example: --proxy-cert file -x https://proxy $URL |
| --- |
| Same as --cert but used in HTTPS proxy context. |
docs/cmdline-opts/proxy-ciphers.d+1 -0
| @@ -3,5 +3,6 @@ Arg: <list> |
| Help: SSL ciphers to use for proxy |
| Added: 7.52.0 |
| Category: proxy tls |
| + | Example: --proxy-ciphers ECDHE-ECDSA-AES256-CCM8 -x https://proxy $URL |
| --- |
| Same as --ciphers but used in HTTPS proxy context. |
docs/cmdline-opts/proxy-crlfile.d+1 -0
| @@ -3,5 +3,6 @@ Arg: <file> |
| Help: Set a CRL list for proxy |
| Added: 7.52.0 |
| Category: proxy tls |
| + | Example: --proxy-crlfile rejects.txt -x https://proxy $URL |
| --- |
| Same as --crlfile but used in HTTPS proxy context. |
docs/cmdline-opts/proxy-digest.d+1 -0
| @@ -2,6 +2,7 @@ Long: proxy-digest |
| Help: Use Digest authentication on the proxy |
| See-also: proxy proxy-anyauth proxy-basic |
| Category: proxy tls |
| + | Example: --proxy-digest --proxy-user user:passwd -x proxy $URL |
| --- |
| Tells curl to use HTTP Digest authentication when communicating with the given |
| proxy. Use --digest for enabling HTTP Digest with a remote host. |
docs/cmdline-opts/proxy-header.d+3 -0
| @@ -4,6 +4,9 @@ Help: Pass custom header(s) to proxy |
| Protocols: HTTP |
| Added: 7.37.0 |
| Category: proxy |
| + | Example: --proxy-header "X-First-Name: Joe" -x http://proxy $URL |
| + | Example: --proxy-header "User-Agent: surprise" -x http://proxy $URL |
| + | Example: --proxy-header "Host:" -x http://proxy $URL |
| --- |
| 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 --header |
docs/cmdline-opts/proxy-insecure.d+1 -0
| @@ -2,5 +2,6 @@ Long: proxy-insecure |
| Help: Do HTTPS proxy connections without verifying the proxy |
| Added: 7.52.0 |
| Category: proxy tls |
| + | Example: --proxy-insecure -x https://proxy $URL |
| --- |
| Same as --insecure but used in HTTPS proxy context. |
docs/cmdline-opts/proxy-key-type.d+1 -0
| @@ -3,5 +3,6 @@ Arg: <type> |
| Help: Private key file type for proxy |
| Added: 7.52.0 |
| Category: proxy tls |
| + | Example: --proxy-key-type DER --proxy-key here -x https://proxy $URL |
| --- |
| Same as --key-type but used in HTTPS proxy context. |
docs/cmdline-opts/proxy-key.d+1 -0
| @@ -2,5 +2,6 @@ Long: proxy-key |
| Help: Private key for HTTPS proxy |
| Arg: <key> |
| Category: proxy tls |
| + | Example: --proxy-key here -x https://proxy $URL |
| --- |
| Same as --key but used in HTTPS proxy context. |
docs/cmdline-opts/proxy-negotiate.d+1 -0
| @@ -3,6 +3,7 @@ Help: Use HTTP Negotiate (SPNEGO) authentication on the proxy |
| Added: 7.17.1 |
| See-also: proxy-anyauth proxy-basic |
| Category: proxy auth |
| + | Example: --proxy-negotiate --proxy-user user:passwd -x proxy $URL |
| --- |
| Tells curl to use HTTP Negotiate (SPNEGO) authentication when communicating |
| with the given proxy. Use --negotiate for enabling HTTP Negotiate (SPNEGO) |
docs/cmdline-opts/proxy-ntlm.d+1 -0
| @@ -2,6 +2,7 @@ Long: proxy-ntlm |
| Help: Use NTLM authentication on the proxy |
| See-also: proxy-negotiate proxy-anyauth |
| Category: proxy auth |
| + | Example: --proxy-ntlm --proxy-user user:passwd -x http://proxy $URL |
| --- |
| Tells curl to use HTTP NTLM authentication when communicating with the given |
| proxy. Use --ntlm for enabling NTLM with a remote host. |
docs/cmdline-opts/proxy-pass.d+1 -0
| @@ -3,5 +3,6 @@ Arg: <phrase> |
| Help: Pass phrase for the private key for HTTPS proxy |
| Added: 7.52.0 |
| Category: proxy tls auth |
| + | Example: --proxy-pass secret --proxy-key here -x https://proxy $URL |
| --- |
| Same as --pass but used in HTTPS proxy context. |
docs/cmdline-opts/proxy-pinnedpubkey.d+2 -0
| @@ -3,6 +3,8 @@ Arg: <hashes> |
| Help: FILE/HASHES public key to verify proxy with |
| Protocols: TLS |
| Category: proxy tls |
| + | Example: --proxy-pinnedpubkey keyfile $URL |
| + | Example: --proxy-pinnedpubkey 'sha256//ce118b51897f4452dc' $URL |
| --- |
| Tells curl to 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 |
docs/cmdline-opts/proxy-service-name.d+1 -0
| @@ -3,5 +3,6 @@ Arg: <name> |
| Help: SPNEGO proxy service name |
| Added: 7.43.0 |
| Category: proxy tls |
| + | Example: --proxy-service-name "shrubbery" -x proxy $URL |
| --- |
| This option allows you to change the service name for proxy negotiation. |
docs/cmdline-opts/proxy-ssl-allow-beast.d+1 -0
| @@ -2,5 +2,6 @@ Long: proxy-ssl-allow-beast |
| Help: Allow security flaw for interop for HTTPS proxy |
| Added: 7.52.0 |
| Category: proxy tls |
| + | Example: --proxy-ssl-allow-beast -x https://proxy $URL |
| --- |
| Same as --ssl-allow-beast but used in HTTPS proxy context. |
docs/cmdline-opts/proxy-ssl-auto-client-cert.d+1 -0
| @@ -2,5 +2,6 @@ Long: proxy-ssl-auto-client-cert |
| Help: Use auto client certificate for proxy (Schannel) |
| Added: 7.77.0 |
| Category: proxy tls |
| + | Example: --proxy-ssl-auto-client-cert -x https://proxy $URL |
| --- |
| Same as --ssl-auto-client-cert but used in HTTPS proxy context. |
docs/cmdline-opts/proxy-tls13-ciphers.d+1 -0
| @@ -3,6 +3,7 @@ Arg: <ciphersuite list> |
| help: TLS 1.3 proxy cipher suites |
| Protocols: TLS |
| Category: proxy tls |
| + | Example: --proxy-tls13-ciphers TLS_AES_128_GCM_SHA256 -x proxy $URL |
| --- |
| Specifies 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 |
docs/cmdline-opts/proxy-tlsauthtype.d+1 -0
| @@ -3,5 +3,6 @@ Arg: <type> |
| Help: TLS authentication type for HTTPS proxy |
| Added: 7.52.0 |
| Category: proxy tls auth |
| + | Example: --proxy-tlsauthtype SRP -x https://proxy $URL |
| --- |
| Same as --tlsauthtype but used in HTTPS proxy context. |
docs/cmdline-opts/proxy-tlspassword.d+1 -0
| @@ -3,5 +3,6 @@ Arg: <string> |
| Help: TLS password for HTTPS proxy |
| Added: 7.52.0 |
| Category: proxy tls auth |
| + | Example: --proxy-tlspassword passwd -x https://proxy $URL |
| --- |
| Same as --tlspassword but used in HTTPS proxy context. |
docs/cmdline-opts/proxy-tlsuser.d+1 -0
| @@ -3,5 +3,6 @@ Arg: <name> |
| Help: TLS username for HTTPS proxy |
| Added: 7.52.0 |
| Category: proxy tls auth |
| + | Example: --proxy-tlsuser smith -x https://proxy $URL |
| --- |
| Same as --tlsuser but used in HTTPS proxy context. |
docs/cmdline-opts/proxy-tlsv1.d+1 -0
| @@ -2,5 +2,6 @@ Long: proxy-tlsv1 |
| Help: Use TLSv1 for HTTPS proxy |
| Added: 7.52.0 |
| Category: proxy tls auth |
| + | Example: --proxy-tlsv1 -x https://proxy $URL |
| --- |
| Same as --tlsv1 but used in HTTPS proxy context. |
docs/cmdline-opts/proxy-user.d+1 -0
| @@ -3,6 +3,7 @@ Short: U |
| Arg: <user:password> |
| Help: Proxy user and password |
| Category: proxy auth |
| + | Example: --proxy-user name:pwd -x proxy $URL |
| --- |
| Specify the user name and password to use for proxy authentication. |
| |
docs/cmdline-opts/proxy.d+1 -0
| @@ -3,6 +3,7 @@ Short: x |
| Arg: [protocol://]host[:port] |
| Help: Use this proxy |
| Category: proxy |
| + | Example: --proxy http://proxy.example $URL |
| --- |
| Use the specified proxy. |
| |
docs/cmdline-opts/proxy1.0.d+1 -0
| @@ -2,6 +2,7 @@ Long: proxy1.0 |
| Arg: <host[:port]> |
| Help: Use HTTP/1.0 proxy on given port |
| Category: proxy |
| + | Example: --proxy1.0 -x http://proxy $URL |
| --- |
| Use the specified HTTP 1.0 proxy. If the port number is not specified, it is |
| assumed at port 1080. |
docs/cmdline-opts/proxytunnel.d+1 -0
| @@ -3,6 +3,7 @@ Short: p |
| Help: Operate through an HTTP proxy tunnel (using CONNECT) |
| See-also: proxy |
| Category: proxy |
| + | Example: --proxytunnel -x http://proxy $URL |
| --- |
| When an HTTP proxy is used --proxy, this option will make curl tunnel through |
| the proxy. The tunnel approach is made with the HTTP proxy CONNECT request and |
docs/cmdline-opts/pubkey.d+1 -0
| @@ -3,6 +3,7 @@ Arg: <key> |
| Protocols: SFTP SCP |
| Help: SSH Public key file name |
| Category: sftp scp auth |
| + | Example: --pubkey file.pub sftp://example.com/ |
| --- |
| Public key file name. Allows you to provide your public key in this separate |
| file. |
docs/cmdline-opts/quote.d+1 -0
| @@ -4,6 +4,7 @@ Short: Q |
| Help: Send command(s) to server before transfer |
| Protocols: FTP SFTP |
| Category: ftp sftp |
| + | Example: --quote "DELE file" ftp://example.com/foo |
| --- |
| Send an arbitrary command to the remote FTP or SFTP server. Quote commands are |
| sent BEFORE the transfer takes place (just after the initial PWD command in an |
docs/cmdline-opts/random-file.d+1 -0
| @@ -2,6 +2,7 @@ Long: random-file |
| Arg: <file> |
| Help: File for reading random data from |
| Category: misc |
| + | Example: --random-file rubbish $URL |
| --- |
| Specify the path name to file containing what will be considered as random |
| data. The data may be used to seed the random engine for SSL connections. See |
docs/cmdline-opts/range.d+1 -0
| @@ -4,6 +4,7 @@ Help: Retrieve only the bytes within RANGE |
| Arg: <range> |
| Protocols: HTTP FTP SFTP FILE |
| Category: http ftp sftp file |
| + | Example: --range 22-44 $URL |
| --- |
| 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. |
docs/cmdline-opts/raw.d+1 -0
| @@ -3,6 +3,7 @@ Help: Do HTTP "raw"; no transfer decoding |
| Added: 7.16.2 |
| Protocols: HTTP |
| Category: http |
| + | Example: --raw $URL |
| --- |
| When used, it disables all internal HTTP decoding of content or transfer |
| encodings and instead makes them passed on unaltered, raw. |
docs/cmdline-opts/referer.d+3 -0
| @@ -5,6 +5,9 @@ Protocols: HTTP |
| Help: Referrer URL |
| See-also: user-agent header |
| Category: http |
| + | Example: --referer "https://fake.example" $URL |
| + | Example: --referer "https://fake.example;auto" -L $URL |
| + | Example: --referer ";auto" -L $URL |
| --- |
| Sends the "Referrer Page" information to the HTTP server. This can also be set |
| with the --header flag of course. When used with --location you can append |
docs/cmdline-opts/remote-header-name.d+1 -0
| @@ -3,6 +3,7 @@ Short: J |
| Protocols: HTTP |
| Help: Use the header-provided filename |
| Category: output |
| + | Example: -OJ https://example.com/file |
| --- |
| This option tells the --remote-name option to use the server-specified |
| Content-Disposition filename instead of extracting a filename from the URL. |
docs/cmdline-opts/remote-name-all.d+1 -0
| @@ -2,6 +2,7 @@ Long: remote-name-all |
| Help: Use the remote file name for all URLs |
| Added: 7.19.0 |
| Category: output |
| + | Example: --remote-name-all ftp://example.com/file1 ftp://example.com/file2 |
| --- |
| This option changes the default action for all given URLs to be dealt with as |
| if --remote-name were used for each one. So if you want to disable that for a |
docs/cmdline-opts/remote-name.d+1 -0
| @@ -2,6 +2,7 @@ Long: remote-name |
| Short: O |
| Help: Write output to a file named as the remote file |
| Category: important output |
| + | Example: -O https://example.com/filename |
| --- |
| 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.) |
docs/cmdline-opts/remote-time.d+1 -0
| @@ -2,6 +2,7 @@ Long: remote-time |
| Short: R |
| Help: Set the remote file's time on the local output |
| Category: output |
| + | Example: --remote-time -o foo $URL |
| --- |
| When used, this will make curl attempt to figure out the timestamp of the |
| remote file, and if that is available make the local file get that same |
docs/cmdline-opts/request-target.d+1 -0
| @@ -4,6 +4,7 @@ Help: Specify the target for this request |
| Protocols: HTTP |
| Added: 7.55.0 |
| Category: http |
| + | Example: --request-target "*" -X OPTIONS $URL |
| --- |
| Tells curl to use an alternative "target" (path) instead of using the path as |
| provided in the URL. Particularly useful when wanting to issue HTTP requests |
docs/cmdline-opts/request.d+2 -0
| @@ -3,6 +3,8 @@ Short: X |
| Arg: <command> |
| Help: Specify request command to use |
| Category: connection |
| + | Example: -X "DELETE" $URL |
| + | Example: -X NLST ftp://example.com/ |
| --- |
| (HTTP) Specifies a custom request method to use when communicating with the |
| HTTP server. The specified request method will be used instead of the method |
docs/cmdline-opts/resolve.d+1 -0
| @@ -3,6 +3,7 @@ Arg: <[+]host:port:addr[,addr]...> |
| Help: Resolve the host+port to this address |
| Added: 7.21.3 |
| Category: connection |
| + | Example: --resolve example.com:443:127.0.0.1 $URL |
| --- |
| 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 |
docs/cmdline-opts/retry-all-errors.d+9 -7
| @@ -2,6 +2,7 @@ Long: retry-all-errors |
| Help: Retry all errors (use with --retry) |
| Added: 7.71.0 |
| Category: curl |
| + | Example: --retry-all-errors $URL |
| --- |
| Retry on any error. This option is used together with --retry. |
| |
| @@ -11,13 +12,14 @@ receiving duplicate data. Do not use with redirected input or output. You'd be |
| much better off handling your unique problems in shell script. Please read the |
| example below. |
| |
| - | Warning: 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 don't parse or record output via redirect in combination with |
| - | this option, since you may receive duplicate data. |
| + | **WARNING**: 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 don't parse or record output |
| + | via redirect in combination with this option, since you may receive duplicate |
| + | data. |
| |
| By default curl will not error on an HTTP response code that indicates an HTTP |
| error, if the transfer was successful. For example, if a server replies 404 |
docs/cmdline-opts/retry-connrefused.d+1 -0
| @@ -2,6 +2,7 @@ Long: retry-connrefused |
| Help: Retry on connection refused (use with --retry) |
| Added: 7.52.0 |
| Category: curl |
| + | Example: --retry-connrefused --retry $URL |
| --- |
| In addition to the other conditions, consider ECONNREFUSED as a transient |
| error too for --retry. This option is used together with --retry. |
docs/cmdline-opts/retry-delay.d+1 -0
| @@ -3,6 +3,7 @@ Arg: <seconds> |
| Help: Wait time between retries |
| Added: 7.12.3 |
| Category: curl |
| + | Example: --retry-delay 5 --retry $URL |
| --- |
| 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 |
docs/cmdline-opts/retry-max-time.d+1 -0
| @@ -3,6 +3,7 @@ Arg: <seconds> |
| Help: Retry only within this period |
| Added: 7.12.3 |
| Category: curl |
| + | Example: --retry-max-time 30 --retry 10 $URL |
| --- |
| The retry timer is reset before the first transfer attempt. Retries will be |
| done as usual (see --retry) as long as the timer hasn't reached this given |
docs/cmdline-opts/retry.d+1 -0
| @@ -3,6 +3,7 @@ Arg: <num> |
| Added: 7.12.3 |
| Help: Retry request if transient problems occur |
| Category: curl |
| + | Example: --retry 7 $URL |
| --- |
| If a transient error is returned when curl tries to perform a transfer, it |
| will retry this number of times before giving up. Setting the number to 0 |
docs/cmdline-opts/sasl-authzid.d+1 -0
| @@ -3,6 +3,7 @@ Arg: <identity> |
| Help: Identity for SASL PLAIN authentication |
| Added: 7.66.0 |
| Category: auth |
| + | Example: --sasl-authzid zid imap://example.com/ |
| --- |
| Use this authorisation identity (authzid), during SASL PLAIN authentication, |
| in addition to the authentication identity (authcid) as specified by --user. |
docs/cmdline-opts/sasl-ir.d+1 -0
| @@ -2,5 +2,6 @@ Long: sasl-ir |
| Help: Enable initial response in SASL authentication |
| Added: 7.31.0 |
| Category: auth |
| + | Example: --sasl-ir imap://example.com/ |
| --- |
| Enable initial response in SASL authentication. |
docs/cmdline-opts/service-name.d+1 -0
| @@ -3,6 +3,7 @@ Help: SPNEGO service name |
| Arg: <name> |
| Added: 7.43.0 |
| Category: misc |
| + | Example: --service-name sockd/server $URL |
| --- |
| This option allows you to change the service name for SPNEGO. |
| |
docs/cmdline-opts/show-error.d+1 -0
| @@ -3,6 +3,7 @@ Short: S |
| Help: Show error even when -s is used |
| See-also: no-progress-meter |
| Category: curl |
| + | Example: --show-error --silent $URL |
| --- |
| When used with --silent, it makes curl show an error message if it fails. |
| |
docs/cmdline-opts/silent.d+1 -0
| @@ -3,6 +3,7 @@ Short: s |
| Help: Silent mode |
| See-also: verbose stderr no-progress-meter |
| Category: important verbose |
| + | Example: -s $URL |
| --- |
| Silent or quiet mode. Don't show progress meter or error messages. Makes Curl |
| mute. It will still output the data you ask for, potentially even to the |
docs/cmdline-opts/socks4.d+1 -0
| @@ -3,6 +3,7 @@ Arg: <host[:port]> |
| Help: SOCKS4 proxy on given host + port |
| Added: 7.15.2 |
| Category: proxy |
| + | Example: --socks4 hostname:4096 $URL |
| --- |
| 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 host name |
docs/cmdline-opts/socks4a.d+1 -0
| @@ -3,6 +3,7 @@ Arg: <host[:port]> |
| Help: SOCKS4a proxy on given host + port |
| Added: 7.18.0 |
| Category: proxy |
| + | Example: --socks4a hostname:4096 $URL |
| --- |
| 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 host name. |
docs/cmdline-opts/socks5-basic.d+1 -0
| @@ -2,6 +2,7 @@ Long: socks5-basic |
| Help: Enable username/password auth for SOCKS5 proxies |
| Added: 7.55.0 |
| Category: proxy auth |
| + | Example: --socks5-basic --socks5 hostname:4096 $URL |
| --- |
| Tells curl to use username/password authentication when connecting to a SOCKS5 |
| proxy. The username/password authentication is enabled by default. Use |
docs/cmdline-opts/socks5-gssapi-nec.d+1 -0
| @@ -2,6 +2,7 @@ Long: socks5-gssapi-nec |
| Help: Compatibility with NEC SOCKS5 server |
| Added: 7.19.4 |
| Category: proxy auth |
| + | Example: --socks5-gssapi-nec --socks5 hostname:4096 $URL |
| --- |
| 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 |
docs/cmdline-opts/socks5-gssapi-service.d+1 -0
| @@ -3,6 +3,7 @@ Arg: <name> |
| Help: SOCKS5 proxy service name for GSS-API |
| Added: 7.19.4 |
| Category: proxy auth |
| + | Example: --socks5-gssapi-service sockd --socks5 hostname:4096 $URL |
| --- |
| The default service name for a socks server is rcmd/server-fqdn. This option |
| allows you to change it. |
docs/cmdline-opts/socks5-gssapi.d+1 -0
| @@ -2,6 +2,7 @@ Long: socks5-gssapi |
| Help: Enable GSS-API auth for SOCKS5 proxies |
| Added: 7.55.0 |
| Category: proxy auth |
| + | Example: --socks5-gssapi --socks5 hostname:4096 $URL |
| --- |
| Tells curl to use GSS-API authentication when connecting to a SOCKS5 proxy. |
| The GSS-API authentication is enabled by default (if curl is compiled with |
docs/cmdline-opts/socks5-hostname.d+1 -0
| @@ -3,6 +3,7 @@ Arg: <host[:port]> |
| Help: SOCKS5 proxy, pass host name to proxy |
| Added: 7.18.0 |
| Category: proxy |
| + | Example: --socks5-hostname proxy.example:7000 $URL |
| --- |
| Use the specified SOCKS5 proxy (and let the proxy resolve the host name). If |
| the port number is not specified, it is assumed at port 1080. |
docs/cmdline-opts/socks5.d+1 -0
| @@ -3,6 +3,7 @@ Arg: <host[:port]> |
| Help: SOCKS5 proxy on given host + port |
| Added: 7.18.0 |
| Category: proxy |
| + | Example: --socks5 proxy.example:7000 $URL |
| --- |
| Use the specified SOCKS5 proxy - but resolve the host name locally. If the |
| port number is not specified, it is assumed at port 1080. |
docs/cmdline-opts/speed-limit.d+1 -0
| @@ -3,6 +3,7 @@ Short: Y |
| Arg: <speed> |
| Help: Stop transfers slower than this |
| Category: connection |
| + | Example: --speed-limit 300 --speed-time 10 $URL |
| --- |
| If a download is slower than this given speed (in bytes per second) for |
| speed-time seconds it gets aborted. speed-time is set with --speed-time and is |
docs/cmdline-opts/speed-time.d+1 -0
| @@ -3,6 +3,7 @@ Short: y |
| Arg: <seconds> |
| Help: Trigger 'speed-limit' abort after this time |
| Category: connection |
| + | Example: --speed-limit 300 --speed-time 10 $URL |
| --- |
| If a download is slower than speed-limit bytes per second during a speed-time |
| period, the download gets aborted. If speed-time is used, the default |
docs/cmdline-opts/ssl-allow-beast.d+5 -2
| @@ -2,9 +2,12 @@ Long: ssl-allow-beast |
| Help: Allow security flaw to improve interop |
| Added: 7.25.0 |
| Category: tls |
| + | Example: --ssl-allow-beast $URL |
| --- |
| This option tells curl to not work around a security flaw in the SSL3 and |
| TLS1.0 protocols known as BEAST. If this option isn't used, the SSL layer may |
| use workarounds known to cause interoperability problems with some older SSL |
| - | implementations. WARNING: this option loosens the SSL security, and by using |
| - | this flag you ask for exactly that. |
| + | implementations. |
| + | |
| + | **WARNING**: this option loosens the SSL security, and by using this flag you |
| + | ask for exactly that. |
docs/cmdline-opts/ssl-auto-client-cert.d+1 -0
| @@ -3,6 +3,7 @@ Help: Use auto client certificate (Schannel) |
| Added: 7.77.0 |
| See-also: proxy-ssl-auto-client-cert |
| Category: tls |
| + | Example: --ssl-auto-client-cert $URL |
| --- |
| Tell libcurl to automatically locate and use a client certificate for |
| authentication, when requested by the server. This option is only supported |
docs/cmdline-opts/ssl-no-revoke.d+1 -0
| @@ -2,6 +2,7 @@ Long: ssl-no-revoke |
| Help: Disable cert revocation checks (Schannel) |
| Added: 7.44.0 |
| Category: tls |
| + | Example: --ssl-no-revoke $URL |
| --- |
| (Schannel) This option tells curl to disable certificate revocation checks. |
| WARNING: this option loosens the SSL security, and by using this flag you ask |
docs/cmdline-opts/ssl-reqd.d+1 -0
| @@ -3,6 +3,7 @@ Help: Require SSL/TLS |
| Protocols: FTP IMAP POP3 SMTP |
| Added: 7.20.0 |
| Category: tls |
| + | Example: --ssl-reqd ftp://example.com |
| --- |
| Require SSL/TLS for the connection. Terminates the connection if the server |
| doesn't support SSL/TLS. |
docs/cmdline-opts/ssl-revoke-best-effort.d+1 -0
| @@ -2,6 +2,7 @@ Long: ssl-revoke-best-effort |
| Help: Ignore missing/offline cert CRL dist points |
| Added: 7.70.0 |
| Category: tls |
| + | Example: --ssl-revoke-best-effort $URL |
| --- |
| (Schannel) This option tells curl to ignore certificate revocation checks when |
| they failed due to missing/offline distribution points for the revocation check |
docs/cmdline-opts/ssl.d+1 -0
| @@ -3,6 +3,7 @@ Help: Try SSL/TLS |
| Protocols: FTP IMAP POP3 SMTP |
| Added: 7.20.0 |
| Category: tls |
| + | Example: --ssl pop3://example.com/ |
| --- |
| Try to use SSL/TLS for the connection. Reverts to a non-secure connection if |
| the server doesn't support SSL/TLS. See also --ftp-ssl-control and --ssl-reqd |
docs/cmdline-opts/sslv2.d+4 -2
| @@ -8,6 +8,8 @@ Requires: TLS |
| See-also: http1.1 http2 |
| Help: Use SSLv2 |
| Category: tls |
| + | Example: --sslv2 $URL |
| --- |
| - | This option previously asked curl to use SSLv2, but starting in curl 7.77.0 this |
| - | instruction is ignored. SSLv2 is widely considered insecure (see RFC 6176). |
| + | This option previously asked curl to use SSLv2, but starting in curl 7.77.0 |
| + | this instruction is ignored. SSLv2 is widely considered insecure (see RFC |
| + | 6176). |
docs/cmdline-opts/sslv3.d+1 -0
| @@ -8,6 +8,7 @@ Requires: TLS |
| See-also: http1.1 http2 |
| Help: Use SSLv3 |
| Category: tls |
| + | Example: --sslv3 $URL |
| --- |
| This option previously asked curl to use SSLv3, but starting in curl 7.77.0 |
| this instruction is ignored. SSLv3 is widely considered insecure (see RFC |
docs/cmdline-opts/stderr.d+1 -0
| @@ -3,6 +3,7 @@ Arg: <file> |
| Help: Where to redirect stderr |
| See-also: verbose silent |
| Category: verbose |
| + | Example: --stderr output.txt $URL |
| --- |
| Redirect all writes to stderr to the specified file instead. If the file name |
| is a plain '-', it is instead written to stdout. |
docs/cmdline-opts/styled-output.d+1 -0
| @@ -2,6 +2,7 @@ Long: styled-output |
| Help: Enable styled output for HTTP headers |
| Added: 7.61.0 |
| Category: verbose |
| + | Example: --styled-output -I $URL |
| --- |
| Enables the automatic use of bold font styles when writing HTTP headers to the |
| terminal. Use --no-styled-output to switch them off. |
docs/cmdline-opts/suppress-connect-headers.d+1 -0
| @@ -2,6 +2,7 @@ Long: suppress-connect-headers |
| Help: Suppress proxy CONNECT response headers |
| See-also: dump-header include proxytunnel |
| Category: proxy |
| + | Example: --suppress-connect-headers --include -x proxy $URL |
| --- |
| When --proxytunnel is used and a CONNECT request is made don't output proxy |
| CONNECT response headers. This option is meant to be used with --dump-header or |
docs/cmdline-opts/tcp-fastopen.d+1 -0
| @@ -2,5 +2,6 @@ Long: tcp-fastopen |
| Added: 7.49.0 |
| Help: Use TCP Fast Open |
| Category: connection |
| + | Example: --tcp-fastopen $URL |
| --- |
| Enable use of TCP Fast Open (RFC7413). |
docs/cmdline-opts/tcp-nodelay.d+1 -0
| @@ -2,6 +2,7 @@ Long: tcp-nodelay |
| Help: Use the TCP_NODELAY option |
| Added: 7.11.2 |
| Category: connection |
| + | Example: --tcp-nodelay $URL |
| --- |
| Turn on the TCP_NODELAY option. See the *curl_easy_setopt(3)* man page for |
| details about this option. |
docs/cmdline-opts/telnet-option.d+1 -0
| @@ -3,6 +3,7 @@ Short: t |
| Arg: <opt=val> |
| Help: Set telnet option |
| Category: telnet |
| + | Example: -t TTYPE=vt100 telnet://example.com/ |
| --- |
| Pass options to the telnet protocol. Supported options are: |
| |
docs/cmdline-opts/tftp-blksize.d+1 -0
| @@ -4,6 +4,7 @@ Help: Set TFTP BLKSIZE option |
| Protocols: TFTP |
| Added: 7.20.0 |
| Category: tftp |
| + | Example: --tftp-blksize 1024 tftp://example.com/file |
| --- |
| Set TFTP BLKSIZE option (must be >512). This is the block size that curl will |
| try to use when transferring data to or from a TFTP server. By default 512 |
docs/cmdline-opts/tftp-no-options.d+1 -0
| @@ -3,6 +3,7 @@ Help: Do not send any TFTP options |
| Protocols: TFTP |
| Added: 7.48.0 |
| Category: tftp |
| + | Example: --tftp-no-options tftp://192.168.0.1/ |
| --- |
| Tells curl not to send TFTP options requests. |
| |
docs/cmdline-opts/time-cond.d+3 -0
| @@ -4,6 +4,9 @@ Arg: <time> |
| Help: Transfer based on a time condition |
| Protocols: HTTP FTP |
| Category: http ftp |
| + | Example: -z "Wed 01 Sep 2021 12:18:00" $URL |
| + | Example: -z "-Wed 01 Sep 2021 12:18:00" $URL |
| + | Example: -z file $URL |
| --- |
| Request a file that has been modified later than the given time and date, or |
| one that has been modified before that time. The <date expression> can be all |
docs/cmdline-opts/tls-max.d+2 -0
| @@ -7,6 +7,8 @@ Requires: TLS |
| See-also: tlsv1.0 tlsv1.1 tlsv1.2 tlsv1.3 |
| Help: Set maximum allowed TLS version |
| Category: tls |
| + | Example: --tls-max 1.2 $URL |
| + | Example: --tls-max 1.3 --tlsv1.2 $URL |
| --- |
| VERSION defines maximum supported TLS version. The minimum acceptable version |
| is set by tlsv1.0, tlsv1.1, tlsv1.2 or tlsv1.3. |
docs/cmdline-opts/tls13-ciphers.d+1 -0
| @@ -3,6 +3,7 @@ Arg: <ciphersuite list> |
| help: TLS 1.3 cipher suites to use |
| Protocols: TLS |
| Category: tls |
| + | Example: --tls13-ciphers TLS_AES_128_GCM_SHA256 $URL |
| --- |
| Specifies which cipher suites to use in the connection if it negotiates TLS |
| 1.3. The list of ciphers suites must specify valid ciphers. Read up on TLS 1.3 |
docs/cmdline-opts/tlsauthtype.d+1 -0
| @@ -3,6 +3,7 @@ Arg: <type> |
| Help: TLS authentication type |
| Added: 7.21.4 |
| Category: tls auth |
| + | Example: --tlsauthtype SRP $URL |
| --- |
| Set TLS authentication type. Currently, the only supported option is "SRP", |
| for TLS-SRP (RFC 5054). If --tlsuser and --tlspassword are specified but |
docs/cmdline-opts/tlspassword.d+1 -0
| @@ -3,6 +3,7 @@ Arg: <string> |
| Help: TLS password |
| Added: 7.21.4 |
| Category: tls auth |
| + | Example: --tlspassword pwd --tlsuser user $URL |
| --- |
| Set password for use with the TLS authentication method specified with |
| --tlsauthtype. Requires that --tlsuser also be set. |
docs/cmdline-opts/tlsuser.d+1 -0
| @@ -3,6 +3,7 @@ Arg: <name> |
| Help: TLS user name |
| Added: 7.21.4 |
| Category: tls auth |
| + | Example: --tlspassword pwd --tlsuser user $URL |
| --- |
| Set username for use with the TLS authentication method specified with |
| --tlsauthtype. Requires that --tlspassword also is set. |
docs/cmdline-opts/tlsv1.0.d+1 -0
| @@ -3,6 +3,7 @@ Help: Use TLSv1.0 or greater |
| Protocols: TLS |
| Added: 7.34.0 |
| Category: tls |
| + | Example: --tlsv1.0 $URL |
| --- |
| Forces curl to use TLS version 1.0 or later when connecting to a remote TLS server. |
| |
docs/cmdline-opts/tlsv1.1.d+1 -0
| @@ -3,6 +3,7 @@ Help: Use TLSv1.1 or greater |
| Protocols: TLS |
| Added: 7.34.0 |
| Category: tls |
| + | Example: --tlsv1.1 $URL |
| --- |
| Forces curl to use TLS version 1.1 or later when connecting to a remote TLS server. |
| |
docs/cmdline-opts/tlsv1.2.d+1 -0
| @@ -3,6 +3,7 @@ Help: Use TLSv1.2 or greater |
| Protocols: TLS |
| Added: 7.34.0 |
| Category: tls |
| + | Example: --tlsv1.2 $URL |
| --- |
| Forces curl to use TLS version 1.2 or later when connecting to a remote TLS server. |
| |
docs/cmdline-opts/tlsv1.3.d+1 -0
| @@ -3,6 +3,7 @@ Help: Use TLSv1.3 or greater |
| Protocols: TLS |
| Added: 7.52.0 |
| Category: tls |
| + | Example: --tlsv1.3 $URL |
| --- |
| Forces curl to use TLS version 1.3 or later when connecting to a remote TLS |
| server. |
docs/cmdline-opts/tlsv1.d+1 -0
| @@ -8,6 +8,7 @@ Requires: TLS |
| See-also: http1.1 http2 |
| Help: Use TLSv1.0 or greater |
| Category: tls |
| + | Example: --tlsv1 $URL |
| --- |
| Tells curl to use at least TLS version 1.x when negotiating with a remote TLS |
| server. That means TLS version 1.0 or higher |
docs/cmdline-opts/tr-encoding.d+1 -0
| @@ -3,6 +3,7 @@ Added: 7.21.6 |
| Help: Request compressed transfer encoding |
| Protocols: HTTP |
| Category: http |
| + | Example: --tr-encoding $URL |
| --- |
| Request a compressed Transfer-Encoding response using one of the algorithms |
| curl supports, and uncompress the data while receiving it. |
docs/cmdline-opts/trace-ascii.d+1 -0
| @@ -3,6 +3,7 @@ Arg: <file> |
| Help: Like --trace, but without hex output |
| Mutexed: trace verbose |
| Category: verbose |
| + | Example: --trace-ascii log.txt $URL |
| --- |
| Enables a full trace dump of all incoming and outgoing data, including |
| descriptive information, to the given output file. Use "-" as filename to have |
docs/cmdline-opts/trace-time.d+1 -0
| @@ -2,6 +2,7 @@ Long: trace-time |
| Help: Add time stamps to trace/verbose output |
| Added: 7.14.0 |
| Category: verbose |
| + | Example: --trace-time --trace-ascii output $URL |
| --- |
| Prepends a time stamp to each trace or verbose line that curl displays. |
| |
docs/cmdline-opts/trace.d+1 -0
| @@ -3,6 +3,7 @@ Arg: <file> |
| Help: Write a debug trace to FILE |
| Mutexed: verbose trace-ascii |
| Category: verbose |
| + | Example: --trace log.txt $URL |
| --- |
| Enables a full trace dump of all incoming and outgoing data, including |
| descriptive information, to the given output file. Use "-" as filename to have |
docs/cmdline-opts/unix-socket.d+1 -0
| @@ -4,5 +4,6 @@ Help: Connect through this Unix domain socket |
| Added: 7.40.0 |
| Protocols: HTTP |
| Category: connection |
| + | Example: --unix-socket socket-path $URL |
| --- |
| Connect through this Unix domain socket, instead of using the network. |
docs/cmdline-opts/upload-file.d+7 -10
| @@ -3,6 +3,9 @@ Short: T |
| Arg: <file> |
| Help: Transfer local FILE to destination |
| Category: important upload |
| + | Example: -T file $URL |
| + | Example: -T "img[1-1000].png" ftp://ftp.example.com/ |
| + | Example: --upload-file "{file1,file2}" $URL |
| --- |
| This transfers the specified local file to the remote URL. If there is no file |
| part in the specified URL, curl will append the local file name. NOTE that you |
| @@ -12,21 +15,15 @@ file name to use. That will most likely cause the upload operation to fail. If |
| this is used on an HTTP(S) server, the PUT command will be used. |
| |
| Use the file name "-" (a single dash) to use stdin instead of a given file. |
| - | Alternately, the file name "." (a single period) may be specified instead |
| - | of "-" to use stdin in non-blocking mode to allow reading server output |
| - | while stdin is being uploaded. |
| + | Alternately, the file name "." (a single period) may be specified instead of |
| + | "-" to use stdin in non-blocking mode to allow reading server output while |
| + | stdin is being uploaded. |
| |
| You can specify one --upload-file for each URL on the command line. Each |
| --upload-file + URL pair specifies what to upload and to where. curl also |
| supports "globbing" of the --upload-file argument, meaning that you can upload |
| multiple files to a single URL by using the same URL globbing style supported |
| - | in the URL, like this: |
| - | |
| - | curl --upload-file "{file1,file2}" http://www.example.com |
| - | |
| - | or even |
| - | |
| - | curl -T "img[1-1000].png" ftp://ftp.example.com/upload/ |
| + | in the URL. |
| |
| When uploading to an SMTP server: the uploaded data is assumed to be RFC 5322 |
| formatted. It has to feature the necessary set of headers and mail body |
docs/cmdline-opts/url.d+3 -2
| @@ -2,6 +2,7 @@ Long: url |
| Arg: <url> |
| Help: URL to work with |
| Category: curl |
| + | Example: --url $URL |
| --- |
| Specify a URL to fetch. This option is mostly handy when you want to specify |
| URL(s) in a config file. |
| @@ -15,5 +16,5 @@ setting a default protocol, see --proto-default for details. |
| This option may be used any number of times. To control where this URL is |
| written, use the --output or the --remote-name options. |
| |
| - | Warning: On Windows, particular file:// accesses can be converted to network |
| - | accesses by the operating system. Beware! |
| + | **WARNING**: On Windows, particular file:// accesses can be converted to |
| + | network accesses by the operating system. Beware! |
docs/cmdline-opts/use-ascii.d+1 -0
| @@ -3,6 +3,7 @@ Long: use-ascii |
| Help: Use ASCII/text transfer |
| Protocols: FTP LDAP |
| Category: misc |
| + | Example: -B ftp://example.com/README |
| --- |
| Enable ASCII transfer. For FTP, this can also be enforced by using a URL that |
| ends with ";type=A". This option causes data sent to stdout to be in text mode |
docs/cmdline-opts/user-agent.d+1 -0
| @@ -4,6 +4,7 @@ Arg: <name> |
| Help: Send User-Agent <name> to server |
| Protocols: HTTP |
| Category: important http |
| + | Example: -A "Agent 007" $URL |
| --- |
| Specify the User-Agent string to send to the HTTP server. To encode blanks in |
| the string, surround the string with single quote marks. This header can also |
docs/cmdline-opts/user.d+1 -0
| @@ -3,6 +3,7 @@ Short: u |
| Arg: <user:password> |
| Help: Server user and password |
| Category: important auth |
| + | Example: -u user:secret $URL |
| --- |
| Specify the user name and password to use for server authentication. Overrides |
| --netrc and --netrc-optional. |
docs/cmdline-opts/verbose.d+1 -0
| @@ -4,6 +4,7 @@ Mutexed: trace trace-ascii |
| Help: Make the operation more talkative |
| See-also: include |
| Category: important verbose |
| + | Example: --verbose $URL |
| --- |
| Makes curl verbose during the operation. Useful for debugging and seeing |
| what's going on "under the hood". A line starting with '>' means "header data" |
docs/cmdline-opts/version.d+1 -0
| @@ -2,6 +2,7 @@ Long: version |
| Short: V |
| Help: Show version number and quit |
| Category: important curl |
| + | Example: --version |
| --- |
| Displays information about curl and the libcurl version it uses. |
| |
docs/cmdline-opts/write-out.d+1 -0
| @@ -3,6 +3,7 @@ Short: w |
| Arg: <format> |
| Help: Use output FORMAT after completion |
| Category: verbose |
| + | Example: -w '%{http_code}\\n' $URL |
| --- |
| Make curl display information on stdout after a completed transfer. The format |
| is a string that may contain plain text mixed with any number of |
docs/cmdline-opts/xattr.d+1 -0
| @@ -1,6 +1,7 @@ |
| Long: xattr |
| Help: Store metadata in extended file attributes |
| Category: misc |
| + | Example: --xattr -o storage $URL |
| --- |
| When saving output to a file, this option tells curl to store certain file |
| metadata in extended file attributes. Currently, the URL is stored in the |
src/tool_help.c+3 -3
| @@ -169,7 +169,7 @@ static const struct helptxt helptext[] = { |
| {"-K, --config <file>", |
| "Read config from a file", |
| CURLHELP_CURL}, |
| - | {" --connect-timeout <seconds>", |
| + | {" --connect-timeout <fractional seconds>", |
| "Maximum time allowed for connection", |
| CURLHELP_CONNECTION}, |
| {" --connect-to <HOST1:PORT1:HOST2:PORT2>", |
| @@ -194,7 +194,7 @@ static const struct helptxt helptext[] = { |
| "Convert LF to CRLF in upload", |
| CURLHELP_FTP | CURLHELP_SMTP}, |
| {" --crlfile <file>", |
| - | "Get a CRL list in PEM format from the given file", |
| + | "Use this CRL list", |
| CURLHELP_TLS}, |
| {" --curves <algorithm list>", |
| "(EC) TLS key exchange algorithm(s) to request", |
| @@ -442,7 +442,7 @@ static const struct helptxt helptext[] = { |
| {" --max-redirs <num>", |
| "Maximum number of redirects allowed", |
| CURLHELP_HTTP}, |
| - | {"-m, --max-time <seconds>", |
| + | {"-m, --max-time <fractional seconds>", |
| "Maximum time allowed for the transfer", |
| CURLHELP_CONNECTION}, |
| {" --metalink", |