Gecko [ v3.cesa.co.za ]

Name	Size	Permission	Date
core.html	306.8 KB	-rw-r--r--	2026-06-12 05:08
directive-dict.html	18 KB	-rw-r--r--	2026-06-12 05:08
directives.html	58.06 KB	-rw-r--r--	2026-06-12 05:08
event.html	28.64 KB	-rw-r--r--	2026-06-12 05:08
index.html	24.33 KB	-rw-r--r--	2026-06-12 05:08
mod_access_compat.html	28.27 KB	-rw-r--r--	2026-06-12 05:08
mod_actions.html	12.61 KB	-rw-r--r--	2026-06-12 05:08
mod_alias.html	40.63 KB	-rw-r--r--	2026-06-12 05:08
mod_allowmethods.html	7.79 KB	-rw-r--r--	2026-06-12 05:08
mod_asis.html	8.65 KB	-rw-r--r--	2026-06-12 05:08
mod_auth_basic.html	19.39 KB	-rw-r--r--	2026-06-12 05:08
mod_auth_digest.html	20.06 KB	-rw-r--r--	2026-06-12 05:08
mod_auth_form.html	50.26 KB	-rw-r--r--	2026-06-12 05:08
mod_authn_anon.html	16.37 KB	-rw-r--r--	2026-06-12 05:08
mod_authn_core.html	16.45 KB	-rw-r--r--	2026-06-12 05:08
mod_authn_dbd.html	15.01 KB	-rw-r--r--	2026-06-12 05:08
mod_authn_dbm.html	12.48 KB	-rw-r--r--	2026-06-12 05:08
mod_authn_file.html	11.17 KB	-rw-r--r--	2026-06-12 05:08
mod_authn_socache.html	18.79 KB	-rw-r--r--	2026-06-12 05:08
mod_authnz_fcgi.html	26.93 KB	-rw-r--r--	2026-06-12 05:08
mod_authnz_ldap.html	86.06 KB	-rw-r--r--	2026-06-12 05:08
mod_authz_core.html	39.59 KB	-rw-r--r--	2026-06-12 05:08
mod_authz_dbd.html	18.13 KB	-rw-r--r--	2026-06-12 05:08
mod_authz_dbm.html	12.7 KB	-rw-r--r--	2026-06-12 05:08
mod_authz_groupfile.html	10.24 KB	-rw-r--r--	2026-06-12 05:08
mod_authz_host.html	13.12 KB	-rw-r--r--	2026-06-12 05:08
mod_authz_owner.html	11 KB	-rw-r--r--	2026-06-12 05:08
mod_authz_user.html	7.91 KB	-rw-r--r--	2026-06-12 05:08
mod_autoindex.html	63.19 KB	-rw-r--r--	2026-06-12 05:08
mod_brotli.html	22.65 KB	-rw-r--r--	2026-06-12 05:08
mod_buffer.html	8.76 KB	-rw-r--r--	2026-06-12 05:08
mod_cache.html	69.74 KB	-rw-r--r--	2026-06-12 05:08
mod_cache_disk.html	20.06 KB	-rw-r--r--	2026-06-12 05:08
mod_cache_socache.html	18.21 KB	-rw-r--r--	2026-06-12 05:08
mod_cern_meta.html	10.83 KB	-rw-r--r--	2026-06-12 05:08
mod_cgi.html	19.94 KB	-rw-r--r--	2026-06-12 05:08
mod_cgid.html	11.36 KB	-rw-r--r--	2026-06-12 05:08
mod_charset_lite.html	15.11 KB	-rw-r--r--	2026-06-12 05:08
mod_data.html	7.2 KB	-rw-r--r--	2026-06-12 05:08
mod_dav.html	19.88 KB	-rw-r--r--	2026-06-12 05:08
mod_dav_fs.html	10.54 KB	-rw-r--r--	2026-06-12 05:08
mod_dav_lock.html	9.51 KB	-rw-r--r--	2026-06-12 05:08
mod_dbd.html	24.89 KB	-rw-r--r--	2026-06-12 05:08
mod_deflate.html	31.15 KB	-rw-r--r--	2026-06-12 05:08
mod_dialup.html	7.2 KB	-rw-r--r--	2026-06-12 05:08
mod_dir.html	23.75 KB	-rw-r--r--	2026-06-12 05:08
mod_dumpio.html	9.41 KB	-rw-r--r--	2026-06-12 05:08
mod_echo.html	7.16 KB	-rw-r--r--	2026-06-12 05:08
mod_env.html	11.48 KB	-rw-r--r--	2026-06-12 05:08
mod_example_hooks.html	11.01 KB	-rw-r--r--	2026-06-12 05:08
mod_expires.html	17.21 KB	-rw-r--r--	2026-06-12 05:08
mod_ext_filter.html	18.05 KB	-rw-r--r--	2026-06-12 05:08
mod_file_cache.html	15.2 KB	-rw-r--r--	2026-06-12 05:08
mod_filter.html	33.35 KB	-rw-r--r--	2026-06-12 05:08
mod_headers.html	34.06 KB	-rw-r--r--	2026-06-12 05:08
mod_heartbeat.html	9.29 KB	-rw-r--r--	2026-06-12 05:08
mod_heartmonitor.html	11.92 KB	-rw-r--r--	2026-06-12 05:08
mod_http2.html	75.84 KB	-rw-r--r--	2026-06-12 05:08
mod_ident.html	9.74 KB	-rw-r--r--	2026-06-12 05:08
mod_imagemap.html	21.06 KB	-rw-r--r--	2026-06-12 05:08
mod_include.html	59.69 KB	-rw-r--r--	2026-06-12 05:08
mod_info.html	14.52 KB	-rw-r--r--	2026-06-12 05:08
mod_isapi.html	23.44 KB	-rw-r--r--	2026-06-12 05:08
mod_lbmethod_bybusyness.html	7.6 KB	-rw-r--r--	2026-06-12 05:08
mod_lbmethod_byrequests.html	12.3 KB	-rw-r--r--	2026-06-12 05:08
mod_lbmethod_bytraffic.html	7.95 KB	-rw-r--r--	2026-06-12 05:08
mod_lbmethod_heartbeat.html	8.02 KB	-rw-r--r--	2026-06-12 05:08
mod_ldap.html	50.89 KB	-rw-r--r--	2026-06-12 05:08
mod_log_config.html	38.27 KB	-rw-r--r--	2026-06-12 05:08
mod_log_debug.html	9.95 KB	-rw-r--r--	2026-06-12 05:08
mod_log_forensic.html	12.64 KB	-rw-r--r--	2026-06-12 05:08
mod_logio.html	10.29 KB	-rw-r--r--	2026-06-12 05:08
mod_lua.html	93.06 KB	-rw-r--r--	2026-06-12 05:08
mod_macro.html	15.29 KB	-rw-r--r--	2026-06-12 05:08
mod_md.html	109.91 KB	-rw-r--r--	2026-06-12 05:08
mod_mime.html	66.05 KB	-rw-r--r--	2026-06-12 05:08
mod_mime_magic.html	16.52 KB	-rw-r--r--	2026-06-12 05:08
mod_negotiation.html	21.68 KB	-rw-r--r--	2026-06-12 05:08
mod_nw_ssl.html	9.27 KB	-rw-r--r--	2026-06-12 05:08
mod_privileges.html	29.36 KB	-rw-r--r--	2026-06-12 05:08
mod_proxy.html	137.06 KB	-rw-r--r--	2026-06-12 05:08
mod_proxy_ajp.html	32.56 KB	-rw-r--r--	2026-06-12 05:08
mod_proxy_balancer.html	23.03 KB	-rw-r--r--	2026-06-12 05:08
mod_proxy_connect.html	9.85 KB	-rw-r--r--	2026-06-12 05:08
mod_proxy_express.html	13.19 KB	-rw-r--r--	2026-06-12 05:08
mod_proxy_fcgi.html	22.14 KB	-rw-r--r--	2026-06-12 05:08
mod_proxy_fdpass.html	7.2 KB	-rw-r--r--	2026-06-12 05:08
mod_proxy_ftp.html	18.84 KB	-rw-r--r--	2026-06-12 05:08
mod_proxy_hcheck.html	17.43 KB	-rw-r--r--	2026-06-12 05:08
mod_proxy_html.html	34.16 KB	-rw-r--r--	2026-06-12 05:08
mod_proxy_http.html	11.63 KB	-rw-r--r--	2026-06-12 05:08
mod_proxy_http2.html	10.05 KB	-rw-r--r--	2026-06-12 05:08
mod_proxy_scgi.html	14.49 KB	-rw-r--r--	2026-06-12 05:08
mod_proxy_uwsgi.html	8.15 KB	-rw-r--r--	2026-06-12 05:08
mod_proxy_wstunnel.html	10.73 KB	-rw-r--r--	2026-06-12 05:08
mod_ratelimit.html	6.72 KB	-rw-r--r--	2026-06-12 05:08
mod_reflector.html	8.28 KB	-rw-r--r--	2026-06-12 05:08
mod_remoteip.html	26.54 KB	-rw-r--r--	2026-06-12 05:08
mod_reqtimeout.html	12.49 KB	-rw-r--r--	2026-06-12 05:08
mod_request.html	9.03 KB	-rw-r--r--	2026-06-12 05:08
mod_rewrite.html	82.27 KB	-rw-r--r--	2026-06-12 05:08
mod_sed.html	11.53 KB	-rw-r--r--	2026-06-12 05:08
mod_session.html	35.31 KB	-rw-r--r--	2026-06-12 05:08
mod_session_cookie.html	13.55 KB	-rw-r--r--	2026-06-12 05:08
mod_session_crypto.html	17.73 KB	-rw-r--r--	2026-06-12 05:08
mod_session_dbd.html	25.2 KB	-rw-r--r--	2026-06-12 05:08
mod_setenvif.html	21.77 KB	-rw-r--r--	2026-06-12 05:08
mod_slotmem_plain.html	7.76 KB	-rw-r--r--	2026-06-12 05:08
mod_slotmem_shm.html	8.36 KB	-rw-r--r--	2026-06-12 05:08
mod_so.html	13.5 KB	-rw-r--r--	2026-06-12 05:08
mod_socache_dbm.html	5.82 KB	-rw-r--r--	2026-06-12 05:08
mod_socache_dc.html	5.87 KB	-rw-r--r--	2026-06-12 05:08
mod_socache_memcache.html	8.34 KB	-rw-r--r--	2026-06-12 05:08
mod_socache_redis.html	10 KB	-rw-r--r--	2026-06-12 05:08
mod_socache_shmcb.html	5.9 KB	-rw-r--r--	2026-06-12 05:08
mod_speling.html	12.64 KB	-rw-r--r--	2026-06-12 05:08
mod_ssl.html	200.72 KB	-rw-r--r--	2026-06-12 05:08
mod_status.html	11.84 KB	-rw-r--r--	2026-06-12 05:08
mod_substitute.html	14.37 KB	-rw-r--r--	2026-06-12 05:08
mod_suexec.html	7.89 KB	-rw-r--r--	2026-06-12 05:08
mod_systemd.html	7.57 KB	-rw-r--r--	2026-06-12 05:08
mod_unique_id.html	14.89 KB	-rw-r--r--	2026-06-12 05:08
mod_unixd.html	13.54 KB	-rw-r--r--	2026-06-12 05:08
mod_userdir.html	12.36 KB	-rw-r--r--	2026-06-12 05:08
mod_usertrack.html	19.68 KB	-rw-r--r--	2026-06-12 05:08
mod_version.html	10.05 KB	-rw-r--r--	2026-06-12 05:08
mod_vhost_alias.html	21.12 KB	-rw-r--r--	2026-06-12 05:08
mod_watchdog.html	7.73 KB	-rw-r--r--	2026-06-12 05:08
mod_xml2enc.html	15.3 KB	-rw-r--r--	2026-06-12 05:08
module-dict.html	9.17 KB	-rw-r--r--	2026-06-12 05:08
mpm_common.html	70.04 KB	-rw-r--r--	2026-06-12 05:08
mpm_netware.html	9.82 KB	-rw-r--r--	2026-06-12 05:08
mpm_winnt.html	10.58 KB	-rw-r--r--	2026-06-12 05:08
mpmt_os2.html	7.5 KB	-rw-r--r--	2026-06-12 05:08
overrides.html	69.49 KB	-rw-r--r--	2026-06-12 05:08
prefork.html	15.96 KB	-rw-r--r--	2026-06-12 05:08
quickreference.html	193.75 KB	-rw-r--r--	2026-06-12 05:08
worker.html	15.23 KB	-rw-r--r--	2026-06-12 05:08

