mirror of
https://github.com/curl/curl.git
synced 2024-12-09 06:30:06 +08:00
eefcc1bda4
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
76 lines
1.8 KiB
Markdown
76 lines
1.8 KiB
Markdown
---
|
|
c: Copyright (C) Daniel Stenberg, <daniel.se>, et al.
|
|
SPDX-License-Identifier: curl
|
|
Title: CURLOPT_HTTP200ALIASES
|
|
Section: 3
|
|
Source: libcurl
|
|
See-also:
|
|
- CURLOPT_HTTP09_ALLOWED (3)
|
|
- CURLOPT_HTTP_VERSION (3)
|
|
---
|
|
|
|
# NAME
|
|
|
|
CURLOPT_HTTP200ALIASES - alternative matches for HTTP 200 OK
|
|
|
|
# SYNOPSIS
|
|
|
|
~~~c
|
|
#include <curl/curl.h>
|
|
|
|
CURLcode curl_easy_setopt(CURL *handle, CURLOPT_HTTP200ALIASES,
|
|
struct curl_slist *aliases);
|
|
~~~
|
|
|
|
# DESCRIPTION
|
|
|
|
Pass a pointer to a linked list of *aliases* to be treated as valid HTTP 200
|
|
responses. Some servers respond with a custom header response line. For
|
|
example, SHOUTcast servers respond with "ICY 200 OK". Also some old Icecast
|
|
1.3.x servers respond like that for certain user agent headers or in absence
|
|
of such. By including this string in your list of aliases, the response gets
|
|
treated as a valid HTTP header line such as "HTTP/1.0 200 OK".
|
|
|
|
The linked list should be a fully valid list of struct curl_slist structs, and
|
|
be properly filled in. Use curl_slist_append(3) to create the list and
|
|
curl_slist_free_all(3) to clean up an entire list.
|
|
|
|
The alias itself is not parsed for any version strings. The protocol is
|
|
assumed to match HTTP 1.0 when an alias match.
|
|
|
|
# DEFAULT
|
|
|
|
NULL
|
|
|
|
# PROTOCOLS
|
|
|
|
HTTP
|
|
|
|
# EXAMPLE
|
|
|
|
~~~c
|
|
int main(void)
|
|
{
|
|
CURL *curl = curl_easy_init();
|
|
if(curl) {
|
|
struct curl_slist *list;
|
|
curl_easy_setopt(curl, CURLOPT_URL, "https://example.com");
|
|
|
|
list = curl_slist_append(NULL, "ICY 200 OK");
|
|
list = curl_slist_append(list, "WEIRDO 99 FINE");
|
|
|
|
curl_easy_setopt(curl, CURLOPT_HTTP200ALIASES, list);
|
|
curl_easy_perform(curl);
|
|
curl_slist_free_all(list); /* free the list again */
|
|
}
|
|
}
|
|
~~~
|
|
|
|
# AVAILABILITY
|
|
|
|
Added in 7.10.3
|
|
|
|
# RETURN VALUE
|
|
|
|
Returns CURLE_OK if HTTP is supported, and CURLE_UNKNOWN_OPTION if not.
|