pkey: update command line tool examples in light of deprecations.
[openssl.git] / doc / man1 / CA.pl.pod
index 129bf3540795ae4989728e0ae8d49f079ed73315..db444d5683794ca82c26144a257954221ad4db8c 100644 (file)
@@ -48,18 +48,18 @@ Prints a usage message.
 
 Creates a new self signed certificate. The private key is written to the file
 F<newkey.pem> and the request written to the file F<newreq.pem>.
-This argument invokes L<openssl-req(1)> command.
+Invokes L<openssl-req(1)>.
 
 =item B<-newreq>
 
 Creates a new certificate request. The private key is written to the file
 F<newkey.pem> and the request written to the file F<newreq.pem>.
-Executes L<openssl-req(1)> command below the hood.
+Executes L<openssl-req(1)> under the hood.
 
 =item B<-newreq-nodes>
 
 Is like B<-newreq> except that the private key will not be encrypted.
-Uses L<openssl-req(1)> command.
+Uses L<openssl-req(1)>.
 
 =item B<-newca>
 
@@ -68,7 +68,7 @@ and B<-xsign> options). The user is prompted to enter the filename of the CA
 certificates (which should also contain the private key) or by hitting ENTER
 details of the CA will be prompted for. The relevant files and directories
 are created in a directory called F<demoCA> in the current directory.
-L<openssl-req(1)> and L<openssl-ca(1)> commands are get invoked.
+Uses L<openssl-req(1)> and L<openssl-ca(1)>.
 
 =item B<-pkcs12>
 
@@ -80,31 +80,31 @@ B<-sign> option. The PKCS#12 file can be imported directly into a browser.
 If there is an additional argument on the command line it will be used as the
 "friendly name" for the certificate (which is typically displayed in the browser
 list box), otherwise the name "My Certificate" is used.
-Delegates work to L<openssl-pkcs12(1)> command.
+Delegates work to L<openssl-pkcs12(1)>.
 
 =item B<-sign>, B<-signcert>, B<-xsign>
 
 Calls the L<openssl-ca(1)> command to sign a certificate request. It expects the
 request to be in the file F<newreq.pem>. The new certificate is written to the
 file F<newcert.pem> except in the case of the B<-xsign> option when it is
-written to standard output. Leverages L<openssl-ca(1)> command.
+written to standard output.
 
 =item B<-signCA>
 
 This option is the same as the B<-signreq> option except it uses the
 configuration file section B<v3_ca> and so makes the signed request a
 valid CA certificate. This is useful when creating intermediate CA from
-a root CA.  Extra params are passed on to L<openssl-ca(1)> command.
+a root CA.  Extra params are passed to L<openssl-ca(1)>.
 
 =item B<-signcert>
 
 This option is the same as B<-sign> except it expects a self signed certificate
 to be present in the file F<newreq.pem>.
-Extra params are passed on to L<openssl-x509(1)> and L<openssl-ca(1)> commands.
+Extra params are passed to L<openssl-x509(1)> and L<openssl-ca(1)>.
 
 =item B<-crl>
 
-Generate a CRL. Executes L<openssl-ca(1)> command.
+Generate a CRL. Executes L<openssl-ca(1)>.
 
 =item B<-revoke> I<certfile> [I<reason>]
 
@@ -112,22 +112,20 @@ Revoke the certificate contained in the specified B<certfile>. An optional
 reason may be specified, and must be one of: B<unspecified>,
 B<keyCompromise>, B<CACompromise>, B<affiliationChanged>, B<superseded>,
 B<cessationOfOperation>, B<certificateHold>, or B<removeFromCRL>.
-Leverages L<openssl-ca(1)> command.
+Leverages L<openssl-ca(1)>.
 
 =item B<-verify>
 
 Verifies certificates against the CA certificate for F<demoCA>. If no
 certificates are specified on the command line it tries to verify the file
-F<newcert.pem>.  Invokes L<openssl-verify(1)> command.
+F<newcert.pem>.  Invokes L<openssl-verify(1)>.
 
 =item B<-extra-req> | B<-extra-ca> | B<-extra-pkcs12> | B<-extra-x509> | B<-extra-verify> I<extra-params>
 
-The purpose of these parameters is to allow optional parameters to be supplied
-to L<openssl(1)> that this command executes. The B<-extra-cmd> are specific to
-the option being used and the L<openssl(1)> command getting invoked. For example
-when this command invokes L<openssl-req(1)> extra parameters can be passed on
-with the B<-extra-req> parameter. The
-L<openssl(1)> commands being invoked per option are documented below.
+For each option B<extra-I<cmd>>, pass I<extra-params> to the L<openssl(1)>
+sub-command with the same name as I<cmd>, if that sub-command is invoked.
+For example, if L<openssl-req(1)> is invoked, the I<extra-params> given with
+B<-extra-req> will be passed to it.
 Users should consult L<openssl(1)> command documentation for more information.
 
 =back
@@ -149,7 +147,7 @@ the request and finally create a PKCS#12 file containing it.
 =head1 DSA CERTIFICATES
 
 Although the B<CA.pl> creates RSA CAs and requests it is still possible to
-use it with DSA certificates and requests using the L<req(1)> command
+use it with DSA certificates and requests using the L<openssl-req(1)> command
 directly. The following example shows the steps that would typically be taken.
 
 Create some DSA parameters:
@@ -164,7 +162,8 @@ Create the CA directories and files:
 
  CA.pl -newca
 
-enter a filename (for example F<cacert.pem>) when prompted for the CA filename.
+enter a filename (for example, F<cacert.pem>) when prompted for the CA file
+name.
 
 Create a DSA certificate request and private key (a different set of parameters
 can optionally be created first):