More configuration docs.
authorDr. Stephen Henson <steve@openssl.org>
Tue, 2 Mar 2004 13:33:52 +0000 (13:33 +0000)
committerDr. Stephen Henson <steve@openssl.org>
Tue, 2 Mar 2004 13:33:52 +0000 (13:33 +0000)
doc/crypto/OPENSSL_config.pod

index 18da16f3c36be657b39efb79996d0f41270ab2e6..16600620ccf314005407c4b68ab212865f19a050 100644 (file)
@@ -2,7 +2,7 @@
 
 =head1 NAME
 
-OPENSSL_config, OPENSSL_no_config - minimal OpenSSL configuration
+OPENSSL_config, OPENSSL_no_config - simple OpenSSL configuration functions
 
 =head1 SYNOPSIS
 
@@ -32,7 +32,8 @@ and some new functionality can be supported automatically.
 
 It is also possible to automatically call OPENSSL_config() when an application
 calls OPENSSL_add_all_algorithms() by compiling an application with the
-preprocessor symbol B<OPENSSL_LOAD_CONF> #define'd.
+preprocessor symbol B<OPENSSL_LOAD_CONF> #define'd. In this way configuration
+can be added without source changes.
 
 The environment variable B<OPENSSL_CONFIG> can be set to specify the location
 of the configuration file.
@@ -51,6 +52,9 @@ application calls OPENSSL_config() it doesn't need to know or care about
 ENGINE control operations because they can be performed by editing a
 configuration file.
 
+Applications should free up configuration at application closedown by calling
+CONF_modules_free().
+
 =head1 RESTRICTIONS
 
 The OPENSSL_config() function is designed to be a very simple "call it and
@@ -59,7 +63,7 @@ all errors silently and it can only load from the standard configuration file
 location for example.
 
 It is however B<much> better than nothing. Applications which need finer
-control over the configuration functionality should use the configuration
+control over their configuration functionality should use the configuration
 functions such as CONF_load_modules() directly.
 
 =head1 RETURN VALUES
@@ -68,7 +72,8 @@ Neither OPENSSL_config() nor OPENSSL_no_config() return a value.
 
 =head1 SEE ALSO
 
-L<conf(5)|conf(5)>
+L<conf(5)|conf(5)>, L<CONF_load_modules_file(3)|CONF_load_modules_file(3)>,
+L<CONF_modules_free(3),CONF_modules_free(3)>
 
 =head1 HISTORY