Imported Upstream version 7.48.0
[platform/upstream/curl.git] / docs / libcurl / opts / CURLOPT_SSLENGINE_DEFAULT.3
1 .\" **************************************************************************
2 .\" *                                  _   _ ____  _
3 .\" *  Project                     ___| | | |  _ \| |
4 .\" *                             / __| | | | |_) | |
5 .\" *                            | (__| |_| |  _ <| |___
6 .\" *                             \___|\___/|_| \_\_____|
7 .\" *
8 .\" * Copyright (C) 1998 - 2015, 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_SSLENGINE_DEFAULT 3 "17 Jun 2014" "libcurl 7.37.0" "curl_easy_setopt options"
24 .SH NAME
25 CURLOPT_SSLENGINE_DEFAULT \- make SSL engine default
26 .SH SYNOPSIS
27 #include <curl/curl.h>
28
29 CURLcode curl_easy_setopt(CURL *handle, CURLOPT_SSLENGINE_DEFAULT, long val);
30 .SH DESCRIPTION
31 Pass a long set to 1 to make the already specified crypto engine the default
32 for (asymmetric) crypto operations.
33
34 This option has no effect unless set after \fICURLOPT_SSLENGINE\fP.
35 .SH DEFAULT
36 None
37 .SH PROTOCOLS
38 All TLS based protocols: HTTPS, FTPS, IMAPS, POP3S, SMTPS etc.
39 .SH EXAMPLE
40 TODO
41 .SH AVAILABILITY
42 Only if the SSL backend is OpenSSL built with engine support.
43 .SH RETURN VALUE
44 CURLE_OK - Engine set as default.
45
46 CURLE_SSL_ENGINE_SETFAILED - Engine could not be set as default.
47
48 CURLE_NOT_BUILT_IN - Option not built in, OpenSSL is not the SSL backend.
49
50 CURLE_UNKNOWN_OPTION - Option not recognized.
51
52 CURLE_OUT_OF_MEMORY - Insufficient heap space.
53 .SH "SEE ALSO"
54 .BR CURLOPT_SSLENGINE "(3), " CURLOPT_SSLCERT "(3), "