granicus.if.org Git - apache/blob - docs/manual/mod/mod_deflate.xml

   1 <?xml version="1.0"?>
   2 <!DOCTYPE modulesynopsis SYSTEM "../style/modulesynopsis.dtd">
   3 <?xml-stylesheet type="text/xsl" href="../style/manual.en.xsl"?>
   4 <modulesynopsis>
   5
   6 <name>mod_deflate</name>
   7 <description>Compress content before
   8     it is delivered to the client</description>
   9 <status>Extension</status>
  10 <sourcefile>mod_deflate.c</sourcefile>
  11 <identifier>deflate_module</identifier>
  12
  13 <summary>
  14     <p>The <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
  17     the network.</p>
  18 </summary>
  19 <seealso><directive module="mod_mime">AddOutputFilter</directive></seealso>
  20 <seealso><directive module="core">SetOutputFilter</directive></seealso>
  21
  22 <section><title>Enabling Compression</title>
  23
  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
  27     is placed:</p>
  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)
  30     </strong></p>
  31
  32 <example>SetEnv gzip-only-text/html 1<br />
  33 SetOutputFilter DEFLATE
  34 </example>
  35
  36     <p>Here is an example of enabling compression for the Apache
  37     documentation:</p>
  38
  39 <example>
  40 &lt;Directory "/your-server-root/manual"&gt;<br />
  41       SetEnv gzip-only-text/html 1<br />
  42       SetOutputFilter DEFLATE<br />
  43 &lt;/Directory&gt;
  44 </example>
  45 </section>
  46
  47 <directivesynopsis>
  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>
  52
  53 <usage>
  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
  57     the directive.</p>
  58 </usage>
  59 </directivesynopsis>
  60
  61 <directivesynopsis>
  62 <name>DeflateBufferSize</name>
  63 <description>Fragment size to be compressed at one time by zlib</description>
  64 <syntax>DeflateBufferSize <em>value</em></syntax>
  65 <contextlist><context>server config</context></contextlist>
  66
  67 <usage>
  68     <p>The <directive>DeflateBufferSize</directive> directive specifies
  69     the size in bytes of the fragments that zlib should compress at one
  70     time.</p>
  71 </usage>
  72 </directivesynopsis>
  73
  74 <directivesynopsis>
  75 <name>DeflateWindowSize</name>
  76 <description>Zlib compression window size</description>
  77 <syntax>DeflateWindowSize <em>value</em></syntax>
  78 <contextlist><context>server config</context></contextlist>
  79
  80 <usage>
  81     <p>The <directive>DeflateWindowSize</directive> directive specifies the
  82     zlib compression window size (a value between 1 and 15).</p>
  83 </usage>
  84 </directivesynopsis>
  85
  86 <directivesynopsis>
  87 <name>DeflateMemLevel</name>
  88 <description>Amount of memory available to zlib for compression</description>
  89 <syntax>DeflateMemLevel <em>value</em></syntax>
  90 <contextlist><context>server config</context></contextlist>
  91
  92 <usage>
  93     <p>The <directive>DeflateMemLevel</directive> directive specifies
  94     the amount of memory in bytes available to zlib for compression.</p>
  95 </usage>
  96 </directivesynopsis>
  97
  98 </modulesynopsis>
  99