curl.1: provide examples for each option

The file format for each option now features a "Example:" header that
can provide one or more examples that get rendered appropriately in the
output. All options MUST have at least one example or gen.pl complains
at build-time.

This fix also does a few other minor format and consistency cleanups.

Closes #7654
This commit is contained in:
Daniel Stenberg 2021-08-31 16:37:14 +02:00
parent c905459e87
commit 68784d73c3
No known key found for this signature in database
GPG Key ID: 5CC908FDB71E12C2
245 changed files with 348 additions and 53 deletions

View File

@ -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) Requires: (space separated list of features this requires, no dashes)
See-also: (space separated list of related options, no dashes) See-also: (space separated list of related options, no dashes)
Help: (short text for the --help output for this option) Help: (short text for the --help output for this option)
Example: (example command line, without "curl" and can use `$URL`)
--- (end of meta-data) --- (end of meta-data)
### Body ### Body

View File

@ -4,6 +4,7 @@ Help: Connect via abstract Unix domain socket
Added: 7.53.0 Added: 7.53.0
Protocols: HTTP Protocols: HTTP
Category: connection Category: connection
Example: --abstract-unix-socket socketpath $URL
--- ---
Connect through an abstract Unix domain socket, instead of using the network. Connect through an abstract Unix domain socket, instead of using the network.
Note: netstat shows the path of an abstract socket prefixed with '@', however Note: netstat shows the path of an abstract socket prefixed with '@', however

View File

@ -4,9 +4,8 @@ Protocols: HTTPS
Help: Enable alt-svc with this cache file Help: Enable alt-svc with this cache file
Added: 7.64.1 Added: 7.64.1
Category: http 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 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, 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. the cache will be saved to the file name again if it has been modified.

View File

@ -3,6 +3,7 @@ Help: Pick any authentication method
Protocols: HTTP Protocols: HTTP
See-also: proxy-anyauth basic digest See-also: proxy-anyauth basic digest
Category: http proxy auth Category: http proxy auth
Example: --anyauth --user me:pwd $URL
--- ---
Tells curl to figure out authentication method by itself, and use the most 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 secure one the remote site claims to support. This is done by first doing a

View File

@ -3,6 +3,7 @@ Long: append
Help: Append to target file when uploading Help: Append to target file when uploading
Protocols: FTP SFTP Protocols: FTP SFTP
Category: 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 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 overwriting it. If the remote file doesn't exist, it will be created. Note

View File

@ -3,6 +3,7 @@ Arg: <provider1[:provider2[:region[:service]]]>
Help: Use AWS V4 signature authentication Help: Use AWS V4 signature authentication
Category: auth http Category: auth http
Added: 7.75.0 Added: 7.75.0
Example: --aws-sigv4 "aws:amz:east-2:es" --user "key:secret" $URL
--- ---
Use AWS V4 signature authentication in the transfer. Use AWS V4 signature authentication in the transfer.

View File

@ -3,6 +3,7 @@ Help: Use HTTP Basic Authentication
See-also: proxy-basic See-also: proxy-basic
Protocols: HTTP Protocols: HTTP
Category: auth Category: auth
Example: -u name:password --basic $URL
--- ---
Tells curl to use HTTP Basic authentication with the remote host. This is the 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 default and this option is usually pointless, unless you use it to override a

View File

@ -3,6 +3,7 @@ Arg: <file>
Help: CA certificate to verify peer against Help: CA certificate to verify peer against
Protocols: TLS Protocols: TLS
Category: tls Category: tls
Example: --cacert CA-file.txt $URL
--- ---
Tells curl to use the specified certificate file to verify the peer. The file 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 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 certificates in the system and user Keychain to verify the peer, which is the
preferred method of verifying the peer's certificate chain. preferred method of verifying the peer's certificate chain.
(Schannel only) This option is supported for Schannel in Windows 7 or later with (Schannel only) This option is supported for Schannel in Windows 7 or later
libcurl 7.60 or later. This option is supported for backward compatibility with libcurl 7.60 or later. This option is supported for backward
with other SSL engines; instead it is recommended to use Windows' store of compatibility with other SSL engines; instead it is recommended to use
root certificates (the default for Schannel). Windows' store of root certificates (the default for Schannel).
If this option is used several times, the last one will be used. If this option is used several times, the last one will be used.

View File

