docs: make each libcurl man specify protocol(s)

The mandatory header now has a mandatory list of protocols for which the
manpage is relevant.

Most man pages already has a "PROTOCOLS" section, but this introduces a
stricter way to specify the relevant protocols.

cd2nroff verifies that at least one protocol is mentioned (which can be
`*`).

This information is not used just yet, but A) the PROTOCOLS section can
now instead get generated and get a unified wording across all manpages
and B) this allows us to more reliably filter/search for protocol
specific manpages/options.

Closes #13166
This commit is contained in:
Daniel Stenberg 2024-03-21 11:50:20 +01:00
parent 98f67a6145
commit b935fd4a07
No known key found for this signature in database
GPG Key ID: 5CC908FDB71E12C2
498 changed files with 1117 additions and 2 deletions

View File

@ -67,6 +67,8 @@ Each curldown starts with a header with meta-data:
Title: CURLOPT_AWS_SIGV4
Section: 3
Source: libcurl
Protocol:
- HTTP
See-also:
- CURLOPT_HEADEROPT (3)
- CURLOPT_HTTPAUTH (3)
@ -75,6 +77,11 @@ Each curldown starts with a header with meta-data:
All curldown files *must* have all the headers present and at least one
`See-also:` entry specified.
If the man page is for section 3 (library related). The `Protocol` list must
contain at least one protocol, which can be `*` if the option is virtually for
everything. If `*` is used, it must be the only listed protocol. Recognized
protocols are either URL schemes (in uppercase) or `TLS`.
Following the header in the file, is the manual page using markdown-like
syntax:

View File

@ -10,6 +10,8 @@ See-also:
- curl_easy_reset (3)
- curl_multi_cleanup (3)
- curl_multi_remove_handle (3)
Protocol:
- *
---
# NAME

View File

@ -9,6 +9,8 @@ See-also:
- curl_easy_init (3)
- curl_easy_reset (3)
- curl_global_init (3)
Protocol:
- *
---
# NAME

View File

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

View File

@ -6,6 +6,8 @@ Section: 3
Source: libcurl
See-also:
- curl_easy_setopt (3)
Protocol:
- *
---
# NAME

View File

@ -10,6 +10,8 @@ See-also:
- curl_easy_nextheader (3)
- curl_easy_perform (3)
- libcurl-errors (3)
Protocol:
- HTTP
---
# NAME

View File

@ -11,6 +11,8 @@ See-also:
- curl_easy_reset (3)
- curl_global_init (3)
- curl_multi_init (3)
Protocol:
- *
---
# NAME

View File

@ -7,6 +7,8 @@ Source: libcurl
See-also:
- curl_easy_header (3)
- curl_easy_perform (3)
Protocol:
- HTTP
---
# NAME

View File

@ -8,6 +8,8 @@ See-also:
- curl_easy_option_by_name (3)
- curl_easy_option_next (3)
- curl_easy_setopt (3)
Protocol:
- *
---
# NAME

View File

@ -8,6 +8,8 @@ See-also:
- curl_easy_option_by_id (3)
- curl_easy_option_next (3)
- curl_easy_setopt (3)
Protocol:
- *
---
# NAME

View File

@ -8,6 +8,8 @@ See-also:
- curl_easy_option_by_id (3)
- curl_easy_option_by_name (3)
- curl_easy_setopt (3)
Protocol:
- *
---
# NAME

View File

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

View File

@ -10,6 +10,8 @@ See-also:
- curl_multi_add_handle (3)
- curl_multi_perform (3)
- libcurl-errors (3)
Protocol:
- *
---
# NAME

View File

@ -9,6 +9,8 @@ See-also:
- curl_easy_perform (3)
- curl_easy_send (3)
- curl_easy_setopt (3)
Protocol:
- *
---
# NAME

View File

@ -9,6 +9,8 @@ See-also:
- curl_easy_duphandle (3)
- curl_easy_init (3)
- curl_easy_setopt (3)
Protocol:
- *
---
# NAME

View File

@ -9,6 +9,8 @@ See-also:
- curl_easy_perform (3)
- curl_easy_recv (3)
- curl_easy_setopt (3)
Protocol:
- *
---
# NAME

View File

@ -13,6 +13,8 @@ See-also:
- curl_easy_option_next (3)
- curl_easy_reset (3)
- curl_multi_setopt (3)
Protocol:
- *
---
# NAME

View File

