doc: remove deprecation notes for apps that are staying.
[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 {- $OpenSSL::safe::opt_provider_synopsis -}
24 [I<numbits>]
25
26 =head1 DESCRIPTION
27
28 This command is used to manipulate or generate DSA parameter files.
29
30 DSA parameter generation can be a slow process and as a result the same set of
31 DSA parameters is often used to generate several distinct keys.
32
33 =head1 OPTIONS
34
35 =over 4
36
37 =item B<-help>
38
39 Print out a usage message.
40
41 =item B<-inform> B<DER>|B<PEM>, B<-outform> B<DER>|B<PEM>
42
43 The input and formats; the default is B<PEM>.
44 See L<openssl(1)/Format Options> for details.
45
46 Parameters are a sequence of B<ASN.1 INTEGER>s: B<p>, B<q>, and B<g>.
47 This is compatible with RFC 2459 B<DSS-Parms> structure.
48
49 =item B<-in> I<filename>
50
51 This specifies the input filename to read parameters from or standard input if
52 this option is not specified. If the I<numbits> parameter is included then
53 this option will be ignored.
54
55 =item B<-out> I<filename>
56
57 This specifies the output filename parameters to. Standard output is used
58 if this option is not present. The output filename should B<not> be the same
59 as the input filename.
60
61 =item B<-noout>
62
63 This option inhibits the output of the encoded version of the parameters.
64
65 =item B<-text>
66
67 This option prints out the DSA parameters in human readable form.
68
69 =item B<-C>
70
71 This option converts the parameters into C code. The parameters can then
72 be loaded by calling the get_dsaXXX() function.
73
74 =item B<-genkey>
75
76 This option will generate a DSA either using the specified or generated
77 parameters.
78
79
80 =item B<-verbose>
81
82 Print extra details about the operations being performed.
83
84 {- $OpenSSL::safe::opt_r_item -}
85
86 {- $OpenSSL::safe::opt_engine_item -}
87
88 =item I<numbits>
89
90 This option specifies that a parameter set should be generated of size
91 I<numbits>. It must be the last option. If this option is included then
92 the input file (if any) is ignored.
93
94 {- $OpenSSL::safe::opt_provider_item -}
95
96 =back
97
98 =head1 SEE ALSO
99
100 L<openssl(1)>,
101 L<openssl-pkeyparam(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-2020 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