@ -3,6 +3,7 @@ Arg: <dir>
Help: CA directory to verify peer against Help: CA directory to verify peer against
Protocols: TLS Protocols: TLS
Category: tls Category: tls
Example: --capath /local/directory $URL
--- ---
Tells curl to use the specified certificate directory to verify the Tells curl to use the specified certificate directory to verify the
peer. Multiple paths can be provided by separating them with ":" (e.g. peer. Multiple paths can be provided by separating them with ":" (e.g.

View File

@ -3,6 +3,7 @@ Protocols: TLS
Added: 7.41.0 Added: 7.41.0
Help: Verify the status of the server cert via OCSP-staple Help: Verify the status of the server cert via OCSP-staple
Category: tls Category: tls
Example: --cert-status $URL
--- ---
Tells curl to verify the status of the server certificate by using the Tells curl to verify the status of the server certificate by using the
Certificate Status Request (aka. OCSP stapling) TLS extension. Certificate Status Request (aka. OCSP stapling) TLS extension.

View File

@ -4,6 +4,7 @@ Arg: <type>
Help: Certificate type (DER/PEM/ENG) Help: Certificate type (DER/PEM/ENG)
See-also: cert key key-type See-also: cert key key-type
Category: tls Category: tls
Example: --cert-type PEM --cert file $URL
--- ---
Tells curl what type the provided client certificate is using. PEM, DER, ENG Tells curl what type the provided client certificate is using. PEM, DER, ENG
and P12 are recognized types. If not specified, PEM is assumed. and P12 are recognized types. If not specified, PEM is assumed.

View File

@ -5,6 +5,7 @@ Help: Client certificate file and password
Protocols: TLS Protocols: TLS
See-also: cert-type key key-type See-also: cert-type key key-type
Category: tls Category: tls
Example: --cert certfile --key keyfile $URL
--- ---
Tells curl to use the specified client certificate file when getting a file 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 with HTTPS, FTPS or another SSL-based protocol. The certificate must be in

View File

@ -3,6 +3,7 @@ Arg: <list of ciphers>
Help: SSL ciphers to use Help: SSL ciphers to use
Protocols: TLS Protocols: TLS
Category: tls Category: tls
Example: --ciphers ECDHE-ECDSA-AES256-CCM8 $URL
--- ---
Specifies which ciphers to use in the connection. The list of ciphers must 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: specify valid ciphers. Read up on SSL cipher list details on this URL:

View File

@ -3,6 +3,7 @@ Help: Enable SSH compression
Protocols: SCP SFTP Protocols: SCP SFTP
Added: 7.56.0 Added: 7.56.0
Category: scp ssh Category: scp ssh
Example: --compressed-ssh sftp://example.com/
--- ---
Enables built-in SSH compression. Enables built-in SSH compression.
This is a request, not an order; the server may or may not do it. This is a request, not an order; the server may or may not do it.

View File

@ -2,6 +2,7 @@ Long: compressed
Help: Request compressed response Help: Request compressed response
Protocols: HTTP Protocols: HTTP
Category: http Category: http
Example: --compressed $URL
--- ---
Request a compressed response using one of the algorithms curl supports, and Request a compressed response using one of the algorithms curl supports, and
automatically decompress the content. Headers are not modified. automatically decompress the content. Headers are not modified.

View File

@ -3,6 +3,7 @@ Arg: <file>
Help: Read config from a file Help: Read config from a file
Short: K Short: K
Category: curl Category: curl
Example: --config file.txt $URL
--- ---
Specify a text file to read curl arguments from. The command line arguments Specify a text file to read curl arguments from. The command line arguments

View File

@ -1,8 +1,10 @@
Long: connect-timeout Long: connect-timeout
Arg: <seconds> Arg: <fractional seconds>
Help: Maximum time allowed for connection Help: Maximum time allowed for connection
See-also: max-time See-also: max-time
Category: connection 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 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 limits the connection phase, so if curl connects within the given period it

View File

@ -4,6 +4,7 @@ Help: Connect to host
Added: 7.49.0 Added: 7.49.0
See-also: resolve header See-also: resolve header
Category: connection 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. For a request to the given HOST1:PORT1 pair, connect to HOST2:PORT2 instead.

View File

@ -4,6 +4,8 @@ Arg: <offset>
Help: Resumed transfer offset Help: Resumed transfer offset
See-also: range See-also: range
Category: connection Category: connection
Example: -C - $URL
Example: -C 400 $URL
--- ---
Continue/Resume a previous file transfer at the given offset. The given offset 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 is the exact number of bytes that will be skipped, counting from the beginning

View File

@ -4,6 +4,8 @@ Arg: <filename>
Protocols: HTTP Protocols: HTTP
Help: Write cookies to <filename> after operation Help: Write cookies to <filename> after operation
Category: http 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 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 operation. Curl writes all cookies from its in-memory cookie storage to the

View File

@ -4,6 +4,8 @@ Arg: <data|filename>
Protocols: HTTP Protocols: HTTP
Help: Send cookies from string/file Help: Send cookies from string/file
Category: http 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 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 the data previously received from the server in a "Set-Cookie:" line. The

View File

@ -1,6 +1,7 @@
Long: create-dirs Long: create-dirs
Help: Create necessary local directory hierarchy Help: Create necessary local directory hierarchy
Category: curl Category: curl
Example: --create-dirs --output local/dir/file $URL
--- ---
When used in conjunction with the --output option, curl will create the When used in conjunction with the --output option, curl will create the
necessary local directory hierarchy as needed. This option creates the necessary local directory hierarchy as needed. This option creates the

View File

@ -5,6 +5,7 @@ Protocols: SFTP SCP FILE
Category: sftp scp file upload Category: sftp scp file upload
See-also: ftp-create-dirs See-also: ftp-create-dirs
Added: 7.75.0 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 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 protocols, this option allows the user to set which 'mode' to set on the file

View File

@ -2,6 +2,7 @@ Long: crlf
Help: Convert LF to CRLF in upload Help: Convert LF to CRLF in upload
Protocols: FTP SMTP Protocols: FTP SMTP
Category: ftp smtp Category: ftp smtp
Example: --crlf -T file ftp://example.com/
--- ---
Convert LF to CRLF in upload. Useful for MVS (OS/390). Convert LF to CRLF in upload. Useful for MVS (OS/390).

View File

@ -1,9 +1,10 @@
Long: crlfile Long: crlfile
Arg: <file> Arg: <file>
Protocols: TLS Protocols: TLS
Help: Get a CRL list in PEM format from the given file Help: Use this CRL list
Added: 7.19.7 Added: 7.19.7
Category: tls Category: tls
Example: --crlfile rejects.txt $URL
--- ---
Provide a file using PEM format with a Certificate Revocation List that may Provide a file using PEM format with a Certificate Revocation List that may
specify peer certificates that are to be considered revoked. specify peer certificates that are to be considered revoked.

View File

@ -4,6 +4,7 @@ Help: (EC) TLS key exchange algorithm(s) to request
Protocols: TLS Protocols: TLS
Added: 7.73.0 Added: 7.73.0
Category: tls Category: tls
Example: --curves X25519 $URL
--- ---
Tells curl to request specific curves to use during SSL session establishment 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 according to RFC 8422, 5.1. Multiple algorithms can be provided by separating

View File

@ -3,5 +3,6 @@ Arg: <data>
Help: HTTP POST ASCII data Help: HTTP POST ASCII data
Protocols: HTTP Protocols: HTTP
Category: http post upload Category: http post upload
Example: --data-ascii @file $URL
--- ---
This is just an alias for --data. This is just an alias for --data.

View File

@ -3,6 +3,7 @@ Arg: <data>
Help: HTTP POST binary data Help: HTTP POST binary data
Protocols: HTTP Protocols: HTTP
Category: http post upload Category: http post upload
Example: --data-binary @filename $URL
--- ---
This posts data exactly as specified with no extra processing whatsoever. This posts data exactly as specified with no extra processing whatsoever.

View File

@ -5,6 +5,8 @@ Help: HTTP POST data, '@' allowed
Added: 7.43.0 Added: 7.43.0
See-also: data See-also: data
Category: http post upload 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 This posts data similarly to --data but without the special
interpretation of the @ character. interpretation of the @ character.

View File

@ -5,6 +5,10 @@ Protocols: HTTP
See-also: data data-raw See-also: data data-raw
Added: 7.18.0 Added: 7.18.0
Category: http post upload 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 This posts data, similar to the other --data options with the exception
that this performs URL-encoding. that this performs URL-encoding.

View File

@ -6,6 +6,9 @@ Protocols: HTTP MQTT
See-also: data-binary data-urlencode data-raw See-also: data-binary data-urlencode data-raw
Mutexed: form head upload-file Mutexed: form head upload-file
Category: important http post upload 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 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 that a browser does when a user has filled in an HTML form and presses the

View File

@ -3,6 +3,7 @@ Arg: <LEVEL>
Help: GSS-API delegation permission Help: GSS-API delegation permission
Protocols: GSS/kerberos Protocols: GSS/kerberos
Category: auth Category: auth
Example: --delegation "none" $URL
--- ---
Set LEVEL to tell the server what it is allowed to delegate when it Set LEVEL to tell the server what it is allowed to delegate when it
comes to user credentials. comes to user credentials.

View File

@ -4,6 +4,7 @@ Protocols: HTTP
Mutexed: basic ntlm negotiate Mutexed: basic ntlm negotiate
See-also: user proxy-digest anyauth See-also: user proxy-digest anyauth
Category: proxy auth http Category: proxy auth http
Example: -u name:password --digest $URL
--- ---
Enables HTTP Digest authentication. This is an authentication scheme that 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 prevents the password from being sent over the wire in clear text. Use this in

View File

@ -2,6 +2,7 @@ Long: disable-eprt
Help: Inhibit using EPRT or LPRT Help: Inhibit using EPRT or LPRT
Protocols: FTP Protocols: FTP
Category: ftp Category: ftp
Example: --disable-eprt ftp://example.com/
--- ---
Tell curl to disable the use of the EPRT and LPRT commands when doing active 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 FTP transfers. Curl will normally always first attempt to use EPRT, then LPRT

View File

@ -2,6 +2,7 @@ Long: disable-epsv
Help: Inhibit using EPSV Help: Inhibit using EPSV
Protocols: FTP Protocols: FTP
Category: ftp Category: ftp
Example: --disable-epsv ftp://example.com/
--- ---
Tell curl to disable the use of the EPSV command when doing passive FTP 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 transfers. Curl will normally always first attempt to use EPSV before

View File

@ -2,6 +2,7 @@ Long: disable
Short: q Short: q
Help: Disable .curlrc Help: Disable .curlrc
Category: curl Category: curl
Example: -q $URL
--- ---
If used as the first parameter on the command line, the *curlrc* config 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 file will not be read and used. See the --config for details on the default

View File

@ -4,5 +4,7 @@ Protocols: HTTP
Added: 7.61.0 Added: 7.61.0
See-also: proto See-also: proto
Category: curl http 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.

View File

@ -6,6 +6,7 @@ See-also: dns-ipv4-addr dns-ipv6-addr
Added: 7.33.0 Added: 7.33.0
Requires: c-ares Requires: c-ares
Category: dns Category: dns
Example: --dns-interface eth0 $URL
--- ---
Tell curl to send outgoing DNS requests through <interface>. This option is a Tell curl to send outgoing DNS requests through <interface>. This option is a
counterpart to --interface (which does not affect DNS). The supplied string counterpart to --interface (which does not affect DNS). The supplied string

View File

@ -6,6 +6,7 @@ See-also: dns-interface dns-ipv6-addr
Added: 7.33.0 Added: 7.33.0
Requires: c-ares Requires: c-ares
Category: dns 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 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 the DNS requests originate from this address. The argument should be a

View File

@ -6,6 +6,7 @@ See-also: dns-interface dns-ipv4-addr
Added: 7.33.0 Added: 7.33.0
Requires: c-ares Requires: c-ares
Category: dns Category: dns
Example: --dns-ipv6-addr 2a04:4e42::561 $URL
--- ---
Tell curl to bind to <ip-address> when making IPv6 DNS requests, so that 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 the DNS requests originate from this address. The argument should be a

View File

@ -4,6 +4,7 @@ Help: DNS server addrs to use
Requires: c-ares Requires: c-ares
Added: 7.33.0 Added: 7.33.0
Category: dns 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. 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 The list of IP addresses should be separated with commas. Port numbers

View File

@ -3,5 +3,6 @@ Help: Verify the status of the DoH server cert via OCSP-staple
Protocols: all Protocols: all
Added: 7.76.0 Added: 7.76.0
Category: dns tls Category: dns tls
Example: --doh-cert-status --doh-url https://doh.example $URL
--- ---
Same as --cert-status but used for DoH (DNS-over-HTTPS). Same as --cert-status but used for DoH (DNS-over-HTTPS).

View File

@ -3,5 +3,6 @@ Help: Allow insecure DoH server connections
Protocols: all Protocols: all
Added: 7.76.0 Added: 7.76.0
Category: dns tls Category: dns tls
Example: --doh-insecure --doh-url https://doh.example $URL
--- ---
Same as --insecure but used for DoH (DNS-over-HTTPS). Same as --insecure but used for DoH (DNS-over-HTTPS).

View File

@ -4,6 +4,7 @@ Help: Resolve host names over DoH
Protocols: all Protocols: all
Added: 7.62.0 Added: 7.62.0
Category: dns Category: dns
Example: --doh-url https://doh.example $URL
--- ---
Specifies which DNS-over-HTTPS (DoH) server to use to resolve hostnames, 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. instead of using the default name resolver mechanism. The URL must be HTTPS.

View File

@ -5,6 +5,7 @@ Help: Write the received headers to <filename>
Protocols: HTTP FTP Protocols: HTTP FTP
See-also: output See-also: output
Category: http ftp Category: http ftp
Example: --dump-header store.txt $URL
--- ---
Write the received protocol headers to the specified file. If no headers are Write the received protocol headers to the specified file. If no headers are
received, the use of this option will create an empty file. received, the use of this option will create an empty file.

View File

@ -4,6 +4,7 @@ Help: EGD socket path for random data
Protocols: TLS Protocols: TLS
See-also: random-file See-also: random-file
Category: tls Category: tls
Example: --egd-file /random/here $URL
--- ---
Specify the path name to the Entropy Gathering Daemon socket. The socket is Specify the path name to the Entropy Gathering Daemon socket. The socket is
used to seed the random engine for SSL connections. used to seed the random engine for SSL connections.

View File

@ -3,6 +3,7 @@ Arg: <name>
Help: Crypto engine to use Help: Crypto engine to use
Protocols: TLS Protocols: TLS
Category: tls Category: tls
Example: --engine flavor $URL
--- ---
Select the OpenSSL crypto engine to use for cipher operations. Use --engine 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 list to print a list of build-time supported engines. Note that not all (and

View File

@ -4,6 +4,7 @@ Help: Pass an ETag from a file as a custom header
Protocols: HTTP Protocols: HTTP
Added: 7.68.0 Added: 7.68.0
Category: http Category: http
Example: --etag-compare etag.txt $URL
--- ---
This option makes a conditional HTTP request for the specific ETag read 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 from the given file by sending a custom If-None-Match header using the

View File

@ -4,6 +4,7 @@ Help: Parse ETag from a request and save it to a file
Protocols: HTTP Protocols: HTTP
Added: 7.68.0 Added: 7.68.0
Category: http Category: http
Example: --etag-save storetag.txt $URL
--- ---
This option saves an HTTP ETag to the specified file. An ETag is a This option saves an HTTP ETag to the specified file. An ETag is a
caching related header, usually returned in a response. caching related header, usually returned in a response.

View File

@ -5,6 +5,7 @@ Protocols: HTTP
Added: 7.47.0 Added: 7.47.0
See-also: connect-timeout See-also: connect-timeout
Category: http Category: http
Example: --expect100-timeout 2.5 -T file $URL
--- ---
Maximum time in seconds that you allow curl to wait for a 100-continue 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 response when curl emits an Expects: 100-continue header in its request. By

View File

@ -2,6 +2,7 @@ Long: fail-early
Help: Fail on first transfer error, do not continue Help: Fail on first transfer error, do not continue
Added: 7.52.0 Added: 7.52.0
Category: curl Category: curl
Example: --fail-early $URL https://two.example
--- ---
Fail and exit on the first detected transfer error. Fail and exit on the first detected transfer error.

View File

@ -4,6 +4,7 @@ Help: Fail on HTTP errors but save the body
Category: http output Category: http output
Added: 7.76.0 Added: 7.76.0
See-also: fail See-also: fail
Example: --fail-with-body $URL
--- ---
Return an error on server errors where the HTTP response code is 400 or 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 greater). In normal cases when an HTTP server fails to deliver a document, it

View File

@ -4,6 +4,7 @@ Protocols: HTTP
Help: Fail silently (no output at all) on HTTP errors Help: Fail silently (no output at all) on HTTP errors
See-also: fail-with-body See-also: fail-with-body
Category: important http Category: important http
Example: --fail $URL
--- ---
Fail silently (no output at all) on server errors. This is mostly done to 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 enable scripts etc to better deal with failed attempts. In normal cases

View File

@ -3,6 +3,7 @@ Help: Enable TLS False Start
Protocols: TLS Protocols: TLS
Added: 7.42.0 Added: 7.42.0
Category: tls Category: tls
Example: --false-start $URL
--- ---
Tells curl to use false start during the TLS handshake. False start is a mode 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 where a TLS client will start sending application data before verifying the

View File

@ -4,6 +4,7 @@ Protocols: HTTP SMTP IMAP
Arg: <name=string> Arg: <name=string>
See-also: form See-also: form
Category: http upload Category: http upload
Example: --form-string "data" $URL
--- ---
Similar to --form except that the value string for the named parameter is used Similar to --form except that the value string for the named parameter is used
literally. Leading \&'@' and \&'<' characters, and the \&';type=' string in literally. Leading \&'@' and \&'<' characters, and the \&';type=' string in

View File

@ -5,6 +5,7 @@ Help: Specify multipart MIME data
Protocols: HTTP SMTP IMAP Protocols: HTTP SMTP IMAP
Mutexed: data head upload-file Mutexed: data head upload-file
Category: http upload 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 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 user has pressed the submit button. This causes curl to POST data using the

View File

@ -4,6 +4,7 @@ Help: Account data string
Protocols: FTP Protocols: FTP
Added: 7.13.0 Added: 7.13.0
Category: ftp auth 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 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. been provided, this data is sent off using the ACCT command.

View File

@ -4,6 +4,7 @@ Help: String to replace USER [name]
Protocols: FTP Protocols: FTP
Added: 7.15.5 Added: 7.15.5
Category: ftp Category: ftp
Example: --ftp-alternative-to-user "U53r" ftp://example.com
--- ---
If authenticating with the USER and PASS commands fails, send this command. If authenticating with the USER and PASS commands fails, send this command.
When connecting to Tumbleweed's Secure Transport server over FTPS using a When connecting to Tumbleweed's Secure Transport server over FTPS using a

View File

@ -3,6 +3,7 @@ Protocols: FTP SFTP
Help: Create the remote dirs if not present Help: Create the remote dirs if not present
See-also: create-dirs See-also: create-dirs
Category: ftp sftp curl 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 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 the server, the standard behavior of curl is to fail. Using this option, curl

View File

@ -4,6 +4,9 @@ Help: Control CWD usage
Protocols: FTP Protocols: FTP
Added: 7.15.1 Added: 7.15.1
Category: ftp 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) 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: server. The method argument should be one of the following alternatives:

View File

@ -4,6 +4,7 @@ Protocols: FTP
Added: 7.11.0 Added: 7.11.0
See-also: disable-epsv See-also: disable-epsv
Category: ftp Category: ftp
Example: --ftp-pasv ftp://example.com/
--- ---
Use passive mode for the data connection. Passive is the internal default 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 behavior, but using this option can be used to override a previous --ftp-port

View File

@ -5,6 +5,9 @@ Short: P
Protocols: FTP Protocols: FTP
See-also: ftp-pasv disable-eprt See-also: ftp-pasv disable-eprt
Category: ftp 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 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 option makes curl use active mode. curl then tells the server to connect back

View File

@ -3,6 +3,7 @@ Help: Send PRET before PASV
Protocols: FTP Protocols: FTP
Added: 7.20.0 Added: 7.20.0
Category: ftp Category: ftp
Example: --ftp-pret ftp://example.com/
--- ---
Tell curl to send a PRET command before PASV (and EPSV). Certain FTP servers, 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 mainly drftpd, require this non-standard command for directory listings as

View File

@ -4,6 +4,7 @@ Protocols: FTP
Added: 7.14.2 Added: 7.14.2
See-also: ftp-pasv See-also: ftp-pasv
Category: ftp Category: ftp
Example: --ftp-skip-pasv-ip ftp://example.com/
--- ---
Tell curl to not use the IP address the server suggests in its response 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 to curl's PASV command when curl connects the data connection. Instead curl

View File

@ -5,6 +5,7 @@ Protocols: FTP
Added: 7.16.2 Added: 7.16.2
See-also: ftp-ssl-ccc See-also: ftp-ssl-ccc
Category: ftp tls 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 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 instead wait for the server to do it, and will not reply to the shutdown from

View File

@ -4,6 +4,7 @@ Protocols: FTP
See-also: ssl ftp-ssl-ccc-mode See-also: ssl ftp-ssl-ccc-mode
Added: 7.16.1 Added: 7.16.1
Category: ftp tls Category: ftp tls
Example: --ftp-ssl-ccc ftps://example.com/
--- ---
Use CCC (Clear Command Channel) Shuts down the SSL/TLS layer after Use CCC (Clear Command Channel) Shuts down the SSL/TLS layer after
authenticating. The rest of the control channel communication will be authenticating. The rest of the control channel communication will be

View File

@ -3,6 +3,7 @@ Help: Require SSL/TLS for FTP login, clear for transfer
Protocols: FTP Protocols: FTP
Added: 7.16.0 Added: 7.16.0
Category: ftp tls Category: ftp tls
Example: --ftp-ssl-control ftp://example.com
--- ---
Require SSL/TLS for the FTP login, clear for transfer. Allows secure Require SSL/TLS for the FTP login, clear for transfer. Allows secure
authentication, but non-encrypted data transfers for efficiency. Fails the authentication, but non-encrypted data transfers for efficiency. Fails the

View File

@ -138,8 +138,11 @@ sub single {
my $requires; my $requires;
my $category; my $category;
my $seealso; my $seealso;
my @examples; # there can be more than one
my $magic; # cmdline special option my $magic; # cmdline special option
my $line;
while(<F>) { while(<F>) {
$line++;
if(/^Short: *(.)/i) { if(/^Short: *(.)/i) {
$short=$1; $short=$1;
} }
@ -173,6 +176,9 @@ sub single {
elsif(/^Category: *(.*)/i) { elsif(/^Category: *(.*)/i) {
$category=$1; $category=$1;
} }
elsif(/^Example: *(.*)/i) {
push @examples, $1;
}
elsif(/^Help: *(.*)/i) { elsif(/^Help: *(.*)/i) {
; ;
} }
@ -185,6 +191,10 @@ sub single {
print STDERR "ERROR: no 'Category:' in $f\n"; print STDERR "ERROR: no 'Category:' in $f\n";
exit 2; exit 2;
} }
if(!$examples[0]) {
print STDERR "$f:$line:1:ERROR: no 'Example:' present\n";
exit 2;
}
last; last;
} }
else { else {
@ -276,6 +286,16 @@ sub single {
} }
push @foot, overrides($standalone, "This option overrides $mstr. "); 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) { if($added) {
push @foot, added($standalone, $added); push @foot, added($standalone, $added);
} }

View File

@ -2,6 +2,7 @@ Long: get
Short: G Short: G
Help: Put the post data in the URL and use GET Help: Put the post data in the URL and use GET
Category: http upload Category: http upload
Example: --get $URL
--- ---
When used, this option will make all data specified with --data, --data-binary 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 or --data-urlencode to be used in an HTTP GET request instead of the POST

View File

@ -2,6 +2,7 @@ Long: globoff
Short: g Short: g
Help: Disable URL sequences and ranges using {} and [] Help: Disable URL sequences and ranges using {} and []
Category: curl Category: curl
Example: -g "https://example.com/{[]}}}}"
--- ---
This option switches off the "URL globbing parser". When you set this option, 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 you can specify URLs that contain the letters {}[] without having curl itself

View File

@ -3,6 +3,7 @@ Arg: <milliseconds>
Help: Time for IPv6 before trying IPv4 Help: Time for IPv6 before trying IPv4
Added: 7.59.0 Added: 7.59.0
Category: connection Category: connection
Example: --happy-eyeballs-timeout-ms 500 $URL
--- ---
Happy Eyeballs is an algorithm that attempts to connect to both IPv4 and IPv6 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 addresses for dual-stack hosts, giving IPv6 a head-start of the specified

View File

@ -3,10 +3,11 @@ Help: Send HAProxy PROXY protocol v1 header
Protocols: HTTP Protocols: HTTP
Added: 7.60.0 Added: 7.60.0
Category: http proxy Category: http proxy
Example: --haproxy-protocol $URL
--- ---
Send a HAProxy PROXY protocol v1 header at the beginning of the connection. This Send a HAProxy PROXY protocol v1 header at the beginning of the
is used by some load balancers and reverse proxies to indicate the client's connection. This is used by some load balancers and reverse proxies to
true IP address and port. indicate the client's true IP address and port.
This option is primarily useful when sending test requests to a service that This option is primarily useful when sending test requests to a service that
expects this header. expects this header.

View File

@ -3,6 +3,7 @@ Short: I
Help: Show document info only Help: Show document info only
Protocols: HTTP FTP FILE Protocols: HTTP FTP FILE
Category: http ftp file Category: http ftp file
Example: -I $URL
--- ---
Fetch the headers only! HTTP-servers feature the command HEAD which this uses 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, to get nothing but the header of a document. When used on an FTP or FILE file,

View File

@ -5,6 +5,9 @@ Help: Pass custom header(s) to server
Protocols: HTTP Protocols: HTTP
Category: http Category: http
See-also: user-agent referer 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 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 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 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. 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 **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 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 the header being sent to other hosts than the original host, so sensitive

View File

@ -3,6 +3,7 @@ Arg: <category>
Short: h Short: h
Help: Get help for commands Help: Get help for commands
Category: important curl Category: important curl
Example: --help all
--- ---
Usage help. This lists all commands of the <category>. Usage help. This lists all commands of the <category>.
If no arg was provided, curl will display the most important If no arg was provided, curl will display the most important

View File

@ -4,6 +4,7 @@ Help: Acceptable MD5 hash of the host public key
Protocols: SFTP SCP Protocols: SFTP SCP
Added: 7.17.1 Added: 7.17.1
Category: sftp scp Category: sftp scp
Example: --hostpubmd5 e5c1c49020640a5ab0f2034854c321a8 sftp://example.com/
--- ---
Pass a string containing 32 hexadecimal digits. The string should 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 be the 128 bit MD5 checksum of the remote host's public key, curl will refuse

View File

@ -4,9 +4,8 @@ Protocols: HTTPS
Help: Enable HSTS with this cache file Help: Enable HSTS with this cache file
Added: 7.74.0 Added: 7.74.0
Category: http 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 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 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. cache will be saved to the file name again if it has been modified.

View File

@ -4,6 +4,7 @@ Protocols: HTTP
Added: Added:
Help: Allow HTTP 0.9 responses Help: Allow HTTP 0.9 responses
Category: http Category: http
Example: --http0.9 $URL
--- ---
Tells curl to be fine with HTTP version 0.9 response. Tells curl to be fine with HTTP version 0.9 response.

View File

@ -6,6 +6,7 @@ Added:
Mutexed: http1.1 http2 Mutexed: http1.1 http2
Help: Use HTTP 1.0 Help: Use HTTP 1.0
Category: http Category: http
Example: --http1.0 $URL
--- ---
Tells curl to use HTTP version 1.0 instead of using its internally preferred Tells curl to use HTTP version 1.0 instead of using its internally preferred
HTTP version. HTTP version.

View File

@ -5,5 +5,6 @@ Added: 7.33.0
Mutexed: http1.0 http2 Mutexed: http1.0 http2
Help: Use HTTP 1.1 Help: Use HTTP 1.1
Category: http Category: http
Example: --http1.1 $URL
--- ---
Tells curl to use HTTP version 1.1. Tells curl to use HTTP version 1.1.

View File

@ -6,6 +6,7 @@ Mutexed: http1.1 http1.0 http2
Requires: HTTP/2 Requires: HTTP/2
Help: Use HTTP 2 without HTTP/1.1 Upgrade Help: Use HTTP 2 without HTTP/1.1 Upgrade
Category: http Category: http
Example: --http2-prior-knowledge $URL
--- ---
Tells curl to issue its non-TLS HTTP requests using HTTP/2 without HTTP/1.1 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 Upgrade. It requires prior knowledge that the server supports HTTP/2 straight

View File

@ -8,5 +8,12 @@ See-also: no-alpn
Help: Use HTTP 2 Help: Use HTTP 2
See-also: http1.1 http3 See-also: http1.1 http3
Category: http Category: http
Example: --http2 $URL
--- ---
Tells curl to use HTTP version 2. 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.

View File

@ -7,8 +7,9 @@ Requires: HTTP/3
Help: Use HTTP v3 Help: Use HTTP v3
See-also: http1.1 http2 See-also: http1.1 http2
Category: http 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 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 the URL. A normal HTTP/3 transaction will be done to a host and then get

View File

@ -2,6 +2,7 @@ Long: ignore-content-length
Help: Ignore the size of the remote resource Help: Ignore the size of the remote resource
Protocols: FTP HTTP Protocols: FTP HTTP
Category: http ftp Category: http ftp
Example: --ignore-content-length $URL
--- ---
For HTTP, Ignore the Content-Length header. This is particularly useful for For HTTP, Ignore the Content-Length header. This is particularly useful for
servers running Apache 1.x, which will report incorrect Content-Length for servers running Apache 1.x, which will report incorrect Content-Length for

View File

@ -3,6 +3,7 @@ Short: i
Help: Include protocol response headers in the output Help: Include protocol response headers in the output
See-also: verbose See-also: verbose
Category: important verbose Category: important verbose
Example: -i $URL
--- ---
Include the HTTP response headers in the output. The HTTP response headers can 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 include things like server name, cookies, date of the document, HTTP version

View File

@ -4,6 +4,7 @@ Help: Allow insecure server connections when using SSL
Protocols: TLS Protocols: TLS
See-also: proxy-insecure cacert See-also: proxy-insecure cacert
Category: tls Category: tls
Example: --insecure $URL
--- ---
By default, every SSL connection curl makes is verified to be secure. This By default, every SSL connection curl makes is verified to be secure. This
option allows curl to proceed and operate even for server connections 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: See this online resource for further details:
https://curl.se/docs/sslcerts.html https://curl.se/docs/sslcerts.html
**WARNING**: this makes the transfer insecure.

View File

@ -3,6 +3,7 @@ Arg: <name>
Help: Use network INTERFACE (or address) Help: Use network INTERFACE (or address)
See-also: dns-interface See-also: dns-interface
Category: connection Category: connection
Example: --interface eth0 $URL
--- ---
Perform an operation using a specified interface. You can enter interface Perform an operation using a specified interface. You can enter interface

View File

@ -8,6 +8,7 @@ Requires:
See-also: http1.1 http2 See-also: http1.1 http2
Help: Resolve names to IPv4 addresses Help: Resolve names to IPv4 addresses
Category: connection dns Category: connection dns
Example: --ipv4 $URL
--- ---
This option tells curl to resolve names to IPv4 addresses only, and not for This option tells curl to resolve names to IPv4 addresses only, and not for
example try IPv6. example try IPv6.

View File

@ -8,6 +8,7 @@ Requires:
See-also: http1.1 http2 See-also: http1.1 http2
Help: Resolve names to IPv6 addresses Help: Resolve names to IPv6 addresses
Category: connection dns Category: connection dns
Example: --ipv6 $URL
--- ---
This option tells curl to resolve names to IPv6 addresses only, and not for This option tells curl to resolve names to IPv6 addresses only, and not for
example try IPv4. example try IPv4.

View File

@ -4,6 +4,7 @@ Help: Ignore session cookies read from file
Protocols: HTTP Protocols: HTTP
See-also: cookie cookie-jar See-also: cookie cookie-jar
Category: http 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 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 discard all "session cookies". This will basically have the same effect as if

View File

@ -3,6 +3,7 @@ Arg: <seconds>
Help: Interval time for keepalive probes Help: Interval time for keepalive probes
Added: 7.18.0 Added: 7.18.0
Category: connection Category: connection
Example: --keepalive-time 20 $URL
--- ---
This option sets the time a connection needs to remain idle before sending This option sets the time a connection needs to remain idle before sending
keepalive probes and the time between individual keepalive probes. It is keepalive probes and the time between individual keepalive probes. It is

View File

@ -3,6 +3,7 @@ Arg: <type>
Help: Private key file type (DER/PEM/ENG) Help: Private key file type (DER/PEM/ENG)
Protocols: TLS Protocols: TLS
Category: tls Category: tls
Example: --key-type DER --key here $URL
--- ---
Private key file type. Specify which type your --key provided private key 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. is. DER, PEM, and ENG are supported. If not specified, PEM is assumed.

View File

@ -3,6 +3,7 @@ Arg: <key>
Protocols: TLS SSH Protocols: TLS SSH
Help: Private key file name Help: Private key file name
Category: tls ssh Category: tls ssh
Example: --cert certificate --key here $URL
--- ---
Private key file name. Allows you to provide your private key in this separate 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: file. For SSH, if not specified, curl tries the following candidates in order:

View File

@ -4,6 +4,7 @@ Help: Enable Kerberos with security <level>
Protocols: FTP Protocols: FTP
Requires: Kerberos Requires: Kerberos
Category: ftp Category: ftp
Example: --krb clear ftp://example.com/
--- ---
Enable Kerberos authentication and use. The level must be entered and should Enable Kerberos authentication and use. The level must be entered and should
be one of 'clear', 'safe', 'confidential', or 'private'. Should you use a be one of 'clear', 'safe', 'confidential', or 'private'. Should you use a

View File

@ -3,6 +3,7 @@ Arg: <file>
Help: Dump libcurl equivalent code of this command line Help: Dump libcurl equivalent code of this command line
Added: 7.16.1 Added: 7.16.1
Category: curl Category: curl
Example: --libcurl client.c $URL
--- ---
Append this option to any ordinary curl command line, and you will get 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 libcurl-using C source code written to the file that does the equivalent

View File

@ -2,6 +2,9 @@ Long: limit-rate
Arg: <speed> Arg: <speed>
Help: Limit transfer speed to RATE Help: Limit transfer speed to RATE
Category: connection 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 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 and uploads. This feature is useful if you have a limited pipe and you'd like

View File

@ -4,6 +4,7 @@ Protocols: FTP POP3
Help: List only mode Help: List only mode
Added: 4.0 Added: 4.0
Category: ftp pop3 Category: ftp pop3
Example: --list-only ftp://example.com/dir/
--- ---
(FTP) (FTP)
When listing an FTP directory, this switch forces a name-only view. This is When listing an FTP directory, this switch forces a name-only view. This is

View File

@ -3,6 +3,7 @@ Arg: <num/range>
Help: Force use of RANGE for local port numbers Help: Force use of RANGE for local port numbers
Added: 7.15.2 Added: 7.15.2
Category: connection Category: connection
Example: --local-port 1000-3000 $URL
--- ---
Set a preferred single number or range (FROM-TO) of local port numbers to use 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 for the connection(s). Note that port numbers by nature are a scarce resource

View File

@ -3,6 +3,7 @@ Help: Like --location, and send auth to other hosts
Protocols: HTTP Protocols: HTTP
See-also: user See-also: user
Category: http auth Category: http auth
Example: --location-trusted -u user:password $URL
--- ---
Like --location, but will allow sending the name + password to all hosts that 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 the site may redirect to. This may or may not introduce a security breach if

View File

@ -3,6 +3,7 @@ Short: L
Help: Follow redirects Help: Follow redirects
Protocols: HTTP Protocols: HTTP
Category: http Category: http
Example: -L $URL
--- ---
If the server reports that the requested page has moved to a different 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 location (indicated with a Location: header and a 3XX response code), this

Some files were not shown because too many files have changed in this diff Show More