mirror/curl
2
0
Fork 0
mirror of https://github.com/curl/curl.git synced 2024-12-27 06:59:43 +08:00
Code Issues Packages Projects Releases Wiki Activity
0887297100
curl/docs/cmdline-opts/help.md

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

27 lines
569 B
Markdown
Raw Normal View History

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-21 06:18:43 +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
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 06:12:03 +08:00
SPDX-License-Identifier: curl
cmdline-docs: more options converted and fixed Now all options are in the new system.
2016-11-28 08:01:13 +08: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 20:15:04 +08:00
Arg: <category>
cmdline-docs: more options converted and fixed Now all options are in the new system.
2016-11-28 08:01:13 +08: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 20:15:04 +08:00
Help: Get help for commands
Category: important curl
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 17:50:07 +08:00
Added: 4.0
curl.1: make help, version and manual sections "custom" Instead of using "multi: boolean", as these are slightly special as in they do are not enable/disable ones. Fixes #10490 Reported-by: u20221022 on github Closes #10497
2023-02-13 22:33:13 +08:00
Multi: custom
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-21 06:18:43 +08:00
See-also:
- verbose
Example:
- --help all
cmdline-docs: more options converted and fixed Now all options are in the new system.
2016-11-28 08:01:13 +08:00
---
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-21 06:18:43 +08:00
# `--help`
cmdline-opts: language cleanups Use imperative mood consistently for the first sentence describing an option. "Set this" instead "tell curl to set" or "this sets..." Plus some extra cleanups and rephrasing. Closes #13106
2024-03-12 17:34:58 +08:00
Usage help. List all curl command line options within the given **category**.
docs/cmdline-opts: spellfixes, typos and polish To make them accepted by the spell checker Closes #11562
2023-08-01 20:11:50 +08:00
cmdline-opts: language cleanups Use imperative mood consistently for the first sentence describing an option. "Set this" instead "tell curl to set" or "this sets..." Plus some extra cleanups and rephrasing. Closes #13106
2024-03-12 17:34:58 +08:00
If no argument is provided, curl displays the most important command line
docs/cmdline-opts: spellfixes, typos and polish To make them accepted by the spell checker Closes #11562
2023-08-01 20:11:50 +08:00
arguments.
For category **all**, curl displays help for all options.
If **category** is specified, curl displays all available help categories.
Reference in New Issue Copy Permalink