comparison xml/ru/docs/http/ngx_http_headers_module.xml @ 76:4a4caa566120

Russian documentation import. Changes in module.dtd: <example> now allowed to contain <value> and <emphasis> elements (we need this to show important parts in examples), less strict checking of <directive> syntax (we don't want to fully document some directives, notably deprecated ones). Known issues: 1. <syntax> elements are preserved as is, they will require manual conversion (likely to some not-yet-existed format a la DocBook cmdsynopsis, as currently used one seems to be incomplete); 2. <value> no longer corresponds to replaceable content, and it's use in examples isn't correct; 3. <link doc="document#fragment"> doesn't work with current xslt, either should be supported or changed to <link doc="document" id="fragment">. The following files are intentionally omitted: maillists.xml (support.xml should be used instead), experimental.xml (obsolete), faq.xml (conflicts with existing one, needs discussion). Not yet linked to site.
author Maxim Dounin <mdounin@mdounin.ru>
date Tue, 11 Oct 2011 12:57:50 +0000
parents
children 1d315ef37215
comparison
equal deleted inserted replaced
75:2bf4cd2787c5 76:4a4caa566120
1 <?xml version="1.0" encoding="utf-8"?>
2
3 <!DOCTYPE module SYSTEM "../../../../dtd/module.dtd">
4
5 <module name="Директивы модуля ngx_http_headers_module"
6 link="/ru/docs/http/ngx_http_headers_module.html"
7 lang="ru">
8
9 <section name="" id="summary">
10
11 <para>
12 Модуль ngx_http_headers_module позволяет выдавать строки "Expires"
13 и "Cache-Control" и добавлять произвольные строки в заголовке ответа.
14 </para>
15
16 </section>
17
18 <section name="Примеры конфигурации" id="example">
19
20 <para>
21 <example>
22 expires 24h;
23 expires modified +24h;
24 expires @24h;
25 expires 0;
26 expires -1;
27 expires epoch;
28 add_header Cache-Control private;
29 </example>
30 </para>
31
32 </section>
33
34
35 <section name="Директивы" id="directives">
36
37 <directive name="add_header">
38 <syntax>add_header <value>название значение</value></syntax>
39 <default>нет</default>
40 <context>http, server, location</context>
41
42 <para>
43 Директива добавляет строку в заголовке ответа при условии, что код ответа
44 равен 200, 204, 301, 302 или 304.
45 В значении можно использовать переменные.
46 </para>
47
48 </directive>
49
50
51 <directive name="expires">
52 <syntax>expires <value>[modified]</value> <value>[время|epoch|max|off]</value></syntax>
53 <default>expires off</default>
54 <context>http, server, location</context>
55
56 <para>
57 Разрешает или запрещает добавлять или менять строки "Expires"
58 и "Cache-Control" в заголовке ответа.
59 В качестве параметра можно задать положительное или отрицательное
60 <link doc="../syntax.xml">время</link>.
61 </para>
62
63 <para>
64 Время в строке "Expires" получается как сумма текущего времени
65 и времени, заданного в директиве.
66 Если используется параметр "modified" (0.7.0, 0.6.32),
67 то время получается как сумма
68 времени модификации файла и времени, заданного в директиве.
69 </para>
70
71 <para>
72 Кроме того, с помощью префикса "@" можно задать время суток (0.7.9, 0.6.34):
73 <example>
74 expires @15h30m;
75 </example>
76 </para>
77
78 <para>
79 Параметр "epoch" означает абсолютное время 1 января 1970 года 00:00:01 GMT.
80 Содержимое строки "Cache-Control" зависит от знака заданного времени:
81 <list type="bullet">
82
83 <listitem>
84 отрицательное время — "Cache-Control: no-cache".
85 </listitem>
86
87 <listitem>
88 положительное время или равное нулю — "Cache-Control: max-age=#",
89 где "#" - это время в секундах, заданное в директиве.
90 </listitem>
91
92 </list>
93 </para>
94
95 <para>
96 Параметр "max" задаёт время 31 декабря 2037 23:55:55 GMT для строки "Expires"
97 и 10 лет для строки "Cache-Control".
98 </para>
99
100 <para>
101 Параметр "off" запрещает добавлять или менять строки "Expires"
102 и "Cache-Control" в заголовке ответа.
103 </para>
104
105 </directive>
106
107 </section>
108
109 </module>