diff options
author | schwarze <> | 2016-11-02 15:23:41 +0000 |
---|---|---|
committer | schwarze <> | 2016-11-02 15:23:41 +0000 |
commit | 878e440382fa65ddbadca1d2784ef1210f0ff652 (patch) | |
tree | d746bbb5cfe6d085f48965873fc3db01fe55f4d6 /src/lib/libcrypto/man/ERR_load_crypto_strings.3 | |
parent | 0f15bae599b571173b77a87f7c4949ff89c55a23 (diff) | |
download | openbsd-878e440382fa65ddbadca1d2784ef1210f0ff652.tar.gz openbsd-878e440382fa65ddbadca1d2784ef1210f0ff652.tar.bz2 openbsd-878e440382fa65ddbadca1d2784ef1210f0ff652.zip |
convert ERR manuals from pod to mdoc; while reading this,
i wtfed, laughed, puked, and cried in more or less that order...
Diffstat (limited to 'src/lib/libcrypto/man/ERR_load_crypto_strings.3')
-rw-r--r-- | src/lib/libcrypto/man/ERR_load_crypto_strings.3 | 48 |
1 files changed, 48 insertions, 0 deletions
diff --git a/src/lib/libcrypto/man/ERR_load_crypto_strings.3 b/src/lib/libcrypto/man/ERR_load_crypto_strings.3 new file mode 100644 index 0000000000..7d14b1e572 --- /dev/null +++ b/src/lib/libcrypto/man/ERR_load_crypto_strings.3 | |||
@@ -0,0 +1,48 @@ | |||
1 | .Dd $Mdocdate: November 2 2016 $ | ||
2 | .Dt ERR_LOAD_CRYPTO_STRINGS 3 | ||
3 | .Os | ||
4 | .Sh NAME | ||
5 | .Nm ERR_load_crypto_strings , | ||
6 | .Nm SSL_load_error_strings , | ||
7 | .Nm ERR_free_strings | ||
8 | .Nd load and free OpenSSL error strings | ||
9 | .Sh SYNOPSIS | ||
10 | .In openssl/err.h | ||
11 | .Ft void | ||
12 | .Fn ERR_load_crypto_strings void | ||
13 | .Ft void | ||
14 | .Fn ERR_free_strings void | ||
15 | .In openssl/ssl.h | ||
16 | .Ft void | ||
17 | .Fn SSL_load_error_strings void | ||
18 | .Sh DESCRIPTION | ||
19 | .Fn ERR_load_crypto_strings | ||
20 | registers the error strings for all | ||
21 | .Xr crypto 3 | ||
22 | functions. | ||
23 | .Fn SSL_load_error_strings | ||
24 | does the same, but also registers the | ||
25 | .Xr ssl 3 | ||
26 | error strings. | ||
27 | .Pp | ||
28 | One of these functions should be called before generating textual error | ||
29 | messages. | ||
30 | However, this is not required when memory usage is an issue. | ||
31 | .Pp | ||
32 | .Fn ERR_free_strings | ||
33 | frees all previously loaded error strings. | ||
34 | .Sh RETURN VALUES | ||
35 | .Fn ERR_load_crypto_strings , | ||
36 | .Fn SSL_load_error_strings , | ||
37 | and | ||
38 | .Fn ERR_free_strings | ||
39 | return no values. | ||
40 | .Sh SEE ALSO | ||
41 | .Xr ERR 3 , | ||
42 | .Xr ERR_error_string 3 | ||
43 | .Sh HISTORY | ||
44 | .Xr ERR_load_error_strings 3 , | ||
45 | .Fn SSL_load_error_strings , | ||
46 | and | ||
47 | .Fn ERR_free_strings | ||
48 | are available in all versions of SSLeay and OpenSSL. | ||