diff options
author | Rich Salz <rsalz@akamai.com> | 2019-10-12 17:45:56 -0400 |
---|---|---|
committer | Tomas Mraz <tmraz@fedoraproject.org> | 2019-10-31 14:19:29 +0100 |
commit | 9fcb9702fba8aa135945f96aefddf050a6f4f11d (patch) | |
tree | 5fa0e0061ca70c9b0678636ee68c713653e7dba8 /doc | |
parent | fb1ecf85c9f732e5827771ff243d7a70e06ce112 (diff) |
Infrastructure for templated doc in POD files
Use new doc-build capabilities
Add -i flag to dofile.
Add doc/man1 to SUBDIRS for the new templated doc files
Rewrite commit a397aca (merged from PR 10118) to use the doc-template stuff.
Put template references in common place
Template options and text come at the end of command-specific options:
opt_x, opt_trust, opt_r (in that order).
Refactor xchain options.
Do doc-nits after building generated sources.
Reviewed-by: Tomas Mraz <tmraz@fedoraproject.org>
Reviewed-by: Richard Levitte <levitte@openssl.org>
(Merged from https://github.com/openssl/openssl/pull/10159)
Diffstat (limited to 'doc')
-rw-r--r-- | doc/man1/build.info | 84 | ||||
-rw-r--r-- | doc/man1/openssl-ca.pod.in (renamed from doc/man1/openssl-ca.pod) | 14 | ||||
-rw-r--r-- | doc/man1/openssl-cms.pod.in (renamed from doc/man1/openssl-cms.pod) | 35 | ||||
-rw-r--r-- | doc/man1/openssl-crl.pod.in (renamed from doc/man1/openssl-crl.pod) | 14 | ||||
-rw-r--r-- | doc/man1/openssl-dgst.pod.in (renamed from doc/man1/openssl-dgst.pod) | 14 | ||||
-rw-r--r-- | doc/man1/openssl-dhparam.pod.in (renamed from doc/man1/openssl-dhparam.pod) | 14 | ||||
-rw-r--r-- | doc/man1/openssl-dsaparam.pod.in (renamed from doc/man1/openssl-dsaparam.pod) | 14 | ||||
-rw-r--r-- | doc/man1/openssl-ecparam.pod.in (renamed from doc/man1/openssl-ecparam.pod) | 14 | ||||
-rw-r--r-- | doc/man1/openssl-enc.pod.in (renamed from doc/man1/openssl-enc.pod) | 12 | ||||
-rw-r--r-- | doc/man1/openssl-gendsa.pod.in (renamed from doc/man1/openssl-gendsa.pod) | 14 | ||||
-rw-r--r-- | doc/man1/openssl-genrsa.pod.in (renamed from doc/man1/openssl-genrsa.pod) | 14 | ||||
-rw-r--r-- | doc/man1/openssl-ocsp.pod.in (renamed from doc/man1/openssl-ocsp.pod) | 16 | ||||
-rw-r--r-- | doc/man1/openssl-passwd.pod.in (renamed from doc/man1/openssl-passwd.pod) | 12 | ||||
-rw-r--r-- | doc/man1/openssl-pkcs12.pod.in (renamed from doc/man1/openssl-pkcs12.pod) | 25 | ||||
-rw-r--r-- | doc/man1/openssl-pkcs8.pod.in (renamed from doc/man1/openssl-pkcs8.pod) | 14 | ||||
-rw-r--r-- | doc/man1/openssl-pkeyutl.pod.in (renamed from doc/man1/openssl-pkeyutl.pod) | 14 | ||||
-rw-r--r-- | doc/man1/openssl-rand.pod.in (renamed from doc/man1/openssl-rand.pod) | 14 | ||||
-rw-r--r-- | doc/man1/openssl-req.pod.in (renamed from doc/man1/openssl-req.pod) | 14 | ||||
-rw-r--r-- | doc/man1/openssl-rsautl.pod.in (renamed from doc/man1/openssl-rsautl.pod) | 14 | ||||
-rw-r--r-- | doc/man1/openssl-s_client.pod.in (renamed from doc/man1/openssl-s_client.pod) | 64 | ||||
-rw-r--r-- | doc/man1/openssl-s_server.pod.in (renamed from doc/man1/openssl-s_server.pod) | 56 | ||||
-rw-r--r-- | doc/man1/openssl-s_time.pod.in (renamed from doc/man1/openssl-s_time.pod) | 16 | ||||
-rw-r--r-- | doc/man1/openssl-smime.pod.in (renamed from doc/man1/openssl-smime.pod) | 25 | ||||
-rw-r--r-- | doc/man1/openssl-speed.pod.in (renamed from doc/man1/openssl-speed.pod) | 14 | ||||
-rw-r--r-- | doc/man1/openssl-srp.pod.in (renamed from doc/man1/openssl-srp.pod) | 12 | ||||
-rw-r--r-- | doc/man1/openssl-ts.pod.in (renamed from doc/man1/openssl-ts.pod) | 14 | ||||
-rw-r--r-- | doc/man1/openssl-verify.pod.in (renamed from doc/man1/openssl-verify.pod) | 16 | ||||
-rw-r--r-- | doc/man1/openssl-x509.pod.in (renamed from doc/man1/openssl-x509.pod) | 14 | ||||
-rw-r--r-- | doc/man1/openssl.pod | 36 | ||||
-rw-r--r-- | doc/perlvars.pm | 129 |
30 files changed, 493 insertions, 269 deletions
diff --git a/doc/man1/build.info b/doc/man1/build.info new file mode 100644 index 0000000000..aed1f948d5 --- /dev/null +++ b/doc/man1/build.info @@ -0,0 +1,84 @@ + +DEPEND[]= \ + openssl-ca.pod \ + openssl-cms.pod \ + openssl-crl.pod \ + openssl-dgst.pod \ + openssl-dhparam.pod \ + openssl-dsaparam.pod \ + openssl-ecparam.pod \ + openssl-enc.pod \ + openssl-gendsa.pod \ + openssl-genrsa.pod \ + openssl-ocsp.pod \ + openssl-passwd.pod \ + openssl-pkcs12.pod \ + openssl-pkcs8.pod \ + openssl-pkeyutl.pod \ + openssl-rand.pod \ + openssl-req.pod \ + openssl-rsautl.pod \ + openssl-s_client.pod \ + openssl-s_server.pod \ + openssl-s_time.pod \ + openssl-smime.pod \ + openssl-speed.pod \ + openssl-srp.pod \ + openssl-ts.pod \ + openssl-verify.pod \ + openssl-x509.pod + +DEPEND[openssl-ca.pod]=../perlvars.pm +GENERATE[openssl-ca.pod]=openssl-ca.pod.in +DEPEND[openssl-cms.pod]=../perlvars.pm +GENERATE[openssl-cms.pod]=openssl-cms.pod.in +DEPEND[openssl-crl.pod]=../perlvars.pm +GENERATE[openssl-crl.pod]=openssl-crl.pod.in +DEPEND[openssl-dgst.pod]=../perlvars.pm +GENERATE[openssl-dgst.pod]=openssl-dgst.pod.in +DEPEND[openssl-dhparam.pod]=../perlvars.pm +GENERATE[openssl-dhparam.pod]=openssl-dhparam.pod.in +DEPEND[openssl-dsaparam.pod]=../perlvars.pm +GENERATE[openssl-dsaparam.pod]=openssl-dsaparam.pod.in +DEPEND[openssl-ecparam.pod]=../perlvars.pm +GENERATE[openssl-ecparam.pod]=openssl-ecparam.pod.in +DEPEND[openssl-enc.pod]=../perlvars.pm +GENERATE[openssl-enc.pod]=openssl-enc.pod.in +DEPEND[openssl-gendsa.pod]=../perlvars.pm +GENERATE[openssl-gendsa.pod]=openssl-gendsa.pod.in +DEPEND[openssl-genrsa.pod]=../perlvars.pm +GENERATE[openssl-genrsa.pod]=openssl-genrsa.pod.in +DEPEND[openssl-ocsp.pod]=../perlvars.pm +GENERATE[openssl-ocsp.pod]=openssl-ocsp.pod.in +DEPEND[openssl-passwd.pod]=../perlvars.pm +GENERATE[openssl-passwd.pod]=openssl-passwd.pod.in +DEPEND[openssl-pkcs8.pod]=../perlvars.pm +GENERATE[openssl-pkcs8.pod]=openssl-pkcs8.pod.in +DEPEND[openssl-pkcs12.pod]=../perlvars.pm +GENERATE[openssl-pkcs12.pod]=openssl-pkcs12.pod.in +DEPEND[openssl-pkeyutl.pod]=../perlvars.pm +GENERATE[openssl-pkeyutl.pod]=openssl-pkeyutl.pod.in +DEPEND[openssl-rand.pod]=../perlvars.pm +GENERATE[openssl-rand.pod]=openssl-rand.pod.in +DEPEND[openssl-req.pod]=../perlvars.pm +GENERATE[openssl-req.pod]=openssl-req.pod.in +DEPEND[openssl-rsautl.pod]=../perlvars.pm +GENERATE[openssl-rsautl.pod]=openssl-rsautl.pod.in +DEPEND[openssl-s_client.pod]=../perlvars.pm +GENERATE[openssl-s_client.pod]=openssl-s_client.pod.in +DEPEND[openssl-s_server.pod]=../perlvars.pm +GENERATE[openssl-s_server.pod]=openssl-s_server.pod.in +DEPEND[openssl-s_time.pod]=../perlvars.pm +GENERATE[openssl-s_time.pod]=openssl-s_time.pod.in +DEPEND[openssl-smime.pod]=../perlvars.pm +GENERATE[openssl-smime.pod]=openssl-smime.pod.in +DEPEND[openssl-speed.pod]=../perlvars.pm +GENERATE[openssl-speed.pod]=openssl-speed.pod.in +DEPEND[openssl-srp.pod]=../perlvars.pm +GENERATE[openssl-srp.pod]=openssl-srp.pod.in +DEPEND[openssl-ts.pod]=../perlvars.pm +GENERATE[openssl-ts.pod]=openssl-ts.pod.in +DEPEND[openssl-verify.pod]=../perlvars.pm +GENERATE[openssl-verify.pod]=openssl-verify.pod.in +DEPEND[openssl-x509.pod]=../perlvars.pm +GENERATE[openssl-x509.pod]=openssl-x509.pod.in diff --git a/doc/man1/openssl-ca.pod b/doc/man1/openssl-ca.pod.in index e3d6c7b17c..81d1186d23 100644 --- a/doc/man1/openssl-ca.pod +++ b/doc/man1/openssl-ca.pod.in @@ -1,5 +1,10 @@ =pod +=begin comment +{- join("\n", @autowarntext) -} + +=end comment + =head1 NAME openssl-ca - sample minimal CA application @@ -54,10 +59,9 @@ B<openssl> B<ca> [B<-create_serial>] [B<-rand_serial>] [B<-multivalue-rdn>] -[B<-rand> I<files>] -[B<-writerand> I<file>] [B<-sm2-id> I<string>] [B<-sm2-hex-id> I<hex-string>] +{- $OpenSSL::safe::opt_r_synopsis -} =for openssl ifdef engine sm2-id sm2-hex-id @@ -294,10 +298,6 @@ C</DC=org/DC=OpenSSL/DC=users/UID=123456+CN=John Doe> If B<-multi-rdn> is not used then the UID value is C<123456+CN=John Doe>. -=item B<-rand> I<files>, B<-writerand> I<file> - -See L<openssl(1)/Random State Options> for more information. - =item B<-sm2-id> I<string> Specify the ID string to use when verifying an SM2 certificate. The ID string is @@ -308,6 +308,8 @@ required by the SM2 signature algorithm for signing and verification. Specify a binary ID string to use when signing or verifying using an SM2 certificate. The argument for this option is string of hexadecimal digits. +{- $OpenSSL::safe::opt_r_item -} + =back =head1 CRL OPTIONS diff --git a/doc/man1/openssl-cms.pod b/doc/man1/openssl-cms.pod.in index ff601cc548..3d8bcd792e 100644 --- a/doc/man1/openssl-cms.pod +++ b/doc/man1/openssl-cms.pod.in @@ -1,5 +1,10 @@ =pod +=begin comment +{- join("\n", @autowarntext) -} + +=end comment + =head1 NAME openssl-cms - CMS utility @@ -38,10 +43,6 @@ B<openssl> B<cms> [B<-text>] [B<-noout>] [B<-print>] -[B<-CAfile> I<file>] -[B<-CApath> I<dir>] -[B<-no-CAfile>] -[B<-no-CApath>] [B<-attime> I<timestamp>] [B<-check_ss_sig>] [B<-crl_check>] @@ -97,11 +98,11 @@ B<openssl> B<cms> [B<-inkey> I<file>] [B<-keyopt> I<name>:I<parameter>] [B<-passin> I<arg>] -[B<-rand> I<files>] -[B<-writerand> I<file>] [B<-to> I<addr>] [B<-from> I<addr>] [B<-subject> I<subj>] +{- $OpenSSL::safe::opt_trust_synopsis -} +{- $OpenSSL::safe::opt_r_synopsis -} [I<cert.pem> ...] =for openssl ifdef des-wrap engine @@ -286,10 +287,6 @@ structure is being checked. For the B<-cmsout> operation print out all fields of the CMS structure. This is mainly useful for testing purposes. -=item B<-CAfile> I<file>, B<-no-CAfile>, B<-CApath> I<dir>, B<-no-CApath> - -See L<openssl(1)/Trusted Certificate Options> for more information. - =item B<-md> I<digest> Digest algorithm to use when signing or resigning. If not present then the @@ -462,15 +459,6 @@ or to modify default parameters for ECDH. The private key password source. For more information about the format of B<arg> see L<openssl(1)/Pass Phrase Options>. -=item B<-rand> I<files>, B<-writerand> I<file> - -See L<openssl(1)/Random State Options> for more information. - -=item I<cert.pem> ... - -One or more certificates of message recipients: used when encrypting -a message. - =item B<-to>, B<-from>, B<-subject> The relevant mail headers. These are included outside the signed @@ -489,6 +477,15 @@ B<-verify_ip>, B<-verify_name>, B<-x509_strict> Set various certificate chain validation options. See the L<openssl-verify(1)> manual page for details. +{- $OpenSSL::safe::opt_trust_item -} + +{- $OpenSSL::safe::opt_r_item -} + +=item I<cert.pem> ... + +One or more certificates of message recipients: used when encrypting +a message. + =back =head1 NOTES diff --git a/doc/man1/openssl-crl.pod b/doc/man1/openssl-crl.pod.in index 911af026bb..7441de446c 100644 --- a/doc/man1/openssl-crl.pod +++ b/doc/man1/openssl-crl.pod.in @@ -1,5 +1,10 @@ =pod +=begin comment +{- join("\n", @autowarntext) -} + +=end comment + =head1 NAME openssl-crl - CRL utility @@ -20,10 +25,7 @@ B<openssl> B<crl> [B<-issuer>] [B<-lastupdate>] [B<-nextupdate>] -[B<-CAfile> I<file>] -[B<-CApath> I<dir>] -[B<-no-CAfile>] -[B<-no-CApath>] +{- $OpenSSL::safe::opt_trust_synopsis -} =for openssl ifdef hash_old @@ -94,9 +96,7 @@ Output the lastUpdate field. Output the nextUpdate field. -=item B<-CAfile> I<file>, B<-no-CAfile>, B<-CApath> I<dir>, B<-no-CApath> - -See L<openssl(1)/Trusted Certificate Options> for more information. +{- $OpenSSL::safe::opt_trust_item -} =back diff --git a/doc/man1/openssl-dgst.pod b/doc/man1/openssl-dgst.pod.in index 7ea47480bc..75187ffe2c 100644 --- a/doc/man1/openssl-dgst.pod +++ b/doc/man1/openssl-dgst.pod.in @@ -1,5 +1,10 @@ =pod +=begin comment +{- join("\n", @autowarntext) -} + +=end comment + =head1 NAME openssl-dgst - perform digest operations @@ -25,10 +30,9 @@ B<openssl> B<dgst>|I<digest> [B<-sigopt> I<nm>:I<v>] [B<-hmac> I<key>] [B<-fips-fingerprint>] -[B<-rand> I<files>] -[B<-writerand> I<file>] [B<-engine> I<id>] [B<-engine_impl>] +{- $OpenSSL::safe::opt_r_synopsis -} [I<file> ...] =head1 DESCRIPTION @@ -164,10 +168,6 @@ for example exactly 32 chars for gost-mac. The L<openssl-mac(1)> command should be preferred to using this command line option. -=item B<-rand> I<files>, B<-writerand> I<file> - -See L<openssl(1)/Random State Options> for more information. - =item B<-fips-fingerprint> Compute HMAC using a specific key for certain OpenSSL-FIPS operations. @@ -184,6 +184,8 @@ specified. When used with the B<-engine> option, it specifies to also use engine I<id> for digest operations. +{- $OpenSSL::safe::opt_r_item -} + =item I<file> ... File or files to digest. If no files are specified then standard input is diff --git a/doc/man1/openssl-dhparam.pod b/doc/man1/openssl-dhparam.pod.in index cbd52b00fb..9ae5006b1e 100644 --- a/doc/man1/openssl-dhparam.pod +++ b/doc/man1/openssl-dhparam.pod.in @@ -1,5 +1,10 @@ =pod +=begin comment +{- join("\n", @autowarntext) -} + +=end comment + =head1 NAME openssl-dhparam - DH parameter manipulation and generation @@ -20,9 +25,8 @@ B<openssl dhparam> [B<-2>] [B<-3>] [B<-5>] -[B<-rand> I<files>] -[B<-writerand> I<file>] [B<-engine> I<id>] +{- $OpenSSL::safe::opt_r_synopsis -} [I<numbits>] =for openssl ifdef dsaparam engine @@ -80,10 +84,6 @@ input file is ignored and parameters are generated instead. If not present but I<numbits> is present, parameters are generated with the default generator 2. -=item B<-rand> I<files>, B<-writerand> I<file> - -See L<openssl(1)/Random State Options> for more information. - =item I<numbits> This option specifies that a parameter set should be generated of size @@ -113,6 +113,8 @@ to attempt to obtain a functional reference to the specified engine, thus initialising it if needed. The engine will then be set as the default for all available algorithms. +{- $OpenSSL::safe::opt_r_item -} + =back =head1 WARNINGS diff --git a/doc/man1/openssl-dsaparam.pod b/doc/man1/openssl-dsaparam.pod.in index 0c85ca0d1d..d23f48fd5b 100644 --- a/doc/man1/openssl-dsaparam.pod +++ b/doc/man1/openssl-dsaparam.pod.in @@ -1,5 +1,10 @@ =pod +=begin comment +{- join("\n", @autowarntext) -} + +=end comment + =head1 NAME openssl-dsaparam - DSA parameter manipulation and generation @@ -15,11 +20,10 @@ B<openssl dsaparam> [B<-noout>] [B<-text>] [B<-C>] -[B<-rand> I<files>] -[B<-writerand> I<file>] [B<-genkey>] [B<-engine> I<id>] [B<-verbose>] +{- $OpenSSL::safe::opt_r_synopsis -} [I<numbits>] =head1 DESCRIPTION @@ -75,10 +79,6 @@ be loaded by calling the get_dsaXXX() function. This option will generate a DSA either using the specified or generated parameters. -=item B<-rand> I<files>, B<-writerand> I<file> - -See L<openssl(1)/Random State Options> for more information. - =item B<-engine> I<id> Specifying an engine (by its unique I<id> string) will cause this command @@ -90,6 +90,8 @@ for all available algorithms. Print extra details about the operations being performed. +{- $OpenSSL::safe::opt_r_item -} + =item I<numbits> This option specifies that a parameter set should be generated of size diff --git a/doc/man1/openssl-ecparam.pod b/doc/man1/openssl-ecparam.pod.in index c761980953..1e262a4a81 100644 --- a/doc/man1/openssl-ecparam.pod +++ b/doc/man1/openssl-ecparam.pod.in @@ -1,5 +1,10 @@ =pod +=begin comment +{- join("\n", @autowarntext) -} + +=end comment + =head1 NAME openssl-ecparam - EC parameter manipulation and generation @@ -22,10 +27,9 @@ B<openssl ecparam> [B<-conv_form> I<arg>] [B<-param_enc> I<arg>] [B<-no_seed>] -[B<-rand> I<files>] -[B<-writerand> I<file>] [B<-genkey>] [B<-engine> I<id>] +{- $OpenSSL::safe::opt_r_synopsis -} =for openssl ifdef engine @@ -122,10 +126,6 @@ is included in the ECParameters structure (see RFC 3279). This option will generate an EC private key using the specified parameters. -=item B<-rand> I<files>, B<-writerand> I<file> - -See L<openssl(1)/Random State Options> for more information. - =item B<-engine> I<id> Specifying an engine (by its unique I<id> string) will cause B<ecparam> @@ -133,6 +133,8 @@ to attempt to obtain a functional reference to the specified engine, thus initialising it if needed. The engine will then be set as the default for all available algorithms. +{- $OpenSSL::safe::opt_r_item -} + =back =head1 EXAMPLES diff --git a/doc/man1/openssl-enc.pod b/doc/man1/openssl-enc.pod.in index ced97e743e..842eb2a183 100644 --- a/doc/man1/openssl-enc.pod +++ b/doc/man1/openssl-enc.pod.in @@ -1,5 +1,10 @@ =pod +=begin comment +{- join("\n", @autowarntext) -} + +=end comment + =head1 NAME openssl-enc - symmetric cipher routines @@ -36,9 +41,8 @@ B<openssl> B<enc>|I<cipher> [B<-nopad>] [B<-debug>] [B<-none>] -[B<-rand> I<files>] -[B<-writerand> I<file>] [B<-engine> I<id>] +{- $OpenSSL::safe::opt_r_synopsis -} =for openssl ifdef z engine @@ -190,9 +194,7 @@ or zlib-dynamic option. Use NULL cipher (no encryption or decryption of input). -=item B<-rand> I<files>, B<-writerand> I<file> - -See L<openssl(1)/Random State Options> for more information. +{- $OpenSSL::safe::opt_r_item -} =back diff --git a/doc/man1/openssl-gendsa.pod b/doc/man1/openssl-gendsa.pod.in index 451a3c4835..d92f0dd7a8 100644 --- a/doc/man1/openssl-gendsa.pod +++ b/doc/man1/openssl-gendsa.pod.in @@ -1,5 +1,10 @@ =pod +=begin comment +{- join("\n", @autowarntext) -} + +=end comment + =head1 NAME openssl-gendsa - generate a DSA private key from a set of parameters @@ -21,10 +26,9 @@ B<openssl> B<gendsa> [B<-des>] [B<-des3>] [B<-idea>] -[B<-rand> I<files>] -[B<-writerand> I<file>] [B<-engine> I<id>] [B<-verbose>] +{- $OpenSSL::safe::opt_r_synopsis -} [I<paramfile>] =for openssl ifdef engine @@ -53,10 +57,6 @@ These options encrypt the private key with specified cipher before outputting it. A pass phrase is prompted for. If none of these options is specified no encryption is used. -=item B<-rand> I<files>, B<-writerand> I<file> - -See L<openssl(1)/Random State Options> for more information. - =item B<-engine> I<id> Specifying an engine (by its unique I<id> string) will cause this command @@ -74,6 +74,8 @@ The DSA parameter file to use. The parameters in this file determine the size of the private key. DSA parameters can be generated and examined using the L<openssl-dsaparam(1)> command. +{- $OpenSSL::safe::opt_r_item -} + =back =head1 NOTES diff --git a/doc/man1/openssl-genrsa.pod b/doc/man1/openssl-genrsa.pod.in index d04c8eeb19..6239cd8bee 100644 --- a/doc/man1/openssl-genrsa.pod +++ b/doc/man1/openssl-genrsa.pod.in @@ -1,5 +1,10 @@ =pod +=begin comment +{- join("\n", @autowarntext) -} + +=end comment + =head1 NAME openssl-genrsa - generate an RSA private key @@ -23,11 +28,10 @@ B<openssl> B<genrsa> [B<-des3>] [B<-idea>] [B<-f4>|B<-3>] -[B<-rand> I<files>] -[B<-writerand> I<file>] [B<-engine> I<id>] [B<-primes> I<num>] [B<-verbose>] +{- $OpenSSL::safe::opt_r_synopsis -} [B<numbits>] =for openssl ifdef engine @@ -65,10 +69,6 @@ for if it is not supplied via the B<-passout> argument. The public exponent to use, either 65537 or 3. The default is 65537. -=item B<-rand> I<files>, B<-writerand> I<file> - -See L<openssl(1)/Random State Options> for more information. - =item B<-engine> I<id> Specifying an engine (by its unique I<id> string) will cause this command @@ -87,6 +87,8 @@ RSA key, which is defined in RFC 8017. Print extra details about the operations being performed. +{- $OpenSSL::safe::opt_r_item -} + =item B<numbits> The size of the private key to generate in bits. This must be the last option diff --git a/doc/man1/openssl-ocsp.pod b/doc/man1/openssl-ocsp.pod.in index 6fc077506f..a3358e724a 100644 --- a/doc/man1/openssl-ocsp.pod +++ b/doc/man1/openssl-ocsp.pod.in @@ -1,5 +1,10 @@ =pod +=begin comment +{- join("\n", @autowarntext) -} + +=end comment + =head1 NAME openssl-ocsp - Online Certificate Status Protocol utility @@ -30,10 +35,6 @@ B<openssl> B<ocsp> [B<-multi> I<process-count>] [B<-header>] [B<-path>] -[B<-CApath> I<dir>] -[B<-CAfile> I<file>] -[B<-no-CAfile>] -[B<-no-CApath>] [B<-attime> I<timestamp>] [B<-check_ss_sig>] [B<-crl_check>] @@ -89,6 +90,7 @@ B<openssl> B<ocsp> [B<-nrequest> I<n>] [B<-rcid> I<digest>] [B<-I<digest>>] +{- $OpenSSL::safe::opt_trust_synopsis -} =for openssl ifdef multi @@ -207,10 +209,6 @@ each child is willing to wait for the client's OCSP response. This option is available on POSIX systems (that support the fork() and other required unix system-calls). -=item B<-CAfile> I<file>, B<-no-CAfile>, B<-CApath> I<dir>, B<-no-CApath> - -See L<openssl(1)/Trusted Certificate Options> for more information. - =item B<-attime>, B<-check_ss_sig>, B<-crl_check>, B<-crl_check_all>, B<-explicit_policy>, B<-extended_crl>, B<-ignore_critical>, B<-inhibit_any>, B<-inhibit_map>, B<-no_alt_chains>, B<-no_check_time>, B<-partial_chain>, B<-policy>, @@ -310,6 +308,8 @@ OCSP request. Any digest supported by the OpenSSL B<dgst> command can be used. The default is SHA-1. This option may be used multiple times to specify the digest used by subsequent certificate identifiers. +{- $OpenSSL::safe::opt_trust_item -} + =back =head2 OCSP Server Options diff --git a/doc/man1/openssl-passwd.pod b/doc/man1/openssl-passwd.pod.in index e7502ae332..2fa8e97f13 100644 --- a/doc/man1/openssl-passwd.pod +++ b/doc/man1/openssl-passwd.pod.in @@ -1,5 +1,10 @@ =pod +=begin comment +{- join("\n", @autowarntext) -} + +=end comment + =head1 NAME openssl-passwd - compute password hashes @@ -20,8 +25,7 @@ B<openssl passwd> [B<-noverify>] [B<-quiet>] [B<-table>] -[B<-rand> I<files>] -[B<-writerand> I<file>] +{- $OpenSSL::safe::opt_r_synopsis -} {I<password>} =for openssl ifdef crypt @@ -93,9 +97,7 @@ Don't output warnings when passwords given at the command line are truncated. In the output list, prepend the cleartext password and a TAB character to each password hash. -=item B<-rand> I<files>, B<-writerand> I<file> - -See L<openssl(1)/Random State Options> for more information. +{- $OpenSSL::safe::opt_r_item -} =back diff --git a/doc/man1/openssl-pkcs12.pod b/doc/man1/openssl-pkcs12.pod.in index 5742549891..09b75111db 100644 --- a/doc/man1/openssl-pkcs12.pod +++ b/doc/man1/openssl-pkcs12.pod.in @@ -1,5 +1,10 @@ =pod +=begin comment +{- join("\n", @autowarntext) -} + +=end comment + =head1 NAME openssl-pkcs12 - PKCS#12 file utility @@ -36,13 +41,9 @@ B<openssl> B<pkcs12> [B<-password> I<arg>] [B<-passin> I<arg>] [B<-passout> I<arg>] -[B<-rand> I<files>] -[B<-writerand> I<file>] -[B<-CAfile> I<file>] -[B<-CApath> I<dir>] -[B<-no-CAfile>] -[B<-no-CApath>] [B<-CSP> I<name>] +{- $OpenSSL::safe::opt_trust_synopsis -} +{- $OpenSSL::safe::opt_r_synopsis -} =for openssl ifdef engine @@ -263,18 +264,14 @@ to be needed to use MAC iterations counts but they are now used by default. Don't attempt to provide the MAC integrity. -=item B<-rand> I<files>, B<-writerand> I<file> - -See L<openssl(1)/Random State Options> for more information. - -=item B<-CAfile> I<file>, B<-no-CAfile>, B<-CApath> I<dir>, B<-no-CApath> - -See L<openssl(1)/Trusted Certificate Options> for more information. - =item B<-CSP> I<name> Write I<name> as a Microsoft CSP name. +{- $OpenSSL::safe::opt_trust_item -} + +{- $OpenSSL::safe::opt_r_item -} + =back =head1 NOTES diff --git a/doc/man1/openssl-pkcs8.pod b/doc/man1/openssl-pkcs8.pod.in index f923c986a0..c9d8b9c5a8 100644 --- a/doc/man1/openssl-pkcs8.pod +++ b/doc/man1/openssl-pkcs8.pod.in @@ -1,5 +1,10 @@ =pod +=begin comment +{- join("\n", @autowarntext) -} + +=end comment + =head1 NAME openssl-pkcs8 - PKCS#8 format private key conversion tool @@ -17,8 +22,6 @@ B<openssl> B<pkcs8> [B<-passout> I<arg>] [B<-iter> I<count>] [B<-noiter>] -[B<-rand> I<files>] -[B<-writerand> I<file>] [B<-nocrypt>] [B<-traditional>] [B<-v2> I<alg>] @@ -29,6 +32,7 @@ B<openssl> B<pkcs8> [B<-scrypt_N> I<N>] [B<-scrypt_r> I<r>] [B<-scrypt_p> I<p>] +{- $OpenSSL::safe::opt_r_synopsis -} =for openssl ifdef engine scrypt scrypt_N scrypt_r scrypt_p @@ -113,10 +117,6 @@ This option does not encrypt private keys at all and should only be used when absolutely necessary. Certain software such as some versions of Java code signing software used unencrypted private keys. -=item B<-rand> I<files>, B<-writerand> I<file> - -See L<openssl(1)/Random State Options> for more information. - =item B<-v2> I<alg> This option sets the PKCS#5 v2.0 algorithm. @@ -158,6 +158,8 @@ B<-scrypt_p> and B<-v2> options. Sets the scrypt I<N>, I<r> or I<p> parameters. +{- $OpenSSL::safe::opt_r_item -} + =back =head1 NOTES diff --git a/doc/man1/openssl-pkeyutl.pod b/doc/man1/openssl-pkeyutl.pod.in index 13519399fa..61cf3cb9ef 100644 --- a/doc/man1/openssl-pkeyutl.pod +++ b/doc/man1/openssl-pkeyutl.pod.in @@ -1,5 +1,10 @@ =pod +=begin comment +{- join("\n", @autowarntext) -} + +=end comment + =head1 NAME openssl-pkeyutl - public key algorithm utility @@ -33,10 +38,9 @@ B<openssl> B<pkeyutl> [B<-pkeyopt_passin> I<opt>[:I<passarg>]] [B<-hexdump>] [B<-asn1parse>] -[B<-rand> I<files>] -[B<-writerand> I<file>] [B<-engine> I<id>] [B<-engine_impl>] +{- $OpenSSL::safe::opt_r_synopsis -} |