httpd-cvs mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From jaillet...@apache.org
Subject svn commit: r1750444 - /httpd/httpd/branches/2.4.x/docs/manual/mod/core.xml
Date Tue, 28 Jun 2016 04:43:43 GMT
Author: jailletc36
Date: Tue Jun 28 04:43:43 2016
New Revision: 1750444

URL: http://svn.apache.org/viewvc?rev=1750444&view=rev
Log:
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

Modified:
    httpd/httpd/branches/2.4.x/docs/manual/mod/core.xml

Modified: httpd/httpd/branches/2.4.x/docs/manual/mod/core.xml
URL: http://svn.apache.org/viewvc/httpd/httpd/branches/2.4.x/docs/manual/mod/core.xml?rev=1750444&r1=1750443&r2=1750444&view=diff
==============================================================================
--- httpd/httpd/branches/2.4.x/docs/manual/mod/core.xml (original)
+++ httpd/httpd/branches/2.4.x/docs/manual/mod/core.xml Tue Jun 28 04:43:43 2016
@@ -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>
     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
 
     <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
       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
 
     <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
     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}/htd
 <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>
@@ -822,7 +830,7 @@ named file-system directory, sub-directo
 &lt;Directory ~ "^/www/[0-9]{3}"&gt;
 
 &lt;/Directory&gt;
-</highlight>
+    </highlight>
 
     <p>would match directories in <code>/www/</code> that consisted of
     three numbers.</p>
@@ -928,7 +936,7 @@ the contents of file-system directories
 &lt;DirectoryMatch "^/www/(.+/)?[0-9]{3}/"&gt;
     # ...
 &lt;/DirectoryMatch&gt;
-</highlight>
+    </highlight>
 
     <p>matches directories in <code>/www/</code> (or any subdirectory thereof)
     that consist of three numbers.</p>
@@ -954,11 +962,11 @@ the contents of file-system directories
     <module>mod_rewrite</module>. In order to prevent confusion, numbered
     (unnamed) backreferences are ignored. Use named groups instead.</p>
 
-<highlight language="config">
+    <highlight language="config">
 &lt;DirectoryMatch "^/var/www/combined/(?&lt;sitename&gt;[^/]+)"&gt;
     Require ldap-group cn=%{env:MATCH_SITENAME},ou=combined,o=Example
 &lt;/DirectoryMatch&gt;
-</highlight>
+    </highlight>
 </usage>
 <seealso><directive type="section" module="core">Directory</directive>
for
 a description of how regular expressions are mixed in with normal
@@ -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 exampl
     <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>
@@ -1593,7 +1613,7 @@ ErrorLogFormat "[%{u}t] [%-m:%l] [pid %P
 
     <p>This would result in error messages such as:</p>
 
-	<example>
+    <example>
     [Thu May 12 08:28:57.652118 2011] [core:error] [pid 8777:tid 4326490112] [client ::1:58619]
File does not exist: /usr/local/apache2/htdocs/favicon.ico
     </example>
 
@@ -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>
@@ -1762,7 +1784,7 @@ filenames</description>
 &lt;Files "?at.*"&gt;
     # This would apply to cat.html, bat.html, hat.php and so on.
 &lt;/Files&gt;
-</highlight>
+    </highlight>
     <p><glossary ref="regex">Regular expressions</glossary>
     can also be used, with the addition of the
     <code>~</code> character. For example:</p>
@@ -1771,7 +1793,7 @@ filenames</description>
 &lt;Files ~ "\.(gif|jpe?g|png)$"&gt;
     #...
 &lt;/Files&gt;
-</highlight>
+    </highlight>
 
     <p>would match most common Internet graphics formats. <directive
     module="core" type="section">FilesMatch</directive> is preferred,
@@ -1807,11 +1829,11 @@ filenames</description>
     does. However, it accepts a <glossary ref="regex">regular
     expression</glossary>. For example:</p>
 
-<highlight language="config">
+    <highlight language="config">
 &lt;FilesMatch ".+\.(gif|jpe?g|png)$"&gt;
     # ...
 &lt;/FilesMatch&gt;
-</highlight>
+    </highlight>
 
     <p>would match most common Internet graphics formats.</p>
 
@@ -1826,11 +1848,11 @@ filenames</description>
     <module>mod_rewrite</module>. In order to prevent confusion, numbered
     (unnamed) backreferences are ignored. Use named groups instead.</p>
 
-<highlight language="config">
+    <highlight language="config">
 &lt;FilesMatch "^(?&lt;sitename&gt;[^/]+)"&gt;
     require ldap-group cn=%{env:MATCH_SITENAME},ou=combined,o=Example
 &lt;/FilesMatch&gt;
