summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorDaniel Stenberg <daniel@haxx.se>2017-08-31 10:12:50 +0200
committerDaniel Stenberg <daniel@haxx.se>2017-08-31 10:13:49 +0200
commitf7512d7becb43ff0b1a639e9b0732332bd1c9805 (patch)
tree5df3a4329113c211d682279ff619c54b6bccf025
parentaa2ea66cdac57868c821190dc30d6bb6d58b4a58 (diff)
downloadcurl-f7512d7becb43ff0b1a639e9b0732332bd1c9805.tar.gz
curl_global_sslset.3: show the struct and enum too
... so that users can actually write code based on the man page alone, not having to read the header file.
-rw-r--r--docs/libcurl/curl_global_sslset.329
1 files changed, 25 insertions, 4 deletions
diff --git a/docs/libcurl/curl_global_sslset.3 b/docs/libcurl/curl_global_sslset.3
index d37e7a9fd..5e7a26359 100644
--- a/docs/libcurl/curl_global_sslset.3
+++ b/docs/libcurl/curl_global_sslset.3
@@ -24,10 +24,31 @@
curl_global_sslset - Select SSL backend to use with libcurl
.SH SYNOPSIS
.B #include <curl/curl.h>
-.sp
-.BI "CURLsslset curl_global_sslset(curl_sslbackend " id ", const char *" name
-.BI ", curl_ssl_backend ***" avail ");"
-.ad
+.nf
+
+typedef struct {
+ curl_sslbackend id;
+ const char *name;
+} curl_ssl_backend;
+
+typedef enum {
+ CURLSSLBACKEND_NONE = 0,
+ CURLSSLBACKEND_OPENSSL = 1,
+ CURLSSLBACKEND_GNUTLS = 2,
+ CURLSSLBACKEND_NSS = 3,
+ CURLSSLBACKEND_GSKIT = 5,
+ CURLSSLBACKEND_POLARSSL = 6,
+ CURLSSLBACKEND_WOLFSSL = 7,
+ CURLSSLBACKEND_SCHANNEL = 8,
+ CURLSSLBACKEND_DARWINSSL = 9,
+ CURLSSLBACKEND_AXTLS = 10,
+ CURLSSLBACKEND_MBEDTLS = 11
+} curl_sslbackend;
+
+.B "CURLsslset curl_global_sslset(curl_sslbackend " id,
+.B " const char *" name,
+.B " curl_ssl_backend ***" avail ");"
+.fi
.SH DESCRIPTION
This function configures at runtime which SSL backend to use with
libcurl. This function can only be used to select an SSL backend once, and it