nginx-site: xml/en/docs/ngx_core

annotate xml/en/docs/ngx_core_module.xml @ 556:345012910707

Documented the "events" and "use" directives.

author	Ruslan Ermilov <ru@nginx.com>
date	Wed, 27 Jun 2012 11:39:27 +0000
parents	ccb7451af1d8
children	71d775bef043

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
516 8e1356bd281a Documented the "debug_connection" directive. Ruslan Ermilov <ru@nginx.com> parents: 469 diff changeset	45 <directive name="debug_connection">
8e1356bd281a Documented the "debug_connection" directive. Ruslan Ermilov <ru@nginx.com> parents: 469 diff changeset	46 <syntax>
8e1356bd281a Documented the "debug_connection" directive. Ruslan Ermilov <ru@nginx.com> parents: 469 diff changeset	47 <value>address</value> \|
8e1356bd281a Documented the "debug_connection" directive. Ruslan Ermilov <ru@nginx.com> parents: 469 diff changeset	48 <value>CIDR</value> \|
8e1356bd281a Documented the "debug_connection" directive. Ruslan Ermilov <ru@nginx.com> parents: 469 diff changeset	49 <literal>unix:</literal></syntax>
8e1356bd281a Documented the "debug_connection" directive. Ruslan Ermilov <ru@nginx.com> parents: 469 diff changeset	50 <default/>
8e1356bd281a Documented the "debug_connection" directive. Ruslan Ermilov <ru@nginx.com> parents: 469 diff changeset	51 <context>events</context>
8e1356bd281a Documented the "debug_connection" directive. Ruslan Ermilov <ru@nginx.com> parents: 469 diff changeset	52
8e1356bd281a Documented the "debug_connection" directive. Ruslan Ermilov <ru@nginx.com> parents: 469 diff changeset	53 <para>
8e1356bd281a Documented the "debug_connection" directive. Ruslan Ermilov <ru@nginx.com> parents: 469 diff changeset	54 Enables debugging log for selected client connections.
8e1356bd281a Documented the "debug_connection" directive. Ruslan Ermilov <ru@nginx.com> parents: 469 diff changeset	55 Other connections will use logging level set by the
8e1356bd281a Documented the "debug_connection" directive. Ruslan Ermilov <ru@nginx.com> parents: 469 diff changeset	56 <link id="error_log"/> directive.
523 a8daad8e83bb Documented 1.2.1 changes. Ruslan Ermilov <ru@nginx.com> parents: 516 diff changeset	57 Debugged connections are specified by IPv4 or IPv6 (1.3.0, 1.2.1)
a8daad8e83bb Documented 1.2.1 changes. Ruslan Ermilov <ru@nginx.com> parents: 516 diff changeset	58 address or network.
516 8e1356bd281a Documented the "debug_connection" directive. Ruslan Ermilov <ru@nginx.com> parents: 469 diff changeset	59 A connection may also be specified using a hostname, in which case the
8e1356bd281a Documented the "debug_connection" directive. Ruslan Ermilov <ru@nginx.com> parents: 469 diff changeset	60 first IPv4 address corresponding to a name is used.
523 a8daad8e83bb Documented 1.2.1 changes. Ruslan Ermilov <ru@nginx.com> parents: 516 diff changeset	61 For connections using UNIX-domain sockets (1.3.0, 1.2.1),
a8daad8e83bb Documented 1.2.1 changes. Ruslan Ermilov <ru@nginx.com> parents: 516 diff changeset	62 debugging log is enabled by the “<literal>unix:</literal>” parameter.
516 8e1356bd281a Documented the "debug_connection" directive. Ruslan Ermilov <ru@nginx.com> parents: 469 diff changeset	63 <example>
8e1356bd281a Documented the "debug_connection" directive. Ruslan Ermilov <ru@nginx.com> parents: 469 diff changeset	64 events {
8e1356bd281a Documented the "debug_connection" directive. Ruslan Ermilov <ru@nginx.com> parents: 469 diff changeset	65 debug_connection 127.0.0.1;
8e1356bd281a Documented the "debug_connection" directive. Ruslan Ermilov <ru@nginx.com> parents: 469 diff changeset	66 debug_connection localhost;
8e1356bd281a Documented the "debug_connection" directive. Ruslan Ermilov <ru@nginx.com> parents: 469 diff changeset	67 debug_connection 192.0.2.0/24;
8e1356bd281a Documented the "debug_connection" directive. Ruslan Ermilov <ru@nginx.com> parents: 469 diff changeset	68 debug_connection ::1;
8e1356bd281a Documented the "debug_connection" directive. Ruslan Ermilov <ru@nginx.com> parents: 469 diff changeset	69 debug_connection 2001:0db8::/32;
8e1356bd281a Documented the "debug_connection" directive. Ruslan Ermilov <ru@nginx.com> parents: 469 diff changeset	70 debug_connection unix:;
8e1356bd281a Documented the "debug_connection" directive. Ruslan Ermilov <ru@nginx.com> parents: 469 diff changeset	71 ...
8e1356bd281a Documented the "debug_connection" directive. Ruslan Ermilov <ru@nginx.com> parents: 469 diff changeset	72 }
8e1356bd281a Documented the "debug_connection" directive. Ruslan Ermilov <ru@nginx.com> parents: 469 diff changeset	73 </example>
8e1356bd281a Documented the "debug_connection" directive. Ruslan Ermilov <ru@nginx.com> parents: 469 diff changeset	74 <note>
8e1356bd281a Documented the "debug_connection" directive. Ruslan Ermilov <ru@nginx.com> parents: 469 diff changeset	75 For this directive to work, nginx needs to
8e1356bd281a Documented the "debug_connection" directive. Ruslan Ermilov <ru@nginx.com> parents: 469 diff changeset	76 be built with <literal>--with-debug</literal>.
8e1356bd281a Documented the "debug_connection" directive. Ruslan Ermilov <ru@nginx.com> parents: 469 diff changeset	77 </note>
8e1356bd281a Documented the "debug_connection" directive. Ruslan Ermilov <ru@nginx.com> parents: 469 diff changeset	78 </para>
8e1356bd281a Documented the "debug_connection" directive. Ruslan Ermilov <ru@nginx.com> parents: 469 diff changeset	79
8e1356bd281a Documented the "debug_connection" directive. Ruslan Ermilov <ru@nginx.com> parents: 469 diff changeset	80 </directive>
8e1356bd281a Documented the "debug_connection" directive. Ruslan Ermilov <ru@nginx.com> parents: 469 diff changeset	81
8e1356bd281a Documented the "debug_connection" directive. Ruslan Ermilov <ru@nginx.com> parents: 469 diff changeset	82
158 05e58829de2e Documented the "error_log" directive. Ruslan Ermilov <ru@nginx.com> parents: 102 diff changeset	83 <directive name="error_log">
05e58829de2e Documented the "error_log" directive. Ruslan Ermilov <ru@nginx.com> parents: 102 diff changeset	84 <syntax>
455 571b790ddf9e error_log: documented the special value "stderr" and default logging level. Ruslan Ermilov <ru@nginx.com> parents: 444 diff changeset	85 <value>file</value> \| <literal>stderr</literal>
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	86 [<literal>debug</literal> \|
4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	87 <literal>info</literal> \|
4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	88 <literal>notice</literal> \|
4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	89 <literal>warn</literal> \|
4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	90 <literal>error</literal> \|
4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	91 <literal>crit</literal> \|
4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	92 <literal>alert</literal> \|
4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	93 <literal>emerg</literal>]</syntax>
158 05e58829de2e Documented the "error_log" directive. Ruslan Ermilov <ru@nginx.com> parents: 102 diff changeset	94 <default>logs/error.log error</default>
05e58829de2e Documented the "error_log" directive. Ruslan Ermilov <ru@nginx.com> parents: 102 diff changeset	95 <context>main</context>
05e58829de2e Documented the "error_log" directive. Ruslan Ermilov <ru@nginx.com> parents: 102 diff changeset	96 <context>http</context>
05e58829de2e Documented the "error_log" directive. Ruslan Ermilov <ru@nginx.com> parents: 102 diff changeset	97 <context>server</context>
05e58829de2e Documented the "error_log" directive. Ruslan Ermilov <ru@nginx.com> parents: 102 diff changeset	98 <context>location</context>
05e58829de2e Documented the "error_log" directive. Ruslan Ermilov <ru@nginx.com> parents: 102 diff changeset	99
05e58829de2e Documented the "error_log" directive. Ruslan Ermilov <ru@nginx.com> parents: 102 diff changeset	100 <para>
05e58829de2e Documented the "error_log" directive. Ruslan Ermilov <ru@nginx.com> parents: 102 diff changeset	101 Configures logging.
05e58829de2e Documented the "error_log" directive. Ruslan Ermilov <ru@nginx.com> parents: 102 diff changeset	102 </para>
05e58829de2e Documented the "error_log" directive. Ruslan Ermilov <ru@nginx.com> parents: 102 diff changeset	103
05e58829de2e Documented the "error_log" directive. Ruslan Ermilov <ru@nginx.com> parents: 102 diff changeset	104 <para>
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	105 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	106 <!--
05e58829de2e Documented the "error_log" directive. Ruslan Ermilov <ru@nginx.com> parents: 102 diff changeset	107 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	108 -->
455 571b790ddf9e error_log: documented the special value "stderr" and default logging level. Ruslan Ermilov <ru@nginx.com> parents: 444 diff changeset	109 The special value <literal>stderr</literal> selects the standard error file.
158 05e58829de2e Documented the "error_log" directive. Ruslan Ermilov <ru@nginx.com> parents: 102 diff changeset	110 </para>
05e58829de2e Documented the "error_log" directive. Ruslan Ermilov <ru@nginx.com> parents: 102 diff changeset	111
05e58829de2e Documented the "error_log" directive. Ruslan Ermilov <ru@nginx.com> parents: 102 diff changeset	112 <para>
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	113 The second parameter determines the level of logging.
158 05e58829de2e Documented the "error_log" directive. Ruslan Ermilov <ru@nginx.com> parents: 102 diff changeset	114 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	115 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	116 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	117 For example, the default level <literal>error</literal> will
4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	118 cause <literal>error</literal>, <literal>crit</literal>,
4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	119 <literal>alert</literal>, and <literal>emerg</literal> messages
158 05e58829de2e Documented the "error_log" directive. Ruslan Ermilov <ru@nginx.com> parents: 102 diff changeset	120 to be logged.
455 571b790ddf9e error_log: documented the special value "stderr" and default logging level. Ruslan Ermilov <ru@nginx.com> parents: 444 diff changeset	121 If this parameter is omitted then <literal>error</literal> is used.
158 05e58829de2e Documented the "error_log" directive. Ruslan Ermilov <ru@nginx.com> parents: 102 diff changeset	122 <note>
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	123 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	124 be built with <literal>--with-debug</literal>.
158 05e58829de2e Documented the "error_log" directive. Ruslan Ermilov <ru@nginx.com> parents: 102 diff changeset	125 </note>
05e58829de2e Documented the "error_log" directive. Ruslan Ermilov <ru@nginx.com> parents: 102 diff changeset	126 </para>
05e58829de2e Documented the "error_log" directive. Ruslan Ermilov <ru@nginx.com> parents: 102 diff changeset	127
05e58829de2e Documented the "error_log" directive. Ruslan Ermilov <ru@nginx.com> parents: 102 diff changeset	128 </directive>
05e58829de2e Documented the "error_log" directive. Ruslan Ermilov <ru@nginx.com> parents: 102 diff changeset	129
05e58829de2e Documented the "error_log" directive. Ruslan Ermilov <ru@nginx.com> parents: 102 diff changeset	130
63 6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	131 <directive name="env">
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	132 <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	133 <default>TZ</default>
63 6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	134 <context>main</context>
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	135
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	136 <para>
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	137 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	138 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	139 <list type="bullet">
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	140
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	141 <listitem>
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	142 variable inheritance during a
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	143 <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	144 of an executable file;
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	145 </listitem>
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	146
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	147 <listitem>
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	148 use of variables by the module
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	149 <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	150 </listitem>
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	151
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	152 <listitem>
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	153 use of variables by worker processes.
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	154 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	155 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	156 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	157 using this directive.
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	158 An exception from this is an above mentioned
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	159 <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	160 of an executable file.
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	161 </listitem>
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 </list>
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	164 </para>
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	165
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	166 <para>
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	167 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	168 <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	169 unless configured explicitly.
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	170 </para>
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	171
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	172 <para>
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	173 Usage example:
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	174 <example>
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	175 env MALLOC_OPTIONS;
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	176 env PERL5LIB=/data/site/modules;
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	177 env OPENSSL_ALLOW_PROXY_CERTS=1;
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	178 </example>
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
444 43c84d19bf92 Added a note about the NGINX environment variable. Ruslan Ermilov <ru@nginx.com> parents: 289 diff changeset	181 <para>
43c84d19bf92 Added a note about the NGINX environment variable. Ruslan Ermilov <ru@nginx.com> parents: 289 diff changeset	182 <note>
43c84d19bf92 Added a note about the NGINX environment variable. Ruslan Ermilov <ru@nginx.com> parents: 289 diff changeset	183 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	184 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	185 </note>
43c84d19bf92 Added a note about the NGINX environment variable. Ruslan Ermilov <ru@nginx.com> parents: 289 diff changeset	186 </para>
43c84d19bf92 Added a note about the NGINX environment variable. Ruslan Ermilov <ru@nginx.com> parents: 289 diff changeset	187
63 6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	188 </directive>
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	189
249 0f43f2c32c0b Fixed some nits. Ruslan Ermilov <ru@nginx.com> parents: 226 diff changeset	190
556 345012910707 Documented the "events" and "use" directives. Ruslan Ermilov <ru@nginx.com> parents: 554 diff changeset	191 <directive name="events">
345012910707 Documented the "events" and "use" directives. Ruslan Ermilov <ru@nginx.com> parents: 554 diff changeset	192 <syntax block="yes"/>
345012910707 Documented the "events" and "use" directives. Ruslan Ermilov <ru@nginx.com> parents: 554 diff changeset	193 <default/>
345012910707 Documented the "events" and "use" directives. Ruslan Ermilov <ru@nginx.com> parents: 554 diff changeset	194 <context>main</context>
345012910707 Documented the "events" and "use" directives. Ruslan Ermilov <ru@nginx.com> parents: 554 diff changeset	195
345012910707 Documented the "events" and "use" directives. Ruslan Ermilov <ru@nginx.com> parents: 554 diff changeset	196 <para>
345012910707 Documented the "events" and "use" directives. Ruslan Ermilov <ru@nginx.com> parents: 554 diff changeset	197 Provides a configuration file context in which the directives that
345012910707 Documented the "events" and "use" directives. Ruslan Ermilov <ru@nginx.com> parents: 554 diff changeset	198 affect connection processing are specified.
345012910707 Documented the "events" and "use" directives. Ruslan Ermilov <ru@nginx.com> parents: 554 diff changeset	199 </para>
345012910707 Documented the "events" and "use" directives. Ruslan Ermilov <ru@nginx.com> parents: 554 diff changeset	200
345012910707 Documented the "events" and "use" directives. Ruslan Ermilov <ru@nginx.com> parents: 554 diff changeset	201 </directive>
345012910707 Documented the "events" and "use" directives. Ruslan Ermilov <ru@nginx.com> parents: 554 diff changeset	202
345012910707 Documented the "events" and "use" directives. Ruslan Ermilov <ru@nginx.com> parents: 554 diff changeset	203
63 6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	204 <directive name="include">
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	205 <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	206 <default/>
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	207 <context/>
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	208
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	209 <para>
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	210 Includes another <value>file</value>, or files matching the
4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	211 specified <value>mask</value>, into configuration.
63 6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	212 Included files should consist of
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	213 syntactically correct directives and blocks.
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	214 </para>
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	215
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	216 <para>
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	217 Usage example:
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	218 <example>
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	219 include mime.types;
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	220 include vhosts/*.conf;
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	221 </example>
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	222 </para>
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>
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	225
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	226
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	227 <directive name="master_process">
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	228 <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	229 <default>on</default>
63 6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	230 <context>main</context>
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	231
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	232 <para>
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	233 Determines whether worker processes are started.
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	234 This directive is intended for nginx developers.
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	235 </para>
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	236
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	237 </directive>
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	238
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	239
289 df261b1ce71f Documented the --with-pcre-jit configuration parameter Ruslan Ermilov <ru@nginx.com> parents: 271 diff changeset	240 <directive name="pcre_jit">
df261b1ce71f Documented the --with-pcre-jit configuration parameter Ruslan Ermilov <ru@nginx.com> parents: 271 diff changeset	241 <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	242 <default>off</default>
df261b1ce71f Documented the --with-pcre-jit configuration parameter Ruslan Ermilov <ru@nginx.com> parents: 271 diff changeset	243 <context>main</context>
df261b1ce71f Documented the --with-pcre-jit configuration parameter Ruslan Ermilov <ru@nginx.com> parents: 271 diff changeset	244 <appeared-in>1.1.12</appeared-in>
df261b1ce71f Documented the --with-pcre-jit configuration parameter Ruslan Ermilov <ru@nginx.com> parents: 271 diff changeset	245
df261b1ce71f Documented the --with-pcre-jit configuration parameter Ruslan Ermilov <ru@nginx.com> parents: 271 diff changeset	246 <para>
df261b1ce71f Documented the --with-pcre-jit configuration parameter Ruslan Ermilov <ru@nginx.com> parents: 271 diff changeset	247 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	248 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	249 </para>
df261b1ce71f Documented the --with-pcre-jit configuration parameter Ruslan Ermilov <ru@nginx.com> parents: 271 diff changeset	250
df261b1ce71f Documented the --with-pcre-jit configuration parameter Ruslan Ermilov <ru@nginx.com> parents: 271 diff changeset	251 <para>
df261b1ce71f Documented the --with-pcre-jit configuration parameter Ruslan Ermilov <ru@nginx.com> parents: 271 diff changeset	252 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	253 <note>
df261b1ce71f Documented the --with-pcre-jit configuration parameter Ruslan Ermilov <ru@nginx.com> parents: 271 diff changeset	254 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	255 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	256 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	257 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	258 <literal>--with-pcre-jit</literal> configuration parameter.
df261b1ce71f Documented the --with-pcre-jit configuration parameter Ruslan Ermilov <ru@nginx.com> parents: 271 diff changeset	259 </note>
df261b1ce71f Documented the --with-pcre-jit configuration parameter Ruslan Ermilov <ru@nginx.com> parents: 271 diff changeset	260 </para>
df261b1ce71f Documented the --with-pcre-jit configuration parameter Ruslan Ermilov <ru@nginx.com> parents: 271 diff changeset	261
df261b1ce71f Documented the --with-pcre-jit configuration parameter Ruslan Ermilov <ru@nginx.com> parents: 271 diff changeset	262 </directive>
df261b1ce71f Documented the --with-pcre-jit configuration parameter Ruslan Ermilov <ru@nginx.com> parents: 271 diff changeset	263
df261b1ce71f Documented the --with-pcre-jit configuration parameter Ruslan Ermilov <ru@nginx.com> parents: 271 diff changeset	264
63 6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	265 <directive name="pid">
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	266 <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	267 <default>nginx.pid</default>
63 6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	268 <context>main</context>
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	269
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	270 <para>
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	271 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	272 </para>
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	273
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	274 </directive>
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
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	277 <directive name="ssl_engine">
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	278 <syntax><value>device</value></syntax>
63 6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	279 <default/>
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	280 <context>main</context>
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	281
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	282 <para>
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	283 Defines the name of the hardware SSL accelerator.
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	284 </para>
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	285
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	286 </directive>
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	287
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	288
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	289 <directive name="timer_resolution">
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	290 <syntax><value>interval</value></syntax>
63 6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	291 <default/>
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	292 <context>main</context>
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 <para>
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	295 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	296 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	297 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	298 on receiving a kernel event.
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	299 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	300 called once per specified <value>interval</value>.
63 6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	301 </para>
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	302
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	303 <para>
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	304 Example:
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	305 <example>
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	306 timer_resolution 100ms;
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	307 </example>
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	308 </para>
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	309
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	310 <para>
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	311 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	312 <list type="bullet">
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 <listitem>
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	315 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	316 </listitem>
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	317
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	318 <listitem>
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	319 <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	320 </listitem>
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 <listitem>
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	323 <c-func>setitimer</c-func> otherwise.
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	324 </listitem>
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	325
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	326 </list>
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	327 </para>
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	328
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	329 </directive>
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	330
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	331
556 345012910707 Documented the "events" and "use" directives. Ruslan Ermilov <ru@nginx.com> parents: 554 diff changeset	332 <directive name="use">
345012910707 Documented the "events" and "use" directives. Ruslan Ermilov <ru@nginx.com> parents: 554 diff changeset	333 <syntax><value>method</value></syntax>
345012910707 Documented the "events" and "use" directives. Ruslan Ermilov <ru@nginx.com> parents: 554 diff changeset	334 <default/>
345012910707 Documented the "events" and "use" directives. Ruslan Ermilov <ru@nginx.com> parents: 554 diff changeset	335 <context>events</context>
345012910707 Documented the "events" and "use" directives. Ruslan Ermilov <ru@nginx.com> parents: 554 diff changeset	336
345012910707 Documented the "events" and "use" directives. Ruslan Ermilov <ru@nginx.com> parents: 554 diff changeset	337 <para>
345012910707 Documented the "events" and "use" directives. Ruslan Ermilov <ru@nginx.com> parents: 554 diff changeset	338 Specifies the <link doc="events.xml">connection processing</link>
345012910707 Documented the "events" and "use" directives. Ruslan Ermilov <ru@nginx.com> parents: 554 diff changeset	339 <value>method</value> to use.
345012910707 Documented the "events" and "use" directives. Ruslan Ermilov <ru@nginx.com> parents: 554 diff changeset	340 There is normally no need to specify it explicitly because nginx will
345012910707 Documented the "events" and "use" directives. Ruslan Ermilov <ru@nginx.com> parents: 554 diff changeset	341 by default use the most efficient method.
345012910707 Documented the "events" and "use" directives. Ruslan Ermilov <ru@nginx.com> parents: 554 diff changeset	342 </para>
345012910707 Documented the "events" and "use" directives. Ruslan Ermilov <ru@nginx.com> parents: 554 diff changeset	343
345012910707 Documented the "events" and "use" directives. Ruslan Ermilov <ru@nginx.com> parents: 554 diff changeset	344 </directive>
345012910707 Documented the "events" and "use" directives. Ruslan Ermilov <ru@nginx.com> parents: 554 diff changeset	345
345012910707 Documented the "events" and "use" directives. Ruslan Ermilov <ru@nginx.com> parents: 554 diff changeset	346
82 89c31b453d40 Sorted directives alphabetically. Ruslan Ermilov <ru@nginx.com> parents: 63 diff changeset	347 <directive name="user">
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	348 <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	349 <default>nobody nobody</default>
63 6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	350 <context>main</context>
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	351
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	352 <para>
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	353 Defines <value>user</value> and <value>group</value>
82 89c31b453d40 Sorted directives alphabetically. Ruslan Ermilov <ru@nginx.com> parents: 63 diff changeset	354 credentials used by worker processes.
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	355 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	356 that of <value>user</value> is used.
63 6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	357 </para>
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	358
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	359 </directive>
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	360
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	361
545 e97b46d1842d Documented the "worker_connections" directive. Ruslan Ermilov <ru@nginx.com> parents: 523 diff changeset	362 <directive name="worker_connections">
e97b46d1842d Documented the "worker_connections" directive. Ruslan Ermilov <ru@nginx.com> parents: 523 diff changeset	363 <syntax><value>number</value></syntax>
e97b46d1842d Documented the "worker_connections" directive. Ruslan Ermilov <ru@nginx.com> parents: 523 diff changeset	364 <default>512</default>
e97b46d1842d Documented the "worker_connections" directive. Ruslan Ermilov <ru@nginx.com> parents: 523 diff changeset	365 <context>events</context>
e97b46d1842d Documented the "worker_connections" directive. Ruslan Ermilov <ru@nginx.com> parents: 523 diff changeset	366
e97b46d1842d Documented the "worker_connections" directive. Ruslan Ermilov <ru@nginx.com> parents: 523 diff changeset	367 <para>
e97b46d1842d Documented the "worker_connections" directive. Ruslan Ermilov <ru@nginx.com> parents: 523 diff changeset	368 Sets the maximum number of simultaneous connections that
e97b46d1842d Documented the "worker_connections" directive. Ruslan Ermilov <ru@nginx.com> parents: 523 diff changeset	369 can be opened by a worker process.
e97b46d1842d Documented the "worker_connections" directive. Ruslan Ermilov <ru@nginx.com> parents: 523 diff changeset	370 </para>
e97b46d1842d Documented the "worker_connections" directive. Ruslan Ermilov <ru@nginx.com> parents: 523 diff changeset	371
e97b46d1842d Documented the "worker_connections" directive. Ruslan Ermilov <ru@nginx.com> parents: 523 diff changeset	372 <para>
e97b46d1842d Documented the "worker_connections" directive. Ruslan Ermilov <ru@nginx.com> parents: 523 diff changeset	373 It should be kept in mind that this number includes all connections
e97b46d1842d Documented the "worker_connections" directive. Ruslan Ermilov <ru@nginx.com> parents: 523 diff changeset	374 (e.g. connections with proxied servers, among other things),
e97b46d1842d Documented the "worker_connections" directive. Ruslan Ermilov <ru@nginx.com> parents: 523 diff changeset	375 not only connections with clients.
e97b46d1842d Documented the "worker_connections" directive. Ruslan Ermilov <ru@nginx.com> parents: 523 diff changeset	376 Another consideration is that the actual number of simultaneous
e97b46d1842d Documented the "worker_connections" directive. Ruslan Ermilov <ru@nginx.com> parents: 523 diff changeset	377 connections may not exceed the current limit on
e97b46d1842d Documented the "worker_connections" directive. Ruslan Ermilov <ru@nginx.com> parents: 523 diff changeset	378 the maximum number of open files, see
e97b46d1842d Documented the "worker_connections" directive. Ruslan Ermilov <ru@nginx.com> parents: 523 diff changeset	379 <link id="worker_rlimit_nofile"/>.
e97b46d1842d Documented the "worker_connections" directive. Ruslan Ermilov <ru@nginx.com> parents: 523 diff changeset	380 </para>
e97b46d1842d Documented the "worker_connections" directive. Ruslan Ermilov <ru@nginx.com> parents: 523 diff changeset	381
e97b46d1842d Documented the "worker_connections" directive. Ruslan Ermilov <ru@nginx.com> parents: 523 diff changeset	382 </directive>
e97b46d1842d Documented the "worker_connections" directive. Ruslan Ermilov <ru@nginx.com> parents: 523 diff changeset	383
e97b46d1842d Documented the "worker_connections" directive. Ruslan Ermilov <ru@nginx.com> parents: 523 diff changeset	384
469 8275e169f77b Documented the "worker_cpu_affinity" directive. Ruslan Ermilov <ru@nginx.com> parents: 455 diff changeset	385 <directive name="worker_cpu_affinity">
8275e169f77b Documented the "worker_cpu_affinity" directive. Ruslan Ermilov <ru@nginx.com> parents: 455 diff changeset	386 <syntax><value>cpumask</value> ...</syntax>
8275e169f77b Documented the "worker_cpu_affinity" directive. Ruslan Ermilov <ru@nginx.com> parents: 455 diff changeset	387 <default/>
8275e169f77b Documented the "worker_cpu_affinity" directive. Ruslan Ermilov <ru@nginx.com> parents: 455 diff changeset	388 <context>main</context>
8275e169f77b Documented the "worker_cpu_affinity" directive. Ruslan Ermilov <ru@nginx.com> parents: 455 diff changeset	389
8275e169f77b Documented the "worker_cpu_affinity" directive. Ruslan Ermilov <ru@nginx.com> parents: 455 diff changeset	390 <para>
8275e169f77b Documented the "worker_cpu_affinity" directive. Ruslan Ermilov <ru@nginx.com> parents: 455 diff changeset	391 Binds worker processes to the sets of CPUs.
8275e169f77b Documented the "worker_cpu_affinity" directive. Ruslan Ermilov <ru@nginx.com> parents: 455 diff changeset	392 Each CPU set is represented by a bitmask of allowed to use CPUs.
8275e169f77b Documented the "worker_cpu_affinity" directive. Ruslan Ermilov <ru@nginx.com> parents: 455 diff changeset	393 There should be a separate set defined for each of the worker processes.
8275e169f77b Documented the "worker_cpu_affinity" directive. Ruslan Ermilov <ru@nginx.com> parents: 455 diff changeset	394 By default, worker processes are not bound to any specific CPUs.
8275e169f77b Documented the "worker_cpu_affinity" directive. Ruslan Ermilov <ru@nginx.com> parents: 455 diff changeset	395 </para>
8275e169f77b Documented the "worker_cpu_affinity" directive. Ruslan Ermilov <ru@nginx.com> parents: 455 diff changeset	396
8275e169f77b Documented the "worker_cpu_affinity" directive. Ruslan Ermilov <ru@nginx.com> parents: 455 diff changeset	397 <para>
8275e169f77b Documented the "worker_cpu_affinity" directive. Ruslan Ermilov <ru@nginx.com> parents: 455 diff changeset	398 For example,
8275e169f77b Documented the "worker_cpu_affinity" directive. Ruslan Ermilov <ru@nginx.com> parents: 455 diff changeset	399 <example>
8275e169f77b Documented the "worker_cpu_affinity" directive. Ruslan Ermilov <ru@nginx.com> parents: 455 diff changeset	400 worker_processes 4;
8275e169f77b Documented the "worker_cpu_affinity" directive. Ruslan Ermilov <ru@nginx.com> parents: 455 diff changeset	401 worker_cpu_affinity 0001 0010 0100 1000;
8275e169f77b Documented the "worker_cpu_affinity" directive. Ruslan Ermilov <ru@nginx.com> parents: 455 diff changeset	402 </example>
8275e169f77b Documented the "worker_cpu_affinity" directive. Ruslan Ermilov <ru@nginx.com> parents: 455 diff changeset	403 binds each worker process to a separate CPU, while
8275e169f77b Documented the "worker_cpu_affinity" directive. Ruslan Ermilov <ru@nginx.com> parents: 455 diff changeset	404 <example>
8275e169f77b Documented the "worker_cpu_affinity" directive. Ruslan Ermilov <ru@nginx.com> parents: 455 diff changeset	405 worker_processes 2;
8275e169f77b Documented the "worker_cpu_affinity" directive. Ruslan Ermilov <ru@nginx.com> parents: 455 diff changeset	406 worker_cpu_affinity 0101 1010;
8275e169f77b Documented the "worker_cpu_affinity" directive. Ruslan Ermilov <ru@nginx.com> parents: 455 diff changeset	407 </example>
8275e169f77b Documented the "worker_cpu_affinity" directive. Ruslan Ermilov <ru@nginx.com> parents: 455 diff changeset	408 binds the first worker process to CPU0/CPU2,
8275e169f77b Documented the "worker_cpu_affinity" directive. Ruslan Ermilov <ru@nginx.com> parents: 455 diff changeset	409 and the second worker process to CPU1/CPU3.
8275e169f77b Documented the "worker_cpu_affinity" directive. Ruslan Ermilov <ru@nginx.com> parents: 455 diff changeset	410 The second example is suitable for hyper-threading.
8275e169f77b Documented the "worker_cpu_affinity" directive. Ruslan Ermilov <ru@nginx.com> parents: 455 diff changeset	411 </para>
8275e169f77b Documented the "worker_cpu_affinity" directive. Ruslan Ermilov <ru@nginx.com> parents: 455 diff changeset	412
8275e169f77b Documented the "worker_cpu_affinity" directive. Ruslan Ermilov <ru@nginx.com> parents: 455 diff changeset	413 <para>
8275e169f77b Documented the "worker_cpu_affinity" directive. Ruslan Ermilov <ru@nginx.com> parents: 455 diff changeset	414 <note>
8275e169f77b Documented the "worker_cpu_affinity" directive. Ruslan Ermilov <ru@nginx.com> parents: 455 diff changeset	415 The directive is only available on FreeBSD and Linux.
8275e169f77b Documented the "worker_cpu_affinity" directive. Ruslan Ermilov <ru@nginx.com> parents: 455 diff changeset	416 </note>
8275e169f77b Documented the "worker_cpu_affinity" directive. Ruslan Ermilov <ru@nginx.com> parents: 455 diff changeset	417 </para>
8275e169f77b Documented the "worker_cpu_affinity" directive. Ruslan Ermilov <ru@nginx.com> parents: 455 diff changeset	418
8275e169f77b Documented the "worker_cpu_affinity" directive. Ruslan Ermilov <ru@nginx.com> parents: 455 diff changeset	419 </directive>
8275e169f77b Documented the "worker_cpu_affinity" directive. Ruslan Ermilov <ru@nginx.com> parents: 455 diff changeset	420
8275e169f77b Documented the "worker_cpu_affinity" directive. Ruslan Ermilov <ru@nginx.com> parents: 455 diff changeset	421
63 6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	422 <directive name="worker_priority">
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	423 <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	424 <default>0</default>
63 6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	425 <context>main</context>
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	426
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	427 <para>
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	428 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	429 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	430 <value>number</value>
63 6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	431 means higher priority.
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	432 Allowed range normally varies from -20 to 20.
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	433 </para>
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	434
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	435 <para>
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	436 Example:
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	437 <example>
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	438 worker_priority -10;
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	439 </example>
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	440 </para>
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	441
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	442 </directive>
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	443
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	444
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	445 <directive name="worker_processes">
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	446 <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	447 <default>1</default>
63 6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	448 <context>main</context>
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	449
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	450 <para>
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	451 Defines the number of worker processes.
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	452 </para>
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	453
226 c4b33b07dcfe Added some basic hints on how to tune "worker_processes". Ruslan Ermilov <ru@nginx.com> parents: 158 diff changeset	454 <para>
c4b33b07dcfe Added some basic hints on how to tune "worker_processes". Ruslan Ermilov <ru@nginx.com> parents: 158 diff changeset	455 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	456 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	457 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	458 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	459 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	460 </para>
c4b33b07dcfe Added some basic hints on how to tune "worker_processes". Ruslan Ermilov <ru@nginx.com> parents: 158 diff changeset	461
63 6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	462 </directive>
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	463
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	464
82 89c31b453d40 Sorted directives alphabetically. Ruslan Ermilov <ru@nginx.com> parents: 63 diff changeset	465 <directive name="worker_rlimit_core">
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	466 <syntax><value>size</value></syntax>
82 89c31b453d40 Sorted directives alphabetically. Ruslan Ermilov <ru@nginx.com> parents: 63 diff changeset	467 <default/>
89c31b453d40 Sorted directives alphabetically. Ruslan Ermilov <ru@nginx.com> parents: 63 diff changeset	468 <context>main</context>
89c31b453d40 Sorted directives alphabetically. Ruslan Ermilov <ru@nginx.com> parents: 63 diff changeset	469
89c31b453d40 Sorted directives alphabetically. Ruslan Ermilov <ru@nginx.com> parents: 63 diff changeset	470 <para>
89c31b453d40 Sorted directives alphabetically. Ruslan Ermilov <ru@nginx.com> parents: 63 diff changeset	471 Changes the limit on the largest size of a core file
89c31b453d40 Sorted directives alphabetically. Ruslan Ermilov <ru@nginx.com> parents: 63 diff changeset	472 (<c-def>RLIMIT_CORE</c-def>) for worker processes.
89c31b453d40 Sorted directives alphabetically. Ruslan Ermilov <ru@nginx.com> parents: 63 diff changeset	473 Used to increase the limit without restarting the main process.
89c31b453d40 Sorted directives alphabetically. Ruslan Ermilov <ru@nginx.com> parents: 63 diff changeset	474 </para>
89c31b453d40 Sorted directives alphabetically. Ruslan Ermilov <ru@nginx.com> parents: 63 diff changeset	475
89c31b453d40 Sorted directives alphabetically. Ruslan Ermilov <ru@nginx.com> parents: 63 diff changeset	476 </directive>
89c31b453d40 Sorted directives alphabetically. Ruslan Ermilov <ru@nginx.com> parents: 63 diff changeset	477
89c31b453d40 Sorted directives alphabetically. Ruslan Ermilov <ru@nginx.com> parents: 63 diff changeset	478
89c31b453d40 Sorted directives alphabetically. Ruslan Ermilov <ru@nginx.com> parents: 63 diff changeset	479 <directive name="worker_rlimit_nofile">
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	480 <syntax><value>number</value></syntax>
82 89c31b453d40 Sorted directives alphabetically. Ruslan Ermilov <ru@nginx.com> parents: 63 diff changeset	481 <default/>
89c31b453d40 Sorted directives alphabetically. Ruslan Ermilov <ru@nginx.com> parents: 63 diff changeset	482 <context>main</context>
89c31b453d40 Sorted directives alphabetically. Ruslan Ermilov <ru@nginx.com> parents: 63 diff changeset	483
89c31b453d40 Sorted directives alphabetically. Ruslan Ermilov <ru@nginx.com> parents: 63 diff changeset	484 <para>
89c31b453d40 Sorted directives alphabetically. Ruslan Ermilov <ru@nginx.com> parents: 63 diff changeset	485 Changes the limit on the maximum number of open files
89c31b453d40 Sorted directives alphabetically. Ruslan Ermilov <ru@nginx.com> parents: 63 diff changeset	486 (<c-def>RLIMIT_NOFILE</c-def>) for worker processes.
89c31b453d40 Sorted directives alphabetically. Ruslan Ermilov <ru@nginx.com> parents: 63 diff changeset	487 Used to increase the limit without restarting the main process.
89c31b453d40 Sorted directives alphabetically. Ruslan Ermilov <ru@nginx.com> parents: 63 diff changeset	488 </para>
89c31b453d40 Sorted directives alphabetically. Ruslan Ermilov <ru@nginx.com> parents: 63 diff changeset	489
89c31b453d40 Sorted directives alphabetically. Ruslan Ermilov <ru@nginx.com> parents: 63 diff changeset	490 </directive>
89c31b453d40 Sorted directives alphabetically. Ruslan Ermilov <ru@nginx.com> parents: 63 diff changeset	491
89c31b453d40 Sorted directives alphabetically. Ruslan Ermilov <ru@nginx.com> parents: 63 diff changeset	492
554 ccb7451af1d8 Documented the "worker_rlimit_sigpending" directive. Ruslan Ermilov <ru@nginx.com> parents: 545 diff changeset	493 <directive name="worker_rlimit_sigpending">
ccb7451af1d8 Documented the "worker_rlimit_sigpending" directive. Ruslan Ermilov <ru@nginx.com> parents: 545 diff changeset	494 <syntax><value>number</value></syntax>
ccb7451af1d8 Documented the "worker_rlimit_sigpending" directive. Ruslan Ermilov <ru@nginx.com> parents: 545 diff changeset	495 <default/>
ccb7451af1d8 Documented the "worker_rlimit_sigpending" directive. Ruslan Ermilov <ru@nginx.com> parents: 545 diff changeset	496 <context>main</context>
ccb7451af1d8 Documented the "worker_rlimit_sigpending" directive. Ruslan Ermilov <ru@nginx.com> parents: 545 diff changeset	497
ccb7451af1d8 Documented the "worker_rlimit_sigpending" directive. Ruslan Ermilov <ru@nginx.com> parents: 545 diff changeset	498 <para>
ccb7451af1d8 Documented the "worker_rlimit_sigpending" directive. Ruslan Ermilov <ru@nginx.com> parents: 545 diff changeset	499 On systems that support <link doc="events.xml" id="rtsig"/>
ccb7451af1d8 Documented the "worker_rlimit_sigpending" directive. Ruslan Ermilov <ru@nginx.com> parents: 545 diff changeset	500 connection processing method,
ccb7451af1d8 Documented the "worker_rlimit_sigpending" directive. Ruslan Ermilov <ru@nginx.com> parents: 545 diff changeset	501 changes the limit on the number of signals that may be queued
ccb7451af1d8 Documented the "worker_rlimit_sigpending" directive. Ruslan Ermilov <ru@nginx.com> parents: 545 diff changeset	502 (<c-def>RLIMIT_SIGPENDING</c-def>) for worker processes.
ccb7451af1d8 Documented the "worker_rlimit_sigpending" directive. Ruslan Ermilov <ru@nginx.com> parents: 545 diff changeset	503 Used to increase the limit without restarting the main process.
ccb7451af1d8 Documented the "worker_rlimit_sigpending" directive. Ruslan Ermilov <ru@nginx.com> parents: 545 diff changeset	504 </para>
ccb7451af1d8 Documented the "worker_rlimit_sigpending" directive. Ruslan Ermilov <ru@nginx.com> parents: 545 diff changeset	505
ccb7451af1d8 Documented the "worker_rlimit_sigpending" directive. Ruslan Ermilov <ru@nginx.com> parents: 545 diff changeset	506 </directive>
ccb7451af1d8 Documented the "worker_rlimit_sigpending" directive. Ruslan Ermilov <ru@nginx.com> parents: 545 diff changeset	507
ccb7451af1d8 Documented the "worker_rlimit_sigpending" directive. Ruslan Ermilov <ru@nginx.com> parents: 545 diff changeset	508
63 6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	509 <directive name="working_directory">
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	510 <syntax><value>directory</value></syntax>
63 6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	511 <default/>
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	512 <context>main</context>
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	513
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	514 <para>
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	515 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	516 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	517 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	518 specified directory.
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	519 </para>
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	520
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	521 </directive>
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	522
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	523 </section>
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	524
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	525 </module>

Mercurial > hg > nginx-site

annotate xml/en/docs/ngx_core_module.xml @ 556:345012910707