Commit 77fcbed7 authored by Christophe Jaillet's avatar Christophe Jaillet
Browse files

Fix typo as spotted by Wolfgang in online doc (r1750439 in trunk) 

Be more consistent in <highlight> block layout in XML.
No visual change (r1750441 in trunk)

Synch with trunk (mainly <highlight> block layout)
Do not use " around parameters in syntax

git-svn-id: https://svn.apache.org/repos/asf/httpd/httpd/branches/2.4.x@1750444 13f79535-47bb-0310-9956-ffa450edef68
parent 5c84896e

docs/manual/mod/core.xml

+127 −64
Original line number Diff line number Diff line
@@ -195,7 +195,9 @@ AcceptFilter https data 
    configuration files are <a href="#allowoverride">enabled for that

    directory</a>. For example:</p>



    <highlight language="config">AccessFileName .acl</highlight>

    <highlight language="config">

AccessFileName .acl

    </highlight>



    <p>Before returning the document

    <code>/usr/local/web/index.html</code>, the server will read
@@ -240,7 +242,9 @@ content-type is <code>text/plain</code> or <code>text/html</code></description> 
    charset values</a> for use in Internet media types (MIME types).

    For example:</p>



    <highlight language="config">AddDefaultCharset utf-8</highlight>

    <highlight language="config">

AddDefaultCharset utf-8

    </highlight>



    <p><directive>AddDefaultCharset</directive> should only be used when all

    of the text resources to which it applies are known to be in that
@@ -320,7 +324,7 @@ NoDecode option available in 2.3.12 and later.</compatibility> 


    <p>When this directive is set to <code>None</code> and <directive

    module="core">AllowOverrideList</directive> is set to

    <code>None</code> <a href="#accessfilename">.htaccess</a>, files are

    <code>None</code>, <a href="#accessfilename">.htaccess</a> files are

    completely ignored. In this case, the server will not even attempt

    to read <code>.htaccess</code> files in the filesystem.</p>
@@ -439,8 +443,8 @@ NoDecode option available in 2.3.12 and later.</compatibility> 
      Allow use of the directives controlling specific directory

      features (<directive module="core">Options</directive> and

      <directive module="mod_include">XBitHack</directive>).

      An equal sign may be given followed by a comma-separated list, without spaces,

      of options that may be set using the <directive

      An equal sign may be given followed by a comma-separated list, without

      spaces, of options that may be set using the <directive

      module="core">Options</directive> command.



      <note><title>Implicit disabling of Options</title>
@@ -460,7 +464,9 @@ NoDecode option available in 2.3.12 and later.</compatibility> 


    <p>Example:</p>



    <highlight language="config">AllowOverride AuthConfig Indexes</highlight>

    <highlight language="config">

AllowOverride AuthConfig Indexes

    </highlight>



    <p>In the example above, all directives that are neither in the group

    <code>AuthConfig</code> nor <code>Indexes</code> cause an internal
@@ -718,7 +724,9 @@ which no other media type configuration could be found. 
    of configuration files, it may be specified with the value

    <code>none</code>, meaning no default media type. For example:</p>



    <highlight language="config">DefaultType None</highlight>

    <highlight language="config">

DefaultType None

    </highlight>



    <p><code>DefaultType None</code> is only available in

    httpd-2.2.7 and later.</p>
@@ -774,7 +782,7 @@ DocumentRoot "/var/www/${servername}/htdocs" 
<name>Directory</name>

<description>Enclose a group of directives that apply only to the

named file-system directory, sub-directories, and their contents.</description>

<syntax>&lt;Directory "<var>directory-path</var>"&gt;

<syntax>&lt;Directory <var>directory-path</var>&gt;

... &lt;/Directory&gt;</syntax>

<contextlist><context>server config</context><context>virtual host</context>

</contextlist>
@@ -985,7 +993,9 @@ from the web</description> 
    path from the requested URL to the document root to make the

    path to the document. Example:</p>



    <highlight language="config">DocumentRoot "/usr/web"</highlight>

    <highlight language="config">

