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

« back to all changes in this revision

Viewing changes to docs/manual/mod/mod_charset_lite.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
* 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:
 
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_charset_lite - 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_charset_lite</h1>
 
23
<div class="toplang">
 
24
<p><span>Available Languages: </span><a href="../en/mod/mod_charset_lite.html" title="English">&nbsp;en&nbsp;</a> |
 
25
<a href="../ko/mod/mod_charset_lite.html" hreflang="ko" rel="alternate" title="Korean">&nbsp;ko&nbsp;</a></p>
 
26
</div>
 
27
<table class="module"><tr><th><a href="module-dict.html#Description">Description:</a></th><td>Specify character set translation or recoding</td></tr>
 
28
<tr><th><a href="module-dict.html#Status">Status:</a></th><td>Experimental</td></tr>
 
29
<tr><th><a href="module-dict.html#ModuleIdentifier">Module�Identifier:</a></th><td>charset_lite_module</td></tr>
 
30
<tr><th><a href="module-dict.html#SourceFile">Source�File:</a></th><td>mod_charset_lite.c</td></tr></table>
 
31
<h3>Summary</h3>
 
32
 
 
33
    <p>This is an <strong>experimental</strong> module and should
 
34
    be used with care. Experiment with your
 
35
    <code class="module"><a href="../mod/mod_charset_lite.html">mod_charset_lite</a></code> configuration to ensure that it
 
36
    performs the desired function.</p>
 
37
 
 
38
    <p><code class="module"><a href="../mod/mod_charset_lite.html">mod_charset_lite</a></code> allows the administrator to
 
39
    specify the source character set of objects as well as the
 
40
    character set they should be translated into before sending to the
 
41
    client. <code class="module"><a href="../mod/mod_charset_lite.html">mod_charset_lite</a></code> does not translate the
 
42
    data itself but instead tells Apache what translation to
 
43
    perform. <code class="module"><a href="../mod/mod_charset_lite.html">mod_charset_lite</a></code> is applicable to EBCDIC
 
44
    and ASCII host environments. In an EBCDIC environment, Apache
 
45
    normally translates text content from the code page of the Apache
 
46
    process locale to ISO-8859-1. <code class="module"><a href="../mod/mod_charset_lite.html">mod_charset_lite</a></code>
 
47
    can be used to specify that a different translation is to be
 
48
    performed. In an ASCII environment, Apache normally performs no
 
49
    translation, so <code class="module"><a href="../mod/mod_charset_lite.html">mod_charset_lite</a></code> is needed in
 
50
    order for any translation to take place.</p>
 
51
 
 
52
    <p>This module provides a small subset of configuration
 
53
    mechanisms implemented by Russian Apache and its associated
 
54
    <code>mod_charset</code>.</p>
 
55
</div>
 
56
<div id="quickview"><h3 class="directives">Directives</h3>
 
57
<ul id="toc">
 
58
<li><img alt="" src="../images/down.gif" /> <a href="#charsetdefault">CharsetDefault</a></li>
 
59
<li><img alt="" src="../images/down.gif" /> <a href="#charsetoptions">CharsetOptions</a></li>
 
60
<li><img alt="" src="../images/down.gif" /> <a href="#charsetsourceenc">CharsetSourceEnc</a></li>
 
61
</ul>
 
62
<h3>Topics</h3>
 
63
<ul id="topics">
 
64
<li><img alt="" src="../images/down.gif" /> <a href="#problems">Common Problems</a></li>
 
65
</ul></div>
 
66
<div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
 
67
<div class="section">
 
68
<h2><a name="problems" id="problems">Common Problems</a></h2>
 
69
 
 
70
    <h3>Invalid character set names</h3>
 
71
 
 
72
      <p>The character set name parameters of <code class="directive"><a href="#charsetsourceenc">CharsetSourceEnc</a></code> and
 
73
      <code class="directive"><a href="#charsetdefault">CharsetDefault</a></code>
 
