summaryrefslogtreecommitdiff
path: root/docs/libcurl/opts
Commit message (Collapse)AuthorAgeFilesLines
* docs: document HTTP/2 not insisting on TLS 1.2bagder/docs-http2Daniel Stenberg2022-01-191-1/+5
| | | | | | | Both for --http2 and CURLOPT_HTTP_VERSION. Reported-by: jhoyla on github Fixes #8235
* CURLMOPT_TIMERFUNCTION/DATA.3: fix the examplesDaniel Stenberg2022-01-172-8/+8
| | | | | | ... to not call libcurl recursively back. Closes #8286
* mbedtls: fix CURLOPT_SSLCERT_BLOB (again)Niels Martignène2022-01-151-4/+5
| | | | | | | | | | | | | | - Increase the buffer length passed to mbedtls_x509_crt_parse to account for the null byte appended to the temporary blob. Follow-up to 867ad1c which uses a null terminated copy of the certificate blob, because mbedtls_x509_crt_parse requires PEM data to be null terminated. Ref: https://github.com/curl/curl/commit/867ad1c#r63439893 Ref: https://github.com/curl/curl/pull/8146 Closes https://github.com/curl/curl/pull/8260
* openldap: implement SASL authenticationPatrick Monnerat2022-01-114-17/+18
| | | | | | | | | | | As credentials can be quite different depending on the mechanism used, there are no default mechanisms for LDAP and simple bind with a DN is then used. The caller has to provide mechanism(s) using CURLOPT_LOGIN_OPTIONS to enable SASL authentication and disable simple bind. Closes #8152
* CURLOPT_RESOLVE.3: change example port to 443Cameron Will2022-01-101-1/+1
| | | | | | | | 83cc966 changed documentation from using http to https. However, CURLOPT_RESOLVE being set to port 80 in the documentation means that it isn't valid for the new URL. Update to 443. Closes https://github.com/curl/curl/pull/8258
* rustls: add CURLOPT_CAINFO_BLOB supportStephen M. Coakley2022-01-102-2/+2
| | | | | | | | | | | | | | | Add support for `CURLOPT_CAINFO_BLOB` `CURLOPT_PROXY_CAINFO_BLOB` to the rustls TLS backend. Multiple certificates in a single PEM string are supported just like OpenSSL does with this option. This is compatible at least with rustls-ffi 0.8+ which is our new minimum version anyway. I was able to build and run this on Windows, pulling trusted certs from the system and then add them to rustls by setting `CURLOPT_CAINFO_BLOB`. Handy! Closes #8255
* url: given a user in the URL, find pwd for that user in netrcDaniel Stenberg2022-01-091-17/+13
| | | | | | | | Add test 380 and 381 to verify, edited test 133 Reported-by: Manfred Schwarb Fixes #8241 Closes #8243
* docs: fix mandoc -T lint formatting complaintsDaniel Stenberg2022-01-052-25/+22
| | | | Closes #8228
* misc: s/e-mail/emailDaniel Stenberg2021-12-191-1/+1
| | | | | | Consistency is king. Following the lead in everything curl. Closes #8159
* openldap: several minor improvementsPatrick Monnerat2021-12-151-7/+7
| | | | | | | | | | | | - Early check proper LDAP URL syntax. Reject URLs with a userinfo part. - Use dynamic memory for ldap_init_fd() URL rather than a stack-allocated buffer. - Never chase referrals: supporting it would require additional parallel connections and alternate authentication credentials. - Do not wait 1 microsecond while polling/reading query response data. - Store last received server code for retrieval with CURLINFO_RESPONSE_CODE. Closes #8140
* CURLSHOPT_USERDATA.3: fix copy-paste mistakeRekGRpth2021-12-091-1/+1
| | | | Closes #8124
* CURLOPT_RESOLVE.3: minor polishDaniel Stenberg2021-12-071-26/+34
| | | | | | | | | | Minor rephrasing for some explanations. Put the format strings in stand-alone lines with .nf/.fi to be easier to spot. Move "added in" to AVAILABILITY Closed #8110
* CURLOPT_STDERR.3: does not work with libcurl as a win32 DLLDaniel Stenberg2021-12-061-0/+5
| | | | | | | | | | This is the exact same limitation already documented for CURLOPT_WRITEDATA but should be clarified here. It also has a different work-around. Reported-by: Stephane Pellegrino Bug: https://github.com/curl/curl/issues/8102 Closes #8103
* multi: handle errors returned from socket/timer callbacksDaniel Stenberg2021-12-062-3/+11
| | | | | | | | | | | | The callbacks were partially documented to support this. Now the behavior is documented and returning error from either of these callbacks will effectively kill all currently ongoing transfers. Added test 530 to verify Reported-by: Marcelo Juchem Fixes #8083 Closes #8089
* openldap: implement STARTTLSPatrick Monnerat2021-12-061-2/+4
| | | | | | | As this introduces use of CURLOPT_USE_SSL option for LDAP, also check this option in ldap.c as it is not supported by this backend. Closes #8065
* CURLMOPT_TIMERFUNCTION.3: call it expire time, not intervalDaniel Stenberg2021-12-021-3/+3
| | | | Since we say it is a non-repating timer
* mbedTLS: add support for CURLOPT_CAINFO_BLOBFlorian Van Heghe2021-11-301-1/+1
| | | | Closes #8071
* docs: consistent manpage SYNOPSISDaniel Stenberg2021-11-26305-220/+907
| | | | | | | | | | Make all libcurl related options use .nf (no fill) for the SYNOPSIS section - for consistent look. roffit then renders that section using <pre> (monospace font) in html for the website. Extended manpage-syntax (test 1173) with a basic check for it. Closes #8062
* docs: address proselint nitsDaniel Stenberg2021-11-261-1/+1
| | | | | | | | | - avoid exclamation marks - use consistent number of spaces after periods: one - avoid clichés - avoid using 'very' Closes #8060
* mime: use percent-escaping for multipart form field and file namesPatrick Monnerat2021-11-152-0/+90
| | | | | | | | | | | | | | | | | | Until now, form field and file names where escaped using the backslash-escaping algorithm defined for multipart mails. This commit replaces this with the percent-escaping method for URLs. As this may introduce incompatibilities with server-side applications, a new libcurl option CURLOPT_MIME_OPTIONS with bitmask CURLMIMEOPT_FORMESCAPE is introduced to revert to legacy use of backslash-escaping. This is controlled by new cli tool option --form-escape. New tests and documentation are provided for this feature. Reported by: Ryan Sleevi Fixes #7789 Closes #7805
* curl_share_setopt.3: split out options into their own manpagesDaniel Stenberg2021-11-126-1/+366
| | | | | | | | | | CURLSHOPT_LOCKFUNC.3 CURLSHOPT_SHARE.3 CURLSHOPT_UNLOCKFUNC.3 CURLSHOPT_UNSHARE.3 CURLSHOPT_USERDATA.3 Closes #7998
* docs: NAME fixes in easy option man pagesDaniel Stenberg2021-11-0827-46/+46
| | | | Closes #7975
* docs: reduce/avoid English contractionsDaniel Stenberg2021-11-0794-137/+137
| | | | | | | | | | | You're => You are Hasn't => Has not Doesn't => Does not Don't => Do not You'll => You will etc Closes #7930
* man pages: fix backslash-n in examplesDaniel Stenberg2021-11-052-2/+2
| | | | | | | | | | | ... to be proper backslash-backslash-n sequences to render nicely in man and on website. Follow-up to 24155569d8a Reported-by: Sergey Markelov Fixes https://github.com/curl/curl-www/issues/163 Closes #7962
* CURLOPT_ALTSVC_CTRL.3: mention conn reuse is preferredDaniel Stenberg2021-11-041-2/+6
| | | | | | Ref: https://github.com/curl/curl/discussions/7954 Closes #7957
* docs: reduce use of "very"Daniel Stenberg2021-11-0120-55/+55
| | | | | | | "Very" should be avoided in most texts. If intensifiers are needed, try find better words instead. Closes #7936
* CURLOPT_[PROXY]_SSL_CIPHER_LIST.3: bold instead of quoteDaniel Stenberg2021-11-012-22/+21
| | | | | | | | | | | Bold the example ciphers instead of using single quotes, which then also avoids the problem of how to use single quotes when first in a line. Also rephrased the pages a little. Reported-by: Sergio Durigan Junior Ref: #7928 Closes #7934
* CURLOPT_HSTSWRITEFUNCTION.3: using CURLOPT_HSTS_CTRL is requiredJonathan Cardoso Machado2021-10-291-0/+3
| | | | Closes #7923
* opt-manpages: use 'Added in' instead of 'Since'Daniel Stenberg2021-10-274-4/+4
| | | | Closes #7913
* docs: fix typo in CURLOPT_TRAILERFUNCTION exampleKerem Kat2021-10-261-1/+1
| | | | Closes #7910
* docs: consistent use of "Added in"Daniel Stenberg2021-10-2512-25/+25
| | | | | Make them all say "Added in [version]" without using 'curl' or 'libcurl' in that phrase.
* 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
* 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-064-3/+71
| | | | | | | | | ... 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-273-0/+167
| | | | | | | | | | | | | | 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-272-2/+2
| | | | | | | | | | 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-262-0/+61
| | | | | | | 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
* 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
* man pages: remove trailing whitespacesDaniel Stenberg2021-08-211-1/+1
| | | | | | | | | 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
* 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