diff options
author | schwarze <> | 2019-06-14 13:41:31 +0000 |
---|---|---|
committer | schwarze <> | 2019-06-14 13:41:31 +0000 |
commit | 1c6dd887ec8f9d6b87ce2f220e839fbe1b78db67 (patch) | |
tree | e256db7268ff96a8a7913497240af58ac3423a15 /src/lib/libssl/man/SSL_library_init.3 | |
parent | 5a7670f6ffe1fa2cc36ecf3077067c03cad025ea (diff) | |
download | openbsd-1c6dd887ec8f9d6b87ce2f220e839fbe1b78db67.tar.gz openbsd-1c6dd887ec8f9d6b87ce2f220e839fbe1b78db67.tar.bz2 openbsd-1c6dd887ec8f9d6b87ce2f220e839fbe1b78db67.zip |
Further improve the documentation of library initialization and configuration.
Among other improvements:
* Use a uniform wording at the top of the DECSRIPTION for obsolete pages.
* Better explain how to use a non-standard configuration file.
* Remove obsolete functions from SEE ALSO.
Triggered by some suggestions from tb@.
Tweaks and OK tb@.
Diffstat (limited to 'src/lib/libssl/man/SSL_library_init.3')
-rw-r--r-- | src/lib/libssl/man/SSL_library_init.3 | 32 |
1 files changed, 10 insertions, 22 deletions
diff --git a/src/lib/libssl/man/SSL_library_init.3 b/src/lib/libssl/man/SSL_library_init.3 index 42f19adc28..053c1e6fcb 100644 --- a/src/lib/libssl/man/SSL_library_init.3 +++ b/src/lib/libssl/man/SSL_library_init.3 | |||
@@ -1,4 +1,4 @@ | |||
1 | .\" $OpenBSD: SSL_library_init.3,v 1.6 2018/03/27 17:35:50 schwarze Exp $ | 1 | .\" $OpenBSD: SSL_library_init.3,v 1.7 2019/06/14 13:41:31 schwarze Exp $ |
2 | .\" OpenSSL b97fdb57 Nov 11 09:33:09 2016 +0100 | 2 | .\" OpenSSL b97fdb57 Nov 11 09:33:09 2016 +0100 |
3 | .\" | 3 | .\" |
4 | .\" This file was written by Lutz Jaenicke <jaenicke@openssl.org>. | 4 | .\" This file was written by Lutz Jaenicke <jaenicke@openssl.org>. |
@@ -48,7 +48,7 @@ | |||
48 | .\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED | 48 | .\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED |
49 | .\" OF THE POSSIBILITY OF SUCH DAMAGE. | 49 | .\" OF THE POSSIBILITY OF SUCH DAMAGE. |
50 | .\" | 50 | .\" |
51 | .Dd $Mdocdate: March 27 2018 $ | 51 | .Dd $Mdocdate: June 14 2019 $ |
52 | .Dt SSL_LIBRARY_INIT 3 | 52 | .Dt SSL_LIBRARY_INIT 3 |
53 | .Os | 53 | .Os |
54 | .Sh NAME | 54 | .Sh NAME |
@@ -65,8 +65,13 @@ | |||
65 | .Ft int | 65 | .Ft int |
66 | .Fn SSLeay_add_ssl_algorithms void | 66 | .Fn SSLeay_add_ssl_algorithms void |
67 | .Sh DESCRIPTION | 67 | .Sh DESCRIPTION |
68 | These functions are deprecated. | ||
69 | It is never useful for any application program to call any of them explicitly. | ||
70 | The library automatically calls them internally whenever needed. | ||
71 | .Pp | ||
68 | .Fn SSL_library_init | 72 | .Fn SSL_library_init |
69 | registers the available SSL/TLS ciphers and digests. | 73 | registers the available ciphers and digests |
74 | which are used directly or indirectly by TLS. | ||
70 | .Pp | 75 | .Pp |
71 | .Fn OpenSSL_add_ssl_algorithms | 76 | .Fn OpenSSL_add_ssl_algorithms |
72 | and | 77 | and |
@@ -74,28 +79,11 @@ and | |||
74 | are synonyms for | 79 | are synonyms for |
75 | .Fn SSL_library_init | 80 | .Fn SSL_library_init |
76 | and are implemented as macros. | 81 | and are implemented as macros. |
77 | .Pp | ||
78 | .Fn SSL_library_init | ||
79 | must be called before any other action takes place. | ||
80 | .Fn SSL_library_init | ||
81 | is not reentrant. | ||
82 | .Pp | ||
83 | .Fn SSL_library_init | ||
84 | adds ciphers and digests used directly and indirectly by SSL/TLS. | ||
85 | .Sh RETURN VALUES | 82 | .Sh RETURN VALUES |
86 | .Fn SSL_library_init | 83 | .Fn SSL_library_init |
87 | always returns 1, so it is safe to discard the return value. | 84 | always returns 1. |
88 | .Sh EXAMPLES | ||
89 | A typical TLS/SSL application will start with the library initialization, and | ||
90 | provide readable error messages. | ||
91 | .Bd -literal | ||
92 | SSL_load_error_strings(); /* readable error messages */ | ||
93 | SSL_library_init(); /* initialize library */ | ||
94 | .Ed | ||
95 | .Sh SEE ALSO | 85 | .Sh SEE ALSO |
96 | .Xr RAND_add 3 , | 86 | .Xr ssl 3 |
97 | .Xr ssl 3 , | ||
98 | .Xr SSL_load_error_strings 3 | ||
99 | .Sh HISTORY | 87 | .Sh HISTORY |
100 | .Fn SSLeay_add_ssl_algorithms | 88 | .Fn SSLeay_add_ssl_algorithms |
101 | first appeared in SSLeay 0.8.0 and has been available since | 89 | first appeared in SSLeay 0.8.0 and has been available since |