curl/docs/libcurl
Jay Satiro 9135275f86 curl_easy_pause.3: remove explanation of progress function
- Remove misleading text that says progress function "gets called at
  least once per second, even if the connection is paused."

The progress function behavior is more nuanced and the user is better
served reading the progress function doc rather than attempt to explain
it in the curl_easy_pause doc.

The progress function can only be called at least once per second if an
appropriate multi transfer function is called (eg curl_multi_perform) in
that time. For a paused transfer there may not be such a call. Rather
than explain this in detail in the curl_easy_pause doc, rely on the user
reading the CURLOPT_PROGRESSFUNCTION doc.

Ref: https://github.com/curl/curl/issues/8983

Closes https://github.com/curl/curl/pull/9015
2022-06-16 03:18:04 -04:00
..
opts misc: add missing SPDX-License-Identifier info 2022-06-13 10:08:17 +02:00
.gitignore copyright: make repository REUSE compliant 2022-06-13 09:13:00 +02:00
ABI.md reuse/dep5: adjusted to parse better 2022-06-14 14:07:02 +02:00
CMakeLists.txt copyright: make repository REUSE compliant 2022-06-13 09:13:00 +02:00
curl_easy_cleanup.3 copyright: make repository REUSE compliant 2022-06-13 09:13:00 +02:00
curl_easy_duphandle.3 copyright: make repository REUSE compliant 2022-06-13 09:13:00 +02:00
curl_easy_escape.3 copyright: make repository REUSE compliant 2022-06-13 09:13:00 +02:00
curl_easy_getinfo.3 copyright: make repository REUSE compliant 2022-06-13 09:13:00 +02:00
curl_easy_header.3 copyright: make repository REUSE compliant 2022-06-13 09:13:00 +02:00
curl_easy_init.3 copyright: make repository REUSE compliant 2022-06-13 09:13:00 +02:00
curl_easy_nextheader.3 copyright: make repository REUSE compliant 2022-06-13 09:13:00 +02:00
curl_easy_option_by_id.3 copyright: make repository REUSE compliant 2022-06-13 09:13:00 +02:00
curl_easy_option_by_name.3 copyright: make repository REUSE compliant 2022-06-13 09:13:00 +02:00
curl_easy_option_next.3 copyright: make repository REUSE compliant 2022-06-13 09:13:00 +02:00
curl_easy_pause.3 curl_easy_pause.3: remove explanation of progress function 2022-06-16 03:18:04 -04:00
curl_easy_perform.3 copyright: make repository REUSE compliant 2022-06-13 09:13:00 +02:00
curl_easy_recv.3 copyright: make repository REUSE compliant 2022-06-13 09:13:00 +02:00
curl_easy_reset.3 copyright: make repository REUSE compliant 2022-06-13 09:13:00 +02:00
curl_easy_send.3 copyright: make repository REUSE compliant 2022-06-13 09:13:00 +02:00
curl_easy_setopt.3 copyright: make repository REUSE compliant 2022-06-13 09:13:00 +02:00
curl_easy_strerror.3 copyright: make repository REUSE compliant 2022-06-13 09:13:00 +02:00
curl_easy_unescape.3 copyright: make repository REUSE compliant 2022-06-13 09:13:00 +02:00
curl_easy_upkeep.3 copyright: make repository REUSE compliant 2022-06-13 09:13:00 +02:00
curl_escape.3 copyright: make repository REUSE compliant 2022-06-13 09:13:00 +02:00
curl_formadd.3 copyright: make repository REUSE compliant 2022-06-13 09:13:00 +02:00
curl_formfree.3 copyright: make repository REUSE compliant 2022-06-13 09:13:00 +02:00
curl_formget.3 copyright: make repository REUSE compliant 2022-06-13 09:13:00 +02:00
curl_free.3 copyright: make repository REUSE compliant 2022-06-13 09:13:00 +02:00
curl_getdate.3 copyright: make repository REUSE compliant 2022-06-13 09:13:00 +02:00
curl_getenv.3 copyright: make repository REUSE compliant 2022-06-13 09:13:00 +02:00
curl_global_cleanup.3 copyright: make repository REUSE compliant 2022-06-13 09:13:00 +02:00
curl_global_init_mem.3 copyright: make repository REUSE compliant 2022-06-13 09:13:00 +02:00
curl_global_init.3 version: rename threadsafe-init to threadsafe 2022-06-13 18:59:45 +00:00
curl_global_sslset.3 copyright: make repository REUSE compliant 2022-06-13 09:13:00 +02:00
curl_mime_addpart.3 copyright: make repository REUSE compliant 2022-06-13 09:13:00 +02:00
curl_mime_data_cb.3 copyright: make repository REUSE compliant 2022-06-13 09:13:00 +02:00
curl_mime_data.3 copyright: make repository REUSE compliant 2022-06-13 09:13:00 +02:00
curl_mime_encoder.3 copyright: make repository REUSE compliant 2022-06-13 09:13:00 +02:00
curl_mime_filedata.3 copyright: make repository REUSE compliant 2022-06-13 09:13:00 +02:00
curl_mime_filename.3 copyright: make repository REUSE compliant 2022-06-13 09:13:00 +02:00
curl_mime_free.3 copyright: make repository REUSE compliant 2022-06-13 09:13:00 +02:00
curl_mime_headers.3 copyright: make repository REUSE compliant 2022-06-13 09:13:00 +02:00
curl_mime_init.3 copyright: make repository REUSE compliant 2022-06-13 09:13:00 +02:00
curl_mime_name.3 copyright: make repository REUSE compliant 2022-06-13 09:13:00 +02:00
curl_mime_subparts.3 copyright: make repository REUSE compliant 2022-06-13 09:13:00 +02:00
curl_mime_type.3 copyright: make repository REUSE compliant 2022-06-13 09:13:00 +02:00
curl_mprintf.3 copyright: make repository REUSE compliant 2022-06-13 09:13:00 +02:00
curl_multi_add_handle.3 copyright: make repository REUSE compliant 2022-06-13 09:13:00 +02:00
curl_multi_assign.3 copyright: make repository REUSE compliant 2022-06-13 09:13:00 +02:00
curl_multi_cleanup.3 copyright: make repository REUSE compliant 2022-06-13 09:13:00 +02:00
curl_multi_fdset.3 copyright: make repository REUSE compliant 2022-06-13 09:13:00 +02:00
curl_multi_info_read.3 copyright: make repository REUSE compliant 2022-06-13 09:13:00 +02:00
curl_multi_init.3 copyright: make repository REUSE compliant 2022-06-13 09:13:00 +02:00
curl_multi_perform.3 copyright: make repository REUSE compliant 2022-06-13 09:13:00 +02:00
curl_multi_poll.3 copyright: make repository REUSE compliant 2022-06-13 09:13:00 +02:00
curl_multi_remove_handle.3 copyright: make repository REUSE compliant 2022-06-13 09:13:00 +02:00
curl_multi_setopt.3 copyright: make repository REUSE compliant 2022-06-13 09:13:00 +02:00
curl_multi_socket_action.3 copyright: make repository REUSE compliant 2022-06-13 09:13:00 +02:00
curl_multi_socket_all.3 The inital early embryos to describe the curl_multi_socket() API. Committed 2005-12-22 15:11:11 +00:00
curl_multi_socket.3 copyright: make repository REUSE compliant 2022-06-13 09:13:00 +02:00
curl_multi_strerror.3 copyright: make repository REUSE compliant 2022-06-13 09:13:00 +02:00
curl_multi_timeout.3 copyright: make repository REUSE compliant 2022-06-13 09:13:00 +02:00
curl_multi_wait.3 copyright: make repository REUSE compliant 2022-06-13 09:13:00 +02:00
curl_multi_wakeup.3 copyright: make repository REUSE compliant 2022-06-13 09:13:00 +02:00
curl_share_cleanup.3 copyright: make repository REUSE compliant 2022-06-13 09:13:00 +02:00
curl_share_init.3 copyright: make repository REUSE compliant 2022-06-13 09:13:00 +02:00
curl_share_setopt.3 copyright: make repository REUSE compliant 2022-06-13 09:13:00 +02:00
curl_share_strerror.3 copyright: make repository REUSE compliant 2022-06-13 09:13:00 +02:00
curl_slist_append.3 copyright: make repository REUSE compliant 2022-06-13 09:13:00 +02:00
curl_slist_free_all.3 copyright: make repository REUSE compliant 2022-06-13 09:13:00 +02:00
curl_strequal.3 copyright: make repository REUSE compliant 2022-06-13 09:13:00 +02:00
curl_strnequal.3 prepend the man3 dir to the file name to work better. 2004-04-02 11:04:34 +00:00
curl_unescape.3 copyright: make repository REUSE compliant 2022-06-13 09:13:00 +02:00
curl_url_cleanup.3 copyright: make repository REUSE compliant 2022-06-13 09:13:00 +02:00
curl_url_dup.3 copyright: make repository REUSE compliant 2022-06-13 09:13:00 +02:00
curl_url_get.3 copyright: make repository REUSE compliant 2022-06-13 09:13:00 +02:00
curl_url_set.3 curl_url_set.3: clarify by default using known schemes only 2022-06-12 23:10:51 +02:00
curl_url_strerror.3 copyright: make repository REUSE compliant 2022-06-13 09:13:00 +02:00
curl_url.3 copyright: make repository REUSE compliant 2022-06-13 09:13:00 +02:00
curl_version_info.3 version: rename threadsafe-init to threadsafe 2022-06-13 18:59:45 +00:00
curl_version.3 copyright: make repository REUSE compliant 2022-06-13 09:13:00 +02:00
libcurl-easy.3 copyright: make repository REUSE compliant 2022-06-13 09:13:00 +02:00
libcurl-env.3 copyright: make repository REUSE compliant 2022-06-13 09:13:00 +02:00
libcurl-errors.3 copyright: make repository REUSE compliant 2022-06-13 09:13:00 +02:00
libcurl-multi.3 copyright: make repository REUSE compliant 2022-06-13 09:13:00 +02:00
libcurl-security.3 copyright: make repository REUSE compliant 2022-06-13 09:13:00 +02:00
libcurl-share.3 copyright: make repository REUSE compliant 2022-06-13 09:13:00 +02:00
libcurl-thread.3 copyright: make repository REUSE compliant 2022-06-13 09:13:00 +02:00
libcurl-tutorial.3 copyright: make repository REUSE compliant 2022-06-13 09:13:00 +02:00
libcurl-url.3 copyright: make repository REUSE compliant 2022-06-13 09:13:00 +02:00
libcurl.3 copyright: make repository REUSE compliant 2022-06-13 09:13:00 +02:00
libcurl.m4 copyright: make repository REUSE compliant 2022-06-13 09:13:00 +02:00
Makefile.am copyright: make repository REUSE compliant 2022-06-13 09:13:00 +02:00
Makefile.inc copyright: make repository REUSE compliant 2022-06-13 09:13:00 +02:00
mksymbolsmanpage.pl copyright: make repository REUSE compliant 2022-06-13 09:13:00 +02:00
symbols-in-versions version: rename threadsafe-init to threadsafe 2022-06-13 18:59:45 +00:00
symbols.pl copyright: make repository REUSE compliant 2022-06-13 09:13:00 +02:00