httpd-cvs mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From rbo...@apache.org
Subject cvs commit: httpd-2.0/docs/manual/mod core.xml
Date Sat, 23 Mar 2002 03:23:16 GMT
rbowen      02/03/22 19:23:16

  Modified:    docs     STATUS
               docs/manual/mod core.xml
  Log:
  Completed going through mod/code.xml ensuring that every directive
  contains at least one example. A little additional clarification a few
  places. Updates STATUS to reflect the status of this task.
  
  Revision  Changes    Path
  1.21      +4 -4      httpd-2.0/docs/STATUS
  
  Index: STATUS
  ===================================================================
  RCS file: /home/cvs/httpd-2.0/docs/STATUS,v
  retrieving revision 1.20
  retrieving revision 1.21
  diff -u -r1.20 -r1.21
  --- STATUS	17 Feb 2002 21:09:03 -0000	1.20
  +++ STATUS	23 Mar 2002 03:23:15 -0000	1.21
  @@ -1,5 +1,5 @@
   Apache HTTP Server 2.0 Documentation Status File.
  -Last modified: $Date: 2002/02/17 21:09:03 $
  +Last modified: $Date: 2002/03/23 03:23:15 $
   
   If you are interested in helping accomplish some of the tasks on this
   list or otherwise improving the documentation, please join the
  @@ -136,9 +136,9 @@
   
     - Every directive should have at least one example of usage, except
       those directives which list all possible usages in the Syntax
  -    description. Some module docs have been reviewed for this, and
  -    mod/core.html has been checked up through the <Limit> directive.
  -    --rcb
  +    description. And maybe some of those too. People like examples.
  +    mod/core.html has been checked all the way through, as have a few
  +    of the modules.
   
   * Making site-specific enhancements easier, including a documented
     and robust way for 3P module docco to be added -- and have it
  
  
  
  1.3       +86 -58    httpd-2.0/docs/manual/mod/core.xml
  
  Index: core.xml
  ===================================================================
  RCS file: /home/cvs/httpd-2.0/docs/manual/mod/core.xml,v
  retrieving revision 1.2
  retrieving revision 1.3
  diff -u -r1.2 -r1.3
  --- core.xml	6 Mar 2002 22:16:49 -0000	1.2
  +++ core.xml	23 Mar 2002 03:23:15 -0000	1.3
  @@ -1161,14 +1161,23 @@
   
   <usage>
       <p><directive type="section">LimitExcept</directive> and
  -    <code>&lt;/LimitExcept&gt;</code> are used to enclose a group of
  -    access control directives which will then apply to any HTTP access
  -    method <strong>not</strong> listed in the arguments; i.e., it is
  -    the opposite of a <directive type="section"
  +    <code>&lt;/LimitExcept&gt;</code> are used to enclose
  +    a group of access control directives which will then apply to any
  +    HTTP access method <strong>not</strong> listed in the arguments; 
  +    i.e., it is the opposite of a <directive type="section"
       module="core">Limit</directive> section and can be used to control
       both standard and nonstandard/unrecognized methods. See the
       documentation for <directive module="core"
       type="section">Limit</directive> for more details.</p>
  +
  +    <p>For example:</p>
  +
  +    <example>
  +    &lt;LimitExcept POST GET&gt;<br />
  +    Require valid-user<br />
  +    &lt;LimitExcept&gt;
  +    </example>
  +
   </usage>
   </directivesynopsis>
   
  @@ -1206,6 +1215,15 @@
       control over abnormal client request behavior, which may be
       useful for avoiding some forms of denial-of-service
       attacks.</p>
  +
  +    <p>If, for example, you are permitting file upload to a particular
  +    location, and wich to limit the size of the uploaded file to 100K,
  +    you might use the following directive:</p>
  +
  +    <example>
  +    LimitRequestBody 102400
  +    </example>
  +
   </usage>
   </directivesynopsis>
   
  @@ -1240,6 +1258,13 @@
       The value should be increased if normal clients see an error
       response from the server that indicates too many fields were
       sent in the request.</p>
  +
  +    <p>For example:</p>
  +
  +    <example>
  +    LimitRequestFields 50
  +    </example>
  +
   </usage>
   </directivesynopsis>
   
  @@ -1270,9 +1295,17 @@
   
       <p>This directive gives the server administrator greater
       control over abnormal client request behavior, which may be
  -    useful for avoiding some forms of denial-of-service attacks.
  -    Under normal conditions, the value should not be changed from
  -    the default.</p>
  +    useful for avoiding some forms of denial-of-service attacks.</p>
  +
  +    <p>For example:</p>
  +
  +    <example>
  +    LimitRequestFieldSize 16380
  +    </example>
  +
  +    <note>Under normal conditions, the value should not be changed from
  +    the default.</note>
  +
   </usage>
   </directivesynopsis>
   
  @@ -1303,9 +1336,16 @@
   
       <p>This directive gives the server administrator greater
       control over abnormal client request behavior, which may be
  -    useful for avoiding some forms of denial-of-service attacks.
  -    Under normal conditions, the value should not be changed from
  -    the default.</p>
  +    useful for avoiding some forms of denial-of-service attacks.</p>
  +
  +    <p>For example:</p>
  +
  +    <example>
  +    LimitRequestLine 16380
  +    </example>
  +
  +    <note>Under normal conditions, the value should not be changed from
  +    the default.</note>
   </usage>
   </directivesynopsis>
   
  @@ -1319,6 +1359,13 @@
   <usage>
       <p>Limit (in bytes) on maximum size of an XML-based request
       body. A value of <code>0</code> will disable any checking.</p>
  +
  +    <p>Example:</p>
  +
  +    <example>
  +    LimitXMLRequestBody 0
  +    </example>
  +
   </usage>
   </directivesynopsis>
   
  @@ -1327,7 +1374,7 @@
   <description>Applies the enclosed directives only to matching
   URLs</description>
   <syntax>&lt;Location
  -    <em>URL-path</em>|<em>URL</em>&gt; ... &lt;/Location&gt;</syntax>
  +    URL-path|URL&gt; ... &lt;/Location&gt;</syntax>
   <contextlist><context>server config</context><context>virtual host</context>
   </contextlist>
   
  @@ -1456,16 +1503,11 @@
       <em>level</em>s are available, in order of decreasing
       significance:</p>
   
  -    <table>
  +    <table border="1">
         <tr>
           <th><strong>Level</strong> </th>
   
           <th><strong>Description</strong> </th>
  -      </tr>
  -
  -      <tr>
  -        <th>
  -        </th>
   
           <th><strong>Example</strong> </th>
         </tr>
  @@ -1474,11 +1516,6 @@
           <td><code>emerg</code> </td>
   
           <td>Emergencies - system is unusable.</td>
  -      </tr>
  -
  -      <tr>
  -        <td>
  -        </td>
   
           <td>"Child cannot open lock file. Exiting"</td>
         </tr>
  @@ -1487,11 +1524,6 @@
           <td><code>alert</code> </td>
   
           <td>Action must be taken immediately.</td>
  -      </tr>
  -
  -      <tr>
  -        <td>
  -        </td>
   
           <td>"getpwuid: couldn't determine user name from uid"</td>
         </tr>
  @@ -1500,11 +1532,6 @@
           <td><code>crit</code> </td>
   
           <td>Critical Conditions.</td>
  -      </tr>
  -
  -      <tr>
  -        <td>
  -        </td>
   
           <td>"socket: Failed to get a socket, exiting child"</td>
         </tr>
  @@ -1513,11 +1540,6 @@
           <td><code>error</code> </td>
   
           <td>Error conditions.</td>
  -      </tr>
  -
  -      <tr>
  -        <td>
  -        </td>
   
           <td>"Premature end of script headers"</td>
         </tr>
  @@ -1526,11 +1548,6 @@
           <td><code>warn</code> </td>
   
           <td>Warning conditions.</td>
  -      </tr>
  -
  -      <tr>
  -        <td>
  -        </td>
   
           <td>"child process 1234 did not exit, sending another
           SIGHUP"</td>
  @@ -1540,11 +1557,6 @@
           <td><code>notice</code> </td>
   
           <td>Normal but significant condition.</td>
  -      </tr>
  -
  -      <tr>
  -        <td>
  -        </td>
   
           <td>"httpd: caught SIGBUS, attempting to dump core in
           ..."</td>
  @@ -1554,11 +1566,6 @@
           <td><code>info</code> </td>
   
           <td>Informational.</td>
  -      </tr>
  -
  -      <tr>
  -        <td>
  -        </td>
   
           <td>"Server seems busy, (you may need to increase
           StartServers, or Min/MaxSpareServers)..."</td>
  @@ -1568,11 +1575,6 @@
           <td><code>debug</code> </td>
   
           <td>Debug-level messages</td>
  -      </tr>
  -
  -      <tr>
  -        <td>
  -        </td>
   
           <td>"Opening config file ..."</td>
         </tr>
  @@ -1586,6 +1588,11 @@
   
       <p>Using a level of at least <code>crit</code> is
       recommended.</p>
  +
  +    <p>For example:</p>
  +
  +    <example>LogLevel notice</example>
  +
   </usage>
   </directivesynopsis>
   
  @@ -1604,6 +1611,10 @@
       set to "<code>0</code>", unlimited requests will be allowed. We
       recommend that this setting be kept to a high value for maximum
       server performance.</p>
  +
  +    <p>For example:</p>
  +
  +    <example>MaxKeepAliveRequests 500</example>
   </usage>
   </directivesynopsis>
   
  @@ -1650,6 +1661,9 @@
    
   <example>NameVirtualHost [fe80::a00:20ff:fea7:ccea]:8080</example>
   
  +<seealso>See also: <a href="../vhosts/">Virtual Hosts
  +documentation</a></seealso>
  +
   </usage>
   </directivesynopsis>
   
  @@ -1971,7 +1985,21 @@
       valid username and password. This can be used to password restrict
       an area, but to let clients from particular addresses in without
       prompting for a password.</p>
  +
  +    <p>For example, if you wanted to let people on your network have
  +    unrestricted access to a portion of your website, but require that
  +    people outside of your network provide a password, you could use a
  +    configuration similar to the following:</p>
  +
  +    <example>
  +    Require valid-user<br />
  +    Allow from 192.168.1<br />
  +    Satisfy any
  +    </example>
  +   
   </usage>
  +   <seealso><directive module="mod_access">Allow</directive></seealso>
  +   <seealso><directive module="core">Require</directive></seealso>
   </directivesynopsis>
   
   <directivesynopsis>
  @@ -2480,4 +2508,4 @@
       request is received</seealso>
   </directivesynopsis>
   
  -</modulesynopsis>
  \ No newline at end of file
  +</modulesynopsis>
  
  
  

Mime
View raw message