mirror of
https://github.com/apache/httpd.git
synced 2025-10-31 19:10:37 +03:00
b134f9aac1
actually necessary, but it's sort of an annual tradition. We think tradition is pretty important. git-svn-id: https://svn.apache.org/repos/asf/httpd/httpd/trunk@895795 13f79535-47bb-0310-9956-ffa450edef68
224 lines
13 KiB
XML
224 lines
13 KiB
XML
<?xml version="1.0" encoding="ISO-8859-1"?>
|
||
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
|
||
<html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en"><head><!--
|
||
XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
|
||
This file is generated from xml source: DO NOT EDIT
|
||
XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
|
||
-->
|
||
<title>mod_charset_lite - Apache HTTP Server</title>
|
||
<link href="../style/css/manual.css" rel="stylesheet" media="all" type="text/css" title="Main stylesheet" />
|
||
<link href="../style/css/manual-loose-100pc.css" rel="alternate stylesheet" media="all" type="text/css" title="No Sidebar - Default font size" />
|
||
<link href="../style/css/manual-print.css" rel="stylesheet" media="print" type="text/css" />
|
||
<link href="../images/favicon.ico" rel="shortcut icon" /></head>
|
||
<body>
|
||
<div id="page-header">
|
||
<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>
|
||
<p class="apache">Apache HTTP Server Version 2.3</p>
|
||
<img alt="" src="../images/feather.gif" /></div>
|
||
<div class="up"><a href="./"><img title="<-" alt="<-" src="../images/left.gif" /></a></div>
|
||
<div id="path">
|
||
<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.3</a> > <a href="./">Modules</a></div>
|
||
<div id="page-content">
|
||
<div id="preamble"><h1>Apache Module mod_charset_lite</h1>
|
||
<div class="toplang">
|
||
<p><span>Available Languages: </span><a href="../en/mod/mod_charset_lite.html" title="English"> en </a> |
|
||
<a href="../ko/mod/mod_charset_lite.html" hreflang="ko" rel="alternate" title="Korean"> ko </a></p>
|
||
</div>
|
||
<table class="module"><tr><th><a href="module-dict.html#Description">Description:</a></th><td>Specify character set translation or recoding</td></tr>
|
||
<tr><th><a href="module-dict.html#Status">Status:</a></th><td>Extension</td></tr>
|
||
<tr><th><a href="module-dict.html#ModuleIdentifier">Module<EFBFBD>Identifier:</a></th><td>charset_lite_module</td></tr>
|
||
<tr><th><a href="module-dict.html#SourceFile">Source<EFBFBD>File:</a></th><td>mod_charset_lite.c</td></tr></table>
|
||
<h3>Summary</h3>
|
||
|
||
<p><code class="module"><a href="../mod/mod_charset_lite.html">mod_charset_lite</a></code> allows the server to change
|
||
the character set of responses before sending them to the client.
|
||
In an EBCDIC environment, Apache always translates HTTP protocol
|
||
content (e.g. response headers) from the code page of the Apache
|
||
process locale to ISO-8859-1, but not the body of responses. In
|
||
any environment, <code class="module"><a href="../mod/mod_charset_lite.html">mod_charset_lite</a></code> can be used to
|
||
specify that response bodies should be translated. For example,
|
||
if files are stored in EBCDIC, then
|
||
<code class="module"><a href="../mod/mod_charset_lite.html">mod_charset_lite</a></code> can translate them to
|
||
ISO-8859-1 before sending them to the client.</p>
|
||
|
||
<p>This module provides a small subset of configuration
|
||
mechanisms implemented by Russian Apache and its associated
|
||
<code>mod_charset</code>.</p>
|
||
</div>
|
||
<div id="quickview"><h3 class="directives">Directives</h3>
|
||
<ul id="toc">
|
||
<li><img alt="" src="../images/down.gif" /> <a href="#charsetdefault">CharsetDefault</a></li>
|
||
<li><img alt="" src="../images/down.gif" /> <a href="#charsetoptions">CharsetOptions</a></li>
|
||
<li><img alt="" src="../images/down.gif" /> <a href="#charsetsourceenc">CharsetSourceEnc</a></li>
|
||
</ul>
|
||
<h3>Topics</h3>
|
||
<ul id="topics">
|
||
<li><img alt="" src="../images/down.gif" /> <a href="#problems">Common Problems</a></li>
|
||
</ul></div>
|
||
<div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
|
||
<div class="section">
|
||
<h2><a name="problems" id="problems">Common Problems</a></h2>
|
||
|
||
<h3>Invalid character set names</h3>
|
||
|
||
<p>The character set name parameters of <code class="directive"><a href="#charsetsourceenc">CharsetSourceEnc</a></code> and
|
||
<code class="directive"><a href="#charsetdefault">CharsetDefault</a></code>
|
||
must be acceptable to the translation mechanism used by
|
||
<a class="glossarylink" href="../glossary.html#apr" title="see glossary">APR</a> on the system where
|
||
<code class="module"><a href="../mod/mod_charset_lite.html">mod_charset_lite</a></code> is deployed. These character
|
||
set names are not standardized and are usually not the same as
|
||
the corresponding values used in http headers. Currently, APR
|
||
can only use iconv(3), so you can easily test your character set
|
||
names using the iconv(1) program, as follows:</p>
|
||
|
||
<div class="example"><p><code>
|
||
iconv -f charsetsourceenc-value -t charsetdefault-value
|
||
</code></p></div>
|
||
|
||
|
||
<h3>Mismatch between character set of content and translation
|
||
rules</h3>
|
||
|
||
<p>If the translation rules don't make sense for the content,
|
||
translation can fail in various ways, including:</p>
|
||
|
||
<ul>
|
||
<li>The translation mechanism may return a bad return code,
|
||
and the connection will be aborted.</li>
|
||
|
||
<li>The translation mechanism may silently place special
|
||
characters (e.g., question marks) in the output buffer when
|
||
it cannot translate the input buffer.</li>
|
||
</ul>
|
||
|
||
</div>
|
||
<div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
|
||
<div class="directive-section"><h2><a name="CharsetDefault" id="CharsetDefault">CharsetDefault</a> <a name="charsetdefault" id="charsetdefault">Directive</a></h2>
|
||
<table class="directive">
|
||
<tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Charset to translate into</td></tr>
|
||
<tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>CharsetDefault <var>charset</var></code></td></tr>
|
||
<tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host, directory, .htaccess</td></tr>
|
||
<tr><th><a href="directive-dict.html#Override">Override:</a></th><td>FileInfo</td></tr>
|
||
<tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Extension</td></tr>
|
||
<tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_charset_lite</td></tr>
|
||
</table>
|
||
<p>The <code class="directive">CharsetDefault</code> directive specifies the
|
||
charset that content in the associated container should be
|
||
translated to.</p>
|
||
|
||
<p>The value of the <var>charset</var> argument must be accepted
|
||
as a valid character set name by the character set support in
|
||
<a class="glossarylink" href="../glossary.html#apr" title="see glossary">APR</a>. Generally, this means that it must be
|
||
supported by iconv.</p>
|
||
|
||
<div class="example"><h3>Example</h3><p><code>
|
||
<Directory /export/home/trawick/apacheinst/htdocs/convert><br />
|
||
<span class="indent">
|
||
CharsetSourceEnc UTF-16BE<br />
|
||
CharsetDefault ISO-8859-1<br />
|
||
</span>
|
||
</Directory>
|
||
</code></p></div>
|
||
|
||
<div class="note">
|
||
Specifying the same charset for both <code class="directive"><a href="#charsetsourceenc">CharsetSourceEnc</a></code>
|
||
and <code class="directive"><a href="#charsetdefault">CharsetDefault</a></code> disables translation. The charset
|
||
need not match the charset of the response, but it must be a valid charset on the system.
|
||
</div>
|
||
|
||
|
||
</div>
|
||
<div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
|
||
<div class="directive-section"><h2><a name="CharsetOptions" id="CharsetOptions">CharsetOptions</a> <a name="charsetoptions" id="charsetoptions">Directive</a></h2>
|
||
<table class="directive">
|
||
<tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Configures charset translation behavior</td></tr>
|
||
<tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>CharsetOptions <var>option</var> [<var>option</var>] ...</code></td></tr>
|
||
<tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>CharsetOptions DebugLevel=0 ImplicitAdd</code></td></tr>
|
||
<tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host, directory, .htaccess</td></tr>
|
||
<tr><th><a href="directive-dict.html#Override">Override:</a></th><td>FileInfo</td></tr>
|
||
<tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Extension</td></tr>
|
||
<tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_charset_lite</td></tr>
|
||
</table>
|
||
<p>The <code class="directive">CharsetOptions</code> directive configures certain
|
||
behaviors of <code class="module"><a href="../mod/mod_charset_lite.html">mod_charset_lite</a></code>. <var>Option</var> can
|
||
be one of</p>
|
||
|
||
<dl>
|
||
<dt><code>DebugLevel=<var>n</var></code></dt>
|
||
|
||
<dd>The <code>DebugLevel</code> keyword allows you to specify
|
||
the level of debug messages generated by
|
||
<code class="module"><a href="../mod/mod_charset_lite.html">mod_charset_lite</a></code>. By default, no messages are
|
||
generated. This is equivalent to <code>DebugLevel=0</code>.
|
||
With higher numbers, more debug messages are generated, and
|
||
server performance will be degraded. The actual meanings of
|
||
the numeric values are described with the definitions of the
|
||
DBGLVL_ constants near the beginning of
|
||
<code>mod_charset_lite.c</code>.</dd>
|
||
|
||
<dt><code>ImplicitAdd | NoImplicitAdd</code></dt>
|
||
|
||
<dd>The <code>ImplicitAdd</code> keyword specifies that
|
||
<code class="module"><a href="../mod/mod_charset_lite.html">mod_charset_lite</a></code> should implicitly insert its
|
||
filter when the configuration specifies that the character
|
||
set of content should be translated. If the filter chain is
|
||
explicitly configured using the <code class="directive"><a href="../mod/mod_mime.html#addoutputfilter">AddOutputFilter</a></code> directive, <code>NoImplicitAdd</code>
|
||
should be specified so that <code class="module"><a href="../mod/mod_charset_lite.html">mod_charset_lite</a></code>
|
||
doesn't add its filter.</dd>
|
||
|
||
<dt><code>TranslateAllMimeTypes | NoTranslateAllMimeTypes</code></dt>
|
||
<dd>Normally, <code class="module"><a href="../mod/mod_charset_lite.html">mod_charset_lite</a></code> will only perform
|
||
translation on a small subset of possible mimetypes. When the
|
||
<code>TranslateAllMimeTypes</code> keyword is specified for a given
|
||
configuration section, translation is performed without regard for
|
||
mimetype.</dd>
|
||
|
||
</dl>
|
||
|
||
</div>
|
||
<div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
|
||
<div class="directive-section"><h2><a name="CharsetSourceEnc" id="CharsetSourceEnc">CharsetSourceEnc</a> <a name="charsetsourceenc" id="charsetsourceenc">Directive</a></h2>
|
||
<table class="directive">
|
||
<tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Source charset of files</td></tr>
|
||
<tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>CharsetSourceEnc <var>charset</var></code></td></tr>
|
||
<tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host, directory, .htaccess</td></tr>
|
||
<tr><th><a href="directive-dict.html#Override">Override:</a></th><td>FileInfo</td></tr>
|
||
<tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Extension</td></tr>
|
||
<tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_charset_lite</td></tr>
|
||
</table>
|
||
<p>The <code class="directive">CharsetSourceEnc</code> directive specifies the
|
||
source charset of files in the associated container.</p>
|
||
|
||
<p>The value of the <var>charset</var> argument must be accepted
|
||
as a valid character set name by the character set support in
|
||
<a class="glossarylink" href="../glossary.html#apr" title="see glossary">APR</a>. Generally, this means that it must be
|
||
supported by iconv.</p>
|
||
|
||
<div class="example"><h3>Example</h3><p><code>
|
||
<Directory /export/home/trawick/apacheinst/htdocs/convert><br />
|
||
<span class="indent">
|
||
CharsetSourceEnc UTF-16BE<br />
|
||
CharsetDefault ISO-8859-1<br />
|
||
</span>
|
||
</Directory>
|
||
</code></p></div>
|
||
|
||
<p>The character set names in this example work with the iconv
|
||
translation support in Solaris 8.</p>
|
||
|
||
<div class="note">
|
||
Specifying the same charset for both <code class="directive"><a href="#charsetsourceenc">CharsetSourceEnc</a></code>
|
||
and <code class="directive"><a href="#charsetdefault">CharsetDefault</a></code> disables translation. The charset
|
||
need not match the charset of the response, but it must be a valid charset on the system.
|
||
</div>
|
||
|
||
|
||
</div>
|
||
</div>
|
||
<div class="bottomlang">
|
||
<p><span>Available Languages: </span><a href="../en/mod/mod_charset_lite.html" title="English"> en </a> |
|
||
<a href="../ko/mod/mod_charset_lite.html" hreflang="ko" rel="alternate" title="Korean"> ko </a></p>
|
||
</div><div id="footer">
|
||
<p class="apache">Copyright 2010 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>
|
||
<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>
|
||
</body></html> |