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