curl/docs/cmdline-opts/proxy-basic.d

c: Copyright (C) 1998 - 2022, Daniel Stenberg, <daniel@haxx.se>, et al.
SPDX-License-Identifier: curl
Long: proxy-basic
Help: Use Basic authentication on the proxy
See-also: proxy proxy-anyauth proxy-digest
Category: proxy auth
Example: --proxy-basic --proxy-user user:passwd -x proxy $URL
Added: 7.12.0
Multi: mutex
---
Tells curl to use HTTP Basic authentication when communicating with the given
proxy. Use --basic for enabling HTTP Basic with a remote host. Basic is the
default authentication method curl uses with proxies.
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-opts: more command line options documented Moved over to the new format 2016-11-28 07:50:25 +08:00			`Long: proxy-basic`
			`Help: Use Basic authentication on the proxy`
			`See-also: proxy proxy-anyauth proxy-digest`
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: proxy auth`
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: --proxy-basic --proxy-user user:passwd -x proxy $URL`
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: 7.12.0`
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: mutex`
cmdline-opts: more command line options documented Moved over to the new format 2016-11-28 07:50:25 +08:00			`---`
			`Tells curl to use HTTP Basic authentication when communicating with the given`
			`proxy. Use --basic for enabling HTTP Basic with a remote host. Basic is the`
			`default authentication method curl uses with proxies.`