Commit 3dfda1a6 authored by Rich Salz's avatar Rich Salz
Browse files

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: default avatarRichard Levitte <levitte@openssl.org>
(Merged from https://github.com/openssl/openssl/pull/2076)
parent b9b5181d

doc/man1/CA.pl.pod

+13 −17
Original line number Diff line number Diff line
@@ -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

doc/man1/ca.pod

+1 −1
Original line number Diff line number Diff line
@@ -62,7 +62,7 @@ and their status. 


The options descriptions will be divided into each purpose.



=head1 COMMAND OPTIONS

=head1 OPTIONS



=over 4

doc/man1/ciphers.pod

+1 −1
Original line number Diff line number Diff line
@@ -28,7 +28,7 @@ The B<ciphers> command converts textual OpenSSL cipher lists into ordered 
SSL cipher preference lists. It can be used as a test tool to determine

the appropriate cipherlist.



=head1 COMMAND OPTIONS

=head1 OPTIONS



=over 4

doc/man1/cms.pod

+1 −1
Original line number Diff line number Diff line
@@ -104,7 +104,7 @@ B<openssl> B<cms> 
The B<cms> command handles S/MIME v3.1 mail. It can encrypt, decrypt, sign and

verify, compress and uncompress S/MIME messages.



=head1 COMMAND OPTIONS

=head1 OPTIONS



There are fourteen operation options that set the type of operation to be

performed. The meaning of the other options varies according to the operation

doc/man1/crl.pod

+1 −1
Original line number Diff line number Diff line
@@ -26,7 +26,7 @@ B<openssl> B<crl> 


The B<crl> command processes CRL files in DER or PEM format.



=head1 COMMAND OPTIONS

=head1 OPTIONS



=over 4