<?xml version="1.0" encoding="UTF-8"?> <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> <html lang="en-us" xml:lang="en-us"> <head> <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> <meta name="security" content="public" /> <meta name="Robots" content="index,follow" /> <meta http-equiv="PICS-Label" content='(PICS-1.1 "http://www.icra.org/ratingsv02.html" l gen true r (cz 1 lz 1 nz 1 oz 1 vz 1) "http://www.rsac.org/ratingsv01.html" l gen true r (n 0 s 0 v 0 l 0) "http://www.classify.org/safesurf/" l gen true r (SS~~000 1))' /> <meta name="DC.Type" content="topic" /> <meta name="DC.Title" content="Module mod_deflate" /> <meta name="copyright" content="(C) Copyright IBM Corporation 2002,2006" /> <meta name="DC.Rights.Owner" content="(C) Copyright IBM Corporation 2002,2006" /> <meta name="DC.Format" content="XHTML" /> <meta name="DC.Identifier" content="rzaiemod_deflate" /> <meta name="DC.Language" content="en-us" /> <!-- All rights reserved. Licensed Materials Property of IBM --> <!-- US Government Users Restricted Rights --> <!-- Use, duplication or disclosure restricted by --> <!-- GSA ADP Schedule Contract with IBM Corp. --> <link rel="stylesheet" type="text/css" href="./ibmdita.css" /> <link rel="stylesheet" type="text/css" href="./ic.css" /> <title>Module mod_deflate</title> </head> <body id="rzaiemod_deflate"><a name="rzaiemod_deflate"><!-- --></a> <!-- Java sync-link --><script language="Javascript" src="../rzahg/synch.js" type="text/javascript"></script> <h1 class="topictitle1">Module mod_deflate</h1> <div><div class="important"><span class="importanttitle">Important:</span> Information for this topic supports the latest PTF levels for HTTP Server for i5/OS . It is recommended that you install the latest PTFs to upgrade to the latest level of the HTTP Server for i5/OS. Some of the topics documented here are not available prior to this update. See <a href="http://www-03.ibm.com/servers/eserver/iseries/software/http/services/service.html" target="_blank">http://www.ibm.com/servers/eserver/iseries/software/http/services/service.htm</a> <img src="www.gif" alt="Link outside Information Center" /> for more information. </div> <p><strong>Summary</strong></p> <p>Module mod_deflate specifies compression and decompression functions using filters, MIME types, environment variables, and HTTP responses. Compressed output is transferred to requesting client browsers at a higher rate of speed than uncompressed output. Compression and decompression is implemented by the DEFLATE filter, located in module mod_deflate. See <a href="http://httpd.apache.org/docs-2.0/mod/mod_deflate.html" target="_blank">Apache HTTP Server Version 2.0 Documentation</a> <img src="www.gif" alt="Link outside Information Center" /> for additional information and examples on configuring the Apache server to use compression.</p> <p><strong>Directives</strong></p> <ul><li><a href="#deflatebuffersize">DeflateBufferSize</a></li> <li><a href="#deflatecompressionlevel">DeflateCompressionLevel</a></li> <li><a href="#deflatefilternote">DeflateFilterNote</a></li> <li><a href="#deflatememlevel">DeflateMemLevel</a></li> <li><a href="#deflatewindowsize">DeflateWindowSize</a></li> </ul> </div> <div class="hr" id="deflatebuffersize"><a name="deflatebuffersize"><!-- --></a><h2 class="topictitle2">DeflateBufferSize</h2> <div> <div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" frame="void" border="0" rules="none"><tbody><tr><td colspan="2" valign="top"><strong><a href="rzaiedirective-dict.htm#rzaiedirective-dict__Module">Module</a></strong>: mod_deflate</td> </tr> <tr><td colspan="2" valign="top"><strong><a href="rzaiedirective-dict.htm#rzaiedirective-dict__Syntax">Syntax</a></strong>: DeflateBufferSize <em>value</em></td> </tr> <tr><td colspan="2" valign="top"><strong><a href="rzaiedirective-dict.htm#rzaiedirective-dict__Default">Default</a></strong>: DeflateBufferSize 8096</td> </tr> <tr><td colspan="2" valign="top"><strong><a href="rzaiedirective-dict.htm#rzaiedirective-dict__Context">Context</a></strong>: <span id="deflatebuffersize__deflatebuffersize_context"><a name="deflatebuffersize__deflatebuffersize_context"><!-- --></a>server config, virtual host</span></td> </tr> <tr><td colspan="2" valign="top"><strong><a href="rzaiedirective-dict.htm#rzaiedirective-dict__Override">Override</a></strong>: none</td> </tr> <tr><td colspan="2" valign="top"><strong><a href="rzaiedirective-dict.htm#rzaiedirective-dict__Origin">Origin</a></strong>: <span id="deflatebuffersize__deflatebuffersize_origin"><a name="deflatebuffersize__deflatebuffersize_origin"><!-- --></a>Apache</span></td> </tr> <tr><td colspan="2" valign="top"><strong><a href="rzaiedirective-dict.htm#rzaiedirective-dict__UsageConsiderations">Usage Considerations</a></strong>: A LoadModule is required in the configuration file prior to using the directive. The statement should be as follows: deflate_module /QSYS.LIB/QHTTPSVR.LIB/QZSRCORE.SRVPGM</td> </tr> <tr><td colspan="2" valign="top"><strong><a href="rzaiedirective-dict.htm#rzaiedirective-dict__Example">Example</a></strong>: DeflateBufferSize 8096</td> </tr> </tbody> </table> </div> <p>The DeflateBufferSize directive specifies the size of the fragments that zlib should compress at one time.</p> <blockquote><dl class="dlexpand"><dt class="dltermexpand"><strong>Parameter</strong>: <em>value</em></dt> <dd><ul><li>The <em>value</em> parameter specifies the size, in bytes, of the fragments that zlib should compress at one time.</li> </ul> </dd> </dl> </blockquote> </div> </div> <div class="hr" id="deflatecompressionlevel"><a name="deflatecompressionlevel"><!-- --></a><h2 class="topictitle2">DeflateCompressionLevel</h2> <div> <div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" frame="void" border="0" rules="none"><tbody><tr><td colspan="2" valign="top"><strong><a href="rzaiedirective-dict.htm#rzaiedirective-dict__Module">Module</a></strong>: mod_deflate</td> </tr> <tr><td colspan="2" valign="top"><strong><a href="rzaiedirective-dict.htm#rzaiedirective-dict__Syntax">Syntax</a></strong>: DeflateCompressionLevel <em>value</em></td> </tr> <tr><td colspan="2" valign="top"><strong><a href="rzaiedirective-dict.htm#rzaiedirective-dict__Default">Default</a></strong>: DeflateCompressionLevel 6</td> </tr> <tr><td colspan="2" valign="top"><strong><a href="rzaiedirective-dict.htm#rzaiedirective-dict__Context">Context</a></strong>: <span id="deflatecompressionlevel__deflatecompressionlevel_context"><a name="deflatecompressionlevel__deflatecompressionlevel_context"><!-- --></a>server config, virtual host</span></td> </tr> <tr><td colspan="2" valign="top"><strong><a href="rzaiedirective-dict.htm#rzaiedirective-dict__Override">Override</a></strong>: none</td> </tr> <tr><td colspan="2" valign="top"><strong><a href="rzaiedirective-dict.htm#rzaiedirective-dict__Origin">Origin</a></strong>: <span id="deflatecompressionlevel__deflatecompressionlevel_origin"><a name="deflatecompressionlevel__deflatecompressionlevel_origin"><!-- --></a>Apache</span></td> </tr> <tr><td colspan="2" valign="top"><strong><a href="rzaiedirective-dict.htm#rzaiedirective-dict__UsageConsiderations">Usage Considerations</a></strong>: A LoadModule is required in the configuration file prior to using the directive. The statement should be as follows: deflate_module /QSYS.LIB/QHTTPSVR.LIB/QZSRCORE.SRVPGM</td> </tr> <tr><td colspan="2" valign="top"><strong><a href="rzaiedirective-dict.htm#rzaiedirective-dict__Example">Example</a></strong>: DeflateCompressionLevel 5</td> </tr> </tbody> </table> </div> <p>The DeflateCompressionLevel directive specifies what level of compression should be used.</p> <blockquote><dl class="dlexpand"><dt class="dltermexpand"><strong>Parameter</strong>: <em>value</em></dt> <dd><ul><li>The <em>value</em> parameter value specifies the level of compression. The higher the value, the greater the compression.<div class="note"><span class="notetitle">Note:</span> Higher compression levels require additional CPU time.</div> </li> </ul> </dd> </dl> </blockquote> </div> </div> <div class="hr" id="deflatefilternote"><a name="deflatefilternote"><!-- --></a><h2 class="topictitle2">DeflateFilterNote</h2> <div> <div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" frame="void" border="0" rules="none"><tbody><tr><td colspan="2" valign="top"><strong><a href="rzaiedirective-dict.htm#rzaiedirective-dict__Module">Module</a></strong>: mod_deflate</td> </tr> <tr><td colspan="2" valign="top"><strong><a href="rzaiedirective-dict.htm#rzaiedirective-dict__Syntax">Syntax</a></strong>: DeflateFilterNote <em>[type]</em> <em>notename</em></td> </tr> <tr><td colspan="2" valign="top"><strong><a href="rzaiedirective-dict.htm#rzaiedirective-dict__Default">Default</a></strong>: none</td> </tr> <tr><td colspan="2" valign="top"><strong><a href="rzaiedirective-dict.htm#rzaiedirective-dict__Context">Context</a></strong>: <span id="deflatefilternote__deflatefilternote_context"><a name="deflatefilternote__deflatefilternote_context"><!-- --></a>server config, virtual host</span></td> </tr> <tr><td colspan="2" valign="top"><strong><a href="rzaiedirective-dict.htm#rzaiedirective-dict__Override">Override</a></strong>: none</td> </tr> <tr><td colspan="2" valign="top"><strong><a href="rzaiedirective-dict.htm#rzaiedirective-dict__Origin">Origin</a></strong>: <span id="deflatefilternote__deflatefilternote_origin"><a name="deflatefilternote__deflatefilternote_origin"><!-- --></a>Apache</span></td> </tr> <tr><td colspan="2" valign="top"><strong><a href="rzaiedirective-dict.htm#rzaiedirective-dict__UsageConsiderations">Usage Considerations</a></strong>: A LoadModule is required in the configuration file prior to using the directive. The statement should be as follows: deflate_module /QSYS.LIB/QHTTPSVR.LIB/QZSRCORE.SRVPGM</td> </tr> <tr><td colspan="2" valign="top"><strong><a href="rzaiedirective-dict.htm#rzaiedirective-dict__Example">Example</a></strong>: DeflateFilterNote ratio</td> </tr> <tr><td colspan="2" valign="top"><strong><a href="rzaiedirective-dict.htm#rzaiedirective-dict__Example">Example</a></strong>: DeflateFilterNote Ratio ratio</td> </tr> <tr><td colspan="2" valign="top"><strong><a href="rzaiedirective-dict.htm#rzaiedirective-dict__Example">Example</a></strong>: DeflateFilterNote Input input</td> </tr> <tr><td colspan="2" valign="top"><strong><a href="rzaiedirective-dict.htm#rzaiedirective-dict__Example">Example</a></strong>: DeflateFilterNote input input</td> </tr> </tbody> </table> </div> <p>The DeflateFilterNote directive specifies that a note about compression ratios should be attached to the request. The note is used for statistical purposes by adding a value to your access log.</p> <blockquote><dl class="dlexpand"><dt class="dltermexpand"><strong>Parameter One</strong>: <em>type</em></dt> <dd><ul><li>The <em>type</em> parameter value specifies what type of data is added to the note for logging. The parameter value is not case-sensitive. Possible values include:<dl class="dlexpand"><dt class="dltermexpand">Input </dt> <dd>Store the byte count of the filter's input stream in the note. </dd> <dt class="dltermexpand">Output</dt> <dd>Store the byte count of the filter's output stream in the note. </dd> <dt class="dltermexpand">Ratio</dt> <dd>Store the compression ratio (output/input * 100) in the note. This is the default, if the type argument is omitted. </dd> </dl> </li> </ul> </dd> </dl> <dl><dt class="dlterm"><strong>Parameter Two</strong>: <em>notename</em></dt> <dd><ul><li>The <em>notename</em> parameter value specifies the note name entered in the log. The <em>notename</em> value is not required to match the <em>type</em> value. Blank characters are not valid.</li> </ul> </dd> </dl> <dl><dt class="dlterm"><strong>Example</strong>: accurate logging</dt> <dd><pre>DeflateFilterNote Input instream DeflateFilterNote Output outstream DeflateFilterNote Ratio ratio LogFormat '"%r" %{outstream}n/%{instream}n (%{ratio}n%%)' deflate CustomLog logs/deflate_log deflate</pre> </dd> </dl> </blockquote> </div> </div> <div class="hr" id="deflatememlevel"><a name="deflatememlevel"><!-- --></a><h2 class="topictitle2">DeflateMemLevel</h2> <div> <div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" frame="void" border="0" rules="none"><tbody><tr><td colspan="2" valign="top"><strong><a href="rzaiedirective-dict.htm#rzaiedirective-dict__Module">Module</a></strong>: mod_deflate</td> </tr> <tr><td colspan="2" valign="top"><strong><a href="rzaiedirective-dict.htm#rzaiedirective-dict__Syntax">Syntax</a></strong>: DeflateMemLevel <em>value</em></td> </tr> <tr><td colspan="2" valign="top"><strong><a href="rzaiedirective-dict.htm#rzaiedirective-dict__Default">Default</a></strong>: DeflateMemLevel 9</td> </tr> <tr><td colspan="2" valign="top"><strong><a href="rzaiedirective-dict.htm#rzaiedirective-dict__Context">Context</a></strong>: <span id="deflatememlevel__deflatememlevel_context"><a name="deflatememlevel__deflatememlevel_context"><!-- --></a>server config, virtual host</span></td> </tr> <tr><td colspan="2" valign="top"><strong><a href="rzaiedirective-dict.htm#rzaiedirective-dict__Override">Override</a></strong>: none</td> </tr> <tr><td colspan="2" valign="top"><strong><a href="rzaiedirective-dict.htm#rzaiedirective-dict__Origin">Origin</a></strong>: <span id="deflatememlevel__deflatememlevel_origin"><a name="deflatememlevel__deflatememlevel_origin"><!-- --></a>Apache</span></td> </tr> <tr><td colspan="2" valign="top"><strong><a href="rzaiedirective-dict.htm#rzaiedirective-dict__UsageConsiderations">Usage Considerations</a></strong>: A LoadModule is required in the configuration file prior to using the directive. The statement should be as follows: deflate_module /QSYS.LIB/QHTTPSVR.LIB/QZSRCORE.SRVPGM</td> </tr> <tr><td colspan="2" valign="top"><strong><a href="rzaiedirective-dict.htm#rzaiedirective-dict__Example">Example</a></strong>: DeflateMemLevel 8</td> </tr> </tbody> </table> </div> <p>The DeflateMemLevel directive specifies how much memory should be used for zlib for compression.</p> <blockquote><dl class="dlexpand"><dt class="dltermexpand"><strong>Parameter</strong>: <em>value</em></dt> <dd><ul><li>The <em>value</em> parameter value specifies how much memory should be used for zlib compression. Each value is equal to 16K. For example, a value of 1 equates to 16K, while a value of 8 equates to 128K.</li> </ul> </dd> </dl> </blockquote> </div> </div> <div class="hr" id="deflatewindowsize"><a name="deflatewindowsize"><!-- --></a><h2 class="topictitle2">DeflateWindowSize</h2> <div> <div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" frame="void" border="0" rules="none"><tbody><tr><td colspan="2" valign="top"><strong><a href="rzaiedirective-dict.htm#rzaiedirective-dict__Module">Module</a></strong>: mod_deflate</td> </tr> <tr><td colspan="2" valign="top"><strong><a href="rzaiedirective-dict.htm#rzaiedirective-dict__Syntax">Syntax</a></strong>: DeflateWindowSize <em>value</em></td> </tr> <tr><td colspan="2" valign="top"><strong><a href="rzaiedirective-dict.htm#rzaiedirective-dict__Default">Default</a></strong>: DeflateWindowSize 15</td> </tr> <tr><td colspan="2" valign="top"><strong><a href="rzaiedirective-dict.htm#rzaiedirective-dict__Context">Context</a></strong>: <span id="deflatewindowsize__deflatewindowsize_context"><a name="deflatewindowsize__deflatewindowsize_context"><!-- --></a>server config, virtual host</span></td> </tr> <tr><td colspan="2" valign="top"><strong><a href="rzaiedirective-dict.htm#rzaiedirective-dict__Override">Override</a></strong>: none</td> </tr> <tr><td colspan="2" valign="top"><strong><a href="rzaiedirective-dict.htm#rzaiedirective-dict__Origin">Origin</a></strong>: <span id="deflatewindowsize__deflatewindowsize_origin"><a name="deflatewindowsize__deflatewindowsize_origin"><!-- --></a>Apache</span></td> </tr> <tr><td colspan="2" valign="top"><strong><a href="rzaiedirective-dict.htm#rzaiedirective-dict__UsageConsiderations">Usage Considerations</a></strong>: A LoadModule is required in the configuration file prior to using the directive. The statement should be as follows: deflate_module /QSYS.LIB/QHTTPSVR.LIB/QZSRCORE.SRVPGM</td> </tr> <tr><td colspan="2" valign="top"><strong><a href="rzaiedirective-dict.htm#rzaiedirective-dict__Example">Example</a></strong>: DeflateWindowSize 14</td> </tr> </tbody> </table> </div> <p>The DeflateWindowSize directive specifies the zlib compression window size.</p> <blockquote><dl class="dlexpand"><dt class="dltermexpand"><strong>Parameter</strong>: <em>value</em></dt> <dd><ul><li>The <em>value</em> parameter value specifies the level of compression window size. The higher the value, the greater the compression window size.<div class="note"><span class="notetitle">Note:</span> Higher compression levels require additional CPU time.</div> </li> </ul> </dd> </dl> </blockquote> </div> </div> </body> </html>