From 2b1d0579cb67a1b90dd986aa8673440cdc679b38 Mon Sep 17 00:00:00 2001 From: Joshua Slive Date: Wed, 21 Sep 2005 15:21:09 +0000 Subject: Add some markup for regular expression and regex. git-svn-id: https://svn.apache.org/repos/asf/httpd/httpd/trunk@290723 13f79535-47bb-0310-9956-ffa450edef68 --- docs/manual/caching.xml | 23 ++++++++++++----------- docs/manual/mod/core.xml | 23 +++++++++++++---------- docs/manual/mod/directive-dict.xml | 4 ++-- docs/manual/mod/mod_alias.xml | 15 +++++++++------ docs/manual/mod/mod_filter.xml | 5 +++-- docs/manual/mod/mod_headers.xml | 6 ++++-- docs/manual/mod/mod_proxy.xml | 5 +++-- docs/manual/mod/mod_rewrite.xml | 3 ++- docs/manual/mod/mod_setenvif.xml | 9 ++++----- docs/manual/mod/mod_version.xml | 5 +++-- docs/manual/mpm.xml | 5 +---- docs/manual/sections.xml | 8 ++++---- docs/manual/urlmapping.xml | 11 ++++++----- 13 files changed, 66 insertions(+), 56 deletions(-) (limited to 'docs') 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 @@
Introduction -

As of Apache HTTP server version 2.2 mod_cache and - mod_file_cache 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.

+

As of Apache HTTP server version 2.2 mod_cache + and mod_file_cache 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.

mod_cache and its provider modules mod_mem_cache and mod_disk_cache @@ -58,7 +58,7 @@ the complexity of actively ensuring the cachability of URLs, mod_file_cache offers file-handle and memory-mapping tricks to keep a cache of files as they were when Apache was last - started. As such mod_file_cache is aimed at improving + started. As such, mod_file_cache is aimed at improving the access time to local static files which do not change very often.

@@ -98,16 +98,17 @@ -

There are two main stages in mod_cache which can +

There are two main stages in mod_cache that can occur in the lifetime of a request. First, mod_cache 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 mod_cache.

-

This means that any other stages with might ordinarily happen in the - process of serving a request, for example being handled by - mod_proxy, or mod_rewrite won't happen. - But then this is the point of caching content in the first place.

+

This means that any other stages that might ordinarily happen + in the process of serving a request -- for example being handled + by mod_proxy, or mod_rewrite -- + won't happen. But then this is the point of caching content in + the first place.

If the URL is not found within the cache, mod_cache will add a filter 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 links.

-

Extended regular - expressions can also be used, with the addition of the +

Regular + expressions can also be used, with the addition of the ~ character. For example:

@@ -761,7 +761,8 @@ subdirectories of directives which will apply only to the named directory and sub-directories of that directory, the same as Directory. However, it - takes as an argument a regular expression. For example:

+ takes as an argument a regular + expression. For example:

<DirectoryMatch "^/www/(.+/)?[0-9]{3}"> @@ -1161,8 +1162,9 @@ filenames

The filename argument should include a filename, or a wild-card string, where ? matches any single character, - and * matches any sequences of characters. Extended regular - expressions can also be used, with the addition of the + and * matches any sequences of characters. + Regular expressions + can also be used, with the addition of the ~ character. For example:

@@ -1200,7 +1202,8 @@ filenames

The FilesMatch directive limits the scope of the enclosed directives by filename, just as the Files directive - does. However, it accepts a regular expression. For example:

+ does. However, it accepts a regular + expression. For example:

<FilesMatch "\.(gif|jpe?g|png)$"> @@ -1890,8 +1893,8 @@ URLs any single character, and * matches any sequences of characters.

-

Extended regular - expressions can also be used, with the addition of the +

Regular expressions + can also be used, with the addition of the ~ character. For example:

@@ -1961,8 +1964,8 @@ matching URLs

The LocationMatch directive limits the scope of the enclosed directives by URL, in an identical manner to Location. However, - it takes a regular expression as an argument instead of a simple - string. For example:

+ it takes a regular expression + as an argument instead of a simple string. For example:

