curl_multi_get_offt: add separate man pages for the options

Follow-up to 1ad2009ad63478ace18977ec5314f597f45ad084

Closes #18168

diff --git a/docs/libcurl/curl_multi_get_offt.md b/docs/libcurl/curl_multi_get_offt.md
index cc7873df47e85fe9c93d0cd8645b1951ced70641..0208e5179f8a1818e2f766ed8d82ff343adfc148 100644 (file)
--- a/docs/libcurl/curl_multi_get_offt.md
+++ b/docs/libcurl/curl_multi_get_offt.md
@@ -37,38 +37,23 @@ The following information can be extracted:
 
 ## CURLMINFO_XFERS_CURRENT
 
-The number of easy handles currently added to the multi. This does not
-count handles removed. It does count internal handles that get
-added for tasks (like resolving via DoH, for example).
-
-For the total number of easy handles ever added to the multi, see
-*CURLMINFO_XFERS_ADDED*.
+See CURLMINFO_XFERS_CURRENT(3).
 
 ## CURLMINFO_XFERS_RUNNING
 
-The number of easy handles currently running, e.g. where the transfer
-has started but not finished yet.
+See CURLMINFO_XFERS_RUNNING(3).
 
 ## CURLMINFO_XFERS_PENDING
 
-The number of current easy handles waiting to start. An added transfer
-might become pending for various reasons: a connection limit forces it
-to wait, resolving DNS is not finished or it is not clear if an existing,
-matching connection may allow multiplexing (HTTP/2 or HTTP/3).
+See CURLMINFO_XFERS_PENDING(3).
 
 ## CURLMINFO_XFERS_DONE
 
-The number of easy handles currently finished, but not yet processed
-via curl_multi_info_read(3).
+See CURLMINFO_XFERS_DONE(3).
 
 ## CURLMINFO_XFERS_ADDED
 
-The cumulative number of all easy handles added to the multi, ever.
-This includes internal handles added for tasks (like resolving
-via DoH, for example).
-
-For the current number of easy handles managed by the multi, use
-*CURLMINFO_XFERS_CURRENT*.
+See CURLMINFO_XFERS_ADDED(3).
 
 # %PROTOCOLS%
 

diff --git a/docs/libcurl/opts/CURLMINFO_XFERS_ADDED.md b/docs/libcurl/opts/CURLMINFO_XFERS_ADDED.md
new file mode 100644 (file)
index 0000000..c3869f6
--- /dev/null
+++ b/docs/libcurl/opts/CURLMINFO_XFERS_ADDED.md
@@ -0,0 +1,63 @@
+---
+c: Copyright (C) Daniel Stenberg, <daniel@haxx.se>, et al.
+SPDX-License-Identifier: curl
+Title: CURLMINFO_XFERS_ADDED
+Section: 3
+Source: libcurl
+See-also:
+  - CURLMINFO_XFERS_CURRENT (3)
+  - CURLMINFO_XFERS_RUNNING (3)
+  - CURLMINFO_XFERS_DONE (3)
+Protocol:
+  - All
+Added-in: 8.16.0
+---
+
+# NAME
+
+CURLMINFO_XFERS_ADDED - Cumulative number of all easy handles added
+
+# SYNOPSIS
+
+~~~c
+#include <curl/curl.h>
+
+CURLMcode curl_multi_get_offt(CURLM *handle, CURLMINFO_XFERS_ADDED,
+                              curl_off_t *pvalue);
+~~~
+
+# DESCRIPTION
+
+The cumulative number of all easy handles added to the multi, ever. This
+includes internal handles added for tasks (like resolving via DoH, for
+example).
+
+For the current number of easy handles managed by the multi, use
+CURLMINFO_XFERS_CURRENT(3).
+
+# DEFAULT
+
+n/a
+
+# %PROTOCOLS%
+
+# EXAMPLE
+
+~~~c
+int main(void)
+{
+  CURLM *m = curl_multi_init();
+  curl_off_t value;
+
+  curl_multi_get_offt(m, CURLMINFO_XFERS_ADDED, &value);
+}
+~~~
+
+# %AVAILABILITY%
+
+# RETURN VALUE
+
+curl_multi_get_offt(3) returns a CURLMcode indicating success or error.
+
+CURLM_OK (0) means everything was OK, non-zero means an error occurred, see
+libcurl-errors(3).

