curldown: make 'added-in:' a mandatory header field

- generate AVAILABILITY manpage sections automatically - for consistent
  wording

- allows us to double-check against other documumentation (symbols-in-versions
  etc)

- enables proper automation/scripting based on this data

- lots of them were wrong or missing in the manpages

- several of them repeated (sometimes mismatching) backend support info

Add test 1488 to verify "added-in" version numbers against
symbols-in-versions.

Closes #14217
This commit is contained in:
Daniel Stenberg
2024-07-18 00:51:50 +02:00
parent d8696dc8c0
commit 8c1d9378ac
508 changed files with 875 additions and 1883 deletions

View File

@@ -80,6 +80,7 @@ Each curldown starts with a header with meta-data:
- CURLOPT_HTTPAUTH (3)
TLS-backend:
- [name]
Added-in: [version or "n/a"]
---
All curldown files *must* have all the headers present and at least one

View File

@@ -6,6 +6,7 @@ Section: 1
Source: curl-config
See-also:
- curl (1)
Added-in: 7.7.2
---
# NAME

View File

@@ -12,6 +12,7 @@ See-also:
- curl_multi_remove_handle (3)
Protocol:
- All
Added-in: 7.1
---
# NAME
@@ -69,10 +70,6 @@ int main(void)
}
~~~
# AVAILABILITY
Added in 7.1
# RETURN VALUE
None

View File

@@ -11,6 +11,7 @@ See-also:
- curl_global_init (3)
Protocol:
- All
Added-in: 7.9
---
# NAME
@@ -64,10 +65,6 @@ int main(void)
}
~~~
# AVAILABILITY
Added in 7.9
# RETURN VALUE
If this function returns NULL, something went wrong and no valid handle was

View File

@@ -10,6 +10,7 @@ See-also:
- curl_url_get (3)
Protocol:
- All
Added-in: 7.15.4
---
# NAME
@@ -80,10 +81,6 @@ int main(void)
}
~~~
# AVAILABILITY
Added in 7.15.4 and replaces the old curl_escape(3) function.
# RETURN VALUE
A pointer to a null-terminated string or NULL if it failed.

View File

@@ -8,6 +8,7 @@ See-also:
- curl_easy_setopt (3)
Protocol:
- All
Added-in: 7.4.1
---
# NAME
@@ -410,10 +411,6 @@ int main(void)
}
~~~
# AVAILABILITY
Added in 7.4.1
# RETURN VALUE
If the operation was successful, CURLE_OK is returned. Otherwise an

View File

@@ -12,6 +12,7 @@ See-also:
- libcurl-errors (3)
Protocol:
- HTTP
Added-in: 7.83.0
---
# NAME
@@ -153,10 +154,6 @@ int main(void)
}
~~~
# AVAILABILITY
Added in 7.83.0. Officially supported since 7.84.0.
# RETURN VALUE
This function returns a CURLHcode indicating success or error.

View File

@@ -13,6 +13,7 @@ See-also:
- curl_multi_init (3)
Protocol:
- All
Added-in: 7.1
---
# NAME
@@ -65,10 +66,6 @@ int main(void)
}
~~~
# AVAILABILITY
Always
# RETURN VALUE
If this function returns NULL, something went wrong and you cannot use the

View File

@@ -9,6 +9,7 @@ See-also:
- curl_easy_perform (3)
Protocol:
- HTTP
Added-in: 7.83.0
---
# NAME
@@ -89,10 +90,6 @@ int main(void)
}
~~~
# AVAILABILITY
Added in 7.83.0. Officially supported since 7.84.0.
# RETURN VALUE
This function returns the next header, or NULL when there are no more

View File

@@ -10,6 +10,7 @@ See-also:
- curl_easy_setopt (3)
Protocol:
- All
Added-in: 7.73.0
---
# NAME
@@ -47,10 +48,6 @@ int main(void)
}
~~~
# AVAILABILITY
This function was added in libcurl 7.73.0
# RETURN VALUE
A pointer to the *curl_easyoption* struct for the option or NULL.

View File

@@ -10,6 +10,7 @@ See-also:
- curl_easy_setopt (3)
Protocol:
- All
Added-in: 7.73.0
---
# NAME
@@ -46,10 +47,6 @@ int main(void)
}
~~~
# AVAILABILITY
This function was added in libcurl 7.73.0
# RETURN VALUE
A pointer to the *curl_easyoption* struct for the option or NULL.

View File

@@ -10,6 +10,7 @@ See-also:
- curl_easy_setopt (3)
Protocol:
- All
Added-in: 7.73.0
---
# NAME
@@ -81,10 +82,6 @@ int main(void)
}
~~~
# AVAILABILITY
This function was added in libcurl 7.73.0
# RETURN VALUE
A pointer to the *curl_easyoption* struct for the next option or NULL if

View File

