curl/docs/cmdline-opts/retry-max-time.d

c: Copyright (C) Daniel Stenberg, <daniel@haxx.se>, et al.
SPDX-License-Identifier: curl
Long: retry-max-time
Arg: <seconds>
Help: Retry only within this period
Added: 7.12.3
Category: curl
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
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.
copyright: update all copyright lines and remove year ranges - they are mostly pointless in all major jurisdictions - many big corporations and projects already don't use them - saves us from pointless churn - git keeps history for us - the year range is kept in COPYING checksrc is updated to allow non-year using copyright statements Closes #10205 2023-01-02 20:51:48 +08:00			`c: Copyright (C) Daniel Stenberg, <daniel@haxx.se>, et al.`
docs/cmdline-opts: add copyright and license identifier to each file gen.pl now insists on C: and SPDX-License-Identifier: fields to be present in all files. Closes #9002 2022-06-14 06:12:03 +08:00			`SPDX-License-Identifier: curl`
docs: fix cmdline-opts metadata headers case consistency. Almost all headers start with an uppercase letter, but some didn't. 2018-05-28 20:16:27 +08:00			`Long: retry-max-time`
cmdline-opts: more command line options documented Moved over to the new format 2016-11-28 07:50:25 +08:00			`Arg: <seconds>`
			`Help: Retry only within this period`
			`Added: 7.12.3`
docs: add categories to all cmdline opts Adapted gen.pl with 'listcats' This commit is a part of "--help me if you can" Closes #5680 2020-07-13 20:15:04 +08:00			`Category: curl`
curl.1: provide examples for each option The file format for each option now features a "Example:" header that can provide one or more examples that get rendered appropriately in the output. All options MUST have at least one example or gen.pl complains at build-time. This fix also does a few other minor format and consistency cleanups. Closes #7654 2021-08-31 22:37:14 +08:00			`Example: --retry-max-time 30 --retry 10 $URL`
curl.1: require "see also" for every documented option gen.pl now generates a warning if the "See Also" field is not filled in for a command line option All command line options now provide one or more related options. 167 "See alsos" added! Closes #8019 2021-11-15 22:58:20 +08:00			`See-also: retry`
cmdline/docs: add a required 'multi' keyword for each option The keyword specifies how option works when specified multiple times: - single: the last provided value replaces the earlier ones - append: it supports being provided multiple times - boolean: on/off values - mutex: flag-like option that disable anoter flag The 'gen.pl' script then outputs the proper and unified language for each option's multi-use behavior in the generated man page. The multi: header is requires in each .d file and will cause build error if missing or set to an unknown value. Closes #9759 2022-10-18 16:39:43 +08:00			`Multi: single`
cmdline-opts: more command line options documented Moved over to the new format 2016-11-28 07:50:25 +08:00			`---`
			`The retry timer is reset before the first transfer attempt. Retries will be`
docs: reduce/avoid English contractions You're => You are Hasn't => Has not Doesn't => Does not Don't => Do not You'll => You will etc Closes #7930 2021-10-31 23:34:44 +08:00			`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`
cmdline-opts: more command line options documented Moved over to the new format 2016-11-28 07:50:25 +08:00			`made and while performing, it may take longer than this given time period. To`
docs: address proselint nits - avoid exclamation marks - use consistent number of spaces after periods: one - avoid clichés - avoid using 'very' Closes #8060 2021-11-26 15:46:59 +08:00			`limit a single request's maximum time, use --max-time. Set this option to`
cmdline-opts: more command line options documented Moved over to the new format 2016-11-28 07:50:25 +08:00			`zero to not timeout retries.`