Replace '=for comment ifdef' with '=for openssl'
[openssl.git] / doc / man1 / openssl-gendsa.pod
1 =pod
2
3 =head1 NAME
4
5 openssl-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> I<filename>]
12 [B<-aes128>]
13 [B<-aes192>]
14 [B<-aes256>]
15 [B<-aria128>]
16 [B<-aria192>]
17 [B<-aria256>]
18 [B<-camellia128>]
19 [B<-camellia192>]
20 [B<-camellia256>]
21 [B<-des>]
22 [B<-des3>]
23 [B<-idea>]
24 [B<-rand> I<files>]
25 [B<-writerand> I<file>]
26 [B<-engine> I<id>]
27 [B<-verbose>]
28 [I<paramfile>]
29
30 =for openssl ifdef engine
31
32 =head1 DESCRIPTION
33
34 This command generates a DSA private key from a DSA parameter file
35 (which will be typically generated by the L<openssl-dsaparam(1)> command).
36
37 =head1 OPTIONS
38
39 =over 4
40
41 =item B<-help>
42
43 Print out a usage message.
44
45 =item B<-out> I<filename>
46
47 Output the key to the specified file. If this argument is not specified then
48 standard output is used.
49
50 =item B<-aes128>, B<-aes192>, B<-aes256>, B<-aria128>, B<-aria192>, B<-aria256>, B<-camellia128>, B<-camellia192>, B<-camellia256>, B<-des>, B<-des3>, B<-idea>
51
52 These options encrypt the private key with specified
53 cipher before outputting it. A pass phrase is prompted for.
54 If none of these options is specified no encryption is used.
55
56 =item B<-rand> I<files>
57
58 The files containing random data used to seed the random number generator.
59 Multiple files can be specified separated by an OS-dependent character.
60 The separator is B<;> for MS-Windows, B<,> for OpenVMS, and B<:> for
61 all others.
62
63 =item B<-writerand> I<file>
64
65 Writes random data to the specified I<file> upon exit.
66 This can be used with a subsequent B<-rand> flag.
67
68 =item B<-engine> I<id>
69
70 Specifying an engine (by its unique I<id> string) will cause this command
71 to attempt to obtain a functional reference to the specified engine,
72 thus initialising it if needed. The engine will then be set as the default
73 for all available algorithms.
74
75 =item B<-verbose>
76
77 Print extra details about the operations being performed.
78
79 =item I<paramfile>
80
81 The DSA parameter file to use. The parameters in this file determine
82 the size of the private key. DSA parameters can be generated and
83 examined using the L<openssl-dsaparam(1)> command.
84
85 =back
86
87 =head1 NOTES
88
89 DSA key generation is little more than random number generation so it is
90 much quicker that RSA key generation for example.
91
92 =head1 SEE ALSO
93
94 L<openssl(1)>,
95 L<openssl-dsaparam(1)>,
96 L<openssl-dsa(1)>,
97 L<openssl-genrsa(1)>,
98 L<openssl-rsa(1)>
99
100 =head1 COPYRIGHT
101
102 Copyright 2000-2019 The OpenSSL Project Authors. All Rights Reserved.
103
104 Licensed under the Apache License 2.0 (the "License").  You may not use
105 this file except in compliance with the License.  You can obtain a copy
106 in the file LICENSE in the source distribution or at
107 L<https://www.openssl.org/source/license.html>.
108
109 =cut