@@ -9,6 +9,7 @@ See-also:
- curl_easy_reset (3)
Protocol:
- All
Added-in: 7.18.0
---
# NAME
@@ -131,10 +132,6 @@ size worth of data that curl cannot stop but instead needs to cache while the
transfer is paused. This means that if a window size of 64 MB is used, libcurl
might end up having to cache 64 MB of data.
# AVAILABILITY
Added in 7.18.0.
# RETURN VALUE
CURLE_OK (zero) means that the option was set properly, and a non-zero return

View File

@@ -12,6 +12,7 @@ See-also:
- libcurl-errors (3)
Protocol:
- All
Added-in: 7.1
---
# NAME
@@ -73,10 +74,6 @@ int main(void)
}
~~~
# AVAILABILITY
Always
# RETURN VALUE
CURLE_OK (0) means everything was OK, non-zero means an error occurred as

View File

@@ -11,6 +11,7 @@ See-also:
- curl_easy_setopt (3)
Protocol:
- All
Added-in: 7.18.2
---
# NAME
@@ -85,10 +86,6 @@ int main(void)
}
~~~
# AVAILABILITY
Added in 7.18.2.
# RETURN VALUE
On success, returns **CURLE_OK**, stores the received data into

View File

@@ -11,6 +11,7 @@ See-also:
- curl_easy_setopt (3)
Protocol:
- All
Added-in: 7.12.1
---
# NAME
@@ -49,10 +50,6 @@ int main(void)
}
~~~
# AVAILABILITY
This function was added in libcurl 7.12.1
# RETURN VALUE
Nothing

View File

@@ -11,6 +11,7 @@ See-also:
- curl_easy_setopt (3)
Protocol:
- All
Added-in: 7.18.2
---
# NAME
@@ -78,10 +79,6 @@ int main(void)
}
~~~
# AVAILABILITY
Added in 7.18.2.
# RETURN VALUE
On success, returns **CURLE_OK** and stores the number of bytes actually

View File

@@ -15,6 +15,7 @@ See-also:
- curl_multi_setopt (3)
Protocol:
- All
Added-in: 7.1
---
# NAME
@@ -1341,12 +1342,6 @@ int main(void)
}
~~~
# ENCRYPTED CLIENT HELLO OPTIONS
# AVAILABILITY
Always
# RETURN VALUE
*CURLE_OK* (zero) means that the option was set properly, non-zero means an

View File

@@ -11,6 +11,7 @@ See-also:
- libcurl-errors (3)
Protocol:
- All
Added-in: 7.12.0
---
# NAME
@@ -52,10 +53,6 @@ int main(void)
}
~~~
# AVAILABILITY
This function was added in libcurl 7.12.0
# RETURN VALUE
A pointer to a null-terminated string.

View File

@@ -9,6 +9,7 @@ See-also:
- curl_url_get (3)
Protocol:
- All
Added-in: 7.15.4
---
# NAME
@@ -66,10 +67,6 @@ int main(void)
}
~~~
# AVAILABILITY
Added in 7.15.4 and replaces the old curl_unescape(3) function.
# RETURN VALUE
A pointer to a null-terminated string or NULL if it failed.

View File

@@ -9,6 +9,7 @@ See-also:
- CURLOPT_TCP_KEEPIDLE (3)
Protocol:
- All
Added-in: 7.62.0
---
# NAME
@@ -68,10 +69,6 @@ int main(void)
}
~~~
# AVAILABILITY
Added in 7.62.0.
# RETURN VALUE
On success, returns **CURLE_OK**.

View File

@@ -9,6 +9,7 @@ See-also:
- curl_unescape (3)
Protocol:
- All
Added-in: 7.1
---
# NAME
@@ -50,7 +51,7 @@ int main(void)
}
~~~
# AVAILABILITY
# HISTORY
Since 7.15.4, curl_easy_escape(3) should be used. This function might be
removed in a future release.

View File

@@ -10,6 +10,7 @@ See-also:
- curl_mime_init (3)
Protocol:
- HTTP
Added-in: 7.1
---
# NAME
@@ -299,7 +300,7 @@ int main(void)
}
~~~
# AVAILABILITY
# DEPRECATED
Deprecated in 7.56.0. Before this release, field names were allowed to contain
zero-valued bytes. The pseudo-filename "-" to read stdin is discouraged

View File

@@ -10,6 +10,7 @@ See-also:
- curl_mime_init (3)
Protocol:
- HTTP
Added-in: 7.1
---
# NAME
@@ -69,7 +70,7 @@ int main(void)
}
~~~
# AVAILABILITY
# DEPRECATED
Deprecated in 7.56.0.

View File

