1
0
mirror of https://github.com/apache/httpd.git synced 2026-01-26 19:01:35 +03:00
Files
apache/docs/manual/mod/mod_info.xml
Joshua Slive c9b4962ad9 Make the xml match the DTD.
git-svn-id: https://svn.apache.org/repos/asf/httpd/httpd/trunk@93797 13f79535-47bb-0310-9956-ffa450edef68
2002-03-08 18:00:37 +00:00

76 lines
2.6 KiB
XML

<?xml version="1.0"?>
<!DOCTYPE modulesynopsis SYSTEM "../style/modulesynopsis.dtd">
<?xml-stylesheet type="text/xsl" href="../style/manual.xsl"?>
<modulesynopsis>
<name>mod_info</name>
<description>Provides a comprehensive overview of the server
configuration</description>
<status>Extension</status>
<sourcefile>mod_info.c</sourcefile>
<identifier>info_module</identifier>
<summary>
<p>To configure <module>mod_info</module>, 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>
<p>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>
<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>
<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>