docs/libcurl: generate PROTOCOLS from meta-data

Remove the PROTOCOLS section from the source files completely and
instead generate them based on the header data in the curldown files.

It also generates TLS backend information for options marked for TLS as
protocol.

Closes #13175
This commit is contained in:
Daniel Stenberg 2024-03-22 23:48:54 +01:00
parent 7bc61bf469
commit e3fe020089
No known key found for this signature in database
GPG Key ID: 5CC908FDB71E12C2
476 changed files with 323 additions and 1860 deletions

View File

@ -85,7 +85,7 @@ everything. If `*` is used, it must be the only listed protocol. Recognized
protocols are either URL schemes (in uppercase), `TLS` or `TCP`.
If the `Protocol` list contains `TLS`, then there must also be a `TLS-backend`
list, specifying `*` or a list of what TLS backends that work with this
list, specifying `All` or a list of what TLS backends that work with this
option. The available TLS backends are:
- `BearSSL`

View File

@ -11,7 +11,7 @@ See-also:
- curl_multi_cleanup (3)
- curl_multi_remove_handle (3)
Protocol:
- *
- All
---
# NAME

View File

@ -10,7 +10,7 @@ See-also:
- curl_easy_reset (3)
- curl_global_init (3)
Protocol:
- *
- All
---
# NAME

View File

@ -8,7 +8,7 @@ See-also:
- curl_easy_unescape (3)
- curl_free (3)
Protocol:
- *
- All
---
# NAME

View File

@ -7,7 +7,7 @@ Source: libcurl
See-also:
- curl_easy_setopt (3)
Protocol:
- *
- All
---
# NAME

View File

@ -12,7 +12,7 @@ See-also:
- curl_global_init (3)
- curl_multi_init (3)
Protocol:
- *
- All
---
# NAME

View File

@ -9,7 +9,7 @@ See-also:
- curl_easy_option_next (3)
- curl_easy_setopt (3)
Protocol:
- *
- All
---
# NAME

View File

@ -9,7 +9,7 @@ See-also:
- curl_easy_option_next (3)
- curl_easy_setopt (3)
Protocol:
- *
- All
---
# NAME

View File

@ -9,7 +9,7 @@ See-also:
- curl_easy_option_by_name (3)
- curl_easy_setopt (3)
Protocol:
- *
- All
---
# NAME

View File

@ -8,7 +8,7 @@ See-also:
- curl_easy_cleanup (3)
- curl_easy_reset (3)
Protocol:
- *
- All
---
# NAME

View File

@ -11,7 +11,7 @@ See-also:
- curl_multi_perform (3)
- libcurl-errors (3)
Protocol:
- *
- All
---
# NAME

View File

@ -10,7 +10,7 @@ See-also:
- curl_easy_send (3)
- curl_easy_setopt (3)
Protocol:
- *
- All
---
# NAME

View File

@ -10,7 +10,7 @@ See-also:
- curl_easy_init (3)
- curl_easy_setopt (3)
Protocol:
- *
- All
---
# NAME

View File

@ -10,7 +10,7 @@ See-also:
- curl_easy_recv (3)
- curl_easy_setopt (3)
Protocol:
- *
- All
---
# NAME

View File

@ -14,7 +14,7 @@ See-also:
- curl_easy_reset (3)
- curl_multi_setopt (3)
Protocol:
- *
- All
---
# NAME

View File

@ -10,7 +10,7 @@ See-also:
- curl_url_strerror (3)
- libcurl-errors (3)
Protocol:
- *
- All
---
# NAME

View File

@ -8,7 +8,7 @@ See-also:
- curl_easy_escape (3)
- curl_free (3)
Protocol:
- *
- All
---
# NAME

View File

@ -8,7 +8,7 @@ See-also:
- CURLOPT_TCP_KEEPALIVE (3)
- CURLOPT_TCP_KEEPIDLE (3)
Protocol:
- *
- All
---
# NAME

View File

@ -8,7 +8,7 @@ See-also:
- curl_free (3)
- curl_unescape (3)
Protocol:
- *
- All
---
# NAME

View File

@ -8,7 +8,7 @@ See-also:
- curl_easy_escape (3)
- curl_easy_unescape (3)
Protocol:
- *
- All
---
# NAME

View File

@ -10,7 +10,7 @@ See-also:
- curl_easy_escape (3)
- curl_easy_unescape (3)
Protocol:
- *
- All
---
# NAME

