luo980/curl
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
12a2ed970f
curl/docs
History
Daniel Stenberg 12a2ed970f
opt-docs: verify man page sections + order 
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
2021-09-04 11:27:46 +02:00
..
cmdline-opts get.d: provide more useful examples 2021-09-04 00:16:53 +02:00
examples mailing lists: move from cool.haxx.se to lists.haxx.se 2021-08-30 09:51:07 +02:00
libcurl opt-docs: verify man page sections + order 2021-09-04 11:27:46 +02:00
.gitignore
ALTSVC.md alt-svc: enable by default 2020-10-25 23:08:54 +01:00
BINDINGS.md docs/BINDINGS: URL update 2021-08-17 23:16:46 +00:00
BUFREF.md docs: correct spelling errors and a broken link 2021-07-18 21:14:36 +02:00
BUG-BOUNTY.md BUG-BOUNTY: removed the cooperation mention 2021-02-03 14:24:25 +01:00
BUGS.md docs: correct spelling errors and a broken link 2021-07-18 21:14:36 +02:00
CHECKSRC.md checksrc: complain on == NULL or != 0 checks in conditions 2021-04-22 09:10:17 +02:00
CIPHERS.md schannel: Support strong crypto option 2021-04-22 17:40:19 -04:00
CMakeLists.txt curl.se: new home 2020-11-04 23:59:47 +01:00
CODE_OF_CONDUCT.md docs: Update to secure URL versions 2017-09-04 14:08:54 +00:00
CODE_REVIEW.md docs: correct spelling errors and a broken link 2021-07-18 21:14:36 +02:00
CODE_STYLE.md CODE_STYLE-md: fix bold font style 2021-08-14 23:12:21 +02:00
CONTRIBUTE.md docs: correct spelling errors and a broken link 2021-07-18 21:14:36 +02:00
curl-config.1 curl.se: new home 2020-11-04 23:59:47 +01:00
CURL-DISABLE.md cmake: sync CURL_DISABLE options 2021-08-25 13:05:50 +02:00
DEPRECATE.md mailing lists: move from cool.haxx.se to lists.haxx.se 2021-08-30 09:51:07 +02:00
DYNBUF.md docs: enable syntax highlighting in several docs files 2020-12-11 18:06:41 +01:00
ECH.md docs: correct spelling errors and a broken link 2021-07-18 21:14:36 +02:00
EXPERIMENTAL.md hsts: enable by default 2021-04-19 08:22:16 +02:00
FAQ docs/tests: remove freenode references 2021-05-24 00:21:00 +02:00
FEATURES.md metalink: remove 2021-06-07 08:14:25 +02:00
GOVERNANCE.md GOVERNANCE: add 'user', 'committer' and 'contributor' 2021-05-31 15:42:39 +02:00
HELP-US.md mailing lists: move from cool.haxx.se to lists.haxx.se 2021-08-30 09:51:07 +02:00
HISTORY.md docs: camelcase it like GitHub everywhere 2021-04-28 08:16:20 +02:00
HSTS.md HSTS: not experimental anymore 2021-05-28 12:34:07 +02:00
HTTP2.md docs: Remove outdated curl tool limitation 2021-06-15 03:19:32 -04:00
HTTP3.md HTTP3: make the ngtcp2 build use the quictls fork 2021-05-07 22:43:54 +02:00
HTTP-COOKIES.md curl.se: new home 2020-11-04 23:59:47 +01:00
HYPER.md test269: disable for hyper 2021-06-03 23:11:11 +02:00
INSTALL
INSTALL.cmake TLS naming: fix more Winssl and Darwinssl leftovers 2020-08-08 00:19:21 +02:00
INSTALL.md docs/INSTALL: remove mentions of configure --with-darwin-ssl 2021-06-06 23:55:32 +02:00
INTERNALS.md docs: improve INTERNALS.md regarding getsock cb 2021-05-19 00:39:06 +02:00
KNOWN_BUGS KNOWN_BUGS: HTTP/3 doesn't support client certs 2021-08-30 13:23:24 +02:00
MAIL-ETIQUETTE curl.se: new home 2020-11-04 23:59:47 +01:00
Makefile.am bufref: buffer reference support 2021-04-22 09:05:53 +02:00
MANUAL.md metalink: remove 2021-06-07 08:14:25 +02:00
mk-ca-bundle.1 curl.se: new home 2020-11-04 23:59:47 +01:00
MQTT.md docs/MQTT: update state of username/password support 2021-07-22 00:06:15 +02:00
NEW-PROTOCOL.md docs: fix typos in NEW-PROTOCOL.md 2021-01-17 12:56:03 +01:00
options-in-versions schannel: Disable auto credentials; add an option to enable it 2021-04-22 16:53:37 -04:00
PARALLEL-TRANSFERS.md docs: fix typos 2019-11-28 12:58:47 +01:00
README.md curl.se: new home 2020-11-04 23:59:47 +01:00
RELEASE-PROCEDURE.md docs: camelcase it like GitHub everywhere 2021-04-28 08:16:20 +02:00
ROADMAP.md ROADMAP: refreshed 2021-01-14 09:49:17 +01:00
RUSTLS.md zuul: use the new rustls directory name 2021-06-30 08:19:31 +02:00
SECURITY-PROCESS.md SECURITY-PROCESS: disclose on hackerone 2020-12-03 22:29:34 +01:00
SSL-PROBLEMS.md docs: Fix typos 2021-07-03 22:11:26 +02:00
SSLCERTS.md curl.se: new home 2020-11-04 23:59:47 +01:00
THANKS mailmap: fixup Michał Antoniak 2021-08-14 23:23:09 +02:00
THANKS-filter RELEASE-NOTES: synced 2021-08-25 13:13:49 +02:00
TheArtOfHttpScripting.md TheArtOfHttpScripting: polish 2021-07-16 23:51:17 +02:00
TODO TODO: add asynch getaddrinfo support 2021-08-16 09:37:16 +02:00
URL-SYNTAX.md URL-SYNTAX.md: document the new 'localhost' treatment 2021-05-31 15:37:37 +02:00
VERSIONS.md docs: enable syntax highlighting in several docs files 2020-12-11 18:06:41 +01:00

README.md

curl logo

Documentation

You'll 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'd 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.