summaryrefslogtreecommitdiffstats
path: root/doc/man5
diff options
context:
space:
mode:
authorTomas Mraz <tmraz@fedoraproject.org>2018-02-27 13:55:35 +0100
committerMatt Caswell <matt@openssl.org>2018-03-05 13:32:40 +0000
commitb524b808a1d1ba204dbdcbb42de4e3bddb3472ac (patch)
tree4b183c1e0737609272adea1a608f4c3c0064f65b /doc/man5
parentaa2ed504ea9d55be6e75a9647d874709dc71823b (diff)
Add support for .include directive in config files
Either files or directories of *.cnf or *.conf files can be included. Recursive inclusion of directories is not supported. Reviewed-by: Andy Polyakov <appro@openssl.org> Reviewed-by: Matt Caswell <matt@openssl.org> (Merged from https://github.com/openssl/openssl/pull/5351)
Diffstat (limited to 'doc/man5')
-rw-r--r--doc/man5/config.pod18
1 files changed, 18 insertions, 0 deletions
diff --git a/doc/man5/config.pod b/doc/man5/config.pod
index a7cc16b2c0..485ec0870b 100644
--- a/doc/man5/config.pod
+++ b/doc/man5/config.pod
@@ -27,6 +27,21 @@ The environment is mapped onto a section called B<ENV>.
Comments can be included by preceding them with the B<#> character
+Other files can be included using the B<.include> directive followed
+by a path. If the path points to a directory all files with
+names ending with B<.cnf> or B<.conf> are included from the directory.
+Recursive inclusion of directories from files in such directory is not
+supported. That means the files in the included directory can also contain
+B<.include> directives but only inclusion of regular files is supported
+there. The inclusion of directories is not supported on systems without
+POSIX IO support.
+
+It is strongly recommended to use absolute paths with the B<.include>
+directive. Relative paths are evaluated based on the application current
+working directory so unless the configuration file containing the
+B<.include> directive is application specific the inclusion will not
+work as expected.
+
Each section in a configuration file consists of a number of name and
value pairs of the form B<name=value>
@@ -52,6 +67,9 @@ or the B<\> character. By making the last character of a line a B<\>
a B<value> string can be spread across multiple lines. In addition
the sequences B<\n>, B<\r>, B<\b> and B<\t> are recognized.
+All expansion and escape rules as described above that apply to B<value>
+also apply to the path of the B<.include> directive.
+
=head1 OPENSSL LIBRARY CONFIGURATION
Applications can automatically configure certain