@ -9,6 +9,8 @@ See-also:
- curl_share_strerror (3)
- curl_url_strerror (3)
- libcurl-errors (3)
Protocol:
- *
---
# NAME

View File

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

View File

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

View File

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

View File

@ -8,6 +8,8 @@ See-also:
- curl_easy_setopt (3)
- curl_formfree (3)
- curl_mime_init (3)
Protocol:
- HTTP
---
# NAME

View File

@ -8,6 +8,8 @@ See-also:
- curl_formadd (3)
- curl_mime_free (3)
- curl_mime_init (3)
Protocol:
- HTTP
---
# NAME

View File

@ -7,6 +7,8 @@ Source: libcurl
See-also:
- curl_formadd (3)
- curl_mime_init (3)
Protocol:
- HTTP
---
# NAME

View File

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

View File

@ -9,6 +9,8 @@ See-also:
- CURLOPT_TIMEVALUE (3)
- curl_easy_escape (3)
- curl_easy_unescape (3)
Protocol:
- *
---
# NAME

View File

@ -6,6 +6,8 @@ Section: 3
Source: libcurl
See-also:
- getenv (3C)
Protocol:
- *
---
# NAME

View File

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

View File

@ -11,6 +11,8 @@ See-also:
- curl_global_sslset (3)
- curl_global_trace (3)
- libcurl (3)
Protocol:
- *
---
# NAME

View File

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

View File

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

View File

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

View File

@ -15,6 +15,10 @@ See-also:
- curl_mime_name (3)
- curl_mime_subparts (3)
- curl_mime_type (3)
Protocol:
- HTTP
- IMAP
- SMTP
---
# NAME

View File

@ -9,6 +9,10 @@ See-also:
- curl_mime_data_cb (3)
- curl_mime_name (3)
- curl_mime_type (3)
Protocol:
- HTTP
- IMAP
- SMTP
---
# NAME

View File

@ -9,6 +9,10 @@ See-also:
- curl_mime_addpart (3)
- curl_mime_data (3)
- curl_mime_name (3)
Protocol:
- HTTP
- IMAP
- SMTP
---
# NAME

View File

@ -8,6 +8,10 @@ See-also:
- curl_mime_addpart (3)
- curl_mime_headers (3)
- curl_mime_subparts (3)
Protocol:
- HTTP
- IMAP
- SMTP
---
# NAME

View File

@ -9,6 +9,10 @@ See-also:
- curl_mime_data (3)
- curl_mime_filename (3)
- curl_mime_name (3)
Protocol:
- HTTP
- IMAP
- SMTP
---
# NAME

View File

@ -8,6 +8,10 @@ See-also:
- curl_mime_addpart (3)
- curl_mime_data (3)
- curl_mime_filedata (3)
Protocol:
- HTTP
- IMAP
- SMTP
---
# NAME

View File

@ -7,6 +7,10 @@ Source: libcurl
See-also:
- curl_free (3)
- curl_mime_init (3)
Protocol:
- HTTP
- IMAP
- SMTP
---
# NAME

View File

@ -7,6 +7,10 @@ Source: libcurl
See-also:
- curl_mime_addpart (3)
- curl_mime_name (3)
Protocol:
- HTTP
- IMAP
- SMTP
---
# NAME

View File

@ -9,6 +9,10 @@ See-also:
- curl_mime_addpart (3)
- curl_mime_free (3)
- curl_mime_subparts (3)
Protocol:
- HTTP
- IMAP
- SMTP
---
# NAME

View File

@ -8,6 +8,10 @@ See-also:
- curl_mime_addpart (3)
- curl_mime_data (3)
- curl_mime_type (3)
Protocol:
- HTTP
- IMAP
- SMTP
---
# NAME

View File

@ -7,6 +7,10 @@ Source: libcurl
See-also:
- curl_mime_addpart (3)
- curl_mime_init (3)
Protocol:
- HTTP
- IMAP
- SMTP
---
# NAME

View File

@ -8,6 +8,10 @@ See-also:
- curl_mime_addpart (3)
- curl_mime_data (3)
- curl_mime_name (3)
Protocol:
- HTTP
- IMAP
- SMTP
---
# NAME

View File

@ -9,6 +9,8 @@ See-also:
- printf (3)
- sprintf (3)
- vprintf (3)
Protocol:
- *
---
# NAME

View File

@ -10,6 +10,8 @@ See-also:
- curl_multi_init (3)
- curl_multi_setopt (3)
- curl_multi_socket_action (3)
Protocol:
- *
---
# NAME

View File

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

