pcs 96/11/30 09:06:41
Modified: htdocs/manual/mod core.html Log: Fix various typos. Put directives in alphabetic order. Put <hr>'s between directives. Remove documentation about %s in ErrorDocument ". Update default MaxClients to 256. Revision Changes Path 1.9 +110 -109 apache/htdocs/manual/mod/core.html Index: core.html =================================================================== RCS file: /export/home/cvs/apache/htdocs/manual/mod/core.html,v retrieving revision 1.8 retrieving revision 1.9 diff -C3 -r1.8 -r1.9 *** core.html 1996/11/30 16:53:29 1.8 --- core.html 1996/11/30 17:06:40 1.9 *************** *** 14,22 **** <ul> - <li>RLimitCPU - <li>RLimitMEM - <li>RLimitNPROC <li><A HREF="#accessconfig">AccessConfig</A> <li><A HREF="#accessfilename">AccessFileName</A> <li>AddModule --- 14,19 ---- *************** *** 33,43 **** <li><A HREF="#files"><Files></A> <li><A HREF="#group">Group</A> <li><A HREF="#identitycheck">IdentityCheck</A> ! <li><A HREF="#ifmodule"><IfModule%gt;</A> <li><A HREF="#keepalive">KeepAlive</A> <li><A HREF="#keepalivetimeout">KeepAliveTimeout</A> <li><A HREF="#limit"><Limit></A> ! <li><A HREF="#listen">Listen;</A> <li><A HREF="#location"><Location></A> <li><A HREF="#maxclients">MaxClients</A> <li><A HREF="#maxrequestsperchild">MaxRequestsPerChild</A> --- 30,40 ---- <li><A HREF="#files"><Files></A> <li><A HREF="#group">Group</A> <li><A HREF="#identitycheck">IdentityCheck</A> ! <li><A HREF="#ifmodule"><IfModule></A> <li><A HREF="#keepalive">KeepAlive</A> <li><A HREF="#keepalivetimeout">KeepAliveTimeout</A> <li><A HREF="#limit"><Limit></A> ! <li><A HREF="#listen">Listen</A> <li><A HREF="#location"><Location></A> <li><A HREF="#maxclients">MaxClients</A> <li><A HREF="#maxrequestsperchild">MaxRequestsPerChild</A> *************** *** 48,53 **** --- 45,53 ---- <li><A HREF="#port">Port</A> <li><A HREF="#require">require</A> <li><A HREF="#resourceconfig">ResourceConfig</A> + <li>RLimitCPU + <li>RLimitMEM + <li>RLimitNPROC <li>Satisfy <li><A HREF="#sendbuffersize>SendBufferSize</A> <li><A HREF="#serveradmin">ServerAdmin</A> *************** *** 63,162 **** </ul> <hr> - <A name="sendbuffersize"><h2>SendBufferSize</h2></A> - <!--%plaintext <?INDEX {\tt AccessConfig} directive> --> - <strong>Syntax:</strong> SendBufferSize <em>bytes</em><br> - <strong>Context:</strong> server config, virtual host<br> - <strong>Status:</strong> core<p> - - The server will set the TCP buffer size to the number of bytes - specified. Very useful to increase past standard OS defaults on high - speed high latency (i.e. 100ms or so, such as transcontinental - fast pipes) - - <p><hr> - - <A name="files"><h2><Files></h2></A> - <strong>Syntax:</strong> <Files <em>filename</em>> - ... </Files><br> - <strong>Context:</strong> server config, virtual host, htaccess<br> - <strong>Status:</strong> core<br> - <strong>Compatibility:</strong> only available in Apache - 1.2 and above.<p> - - <p>The <Files> directive provides for access control by - filename. It is comparable to the <a - href="#directory"><Directory></a> directive and - <a href="#location"><Location></a> directives. It - should be matched with a </Files> directive. Directives that - apply to the filename given should be listed - within. <code><Files></code> sections are processed in the - order they appear in the configuration file, after the - <Directory> sections and <code>.htaccess</code> files are - read, but before <Location> sections.</p> - - <p>The <em>filename</em> argument should include a filename, or a - wildcard string, where `?' matches any single character, and `*' matches any - sequences of characters. Extended regular expressions can also be used, with the addition of - the <code>~</code> character. For example:</p> - - <pre> - <Files ~ "\.(gif|jpe?g|png)$"> - </pre> - - would match most common Internet graphics formats. - - <p>Note that unlike <a - href="#directory"><code><Directory></code></a> and <a - href="#location"><code><Location></code></a> sections, - <code><Files></code> sections can be used inside .htaccess - files. This allows users to control access to their own files, at a - file-by-file level. When used in an .htaccess file, if the - <em>filename</em> does not begin with a <code>/</code> character, - the directory being applied will be prefixed automatically. - - <p> <hr> - - <A NAME="ifmodule"><H2><IfModule></H2></A> - <b>Syntax:</b> <IfModule [!]<i>module-name</i>> <i>...</i> - </IfModule><br> - <b>Default:</b> None<br> - <b>Context:</b> all<br> - <b>Status:</b> Core - <strong>Compatibility:</strong> ScriptLog is only available in 1.2 and - later.<P> - - <p> - - The <IfModule <i>test</i>>...</IfModule> - section is used to mark directives that are conditional. The - directives within an IfModule section are only - processed if the <i>test</i> is true. If <i>test</i> - is false, everything between the start and end markers - is ignored.<p> - - The <i>test</i> in the <IfModule> section directive - can be one of two forms: - - <ul> - <li><i>module name</i> - <li>!<i>module name</i> - </ul> - - <p>In the former case, the directives between the start and end markers - are only processed if the module named <i>module name</i> is compiled - in to Apache. The second format reverses the test, and only processes - the directives if <i>module name</i> is <b>not</b> compiled in. - - <p>The <i>module name</i> argument is a module name as given as the file - name of the module, at the time it was compiled. For example, - <code>mod_rewrite.c</code>. - - <p><IfModule> sections are nestable, which can be used to implement - simple multiple-module tests. - - <P> <hr> - <A name="accessconfig"><h2>AccessConfig directive</h2></A> <!--%plaintext <?INDEX {\tt AccessConfig} directive> --> <strong>Syntax:</strong> AccessConfig <em>filename</em><br> --- 63,68 ---- *************** *** 431,438 **** <P><em>Messages</em> in this context, begin with a single quote (<code>"</code>), which does not form part of the message itself. Apache will ! sometime offer additional information regarding the problem/error. This can be ! embedded into the message using <code>%s</code> <P>URLs will begin with a slash (/) for local URLs, or will be a full URL which the client can resolve. Examples: --- 337,343 ---- <P><em>Messages</em> in this context, begin with a single quote (<code>"</code>), which does not form part of the message itself. Apache will ! sometime offer additional information regarding the problem/error. <P>URLs will begin with a slash (/) for local URLs, or will be a full URL which the client can resolve. Examples: *************** *** 460,465 **** --- 365,411 ---- <blockquote><code>ErrorLog /dev/null</code></blockquote> This effectively turns off error logging.<p><hr> + <A name="files"><h2><Files></h2></A> + <strong>Syntax:</strong> <Files <em>filename</em>> + ... </Files><br> + <strong>Context:</strong> server config, virtual host, htaccess<br> + <strong>Status:</strong> core<br> + <strong>Compatibility:</strong> only available in Apache + 1.2 and above.<p> + + <p>The <Files> directive provides for access control by + filename. It is comparable to the <a + href="#directory"><Directory></a> directive and + <a href="#location"><Location></a> directives. It + should be matched with a </Files> directive. Directives that + apply to the filename given should be listed + within. <code><Files></code> sections are processed in the + order they appear in the configuration file, after the + <Directory> sections and <code>.htaccess</code> files are + read, but before <Location> sections.</p> + + <p>The <em>filename</em> argument should include a filename, or a + wildcard string, where `?' matches any single character, and `*' matches any + sequences of characters. Extended regular expressions can also be used, with the addition of + the <code>~</code> character. For example:</p> + + <pre> + <Files ~ "\.(gif|jpe?g|png)$"> + </pre> + + would match most common Internet graphics formats. + + <p>Note that unlike <a + href="#directory"><code><Directory></code></a> and <a + href="#location"><code><Location></code></a> sections, + <code><Files></code> sections can be used inside .htaccess + files. This allows users to control access to their own files, at a + file-by-file level. When used in an .htaccess file, if the + <em>filename</em> does not begin with a <code>/</code> character, + the directory being applied will be prefixed automatically. + + <p> <hr> + <A name="group"><h2>Group directive</h2></A> <!--%plaintext <?INDEX {\tt Group} directive> --> <strong>Syntax:</strong> Group <em>unix-group</em><br> *************** *** 503,508 **** --- 449,494 ---- The information should not trusted in any way except for rudimentary usage tracking.<p><hr> + <A NAME="ifmodule"><H2><IfModule></H2></A> + <b>Syntax:</b> <IfModule [!]<i>module-name</i>> <i>...</i> + </IfModule><br> + <b>Default:</b> None<br> + <b>Context:</b> all<br> + <b>Status:</b> Core + <strong>Compatibility:</strong> ScriptLog is only available in 1.2 and + later.<P> + + <p> + + The <IfModule <i>test</i>>...</IfModule> + section is used to mark directives that are conditional. The + directives within an IfModule section are only + processed if the <i>test</i> is true. If <i>test</i> + is false, everything between the start and end markers + is ignored.<p> + + The <i>test</i> in the <IfModule> section directive + can be one of two forms: + + <ul> + <li><i>module name</i> + <li>!<i>module name</i> + </ul> + + <p>In the former case, the directives between the start and end markers + are only processed if the module named <i>module name</i> is compiled + in to Apache. The second format reverses the test, and only processes + the directives if <i>module name</i> is <b>not</b> compiled in. + + <p>The <i>module name</i> argument is a module name as given as the file + name of the module, at the time it was compiled. For example, + <code>mod_rewrite.c</code>. + + <p><IfModule> sections are nestable, which can be used to implement + simple multiple-module tests. + + <P> <hr> + <h2><a name="keepalive">KeepAlive</a></h2> <strong>Syntax:</strong> KeepAlive <em>max-requests</em><br> <strong>Default:</strong> <code>KeepAlive 5</code><br> *************** *** 531,537 **** value specified by the <a href="../core.html#timeout"><code>Timeout</code></a> directive applies. ! <A name="listen"><h2>Listen</h2></A> <strong>Syntax:</strong> --- 517,523 ---- value specified by the <a href="../core.html#timeout"><code>Timeout</code></a> directive applies. ! <hr> <A name="listen"><h2>Listen</h2></A> <strong>Syntax:</strong> *************** *** 548,553 **** --- 534,540 ---- <p><strong>See Also</strong>: <a href="bind.html">Setting which addresses and ports Apache uses</a></p> + <hr> <A name="limit"><h2><Limit> directive</h2></A> <!--%plaintext <?INDEX {\tt Limit} section directive> --> *************** *** 623,634 **** </Limit> </Location> </pre> ! <A name="maxclients"><h2>MaxClients directive</h2></A> <!--%plaintext <?INDEX {\tt MaxClients} directive> --> <strong>Syntax:</strong> MaxClients <em>number</em><br> ! <strong>Default:</strong> <code>MaxClients 150</code><br> <strong>Context:</strong> server config<br> <strong>Status:</strong> core<p> --- 610,621 ---- </Limit> </Location> </pre> ! <hr> <A name="maxclients"><h2>MaxClients directive</h2></A> <!--%plaintext <?INDEX {\tt MaxClients} directive> --> <strong>Syntax:</strong> MaxClients <em>number</em><br> ! <strong>Default:</strong> <code>MaxClients 256</code><br> <strong>Context:</strong> server config<br> <strong>Status:</strong> core<p> *************** *** 744,754 **** Normally, if multiple <code>Options</code> could apply to a directory, then the most specific one is taken complete; the options are not ! merged. However if <i>all</i> the options on the <code>Options</code> directive are ! preceeded by a + or - symbol, the options are merged. Any options ! preceeded by a + are added to the options currently in force, and any ! options preceeded by a - are removed from the options currently in ! force. <P> For example, without any + and - symbols: --- 731,741 ---- Normally, if multiple <code>Options</code> could apply to a directory, then the most specific one is taken complete; the options are not ! merged. However if <i>all</i> the options on the <code>Options</code> ! directive are preceeded by a + or - symbol, the options are ! merged. Any options preceeded by a + are added to the options ! currently in force, and any options preceeded by a - are removed from ! the options currently in force. <P> For example, without any + and - symbols: *************** *** 774,779 **** --- 761,767 ---- </code></blockquote> then the options <code>FollowSymLinks</code> and <code>Includes</code> are set for the /web/docs/spec directory. + <hr> <A name="pidfile"><h2>PidFile directive</h2></A> <!--%plaintext <?INDEX {\tt PidFile} directive> --> *************** *** 877,882 **** --- 865,882 ---- See also <A HREF="#accessconfig">AccessConfig</A>.<p><hr> + <A name="sendbuffersize"><h2>SendBufferSize</h2></A> + <!--%plaintext <?INDEX {\tt AccessConfig} directive> --> + <strong>Syntax:</strong> SendBufferSize <em>bytes</em><br> + <strong>Context:</strong> server config, virtual host<br> + <strong>Status:</strong> core<p> + + The server will set the TCP buffer size to the number of bytes + specified. Very useful to increase past standard OS defaults on high + speed high latency (i.e. 100ms or so, such as transcontinental + fast pipes) + <p><hr> + <A name="serveradmin"><h2>ServerAdmin directive</h2></A> <!--%plaintext <?INDEX {\tt ServerAdmin} directive> --> <strong>Syntax:</strong> ServerAdmin <em>email-address</em><br> *************** *** 928,933 **** --- 928,934 ---- The ServerAlias directive sets the legacy URL pathname for a host, for use with <a href="host.html">Host-header based virtual hosts</a>. + <hr> <A name="serverroot"><h2>ServerRoot directive</h2></A> <!--%plaintext <?INDEX {\tt ServerRoot} directive> -->