nginx-site: xml/en/docs/ngx_core

annotate xml/en/docs/ngx_core_module.xml @ 966:95c3c3bbf1ce

Text review.

author	Egor Nikitin <yegor.nikitin@gmail.com>
date	Wed, 14 Aug 2013 12:03:41 +0400
parents	6d9d4bb571a9
children	379cb572a7ec

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
580 be54c443235a Added copyright markers to documentation sources. Ruslan Ermilov <ru@nginx.com> parents: 574 diff changeset	3 <!--
be54c443235a Added copyright markers to documentation sources. Ruslan Ermilov <ru@nginx.com> parents: 574 diff changeset	4 Copyright (C) Igor Sysoev
be54c443235a Added copyright markers to documentation sources. Ruslan Ermilov <ru@nginx.com> parents: 574 diff changeset	5 Copyright (C) Nginx, Inc.
be54c443235a Added copyright markers to documentation sources. Ruslan Ermilov <ru@nginx.com> parents: 574 diff changeset	6 -->
be54c443235a Added copyright markers to documentation sources. Ruslan Ermilov <ru@nginx.com> parents: 574 diff changeset	7
63 6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	8 <!DOCTYPE module SYSTEM "../../../dtd/module.dtd">
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	9
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	10 <module name="Core functionality"
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	11 link="/en/docs/ngx_core_module.html"
589 764fbac1b8b4 Added document revision. Ruslan Ermilov <ru@nginx.com> parents: 580 diff changeset	12 lang="en"
953 aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 935 diff changeset	13 rev="9">
63 6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	14
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	15 <section id="example" name="Example Configuration">
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	16
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	17 <para>
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	18 <example>
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	19 user www www;
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	20 worker_processes 2;
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 error_log /var/log/nginx-error.log info;
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 events {
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	25 use kqueue;
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	26 worker_connections 2048;
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	27 }
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 </example>
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	31 </para>
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	32
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	33 </section>
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	34
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	35
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	36 <section id="directives" name="Directives">
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	37
571 71d775bef043 Documented accept_mutex, accept_mutex_delay, multi_accept, and lock_file. Ruslan Ermilov <ru@nginx.com> parents: 556 diff changeset	38 <directive name="accept_mutex">
71d775bef043 Documented accept_mutex, accept_mutex_delay, multi_accept, and lock_file. Ruslan Ermilov <ru@nginx.com> parents: 556 diff changeset	39 <syntax><literal>on</literal> \| <literal>off</literal></syntax>
71d775bef043 Documented accept_mutex, accept_mutex_delay, multi_accept, and lock_file. Ruslan Ermilov <ru@nginx.com> parents: 556 diff changeset	40 <default>on</default>
71d775bef043 Documented accept_mutex, accept_mutex_delay, multi_accept, and lock_file. Ruslan Ermilov <ru@nginx.com> parents: 556 diff changeset	41 <context>events</context>
71d775bef043 Documented accept_mutex, accept_mutex_delay, multi_accept, and lock_file. Ruslan Ermilov <ru@nginx.com> parents: 556 diff changeset	42
71d775bef043 Documented accept_mutex, accept_mutex_delay, multi_accept, and lock_file. Ruslan Ermilov <ru@nginx.com> parents: 556 diff changeset	43 <para>
957 6d9d4bb571a9 Text review of the ngx_core_module. Egor Nikitin <yegor.nikitin@gmail.com> parents: 953 diff changeset	44 If <literal>accept_mutex</literal> is enabled,
6d9d4bb571a9 Text review of the ngx_core_module. Egor Nikitin <yegor.nikitin@gmail.com> parents: 953 diff changeset	45 worker processes will accept new connections by turn.
571 71d775bef043 Documented accept_mutex, accept_mutex_delay, multi_accept, and lock_file. Ruslan Ermilov <ru@nginx.com> parents: 556 diff changeset	46 Otherwise, all worker processes will be notified about new connections,
71d775bef043 Documented accept_mutex, accept_mutex_delay, multi_accept, and lock_file. Ruslan Ermilov <ru@nginx.com> parents: 556 diff changeset	47 and if volume of new connections is low, some of the worker processes
71d775bef043 Documented accept_mutex, accept_mutex_delay, multi_accept, and lock_file. Ruslan Ermilov <ru@nginx.com> parents: 556 diff changeset	48 may just waste system resources.
71d775bef043 Documented accept_mutex, accept_mutex_delay, multi_accept, and lock_file. Ruslan Ermilov <ru@nginx.com> parents: 556 diff changeset	49 <note>
71d775bef043 Documented accept_mutex, accept_mutex_delay, multi_accept, and lock_file. Ruslan Ermilov <ru@nginx.com> parents: 556 diff changeset	50 The use of <link doc="events.xml" id="rtsig"/>
71d775bef043 Documented accept_mutex, accept_mutex_delay, multi_accept, and lock_file. Ruslan Ermilov <ru@nginx.com> parents: 556 diff changeset	51 connection processing method
71d775bef043 Documented accept_mutex, accept_mutex_delay, multi_accept, and lock_file. Ruslan Ermilov <ru@nginx.com> parents: 556 diff changeset	52 requires <literal>accept_mutex</literal> to be enabled.
71d775bef043 Documented accept_mutex, accept_mutex_delay, multi_accept, and lock_file. Ruslan Ermilov <ru@nginx.com> parents: 556 diff changeset	53 </note>
71d775bef043 Documented accept_mutex, accept_mutex_delay, multi_accept, and lock_file. Ruslan Ermilov <ru@nginx.com> parents: 556 diff changeset	54 </para>
71d775bef043 Documented accept_mutex, accept_mutex_delay, multi_accept, and lock_file. Ruslan Ermilov <ru@nginx.com> parents: 556 diff changeset	55
71d775bef043 Documented accept_mutex, accept_mutex_delay, multi_accept, and lock_file. Ruslan Ermilov <ru@nginx.com> parents: 556 diff changeset	56 </directive>
71d775bef043 Documented accept_mutex, accept_mutex_delay, multi_accept, and lock_file. Ruslan Ermilov <ru@nginx.com> parents: 556 diff changeset	57
71d775bef043 Documented accept_mutex, accept_mutex_delay, multi_accept, and lock_file. Ruslan Ermilov <ru@nginx.com> parents: 556 diff changeset	58
71d775bef043 Documented accept_mutex, accept_mutex_delay, multi_accept, and lock_file. Ruslan Ermilov <ru@nginx.com> parents: 556 diff changeset	59 <directive name="accept_mutex_delay">
71d775bef043 Documented accept_mutex, accept_mutex_delay, multi_accept, and lock_file. Ruslan Ermilov <ru@nginx.com> parents: 556 diff changeset	60 <syntax><value>time</value></syntax>
71d775bef043 Documented accept_mutex, accept_mutex_delay, multi_accept, and lock_file. Ruslan Ermilov <ru@nginx.com> parents: 556 diff changeset	61 <default>500ms</default>
71d775bef043 Documented accept_mutex, accept_mutex_delay, multi_accept, and lock_file. Ruslan Ermilov <ru@nginx.com> parents: 556 diff changeset	62 <context>events</context>
71d775bef043 Documented accept_mutex, accept_mutex_delay, multi_accept, and lock_file. Ruslan Ermilov <ru@nginx.com> parents: 556 diff changeset	63
71d775bef043 Documented accept_mutex, accept_mutex_delay, multi_accept, and lock_file. Ruslan Ermilov <ru@nginx.com> parents: 556 diff changeset	64 <para>
71d775bef043 Documented accept_mutex, accept_mutex_delay, multi_accept, and lock_file. Ruslan Ermilov <ru@nginx.com> parents: 556 diff changeset	65 If <link id="accept_mutex"/> is enabled, specifies the maximum time
71d775bef043 Documented accept_mutex, accept_mutex_delay, multi_accept, and lock_file. Ruslan Ermilov <ru@nginx.com> parents: 556 diff changeset	66 during which a worker process will try to restart accepting new
957 6d9d4bb571a9 Text review of the ngx_core_module. Egor Nikitin <yegor.nikitin@gmail.com> parents: 953 diff changeset	67 connections if another worker process is currently accepting
6d9d4bb571a9 Text review of the ngx_core_module. Egor Nikitin <yegor.nikitin@gmail.com> parents: 953 diff changeset	68 new connections.
571 71d775bef043 Documented accept_mutex, accept_mutex_delay, multi_accept, and lock_file. Ruslan Ermilov <ru@nginx.com> parents: 556 diff changeset	69 </para>
71d775bef043 Documented accept_mutex, accept_mutex_delay, multi_accept, and lock_file. Ruslan Ermilov <ru@nginx.com> parents: 556 diff changeset	70
71d775bef043 Documented accept_mutex, accept_mutex_delay, multi_accept, and lock_file. Ruslan Ermilov <ru@nginx.com> parents: 556 diff changeset	71 </directive>
71d775bef043 Documented accept_mutex, accept_mutex_delay, multi_accept, and lock_file. Ruslan Ermilov <ru@nginx.com> parents: 556 diff changeset	72
71d775bef043 Documented accept_mutex, accept_mutex_delay, multi_accept, and lock_file. Ruslan Ermilov <ru@nginx.com> parents: 556 diff changeset	73
63 6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	74 <directive name="daemon">
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	75 <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	76 <default>on</default>
63 6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	77 <context>main</context>
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	78
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	79 <para>
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	80 Determines whether nginx should become a daemon.
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	81 Mainly used during development.
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	82 </para>
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	83
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	84 </directive>
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	85
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	86
516 8e1356bd281a Documented the "debug_connection" directive. Ruslan Ermilov <ru@nginx.com> parents: 469 diff changeset	87 <directive name="debug_connection">
8e1356bd281a Documented the "debug_connection" directive. Ruslan Ermilov <ru@nginx.com> parents: 469 diff changeset	88 <syntax>
8e1356bd281a Documented the "debug_connection" directive. Ruslan Ermilov <ru@nginx.com> parents: 469 diff changeset	89 <value>address</value> \|
8e1356bd281a Documented the "debug_connection" directive. Ruslan Ermilov <ru@nginx.com> parents: 469 diff changeset	90 <value>CIDR</value> \|
8e1356bd281a Documented the "debug_connection" directive. Ruslan Ermilov <ru@nginx.com> parents: 469 diff changeset	91 <literal>unix:</literal></syntax>
8e1356bd281a Documented the "debug_connection" directive. Ruslan Ermilov <ru@nginx.com> parents: 469 diff changeset	92 <default/>
8e1356bd281a Documented the "debug_connection" directive. Ruslan Ermilov <ru@nginx.com> parents: 469 diff changeset	93 <context>events</context>
8e1356bd281a Documented the "debug_connection" directive. Ruslan Ermilov <ru@nginx.com> parents: 469 diff changeset	94
8e1356bd281a Documented the "debug_connection" directive. Ruslan Ermilov <ru@nginx.com> parents: 469 diff changeset	95 <para>
8e1356bd281a Documented the "debug_connection" directive. Ruslan Ermilov <ru@nginx.com> parents: 469 diff changeset	96 Enables debugging log for selected client connections.
8e1356bd281a Documented the "debug_connection" directive. Ruslan Ermilov <ru@nginx.com> parents: 469 diff changeset	97 Other connections will use logging level set by the
8e1356bd281a Documented the "debug_connection" directive. Ruslan Ermilov <ru@nginx.com> parents: 469 diff changeset	98 <link id="error_log"/> directive.
523 a8daad8e83bb Documented 1.2.1 changes. Ruslan Ermilov <ru@nginx.com> parents: 516 diff changeset	99 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	100 address or network.
614 0526cac4637e Removed intimate details of the "debug_connection" directive's Ruslan Ermilov <ru@nginx.com> parents: 610 diff changeset	101 A connection may also be specified using a hostname.
523 a8daad8e83bb Documented 1.2.1 changes. Ruslan Ermilov <ru@nginx.com> parents: 516 diff changeset	102 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	103 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	104 <example>
8e1356bd281a Documented the "debug_connection" directive. Ruslan Ermilov <ru@nginx.com> parents: 469 diff changeset	105 events {
8e1356bd281a Documented the "debug_connection" directive. Ruslan Ermilov <ru@nginx.com> parents: 469 diff changeset	106 debug_connection 127.0.0.1;
8e1356bd281a Documented the "debug_connection" directive. Ruslan Ermilov <ru@nginx.com> parents: 469 diff changeset	107 debug_connection localhost;
8e1356bd281a Documented the "debug_connection" directive. Ruslan Ermilov <ru@nginx.com> parents: 469 diff changeset	108 debug_connection 192.0.2.0/24;
8e1356bd281a Documented the "debug_connection" directive. Ruslan Ermilov <ru@nginx.com> parents: 469 diff changeset	109 debug_connection ::1;
8e1356bd281a Documented the "debug_connection" directive. Ruslan Ermilov <ru@nginx.com> parents: 469 diff changeset	110 debug_connection 2001:0db8::/32;
8e1356bd281a Documented the "debug_connection" directive. Ruslan Ermilov <ru@nginx.com> parents: 469 diff changeset	111 debug_connection unix:;
8e1356bd281a Documented the "debug_connection" directive. Ruslan Ermilov <ru@nginx.com> parents: 469 diff changeset	112 ...
8e1356bd281a Documented the "debug_connection" directive. Ruslan Ermilov <ru@nginx.com> parents: 469 diff changeset	113 }
8e1356bd281a Documented the "debug_connection" directive. Ruslan Ermilov <ru@nginx.com> parents: 469 diff changeset	114 </example>
8e1356bd281a Documented the "debug_connection" directive. Ruslan Ermilov <ru@nginx.com> parents: 469 diff changeset	115 <note>
8e1356bd281a Documented the "debug_connection" directive. Ruslan Ermilov <ru@nginx.com> parents: 469 diff changeset	116 For this directive to work, nginx needs to
913 9a65d437da42 Link to "A debugging log" from "debug_connection" and "error_log". Ruslan Ermilov <ru@nginx.com> parents: 804 diff changeset	117 be built with <literal>--with-debug</literal>,
9a65d437da42 Link to "A debugging log" from "debug_connection" and "error_log". Ruslan Ermilov <ru@nginx.com> parents: 804 diff changeset	118 see “<link doc="debugging_log.xml"/>”.
516 8e1356bd281a Documented the "debug_connection" directive. Ruslan Ermilov <ru@nginx.com> parents: 469 diff changeset	119 </note>
8e1356bd281a Documented the "debug_connection" directive. Ruslan Ermilov <ru@nginx.com> parents: 469 diff changeset	120 </para>
8e1356bd281a Documented the "debug_connection" directive. Ruslan Ermilov <ru@nginx.com> parents: 469 diff changeset	121
8e1356bd281a Documented the "debug_connection" directive. Ruslan Ermilov <ru@nginx.com> parents: 469 diff changeset	122 </directive>
8e1356bd281a Documented the "debug_connection" directive. Ruslan Ermilov <ru@nginx.com> parents: 469 diff changeset	123
8e1356bd281a Documented the "debug_connection" directive. Ruslan Ermilov <ru@nginx.com> parents: 469 diff changeset	124
574 5e9ff979eac8 Documented debug_points. Ruslan Ermilov <ru@nginx.com> parents: 571 diff changeset	125 <directive name="debug_points">
5e9ff979eac8 Documented debug_points. Ruslan Ermilov <ru@nginx.com> parents: 571 diff changeset	126 <syntax><literal>abort</literal> \| <literal>stop</literal></syntax>
5e9ff979eac8 Documented debug_points. Ruslan Ermilov <ru@nginx.com> parents: 571 diff changeset	127 <default/>
5e9ff979eac8 Documented debug_points. Ruslan Ermilov <ru@nginx.com> parents: 571 diff changeset	128 <context>main</context>
5e9ff979eac8 Documented debug_points. Ruslan Ermilov <ru@nginx.com> parents: 571 diff changeset	129
5e9ff979eac8 Documented debug_points. Ruslan Ermilov <ru@nginx.com> parents: 571 diff changeset	130 <para>
5e9ff979eac8 Documented debug_points. Ruslan Ermilov <ru@nginx.com> parents: 571 diff changeset	131 This directive is used for debugging.
5e9ff979eac8 Documented debug_points. Ruslan Ermilov <ru@nginx.com> parents: 571 diff changeset	132 </para>
5e9ff979eac8 Documented debug_points. Ruslan Ermilov <ru@nginx.com> parents: 571 diff changeset	133
5e9ff979eac8 Documented debug_points. Ruslan Ermilov <ru@nginx.com> parents: 571 diff changeset	134 <para>
5e9ff979eac8 Documented debug_points. Ruslan Ermilov <ru@nginx.com> parents: 571 diff changeset	135 When internal error is detected, e.g. the leak of sockets on
5e9ff979eac8 Documented debug_points. Ruslan Ermilov <ru@nginx.com> parents: 571 diff changeset	136 restart of working processes, enabling <literal>debug_points</literal>
5e9ff979eac8 Documented debug_points. Ruslan Ermilov <ru@nginx.com> parents: 571 diff changeset	137 leads to a core file creation (<literal>abort</literal>)
957 6d9d4bb571a9 Text review of the ngx_core_module. Egor Nikitin <yegor.nikitin@gmail.com> parents: 953 diff changeset	138 or to stopping of a process (<literal>stop</literal>) for further
574 5e9ff979eac8 Documented debug_points. Ruslan Ermilov <ru@nginx.com> parents: 571 diff changeset	139 analysis using a system debugger.
5e9ff979eac8 Documented debug_points. Ruslan Ermilov <ru@nginx.com> parents: 571 diff changeset	140 </para>
5e9ff979eac8 Documented debug_points. Ruslan Ermilov <ru@nginx.com> parents: 571 diff changeset	141
5e9ff979eac8 Documented debug_points. Ruslan Ermilov <ru@nginx.com> parents: 571 diff changeset	142 </directive>
5e9ff979eac8 Documented debug_points. Ruslan Ermilov <ru@nginx.com> parents: 571 diff changeset	143
5e9ff979eac8 Documented debug_points. Ruslan Ermilov <ru@nginx.com> parents: 571 diff changeset	144
158 05e58829de2e Documented the "error_log" directive. Ruslan Ermilov <ru@nginx.com> parents: 102 diff changeset	145 <directive name="error_log">
05e58829de2e Documented the "error_log" directive. Ruslan Ermilov <ru@nginx.com> parents: 102 diff changeset	146 <syntax>
953 aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 935 diff changeset	147 <value>file</value> \| <literal>stderr</literal> \|
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 935 diff changeset	148 <literal>syslog:</literal><literal>server</literal>=<value>address</value>[,<value>parameter</value>=<value>value</value>]
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	149 [<literal>debug</literal> \|
4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	150 <literal>info</literal> \|
4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	151 <literal>notice</literal> \|
4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	152 <literal>warn</literal> \|
4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	153 <literal>error</literal> \|
4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	154 <literal>crit</literal> \|
4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	155 <literal>alert</literal> \|
4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	156 <literal>emerg</literal>]</syntax>
158 05e58829de2e Documented the "error_log" directive. Ruslan Ermilov <ru@nginx.com> parents: 102 diff changeset	157 <default>logs/error.log error</default>
05e58829de2e Documented the "error_log" directive. Ruslan Ermilov <ru@nginx.com> parents: 102 diff changeset	158 <context>main</context>
05e58829de2e Documented the "error_log" directive. Ruslan Ermilov <ru@nginx.com> parents: 102 diff changeset	159 <context>http</context>
05e58829de2e Documented the "error_log" directive. Ruslan Ermilov <ru@nginx.com> parents: 102 diff changeset	160 <context>server</context>
05e58829de2e Documented the "error_log" directive. Ruslan Ermilov <ru@nginx.com> parents: 102 diff changeset	161 <context>location</context>
05e58829de2e Documented the "error_log" directive. Ruslan Ermilov <ru@nginx.com> parents: 102 diff changeset	162
05e58829de2e Documented the "error_log" directive. Ruslan Ermilov <ru@nginx.com> parents: 102 diff changeset	163 <para>
05e58829de2e Documented the "error_log" directive. Ruslan Ermilov <ru@nginx.com> parents: 102 diff changeset	164 Configures logging.
935 3860b37d56c0 Documented support for multiple "error_log" directives. Vladimir Homutov <vl@nginx.com> parents: 913 diff changeset	165 Several logs can be specified on the same level (1.5.2).
158 05e58829de2e Documented the "error_log" directive. Ruslan Ermilov <ru@nginx.com> parents: 102 diff changeset	166 </para>
05e58829de2e Documented the "error_log" directive. Ruslan Ermilov <ru@nginx.com> parents: 102 diff changeset	167
05e58829de2e Documented the "error_log" directive. Ruslan Ermilov <ru@nginx.com> parents: 102 diff changeset	168 <para>
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	169 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	170 <!--
05e58829de2e Documented the "error_log" directive. Ruslan Ermilov <ru@nginx.com> parents: 102 diff changeset	171 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	172 -->
455 571b790ddf9e error_log: documented the special value "stderr" and default logging level. Ruslan Ermilov <ru@nginx.com> parents: 444 diff changeset	173 The special value <literal>stderr</literal> selects the standard error file.
953 aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 935 diff changeset	174 Logging to syslog can be configured by specifying
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 935 diff changeset	175 the “<literal>syslog:</literal>” prefix.
158 05e58829de2e Documented the "error_log" directive. Ruslan Ermilov <ru@nginx.com> parents: 102 diff changeset	176 </para>
05e58829de2e Documented the "error_log" directive. Ruslan Ermilov <ru@nginx.com> parents: 102 diff changeset	177
05e58829de2e Documented the "error_log" directive. Ruslan Ermilov <ru@nginx.com> parents: 102 diff changeset	178 <para>
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	179 The second parameter determines the level of logging.
158 05e58829de2e Documented the "error_log" directive. Ruslan Ermilov <ru@nginx.com> parents: 102 diff changeset	180 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	181 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	182 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	183 For example, the default level <literal>error</literal> will
4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	184 cause <literal>error</literal>, <literal>crit</literal>,
4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	185 <literal>alert</literal>, and <literal>emerg</literal> messages
158 05e58829de2e Documented the "error_log" directive. Ruslan Ermilov <ru@nginx.com> parents: 102 diff changeset	186 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	187 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	188 <note>
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	189 For <literal>debug</literal> logging to work, nginx needs to
913 9a65d437da42 Link to "A debugging log" from "debug_connection" and "error_log". Ruslan Ermilov <ru@nginx.com> parents: 804 diff changeset	190 be built with <literal>--with-debug</literal>,
9a65d437da42 Link to "A debugging log" from "debug_connection" and "error_log". Ruslan Ermilov <ru@nginx.com> parents: 804 diff changeset	191 see “<link doc="debugging_log.xml"/>”.
158 05e58829de2e Documented the "error_log" directive. Ruslan Ermilov <ru@nginx.com> parents: 102 diff changeset	192 </note>
05e58829de2e Documented the "error_log" directive. Ruslan Ermilov <ru@nginx.com> parents: 102 diff changeset	193 </para>
05e58829de2e Documented the "error_log" directive. Ruslan Ermilov <ru@nginx.com> parents: 102 diff changeset	194
953 aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 935 diff changeset	195 <para>
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 935 diff changeset	196 The following parameters configure logging to syslog:
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 935 diff changeset	197 <list type="tag">
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 935 diff changeset	198
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 935 diff changeset	199 <tag-name><literal>server=</literal><value>address</value></tag-name>
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 935 diff changeset	200 <tag-desc>
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 935 diff changeset	201 Defines an address of a syslog server.
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 935 diff changeset	202 An address can be specified as a domain name or IP address,
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 935 diff changeset	203 and an optional port, or as a UNIX-domain socket path
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 935 diff changeset	204 specified after the “<literal>unix:</literal>” prefix.
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 935 diff changeset	205 If port is not specified, the port 514 is used.
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 935 diff changeset	206 If a domain name resolves to several IP addresses, the first resolved
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 935 diff changeset	207 address is used.
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 935 diff changeset	208 </tag-desc>
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 935 diff changeset	209
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 935 diff changeset	210 <tag-name><literal>facility=</literal><value>string</value></tag-name>
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 935 diff changeset	211 <tag-desc>
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 935 diff changeset	212 Sets facility of syslog messages, as defined in
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 935 diff changeset	213 <link url="http://tools.ietf.org/html/rfc3164#section-4.1.1">RFC 3164</link>.
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 935 diff changeset	214 Facility can be one of “<literal>kern</literal>”, “<literal>user</literal>”,
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 935 diff changeset	215 “<literal>mail</literal>”, “<literal>daemon</literal>”,
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 935 diff changeset	216 “<literal>auth</literal>”, “<literal>intern</literal>”,
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 935 diff changeset	217 “<literal>lpr</literal>”, “<literal>news</literal>”, “<literal>uucp</literal>”,
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 935 diff changeset	218 “<literal>clock</literal>”, “<literal>authpriv</literal>”,
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 935 diff changeset	219 “<literal>ftp</literal>”, “<literal>ntp</literal>”, “<literal>audit</literal>”,
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 935 diff changeset	220 “<literal>alert</literal>”, “<literal>cron</literal>”,
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 935 diff changeset	221 “<literal>local0</literal>”..“<literal>local7</literal>”.
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 935 diff changeset	222 Default is “<literal>local7</literal>”.
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 935 diff changeset	223 </tag-desc>
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 935 diff changeset	224
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 935 diff changeset	225 <tag-name><literal>tag=</literal><value>string</value></tag-name>
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 935 diff changeset	226 <tag-desc>
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 935 diff changeset	227 Sets tag of syslog messages.
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 935 diff changeset	228 Default is “<literal>nginx</literal>”.
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 935 diff changeset	229 </tag-desc>
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 935 diff changeset	230
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 935 diff changeset	231 <!--
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 935 diff changeset	232 <tag-name><literal>bare=</literal><literal>on</literal> \|
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 935 diff changeset	233 <literal>off</literal></tag-name>
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 935 diff changeset	234 <tag-desc>
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 935 diff changeset	235 If enabled, messages are sent without syslog headers.
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 935 diff changeset	236 Default is <literal>off</literal>.
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 935 diff changeset	237 </tag-desc>
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 935 diff changeset	238 -->
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 935 diff changeset	239
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 935 diff changeset	240 </list>
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 935 diff changeset	241 Example syslog configuration:
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 935 diff changeset	242 <example>
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 935 diff changeset	243 error_log syslog:server=192.168.1.1 debug;
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 935 diff changeset	244 error_log syslog:server=unix:/var/log/nginx.sock;
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 935 diff changeset	245 error_log syslog:server=[2001:db8::1]:12345,facility=local7,tag=nginx error;
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 935 diff changeset	246 </example>
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 935 diff changeset	247 </para>
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 935 diff changeset	248
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 935 diff changeset	249 <para>
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 935 diff changeset	250 <note>
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 935 diff changeset	251 Logging to syslog is available as part of our <commercial_version/> only.
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 935 diff changeset	252 </note>
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 935 diff changeset	253 </para>
aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 935 diff changeset	254
158 05e58829de2e Documented the "error_log" directive. Ruslan Ermilov <ru@nginx.com> parents: 102 diff changeset	255 </directive>
05e58829de2e Documented the "error_log" directive. Ruslan Ermilov <ru@nginx.com> parents: 102 diff changeset	256
05e58829de2e Documented the "error_log" directive. Ruslan Ermilov <ru@nginx.com> parents: 102 diff changeset	257
63 6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	258 <directive name="env">
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	259 <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	260 <default>TZ</default>
63 6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	261 <context>main</context>
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 <para>
804 d22421dc5d00 Clarified the effects of the "env" directive. Ruslan Ermilov <ru@nginx.com> parents: 764 diff changeset	264 By default, nginx removes all environment variables inherited
d22421dc5d00 Clarified the effects of the "env" directive. Ruslan Ermilov <ru@nginx.com> parents: 764 diff changeset	265 from its parent process except the TZ variable.
957 6d9d4bb571a9 Text review of the ngx_core_module. Egor Nikitin <yegor.nikitin@gmail.com> parents: 953 diff changeset	266 This directive allows preserving some of the inherited variables,
6d9d4bb571a9 Text review of the ngx_core_module. Egor Nikitin <yegor.nikitin@gmail.com> parents: 953 diff changeset	267 changing their values, or creating new environment variables.
804 d22421dc5d00 Clarified the effects of the "env" directive. Ruslan Ermilov <ru@nginx.com> parents: 764 diff changeset	268 These variables are then:
63 6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	269 <list type="bullet">
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	270
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	271 <listitem>
804 d22421dc5d00 Clarified the effects of the "env" directive. Ruslan Ermilov <ru@nginx.com> parents: 764 diff changeset	272 inherited during a <link doc="control.xml" id="upgrade">live upgrade</link>
63 6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	273 of an executable file;
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	274 </listitem>
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 <listitem>
957 6d9d4bb571a9 Text review of the ngx_core_module. Egor Nikitin <yegor.nikitin@gmail.com> parents: 953 diff changeset	277 used by the
6d9d4bb571a9 Text review of the ngx_core_module. Egor Nikitin <yegor.nikitin@gmail.com> parents: 953 diff changeset	278 <link doc="http/ngx_http_perl_module.xml">ngx_http_perl_module</link> module;
63 6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	279 </listitem>
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	280
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	281 <listitem>
804 d22421dc5d00 Clarified the effects of the "env" directive. Ruslan Ermilov <ru@nginx.com> parents: 764 diff changeset	282 used by worker processes.
957 6d9d4bb571a9 Text review of the ngx_core_module. Egor Nikitin <yegor.nikitin@gmail.com> parents: 953 diff changeset	283 One should bear in mind that controlling system libraries in this way
6d9d4bb571a9 Text review of the ngx_core_module. Egor Nikitin <yegor.nikitin@gmail.com> parents: 953 diff changeset	284 is not always possible as it is common for libraries to check
63 6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	285 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	286 using this directive.
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	287 An exception from this is an above mentioned
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	288 <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	289 of an executable file.
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	290 </listitem>
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	291
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	292 </list>
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	293 </para>
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	294
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	295 <para>
957 6d9d4bb571a9 Text review of the ngx_core_module. Egor Nikitin <yegor.nikitin@gmail.com> parents: 953 diff changeset	296 The TZ variable is always inherited and available to the
6d9d4bb571a9 Text review of the ngx_core_module. Egor Nikitin <yegor.nikitin@gmail.com> parents: 953 diff changeset	297 <link doc="http/ngx_http_perl_module.xml">ngx_http_perl_module</link>
6d9d4bb571a9 Text review of the ngx_core_module. Egor Nikitin <yegor.nikitin@gmail.com> parents: 953 diff changeset	298 module, unless it is configured explicitly.
63 6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	299 </para>
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	300
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 Usage example:
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	303 <example>
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	304 env MALLOC_OPTIONS;
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	305 env PERL5LIB=/data/site/modules;
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	306 env OPENSSL_ALLOW_PROXY_CERTS=1;
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
444 43c84d19bf92 Added a note about the NGINX environment variable. Ruslan Ermilov <ru@nginx.com> parents: 289 diff changeset	310 <para>
43c84d19bf92 Added a note about the NGINX environment variable. Ruslan Ermilov <ru@nginx.com> parents: 289 diff changeset	311 <note>
43c84d19bf92 Added a note about the NGINX environment variable. Ruslan Ermilov <ru@nginx.com> parents: 289 diff changeset	312 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	313 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	314 </note>
43c84d19bf92 Added a note about the NGINX environment variable. Ruslan Ermilov <ru@nginx.com> parents: 289 diff changeset	315 </para>
43c84d19bf92 Added a note about the NGINX environment variable. Ruslan Ermilov <ru@nginx.com> parents: 289 diff changeset	316
63 6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	317 </directive>
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	318
249 0f43f2c32c0b Fixed some nits. Ruslan Ermilov <ru@nginx.com> parents: 226 diff changeset	319
556 345012910707 Documented the "events" and "use" directives. Ruslan Ermilov <ru@nginx.com> parents: 554 diff changeset	320 <directive name="events">
345012910707 Documented the "events" and "use" directives. Ruslan Ermilov <ru@nginx.com> parents: 554 diff changeset	321 <syntax block="yes"/>
345012910707 Documented the "events" and "use" directives. Ruslan Ermilov <ru@nginx.com> parents: 554 diff changeset	322 <default/>
345012910707 Documented the "events" and "use" directives. Ruslan Ermilov <ru@nginx.com> parents: 554 diff changeset	323 <context>main</context>
345012910707 Documented the "events" and "use" directives. Ruslan Ermilov <ru@nginx.com> parents: 554 diff changeset	324
345012910707 Documented the "events" and "use" directives. Ruslan Ermilov <ru@nginx.com> parents: 554 diff changeset	325 <para>
957 6d9d4bb571a9 Text review of the ngx_core_module. Egor Nikitin <yegor.nikitin@gmail.com> parents: 953 diff changeset	326 Provides the configuration file context in which the directives that
556 345012910707 Documented the "events" and "use" directives. Ruslan Ermilov <ru@nginx.com> parents: 554 diff changeset	327 affect connection processing are specified.
345012910707 Documented the "events" and "use" directives. Ruslan Ermilov <ru@nginx.com> parents: 554 diff changeset	328 </para>
345012910707 Documented the "events" and "use" directives. Ruslan Ermilov <ru@nginx.com> parents: 554 diff changeset	329
345012910707 Documented the "events" and "use" directives. Ruslan Ermilov <ru@nginx.com> parents: 554 diff changeset	330 </directive>
345012910707 Documented the "events" and "use" directives. Ruslan Ermilov <ru@nginx.com> parents: 554 diff changeset	331
345012910707 Documented the "events" and "use" directives. Ruslan Ermilov <ru@nginx.com> parents: 554 diff changeset	332
63 6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	333 <directive name="include">
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	334 <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	335 <default/>
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	336 <context/>
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	337
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	338 <para>
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	339 Includes another <value>file</value>, or files matching the
4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	340 specified <value>mask</value>, into configuration.
63 6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	341 Included files should consist of
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	342 syntactically correct directives and blocks.
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	343 </para>
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	344
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	345 <para>
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	346 Usage example:
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	347 <example>
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	348 include mime.types;
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	349 include vhosts/*.conf;
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	350 </example>
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	351 </para>
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	352
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	353 </directive>
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	354
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	355
571 71d775bef043 Documented accept_mutex, accept_mutex_delay, multi_accept, and lock_file. Ruslan Ermilov <ru@nginx.com> parents: 556 diff changeset	356 <directive name="lock_file">
71d775bef043 Documented accept_mutex, accept_mutex_delay, multi_accept, and lock_file. Ruslan Ermilov <ru@nginx.com> parents: 556 diff changeset	357 <syntax><value>file</value></syntax>
71d775bef043 Documented accept_mutex, accept_mutex_delay, multi_accept, and lock_file. Ruslan Ermilov <ru@nginx.com> parents: 556 diff changeset	358 <default>logs/nginx.lock</default>
71d775bef043 Documented accept_mutex, accept_mutex_delay, multi_accept, and lock_file. Ruslan Ermilov <ru@nginx.com> parents: 556 diff changeset	359 <context>main</context>
71d775bef043 Documented accept_mutex, accept_mutex_delay, multi_accept, and lock_file. Ruslan Ermilov <ru@nginx.com> parents: 556 diff changeset	360
71d775bef043 Documented accept_mutex, accept_mutex_delay, multi_accept, and lock_file. Ruslan Ermilov <ru@nginx.com> parents: 556 diff changeset	361 <para>
71d775bef043 Documented accept_mutex, accept_mutex_delay, multi_accept, and lock_file. Ruslan Ermilov <ru@nginx.com> parents: 556 diff changeset	362 nginx uses the locking mechanism to implement <link id="accept_mutex"/>
957 6d9d4bb571a9 Text review of the ngx_core_module. Egor Nikitin <yegor.nikitin@gmail.com> parents: 953 diff changeset	363 and serialize access to shared memory.
571 71d775bef043 Documented accept_mutex, accept_mutex_delay, multi_accept, and lock_file. Ruslan Ermilov <ru@nginx.com> parents: 556 diff changeset	364 On most systems the locks are implemented using atomic operations,
71d775bef043 Documented accept_mutex, accept_mutex_delay, multi_accept, and lock_file. Ruslan Ermilov <ru@nginx.com> parents: 556 diff changeset	365 and this directive is ignored.
71d775bef043 Documented accept_mutex, accept_mutex_delay, multi_accept, and lock_file. Ruslan Ermilov <ru@nginx.com> parents: 556 diff changeset	366 On other systems the “lock file” mechanism is used.
71d775bef043 Documented accept_mutex, accept_mutex_delay, multi_accept, and lock_file. Ruslan Ermilov <ru@nginx.com> parents: 556 diff changeset	367 This directive specifies a prefix for the names of lock files.
71d775bef043 Documented accept_mutex, accept_mutex_delay, multi_accept, and lock_file. Ruslan Ermilov <ru@nginx.com> parents: 556 diff changeset	368 </para>
71d775bef043 Documented accept_mutex, accept_mutex_delay, multi_accept, and lock_file. Ruslan Ermilov <ru@nginx.com> parents: 556 diff changeset	369
71d775bef043 Documented accept_mutex, accept_mutex_delay, multi_accept, and lock_file. Ruslan Ermilov <ru@nginx.com> parents: 556 diff changeset	370 </directive>
71d775bef043 Documented accept_mutex, accept_mutex_delay, multi_accept, and lock_file. Ruslan Ermilov <ru@nginx.com> parents: 556 diff changeset	371
71d775bef043 Documented accept_mutex, accept_mutex_delay, multi_accept, and lock_file. Ruslan Ermilov <ru@nginx.com> parents: 556 diff changeset	372
63 6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	373 <directive name="master_process">
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	374 <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	375 <default>on</default>
63 6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	376 <context>main</context>
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	377
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	378 <para>
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	379 Determines whether worker processes are started.
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	380 This directive is intended for nginx developers.
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 </directive>
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	384
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	385
571 71d775bef043 Documented accept_mutex, accept_mutex_delay, multi_accept, and lock_file. Ruslan Ermilov <ru@nginx.com> parents: 556 diff changeset	386 <directive name="multi_accept">
71d775bef043 Documented accept_mutex, accept_mutex_delay, multi_accept, and lock_file. Ruslan Ermilov <ru@nginx.com> parents: 556 diff changeset	387 <syntax><literal>on</literal> \| <literal>off</literal></syntax>
71d775bef043 Documented accept_mutex, accept_mutex_delay, multi_accept, and lock_file. Ruslan Ermilov <ru@nginx.com> parents: 556 diff changeset	388 <default>off</default>
71d775bef043 Documented accept_mutex, accept_mutex_delay, multi_accept, and lock_file. Ruslan Ermilov <ru@nginx.com> parents: 556 diff changeset	389 <context>events</context>
71d775bef043 Documented accept_mutex, accept_mutex_delay, multi_accept, and lock_file. Ruslan Ermilov <ru@nginx.com> parents: 556 diff changeset	390
71d775bef043 Documented accept_mutex, accept_mutex_delay, multi_accept, and lock_file. Ruslan Ermilov <ru@nginx.com> parents: 556 diff changeset	391 <para>
957 6d9d4bb571a9 Text review of the ngx_core_module. Egor Nikitin <yegor.nikitin@gmail.com> parents: 953 diff changeset	392 If <literal>multi_accept</literal> is disabled, a worker process
571 71d775bef043 Documented accept_mutex, accept_mutex_delay, multi_accept, and lock_file. Ruslan Ermilov <ru@nginx.com> parents: 556 diff changeset	393 will accept one new connection at a time.
71d775bef043 Documented accept_mutex, accept_mutex_delay, multi_accept, and lock_file. Ruslan Ermilov <ru@nginx.com> parents: 556 diff changeset	394 Otherwise, a worker process
71d775bef043 Documented accept_mutex, accept_mutex_delay, multi_accept, and lock_file. Ruslan Ermilov <ru@nginx.com> parents: 556 diff changeset	395 will accept all new connections at a time.
71d775bef043 Documented accept_mutex, accept_mutex_delay, multi_accept, and lock_file. Ruslan Ermilov <ru@nginx.com> parents: 556 diff changeset	396 <note>
71d775bef043 Documented accept_mutex, accept_mutex_delay, multi_accept, and lock_file. Ruslan Ermilov <ru@nginx.com> parents: 556 diff changeset	397 The directive is ignored if <link doc="events.xml" id="kqueue"/>
957 6d9d4bb571a9 Text review of the ngx_core_module. Egor Nikitin <yegor.nikitin@gmail.com> parents: 953 diff changeset	398 connection processing method is used, because it reports
571 71d775bef043 Documented accept_mutex, accept_mutex_delay, multi_accept, and lock_file. Ruslan Ermilov <ru@nginx.com> parents: 556 diff changeset	399 the number of new connections waiting to be accepted.
71d775bef043 Documented accept_mutex, accept_mutex_delay, multi_accept, and lock_file. Ruslan Ermilov <ru@nginx.com> parents: 556 diff changeset	400 </note>
71d775bef043 Documented accept_mutex, accept_mutex_delay, multi_accept, and lock_file. Ruslan Ermilov <ru@nginx.com> parents: 556 diff changeset	401 <note>
71d775bef043 Documented accept_mutex, accept_mutex_delay, multi_accept, and lock_file. Ruslan Ermilov <ru@nginx.com> parents: 556 diff changeset	402 The use of <link doc="events.xml" id="rtsig"/>
71d775bef043 Documented accept_mutex, accept_mutex_delay, multi_accept, and lock_file. Ruslan Ermilov <ru@nginx.com> parents: 556 diff changeset	403 connection processing method
71d775bef043 Documented accept_mutex, accept_mutex_delay, multi_accept, and lock_file. Ruslan Ermilov <ru@nginx.com> parents: 556 diff changeset	404 automatically enables <literal>multi_accept</literal>.
71d775bef043 Documented accept_mutex, accept_mutex_delay, multi_accept, and lock_file. Ruslan Ermilov <ru@nginx.com> parents: 556 diff changeset	405 </note>
71d775bef043 Documented accept_mutex, accept_mutex_delay, multi_accept, and lock_file. Ruslan Ermilov <ru@nginx.com> parents: 556 diff changeset	406 </para>
71d775bef043 Documented accept_mutex, accept_mutex_delay, multi_accept, and lock_file. Ruslan Ermilov <ru@nginx.com> parents: 556 diff changeset	407
71d775bef043 Documented accept_mutex, accept_mutex_delay, multi_accept, and lock_file. Ruslan Ermilov <ru@nginx.com> parents: 556 diff changeset	408 </directive>
71d775bef043 Documented accept_mutex, accept_mutex_delay, multi_accept, and lock_file. Ruslan Ermilov <ru@nginx.com> parents: 556 diff changeset	409
71d775bef043 Documented accept_mutex, accept_mutex_delay, multi_accept, and lock_file. Ruslan Ermilov <ru@nginx.com> parents: 556 diff changeset	410
289 df261b1ce71f Documented the --with-pcre-jit configuration parameter Ruslan Ermilov <ru@nginx.com> parents: 271 diff changeset	411 <directive name="pcre_jit">
df261b1ce71f Documented the --with-pcre-jit configuration parameter Ruslan Ermilov <ru@nginx.com> parents: 271 diff changeset	412 <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	413 <default>off</default>
df261b1ce71f Documented the --with-pcre-jit configuration parameter Ruslan Ermilov <ru@nginx.com> parents: 271 diff changeset	414 <context>main</context>
df261b1ce71f Documented the --with-pcre-jit configuration parameter Ruslan Ermilov <ru@nginx.com> parents: 271 diff changeset	415 <appeared-in>1.1.12</appeared-in>
df261b1ce71f Documented the --with-pcre-jit configuration parameter Ruslan Ermilov <ru@nginx.com> parents: 271 diff changeset	416
df261b1ce71f Documented the --with-pcre-jit configuration parameter Ruslan Ermilov <ru@nginx.com> parents: 271 diff changeset	417 <para>
df261b1ce71f Documented the --with-pcre-jit configuration parameter Ruslan Ermilov <ru@nginx.com> parents: 271 diff changeset	418 Enables or disables the use of “just-in-time compilation” (PCRE JIT)
957 6d9d4bb571a9 Text review of the ngx_core_module. Egor Nikitin <yegor.nikitin@gmail.com> parents: 953 diff changeset	419 for the regular expressions known by the time of configuration parsing.
289 df261b1ce71f Documented the --with-pcre-jit configuration parameter Ruslan Ermilov <ru@nginx.com> parents: 271 diff changeset	420 </para>
df261b1ce71f Documented the --with-pcre-jit configuration parameter Ruslan Ermilov <ru@nginx.com> parents: 271 diff changeset	421
df261b1ce71f Documented the --with-pcre-jit configuration parameter Ruslan Ermilov <ru@nginx.com> parents: 271 diff changeset	422 <para>
df261b1ce71f Documented the --with-pcre-jit configuration parameter Ruslan Ermilov <ru@nginx.com> parents: 271 diff changeset	423 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	424 <note>
df261b1ce71f Documented the --with-pcre-jit configuration parameter Ruslan Ermilov <ru@nginx.com> parents: 271 diff changeset	425 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	426 built with the <literal>--enable-jit</literal> configuration parameter.
957 6d9d4bb571a9 Text review of the ngx_core_module. Egor Nikitin <yegor.nikitin@gmail.com> parents: 953 diff changeset	427 When the PCRE library is built with nginx (<literal>--with-pcre=</literal>),
6d9d4bb571a9 Text review of the ngx_core_module. Egor Nikitin <yegor.nikitin@gmail.com> parents: 953 diff changeset	428 the JIT support is enabled via the
289 df261b1ce71f Documented the --with-pcre-jit configuration parameter Ruslan Ermilov <ru@nginx.com> parents: 271 diff changeset	429 <literal>--with-pcre-jit</literal> configuration parameter.
df261b1ce71f Documented the --with-pcre-jit configuration parameter Ruslan Ermilov <ru@nginx.com> parents: 271 diff changeset	430 </note>
df261b1ce71f Documented the --with-pcre-jit configuration parameter Ruslan Ermilov <ru@nginx.com> parents: 271 diff changeset	431 </para>
df261b1ce71f Documented the --with-pcre-jit configuration parameter Ruslan Ermilov <ru@nginx.com> parents: 271 diff changeset	432
df261b1ce71f Documented the --with-pcre-jit configuration parameter Ruslan Ermilov <ru@nginx.com> parents: 271 diff changeset	433 </directive>
df261b1ce71f Documented the --with-pcre-jit configuration parameter Ruslan Ermilov <ru@nginx.com> parents: 271 diff changeset	434
df261b1ce71f Documented the --with-pcre-jit configuration parameter Ruslan Ermilov <ru@nginx.com> parents: 271 diff changeset	435
63 6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	436 <directive name="pid">
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	437 <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	438 <default>nginx.pid</default>
63 6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	439 <context>main</context>
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	440
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	441 <para>
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	442 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	443 </para>
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>
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	446
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	447
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	448 <directive name="ssl_engine">
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	449 <syntax><value>device</value></syntax>
63 6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	450 <default/>
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	451 <context>main</context>
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 <para>
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	454 Defines the name of the hardware SSL accelerator.
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	455 </para>
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 </directive>
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	458
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	459
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	460 <directive name="timer_resolution">
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	461 <syntax><value>interval</value></syntax>
63 6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	462 <default/>
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	463 <context>main</context>
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	464
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	465 <para>
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	466 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	467 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	468 By default, <c-func>gettimeofday</c-func> is called each time
957 6d9d4bb571a9 Text review of the ngx_core_module. Egor Nikitin <yegor.nikitin@gmail.com> parents: 953 diff changeset	469 a kernel event is received.
63 6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	470 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	471 called once per specified <value>interval</value>.
63 6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	472 </para>
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	473
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	474 <para>
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	475 Example:
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	476 <example>
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	477 timer_resolution 100ms;
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	478 </example>
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	479 </para>
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	480
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	481 <para>
957 6d9d4bb571a9 Text review of the ngx_core_module. Egor Nikitin <yegor.nikitin@gmail.com> parents: 953 diff changeset	482 Internal implementation of the interval depends on the method used:
63 6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	483 <list type="bullet">
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	484
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	485 <listitem>
957 6d9d4bb571a9 Text review of the ngx_core_module. Egor Nikitin <yegor.nikitin@gmail.com> parents: 953 diff changeset	486 the <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	487 </listitem>
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	488
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	489 <listitem>
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	490 <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	491 </listitem>
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	492
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	493 <listitem>
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	494 <c-func>setitimer</c-func> otherwise.
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	495 </listitem>
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	496
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	497 </list>
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	498 </para>
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	499
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	500 </directive>
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	501
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	502
556 345012910707 Documented the "events" and "use" directives. Ruslan Ermilov <ru@nginx.com> parents: 554 diff changeset	503 <directive name="use">
345012910707 Documented the "events" and "use" directives. Ruslan Ermilov <ru@nginx.com> parents: 554 diff changeset	504 <syntax><value>method</value></syntax>
345012910707 Documented the "events" and "use" directives. Ruslan Ermilov <ru@nginx.com> parents: 554 diff changeset	505 <default/>
345012910707 Documented the "events" and "use" directives. Ruslan Ermilov <ru@nginx.com> parents: 554 diff changeset	506 <context>events</context>
345012910707 Documented the "events" and "use" directives. Ruslan Ermilov <ru@nginx.com> parents: 554 diff changeset	507
345012910707 Documented the "events" and "use" directives. Ruslan Ermilov <ru@nginx.com> parents: 554 diff changeset	508 <para>
345012910707 Documented the "events" and "use" directives. Ruslan Ermilov <ru@nginx.com> parents: 554 diff changeset	509 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	510 <value>method</value> to use.
957 6d9d4bb571a9 Text review of the ngx_core_module. Egor Nikitin <yegor.nikitin@gmail.com> parents: 953 diff changeset	511 There is normally no need to specify it explicitly, because nginx will
556 345012910707 Documented the "events" and "use" directives. Ruslan Ermilov <ru@nginx.com> parents: 554 diff changeset	512 by default use the most efficient method.
345012910707 Documented the "events" and "use" directives. Ruslan Ermilov <ru@nginx.com> parents: 554 diff changeset	513 </para>
345012910707 Documented the "events" and "use" directives. Ruslan Ermilov <ru@nginx.com> parents: 554 diff changeset	514
345012910707 Documented the "events" and "use" directives. Ruslan Ermilov <ru@nginx.com> parents: 554 diff changeset	515 </directive>
345012910707 Documented the "events" and "use" directives. Ruslan Ermilov <ru@nginx.com> parents: 554 diff changeset	516
345012910707 Documented the "events" and "use" directives. Ruslan Ermilov <ru@nginx.com> parents: 554 diff changeset	517
82 89c31b453d40 Sorted directives alphabetically. Ruslan Ermilov <ru@nginx.com> parents: 63 diff changeset	518 <directive name="user">
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	519 <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	520 <default>nobody nobody</default>
63 6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	521 <context>main</context>
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 <para>
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	524 Defines <value>user</value> and <value>group</value>
82 89c31b453d40 Sorted directives alphabetically. Ruslan Ermilov <ru@nginx.com> parents: 63 diff changeset	525 credentials used by worker processes.
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	526 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	527 that of <value>user</value> is used.
63 6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	528 </para>
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	529
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	530 </directive>
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	531
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	532
749 2abb92a19101 Documented 'worker_aio_requests' directive. Vladimir Homutov <vl@nginx.com> parents: 742 diff changeset	533 <directive name="worker_aio_requests">
2abb92a19101 Documented 'worker_aio_requests' directive. Vladimir Homutov <vl@nginx.com> parents: 742 diff changeset	534 <syntax><value>number</value></syntax>
2abb92a19101 Documented 'worker_aio_requests' directive. Vladimir Homutov <vl@nginx.com> parents: 742 diff changeset	535 <default>32</default>
2abb92a19101 Documented 'worker_aio_requests' directive. Vladimir Homutov <vl@nginx.com> parents: 742 diff changeset	536 <context>events</context>
750 6a1b1ba62cab Documented history of "worker_aio_requests" directive. Vladimir Homutov <vl@nginx.com> parents: 749 diff changeset	537 <appeared-in>1.1.4</appeared-in>
6a1b1ba62cab Documented history of "worker_aio_requests" directive. Vladimir Homutov <vl@nginx.com> parents: 749 diff changeset	538 <appeared-in>1.0.7</appeared-in>
749 2abb92a19101 Documented 'worker_aio_requests' directive. Vladimir Homutov <vl@nginx.com> parents: 742 diff changeset	539
2abb92a19101 Documented 'worker_aio_requests' directive. Vladimir Homutov <vl@nginx.com> parents: 742 diff changeset	540 <para>
2abb92a19101 Documented 'worker_aio_requests' directive. Vladimir Homutov <vl@nginx.com> parents: 742 diff changeset	541 When using <link doc="http/ngx_http_core_module.xml" id="aio"/>
2abb92a19101 Documented 'worker_aio_requests' directive. Vladimir Homutov <vl@nginx.com> parents: 742 diff changeset	542 with the <link doc="../docs/events.xml" id="epoll"/>
2abb92a19101 Documented 'worker_aio_requests' directive. Vladimir Homutov <vl@nginx.com> parents: 742 diff changeset	543 connection processing method, sets the maximum <value>number</value> of
2abb92a19101 Documented 'worker_aio_requests' directive. Vladimir Homutov <vl@nginx.com> parents: 742 diff changeset	544 outstanding asynchronous I/O operations
2abb92a19101 Documented 'worker_aio_requests' directive. Vladimir Homutov <vl@nginx.com> parents: 742 diff changeset	545 for a single worker process.
2abb92a19101 Documented 'worker_aio_requests' directive. Vladimir Homutov <vl@nginx.com> parents: 742 diff changeset	546 </para>
2abb92a19101 Documented 'worker_aio_requests' directive. Vladimir Homutov <vl@nginx.com> parents: 742 diff changeset	547
2abb92a19101 Documented 'worker_aio_requests' directive. Vladimir Homutov <vl@nginx.com> parents: 742 diff changeset	548 </directive>
2abb92a19101 Documented 'worker_aio_requests' directive. Vladimir Homutov <vl@nginx.com> parents: 742 diff changeset	549
2abb92a19101 Documented 'worker_aio_requests' directive. Vladimir Homutov <vl@nginx.com> parents: 742 diff changeset	550
545 e97b46d1842d Documented the "worker_connections" directive. Ruslan Ermilov <ru@nginx.com> parents: 523 diff changeset	551 <directive name="worker_connections">
e97b46d1842d Documented the "worker_connections" directive. Ruslan Ermilov <ru@nginx.com> parents: 523 diff changeset	552 <syntax><value>number</value></syntax>
e97b46d1842d Documented the "worker_connections" directive. Ruslan Ermilov <ru@nginx.com> parents: 523 diff changeset	553 <default>512</default>
e97b46d1842d Documented the "worker_connections" directive. Ruslan Ermilov <ru@nginx.com> parents: 523 diff changeset	554 <context>events</context>
e97b46d1842d Documented the "worker_connections" directive. Ruslan Ermilov <ru@nginx.com> parents: 523 diff changeset	555
e97b46d1842d Documented the "worker_connections" directive. Ruslan Ermilov <ru@nginx.com> parents: 523 diff changeset	556 <para>
e97b46d1842d Documented the "worker_connections" directive. Ruslan Ermilov <ru@nginx.com> parents: 523 diff changeset	557 Sets the maximum number of simultaneous connections that
e97b46d1842d Documented the "worker_connections" directive. Ruslan Ermilov <ru@nginx.com> parents: 523 diff changeset	558 can be opened by a worker process.
e97b46d1842d Documented the "worker_connections" directive. Ruslan Ermilov <ru@nginx.com> parents: 523 diff changeset	559 </para>
e97b46d1842d Documented the "worker_connections" directive. Ruslan Ermilov <ru@nginx.com> parents: 523 diff changeset	560
e97b46d1842d Documented the "worker_connections" directive. Ruslan Ermilov <ru@nginx.com> parents: 523 diff changeset	561 <para>
e97b46d1842d Documented the "worker_connections" directive. Ruslan Ermilov <ru@nginx.com> parents: 523 diff changeset	562 It should be kept in mind that this number includes all connections
957 6d9d4bb571a9 Text review of the ngx_core_module. Egor Nikitin <yegor.nikitin@gmail.com> parents: 953 diff changeset	563 (e.g. connections with proxied servers, among others),
545 e97b46d1842d Documented the "worker_connections" directive. Ruslan Ermilov <ru@nginx.com> parents: 523 diff changeset	564 not only connections with clients.
e97b46d1842d Documented the "worker_connections" directive. Ruslan Ermilov <ru@nginx.com> parents: 523 diff changeset	565 Another consideration is that the actual number of simultaneous
966 95c3c3bbf1ce Text review. Egor Nikitin <yegor.nikitin@gmail.com> parents: 957 diff changeset	566 connections cannot exceed the current limit on
957 6d9d4bb571a9 Text review of the ngx_core_module. Egor Nikitin <yegor.nikitin@gmail.com> parents: 953 diff changeset	567 the maximum number of open files, which can be changed by
545 e97b46d1842d Documented the "worker_connections" directive. Ruslan Ermilov <ru@nginx.com> parents: 523 diff changeset	568 <link id="worker_rlimit_nofile"/>.
e97b46d1842d Documented the "worker_connections" directive. Ruslan Ermilov <ru@nginx.com> parents: 523 diff changeset	569 </para>
e97b46d1842d Documented the "worker_connections" directive. Ruslan Ermilov <ru@nginx.com> parents: 523 diff changeset	570
e97b46d1842d Documented the "worker_connections" directive. Ruslan Ermilov <ru@nginx.com> parents: 523 diff changeset	571 </directive>
e97b46d1842d Documented the "worker_connections" directive. Ruslan Ermilov <ru@nginx.com> parents: 523 diff changeset	572
e97b46d1842d Documented the "worker_connections" directive. Ruslan Ermilov <ru@nginx.com> parents: 523 diff changeset	573
469 8275e169f77b Documented the "worker_cpu_affinity" directive. Ruslan Ermilov <ru@nginx.com> parents: 455 diff changeset	574 <directive name="worker_cpu_affinity">
8275e169f77b Documented the "worker_cpu_affinity" directive. Ruslan Ermilov <ru@nginx.com> parents: 455 diff changeset	575 <syntax><value>cpumask</value> ...</syntax>
8275e169f77b Documented the "worker_cpu_affinity" directive. Ruslan Ermilov <ru@nginx.com> parents: 455 diff changeset	576 <default/>
8275e169f77b Documented the "worker_cpu_affinity" directive. Ruslan Ermilov <ru@nginx.com> parents: 455 diff changeset	577 <context>main</context>
8275e169f77b Documented the "worker_cpu_affinity" directive. Ruslan Ermilov <ru@nginx.com> parents: 455 diff changeset	578
8275e169f77b Documented the "worker_cpu_affinity" directive. Ruslan Ermilov <ru@nginx.com> parents: 455 diff changeset	579 <para>
8275e169f77b Documented the "worker_cpu_affinity" directive. Ruslan Ermilov <ru@nginx.com> parents: 455 diff changeset	580 Binds worker processes to the sets of CPUs.
957 6d9d4bb571a9 Text review of the ngx_core_module. Egor Nikitin <yegor.nikitin@gmail.com> parents: 953 diff changeset	581 Each CPU set is represented by a bitmask of allowed CPUs.
469 8275e169f77b Documented the "worker_cpu_affinity" directive. Ruslan Ermilov <ru@nginx.com> parents: 455 diff changeset	582 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	583 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	584 </para>
8275e169f77b Documented the "worker_cpu_affinity" directive. Ruslan Ermilov <ru@nginx.com> parents: 455 diff changeset	585
8275e169f77b Documented the "worker_cpu_affinity" directive. Ruslan Ermilov <ru@nginx.com> parents: 455 diff changeset	586 <para>
8275e169f77b Documented the "worker_cpu_affinity" directive. Ruslan Ermilov <ru@nginx.com> parents: 455 diff changeset	587 For example,
8275e169f77b Documented the "worker_cpu_affinity" directive. Ruslan Ermilov <ru@nginx.com> parents: 455 diff changeset	588 <example>
8275e169f77b Documented the "worker_cpu_affinity" directive. Ruslan Ermilov <ru@nginx.com> parents: 455 diff changeset	589 worker_processes 4;
8275e169f77b Documented the "worker_cpu_affinity" directive. Ruslan Ermilov <ru@nginx.com> parents: 455 diff changeset	590 worker_cpu_affinity 0001 0010 0100 1000;
8275e169f77b Documented the "worker_cpu_affinity" directive. Ruslan Ermilov <ru@nginx.com> parents: 455 diff changeset	591 </example>
8275e169f77b Documented the "worker_cpu_affinity" directive. Ruslan Ermilov <ru@nginx.com> parents: 455 diff changeset	592 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	593 <example>
8275e169f77b Documented the "worker_cpu_affinity" directive. Ruslan Ermilov <ru@nginx.com> parents: 455 diff changeset	594 worker_processes 2;
8275e169f77b Documented the "worker_cpu_affinity" directive. Ruslan Ermilov <ru@nginx.com> parents: 455 diff changeset	595 worker_cpu_affinity 0101 1010;
8275e169f77b Documented the "worker_cpu_affinity" directive. Ruslan Ermilov <ru@nginx.com> parents: 455 diff changeset	596 </example>
8275e169f77b Documented the "worker_cpu_affinity" directive. Ruslan Ermilov <ru@nginx.com> parents: 455 diff changeset	597 binds the first worker process to CPU0/CPU2,
8275e169f77b Documented the "worker_cpu_affinity" directive. Ruslan Ermilov <ru@nginx.com> parents: 455 diff changeset	598 and the second worker process to CPU1/CPU3.
8275e169f77b Documented the "worker_cpu_affinity" directive. Ruslan Ermilov <ru@nginx.com> parents: 455 diff changeset	599 The second example is suitable for hyper-threading.
8275e169f77b Documented the "worker_cpu_affinity" directive. Ruslan Ermilov <ru@nginx.com> parents: 455 diff changeset	600 </para>
8275e169f77b Documented the "worker_cpu_affinity" directive. Ruslan Ermilov <ru@nginx.com> parents: 455 diff changeset	601
8275e169f77b Documented the "worker_cpu_affinity" directive. Ruslan Ermilov <ru@nginx.com> parents: 455 diff changeset	602 <para>
8275e169f77b Documented the "worker_cpu_affinity" directive. Ruslan Ermilov <ru@nginx.com> parents: 455 diff changeset	603 <note>
8275e169f77b Documented the "worker_cpu_affinity" directive. Ruslan Ermilov <ru@nginx.com> parents: 455 diff changeset	604 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	605 </note>
8275e169f77b Documented the "worker_cpu_affinity" directive. Ruslan Ermilov <ru@nginx.com> parents: 455 diff changeset	606 </para>
8275e169f77b Documented the "worker_cpu_affinity" directive. Ruslan Ermilov <ru@nginx.com> parents: 455 diff changeset	607
8275e169f77b Documented the "worker_cpu_affinity" directive. Ruslan Ermilov <ru@nginx.com> parents: 455 diff changeset	608 </directive>
8275e169f77b Documented the "worker_cpu_affinity" directive. Ruslan Ermilov <ru@nginx.com> parents: 455 diff changeset	609
8275e169f77b Documented the "worker_cpu_affinity" directive. Ruslan Ermilov <ru@nginx.com> parents: 455 diff changeset	610
63 6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	611 <directive name="worker_priority">
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	612 <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	613 <default>0</default>
63 6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	614 <context>main</context>
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	615
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	616 <para>
957 6d9d4bb571a9 Text review of the ngx_core_module. Egor Nikitin <yegor.nikitin@gmail.com> parents: 953 diff changeset	617 Defines the scheduling priority for worker processes like it is
63 6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	618 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	619 <value>number</value>
63 6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	620 means higher priority.
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	621 Allowed range normally varies from -20 to 20.
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	622 </para>
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	623
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	624 <para>
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	625 Example:
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	626 <example>
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	627 worker_priority -10;
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	628 </example>
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	629 </para>
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	630
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	631 </directive>
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	632
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	633
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	634 <directive name="worker_processes">
740 46d70031bea9 Documented the recently added "auto" parameter of the Andrey Belov <defan@nginx.com> parents: 659 diff changeset	635 <syntax><value>number</value> \| <literal>auto</literal></syntax>
102 c76a257f3fd4 The directive name is now automatically printed in <default> and <syntax>. Ruslan Ermilov <ru@nginx.com> parents: 98 diff changeset	636 <default>1</default>
63 6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	637 <context>main</context>
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	638
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	639 <para>
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	640 Defines the number of worker processes.
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	641 </para>
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	642
226 c4b33b07dcfe Added some basic hints on how to tune "worker_processes". Ruslan Ermilov <ru@nginx.com> parents: 158 diff changeset	643 <para>
c4b33b07dcfe Added some basic hints on how to tune "worker_processes". Ruslan Ermilov <ru@nginx.com> parents: 158 diff changeset	644 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	645 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	646 drives that store data, and load pattern.
957 6d9d4bb571a9 Text review of the ngx_core_module. Egor Nikitin <yegor.nikitin@gmail.com> parents: 953 diff changeset	647 When one is in doubt, setting it to the number of available CPU cores
740 46d70031bea9 Documented the recently added "auto" parameter of the Andrey Belov <defan@nginx.com> parents: 659 diff changeset	648 would be a good start (the value “<literal>auto</literal>”
46d70031bea9 Documented the recently added "auto" parameter of the Andrey Belov <defan@nginx.com> parents: 659 diff changeset	649 will try to autodetect it).
742 3a2e35f4c279 Documented that "worker_processes auto" appeared in version 1.3.8. Ruslan Ermilov <ru@nginx.com> parents: 740 diff changeset	650 <note>
3a2e35f4c279 Documented that "worker_processes auto" appeared in version 1.3.8. Ruslan Ermilov <ru@nginx.com> parents: 740 diff changeset	651 The <literal>auto</literal> parameter is supported starting from
764 f8434fdd3cd9 The "auto" parameter of the ""worker_processes" directive Ruslan Ermilov <ru@nginx.com> parents: 750 diff changeset	652 versions 1.3.8 and 1.2.5.
742 3a2e35f4c279 Documented that "worker_processes auto" appeared in version 1.3.8. Ruslan Ermilov <ru@nginx.com> parents: 740 diff changeset	653 </note>
226 c4b33b07dcfe Added some basic hints on how to tune "worker_processes". Ruslan Ermilov <ru@nginx.com> parents: 158 diff changeset	654 </para>
c4b33b07dcfe Added some basic hints on how to tune "worker_processes". Ruslan Ermilov <ru@nginx.com> parents: 158 diff changeset	655
63 6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	656 </directive>
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	657
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	658
82 89c31b453d40 Sorted directives alphabetically. Ruslan Ermilov <ru@nginx.com> parents: 63 diff changeset	659 <directive name="worker_rlimit_core">
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	660 <syntax><value>size</value></syntax>
82 89c31b453d40 Sorted directives alphabetically. Ruslan Ermilov <ru@nginx.com> parents: 63 diff changeset	661 <default/>
89c31b453d40 Sorted directives alphabetically. Ruslan Ermilov <ru@nginx.com> parents: 63 diff changeset	662 <context>main</context>
89c31b453d40 Sorted directives alphabetically. Ruslan Ermilov <ru@nginx.com> parents: 63 diff changeset	663
89c31b453d40 Sorted directives alphabetically. Ruslan Ermilov <ru@nginx.com> parents: 63 diff changeset	664 <para>
89c31b453d40 Sorted directives alphabetically. Ruslan Ermilov <ru@nginx.com> parents: 63 diff changeset	665 Changes the limit on the largest size of a core file
89c31b453d40 Sorted directives alphabetically. Ruslan Ermilov <ru@nginx.com> parents: 63 diff changeset	666 (<c-def>RLIMIT_CORE</c-def>) for worker processes.
89c31b453d40 Sorted directives alphabetically. Ruslan Ermilov <ru@nginx.com> parents: 63 diff changeset	667 Used to increase the limit without restarting the main process.
89c31b453d40 Sorted directives alphabetically. Ruslan Ermilov <ru@nginx.com> parents: 63 diff changeset	668 </para>
89c31b453d40 Sorted directives alphabetically. Ruslan Ermilov <ru@nginx.com> parents: 63 diff changeset	669
89c31b453d40 Sorted directives alphabetically. Ruslan Ermilov <ru@nginx.com> parents: 63 diff changeset	670 </directive>
89c31b453d40 Sorted directives alphabetically. Ruslan Ermilov <ru@nginx.com> parents: 63 diff changeset	671
89c31b453d40 Sorted directives alphabetically. Ruslan Ermilov <ru@nginx.com> parents: 63 diff changeset	672
89c31b453d40 Sorted directives alphabetically. Ruslan Ermilov <ru@nginx.com> parents: 63 diff changeset	673 <directive name="worker_rlimit_nofile">
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	674 <syntax><value>number</value></syntax>
82 89c31b453d40 Sorted directives alphabetically. Ruslan Ermilov <ru@nginx.com> parents: 63 diff changeset	675 <default/>
89c31b453d40 Sorted directives alphabetically. Ruslan Ermilov <ru@nginx.com> parents: 63 diff changeset	676 <context>main</context>
89c31b453d40 Sorted directives alphabetically. Ruslan Ermilov <ru@nginx.com> parents: 63 diff changeset	677
89c31b453d40 Sorted directives alphabetically. Ruslan Ermilov <ru@nginx.com> parents: 63 diff changeset	678 <para>
89c31b453d40 Sorted directives alphabetically. Ruslan Ermilov <ru@nginx.com> parents: 63 diff changeset	679 Changes the limit on the maximum number of open files
89c31b453d40 Sorted directives alphabetically. Ruslan Ermilov <ru@nginx.com> parents: 63 diff changeset	680 (<c-def>RLIMIT_NOFILE</c-def>) for worker processes.
89c31b453d40 Sorted directives alphabetically. Ruslan Ermilov <ru@nginx.com> parents: 63 diff changeset	681 Used to increase the limit without restarting the main process.
89c31b453d40 Sorted directives alphabetically. Ruslan Ermilov <ru@nginx.com> parents: 63 diff changeset	682 </para>
89c31b453d40 Sorted directives alphabetically. Ruslan Ermilov <ru@nginx.com> parents: 63 diff changeset	683
89c31b453d40 Sorted directives alphabetically. Ruslan Ermilov <ru@nginx.com> parents: 63 diff changeset	684 </directive>
89c31b453d40 Sorted directives alphabetically. Ruslan Ermilov <ru@nginx.com> parents: 63 diff changeset	685
89c31b453d40 Sorted directives alphabetically. Ruslan Ermilov <ru@nginx.com> parents: 63 diff changeset	686
554 ccb7451af1d8 Documented the "worker_rlimit_sigpending" directive. Ruslan Ermilov <ru@nginx.com> parents: 545 diff changeset	687 <directive name="worker_rlimit_sigpending">
ccb7451af1d8 Documented the "worker_rlimit_sigpending" directive. Ruslan Ermilov <ru@nginx.com> parents: 545 diff changeset	688 <syntax><value>number</value></syntax>
ccb7451af1d8 Documented the "worker_rlimit_sigpending" directive. Ruslan Ermilov <ru@nginx.com> parents: 545 diff changeset	689 <default/>
ccb7451af1d8 Documented the "worker_rlimit_sigpending" directive. Ruslan Ermilov <ru@nginx.com> parents: 545 diff changeset	690 <context>main</context>
ccb7451af1d8 Documented the "worker_rlimit_sigpending" directive. Ruslan Ermilov <ru@nginx.com> parents: 545 diff changeset	691
ccb7451af1d8 Documented the "worker_rlimit_sigpending" directive. Ruslan Ermilov <ru@nginx.com> parents: 545 diff changeset	692 <para>
ccb7451af1d8 Documented the "worker_rlimit_sigpending" directive. Ruslan Ermilov <ru@nginx.com> parents: 545 diff changeset	693 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	694 connection processing method,
ccb7451af1d8 Documented the "worker_rlimit_sigpending" directive. Ruslan Ermilov <ru@nginx.com> parents: 545 diff changeset	695 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	696 (<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	697 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	698 </para>
ccb7451af1d8 Documented the "worker_rlimit_sigpending" directive. Ruslan Ermilov <ru@nginx.com> parents: 545 diff changeset	699
ccb7451af1d8 Documented the "worker_rlimit_sigpending" directive. Ruslan Ermilov <ru@nginx.com> parents: 545 diff changeset	700 </directive>
ccb7451af1d8 Documented the "worker_rlimit_sigpending" directive. Ruslan Ermilov <ru@nginx.com> parents: 545 diff changeset	701
ccb7451af1d8 Documented the "worker_rlimit_sigpending" directive. Ruslan Ermilov <ru@nginx.com> parents: 545 diff changeset	702
63 6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	703 <directive name="working_directory">
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	704 <syntax><value>directory</value></syntax>
63 6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	705 <default/>
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	706 <context>main</context>
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	707
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	708 <para>
957 6d9d4bb571a9 Text review of the ngx_core_module. Egor Nikitin <yegor.nikitin@gmail.com> parents: 953 diff changeset	709 Defines the current working directory for a worker process.
63 6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	710 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	711 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	712 specified directory.
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	713 </para>
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	714
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	715 </directive>
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	716
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	717 </section>
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	718
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	719 </module>

Mercurial > hg > nginx-site

annotate xml/en/docs/ngx_core_module.xml @ 966:95c3c3bbf1ce