Commit 2b388fbf authored by Joshua Slive's avatar Joshua Slive
Browse files

Bringing forward from 1.3: small changes to standardize argument types. 


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

docs/manual/mod/mod_access.html

+6 −6
Original line number Diff line number Diff line
@@ -88,8 +88,8 @@ href="core.html#limit">&lt;Limit&gt;</a> section.</p> 
 HREF="directive-dict.html#Syntax"

 REL="Help"

><STRONG>Syntax:</STRONG></A> Allow from 

   all|<EM>host</em>|env=<em>variablename</em> 

   [<em>host</em>|env=<em>variablename</em>] ...<BR>

   all|<EM>host</em>|env=<em>env-variable</em> 

   [<em>host</em>|env=<em>env-variable</em>] ...<BR>

<A

 HREF="directive-dict.html#Context"

 REL="Help"
@@ -156,9 +156,9 @@ same set of hosts.</p> 
<p>The third format of the arguments to the <code>Allow</code>

directive allows access to the server to be controlled based on the

existence of an <a href="../env.html">environment variable</a>.  When

<code>Allow from env=</code><em>variablename</em> is specified, then

<code>Allow from env=</code><em>env-variable</em> is specified, then

the request is allowed access if the environment variable

<em>variablename</em> exists.  The server provides the ability to set

<em>env-variable</em> exists.  The server provides the ability to set

environment variables in a flexible way based on characteristics of

the client request using the directives provided by <a

href="mod_setenvif.html">mod_setenvif</a>.  Therefore, this directive
@@ -194,8 +194,8 @@ and <A HREF="mod_setenvif.html#SetEnvIf">SetEnvIf</A>. 
 HREF="directive-dict.html#Syntax"

 REL="Help"

><STRONG>Syntax:</STRONG></A> Deny from 

   all|<EM>host</em>|env=<em>variablename</em> 

   [<em>host</em>|env=<em>variablename</em>] ...<BR>

   all|<EM>host</em>|env=<em>env-variable</em> 

   [<em>host</em>|env=<em>env-variable</em>] ...<BR>

<A

 HREF="directive-dict.html#Context"

 REL="Help"

docs/manual/mod/mod_alias.html

+34 −31
Original line number Diff line number Diff line
@@ -77,7 +77,7 @@ HREF="mod_rewrite.html"><CODE>mod_rewrite</CODE></A> module. 
<A

 HREF="directive-dict.html#Syntax"

 REL="Help"

><STRONG>Syntax:</STRONG></A> Alias <EM>url-path directory-filename</EM><BR>

><STRONG>Syntax:</STRONG></A> Alias <EM>URL-path file-path</em>|<em>directory-path</EM><BR>

<A

 HREF="directive-dict.html#Context"

 REL="Help"
@@ -129,7 +129,7 @@ See also <A HREF="#scriptalias">ScriptAlias</A>. 
<A

 HREF="directive-dict.html#Syntax"

 REL="Help"

><STRONG>Syntax:</STRONG></A> AliasMatch <EM>regex directory-filename</EM><BR>

><STRONG>Syntax:</STRONG></A> AliasMatch <EM>regex file-path</em>|<em>directory-path</EM><BR>

<A

 HREF="directive-dict.html#Context"

 REL="Help"
@@ -146,10 +146,11 @@ See also <A HREF="#scriptalias">ScriptAlias</A>. 


<P>This directive is equivalent to <A HREF="#alias">Alias</A>, but

makes use of standard regular expressions, instead of simple prefix

matching. The supplied regular expression is matched against the URL,

and if it matches, the server will substitute any parenthesized

matches into the given string and use it as a filename. For example,

to activate the <CODE>/icons</CODE> directory, one might use:

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 example, to activate the <CODE>/icons</CODE> directory,

one might use:

<PRE>

    AliasMatch ^/icons(.*) /usr/local/apache/icons$1

