mirror/curl
2
0
Fork 0
mirror of https://github.com/curl/curl.git synced 2024-12-27 06:59:43 +08:00
Code Issues Packages Projects Releases Wiki Activity
dd5999b686
curl/docs/cmdline-opts/max-time.d

Ignoring revisions in .git-blame-ignore-revs. Click here to bypass and see the normal blame view.

26 lines
977 B
D
Raw Normal View History

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
cmdline-docs: more options converted over
2016-11-16 06:44:58 +08:00
Long: max-time
Short: m
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
Arg: <fractional seconds>
Help: Maximum time allowed for transfer
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-19 15:40:52 +08:00
See-also: connect-timeout retry-max-time
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: connection
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: --max-time 10 $URL
Example: --max-time 2.92 $URL
cmdline-opts: made the 'Added:' field mandatory Since "too old" versions are no longer included in the generated man page, this field is now mandatory so that it won't be forgotten and then not included in the documentation. Closes #7786
2021-09-28 17:50:07 +08:00
Added: 4.0
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-docs: more options converted over
2016-11-16 06:44:58 +08:00
---
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-19 15:40:52 +08:00
Maximum time in seconds that you allow each transfer to take. This is
cmdline-docs: more options converted over
2016-11-16 06:44:58 +08:00
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.
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-19 15:40:52 +08:00
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.
tool_operate: override the numeric locale and set "C" by force Makes curl always use dot as decimal separator for options, independently of what the locale says. Makes scripts and command lines portable. Updated docs accordingly. Reported-by: Daniel Faust Fixes #9969 Closes #9972
2022-11-23 18:24:26 +08:00
The decimal value needs to provided using a dot (.) as decimal separator - not
the local version even if it might be using another separator.
Reference in New Issue Copy Permalink