Mercurial > hg > nginx-site

comparison xml/en/docs/http/ngx_http_gunzip_module.xml @ 744:ac709e45740d

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Revision of ngx_http_gunzip_module documentation.
author Ruslan Ermilov <ru@nginx.com>
date Tue, 23 Oct 2012 14:45:14 +0000
parents 6d6aa03e43fa
children 95c3c3bbf1ce
comparison
equal deleted inserted replaced
743:7951fb38b4b3 744:ac709e45740d
8 <!DOCTYPE module SYSTEM "../../../../dtd/module.dtd"> 8 <!DOCTYPE module SYSTEM "../../../../dtd/module.dtd">
9 9
10 <module name="Module ngx_http_gunzip_module" 10 <module name="Module ngx_http_gunzip_module"
11 link="/en/docs/http/ngx_http_gunzip_module.html" 11 link="/en/docs/http/ngx_http_gunzip_module.html"
12 lang="en" 12 lang="en"
13 rev="1"> 13 rev="2">
14 14
15 <section id="summary"> 15 <section id="summary">
16 16
17 <para> 17 <para>
18 The <literal>ngx_http_gunzip_module</literal> module is a filter that 18 The <literal>ngx_http_gunzip_module</literal> module is a filter that
19 decompresses responses returned with the 19 decompresses responses with “<literal>Content-Encoding: gzip</literal>”
20 “<literal>Content-Encoding: gzip</literal>” for clients that don’t support it. 20 for clients that do not support “gzip” encoding method.
21 It may be useful if it is preferred to store the data compressed 21 The module will be useful when it is desirable to store
22 (to save space or disk/network IO), but it is undesirable 22 data compressed, to save space and reduce I/O costs.
23 to penalize clients without the gzip support.
24 </para> 23 </para>
25 24
26 <para> 25 <para>
27 This module is not built by default, it should be enabled with the 26 This module is not built by default, it should be enabled with the
28 <literal>--with-http_gunzip_module</literal> 27 <literal>--with-http_gunzip_module</literal>
54 <context>http</context> 53 <context>http</context>
55 <context>server</context> 54 <context>server</context>
56 <context>location</context> 55 <context>location</context>
57 56
58 <para> 57 <para>
59 Enables or disables decompression of gzipped responses. 58 Enables or disables decompression of gzipped responses
59 for clients that lack gzip support.
60 If enabled, the following directives are also taken into account
61 when determining if clients support gzip:
62 <link doc="ngx_http_gzip_module.xml" id="gzip_http_version"/>,
63 <link doc="ngx_http_gzip_module.xml" id="gzip_proxied"/>, and
64 <link doc="ngx_http_gzip_module.xml" id="gzip_disable"/>.
65 See also the <link doc="ngx_http_gzip_module.xml" id="gzip_vary"/> directive.
60 </para> 66 </para>
61 67
62 </directive> 68 </directive>
63 69
64 70
68 <context>http</context> 74 <context>http</context>
69 <context>server</context> 75 <context>server</context>
70 <context>location</context> 76 <context>location</context>
71 77
72 <para> 78 <para>
73 Specifies the number and size of buffers available for decompression. 79 Sets the <value>number</value> and <value>size</value> of buffers
80 used to decompress a response.
81 By default, the buffer size is equal to one memory page.
82 This is either 4K or 8K, depending on a platform.
74 </para> 83 </para>
75 84
76 </directive> 85 </directive>
77 86
78 </section> 87 </section>