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