Upgrade to OpenSSL 0.9.8h.
[dragonfly.git] / secure / lib / libcrypto / man / CONF_modules_load_file.3
CommitLineData
aac4ff6f 1.\" Automatically generated by Pod::Man v1.37, Pod::Parser v1.32
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
aac4ff6f
PA
28.\" double quote, and \*(R" will give a right double quote. | will give a
29.\" real vertical bar. \*(C+ will give a nicer C++. Capital omega is used to
30.\" do unbreakable dashes and therefore won't be available. \*(C` and \*(C'
31.\" expand to `' in nroff, nothing in troff, for use with C<>.
32.tr \(*W-|\(bv\*(Tr
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
JR
50.\"
51.\" If the F register is turned on, we'll generate index entries on stderr for
52.\" titles (.TH), headers (.SH), subsections (.Sh), 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.if \nF \{\
56. de IX
57. tm Index:\\$1\t\\n%\t"\\$2"
74dab6c2 58..
8b0cefbb
JR
59. nr % 0
60. rr F
74dab6c2 61.\}
8b0cefbb 62.\"
aac4ff6f
PA
63.\" For nroff, turn off justification. Always turn off hyphenation; it makes
64.\" way too many mistakes in technical documents.
65.hy 0
66.if n .na
67.\"
8b0cefbb
JR
68.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
69.\" Fear. Run. Save yourself. No user-serviceable parts.
70. \" fudge factors for nroff and troff
74dab6c2 71.if n \{\
8b0cefbb
JR
72. ds #H 0
73. ds #V .8m
74. ds #F .3m
75. ds #[ \f1
76. ds #] \fP
74dab6c2
JR
77.\}
78.if t \{\
8b0cefbb
JR
79. ds #H ((1u-(\\\\n(.fu%2u))*.13m)
80. ds #V .6m
81. ds #F 0
82. ds #[ \&
83. ds #] \&
74dab6c2 84.\}
8b0cefbb 85. \" simple accents for nroff and troff
74dab6c2 86.if n \{\
8b0cefbb
JR
87. ds ' \&
88. ds ` \&
89. ds ^ \&
90. ds , \&
91. ds ~ ~
92. ds /
74dab6c2
JR
93.\}
94.if t \{\
8b0cefbb
JR
95. ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
96. ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
97. ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
98. ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
99. ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
100. ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
74dab6c2 101.\}
8b0cefbb 102. \" troff and (daisy-wheel) nroff accents
74dab6c2
JR
103.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
104.ds 8 \h'\*(#H'\(*b\h'-\*(#H'
74dab6c2
JR
105.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
106.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
107.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
108.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
109.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
110.ds ae a\h'-(\w'a'u*4/10)'e
111.ds Ae A\h'-(\w'A'u*4/10)'E
8b0cefbb 112. \" corrections for vroff
74dab6c2
JR
113.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
114.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
8b0cefbb 115. \" for low resolution devices (crt and lpr)
74dab6c2
JR
116.if \n(.H>23 .if \n(.V>19 \
117\{\
8b0cefbb
JR
118. ds : e
119. ds 8 ss
120. ds o a
121. ds d- d\h'-1'\(ga
122. ds D- D\h'-1'\(hy
123. ds th \o'bp'
124. ds Th \o'LP'
125. ds ae ae
126. ds Ae AE
74dab6c2
JR
127.\}
128.rm #[ #] #H #V #F C
8b0cefbb
JR
129.\" ========================================================================
130.\"
131.IX Title "CONF_modules_load_file 3"
aac4ff6f 132.TH CONF_modules_load_file 3 "2008-09-06" "0.9.8h" "OpenSSL"
74dab6c2 133.SH "NAME"
74dab6c2 134.Vb 1
aac4ff6f 135\& CONF_modules_load_file, CONF_modules_load - OpenSSL configuration functions
74dab6c2
JR
136.Ve
137.SH "SYNOPSIS"
8b0cefbb 138.IX Header "SYNOPSIS"
74dab6c2
JR
139.Vb 1
140\& #include <openssl/conf.h>
aac4ff6f
PA
141.Ve
142.PP
143.Vb 4
74dab6c2
JR
144\& int CONF_modules_load_file(const char *filename, const char *appname,
145\& unsigned long flags);
146\& int CONF_modules_load(const CONF *cnf, const char *appname,
147\& unsigned long flags);
148.Ve
149.SH "DESCRIPTION"
8b0cefbb 150.IX Header "DESCRIPTION"
74dab6c2 151The function \fICONF_modules_load_file()\fR configures OpenSSL using file
8b0cefbb 152\&\fBfilename\fR and application name \fBappname\fR. If \fBfilename\fR is \s-1NULL\s0
74dab6c2 153the standard OpenSSL configuration file is used. If \fBappname\fR is
8b0cefbb 154\&\s-1NULL\s0 the standard OpenSSL application name \fBopenssl_conf\fR is used.
74dab6c2
JR
155The behaviour can be cutomized using \fBflags\fR.
156.PP
8b0cefbb 157\&\fICONF_modules_load()\fR is idential to \fICONF_modules_load_file()\fR except it
aac4ff6f 158read configuration information from \fBcnf\fR.
74dab6c2 159.SH "NOTES"
8b0cefbb 160.IX Header "NOTES"
74dab6c2
JR
161The following \fBflags\fR are currently recognized:
162.PP
8b0cefbb 163\&\fB\s-1CONF_MFLAGS_IGNORE_ERRORS\s0\fR if set errors returned by individual
74dab6c2
JR
164configuration modules are ignored. If not set the first module error is
165considered fatal and no further modules are loads.
166.PP
167Normally any modules errors will add error information to the error queue. If
8b0cefbb 168\&\fB\s-1CONF_MFLAGS_SILENT\s0\fR is set no error information is added.
74dab6c2 169.PP
8b0cefbb 170If \fB\s-1CONF_MFLAGS_NO_DSO\s0\fR is set configuration module loading from DSOs is
74dab6c2
JR
171disabled.
172.PP
8b0cefbb 173\&\fB\s-1CONF_MFLAGS_IGNORE_MISSING_FILE\s0\fR if set will make \fICONF_load_modules_file()\fR
74dab6c2
JR
174ignore missing configuration files. Normally a missing configuration file
175return an error.
176.SH "RETURN VALUE"
8b0cefbb 177.IX Header "RETURN VALUE"
74dab6c2
JR
178These functions return 1 for success and a zero or negative value for
179failure. If module errors are not ignored the return code will reflect the
180return value of the failing module (this will always be zero or negative).
181.SH "SEE ALSO"
74dab6c2 182.IX Header "SEE ALSO"
8b0cefbb
JR
183\&\fIconf\fR\|(5), \fIOPENSSL_config\fR\|(3),
184\&\*(L"\fICONF_free\fR\|(3), \fICONF_free\fR\|(3)\*(R", \fIerr\fR\|(3),\fIerr\fR\|(3)
185.SH "HISTORY"
74dab6c2 186.IX Header "HISTORY"
8b0cefbb 187CONF_modules_load_file and CONF_modules_load first appeared in OpenSSL 0.9.7.