openssl.pod: Fix openSSL options doc
[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 -}{- $OpenSSL::safe::opt_provider_synopsis -}
29 [I<paramfile>]
30
31 =for openssl ifdef engine
32
33 =head1 DESCRIPTION
34
35 This command generates a DSA private key from a DSA parameter file
36 (which will be typically generated by the L<openssl-dsaparam(1)> command).
37
38 =head1 OPTIONS
39
40 =over 4
41
42 =item B<-help>
43
44 Print out a usage message.
45
46 =item B<-out> I<filename>
47
48 Output the key to the specified file. If this argument is not specified then
49 standard output is used.
50
51 =item B<-passout> I<arg>
52
53 The passphrase used for the output file.
54 See L<openssl-passphrase-options(1)>.
55
56 =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>
57
58 These options encrypt the private key with specified
59 cipher before outputting it. A pass phrase is prompted for.
60 If none of these options is specified no encryption is used.
61
62 =item B<-verbose>
63
64 Print extra details about the operations being performed.
65
66 {- $OpenSSL::safe::opt_r_item -}
67
68 {- $OpenSSL::safe::opt_engine_item -}
69
70 =item I<paramfile>
71
72 The DSA parameter file to use. The parameters in this file determine
73 the size of the private key. DSA parameters can be generated and
74 examined using the L<openssl-dsaparam(1)> command.
75
76 {- $OpenSSL::safe::opt_provider_item -}
77
78 =back
79
80 =head1 NOTES
81
82 DSA key generation is little more than random number generation so it is
83 much quicker that RSA key generation for example.
84
85 =head1 SEE ALSO
86
87 L<openssl(1)>,
88 L<openssl-genpkey(1)>,
89 L<openssl-dsaparam(1)>,
90 L<openssl-dsa(1)>,
91 L<openssl-genrsa(1)>,
92 L<openssl-rsa(1)>
93
94 =head1 HISTORY
95
96 The B<-engine> option was deprecated in OpenSSL 3.0.
97
98 =head1 COPYRIGHT
99
100 Copyright 2000-2020 The OpenSSL Project Authors. All Rights Reserved.
101
102 Licensed under the Apache License 2.0 (the "License").  You may not use
103 this file except in compliance with the License.  You can obtain a copy
104 in the file LICENSE in the source distribution or at
105 L<https://www.openssl.org/source/license.html>.
106
107 =cut