Refactor -engine documentation
[openssl.git] / doc / man1 / openssl-dsaparam.pod.in
1 =pod
2 {- OpenSSL::safe::output_do_not_edit_headers(); -}
3
4 =head1 NAME
5
6 openssl-dsaparam - DSA parameter manipulation and generation
7
8 =head1 SYNOPSIS
9
10 B<openssl dsaparam>
11 [B<-help>]
12 [B<-inform> B<DER>|B<PEM>]
13 [B<-outform> B<DER>|B<PEM>]
14 [B<-in> I<filename>]
15 [B<-out> I<filename>]
16 [B<-noout>]
17 [B<-text>]
18 [B<-C>]
19 [B<-genkey>]
20 [B<-verbose>]
21 {- $OpenSSL::safe::opt_r_synopsis -}
22 {- $OpenSSL::safe::opt_engine_synopsis -}
23 [I<numbits>]
24
25 =head1 DESCRIPTION
26
27 This command is used to manipulate or generate DSA parameter files.
28
29 DSA parameter generation can be a slow process and as a result the same set of
30 DSA parameters is often used to generate several distinct keys.
31
32 =head1 OPTIONS
33
34 =over 4
35
36 =item B<-help>
37
38 Print out a usage message.
39
40 =item B<-inform> B<DER>|B<PEM>, B<-outform> B<DER>|B<PEM>
41
42 The input and formats; the default is B<PEM>.
43 See L<openssl(1)/Format Options> for details.
44
45 Parameters are a sequence of B<ASN.1 INTEGER>s: B<p>, B<q>, and B<g>.
46 This is compatible with RFC 2459 B<DSS-Parms> structure.
47
48 =item B<-in> I<filename>
49
50 This specifies the input filename to read parameters from or standard input if
51 this option is not specified. If the I<numbits> parameter is included then
52 this option will be ignored.
53
54 =item B<-out> I<filename>
55
56 This specifies the output filename parameters to. Standard output is used
57 if this option is not present. The output filename should B<not> be the same
58 as the input filename.
59
60 =item B<-noout>
61
62 This option inhibits the output of the encoded version of the parameters.
63
64 =item B<-text>
65
66 This option prints out the DSA parameters in human readable form.
67
68 =item B<-C>
69
70 This option converts the parameters into C code. The parameters can then
71 be loaded by calling the get_dsaXXX() function.
72
73 =item B<-genkey>
74
75 This option will generate a DSA either using the specified or generated
76 parameters.
77
78
79 =item B<-verbose>
80
81 Print extra details about the operations being performed.
82
83 {- $OpenSSL::safe::opt_r_item -}
84
85 {- $OpenSSL::safe::opt_engine_item -}
86
87 =item I<numbits>
88
89 This option specifies that a parameter set should be generated of size
90 I<numbits>. It must be the last option. If this option is included then
91 the input file (if any) is ignored.
92
93 =back
94
95 =head1 SEE ALSO
96
97 L<openssl(1)>,
98 L<openssl-gendsa(1)>,
99 L<openssl-dsa(1)>,
100 L<openssl-genrsa(1)>,
101 L<openssl-rsa(1)>
102
103 =head1 COPYRIGHT
104
105 Copyright 2000-2019 The OpenSSL Project Authors. All Rights Reserved.
106
107 Licensed under the Apache License 2.0 (the "License").  You may not use
108 this file except in compliance with the License.  You can obtain a copy
109 in the file LICENSE in the source distribution or at
110 L<https://www.openssl.org/source/license.html>.
111
112 =cut