@@ -9,6 +9,7 @@ See-also:
- curl_mime_init (3)
Protocol:
- HTTP
Added-in: 7.15.5
---
# NAME
@@ -26,9 +27,11 @@ int curl_formget(struct curl_httppost * form, void *userp,
# DESCRIPTION
The form API (including this function) is deprecated since libcurl 7.56.0.
curl_formget() serializes data previously built with curl_formadd(3). It
accepts a void pointer as second argument named *userp* which is passed as
the first argument to the curl_formget_callback function.
accepts a void pointer as second argument named *userp* which is passed as the
first argument to the curl_formget_callback function.
~~~c
typedef size_t (*curl_formget_callback)(void *userp, const char *buf,
@@ -40,9 +43,8 @@ character buffer passed to the callback must not be freed. The callback should
return the buffer length passed to it on success.
If the **CURLFORM_STREAM** option is used in the formpost, it prevents
curl_formget(3) from working until you have performed the actual HTTP
request. This, because first then does libcurl known which actual read
callback to use!
curl_formget(3) from working until you have performed the actual HTTP request.
This, because first then does libcurl known which actual read callback to use!
# EXAMPLE
@@ -64,11 +66,6 @@ size_t print_httppost(struct curl_httppost *post)
}
~~~
# AVAILABILITY
This function was added in libcurl 7.15.5. The form API is deprecated in
libcurl 7.56.0.
# RETURN VALUE
0 means everything was OK, non-zero means an error occurred

View File

@@ -9,6 +9,7 @@ See-also:
- curl_easy_unescape (3)
Protocol:
- All
Added-in: 7.1
---
# NAME
@@ -45,10 +46,6 @@ int main(void)
}
~~~
# AVAILABILITY
Always
# RETURN VALUE
None

View File

@@ -11,6 +11,7 @@ See-also:
- curl_easy_unescape (3)
Protocol:
- All
Added-in: 7.1
---
# NAME
@@ -113,10 +114,6 @@ RFC 1036) and ANSI C's *asctime()* format.
These formats are the only ones RFC 7231 says HTTP applications may use.
# AVAILABILITY
Always
# RETURN VALUE
This function returns -1 when it fails to parse the date string. Otherwise it

View File

@@ -8,6 +8,7 @@ See-also:
- getenv (3C)
Protocol:
- All
Added-in: 7.1
---
# NAME
@@ -43,10 +44,6 @@ int main(void)
}
~~~
# AVAILABILITY
Always
# RETURN VALUE
A pointer to a null-terminated string or NULL if it failed to find the

View File

@@ -10,6 +10,7 @@ See-also:
- libcurl-thread (3)
Protocol:
- All
Added-in: 7.8
---
# NAME
@@ -72,10 +73,6 @@ int main(void)
}
~~~
# AVAILABILITY
Added in 7.8
# RETURN VALUE
None

View File

@@ -13,6 +13,7 @@ See-also:
- libcurl (3)
Protocol:
- All
Added-in: 7.8
---
# NAME
@@ -122,10 +123,6 @@ int main(void)
}
~~~
# AVAILABILITY
Added in 7.8
# RETURN VALUE
If this function returns non-zero, something went wrong and you cannot use the

View File

@@ -9,6 +9,7 @@ See-also:
- curl_global_init (3)
Protocol:
- All
Added-in: 7.12.0
---
# NAME
@@ -87,10 +88,6 @@ int main(void)
}
~~~
# AVAILABILITY
Added in 7.12.0
# RETURN VALUE
CURLE_OK (0) means everything was OK, non-zero means an error occurred as

View File

@@ -9,6 +9,7 @@ See-also:
- libcurl (3)
Protocol:
- All
Added-in: 7.56.0
---
# NAME
@@ -119,11 +120,6 @@ int main(void)
}
~~~
# AVAILABILITY
This function was added in libcurl 7.56.0. Before this version, there was no
support for choosing SSL backends at runtime.
# RETURN VALUE
If this function returns *CURLSSLSET_OK*, the backend was successfully

View File

@@ -9,6 +9,7 @@ See-also:
- libcurl (3)
Protocol:
- All
Added-in: 8.3
---
# NAME
@@ -131,10 +132,6 @@ of an enabled component appears at the beginning in brackets.
...
~~~
# AVAILABILITY
Added in 8.3
# RETURN VALUE
If this function returns non-zero, something went wrong and the configuration

View File

@@ -19,6 +19,7 @@ Protocol:
- HTTP
- IMAP
- SMTP
Added-in: 7.56.0
---
# NAME
@@ -65,10 +66,6 @@ int main(void)
}
~~~
# AVAILABILITY
As long as at least one of HTTP, SMTP or IMAP is enabled. Added in 7.56.0.
# RETURN VALUE
A mime part structure handle, or NULL upon failure.

View File

@@ -13,6 +13,7 @@ Protocol:
- HTTP
- IMAP
- SMTP
Added-in: 7.56.0
---
# NAME
@@ -71,10 +72,6 @@ int main(void)
}
~~~
# AVAILABILITY
As long as at least one of HTTP, SMTP or IMAP is enabled. Added in 7.56.0.
# RETURN VALUE
CURLE_OK or a CURL error code upon failure.

View File

@@ -13,6 +13,7 @@ Protocol:
- HTTP
- IMAP
- SMTP
Added-in: 7.56.0
---
# NAME
@@ -163,10 +164,6 @@ int main(void)
}
~~~
# AVAILABILITY
As long as at least one of HTTP, SMTP or IMAP is enabled. Added in 7.56.0.
# RETURN VALUE
CURLE_OK or a CURL error code upon failure.

