diff options
author | bentley <> | 2014-10-12 09:33:04 +0000 |
---|---|---|
committer | bentley <> | 2014-10-12 09:33:04 +0000 |
commit | 82b7f378b6907ab315a6e50322d2a0a8794a0aa9 (patch) | |
tree | a5087bf8d016a6041c2b6822fbecfd8f6c5e70b1 /src/lib/libssl/doc/SSL_library_init.3 | |
parent | 0a63f0cf49369e1926567ab62e04e3355cedf0cd (diff) | |
download | openbsd-82b7f378b6907ab315a6e50322d2a0a8794a0aa9.tar.gz openbsd-82b7f378b6907ab315a6e50322d2a0a8794a0aa9.tar.bz2 openbsd-82b7f378b6907ab315a6e50322d2a0a8794a0aa9.zip |
Convert libssl manpages from pod to mdoc(7).
libcrypto has not been started yet.
ok schwarze@ miod@
Diffstat (limited to 'src/lib/libssl/doc/SSL_library_init.3')
-rw-r--r-- | src/lib/libssl/doc/SSL_library_init.3 | 51 |
1 files changed, 51 insertions, 0 deletions
diff --git a/src/lib/libssl/doc/SSL_library_init.3 b/src/lib/libssl/doc/SSL_library_init.3 new file mode 100644 index 0000000000..0644ebd987 --- /dev/null +++ b/src/lib/libssl/doc/SSL_library_init.3 | |||
@@ -0,0 +1,51 @@ | |||
1 | .Dd $Mdocdate: October 12 2014 $ | ||
2 | .Dt SSL_LIBRARY_INIT 3 | ||
3 | .Os | ||
4 | .Sh NAME | ||
5 | .Nm SSL_library_init , | ||
6 | .Nm OpenSSL_add_ssl_algorithms , | ||
7 | .Nm SSLeay_add_ssl_algorithms | ||
8 | .Nd initialize SSL library by registering algorithms | ||
9 | .Sh SYNOPSIS | ||
10 | .In openssl/ssl.h | ||
11 | .Ft int | ||
12 | .Fn SSL_library_init void | ||
13 | .Fd #define OpenSSL_add_ssl_algorithms() SSL_library_init() | ||
14 | .Fd #define SSLeay_add_ssl_algorithms() SSL_library_init() | ||
15 | .Sh DESCRIPTION | ||
16 | .Fn SSL_library_init | ||
17 | registers the available SSL/TLS ciphers and digests. | ||
18 | .Pp | ||
19 | .Fn OpenSSL_add_ssl_algorithms | ||
20 | and | ||
21 | .Fn SSLeay_add_ssl_algorithms | ||
22 | are synonyms for | ||
23 | .Fn SSL_library_init . | ||
24 | .Sh NOTES | ||
25 | .Fn SSL_library_init | ||
26 | must be called before any other action takes place. | ||
27 | .Fn SSL_library_init | ||
28 | is not reentrant. | ||
29 | .Sh WARNING | ||
30 | .Fn SSL_library_init | ||
31 | adds ciphers and digests used directly and indirectly by SSL/TLS. | ||
32 | .Sh RETURN VALUES | ||
33 | .Fn SSL_library_init | ||
34 | always returns 1, so it is safe to discard the return value. | ||
35 | .Sh EXAMPLES | ||
36 | A typical TLS/SSL application will start with the library initialization, and | ||
37 | provide readable error messages. | ||
38 | .Bd -literal | ||
39 | SSL_load_error_strings(); /* readable error messages */ | ||
40 | SSL_library_init(); /* initialize library */ | ||
41 | .Ed | ||
42 | .Sh NOTES | ||
43 | OpenSSL 0.9.8o and 1.0.0a and later added SHA2 algorithms to | ||
44 | .Fn SSL_library_init . | ||
45 | Applications which need to use SHA2 in earlier versions of OpenSSL should call | ||
46 | .Fn OpenSSL_add_all_algorithms | ||
47 | as well. | ||
48 | .Sh SEE ALSO | ||
49 | .Xr RAND_add 3 , | ||
50 | .Xr ssl 3 , | ||
51 | .Xr SSL_load_error_strings 3 | ||