Some details on mod_rewrite variables.

Submitted by:	Miguel Cruz <mnc@un.u.nu>

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

diff --git a/docs/manual/mod/mod_rewrite.html b/docs/manual/mod/mod_rewrite.html
index 52bdb988b39e1f460b4f384d8c269d28d5ddffb3..812e755ccc03afe20d2c03801bf6a3d4bc19c536 100644 (file)
--- a/docs/manual/mod/mod_rewrite.html
+++ b/docs/manual/mod/mod_rewrite.html
@@ -1137,9 +1137,42 @@ IS_SUBREQ<BR>
 <P>
 <TABLE WIDTH="70%" BORDER=0 BGCOLOR="#E0E0F0" CELLSPACING=0 CELLPADDING=10>
 <TR><TD>
-<STRONG>Notice:</STRONG> These variables all correspond to the similarly named
-HTTP MIME-headers, C variables of the Apache server or <CODE>struct tm</CODE>
-fields of the Unix system.
+
+<p><STRONG>Notice:</STRONG> These variables all correspond to
+the similarly named HTTP MIME-headers, C variables of the Apache
+server or <CODE>struct tm</CODE> fields of the Unix system.  Most
+are documented elsewhere in the Manual or in the CGI specification.
+Those that are special to mod_rewrite include:</p>
+
+<dl>
+<dt><code>IS_SUBREQ</code></dt>
+<dd>Will contain the text "true" if the request currently
+being processed is a sub-request, "false" otherwise. Sub-requests may
+be generated by modules that need to resolve additional files or URIs
+in order to complete their tasks.</dd>
+
+<dt><code>API_VERSION</code></dt> 
+<dd>This is the version of the Apache module API (the internal
+interface between server and module) in the current httpd build, as
+defined in include/ap_mmn.h. The module API version corresponds to the
+version of Apache in use (in the release version of Apache 1.3.14, for
+instance, it is 19990320:10), but is mainly of interest to module
+authors.</dd>
+
+<dt><code>THE_REQUEST</code></dt> 
+<dd>The full HTTP request line sent by the browser to the server
+(e.g., "<code>GET /index.html HTTP/1.1</code>"). This does not include
+any additional headers sent by the browser.</dd>
+
+<dt><code>REQUEST_URI</code></dt>
+<dd>The resource requested in the HTTP request line. (In the
+example above, this would be "/index.html".)</dd>
+
+<dt><code>REQUEST_FILENAME</code></dt>
+<dd>The full local filesystem path to the file or script
+matching the request.</dd>
+</dl>
+
 </TD></TR>
 </TABLE>