Fixed a bunch of typos in the docs
[openssl.git] / doc / apps / gendsa.pod
1 =pod
2
3 =head1 NAME
4
5 gendsa - generate a DSA private key from a set of parameters
6
7 =head1 SYNOPSIS
8
9 B<openssl> B<gendsa>
10 [B<-help>]
11 [B<-out filename>]
12 [B<-aes128>]
13 [B<-aes192>]
14 [B<-aes256>]
15 [B<-camellia128>]
16 [B<-camellia192>]
17 [B<-camellia256>]
18 [B<-des>]
19 [B<-des3>]
20 [B<-idea>]
21 [B<-rand file(s)>]
22 [B<-engine id>]
23 [B<paramfile>]
24
25 =head1 DESCRIPTION
26
27 The B<gendsa> command generates a DSA private key from a DSA parameter file
28 (which will be typically generated by the B<openssl dsaparam> command).
29
30 =head1 OPTIONS
31
32 =over 4
33
34 =item B<-help>
35
36 Print out a usage message.
37
38 =item B<-out filename>
39
40 Output the key to the specified file. If this argument is not specified then
41 standard output is used.
42
43 =item B<-aes128|-aes192|-aes256|-camellia128|-camellia192|-camellia256|-des|-des3|-idea>
44
45 These options encrypt the private key with specified
46 cipher before outputting it. A pass phrase is prompted for.
47 If none of these options is specified no encryption is used.
48
49 =item B<-rand file(s)>
50
51 a file or files containing random data used to seed the random number
52 generator, or an EGD socket (see L<RAND_egd(3)>).
53 Multiple files can be specified separated by an OS-dependent character.
54 The separator is B<;> for MS-Windows, B<,> for OpenVMS, and B<:> for
55 all others.
56
57 =item B<-engine id>
58
59 specifying an engine (by its unique B<id> string) will cause B<gendsa>
60 to attempt to obtain a functional reference to the specified engine,
61 thus initialising it if needed. The engine will then be set as the default
62 for all available algorithms.
63
64 =item B<paramfile>
65
66 This option specifies the DSA parameter file to use. The parameters in this
67 file determine the size of the private key. DSA parameters can be generated
68 and examined using the B<openssl dsaparam> command.
69
70 =back
71
72 =head1 NOTES
73
74 DSA key generation is little more than random number generation so it is
75 much quicker that RSA key generation for example.
76
77 =head1 SEE ALSO
78
79 L<dsaparam(1)>, L<dsa(1)>, L<genrsa(1)>,
80 L<rsa(1)>
81
82 =cut