mod_charset_lite.html.en revision cee399b097f61ab31c81399957f1293b55e1a984
e6469ad7a7dacf318f7ecf393b448b83ad1fdb37slive<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
e942c741056732f50da2074b36fe59805d370650slive<html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en"><head><!--
5f5d1b4cc970b7f06ff8ef6526128e9a27303d88nd XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
d5d794fc2f4cc9ca6d6da17cfa2cdcd8d244bacdnd This file is generated from xml source: DO NOT EDIT
d5d794fc2f4cc9ca6d6da17cfa2cdcd8d244bacdnd XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
db479b48bd4d75423ed4a45e15b75089d1a8ad72fielding --><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.0</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-project/">Documentation</a> > <a href="../">Version 2.0</a> > <a href="./">Modules</a></div><div id="page-content"><div id="preamble"><h1>Apache Module mod_charset_lite</h1><table class="module"><tr><th><a href="module-dict.html#Description">Description:
db479b48bd4d75423ed4a45e15b75089d1a8ad72fielding </a></th><td>Specify character set translation or recoding</td></tr><tr><th><a href="module-dict.html#Status">Status:
db479b48bd4d75423ed4a45e15b75089d1a8ad72fielding </a></th><td>Experimental</td></tr><tr><th><a href="module-dict.html#ModuleIdentifier">Module�Identifier:
db479b48bd4d75423ed4a45e15b75089d1a8ad72fielding </a></th><td>charset_lite_module</td></tr><tr><th><a href="module-dict.html#SourceFile">Source�File:
db479b48bd4d75423ed4a45e15b75089d1a8ad72fielding </a></th><td>mod_charset_lite.c</td></tr></table><h3>Summary</h3>
db479b48bd4d75423ed4a45e15b75089d1a8ad72fielding <p>This is an <strong>experimental</strong> module and should
d5d794fc2f4cc9ca6d6da17cfa2cdcd8d244bacdnd be used with care. Experiment with your
d5d794fc2f4cc9ca6d6da17cfa2cdcd8d244bacdnd <code class="module"><a href="/mod/mod_charset_lite.html">mod_charset_lite</a></code> configuration to ensure that it
d5d794fc2f4cc9ca6d6da17cfa2cdcd8d244bacdnd performs the desired function.</p>
d5d794fc2f4cc9ca6d6da17cfa2cdcd8d244bacdnd <p><code class="module"><a href="/mod/mod_charset_lite.html">mod_charset_lite</a></code> allows the administrator to
d5d794fc2f4cc9ca6d6da17cfa2cdcd8d244bacdnd specify the source character set of objects as well as the
d5d794fc2f4cc9ca6d6da17cfa2cdcd8d244bacdnd character set they should be translated into before sending to the
d5d794fc2f4cc9ca6d6da17cfa2cdcd8d244bacdnd client. <code class="module"><a href="/mod/mod_charset_lite.html">mod_charset_lite</a></code> does not translate the
d5d794fc2f4cc9ca6d6da17cfa2cdcd8d244bacdnd data itself but instead tells Apache what translation to
d5d794fc2f4cc9ca6d6da17cfa2cdcd8d244bacdnd perform. <code class="module"><a href="/mod/mod_charset_lite.html">mod_charset_lite</a></code> is applicable to EBCDIC
7db9f691a00ead175b03335457ca296a33ddf31bnd and ASCII host environments. In an EBCDIC environment, Apache
e6469ad7a7dacf318f7ecf393b448b83ad1fdb37slive normally translates text content from the code page of the Apache
e6469ad7a7dacf318f7ecf393b448b83ad1fdb37slive process locale to ISO-8859-1. <code class="module"><a href="/mod/mod_charset_lite.html">mod_charset_lite</a></code>
e6469ad7a7dacf318f7ecf393b448b83ad1fdb37slive can be used to specify that a different translation is to be
e6469ad7a7dacf318f7ecf393b448b83ad1fdb37slive performed. In an ASCII environment, Apache normally performs no
e6469ad7a7dacf318f7ecf393b448b83ad1fdb37slive translation, so <code class="module"><a href="/mod/mod_charset_lite.html">mod_charset_lite</a></code> is needed in
e6469ad7a7dacf318f7ecf393b448b83ad1fdb37slive order for any translation to take place.</p>
e6469ad7a7dacf318f7ecf393b448b83ad1fdb37slive <p>This module provides a small subset of configuration
e6469ad7a7dacf318f7ecf393b448b83ad1fdb37slive mechanisms implemented by Russian Apache and its associated
b1213b43a3643e4fd80f85b5ec3975b9dc97edf8sf</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>
e6469ad7a7dacf318f7ecf393b448b83ad1fdb37slive<li><img alt="" src="/images/down.gif" /> <a href="#charsetoptions">CharsetOptions</a></li>
e6469ad7a7dacf318f7ecf393b448b83ad1fdb37slive<li><img alt="" src="/images/down.gif" /> <a href="#charsetsourceenc">CharsetSourceEnc</a></li>
e6469ad7a7dacf318f7ecf393b448b83ad1fdb37slive</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>
e6469ad7a7dacf318f7ecf393b448b83ad1fdb37slive <p>The character set name parameters of <code class="directive"><a href="#charsetsourceenc">CharsetSourceEnc</a></code> and
e6469ad7a7dacf318f7ecf393b448b83ad1fdb37slive <code class="directive"><a href="#charsetdefault">CharsetDefault</a></code>
53bae66d3dc14a667e14a451f7bc65a893dd450fnd must be acceptable to the translation mechanism used by APR on the
e6469ad7a7dacf318f7ecf393b448b83ad1fdb37slive system where <code class="module"><a href="/mod/mod_charset_lite.html">mod_charset_lite</a></code> is deployed. These
860b4efe27e7c1c9a2bf5c872b29c90f76849b51jim character set names are not standardized and are usually not the
9f380527370b68cda29abdad35334f62d6a7326drbowen same as the corresponding values used in http headers. Currently,
9f380527370b68cda29abdad35334f62d6a7326drbowen APR can only use iconv(3), so you can easily test your character
860b4efe27e7c1c9a2bf5c872b29c90f76849b51jim set names using the iconv(1) program, as follows:</p>
e6469ad7a7dacf318f7ecf393b448b83ad1fdb37slive iconv -f charsetsourceenc-value -t charsetdefault-value
1597043cec6ad37fa4154bf09b0fccdabed1a239slive <h3>Mismatch between character set of content and translation
984276e3760754bae346208618ad01194ddd4e73rbowen <p>If the translation rules don't make sense for the content,
97a9a944b5887e91042b019776c41d5dd74557aferikabele translation can fail in various ways, including:</p>
a5da9d9dfc593837aca771df70ad124a37e22abapatrikj <li>The translation mechanism may return a bad return code,
a1de5cf47c9ccfbf493264e8a3fa7ddd5a9c80d1kbrand and the connection will be aborted.</li>
98b409eae9ad8033008f8589b5c7c02ed49db767sctemme <li>The translation mechanism may silently place special
f7489468254ddf807594db3dfb994035f0ec1c7djorton characters (e.g., question marks) in the output buffer when
a5da9d9dfc593837aca771df70ad124a37e22abapatrikj it cannot translate the input buffer.</li>
a5da9d9dfc593837aca771df70ad124a37e22abapatrikj</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:
08ff7ca3674b179f36b9e0798ae2a9bdbb72c437wrowe </a></th><td>Charset to translate into</td></tr><tr><th><a href="directive-dict.html#Syntax">Syntax:
a5da9d9dfc593837aca771df70ad124a37e22abapatrikj </a></th><td><code>CharsetDefault <var>charset</var></code></td></tr><tr><th><a href="directive-dict.html#Context">Context:
a5da9d9dfc593837aca771df70ad124a37e22abapatrikj </a></th><td>server config, virtual host, directory, .htaccess</td></tr><tr><th><a href="directive-dict.html#Override">Override:
a5da9d9dfc593837aca771df70ad124a37e22abapatrikj </a></th><td>FileInfo</td></tr><tr><th><a href="directive-dict.html#Status">Status:
a5da9d9dfc593837aca771df70ad124a37e22abapatrikj </a></th><td>Experimental</td></tr><tr><th><a href="directive-dict.html#Module">Module:
a5da9d9dfc593837aca771df70ad124a37e22abapatrikj <p>The <code class="directive">CharsetDefault</code> directive specifies the
a5da9d9dfc593837aca771df70ad124a37e22abapatrikj charset that content in the associated container should be
a5da9d9dfc593837aca771df70ad124a37e22abapatrikj translated to.</p>
a5da9d9dfc593837aca771df70ad124a37e22abapatrikj <p>The value of the <var>charset</var> argument must be accepted
8514af9d926a1c330756d11eb71acfcf6e8e56bdjorton as a valid character set name by the character set support in
a5da9d9dfc593837aca771df70ad124a37e22abapatrikj APR. Generally, this means that it must be supported by
a5da9d9dfc593837aca771df70ad124a37e22abapatrikj <Directory /export/home/trawick/apacheinst/htdocs/convert><br />
a5da9d9dfc593837aca771df70ad124a37e22abapatrikj CharsetSourceEnc UTF-16BE<br />
a5da9d9dfc593837aca771df70ad124a37e22abapatrikj CharsetDefault ISO-8859-1<br />
a5da9d9dfc593837aca771df70ad124a37e22abapatrikj </Directory>
a5da9d9dfc593837aca771df70ad124a37e22abapatrikj</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:
a5da9d9dfc593837aca771df70ad124a37e22abapatrikj </a></th><td>Configures charset translation behavior</td></tr><tr><th><a href="directive-dict.html#Syntax">Syntax:
a5da9d9dfc593837aca771df70ad124a37e22abapatrikj </a></th><td><code>CharsetOptions <var>option</var> [<var>option</var>] ...</code></td></tr><tr><th><a href="directive-dict.html#Default">Default:
a5da9d9dfc593837aca771df70ad124a37e22abapatrikj </a></th><td><code>CharsetOptions DebugLevel=0 NoImplicitAdd</code></td></tr><tr><th><a href="directive-dict.html#Context">Context:
a5da9d9dfc593837aca771df70ad124a37e22abapatrikj </a></th><td>server config, virtual host, directory, .htaccess</td></tr><tr><th><a href="directive-dict.html#Override">Override:
099c357f282d4aebf2b32264f7dce6ffc0497c37sf </a></th><td>FileInfo</td></tr><tr><th><a href="directive-dict.html#Status">Status:
099c357f282d4aebf2b32264f7dce6ffc0497c37sf </a></th><td>Experimental</td></tr><tr><th><a href="directive-dict.html#Module">Module:
e6469ad7a7dacf318f7ecf393b448b83ad1fdb37slive <p>The <code class="directive">CharsetOptions</code> directive configures certain
48a0d431b5507ffaedacaea4f5d134c8f2f118f2jorton behaviors of <code class="module"><a href="/mod/mod_charset_lite.html">mod_charset_lite</a></code>. <var>Option</var> can
48a0d431b5507ffaedacaea4f5d134c8f2f118f2jorton be one of</p>
fbcc97f10f1edb3bdcb0c66cba273abca56c670djorton <dd>The <code>DebugLevel</code> keyword allows you to specify
fbcc97f10f1edb3bdcb0c66cba273abca56c670djorton the level of debug messages generated by
fbcc97f10f1edb3bdcb0c66cba273abca56c670djorton <code class="module"><a href="/mod/mod_charset_lite.html">mod_charset_lite</a></code>. By default, no messages are
fbcc97f10f1edb3bdcb0c66cba273abca56c670djorton generated. This is equivalent to <code>DebugLevel=0</code>.
fbcc97f10f1edb3bdcb0c66cba273abca56c670djorton With higher numbers, more debug messages are generated, and
fbcc97f10f1edb3bdcb0c66cba273abca56c670djorton server performance will be degraded. The actual meanings of
fbcc97f10f1edb3bdcb0c66cba273abca56c670djorton the numeric values are described with the definitions of the
fbcc97f10f1edb3bdcb0c66cba273abca56c670djorton DBGLVL_ constants near the beginning of
1b1621900bd89ddc496d721c865a726f635ebd7esf <code class="module"><a href="/mod/mod_charset_lite.html">mod_charset_lite</a></code> should implicitly insert its
1b1621900bd89ddc496d721c865a726f635ebd7esf filter when the configuration specifies that the character
1b1621900bd89ddc496d721c865a726f635ebd7esf set of content should be translated. If the filter chain is
8514af9d926a1c330756d11eb71acfcf6e8e56bdjorton explicitly configured using the <code class="directive"><a href="/mod/mod_mime.html#addoutputfilter">AddOutputFilter</a></code> directive, <code>NoImplicitAdd</code>
8514af9d926a1c330756d11eb71acfcf6e8e56bdjorton should be specified so that <code class="module"><a href="/mod/mod_charset_lite.html">mod_charset_lite</a></code>
8514af9d926a1c330756d11eb71acfcf6e8e56bdjorton doesn't add its filter.</dd>
f7ac17a355153b91b25db5d526afd752465aa489jorton</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:
f7ac17a355153b91b25db5d526afd752465aa489jorton </a></th><td>Source charset of files</td></tr><tr><th><a href="directive-dict.html#Syntax">Syntax:
f7ac17a355153b91b25db5d526afd752465aa489jorton </a></th><td><code>CharsetSourceEnc <var>charset</var></code></td></tr><tr><th><a href="directive-dict.html#Context">Context:
f7ac17a355153b91b25db5d526afd752465aa489jorton </a></th><td>server config, virtual host, directory, .htaccess</td></tr><tr><th><a href="directive-dict.html#Override">Override:
f7ac17a355153b91b25db5d526afd752465aa489jorton </a></th><td>FileInfo</td></tr><tr><th><a href="directive-dict.html#Status">Status:
f7ac17a355153b91b25db5d526afd752465aa489jorton </a></th><td>Experimental</td></tr><tr><th><a href="directive-dict.html#Module">Module:
f7ac17a355153b91b25db5d526afd752465aa489jorton <p>The <code class="directive">CharsetSourceEnc</code> directive specifies the
f7ac17a355153b91b25db5d526afd752465aa489jorton source charset of files in the associated container.</p>
f7ac17a355153b91b25db5d526afd752465aa489jorton <p>The value of the <var>charset</var> argument must be accepted
f7ac17a355153b91b25db5d526afd752465aa489jorton as a valid character set name by the character set support in
f7ac17a355153b91b25db5d526afd752465aa489jorton APR. Generally, this means that it must be supported by
f7ac17a355153b91b25db5d526afd752465aa489jorton <Directory /export/home/trawick/apacheinst/htdocs/convert><br />
f7ac17a355153b91b25db5d526afd752465aa489jorton CharsetSourceEnc UTF-16BE<br />
f7ac17a355153b91b25db5d526afd752465aa489jorton CharsetDefault ISO-8859-1<br />
f7ac17a355153b91b25db5d526afd752465aa489jorton </Directory>
f7ac17a355153b91b25db5d526afd752465aa489jorton <p>The character set names in this example work with the iconv
f7ac17a355153b91b25db5d526afd752465aa489jorton translation support in Solaris 8.</p>
f7ac17a355153b91b25db5d526afd752465aa489jorton</div></div><div id="footer"><p class="apache">Maintained by the <a href="http://httpd.apache.org/docs-project/">Apache HTTP Server Documentation Project</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>