APPS/{storeutl,gendsa}: give error on extra arguments, improve 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 [B<-quiet>]
28 {- $OpenSSL::safe::opt_r_synopsis -}
29 {- $OpenSSL::safe::opt_engine_synopsis -}{- $OpenSSL::safe::opt_provider_synopsis -}
30 [I<paramfile>]
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<-passout> I<arg>
51
52 The passphrase used for the output file.
53 See L<openssl-passphrase-options(1)>.
54
55 =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>
56
57 These options encrypt the private key with specified
58 cipher before outputting it. A pass phrase is prompted for.
59 If none of these options is specified no encryption is used.
60
61 Note that all options must be given before the I<paramfile> argument.
62
63 =item B<-verbose>
64
65 Print extra details about the operations being performed.
66
67 =item B<-quiet>
68
69 Print fewer details about the operations being performed, which may
70 be handy during batch scripts and pipelines.
71
72 {- $OpenSSL::safe::opt_r_item -}
73
74 {- $OpenSSL::safe::opt_engine_item -}
75
76 =item I<paramfile>
77
78 The DSA parameter file to use. The parameters in this file determine
79 the size of the private key. DSA parameters can be generated and
80 examined using the L<openssl-dsaparam(1)> command.
81
82 {- $OpenSSL::safe::opt_provider_item -}
83
84 =back
85
86 =head1 NOTES
87
88 DSA key generation is little more than random number generation so it is
89 much quicker that RSA key generation for example.
90
91 =head1 SEE ALSO
92
93 L<openssl(1)>,
94 L<openssl-genpkey(1)>,
95 L<openssl-dsaparam(1)>,
96 L<openssl-dsa(1)>,
97 L<openssl-genrsa(1)>,
98 L<openssl-rsa(1)>
99
100 =head1 HISTORY
101
102 The B<-engine> option was deprecated in OpenSSL 3.0.
103
104 =head1 COPYRIGHT
105
106 Copyright 2000-2022 The OpenSSL Project Authors. All Rights Reserved.
107
108 Licensed under the Apache License 2.0 (the "License").  You may not use
109 this file except in compliance with the License.  You can obtain a copy
110 in the file LICENSE in the source distribution or at
111 L<https://www.openssl.org/source/license.html>.
112
113 =cut