curl/docs/cmdline-opts/libcurl.d

c: Copyright (C) 1998 - 2022, Daniel Stenberg, <daniel@haxx.se>, et al.
SPDX-License-Identifier: curl
Long: libcurl
Arg: <file>
Help: Dump libcurl equivalent code of this command line
Added: 7.16.1
Category: curl
Example: --libcurl client.c $URL
See-also: verbose
Multi: single
---
Append this option to any ordinary curl command line, and you will get
libcurl-using C source code written to the file that does the equivalent
of what your command-line operation does!

This option is global and does not need to be specified for each use of
--next.
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			`c: Copyright (C) 1998 - 2022, Daniel Stenberg, <daniel@haxx.se>, et al.`
			`SPDX-License-Identifier: curl`
cmdline-docs: more options converted over 2016-11-16 06:44:58 +08:00			`Long: libcurl`
			`Arg: <file>`
			`Help: Dump libcurl equivalent code of this command line`
			`Added: 7.16.1`
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			`Category: 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 22:37:14 +08:00			`Example: --libcurl client.c $URL`
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 22:58:20 +08: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 16:39:43 +08:00			`Multi: single`
cmdline-docs: more options converted over 2016-11-16 06:44:58 +08:00			`---`
docs/cmdline: fix grammar and typos Closes https://github.com/curl/curl/pull/7432 Closes https://github.com/curl/curl/pull/7436 Closes https://github.com/curl/curl/pull/7438 Closes https://github.com/curl/curl/pull/7440 Closes https://github.com/curl/curl/pull/7445 2021-07-19 09:51:43 +08:00			`Append this option to any ordinary curl command line, and you will get`
cmdline-docs: more options converted over 2016-11-16 06:44:58 +08:00			`libcurl-using C source code written to the file that does the equivalent`
			`of what your command-line operation does!`

curl.1: mention "global" flags Mention options that are "global". A global command line option is one that doesn't get reset at --next uses and therefore don't need to be used again. Reported-by: Josh Soref Fixes #7457 Closes #7510 2021-07-28 23:41:05 +08:00			`This option is global and does not need to be specified for each use of`
			`--next.`