74
      must be acceptable to the translation mechanism used by
 
75
      <a class="glossarylink" href="../glossary.html#apr" title="see glossary">APR</a> on the system where
 
76
      <code class="module"><a href="../mod/mod_charset_lite.html">mod_charset_lite</a></code> is deployed.  These character
 
77
      set names are not standardized and are usually not the same as
 
78
      the corresponding values used in http headers.  Currently, APR
 
79
      can only use iconv(3), so you can easily test your character set
 
80
      names using the iconv(1) program, as follows:</p>
 
81
 
 
82
      <div class="example"><p><code>
 
83
        iconv -f charsetsourceenc-value -t charsetdefault-value
 
84
      </code></p></div>
 
85
    
 
86
 
 
87
    <h3>Mismatch between character set of content and translation
 
88
    rules</h3>
 
89
 
 
90
      <p>If the translation rules don't make sense for the content,
 
91
      translation can fail in various ways, including:</p>
 
92
 
 
93
      <ul>
 
94
      <li>The translation mechanism may return a bad return code,
 
95
      and the connection will be aborted.</li>
 
96
 
 
97
      <li>The translation mechanism may silently place special
 
98
      characters (e.g., question marks) in the output buffer when
 
99
      it cannot translate the input buffer.</li>
 
100
      </ul>
 
101
    
 
102
</div>
 
103
<div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
 
104
<div class="directive-section"><h2><a name="CharsetDefault" id="CharsetDefault">CharsetDefault</a> <a name="charsetdefault" id="charsetdefault">Directive</a></h2>
 
105
<table class="directive">
 
106
<tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Charset to translate into</td></tr>
 
107
<tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>CharsetDefault <var>charset</var></code></td></tr>
 
108
<tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host, directory, .htaccess</td></tr>
 
109
<tr><th><a href="directive-dict.html#Override">Override:</a></th><td>FileInfo</td></tr>
 
110
<tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Experimental</td></tr>
 
111
<tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_charset_lite</td></tr>
 
112
</table>
 
113
    <p>The <code class="directive">CharsetDefault</code> directive specifies the
 
114
    charset that content in the associated container should be
 
115
    translated to.</p>
 
116
 
 
117
    <p>The value of the <var>charset</var> argument must be accepted
 
118
    as a valid character set name by the character set support in
 
119
    <a class="glossarylink" href="../glossary.html#apr" title="see glossary">APR</a>. Generally, this means that it must be
 
120
    supported by iconv.</p>
 
121
 
 
122
    <div class="example"><h3>Example</h3><p><code>
 
123
      &lt;Directory /export/home/trawick/apacheinst/htdocs/convert&gt;<br />
 
124
      <span class="indent">
 
125
        CharsetSourceEnc  UTF-16BE<br />
 
126
        CharsetDefault    ISO-8859-1<br />
 
127
      </span>
 
128
      &lt;/Directory&gt;
 
129
    </code></p></div>
 
130
 
 
131
</div>
 
132
<div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
 
133
<div class="directive-section"><h2><a name="CharsetOptions" id="CharsetOptions">CharsetOptions</a> <a name="charsetoptions" id="charsetoptions">Directive</a></h2>
 
134
<table class="directive">
 
135
<tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Configures charset translation behavior</td></tr>
 
136
<tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>CharsetOptions <var>option</var> [<var>option</var>] ...</code></td></tr>
 
137
<tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>CharsetOptions DebugLevel=0 NoImplicitAdd</code></td></tr>
 
138
<tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host, directory, .htaccess</td></tr>
 
139
<tr><th><a href="directive-dict.html#Override">Override:</a></th><td>FileInfo</td></tr>
 
140
<tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Experimental</td></tr>
 
141
<tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_charset_lite</td></tr>
 
142
</table>
 
143
    <p>The <code class="directive">CharsetOptions</code> directive configures certain
 
144
    behaviors of <code class="module"><a href="../mod/mod_charset_lite.html">mod_charset_lite</a></code>. <var>Option</var> can
 
