Remove building with NOCRYPTO option
[minix.git] / crypto / external / bsd / openssl / lib / libcrypto / man / openssl_dsaparam.1
blobb1477f222a10b18e9ee3f5078070c28e0fe2027e
1 .\"     $NetBSD: openssl_dsaparam.1,v 1.14 2015/06/12 17:01:14 christos Exp $
2 .\"
3 .\" Automatically generated by Pod::Man 2.28 (Pod::Simple 3.28)
4 .\"
5 .\" Standard preamble:
6 .\" ========================================================================
7 .de Sp \" Vertical space (when we can't use .PP)
8 .if t .sp .5v
9 .if n .sp
11 .de Vb \" Begin verbatim text
12 .ft CW
13 .nf
14 .ne \\$1
16 .de Ve \" End verbatim text
17 .ft R
18 .fi
20 .\" Set up some character translations and predefined strings.  \*(-- will
21 .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
22 .\" double quote, and \*(R" will give a right double quote.  \*(C+ will
23 .\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
24 .\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
25 .\" nothing in troff, for use with C<>.
26 .tr \(*W-
27 .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
28 .ie n \{\
29 .    ds -- \(*W-
30 .    ds PI pi
31 .    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
32 .    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
33 .    ds L" ""
34 .    ds R" ""
35 .    ds C` ""
36 .    ds C' ""
37 'br\}
38 .el\{\
39 .    ds -- \|\(em\|
40 .    ds PI \(*p
41 .    ds L" ``
42 .    ds R" ''
43 .    ds C`
44 .    ds C'
45 'br\}
46 .\"
47 .\" Escape single quotes in literal strings from groff's Unicode transform.
48 .ie \n(.g .ds Aq \(aq
49 .el       .ds Aq '
50 .\"
51 .\" If the F register is turned on, we'll generate index entries on stderr for
52 .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
53 .\" entries marked with X<> in POD.  Of course, you'll have to process the
54 .\" output yourself in some meaningful fashion.
55 .\"
56 .\" Avoid warning from groff about undefined register 'F'.
57 .de IX
59 .nr rF 0
60 .if \n(.g .if rF .nr rF 1
61 .if (\n(rF:(\n(.g==0)) \{
62 .    if \nF \{
63 .        de IX
64 .        tm Index:\\$1\t\\n%\t"\\$2"
66 .        if !\nF==2 \{
67 .            nr % 0
68 .            nr F 2
69 .        \}
70 .    \}
71 .\}
72 .rr rF
73 .\"
74 .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
75 .\" Fear.  Run.  Save yourself.  No user-serviceable parts.
76 .    \" fudge factors for nroff and troff
77 .if n \{\
78 .    ds #H 0
79 .    ds #V .8m
80 .    ds #F .3m
81 .    ds #[ \f1
82 .    ds #] \fP
83 .\}
84 .if t \{\
85 .    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
86 .    ds #V .6m
87 .    ds #F 0
88 .    ds #[ \&
89 .    ds #] \&
90 .\}
91 .    \" simple accents for nroff and troff
92 .if n \{\
93 .    ds ' \&
94 .    ds ` \&
95 .    ds ^ \&
96 .    ds , \&
97 .    ds ~ ~
98 .    ds /
99 .\}
100 .if t \{\
101 .    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
102 .    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
103 .    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
104 .    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
105 .    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
106 .    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
108 .    \" troff and (daisy-wheel) nroff accents
109 .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
110 .ds 8 \h'\*(#H'\(*b\h'-\*(#H'
111 .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
112 .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
113 .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
114 .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
115 .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
116 .ds ae a\h'-(\w'a'u*4/10)'e
117 .ds Ae A\h'-(\w'A'u*4/10)'E
118 .    \" corrections for vroff
119 .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
120 .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
121 .    \" for low resolution devices (crt and lpr)
122 .if \n(.H>23 .if \n(.V>19 \
124 .    ds : e
125 .    ds 8 ss
126 .    ds o a
127 .    ds d- d\h'-1'\(ga
128 .    ds D- D\h'-1'\(hy
129 .    ds th \o'bp'
130 .    ds Th \o'LP'
131 .    ds ae ae
132 .    ds Ae AE
134 .rm #[ #] #H #V #F C
135 .\" ========================================================================
137 .IX Title "DSAPARAM 1"
138 .TH DSAPARAM 1 "2009-07-19" "1.0.1n" "OpenSSL"
139 .\" For nroff, turn off justification.  Always turn off hyphenation; it makes
140 .\" way too many mistakes in technical documents.
141 .if n .ad l
143 .SH "NAME"
144 dsaparam \- DSA parameter manipulation and generation
145 .SH "LIBRARY"
146 libcrypto, -lcrypto
147 .SH "SYNOPSIS"
148 .IX Header "SYNOPSIS"
149 \&\fBopenssl dsaparam\fR
150 [\fB\-inform DER|PEM\fR]
151 [\fB\-outform DER|PEM\fR]
152 [\fB\-in filename\fR]
153 [\fB\-out filename\fR]
154 [\fB\-noout\fR]
155 [\fB\-text\fR]
156 [\fB\-C\fR]
157 [\fB\-rand file(s)\fR]
158 [\fB\-genkey\fR]
159 [\fB\-engine id\fR]
160 [\fBnumbits\fR]
161 .SH "DESCRIPTION"
162 .IX Header "DESCRIPTION"
163 This command is used to manipulate or generate \s-1DSA\s0 parameter files.
164 .SH "OPTIONS"
165 .IX Header "OPTIONS"
166 .IP "\fB\-inform DER|PEM\fR" 4
167 .IX Item "-inform DER|PEM"
168 This specifies the input format. The \fB\s-1DER\s0\fR option uses an \s-1ASN1 DER\s0 encoded
169 form compatible with \s-1RFC2459 \s0(\s-1PKIX\s0) DSS-Parms that is a \s-1SEQUENCE\s0 consisting
170 of p, q and g respectively. The \s-1PEM\s0 form is the default format: it consists
171 of the \fB\s-1DER\s0\fR format base64 encoded with additional header and footer lines.
172 .IP "\fB\-outform DER|PEM\fR" 4
173 .IX Item "-outform DER|PEM"
174 This specifies the output format, the options have the same meaning as the
175 \&\fB\-inform\fR option.
176 .IP "\fB\-in filename\fR" 4
177 .IX Item "-in filename"
178 This specifies the input filename to read parameters from or standard input if
179 this option is not specified. If the \fBnumbits\fR parameter is included then
180 this option will be ignored.
181 .IP "\fB\-out filename\fR" 4
182 .IX Item "-out filename"
183 This specifies the output filename parameters to. Standard output is used
184 if this option is not present. The output filename should \fBnot\fR be the same
185 as the input filename.
186 .IP "\fB\-noout\fR" 4
187 .IX Item "-noout"
188 this option inhibits the output of the encoded version of the parameters.
189 .IP "\fB\-text\fR" 4
190 .IX Item "-text"
191 this option prints out the \s-1DSA\s0 parameters in human readable form.
192 .IP "\fB\-C\fR" 4
193 .IX Item "-C"
194 this option converts the parameters into C code. The parameters can then
195 be loaded by calling the \fB\f(BIget_dsaXXX()\fB\fR function.
196 .IP "\fB\-genkey\fR" 4
197 .IX Item "-genkey"
198 this option will generate a \s-1DSA\s0 either using the specified or generated
199 parameters.
200 .IP "\fB\-rand file(s)\fR" 4
201 .IX Item "-rand file(s)"
202 a file or files containing random data used to seed the random number
203 generator, or an \s-1EGD\s0 socket (see \fIRAND_egd\fR\|(3)).
204 Multiple files can be specified separated by a OS-dependent character.
205 The separator is \fB;\fR for MS-Windows, \fB,\fR for OpenVMS, and \fB:\fR for
206 all others.
207 .IP "\fBnumbits\fR" 4
208 .IX Item "numbits"
209 this option specifies that a parameter set should be generated of size
210 \&\fBnumbits\fR. It must be the last option. If this option is included then
211 the input file (if any) is ignored.
212 .IP "\fB\-engine id\fR" 4
213 .IX Item "-engine id"
214 specifying an engine (by its unique \fBid\fR string) will cause \fBdsaparam\fR
215 to attempt to obtain a functional reference to the specified engine,
216 thus initialising it if needed. The engine will then be set as the default
217 for all available algorithms.
218 .SH "NOTES"
219 .IX Header "NOTES"
220 \&\s-1PEM\s0 format \s-1DSA\s0 parameters use the header and footer lines:
222 .Vb 2
223 \& \-\-\-\-\-BEGIN DSA PARAMETERS\-\-\-\-\-
224 \& \-\-\-\-\-END DSA PARAMETERS\-\-\-\-\-
227 \&\s-1DSA\s0 parameter generation is a slow process and as a result the same set of
228 \&\s-1DSA\s0 parameters is often used to generate several distinct keys.
229 .SH "SEE ALSO"
230 .IX Header "SEE ALSO"
231 \&\fIopenssl_gendsa\fR\|(1), \fIopenssl_dsa\fR\|(1), \fIopenssl_genrsa\fR\|(1),
232 \&\fIopenssl_rsa\fR\|(1)