]> granicus.if.org Git - apache/commitdiff
Add some <glossary> markup for regular expression and regex.
authorJoshua Slive <slive@apache.org>
Wed, 21 Sep 2005 15:21:09 +0000 (15:21 +0000)
committerJoshua Slive <slive@apache.org>
Wed, 21 Sep 2005 15:21:09 +0000 (15:21 +0000)
git-svn-id: https://svn.apache.org/repos/asf/httpd/httpd/trunk@290723 13f79535-47bb-0310-9956-ffa450edef68

13 files changed:
docs/manual/caching.xml
docs/manual/mod/core.xml
docs/manual/mod/directive-dict.xml
docs/manual/mod/mod_alias.xml
docs/manual/mod/mod_filter.xml
docs/manual/mod/mod_headers.xml
docs/manual/mod/mod_proxy.xml
docs/manual/mod/mod_rewrite.xml
docs/manual/mod/mod_setenvif.xml
docs/manual/mod/mod_version.xml
docs/manual/mpm.xml
docs/manual/sections.xml
docs/manual/urlmapping.xml

index c6d6a5536d80fbdd92fe5f2e26ba1e6b265d35e3..2ac84e8f92967547a769c3a114556d81b1d80cc7 100644 (file)
   <section id="introduction">
     <title>Introduction</title>
 
-    <p>As of Apache HTTP server version 2.2 <module>mod_cache</module> and 
-    <module>mod_file_cache</module> are no longer marked experimental and are 
-    considered suitable for production use. These caching architectures provide
-    a powerful means to accelerate HTTP handling, both as a webserver and as a 
-    proxy.</p>
+    <p>As of Apache HTTP server version 2.2 <module>mod_cache</module>
+    and <module>mod_file_cache</module> are no longer marked
+    experimental and are considered suitable for production use. These
+    caching architectures provide a powerful means to accelerate HTTP
+    handling, both as an origin webserver and as a proxy.</p>
 
     <p><module>mod_cache</module> and its provider modules 
     <module>mod_mem_cache</module> and <module>mod_disk_cache</module> 
@@ -58,7 +58,7 @@
     the complexity of actively ensuring the cachability of URLs,
     <module>mod_file_cache</module> offers file-handle and memory-mapping 
     tricks to keep a cache of files as they were when Apache was last 
-    started. As such <module>mod_file_cache</module> is aimed at improving 
+    started. As such, <module>mod_file_cache</module> is aimed at improving 
     the access time to local static files which do not change very
     often.</p>
 
       </directivelist>
     </related>
 
-    <p>There are two main stages in <module>mod_cache</module> which can
+    <p>There are two main stages in <module>mod_cache</module> that can
     occur in the lifetime of a request. First, <module>mod_cache</module>
     is a URL mapping module, which means that if a URL has been cached,
     and the cached version of that URL has not expired, the request will 
     be served directly by <module>mod_cache</module>.</p>
 
-    <p>This means that any other stages with might ordinarily happen in the 
-    process of serving a request, for example being handled by 
-    <module>mod_proxy</module>, or <module>mod_rewrite</module> won't happen. 
-    But then this is the point of caching content in the first place.</p>
+    <p>This means that any other stages that might ordinarily happen
+    in the process of serving a request -- for example being handled
+    by <module>mod_proxy</module>, or <module>mod_rewrite</module> --
+    won't happen.  But then this is the point of caching content in
+    the first place.</p>
 
     <p>If the URL is not found within the cache, <module>mod_cache</module>
     will add a <a href="filter.html">filter</a> to the request handling. After
index 33fc48b63f58f0a455ab21290eed297fab01b7dc..57d4699cc1090716c13a3c8c58160437f5a58efd 100644 (file)
@@ -645,8 +645,8 @@ named file-system directory and sub-directories</description>
       links.</p>
     </note>
 
-    <p>Extended regular
-    expressions can also be used, with the addition of the
+    <p><glossary ref="regex">Regular
+    expressions</glossary> can also be used, with the addition of the
     <code>~</code> character. For example:</p>
 
     <example>
@@ -761,7 +761,8 @@ subdirectories</description>
     of directives which will apply only to the named directory and
     sub-directories of that directory, the same as <directive
     module="core" type="section">Directory</directive>. However, it
-    takes as an argument a regular expression. For example:</p>
+    takes as an argument a <glossary ref="regex">regular 
+    expression</glossary>. For example:</p>
 
     <example>
       &lt;DirectoryMatch "^/www/(.+/)?[0-9]{3}"&gt;
