curl/docs/cmdline-opts
Jay Satiro 64641d2170
max-time.d: clarify max-time sets max transfer time
Prior to this change the doc said --max-time set the maximum time of the
'whole operation' which is not accurate. The option maps to
CURLOPT_TIMEOUT_MS which sets maximum transfer time.

For example, the maximum time on a transfer is reset if the transfer is
retried (--retry).

Reported-by: Nuru@users.noreply.github.com

Fixes https://github.com/curl/curl/issues/8877
Closes #8879
2022-05-23 17:14:57 +02:00
..
abstract-unix-socket.d curl.1: require "see also" for every documented option 2021-11-15 23:06:41 +01:00
alt-svc.d curl.1: require "see also" for every documented option 2021-11-15 23:06:41 +01:00
anyauth.d
append.d docs: address proselint nits 2021-11-26 14:27:07 +01:00
aws-sigv4.d curl.1: require "see also" for every documented option 2021-11-15 23:06:41 +01:00
basic.d
cacert.d curl.1: require "see also" for every documented option 2021-11-15 23:06:41 +01:00
capath.d curl.1: require "see also" for every documented option 2021-11-15 23:06:41 +01:00
cert-status.d curl.1: require "see also" for every documented option 2021-11-15 23:06:41 +01:00
cert-type.d docs/opts: Mention Schannel client cert type is P12 2022-03-22 14:24:06 -04:00
cert.d docs: address proselint nits 2021-11-26 14:27:07 +01:00
ciphers.d curl.1: require "see also" for every documented option 2021-11-15 23:06:41 +01:00
CMakeLists.txt
compressed-ssh.d curl.1: require "see also" for every documented option 2021-11-15 23:06:41 +01:00
compressed.d curl.1: require "see also" for every documented option 2021-11-15 23:06:41 +01:00
config.d config.d: Clarify _curlrc filename is still valid on Windows 2022-02-04 03:46:26 -05:00
connect-timeout.d
connect-to.d
continue-at.d docs: address proselint nits 2021-11-26 14:27:07 +01:00
cookie-jar.d curl.1: require "see also" for every documented option 2021-11-15 23:06:41 +01:00
cookie.d cookie.d: clarify when cookies are always sent 2022-04-25 13:05:47 +02:00
create-dirs.d curl.1: require "see also" for every documented option 2021-11-15 23:06:41 +01:00
create-file-mode.d
crlf.d curl.1: require "see also" for every documented option 2021-11-15 23:06:41 +01:00
crlfile.d curl.1: require "see also" for every documented option 2021-11-15 23:06:41 +01:00
curves.d docs: address proselint nits 2021-11-26 14:27:07 +01:00
data-ascii.d curl.1: require "see also" for every documented option 2021-11-15 23:06:41 +01:00
data-binary.d docs: address proselint nits 2021-11-26 14:27:07 +01:00
data-raw.d
data-urlencode.d docs: lots of minor language polish 2022-03-29 13:58:14 +02:00
data.d docs: address proselint nits 2021-11-26 14:27:07 +01:00
delegation.d curl.1: require "see also" for every documented option 2021-11-15 23:06:41 +01:00
digest.d
disable-eprt.d curl.1: require "see also" for every documented option 2021-11-15 23:06:41 +01:00
disable-epsv.d curl.1: require "see also" for every documented option 2021-11-15 23:06:41 +01:00
disable.d curl.1: require "see also" for every documented option 2021-11-15 23:06:41 +01:00
disallow-username-in-url.d docs: lots of minor language polish 2022-03-29 13:58:14 +02:00
dns-interface.d
dns-ipv4-addr.d
dns-ipv6-addr.d
dns-servers.d curl.1: require "see also" for every documented option 2021-11-15 23:06:41 +01:00
doh-cert-status.d docs/cmdline-opts: do not say "protocols: all" 2021-11-15 23:11:55 +01:00
doh-insecure.d docs/cmdline-opts: do not say "protocols: all" 2021-11-15 23:11:55 +01:00
doh-url.d docs/cmdline-opts: do not say "protocols: all" 2021-11-15 23:11:55 +01:00
dump-header.d
egd-file.d curl: deprecate --random-file and --egd-file 2022-05-17 11:06:07 +02:00
engine.d docs: lots of minor language polish 2022-03-29 13:58:14 +02:00
etag-compare.d curl.1: require "see also" for every documented option 2021-11-15 23:06:41 +01:00
etag-save.d curl.1: require "see also" for every documented option 2021-11-15 23:06:41 +01:00
expect100-timeout.d
fail-early.d curl.1: require "see also" for every documented option 2021-11-15 23:06:41 +01:00
fail-with-body.d
fail.d fail.d: tweak the description 2022-04-15 23:50:35 +02:00
false-start.d curl.1: require "see also" for every documented option 2021-11-15 23:06:41 +01:00
form-escape.d
form-string.d
form.d misc: s/e-mail/email 2021-12-19 23:48:13 +01:00
ftp-account.d curl.1: require "see also" for every documented option 2021-11-15 23:06:41 +01:00
ftp-alternative-to-user.d curl.1: require "see also" for every documented option 2021-11-15 23:06:41 +01:00
ftp-create-dirs.d
ftp-method.d curl.1: require "see also" for every documented option 2021-11-15 23:06:41 +01:00
ftp-pasv.d
ftp-port.d
ftp-pret.d curl.1: require "see also" for every documented option 2021-11-15 23:06:41 +01:00
ftp-skip-pasv-ip.d
ftp-ssl-ccc-mode.d
ftp-ssl-ccc.d
ftp-ssl-control.d curl.1: require "see also" for every documented option 2021-11-15 23:06:41 +01:00
gen.pl gen.pl: change wording for mutexed options 2022-04-17 11:21:16 +02:00
get.d curl.1: require "see also" for every documented option 2021-11-15 23:06:41 +01:00
globoff.d curl.1: require "see also" for every documented option 2021-11-15 23:06:41 +01:00
happy-eyeballs-timeout-ms.d curl.1: require "see also" for every documented option 2021-11-15 23:06:41 +01:00
haproxy-protocol.d curl.1: require "see also" for every documented option 2021-11-15 23:06:41 +01:00
head.d curl.1: require "see also" for every documented option 2021-11-15 23:06:41 +01:00
header.d docs: lots of minor language polish 2022-03-29 13:58:14 +02:00
help.d curl.1: require "see also" for every documented option 2021-11-15 23:06:41 +01:00
hostpubmd5.d curl.1: require "see also" for every documented option 2021-11-15 23:06:41 +01:00
hostpubsha256.d curl.1: require "see also" for every documented option 2021-11-15 23:06:41 +01:00
hsts.d curl.1: require "see also" for every documented option 2021-11-15 23:06:41 +01:00
http0.9.d curl.1: require "see also" for every documented option 2021-11-15 23:06:41 +01:00
http1.0.d docs/cmdline-opts: add "mutexed" options for more http versions 2022-01-10 09:33:35 +01:00
http1.1.d docs/cmdline-opts: add "mutexed" options for more http versions 2022-01-10 09:33:35 +01:00
http2-prior-knowledge.d docs/cmdline-opts: add "mutexed" options for more http versions 2022-01-10 09:33:35 +01:00
http2.d docs: document HTTP/2 not insisting on TLS 1.2 2022-01-19 23:30:07 +01:00
http3.d
ignore-content-length.d curl.1: require "see also" for every documented option 2021-11-15 23:06:41 +01:00
include.d
insecure.d insecure.d: detail its use for SFTP and SCP as well 2021-11-25 22:31:15 +01:00
interface.d
ipv4.d ipv4/6.d: clarify that they are about using IP addresses 2022-03-06 23:32:40 +01:00
ipv6.d ipv4/6.d: clarify that they are about using IP addresses 2022-03-06 23:32:40 +01:00
json.d json.d: fix typo (overriden -> overridden) 2022-03-07 22:48:10 +01:00
junk-session-cookies.d
keepalive-time.d keepalive-time.d: It takes many probes to detect brokenness 2022-03-11 17:13:25 -08:00
key-type.d curl.1: require "see also" for every documented option 2021-11-15 23:06:41 +01:00
key.d docs/opts: Mention Schannel client cert type is P12 2022-03-22 14:24:06 -04:00
krb.d curl.1: require "see also" for every documented option 2021-11-15 23:06:41 +01:00
libcurl.d curl.1: require "see also" for every documented option 2021-11-15 23:06:41 +01:00
limit-rate.d curl.1: require "see also" for every documented option 2021-11-15 23:06:41 +01:00
list-only.d curl.1: require "see also" for every documented option 2021-11-15 23:06:41 +01:00
local-port.d curl.1: require "see also" for every documented option 2021-11-15 23:06:41 +01:00
location-trusted.d
location.d curl.1: require "see also" for every documented option 2021-11-15 23:06:41 +01:00
login-options.d openldap: implement SASL authentication 2022-01-11 11:17:27 +01:00
mail-auth.d
mail-from.d
mail-rcpt-allowfails.d curl.1: require "see also" for every documented option 2021-11-15 23:06:41 +01:00
mail-rcpt.d misc: s/e-mail/email 2021-12-19 23:48:13 +01:00
Makefile.am
Makefile.inc curl: add --no-clobber 2022-03-11 08:38:01 +01:00
MANPAGE.md gen.pl: improve example output format 2021-11-15 22:59:49 +01:00
manual.d curl.1: require "see also" for every documented option 2021-11-15 23:06:41 +01:00
max-filesize.d
max-redirs.d curl.1: require "see also" for every documented option 2021-11-15 23:06:41 +01:00
max-time.d max-time.d: clarify max-time sets max transfer time 2022-05-23 17:14:57 +02:00
metalink.d curl.1: require "see also" for every documented option 2021-11-15 23:06:41 +01:00
negotiate.d
netrc-file.d docs: address proselint nits 2021-11-26 14:27:07 +01:00
netrc-optional.d
netrc.d netrc.d: edit the .netrc example to look nicer 2021-11-17 08:33:05 +01:00
next.d next.d. remove .fi/.nf as they are handled by gen.pl 2022-01-05 22:44:59 +01:00
no-alpn.d
no-buffer.d curl.1: require "see also" for every documented option 2021-11-15 23:06:41 +01:00
no-clobber.d curl: add --no-clobber 2022-03-11 08:38:01 +01:00
no-keepalive.d curl.1: require "see also" for every documented option 2021-11-15 23:06:41 +01:00
no-npn.d
no-progress-meter.d
no-sessionid.d docs: address proselint nits 2021-11-26 14:27:07 +01:00
noproxy.d curl.1: require "see also" for every documented option 2021-11-15 23:06:41 +01:00
ntlm-wb.d
ntlm.d
oauth2-bearer.d openldap: implement SASL authentication 2022-01-11 11:17:27 +01:00
output-dir.d
output.d
page-footer page-footer: mention exit code zero too 2022-05-12 16:26:20 +02:00
page-header docs: fix proselint nits 2021-12-09 23:16:46 +01:00
parallel-immediate.d
parallel-max.d
parallel.d curl.1: require "see also" for every documented option 2021-11-15 23:06:41 +01:00
pass.d curl.1: require "see also" for every documented option 2021-11-15 23:06:41 +01:00
path-as-is.d curl.1: require "see also" for every documented option 2021-11-15 23:06:41 +01:00
pinnedpubkey.d curl.1: require "see also" for every documented option 2021-11-15 23:06:41 +01:00
post301.d
post302.d
post303.d
preproxy.d curl.1: require "see also" for every documented option 2021-11-15 23:06:41 +01:00
progress-bar.d curl.1: require "see also" for every documented option 2021-11-15 23:06:41 +01:00
proto-default.d curl.1: require "see also" for every documented option 2021-11-15 23:06:41 +01:00
proto-redir.d curl.1: require "see also" for every documented option 2021-11-15 23:06:41 +01:00
proto.d
proxy1.0.d curl.1: require "see also" for every documented option 2021-11-15 23:06:41 +01:00
proxy-anyauth.d
proxy-basic.d
proxy-cacert.d
proxy-capath.d
proxy-cert-type.d curl.1: require "see also" for every documented option 2021-11-15 23:06:41 +01:00
proxy-cert.d curl.1: require "see also" for every documented option 2021-11-15 23:06:41 +01:00
proxy-ciphers.d curl.1: require "see also" for every documented option 2021-11-15 23:06:41 +01:00
proxy-crlfile.d curl.1: require "see also" for every documented option 2021-11-15 23:06:41 +01:00
proxy-digest.d
proxy-header.d curl.1: require "see also" for every documented option 2021-11-15 23:06:41 +01:00
proxy-insecure.d curl.1: require "see also" for every documented option 2021-11-15 23:06:41 +01:00
proxy-key-type.d curl.1: require "see also" for every documented option 2021-11-15 23:06:41 +01:00
proxy-key.d curl.1: require "see also" for every documented option 2021-11-15 23:06:41 +01:00
proxy-negotiate.d
proxy-ntlm.d
proxy-pass.d curl.1: require "see also" for every documented option 2021-11-15 23:06:41 +01:00
proxy-pinnedpubkey.d curl.1: require "see also" for every documented option 2021-11-15 23:06:41 +01:00
proxy-service-name.d curl.1: require "see also" for every documented option 2021-11-15 23:06:41 +01:00
proxy-ssl-allow-beast.d curl.1: require "see also" for every documented option 2021-11-15 23:06:41 +01:00
proxy-ssl-auto-client-cert.d curl.1: require "see also" for every documented option 2021-11-15 23:06:41 +01:00
proxy-tls13-ciphers.d curl.1: require "see also" for every documented option 2021-11-15 23:06:41 +01:00
proxy-tlsauthtype.d curl.1: require "see also" for every documented option 2021-11-15 23:06:41 +01:00
proxy-tlspassword.d curl.1: require "see also" for every documented option 2021-11-15 23:06:41 +01:00
proxy-tlsuser.d curl.1: require "see also" for every documented option 2021-11-15 23:06:41 +01:00
proxy-tlsv1.d curl.1: require "see also" for every documented option 2021-11-15 23:06:41 +01:00
proxy-user.d docs: address proselint nits 2021-11-26 14:27:07 +01:00
proxy.d socks: support unix sockets for socks proxy 2022-05-19 15:35:03 +02:00
proxytunnel.d
pubkey.d curl.1: require "see also" for every documented option 2021-11-15 23:06:41 +01:00
quote.d CURLOPT_PREQUOTE.3: only works for FTP file transfers, not dirs 2022-03-29 18:15:44 +02:00
random-file.d curl: deprecate --random-file and --egd-file 2022-05-17 11:06:07 +02:00
range.d curl.1: require "see also" for every documented option 2021-11-15 23:06:41 +01:00
raw.d curl.1: require "see also" for every documented option 2021-11-15 23:06:41 +01:00
referer.d docs: address proselint nits 2021-11-26 14:27:07 +01:00
remote-header-name.d remote-header-name.d: clarify 2022-01-09 16:04:05 +01:00
remote-name-all.d curl.1: require "see also" for every documented option 2021-11-15 23:06:41 +01:00
remote-name.d curl.1: require "see also" for every documented option 2021-11-15 23:06:41 +01:00
remote-time.d curl.1: require "see also" for every documented option 2021-11-15 23:06:41 +01:00
remove-on-error.d remove-on-error.d: typo 2022-03-10 22:56:11 +01:00
request-target.d curl.1: require "see also" for every documented option 2021-11-15 23:06:41 +01:00
request.d request.d: refer to 'method' rather than 'command' 2021-12-05 23:05:11 +01:00
resolve.d curl.1: require "see also" for every documented option 2021-11-15 23:06:41 +01:00
retry-all-errors.d retry-all-errors.d: make the example complete 2021-12-07 10:10:51 +01:00
retry-connrefused.d curl.1: require "see also" for every documented option 2021-11-15 23:06:41 +01:00
retry-delay.d curl.1: require "see also" for every documented option 2021-11-15 23:06:41 +01:00
retry-max-time.d docs: address proselint nits 2021-11-26 14:27:07 +01:00
retry.d docs: address proselint nits 2021-11-26 14:27:07 +01:00
sasl-authzid.d English: use American spelling consistently 2022-04-05 14:55:47 +02:00
sasl-ir.d curl.1: require "see also" for every documented option 2021-11-15 23:06:41 +01:00
service-name.d curl.1: require "see also" for every documented option 2021-11-15 23:06:41 +01:00
show-error.d
silent.d docs: address proselint nits 2021-11-26 14:27:07 +01:00
socks4.d socks: support unix sockets for socks proxy 2022-05-19 15:35:03 +02:00
socks4a.d socks: support unix sockets for socks proxy 2022-05-19 15:35:03 +02:00
socks5-basic.d curl.1: require "see also" for every documented option 2021-11-15 23:06:41 +01:00
socks5-gssapi-nec.d docs: address proselint nits 2021-11-26 14:27:07 +01:00
socks5-gssapi-service.d curl.1: require "see also" for every documented option 2021-11-15 23:06:41 +01:00
socks5-gssapi.d curl.1: require "see also" for every documented option 2021-11-15 23:06:41 +01:00
socks5-hostname.d socks: support unix sockets for socks proxy 2022-05-19 15:35:03 +02:00
socks5.d socks: support unix sockets for socks proxy 2022-05-19 15:35:03 +02:00
speed-limit.d curl.1: require "see also" for every documented option 2021-11-15 23:06:41 +01:00
speed-time.d curl.1: require "see also" for every documented option 2021-11-15 23:06:41 +01:00
ssl-allow-beast.d curl.1: require "see also" for every documented option 2021-11-15 23:06:41 +01:00
ssl-auto-client-cert.d
ssl-no-revoke.d curl.1: require "see also" for every documented option 2021-11-15 23:06:41 +01:00
ssl-reqd.d docs: fix proselint nits 2021-12-09 23:16:46 +01:00
ssl-revoke-best-effort.d curl.1: require "see also" for every documented option 2021-11-15 23:06:41 +01:00
ssl.d openldap: implement STARTTLS 2021-12-06 07:53:04 +01:00
sslv2.d
sslv3.d
stderr.d
styled-output.d curl.1: require "see also" for every documented option 2021-11-15 23:06:41 +01:00
suppress-connect-headers.d
tcp-fastopen.d curl.1: require "see also" for every documented option 2021-11-15 23:06:41 +01:00
tcp-nodelay.d curl.1: require "see also" for every documented option 2021-11-15 23:06:41 +01:00
telnet-option.d curl.1: require "see also" for every documented option 2021-11-15 23:06:41 +01:00
tftp-blksize.d curl.1: require "see also" for every documented option 2021-11-15 23:06:41 +01:00
tftp-no-options.d curl.1: require "see also" for every documented option 2021-11-15 23:06:41 +01:00
time-cond.d curl.1: require "see also" for every documented option 2021-11-15 23:06:41 +01:00
tls13-ciphers.d curl.1: require "see also" for every documented option 2021-11-15 23:06:41 +01:00
tls-max.d
tlsauthtype.d docs: address proselint nits 2021-11-26 14:27:07 +01:00
tlspassword.d curl.1: require "see also" for every documented option 2021-11-15 23:06:41 +01:00
tlsuser.d curl.1: require "see also" for every documented option 2021-11-15 23:06:41 +01:00
tlsv1.0.d docs: fix proselint nits 2021-12-09 23:16:46 +01:00
tlsv1.1.d docs: fix proselint nits 2021-12-09 23:16:46 +01:00
tlsv1.2.d docs: fix proselint nits 2021-12-09 23:16:46 +01:00
tlsv1.3.d curl.1: require "see also" for every documented option 2021-11-15 23:06:41 +01:00
tlsv1.d
tr-encoding.d curl.1: require "see also" for every documented option 2021-11-15 23:06:41 +01:00
trace-ascii.d curl.1: require "see also" for every documented option 2021-11-15 23:06:41 +01:00
trace-time.d curl.1: require "see also" for every documented option 2021-11-15 23:06:41 +01:00
trace.d curl.1: require "see also" for every documented option 2021-11-15 23:06:41 +01:00
unix-socket.d curl.1: require "see also" for every documented option 2021-11-15 23:06:41 +01:00
upload-file.d curl.1: require "see also" for every documented option 2021-11-15 23:06:41 +01:00
url.d curl.1: require "see also" for every documented option 2021-11-15 23:06:41 +01:00
use-ascii.d curl.1: require "see also" for every documented option 2021-11-15 23:06:41 +01:00
user-agent.d curl.1: require "see also" for every documented option 2021-11-15 23:06:41 +01:00
user.d curl.1: require "see also" for every documented option 2021-11-15 23:06:41 +01:00
verbose.d
version.d curl.1: require "see also" for every documented option 2021-11-15 23:06:41 +01:00
write-out.d misc: spelling fixes 2022-03-30 10:49:06 +02:00
xattr.d curl.1: require "see also" for every documented option 2021-11-15 23:06:41 +01:00