← Back to branch summary

~ubuntu-branches/ubuntu/feisty/apache2/feisty

« back to all changes in this revision

Viewing changes to docs/manual/mod/mod_speling.html.en

  • Committer: Bazaar Package Importer
  • Author(s): Andreas Barth
  • Date: 2006-12-09 21:05:45 UTC
  • mfrom: (0.6.1 upstream)
  • Revision ID: james.westby@ubuntu.com-20061209210545-h70s0xaqc2v8vqr2
Tags: 2.2.3-3.2
http://bugs.debian.org/396265
* Non-maintainer upload.
* 043_ajp_connection_reuse: Patch from upstream Bugzilla, fixing a critical
  issue with regard to connection reuse in mod_proxy_ajp.
  Closes: #396265

Show diffs side-by-side

added added

removed removed

Lines of Context:
docs/manual/mod/mod_speling.html.en
 
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
 
7
      -->
 
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" />
 
12
<link href="../images/favicon.ico" rel="shortcut icon" /></head>
 
13
<body>
 
14
<div id="page-header">
 
15
<p class="menu"><a href="../mod/">Modules</a> | <a href="../mod/directives.html">Directives</a> | <a href="../faq/">FAQ</a> | <a href="../glossary.html">Glossary</a> | <a href="../sitemap.html">Sitemap</a></p>
 
16
<p class="apache">Apache HTTP Server Version 2.2</p>
 
17
<img alt="" src="../images/feather.gif" /></div>
 
18
<div class="up"><a href="./"><img title="&lt;-" alt="&lt;-" src="../images/left.gif" /></a></div>
 
19
<div id="path">
 
20
<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>
 
21
<div id="page-content">
 
22
<div id="preamble"><h1>Apache Module mod_speling</h1>
 
23
<div class="toplang">
 
24
<p><span>Available Languages: </span><a href="../en/mod/mod_speling.html" title="English">&nbsp;en&nbsp;</a> |
 
25
<a href="../ja/mod/mod_speling.html" hreflang="ja" rel="alternate" title="Japanese">&nbsp;ja&nbsp;</a> |
 
26
<a href="../ko/mod/mod_speling.html" hreflang="ko" rel="alternate" title="Korean">&nbsp;ko&nbsp;</a></p>
 
27
</div>
 
28
<table class="module"><tr><th><a href="module-dict.html#Description">Description:</a></th><td>Attempts to correct mistaken URLs that
 
29
users might have entered by ignoring capitalization and by
 
30
allowing up to one misspelling</td></tr>
 
31
<tr><th><a href="module-dict.html#Status">Status:</a></th><td>Extension</td></tr>
 
32
<tr><th><a href="module-dict.html#ModuleIdentifier">Module�Identifier:</a></th><td>speling_module</td></tr>
 
33
<tr><th><a href="module-dict.html#SourceFile">Source�File:</a></th><td>mod_speling.c</td></tr></table>
 
34
<h3>Summary</h3>
 
35
 
 
36
 
 
37
    <p>Requests to documents sometimes cannot be served by the core
 
38
    apache server because the request was misspelled or
 
39
    miscapitalized. This module addresses this problem by trying to
 
40
    find a matching document, even after all other modules gave up.
 
41
    It does its work by comparing each document name in the
 
42
    requested directory against the requested document name
 
43
    <strong>without regard to case</strong>, and allowing
 
44
    <strong>up to one misspelling</strong> (character insertion /
 
45
    omission / transposition or wrong character). A list is built
 
46
    with all document names which were matched using this
 
47
    strategy.</p>
 
48
 
 
49
    <p>If, after scanning the directory,</p>
 
50
 
 
51
    <ul>
 
52
      <li>no matching document was found, Apache will proceed as
 
53
      usual and return a "document not found" error.</li>
 
54
 
 
55
      <li>only one document is found that "almost" matches the
 
56
      request, then it is returned in the form of a redirection
 
57
      response.</li>
 
58
 
 
59
      <li>more than one document with a close match was found, then
 
