curl/docs
Daniel Stenberg 8dab7465a5
libcurl-docs: make option lists alpha-sorted
The man pages for curl_easy_getinfo, curl_easy_setopt and
curl_multi_setopt now feature the lists of options alphabetically
sorted. Test 1139 verify that they are.

The curl_multi_setopt page also got brief explanations of the listed
options.

Closes #14156
2024-07-14 13:44:24 +02:00
..
cmdline-opts variable.md: make example use expand 2024-07-08 23:15:56 +02:00
examples tidy-up: adjust casing of project names 2024-07-12 13:56:16 +02:00
libcurl libcurl-docs: make option lists alpha-sorted 2024-07-14 13:44:24 +02:00
.gitignore docs: add RELEASE-TOOLS.md.dist to .gitignore 2024-07-01 22:49:55 +02:00
ALTSVC.md reuse: add copyright + license info to individual docs/*.md files 2024-03-31 12:01:18 +02:00
BINDINGS.md BINDINGS: update java link to one that exists 2024-06-14 09:47:47 +02:00
BUFQ.md reuse: add copyright + license info to individual docs/*.md files 2024-03-31 12:01:18 +02:00
BUFREF.md reuse: add copyright + license info to individual docs/*.md files 2024-03-31 12:01:18 +02:00
BUG-BOUNTY.md BUG-BOUNTY.md: clarify the third party situation 2024-05-14 16:23:42 +02:00
BUGS.md reuse: add copyright + license info to individual docs/*.md files 2024-03-31 12:01:18 +02:00
CHECKSRC.md reuse: add copyright + license info to individual docs/*.md files 2024-03-31 12:01:18 +02:00
CIPHERS.md tidy-up: adjust casing of project names 2024-07-12 13:56:16 +02:00
CLIENT-READERS.md CI: add whitespace checker 2024-06-27 13:33:30 +02:00
CLIENT-WRITERS.md reuse: add copyright + license info to individual docs/*.md files 2024-03-31 12:01:18 +02:00
CMakeLists.txt cmake: whitespace, formatting/tidy-up in comments 2024-05-27 18:07:10 +02:00
CODE_OF_CONDUCT.md reuse: add copyright + license info to individual docs/*.md files 2024-03-31 12:01:18 +02:00
CODE_REVIEW.md docs: misc language polish 2024-07-01 16:45:17 +02:00
CODE_STYLE.md reuse: add copyright + license info to individual docs/*.md files 2024-03-31 12:01:18 +02:00
CONNECTION-FILTERS.md CI: add whitespace checker 2024-06-27 13:33:30 +02:00
CONTRIBUTE.md reuse: switch to REUSE 3.2 and REUSE.toml 2024-07-05 20:47:48 +02:00
CURL-DISABLE.md reuse: add copyright + license info to individual docs/*.md files 2024-03-31 12:01:18 +02:00
CURLDOWN.md tidy-up: adjust casing of project names 2024-07-12 13:56:16 +02:00
DEPRECATE.md docs: start markdown headers with capital letter where applicable 2024-07-10 16:24:25 +02:00
DISTROS.md DISTROS: add AlmaLinux package source link 2024-07-11 12:52:58 -07:00
DYNBUF.md reuse: add copyright + license info to individual docs/*.md files 2024-03-31 12:01:18 +02:00
EARLY-RELEASE.md reuse: add copyright + license info to individual docs/*.md files 2024-03-31 12:01:18 +02:00
ECH.md tidy-up: adjust casing of project names 2024-07-12 13:56:16 +02:00
EXPERIMENTAL.md EXPERIMENTAL: add graduation requirements for each feature 2024-05-06 17:05:04 +02:00
FAQ tidy-up: adjust casing of project names 2024-07-12 13:56:16 +02:00
FEATURES.md FEATURES.md: refresh 2024-07-03 08:35:56 +02:00
GOVERNANCE.md reuse: add copyright + license info to individual docs/*.md files 2024-03-31 12:01:18 +02:00
HELP-US.md reuse: add copyright + license info to individual docs/*.md files 2024-03-31 12:01:18 +02:00
HISTORY.md tidy-up: adjust casing of project names 2024-07-12 13:56:16 +02:00
HSTS.md reuse: add copyright + license info to individual docs/*.md files 2024-03-31 12:01:18 +02:00
HTTP-COOKIES.md reuse: add copyright + license info to individual docs/*.md files 2024-03-31 12:01:18 +02:00
HTTP2.md tidy-up: adjust casing of project names 2024-07-12 13:56:16 +02:00
HTTP3.md docs: start markdown headers with capital letter where applicable 2024-07-10 16:24:25 +02:00
HYPER.md docs: start markdown headers with capital letter where applicable 2024-07-10 16:24:25 +02:00
INSTALL
INSTALL-CMAKE.md tidy-up: adjust casing of project names 2024-07-12 13:56:16 +02:00
INSTALL.md tidy-up: adjust casing of project names 2024-07-12 13:56:16 +02:00
INTERNALS.md GIT-INFO.md: remove version requirements 2024-07-08 23:06:05 +02:00
IPFS.md reuse: add copyright + license info to individual docs/*.md files 2024-03-31 12:01:18 +02:00
KNOWN_BUGS KNOWN_BUGS: three new bugs 2024-06-27 16:49:22 +02:00
MAIL-ETIQUETTE.md docs/MAIL-ETIQUETTE: convert to markdown 2024-03-31 15:32:27 +02:00
MANUAL.md MANUAL.md: wrap two example urls that overrun styling 2024-07-10 23:39:39 +02:00
MQTT.md reuse: add copyright + license info to individual docs/*.md files 2024-03-31 12:01:18 +02:00
Makefile.am docs/Makefile.am: make curl-config.1 install 2024-05-22 09:26:55 +02:00
NEW-PROTOCOL.md reuse: add copyright + license info to individual docs/*.md files 2024-03-31 12:01:18 +02:00
PARALLEL-TRANSFERS.md reuse: add copyright + license info to individual docs/*.md files 2024-03-31 12:01:18 +02:00
README.md reuse: add copyright + license info to individual docs/*.md files 2024-03-31 12:01:18 +02:00
RELEASE-PROCEDURE.md RELEASE-PROCEDURE.md: update release date 2024-06-28 14:30:04 +02:00
ROADMAP.md CI: add whitespace checker 2024-06-27 13:33:30 +02:00
RUSTLS.md reuse: add copyright + license info to individual docs/*.md files 2024-03-31 12:01:18 +02:00
SECURITY-ADVISORY.md reuse: add copyright + license info to individual docs/*.md files 2024-03-31 12:01:18 +02:00
SPONSORS.md reuse: add copyright + license info to individual docs/*.md files 2024-03-31 12:01:18 +02:00
SSL-PROBLEMS.md reuse: add copyright + license info to individual docs/*.md files 2024-03-31 12:01:18 +02:00
SSLCERTS.md tidy-up: use consistent casing for Windows directories 2024-05-30 14:40:12 +02:00
THANKS THANKS: add contributors from 8.8.0 2024-05-22 07:54:25 +02:00
THANKS-filter THANKS-filter: name fixes 2024-04-17 09:48:45 +02:00
TODO TODO: remove item about 'SSL_peak' 2024-07-04 09:56:32 +02:00
TheArtOfHttpScripting.md code: language cleanup in comments 2024-07-01 22:58:55 +02:00
URL-SYNTAX.md docs: start markdown headers with capital letter where applicable 2024-07-10 16:24:25 +02:00
VERSIONS.md reuse: add copyright + license info to individual docs/*.md files 2024-03-31 12:01:18 +02:00
VULN-DISCLOSURE-POLICY.md VULN-DISCLOSURE-POLICY: NULL dereferences and crashes 2024-06-19 12:53:35 +02:00
WEBSOCKET.md docs: use present tense 2024-02-27 09:47:21 +01:00
curl-config.md curldown: Fix email address in Copyright 2024-02-28 11:28:10 +01:00
mk-ca-bundle.md curldown: Fix email address in Copyright 2024-02-28 11:28:10 +01:00
options-in-versions tcpkeepalive: add CURLOPT_TCP_KEEPCNT and --keepalive-cnt 2024-06-12 09:31:17 +02:00

README.md

curl logo

Documentation

You find a mix of various documentation in this directory and subdirectories, using several different formats. Some of them are not ideal for reading directly in your browser.

If you would rather see the rendered version of the documentation, check out the curl website's documentation section for general curl stuff or the libcurl section for libcurl related documentation.