diff options
| author | Daniel Stenberg <daniel@haxx.se> | 2021-08-31 16:37:14 +0200 |
|---|---|---|
| committer | Daniel Stenberg <daniel@haxx.se> | 2021-09-01 14:02:43 +0200 |
| commit | 68784d73c3f8bc0d14502b4e1e930b1741c41699 (patch) | |
| tree | b1d7a129e2d43da0bfac6bba56a0b53912a9b026 /docs/cmdline-opts/max-time.d | |
| parent | c905459e878690942e9a0a8cd7f9ad57b6898efb (diff) | |
| download | curl-68784d73c3f8bc0d14502b4e1e930b1741c41699.tar.gz | |
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
Diffstat (limited to 'docs/cmdline-opts/max-time.d')
| -rw-r--r-- | docs/cmdline-opts/max-time.d | 6 |
1 files changed, 4 insertions, 2 deletions
diff --git a/docs/cmdline-opts/max-time.d b/docs/cmdline-opts/max-time.d index c4e4ed7eb..cb86fa9fc 100644 --- a/docs/cmdline-opts/max-time.d +++ b/docs/cmdline-opts/max-time.d @@ -1,9 +1,11 @@ Long: max-time Short: m -Arg: <seconds> -Help: Maximum time allowed for the transfer +Arg: <fractional seconds> +Help: Maximum time allowed for transfer See-also: connect-timeout Category: connection +Example: --max-time 10 $URL +Example: --max-time 2.92 $URL --- Maximum time in seconds that you allow the whole operation to take. This is useful for preventing your batch jobs from hanging for hours due to slow |