</PRE>
@@ -164,7 +165,7 @@ to activate the <CODE>/icons</CODE> directory, one might use: 
 HREF="directive-dict.html#Syntax"

 REL="Help"

><STRONG>Syntax:</STRONG></A> Redirect [<EM>status</EM>]

 <EM>url-path url</EM><BR>

 <EM>URL-path URL</EM><BR>

<A

 HREF="directive-dict.html#Context"

 REL="Help"
@@ -186,9 +187,9 @@ to activate the <CODE>/icons</CODE> directory, one might use: 
<P>

The Redirect directive maps an old URL into a new one. The new URL is returned

to the client which attempts to fetch it again with the new address.

<EM>Url-path</EM> a (%-decoded) path; any requests for documents beginning with

this path will be returned a redirect error to a new (%-encoded) url

beginning with <EM>url</EM>.

<EM>URL-path</EM> a (%-decoded) path; any requests for documents beginning with

this path will be returned a redirect error to a new (%-encoded) URL

beginning with <EM>URL</EM>.

</P>

<P>

Example:
@@ -203,7 +204,7 @@ access http://foo2.bar.com/service/foo.txt instead. 
<STRONG>Note:</STRONG> Redirect directives take precedence over Alias

and ScriptAlias

directives, irrespective of their ordering in the configuration file.  Also,

<EM>Url-path</EM> must be an absolute path, not a relative path, even

<EM>URL-path</EM> must be an absolute path, not a relative path, even

when used with .htaccess files or inside of &lt;Directory&gt; sections.

</P>

<P>
@@ -242,7 +243,7 @@ the function <CODE>send_error_response</CODE> in http_protocol.c). 
 HREF="directive-dict.html#Syntax"

 REL="Help"

><STRONG>Syntax:</STRONG></A>

    RedirectMatch [<EM>status</EM>] <EM>regex url</EM>

    RedirectMatch [<EM>status</EM>] <EM>regex URL</EM>

<BR>

<A

 HREF="directive-dict.html#Context"
@@ -263,13 +264,13 @@ the function <CODE>send_error_response</CODE> in http_protocol.c). 
><STRONG>Module:</STRONG></A> mod_alias

</P>



<P>This directive is equivalent to <A HREF="#redirect">Redirect</A>, but

makes use of standard regular expressions, instead of simple prefix

matching. The supplied regular expression is matched against the URL,

and if it matches, the server will substitute any parenthesized

matches into the given string and use it as a filename. For example,

to redirect all GIF files to like-named JPEG files on another server,

one might use:

<P>This directive is equivalent to <A HREF="#redirect">Redirect</A>,

but makes use of standard 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 example, to redirect all GIF files to like-named JPEG

files on another server, one might use:

<PRE>

    RedirectMatch (.*)\.gif$ http://www.anotherserver.com$1.jpg

</PRE>
@@ -283,7 +284,7 @@ one might use: 
<A

 HREF="directive-dict.html#Syntax"

 REL="Help"

><STRONG>Syntax:</STRONG></A> RedirectTemp <EM>url-path url</EM><BR>

><STRONG>Syntax:</STRONG></A> RedirectTemp <EM>URL-path URL</EM><BR>

<A

 HREF="directive-dict.html#Context"

 REL="Help"
@@ -315,7 +316,7 @@ temp</CODE>. 
<A

 HREF="directive-dict.html#Syntax"

 REL="Help"

><STRONG>Syntax:</STRONG></A> RedirectPermanent <EM>url-path url</EM><BR>

><STRONG>Syntax:</STRONG></A> RedirectPermanent <EM>URL-path URL</EM><BR>

<A

 HREF="directive-dict.html#Context"

 REL="Help"
@@ -346,7 +347,7 @@ This directive makes the client know that the Redirect is permanent 
<A

 HREF="directive-dict.html#Syntax"

 REL="Help"

><STRONG>Syntax:</STRONG></A> ScriptAlias <EM>url-path directory-filename</EM>

><STRONG>Syntax:</STRONG></A> ScriptAlias <EM>URL-path file-path</em>|<em>directory-path</em>

