summaryrefslogtreecommitdiff
path: root/docs/libcurl
Commit message (Collapse)AuthorAgeFilesLines
* ssh: Add support for libssh2 read timeoutDaniel Silverstone2023-05-151-1/+4
| | | | | | | | | | | | Hook the new (1.11.0 or newer) libssh2 support for setting a read timeout into the SERVER_RESPONSE_TIMEOUT option. With this done, clients can use the standard curl response timeout setting to also control the time that libssh2 will wait for packets from a slow server. This is necessary to enable use of very slow SFTP servers. Signed-off-by: Daniel Silverstone <daniel.silverstone@codethink.co.uk> Closes #10965
* CURLOPT_DNS_CACHE_TIMEOUT.3: fix spellingDaniel Stenberg2023-05-101-1/+1
| | | | | | Follow-up to 9ed7d56e044f5aa1b29 Closes #11096
* CURLOPT_IPRESOLVE.3: clarify that this for host names, not IP addressesDaniel Stenberg2023-05-081-2/+7
| | | | | Reported-by: Harry Sintonen Closes #11087
* hostip: enforce a maximum DNS cache size independent of timeout valueDaniel Stenberg2023-05-081-2/+10
| | | | | | | | | | To reduce the damage an application can cause if using -1 or other ridiculous timeout values and letting the cache live long times. The maximum number of entries in the DNS cache is now totally arbitrarily and hard-coded set to 29999. Closes #11084
* docs: minor polishDaniel Stenberg2023-04-273-3/+3
| | | | | | | | | - "an HTTP*" (not "a") - remove a few contractions - remove a spurious "a" - reduce use of "I" in texts Closes #11040
* docs: clarify that more backends have HTTPS proxy supportDaniel Stenberg2023-04-262-2/+9
| | | | Closes #11033
* docs/libcurl/curl_*escape.3: rename "url" argument to "input"/"string"Emanuele Torre2023-04-263-14/+14
| | | | | | | Also reword the DESCRIPTION section to mention "input"/"string" argument in bold. Closes #11027
* docs/libcurl: minor cleanupsEmanuele Torre2023-04-265-10/+10
| | | | | | | | | | | | | | | | | | | | | | | | | I was reading curl_unescape(3) and I noticed that there was an extra space after the open parenthesis in the SYNOPSIS; I removed the extra space. I also ran a few grep -r commands to find and remove extra spaces after '(' in other files, and to find and replace uses of `T*' instead of `T *'. Some of the instances of `T*` where unnecessary casts that I removed. I also fixed a comment that was misaligned in CURLMOPT_SOCKETFUNCTION.3. And I fixed some formatting inconsistencies: in curl_unescape(3), all function parameter were mentioned with bold text except length, that was mentioned as 'length'; and, in curl_easy_unescape(3), all parameters were mentioned in bold text except url that was italicised. Now they are all mentioned in bold. Documentation is not very consistent in how function parameter are formatted: many pages italicise them, and others display them in bold text; but I think it makes sense to at least be consistent with formatting within the same page. Closes #11027
* man pages: simplify the .TH sectionsDaniel Stenberg2023-04-26483-484/+484
| | | | | | | | | | - remove the version numbers - simplify the texts The date and version number will be put there for releases when maketgz runs the updatemanpages.pl script. Closes #11029
* curl_easy_unescape.3: rename the argumentDaniel Stenberg2023-04-171-5/+5
| | | | | | and highlight it appropriately in the text. Closes #10979
* libcurl-thread.3: improved name resolver wordingDaniel Stenberg2023-04-141-20/+24
| | | | | | And make better .SH sections Closes #10966
* CURLOPT_PROXY_SSL_VERIFYPEER.3: fix minor grammar mistakeColman Mbuya2023-04-141-1/+1
| | | | Closes #10968
* KNOWN_BUGS: remove fixed or outdated issues, move non-bugsDaniel Stenberg2023-04-141-0/+3
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | - remove h3 issues believed to be fixed - make the flaky CI issue be generic and not Windows specific - "TLS session cache does not work with TFO" now documented This is now a documented restriction and not a bug. TFO in general is rarely used and has other problems, making it a low-priotity thing to work on. - remove "Renegotiate from server may cause hang for OpenSSL backend" This is an OpenSSL issue, not a curl one. Even if it taints curl. - rm "make distclean loops forever" - rm "configure finding libs in wrong directory" Added a section to docs/INSTALL.md about it. - "A shared connection cache is not thread-safe" Moved over to TODO and expanded for other sharing improvements we could do - rm "CURLOPT_OPENSOCKETPAIRFUNCTION is missing" - rm "Blocking socket operations in non-blocking API" Already listed as a TODO - rm "curl compiled on OSX 10.13 failed to run on OSX 10.10" Water under the bridge. No one cares about this anymore. - rm "build on Linux links libcurl to libdl" Verified to not be true (anymore). - rm "libpsl is not supported" The cmake build supports it since cafb356e19cda22 Closes #10963
* curl_url_set.3: mention that users can set content rather freelyDaniel Stenberg2023-04-111-0/+5
| | | | | | ... which then might render bad URLs if you extract a URL later. Closes #10921
* CURLPROXY_HTTPS2: for HTTPS proxy that may speak HTTP/2Daniel Stenberg2023-04-082-1/+4
| | | | | | | Setting this proxy type allows curl to negotiate and use HTTP/2 with HTTPS proxies. Closes #10900
* openssl: interop with AWS-LCJim King2023-03-302-0/+3
| | | | | | | | | | | | | * Configure changes to detect AWS-LC * CMakeLists.txt changes to detect AWS-LC * Compile-time branches needed to support AWS-LC * Correctly set OSSL_VERSION and report AWS-LC release number * GitHub Actions script to build with autoconf and cmake against AWS-LC AWS-LC is a BoringSSL/OpenSSL derivative For more information see https://github.com/awslabs/aws-lc/ Closes #10320
* curl_easy_getinfo.3: typo fix (duplicated "from the")Frank Gevaerts2023-03-281-1/+1
| | | | Closes #10850
* doc: curl_mime_init() strong easy handle binding has been relaxed in 7.87.0Patrick Monnerat2023-03-261-2/+2
| | | | | | Reported-by: Chloe Kudryavtsev Fixes #10834 Closes #10835
* CURLOPT_WRITEFUNCTION.3: fix typoJay Satiro2023-03-251-1/+1
| | | | | | Reported-by: Osaila@users.noreply.github.com Fixes https://github.com/curl/curl/issues/10839
* lib2305: deal with CURLE_AGAINDaniel Stenberg2023-03-161-0/+4
| | | | | | | | | | | The test does a slightly ugly busy-loop for this case but should be managable due to it likely being a very short moment. Mention CURLE_AGAIN in curl_ws_recv.3 Fixes #10760 Reported-by: Jay Satiro Closes #10781
* aws_sigv4: fall back to UNSIGNED-PAYLOAD for sign_as_s3Casey Bodley2023-03-141-0/+4
| | | | | | | | | | all s3 requests default to UNSIGNED-PAYLOAD and add the required x-amz-content-sha256 header. this allows CURLAUTH_AWS_SIGV4 to correctly sign s3 requests to amazon with no additional configuration Signed-off-by: Casey Bodley <cbodley@redhat.com> Closes #9995
* CURLOPT_PROXY.3: curl+NSS does not handle HTTPS over unix domain socketDaniel Stenberg2023-03-101-0/+3
| | | | | | | | | | It results in error "NSS error -5985 (PR_ADDRESS_NOT_SUPPORTED_ERROR)" Disabled test 1470 for NSS builds and documented the restriction. Reported-by: Dan Fandrich Fixes #10723 Closes #10734
* CURLSHOPT_SHARE.3: HSTS sharing is not thread-safeDaniel Stenberg2023-03-101-2/+3
| | | | | Reported-by: Hiroki Kurosawa Closes #10732
* doc: fix compiler warning in libcurl.m4Evgeny Grin (Karlson2k)2023-03-081-3/+4
| | | | | | | | | Current test for curl_free() may produce warnings with strict compiler flags or even with default compiler flags with upcoming versions. These warning could turned into errors by -Werror or similar flags. Such warnings/errors are avoided by this patch. Closes #10710
* misc: fix typosViktor Szakats2023-03-081-1/+1
| | | | Closes #10706
* docs: extend the URL API descriptionsDaniel Stenberg2023-03-072-6/+37
| | | | Closes #10701
* urlapi: parse IPv6 literals without ENABLE_IPV6Brad Spencer2023-03-031-0/+3
| | | | | | | This makes the URL parser API stable and working the same way independently of libcurl supporting IPv6 transfers or not. Closes #10660
* libcurl-errors.3: add the CURLHcode errors from curl_easy_header.3Daniel Stenberg2023-02-282-15/+19
| | | | Closes #10629
* CURLOPT_WS_OPTIONS.3: fix the availability versionPierrick Charron2023-02-181-1/+1
| | | | Closes #10557
* man pages: call the custom user pointer 'clientp' consistentlyDaniel Stenberg2023-02-0718-46/+46
| | | | | | | | | | | The variable had a few different names. Now try to use 'clientp' consistently for all man pages using a custom pointer set by the application. Reported-by: Gerrit Renker Fixes #10434 Closes #10435
* curl_ws_send.3: clarify how to send multi-frame messagesDaniel Stenberg2023-02-061-0/+2
|
* CURLOPT_WRITEFUNCTION.3: fix memory leak in exampleThomas16642023-02-031-22/+35
| | | | Closes #10390
* curl_free.3: fix return type of `curl_free`Thomas1664 on github2023-01-311-1/+1
| | | | | Fixes #10373 Closes #10374
* CURLOPT_READFUNCTION.3: the callback 'size' arg is always 1Daniel Stenberg2023-01-291-1/+1
| | | | | | Reported-by: Brian Green Fixes #10328 Closes #10355
* docs: POSTFIELDSIZE must be set to -1 with read functionDan Fandrich2023-01-202-8/+10
| | | | | | Reported-by: RanBarLavie on github Closes #10313
* curl_version_info.3: fix typoSergey Bronnikov2023-01-171-1/+1
| | | | Closes https://github.com/curl/curl/pull/10306
* openssl: Don't ignore CA paths when using Windows CA store (redux)Jay Satiro2023-01-172-2/+9
| | | | | | | | | | | | | | | | | | | | | | | | .. and remove 'experimental' designation from CURLSSLOPT_NATIVE_CA. This commit restores the behavior of CURLSSLOPT_NATIVE_CA so that it does not override CURLOPT_CAINFO / CURLOPT_CAPATH, or the hardcoded default locations. Instead the native Windows CA store can be used at the same time. --- This behavior was originally added over two years ago in abbc5d60 (#5585) but then 83393b1a (#7892) broke it over a year ago, I assume inadvertently. The CURLSSLOPT_NATIVE_CA feature was marked experimental and likely rarely used. Ref: https://github.com/curl/curl/pull/5585 Ref: https://github.com/curl/curl/pull/7892 Ref: https://curl.se/mail/lib-2023-01/0019.html Closes https://github.com/curl/curl/pull/10244
* curl.h: add CURL_HTTP_VERSION_3ONLYDaniel Stenberg2023-01-122-7/+7
| | | | | | As the previous CURL_HTTP_VERSION_3 option gets a slightly altered meaning. Closes #10264
* curl.h: allow up to 10M buffer sizeDaniel Stenberg2023-01-081-1/+3
| | | | | | | | | | Bump the limit from 512K. There might be reasons for applications using h3 to set larger buffers and there is no strong reason for curl to have a very small maximum. Ref: https://curl.se/mail/lib-2023-01/0026.html Closes #10256
* CURLOPT_HEADERDATA.3: warn DLL users must set write functionJay Satiro2023-01-061-0/+4
| | | | | | | | | | | | | | | | - Warn that in Windows if libcurl is running from a DLL and if CURLOPT_HEADERDATA is set then CURLOPT_WRITEFUNCTION or CURLOPT_HEADERFUNCTION must be set as well, otherwise the user may experience crashes. We already have a similar warning in CURLOPT_WRITEDATA. Basically, in Windows libcurl could crash writing a FILE pointer that was created by a different C runtime. In Windows each DLL that is part of a program may or may not have its own C runtime. Ref: https://github.com/curl/curl/issues/10231 Closes https://github.com/curl/curl/pull/10233
* copyright: update all copyright lines and remove year rangesDaniel Stenberg2023-01-03493-494/+494
| | | | | | | | | | | | - they are mostly pointless in all major jurisdictions - many big corporations and projects already don't use them - saves us from pointless churn - git keeps history for us - the year range is kept in COPYING checksrc is updated to allow non-year using copyright statements Closes #10205
* curl_global_sslset.3: clarify the openssl situationDaniel Stenberg2023-01-011-4/+14
| | | | | | and add rustls Closes #10188
* docs/libcurl/curl_getdate.3: minor whitespace editDaniel Stenberg2022-12-301-2/+3
| | | | To avoid a fccp quirk that made it render wrongly on the website
* share: add sharing of HSTS cache among handlesDaniel Stenberg2022-12-272-0/+5
| | | | Closes #10138
* urlapi: add CURLU_PUNYCODEDaniel Stenberg2022-12-262-0/+13
| | | | | | | | | Allows curl_url_get() get the punycode version of host names for the host name and URL parts. Extend test 1560 to verify. Closes #10109
* docs: mention indirect effects of --insecureDaniel Stenberg2022-12-212-0/+16
| | | | | | | | Warn users that disabling certficate verification allows servers to "pollute" curl with data it trusts. Reported-by: Harry Sintonen Closes #10126
* CURLOPT_DEBUGFUNCTION.3: emphasize that incoming data is "raw"Daniel Stenberg2022-12-161-1/+4
| | | | Closes #10106
* curl_url_get.3: remove spurious backtickDaniel Stenberg2022-12-151-1/+1
| | | | | | | | Put there by mistake. Follow-up from 9a8564a92 Closes #10101
* curl_url_set.3: document CURLU_DISALLOW_USERDaniel Stenberg2022-12-151-0/+4
| | | | Closes #10099
* curl_url_set.3: fix typoEmil Engler2022-12-131-1/+1
| | | | | Closes: #10089 Reviewed-by: Daniel Gustafsson <daniel@yesql.se>