diff options
author | Rich Salz <rsalz@akamai.com> | 2019-10-24 16:40:11 -0400 |
---|---|---|
committer | Tomas Mraz <tmraz@fedoraproject.org> | 2020-01-22 18:06:49 +0100 |
commit | fadb57e554cb0b9b7678902a3572740f31bcc279 (patch) | |
tree | 9f46c05cf0fd4f5fa18c8204c0a9607eb4314b5a /doc/man1 | |
parent | 2280685883f7c19a07a55bcc3ddcd11b6cd82056 (diff) |
Fix some missing doc links.
Replace "=for openssl foreign manuals" with simpler syntax, it looks
like the "=for openssl ifdef" construct.
Fix some broken L<> links; add some missing foreign references and fixed
some typo's.
The WARNINGS in dhparam referred to non-existant commands so reword it.
Fixes #10109
Reviewed-by: Richard Levitte <levitte@openssl.org>
Reviewed-by: Tomas Mraz <tmraz@fedoraproject.org>
(Merged from https://github.com/openssl/openssl/pull/10256)
Diffstat (limited to 'doc/man1')
-rw-r--r-- | doc/man1/openssl-ca.pod.in | 2 | ||||
-rw-r--r-- | doc/man1/openssl-cmds.pod | 4 | ||||
-rw-r--r-- | doc/man1/openssl-dgst.pod.in | 2 | ||||
-rw-r--r-- | doc/man1/openssl-dhparam.pod.in | 12 | ||||
-rw-r--r-- | doc/man1/openssl-ts.pod.in | 4 | ||||
-rw-r--r-- | doc/man1/tsget.pod | 2 |
6 files changed, 14 insertions, 12 deletions
diff --git a/doc/man1/openssl-ca.pod.in b/doc/man1/openssl-ca.pod.in index 44e581e0d9..6d351ae1cc 100644 --- a/doc/man1/openssl-ca.pod.in +++ b/doc/man1/openssl-ca.pod.in @@ -149,6 +149,8 @@ Names and values of these options are algorithm-specific. =item B<-key> I<password> +=for openssl foreign manual ps(1) + The password used to encrypt the private key. Since on some systems the command line arguments are visible (e.g. Unix with the L<ps(1)> utility) this option should be used with caution. diff --git a/doc/man1/openssl-cmds.pod b/doc/man1/openssl-cmds.pod index 8a649ca343..d44d40cfec 100644 --- a/doc/man1/openssl-cmds.pod +++ b/doc/man1/openssl-cmds.pod @@ -55,7 +55,7 @@ version, x509 - OpenSSL application commands -=for comment foreign manuals: apropos(1) +=for openssl foreign manual apropos(1) =head1 SYNOPSIS @@ -136,6 +136,8 @@ L<openssl-x509(1)>, =head1 HISTORY +=for openssl foreign manual apropos(1) + Initially, the manual page entry for the C<openssl I<cmd>> command used to be available at I<cmd>(1). Later, the alias B<openssl-I<cmd>>(1) was introduced, which made it easier to group the openssl commands using diff --git a/doc/man1/openssl-dgst.pod.in b/doc/man1/openssl-dgst.pod.in index 4563ad1d5e..a954b8b253 100644 --- a/doc/man1/openssl-dgst.pod.in +++ b/doc/man1/openssl-dgst.pod.in @@ -81,6 +81,8 @@ Output the digest or signature in binary form. =item B<-r> +=for openssl foreign manual sha1sum(1) + Output the digest in the "coreutils" format, including newlines. Used by programs like L<sha1sum(1)>. diff --git a/doc/man1/openssl-dhparam.pod.in b/doc/man1/openssl-dhparam.pod.in index e125330b36..9da15f7ad2 100644 --- a/doc/man1/openssl-dhparam.pod.in +++ b/doc/man1/openssl-dhparam.pod.in @@ -108,19 +108,15 @@ be loaded by calling the get_dhNNNN() function. =back -=head1 WARNINGS - -This command combines the functionality of the L<openssl-dh(1)> and the -L<openssl-gendh(1)> commands in previous OpenSSL versions. -The L<openssl-dh(1)> and L<openssl-gendh(1)> commands are retained for now but -may have different purposes in future versions of OpenSSL. - =head1 NOTES +This command replaces the B<dh> and B<gendh> commands of previous +releases. + OpenSSL currently only supports the older PKCS#3 DH, not the newer X9.42 DH. -This program manipulates DH parameters not keys. +This command manipulates DH parameters not keys. =head1 BUGS diff --git a/doc/man1/openssl-ts.pod.in b/doc/man1/openssl-ts.pod.in index 0eb4f8031a..53781126fa 100644 --- a/doc/man1/openssl-ts.pod.in +++ b/doc/man1/openssl-ts.pod.in @@ -608,7 +608,7 @@ You could also look at the 'test' directory for more examples. =head1 BUGS -=for openssl foreign manuals: procmail(1), perl(1) +=for openssl foreign manual procmail(1) perl(1) =over 2 @@ -653,7 +653,7 @@ retained mainly for compatibility reasons. =head1 SEE ALSO L<openssl(1)>, -L<openssl-tsget(1)>, +L<tsget(1)>, L<openssl-req(1)>, L<openssl-x509(1)>, L<openssl-ca(1)>, diff --git a/doc/man1/tsget.pod b/doc/man1/tsget.pod index 0287bc94be..201c24fc2a 100644 --- a/doc/man1/tsget.pod +++ b/doc/man1/tsget.pod @@ -183,7 +183,7 @@ example: =head1 SEE ALSO -=for openssl foreign manuals: WWW::Curl::Easy +=for openssl foreign manual WWW::Curl::Easy L<openssl(1)>, L<openssl-ts(1)>, |