You are viewing a plain text version of this content. The canonical link for it is here.
Posted to cvs@httpd.apache.org by nd...@apache.org on 2002/11/07 05:35:57 UTC
cvs commit: httpd-2.0/docs/manual/mod mod_charset_lite.html.en mod_charset_lite.xml quickreference.html.en
nd 2002/11/06 20:35:57
Modified: docs/manual/mod mod_charset_lite.html.en
mod_charset_lite.xml quickreference.html.en
Log:
- <em> -> <var>
- whitespace reformatting
- little markup improvements
- typo
-> update transformation
Revision Changes Path
1.13 +53 -48 httpd-2.0/docs/manual/mod/mod_charset_lite.html.en
Index: mod_charset_lite.html.en
===================================================================
RCS file: /home/cvs/httpd-2.0/docs/manual/mod/mod_charset_lite.html.en,v
retrieving revision 1.12
retrieving revision 1.13
diff -u -r1.12 -r1.13
--- mod_charset_lite.html.en 7 Oct 2002 15:23:01 -0000 1.12
+++ mod_charset_lite.html.en 7 Nov 2002 04:35:56 -0000 1.13
@@ -11,7 +11,7 @@
</a></th><td>mod_charset_lite.c</td></tr></table><h3>Summary</h3>
<p>This is an <strong>experimental</strong> module and should
be used with care. Experiment with your
- <code>mod_charset_lite</code> configuration to ensure that it
+ <code class="module"><a href="../mod/mod_charset_lite.html">mod_charset_lite</a></code> configuration to ensure that it
performs the desired function.</p>
<p><code class="module"><a href="../mod/mod_charset_lite.html">mod_charset_lite</a></code> allows the administrator to
@@ -22,7 +22,7 @@
perform. <code class="module"><a href="../mod/mod_charset_lite.html">mod_charset_lite</a></code> is applicable to EBCDIC
and ASCII host environments. In an EBCDIC environment, Apache
normally translates text content from the code page of the Apache
- process locale to ISO-8859-1. <code class="module"><a href="../mod/mod_charset_lite.html">mod_charset_lite</a></code>
+ process locale to ISO-8859-1. <code class="module"><a href="../mod/mod_charset_lite.html">mod_charset_lite</a></code>
can be used to specify that a different translation is to be
performed. In an ASCII environment, Apache normally performs no
translation, so <code class="module"><a href="../mod/mod_charset_lite.html">mod_charset_lite</a></code> is needed in
@@ -34,41 +34,42 @@
</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" /> Common Problems</li></ul></div><div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div><div class="section"><h2>Common Problems</h2>
+</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 APR 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>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 APR 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
+ <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>
+ <p>If the translation rules don't make sense for the content,
+ translation can fail in various ways, including:</p>
- <ul>
+ <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>
-
+ </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 <em>charset</em></code></td></tr><tr><th><a href="directive-dict.html#Context">Context:
+ </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>Experimental</td></tr><tr><th><a href="directive-dict.html#Module">Module:
@@ -77,32 +78,33 @@
charset that content in the associated container should be
translated to.</p>
- <p>The value of the <em>charset</em> argument must be accepted
+ <p>The value of the <var>charset</var> argument must be accepted
as a valid character set name by the character set support in
APR. 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 />
- CharsetSourceEnc UTF-16BE<br />
- CharsetDefault ISO-8859-1<br />
- </Directory>
-</code></p></div>
+ <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><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 tranlation behavior</td></tr><tr><th><a href="directive-dict.html#Syntax">Syntax:
- </a></th><td><code>CharsetOptions <em>option</em> [<em>option</em>] ...</code></td></tr><tr><th><a href="directive-dict.html#Default">Default:
- </a></th><td><code>CharsetOptions DebugLevel=0
-NoImplicitAdd</code></td></tr><tr><th><a href="directive-dict.html#Context">Context:
+ </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 NoImplicitAdd</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>Experimental</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>. <em>Option</em> can
+ 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>DebugLevel=<em>n</em></dt>
+ <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
@@ -114,19 +116,19 @@
DBGLVL_ constants near the beginning of
<code>mod_charset_lite.c</code>.</dd>
- <dt>ImplicitAdd | NoImplicitAdd</dt>
+ <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 AddOutputFilter 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>
+ 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>
</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 <em>charset</em></code></td></tr><tr><th><a href="directive-dict.html#Context">Context:
+ </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>Experimental</td></tr><tr><th><a href="directive-dict.html#Module">Module:
@@ -134,17 +136,20 @@
<p>The <code class="directive">CharsetSourceEnc</code> directive specifies the
source charset of files in the associated container.</p>
- <p>The value of the <em>charset</em> argument must be accepted
+ <p>The value of the <var>charset</var> argument must be accepted
as a valid character set name by the character set support in
APR. 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 />
- CharsetSourceEnc UTF-16BE<br />
- CharsetDefault ISO-8859-1<br />
- </Directory>
-</code></p></div>
+ <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></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>
1.6 +55 -49 httpd-2.0/docs/manual/mod/mod_charset_lite.xml
Index: mod_charset_lite.xml
===================================================================
RCS file: /home/cvs/httpd-2.0/docs/manual/mod/mod_charset_lite.xml,v
retrieving revision 1.5
retrieving revision 1.6
diff -u -r1.5 -r1.6
--- mod_charset_lite.xml 7 Sep 2002 11:55:55 -0000 1.5
+++ mod_charset_lite.xml 7 Nov 2002 04:35:56 -0000 1.6
@@ -12,7 +12,7 @@
<summary>
<p>This is an <strong>experimental</strong> module and should
be used with care. Experiment with your
- <code>mod_charset_lite</code> configuration to ensure that it
+ <module>mod_charset_lite</module> configuration to ensure that it
performs the desired function.</p>
<p><module>mod_charset_lite</module> allows the administrator to
@@ -23,7 +23,7 @@
perform. <module>mod_charset_lite</module> is applicable to EBCDIC
and ASCII host environments. In an EBCDIC environment, Apache
normally translates text content from the code page of the Apache
- process locale to ISO-8859-1. <module>mod_charset_lite</module>
+ process locale to ISO-8859-1. <module>mod_charset_lite</module>
can be used to specify that a different translation is to be
performed. In an ASCII environment, Apache normally performs no
translation, so <module>mod_charset_lite</module> is needed in
@@ -34,45 +34,46 @@
<code>mod_charset</code>.</p>
</summary>
-<section><title>Common Problems</title>
+<section id="problems"><title>Common Problems</title>
-<section><title>Invalid character set names</title>
+ <section><title>Invalid character set names</title>
- <p>The character set name parameters of <directive
- module="mod_charset_lite">CharsetSourceEnc</directive> and
- <directive module="mod_charset_lite">CharsetDefault</directive>
- must be acceptable to the translation mechanism used by APR on the
- system where <module>mod_charset_lite</module> 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>
-<example>
- iconv -f charsetsourceenc-value -t charsetdefault-value
-</example>
-</section>
+ <p>The character set name parameters of <directive
+ module="mod_charset_lite">CharsetSourceEnc</directive> and
+ <directive module="mod_charset_lite">CharsetDefault</directive>
+ must be acceptable to the translation mechanism used by APR on the
+ system where <module>mod_charset_lite</module> 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>
+
+ <example>
+ iconv -f charsetsourceenc-value -t charsetdefault-value
+ </example>
+ </section>
-<section><title>Mismatch between character set of content and translation
+ <section><title>Mismatch between character set of content and translation
rules</title>
- <p>If the translation rules don't make sense for the content,
- translation can fail in various ways, including:</p>
+ <p>If the translation rules don't make sense for the content,
+ translation can fail in various ways, including:</p>
- <ul>
+ <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>
-</section>
+ </ul>
+ </section>
</section>
<directivesynopsis>
<name>CharsetSourceEnc</name>
<description>Source charset of files</description>
-<syntax>CharsetSourceEnc <em>charset</em></syntax>
+<syntax>CharsetSourceEnc <var>charset</var></syntax>
<contextlist><context>server config</context>
<context>virtual host</context><context>directory</context>
<context>.htaccess</context>
@@ -83,17 +84,20 @@
<p>The <directive>CharsetSourceEnc</directive> directive specifies the
source charset of files in the associated container.</p>
- <p>The value of the <em>charset</em> argument must be accepted
+ <p>The value of the <var>charset</var> argument must be accepted
as a valid character set name by the character set support in
APR. Generally, this means that it must be supported by
iconv.</p>
-<example><title>Example</title>
- <Directory "/export/home/trawick/apacheinst/htdocs/convert"><br />
- CharsetSourceEnc UTF-16BE<br />
- CharsetDefault ISO-8859-1<br />
- </Directory>
-</example>
+ <example><title>Example</title>
+ <Directory /export/home/trawick/apacheinst/htdocs/convert><br />
+ <indent>
+ CharsetSourceEnc UTF-16BE<br />
+ CharsetDefault ISO-8859-1<br />
+ </indent>
+ </Directory>
+ </example>
+
<p>The character set names in this example work with the iconv
translation support in Solaris 8.</p>
</usage>
@@ -102,7 +106,7 @@
<directivesynopsis>
<name>CharsetDefault</name>
<description>Charset to translate into</description>
-<syntax>CharsetDefault <em>charset</em></syntax>
+<syntax>CharsetDefault <var>charset</var></syntax>
<contextlist><context>server config</context>
<context>virtual host</context><context>directory</context>
<context>.htaccess</context>
@@ -114,26 +118,27 @@
charset that content in the associated container should be
translated to.</p>
- <p>The value of the <em>charset</em> argument must be accepted
+ <p>The value of the <var>charset</var> argument must be accepted
as a valid character set name by the character set support in
APR. Generally, this means that it must be supported by
iconv.</p>
-<example><title>Example</title>
- <Directory "/export/home/trawick/apacheinst/htdocs/convert"><br />
- CharsetSourceEnc UTF-16BE<br />
- CharsetDefault ISO-8859-1<br />
- </Directory>
-</example>
+ <example><title>Example</title>
+ <Directory /export/home/trawick/apacheinst/htdocs/convert><br />
+ <indent>
+ CharsetSourceEnc UTF-16BE<br />
+ CharsetDefault ISO-8859-1<br />
+ </indent>
+ </Directory>
+ </example>
</usage>
</directivesynopsis>
<directivesynopsis>
<name>CharsetOptions</name>
-<description>Configures charset tranlation behavior</description>
-<syntax>CharsetOptions <em>option</em> [<em>option</em>] ...</syntax>
-<default>CharsetOptions DebugLevel=0
-NoImplicitAdd</default>
+<description>Configures charset translation behavior</description>
+<syntax>CharsetOptions <var>option</var> [<var>option</var>] ...</syntax>
+<default>CharsetOptions DebugLevel=0 NoImplicitAdd</default>
<contextlist><context>server config</context>
<context>virtual host</context><context>directory</context>
<context>.htaccess</context>
@@ -142,11 +147,11 @@
<usage>
<p>The <directive>CharsetOptions</directive> directive configures certain
- behaviors of <module>mod_charset_lite</module>. <em>Option</em> can
+ behaviors of <module>mod_charset_lite</module>. <var>Option</var> can
be one of</p>
<dl>
- <dt>DebugLevel=<em>n</em></dt>
+ <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
@@ -158,15 +163,16 @@
DBGLVL_ constants near the beginning of
<code>mod_charset_lite.c</code>.</dd>
- <dt>ImplicitAdd | NoImplicitAdd</dt>
+ <dt><code>ImplicitAdd | NoImplicitAdd</code></dt>
<dd>The <code>ImplicitAdd</code> keyword specifies that
<module>mod_charset_lite</module> 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 AddOutputFilter directive,
- <code>NoImplicitAdd</code> should be specified so that
- <module>mod_charset_lite</module> doesn't add its filter.</dd>
+ explicitly configured using the <directive module="mod_mime"
+ >AddOutputFilter</directive> directive, <code>NoImplicitAdd</code>
+ should be specified so that <module>mod_charset_lite</module>
+ doesn't add its filter.</dd>
</dl>
</usage>
</directivesynopsis>
1.30 +3 -4 httpd-2.0/docs/manual/mod/quickreference.html.en
Index: quickreference.html.en
===================================================================
RCS file: /home/cvs/httpd-2.0/docs/manual/mod/quickreference.html.en,v
retrieving revision 1.29
retrieving revision 1.30
diff -u -r1.29 -r1.30
--- quickreference.html.en 7 Nov 2002 03:34:36 -0000 1.29
+++ quickreference.html.en 7 Nov 2002 04:35:56 -0000 1.30
@@ -186,10 +186,9 @@
cached by proxy servers</td></tr>
<tr><td><a href="core.html#cgimapextension">CGIMapExtension cgi-path .extension</a></td><td /><td>dh</td><td>C</td></tr><tr><td class="descr" colspan="4">Technique for locating the interpreter for CGI
scripts</td></tr>
-<tr class="odd"><td><a href="mod_charset_lite.html#charsetdefault">CharsetDefault <em>charset</em></a></td><td /><td>svdh</td><td>X</td></tr><tr class="odd"><td class="descr" colspan="4">Charset to translate into</td></tr>
-<tr><td><a href="mod_charset_lite.html#charsetoptions">CharsetOptions <em>option</em> [<em>option</em>] ...</a></td><td> DebugLevel=0
-NoImp +</td><td>svdh</td><td>X</td></tr><tr><td class="descr" colspan="4">Configures charset tranlation behavior</td></tr>
-<tr class="odd"><td><a href="mod_charset_lite.html#charsetsourceenc">CharsetSourceEnc <em>charset</em></a></td><td /><td>svdh</td><td>X</td></tr><tr class="odd"><td class="descr" colspan="4">Source charset of files</td></tr>
+<tr class="odd"><td><a href="mod_charset_lite.html#charsetdefault">CharsetDefault <var>charset</var></a></td><td /><td>svdh</td><td>X</td></tr><tr class="odd"><td class="descr" colspan="4">Charset to translate into</td></tr>
+<tr><td><a href="mod_charset_lite.html#charsetoptions">CharsetOptions <var>option</var> [<var>option</var>] ...</a></td><td> DebugLevel=0 NoImpl +</td><td>svdh</td><td>X</td></tr><tr><td class="descr" colspan="4">Configures charset translation behavior</td></tr>
+<tr class="odd"><td><a href="mod_charset_lite.html#charsetsourceenc">CharsetSourceEnc <var>charset</var></a></td><td /><td>svdh</td><td>X</td></tr><tr class="odd"><td class="descr" colspan="4">Source charset of files</td></tr>
<tr><td><a href="mod_speling.html#checkspelling">CheckSpelling on|off</a></td><td> Off </td><td>svdh</td><td>E</td></tr><tr><td class="descr" colspan="4">Enables the spelling
module</td></tr>
<tr class="odd"><td><a href="perchild.html#childperuserid">ChildPerUserID <var>user_id</var>