DocumentRoot "/usr/web"

    </highlight>



    <p>then an access to

    <code>http://my.example.com/index.html</code> refers to
@@ -1130,7 +1140,9 @@ for a complete reference and more examples.</seealso> 
    <p>For server configurations that are vulnerable to these problems,

    you should disable memory-mapping of delivered files by specifying:</p>



    <highlight language="config">EnableMMAP Off</highlight>

    <highlight language="config">

EnableMMAP Off

    </highlight>



    <p>For NFS mounted files, this feature may be disabled explicitly for

    the offending files by specifying:</p>
@@ -1186,7 +1198,9 @@ version 2.3.9.</compatibility> 
    <p>For server configurations that are not vulnerable to these problems,

    you may enable this feature by specifying:</p>



    <highlight language="config">EnableSendfile On</highlight>

    <highlight language="config">

EnableSendfile On

    </highlight>



    <p>For network mounted files, this feature may be disabled explicitly

    for the offending files by specifying:</p>
@@ -1366,13 +1380,17 @@ ErrorDocument 404 /cgi-bin/bad_urls.pl 
    the <var>file-path</var> is not absolute then it is assumed to be

    relative to the <directive module="core">ServerRoot</directive>.</p>



    <highlight language="config">ErrorLog "/var/log/httpd/error_log"</highlight>

    <highlight language="config">

ErrorLog "/var/log/httpd/error_log"

    </highlight>



    <p>If the <var>file-path</var>

    begins with a pipe character "<code>|</code>" then it is assumed to be a

    command to spawn to handle the error log.</p>



    <highlight language="config">ErrorLog "|/usr/local/bin/httpd_errors"</highlight>

    <highlight language="config">

ErrorLog "|/usr/local/bin/httpd_errors"

    </highlight>



    <p>See the notes on <a href="../logs.html#piped">piped logs</a> for

    more information.</p>
@@ -1386,7 +1404,9 @@ ErrorDocument 404 /cgi-bin/bad_urls.pl 
    in individual virtual hosts, the final facility specified affects the

    entire server.</p>



    <highlight language="config">ErrorLog syslog:user</highlight>

    <highlight language="config">

ErrorLog syslog:user

    </highlight>



    <p>Additional modules can provide their own ErrorLog providers. The syntax

    is similar to the <code>syslog</code> example above.</p>
@@ -1687,7 +1707,9 @@ earlier.</compatibility> 
     <dd>The number of bytes in the file will be included</dd>

     <dt><strong>All</strong></dt>

     <dd>All available fields will be used. This is equivalent to:

         <highlight language="config">FileETag INode MTime Size</highlight></dd>

         <highlight language="config">

FileETag INode MTime Size

         </highlight></dd>

     <dt><strong>None</strong></dt>

     <dd>If a document is file-based, no <code>ETag</code> field will be

       included in the response</dd>
@@ -1726,7 +1748,7 @@ earlier.</compatibility> 
<name>Files</name>

<description>Contains directives that apply to matched

filenames</description>

<syntax>&lt;Files "<var>filename</var>"&gt; ... &lt;/Files&gt;</syntax>

<syntax>&lt;Files <var>filename</var>&gt; ... &lt;/Files&gt;</syntax>

<contextlist><context>server config</context><context>virtual host</context>

<context>directory</context><context>.htaccess</context>

</contextlist>
@@ -1858,7 +1880,9 @@ media type in the HTTP Content-Type header field</description> 
    GIF files, but did not want to label them all with <code>.gif</code>,

    you might want to use:</p>



    <highlight language="config">ForceType image/gif</highlight>

    <highlight language="config">

ForceType image/gif

    </highlight>



    <p>Note that this directive overrides other indirect media type

    associations defined in mime.types or via the
@@ -1982,7 +2006,9 @@ satisfied by a request at runtime</description> 
    directives if and only if the expression evaluates to true.

    For example:</p>



    <highlight language="config">&lt;If "-z req('Host')"&gt;</highlight>

    <highlight language="config">

