Annotation of embedaddon/curl/docs/libcurl/opts/CURLOPT_USE_SSL.3, revision 1.1

1.1     ! misho       1: .\" **************************************************************************
        !             2: .\" *                                  _   _ ____  _
        !             3: .\" *  Project                     ___| | | |  _ \| |
        !             4: .\" *                             / __| | | | |_) | |
        !             5: .\" *                            | (__| |_| |  _ <| |___
        !             6: .\" *                             \___|\___/|_| \_\_____|
        !             7: .\" *
        !             8: .\" * Copyright (C) 1998 - 2020, Daniel Stenberg, <daniel@haxx.se>, et al.
        !             9: .\" *
        !            10: .\" * This software is licensed as described in the file COPYING, which
        !            11: .\" * you should have received as part of this distribution. The terms
        !            12: .\" * are also available at https://curl.haxx.se/docs/copyright.html.
        !            13: .\" *
        !            14: .\" * You may opt to use, copy, modify, merge, publish, distribute and/or sell
        !            15: .\" * copies of the Software, and permit persons to whom the Software is
        !            16: .\" * furnished to do so, under the terms of the COPYING file.
        !            17: .\" *
        !            18: .\" * This software is distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY
        !            19: .\" * KIND, either express or implied.
        !            20: .\" *
        !            21: .\" **************************************************************************
        !            22: .\"
        !            23: .TH CURLOPT_USE_SSL 3 "March 23, 2020" "libcurl 7.70.0" "curl_easy_setopt options"
        !            24: 
        !            25: .SH NAME
        !            26: CURLOPT_USE_SSL \- request using SSL / TLS for the transfer
        !            27: .SH SYNOPSIS
        !            28: #include <curl/curl.h>
        !            29: 
        !            30: CURLcode curl_easy_setopt(CURL *handle, CURLOPT_USE_SSL, long level);
        !            31: .SH DESCRIPTION
        !            32: Pass a long using one of the values from below, to make libcurl use your
        !            33: desired \fIlevel\fP of SSL for the transfer.
        !            34: 
        !            35: These are all protocols that start out plain text and get "upgraded" to SSL
        !            36: using the STARTTLS command.
        !            37: 
        !            38: This is for enabling SSL/TLS when you use FTP, SMTP, POP3, IMAP etc.
        !            39: .IP CURLUSESSL_NONE
        !            40: Don't attempt to use SSL.
        !            41: .IP CURLUSESSL_TRY
        !            42: Try using SSL, proceed as normal otherwise.
        !            43: .IP CURLUSESSL_CONTROL
        !            44: Require SSL for the control connection or fail with \fICURLE_USE_SSL_FAILED\fP.
        !            45: .IP CURLUSESSL_ALL
        !            46: Require SSL for all communication or fail with \fICURLE_USE_SSL_FAILED\fP.
        !            47: .SH DEFAULT
        !            48: CURLUSESSL_NONE
        !            49: .SH PROTOCOLS
        !            50: FTP, SMTP, POP3, IMAP
        !            51: .SH EXAMPLE
        !            52: .nf
        !            53: CURL *curl = curl_easy_init();
        !            54: if(curl) {
        !            55:   curl_easy_setopt(curl, CURLOPT_URL, "ftp://example.com/dir/file.ext");
        !            56: 
        !            57:   /* require use of SSL for this, or fail */
        !            58:   curl_easy_setopt(curl, CURLOPT_USE_SSL, CURLUSESSL_ALL);
        !            59: 
        !            60:   /* Perform the request */
        !            61:   curl_easy_perform(curl);
        !            62: }
        !            63: .fi
        !            64: .SH AVAILABILITY
        !            65: Added in 7.11.0. This option was known as CURLOPT_FTP_SSL up to 7.16.4, and
        !            66: the constants were known as CURLFTPSSL_*
        !            67: .SH RETURN VALUE
        !            68: Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not.
        !            69: .SH "SEE ALSO"
        !            70: .BR CURLOPT_SSLVERSION "(3), " CURLOPT_PROXY_SSLVERSION "(3), "
        !            71: .BR CURLOPT_SSL_OPTIONS "(3), "

FreeBSD-CVSweb <freebsd-cvsweb@FreeBSD.org>