View File

@@ -12,6 +12,7 @@ Protocol:
- HTTP
- IMAP
- SMTP
Added-in: 7.56.0
---
# NAME
@@ -95,10 +96,6 @@ int main(void)
}
~~~
# AVAILABILITY
As long as at least one of HTTP, SMTP or IMAP is enabled. Added in 7.56.0.
# RETURN VALUE
CURLE_OK or a CURL error code upon failure.

View File

@@ -13,6 +13,7 @@ Protocol:
- HTTP
- IMAP
- SMTP
Added-in: 7.56.0
---
# NAME
@@ -80,10 +81,6 @@ int main(void)
}
~~~
# AVAILABILITY
As long as at least one of HTTP, SMTP or IMAP is enabled. Added in 7.56.0.
# RETURN VALUE
CURLE_OK or a CURL error code upon failure. CURLE_READ_ERROR is only an

View File

@@ -12,6 +12,7 @@ Protocol:
- HTTP
- IMAP
- SMTP
Added-in: 7.56.0
---
# NAME
@@ -74,10 +75,6 @@ int main(void)
}
~~~
# AVAILABILITY
As long as at least one of HTTP, SMTP or IMAP is enabled. Added in 7.56.0.
# RETURN VALUE
CURLE_OK or a CURL error code upon failure.

View File

@@ -11,6 +11,7 @@ Protocol:
- HTTP
- IMAP
- SMTP
Added-in: 7.56.0
---
# NAME
@@ -60,10 +61,6 @@ int main(void)
}
~~~
# AVAILABILITY
As long as at least one of HTTP, SMTP or IMAP is enabled. Added in 7.56.0.
# RETURN VALUE
None

View File

@@ -11,6 +11,7 @@ Protocol:
- HTTP
- IMAP
- SMTP
Added-in: 7.56.0
---
# NAME
@@ -73,10 +74,6 @@ int main(void)
}
~~~
# AVAILABILITY
As long as at least one of HTTP, SMTP or IMAP is enabled. Added in 7.56.0.
# RETURN VALUE
CURLE_OK or a CURL error code upon failure.

View File

@@ -13,6 +13,7 @@ Protocol:
- HTTP
- IMAP
- SMTP
Added-in: 7.56.0
---
# NAME
@@ -67,10 +68,6 @@ int main(void)
}
~~~
# AVAILABILITY
As long as at least one of HTTP, SMTP or IMAP is enabled. Added in 7.56.0.
# RETURN VALUE
A mime struct handle, or NULL upon failure.

View File

@@ -12,6 +12,7 @@ Protocol:
- HTTP
- IMAP
- SMTP
Added-in: 7.56.0
---
# NAME
@@ -62,10 +63,6 @@ int main(void)
}
~~~
# AVAILABILITY
As long as at least one of HTTP, SMTP or IMAP is enabled. Added in 7.56.0.
# RETURN VALUE
CURLE_OK or a CURL error code upon failure.

View File

@@ -11,6 +11,7 @@ Protocol:
- HTTP
- IMAP
- SMTP
Added-in: 7.56.0
---
# NAME
@@ -78,10 +79,6 @@ int main(void)
}
~~~
# AVAILABILITY
As long as at least one of HTTP, SMTP or IMAP is enabled. Added in 7.56.0.
# RETURN VALUE
CURLE_OK or a CURL error code upon failure.

View File

@@ -12,6 +12,7 @@ Protocol:
- HTTP
- IMAP
- SMTP
Added-in: 7.56.0
---
# NAME
@@ -81,10 +82,6 @@ int main(void)
}
~~~
# AVAILABILITY
As long as at least one of HTTP, SMTP or IMAP is enabled. Added in 7.56.0.
# RETURN VALUE
CURLE_OK or a CURL error code upon failure.

View File

@@ -11,6 +11,7 @@ See-also:
- vprintf (3)
Protocol:
- All
Added-in: 7.1
---
# NAME
@@ -275,11 +276,6 @@ int main(void)
}
~~~
# AVAILABILITY
These functions might be removed from the public libcurl API in the future. Do
not use them in new programs or projects.
# RETURN VALUE
The **curl_maprintf** and **curl_mvaprintf** functions return a pointer to

View File

@@ -12,6 +12,7 @@ See-also:
- curl_multi_socket_action (3)
Protocol:
- All
Added-in: 7.9.6
---
# NAME
@@ -81,10 +82,6 @@ int main(void)
}
~~~
# AVAILABILITY
Added in 7.9.6
# RETURN VALUE
CURLMcode type, general libcurl multi interface error code.

View File

