Update files for OpenSSL-1.0.0f import.
[dragonfly.git] / secure / lib / libcrypto / man / OPENSSL_config.3
CommitLineData
e3261593 1.\" Automatically generated by Pod::Man 2.25 (Pod::Simple 3.19)
8b0cefbb
JR
2.\"
3.\" Standard preamble:
4.\" ========================================================================
8b0cefbb 5.de Sp \" Vertical space (when we can't use .PP)
74dab6c2
JR
6.if t .sp .5v
7.if n .sp
8..
8b0cefbb 9.de Vb \" Begin verbatim text
74dab6c2
JR
10.ft CW
11.nf
12.ne \\$1
13..
8b0cefbb 14.de Ve \" End verbatim text
74dab6c2 15.ft R
74dab6c2
JR
16.fi
17..
8b0cefbb
JR
18.\" Set up some character translations and predefined strings. \*(-- will
19.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
e257b235
PA
20.\" double quote, and \*(R" will give a right double quote. \*(C+ will
21.\" give a nicer C++. Capital omega is used to do unbreakable dashes and
22.\" therefore won't be available. \*(C` and \*(C' expand to `' in nroff,
23.\" nothing in troff, for use with C<>.
24.tr \(*W-
8b0cefbb 25.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
74dab6c2 26.ie n \{\
8b0cefbb
JR
27. ds -- \(*W-
28. ds PI pi
29. if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
30. if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch
31. ds L" ""
32. ds R" ""
33. ds C` ""
34. ds C' ""
74dab6c2
JR
35'br\}
36.el\{\
8b0cefbb
JR
37. ds -- \|\(em\|
38. ds PI \(*p
39. ds L" ``
40. ds R" ''
74dab6c2 41'br\}
8b0cefbb 42.\"
e257b235
PA
43.\" Escape single quotes in literal strings from groff's Unicode transform.
44.ie \n(.g .ds Aq \(aq
45.el .ds Aq '
46.\"
8b0cefbb 47.\" If the F register is turned on, we'll generate index entries on stderr for
01185282 48.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
8b0cefbb
JR
49.\" entries marked with X<> in POD. Of course, you'll have to process the
50.\" output yourself in some meaningful fashion.
e257b235 51.ie \nF \{\
8b0cefbb
JR
52. de IX
53. tm Index:\\$1\t\\n%\t"\\$2"
74dab6c2 54..
8b0cefbb
JR
55. nr % 0
56. rr F
74dab6c2 57.\}
e257b235
PA
58.el \{\
59. de IX
60..
61.\}
aac4ff6f 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 "OPENSSL_config 3"
e3261593 127.TH OPENSSL_config 3 "2012-01-04" "1.0.0f" "OpenSSL"
e257b235
PA
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
JR
132.SH "NAME"
133OPENSSL_config, OPENSSL_no_config \- simple OpenSSL configuration functions
134.SH "SYNOPSIS"
8b0cefbb 135.IX Header "SYNOPSIS"
74dab6c2
JR
136.Vb 1
137\& #include <openssl/conf.h>
e257b235 138\&
74dab6c2
JR
139\& void OPENSSL_config(const char *config_name);
140\& void OPENSSL_no_config(void);
141.Ve
142.SH "DESCRIPTION"
8b0cefbb
JR
143.IX Header "DESCRIPTION"
144\&\fIOPENSSL_config()\fR configures OpenSSL using the standard \fBopenssl.cnf\fR
145configuration file name using \fBconfig_name\fR. If \fBconfig_name\fR is \s-1NULL\s0 then
74dab6c2
JR
146the default name \fBopenssl_conf\fR will be used. Any errors are ignored. Further
147calls to \fIOPENSSL_config()\fR will have no effect. The configuration file format
8b0cefbb 148is documented in the \fIconf\fR\|(5) manual page.
74dab6c2 149.PP
8b0cefbb 150\&\fIOPENSSL_no_config()\fR disables configuration. If called before \fIOPENSSL_config()\fR
74dab6c2
JR
151no configuration takes place.
152.SH "NOTES"
8b0cefbb 153.IX Header "NOTES"
74dab6c2
JR
154It is \fBstrongly\fR recommended that \fBall\fR new applications call \fIOPENSSL_config()\fR
155or the more sophisticated functions such as \fICONF_modules_load()\fR during
156initialization (that is before starting any threads). By doing this
157an application does not need to keep track of all configuration options
158and some new functionality can be supported automatically.
159.PP
160It is also possible to automatically call \fIOPENSSL_config()\fR when an application
161calls \fIOPENSSL_add_all_algorithms()\fR by compiling an application with the
8b0cefbb 162preprocessor symbol \fB\s-1OPENSSL_LOAD_CONF\s0\fR #define'd. In this way configuration
74dab6c2
JR
163can be added without source changes.
164.PP
a561f9ff 165The environment variable \fB\s-1OPENSSL_CONF\s0\fR can be set to specify the location
74dab6c2 166of the configuration file.
8b0cefbb
JR
167.PP
168Currently \s-1ASN1\s0 OBJECTs and \s-1ENGINE\s0 configuration can be performed future
74dab6c2
JR
169versions of OpenSSL will add new configuration options.
170.PP
171There are several reasons why calling the OpenSSL configuration routines is
8b0cefbb 172advisable. For example new \s-1ENGINE\s0 functionality was added to OpenSSL 0.9.7.
74dab6c2
JR
173In OpenSSL 0.9.7 control functions can be supported by ENGINEs, this can be
174used (among other things) to load dynamic ENGINEs from shared libraries (DSOs).
175However very few applications currently support the control interface and so
176very few can load and use dynamic ENGINEs. Equally in future more sophisticated
177ENGINEs will require certain control operations to customize them. If an
178application calls \fIOPENSSL_config()\fR it doesn't need to know or care about
8b0cefbb 179\&\s-1ENGINE\s0 control operations because they can be performed by editing a
74dab6c2
JR
180configuration file.
181.PP
182Applications should free up configuration at application closedown by calling
8b0cefbb 183\&\fICONF_modules_free()\fR.
74dab6c2 184.SH "RESTRICTIONS"
8b0cefbb 185.IX Header "RESTRICTIONS"
74dab6c2
JR
186The \fIOPENSSL_config()\fR function is designed to be a very simple \*(L"call it and
187forget it\*(R" function. As a result its behaviour is somewhat limited. It ignores
188all errors silently and it can only load from the standard configuration file
189location for example.
190.PP
191It is however \fBmuch\fR better than nothing. Applications which need finer
192control over their configuration functionality should use the configuration
193functions such as \fICONF_load_modules()\fR directly.
194.SH "RETURN VALUES"
8b0cefbb 195.IX Header "RETURN VALUES"
74dab6c2
JR
196Neither \fIOPENSSL_config()\fR nor \fIOPENSSL_no_config()\fR return a value.
197.SH "SEE ALSO"
74dab6c2 198.IX Header "SEE ALSO"
8b0cefbb
JR
199\&\fIconf\fR\|(5), \fICONF_load_modules_file\fR\|(3),
200\&\fICONF_modules_free\fR\|(3),\fICONF_modules_free\fR\|(3)
201.SH "HISTORY"
74dab6c2 202.IX Header "HISTORY"
8b0cefbb 203\&\fIOPENSSL_config()\fR and \fIOPENSSL_no_config()\fR first appeared in OpenSSL 0.9.7