<BR>

<A

 HREF="directive-dict.html#Context"
@@ -365,8 +366,9 @@ This directive makes the client know that the Redirect is permanent 
The ScriptAlias directive has the same behavior as the

<A HREF="#alias">Alias</A> directive, except that in addition it

marks the target directory as containing CGI scripts.

URLs with a (%-decoded) path beginning with <EM>url-path</EM> will be

mapped to scripts beginning with <EM>directory-filename</EM>.

URLs with a (%-decoded) path beginning with <EM>URL-path</EM> will be

mapped to scripts beginning with the second argument which is a full

pathname in the local filesystem.

<P>

Example:

</P>
@@ -384,7 +386,7 @@ run the script /web/cgi-bin/foo. 
 HREF="directive-dict.html#Syntax"

 REL="Help"

><STRONG>Syntax:</STRONG></A> ScriptAliasMatch

 <EM>regex directory-filename</EM><BR>

 <EM>regex file-path</em>|<em>directory-path</EM><BR>

<A

 HREF="directive-dict.html#Context"

 REL="Help"
@@ -399,12 +401,13 @@ run the script /web/cgi-bin/foo. 
><STRONG>Module:</STRONG></A> mod_alias

</P>



<P>This directive is equivalent to <A HREF="#scriptalias">ScriptAlias</A>, but

makes use of standard regular expressions, instead of simple prefix

matching. The supplied regular expression is matched against the URL,

and if it matches, the server will substitute any parenthesized

matches into the given string and use it as a filename. For example,

to activate the standard <CODE>/cgi-bin</CODE>, one might use:

<P>This directive is equivalent to <A

HREF="#scriptalias">ScriptAlias</A>, but makes use of standard 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 example, to activate the standard

<CODE>/cgi-bin</CODE>, one might use:

<PRE>

    ScriptAliasMatch ^/cgi-bin(.*) /usr/local/apache/cgi-bin$1

</PRE>

docs/manual/mod/mod_auth.html

+4 −4
Original line number Diff line number Diff line
@@ -63,7 +63,7 @@ and <A HREF="core.html#satisfy">satisfy</A>.</P> 
<A

 HREF="directive-dict.html#Syntax"

 REL="Help"

><STRONG>Syntax:</STRONG></A> AuthGroupFile <EM>filename</EM><BR>

><STRONG>Syntax:</STRONG></A> AuthGroupFile <EM>file-path</EM><BR>

<A

 HREF="directive-dict.html#Context"

 REL="Help"
@@ -82,7 +82,7 @@ and <A HREF="core.html#satisfy">satisfy</A>.</P> 
><STRONG>Module:</STRONG></A> mod_auth<P>



The AuthGroupFile directive sets the name of a textual file containing the list

of user groups for user authentication. <EM>Filename</EM> is the path

of user groups for user authentication. <EM>File-path</EM> is the path

