12 commits

Author	SHA1	Message	Date
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
Daniel Stenberg	4600bd3993	cmdline-docs: use present tense, not future ... + some smaller cleanups Closes #11821	2023-09-08 16:57:33 +02:00
Daniel Stenberg	2bc1d775f5	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-03 09:19:21 +01:00
Daniel Stenberg	ef305de95c	cmdline/docs: add a required 'multi' keyword for each option ... The keyword specifies how option works when specified multiple times: - single: the last provided value replaces the earlier ones - append: it supports being provided multiple times - boolean: on/off values - mutex: flag-like option that disable anoter flag The 'gen.pl' script then outputs the proper and unified language for each option's multi-use behavior in the generated man page. The multi: header is requires in each .d file and will cause build error if missing or set to an unknown value. Closes #9759	2022-10-18 18:50:25 +02:00
Daniel Stenberg	df45fd1794	docs/cmdline-opts: add copyright and license identifier to each file ... gen.pl now insists on C: and SPDX-License-Identifier: fields to be present in all files. Closes #9002	2022-06-14 08:48:09 +02:00
Daniel Stenberg	ddaa85893d	curl.1: require "see also" for every documented option ... gen.pl now generates a warning if the "See Also" field is not filled in for a command line option All command line options now provide one or more related options. 167 "See alsos" added! Closes #8019	2021-11-15 23:06:41 +01:00
Daniel Stenberg	68784d73c3	curl.1: provide examples for each option ... The file format for each option now features a "Example:" header that can provide one or more examples that get rendered appropriately in the output. All options MUST have at least one example or gen.pl complains at build-time. This fix also does a few other minor format and consistency cleanups. Closes #7654	2021-09-01 14:02:43 +02:00
Emil Engler	5dddc1dc7e	docs: add categories to all cmdline opts ... Adapted gen.pl with 'listcats' This commit is a part of "--help me if you can" Closes #5680	2020-09-04 15:38:14 +02:00
Pedro Monreal	4b6fd29f1a	cleanup: fix typos and wording in docs and comments ... Closes #4869 Reviewed-by: Emil Engler and Daniel Gustafsson	2020-02-02 18:43:01 +01:00
Victor Magierski	8487734e8b	docs: fix typos ... Change 'experiemental' to 'experimental'. Closes #4618 Reviewed-by: Daniel Gustafsson <daniel@yesql.se>	2019-11-20 09:59:05 +01:00
Tim Rühsen	7b758e9835	documentation: Fix several typos ... Closes #3724 Reviewed-by: Jakub Zakrzewski Reviewed-by: Daniel Gustafsson	2019-04-03 22:06:06 +02:00
Daniel Stenberg	c51c78dd8d	alt-svc: the curl command line bits	2019-03-03 11:17:52 +01:00