]> granicus.if.org Git - apache/commitdiff
PR50382: explain in mod_env documentation that these environment variables aren...
authorEric Covener <covener@apache.org>
Tue, 30 Nov 2010 13:48:55 +0000 (13:48 +0000)
committerEric Covener <covener@apache.org>
Tue, 30 Nov 2010 13:48:55 +0000 (13:48 +0000)
(short rehash of info in env.html)

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

docs/manual/mod/mod_env.xml
docs/manual/mod/mod_setenvif.xml

index f845063f0ee4c9f402df9267fc8de7bb4dfed280..97bac32d8e8d2f066d08acf0a0094bb779e1348c 100644 (file)
@@ -29,13 +29,15 @@ SSI pages</description>
 <sourcefile>mod_env.c</sourcefile>
 <identifier>env_module</identifier>
 <summary>
-    <p>This module allows for control of the environment that will
-    be provided to CGI scripts and SSI pages. Environment variables
-    may be passed from the shell which invoked the <program>httpd</program>
-    process. Alternatively, environment variables may be set or unset within
-    the configuration process.</p>
+    <p>This module allows for control of internal environment variables that
+    are used by various Apache HTTP Server modules. These variables are also
+    provided to CGI scripts as native system environment variables, and available
+    for use in SSI pages. Environment variables may be passed from the shell 
+    which invoked the <program>httpd</program> process. Alternatively, 
+    environment variables may be set or unset within the configuration process.</p>
 </summary>
 <seealso><a href="../env.html">Environment Variables</a></seealso>
+<seealso><directive module="mod_setenvif">SetEnvIf</directive></seealso>
 
 <directivesynopsis>
 <name>PassEnv</name>
@@ -47,9 +49,11 @@ SSI pages</description>
 <override>FileInfo</override>
 
 <usage>
-    <p>Specifies one or more environment variables to pass to CGI
-    scripts and SSI pages from the environment of the shell which
-    invoked the <program>httpd</program> process.</p>
+    <p>Specifies one or more native system environment variables to make available
+    as internal environment variables, which are available to Apache HTTP Server modules
+    as well as propogated to CGI scripts and SSI pages. Values come from the 
+    native OS environment of the shell which invoked the 
+    <program>httpd</program> process.</p>
 
     <example><title>Example</title>
       PassEnv LD_LIBRARY_PATH
@@ -66,8 +70,8 @@ SSI pages</description>
 <override>FileInfo</override>
 
 <usage>
-    <p>Sets an environment variable, which is then passed on to CGI
-    scripts and SSI pages.</p>
+    <p>Sets an internal environment variable, which is then available to Apache 
+    HTTP Server modules, and passed on to CGI scripts and SSI pages.</p>
 
     <example><title>Example</title>
       SetEnv SPECIAL_PATH /foo/bin
@@ -83,6 +87,7 @@ SSI pages</description>
     </note>
      
 </usage>
+<seealso><a href="../env.html">Environment Variables</a></seealso>
 </directivesynopsis>
 
 <directivesynopsis>
@@ -95,7 +100,7 @@ SSI pages</description>
 <override>FileInfo</override>
 
 <usage>
-    <p>Removes one or more environment variables from those passed
+    <p>Removes one or more internal environment variables from those passed
     on to CGI scripts and SSI pages.</p>
 
     <example><title>Example</title>
index c970500312f09c080ffa09480329b0c6bb33a907..d1a101b4a9c20ec47b6522ec9ca2bc585d347e60 100644 (file)
@@ -33,10 +33,11 @@ on characteristics of the request</description>
 <summary>
 
     <p>The <module>mod_setenvif</module> module allows you to set
-    environment variables according to whether different aspects of
+    internal environment variables according to whether different aspects of
     the request match regular expressions you specify. These
     environment variables can be used by other parts of the server
-    to make decisions about actions to be taken.</p>
+    to make decisions about actions to be taken, as well as becoming
+    available to CGI scripts and SSI pages.</p>
 
     <p>The directives are considered in the order they appear in
     the configuration files. So more complex sequences can be used,