View File

@ -7,7 +7,7 @@ Source: libcurl
See-also:
- getenv (3C)
Protocol:
- *
- All
---
# NAME

View File

@ -9,7 +9,7 @@ See-also:
- libcurl (3)
- libcurl-thread (3)
Protocol:
- *
- All
---
# NAME

View File

@ -12,7 +12,7 @@ See-also:
- curl_global_trace (3)
- libcurl (3)
Protocol:
- *
- All
---
# NAME

View File

@ -8,7 +8,7 @@ See-also:
- curl_global_cleanup (3)
- curl_global_init (3)
Protocol:
- *
- All
---
# NAME

View File

@ -8,7 +8,7 @@ See-also:
- curl_global_init (3)
- libcurl (3)
Protocol:
- *
- All
---
# NAME

View File

@ -8,7 +8,7 @@ See-also:
- curl_global_init (3)
- libcurl (3)
Protocol:
- *
- All
---
# NAME

View File

@ -10,7 +10,7 @@ See-also:
- sprintf (3)
- vprintf (3)
Protocol:
- *
- All
---
# NAME

View File

@ -11,7 +11,7 @@ See-also:
- curl_multi_setopt (3)
- curl_multi_socket_action (3)
Protocol:
- *
- All
---
# NAME

View File

@ -8,7 +8,7 @@ See-also:
- curl_multi_setopt (3)
- curl_multi_socket_action (3)
Protocol:
- *
- All
---
# NAME

View File

@ -10,7 +10,7 @@ See-also:
- curl_multi_get_handles (3)
- curl_multi_init (3)
Protocol:
- *
- All
---
# NAME

View File

@ -12,7 +12,7 @@ See-also:
- curl_multi_wait (3)
- select (2)
Protocol:
- *
- All
---
# NAME

View File

@ -10,7 +10,7 @@ See-also:
- curl_multi_init (3)
- curl_multi_remove_handle (3)
Protocol:
- *
- All
---
# NAME

View File

@ -9,7 +9,7 @@ See-also:
- curl_multi_init (3)
- curl_multi_perform (3)
Protocol:
- *
- All
---
# NAME

View File

@ -11,7 +11,7 @@ See-also:
- curl_multi_cleanup (3)
- curl_multi_get_handles (3)
Protocol:
- *
- All
---
# NAME

View File

@ -13,7 +13,7 @@ See-also:
- curl_multi_wait (3)
- libcurl-errors (3)
Protocol:
- *
- All
---
# NAME

View File

@ -10,7 +10,7 @@ See-also:
- curl_multi_wait (3)
- curl_multi_wakeup (3)
Protocol:
- *
- All
---
# NAME

View File

@ -9,7 +9,7 @@ See-also:
- curl_multi_cleanup (3)
- curl_multi_init (3)
Protocol:
- *
- All
---
# NAME

View File

@ -10,7 +10,7 @@ See-also:
- curl_multi_init (3)
- curl_multi_socket (3)
Protocol:
- *
- All
---
# NAME

View File

@ -11,7 +11,7 @@ See-also:
- curl_multi_init (3)
- the hiperfifo.c example
Protocol:
- *
- All
---
# NAME

View File

@ -11,7 +11,7 @@ See-also:
- curl_multi_init (3)
- the hiperfifo.c example
Protocol:
- *
- All
---
# NAME

View File

@ -11,7 +11,7 @@ See-also:
- curl_multi_init (3)
- the hiperfifo.c example
Protocol:
- *
- All
---
# NAME

View File

@ -10,7 +10,7 @@ See-also:
- curl_url_strerror (3)
- libcurl-errors (3)
Protocol:
- *
- All
---
# NAME

View File

@ -10,7 +10,7 @@ See-also:
- curl_multi_setopt (3)
- curl_multi_socket (3)
Protocol:
- *
- All
---
# NAME

View File

@ -9,7 +9,7 @@ See-also:
- curl_multi_perform (3)
- curl_multi_poll (3)
Protocol:
- *
- All
---
# NAME

View File

@ -8,7 +8,7 @@ See-also:
- curl_multi_poll (3)
- curl_multi_wait (3)
Protocol:
- *
- All
---
# NAME

View File

@ -8,7 +8,7 @@ See-also:
- curl_share_init (3)
- curl_share_setopt (3)
Protocol:
- *
- All
---
# NAME

