aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorDaniel Stenberg <daniel@haxx.se>2023-10-06 09:22:26 +0200
committerDaniel Stenberg <daniel@haxx.se>2023-10-06 14:48:32 +0200
commita311c727235390395c5bca08c91d32228cc20660 (patch)
treeab1794780963e9350d970426c80424380a83f948
parent4a80c7503f5a36ad5402407df0771a1783090936 (diff)
downloadcurl-a311c727235390395c5bca08c91d32228cc20660.tar.gz
curl_easy_pause.3: mention it works within callbacks
Reported-by: Maxim Dzhura Bug: https://curl.se/mail/lib-2023-10/0010.html Closes #12046
-rw-r--r--docs/libcurl/curl_easy_pause.34
1 files changed, 3 insertions, 1 deletions
diff --git a/docs/libcurl/curl_easy_pause.3 b/docs/libcurl/curl_easy_pause.3
index f3a879391..a3cf4b81c 100644
--- a/docs/libcurl/curl_easy_pause.3
+++ b/docs/libcurl/curl_easy_pause.3
@@ -32,7 +32,9 @@ curl_easy_pause - pause and unpause a connection
.fi
.SH DESCRIPTION
Using this function, you can explicitly mark a running connection to get
-paused, and you can unpause a connection that was previously paused.
+paused, and you can unpause a connection that was previously paused. Unlike
+most other libcurl functions, \fIcurl_easy_pause(3)\fP can be used from within
+callbacks.
A connection can be paused by using this function or by letting the read or
the write callbacks return the proper magic return code