github.com/krum110487/go-htaccess@v0.0.0-20240316004156-60641c8e7598/tests/data/apache_2_2_34/manual/mod/mod_speling.html.en (about)

     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  <meta content="text/html; charset=ISO-8859-1" http-equiv="Content-Type" />
     5  <!--
     6          XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
     7                This file is generated from xml source: DO NOT EDIT
     8          XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
     9        -->
    10  <title>mod_speling - Apache HTTP Server Version 2.2</title>
    11  <link href="../style/css/manual.css" rel="stylesheet" media="all" type="text/css" title="Main stylesheet" />
    12  <link href="../style/css/manual-loose-100pc.css" rel="alternate stylesheet" media="all" type="text/css" title="No Sidebar - Default font size" />
    13  <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" />
    14  <script src="../style/scripts/prettify.min.js" type="text/javascript">
    15  </script>
    16  
    17  <link href="../images/favicon.ico" rel="shortcut icon" /><link href="http://httpd.apache.org/docs/current/mod/mod_speling.html" rel="canonical" /></head>
    18  <body>
    19  <div id="page-header">
    20  <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>
    21  <p class="apache">Apache HTTP Server Version 2.2</p>
    22  <img alt="" src="../images/feather.gif" /></div>
    23  <div class="up"><a href="./"><img title="&lt;-" alt="&lt;-" src="../images/left.gif" /></a></div>
    24  <div id="path">
    25  <a href="http://www.apache.org/">Apache</a> &gt; <a href="http://httpd.apache.org/">HTTP Server</a> &gt; <a href="http://httpd.apache.org/docs/">Documentation</a> &gt; <a href="../">Version 2.2</a> &gt; <a href="./">Modules</a></div>
    26  <div id="page-content">
    27  <div class="retired"><h4>Please note</h4>
    28              <p> This document refers to a legacy release (<strong>2.2</strong>) of Apache httpd. The active release (<strong>2.4</strong>) is documented <a href="http://httpd.apache.org/docs/current">here</a>. If you have not already upgraded, please follow <a href="http://httpd.apache.org/docs/current/upgrading.html">this link</a> for more information.</p>
    29          <p>You may follow <a href="http://httpd.apache.org/docs/current/mod/mod_speling.html">this link</a> to go to the current version of this document.</p></div><div id="preamble"><h1>Apache Module mod_speling</h1>
    30  <div class="toplang">
    31  <p><span>Available Languages: </span><a href="../en/mod/mod_speling.html" title="English">&nbsp;en&nbsp;</a> |
    32  <a href="../ja/mod/mod_speling.html" hreflang="ja" rel="alternate" title="Japanese">&nbsp;ja&nbsp;</a> |
    33  <a href="../ko/mod/mod_speling.html" hreflang="ko" rel="alternate" title="Korean">&nbsp;ko&nbsp;</a></p>
    34  </div>
    35  <table class="module"><tr><th><a href="module-dict.html#Description">Description:</a></th><td>Attempts to correct mistaken URLs that
    36  users might have entered by ignoring capitalization and by
    37  allowing up to one misspelling</td></tr>
    38  <tr><th><a href="module-dict.html#Status">Status:</a></th><td>Extension</td></tr>
    39  <tr><th><a href="module-dict.html#ModuleIdentifier">Module Identifier:</a></th><td>speling_module</td></tr>
    40  <tr><th><a href="module-dict.html#SourceFile">Source File:</a></th><td>mod_speling.c</td></tr></table>
    41  <h3>Summary</h3>
    42  
    43  
    44      <p>Requests to documents sometimes cannot be served by the core
    45      apache server because the request was misspelled or
    46      miscapitalized. This module addresses this problem by trying to
    47      find a matching document, even after all other modules gave up.
    48      It does its work by comparing each document name in the
    49      requested directory against the requested document name
    50      <strong>without regard to case</strong>, and allowing
    51      <strong>up to one misspelling</strong> (character insertion /
    52      omission / transposition or wrong character). A list is built
    53      with all document names which were matched using this
    54      strategy.</p>
    55  
    56      <p>If, after scanning the directory,</p>
    57  
    58      <ul>
    59        <li>no matching document was found, Apache will proceed as
    60        usual and return a "document not found" error.</li>
    61  
    62        <li>only one document is found that "almost" matches the
    63        request, then it is returned in the form of a redirection
    64        response.</li>
    65  
    66        <li>more than one document with a close match was found, then
    67        the list of the matches is returned to the client, and the
    68        client can select the correct candidate.</li>
    69      </ul>
    70  
    71  </div>
    72  <div id="quickview"><h3 class="directives">Directives</h3>
    73  <ul id="toc">
    74  <li><img alt="" src="../images/down.gif" /> <a href="#checkcaseonly">CheckCaseOnly</a></li>
    75  <li><img alt="" src="../images/down.gif" /> <a href="#checkspelling">CheckSpelling</a></li>
    76  </ul>
    77  <ul class="seealso"><li><a href="#comments_section">Comments</a></li></ul></div>
    78  
    79  <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
    80  <div class="directive-section"><h2><a name="CheckCaseOnly" id="CheckCaseOnly">CheckCaseOnly</a> <a name="checkcaseonly" id="checkcaseonly">Directive</a></h2>
    81  <table class="directive">
    82  <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Limits the action of the speling module to case corrections</td></tr>
    83  <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>CheckCaseOnly on|off</code></td></tr>
    84  <tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>CheckCaseOnly Off</code></td></tr>
    85  <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host, directory, .htaccess</td></tr>
    86  <tr><th><a href="directive-dict.html#Override">Override:</a></th><td>Options</td></tr>
    87  <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Extension</td></tr>
    88  <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_speling</td></tr>
    89  </table>
    90      <p>When set, this directive limits the action of the spelling correction to lower/upper case changes. 
    91      Other potential corrections are not performed.</p>
    92  
    93  
    94  </div>
    95  <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
    96  <div class="directive-section"><h2><a name="CheckSpelling" id="CheckSpelling">CheckSpelling</a> <a name="checkspelling" id="checkspelling">Directive</a></h2>
    97  <table class="directive">
    98  <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Enables the spelling 
    99  module</td></tr>
   100  <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>CheckSpelling on|off</code></td></tr>
   101  <tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>CheckSpelling Off</code></td></tr>
   102  <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host, directory, .htaccess</td></tr>
   103  <tr><th><a href="directive-dict.html#Override">Override:</a></th><td>Options</td></tr>
   104  <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Extension</td></tr>
   105  <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_speling</td></tr>
   106  <tr><th><a href="directive-dict.html#Compatibility">Compatibility:</a></th><td>CheckSpelling was available as a separately available
   107  module for Apache 1.1, but was limited to miscapitalizations. As
   108  of Apache 1.3, it is part of the Apache distribution. Prior to Apache
   109  1.3.2, the <code>CheckSpelling</code> directive was only available in the
   110  "server" and "virtual host" contexts.</td></tr>
   111  </table>
   112      <p>This directive enables or disables the spelling module. When
   113      enabled, keep in mind that</p>
   114  
   115      <ul>
   116        <li>the directory scan which is necessary for the spelling
   117        correction will have an impact on the server's performance
   118        when many spelling corrections have to be performed at the
   119        same time.</li>
   120  
   121        <li>the document trees should not contain sensitive files
   122        which could be matched inadvertently by a spelling
   123        "correction".</li>
   124  
   125        <li>the module is unable to correct misspelled user names (as
   126        in <code>http://my.host/~apahce/</code>), just file names or
   127        directory names.</li>
   128  
   129        <li>spelling corrections apply strictly to existing files, so
   130        a request for the <code>&lt;Location /status&gt;</code> may
   131        get incorrectly treated as the negotiated file
   132        "<code>/stats.html</code>".</li>
   133      </ul>
   134  
   135      
   136      <p>mod_speling should not be enabled in <a href="mod_dav.html">DAV</a>
   137      enabled directories, because it will try to "spell fix" newly created
   138      resource names against existing filenames, e.g., when trying to upload
   139      a new document <code>doc43.html</code> it might redirect to an existing
   140      document <code>doc34.html</code>, which is not what was intended.
   141      </p>
   142  
   143  </div>
   144  </div>
   145  <div class="bottomlang">
   146  <p><span>Available Languages: </span><a href="../en/mod/mod_speling.html" title="English">&nbsp;en&nbsp;</a> |
   147  <a href="../ja/mod/mod_speling.html" hreflang="ja" rel="alternate" title="Japanese">&nbsp;ja&nbsp;</a> |
   148  <a href="../ko/mod/mod_speling.html" hreflang="ko" rel="alternate" title="Korean">&nbsp;ko&nbsp;</a></p>
   149  </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&amp;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>
   150  <script type="text/javascript"><!--//--><![CDATA[//><!--
   151  var comments_shortname = 'httpd';
   152  var comments_identifier = 'http://httpd.apache.org/docs/2.2/mod/mod_speling.html';
   153  (function(w, d) {
   154      if (w.location.hostname.toLowerCase() == "httpd.apache.org") {
   155          d.write('<div id="comments_thread"><\/div>');
   156          var s = d.createElement('script');
   157          s.type = 'text/javascript';
   158          s.async = true;
   159          s.src = 'https://comments.apache.org/show_comments.lua?site=' + comments_shortname + '&page=' + comments_identifier;
   160          (d.getElementsByTagName('head')[0] || d.getElementsByTagName('body')[0]).appendChild(s);
   161      }
   162      else { 
   163          d.write('<div id="comments_thread">Comments are disabled for this page at the moment.<\/div>');
   164      }
   165  })(window, document);
   166  //--><!]]></script></div><div id="footer">
   167  <p class="apache">Copyright 2017 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>
   168  <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[//><!--
   169  if (typeof(prettyPrint) !== 'undefined') {
   170      prettyPrint();
   171  }
   172  //--><!]]></script>
   173  </body></html>