<-
Apache > HTTP Server > Documentation > Version 2.5 > Modules

Apache Module mod_speling

Available Languages:  en  |  ja  |  ko 

Description:Attempts to correct mistaken URLs by ignoring capitalization, or attempting to correct various minor misspellings.
Status:Extension
Module Identifier:speling_module
Source File:mod_speling.c

Summary

Requests to documents sometimes cannot be served by the core apache server because the request was misspelled or miscapitalized. This module addresses this problem by trying to find a matching document, even after all other modules gave up. It does its work by comparing each document name in the requested directory against the requested document name without regard to case, and allowing up to one misspelling (character insertion / omission / transposition or wrong character). A list is built with all document names which were matched using this strategy.

If, after scanning the directory,

Directives

Bugfix checklist

top

CheckBasenameMatch Directive

Description:Also match files with differing file name extensions.
Syntax:CheckBasenameMatch on|off
Default:CheckBasenameMatch Off
Context:server config, virtual host, directory, .htaccess
Override:Options
Status:Extension
Module:mod_speling

When set, this directive extends the action of the spelling correction to the file name extension. For example a file foo.gif will match a request for foo or foo.jpg. This can be particulary useful in conjunction with MultiViews.

top

CheckCaseOnly Directive

Description:Limits the action of the speling module to case corrections
Syntax:CheckCaseOnly on|off
Default:CheckCaseOnly Off
Context:server config, virtual host, directory, .htaccess
Override:Options
Status:Extension
Module:mod_speling

When set, this directive limits the action of the spelling correction to lower/upper case changes. Other potential corrections are not performed, except when CheckBasenameMatch is also set.

top

CheckSpelling Directive

Description:Enables the spelling module
Syntax:CheckSpelling on|off
Default:CheckSpelling Off
Context:server config, virtual host, directory, .htaccess
Override:Options
Status:Extension
Module:mod_speling

This directive enables or disables the spelling module. When enabled, keep in mind that

mod_speling should not be enabled in DAV enabled directories, because it will try to "spell fix" newly created resource names against existing filenames, e.g., when trying to upload a new document doc43.html it might redirect to an existing document doc34.html, which is not what was intended.

Available Languages:  en  |  ja  |  ko 

top

Comments

Notice:
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 mailing lists.