nginx-site: xml/en/docs/ngx_core

annotate xml/en/docs/ngx_core_module.xml @ 516:8e1356bd281a

Documented the "debug_connection" directive.

author	Ruslan Ermilov <ru@nginx.com>
date	Mon, 14 May 2012 11:29:39 +0000
parents	8275e169f77b
children	a8daad8e83bb

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.
8e1356bd281a Documented the "debug_connection" directive. Ruslan Ermilov <ru@nginx.com> parents: 469 diff changeset	57 Debugged connections are specified by IPv4 or IPv6 (1.3.0) address or network.
8e1356bd281a Documented the "debug_connection" directive. Ruslan Ermilov <ru@nginx.com> parents: 469 diff changeset	58 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	59 first IPv4 address corresponding to a name is used.
8e1356bd281a Documented the "debug_connection" directive. Ruslan Ermilov <ru@nginx.com> parents: 469 diff changeset	60 For connections using UNIX-domain sockets (1.3.0), debugging log is enabled
8e1356bd281a Documented the "debug_connection" directive. Ruslan Ermilov <ru@nginx.com> parents: 469 diff changeset	61 by the “<literal>unix:</literal>” parameter.
8e1356bd281a Documented the "debug_connection" directive. Ruslan Ermilov <ru@nginx.com> parents: 469 diff changeset	62 <example>
8e1356bd281a Documented the "debug_connection" directive. Ruslan Ermilov <ru@nginx.com> parents: 469 diff changeset	63 events {
8e1356bd281a Documented the "debug_connection" directive. Ruslan Ermilov <ru@nginx.com> parents: 469 diff changeset	64 debug_connection 127.0.0.1;
8e1356bd281a Documented the "debug_connection" directive. Ruslan Ermilov <ru@nginx.com> parents: 469 diff changeset	65 debug_connection localhost;
8e1356bd281a Documented the "debug_connection" directive. Ruslan Ermilov <ru@nginx.com> parents: 469 diff changeset	66 debug_connection 192.0.2.0/24;
8e1356bd281a Documented the "debug_connection" directive. Ruslan Ermilov <ru@nginx.com> parents: 469 diff changeset	67 debug_connection ::1;
8e1356bd281a Documented the "debug_connection" directive. Ruslan Ermilov <ru@nginx.com> parents: 469 diff changeset	68 debug_connection 2001:0db8::/32;
8e1356bd281a Documented the "debug_connection" directive. Ruslan Ermilov <ru@nginx.com> parents: 469 diff changeset	69 debug_connection unix:;
8e1356bd281a Documented the "debug_connection" directive. Ruslan Ermilov <ru@nginx.com> parents: 469 diff changeset	70 ...
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 </example>
8e1356bd281a Documented the "debug_connection" directive. Ruslan Ermilov <ru@nginx.com> parents: 469 diff changeset	73 <note>
8e1356bd281a Documented the "debug_connection" directive. Ruslan Ermilov <ru@nginx.com> parents: 469 diff changeset	74 For this directive to work, nginx needs to
8e1356bd281a Documented the "debug_connection" directive. Ruslan Ermilov <ru@nginx.com> parents: 469 diff changeset	75 be built with <literal>--with-debug</literal>.
8e1356bd281a Documented the "debug_connection" directive. Ruslan Ermilov <ru@nginx.com> parents: 469 diff changeset	76 </note>
8e1356bd281a Documented the "debug_connection" directive. Ruslan Ermilov <ru@nginx.com> parents: 469 diff changeset	77 </para>
8e1356bd281a Documented the "debug_connection" directive. Ruslan Ermilov <ru@nginx.com> parents: 469 diff changeset	78
8e1356bd281a Documented the "debug_connection" directive. Ruslan Ermilov <ru@nginx.com> parents: 469 diff changeset	79 </directive>
8e1356bd281a Documented the "debug_connection" directive. Ruslan Ermilov <ru@nginx.com> parents: 469 diff changeset	80
8e1356bd281a Documented the "debug_connection" directive. Ruslan Ermilov <ru@nginx.com> parents: 469 diff changeset	81
158 05e58829de2e Documented the "error_log" directive. Ruslan Ermilov <ru@nginx.com> parents: 102 diff changeset	82 <directive name="error_log">
05e58829de2e Documented the "error_log" directive. Ruslan Ermilov <ru@nginx.com> parents: 102 diff changeset	83 <syntax>
455 571b790ddf9e error_log: documented the special value "stderr" and default logging level. Ruslan Ermilov <ru@nginx.com> parents: 444 diff changeset	84 <value>file</value> \| <literal>stderr</literal>
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	85 [<literal>debug</literal> \|
4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	86 <literal>info</literal> \|
4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	87 <literal>notice</literal> \|
4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	88 <literal>warn</literal> \|
4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	89 <literal>error</literal> \|
4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	90 <literal>crit</literal> \|
4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	91 <literal>alert</literal> \|
4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	92 <literal>emerg</literal>]</syntax>
158 05e58829de2e Documented the "error_log" directive. Ruslan Ermilov <ru@nginx.com> parents: 102 diff changeset	93 <default>logs/error.log error</default>
05e58829de2e Documented the "error_log" directive. Ruslan Ermilov <ru@nginx.com> parents: 102 diff changeset	94 <context>main</context>
05e58829de2e Documented the "error_log" directive. Ruslan Ermilov <ru@nginx.com> parents: 102 diff changeset	95 <context>http</context>
05e58829de2e Documented the "error_log" directive. Ruslan Ermilov <ru@nginx.com> parents: 102 diff changeset	96 <context>server</context>
05e58829de2e Documented the "error_log" directive. Ruslan Ermilov <ru@nginx.com> parents: 102 diff changeset	97 <context>location</context>
05e58829de2e Documented the "error_log" directive. Ruslan Ermilov <ru@nginx.com> parents: 102 diff changeset	98
05e58829de2e Documented the "error_log" directive. Ruslan Ermilov <ru@nginx.com> parents: 102 diff changeset	99 <para>
05e58829de2e Documented the "error_log" directive. Ruslan Ermilov <ru@nginx.com> parents: 102 diff changeset	100 Configures logging.
05e58829de2e Documented the "error_log" directive. Ruslan Ermilov <ru@nginx.com> parents: 102 diff changeset	101 </para>
05e58829de2e Documented the "error_log" directive. Ruslan Ermilov <ru@nginx.com> parents: 102 diff changeset	102
05e58829de2e Documented the "error_log" directive. Ruslan Ermilov <ru@nginx.com> parents: 102 diff changeset	103 <para>
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	104 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	105 <!--
05e58829de2e Documented the "error_log" directive. Ruslan Ermilov <ru@nginx.com> parents: 102 diff changeset	106 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	107 -->
455 571b790ddf9e error_log: documented the special value "stderr" and default logging level. Ruslan Ermilov <ru@nginx.com> parents: 444 diff changeset	108 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	109 </para>
05e58829de2e Documented the "error_log" directive. Ruslan Ermilov <ru@nginx.com> parents: 102 diff changeset	110
05e58829de2e Documented the "error_log" directive. Ruslan Ermilov <ru@nginx.com> parents: 102 diff changeset	111 <para>
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	112 The second parameter determines the level of logging.
158 05e58829de2e Documented the "error_log" directive. Ruslan Ermilov <ru@nginx.com> parents: 102 diff changeset	113 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	114 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	115 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	116 For example, the default level <literal>error</literal> will
4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	117 cause <literal>error</literal>, <literal>crit</literal>,
4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	118 <literal>alert</literal>, and <literal>emerg</literal> messages
158 05e58829de2e Documented the "error_log" directive. Ruslan Ermilov <ru@nginx.com> parents: 102 diff changeset	119 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	120 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	121 <note>
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	122 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	123 be built with <literal>--with-debug</literal>.
158 05e58829de2e Documented the "error_log" directive. Ruslan Ermilov <ru@nginx.com> parents: 102 diff changeset	124 </note>
05e58829de2e Documented the "error_log" directive. Ruslan Ermilov <ru@nginx.com> parents: 102 diff changeset	125 </para>
05e58829de2e Documented the "error_log" directive. Ruslan Ermilov <ru@nginx.com> parents: 102 diff changeset	126
05e58829de2e Documented the "error_log" directive. Ruslan Ermilov <ru@nginx.com> parents: 102 diff changeset	127 </directive>
05e58829de2e Documented the "error_log" directive. Ruslan Ermilov <ru@nginx.com> parents: 102 diff changeset	128
05e58829de2e Documented the "error_log" directive. Ruslan Ermilov <ru@nginx.com> parents: 102 diff changeset	129
63 6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	130 <directive name="env">
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	131 <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	132 <default>TZ</default>
63 6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	133 <context>main</context>
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	134
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	135 <para>
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	136 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	137 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	138 <list type="bullet">
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	139
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	140 <listitem>
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	141 variable inheritance during a
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	142 <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	143 of an executable file;
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	144 </listitem>
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	145
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	146 <listitem>
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	147 use of variables by the module
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	148 <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	149 </listitem>
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	150
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	151 <listitem>
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	152 use of variables by worker processes.
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	153 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	154 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	155 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	156 using this directive.
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	157 An exception from this is an above mentioned
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	158 <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	159 of an executable file.
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	160 </listitem>
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	161
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	162 </list>
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
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	165 <para>
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	166 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	167 <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	168 unless configured explicitly.
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 <para>
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	172 Usage example:
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	173 <example>
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	174 env MALLOC_OPTIONS;
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	175 env PERL5LIB=/data/site/modules;
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	176 env OPENSSL_ALLOW_PROXY_CERTS=1;
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	177 </example>
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	178 </para>
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	179
444 43c84d19bf92 Added a note about the NGINX environment variable. Ruslan Ermilov <ru@nginx.com> parents: 289 diff changeset	180 <para>
43c84d19bf92 Added a note about the NGINX environment variable. Ruslan Ermilov <ru@nginx.com> parents: 289 diff changeset	181 <note>
43c84d19bf92 Added a note about the NGINX environment variable. Ruslan Ermilov <ru@nginx.com> parents: 289 diff changeset	182 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	183 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	184 </note>
43c84d19bf92 Added a note about the NGINX environment variable. Ruslan Ermilov <ru@nginx.com> parents: 289 diff changeset	185 </para>
43c84d19bf92 Added a note about the NGINX environment variable. Ruslan Ermilov <ru@nginx.com> parents: 289 diff changeset	186
63 6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	187 </directive>
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	188
249 0f43f2c32c0b Fixed some nits. Ruslan Ermilov <ru@nginx.com> parents: 226 diff changeset	189
63 6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	190 <directive name="include">
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	191 <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	192 <default/>
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	193 <context/>
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	194
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	195 <para>
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	196 Includes another <value>file</value>, or files matching the
4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	197 specified <value>mask</value>, into configuration.
63 6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	198 Included files should consist of
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	199 syntactically correct directives and blocks.
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	200 </para>
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	201
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	202 <para>
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	203 Usage example:
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	204 <example>
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	205 include mime.types;
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	206 include vhosts/*.conf;
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	207 </example>
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	208 </para>
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	209
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	210 </directive>
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	211
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	212
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	213 <directive name="master_process">
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	214 <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	215 <default>on</default>
63 6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	216 <context>main</context>
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	217
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	218 <para>
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	219 Determines whether worker processes are started.
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	220 This directive is intended for nginx developers.
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	221 </para>
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 </directive>
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	224
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	225
289 df261b1ce71f Documented the --with-pcre-jit configuration parameter Ruslan Ermilov <ru@nginx.com> parents: 271 diff changeset	226 <directive name="pcre_jit">
df261b1ce71f Documented the --with-pcre-jit configuration parameter Ruslan Ermilov <ru@nginx.com> parents: 271 diff changeset	227 <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	228 <default>off</default>
df261b1ce71f Documented the --with-pcre-jit configuration parameter Ruslan Ermilov <ru@nginx.com> parents: 271 diff changeset	229 <context>main</context>
df261b1ce71f Documented the --with-pcre-jit configuration parameter Ruslan Ermilov <ru@nginx.com> parents: 271 diff changeset	230 <appeared-in>1.1.12</appeared-in>
df261b1ce71f Documented the --with-pcre-jit configuration parameter Ruslan Ermilov <ru@nginx.com> parents: 271 diff changeset	231
df261b1ce71f Documented the --with-pcre-jit configuration parameter Ruslan Ermilov <ru@nginx.com> parents: 271 diff changeset	232 <para>
df261b1ce71f Documented the --with-pcre-jit configuration parameter Ruslan Ermilov <ru@nginx.com> parents: 271 diff changeset	233 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	234 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	235 </para>
df261b1ce71f Documented the --with-pcre-jit configuration parameter Ruslan Ermilov <ru@nginx.com> parents: 271 diff changeset	236
df261b1ce71f Documented the --with-pcre-jit configuration parameter Ruslan Ermilov <ru@nginx.com> parents: 271 diff changeset	237 <para>
df261b1ce71f Documented the --with-pcre-jit configuration parameter Ruslan Ermilov <ru@nginx.com> parents: 271 diff changeset	238 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	239 <note>
df261b1ce71f Documented the --with-pcre-jit configuration parameter Ruslan Ermilov <ru@nginx.com> parents: 271 diff changeset	240 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	241 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	242 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	243 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	244 <literal>--with-pcre-jit</literal> configuration parameter.
df261b1ce71f Documented the --with-pcre-jit configuration parameter Ruslan Ermilov <ru@nginx.com> parents: 271 diff changeset	245 </note>
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
df261b1ce71f Documented the --with-pcre-jit configuration parameter Ruslan Ermilov <ru@nginx.com> parents: 271 diff changeset	248 </directive>
df261b1ce71f Documented the --with-pcre-jit configuration parameter Ruslan Ermilov <ru@nginx.com> parents: 271 diff changeset	249
df261b1ce71f Documented the --with-pcre-jit configuration parameter Ruslan Ermilov <ru@nginx.com> parents: 271 diff changeset	250
63 6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	251 <directive name="pid">
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	252 <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	253 <default>nginx.pid</default>
63 6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	254 <context>main</context>
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	255
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	256 <para>
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	257 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	258 </para>
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	259
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	260 </directive>
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	261
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	262
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	263 <directive name="ssl_engine">
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	264 <syntax><value>device</value></syntax>
63 6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	265 <default/>
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	266 <context>main</context>
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	267
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	268 <para>
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	269 Defines the name of the hardware SSL accelerator.
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	270 </para>
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	271
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	272 </directive>
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
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	275 <directive name="timer_resolution">
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	276 <syntax><value>interval</value></syntax>
63 6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	277 <default/>
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	278 <context>main</context>
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	279
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	280 <para>
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	281 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	282 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	283 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	284 on receiving a kernel event.
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	285 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	286 called once per specified <value>interval</value>.
63 6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	287 </para>
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 <para>
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	290 Example:
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	291 <example>
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	292 timer_resolution 100ms;
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	293 </example>
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
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	296 <para>
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	297 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	298 <list type="bullet">
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	299
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	300 <listitem>
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	301 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	302 </listitem>
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	303
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	304 <listitem>
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	305 <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	306 </listitem>
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	307
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	308 <listitem>
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	309 <c-func>setitimer</c-func> otherwise.
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	310 </listitem>
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	311
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	312 </list>
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	313 </para>
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	314
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	315 </directive>
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
82 89c31b453d40 Sorted directives alphabetically. Ruslan Ermilov <ru@nginx.com> parents: 63 diff changeset	318 <directive name="user">
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	319 <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	320 <default>nobody nobody</default>
63 6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	321 <context>main</context>
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	322
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	323 <para>
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	324 Defines <value>user</value> and <value>group</value>
82 89c31b453d40 Sorted directives alphabetically. Ruslan Ermilov <ru@nginx.com> parents: 63 diff changeset	325 credentials used by worker processes.
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	326 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	327 that of <value>user</value> is used.
63 6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	328 </para>
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	329
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	330 </directive>
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	331
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	332
469 8275e169f77b Documented the "worker_cpu_affinity" directive. Ruslan Ermilov <ru@nginx.com> parents: 455 diff changeset	333 <directive name="worker_cpu_affinity">
8275e169f77b Documented the "worker_cpu_affinity" directive. Ruslan Ermilov <ru@nginx.com> parents: 455 diff changeset	334 <syntax><value>cpumask</value> ...</syntax>
8275e169f77b Documented the "worker_cpu_affinity" directive. Ruslan Ermilov <ru@nginx.com> parents: 455 diff changeset	335 <default/>
8275e169f77b Documented the "worker_cpu_affinity" directive. Ruslan Ermilov <ru@nginx.com> parents: 455 diff changeset	336 <context>main</context>
8275e169f77b Documented the "worker_cpu_affinity" directive. Ruslan Ermilov <ru@nginx.com> parents: 455 diff changeset	337
8275e169f77b Documented the "worker_cpu_affinity" directive. Ruslan Ermilov <ru@nginx.com> parents: 455 diff changeset	338 <para>
8275e169f77b Documented the "worker_cpu_affinity" directive. Ruslan Ermilov <ru@nginx.com> parents: 455 diff changeset	339 Binds worker processes to the sets of CPUs.
8275e169f77b Documented the "worker_cpu_affinity" directive. Ruslan Ermilov <ru@nginx.com> parents: 455 diff changeset	340 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	341 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	342 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	343 </para>
8275e169f77b Documented the "worker_cpu_affinity" directive. Ruslan Ermilov <ru@nginx.com> parents: 455 diff changeset	344
8275e169f77b Documented the "worker_cpu_affinity" directive. Ruslan Ermilov <ru@nginx.com> parents: 455 diff changeset	345 <para>
8275e169f77b Documented the "worker_cpu_affinity" directive. Ruslan Ermilov <ru@nginx.com> parents: 455 diff changeset	346 For example,
8275e169f77b Documented the "worker_cpu_affinity" directive. Ruslan Ermilov <ru@nginx.com> parents: 455 diff changeset	347 <example>
8275e169f77b Documented the "worker_cpu_affinity" directive. Ruslan Ermilov <ru@nginx.com> parents: 455 diff changeset	348 worker_processes 4;
8275e169f77b Documented the "worker_cpu_affinity" directive. Ruslan Ermilov <ru@nginx.com> parents: 455 diff changeset	349 worker_cpu_affinity 0001 0010 0100 1000;
8275e169f77b Documented the "worker_cpu_affinity" directive. Ruslan Ermilov <ru@nginx.com> parents: 455 diff changeset	350 </example>
8275e169f77b Documented the "worker_cpu_affinity" directive. Ruslan Ermilov <ru@nginx.com> parents: 455 diff changeset	351 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	352 <example>
8275e169f77b Documented the "worker_cpu_affinity" directive. Ruslan Ermilov <ru@nginx.com> parents: 455 diff changeset	353 worker_processes 2;
8275e169f77b Documented the "worker_cpu_affinity" directive. Ruslan Ermilov <ru@nginx.com> parents: 455 diff changeset	354 worker_cpu_affinity 0101 1010;
8275e169f77b Documented the "worker_cpu_affinity" directive. Ruslan Ermilov <ru@nginx.com> parents: 455 diff changeset	355 </example>
8275e169f77b Documented the "worker_cpu_affinity" directive. Ruslan Ermilov <ru@nginx.com> parents: 455 diff changeset	356 binds the first worker process to CPU0/CPU2,
8275e169f77b Documented the "worker_cpu_affinity" directive. Ruslan Ermilov <ru@nginx.com> parents: 455 diff changeset	357 and the second worker process to CPU1/CPU3.
8275e169f77b Documented the "worker_cpu_affinity" directive. Ruslan Ermilov <ru@nginx.com> parents: 455 diff changeset	358 The second example is suitable for hyper-threading.
8275e169f77b Documented the "worker_cpu_affinity" directive. Ruslan Ermilov <ru@nginx.com> parents: 455 diff changeset	359 </para>
8275e169f77b Documented the "worker_cpu_affinity" directive. Ruslan Ermilov <ru@nginx.com> parents: 455 diff changeset	360
8275e169f77b Documented the "worker_cpu_affinity" directive. Ruslan Ermilov <ru@nginx.com> parents: 455 diff changeset	361 <para>
8275e169f77b Documented the "worker_cpu_affinity" directive. Ruslan Ermilov <ru@nginx.com> parents: 455 diff changeset	362 <note>
8275e169f77b Documented the "worker_cpu_affinity" directive. Ruslan Ermilov <ru@nginx.com> parents: 455 diff changeset	363 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	364 </note>
8275e169f77b Documented the "worker_cpu_affinity" directive. Ruslan Ermilov <ru@nginx.com> parents: 455 diff changeset	365 </para>
8275e169f77b Documented the "worker_cpu_affinity" directive. Ruslan Ermilov <ru@nginx.com> parents: 455 diff changeset	366
8275e169f77b Documented the "worker_cpu_affinity" directive. Ruslan Ermilov <ru@nginx.com> parents: 455 diff changeset	367 </directive>
8275e169f77b Documented the "worker_cpu_affinity" directive. Ruslan Ermilov <ru@nginx.com> parents: 455 diff changeset	368
8275e169f77b Documented the "worker_cpu_affinity" directive. Ruslan Ermilov <ru@nginx.com> parents: 455 diff changeset	369
63 6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	370 <directive name="worker_priority">
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	371 <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	372 <default>0</default>
63 6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	373 <context>main</context>
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	374
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 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	377 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	378 <value>number</value>
63 6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	379 means higher priority.
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	380 Allowed range normally varies from -20 to 20.
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	381 </para>
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	382
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	383 <para>
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	384 Example:
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	385 <example>
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	386 worker_priority -10;
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	387 </example>
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	388 </para>
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	389
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	390 </directive>
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	391
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	392
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	393 <directive name="worker_processes">
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	394 <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	395 <default>1</default>
63 6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	396 <context>main</context>
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	397
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	398 <para>
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	399 Defines the number of worker processes.
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	400 </para>
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	401
226 c4b33b07dcfe Added some basic hints on how to tune "worker_processes". Ruslan Ermilov <ru@nginx.com> parents: 158 diff changeset	402 <para>
c4b33b07dcfe Added some basic hints on how to tune "worker_processes". Ruslan Ermilov <ru@nginx.com> parents: 158 diff changeset	403 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	404 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	405 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	406 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	407 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	408 </para>
c4b33b07dcfe Added some basic hints on how to tune "worker_processes". Ruslan Ermilov <ru@nginx.com> parents: 158 diff changeset	409
63 6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	410 </directive>
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	411
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	412
82 89c31b453d40 Sorted directives alphabetically. Ruslan Ermilov <ru@nginx.com> parents: 63 diff changeset	413 <directive name="worker_rlimit_core">
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	414 <syntax><value>size</value></syntax>
82 89c31b453d40 Sorted directives alphabetically. Ruslan Ermilov <ru@nginx.com> parents: 63 diff changeset	415 <default/>
89c31b453d40 Sorted directives alphabetically. Ruslan Ermilov <ru@nginx.com> parents: 63 diff changeset	416 <context>main</context>
89c31b453d40 Sorted directives alphabetically. Ruslan Ermilov <ru@nginx.com> parents: 63 diff changeset	417
89c31b453d40 Sorted directives alphabetically. Ruslan Ermilov <ru@nginx.com> parents: 63 diff changeset	418 <para>
89c31b453d40 Sorted directives alphabetically. Ruslan Ermilov <ru@nginx.com> parents: 63 diff changeset	419 Changes the limit on the largest size of a core file
89c31b453d40 Sorted directives alphabetically. Ruslan Ermilov <ru@nginx.com> parents: 63 diff changeset	420 (<c-def>RLIMIT_CORE</c-def>) for worker processes.
89c31b453d40 Sorted directives alphabetically. Ruslan Ermilov <ru@nginx.com> parents: 63 diff changeset	421 Used to increase the limit without restarting the main process.
89c31b453d40 Sorted directives alphabetically. Ruslan Ermilov <ru@nginx.com> parents: 63 diff changeset	422 </para>
89c31b453d40 Sorted directives alphabetically. Ruslan Ermilov <ru@nginx.com> parents: 63 diff changeset	423
89c31b453d40 Sorted directives alphabetically. Ruslan Ermilov <ru@nginx.com> parents: 63 diff changeset	424 </directive>
89c31b453d40 Sorted directives alphabetically. Ruslan Ermilov <ru@nginx.com> parents: 63 diff changeset	425
89c31b453d40 Sorted directives alphabetically. Ruslan Ermilov <ru@nginx.com> parents: 63 diff changeset	426
89c31b453d40 Sorted directives alphabetically. Ruslan Ermilov <ru@nginx.com> parents: 63 diff changeset	427 <directive name="worker_rlimit_nofile">
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	428 <syntax><value>number</value></syntax>
82 89c31b453d40 Sorted directives alphabetically. Ruslan Ermilov <ru@nginx.com> parents: 63 diff changeset	429 <default/>
89c31b453d40 Sorted directives alphabetically. Ruslan Ermilov <ru@nginx.com> parents: 63 diff changeset	430 <context>main</context>
89c31b453d40 Sorted directives alphabetically. Ruslan Ermilov <ru@nginx.com> parents: 63 diff changeset	431
89c31b453d40 Sorted directives alphabetically. Ruslan Ermilov <ru@nginx.com> parents: 63 diff changeset	432 <para>
89c31b453d40 Sorted directives alphabetically. Ruslan Ermilov <ru@nginx.com> parents: 63 diff changeset	433 Changes the limit on the maximum number of open files
89c31b453d40 Sorted directives alphabetically. Ruslan Ermilov <ru@nginx.com> parents: 63 diff changeset	434 (<c-def>RLIMIT_NOFILE</c-def>) for worker processes.
89c31b453d40 Sorted directives alphabetically. Ruslan Ermilov <ru@nginx.com> parents: 63 diff changeset	435 Used to increase the limit without restarting the main process.
89c31b453d40 Sorted directives alphabetically. Ruslan Ermilov <ru@nginx.com> parents: 63 diff changeset	436 </para>
89c31b453d40 Sorted directives alphabetically. Ruslan Ermilov <ru@nginx.com> parents: 63 diff changeset	437
89c31b453d40 Sorted directives alphabetically. Ruslan Ermilov <ru@nginx.com> parents: 63 diff changeset	438 </directive>
89c31b453d40 Sorted directives alphabetically. Ruslan Ermilov <ru@nginx.com> parents: 63 diff changeset	439
89c31b453d40 Sorted directives alphabetically. Ruslan Ermilov <ru@nginx.com> parents: 63 diff changeset	440
63 6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	441 <directive name="working_directory">
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	442 <syntax><value>directory</value></syntax>
63 6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	443 <default/>
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	444 <context>main</context>
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	445
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	446 <para>
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	447 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	448 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	449 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	450 specified directory.
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	451 </para>
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	452
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	453 </directive>
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	454
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	455 </section>
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	456
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	457 </module>

Mercurial > hg > nginx-site

annotate xml/en/docs/ngx_core_module.xml @ 516:8e1356bd281a