diff options
| author | Rich Salz <rsalz@openssl.org> | 2016-12-12 11:14:40 -0500 |
|---|---|---|
| committer | Rich Salz <rsalz@openssl.org> | 2016-12-13 12:12:35 -0500 |
| commit | 3dfda1a6363c0cf4efee94754a36c2d86be190c3 (patch) | |
| tree | eb6ccd6b25de2244c3d01cf49bf683563cca1a4c /doc/man1/CA.pl.pod | |
| parent | b9b5181dd2f52ff0560a33b116396cdae5e48048 (diff) | |
Fix various doc nits.
find-doc-nits warns if you don't give a "what to do flag"
Don't use regexps for section names, just strings: More consistency.
Rename "COMMAND OPTIONS" to OPTIONS.
Fix a couple of other nit-level things.
Reviewed-by: Richard Levitte <levitte@openssl.org>
(Merged from https://github.com/openssl/openssl/pull/2076)
Diffstat (limited to 'doc/man1/CA.pl.pod')
| -rw-r--r-- | doc/man1/CA.pl.pod | 30 |
1 files changed, 13 insertions, 17 deletions
diff --git a/doc/man1/CA.pl.pod b/doc/man1/CA.pl.pod index 9d760c9a45..727cce12c7 100644 --- a/doc/man1/CA.pl.pod +++ b/doc/man1/CA.pl.pod @@ -29,28 +29,14 @@ B<CA.pl> B<-verify> [B<-extra-verify> extra-params] B<certfile>... B<CA.pl> B<-revoke> [B<-extra-ca> extra-params] B<certfile> [B<reason>] +=head1 DESCRIPTION + The B<CA.pl> script is a perl script that supplies the relevant command line arguments to the B<openssl> command for some common certificate operations. It is intended to simplify the process of certificate creation and management by the use of some simple options. -=head1 COMMON OPTIONS - -=over 4 - -=item B<-extra-req> | B<-extra-ca> | B<-extra-pkcs12> | B<-extra-x509> | B<-extra-verify> <extra-params> - -The purpose of these parameters is to allow optional parameters to be supplied -to B<openssl> that this command executes. The B<-extra-cmd> are specific to the -option being used and the B<openssl> command getting invoked. For example -when this command invokes B<openssl req> extra parameters can be passed on -with the B<-extra-req> parameter. The -B<openssl> commands being invoked per option are documented below. -Users should consult B<openssl> command documentation for more information. - -=back - -=head1 COMMAND OPTIONS +=head1 OPTIONS =over 4 @@ -134,6 +120,16 @@ verifies certificates against the CA certificate for "demoCA". If no certificate are specified on the command line it tries to verify the file "newcert.pem". Invokes B<openssl verify> command. +=item B<-extra-req> | B<-extra-ca> | B<-extra-pkcs12> | B<-extra-x509> | B<-extra-verify> <extra-params> + +The purpose of these parameters is to allow optional parameters to be supplied +to B<openssl> that this command executes. The B<-extra-cmd> are specific to the +option being used and the B<openssl> command getting invoked. For example +when this command invokes B<openssl req> extra parameters can be passed on +with the B<-extra-req> parameter. The +B<openssl> commands being invoked per option are documented below. +Users should consult B<openssl> command documentation for more information. + =back =head1 EXAMPLES |