summaryrefslogtreecommitdiffstats
path: root/docs
diff options
context:
space:
mode:
authorJoshua Slive <slive@apache.org>2005-09-21 17:21:09 +0200
committerJoshua Slive <slive@apache.org>2005-09-21 17:21:09 +0200
commit2b1d0579cb67a1b90dd986aa8673440cdc679b38 (patch)
tree9702ce3dc94a898d623b9dbb85a3acbac7c18578 /docs
parentOmit reference to pre-2.0.48 versions. (diff)
downloadapache2-2b1d0579cb67a1b90dd986aa8673440cdc679b38.tar.xz
apache2-2b1d0579cb67a1b90dd986aa8673440cdc679b38.zip
Add some <glossary> markup for regular expression and regex.
git-svn-id: https://svn.apache.org/repos/asf/httpd/httpd/trunk@290723 13f79535-47bb-0310-9956-ffa450edef68
Diffstat (limited to 'docs')
-rw-r--r--docs/manual/caching.xml23
-rw-r--r--docs/manual/mod/core.xml23
-rw-r--r--docs/manual/mod/directive-dict.xml4
-rw-r--r--docs/manual/mod/mod_alias.xml15
-rw-r--r--docs/manual/mod/mod_filter.xml5
-rw-r--r--docs/manual/mod/mod_headers.xml6
-rw-r--r--docs/manual/mod/mod_proxy.xml5
-rw-r--r--docs/manual/mod/mod_rewrite.xml3
-rw-r--r--docs/manual/mod/mod_setenvif.xml9
-rw-r--r--docs/manual/mod/mod_version.xml5
-rw-r--r--docs/manual/mpm.xml5
-rw-r--r--docs/manual/sections.xml8
-rw-r--r--docs/manual/urlmapping.xml11
13 files changed, 66 insertions, 56 deletions
diff --git a/docs/manual/caching.xml b/docs/manual/caching.xml
index c6d6a5536d..2ac84e8f92 100644
--- a/docs/manual/caching.xml
+++ b/docs/manual/caching.xml
@@ -36,11 +36,11 @@
<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>
@@ -98,16 +98,17 @@
</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
diff --git a/docs/manual/mod/core.xml b/docs/manual/mod/core.xml
index 33fc48b63f..57d4699cc1 100644
--- a/docs/manual/mod/core.xml
+++ b/docs/manual/mod/core.xml
@@ -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;
diff --git a/docs/manual/mod/directive-dict.xml b/docs/manual/mod/directive-dict.xml
index 8ae121370f..d0ffff5b63 100644
--- a/docs/manual/mod/directive-dict.xml
+++ b/docs/manual/mod/directive-dict.xml
@@ -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>
diff --git a/docs/manual/mod/mod_alias.xml b/docs/manual/mod/mod_alias.xml
index 2bcb910282..2b40b8bc08 100644
--- a/docs/manual/mod/mod_alias.xml
+++ b/docs/manual/mod/mod_alias.xml
@@ -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
diff --git a/docs/manual/mod/mod_filter.xml b/docs/manual/mod/mod_filter.xml
index 8e2231ee06..ad15c8c26e 100644
--- a/docs/manual/mod/mod_filter.xml
+++ b/docs/manual/mod/mod_filter.xml
@@ -277,7 +277,8 @@
<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>
@@ -292,7 +293,7 @@
<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>
diff --git a/docs/manual/mod/mod_headers.xml b/docs/manual/mod/mod_headers.xml
index 965a1d9c5d..24e0dd5808 100644
--- a/docs/manual/mod/mod_headers.xml
+++ b/docs/manual/mod/mod_headers.xml
@@ -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>
diff --git a/docs/manual/mod/mod_proxy.xml b/docs/manual/mod/mod_proxy.xml
index 29587b6d20..08631693f2 100644
--- a/docs/manual/mod/mod_proxy.xml
+++ b/docs/manual/mod/mod_proxy.xml
@@ -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>
diff --git a/docs/manual/mod/mod_rewrite.xml b/docs/manual/mod/mod_rewrite.xml
index 5a10508521..d08d3c1c38 100644
--- a/docs/manual/mod/mod_rewrite.xml
+++ b/docs/manual/mod/mod_rewrite.xml
@@ -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>
diff --git a/docs/manual/mod/mod_setenvif.xml b/docs/manual/mod/mod_setenvif.xml
index 5949d1db5a..ac3c5ccadf 100644
--- a/docs/manual/mod/mod_setenvif.xml
+++ b/docs/manual/mod/mod_setenvif.xml
@@ -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
diff --git a/docs/manual/mod/mod_version.xml b/docs/manual/mod/mod_version.xml
index e96a2de3f0..4880a54664 100644
--- a/docs/manual/mod/mod_version.xml
+++ b/docs/manual/mod/mod_version.xml
@@ -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>
diff --git a/docs/manual/mpm.xml b/docs/manual/mpm.xml
index 30ec624582..dbf32d9bdf 100644
--- a/docs/manual/mpm.xml
+++ b/docs/manual/mpm.xml
@@ -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
diff --git a/docs/manual/sections.xml b/docs/manual/sections.xml
index 0df64ee175..10c8e70fa2 100644
--- a/docs/manual/sections.xml
+++ b/docs/manual/sections.xml
@@ -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>
diff --git a/docs/manual/urlmapping.xml b/docs/manual/urlmapping.xml
index bde7e69476..b760fc49ae 100644
--- a/docs/manual/urlmapping.xml
+++ b/docs/manual/urlmapping.xml
@@ -109,13 +109,14 @@
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>