@@ -9,6 +9,7 @@ See-also:
- curl_multi_socket_action (3)
Protocol:
- All
Added-in: 7.15.5
---
# NAME
@@ -63,14 +64,6 @@ int main(void)
}
~~~
# AVAILABILITY
Added in 7.15.5
# RETURN VALUE
The standard CURLMcode for multi interface error codes.
# TYPICAL USAGE
In a typical application you allocate a struct or at least use some kind of
@@ -78,6 +71,10 @@ semi-dynamic data for each socket that we must wait for action on when using
the curl_multi_socket_action(3) approach.
When our socket-callback gets called by libcurl and we get to know about yet
another socket to wait for, we can use curl_multi_assign(3) to point out
the particular data so that when we get updates about this same socket again,
we do not have to find the struct associated with this socket by ourselves.
another socket to wait for, we can use curl_multi_assign(3) to point out the
particular data so that when we get updates about this same socket again, we
do not have to find the struct associated with this socket by ourselves.
# RETURN VALUE
The standard CURLMcode for multi interface error codes.

View File

@@ -11,6 +11,7 @@ See-also:
- curl_multi_init (3)
Protocol:
- All
Added-in: 7.9.6
---
# NAME
@@ -57,10 +58,6 @@ int main(void)
}
~~~
# AVAILABILITY
Added in 7.9.6
# RETURN VALUE
CURLMcode type, general libcurl multi interface error code. On success,

View File

@@ -14,6 +14,7 @@ See-also:
- select (2)
Protocol:
- All
Added-in: 7.9.6
---
# NAME
@@ -112,10 +113,6 @@ int main(void)
}
~~~
# AVAILABILITY
Added in 7.9.6
# RETURN VALUE
**CURLMcode** type, general libcurl multi interface error code. See

View File

@@ -11,6 +11,7 @@ See-also:
- curl_multi_remove_handle (3)
Protocol:
- All
Added-in: 8.4.0
---
# NAME
@@ -70,10 +71,6 @@ int main(void)
}
~~~
# AVAILABILITY
Added in 8.4.0
# RETURN VALUE
Returns NULL on failure. Otherwise it returns a pointer to an allocated array.

View File

@@ -10,6 +10,7 @@ See-also:
- curl_multi_perform (3)
Protocol:
- All
Added-in: 7.9.6
---
# NAME
@@ -93,10 +94,6 @@ int main(void)
}
~~~
# AVAILABILITY
Added in 7.9.6
# RETURN VALUE
A pointer to a filled-in struct, or NULL if it failed or ran out of

View File

@@ -12,6 +12,7 @@ See-also:
- curl_multi_get_handles (3)
Protocol:
- All
Added-in: 7.9.6
---
# NAME
@@ -49,10 +50,6 @@ int main(void)
}
~~~
# AVAILABILITY
Added in 7.9.6
# RETURN VALUE
If this function returns NULL, something went wrong and you cannot use the

View File

@@ -14,6 +14,7 @@ See-also:
- libcurl-errors (3)
Protocol:
- All
Added-in: 7.9.6
---
# NAME
@@ -88,10 +89,6 @@ int main(void)
}
~~~
# AVAILABILITY
Added in 7.9.6
# RETURN VALUE
CURLMcode type, general libcurl multi interface error code.

View File

@@ -11,6 +11,7 @@ See-also:
- curl_multi_wakeup (3)
Protocol:
- All
Added-in: 7.66.0
---
# NAME
@@ -132,10 +133,6 @@ int main(void)
}
~~~
# AVAILABILITY
Added in 7.66.0.
# RETURN VALUE
CURLMcode type, general libcurl multi interface error code. See

View File

@@ -10,6 +10,7 @@ See-also:
- curl_multi_init (3)
Protocol:
- All
Added-in: 7.9.6
---
# NAME
@@ -66,10 +67,6 @@ int main(void)
}
~~~
# AVAILABILITY
Added in 7.9.6
# RETURN VALUE
CURLMcode type, general libcurl multi interface error code.

View File

@@ -11,6 +11,7 @@ See-also:
- curl_multi_socket (3)
Protocol:
- All
Added-in: 7.15.4
---
# NAME
@@ -117,10 +118,6 @@ int main(void)
}
~~~
# AVAILABILITY
Added in 7.15.4
# RETURN VALUE
The standard CURLMcode for multi interface error codes. Note that it returns a

View File

@@ -12,6 +12,7 @@ See-also:
- the hiperfifo.c example
Protocol:
- All
Added-in: 7.15.4
---
# NAME
@@ -71,10 +72,7 @@ int main(void)
}
~~~
# AVAILABILITY
This function was added in libcurl 7.15.4, and is deemed stable since
7.16.0.
# DEPRECATED
curl_multi_socket(3) is deprecated, use curl_multi_socket_action(3) instead!

View File

@@ -12,6 +12,7 @@ See-also:
- the hiperfifo.c example
Protocol:
- All
Added-in: 7.15.4
---
# NAME
@@ -112,10 +113,6 @@ int main(void)
}
~~~
# AVAILABILITY
This function was added in libcurl 7.15.4, and is deemed stable since 7.16.0.
# RETURN VALUE
CURLMcode type, general libcurl multi interface error code. See