Rename

<!DOCTYPE html SYSTEM "about:legacy-compat">
<html lang="en"><head><META http-equiv="Content-Type" content="text/html; charset=UTF-8">
<meta content="width=device-width, initial-scale=1" name="viewport">

<title>mod_xml2enc - Apache HTTP Server Version 2.4</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 rel="stylesheet" type="text/css" href="../../style/css/prettify.css">
<script src="../../style/scripts/prettify.min.js">
</script>

<p>This module provides enhanced internationalisation support for
    markup-aware filter modules such as <code class="module"><a href="../mod/mod_proxy_html.html">mod_proxy_html</a></code>.
    It can automatically detect the encoding of input data and ensure
    they are correctly processed by the <a href="http://xmlsoft.org/">libxml2</a> parser, including converting to Unicode (UTF-8) where
    necessary.  It can also convert data to an encoding of choice
    after markup processing, and will ensure the correct <var>charset</var>
    value is set in the HTTP <var>Content-Type</var> header.</p>
</div>
<div id="quickview"><h3>Topics</h3>
<ul id="topics">
<li><img alt="" src="../../images/down.gif"> <a href="#usage">Usage</a></li>
<li><img alt="" src="../../images/down.gif"> <a href="#api">Programming API</a></li>
<li><img alt="" src="../../images/down.gif"> <a href="#sniffing">Detecting an Encoding</a></li>
<li><img alt="" src="../../images/down.gif"> <a href="#output">Output Encoding</a></li>
<li><img alt="" src="../../images/down.gif"> <a href="#alias">Unsupported Encodings</a></li>
</ul><h3 class="directives">Directives</h3>
<ul id="toc">
<li><img alt="" src="../../images/down.gif"> <a href="#xml2encalias">xml2EncAlias</a></li>
<li><img alt="" src="../../images/down.gif"> <a href="#xml2encdefault">xml2EncDefault</a></li>
<li><img alt="" src="../../images/down.gif"> <a href="#xml2startparse">xml2StartParse</a></li>
</ul>
<h3>Bugfix checklist</h3><ul class="seealso"><li><a href="https://www.apache.org/dist/httpd/CHANGES_2.4">httpd changelog</a></li><li><a href="https://bz.apache.org/bugzilla/buglist.cgi?bug_status=__open__&amp;list_id=144532&amp;product=Apache%20httpd-2&amp;query_format=specific&amp;order=changeddate%20DESC%2Cpriority%2Cbug_severity&amp;component=mod_xml2enc">Known issues</a></li><li><a href="https://bz.apache.org/bugzilla/enter_bug.cgi?product=Apache%20httpd-2&amp;component=mod_xml2enc">Report a bug</a></li></ul></div>
<div class="top"><a href="#page-header"><img alt="top" src="../../images/up.gif"></a></div>
<div class="section">
<h2 id="usage">Usage <a title="Permanent link" href="#usage" class="permalink">&para;</a></h2>
    <p>There are two usage scenarios: with modules programmed to work
    with mod_xml2enc, and with those that are not aware of it:</p>
    <dl>
    <dt>Filter modules enabled for mod_xml2enc</dt><dd>
    <p>Modules such as <code class="module"><a href="../mod/mod_proxy_html.html">mod_proxy_html</a></code> version 3.1
    and up use the <code>xml2enc_charset</code> optional function to retrieve
    the charset argument to pass to the libxml2 parser, and may use the
    <code>xml2enc_filter</code> optional function to postprocess to another
    encoding.  Using mod_xml2enc with an enabled module, no configuration
    is necessary: the other module will configure mod_xml2enc for you
    (though you may still want to customize it using the configuration
    directives below).</p>
    </dd>
    <dt>Non-enabled modules</dt><dd>
    <p>To use it with a libxml2-based module that isn't explicitly enabled for
    mod_xml2enc, you will have to configure the filter chain yourself.  So to
    use it with a filter <strong>foo</strong> provided by a module
    <strong>mod_foo</strong> to improve the latter's i18n support with HTML and
    XML, you could use</p>
    <pre><code>
    FilterProvider iconv    xml2enc Content-Type $text/html
    FilterProvider iconv    xml2enc Content-Type $xml
    FilterProvider markup   foo Content-Type $text/html
    FilterProvider markup   foo Content-Type $xml
    FilterChain     iconv markup
    </code></pre>
    <p><strong>mod_foo</strong> will now support any character set supported by either
    (or both) of libxml2 or apr_xlate/iconv.</p>
    </dd></dl>
