You are viewing a plain text version of this content. The canonical link for it is here.
Posted to cvs@httpd.apache.org by no...@apache.org on 2009/11/02 23:05:02 UTC
svn commit: r832130 - in /httpd/httpd/trunk/docs/manual/mod:
mod_rewrite.html.en mod_rewrite.xml
Author: noirin
Date: Mon Nov 2 22:05:01 2009
New Revision: 832130
URL: http://svn.apache.org/viewvc?rev=832130&view=rev
Log:
Ripping out the stuff that isn't really module reference, and translating the
introduction to English
Modified:
httpd/httpd/trunk/docs/manual/mod/mod_rewrite.html.en
httpd/httpd/trunk/docs/manual/mod/mod_rewrite.xml
Modified: httpd/httpd/trunk/docs/manual/mod/mod_rewrite.html.en
URL: http://svn.apache.org/viewvc/httpd/httpd/trunk/docs/manual/mod/mod_rewrite.html.en?rev=832130&r1=832129&r2=832130&view=diff
==============================================================================
--- httpd/httpd/trunk/docs/manual/mod/mod_rewrite.html.en (original)
+++ httpd/httpd/trunk/docs/manual/mod/mod_rewrite.html.en Mon Nov 2 22:05:01 2009
@@ -32,24 +32,22 @@
<tr><th><a href="module-dict.html#Compatibility">Compatibility:</a></th><td>Available in Apache 1.3 and later</td></tr></table>
<h3>Summary</h3>
- <p>This module uses a rule-based rewriting engine (based on a
- regular-expression parser) to rewrite requested URLs on the
- fly. It supports an unlimited number of rules and an
- unlimited number of attached rule conditions for each rule, to
- provide a really flexible and powerful URL manipulation
- mechanism. The URL manipulations can depend on various tests,
- of server variables, environment variables, HTTP
- headers, or time stamps. Even external database lookups in
- various formats can be used to achieve highly granular URL
- matching.</p>
-
- <p>This module operates on the full URLs (including the
- path-info part) both in per-server context
- (<code>httpd.conf</code>) and per-directory context
- (<code>.htaccess</code>) and can generate query-string
- parts on result. The rewritten result can lead to internal
- sub-processing, external request redirection or even to an
- internal proxy throughput.</p>
+ <p>The <code class="module"><a href="../mod/mod_rewrite.html">mod_rewrite</a></code> module uses a rule-based rewriting
+ engine, based on a regular-expression parser, to rewrite requested URLs on
+ the fly. By default, <code class="module"><a href="../mod/mod_rewrite.html">mod_rewrite</a></code> maps a URL to a filesystem
+ path. However, it can also be used to redirect one URL to another URL, or
+ to invoke an internal proxy fetch.</p>
+ <p><code class="module"><a href="../mod/mod_rewrite.html">mod_rewrite</a></code> provides a flexible and powerful way to
+ manipulate URLs using an unlimited number of rules. Each rule can have an
+ unlimited number of attached rule conditions, to allow you to rewrite URL
+ based on server variables, environment variables, HTTP headers, or time
+ stamps.</p>
+ <p><code class="module"><a href="../mod/mod_rewrite.html">mod_rewrite</a></code> operates on the full URL path, including the
+ path-info section. A rewrite rule can be invoked in
+ <code>httpd.conf</code> or in <code>.htaccess</code>. The path generated
+ by a rewrite rule can include a query string, or can lead to internal
+ sub-processing, external request redirection, or internal proxy
+ throughput.</p>
<p>Further details, discussion, and examples, are provided in the
<a href="../rewrite/">detailed mod_rewrite documentation</a>.</p>
@@ -66,80 +64,8 @@
<li><img alt="" src="../images/down.gif" /> <a href="#rewriteoptions">RewriteOptions</a></li>
<li><img alt="" src="../images/down.gif" /> <a href="#rewriterule">RewriteRule</a></li>
</ul>
-<h3>Topics</h3>
-<ul id="topics">
-<li><img alt="" src="../images/down.gif" /> <a href="#quoting">Quoting Special Characters</a></li>
-<li><img alt="" src="../images/down.gif" /> <a href="#EnvVar">Environment Variables</a></li>
-<li><img alt="" src="../images/down.gif" /> <a href="#vhosts">Rewriting in Virtual Hosts</a></li>
-<li><img alt="" src="../images/down.gif" /> <a href="#Solutions">Practical Solutions</a></li>
-</ul><h3>See also</h3>
-<ul class="seealso">
-<li><a href="#rewriteflags">Rewrite Flags</a></li>
-</ul></div>
-<div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
-<div class="section">
-<h2><a name="quoting" id="quoting">Quoting Special Characters</a></h2>
-
- <p>As of Apache 1.3.20, special characters in
- <em>TestString</em> and <em>Substitution</em> strings can be
- escaped (that is, treated as normal characters without their
- usual special meaning) by prefixing them with a slash ('\')
- character. In other words, you can include an actual
- dollar-sign character in a <em>Substitution</em> string by
- using '<code>\$</code>'; this keeps mod_rewrite from trying
- to treat it as a backreference.</p>
-</div><div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
-<div class="section">
-<h2><a name="EnvVar" id="EnvVar">Environment Variables</a></h2>
-
- <p>This module keeps track of two additional (non-standard)
- CGI/SSI environment variables named <code>SCRIPT_URL</code>
- and <code>SCRIPT_URI</code>. These contain the
- <em>logical</em> Web-view to the current resource, while the
- standard CGI/SSI variables <code>SCRIPT_NAME</code> and
- <code>SCRIPT_FILENAME</code> contain the <em>physical</em>
- System-view. </p>
-
- <p>Notice: These variables hold the URI/URL <em>as they were
- initially requested</em>, that is, <em>before</em> any
- rewriting. This is important to note because the rewriting process is
- primarily used to rewrite logical URLs to physical
- pathnames.<br />
- These variables are set in per-server context, which means
- that they are available in per-directory context only, if
- <code class="directive">RewriteEngine</code> is set to <code>on</code> in
- per-server context.</p>
-
-<div class="example"><h3>Example</h3><pre>
-SCRIPT_NAME=/sw/lib/w3s/tree/global/u/rse/.www/index.html
-SCRIPT_FILENAME=/u/rse/.www/index.html
-SCRIPT_URL=/u/rse/
-SCRIPT_URI=http://en1.engelschall.com/u/rse/
-</pre></div>
-
-</div><div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
-<div class="section">
-<h2><a name="vhosts" id="vhosts">Rewriting in Virtual Hosts</a></h2>
-
- <p>By default, <code class="module"><a href="../mod/mod_rewrite.html">mod_rewrite</a></code> configuration
- settings from the main server context are not inherited by
- virtual hosts. To make the main server settings apply to virtual
- hosts, you must place the following directives in each <code class="directive"><a href="../mod/core.html#virtualhost"><VirtualHost></a></code> section:</p>
-
- <div class="example"><p><code>
- RewriteEngine On<br />
- RewriteOptions Inherit
- </code></p></div>
-</div><div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
-<div class="section">
-<h2><a name="Solutions" id="Solutions">Practical Solutions</a></h2>
-
- <p>For numerous examples of common, and not-so-common, uses for
- mod_rewrite, see the <a href="../rewrite/rewrite_guide.html">Rewrite
- Guide</a>, and the <a href="../rewrite/rewrite_guide_advanced.html">Advanced Rewrite
- Guide</a> documents.</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="RewriteBase" id="RewriteBase">RewriteBase</a> <a name="rewritebase" id="rewritebase">Directive</a></h2>
<table class="directive">
@@ -1473,7 +1399,7 @@
Alias /def /ghi
</code></p></div>
If you omit the <code>PT</code> flag,
- <code>mod_rewrite</code> will rewrite
+ <code class="module"><a href="../mod/mod_rewrite.html">mod_rewrite</a></code> will rewrite
<code>uri=/abc/...</code> to
<code>filename=/def/...</code> as a full API-compliant
URI-to-filename translator should do. Then
Modified: httpd/httpd/trunk/docs/manual/mod/mod_rewrite.xml
URL: http://svn.apache.org/viewvc/httpd/httpd/trunk/docs/manual/mod/mod_rewrite.xml?rev=832130&r1=832129&r2=832130&view=diff
==============================================================================
--- httpd/httpd/trunk/docs/manual/mod/mod_rewrite.xml (original)
+++ httpd/httpd/trunk/docs/manual/mod/mod_rewrite.xml Mon Nov 2 22:05:01 2009
@@ -33,97 +33,27 @@
<compatibility>Available in Apache 1.3 and later</compatibility>
<summary>
- <p>This module uses a rule-based rewriting engine (based on a
- regular-expression parser) to rewrite requested URLs on the
- fly. It supports an unlimited number of rules and an
- unlimited number of attached rule conditions for each rule, to
- provide a really flexible and powerful URL manipulation
- mechanism. The URL manipulations can depend on various tests,
- of server variables, environment variables, HTTP
- headers, or time stamps. Even external database lookups in
- various formats can be used to achieve highly granular URL
- matching.</p>
-
- <p>This module operates on the full URLs (including the
- path-info part) both in per-server context
- (<code>httpd.conf</code>) and per-directory context
- (<code>.htaccess</code>) and can generate query-string
- parts on result. The rewritten result can lead to internal
- sub-processing, external request redirection or even to an
- internal proxy throughput.</p>
+ <p>The <module>mod_rewrite</module> module uses a rule-based rewriting
+ engine, based on a regular-expression parser, to rewrite requested URLs on
+ the fly. By default, <module>mod_rewrite</module> maps a URL to a filesystem
+ path. However, it can also be used to redirect one URL to another URL, or
+ to invoke an internal proxy fetch.</p>
+ <p><module>mod_rewrite</module> provides a flexible and powerful way to
+ manipulate URLs using an unlimited number of rules. Each rule can have an
+ unlimited number of attached rule conditions, to allow you to rewrite URL
+ based on server variables, environment variables, HTTP headers, or time
+ stamps.</p>
+ <p><module>mod_rewrite</module> operates on the full URL path, including the
+ path-info section. A rewrite rule can be invoked in
+ <code>httpd.conf</code> or in <code>.htaccess</code>. The path generated
+ by a rewrite rule can include a query string, or can lead to internal
+ sub-processing, external request redirection, or internal proxy
+ throughput.</p>
<p>Further details, discussion, and examples, are provided in the
<a href="../rewrite/">detailed mod_rewrite documentation</a>.</p>
</summary>
-<seealso><a href="#rewriteflags">Rewrite Flags</a></seealso>
-
-<section id="quoting"><title>Quoting Special Characters</title>
-
- <p>As of Apache 1.3.20, special characters in
- <em>TestString</em> and <em>Substitution</em> strings can be
- escaped (that is, treated as normal characters without their
- usual special meaning) by prefixing them with a slash ('\')
- character. In other words, you can include an actual
- dollar-sign character in a <em>Substitution</em> string by
- using '<code>\$</code>'; this keeps mod_rewrite from trying
- to treat it as a backreference.</p>
-</section>
-
-<section id="EnvVar"><title>Environment Variables</title>
-
- <p>This module keeps track of two additional (non-standard)
- CGI/SSI environment variables named <code>SCRIPT_URL</code>
- and <code>SCRIPT_URI</code>. These contain the
- <em>logical</em> Web-view to the current resource, while the
- standard CGI/SSI variables <code>SCRIPT_NAME</code> and
- <code>SCRIPT_FILENAME</code> contain the <em>physical</em>
- System-view. </p>
-
- <p>Notice: These variables hold the URI/URL <em>as they were
- initially requested</em>, that is, <em>before</em> any
- rewriting. This is important to note because the rewriting process is
- primarily used to rewrite logical URLs to physical
- pathnames.<br />
- These variables are set in per-server context, which means
- that they are available in per-directory context only, if
- <directive>RewriteEngine</directive> is set to <code>on</code> in
- per-server context.</p>
-
-<example><title>Example</title>
-<pre>
-SCRIPT_NAME=/sw/lib/w3s/tree/global/u/rse/.www/index.html
-SCRIPT_FILENAME=/u/rse/.www/index.html
-SCRIPT_URL=/u/rse/
-SCRIPT_URI=http://en1.engelschall.com/u/rse/
-</pre>
-</example>
-
-</section>
-
-<section id="vhosts"><title>Rewriting in Virtual Hosts</title>
-
- <p>By default, <module>mod_rewrite</module> configuration
- settings from the main server context are not inherited by
- virtual hosts. To make the main server settings apply to virtual
- hosts, you must place the following directives in each <directive
- module="core" type="section">VirtualHost</directive> section:</p>
-
- <example>
- RewriteEngine On<br />
- RewriteOptions Inherit
- </example>
-</section>
-
-<section id="Solutions"><title>Practical Solutions</title>
-
- <p>For numerous examples of common, and not-so-common, uses for
- mod_rewrite, see the <a href="../rewrite/rewrite_guide.html">Rewrite
- Guide</a>, and the <a
- href="../rewrite/rewrite_guide_advanced.html">Advanced Rewrite
- Guide</a> documents.</p>
-
-</section>
<directivesynopsis>
<name>RewriteEngine</name>
@@ -1489,7 +1419,7 @@
Alias /def /ghi
</example>
If you omit the <code>PT</code> flag,
- <code>mod_rewrite</code> will rewrite
+ <module>mod_rewrite</module> will rewrite
<code>uri=/abc/...</code> to
<code>filename=/def/...</code> as a full API-compliant
URI-to-filename translator should do. Then
Re: svn commit: r832130 - in /httpd/httpd/trunk/docs/manual/mod:
mod_rewrite.html.en mod_rewrite.xml
Posted by Bob Ionescu <bo...@googlemail.com>.
2009/11/2 <no...@apache.org>:
> Author: noirin
> Date: Mon Nov 2 22:05:01 2009
> New Revision: 832130
>
> URL: http://svn.apache.org/viewvc?rev=832130&view=rev
> Log:
> Ripping out the stuff that isn't really module reference, and translating the
> introduction to English
>
> Modified:
> httpd/httpd/trunk/docs/manual/mod/mod_rewrite.html.en
> httpd/httpd/trunk/docs/manual/mod/mod_rewrite.xml
[...]
> -<h2><a name="EnvVar" id="EnvVar">Environment Variables</a></h2>
> -
> - <p>This module keeps track of two additional (non-standard)
> - CGI/SSI environment variables named <code>SCRIPT_URL</code>
> - and <code>SCRIPT_URI</code>. These contain the
> - <em>logical</em> Web-view to the current resource, while the
> - standard CGI/SSI variables <code>SCRIPT_NAME</code> and
> - <code>SCRIPT_FILENAME</code> contain the <em>physical</em>
> - System-view. </p>
> -
> - <p>Notice: These variables hold the URI/URL <em>as they were
> - initially requested</em>, that is, <em>before</em> any
> - rewriting. This is important to note because the rewriting process is
> - primarily used to rewrite logical URLs to physical
> - pathnames.<br />
> - These variables are set in per-server context, which means
> - that they are available in per-directory context only, if
> - <code class="directive">RewriteEngine</code> is set to <code>on</code> in
> - per-server context.</p>
I think this should go somewhere else (may be env.xml?), otherwise it
is undocumented that mod_rewrite adds the special non-standard ENVs
SCRIPT_URL and SCRIPT_URI to the internal env table when used in
server context.
Bob
---------------------------------------------------------------------
To unsubscribe, e-mail: docs-unsubscribe@httpd.apache.org
For additional commands, e-mail: docs-help@httpd.apache.org