summaryrefslogtreecommitdiff
path: root/lib/Apache/Config/Preproc/include.pm
diff options
context:
space:
mode:
authorSergey Poznyakoff <gray@gnu.org.ua>2017-12-07 16:44:01 +0200
committerSergey Poznyakoff <gray@gnu.org.ua>2017-12-07 16:44:01 +0200
commit31a64151b3f675322eb8eadb8bae9887e0f82941 (patch)
tree83d5111dbfee77f483d5f7047ff7f586d34b50f0 /lib/Apache/Config/Preproc/include.pm
parenta8469ca12c614dc3baa1e0238328a6243189ebbe (diff)
downloadacpp-31a64151b3f675322eb8eadb8bae9887e0f82941.tar.gz
acpp-31a64151b3f675322eb8eadb8bae9887e0f82941.tar.bz2
Improve docs
Diffstat (limited to 'lib/Apache/Config/Preproc/include.pm')
-rw-r--r--lib/Apache/Config/Preproc/include.pm26
1 files changed, 26 insertions, 0 deletions
diff --git a/lib/Apache/Config/Preproc/include.pm b/lib/Apache/Config/Preproc/include.pm
index dfa841c..9959a59 100644
--- a/lib/Apache/Config/Preproc/include.pm
+++ b/lib/Apache/Config/Preproc/include.pm
@@ -53,3 +53,29 @@ sub check_included {
}
1;
+
+__END__
+
+=head1 NAME
+
+Apache::Config::Preproc::ifmodule - expand Include statements
+
+=head1 SYNOPSIS
+
+ $x = new Apache::Config::Preproc '/path/to/httpd.conf',
+ -expand => [ qw(include) ],
+ [-server_root => $dir];
+
+=head1 DESCRIPTION
+
+Processes B<Include> and B<IncludeOptional> statements and replaces them
+with the contents of the files supplied in their arguments. If the argument
+is not an absolute file name, it is searched in the server root directory.
+The latter is determined inspecting the B<ServerRoot> statement. If this
+statement is absent, the current working directory is used. The
+B<-server_root> constructor argument can be used to enforce a specific
+server root directory.
+
+=cut
+
+

Return to:

Send suggestions and report system problems to the System administrator.