&lt;If "-z req('Host')"&gt;

    </highlight>



    <p>would match HTTP/1.0 requests without a <var>Host:</var> header.

    Expressions may contain various shell-like operators for string
@@ -1991,7 +2017,9 @@ satisfied by a request at runtime</description> 
    and others (<code>-n</code>, <code>-z</code>, <code>-f</code>, ...).

    It is also possible to use regular expressions, </p>



    <highlight language="config">&lt;If "%{QUERY_STRING} =~ /(delete|commit)=.*?elem/"&gt;</highlight>

    <highlight language="config">

&lt;If "%{QUERY_STRING} =~ /(delete|commit)=.*?elem/"&gt;

    </highlight>



    <p>shell-like pattern matches and many other operations. These operations

    can be done on request headers (<code>req</code>), environment variables
@@ -2195,12 +2223,16 @@ Include conf/vhosts/*.conf 
    path. This example will fail if there is no subdirectory in conf/vhosts

    that contains at least one *.conf file:</p>



    <highlight language="config">Include conf/vhosts/*/*.conf</highlight>

    <highlight language="config">

Include conf/vhosts/*/*.conf

    </highlight>



    <p>Alternatively, the following command will just be ignored in case of

    missing files or directories:</p>



    <highlight language="config">IncludeOptional conf/vhosts/*/*.conf</highlight>

    <highlight language="config">

