1 <?xml version="1.0" encoding="ISO-8859-1"?>
2 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
3 <html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en"><head><!--
4 XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
5 This file is generated from xml source: DO NOT EDIT
6 XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
8 <title>mod_speling - Apache HTTP Server</title>
9 <link href="../style/css/manual.css" rel="stylesheet" media="all" type="text/css" title="Main stylesheet" />
10 <link href="../style/css/manual-loose-100pc.css" rel="alternate stylesheet" media="all" type="text/css" title="No Sidebar - Default font size" />
11 <link href="../style/css/manual-print.css" rel="stylesheet" media="print" type="text/css" /><link rel="stylesheet" type="text/css" href="../style/css/prettify.css" />
12 <script src="../style/scripts/prettify.js" type="text/javascript">
15 <link href="../images/favicon.ico" rel="shortcut icon" /></head>
17 <div id="page-header">
18 <p class="menu"><a href="../mod/">Modules</a> | <a href="../mod/directives.html">Directives</a> | <a href="http://wiki.apache.org/httpd/FAQ">FAQ</a> | <a href="../glossary.html">Glossary</a> | <a href="../sitemap.html">Sitemap</a></p>
19 <p class="apache">Apache HTTP Server Version 2.5</p>
20 <img alt="" src="../images/feather.gif" /></div>
21 <div class="up"><a href="./"><img title="<-" alt="<-" src="../images/left.gif" /></a></div>
23 <a href="http://www.apache.org/">Apache</a> > <a href="http://httpd.apache.org/">HTTP Server</a> > <a href="http://httpd.apache.org/docs/">Documentation</a> > <a href="../">Version 2.5</a> > <a href="./">Modules</a></div>
24 <div id="page-content">
25 <div id="preamble"><h1>Apache Module mod_speling</h1>
27 <p><span>Available Languages: </span><a href="../en/mod/mod_speling.html" title="English"> en </a> |
28 <a href="../ja/mod/mod_speling.html" hreflang="ja" rel="alternate" title="Japanese"> ja </a> |
29 <a href="../ko/mod/mod_speling.html" hreflang="ko" rel="alternate" title="Korean"> ko </a></p>
31 <table class="module"><tr><th><a href="module-dict.html#Description">Description:</a></th><td>Attempts to correct mistaken URLs by ignoring
32 capitalization, or attempting to correct various minor
33 misspellings.</td></tr>
34 <tr><th><a href="module-dict.html#Status">Status:</a></th><td>Extension</td></tr>
35 <tr><th><a href="module-dict.html#ModuleIdentifier">Module Identifier:</a></th><td>speling_module</td></tr>
36 <tr><th><a href="module-dict.html#SourceFile">Source File:</a></th><td>mod_speling.c</td></tr></table>
40 <p>Requests to documents sometimes cannot be served by the core
41 apache server because the request was misspelled or
42 miscapitalized. This module addresses this problem by trying to
43 find a matching document, even after all other modules gave up.
44 It does its work by comparing each document name in the
45 requested directory against the requested document name
46 <strong>without regard to case</strong>, and allowing
47 <strong>up to one misspelling</strong> (character insertion /
48 omission / transposition or wrong character). A list is built
49 with all document names which were matched using this
52 <p>If, after scanning the directory,</p>
55 <li>no matching document was found, Apache will proceed as
56 usual and return a "document not found" error.</li>
58 <li>only one document is found that "almost" matches the
59 request, then it is returned in the form of a redirection
62 <li>more than one document with a close match was found, then
63 the list of the matches is returned to the client, and the
64 client can select the correct candidate.</li>
68 <div id="quickview"><h3 class="directives">Directives</h3>
70 <li><img alt="" src="../images/down.gif" /> <a href="#checkcaseonly">CheckCaseOnly</a></li>
71 <li><img alt="" src="../images/down.gif" /> <a href="#checkspelling">CheckSpelling</a></li>
73 <ul class="seealso"><li><a href="#comments_section">Comments</a></li></ul></div>
75 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
76 <div class="directive-section"><h2><a name="CheckCaseOnly" id="CheckCaseOnly">CheckCaseOnly</a> <a name="checkcaseonly" id="checkcaseonly">Directive</a></h2>
77 <table class="directive">
78 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Limits the action of the speling module to case corrections</td></tr>
79 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>CheckCaseOnly on|off</code></td></tr>
80 <tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>CheckCaseOnly Off</code></td></tr>
81 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host, directory, .htaccess</td></tr>
82 <tr><th><a href="directive-dict.html#Override">Override:</a></th><td>Options</td></tr>
83 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Extension</td></tr>
84 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_speling</td></tr>
86 <p>When set, this directive limits the action of the spelling correction to lower/upper case changes.
87 Other potential corrections are not performed.</p>
91 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
92 <div class="directive-section"><h2><a name="CheckSpelling" id="CheckSpelling">CheckSpelling</a> <a name="checkspelling" id="checkspelling">Directive</a></h2>
93 <table class="directive">
94 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Enables the spelling
96 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>CheckSpelling on|off</code></td></tr>
97 <tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>CheckSpelling Off</code></td></tr>
98 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host, directory, .htaccess</td></tr>
99 <tr><th><a href="directive-dict.html#Override">Override:</a></th><td>Options</td></tr>
100 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Extension</td></tr>
101 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_speling</td></tr>
103 <p>This directive enables or disables the spelling module. When
104 enabled, keep in mind that</p>
107 <li>the directory scan which is necessary for the spelling
108 correction will have an impact on the server's performance
109 when many spelling corrections have to be performed at the
112 <li>the document trees should not contain sensitive files
113 which could be matched inadvertently by a spelling
116 <li>the module is unable to correct misspelled user names (as
117 in <code>http://my.host/~apahce/</code>), just file names or
118 directory names.</li>
120 <li>spelling corrections apply strictly to existing files, so
121 a request for the <code><Location /status></code> may
122 get incorrectly treated as the negotiated file
123 "<code>/stats.html</code>".</li>
127 <p>mod_speling should not be enabled in <a href="mod_dav.html">DAV</a>
128 enabled directories, because it will try to "spell fix" newly created
129 resource names against existing filenames, e.g., when trying to upload
130 a new document <code>doc43.html</code> it might redirect to an existing
131 document <code>doc34.html</code>, which is not what was intended.
136 <div class="bottomlang">
137 <p><span>Available Languages: </span><a href="../en/mod/mod_speling.html" title="English"> en </a> |
138 <a href="../ja/mod/mod_speling.html" hreflang="ja" rel="alternate" title="Japanese"> ja </a> |
139 <a href="../ko/mod/mod_speling.html" hreflang="ko" rel="alternate" title="Korean"> ko </a></p>
140 </div><div class="top"><a href="#page-header"><img src="../images/up.gif" alt="top" /></a></div><div class="section"><h2><a id="comments_section" name="comments_section">Comments</a></h2><div class="warning"><strong>Notice:</strong><br />This is not a Q&A section. Comments placed here should be pointed towards suggestions on improving the documentation or server, and may be removed again by our moderators if they are either implemented or considered invalid/off-topic. Questions on how to manage the Apache HTTP Server should be directed at either our IRC channel, #httpd, on Freenode, or sent to our <a href="http://httpd.apache.org/lists.html">mailing lists</a>.</div>
141 <script type="text/javascript"><!--//--><![CDATA[//><!--
142 var comments_shortname = 'httpd';
143 var comments_identifier = 'http://httpd.apache.org/docs/trunk/mod/mod_speling.html';
145 if (w.location.hostname.toLowerCase() == "httpd.apache.org") {
146 d.write('<div id="comments_thread"><\/div>');
147 var s = d.createElement('script');
148 s.type = 'text/javascript';
150 s.src = 'https://c.apaste.info/show_comments.lua?site=' + comments_shortname + '&page=' + comments_identifier;
151 (d.getElementsByTagName('head')[0] || d.getElementsByTagName('body')[0]).appendChild(s);
154 d.write('<div id="comments_thread">Comments are disabled for this page at the moment.<\/div>');
156 })(window, document);
157 //--><!]]></script></div><div id="footer">
158 <p class="apache">Copyright 2012 The Apache Software Foundation.<br />Licensed under the <a href="http://www.apache.org/licenses/LICENSE-2.0">Apache License, Version 2.0</a>.</p>
159 <p class="menu"><a href="../mod/">Modules</a> | <a href="../mod/directives.html">Directives</a> | <a href="http://wiki.apache.org/httpd/FAQ">FAQ</a> | <a href="../glossary.html">Glossary</a> | <a href="../sitemap.html">Sitemap</a></p></div><script type="text/javascript"><!--//--><![CDATA[//><!--
160 if (typeof(prettyPrint) !== 'undefined') {