Commit 5b8dbf15 authored by Ken Coar's avatar Ken Coar
Browse files

Correcting various manual documentation errors and omissions. 

Submitted by:	Martin Kraemer


git-svn-id: https://svn.apache.org/repos/asf/httpd/httpd/trunk@78210 13f79535-47bb-0310-9956-ffa450edef68
parent 1edbda86

docs/manual/mod/directives.html

+6 −2
Original line number Diff line number Diff line
@@ -12,6 +12,9 @@ 
<li><A HREF="core.html#accessconfig">AccessConfig</A>

<li><A HREF="core.html#accessfilename">AccessFileName</A>

<li><A HREF="mod_actions.html#action">Action</A>

<li><A HREF="mod_dir.html#addalt">AddAlt</A>

<li><A HREF="mod_dir.html#addaltbyencoding">AddAltByEncoding</A>

<li><A HREF="mod_dir.html#addaltbytype">AddAltByType</A>

<li><A HREF="mod_dir.html#adddescription">AddDescription</A>

<li><A HREF="mod_mime.html#addencoding">AddEncoding</A>

<li><A HREF="mod_mime.html#addhandler">AddHandler</A>
@@ -26,10 +29,11 @@ 
<li><A HREF="mod_access.html#allow">allow</A>

<li><A HREF="core.html#allowoverride">AllowOverride</A>

<li><A HREF="mod_auth_anon.html#anonymous">Anonymous</A>

<li><A HREF="mod_auth_anon.html#Authoritative">Anonymous_Authoritative</A>

<li><A HREF="mod_auth_anon.html#LogEmail">Anonymous_LogEmail</A>

<li><A HREF="mod_auth_anon.html#MustGiveEmail">Anonymous_MustGiveEmail</A>

<li><A HREF="mod_auth_anon.html#NoUserID">Anonymous_NoUserID</A>

<li><A HREF="mod_auth_anon.html#VerifyEmail">Anonymous_VerifyEmail</A>

<li><A HREF="mod_auth_anon.html#NoUser">Anonymous_NoUser</A>

<li><A HREF="mod_auth_anon.html#Authoritative">Anonymous_Authoritative</A>

<li><A HREF="mod_auth.html#authauthoritative">AuthAuthoritative</A>

<li><A HREF="mod_auth_db.html#authdbauthoritative">AuthDBAuthoritative</A>

<li><A HREF="mod_auth_db.html#authdbgroupfile">AuthDBGroupFile</A>

docs/manual/mod/mod_auth_anon.html

+39 −24
Original line number Diff line number Diff line
@@ -36,10 +36,11 @@ allows users to share URLs. 
<h2><a name="Directives">Directives</a></h2>

<ul>

<li><A HREF="#anonymous">Anonymous</A>

<li><A HREF="#Authoritative">Anonymous_Authoritative</A>

<li><A HREF="#LogEmail">Anonymous_LogEmail</A>

<li><A HREF="#MustGiveEmail">Anonymous_MustGiveEmail</A>

<li><A HREF="#NoUserID">Anonymous_NoUserID</A>

<li><A HREF="#VerifyEmail">Anonymous_VerifyEmail</A>

<li><A HREF="#NoUser">Anonymous_NoUser</A>

<li><A HREF="#Authoritative">Anonymous_Authoritative</A>

</ul>



<hr>
@@ -70,6 +71,25 @@ allows users to share URLs. 
	This would allow the user to enter without password verification

	by using the userId's 'anonymous', 'AnonyMous','Not Registered' and

	'I Don't Know'.

<HR>



<A name="Authoritative"><h2>Anonymous_Authoritative</h2></A>

<strong>Syntax:</strong> Anonymous_Authoritative <em>on | off</em><br>

<strong>Default:</strong> <code>Anonymous_Authoritative off</code><br>

<strong>Context:</strong> directory, .htaccess<br>

<strong>Override:</strong> AuthConfig<br>

