Update copyright year
[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<-genkey>]
19 [B<-verbose>]
20 [B<-quiet>]
21 {- $OpenSSL::safe::opt_r_synopsis -}
22 {- $OpenSSL::safe::opt_engine_synopsis -}{- $OpenSSL::safe::opt_provider_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>
41
42 The DSA parameters input format; unspecified by default.
43 See L<openssl-format-options(1)> for details.
44
45 =item B<-outform> B<DER>|B<PEM>
46
47 The DSA parameters output format; the default is B<PEM>.
48 See L<openssl-format-options(1)> for details.
49
50 Parameters are a sequence of B<ASN.1 INTEGER>s: B<p>, B<q>, and B<g>.
51 This is compatible with RFC 2459 B<DSS-Parms> structure.
52
53 =item B<-in> I<filename>
54
55 This specifies the input filename to read parameters from or standard input if
56 this option is not specified. If the I<numbits> parameter is included then
57 this option will be ignored.
58
59 =item B<-out> I<filename>
60
61 This specifies the output filename parameters to. Standard output is used
62 if this option is not present. The output filename should B<not> be the same
63 as the input filename.
64
65 =item B<-noout>
66
67 This option inhibits the output of the encoded version of the parameters.
68
69 =item B<-text>
70
71 This option prints out the DSA parameters in human readable form.
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 =item B<-quiet>
84
85 Print fewer details about the operations being performed, which may
86 be handy during batch scripts and pipelines.
87
88 {- $OpenSSL::safe::opt_r_item -}
89
90 {- $OpenSSL::safe::opt_engine_item -}
91
92 =item I<numbits>
93
94 This option specifies that a parameter set should be generated of size
95 I<numbits>. It must be the last option. If this option is included then
96 the input file (if any) is ignored.
97
98 {- $OpenSSL::safe::opt_provider_item -}
99
100 =back
101
102 =head1 SEE ALSO
103
104 L<openssl(1)>,
105 L<openssl-pkeyparam(1)>,
106 L<openssl-gendsa(1)>,
107 L<openssl-dsa(1)>,
108 L<openssl-genrsa(1)>,
109 L<openssl-rsa(1)>
110
111 =head1 HISTORY
112
113 The B<-engine> option was deprecated in OpenSSL 3.0.
114
115 The B<-C> option was removed in OpenSSL 3.0.
116
117 =head1 COPYRIGHT
118
119 Copyright 2000-2022 The OpenSSL Project Authors. All Rights Reserved.
120
121 Licensed under the Apache License 2.0 (the "License").  You may not use
122 this file except in compliance with the License.  You can obtain a copy
123 in the file LICENSE in the source distribution or at
124 L<https://www.openssl.org/source/license.html>.
125
126 =cut