diff options
| author | schwarze <> | 2016-11-05 15:32:20 +0000 |
|---|---|---|
| committer | schwarze <> | 2016-11-05 15:32:20 +0000 |
| commit | b3e8c428c609fc9c66690abb3d188c60b5d48bb1 (patch) | |
| tree | 1672f1234352c29443fcacb44e22f1b20f174d99 /src/lib/libssl/man/SSL_library_init.3 | |
| parent | 19bc742a20d4c505bc890d49e01c44192e9dbeff (diff) | |
| download | openbsd-b3e8c428c609fc9c66690abb3d188c60b5d48bb1.tar.gz openbsd-b3e8c428c609fc9c66690abb3d188c60b5d48bb1.tar.bz2 openbsd-b3e8c428c609fc9c66690abb3d188c60b5d48bb1.zip | |
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@
Diffstat (limited to 'src/lib/libssl/man/SSL_library_init.3')
| -rw-r--r-- | src/lib/libssl/man/SSL_library_init.3 | 54 |
1 files changed, 54 insertions, 0 deletions
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 @@ | |||
| 1 | .\" | ||
| 2 | .\" $OpenBSD: SSL_library_init.3,v 1.1 2016/11/05 15:32:20 schwarze Exp $ | ||
| 3 | .\" | ||
| 4 | .Dd $Mdocdate: November 5 2016 $ | ||
| 5 | .Dt SSL_LIBRARY_INIT 3 | ||
| 6 | .Os | ||
| 7 | .Sh NAME | ||
| 8 | .Nm SSL_library_init , | ||
| 9 | .Nm OpenSSL_add_ssl_algorithms , | ||
| 10 | .Nm SSLeay_add_ssl_algorithms | ||
| 11 | .Nd initialize SSL library by registering algorithms | ||
| 12 | .Sh SYNOPSIS | ||
| 13 | .In openssl/ssl.h | ||
| 14 | .Ft int | ||
| 15 | .Fn SSL_library_init void | ||
| 16 | .Fd #define OpenSSL_add_ssl_algorithms() SSL_library_init() | ||
| 17 | .Fd #define SSLeay_add_ssl_algorithms() SSL_library_init() | ||
| 18 | .Sh DESCRIPTION | ||
| 19 | .Fn SSL_library_init | ||
| 20 | registers the available SSL/TLS ciphers and digests. | ||
| 21 | .Pp | ||
| 22 | .Fn OpenSSL_add_ssl_algorithms | ||
| 23 | and | ||
| 24 | .Fn SSLeay_add_ssl_algorithms | ||
| 25 | are synonyms for | ||
| 26 | .Fn SSL_library_init . | ||
| 27 | .Sh NOTES | ||
| 28 | .Fn SSL_library_init | ||
| 29 | must be called before any other action takes place. | ||
| 30 | .Fn SSL_library_init | ||
| 31 | is not reentrant. | ||
| 32 | .Sh WARNING | ||
| 33 | .Fn SSL_library_init | ||
| 34 | adds ciphers and digests used directly and indirectly by SSL/TLS. | ||
| 35 | .Sh RETURN VALUES | ||
| 36 | .Fn SSL_library_init | ||
| 37 | always returns 1, so it is safe to discard the return value. | ||
| 38 | .Sh EXAMPLES | ||
| 39 | A typical TLS/SSL application will start with the library initialization, and | ||
| 40 | provide readable error messages. | ||
| 41 | .Bd -literal | ||
| 42 | SSL_load_error_strings(); /* readable error messages */ | ||
| 43 | SSL_library_init(); /* initialize library */ | ||
| 44 | .Ed | ||
| 45 | .Sh NOTES | ||
| 46 | OpenSSL 0.9.8o and 1.0.0a and later added SHA2 algorithms to | ||
| 47 | .Fn SSL_library_init . | ||
| 48 | Applications which need to use SHA2 in earlier versions of OpenSSL should call | ||
| 49 | .Fn OpenSSL_add_all_algorithms | ||
| 50 | as well. | ||
| 51 | .Sh SEE ALSO | ||
| 52 | .Xr RAND_add 3 , | ||
| 53 | .Xr ssl 3 , | ||
| 54 | .Xr SSL_load_error_strings 3 | ||
