mod_speling.html revision e0b181d3bfa99dfb992df3024b397660cb7afbe9
5239N/A<html xmlns="http://www.w3.org/TR/xhtml1/strict"><head><!--
5239N/A XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
5239N/A This file is generated from xml source: DO NOT EDIT
5239N/A XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
5239N/A --><title>mod_speling- Apache HTTP Server</title><link rel="stylesheet" type="text/css" href="/style/manual.css"/></head><body><blockquote><div align="center"><img src="/images/sub.gif" alt="[APACHE DOCUMENTATION]"/><h3>Apache HTTP Server Version 2.0</h3></div><h1 align="center">Apache Module mod_speling</h1><table bgcolor="#cccccc" cellpadding="0" cellspacing="1"><tr><td><table bgcolor="#ffffff"><tr><td valign="top"><span class="help">Description:</span></td><td>Attempts to correct mistaken URLs that
5239N/Ausers might have entered by ignoring capitalization and by
5239N/Aallowing up to one misspelling</td></tr><tr><td><a class="help" href="module-dict.html#Status">Status:</a></td><td>Extension</td></tr><tr><td><a class="help" href="module-dict.html#ModuleIdentifier">Module&nbsp;Identifier:</a></td><td>speling_module</td></tr></table></td></tr></table><h2>Summary</h2>
5239N/A
5239N/A <p>Requests to documents sometimes cannot be served by the core
5239N/A apache server because the request was misspelled or
5239N/A miscapitalized. This module addresses this problem by trying to
5239N/A find a matching document, even after all other modules gave up.
5239N/A It does its work by comparing each document name in the
5239N/A requested directory against the requested document name
5239N/A <strong>without regard to case</strong>, and allowing
5239N/A <strong>up to one misspelling</strong> (character insertion /
5239N/A omission / transposition or wrong character). A list is built
5239N/A with all document names which were matched using this
5239N/A strategy.</p>
5239N/A
5239N/A <p>If, after scanning the directory,</p>
5239N/A
5239N/A <ul>
5239N/A <li>no matching document was found, Apache will proceed as
5239N/A usual and return a "document not found" error.</li>
5239N/A
5239N/A <li>only one document is found that "almost" matches the
5239N/A request, then it is returned in the form of a redirection
5239N/A response.</li>
5239N/A
5239N/A <li>more than one document with a close match was found, then
5239N/A the list of the matches is returned to the client, and the
5239N/A client can select the correct candidate.</li>
5239N/A </ul>
5239N/A
5239N/A<h2>Directives</h2><ul><li><a href="#checkspelling">CheckSpelling</a></li></ul><hr/><h2><a name="CheckSpelling">CheckSpelling</a> <a name="checkspelling">Directive</a></h2><table bgcolor="#cccccc" border="0" cellspacing="0" cellpadding="1"><tr><td><table bgcolor="#ffffff"><tr><td><strong>Description: </strong></td><td>Enables the spelling
5239N/Amodule</td></tr><tr><td><a class="help" href="directive-dict.html#Syntax">Syntax:</a></td><td>CheckSpelling on|off</td></tr><tr><td><a class="help" href="directive-dict.html#Default">Default:</a></td><td><code>CheckSpelling Off</code></td></tr><tr><td><a class="help" href="directive-dict.html#Context">Context:</a></td><td>server config, virtual host, directory, .htaccess</td></tr><tr><td><a class="help" href="directive-dict.html#Override">Override:</a></td><td>Options</td></tr><tr><td><a class="help" href="directive-dict.html#Status">Status:</a></td><td>Extension</td></tr><tr><td><a class="help" href="directive-dict.html#Module">Module:</a></td><td>mod_speling</td></tr><tr><td valign="top" align="left"><a class="help" href="directive-dict.html#Compatibility">Compatibility:</a></td><td>CheckSpelling was available as a separately available
5239N/Amodule for Apache 1.1, but was limited to miscapitalizations. As
5239N/Aof Apache 1.3, it is part of the Apache distribution. Prior to Apache
5239N/A1.3.2, the CheckSpelling directive was only available in the
5239N/A"server" and "virtual host" contexts.</td></tr></table></td></tr></table>
5239N/A
5239N/A <p>This directive enables or disables the spelling module. When
5239N/A enabled, keep in mind that</p>
5239N/A
5239N/A <ul>
5239N/A <li>the directory scan which is necessary for the spelling
5239N/A correction will have an impact on the server's performance
5239N/A when many spelling corrections have to be performed at the
5239N/A same time.</li>
5239N/A
5239N/A <li>the document trees should not contain sensitive files
5239N/A which could be matched inadvertently by a spelling
5239N/A "correction".</li>
5239N/A
5239N/A <li>the module is unable to correct misspelled user names (as
5239N/A in <code>http://my.host/~apahce/</code>), just file names or
5239N/A directory names.</li>
5239N/A
5239N/A <li>spelling corrections apply strictly to existing files, so
5239N/A a request for the <code>&lt;Location /status&gt;</code> may
5239N/A get incorrectly treated as the negotiated file
5239N/A "<code>/stats.html</code>".</li>
5239N/A </ul>
5239N/A<hr/></blockquote><h3 align="center">Apache HTTP Server Version 2.0</h3><a href="./"><img src="/images/index.gif" alt="Index"/></a><a href="../"><img src="/images/home.gif" alt="Home"/></a></body></html>