-</highlight>
+    </highlight>
 </usage>
 
 <seealso><a href="../sections.html">How &lt;Directory&gt;, &lt;Location&gt;
@@ -1858,7 +1880,9 @@ media type in the HTTP Content-Type head
     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</descr
     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</descr
     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</descri
 
     <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>
 
@@ -2730,7 +2774,7 @@ URLs</description>
 &lt;Location ~ "/(extra|special)/data"&gt;
     #...
 &lt;/Location&gt;
-</highlight>
+    </highlight>
 
     <p>would match URLs that contained the substring <code>/extra/data</code>
     or <code>/special/data</code>. The directive <directive
@@ -2801,7 +2845,7 @@ matching URLs</description>
 &lt;LocationMatch "/(extra|special)/data"&gt;
     # ...
 &lt;/LocationMatch&gt;
-</highlight>
+    </highlight>
 
     <p>would match URLs that contained the substring <code>/extra/data</code>
     or <code>/special/data</code>.</p>
@@ -2812,7 +2856,7 @@ matching URLs</description>
     regular expression with a <code>^</code> to require this.</p>
 
     <highlight language="config">
-    &lt;LocationMatch "^/(extra|special)/data"&gt;
+&lt;LocationMatch "^/(extra|special)/data"&gt;
     </highlight>
     </note>
 
@@ -2823,11 +2867,11 @@ matching URLs</description>
     <module>mod_rewrite</module>. In order to prevent confusion, numbered
     (unnamed) backreferences are ignored. Use named groups instead.</p>
 
-<highlight language="config">
+    <highlight language="config">
 &lt;LocationMatch "^/combined/(?&lt;sitename&gt;[^/]+)"&gt;
     require ldap-group cn=%{env:MATCH_SITENAME},ou=combined,o=Example
 &lt;/LocationMatch&gt;
-</highlight>
+    </highlight>
 </usage>
 
 <seealso><a href="../sections.html">How &lt;Directory&gt;, &lt;Location&gt;
@@ -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
@@ -3035,9 +3081,9 @@ LogLevel info
 
     <note>
         Per directory loglevel configuration only affects messages that are
-	logged after the request has been parsed and that are associated with
-	the request. Log messages which are associated with the connection or
-	the server are not affected.
+        logged after the request has been parsed and that are associated with
+        the request. Log messages which are associated with the connection or
+        the server are not affected.
     </note>
 </usage>
 <seealso><directive module="core">ErrorLog</directive></seealso>
@@ -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.
        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>
@@ -3637,7 +3688,7 @@ On Windows, from Apache 2.3.3 and later.
             specify:</p>
         
         <highlight language="config">
-            Protocols h2 http/1.1
+Protocols h2 http/1.1
         </highlight>
 
         <p>Valid protocols are <code>http/1.1</code> for http and https
connections,
@@ -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>
@@ -3946,7 +4003,7 @@ to name-virtual hosts</description>
 
     <p>The complete list of names in the <directive type="section" module="core"
     >VirtualHost</directive>
-    directive are treated just like a (non wildcard) 
+    directive are treated just like a (non wildcard)
     <directive>ServerAlias</directive>.</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,
@@ -3994,7 +4053,7 @@ itself</description>
     server attempts to deduce the client visible hostname by first asking 
     the operating system for the system hostname, and if that fails, 
     performing a reverse lookup on an IP address present on the system.</p>
-    
+
     <p>If no port is specified in the
     <directive>ServerName</directive>, then the server will use the
     port from the incoming request. For optimal reliability and
@@ -4078,7 +4137,9 @@ is accessed by an incompatible browser</
     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
@@ -4647,8 +4710,8 @@ hostname or IP address</description>
 
 <usage>
     <p>This directive controls whether HTTP trailers are copied into the
-    internal representation of HTTP headers. This merging occurs when the 
-    request body has been completely consumed, long after most header 
+    internal representation of HTTP headers. This merging occurs when the
+    request body has been completely consumed, long after most header
     processing would have a chance to examine or modify request headers.</p>
     <p>This option is provided for compatibility with releases prior to 2.4.11,
     where trailers were always merged.</p>
@@ -4658,7 +4721,7 @@ hostname or IP address</description>
 <directivesynopsis>
 <name>QualifyRedirectURL</name>
 <description>Controls whether the REDIRECT_URL environment variable is
-fully qualified</description>
+             fully qualified</description>
 <syntax>QualifyRedirectURL ON|OFF</syntax>
 <default>QualifyRedirectURL OFF</default>
 <contextlist><context>server config</context><context>virtual host</context>



Mime
View raw message