curl/docs
Viktor Szakats 2620aa930b
cmake: speed up curldown processing, enable by default
- cmake: enable `BUILD_DOCS` by default (this controls converting and
  installing `.3` files from `.md` sources)

- cmake: speed up generating `.3` files by using a single command per
  directory, instead of a single command per file. This reduces external
  commands by about a thousand. (There remains some CMake logic kicking
  in resulting in 500 -one per file- external `-E touch_nocreate` calls.)

- cd2nroff: add ability to process multiple input files.

- cd2nroff: add `-k` option to use the source filename to form the
  output filename. (instead of the default in-file `Title:` line.)

Follow-up to 3f08d80b22
Follow-up to ea0b575dab #12753
Follow-up to eefcc1bda4 #12730

Closes #12762
2024-01-23 23:06:39 +00:00
..
cmdline-opts docs: install curl.1 with cmake as well 2024-01-23 23:55:08 +01:00
examples examples/range.c: add 2024-01-10 09:33:08 +01:00
libcurl cmake: speed up curldown processing, enable by default 2024-01-23 23:06:39 +00:00
.gitignore docs: introduce "curldown" for libcurl man page format 2024-01-23 00:29:02 +01:00
ALTSVC.md altsvc: accept and parse IPv6 addresses in response headers 2023-08-28 17:08:42 +02:00
BINDINGS.md BINDINGS: add V binding 2023-10-23 07:57:31 +02:00
BUFQ.md tidy-up: mostly whitespace nits 2023-08-31 23:02:10 +00:00
BUFREF.md docs: spellfixes 2022-09-21 15:20:08 +02:00
BUG-BOUNTY.md docs: link to the website versions instead of markdowns 2023-08-02 00:47:41 +02:00
BUGS.md tidy-up: mostly whitespace nits 2023-08-31 23:02:10 +00:00
CHECKSRC.md tool: use our own stderr variable 2023-09-28 10:50:56 +00:00
CIPHERS.md gskit: remove 2023-08-07 20:57:48 +02:00
CLIENT-WRITERS.md CLIENT-WRITERS: design and use documentation 2023-12-12 17:37:52 +01:00
CMakeLists.txt copyright: update all copyright lines and remove year ranges 2023-01-03 09:19:21 +01:00
CODE_OF_CONDUCT.md docs: Update to secure URL versions 2017-09-04 14:08:54 +00:00
CODE_REVIEW.md docs: spellfixes 2022-09-21 15:20:08 +02:00
CODE_STYLE.md docs: rewrite to present tense 2023-08-23 23:26:10 +02:00
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-DISABLE.md lib: add ability to disable auths individually 2023-09-07 17:45:06 +02:00
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 docs: rewrite to present tense 2023-08-23 23:26:10 +02:00
EARLY-RELEASE.md docs: rewrite to present tense 2023-08-23 23:26:10 +02:00
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 docs: rewrite to present tense 2023-08-23 23:26:10 +02:00
HISTORY.md docs: introduce "curldown" for libcurl man page format 2024-01-23 00:29:02 +01:00
HSTS.md docs: spellfixes 2022-09-21 15:20:08 +02:00
HTTP-COOKIES.md docs: describe and highlight super cookies 2024-01-12 23:55:20 +01:00
HTTP2.md docs: rewrite to present tense 2023-08-23 23:26:10 +02:00
HTTP3.md http3: initial support for OpenSSL 3.2 QUIC stack 2024-01-22 16:15:45 +01:00
HYPER.md hyper: temporarily remove HTTP/2 support 2023-11-20 11:01:48 +01:00
INSTALL INSTALL: converted to markdown => INSTALL.md 2016-10-21 15:57:29 +02:00
INSTALL.cmake nss: remove support for this TLS library 2023-07-29 23:44:28 +02:00
INSTALL.md Makefile.mk: drop Windows support 2023-12-16 13:12:22 +00:00
INTERNALS.md gskit: remove 2023-08-07 20:57:48 +02:00
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 docs: rewrite to present tense 2023-08-23 23:26:10 +02:00
MANUAL.md tidy-up: use more example domains 2023-09-29 18:25:56 +00:00
MQTT.md tidy-up: use more example domains 2023-09-29 18:25:56 +00:00
Makefile.am docs: introduce "curldown" for libcurl man page format 2024-01-23 00:29:02 +01:00
NEW-PROTOCOL.md docs: minor grammar fixes 2022-09-29 10:44:12 +02:00
PARALLEL-TRANSFERS.md PARALLEL-TRANSFERS.md: not "early days" for this anymore 2023-02-27 20:08:54 +01:00
README.md docs: reduce/avoid English contractions 2021-11-07 23:16:27 +01:00
RELEASE-PROCEDURE.md RELEASE-PROCEDURE.md: updated coming release dates 2023-10-02 13:31:51 +02:00
ROADMAP.md spellcheck.words: remove 'github' as an accepted word 2022-10-27 15:53:11 +02:00
RUSTLS.md rustls: update rustls-ffi 0.10.0 2023-07-22 23:40:44 +02:00
SECURITY-ADVISORY.md misc: remove duplicate words 2023-08-29 10:39:31 +02:00
SSL-PROBLEMS.md misc: typo and grammar fixes 2022-10-27 10:01:30 +02:00
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
TODO TODO: update broken link to ratelimit-headers draft 2024-01-19 18:18:05 +01:00
TheArtOfHttpScripting.md tidy-up: use more example domains 2023-09-29 18:25:56 +00:00
URL-SYNTAX.md misc: fix spelling 2023-08-25 20:54:14 +02:00
VERSIONS.md docs: spellfixes 2022-09-21 15:20:08 +02:00
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-config.md docs: introduce "curldown" for libcurl man page format 2024-01-23 00:29:02 +01:00
mk-ca-bundle.md docs: introduce "curldown" for libcurl man page format 2024-01-23 00:29:02 +01:00
options-in-versions curl: add support for the IPFS protocols: 2023-09-23 11:02:10 +02:00

README.md

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.