summaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
authorRichard Levitte <levitte@openssl.org>2019-10-01 20:06:22 +0200
committerRichard Levitte <levitte@openssl.org>2019-10-09 10:44:32 +0200
commitf5c14c63226b12e10a9404604657f2860dcfcdee (patch)
treea239b113c762ab78f38a05f89266c5bb79a54f2c /doc
parent35a810bb1d6af5a71170c5c4b506f7665d573a3e (diff)
Command docs: fix links to other sections (sometimes in other manuals)
Reviewed-by: Tomas Mraz <tmraz@fedoraproject.org> (Merged from https://github.com/openssl/openssl/pull/10065)
Diffstat (limited to 'doc')
-rw-r--r--doc/man1/openssl-ca.pod2
-rw-r--r--doc/man1/openssl-dsa.pod2
-rw-r--r--doc/man1/openssl-ec.pod2
-rw-r--r--doc/man1/openssl-genpkey.pod6
-rw-r--r--doc/man1/openssl-pkcs12.pod12
-rw-r--r--doc/man1/openssl-pkcs8.pod2
-rw-r--r--doc/man1/openssl-pkey.pod2
-rw-r--r--doc/man1/openssl-pkeyutl.pod2
-rw-r--r--doc/man1/openssl-req.pod8
-rw-r--r--doc/man1/openssl-rsa.pod2
-rw-r--r--doc/man1/openssl-s_client.pod2
-rw-r--r--doc/man1/openssl-s_server.pod3
-rw-r--r--doc/man1/openssl-srp.pod2
-rw-r--r--doc/man1/openssl-verify.pod16
-rw-r--r--doc/man1/openssl-x509.pod10
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<ps(1)> 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<arg>
The output file password source. For more information about the format of I<arg>
-see the B<PASS PHRASE ARGUMENTS> section in L<openssl(1)>.
+see L<openssl(1)/Pass phrase options>.
=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<arg>
The output file password source. For more information about the format of I<arg>
-see the B<PASS PHRASE ARGUMENTS> section in L<openssl(1)>.
+see L<openssl(1)/Pass phrase options>.
=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<opt> to I<value>. The precise set of
options supported depends on the public key algorithm used and its
-implementation. See L<KEY GENERATION OPTIONS> and
-L<PARAMETER GENERATION OPTIONS> below for more details.
+implementation. See L</KEY GENERATION OPTIONS> and
+L</PARAMETER GENERATION OPTIONS> 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<EC Key Generation Options> above.
+L</EC Key Generation Options> 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<openssl(1)/Pass phrase options>.
=item B<-passout> I<arg>
Pass phrase source to encrypt any outputted private keys with. For more
-information about the format of I<arg> see the B<PASS PHRASE ARGUMENTS> section
-in L<openssl(1)>.
+information about the format of I<arg>
+see L<openssl(1)/Pass phrase options>.
=item B<-password> I<arg>
@@ -207,14 +207,12 @@ displays them.
=item B<-pass> I<arg>, B<-passout> I<arg>
The PKCS#12 file (i.e. output file) password source. For more information about
-the format of I<arg> see the B<PASS PHRASE ARGUMENTS> section in
-L<openssl(1)>.
+the format of I<arg> see L<openssl(1)/Pass phrase options>.
=item B<-passin> I<password>
Pass phrase source to decrypt any input private keys with. For more information
-about the format of I<arg> see the B<PASS PHRASE ARGUMENTS> section in
-L<openssl(1)>.
+about the format of I<arg> see L<openssl(1)/Pass phrase options>.
=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<NOTES> section for more information). If a cipher name
+can be used (see L</NOTES> section for more information). If a cipher name
(as output by C<openssl list -cipher-algorithms>) 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<arg>
The output file password source. For more information about the format of I<arg>
-see the B<PASS PHRASE ARGUMENTS> section in L<openssl(1)>.
+see L<openssl(1)/Pass phrase options>.
=item B<-iter> I<count>
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<arg>
The output file password source. For more information about the format of I<arg>
-see the B<PASS PHRASE ARGUMENTS> section in L<openssl(1)>.
+see L<openssl(1)/Pass phrase options>.
=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<opt> from stdin or a password source.
If only I<opt> is specified, the user will be prompted to enter a password on
stdin. Alternatively, I<passarg> can be specified which can be any value
-supported by B<PASS PHRASE ARGUMENTS> in L<openssl(1)>.
+supported by L<openssl(1)/Pass phrase options>.
=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<arg>
-The output file password source. For more information about the format of I<arg>
-see the B<PASS PHRASE ARGUMENTS> section in L<openssl(1)>.
+The output file password source. For more information about the format of B<arg>
+see L<openssl(1)/Pass phrase options>.
=item B<-text>
@@ -184,8 +184,8 @@ specified by B<-pkeyopt> I<paramset:X>
Set the public key algorithm option I<opt> to I<value>. The precise set of
options supported depends on the public key algorithm used and its
-implementation. See B<KEY GENERATION OPTIONS> in the B<genpkey> manual page
-for more details.
+implementation.
+See L<openssl-genpkey(1)/KEY GENERATION OPTIONS> for more details.
=item B<-key> I<filename>
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<arg>
The output file password source. For more information about the format of I<arg>
-see the B<PASS PHRASE ARGUMENTS> section in L<openssl(1)>.
+see L<openssl(1)/Pass phrase options>.
=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<arg>
the private key password source. For more information about the format of I<arg>
-see the B<PASS PHRASE ARGUMENTS> section in L<openssl(1)>.
+see L<openssl(1)/Pass phrase options>.
=item B<-verify> I<depth>
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<SSL_CONF_cmd(3)>
-manual page.
+L<SSL_CONF_cmd(3)/Supported Command Line Commands>
=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<g> and I<N> 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<openssl(1)> command.
+the L<openssl(1)/Pass phrase options> 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<sslclient>, B<sslserver>, B<nssslserver>,
-B<smimesign>, B<smimeencrypt>. See the B<VERIFY OPERATION> section for more
+B<smimesign>, B<smimeencrypt>. See the L</VERIFY OPERATION> 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<CERTIFICATE EXTENSIONS> section of the B<x509> 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<openssl-x509(1)/CERTIFICATE EXTENSIONS>.
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<TRUST SETTINGS> section.
+but are described in the L</Trust Settings> section.
=over 4
@@ -173,7 +173,7 @@ See the L<x509v3_config(5)> manual page for the extension names.
Customise the output format used with B<-text>. The I<option> argument
can be a single option or multiple options separated by commas. The
B<-certopt> switch may be also be used more than once to set multiple
-options. See the B<TEXT OPTIONS> section for more information.
+options. See the L</Text Options> section for more information.
=item B<-noout>
@@ -233,7 +233,7 @@ Outputs the issuer name.
Option which determines how the subject or issuer names are displayed. The
I<option> argument can be a single option or multiple options separated by
commas. Alternatively the B<-nameopt> switch may be used more than once to
-set multiple options. See the B<NAME OPTIONS> section for more information.
+set multiple options. See the L</Name Options> section for more information.
=item B<-email>
@@ -341,8 +341,8 @@ option.
=item B<-purpose>
This option performs tests on the certificate extensions and outputs
-the results. For a more complete description see the B<CERTIFICATE
-EXTENSIONS> section.
+the results. For a more complete description see the
+L</CERTIFICATE EXTENSIONS> section.
=back