<strong>Status:</strong> Extension<br>

<strong>Module:</strong> mod_auth_anon<p>



        When set 'on', there is no

        fall-through to other authorization methods. So if a

        userID does not match the values specified in the

	<code>Anonymous</code> directive, access is denied.

	<p>

	Be sure you know what you are doing when you decide to switch 

	it on. And remember that it is the linking order of the modules

	(in the Configuration / Make file) which details the order

	in which the Authorization modules are queried.

<hr>



<A name="LogEmail"><h2>Anonymous_LogEmail</h2></A>
@@ -84,23 +104,22 @@ allows users to share URLs. 
	contains a sensible email address) is logged in the httpd-log file.

<hr>



<A name="VerifyEmail"><h2>Anonymous_VerifyEmail</h2></A>

<strong>Syntax:</strong> Anonymous <em>on | off</em><br>

<strong>Default:</strong> <code>Anonymous_VerifyEmail off</code><br>

<A name="MustGiveEmail"><h2>Anonymous_MustGiveEmail</h2></a>

<!--%plaintext &lt;?INDEX {\tt Anonymous_MustGiveEmail} directive&gt; -->

<strong>Syntax:</strong> Anonymous_MustGiveEmail <em>on</em> | <em>off</em><br>

<strong>Default:</strong> off<br>

<strong>Context:</strong> directory, .htaccess<br>

<strong>Override:</strong> AuthConfig<br>

<strong>Status:</strong> Extension<br>

<strong>Module:</strong> mod_auth_anon<p>



	When set 'on' the 'password' entered is

	checked for at least one '@' and a '.' to encourage users to enter

	valid email addresses (see the above <code>Auth_LogEmail</code>).



	Specifies whether the user must specify an email

	address as the password.  This prohibits blank passwords.

<HR>



<A name="NoUser"><h2>Anonymous_NoUser</h2></A>

<strong>Syntax:</strong> Anonymous_NoUser <em>on | off</em><br>

<strong>Default:</strong> <code>Anonymous_NoUser off</code><br>

<A name="NoUserID"><h2>Anonymous_NoUserID</h2></A>

<strong>Syntax:</strong> Anonymous_NoUserID <em>on | off</em><br>

<strong>Default:</strong> <code>Anonymous_NoUserID off</code><br>

<strong>Context:</strong> directory, .htaccess<br>

<strong>Override:</strong> AuthConfig<br>

<strong>Status:</strong> Extension<br>
@@ -112,23 +131,19 @@ allows users to share URLs. 
	just hit return or click directly on the OK button; which

	seems a natural reaction.



<A name="Authoritative"><h2>Anonymous_Authoritative</h2></A>

<strong>Syntax:</strong> Anonymous_Authoritative <em>on | off</em><br>

<strong>Default:</strong> <code>Anonymous_Authoritative off</code><br>

<hr>



<A name="VerifyEmail"><h2>Anonymous_VerifyEmail</h2></A>

<strong>Syntax:</strong> Anonymous <em>on | off</em><br>

<strong>Default:</strong> <code>Anonymous_VerifyEmail off</code><br>

<strong>Context:</strong> directory, .htaccess<br>

<strong>Override:</strong> AuthConfig<br>

<strong>Status:</strong> Extension<br>

<strong>Module:</strong> mod_auth_anon<p>



        When set 'on', there is no

        fall-through to other authorization methods. So if a

        userID does not match the values specified in the

	<code>Anonymous</code> directive, access is denied.

	<p>

	Be sure you know what you are doing when you decide to switch 

	it on. And remember that it is the linking order of the modules

	(in the Configuration / Make file) which details the order

	in which the Authorization modules are queried.

	When set 'on' the 'password' entered is

	checked for at least one '@' and a '.' to encourage users to enter

	valid email addresses (see the above <code>Auth_LogEmail</code>).



<hr><a name="Example"><h2>Example</h2></a>

