cvs commit: httpd-2.0/docs/manual/mod mod_info.xml

[rb...@apache.org]

rbowen      02/02/16 20:03:21

  Added:       docs/manual/mod mod_info.xml
  Log:
  First attempt at converting a module doc to xml.
  
  Revision  Changes    Path
  1.1                  httpd-2.0/docs/manual/mod/mod_info.xml
  
  Index: mod_info.xml
  ===================================================================
  <?xml version="1.0"?>
  <?xml-stylesheet type="text/xsl" href="../style/manual.xsl"?>
  <modulesynopsis>
  
  <name>mod_info</name>
  <status>Extension</status>
  <description>This module provides a comprehensive overview of the server
  configuration including all installed modules and directives in the
  configuration files.</description>
  <identifier>info_module</identifier>
  <sourcefile>mod_info.c</sourcefile>
  <compatibility>Available in Apache 1.1 and later</compatibility>
  
  
  <summary>
  
      <h2>Using mod_info</h2>
  
      <p>To configure it, add the following to your
      <code>httpd.conf</code> file.</p>
  
  <example>
  &lt;Location /server-info&gt;<br />
  SetHandler server-info<br />
  &lt;/Location&gt;<br />
  </example>
  
      You may wish to add a 
      <directive module="core">&lt;Limit&gt;</directive> 
      clause inside the 
      <directive module="core">&lt;location&gt;</directive>
      directive to limit access to your server configuration 
      information. 
  
      <p>Once configured, the server information is obtained by
      accessing <code>http://your.host.dom/server-info</code></p>
  
      <note>
        Note that the configuration files are read by the
        module at run-time, and therefore the display may
        <em>not</em> reflect the running server's active
        configuration if the files have been changed since the server
        was last reloaded. Also, the configuration files must be
        readable by the user as which the server is running (see the
        <directive module="mpm_common">User</directive> directive), or
        else the directive settings will not be listed.
  
        <p>It should also be noted that if
        <module>mod_info</module> is compiled into the server, its
        handler capability is available in <em>all</em> configuration
        files, including <em>per</em>-directory files (<em>e.g.</em>,
        <code>.htaccess</code>). This may have security-related
        ramifications for your site.</p>
      </note>
  </summary>
  
  <directivesynopsis>
  <name>AddModuleInfo</name>
  <description>Allows additional information to be added to the module
  information displayed by the server-info handler</description>
  <syntax>AddModuleInfo <em>module-name string</em></syntax>
  <default><em>none</em></default>
  <contextlist><context>server config</context> <context>virtual
  host</context></contextlist>
  <compatibility>Apache 1.3 and above</compatibility>
  
  <usage>
      <p>This allows the content of <em>string</em> to be shown as
      HTML interpreted, <strong>Additional Information</strong> for
      the module <em>module-name</em>. Example:</p>
  
  <example>
  AddModuleInfo mod_auth.c 'See &lt;A HREF="http://www.apache.org/docs/mod/mod_auth.html"&gt;http://www.apache.org/docs/mod/mod_auth.html&lt;/A&gt;'
  </example>
  </usage>
  
  </directivesynopsis>
  </modulesynopsis>