summaryrefslogtreecommitdiff
path: root/src/lib/libcrypto/doc/ERR_print_errors.pod
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/doc/ERR_print_errors.pod
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/doc/ERR_print_errors.pod')
-rw-r--r--src/lib/libcrypto/doc/ERR_print_errors.pod51
1 files changed, 0 insertions, 51 deletions
diff --git a/src/lib/libcrypto/doc/ERR_print_errors.pod b/src/lib/libcrypto/doc/ERR_print_errors.pod
deleted file mode 100644
index b100a5fa2b..0000000000
--- a/src/lib/libcrypto/doc/ERR_print_errors.pod
+++ /dev/null
@@ -1,51 +0,0 @@
1=pod
2
3=head1 NAME
4
5ERR_print_errors, ERR_print_errors_fp - print error messages
6
7=head1 SYNOPSIS
8
9 #include <openssl/err.h>
10
11 void ERR_print_errors(BIO *bp);
12 void ERR_print_errors_fp(FILE *fp);
13
14=head1 DESCRIPTION
15
16ERR_print_errors() is a convenience function that prints the error
17strings for all errors that OpenSSL has recorded to B<bp>, thus
18emptying the error queue.
19
20ERR_print_errors_fp() is the same, except that the output goes to a
21B<FILE>.
22
23
24The error strings will have the following format:
25
26 [pid]:error:[error code]:[library name]:[function name]:[reason string]:[file name]:[line]:[optional text message]
27
28I<error code> is an 8 digit hexadecimal number. I<library name>,
29I<function name> and I<reason string> are ASCII text, as is I<optional
30text message> if one was set for the respective error code.
31
32If there is no text string registered for the given error code,
33the error string will contain the numeric code.
34
35=head1 RETURN VALUES
36
37ERR_print_errors() and ERR_print_errors_fp() return no values.
38
39=head1 SEE ALSO
40
41L<err(3)|err(3)>, L<ERR_error_string(3)|ERR_error_string(3)>,
42L<ERR_get_error(3)|ERR_get_error(3)>,
43L<ERR_load_crypto_strings(3)|ERR_load_crypto_strings(3)>,
44L<SSL_load_error_strings(3)|SSL_load_error_strings(3)>
45
46=head1 HISTORY
47
48ERR_print_errors() and ERR_print_errors_fp()
49are available in all versions of SSLeay and OpenSSL.
50
51=cut