From 083da46c60f84ff3feae7f312812c50ac8a439bb Mon Sep 17 00:00:00 2001 From: Daniel Stenberg Date: Mon, 31 Mar 2025 00:52:07 +0200 Subject: [PATCH] docs/cmdline-opts: use imperative form Use 'set', not 'sets' etc. For consistency. Closes #16879 --- docs/cmdline-opts/ciphers.md | 6 +++--- docs/cmdline-opts/compressed-ssh.md | 4 ++-- docs/cmdline-opts/data.md | 2 +- docs/cmdline-opts/digest.md | 2 +- docs/cmdline-opts/doh-cert-status.md | 2 +- docs/cmdline-opts/doh-url.md | 4 ++-- docs/cmdline-opts/ech.md | 2 +- docs/cmdline-opts/ftp-port.md | 2 +- docs/cmdline-opts/ftp-ssl-ccc-mode.md | 8 ++++---- docs/cmdline-opts/happy-eyeballs-timeout-ms.md | 2 ++ docs/cmdline-opts/haproxy-clientip.md | 2 +- docs/cmdline-opts/http3-only.md | 2 +- docs/cmdline-opts/json.md | 2 +- docs/cmdline-opts/location-trusted.md | 2 +- docs/cmdline-opts/mptcp.md | 2 +- docs/cmdline-opts/no-buffer.md | 2 +- docs/cmdline-opts/no-keepalive.md | 2 +- docs/cmdline-opts/parallel.md | 2 +- docs/cmdline-opts/pass.md | 2 +- docs/cmdline-opts/remote-time.md | 2 +- docs/cmdline-opts/tls-max.md | 4 ++-- docs/cmdline-opts/tls13-ciphers.md | 6 +++--- docs/cmdline-opts/tlsv1.0.md | 2 +- docs/cmdline-opts/tlsv1.1.md | 2 +- docs/cmdline-opts/tlsv1.2.md | 2 +- docs/cmdline-opts/tlsv1.3.md | 2 +- docs/cmdline-opts/trace-ids.md | 3 ++- docs/cmdline-opts/trace-time.md | 2 +- docs/cmdline-opts/verbose.md | 9 +++++---- docs/cmdline-opts/version.md | 2 +- docs/cmdline-opts/xattr.md | 2 ++ 31 files changed, 48 insertions(+), 42 deletions(-) diff --git a/docs/cmdline-opts/ciphers.md b/docs/cmdline-opts/ciphers.md index 6a597a2c8f..14f0425dbf 100644 --- a/docs/cmdline-opts/ciphers.md +++ b/docs/cmdline-opts/ciphers.md @@ -18,8 +18,8 @@ Example: # `--ciphers` -Specifies which cipher suites to use in the connection if it negotiates -TLS 1.2 (1.1, 1.0). The list of ciphers suites must specify valid ciphers. -Read up on cipher suite details on this URL: +Specify which cipher suites to use in the connection if it negotiates TLS 1.2 +(1.1, 1.0). The list of ciphers suites must specify valid ciphers. Read up on +cipher suite details on this URL: https://curl.se/docs/ssl-ciphers.html diff --git a/docs/cmdline-opts/compressed-ssh.md b/docs/cmdline-opts/compressed-ssh.md index b404f62d5d..955c59c2b7 100644 --- a/docs/cmdline-opts/compressed-ssh.md +++ b/docs/cmdline-opts/compressed-ssh.md @@ -15,5 +15,5 @@ Example: # `--compressed-ssh` -Enables built-in SSH compression. This is a request, not an order; the server -may or may not do it. +Enable SSH compression. This is a request, not an order; the server may or may +not do it. diff --git a/docs/cmdline-opts/data.md b/docs/cmdline-opts/data.md index 6b6e70285e..356fd39204 100644 --- a/docs/cmdline-opts/data.md +++ b/docs/cmdline-opts/data.md @@ -22,7 +22,7 @@ Example: # `--data` -Sends the specified data in a POST request to the HTTP server, in the same way +Send 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 submit button. This option makes curl pass the data to the server using the content-type application/x-www-form-urlencoded. Compare to --form. diff --git a/docs/cmdline-opts/digest.md b/docs/cmdline-opts/digest.md index 04c5a79a96..7a8b49cdf5 100644 --- a/docs/cmdline-opts/digest.md +++ b/docs/cmdline-opts/digest.md @@ -18,6 +18,6 @@ Example: # `--digest` -Enables HTTP Digest authentication. This authentication scheme avoids sending +Enable HTTP Digest authentication. This authentication scheme avoids sending the password over the wire in clear text. Use this in combination with the normal --user option to set username and password. diff --git a/docs/cmdline-opts/doh-cert-status.md b/docs/cmdline-opts/doh-cert-status.md index 920c5b435d..7c497cf16f 100644 --- a/docs/cmdline-opts/doh-cert-status.md +++ b/docs/cmdline-opts/doh-cert-status.md @@ -16,7 +16,7 @@ Example: Same as --cert-status but used for DoH (DNS-over-HTTPS). -Verifies the status of the DoH servers' certificate by using the Certificate +Verify the status of the DoH servers' certificate by using the Certificate Status Request (aka. OCSP stapling) TLS extension. If this option is enabled and the DoH server sends an invalid (e.g. expired) diff --git a/docs/cmdline-opts/doh-url.md b/docs/cmdline-opts/doh-url.md index 0f745af3b7..6c092d8eb5 100644 --- a/docs/cmdline-opts/doh-url.md +++ b/docs/cmdline-opts/doh-url.md @@ -16,8 +16,8 @@ Example: # `--doh-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. +Specify which DNS-over-HTTPS (DoH) server to use to resolve hostnames, instead +of using the default name resolver mechanism. The URL must be HTTPS. Some SSL options that you set for your transfer also applies to DoH since the name lookups take place over SSL. However, the certificate verification diff --git a/docs/cmdline-opts/ech.md b/docs/cmdline-opts/ech.md index ed16cd8112..3d8f3873af 100644 --- a/docs/cmdline-opts/ech.md +++ b/docs/cmdline-opts/ech.md @@ -16,7 +16,7 @@ Example: # `--ech` -Specifies how to do ECH (Encrypted Client Hello). +Specify how to do ECH (Encrypted Client Hello). The values allowed for \ can be: diff --git a/docs/cmdline-opts/ftp-port.md b/docs/cmdline-opts/ftp-port.md index ff6d41c131..28cc34ba2f 100644 --- a/docs/cmdline-opts/ftp-port.md +++ b/docs/cmdline-opts/ftp-port.md @@ -20,7 +20,7 @@ Example: # `--ftp-port` -Reverses the default initiator/listener roles when connecting with FTP. This +Reverse the default initiator/listener roles when connecting with FTP. This option makes curl use active mode. curl then commands the server to connect back to the client's specified address and port, while passive mode asks the server to setup an IP address and port for it to connect to. \ diff --git a/docs/cmdline-opts/ftp-ssl-ccc-mode.md b/docs/cmdline-opts/ftp-ssl-ccc-mode.md index 5f428dc0fa..3e9eb725c6 100644 --- a/docs/cmdline-opts/ftp-ssl-ccc-mode.md +++ b/docs/cmdline-opts/ftp-ssl-ccc-mode.md @@ -16,7 +16,7 @@ Example: # `--ftp-ssl-ccc-mode` -Sets the CCC mode. The passive mode does not initiate the shutdown, but -instead waits for the server to do it, and does not reply to the shutdown from -the server. The active mode initiates the shutdown and waits for a reply from -the server. +Set the CCC mode. The passive mode does not initiate the shutdown, but instead +waits for the server to do it, and does not reply to the shutdown from the +server. The active mode initiates the shutdown and waits for a reply from the +server. diff --git a/docs/cmdline-opts/happy-eyeballs-timeout-ms.md b/docs/cmdline-opts/happy-eyeballs-timeout-ms.md index f4b492db0d..f1abb37725 100644 --- a/docs/cmdline-opts/happy-eyeballs-timeout-ms.md +++ b/docs/cmdline-opts/happy-eyeballs-timeout-ms.md @@ -16,6 +16,8 @@ Example: # `--happy-eyeballs-timeout-ms` +Set the timeout for Happy Eyeballs. + Happy Eyeballs is an algorithm that attempts to connect to both IPv4 and IPv6 addresses for dual-stack hosts, giving IPv6 a head-start of the specified number of milliseconds. If the IPv6 address cannot be connected to within that diff --git a/docs/cmdline-opts/haproxy-clientip.md b/docs/cmdline-opts/haproxy-clientip.md index fde085a976..fd27da7cc8 100644 --- a/docs/cmdline-opts/haproxy-clientip.md +++ b/docs/cmdline-opts/haproxy-clientip.md @@ -16,7 +16,7 @@ Example: # `--haproxy-clientip` -Sets a client IP in HAProxy PROXY protocol v1 header at the beginning of the +Set a client IP in HAProxy PROXY protocol v1 header at the beginning of the connection. For valid requests, IPv4 addresses must be indicated as a series of exactly diff --git a/docs/cmdline-opts/http3-only.md b/docs/cmdline-opts/http3-only.md index 0ee5f1887e..400ac19ac2 100644 --- a/docs/cmdline-opts/http3-only.md +++ b/docs/cmdline-opts/http3-only.md @@ -20,7 +20,7 @@ Example: # `--http3-only` -Instructs curl to use HTTP/3 to the host in the URL, with no fallback to +Instruct curl to use HTTP/3 to the host in the URL, with no fallback to earlier HTTP versions. HTTP/3 can only be used for HTTPS and not for HTTP URLs. For HTTP, this option triggers an error. diff --git a/docs/cmdline-opts/json.md b/docs/cmdline-opts/json.md index 7763d81ee0..c64a9ab124 100644 --- a/docs/cmdline-opts/json.md +++ b/docs/cmdline-opts/json.md @@ -21,7 +21,7 @@ Example: # `--json` -Sends the specified JSON data in a POST request to the HTTP server. --json +Send the specified JSON data in a POST request to the HTTP server. --json works as a shortcut for passing on these three options: --data-binary [arg] diff --git a/docs/cmdline-opts/location-trusted.md b/docs/cmdline-opts/location-trusted.md index 06458a4678..5e20d8cc1f 100644 --- a/docs/cmdline-opts/location-trusted.md +++ b/docs/cmdline-opts/location-trusted.md @@ -16,7 +16,7 @@ Example: # `--location-trusted` -Instructs curl to like --location follow HTTP redirects, but permits it to +Instruct curl to follow HTTP redirects like --location, but permit curl to send credentials and other secrets along to other hosts than the initial one. This may or may not introduce a security breach if the site redirects you to a diff --git a/docs/cmdline-opts/mptcp.md b/docs/cmdline-opts/mptcp.md index 698b693701..2cd76abc3f 100644 --- a/docs/cmdline-opts/mptcp.md +++ b/docs/cmdline-opts/mptcp.md @@ -14,7 +14,7 @@ Example: # `--mptcp` -Enables the use of Multipath TCP (MPTCP) for connections. MPTCP is an extension +Enable the use of Multipath TCP (MPTCP) for connections. MPTCP is an extension to the standard TCP that allows multiple TCP streams over different network paths between the same source and destination. This can enhance bandwidth and improve reliability by using multiple paths simultaneously. diff --git a/docs/cmdline-opts/no-buffer.md b/docs/cmdline-opts/no-buffer.md index e0860155c8..442beb0b3c 100644 --- a/docs/cmdline-opts/no-buffer.md +++ b/docs/cmdline-opts/no-buffer.md @@ -15,7 +15,7 @@ Example: # `--no-buffer` -Disables the buffering of the output stream. In normal work situations, curl +Disable the buffering of the output stream. In normal work situations, curl uses a standard buffered output stream that has the effect that it outputs the data in chunks, not necessarily exactly when the data arrives. Using this option disables that buffering. diff --git a/docs/cmdline-opts/no-keepalive.md b/docs/cmdline-opts/no-keepalive.md index 2c2115fe09..99dd0329db 100644 --- a/docs/cmdline-opts/no-keepalive.md +++ b/docs/cmdline-opts/no-keepalive.md @@ -15,7 +15,7 @@ Example: # `--no-keepalive` -Disables the use of keepalive messages on the TCP connection. curl otherwise +Disable the use of keepalive messages on the TCP connection. curl otherwise enables them by default. Note that this is the negated option name documented. You can thus use diff --git a/docs/cmdline-opts/parallel.md b/docs/cmdline-opts/parallel.md index fb9221bc6f..d4776eb537 100644 --- a/docs/cmdline-opts/parallel.md +++ b/docs/cmdline-opts/parallel.md @@ -19,7 +19,7 @@ Example: # `--parallel` -Makes curl perform all transfers in parallel as compared to the regular serial +Make curl perform all transfers in parallel as compared to the regular serial manner. Parallel transfer means that curl runs up to N concurrent transfers simultaneously and if there are more than N transfers to handle, it starts new ones when earlier transfers finish. diff --git a/docs/cmdline-opts/pass.md b/docs/cmdline-opts/pass.md index 98bc35b244..0527334f2a 100644 --- a/docs/cmdline-opts/pass.md +++ b/docs/cmdline-opts/pass.md @@ -17,4 +17,4 @@ Example: # `--pass` -Passphrase for the private key. +Passphrase for the private key used for SSH or TLS. diff --git a/docs/cmdline-opts/remote-time.md b/docs/cmdline-opts/remote-time.md index 7c5d21f036..3f8c702b45 100644 --- a/docs/cmdline-opts/remote-time.md +++ b/docs/cmdline-opts/remote-time.md @@ -16,6 +16,6 @@ Example: # `--remote-time` -Makes curl attempt to figure out the timestamp of the remote file that is +Make curl attempt to figure out the timestamp of the remote file that is getting downloaded, and if that is available make the local file get that same timestamp. diff --git a/docs/cmdline-opts/tls-max.md b/docs/cmdline-opts/tls-max.md index 87233c75ac..512a90e7ce 100644 --- a/docs/cmdline-opts/tls-max.md +++ b/docs/cmdline-opts/tls-max.md @@ -22,8 +22,8 @@ Example: # `--tls-max` -VERSION defines maximum supported TLS version. The minimum acceptable version -is set by tlsv1.0, tlsv1.1, tlsv1.2 or tlsv1.3. +Set the maximum allowed TLS version. The minimum acceptable version is set by +tlsv1.0, tlsv1.1, tlsv1.2 or tlsv1.3. If the connection is done without TLS, this option has no effect. This includes QUIC-using (HTTP/3) transfers. diff --git a/docs/cmdline-opts/tls13-ciphers.md b/docs/cmdline-opts/tls13-ciphers.md index ccd08f7c81..cae224eb17 100644 --- a/docs/cmdline-opts/tls13-ciphers.md +++ b/docs/cmdline-opts/tls13-ciphers.md @@ -18,9 +18,9 @@ Example: # `--tls13-ciphers` -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 -cipher suite details on this URL: +Set 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 cipher +suite details on this URL: https://curl.se/docs/ssl-ciphers.html diff --git a/docs/cmdline-opts/tlsv1.0.md b/docs/cmdline-opts/tlsv1.0.md index 66ca32389e..59eaae26e9 100644 --- a/docs/cmdline-opts/tlsv1.0.md +++ b/docs/cmdline-opts/tlsv1.0.md @@ -15,7 +15,7 @@ Example: # `--tlsv1.0` -Forces curl to use TLS version 1.0 or later when connecting to a remote TLS server. +Force curl to use TLS version 1.0 or later when connecting to a remote TLS server. In old versions of curl this option was documented to allow _only_ TLS 1.0. That behavior was inconsistent depending on the TLS library. Use --tls-max if diff --git a/docs/cmdline-opts/tlsv1.1.md b/docs/cmdline-opts/tlsv1.1.md index 577b7c7a50..5f5e7c765c 100644 --- a/docs/cmdline-opts/tlsv1.1.md +++ b/docs/cmdline-opts/tlsv1.1.md @@ -16,7 +16,7 @@ Example: # `--tlsv1.1` -Forces curl to use TLS version 1.1 or later when connecting to a remote TLS server. +Force curl to use TLS version 1.1 or later when connecting to a remote TLS server. In old versions of curl this option was documented to allow _only_ TLS 1.1. That behavior was inconsistent depending on the TLS library. Use --tls-max if diff --git a/docs/cmdline-opts/tlsv1.2.md b/docs/cmdline-opts/tlsv1.2.md index 0132074e3c..bf38762be7 100644 --- a/docs/cmdline-opts/tlsv1.2.md +++ b/docs/cmdline-opts/tlsv1.2.md @@ -16,7 +16,7 @@ Example: # `--tlsv1.2` -Forces curl to use TLS version 1.2 or later when connecting to a remote TLS server. +Force curl to use TLS version 1.2 or later when connecting to a remote TLS server. In old versions of curl this option was documented to allow _only_ TLS 1.2. That behavior was inconsistent depending on the TLS library. Use --tls-max if diff --git a/docs/cmdline-opts/tlsv1.3.md b/docs/cmdline-opts/tlsv1.3.md index 6c65f59de6..6f14eccb5a 100644 --- a/docs/cmdline-opts/tlsv1.3.md +++ b/docs/cmdline-opts/tlsv1.3.md @@ -16,7 +16,7 @@ Example: # `--tlsv1.3` -Forces curl to use TLS version 1.3 or later when connecting to a remote TLS +Force curl to use TLS version 1.3 or later when connecting to a remote TLS server. If the connection is done without TLS, this option has no effect. This diff --git a/docs/cmdline-opts/trace-ids.md b/docs/cmdline-opts/trace-ids.md index dc7d61e7f7..b9a6222600 100644 --- a/docs/cmdline-opts/trace-ids.md +++ b/docs/cmdline-opts/trace-ids.md @@ -16,4 +16,5 @@ Example: # `--trace-ids` -Prepends the transfer and connection identifiers to each trace or verbose line that curl displays. +Prepend the transfer and connection identifiers to each trace or verbose line +that curl displays. diff --git a/docs/cmdline-opts/trace-time.md b/docs/cmdline-opts/trace-time.md index d3e0f47c19..baa7b8800f 100644 --- a/docs/cmdline-opts/trace-time.md +++ b/docs/cmdline-opts/trace-time.md @@ -16,4 +16,4 @@ Example: # `--trace-time` -Prepends a time stamp to each trace or verbose line that curl displays. +Prepend a time stamp to each trace or verbose line that curl displays. diff --git a/docs/cmdline-opts/verbose.md b/docs/cmdline-opts/verbose.md index 21065f7169..0a251c3126 100644 --- a/docs/cmdline-opts/verbose.md +++ b/docs/cmdline-opts/verbose.md @@ -20,10 +20,11 @@ Example: # `--verbose` -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 sent -by curl, \< means header data received by curl that is hidden in normal cases, -and a line starting with * means additional info provided by curl. +Make curl output verbose information during the operation. Useful for +debugging and seeing what's going on under the hood. A line starting with \> +means header data sent by curl, \< means header data received by curl that is +hidden in normal cases, and a line starting with * means additional info +provided by curl. If you only want HTTP headers in the output, --show-headers or --dump-header might be more suitable options. diff --git a/docs/cmdline-opts/version.md b/docs/cmdline-opts/version.md index 3f021565e5..46074f8b8c 100644 --- a/docs/cmdline-opts/version.md +++ b/docs/cmdline-opts/version.md @@ -16,7 +16,7 @@ Example: # `--version` -Displays information about curl and the libcurl version it uses. +Display information about curl and the libcurl version it uses. The first line includes the full version of curl, libcurl and other 3rd party libraries linked with the executable. diff --git a/docs/cmdline-opts/xattr.md b/docs/cmdline-opts/xattr.md index 0c3bb753ae..380cdbdfd3 100644 --- a/docs/cmdline-opts/xattr.md +++ b/docs/cmdline-opts/xattr.md @@ -16,6 +16,8 @@ Example: # `--xattr` +Store metadata in the extended file attributes. + When saving output to a file, tell curl to store file metadata in extended file attributes. Currently, `curl` is stored in the `creator` attribute, the URL is stored in the `xdg.origin.url` attribute and, for HTTP, the content -- 2.47.2