Mercurial > hg > nginx-site

comparison xml/en/docs/ngx_core_module.xml @ 102:c76a257f3fd4

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
The directive name is now automatically printed in <default> and <syntax>. Specifying <default> is made non-optional. Visible changes: - "types" and "proxy_set_header" get proper defaults (not yet displayed nicely); - "fastcgi_hide_header", "fastcgi_ignore_headers", "fastcgi_pass_header", "proxy_hide_header", "proxy_ignore_headers", and "proxy_pass_header" now have their (empty) defaults documented; - mentions of "fastcgi_redirect_errors" and "proxy_redirect_errors" which are long unsupported were removed.
author Ruslan Ermilov <ru@nginx.com>
date Wed, 19 Oct 2011 05:15:24 +0000
parents a10bc0cb0a6a
children 05e58829de2e
comparison
equal deleted inserted replaced
101:b8fd014ec712 102:c76a257f3fd4
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>daemon <value>on</value> | <value>off</value></syntax> 33 <syntax><value>on</value> | <value>off</value></syntax>
34 <default>daemon 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.
39 Mainly used during development. 39 Mainly used during development.
41 41
42 </directive> 42 </directive>
43 43
44 44
45 <directive name="env"> 45 <directive name="env">
46 <syntax>env <argument>VAR</argument>[=<argument>VALUE</argument>]</syntax> 46 <syntax><argument>VAR</argument>[=<argument>VALUE</argument>]</syntax>
47 <default>env TZ</default> 47 <default>TZ</default>
48 <context>main</context> 48 <context>main</context>
49 49
50 <para> 50 <para>
51 Allows to limit a set of environment variables, change their values, 51 Allows to limit a set of environment variables, change their values,
52 or create new environment variables, for the following cases: 52 or create new environment variables, for the following cases:
93 </para> 93 </para>
94 94
95 </directive> 95 </directive>
96 96
97 <directive name="include"> 97 <directive name="include">
98 <syntax>include <argument>file</argument> | <argument>mask</argument></syntax> 98 <syntax><argument>file</argument> | <argument>mask</argument></syntax>
99 <default/> 99 <default/>
100 <context/> 100 <context/>
101 101
102 <para> 102 <para>
103 Includes another <argument>file</argument>, or files matching the 103 Includes another <argument>file</argument>, or files matching the
116 116
117 </directive> 117 </directive>
118 118
119 119
120 <directive name="master_process"> 120 <directive name="master_process">
121 <syntax>master_process <value>on</value> | <value>off</value></syntax> 121 <syntax><value>on</value> | <value>off</value></syntax>
122 <default>master_process on</default> 122 <default>on</default>
123 <context>main</context> 123 <context>main</context>
124 124
125 <para> 125 <para>
126 Determines whether worker processes are started. 126 Determines whether worker processes are started.
127 This directive is intended for nginx developers. 127 This directive is intended for nginx developers.
129 129
130 </directive> 130 </directive>
131 131
132 132
133 <directive name="pid"> 133 <directive name="pid">
134 <syntax>pid <argument>file</argument></syntax> 134 <syntax><argument>file</argument></syntax>
135 <default>pid nginx.pid</default> 135 <default>nginx.pid</default>
136 <context>main</context> 136 <context>main</context>
137 137
138 <para> 138 <para>
139 Defines a <argument>file</argument> which will store the process ID of the main process. 139 Defines a <argument>file</argument> which will store the process ID of the main process.
140 </para> 140 </para>
141 141
142 </directive> 142 </directive>
143 143
144 144
145 <directive name="ssl_engine"> 145 <directive name="ssl_engine">
146 <syntax>ssl_engine <argument>device</argument></syntax> 146 <syntax><argument>device</argument></syntax>
147 <default/> 147 <default/>
148 <context>main</context> 148 <context>main</context>
149 149
150 <para> 150 <para>
151 Defines the name of the hardware SSL accelerator. 151 Defines the name of the hardware SSL accelerator.
153 153
154 </directive> 154 </directive>
155 155
156 156
157 <directive name="timer_resolution"> 157 <directive name="timer_resolution">
158 <syntax>timer_resolution <argument>interval</argument></syntax> 158 <syntax><argument>interval</argument></syntax>
159 <default/> 159 <default/>
160 <context>main</context> 160 <context>main</context>
161 161
162 <para> 162 <para>
163 Reduces timer resolution in worker processes, thus reducing the 163 Reduces timer resolution in worker processes, thus reducing the
196 196
197 </directive> 197 </directive>
198 198
199 199
200 <directive name="user"> 200 <directive name="user">
201 <syntax>user <argument>user</argument> [<argument>group</argument>]</syntax> 201 <syntax><argument>user</argument> [<argument>group</argument>]</syntax>
202 <default>user nobody nobody</default> 202 <default>nobody nobody</default>
203 <context>main</context> 203 <context>main</context>
204 204
205 <para> 205 <para>
206 Defines <argument>user</argument> and <argument>group</argument> 206 Defines <argument>user</argument> and <argument>group</argument>
207 credentials used by worker processes. 207 credentials used by worker processes.
211 211
212 </directive> 212 </directive>
213 213
214 214
215 <directive name="worker_priority"> 215 <directive name="worker_priority">
216 <syntax>worker_priority <argument>number</argument></syntax> 216 <syntax><argument>number</argument></syntax>
217 <default>worker_priority 0</default> 217 <default>0</default>
218 <context>main</context> 218 <context>main</context>
219 219
220 <para> 220 <para>
221 Defines a scheduling priority for worker processes like is 221 Defines a scheduling priority for worker processes like is
222 done by the <command>nice</command> command: a negative 222 done by the <command>nice</command> command: a negative
234 234
235 </directive> 235 </directive>
236 236
237 237
238 <directive name="worker_processes"> 238 <directive name="worker_processes">
239 <syntax>worker_processes <argument>number</argument></syntax> 239 <syntax><argument>number</argument></syntax>
240 <default>worker_processes 1</default> 240 <default>1</default>
241 <context>main</context> 241 <context>main</context>
242 242
243 <para> 243 <para>
244 Defines the number of worker processes. 244 Defines the number of worker processes.
245 </para> 245 </para>
246 246
247 </directive> 247 </directive>
248 248
249 249
250 <directive name="worker_rlimit_core"> 250 <directive name="worker_rlimit_core">
251 <syntax>worker_rlimit_core <argument>size</argument></syntax> 251 <syntax><argument>size</argument></syntax>
252 <default/> 252 <default/>
253 <context>main</context> 253 <context>main</context>
254 254
255 <para> 255 <para>
256 Changes the limit on the largest size of a core file 256 Changes the limit on the largest size of a core file
260 260
261 </directive> 261 </directive>
262 262
263 263
264 <directive name="worker_rlimit_nofile"> 264 <directive name="worker_rlimit_nofile">
265 <syntax>worker_rlimit_nofile <argument>number</argument></syntax> 265 <syntax><argument>number</argument></syntax>
266 <default/> 266 <default/>
267 <context>main</context> 267 <context>main</context>
268 268
269 <para> 269 <para>
270 Changes the limit on the maximum number of open files 270 Changes the limit on the maximum number of open files
274 274
275 </directive> 275 </directive>
276 276
277 277
278 <directive name="working_directory"> 278 <directive name="working_directory">
279 <syntax>working_directory <argument>directory</argument></syntax> 279 <syntax><argument>directory</argument></syntax>
280 <default/> 280 <default/>
281 <context>main</context> 281 <context>main</context>
282 282
283 <para> 283 <para>
284 Defines a current working directory for a worker process. 284 Defines a current working directory for a worker process.