From 68784d73c3f8bc0d14502b4e1e930b1741c41699 Mon Sep 17 00:00:00 2001 From: Daniel Stenberg Date: Tue, 31 Aug 2021 16:37:14 +0200 Subject: 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 --- docs/cmdline-opts/max-time.d | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) (limited to 'docs/cmdline-opts/max-time.d') 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: -Help: Maximum time allowed for the transfer +Arg: +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 -- cgit v1.2.1