View File

@ -8,7 +8,7 @@ See-also:
- curl_share_cleanup (3)
- curl_share_setopt (3)
Protocol:
- *
- All
---
# NAME

View File

@ -8,7 +8,7 @@ See-also:
- curl_share_cleanup (3)
- curl_share_init (3)
Protocol:
- *
- All
---
# NAME

View File

@ -10,7 +10,7 @@ See-also:
- curl_url_strerror (3)
- libcurl-errors (3)
Protocol:
- *
- All
---
# NAME

View File

@ -7,7 +7,7 @@ Source: libcurl
See-also:
- curl_slist_free_all (3)
Protocol:
- *
- All
---
# NAME

View File

@ -7,7 +7,7 @@ Source: libcurl
See-also:
- curl_slist_append (3)
Protocol:
- *
- All
---
# NAME

View File

@ -8,7 +8,7 @@ See-also:
- strcasecmp (3)
- strcmp (3)
Protocol:
- *
- All
---
# NAME

View File

@ -8,7 +8,7 @@ See-also:
- strcasecmp (3)
- strcmp (3)
Protocol:
- *
- All
---
# NAME

View File

@ -10,7 +10,7 @@ See-also:
- curl_easy_unescape (3)
- curl_free (3)
Protocol:
- *
- All
---
# NAME

View File

@ -12,7 +12,7 @@ See-also:
- curl_url_set (3)
- curl_url_strerror (3)
Protocol:
- *
- All
---
# NAME

View File

@ -11,7 +11,7 @@ See-also:
- curl_url_get (3)
- curl_url_set (3)
Protocol:
- *
- All
---
# NAME

View File

@ -11,7 +11,7 @@ See-also:
- curl_url_get (3)
- curl_url_set (3)
Protocol:
- *
- All
---
# NAME

View File

@ -12,7 +12,7 @@ See-also:
- curl_url_set (3)
- curl_url_strerror (3)
Protocol:
- *
- All
---
# NAME

View File

@ -12,7 +12,7 @@ See-also:
- curl_url_get (3)
- curl_url_strerror (3)
Protocol:
- *
- All
---
# NAME

View File

@ -12,7 +12,7 @@ See-also:
- curl_url_set (3)
- libcurl-errors (3)
Protocol:
- *
- All
---
# NAME

View File

@ -7,7 +7,7 @@ Source: libcurl
See-also:
- curl_version_info (3)
Protocol:
- *
- All
---
# NAME

View File

@ -7,7 +7,7 @@ Source: libcurl
See-also:
- curl_version (3)
Protocol:
- *
- All
---
# NAME

View File

@ -12,7 +12,7 @@ See-also:
- libcurl-errors (3)
- libcurl-multi (3)
Protocol:
- *
- All
---
# NAME

View File

@ -7,7 +7,7 @@ Source: libcurl
See-also:
- libcurl-env (3)
Protocol:
- *
- All
---
# NAME

View File

@ -7,7 +7,7 @@ Source: libcurl
See-also:
- libcurl-env-dbg (3)
Protocol:
- *
- All
---
# NAME

View File

@ -13,7 +13,7 @@ See-also:
- curl_share_strerror (3)
- curl_url_strerror (3)
Protocol:
- *
- All
---
# NAME

View File

@ -9,7 +9,7 @@ See-also:
- libcurl-easy (3)
- libcurl-errors (3)
Protocol:
- *
- All
---
# NAME

View File

@ -7,7 +7,7 @@ Source: libcurl
See-also:
- libcurl-thread (3)
Protocol:
- *
- All
---
<!-- markdown-link-check-disable -->
# NAME

View File

@ -12,7 +12,7 @@ See-also:
- libcurl-errors (3)
- libcurl-multi (3)
Protocol:
- *
- All
---
# NAME

View File

@ -7,7 +7,7 @@ Source: libcurl
See-also:
- libcurl-security (3)
Protocol:
- *
- All
---
# NAME

View File

@ -10,7 +10,7 @@ See-also:
- libcurl-multi (3)
- libcurl-url (3)
Protocol:
- *
- All
---
# NAME

View File

@ -13,7 +13,7 @@ See-also:
- curl_url_set (3)
- curl_url_strerror (3)
Protocol:
- *
- All
---
# NAME

View File