View File

@@ -1,7 +1,7 @@
---
c: Copyright (C) Daniel Stenberg, <daniel@haxx.se>, et al.
SPDX-License-Identifier: curl
Title: curl_multi_socket
Title: curl_multi_socket_all
Section: 3
Source: libcurl
See-also:
@@ -12,6 +12,7 @@ See-also:
- the hiperfifo.c example
Protocol:
- All
Added-in: 7.15.4
---
# NAME
@@ -52,13 +53,6 @@ int main(void)
}
~~~
# AVAILABILITY
This function was added in libcurl 7.15.4, and is deemed stable since 7.16.0.
curl_multi_socket_all(3) is deprecated, use
curl_multi_socket_action(3) instead!
# RETURN VALUE
CURLMcode type, general libcurl multi interface error code.

View File

@@ -11,6 +11,7 @@ See-also:
- libcurl-errors (3)
Protocol:
- All
Added-in: 7.12.0
---
# NAME
@@ -44,10 +45,6 @@ int main(void)
}
~~~
# AVAILABILITY
This function was added in libcurl 7.12.0
# RETURN VALUE
A pointer to a null-terminated string.

View File

@@ -11,6 +11,7 @@ See-also:
- curl_multi_socket (3)
Protocol:
- All
Added-in: 7.15.4
---
# NAME
@@ -82,10 +83,6 @@ out which sockets to wait for by calling curl_multi_fdset(3).
When there is activity or timeout, call curl_multi_perform(3) and then
loop - until all transfers are complete.
# AVAILABILITY
This function was added in libcurl 7.15.4.
# RETURN VALUE
The standard CURLMcode for multi interface error codes.

View File

@@ -10,6 +10,7 @@ See-also:
- curl_multi_poll (3)
Protocol:
- All
Added-in: 7.28.0
---
# NAME
@@ -113,10 +114,6 @@ int main(void)
}
~~~
# AVAILABILITY
This function was added in libcurl 7.28.0.
# RETURN VALUE
CURLMcode type, general libcurl multi interface error code. See

View File

@@ -11,6 +11,7 @@ See-also:
- curl_multi_fdset (3)
Protocol:
- All
Added-in: 8.8.0
---
# NAME
@@ -99,10 +100,6 @@ int main(void)
}
~~~
# AVAILABILITY
Added in 8.8.0
# RETURN VALUE
**CURLMcode** type, general libcurl multi interface error code. See

View File

@@ -9,6 +9,7 @@ See-also:
- curl_multi_wait (3)
Protocol:
- All
Added-in: 7.68.0
---
# NAME
@@ -84,10 +85,6 @@ int main(void)
}
~~~
# AVAILABILITY
Added in 7.68.0
# RETURN VALUE
CURLMcode type, general libcurl multi interface error code.

View File

@@ -9,6 +9,7 @@ See-also:
- curl_pushheader_bynum (3)
Protocol:
- HTTP
Added-in: 7.44.0
---
# NAME
@@ -75,10 +76,6 @@ int main(void)
}
~~~
# AVAILABILITY
Added in 7.44.0
# RETURN VALUE
Returns a pointer to the header field content or NULL.

View File

@@ -9,6 +9,7 @@ See-also:
- curl_pushheader_byname (3)
Protocol:
- HTTP
Added-in: 7.44.0
---
# NAME
@@ -62,10 +63,6 @@ int main(void)
}
~~~
# AVAILABILITY
Added in 7.44.0
# RETURN VALUE
Returns a pointer to the header field content or NULL.

View File

@@ -9,6 +9,7 @@ See-also:
- curl_share_setopt (3)
Protocol:
- All
Added-in: 7.10
---
# NAME
@@ -44,10 +45,6 @@ int main(void)
}
~~~
# AVAILABILITY
Added in 7.10
# RETURN VALUE
CURLSHE_OK (zero) means that the option was set properly, non-zero means an

View File

@@ -9,6 +9,7 @@ See-also:
- curl_share_setopt (3)
Protocol:
- All
Added-in: 7.10
---
# NAME
@@ -48,10 +49,6 @@ int main(void)
}
~~~
# AVAILABILITY
Added in 7.10
# RETURN VALUE
If this function returns NULL, something went wrong (out of memory, etc.)

View File

@@ -9,6 +9,7 @@ See-also:
- curl_share_init (3)
Protocol:
- All
Added-in: 7.10
---
# NAME
@@ -62,10 +63,6 @@ int main(void)
}
~~~
# AVAILABILITY
Added in 7.10
# RETURN VALUE
CURLSHE_OK (zero) means that the option was set properly, non-zero means an

View File

@@ -11,6 +11,7 @@ See-also:
- libcurl-errors (3)
Protocol:
- All
Added-in: 7.12.0
---
# NAME
@@ -43,10 +44,6 @@ int main(void)
}
~~~
# AVAILABILITY
This function was added in libcurl 7.12.0
# RETURN VALUE
A pointer to a null-terminated string.

View File