docs/manual/mod/mod_autoindex.html

+52 −0
Original line number Diff line number Diff line
@@ -30,6 +30,9 @@ first icon listed that matches the file is displayed. 
<h2>Directives</h2>



<menu>

<li><A HREF="#addalt">AddAlt</A>

<li><A HREF="#addaltbyencoding">AddAltByEncoding</A>

<li><A HREF="#addaltbytype">AddAltByType</A>

<li><A HREF="#adddescription">AddDescription</A>

<li><A HREF="#addicon">AddIcon</A>

<li><A HREF="#addiconbyencoding">AddIconByEncoding</A>
@@ -44,6 +47,55 @@ first icon listed that matches the file is displayed. 
</menu>

<hr>



<A name="addalt"><h2>AddAlt</h2></A>

<!--%plaintext &lt;?INDEX {\tt AddAlt} directive&gt; -->

<strong>Syntax:</strong> AddAlt <em>string file file...</em><br>

<Strong>Context:</strong> server config, virtual host, directory, .htaccess<br>

<Strong>Override:</strong> Indexes<br>

<strong>Status:</strong> Base<br>

<strong>Module:</strong> mod_dir<p>



This sets the alternate text to display for a file, instead of an icon, for

<A HREF="#fancyindexing">FancyIndexing</A>. <em>File</em> is a file

extension, partial filename, wild-card expression or full filename for files

to describe. <em>String</em> is enclosed in double quotes

(<code>&quot;</code>).  This alternate text is displayed if the client is

image-incapable or has image loading disabled.



<HR>

<A name="addaltbyencoding"><h2>AddAltByEncoding</h2></A>

<!--%plaintext &lt;?INDEX {\tt AddAltByEncoding} directive&gt; -->

<strong>Syntax:</strong> AddAltByEncoding <em>string MIME-encoding

    MIME-encoding...</em><br>

<Strong>Context:</strong> server config, virtual host, directory, .htaccess<br>

<Strong>Override:</strong> Indexes<br>

<strong>Status:</strong> Base<br>

<strong>Module:</strong> mod_dir<p>



This sets the alternate text to display for a file, instead of an icon, for

<A HREF="#fancyindexing">FancyIndexing</A>. <em>MIME-encoding</em> is a

valid content-encoding, such as <SAMP>x-compress</SAMP>.

<em>String</em> is enclosed in double quotes

(<code>&quot;</code>).  This alternate text is displayed if the client is

image-incapable or has image loading disabled.



<HR>

<A name="addaltbytype"><h2>AddAltByType</h2></A>

<!--%plaintext &lt;?INDEX {\tt AddAltByType} directive&gt; -->

<strong>Syntax:</strong> AddAltByType <em>string MIME-type MIME-type...</em><br>

<Strong>Context:</strong> server config, virtual host, directory, .htaccess<br>

<Strong>Override:</strong> Indexes<br>

<strong>Status:</strong> Base<br>

<strong>Module:</strong> mod_dir<p>



This sets the alternate text to display for a file, instead of an icon, for

<A HREF="#fancyindexing">FancyIndexing</A>. <em>MIME-type</em> is a

valid content-type, such as <SAMP>text/html</SAMP>.

<em>String</em> is enclosed in double quotes

(<code>&quot;</code>).  This alternate text is displayed if the client is

image-incapable or has image loading disabled.



<HR>



<A name="adddescription"><h2>AddDescription</h2></A>

<!--%plaintext &lt;?INDEX {\tt AddDescription} directive&gt; -->

docs/manual/mod/mod_dir.html

+52 −0
Original line number Diff line number Diff line
@@ -30,6 +30,9 @@ first icon listed that matches the file is displayed. 
<h2>Directives</h2>



<menu>

<li><A HREF="#addalt">AddAlt</A>

<li><A HREF="#addaltbyencoding">AddAltByEncoding</A>

<li><A HREF="#addaltbytype">AddAltByType</A>