diff --git a/docs/libcurl/opts/CURLMINFO_XFERS_CURRENT.md b/docs/libcurl/opts/CURLMINFO_XFERS_CURRENT.md
new file mode 100644 (file)
index 0000000..2b29117
--- /dev/null
+++ b/docs/libcurl/opts/CURLMINFO_XFERS_CURRENT.md
@@ -0,0 +1,62 @@
+---
+c: Copyright (C) Daniel Stenberg, <daniel@haxx.se>, et al.
+SPDX-License-Identifier: curl
+Title: CURLMINFO_XFERS_CURRENT
+Section: 3
+Source: libcurl
+See-also:
+  - CURLMINFO_XFERS_RUNNING (3)
+  - CURLMINFO_XFERS_PENDING (3)
+Protocol:
+  - All
+Added-in: 8.16.0
+---
+
+# NAME
+
+CURLMINFO_XFERS_CURRENT - Number of easy handles currently added
+
+# SYNOPSIS
+
+~~~c
+#include <curl/curl.h>
+
+CURLMcode curl_multi_get_offt(CURLM *handle, CURLMINFO_XFERS_CURRENT,
+                              curl_off_t *pvalue);
+~~~
+
+# DESCRIPTION
+
+Returns the number of easy handles currently added to the multi handle. This
+does not include already removed handles. It does include internal handles
+that get added for tasks (like resolving via DoH, for example).
+
+For the total number of easy handles ever added to the multi, see
+CURLMINFO_XFERS_ADDED(3).
+
+# DEFAULT
+
+n/a
+
+# %PROTOCOLS%
+
+# EXAMPLE
+
+~~~c
+int main(void)
+{
+  CURLM *m = curl_multi_init();
+  curl_off_t value;
+
+  curl_multi_get_offt(m, CURLMINFO_XFERS_CURRENT, &value);
+}
+~~~
+
+# %AVAILABILITY%
+
+# RETURN VALUE
+
+curl_multi_get_offt(3) returns a CURLMcode indicating success or error.
+
+CURLM_OK (0) means everything was OK, non-zero means an error occurred, see
+libcurl-errors(3).

diff --git a/docs/libcurl/opts/CURLMINFO_XFERS_DONE.md b/docs/libcurl/opts/CURLMINFO_XFERS_DONE.md
new file mode 100644 (file)
index 0000000..6097d5f
--- /dev/null
+++ b/docs/libcurl/opts/CURLMINFO_XFERS_DONE.md
@@ -0,0 +1,58 @@
+---
+c: Copyright (C) Daniel Stenberg, <daniel@haxx.se>, et al.
+SPDX-License-Identifier: curl
+Title: CURLMINFO_XFERS_DONE
+Section: 3
+Source: libcurl
+See-also:
+  - CURLMINFO_XFERS_CURRENT (3)
+  - CURLMINFO_XFERS_RUNNING (3)
+Protocol:
+  - All
+Added-in: 8.16.0
+---
+
+# NAME
+
+CURLMINFO_XFERS_DONE - Number of finished unprocessed easy handles
+
+# SYNOPSIS
+
+~~~c
+#include <curl/curl.h>
+
+CURLMcode curl_multi_get_offt(CURLM *handle, CURLMINFO_XFERS_DONE,
+                              curl_off_t *pvalue);
+~~~
+
+# DESCRIPTION
+
+The number of easy handles currently finished, but not yet processed via
+curl_multi_info_read(3).
+
+# DEFAULT
+
+n/a
+
+# %PROTOCOLS%
+
+# EXAMPLE
+
+~~~c
+int main(void)
+{
+  CURLM *m = curl_multi_init();
+  curl_off_t value;
+
+  curl_multi_get_offt(m, CURLMINFO_XFERS_DONE, &value);
+}
+~~~
+
+# %AVAILABILITY%
+
+# RETURN VALUE
+
+curl_multi_get_offt(3) returns a CURLMcode indicating success or error.
+
+CURLM_OK (0) means everything was OK, non-zero means an error occurred, see
+libcurl-errors(3).

