curl/docs
Daniel Stenberg f03c85635f
docs: ascii version of manpage without nroff
Create ASCII version of manpage without nroff

 - build src/tool_hugegelp.c from the ascii manpage
 - move the the manpage and the ascii version build to docs/cmdline-opts
 - remove all use of nroff from the build process
 - should make the build entirely reproducible (by avoiding nroff)

 - partly reverts 2620aa9 to build libcurl option man pages one by one
   in cmake because the appveyor builds got all crazy until I did

The ASCII version of the manpage

 - is built with gen.pl, just like the manpage is
 - has a right-justified column making the appearance similar to the previous
   version
 - uses a 4-space indent per level (instead of the old version's 7)
 - does not do hyphenation of words (which nroff does)

History

  We first made the curl build use nroff for building the hugehelp file in
  December 1998, for curl 5.2.

Closes #13047
2024-03-06 15:55:59 +01:00
..
cmdline-opts docs: ascii version of manpage without nroff 2024-03-06 15:55:59 +01:00
examples misc: Fix typos in docs and lib 2024-03-01 09:59:48 +01:00
libcurl docs: ascii version of manpage without nroff 2024-03-06 15:55:59 +01:00
.gitignore docs: introduce "curldown" for libcurl man page format 2024-01-23 00:29:02 +01:00
ALTSVC.md ALTSVC.md: correct a typo 2024-02-05 22:26:14 +01:00
BINDINGS.md BINDINGS: add mcurl, the python binding 2024-02-19 17:01:00 +01:00
BUFQ.md docs: use present tense 2024-02-27 09:47:21 +01:00
BUFREF.md docs: use present tense 2024-02-27 09:47:21 +01:00
BUG-BOUNTY.md docs: use present tense 2024-02-27 09:47:21 +01:00
BUGS.md docs: use present tense 2024-02-27 09:47:21 +01:00
CHECKSRC.md docs: use present tense 2024-02-27 09:47:21 +01:00
CIPHERS.md docs: use present tense 2024-02-27 09:47:21 +01:00
CLIENT-READERS.md lib: enhance client reader resume + rewind 2024-03-05 13:26:05 +01:00
CLIENT-WRITERS.md docs: use present tense 2024-02-27 09:47:21 +01:00
CMakeLists.txt cmake: rework options to enable curl and libcurl docs 2024-01-24 23:22:27 +00:00
CODE_OF_CONDUCT.md
CODE_REVIEW.md docs: spellfixes 2022-09-21 15:20:08 +02:00
CODE_STYLE.md docs: use present tense 2024-02-27 09:47:21 +01:00
CONNECTION-FILTERS.md misc: Fix typos in docs and lib 2024-03-01 09:59:48 +01:00
CONTRIBUTE.md CONTRIBUTE: update the section on documentation format 2024-03-05 10:53:21 +01:00
curl-config.md curldown: Fix email address in Copyright 2024-02-28 11:28:10 +01:00
CURL-DISABLE.md lib: add ability to disable auths individually 2023-09-07 17:45:06 +02:00
CURLDOWN.md curldown: Fix email address in Copyright 2024-02-28 11:28:10 +01:00
DEPRECATE.md docs: use present tense 2024-02-27 09:47:21 +01:00
DYNBUF.md docs: use present tense 2024-02-27 09:47:21 +01:00
EARLY-RELEASE.md docs: use present tense 2024-02-27 09:47:21 +01:00
EXPERIMENTAL.md docs: use present tense 2024-02-27 09:47:21 +01:00
FAQ tidy-up: use more example domains 2023-09-29 18:25:56 +00:00
FEATURES.md badwords: use hostname, not host name 2024-02-07 08:25:52 +01:00
GOVERNANCE.md docs: use present tense 2024-02-27 09:47:21 +01:00
HELP-US.md docs: use present tense 2024-02-27 09:47:21 +01:00
HISTORY.md docs: introduce "curldown" for libcurl man page format 2024-01-23 00:29:02 +01:00
HSTS.md docs: use present tense 2024-02-27 09:47:21 +01:00
HTTP2.md docs: use present tense 2024-02-27 09:47:21 +01:00
HTTP3.md cmake: add USE_OPENSSL_QUIC support 2024-03-05 17:07:57 +01:00
HTTP-COOKIES.md docs: use present tense 2024-02-27 09:47:21 +01:00
HYPER.md docs: use present tense 2024-02-27 09:47:21 +01:00
INSTALL
INSTALL-CMAKE.md docs: use present tense 2024-02-27 09:47:21 +01:00
INSTALL.md docs: Update minimal binary size in INSTALL.md 2024-03-01 01:16:24 -08:00
INTERNALS.md docs: ascii version of manpage without nroff 2024-03-06 15:55:59 +01:00
IPFS.md docs: use present tense 2024-02-27 09:47:21 +01:00
KNOWN_BUGS KNOWN_BUGS: fix typo 2024-03-05 12:53:50 +00:00
MAIL-ETIQUETTE docs: more language cleanups 2024-02-27 16:19:43 +01:00
Makefile.am docs: ascii version of manpage without nroff 2024-03-06 15:55:59 +01:00
MANUAL.md docs: use present tense 2024-02-27 09:47:21 +01:00
mk-ca-bundle.md curldown: Fix email address in Copyright 2024-02-28 11:28:10 +01:00
MQTT.md docs: use present tense 2024-02-27 09:47:21 +01:00
NEW-PROTOCOL.md docs: use present tense 2024-02-27 09:47:21 +01:00
options-in-versions curl: add support for the IPFS protocols: 2023-09-23 11:02:10 +02:00
PARALLEL-TRANSFERS.md docs: use present tense 2024-02-27 09:47:21 +01:00
README.md docs: use present tense 2024-02-27 09:47:21 +01:00
RELEASE-PROCEDURE.md docs: use present tense 2024-02-27 09:47:21 +01:00
ROADMAP.md spellcheck.words: remove 'github' as an accepted word 2022-10-27 15:53:11 +02:00
RUSTLS.md rustls: make curl compile with 0.12.0 2024-02-26 08:59:43 +01:00
SECURITY-ADVISORY.md docs: use present tense 2024-02-27 09:47:21 +01:00
SSL-PROBLEMS.md docs: use present tense 2024-02-27 09:47:21 +01:00
SSLCERTS.md docs: more language cleanups 2024-02-27 16:19:43 +01:00
THANKS THANKS: add bug reporter from #740 2024-02-23 10:13:03 +01:00
THANKS-filter THANKS: add contributors from 8.4.0 2023-10-11 07:34:19 +02:00
TheArtOfHttpScripting.md docs: use present tense 2024-02-27 09:47:21 +01:00
TODO docs: ascii version of manpage without nroff 2024-03-06 15:55:59 +01:00
URL-SYNTAX.md docs: use present tense 2024-02-27 09:47:21 +01:00
VERSIONS.md docs: use present tense 2024-02-27 09:47:21 +01:00
VULN-DISCLOSURE-POLICY.md docs: use present tense 2024-02-27 09:47:21 +01:00
WEBSOCKET.md docs: use present tense 2024-02-27 09:47:21 +01:00

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.