diff options
author | Pauli <paul.dale@oracle.com> | 2020-02-27 07:45:31 +1000 |
---|---|---|
committer | Pauli <paul.dale@oracle.com> | 2020-03-07 11:46:47 +1000 |
commit | 5e98904c231f5a40c6ce291df85799cca7c8d125 (patch) | |
tree | 70e2069ad42554c250543a44a2d4607ed5b39390 /doc/man1/openssl-errstr.pod.in | |
parent | 55f02cb6849f0366dd8b787dbe8e74b56c15bfd1 (diff) |
man1: make all openssl command line tool documentation generated.
With the introduction of provider command line options which are applicable to
almost all of the command line tools, it seemed reasonable to make them all
generated. This simplifes the .gitignore and avoids having to keep two lists
in sync.
Reviewed-by: Tomas Mraz <tmraz@fedoraproject.org>
(Merged from https://github.com/openssl/openssl/pull/11167)
Diffstat (limited to 'doc/man1/openssl-errstr.pod.in')
-rw-r--r-- | doc/man1/openssl-errstr.pod.in | 54 |
1 files changed, 54 insertions, 0 deletions
diff --git a/doc/man1/openssl-errstr.pod.in b/doc/man1/openssl-errstr.pod.in new file mode 100644 index 0000000000..3a4e5163f9 --- /dev/null +++ b/doc/man1/openssl-errstr.pod.in @@ -0,0 +1,54 @@ +=pod +{- OpenSSL::safe::output_do_not_edit_headers(); -} + +=head1 NAME + +openssl-errstr - lookup error codes + +=head1 SYNOPSIS + +B<openssl errstr> +[B<-help>] +I<error_code...> + +=head1 DESCRIPTION + +Sometimes an application will not load error message texts and only +numerical forms will be available. This command can be +used to display the meaning of the hex code. The hex code is the hex digits +after the second colon. + +=head1 OPTIONS + +=over 4 + +=item B<-help> + +Display a usage message. + +=back + +=head1 EXAMPLES + +The error code: + + 27594:error:2006D080:lib(32)::reason(128)::107: + +can be displayed with: + + openssl errstr 2006D080 + +to produce the error message: + + error:2006D080:BIO routines::no such file + +=head1 COPYRIGHT + +Copyright 2004-2019 The OpenSSL Project Authors. All Rights Reserved. + +Licensed under the Apache License 2.0 (the "License"). You may not use +this file except in compliance with the License. You can obtain a copy +in the file LICENSE in the source distribution or at +L<https://www.openssl.org/source/license.html>. + +=cut |