mirror of
https://github.com/curl/curl.git
synced 2026-08-25 23:23:31 +03:00
docs: introduce "curldown" for libcurl man page format
curldown is this new file format for libcurl man pages. It is markdown inspired with differences: - Each file has a set of leading headers with meta-data - Supports a small subset of markdown - Uses .md file extensions for editors/IDE/GitHub to treat them nicely - Generates man pages very similar to the previous ones - Generates man pages that still convert nicely to HTML on the website - Detects and highlights mentions of curl symbols automatically (when their man page section is specified) tools: - cd2nroff: converts from curldown to nroff man page - nroff2cd: convert an (old) nroff man page to curldown - cdall: convert many nroff pages to curldown versions - cd2cd: verifies and updates a curldown to latest curldown This setup generates .3 versions of all the curldown versions at build time. CI: Since the documentation is now technically markdown in the eyes of many things, the CI runs many more tests and checks on this documentation, including proselint, link checkers and tests that make sure we capitalize the first letter after a period... Closes #12730
This commit is contained in:
parent
02f91d5b64
commit
eefcc1bda4
960 changed files with 41083 additions and 39724 deletions
64
docs/libcurl/opts/CURLOPT_TIMEOUT_MS.md
Normal file
64
docs/libcurl/opts/CURLOPT_TIMEOUT_MS.md
Normal file
|
|
@ -0,0 +1,64 @@
|
|||
---
|
||||
c: Copyright (C) Daniel Stenberg, <daniel.se>, et al.
|
||||
SPDX-License-Identifier: curl
|
||||
Title: CURLOPT_TIMEOUT_MS
|
||||
Section: 3
|
||||
Source: libcurl
|
||||
See-also:
|
||||
- CURLOPT_CONNECTTIMEOUT (3)
|
||||
- CURLOPT_LOW_SPEED_LIMIT (3)
|
||||
- CURLOPT_TCP_KEEPALIVE (3)
|
||||
- CURLOPT_TIMEOUT (3)
|
||||
---
|
||||
|
||||
# NAME
|
||||
|
||||
CURLOPT_TIMEOUT_MS - maximum time the transfer is allowed to complete
|
||||
|
||||
# SYNOPSIS
|
||||
|
||||
~~~c
|
||||
#include <curl/curl.h>
|
||||
|
||||
CURLcode curl_easy_setopt(CURL *handle, CURLOPT_TIMEOUT_MS, long timeout);
|
||||
~~~
|
||||
|
||||
# DESCRIPTION
|
||||
|
||||
Pass a long as parameter containing *timeout* - the maximum time in
|
||||
milliseconds that you allow the libcurl transfer operation to take.
|
||||
|
||||
See CURLOPT_TIMEOUT(3) for details.
|
||||
|
||||
# DEFAULT
|
||||
|
||||
Default timeout is 0 (zero) which means it never times out during transfer.
|
||||
|
||||
# PROTOCOLS
|
||||
|
||||
All
|
||||
|
||||
# EXAMPLE
|
||||
|
||||
~~~c
|
||||
int main(void)
|
||||
{
|
||||
CURL *curl = curl_easy_init();
|
||||
if(curl) {
|
||||
curl_easy_setopt(curl, CURLOPT_URL, "https://example.com");
|
||||
|
||||
/* complete within 20000 milliseconds */
|
||||
curl_easy_setopt(curl, CURLOPT_TIMEOUT_MS, 20000L);
|
||||
|
||||
curl_easy_perform(curl);
|
||||
}
|
||||
}
|
||||
~~~
|
||||
|
||||
# AVAILABILITY
|
||||
|
||||
Always
|
||||
|
||||
# RETURN VALUE
|
||||
|
||||
Returns CURLE_OK
|
||||
Loading…
Add table
Add a link
Reference in a new issue