Use a function to generate do-not-edit comment
[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<-engine> I<id>]
21 [B<-verbose>]
22 {- $OpenSSL::safe::opt_r_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 =item B<-engine> I<id>
79
80 Specifying an engine (by its unique I<id> string) will cause this command
81 to attempt to obtain a functional reference to the specified engine,
82 thus initialising it if needed. The engine will then be set as the default
83 for all available algorithms.
84
85 =item B<-verbose>
86
87 Print extra details about the operations being performed.
88
89 {- $OpenSSL::safe::opt_r_item -}
90
91 =item I<numbits>
92
93 This option specifies that a parameter set should be generated of size
94 I<numbits>. It must be the last option. If this option is included then
95 the input file (if any) is ignored.
96
97 =back
98
99 =head1 SEE ALSO
100
101 L<openssl(1)>,
102 L<openssl-gendsa(1)>,
103 L<openssl-dsa(1)>,
104 L<openssl-genrsa(1)>,
105 L<openssl-rsa(1)>
106
107 =head1 COPYRIGHT
108
109 Copyright 2000-2019 The OpenSSL Project Authors. All Rights Reserved.
110
111 Licensed under the Apache License 2.0 (the "License").  You may not use
112 this file except in compliance with the License.  You can obtain a copy
113 in the file LICENSE in the source distribution or at
114 L<https://www.openssl.org/source/license.html>.
115
116 =cut