comparison xml/ru/docs/ngx_core_module.xml @ 271:4c6d2c614d2c

Cleaned up XML tag mess: - all of <parameter> and <code>, and some of <dirname>, <value>, and <command> were replaced by <literal>; - the rest of <dirname> were replaced by links; - <argument> were replaced by <value>; - <value> is now rendered in HTML in italic; - <literal> and <path> can now contain <value>. Cleaned up terminology mess: - directives take "parameters".
author Ruslan Ermilov <ru@nginx.com>
date Fri, 23 Dec 2011 17:29:59 +0000
parents 945d7299c26c
children df261b1ce71f
comparison
equal deleted inserted replaced
270:945d7299c26c 271:4c6d2c614d2c
28 28
29 29
30 <section id="directives" name="Директивы"> 30 <section id="directives" name="Директивы">
31 31
32 <directive name="daemon"> 32 <directive name="daemon">
33 <syntax><value>on</value> | <value>off</value></syntax> 33 <syntax><literal>on</literal> | <literal>off</literal></syntax>
34 <default>on</default> 34 <default>on</default>
35 <context>main</context> 35 <context>main</context>
36 36
37 <para> 37 <para>
38 Определяет, будет ли nginx запускаться в режиме демона. 38 Определяет, будет ли nginx запускаться в режиме демона.
42 </directive> 42 </directive>
43 43
44 44
45 <directive name="error_log"> 45 <directive name="error_log">
46 <syntax> 46 <syntax>
47 <argument>файл</argument> 47 <value>файл</value>
48 [<value>debug</value> | 48 [<literal>debug</literal> |
49 <value>info</value> | 49 <literal>info</literal> |
50 <value>notice</value> | 50 <literal>notice</literal> |
51 <value>warn</value> | 51 <literal>warn</literal> |
52 <value>error</value> | 52 <literal>error</literal> |
53 <value>crit</value> | 53 <literal>crit</literal> |
54 <value>alert</value> | 54 <literal>alert</literal> |
55 <value>emerg</value>]</syntax> 55 <literal>emerg</literal>]</syntax>
56 <default>logs/error.log error</default> 56 <default>logs/error.log error</default>
57 <context>main</context> 57 <context>main</context>
58 <context>http</context> 58 <context>http</context>
59 <context>server</context> 59 <context>server</context>
60 <context>location</context> 60 <context>location</context>
62 <para> 62 <para>
63 Конфигурирует запись в лог. 63 Конфигурирует запись в лог.
64 </para> 64 </para>
65 65
66 <para> 66 <para>
67 Первый аргумент задаёт файл, который будет хранить лог. 67 Первый параметр задаёт файл, который будет хранить лог.
68 <!-- 68 <!--
69 Если имя файла не абсолютное, к нему добавляется в начало путь префикса. 69 Если имя файла не абсолютное, к нему добавляется в начало путь префикса.
70 --> 70 -->
71 </para> 71 </para>
72 72
73 <para> 73 <para>
74 Второй аргумент определяет уровень лога. 74 Второй параметр определяет уровень лога.
75 Уровни лога, указанные выше, перечислены в порядке возрастания их серьёзности. 75 Уровни лога, указанные выше, перечислены в порядке возрастания их серьёзности.
76 При установке определённого уровня в лог попадают все сообщения 76 При установке определённого уровня в лог попадают все сообщения
77 указанного и более серьёзных уровней. 77 указанного и более серьёзных уровней.
78 Например, при стандартном уровне <value>error</value> в лог попадают 78 Например, при стандартном уровне <literal>error</literal> в лог попадают
79 сообщения уровней <value>error</value>, <value>crit</value>, 79 сообщения уровней <literal>error</literal>, <literal>crit</literal>,
80 <value>alert</value> и <value>emerg</value>. 80 <literal>alert</literal> и <literal>emerg</literal>.
81 81
82 <note> 82 <note>
83 Для работы уровня лога <value>debug</value> необходимо сконфигурировать 83 Для работы уровня лога <literal>debug</literal> необходимо сконфигурировать
84 nginx с <code>--with-debug</code>. 84 nginx с <literal>--with-debug</literal>.
85 </note> 85 </note>
86 </para> 86 </para>
87 87
88 </directive> 88 </directive>
89 89
90 90
91 <directive name="env"> 91 <directive name="env">
92 <syntax><argument>переменная</argument>[=<argument>значение</argument>]</syntax> 92 <syntax><value>переменная</value>[=<value>значение</value>]</syntax>
93 <default>TZ</default> 93 <default>TZ</default>
94 <context>main</context> 94 <context>main</context>
95 95
96 <para> 96 <para>
97 Позволяет ограничить набор переменных окружения, поменять им значения 97 Позволяет ограничить набор переменных окружения, поменять им значения
138 138
139 </directive> 139 </directive>
140 140
141 141
142 <directive name="include"> 142 <directive name="include">
143 <syntax><argument>файл</argument> | <argument>маска</argument></syntax> 143 <syntax><value>файл</value> | <value>маска</value></syntax>
144 <default/> 144 <default/>
145 <context/> 145 <context/>
146 146
147 <para> 147 <para>
148 Включает в конфигурацию другой <argument>файл</argument> или файлы, 148 Включает в конфигурацию другой <value>файл</value> или файлы,
149 подходящие под заданную маску. 149 подходящие под заданную маску.
150 Включаемые файлы должны содержать синтаксически верные директивы и блоки. 150 Включаемые файлы должны содержать синтаксически верные директивы и блоки.
151 </para> 151 </para>
152 152
153 <para> 153 <para>
160 160
161 </directive> 161 </directive>
162 162
163 163
164 <directive name="master_process"> 164 <directive name="master_process">
165 <syntax><value>on</value> | <value>off</value></syntax> 165 <syntax><literal>on</literal> | <literal>off</literal></syntax>
166 <default>on</default> 166 <default>on</default>
167 <context>main</context> 167 <context>main</context>
168 168
169 <para> 169 <para>
170 Определяет, будут ли запускаться рабочие процессы. 170 Определяет, будут ли запускаться рабочие процессы.
173 173
174 </directive> 174 </directive>
175 175
176 176
177 <directive name="pid"> 177 <directive name="pid">
178 <syntax><argument>файл</argument></syntax> 178 <syntax><value>файл</value></syntax>
179 <default>nginx.pid</default> 179 <default>nginx.pid</default>
180 <context>main</context> 180 <context>main</context>
181 181
182 <para> 182 <para>
183 Задаёт <argument>файл</argument>, в котором хранится номер (PID) основного процесса. 183 Задаёт <value>файл</value>, в котором будет храниться номер (PID) основного процесса.
184 </para> 184 </para>
185 185
186 </directive> 186 </directive>
187 187
188 188
189 <directive name="ssl_engine"> 189 <directive name="ssl_engine">
190 <syntax><argument>устройство</argument></syntax> 190 <syntax><value>устройство</value></syntax>
191 <default/> 191 <default/>
192 <context>main</context> 192 <context>main</context>
193 193
194 <para> 194 <para>
195 Задаёт название аппаратного SSL-акселератора. 195 Задаёт название аппаратного SSL-акселератора.
197 197
198 </directive> 198 </directive>
199 199
200 200
201 <directive name="timer_resolution"> 201 <directive name="timer_resolution">
202 <syntax><argument>интервал</argument></syntax> 202 <syntax><value>интервал</value></syntax>
203 <default/> 203 <default/>
204 <context>main</context> 204 <context>main</context>
205 205
206 <para> 206 <para>
207 Уменьшает разрешение таймеров времени в рабочих процессах, за счёт 207 Уменьшает разрешение таймеров времени в рабочих процессах, за счёт
208 чего уменьшается число системных вызовов <c-func>gettimeofday</c-func>. 208 чего уменьшается число системных вызовов <c-func>gettimeofday</c-func>.
209 По умолчанию <c-func>gettimeofday</c-func> вызывается после каждой 209 По умолчанию <c-func>gettimeofday</c-func> вызывается после каждой
210 операции получения событий из ядра. 210 операции получения событий из ядра.
211 C уменьшенным разрешением <c-func>gettimeofday</c-func> вызывается только 211 C уменьшенным разрешением <c-func>gettimeofday</c-func> вызывается только
212 один раз за указанный <argument>интервал</argument>. 212 один раз за указанный <value>интервал</value>.
213 </para> 213 </para>
214 214
215 <para> 215 <para>
216 Пример использования: 216 Пример использования:
217 <example> 217 <example>
222 <para> 222 <para>
223 Внутренняя реализация интервала зависит от используемого метода: 223 Внутренняя реализация интервала зависит от используемого метода:
224 <list type="bullet"> 224 <list type="bullet">
225 225
226 <listitem> 226 <listitem>
227 фильтр <c-def>EVFILT_TIMER</c-def> при использовании <value>kqueue</value>; 227 фильтр <c-def>EVFILT_TIMER</c-def> при использовании <literal>kqueue</literal>;
228 </listitem> 228 </listitem>
229 229
230 <listitem> 230 <listitem>
231 <c-func>timer_create</c-func> при использовании <value>eventport</value>; 231 <c-func>timer_create</c-func> при использовании <literal>eventport</literal>;
232 </listitem> 232 </listitem>
233 233
234 <listitem> 234 <listitem>
235 и <c-func>setitimer</c-func> во всех остальных случаях. 235 и <c-func>setitimer</c-func> во всех остальных случаях.
236 </listitem> 236 </listitem>
240 240
241 </directive> 241 </directive>
242 242
243 243
244 <directive name="user"> 244 <directive name="user">
245 <syntax><argument>пользователь</argument> [<argument>группа</argument>]</syntax> 245 <syntax><value>пользователь</value> [<value>группа</value>]</syntax>
246 <default>nobody nobody</default> 246 <default>nobody nobody</default>
247 <context>main</context> 247 <context>main</context>
248 248
249 <para> 249 <para>
250 Задаёт пользователя и группу, с правами которого будут работать 250 Задаёт пользователя и группу, с правами которого будут работать
251 рабочие процессы. 251 рабочие процессы.
252 Если <argument>группа</argument> не задана, то используется группа, имя 252 Если <value>группа</value> не задана, то используется группа, имя
253 которой совпадает с именем пользователя. 253 которой совпадает с именем пользователя.
254 </para> 254 </para>
255 255
256 </directive> 256 </directive>
257 257
258 258
259 <directive name="worker_priority"> 259 <directive name="worker_priority">
260 <syntax><argument>число</argument></syntax> 260 <syntax><value>число</value></syntax>
261 <default>0</default> 261 <default>0</default>
262 <context>main</context> 262 <context>main</context>
263 263
264 <para> 264 <para>
265 Задаёт приоритет планирования рабочих процессов подобно тому, 265 Задаёт приоритет планирования рабочих процессов подобно тому,
266 как это делается командой <command>nice</command>: отрицательное 266 как это делается командой <command>nice</command>: отрицательное
267 <argument>число</argument> 267 <value>число</value>
268 означает более высокий приоритет. 268 означает более высокий приоритет.
269 Диапазон возможных значений, как правило, варьируется от -20 до 20. 269 Диапазон возможных значений, как правило, варьируется от -20 до 20.
270 </para> 270 </para>
271 271
272 <para> 272 <para>
278 278
279 </directive> 279 </directive>
280 280
281 281
282 <directive name="worker_processes"> 282 <directive name="worker_processes">
283 <syntax><argument>число</argument></syntax> 283 <syntax><value>число</value></syntax>
284 <default>1</default> 284 <default>1</default>
285 <context>main</context> 285 <context>main</context>
286 286
287 <para> 287 <para>
288 Задаёт число рабочих процессов. 288 Задаёт число рабочих процессов.
298 298
299 </directive> 299 </directive>
300 300
301 301
302 <directive name="worker_rlimit_core"> 302 <directive name="worker_rlimit_core">
303 <syntax><argument>размер</argument></syntax> 303 <syntax><value>размер</value></syntax>
304 <default/> 304 <default/>
305 <context>main</context> 305 <context>main</context>
306 306
307 <para> 307 <para>
308 Изменяет ограничение на наибольший размер core-файла 308 Изменяет ограничение на наибольший размер core-файла
312 312
313 </directive> 313 </directive>
314 314
315 315
316 <directive name="worker_rlimit_nofile"> 316 <directive name="worker_rlimit_nofile">
317 <syntax><argument>число</argument></syntax> 317 <syntax><value>число</value></syntax>
318 <default/> 318 <default/>
319 <context>main</context> 319 <context>main</context>
320 320
321 <para> 321 <para>
322 Изменяет ограничение на максимальное число открытых файлов 322 Изменяет ограничение на максимальное число открытых файлов
326 326
327 </directive> 327 </directive>
328 328
329 329
330 <directive name="working_directory"> 330 <directive name="working_directory">
331 <syntax><argument>каталог</argument></syntax> 331 <syntax><value>каталог</value></syntax>
332 <default/> 332 <default/>
333 <context>main</context> 333 <context>main</context>
334 334
335 <para> 335 <para>
336 Задаёт каталог, который будет текущим для рабочего процесса. 336 Задаёт каталог, который будет текущим для рабочего процесса.