curl/docs
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
..
cmdline-opts docs/cmdline-opts: add copyright and license identifier to each file 2022-06-14 08:48:09 +02:00
examples reuse/dep5: adjusted to parse better 2022-06-14 14:07:02 +02:00
libcurl curl_easy_pause.3: remove explanation of progress function 2022-06-16 03:18:04 -04:00
.gitignore copyright: make repository REUSE compliant 2022-06-13 09:13:00 +02:00
ALTSVC.md
BINDINGS.md
BUFREF.md
BUG-BOUNTY.md
BUGS.md
CHECKSRC.md
CIPHERS.md
CMakeLists.txt copyright: make repository REUSE compliant 2022-06-13 09:13:00 +02:00
CODE_OF_CONDUCT.md
CODE_REVIEW.md
CODE_STYLE.md
CONTRIBUTE.md docs/CONTRIBUTE.md: document the 'needs-votes' concept 2022-06-02 08:21:24 +02:00
curl-config.1 copyright: make repository REUSE compliant 2022-06-13 09:13:00 +02:00
CURL-DISABLE.md headers api: remove EXPERIMENTAL tag 2022-05-30 14:13:48 +02:00
DEPRECATE.md
DYNBUF.md
EXPERIMENTAL.md configure: warn about rustls being experimental 2022-06-15 23:33:00 +02:00
FAQ
FEATURES.md
GOVERNANCE.md
HELP-US.md
HISTORY.md
HSTS.md
HTTP2.md
HTTP3.md
HTTP-COOKIES.md
HYPER.md
INSTALL
INSTALL.cmake
INSTALL.md
INTERNALS.md
KNOWN_BUGS
MAIL-ETIQUETTE
Makefile.am copyright: make repository REUSE compliant 2022-06-13 09:13:00 +02:00
MANUAL.md
mk-ca-bundle.1 copyright: make repository REUSE compliant 2022-06-13 09:13:00 +02:00
MQTT.md
NEW-PROTOCOL.md
options-in-versions curl: add --rate to set max request rate per time unit 2022-05-23 17:59:56 +02:00
PARALLEL-TRANSFERS.md
README.md
RELEASE-PROCEDURE.md
ROADMAP.md
RUSTLS.md
SECURITY-PROCESS.md
SSL-PROBLEMS.md
SSLCERTS.md
THANKS
THANKS-filter copyright: make repository REUSE compliant 2022-06-13 09:13:00 +02:00
TheArtOfHttpScripting.md
TODO curl: add --rate to set max request rate per time unit 2022-05-23 17:59:56 +02:00
URL-SYNTAX.md
VERSIONS.md

curl logo

Documentation

you will find a mix of various documentation in this directory and subdirectories, using several different formats. Some of them are not ideal for reading directly in your browser.

If you would rather see the rendered version of the documentation, check out the curl website's documentation section for general curl stuff or the libcurl section for libcurl related documentation.