2 <!DOCTYPE modulesynopsis SYSTEM "../style/modulesynopsis.dtd">
3 <?xml-stylesheet type="text/xsl" href="../style/manual.xsl"?>
6 <name>mod_deflate</name>
7 <description>Compress content before
8 it is delivered to the client</description>
9 <status>experimental</status>
10 <sourcefile>mod_deflate.c</sourcefile>
11 <identifier>deflate_module</identifier>
14 <p>The experimental <module>mod_deflate</module> module provides
15 the <code>DEFLATE</code> output filter that allows output from
16 your server to be compressed before being sent to the client over
19 <seealso><directive module="mod_mime">AddOutputFilter</directive></seealso>
20 <seealso><directive module="core">SetOutputFilter</directive></seealso>
22 <section><title>Enabling Compression</title>
24 <p>Compression is implemented by the <code>DEFLATE</code>
25 <a href="../filter.html">filter</a>. The following directive
26 will enable compression for documents in the container where it
28 <p><strong>Most popular browsers can not handle compression of all content
29 so you may want to enable the 'gzip-only-text/html' note (see below)
32 <example>SetEnv gzip-only-text/html 1<br />
33 SetOutputFilter DEFLATE
36 <p>Here is an example of enabling compression for the Apache
40 <Directory "/your-server-root/manual"><br />
41 SetEnv gzip-only-text/html 1<br />
42 SetOutputFilter DEFLATE<br />
48 <name>DeflateFilterNote</name>
49 <description>Places the compression ratio in a note for logging</description>
50 <syntax>DeflateFilterNote <em>notename</em></syntax>
51 <contextlist><context>server config</context></contextlist>
54 <p>The <directive>DeflateFilterNote</directive> directive
55 specifies that a note about compression ratios should be attached
56 to the request. The name of the note is the value specified for
62 <name>DeflateWindowSize</name>
63 <description>Zlib compression window size</description>
64 <syntax>DeflateWindowSize <em>value</em></syntax>
65 <contextlist><context>server config</context></contextlist>
68 <!-- XXX: Ummm... What unit??? -->
69 <p>The <directive>DeflateWindowSize</directive> directive specifies the
70 zlib compression window size.</p>
75 <name>DeflateMemLevel</name>
76 <description>Amount of memory available to zlib for compression</description>
77 <syntax>DeflateMemLevel <em>value</em></syntax>
78 <contextlist><context>server config</context></contextlist>
81 <!-- XXX: Ummm... What unit??? -->
82 <p>The <directive>DeflateMemLevel</directive> directive specifies
83 the amount of memory available to zlib for compression.</p>