From: Daniel Earl Poirier <poirier@apache.org>
Date: Fri, 18 Dec 2009 15:44:03 +0000 (+0000)
Subject: Document the ability to use shell environment variables in
X-Git-Tag: 2.3.5~78
X-Git-Url: https://granicus.if.org/sourcecode?a=commitdiff_plain;h=7f96be759771432c9cb52b4a1f26c7c4eb53a92b;p=apache

Document the ability to use shell environment variables in
the configuration file.

PR: 46333
Patch submitted by: Nathan Stratton Treadway


git-svn-id: https://svn.apache.org/repos/asf/httpd/httpd/trunk@892280 13f79535-47bb-0310-9956-ffa450edef68
---

diff --git a/docs/manual/configuring.html.en b/docs/manual/configuring.html.en
index 723b03f0b0..d9cd6b4013 100644
--- a/docs/manual/configuring.html.en
+++ b/docs/manual/configuring.html.en
@@ -74,9 +74,19 @@ HTTP server.</p>
     and white space occurring before a directive are ignored, so
     you may indent directives for clarity.</p>
 
-    <p>The maximum length of a line in the configuration file,
-    after joining any continued lines and removing leading and
-    trailing white space, is 8192 characters.</p>
+    <p>The values of shell environment variables can be used in
+    configuration file lines using the syntax <code>${ENVVAR}</code>.
+    If "ENVVAR" is the name of a valid environment variable, the value
+    of that variable is substituted into that spot in the
+    configuration file line, and processing continues as if that text
+    were found directly in the configuration file.  (If the ENVVAR
+    variable is not found, the characters "${ENVVAR}" are left
+    unchanged for use by later stages in the config file
+    processing.)</p>
+
+    <p>The maximum length of a line in the configuration file, after
+    environment-variable substitution, joining any continued lines and
+    removing leading and trailing white space, is 8192 characters.</p>
 
     <p>You can check your configuration files for syntax errors
     without starting the server by using <code>apachectl
diff --git a/docs/manual/configuring.xml b/docs/manual/configuring.xml
index 7ef3006b14..390a88ca85 100644
--- a/docs/manual/configuring.xml
+++ b/docs/manual/configuring.xml
@@ -77,9 +77,19 @@ HTTP server.</p>
     and white space occurring before a directive are ignored, so
     you may indent directives for clarity.</p>
 
-    <p>The maximum length of a line in the configuration file,
-    after joining any continued lines and removing leading and
-    trailing white space, is 8192 characters.</p>
+    <p>The values of shell environment variables can be used in
+    configuration file lines using the syntax <code>${ENVVAR}</code>.
+    If "ENVVAR" is the name of a valid environment variable, the value
+    of that variable is substituted into that spot in the
+    configuration file line, and processing continues as if that text
+    were found directly in the configuration file.  (If the ENVVAR
+    variable is not found, the characters "${ENVVAR}" are left
+    unchanged for use by later stages in the config file
+    processing.)</p>
+
+    <p>The maximum length of a line in the configuration file, after
+    environment-variable substitution, joining any continued lines and
+    removing leading and trailing white space, is 8192 characters.</p>
 
     <p>You can check your configuration files for syntax errors
     without starting the server by using <code>apachectl