RT1832: Fix PKCS7_verify return value

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

diff --git a/doc/apps/genrsa.pod b/doc/apps/genrsa.pod
index fe3c5b43e5b537a6859a16c5fd7833e71ca83a20..cb03d09b95eb64d553d69de64af26dfab4f9d022 100644 (file)
--- a/doc/apps/genrsa.pod
+++ b/doc/apps/genrsa.pod
@@ -8,14 +8,26 @@ genrsa - generate an RSA private key
 
 B<openssl> B<genrsa>
 [B<-out filename>]
-[B<-passout password>]
-[B<-envpassout var>]
+[B<-passout arg>]
+[B<-aes128>]
+[B<-aes128>]
+[B<-aes192>]
+[B<-aes256>]
+[B<-camellia128>]
+[B<-camellia192>]
+[B<-camellia256>]
+[B<-aes192>]
+[B<-aes256>]
+[B<-camellia128>]
+[B<-camellia192>]
+[B<-camellia256>]
 [B<-des>]
 [B<-des3>]
 [B<-idea>]
 [B<-f4>]
 [B<-3>]
 [B<-rand file(s)>]
+[B<-engine id>]
 [B<numbits>]
 
 =head1 DESCRIPTION
@@ -31,21 +43,17 @@ The B<genrsa> command generates an RSA private key.
 the output filename. If this argument is not specified then standard output is
 used.  
 
-=item B<-passout password>
+=item B<-passout arg>
 
-the output file password. Since certain utilities like "ps" make the command line
-visible this option should be used with caution.
+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<-envpassout var>
+=item B<-aes128|-aes192|-aes256|-camellia128|-camellia192|-camellia256|-des|-des3|-idea>
 
-read the output file password from the environment variable B<var>.
-
-=item B<-des|-des3|-idea>
-
-These options encrypt the private key with the DES, triple DES, or the 
-IDEA ciphers respectively before outputting it. If none of these options is
+These options encrypt the private key with specified
+cipher before outputting it. If none of these options is
 specified no encryption is used. If encryption is used a pass phrase is prompted
-for if it is not supplied via the B<-passout> or B<-envpassout> arguments.
+for if it is not supplied via the B<-passout> argument.
 
 =item B<-F4|-3>
 
@@ -54,9 +62,17 @@ the public exponent to use, either 65537 or 3. The default is 65537.
 =item B<-rand file(s)>
 
 a file or files containing random data used to seed the random number
-generator. Multiple files can be specified separated by a OS-dependent
-character.  For MS-Windows, the separator is B<;>.  For OpenVMS, it's
-B<,>.  For all others, it's B<:>.
+generator, or an EGD socket (see L<RAND_egd(3)|RAND_egd(3)>).
+Multiple files can be specified separated by a OS-dependent character.
+The separator is B<;> for MS-Windows, B<,> for OpenVMS, and B<:> for
+all others.
+
+=item B<-engine id>
+
+specifying an engine (by its unique B<id> string) will cause B<genrsa>
+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.
 
 =item B<numbits>
 
@@ -69,9 +85,10 @@ specified. The default is 512.
 
 RSA private key generation essentially involves the generation of two prime
 numbers. When generating a private key various symbols will be output to
-indicate the progress of the generation. A B<.> represents each number tested.
-A B<+> means a number has passed a single primality test. A newline means that
-the number has passed all the prime tests (currently set to 5 single tests).
+indicate the progress of the generation. A B<.> represents each number which
+has passed an initial sieve test, B<+> means a number has passed a single
+round of the Miller-Rabin primality test. A newline means that the number has
+passed all the prime tests (the actual number depends on the key size).
 
 Because key generation is a random process the time taken to generate a key
 may vary somewhat.
@@ -86,3 +103,6 @@ be much larger (typically 1024 bits).
 =head1 SEE ALSO
 
 L<gendsa(1)|gendsa(1)>
+
+=cut
+