@@ -8,6 +8,7 @@ See-also:
- curl_slist_free_all (3)
Protocol:
- All
Added-in: 7.1
---
# NAME
@@ -65,10 +66,6 @@ int main(void)
}
~~~
# AVAILABILITY
Always
# RETURN VALUE
A null pointer is returned if anything went wrong, otherwise the new list

View File

@@ -8,6 +8,7 @@ See-also:
- curl_slist_append (3)
Protocol:
- All
Added-in: 7.1
---
# NAME
@@ -51,10 +52,6 @@ int main(void)
}
~~~
# AVAILABILITY
Always
# RETURN VALUE
Nothing.

View File

@@ -10,6 +10,7 @@ See-also:
- strcmp (3)
Protocol:
- All
Added-in: 7.1
---
# NAME
@@ -49,10 +50,6 @@ int main(int argc, char **argv)
}
~~~
# AVAILABILITY
Always
# RETURN VALUE
Non-zero if the strings are identical. Zero if they are not.

View File

@@ -1,7 +1,7 @@
---
c: Copyright (C) Daniel Stenberg, <daniel@haxx.se>, et al.
SPDX-License-Identifier: curl
Title: curl_strequal
Title: curl_strnequal
Section: 3
Source: libcurl
See-also:
@@ -10,6 +10,7 @@ See-also:
- strcmp (3)
Protocol:
- All
Added-in: 7.1
---
# NAME
@@ -52,10 +53,6 @@ int main(int argc, char **argv)
}
~~~
# AVAILABILITY
Always
# RETURN VALUE
Non-zero if the strings are identical. Zero if they are not.

View File

@@ -11,6 +11,7 @@ See-also:
- curl_free (3)
Protocol:
- All
Added-in: 7.1
---
# NAME
@@ -27,7 +28,7 @@ char *curl_unescape(const char *input, int length);
# DESCRIPTION
Obsolete function. Use curl_easy_unescape(3) instead.
Deprecated. Use curl_easy_unescape(3) instead.
This function converts the URL encoded string **input** to a "plain string"
and return that as a new allocated string. All input characters that are URL
@@ -57,7 +58,7 @@ int main(void)
}
~~~
# AVAILABILITY
# DEPRECATED
Since 7.15.4, curl_easy_unescape(3) should be used. This function might
be removed in a future release.

View File

@@ -13,6 +13,7 @@ See-also:
- curl_url_strerror (3)
Protocol:
- All
Added-in: 7.62.0
---
# NAME
@@ -57,10 +58,6 @@ int main(void)
}
~~~
# AVAILABILITY
Added in 7.62.0
# RETURN VALUE
Returns a **CURLU *** if successful, or NULL if out of memory.

View File

@@ -12,6 +12,7 @@ See-also:
- curl_url_set (3)
Protocol:
- All
Added-in: 7.62.0
---
# NAME
@@ -44,10 +45,6 @@ int main(void)
}
~~~
# AVAILABILITY
Added in 7.62.0
# RETURN VALUE
none

View File

@@ -12,6 +12,7 @@ See-also:
- curl_url_set (3)
Protocol:
- All
Added-in: 7.62.0
---
# NAME
@@ -49,10 +50,6 @@ int main(void)
}
~~~
# AVAILABILITY
Added in 7.62.0
# RETURN VALUE
Returns a new handle or NULL if out of memory.

View File

@@ -13,6 +13,7 @@ See-also:
- curl_url_strerror (3)
Protocol:
- All
Added-in: 7.62.0
---
# NAME
@@ -235,10 +236,6 @@ int main(void)
}
~~~
# AVAILABILITY
Added in 7.62.0. CURLUPART_ZONEID was added in 7.65.0.
# RETURN VALUE
Returns a CURLUcode error value, which is CURLUE_OK (0) if everything went

View File

@@ -13,6 +13,7 @@ See-also:
- curl_url_strerror (3)
Protocol:
- All
Added-in: 7.78.0
---
# NAME
@@ -255,10 +256,6 @@ int main(void)
}
~~~
# AVAILABILITY
Added in 7.62.0. CURLUPART_ZONEID was added in 7.65.0.
# RETURN VALUE
Returns a *CURLUcode* error value, which is CURLUE_OK (0) if everything

View File

@@ -13,6 +13,7 @@ See-also:
- libcurl-errors (3)
Protocol:
- All
Added-in: 7.80.0
---
# NAME
@@ -46,10 +47,6 @@ int main(void)
}
~~~
# AVAILABILITY
Added in 7.80.0
# RETURN VALUE
A pointer to a null-terminated string.

View File

@@ -8,6 +8,7 @@ See-also:
- curl_version_info (3)
Protocol:
- All
Added-in: 7.1
---
# NAME
@@ -38,10 +39,6 @@ int main(void)
}
~~~
# AVAILABILITY
Always
# RETURN VALUE
A pointer to a null-terminated string. The string resides in a statically

View File

