curl/docs/cmdline-opts/ssl.d

c: Copyright (C) Daniel Stenberg, <daniel@haxx.se>, et al.
SPDX-License-Identifier: curl
Long: ssl
Help: Try SSL/TLS
Protocols: FTP IMAP POP3 SMTP LDAP
Added: 7.20.0
Category: tls
Example: --ssl pop3://example.com/
See-also: ssl-reqd insecure ciphers
Multi: boolean
---
Warning: this is considered an insecure option. Consider using --ssl-reqd
instead to be sure curl upgrades to a secure connection.

Try to use SSL/TLS for the connection. Reverts to a non-secure connection if
the server does not support SSL/TLS. See also --ftp-ssl-control and --ssl-reqd
for different levels of encryption required.

This option is handled in LDAP since version 7.81.0. It is fully supported
by the OpenLDAP backend and ignored by the generic ldap backend.

Please note that a server may close the connection if the negotiation does
not succeed.

This option was formerly known as --ftp-ssl (Added in 7.11.0). That option
name can still be used but will be removed in a future version.
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`
docs: fix cmdline-opts metadata headers case consistency. Almost all headers start with an uppercase letter, but some didn't. 2018-05-28 20:16:27 +08:00			`Long: ssl`
cmdline-opts: more command line options documented Moved over to the new format 2016-11-28 07:50:25 +08:00			`Help: Try SSL/TLS`
openldap: implement STARTTLS As this introduces use of CURLOPT_USE_SSL option for LDAP, also check this option in ldap.c as it is not supported by this backend. Closes #8065 2021-12-01 00:48:28 +08:00			`Protocols: FTP IMAP POP3 SMTP LDAP`
cmdline-opts: more command line options documented Moved over to the new format 2016-11-28 07:50:25 +08:00			`Added: 7.20.0`
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: tls`
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: --ssl pop3://example.com/`
curl: warn for --ssl use, considered insecure Closes #9519 2022-09-17 01:03:49 +08:00			`See-also: ssl-reqd insecure ciphers`
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: boolean`
cmdline-opts: more command line options documented Moved over to the new format 2016-11-28 07:50:25 +08:00			`---`
curl: warn for --ssl use, considered insecure Closes #9519 2022-09-17 01:03:49 +08:00			`Warning: this is considered an insecure option. Consider using --ssl-reqd`
			`instead to be sure curl upgrades to a secure connection.`

docs: address proselint nits - avoid exclamation marks - use consistent number of spaces after periods: one - avoid clichés - avoid using 'very' Closes #8060 2021-11-26 15:46:59 +08:00			`Try to use SSL/TLS for the connection. Reverts to a non-secure connection if`
			`the server does not support SSL/TLS. See also --ftp-ssl-control and --ssl-reqd`
cmdline-opts: more command line options documented Moved over to the new format 2016-11-28 07:50:25 +08:00			`for different levels of encryption required.`

openldap: implement STARTTLS As this introduces use of CURLOPT_USE_SSL option for LDAP, also check this option in ldap.c as it is not supported by this backend. Closes #8065 2021-12-01 00:48:28 +08:00			`This option is handled in LDAP since version 7.81.0. It is fully supported`
docs: spellfixes Pointed by the new CI job 2022-09-21 05:30:19 +08:00			`by the OpenLDAP backend and ignored by the generic ldap backend.`
openldap: implement STARTTLS As this introduces use of CURLOPT_USE_SSL option for LDAP, also check this option in ldap.c as it is not supported by this backend. Closes #8065 2021-12-01 00:48:28 +08:00
			`Please note that a server may close the connection if the negotiation does`
			`not succeed.`

cmdline-opts: more command line options documented Moved over to the new format 2016-11-28 07:50:25 +08:00			`This option was formerly known as --ftp-ssl (Added in 7.11.0). That option`
			`name can still be used but will be removed in a future version.`