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/OPENSSL_init_ssl.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/OPENSSL_init_ssl.3')
-rw-r--r-- | src/lib/libssl/man/OPENSSL_init_ssl.3 | 30 |
1 files changed, 22 insertions, 8 deletions
diff --git a/src/lib/libssl/man/OPENSSL_init_ssl.3 b/src/lib/libssl/man/OPENSSL_init_ssl.3 index 5c9f51fe49..f37dccfaac 100644 --- a/src/lib/libssl/man/OPENSSL_init_ssl.3 +++ b/src/lib/libssl/man/OPENSSL_init_ssl.3 | |||
@@ -1,4 +1,4 @@ | |||
1 | .\" $OpenBSD: OPENSSL_init_ssl.3,v 1.3 2019/06/12 09:36:30 schwarze Exp $ | 1 | .\" $OpenBSD: OPENSSL_init_ssl.3,v 1.4 2019/06/14 13:41:31 schwarze Exp $ |
2 | .\" Copyright (c) 2018 Ingo Schwarze <schwarze@openbsd.org> | 2 | .\" Copyright (c) 2018 Ingo Schwarze <schwarze@openbsd.org> |
3 | .\" | 3 | .\" |
4 | .\" Permission to use, copy, modify, and distribute this software for any | 4 | .\" Permission to use, copy, modify, and distribute this software for any |
@@ -13,7 +13,7 @@ | |||
13 | .\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF | 13 | .\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF |
14 | .\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. | 14 | .\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. |
15 | .\" | 15 | .\" |
16 | .Dd $Mdocdate: June 12 2019 $ | 16 | .Dd $Mdocdate: June 14 2019 $ |
17 | .Dt OPENSSL_INIT_SSL 3 | 17 | .Dt OPENSSL_INIT_SSL 3 |
18 | .Os | 18 | .Os |
19 | .Sh NAME | 19 | .Sh NAME |
@@ -27,13 +27,27 @@ | |||
27 | .Fa "const void *dummy" | 27 | .Fa "const void *dummy" |
28 | .Fc | 28 | .Fc |
29 | .Sh DESCRIPTION | 29 | .Sh DESCRIPTION |
30 | This function is deprecated. | ||
31 | It is never useful for any application program to call it explicitly. | ||
32 | The library automatically calls it internally with an | ||
33 | .Fa options | ||
34 | argument of 0 whenever needed. | ||
35 | It is safest to assume that any function may do so. | ||
36 | .Pp | ||
37 | To enable or disable the standard configuration file, instead use | ||
38 | .Xr OPENSSL_config 3 | ||
39 | or | ||
40 | .Xr OPENSSL_no_config 3 , | ||
41 | respectively. | ||
42 | To load a non-standard configuration file, refer to | ||
43 | .Xr CONF_modules_load_file 3 . | ||
44 | .Pp | ||
30 | .Fn OPENSSL_init_ssl | 45 | .Fn OPENSSL_init_ssl |
31 | calls | 46 | calls |
32 | .Xr OPENSSL_init_crypto 3 | 47 | .Xr OPENSSL_init_crypto 3 , |
33 | and also allocates various resources used internally by the ssl library. | 48 | .Xr SSL_load_error_strings 3 , |
34 | .Pp | 49 | and |
35 | Calling it is never useful because it is automatically called | 50 | .Xr SSL_library_init 3 . |
36 | internally when needed. | ||
37 | .Pp | 51 | .Pp |
38 | The | 52 | The |
39 | .Fa options | 53 | .Fa options |
@@ -50,7 +64,7 @@ none of the calls except the first one have any effect. | |||
50 | is intended to return 1 on success or 0 on error. | 64 | is intended to return 1 on success or 0 on error. |
51 | .Sh SEE ALSO | 65 | .Sh SEE ALSO |
52 | .Xr CONF_modules_load_file 3 , | 66 | .Xr CONF_modules_load_file 3 , |
53 | .Xr OPENSSL_init_crypto 3 , | 67 | .Xr OPENSSL_config 3 , |
54 | .Xr ssl 3 | 68 | .Xr ssl 3 |
55 | .Sh HISTORY | 69 | .Sh HISTORY |
56 | .Fn OPENSSL_init_ssl | 70 | .Fn OPENSSL_init_ssl |