mirror of
https://github.com/curl/curl.git
synced 2026-05-23 22:26:22 +03:00
eefcc1bda4
curldown is this new file format for libcurl man pages. It is markdown inspired with differences: - Each file has a set of leading headers with meta-data - Supports a small subset of markdown - Uses .md file extensions for editors/IDE/GitHub to treat them nicely - Generates man pages very similar to the previous ones - Generates man pages that still convert nicely to HTML on the website - Detects and highlights mentions of curl symbols automatically (when their man page section is specified) tools: - cd2nroff: converts from curldown to nroff man page - nroff2cd: convert an (old) nroff man page to curldown - cdall: convert many nroff pages to curldown versions - cd2cd: verifies and updates a curldown to latest curldown This setup generates .3 versions of all the curldown versions at build time. CI: Since the documentation is now technically markdown in the eyes of many things, the CI runs many more tests and checks on this documentation, including proselint, link checkers and tests that make sure we capitalize the first letter after a period... Closes #12730
74 lines
1.5 KiB
Markdown
74 lines
1.5 KiB
Markdown
---
|
|
c: Copyright (C) Daniel Stenberg, <daniel.se>, et al.
|
|
SPDX-License-Identifier: curl
|
|
Title: CURLOPT_SSLENGINE
|
|
Section: 3
|
|
Source: libcurl
|
|
See-also:
|
|
- CURLINFO_SSL_ENGINES (3)
|
|
- CURLOPT_SSLENGINE_DEFAULT (3)
|
|
- CURLOPT_SSLKEY (3)
|
|
---
|
|
|
|
# NAME
|
|
|
|
CURLOPT_SSLENGINE - SSL engine identifier
|
|
|
|
# SYNOPSIS
|
|
|
|
~~~c
|
|
#include <curl/curl.h>
|
|
|
|
CURLcode curl_easy_setopt(CURL *handle, CURLOPT_SSLENGINE, char *id);
|
|
~~~
|
|
|
|
# DESCRIPTION
|
|
|
|
Pass a pointer to a null-terminated string as parameter. It is used as the
|
|
identifier for the crypto engine you want to use for your private key.
|
|
|
|
The application does not have to keep the string around after setting this
|
|
option.
|
|
|
|
# DEFAULT
|
|
|
|
NULL
|
|
|
|
# PROTOCOLS
|
|
|
|
All TLS based protocols: HTTPS, FTPS, IMAPS, POP3S, SMTPS etc.
|
|
|
|
# EXAMPLE
|
|
|
|
~~~c
|
|
int main(void)
|
|
{
|
|
CURL *curl = curl_easy_init();
|
|
if(curl) {
|
|
CURLcode res;
|
|
curl_easy_setopt(curl, CURLOPT_URL, "https://example.com/");
|
|
curl_easy_setopt(curl, CURLOPT_SSLENGINE, "dynamic");
|
|
res = curl_easy_perform(curl);
|
|
curl_easy_cleanup(curl);
|
|
}
|
|
}
|
|
~~~
|
|
|
|
# AVAILABILITY
|
|
|
|
Only if the SSL backend is OpenSSL built with engine support.
|
|
|
|
# RETURN VALUE
|
|
|
|
CURLE_OK - Engine found.
|
|
|
|
CURLE_SSL_ENGINE_NOTFOUND - Engine not found, or OpenSSL was not built with
|
|
engine support.
|
|
|
|
CURLE_SSL_ENGINE_INITFAILED - Engine found but initialization failed.
|
|
|
|
CURLE_NOT_BUILT_IN - Option not built in, OpenSSL is not the SSL backend.
|
|
|
|
CURLE_UNKNOWN_OPTION - Option not recognized.
|
|
|
|
CURLE_OUT_OF_MEMORY - Insufficient heap space.
|