curl/docs/cmdline-opts/proto.d

c: Copyright (C) Daniel Stenberg, <daniel@haxx.se>, et al.
SPDX-License-Identifier: curl
Long: proto
Arg: <protocols>
Help: Enable/disable PROTOCOLS
See-also: proto-redir proto-default
Added: 7.20.2
Category: connection curl
Example: --proto =http,https,sftp $URL
Multi: single
---
Tells curl to limit what protocols it may use for transfers. Protocols are
evaluated left to right, are comma separated, and are each a protocol name or
'all', optionally prefixed by zero or more modifiers. Available modifiers are:

## +
Permit this protocol in addition to protocols already permitted (this is
the default if no modifier is used).

## -
Deny this protocol, removing it from the list of protocols already permitted.

## =
Permit only this protocol (ignoring the list already permitted), though
subject to later modification by subsequent entries in the comma separated
list.

##

For example: --proto -ftps uses the default protocols, but disables ftps

--proto -all,https,+http only enables http and https

--proto =http,https also only enables http and https

Unknown and disabled protocols produce a warning. This allows scripts to
safely rely on being able to disable potentially dangerous protocols, without
relying upon support for that protocol being built into curl to avoid an error.

This option can be used multiple times, in which case the effect is the same
as concatenating the protocols into one instance of the option.
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 conversion 2016-11-16 21:20:36 +08:00			`Long: proto`
			`Arg: <protocols>`
			`Help: Enable/disable PROTOCOLS`
			`See-also: proto-redir proto-default`
			`Added: 7.20.2`
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: connection 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: --proto =http,https,sftp $URL`
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 conversion 2016-11-16 21:20:36 +08:00			`---`
doc/cmdline: fix grammar and typos Closes https://github.com/curl/curl/pull/7454 Closes https://github.com/curl/curl/pull/7455 Closes https://github.com/curl/curl/pull/7456 Closes https://github.com/curl/curl/pull/7459 Closes https://github.com/curl/curl/pull/7460 Closes https://github.com/curl/curl/pull/7461 Closes https://github.com/curl/curl/pull/7462 Closes https://github.com/curl/curl/pull/7463 2021-07-20 13:06:56 +08:00			`Tells curl to limit what protocols it may use for transfers. Protocols are`
cmdline-docs: more conversion 2016-11-16 21:20:36 +08:00			`evaluated left to right, are comma separated, and are each a protocol name or`
docs/cmdline-opts: remove \& escapes from all .d files gen.pl escapes them itself now 2022-08-23 19:42:49 +08:00			`'all', optionally prefixed by zero or more modifiers. Available modifiers are:`
cmdline/docs/*.d: switch to using ## instead of .IP To make the editing easier. To write and to read. Closes #12667 2024-01-09 17:36:14 +08:00
			`## +`
cmdline-docs: more conversion 2016-11-16 21:20:36 +08:00			`Permit this protocol in addition to protocols already permitted (this is`
			`the default if no modifier is used).`
cmdline/docs/*.d: switch to using ## instead of .IP To make the editing easier. To write and to read. Closes #12667 2024-01-09 17:36:14 +08:00
			`## -`
cmdline-docs: more conversion 2016-11-16 21:20:36 +08:00			`Deny this protocol, removing it from the list of protocols already permitted.`
cmdline/docs/*.d: switch to using ## instead of .IP To make the editing easier. To write and to read. Closes #12667 2024-01-09 17:36:14 +08:00
			`## =`
cmdline-docs: more conversion 2016-11-16 21:20:36 +08:00			`Permit only this protocol (ignoring the list already permitted), though`
			`subject to later modification by subsequent entries in the comma separated`
			`list.`
cmdline/docs/*.d: switch to using ## instead of .IP To make the editing easier. To write and to read. Closes #12667 2024-01-09 17:36:14 +08:00
			`##`

cmdline-docs: use .IP consistently Remove use of .TP and some .B. The idea is to reduce nroff syntax as much as possible and to use it consistently. Ultimately, we should be able to introduce our own easier-to-use-and-read syntax/formatting and convert on generation time. Closes #12535 2023-12-16 18:46:31 +08:00			`For example: --proto -ftps uses the default protocols, but disables ftps`

			`--proto -all,https,+http only enables http and https`

			`--proto =http,https also only enables http and https`

docs: tell about disabled protocols in CURLOPT_*PROTOCOLS_STR. Disabled protocols are now handled as if they were unknown. Also update the possible protocol list. 2022-09-14 01:47:18 +08:00			`Unknown and disabled protocols produce a warning. This allows scripts to`
			`safely rely on being able to disable potentially dangerous protocols, without`
			`relying upon support for that protocol being built into curl to avoid an error.`
cmdline-docs: more conversion 2016-11-16 21:20:36 +08:00
			`This option can be used multiple times, in which case the effect is the same`
			`as concatenating the protocols into one instance of the option.`