Merge from 1.0.0-stable branch.

[openssl.git] / doc / apps / dsa.pod

diff --git a/doc/apps/dsa.pod b/doc/apps/dsa.pod
index 1235e5598beb33a651ebb9b27e87ac3e6e7ca247..ed06b8806d8c117ca16cec51f747d39609c1c862 100644 (file)
--- a/doc/apps/dsa.pod
+++ b/doc/apps/dsa.pod
@@ -10,11 +10,9 @@ B<openssl> B<dsa>
 [B<-inform PEM|DER>]
 [B<-outform PEM|DER>]
 [B<-in filename>]
-[B<-passin password>]
-[B<-envpassin var>]
+[B<-passin arg>]
 [B<-out filename>]
-[B<-passout password>]
-[B<-envpassout var>]
+[B<-passout arg>]
 [B<-des>]
 [B<-des3>]
 [B<-idea>]
@@ -23,6 +21,7 @@ B<openssl> B<dsa>
 [B<-modulus>]
 [B<-pubin>]
 [B<-pubout>]
+[B<-engine id>]
 
 =head1 DESCRIPTION
 
@@ -58,14 +57,10 @@ This specifies the input filename to read a key from or standard input if this
 option is not specified. If the key is encrypted a pass phrase will be
 prompted for.
 
-=item B<-passin password>
+=item B<-passin arg>
 
-the input file password. Since certain utilities like "ps" make the command line
-visible this option should be used with caution.
-
-=item B<-envpassin var>
-
-read the input file password from the environment variable B<var>.
+the input file password source. For more information about the format of B<arg>
+see the B<PASS PHRASE ARGUMENTS> section in L<openssl(1)|openssl(1)>.
 
 =item B<-out filename>
 
@@ -74,21 +69,17 @@ is not specified. If any encryption options are set then a pass phrase will be
 prompted for. The output filename should B<not> be the same as the input
 filename.
 
-=item B<-passout password>
-
-the output file password. Since certain utilities like "ps" make the command line
-visible this option should be used with caution.
-
-=item B<-envpassout var>
+=item B<-passout arg>
 
-read the output file password from the environment variable B<var>.
+the output file password source. For more information about the format of B<arg>
+see the B<PASS PHRASE ARGUMENTS> section in L<openssl(1)|openssl(1)>.
 
 =item B<-des|-des3|-idea>
 
 These options encrypt the private key with the DES, triple DES, or the 
 IDEA ciphers respectively before outputting it. A pass phrase is prompted for.
 If none of these options is specified the key is written in plain text. This
-means that using the B<rsa> utility to read in an encrypted key with no
+means that using the B<dsa> utility to read in an encrypted key with no
 encryption option can be used to remove the pass phrase from a key, or by
 setting the encryption options it can be use to add or change the pass phrase.
 These options can only be used with PEM format output files.
@@ -107,8 +98,8 @@ this option prints out the value of the public key component of the key.
 
 =item B<-pubin>
 
-by default a private key is input file with this option a public key is input
-instead.
+by default a private key is read from the input file: with this option a
+public key is read instead.
 
 =item B<-pubout>
 
@@ -116,6 +107,13 @@ by default a private key is output. With this option a public
 key will be output instead. This option is automatically set if the input is
 a public key.
 
+=item B<-engine id>
+
+specifying an engine (by it's unique B<id> string) will cause B<req>
+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.
+
 =back
 
 =head1 NOTES
@@ -125,30 +123,36 @@ The PEM private key format uses the header and footer lines:
  -----BEGIN DSA PRIVATE KEY-----
  -----END DSA PRIVATE KEY-----
 
+The PEM public key format uses the header and footer lines:
+
+ -----BEGIN PUBLIC KEY-----
+ -----END PUBLIC KEY-----
+
 =head1 EXAMPLES
 
 To remove the pass phrase on a DSA private key:
 
-C<openssl dsa -in key.pem -out keyout.pem>
+ openssl dsa -in key.pem -out keyout.pem
 
 To encrypt a private key using triple DES:
 
-C<openssl dsa -in key.pem -des3 -out keyout.pem>
+ openssl dsa -in key.pem -des3 -out keyout.pem
 
 To convert a private key from PEM to DER format: 
 
-C<openssl dsa -in key.pem -outform DER -out keyout.der>
+ openssl dsa -in key.pem -outform DER -out keyout.der
 
 To print out the components of a private key to standard output:
 
-C<openssl dsa -in key.pem -text -noout>
+ openssl dsa -in key.pem -text -noout
 
 To just output the public part of a private key:
 
-C<openssl dsa -in key.pem -pubout -out pubkey.pem>
+ openssl dsa -in key.pem -pubout -out pubkey.pem
 
 =head1 SEE ALSO
 
-dsaparam(1), gendsa(1), rsa(1), genrsa(1)
+L<dsaparam(1)|dsaparam(1)>, L<gendsa(1)|gendsa(1)>, L<rsa(1)|rsa(1)>,
+L<genrsa(1)|genrsa(1)>
 
 =cut