@@ -1161,8 +1162,9 @@ filenames</description>
 
     <p>The <var>filename</var> argument should include a filename, or
     a wild-card string, where <code>?</code> matches any single character,
-    and <code>*</code> matches any sequences of characters. Extended regular
-    expressions can also be used, with the addition of the
+    and <code>*</code> matches any sequences of characters.
+    <glossary ref="regex">Regular expressions</glossary> 
+    can also be used, with the addition of the
     <code>~</code> character. For example:</p>
 
     <example>
@@ -1200,7 +1202,8 @@ filenames</description>
     <p>The <directive type="section">FilesMatch</directive> directive
     limits the scope of the enclosed directives by filename, just as the
     <directive module="core" type="section">Files</directive> directive
-    does. However, it accepts a regular expression. For example:</p>
+    does. However, it accepts a <glossary ref="regex">regular 
+    expression</glossary>. For example:</p>
 
     <example>
       &lt;FilesMatch "\.(gif|jpe?g|png)$"&gt;
@@ -1890,8 +1893,8 @@ URLs</description>
     any single character, and <code>*</code> matches any sequences of
     characters.</p>
 
-    <p>Extended regular
-    expressions can also be used, with the addition of the
+    <p><glossary ref="regex">Regular expressions</glossary>
+    can also be used, with the addition of the
     <code>~</code> character. For example:</p>
 
     <example>
@@ -1961,8 +1964,8 @@ matching URLs</description>
     <p>The <directive type="section">LocationMatch</directive> directive
     limits the scope of the enclosed directives by URL, in an identical manner
     to <directive module="core" type="section">Location</directive>. However,
-    it takes a regular expression as an argument instead of a simple
-    string. For example:</p>
+    it takes a <glossary ref="regex">regular expression</glossary>
+    as an argument instead of a simple string. For example:</p>
 
     <example>
       &lt;LocationMatch "/(extra|special)/data"&gt;
index 8ae121370f27ebe2812c80e3904dda4e75d19247..d0ffff5b63ba1f84d98d68afc349d2cc4ac7d601 100644 (file)
@@ -92,8 +92,8 @@
 
       <dt><em>regex</em></dt>
 
-      <dd>A Perl-compatible <a href="../glossary.html#regex">regular
-      expression</a>. The directive definition will specify what the
+      <dd>A Perl-compatible <glossary ref="regex">regular
+      expression</glossary>. The directive definition will specify what the
       <em>regex</em> is matching against.</dd>
 
       <dt><em>extension</em></dt>
index 2bcb910282c8368c8118d9072e99b5ff61bd1221..2b40b8bc082c399723a7c2fdabd56ca8d988159f 100644 (file)
@@ -159,8 +159,9 @@ expressions</description>
 
 <usage>
     <p>This directive is equivalent to <directive
-    module="mod_alias">Alias</directive>, but makes use of standard
-    regular expressions, instead of simple prefix matching. The
+    module="mod_alias">Alias</directive>, but makes use of 
+    <glossary ref="regex">regular expressions</glossary>, 
+    instead of simple prefix matching. The
     supplied regular expression is matched against the URL-path, and
     if it matches, the server will substitute any parenthesized
     matches into the given string and use it as a filename. For
@@ -266,8 +267,9 @@ of the current URL</description>
 
 <usage>
     <p>This directive is equivalent to <directive
-    module="mod_alias">Redirect</directive>, but makes use of standard
-    regular expressions, instead of simple prefix matching. The
+    module="mod_alias">Redirect</directive>, but makes use of 
+    <glossary ref="regex">regular expressions</glossary>, 
+    instead of simple prefix matching. The
     supplied regular expression is matched against the URL-path, and
     if it matches, the server will substitute any parenthesized
     matches into the given string and use it as a filename. For
@@ -351,8 +353,9 @@ and designates the target as a CGI script</description>
 
 <usage>
     <p>This directive is equivalent to <directive module="mod_alias"
-    >ScriptAlias</directive>, but makes use of standard
-    regular expressions, instead of simple prefix matching. The
+    >ScriptAlias</directive>, but makes use of 
+    <glossary ref="regex">regular expressions</glossary>, 
+    instead of simple prefix matching. The
     supplied regular expression is matched against the URL-path,
     and if it matches, the server will substitute any parenthesized
     matches into the given string and use it as a filename. For
