summaryrefslogtreecommitdiff
path: root/docs/libcurl
Commit message (Collapse)AuthorAgeFilesLines
* docs: consistent use of "Added in"Daniel Stenberg2021-10-2528-41/+41
| | | | | Make them all say "Added in [version]" without using 'curl' or 'libcurl' in that phrase.
* man pages: require all to use the same section header orderDaniel Stenberg2021-10-2573-264/+676
| | | | | | | | | This is the same order we already enforce among the options' man pages: consistency is good. Add lots of previously missing examples. Adjust the manpage-syntax script for this purpose, used in test 1173. Closes #7904
* docs: provide "RETURN VALUE" section for more func manpagesDaniel Stenberg2021-10-254-4/+11
| | | | | | Three were missing, one used a non-standard name for the header. Closes #7902
* curl_multi_socket_action.3: add a "RETURN VALUE" sectionJay Satiro2021-10-251-0/+3
| | | | | | | | | .. because it may not be immediately clear to the user what curl_multi_socket_action returns. Ref: https://curl.se/mail/lib-2021-10/0035.html Closes https://github.com/curl/curl/pull/7901
* hyper: does not support disabling CURLOPT_HTTP_TRANSFER_DECODINGDaniel Stenberg2021-10-221-1/+2
| | | | | | | | Simply because hyper doesn't have this ability. Mentioned in docs now. Skip test 326 then Closes #7889
* manpage: adjust the asterisk in some SYNOPSIS sectionsDaniel Stenberg2021-10-204-10/+11
| | | | Closes #7884
* curl_multi_perform.3: polish wordingDaniel Stenberg2021-10-201-66/+25
| | | | | | | | | | | | | - simplify the example by using curl_multi_poll - mention curl_multi_add_handle in the text - cut out the description of pre-7.20.0 return code behavior - that version is now more than eleven years old and is basically no longer out there - adjust the "typical usage" to mention curl_multi_poll Closes #7883
* curl_easy_perform.3: minor wording tweakDaniel Stenberg2021-10-201-3/+3
|
* urlapi: URL decode percent-encoded host namesDaniel Stenberg2021-10-111-1/+9
| | | | | | | | | | | | | | | | | | | | | | The host name is stored decoded and can be encoded when used to extract the full URL. By default when extracting the URL, the host name will not be URL encoded to work as similar as possible as before. When not URL encoding the host name, the '%' character will however still be encoded. Getting the URL with the CURLU_URLENCODE flag set will percent encode the host name part. As a bonus, setting the host name part with curl_url_set() no longer accepts a name that contains space, CR or LF. Test 1560 has been extended to verify percent encodings. Reported-by: Noam Moshe Reported-by: Sharon Brizinov Reported-by: Raul Onitza-Klugman Reported-by: Kirill Efimov Fixes #7830 Closes #7834
* CURLOPT_HTTPHEADER.3: add descripion for specific headersDaniel Stenberg2021-10-081-0/+10
| | | | | | | Settting Host: or Transfer-Encoding: chunked actually have special meanings to libcurl. This change tries to document them Closes #7829
* CURLOPT_MAXLIFETIME_CONN: maximum allowed lifetime for conn reuseJeffrey Tolar2021-10-066-4/+75
| | | | | | | | | ... and close connections that are too old instead of reusing them. By default, this behavior is disabled. Bug: https://curl.se/mail/lib-2021-09/0058.html Closes #7751
* CURLOPT_PREREQFUNCTION: add new callbackMax Dymond2021-09-275-0/+175
| | | | | | | | | | | | | | Triggered before a request is made but after a connection is set up Changes: - callback: Update docs and callback for pre-request callback - Add documentation for CURLOPT_PREREQDATA and CURLOPT_PREREQFUNCTION, - Add redirect test and callback failure test - Note that the function may be called multiple times on a redirection - Disable new 2086 test due to Windows weirdness Closes #7477
* urlapi: add curl_url_strerror()i-ky2021-09-2712-17/+66
| | | | | | | | | | Add curl_url_strerror() to convert CURLUcode into readable string and facilitate easier troubleshooting in programs using URL API. Extend CURLUcode with CURLU_LAST for iteration in unit tests. Update man pages with a mention of new function. Update example code and tests with new functionality where it fits. Closes #7605
* libssh2: add SHA256 fingerprint supportMats Lindestam2021-09-264-0/+64
| | | | | | | Added support for SHA256 fingerprint in command line curl and in libcurl. Closes #7646
* misc: fix typos in docs and commentsa13460542021-09-231-1/+1
| | | | | | | No user facing output from curl/libcurl is changed by this, just comments. Closes #7747
* hsts: CURLSTS_FAIL from hsts read callback should fail transferDaniel Stenberg2021-09-161-1/+3
| | | | | | | | | | ... and have CURLE_ABORTED_BY_CALLBACK returned. Extended test 1915 to verify. Reported-by: Jonathan Cardoso Fixes #7726 Closes #7729
* opts docs: unify phrasing in NAME headerDaniel Stenberg2021-09-09134-246/+246
| | | | | | | | | | | | | - avoid writing "set ..." or "enable/disable ..." or "specify ..." *All* options for curl_easy_setopt() are about setting or enabling things and most of the existing options didn't use that way of description. - start with lowercase letter, unless abbreviation. For consistency. - Some additional touch-ups Closes #7688
* docs: remove experimental mentions from HSTS and MQTTDaniel Stenberg2021-09-076-36/+6
| | | | | | Reported-by: Jonathan Cardoso Bug: https://github.com/curl/curl/pull/6700#issuecomment-913792863 Closes #7681
* CURLOPT_UNIX_SOCKET_PATH.3: remove nginx reference, add see alsoDaniel Stenberg2021-09-041-4/+5
| | | | Closes #7656
* opt-docs: verify man page sections + orderDaniel Stenberg2021-09-0415-54/+81
| | | | | | | | | | | | | | | | | | | | In every libcurl option man page there are now 8 mandatory sections that must use the right name in the correct order and test 1173 verifies this. Only 14 man pages needed adjustments. The sections and the order is as follows: - NAME - SYNOPSIS - DESCRIPTION - PROTOCOLS - EXAMPLE - AVAILABILITY - RETURN VALUE - SEE ALSO Reviewed-by: Daniel Gustafsson Closes #7656
* opt-docs: make sure all man pages have examplesDaniel Stenberg2021-09-0410-16/+215
| | | | | | | | | Extended manpage-syntax.pl (run by test 1173) to check that every man page for a libcurl option has an EXAMPLE section that is more than two lines. Then fixed all errors it found and added examples. Reviewed-by: Daniel Gustafsson Closes #7656
* curl_easy_setopt: tweak the string copy wordingDaniel Stenberg2021-08-261-5/+5
| | | | | | Reported-by: Yaobin Wen Fixes #7632 Closes #7634
* setopt: enable CURLOPT_IGNORE_CONTENT_LENGTH for hyperDaniel Stenberg2021-08-231-1/+1
| | | | | | | | | | | Since this option is also used for FTP, it needs to work to set for applications even if hyper doesn't support it for HTTP. Verified by test 1137. Updated docs to specify that the option doesn't work for HTTP when using the hyper backend. Closes #7614
* libcurl-errors.3: clarify two CURLUcode errorsDaniel Stenberg2021-08-231-2/+2
| | | | | | | | | | CURLUE_BAD_HANDLE and CURLUE_BAD_PARTPOINTER should be for "bad" or wrong pointers in a generic sense, not just for NULL pointers. Reviewed-by: Jay Satiro Ref: #7605 Closes #7611
* symbols-in-versions: fix CURLSSLBACKEND_QSOSSL last used versionJay Satiro2021-08-231-2/+2
| | | | | | | ... and also change the 'Removed' column name to 'Last' since that column is for the last version to contain the symbol. Closes https://github.com/curl/curl/pull/7609
* mksymbolsmanpage.pl: Fix showing symbol's last used versionJay Satiro2021-08-221-1/+1
| | | | | | | | Prior to this change the symbol's deprecated version was erroneously shown as its last used version. Bug: https://github.com/curl/curl/commit/4e53b94#commitcomment-55239509 Reported-by: i-ky@users.noreply.github.com
* mksymbolsmanpage.pl: match symbols case insenitivelyDaniel Stenberg2021-08-211-2/+2
| | | | | | | | Follow-up to 4e53b9430c750 which made this bug show. Reported-by: i-ky Bug: https://github.com/curl/curl/commit/4e53b9430c7504de8984796e2a2091ec16f27136#commitcomment-55239253 Closes #7607
* man pages: remove trailing whitespacesDaniel Stenberg2021-08-212-3/+3
| | | | | | | | | Extended test 1173 (via the manpage-syntax.pl script) to detect and warn for them. Ref: #7602 Reported-by: a1346054 on github Closes #7604
* sectransp: support CURLINFO_CERTINFOSergey Markelov2021-08-172-4/+6
| | | | | Fixes #4130 Closes #7372
* curl_url_get.3: clarify about path and queryEmil Engler2021-08-131-0/+9
| | | | | | | The current man-page lacks some details regarding the obtained path and query. Closes #7563
* bearssl: support CURLOPT_CAINFO_BLOBAleksandr Krotov2021-07-281-2/+2
| | | | Closes #7468
* CURLOPT_DOH_URL.3: CURLOPT_OPENSOCKETFUNCTION is not inheritedDaniel Stenberg2021-07-281-6/+9
| | | | | | Reported-by: Daniel Woelfel Fixes #7441 Closes #7509
* docs: fix grammarJosh Soref2021-07-271-2/+3
| | | | | | | Fixes https://github.com/curl/curl/issues/7444 Fixes https://github.com/curl/curl/issues/7451 Fixes https://github.com/curl/curl/issues/7465 Closes https://github.com/curl/curl/pull/7495
* CURLOPT_SSL_CTX_*.3: tidy up the exampleDaniel Stenberg2021-07-262-18/+92
| | | | | | | Use the proper code style. Don't store return codes that aren't read. Copy the same example into CURLOPT_SSL_CTX_FUNCTION.3 as well. Closes #7500
* docs: change max-filesize caveat againJay Satiro2021-07-232-6/+6
| | | | | | | | | | | | | | | - Add protocols field to max-filesize.d. - Revert wording on unknown file size caveat and do not discuss specific protocols in that section. Partial revert of ecf0225. All max-filesize options now have the list of protocols and it's clearer just to have that list without discussing specific protocols in the caveat. Reported-by: Josh Soref Ref: https://github.com/curl/curl/issues/7453#issuecomment-884128762
* CURLMOPT_TIMERFUNCTION.3: remove misplaced "time"Oleg Pudeyev2021-07-211-1/+1
| | | | Closes #7470
* docs: mention max-filesize options also apply to MQTT transfersJay Satiro2021-07-212-8/+8
| | | | | | | | | | Also make it clearer that the caveat 'if the file size is unknown it the option will have no effect' may apply to protocols other than FTP and HTTP. Reported-by: Josh Soref Fixes https://github.com/curl/curl/issues/7453
* docs: correct spelling errors and a broken linkNyholm2021-07-181-1/+1
| | | | | | | Update grammar and spelling in docs and source code comments. Closes: #7427 Reviewed-by: Daniel Stenberg <daniel@haxx.se>
* cleanup: spell DoH with a lowercase oJosh Soref2021-07-166-35/+35
| | | | | | Signed-off-by: Josh Soref <jsoref@users.noreply.github.com> Closes #7413
* docs: fix inconsistencies in EGDSOCKET documentationDaniel Gustafsson2021-07-141-3/+3
| | | | | | | | | Only the OpenSSL backend actually use the EGDSOCKET, and also use TLS consistently rather than mixing SSL and TLS. While there, also fix a minor spelling nit. Closes: #7391 Reviewed-by: Jay Satiro <raysatiro@yahoo.com>
* docs: fix incorrect argument name referenceRandolf J2021-07-131-2/+2
| | | | | | | | | The documentation for the read callback was erroneously referencing the nitems argument by nmemb. The error was introduced in commit ce0881edee3c7. Closes #7383 Reviewed-by: Daniel Gustafsson <daniel@yesql.se>
* msnprintf: return number of printed characters excluding null byteDaniel Stenberg2021-07-081-3/+3
| | | | | | | | ... even when the output is "capped" by the maximum length argument. Clarified in the docs. Closes #7361
* libcurl-security.3: mention file descriptors and forksDaniel Stenberg2021-06-171-4/+13
| | | | | | | ... and move the security report section last. Reported-by: Harry Sintonen Closes #7270
* idn: fix libidn2 with windows unicode buildsViktor Szakats2021-06-151-1/+1
| | | | | | | | | | | | | Unicode Windows builds use UTF-8 strings internally in libcurl, so make sure to call the UTF-8 flavour of the libidn2 API. Also document that Windows builds with libidn2 and UNICODE do expect CURLOPT_URL as an UTF-8 string. Reported-by: dEajL3kA on github Assisted-by: Jay Satiro Reviewed-by: Marcel Raad Closes #7246 Fixes #7228
* curl_url_set: reject spaces in URLs w/o CURLU_ALLOW_SPACEDaniel Stenberg2021-06-152-0/+10
| | | | | | | | | | | | | They were never officially allowed and slipped in only due to sloppy parsing. Spaces (ascii 32) should be correctly encoded (to %20) before being part of a URL. The new flag bit CURLU_ALLOW_SPACE when a full URL is set, makes libcurl allow spaces. Updated test 1560 to verify. Closes #7073
* CURLOPT_WRITEFUNCTION.3: minor update of the exampleFawad Mirza2021-06-091-1/+1
| | | | | | Safely avoid chunk.size garbage value if declared non globally. Closes #7219
* test269: disable for hyperDaniel Stenberg2021-06-031-2/+3
| | | | | | | --ignore-content-length / CURLOPT_IGNORE_CONTENT_LENGTH doesn't work with hyper. Closes #7184
* CURLE_SETOPT_OPTION_SYNTAX: new error name for wrong setopt syntaxDaniel Stenberg2021-06-022-2/+4
| | | | | | | | | For options that pass in lists or strings that are subsequently parsed and must be correct. This broadens the scope for the option previously known as CURLE_TELNET_OPTION_SYNTAX but the old name is of course still provided as a #define for existing applications. Closes #7175
* docs: fix typosDaniel Gustafsson2021-05-311-1/+1
|
* copyright: update copyright year ranges to 2021Daniel Stenberg2021-05-261-1/+1
|
View Lorry Controller Status