add internal doc files actually belonging to CMP contribution chunk 6
[openssl.git] / doc / man1 / openssl-gendsa.pod.in
1 =pod
2 {- OpenSSL::safe::output_do_not_edit_headers(); -}
3
4 =head1 NAME
5
6 openssl-gendsa - generate a DSA private key from a set of parameters
7
8 =head1 SYNOPSIS
9
10 B<openssl> B<gendsa>
11 [B<-help>]
12 [B<-out> I<filename>]
13 [B<-passout> I<arg>]
14 [B<-aes128>]
15 [B<-aes192>]
16 [B<-aes256>]
17 [B<-aria128>]
18 [B<-aria192>]
19 [B<-aria256>]
20 [B<-camellia128>]
21 [B<-camellia192>]
22 [B<-camellia256>]
23 [B<-des>]
24 [B<-des3>]
25 [B<-idea>]
26 [B<-verbose>]
27 {- $OpenSSL::safe::opt_r_synopsis -}
28 {- $OpenSSL::safe::opt_engine_synopsis -}
29 [I<paramfile>]
30
31 =for openssl ifdef engine
32
33 =head1 DESCRIPTION
34
35 This command has been deprecated.
36 The L<openssl-genpkey(1)> command should be used instead.
37
38 This command generates a DSA private key from a DSA parameter file
39 (which will be typically generated by the L<openssl-dsaparam(1)> command).
40
41 =head1 OPTIONS
42
43 =over 4
44
45 =item B<-help>
46
47 Print out a usage message.
48
49 =item B<-out> I<filename>
50
51 Output the key to the specified file. If this argument is not specified then
52 standard output is used.
53
54 =item B<-passout> I<arg>
55
56 The passphrase used for the output file.
57 See L<openssl(1)/Pass Phrase Options>.
58
59 =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>
60
61 These options encrypt the private key with specified
62 cipher before outputting it. A pass phrase is prompted for.
63 If none of these options is specified no encryption is used.
64
65 =item B<-verbose>
66
67 Print extra details about the operations being performed.
68
69 {- $OpenSSL::safe::opt_r_item -}
70
71 {- $OpenSSL::safe::opt_engine_item -}
72
73 =item I<paramfile>
74
75 The DSA parameter file to use. The parameters in this file determine
76 the size of the private key. DSA parameters can be generated and
77 examined using the L<openssl-dsaparam(1)> command.
78
79 =back
80
81 =head1 NOTES
82
83 DSA key generation is little more than random number generation so it is
84 much quicker that RSA key generation for example.
85
86 =head1 SEE ALSO
87
88 L<openssl(1)>,
89 L<openssl-genpkey(1)>,
90 L<openssl-dsaparam(1)>,
91 L<openssl-dsa(1)>,
92 L<openssl-genrsa(1)>,
93 L<openssl-rsa(1)>
94
95 =head1 HISTORY
96
97 This command was deprecated in OpenSSL 3.0.
98
99 =head1 COPYRIGHT
100
101 Copyright 2000-2019 The OpenSSL Project Authors. All Rights Reserved.
102
103 Licensed under the Apache License 2.0 (the "License").  You may not use
104 this file except in compliance with the License.  You can obtain a copy
105 in the file LICENSE in the source distribution or at
106 L<https://www.openssl.org/source/license.html>.
107
108 =cut