nginx-site: xml/en/docs/ngx_core

annotate xml/en/docs/ngx_core_module.xml @ 444:43c84d19bf92

Added a note about the NGINX environment variable.

author	Ruslan Ermilov <ru@nginx.com>
date	Mon, 12 Mar 2012 12:32:04 +0000
parents	df261b1ce71f
children	571b790ddf9e

rev	line source
63 6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1 <?xml version="1.0"?>
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3 <!DOCTYPE module SYSTEM "../../../dtd/module.dtd">
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	4
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	5 <module name="Core functionality"
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	6 link="/en/docs/ngx_core_module.html"
98 a10bc0cb0a6a Whitespace cleanup. Ruslan Ermilov <ru@nginx.com> parents: 82 diff changeset	7 lang="en">
63 6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	8
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	9 <section id="example" name="Example Configuration">
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	10
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	11 <para>
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	12 <example>
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	13 user www www;
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	14 worker_processes 2;
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	15
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	16 error_log /var/log/nginx-error.log info;
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	17
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	18 events {
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	19 use kqueue;
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	20 worker_connections 2048;
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	21 }
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	22
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	23 ...
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	24 </example>
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	25 </para>
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	26
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	27 </section>
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	28
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	29
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	30 <section id="directives" name="Directives">
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	31
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	32 <directive name="daemon">
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	33 <syntax><literal>on</literal> \| <literal>off</literal></syntax>
102 c76a257f3fd4 The directive name is now automatically printed in <default> and <syntax>. Ruslan Ermilov <ru@nginx.com> parents: 98 diff changeset	34 <default>on</default>
63 6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	35 <context>main</context>
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	36
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	37 <para>
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	38 Determines whether nginx should become a daemon.
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	39 Mainly used during development.
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	40 </para>
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	41
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	42 </directive>
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	43
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	44
158 05e58829de2e Documented the "error_log" directive. Ruslan Ermilov <ru@nginx.com> parents: 102 diff changeset	45 <directive name="error_log">
05e58829de2e Documented the "error_log" directive. Ruslan Ermilov <ru@nginx.com> parents: 102 diff changeset	46 <syntax>
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	47 <value>file</value>
4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	48 [<literal>debug</literal> \|
4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	49 <literal>info</literal> \|
4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	50 <literal>notice</literal> \|
4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	51 <literal>warn</literal> \|
4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	52 <literal>error</literal> \|
4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	53 <literal>crit</literal> \|
4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	54 <literal>alert</literal> \|
4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	55 <literal>emerg</literal>]</syntax>
158 05e58829de2e Documented the "error_log" directive. Ruslan Ermilov <ru@nginx.com> parents: 102 diff changeset	56 <default>logs/error.log error</default>
05e58829de2e Documented the "error_log" directive. Ruslan Ermilov <ru@nginx.com> parents: 102 diff changeset	57 <context>main</context>
05e58829de2e Documented the "error_log" directive. Ruslan Ermilov <ru@nginx.com> parents: 102 diff changeset	58 <context>http</context>
05e58829de2e Documented the "error_log" directive. Ruslan Ermilov <ru@nginx.com> parents: 102 diff changeset	59 <context>server</context>
05e58829de2e Documented the "error_log" directive. Ruslan Ermilov <ru@nginx.com> parents: 102 diff changeset	60 <context>location</context>
05e58829de2e Documented the "error_log" directive. Ruslan Ermilov <ru@nginx.com> parents: 102 diff changeset	61
05e58829de2e Documented the "error_log" directive. Ruslan Ermilov <ru@nginx.com> parents: 102 diff changeset	62 <para>
05e58829de2e Documented the "error_log" directive. Ruslan Ermilov <ru@nginx.com> parents: 102 diff changeset	63 Configures logging.
05e58829de2e Documented the "error_log" directive. Ruslan Ermilov <ru@nginx.com> parents: 102 diff changeset	64 </para>
05e58829de2e Documented the "error_log" directive. Ruslan Ermilov <ru@nginx.com> parents: 102 diff changeset	65
05e58829de2e Documented the "error_log" directive. Ruslan Ermilov <ru@nginx.com> parents: 102 diff changeset	66 <para>
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	67 The first parameter defines a file that will store the log.
158 05e58829de2e Documented the "error_log" directive. Ruslan Ermilov <ru@nginx.com> parents: 102 diff changeset	68 <!--
05e58829de2e Documented the "error_log" directive. Ruslan Ermilov <ru@nginx.com> parents: 102 diff changeset	69 If filename is not absolute, it is prefixed with the prefix path.
05e58829de2e Documented the "error_log" directive. Ruslan Ermilov <ru@nginx.com> parents: 102 diff changeset	70 -->
05e58829de2e Documented the "error_log" directive. Ruslan Ermilov <ru@nginx.com> parents: 102 diff changeset	71 </para>
05e58829de2e Documented the "error_log" directive. Ruslan Ermilov <ru@nginx.com> parents: 102 diff changeset	72
05e58829de2e Documented the "error_log" directive. Ruslan Ermilov <ru@nginx.com> parents: 102 diff changeset	73 <para>
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	74 The second parameter determines the level of logging.
158 05e58829de2e Documented the "error_log" directive. Ruslan Ermilov <ru@nginx.com> parents: 102 diff changeset	75 Log levels above are listed in the order of increasing severity.
05e58829de2e Documented the "error_log" directive. Ruslan Ermilov <ru@nginx.com> parents: 102 diff changeset	76 Setting a certain log level will cause all messages of
05e58829de2e Documented the "error_log" directive. Ruslan Ermilov <ru@nginx.com> parents: 102 diff changeset	77 the specified and more severe log levels to be logged.
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	78 For example, the default level <literal>error</literal> will
4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	79 cause <literal>error</literal>, <literal>crit</literal>,
4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	80 <literal>alert</literal>, and <literal>emerg</literal> messages
158 05e58829de2e Documented the "error_log" directive. Ruslan Ermilov <ru@nginx.com> parents: 102 diff changeset	81 to be logged.
05e58829de2e Documented the "error_log" directive. Ruslan Ermilov <ru@nginx.com> parents: 102 diff changeset	82 <note>
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	83 For <literal>debug</literal> logging to work, nginx needs to
4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	84 be built with <literal>--with-debug</literal>.
158 05e58829de2e Documented the "error_log" directive. Ruslan Ermilov <ru@nginx.com> parents: 102 diff changeset	85 </note>
05e58829de2e Documented the "error_log" directive. Ruslan Ermilov <ru@nginx.com> parents: 102 diff changeset	86 </para>
05e58829de2e Documented the "error_log" directive. Ruslan Ermilov <ru@nginx.com> parents: 102 diff changeset	87
05e58829de2e Documented the "error_log" directive. Ruslan Ermilov <ru@nginx.com> parents: 102 diff changeset	88 </directive>
05e58829de2e Documented the "error_log" directive. Ruslan Ermilov <ru@nginx.com> parents: 102 diff changeset	89
05e58829de2e Documented the "error_log" directive. Ruslan Ermilov <ru@nginx.com> parents: 102 diff changeset	90
63 6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	91 <directive name="env">
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	92 <syntax><value>variable</value>[=<value>value</value>]</syntax>
102 c76a257f3fd4 The directive name is now automatically printed in <default> and <syntax>. Ruslan Ermilov <ru@nginx.com> parents: 98 diff changeset	93 <default>TZ</default>
63 6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	94 <context>main</context>
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	95
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	96 <para>
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	97 Allows to limit a set of environment variables, change their values,
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	98 or create new environment variables, for the following cases:
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	99 <list type="bullet">
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	100
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	101 <listitem>
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	102 variable inheritance during a
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	103 <link doc="control.xml" id="upgrade">live upgrade</link>
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	104 of an executable file;
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	105 </listitem>
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	106
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	107 <listitem>
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	108 use of variables by the module
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	109 <link doc="http/ngx_http_perl_module.xml">ngx_http_perl_module</link>;
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	110 </listitem>
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	111
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	112 <listitem>
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	113 use of variables by worker processes.
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	114 Please bear in mind that controlling system libraries in this way
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	115 is not always possible as it is not uncommon for libraries to check
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	116 variables only during initialization, well before they can be set
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	117 using this directive.
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	118 An exception from this is an above mentioned
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	119 <link doc="control.xml" id="upgrade">live upgrade</link>
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	120 of an executable file.
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	121 </listitem>
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	122
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	123 </list>
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	124 </para>
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	125
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	126 <para>
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	127 The TZ variable is always inherited and made available to the module
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	128 <link doc="http/ngx_http_perl_module.xml">ngx_http_perl_module</link>,
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	129 unless configured explicitly.
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	130 </para>
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	131
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	132 <para>
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	133 Usage example:
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	134 <example>
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	135 env MALLOC_OPTIONS;
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	136 env PERL5LIB=/data/site/modules;
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	137 env OPENSSL_ALLOW_PROXY_CERTS=1;
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	138 </example>
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	139 </para>
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	140
444 43c84d19bf92 Added a note about the NGINX environment variable. Ruslan Ermilov <ru@nginx.com> parents: 289 diff changeset	141 <para>
43c84d19bf92 Added a note about the NGINX environment variable. Ruslan Ermilov <ru@nginx.com> parents: 289 diff changeset	142 <note>
43c84d19bf92 Added a note about the NGINX environment variable. Ruslan Ermilov <ru@nginx.com> parents: 289 diff changeset	143 The NGINX environment variable is used internally by nginx
43c84d19bf92 Added a note about the NGINX environment variable. Ruslan Ermilov <ru@nginx.com> parents: 289 diff changeset	144 and should not be set directly by the user.
43c84d19bf92 Added a note about the NGINX environment variable. Ruslan Ermilov <ru@nginx.com> parents: 289 diff changeset	145 </note>
43c84d19bf92 Added a note about the NGINX environment variable. Ruslan Ermilov <ru@nginx.com> parents: 289 diff changeset	146 </para>
43c84d19bf92 Added a note about the NGINX environment variable. Ruslan Ermilov <ru@nginx.com> parents: 289 diff changeset	147
63 6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	148 </directive>
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	149
249 0f43f2c32c0b Fixed some nits. Ruslan Ermilov <ru@nginx.com> parents: 226 diff changeset	150
63 6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	151 <directive name="include">
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	152 <syntax><value>file</value> \| <value>mask</value></syntax>
63 6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	153 <default/>
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	154 <context/>
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	155
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	156 <para>
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	157 Includes another <value>file</value>, or files matching the
4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	158 specified <value>mask</value>, into configuration.
63 6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	159 Included files should consist of
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	160 syntactically correct directives and blocks.
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	161 </para>
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	162
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	163 <para>
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	164 Usage example:
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	165 <example>
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	166 include mime.types;
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	167 include vhosts/*.conf;
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	168 </example>
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	169 </para>
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	170
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	171 </directive>
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	172
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	173
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	174 <directive name="master_process">
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	175 <syntax><literal>on</literal> \| <literal>off</literal></syntax>
102 c76a257f3fd4 The directive name is now automatically printed in <default> and <syntax>. Ruslan Ermilov <ru@nginx.com> parents: 98 diff changeset	176 <default>on</default>
63 6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	177 <context>main</context>
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	178
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	179 <para>
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	180 Determines whether worker processes are started.
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	181 This directive is intended for nginx developers.
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	182 </para>
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	183
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	184 </directive>
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	185
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	186
289 df261b1ce71f Documented the --with-pcre-jit configuration parameter Ruslan Ermilov <ru@nginx.com> parents: 271 diff changeset	187 <directive name="pcre_jit">
df261b1ce71f Documented the --with-pcre-jit configuration parameter Ruslan Ermilov <ru@nginx.com> parents: 271 diff changeset	188 <syntax><literal>on</literal> \| <literal>off</literal></syntax>
df261b1ce71f Documented the --with-pcre-jit configuration parameter Ruslan Ermilov <ru@nginx.com> parents: 271 diff changeset	189 <default>off</default>
df261b1ce71f Documented the --with-pcre-jit configuration parameter Ruslan Ermilov <ru@nginx.com> parents: 271 diff changeset	190 <context>main</context>
df261b1ce71f Documented the --with-pcre-jit configuration parameter Ruslan Ermilov <ru@nginx.com> parents: 271 diff changeset	191 <appeared-in>1.1.12</appeared-in>
df261b1ce71f Documented the --with-pcre-jit configuration parameter Ruslan Ermilov <ru@nginx.com> parents: 271 diff changeset	192
df261b1ce71f Documented the --with-pcre-jit configuration parameter Ruslan Ermilov <ru@nginx.com> parents: 271 diff changeset	193 <para>
df261b1ce71f Documented the --with-pcre-jit configuration parameter Ruslan Ermilov <ru@nginx.com> parents: 271 diff changeset	194 Enables or disables the use of “just-in-time compilation” (PCRE JIT)
df261b1ce71f Documented the --with-pcre-jit configuration parameter Ruslan Ermilov <ru@nginx.com> parents: 271 diff changeset	195 for regular expressions known at configuration parse time.
df261b1ce71f Documented the --with-pcre-jit configuration parameter Ruslan Ermilov <ru@nginx.com> parents: 271 diff changeset	196 </para>
df261b1ce71f Documented the --with-pcre-jit configuration parameter Ruslan Ermilov <ru@nginx.com> parents: 271 diff changeset	197
df261b1ce71f Documented the --with-pcre-jit configuration parameter Ruslan Ermilov <ru@nginx.com> parents: 271 diff changeset	198 <para>
df261b1ce71f Documented the --with-pcre-jit configuration parameter Ruslan Ermilov <ru@nginx.com> parents: 271 diff changeset	199 PCRE JIT can speed up processing of regular expressions significantly.
df261b1ce71f Documented the --with-pcre-jit configuration parameter Ruslan Ermilov <ru@nginx.com> parents: 271 diff changeset	200 <note>
df261b1ce71f Documented the --with-pcre-jit configuration parameter Ruslan Ermilov <ru@nginx.com> parents: 271 diff changeset	201 The JIT is available in PCRE libraries starting from version 8.20
df261b1ce71f Documented the --with-pcre-jit configuration parameter Ruslan Ermilov <ru@nginx.com> parents: 271 diff changeset	202 built with the <literal>--enable-jit</literal> configuration parameter.
df261b1ce71f Documented the --with-pcre-jit configuration parameter Ruslan Ermilov <ru@nginx.com> parents: 271 diff changeset	203 When building the PCRE library with nginx (<literal>--with-pcre=</literal>),
df261b1ce71f Documented the --with-pcre-jit configuration parameter Ruslan Ermilov <ru@nginx.com> parents: 271 diff changeset	204 the JIT support should be enabled with the
df261b1ce71f Documented the --with-pcre-jit configuration parameter Ruslan Ermilov <ru@nginx.com> parents: 271 diff changeset	205 <literal>--with-pcre-jit</literal> configuration parameter.
df261b1ce71f Documented the --with-pcre-jit configuration parameter Ruslan Ermilov <ru@nginx.com> parents: 271 diff changeset	206 </note>
df261b1ce71f Documented the --with-pcre-jit configuration parameter Ruslan Ermilov <ru@nginx.com> parents: 271 diff changeset	207 </para>
df261b1ce71f Documented the --with-pcre-jit configuration parameter Ruslan Ermilov <ru@nginx.com> parents: 271 diff changeset	208
df261b1ce71f Documented the --with-pcre-jit configuration parameter Ruslan Ermilov <ru@nginx.com> parents: 271 diff changeset	209 </directive>
df261b1ce71f Documented the --with-pcre-jit configuration parameter Ruslan Ermilov <ru@nginx.com> parents: 271 diff changeset	210
df261b1ce71f Documented the --with-pcre-jit configuration parameter Ruslan Ermilov <ru@nginx.com> parents: 271 diff changeset	211
63 6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	212 <directive name="pid">
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	213 <syntax><value>file</value></syntax>
102 c76a257f3fd4 The directive name is now automatically printed in <default> and <syntax>. Ruslan Ermilov <ru@nginx.com> parents: 98 diff changeset	214 <default>nginx.pid</default>
63 6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	215 <context>main</context>
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	216
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	217 <para>
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	218 Defines a <value>file</value> that will store the process ID of the main process.
63 6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	219 </para>
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	220
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	221 </directive>
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	222
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	223
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	224 <directive name="ssl_engine">
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	225 <syntax><value>device</value></syntax>
63 6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	226 <default/>
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	227 <context>main</context>
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	228
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	229 <para>
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	230 Defines the name of the hardware SSL accelerator.
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	231 </para>
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	232
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	233 </directive>
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	234
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	235
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	236 <directive name="timer_resolution">
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	237 <syntax><value>interval</value></syntax>
63 6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	238 <default/>
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	239 <context>main</context>
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	240
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	241 <para>
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	242 Reduces timer resolution in worker processes, thus reducing the
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	243 number of <c-func>gettimeofday</c-func> system calls made.
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	244 By default, <c-func>gettimeofday</c-func> is called each time
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	245 on receiving a kernel event.
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	246 With reduced resolution, <c-func>gettimeofday</c-func> is only
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	247 called once per specified <value>interval</value>.
63 6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	248 </para>
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	249
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	250 <para>
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	251 Example:
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	252 <example>
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	253 timer_resolution 100ms;
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	254 </example>
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	255 </para>
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	256
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	257 <para>
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	258 An internal implementation of interval depends on the method used:
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	259 <list type="bullet">
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	260
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	261 <listitem>
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	262 an <c-def>EVFILT_TIMER</c-def> filter if <literal>kqueue</literal> is used;
63 6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	263 </listitem>
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	264
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	265 <listitem>
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	266 <c-func>timer_create</c-func> if <literal>eventport</literal> is used;
63 6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	267 </listitem>
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	268
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	269 <listitem>
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	270 <c-func>setitimer</c-func> otherwise.
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	271 </listitem>
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	272
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	273 </list>
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	274 </para>
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	275
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	276 </directive>
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	277
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	278
82 89c31b453d40 Sorted directives alphabetically. Ruslan Ermilov <ru@nginx.com> parents: 63 diff changeset	279 <directive name="user">
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	280 <syntax><value>user</value> [<value>group</value>]</syntax>
102 c76a257f3fd4 The directive name is now automatically printed in <default> and <syntax>. Ruslan Ermilov <ru@nginx.com> parents: 98 diff changeset	281 <default>nobody nobody</default>
63 6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	282 <context>main</context>
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	283
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	284 <para>
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	285 Defines <value>user</value> and <value>group</value>
82 89c31b453d40 Sorted directives alphabetically. Ruslan Ermilov <ru@nginx.com> parents: 63 diff changeset	286 credentials used by worker processes.
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	287 If <value>group</value> is omitted, a group whose name equals
4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	288 that of <value>user</value> is used.
63 6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	289 </para>
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	290
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	291 </directive>
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	292
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	293
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	294 <directive name="worker_priority">
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	295 <syntax><value>number</value></syntax>
102 c76a257f3fd4 The directive name is now automatically printed in <default> and <syntax>. Ruslan Ermilov <ru@nginx.com> parents: 98 diff changeset	296 <default>0</default>
63 6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	297 <context>main</context>
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	298
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	299 <para>
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	300 Defines a scheduling priority for worker processes like is
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	301 done by the <command>nice</command> command: a negative
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	302 <value>number</value>
63 6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	303 means higher priority.
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	304 Allowed range normally varies from -20 to 20.
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	305 </para>
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	306
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	307 <para>
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	308 Example:
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	309 <example>
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	310 worker_priority -10;
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	311 </example>
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	312 </para>
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	313
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	314 </directive>
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	315
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	316
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	317 <directive name="worker_processes">
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	318 <syntax><value>number</value></syntax>
102 c76a257f3fd4 The directive name is now automatically printed in <default> and <syntax>. Ruslan Ermilov <ru@nginx.com> parents: 98 diff changeset	319 <default>1</default>
63 6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	320 <context>main</context>
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	321
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	322 <para>
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	323 Defines the number of worker processes.
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	324 </para>
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	325
226 c4b33b07dcfe Added some basic hints on how to tune "worker_processes". Ruslan Ermilov <ru@nginx.com> parents: 158 diff changeset	326 <para>
c4b33b07dcfe Added some basic hints on how to tune "worker_processes". Ruslan Ermilov <ru@nginx.com> parents: 158 diff changeset	327 The optimal value depends on many factors including (but not
c4b33b07dcfe Added some basic hints on how to tune "worker_processes". Ruslan Ermilov <ru@nginx.com> parents: 158 diff changeset	328 limited to) the number of CPU cores, the number of hard disk
c4b33b07dcfe Added some basic hints on how to tune "worker_processes". Ruslan Ermilov <ru@nginx.com> parents: 158 diff changeset	329 drives that store data, and load pattern.
c4b33b07dcfe Added some basic hints on how to tune "worker_processes". Ruslan Ermilov <ru@nginx.com> parents: 158 diff changeset	330 When in doubt, setting it to the number of available CPU cores
c4b33b07dcfe Added some basic hints on how to tune "worker_processes". Ruslan Ermilov <ru@nginx.com> parents: 158 diff changeset	331 would be a good start.
c4b33b07dcfe Added some basic hints on how to tune "worker_processes". Ruslan Ermilov <ru@nginx.com> parents: 158 diff changeset	332 </para>
c4b33b07dcfe Added some basic hints on how to tune "worker_processes". Ruslan Ermilov <ru@nginx.com> parents: 158 diff changeset	333
63 6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	334 </directive>
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	335
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	336
82 89c31b453d40 Sorted directives alphabetically. Ruslan Ermilov <ru@nginx.com> parents: 63 diff changeset	337 <directive name="worker_rlimit_core">
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	338 <syntax><value>size</value></syntax>
82 89c31b453d40 Sorted directives alphabetically. Ruslan Ermilov <ru@nginx.com> parents: 63 diff changeset	339 <default/>
89c31b453d40 Sorted directives alphabetically. Ruslan Ermilov <ru@nginx.com> parents: 63 diff changeset	340 <context>main</context>
89c31b453d40 Sorted directives alphabetically. Ruslan Ermilov <ru@nginx.com> parents: 63 diff changeset	341
89c31b453d40 Sorted directives alphabetically. Ruslan Ermilov <ru@nginx.com> parents: 63 diff changeset	342 <para>
89c31b453d40 Sorted directives alphabetically. Ruslan Ermilov <ru@nginx.com> parents: 63 diff changeset	343 Changes the limit on the largest size of a core file
89c31b453d40 Sorted directives alphabetically. Ruslan Ermilov <ru@nginx.com> parents: 63 diff changeset	344 (<c-def>RLIMIT_CORE</c-def>) for worker processes.
89c31b453d40 Sorted directives alphabetically. Ruslan Ermilov <ru@nginx.com> parents: 63 diff changeset	345 Used to increase the limit without restarting the main process.
89c31b453d40 Sorted directives alphabetically. Ruslan Ermilov <ru@nginx.com> parents: 63 diff changeset	346 </para>
89c31b453d40 Sorted directives alphabetically. Ruslan Ermilov <ru@nginx.com> parents: 63 diff changeset	347
89c31b453d40 Sorted directives alphabetically. Ruslan Ermilov <ru@nginx.com> parents: 63 diff changeset	348 </directive>
89c31b453d40 Sorted directives alphabetically. Ruslan Ermilov <ru@nginx.com> parents: 63 diff changeset	349
89c31b453d40 Sorted directives alphabetically. Ruslan Ermilov <ru@nginx.com> parents: 63 diff changeset	350
89c31b453d40 Sorted directives alphabetically. Ruslan Ermilov <ru@nginx.com> parents: 63 diff changeset	351 <directive name="worker_rlimit_nofile">
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	352 <syntax><value>number</value></syntax>
82 89c31b453d40 Sorted directives alphabetically. Ruslan Ermilov <ru@nginx.com> parents: 63 diff changeset	353 <default/>
89c31b453d40 Sorted directives alphabetically. Ruslan Ermilov <ru@nginx.com> parents: 63 diff changeset	354 <context>main</context>
89c31b453d40 Sorted directives alphabetically. Ruslan Ermilov <ru@nginx.com> parents: 63 diff changeset	355
89c31b453d40 Sorted directives alphabetically. Ruslan Ermilov <ru@nginx.com> parents: 63 diff changeset	356 <para>
89c31b453d40 Sorted directives alphabetically. Ruslan Ermilov <ru@nginx.com> parents: 63 diff changeset	357 Changes the limit on the maximum number of open files
89c31b453d40 Sorted directives alphabetically. Ruslan Ermilov <ru@nginx.com> parents: 63 diff changeset	358 (<c-def>RLIMIT_NOFILE</c-def>) for worker processes.
89c31b453d40 Sorted directives alphabetically. Ruslan Ermilov <ru@nginx.com> parents: 63 diff changeset	359 Used to increase the limit without restarting the main process.
89c31b453d40 Sorted directives alphabetically. Ruslan Ermilov <ru@nginx.com> parents: 63 diff changeset	360 </para>
89c31b453d40 Sorted directives alphabetically. Ruslan Ermilov <ru@nginx.com> parents: 63 diff changeset	361
89c31b453d40 Sorted directives alphabetically. Ruslan Ermilov <ru@nginx.com> parents: 63 diff changeset	362 </directive>
89c31b453d40 Sorted directives alphabetically. Ruslan Ermilov <ru@nginx.com> parents: 63 diff changeset	363
89c31b453d40 Sorted directives alphabetically. Ruslan Ermilov <ru@nginx.com> parents: 63 diff changeset	364
63 6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	365 <directive name="working_directory">
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	366 <syntax><value>directory</value></syntax>
63 6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	367 <default/>
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	368 <context>main</context>
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	369
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	370 <para>
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	371 Defines a current working directory for a worker process.
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	372 It is primarily used when writing a core-file, in which case
262 676abe405aba Changed one instance of "working process" to "worker process". Ruslan Ermilov <ru@nginx.com> parents: 249 diff changeset	373 a worker process should have write permission for the
63 6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	374 specified directory.
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	375 </para>
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	376
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	377 </directive>
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	378
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	379 </section>
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	380
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	381 </module>

Mercurial > hg > nginx-site

annotate xml/en/docs/ngx_core_module.xml @ 444:43c84d19bf92