curl/docs/cmdline-opts/keepalive-time.d

c: Copyright (C) Daniel Stenberg, <daniel@haxx.se>, et al.
SPDX-License-Identifier: curl
Long: keepalive-time
Arg: <seconds>
Help: Interval time for keepalive probes
Added: 7.18.0
Category: connection
Example: --keepalive-time 20 $URL
See-also: no-keepalive max-time
Multi: single
---
This option sets the time a connection needs to remain idle before sending
keepalive probes and the time between individual keepalive probes. It is
currently effective on operating systems offering the TCP_KEEPIDLE and
TCP_KEEPINTVL socket options (meaning Linux, recent AIX, HP-UX and more).
Keepalives are used by the TCP stack to detect broken networks on idle
connections. The number of missed keepalive probes before declaring the
connection down is OS dependent and is commonly 9 or 10. This option has no
effect if --no-keepalive is used.

If unspecified, the option defaults to 60 seconds.
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: keepalive-time`
			`Arg: <seconds>`
			`Help: Interval time for keepalive probes`
			`Added: 7.18.0`
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: --keepalive-time 20 $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: no-keepalive max-time`
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			`---`
			`This option sets the time a connection needs to remain idle before sending`
			`keepalive probes and the time between individual keepalive probes. It is`
			`currently effective on operating systems offering the TCP_KEEPIDLE and`
keepalive-time.d: It takes many probes to detect brokenness 2022-03-10 14:11:13 +08:00			`TCP_KEEPINTVL socket options (meaning Linux, recent AIX, HP-UX and more).`
			`Keepalives are used by the TCP stack to detect broken networks on idle`
			`connections. The number of missed keepalive probes before declaring the`
			`connection down is OS dependent and is commonly 9 or 10. This option has no`
			`effect if --no-keepalive is used.`
cmdline-docs: more options converted over 2016-11-16 06:44:58 +08:00
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			`If unspecified, the option defaults to 60 seconds.`