to the group file.  If it is not absolute (<EM>i.e.</EM>, if it

doesn't begin with a slash), it is treated as relative to the ServerRoot.

<P>
@@ -106,7 +106,7 @@ See also <A HREF="core.html#authname">AuthName</A>, 
<A

 HREF="directive-dict.html#Syntax"

 REL="Help"

><STRONG>Syntax:</STRONG></A> AuthUserFile <EM>filename</EM><BR>

><STRONG>Syntax:</STRONG></A> AuthUserFile <EM>file-path</EM><BR>

<A

 HREF="directive-dict.html#Context"

 REL="Help"
@@ -126,7 +126,7 @@ See also <A HREF="core.html#authname">AuthName</A>, 


The AuthUserFile directive sets the name of a textual file containing

the list of users and passwords for user

authentication. <EM>Filename</EM> is the path to the user

authentication. <EM>File-path</EM> is the path to the user

file. If it is not absolute (<EM>i.e.</EM>, if it doesn't begin with a

slash), it is treated as relative to the ServerRoot.

<P> Each line of the user file file contains a username followed

docs/manual/mod/mod_auth_db.html

+4 −4
Original line number Diff line number Diff line
@@ -70,7 +70,7 @@ compatibility mode is enabled.</p> 
<A

 HREF="directive-dict.html#Syntax"

 REL="Help"

><STRONG>Syntax:</STRONG></A> AuthDBGroupFile <EM>filename</EM><BR>

><STRONG>Syntax:</STRONG></A> AuthDBGroupFile <EM>file-path</EM><BR>

<A

 HREF="directive-dict.html#Context"

 REL="Help"
@@ -89,7 +89,7 @@ compatibility mode is enabled.</p> 
><STRONG>Module:</STRONG></A> mod_auth_db<P>



The AuthDBGroupFile directive sets the name of a DB file containing the list

of user groups for user authentication. <EM>Filename</EM> is the absolute path

of user groups for user authentication. <EM>File-path</EM> is the absolute path

to the group file.<P>



The group file is keyed on the username. The value for a user is a
@@ -133,7 +133,7 @@ See also <A HREF="core.html#authname">AuthName</A>, 
<A

 HREF="directive-dict.html#Syntax"

 REL="Help"

><STRONG>Syntax:</STRONG></A> AuthDBUserFile <EM>filename</EM><BR>

><STRONG>Syntax:</STRONG></A> AuthDBUserFile <EM>file-path</EM><BR>

<A

 HREF="directive-dict.html#Context"

 REL="Help"
@@ -152,7 +152,7 @@ See also <A HREF="core.html#authname">AuthName</A>, 
><STRONG>Module:</STRONG></A> mod_auth_db<P>



The AuthDBUserFile directive sets the name of a DB file containing the list

of users and passwords for user authentication. <EM>Filename</EM> is the

of users and passwords for user authentication. <EM>File-path</EM> is the

absolute path to the user file.<P>



The user file is keyed on the username. The value for a user is the

docs/manual/mod/mod_auth_dbm.html

+4 −4
Original line number Diff line number Diff line
@@ -60,7 +60,7 @@ provided by <a href="mod_auth_db.html">mod_auth_db</a>.</p> 
<A

 HREF="directive-dict.html#Syntax"

 REL="Help"

><STRONG>Syntax:</STRONG></A> AuthDBMGroupFile <EM>filename</EM><BR>

><STRONG>Syntax:</STRONG></A> AuthDBMGroupFile <EM>file-path</EM><BR>

<A

 HREF="directive-dict.html#Context"

 REL="Help"
@@ -79,7 +79,7 @@ provided by <a href="mod_auth_db.html">mod_auth_db</a>.</p> 
><STRONG>Module:</STRONG></A> mod_auth_dbm<P>



The AuthDBMGroupFile directive sets the name of a DBM file containing the list

of user groups for user authentication. <EM>Filename</EM> is the absolute path

of user groups for user authentication. <EM>File-path</EM> is the absolute path

to the group file.<P>



The group file is keyed on the username. The value for a user is a
@@ -124,7 +124,7 @@ See also <A HREF="core.html#authname">AuthName</A>, 
<A

 HREF="directive-dict.html#Syntax"

 REL="Help"

><STRONG>Syntax:</STRONG></A> AuthDBMUserFile <EM>filename</EM><BR>

><STRONG>Syntax:</STRONG></A> AuthDBMUserFile <EM>file-path</EM><BR>

<A

 HREF="directive-dict.html#Context"

 REL="Help"
@@ -143,7 +143,7 @@ See also <A HREF="core.html#authname">AuthName</A>, 
><STRONG>Module:</STRONG></A> mod_auth_dbm<P>



The AuthDBMUserFile directive sets the name of a DBM file containing the list

of users and passwords for user authentication. <EM>Filename</EM> is the

of users and passwords for user authentication. <EM>File-path</EM> is the

absolute path to the user file.<P>



The user file is keyed on the username. The value for a user is the