curl/docs
Daniel Stenberg 2494b8dd51
docs/cmdline: change to .md for cmdline docs
- switch all invidual files documenting command line options into .md,
   as the documentation is now markdown-looking.

 - made the parser treat 4-space indents as quotes

 - switch to building the curl.1 manpage using the "mainpage.idx" file,
   which lists the files to include to generate it, instead of using the
   previous page-footer/headers. Also, those files are now also .md
   ones, using the same format. I gave them underscore prefixes to make
   them sort separately:
   _NAME.md, _SYNOPSIS.md, _DESCRIPTION.md, _URL.md, _GLOBBING.md,
   _VARIABLES.md, _OUTPUT.md, _PROTOCOLS.md, _PROGRESS.md, _VERSION.md,
   _OPTIONS.md, _FILES.md, _ENVIRONMENT.md, _PROXYPREFIX.md,
   _EXITCODES.md, _BUGS.md, _AUTHORS.md, _WWW.md, _SEEALSO.md

 - updated test cases accordingly

Closes #12751
2024-01-23 14:30:15 +01:00
..
cmdline-opts docs/cmdline: change to .md for cmdline docs 2024-01-23 14:30:15 +01:00
examples examples/range.c: add 2024-01-10 09:33:08 +01:00
libcurl cmake: add option to disable building docs 2024-01-23 00:29:02 +01:00
.gitignore docs: introduce "curldown" for libcurl man page format 2024-01-23 00:29:02 +01:00
ALTSVC.md
BINDINGS.md BINDINGS: add V binding 2023-10-23 07:57:31 +02:00
BUFQ.md
BUFREF.md
BUG-BOUNTY.md
BUGS.md
CHECKSRC.md
CIPHERS.md
CLIENT-WRITERS.md CLIENT-WRITERS: design and use documentation 2023-12-12 17:37:52 +01:00
CMakeLists.txt
CODE_OF_CONDUCT.md
CODE_REVIEW.md
CODE_STYLE.md
CONNECTION-FILTERS.md CONNECTION-FILTERS: update documentation 2023-12-11 23:30:26 +01:00
CONTRIBUTE.md docs: introduce "curldown" for libcurl man page format 2024-01-23 00:29:02 +01:00
curl-config.md docs: introduce "curldown" for libcurl man page format 2024-01-23 00:29:02 +01:00
CURL-DISABLE.md
CURLDOWN.md docs: introduce "curldown" for libcurl man page format 2024-01-23 00:29:02 +01:00
DEPRECATE.md DEPRECATE.md: mention that NTLM_WB no longer works 2023-12-19 10:21:45 +01:00
DYNBUF.md
EARLY-RELEASE.md
EXPERIMENTAL.md HTTP3: ngtcp2 builds are no longer experimental 2023-10-31 14:31:46 +01:00
FAQ tidy-up: use more example domains 2023-09-29 18:25:56 +00:00
FEATURES.md FEATURES: update the URL phrasing 2023-11-22 13:26:51 +01:00
GOVERNANCE.md docs: introduce "curldown" for libcurl man page format 2024-01-23 00:29:02 +01:00
HELP-US.md
HISTORY.md docs: introduce "curldown" for libcurl man page format 2024-01-23 00:29:02 +01:00
HSTS.md
HTTP2.md
HTTP3.md http3: initial support for OpenSSL 3.2 QUIC stack 2024-01-22 16:15:45 +01:00
HTTP-COOKIES.md docs: describe and highlight super cookies 2024-01-12 23:55:20 +01:00
HYPER.md hyper: temporarily remove HTTP/2 support 2023-11-20 11:01:48 +01:00
INSTALL
INSTALL.cmake
INSTALL.md Makefile.mk: drop Windows support 2023-12-16 13:12:22 +00:00
INTERNALS.md
IPFS.md IPFS: bugfixes 2023-11-11 23:28:13 +01:00
KNOWN_BUGS cmake: when USE_MANUAL=YES, build the curl.1 man page 2024-01-19 18:14:56 +01:00
MAIL-ETIQUETTE
Makefile.am docs: introduce "curldown" for libcurl man page format 2024-01-23 00:29:02 +01:00
MANUAL.md tidy-up: use more example domains 2023-09-29 18:25:56 +00:00
mk-ca-bundle.md docs: introduce "curldown" for libcurl man page format 2024-01-23 00:29:02 +01:00
MQTT.md tidy-up: use more example domains 2023-09-29 18:25:56 +00:00
NEW-PROTOCOL.md
options-in-versions
PARALLEL-TRANSFERS.md
README.md
RELEASE-PROCEDURE.md RELEASE-PROCEDURE.md: updated coming release dates 2023-10-02 13:31:51 +02:00
ROADMAP.md
RUSTLS.md
SECURITY-ADVISORY.md
SSL-PROBLEMS.md
SSLCERTS.md docs: introduce "curldown" for libcurl man page format 2024-01-23 00:29:02 +01:00
THANKS cmake: use curldown to build man pages 2024-01-23 00:29:02 +01:00
THANKS-filter THANKS: add contributors from 8.4.0 2023-10-11 07:34:19 +02:00
TheArtOfHttpScripting.md tidy-up: use more example domains 2023-09-29 18:25:56 +00:00
TODO TODO: update broken link to ratelimit-headers draft 2024-01-19 18:18:05 +01:00
URL-SYNTAX.md
VERSIONS.md
VULN-DISCLOSURE-POLICY.md VULN-DISCLOSURE-POLIC: remove broken link to hackerone 2023-11-11 23:16:52 +01:00
WEBSOCKET.md WEBSOCKET.md: remove dead link 2024-01-09 16:00:29 +01:00

curl logo

Documentation

you will 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.