Commit manual pages after running 'man-update' and add new manual pages.
[dragonfly.git] / secure / lib / libcrypto / man / OPENSSL_config.3
1 .rn '' }`
2 ''' $RCSfile$$Revision$$Date$
3 '''
4 ''' $Log$
5 '''
6 .de Sh
7 .br
8 .if t .Sp
9 .ne 5
10 .PP
11 \fB\\$1\fR
12 .PP
13 ..
14 .de Sp
15 .if t .sp .5v
16 .if n .sp
17 ..
18 .de Ip
19 .br
20 .ie \\n(.$>=3 .ne \\$3
21 .el .ne 3
22 .IP "\\$1" \\$2
23 ..
24 .de Vb
25 .ft CW
26 .nf
27 .ne \\$1
28 ..
29 .de Ve
30 .ft R
31
32 .fi
33 ..
34 '''
35 '''
36 '''     Set up \*(-- to give an unbreakable dash;
37 '''     string Tr holds user defined translation string.
38 '''     Bell System Logo is used as a dummy character.
39 '''
40 .tr \(*W-|\(bv\*(Tr
41 .ie n \{\
42 .ds -- \(*W-
43 .ds PI pi
44 .if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
45 .if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch
46 .ds L" ""
47 .ds R" ""
48 '''   \*(M", \*(S", \*(N" and \*(T" are the equivalent of
49 '''   \*(L" and \*(R", except that they are used on ".xx" lines,
50 '''   such as .IP and .SH, which do another additional levels of
51 '''   double-quote interpretation
52 .ds M" """
53 .ds S" """
54 .ds N" """""
55 .ds T" """""
56 .ds L' '
57 .ds R' '
58 .ds M' '
59 .ds S' '
60 .ds N' '
61 .ds T' '
62 'br\}
63 .el\{\
64 .ds -- \(em\|
65 .tr \*(Tr
66 .ds L" ``
67 .ds R" ''
68 .ds M" ``
69 .ds S" ''
70 .ds N" ``
71 .ds T" ''
72 .ds L' `
73 .ds R' '
74 .ds M' `
75 .ds S' '
76 .ds N' `
77 .ds T' '
78 .ds PI \(*p
79 'br\}
80 .\"     If the F register is turned on, we'll generate
81 .\"     index entries out stderr for the following things:
82 .\"             TH      Title 
83 .\"             SH      Header
84 .\"             Sh      Subsection 
85 .\"             Ip      Item
86 .\"             X<>     Xref  (embedded
87 .\"     Of course, you have to process the output yourself
88 .\"     in some meaninful fashion.
89 .if \nF \{
90 .de IX
91 .tm Index:\\$1\t\\n%\t"\\$2"
92 ..
93 .nr % 0
94 .rr F
95 .\}
96 .TH OPENSSL_config 3 "0.9.7d" "2/Sep/2004" "OpenSSL"
97 .UC
98 .if n .hy 0
99 .if n .na
100 .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
101 .de CQ          \" put $1 in typewriter font
102 .ft CW
103 'if n "\c
104 'if t \\&\\$1\c
105 'if n \\&\\$1\c
106 'if n \&"
107 \\&\\$2 \\$3 \\$4 \\$5 \\$6 \\$7
108 '.ft R
109 ..
110 .\" @(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2
111 .       \" AM - accent mark definitions
112 .bd B 3
113 .       \" fudge factors for nroff and troff
114 .if n \{\
115 .       ds #H 0
116 .       ds #V .8m
117 .       ds #F .3m
118 .       ds #[ \f1
119 .       ds #] \fP
120 .\}
121 .if t \{\
122 .       ds #H ((1u-(\\\\n(.fu%2u))*.13m)
123 .       ds #V .6m
124 .       ds #F 0
125 .       ds #[ \&
126 .       ds #] \&
127 .\}
128 .       \" simple accents for nroff and troff
129 .if n \{\
130 .       ds ' \&
131 .       ds ` \&
132 .       ds ^ \&
133 .       ds , \&
134 .       ds ~ ~
135 .       ds ? ?
136 .       ds ! !
137 .       ds /
138 .       ds q
139 .\}
140 .if t \{\
141 .       ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
142 .       ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
143 .       ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
144 .       ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
145 .       ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
146 .       ds ? \s-2c\h'-\w'c'u*7/10'\u\h'\*(#H'\zi\d\s+2\h'\w'c'u*8/10'
147 .       ds ! \s-2\(or\s+2\h'-\w'\(or'u'\v'-.8m'.\v'.8m'
148 .       ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
149 .       ds q o\h'-\w'o'u*8/10'\s-4\v'.4m'\z\(*i\v'-.4m'\s+4\h'\w'o'u*8/10'
150 .\}
151 .       \" troff and (daisy-wheel) nroff accents
152 .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
153 .ds 8 \h'\*(#H'\(*b\h'-\*(#H'
154 .ds v \\k:\h'-(\\n(.wu*9/10-\*(#H)'\v'-\*(#V'\*(#[\s-4v\s0\v'\*(#V'\h'|\\n:u'\*(#]
155 .ds _ \\k:\h'-(\\n(.wu*9/10-\*(#H+(\*(#F*2/3))'\v'-.4m'\z\(hy\v'.4m'\h'|\\n:u'
156 .ds . \\k:\h'-(\\n(.wu*8/10)'\v'\*(#V*4/10'\z.\v'-\*(#V*4/10'\h'|\\n:u'
157 .ds 3 \*(#[\v'.2m'\s-2\&3\s0\v'-.2m'\*(#]
158 .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
159 .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
160 .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
161 .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
162 .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
163 .ds ae a\h'-(\w'a'u*4/10)'e
164 .ds Ae A\h'-(\w'A'u*4/10)'E
165 .ds oe o\h'-(\w'o'u*4/10)'e
166 .ds Oe O\h'-(\w'O'u*4/10)'E
167 .       \" corrections for vroff
168 .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
169 .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
170 .       \" for low resolution devices (crt and lpr)
171 .if \n(.H>23 .if \n(.V>19 \
172 \{\
173 .       ds : e
174 .       ds 8 ss
175 .       ds v \h'-1'\o'\(aa\(ga'
176 .       ds _ \h'-1'^
177 .       ds . \h'-1'.
178 .       ds 3 3
179 .       ds o a
180 .       ds d- d\h'-1'\(ga
181 .       ds D- D\h'-1'\(hy
182 .       ds th \o'bp'
183 .       ds Th \o'LP'
184 .       ds ae ae
185 .       ds Ae AE
186 .       ds oe oe
187 .       ds Oe OE
188 .\}
189 .rm #[ #] #H #V #F C
190 .SH "NAME"
191 OPENSSL_config, OPENSSL_no_config \- simple OpenSSL configuration functions
192 .SH "SYNOPSIS"
193 .PP
194 .Vb 1
195 \& #include <openssl/conf.h>
196 .Ve
197 .Vb 2
198 \& void OPENSSL_config(const char *config_name);
199 \& void OPENSSL_no_config(void);
200 .Ve
201 .SH "DESCRIPTION"
202 \fIOPENSSL_config()\fR configures OpenSSL using the standard \fBopenssl.cnf\fR
203 configuration file name using \fBconfig_name\fR. If \fBconfig_name\fR is NULL then
204 the default name \fBopenssl_conf\fR will be used. Any errors are ignored. Further
205 calls to \fIOPENSSL_config()\fR will have no effect. The configuration file format
206 is documented in the conf(5) manual page.
207 .PP
208 \fIOPENSSL_no_config()\fR disables configuration. If called before \fIOPENSSL_config()\fR
209 no configuration takes place.
210 .SH "NOTES"
211 It is \fBstrongly\fR recommended that \fBall\fR new applications call \fIOPENSSL_config()\fR
212 or the more sophisticated functions such as \fICONF_modules_load()\fR during
213 initialization (that is before starting any threads). By doing this
214 an application does not need to keep track of all configuration options
215 and some new functionality can be supported automatically.
216 .PP
217 It is also possible to automatically call \fIOPENSSL_config()\fR when an application
218 calls \fIOPENSSL_add_all_algorithms()\fR by compiling an application with the
219 preprocessor symbol \fBOPENSSL_LOAD_CONF\fR #define'd. In this way configuration
220 can be added without source changes.
221 .PP
222 The environment variable \fBOPENSSL_CONFIG\fR can be set to specify the location
223 of the configuration file.
224  
225 Currently ASN1 OBJECTs and ENGINE configuration can be performed future
226 versions of OpenSSL will add new configuration options.
227 .PP
228 There are several reasons why calling the OpenSSL configuration routines is
229 advisable. For example new ENGINE functionality was added to OpenSSL 0.9.7.
230 In OpenSSL 0.9.7 control functions can be supported by ENGINEs, this can be
231 used (among other things) to load dynamic ENGINEs from shared libraries (DSOs).
232 However very few applications currently support the control interface and so
233 very few can load and use dynamic ENGINEs. Equally in future more sophisticated
234 ENGINEs will require certain control operations to customize them. If an
235 application calls \fIOPENSSL_config()\fR it doesn't need to know or care about
236 ENGINE control operations because they can be performed by editing a
237 configuration file.
238 .PP
239 Applications should free up configuration at application closedown by calling
240 \fICONF_modules_free()\fR.
241 .SH "RESTRICTIONS"
242 The \fIOPENSSL_config()\fR function is designed to be a very simple \*(L"call it and
243 forget it\*(R" function. As a result its behaviour is somewhat limited. It ignores
244 all errors silently and it can only load from the standard configuration file
245 location for example.
246 .PP
247 It is however \fBmuch\fR better than nothing. Applications which need finer
248 control over their configuration functionality should use the configuration
249 functions such as \fICONF_load_modules()\fR directly.
250 .SH "RETURN VALUES"
251 Neither \fIOPENSSL_config()\fR nor \fIOPENSSL_no_config()\fR return a value.
252 .SH "SEE ALSO"
253 conf(5), CONF_load_modules_file(3),
254 the \fICONF_modules_free(3),CONF_modules_free(3)\fR manpage
255 .SH "HISTORY"
256 \fIOPENSSL_config()\fR and \fIOPENSSL_no_config()\fR first appeared in OpenSSL 0.9.7
257
258 .rn }` ''
259 .IX Title "OPENSSL_config 3"
260 .IX Name "OPENSSL_config, OPENSSL_no_config - simple OpenSSL configuration functions"
261
262 .IX Header "NAME"
263
264 .IX Header "SYNOPSIS"
265
266 .IX Header "DESCRIPTION"
267
268 .IX Header "NOTES"
269
270 .IX Header "RESTRICTIONS"
271
272 .IX Header "RETURN VALUES"
273
274 .IX Header "SEE ALSO"
275
276 .IX Header "HISTORY"
277