<li><A HREF="#adddescription">AddDescription</A>

<li><A HREF="#addicon">AddIcon</A>

<li><A HREF="#addiconbyencoding">AddIconByEncoding</A>
@@ -44,6 +47,55 @@ first icon listed that matches the file is displayed. 
</menu>

<hr>



<A name="addalt"><h2>AddAlt</h2></A>

<!--%plaintext &lt;?INDEX {\tt AddAlt} directive&gt; -->

<strong>Syntax:</strong> AddAlt <em>string file file...</em><br>

<Strong>Context:</strong> server config, virtual host, directory, .htaccess<br>

<Strong>Override:</strong> Indexes<br>

<strong>Status:</strong> Base<br>

<strong>Module:</strong> mod_dir<p>



This sets the alternate text to display for a file, instead of an icon, for

<A HREF="#fancyindexing">FancyIndexing</A>. <em>File</em> is a file

extension, partial filename, wild-card expression or full filename for files

to describe. <em>String</em> is enclosed in double quotes

(<code>&quot;</code>).  This alternate text is displayed if the client is

image-incapable or has image loading disabled.



<HR>

<A name="addaltbyencoding"><h2>AddAltByEncoding</h2></A>

<!--%plaintext &lt;?INDEX {\tt AddAltByEncoding} directive&gt; -->

<strong>Syntax:</strong> AddAltByEncoding <em>string MIME-encoding

    MIME-encoding...</em><br>

<Strong>Context:</strong> server config, virtual host, directory, .htaccess<br>

<Strong>Override:</strong> Indexes<br>

<strong>Status:</strong> Base<br>

<strong>Module:</strong> mod_dir<p>



This sets the alternate text to display for a file, instead of an icon, for

<A HREF="#fancyindexing">FancyIndexing</A>. <em>MIME-encoding</em> is a

valid content-encoding, such as <SAMP>x-compress</SAMP>.

<em>String</em> is enclosed in double quotes

(<code>&quot;</code>).  This alternate text is displayed if the client is

image-incapable or has image loading disabled.



<HR>

<A name="addaltbytype"><h2>AddAltByType</h2></A>

<!--%plaintext &lt;?INDEX {\tt AddAltByType} directive&gt; -->

<strong>Syntax:</strong> AddAltByType <em>string MIME-type MIME-type...</em><br>

<Strong>Context:</strong> server config, virtual host, directory, .htaccess<br>

<Strong>Override:</strong> Indexes<br>

<strong>Status:</strong> Base<br>

<strong>Module:</strong> mod_dir<p>



This sets the alternate text to display for a file, instead of an icon, for

<A HREF="#fancyindexing">FancyIndexing</A>. <em>MIME-type</em> is a

valid content-type, such as <SAMP>text/html</SAMP>.

<em>String</em> is enclosed in double quotes

(<code>&quot;</code>).  This alternate text is displayed if the client is

image-incapable or has image loading disabled.



<HR>



<A name="adddescription"><h2>AddDescription</h2></A>

<!--%plaintext &lt;?INDEX {\tt AddDescription} directive&gt; -->

docs/manual/mod/mod_mime.html

+2 −2
Original line number Diff line number Diff line
@@ -83,7 +83,7 @@ with the file extension "<code>.cgi</code>", you might use: 
<p>Once that has been put into your srm.conf or httpd.conf file, any

file ending with "<code>.cgi</code>" will be treated as a CGI

program.</p>



<HR>



<h2><A name="addlanguage">AddLanguage</A></h2>

<!--%plaintext &lt;?INDEX {\tt AddLanguage} directive&gt; -->
@@ -179,7 +179,7 @@ called, you might put the following into access.conf: 
    SetHandler server-status

    &lt;/Location&gt;

</pre>



<HR>



<h2><A name="typesconfig">TypesConfig</A></h2>

<!--%plaintext &lt;?INDEX {\tt TypesConfig} directive&gt; -->