60
      the list of the matches is returned to the client, and the
 
61
      client can select the correct candidate.</li>
 
62
    </ul>
 
63
 
 
64
</div>
 
65
<div id="quickview"><h3 class="directives">Directives</h3>
 
66
<ul id="toc">
 
67
<li><img alt="" src="../images/down.gif" /> <a href="#checkspelling">CheckSpelling</a></li>
 
68
</ul>
 
69
</div>
 
70
 
 
71
<div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
 
72
<div class="directive-section"><h2><a name="CheckSpelling" id="CheckSpelling">CheckSpelling</a> <a name="checkspelling" id="checkspelling">Directive</a></h2>
 
73
<table class="directive">
 
74
<tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Enables the spelling 
 
75
module</td></tr>
 
76
<tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>CheckSpelling on|off</code></td></tr>
 
77
<tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>CheckSpelling Off</code></td></tr>
 
78
<tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host, directory, .htaccess</td></tr>
 
79
<tr><th><a href="directive-dict.html#Override">Override:</a></th><td>Options</td></tr>
 
80
<tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Extension</td></tr>
 
81
<tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_speling</td></tr>
 
82
<tr><th><a href="directive-dict.html#Compatibility">Compatibility:</a></th><td>CheckSpelling was available as a separately available
 
83
module for Apache 1.1, but was limited to miscapitalizations. As
 
84
of Apache 1.3, it is part of the Apache distribution. Prior to Apache
 
85
1.3.2, the <code>CheckSpelling</code> directive was only available in the
 
86
"server" and "virtual host" contexts.</td></tr>
 
87
</table>
 
88
    <p>This directive enables or disables the spelling module. When
 
89
    enabled, keep in mind that</p>
 
90
 
 
91
    <ul>
 
92
      <li>the directory scan which is necessary for the spelling
 
93
      correction will have an impact on the server's performance
 
94
      when many spelling corrections have to be performed at the
 
95
      same time.</li>
 
96
 
 
97
      <li>the document trees should not contain sensitive files
 
98
      which could be matched inadvertently by a spelling
 
99
      "correction".</li>
 
100
 
 
101
      <li>the module is unable to correct misspelled user names (as
 
102
      in <code>http://my.host/~apahce/</code>), just file names or
 
103
      directory names.</li>
 
104
 
 
105
      <li>spelling corrections apply strictly to existing files, so
 
106
      a request for the <code>&lt;Location /status&gt;</code> may
 
107
      get incorrectly treated as the negotiated file
 
108
      "<code>/stats.html</code>".</li>
 
109
    </ul>
 
110
 
 
111
    
 
112
    <p>mod_speling should not be enabled in <a href="mod_dav.html">DAV</a>
 
113
    enabled directories, because it will try to "spell fix" newly created
 
114
    resource names against existing filenames, e.g., when trying to upload
 
115
    a new document <code>doc43.html</code> it might redirect to an existing
 
116
    document <code>doc34.html</code>, which is not what was intended.
 
117
    </p>
 
118
 
 
119
</div>
 
120
</div>
 
121
<div class="bottomlang">
 
122
<p><span>Available Languages: </span><a href="../en/mod/mod_speling.html" title="English">&nbsp;en&nbsp;</a> |
 
123
<a href="../ja/mod/mod_speling.html" hreflang="ja" rel="alternate" title="Japanese">&nbsp;ja&nbsp;</a> |
 
124
<a href="../ko/mod/mod_speling.html" hreflang="ko" rel="alternate" title="Korean">&nbsp;ko&nbsp;</a></p>
 
125
</div><div id="footer">
 
126
<p class="apache">Copyright 2006 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>
 
127
<p class="menu"><a href="../mod/">Modules</a> | <a href="../mod/directives.html">Directives</a> | <a href="../faq/">FAQ</a> | <a href="../glossary.html">Glossary</a> | <a href="../sitemap.html">Sitemap</a></p></div>
 
128
</body></html>
 
 
b'\\ No newline at end of file'