]> granicus.if.org Git - apache/blob - docs/manual/mod/mod_deflate.html
initial (rough) docs for mod_deflate
[apache] / docs / manual / mod / mod_deflate.html
1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
2     "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
3
4 <html xmlns="http://www.w3.org/1999/xhtml">
5   <head>
6     <meta name="generator" content="HTML Tidy, see www.w3.org" />
7
8     <title>Apache module mod_deflate</title>
9   </head>
10   <!-- Background white, links blue (unvisited), navy (visited), red (active) -->
11
12   <body bgcolor="#FFFFFF" text="#000000" link="#0000FF"
13   vlink="#000080" alink="#FF0000">
14     <!--#include virtual="header.html" -->
15
16     <h1 align="CENTER">Module mod_deflate</h1>
17
18     <p>This module provides the ability to set environment
19     variables based upon attributes of the request.</p>
20
21     <p><a href="module-dict.html#Status"
22     rel="Help"><strong>Status:</strong></a> Experimental<br />
23      <a href="module-dict.html#SourceFile"
24     rel="Help"><strong>Source File:</strong></a>
25     mod_deflate.c<br />
26      <a href="module-dict.html#ModuleIdentifier"
27     rel="Help"><strong>Module Identifier:</strong></a>
28     deflate_module<br />
29      <a href="module-dict.html#Compatibility"
30     rel="Help"><strong>Compatibility:</strong></a> Available in
31     Apache 2.0 and later.</p>
32
33     <h2>Summary</h2>
34
35     <p>The experimental <samp>mod_deflate</samp> module allows 
36     output from your server to be compressed before being sent
37     to the client over the network.</p>
38
39     <h2>Directives</h2>
40
41     <ul>
42       <li><a href="#DeflateFilterNote">DeflateFilterNote</a></li>
43
44       <li><a href="#DeflateWindowSize">DeflateWindowSize</a></li>
45
46       <li><a href="#DeflateMemLevel">DeflateMemLevel</a></li>
47     </ul>
48     <hr />
49     <!-- the HR is part of the directive description -->
50
51     <h2><a id="DeflateFilterNote" name="DeflateFilterNote">DeflateFilterNote
52     directive</a></h2>
53
54     <p><a href="directive-dict.html#Syntax"
55     rel="Help"><strong>Syntax:</strong></a> DeflateFilterNote <em>notename
56     </em><br />
57      <a href="directive-dict.html#Default"
58     rel="Help"><strong>Default:</strong></a> <i>none</i><br />
59      <a href="directive-dict.html#Context"
60     rel="Help"><strong>Context:</strong></a> server config<br />
61      <a href="directive-dict.html#Override"
62     rel="Help"><strong>Override:</strong></a> none<br />
63      <a href="directive-dict.html#Status"
64     rel="Help"><strong>Status:</strong></a> Experimental<br />
65      <a href="directive-dict.html#Module"
66     rel="Help"><strong>Module:</strong></a> mod_deflate<br />
67      <a href="directive-dict.html#Compatibility"
68     rel="Help"><strong>Compatibility:</strong></a> Apache 2.0 and
69     above</p>
70
71     <p>The DeflateFilterNote directive specifies that a note about
72     compression ratios should be attached to the request.  The name
73     of the note is the value specified for the directive.</p>
74
75     <hr />
76     <!-- the HR is part of the directive description -->
77
78     <h2><a id="DeflateWindowSize"
79     name="DeflateWindowSize">DeflateWindowSize directive</a></h2>
80
81     <p><a href="directive-dict.html#Syntax"
82     rel="Help"><strong>Syntax:</strong></a> DeflateWindowSize
83     <em>value</em><br />
84      <a href="directive-dict.html#Default"
85     rel="Help"><strong>Default:</strong></a> <em>none</em><br />
86      <a href="directive-dict.html#Context"
87     rel="Help"><strong>Context:</strong></a> server config<br />
88      <a href="directive-dict.html#Override"
89     rel="Help"><strong>Override:</strong></a> none<br />
90      <a href="directive-dict.html#Status"
91     rel="Help"><strong>Status:</strong></a> Experimental<br />
92      <a href="directive-dict.html#Module"
93     rel="Help"><strong>Module:</strong></a> mod_deflate<br />
94      <a href="directive-dict.html#Compatibility"
95     rel="Help"><strong>Compatibility:</strong></a> Apache 2.0 and
96     above</p>
97
98     <p>The <samp>DeflateWindowSize</samp> directive specifies the
99     zlib compression window size.</p>
100
101     <hr />
102     <!-- the HR is part of the directive description -->
103
104     <h2><a id="DeflateMemLevel" name="DeflateMemLevel">DeflateMemLevel
105     directive</a></h2>
106
107     <p><a href="directive-dict.html#Syntax"
108     rel="Help"><strong>Syntax:</strong></a> DeflateMemLevel
109     <em>value</em><br />
110      <a href="directive-dict.html#Default"
111     rel="Help"><strong>Default:</strong></a> <em>none</em><br />
112      <a href="directive-dict.html#Context"
113     rel="Help"><strong>Context:</strong></a> server config<br />
114      <a href="directive-dict.html#Override"
115     rel="Help"><strong>Override:</strong></a> none<br />
116      <a href="directive-dict.html#Status"
117     rel="Help"><strong>Status:</strong></a> Experimental<br />
118      <a href="directive-dict.html#Module"
119     rel="Help"><strong>Module:</strong></a> mod_deflate<br />
120      <a href="directive-dict.html#Compatibility"
121     rel="Help"><strong>Compatibility:</strong></a> Apache 2.0 and
122     above</p>
123
124     <p>The DeflateMemLevel directive specifies the amount of
125     memory available to zlib for compression.</p>
126     <!--#include virtual="footer.html" -->
127   </body>
128 </html>
129