View File

@ -9,6 +9,8 @@ See-also:
- curl_easy_init (3)
- curl_multi_get_handles (3)
- curl_multi_init (3)
Protocol:
- *
---
# NAME

View File

@ -11,6 +11,8 @@ See-also:
- curl_multi_timeout (3)
- curl_multi_wait (3)
- select (2)
Protocol:
- *
---
# NAME

View File

@ -9,6 +9,8 @@ See-also:
- curl_multi_cleanup (3)
- curl_multi_init (3)
- curl_multi_remove_handle (3)
Protocol:
- *
---
# NAME

View File

@ -8,6 +8,8 @@ See-also:
- curl_multi_cleanup (3)
- curl_multi_init (3)
- curl_multi_perform (3)
Protocol:
- *
---
# NAME

View File

@ -10,6 +10,8 @@ See-also:
- curl_multi_add_handle (3)
- curl_multi_cleanup (3)
- curl_multi_get_handles (3)
Protocol:
- *
---
# NAME

View File

@ -12,6 +12,8 @@ See-also:
- curl_multi_init (3)
- curl_multi_wait (3)
- libcurl-errors (3)
Protocol:
- *
---
# NAME

View File

@ -9,6 +9,8 @@ See-also:
- curl_multi_perform (3)
- curl_multi_wait (3)
- curl_multi_wakeup (3)
Protocol:
- *
---
# NAME

View File

@ -8,6 +8,8 @@ See-also:
- curl_multi_add_handle (3)
- curl_multi_cleanup (3)
- curl_multi_init (3)
Protocol:
- *
---
# NAME

View File

@ -9,6 +9,8 @@ See-also:
- curl_multi_info_read (3)
- curl_multi_init (3)
- curl_multi_socket (3)
Protocol:
- *
---
# NAME

View File

@ -10,6 +10,8 @@ See-also:
- curl_multi_info_read (3)
- curl_multi_init (3)
- the hiperfifo.c example
Protocol:
- *
---
# NAME

View File

@ -10,6 +10,8 @@ See-also:
- curl_multi_info_read (3)
- curl_multi_init (3)
- the hiperfifo.c example
Protocol:
- *
---
# NAME

View File

@ -10,6 +10,8 @@ See-also:
- curl_multi_info_read (3)
- curl_multi_init (3)
- the hiperfifo.c example
Protocol:
- *
---
# NAME

View File

@ -9,6 +9,8 @@ See-also:
- curl_share_strerror (3)
- curl_url_strerror (3)
- libcurl-errors (3)
Protocol:
- *
---
# NAME

View File

@ -9,6 +9,8 @@ See-also:
- curl_multi_info_read (3)
- curl_multi_setopt (3)
- curl_multi_socket (3)
Protocol:
- *
---
# NAME

View File

@ -8,6 +8,8 @@ See-also:
- curl_multi_fdset (3)
- curl_multi_perform (3)
- curl_multi_poll (3)
Protocol:
- *
---
# NAME

View File

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

View File

@ -7,6 +7,8 @@ Source: libcurl
See-also:
- CURLMOPT_PUSHFUNCTION (3)
- curl_pushheader_bynum (3)
Protocol:
- HTTP
---
# NAME

View File

@ -7,6 +7,8 @@ Source: libcurl
See-also:
- CURLMOPT_PUSHFUNCTION (3)
- curl_pushheader_byname (3)
Protocol:
- HTTP
---
# NAME

View File

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

View File

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

View File

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

View File

@ -9,6 +9,8 @@ See-also:
- curl_multi_strerror (3)
- curl_url_strerror (3)
- libcurl-errors (3)
Protocol:
- *
---
# NAME

View File

@ -6,6 +6,8 @@ Section: 3
Source: libcurl
See-also:
- curl_slist_free_all (3)
Protocol:
- *
---
# NAME

View File

@ -6,6 +6,8 @@ Section: 3
Source: libcurl
See-also:
- curl_slist_append (3)
Protocol:
- *
---
# NAME

View File

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

View File

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

View File

@ -9,6 +9,8 @@ See-also:
- curl_easy_escape (3)
- curl_easy_unescape (3)
- curl_free (3)
Protocol:
- *
---
# NAME

View File

@ -11,6 +11,8 @@ See-also:
- curl_url_get (3)
- curl_url_set (3)
- curl_url_strerror (3)
Protocol:
- *
---
# NAME

View File

