From: Ankita Shetty Date: Wed, 9 Dec 2020 20:56:51 +0000 (+0100) Subject: openssl.pod: Fix openSSL options doc X-Git-Tag: openssl-3.0.0-alpha10~67 X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=469491536d7810337110823f1b5ca296c7ca8cc1;p=thirdparty%2Fopenssl.git openssl.pod: Fix openSSL options doc Reviewed-by: Richard Levitte Reviewed-by: Tomas Mraz Reviewed-by: David von Oheimb (Merged from https://github.com/openssl/openssl/pull/13651) --- diff --git a/doc/man1/openssl-asn1parse.pod.in b/doc/man1/openssl-asn1parse.pod.in index 62b7e626efa..f098c89c338 100644 --- a/doc/man1/openssl-asn1parse.pod.in +++ b/doc/man1/openssl-asn1parse.pod.in @@ -41,7 +41,7 @@ Print out a usage message. =item B<-inform> B|B The input format; the default is B. -See L for details. +See L for details. =item B<-in> I diff --git a/doc/man1/openssl-ca.pod.in b/doc/man1/openssl-ca.pod.in index 68da77d349c..d2d3bfb13df 100644 --- a/doc/man1/openssl-ca.pod.in +++ b/doc/man1/openssl-ca.pod.in @@ -156,7 +156,7 @@ The CA private key to sign requests with. This must match with B<-cert>. The format of the private key input file; the default is B. The only value with effect is B; all others have become obsolete. -See L for details. +See L for details. =item B<-sigopt> I:I @@ -186,7 +186,7 @@ Better use B<-passin>. The key password source for key files and certificate PKCS#12 files. For more information about the format of B -see L. +see L. =item B<-selfsign> diff --git a/doc/man1/openssl-cms.pod.in b/doc/man1/openssl-cms.pod.in index f5872f2261a..847ebaccd8d 100644 --- a/doc/man1/openssl-cms.pod.in +++ b/doc/man1/openssl-cms.pod.in @@ -228,25 +228,25 @@ format message that has been signed or verified. The input format of the CMS structure (if one is being read); the default is B. -See L for details. +See L for details. =item B<-outform> B|B|B The output format of the CMS structure (if one is being written); the default is B. -See L for details. +See L for details. =item B<-keyform> B|B|B|B The format of the private key file; the default is B. The only value with effect is B; all others have become obsolete. -See L for details. +See L for details. =item B<-rctform> B|B|B The signed receipt format for use with the B<-receipt_verify>; the default is B. -See L for details. +See L for details. =item B<-stream>, B<-indef> @@ -293,7 +293,7 @@ is mainly useful for testing purposes. For the B<-cmsout> operation when B<-print> option is in use, specifies printing options for string fields. For most cases B is reasonable value. -See L for details. +See L for details. =item B<-md> I @@ -484,7 +484,7 @@ or to modify default parameters for ECDH. =item B<-passin> I The private key password source. For more information about the format of B -see L. +see L. =item B<-to>, B<-from>, B<-subject> diff --git a/doc/man1/openssl-crl.pod.in b/doc/man1/openssl-crl.pod.in index 98404c7b4ac..ccba7938a2a 100644 --- a/doc/man1/openssl-crl.pod.in +++ b/doc/man1/openssl-crl.pod.in @@ -53,7 +53,7 @@ This option has no effect and is retained for backward compatibility only. =item B<-outform> B|B The CRL output format; the default is B. -See L for details. +See L for details. =item B<-key> I diff --git a/doc/man1/openssl-crl2pkcs7.pod.in b/doc/man1/openssl-crl2pkcs7.pod.in index 5dcd7a933b0..db06f6e68f3 100644 --- a/doc/man1/openssl-crl2pkcs7.pod.in +++ b/doc/man1/openssl-crl2pkcs7.pod.in @@ -34,12 +34,12 @@ Print out a usage message. =item B<-inform> B|B The input format of the CRL; the default is B. -See L for details. +See L for details. =item B<-outform> B|B The output format of the PKCS#7 object; the default is B. -See L for details. +See L for details. =item B<-in> I diff --git a/doc/man1/openssl-dgst.pod.in b/doc/man1/openssl-dgst.pod.in index 6679973c0ef..d90e6146c6c 100644 --- a/doc/man1/openssl-dgst.pod.in +++ b/doc/man1/openssl-dgst.pod.in @@ -110,7 +110,7 @@ command instead for this. The format of the key to sign with; the default is B. The only value with effect is B; all others have become obsolete. -See L for details. +See L for details. =item B<-sigopt> I:I @@ -120,7 +120,7 @@ Names and values of these options are algorithm-specific. =item B<-passin> I The private key password source. For more information about the format of I -see L. +see L. =item B<-verify> I diff --git a/doc/man1/openssl-dhparam.pod.in b/doc/man1/openssl-dhparam.pod.in index 778747df59f..eee69a69de5 100644 --- a/doc/man1/openssl-dhparam.pod.in +++ b/doc/man1/openssl-dhparam.pod.in @@ -42,7 +42,7 @@ Print out a usage message. The input format and output format; the default is B. The object is compatible with the PKCS#3 B structure. -See L for details. +See L for details. =item B<-in> I diff --git a/doc/man1/openssl-dsa.pod.in b/doc/man1/openssl-dsa.pod.in index f1839341ed6..61f4b1f74bf 100644 --- a/doc/man1/openssl-dsa.pod.in +++ b/doc/man1/openssl-dsa.pod.in @@ -58,7 +58,7 @@ Print out a usage message. =item B<-inform> B|B, B<-outform> B|B The input and formats; the default is B. -See L for details. +See L for details. Private keys are a sequence of B: the version (zero), B

, B, B, and the public and private key components. Public keys @@ -83,7 +83,7 @@ filename. The password source for the input and output file. For more information about the format of B -see 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-dsaparam.pod.in b/doc/man1/openssl-dsaparam.pod.in index f7c3eafb0f5..96c429cf940 100644 --- a/doc/man1/openssl-dsaparam.pod.in +++ b/doc/man1/openssl-dsaparam.pod.in @@ -39,7 +39,7 @@ Print out a usage message. =item B<-inform> B|B, B<-outform> B|B This option has become obsolete. -See L for details. +See L for details. Parameters are a sequence of Bs: B

, B, and B. This is compatible with RFC 2459 B structure. diff --git a/doc/man1/openssl-ec.pod.in b/doc/man1/openssl-ec.pod.in index befae6990bc..5cdd3d820a4 100644 --- a/doc/man1/openssl-ec.pod.in +++ b/doc/man1/openssl-ec.pod.in @@ -55,12 +55,12 @@ Print out a usage message. The key input format; the default is B. The only value with effect is B; all others have become obsolete. -See L for details. +See L for details. =item B<-outform> B|B The key output formats; the default is B. -See L for details. +See L for details. Private keys are an SEC1 private key or PKCS#8 format. Public keys are a B as specified in IETF RFC 3280. @@ -82,7 +82,7 @@ filename. The password source for the input and output file. For more information about the format of B -see L. +see L. =item B<-des>|B<-des3>|B<-idea> diff --git a/doc/man1/openssl-ecparam.pod.in b/doc/man1/openssl-ecparam.pod.in index 26fd0af97b6..ee5c0218190 100644 --- a/doc/man1/openssl-ecparam.pod.in +++ b/doc/man1/openssl-ecparam.pod.in @@ -46,7 +46,7 @@ Print out a usage message. =item B<-inform> B|B, B<-outform> B|B The input and formats; the default is B. -See L for details. +See L for details. Parameters are encoded as B as specified in IETF RFC 3279. diff --git a/doc/man1/openssl-enc.pod.in b/doc/man1/openssl-enc.pod.in index 2665ddc2afe..cc0378c4718 100644 --- a/doc/man1/openssl-enc.pod.in +++ b/doc/man1/openssl-enc.pod.in @@ -79,7 +79,7 @@ The output filename, standard output by default. =item B<-pass> I The password source. For more information about the format of I -see L. +see L. =item B<-e> diff --git a/doc/man1/openssl-gendsa.pod.in b/doc/man1/openssl-gendsa.pod.in index e62e0706cb1..2a4e7692a5f 100644 --- a/doc/man1/openssl-gendsa.pod.in +++ b/doc/man1/openssl-gendsa.pod.in @@ -51,7 +51,7 @@ standard output is used. =item B<-passout> I The passphrase used for the output file. -See 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-genpkey.pod.in b/doc/man1/openssl-genpkey.pod.in index 14b5767c946..7f4ebef439a 100644 --- a/doc/man1/openssl-genpkey.pod.in +++ b/doc/man1/openssl-genpkey.pod.in @@ -47,14 +47,14 @@ standard output is used. =item B<-outform> B|B The output format, except when B<-genparam> is given; the default is B. -See L for details. +See L for details. When B<-genparam> is given, B<-outform> is ignored. =item B<-pass> I The output file password source. For more information about the format of I -see L. +see L. =item B<-I> diff --git a/doc/man1/openssl-genrsa.pod.in b/doc/man1/openssl-genrsa.pod.in index f524bb860b1..1a6c32250a4 100644 --- a/doc/man1/openssl-genrsa.pod.in +++ b/doc/man1/openssl-genrsa.pod.in @@ -58,7 +58,7 @@ standard output is used. =item B<-passout> I The output file password source. For more information about the format -see 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-namefmt-options.pod b/doc/man1/openssl-namedisplay-options.pod similarity index 98% rename from doc/man1/openssl-namefmt-options.pod rename to doc/man1/openssl-namedisplay-options.pod index d92abd406ba..ff6ed1f4b47 100644 --- a/doc/man1/openssl-namefmt-options.pod +++ b/doc/man1/openssl-namedisplay-options.pod @@ -2,7 +2,7 @@ =head1 NAME -openssl-namefmt-options - DN display options +openssl-namedisplay-options - Distinguished name display options =head1 SYNOPSIS diff --git a/doc/man1/openssl-ocsp.pod.in b/doc/man1/openssl-ocsp.pod.in index a3e9d3e5047..8cd9c7de190 100644 --- a/doc/man1/openssl-ocsp.pod.in +++ b/doc/man1/openssl-ocsp.pod.in @@ -314,7 +314,7 @@ specified in the B<-rsigner> option is used. =item B<-passin> I The private key password source. For more information about the format of I -see L. +see L. =item B<-rother> I diff --git a/doc/man1/openssl-pkcs12.pod.in b/doc/man1/openssl-pkcs12.pod.in index b9565144da6..c0e0fdfca9a 100644 --- a/doc/man1/openssl-pkcs12.pod.in +++ b/doc/man1/openssl-pkcs12.pod.in @@ -293,6 +293,10 @@ displays them. =item B<-CSP> I Write I as a Microsoft CSP name. +The password source for the input, and for encrypting any private keys that +are output. +For more information about the format of B +see L. =item B<-LMK> diff --git a/doc/man1/openssl-pkcs7.pod.in b/doc/man1/openssl-pkcs7.pod.in index 3a28adc1ab3..7c3130c09a7 100644 --- a/doc/man1/openssl-pkcs7.pod.in +++ b/doc/man1/openssl-pkcs7.pod.in @@ -42,7 +42,7 @@ Print out a usage message. =item B<-inform> B|B, B<-outform> B|B The input and formats; the default is B. -See L for details. +See L for details. The data is a PKCS#7 Version 1.5 structure. diff --git a/doc/man1/openssl-pkcs8.pod.in b/doc/man1/openssl-pkcs8.pod.in index 6ff6e8bc758..8e7542611e8 100644 --- a/doc/man1/openssl-pkcs8.pod.in +++ b/doc/man1/openssl-pkcs8.pod.in @@ -55,7 +55,7 @@ reversed: it reads a private key and writes a PKCS#8 format key. =item B<-inform> B|B, B<-outform> B|B The input and formats; the default is B. -See L for details. +See L for details. If a key is being converted from PKCS#8 form (i.e. the B<-topk8> option is not used) then the input file must be in PKCS#8 format. An encrypted @@ -88,7 +88,7 @@ prompted for. The password source for the input and output file. For more information about the format of B -see L. +see L. =item B<-out> I diff --git a/doc/man1/openssl-pkey.pod.in b/doc/man1/openssl-pkey.pod.in index 14a8a638410..86597c9e369 100644 --- a/doc/man1/openssl-pkey.pod.in +++ b/doc/man1/openssl-pkey.pod.in @@ -51,12 +51,12 @@ Print out a usage message. The key input format; the default is B. The only value with effect is B; all others have become obsolete. -See L for details. +See L for details. =item B<-outform> B|B The key output formats; the default is B. -See L for details. +See L for details. =item B<-in> I|I @@ -68,7 +68,7 @@ prompted for. The password source for the input and output file. For more information about the format of B -see L. +see L. =item B<-out> I diff --git a/doc/man1/openssl-pkeyutl.pod.in b/doc/man1/openssl-pkeyutl.pod.in index b657440f7ee..3ba09554250 100644 --- a/doc/man1/openssl-pkeyutl.pod.in +++ b/doc/man1/openssl-pkeyutl.pod.in @@ -93,12 +93,12 @@ The input key, by default it should be a private key. The key format; the default is B. The only value with effect is B; all others have become obsolete. -See L for details. +See L for details. =item B<-passin> I The input key password source. For more information about the format of I -see L. +see L. =item B<-peerkey> I @@ -108,7 +108,7 @@ The peer key file, used by key derivation (agreement) operations. The peer key format; the default is B. The only value with effect is B; all others have become obsolete. -See L for details. +See L for details. =item B<-pubin> @@ -171,7 +171,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 L. +supported by L. =item B<-hexdump> diff --git a/doc/man1/openssl-req.pod.in b/doc/man1/openssl-req.pod.in index 9b3242d28a3..f778ec5cea0 100644 --- a/doc/man1/openssl-req.pod.in +++ b/doc/man1/openssl-req.pod.in @@ -72,7 +72,7 @@ Print out a usage message. =item B<-inform> B|B, B<-outform> B|B The input and formats; the default is B. -See L for details. +See L for details. The data is a PKCS#10 object. @@ -104,7 +104,7 @@ which supports both options for good reasons. The password source for the input and output file. For more information about the format of B -see L. +see L. =item B<-out> I @@ -190,7 +190,7 @@ accepts PKCS#8 format private keys for PEM format files. The format of the private key; the default is B. The only value with effect is B; all others have become obsolete. -See L for details. +See L for details. =item B<-keyout> I diff --git a/doc/man1/openssl-rsa.pod.in b/doc/man1/openssl-rsa.pod.in index 1eebef83ef5..1d98caabb64 100644 --- a/doc/man1/openssl-rsa.pod.in +++ b/doc/man1/openssl-rsa.pod.in @@ -62,12 +62,12 @@ Print out a usage message. The key input format; the default is B. The only value with effect is B; all others have become obsolete. -See L for details. +See L for details. =item B<-outform> B|B The key output format; the default is B. -See L for details. +See L for details. =item B<-traditional> @@ -84,7 +84,7 @@ prompted for. The password source for the input and output file. For more information about the format of B -see L. +see L. =item B<-out> I diff --git a/doc/man1/openssl-rsautl.pod.in b/doc/man1/openssl-rsautl.pod.in index fca0fdbf4c2..21d641aa27e 100644 --- a/doc/man1/openssl-rsautl.pod.in +++ b/doc/man1/openssl-rsautl.pod.in @@ -60,7 +60,7 @@ if this option is not specified. =item B<-passin> I The passphrase used in the output file. -See see L. +See see L. =item B<-rev> @@ -79,7 +79,7 @@ The input key, by default it should be an RSA private key. The key format; the default is B. The only value with effect is B; all others have become obsolete. -See L for details. +See L for details. =item B<-pubin> diff --git a/doc/man1/openssl-s_client.pod.in b/doc/man1/openssl-s_client.pod.in index 66fd0515910..e6fea3fa1e4 100644 --- a/doc/man1/openssl-s_client.pod.in +++ b/doc/man1/openssl-s_client.pod.in @@ -198,7 +198,7 @@ the network. Use with caution. The proxy password source, used with the B<-proxy_user> flag. For more information about the format of B -see L. +see L. =item B<-unix> I @@ -263,7 +263,7 @@ CRL file to use to check the server's certificate. =item B<-CRLform> B|B The CRL file format; the default is B. -See L for details. +See L for details. =item B<-crl_download> @@ -278,13 +278,13 @@ If not specified then the certificate file will be used to read also the key. The key format; the default is B. The only value with effect is B; all others have become obsolete. -See L for details. +See L for details. =item B<-pass> I the private key and certifiate file password source. For more information about the format of I -see L. +see L. =item B<-verify> I diff --git a/doc/man1/openssl-s_server.pod.in b/doc/man1/openssl-s_server.pod.in index 23693956a27..cb6a1378a0f 100644 --- a/doc/man1/openssl-s_server.pod.in +++ b/doc/man1/openssl-s_server.pod.in @@ -261,13 +261,13 @@ The private Key file to use for servername if not given via B<-cert2>. The key format; the default is B. The only value with effect is B; all others have become obsolete. -See L for details. +See L for details. =item B<-pass> I The private key and certificate file password source. For more information about the format of I, -see L. +see L. =item B<-dcert> I, B<-dkey> I|I @@ -296,13 +296,13 @@ This option has no effect and is retained for backward compatibility only. The format of the additional private key; the default is B. The only value with effect is B; all others have become obsolete. -See L. +See L. =item B<-dpass> I The passphrase for the additional private key and certificate. For more information about the format of I, -see L. +see L. =item B<-nbio_test> @@ -335,7 +335,7 @@ The CRL file to use. =item B<-CRLform> B|B The CRL file format; the default is B. -See L for details. +See L for details. =item B<-crl_download> diff --git a/doc/man1/openssl-sess_id.pod.in b/doc/man1/openssl-sess_id.pod.in index 6af88b4c382..92d7500f4f5 100644 --- a/doc/man1/openssl-sess_id.pod.in +++ b/doc/man1/openssl-sess_id.pod.in @@ -40,7 +40,7 @@ Print out a usage message. =item B<-inform> B|B, B<-outform> B|B|B The input and output formats; the default is PEM. -See L for details. +See L for details. For B output, the session ID and master key are reported in NSS "keylog" format. diff --git a/doc/man1/openssl-smime.pod.in b/doc/man1/openssl-smime.pod.in index 563340b1523..3c5859dc01f 100644 --- a/doc/man1/openssl-smime.pod.in +++ b/doc/man1/openssl-smime.pod.in @@ -117,19 +117,19 @@ format message that has been signed or verified. The input format of the PKCS#7 (S/MIME) structure (if one is being read); the default is B. -See L for details. +See L for details. =item B<-outform> B|B|B The output format of the PKCS#7 (S/MIME) structure (if one is being written); the default is B. -See L for details. +See L for details. =item B<-keyform> B|B|B|B The key format; the default is B. The only value with effect is B; all others have become obsolete. -See L for details. +See L for details. =item B<-stream>, B<-indef>, B<-noindef> @@ -270,7 +270,7 @@ multiple times to specify successive keys. =item B<-passin> I The private key password source. For more information about the format of I -see L. +see L. =item B<-to>, B<-from>, B<-subject> diff --git a/doc/man1/openssl-spkac.pod.in b/doc/man1/openssl-spkac.pod.in index 2a596ed3143..f0ddd5179d4 100644 --- a/doc/man1/openssl-spkac.pod.in +++ b/doc/man1/openssl-spkac.pod.in @@ -62,12 +62,12 @@ present. The key format; the default is B. The only value with effect is B; all others have become obsolete. -See L for details. +See L for details. =item B<-passin> I The input file password source. For more information about the format of I -see L. +see L. =item B<-challenge> I diff --git a/doc/man1/openssl-srp.pod.in b/doc/man1/openssl-srp.pod.in index 8a2730265fb..73e4e70f975 100644 --- a/doc/man1/openssl-srp.pod.in +++ b/doc/man1/openssl-srp.pod.in @@ -70,7 +70,7 @@ adding or modifying a user. The password source for the input and output file. For more information about the format of B -see L. +see L. {- $OpenSSL::safe::opt_engine_item -} diff --git a/doc/man1/openssl-storeutl.pod.in b/doc/man1/openssl-storeutl.pod.in index 404639e6fd6..80dc7e36c8f 100644 --- a/doc/man1/openssl-storeutl.pod.in +++ b/doc/man1/openssl-storeutl.pod.in @@ -55,7 +55,7 @@ this option prevents output of the PEM data. =item B<-passin> I the key password source. For more information about the format of I -see L. +see L. =item B<-text> diff --git a/doc/man1/openssl-x509.pod.in b/doc/man1/openssl-x509.pod.in index a3f7639284f..0c0fc7e4141 100644 --- a/doc/man1/openssl-x509.pod.in +++ b/doc/man1/openssl-x509.pod.in @@ -101,7 +101,7 @@ Print out a usage message. =item B<-inform> B|B The CSR input format; the default is B. -See L for details. +See L for details. The input is normally an X.509 certificate file of any format, but this can change if other options such as B<-req> are used. @@ -109,7 +109,7 @@ but this can change if other options such as B<-req> are used. B<-outform> B|B The output format; the default is B. -See L for details. +See L for details. =item B<-in> I @@ -382,7 +382,7 @@ Names and values of these options are algorithm-specific. The key and certificate file password source. For more information about the format of I -see L. +see L. =item B<-clrext> @@ -395,7 +395,7 @@ retained. The key format; the default is B. The only value with effect is B; all others have become obsolete. -See L for details. +See L for details. =item B<-CAform> B|B|B, @@ -406,7 +406,7 @@ This option has no effect and is retained for backward compatibility. The format for the CA key; the default is B. The only value with effect is B; all others have become obsolete. -See L for details. +See L for details. =item B<-days> I diff --git a/doc/man1/openssl.pod b/doc/man1/openssl.pod index 9daa13189ea..abb5d5e3e46 100644 --- a/doc/man1/openssl.pod +++ b/doc/man1/openssl.pod @@ -565,7 +565,7 @@ See the L manual page. =head2 Name Format Options -See the L manual page. +See the L manual page. =head2 TLS Version Options diff --git a/doc/perlvars.pm b/doc/perlvars.pm index c13e224197e..d4fbba9a64f 100644 --- a/doc/perlvars.pm +++ b/doc/perlvars.pm @@ -79,7 +79,7 @@ $OpenSSL::safe::opt_name_item = "" . "=item B<-nameopt> I