You are viewing a plain text version of this content. The canonical link for it is here.
Posted to docs@httpd.apache.org by Hiroaki KAWAI <ha...@bcl.t.u-tokyo.ac.jp> on 2002/10/09 16:54:28 UTC
markups - 2.0/manual/mod/mod_mime.xml
I fixed, added some markups.
--
Index: mod_mime.xml
===================================================================
RCS file: /home/cvspublic/httpd-2.0/docs/manual/mod/mod_mime.xml,v
retrieving revision 1.15
diff -u -r1.15 mod_mime.xml
--- mod_mime.xml 8 Oct 2002 01:46:47 -0000 1.15
+++ mod_mime.xml 9 Oct 2002 14:50:12 -0000
@@ -154,8 +154,7 @@
</section>
-<section>
-
+<section id="charactersetsandlanguages">
<title>Character sets and languages</title>
<p>In addition to file type and the file encoding,
@@ -221,8 +220,9 @@
<usage>
- <p>The AddCharset directive maps the given filename extensions
- to the specified content charset. <em>charset</em> is the MIME
+ <p>The <directive>AddCharset</directive> directive maps the given
+ filename extensions to the specified content charset.
+ <em>charset</em> is the MIME
charset parameter of filenames containing <em>extension</em>.
This mapping is added to any already in force, overriding any
mappings that already exist for the same <em>extension</em>.</p>
@@ -237,8 +237,9 @@
<p>Then the document <code>xxxx.ja.jis</code> will be treated
as being a Japanese document whose charset is ISO-2022-JP (as
- will the document <code>xxxx.jis.ja</code>). The AddCharset
- directive is useful for both to inform the client about the
+ will the document <code>xxxx.jis.ja</code>). The
+ <directive>AddCharset</directive> directive is useful for both
+ to inform the client about the
character encoding of the document so that the document can be
interpreted and displayed appropriately, and for <a
href="../content-negotiation.html">content negotiation</a>,
@@ -271,7 +272,8 @@
<usage>
- <p>The AddEncoding directive maps the given filename extensions
+ <p>The <directive>AddEncoding</directive> directive maps the
+ given filename extensions
to the specified encoding type. <em>MIME-enc</em> is the MIME
encoding to use for documents containing the
<em>extension</em>. This mapping is added to any already in
@@ -297,7 +299,7 @@
(<em>i.e.</em>, <code>x-foo</code> or <code>foo</code>) the
client requested. If the client didn't specifically request a
particular form Apache will use the form given by the
- <code>AddEncoding</code> directive. To make this long story
+ <directive>AddEncoding</directive> directive. To make this long story
short, you should always use <code>x-gzip</code> and
<code>x-compress</code> for these two specific encodings. More
recent encodings, such as <code>deflate</code> should be
@@ -369,8 +371,8 @@
to the <a href="../filter.html">filters</a> which will process
client requests and POST input when they are received by the
server. This is in addition to any filters defined elsewhere,
- including the <a
- href="core.html#setinputfilter">SetInputFilter</a> directive.
+ including the <directive module="core">SetInputFilter</directive>
+ directive.
This mapping is merged over any already in force, overriding any
mappings that already exist for the same <em>extension</em>.</p>
@@ -401,7 +403,8 @@
<usage>
- <p>The AddLanguage directive maps the given filename extension
+ <p>The <directive>AddLanguage</directive> directive maps the
+ given filename extension
to the specified content language. <em>MIME-lang</em> is the
MIME language of filenames containing <em>extension</em>. This
mapping is added to any already in force, overriding any
@@ -420,8 +423,9 @@
being a compressed English document (as will the document
<code>xxxx.Z.en</code>). Although the content language is
reported to the client, the browser is unlikely to use this
- information. The AddLanguage directive is more useful for <a
- href="../content-negotiation.html">content negotiation</a>,
+ information. The <directive>AddLanguage</directive> directive
+ is more useful for <a
+ href="../content-negotiation.html">content negotiation</a>,
where the server returns one from several documents based on
the client's language preference.</p>
@@ -511,7 +515,8 @@
<usage>
- <p>The AddType directive maps the given filename extensions onto
+ <p>The <directive>AddType</directive> directive maps the given
+ filename extensions onto
the specified content type. <em>MIME-type</em> is the MIME type to
use for filenames containing <em>extension</em>. This mapping is
added to any already in force, overriding any mappings that
@@ -556,28 +561,31 @@
<usage>
- <p>MultiviewsMatch permits three different behaviors for
- <a href="mod_negotiation.html">mod_negotiation</a>'s Multiviews
+ <p><directive>MultiviewsMatch</directive> permits three different
+ behaviors for <module>mod_negotiation</module>'s Multiviews
feature. Multiviews allows a request for a file, e.g. index.html,
to match any negotiated extensions following the base request,
e.g. index.html.en, index.html.fr, or index.html.gz.</p>
- <p>The NegotiatedOnly option provides that every extension following
+ <p>The <em>NegotiatedOnly</em> option provides that every extension following
the base name must correlate to a recognized mod_mime extension for
content negotation, e.g. Charset, Content-Type, Language, or
Encoding. This is the strictest implementation with the fewest
unexpected side effects, and is the default behavior.</p>
<p>To include extensions associated with Handlers and/or Filters,
- set the MultiviewsMatch directive to either Handlers, Filters, or
- both option keywords. If all other factors are equal, the smallest
+ set the <directive>MultiviewsMatch</directive> directive to either
+ <em>Handlers</em>, <em>Filters</em>, or both option keywords.
+ If all other factors are equal, the smallest
file will be served, e.g. in deciding between index.html.cgi of 500
characters and index.html.pl of 1000 bytes, the .cgi file would win
in this example. Users of .asis files might prefer to use the
- Handler option, if .asis files are associated with the asis-handler.</p>
+ <em>Handlers</em> option, if .asis files are associated with
+ the asis-handler.</p>
- <p>You may finally allow Any extensions to match, even if mod_mime
- doesn't recognize the extension. This was the behavior in Apache 1.3,
+ <p>You may finally allow Any extensions to match, even if
+ <module>mod_mime</module> doesn't recognize the extension.
+ This was the behavior in Apache 1.3,
and can cause unpredicatable results, such as serving .old or .bak
files the webmaster never expected to be served.</p>
@@ -610,21 +618,22 @@
<usage>
- <p>The DefaultLanguage directive tells Apache that all files in
- the directive's scope (<em>e.g.</em>, all files covered by the
- current <code><Directory></code> container) that don't
+ <p>The <directive>DefaultLanguage</directive> directive tells
+ Apache that all files in the directive's scope (<em>e.g.</em>,
+ all files covered by the current <directive module="core"
+ type="section">Directory</directive> container) that don't
have an explicit language extension (such as <code>.fr</code>
- or <code>.de</code> as configured by <code>AddLanguage</code>)
+ or <code>.de</code> as configured by <directive>AddLanguage</directive>)
should be considered to be in the specified <em>MIME-lang</em>
language. This allows entire directories to be marked as
containing Dutch content, for instance, without having to
rename each file. Note that unlike using extensions to specify
- languages, <code>DefaultLanguage</code> can only specify a
+ languages, <directive>DefaultLanguage</directive> can only specify a
single language.</p>
- <p>If no <code>DefaultLanguage</code> directive is in force,
+ <p>If no <directive>DefaultLanguage</directive> directive is in force,
and a file does not have any language extensions as configured
- by <code>AddLanguage</code>, then that file will be considered
+ by <directive>AddLanguage</directive>, then that file will be considered
to have no language attribute.</p>
<example><title>Example</title>
@@ -650,8 +659,9 @@
<usage>
- <p>The ModMimeUsePathInfo directive is used to combine the filename with
- the path_info URL component to apply mod_mime's directives to the
+ <p>The <directive>ModMimeUsePathInfo</directive> directive is used to
+ combine the filename with the path_info URL component to apply
+ <module>mod_mime</module>'s directives to the
request. The default value is 'Off' - therefore, the path_info
component is ignored.
</p>
@@ -663,12 +673,13 @@
ModMimeUsePathInfo On
</example>
- <p>If you have a request for /bar/foo.shtml where /bar is a Location and
- ModMimeUsePathInfo is on, mod_mime will treat the incoming request as
- /bar/foo.shtml and directives like
- <code>AddOutputFilter INCLUDES .shtml</code> will add the INCLUDES
- filter to the request. If ModMimeUsePathInfo is not set, the includes
- filter will not be added.
+ <p>If you have a request for <code>/bar/foo.shtml</code> where
+ <code>/bar</code> is a Location and
+ <directive>ModMimeUsePathInfo</directive> is on, <module>mod_mime</module>
+ will treat the incoming request as <code>/bar/foo.shtml</code> and
+ directives like <code>AddOutputFilter INCLUDES .shtml</code> will add the INCLUDES
+ filter to the request. If <directive>ModMimeUsePathInfo</directive>
+ is not set, the includes filter will not be added.
</p>
</usage>
@@ -689,7 +700,7 @@
only available in Apache 2.0.24 and later.</compatibility>
<usage>
- <p>The <code>RemoveCharset</code> directive removes any
+ <p>The <directive>RemoveCharset</directive> directive removes any
character set associations for files with the given extensions.
This allows <code>.htaccess</code> files in subdirectories to
undo any associations inherited from parent directories or the
@@ -721,7 +732,7 @@
<usage>
- <p>The <code>RemoveEncoding</code> directive removes any
+ <p>The <directive>RemoveEncoding</directive> directive removes any
encoding associations for files with the given extensions. This
allows <code>.htaccess</code> files in subdirectories to undo
any associations inherited from parent directories or the
@@ -741,8 +752,9 @@
encoded with the gzip method, but <code>foo.gz.asc</code> as an
unencoded plaintext file.</p>
- <p><strong>Note:</strong>RemoveEncoding directives are processed
- <em>after</em> any AddEncoding directives, so it is possible they
+ <p><strong>Note:</strong><directive>RemoveEncoding</directive>
+ directives are processed <em>after</em> any
+ <directive>AddEncoding</directive> directives, so it is possible they
may undo the effects of the latter if both occur within the
same directory configuration.</p>
@@ -768,7 +780,7 @@
<usage>
- <p>The <code>RemoveHandler</code> directive removes any handler
+ <p>The <directive>RemoveHandler</directive> directive removes any handler
associations for files with the given extensions. This allows
<code>.htaccess</code> files in subdirectories to undo any
associations inherited from parent directories or the server
@@ -784,8 +796,8 @@
<p>This has the effect of returning <code>.html</code> files in
the <code>/foo/bar</code> directory to being treated as normal
- files, rather than as candidates for parsing (see the <a
- href="mod_include.html"><code>mod_include</code></a>
+ files, rather than as candidates for parsing (see the
+ <module>mod_include</module>
module).</p>
<p>The <em>extension</em> argument is case-insensitive, and can
@@ -810,7 +822,7 @@
<usage>
- <p>The <code>RemoveInputFilter</code> directive removes any
+ <p>The <directive>RemoveInputFilter</directive> directive removes any
input filter associations for files with the given extensions.
This allows <code>.htaccess</code> files in subdirectories to
undo any associations inherited from parent directories or the
@@ -839,7 +851,7 @@
<usage>
- <p>The <code>RemoveLanguage</code> directive removes any
+ <p>The <directive>RemoveLanguage</directive> directive removes any
language associations for files with the given extensions. This
allows <code>.htaccess</code> files in subdirectories to undo
any associations inherited from parent directories or the
@@ -867,7 +879,7 @@
<usage>
- <p>The <code>RemoveOutputFilter</code> directive removes any
+ <p>The <directive>RemoveOutputFilter</directive> directive removes any
output filter associations for files with the given extensions.
This allows <code>.htaccess</code> files in subdirectories to
undo any associations inherited from parent directories or the
@@ -913,8 +925,8 @@
<p>This will remove any special handling of <code>.cgi</code>
files in the <code>/foo/</code> directory and any beneath it,
- causing the files to be treated as being of the <a
- href="core.html#defaulttype">default type</a>.</p>
+ causing the files to be treated as being of the default type
+ (<directive module="core">DefaultType</directive> directive).</p>
<note><strong>Note:</strong><directive>RemoveType</directive> directives
are processed <em>after</em> any <directive>AddType</directive>
@@ -939,8 +951,8 @@
<usage>
<p>The TypesConfig directive sets the location of the MIME types
- configuration file. <em>Filename</em> is relative to the <a
- href="core.html#serverroot">ServerRoot</a>. This file sets the
+ configuration file. <em>Filename</em> is relative to the <directive
+ module="core">ServerRoot</directive>. This file sets the
default list of mappings from filename extensions to content
types. Most administrators use the provided
<code>mime.types</code> file, which associates common filename
--
Hiroaki Kawai
Department of Complexity Science and Engineering,
The University of Tokyo
http://www.bcl.t.u-tokyo.ac.jp
mailto:hawk@bcl.t.u-tokyo.ac.jp
---------------------------------------------------------------------
To unsubscribe, e-mail: docs-unsubscribe@httpd.apache.org
For additional commands, e-mail: docs-help@httpd.apache.org