Update build for OpenSSL-0.9.8j upgrade.
[dragonfly.git] / secure / lib / libcrypto / man / CONF_modules_load_file.3
CommitLineData
e257b235 1.\" Automatically generated by Pod::Man 2.16 (Pod::Simple 3.05)
8b0cefbb
JR
2.\"
3.\" Standard preamble:
4.\" ========================================================================
5.de Sh \" Subsection heading
74dab6c2
JR
6.br
7.if t .Sp
8.ne 5
9.PP
10\fB\\$1\fR
11.PP
12..
8b0cefbb 13.de Sp \" Vertical space (when we can't use .PP)
74dab6c2
JR
14.if t .sp .5v
15.if n .sp
16..
8b0cefbb 17.de Vb \" Begin verbatim text
74dab6c2
JR
18.ft CW
19.nf
20.ne \\$1
21..
8b0cefbb 22.de Ve \" End verbatim text
74dab6c2 23.ft R
74dab6c2
JR
24.fi
25..
8b0cefbb
JR
26.\" Set up some character translations and predefined strings. \*(-- will
27.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
e257b235
PA
28.\" double quote, and \*(R" will give a right double quote. \*(C+ will
29.\" give a nicer C++. Capital omega is used to do unbreakable dashes and
30.\" therefore won't be available. \*(C` and \*(C' expand to `' in nroff,
31.\" nothing in troff, for use with C<>.
32.tr \(*W-
8b0cefbb 33.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
74dab6c2 34.ie n \{\
8b0cefbb
JR
35. ds -- \(*W-
36. ds PI pi
37. if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
38. if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch
39. ds L" ""
40. ds R" ""
41. ds C` ""
42. ds C' ""
74dab6c2
JR
43'br\}
44.el\{\
8b0cefbb
JR
45. ds -- \|\(em\|
46. ds PI \(*p
47. ds L" ``
48. ds R" ''
74dab6c2 49'br\}
8b0cefbb 50.\"
e257b235
PA
51.\" Escape single quotes in literal strings from groff's Unicode transform.
52.ie \n(.g .ds Aq \(aq
53.el .ds Aq '
54.\"
8b0cefbb
JR
55.\" If the F register is turned on, we'll generate index entries on stderr for
56.\" titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and index
57.\" entries marked with X<> in POD. Of course, you'll have to process the
58.\" output yourself in some meaningful fashion.
e257b235 59.ie \nF \{\
8b0cefbb
JR
60. de IX
61. tm Index:\\$1\t\\n%\t"\\$2"
74dab6c2 62..
8b0cefbb
JR
63. nr % 0
64. rr F
74dab6c2 65.\}
e257b235
PA
66.el \{\
67. de IX
68..
69.\}
aac4ff6f 70.\"
8b0cefbb
JR
71.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
72.\" Fear. Run. Save yourself. No user-serviceable parts.
73. \" fudge factors for nroff and troff
74dab6c2 74.if n \{\
8b0cefbb
JR
75. ds #H 0
76. ds #V .8m
77. ds #F .3m
78. ds #[ \f1
79. ds #] \fP
74dab6c2
JR
80.\}
81.if t \{\
8b0cefbb
JR
82. ds #H ((1u-(\\\\n(.fu%2u))*.13m)
83. ds #V .6m
84. ds #F 0
85. ds #[ \&
86. ds #] \&
74dab6c2 87.\}
8b0cefbb 88. \" simple accents for nroff and troff
74dab6c2 89.if n \{\
8b0cefbb
JR
90. ds ' \&
91. ds ` \&
92. ds ^ \&
93. ds , \&
94. ds ~ ~
95. ds /
74dab6c2
JR
96.\}
97.if t \{\
8b0cefbb
JR
98. ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
99. ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
100. ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
101. ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
102. ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
103. ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
74dab6c2 104.\}
8b0cefbb 105. \" troff and (daisy-wheel) nroff accents
74dab6c2
JR
106.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
107.ds 8 \h'\*(#H'\(*b\h'-\*(#H'
74dab6c2
JR
108.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
109.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
110.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
111.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
112.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
113.ds ae a\h'-(\w'a'u*4/10)'e
114.ds Ae A\h'-(\w'A'u*4/10)'E
8b0cefbb 115. \" corrections for vroff
74dab6c2
JR
116.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
117.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
8b0cefbb 118. \" for low resolution devices (crt and lpr)
74dab6c2
JR
119.if \n(.H>23 .if \n(.V>19 \
120\{\
8b0cefbb
JR
121. ds : e
122. ds 8 ss
123. ds o a
124. ds d- d\h'-1'\(ga
125. ds D- D\h'-1'\(hy
126. ds th \o'bp'
127. ds Th \o'LP'
128. ds ae ae
129. ds Ae AE
74dab6c2
JR
130.\}
131.rm #[ #] #H #V #F C
8b0cefbb
JR
132.\" ========================================================================
133.\"
134.IX Title "CONF_modules_load_file 3"
e257b235
PA
135.TH CONF_modules_load_file 3 "2009-01-11" "0.9.8j" "OpenSSL"
136.\" For nroff, turn off justification. Always turn off hyphenation; it makes
137.\" way too many mistakes in technical documents.
138.if n .ad l
139.nh
74dab6c2 140.SH "NAME"
74dab6c2 141.Vb 1
e257b235 142\& CONF_modules_load_file, CONF_modules_load \- OpenSSL configuration functions
74dab6c2
JR
143.Ve
144.SH "SYNOPSIS"
8b0cefbb 145.IX Header "SYNOPSIS"
74dab6c2
JR
146.Vb 1
147\& #include <openssl/conf.h>
e257b235 148\&
74dab6c2
JR
149\& int CONF_modules_load_file(const char *filename, const char *appname,
150\& unsigned long flags);
151\& int CONF_modules_load(const CONF *cnf, const char *appname,
152\& unsigned long flags);
153.Ve
154.SH "DESCRIPTION"
8b0cefbb 155.IX Header "DESCRIPTION"
74dab6c2 156The function \fICONF_modules_load_file()\fR configures OpenSSL using file
8b0cefbb 157\&\fBfilename\fR and application name \fBappname\fR. If \fBfilename\fR is \s-1NULL\s0
74dab6c2 158the standard OpenSSL configuration file is used. If \fBappname\fR is
8b0cefbb 159\&\s-1NULL\s0 the standard OpenSSL application name \fBopenssl_conf\fR is used.
74dab6c2
JR
160The behaviour can be cutomized using \fBflags\fR.
161.PP
8b0cefbb 162\&\fICONF_modules_load()\fR is idential to \fICONF_modules_load_file()\fR except it
e257b235 163read configuration information from \fBcnf\fR.
74dab6c2 164.SH "NOTES"
8b0cefbb 165.IX Header "NOTES"
74dab6c2
JR
166The following \fBflags\fR are currently recognized:
167.PP
8b0cefbb 168\&\fB\s-1CONF_MFLAGS_IGNORE_ERRORS\s0\fR if set errors returned by individual
74dab6c2
JR
169configuration modules are ignored. If not set the first module error is
170considered fatal and no further modules are loads.
171.PP
172Normally any modules errors will add error information to the error queue. If
8b0cefbb 173\&\fB\s-1CONF_MFLAGS_SILENT\s0\fR is set no error information is added.
74dab6c2 174.PP
8b0cefbb 175If \fB\s-1CONF_MFLAGS_NO_DSO\s0\fR is set configuration module loading from DSOs is
74dab6c2
JR
176disabled.
177.PP
8b0cefbb 178\&\fB\s-1CONF_MFLAGS_IGNORE_MISSING_FILE\s0\fR if set will make \fICONF_load_modules_file()\fR
74dab6c2
JR
179ignore missing configuration files. Normally a missing configuration file
180return an error.
181.SH "RETURN VALUE"
8b0cefbb 182.IX Header "RETURN VALUE"
74dab6c2
JR
183These functions return 1 for success and a zero or negative value for
184failure. If module errors are not ignored the return code will reflect the
185return value of the failing module (this will always be zero or negative).
186.SH "SEE ALSO"
74dab6c2 187.IX Header "SEE ALSO"
8b0cefbb
JR
188\&\fIconf\fR\|(5), \fIOPENSSL_config\fR\|(3),
189\&\*(L"\fICONF_free\fR\|(3), \fICONF_free\fR\|(3)\*(R", \fIerr\fR\|(3),\fIerr\fR\|(3)
190.SH "HISTORY"
74dab6c2 191.IX Header "HISTORY"
8b0cefbb 192CONF_modules_load_file and CONF_modules_load first appeared in OpenSSL 0.9.7.