Replace "SSLeay" in API with OpenSSL
[openssl.git] / doc / ssl / SSL_library_init.pod
1 =pod
2
3 =head1 NAME
4
5 SSL_library_init, OpenSSL_add_ssl_algorithms,
6 - initialize SSL library by registering algorithms
7
8 =head1 SYNOPSIS
9
10  #include <openssl/ssl.h>
11
12  int SSL_library_init(void);
13  #define OpenSSL_add_ssl_algorithms()    SSL_library_init()
14
15 =head1 DESCRIPTION
16
17 SSL_library_init() registers the available SSL/TLS ciphers and digests.
18
19 OpenSSL_add_ssl_algorithms() is a synonym for SSL_library_init().
20
21 =head1 NOTES
22
23 SSL_library_init() must be called before any other action takes place.
24 SSL_library_init() is not reentrant. 
25
26 =head1 WARNING
27
28 SSL_library_init() adds ciphers and digests used directly and indirectly by
29 SSL/TLS.
30
31 =head1 EXAMPLES
32
33 A typical TLS/SSL application will start with the library initialization,
34 and provide readable error messages.
35
36  SSL_load_error_strings();                /* readable error messages */
37  SSL_library_init();                      /* initialize library */
38
39 =head1 RETURN VALUES
40
41 SSL_library_init() always returns "1", so it is safe to discard the return
42 value.
43
44 =head1 SEE ALSO
45
46 L<ssl(3)>, L<SSL_load_error_strings(3)>,
47 L<RAND_add(3)>
48
49 =cut