diff options
Diffstat (limited to 'docs/cmdline-opts')
266 files changed, 1697 insertions, 1070 deletions
diff --git a/docs/cmdline-opts/CMakeLists.txt b/docs/cmdline-opts/CMakeLists.txt index fe7870f5d..3dd8be49b 100644 --- a/docs/cmdline-opts/CMakeLists.txt +++ b/docs/cmdline-opts/CMakeLists.txt @@ -5,7 +5,7 @@ # | (__| |_| | _ <| |___ # \___|\___/|_| \_\_____| # -# Copyright (C) 1998 - 2022, Daniel Stenberg, <daniel@haxx.se>, et al. +# Copyright (C) Daniel Stenberg, <daniel@haxx.se>, et al. # # This software is licensed as described in the file COPYING, which # you should have received as part of this distribution. The terms diff --git a/docs/cmdline-opts/MANPAGE.md b/docs/cmdline-opts/MANPAGE.md index b760a9ad8..6de32dab9 100644 --- a/docs/cmdline-opts/MANPAGE.md +++ b/docs/cmdline-opts/MANPAGE.md @@ -1,5 +1,5 @@ <!-- - Copyright (C) 2000 - 2022, Daniel Stenberg, <daniel@haxx.se>, et al. + Copyright (C) Daniel Stenberg, <daniel@haxx.se>, et al. SPDX-License-Identifier: curl --> @@ -31,10 +31,11 @@ Each file has a set of meta-data and a body of text. Help: (short text for the --help output for this option) Long: (long form name, without dashes) Magic: (description of "magic" options) - Multi: single/append/boolean/mutex (if used more than once) + Multi: single/append/boolean/mutex/custom (if used more than once) Mutexed: (space separated list of options this overrides, no dashes) Protocols: (space separated list for which protocols this option works) Requires: (space separated list of features this requires, no dashes) + Scope: global (if the option is global) See-also: (space separated list of related options, no dashes) Short: (single letter, without dash) SPDX-License-Identifier: curl @@ -44,19 +45,19 @@ Each file has a set of meta-data and a body of text. ### Body The body of the description. Only refer to options with their long form option -version, like `--verbose`. The output generator will replace such with the +version, like `--verbose`. The output generator replaces such option with the correct markup that shows both short and long version. -Text written within `*asterisks*` will get shown using italics. Text within -two `**asterisks**` will get shown using bold. +Text written within `*asterisks*` is shown using italics. Text within two +`**asterisks**` is shown using bold. -Text that is prefixed with a space will be treated like an "example" and will -be output in monospace. +Text that is prefixed with a space is treated like an "example" and gets +output in monospace. ## Header and footer -`page-header` is the file that will be output before the generated options -output for the master man page. +`page-header` is the file that is output before the generated options output +for the master man page. `page-footer` is appended after all the individual options. diff --git a/docs/cmdline-opts/Makefile.am b/docs/cmdline-opts/Makefile.am index df38e192a..5a8996bc2 100644 --- a/docs/cmdline-opts/Makefile.am +++ b/docs/cmdline-opts/Makefile.am @@ -5,7 +5,7 @@ # | (__| |_| | _ <| |___ # \___|\___/|_| \_\_____| # -# Copyright (C) 1998 - 2022, Daniel Stenberg, <daniel@haxx.se>, et al. +# Copyright (C) Daniel Stenberg, <daniel@haxx.se>, et al. # # This software is licensed as described in the file COPYING, which # you should have received as part of this distribution. The terms @@ -30,8 +30,12 @@ include Makefile.inc EXTRA_DIST = $(DPAGES) MANPAGE.md gen.pl $(OTHERPAGES) CMakeLists.txt +GEN = $(GN_$(V)) +GN_0 = @echo " GENERATE" $@; +GN_1 = +GN_ = $(GN_0) + all: $(MANPAGE) -$(MANPAGE): $(DPAGES) $(OTHERPAGES) Makefile.inc - @echo "generate $(MANPAGE)" - @(cd $(srcdir) && @PERL@ ./gen.pl mainpage $(DPAGES)) > $(MANPAGE) +$(MANPAGE): $(DPAGES) $(OTHERPAGES) Makefile.inc gen.pl + $(GEN)(rm -f $(MANPAGE) && cd $(srcdir) && @PERL@ ./gen.pl mainpage $(DPAGES) > $(builddir)/manpage.tmp && mv $(builddir)/manpage.tmp $(MANPAGE)) diff --git a/docs/cmdline-opts/Makefile.in b/docs/cmdline-opts/Makefile.in index 4450fa73a..f861c23fa 100644 --- a/docs/cmdline-opts/Makefile.in +++ b/docs/cmdline-opts/Makefile.in @@ -21,7 +21,7 @@ # | (__| |_| | _ <| |___ # \___|\___/|_| \_\_____| # -# Copyright (C) 1998 - 2022, Daniel Stenberg, <daniel@haxx.se>, et al. +# Copyright (C) Daniel Stenberg, <daniel@haxx.se>, et al. # # This software is licensed as described in the file COPYING, which # you should have received as part of this distribution. The terms @@ -45,7 +45,7 @@ # | (__| |_| | _ <| |___ # \___|\___/|_| \_\_____| # -# Copyright (C) 1998 - 2022, Daniel Stenberg, <daniel@haxx.se>, et al. +# Copyright (C) Daniel Stenberg, <daniel@haxx.se>, et al. # # This software is licensed as described in the file COPYING, which # you should have received as part of this distribution. The terms @@ -144,7 +144,7 @@ am__aclocal_m4_deps = $(top_srcdir)/m4/curl-amissl.m4 \ $(top_srcdir)/m4/curl-confopts.m4 \ $(top_srcdir)/m4/curl-functions.m4 \ $(top_srcdir)/m4/curl-gnutls.m4 \ - $(top_srcdir)/m4/curl-mbedtls.m4 $(top_srcdir)/m4/curl-nss.m4 \ + $(top_srcdir)/m4/curl-mbedtls.m4 \ $(top_srcdir)/m4/curl-openssl.m4 \ $(top_srcdir)/m4/curl-override.m4 \ $(top_srcdir)/m4/curl-reentrant.m4 \ @@ -198,6 +198,8 @@ DISTFILES = $(DIST_COMMON) $(DIST_SOURCES) $(TEXINFOS) $(EXTRA_DIST) ACLOCAL = @ACLOCAL@ AMTAR = @AMTAR@ AM_DEFAULT_VERBOSITY = @AM_DEFAULT_VERBOSITY@ +APACHECTL = @APACHECTL@ +APXS = @APXS@ AR = @AR@ AR_FLAGS = @AR_FLAGS@ AS = @AS@ @@ -206,6 +208,7 @@ AUTOHEADER = @AUTOHEADER@ AUTOMAKE = @AUTOMAKE@ AWK = @AWK@ BLANK_AT_MAKETIME = @BLANK_AT_MAKETIME@ +CADDY = @CADDY@ CC = @CC@ CCDEPMODE = @CCDEPMODE@ CFLAGS = @CFLAGS@ @@ -267,6 +270,8 @@ HAVE_LIBZ = @HAVE_LIBZ@ HAVE_OPENSSL_SRP = @HAVE_OPENSSL_SRP@ HAVE_PROTO_BSDSOCKET_H = @HAVE_PROTO_BSDSOCKET_H@ HAVE_ZSTD = @HAVE_ZSTD@ +HTTPD = @HTTPD@ +HTTPD_NGHTTPX = @HTTPD_NGHTTPX@ IDN_ENABLED = @IDN_ENABLED@ INSTALL = @INSTALL@ INSTALL_DATA = @INSTALL_DATA@ @@ -294,7 +299,6 @@ MKDIR_P = @MKDIR_P@ NM = @NM@ NMEDIT = @NMEDIT@ NROFF = @NROFF@ -NSS_LIBS = @NSS_LIBS@ OBJDUMP = @OBJDUMP@ OBJEXT = @OBJEXT@ OTOOL = @OTOOL@ @@ -325,6 +329,7 @@ SSL_LIBS = @SSL_LIBS@ STRIP = @STRIP@ SUPPORT_FEATURES = @SUPPORT_FEATURES@ SUPPORT_PROTOCOLS = @SUPPORT_PROTOCOLS@ +TEST_NGHTTPX = @TEST_NGHTTPX@ USE_ARES = @USE_ARES@ USE_BEARSSL = @USE_BEARSSL@ USE_GNUTLS = @USE_GNUTLS@ @@ -338,9 +343,8 @@ USE_NGHTTP2 = @USE_NGHTTP2@ USE_NGHTTP3 = @USE_NGHTTP3@ USE_NGTCP2 = @USE_NGTCP2@ USE_NGTCP2_CRYPTO_GNUTLS = @USE_NGTCP2_CRYPTO_GNUTLS@ -USE_NGTCP2_CRYPTO_OPENSSL = @USE_NGTCP2_CRYPTO_OPENSSL@ +USE_NGTCP2_CRYPTO_QUICTLS = @USE_NGTCP2_CRYPTO_QUICTLS@ USE_NGTCP2_CRYPTO_WOLFSSL = @USE_NGTCP2_CRYPTO_WOLFSSL@ -USE_NSS = @USE_NSS@ USE_OPENLDAP = @USE_OPENLDAP@ USE_QUICHE = @USE_QUICHE@ USE_RUSTLS = @USE_RUSTLS@ @@ -420,6 +424,7 @@ DPAGES = \ append.d \ aws-sigv4.d \ basic.d \ + ca-native.d \ cacert.d \ capath.d \ cert-status.d \ @@ -485,6 +490,7 @@ DPAGES = \ globoff.d \ happy-eyeballs-timeout-ms.d \ haproxy-protocol.d \ + haproxy-clientip.d \ head.d \ header.d \ help.d \ @@ -497,10 +503,12 @@ DPAGES = \ http2-prior-knowledge.d \ http2.d \ http3.d \ + http3-only.d \ ignore-content-length.d \ include.d \ insecure.d \ interface.d \ + ipfs-gateway.d \ ipv4.d \ ipv6.d \ json.d \ @@ -559,6 +567,7 @@ DPAGES = \ proto.d \ proxy-anyauth.d \ proxy-basic.d \ + proxy-ca-native.d \ proxy-cacert.d \ proxy-capath.d \ proxy-cert-type.d \ @@ -567,6 +576,7 @@ DPAGES = \ proxy-crlfile.d \ proxy-digest.d \ proxy-header.d \ + proxy-http2.d \ proxy-insecure.d \ proxy-key-type.d \ proxy-key.d \ @@ -650,14 +660,18 @@ DPAGES = \ tlsv1.d \ tr-encoding.d \ trace-ascii.d \ + trace-config.d \ + trace-ids.d \ trace-time.d \ trace.d \ unix-socket.d \ upload-file.d \ url.d \ + url-query.d \ use-ascii.d \ user-agent.d \ user.d \ + variable.d \ verbose.d \ version.d \ write-out.d \ @@ -665,6 +679,10 @@ DPAGES = \ OTHERPAGES = page-footer page-header EXTRA_DIST = $(DPAGES) MANPAGE.md gen.pl $(OTHERPAGES) CMakeLists.txt +GEN = $(GN_$(V)) +GN_0 = @echo " GENERATE" $@; +GN_1 = +GN_ = $(GN_0) all: all-am .SUFFIXES: @@ -862,9 +880,8 @@ uninstall-am: all: $(MANPAGE) -$(MANPAGE): $(DPAGES) $(OTHERPAGES) Makefile.inc - @echo "generate $(MANPAGE)" - @(cd $(srcdir) && @PERL@ ./gen.pl mainpage $(DPAGES)) > $(MANPAGE) +$(MANPAGE): $(DPAGES) $(OTHERPAGES) Makefile.inc gen.pl + $(GEN)(rm -f $(MANPAGE) && cd $(srcdir) && @PERL@ ./gen.pl mainpage $(DPAGES) > $(builddir)/manpage.tmp && mv $(builddir)/manpage.tmp $(MANPAGE)) # Tell versions [3.59,3.63) of GNU make to not export all variables. # Otherwise a system limit (for SysV at least) may be exceeded. diff --git a/docs/cmdline-opts/Makefile.inc b/docs/cmdline-opts/Makefile.inc index 350fa9fa7..a7c92f264 100644 --- a/docs/cmdline-opts/Makefile.inc +++ b/docs/cmdline-opts/Makefile.inc @@ -5,7 +5,7 @@ # | (__| |_| | _ <| |___ # \___|\___/|_| \_\_____| # -# Copyright (C) 1998 - 2022, Daniel Stenberg, <daniel@haxx.se>, et al. +# Copyright (C) Daniel Stenberg, <daniel@haxx.se>, et al. # # This software is licensed as described in the file COPYING, which # you should have received as part of this distribution. The terms @@ -30,6 +30,7 @@ DPAGES = \ append.d \ aws-sigv4.d \ basic.d \ + ca-native.d \ cacert.d \ capath.d \ cert-status.d \ @@ -95,6 +96,7 @@ DPAGES = \ globoff.d \ happy-eyeballs-timeout-ms.d \ haproxy-protocol.d \ + haproxy-clientip.d \ head.d \ header.d \ help.d \ @@ -107,10 +109,12 @@ DPAGES = \ http2-prior-knowledge.d \ http2.d \ http3.d \ + http3-only.d \ ignore-content-length.d \ include.d \ insecure.d \ interface.d \ + ipfs-gateway.d \ ipv4.d \ ipv6.d \ json.d \ @@ -169,6 +173,7 @@ DPAGES = \ proto.d \ proxy-anyauth.d \ proxy-basic.d \ + proxy-ca-native.d \ proxy-cacert.d \ proxy-capath.d \ proxy-cert-type.d \ @@ -177,6 +182,7 @@ DPAGES = \ proxy-crlfile.d \ proxy-digest.d \ proxy-header.d \ + proxy-http2.d \ proxy-insecure.d \ proxy-key-type.d \ proxy-key.d \ @@ -260,14 +266,18 @@ DPAGES = \ tlsv1.d \ tr-encoding.d \ trace-ascii.d \ + trace-config.d \ + trace-ids.d \ trace-time.d \ trace.d \ unix-socket.d \ upload-file.d \ url.d \ + url-query.d \ use-ascii.d \ user-agent.d \ user.d \ + variable.d \ verbose.d \ version.d \ write-out.d \ diff --git a/docs/cmdline-opts/abstract-unix-socket.d b/docs/cmdline-opts/abstract-unix-socket.d index 32cd5e209..5c2fd4a47 100644 --- a/docs/cmdline-opts/abstract-unix-socket.d +++ b/docs/cmdline-opts/abstract-unix-socket.d @@ -1,4 +1,4 @@ -c: Copyright (C) 1998 - 2022, Daniel Stenberg, <daniel@haxx.se>, et al. +c: Copyright (C) Daniel Stenberg, <daniel@haxx.se>, et al. SPDX-License-Identifier: curl Long: abstract-unix-socket Arg: <path> diff --git a/docs/cmdline-opts/alt-svc.d b/docs/cmdline-opts/alt-svc.d index 6689d605c..276ac1b66 100644 --- a/docs/cmdline-opts/alt-svc.d +++ b/docs/cmdline-opts/alt-svc.d @@ -1,4 +1,4 @@ -c: Copyright (C) 1998 - 2022, Daniel Stenberg, <daniel@haxx.se>, et al. +c: Copyright (C) Daniel Stenberg, <daniel@haxx.se>, et al. SPDX-License-Identifier: curl Long: alt-svc Arg: <file name> @@ -11,11 +11,11 @@ Example: --alt-svc svc.txt $URL Multi: append --- 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. +existing alt-svc cache file, that gets used. After a completed transfer, the +cache is saved to the file name again if it has been modified. Specify a "" file name (zero length) to avoid loading/saving and make curl just handle the cache in memory. -If this option is used several times, curl will load contents from all the -files but the last one will be used for saving. +If this option is used several times, curl loads contents from all the +files but the last one is used for saving. diff --git a/docs/cmdline-opts/anyauth.d b/docs/cmdline-opts/anyauth.d index cc871b6e2..2498bdcd8 100644 --- a/docs/cmdline-opts/anyauth.d +++ b/docs/cmdline-opts/anyauth.d @@ -1,4 +1,4 @@ -c: Copyright (C) 1998 - 2022, Daniel Stenberg, <daniel@haxx.se>, et al. +c: Copyright (C) Daniel Stenberg, <daniel@haxx.se>, et al. SPDX-License-Identifier: curl Long: anyauth Help: Pick any authentication method @@ -17,7 +17,6 @@ method, which you can do with --basic, --digest, --ntlm, and --negotiate. Using --anyauth is not recommended if you do uploads from stdin, since it may require data to be sent twice and then the client must be able to rewind. If -the need should arise when uploading from stdin, the upload operation will -fail. +the need should arise when uploading from stdin, the upload operation fails. Used together with --user. diff --git a/docs/cmdline-opts/append.d b/docs/cmdline-opts/append.d index b1eab78cf..7561c951c 100644 --- a/docs/cmdline-opts/append.d +++ b/docs/cmdline-opts/append.d @@ -1,4 +1,4 @@ -c: Copyright (C) 1998 - 2022, Daniel Stenberg, <daniel@haxx.se>, et al. +c: Copyright (C) Daniel Stenberg, <daniel@haxx.se>, et al. SPDX-License-Identifier: curl Short: a Long: append @@ -10,6 +10,7 @@ Example: --upload-file local --append ftp://example.com/ Added: 4.8 Multi: boolean --- -When used in an upload, this makes curl append to the target file instead of -overwriting it. If the remote file does not exist, it will be created. Note -that this flag is ignored by some SFTP servers (including OpenSSH). +When used in an upload, this option makes curl append to the target file +instead of overwriting it. If the remote file does not exist, it is +created. Note that this flag is ignored by some SFTP servers (including +OpenSSH). diff --git a/docs/cmdline-opts/aws-sigv4.d b/docs/cmdline-opts/aws-sigv4.d index 7f69c03ab..b771eee6a 100644 --- a/docs/cmdline-opts/aws-sigv4.d +++ b/docs/cmdline-opts/aws-sigv4.d @@ -1,4 +1,4 @@ -c: Copyright (C) 1998 - 2022, Daniel Stenberg, <daniel@haxx.se>, et al. +c: Copyright (C) Daniel Stenberg, <daniel@haxx.se>, et al. SPDX-License-Identifier: curl Long: aws-sigv4 Arg: <provider1[:provider2[:region[:service]]]> @@ -6,7 +6,7 @@ Help: Use AWS V4 signature authentication Category: auth http Added: 7.75.0 See-also: basic user -Example: --aws-sigv4 "aws:amz:east-2:es" --user "key:secret" $URL +Example: --aws-sigv4 "aws:amz:us-east-2:es" --user "key:secret" $URL Multi: single --- Use AWS V4 signature authentication in the transfer. diff --git a/docs/cmdline-opts/basic.d b/docs/cmdline-opts/basic.d index ca873b8bb..cb0642620 100644 --- a/docs/cmdline-opts/basic.d +++ b/docs/cmdline-opts/basic.d @@ -1,4 +1,4 @@ -c: Copyright (C) 1998 - 2022, Daniel Stenberg, <daniel@haxx.se>, et al. +c: Copyright (C) Daniel Stenberg, <daniel@haxx.se>, et al. SPDX-License-Identifier: curl Long: basic Help: Use HTTP Basic Authentication diff --git a/docs/cmdline-opts/ca-native.d b/docs/cmdline-opts/ca-native.d new file mode 100644 index 000000000..51e36918a --- /dev/null +++ b/docs/cmdline-opts/ca-native.d @@ -0,0 +1,21 @@ +c: Copyright (C) Daniel Stenberg, <daniel@haxx.se>, et al. +SPDX-License-Identifier: curl +Long: ca-native +Help: Use CA certificates from the native OS +Protocols: TLS +Category: tls +See-also: cacert capath insecure +Example: --ca-native $URL +Added: 8.2.0 +Multi: boolean +--- +Tells curl to use the CA store from the native operating system to verify the +peer. By default, curl otherwise uses a CA store provided in a single file or +directory, but when using this option it interfaces the operating system's +own vault. + +This option only works for curl on Windows when built to use OpenSSL. When +curl on Windows is built to use Schannel, this feature is implied and curl +then only uses the native CA store. + +curl built with wolfSSL also supports this option (added in 8.3.0). diff --git a/docs/cmdline-opts/cacert.d b/docs/cmdline-opts/cacert.d index 1f86b0e96..5e4e74901 100644 --- a/docs/cmdline-opts/cacert.d +++ b/docs/cmdline-opts/cacert.d @@ -1,4 +1,4 @@ -c: Copyright (C) 1998 - 2022, Daniel Stenberg, <daniel@haxx.se>, et al. +c: Copyright (C) Daniel Stenberg, <daniel@haxx.se>, et al. SPDX-License-Identifier: curl Long: cacert Arg: <file> @@ -19,20 +19,17 @@ curl recognizes the environment variable named 'CURL_CA_BUNDLE' if it is set, and uses the given path as a path to a CA cert bundle. This option overrides that variable. -The windows version of curl will automatically look for a CA certs file named +The windows version of curl automatically looks for a CA certs file named 'curl-ca-bundle.crt', either in the same directory as curl.exe, or in the Current Working Directory, or in any folder along your PATH. -If curl is built against the NSS SSL library, the NSS PEM PKCS#11 module -(libnsspem.so) needs to be available for this option to work properly. - (iOS and macOS only) If curl is built against Secure Transport, then this option is supported for backward compatibility with other SSL engines, but it -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. +should not be set. If the option is not set, then curl uses 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). +(added in 7.60.0). 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). diff --git a/docs/cmdline-opts/capath.d b/docs/cmdline-opts/capath.d index 552c05a3c..75e9f2e40 100644 --- a/docs/cmdline-opts/capath.d +++ b/docs/cmdline-opts/capath.d @@ -1,4 +1,4 @@ -c: Copyright (C) 1998 - 2022, Daniel Stenberg, <daniel@haxx.se>, et al. +c: Copyright (C) Daniel Stenberg, <daniel@haxx.se>, et al. SPDX-License-Identifier: curl Long: capath Arg: <dir> @@ -18,4 +18,4 @@ c_rehash utility supplied with OpenSSL. Using --capath can allow OpenSSL-powered curl to make SSL-connections much more efficiently than using --cacert if the --cacert file contains many CA certificates. -If this option is set, the default capath value will be ignored. +If this option is set, the default capath value is ignored. diff --git a/docs/cmdline-opts/cert-status.d b/docs/cmdline-opts/cert-status.d index 83241dba2..e2d1d7aa2 100644 --- a/docs/cmdline-opts/cert-status.d +++ b/docs/cmdline-opts/cert-status.d @@ -1,4 +1,4 @@ -c: Copyright (C) 1998 - 2022, Daniel Stenberg, <daniel@haxx.se>, et al. +c: Copyright (C) Daniel Stenberg, <daniel@haxx.se>, et al. SPDX-License-Identifier: curl Long: cert-status Protocols: TLS @@ -16,4 +16,4 @@ If this option is enabled and the server sends an invalid (e.g. expired) response, if the response suggests that the server certificate has been revoked, or no response at all is received, the verification fails. -This is currently only implemented in the OpenSSL, GnuTLS and NSS backends. +This is currently only implemented in the OpenSSL and GnuTLS backends. diff --git a/docs/cmdline-opts/cert-type.d b/docs/cmdline-opts/cert-type.d index 13643fb53..cf9f17b7d 100644 --- a/docs/cmdline-opts/cert-type.d +++ b/docs/cmdline-opts/cert-type.d @@ -1,4 +1,4 @@ -c: Copyright (C) 1998 - 2022, Daniel Stenberg, <daniel@haxx.se>, et al. +c: Copyright (C) Daniel Stenberg, <daniel@haxx.se>, et al. SPDX-License-Identifier: curl Long: cert-type Protocols: TLS diff --git a/docs/cmdline-opts/cert.d b/docs/cmdline-opts/cert.d index 54c5cb0a0..56d0df7fd 100644 --- a/docs/cmdline-opts/cert.d +++ b/docs/cmdline-opts/cert.d @@ -1,4 +1,4 @@ -c: Copyright (C) 1998 - 2022, Daniel Stenberg, <daniel@haxx.se>, et al. +c: Copyright (C) Daniel Stenberg, <daniel@haxx.se>, et al. SPDX-License-Identifier: curl Short: E Long: cert @@ -14,7 +14,7 @@ Multi: single 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 PKCS#12 format if using Secure Transport, or PEM format if using any other -engine. If the optional password is not specified, it will be queried for on +engine. If the optional password is not specified, it is queried for on the terminal. Note that this option assumes a certificate file that is the private key and the client certificate concatenated. See --cert and --key to specify them independently. @@ -24,21 +24,12 @@ as "\\:" so that it is not recognized as the password delimiter. Similarly, you must escape the character "\\" as "\\\\" so that it is not recognized as an escape character. -If curl is built against the NSS SSL library then this option can tell -curl the nickname of the certificate to use within the NSS database defined -by the environment variable SSL_DIR (or by default /etc/pki/nssdb). If the -NSS PEM PKCS#11 module (libnsspem.so) is available then PEM files may be -loaded. - -If you provide a path relative to the current directory, you must prefix the -path with "./" in order to avoid confusion with an NSS database nickname. - If curl is built against OpenSSL library, and the engine pkcs11 is available, then a PKCS#11 URI (RFC 7512) can be used to specify a certificate located in -a PKCS#11 device. A string beginning with "pkcs11:" will be interpreted as a -PKCS#11 URI. If a PKCS#11 URI is provided, then the --engine option will be set -as "pkcs11" if none was provided and the --cert-type option will be set as -"ENG" if none was provided. +a PKCS#11 device. A string beginning with "pkcs11:" is interpreted as a +PKCS#11 URI. If a PKCS#11 URI is provided, then the --engine option is set as +"pkcs11" if none was provided and the --cert-type option is set as "ENG" if +none was provided. (iOS and macOS only) If curl is built against Secure Transport, then the certificate string can either be the name of a certificate/private key in the @@ -47,12 +38,12 @@ private key. If you want to use a file from the current directory, please precede it with "./" prefix, in order to avoid confusion with a nickname. (Schannel only) Client certificates must be specified by a path -expression to a certificate store. (Loading PFX is not supported; you can +expression to a certificate store. (Loading *PFX* is not supported; you can import it to a store first). You can use "<store location>\\<store name>\\<thumbprint>" to refer to a certificate in the system certificates store, for example, -"CurrentUser\\MY\\934a7ac6f8a5d579285a74fa61e19f23ddfe8d7a". Thumbprint is +*"CurrentUser\\MY\\934a7ac6f8a5d579285a74fa61e19f23ddfe8d7a"*. Thumbprint is usually a SHA-1 hex string which you can see in certificate details. Following -store locations are supported: CurrentUser, LocalMachine, CurrentService, -Services, CurrentUserGroupPolicy, LocalMachineGroupPolicy, -LocalMachineEnterprise. +store locations are supported: *CurrentUser*, *LocalMachine*, *CurrentService*, +*Services*, *CurrentUserGroupPolicy*, *LocalMachineGroupPolicy* and +*LocalMachineEnterprise*. diff --git a/docs/cmdline-opts/ciphers.d b/docs/cmdline-opts/ciphers.d index e64a3f6a0..a30902bdb 100644 --- a/docs/cmdline-opts/ciphers.d +++ b/docs/cmdline-opts/ciphers.d @@ -1,11 +1,11 @@ -c: Copyright (C) 1998 - 2022, Daniel Stenberg, <daniel@haxx.se>, et al. +c: Copyright (C) Daniel Stenberg, <daniel@haxx.se>, et al. SPDX-License-Identifier: curl Long: ciphers Arg: <list of ciphers> Help: SSL ciphers to use Protocols: TLS Category: tls -See-also: tlsv1.3 +See-also: tlsv1.3 tls13-ciphers proxy-ciphers Example: --ciphers ECDHE-ECDSA-AES256-CCM8 $URL Added: 7.9 Multi: single @@ -13,4 +13,4 @@ Multi: single 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: - https://curl.se/docs/ssl-ciphers.html +https://curl.se/docs/ssl-ciphers.html diff --git a/docs/cmdline-opts/compressed-ssh.d b/docs/cmdline-opts/compressed-ssh.d index 0521a2ba4..897395677 100644 --- a/docs/cmdline-opts/compressed-ssh.d +++ b/docs/cmdline-opts/compressed-ssh.d @@ -1,4 +1,4 @@ -c: Copyright (C) 1998 - 2022, Daniel Stenberg, <daniel@haxx.se>, et al. +c: Copyright (C) Daniel Stenberg, <daniel@haxx.se>, et al. SPDX-License-Identifier: curl Long: compressed-ssh Help: Enable SSH compression diff --git a/docs/cmdline-opts/compressed.d b/docs/cmdline-opts/compressed.d index f3b03c672..bb1d3baa7 100644 --- a/docs/cmdline-opts/compressed.d +++ b/docs/cmdline-opts/compressed.d @@ -1,4 +1,4 @@ -c: Copyright (C) 1998 - 2022, Daniel Stenberg, <daniel@haxx.se>, et al. +c: Copyright (C) Daniel Stenberg, <daniel@haxx.se>, et al. SPDX-License-Identifier: curl Long: compressed Help: Request compressed response @@ -10,8 +10,12 @@ Added: 7.10 Multi: boolean --- Request a compressed response using one of the algorithms curl supports, and -automatically decompress the content. Headers are not modified. +automatically decompress the content. -If this option is used and the server sends an unsupported encoding, curl will -report an error. This is a request, not an order; the server may or may not +Response headers are not modified when saved, so if they are "interpreted" +separately again at a later point they might appear to be saying that the +content is (still) compressed; while in fact it has already been decompressed. + +If this option is used and the server sends an unsupported encoding, curl +reports an error. This is a request, not an order; the server may or may not deliver data compressed. diff --git a/docs/cmdline-opts/config.d b/docs/cmdline-opts/config.d index 84456f627..c22a827f6 100644 --- a/docs/cmdline-opts/config.d +++ b/docs/cmdline-opts/config.d @@ -1,4 +1,4 @@ -c: Copyright (C) 1998 - 2022, Daniel Stenberg, <daniel@haxx.se>, et al. +c: Copyright (C) Daniel Stenberg, <daniel@haxx.se>, et al. SPDX-License-Identifier: curl Long: config Arg: <file> @@ -11,7 +11,7 @@ See-also: disable Multi: append --- Specify a text file to read curl arguments from. The command line arguments -found in the text file will be used as if they were provided on the command +found in the text file are used as if they were provided on the command line. Options and their parameters must be specified on the same line in the file, @@ -21,15 +21,16 @@ if so, the colon or equals characters can be used as separators. If the option is specified with one or two dashes, there can be no colon or equals character between the option and its parameter. -If the parameter contains whitespace (or starts with : or =), the parameter -must be enclosed within quotes. Within double quotes, the following escape -sequences are available: \\\\, \\", \\t, \\n, \\r and \\v. A backslash -preceding any other letter is ignored. +If the parameter contains whitespace or starts with a colon (:) or equals sign +(=), it must be specified enclosed within double quotes (\&"). Within double +quotes the following escape sequences are available: \\\\, \\", \\t, \\n, \\r +and \\v. A backslash preceding any other letter is ignored. -If the first column of a config line is a '#' character, the rest of the line -will be treated as a comment. +If the first non-blank column of a config line is a '#' character, that line +is treated as a comment. -Only write one option per physical line in the config file. +Only write one option per physical line in the config file. A single line is +required to be no more than 10 megabytes (since 8.2.0). Specify the filename to --config as '-' to make curl read the file from stdin. @@ -55,22 +56,22 @@ When curl is invoked, it (unless --disable is used) checks for a default config file and uses it if found, even when --config is used. The default config file is checked for in the following places in this order: -1) "$CURL_HOME/.curlrc" +1) **"$CURL_HOME/.curlrc"** -2) "$XDG_CONFIG_HOME/.curlrc" (Added in 7.73.0) +2) **"$XDG_CONFIG_HOME/curlrc"** (Added in 7.73.0) -3) "$HOME/.curlrc" +3) **"$HOME/.curlrc"** -4) Windows: "%USERPROFILE%\\.curlrc" +4) Windows: **"%USERPROFILE%\\.curlrc"** -5) Windows: "%APPDATA%\\.curlrc" +5) Windows: **"%APPDATA%\\.curlrc"** -6) Windows: "%USERPROFILE%\\Application Data\\.curlrc" +6) Windows: **"%USERPROFILE%\\Application Data\\.curlrc"** 7) Non-Windows: use getpwuid to find the home directory -8) On Windows, if it finds no .curlrc file in the sequence described above, it +8) On Windows, if it finds no *.curlrc* file in the sequence described above, it checks for one in the same dir the curl executable is placed. -On Windows two filenames are checked per location: .curlrc and _curlrc, -preferring the former. Older versions on Windows checked for _curlrc only. +On Windows two filenames are checked per location: *.curlrc* and *_curlrc*, +preferring the former. Older versions on Windows checked for *_curlrc* only. diff --git a/docs/cmdline-opts/connect-timeout.d b/docs/cmdline-opts/connect-timeout.d index 6a2889d21..b3d19b3c3 100644 --- a/docs/cmdline-opts/connect-timeout.d +++ b/docs/cmdline-opts/connect-timeout.d @@ -1,4 +1,4 @@ -c: Copyright (C) 1998 - 2022, Daniel Stenberg, <daniel@haxx.se>, et al. +c: Copyright (C) Daniel Stenberg, <daniel@haxx.se>, et al. SPDX-License-Identifier: curl Long: connect-timeout Arg: <fractional seconds> @@ -12,5 +12,11 @@ Multi: single --- 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 -will continue - if not it will exit. Since version 7.32.0, this option -accepts decimal values. +continues - if not it exits. + +This option accepts decimal values (added in 7.32.0). The decimal value needs +to be provided using a dot (.) as decimal separator - not the local version +even if it might be using another separator. + +The connection phase is considered complete when the DNS lookup and requested +TCP, TLS or QUIC handshakes are done. diff --git a/docs/cmdline-opts/connect-to.d b/docs/cmdline-opts/connect-to.d index 040ea19dd..95fab9112 100644 --- a/docs/cmdline-opts/connect-to.d +++ b/docs/cmdline-opts/connect-to.d @@ -1,4 +1,4 @@ -c: Copyright (C) 1998 - 2022, Daniel Stenberg, <daniel@haxx.se>, et al. +c: Copyright (C) Daniel Stenberg, <daniel@haxx.se>, et al. SPDX-License-Identifier: curl Long: connect-to Arg: <HOST1:PORT1:HOST2:PORT2> diff --git a/docs/cmdline-opts/continue-at.d b/docs/cmdline-opts/continue-at.d index 726171a41..a4fc1a969 100644 --- a/docs/cmdline-opts/continue-at.d +++ b/docs/cmdline-opts/continue-at.d @@ -1,4 +1,4 @@ -c: Copyright (C) 1998 - 2022, Daniel Stenberg, <daniel@haxx.se>, et al. +c: Copyright (C) Daniel Stenberg, <daniel@haxx.se>, et al. SPDX-License-Identifier: curl Short: C Long: continue-at @@ -12,9 +12,9 @@ Added: 4.8 Multi: single --- 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 are skipped, counting from the beginning of the source file before it is transferred to the destination. If used with -uploads, the FTP server command SIZE will not be used by curl. +uploads, the FTP server command SIZE is not used by curl. Use "-C -" to tell curl to automatically find out where/how to resume the transfer. It then uses the given output/input files to figure that out. diff --git a/docs/cmdline-opts/cookie-jar.d b/docs/cmdline-opts/cookie-jar.d index 2f3b8e9e6..28738cac9 100644 --- a/docs/cmdline-opts/cookie-jar.d +++ b/docs/cmdline-opts/cookie-jar.d @@ -1,4 +1,4 @@ -c: Copyright (C) 1998 - 2022, Daniel Stenberg, <daniel@haxx.se>, et al. +c: Copyright (C) Daniel Stenberg, <daniel@haxx.se>, et al. SPDX-License-Identifier: curl Short: c Long: cookie-jar @@ -14,16 +14,18 @@ Multi: single --- 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 -given file at the end of operations. If no cookies are known, no data will be -written. The file will be written using the Netscape cookie file format. If -you set the file name to a single dash, "-", the cookies will be written to -stdout. +given file at the end of operations. If no cookies are known, no data is +written. The file is created using the Netscape cookie file format. If you set +the file name to a single dash, "-", the cookies are written to stdout. -This command line option will activate the cookie engine that makes curl -record and use cookies. Another way to activate it is to use the --cookie -option. +The file specified with --cookie-jar is only used for output. No cookies are +read from the file. To read cookies, use the --cookie option. Both options +can specify the same file. + +This command line option activates the cookie engine that makes curl record +and use cookies. The --cookie option also activates it. If the cookie jar cannot be created or written to, the whole curl operation -will not fail or even report an error clearly. Using --verbose will get a -warning displayed, but that is the only visible feedback you get about this -possibly lethal situation. +does not fail or even report an error clearly. Using --verbose gets a warning +displayed, but that is the only visible feedback you get about this possibly +lethal situation. diff --git a/docs/cmdline-opts/cookie.d b/docs/cmdline-opts/cookie.d index 2b736539e..0f858d661 100644 --- a/docs/cmdline-opts/cookie.d +++ b/docs/cmdline-opts/cookie.d @@ -1,4 +1,4 @@ -c: Copyright (C) 1998 - 2022, Daniel Stenberg, <daniel@haxx.se>, et al. +c: Copyright (C) Daniel Stenberg, <daniel@haxx.se>, et al. SPDX-License-Identifier: curl Short: b Long: cookie @@ -17,25 +17,25 @@ data previously received from the server in a "Set-Cookie:" line. The data should be in the format "NAME1=VALUE1; NAME2=VALUE2". This makes curl use the cookie header with this content explicitly in all outgoing request(s). If multiple requests are done due to authentication, followed redirects or -similar, they will all get this cookie passed on. +similar, they all get this cookie passed on. If no '=' symbol is used in the argument, it is instead treated as a filename to read previously stored cookie from. This option also activates the cookie -engine which will make curl record incoming cookies, which may be handy if -you are using this in combination with the --location option or do multiple URL +engine which makes curl record incoming cookies, which may be handy if you are +using this in combination with the --location option or do multiple URL transfers on the same invoke. If the file name is exactly a minus ("-"), curl -will instead read the contents from stdin. +instead reads the contents from stdin. The file format of the file to read cookies from should be plain HTTP headers (Set-Cookie style) or the Netscape/Mozilla cookie file format. -The file specified with --cookie is only used as input. No cookies will be -written to the file. To store cookies, use the --cookie-jar option. +The file specified with --cookie is only used as input. No cookies are written +to the file. To store cookies, use the --cookie-jar option. If you use the Set-Cookie file format and do not specify a domain then the -cookie is not sent since the domain will never match. To address this, set a -domain in Set-Cookie line (doing that will include sub-domains) or preferably: -use the Netscape format. +cookie is not sent since the domain never matches. To address this, set a +domain in Set-Cookie line (doing that includes subdomains) or preferably: use +the Netscape format. Users often want to both read cookies from a file and write updated cookies back to a file, so using both --cookie and --cookie-jar in the same command diff --git a/docs/cmdline-opts/create-dirs.d b/docs/cmdline-opts/create-dirs.d index 01b7ccf92..966b70384 100644 --- a/docs/cmdline-opts/create-dirs.d +++ b/docs/cmdline-opts/create-dirs.d @@ -1,4 +1,4 @@ -c: Copyright (C) 1998 - 2022, Daniel Stenberg, <daniel@haxx.se>, et al. +c: Copyright (C) Daniel Stenberg, <daniel@haxx.se>, et al. SPDX-License-Identifier: curl Long: create-dirs Help: Create necessary local directory hierarchy @@ -8,12 +8,12 @@ Added: 7.10.3 See-also: ftp-create-dirs output-dir Multi: boolean --- -When used in conjunction with the --output option, curl will create the -necessary local directory hierarchy as needed. This option creates the -directories mentioned with the --output option, nothing else. If the --output -file name uses no directory, or if the directories it mentions already exist, -no directories will be created. +When used in conjunction with the --output option, curl creates the necessary +local directory hierarchy as needed. This option creates the directories +mentioned with the --output option combined with the path possibly set with +--output-dir. If the combined output file name uses no directory, or if the +directories it mentions already exist, no directories are created. -Created dirs are made with mode 0750 on unix style file systems. +Created directories are made with mode 0750 on unix style file systems. To create remote directories when using FTP or SFTP, try --ftp-create-dirs. diff --git a/docs/cmdline-opts/create-file-mode.d b/docs/cmdline-opts/create-file-mode.d index 32e6e84bf..c0ebc08d4 100644 --- a/docs/cmdline-opts/create-file-mode.d +++ b/docs/cmdline-opts/create-file-mode.d @@ -1,4 +1,4 @@ -c: Copyright (C) 1998 - 2022, Daniel Stenberg, <daniel@haxx.se>, et al. +c: Copyright (C) Daniel Stenberg, <daniel@haxx.se>, et al. SPDX-License-Identifier: curl Long: create-file-mode Arg: <mode> diff --git a/docs/cmdline-opts/crlf.d b/docs/cmdline-opts/crlf.d index f19a5b25d..ea7fb1526 100644 --- a/docs/cmdline-opts/crlf.d +++ b/docs/cmdline-opts/crlf.d @@ -1,4 +1,4 @@ -c: Copyright (C) 1998 - 2022, Daniel Stenberg, <daniel@haxx.se>, et al. +c: Copyright (C) Daniel Stenberg, <daniel@haxx.se>, et al. SPDX-License-Identifier: curl Long: crlf Help: Convert LF to CRLF in upload @@ -9,6 +9,7 @@ Added: 5.7 See-also: use-ascii Multi: boolean --- -Convert LF to CRLF in upload. Useful for MVS (OS/390). +Convert line feeds to carriage return plus line feeds in upload. Useful for +**MVS (OS/390)**. (SMTP added in 7.40.0) diff --git a/docs/cmdline-opts/crlfile.d b/docs/cmdline-opts/crlfile.d index deb54e124..da0d239ba 100644 --- a/docs/cmdline-opts/crlfile.d +++ b/docs/cmdline-opts/crlfile.d @@ -1,4 +1,4 @@ -c: Copyright (C) 1998 - 2022, Daniel Stenberg, <daniel@haxx.se>, et al. +c: Copyright (C) Daniel Stenberg, <daniel@haxx.se>, et al. SPDX-License-Identifier: curl Long: crlfile Arg: <file> diff --git a/docs/cmdline-opts/curves.d b/docs/cmdline-opts/curves.d index 84f1291d8..58d472d20 100644 --- a/docs/cmdline-opts/curves.d +++ b/docs/cmdline-opts/curves.d @@ -1,4 +1,4 @@ -c: Copyright (C) 1998 - 2022, Daniel Stenberg, <daniel@haxx.se>, et al. +c: Copyright (C) Daniel Stenberg, <daniel@haxx.se>, et al. SPDX-License-Identifier: curl Long: curves Arg: <algorithm list> @@ -19,5 +19,4 @@ in the "openssl s_client/s_server" utilities. the (EC) curve requested by the client, avoiding nontransparent client/server negotiations. -If this option is set, the default curves list built into openssl will be -ignored. +If this option is set, the default curves list built into OpenSSL are ignored. diff --git a/docs/cmdline-opts/data-ascii.d b/docs/cmdline-opts/data-ascii.d index 4f9bdb1d3..5c7840bbc 100644 --- a/docs/cmdline-opts/data-ascii.d +++ b/docs/cmdline-opts/data-ascii.d @@ -1,4 +1,4 @@ -c: Copyright (C) 1998 - 2022, Daniel Stenberg, <daniel@haxx.se>, et al. +c: Copyright (C) Daniel Stenberg, <daniel@haxx.se>, et al. SPDX-License-Identifier: curl Long: data-ascii Arg: <data> diff --git a/docs/cmdline-opts/data-binary.d b/docs/cmdline-opts/data-binary.d index c1c9b20d1..2cedda97b 100644 --- a/docs/cmdline-opts/data-binary.d +++ b/docs/cmdline-opts/data-binary.d @@ -1,4 +1,4 @@ -c: Copyright (C) 1998 - 2022, Daniel Stenberg, <daniel@haxx.se>, et al. +c: Copyright (C) Daniel Stenberg, <daniel@haxx.se>, et al. SPDX-License-Identifier: curl Long: data-binary Arg: <data> @@ -21,5 +21,5 @@ application/x-www-form-urlencoded. If you want the data to be treated as arbitrary binary data by the server then set the content-type to octet-stream: -H "Content-Type: application/octet-stream". -If this option is used several times, the ones following the first will append +If this option is used several times, the ones following the first append data as described in --data. diff --git a/docs/cmdline-opts/data-raw.d b/docs/cmdline-opts/data-raw.d index 8ec29fad8..e6a5a5b2b 100644 --- a/docs/cmdline-opts/data-raw.d +++ b/docs/cmdline-opts/data-raw.d @@ -1,4 +1,4 @@ -c: Copyright (C) 1998 - 2022, Daniel Stenberg, <daniel@haxx.se>, et al. +c: Copyright (C) Daniel Stenberg, <daniel@haxx.se>, et al. SPDX-License-Identifier: curl Long: data-raw Arg: <data> diff --git a/docs/cmdline-opts/data-urlencode.d b/docs/cmdline-opts/data-urlencode.d index e9adc4563..3c436b26b 100644 --- a/docs/cmdline-opts/data-urlencode.d +++ b/docs/cmdline-opts/data-urlencode.d @@ -1,4 +1,4 @@ -c: Copyright (C) 1998 - 2022, Daniel Stenberg, <daniel@haxx.se>, et al. +c: Copyright (C) Daniel Stenberg, <daniel@haxx.se>, et al. SPDX-License-Identifier: curl Long: data-urlencode Arg: <data> @@ -21,21 +21,22 @@ by a separator and a content specification. The <data> part can be passed to curl using one of the following syntaxes: .RS .IP "content" -This will make curl URL-encode the content and pass that on. Just be careful -so that the content does not contain any = or @ symbols, as that will then make +This makes curl URL-encode the content and pass that on. Just be careful +so that the content does not contain any = or @ symbols, as that makes the syntax match one of the other cases below! .IP "=content" -This will make curl URL-encode the content and pass that on. The preceding = +This makes curl URL-encode the content and pass that on. The preceding = symbol is not included in the data. .IP "name=content" -This will make curl URL-encode the content part and pass that on. Note that +This makes curl URL-encode the content part and pass that on. Note that the name part is expected to be URL-encoded already. .IP "@filename" -This will make curl load data from the given file (including any newlines), +This makes curl load data from the given file (including any newlines), URL-encode that data and pass it on in the POST. .IP "name@filename" -This will make curl load data from the given file (including any newlines), +This makes curl load data from the given file (including any newlines), URL-encode that data and pass it on in the POST. The name part gets an equal sign appended, resulting in *name=urlencoded-file-content*. Note that the name is expected to be URL-encoded already. .RE +.IP diff --git a/docs/cmdline-opts/data.d b/docs/cmdline-opts/data.d index 628b15069..f1d67b950 100644 --- a/docs/cmdline-opts/data.d +++ b/docs/cmdline-opts/data.d @@ -1,4 +1,4 @@ -c: Copyright (C) 1998 - 2022, Daniel Stenberg, <daniel@haxx.se>, et al. +c: Copyright (C) Daniel Stenberg, <daniel@haxx.se>, et al. SPDX-License-Identifier: curl Long: data Short: d @@ -16,7 +16,7 @@ Multi: append --- 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 -submit button. This will cause curl to pass the data to the server using the +submit button. This makes curl pass the data to the server using the content-type application/x-www-form-urlencoded. Compare to --form. --data-raw is almost the same but does not have a special interpretation of @@ -25,7 +25,7 @@ the @ character. To post data purely binary, you should instead use the --data-urlencode. If any of these options is used more than once on the same command line, the -data pieces specified will be merged with a separating &-symbol. Thus, using +data pieces specified are merged with a separating &-symbol. Thus, using '-d name=daniel -d skill=lousy' would generate a post chunk that looks like 'name=daniel&skill=lousy'. @@ -33,5 +33,9 @@ If you start the data with the letter @, the rest should be a file name to read the data from, or - if you want curl to read the data from stdin. Posting data from a file named 'foobar' would thus be done with --data @foobar. When --data is told to read from a file like that, carriage returns and newlines -will be stripped out. If you do not want the @ character to have a special +are stripped out. If you do not want the @ character to have a special interpretation use --data-raw instead. + +The data for this option is passed on to the server exactly as provided on the +command line. curl does not convert, change or improve it. It is up to the +user to provide the data in the correct form. diff --git a/docs/cmdline-opts/delegation.d b/docs/cmdline-opts/delegation.d index c4659d844..794184934 100644 --- a/docs/cmdline-opts/delegation.d +++ b/docs/cmdline-opts/delegation.d @@ -1,4 +1,4 @@ -c: Copyright (C) 1998 - 2022, Daniel Stenberg, <daniel@haxx.se>, et al. +c: Copyright (C) Daniel Stenberg, <daniel@haxx.se>, et al. SPDX-License-Identifier: curl Long: delegation Arg: <LEVEL> @@ -21,3 +21,4 @@ service ticket, which is a matter of realm policy. .IP "always" Unconditionally allow the server to delegate. .RE +.IP diff --git a/docs/cmdline-opts/digest.d b/docs/cmdline-opts/digest.d index c42486f04..f2ee551c5 100644 --- a/docs/cmdline-opts/digest.d +++ b/docs/cmdline-opts/digest.d @@ -1,4 +1,4 @@ -c: Copyright (C) 1998 - 2022, Daniel Stenberg, <daniel@haxx.se>, et al. +c: Copyright (C) Daniel Stenberg, <daniel@haxx.se>, et al. SPDX-License-Identifier: curl Long: digest Help: Use HTTP Digest Authentication diff --git a/docs/cmdline-opts/disable-eprt.d b/docs/cmdline-opts/disable-eprt.d index 8a21fed8d..b6d382baf 100644 --- a/docs/cmdline-opts/disable-eprt.d +++ b/docs/cmdline-opts/disable-eprt.d @@ -1,4 +1,4 @@ -c: Copyright (C) 1998 - 2022, Daniel Stenberg, <daniel@haxx.se>, et al. +c: Copyright (C) Daniel Stenberg, <daniel@haxx.se>, et al. SPDX-License-Identifier: curl Long: disable-eprt Help: Inhibit using EPRT or LPRT @@ -10,17 +10,16 @@ See-also: disable-epsv ftp-port Multi: boolean --- 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 -before using PORT, but with this option, it will use PORT right away. EPRT and -LPRT are extensions to the original FTP protocol, and may not work on all -servers, but they enable more functionality in a better way than the -traditional PORT command. +FTP transfers. Curl normally first attempts to use EPRT before using PORT, but +with this option, it uses PORT right away. EPRT is an extension to the +original FTP protocol, and does not work on all servers, but enables more +functionality in a better way than the traditional PORT command. --eprt can be used to explicitly enable EPRT again and --no-eprt is an alias for --disable-eprt. -If the server is accessed using IPv6, this option will have no effect as EPRT -is necessary then. +If the server is accessed using IPv6, this option has no effect as EPRT is +necessary then. Disabling EPRT only changes the active behavior. If you want to switch to passive mode you need to not use --ftp-port or force it with --ftp-pasv. diff --git a/docs/cmdline-opts/disable-epsv.d b/docs/cmdline-opts/disable-epsv.d index 3f58f508c..f02df763d 100644 --- a/docs/cmdline-opts/disable-epsv.d +++ b/docs/cmdline-opts/disable-epsv.d @@ -1,4 +1,4 @@ -c: Copyright (C) 1998 - 2022, Daniel Stenberg, <daniel@haxx.se>, et al. +c: Copyright (C) Daniel Stenberg, <daniel@haxx.se>, et al. SPDX-License-Identifier: curl Long: disable-epsv Help: Inhibit using EPSV @@ -10,14 +10,14 @@ See-also: disable-eprt ftp-port Multi: boolean --- 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 -PASV, but with this option, it will not try using EPSV. +transfers. Curl normally first attempts to use EPSV before PASV, but with this +option, it does not try EPSV. --epsv can be used to explicitly enable EPSV again and --no-epsv is an alias for --disable-epsv. -If the server is an IPv6 host, this option will have no effect as EPSV is -necessary then. +If the server is an IPv6 host, this option has no effect as EPSV is necessary +then. Disabling EPSV only changes the passive behavior. If you want to switch to active mode you need to use --ftp-port. diff --git a/docs/cmdline-opts/disable.d b/docs/cmdline-opts/disable.d index 4ce33cd61..979c03991 100644 --- a/docs/cmdline-opts/disable.d +++ b/docs/cmdline-opts/disable.d @@ -1,4 +1,4 @@ -c: Copyright (C) 1998 - 2022, Daniel Stenberg, <daniel@haxx.se>, et al. +c: Copyright (C) Daniel Stenberg, <daniel@haxx.se>, et al. SPDX-License-Identifier: curl Long: disable Short: q @@ -9,6 +9,9 @@ Added: 5.0 See-also: config Multi: boolean --- -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 -config file search path. +If used as the **first** parameter on the command line, the *curlrc* config +file is not read or used. See the --config for details on the default config +file search path. + +Prior to 7.50.0 curl supported the short option name *q* but not the long +option name *disable*. diff --git a/docs/cmdline-opts/disallow-username-in-url.d b/docs/cmdline-opts/disallow-username-in-url.d index 3e1de348a..d0537db97 100644 --- a/docs/cmdline-opts/disallow-username-in-url.d +++ b/docs/cmdline-opts/disallow-username-in-url.d @@ -1,4 +1,4 @@ -c: Copyright (C) 1998 - 2022, Daniel Stenberg, <daniel@haxx.se>, et al. +c: Copyright (C) Daniel Stenberg, <daniel@haxx.se>, et al. SPDX-License-Identifier: curl Long: disallow-username-in-url Help: Disallow username in URL diff --git a/docs/cmdline-opts/dns-interface.d b/docs/cmdline-opts/dns-interface.d index 8cd4d1347..fd924b897 100644 --- a/docs/cmdline-opts/dns-interface.d +++ b/docs/cmdline-opts/dns-interface.d @@ -1,4 +1,4 @@ -c: Copyright (C) 1998 - 2022, Daniel Stenberg, <daniel@haxx.se>, et al. +c: Copyright (C) Daniel Stenberg, <daniel@haxx.se>, et al. SPDX-License-Identifier: curl Long: dns-interface Arg: <interface> diff --git a/docs/cmdline-opts/dns-ipv4-addr.d b/docs/cmdline-opts/dns-ipv4-addr.d index 358bec368..593055739 100644 --- a/docs/cmdline-opts/dns-ipv4-addr.d +++ b/docs/cmdline-opts/dns-ipv4-addr.d @@ -1,4 +1,4 @@ -c: Copyright (C) 1998 - 2022, Daniel Stenberg, <daniel@haxx.se>, et al. +c: Copyright (C) Daniel Stenberg, <daniel@haxx.se>, et al. SPDX-License-Identifier: curl Long: dns-ipv4-addr Arg: <address> @@ -11,6 +11,6 @@ Category: dns Example: --dns-ipv4-addr 10.1.2.3 $URL Multi: single --- -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 +Tell curl to bind to a specific IP address when making IPv4 DNS requests, so +that the DNS requests originate from this address. The argument should be a single IPv4 address. diff --git a/docs/cmdline-opts/dns-ipv6-addr.d b/docs/cmdline-opts/dns-ipv6-addr.d index 945265686..a76120cdc 100644 --- a/docs/cmdline-opts/dns-ipv6-addr.d +++ b/docs/cmdline-opts/dns-ipv6-addr.d @@ -1,4 +1,4 @@ -c: Copyright (C) 1998 - 2022, Daniel Stenberg, <daniel@haxx.se>, et al. +c: Copyright (C) Daniel Stenberg, <daniel@haxx.se>, et al. SPDX-License-Identifier: curl Long: dns-ipv6-addr Arg: <address> @@ -11,6 +11,6 @@ Category: dns Example: --dns-ipv6-addr 2a04:4e42::561 $URL Multi: single --- -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 +Tell curl to bind to a specific IP address when making IPv6 DNS requests, so +that the DNS requests originate from this address. The argument should be a single IPv6 address. diff --git a/docs/cmdline-opts/dns-servers.d b/docs/cmdline-opts/dns-servers.d index ff0705122..bec23a3c3 100644 --- a/docs/cmdline-opts/dns-servers.d +++ b/docs/cmdline-opts/dns-servers.d @@ -1,4 +1,4 @@ -c: Copyright (C) 1998 - 2022, Daniel Stenberg, <daniel@haxx.se>, et al. +c: Copyright (C) Daniel Stenberg, <daniel@haxx.se>, et al. SPDX-License-Identifier: curl Long: dns-servers Arg: <addresses> diff --git a/docs/cmdline-opts/doh-cert-status.d b/docs/cmdline-opts/doh-cert-status.d index 534c79529..37ae0f827 100644 --- a/docs/cmdline-opts/doh-cert-status.d +++ b/docs/cmdline-opts/doh-cert-status.d @@ -1,4 +1,4 @@ -c: Copyright (C) 1998 - 2022, Daniel Stenberg, <daniel@haxx.se>, et al. +c: Copyright (C) Daniel Stenberg, <daniel@haxx.se>, et al. SPDX-License-Identifier: curl Long: doh-cert-status Help: Verify the status of the DoH server cert via OCSP-staple diff --git a/docs/cmdline-opts/doh-insecure.d b/docs/cmdline-opts/doh-insecure.d index 30c44bba3..dcc65fb6c 100644 --- a/docs/cmdline-opts/doh-insecure.d +++ b/docs/cmdline-opts/doh-insecure.d @@ -1,4 +1,4 @@ -c: Copyright (C) 1998 - 2022, Daniel Stenberg, <daniel@haxx.se>, et al. +c: Copyright (C) Daniel Stenberg, <daniel@haxx.se>, et al. SPDX-License-Identifier: curl Long: doh-insecure Help: Allow insecure DoH server connections diff --git a/docs/cmdline-opts/doh-url.d b/docs/cmdline-opts/doh-url.d index 4717a6ac6..6d0dd1605 100644 --- a/docs/cmdline-opts/doh-url.d +++ b/docs/cmdline-opts/doh-url.d @@ -1,4 +1,4 @@ -c: Copyright (C) 1998 - 2022, Daniel Stenberg, <daniel@haxx.se>, et al. +c: Copyright (C) Daniel Stenberg, <daniel@haxx.se>, et al. SPDX-License-Identifier: curl Long: doh-url Arg: <URL> @@ -12,10 +12,10 @@ Multi: single 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. -Some SSL options that you set for your transfer will apply to DoH since the +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 -settings are not inherited and can be controlled separately via ---doh-insecure and --doh-cert-status. +settings are not inherited but are controlled separately via --doh-insecure +and --doh-cert-status. -This option is unset if an empty string "" is used as the URL. (Added in -7.85.0) +This option is unset if an empty string "" is used as the URL. +(Added in 7.85.0) diff --git a/docs/cmdline-opts/dump-header.d b/docs/cmdline-opts/dump-header.d index 3dabac85e..42a79e7dd 100644 --- a/docs/cmdline-opts/dump-header.d +++ b/docs/cmdline-opts/dump-header.d @@ -1,4 +1,4 @@ -c: Copyright (C) 1998 - 2022, Daniel Stenberg, <daniel@haxx.se>, et al. +c: Copyright (C) Daniel Stenberg, <daniel@haxx.se>, et al. SPDX-License-Identifier: curl Long: dump-header Short: D @@ -12,7 +12,10 @@ Added: 5.7 Multi: single --- 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 creates an empty file. When used in FTP, the FTP server response lines are considered being "headers" and thus are saved there. + +Having multiple transfers in one set of operations (i.e. the URLs in one +--next clause), appends them to the same file, separated by a blank line. diff --git a/docs/cmdline-opts/egd-file.d b/docs/cmdline-opts/egd-file.d index b6661c773..4543ecf15 100644 --- a/docs/cmdline-opts/egd-file.d +++ b/docs/cmdline-opts/egd-file.d @@ -1,4 +1,4 @@ -c: Copyright (C) 1998 - 2022, Daniel Stenberg, <daniel@haxx.se>, et al. +c: Copyright (C) Daniel Stenberg, <daniel@haxx.se>, et al. SPDX-License-Identifier: curl Long: egd-file Arg: <file> @@ -10,8 +10,8 @@ Example: --egd-file /random/here $URL Added: 7.7 Multi: single --- -Deprecated option. This option is ignored by curl since 7.84.0. Prior to that -it only had an effect on curl if built to use old versions of OpenSSL. +Deprecated option (added in 7.84.0). Prior to that it only had an effect on +curl if built to use old versions of OpenSSL. Specify the path name to the Entropy Gathering Daemon socket. The socket is used to seed the random engine for SSL connections. diff --git a/docs/cmdline-opts/engine.d b/docs/cmdline-opts/engine.d index 58578ea8f..1ebc779c0 100644 --- a/docs/cmdline-opts/engine.d +++ b/docs/cmdline-opts/engine.d @@ -1,4 +1,4 @@ -c: Copyright (C) 1998 - 2022, Daniel Stenberg, <daniel@haxx.se>, et al. +c: Copyright (C) Daniel Stenberg, <daniel@haxx.se>, et al. SPDX-License-Identifier: curl Long: engine Arg: <name> diff --git a/docs/cmdline-opts/etag-compare.d b/docs/cmdline-opts/etag-compare.d index 12c786790..d3c48d17a 100644 --- a/docs/cmdline-opts/etag-compare.d +++ b/docs/cmdline-opts/etag-compare.d @@ -1,4 +1,4 @@ -c: Copyright (C) 1998 - 2022, Daniel Stenberg, <daniel@haxx.se>, et al. +c: Copyright (C) Daniel Stenberg, <daniel@haxx.se>, et al. SPDX-License-Identifier: curl Long: etag-compare Arg: <file> diff --git a/docs/cmdline-opts/etag-save.d b/docs/cmdline-opts/etag-save.d index 2f44c0f7d..6295a9e31 100644 --- a/docs/cmdline-opts/etag-save.d +++ b/docs/cmdline-opts/etag-save.d @@ -1,4 +1,4 @@ -c: Copyright (C) 1998 - 2022, Daniel Stenberg, <daniel@haxx.se>, et al. +c: Copyright (C) Daniel Stenberg, <daniel@haxx.se>, et al. SPDX-License-Identifier: curl Long: etag-save Arg: <file> diff --git a/docs/cmdline-opts/expect100-timeout.d b/docs/cmdline-opts/expect100-timeout.d index 93e3c633e..f9a119bd9 100644 --- a/docs/cmdline-opts/expect100-timeout.d +++ b/docs/cmdline-opts/expect100-timeout.d @@ -1,4 +1,4 @@ -c: Copyright (C) 1998 - 2022, Daniel Stenberg, <daniel@haxx.se>, et al. +c: Copyright (C) Daniel Stenberg, <daniel@haxx.se>, et al. SPDX-License-Identifier: curl Long: expect100-timeout Arg: <seconds> @@ -12,5 +12,8 @@ Multi: single --- 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 -default curl will wait one second. This option accepts decimal values! When -curl stops waiting, it will continue as if the response has been received. +default curl waits one second. This option accepts decimal values! When +curl stops waiting, it continues as if the response has been received. + +The decimal value needs to provided using a dot (.) as decimal separator - not +the local version even if it might be using another separator. diff --git a/docs/cmdline-opts/fail-early.d b/docs/cmdline-opts/fail-early.d index cedc884f8..36b330999 100644 --- a/docs/cmdline-opts/fail-early.d +++ b/docs/cmdline-opts/fail-early.d @@ -1,4 +1,4 @@ -c: Copyright (C) 1998 - 2022, Daniel Stenberg, <daniel@haxx.se>, et al. +c: Copyright (C) Daniel Stenberg, <daniel@haxx.se>, et al. SPDX-License-Identifier: curl Long: fail-early Help: Fail on first transfer error, do not continue @@ -7,21 +7,19 @@ Category: curl Example: --fail-early $URL https://two.example See-also: fail fail-with-body Multi: boolean +Scope: global --- Fail and exit on the first detected transfer error. -When curl is used to do multiple transfers on the command line, it will -attempt to operate on each given URL, one by one. By default, it will ignore -errors if there are more URLs given and the last URL's success will determine -the error code curl returns. So early failures will be "hidden" by subsequent -successful transfers. +When curl is used to do multiple transfers on the command line, it attempts to +operate on each given URL, one by one. By default, it ignores errors if there +are more URLs given and the last URL's success determines the error code curl +returns. So early failures are "hidden" by subsequent successful transfers. -Using this option, curl will instead return an error on the first transfer -that fails, independent of the amount of URLs that are given on the command +Using this option, curl instead returns an error on the first transfer that +fails, independent of the amount of URLs that are given on the command line. This way, no transfer failures go undetected by scripts and similar. -This option is global and does not need to be specified for each use of --next. - This option does not imply --fail, which causes transfers to fail due to the server's HTTP status code. You can combine the two options, however note --fail is not global and is therefore contained by --next. diff --git a/docs/cmdline-opts/fail-with-body.d b/docs/cmdline-opts/fail-with-body.d index adf5294f4..dddb86e22 100644 --- a/docs/cmdline-opts/fail-with-body.d +++ b/docs/cmdline-opts/fail-with-body.d @@ -1,11 +1,11 @@ -c: Copyright (C) 1998 - 2022, Daniel Stenberg, <daniel@haxx.se>, et al. +c: Copyright (C) Daniel Stenberg, <daniel@haxx.se>, et al. SPDX-License-Identifier: curl Long: fail-with-body Protocols: HTTP Help: Fail on HTTP errors but save the body Category: http output Added: 7.76.0 -See-also: fail +See-also: fail fail-early Mutexed: fail Example: --fail-with-body $URL Multi: boolean @@ -13,8 +13,8 @@ Multi: boolean 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 returns an HTML document stating so (which often also describes why and -more). This flag will still allow curl to output and save that content but -also to return error 22. +more). This flag allows curl to output and save that content but also to +return error 22. This is an alternative option to --fail which makes curl fail for the same circumstances but without saving the content. diff --git a/docs/cmdline-opts/fail.d b/docs/cmdline-opts/fail.d index 66c08fa50..8196a908d 100644 --- a/docs/cmdline-opts/fail.d +++ b/docs/cmdline-opts/fail.d @@ -1,10 +1,10 @@ -c: Copyright (C) 1998 - 2022, Daniel Stenberg, <daniel@haxx.se>, et al. +c: Copyright (C) Daniel Stenberg, <daniel@haxx.se>, et al. SPDX-License-Identifier: curl Long: fail Short: f Protocols: HTTP Help: Fail fast with no output on HTTP errors -See-also: fail-with-body +See-also: fail-with-body fail-early Category: important http Example: --fail $URL Mutexed: fail-with-body @@ -14,9 +14,9 @@ Multi: boolean Fail fast with no output at all on server errors. This is useful to enable scripts and users to better deal with failed attempts. In normal cases when an HTTP server fails to deliver a document, it returns an HTML document stating -so (which often also describes why and more). This flag will prevent curl from +so (which often also describes why and more). This flag prevents curl from outputting that and return error 22. This method is not fail-safe and there are occasions where non-successful -response codes will slip through, especially when authentication is involved +response codes slip through, especially when authentication is involved (response codes 401 and 407). diff --git a/docs/cmdline-opts/false-start.d b/docs/cmdline-opts/false-start.d index b617a6b67..73240492b 100644 --- a/docs/cmdline-opts/false-start.d +++ b/docs/cmdline-opts/false-start.d @@ -1,4 +1,4 @@ -c: Copyright (C) 1998 - 2022, Daniel Stenberg, <daniel@haxx.se>, et al. +c: Copyright (C) Daniel Stenberg, <daniel@haxx.se>, et al. SPDX-License-Identifier: curl Long: false-start Help: Enable TLS False Start @@ -10,9 +10,9 @@ See-also: tcp-fastopen Multi: boolean --- 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 starts sending application data before verifying the server's Finished message, thus saving a round trip when performing a full handshake. -This is currently only implemented in the NSS and Secure Transport (on iOS 7.0 -or later, or OS X 10.9 or later) backends. +This is currently only implemented in the Secure Transport (on iOS 7.0 or +later, or OS X 10.9 or later) backend. diff --git a/docs/cmdline-opts/form-escape.d b/docs/cmdline-opts/form-escape.d index b399741e2..304bfe814 100644 --- a/docs/cmdline-opts/form-escape.d +++ b/docs/cmdline-opts/form-escape.d @@ -1,4 +1,4 @@ -c: Copyright (C) 1998 - 2022, Daniel Stenberg, <daniel@haxx.se>, et al. +c: Copyright (C) Daniel Stenberg, <daniel@haxx.se>, et al. SPDX-License-Identifier: curl Long: form-escape Help: Escape multipart form field/file names using backslash diff --git a/docs/cmdline-opts/form-string.d b/docs/cmdline-opts/form-string.d index a2c450b17..6d7a500a4 100644 --- a/docs/cmdline-opts/form-string.d +++ b/docs/cmdline-opts/form-string.d @@ -1,4 +1,4 @@ -c: Copyright (C) 1998 - 2022, Daniel Stenberg, <daniel@haxx.se>, et al. +c: Copyright (C) Daniel Stenberg, <daniel@haxx.se>, et al. SPDX-License-Identifier: curl Long: form-string Help: Specify multipart MIME data @@ -13,5 +13,5 @@ Multi: append Similar to --form except that the value string for the named parameter is used literally. Leading '@' and '<' characters, and the ';type=' string in the value have no special meaning. Use this in preference to --form if -there's any possibility that the string value may accidentally trigger the +there is any possibility that the string value may accidentally trigger the '@' or '<' features of --form. diff --git a/docs/cmdline-opts/form.d b/docs/cmdline-opts/form.d index 3954fdaf6..e53e93ae0 100644 --- a/docs/cmdline-opts/form.d +++ b/docs/cmdline-opts/form.d @@ -1,4 +1,4 @@ -c: Copyright (C) 1998 - 2022, Daniel Stenberg, <daniel@haxx.se>, et al. +c: Copyright (C) Daniel Stenberg, <daniel@haxx.se>, et al. SPDX-License-Identifier: curl Long: form Short: F @@ -29,14 +29,13 @@ file. Tell curl to read content from stdin instead of a file by using - as filename. This goes for both @ and < constructs. When stdin is used, the contents is buffered in memory first by curl to determine its size and allow a -possible resend. Defining a part's data from a named non-regular file (such -as a named pipe or similar) is unfortunately not subject to buffering and will -be effectively read at transmission time; since the full size is unknown -before the transfer starts, such data is sent as chunks by HTTP and rejected -by IMAP. +possible resend. Defining a part's data from a named non-regular file (such as +a named pipe or similar) is not subject to buffering and is instead read at +transmission time; since the full size is unknown before the transfer starts, +such data is sent as chunks by HTTP and rejected by IMAP. Example: send an image to an HTTP server, where 'profile' is the name of the -form-field to which the file portrait.jpg will be the input: +form-field to which the file **portrait.jpg** is the input: curl -F profile=@portrait.jpg https://example.com/upload.cgi diff --git a/docs/cmdline-opts/ftp-account.d b/docs/cmdline-opts/ftp-account.d index f71773f14..eb669c562 100644 --- a/docs/cmdline-opts/ftp-account.d +++ b/docs/cmdline-opts/ftp-account.d @@ -1,4 +1,4 @@ -c: Copyright (C) 1998 - 2022, Daniel Stenberg, <daniel@haxx.se>, et al. +c: Copyright (C) Daniel Stenberg, <daniel@haxx.se>, et al. SPDX-License-Identifier: curl Long: ftp-account Arg: <data> diff --git a/docs/cmdline-opts/ftp-alternative-to-user.d b/docs/cmdline-opts/ftp-alternative-to-user.d index 22e5b4f92..f030bcf59 100644 --- a/docs/cmdline-opts/ftp-alternative-to-user.d +++ b/docs/cmdline-opts/ftp-alternative-to-user.d @@ -1,4 +1,4 @@ -c: Copyright (C) 1998 - 2022, Daniel Stenberg, <daniel@haxx.se>, et al. +c: Copyright (C) Daniel Stenberg, <daniel@haxx.se>, et al. SPDX-License-Identifier: curl Long: ftp-alternative-to-user Arg: <command> @@ -12,5 +12,5 @@ Multi: single --- If authenticating with the USER and PASS commands fails, send this command. When connecting to Tumbleweed's Secure Transport server over FTPS using a -client certificate, using "SITE AUTH" will tell the server to retrieve the +client certificate, using "SITE AUTH" tells the server to retrieve the username from the certificate. diff --git a/docs/cmdline-opts/ftp-create-dirs.d b/docs/cmdline-opts/ftp-create-dirs.d index 7cf3e1c79..7c64f0e21 100644 --- a/docs/cmdline-opts/ftp-create-dirs.d +++ b/docs/cmdline-opts/ftp-create-dirs.d @@ -1,4 +1,4 @@ -c: Copyright (C) 1998 - 2022, Daniel Stenberg, <daniel@haxx.se>, et al. +c: Copyright (C) Daniel Stenberg, <daniel@haxx.se>, et al. SPDX-License-Identifier: curl Long: ftp-create-dirs Protocols: FTP SFTP @@ -11,4 +11,4 @@ Multi: boolean --- When an FTP or SFTP URL/operation uses a path that does not currently exist on the server, the standard behavior of curl is to fail. Using this option, curl -will instead attempt to create missing directories. +instead attempts to create missing directories. diff --git a/docs/cmdline-opts/ftp-method.d b/docs/cmdline-opts/ftp-method.d index d745cca32..8061d2b68 100644 --- a/docs/cmdline-opts/ftp-method.d +++ b/docs/cmdline-opts/ftp-method.d @@ -1,4 +1,4 @@ -c: Copyright (C) 1998 - 2022, Daniel Stenberg, <daniel@haxx.se>, et al. +c: Copyright (C) Daniel Stenberg, <daniel@haxx.se>, et al. SPDX-License-Identifier: curl Long: ftp-method Arg: <method> @@ -20,10 +20,11 @@ curl does a single CWD operation for each path part in the given URL. For deep hierarchies this means many commands. This is how RFC 1738 says it should be done. This is the default but the slowest behavior. .IP nocwd -curl does no CWD at all. curl will do SIZE, RETR, STOR etc and give a full +curl does no CWD at all. curl does SIZE, RETR, STOR etc and give a full path to the server for all these commands. This is the fastest behavior. .IP singlecwd curl does one CWD with the full target directory and then operates on the file "normally" (like in the multicwd case). This is somewhat more standards compliant than 'nocwd' but without the full penalty of 'multicwd'. .RE +.IP diff --git a/docs/cmdline-opts/ftp-pasv.d b/docs/cmdline-opts/ftp-pasv.d index d6b4bfd9f..c43bf2bee 100644 --- a/docs/cmdline-opts/ftp-pasv.d +++ b/docs/cmdline-opts/ftp-pasv.d @@ -1,4 +1,4 @@ -c: Copyright (C) 1998 - 2022, Daniel Stenberg, <daniel@haxx.se>, et al. +c: Copyright (C) Daniel Stenberg, <daniel@haxx.se>, et al. SPDX-License-Identifier: curl Long: ftp-pasv Help: Use PASV/EPSV instead of PORT @@ -16,5 +16,5 @@ option. Reversing an enforced passive really is not doable but you must then instead enforce the correct --ftp-port again. -Passive mode means that curl will try the EPSV command first and then PASV, +Passive mode means that curl tries the EPSV command first and then PASV, unless --disable-epsv is used. diff --git a/docs/cmdline-opts/ftp-port.d b/docs/cmdline-opts/ftp-port.d index 4f660bd9e..e1f4a1dba 100644 --- a/docs/cmdline-opts/ftp-port.d +++ b/docs/cmdline-opts/ftp-port.d @@ -1,4 +1,4 @@ -c: Copyright (C) 1998 - 2022, Daniel Stenberg, <daniel@haxx.se>, et al. +c: Copyright (C) Daniel Stenberg, <daniel@haxx.se>, et al. SPDX-License-Identifier: curl Long: ftp-port Arg: <address> @@ -29,6 +29,7 @@ e.g. "my.host.domain" to specify the machine make curl pick the same IP address that is already used for the control connection .RE +.IP Disable the use of PORT with --ftp-pasv. Disable the attempt to use the EPRT command instead of PORT by using --disable-eprt. EPRT is really PORT++. diff --git a/docs/cmdline-opts/ftp-pret.d b/docs/cmdline-opts/ftp-pret.d index f31cc5625..4bea99e6d 100644 --- a/docs/cmdline-opts/ftp-pret.d +++ b/docs/cmdline-opts/ftp-pret.d @@ -1,4 +1,4 @@ -c: Copyright (C) 1998 - 2022, Daniel Stenberg, <daniel@haxx.se>, et al. +c: Copyright (C) Daniel Stenberg, <daniel@haxx.se>, et al. SPDX-License-Identifier: curl Long: ftp-pret Help: Send PRET before PASV diff --git a/docs/cmdline-opts/ftp-skip-pasv-ip.d b/docs/cmdline-opts/ftp-skip-pasv-ip.d index af9eb7d57..3af9c6de4 100644 --- a/docs/cmdline-opts/ftp-skip-pasv-ip.d +++ b/docs/cmdline-opts/ftp-skip-pasv-ip.d @@ -1,4 +1,4 @@ -c: Copyright (C) 1998 - 2022, Daniel Stenberg, <daniel@haxx.se>, et al. +c: Copyright (C) Daniel Stenberg, <daniel@haxx.se>, et al. SPDX-License-Identifier: curl Long: ftp-skip-pasv-ip Help: Skip the IP address for PASV @@ -9,11 +9,10 @@ Category: ftp Example: --ftp-skip-pasv-ip ftp://example.com/ Multi: boolean --- -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 -will re-use the same IP address it already uses for the control -connection. +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 +reuses the same IP address it already uses for the control connection. -Since curl 7.74.0 this option is enabled by default. +This option is enabled by default (added in 7.74.0). This option has no effect if PORT, EPRT or EPSV is used instead of PASV. diff --git a/docs/cmdline-opts/ftp-ssl-ccc-mode.d b/docs/cmdline-opts/ftp-ssl-ccc-mode.d index e738b55ba..ae9af9429 100644 --- a/docs/cmdline-opts/ftp-ssl-ccc-mode.d +++ b/docs/cmdline-opts/ftp-ssl-ccc-mode.d @@ -1,4 +1,4 @@ -c: Copyright (C) 1998 - 2022, Daniel Stenberg, <daniel@haxx.se>, et al. +c: Copyright (C) Daniel Stenberg, <daniel@haxx.se>, et al. SPDX-License-Identifier: curl Long: ftp-ssl-ccc-mode Arg: <active/passive> @@ -10,7 +10,7 @@ Category: ftp tls Example: --ftp-ssl-ccc-mode active --ftp-ssl-ccc ftps://example.com/ Multi: boolean --- -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 +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. diff --git a/docs/cmdline-opts/ftp-ssl-ccc.d b/docs/cmdline-opts/ftp-ssl-ccc.d index c6c0bfa4c..33ae83b1c 100644 --- a/docs/cmdline-opts/ftp-ssl-ccc.d +++ b/docs/cmdline-opts/ftp-ssl-ccc.d @@ -1,4 +1,4 @@ -c: Copyright (C) 1998 - 2022, Daniel Stenberg, <daniel@haxx.se>, et al. +c: Copyright (C) Daniel Stenberg, <daniel@haxx.se>, et al. SPDX-License-Identifier: curl Long: ftp-ssl-ccc Help: Send CCC after authenticating @@ -10,6 +10,6 @@ Example: --ftp-ssl-ccc ftps://example.com/ Multi: boolean --- 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 is be unencrypted. This allows NAT routers to follow the FTP transaction. The default mode is passive. diff --git a/docs/cmdline-opts/ftp-ssl-control.d b/docs/cmdline-opts/ftp-ssl-control.d index 6bdc5806d..b89577927 100644 --- a/docs/cmdline-opts/ftp-ssl-control.d +++ b/docs/cmdline-opts/ftp-ssl-control.d @@ -1,4 +1,4 @@ -c: Copyright (C) 1998 - 2022, Daniel Stenberg, <daniel@haxx.se>, et al. +c: Copyright (C) Daniel Stenberg, <daniel@haxx.se>, et al. SPDX-License-Identifier: curl Long: ftp-ssl-control Help: Require SSL/TLS for FTP login, clear for transfer diff --git a/docs/cmdline-opts/gen.pl b/docs/cmdline-opts/gen.pl index fe3e43e06..edf90622b 100755 --- a/docs/cmdline-opts/gen.pl +++ b/docs/cmdline-opts/gen.pl @@ -6,7 +6,7 @@ # | (__| |_| | _ <| |___ # \___|\___/|_| \_\_____| # -# Copyright (C) 1998 - 2022, Daniel Stenberg, <daniel@haxx.se>, et al. +# Copyright (C) Daniel Stenberg, <daniel@haxx.se>, et al. # # This software is licensed as described in the file COPYING, which # you should have received as part of this distribution. The terms @@ -33,7 +33,7 @@ Dev notes: We open *input* files in :crlf translation (a no-op on many platforms) in case we have CRLF line endings in Windows but a perl that defaults to LF. -Unfortunately it seems some perls like msysgit can't handle a global input-only +Unfortunately it seems some perls like msysgit cannot handle a global input-only :crlf so it has to be specified on each file open for text input. =end comment @@ -48,9 +48,16 @@ my %protolong; my %catlong; use POSIX qw(strftime); -my $date = strftime "%B %d %Y", localtime; -my $year = strftime "%Y", localtime; +my @ts; +if (defined($ENV{SOURCE_DATE_EPOCH})) { + @ts = localtime($ENV{SOURCE_DATE_EPOCH}); +} else { + @ts = localtime; +} +my $date = strftime "%B %d %Y", @ts; +my $year = strftime "%Y", @ts; my $version = "unknown"; +my $globals; open(INC, "<../../include/curl/curlver.h"); while(<INC>) { @@ -65,13 +72,16 @@ close(INC); sub manpageify { my ($k)=@_; my $l; + my $klong = $k; + # quote "bare" minuses in the long name + $klong =~ s/-/\\-/g; if($optlong{$k} ne "") { # both short + long - $l = "\\fI-".$optlong{$k}.", --$k\\fP"; + $l = "\\fI-".$optlong{$k}.", \\-\\-$klong\\fP"; } else { # only long - $l = "\\fI--$k\\fP"; + $l = "\\fI\\-\\-$klong\\fP"; } return $l; } @@ -104,16 +114,21 @@ sub printdesc { } # skip lines starting with space (examples) if($d =~ /^[^ ]/ && $d =~ /--/) { - for my $k (keys %optlong) { + # scan for options in longest-names first order + for my $k (sort {length($b) <=> length($a)} keys %optlong) { + # --tlsv1 is complicated since --tlsv1.2 etc are also + # acceptable options! + if(($k eq "tlsv1") && ($d =~ /--tlsv1\.[0-9]\\f/)) { + next; + } my $l = manpageify($k); - $d =~ s/--\Q$k\E([^a-z0-9_-])([^a-zA-Z0-9_])/$l$1$2/; + $d =~ s/\-\-$k([^a-z0-9-])/$l$1/g; } } - # quote "bare" minuses in the output - $d =~ s/( |\\fI|^)--/$1\\-\\-/g; - $d =~ s/([ -]|\\fI|^)-/$1\\-/g; - # handle single quotes first on the line - $d =~ s/^(\s*)\'/$1\\(aq/; + # quote minuses in the output + $d =~ s/([^\\])-/$1\\-/g; + # replace single quotes + $d =~ s/\'/\\(aq/g; # handle double quotes first on the line $d =~ s/^(\s*)\"/$1\\(dq/; print $d; @@ -163,8 +178,8 @@ sub too_old { elsif($version =~ /^(\d+)\.(\d+)/) { $a = $1 * 1000 + $2 * 10; } - if($a < 7300) { - # we consider everything before 7.30.0 to be too old to mention + if($a < 7500) { + # we consider everything before 7.50.0 to be too old to mention # specific changes for return 1; } @@ -174,7 +189,7 @@ sub too_old { sub added { my ($standalone, $data)=@_; if(too_old($data)) { - # don't mention ancient additions + # do not mention ancient additions return ""; } if($standalone) { @@ -205,6 +220,7 @@ sub single { my $magic; # cmdline special option my $line; my $multi; + my $scope; my $experimental; while(<F>) { $line++; @@ -233,6 +249,10 @@ sub single { $protocols=$1; } elsif(/^See-also: *(.*)/i) { + if($seealso) { + print STDERR "ERROR: duplicated See-also in $f\n"; + return 1; + } $seealso=$1; } elsif(/^Requires: *(.*)/i) { @@ -247,6 +267,9 @@ sub single { elsif(/^Multi: *(.*)/i) { $multi=$1; } + elsif(/^Scope: *(.*)/i) { + $scope=$1; + } elsif(/^Experimental: yes/i) { $experimental=1; } @@ -264,10 +287,6 @@ sub single { print STDERR "ERROR: no 'Long:' in $f\n"; return 1; } - if($multi !~ /(single|append|boolean|mutex)/) { - print STDERR "ERROR: bad 'Multi:' in $f\n"; - return 1; - } if(!$category) { print STDERR "ERROR: no 'Category:' in $f\n"; return 2; @@ -305,6 +324,7 @@ sub single { } close(F); my $opt; + if(defined($short) && $long) { $opt = "-$short, --$long"; } @@ -320,8 +340,7 @@ sub single { } # quote "bare" minuses in opt - $opt =~ s/( |^)--/$1\\-\\-/g; - $opt =~ s/( |^)-/$1\\-/g; + $opt =~ s/-/\\-/g; if($standalone) { print ".TH curl 1 \"30 Nov 2016\" \"curl 7.52.0\" \"curl manual\"\n"; print ".SH OPTION\n"; @@ -345,12 +364,23 @@ sub single { printdesc(@desc); undef @desc; + if($scope) { + if($scope eq "global") { + print "\nThis option is global and does not need to be specified for each use of --next.\n"; + } + else { + print STDERR "$f:$line:1:ERROR: unrecognized scope: '$scope'\n"; + return 2; + } + } + + my @extra; if($multi eq "single") { - print "\nIf --$long is provided several times, the last set ". - "value will be used.\n"; + push @extra, "\nIf --$long is provided several times, the last set ". + "value is used.\n"; } elsif($multi eq "append") { - print "\n--$long can be used several times in a command line\n"; + push @extra, "\n--$long can be used several times in a command line\n"; } elsif($multi eq "boolean") { my $rev = "no-$long"; @@ -360,13 +390,24 @@ sub single { $rev = $long; $rev =~ s/^no-//; } - print "\nProviding --$long multiple times has no extra effect.\n". - "Disable it again with --$rev.\n"; + push @extra, + "\nProviding --$long multiple times has no extra effect.\n". + "Disable it again with \\-\\-$rev.\n"; } elsif($multi eq "mutex") { - print "\nProviding --$long multiple times has no extra effect.\n"; + push @extra, + "\nProviding --$long multiple times has no extra effect.\n"; + } + elsif($multi eq "custom") { + ; # left for the text to describe + } + else { + print STDERR "$f:$line:1:ERROR: unrecognized Multi: '$multi'\n"; + return 2; } + printdesc(@extra); + my @foot; if($seealso) { my @m=split(/ /, $seealso); @@ -392,6 +433,7 @@ sub single { } push @foot, seealso($standalone, $mstr); } + if($requires) { my $l = manpageify($long); push @foot, "$l requires that the underlying libcurl". @@ -416,6 +458,8 @@ sub single { print "\nExample$s:\n.nf\n"; foreach my $e (@examples) { $e =~ s!\$URL!https://example.com!g; + $e =~ s/-/\\-/g; + $e =~ s/\'/\\(aq/g; print " curl $e\n"; } print ".fi\n"; @@ -491,6 +535,7 @@ sub header { while(<F>) { s/%DATE/$date/g; s/%VERSION/$version/g; + s/%GLOBALS/$globals/g; push @d, $_; } close(F); @@ -506,7 +551,7 @@ sub listhelp { * | (__| |_| | _ <| |___ * \\___|\\___/|_| \\_\\_____| * - * Copyright (C) 1998 - $year, Daniel Stenberg, <daniel@haxx.se>, et al. + * Copyright (C) Daniel Stenberg, <daniel\@haxx.se>, et al. * * This software is licensed as described in the file COPYING, which * you should have received as part of this distribution. The terms @@ -540,7 +585,7 @@ HEAD my $long = $f; my $short = $optlong{$long}; my @categories = split ' ', $catlong{$long}; - my $bitmask; + my $bitmask = ' '; my $opt; if(defined($short) && $long) { @@ -556,6 +601,7 @@ HEAD $bitmask .= ' | '; } } + $bitmask =~ s/(?=.{76}).{1,76}\|/$&\n /g; my $arg = $arglong{$long}; if($arg) { $opt .= " $arg"; @@ -563,7 +609,7 @@ HEAD my $desc = $helplong{$f}; $desc =~ s/\"/\\\"/g; # escape double quotes - my $line = sprintf " {\"%s\",\n \"%s\",\n %s},\n", $opt, $desc, $bitmask; + my $line = sprintf " {\"%s\",\n \"%s\",\n %s},\n", $opt, $desc, $bitmask; if(length($opt) > 78) { print STDERR "WARN: the --$long name is too long\n"; @@ -599,6 +645,36 @@ sub listcats { } } +sub listglobals { + my (@files) = @_; + my @globalopts; + + # Find all global options and output them + foreach my $f (sort @files) { + open(F, "<:crlf", "$f") || + next; + my $long; + while(<F>) { + if(/^Long: *(.*)/i) { + $long=$1; + } + elsif(/^Scope: global/i) { + push @globalopts, $long; + last; + } + elsif(/^---/) { + last; + } + } + close(F); + } + return $ret if($ret); + for my $e (0 .. $#globalopts) { + $globals .= sprintf "%s--%s", $e?($globalopts[$e+1] ? ", " : " and "):"", + $globalopts[$e],; + } +} + sub mainpage { my (@files) = @_; my $ret; @@ -610,7 +686,9 @@ sub mainpage { $ret += single($f, 0); } - header("page-footer"); + if(!$ret) { + header("page-footer"); + } exit $ret if($ret); } @@ -637,6 +715,7 @@ sub showprotocols { sub getargs { my ($f, @s) = @_; if($f eq "mainpage") { + listglobals(@s); mainpage(@s); return; } diff --git a/docs/cmdline-opts/get.d b/docs/cmdline-opts/get.d index fbfbe8672..2e03a255b 100644 --- a/docs/cmdline-opts/get.d +++ b/docs/cmdline-opts/get.d @@ -1,4 +1,4 @@ -c: Copyright (C) 1998 - 2022, Daniel Stenberg, <daniel@haxx.se>, et al. +c: Copyright (C) Daniel Stenberg, <daniel@haxx.se>, et al. SPDX-License-Identifier: curl Long: get Short: G @@ -11,10 +11,10 @@ Added: 7.8.1 See-also: data request Multi: boolean --- -When used, this option will make all data specified with --data, --data-binary +When used, this option makes all data specified with --data, --data-binary or --data-urlencode to be used in an HTTP GET request instead of the POST -request that otherwise would be used. The data will be appended to the URL +request that otherwise would be used. The data is appended to the URL with a '?' separator. -If used in combination with --head, the POST data will instead be appended to -the URL with a HEAD request. +If used in combination with --head, the POST data is instead appended to the +URL with a HEAD request. diff --git a/docs/cmdline-opts/globoff.d b/docs/cmdline-opts/globoff.d index ff84ad01d..53bed6ec8 100644 --- a/docs/cmdline-opts/globoff.d +++ b/docs/cmdline-opts/globoff.d @@ -1,4 +1,4 @@ -c: Copyright (C) 1998 - 2022, Daniel Stenberg, <daniel@haxx.se>, et al. +c: Copyright (C) Daniel Stenberg, <daniel@haxx.se>, et al. SPDX-License-Identifier: curl Long: globoff Short: g diff --git a/docs/cmdline-opts/happy-eyeballs-timeout-ms.d b/docs/cmdline-opts/happy-eyeballs-timeout-ms.d index c5f10f6db..29114e209 100644 --- a/docs/cmdline-opts/happy-eyeballs-timeout-ms.d +++ b/docs/cmdline-opts/happy-eyeballs-timeout-ms.d @@ -1,4 +1,4 @@ -c: Copyright (C) 1998 - 2022, Daniel Stenberg, <daniel@haxx.se>, et al. +c: Copyright (C) Daniel Stenberg, <daniel@haxx.se>, et al. SPDX-License-Identifier: curl Long: happy-eyeballs-timeout-ms Arg: <milliseconds> diff --git a/docs/cmdline-opts/haproxy-clientip.d b/docs/cmdline-opts/haproxy-clientip.d new file mode 100644 index 000000000..25cb7e623 --- /dev/null +++ b/docs/cmdline-opts/haproxy-clientip.d @@ -0,0 +1,29 @@ +c: Copyright (C) Daniel Stenberg, <daniel@haxx.se>, et al. +SPDX-License-Identifier: curl +Long: haproxy-clientip +Help: Sets client IP in HAProxy PROXY protocol v1 header +Protocols: HTTP +Added: 8.2.0 +Category: http proxy +Example: --haproxy-clientip $IP +See-also: proxy +Multi: single +--- +Sets a client IP in HAProxy PROXY protocol v1 header at the beginning of the +connection. + +For valid requests, IPv4 addresses must be indicated as a series of exactly +4 integers in the range [0..255] inclusive written in decimal representation +separated by exactly one dot between each other. Heading zeroes are not +permitted in front of numbers in order to avoid any possible confusion +with octal numbers. IPv6 addresses must be indicated as series of 4 hexadecimal +digits (upper or lower case) delimited by colons between each other, with the +acceptance of one double colon sequence to replace the largest acceptable range +of consecutive zeroes. The total number of decoded bits must exactly be 128. + +Otherwise, any string can be accepted for the client IP and get sent. + +It replaces --haproxy-protocol if used, it is not necessary to specify both flags. + +This option is primarily useful when sending test requests to +verify a service is working as intended. diff --git a/docs/cmdline-opts/haproxy-protocol.d b/docs/cmdline-opts/haproxy-protocol.d index b2129e6eb..34119062e 100644 --- a/docs/cmdline-opts/haproxy-protocol.d +++ b/docs/cmdline-opts/haproxy-protocol.d @@ -1,4 +1,4 @@ -c: Copyright (C) 1998 - 2022, Daniel Stenberg, <daniel@haxx.se>, et al. +c: Copyright (C) Daniel Stenberg, <daniel@haxx.se>, et al. SPDX-License-Identifier: curl Long: haproxy-protocol Help: Send HAProxy PROXY protocol v1 header diff --git a/docs/cmdline-opts/head.d b/docs/cmdline-opts/head.d index 31de19aca..bb748b72e 100644 --- a/docs/cmdline-opts/head.d +++ b/docs/cmdline-opts/head.d @@ -1,4 +1,4 @@ -c: Copyright (C) 1998 - 2022, Daniel Stenberg, <daniel@haxx.se>, et al. +c: Copyright (C) Daniel Stenberg, <daniel@haxx.se>, et al. SPDX-License-Identifier: curl Long: head Short: I diff --git a/docs/cmdline-opts/header.d b/docs/cmdline-opts/header.d index a64873fcb..95c1565e8 100644 --- a/docs/cmdline-opts/header.d +++ b/docs/cmdline-opts/header.d @@ -1,4 +1,4 @@ -c: Copyright (C) 1998 - 2022, Daniel Stenberg, <daniel@haxx.se>, et al. +c: Copyright (C) Daniel Stenberg, <daniel@haxx.se>, et al. SPDX-License-Identifier: curl Long: header Short: H @@ -10,6 +10,7 @@ See-also: user-agent referer Example: -H "X-First-Name: Joe" $URL Example: -H "User-Agent: yes-please/2000" $URL Example: -H "Host:" $URL +Example: -H @headers.txt $URL Added: 5.0 Multi: append --- @@ -22,22 +23,23 @@ global level. It does not affect raw uploaded mails (Added in 7.56.0). You may specify any number of extra headers. Note that if you should add a custom header that has the same name as one of the internal ones curl would -use, your externally set header will be used instead of the internal one. -This allows you to make even trickier stuff than curl would normally do. You -should not replace internally set headers without knowing perfectly well what -you are doing. Remove an internal header by giving a replacement without -content on the right side of the colon, as in: -H "Host:". If you send the -custom header with no-value then its header must be terminated with a -semicolon, such as \-H "X-Custom-Header;" to send "X-Custom-Header:". - -curl will make sure that each header you add/replace is sent with the proper +use, your externally set header is used instead of the internal one. This +allows you to make even trickier stuff than curl would normally do. You should +not replace internally set headers without knowing perfectly well what you are +doing. Remove an internal header by giving a replacement without content on +the right side of the colon, as in: -H "Host:". If you send the custom header +with no-value then its header must be terminated with a semicolon, such as \-H +"X-Custom-Header;" to send "X-Custom-Header:". + +curl makes sure that each header you add/replace is sent with the proper end-of-line marker, you should thus **not** add that as a part of the header -content: do not add newlines or carriage returns, they will only mess things -up for you. +content: do not add newlines or carriage returns, they only mess things up for +you. curl passes on the verbatim string you give it without any filter or +other safe guards. That includes white space and control characters. This option can take an argument in @filename style, which then adds a header -for each line in the input file. Using @- will make curl read the header file -from stdin. Added in 7.55.0. +for each line in the input file. Using @- makes curl read the header file from +stdin. Added in 7.55.0. Please note that most anti-spam utilities check the presence and value of several MIME mail headers: these are "From:", "To:", "Date:" and "Subject:" @@ -47,10 +49,9 @@ You need --proxy-header to send custom headers intended for an HTTP proxy. Added in 7.37.0. Passing on a "Transfer-Encoding: chunked" header when doing an HTTP request -with a request body, will make curl send the data using chunked encoding. +with a request body, makes curl send the data using chunked encoding. -**WARNING**: headers set with this option will be set in all HTTP 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 headers should be used with caution combined with following -redirects. +**WARNING**: headers set with this option are set in all HTTP 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 +headers should be used with caution combined with following redirects. diff --git a/docs/cmdline-opts/help.d b/docs/cmdline-opts/help.d index 7d835a381..f8675e484 100644 --- a/docs/cmdline-opts/help.d +++ b/docs/cmdline-opts/help.d @@ -1,4 +1,4 @@ -c: Copyright (C) 1998 - 2022, Daniel Stenberg, <daniel@haxx.se>, et al. +c: Copyright (C) Daniel Stenberg, <daniel@haxx.se>, et al. SPDX-License-Identifier: curl Long: help Arg: <category> @@ -8,11 +8,14 @@ Category: important curl Example: --help all Added: 4.0 See-also: verbose -Multi: boolean +Multi: custom --- -Usage help. This lists all commands of the <category>. -If no arg was provided, curl will display the most important -command line arguments. -If the argument "all" was provided, curl will display all options available. -If the argument "category" was provided, curl will display all categories and -their meanings. +Usage help. This lists all curl command line options within the given +**category**. + +If no argument is provided, curl displays only the most important command line +arguments. + +For category **all**, curl displays help for all options. + +If **category** is specified, curl displays all available help categories. diff --git a/docs/cmdline-opts/hostpubmd5.d b/docs/cmdline-opts/hostpubmd5.d index 966bbca27..e9db23db0 100644 --- a/docs/cmdline-opts/hostpubmd5.d +++ b/docs/cmdline-opts/hostpubmd5.d @@ -1,4 +1,4 @@ -c: Copyright (C) 1998 - 2022, Daniel Stenberg, <daniel@haxx.se>, et al. +c: Copyright (C) Daniel Stenberg, <daniel@haxx.se>, et al. SPDX-License-Identifier: curl Long: hostpubmd5 Arg: <md5> @@ -11,5 +11,5 @@ See-also: hostpubsha256 Multi: single --- 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 refuses the connection with the host unless the md5sums match. diff --git a/docs/cmdline-opts/hostpubsha256.d b/docs/cmdline-opts/hostpubsha256.d index c95248504..b33f338bd 100644 --- a/docs/cmdline-opts/hostpubsha256.d +++ b/docs/cmdline-opts/hostpubsha256.d @@ -1,4 +1,4 @@ -c: Copyright (C) 1998 - 2022, Daniel Stenberg, <daniel@haxx.se>, et al. +c: Copyright (C) Daniel Stenberg, <daniel@haxx.se>, et al. SPDX-License-Identifier: curl Long: hostpubsha256 Arg: <sha256> @@ -10,6 +10,8 @@ Example: --hostpubsha256 NDVkMTQxMGQ1ODdmMjQ3MjczYjAyOTY5MmRkMjVmNDQ= sftp://exa See-also: hostpubmd5 Multi: single --- -Pass a string containing a Base64-encoded SHA256 hash of the remote -host's public key. Curl will refuse the connection with the host -unless the hashes match. +Pass a string containing a Base64-encoded SHA256 hash of the remote host's +public key. Curl refuses the connection with the host unless the hashes match. + +This feature requires libcurl to be built with libssh2 and does not work with +other SSH backends. diff --git a/docs/cmdline-opts/hsts.d b/docs/cmdline-opts/hsts.d index ec251acbe..e30d3b419 100644 --- a/docs/cmdline-opts/hsts.d +++ b/docs/cmdline-opts/hsts.d @@ -1,4 +1,4 @@ -c: Copyright (C) 1998 - 2022, Daniel Stenberg, <daniel@haxx.se>, et al. +c: Copyright (C) Daniel Stenberg, <daniel@haxx.se>, et al. SPDX-License-Identifier: curl Long: hsts Arg: <file name> @@ -11,11 +11,16 @@ See-also: proto Multi: append --- 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. +existing HSTS cache file, that is used. After a completed transfer, the +cache is saved to the file name again if it has been modified. + +If curl is told to use HTTP:// for a transfer involving a host name that +exists in the HSTS cache, it upgrades the transfer to use HTTPS. Each HSTS +cache entry has an individual life time after which the upgrade is no longer +performed. Specify a "" file name (zero length) to avoid loading/saving and make curl just handle HSTS in memory. -If this option is used several times, curl will load contents from all the -files but the last one will be used for saving. +If this option is used several times, curl loads contents from all the +files but the last one is used for saving. diff --git a/docs/cmdline-opts/http0.9.d b/docs/cmdline-opts/http0.9.d index 58dec5577..3dd14a05c 100644 --- a/docs/cmdline-opts/http0.9.d +++ b/docs/cmdline-opts/http0.9.d @@ -1,4 +1,4 @@ -c: Copyright (C) 1998 - 2022, Daniel Stenberg, <daniel@haxx.se>, et al. +c: Copyright (C) Daniel Stenberg, <daniel@haxx.se>, et al. SPDX-License-Identifier: curl Long: http0.9 Tags: Versions @@ -12,8 +12,8 @@ Multi: boolean --- Tells curl to be fine with HTTP version 0.9 response. -HTTP/0.9 is a completely headerless response and therefore you can also -connect with this to non-HTTP servers and still get a response since curl will -simply transparently downgrade - if allowed. +HTTP/0.9 is a response without headers and therefore you can also connect with +this to non-HTTP servers and still get a response since curl simply +transparently downgrades - if allowed. -Since curl 7.66.0, HTTP/0.9 is disabled by default. +HTTP/0.9 is disabled by default (added in 7.66.0) diff --git a/docs/cmdline-opts/http1.0.d b/docs/cmdline-opts/http1.0.d index 3f8277edd..c5f4de872 100644 --- a/docs/cmdline-opts/http1.0.d +++ b/docs/cmdline-opts/http1.0.d @@ -1,4 +1,4 @@ -c: Copyright (C) 1998 - 2022, Daniel Stenberg, <daniel@haxx.se>, et al. +c: Copyright (C) Daniel Stenberg, <daniel@haxx.se>, et al. SPDX-License-Identifier: curl Short: 0 Long: http1.0 diff --git a/docs/cmdline-opts/http1.1.d b/docs/cmdline-opts/http1.1.d index 205755309..3057aed36 100644 --- a/docs/cmdline-opts/http1.1.d +++ b/docs/cmdline-opts/http1.1.d @@ -1,4 +1,4 @@ -c: Copyright (C) 1998 - 2022, Daniel Stenberg, <daniel@haxx.se>, et al. +c: Copyright (C) Daniel Stenberg, <daniel@haxx.se>, et al. SPDX-License-Identifier: curl Long: http1.1 Tags: Versions diff --git a/docs/cmdline-opts/http2-prior-knowledge.d b/docs/cmdline-opts/http2-prior-knowledge.d index eb79c9f36..7d7cabfd8 100644 --- a/docs/cmdline-opts/http2-prior-knowledge.d +++ b/docs/cmdline-opts/http2-prior-knowledge.d @@ -1,4 +1,4 @@ -c: Copyright (C) 1998 - 2022, Daniel Stenberg, <daniel@haxx.se>, et al. +c: Copyright (C) Daniel Stenberg, <daniel@haxx.se>, et al. SPDX-License-Identifier: curl Long: http2-prior-knowledge Tags: Versions @@ -14,5 +14,5 @@ Multi: boolean --- 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 -away. HTTPS requests will still do HTTP/2 the standard way with negotiated -protocol version in the TLS handshake. +away. HTTPS requests still do HTTP/2 the standard way with negotiated protocol +version in the TLS handshake. diff --git a/docs/cmdline-opts/http2.d b/docs/cmdline-opts/http2.d index e247b649c..af5f3c4f5 100644 --- a/docs/cmdline-opts/http2.d +++ b/docs/cmdline-opts/http2.d @@ -1,4 +1,4 @@ -c: Copyright (C) 1998 - 2022, Daniel Stenberg, <daniel@haxx.se>, et al. +c: Copyright (C) Daniel Stenberg, <daniel@haxx.se>, et al. SPDX-License-Identifier: curl Long: http2 Tags: Versions @@ -6,20 +6,19 @@ Protocols: HTTP Added: 7.33.0 Mutexed: http1.1 http1.0 http2-prior-knowledge http3 Requires: HTTP/2 -See-also: no-alpn -Help: Use HTTP 2 -See-also: http1.1 http3 +Help: Use HTTP/2 +See-also: http1.1 http3 no-alpn Category: http Example: --http2 $URL Multi: mutex --- 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 HTTPS, this means curl negotiates 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. +For HTTP, this means curl attempts to upgrade the request to HTTP/2 using the +Upgrade: request header. When curl uses HTTP/2 over HTTPS, it does not itself insist on TLS 1.2 or higher even though that is required by the specification. A user can add this diff --git a/docs/cmdline-opts/http3-only.d b/docs/cmdline-opts/http3-only.d new file mode 100644 index 000000000..c3f0f31aa --- /dev/null +++ b/docs/cmdline-opts/http3-only.d @@ -0,0 +1,25 @@ +c: Copyright (C) Daniel Stenberg, <daniel@haxx.se>, et al. +SPDX-License-Identifier: curl +Long: http3-only +Tags: Versions +Protocols: HTTP +Added: 7.88.0 +Mutexed: http1.1 http1.0 http2 http2-prior-knowledge http3 +Requires: HTTP/3 +Help: Use HTTP v3 only +See-also: http1.1 http2 http3 +Category: http +Example: --http3-only $URL +Multi: mutex +Experimental: yes +--- +Instructs curl to use HTTP/3 to the host in the URL, with no fallback to +earlier HTTP versions. HTTP/3 can only be used for HTTPS and not for HTTP +URLs. For HTTP, this option triggers an error. + +This option allows a user to avoid using the Alt-Svc method of upgrading to +HTTP/3 when you know that the target speaks HTTP/3 on the given host and port. + +This option makes curl fail if a QUIC connection cannot be established, it +does not attempt any other HTTP versions on its own. Use --http3 for similar +functionality *with* a fallback. diff --git a/docs/cmdline-opts/http3.d b/docs/cmdline-opts/http3.d index 7f5b8eb5a..a8258c4d3 100644 --- a/docs/cmdline-opts/http3.d +++ b/docs/cmdline-opts/http3.d @@ -1,10 +1,10 @@ -c: Copyright (C) 1998 - 2022, Daniel Stenberg, <daniel@haxx.se>, et al. +c: Copyright (C) Daniel Stenberg, <daniel@haxx.se>, et al. SPDX-License-Identifier: curl Long: http3 Tags: Versions Protocols: HTTP Added: 7.66.0 -Mutexed: http1.1 http1.0 http2 http2-prior-knowledge +Mutexed: http1.1 http1.0 http2 http2-prior-knowledge http3-only Requires: HTTP/3 Help: Use HTTP v3 See-also: http1.1 http2 @@ -13,10 +13,15 @@ Example: --http3 $URL Multi: mutex Experimental: yes --- -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 -redirected via Alt-Svc, but this option allows a user to circumvent that when -you know that the target speaks HTTP/3 on the given host and port. +Tells curl to try HTTP/3 to the host in the URL, but fallback to earlier +HTTP versions if the HTTP/3 connection establishment fails. HTTP/3 is only +available for HTTPS and not for HTTP URLs. -This option will make curl fail if a QUIC connection cannot be established, it -cannot fall back to a lower HTTP version on its own. +This option allows a user to avoid using the Alt-Svc method of upgrading to +HTTP/3 when you know that the target speaks HTTP/3 on the given host and port. + +When asked to use HTTP/3, curl issues a separate attempt to use older HTTP +versions with a slight delay, so if the HTTP/3 transfer fails or is slow, curl +still tries to proceed with an older HTTP version. + +Use --http3-only for similar functionality *without* a fallback. diff --git a/docs/cmdline-opts/ignore-content-length.d b/docs/cmdline-opts/ignore-content-length.d index eda4bd016..505c04c18 100644 --- a/docs/cmdline-opts/ignore-content-length.d +++ b/docs/cmdline-opts/ignore-content-length.d @@ -1,4 +1,4 @@ -c: Copyright (C) 1998 - 2022, Daniel Stenberg, <daniel@haxx.se>, et al. +c: Copyright (C) Daniel Stenberg, <daniel@haxx.se>, et al. SPDX-License-Identifier: curl Long: ignore-content-length Help: Ignore the size of the remote resource @@ -10,10 +10,10 @@ See-also: ftp-skip-pasv-ip Multi: boolean --- 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 reports incorrect Content-Length for files larger than 2 gigabytes. -For FTP (since 7.46.0), skip the RETR command to figure out the size before -downloading a file. +For FTP, this makes curl skip the SIZE command to figure out the size before +downloading a file (added in 7.46.0). This option does not work for HTTP if libcurl was built to use hyper. diff --git a/docs/cmdline-opts/include.d b/docs/cmdline-opts/include.d index 9e9649b7e..ce7b9d87b 100644 --- a/docs/cmdline-opts/include.d +++ b/docs/cmdline-opts/include.d @@ -1,4 +1,4 @@ -c: Copyright (C) 1998 - 2022, Daniel Stenberg, <daniel@haxx.se>, et al. +c: Copyright (C) Daniel Stenberg, <daniel@haxx.se>, et al. SPDX-License-Identifier: curl Long: include Short: i @@ -14,3 +14,6 @@ include things like server name, cookies, date of the document, HTTP version and more... To view the request headers, consider the --verbose option. + +Prior to 7.75.0 curl did not print the headers if --fail was used in +combination with this option and there was error reported by server. diff --git a/docs/cmdline-opts/insecure.d b/docs/cmdline-opts/insecure.d index c75817efc..e48d50002 100644 --- a/docs/cmdline-opts/insecure.d +++ b/docs/cmdline-opts/insecure.d @@ -1,4 +1,4 @@ -c: Copyright (C) 1998 - 2022, Daniel Stenberg, <daniel@haxx.se>, et al. +c: Copyright (C) Daniel Stenberg, <daniel@haxx.se>, et al. SPDX-License-Identifier: curl Long: insecure Short: k @@ -26,3 +26,8 @@ For SFTP and SCP, this option makes curl skip the *known_hosts* verification. ".ssh" subdirectory, which contains host names and their public keys. **WARNING**: using this option makes the transfer insecure. + +When curl uses secure protocols it trusts responses and allows for example +HSTS and Alt-Svc information to be stored and used subsequently. Using +--insecure can make curl trust and use such information from malicious +servers. diff --git a/docs/cmdline-opts/interface.d b/docs/cmdline-opts/interface.d index 275f6151c..026ceaef5 100644 --- a/docs/cmdline-opts/interface.d +++ b/docs/cmdline-opts/interface.d @@ -1,4 +1,4 @@ -c: Copyright (C) 1998 - 2022, Daniel Stenberg, <daniel@haxx.se>, et al. +c: Copyright (C) Daniel Stenberg, <daniel@haxx.se>, et al. SPDX-License-Identifier: curl Long: interface Arg: <name> @@ -14,6 +14,6 @@ name, IP address or host name. An example could look like: curl --interface eth0:1 https://www.example.com/ -On Linux it can be used to specify a VRF, but the binary needs to either -have CAP_NET_RAW or to be run as root. More information about Linux VRF: -https://www.kernel.org/doc/Documentation/networking/vrf.txt +On Linux it can be used to specify a **VRF**, but the binary needs to either +have **CAP_NET_RAW** or to be run as root. More information about Linux +**VRF**: https://www.kernel.org/doc/Documentation/networking/vrf.txt diff --git a/docs/cmdline-opts/ipfs-gateway.d b/docs/cmdline-opts/ipfs-gateway.d new file mode 100644 index 000000000..e6845b327 --- /dev/null +++ b/docs/cmdline-opts/ipfs-gateway.d @@ -0,0 +1,32 @@ +c: Copyright (C) 2023, Mark Gaiser, <markg85@gmail.com> +SPDX-License-Identifier: curl +Long: ipfs-gateway +Arg: <URL> +Help: Gateway for IPFS +Added: 8.4.0 +See-also: help manual +Category: ipfs +Example: --ipfs-gateway $URL ipfs:// +Multi: single +--- +Specify which gateway to use for IPFS and IPNS URLs. Not specifying this will +instead make curl check if the IPFS_GATEWAY environment variable is set, or if +a ~/.ipfs/gateway file holding the gateway URL exists. + +If you run a local IPFS node, this gateway is by default available under +http://localhost:8080. A full example URL would look like: + + curl --ipfs-gateway http://localhost:8080 ipfs://bafybeigagd5nmnn2iys2f3doro7ydrevyr2mzarwidgadawmamiteydbzi + +There are many public IPFS gateways. See for example: + + https://ipfs.github.io/public-gateway-checker/ + +WARNING: If you opt to go for a remote gateway you should be aware that you +completely trust the gateway. This is fine in local gateways as you host it +yourself. With remote gateways there could potentially be a malicious actor +returning you data that does not match the request you made, inspect or even +interfere with the request. You will not notice this when using curl. A +mitigation could be to go for a "trustless" gateway. This means you locally +verify that the data. Consult the docs page on trusted vs trustless: +https://docs.ipfs.tech/reference/http/gateway/#trusted-vs-trustless diff --git a/docs/cmdline-opts/ipv4.d b/docs/cmdline-opts/ipv4.d index 8a3e35e73..60690bedc 100644 --- a/docs/cmdline-opts/ipv4.d +++ b/docs/cmdline-opts/ipv4.d @@ -1,4 +1,4 @@ -c: Copyright (C) 1998 - 2022, Daniel Stenberg, <daniel@haxx.se>, et al. +c: Copyright (C) Daniel Stenberg, <daniel@haxx.se>, et al. SPDX-License-Identifier: curl Short: 4 Long: ipv4 @@ -11,7 +11,7 @@ See-also: http1.1 http2 Help: Resolve names to IPv4 addresses Category: connection dns Example: --ipv4 $URL -Multi: boolean +Multi: mutex --- -This option tells curl to use IPv4 addresses only, and not for example try -IPv6. +This option tells curl to use IPv4 addresses only when resolving host names, +and not for example try IPv6. diff --git a/docs/cmdline-opts/ipv6.d b/docs/cmdline-opts/ipv6.d index 16c47f178..24ce201a2 100644 --- a/docs/cmdline-opts/ipv6.d +++ b/docs/cmdline-opts/ipv6.d @@ -1,4 +1,4 @@ -c: Copyright (C) 1998 - 2022, Daniel Stenberg, <daniel@haxx.se>, et al. +c: Copyright (C) Daniel Stenberg, <daniel@haxx.se>, et al. SPDX-License-Identifier: curl Short: 6 Long: ipv6 @@ -11,7 +11,7 @@ See-also: http1.1 http2 Help: Resolve names to IPv6 addresses Category: connection dns Example: --ipv6 $URL -Multi: boolean +Multi: mutex --- -This option tells curl to use IPv6 addresses only, and not for example try -IPv4. +This option tells curl to use IPv6 addresses only when resolving host names, +and not for example try IPv4. diff --git a/docs/cmdline-opts/json.d b/docs/cmdline-opts/json.d index d2ea553b0..aa3b49de2 100644 --- a/docs/cmdline-opts/json.d +++ b/docs/cmdline-opts/json.d @@ -1,4 +1,4 @@ -c: Copyright (C) 1998 - 2022, Daniel Stenberg, <daniel@haxx.se>, et al. +c: Copyright (C) Daniel Stenberg, <daniel@haxx.se>, et al. SPDX-License-Identifier: curl Long: json Arg: <data> @@ -30,6 +30,6 @@ from stdin. Posting data from a file named 'foobar' would thus be done with --json @foobar and to instead read the data from stdin, use --json @-. If this option is used more than once on the same command line, the additional -data pieces will be concatenated to the previous before sending. +data pieces are concatenated to the previous before sending. The headers this option sets can be overridden with --header as usual. diff --git a/docs/cmdline-opts/junk-session-cookies.d b/docs/cmdline-opts/junk-session-cookies.d index 7816125fa..daea7840a 100644 --- a/docs/cmdline-opts/junk-session-cookies.d +++ b/docs/cmdline-opts/junk-session-cookies.d @@ -1,4 +1,4 @@ -c: Copyright (C) 1998 - 2022, Daniel Stenberg, <daniel@haxx.se>, et al. +c: Copyright (C) Daniel Stenberg, <daniel@haxx.se>, et al. SPDX-License-Identifier: curl Long: junk-session-cookies Short: j @@ -10,7 +10,6 @@ Example: --junk-session-cookies -b cookies.txt $URL Added: 7.9.7 Multi: boolean --- -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 -a new session is started. Typical browsers always discard session cookies when -they are closed down. +When curl is told to read cookies from a given file, this option makes it +discard all "session cookies". This has the same effect as if a new session is +started. Typical browsers discard session cookies when they are closed down. diff --git a/docs/cmdline-opts/keepalive-time.d b/docs/cmdline-opts/keepalive-time.d index 9667633b9..5e284774d 100644 --- a/docs/cmdline-opts/keepalive-time.d +++ b/docs/cmdline-opts/keepalive-time.d @@ -1,4 +1,4 @@ -c: Copyright (C) 1998 - 2022, Daniel Stenberg, <daniel@haxx.se>, et al. +c: Copyright (C) Daniel Stenberg, <daniel@haxx.se>, et al. SPDX-License-Identifier: curl Long: keepalive-time Arg: <seconds> diff --git a/docs/cmdline-opts/key-type.d b/docs/cmdline-opts/key-type.d index 83ab99b94..22339b4c9 100644 --- a/docs/cmdline-opts/key-type.d +++ b/docs/cmdline-opts/key-type.d @@ -1,4 +1,4 @@ -c: Copyright (C) 1998 - 2022, Daniel Stenberg, <daniel@haxx.se>, et al. +c: Copyright (C) Daniel Stenberg, <daniel@haxx.se>, et al. SPDX-License-Identifier: curl Long: key-type Arg: <type> diff --git a/docs/cmdline-opts/key.d b/docs/cmdline-opts/key.d index 3e07c8ed1..4236218c9 100644 --- a/docs/cmdline-opts/key.d +++ b/docs/cmdline-opts/key.d @@ -1,4 +1,4 @@ -c: Copyright (C) 1998 - 2022, Daniel Stenberg, <daniel@haxx.se>, et al. +c: Copyright (C) Daniel Stenberg, <daniel@haxx.se>, et al. SPDX-License-Identifier: curl Long: key Arg: <key> @@ -15,11 +15,11 @@ file. For SSH, if not specified, curl tries the following candidates in order: '~/.ssh/id_rsa', '~/.ssh/id_dsa', './id_rsa', './id_dsa'. If curl is built against OpenSSL library, and the engine pkcs11 is available, -then a PKCS#11 URI (RFC 7512) can be used to specify a private key located in a -PKCS#11 device. A string beginning with "pkcs11:" will be interpreted as a -PKCS#11 URI. If a PKCS#11 URI is provided, then the --engine option will be set -as "pkcs11" if none was provided and the --key-type option will be set as -"ENG" if none was provided. +then a PKCS#11 URI (RFC 7512) can be used to specify a private key located in +a PKCS#11 device. A string beginning with "pkcs11:" is interpreted as a +PKCS#11 URI. If a PKCS#11 URI is provided, then the --engine option is set as +"pkcs11" if none was provided and the --key-type option is set as "ENG" if +none was provided. If curl is built against Secure Transport or Schannel then this option is ignored for TLS protocols (HTTPS, etc). Those backends expect the private key diff --git a/docs/cmdline-opts/krb.d b/docs/cmdline-opts/krb.d index b2375ee79..42aa67ada 100644 --- a/docs/cmdline-opts/krb.d +++ b/docs/cmdline-opts/krb.d @@ -1,4 +1,4 @@ -c: Copyright (C) 1998 - 2022, Daniel Stenberg, <daniel@haxx.se>, et al. +c: Copyright (C) Daniel Stenberg, <daniel@haxx.se>, et al. SPDX-License-Identifier: curl Long: krb Arg: <level> @@ -13,4 +13,4 @@ Multi: single --- Enable Kerberos authentication and use. The level must be entered and should be one of 'clear', 'safe', 'confidential', or 'private'. Should you use a -level that is not one of these, 'private' will instead be used. +level that is not one of these, 'private' is used. diff --git a/docs/cmdline-opts/libcurl.d b/docs/cmdline-opts/libcurl.d index da845d939..52e252f3b 100644 --- a/docs/cmdline-opts/libcurl.d +++ b/docs/cmdline-opts/libcurl.d @@ -1,4 +1,4 @@ -c: Copyright (C) 1998 - 2022, Daniel Stenberg, <daniel@haxx.se>, et al. +c: Copyright (C) Daniel Stenberg, <daniel@haxx.se>, et al. SPDX-License-Identifier: curl Long: libcurl Arg: <file> @@ -8,10 +8,8 @@ Category: curl Example: --libcurl client.c $URL See-also: verbose Multi: single +Scope: global --- -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 -of what your command-line operation does! - -This option is global and does not need to be specified for each use of ---next. +Append this option to any ordinary curl command line, and you get +libcurl-using C source code written to the file that does the equivalent of +what your command-line operation does! diff --git a/docs/cmdline-opts/limit-rate.d b/docs/cmdline-opts/limit-rate.d index 0a1e4cf60..43ebf2c23 100644 --- a/docs/cmdline-opts/limit-rate.d +++ b/docs/cmdline-opts/limit-rate.d @@ -1,4 +1,4 @@ -c: Copyright (C) 1998 - 2022, Daniel Stenberg, <daniel@haxx.se>, et al. +c: Copyright (C) Daniel Stenberg, <daniel@haxx.se>, et al. SPDX-License-Identifier: curl Long: limit-rate Arg: <speed> @@ -8,7 +8,7 @@ Example: --limit-rate 100K $URL Example: --limit-rate 1000 $URL Example: --limit-rate 10M $URL Added: 7.10 -See-also: speed-limit speed-time +See-also: rate speed-limit speed-time Multi: single --- Specify the maximum transfer rate you want curl to use - for both downloads @@ -17,13 +17,13 @@ your transfer not to use your entire bandwidth. To make it slower than it otherwise would be. The given speed is measured in bytes/second, unless a suffix is appended. -Appending 'k' or 'K' will count the number as kilobytes, 'm' or 'M' makes it +Appending 'k' or 'K' counts the number as kilobytes, 'm' or 'M' makes it megabytes, while 'g' or 'G' makes it gigabytes. The suffixes (k, M, G, T, P) are 1024 based. For example 1k is 1024. Examples: 200K, 3m and 1G. The rate limiting logic works on averaging the transfer speed to no more than the set threshold over a period of multiple seconds. -If you also use the --speed-limit option, that option will take precedence and +If you also use the --speed-limit option, that option takes precedence and might cripple the rate-limiting slightly, to help keeping the speed-limit logic working. diff --git a/docs/cmdline-opts/list-only.d b/docs/cmdline-opts/list-only.d index d84974f49..dcfbf2ccc 100644 --- a/docs/cmdline-opts/list-only.d +++ b/docs/cmdline-opts/list-only.d @@ -1,11 +1,11 @@ -c: Copyright (C) 1998 - 2022, Daniel Stenberg, <daniel@haxx.se>, et al. +c: Copyright (C) Daniel Stenberg, <daniel@haxx.se>, et al. SPDX-License-Identifier: curl Long: list-only Short: l -Protocols: FTP POP3 +Protocols: FTP POP3 SFTP Help: List only mode Added: 4.0 -Category: ftp pop3 +Category: ftp pop3 sftp Example: --list-only ftp://example.com/dir/ See-also: quote request Multi: boolean @@ -20,6 +20,12 @@ the server instead of LIST. Note: Some FTP servers list only files in their response to NLST; they do not include sub-directories and symbolic links. +(SFTP) +When listing an SFTP directory, this switch forces a name-only view, one per line. +This is especially useful if the user wants to machine-parse the contents of an +SFTP directory since the normal directory view provides more information than just +file names. + (POP3) When retrieving a specific email from POP3, this switch forces a LIST command to be performed instead of RETR. This is particularly useful if the user wants diff --git a/docs/cmdline-opts/local-port.d b/docs/cmdline-opts/local-port.d index e889ee443..d6949b7ee 100644 --- a/docs/cmdline-opts/local-port.d +++ b/docs/cmdline-opts/local-port.d @@ -1,4 +1,4 @@ -c: Copyright (C) 1998 - 2022, Daniel Stenberg, <daniel@haxx.se>, et al. +c: Copyright (C) Daniel Stenberg, <daniel@haxx.se>, et al. SPDX-License-Identifier: curl Long: local-port Arg: <num/range> @@ -11,5 +11,5 @@ Multi: single --- 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 -that will be busy at times so setting this range to something too narrow might -cause unnecessary connection setup failures. +so setting this range to something too narrow might cause unnecessary +connection setup failures. diff --git a/docs/cmdline-opts/location-trusted.d b/docs/cmdline-opts/location-trusted.d index 8d19416d7..9f83d0ef0 100644 --- a/docs/cmdline-opts/location-trusted.d +++ b/docs/cmdline-opts/location-trusted.d @@ -1,4 +1,4 @@ -c: Copyright (C) 1998 - 2022, Daniel Stenberg, <daniel@haxx.se>, et al. +c: Copyright (C) Daniel Stenberg, <daniel@haxx.se>, et al. SPDX-License-Identifier: curl Long: location-trusted Help: Like --location, and send auth to other hosts @@ -9,7 +9,7 @@ Example: --location-trusted -u user:password $URL Added: 7.10.4 Multi: boolean --- -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 redirects you to a site to which you will send your authentication -info (which is plaintext in the case of HTTP Basic authentication). +Like --location, but allows 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 redirects you to a site to which you send your authentication info +(which is plaintext in the case of HTTP Basic authentication). diff --git a/docs/cmdline-opts/location.d b/docs/cmdline-opts/location.d index c3b2b5d82..9a99a0513 100644 --- a/docs/cmdline-opts/location.d +++ b/docs/cmdline-opts/location.d @@ -1,4 +1,4 @@ -c: Copyright (C) 1998 - 2022, Daniel Stenberg, <daniel@haxx.se>, et al. +c: Copyright (C) Daniel Stenberg, <daniel@haxx.se>, et al. SPDX-License-Identifier: curl Long: location Short: L @@ -12,18 +12,19 @@ Multi: boolean --- If the server reports that the requested page has moved to a different location (indicated with a Location: header and a 3XX response code), this -option will make curl redo the request on the new place. If used together with ---include or --head, headers from all requested pages will be shown. When -authentication is used, curl only sends its credentials to the initial -host. If a redirect takes curl to a different host, it will not be able to -intercept the user+password. See also --location-trusted on how to change -this. You can limit the amount of redirects to follow by using the ---max-redirs option. +option makes curl redo the request on the new place. If used together with +--include or --head, headers from all requested pages are shown. -When curl follows a redirect and if the request is a POST, it will send the +When authentication is used, curl only sends its credentials to the initial +host. If a redirect takes curl to a different host, it does not get the +user+password pass on. See also --location-trusted on how to change this. + +Limit the amount of redirects to follow by using the --max-redirs option. + +When curl follows a redirect and if the request is a POST, it sends the following request with a GET if the HTTP response was 301, 302, or 303. If the -response code was any other 3xx code, curl will re-send the following request -using the same unmodified method. +response code was any other 3xx code, curl resends the following request using +the same unmodified method. You can tell curl to not change POST requests to GET after a 30x response by using the dedicated options for that: --post301, --post302 and --post303. diff --git a/docs/cmdline-opts/login-options.d b/docs/cmdline-opts/login-options.d index e9e07a3ef..c67be90f8 100644 --- a/docs/cmdline-opts/login-options.d +++ b/docs/cmdline-opts/login-options.d @@ -1,4 +1,4 @@ -c: Copyright (C) 1998 - 2022, Daniel Stenberg, <daniel@haxx.se>, et al. +c: Copyright (C) Daniel Stenberg, <daniel@haxx.se>, et al. SPDX-License-Identifier: curl Long: login-options Arg: <options> @@ -13,6 +13,13 @@ Multi: single Specify the login options to use during server authentication. You can use login options to specify protocol specific options that may be -used during authentication. At present only IMAP, POP3 and SMTP support -login options. For more information about login options please see RFC -2384, RFC 5092 and IETF draft draft-earhart-url-smtp-00.txt +used during authentication. At present only IMAP, POP3 and SMTP support login +options. For more information about login options please see RFC 2384, +RFC 5092 and the IETF draft +https://datatracker.ietf.org/doc/html/draft-earhart-url-smtp-00. + +Since 8.2.0, IMAP supports the login option "AUTH=+LOGIN". With this option, +curl uses the plain (not SASL) LOGIN IMAP command even if the server +advertises SASL authentication. Care should be taken in using this option, as +it sends your password over the network in plain text. This does not work if +the IMAP server disables the plain LOGIN (e.g. to prevent password snooping). diff --git a/docs/cmdline-opts/mail-auth.d b/docs/cmdline-opts/mail-auth.d index e215575be..45ceebd99 100644 --- a/docs/cmdline-opts/mail-auth.d +++ b/docs/cmdline-opts/mail-auth.d @@ -1,4 +1,4 @@ -c: Copyright (C) 1998 - 2022, Daniel Stenberg, <daniel@haxx.se>, et al. +c: Copyright (C) Daniel Stenberg, <daniel@haxx.se>, et al. SPDX-License-Identifier: curl Long: mail-auth Arg: <address> @@ -10,6 +10,5 @@ Category: smtp Example: --mail-auth user@example.come -T mail smtp://example.com/ Multi: single --- -Specify a single address. This will be used to specify the authentication -address (identity) of a submitted message that is being relayed to another -server. +Specify a single address. This is used to specify the authentication address +(identity) of a submitted message that is being relayed to another server. diff --git a/docs/cmdline-opts/mail-from.d b/docs/cmdline-opts/mail-from.d index c96193840..0729e841a 100644 --- a/docs/cmdline-opts/mail-from.d +++ b/docs/cmdline-opts/mail-from.d @@ -1,4 +1,4 @@ -c: Copyright (C) 1998 - 2022, Daniel Stenberg, <daniel@haxx.se>, et al. +c: Copyright (C) Daniel Stenberg, <daniel@haxx.se>, et al. SPDX-License-Identifier: curl Long: mail-from Arg: <address> diff --git a/docs/cmdline-opts/mail-rcpt-allowfails.d b/docs/cmdline-opts/mail-rcpt-allowfails.d index d14b9e8f0..d2a5f39d3 100644 --- a/docs/cmdline-opts/mail-rcpt-allowfails.d +++ b/docs/cmdline-opts/mail-rcpt-allowfails.d @@ -1,4 +1,4 @@ -c: Copyright (C) 1998 - 2022, Daniel Stenberg, <daniel@haxx.se>, et al. +c: Copyright (C) Daniel Stenberg, <daniel@haxx.se>, et al. SPDX-License-Identifier: curl Long: mail-rcpt-allowfails Help: Allow RCPT TO command to fail for some recipients @@ -9,14 +9,14 @@ Example: --mail-rcpt-allowfails --mail-rcpt dest@example.com smtp://example.com See-also: mail-rcpt Multi: boolean --- -When sending data to multiple recipients, by default curl will abort SMTP +When sending data to multiple recipients, by default curl aborts SMTP conversation if at least one of the recipients causes RCPT TO command to return an error. The default behavior can be changed by passing --mail-rcpt-allowfails -command-line option which will make curl ignore errors and proceed with the +command-line option which makes curl ignore errors and proceed with the remaining valid recipients. If all recipients trigger RCPT TO failures and this flag is specified, curl -will still abort the SMTP conversation and return the error received from to -the last RCPT TO command. +still aborts the SMTP conversation and returns the error received from to the +last RCPT TO command. diff --git a/docs/cmdline-opts/mail-rcpt.d b/docs/cmdline-opts/mail-rcpt.d index d1e6a1561..a4b16c4f7 100644 --- a/docs/cmdline-opts/mail-rcpt.d +++ b/docs/cmdline-opts/mail-rcpt.d @@ -1,4 +1,4 @@ -c: Copyright (C) 1998 - 2022, Daniel Stenberg, <daniel@haxx.se>, et al. +c: Copyright (C) Daniel Stenberg, <daniel@haxx.se>, et al. SPDX-License-Identifier: curl Long: mail-rcpt Arg: <address> @@ -13,9 +13,9 @@ Multi: append Specify a single email address, user name or mailing list name. Repeat this option several times to send to multiple recipients. -When performing an address verification (VRFY command), the recipient should be +When performing an address verification (**VRFY** command), the recipient should be specified as the user name or user name and domain (as per Section 3.5 of -RFC5321). (Added in 7.34.0) +RFC 5321). (Added in 7.34.0) When performing a mailing list expand (EXPN command), the recipient should be specified using the mailing list name, such as "Friends" or "London-Office". diff --git a/docs/cmdline-opts/manual.d b/docs/cmdline-opts/manual.d index e6d439713..9ee4d075a 100644 --- a/docs/cmdline-opts/manual.d +++ b/docs/cmdline-opts/manual.d @@ -1,4 +1,4 @@ -c: Copyright (C) 1998 - 2022, Daniel Stenberg, <daniel@haxx.se>, et al. +c: Copyright (C) Daniel Stenberg, <daniel@haxx.se>, et al. SPDX-License-Identifier: curl Long: manual Short: M @@ -7,6 +7,6 @@ Category: curl Example: --manual Added: 5.2 See-also: verbose libcurl trace -Multi: boolean +Multi: custom --- Manual. Display the huge help text. diff --git a/docs/cmdline-opts/max-filesize.d b/docs/cmdline-opts/max-filesize.d index 822252e82..7541a2712 100644 --- a/docs/cmdline-opts/max-filesize.d +++ b/docs/cmdline-opts/max-filesize.d @@ -1,4 +1,4 @@ -c: Copyright (C) 1998 - 2022, Daniel Stenberg, <daniel@haxx.se>, et al. +c: Copyright (C) Daniel Stenberg, <daniel@haxx.se>, et al. SPDX-License-Identifier: curl Long: max-filesize Arg: <bytes> @@ -11,13 +11,16 @@ Added: 7.10.8 Multi: single --- 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 -return with exit code 63. +requested is larger than this value, the transfer does not start and curl +returns with exit code 63. -A size modifier may be used. For example, Appending 'k' or 'K' will count the +A size modifier may be used. For example, Appending 'k' or 'K' counts the number as kilobytes, 'm' or 'M' makes it megabytes, while 'g' or 'G' makes it gigabytes. Examples: 200K, 3m and 1G. (Added in 7.58.0) -**NOTE**: The file size is not always known prior to download, and for such -files this option has no effect even if the file transfer ends up being larger -than this given limit.
\ No newline at end of file +**NOTE**: before curl 8.4.0, when the file size is not known prior to +download, for such files this option has no effect even if the file transfer +ends up being larger than this given limit. + +Starting with curl 8.4.0, this option aborts the transfer if it reaches the +threshold during transfer. diff --git a/docs/cmdline-opts/max-redirs.d b/docs/cmdline-opts/max-redirs.d index f8434748e..31ce98ea5 100644 --- a/docs/cmdline-opts/max-redirs.d +++ b/docs/cmdline-opts/max-redirs.d @@ -1,4 +1,4 @@ -c: Copyright (C) 1998 - 2022, Daniel Stenberg, <daniel@haxx.se>, et al. +c: Copyright (C) Daniel Stenberg, <daniel@haxx.se>, et al. SPDX-License-Identifier: curl Long: max-redirs Arg: <num> diff --git a/docs/cmdline-opts/max-time.d b/docs/cmdline-opts/max-time.d index 8efef1279..0d5747b26 100644 --- a/docs/cmdline-opts/max-time.d +++ b/docs/cmdline-opts/max-time.d @@ -1,4 +1,4 @@ -c: Copyright (C) 1998 - 2022, Daniel Stenberg, <daniel@haxx.se>, et al. +c: Copyright (C) Daniel Stenberg, <daniel@haxx.se>, et al. SPDX-License-Identifier: curl Long: max-time Short: m @@ -11,12 +11,13 @@ Example: --max-time 2.92 $URL Added: 4.0 Multi: single --- -Maximum time in seconds that you allow each transfer to take. This is -useful for preventing your batch jobs from hanging for hours due to slow -networks or links going down. Since 7.32.0, this option accepts decimal -values, but the actual timeout will decrease in accuracy as the specified -timeout increases in decimal precision. +Maximum time in seconds that you allow each transfer to take. This is useful +for preventing your batch jobs from hanging for hours due to slow networks or +links going down. This option accepts decimal values (added in 7.32.0). If you enable retrying the transfer (--retry) then the maximum time counter is reset each time the transfer is retried. You can use --retry-max-time to limit the retry time. + +The decimal value needs to provided using a dot (.) as decimal separator - not +the local version even if it might be using another separator. diff --git a/docs/cmdline-opts/metalink.d b/docs/cmdline-opts/metalink.d index 2a05228ae..88f012176 100644 --- a/docs/cmdline-opts/metalink.d +++ b/docs/cmdline-opts/metalink.d @@ -1,4 +1,4 @@ -c: Copyright (C) 1998 - 2022, Daniel Stenberg, <daniel@haxx.se>, et al. +c: Copyright (C) Daniel Stenberg, <daniel@haxx.se>, et al. SPDX-License-Identifier: curl Long: metalink Help: Process given URLs as metalink XML file @@ -8,5 +8,5 @@ Example: --metalink file $URL See-also: parallel Multi: single --- -This option was previously used to specify a metalink resource. Metalink -support has been disabled in curl since 7.78.0 for security reasons. +This option was previously used to specify a Metalink resource. Metalink +support is disabled in curl for security reasons (added in 7.78.0). diff --git a/docs/cmdline-opts/negotiate.d b/docs/cmdline-opts/negotiate.d index 727f89826..f1dd34dba 100644 --- a/docs/cmdline-opts/negotiate.d +++ b/docs/cmdline-opts/negotiate.d @@ -1,4 +1,4 @@ -c: Copyright (C) 1998 - 2022, Daniel Stenberg, <daniel@haxx.se>, et al. +c: Copyright (C) Daniel Stenberg, <daniel@haxx.se>, et al. SPDX-License-Identifier: curl Long: negotiate Help: Use HTTP Negotiate (SPNEGO) authentication @@ -17,5 +17,3 @@ This option requires a library built with GSS-API or SSPI support. Use When using this option, you must also provide a fake --user option to activate the authentication code properly. Sending a '-u :' is enough as the user name and password from the --user option are not actually used. - -If this option is used several times, only the first one is used. diff --git a/docs/cmdline-opts/netrc-file.d b/docs/cmdline-opts/netrc-file.d index f50c0ed34..7b1a214da 100644 --- a/docs/cmdline-opts/netrc-file.d +++ b/docs/cmdline-opts/netrc-file.d @@ -1,4 +1,4 @@ -c: Copyright (C) 1998 - 2022, Daniel Stenberg, <daniel@haxx.se>, et al. +c: Copyright (C) Daniel Stenberg, <daniel@haxx.se>, et al. SPDX-License-Identifier: curl Long: netrc-file Help: Specify FILE for netrc @@ -14,4 +14,4 @@ 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 netrc file per invocation. -It will abide by --netrc-optional if specified. +It abides by --netrc-optional if specified. diff --git a/docs/cmdline-opts/netrc-optional.d b/docs/cmdline-opts/netrc-optional.d index 6d96acf6c..a7759640f 100644 --- a/docs/cmdline-opts/netrc-optional.d +++ b/docs/cmdline-opts/netrc-optional.d @@ -1,4 +1,4 @@ -c: Copyright (C) 1998 - 2022, Daniel Stenberg, <daniel@haxx.se>, et al. +c: Copyright (C) Daniel Stenberg, <daniel@haxx.se>, et al. SPDX-License-Identifier: curl Long: netrc-optional Help: Use either .netrc or URL diff --git a/docs/cmdline-opts/netrc.d b/docs/cmdline-opts/netrc.d index 7f109f7ad..f0ec75f37 100644 --- a/docs/cmdline-opts/netrc.d +++ b/docs/cmdline-opts/netrc.d @@ -1,4 +1,4 @@ -c: Copyright (C) 1998 - 2022, Daniel Stenberg, <daniel@haxx.se>, et al. +c: Copyright (C) Daniel Stenberg, <daniel@haxx.se>, et al. SPDX-License-Identifier: curl Long: netrc Short: n @@ -7,15 +7,19 @@ Category: curl Example: --netrc $URL Added: 4.6 See-also: netrc-file config user +Mutexed: netrc-file netrc-optional Multi: boolean --- -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 -Unix. If used with HTTP, curl will enable user authentication. See -*netrc(5)* and *ftp(1)* for details on the file format. Curl will not -complain if that file does not have the right permissions (it should be -neither world- nor group-readable). The environment variable "HOME" is used -to find the home directory. +Makes curl scan the *.netrc* file in the user's home directory for login name +and password. This is typically used for FTP on Unix. If used with HTTP, curl +enables user authentication. See *netrc(5)* and *ftp(1)* for details on the +file format. Curl does not complain if that file does not have the right +permissions (it should be neither world- nor group-readable). The environment +variable "HOME" is used to find the home directory. + +On Windows two filenames in the home directory are checked: *.netrc* and +*_netrc*, preferring the former. Older versions on Windows checked for *_netrc* +only. A quick and simple example of how to setup a *.netrc* to allow curl to FTP to the machine host.domain.com with user name 'myself' and password 'secret' diff --git a/docs/cmdline-opts/next.d b/docs/cmdline-opts/next.d index 49a3d2e2e..93c9c45b3 100644 --- a/docs/cmdline-opts/next.d +++ b/docs/cmdline-opts/next.d @@ -1,4 +1,4 @@ -c: Copyright (C) 1998 - 2022, Daniel Stenberg, <daniel@haxx.se>, et al. +c: Copyright (C) Daniel Stenberg, <daniel@haxx.se>, et al. SPDX-License-Identifier: curl Short: : Long: next @@ -18,9 +18,9 @@ options. This allows you to send several URL requests, each with their own specific options, for example, such as different user names or custom requests for each. ---next will reset all local options and only global ones will have their -values survive over to the operation following the --next instruction. Global -options include --verbose, --trace, --trace-ascii and --fail-early. +--next resets all local options and only global ones have their values survive +over to the operation following the --next instruction. Global 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: diff --git a/docs/cmdline-opts/no-alpn.d b/docs/cmdline-opts/no-alpn.d index 8f01f4af4..102f2990e 100644 --- a/docs/cmdline-opts/no-alpn.d +++ b/docs/cmdline-opts/no-alpn.d @@ -1,4 +1,4 @@ -c: Copyright (C) 1998 - 2022, Daniel Stenberg, <daniel@haxx.se>, et al. +c: Copyright (C) Daniel Stenberg, <daniel@haxx.se>, et al. SPDX-License-Identifier: curl Long: no-alpn Tags: HTTP/2 @@ -14,3 +14,6 @@ Multi: boolean Disable the ALPN TLS extension. ALPN is enabled by default if libcurl was built with an SSL library that supports ALPN. ALPN is used by a libcurl that supports HTTP/2 to negotiate HTTP/2 support with the server during https sessions. + +Note that this is the negated option name documented. You can use --alpn to +enable ALPN. diff --git a/docs/cmdline-opts/no-buffer.d b/docs/cmdline-opts/no-buffer.d index 2de48c97c..33f6fbc5b 100644 --- a/docs/cmdline-opts/no-buffer.d +++ b/docs/cmdline-opts/no-buffer.d @@ -1,4 +1,4 @@ -c: Copyright (C) 1998 - 2022, Daniel Stenberg, <daniel@haxx.se>, et al. +c: Copyright (C) Daniel Stenberg, <daniel@haxx.se>, et al. SPDX-License-Identifier: curl Long: no-buffer Short: N @@ -10,6 +10,9 @@ See-also: progress-bar Multi: boolean --- 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 -will output the data in chunks, not necessarily exactly when the data arrives. -Using this option will disable that buffering. +uses a standard buffered output stream that has the effect that it outputs the +data in chunks, not necessarily exactly when the data arrives. Using this +option disables that buffering. + +Note that this is the negated option name documented. You can use --buffer to +enable buffering again. diff --git a/docs/cmdline-opts/no-clobber.d b/docs/cmdline-opts/no-clobber.d index d8fc3f141..9325558da 100644 --- a/docs/cmdline-opts/no-clobber.d +++ b/docs/cmdline-opts/no-clobber.d @@ -1,4 +1,4 @@ -c: Copyright (C) 1998 - 2022, Daniel Stenberg, <daniel@haxx.se>, et al. +c: Copyright (C) Daniel Stenberg, <daniel@haxx.se>, et al. SPDX-License-Identifier: curl Long: no-clobber Help: Do not overwrite files that already exist @@ -10,10 +10,10 @@ Multi: boolean --- When used in conjunction with the --output, --remote-header-name, --remote-name, or --remote-name-all options, curl avoids overwriting files -that already exist. Instead, a dot and a number gets appended to the name -of the file that would be created, up to filename.100 after which it will not +that already exist. Instead, a dot and a number gets appended to the name of +the file that would be created, up to filename.100 after which it does not create any file. Note that this is the negated option name documented. You can thus use ---clobber to enforce the clobbering, even if --remote-header-name or -J is +--clobber to enforce the clobbering, even if --remote-header-name is specified. diff --git a/docs/cmdline-opts/no-keepalive.d b/docs/cmdline-opts/no-keepalive.d index 0f4464647..0aeaef8d5 100644 --- a/docs/cmdline-opts/no-keepalive.d +++ b/docs/cmdline-opts/no-keepalive.d @@ -1,4 +1,4 @@ -c: Copyright (C) 1998 - 2022, Daniel Stenberg, <daniel@haxx.se>, et al. +c: Copyright (C) Daniel Stenberg, <daniel@haxx.se>, et al. SPDX-License-Identifier: curl Long: no-keepalive Help: Disable TCP keepalive on the connection diff --git a/docs/cmdline-opts/no-npn.d b/docs/cmdline-opts/no-npn.d index 97314e8cc..cd0e5e2af 100644 --- a/docs/cmdline-opts/no-npn.d +++ b/docs/cmdline-opts/no-npn.d @@ -1,4 +1,4 @@ -c: Copyright (C) 1998 - 2022, Daniel Stenberg, <daniel@haxx.se>, et al. +c: Copyright (C) Daniel Stenberg, <daniel@haxx.se>, et al. SPDX-License-Identifier: curl Long: no-npn Tags: Versions HTTP/2 @@ -12,7 +12,7 @@ Category: tls http Example: --no-npn $URL Multi: boolean --- -In curl 7.86.0 and later, curl never uses NPN. +curl never uses NPN, this option has no effect (added in 7.86.0). Disable the NPN TLS extension. NPN is enabled by default if libcurl was built with an SSL library that supports NPN. NPN is used by a libcurl that supports diff --git a/docs/cmdline-opts/no-progress-meter.d b/docs/cmdline-opts/no-progress-meter.d index 9a298c44c..820557d9d 100644 --- a/docs/cmdline-opts/no-progress-meter.d +++ b/docs/cmdline-opts/no-progress-meter.d @@ -1,4 +1,4 @@ -c: Copyright (C) 1998 - 2022, Daniel Stenberg, <daniel@haxx.se>, et al. +c: Copyright (C) Daniel Stenberg, <daniel@haxx.se>, et al. SPDX-License-Identifier: curl Long: no-progress-meter Help: Do not show the progress meter diff --git a/docs/cmdline-opts/no-sessionid.d b/docs/cmdline-opts/no-sessionid.d index b3e51b216..9699f46bc 100644 --- a/docs/cmdline-opts/no-sessionid.d +++ b/docs/cmdline-opts/no-sessionid.d @@ -1,4 +1,4 @@ -c: Copyright (C) 1998 - 2022, Daniel Stenberg, <daniel@haxx.se>, et al. +c: Copyright (C) Daniel Stenberg, <daniel@haxx.se>, et al. SPDX-License-Identifier: curl Long: no-sessionid Help: Disable SSL session-ID reusing diff --git a/docs/cmdline-opts/noproxy.d b/docs/cmdline-opts/noproxy.d index c28e897eb..001c109b6 100644 --- a/docs/cmdline-opts/noproxy.d +++ b/docs/cmdline-opts/noproxy.d @@ -1,4 +1,4 @@ -c: Copyright (C) 1998 - 2022, Daniel Stenberg, <daniel@haxx.se>, et al. +c: Copyright (C) Daniel Stenberg, <daniel@haxx.se>, et al. SPDX-License-Identifier: curl Long: noproxy Arg: <no-proxy-list> @@ -16,6 +16,12 @@ either a domain which contains the hostname, or the hostname itself. For example, local.com would match local.com, local.com:80, and www.local.com, but not www.notlocal.com. -Since 7.53.0, This option overrides the environment variables that disable the -proxy ('no_proxy' and 'NO_PROXY'). If there's an environment variable -disabling a proxy, you can set the noproxy list to "" to override it. +This option overrides the environment variables that disable the proxy +('no_proxy' and 'NO_PROXY') (added in 7.53.0). If there is an environment +variable disabling a proxy, you can set the no proxy list to "" to override +it. + +IP addresses specified to this option can be provided using CIDR notation +(added in 7.86.0): an appended slash and number specifies the number of +"network bits" out of the address to use in the comparison. For example +"192.168.0.0/16" would match all addresses starting with "192.168". diff --git a/docs/cmdline-opts/ntlm-wb.d b/docs/cmdline-opts/ntlm-wb.d index 7317adc78..4a3225293 100644 --- a/docs/cmdline-opts/ntlm-wb.d +++ b/docs/cmdline-opts/ntlm-wb.d @@ -1,4 +1,4 @@ -c: Copyright (C) 1998 - 2022, Daniel Stenberg, <daniel@haxx.se>, et al. +c: Copyright (C) Daniel Stenberg, <daniel@haxx.se>, et al. SPDX-License-Identifier: curl Long: ntlm-wb Help: Use HTTP NTLM authentication with winbind diff --git a/docs/cmdline-opts/ntlm.d b/docs/cmdline-opts/ntlm.d index 9e1a99687..cc98c51e3 100644 --- a/docs/cmdline-opts/ntlm.d +++ b/docs/cmdline-opts/ntlm.d @@ -1,4 +1,4 @@ -c: Copyright (C) 1998 - 2022, Daniel Stenberg, <daniel@haxx.se>, et al. +c: Copyright (C) Daniel Stenberg, <daniel@haxx.se>, et al. SPDX-License-Identifier: curl Long: ntlm Help: Use HTTP NTLM authentication @@ -20,5 +20,3 @@ method instead, such as Digest. If you want to enable NTLM for your proxy authentication, then use --proxy-ntlm. - -If this option is used several times, only the first one is used. diff --git a/docs/cmdline-opts/oauth2-bearer.d b/docs/cmdline-opts/oauth2-bearer.d index 6b639cba0..6f3514784 100644 --- a/docs/cmdline-opts/oauth2-bearer.d +++ b/docs/cmdline-opts/oauth2-bearer.d @@ -1,4 +1,4 @@ -c: Copyright (C) 1998 - 2022, Daniel Stenberg, <daniel@haxx.se>, et al. +c: Copyright (C) Daniel Stenberg, <daniel@haxx.se>, et al. SPDX-License-Identifier: curl Long: oauth2-bearer Help: OAuth 2 Bearer Token diff --git a/docs/cmdline-opts/output-dir.d b/docs/cmdline-opts/output-dir.d index 5c53c7fdc..803b2948b 100644 --- a/docs/cmdline-opts/output-dir.d +++ b/docs/cmdline-opts/output-dir.d @@ -1,4 +1,4 @@ -c: Copyright (C) 1998 - 2022, Daniel Stenberg, <daniel@haxx.se>, et al. +c: Copyright (C) Daniel Stenberg, <daniel@haxx.se>, et al. SPDX-License-Identifier: curl Long: output-dir Arg: <dir> @@ -15,5 +15,5 @@ This option specifies the directory in which files should be stored, when The given output directory is used for all URLs and output options on the command line, up until the first --next. -If the specified target directory does not exist, the operation will fail -unless --create-dirs is also used. +If the specified target directory does not exist, the operation fails unless +--create-dirs is also used. diff --git a/docs/cmdline-opts/output.d b/docs/cmdline-opts/output.d index e3005d587..316f10999 100644 --- a/docs/cmdline-opts/output.d +++ b/docs/cmdline-opts/output.d @@ -1,4 +1,4 @@ -c: Copyright (C) 1998 - 2022, Daniel Stenberg, <daniel@haxx.se>, et al. +c: Copyright (C) Daniel Stenberg, <daniel@haxx.se>, et al. SPDX-License-Identifier: curl Long: output Arg: <file> @@ -8,42 +8,42 @@ 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: "http://{site,host}.host[1-5].example" -o "#1_#2" Example: -o file $URL -o file2 https://example.net Added: 4.0 Multi: append --- 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 -number in the <file> specifier. That variable will be replaced with the current +number in the <file> specifier. That variable is replaced with the current string for the URL being fetched. Like in: curl "http://{one,two}.example.com" -o "file_#1.txt" or use several variables like: - curl "http://{site,host}.host[1-5].com" -o "#1_#2" + curl "http://{site,host}.host[1-5].example" -o "#1_#2" You may use this option as many times as the number of URLs you have. For example, if you specify two URLs on the same command line, you can use it like this: - curl -o aa example.com -o bb example.net + curl -o aa example.com -o bb example.net and the order of the -o options and the URLs does not matter, just that the first -o is for the first URL and so on, so the above command line can also be written as - curl example.com example.net -o aa -o bb + curl example.com example.net -o aa -o bb See also the --create-dirs option to create the local directories -dynamically. Specifying the output as '-' (a single dash) will force the -output to be done to stdout. +dynamically. Specifying the output as '-' (a single dash) passes the output to +stdout. To suppress response bodies, you can redirect output to /dev/null: - curl example.com -o /dev/null + curl example.com -o /dev/null -Or for Windows use nul: +Or for Windows: - curl example.com -o nul + curl example.com -o nul diff --git a/docs/cmdline-opts/page-footer b/docs/cmdline-opts/page-footer index c8a65be04..af41c9482 100644 --- a/docs/cmdline-opts/page-footer +++ b/docs/cmdline-opts/page-footer @@ -37,64 +37,65 @@ 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. -IPv6 numerical addresses are compared as strings, so they will only match if -the representations are the same: "::1" is the same as "::0:1" but they do not -match. +IP addresses can be specified using CIDR notation: an appended slash and +number specifies the number of "network bits" out of the address to use in the +comparison (added in 7.86.0). For example "192.168.0.0/16" would match all +addresses starting with "192.168". .IP "APPDATA <dir>" On Windows, this variable is used when trying to find the home directory. If the primary home variable are all unset. .IP "COLUMNS <terminal width>" -If set, the specified number of characters will be used as the terminal width -when the alternative progress-bar is shown. If not set, curl will try to -figure it out using other ways. +If set, the specified number of characters is used as the terminal width when +the alternative progress-bar is shown. If not set, curl tries to figure it out +using other ways. .IP "CURL_CA_BUNDLE <file>" -If set, will be used as the \fI--cacert\fP value. +If set, it is used as the --cacert value. .IP "CURL_HOME <dir>" If set, is the first variable curl checks when trying to find its home -directory. If not set, it continues to check \fBXDG_CONFIG_HOME\fP. +directory. If not set, it continues to check *XDG_CONFIG_HOME* .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 -invoked. Setting a name that is not a built-in alternative will make curl -stay with the default. +invoked. Setting a name that is not a built-in alternative makes curl stay +with the default. -SSL backend names (case-insensitive): bearssl, gnutls, gskit, mbedtls, -nss, openssl, rustls, schannel, secure-transport, wolfssl +SSL backend names (case-insensitive): **bearssl**, **gnutls**, **mbedtls**, +**openssl**, **rustls**, **schannel**, **secure-transport**, **wolfssl** .IP "HOME <dir>" If set, this is used to find the home directory when that is needed. Like when -looking for the default .curlrc. \fBCURL_HOME\fP and \fBXDG_CONFIG_HOME\fP +looking for the default .curlrc. *CURL_HOME* and *XDG_CONFIG_HOME* have preference. .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 +local directory makes 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. +files can become rather large. Works with the ngtcp2 and quiche QUIC backends. .IP SHELL -Used on VMS when trying to detect if using a DCL or a "unix" shell. +Used on VMS when trying to detect if using a **DCL** or a **unix** shell. .IP "SSL_CERT_DIR <dir>" -If set, will be used as the \fI--capath\fP value. +If set, it is used as the --capath value. .IP "SSL_CERT_FILE <path>" -If set, will be used as the \fI--cacert\fP value. +If set, it is used as the --cacert value. .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. +If you set this environment variable to a file name, curl stores 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 +and wolfSSL. .IP "USERPROFILE <dir>" On Windows, this variable is used when trying to find the home directory. If -the other, primary, variable are all unset. If set, curl will use the path -"$USERPROFILE\\Application Data". +the other, primary, variable are all unset. If set, curl uses the path +**"$USERPROFILE\\Application Data"**. .IP "XDG_CONFIG_HOME <dir>" -If \fBCURL_HOME\fP is not set, this variable is checked when looking for a +If *CURL_HOME* is not set, this variable is checked when looking for a default .curlrc file. .SH "PROXY PROTOCOL PREFIXES" The proxy string may be specified with a protocol:// prefix to specify alternative proxy protocols. (Added in 7.21.7) -If no protocol is specified in the proxy string or if the string does not match -a supported one, the proxy will be treated as an HTTP proxy. +If no protocol is specified in the proxy string or if the string does not +match a supported one, the proxy is treated as an HTTP proxy. The supported proxy protocol prefixes are as follows: .IP "http://" @@ -172,8 +173,8 @@ appears if --fail is used. .IP 23 Write error. Curl could not write data to a local filesystem or similar. .IP 25 -FTP could not STOR file. The server denied the STOR operation, used for FTP -uploading. +Failed starting the upload. For FTP, the server typically denied the STOR +command. .IP 26 Read error. Various reading problems. .IP 27 @@ -242,7 +243,7 @@ Requested FTP SSL level failed. .IP 65 Sending the data requires a rewind that failed. .IP 66 -Failed to initialise SSL Engine. +Failed to initialize SSL Engine. .IP 67 The user name, password, or similar was not accepted and curl failed to log in. .IP 68 @@ -282,7 +283,7 @@ Unable to parse FTP file list. .IP 88 FTP chunk callback reported error. .IP 89 -No connection available, the session will be queued. +No connection available, the session is queued. .IP 90 SSL public key does not matched pinned public key. .IP 91 @@ -299,9 +300,15 @@ be one out of several problems, see the error message for details. .IP 96 QUIC connection error. This error may be caused by an SSL library error. QUIC is the protocol used for HTTP/3 transfers. +.IP 97 +Proxy handshake error. +.IP 98 +A client-side certificate is required to complete the TLS handshake. +.IP 99 +Poll or select returned fatal error. .IP XX -More error codes will appear here in future releases. The existing ones -are meant to never change. +More error codes might appear here in future releases. The existing ones are +meant to never change. .SH BUGS If you experience any problems with curl, submit an issue in the project's bug tracker on GitHub: https://github.com/curl/curl/issues diff --git a/docs/cmdline-opts/page-header b/docs/cmdline-opts/page-header index 1737ab5bd..7d14f4c45 100644 --- a/docs/cmdline-opts/page-header +++ b/docs/cmdline-opts/page-header @@ -5,7 +5,7 @@ .\" * | (__| |_| | _ <| |___ .\" * \___|\___/|_| \_\_____| .\" * -.\" * Copyright (C) 1998 - 2022, Daniel Stenberg, <daniel@haxx.se>, et al. +.\" * Copyright (C) Daniel Stenberg, <daniel@haxx.se>, et al. .\" * .\" * This software is licensed as described in the file COPYING, which .\" * you should have received as part of this distribution. The terms @@ -30,16 +30,10 @@ curl \- transfer a URL .SH SYNOPSIS .B curl [options / URLs] .SH DESCRIPTION -**curl** is a tool for transferring data from or to a server. It supports these -protocols: DICT, FILE, FTP, FTPS, GOPHER, GOPHERS, HTTP, HTTPS, IMAP, IMAPS, -LDAP, LDAPS, MQTT, POP3, POP3S, RTMP, RTMPS, RTSP, SCP, SFTP, SMB, SMBS, SMTP, -SMTPS, TELNET, TFTP, WS and WSS. 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 -resume and more. As you will see below, the number of features will make your -head spin. +**curl** is a tool for transferring data from or to a server using URLs. It +supports these protocols: DICT, FILE, FTP, FTPS, GOPHER, GOPHERS, HTTP, HTTPS, +IMAP, IMAPS, LDAP, LDAPS, MQTT, POP3, POP3S, RTMP, RTMPS, RTSP, SCP, SFTP, +SMB, SMBS, SMTP, SMTPS, TELNET, TFTP, WS and WSS. curl is powered by libcurl for all transfer-related features. See *libcurl(3)* for details. @@ -47,8 +41,33 @@ curl is powered by libcurl for all transfer-related features. See The URL syntax is protocol-dependent. You find a detailed description in RFC 3986. -You can specify multiple URLs or parts of URLs by writing part sets within -braces and quoting the URL as in: +If you provide a URL without a leading **protocol://** scheme, curl guesses +what protocol you want. It then defaults to HTTP but assumes others based on +often-used host name prefixes. For example, for host names starting with +"ftp." curl assumes you want FTP. + +You can specify any amount of URLs on the command line. They are fetched in a +sequential manner in the specified order unless you use --parallel. You can +specify command line options and URLs mixed and in any order on the command +line. + +curl attempts to reuse connections when doing multiple transfers, so that +getting many files from the same server do not use multiple connects and setup +handshakes. This improves speed. Connection reuse can only be done for URLs +specified for a single command line invocation and cannot be performed between +separate curl runs. + +Provide an IPv6 zone id in the URL with an escaped percentage sign. Like in + + "http://[fe80::3%25eth0]/" + +Everything provided on the command line that is not a command line option or +its argument, curl assumes is a URL and treats it as such. +.SH GLOBBING +You can specify multiple URLs or parts of URLs by writing lists within braces +or ranges within brackets. We call this "globbing". + +Provide a list with three different names like this: "http://site.{one,two,three}.com" @@ -65,10 +84,6 @@ other: "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 -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: @@ -81,25 +96,49 @@ probably have to put the full URL within double quotes to avoid the shell from interfering with it. This also goes for other characters treated special, like for example '&', '?' and '*'. -Provide the IPv6 zone index in the URL with an escaped percentage sign and the -interface name. Like in +Switch off globbing with --globoff. +.SH VARIABLES +curl supports command line variables (added in 8.3.0). Set variables with +--variable name=content or --variable name@file (where "file" can be stdin if +set to a single dash (-)). - "http://[fe80::3%25eth0]/" +Variable contents can expanded in option parameters using "{{name}}" (without +the quotes) if the option name is prefixed with "--expand-". This gets the +contents of the variable "name" inserted, or a blank if the name does not +exist as a variable. Insert "{{" verbatim in the string by prefixing it with a +backslash, like "\\{{". -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 -based on often-used host name prefixes. For example, for host names starting -with "ftp." curl will assume you want to speak FTP. +You an access and expand environment variables by first importing them. You +can select to either require the environment variable to be set or you can +provide a default value in case it is not already set. Plain --variable %name +imports the variable called 'name' but exits with an error if that environment +variable is not already set. To provide a default value if it is not set, use +--variable %name=content or --variable %name@content. -curl will do its best to use what you pass to it as a URL. It is not trying to -validate it as a syntactically correct URL by any means but is fairly liberal -with what it accepts. +Example. Get the USER environment variable into the URL, fail if USER is not +set: -curl will attempt to re-use connections for multiple file transfers, so that -getting many files from the same server will not do multiple connects / -handshakes. This improves speed. Of course this is only done on files -specified on a single command line and cannot be used between separate curl -invocations. + --variable '%USER' + --expand-url = "https://example.com/api/{{USER}}/method" + +When expanding variables, curl supports a set of functions that can make the +variable contents more convenient to use. It can trim leading and trailing +white space with *trim*, it can output the contents as a JSON quoted string +with *json*, URL encode the string with *url* or base64 encode it with +*b64*. You apply function to a variable expansion, add them colon separated to +the right side of the variable. Variable content holding null bytes that are +not encoded when expanded cause error. + +Example: get the contents of a file called $HOME/.secret into a variable +called "fix". Make sure that the content is trimmed and percent-encoded sent +as POST data: + + --variable %HOME + --expand-variable fix@{{HOME}}/.secret + --expand-data "{{fix:trim:url}}" + https://example.com/ + +Command line variables and expansions were added in in 8.3.0. .SH OUTPUT If not told otherwise, curl writes the received data to stdout. It can be instructed to instead save that data into a local file, using the --output or @@ -117,7 +156,7 @@ Lets you lookup words using online dictionaries. .IP FILE Read or write local files. curl does not support accessing file:// URL remotely, but when running on Microsoft Windows using the native UNC approach -will work. +works. .IP FTP(S) curl supports the File Transfer Protocol with a lot of tweaks and levers. With or without using TLS. @@ -140,7 +179,7 @@ not supported (yet). Downloading from a pop3 server means getting a mail. With or without using TLS. .IP RTMP(S) -The Realtime Messaging Protocol is primarily used to server streaming media +The **Realtime Messaging Protocol** is primarily used to serve streaming media and curl can download it. .IP RTSP curl supports RTSP 1.0 downloads. @@ -161,9 +200,9 @@ curl can do TFTP downloads and uploads. .SH "PROGRESS METER" curl normally displays a progress meter during operations, indicating the amount of transferred data, transfer speeds and estimated time left, etc. The -progress meter displays number of bytes and the speeds are in bytes per -second. The suffixes (k, M, G, T, P) are 1024 based. For example 1k is 1024 -bytes. 1M is 1048576 bytes. +progress meter displays the transfer rate in bytes per second. The suffixes +(k, M, G, T, P) are 1024 based. For example 1k is 1024 bytes. 1M is 1048576 +bytes. curl displays this data to the terminal by default, so if you invoke curl to do an operation and it is about to write data to the terminal, it @@ -180,9 +219,22 @@ response data to the terminal. If you prefer a progress "bar" instead of the regular meter, --progress-bar is your friend. You can also disable the progress meter completely with the --silent option. +.SH VERSION +This man page describes curl %VERSION. If you use a later version, chances are +this man page does not fully document it. If you use an earlier version, this +document tries to include version information about which specific version +that introduced changes. + +You can always learn which the latest curl version is by running + + curl https://curl.se/info + +The online version of this man page is always showing the latest incarnation: +https://curl.se/docs/manpage.html .SH OPTIONS Options start with one or two dashes. Many of the options require an -additional value next to them. +additional value next to them. If provided text does not start with a dash, it +is presumed to be and treated as a URL. The short "single-dash" form of the options, -d for example, may be used with or without a space between it and its value, although a space is a recommended @@ -191,9 +243,16 @@ between it and its value. Short version options that do not need any additional values can be used immediately next to each other, like for example you can specify all the -options -O, -L and -v at once as -OLv. +options *-O*, *-L* and *-v* at once as *-OLv*. In general, all boolean options are enabled with --**option** and yet again disabled with --**no-**option. That is, you use the same option name but prefix it with "no-". However, in this list we mostly only list and show the ---option version of them. +*--option* version of them. + +When --next is used, it resets the parser state and you start again with a +clean option state, except for the options that are "global". Global options +retain their values and meaning even after --next. + +The following options are global: +%GLOBALS. diff --git a/docs/cmdline-opts/parallel-immediate.d b/docs/cmdline-opts/parallel-immediate.d index e202214c1..b534dd512 100644 --- a/docs/cmdline-opts/parallel-immediate.d +++ b/docs/cmdline-opts/parallel-immediate.d @@ -1,4 +1,4 @@ -c: Copyright (C) 1998 - 2022, Daniel Stenberg, <daniel@haxx.se>, et al. +c: Copyright (C) Daniel Stenberg, <daniel@haxx.se>, et al. SPDX-License-Identifier: curl Long: parallel-immediate Help: Do not wait for multiplexing (with --parallel) @@ -7,11 +7,9 @@ See-also: parallel parallel-max Category: connection curl Example: --parallel-immediate -Z $URL -o file1 $URL -o file2 Multi: boolean +Scope: global --- -When doing parallel transfers, this option will instruct curl that it should +When doing parallel transfers, this option instructs curl that it should rather prefer opening up more connections in parallel at once rather than waiting to see if new transfers can be added as multiplexed streams on another connection. - -This option is global and does not need to be specified for each use of ---next. diff --git a/docs/cmdline-opts/parallel-max.d b/docs/cmdline-opts/parallel-max.d index 7bdd1b8f4..cc6d32d18 100644 --- a/docs/cmdline-opts/parallel-max.d +++ b/docs/cmdline-opts/parallel-max.d @@ -1,4 +1,4 @@ -c: Copyright (C) 1998 - 2022, Daniel Stenberg, <daniel@haxx.se>, et al. +c: Copyright (C) Daniel Stenberg, <daniel@haxx.se>, et al. SPDX-License-Identifier: curl Long: parallel-max Arg: <num> diff --git a/docs/cmdline-opts/parallel.d b/docs/cmdline-opts/parallel.d index 83c5cc5bd..4f698f8b3 100644 --- a/docs/cmdline-opts/parallel.d +++ b/docs/cmdline-opts/parallel.d @@ -1,4 +1,4 @@ -c: Copyright (C) 1998 - 2022, Daniel Stenberg, <daniel@haxx.se>, et al. +c: Copyright (C) Daniel Stenberg, <daniel@haxx.se>, et al. SPDX-License-Identifier: curl Short: Z Long: parallel @@ -8,9 +8,7 @@ Category: connection curl Example: --parallel $URL -o file1 $URL -o file2 See-also: next verbose Multi: boolean +Scope: global --- Makes curl perform its transfers in parallel as compared to the regular serial manner. - -This option is global and does not need to be specified for each use of ---next. diff --git a/docs/cmdline-opts/pass.d b/docs/cmdline-opts/pass.d index a81c34892..2c0a2bef6 100644 --- a/docs/cmdline-opts/pass.d +++ b/docs/cmdline-opts/pass.d @@ -1,4 +1,4 @@ -c: Copyright (C) 1998 - 2022, Daniel Stenberg, <daniel@haxx.se>, et al. +c: Copyright (C) Daniel Stenberg, <daniel@haxx.se>, et al. SPDX-License-Identifier: curl Long: pass Arg: <phrase> diff --git a/docs/cmdline-opts/path-as-is.d b/docs/cmdline-opts/path-as-is.d index 45c161b6d..9897d882f 100644 --- a/docs/cmdline-opts/path-as-is.d +++ b/docs/cmdline-opts/path-as-is.d @@ -1,4 +1,4 @@ -c: Copyright (C) 1998 - 2022, Daniel Stenberg, <daniel@haxx.se>, et al. +c: Copyright (C) Daniel Stenberg, <daniel@haxx.se>, et al. SPDX-License-Identifier: curl Long: path-as-is Help: Do not squash .. sequences in URL path @@ -9,5 +9,5 @@ See-also: request-target Multi: boolean --- 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 +path. Normally curl squashes or merges them according to standards but with this option set you tell it not to do that. diff --git a/docs/cmdline-opts/pinnedpubkey.d b/docs/cmdline-opts/pinnedpubkey.d index 3ac484690..d799bfac8 100644 --- a/docs/cmdline-opts/pinnedpubkey.d +++ b/docs/cmdline-opts/pinnedpubkey.d @@ -1,4 +1,4 @@ -c: Copyright (C) 1998 - 2022, Daniel Stenberg, <daniel@haxx.se>, et al. +c: Copyright (C) Daniel Stenberg, <daniel@haxx.se>, et al. SPDX-License-Identifier: curl Long: pinnedpubkey Arg: <hashes> @@ -18,21 +18,21 @@ or DER format, or any number of base64 encoded sha256 hashes preceded by When negotiating a TLS or SSL connection, the server sends a certificate indicating its identity. A public key is extracted from this certificate and -if it does not exactly match the public key provided to this option, curl will -abort the connection before sending or receiving any data. +if it does not exactly match the public key provided to this option, curl +aborts the connection before sending or receiving any data. -PEM/DER support: - -7.39.0: OpenSSL, GnuTLS and GSKit +This option is independent of option --insecure. If you use both options +together then the peer is still verified by public key. -7.43.0: NSS and wolfSSL +PEM/DER support: -7.47.0: mbedtls +OpenSSL and GnuTLS (added in 7.39.0), wolfSSL (added in 7.43.0), mbedTLS +(added in 7.47.0), Secure Transport macOS 10.7+/iOS 10+ (7.54.1), Schannel +(7.58.1) sha256 support: -7.44.0: OpenSSL, GnuTLS, NSS and wolfSSL - -7.47.0: mbedtls +OpenSSL, GnuTLS and wolfSSL (added in 7.44.0), mbedTLS (added in 7.47.0), +Secure Transport macOS 10.7+/iOS 10+ (7.54.1), Schannel (7.58.1) Other SSL backends not supported. diff --git a/docs/cmdline-opts/post301.d b/docs/cmdline-opts/post301.d index 0de2e519e..d067fc8cc 100644 --- a/docs/cmdline-opts/post301.d +++ b/docs/cmdline-opts/post301.d @@ -1,4 +1,4 @@ -c: Copyright (C) 1998 - 2022, Daniel Stenberg, <daniel@haxx.se>, et al. +c: Copyright (C) Daniel Stenberg, <daniel@haxx.se>, et al. SPDX-License-Identifier: curl Long: post301 Help: Do not switch to GET after following a 301 diff --git a/docs/cmdline-opts/post302.d b/docs/cmdline-opts/post302.d index 4a42c79d0..b7190ce0f 100644 --- a/docs/cmdline-opts/post302.d +++ b/docs/cmdline-opts/post302.d @@ -1,4 +1,4 @@ -c: Copyright (C) 1998 - 2022, Daniel Stenberg, <daniel@haxx.se>, et al. +c: Copyright (C) Daniel Stenberg, <daniel@haxx.se>, et al. SPDX-License-Identifier: curl Long: post302 Help: Do not switch to GET after following a 302 diff --git a/docs/cmdline-opts/post303.d b/docs/cmdline-opts/post303.d index 79c891687..52d440c45 100644 --- a/docs/cmdline-opts/post303.d +++ b/docs/cmdline-opts/post303.d @@ -1,4 +1,4 @@ -c: Copyright (C) 1998 - 2022, Daniel Stenberg, <daniel@haxx.se>, et al. +c: Copyright (C) Daniel Stenberg, <daniel@haxx.se>, et al. SPDX-License-Identifier: curl Long: post303 Help: Do not switch to GET after following a 303 diff --git a/docs/cmdline-opts/preproxy.d b/docs/cmdline-opts/preproxy.d index 5be20712b..b55c1d47a 100644 --- a/docs/cmdline-opts/preproxy.d +++ b/docs/cmdline-opts/preproxy.d @@ -1,4 +1,4 @@ -c: Copyright (C) 1998 - 2022, Daniel Stenberg, <daniel@haxx.se>, et al. +c: Copyright (C) Daniel Stenberg, <daniel@haxx.se>, et al. SPDX-License-Identifier: curl Long: preproxy Arg: [protocol://]host[:port] @@ -16,7 +16,7 @@ SOCKS) to the HTTP or HTTPS proxy. Hence pre proxy. The pre proxy string should be specified with a protocol:// prefix to specify alternative proxy protocols. Use socks4://, socks4a://, socks5:// or socks5h:// to request the specific SOCKS version to be used. No protocol -specified will make curl default to SOCKS4. +specified makes curl default to SOCKS4. If the port number is not specified in the proxy string, it is assumed to be 1080. diff --git a/docs/cmdline-opts/progress-bar.d b/docs/cmdline-opts/progress-bar.d index 5c87023b8..fee170979 100644 --- a/docs/cmdline-opts/progress-bar.d +++ b/docs/cmdline-opts/progress-bar.d @@ -1,4 +1,4 @@ -c: Copyright (C) 1998 - 2022, Daniel Stenberg, <daniel@haxx.se>, et al. +c: Copyright (C) Daniel Stenberg, <daniel@haxx.se>, et al. SPDX-License-Identifier: curl Short: # Long: progress-bar @@ -8,15 +8,13 @@ Example: -# -O $URL Added: 5.10 See-also: styled-output Multi: boolean +Scope: global --- Make curl display transfer progress as a simple progress bar instead of the standard, more informational, meter. This progress bar draws a single line of '#' characters across the screen and shows a percentage if the transfer size is known. For transfers without a -known size, there will be space ship (-=o=-) that moves back and forth but -only while data is being transferred, with a set of flying hash sign symbols on +known size, there is a space ship (-=o=-) that moves back and forth but only +while data is being transferred, with a set of flying hash sign symbols on top. - -This option is global and does not need to be specified for each use of ---next. diff --git a/docs/cmdline-opts/proto-default.d b/docs/cmdline-opts/proto-default.d index bb8940f7e..d5b4bcd10 100644 --- a/docs/cmdline-opts/proto-default.d +++ b/docs/cmdline-opts/proto-default.d @@ -1,4 +1,4 @@ -c: Copyright (C) 1998 - 2022, Daniel Stenberg, <daniel@haxx.se>, et al. +c: Copyright (C) Daniel Stenberg, <daniel@haxx.se>, et al. SPDX-License-Identifier: curl Long: proto-default Help: Use PROTOCOL for any URL missing a scheme diff --git a/docs/cmdline-opts/proto-redir.d b/docs/cmdline-opts/proto-redir.d index b6f0f0f36..dec871614 100644 --- a/docs/cmdline-opts/proto-redir.d +++ b/docs/cmdline-opts/proto-redir.d @@ -1,4 +1,4 @@ -c: Copyright (C) 1998 - 2022, Daniel Stenberg, <daniel@haxx.se>, et al. +c: Copyright (C) Daniel Stenberg, <daniel@haxx.se>, et al. SPDX-License-Identifier: curl Long: proto-redir Arg: <protocols> @@ -17,6 +17,6 @@ Example, allow only HTTP and HTTPS on redirect: curl --proto-redir -all,http,https http://example.com -By default curl will only allow HTTP, HTTPS, FTP and FTPS on redirect (since +By default curl only allows HTTP, HTTPS, FTP and FTPS on redirects (added in 7.65.2). Specifying *all* or *+all* enables all protocols on redirects, which is not good for security. diff --git a/docs/cmdline-opts/proto.d b/docs/cmdline-opts/proto.d index a24c0dbdc..ac024bf42 100644 --- a/docs/cmdline-opts/proto.d +++ b/docs/cmdline-opts/proto.d @@ -1,4 +1,4 @@ -c: Copyright (C) 1998 - 2022, Daniel Stenberg, <daniel@haxx.se>, et al. +c: Copyright (C) Daniel Stenberg, <daniel@haxx.se>, et al. SPDX-License-Identifier: curl Long: proto Arg: <protocols> diff --git a/docs/cmdline-opts/proxy-anyauth.d b/docs/cmdline-opts/proxy-anyauth.d index c215ad746..fa460876e 100644 --- a/docs/cmdline-opts/proxy-anyauth.d +++ b/docs/cmdline-opts/proxy-anyauth.d @@ -1,4 +1,4 @@ -c: Copyright (C) 1998 - 2022, Daniel Stenberg, <daniel@haxx.se>, et al. +c: Copyright (C) Daniel Stenberg, <daniel@haxx.se>, et al. SPDX-License-Identifier: curl Long: proxy-anyauth Help: Pick any proxy authentication method diff --git a/docs/cmdline-opts/proxy-basic.d b/docs/cmdline-opts/proxy-basic.d index 3856c49f3..ff56631f7 100644 --- a/docs/cmdline-opts/proxy-basic.d +++ b/docs/cmdline-opts/proxy-basic.d @@ -1,4 +1,4 @@ -c: Copyright (C) 1998 - 2022, Daniel Stenberg, <daniel@haxx.se>, et al. +c: Copyright (C) Daniel Stenberg, <daniel@haxx.se>, et al. SPDX-License-Identifier: curl Long: proxy-basic Help: Use Basic authentication on the proxy diff --git a/docs/cmdline-opts/proxy-ca-native.d b/docs/cmdline-opts/proxy-ca-native.d new file mode 100644 index 000000000..aab4fcabc --- /dev/null +++ b/docs/cmdline-opts/proxy-ca-native.d @@ -0,0 +1,21 @@ +c: Copyright (C) Daniel Stenberg, <daniel@haxx.se>, et al. +SPDX-License-Identifier: curl +Long: proxy-ca-native +Help: Use CA certificates from the native OS for proxy +Protocols: TLS +Category: tls +See-also: cacert capath insecure +Example: --ca-native $URL +Added: 8.2.0 +Multi: boolean +--- +Tells curl to use the CA store from the native operating system to verify the +HTTPS proxy. By default, curl uses a CA store provided in a single file or +directory, but when using this option it interfaces the operating system's own +vault. + +This option only works for curl on Windows when built to use OpenSSL. When +curl on Windows is built to use Schannel, this feature is implied and curl +then only uses the native CA store. + +curl built with wolfSSL also supports this option (added in 8.3.0). diff --git a/docs/cmdline-opts/proxy-cacert.d b/docs/cmdline-opts/proxy-cacert.d index a7c8e743b..45dc3f301 100644 --- a/docs/cmdline-opts/proxy-cacert.d +++ b/docs/cmdline-opts/proxy-cacert.d @@ -1,4 +1,4 @@ -c: Copyright (C) 1998 - 2022, Daniel Stenberg, <daniel@haxx.se>, et al. +c: Copyright (C) Daniel Stenberg, <daniel@haxx.se>, et al. SPDX-License-Identifier: curl Long: proxy-cacert Help: CA certificate to verify peer against for proxy diff --git a/docs/cmdline-opts/proxy-capath.d b/docs/cmdline-opts/proxy-capath.d index e6113012b..309f9408a 100644 --- a/docs/cmdline-opts/proxy-capath.d +++ b/docs/cmdline-opts/proxy-capath.d @@ -1,4 +1,4 @@ -c: Copyright (C) 1998 - 2022, Daniel Stenberg, <daniel@haxx.se>, et al. +c: Copyright (C) Daniel Stenberg, <daniel@haxx.se>, et al. SPDX-License-Identifier: curl Long: proxy-capath Help: CA directory to verify peer against for proxy diff --git a/docs/cmdline-opts/proxy-cert-type.d b/docs/cmdline-opts/proxy-cert-type.d index 2376acab4..4ab38f5a8 100644 --- a/docs/cmdline-opts/proxy-cert-type.d +++ b/docs/cmdline-opts/proxy-cert-type.d @@ -1,4 +1,4 @@ -c: Copyright (C) 1998 - 2022, Daniel Stenberg, <daniel@haxx.se>, et al. +c: Copyright (C) Daniel Stenberg, <daniel@haxx.se>, et al. SPDX-License-Identifier: curl Long: proxy-cert-type Arg: <type> diff --git a/docs/cmdline-opts/proxy-cert.d b/docs/cmdline-opts/proxy-cert.d index cc2f8041b..2a869deb0 100644 --- a/docs/cmdline-opts/proxy-cert.d +++ b/docs/cmdline-opts/proxy-cert.d @@ -1,4 +1,4 @@ -c: Copyright (C) 1998 - 2022, Daniel Stenberg, <daniel@haxx.se>, et al. +c: Copyright (C) Daniel Stenberg, <daniel@haxx.se>, et al. SPDX-License-Identifier: curl Long: proxy-cert Arg: <cert[:passwd]> diff --git a/docs/cmdline-opts/proxy-ciphers.d b/docs/cmdline-opts/proxy-ciphers.d index 1fdbb3443..5879f397e 100644 --- a/docs/cmdline-opts/proxy-ciphers.d +++ b/docs/cmdline-opts/proxy-ciphers.d @@ -1,4 +1,4 @@ -c: Copyright (C) 1998 - 2022, Daniel Stenberg, <daniel@haxx.se>, et al. +c: Copyright (C) Daniel Stenberg, <daniel@haxx.se>, et al. SPDX-License-Identifier: curl Long: proxy-ciphers Arg: <list> @@ -10,3 +10,9 @@ See-also: ciphers curves proxy Multi: single --- Same as --ciphers but used in HTTPS proxy context. + +Specifies which ciphers to use in the connection to the HTTPS proxy. The list +of ciphers must specify valid ciphers. Read up on SSL cipher list details on +this URL: + +https://curl.se/docs/ssl-ciphers.html diff --git a/docs/cmdline-opts/proxy-crlfile.d b/docs/cmdline-opts/proxy-crlfile.d index 7e4ef24a9..1a8fdf25d 100644 --- a/docs/cmdline-opts/proxy-crlfile.d +++ b/docs/cmdline-opts/proxy-crlfile.d @@ -1,4 +1,4 @@ -c: Copyright (C) 1998 - 2022, Daniel Stenberg, <daniel@haxx.se>, et al. +c: Copyright (C) Daniel Stenberg, <daniel@haxx.se>, et al. SPDX-License-Identifier: curl Long: proxy-crlfile Arg: <file> diff --git a/docs/cmdline-opts/proxy-digest.d b/docs/cmdline-opts/proxy-digest.d index f8a56fac9..c5cb19c48 100644 --- a/docs/cmdline-opts/proxy-digest.d +++ b/docs/cmdline-opts/proxy-digest.d @@ -1,4 +1,4 @@ -c: Copyright (C) 1998 - 2022, Daniel Stenberg, <daniel@haxx.se>, et al. +c: Copyright (C) Daniel Stenberg, <daniel@haxx.se>, et al. SPDX-License-Identifier: curl Long: proxy-digest Help: Use Digest authentication on the proxy diff --git a/docs/cmdline-opts/proxy-header.d b/docs/cmdline-opts/proxy-header.d index c064b1ff8..06ae3bcba 100644 --- a/docs/cmdline-opts/proxy-header.d +++ b/docs/cmdline-opts/proxy-header.d @@ -1,4 +1,4 @@ -c: Copyright (C) 1998 - 2022, Daniel Stenberg, <daniel@haxx.se>, et al. +c: Copyright (C) Daniel Stenberg, <daniel@haxx.se>, et al. SPDX-License-Identifier: curl Long: proxy-header Arg: <header/@file> @@ -17,16 +17,16 @@ specify any number of extra headers. This is the equivalent option to --header but is for proxy communication only like in CONNECT requests when you want a separate header sent to the proxy to what is sent to the actual remote host. -curl will make sure that each header you add/replace is sent with the proper +curl makes sure that each header you add/replace is sent with the proper end-of-line marker, you should thus **not** add that as a part of the header -content: do not add newlines or carriage returns, they will only mess things -up for you. +content: do not add newlines or carriage returns, they only mess things up for +you. -Headers specified with this option will not be included in requests that curl -knows will not be sent to a proxy. +Headers specified with this option are not included in requests that curl +knows are not be sent to a proxy. -Starting in 7.55.0, this option can take an argument in @filename style, which -then adds a header for each line in the input file. Using @- will make curl -read the header file from stdin. +This option can take an argument in @filename style, which then adds a header +for each line in the input file (added in 7.55.0). Using @- makes curl read +the headers from stdin. This option can be used multiple times to add/replace/remove multiple headers. diff --git a/docs/cmdline-opts/proxy-http2.d b/docs/cmdline-opts/proxy-http2.d new file mode 100644 index 000000000..58f55e74d --- /dev/null +++ b/docs/cmdline-opts/proxy-http2.d @@ -0,0 +1,18 @@ +c: Copyright (C) Daniel Stenberg, <daniel@haxx.se>, et al. +SPDX-License-Identifier: curl +Long: proxy-http2 +Tags: Versions HTTP/2 +Protocols: HTTP +Added: 8.1.0 +Mutexed: +Requires: HTTP/2 +See-also: proxy +Help: Use HTTP/2 with HTTPS proxy +Category: http proxy +Example: --proxy-http2 -x proxy $URL +Multi: boolean +--- +Tells curl to try negotiate HTTP version 2 with an HTTPS proxy. The proxy might +still only offer HTTP/1 and then curl sticks to using that version. + +This has no effect for any other kinds of proxies. diff --git a/docs/cmdline-opts/proxy-insecure.d b/docs/cmdline-opts/proxy-insecure.d index 7eb00244e..beb8c2531 100644 --- a/docs/cmdline-opts/proxy-insecure.d +++ b/docs/cmdline-opts/proxy-insecure.d @@ -1,4 +1,4 @@ -c: Copyright (C) 1998 - 2022, Daniel Stenberg, <daniel@haxx.se>, et al. +c: Copyright (C) Daniel Stenberg, <daniel@haxx.se>, et al. SPDX-License-Identifier: curl Long: proxy-insecure Help: Do HTTPS proxy connections without verifying the proxy diff --git a/docs/cmdline-opts/proxy-key-type.d b/docs/cmdline-opts/proxy-key-type.d index 7f4e51ef0..3fd11f3a3 100644 --- a/docs/cmdline-opts/proxy-key-type.d +++ b/docs/cmdline-opts/proxy-key-type.d @@ -1,4 +1,4 @@ -c: Copyright (C) 1998 - 2022, Daniel Stenberg, <daniel@haxx.se>, et al. +c: Copyright (C) Daniel Stenberg, <daniel@haxx.se>, et al. SPDX-License-Identifier: curl Long: proxy-key-type Arg: <type> diff --git a/docs/cmdline-opts/proxy-key.d b/docs/cmdline-opts/proxy-key.d index 01bd51aa6..4bf2748a4 100644 --- a/docs/cmdline-opts/proxy-key.d +++ b/docs/cmdline-opts/proxy-key.d @@ -1,4 +1,4 @@ -c: Copyright (C) 1998 - 2022, Daniel Stenberg, <daniel@haxx.se>, et al. +c: Copyright (C) Daniel Stenberg, <daniel@haxx.se>, et al. SPDX-License-Identifier: curl Long: proxy-key Help: Private key for HTTPS proxy diff --git a/docs/cmdline-opts/proxy-negotiate.d b/docs/cmdline-opts/proxy-negotiate.d index f0ca0b08a..89b5c1bde 100644 --- a/docs/cmdline-opts/proxy-negotiate.d +++ b/docs/cmdline-opts/proxy-negotiate.d @@ -1,4 +1,4 @@ -c: Copyright (C) 1998 - 2022, Daniel Stenberg, <daniel@haxx.se>, et al. +c: Copyright (C) Daniel Stenberg, <daniel@haxx.se>, et al. SPDX-License-Identifier: curl Long: proxy-negotiate Help: Use HTTP Negotiate (SPNEGO) authentication on the proxy diff --git a/docs/cmdline-opts/proxy-ntlm.d b/docs/cmdline-opts/proxy-ntlm.d index 57cb9945d..f8481e5d6 100644 --- a/docs/cmdline-opts/proxy-ntlm.d +++ b/docs/cmdline-opts/proxy-ntlm.d @@ -1,4 +1,4 @@ -c: Copyright (C) 1998 - 2022, Daniel Stenberg, <daniel@haxx.se>, et al. +c: Copyright (C) Daniel Stenberg, <daniel@haxx.se>, et al. SPDX-License-Identifier: curl Long: proxy-ntlm Help: Use NTLM authentication on the proxy diff --git a/docs/cmdline-opts/proxy-pass.d b/docs/cmdline-opts/proxy-pass.d index 733e62615..307139951 100644 --- a/docs/cmdline-opts/proxy-pass.d +++ b/docs/cmdline-opts/proxy-pass.d @@ -1,4 +1,4 @@ -c: Copyright (C) 1998 - 2022, Daniel Stenberg, <daniel@haxx.se>, et al. +c: Copyright (C) Daniel Stenberg, <daniel@haxx.se>, et al. SPDX-License-Identifier: curl Long: proxy-pass Arg: <phrase> diff --git a/docs/cmdline-opts/proxy-pinnedpubkey.d b/docs/cmdline-opts/proxy-pinnedpubkey.d index 4f139af60..7bf99d8c5 100644 --- a/docs/cmdline-opts/proxy-pinnedpubkey.d +++ b/docs/cmdline-opts/proxy-pinnedpubkey.d @@ -1,4 +1,4 @@ -c: Copyright (C) 1998 - 2022, Daniel Stenberg, <daniel@haxx.se>, et al. +c: Copyright (C) Daniel Stenberg, <daniel@haxx.se>, et al. SPDX-License-Identifier: curl Long: proxy-pinnedpubkey Arg: <hashes> @@ -18,5 +18,5 @@ or DER format, or any number of base64 encoded sha256 hashes preceded by When negotiating a TLS or SSL connection, the server sends a certificate indicating its identity. A public key is extracted from this certificate and -if it does not exactly match the public key provided to this option, curl will -abort the connection before sending or receiving any data. +if it does not exactly match the public key provided to this option, curl +aborts the connection before sending or receiving any data. diff --git a/docs/cmdline-opts/proxy-service-name.d b/docs/cmdline-opts/proxy-service-name.d index 02191afb0..200973fb5 100644 --- a/docs/cmdline-opts/proxy-service-name.d +++ b/docs/cmdline-opts/proxy-service-name.d @@ -1,4 +1,4 @@ -c: Copyright (C) 1998 - 2022, Daniel Stenberg, <daniel@haxx.se>, et al. +c: Copyright (C) Daniel Stenberg, <daniel@haxx.se>, et al. SPDX-License-Identifier: curl Long: proxy-service-name Arg: <name> diff --git a/docs/cmdline-opts/proxy-ssl-allow-beast.d b/docs/cmdline-opts/proxy-ssl-allow-beast.d index c5149f597..55ff62b46 100644 --- a/docs/cmdline-opts/proxy-ssl-allow-beast.d +++ b/docs/cmdline-opts/proxy-ssl-allow-beast.d @@ -1,4 +1,4 @@ -c: Copyright (C) 1998 - 2022, Daniel Stenberg, <daniel@haxx.se>, et al. +c: Copyright (C) Daniel Stenberg, <daniel@haxx.se>, et al. SPDX-License-Identifier: curl Long: proxy-ssl-allow-beast Help: Allow security flaw for interop for HTTPS proxy diff --git a/docs/cmdline-opts/proxy-ssl-auto-client-cert.d b/docs/cmdline-opts/proxy-ssl-auto-client-cert.d index 21d09faa6..ea0f0c04d 100644 --- a/docs/cmdline-opts/proxy-ssl-auto-client-cert.d +++ b/docs/cmdline-opts/proxy-ssl-auto-client-cert.d @@ -1,4 +1,4 @@ -c: Copyright (C) 1998 - 2022, Daniel Stenberg, <daniel@haxx.se>, et al. +c: Copyright (C) Daniel Stenberg, <daniel@haxx.se>, et al. SPDX-License-Identifier: curl Long: proxy-ssl-auto-client-cert Help: Use auto client certificate for proxy (Schannel) diff --git a/docs/cmdline-opts/proxy-tls13-ciphers.d b/docs/cmdline-opts/proxy-tls13-ciphers.d index 90952ffad..f18c3d5c0 100644 --- a/docs/cmdline-opts/proxy-tls13-ciphers.d +++ b/docs/cmdline-opts/proxy-tls13-ciphers.d @@ -1,4 +1,4 @@ -c: Copyright (C) 1998 - 2022, Daniel Stenberg, <daniel@haxx.se>, et al. +c: Copyright (C) Daniel Stenberg, <daniel@haxx.se>, et al. SPDX-License-Identifier: curl Long: proxy-tls13-ciphers Arg: <ciphersuite list> @@ -7,14 +7,14 @@ Protocols: TLS Category: proxy tls Example: --proxy-tls13-ciphers TLS_AES_128_GCM_SHA256 -x proxy $URL Added: 7.61.0 -See-also: tls13-ciphers curves +See-also: tls13-ciphers curves proxy-ciphers Multi: single --- 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 ciphers. Read up on TLS 1.3 cipher suite details on this URL: - https://curl.se/docs/ssl-ciphers.html +https://curl.se/docs/ssl-ciphers.html This option is currently used only when curl is built to use OpenSSL 1.1.1 or later. If you are using a different SSL backend you can try setting TLS 1.3 diff --git a/docs/cmdline-opts/proxy-tlsauthtype.d b/docs/cmdline-opts/proxy-tlsauthtype.d index 8ba7428e2..f83153e7b 100644 --- a/docs/cmdline-opts/proxy-tlsauthtype.d +++ b/docs/cmdline-opts/proxy-tlsauthtype.d @@ -1,4 +1,4 @@ -c: Copyright (C) 1998 - 2022, Daniel Stenberg, <daniel@haxx.se>, et al. +c: Copyright (C) Daniel Stenberg, <daniel@haxx.se>, et al. SPDX-License-Identifier: curl Long: proxy-tlsauthtype Arg: <type> diff --git a/docs/cmdline-opts/proxy-tlspassword.d b/docs/cmdline-opts/proxy-tlspassword.d index ba232e68a..7ec01401b 100644 --- a/docs/cmdline-opts/proxy-tlspassword.d +++ b/docs/cmdline-opts/proxy-tlspassword.d @@ -1,4 +1,4 @@ -c: Copyright (C) 1998 - 2022, Daniel Stenberg, <daniel@haxx.se>, et al. +c: Copyright (C) Daniel Stenberg, <daniel@haxx.se>, et al. SPDX-License-Identifier: curl Long: proxy-tlspassword Arg: <string> diff --git a/docs/cmdline-opts/proxy-tlsuser.d b/docs/cmdline-opts/proxy-tlsuser.d index 944d87601..17be7f7ba 100644 --- a/docs/cmdline-opts/proxy-tlsuser.d +++ b/docs/cmdline-opts/proxy-tlsuser.d @@ -1,4 +1,4 @@ -c: Copyright (C) 1998 - 2022, Daniel Stenberg, <daniel@haxx.se>, et al. +c: Copyright (C) Daniel Stenberg, <daniel@haxx.se>, et al. SPDX-License-Identifier: curl Long: proxy-tlsuser Arg: <name> diff --git a/docs/cmdline-opts/proxy-tlsv1.d b/docs/cmdline-opts/proxy-tlsv1.d index b6d039b15..c4345023e 100644 --- a/docs/cmdline-opts/proxy-tlsv1.d +++ b/docs/cmdline-opts/proxy-tlsv1.d @@ -1,4 +1,4 @@ -c: Copyright (C) 1998 - 2022, Daniel Stenberg, <daniel@haxx.se>, et al. +c: Copyright (C) Daniel Stenberg, <daniel@haxx.se>, et al. SPDX-License-Identifier: curl Long: proxy-tlsv1 Help: Use TLSv1 for HTTPS proxy diff --git a/docs/cmdline-opts/proxy-user.d b/docs/cmdline-opts/proxy-user.d index 572cb06c0..df30de2d9 100644 --- a/docs/cmdline-opts/proxy-user.d +++ b/docs/cmdline-opts/proxy-user.d @@ -1,4 +1,4 @@ -c: Copyright (C) 1998 - 2022, Daniel Stenberg, <daniel@haxx.se>, et al. +c: Copyright (C) Daniel Stenberg, <daniel@haxx.se>, et al. SPDX-License-Identifier: curl Long: proxy-user Short: U @@ -16,8 +16,8 @@ If you use a Windows SSPI-enabled curl binary and do either Negotiate or NTLM authentication then you can tell curl to select the user name and password from your environment by specifying a single colon with this option: "-U :". -On systems where it works, curl will hide the given option argument from -process listings. This is not enough to protect credentials from possibly -getting seen by other users on the same system as they will still be visible -for a moment before cleared. Such sensitive data should be retrieved from a -file instead or similar and never used in clear text in a command line. +On systems where it works, curl hides the given option argument from process +listings. This is not enough to protect credentials from possibly getting seen +by other users on the same system as they still are visible for a moment +before cleared. Such sensitive data should be retrieved from a file instead or +similar and never used in clear text in a command line. diff --git a/docs/cmdline-opts/proxy.d b/docs/cmdline-opts/proxy.d index a3be835bf..b7d550a11 100644 --- a/docs/cmdline-opts/proxy.d +++ b/docs/cmdline-opts/proxy.d @@ -1,4 +1,4 @@ -c: Copyright (C) 1998 - 2022, Daniel Stenberg, <daniel@haxx.se>, et al. +c: Copyright (C) Daniel Stenberg, <daniel@haxx.se>, et al. SPDX-License-Identifier: curl Long: proxy Short: x @@ -13,27 +13,28 @@ Multi: single Use the specified proxy. The proxy string can be specified with a protocol:// prefix. No protocol -specified or http:// will be treated as HTTP proxy. Use socks4://, socks4a://, -socks5:// or socks5h:// to request a specific SOCKS version to be used. -(Added in 7.21.7) +specified or http:// it is treated as an HTTP proxy. Use socks4://, +socks4a://, socks5:// or socks5h:// to request a specific SOCKS version to be +used. (Added in 7.21.7) Unix domain sockets are supported for socks proxy. Set localhost for the host part. e.g. socks5h://localhost/path/to/socket.sock -HTTPS proxy support via https:// protocol prefix was added in 7.52.0 for -OpenSSL, GnuTLS and NSS. +HTTPS proxy support works set with the https:// protocol prefix for OpenSSL +and GnuTLS (added in 7.52.0). It also works for BearSSL, mbedTLS, rustls, +Schannel, Secure Transport and wolfSSL (added in 7.87.0). -Unrecognized and unsupported proxy protocols cause an error since 7.52.0. -Prior versions may ignore the protocol and use http:// instead. +Unrecognized and unsupported proxy protocols cause an error (added in 7.52.0). +Ancient curl versions ignored unknown schemes and used http:// instead. If the port number is not specified in the proxy string, it is assumed to be 1080. This option overrides existing environment variables that set the proxy to -use. If there's an environment variable setting a proxy, you can set proxy to +use. If there is an environment variable setting a proxy, you can set proxy to "" to override it. -All operations that are performed over an HTTP proxy will transparently be +All operations that are performed over an HTTP proxy are transparently converted to HTTP. It means that certain protocol specific operations might not be available. This is not the case if you can tunnel through the proxy, as one with the --proxytunnel option. @@ -45,3 +46,6 @@ or pass in a colon with %3a. The proxy host can be specified the same way as the proxy environment variables, including the protocol prefix (http://) and the embedded user + password. + +When a proxy is used, the active FTP mode as set with --ftp-port, cannot be +used. diff --git a/docs/cmdline-opts/proxy1.0.d b/docs/cmdline-opts/proxy1.0.d index 3f7b61331..0657a9519 100644 --- a/docs/cmdline-opts/proxy1.0.d +++ b/docs/cmdline-opts/proxy1.0.d @@ -1,4 +1,4 @@ -c: Copyright (C) 1998 - 2022, Daniel Stenberg, <daniel@haxx.se>, et al. +c: Copyright (C) Daniel Stenberg, <daniel@haxx.se>, et al. SPDX-License-Identifier: curl Long: proxy1.0 Arg: <host[:port]> @@ -13,5 +13,5 @@ Use the specified HTTP 1.0 proxy. If the port number is not specified, it is assumed at port 1080. The only difference between this and the HTTP proxy option --proxy, is that -attempts to use CONNECT through the proxy will specify an HTTP 1.0 protocol +attempts to use CONNECT through the proxy specifies an HTTP 1.0 protocol instead of the default HTTP 1.1. diff --git a/docs/cmdline-opts/proxytunnel.d b/docs/cmdline-opts/proxytunnel.d index ef2d56b2a..51457870b 100644 --- a/docs/cmdline-opts/proxytunnel.d +++ b/docs/cmdline-opts/proxytunnel.d @@ -1,4 +1,4 @@ -c: Copyright (C) 1998 - 2022, Daniel Stenberg, <daniel@haxx.se>, et al. +c: Copyright (C) Daniel Stenberg, <daniel@haxx.se>, et al. SPDX-License-Identifier: curl Long: proxytunnel Short: p @@ -9,10 +9,10 @@ Example: --proxytunnel -x http://proxy $URL Added: 7.3 Multi: boolean --- -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 -requires that the proxy allows direct connect to the remote port number curl -wants to tunnel through to. +When an HTTP proxy is used --proxy, this option makes curl tunnel the traffic +through the proxy. The tunnel approach is made with the HTTP proxy CONNECT +request and requires that the proxy allows direct connect to the remote port +number curl wants to tunnel through to. To suppress proxy CONNECT response headers when curl is set to output headers use --suppress-connect-headers. diff --git a/docs/cmdline-opts/pubkey.d b/docs/cmdline-opts/pubkey.d index 2078982e2..b2f4b727b 100644 --- a/docs/cmdline-opts/pubkey.d +++ b/docs/cmdline-opts/pubkey.d @@ -1,4 +1,4 @@ -c: Copyright (C) 1998 - 2022, Daniel Stenberg, <daniel@haxx.se>, et al. +c: Copyright (C) Daniel Stenberg, <daniel@haxx.se>, et al. SPDX-License-Identifier: curl Long: pubkey Arg: <key> @@ -13,7 +13,7 @@ Multi: single Public key file name. Allows you to provide your public key in this separate file. -(As of 7.39.0, curl attempts to automatically extract the public key from the -private key file, so passing this option is generally not required. Note that -this public key extraction requires libcurl to be linked against a copy of -libssh2 1.2.8 or higher that is itself linked against OpenSSL.) +curl attempts to automatically extract the public key from the private key +file, so passing this option is generally not required. Note that this public +key extraction requires libcurl to be linked against a copy of libssh2 1.2.8 +or higher that is itself linked against OpenSSL. (Added in 7.39.0.) diff --git a/docs/cmdline-opts/quote.d b/docs/cmdline-opts/quote.d index 96c4e1f17..5008d4932 100644 --- a/docs/cmdline-opts/quote.d +++ b/docs/cmdline-opts/quote.d @@ -1,4 +1,4 @@ -c: Copyright (C) 1998 - 2022, Daniel Stenberg, <daniel@haxx.se>, et al. +c: Copyright (C) Daniel Stenberg, <daniel@haxx.se>, et al. SPDX-License-Identifier: curl Long: quote Arg: <command> @@ -12,9 +12,9 @@ See-also: request Multi: append --- 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 -FTP transfer, to be exact). To make commands take place after a successful -transfer, prefix them with a dash '-'. +sent BEFORE the transfer takes place (just after the initial **PWD** command +in an FTP transfer, to be exact). To make commands take place after a +successful transfer, prefix them with a dash '-'. (FTP only) To make commands be sent after curl has changed the working directory, just before the file transfer command(s), prefix the command with a @@ -22,55 +22,66 @@ directory, just before the file transfer command(s), prefix the command with a You may specify any number of commands. -By default curl will stop at first failure. To make curl continue even if the +By default curl stops at first failure. To make curl continue even if the command fails, prefix the command with an asterisk (*). Otherwise, if the -server returns failure for one of the commands, the entire operation will be +server returns failure for one of the commands, the entire operation is aborted. You must send syntactically correct FTP commands as RFC 959 defines to FTP servers, or one of the commands listed below to SFTP servers. -This option can be used multiple times. - SFTP is a binary protocol. Unlike for FTP, curl interprets SFTP quote commands itself before sending them to the server. File names may be quoted shell-style to embed spaces or special characters. Following is the list of all supported SFTP quote commands: .RS -.IP "atime date file" +.TP +**"atime date file"** The atime command sets the last access time of the file named by the file operand. The <date expression> can be all sorts of date strings, see the *curl_getdate(3)* man page for date expression details. (Added in 7.73.0) -.IP "chgrp group file" +.TP +**"chgrp group file"** The chgrp command sets the group ID of the file named by the file operand to the group ID specified by the group operand. The group operand is a decimal integer group ID. -.IP "chmod mode file" +.TP +**"chmod mode file"** The chmod command modifies the file mode bits of the specified file. The mode operand is an octal integer mode number. -.IP "chown user file" +.TP +**"chown user file"** The chown command sets the owner of the file named by the file operand to the user ID specified by the user operand. The user operand is a decimal integer user ID. -.IP "ln source_file target_file" +.TP +**"ln source_file target_file"** The ln and symlink commands create a symbolic link at the target_file location pointing to the source_file location. -.IP "mkdir directory_name" +.TP +**"mkdir directory_name"** The mkdir command creates the directory named by the directory_name operand. -.IP "mtime date file" +.TP +**"mtime date file"** The mtime command sets the last modification time of the file named by the file operand. The <date expression> can be all sorts of date strings, see the *curl_getdate(3)* man page for date expression details. (Added in 7.73.0) -.IP "pwd" -The pwd command returns the absolute pathname of the current working directory. -.IP "rename source target" +.TP +**"pwd"** +The pwd command returns the absolute path name of the current working directory. +.TP +**"rename source target"** The rename command renames the file or directory named by the source operand to the destination path named by the target operand. -.IP "rm file" +.TP +**"rm file"** The rm command removes the file specified by the file operand. -.IP "rmdir directory" +.TP +**"rmdir directory"** The rmdir command removes the directory entry specified by the directory operand, provided it is empty. -.IP "symlink source_file target_file" +.TP +**"symlink source_file target_file"** See ln. .RE +.IP diff --git a/docs/cmdline-opts/random-file.d b/docs/cmdline-opts/random-file.d index ad0a558cc..aa076de7f 100644 --- a/docs/cmdline-opts/random-file.d +++ b/docs/cmdline-opts/random-file.d @@ -1,4 +1,4 @@ -c: Copyright (C) 1998 - 2022, Daniel Stenberg, <daniel@haxx.se>, et al. +c: Copyright (C) Daniel Stenberg, <daniel@haxx.se>, et al. SPDX-License-Identifier: curl Long: random-file Arg: <file> @@ -9,8 +9,8 @@ Added: 7.7 See-also: egd-file Multi: single --- -Deprecated option. This option is ignored by curl since 7.84.0. Prior to that -it only had an effect on curl if built to use old versions of OpenSSL. +Deprecated option. This option is ignored (added in 7.84.0). Prior to that it +only had an effect on curl if built to use old versions of OpenSSL. -Specify the path name to file containing what will be considered as random -data. The data may be used to seed the random engine for SSL connections. +Specify the path name to file containing random data. The data may be used to +seed the random engine for SSL connections. diff --git a/docs/cmdline-opts/range.d b/docs/cmdline-opts/range.d index f49d40472..eba7220e1 100644 --- a/docs/cmdline-opts/range.d +++ b/docs/cmdline-opts/range.d @@ -1,4 +1,4 @@ -c: Copyright (C) 1998 - 2022, Daniel Stenberg, <daniel@haxx.se>, et al. +c: Copyright (C) Daniel Stenberg, <daniel@haxx.se>, et al. SPDX-License-Identifier: curl Long: range Short: r @@ -34,18 +34,16 @@ specifies the first and last byte only(*)(HTTP) specifies two separate 100-byte ranges(*) (HTTP) .RE .IP -(*) = NOTE that this will cause the server to reply with a multipart -response, which will be returned as-is by curl! Parsing or otherwise -transforming this response is the responsibility of the caller. +(*) = NOTE that this causes the server to reply with a multipart response, +which is returned as-is by curl! Parsing or otherwise transforming this +response is the responsibility of the caller. Only digit characters (0-9) are valid in the 'start' and 'stop' fields of the -'start-stop' range syntax. If a non-digit character is given in the range, -the server's response will be unspecified, depending on the server's -configuration. +'start-stop' range syntax. If a non-digit character is given in the range, the +server's response is unspecified, depending on the server's configuration. -You should also be aware that many HTTP/1.1 servers do not have this feature -enabled, so that when you attempt to get a range, you will instead get the -whole document. +Many HTTP/1.1 servers do not have this feature enabled, so that when you +attempt to get a range, curl instead gets the whole document. FTP and SFTP range downloads only support the simple 'start-stop' syntax (optionally with one of the numbers omitted). FTP use depends on the extended diff --git a/docs/cmdline-opts/rate.d b/docs/cmdline-opts/rate.d index 953f86596..d3cbd2849 100644 --- a/docs/cmdline-opts/rate.d +++ b/docs/cmdline-opts/rate.d @@ -1,22 +1,23 @@ -c: Copyright (C) 1998 - 2022, Daniel Stenberg, <daniel@haxx.se>, et al. +c: Copyright (C) Daniel Stenberg, <daniel@haxx.se>, et al. SPDX-License-Identifier: curl Long: rate Arg: <max request rate> Help: Request rate for serial transfers Category: connection -Example: --rate 2/s $URL -Example: --rate 3/h $URL -Example: --rate 14/m $URL +Example: --rate 2/s $URL ... +Example: --rate 3/h $URL ... +Example: --rate 14/m $URL ... Added: 7.84.0 See-also: limit-rate retry-delay Multi: single +Scope: global --- Specify the maximum transfer frequency you allow curl to use - in number of transfer starts per time unit (sometimes called request rate). Without this -option, curl will start the next transfer as fast as possible. +option, curl starts the next transfer as fast as possible. If given several URLs and a transfer completes faster than the allowed rate, -curl will wait until the next transfer is started to maintain the requested +curl waits until the next transfer is started to maintain the requested rate. This option has no effect when --parallel is used. The request rate is provided as "N/U" where N is an integer number and U is a @@ -24,11 +25,11 @@ time unit. Supported units are 's' (second), 'm' (minute), 'h' (hour) and 'd' /(day, as in a 24 hour unit). The default time unit, if no "/U" is provided, is number of transfers per hour. -If curl is told to allow 10 requests per minute, it will not start the next +If curl is told to allow 10 requests per minute, it does not start the next request until 6 seconds have elapsed since the previous transfer was started. This function uses millisecond resolution. If the allowed frequency is set -more than 1000 per second, it will instead run unrestricted. +more than 1000 per second, it instead runs unrestricted. When retrying transfers, enabled with --retry, the separate retry delay logic is used and not this setting. diff --git a/docs/cmdline-opts/raw.d b/docs/cmdline-opts/raw.d index 8e753c126..0523d62fa 100644 --- a/docs/cmdline-opts/raw.d +++ b/docs/cmdline-opts/raw.d @@ -1,4 +1,4 @@ -c: Copyright (C) 1998 - 2022, Daniel Stenberg, <daniel@haxx.se>, et al. +c: Copyright (C) Daniel Stenberg, <daniel@haxx.se>, et al. SPDX-License-Identifier: curl Long: raw Help: Do HTTP "raw"; no transfer decoding diff --git a/docs/cmdline-opts/referer.d b/docs/cmdline-opts/referer.d index 3740957eb..0609e8c99 100644 --- a/docs/cmdline-opts/referer.d +++ b/docs/cmdline-opts/referer.d @@ -1,4 +1,4 @@ -c: Copyright (C) 1998 - 2022, Daniel Stenberg, <daniel@haxx.se>, et al. +c: Copyright (C) Daniel Stenberg, <daniel@haxx.se>, et al. SPDX-License-Identifier: curl Long: referer Short: e diff --git a/docs/cmdline-opts/remote-header-name.d b/docs/cmdline-opts/remote-header-name.d index f97cf49a3..917fe7abf 100644 --- a/docs/cmdline-opts/remote-header-name.d +++ b/docs/cmdline-opts/remote-header-name.d @@ -1,4 +1,4 @@ -c: Copyright (C) 1998 - 2022, Daniel Stenberg, <daniel@haxx.se>, et al. +c: Copyright (C) Daniel Stenberg, <daniel@haxx.se>, et al. SPDX-License-Identifier: curl Long: remote-header-name Short: J @@ -12,20 +12,23 @@ Multi: boolean --- This option tells the --remote-name option to use the server-specified Content-Disposition filename instead of extracting a filename from the URL. If -the server-provided file name contains a path, that will be stripped off -before the file name is used. +the server-provided file name contains a path, that is stripped off before the +file name is used. The file is saved in the current directory, or in the directory specified with --output-dir. If the server specifies a file name and a file with that name already exists -in the destination directory, it will not be overwritten and an error will -occur. If the server does not specify a file name then this option has no -effect. +in the destination directory, it is not overwritten and an error occurs - +unless you allow it by using the --clobber option. If the server does not +specify a file name then this option has no effect. -There's no attempt to decode %-sequences (yet) in the provided file name, so +There is no attempt to decode %-sequences (yet) in the provided file name, so this option may provide you with rather unexpected file names. +This feature uses the name from the "filename" field, it does not yet support +the "filename*" field (filenames with explicit character sets). + **WARNING**: Exercise judicious use of this option, especially on Windows. A rogue server could send you the name of a DLL or other file that could be loaded automatically by Windows or some third party software. diff --git a/docs/cmdline-opts/remote-name-all.d b/docs/cmdline-opts/remote-name-all.d index fa6a233bb..249c4e265 100644 --- a/docs/cmdline-opts/remote-name-all.d +++ b/docs/cmdline-opts/remote-name-all.d @@ -1,4 +1,4 @@ -c: Copyright (C) 1998 - 2022, Daniel Stenberg, <daniel@haxx.se>, et al. +c: Copyright (C) Daniel Stenberg, <daniel@haxx.se>, et al. SPDX-License-Identifier: curl Long: remote-name-all Help: Use the remote file name for all URLs diff --git a/docs/cmdline-opts/remote-name.d b/docs/cmdline-opts/remote-name.d index 4e51b1206..215cf72de 100644 --- a/docs/cmdline-opts/remote-name.d +++ b/docs/cmdline-opts/remote-name.d @@ -1,4 +1,4 @@ -c: Copyright (C) 1998 - 2022, Daniel Stenberg, <daniel@haxx.se>, et al. +c: Copyright (C) Daniel Stenberg, <daniel@haxx.se>, et al. SPDX-License-Identifier: curl Long: remote-name Short: O @@ -12,17 +12,17 @@ Multi: append Write output to a local file named like the remote file we get. (Only the file part of the remote file is used, the path is cut off.) -The file will be saved in the current working directory. If you want the file -saved in a different directory, make sure you change the current working -directory before invoking curl with this option or use --output-dir. +The file is saved in the current working directory. If you want the file saved +in a different directory, make sure you change the current working directory +before invoking curl with this option or use --output-dir. The remote file name to use for saving is extracted from the given URL, -nothing else, and if it already exists it will be overwritten. If you want the +nothing else, and if it already exists it is overwritten. If you want the server to be able to choose the file name refer to --remote-header-name which can be used in addition to this option. If the server chooses a file name and -that name already exists it will not be overwritten. +that name already exists it is not overwritten. There is no URL decoding done on the file name. If it has %20 or other URL -encoded parts of the name, they will end up as-is as file name. +encoded parts of the name, they end up as-is as file name. You may use this option as many times as the number of URLs you have. diff --git a/docs/cmdline-opts/remote-time.d b/docs/cmdline-opts/remote-time.d index 12bd88306..6dfb26c49 100644 --- a/docs/cmdline-opts/remote-time.d +++ b/docs/cmdline-opts/remote-time.d @@ -1,4 +1,4 @@ -c: Copyright (C) 1998 - 2022, Daniel Stenberg, <daniel@haxx.se>, et al. +c: Copyright (C) Daniel Stenberg, <daniel@haxx.se>, et al. SPDX-License-Identifier: curl Long: remote-time Short: R @@ -9,6 +9,6 @@ Added: 7.9 See-also: remote-name time-cond Multi: boolean --- -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 +Makes 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/remove-on-error.d b/docs/cmdline-opts/remove-on-error.d index 4ac1595a9..50b7b1b65 100644 --- a/docs/cmdline-opts/remove-on-error.d +++ b/docs/cmdline-opts/remove-on-error.d @@ -1,4 +1,4 @@ -c: Copyright (C) 1998 - 2022, Daniel Stenberg, <daniel@haxx.se>, et al. +c: Copyright (C) Daniel Stenberg, <daniel@haxx.se>, et al. SPDX-License-Identifier: curl Long: remove-on-error Help: Remove output file on errors diff --git a/docs/cmdline-opts/request-target.d b/docs/cmdline-opts/request-target.d index 0ddcbc0b2..be53c658c 100644 --- a/docs/cmdline-opts/request-target.d +++ b/docs/cmdline-opts/request-target.d @@ -1,4 +1,4 @@ -c: Copyright (C) 1998 - 2022, Daniel Stenberg, <daniel@haxx.se>, et al. +c: Copyright (C) Daniel Stenberg, <daniel@haxx.se>, et al. SPDX-License-Identifier: curl Long: request-target Arg: <path> @@ -14,3 +14,6 @@ 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 without leading slash or other data that does not follow the regular URL pattern, like "OPTIONS *". + +curl passes on the verbatim string you give it its the request without any +filter or other safe guards. That includes white space and control characters. diff --git a/docs/cmdline-opts/request.d b/docs/cmdline-opts/request.d index c837f0987..6afd53564 100644 --- a/docs/cmdline-opts/request.d +++ b/docs/cmdline-opts/request.d @@ -1,4 +1,4 @@ -c: Copyright (C) 1998 - 2022, Daniel Stenberg, <daniel@haxx.se>, et al. +c: Copyright (C) Daniel Stenberg, <daniel@haxx.se>, et al. SPDX-License-Identifier: curl Long: request Short: X @@ -11,35 +11,44 @@ Added: 6.0 See-also: request-target Multi: single --- -(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 -otherwise used (which defaults to GET). Read the HTTP 1.1 specification for -details and explanations. Common additional HTTP requests include PUT and -DELETE, but related technologies like WebDAV offers PROPFIND, COPY, MOVE and +Change the method to use when starting the transfer. + +curl passes on the verbatim string you give it its the request without any +filter or other safe guards. That includes white space and control characters. +.RS +.TP 15 +**HTTP** +Specifies a custom request method to use when communicating with the HTTP +server. The specified request method is used instead of the method otherwise +used (which defaults to *GET*). Read the HTTP 1.1 specification for details +and explanations. Common additional HTTP requests include *PUT* and *DELETE*, +but related technologies like WebDAV offers *PROPFIND*, *COPY*, *MOVE* and more. -Normally you do not need this option. All sorts of GET, HEAD, POST and PUT -requests are rather invoked by using dedicated command line options. +Normally you do not need this option. All sorts of *GET*, *HEAD*, *POST* and +*PUT* requests are rather invoked by using dedicated command line options. This option only changes the actual word used in the HTTP request, it does not alter the way curl behaves. So for example if you want to make a proper HEAD -request, using -X HEAD will not suffice. You need to use the --head option. +request, using -X HEAD does not suffice. You need to use the --head option. -The method string you set with --request will be used for all requests, which +The method string you set with --request is used for all requests, which if you for example use --location may cause unintended side-effects when curl does not change request method according to the HTTP 30x response codes - and similar. - -(FTP) -Specifies a custom FTP command to use instead of LIST when doing file lists +.TP +**FTP** +Specifies a custom FTP command to use instead of *LIST* when doing file lists with FTP. - -(POP3) -Specifies a custom POP3 command to use instead of LIST or RETR. +.TP +**POP3** +Specifies a custom POP3 command to use instead of *LIST* or *RETR*. (Added in 7.26.0) - -(IMAP) -Specifies a custom IMAP command to use instead of LIST. (Added in 7.30.0) - -(SMTP) -Specifies a custom SMTP command to use instead of HELP or VRFY. (Added in 7.34.0) +.TP +**IMAP** +Specifies a custom IMAP command to use instead of *LIST*. (Added in 7.30.0) +.TP +**SMTP** +Specifies a custom SMTP command to use instead of *HELP* or **VRFY**. (Added in 7.34.0) +.RE +.IP diff --git a/docs/cmdline-opts/resolve.d b/docs/cmdline-opts/resolve.d index f5592bc75..badb54e45 100644 --- a/docs/cmdline-opts/resolve.d +++ b/docs/cmdline-opts/resolve.d @@ -1,4 +1,4 @@ -c: Copyright (C) 1998 - 2022, Daniel Stenberg, <daniel@haxx.se>, et al. +c: Copyright (C) Daniel Stenberg, <daniel@haxx.se>, et al. SPDX-License-Identifier: curl Long: resolve Arg: <[+]host:port:addr[,addr]...> @@ -13,22 +13,22 @@ Provide a custom address for a specific host and port pair. Using this, you can make the curl requests(s) use a specified address and prevent the otherwise normally resolved address to be used. Consider it a sort of /etc/hosts alternative provided on the command line. The port number should be -the number used for the specific protocol the host will be used for. It means +the number used for the specific protocol the host is used for. It means you need several entries if you want to provide address for the same host but different ports. By specifying '*' as host you can tell curl to resolve any host and specific port pair to the specified address. Wildcard is resolved last so any --resolve -with a specific host and port will be used first. +with a specific host and port is used first. -The provided address set by this option will be used even if --ipv4 or --ipv6 -is set to make curl use another IP version. +The provided address set by this option is used even if --ipv4 or --ipv6 is +set to make curl use another IP version. By prefixing the host with a '+' you can make the entry time out after curl's -default timeout (1 minute). Note that this will only make sense for long -running parallel transfers with a lot of files. In such cases, if this option -is used curl will try to resolve the host as it normally would once the -timeout has expired. +default timeout (1 minute). Note that this only makes sense for long running +parallel transfers with a lot of files. In such cases, if this option is used +curl tries to resolve the host as it normally would once the timeout has +expired. Support for providing the IP address within [brackets] was added in 7.57.0. @@ -37,5 +37,3 @@ Support for providing multiple IP addresses per entry was added in 7.59.0. Support for resolving with wildcard was added in 7.64.0. Support for the '+' prefix was was added in 7.75.0. - -This option can be used many times to add many host names to resolve. diff --git a/docs/cmdline-opts/retry-all-errors.d b/docs/cmdline-opts/retry-all-errors.d index a1fb89e9d..1190d6a3a 100644 --- a/docs/cmdline-opts/retry-all-errors.d +++ b/docs/cmdline-opts/retry-all-errors.d @@ -1,4 +1,4 @@ -c: Copyright (C) 1998 - 2022, Daniel Stenberg, <daniel@haxx.se>, et al. +c: Copyright (C) Daniel Stenberg, <daniel@haxx.se>, et al. SPDX-License-Identifier: curl Long: retry-all-errors Help: Retry all errors (use with --retry) @@ -11,10 +11,10 @@ Multi: boolean 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. +default (for example in your **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 @@ -25,10 +25,10 @@ file, which are not reset. We strongly suggest you do not parse or record output via redirect in combination with this option, since you may receive duplicate data. -By default curl 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 -Not Found and the reply is fully received then that is not an error. When ---retry is used then curl will retry on some HTTP response codes that indicate -transient HTTP errors, but that does not include most 4xx response codes such -as 404. If you want to retry on all response codes that indicate HTTP errors -(4xx and 5xx) then combine with --fail. +By default curl does not return error for transfers with an HTTP response code +that indicates an HTTP error, if the transfer was successful. For example, if +a server replies 404 Not Found and the reply is fully received then that is +not an error. When --retry is used then curl retries on some HTTP response +codes that indicate transient HTTP errors, but that does not include most 4xx +response codes such as 404. If you want to retry on all response codes that +indicate HTTP errors (4xx and 5xx) then combine with --fail. diff --git a/docs/cmdline-opts/retry-connrefused.d b/docs/cmdline-opts/retry-connrefused.d index 6916603d6..a7b9643ce 100644 --- a/docs/cmdline-opts/retry-connrefused.d +++ b/docs/cmdline-opts/retry-connrefused.d @@ -1,10 +1,10 @@ -c: Copyright (C) 1998 - 2022, Daniel Stenberg, <daniel@haxx.se>, et al. +c: Copyright (C) Daniel Stenberg, <daniel@haxx.se>, et al. SPDX-License-Identifier: curl Long: retry-connrefused Help: Retry on connection refused (use with --retry) Added: 7.52.0 Category: curl -Example: --retry-connrefused --retry $URL +Example: --retry-connrefused --retry 7 $URL See-also: retry retry-all-errors Multi: boolean --- diff --git a/docs/cmdline-opts/retry-delay.d b/docs/cmdline-opts/retry-delay.d index 78d0aac2a..686a0d8ba 100644 --- a/docs/cmdline-opts/retry-delay.d +++ b/docs/cmdline-opts/retry-delay.d @@ -1,15 +1,15 @@ -c: Copyright (C) 1998 - 2022, Daniel Stenberg, <daniel@haxx.se>, et al. +c: Copyright (C) Daniel Stenberg, <daniel@haxx.se>, et al. SPDX-License-Identifier: curl Long: retry-delay Arg: <seconds> Help: Wait time between retries Added: 7.12.3 Category: curl -Example: --retry-delay 5 --retry $URL +Example: --retry-delay 5 --retry 7 $URL See-also: retry Multi: single --- Make curl sleep this amount of time before each retry when a transfer has failed with a transient error (it changes the default backoff time algorithm between retries). This option is only interesting if --retry is also -used. Setting this delay to zero will make curl use the default backoff time. +used. Setting this delay to zero makes curl use the default backoff time. diff --git a/docs/cmdline-opts/retry-max-time.d b/docs/cmdline-opts/retry-max-time.d index 2e132f946..de2aff9a8 100644 --- a/docs/cmdline-opts/retry-max-time.d +++ b/docs/cmdline-opts/retry-max-time.d @@ -1,4 +1,4 @@ -c: Copyright (C) 1998 - 2022, Daniel Stenberg, <daniel@haxx.se>, et al. +c: Copyright (C) Daniel Stenberg, <daniel@haxx.se>, et al. SPDX-License-Identifier: curl Long: retry-max-time Arg: <seconds> @@ -9,9 +9,9 @@ Example: --retry-max-time 30 --retry 10 $URL See-also: retry Multi: single --- -The retry timer is reset before the first transfer attempt. Retries will be -done as usual (see --retry) as long as the timer has not reached this given -limit. Notice that if the timer has not reached the limit, the request will be +The retry timer is reset before the first transfer attempt. Retries are done +as usual (see --retry) as long as the timer has not reached this given +limit. Notice that if the timer has not reached the limit, the request is made and while performing, it may take longer than this given time period. To -limit a single request's maximum time, use --max-time. Set this option to -zero to not timeout retries. +limit a single request's maximum time, use --max-time. Set this option to zero +to not timeout retries. diff --git a/docs/cmdline-opts/retry.d b/docs/cmdline-opts/retry.d index 080825bf8..d49a0cdfb 100644 --- a/docs/cmdline-opts/retry.d +++ b/docs/cmdline-opts/retry.d @@ -1,4 +1,4 @@ -c: Copyright (C) 1998 - 2022, Daniel Stenberg, <daniel@haxx.se>, et al. +c: Copyright (C) Daniel Stenberg, <daniel@haxx.se>, et al. SPDX-License-Identifier: curl Long: retry Arg: <num> @@ -10,16 +10,16 @@ See-also: retry-max-time Multi: single --- 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 +retries this number of times before giving up. Setting the number to 0 makes curl do no retries (which is the default). Transient error means either: a timeout, an FTP 4xx response code or an HTTP 408, 429, 500, 502, 503 or 504 response code. -When curl is about to retry a transfer, it will first wait one second and then -for all forthcoming retries it will double the waiting time until it reaches -10 minutes which then will be the delay between the rest of the retries. By -using --retry-delay you disable this exponential backoff algorithm. See also +When curl is about to retry a transfer, it first waits one second and then for +all forthcoming retries it doubles the waiting time until it reaches 10 +minutes which then remains delay between the rest of the retries. By using +--retry-delay you disable this exponential backoff algorithm. See also --retry-max-time to limit the total time allowed for retries. -Since curl 7.66.0, curl will comply with the Retry-After: response header if -one was present to know when to issue the next retry. +curl complies with the Retry-After: response header if one was present to know +when to issue the next retry (added in 7.66.0). diff --git a/docs/cmdline-opts/sasl-authzid.d b/docs/cmdline-opts/sasl-authzid.d index ff56ce9c2..872818df7 100644 --- a/docs/cmdline-opts/sasl-authzid.d +++ b/docs/cmdline-opts/sasl-authzid.d @@ -1,4 +1,4 @@ -c: Copyright (C) 1998 - 2022, Daniel Stenberg, <daniel@haxx.se>, et al. +c: Copyright (C) Daniel Stenberg, <daniel@haxx.se>, et al. SPDX-License-Identifier: curl Long: sasl-authzid Arg: <identity> @@ -9,10 +9,11 @@ Example: --sasl-authzid zid imap://example.com/ See-also: login-options Multi: single --- -Use this authorization identity (authzid), during SASL PLAIN authentication, -in addition to the authentication identity (authcid) as specified by --user. +Use this authorization identity (**authzid**), during SASL PLAIN +authentication, in addition to the authentication identity (**authcid**) as +specified by --user. -If the option is not specified, the server will derive the authzid from the -authcid, but if specified, and depending on the server implementation, it may -be used to access another user's inbox, that the user has been granted access -to, or a shared mailbox for example. +If the option is not specified, the server derives the **authzid** from the +**authcid**, but if specified, and depending on the server implementation, it +may be used to access another user's inbox, that the user has been granted +access to, or a shared mailbox for example. diff --git a/docs/cmdline-opts/sasl-ir.d b/docs/cmdline-opts/sasl-ir.d index 8fe3a60e2..56f1ae8ad 100644 --- a/docs/cmdline-opts/sasl-ir.d +++ b/docs/cmdline-opts/sasl-ir.d @@ -1,4 +1,4 @@ -c: Copyright (C) 1998 - 2022, Daniel Stenberg, <daniel@haxx.se>, et al. +c: Copyright (C) Daniel Stenberg, <daniel@haxx.se>, et al. SPDX-License-Identifier: curl Long: sasl-ir Help: Enable initial response in SASL authentication diff --git a/docs/cmdline-opts/service-name.d b/docs/cmdline-opts/service-name.d index 0cf9cef74..54d7ebf7b 100644 --- a/docs/cmdline-opts/service-name.d +++ b/docs/cmdline-opts/service-name.d @@ -1,4 +1,4 @@ -c: Copyright (C) 1998 - 2022, Daniel Stenberg, <daniel@haxx.se>, et al. +c: Copyright (C) Daniel Stenberg, <daniel@haxx.se>, et al. SPDX-License-Identifier: curl Long: service-name Help: SPNEGO service name @@ -10,5 +10,3 @@ See-also: negotiate proxy-service-name Multi: single --- This option allows you to change the service name for SPNEGO. - -Examples: --negotiate --service-name sockd would use sockd/server-name. diff --git a/docs/cmdline-opts/show-error.d b/docs/cmdline-opts/show-error.d index a31e07d9e..f15028745 100644 --- a/docs/cmdline-opts/show-error.d +++ b/docs/cmdline-opts/show-error.d @@ -1,4 +1,4 @@ -c: Copyright (C) 1998 - 2022, Daniel Stenberg, <daniel@haxx.se>, et al. +c: Copyright (C) Daniel Stenberg, <daniel@haxx.se>, et al. SPDX-License-Identifier: curl Long: show-error Short: S @@ -8,8 +8,6 @@ Category: curl Example: --show-error --silent $URL Added: 5.9 Multi: boolean +Scope: global --- When used with --silent, it makes curl show an error message if it fails. - -This option is global and does not need to be specified for each use of ---next. diff --git a/docs/cmdline-opts/silent.d b/docs/cmdline-opts/silent.d index b31fe5cf1..74bb299cc 100644 --- a/docs/cmdline-opts/silent.d +++ b/docs/cmdline-opts/silent.d @@ -1,4 +1,4 @@ -c: Copyright (C) 1998 - 2022, Daniel Stenberg, <daniel@haxx.se>, et al. +c: Copyright (C) Daniel Stenberg, <daniel@haxx.se>, et al. SPDX-License-Identifier: curl Long: silent Short: s @@ -10,7 +10,7 @@ Added: 4.0 Multi: boolean --- Silent or quiet mode. Do not show progress meter or error messages. Makes Curl -mute. It will still output the data you ask for, potentially even to the +mute. It still outputs the data you ask for, potentially even to the terminal/stdout unless you redirect it. Use --show-error in addition to this option to disable progress meter but diff --git a/docs/cmdline-opts/socks4.d b/docs/cmdline-opts/socks4.d index c99a134e4..d8cf719aa 100644 --- a/docs/cmdline-opts/socks4.d +++ b/docs/cmdline-opts/socks4.d @@ -1,4 +1,4 @@ -c: Copyright (C) 1998 - 2022, Daniel Stenberg, <daniel@haxx.se>, et al. +c: Copyright (C) Daniel Stenberg, <daniel@haxx.se>, et al. SPDX-License-Identifier: curl Long: socks4 Arg: <host[:port]> @@ -22,6 +22,7 @@ exclusive. This option is superfluous since you can specify a socks4 proxy with --proxy using a socks4:// protocol prefix. (Added in 7.21.7) -Since 7.52.0, --preproxy can be used to specify a SOCKS proxy at the same time ---proxy is used with an HTTP/HTTPS proxy. In such a case curl first connects to -the SOCKS proxy and then connects (through SOCKS) to the HTTP or HTTPS proxy. +--preproxy can be used to specify a SOCKS proxy at the same time proxy is used +with an HTTP/HTTPS proxy (added in 7.52.0). In such a case, curl first +connects to the SOCKS proxy and then connects (through SOCKS) to the HTTP or +HTTPS proxy. diff --git a/docs/cmdline-opts/socks4a.d b/docs/cmdline-opts/socks4a.d index e3afbaf6b..cbb62724c 100644 --- a/docs/cmdline-opts/socks4a.d +++ b/docs/cmdline-opts/socks4a.d @@ -1,4 +1,4 @@ -c: Copyright (C) 1998 - 2022, Daniel Stenberg, <daniel@haxx.se>, et al. +c: Copyright (C) Daniel Stenberg, <daniel@haxx.se>, et al. SPDX-License-Identifier: curl Long: socks4a Arg: <host[:port]> @@ -21,6 +21,7 @@ exclusive. This option is superfluous since you can specify a socks4a proxy with --proxy using a socks4a:// protocol prefix. (Added in 7.21.7) -Since 7.52.0, --preproxy can be used to specify a SOCKS proxy at the same time ---proxy is used with an HTTP/HTTPS proxy. In such a case curl first connects to -the SOCKS proxy and then connects (through SOCKS) to the HTTP or HTTPS proxy. +--preproxy can be used to specify a SOCKS proxy at the same time --proxy is +used with an HTTP/HTTPS proxy (added in 7.52.0). In such a case, curl first +connects to the SOCKS proxy and then connects (through SOCKS) to the HTTP or +HTTPS proxy. diff --git a/docs/cmdline-opts/socks5-basic.d b/docs/cmdline-opts/socks5-basic.d index 1f4d5e33f..a16831be1 100644 --- a/docs/cmdline-opts/socks5-basic.d +++ b/docs/cmdline-opts/socks5-basic.d @@ -1,4 +1,4 @@ -c: Copyright (C) 1998 - 2022, Daniel Stenberg, <daniel@haxx.se>, et al. +c: Copyright (C) Daniel Stenberg, <daniel@haxx.se>, et al. SPDX-License-Identifier: curl Long: socks5-basic Help: Enable username/password auth for SOCKS5 proxies diff --git a/docs/cmdline-opts/socks5-gssapi-nec.d b/docs/cmdline-opts/socks5-gssapi-nec.d index bc5d31735..957655a09 100644 --- a/docs/cmdline-opts/socks5-gssapi-nec.d +++ b/docs/cmdline-opts/socks5-gssapi-nec.d @@ -1,4 +1,4 @@ -c: Copyright (C) 1998 - 2022, Daniel Stenberg, <daniel@haxx.se>, et al. +c: Copyright (C) Daniel Stenberg, <daniel@haxx.se>, et al. SPDX-License-Identifier: curl Long: socks5-gssapi-nec Help: Compatibility with NEC SOCKS5 server diff --git a/docs/cmdline-opts/socks5-gssapi-service.d b/docs/cmdline-opts/socks5-gssapi-service.d index 218c0bf38..66c2f33a5 100644 --- a/docs/cmdline-opts/socks5-gssapi-service.d +++ b/docs/cmdline-opts/socks5-gssapi-service.d @@ -1,4 +1,4 @@ -c: Copyright (C) 1998 - 2022, Daniel Stenberg, <daniel@haxx.se>, et al. +c: Copyright (C) Daniel Stenberg, <daniel@haxx.se>, et al. SPDX-License-Identifier: curl Long: socks5-gssapi-service Arg: <name> @@ -9,10 +9,5 @@ Example: --socks5-gssapi-service sockd --socks5 hostname:4096 $URL See-also: socks5 Multi: single --- -The default service name for a socks server is rcmd/server-fqdn. This option +The default service name for a socks server is **rcmd/server-fqdn**. This option allows you to change it. - -Examples: --socks5 proxy-name --socks5-gssapi-service sockd would use -sockd/proxy-name --socks5 proxy-name --socks5-gssapi-service sockd/real-name -would use sockd/real-name for cases where the proxy-name does not match the -principal name. diff --git a/docs/cmdline-opts/socks5-gssapi.d b/docs/cmdline-opts/socks5-gssapi.d index 3a4fda21c..cec684f42 100644 --- a/docs/cmdline-opts/socks5-gssapi.d +++ b/docs/cmdline-opts/socks5-gssapi.d @@ -1,4 +1,4 @@ -c: Copyright (C) 1998 - 2022, Daniel Stenberg, <daniel@haxx.se>, et al. +c: Copyright (C) Daniel Stenberg, <daniel@haxx.se>, et al. SPDX-License-Identifier: curl Long: socks5-gssapi Help: Enable GSS-API auth for SOCKS5 proxies diff --git a/docs/cmdline-opts/socks5-hostname.d b/docs/cmdline-opts/socks5-hostname.d index a5781370d..ee49ca642 100644 --- a/docs/cmdline-opts/socks5-hostname.d +++ b/docs/cmdline-opts/socks5-hostname.d @@ -1,4 +1,4 @@ -c: Copyright (C) 1998 - 2022, Daniel Stenberg, <daniel@haxx.se>, et al. +c: Copyright (C) Daniel Stenberg, <daniel@haxx.se>, et al. SPDX-License-Identifier: curl Long: socks5-hostname Arg: <host[:port]> @@ -21,6 +21,7 @@ exclusive. This option is superfluous since you can specify a socks5 hostname proxy with --proxy using a socks5h:// protocol prefix. (Added in 7.21.7) -Since 7.52.0, --preproxy can be used to specify a SOCKS proxy at the same time ---proxy is used with an HTTP/HTTPS proxy. In such a case curl first connects to -the SOCKS proxy and then connects (through SOCKS) to the HTTP or HTTPS proxy. +--preproxy can be used to specify a SOCKS proxy at the same time --proxy is +used with an HTTP/HTTPS proxy (added in 7.52.0). In such a case, curl first +connects to the SOCKS proxy and then connects (through SOCKS) to the HTTP or +HTTPS proxy. diff --git a/docs/cmdline-opts/socks5.d b/docs/cmdline-opts/socks5.d index 183b8c24d..0e52166ea 100644 --- a/docs/cmdline-opts/socks5.d +++ b/docs/cmdline-opts/socks5.d @@ -1,4 +1,4 @@ -c: Copyright (C) 1998 - 2022, Daniel Stenberg, <daniel@haxx.se>, et al. +c: Copyright (C) Daniel Stenberg, <daniel@haxx.se>, et al. SPDX-License-Identifier: curl Long: socks5 Arg: <host[:port]> @@ -21,8 +21,9 @@ exclusive. This option is superfluous since you can specify a socks5 proxy with --proxy using a socks5:// protocol prefix. (Added in 7.21.7) -Since 7.52.0, --preproxy can be used to specify a SOCKS proxy at the same time ---proxy is used with an HTTP/HTTPS proxy. In such a case curl first connects to -the SOCKS proxy and then connects (through SOCKS) to the HTTP or HTTPS proxy. +--preproxy can be used to specify a SOCKS proxy at the same time --proxy is +used with an HTTP/HTTPS proxy (added in 7.52.0). In such a case, curl first +connects to the SOCKS proxy and then connects (through SOCKS) to the HTTP or +HTTPS proxy. This option (as well as --socks4) does not work with IPV6, FTPS or LDAP. diff --git a/docs/cmdline-opts/speed-limit.d b/docs/cmdline-opts/speed-limit.d index 878ca440d..dc9778db9 100644 --- a/docs/cmdline-opts/speed-limit.d +++ b/docs/cmdline-opts/speed-limit.d @@ -1,4 +1,4 @@ -c: Copyright (C) 1998 - 2022, Daniel Stenberg, <daniel@haxx.se>, et al. +c: Copyright (C) Daniel Stenberg, <daniel@haxx.se>, et al. SPDX-License-Identifier: curl Long: speed-limit Short: Y diff --git a/docs/cmdline-opts/speed-time.d b/docs/cmdline-opts/speed-time.d index 1426b5648..4a8860660 100644 --- a/docs/cmdline-opts/speed-time.d +++ b/docs/cmdline-opts/speed-time.d @@ -1,4 +1,4 @@ -c: Copyright (C) 1998 - 2022, Daniel Stenberg, <daniel@haxx.se>, et al. +c: Copyright (C) Daniel Stenberg, <daniel@haxx.se>, et al. SPDX-License-Identifier: curl Long: speed-time Short: y @@ -10,9 +10,9 @@ Added: 4.7 See-also: speed-limit limit-rate Multi: single --- -If a transfer runs slower than speed-limit bytes per second during a speed-time -period, the transfer is aborted. If speed-time is used, the default -speed-limit will be 1 unless set with --speed-limit. +If a transfer runs slower than speed-limit bytes per second during a +speed-time period, the transfer is aborted. If speed-time is used, the default +speed-limit is 1 unless set with --speed-limit. -This option controls transfers (in both directions) but will not affect slow +This option controls transfers (in both directions) but does not affect slow connects etc. If this is a concern for you, try the --connect-timeout option. diff --git a/docs/cmdline-opts/ssl-allow-beast.d b/docs/cmdline-opts/ssl-allow-beast.d index 2545d07ba..2547675d6 100644 --- a/docs/cmdline-opts/ssl-allow-beast.d +++ b/docs/cmdline-opts/ssl-allow-beast.d @@ -1,4 +1,4 @@ -c: Copyright (C) 1998 - 2022, Daniel Stenberg, <daniel@haxx.se>, et al. +c: Copyright (C) Daniel Stenberg, <daniel@haxx.se>, et al. SPDX-License-Identifier: curl Long: ssl-allow-beast Help: Allow security flaw to improve interop diff --git a/docs/cmdline-opts/ssl-auto-client-cert.d b/docs/cmdline-opts/ssl-auto-client-cert.d index 617d20a64..5328adea7 100644 --- a/docs/cmdline-opts/ssl-auto-client-cert.d +++ b/docs/cmdline-opts/ssl-auto-client-cert.d @@ -1,4 +1,4 @@ -c: Copyright (C) 1998 - 2022, Daniel Stenberg, <daniel@haxx.se>, et al. +c: Copyright (C) Daniel Stenberg, <daniel@haxx.se>, et al. SPDX-License-Identifier: curl Long: ssl-auto-client-cert Help: Use auto client certificate (Schannel) @@ -8,9 +8,7 @@ Category: tls Example: --ssl-auto-client-cert $URL Multi: boolean --- -Tell libcurl to automatically locate and use a client certificate for -authentication, when requested by the server. This option is only supported -for Schannel (the native Windows SSL library). Prior to 7.77.0 this was the -default behavior in libcurl with Schannel. Since the server can request any -certificate that supports client authentication in the OS certificate store it -could be a privacy violation and unexpected. +(Schannel) Tell libcurl to automatically locate and use a client certificate +for authentication, when requested by the server. Since the server can request +any certificate that supports client authentication in the OS certificate +store it could be a privacy violation and unexpected. diff --git a/docs/cmdline-opts/ssl-no-revoke.d b/docs/cmdline-opts/ssl-no-revoke.d index ad036740f..37e91d9c2 100644 --- a/docs/cmdline-opts/ssl-no-revoke.d +++ b/docs/cmdline-opts/ssl-no-revoke.d @@ -1,4 +1,4 @@ -c: Copyright (C) 1998 - 2022, Daniel Stenberg, <daniel@haxx.se>, et al. +c: Copyright (C) Daniel Stenberg, <daniel@haxx.se>, et al. SPDX-License-Identifier: curl Long: ssl-no-revoke Help: Disable cert revocation checks (Schannel) diff --git a/docs/cmdline-opts/ssl-reqd.d b/docs/cmdline-opts/ssl-reqd.d index cf81fb229..8a5b8577e 100644 --- a/docs/cmdline-opts/ssl-reqd.d +++ b/docs/cmdline-opts/ssl-reqd.d @@ -1,4 +1,4 @@ -c: Copyright (C) 1998 - 2022, Daniel Stenberg, <daniel@haxx.se>, et al. +c: Copyright (C) Daniel Stenberg, <daniel@haxx.se>, et al. SPDX-License-Identifier: curl Long: ssl-reqd Help: Require SSL/TLS @@ -9,11 +9,15 @@ Example: --ssl-reqd ftp://example.com See-also: ssl insecure Multi: boolean --- -Require SSL/TLS for the connection. Terminates the connection if the server -does not support SSL/TLS. +Require SSL/TLS for the connection. Terminates the connection if the transfer +cannot be upgraded to use SSL/TLS. -This option is handled in LDAP since version 7.81.0. It is fully supported -by the OpenLDAP backend and rejected by the generic ldap backend if explicit -TLS is required. +This option is handled in LDAP (added in 7.81.0). It is fully supported by the +OpenLDAP backend and rejected by the generic ldap backend if explicit TLS is +required. + +This option is unnecessary if you use a URL scheme that in itself implies +immediate and implicit use of TLS, like for FTPS, IMAPS, POP3S, SMTPS and +LDAPS. Such a transfer always fails if the TLS handshake does not work. This option was formerly known as --ftp-ssl-reqd. diff --git a/docs/cmdline-opts/ssl-revoke-best-effort.d b/docs/cmdline-opts/ssl-revoke-best-effort.d index edf04cc0e..cb26d0b9a 100644 --- a/docs/cmdline-opts/ssl-revoke-best-effort.d +++ b/docs/cmdline-opts/ssl-revoke-best-effort.d @@ -1,7 +1,7 @@ -c: Copyright (C) 1998 - 2022, Daniel Stenberg, <daniel@haxx.se>, et al. +c: Copyright (C) Daniel Stenberg, <daniel@haxx.se>, et al. SPDX-License-Identifier: curl Long: ssl-revoke-best-effort -Help: Ignore missing/offline cert CRL dist points +Help: Ignore missing/offline cert CRL dist points (Schannel) Added: 7.70.0 Category: tls Example: --ssl-revoke-best-effort $URL diff --git a/docs/cmdline-opts/ssl.d b/docs/cmdline-opts/ssl.d index 31d46f883..b8fd22a9c 100644 --- a/docs/cmdline-opts/ssl.d +++ b/docs/cmdline-opts/ssl.d @@ -1,4 +1,4 @@ -c: Copyright (C) 1998 - 2022, Daniel Stenberg, <daniel@haxx.se>, et al. +c: Copyright (C) Daniel Stenberg, <daniel@haxx.se>, et al. SPDX-License-Identifier: curl Long: ssl Help: Try SSL/TLS @@ -16,11 +16,11 @@ Try to use SSL/TLS for the connection. Reverts to a non-secure connection if the server does not support SSL/TLS. See also --ftp-ssl-control and --ssl-reqd for different levels of encryption required. -This option is handled in LDAP since version 7.81.0. It is fully supported -by the OpenLDAP backend and ignored by the generic ldap backend. +This option is handled in LDAP (added in 7.81.0). It is fully supported by the +OpenLDAP backend and ignored by the generic ldap backend. Please note that a server may close the connection if the negotiation does not succeed. -This option was formerly known as --ftp-ssl (Added in 7.11.0). That option -name can still be used but will be removed in a future version. +This option was formerly known as --ftp-ssl (added in 7.11.0). That option +name can still be used but might be removed in a future version. diff --git a/docs/cmdline-opts/sslv2.d b/docs/cmdline-opts/sslv2.d index fbda3fa12..3ecf109a0 100644 --- a/docs/cmdline-opts/sslv2.d +++ b/docs/cmdline-opts/sslv2.d @@ -1,4 +1,4 @@ -c: Copyright (C) 1998 - 2022, Daniel Stenberg, <daniel@haxx.se>, et al. +c: Copyright (C) Daniel Stenberg, <daniel@haxx.se>, et al. SPDX-License-Identifier: curl Short: 2 Long: sslv2 @@ -13,6 +13,5 @@ Category: tls Example: --sslv2 $URL Multi: mutex --- -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 is now ignored +(added in 7.77.0). SSLv2 is widely considered insecure (see RFC 6176). diff --git a/docs/cmdline-opts/sslv3.d b/docs/cmdline-opts/sslv3.d index 26f8e44b0..409afc610 100644 --- a/docs/cmdline-opts/sslv3.d +++ b/docs/cmdline-opts/sslv3.d @@ -1,4 +1,4 @@ -c: Copyright (C) 1998 - 2022, Daniel Stenberg, <daniel@haxx.se>, et al. +c: Copyright (C) Daniel Stenberg, <daniel@haxx.se>, et al. SPDX-License-Identifier: curl Short: 3 Long: sslv3 @@ -13,6 +13,5 @@ Category: tls Example: --sslv3 $URL Multi: mutex --- -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 -7568). +This option previously asked curl to use SSLv3, but is now ignored +(added in 7.77.0). SSLv3 is widely considered insecure (see RFC 7568). diff --git a/docs/cmdline-opts/stderr.d b/docs/cmdline-opts/stderr.d index e23f3cd14..a80bf43d1 100644 --- a/docs/cmdline-opts/stderr.d +++ b/docs/cmdline-opts/stderr.d @@ -1,4 +1,4 @@ -c: Copyright (C) 1998 - 2022, Daniel Stenberg, <daniel@haxx.se>, et al. +c: Copyright (C) Daniel Stenberg, <daniel@haxx.se>, et al. SPDX-License-Identifier: curl Long: stderr Arg: <file> @@ -8,9 +8,7 @@ Category: verbose Example: --stderr output.txt $URL Added: 6.2 Multi: single +Scope: global --- Redirect all writes to stderr to the specified file instead. If the file name is a plain '-', it is instead written to stdout. - -This option is global and does not need to be specified for each use of ---next. diff --git a/docs/cmdline-opts/styled-output.d b/docs/cmdline-opts/styled-output.d index 20e011405..70e9da4e8 100644 --- a/docs/cmdline-opts/styled-output.d +++ b/docs/cmdline-opts/styled-output.d @@ -1,4 +1,4 @@ -c: Copyright (C) 1998 - 2022, Daniel Stenberg, <daniel@haxx.se>, et al. +c: Copyright (C) Daniel Stenberg, <daniel@haxx.se>, et al. SPDX-License-Identifier: curl Long: styled-output Help: Enable styled output for HTTP headers @@ -7,9 +7,10 @@ Category: verbose Example: --styled-output -I $URL See-also: head verbose Multi: boolean +Scope: global --- Enables the automatic use of bold font styles when writing HTTP headers to the terminal. Use --no-styled-output to switch them off. -This option is global and does not need to be specified for each use of ---next. +Styled output requires a terminal that supports bold fonts. This feature is +not present on curl for Windows due to lack of this capability. diff --git a/docs/cmdline-opts/suppress-connect-headers.d b/docs/cmdline-opts/suppress-connect-headers.d index adde2499c..ed38f36de 100644 --- a/docs/cmdline-opts/suppress-connect-headers.d +++ b/docs/cmdline-opts/suppress-connect-headers.d @@ -1,4 +1,4 @@ -c: Copyright (C) 1998 - 2022, Daniel Stenberg, <daniel@haxx.se>, et al. +c: Copyright (C) Daniel Stenberg, <daniel@haxx.se>, et al. SPDX-License-Identifier: curl Long: suppress-connect-headers Help: Suppress proxy CONNECT response headers diff --git a/docs/cmdline-opts/tcp-fastopen.d b/docs/cmdline-opts/tcp-fastopen.d index 155dfed94..bcf1edbff 100644 --- a/docs/cmdline-opts/tcp-fastopen.d +++ b/docs/cmdline-opts/tcp-fastopen.d @@ -1,4 +1,4 @@ -c: Copyright (C) 1998 - 2022, Daniel Stenberg, <daniel@haxx.se>, et al. +c: Copyright (C) Daniel Stenberg, <daniel@haxx.se>, et al. SPDX-License-Identifier: curl Long: tcp-fastopen Added: 7.49.0 @@ -8,4 +8,7 @@ Example: --tcp-fastopen $URL See-also: false-start Multi: boolean --- -Enable use of TCP Fast Open (RFC7413). + +Enable use of TCP Fast Open (RFC 7413). TCP Fast Open is a TCP extension that +allows data to get sent earlier over the connection (before the final +handshake ACK) if the client and server have been connected previously. diff --git a/docs/cmdline-opts/tcp-nodelay.d b/docs/cmdline-opts/tcp-nodelay.d index cbb0a92ba..2bf51cb5f 100644 --- a/docs/cmdline-opts/tcp-nodelay.d +++ b/docs/cmdline-opts/tcp-nodelay.d @@ -1,4 +1,4 @@ -c: Copyright (C) 1998 - 2022, Daniel Stenberg, <daniel@haxx.se>, et al. +c: Copyright (C) Daniel Stenberg, <daniel@haxx.se>, et al. SPDX-License-Identifier: curl Long: tcp-nodelay Help: Use the TCP_NODELAY option @@ -11,5 +11,5 @@ Multi: boolean Turn on the TCP_NODELAY option. See the *curl_easy_setopt(3)* man page for details about this option. -Since 7.50.2, curl sets this option by default and you need to explicitly -switch it off if you do not want it on. +curl sets this option by default and you need to explicitly switch it off if +you do not want it on (added in 7.50.2). diff --git a/docs/cmdline-opts/telnet-option.d b/docs/cmdline-opts/telnet-option.d index 3e239e20f..651ce4203 100644 --- a/docs/cmdline-opts/telnet-option.d +++ b/docs/cmdline-opts/telnet-option.d @@ -1,4 +1,4 @@ -c: Copyright (C) 1998 - 2022, Daniel Stenberg, <daniel@haxx.se>, et al. +c: Copyright (C) Daniel Stenberg, <daniel@haxx.se>, et al. SPDX-License-Identifier: curl Long: telnet-option Short: t @@ -12,8 +12,12 @@ Multi: append --- Pass options to the telnet protocol. Supported options are: -TTYPE=<term> Sets the terminal type. - -XDISPLOC=<X display> Sets the X display location. - -NEW_ENV=<var,val> Sets an environment variable. +.RS +.TP 15 +**TTYPE**=<term> Sets the terminal type. +.TP +**XDISPLOC**=<X display> Sets the X display location. +.TP +**NEW_ENV**=<var,val> Sets an environment variable. +.RE +.IP diff --git a/docs/cmdline-opts/tftp-blksize.d b/docs/cmdline-opts/tftp-blksize.d index 9aaa9850d..76c7ee4b1 100644 --- a/docs/cmdline-opts/tftp-blksize.d +++ b/docs/cmdline-opts/tftp-blksize.d @@ -1,4 +1,4 @@ -c: Copyright (C) 1998 - 2022, Daniel Stenberg, <daniel@haxx.se>, et al. +c: Copyright (C) Daniel Stenberg, <daniel@haxx.se>, et al. SPDX-License-Identifier: curl Long: tftp-blksize Arg: <value> @@ -10,6 +10,6 @@ Example: --tftp-blksize 1024 tftp://example.com/file See-also: tftp-no-options Multi: single --- -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 -bytes will be used. +Set the TFTP **BLKSIZE** option (must be >512). This is the block size that +curl tries to use when transferring data to or from a TFTP server. By +default 512 bytes are used. diff --git a/docs/cmdline-opts/tftp-no-options.d b/docs/cmdline-opts/tftp-no-options.d index 8b252bd28..43b1c00c4 100644 --- a/docs/cmdline-opts/tftp-no-options.d +++ b/docs/cmdline-opts/tftp-no-options.d @@ -1,4 +1,4 @@ -c: Copyright (C) 1998 - 2022, Daniel Stenberg, <daniel@haxx.se>, et al. +c: Copyright (C) Daniel Stenberg, <daniel@haxx.se>, et al. SPDX-License-Identifier: curl Long: tftp-no-options Help: Do not send any TFTP options diff --git a/docs/cmdline-opts/time-cond.d b/docs/cmdline-opts/time-cond.d index 416b16527..c21ed2853 100644 --- a/docs/cmdline-opts/time-cond.d +++ b/docs/cmdline-opts/time-cond.d @@ -1,4 +1,4 @@ -c: Copyright (C) 1998 - 2022, Daniel Stenberg, <daniel@haxx.se>, et al. +c: Copyright (C) Daniel Stenberg, <daniel@haxx.se>, et al. SPDX-License-Identifier: curl Long: time-cond Short: z @@ -22,3 +22,6 @@ instead. See the *curl_getdate(3)* man pages for date expression details. Start the date expression with a dash (-) to make it request for a document that is older than the given date/time, default is a document that is newer than the specified date/time. + +If provided a non-existing file, curl outputs a warning about that fact and +proceeds to do the transfer without a time condition. diff --git a/docs/cmdline-opts/tls-max.d b/docs/cmdline-opts/tls-max.d index 6a7375a70..2d52c1039 100644 --- a/docs/cmdline-opts/tls-max.d +++ b/docs/cmdline-opts/tls-max.d @@ -1,9 +1,9 @@ -c: Copyright (C) 1998 - 2022, Daniel Stenberg, <daniel@haxx.se>, et al. +c: Copyright (C) Daniel Stenberg, <daniel@haxx.se>, et al. SPDX-License-Identifier: curl Long: tls-max Arg: <VERSION> Tags: Versions -Protocols: SSL +Protocols: TLS Added: 7.54.0 Requires: TLS See-also: tlsv1.0 tlsv1.1 tlsv1.2 tlsv1.3 @@ -31,3 +31,4 @@ Use up to TLSv1.2. .IP "1.3" Use up to TLSv1.3. .RE +.IP diff --git a/docs/cmdline-opts/tls13-ciphers.d b/docs/cmdline-opts/tls13-ciphers.d index 60cbfe59a..34c607dd1 100644 --- a/docs/cmdline-opts/tls13-ciphers.d +++ b/docs/cmdline-opts/tls13-ciphers.d @@ -1,4 +1,4 @@ -c: Copyright (C) 1998 - 2022, Daniel Stenberg, <daniel@haxx.se>, et al. +c: Copyright (C) Daniel Stenberg, <daniel@haxx.se>, et al. SPDX-License-Identifier: curl Long: tls13-ciphers Arg: <ciphersuite list> @@ -7,15 +7,15 @@ Protocols: TLS Category: tls Example: --tls13-ciphers TLS_AES_128_GCM_SHA256 $URL Added: 7.61.0 -See-also: ciphers curves +See-also: ciphers curves proxy-tls13-ciphers Multi: single --- 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: - https://curl.se/docs/ssl-ciphers.html +https://curl.se/docs/ssl-ciphers.html This option is currently used only when curl is built to use OpenSSL 1.1.1 or -later. If you are using a different SSL backend you can try setting TLS 1.3 -cipher suites by using the --ciphers option. +later, or Schannel. If you are using a different SSL backend you can try +setting TLS 1.3 cipher suites by using the --ciphers option. diff --git a/docs/cmdline-opts/tlsauthtype.d b/docs/cmdline-opts/tlsauthtype.d index 239753994..7d3f7e5aa 100644 --- a/docs/cmdline-opts/tlsauthtype.d +++ b/docs/cmdline-opts/tlsauthtype.d @@ -1,4 +1,4 @@ -c: Copyright (C) 1998 - 2022, Daniel Stenberg, <daniel@haxx.se>, et al. +c: Copyright (C) Daniel Stenberg, <daniel@haxx.se>, et al. SPDX-License-Identifier: curl Long: tlsauthtype Arg: <type> diff --git a/docs/cmdline-opts/tlspassword.d b/docs/cmdline-opts/tlspassword.d index 053751e7f..0513191ae 100644 --- a/docs/cmdline-opts/tlspassword.d +++ b/docs/cmdline-opts/tlspassword.d @@ -1,4 +1,4 @@ -c: Copyright (C) 1998 - 2022, Daniel Stenberg, <daniel@haxx.se>, et al. +c: Copyright (C) Daniel Stenberg, <daniel@haxx.se>, et al. SPDX-License-Identifier: curl Long: tlspassword Arg: <string> diff --git a/docs/cmdline-opts/tlsuser.d b/docs/cmdline-opts/tlsuser.d index a3f0d54cd..f87532a7c 100644 --- a/docs/cmdline-opts/tlsuser.d +++ b/docs/cmdline-opts/tlsuser.d @@ -1,4 +1,4 @@ -c: Copyright (C) 1998 - 2022, Daniel Stenberg, <daniel@haxx.se>, et al. +c: Copyright (C) Daniel Stenberg, <daniel@haxx.se>, et al. SPDX-License-Identifier: curl Long: tlsuser Arg: <name> diff --git a/docs/cmdline-opts/tlsv1.0.d b/docs/cmdline-opts/tlsv1.0.d index f5fe3bfb0..493c0c653 100644 --- a/docs/cmdline-opts/tlsv1.0.d +++ b/docs/cmdline-opts/tlsv1.0.d @@ -1,4 +1,4 @@ -c: Copyright (C) 1998 - 2022, Daniel Stenberg, <daniel@haxx.se>, et al. +c: Copyright (C) Daniel Stenberg, <daniel@haxx.se>, et al. SPDX-License-Identifier: curl Long: tlsv1.0 Help: Use TLSv1.0 or greater diff --git a/docs/cmdline-opts/tlsv1.1.d b/docs/cmdline-opts/tlsv1.1.d index 567254d70..f8ecdf67a 100644 --- a/docs/cmdline-opts/tlsv1.1.d +++ b/docs/cmdline-opts/tlsv1.1.d @@ -1,4 +1,4 @@ -c: Copyright (C) 1998 - 2022, Daniel Stenberg, <daniel@haxx.se>, et al. +c: Copyright (C) Daniel Stenberg, <daniel@haxx.se>, et al. SPDX-License-Identifier: curl Long: tlsv1.1 Help: Use TLSv1.1 or greater diff --git a/docs/cmdline-opts/tlsv1.2.d b/docs/cmdline-opts/tlsv1.2.d index df1b90be9..a9953604e 100644 --- a/docs/cmdline-opts/tlsv1.2.d +++ b/docs/cmdline-opts/tlsv1.2.d @@ -1,4 +1,4 @@ -c: Copyright (C) 1998 - 2022, Daniel Stenberg, <daniel@haxx.se>, et al. +c: Copyright (C) Daniel Stenberg, <daniel@haxx.se>, et al. SPDX-License-Identifier: curl Long: tlsv1.2 Help: Use TLSv1.2 or greater diff --git a/docs/cmdline-opts/tlsv1.3.d b/docs/cmdline-opts/tlsv1.3.d index d91b175d3..5690aa113 100644 --- a/docs/cmdline-opts/tlsv1.3.d +++ b/docs/cmdline-opts/tlsv1.3.d @@ -1,4 +1,4 @@ -c: Copyright (C) 1998 - 2022, Daniel Stenberg, <daniel@haxx.se>, et al. +c: Copyright (C) Daniel Stenberg, <daniel@haxx.se>, et al. SPDX-License-Identifier: curl Long: tlsv1.3 Help: Use TLSv1.3 or greater diff --git a/docs/cmdline-opts/tlsv1.d b/docs/cmdline-opts/tlsv1.d index b958a809e..16aee71a3 100644 --- a/docs/cmdline-opts/tlsv1.d +++ b/docs/cmdline-opts/tlsv1.d @@ -1,9 +1,9 @@ -c: Copyright (C) 1998 - 2022, Daniel Stenberg, <daniel@haxx.se>, et al. +c: Copyright (C) Daniel Stenberg, <daniel@haxx.se>, et al. SPDX-License-Identifier: curl Short: 1 Long: tlsv1 Tags: Versions -Protocols: SSL +Protocols: TLS Added: 7.9.2 Mutexed: tlsv1.1 tlsv1.2 tlsv1.3 Requires: TLS diff --git a/docs/cmdline-opts/tr-encoding.d b/docs/cmdline-opts/tr-encoding.d index ca385ce53..053e18ca1 100644 --- a/docs/cmdline-opts/tr-encoding.d +++ b/docs/cmdline-opts/tr-encoding.d @@ -1,4 +1,4 @@ -c: Copyright (C) 1998 - 2022, Daniel Stenberg, <daniel@haxx.se>, et al. +c: Copyright (C) Daniel Stenberg, <daniel@haxx.se>, et al. SPDX-License-Identifier: curl Long: tr-encoding Added: 7.21.6 diff --git a/docs/cmdline-opts/trace-ascii.d b/docs/cmdline-opts/trace-ascii.d index 01484f9f6..2aebc2863 100644 --- a/docs/cmdline-opts/trace-ascii.d +++ b/docs/cmdline-opts/trace-ascii.d @@ -1,4 +1,4 @@ -c: Copyright (C) 1998 - 2022, Daniel Stenberg, <daniel@haxx.se>, et al. +c: Copyright (C) Daniel Stenberg, <daniel@haxx.se>, et al. SPDX-License-Identifier: curl Long: trace-ascii Arg: <file> @@ -9,6 +9,7 @@ Example: --trace-ascii log.txt $URL Added: 7.9.7 See-also: verbose trace Multi: single +Scope: global --- Enables a full trace dump of all incoming and outgoing data, including descriptive information, to the given output file. Use "-" as filename to have @@ -18,5 +19,6 @@ This is similar to --trace, but leaves out the hex part and only shows the ASCII part of the dump. It makes smaller output that might be easier to read for untrained humans. -This option is global and does not need to be specified for each use of ---next. +Note that verbose output of curl activities and network traffic might contain +sensitive data, including user names, credentials or secret data content. Be +aware and be careful when sharing trace logs with others. diff --git a/docs/cmdline-opts/trace-config.d b/docs/cmdline-opts/trace-config.d new file mode 100644 index 000000000..a731c9dc9 --- /dev/null +++ b/docs/cmdline-opts/trace-config.d @@ -0,0 +1,21 @@ +c: Copyright (C) Daniel Stenberg, <daniel@haxx.se>, et al. +SPDX-License-Identifier: curl +Long: trace-config +Arg: <string> +Help: Details to log in trace/verbose output +Mutexed: trace verbose +Category: verbose +Example: --trace-config ids,http/2 $URL +Added: 8.3.0 +See-also: verbose trace +Multi: append +Scope: global +--- +Set configuration for trace output. A comma-separated list of components where +detailed output can be made available from. Names are case-insensitive. +Specify 'all' to enable all trace components. + +In addition to trace component names, specify "ids" and "time" to +avoid extra --trace-ids or --trace-time parameters. + +See the *curl_global_trace(3)* man page for more details. diff --git a/docs/cmdline-opts/trace-ids.d b/docs/cmdline-opts/trace-ids.d new file mode 100644 index 000000000..7b8ce6f70 --- /dev/null +++ b/docs/cmdline-opts/trace-ids.d @@ -0,0 +1,12 @@ +c: Copyright (C) Daniel Stenberg, <daniel@haxx.se>, et al. +SPDX-License-Identifier: curl +Long: trace-ids +Help: Add transfer and connection identifiers to trace/verbose output +Added: 8.2.0 +Category: verbose +Example: --trace-ids --trace-ascii output $URL +See-also: trace verbose +Multi: boolean +Scope: global +--- +Prepends the transfer and connection identifiers to each trace or verbose line that curl displays. diff --git a/docs/cmdline-opts/trace-time.d b/docs/cmdline-opts/trace-time.d index e76988544..f40ee02d7 100644 --- a/docs/cmdline-opts/trace-time.d +++ b/docs/cmdline-opts/trace-time.d @@ -1,4 +1,4 @@ -c: Copyright (C) 1998 - 2022, Daniel Stenberg, <daniel@haxx.se>, et al. +c: Copyright (C) Daniel Stenberg, <daniel@haxx.se>, et al. SPDX-License-Identifier: curl Long: trace-time Help: Add time stamps to trace/verbose output @@ -7,8 +7,6 @@ Category: verbose Example: --trace-time --trace-ascii output $URL See-also: trace verbose Multi: boolean +Scope: global --- Prepends a time stamp to each trace or verbose line that curl displays. - -This option is global and does not need to be specified for each use of ---next. diff --git a/docs/cmdline-opts/trace.d b/docs/cmdline-opts/trace.d index 2f088ecb0..35b2248e9 100644 --- a/docs/cmdline-opts/trace.d +++ b/docs/cmdline-opts/trace.d @@ -1,4 +1,4 @@ -c: Copyright (C) 1998 - 2022, Daniel Stenberg, <daniel@haxx.se>, et al. +c: Copyright (C) Daniel Stenberg, <daniel@haxx.se>, et al. SPDX-License-Identifier: curl Long: trace Arg: <file> @@ -7,13 +7,15 @@ Mutexed: verbose trace-ascii Category: verbose Example: --trace log.txt $URL Added: 7.9.7 -See-also: trace-ascii trace-time +See-also: trace-ascii trace-config trace-ids trace-time Multi: single +Scope: global --- Enables a full trace dump of all incoming and outgoing data, including descriptive information, to the given output file. Use "-" as filename to have the output sent to stdout. Use "%" as filename to have the output sent to stderr. -This option is global and does not need to be specified for each use of ---next. +Note that verbose output of curl activities and network traffic might contain +sensitive data, including user names, credentials or secret data content. Be +aware and be careful when sharing trace logs with others. diff --git a/docs/cmdline-opts/unix-socket.d b/docs/cmdline-opts/unix-socket.d index 7d95a71df..5ea56ebf1 100644 --- a/docs/cmdline-opts/unix-socket.d +++ b/docs/cmdline-opts/unix-socket.d @@ -1,4 +1,4 @@ -c: Copyright (C) 1998 - 2022, Daniel Stenberg, <daniel@haxx.se>, et al. +c: Copyright (C) Daniel Stenberg, <daniel@haxx.se>, et al. SPDX-License-Identifier: curl Long: unix-socket Arg: <path> diff --git a/docs/cmdline-opts/upload-file.d b/docs/cmdline-opts/upload-file.d index 3709896f6..8e0091d18 100644 --- a/docs/cmdline-opts/upload-file.d +++ b/docs/cmdline-opts/upload-file.d @@ -1,4 +1,4 @@ -c: Copyright (C) 1998 - 2022, Daniel Stenberg, <daniel@haxx.se>, et al. +c: Copyright (C) Daniel Stenberg, <daniel@haxx.se>, et al. SPDX-License-Identifier: curl Long: upload-file Short: T @@ -9,21 +9,28 @@ Example: -T file $URL Example: -T "img[1-1000].png" ftp://ftp.example.com/ Example: --upload-file "{file1,file2}" $URL Added: 4.0 -See-also: get head +See-also: get head request data Multi: append --- -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 -must use a trailing / on the last directory to really prove to Curl that there -is no file name or curl will think that your last directory name is the remote -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. +This transfers the specified local file to the remote URL. + +If there is no file part in the specified URL, curl appends the local file +name to the end of the URL before the operation starts. You must use a +trailing slash (/) on the last directory to prove to curl that there is no +file name or curl thinks that your last directory name is the remote file name +to use. + +When putting the local file name at the end of the URL, curl ignores what is +on the left side of any slash (/) or backslash (\\) used in the file name and +only appends what is on the right side of the rightmost such character. 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. +If this option is used with a HTTP(S) URL, the PUT method is used. + 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 @@ -32,5 +39,5 @@ 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 -formatted correctly by the user as curl will not transcode nor encode it +formatted correctly by the user as curl does not transcode nor encode it further in any way. diff --git a/docs/cmdline-opts/url-query.d b/docs/cmdline-opts/url-query.d new file mode 100644 index 000000000..29b31e338 --- /dev/null +++ b/docs/cmdline-opts/url-query.d @@ -0,0 +1,25 @@ +c: Copyright (C) Daniel Stenberg, <daniel@haxx.se>, et al. +SPDX-License-Identifier: curl +Long: url-query +Arg: <data> +Help: Add a URL query part +Protocols: all +See-also: data-urlencode get +Added: 7.87.0 +Category: http post upload +Example: --url-query name=val $URL +Example: --url-query =encodethis http://example.net/foo +Example: --url-query name@file $URL +Example: --url-query @fileonly $URL +Example: --url-query "+name=%20foo" $URL +Multi: append +--- +This option adds a piece of data, usually a name + value pair, to the end of +the URL query part. The syntax is identical to that used for --data-urlencode +with one extension: + +If the argument starts with a '+' (plus), the rest of the string is provided +as-is unencoded. + +The query part of a URL is the one following the question mark on the right +end. diff --git a/docs/cmdline-opts/url.d b/docs/cmdline-opts/url.d index 5ec61b1df..fa0421e08 100644 --- a/docs/cmdline-opts/url.d +++ b/docs/cmdline-opts/url.d @@ -1,4 +1,4 @@ -c: Copyright (C) 1998 - 2022, Daniel Stenberg, <daniel@haxx.se>, et al. +c: Copyright (C) Daniel Stenberg, <daniel@haxx.se>, et al. SPDX-License-Identifier: curl Long: url Arg: <url> @@ -13,10 +13,11 @@ Specify a URL to fetch. This option is mostly handy when you want to specify URL(s) in a config file. If the given URL is missing a scheme name (such as "http://" or "ftp://" etc) -then curl will make a guess based on the host. If the outermost sub-domain -name matches DICT, FTP, IMAP, LDAP, POP3 or SMTP then that protocol will be -used, otherwise HTTP will be used. Since 7.45.0 guessing can be disabled by -setting a default protocol, see --proto-default for details. +then curl makes a guess based on the host. If the outermost subdomain name +matches DICT, FTP, IMAP, LDAP, POP3 or SMTP then that protocol is used, +otherwise HTTP is used. Guessing can be avoided by providing a full URL +including the scheme, or disabled by setting a default protocol (added in +7.45.0), see --proto-default for details. To control where this URL is written, use the --output or the --remote-name options. diff --git a/docs/cmdline-opts/use-ascii.d b/docs/cmdline-opts/use-ascii.d index 569c7c6da..772992c17 100644 --- a/docs/cmdline-opts/use-ascii.d +++ b/docs/cmdline-opts/use-ascii.d @@ -1,4 +1,4 @@ -c: Copyright (C) 1998 - 2022, Daniel Stenberg, <daniel@haxx.se>, et al. +c: Copyright (C) Daniel Stenberg, <daniel@haxx.se>, et al. SPDX-License-Identifier: curl Short: B Long: use-ascii diff --git a/docs/cmdline-opts/user-agent.d b/docs/cmdline-opts/user-agent.d index 3f2b65d1a..1681b7e8b 100644 --- a/docs/cmdline-opts/user-agent.d +++ b/docs/cmdline-opts/user-agent.d @@ -1,4 +1,4 @@ -c: Copyright (C) 1998 - 2022, Daniel Stenberg, <daniel@haxx.se>, et al. +c: Copyright (C) Daniel Stenberg, <daniel@haxx.se>, et al. SPDX-License-Identifier: curl Short: A Long: user-agent @@ -15,6 +15,6 @@ 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 +If you give an empty argument to --user-agent (""), it removes the header completely from the request. If you prefer a blank header, you can set it to a single space (" "). diff --git a/docs/cmdline-opts/user.d b/docs/cmdline-opts/user.d index 930df83cc..f776ab7ae 100644 --- a/docs/cmdline-opts/user.d +++ b/docs/cmdline-opts/user.d @@ -1,4 +1,4 @@ -c: Copyright (C) 1998 - 2022, Daniel Stenberg, <daniel@haxx.se>, et al. +c: Copyright (C) Daniel Stenberg, <daniel@haxx.se>, et al. SPDX-License-Identifier: curl Long: user Short: u @@ -13,17 +13,17 @@ Multi: single Specify the user name and password to use for server authentication. Overrides --netrc and --netrc-optional. -If you simply specify the user name, curl will prompt for a password. +If you simply specify the user name, curl prompts for a password. The user name and passwords are split up on the first colon, which makes it impossible to use a colon in the user name with this option. The password can, still. -On systems where it works, curl will hide the given option argument from -process listings. This is not enough to protect credentials from possibly -getting seen by other users on the same system as they will still be visible -for a moment before cleared. Such sensitive data should be retrieved from a -file instead or similar and never used in clear text in a command line. +On systems where it works, curl hides the given option argument from process +listings. This is not enough to protect credentials from possibly getting seen +by other users on the same system as they still are visible for a brief moment +before cleared. Such sensitive data should be retrieved from a file instead or +similar and never used in clear text in a command line. When using Kerberos V5 with a Windows based server you should include the Windows domain name in the user name, in order for the server to successfully diff --git a/docs/cmdline-opts/variable.d b/docs/cmdline-opts/variable.d new file mode 100644 index 000000000..d7d773eda --- /dev/null +++ b/docs/cmdline-opts/variable.d @@ -0,0 +1,55 @@ +c: Copyright (C) Daniel Stenberg, <daniel@haxx.se>, et al. +SPDX-License-Identifier: curl +Long: variable +Arg: <[%]name=text/@file> +Help: Set variable +Category: curl +Example: --variable name=smith $URL +Added: 8.3.0 +See-also: config +Multi: append +--- +Set a variable with "name=content" or "name@file" (where "file" can be stdin +if set to a single dash (-)). The name is a case sensitive identifier that +must consist of no other letters than a-z, A-Z, 0-9 or underscore. The +specified content is then associated with this identifier. + +Setting the same variable name again overwrites the old contents with the new. + +The contents of a variable can be referenced in a later command line option +when that option name is prefixed with "--expand-", and the name is used as +"{{name}}" (without the quotes). + +--variable can import environment variables into the name space. Opt to either +require the environment variable to be set or provide a default value for the +variable in case it is not already set. + +--variable %name imports the variable called 'name' but exits with an error if +that environment variable is not already set. To provide a default value if +the environment variable is not set, use --variable %name=content or +--variable %name@content. Note that on some systems - but not all - +environment variables are case insensitive. + +When expanding variables, curl supports a set of functions that can make the +variable contents more convenient to use. You apply a function to a variable +expansion by adding a colon and then list the desired functions in a +comma-separated list that is evaluated in a left-to-right order. Variable +content holding null bytes that are not encoded when expanded, causes an +error. + +Available functions: +.RS +.TP 15 +**trim** +removes all leading and trailing white space. +.TP +**json** +outputs the content using JSON string quoting rules. +.TP +**url** +shows the content URL (percent) encoded. +.TP +**b64** +expands the variable base64 encoded +.RE +.IP diff --git a/docs/cmdline-opts/verbose.d b/docs/cmdline-opts/verbose.d index 7122f7d24..c5661f86a 100644 --- a/docs/cmdline-opts/verbose.d +++ b/docs/cmdline-opts/verbose.d @@ -1,14 +1,15 @@ -c: Copyright (C) 1998 - 2022, Daniel Stenberg, <daniel@haxx.se>, et al. +c: Copyright (C) Daniel Stenberg, <daniel@haxx.se>, et al. SPDX-License-Identifier: curl Short: v Long: verbose Mutexed: trace trace-ascii Help: Make the operation more talkative -See-also: include +See-also: include silent trace trace-ascii Category: important verbose Example: --verbose $URL Added: 4.0 Multi: boolean +Scope: global --- 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" @@ -16,13 +17,12 @@ 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, --include might be the option -you are looking for. +If you only want HTTP headers in the output, --include or --dump-header might +be more suitable options. If you think this option still does not give you enough details, consider using --trace or --trace-ascii instead. -This option is global and does not need to be specified for each use of ---next. - -Use --silent to make curl really quiet. +Note that verbose output of curl activities and network traffic might contain +sensitive data, including user names, credentials or secret data content. Be +aware and be careful when sharing trace logs with others. diff --git a/docs/cmdline-opts/version.d b/docs/cmdline-opts/version.d index 032e2e2db..8d231ce0c 100644 --- a/docs/cmdline-opts/version.d +++ b/docs/cmdline-opts/version.d @@ -1,4 +1,4 @@ -c: Copyright (C) 1998 - 2022, Daniel Stenberg, <daniel@haxx.se>, et al. +c: Copyright (C) Daniel Stenberg, <daniel@haxx.se>, et al. SPDX-License-Identifier: curl Long: version Short: V @@ -7,17 +7,19 @@ Category: important curl Example: --version Added: 4.0 See-also: help manual -Multi: boolean +Multi: custom --- Displays 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. -The second line (starts with "Protocols:") shows all protocols that libcurl +The second line (starts with "Release-Date:") shows the release date. + +The third line (starts with "Protocols:") shows all protocols that libcurl reports to support. -The third line (starts with "Features:") shows specific features libcurl +The fourth line (starts with "Features:") shows specific features libcurl reports to offer. Available features include: .RS .IP "alt-svc" @@ -83,3 +85,4 @@ Unix sockets support is provided. .IP "zstd" Automatic decompression (via zstd) of compressed files over HTTP is supported. .RE +.IP diff --git a/docs/cmdline-opts/write-out.d b/docs/cmdline-opts/write-out.d index 8ca1746d0..e069afcf1 100644 --- a/docs/cmdline-opts/write-out.d +++ b/docs/cmdline-opts/write-out.d @@ -1,11 +1,11 @@ -c: Copyright (C) 1998 - 2022, Daniel Stenberg, <daniel@haxx.se>, et al. +c: Copyright (C) Daniel Stenberg, <daniel@haxx.se>, et al. SPDX-License-Identifier: curl Long: write-out Short: w Arg: <format> Help: Use output FORMAT after completion Category: verbose -Example: -w '%{http_code}\\n' $URL +Example: -w '%{response_code}\\n' $URL Added: 6.5 See-also: verbose head Multi: single @@ -16,193 +16,276 @@ variables. The format can be specified as a literal "string", or you can have curl read the format from a file with "@filename" and to tell curl to read the format from stdin you write "@-". -The variables present in the output format will be substituted by the value or +The variables present in the output format are substituted by the value or text that curl thinks fit, as described below. All variables are specified as %{variable_name} and to output a normal % you just write them as %%. You can output a newline by using \\n, a carriage return with \\r and a tab space with \\t. -The output will be written to standard output, but this can be switched to -standard error by using %{stderr}. +The output is by default written to standard output, but can be changed with +%{stderr} and %output{}. -Output HTTP headers from the most recent request by using \fB%header{name}\fP -where \fBname\fP is the case insensitive name of the header (without the -trailing colon). The header contents are exactly as sent over the network, -with leading and trailing whitespace trimmed. Added in curl 7.84.0. +Output HTTP headers from the most recent request by using *%header{name}* +where *name* is the case insensitive name of the header (without the trailing +colon). The header contents are exactly as sent over the network, with leading +and trailing whitespace trimmed (added in 7.84.0). -.B NOTE: -The %-symbol is a special symbol in the win32-environment, where all -occurrences of % must be doubled when using this option. +Select a specific target destination file to write the output to, by using +*%output{name}* (added in curl 8.3.0) where *name* is the full file name. The +output following that instruction is then written to that file. More than one +*%output{}* instruction can be specified in the same write-out argument. If +the file name cannot be created, curl leaves the output destination to the one +used prior to the *%output{}* instruction. Use *%output{>>name}* to append +data to an existing file. + +**NOTE:** +In Windows the %-symbol is a special symbol used to expand environment +variables. In batch files all occurrences of % must be doubled when using this +option to properly escape. If this option is used at the command prompt then +the % cannot be escaped and unintended expansion is possible. The variables available are: .RS .TP 15 -.B content_type +**certs** +Output the certificate chain with details. Supported only by the OpenSSL, +GnuTLS, Schannel and Secure Transport backends. (Added in 7.88.0) +.TP +**content_type** The Content-Type of the requested document, if there was any. .TP -.B errormsg +**errormsg** The error message. (Added in 7.75.0) .TP -.B exitcode -The numerical exitcode of the transfer. (Added in 7.75.0) +**exitcode** +The numerical exit code of the transfer. (Added in 7.75.0) .TP -.B filename_effective +**filename_effective** The ultimate filename that curl writes out to. This is only meaningful if curl is told to write to a file with the --remote-name or --output option. It's most useful in combination with the --remote-header-name option. (Added in 7.26.0) .TP -.B ftp_entry_path +**ftp_entry_path** The initial path curl ended up in when logging on to the remote FTP server. (Added in 7.15.4) .TP -.B header_json +**header_json** A JSON object with all HTTP response headers from the recent transfer. Values are provided as arrays, since in the case of multiple headers there can be -multiple values. +multiple values. (Added in 7.83.0) The header names provided in lowercase, listed in order of appearance over the wire. Except for duplicated headers. They are grouped on the first occurrence of that header, each value is presented in the JSON array. .TP -.B http_code +**http_code** The numerical response code that was found in the last retrieved HTTP(S) or FTP(s) transfer. .TP -.B http_connect +**http_connect** The numerical code that was found in the last response (from a proxy) to a curl CONNECT request. (Added in 7.12.4) .TP -.B http_version +**http_version** The http version that was effectively used. (Added in 7.50.0) .TP -.B json -A JSON object with all available keys. +**json** +A JSON object with all available keys. (Added in 7.70.0) .TP -.B local_ip +**local_ip** The IP address of the local end of the most recently done connection - can be either IPv4 or IPv6. (Added in 7.29.0) .TP -.B local_port +**local_port** The local port number of the most recently done connection. (Added in 7.29.0) .TP -.B method +**method** The http method used in the most recent HTTP request. (Added in 7.72.0) .TP -.B num_connects +**num_certs** +Number of server certificates received in the TLS handshake. Supported only by +the OpenSSL, GnuTLS, Schannel and Secure Transport backends. +(Added in 7.88.0) +.TP +**num_connects** Number of new connects made in the recent transfer. (Added in 7.12.3) .TP -.B num_headers +**num_headers** The number of response headers in the most recent request (restarted at each redirect). Note that the status line IS NOT a header. (Added in 7.73.0) .TP -.B num_redirects +**num_redirects** Number of redirects that were followed in the request. (Added in 7.12.3) .TP -.B onerror -The rest of the output is only shown if the transfer returned a non-zero error +**onerror** +The rest of the output is only shown if the transfer returned a non-zero error. (Added in 7.75.0) .TP -.B proxy_ssl_verify_result +**proxy_ssl_verify_result** The result of the HTTPS proxy's SSL peer certificate verification that was requested. 0 means the verification was successful. (Added in 7.52.0) .TP -.B redirect_url +**redirect_url** When an HTTP request was made without --location to follow redirects (or when ---max-redirs is met), this variable will show the actual URL a redirect +--max-redirs is met), this variable shows the actual URL a redirect *would* have gone to. (Added in 7.18.2) .TP -.B referer +**referer** The Referer: header, if there was any. (Added in 7.76.0) .TP -.B remote_ip +**remote_ip** The remote IP address of the most recently done connection - can be either IPv4 or IPv6. (Added in 7.29.0) .TP -.B remote_port +**remote_port** The remote port number of the most recently done connection. (Added in 7.29.0) .TP -.B response_code +**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 +**scheme** The URL scheme (sometimes called protocol) that was effectively used. (Added in 7.52.0) .TP -.B size_download +**size_download** The total amount of bytes that were downloaded. This is the size of the body/data that was transferred, excluding headers. .TP -.B size_header +**size_header** The total amount of bytes of the downloaded headers. .TP -.B size_request +**size_request** The total amount of bytes that were sent in the HTTP request. .TP -.B size_upload +**size_upload** The total amount of bytes that were uploaded. This is the size of the body/data that was transferred, excluding headers. .TP -.B speed_download +**speed_download** The average download speed that curl measured for the complete download. Bytes per second. .TP -.B speed_upload +**speed_upload** The average upload speed that curl measured for the complete upload. Bytes per second. .TP -.B ssl_verify_result +**ssl_verify_result** The result of the SSL peer certificate verification that was requested. 0 means the verification was successful. (Added in 7.19.0) .TP -.B stderr -From this point on, the --write-out output will be written to standard +**stderr** +From this point on, the --write-out output is written to standard error. (Added in 7.63.0) .TP -.B stdout -From this point on, the --write-out output will be written to standard output. +**stdout** +From this point on, the --write-out output is written to standard output. This is the default, but can be used to switch back after switching to stderr. (Added in 7.63.0) .TP -.B time_appconnect +**time_appconnect** The time, in seconds, it took from the start until the SSL/SSH/etc connect/handshake to the remote host was completed. (Added in 7.19.0) .TP -.B time_connect +**time_connect** The time, in seconds, it took from the start until the TCP connect to the remote host (or proxy) was completed. .TP -.B time_namelookup +**time_namelookup** The time, in seconds, it took from the start until the name resolving was completed. .TP -.B time_pretransfer +**time_pretransfer** The time, in seconds, it took from the start until the file transfer was just about to begin. This includes all pre-transfer commands and negotiations that are specific to the particular protocol(s) involved. .TP -.B time_redirect +**time_redirect** The time, in seconds, it took for all redirection steps including name lookup, connect, pretransfer and transfer before the final transaction was started. time_redirect shows the complete execution time for multiple redirections. (Added in 7.12.3) .TP -.B time_starttransfer -The time, in seconds, it took from the start until the first byte was just -about to be transferred. This includes time_pretransfer and also the time the -server needed to calculate the result. +**time_starttransfer** +The time, in seconds, it took from the start until the first byte is received. +This includes time_pretransfer and also the time the server needed to calculate +the result. .TP -.B time_total +**time_total** The total time, in seconds, that the full operation lasted. .TP -.B url +**url** The URL that was fetched. (Added in 7.75.0) .TP -.B urlnum -The URL index number of this transfer, 0-indexed. De-globbed URLs share the +**url.scheme** +The scheme part of the URL that was fetched. (Added in 8.1.0) +.TP +**url.user** +The user part of the URL that was fetched. (Added in 8.1.0) +.TP +**url.password** +The password part of the URL that was fetched. (Added in 8.1.0) +.TP +**url.options** +The options part of the URL that was fetched. (Added in 8.1.0) +.TP +**url.host** +The host part of the URL that was fetched. (Added in 8.1.0) +.TP +**url.port** +The port number of the URL that was fetched. If no port number was specified, +but the URL scheme is known, that scheme's default port number is +shown. (Added in 8.1.0) +.TP +**url.path** +The path part of the URL that was fetched. (Added in 8.1.0) +.TP +**url.query** +The query part of the URL that was fetched. (Added in 8.1.0) +.TP +**url.fragment** +The fragment part of the URL that was fetched. (Added in 8.1.0) +.TP +**url.zoneid** +The zone id part of the URL that was fetched. (Added in 8.1.0) +.TP +**urle.scheme** +The scheme part of the effective (last) URL that was fetched. (Added in 8.1.0) +.TP +**urle.user** +The user part of the effective (last) URL that was fetched. (Added in 8.1.0) +.TP +**urle.password** +The password part of the effective (last) URL that was fetched. (Added in 8.1.0) +.TP +**urle.options** +The options part of the effective (last) URL that was fetched. (Added in 8.1.0) +.TP +**urle.host** +The host part of the effective (last) URL that was fetched. (Added in 8.1.0) +.TP +**urle.port** +The port number of the effective (last) URL that was fetched. If no port +number was specified, but the URL scheme is known, that scheme's default port +number is shown. (Added in 8.1.0) +.TP +**urle.path** +The path part of the effective (last) URL that was fetched. (Added in 8.1.0) +.TP +**urle.query** +The query part of the effective (last) URL that was fetched. (Added in 8.1.0) +.TP +**urle.fragment** +The fragment part of the effective (last) URL that was fetched. (Added in 8.1.0) +.TP +**urle.zoneid** +The zone id part of the effective (last) URL that was fetched. (Added in 8.1.0) +.TP +**urlnum** +The URL index number of this transfer, 0-indexed. Unglobbed URLs share the same index number as the origin globbed URL. (Added in 7.75.0) .TP -.B url_effective +**url_effective** The URL that was fetched last. This is most meaningful if you have told curl to follow location: headers. .RE diff --git a/docs/cmdline-opts/xattr.d b/docs/cmdline-opts/xattr.d index 9f1a6cf8a..31bdb2d72 100644 --- a/docs/cmdline-opts/xattr.d +++ b/docs/cmdline-opts/xattr.d @@ -1,4 +1,4 @@ -c: Copyright (C) 1998 - 2022, Daniel Stenberg, <daniel@haxx.se>, et al. +c: Copyright (C) Daniel Stenberg, <daniel@haxx.se>, et al. SPDX-License-Identifier: curl Long: xattr Help: Store metadata in extended file attributes |