diff options
Diffstat (limited to 'src/lib/libcrypto/doc/OPENSSL_load_builtin_modules.pod')
-rw-r--r-- | src/lib/libcrypto/doc/OPENSSL_load_builtin_modules.pod | 51 |
1 files changed, 51 insertions, 0 deletions
diff --git a/src/lib/libcrypto/doc/OPENSSL_load_builtin_modules.pod b/src/lib/libcrypto/doc/OPENSSL_load_builtin_modules.pod new file mode 100644 index 0000000000..f14dfaf005 --- /dev/null +++ b/src/lib/libcrypto/doc/OPENSSL_load_builtin_modules.pod | |||
@@ -0,0 +1,51 @@ | |||
1 | =pod | ||
2 | |||
3 | =head1 NAME | ||
4 | |||
5 | OPENSSL_load_builtin_modules - add standard configuration modules | ||
6 | |||
7 | =head1 SYNOPSIS | ||
8 | |||
9 | #include <openssl/conf.h> | ||
10 | |||
11 | void OPENSSL_load_builtin_modules(void); | ||
12 | void ASN1_add_oid_module(void); | ||
13 | ENGINE_add_conf_module(); | ||
14 | |||
15 | =head1 DESCRIPTION | ||
16 | |||
17 | The function OPENSSL_load_builtin_modules() adds all the standard OpenSSL | ||
18 | configuration modules to the internal list. They can then be used by the | ||
19 | OpenSSL configuration code. | ||
20 | |||
21 | ASN1_add_oid_module() adds just the ASN1 OBJECT module. | ||
22 | |||
23 | ENGINE_add_conf_module() adds just the ENGINE configuration module. | ||
24 | |||
25 | =head1 NOTES | ||
26 | |||
27 | If the simple configuration function OPENSSL_config() is called then | ||
28 | OPENSSL_load_builtin_modules() is called automatically. | ||
29 | |||
30 | Applications which use the configuration functions directly will need to | ||
31 | call OPENSSL_load_builtin_modules() themselves I<before> any other | ||
32 | configuration code. | ||
33 | |||
34 | Applications should call OPENSSL_load_builtin_modules() to load all | ||
35 | configuration modules instead of adding modules selectively: otherwise | ||
36 | functionality may be missing from the application if an when new | ||
37 | modules are added. | ||
38 | |||
39 | =head1 RETURN VALUE | ||
40 | |||
41 | None of the functions return a value. | ||
42 | |||
43 | =head1 SEE ALSO | ||
44 | |||
45 | L<conf(3)|conf(3)>, L<OPENSSL_config(3)|OPENSSL_config(3)> | ||
46 | |||
47 | =head1 HISTORY | ||
48 | |||
49 | These functions first appeared in OpenSSL 0.9.7. | ||
50 | |||
51 | =cut | ||