mirror of
https://github.com/curl/curl.git
synced 2026-08-25 21:33:36 +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_EXPECT_100_TIMEOUT_MS.md
Normal file
64
docs/libcurl/opts/CURLOPT_EXPECT_100_TIMEOUT_MS.md
Normal file
|
|
@ -0,0 +1,64 @@
|
|||
---
|
||||
c: Copyright (C) Daniel Stenberg, <daniel.se>, et al.
|
||||
SPDX-License-Identifier: curl
|
||||
Title: CURLOPT_EXPECT_100_TIMEOUT_MS
|
||||
Section: 3
|
||||
Source: libcurl
|
||||
See-also:
|
||||
- CURLOPT_HTTPPOST (3)
|
||||
- CURLOPT_POST (3)
|
||||
---
|
||||
|
||||
# NAME
|
||||
|
||||
CURLOPT_EXPECT_100_TIMEOUT_MS - timeout for Expect: 100-continue response
|
||||
|
||||
# SYNOPSIS
|
||||
|
||||
~~~c
|
||||
#include <curl/curl.h>
|
||||
|
||||
CURLcode curl_easy_setopt(CURL *handle, CURLOPT_EXPECT_100_TIMEOUT_MS,
|
||||
long milliseconds);
|
||||
~~~
|
||||
|
||||
# DESCRIPTION
|
||||
|
||||
Pass a long to tell libcurl the number of *milliseconds* to wait for a
|
||||
server response with the HTTP status 100 (Continue), 417 (Expectation Failed)
|
||||
or similar after sending an HTTP request containing an Expect: 100-continue
|
||||
header. If this times out before a response is received, the request body is
|
||||
sent anyway.
|
||||
|
||||
# DEFAULT
|
||||
|
||||
1000 milliseconds
|
||||
|
||||
# PROTOCOLS
|
||||
|
||||
HTTP
|
||||
|
||||
# EXAMPLE
|
||||
|
||||
~~~c
|
||||
int main(void)
|
||||
{
|
||||
CURL *curl = curl_easy_init();
|
||||
if(curl) {
|
||||
curl_easy_setopt(curl, CURLOPT_URL, "https://example.com");
|
||||
|
||||
/* wait 3 seconds for 100-continue */
|
||||
curl_easy_setopt(curl, CURLOPT_EXPECT_100_TIMEOUT_MS, 3000L);
|
||||
|
||||
curl_easy_perform(curl);
|
||||
}
|
||||
}
|
||||
~~~
|
||||
|
||||
# AVAILABILITY
|
||||
|
||||
Added in 7.36.0
|
||||
|
||||
# RETURN VALUE
|
||||
|
||||
Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not.
|
||||
Loading…
Add table
Add a link
Reference in a new issue