Mercurial > hg > nginx-site

comparison xml/en/docs/ngx_core_module.xml @ 2142:ca7568f67dee

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Sorted directives alphabetically.
author Ruslan Ermilov <ru@nginx.com>
date Tue, 10 Apr 2018 18:39:34 +0300
parents 8f885a69374d
children eeed494bba51
comparison
equal deleted inserted replaced
2141:10751277a8ad 2142:ca7568f67dee
139 When internal error is detected, e.g. the leak of sockets on 139 When internal error is detected, e.g. the leak of sockets on
140 restart of working processes, enabling <literal>debug_points</literal> 140 restart of working processes, enabling <literal>debug_points</literal>
141 leads to a core file creation (<literal>abort</literal>) 141 leads to a core file creation (<literal>abort</literal>)
142 or to stopping of a process (<literal>stop</literal>) for further 142 or to stopping of a process (<literal>stop</literal>) for further
143 analysis using a system debugger. 143 analysis using a system debugger.
144 </para>
145
146 </directive>
147
148
149 <directive name="env">
150 <syntax><value>variable</value>[=<value>value</value>]</syntax>
151 <default>TZ</default>
152 <context>main</context>
153
154 <para>
155 By default, nginx removes all environment variables inherited
156 from its parent process except the TZ variable.
157 This directive allows preserving some of the inherited variables,
158 changing their values, or creating new environment variables.
159 These variables are then:
160 <list type="bullet">
161
162 <listitem>
163 inherited during a <link doc="control.xml" id="upgrade">live upgrade</link>
164 of an executable file;
165 </listitem>
166
167 <listitem>
168 used by the
169 <link doc="http/ngx_http_perl_module.xml">ngx_http_perl_module</link> module;
170 </listitem>
171
172 <listitem>
173 used by worker processes.
174 One should bear in mind that controlling system libraries in this way
175 is not always possible as it is common for libraries to check
176 variables only during initialization, well before they can be set
177 using this directive.
178 An exception from this is an above mentioned
179 <link doc="control.xml" id="upgrade">live upgrade</link>
180 of an executable file.
181 </listitem>
182
183 </list>
184 </para>
185
186 <para>
187 The TZ variable is always inherited and available to the
188 <link doc="http/ngx_http_perl_module.xml">ngx_http_perl_module</link>
189 module, unless it is configured explicitly.
190 </para>
191
192 <para>
193 Usage example:
194 <example>
195 env MALLOC_OPTIONS;
196 env PERL5LIB=/data/site/modules;
197 env OPENSSL_ALLOW_PROXY_CERTS=1;
198 </example>
199 </para>
200
201 <para>
202 <note>
203 The NGINX environment variable is used internally by nginx
204 and should not be set directly by the user.
205 </note>
144 </para> 206 </para>
145 207
146 </directive> 208 </directive>
147 209
148 210
207 </para> 269 </para>
208 270
209 </directive> 271 </directive>
210 272
211 273
212 <directive name="env">
213 <syntax><value>variable</value>[=<value>value</value>]</syntax>
214 <default>TZ</default>
215 <context>main</context>
216
217 <para>
218 By default, nginx removes all environment variables inherited
219 from its parent process except the TZ variable.
220 This directive allows preserving some of the inherited variables,
221 changing their values, or creating new environment variables.
222 These variables are then:
223 <list type="bullet">
224
225 <listitem>
226 inherited during a <link doc="control.xml" id="upgrade">live upgrade</link>
227 of an executable file;
228 </listitem>
229
230 <listitem>
231 used by the
232 <link doc="http/ngx_http_perl_module.xml">ngx_http_perl_module</link> module;
233 </listitem>
234
235 <listitem>
236 used by worker processes.
237 One should bear in mind that controlling system libraries in this way
238 is not always possible as it is common for libraries to check
239 variables only during initialization, well before they can be set
240 using this directive.
241 An exception from this is an above mentioned
242 <link doc="control.xml" id="upgrade">live upgrade</link>
243 of an executable file.
244 </listitem>
245
246 </list>
247 </para>
248
249 <para>
250 The TZ variable is always inherited and available to the
251 <link doc="http/ngx_http_perl_module.xml">ngx_http_perl_module</link>
252 module, unless it is configured explicitly.
253 </para>
254
255 <para>
256 Usage example:
257 <example>
258 env MALLOC_OPTIONS;
259 env PERL5LIB=/data/site/modules;
260 env OPENSSL_ALLOW_PROXY_CERTS=1;
261 </example>
262 </para>
263
264 <para>
265 <note>
266 The NGINX environment variable is used internally by nginx
267 and should not be set directly by the user.
268 </note>
269 </para>
270
271 </directive>
272
273
274 <directive name="events"> 274 <directive name="events">
275 <syntax block="yes"/> 275 <syntax block="yes"/>
276 <default/> 276 <default/>
277 <context>main</context> 277 <context>main</context>
278 278