summaryrefslogtreecommitdiff
path: root/docs/cmdline-opts/max-time.d
diff options
context:
space:
mode:
authorDaniel Stenberg <daniel@haxx.se>2021-08-31 16:37:14 +0200
committerDaniel Stenberg <daniel@haxx.se>2021-09-01 00:26:32 +0200
commitad53b9a65f7f0c776909abd194ce13292341e139 (patch)
tree2d4fdb58b76c9fd4652d24f257a3d68df7be649d /docs/cmdline-opts/max-time.d
parente8c8775eaa79fb93208c70a3c607e7e23222e4db (diff)
downloadcurl-ad53b9a65f7f0c776909abd194ce13292341e139.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.
Diffstat (limited to 'docs/cmdline-opts/max-time.d')
-rw-r--r--docs/cmdline-opts/max-time.d2
1 files changed, 2 insertions, 0 deletions
diff --git a/docs/cmdline-opts/max-time.d b/docs/cmdline-opts/max-time.d
index c4e4ed7eb..1827abe72 100644
--- a/docs/cmdline-opts/max-time.d
+++ b/docs/cmdline-opts/max-time.d
@@ -4,6 +4,8 @@ Arg: <seconds>
Help: Maximum time allowed for the 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