summaryrefslogtreecommitdiff
path: root/docs
Commit message (Collapse)AuthorAgeFilesLines
* curl.1: require "see also" for every documented optionbagder/curl-1-seealsoDaniel Stenberg2021-11-15168-8/+179
| | | | | | | gen.pl now generates a warning if the "See Also" field is not filled in for a command line option All command line options now provide one or more related options.
* Revert "form-escape.d: double the back-slashes for proper man page output"Daniel Stenberg2021-11-151-1/+1
| | | | | | This reverts commit a2d8eac04a4eb1d5a98cf24b4e5cec5cec565d27. silly me, it was intended to be one backslash!
* form-escape.d: double the back-slashes for proper man page outputDaniel Stenberg2021-11-151-1/+1
|
* page-footer: add a mention of how to report bugs to the man pageDaniel Stenberg2021-11-151-0/+3
|
* mime: use percent-escaping for multipart form field and file namesPatrick Monnerat2021-11-157-0/+106
| | | | | | | | | | | | | | | | | | 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
* zuul.d: update rustls-ffi to version 0.8.2Kevin Burke2021-11-151-2/+2
| | | | | | | | This version fixes errors with ALPN negotiation in rustls, which is necessary for HTTP/2 support. For more information see the rustls-ffi changelog. Closes #8013
* curl_share_setopt.3: refer to CURLSHOPT_USERDATA(3) properlyDaniel Stenberg2021-11-121-2/+1
|
* curl_share_setopt.3: split out options into their own manpagesDaniel Stenberg2021-11-127-70/+370
| | | | | | | | | | CURLSHOPT_LOCKFUNC.3 CURLSHOPT_SHARE.3 CURLSHOPT_UNLOCKFUNC.3 CURLSHOPT_UNSHARE.3 CURLSHOPT_USERDATA.3 Closes #7998
* docs/checksrc: Add documentation for STRERRORRikard Falkeborn2021-11-111-1/+3
| | | | Closes #7991
* vtls/rustls: adapt to the updated rustls_version protoDaniel Stenberg2021-11-111-2/+2
| | | | Closes #7956
* curl_easy_cleanup.3: remove from multi handle firstDaniel Stenberg2021-11-101-0/+4
| | | | | | | | | Easy handles that are used by the multi interface should be removed from the multi handle before they are cleaned up. Reported-by: Stephen M. Coakley Ref: #7982 Closes #7983
* THANKS: add contributors from the 7.80.0 cycleDaniel Stenberg2021-11-101-0/+45
|
* docs: NAME fixes in easy option man pagesDaniel Stenberg2021-11-0827-46/+46
| | | | Closes #7975
* curl_easy_perform.3: add a para about recv and send dataDaniel Stenberg2021-11-081-0/+6
| | | | | | Reported-by: Godwin Stewart Fixes #7973 Closes #7974
* libcurl-easy.3: language polishDaniel Stenberg2021-11-081-5/+6
|
* limit-rate.d: this is average over several secondsDaniel Stenberg2021-11-081-0/+3
| | | | Closes #7970
* docs: reduce/avoid English contractionsDaniel Stenberg2021-11-07263-923/+924
| | | | | | | | | | | 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-0520-22/+22
| | | | | | | | | | | ... 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
* curl.1: fix typos in the manpageSergio Durigan Junior2021-11-012-3/+3
| | | | | | | | s/transfering/transferring/ s/transfered/transferred/ Signed-off-by: Sergio Durigan Junior <sergiodj@sergiodj.net> Closes #7937
* docs: reduce use of "very"Daniel Stenberg2021-11-0151-236/+232
| | | | | | | "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
* gen.pl: replace leading single quotes with \(aqDaniel Stenberg2021-11-015-4/+6
| | | | | | | | | | ... and allow single quotes to be used "normally" in the .d files. Makes the output curl.1 use better nroff. Reported-by: Sergio Durigan Junior Ref: #7928 Closes #7933
* smooth-gtk-thread.c: enhance the mutex lock useDaniel Stenberg2021-11-011-39/+31
| | | | | | Reported-by: ryancaicse on github Fixes #7926 Closes #7931
* 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/HYPER: remove some remaining issues, add HTTP/0.9 limitationDaniel Stenberg2021-10-261-6/+2
|
* hyper: disable test 1294 since hyper doesn't allow such crazy headersDaniel Stenberg2021-10-251-0/+1
| | | | Closes #7905
* Makefile.m32: fix to not require OpenSSL with -libssh2 or -rtmp optionsViktor Szakats2021-10-251-3/+8
| | | | | | | | | | | | | | | Previously, -libssh2/-rtmp options assumed that OpenSSL is also enabled (and then failed with an error when not finding expected OpenSSL headers), but this isn't necessarly true, e.g. when building both libssh2 and curl against Schannel. This patch makes sure to only enable the OpenSSL backend with -libssh2/-rtmp, when there was no SSL option explicitly selected. - Re-implement the logic as a single block of script. - Also fix an indentation while there. Assisted-by: Jay Satiro Closes #7895
* 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/HTTP3: improve build instructionsDavid Hu2021-10-251-7/+14
| | | | | | | | | | | | | | 1. If writing to a system path if the command is not prefixed with `sudo` it will cause a permission denied error 2. The patched OpenSSL branch has been updated to `openssl-3.0.0+quic` to match upstream OpenSSL version. 3. We should not disable GnuTLS docs. Updated some commands about `make install` Closes #7842
* 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-222-1/+3
| | | | | | | | Simply because hyper doesn't have this ability. Mentioned in docs now. Skip test 326 then Closes #7889
* INSTALL: update symbol hiding optionÉrico Nogueira2021-10-221-1/+1
| | | | | | | --enable-hidden-symbols was deprecated in 9e24b9c7afbcb81120af4cf3f6cdee49a06d8224. Closes #7890
* URL-SYNTAX: add IMAP UID SEARCH exampleJay Satiro2021-10-211-5/+24
| | | | | | | | | | | | | - Explain the difference between IMAP search via URL (which returns message sequence numbers) and IMAP search via custom request (which can return UID numbers if prefixed with UID, eg "UID SEARCH ..."). Bug: https://github.com/curl/curl/issues/7626 Reported-by: orycho@users.noreply.github.com Ref: https://github.com/curl/curl/issues/2789 Closes https://github.com/curl/curl/pull/7881
* 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
* docs/THANKS: removed on requestDaniel Stenberg2021-10-201-1/+0
|
* FAQ: polish the explanation of libcurlDaniel Stenberg2021-10-201-2/+2
|
* curl_easy_perform.3: minor wording tweakDaniel Stenberg2021-10-201-3/+3
|
* examples/htmltidy: correct wrong printf() useDaniel Stenberg2021-10-151-4/+4
| | | | | | | | | ... and update the includes to match how current htmltidy wants them used. Reported-by: Stathis Kapnidis Fixes #7860 Closes #7861
* docs/Makefile.am: repair 'make html'Daniel Stenberg2021-10-141-1/+1
| | | | | | by removing index.html which isn't around anymore Closes #7853
* 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
* docs/examples: add missing binaries to gitignoreDaniel Gustafsson2021-10-061-0/+2
| | | | | | | | Commit f65d7889b added getreferrer, and commit ae8e11ed5 multi-legacy, both of which missed adding .gitignore clauses for the built binaries. Closes #7817 Reviewed-by: Daniel Stenberg <daniel@haxx.se>
* HTTP3: fix the HTTP/3 Explained book linkJosip Medved2021-10-051-1/+1
| | | | Closes #7813