From 5af30545c000c195ca6e44f207da004e5780ddb5 Mon Sep 17 00:00:00 2001 From: schwarze <> Date: Sat, 5 Nov 2016 15:32:20 +0000 Subject: move manual pages from doc/ to man/ for consistency with other libraries, in particular considering that there are unrelated files in doc/; requested by jsing@ and beck@ --- src/lib/libssl/man/SSL_library_init.3 | 54 +++++++++++++++++++++++++++++++++++ 1 file changed, 54 insertions(+) create mode 100644 src/lib/libssl/man/SSL_library_init.3 (limited to 'src/lib/libssl/man/SSL_library_init.3') diff --git a/src/lib/libssl/man/SSL_library_init.3 b/src/lib/libssl/man/SSL_library_init.3 new file mode 100644 index 0000000000..ab5326bc4d --- /dev/null +++ b/src/lib/libssl/man/SSL_library_init.3 @@ -0,0 +1,54 @@ +.\" +.\" $OpenBSD: SSL_library_init.3,v 1.1 2016/11/05 15:32:20 schwarze Exp $ +.\" +.Dd $Mdocdate: November 5 2016 $ +.Dt SSL_LIBRARY_INIT 3 +.Os +.Sh NAME +.Nm SSL_library_init , +.Nm OpenSSL_add_ssl_algorithms , +.Nm SSLeay_add_ssl_algorithms +.Nd initialize SSL library by registering algorithms +.Sh SYNOPSIS +.In openssl/ssl.h +.Ft int +.Fn SSL_library_init void +.Fd #define OpenSSL_add_ssl_algorithms() SSL_library_init() +.Fd #define SSLeay_add_ssl_algorithms() SSL_library_init() +.Sh DESCRIPTION +.Fn SSL_library_init +registers the available SSL/TLS ciphers and digests. +.Pp +.Fn OpenSSL_add_ssl_algorithms +and +.Fn SSLeay_add_ssl_algorithms +are synonyms for +.Fn SSL_library_init . +.Sh NOTES +.Fn SSL_library_init +must be called before any other action takes place. +.Fn SSL_library_init +is not reentrant. +.Sh WARNING +.Fn SSL_library_init +adds ciphers and digests used directly and indirectly by SSL/TLS. +.Sh RETURN VALUES +.Fn SSL_library_init +always returns 1, so it is safe to discard the return value. +.Sh EXAMPLES +A typical TLS/SSL application will start with the library initialization, and +provide readable error messages. +.Bd -literal +SSL_load_error_strings(); /* readable error messages */ +SSL_library_init(); /* initialize library */ +.Ed +.Sh NOTES +OpenSSL 0.9.8o and 1.0.0a and later added SHA2 algorithms to +.Fn SSL_library_init . +Applications which need to use SHA2 in earlier versions of OpenSSL should call +.Fn OpenSSL_add_all_algorithms +as well. +.Sh SEE ALSO +.Xr RAND_add 3 , +.Xr ssl 3 , +.Xr SSL_load_error_strings 3 -- cgit v1.2.3-55-g6feb