Commit 61eca626 authored by Brian Pane's avatar Brian Pane
Browse files

Added documentation for the new EnableMMAP directive


git-svn-id: https://svn.apache.org/repos/asf/httpd/httpd/trunk@95100 13f79535-47bb-0310-9956-ffa450edef68
parent 78ad2a43
Loading
Loading
Loading
Loading
+39 −0
Changes for docs/manual/mod/core.xml: 39 added lines, 0 removed lines.
Original line number Diff line number Diff line
@@ -544,6 +544,45 @@ from the web</description>
Location</a></seealso>
</directivesynopsis>

<directivesynopsis>
<name>EnableMMAP</name>
<description>Controls whether the httpd uses memory-mapping to read files
during delivery</description>
<syntax>EnableMMAP on|off</syntax>
<default>EnableMMAP on</default>
<contextlist><context>server config</context><context>virtual host</context>
<context>directory</context><context>.htaccess</context>
</contextlist>

<usage>
    <p>This directive controls whether the httpd may use memory-mapping
    if it needs to read the contents of a file during delivery.  By default,
    when the handling of a request requires access to the data within a file--
    for example, when delivering a server-parsed file using <module>mod_include</module>--
    Apache memory-maps the file if the OS supports it.
    </p>
    <p>
    This memory-mapping sometimes yields a performance improvement.
    But in some environments, it is better to disable the memory-mapping
    to prevent operational problems:
    </p>
    <ul>
    <li>On some multiprocessor systems, memory-mapping can reduce the
    performance of the httpd.</li>
    <li>With an NFS-mounted <directive module="core">DocumentRoot</directive>,
    the httpd may crash due tof a segmentation fault if a file is deleted
    or truncated while the httpd has it memory-mapped.</li>
    </ul>
    <p>
    For server configurations that are vulnerable to these problems,
    you should disable memory-mapping of delivered files by specifying:
    </p>
<example>
   EnableMMAP off
</example>
</usage>
</directivesynopsis>

<directivesynopsis>
<name>ErrorDocument</name>
<description>Specifies what the server will return to the client