diff options
author | Dr. Matthias St. Pierre <Matthias.St.Pierre@ncp-e.com> | 2019-08-22 01:04:41 +0200 |
---|---|---|
committer | Dr. Matthias St. Pierre <Matthias.St.Pierre@ncp-e.com> | 2019-08-22 18:58:40 +0200 |
commit | b6b66573bdeb369636be66104687f211dfad03aa (patch) | |
tree | b23b83dff297f3a3499698ad9af054548e7e758c /doc/man1/errstr.pod | |
parent | 8ed7bbb411d2a9e0edef928958ad955e0be3d6dd (diff) |
Deprecate unprefixed manual entries for openssl commands
Initially, the manual page entry for the 'openssl cmd' command used
to be available at 'cmd(1)'. Later, the aliases 'openssl-cmd(1)' was
introduced, which made it easier to group the openssl commands using
the 'apropos(1)' command or the shell's tab completion.
In order to reduce cluttering of the global manual page namespace,
the manual page entries without the 'openssl-' prefix have been
deprecated in OpenSSL 3.0 and will be removed in OpenSSL 4.0.
Reviewed-by: Richard Levitte <levitte@openssl.org>
(Merged from https://github.com/openssl/openssl/pull/9666)
Diffstat (limited to 'doc/man1/errstr.pod')
-rw-r--r-- | doc/man1/errstr.pod | 46 |
1 files changed, 0 insertions, 46 deletions
diff --git a/doc/man1/errstr.pod b/doc/man1/errstr.pod deleted file mode 100644 index 9ba20914a9..0000000000 --- a/doc/man1/errstr.pod +++ /dev/null @@ -1,46 +0,0 @@ -=pod - -=head1 NAME - -openssl-errstr, -errstr - lookup error codes - -=head1 SYNOPSIS - -B<openssl errstr error_code> - -=head1 DESCRIPTION - -Sometimes an application will not load error message and only -numerical forms will be available. The B<errstr> utility can be used to -display the meaning of the hex code. The hex code is the hex digits after the -second colon. - -=head1 OPTIONS - -None. - -=head1 EXAMPLES - -The error code: - - 27594:error:2006D080:lib(32):func(109):reason(128):bss_file.c:107: - -can be displayed with: - - openssl errstr 2006D080 - -to produce the error message: - - error:2006D080:BIO routines:BIO_new_file:no such file - -=head1 COPYRIGHT - -Copyright 2004-2016 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 |