From 5c4a526388e5d45f332d241b03114eaff98c53ce Mon Sep 17 00:00:00 2001 From: Daniel Stenberg Date: Mon, 28 Nov 2016 00:50:25 +0100 Subject: cmdline-opts: more command line options documented Moved over to the new format --- docs/cmdline-opts/disable.d | 7 ++++ docs/cmdline-opts/proxy-anyauth.d | 7 ++++ docs/cmdline-opts/proxy-basic.d | 7 ++++ docs/cmdline-opts/proxy-cacert.d | 7 ++++ docs/cmdline-opts/proxy-capath.d | 7 ++++ docs/cmdline-opts/proxy-cert.d | 6 ++++ docs/cmdline-opts/proxy-ciphers.d | 6 ++++ docs/cmdline-opts/proxy-crlfile.d | 6 ++++ docs/cmdline-opts/proxy-digest.d | 6 ++++ docs/cmdline-opts/proxy-insecure.d | 5 +++ docs/cmdline-opts/proxy-key-type.d | 6 ++++ docs/cmdline-opts/proxy-key.d | 5 +++ docs/cmdline-opts/proxy-negotiate.d | 8 +++++ docs/cmdline-opts/proxy-ntlm.d | 6 ++++ docs/cmdline-opts/proxy-pass.d | 6 ++++ docs/cmdline-opts/proxy-service-name.d | 6 ++++ docs/cmdline-opts/proxy-ssl-allow-beast.d | 5 +++ docs/cmdline-opts/proxy-tlsauthtype.d | 6 ++++ docs/cmdline-opts/proxy-tlspassword.d | 6 ++++ docs/cmdline-opts/proxy-tlsuser.d | 6 ++++ docs/cmdline-opts/proxy-tlsv1.d | 5 +++ docs/cmdline-opts/proxy1.0.d | 10 ++++++ docs/cmdline-opts/pubkey.d | 14 ++++++++ docs/cmdline-opts/quote.d | 55 +++++++++++++++++++++++++++++++ docs/cmdline-opts/random-file.d | 7 ++++ docs/cmdline-opts/range.d | 46 ++++++++++++++++++++++++++ docs/cmdline-opts/raw.d | 7 ++++ docs/cmdline-opts/remote-name-all.d | 8 +++++ docs/cmdline-opts/remote-time.d | 7 ++++ docs/cmdline-opts/resolve.d | 17 ++++++++++ docs/cmdline-opts/retry-connrefused.d | 6 ++++ docs/cmdline-opts/retry-delay.d | 11 +++++++ docs/cmdline-opts/retry-max-time.d | 13 ++++++++ docs/cmdline-opts/retry.d | 17 ++++++++++ docs/cmdline-opts/sasl-ir.d | 5 +++ docs/cmdline-opts/service-name.d | 8 +++++ docs/cmdline-opts/show-error.d | 5 +++ docs/cmdline-opts/silent.d | 8 +++++ docs/cmdline-opts/socks4.d | 15 +++++++++ docs/cmdline-opts/socks4a.d | 15 +++++++++ docs/cmdline-opts/socks5-hostname.d | 15 +++++++++ docs/cmdline-opts/socks5.d | 17 ++++++++++ docs/cmdline-opts/ssl-allow-beast.d | 9 +++++ docs/cmdline-opts/ssl-no-revoke.d | 7 ++++ docs/cmdline-opts/ssl-reqd.d | 9 +++++ docs/cmdline-opts/ssl.d | 12 +++++++ 46 files changed, 472 insertions(+) create mode 100644 docs/cmdline-opts/disable.d create mode 100644 docs/cmdline-opts/proxy-anyauth.d create mode 100644 docs/cmdline-opts/proxy-basic.d create mode 100644 docs/cmdline-opts/proxy-cacert.d create mode 100644 docs/cmdline-opts/proxy-capath.d create mode 100644 docs/cmdline-opts/proxy-cert.d create mode 100644 docs/cmdline-opts/proxy-ciphers.d create mode 100644 docs/cmdline-opts/proxy-crlfile.d create mode 100644 docs/cmdline-opts/proxy-digest.d create mode 100644 docs/cmdline-opts/proxy-insecure.d create mode 100644 docs/cmdline-opts/proxy-key-type.d create mode 100644 docs/cmdline-opts/proxy-key.d create mode 100644 docs/cmdline-opts/proxy-negotiate.d create mode 100644 docs/cmdline-opts/proxy-ntlm.d create mode 100644 docs/cmdline-opts/proxy-pass.d create mode 100644 docs/cmdline-opts/proxy-service-name.d create mode 100644 docs/cmdline-opts/proxy-ssl-allow-beast.d create mode 100644 docs/cmdline-opts/proxy-tlsauthtype.d create mode 100644 docs/cmdline-opts/proxy-tlspassword.d create mode 100644 docs/cmdline-opts/proxy-tlsuser.d create mode 100644 docs/cmdline-opts/proxy-tlsv1.d create mode 100644 docs/cmdline-opts/proxy1.0.d create mode 100644 docs/cmdline-opts/pubkey.d create mode 100644 docs/cmdline-opts/quote.d create mode 100644 docs/cmdline-opts/random-file.d create mode 100644 docs/cmdline-opts/range.d create mode 100644 docs/cmdline-opts/raw.d create mode 100644 docs/cmdline-opts/remote-name-all.d create mode 100644 docs/cmdline-opts/remote-time.d create mode 100644 docs/cmdline-opts/resolve.d create mode 100644 docs/cmdline-opts/retry-connrefused.d create mode 100644 docs/cmdline-opts/retry-delay.d create mode 100644 docs/cmdline-opts/retry-max-time.d create mode 100644 docs/cmdline-opts/retry.d create mode 100644 docs/cmdline-opts/sasl-ir.d create mode 100644 docs/cmdline-opts/service-name.d create mode 100644 docs/cmdline-opts/show-error.d create mode 100644 docs/cmdline-opts/silent.d create mode 100644 docs/cmdline-opts/socks4.d create mode 100644 docs/cmdline-opts/socks4a.d create mode 100644 docs/cmdline-opts/socks5-hostname.d create mode 100644 docs/cmdline-opts/socks5.d create mode 100644 docs/cmdline-opts/ssl-allow-beast.d create mode 100644 docs/cmdline-opts/ssl-no-revoke.d create mode 100644 docs/cmdline-opts/ssl-reqd.d create mode 100644 docs/cmdline-opts/ssl.d (limited to 'docs/cmdline-opts') diff --git a/docs/cmdline-opts/disable.d b/docs/cmdline-opts/disable.d new file mode 100644 index 000000000..20b27b4c5 --- /dev/null +++ b/docs/cmdline-opts/disable.d @@ -0,0 +1,7 @@ +Long: disable +Short: q +Help: Disable .curlrc +--- +If used as the first parameter on the command line, the \fIcurlrc\fP config +file will not be read and used. See the --config for details on the default +config file search path. diff --git a/docs/cmdline-opts/proxy-anyauth.d b/docs/cmdline-opts/proxy-anyauth.d new file mode 100644 index 000000000..b60d0a05e --- /dev/null +++ b/docs/cmdline-opts/proxy-anyauth.d @@ -0,0 +1,7 @@ +Long: proxy-anyauth +Help: Pick any proxy authentication method +Added: 7.13.2 +See-also: proxy proxy-basic proxy-digest +--- +Tells curl to pick a suitable authentication method when communicating with +the given HTTP proxy. This might cause an extra request/response round-trip. diff --git a/docs/cmdline-opts/proxy-basic.d b/docs/cmdline-opts/proxy-basic.d new file mode 100644 index 000000000..566f890a9 --- /dev/null +++ b/docs/cmdline-opts/proxy-basic.d @@ -0,0 +1,7 @@ +Long: proxy-basic +Help: Use Basic authentication on the proxy +See-also: proxy proxy-anyauth proxy-digest +--- +Tells curl to use HTTP Basic authentication when communicating with the given +proxy. Use --basic for enabling HTTP Basic with a remote host. Basic is the +default authentication method curl uses with proxies. diff --git a/docs/cmdline-opts/proxy-cacert.d b/docs/cmdline-opts/proxy-cacert.d new file mode 100644 index 000000000..2713dd2a4 --- /dev/null +++ b/docs/cmdline-opts/proxy-cacert.d @@ -0,0 +1,7 @@ +Long: proxy-cacert +Help: CA certificate to verify peer against for proxy +Arg: +Added: 7.52.0 +See-also: proxy-capath cacert capath proxy +--- +Same as --cacert but used in HTTPS proxy context. diff --git a/docs/cmdline-opts/proxy-capath.d b/docs/cmdline-opts/proxy-capath.d new file mode 100644 index 000000000..177246aab --- /dev/null +++ b/docs/cmdline-opts/proxy-capath.d @@ -0,0 +1,7 @@ +Long: proxy-capath +Help: CA directory to verify peer against for proxy +Arg: +Added: 7.52.0 +See-also: proxy-cacert proxy capath +--- +Same as --capath but used in HTTPS proxy context. diff --git a/docs/cmdline-opts/proxy-cert.d b/docs/cmdline-opts/proxy-cert.d new file mode 100644 index 000000000..495296b14 --- /dev/null +++ b/docs/cmdline-opts/proxy-cert.d @@ -0,0 +1,6 @@ +Long: proxy-cert +Arg: +Help: Client certificate file and password for proxy +Added: 7.52.0 +--- +Same as --cert but used in HTTPS proxy context. diff --git a/docs/cmdline-opts/proxy-ciphers.d b/docs/cmdline-opts/proxy-ciphers.d new file mode 100644 index 000000000..dcac81284 --- /dev/null +++ b/docs/cmdline-opts/proxy-ciphers.d @@ -0,0 +1,6 @@ +Long: proxy-ciphers +Arg: +Help: SSL ciphers to use for proxy +Added: 7.52.0 +--- +Same as --ciphers but used in HTTPS proxy context. diff --git a/docs/cmdline-opts/proxy-crlfile.d b/docs/cmdline-opts/proxy-crlfile.d new file mode 100644 index 000000000..1d6247f47 --- /dev/null +++ b/docs/cmdline-opts/proxy-crlfile.d @@ -0,0 +1,6 @@ +Long: proxy-crlfile +Arg: +Help: Set a CRL list for proxy +Added: 7.52.0 +--- +Same as --crlfile but used in HTTPS proxy context. diff --git a/docs/cmdline-opts/proxy-digest.d b/docs/cmdline-opts/proxy-digest.d new file mode 100644 index 000000000..ccf46636c --- /dev/null +++ b/docs/cmdline-opts/proxy-digest.d @@ -0,0 +1,6 @@ +Long: proxy-digest +Help: Use Digest authentication on the proxy +See-also: proxy proxy-anyauth proxy-basic +--- +Tells curl to use HTTP Digest authentication when communicating with the given +proxy. Use --digest for enabling HTTP Digest with a remote host. diff --git a/docs/cmdline-opts/proxy-insecure.d b/docs/cmdline-opts/proxy-insecure.d new file mode 100644 index 000000000..762828f43 --- /dev/null +++ b/docs/cmdline-opts/proxy-insecure.d @@ -0,0 +1,5 @@ +Long: proxy-insecure +Help: Do HTTPS proxy connections without verifying the proxy +Added: 7.52.0 +--- +Same as --insecure but used in HTTPS proxy context. diff --git a/docs/cmdline-opts/proxy-key-type.d b/docs/cmdline-opts/proxy-key-type.d new file mode 100644 index 000000000..ce7482ae9 --- /dev/null +++ b/docs/cmdline-opts/proxy-key-type.d @@ -0,0 +1,6 @@ +Long: proxy-key-type +Arg: +Help: Private key file type for proxy +Added: 7.52.0 +--- +Same as --key-type but used in HTTPS proxy context. diff --git a/docs/cmdline-opts/proxy-key.d b/docs/cmdline-opts/proxy-key.d new file mode 100644 index 000000000..e61eb18a9 --- /dev/null +++ b/docs/cmdline-opts/proxy-key.d @@ -0,0 +1,5 @@ +Long: proxy-key +Help: Private key for HTTPS proxy +Arg: +--- +Same as --key but used in HTTPS proxy context. diff --git a/docs/cmdline-opts/proxy-negotiate.d b/docs/cmdline-opts/proxy-negotiate.d new file mode 100644 index 000000000..775f62a9a --- /dev/null +++ b/docs/cmdline-opts/proxy-negotiate.d @@ -0,0 +1,8 @@ +Long: proxy-negotiate +Help: Use HTTP Negotiate (SPNEGO) authentication on the proxy +Added: 7.17.1 +See-also: proxy-anyauth proxy-basic +--- +Tells curl to use HTTP Negotiate (SPNEGO) authentication when communicating +with the given proxy. Use --negotiate for enabling HTTP Negotiate (SPNEGO) +with a remote host. diff --git a/docs/cmdline-opts/proxy-ntlm.d b/docs/cmdline-opts/proxy-ntlm.d new file mode 100644 index 000000000..c30db53b9 --- /dev/null +++ b/docs/cmdline-opts/proxy-ntlm.d @@ -0,0 +1,6 @@ +Long: proxy-ntlm +Help: Use NTLM authentication on the proxy +See-also: proxy-negotiate proxy-anyauth +--- +Tells curl to use HTTP NTLM authentication when communicating with the given +proxy. Use --ntlm for enabling NTLM with a remote host. diff --git a/docs/cmdline-opts/proxy-pass.d b/docs/cmdline-opts/proxy-pass.d new file mode 100644 index 000000000..6534b25ea --- /dev/null +++ b/docs/cmdline-opts/proxy-pass.d @@ -0,0 +1,6 @@ +Long: proxy-pass +Arg: +Help: Pass phrase for the private key for HTTPS proxy +Added: 7.52.0 +--- +Same as \fI--pass\fP but used in HTTPS proxy context. diff --git a/docs/cmdline-opts/proxy-service-name.d b/docs/cmdline-opts/proxy-service-name.d new file mode 100644 index 000000000..e774d2427 --- /dev/null +++ b/docs/cmdline-opts/proxy-service-name.d @@ -0,0 +1,6 @@ +long: proxy-service-name +Arg: +Help: SPNEGO proxy service name +Added: 7.43.0 +--- +This option allows you to change the service name for proxy negotiation. diff --git a/docs/cmdline-opts/proxy-ssl-allow-beast.d b/docs/cmdline-opts/proxy-ssl-allow-beast.d new file mode 100644 index 000000000..6b25892f5 --- /dev/null +++ b/docs/cmdline-opts/proxy-ssl-allow-beast.d @@ -0,0 +1,5 @@ +Long: proxy-ssl-allow-beast +Help: Allow security flaw to improve interop for HTTPS proxy +Added: 7.52.0 +--- +Same as --ssl-allow-beast but used in HTTPS proxy context. diff --git a/docs/cmdline-opts/proxy-tlsauthtype.d b/docs/cmdline-opts/proxy-tlsauthtype.d new file mode 100644 index 000000000..7d0ce8e1a --- /dev/null +++ b/docs/cmdline-opts/proxy-tlsauthtype.d @@ -0,0 +1,6 @@ +Long: proxy-tlsauthtype +Arg: +Help: TLS authentication type for HTTPS proxy +Added: 7.52.0 +--- +Same as --tlsauthtype but used in HTTPS proxy context. diff --git a/docs/cmdline-opts/proxy-tlspassword.d b/docs/cmdline-opts/proxy-tlspassword.d new file mode 100644 index 000000000..cf003844e --- /dev/null +++ b/docs/cmdline-opts/proxy-tlspassword.d @@ -0,0 +1,6 @@ +Long: proxy-tlspassword +Arg: +Help: TLS password for HTTPS proxy +Added: 7.52.0 +--- +Same as --tlspassword but used in HTTPS proxy context. diff --git a/docs/cmdline-opts/proxy-tlsuser.d b/docs/cmdline-opts/proxy-tlsuser.d new file mode 100644 index 000000000..c5de5276f --- /dev/null +++ b/docs/cmdline-opts/proxy-tlsuser.d @@ -0,0 +1,6 @@ +Long: proxy-tlsuser.d +Arg: +Help: TLS username for HTTPS proxy +Added: 7.52.0 +--- +Same as --tlsuser but used in HTTPS proxy context. diff --git a/docs/cmdline-opts/proxy-tlsv1.d b/docs/cmdline-opts/proxy-tlsv1.d new file mode 100644 index 000000000..d024eeac3 --- /dev/null +++ b/docs/cmdline-opts/proxy-tlsv1.d @@ -0,0 +1,5 @@ +Long: proxy-tlsv1 +Help: Use TLSv1 for HTTPS proxy +Added: 7.52.0 +--- +Same as --tlsv1 but used in HTTPS proxy context. diff --git a/docs/cmdline-opts/proxy1.0.d b/docs/cmdline-opts/proxy1.0.d new file mode 100644 index 000000000..4a931bd15 --- /dev/null +++ b/docs/cmdline-opts/proxy1.0.d @@ -0,0 +1,10 @@ +Long: proxy1.0 +Arg: +Help: Use HTTP/1.0 proxy on given port +--- +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 +instead of the default HTTP 1.1. diff --git a/docs/cmdline-opts/pubkey.d b/docs/cmdline-opts/pubkey.d new file mode 100644 index 000000000..b2e11c024 --- /dev/null +++ b/docs/cmdline-opts/pubkey.d @@ -0,0 +1,14 @@ +Long: pubkey +Arg: +Protocols: SFTP SCP +Help: SSH Public key file name +--- +Public key file name. Allows you to provide your public key in this separate +file. + +If this option is used several times, the last one will be used. + +(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.) diff --git a/docs/cmdline-opts/quote.d b/docs/cmdline-opts/quote.d new file mode 100644 index 000000000..621c571a3 --- /dev/null +++ b/docs/cmdline-opts/quote.d @@ -0,0 +1,55 @@ +Long: quote +Help: Send command(s) to server before transfer +Protocols: FTP SFTP +--- + +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 '-'. To make commands be sent after curl +has changed the working directory, just before the transfer command(s), prefix +the command with a '+' (this is only supported for FTP). You may specify any +number of commands. + +If the server returns failure for one of the commands, the entire operation +will be 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. When speaking to an FTP server, prefix +the command with an asterisk (*) to make curl continue even if the command +fails as by default curl will stop at first failure. + +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 "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" +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" +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" +The ln and symlink commands create a symbolic link at the target_file location +pointing to the source_file location. +.IP "mkdir directory_name" +The mkdir command creates the directory named by the directory_name operand. +.IP "pwd" +The pwd command returns the absolute pathname of the current working directory. +.IP "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" +The rm command removes the file specified by the file operand. +.IP "rmdir directory" +The rmdir command removes the directory entry specified by the directory +operand, provided it is empty. +.IP "symlink source_file target_file" +See ln. +.RE diff --git a/docs/cmdline-opts/random-file.d b/docs/cmdline-opts/random-file.d new file mode 100644 index 000000000..51626f88d --- /dev/null +++ b/docs/cmdline-opts/random-file.d @@ -0,0 +1,7 @@ +Long: random-file +Arg: +Help: File for reading random data from +--- +Specify the path name to file containing what will be considered as random +data. The data may be used to seed the random engine for SSL connections. See +also the --egd-file option. diff --git a/docs/cmdline-opts/range.d b/docs/cmdline-opts/range.d new file mode 100644 index 000000000..760d15e22 --- /dev/null +++ b/docs/cmdline-opts/range.d @@ -0,0 +1,46 @@ +Long: range +Short: r +Help: Retrieve only the bytes within RANGE +Arg: +Protocols: HTTP FTP SFTP FILE +--- +Retrieve a byte range (i.e a partial document) from a HTTP/1.1, FTP or SFTP +server or a local FILE. Ranges can be specified in a number of ways. +.RS +.TP 10 +.B 0-499 +specifies the first 500 bytes +.TP +.B 500-999 +specifies the second 500 bytes +.TP +.B -500 +specifies the last 500 bytes +.TP +.B 9500- +specifies the bytes from offset 9500 and forward +.TP +.B 0-0,-1 +specifies the first and last byte only(*)(HTTP) +.TP +.B 100-199,500-599 +specifies two separate 100-byte ranges(*) (HTTP) +.RE +.IP +(*) = NOTE that this will cause the server to reply with a multipart +response! + +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. + +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'll instead get 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 +FTP command SIZE. + +If this option is used several times, the last one will be used. diff --git a/docs/cmdline-opts/raw.d b/docs/cmdline-opts/raw.d new file mode 100644 index 000000000..c3328e69a --- /dev/null +++ b/docs/cmdline-opts/raw.d @@ -0,0 +1,7 @@ +Long: raw +Help: Do HTTP "raw"; no transfer decoding +Added: 7.16.2 +Protocols: HTTP +--- +When used, it disables all internal HTTP decoding of content or transfer +encodings and instead makes them passed on unaltered, raw. diff --git a/docs/cmdline-opts/remote-name-all.d b/docs/cmdline-opts/remote-name-all.d new file mode 100644 index 000000000..f7a199679 --- /dev/null +++ b/docs/cmdline-opts/remote-name-all.d @@ -0,0 +1,8 @@ +Long: remote-name-all +Help: Use the remote file name for all URLs +Added: 7.19.0 +--- +This option changes the default action for all given URLs to be dealt with as +if --remote-name were used for each one. So if you want to disable that for a +specific URL after --remote-name-all has been used, you must use "-o -" or +--no-remote-name. diff --git a/docs/cmdline-opts/remote-time.d b/docs/cmdline-opts/remote-time.d new file mode 100644 index 000000000..0f369e01f --- /dev/null +++ b/docs/cmdline-opts/remote-time.d @@ -0,0 +1,7 @@ +long: remote-time +short: R +Help: Set the remote file's time on the local output +--- +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 +timestamp. diff --git a/docs/cmdline-opts/resolve.d b/docs/cmdline-opts/resolve.d new file mode 100644 index 000000000..ba3967a14 --- /dev/null +++ b/docs/cmdline-opts/resolve.d @@ -0,0 +1,17 @@ +Long: resolve +Arg: +Help: Resolve the host+port to this address +Added: 7.21.3 +--- +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 +you need several entries if you want to provide address for the same host but +different ports. + +The provided address set by this option will be used even if --ipv4 or --ipv6 +is set to make curl use another IP version. + +This option can be used many times to add many host names to resolve. diff --git a/docs/cmdline-opts/retry-connrefused.d b/docs/cmdline-opts/retry-connrefused.d new file mode 100644 index 000000000..6a78e1fda --- /dev/null +++ b/docs/cmdline-opts/retry-connrefused.d @@ -0,0 +1,6 @@ +Long: retry-connrefused +Help: Retry on connection refused (use with --retry) +Added: 7.52.0 +--- +In addition to the other conditions, consider ECONNREFUSED as a transient +error too for --retry. This option is used together with --retry. diff --git a/docs/cmdline-opts/retry-delay.d b/docs/cmdline-opts/retry-delay.d new file mode 100644 index 000000000..43c5affa2 --- /dev/null +++ b/docs/cmdline-opts/retry-delay.d @@ -0,0 +1,11 @@ +long: retry-delay +arg: +Help: Wait time between retries +Added: 7.12.3 +--- +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. + +If this option is used several times, the last one will be used. diff --git a/docs/cmdline-opts/retry-max-time.d b/docs/cmdline-opts/retry-max-time.d new file mode 100644 index 000000000..1c2f972ab --- /dev/null +++ b/docs/cmdline-opts/retry-max-time.d @@ -0,0 +1,13 @@ +long: retry-max-time +Arg: +Help: Retry only within this period +Added: 7.12.3 +--- +The retry timer is reset before the first transfer attempt. Retries will be +done as usual (see --retry) as long as the timer hasn't reached this given +limit. Notice that if the timer hasn't reached the limit, the request will be +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. + +If this option is used several times, the last one will be used. diff --git a/docs/cmdline-opts/retry.d b/docs/cmdline-opts/retry.d new file mode 100644 index 000000000..35215dfd4 --- /dev/null +++ b/docs/cmdline-opts/retry.d @@ -0,0 +1,17 @@ +Long: retry +Arg: +Added: 7.12.3 +Help: Retry request if transient problems occur +--- +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 +makes curl do no retries (which is the default). Transient error means either: +a timeout, an FTP 4xx response code or an HTTP 5xx 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 +--retry-max-time to limit the total time allowed for retries. + +If this option is used several times, the last one will be used. diff --git a/docs/cmdline-opts/sasl-ir.d b/docs/cmdline-opts/sasl-ir.d new file mode 100644 index 000000000..120b19da0 --- /dev/null +++ b/docs/cmdline-opts/sasl-ir.d @@ -0,0 +1,5 @@ +long: sasl-ir +Help: Enable initial response in SASL authentication +Added: 7.31.0 +--- +Enable initial response in SASL authentication. diff --git a/docs/cmdline-opts/service-name.d b/docs/cmdline-opts/service-name.d new file mode 100644 index 000000000..4dfeb27d6 --- /dev/null +++ b/docs/cmdline-opts/service-name.d @@ -0,0 +1,8 @@ +Long: service-name +Help: SPNEGO service name +Arg: +Added: 7.43.0 +--- +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 new file mode 100644 index 000000000..fdc595681 --- /dev/null +++ b/docs/cmdline-opts/show-error.d @@ -0,0 +1,5 @@ +long: show-error +Short: S +Help: Show error. With -s, make curl show errors when they occur +--- +When used with --silent, it makes curl show an error message if it fails. diff --git a/docs/cmdline-opts/silent.d b/docs/cmdline-opts/silent.d new file mode 100644 index 000000000..321279129 --- /dev/null +++ b/docs/cmdline-opts/silent.d @@ -0,0 +1,8 @@ +long: silent +Short: s +Help: Silent mode +See-also: verbose stderr +--- +Silent or quiet mode. Don't show progress meter or error messages. Makes Curl +mute. It will still output the data you ask for, potentially even to the +terminal/stdout unless you redirect it. diff --git a/docs/cmdline-opts/socks4.d b/docs/cmdline-opts/socks4.d new file mode 100644 index 000000000..ab4536af3 --- /dev/null +++ b/docs/cmdline-opts/socks4.d @@ -0,0 +1,15 @@ +Long: socks4 +Arg: +Help: SOCKS4 proxy on given host + port +Added: 7.15.2 +--- +Use the specified SOCKS4 proxy. If the port number is not specified, it is +assumed at port 1080. + +This option overrides any previous use of --proxy, as they are mutually +exclusive. + +Since 7.21.7, this option is superfluous since you can specify a socks4 proxy +with --proxy using a socks4:// protocol prefix. + +If this option is used several times, the last one will be used. diff --git a/docs/cmdline-opts/socks4a.d b/docs/cmdline-opts/socks4a.d new file mode 100644 index 000000000..a1db1f56a --- /dev/null +++ b/docs/cmdline-opts/socks4a.d @@ -0,0 +1,15 @@ +Long: socks4a +Arg: +Help: SOCKS4a proxy on given host + port +Added: 7.18.0 +--- +Use the specified SOCKS4a proxy. If the port number is not specified, it is +assumed at port 1080. + +This option overrides any previous use of --proxy, as they are mutually +exclusive. + +Since 7.21.7, this option is superfluous since you can specify a socks4a proxy +with --proxy using a socks4a:// protocol prefix. + +If this option is used several times, the last one will be used. diff --git a/docs/cmdline-opts/socks5-hostname.d b/docs/cmdline-opts/socks5-hostname.d new file mode 100644 index 000000000..d971766af --- /dev/null +++ b/docs/cmdline-opts/socks5-hostname.d @@ -0,0 +1,15 @@ +Long: socks5-hostname +Arg: +Help: SOCKS5 proxy, pass host name to proxy +Added: 7.18.0 +--- +Use the specified SOCKS5 proxy (and let the proxy resolve the host name). If +the port number is not specified, it is assumed at port 1080. + +This option overrides any previous use of --proxy, as they are mutually +exclusive. + +Since 7.21.7, this option is superfluous since you can specify a socks5 +hostname proxy with --proxy using a socks5h:// protocol prefix. + +If this option is used several times, the last one will be used. diff --git a/docs/cmdline-opts/socks5.d b/docs/cmdline-opts/socks5.d new file mode 100644 index 000000000..34f0311ed --- /dev/null +++ b/docs/cmdline-opts/socks5.d @@ -0,0 +1,17 @@ +Long: socks5 +Arg: +Help: SOCKS5 proxy on given host + port +Added: 7.18.0 +--- +Use the specified SOCKS5 proxy - but resolve the host name locally. If the +port number is not specified, it is assumed at port 1080. + +This option overrides any previous use of --proxy, as they are mutually +exclusive. + +Since 7.21.7, this option is superfluous since you can specify a socks5 proxy +with --proxy using a socks5:// protocol prefix. + +If this option is used several times, the last one will be used. + +This option (as well as --socks4) does not work with IPV6, FTPS or LDAP. diff --git a/docs/cmdline-opts/ssl-allow-beast.d b/docs/cmdline-opts/ssl-allow-beast.d new file mode 100644 index 000000000..973fcd451 --- /dev/null +++ b/docs/cmdline-opts/ssl-allow-beast.d @@ -0,0 +1,9 @@ +Long: ssl-allow-beast +Help: Allow security flaw to improve interop +Added: 7.25.0 +--- +This option tells curl to not work around a security flaw in the SSL3 and +TLS1.0 protocols known as BEAST. If this option isn't used, the SSL layer may +use workarounds known to cause interoperability problems with some older SSL +implementations. WARNING: this option loosens the SSL security, and by using +this flag you ask for exactly that. diff --git a/docs/cmdline-opts/ssl-no-revoke.d b/docs/cmdline-opts/ssl-no-revoke.d new file mode 100644 index 000000000..cdb6fb5ee --- /dev/null +++ b/docs/cmdline-opts/ssl-no-revoke.d @@ -0,0 +1,7 @@ +Long: ssl-no-revoke +Help: Disable cert revocation checks (WinSSL) +Added: 7.44.0 +--- +(WinSSL) This option tells curl to disable certificate revocation checks. +WARNING: this option loosens the SSL security, and by using this flag you ask +for exactly that. diff --git a/docs/cmdline-opts/ssl-reqd.d b/docs/cmdline-opts/ssl-reqd.d new file mode 100644 index 000000000..b21aed104 --- /dev/null +++ b/docs/cmdline-opts/ssl-reqd.d @@ -0,0 +1,9 @@ +long: ssl-reqd +Help: Require SSL/TLS +Protocols: FTP IMAP POP3 SMTP +Added: 7.20.0 +--- +Require SSL/TLS for the connection. Terminates the connection if the server +doesn't support SSL/TLS. + +This option was formerly known as --ftp-ssl-reqd. diff --git a/docs/cmdline-opts/ssl.d b/docs/cmdline-opts/ssl.d new file mode 100644 index 000000000..71c187ae3 --- /dev/null +++ b/docs/cmdline-opts/ssl.d @@ -0,0 +1,12 @@ +long: ssl +Help: Try SSL/TLS +Protocols: FTP IMAP POP3 SMTP +Added: 7.20.0 +--- + +Try to use SSL/TLS for the connection. Reverts to a non-secure connection if +the server doesn't support SSL/TLS. See also --ftp-ssl-control and --ssl-reqd +for different levels of encryption required. + +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. -- cgit v1.2.1