@ -13,7 +13,7 @@ See-also:
- curl_ws_recv (3)
- curl_ws_send (3)
Protocol:
- *
- All
---
# NAME

View File

@ -10,7 +10,7 @@ See-also:
- libcurl-security (3)
- libcurl-thread (3)
Protocol:
- *
- All
---
# NAME

View File

@ -41,7 +41,7 @@ Title: libcurl-symbols
Section: 3
Source: libcurl
Protocol:
- *
- All
See-also:
- libcurl (3)
- libcurl-easy (3)

View File

@ -10,7 +10,7 @@ See-also:
- curl_easy_getinfo (3)
- curl_easy_setopt (3)
Protocol:
- *
- All
---
# NAME
@ -40,10 +40,6 @@ CURLOPT_CONNECT_ONLY(3), which skips the transfer phase.
CURLINFO_ACTIVESOCKET(3) was added as a replacement for
CURLINFO_LASTSOCKET(3) since that one is not working on all platforms.
# PROTOCOLS
All
# EXAMPLE
~~~c

View File

@ -9,7 +9,7 @@ See-also:
- curl_easy_getinfo (3)
- curl_easy_setopt (3)
Protocol:
- *
- All
---
# NAME
@ -37,10 +37,6 @@ When a redirect is followed, the time from each request is added together.
See also the TIMES overview in the curl_easy_getinfo(3) man page.
# PROTOCOLS
All
# EXAMPLE
~~~c

View File

@ -9,7 +9,7 @@ See-also:
- curl_easy_getinfo (3)
- curl_easy_setopt (3)
Protocol:
- *
- All
---
# NAME
@ -38,10 +38,6 @@ When a redirect is followed, the time from each request is added together.
See also the TIMES overview in the curl_easy_getinfo(3) man page.
# PROTOCOLS
All
# EXAMPLE
~~~c

View File

@ -40,10 +40,6 @@ This is a path identifying a single file containing CA certificates.
The **path** pointer is set to NULL if there is no default path.
# PROTOCOLS
All
# EXAMPLE
~~~c

View File

@ -43,10 +43,6 @@ This is a path identifying a directory.
The **path** pointer is set to NULL if there is no default path.
# PROTOCOLS
All
# EXAMPLE
~~~c

View File

@ -50,10 +50,6 @@ items with textual information in the format "name:content" such as
"Subject:Foo", "Issuer:Bar", etc. The items in each list varies depending on
the SSL backend and the certificate.
# PROTOCOLS
All TLS-based
# EXAMPLE
~~~c

View File

@ -36,10 +36,6 @@ gets a zero stored if the condition instead was met. This can also return 1 if
the server responded with a 304 HTTP status code, for example after sending a
custom "If-Match-*" header.
# PROTOCOLS
HTTP and some
# EXAMPLE
~~~c

View File

@ -9,7 +9,7 @@ See-also:
- curl_easy_getinfo (3)
- curl_easy_setopt (3)
Protocol:
- *
- All
---
# NAME
@ -33,10 +33,6 @@ When a redirect is followed, the time from each request is added together.
See also the TIMES overview in the curl_easy_getinfo(3) man page.
# PROTOCOLS
All
# EXAMPLE
~~~c

View File

@ -10,7 +10,7 @@ See-also:
- curl_easy_getinfo (3)
- curl_easy_setopt (3)
Protocol:
- *
- All
---
# NAME
@ -35,10 +35,6 @@ When a redirect is followed, the time from each request is added together.
See also the TIMES overview in the curl_easy_getinfo(3) man page.
# PROTOCOLS
All
# EXAMPLE
~~~c

View File

@ -9,7 +9,7 @@ See-also:
- curl_easy_getinfo (3)
- curl_easy_setopt (3)
Protocol:
- *
- All
---
# NAME
@ -34,10 +34,6 @@ The connection id is unique among all connections using the same
connection cache. This is implicitly the case for all connections in the
same multi handle.
# PROTOCOLS
All
# EXAMPLE
~~~c

View File

@ -9,7 +9,7 @@ See-also:
- curl_easy_getinfo (3)
- curl_easy_setopt (3)
Protocol:
- *
- All
---
# NAME
@ -34,10 +34,6 @@ is the value read from the Content-Length: field. Since 7.19.4, this returns
CURLINFO_CONTENT_LENGTH_DOWNLOAD_T(3) is a newer replacement that returns a more
sensible variable type.
# PROTOCOLS
HTTP(S)
# EXAMPLE
~~~c

