Blame view

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