changeset 744:ac709e45740d

Revision of ngx_http_gunzip_module documentation.
author Ruslan Ermilov <ru@nginx.com>
date Tue, 23 Oct 2012 14:45:14 +0000
parents 7951fb38b4b3
children d61128d5ecfc
files xml/en/docs/http/ngx_http_gunzip_module.xml xml/en/docs/http/ngx_http_gzip_module.xml xml/ru/docs/http/ngx_http_gunzip_module.xml xml/ru/docs/http/ngx_http_gzip_module.xml
diffstat 4 files changed, 44 insertions(+), 27 deletions(-) [+]
line wrap: on
line diff
--- a/xml/en/docs/http/ngx_http_gunzip_module.xml	Tue Oct 23 13:05:11 2012 +0000
+++ b/xml/en/docs/http/ngx_http_gunzip_module.xml	Tue Oct 23 14:45:14 2012 +0000
@@ -10,17 +10,16 @@
 <module name="Module ngx_http_gunzip_module"
         link="/en/docs/http/ngx_http_gunzip_module.html"
         lang="en"
-        rev="1">
+        rev="2">
 
 <section id="summary">
 
 <para>
 The <literal>ngx_http_gunzip_module</literal> module is a filter that
-decompresses responses returned with the
-“<literal>Content-Encoding: gzip</literal>” for clients that don’t support it.
-It may be useful if it is preferred to store the data compressed
-(to save space or disk/network IO), but it is undesirable
-to penalize clients without the gzip support.
+decompresses responses with “<literal>Content-Encoding: gzip</literal>”
+for clients that do not support “gzip” encoding method.
+The module will be useful when it is desirable to store
+data compressed, to save space and reduce I/O costs.
 </para>
 
 <para>
@@ -56,7 +55,14 @@
 <context>location</context>
 
 <para>
-Enables or disables decompression of gzipped responses.
+Enables or disables decompression of gzipped responses
+for clients that lack gzip support.
+If enabled, the following directives are also taken into account
+when determining if clients support gzip:
+<link doc="ngx_http_gzip_module.xml" id="gzip_http_version"/>,
+<link doc="ngx_http_gzip_module.xml" id="gzip_proxied"/>, and
+<link doc="ngx_http_gzip_module.xml" id="gzip_disable"/>.
+See also the <link doc="ngx_http_gzip_module.xml" id="gzip_vary"/> directive.
 </para>
 
 </directive>
@@ -70,7 +76,10 @@
 <context>location</context>
 
 <para>
-Specifies the number and size of buffers available for decompression.
+Sets the <value>number</value> and <value>size</value> of buffers
+used to decompress a response.
+By default, the buffer size is equal to one memory page.
+This is either 4K or 8K, depending on a platform.
 </para>
 
 </directive>
--- a/xml/en/docs/http/ngx_http_gzip_module.xml	Tue Oct 23 13:05:11 2012 +0000
+++ b/xml/en/docs/http/ngx_http_gzip_module.xml	Tue Oct 23 14:45:14 2012 +0000
@@ -10,7 +10,7 @@
 <module name="Module ngx_http_gzip_module"
         link="/en/docs/http/ngx_http_gzip_module.html"
         lang="en"
-        rev="1">
+        rev="2">
 
 <section id="summary">
 
@@ -261,8 +261,9 @@
 <para>
 Enables or disables emitting the <header>Vary: Accept-Encoding</header>
 response header field if the directives
-<link id="gzip"/> or
-<link doc="ngx_http_gzip_static_module.xml" id="gzip_static"/>
+<link id="gzip"/>,
+<link doc="ngx_http_gzip_static_module.xml" id="gzip_static"/>, or
+<link doc="ngx_http_gunzip_module.xml" id="gunzip"/>
 are active.
 </para>
 
--- a/xml/ru/docs/http/ngx_http_gunzip_module.xml	Tue Oct 23 13:05:11 2012 +0000
+++ b/xml/ru/docs/http/ngx_http_gunzip_module.xml	Tue Oct 23 14:45:14 2012 +0000
@@ -10,18 +10,16 @@
 <module name="Модуль ngx_http_gunzip_module"
         link="/ru/docs/http/ngx_http_gunzip_module.html"
         lang="ru"
-        rev="1">
+        rev="2">
 
 <section id="summary">
 
 <para>
-Модуль <literal>ngx_http_gunzip_module</literal> это фильтр, распаковывающий
-ответы, возвращаемые с “<literal>Content-Encoding: gzip</literal>”,
-для тех клиентов, которые не поддерживают данный метод.
-Это может быть полезно, если предпочтительно хранить данные сжатыми
-(чтобы сэкономить пространство или дисковые/сетевые операции
-ввода/вывода), но при этом нежелательно причинять неудобства клиентам,
-которые не поддерживают сжатие методом gzip.
+Модуль <literal>ngx_http_gunzip_module</literal> — это фильтр,
+распаковывающий ответы с “<literal>Content-Encoding: gzip</literal>”
+для тех клиентов, которые не поддерживают метод сжатия “gzip”.
+Модуль будет полезен, когда данные желательно хранить сжатыми
+для экономии места и сокращения затрат на ввод-вывод.
 </para>
 
 <para>
@@ -57,8 +55,14 @@
 <context>location</context>
 
 <para>
-Разрешает или запрещает распаковку ответов, сжатых методом
-<literal>“gzip”</literal>.
+Разрешает или запрещает распаковку ответов, сжатых методом gzip,
+для тех клиентов, которые его не поддерживают.
+Если разрешено, то для определения, поддерживает ли клиент gzip,
+также учитываются следующие директивы:
+<link doc="ngx_http_gzip_module.xml" id="gzip_http_version"/>,
+<link doc="ngx_http_gzip_module.xml" id="gzip_proxied"/> и
+<link doc="ngx_http_gzip_module.xml" id="gzip_disable"/>.
+См. также директиву <link doc="ngx_http_gzip_module.xml" id="gzip_vary"/>.
 </para>
 
 </directive>
@@ -72,7 +76,10 @@
 <context>location</context>
 
 <para>
-Задаёт число и размер буферов, доступных для распаковки.
+Задаёт <value>число</value> и <value>размер</value> буферов,
+в которые будет разжиматься ответ.
+По умолчанию размер одного буфера равен размеру страницы.
+В зависимости от платформы это или 4K, или 8K.
 </para>
 
 </directive>
--- a/xml/ru/docs/http/ngx_http_gzip_module.xml	Tue Oct 23 13:05:11 2012 +0000
+++ b/xml/ru/docs/http/ngx_http_gzip_module.xml	Tue Oct 23 14:45:14 2012 +0000
@@ -10,7 +10,7 @@
 <module name="Модуль ngx_http_gzip_module"
         link="/ru/docs/http/ngx_http_gzip_module.html"
         lang="ru"
-        rev="1">
+        rev="2">
 
 <section id="summary">
 
@@ -260,10 +260,10 @@
 
 <para>
 Разрешает или запрещает выдавать в ответе поле заголовка
-<header>Vary: Accept-Encoding</header>, если директивы
-<link id="gzip"/> или
-<link doc="ngx_http_gzip_static_module.xml" id="gzip_static"/>
-активны.
+<header>Vary: Accept-Encoding</header>, если активны директивы
+<link id="gzip"/>,
+<link doc="ngx_http_gzip_static_module.xml" id="gzip_static"/> или
+<link doc="ngx_http_gunzip_module.xml" id="gunzip"/>.
 </para>
 
 </directive>