<LocationMatch "/(extra|special)/data"> 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 @@
regex
-
A Perl-compatible regular - expression. The directive definition will specify what the +
A Perl-compatible regular + expression. The directive definition will specify what the regex is matching against.
extension
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

This directive is equivalent to Alias, but makes use of standard - regular expressions, instead of simple prefix matching. The + module="mod_alias">Alias, but makes use of + regular expressions, + 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

This directive is equivalent to Redirect, but makes use of standard - regular expressions, instead of simple prefix matching. The + module="mod_alias">Redirect, but makes use of + regular expressions, + 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

This directive is equivalent to ScriptAlias, but makes use of standard - regular expressions, instead of simple prefix matching. The + >ScriptAlias, but makes use of + regular expressions, + 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 @@

The match argument specifies a match that will be applied to the filter's dispatch criterion. The match may be - a string match (exact match or substring), a regexp, an integer (greater, + a string match (exact match or substring), a regex, + an integer (greater, lessthan or equals), or unconditional. The first characters of the match argument determines this:

@@ -292,7 +293,7 @@ CharacterDescription (none)exact match $substring match - /regexp match (delimited by a second /) + /regex match (delimited by a second /) =integer equality <integer less-than <=integer less-than or equal 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
echo
Request headers with this name are echoed back in the - response headers. header may be a regular expression. + response headers. header may be a + regular expression. value must be omitted.
@@ -276,7 +277,8 @@ is available only in Apache 2.0 can include the final colon, but it is not required. Case is ignored for set, append, add and unset. The header name for echo - is case sensitive and may be a regular expression.

+ is case sensitive and may be a regular + expression.

For add, append and set a value is specified as the third argument. If value 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

The ProxyMatch directive is identical to the Proxy directive, except it matches URLs - using regular expressions.

+ using regular expressions.

@@ -528,7 +528,8 @@ expressions

The ProxyRemoteMatch is identical to the ProxyRemote directive, except the - first argument is a regular expression match against the requested URL.

+ first argument is a regular expression + match against the requested URL.

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.

-

Some hints about the syntax of regular expressions:

+

Some hints about the syntax of regular + expressions:

 Text:
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 attribute.
 
 
 
-

The second argument (regex) is a Perl compatible regular expression. -This is similar to a POSIX.2 egrep-style regular expression. -If the regex matches against the attribute, -then the remainder of the arguments are evaluated.

+

The second argument (regex) is a regular expression. If the regex +matches against the attribute, then the remainder of the +arguments are evaluated.

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 @@ </IfVersion> -

Besides the numerical comparison it is possible to match a regular - expression against the httpd version. There are two ways to write it:

+

Besides the numerical comparison it is possible to match a + regular expression + against the httpd version. There are two ways to write it:

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.

scalability can choose to use a threaded MPM like worker or event, while sites requiring stability or compatibility with older software can use a - prefork. In addition, - special features like serving different hosts under different - userids (perchild) can be - provided. + prefork.

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.

The Directory and Files -directives, along with their regex counterparts, apply directives to +directives, along with their regex counterparts, apply directives to parts of the filesystem. Directives enclosed in a Directory section apply to the named filesystem directory and all subdirectories of that @@ -182,7 +182,7 @@ Deny from all

Webspace Containers

The Location -directive and its regex counterpart, on the other hand, change the +directive and its regex 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.

If even more flexible matching is required, each -container has a regular-expression (regex) counterpart DirectoryMatch, FilesMatch, and LocationMatch that allow perl-compatible -regular expressions +regular expressions 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.

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 /var/web/dir/file.html. The ScriptAlias directive works the same way, with the additional effect that all content - located at the target path is treated as CGI scripts.

+ located at the target path is treated as CGI scripts.

For situations where you require additional flexibility, you - can use the AliasMatch and - ScriptAliasMatch - directives to do powerful regular-expression based matching and - substitution. For example,

+ can use the AliasMatch + and ScriptAliasMatch + directives to do powerful regular + expression based matching and substitution. For + example,

ScriptAliasMatch ^/~([a-zA-Z0-9]+)/cgi-bin/(.+) /home/$1/cgi-bin/$2 -- cgit v1.2.3
operatordescription