From: Luca Toscano <elukey@apache.org>
Date: Wed, 27 Jan 2016 21:48:28 +0000 (+0000)
Subject: Added more env variables to the mod_cgi's documentation.
X-Git-Tag: 2.5.0-alpha~2260
X-Git-Url: https://granicus.if.org/sourcecode?a=commitdiff_plain;h=565cfcba1ae025cb64fa9bd33d18a9e1b9e98e9f;p=apache

Added more env variables to the mod_cgi's documentation.
Bugs: 58305/58306



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

diff --git a/docs/manual/mod/mod_cgi.html.en b/docs/manual/mod/mod_cgi.html.en
index e07aba715a..ddea09f1a6 100644
--- a/docs/manual/mod/mod_cgi.html.en
+++ b/docs/manual/mod/mod_cgi.html.en
@@ -120,9 +120,26 @@
     <p>This module also leverages the core functions 
        <a href="https://ci.apache.org/projects/httpd/trunk/doxygen/group__APACHE__CORE__SCRIPT.html#ga0e81f9571a8a73f5da0e89e1f46d34b1">ap_add_common_vars</a> and 
        <a href="https://ci.apache.org/projects/httpd/trunk/doxygen/group__APACHE__CORE__SCRIPT.html#ga6b975cd7ff27a338cb8752381a4cc14f">ap_add_cgi_vars</a> 
-       to add common CGI environment variables like <code>DOCUMENT_ROOT</code> 
-       (this one from the related <code class="directive"><a href="../mod/core.html#documentroot">DocumentRoot</a></code> directive). 
-       For an exhaustive list please check the code in the appropriate httpd branch.  
+       to add environment variables like:</p> 
+       <dl>
+           <dt>DOCUMENT_ROOT</dt>
+
+           <dd>Set with the content of the related <code class="directive"><a href="../mod/core.html#documentroot">DocumentRoot</a></code> directive.</dd>
+
+           <dt>SERVER_NAME</dt>
+
+           <dd>The fully qualified domain name related to the request.</dd>
+
+           <dt>SERVER_ADDR</dt>
+
+           <dd>The IP address of the Virtual Host serving the request.</dd>
+
+           <dt>SERVER_ADMIN</dt>
+
+           <dd>Set with the content of the related <code class="directive"><a href="../mod/core.html#serveradmin">ServerAdmin</a></code> directive.</dd>
+      </dl>
+    <p>For an exhaustive list it is suggested to write a basic CGI script 
+       that dumps all the environment variables passed by Apache in a convenient format.
     </p>   
 </div><div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
 <div class="section">
diff --git a/docs/manual/mod/mod_cgi.xml b/docs/manual/mod/mod_cgi.xml
index e7035c2f25..aa7dd93943 100644
--- a/docs/manual/mod/mod_cgi.xml
+++ b/docs/manual/mod/mod_cgi.xml
@@ -105,9 +105,26 @@
     <p>This module also leverages the core functions 
        <a href="https://ci.apache.org/projects/httpd/trunk/doxygen/group__APACHE__CORE__SCRIPT.html#ga0e81f9571a8a73f5da0e89e1f46d34b1">ap_add_common_vars</a> and 
        <a href="https://ci.apache.org/projects/httpd/trunk/doxygen/group__APACHE__CORE__SCRIPT.html#ga6b975cd7ff27a338cb8752381a4cc14f">ap_add_cgi_vars</a> 
-       to add common CGI environment variables like <code>DOCUMENT_ROOT</code> 
-       (this one from the related <directive module="core">DocumentRoot</directive> directive). 
-       For an exhaustive list please check the code in the appropriate httpd branch.  
+       to add environment variables like:</p> 
+       <dl>
+           <dt>DOCUMENT_ROOT</dt>
+
+           <dd>Set with the content of the related <directive module="core">DocumentRoot</directive> directive.</dd>
+
+           <dt>SERVER_NAME</dt>
+
+           <dd>The fully qualified domain name related to the request.</dd>
+
+           <dt>SERVER_ADDR</dt>
+
+           <dd>The IP address of the Virtual Host serving the request.</dd>
+
+           <dt>SERVER_ADMIN</dt>
+
+           <dd>Set with the content of the related <directive module="core">ServerAdmin</directive> directive.</dd>
+      </dl>
+    <p>For an exhaustive list it is suggested to write a basic CGI script 
+       that dumps all the environment variables passed by Apache in a convenient format.
     </p>   
 </section>