Mercurial > hg > nginx-site
comparison xml/en/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="Directives"> | 30 <section id="directives" name="Directives"> |
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 Determines whether nginx should become a daemon. | 38 Determines whether nginx should become a daemon. |
42 </directive> | 42 </directive> |
43 | 43 |
44 | 44 |
45 <directive name="error_log"> | 45 <directive name="error_log"> |
46 <syntax> | 46 <syntax> |
47 <argument>file</argument> | 47 <value>file</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 Configures logging. | 63 Configures logging. |
64 </para> | 64 </para> |
65 | 65 |
66 <para> | 66 <para> |
67 The first argument defines a file that will store the log. | 67 The first parameter defines a file that will store the log. |
68 <!-- | 68 <!-- |
69 If filename is not absolute, it is prefixed with the prefix path. | 69 If filename is not absolute, it is prefixed with the prefix path. |
70 --> | 70 --> |
71 </para> | 71 </para> |
72 | 72 |
73 <para> | 73 <para> |
74 The second argument determines the level of logging. | 74 The second parameter determines the level of logging. |
75 Log levels above are listed in the order of increasing severity. | 75 Log levels above are listed in the order of increasing severity. |
76 Setting a certain log level will cause all messages of | 76 Setting a certain log level will cause all messages of |
77 the specified and more severe log levels to be logged. | 77 the specified and more severe log levels to be logged. |
78 For example, the default level <value>error</value> will | 78 For example, the default level <literal>error</literal> will |
79 cause <value>error</value>, <value>crit</value>, | 79 cause <literal>error</literal>, <literal>crit</literal>, |
80 <value>alert</value>, and <value>emerg</value> messages | 80 <literal>alert</literal>, and <literal>emerg</literal> messages |
81 to be logged. | 81 to be logged. |
82 <note> | 82 <note> |
83 For <value>debug</value> logging to work, nginx needs to | 83 For <literal>debug</literal> logging to work, nginx needs to |
84 be built with <code>--with-debug</code>. | 84 be built with <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>variable</argument>[=<argument>value</argument>]</syntax> | 92 <syntax><value>variable</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 Allows to limit a set of environment variables, change their values, | 97 Allows to limit a set of environment variables, change their values, |
140 | 140 |
141 </directive> | 141 </directive> |
142 | 142 |
143 | 143 |
144 <directive name="include"> | 144 <directive name="include"> |
145 <syntax><argument>file</argument> | <argument>mask</argument></syntax> | 145 <syntax><value>file</value> | <value>mask</value></syntax> |
146 <default/> | 146 <default/> |
147 <context/> | 147 <context/> |
148 | 148 |
149 <para> | 149 <para> |
150 Includes another <argument>file</argument>, or files matching the | 150 Includes another <value>file</value>, or files matching the |
151 specified <argument>mask</argument>, into configuration. | 151 specified <value>mask</value>, into configuration. |
152 Included files should consist of | 152 Included files should consist of |
153 syntactically correct directives and blocks. | 153 syntactically correct directives and blocks. |
154 </para> | 154 </para> |
155 | 155 |
156 <para> | 156 <para> |
163 | 163 |
164 </directive> | 164 </directive> |
165 | 165 |
166 | 166 |
167 <directive name="master_process"> | 167 <directive name="master_process"> |
168 <syntax><value>on</value> | <value>off</value></syntax> | 168 <syntax><literal>on</literal> | <literal>off</literal></syntax> |
169 <default>on</default> | 169 <default>on</default> |
170 <context>main</context> | 170 <context>main</context> |
171 | 171 |
172 <para> | 172 <para> |
173 Determines whether worker processes are started. | 173 Determines whether worker processes are started. |
176 | 176 |
177 </directive> | 177 </directive> |
178 | 178 |
179 | 179 |
180 <directive name="pid"> | 180 <directive name="pid"> |
181 <syntax><argument>file</argument></syntax> | 181 <syntax><value>file</value></syntax> |
182 <default>nginx.pid</default> | 182 <default>nginx.pid</default> |
183 <context>main</context> | 183 <context>main</context> |
184 | 184 |
185 <para> | 185 <para> |
186 Defines a <argument>file</argument> which will store the process ID of the main process. | 186 Defines a <value>file</value> that will store the process ID of the main process. |
187 </para> | 187 </para> |
188 | 188 |
189 </directive> | 189 </directive> |
190 | 190 |
191 | 191 |
192 <directive name="ssl_engine"> | 192 <directive name="ssl_engine"> |
193 <syntax><argument>device</argument></syntax> | 193 <syntax><value>device</value></syntax> |
194 <default/> | 194 <default/> |
195 <context>main</context> | 195 <context>main</context> |
196 | 196 |
197 <para> | 197 <para> |
198 Defines the name of the hardware SSL accelerator. | 198 Defines the name of the hardware SSL accelerator. |
200 | 200 |
201 </directive> | 201 </directive> |
202 | 202 |
203 | 203 |
204 <directive name="timer_resolution"> | 204 <directive name="timer_resolution"> |
205 <syntax><argument>interval</argument></syntax> | 205 <syntax><value>interval</value></syntax> |
206 <default/> | 206 <default/> |
207 <context>main</context> | 207 <context>main</context> |
208 | 208 |
209 <para> | 209 <para> |
210 Reduces timer resolution in worker processes, thus reducing the | 210 Reduces timer resolution in worker processes, thus reducing the |
211 number of <c-func>gettimeofday</c-func> system calls made. | 211 number of <c-func>gettimeofday</c-func> system calls made. |
212 By default, <c-func>gettimeofday</c-func> is called each time | 212 By default, <c-func>gettimeofday</c-func> is called each time |
213 on receiving a kernel event. | 213 on receiving a kernel event. |
214 With reduced resolution, <c-func>gettimeofday</c-func> is only | 214 With reduced resolution, <c-func>gettimeofday</c-func> is only |
215 called once per specified <argument>interval</argument>. | 215 called once per specified <value>interval</value>. |
216 </para> | 216 </para> |
217 | 217 |
218 <para> | 218 <para> |
219 Example: | 219 Example: |
220 <example> | 220 <example> |
225 <para> | 225 <para> |
226 An internal implementation of interval depends on the method used: | 226 An internal implementation of interval depends on the method used: |
227 <list type="bullet"> | 227 <list type="bullet"> |
228 | 228 |
229 <listitem> | 229 <listitem> |
230 an <c-def>EVFILT_TIMER</c-def> filter if <value>kqueue</value> is used; | 230 an <c-def>EVFILT_TIMER</c-def> filter if <literal>kqueue</literal> is used; |
231 </listitem> | 231 </listitem> |
232 | 232 |
233 <listitem> | 233 <listitem> |
234 <c-func>timer_create</c-func> if <value>eventport</value> is used; | 234 <c-func>timer_create</c-func> if <literal>eventport</literal> is used; |
235 </listitem> | 235 </listitem> |
236 | 236 |
237 <listitem> | 237 <listitem> |
238 <c-func>setitimer</c-func> otherwise. | 238 <c-func>setitimer</c-func> otherwise. |
239 </listitem> | 239 </listitem> |
243 | 243 |
244 </directive> | 244 </directive> |
245 | 245 |
246 | 246 |
247 <directive name="user"> | 247 <directive name="user"> |
248 <syntax><argument>user</argument> [<argument>group</argument>]</syntax> | 248 <syntax><value>user</value> [<value>group</value>]</syntax> |
249 <default>nobody nobody</default> | 249 <default>nobody nobody</default> |
250 <context>main</context> | 250 <context>main</context> |
251 | 251 |
252 <para> | 252 <para> |
253 Defines <argument>user</argument> and <argument>group</argument> | 253 Defines <value>user</value> and <value>group</value> |
254 credentials used by worker processes. | 254 credentials used by worker processes. |
255 If <argument>group</argument> is omitted, a group whose name equals | 255 If <value>group</value> is omitted, a group whose name equals |
256 that of <argument>user</argument> is used. | 256 that of <value>user</value> is used. |
257 </para> | 257 </para> |
258 | 258 |
259 </directive> | 259 </directive> |
260 | 260 |
261 | 261 |
262 <directive name="worker_priority"> | 262 <directive name="worker_priority"> |
263 <syntax><argument>number</argument></syntax> | 263 <syntax><value>number</value></syntax> |
264 <default>0</default> | 264 <default>0</default> |
265 <context>main</context> | 265 <context>main</context> |
266 | 266 |
267 <para> | 267 <para> |
268 Defines a scheduling priority for worker processes like is | 268 Defines a scheduling priority for worker processes like is |
269 done by the <command>nice</command> command: a negative | 269 done by the <command>nice</command> command: a negative |
270 <argument>number</argument> | 270 <value>number</value> |
271 means higher priority. | 271 means higher priority. |
272 Allowed range normally varies from -20 to 20. | 272 Allowed range normally varies from -20 to 20. |
273 </para> | 273 </para> |
274 | 274 |
275 <para> | 275 <para> |
281 | 281 |
282 </directive> | 282 </directive> |
283 | 283 |
284 | 284 |
285 <directive name="worker_processes"> | 285 <directive name="worker_processes"> |
286 <syntax><argument>number</argument></syntax> | 286 <syntax><value>number</value></syntax> |
287 <default>1</default> | 287 <default>1</default> |
288 <context>main</context> | 288 <context>main</context> |
289 | 289 |
290 <para> | 290 <para> |
291 Defines the number of worker processes. | 291 Defines the number of worker processes. |
301 | 301 |
302 </directive> | 302 </directive> |
303 | 303 |
304 | 304 |
305 <directive name="worker_rlimit_core"> | 305 <directive name="worker_rlimit_core"> |
306 <syntax><argument>size</argument></syntax> | 306 <syntax><value>size</value></syntax> |
307 <default/> | 307 <default/> |
308 <context>main</context> | 308 <context>main</context> |
309 | 309 |
310 <para> | 310 <para> |
311 Changes the limit on the largest size of a core file | 311 Changes the limit on the largest size of a core file |
315 | 315 |
316 </directive> | 316 </directive> |
317 | 317 |
318 | 318 |
319 <directive name="worker_rlimit_nofile"> | 319 <directive name="worker_rlimit_nofile"> |
320 <syntax><argument>number</argument></syntax> | 320 <syntax><value>number</value></syntax> |
321 <default/> | 321 <default/> |
322 <context>main</context> | 322 <context>main</context> |
323 | 323 |
324 <para> | 324 <para> |
325 Changes the limit on the maximum number of open files | 325 Changes the limit on the maximum number of open files |
329 | 329 |
330 </directive> | 330 </directive> |
331 | 331 |
332 | 332 |
333 <directive name="working_directory"> | 333 <directive name="working_directory"> |
334 <syntax><argument>directory</argument></syntax> | 334 <syntax><value>directory</value></syntax> |
335 <default/> | 335 <default/> |
336 <context>main</context> | 336 <context>main</context> |
337 | 337 |
338 <para> | 338 <para> |
339 Defines a current working directory for a worker process. | 339 Defines a current working directory for a worker process. |