diff --git a/docs/libcurl/opts/CURLMINFO_XFERS_PENDING.md b/docs/libcurl/opts/CURLMINFO_XFERS_PENDING.md
new file mode 100644 (file)
index 0000000..acdc1f1
--- /dev/null
+++ b/docs/libcurl/opts/CURLMINFO_XFERS_PENDING.md
@@ -0,0 +1,60 @@
+---
+c: Copyright (C) Daniel Stenberg, <daniel@haxx.se>, et al.
+SPDX-License-Identifier: curl
+Title: CURLMINFO_XFERS_PENDING
+Section: 3
+Source: libcurl
+See-also:
+  - CURLMINFO_XFERS_CURRENT (3)
+  - CURLMINFO_XFERS_RUNNING (3)
+Protocol:
+  - All
+Added-in: 8.16.0
+---
+
+# NAME
+
+CURLMINFO_XFERS_PENDING - Number of easy handles waiting to start
+
+# SYNOPSIS
+
+~~~c
+#include <curl/curl.h>
+
+CURLMcode curl_multi_get_offt(CURLM *handle, CURLMINFO_XFERS_PENDING,
+                              curl_off_t *pvalue);
+~~~
+
+# DESCRIPTION
+
+The number of current easy handles waiting to start. An added transfer might
+become pending for various reasons: a connection limit forces it to wait,
+resolving DNS is not finished or it is not clear if an existing, matching
+connection may allow multiplexing (HTTP/2 or HTTP/3).
+
+# DEFAULT
+
+n/a
+
+# %PROTOCOLS%
+
+# EXAMPLE
+
+~~~c
+int main(void)
+{
+  CURLM *m = curl_multi_init();
+  curl_off_t value;
+
+  curl_multi_get_offt(m, CURLMINFO_XFERS_PENDING, &value);
+}
+~~~
+
+# %AVAILABILITY%
+
+# RETURN VALUE
+
+curl_multi_get_offt(3) returns a CURLMcode indicating success or error.
+
+CURLM_OK (0) means everything was OK, non-zero means an error occurred, see
+libcurl-errors(3).

diff --git a/docs/libcurl/opts/CURLMINFO_XFERS_RUNNING.md b/docs/libcurl/opts/CURLMINFO_XFERS_RUNNING.md
new file mode 100644 (file)
index 0000000..eeedb75
--- /dev/null
+++ b/docs/libcurl/opts/CURLMINFO_XFERS_RUNNING.md
@@ -0,0 +1,58 @@
+---
+c: Copyright (C) Daniel Stenberg, <daniel@haxx.se>, et al.
+SPDX-License-Identifier: curl
+Title: CURLMINFO_XFERS_RUNNING
+Section: 3
+Source: libcurl
+See-also:
+  - CURLMINFO_XFERS_CURRENT (3)
+  - CURLMINFO_XFERS_PENDING (3)
+Protocol:
+  - All
+Added-in: 8.16.0
+---
+
+# NAME
+
+CURLMINFO_XFERS_RUNNING - Number of easy handles currently running
+
+# SYNOPSIS
+
+~~~c
+#include <curl/curl.h>
+
+CURLMcode curl_multi_get_offt(CURLM *handle, CURLMINFO_XFERS_RUNNING,
+                              curl_off_t *pvalue);
+~~~
+
+# DESCRIPTION
+
+The number of easy handles currently running, e.g. where the transfer has
+started but not finished yet.
+
+# DEFAULT
+
+n/a
+
+# %PROTOCOLS%
+
+# EXAMPLE
+
+~~~c
+int main(void)
+{
+  CURLM *m = curl_multi_init();
+  curl_off_t value;
+
+  curl_multi_get_offt(m, CURLMINFO_XFERS_RUNNING, &value);
+}
+~~~
+
+# %AVAILABILITY%
+
+# RETURN VALUE
+
+curl_multi_get_offt(3) returns a CURLMcode indicating success or error.
+
+CURLM_OK (0) means everything was OK, non-zero means an error occurred, see
+libcurl-errors(3).

diff --git a/docs/libcurl/opts/Makefile.inc b/docs/libcurl/opts/Makefile.inc
index 1cf960e5ee930e75c3327975aaf93bbf8bb5d5c7..98691cac3cc19c81bc32db63e1d5030630e0c776 100644 (file)
--- a/docs/libcurl/opts/Makefile.inc
+++ b/docs/libcurl/opts/Makefile.inc
@@ -101,6 +101,11 @@ man_MANS =                                      \
   CURLINFO_TOTAL_TIME_T.3                       \
   CURLINFO_USED_PROXY.3                         \
   CURLINFO_XFER_ID.3                            \
+  CURLMINFO_XFERS_ADDED.3                       \
+  CURLMINFO_XFERS_CURRENT.3                     \
+  CURLMINFO_XFERS_DONE.3                        \
+  CURLMINFO_XFERS_PENDING.3                     \
+  CURLMINFO_XFERS_RUNNING.3                     \
   CURLMOPT_CHUNK_LENGTH_PENALTY_SIZE.3          \
   CURLMOPT_CONTENT_LENGTH_PENALTY_SIZE.3        \
   CURLMOPT_MAX_CONCURRENT_STREAMS.3             \