Mercurial > hg > nginx-site
comparison xml/en/docs/http/ngx_http_gunzip_module.xml @ 676:6d6aa03e43fa
Actually added gunzip module documentation files.
author | Vladimir Homutov <vl@nginx.com> |
---|---|
date | Wed, 12 Sep 2012 09:36:37 +0000 |
parents | |
children | ac709e45740d |
comparison
equal
deleted
inserted
replaced
675:08140f6b7964 | 676:6d6aa03e43fa |
---|---|
1 <?xml version="1.0"?> | |
2 | |
3 <!-- | |
4 Copyright (C) Maxim Dounin | |
5 Copyright (C) Nginx, Inc. | |
6 --> | |
7 | |
8 <!DOCTYPE module SYSTEM "../../../../dtd/module.dtd"> | |
9 | |
10 <module name="Module ngx_http_gunzip_module" | |
11 link="/en/docs/http/ngx_http_gunzip_module.html" | |
12 lang="en" | |
13 rev="1"> | |
14 | |
15 <section id="summary"> | |
16 | |
17 <para> | |
18 The <literal>ngx_http_gunzip_module</literal> module is a filter that | |
19 decompresses responses returned with the | |
20 “<literal>Content-Encoding: gzip</literal>” for clients that don’t support it. | |
21 It may be useful if it is preferred to store the data compressed | |
22 (to save space or disk/network IO), but it is undesirable | |
23 to penalize clients without the gzip support. | |
24 </para> | |
25 | |
26 <para> | |
27 This module is not built by default, it should be enabled with the | |
28 <literal>--with-http_gunzip_module</literal> | |
29 configuration parameter. | |
30 </para> | |
31 | |
32 </section> | |
33 | |
34 | |
35 <section id="example" name="Example Configuration"> | |
36 | |
37 <para> | |
38 <example> | |
39 location /storage/ { | |
40 gunzip on; | |
41 ... | |
42 } | |
43 </example> | |
44 </para> | |
45 | |
46 </section> | |
47 | |
48 | |
49 <section id="directives" name="Directives"> | |
50 | |
51 <directive name="gunzip"> | |
52 <syntax><literal>on</literal> | <literal>off</literal></syntax> | |
53 <default>off</default> | |
54 <context>http</context> | |
55 <context>server</context> | |
56 <context>location</context> | |
57 | |
58 <para> | |
59 Enables or disables decompression of gzipped responses. | |
60 </para> | |
61 | |
62 </directive> | |
63 | |
64 | |
65 <directive name="gunzip_buffers"> | |
66 <syntax><value>number</value> <value>size</value></syntax> | |
67 <default>32 4k|16 8k</default> | |
68 <context>http</context> | |
69 <context>server</context> | |
70 <context>location</context> | |
71 | |
72 <para> | |
73 Specifies the number and size of buffers available for decompression. | |
74 </para> | |
75 | |
76 </directive> | |
77 | |
78 </section> | |
79 | |
80 </module> |