</div><div class="top"><a href="#page-header"><img alt="top" src="../../images/up.gif"></a></div>
<div class="section">
<h2 id="api">Programming API <a title="Permanent link" href="#api" class="permalink">&para;</a></h2>
    <p>Programmers writing libxml2-based filter modules are encouraged to
    enable them for mod_xml2enc, to provide strong i18n support for your
    users without reinventing the wheel.  The programming API is exposed in
    <var>mod_xml2enc.h</var>, and a usage example is
    <code class="module"><a href="../mod/mod_proxy_html.html">mod_proxy_html</a></code>.</p>
</div><div class="top"><a href="#page-header"><img alt="top" src="../../images/up.gif"></a></div>
<div class="section">
<h2 id="sniffing">Detecting an Encoding <a title="Permanent link" href="#sniffing" class="permalink">&para;</a></h2>
    <p>Unlike <code class="module"><a href="../mod/mod_charset_lite.html">mod_charset_lite</a></code>, mod_xml2enc is designed
    to work with data whose encoding cannot be known in advance and thus
    configured.  It therefore uses 'sniffing' techniques to detect the
    encoding of HTTP data as follows:</p>
    <ol>
        <li>If the HTTP <var>Content-Type</var> header includes a
        <var>charset</var> parameter, that is used.</li>
        <li>If the data start with an XML Byte Order Mark (BOM) or an
        XML encoding declaration, that is used.</li>
        <li>If an encoding is declared in an HTML <code>&lt;META&gt;</code>
        element, that is used.</li>
        <li>If none of the above match, the default value set by
        <code class="directive">xml2EncDefault</code> is used.</li>
    </ol>
    <p>The rules are applied in order.  As soon as a match is found,
    it is used and detection is stopped.</p>
