[dragonfly.git] / secure / lib / libcrypto / man / CONF_modules_load_file.3

.rn '' }`
''' $RCSfile$$Revision$$Date$
'''
''' $Log$
'''
.de Sh
.br
.if t .Sp
.ne 5
.PP
\fB\\$1\fR
.PP
..
.de Sp
.if t .sp .5v
.if n .sp
..
.de Ip
.br
.ie \\n(.$>=3 .ne \\$3
.el .ne 3
.IP "\\$1" \\$2
..
.de Vb
.ft CW
.nf
.ne \\$1
..
.de Ve
.ft R

.fi
..
'''
'''
'''     Set up \*(-- to give an unbreakable dash;
'''     string Tr holds user defined translation string.
'''     Bell System Logo is used as a dummy character.
'''
.tr \(*W-|\(bv\*(Tr
.ie n \{\
.ds -- \(*W-
.ds PI pi
.if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
.if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch
.ds L" ""
.ds R" ""
'''   \*(M", \*(S", \*(N" and \*(T" are the equivalent of
'''   \*(L" and \*(R", except that they are used on ".xx" lines,
'''   such as .IP and .SH, which do another additional levels of
'''   double-quote interpretation
.ds M" """
.ds S" """
.ds N" """""
.ds T" """""
.ds L' '
.ds R' '
.ds M' '
.ds S' '
.ds N' '
.ds T' '
'br\}
.el\{\
.ds -- \(em\|
.tr \*(Tr
.ds L" ``
.ds R" ''
.ds M" ``
.ds S" ''
.ds N" ``
.ds T" ''
.ds L' `
.ds R' '
.ds M' `
.ds S' '
.ds N' `
.ds T' '
.ds PI \(*p
'br\}
.\"	If the F register is turned on, we'll generate
.\"	index entries out stderr for the following things:
.\"		TH	Title 
.\"		SH	Header
.\"		Sh	Subsection 
.\"		Ip	Item
.\"		X<>	Xref  (embedded
.\"	Of course, you have to process the output yourself
.\"	in some meaninful fashion.
.if \nF \{
.de IX
.tm Index:\\$1\t\\n%\t"\\$2"
..
.nr % 0
.rr F
.\}
.TH CONF_modules_load_file 3 "0.9.7d" "2/Sep/2004" "OpenSSL"
.UC
.if n .hy 0
.if n .na
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.de CQ          \" put $1 in typewriter font
.ft CW
'if n "\c
'if t \\&\\$1\c
'if n \\&\\$1\c
'if n \&"
\\&\\$2 \\$3 \\$4 \\$5 \\$6 \\$7
'.ft R
..
.\" @(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2
.	\" AM - accent mark definitions
.bd B 3
.	\" fudge factors for nroff and troff
.if n \{\
.	ds #H 0
.	ds #V .8m
.	ds #F .3m
.	ds #[ \f1
.	ds #] \fP
.\}
.if t \{\
.	ds #H ((1u-(\\\\n(.fu%2u))*.13m)
.	ds #V .6m
.	ds #F 0
.	ds #[ \&
.	ds #] \&
.\}
.	\" simple accents for nroff and troff
.if n \{\
.	ds ' \&
.	ds ` \&
.	ds ^ \&
.	ds , \&
.	ds ~ ~
.	ds ? ?
.	ds ! !
.	ds /
.	ds q
.\}
.if t \{\
.	ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
.	ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
.	ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
.	ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
.	ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
.	ds ? \s-2c\h'-\w'c'u*7/10'\u\h'\*(#H'\zi\d\s+2\h'\w'c'u*8/10'
.	ds ! \s-2\(or\s+2\h'-\w'\(or'u'\v'-.8m'.\v'.8m'
.	ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
.	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'
.\}
.	\" troff and (daisy-wheel) nroff accents
.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
.ds 8 \h'\*(#H'\(*b\h'-\*(#H'
.ds v \\k:\h'-(\\n(.wu*9/10-\*(#H)'\v'-\*(#V'\*(#[\s-4v\s0\v'\*(#V'\h'|\\n:u'\*(#]
.ds _ \\k:\h'-(\\n(.wu*9/10-\*(#H+(\*(#F*2/3))'\v'-.4m'\z\(hy\v'.4m'\h'|\\n:u'
.ds . \\k:\h'-(\\n(.wu*8/10)'\v'\*(#V*4/10'\z.\v'-\*(#V*4/10'\h'|\\n:u'
.ds 3 \*(#[\v'.2m'\s-2\&3\s0\v'-.2m'\*(#]
.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
.ds ae a\h'-(\w'a'u*4/10)'e
.ds Ae A\h'-(\w'A'u*4/10)'E
.ds oe o\h'-(\w'o'u*4/10)'e
.ds Oe O\h'-(\w'O'u*4/10)'E
.	\" corrections for vroff
.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
.	\" for low resolution devices (crt and lpr)
.if \n(.H>23 .if \n(.V>19 \
\{\
.	ds : e
.	ds 8 ss
.	ds v \h'-1'\o'\(aa\(ga'
.	ds _ \h'-1'^
.	ds . \h'-1'.
.	ds 3 3
.	ds o a
.	ds d- d\h'-1'\(ga
.	ds D- D\h'-1'\(hy
.	ds th \o'bp'
.	ds Th \o'LP'
.	ds ae ae
.	ds Ae AE
.	ds oe oe
.	ds Oe OE
.\}
.rm #[ #] #H #V #F C
.SH "NAME"
.PP
.Vb 1
\& CONF_modules_load_file, CONF_modules_load - OpenSSL configuration functions
.Ve
.SH "SYNOPSIS"
.PP
.Vb 1
\& #include <openssl/conf.h>
.Ve
.Vb 4
\& int CONF_modules_load_file(const char *filename, const char *appname,
\&                           unsigned long flags);
\& int CONF_modules_load(const CONF *cnf, const char *appname,
\&                      unsigned long flags);
.Ve
.SH "DESCRIPTION"
The function \fICONF_modules_load_file()\fR configures OpenSSL using file
\fBfilename\fR and application name \fBappname\fR. If \fBfilename\fR is NULL
the standard OpenSSL configuration file is used. If \fBappname\fR is
NULL the standard OpenSSL application name \fBopenssl_conf\fR is used.
The behaviour can be cutomized using \fBflags\fR.
.PP
\fICONF_modules_load()\fR is idential to \fICONF_modules_load_file()\fR except it
read configuration information from \fBcnf\fR. 
.SH "NOTES"
The following \fBflags\fR are currently recognized:
.PP
\fBCONF_MFLAGS_IGNORE_ERRORS\fR if set errors returned by individual
configuration modules are ignored. If not set the first module error is
considered fatal and no further modules are loads.
.PP
Normally any modules errors will add error information to the error queue. If
\fBCONF_MFLAGS_SILENT\fR is set no error information is added.
.PP
If \fBCONF_MFLAGS_NO_DSO\fR is set configuration module loading from DSOs is
disabled.
.PP
\fBCONF_MFLAGS_IGNORE_MISSING_FILE\fR if set will make \fICONF_load_modules_file()\fR
ignore missing configuration files. Normally a missing configuration file
return an error.
.SH "RETURN VALUE"
These functions return 1 for success and a zero or negative value for
failure. If module errors are not ignored the return code will reflect the
return value of the failing module (this will always be zero or negative).
.SH "SEE ALSO"
conf(5), OPENSSL_config(3),
the section on \fICONF_free(3), CONF_free(3)\fR, the \fIerr(3),err(3)\fR manpage
.SH "HISTORY"
CONF_modules_load_file and CONF_modules_load first appeared in OpenSSL 0.9.7.

.rn }` ''
.IX Title "CONF_modules_load_file 3"
.IX Name "CONF_modules_load_file, CONF_modules_load - OpenSSL configuration functions"

.IX Header "NAME"

.IX Header "SYNOPSIS"

.IX Header "DESCRIPTION"

.IX Header "NOTES"

.IX Header "RETURN VALUE"

.IX Header "SEE ALSO"

.IX Header "HISTORY"
Commit	Line	Data
74dab6c2 JR	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 CONF_modules_load_file 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(.wu8/10-\(#H)'\'\h"\|\\n:u"
142	. ds ` \\k:\h'-(\\n(.wu8/10-\(#H)'\`\h'\|\\n:u'
143	. ds ^ \\k:\h'-(\\n(.wu10/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'u7/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(.wu8/10-\(#H)'\z\(sl\h'\|\\n:u'
149	. ds q o\h'-\w'o'u8/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(.wu8/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(.wu9/10-\(#H)'\v'-\(#V'\(#[\s-4v\s0\v'\(#V'\h'\|\\n:u'\(#]
155	.ds _ \\k:\h'-(\\n(.wu9/10-\(#H+(\(#F2/3))'\v'-.4m'\z\(hy\v'.4m'\h'\|\\n:u'
156	.ds . \\k:\h'-(\\n(.wu8/10)'\v'\(#V4/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'u2/3)'\s-1o\s+1\*(#]
162	.ds Th \(#[\s+2I\s-2\h'-\w'I'u3/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(.wu9/10-\(#H)'\s-2\u~\d\s+2\h'\|\\n:u'
169	.if v .ds ^ \\k:\h'-(\\n(.wu10/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	.PP
192	.Vb 1
193	\& CONF_modules_load_file, CONF_modules_load - OpenSSL configuration functions
194	.Ve
195	.SH "SYNOPSIS"
196	.PP
197	.Vb 1
198	\& #include <openssl/conf.h>
199	.Ve
200	.Vb 4
201	\& int CONF_modules_load_file(const char filename, const char appname,
202	\& unsigned long flags);
203	\& int CONF_modules_load(const CONF cnf, const char appname,
204	\& unsigned long flags);
205	.Ve
206	.SH "DESCRIPTION"
207	The function \fICONF_modules_load_file()\fR configures OpenSSL using file
208	\fBfilename\fR and application name \fBappname\fR. If \fBfilename\fR is NULL
209	the standard OpenSSL configuration file is used. If \fBappname\fR is
210	NULL the standard OpenSSL application name \fBopenssl_conf\fR is used.
211	The behaviour can be cutomized using \fBflags\fR.
212	.PP
213	\fICONF_modules_load()\fR is idential to \fICONF_modules_load_file()\fR except it
214	read configuration information from \fBcnf\fR.
215	.SH "NOTES"
216	The following \fBflags\fR are currently recognized:
217	.PP
218	\fBCONF_MFLAGS_IGNORE_ERRORS\fR if set errors returned by individual
219	configuration modules are ignored. If not set the first module error is
220	considered fatal and no further modules are loads.
221	.PP
222	Normally any modules errors will add error information to the error queue. If
223	\fBCONF_MFLAGS_SILENT\fR is set no error information is added.
224	.PP
225	If \fBCONF_MFLAGS_NO_DSO\fR is set configuration module loading from DSOs is
226	disabled.
227	.PP
228	\fBCONF_MFLAGS_IGNORE_MISSING_FILE\fR if set will make \fICONF_load_modules_file()\fR
229	ignore missing configuration files. Normally a missing configuration file
230	return an error.
231	.SH "RETURN VALUE"
232	These functions return 1 for success and a zero or negative value for
233	failure. If module errors are not ignored the return code will reflect the
234	return value of the failing module (this will always be zero or negative).
235	.SH "SEE ALSO"
236	conf(5), OPENSSL_config(3),
237	the section on \fICONF_free(3), CONF_free(3)\fR, the \fIerr(3),err(3)\fR manpage
238	.SH "HISTORY"
239	CONF_modules_load_file and CONF_modules_load first appeared in OpenSSL 0.9.7.
240
241	.rn }` ''
242	.IX Title "CONF_modules_load_file 3"
243	.IX Name "CONF_modules_load_file, CONF_modules_load - OpenSSL configuration functions"
244
245	.IX Header "NAME"
246
247	.IX Header "SYNOPSIS"
248
249	.IX Header "DESCRIPTION"
250
251	.IX Header "NOTES"
252
253	.IX Header "RETURN VALUE"
254
255	.IX Header "SEE ALSO"
256
257	.IX Header "HISTORY"
258