Mercurial > hg > nginx-site

comparison xml/ru/docs/ngx_core_module.xml @ 76:4a4caa566120

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
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 0a45870d0160
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="Глобальные директивы"
6 link="/ru/docs/ngx_core_module.html"
7 lang="ru">
8
9
10 <section name="Пример конфигурации" id="example">
11
12 <para>
13 <example>
14
15 user www www;
16 worker_processes 2;
17
18 error_log /var/log/nginx-error.log info;
19
20 events {
21 use kqueue;
22 worker_connections 2048;
23 }
24
25 ...
26 </example>
27 </para>
28
29 </section>
30
31
32 <section name="Директивы" id="directives">
33
34 <directive name="daemon">
35 <syntax>daemon <value>on|off</value></syntax>
36 <default>daemon on</default>
37 <context>main</context>
38
39 <para>
40 Директива определяет, будет ли nginx запускаться в режиме демона.
41 Используется в основном для разработки.
42 </para>
43
44 </directive>
45
46
47 <directive name="env">
48 <syntax>env <value>VAR|VAR=VALUE</value></syntax>
49 <default>env TZ</default>
50 <context>main</context>
51
52 <para>
53 Директива позволяет ограничить набор переменных среды, поменять им значения
54 или же создать новые переменные для следующих случаев:
55 <list type="bullet">
56
57 <listitem>
58 наследование переменных во время <link doc="../control.xml#upgrade">обновления исполняемого файла
59 на лету</link>;
60 </listitem>
61
62 <listitem>
63 использование переменных модулем <link doc="ngx_http_perl_module.xml">ngx_http_perl_module</link>;
64 </listitem>
65
66 <listitem>
67 использование переменных рабочими процессами.
68 Однако нужно иметь в виду, что управление поведением системных библиотек
69 подобным образом возможно не всегда, поскольку зачастую библиотеки используют
70 переменные только во время инициализации, то есть ещё до того, как их
71 можно задать с помощью данной директивы.
72 Исключением из этого является вышеописанное обновление исполняемого файла
73 на лету.
74 </listitem>
75
76 </list>
77 </para>
78
79 <para>
80 Если переменная TZ не описана явно, то она всегда наследуется
81 и всегда доступна модулю ngx_http_perl_module.
82 </para>
83
84 <para>
85 Пример использования:
86 <example>
87 env MALLOC_OPTIONS;
88 env PERL5LIB=/data/site/modules;
89 env OPENSSL_ALLOW_PROXY_CERTS=1;
90 </example>
91 </para>
92
93 </directive>
94
95
96 <directive name="include">
97 <syntax>include <value>файл|маска</value></syntax>
98 <default>нет</default>
99 <context>везде</context>
100
101 <para>
102 Директива позволяет включить в конфигурацию другой файл.
103 Файл должен содержать синтаксически законченные директивы и блоки.
104 </para>
105
106 <para>
107 Пример использования:
108 <example>
109 include mime.types;
110 include vhosts/*.conf;
111 </example>
112 </para>
113
114 </directive>
115
116
117 <directive name="master_process">
118 <syntax>master_process <value>on|off</value></syntax>
119 <default>master_process on</default>
120 <context>main</context>
121
122 <para>
123 Директива определяет, будут ли запускаться рабочие процессы.
124 Используется только для разработки.
125 </para>
126
127 </directive>
128
129
130 <directive name="pid">
131 <syntax>pid <value>файл</value></syntax>
132 <default>pid nginx.pid</default>
133 <context>main</context>
134
135 <para>
136 Директива задаёт файл, в котором хранится номер основго процесса.
137 </para>
138
139 </directive>
140
141
142 <directive name="ssl_engine">
143 <syntax>ssl_engine <value>устройство</value></syntax>
144 <default>нет</default>
145 <context>main</context>
146
147 <para>
148 Директива задаёт название аппартного SSL-акселератора.
149 </para>
150
151 </directive>
152
153
154 <directive name="user">
155 <syntax>user <value>пользователь [группа]</value></syntax>
156 <default>user nobody nobody</default>
157 <context>main</context>
158
159 <para>
160 Директива задаёт пользователя и группу, с правами которого будут работать
161 рабочие процессы. Если группа не задана, то используется группа, имя
162 которой совпадает с именем пользователя.
163 </para>
164
165 </directive>
166
167
168 <directive name="timer_resolution">
169 <syntax>timer_resolution <value>время</value></syntax>
170 <default>нет</default>
171 <context>main</context>
172
173 <para>
174 Директива уменьшает разрешение времени в рабочих процессах, за счёт
175 чего уменьшается число системных вызовов gettimeofday().
176 По умолчанию gettimeofday() вызывается после каждой операции получения
177 событий из ядра.
178 C уменьшенным разрешением gettimeofday() вызывается только
179 один раз за указанный интервал.
180 </para>
181
182 <para>
183 Пример использования:
184 <example>
185 timer_resolution 100ms;
186 </example>
187 </para>
188
189 <para>
190 Внутренняя реализация интервала зависит от используемого метода:
191 <list type="bullet">
192
193 <listitem>
194 фильтр EVFILT_TIMER при использовании kqueue;
195 </listitem>
196
197 <listitem>
198 timer_create() при использовании eventport;
199 </listitem>
200
201 <listitem>
202 и setitimer() во всех остальных случаяx.
203 </listitem>
204
205 </list>
206 </para>
207
208 </directive>
209
210
211 <directive name="worker_rlimit_core">
212 <syntax>worker_rlimit_core <value>размер</value></syntax>
213 <default>нет</default>
214 <context>main</context>
215
216 <para>
217 Директива изменяет ограничение на размер core-файла RLIMIT_CORE
218 для рабочего процесса.
219 Используется для увеличения ограничения без перезапуска основного процесса.
220 </para>
221
222 </directive>
223
224
225 <directive name="worker_rlimit_nofile">
226 <syntax>worker_rlimit_nofile <value>число</value></syntax>
227 <default>нет</default>
228 <context>main</context>
229
230 <para>
231 Директива изменяет ограничение на число используемых файлов RLIMIT_NOFILE
232 для рабочего процесса.
233 Используется для увеличения ограничения без перезапуска основного процесса.
234 </para>
235
236 </directive>
237
238
239 <directive name="worker_priority">
240 <syntax>worker_priority <value>число</value></syntax>
241 <default>worker_priority 0</default>
242 <context>main</context>
243
244 <para>
245 Директива задаёт приоритет рабочих процессов подобно тому,
246 как это делается командой <command>nice</command>:
247 отрицательное число означает более высокий приоритет.
248 Диапазон возможных значений, как правило, от -20 до 20.
249 </para>
250
251 <para>
252 Пример использования:
253 <example>
254 worker_priority -10;
255 </example>
256 </para>
257
258 </directive>
259
260
261 <directive name="worker_processes">
262 <syntax>worker_processes <value>число</value></syntax>
263 <default>worker_processes 1</default>
264 <context>main</context>
265
266 <para>
267 Директива задаёт число рабочих процессов.
268 </para>
269
270 </directive>
271
272
273 <directive name="working_directory">
274 <syntax>working_directory <value>путь</value></syntax>
275 <default>нет</default>
276 <context>main</context>
277
278 <para>
279 Директива задаёт каталог, который будет текущим для рабочего процесса.
280 Основное применение — запись core-файла, в этом случае рабочий
281 процесс должен иметь права на запись в этот каталог.
282 </para>
283
284 </directive>
285
286 </section>
287
288 </module>