</div><div class="top"><a href="#page-header"><img alt="top" src="../../images/up.gif"></a></div>
<div class="section">
<h2 id="output">Output Encoding <a title="Permanent link" href="#output" class="permalink">&para;</a></h2>
<p><a href="http://xmlsoft.org/">libxml2</a> always uses UTF-8 (Unicode)
internally, and libxml2-based filter modules will output that by default.
mod_xml2enc can change the output encoding through the API, but there
is currently no way to configure that directly.</p>
<p>Changing the output encoding should (in theory, at least) never be
necessary, and is not recommended due to the extra processing load on
the server of an unnecessary conversion.</p>
</div><div class="top"><a href="#page-header"><img alt="top" src="../../images/up.gif"></a></div>
<div class="section">
<h2 id="alias">Unsupported Encodings <a title="Permanent link" href="#alias" class="permalink">&para;</a></h2>
<p>If you are working with encodings that are not supported by any of
the conversion methods available on your platform, you can still alias
them to a supported encoding using <code class="directive">xml2EncAlias</code>.</p>
</div>
<div class="top"><a href="#page-header"><img alt="top" src="../../images/up.gif"></a></div>
<div class="directive-section"><h2 id="xml2encalias"><span id="xml2EncAlias">xml2EncAlias</span> Directive <a title="Permanent link" href="#xml2encalias" class="permalink">&para;</a></h2>
<table class="directive">
<tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Recognize Aliases for encoding values</td></tr>
<tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>xml2EncAlias <var>charset alias [alias ...]</var></code></td></tr>
<tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config</td></tr>
<tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Base</td></tr>
<tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_xml2enc</td></tr>
</table>
    <p>This server-wide directive aliases one or more encoding to another
    encoding.  This enables encodings not recognized by libxml2 to be handled
    internally by libxml2's encoding support using the translation table for
    a recognized encoding.  This serves two purposes: to support character sets
    (or names) not recognized either by libxml2 or iconv, and to skip
    conversion for an encoding where it is known to be unnecessary.</p>