@ -10,6 +10,8 @@ See-also:
- curl_url_dup (3)
- curl_url_get (3)
- curl_url_set (3)
Protocol:
- *
---
# NAME

View File

@ -10,6 +10,8 @@ See-also:
- curl_url_cleanup (3)
- curl_url_get (3)
- curl_url_set (3)
Protocol:
- *
---
# NAME

View File

@ -11,6 +11,8 @@ See-also:
- curl_url_dup (3)
- curl_url_set (3)
- curl_url_strerror (3)
Protocol:
- *
---
# NAME

View File

@ -11,6 +11,8 @@ See-also:
- curl_url_dup (3)
- curl_url_get (3)
- curl_url_strerror (3)
Protocol:
- *
---
# NAME

View File

@ -11,6 +11,8 @@ See-also:
- curl_url_get (3)
- curl_url_set (3)
- libcurl-errors (3)
Protocol:
- *
---
# NAME

View File

@ -6,6 +6,8 @@ Section: 3
Source: libcurl
See-also:
- curl_version_info (3)
Protocol:
- *
---
# NAME

View File

@ -6,6 +6,8 @@ Section: 3
Source: libcurl
See-also:
- curl_version (3)
Protocol:
- *
---
# NAME

View File

@ -10,6 +10,8 @@ See-also:
- curl_ws_recv (3)
- curl_ws_send (3)
- libcurl-ws (3)
Protocol:
- WS
---
# NAME

View File

@ -10,6 +10,8 @@ See-also:
- curl_easy_setopt (3)
- curl_ws_send (3)
- libcurl-ws (3)
Protocol:
- Ws
---
# NAME

View File

@ -10,6 +10,8 @@ See-also:
- curl_easy_setopt (3)
- curl_ws_recv (3)
- libcurl-ws (3)
Protocol:
- WS
---
# NAME

View File

@ -11,6 +11,8 @@ See-also:
- libcurl (3)
- libcurl-errors (3)
- libcurl-multi (3)
Protocol:
- *
---
# NAME

View File

@ -6,6 +6,8 @@ Section: 3
Source: libcurl
See-also:
- libcurl-env (3)
Protocol:
- *
---
# NAME

View File

@ -6,6 +6,8 @@ Section: 3
Source: libcurl
See-also:
- libcurl-env-dbg (3)
Protocol:
- *
---
# NAME

View File

@ -12,6 +12,8 @@ See-also:
- curl_multi_strerror (3)
- curl_share_strerror (3)
- curl_url_strerror (3)
Protocol:
- *
---
# NAME

View File

@ -8,6 +8,8 @@ See-also:
- libcurl (3)
- libcurl-easy (3)
- libcurl-errors (3)
Protocol:
- *
---
# NAME

View File

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

View File

@ -11,6 +11,8 @@ See-also:
- libcurl-easy (3)
- libcurl-errors (3)
- libcurl-multi (3)
Protocol:
- *
---
# NAME

View File

@ -6,6 +6,8 @@ Section: 3
Source: libcurl
See-also:
- libcurl-security (3)
Protocol:
- *
---
# NAME

View File

@ -9,6 +9,8 @@ See-also:
- libcurl-errors (3)
- libcurl-multi (3)
- libcurl-url (3)
Protocol:
- *
---
# NAME

View File

@ -12,6 +12,8 @@ See-also:
- curl_url_get (3)
- curl_url_set (3)
- curl_url_strerror (3)
Protocol:
- *
---
# NAME

View File

@ -12,6 +12,8 @@ See-also:
- curl_ws_meta (3)
- curl_ws_recv (3)
- curl_ws_send (3)
Protocol:
- *
---
# NAME

View File

@ -9,6 +9,8 @@ See-also:
- libcurl-multi (3)
- libcurl-security (3)
- libcurl-thread (3)
Protocol:
- *
---
# NAME

View File

@ -40,6 +40,8 @@ SPDX-License-Identifier: curl
Title: libcurl-symbols
Section: 3
Source: libcurl
Protocol:
- *
See-also:
- libcurl (3)
- libcurl-easy (3)

View File

@ -9,6 +9,8 @@ See-also:
- CURLOPT_CONNECT_ONLY (3)
- curl_easy_getinfo (3)
- curl_easy_setopt (3)
Protocol:
- *
---
# NAME

View File

@ -8,6 +8,8 @@ See-also:
- CURLINFO_APPCONNECT_TIME_T (3)
- curl_easy_getinfo (3)
- curl_easy_setopt (3)
Protocol:
- *
---
# NAME

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