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