curl/docs/cmdline-opts/help.d

c: Copyright (C) Daniel Stenberg, <daniel@haxx.se>, et al.
SPDX-License-Identifier: curl
Long: help
Arg: <category>
Short: h
Help: Get help for commands
Category: important curl
Example: --help all
Added: 4.0
See-also: verbose
Multi: boolean
---
Usage help. This lists all commands of the <category>.
If no arg was provided, curl will display the most important
command line arguments.
If the argument "all" was provided, curl will display all options available.
If the argument "category" was provided, curl will display all categories and
their meanings.
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 15:51:48 +03:00			`c: Copyright (C) Daniel Stenberg, <daniel@haxx.se>, et al.`
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 01:12:03 +03:00			`SPDX-License-Identifier: curl`
cmdline-docs: more options converted and fixed Now all options are in the new system. 2016-11-28 03:01:13 +03:00			`Long: help`
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-07-13 15:15:04 +03:00			`Arg: <category>`
cmdline-docs: more options converted and fixed Now all options are in the new system. 2016-11-28 03:01:13 +03:00			`Short: h`
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-07-13 15:15:04 +03:00			`Help: Get help for commands`
			`Category: important curl`
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-08-31 17:37:14 +03:00			`Example: --help all`
cmdline-opts: made the 'Added:' field mandatory Since "too old" versions are no longer included in the generated man page, this field is now mandatory so that it won't be forgotten and then not included in the documentation. Closes #7786 2021-09-28 12:50:07 +03:00			`Added: 4.0`
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 17:58:20 +03:00			`See-also: verbose`
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 11:39:43 +03:00			`Multi: boolean`
cmdline-docs: more options converted and fixed Now all options are in the new system. 2016-11-28 03:01:13 +03:00			`---`
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-07-13 15:15:04 +03:00			`Usage help. This lists all commands of the <category>.`
			`If no arg was provided, curl will display the most important`
docs: fix wrong documentation in help.d curl does not list all categories when you invoke "--help" without any parameters. Closes #6436 2021-01-11 22:12:48 +03:00			`command line arguments.`
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-07-13 15:15:04 +03:00			`If the argument "all" was provided, curl will display all options available.`
			`If the argument "category" was provided, curl will display all categories and`
			`their meanings.`