From f5c14c63226b12e10a9404604657f2860dcfcdee Mon Sep 17 00:00:00 2001 From: Richard Levitte Date: Tue, 1 Oct 2019 20:06:22 +0200 Subject: [PATCH] Command docs: fix links to other sections (sometimes in other manuals) Reviewed-by: Tomas Mraz (Merged from https://github.com/openssl/openssl/pull/10065) --- doc/man1/openssl-ca.pod | 2 +- doc/man1/openssl-dsa.pod | 2 +- doc/man1/openssl-ec.pod | 2 +- doc/man1/openssl-genpkey.pod | 6 +++--- doc/man1/openssl-pkcs12.pod | 12 +++++------- doc/man1/openssl-pkcs8.pod | 2 +- doc/man1/openssl-pkey.pod | 2 +- doc/man1/openssl-pkeyutl.pod | 2 +- doc/man1/openssl-req.pod | 8 ++++---- doc/man1/openssl-rsa.pod | 2 +- doc/man1/openssl-s_client.pod | 2 +- doc/man1/openssl-s_server.pod | 3 +-- doc/man1/openssl-srp.pod | 2 +- doc/man1/openssl-verify.pod | 16 ++++++++-------- doc/man1/openssl-x509.pod | 10 +++++----- 15 files changed, 35 insertions(+), 38 deletions(-) diff --git a/doc/man1/openssl-ca.pod b/doc/man1/openssl-ca.pod index bf5dc57034..8e1ce25aa2 100644 --- a/doc/man1/openssl-ca.pod +++ b/doc/man1/openssl-ca.pod @@ -147,7 +147,7 @@ Names and values of these options are algorithm-specific. The password used to encrypt the private key. Since on some systems the command line arguments are visible (e.g. Unix with -the 'ps' utility) this option should be used with caution. +the L utility) this option should be used with caution. =item B<-selfsign> diff --git a/doc/man1/openssl-dsa.pod b/doc/man1/openssl-dsa.pod index 55127db6e9..3e3a114252 100644 --- a/doc/man1/openssl-dsa.pod +++ b/doc/man1/openssl-dsa.pod @@ -88,7 +88,7 @@ filename. =item B<-passout> I The output file password source. For more information about the format of I -see the B section in L. +see L. =item B<-aes128>, B<-aes192>, B<-aes256>, B<-aria128>, B<-aria192>, B<-aria256>, B<-camellia128>, B<-camellia192>, B<-camellia256>, B<-des>, B<-des3>, B<-idea> diff --git a/doc/man1/openssl-ec.pod b/doc/man1/openssl-ec.pod index a519367925..8f09692007 100644 --- a/doc/man1/openssl-ec.pod +++ b/doc/man1/openssl-ec.pod @@ -81,7 +81,7 @@ filename. =item B<-passout> I The output file password source. For more information about the format of I -see the B section in L. +see L. =item B<-des>|B<-des3>|B<-idea> diff --git a/doc/man1/openssl-genpkey.pod b/doc/man1/openssl-genpkey.pod index fdec91e064..075bcfbfa7 100644 --- a/doc/man1/openssl-genpkey.pod +++ b/doc/man1/openssl-genpkey.pod @@ -83,8 +83,8 @@ below for more details. Set the public key algorithm option I to I. The precise set of options supported depends on the public key algorithm used and its -implementation. See L and -L below for more details. +implementation. See L and +L below for more details. =item B<-genparam> @@ -243,7 +243,7 @@ options. =head2 EC Parameter Generation Options The EC parameter generation options are the same as for key generation. See -L above. +L above. =head1 NOTES diff --git a/doc/man1/openssl-pkcs12.pod b/doc/man1/openssl-pkcs12.pod index e3c52f3539..4ea722b6e0 100644 --- a/doc/man1/openssl-pkcs12.pod +++ b/doc/man1/openssl-pkcs12.pod @@ -85,8 +85,8 @@ see L. =item B<-passout> I Pass phrase source to encrypt any outputted private keys with. For more -information about the format of I see the B section -in L. +information about the format of I +see L. =item B<-password> I @@ -207,14 +207,12 @@ displays them. =item B<-pass> I, B<-passout> I The PKCS#12 file (i.e. output file) password source. For more information about -the format of I see the B section in -L. +the format of I see L. =item B<-passin> I Pass phrase source to decrypt any input private keys with. For more information -about the format of I see the B section in -L. +about the format of I see L. =item B<-chain> @@ -233,7 +231,7 @@ unless RC2 is disabled in which case triple DES is used. These options allow the algorithm used to encrypt the private key and certificates to be selected. Any PKCS#5 v1.5 or PKCS#12 PBE algorithm name -can be used (see B section for more information). If a cipher name +can be used (see L section for more information). If a cipher name (as output by C) is specified then it is used with PKCS#5 v2.0. For interoperability reasons it is advisable to only use PKCS#12 algorithms. diff --git a/doc/man1/openssl-pkcs8.pod b/doc/man1/openssl-pkcs8.pod index 601a638eaf..a3b6b7b762 100644 --- a/doc/man1/openssl-pkcs8.pod +++ b/doc/man1/openssl-pkcs8.pod @@ -88,7 +88,7 @@ filename. =item B<-passout> I The output file password source. For more information about the format of I -see the B section in L. +see L. =item B<-iter> I diff --git a/doc/man1/openssl-pkey.pod b/doc/man1/openssl-pkey.pod index 49925c2a01..4177a6fedf 100644 --- a/doc/man1/openssl-pkey.pod +++ b/doc/man1/openssl-pkey.pod @@ -70,7 +70,7 @@ filename. =item B<-passout> I The output file password source. For more information about the format of I -see the B section in L. +see L. =item B<-traditional> diff --git a/doc/man1/openssl-pkeyutl.pod b/doc/man1/openssl-pkeyutl.pod index 73a67e49d4..1f231ba325 100644 --- a/doc/man1/openssl-pkeyutl.pod +++ b/doc/man1/openssl-pkeyutl.pod @@ -166,7 +166,7 @@ Public key options specified as opt:value. See NOTES below for more details. Allows reading a public key option I from stdin or a password source. If only I is specified, the user will be prompted to enter a password on stdin. Alternatively, I can be specified which can be any value -supported by B in L. +supported by L. =item B<-hexdump> diff --git a/doc/man1/openssl-req.pod b/doc/man1/openssl-req.pod index ef90a78db8..59da90cb79 100644 --- a/doc/man1/openssl-req.pod +++ b/doc/man1/openssl-req.pod @@ -102,8 +102,8 @@ default. =item B<-passout> I -The output file password source. For more information about the format of I -see the B section in L. +The output file password source. For more information about the format of B +see L. =item B<-text> @@ -184,8 +184,8 @@ specified by B<-pkeyopt> I Set the public key algorithm option I to I. The precise set of options supported depends on the public key algorithm used and its -implementation. See B in the B manual page -for more details. +implementation. +See L for more details. =item B<-key> I diff --git a/doc/man1/openssl-rsa.pod b/doc/man1/openssl-rsa.pod index 6da5345663..36f96b7b11 100644 --- a/doc/man1/openssl-rsa.pod +++ b/doc/man1/openssl-rsa.pod @@ -88,7 +88,7 @@ filename. =item B<-passout> I The output file password source. For more information about the format of I -see the B section in L. +see L. =item B<-aes128>, B<-aes192>, B<-aes256>, B<-aria128>, B<-aria192>, B<-aria256>, B<-camellia128>, B<-camellia192>, B<-camellia256>, B<-des>, B<-des3>, B<-idea> diff --git a/doc/man1/openssl-s_client.pod b/doc/man1/openssl-s_client.pod index dd462360a7..c76f3d1fd8 100644 --- a/doc/man1/openssl-s_client.pod +++ b/doc/man1/openssl-s_client.pod @@ -284,7 +284,7 @@ Extra certificate and private key format respectively. =item B<-pass> I the private key password source. For more information about the format of I -see the B section in L. +see L. =item B<-verify> I diff --git a/doc/man1/openssl-s_server.pod b/doc/man1/openssl-s_server.pod index 14ab307e16..94f1a5ee1f 100644 --- a/doc/man1/openssl-s_server.pod +++ b/doc/man1/openssl-s_server.pod @@ -204,8 +204,7 @@ listens for connections on a given port using SSL/TLS. In addition to the options below, this command also supports the common and server only options documented -in the "Supported Command Line Commands" section of the L -manual page. +L =over 4 diff --git a/doc/man1/openssl-srp.pod b/doc/man1/openssl-srp.pod index dfaadd31f2..8890e00e94 100644 --- a/doc/man1/openssl-srp.pod +++ b/doc/man1/openssl-srp.pod @@ -45,7 +45,7 @@ The B<-gn> flag specifies the I and I values, using one of the strengths defined in IETF RFC 5054. The B<-passin> and B<-passout> arguments are parsed as described in -the L command. +the L command. =head1 OPTIONS diff --git a/doc/man1/openssl-verify.pod b/doc/man1/openssl-verify.pod index 6c1f3ed74c..0dd27c4200 100644 --- a/doc/man1/openssl-verify.pod +++ b/doc/man1/openssl-verify.pod @@ -195,7 +195,7 @@ The intended use for the certificate. If this option is not specified, this command will not consider certificate purpose during chain verification. Currently accepted uses are B, B, B, -B, B. See the B section for more +B, B. See the L section for more information. =item B<-suiteB_128_only>, B<-suiteB_128>, B<-suiteB_192> @@ -383,19 +383,19 @@ list. The second operation is to check every untrusted certificate's extensions for consistency with the supplied purpose. If the B<-purpose> option is not included then no checks are done. The supplied or "leaf" certificate must have extensions -compatible with the supplied purpose and all other certificates must also be valid -CA certificates. The precise extensions required are described in more detail in -the B section of the B utility. +compatible with the supplied purpose and all other certificates must also be +valid CA certificates. The precise extensions required are described in more +detail in L. The third operation is to check the trust settings on the root CA. The root CA should be trusted for the supplied purpose. For compatibility with previous versions of OpenSSL, a certificate with no trust settings is considered to be valid for all purposes. -The final operation is to check the validity of the certificate chain. The validity -period is checked against the current system time and the notBefore and notAfter -dates in the certificate. The certificate signatures are also checked at this -point. +The final operation is to check the validity of the certificate chain. The +validity period is checked against the current system time and the notBefore +and notAfter dates in the certificate. The certificate signatures are also +checked at this point. If all operations complete successfully then certificate is considered valid. If any operation fails then the certificate is not valid. diff --git a/doc/man1/openssl-x509.pod b/doc/man1/openssl-x509.pod index a5e133fd46..5fcff0aed4 100644 --- a/doc/man1/openssl-x509.pod +++ b/doc/man1/openssl-x509.pod @@ -152,7 +152,7 @@ Cannot be used with the B<-days> option. =head2 Display Options Note: the B<-alias> and B<-purpose> options are also display options -but are described in the B section. +but are described in the L section. =over 4 @@ -173,7 +173,7 @@ See the L manual page for the extension names. Customise the output format used with B<-text>. The I