mirror/curl
2
0
Fork 0
mirror of https://github.com/curl/curl.git synced 2024-12-09 06:30:06 +08:00
Code Issues Packages Projects Releases Wiki Activity
6e95e3f7af
curl/docs/Makefile.am

Ignoring revisions in .git-blame-ignore-revs. Click here to bypass and see the normal blame view.

127 lines
4.7 KiB
Makefile
Raw Normal View History

headers: more copyright headers added
2011-03-23 05:48:11 +08:00
#***************************************************************************
# _ _ ____ _
# Project ___| | | | _ \| |
# / __| | | | |_) | |
# | (__| |_| | _ <| |___
# \___|\___/|_| \_\_____|
for install and more
2000-07-29 23:34:32 +08:00
#
copyright: update all copyright lines and remove year ranges - they are mostly pointless in all major jurisdictions - many big corporations and projects already don't use them - saves us from pointless churn - git keeps history for us - the year range is kept in COPYING checksrc is updated to allow non-year using copyright statements Closes #10205
2023-01-02 20:51:48 +08:00
# Copyright (C) Daniel Stenberg, <daniel@haxx.se>, et al.
for install and more
2000-07-29 23:34:32 +08:00
#
headers: more copyright headers added
2011-03-23 05:48:11 +08:00
# This software is licensed as described in the file COPYING, which
# you should have received as part of this distribution. The terms
curl.se: new home Closes #6172
2020-11-04 21:02:01 +08:00
# are also available at https://curl.se/docs/copyright.html.
headers: more copyright headers added
2011-03-23 05:48:11 +08:00
#
# You may opt to use, copy, modify, merge, publish, distribute and/or sell
# copies of the Software, and permit persons to whom the Software is
# furnished to do so, under the terms of the COPYING file.
#
# This software is distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY
# KIND, either express or implied.
#
# SPDX-License-Identifier: curl
copyright: make repository REUSE compliant Add licensing and copyright information for all files in this repository. This either happens in the file itself as a comment header or in the file `.reuse/dep5`. This commit also adds a Github workflow to check pull requests and adapts copyright.pl to the changes. Closes #8869
2022-05-17 17:16:50 +08:00
#
headers: more copyright headers added
2011-03-23 05:48:11 +08:00
###########################################################################
for install and more
2000-07-29 23:34:32 +08:00
AUTOMAKE_OPTIONS = foreign no-dependencies
docs: add mk-ca-bundle.1 to dist ... which also makes it get built. But don't build this or curl-config.1 if build docs is disabled. Closes #12875
2024-02-06 16:29:17 +08:00
if BUILD_DOCS
# if we disable man page building, ignore these
MK_CA_DOCS = mk-ca-bundle.1
CURLCONF_DOCS = curl-config.1
docs/Makefile.am: make curl-config.1 install on "make install" like it should Follow-up to 60971d665b9b1df87082 Closes #13741
2024-05-22 14:43:43 +08:00
man_MANS = curl-config.1
docs: add mk-ca-bundle.1 to dist ... which also makes it get built. But don't build this or curl-config.1 if build docs is disabled. Closes #12875
2024-02-06 16:29:17 +08:00
endif
docs: introduce "curldown" for libcurl man page format curldown is this new file format for libcurl man pages. It is markdown inspired with differences: - Each file has a set of leading headers with meta-data - Supports a small subset of markdown - Uses .md file extensions for editors/IDE/GitHub to treat them nicely - Generates man pages very similar to the previous ones - Generates man pages that still convert nicely to HTML on the website - Detects and highlights mentions of curl symbols automatically (when their man page section is specified) tools: - cd2nroff: converts from curldown to nroff man page - nroff2cd: convert an (old) nroff man page to curldown - cdall: convert many nroff pages to curldown versions - cd2cd: verifies and updates a curldown to latest curldown This setup generates .3 versions of all the curldown versions at build time. CI: Since the documentation is now technically markdown in the eyes of many things, the CI runs many more tests and checks on this documentation, including proselint, link checkers and tests that make sure we capitalize the first letter after a period... Closes #12730
2024-01-17 18:32:44 +08:00
CURLPAGES = curl-config.md mk-ca-bundle.md
moved lots to the new subdir 'libcurl'
2002-03-04 18:27:37 +08:00
docs: introduce "curldown" for libcurl man page format curldown is this new file format for libcurl man pages. It is markdown inspired with differences: - Each file has a set of leading headers with meta-data - Supports a small subset of markdown - Uses .md file extensions for editors/IDE/GitHub to treat them nicely - Generates man pages very similar to the previous ones - Generates man pages that still convert nicely to HTML on the website - Detects and highlights mentions of curl symbols automatically (when their man page section is specified) tools: - cd2nroff: converts from curldown to nroff man page - nroff2cd: convert an (old) nroff man page to curldown - cdall: convert many nroff pages to curldown versions - cd2cd: verifies and updates a curldown to latest curldown This setup generates .3 versions of all the curldown versions at build time. CI: Since the documentation is now technically markdown in the eyes of many things, the CI runs many more tests and checks on this documentation, including proselint, link checkers and tests that make sure we capitalize the first letter after a period... Closes #12730
2024-01-17 18:32:44 +08:00
SUBDIRS = . cmdline-opts libcurl
DIST_SUBDIRS = $(SUBDIRS) examples
added a 'html' target that builds HTML versions from the man page sources. It requires 'gnroff' and 'man2html' for now. 'make html' will be invoked by the 'maketgz' script and the HTML files are included in release archives.
2001-08-21 17:16:09 +08:00
docs: dist curl*.1 and install without perl Drop docs/mk-ca-bundle.1 from the tarball. It can be generated at will. Closes #12959 Fixes #12921 Reported-by: Michael Forney
2024-02-19 16:32:07 +08:00
if BUILD_DOCS
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-05 00:22:17 +08:00
CLEANFILES = mk-ca-bundle.1 curl-config.1
docs: dist curl*.1 and install without perl Drop docs/mk-ca-bundle.1 from the tarball. It can be generated at will. Closes #12959 Fixes #12921 Reported-by: Michael Forney
2024-02-19 16:32:07 +08:00
endif
clean the html and pdf files
2004-03-02 16:28:23 +08:00
docs/RELEASE-PROCEDURE.md: renamed to use .md extension Closes #2663
2018-06-15 19:37:48 +08:00
EXTRA_DIST = \
docs: introduce "curldown" for libcurl man page format curldown is this new file format for libcurl man pages. It is markdown inspired with differences: - Each file has a set of leading headers with meta-data - Supports a small subset of markdown - Uses .md file extensions for editors/IDE/GitHub to treat them nicely - Generates man pages very similar to the previous ones - Generates man pages that still convert nicely to HTML on the website - Detects and highlights mentions of curl symbols automatically (when their man page section is specified) tools: - cd2nroff: converts from curldown to nroff man page - nroff2cd: convert an (old) nroff man page to curldown - cdall: convert many nroff pages to curldown versions - cd2cd: verifies and updates a curldown to latest curldown This setup generates .3 versions of all the curldown versions at build time. CI: Since the documentation is now technically markdown in the eyes of many things, the CI runs many more tests and checks on this documentation, including proselint, link checkers and tests that make sure we capitalize the first letter after a period... Closes #12730
2024-01-17 18:32:44 +08:00
$(CURLPAGES) \
docs/ALTSVC.md: docs describing the approach Closes #3498
2019-03-03 18:17:52 +08:00
ALTSVC.md \
docs/RELEASE-PROCEDURE.md: renamed to use .md extension Closes #2663
2018-06-15 19:37:48 +08:00
BINDINGS.md \
dist: add files missing from release tarball Closes #13346
2024-04-11 19:16:18 +08:00
BUFQ.md \
bufref: buffer reference support A struct bufref holds a buffer pointer, a data size and a destructor. When freed or its contents are changed, the previous buffer is implicitly released by the associated destructor. The data size, although not used internally, allows binary data support. A unit test checks its handling methods: test 1661 Closes #6654
2021-03-23 09:02:18 +08:00
BUFREF.md \
docs/BUG-BOUNTY: bug bounty time [skip ci] Introducing the curl bug bounty program on hackerone. We now recommend filing security issues directly in the hackerone ticket system which only is readable to curl security team members. Assisted-by: Daniel Gustafsson Closes #3488
2019-04-20 18:19:47 +08:00
BUG-BOUNTY.md \
BUGS: convert document to markdown Closes #5979
2020-09-18 19:44:57 +08:00
BUGS.md \
docs/RELEASE-PROCEDURE.md: renamed to use .md extension Closes #2663
2018-06-15 19:37:48 +08:00
CHECKSRC.md \
CIPHERS.md \
CMakeLists.txt \
CODE_OF_CONDUCT.md \
CODE_REVIEW.md: how to do code reviews in curl Assisted-by: Daniel Gustafsson Assisted-by: Rich Salz Assisted-by: Hugo van Kemenade Assisted-by: James Fuller Assisted-by: Marc Hörsken Assisted-by: Jay Satiro Closes #5555
2020-06-11 18:04:05 +08:00
CODE_REVIEW.md \
docs/RELEASE-PROCEDURE.md: renamed to use .md extension Closes #2663
2018-06-15 19:37:48 +08:00
CODE_STYLE.md \
lib: Curl_read/Curl_write clarifications - replace `Curl_read()`, `Curl_write()` and `Curl_nwrite()` to clarify when and at what level they operate - send/recv of transfer related data is now done via `Curl_xfer_send()/Curl_xfer_recv()` which no longer has socket/socketindex as parameter. It decides on the transfer setup of `conn->sockfd` and `conn->writesockfd` on which connection filter chain to operate. - send/recv on a specific connection filter chain is done via `Curl_conn_send()/Curl_conn_recv()` which get the socket index as parameter. - rename `Curl_setup_transfer()` to `Curl_xfer_setup()` for naming consistency - clarify that the special CURLE_AGAIN hangling to return `CURLE_OK` with length 0 only applies to `Curl_xfer_send()` and CURLE_AGAIN is returned by all other send() variants. - fix a bug in websocket `curl_ws_recv()` that mixed up data when it arrived in more than a single chunk (to be made into a sperate PR, also) Added as documented [in CLIENT-READER.md](https://github.com/curl/curl/blob/5b1f31dfbab8aef467c419c68aa06dc738cb75d4/docs/CLIENT-READERS.md). - old `Curl_buffer_send()` completely replaced by new `Curl_req_send()` - old `Curl_fillreadbuffer()` replaced with `Curl_client_read()` - HTTP chunked uploads are now formatted in a client reader added when needed. - FTP line-end conversions are done in a client reader added when needed. - when sending requests headers, remaining buffer space is filled with body data for sending in "one go". This is independent of the request body size. Resolves #12938 as now small and large requests have the same code path. Changes done to test cases: - test513: now fails before sending request headers as this initial "client read" triggers the setup fault. Behaves now the same as in hyper build - test547, test555, test1620: fix the length check in the lib code to only fail for reads *smaller* than expected. This was a bug in the test code that never triggered in the old implementation. Closes #12969
2024-02-15 23:22:53 +08:00
CLIENT-READERS.md \
CLIENT-WRITERS: design and use documentation Closes #12507
2023-12-12 19:36:07 +08:00
CLIENT-WRITERS.md \
lib: connection filters (cfilter) addition to curl: - general construct/destroy in connectdata - default implementations of callback functions - connect: cfilters for connect and accept - socks: cfilter for socks proxying - http_proxy: cfilter for http proxy tunneling - vtls: cfilters for primary and proxy ssl - change in general handling of data/conn - Curl_cfilter_setup() sets up filter chain based on data settings, if none are installed by the protocol handler setup - Curl_cfilter_connect() boot straps filters into `connected` status, used by handlers and multi to reach further stages - Curl_cfilter_is_connected() to check if a conn is connected, e.g. all filters have done their work - Curl_cfilter_get_select_socks() gets the sockets and READ/WRITE indicators for multi select to work - Curl_cfilter_data_pending() asks filters if the have incoming data pending for recv - Curl_cfilter_recv()/Curl_cfilter_send are the general callbacks installed in conn->recv/conn->send for io handling - Curl_cfilter_attach_data()/Curl_cfilter_detach_data() inform filters and addition/removal of a `data` from their connection - adding vtl functions to prevent use of Curl_ssl globals directly in other parts of the code. Reviewed-by: Daniel Stenberg Closes #9855
2022-11-11 18:45:34 +08:00
CONNECTION-FILTERS.md \
docs/RELEASE-PROCEDURE.md: renamed to use .md extension Closes #2663
2018-06-15 19:37:48 +08:00
CONTRIBUTE.md \
CURL-DISABLE: initial docs for the CURL_DISABLE_* defines The disable-scan script used in test 1165 is extended to also verify that the docs cover all used defines and all defines offered by configure. Reported-by: SLDiggie on github Fixes #4545 Closes #4587
2019-11-12 00:16:04 +08:00
CURL-DISABLE.md \
docs: introduce "curldown" for libcurl man page format curldown is this new file format for libcurl man pages. It is markdown inspired with differences: - Each file has a set of leading headers with meta-data - Supports a small subset of markdown - Uses .md file extensions for editors/IDE/GitHub to treat them nicely - Generates man pages very similar to the previous ones - Generates man pages that still convert nicely to HTML on the website - Detects and highlights mentions of curl symbols automatically (when their man page section is specified) tools: - cd2nroff: converts from curldown to nroff man page - nroff2cd: convert an (old) nroff man page to curldown - cdall: convert many nroff pages to curldown versions - cd2cd: verifies and updates a curldown to latest curldown This setup generates .3 versions of all the curldown versions at build time. CI: Since the documentation is now technically markdown in the eyes of many things, the CI runs many more tests and checks on this documentation, including proselint, link checkers and tests that make sure we capitalize the first letter after a period... Closes #12730
2024-01-17 18:32:44 +08:00
CURLDOWN.md \
DEPRECATE: new doc describing planned item removals Closes #2704
2018-07-01 19:22:53 +08:00
DEPRECATE.md \
DISTROS: add document with distro pointers Lots of organizations distribute curl packages to end users. This is a collection of pointers to where to learn more about curl on and with each distro. Assisted-by: Alan Coopersmith Assisted-by: Andrew Kaster Assisted-by: Andy Fiddaman Assisted-by: Arjan van de Ven Assisted-by: Brian Clemens Assisted-by: chrysos349 on github Assisted-by: Dan Fandrich Assisted-by: Dan McDonald Assisted-by: Gaelan Steele Assisted-by: graywolf on github Assisted-by: Jan Macku Assisted-by: John Marshall Assisted-by: Jonathan Perkin Assisted-by: Kevin Daudt Assisted-by: Marcus Müller Assisted-by: Michał Górny Assisted-by: Outvi V Assisted-by: Ross Burton Assisted-by: Sean Molenaar Assisted-by: Till Wegmüller Assisted-by: Viktor Szakats Assisted-by: Winni Neessen Closes #13178
2024-03-23 21:43:35 +08:00
DISTROS.md \
dynbuf: introduce internal generic dynamic buffer functions A common set of functions instead of many separate implementations for creating buffers that can grow when appending data to them. Existing functionality has been ported over. In my early basic testing, the total number of allocations seem at roughly the same amount as before, possibly a few less. See docs/DYNBUF.md for a description of the API. Closes #5300
2020-05-02 23:04:08 +08:00
DYNBUF.md \
docs/EARLY-RELEASE.md: how to determine an early release URL: https://curl.se/mail/lib-2022-10/0079.html Closes #9820
2022-11-06 06:50:32 +08:00
EARLY-RELEASE.md \
dist: add ECH files to tarball Also sort `EXTRA_DIST` list in `tests/Makefile.am` and make it diffable. Follow-up to a362962b7289ec02b412890c9515657cf0ed50ac #11922 Closes #13381
2024-04-16 15:51:57 +08:00
ECH.md \
docs/EXPERIMENTAL: explain what it means and what's experimental now
2019-08-07 20:52:02 +08:00
EXPERIMENTAL.md \
docs/RELEASE-PROCEDURE.md: renamed to use .md extension Closes #2663
2018-06-15 19:37:48 +08:00
FAQ \
docs/FEATURE: convert to markdown ... and clean it up a bit. Closes #6067
2020-10-13 23:34:40 +08:00
FEATURES.md \
docs/RELEASE-PROCEDURE.md: renamed to use .md extension Closes #2663
2018-06-15 19:37:48 +08:00
GOVERNANCE.md \
HELP-US.md \
HISTORY.md \
hsts: add support for Strict-Transport-Security - enable in the build (configure) - header parsing - host name lookup - unit tests for the above - CI build - CURL_VERSION_HSTS bit - curl_version_info support - curl -V output - curl-config --features - CURLOPT_HSTS_CTRL - man page for CURLOPT_HSTS_CTRL - curl --hsts (sets CURLOPT_HSTS_CTRL and works with --libcurl) - man page for --hsts - save cache to disk - load cache from disk - CURLOPT_HSTS - man page for CURLOPT_HSTS - added docs/HSTS.md - fixed --version docs - adjusted curl_easy_duphandle Closes #5896
2020-11-03 06:17:01 +08:00
HSTS.md \
docs/RELEASE-PROCEDURE.md: renamed to use .md extension Closes #2663
2018-06-15 19:37:48 +08:00
HTTP-COOKIES.md \
HTTP2.md \
HTTP3: initial (experimental) support USe configure --with-ngtcp2 or --with-quiche Using either option will enable a HTTP3 build. Co-authored-by: Alessandro Ghedini <alessandro@ghedini.me> Closes #3500
2019-07-22 05:48:58 +08:00
HTTP3.md \
docs: add HYPER.md
2020-12-14 21:10:32 +08:00
HYPER.md \
docs/RELEASE-PROCEDURE.md: renamed to use .md extension Closes #2663
2018-06-15 19:37:48 +08:00
INSTALL \
cmake: freshen up docs/INSTALL.cmake - Turn docs/INSTALL.cmake into a proper markdown file, docs/INSTALL-CMAKE.md - Move things around to divide the description into configuration, building and installing sections - Mention the more modern cmake options to configure, build and install, but also retain the older variants as fallbacks Closes #12772
2024-01-24 20:07:00 +08:00
INSTALL-CMAKE.md \
docs/RELEASE-PROCEDURE.md: renamed to use .md extension Closes #2663
2018-06-15 19:37:48 +08:00
INSTALL.md \
INTERNALS.md \
dist: add files missing from release tarball Closes #13346
2024-04-11 19:16:18 +08:00
IPFS.md \
docs/RELEASE-PROCEDURE.md: renamed to use .md extension Closes #2663
2018-06-15 19:37:48 +08:00
KNOWN_BUGS \
docs/MAIL-ETIQUETTE: convert to markdown To render nicer. To get spellchecked. Closes #13247
2024-03-31 18:20:04 +08:00
MAIL-ETIQUETTE.md \
dist: add files missing from release tarball Closes #13346
2024-04-11 19:16:18 +08:00
MANUAL.md \
mqtt: add new experimental protocol Closes #5173
2020-04-14 17:19:12 +08:00
MQTT.md \
NEW-PROTOCOL: document what needs to be done to add one Closes #6263
2020-11-29 05:03:54 +08:00
NEW-PROTOCOL.md \
docs/options-in-versions: which version added each cmdline option Added test 971 to verify that the list is in sync with the files in cmdline-opts. The check also verifies that .d-files that uses Added: specify the same version number as the options-in-versions file does. Closes #5381
2020-05-12 19:29:53 +08:00
options-in-versions \
docs/PARALLEL-TRANSFERS: added
2019-07-21 01:14:00 +08:00
PARALLEL-TRANSFERS.md \
docs/RELEASE-PROCEDURE.md: renamed to use .md extension Closes #2663
2018-06-15 19:37:48 +08:00
README.md \
RELEASE-PROCEDURE.md \
docs: document version of crustls dependency This also pins a specific release in the Travis test so future API-breaking changins in crustls won't break curl builds. Add RUSTLS documentation to release tarball. Enable running tests for rustls, minus FTP tests (require connect_blocking, which rustls doesn't implement) and 313 (requires CRL handling). Closes #6763
2021-03-17 08:09:47 +08:00
RUSTLS.md \
docs/RELEASE-PROCEDURE.md: renamed to use .md extension Closes #2663
2018-06-15 19:37:48 +08:00
ROADMAP.md \
docs/SECURITY-ADVISORY.md: how to write a curl security advisory Closes #11080
2023-05-08 00:33:57 +08:00
SECURITY-ADVISORY.md \
SPONSORS: describe the basics Closes #13119
2024-03-13 20:26:07 +08:00
SPONSORS.md \
docs/RELEASE-PROCEDURE.md: renamed to use .md extension Closes #2663
2018-06-15 19:37:48 +08:00
SSL-PROBLEMS.md \
SSLCERTS.md \
THANKS \
TODO \
docs/TheArtOfHttpScripting: convert to markdown Makes it easier to browse on github etc. Offers (better) links. It should be noted that this document is already mostly outdated and "Everything curl" at https://ec.haxx.se/ is a better resource and tutorial. Closes #5981
2020-09-18 21:09:12 +08:00
TheArtOfHttpScripting.md \
docs/URL-SYNTAX: the URL syntax curl accepts and works with Closes #6285
2020-12-07 20:58:55 +08:00
URL-SYNTAX.md \
docs: use "WebSocket" in singular This is how the RFC calls the protocol. Also rename the file in docs/ to WEBSOCKET.md in uppercase to match how we have done it for many other protocol docs in similar fashion. Add the WebSocket docs to the tarball. Closes #9496
2022-09-13 15:17:53 +08:00
VERSIONS.md \
SECURITY-PROCESS.md. call it vulnerability disclosure policy SECURITY-PROCESS.md -> VULN-DISCLOSURE-POLICY.md This a name commonly used for a document like this. This name helps users find it. Closes #11852
2023-09-14 22:41:19 +08:00
VULN-DISCLOSURE-POLICY.md \
docs: use "WebSocket" in singular This is how the RFC calls the protocol. Also rename the file in docs/ to WEBSOCKET.md in uppercase to match how we have done it for many other protocol docs in similar fashion. Add the WebSocket docs to the tarball. Closes #9496
2022-09-13 15:17:53 +08:00
WEBSOCKET.md
adjusted to work with automake 'make dist'
2001-01-08 21:39:21 +08:00
docs: introduce "curldown" for libcurl man page format curldown is this new file format for libcurl man pages. It is markdown inspired with differences: - Each file has a set of leading headers with meta-data - Supports a small subset of markdown - Uses .md file extensions for editors/IDE/GitHub to treat them nicely - Generates man pages very similar to the previous ones - Generates man pages that still convert nicely to HTML on the website - Detects and highlights mentions of curl symbols automatically (when their man page section is specified) tools: - cd2nroff: converts from curldown to nroff man page - nroff2cd: convert an (old) nroff man page to curldown - cdall: convert many nroff pages to curldown versions - cd2cd: verifies and updates a curldown to latest curldown This setup generates .3 versions of all the curldown versions at build time. CI: Since the documentation is now technically markdown in the eyes of many things, the CI runs many more tests and checks on this documentation, including proselint, link checkers and tests that make sure we capitalize the first letter after a period... Closes #12730
2024-01-17 18:32:44 +08:00
CD2NROFF = $(top_srcdir)/scripts/cd2nroff $< >$@
CD2 = $(CD2_$(V))
CD2_0 = @echo " RENDER " $@;
CD2_1 =
CD2_ = $(CD2_0)
added a 'html' target that builds HTML versions from the man page sources. It requires 'gnroff' and 'man2html' for now. 'make html' will be invoked by the 'maketgz' script and the HTML files are included in release archives.
2001-08-21 17:16:09 +08:00
docs: introduce "curldown" for libcurl man page format curldown is this new file format for libcurl man pages. It is markdown inspired with differences: - Each file has a set of leading headers with meta-data - Supports a small subset of markdown - Uses .md file extensions for editors/IDE/GitHub to treat them nicely - Generates man pages very similar to the previous ones - Generates man pages that still convert nicely to HTML on the website - Detects and highlights mentions of curl symbols automatically (when their man page section is specified) tools: - cd2nroff: converts from curldown to nroff man page - nroff2cd: convert an (old) nroff man page to curldown - cdall: convert many nroff pages to curldown versions - cd2cd: verifies and updates a curldown to latest curldown This setup generates .3 versions of all the curldown versions at build time. CI: Since the documentation is now technically markdown in the eyes of many things, the CI runs many more tests and checks on this documentation, including proselint, link checkers and tests that make sure we capitalize the first letter after a period... Closes #12730
2024-01-17 18:32:44 +08:00
SUFFIXES = .1 .md
added a 'html' target that builds HTML versions from the man page sources. It requires 'gnroff' and 'man2html' for now. 'make html' will be invoked by the 'maketgz' script and the HTML files are included in release archives.
2001-08-21 17:16:09 +08:00
dist: remove the curl-config.1 from the tarball The markdown file is already there and the .1 file gets generated in the build. Ref: #13250 Closes #13268
2024-04-03 16:00:03 +08:00
all: $(MK_CA_DOCS) $(CURLCONF_DOCS)
docs: dist curl*.1 and install without perl Drop docs/mk-ca-bundle.1 from the tarball. It can be generated at will. Closes #12959 Fixes #12921 Reported-by: Michael Forney
2024-02-19 16:32:07 +08:00
docs: introduce "curldown" for libcurl man page format curldown is this new file format for libcurl man pages. It is markdown inspired with differences: - Each file has a set of leading headers with meta-data - Supports a small subset of markdown - Uses .md file extensions for editors/IDE/GitHub to treat them nicely - Generates man pages very similar to the previous ones - Generates man pages that still convert nicely to HTML on the website - Detects and highlights mentions of curl symbols automatically (when their man page section is specified) tools: - cd2nroff: converts from curldown to nroff man page - nroff2cd: convert an (old) nroff man page to curldown - cdall: convert many nroff pages to curldown versions - cd2cd: verifies and updates a curldown to latest curldown This setup generates .3 versions of all the curldown versions at build time. CI: Since the documentation is now technically markdown in the eyes of many things, the CI runs many more tests and checks on this documentation, including proselint, link checkers and tests that make sure we capitalize the first letter after a period... Closes #12730
2024-01-17 18:32:44 +08:00
.md.1:
$(CD2)$(CD2NROFF)
generate and include PDF versions of the docs in the release archive
2002-10-14 15:39:49 +08:00
docs: introduce "curldown" for libcurl man page format curldown is this new file format for libcurl man pages. It is markdown inspired with differences: - Each file has a set of leading headers with meta-data - Supports a small subset of markdown - Uses .md file extensions for editors/IDE/GitHub to treat them nicely - Generates man pages very similar to the previous ones - Generates man pages that still convert nicely to HTML on the website - Detects and highlights mentions of curl symbols automatically (when their man page section is specified) tools: - cd2nroff: converts from curldown to nroff man page - nroff2cd: convert an (old) nroff man page to curldown - cdall: convert many nroff pages to curldown versions - cd2cd: verifies and updates a curldown to latest curldown This setup generates .3 versions of all the curldown versions at build time. CI: Since the documentation is now technically markdown in the eyes of many things, the CI runs many more tests and checks on this documentation, including proselint, link checkers and tests that make sure we capitalize the first letter after a period... Closes #12730
2024-01-17 18:32:44 +08:00
curl-config.1: curl-config.md
generate and include PDF versions of the docs in the release archive
2002-10-14 15:39:49 +08:00
docs: dist curl*.1 and install without perl Drop docs/mk-ca-bundle.1 from the tarball. It can be generated at will. Closes #12959 Fixes #12921 Reported-by: Michael Forney
2024-02-19 16:32:07 +08:00
mk-ca-bundle.1: mk-ca-bundle.md
make: fix "make distclean" Fixes #2097 Closes #2108
2017-11-24 07:49:48 +08:00
distclean:
rm -f $(CLEANFILES)
Reference in New Issue Copy Permalink