@@ -8,6 +8,7 @@ See-also:
- curl_version (3)
Protocol:
- All
Added-in: 7.10.0
---
# NAME
@@ -382,10 +383,6 @@ int main(void)
}
~~~
# AVAILABILITY
Added in 7.10
# RETURN VALUE
A pointer to a curl_version_info_data struct.

View File

@@ -12,6 +12,7 @@ See-also:
- libcurl-ws (3)
Protocol:
- WS
Added-in: 7.86.0
---
# NAME
@@ -132,10 +133,6 @@ int main(void)
}
~~~
# AVAILABILITY
Added in 7.86.0.
# RETURN VALUE
This function returns a pointer to a *curl_ws_frame* struct with read-only

View File

@@ -12,6 +12,7 @@ See-also:
- libcurl-ws (3)
Protocol:
- WS
Added-in: 7.86.0
---
# NAME
@@ -60,10 +61,6 @@ int main(void)
}
~~~
# AVAILABILITY
Added in 7.86.0.
# RETURN VALUE
Returns **CURLE_OK** if everything is okay, and a non-zero number for

View File

@@ -12,6 +12,7 @@ See-also:
- libcurl-ws (3)
Protocol:
- WS
Added-in: 7.86.0
---
# NAME
@@ -111,10 +112,6 @@ int main(void)
}
~~~
# AVAILABILITY
Added in 7.86.0.
# RETURN VALUE
*CURLE_OK* (zero) means that the data was sent properly, non-zero means an

View File

@@ -1,7 +1,7 @@
---
c: Copyright (C) Daniel Stenberg, <daniel@haxx.se>, et al.
SPDX-License-Identifier: curl
Title: libcurl
Title: libcurl-easy
Section: 3
Source: libcurl
See-also:
@@ -13,6 +13,7 @@ See-also:
- libcurl-multi (3)
Protocol:
- All
Added-in: 7.1
---
# NAME

View File

@@ -8,6 +8,7 @@ See-also:
- libcurl-env (3)
Protocol:
- All
Added-in: n/a
---
# NAME

View File

@@ -8,6 +8,7 @@ See-also:
- libcurl-env-dbg (3)
Protocol:
- All
Added-in: n/a
---
# NAME

View File

@@ -14,6 +14,7 @@ See-also:
- curl_url_strerror (3)
Protocol:
- All
Added-in: n/a
---
# NAME

View File

@@ -10,6 +10,7 @@ See-also:
- libcurl-errors (3)
Protocol:
- All
Added-in: 7.9.6
---
# NAME

View File

@@ -8,6 +8,7 @@ See-also:
- libcurl-thread (3)
Protocol:
- All
Added-in: n/a
---
<!-- markdown-link-check-disable -->
# NAME

View File

@@ -13,6 +13,7 @@ See-also:
- libcurl-multi (3)
Protocol:
- All
Added-in: n/a
---
# NAME

View File

@@ -8,6 +8,7 @@ See-also:
- libcurl-security (3)
Protocol:
- All
Added-in: n/a
---
# NAME

View File

@@ -11,6 +11,7 @@ See-also:
- libcurl-url (3)
Protocol:
- All
Added-in: n/a
---
# NAME

View File

@@ -1,7 +1,7 @@
---
c: Copyright (C) Daniel Stenberg, <daniel@haxx.se>, et al.
SPDX-License-Identifier: curl
Title: libcurl
Title: libcurl-url
Section: 3
Source: libcurl
See-also:
@@ -14,6 +14,7 @@ See-also:
- curl_url_strerror (3)
Protocol:
- All
Added-in: 7.62.0
---
# NAME
@@ -156,9 +157,7 @@ Now the URL looks like
https://example.com/?shoes=2&hat=1&candy=N%26N
~~~
# AVAILABILITY
The URL API was introduced in libcurl 7.62.0.
# NOTES
A URL with a literal IPv6 address can be parsed even when IPv6 support is not
enabled.

View File

@@ -1,7 +1,7 @@
---
c: Copyright (C) Daniel Stenberg, <daniel@haxx.se>, et al.
SPDX-License-Identifier: curl
Title: libcurl
Title: libcurl-ws
Section: 3
Source: libcurl
See-also:
@@ -14,6 +14,7 @@ See-also:
- curl_ws_send (3)
Protocol:
- All
Added-in: 7.86.0
---
# NAME
@@ -115,7 +116,7 @@ Once such a setup has been successfully performed, the application can proceed
and use curl_ws_recv(3) and curl_ws_send(3) freely to exchange
WebSocket messages with the server.
# AVAILABILITY
# EXPERIMENTAL
The WebSocket API was introduced as experimental in 7.86.0 and is still
experimental today.

View File

@@ -11,6 +11,7 @@ See-also:
- libcurl-thread (3)
Protocol:
- All
Added-in: n/a
---
# NAME

View File

@@ -48,6 +48,7 @@ See-also:
- libcurl-multi (3)
- libcurl-security (3)
- libcurl-thread (3)
Added-in: n/a
---
# libcurl symbols

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