mirror/curl
2
0
Fork 0
mirror of https://github.com/curl/curl.git synced 2024-12-09 06:30:06 +08:00
Code Issues Packages Projects Releases Wiki Activity
54fe8c44e1
curl/docs/cmdline-opts/connect-timeout.md

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

29 lines
834 B
Markdown
Raw Normal View History

docs/cmdline: change to .md for cmdline docs - switch all invidual files documenting command line options into .md, as the documentation is now markdown-looking. - made the parser treat 4-space indents as quotes - switch to building the curl.1 manpage using the "mainpage.idx" file, which lists the files to include to generate it, instead of using the previous page-footer/headers. Also, those files are now also .md ones, using the same format. I gave them underscore prefixes to make them sort separately: _NAME.md, _SYNOPSIS.md, _DESCRIPTION.md, _URL.md, _GLOBBING.md, _VARIABLES.md, _OUTPUT.md, _PROTOCOLS.md, _PROGRESS.md, _VERSION.md, _OPTIONS.md, _FILES.md, _ENVIRONMENT.md, _PROXYPREFIX.md, _EXITCODES.md, _BUGS.md, _AUTHORS.md, _WWW.md, _SEEALSO.md - updated test cases accordingly Closes #12751
2024-01-21 06:18:43 +08:00
---
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: connect-timeout
cmdline-opts: shorter help texts In an effort to increase the readability of the "--help all" output on narrow (80 column) terminals. Co-authored-by: Jay Satiro Closes #13169
2024-03-25 17:02:30 +08:00
Arg: <seconds>
Help: Maximum time allowed to connect
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
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: 7.7
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
docs/cmdline: change to .md for cmdline docs - switch all invidual files documenting command line options into .md, as the documentation is now markdown-looking. - made the parser treat 4-space indents as quotes - switch to building the curl.1 manpage using the "mainpage.idx" file, which lists the files to include to generate it, instead of using the previous page-footer/headers. Also, those files are now also .md ones, using the same format. I gave them underscore prefixes to make them sort separately: _NAME.md, _SYNOPSIS.md, _DESCRIPTION.md, _URL.md, _GLOBBING.md, _VARIABLES.md, _OUTPUT.md, _PROTOCOLS.md, _PROGRESS.md, _VERSION.md, _OPTIONS.md, _FILES.md, _ENVIRONMENT.md, _PROXYPREFIX.md, _EXITCODES.md, _BUGS.md, _AUTHORS.md, _WWW.md, _SEEALSO.md - updated test cases accordingly Closes #12751
2024-01-21 06:18:43 +08:00
See-also:
- max-time
Example:
- --connect-timeout 20 $URL
- --connect-timeout 3.14 $URL
cmdline-docs: more options converted over
2016-11-16 06:44:58 +08:00
---
docs/cmdline: change to .md for cmdline docs - switch all invidual files documenting command line options into .md, as the documentation is now markdown-looking. - made the parser treat 4-space indents as quotes - switch to building the curl.1 manpage using the "mainpage.idx" file, which lists the files to include to generate it, instead of using the previous page-footer/headers. Also, those files are now also .md ones, using the same format. I gave them underscore prefixes to make them sort separately: _NAME.md, _SYNOPSIS.md, _DESCRIPTION.md, _URL.md, _GLOBBING.md, _VARIABLES.md, _OUTPUT.md, _PROTOCOLS.md, _PROGRESS.md, _VERSION.md, _OPTIONS.md, _FILES.md, _ENVIRONMENT.md, _PROXYPREFIX.md, _EXITCODES.md, _BUGS.md, _AUTHORS.md, _WWW.md, _SEEALSO.md - updated test cases accordingly Closes #12751
2024-01-21 06:18:43 +08:00
# `--connect-timeout`
Maximum time in seconds that you allow curl's connection to take. This only
cmdline-docs: more options converted over
2016-11-16 06:44:58 +08:00
limits the connection phase, so if curl connects within the given period it
cmdline-docs: use present tense, not future + some smaller cleanups Closes #11821
2023-09-08 20:32:29 +08:00
continues - if not it exits.
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
cmdline-docs: make sure to phrase it as "added in ...." References to things that were added or changed in a specific version should be specified as "(added in [version]) for two reasons: 1 - consistency 2 - to allow gen.pl to strip them out if deemed referring to too old versions Closes #11821
2023-09-08 20:03:59 +08:00
This option accepts decimal values (added in 7.32.0). The decimal value needs
to be provided using a dot (.) as decimal separator - not the local version
even if it might be using another separator.
KNOWN_BUGS: remove five FTP related issues - "FTP with CONNECT and slow server" I believe this is not a problem these days. - "FTP with NULs in URL parts" The FTP protocol does not support them properly anyway. - remove "FTP and empty path parts in the URL" I don't think this has ever been reported as a real problem but was only a hypothetical one. - "Premature transfer end but healthy control channel" This is not a bug, this is an optimization that *could* be performed but is not an actual problem. - "FTP without or slow 220 response" Instead add to the documentation of the connect timeout that the connection is considered complete at TCP/TLS/QUIC layer. Closes #9979
2022-11-22 16:28:20 +08:00
cmdline-docs: make sure to phrase it as "added in ...." References to things that were added or changed in a specific version should be specified as "(added in [version]) for two reasons: 1 - consistency 2 - to allow gen.pl to strip them out if deemed referring to too old versions Closes #11821
2023-09-08 20:03:59 +08:00
The connection phase is considered complete when the DNS lookup and requested
TCP, TLS or QUIC handshakes are done.
Reference in New Issue Copy Permalink