aboutsummaryrefslogtreecommitdiffstats
path: root/docs/cmdline-opts
diff options
context:
space:
mode:
authorTreehugger Robot <treehugger-gerrit@google.com>2020-07-14 15:51:44 +0000
committerAutomerger Merge Worker <android-build-automerger-merge-worker@system.gserviceaccount.com>2020-07-14 15:51:44 +0000
commit9aa1a64cabedcc41f8be6608e0ee872b56c454a3 (patch)
tree2c3eab943845aec3b36d6ea0e33ce0f5cc412033 /docs/cmdline-opts
parent0c66739b05f29c81b6a0a6814929e1e6a51c6995 (diff)
parentd82935bad8787715114b546d997bc3e494fb63cc (diff)
downloadexternal_curl-9aa1a64cabedcc41f8be6608e0ee872b56c454a3.tar.gz
external_curl-9aa1a64cabedcc41f8be6608e0ee872b56c454a3.tar.bz2
external_curl-9aa1a64cabedcc41f8be6608e0ee872b56c454a3.zip
Merge "Upgrade curl to curl-7_71_1" am: 23abcba889 am: d82935bad8
Original change: https://android-review.googlesource.com/c/platform/external/curl/+/1360986 Change-Id: If39a57f7925d048081295b1d981399e38ac55e22
Diffstat (limited to 'docs/cmdline-opts')
-rw-r--r--docs/cmdline-opts/Makefile.inc1
-rw-r--r--docs/cmdline-opts/cert-type.d2
-rw-r--r--docs/cmdline-opts/happy-eyeballs-timeout-ms.d2
-rw-r--r--docs/cmdline-opts/list-only.d2
-rw-r--r--docs/cmdline-opts/page-footer18
-rw-r--r--docs/cmdline-opts/page-header19
-rw-r--r--docs/cmdline-opts/resolve.d2
-rw-r--r--docs/cmdline-opts/retry-all-errors.d19
-rw-r--r--docs/cmdline-opts/sasl-authzid.d3
-rw-r--r--docs/cmdline-opts/ssl-revoke-best-effort.d2
-rw-r--r--docs/cmdline-opts/tls13-ciphers.d2
-rw-r--r--docs/cmdline-opts/user-agent.d4
-rw-r--r--docs/cmdline-opts/version.d64
-rw-r--r--docs/cmdline-opts/write-out.d4
14 files changed, 99 insertions, 45 deletions
diff --git a/docs/cmdline-opts/Makefile.inc b/docs/cmdline-opts/Makefile.inc
index 5b7439e4..6a7b953b 100644
--- a/docs/cmdline-opts/Makefile.inc
+++ b/docs/cmdline-opts/Makefile.inc
@@ -180,6 +180,7 @@ DPAGES = \
request-target.d \
request.d \
resolve.d \
+ retry-all-errors.d \
retry-connrefused.d \
retry-delay.d \
retry-max-time.d \
diff --git a/docs/cmdline-opts/cert-type.d b/docs/cmdline-opts/cert-type.d
index 55d8033b..1232ec10 100644
--- a/docs/cmdline-opts/cert-type.d
+++ b/docs/cmdline-opts/cert-type.d
@@ -1,7 +1,7 @@
Long: cert-type
Protocols: TLS
Arg: <type>
-Help: Certificate file type
+Help: Certificate type (DER/PEM/ENG)
See-also: cert key key-type
---
Tells curl what type the provided client certificate is using. PEM, DER, ENG
diff --git a/docs/cmdline-opts/happy-eyeballs-timeout-ms.d b/docs/cmdline-opts/happy-eyeballs-timeout-ms.d
index ec9a8c22..611a8f1d 100644
--- a/docs/cmdline-opts/happy-eyeballs-timeout-ms.d
+++ b/docs/cmdline-opts/happy-eyeballs-timeout-ms.d
@@ -1,6 +1,6 @@
Long: happy-eyeballs-timeout-ms
Arg: <milliseconds>
-Help: How long to wait in milliseconds for IPv6 before trying IPv4
+Help: Time for IPv6 before trying IPv4
Added: 7.59.0
---
Happy eyeballs is an algorithm that attempts to connect to both IPv4 and IPv6
diff --git a/docs/cmdline-opts/list-only.d b/docs/cmdline-opts/list-only.d
index 4c56304a..63b2851f 100644
--- a/docs/cmdline-opts/list-only.d
+++ b/docs/cmdline-opts/list-only.d
@@ -2,7 +2,7 @@ Long: list-only
Short: l
Protocols: FTP POP3
Help: List only mode
-Added: 7.21.5
+Added: 4.0
---
(FTP)
When listing an FTP directory, this switch forces a name-only view. This is
diff --git a/docs/cmdline-opts/page-footer b/docs/cmdline-opts/page-footer
index defe7e8b..e76e7d25 100644
--- a/docs/cmdline-opts/page-footer
+++ b/docs/cmdline-opts/page-footer
@@ -36,7 +36,23 @@ accesses the target URL through the proxy.
The list of host names can also be include numerical IP addresses, and IPv6
versions should then be given without enclosing brackets.
-
+.IP "CURL_SSL_BACKEND <TLS backend>"
+If curl was built with support for "MultiSSL", meaning that it has built-in
+support for more than one TLS backend, this environment variable can be set to
+the case insensitive name of the particular backend to use when curl is
+invokved. Setting a name that isn't a built-in alternative, will make curl
+stay with the default.
+.IP "QLOGDIR <directory name>"
+If curl was built with HTTP/3 support, setting this environment variable to a
+local directory will make curl produce qlogs in that directory, using file
+names named after the destination connection id (in hex). Do note that these
+files can become rather large. Works with both QUIC backends.
+.IP "SSLKEYLOGFILE <file name>"
+If you set this environment variable to a file name, curl will store TLS
+secrets from its connections in that file when invoked to enable you to
+analyze the TLS traffic in real time using network analyzing tools such as
+Wireshark. This works with the following TLS backends: OpenSSL, libressl,
+BoringSSL, GnuTLS, NSS and wolfSSL.
.SH "PROXY PROTOCOL PREFIXES"
Since curl version 7.21.7, the proxy string may be specified with a
protocol:// prefix to specify alternative proxy protocols.
diff --git a/docs/cmdline-opts/page-header b/docs/cmdline-opts/page-header
index 60c3b07f..c38698c6 100644
--- a/docs/cmdline-opts/page-header
+++ b/docs/cmdline-opts/page-header
@@ -31,8 +31,9 @@ curl \- transfer a URL
.B curl
is a tool to transfer data from or to a server, using one of the supported
protocols (DICT, FILE, FTP, FTPS, GOPHER, HTTP, HTTPS, IMAP, IMAPS, LDAP,
-LDAPS, MQTT, POP3, POP3S, RTMP, RTSP, SCP, SFTP, SMB, SMBS, SMTP, SMTPS,
-TELNET and TFTP). The command is designed to work without user interaction.
+LDAPS, MQTT, POP3, POP3S, RTMP, RTMPS, RTSP, SCP, SFTP, SMB, SMBS, SMTP,
+SMTPS, TELNET and TFTP). The command is designed to work without user
+interaction.
curl offers a busload of useful tricks like proxy support, user
authentication, FTP upload, HTTP post, SSL connections, cookies, file transfer
@@ -52,16 +53,16 @@ braces and quoting the URL as in:
or you can get sequences of alphanumeric series by using [] as in:
- ftp://ftp.example.com/file[1-100].txt
+ "ftp://ftp.example.com/file[1-100].txt"
- ftp://ftp.example.com/file[001-100].txt (with leading zeros)
+ "ftp://ftp.example.com/file[001-100].txt" (with leading zeros)
- ftp://ftp.example.com/file[a-z].txt
+ "ftp://ftp.example.com/file[a-z].txt"
Nested sequences are not supported, but you can use several ones next to each
other:
- http://example.com/archive[1996-1999]/vol[1-4]/part{a,b,c}.html
+ "http://example.com/archive[1996-1999]/vol[1-4]/part{a,b,c}.html"
You can specify any amount of URLs on the command line. They will be fetched
in a sequential manner in the specified order. You can specify command line
@@ -70,9 +71,9 @@ options and URLs mixed and in any order on the command line.
You can specify a step counter for the ranges to get every Nth number or
letter:
- http://example.com/file[1-100:10].txt
+ "http://example.com/file[1-100:10].txt"
- http://example.com/file[a-z:2].txt
+ "http://example.com/file[a-z:2].txt"
When using [] or {} sequences when invoked from a command line prompt, you
probably have to put the full URL within double quotes to avoid the shell from
@@ -82,7 +83,7 @@ for example '&', '?' and '*'.
Provide the IPv6 zone index in the URL with an escaped percentage sign and the
interface name. Like in
- http://[fe80::3%25eth0]/
+ "http://[fe80::3%25eth0]/"
If you specify URL without protocol:// prefix, curl will attempt to guess what
protocol you might want. It will then default to HTTP but try other protocols
diff --git a/docs/cmdline-opts/resolve.d b/docs/cmdline-opts/resolve.d
index 9c37525b..c1692f0f 100644
--- a/docs/cmdline-opts/resolve.d
+++ b/docs/cmdline-opts/resolve.d
@@ -1,5 +1,5 @@
Long: resolve
-Arg: <host:port:address[,address]...>
+Arg: <host:port:addr[,addr]...>
Help: Resolve the host+port to this address
Added: 7.21.3
---
diff --git a/docs/cmdline-opts/retry-all-errors.d b/docs/cmdline-opts/retry-all-errors.d
new file mode 100644
index 00000000..4554f593
--- /dev/null
+++ b/docs/cmdline-opts/retry-all-errors.d
@@ -0,0 +1,19 @@
+Long: retry-all-errors
+Help: Retry all errors (use with --retry)
+Added: 7.71.0
+---
+Retry on any error. This option is used together with --retry.
+
+This option is the "sledgehammer" of retrying. Do not use this option by
+default (eg in curlrc), there may be unintended consequences such as sending or
+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.
diff --git a/docs/cmdline-opts/sasl-authzid.d b/docs/cmdline-opts/sasl-authzid.d
index b34db97f..a3bd46e7 100644
--- a/docs/cmdline-opts/sasl-authzid.d
+++ b/docs/cmdline-opts/sasl-authzid.d
@@ -1,5 +1,6 @@
Long: sasl-authzid
-Help: Use this identity to act as during SASL PLAIN authentication
+Arg: <identity>
+Help: Identity for SASL PLAIN authentication
Added: 7.66.0
---
Use this authorisation identity (authzid), during SASL PLAIN authentication,
diff --git a/docs/cmdline-opts/ssl-revoke-best-effort.d b/docs/cmdline-opts/ssl-revoke-best-effort.d
index 9b55699d..e339b8af 100644
--- a/docs/cmdline-opts/ssl-revoke-best-effort.d
+++ b/docs/cmdline-opts/ssl-revoke-best-effort.d
@@ -1,5 +1,5 @@
Long: ssl-revoke-best-effort
-Help: Ignore missing/offline cert CRL distribution points (Schannel)
+Help: Ignore missing/offline cert CRL dist points
Added: 7.70.0
---
(Schannel) This option tells curl to ignore certificate revocation checks when
diff --git a/docs/cmdline-opts/tls13-ciphers.d b/docs/cmdline-opts/tls13-ciphers.d
index 654a25b4..db803352 100644
--- a/docs/cmdline-opts/tls13-ciphers.d
+++ b/docs/cmdline-opts/tls13-ciphers.d
@@ -1,5 +1,5 @@
Long: tls13-ciphers
-Arg: <list of TLS 1.3 ciphersuites>
+Arg: <ciphersuite list>
help: TLS 1.3 cipher suites to use
Protocols: TLS
---
diff --git a/docs/cmdline-opts/user-agent.d b/docs/cmdline-opts/user-agent.d
index de73f723..c6dd2e58 100644
--- a/docs/cmdline-opts/user-agent.d
+++ b/docs/cmdline-opts/user-agent.d
@@ -9,4 +9,8 @@ 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
be set with the --header or the --proxy-header options.
+If you give an empty argument to --user-agent (""), it will remove the header
+completely from the request. If you prefer a blank header, you can set it to a
+single space (" ").
+
If this option is used several times, the last one will be used.
diff --git a/docs/cmdline-opts/version.d b/docs/cmdline-opts/version.d
index cd35f27f..16c1843f 100644
--- a/docs/cmdline-opts/version.d
+++ b/docs/cmdline-opts/version.d
@@ -13,48 +13,56 @@ reports to support.
The third line (starts with "Features:") shows specific features libcurl
reports to offer. Available features include:
.RS
+.IP "alt-svc"
+Support for the Alt-Svc: header is provided.
+.IP "AsynchDNS"
+This curl uses asynchronous name resolves. Asynchronous name resolves can be
+done using either the c-ares or the threaded resolver backends.
+.IP "brotli"
+Support for automatic brotli compression over HTTP(S).
+.IP "CharConv"
+curl was built with support for character set conversions (like EBCDIC)
+.IP "Debug"
+This curl uses a libcurl built with Debug. This enables more error-tracking
+and memory debugging etc. For curl-developers only!
+.IP "GSS-API"
+GSS-API is supported.
+.IP "HTTP2"
+HTTP/2 support has been built-in.
+.IP "HTTP3"
+HTTP/3 support has been built-in.
+.IP "HTTPS-proxy"
+This curl is built to support HTTPS proxy.
+.IP "IDN"
+This curl supports IDN - international domain names.
.IP "IPv6"
You can use IPv6 with this.
.IP "krb4"
Krb4 for FTP is supported.
-.IP "SSL"
-SSL versions of various protocols are supported, such as HTTPS, FTPS, POP3S
-and so on.
+.IP "Largefile"
+This curl supports transfers of large files, files larger than 2GB.
.IP "libz"
Automatic decompression of compressed files over HTTP is supported.
+.IP "Metalink"
+This curl supports Metalink
+.IP "MultiSSL"
+This curl supports multiple TLS backends.
.IP "NTLM"
NTLM authentication is supported.
-.IP "Debug"
-This curl uses a libcurl built with Debug. This enables more error-tracking
-and memory debugging etc. For curl-developers only!
-.IP "AsynchDNS"
-This curl uses asynchronous name resolves. Asynchronous name resolves can be
-done using either the c-ares or the threaded resolver backends.
+.IP "NTLM"
+NTLM authentication is supported.
+.IP "PSL"
+PSL is short for Public Suffix List and means that this curl has been built
+with knowledge about "public suffixes".
.IP "SPNEGO"
SPNEGO authentication is supported.
-.IP "Largefile"
-This curl supports transfers of large files, files larger than 2GB.
-.IP "IDN"
-This curl supports IDN - international domain names.
-.IP "GSS-API"
-GSS-API is supported.
+.IP "SSL"
+SSL versions of various protocols are supported, such as HTTPS, FTPS, POP3S
+and so on.
.IP "SSPI"
SSPI is supported.
.IP "TLS-SRP"
SRP (Secure Remote Password) authentication is supported for TLS.
-.IP "HTTP2"
-HTTP/2 support has been built-in.
.IP "UnixSockets"
Unix sockets support is provided.
-.IP "HTTPS-proxy"
-This curl is built to support HTTPS proxy.
-.IP "Metalink"
-This curl supports Metalink (both version 3 and 4 (RFC 5854)), which
-describes mirrors and hashes. curl will use mirrors for failover if
-there are errors (such as the file or server not being available).
-.IP "PSL"
-PSL is short for Public Suffix List and means that this curl has been built
-with knowledge about "public suffixes".
-.IP "MultiSSL"
-This curl supports multiple TLS backends.
.RE
diff --git a/docs/cmdline-opts/write-out.d b/docs/cmdline-opts/write-out.d
index 9024d32e..9786a9af 100644
--- a/docs/cmdline-opts/write-out.d
+++ b/docs/cmdline-opts/write-out.d
@@ -82,6 +82,10 @@ IPv4 or IPv6 (Added in 7.29.0)
.B remote_port
The remote port number of the most recently done connection (Added in 7.29.0)
.TP
+.B response_code
+The numerical response code that was found in the last transfer (formerly
+known as "http_code"). (Added in 7.18.2)
+.TP
.B scheme
The URL scheme (sometimes called protocol) that was effectively used (Added in 7.52.0)
.TP