man1: make all openssl command line tool documentation generated.
[openssl.git] / doc / man1 / openssl-errstr.pod.in
1 =pod
2 {- OpenSSL::safe::output_do_not_edit_headers(); -}
3
4 =head1 NAME
5
6 openssl-errstr - lookup error codes
7
8 =head1 SYNOPSIS
9
10 B<openssl errstr>
11 [B<-help>]
12 I<error_code...>
13
14 =head1 DESCRIPTION
15
16 Sometimes an application will not load error message texts and only
17 numerical forms will be available. This command can be
18 used to display the meaning of the hex code. The hex code is the hex digits
19 after the second colon.
20
21 =head1 OPTIONS
22
23 =over 4
24
25 =item B<-help>
26
27 Display a usage message.
28
29 =back
30
31 =head1 EXAMPLES
32
33 The error code:
34
35  27594:error:2006D080:lib(32)::reason(128)::107:
36
37 can be displayed with:
38
39  openssl errstr 2006D080
40
41 to produce the error message:
42
43  error:2006D080:BIO routines::no such file
44
45 =head1 COPYRIGHT
46
47 Copyright 2004-2019 The OpenSSL Project Authors. All Rights Reserved.
48
49 Licensed under the Apache License 2.0 (the "License").  You may not use
50 this file except in compliance with the License.  You can obtain a copy
51 in the file LICENSE in the source distribution or at
52 L<https://www.openssl.org/source/license.html>.
53
54 =cut