index 8e2231ee06fa7f17021cf1b56ec283023a915d80..ad15c8c26e0f82f36174b2d47f38f631c8439d60 100644 (file)
 
     <p>The <var>match</var> argument specifies a match that will be applied to
     the filter's <var>dispatch</var> criterion.  The <var>match</var> may be
-    a string match (exact match or substring), a regexp, an integer (greater,
+    a string match (exact match or substring), a <glossary>regex</glossary>, 
+    an integer (greater,
     lessthan or equals), or unconditional.  The first characters of the
     <var>match</var> argument determines this:</p>
 
     <tr><th>Character</th><th>Description</th></tr>
     <tr><td><em>(none)</em></td><td>exact match</td></tr>
     <tr><td><code>$</code></td><td>substring match</td></tr>
-    <tr><td><code>/</code></td><td>regexp match (delimited by a second <code>/</code>)</td></tr>
+    <tr><td><code>/</code></td><td>regex match (delimited by a second <code>/</code>)</td></tr>
     <tr><td><code>=</code></td><td>integer equality</td></tr>
     <tr><td><code>&lt;</code></td><td>integer less-than</td></tr>
     <tr><td><code>&lt;=</code></td><td>integer less-than or equal</td></tr>
index 965a1d9c5de048d90e9a662b2586abd476880bfa..24e0dd58082bc68a248f0c9a749ac27c7e2c0517 100644 (file)
@@ -268,7 +268,8 @@ is available only in Apache 2.0</compatibility>
 
     <dt><code>echo</code></dt>
     <dd>Request headers with this name are echoed back in the
-    response headers. <var>header</var> may be a regular expression.
+    response headers. <var>header</var> may be a 
+    <glossary ref="regex">regular expression</glossary>.
     <var>value</var> must be omitted.</dd>
     </dl>
 
@@ -276,7 +277,8 @@ is available only in Apache 2.0</compatibility>
     can include the final colon, but it is not required. Case is
     ignored for <code>set</code>, <code>append</code>, <code>add</code>
     and <code>unset</code>. The <var>header</var> name for <code>echo</code>
-    is case sensitive and may be a regular expression.</p>
+    is case sensitive and may be a <glossary ref="regex">regular 
+    expression</glossary>.</p>
 
     <p>For <code>add</code>, <code>append</code> and <code>set</code> a
     <var>value</var> is specified as the third argument. If <var>value</var>
index 29587b6d20e7d9d1a8e38c0bc68a9ce69439a71f..08631693f22969244fd49be29f40ff071844d1c6 100644 (file)
@@ -423,7 +423,7 @@ proxied resources</description>
     <p>The <directive type="section">ProxyMatch</directive> directive is
     identical to the <directive module="mod_proxy"
     type="section">Proxy</directive> directive, except it matches URLs
-    using regular expressions.</p>
+    using <glossary ref="regex">regular expressions</glossary>.</p>
 </usage>
 </directivesynopsis>
 
@@ -528,7 +528,8 @@ expressions</description>
 <usage>
     <p>The <directive>ProxyRemoteMatch</directive> is identical to the
     <directive module="mod_proxy">ProxyRemote</directive> directive, except the
-    first argument is a regular expression match against the requested URL.</p>
+    first argument is a <glossary ref="regex">regular expression</glossary>
+    match against the requested URL.</p>
 </usage>
 </directivesynopsis>
 
index 5a10508521b8e55ce74b368d43bf51c88eba6d46..d08d3c1c38df3b336cbcb1db37dae2a4969796bc 100644 (file)
@@ -1080,7 +1080,8 @@ RewriteRule  ^/$                 /homepage.std.html  [L]
       because any number of rules may already have matched and made
       alterations to it.</p>
 
-      <p>Some hints about the syntax of regular expressions:</p>
+      <p>Some hints about the syntax of <glossary ref="regex">regular 
+      expressions</glossary>:</p>
 
 <note><pre>
 <strong>Text:</strong>
index 5949d1db5a7c77df009e3083032552fccbde6604..ac3c5ccadfdbbac63646ddbe3440502f21a61d33 100644 (file)
@@ -193,11 +193,10 @@ used for the <em>attribute</em>.</li>
 </li>
 </ol>
 
-<p>The second argument (<em>regex</em>) is a <a
-href="http://www.pcre.org/">Perl compatible regular expression</a>.
-This is similar to a POSIX.2 egrep-style regular expression.
-If the <em>regex</em> matches against the <em>attribute</em>,
-then the remainder of the arguments are evaluated.</p>
+<p>The second argument (<em>regex</em>) is a <glossary
+ref="regex">regular expression</glossary>.  If the <em>regex</em>
+matches against the <em>attribute</em>, then the remainder of the
+arguments are evaluated.</p>
 
 <p>The rest of the arguments give the names of variables to set, and
 optionally values to which they should be set. These take the form
index e96a2de3f02a666619740c3cc57e658da3a65650..4880a546643a93a2f9f2cf305f89977c4b47a011 100644 (file)
@@ -97,8 +97,9 @@
       &lt;/IfVersion&gt;
     </example>
 
-    <p>Besides the numerical comparison it is possible to match a regular
-    expression against the httpd version. There are two ways to write it:</p>
+    <p>Besides the numerical comparison it is possible to match a 
+    <glossary ref="regex">regular expression</glossary> 
+    against the httpd version. There are two ways to write it:</p>
 
     <table style="zebra" border="1">
     <tr><th><var>operator</var></th><th>description</th></tr>
index 30ec624582bd112d62246d1f69df1b456e88b7dc..dbf32d9bdfff6ccb61ad33d5d81f6a606ed40122 100644 (file)
@@ -65,10 +65,7 @@ how they are used by the Apache HTTP Server.</p>
       scalability can choose to use a threaded MPM like 
       <module>worker</module> or <module>event</module>, while sites requiring
       stability or compatibility with older software can use a
-      <module>prefork</module>. In addition,
-      special features like serving different hosts under different
-      userids (<module>perchild</module>) can be
-      provided.</li>
+      <module>prefork</module>.</li>
     </ul>
 
     <p>At the user level, MPMs appear much like other Apache
index 0df64ee1754a062f364602b6a06cc375e76a5f92..10c8e70fa2d034be3fca230fd0ef4441147a8c1b 100644 (file)
@@ -129,7 +129,7 @@ from databases or other locations.</p>
 
 <p>The <directive type="section" module="core">Directory</directive>
 and <directive type="section" module="core">Files</directive>
-directives, along with their regex counterparts, apply directives to
+directives, along with their <glossary>regex</glossary> counterparts, apply directives to
 parts of the filesystem.  Directives enclosed in a <directive
 type="section" module="core">Directory</directive> section apply to
 the named filesystem directory and all subdirectories of that
@@ -182,7 +182,7 @@ Deny from all<br />
 <section id="webspace"><title>Webspace Containers</title>
 
 <p>The <directive type="section" module="core">Location</directive>
-directive and its regex counterpart, on the other hand, change the
+directive and its <glossary>regex</glossary> counterpart, on the other hand, change the
 configuration for content in the webspace.  For example, the following
 configuration prevents access to any URL-path that begins in /private.
 In particular, it will apply to requests for
@@ -225,12 +225,12 @@ character will not be matched by any wildcard; it must be specified
 explicitly.</p>
 
 <p>If even more flexible matching is required, each
-container has a regular-expression (regex) counterpart <directive
+container has a regular expression (regex) counterpart <directive
 type="section" module="core">DirectoryMatch</directive>, <directive
 type="section" module="core">FilesMatch</directive>, and <directive
 type="section" module="core">LocationMatch</directive> that allow
 perl-compatible
-<a href="glossary.html#regex">regular expressions</a>
+<glossary ref="regex">regular expressions</glossary>
 to be used in choosing the matches.  But see the section below on
 configuration merging to find out how using regex sections will change
 how directives are applied.</p>
index bde7e69476469ab4c2ff1d935e6d45b5c9907cb1..b760fc49aedefe061a9ab3eb9eee145f80c61757 100644 (file)
     will be served from <code>/var/web/dir/file.html</code>. The
     <directive module="mod_alias">ScriptAlias</directive> directive
     works the same way, with the additional effect that all content
-    located at the target path is treated as CGI scripts.</p>
+    located at the target path is treated as <glossary>CGI</glossary> scripts.</p>
 
     <p>For situations where you require additional flexibility, you
-    can use the <directive module="mod_alias">AliasMatch</directive> and 
-    <directive module="mod_alias">ScriptAliasMatch</directive>
-    directives to do powerful regular-expression based matching and
-    substitution. For example,</p>
+    can use the <directive module="mod_alias">AliasMatch</directive>
+    and <directive module="mod_alias">ScriptAliasMatch</directive>
+    directives to do powerful <glossary ref="regex">regular
+    expression</glossary> based matching and substitution. For
+    example,</p>
 
 <example>ScriptAliasMatch ^/~([a-zA-Z0-9]+)/cgi-bin/(.+)
       /home/$1/cgi-bin/$2</example>