View File

@ -31,10 +31,6 @@ Pass a pointer to a *curl_off_t* to receive the content-length of the
download. This is the value read from the Content-Length: field. Stores -1 if
the size is not known.
# PROTOCOLS
HTTP(S)
# EXAMPLE
~~~c

View File

@ -9,7 +9,7 @@ See-also:
- curl_easy_getinfo (3)
- curl_easy_setopt (3)
Protocol:
- *
- All
---
# NAME
@ -33,10 +33,6 @@ Pass a pointer to a double to receive the specified size of the upload. Since
CURLINFO_CONTENT_LENGTH_UPLOAD_T(3) is a newer replacement that returns a
more sensible variable type.
# PROTOCOLS
All
# EXAMPLE
~~~c

View File

@ -9,7 +9,7 @@ See-also:
- curl_easy_getinfo (3)
- curl_easy_setopt (3)
Protocol:
- *
- All
---
# NAME
@ -30,10 +30,6 @@ CURLcode curl_easy_getinfo(CURL *handle, CURLINFO_CONTENT_LENGTH_UPLOAD_T,
Pass a pointer to a *curl_off_t* to receive the specified size of the
upload. Stores -1 if the size is not known.
# PROTOCOLS
All
# EXAMPLE
~~~c

View File

@ -39,10 +39,6 @@ corresponding CURL handle.
The modern way to get this header from a response is to instead use the
curl_easy_header(3) function.
# PROTOCOLS
HTTP(S)
# EXAMPLE
~~~c

View File

@ -36,10 +36,6 @@ received) the 'struct curl_slist *' is made a NULL pointer.
Since 7.43.0 cookies that were imported in the Set-Cookie format without a
domain name are not exported by this option.
# PROTOCOLS
HTTP(S)
# EXAMPLE
~~~c

View File

@ -38,10 +38,6 @@ The **methodp** pointer is NULL or points to private memory. You MUST NOT
free - it gets freed when you call curl_easy_cleanup(3) on the
corresponding CURL handle.
# PROTOCOLS
HTTP(S)
# EXAMPLE
~~~c

View File

@ -35,10 +35,6 @@ The **urlp** pointer is NULL or points to private memory. You MUST NOT free
- it gets freed when you call curl_easy_cleanup(3) on the corresponding
CURL handle.
# PROTOCOLS
HTTP(S)
# EXAMPLE
~~~c

View File

@ -41,10 +41,6 @@ you this unconditionally gets a -1 back.
Consider using CURLINFO_FILETIME_T(3) to be able to extract dates beyond
the year 2038 on systems using 32 bit longs (Windows).
# PROTOCOLS
HTTP(S), FTP(S), SFTP
# EXAMPLE
~~~c

View File

@ -43,10 +43,6 @@ This option is an alternative to CURLINFO_FILETIME(3) to allow systems
with 32 bit long variables to extract dates outside of the 32bit timestamp
range.
# PROTOCOLS
HTTP(S), FTP(S), SFTP
# EXAMPLE
~~~c

View File

@ -34,10 +34,6 @@ The **path** pointer is NULL or points to private memory. You MUST NOT free
- it gets freed when you call curl_easy_cleanup(3) on the corresponding
CURL handle.
# PROTOCOLS
FTP(S) and SFTP
# EXAMPLE
~~~c

View File

@ -10,7 +10,7 @@ See-also:
- curl_easy_getinfo (3)
- curl_easy_setopt (3)
Protocol:
- *
- All
---
# NAME
@ -33,10 +33,6 @@ received. Measured in number of bytes.
The total includes the size of any received headers suppressed by
CURLOPT_SUPPRESS_CONNECT_HEADERS(3).
# PROTOCOLS
All
# EXAMPLE
~~~c

View File

@ -32,10 +32,6 @@ method(s) available according to the previous response. The meaning of the
bits is explained in the CURLOPT_HTTPAUTH(3) option for
curl_easy_setopt(3).
# PROTOCOLS
HTTP(S)
# EXAMPLE
~~~c

View File

@ -30,10 +30,6 @@ Pass a pointer to a long to receive the last received HTTP proxy response code
to a CONNECT request. The returned value is zero if no such response code was
available.
# PROTOCOLS
HTTP
# EXAMPLE
~~~c

Some files were not shown because too many files have changed in this diff Show More