IncludeOptional conf/vhosts/*/*.conf

    </highlight>



</usage>
@@ -2437,7 +2469,9 @@ subrequests</description> 
    determines how deeply subrequests may be nested. If you specify only one

    <var>number</var>, it will be assigned to both limits.</p>



    <highlight language="config">LimitInternalRecursion 5</highlight>

    <highlight language="config">

LimitInternalRecursion 5

    </highlight>

</usage>

</directivesynopsis>
@@ -2480,7 +2514,9 @@ from the client</description> 
    location and wish to limit the size of the uploaded file to 100K,

    you might use the following directive:</p>



    <highlight language="config">LimitRequestBody 102400</highlight>

    <highlight language="config">

LimitRequestBody 102400

    </highlight>



    <note><p>For a full description of how this directive is interpreted by

    proxy requests, see the <module>mod_proxy</module> documentation.</p>
@@ -2523,7 +2559,9 @@ will be accepted from the client</description> 


    <p>For example:</p>



    <highlight language="config">LimitRequestFields 50</highlight>

    <highlight language="config">

LimitRequestFields 50

    </highlight>



     <note type="warning"><title>Warning</title>

     <p> When name-based virtual hosting is used, the value for this
@@ -2562,7 +2600,9 @@ client</description> 


    <p>For example:</p>



    <highlight language="config">LimitRequestFieldSize 4094</highlight>

    <highlight language="config">

LimitRequestFieldSize 4094

    </highlight>



    <note>Under normal conditions, the value should not be changed from

    the default.</note>
@@ -2603,7 +2643,9 @@ from the client</description> 


    <p>For example:</p>



    <highlight language="config">LimitRequestLine 4094</highlight>

    <highlight language="config">

LimitRequestLine 4094

    </highlight>



    <note>Under normal conditions, the value should not be changed from

    the default.</note>
@@ -2632,7 +2674,9 @@ from the client</description> 


    <p>Example:</p>



    <highlight language="config">LimitXMLRequestBody 0</highlight>

    <highlight language="config">

LimitXMLRequestBody 0

    </highlight>



</usage>

</directivesynopsis>
@@ -2642,7 +2686,7 @@ from the client</description> 
<description>Applies the enclosed directives only to matching

URLs</description>

<syntax>&lt;Location

    "<var>URL-path</var>|<var>URL</var>"&gt; ... &lt;/Location&gt;</syntax>

    <var>URL-path</var>|<var>URL</var>&gt; ... &lt;/Location&gt;</syntax>

<contextlist><context>server config</context><context>virtual host</context>

</contextlist>
@@ -3001,7 +3045,9 @@ matching URLs</description> 


    <p>For example:</p>



    <highlight language="config">LogLevel notice</highlight>

    <highlight language="config">

LogLevel notice

    </highlight>



    <note><title>Note</title>

      <p>When logging to a regular file, messages of the level
@@ -3064,7 +3110,9 @@ connection</description> 


    <p>For example:</p>



    <highlight language="config">MaxKeepAliveRequests 500</highlight>

    <highlight language="config">

MaxKeepAliveRequests 500

    </highlight>

</usage>

</directivesynopsis>
@@ -3529,7 +3577,7 @@ directory</description> 
    <p>Normally, if multiple <directive>Options</directive> could

    apply to a directory, then the most specific one is used and

    others are ignored; the options are not merged. (See <a

    href="../sections.html#mergin">how sections are merged</a>.)

    href="../sections.html#merging">how sections are merged</a>.)

    However if <em>all</em> the options on the

    <directive>Options</directive> directive are preceded by a

    <code>+</code> or <code>-</code> symbol, the options are
@@ -3604,9 +3652,12 @@ On Windows, from Apache 2.3.3 and later.</compatibility> 
       otherwise, <code>http</code> is assumed for port 80 and <code>https</code>

       for port 443.</p>



    <p>For example, if you are running <code>https</code> on a non-standard port, specify the protocol explicitly:</p>

    <p>For example, if you are running <code>https</code> on a non-standard port,

       specify the protocol explicitly:</p>



    <highlight language="config">Protocol https</highlight>

    <highlight language="config">

Protocol https

    </highlight>



    <p>You can also specify the protocol using the <directive module="mpm_common">Listen</directive> directive.</p>

</usage>
@@ -3808,11 +3859,15 @@ scripts</description> 
    by the shebang line (first line, starting with <code>#!</code>) in the

    script. On Win32 systems this line usually looks like:</p>



    <highlight language="perl">#!C:/Perl/bin/perl.exe</highlight>

    <highlight language="perl">

#!C:/Perl/bin/perl.exe

    </highlight>



    <p>or, if <code>perl</code> is in the <code>PATH</code>, simply:</p>



    <highlight language="perl">#!perl</highlight>

    <highlight language="perl">

#!perl

    </highlight>



    <p>Setting <code>ScriptInterpreterSource Registry</code> will

    cause the Windows Registry tree <code>HKEY_CLASSES_ROOT</code> to be
@@ -3908,7 +3963,9 @@ messages sent to the client</description> 


    <p>It may be worth setting up a dedicated address for this, e.g.</p>



    <highlight language="config">ServerAdmin www-admin@foo.example.com</highlight>

    <highlight language="config">

ServerAdmin www-admin@foo.example.com

    </highlight>

    <p>as users do not always mention that they are talking about the

    server!</p>

</usage>
@@ -3983,7 +4040,9 @@ itself</description> 
    and you wish the web server to be so identified, the following

    directive should be used:</p>



    <highlight language="config">ServerName www.example.com</highlight>

    <highlight language="config">

ServerName www.example.com

    </highlight>



    <p>The <directive>ServerName</directive> directive

    may appear anywhere within the definition of a server. However,
@@ -4078,7 +4137,9 @@ is accessed by an incompatible browser</description> 
    module="mod_so">LoadModule</directive>, for example) are taken as

    relative to this directory.</p>



    <highlight language="config">ServerRoot "/home/httpd"</highlight>

    <highlight language="config">

ServerRoot "/home/httpd"

    </highlight>



    <p>The default location of <directive>ServerRoot</directive> may be

    modified by using the <code>--prefix</code> argument to
@@ -4218,7 +4279,9 @@ handler</description> 
    of extension, you might put the following into an

    <code>.htaccess</code> file in that directory:</p>



    <highlight language="config">SetHandler imap-file</highlight>

    <highlight language="config">

SetHandler imap-file

    </highlight>



    <p>Another example: if you wanted to have the server display a

    status report whenever a URL of