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