You are viewing a plain text version of this content. The canonical link for it is here.
Posted to cvs@httpd.apache.org by sf...@apache.org on 2011/01/21 12:32:13 UTC
svn commit: r1061758 - in /httpd/httpd/trunk/docs/manual:
configuring.html.en configuring.xml mod/core.html.en mod/core.xml
Author: sf
Date: Fri Jan 21 11:32:13 2011
New Revision: 1061758
URL: http://svn.apache.org/viewvc?rev=1061758&view=rev
Log:
Add more documentations for Define'd variables
Modified:
httpd/httpd/trunk/docs/manual/configuring.html.en
httpd/httpd/trunk/docs/manual/configuring.xml
httpd/httpd/trunk/docs/manual/mod/core.html.en
httpd/httpd/trunk/docs/manual/mod/core.xml
Modified: httpd/httpd/trunk/docs/manual/configuring.html.en
URL: http://svn.apache.org/viewvc/httpd/httpd/trunk/docs/manual/configuring.html.en?rev=1061758&r1=1061757&r2=1061758&view=diff
==============================================================================
--- httpd/httpd/trunk/docs/manual/configuring.html.en (original)
+++ httpd/httpd/trunk/docs/manual/configuring.html.en Fri Jan 21 11:32:13 2011
@@ -74,24 +74,28 @@ Server.</p>
and white space occurring before a directive are ignored, so
you may indent directives for clarity.</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
+ <p>The values of variables defined with the <code class="directive"><a href="./mod/core.html# define">
+ Define</a></code> of or shell environment variables can be used in
+ configuration file lines using the syntax <code>${VAR}</code>.
+ If "VAR" is the name of a valid 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>Only environment variables defined before the server is started
- can be used in expansions. Variables defined in the
- configuration file itself, for example with <code class="directive"><a href="./mod/mod_env.html#setenv">SetEnv</a></code>, take effect too late to be
- used for expansions in the configuration file.</p>
+ were found directly in the configuration file. Variables defined with
+ <code class="directive"><a href="./mod/core.html#define">Define</a></code> take precedence over shell
+ environment variables. If the "VAR" variable is not found, the characters
+ <code>${VAR}</code> are left unchanged, and a warning is logged. Variable
+ names may not contain colon ":" characters, to avoid clashes with
+ <code class="directive"><a href="./mod/mod_rewrite.html#rewritemap">RewriteMap</a></code>'s syntax.</p>
+
+ <p>Only shell environment variables defined before the server is started
+ can be used in expansions. Environment variables defined in the
+ configuration file itself, for example with <code class="directive"><a href="./mod/mod_env.html# setenv">
+ SetEnv</a></code>, take effect too late to be used for expansions in the
+ configuration file.</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>
+ 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
Modified: httpd/httpd/trunk/docs/manual/configuring.xml
URL: http://svn.apache.org/viewvc/httpd/httpd/trunk/docs/manual/configuring.xml?rev=1061758&r1=1061757&r2=1061758&view=diff
==============================================================================
--- httpd/httpd/trunk/docs/manual/configuring.xml (original)
+++ httpd/httpd/trunk/docs/manual/configuring.xml Fri Jan 21 11:32:13 2011
@@ -77,25 +77,28 @@ Server.</p>
and white space occurring before a directive are ignored, so
you may indent directives for clarity.</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 values of variables defined with the <directive
+ module="core">Define</directive> of or shell environment variables can
+ be used in configuration file lines using the syntax <code>${VAR}</code>.
+ If "VAR" is the name of a valid 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.
+ Variables defined with <directive module="core">Define</directive> take
+ precedence over shell environment variables.
+ If the "VAR" variable is not found, the characters <code>${VAR}</code>
+ are left unchanged, and a warning is logged.
+ Variable names may not contain colon ":" characters, to avoid clashes with
+ <directive module="mod_rewrite">RewriteMap</directive>'s syntax.</p>
- <p>Only environment variables defined before the server is started
- can be used in expansions. Variables defined in the
+ <p>Only shell environment variables defined before the server is started
+ can be used in expansions. Environment variables defined in the
configuration file itself, for example with <directive
- module="mod_env">SetEnv</directive>, take effect too late to be
- used for expansions in the configuration file.</p>
+ module="mod_env">SetEnv</directive>, take effect too late to be used for
+ expansions in the configuration file.</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>
+ 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
Modified: httpd/httpd/trunk/docs/manual/mod/core.html.en
URL: http://svn.apache.org/viewvc/httpd/httpd/trunk/docs/manual/mod/core.html.en?rev=1061758&r1=1061757&r2=1061758&view=diff
==============================================================================
--- httpd/httpd/trunk/docs/manual/mod/core.html.en (original)
+++ httpd/httpd/trunk/docs/manual/mod/core.html.en Fri Jan 21 11:32:13 2011
@@ -621,6 +621,9 @@ which no other media type configuration
</IfDefine><br />
</code></p></div>
+ <p>Variable names may not contain colon ":" characters, to avoid clashes
+ with <code class="directive"><a href="../mod/mod_rewrite.html#rewritemap">RewriteMap</a></code>'s syntax.</p>
+
</div>
<div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
<div class="directive-section"><h2><a name="Directory" id="Directory"><Directory></a> <a name="directory" id="directory">Directive</a></h2>
Modified: httpd/httpd/trunk/docs/manual/mod/core.xml
URL: http://svn.apache.org/viewvc/httpd/httpd/trunk/docs/manual/mod/core.xml?rev=1061758&r1=1061757&r2=1061758&view=diff
==============================================================================
--- httpd/httpd/trunk/docs/manual/mod/core.xml (original)
+++ httpd/httpd/trunk/docs/manual/mod/core.xml Fri Jan 21 11:32:13 2011
@@ -565,6 +565,9 @@ which no other media type configuration
Define SSL<br/>
</IfDefine><br/>
</example>
+
+ <p>Variable names may not contain colon ":" characters, to avoid clashes
+ with <directive module="mod_rewrite">RewriteMap</directive>'s syntax.</p>
</usage>
</directivesynopsis>