145
    be one of</p>
 
146
 
 
147
    <dl>
 
148
      <dt><code>DebugLevel=<var>n</var></code></dt>
 
149
 
 
150
      <dd>The <code>DebugLevel</code> keyword allows you to specify
 
151
      the level of debug messages generated by
 
152
      <code class="module"><a href="../mod/mod_charset_lite.html">mod_charset_lite</a></code>. By default, no messages are
 
153
      generated. This is equivalent to <code>DebugLevel=0</code>.
 
154
      With higher numbers, more debug messages are generated, and
 
155
      server performance will be degraded. The actual meanings of
 
156
      the numeric values are described with the definitions of the
 
157
      DBGLVL_ constants near the beginning of
 
158
      <code>mod_charset_lite.c</code>.</dd>
 
159
 
 
160
      <dt><code>ImplicitAdd | NoImplicitAdd</code></dt>
 
161
 
 
162
      <dd>The <code>ImplicitAdd</code> keyword specifies that
 
163
      <code class="module"><a href="../mod/mod_charset_lite.html">mod_charset_lite</a></code> should implicitly insert its
 
164
      filter when the configuration specifies that the character
 
165
      set of content should be translated. If the filter chain is
 
166
      explicitly configured using the <code class="directive"><a href="../mod/mod_mime.html#addoutputfilter">AddOutputFilter</a></code> directive, <code>NoImplicitAdd</code>
 
167
      should be specified so that <code class="module"><a href="../mod/mod_charset_lite.html">mod_charset_lite</a></code>
 
168
      doesn't add its filter.</dd>
 
169
    </dl>
 
170
 
 
171
</div>
 
172
<div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
 
173
<div class="directive-section"><h2><a name="CharsetSourceEnc" id="CharsetSourceEnc">CharsetSourceEnc</a> <a name="charsetsourceenc" id="charsetsourceenc">Directive</a></h2>
 
174
<table class="directive">
 
175
<tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Source charset of files</td></tr>
 
176
<tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>CharsetSourceEnc <var>charset</var></code></td></tr>
 
177
<tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host, directory, .htaccess</td></tr>
 
178
<tr><th><a href="directive-dict.html#Override">Override:</a></th><td>FileInfo</td></tr>
 
179
<tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Experimental</td></tr>
 
180
<tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_charset_lite</td></tr>
 
181
</table>
 
182
    <p>The <code class="directive">CharsetSourceEnc</code> directive specifies the
 
183
    source charset of files in the associated container.</p>
 
184
 
 
185
    <p>The value of the <var>charset</var> argument must be accepted
 
186
    as a valid character set name by the character set support in
 
187
    <a class="glossarylink" href="../glossary.html#apr" title="see glossary">APR</a>. Generally, this means that it must be
 
188
    supported by iconv.</p>
 
189
    
 
190
    <div class="example"><h3>Example</h3><p><code>
 
191
      &lt;Directory /export/home/trawick/apacheinst/htdocs/convert&gt;<br />
 
192
      <span class="indent">
 
193
        CharsetSourceEnc  UTF-16BE<br />
 
194
        CharsetDefault    ISO-8859-1<br />
 
195
      </span>
 
196
      &lt;/Directory&gt;
 
197
    </code></p></div>
 
198
 
 
199
    <p>The character set names in this example work with the iconv
 
200
    translation support in Solaris 8.</p>
 
201
 
 
202
</div>
 
203
</div>
 
204
<div class="bottomlang">
 
205
<p><span>Available Languages: </span><a href="../en/mod/mod_charset_lite.html" title="English">&nbsp;en&nbsp;</a> |
 
206
<a href="../ko/mod/mod_charset_lite.html" hreflang="ko" rel="alternate" title="Korean">&nbsp;ko&nbsp;</a></p>
 
207
</div><div id="footer">
 
208
<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>
 
209
<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>
 
210
</body></html>
 
 
b'\\ No newline at end of file'