</div>
<div class="top"><a href="#page-header"><img alt="top" src="../../images/up.gif"></a></div>
<div class="directive-section"><h2 id="xml2encdefault"><span id="xml2EncDefault">xml2EncDefault</span> Directive <a title="Permanent link" href="#xml2encdefault" class="permalink">&para;</a></h2>
<table class="directive">
<tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Sets a default encoding to assume when absolutely no information
can be <a href="#sniffing">automatically detected</a></td></tr>
<tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>xml2EncDefault <var>name</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#Status">Status:</a></th><td>Base</td></tr>
<tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_xml2enc</td></tr>
</table>
    <p>If you are processing data with known encoding but no encoding
    information, you can set this default to help mod_xml2enc process
    the data correctly.  For example, to work with the default value
    of Latin1 (<var>iso-8859-1</var>) specified in HTTP/1.0, use:</p>
    <pre class="prettyprint lang-config">xml2EncDefault iso-8859-1</pre>

</div>
<div class="top"><a href="#page-header"><img alt="top" src="../../images/up.gif"></a></div>
<div class="directive-section"><h2 id="xml2startparse"><span id="xml2StartParse">xml2StartParse</span> Directive <a title="Permanent link" href="#xml2startparse" class="permalink">&para;</a></h2>
<table class="directive">
<tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Advise the parser to skip leading junk.</td></tr>
<tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>xml2StartParse <var>element [element ...]</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#Status">Status:</a></th><td>Base</td></tr>
<tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_xml2enc</td></tr>
</table>
    <p>Specify that the markup parser should start at the first instance
    of any of the elements specified.  This can be used as a workaround
    where a broken backend inserts leading junk that messes up the parser (<a href="http://bahumbug.wordpress.com/2006/10/12/mod_proxy_html-revisited/">example here</a>).</p>
    <p>It should never be used for XML, nor well-formed HTML.</p>

</div>
</div>
<div class="bottomlang">
<p><span>Available Languages: </span><a href="../../en/mod/mod_xml2enc.html" title="English">&nbsp;en&nbsp;</a> |
<a href="../../fr/mod/mod_xml2enc.html" hreflang="fr" rel="alternate" title="Fran&ccedil;ais">&nbsp;fr&nbsp;</a></p>
</div><div id="footer">
<p class="apache">Copyright 2026 The Apache Software Foundation.<br>Licensed under the <a href="https://www.apache.org/licenses/LICENSE-2.0">Apache License, Version 2.0</a>.</p>
<p class="menu"><a href="../mod/index.html">Modules</a> | <a href="../mod/quickreference.html">Directives</a> | <a href="https://cwiki.apache.org/confluence/display/httpd/FAQ">FAQ</a> | <a href="../glossary.html">Glossary</a> | <a href="../sitemap.html">Sitemap</a> | <a href="https://bz.apache.org/bugzilla/enter_bug.cgi?product=Apache%20httpd-2">Report a bug</a></p></div><script><![CDATA[//><!]]></script>
</body></html>