summaryrefslogtreecommitdiff
path: root/src/lib/libcrypto/man/ERR_print_errors.3
diff options
context:
space:
mode:
authorschwarze <>2016-11-02 15:23:41 +0000
committerschwarze <>2016-11-02 15:23:41 +0000
commit878e440382fa65ddbadca1d2784ef1210f0ff652 (patch)
treed746bbb5cfe6d085f48965873fc3db01fe55f4d6 /src/lib/libcrypto/man/ERR_print_errors.3
parent0f15bae599b571173b77a87f7c4949ff89c55a23 (diff)
downloadopenbsd-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_print_errors.3')
-rw-r--r--src/lib/libcrypto/man/ERR_print_errors.357
1 files changed, 57 insertions, 0 deletions
diff --git a/src/lib/libcrypto/man/ERR_print_errors.3 b/src/lib/libcrypto/man/ERR_print_errors.3
new file mode 100644
index 0000000000..1fc80d93f7
--- /dev/null
+++ b/src/lib/libcrypto/man/ERR_print_errors.3
@@ -0,0 +1,57 @@
1.Dd $Mdocdate: November 2 2016 $
2.Dt ERR_PRINT_ERRORS 3
3.Os
4.Sh NAME
5.Nm ERR_print_errors ,
6.Nm ERR_print_errors_fp
7.Nd print OpenSSL error messages
8.Sh SYNOPSIS
9.In openssl/err.h
10.Ft void
11.Fo ERR_print_errors
12.Fa "BIO *bp"
13.Fc
14.Ft void
15.Fo ERR_print_errors_fp
16.Fa "FILE *fp"
17.Fc
18.Sh DESCRIPTION
19.Fn ERR_print_errors
20is a convenience function that prints the error strings for all errors
21that OpenSSL has recorded to
22.Fa bp ,
23thus emptying the error queue.
24.Pp
25.Fn ERR_print_errors_fp
26is the same, except that the output goes to a
27.Vt FILE .
28.Pp
29The error strings have the following format:
30.Bd -literal
31[pid]:error:[error code]:[library name]:[function name]:[reason string]:
32[file name]:[line]:[optional text message]
33.Ed
34.Pp
35The error code is an 8 digit hexadecimal number.
36The library name, the function name, and the reason string are ASCII
37text, as is the optional text message if one was set for the
38respective error code.
39.Pp
40If there is no text string registered for the given error code, the
41error string will contain the numeric code.
42.Sh RETURN VALUES
43.Fn ERR_print_errors
44and
45.Fn ERR_print_errors_fp
46return no values.
47.Sh SEE ALSO
48.Xr ERR 3 ,
49.Xr ERR_error_string 3 ,
50.Xr ERR_get_error 3 ,
51.Xr ERR_load_crypto_strings 3 ,
52.Xr SSL_load_error_strings 3
53.Sh HISTORY
54.Fn ERR_print_errors
55and
56.Fn ERR_print_errors_fp
57are available in all versions of SSLeay and OpenSSL.