aboutsummaryrefslogtreecommitdiff
path: root/docs/libcurl
AgeCommit message (Collapse)Author
2013-08-30docs: Added documentation for CURLOPT_BEARERKyle L. Huff
2013-08-28symbols-in-versions: add CURLOPT_XOAUTH2_BEARERDaniel Stenberg
2013-08-20CURLM_ADDED_ALREADY: new error codeDaniel Stenberg
Doing curl_multi_add_handle() on an easy handle that is already added to a multi handle now returns this error code. It previously returned CURLM_BAD_EASY_HANDLE for this condition.
2013-08-09curl_multi_add_handle.3: ... that timer callback is for event-basedDaniel Stenberg
2013-08-09curl_multi_add_handle.3: mention the CURLMOPT_TIMERFUNCTION useDaniel Stenberg
2013-08-02Revert "DOCS: Added IMAP URL example for listing new messages"Steve Holme
This reverts commit 82ab5f1b0c7c3f as this was the wrong place to document the complexity of IMAP URLs and Custom Requests.
2013-08-02DOCS: Added IMAP URL example for listing new messagesSteve Holme
In addition to listing the folder contents, in the URL examples, added an example to list the new messages waiting in the user's inbox.
2013-07-29curl_easy_pause: on unpause, trigger mulit-socket handlingDaniel Stenberg
When the multi-socket API is used, we need the handle to be checked again when it gets unpaused. Bug: http://curl.haxx.se/mail/lib-2013-07/0239.html Reported-by: Justin Karneges
2013-07-18CURLOPT_XFERINFOFUNCTION: introducing a new progress callbackDaniel Stenberg
CURLOPT_XFERINFOFUNCTION is now the preferred progress callback function and CURLOPT_PROGRESSFUNCTION is considered deprecated. This new callback uses pure 'curl_off_t' arguments to pass on full resolution sizes. It otherwise retains the same characteristics: the same call rate, the same meanings for the arguments and the return code is used the same way. The progressfunc.c example is updated to show how to use the new callback for newer libcurls while supporting the older one if built with an older libcurl or even built with a newer libcurl while running with an older.
2013-06-22docs: fix typo in curl_easy_getinfo manpageAlessandro Ghedini
2013-06-14curl_easy_setopt.3: clarify CURLOPT_PROGRESSFUNCTION frequencyDaniel Stenberg
Make it clearer that the CURLOPT_PROGRESSFUNCTION callback will be called more frequently than once per second when things are happening.
2013-06-13curl_multi_wait.3: clarify the numfds counterDaniel Stenberg
2013-06-08curl_easy_setopt.3: HTTP header with no contentPeter Gal
Update the documentation on how to specify a HTTP header with no content.
2013-06-03libcurl-tutorial.3: added a section on IPv6Dan Fandrich
Also added a (correctly-escaped) backslash to the autoexec.bat example file and a new Windows character device name with a colon as examples of other characters that are special and potentially dangerous (this reverts and reworks commit 7d8d2a54).
2013-06-03curl_multi_wait: reduce timeout if the multi handle wants toDaniel Stenberg
If the multi handle's pending timeout is less than what is passed into this function, it will now opt to use the shorter time anyway since it is a very good hint that the handle wants to process something in a shorter time than what otherwise would happen. curl_multi_wait.3 was updated accordingly to clarify This is the reason for bug #1224 Bug: http://curl.haxx.se/bug/view.cgi?id=1224 Reported-by: Andrii Moiseiev
2013-05-28libcurl-tutorial.3: remove incorrect backslashDaniel Stenberg
A single backslash in the content is not legal nroff syntax. Reported and fixed by: Eric S. Raymond Bug: http://curl.haxx.se/bug/view.cgi?id=1234
2013-05-28curl_formadd.3: fixed wrong "end-marker" syntaxDaniel Stenberg
Reported and fixed by: Eric S. Raymond Bug: http://curl.haxx.se/bug/view.cgi?id=1233
2013-05-20curl_easy_setopt.3: expand the PROGRESSFUNCTION sectionDaniel Stenberg
Explain the callback and its arguments better and with more descriptive text.
2013-04-28DOCS: Corrected line length of recent Secure Transport changesSteve Holme
2013-04-27darwinssl: add TLS crypto authenticationNick Zitzmann
Users using the Secure Transport (darwinssl) back-end can now use a certificate and private key to authenticate with a site using TLS. Because Apple's security system is based around the keychain and does not have any non-public function to create a SecIdentityRef data structure from data loaded outside of the Keychain, the certificate and private key have to be loaded into the Keychain first (using the certtool command line tool or the Security framework's C API) before we can find it and use it.
2013-04-27Corrected version numbers after bumpSteve Holme
2013-04-27DOCS: Updated following the addition of CURLOPT_SASL_IRSteve Holme
Documented the the option in curl_easy_setopt() and added it to symbols-in-versions.
2013-04-25DOCS: Minor rewording / clarification of host name protocol detectionSteve Holme
2013-04-24DOCS: Added reference to IETF draft for SMTP URL InterfaceSteve Holme
...when mentioning login options. Additional minor clarification of "Windows builds" to be "Windows builds with SSPI"as a way of enabling NTLM as Windows builds may be built with OpenSSL to enable NTLM or without NTLM support altogether.
2013-04-23DOCS: Reworked the scheme calculation explanation under CURLOPT_URLSteve Holme
2013-04-22DOCS: Added information about login options to CURLOPT_USERPWDSteve Holme
2013-04-22DOCS: Added information about login options in the URLSteve Holme
2013-04-16docs/libcurl: fix formatting in manpageDave Reisner
Commit c3ea3eb6 introduced some minor cosmetic errors in curl_mutli_socket_action(3).
2013-04-12libcurl-share.3: update what it does and does not share.David Strauss
Update sharing interface documentation to provide exhaustive list of what it does and does not share.
2013-04-05curl_global_init.3: improve description of CURL_GLOBAL_ALLKamil Dudka
Reported by: Tomas Mlcoch
2013-04-03curl_easy_setopt.3: CURLOPT_HTTPGET disables CURLOPT_UPLOADDaniel Stenberg
2013-03-13Multiple pipelines and limiting the number of connections.Linus Nielsen Feltzing
Introducing a number of options to the multi interface that allows for multiple pipelines to the same host, in order to optimize the balance between the penalty for opening new connections and the potential pipelining latency. Two new options for limiting the number of connections: CURLMOPT_MAX_HOST_CONNECTIONS - Limits the number of running connections to the same host. When adding a handle that exceeds this limit, that handle will be put in a pending state until another handle is finished, so we can reuse the connection. CURLMOPT_MAX_TOTAL_CONNECTIONS - Limits the number of connections in total. When adding a handle that exceeds this limit, that handle will be put in a pending state until another handle is finished. The free connection will then be reused, if possible, or closed if the pending handle can't reuse it. Several new options for pipelining: CURLMOPT_MAX_PIPELINE_LENGTH - Limits the pipeling length. If a pipeline is "full" when a connection is to be reused, a new connection will be opened if the CURLMOPT_MAX_xxx_CONNECTIONS limits allow it. If not, the handle will be put in a pending state until a connection is ready (either free or a pipe got shorter). CURLMOPT_CONTENT_LENGTH_PENALTY_SIZE - A pipelined connection will not be reused if it is currently processing a transfer with a content length that is larger than this. CURLMOPT_CHUNK_LENGTH_PENALTY_SIZE - A pipelined connection will not be reused if it is currently processing a chunk larger than this. CURLMOPT_PIPELINING_SITE_BL - A blacklist of hosts that don't allow pipelining. CURLMOPT_PIPELINING_SERVER_BL - A blacklist of server types that don't allow pipelining. See the curl_multi_setopt() man page for details.
2013-03-12curl_global_init: accept the CURL_GLOBAL_ACK_EINTR flagZdenek Pavlas
The flag can be used in pycurl-based applications where using the multi interface would not be acceptable because of the performance lost caused by implementing the select() loop in python. Bug: http://curl.haxx.se/bug/view.cgi?id=1168 Downstream Bug: https://bugzilla.redhat.com/919127
2013-03-07DOCS: Corrected the IMAP URL grammar of the UIDVALIDITY parameterSteve Holme
2013-03-07DOCS: Added the list command to the IMAP URL sectionSteve Holme
Added examples of the list command and clarified existing example URLs following recent changes.
2013-02-26DOCS: Added the IMAP UIDVALIDITY property to the CURLOPT_URL sectionSteve Holme
2013-02-25DOCS: Corrected IMAP URL examples according to RFC5092Steve Holme
URL examples that included the UID weren't technically correct although would pass the curl parser.
2013-02-24DOCS: Corrected layout of POP3 and IMAP URL examplesSteve Holme
Corrected layout issues with the POP3 and IMAP URL examples introduced in commit cb3ae6894fb2.
2013-02-23DOCS: Updated CURLOPT_URL section following recent POP3 and IMAP changesSteve Holme
Updated the POP3 sub-section to refer to message ID rather than mailbox. Added an IMAP sub-section with example URLs depicting the specification of mailbox, uid and section.
2013-02-22libcurl documentation: clarifications and typosAlexander Klauer
* Elaborates on default values of some curl_easy_setopt() options. * Reminds the user to cast variadic arguments to curl_easy_setopt() to 'void *' where curl internally interprets them as such. * Clarifies the working of the CURLOPT_SEEKFUNCTION option for curl_easy_setopt(). * Fixes typo 'forth' → 'fourth'. * Elaborates on CURL_SOCKET_TIMEOUT. * Adds some missing periods. * Notes that the return value of curl_version() must not be passed to free().
2013-02-22libcurl documentation: updates HTML indexAlexander Klauer
* Adds several links to documentation of library functions which were missing. * Marks documentation of deprecated library functions "(deprecated)". * Removes spurious .html suffixes.
2013-02-18docs: schannel and darwinssl documentation improvementsNick Zitzmann
Schannel and darwinssl use the certificates built into the OS to do vert verification instead of bundles. darwinssl is thread-safe. Corrected typos in the NSS docs.
2013-02-17docs: refer to CURLOPT_ACCEPT_ENCODING instead of the old nameDaniel Stenberg
2013-01-28docs: fix typos in man pagesKamil Dudka
Reported by: Jiri Jaburek Bug: https://bugzilla.redhat.com/896544
2013-01-28docs: update the comments about loading CA certs with NSSKamil Dudka
Bug: https://bugzilla.redhat.com/696783
2013-01-19curl_easy_send.3: document return codesDaniel Stenberg
Reported by: Craig Davison Bug: http://curl.haxx.se/mail/lib-2013-01/0234.html
2013-01-19curl_easy_recv.3: document return codesDaniel Stenberg
Reported by: Craig Davison Bug: http://curl.haxx.se/mail/lib-2013-01/0234.html
2012-11-23DOCS: Updated CURLOPT_CONNECT_ONLY to reflect usage in other protocolsSteve Holme
2012-11-06CURLOPT_SSL_VERIFYHOST: stop supporting the 1 valueDaniel Stenberg
After a research team wrote a document[1] that found several live source codes out there in the wild that misused the CURLOPT_SSL_VERIFYHOST option thinking it was a boolean, this change now bans 1 as a value and will make libcurl return error for it. 1 was never a sensible value to use in production but was introduced back in the days to help debugging. It was always documented clearly this way. 1 was never supported by all SSL backends in libcurl, so this cleanup makes the treatment of it unified. The report's list of mistakes for this option were all PHP code and while there's a binding layer between libcurl and PHP, the PHP team has decided that they have an as thin layer as possible on top of libcurl so they will not alter or specifically filter a 'TRUE' value for this particular option. I sympathize with that position. [1] = http://daniel.haxx.se/blog/2012/10/25/libcurl-claimed-to-be-dangerous/
2012-10-09curl_multi_wait: no wait if no descriptors to wait forDaniel Stenberg
This is a minor change in behavior after having been pointed out by Mark Tully and discussed on the list. Initially this case would internally call poll() with no sockets and a timeout which would equal a sleep for that specified time. Bug: http://curl.haxx.se/mail/lib-2012-10/0076.html Reported by: Mark Tully