nginx-site: xml/en/docs/ngx_core

annotate xml/en/docs/ngx_core_module.xml @ 2634:0722b485010c

Improved wording in the thread_pool directive description.

author	Maxim Dounin <mdounin@mdounin.ru>
date	Tue, 08 Dec 2020 16:01:39 +0300
parents	eeed494bba51
children	eb5950986b11

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"
2634 0722b485010c Improved wording in the thread_pool directive description. Maxim Dounin <mdounin@mdounin.ru> parents: 2593 diff changeset	13 rev="27">
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>
1755 bde044a0bd90 Documented that accept_mutex is off by default. Yaroslav Zhuravlev <yar@nginx.com> parents: 1697 diff changeset	40 <default>off</default>
571 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.
1755 bde044a0bd90 Documented that accept_mutex is off by default. Yaroslav Zhuravlev <yar@nginx.com> parents: 1697 diff changeset	49 <note>
1784 68928f8d31d9 Updated accept_mutex with info about reuseport and epollexclusive. Yaroslav Zhuravlev <yar@nginx.com> parents: 1755 diff changeset	50 There is no need to enable <literal>accept_mutex</literal>
68928f8d31d9 Updated accept_mutex with info about reuseport and epollexclusive. Yaroslav Zhuravlev <yar@nginx.com> parents: 1755 diff changeset	51 on systems that support the
68928f8d31d9 Updated accept_mutex with info about reuseport and epollexclusive. Yaroslav Zhuravlev <yar@nginx.com> parents: 1755 diff changeset	52 <link doc="events.xml" id="epoll">EPOLLEXCLUSIVE</link> flag (1.11.3) or
68928f8d31d9 Updated accept_mutex with info about reuseport and epollexclusive. Yaroslav Zhuravlev <yar@nginx.com> parents: 1755 diff changeset	53 when using <link doc="http/ngx_http_core_module.xml" id="reuseport"/>.
68928f8d31d9 Updated accept_mutex with info about reuseport and epollexclusive. Yaroslav Zhuravlev <yar@nginx.com> parents: 1755 diff changeset	54 </note>
68928f8d31d9 Updated accept_mutex with info about reuseport and epollexclusive. Yaroslav Zhuravlev <yar@nginx.com> parents: 1755 diff changeset	55 <note>
1755 bde044a0bd90 Documented that accept_mutex is off by default. Yaroslav Zhuravlev <yar@nginx.com> parents: 1697 diff changeset	56 Prior to version 1.11.3, the default value was <literal>on</literal>.
bde044a0bd90 Documented that accept_mutex is off by default. Yaroslav Zhuravlev <yar@nginx.com> parents: 1697 diff changeset	57 </note>
571 71d775bef043 Documented accept_mutex, accept_mutex_delay, multi_accept, and lock_file. Ruslan Ermilov <ru@nginx.com> parents: 556 diff changeset	58 </para>
71d775bef043 Documented accept_mutex, accept_mutex_delay, multi_accept, and lock_file. Ruslan Ermilov <ru@nginx.com> parents: 556 diff changeset	59
71d775bef043 Documented accept_mutex, accept_mutex_delay, multi_accept, and lock_file. Ruslan Ermilov <ru@nginx.com> parents: 556 diff changeset	60 </directive>
71d775bef043 Documented accept_mutex, accept_mutex_delay, multi_accept, and lock_file. Ruslan Ermilov <ru@nginx.com> parents: 556 diff changeset	61
71d775bef043 Documented accept_mutex, accept_mutex_delay, multi_accept, and lock_file. Ruslan Ermilov <ru@nginx.com> parents: 556 diff changeset	62
71d775bef043 Documented accept_mutex, accept_mutex_delay, multi_accept, and lock_file. Ruslan Ermilov <ru@nginx.com> parents: 556 diff changeset	63 <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	64 <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	65 <default>500ms</default>
71d775bef043 Documented accept_mutex, accept_mutex_delay, multi_accept, and lock_file. Ruslan Ermilov <ru@nginx.com> parents: 556 diff changeset	66 <context>events</context>
71d775bef043 Documented accept_mutex, accept_mutex_delay, multi_accept, and lock_file. Ruslan Ermilov <ru@nginx.com> parents: 556 diff changeset	67
71d775bef043 Documented accept_mutex, accept_mutex_delay, multi_accept, and lock_file. Ruslan Ermilov <ru@nginx.com> parents: 556 diff changeset	68 <para>
71d775bef043 Documented accept_mutex, accept_mutex_delay, multi_accept, and lock_file. Ruslan Ermilov <ru@nginx.com> parents: 556 diff changeset	69 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	70 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	71 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	72 new connections.
571 71d775bef043 Documented accept_mutex, accept_mutex_delay, multi_accept, and lock_file. Ruslan Ermilov <ru@nginx.com> parents: 556 diff changeset	73 </para>
71d775bef043 Documented accept_mutex, accept_mutex_delay, multi_accept, and lock_file. Ruslan Ermilov <ru@nginx.com> parents: 556 diff changeset	74
71d775bef043 Documented accept_mutex, accept_mutex_delay, multi_accept, and lock_file. Ruslan Ermilov <ru@nginx.com> parents: 556 diff changeset	75 </directive>
71d775bef043 Documented accept_mutex, accept_mutex_delay, multi_accept, and lock_file. Ruslan Ermilov <ru@nginx.com> parents: 556 diff changeset	76
71d775bef043 Documented accept_mutex, accept_mutex_delay, multi_accept, and lock_file. Ruslan Ermilov <ru@nginx.com> parents: 556 diff changeset	77
63 6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	78 <directive name="daemon">
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	79 <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	80 <default>on</default>
63 6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	81 <context>main</context>
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	82
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	83 <para>
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	84 Determines whether nginx should become a daemon.
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	85 Mainly used during development.
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	86 </para>
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	87
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	88 </directive>
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	89
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	90
516 8e1356bd281a Documented the "debug_connection" directive. Ruslan Ermilov <ru@nginx.com> parents: 469 diff changeset	91 <directive name="debug_connection">
8e1356bd281a Documented the "debug_connection" directive. Ruslan Ermilov <ru@nginx.com> parents: 469 diff changeset	92 <syntax>
8e1356bd281a Documented the "debug_connection" directive. Ruslan Ermilov <ru@nginx.com> parents: 469 diff changeset	93 <value>address</value> \|
8e1356bd281a Documented the "debug_connection" directive. Ruslan Ermilov <ru@nginx.com> parents: 469 diff changeset	94 <value>CIDR</value> \|
8e1356bd281a Documented the "debug_connection" directive. Ruslan Ermilov <ru@nginx.com> parents: 469 diff changeset	95 <literal>unix:</literal></syntax>
8e1356bd281a Documented the "debug_connection" directive. Ruslan Ermilov <ru@nginx.com> parents: 469 diff changeset	96 <default/>
8e1356bd281a Documented the "debug_connection" directive. Ruslan Ermilov <ru@nginx.com> parents: 469 diff changeset	97 <context>events</context>
8e1356bd281a Documented the "debug_connection" directive. Ruslan Ermilov <ru@nginx.com> parents: 469 diff changeset	98
8e1356bd281a Documented the "debug_connection" directive. Ruslan Ermilov <ru@nginx.com> parents: 469 diff changeset	99 <para>
8e1356bd281a Documented the "debug_connection" directive. Ruslan Ermilov <ru@nginx.com> parents: 469 diff changeset	100 Enables debugging log for selected client connections.
8e1356bd281a Documented the "debug_connection" directive. Ruslan Ermilov <ru@nginx.com> parents: 469 diff changeset	101 Other connections will use logging level set by the
8e1356bd281a Documented the "debug_connection" directive. Ruslan Ermilov <ru@nginx.com> parents: 469 diff changeset	102 <link id="error_log"/> directive.
523 a8daad8e83bb Documented 1.2.1 changes. Ruslan Ermilov <ru@nginx.com> parents: 516 diff changeset	103 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	104 address or network.
614 0526cac4637e Removed intimate details of the "debug_connection" directive's Ruslan Ermilov <ru@nginx.com> parents: 610 diff changeset	105 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	106 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	107 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	108 <example>
8e1356bd281a Documented the "debug_connection" directive. Ruslan Ermilov <ru@nginx.com> parents: 469 diff changeset	109 events {
8e1356bd281a Documented the "debug_connection" directive. Ruslan Ermilov <ru@nginx.com> parents: 469 diff changeset	110 debug_connection 127.0.0.1;
8e1356bd281a Documented the "debug_connection" directive. Ruslan Ermilov <ru@nginx.com> parents: 469 diff changeset	111 debug_connection localhost;
8e1356bd281a Documented the "debug_connection" directive. Ruslan Ermilov <ru@nginx.com> parents: 469 diff changeset	112 debug_connection 192.0.2.0/24;
8e1356bd281a Documented the "debug_connection" directive. Ruslan Ermilov <ru@nginx.com> parents: 469 diff changeset	113 debug_connection ::1;
8e1356bd281a Documented the "debug_connection" directive. Ruslan Ermilov <ru@nginx.com> parents: 469 diff changeset	114 debug_connection 2001:0db8::/32;
8e1356bd281a Documented the "debug_connection" directive. Ruslan Ermilov <ru@nginx.com> parents: 469 diff changeset	115 debug_connection unix:;
8e1356bd281a Documented the "debug_connection" directive. Ruslan Ermilov <ru@nginx.com> parents: 469 diff changeset	116 ...
8e1356bd281a Documented the "debug_connection" directive. Ruslan Ermilov <ru@nginx.com> parents: 469 diff changeset	117 }
8e1356bd281a Documented the "debug_connection" directive. Ruslan Ermilov <ru@nginx.com> parents: 469 diff changeset	118 </example>
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 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	121 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	122 see “<link doc="debugging_log.xml"/>”.
516 8e1356bd281a Documented the "debug_connection" directive. Ruslan Ermilov <ru@nginx.com> parents: 469 diff changeset	123 </note>
8e1356bd281a Documented the "debug_connection" directive. Ruslan Ermilov <ru@nginx.com> parents: 469 diff changeset	124 </para>
8e1356bd281a Documented the "debug_connection" directive. Ruslan Ermilov <ru@nginx.com> parents: 469 diff changeset	125
8e1356bd281a Documented the "debug_connection" directive. Ruslan Ermilov <ru@nginx.com> parents: 469 diff changeset	126 </directive>
8e1356bd281a Documented the "debug_connection" directive. Ruslan Ermilov <ru@nginx.com> parents: 469 diff changeset	127
8e1356bd281a Documented the "debug_connection" directive. Ruslan Ermilov <ru@nginx.com> parents: 469 diff changeset	128
574 5e9ff979eac8 Documented debug_points. Ruslan Ermilov <ru@nginx.com> parents: 571 diff changeset	129 <directive name="debug_points">
5e9ff979eac8 Documented debug_points. Ruslan Ermilov <ru@nginx.com> parents: 571 diff changeset	130 <syntax><literal>abort</literal> \| <literal>stop</literal></syntax>
5e9ff979eac8 Documented debug_points. Ruslan Ermilov <ru@nginx.com> parents: 571 diff changeset	131 <default/>
5e9ff979eac8 Documented debug_points. Ruslan Ermilov <ru@nginx.com> parents: 571 diff changeset	132 <context>main</context>
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 This directive is used for debugging.
5e9ff979eac8 Documented debug_points. Ruslan Ermilov <ru@nginx.com> parents: 571 diff changeset	136 </para>
5e9ff979eac8 Documented debug_points. Ruslan Ermilov <ru@nginx.com> parents: 571 diff changeset	137
5e9ff979eac8 Documented debug_points. Ruslan Ermilov <ru@nginx.com> parents: 571 diff changeset	138 <para>
5e9ff979eac8 Documented debug_points. Ruslan Ermilov <ru@nginx.com> parents: 571 diff changeset	139 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	140 restart of working processes, enabling <literal>debug_points</literal>
5e9ff979eac8 Documented debug_points. Ruslan Ermilov <ru@nginx.com> parents: 571 diff changeset	141 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	142 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	143 analysis using a system debugger.
5e9ff979eac8 Documented debug_points. Ruslan Ermilov <ru@nginx.com> parents: 571 diff changeset	144 </para>
5e9ff979eac8 Documented debug_points. Ruslan Ermilov <ru@nginx.com> parents: 571 diff changeset	145
5e9ff979eac8 Documented debug_points. Ruslan Ermilov <ru@nginx.com> parents: 571 diff changeset	146 </directive>
5e9ff979eac8 Documented debug_points. Ruslan Ermilov <ru@nginx.com> parents: 571 diff changeset	147
5e9ff979eac8 Documented debug_points. Ruslan Ermilov <ru@nginx.com> parents: 571 diff changeset	148
2142 ca7568f67dee Sorted directives alphabetically. Ruslan Ermilov <ru@nginx.com> parents: 2080 diff changeset	149 <directive name="env">
ca7568f67dee Sorted directives alphabetically. Ruslan Ermilov <ru@nginx.com> parents: 2080 diff changeset	150 <syntax><value>variable</value>[=<value>value</value>]</syntax>
ca7568f67dee Sorted directives alphabetically. Ruslan Ermilov <ru@nginx.com> parents: 2080 diff changeset	151 <default>TZ</default>
ca7568f67dee Sorted directives alphabetically. Ruslan Ermilov <ru@nginx.com> parents: 2080 diff changeset	152 <context>main</context>
ca7568f67dee Sorted directives alphabetically. Ruslan Ermilov <ru@nginx.com> parents: 2080 diff changeset	153
ca7568f67dee Sorted directives alphabetically. Ruslan Ermilov <ru@nginx.com> parents: 2080 diff changeset	154 <para>
ca7568f67dee Sorted directives alphabetically. Ruslan Ermilov <ru@nginx.com> parents: 2080 diff changeset	155 By default, nginx removes all environment variables inherited
ca7568f67dee Sorted directives alphabetically. Ruslan Ermilov <ru@nginx.com> parents: 2080 diff changeset	156 from its parent process except the TZ variable.
ca7568f67dee Sorted directives alphabetically. Ruslan Ermilov <ru@nginx.com> parents: 2080 diff changeset	157 This directive allows preserving some of the inherited variables,
ca7568f67dee Sorted directives alphabetically. Ruslan Ermilov <ru@nginx.com> parents: 2080 diff changeset	158 changing their values, or creating new environment variables.
ca7568f67dee Sorted directives alphabetically. Ruslan Ermilov <ru@nginx.com> parents: 2080 diff changeset	159 These variables are then:
ca7568f67dee Sorted directives alphabetically. Ruslan Ermilov <ru@nginx.com> parents: 2080 diff changeset	160 <list type="bullet">
ca7568f67dee Sorted directives alphabetically. Ruslan Ermilov <ru@nginx.com> parents: 2080 diff changeset	161
ca7568f67dee Sorted directives alphabetically. Ruslan Ermilov <ru@nginx.com> parents: 2080 diff changeset	162 <listitem>
ca7568f67dee Sorted directives alphabetically. Ruslan Ermilov <ru@nginx.com> parents: 2080 diff changeset	163 inherited during a <link doc="control.xml" id="upgrade">live upgrade</link>
ca7568f67dee Sorted directives alphabetically. Ruslan Ermilov <ru@nginx.com> parents: 2080 diff changeset	164 of an executable file;
ca7568f67dee Sorted directives alphabetically. Ruslan Ermilov <ru@nginx.com> parents: 2080 diff changeset	165 </listitem>
ca7568f67dee Sorted directives alphabetically. Ruslan Ermilov <ru@nginx.com> parents: 2080 diff changeset	166
ca7568f67dee Sorted directives alphabetically. Ruslan Ermilov <ru@nginx.com> parents: 2080 diff changeset	167 <listitem>
ca7568f67dee Sorted directives alphabetically. Ruslan Ermilov <ru@nginx.com> parents: 2080 diff changeset	168 used by the
ca7568f67dee Sorted directives alphabetically. Ruslan Ermilov <ru@nginx.com> parents: 2080 diff changeset	169 <link doc="http/ngx_http_perl_module.xml">ngx_http_perl_module</link> module;
ca7568f67dee Sorted directives alphabetically. Ruslan Ermilov <ru@nginx.com> parents: 2080 diff changeset	170 </listitem>
ca7568f67dee Sorted directives alphabetically. Ruslan Ermilov <ru@nginx.com> parents: 2080 diff changeset	171
ca7568f67dee Sorted directives alphabetically. Ruslan Ermilov <ru@nginx.com> parents: 2080 diff changeset	172 <listitem>
ca7568f67dee Sorted directives alphabetically. Ruslan Ermilov <ru@nginx.com> parents: 2080 diff changeset	173 used by worker processes.
ca7568f67dee Sorted directives alphabetically. Ruslan Ermilov <ru@nginx.com> parents: 2080 diff changeset	174 One should bear in mind that controlling system libraries in this way
ca7568f67dee Sorted directives alphabetically. Ruslan Ermilov <ru@nginx.com> parents: 2080 diff changeset	175 is not always possible as it is common for libraries to check
ca7568f67dee Sorted directives alphabetically. Ruslan Ermilov <ru@nginx.com> parents: 2080 diff changeset	176 variables only during initialization, well before they can be set
ca7568f67dee Sorted directives alphabetically. Ruslan Ermilov <ru@nginx.com> parents: 2080 diff changeset	177 using this directive.
ca7568f67dee Sorted directives alphabetically. Ruslan Ermilov <ru@nginx.com> parents: 2080 diff changeset	178 An exception from this is an above mentioned
ca7568f67dee Sorted directives alphabetically. Ruslan Ermilov <ru@nginx.com> parents: 2080 diff changeset	179 <link doc="control.xml" id="upgrade">live upgrade</link>
ca7568f67dee Sorted directives alphabetically. Ruslan Ermilov <ru@nginx.com> parents: 2080 diff changeset	180 of an executable file.
ca7568f67dee Sorted directives alphabetically. Ruslan Ermilov <ru@nginx.com> parents: 2080 diff changeset	181 </listitem>
ca7568f67dee Sorted directives alphabetically. Ruslan Ermilov <ru@nginx.com> parents: 2080 diff changeset	182
ca7568f67dee Sorted directives alphabetically. Ruslan Ermilov <ru@nginx.com> parents: 2080 diff changeset	183 </list>
ca7568f67dee Sorted directives alphabetically. Ruslan Ermilov <ru@nginx.com> parents: 2080 diff changeset	184 </para>
ca7568f67dee Sorted directives alphabetically. Ruslan Ermilov <ru@nginx.com> parents: 2080 diff changeset	185
ca7568f67dee Sorted directives alphabetically. Ruslan Ermilov <ru@nginx.com> parents: 2080 diff changeset	186 <para>
ca7568f67dee Sorted directives alphabetically. Ruslan Ermilov <ru@nginx.com> parents: 2080 diff changeset	187 The TZ variable is always inherited and available to the
ca7568f67dee Sorted directives alphabetically. Ruslan Ermilov <ru@nginx.com> parents: 2080 diff changeset	188 <link doc="http/ngx_http_perl_module.xml">ngx_http_perl_module</link>
ca7568f67dee Sorted directives alphabetically. Ruslan Ermilov <ru@nginx.com> parents: 2080 diff changeset	189 module, unless it is configured explicitly.
ca7568f67dee Sorted directives alphabetically. Ruslan Ermilov <ru@nginx.com> parents: 2080 diff changeset	190 </para>
ca7568f67dee Sorted directives alphabetically. Ruslan Ermilov <ru@nginx.com> parents: 2080 diff changeset	191
ca7568f67dee Sorted directives alphabetically. Ruslan Ermilov <ru@nginx.com> parents: 2080 diff changeset	192 <para>
ca7568f67dee Sorted directives alphabetically. Ruslan Ermilov <ru@nginx.com> parents: 2080 diff changeset	193 Usage example:
ca7568f67dee Sorted directives alphabetically. Ruslan Ermilov <ru@nginx.com> parents: 2080 diff changeset	194 <example>
ca7568f67dee Sorted directives alphabetically. Ruslan Ermilov <ru@nginx.com> parents: 2080 diff changeset	195 env MALLOC_OPTIONS;
ca7568f67dee Sorted directives alphabetically. Ruslan Ermilov <ru@nginx.com> parents: 2080 diff changeset	196 env PERL5LIB=/data/site/modules;
ca7568f67dee Sorted directives alphabetically. Ruslan Ermilov <ru@nginx.com> parents: 2080 diff changeset	197 env OPENSSL_ALLOW_PROXY_CERTS=1;
ca7568f67dee Sorted directives alphabetically. Ruslan Ermilov <ru@nginx.com> parents: 2080 diff changeset	198 </example>
ca7568f67dee Sorted directives alphabetically. Ruslan Ermilov <ru@nginx.com> parents: 2080 diff changeset	199 </para>
ca7568f67dee Sorted directives alphabetically. Ruslan Ermilov <ru@nginx.com> parents: 2080 diff changeset	200
ca7568f67dee Sorted directives alphabetically. Ruslan Ermilov <ru@nginx.com> parents: 2080 diff changeset	201 <para>
ca7568f67dee Sorted directives alphabetically. Ruslan Ermilov <ru@nginx.com> parents: 2080 diff changeset	202 <note>
ca7568f67dee Sorted directives alphabetically. Ruslan Ermilov <ru@nginx.com> parents: 2080 diff changeset	203 The NGINX environment variable is used internally by nginx
ca7568f67dee Sorted directives alphabetically. Ruslan Ermilov <ru@nginx.com> parents: 2080 diff changeset	204 and should not be set directly by the user.
ca7568f67dee Sorted directives alphabetically. Ruslan Ermilov <ru@nginx.com> parents: 2080 diff changeset	205 </note>
ca7568f67dee Sorted directives alphabetically. Ruslan Ermilov <ru@nginx.com> parents: 2080 diff changeset	206 </para>
ca7568f67dee Sorted directives alphabetically. Ruslan Ermilov <ru@nginx.com> parents: 2080 diff changeset	207
ca7568f67dee Sorted directives alphabetically. Ruslan Ermilov <ru@nginx.com> parents: 2080 diff changeset	208 </directive>
ca7568f67dee Sorted directives alphabetically. Ruslan Ermilov <ru@nginx.com> parents: 2080 diff changeset	209
ca7568f67dee Sorted directives alphabetically. Ruslan Ermilov <ru@nginx.com> parents: 2080 diff changeset	210
158 05e58829de2e Documented the "error_log" directive. Ruslan Ermilov <ru@nginx.com> parents: 102 diff changeset	211 <directive name="error_log">
1697 147e3d0339e8 Reduced syntax clutter in the error_log directive. Maxim Dounin <mdounin@mdounin.ru> parents: 1695 diff changeset	212 <syntax><value>file</value> [<value>level</value>]</syntax>
158 05e58829de2e Documented the "error_log" directive. Ruslan Ermilov <ru@nginx.com> parents: 102 diff changeset	213 <default>logs/error.log error</default>
05e58829de2e Documented the "error_log" directive. Ruslan Ermilov <ru@nginx.com> parents: 102 diff changeset	214 <context>main</context>
05e58829de2e Documented the "error_log" directive. Ruslan Ermilov <ru@nginx.com> parents: 102 diff changeset	215 <context>http</context>
1480 d1e1a8d34bce Documented mail support in error_log. Yaroslav Zhuravlev <yar@nginx.com> parents: 1465 diff changeset	216 <context>mail</context>
1450 f5b5eefc43cb Updated commercial docs for the upcoming release. Ruslan Ermilov <ru@nginx.com> parents: 1449 diff changeset	217 <context>stream</context>
158 05e58829de2e Documented the "error_log" directive. Ruslan Ermilov <ru@nginx.com> parents: 102 diff changeset	218 <context>server</context>
05e58829de2e Documented the "error_log" directive. Ruslan Ermilov <ru@nginx.com> parents: 102 diff changeset	219 <context>location</context>
05e58829de2e Documented the "error_log" directive. Ruslan Ermilov <ru@nginx.com> parents: 102 diff changeset	220
05e58829de2e Documented the "error_log" directive. Ruslan Ermilov <ru@nginx.com> parents: 102 diff changeset	221 <para>
05e58829de2e Documented the "error_log" directive. Ruslan Ermilov <ru@nginx.com> parents: 102 diff changeset	222 Configures logging.
2593 eeed494bba51 Unified phrases about configuration levels and inheritance. Ruslan Ermilov <ru@nginx.com> parents: 2142 diff changeset	223 Several logs can be specified on the same configuration level (1.5.2).
1893 f1c18acbe785 Added info about default log file to error_log. Yaroslav Zhuravlev <yar@nginx.com> parents: 1888 diff changeset	224 If on the <literal>main</literal> configuration level writing a log to a file
f1c18acbe785 Added info about default log file to error_log. Yaroslav Zhuravlev <yar@nginx.com> parents: 1888 diff changeset	225 is not explicitly defined, the default file will be used.
158 05e58829de2e Documented the "error_log" directive. Ruslan Ermilov <ru@nginx.com> parents: 102 diff changeset	226 </para>
05e58829de2e Documented the "error_log" directive. Ruslan Ermilov <ru@nginx.com> parents: 102 diff changeset	227
05e58829de2e Documented the "error_log" directive. Ruslan Ermilov <ru@nginx.com> parents: 102 diff changeset	228 <para>
1697 147e3d0339e8 Reduced syntax clutter in the error_log directive. Maxim Dounin <mdounin@mdounin.ru> parents: 1695 diff changeset	229 The first parameter defines a <value>file</value> that will store the log.
158 05e58829de2e Documented the "error_log" directive. Ruslan Ermilov <ru@nginx.com> parents: 102 diff changeset	230 <!--
05e58829de2e Documented the "error_log" directive. Ruslan Ermilov <ru@nginx.com> parents: 102 diff changeset	231 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	232 -->
455 571b790ddf9e error_log: documented the special value "stderr" and default logging level. Ruslan Ermilov <ru@nginx.com> parents: 444 diff changeset	233 The special value <literal>stderr</literal> selects the standard error file.
1285 4e89518a5999 Moved syslog configuration details into the separate documents. Ruslan Ermilov <ru@nginx.com> parents: 1205 diff changeset	234 Logging to <link doc="syslog.xml">syslog</link> can be configured by specifying
953 aded7086e84f Commercial version documentation. Ruslan Ermilov <ru@nginx.com> parents: 935 diff changeset	235 the “<literal>syslog:</literal>” prefix.
1449 c79501e16e26 Documented cyclic memory buffer support for error_log. Yaroslav Zhuravlev <yar@nginx.com> parents: 1436 diff changeset	236 Logging to a
c79501e16e26 Documented cyclic memory buffer support for error_log. Yaroslav Zhuravlev <yar@nginx.com> parents: 1436 diff changeset	237 <link doc="debugging_log.xml" id="memory">cyclic memory buffer</link>
c79501e16e26 Documented cyclic memory buffer support for error_log. Yaroslav Zhuravlev <yar@nginx.com> parents: 1436 diff changeset	238 can be configured by specifying the “<literal>memory:</literal>” prefix and
c79501e16e26 Documented cyclic memory buffer support for error_log. Yaroslav Zhuravlev <yar@nginx.com> parents: 1436 diff changeset	239 buffer <value>size</value>, and is generally used for debugging (1.7.11).
158 05e58829de2e Documented the "error_log" directive. Ruslan Ermilov <ru@nginx.com> parents: 102 diff changeset	240 </para>
05e58829de2e Documented the "error_log" directive. Ruslan Ermilov <ru@nginx.com> parents: 102 diff changeset	241
05e58829de2e Documented the "error_log" directive. Ruslan Ermilov <ru@nginx.com> parents: 102 diff changeset	242 <para>
1695 aa95174efa80 Moved levels from error_log syntax to description. Maxim Dounin <mdounin@mdounin.ru> parents: 1650 diff changeset	243 The second parameter determines the <value>level</value> of logging,
aa95174efa80 Moved levels from error_log syntax to description. Maxim Dounin <mdounin@mdounin.ru> parents: 1650 diff changeset	244 and can be one of the following:
aa95174efa80 Moved levels from error_log syntax to description. Maxim Dounin <mdounin@mdounin.ru> parents: 1650 diff changeset	245 <literal>debug</literal>, <literal>info</literal>, <literal>notice</literal>,
aa95174efa80 Moved levels from error_log syntax to description. Maxim Dounin <mdounin@mdounin.ru> parents: 1650 diff changeset	246 <literal>warn</literal>, <literal>error</literal>, <literal>crit</literal>,
aa95174efa80 Moved levels from error_log syntax to description. Maxim Dounin <mdounin@mdounin.ru> parents: 1650 diff changeset	247 <literal>alert</literal>, or <literal>emerg</literal>.
158 05e58829de2e Documented the "error_log" directive. Ruslan Ermilov <ru@nginx.com> parents: 102 diff changeset	248 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	249 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	250 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	251 For example, the default level <literal>error</literal> will
4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	252 cause <literal>error</literal>, <literal>crit</literal>,
4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	253 <literal>alert</literal>, and <literal>emerg</literal> messages
158 05e58829de2e Documented the "error_log" directive. Ruslan Ermilov <ru@nginx.com> parents: 102 diff changeset	254 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	255 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	256 <note>
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	257 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	258 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	259 see “<link doc="debugging_log.xml"/>”.
158 05e58829de2e Documented the "error_log" directive. Ruslan Ermilov <ru@nginx.com> parents: 102 diff changeset	260 </note>
1450 f5b5eefc43cb Updated commercial docs for the upcoming release. Ruslan Ermilov <ru@nginx.com> parents: 1449 diff changeset	261
f5b5eefc43cb Updated commercial docs for the upcoming release. Ruslan Ermilov <ru@nginx.com> parents: 1449 diff changeset	262 <note>
f5b5eefc43cb Updated commercial docs for the upcoming release. Ruslan Ermilov <ru@nginx.com> parents: 1449 diff changeset	263 The directive can be specified on the
f5b5eefc43cb Updated commercial docs for the upcoming release. Ruslan Ermilov <ru@nginx.com> parents: 1449 diff changeset	264 <literal>stream</literal> level
1888 3ed02f21146b Merged notes about versions in error_log. Yaroslav Zhuravlev <yar@nginx.com> parents: 1784 diff changeset	265 starting from version 1.7.11,
3ed02f21146b Merged notes about versions in error_log. Yaroslav Zhuravlev <yar@nginx.com> parents: 1784 diff changeset	266 and on the <literal>mail</literal> level
1480 d1e1a8d34bce Documented mail support in error_log. Yaroslav Zhuravlev <yar@nginx.com> parents: 1465 diff changeset	267 starting from version 1.9.0.
d1e1a8d34bce Documented mail support in error_log. Yaroslav Zhuravlev <yar@nginx.com> parents: 1465 diff changeset	268 </note>
158 05e58829de2e Documented the "error_log" directive. Ruslan Ermilov <ru@nginx.com> parents: 102 diff changeset	269 </para>
05e58829de2e Documented the "error_log" directive. Ruslan Ermilov <ru@nginx.com> parents: 102 diff changeset	270
05e58829de2e Documented the "error_log" directive. Ruslan Ermilov <ru@nginx.com> parents: 102 diff changeset	271 </directive>
05e58829de2e Documented the "error_log" directive. Ruslan Ermilov <ru@nginx.com> parents: 102 diff changeset	272
05e58829de2e Documented the "error_log" directive. Ruslan Ermilov <ru@nginx.com> parents: 102 diff changeset	273
556 345012910707 Documented the "events" and "use" directives. Ruslan Ermilov <ru@nginx.com> parents: 554 diff changeset	274 <directive name="events">
345012910707 Documented the "events" and "use" directives. Ruslan Ermilov <ru@nginx.com> parents: 554 diff changeset	275 <syntax block="yes"/>
345012910707 Documented the "events" and "use" directives. Ruslan Ermilov <ru@nginx.com> parents: 554 diff changeset	276 <default/>
345012910707 Documented the "events" and "use" directives. Ruslan Ermilov <ru@nginx.com> parents: 554 diff changeset	277 <context>main</context>
345012910707 Documented the "events" and "use" directives. Ruslan Ermilov <ru@nginx.com> parents: 554 diff changeset	278
345012910707 Documented the "events" and "use" directives. Ruslan Ermilov <ru@nginx.com> parents: 554 diff changeset	279 <para>
957 6d9d4bb571a9 Text review of the ngx_core_module. Egor Nikitin <yegor.nikitin@gmail.com> parents: 953 diff changeset	280 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	281 affect connection processing are specified.
345012910707 Documented the "events" and "use" directives. Ruslan Ermilov <ru@nginx.com> parents: 554 diff changeset	282 </para>
345012910707 Documented the "events" and "use" directives. Ruslan Ermilov <ru@nginx.com> parents: 554 diff changeset	283
345012910707 Documented the "events" and "use" directives. Ruslan Ermilov <ru@nginx.com> parents: 554 diff changeset	284 </directive>
345012910707 Documented the "events" and "use" directives. Ruslan Ermilov <ru@nginx.com> parents: 554 diff changeset	285
345012910707 Documented the "events" and "use" directives. Ruslan Ermilov <ru@nginx.com> parents: 554 diff changeset	286
63 6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	287 <directive name="include">
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	288 <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	289 <default/>
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	290 <context/>
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 <para>
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	293 Includes another <value>file</value>, or files matching the
4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	294 specified <value>mask</value>, into configuration.
63 6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	295 Included files should consist of
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	296 syntactically correct directives and blocks.
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	297 </para>
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	298
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	299 <para>
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	300 Usage example:
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	301 <example>
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	302 include mime.types;
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	303 include vhosts/*.conf;
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	304 </example>
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	305 </para>
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	306
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	307 </directive>
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	308
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	309
1650 6b4cb951cf83 Documented the load_module directive. Yaroslav Zhuravlev <yar@nginx.com> parents: 1641 diff changeset	310 <directive name="load_module">
6b4cb951cf83 Documented the load_module directive. Yaroslav Zhuravlev <yar@nginx.com> parents: 1641 diff changeset	311 <syntax><value>file</value></syntax>
6b4cb951cf83 Documented the load_module directive. Yaroslav Zhuravlev <yar@nginx.com> parents: 1641 diff changeset	312 <default/>
6b4cb951cf83 Documented the load_module directive. Yaroslav Zhuravlev <yar@nginx.com> parents: 1641 diff changeset	313 <context>main</context>
6b4cb951cf83 Documented the load_module directive. Yaroslav Zhuravlev <yar@nginx.com> parents: 1641 diff changeset	314 <appeared-in>1.9.11</appeared-in>
6b4cb951cf83 Documented the load_module directive. Yaroslav Zhuravlev <yar@nginx.com> parents: 1641 diff changeset	315
6b4cb951cf83 Documented the load_module directive. Yaroslav Zhuravlev <yar@nginx.com> parents: 1641 diff changeset	316 <para>
6b4cb951cf83 Documented the load_module directive. Yaroslav Zhuravlev <yar@nginx.com> parents: 1641 diff changeset	317 Loads a dynamic module.
6b4cb951cf83 Documented the load_module directive. Yaroslav Zhuravlev <yar@nginx.com> parents: 1641 diff changeset	318 </para>
6b4cb951cf83 Documented the load_module directive. Yaroslav Zhuravlev <yar@nginx.com> parents: 1641 diff changeset	319
6b4cb951cf83 Documented the load_module directive. Yaroslav Zhuravlev <yar@nginx.com> parents: 1641 diff changeset	320 <para>
6b4cb951cf83 Documented the load_module directive. Yaroslav Zhuravlev <yar@nginx.com> parents: 1641 diff changeset	321 Example:
6b4cb951cf83 Documented the load_module directive. Yaroslav Zhuravlev <yar@nginx.com> parents: 1641 diff changeset	322 <example>
6b4cb951cf83 Documented the load_module directive. Yaroslav Zhuravlev <yar@nginx.com> parents: 1641 diff changeset	323 load_module modules/ngx_mail_module.so;
6b4cb951cf83 Documented the load_module directive. Yaroslav Zhuravlev <yar@nginx.com> parents: 1641 diff changeset	324 </example>
6b4cb951cf83 Documented the load_module directive. Yaroslav Zhuravlev <yar@nginx.com> parents: 1641 diff changeset	325 </para>
6b4cb951cf83 Documented the load_module directive. Yaroslav Zhuravlev <yar@nginx.com> parents: 1641 diff changeset	326
6b4cb951cf83 Documented the load_module directive. Yaroslav Zhuravlev <yar@nginx.com> parents: 1641 diff changeset	327 </directive>
6b4cb951cf83 Documented the load_module directive. Yaroslav Zhuravlev <yar@nginx.com> parents: 1641 diff changeset	328
6b4cb951cf83 Documented the load_module directive. Yaroslav Zhuravlev <yar@nginx.com> parents: 1641 diff changeset	329
571 71d775bef043 Documented accept_mutex, accept_mutex_delay, multi_accept, and lock_file. Ruslan Ermilov <ru@nginx.com> parents: 556 diff changeset	330 <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	331 <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	332 <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	333 <context>main</context>
71d775bef043 Documented accept_mutex, accept_mutex_delay, multi_accept, and lock_file. Ruslan Ermilov <ru@nginx.com> parents: 556 diff changeset	334
71d775bef043 Documented accept_mutex, accept_mutex_delay, multi_accept, and lock_file. Ruslan Ermilov <ru@nginx.com> parents: 556 diff changeset	335 <para>
71d775bef043 Documented accept_mutex, accept_mutex_delay, multi_accept, and lock_file. Ruslan Ermilov <ru@nginx.com> parents: 556 diff changeset	336 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	337 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	338 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	339 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	340 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	341 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	342 </para>
71d775bef043 Documented accept_mutex, accept_mutex_delay, multi_accept, and lock_file. Ruslan Ermilov <ru@nginx.com> parents: 556 diff changeset	343
71d775bef043 Documented accept_mutex, accept_mutex_delay, multi_accept, and lock_file. Ruslan Ermilov <ru@nginx.com> parents: 556 diff changeset	344 </directive>
71d775bef043 Documented accept_mutex, accept_mutex_delay, multi_accept, and lock_file. Ruslan Ermilov <ru@nginx.com> parents: 556 diff changeset	345
71d775bef043 Documented accept_mutex, accept_mutex_delay, multi_accept, and lock_file. Ruslan Ermilov <ru@nginx.com> parents: 556 diff changeset	346
63 6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	347 <directive name="master_process">
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	348 <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	349 <default>on</default>
63 6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	350 <context>main</context>
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	351
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	352 <para>
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	353 Determines whether worker processes are started.
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	354 This directive is intended for nginx developers.
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	355 </para>
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	356
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	357 </directive>
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	358
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	359
571 71d775bef043 Documented accept_mutex, accept_mutex_delay, multi_accept, and lock_file. Ruslan Ermilov <ru@nginx.com> parents: 556 diff changeset	360 <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	361 <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	362 <default>off</default>
71d775bef043 Documented accept_mutex, accept_mutex_delay, multi_accept, and lock_file. Ruslan Ermilov <ru@nginx.com> parents: 556 diff changeset	363 <context>events</context>
71d775bef043 Documented accept_mutex, accept_mutex_delay, multi_accept, and lock_file. Ruslan Ermilov <ru@nginx.com> parents: 556 diff changeset	364
71d775bef043 Documented accept_mutex, accept_mutex_delay, multi_accept, and lock_file. Ruslan Ermilov <ru@nginx.com> parents: 556 diff changeset	365 <para>
957 6d9d4bb571a9 Text review of the ngx_core_module. Egor Nikitin <yegor.nikitin@gmail.com> parents: 953 diff changeset	366 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	367 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	368 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	369 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	370 <note>
71d775bef043 Documented accept_mutex, accept_mutex_delay, multi_accept, and lock_file. Ruslan Ermilov <ru@nginx.com> parents: 556 diff changeset	371 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	372 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	373 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	374 </note>
71d775bef043 Documented accept_mutex, accept_mutex_delay, multi_accept, and lock_file. Ruslan Ermilov <ru@nginx.com> parents: 556 diff changeset	375 </para>
71d775bef043 Documented accept_mutex, accept_mutex_delay, multi_accept, and lock_file. Ruslan Ermilov <ru@nginx.com> parents: 556 diff changeset	376
71d775bef043 Documented accept_mutex, accept_mutex_delay, multi_accept, and lock_file. Ruslan Ermilov <ru@nginx.com> parents: 556 diff changeset	377 </directive>
71d775bef043 Documented accept_mutex, accept_mutex_delay, multi_accept, and lock_file. Ruslan Ermilov <ru@nginx.com> parents: 556 diff changeset	378
71d775bef043 Documented accept_mutex, accept_mutex_delay, multi_accept, and lock_file. Ruslan Ermilov <ru@nginx.com> parents: 556 diff changeset	379
289 df261b1ce71f Documented the --with-pcre-jit configuration parameter Ruslan Ermilov <ru@nginx.com> parents: 271 diff changeset	380 <directive name="pcre_jit">
df261b1ce71f Documented the --with-pcre-jit configuration parameter Ruslan Ermilov <ru@nginx.com> parents: 271 diff changeset	381 <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	382 <default>off</default>
df261b1ce71f Documented the --with-pcre-jit configuration parameter Ruslan Ermilov <ru@nginx.com> parents: 271 diff changeset	383 <context>main</context>
df261b1ce71f Documented the --with-pcre-jit configuration parameter Ruslan Ermilov <ru@nginx.com> parents: 271 diff changeset	384 <appeared-in>1.1.12</appeared-in>
df261b1ce71f Documented the --with-pcre-jit configuration parameter Ruslan Ermilov <ru@nginx.com> parents: 271 diff changeset	385
df261b1ce71f Documented the --with-pcre-jit configuration parameter Ruslan Ermilov <ru@nginx.com> parents: 271 diff changeset	386 <para>
df261b1ce71f Documented the --with-pcre-jit configuration parameter Ruslan Ermilov <ru@nginx.com> parents: 271 diff changeset	387 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	388 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	389 </para>
df261b1ce71f Documented the --with-pcre-jit configuration parameter Ruslan Ermilov <ru@nginx.com> parents: 271 diff changeset	390
df261b1ce71f Documented the --with-pcre-jit configuration parameter Ruslan Ermilov <ru@nginx.com> parents: 271 diff changeset	391 <para>
df261b1ce71f Documented the --with-pcre-jit configuration parameter Ruslan Ermilov <ru@nginx.com> parents: 271 diff changeset	392 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	393 <note>
df261b1ce71f Documented the --with-pcre-jit configuration parameter Ruslan Ermilov <ru@nginx.com> parents: 271 diff changeset	394 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	395 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	396 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	397 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	398 <literal>--with-pcre-jit</literal> configuration parameter.
df261b1ce71f Documented the --with-pcre-jit configuration parameter Ruslan Ermilov <ru@nginx.com> parents: 271 diff changeset	399 </note>
df261b1ce71f Documented the --with-pcre-jit configuration parameter Ruslan Ermilov <ru@nginx.com> parents: 271 diff changeset	400 </para>
df261b1ce71f Documented the --with-pcre-jit configuration parameter Ruslan Ermilov <ru@nginx.com> parents: 271 diff changeset	401
df261b1ce71f Documented the --with-pcre-jit configuration parameter Ruslan Ermilov <ru@nginx.com> parents: 271 diff changeset	402 </directive>
df261b1ce71f Documented the --with-pcre-jit configuration parameter Ruslan Ermilov <ru@nginx.com> parents: 271 diff changeset	403
df261b1ce71f Documented the --with-pcre-jit configuration parameter Ruslan Ermilov <ru@nginx.com> parents: 271 diff changeset	404
63 6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	405 <directive name="pid">
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	406 <syntax><value>file</value></syntax>
2080 8f885a69374d Fixed the "pid" directive default value. Maxim Dounin <mdounin@mdounin.ru> parents: 1927 diff changeset	407 <default>logs/nginx.pid</default>
63 6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	408 <context>main</context>
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	409
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	410 <para>
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	411 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	412 </para>
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	413
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	414 </directive>
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	415
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	416
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	417 <directive name="ssl_engine">
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	418 <syntax><value>device</value></syntax>
63 6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	419 <default/>
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	420 <context>main</context>
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	421
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	422 <para>
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	423 Defines the name of the hardware SSL accelerator.
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	424 </para>
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	425
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	426 </directive>
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	427
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	428
1436 2333e08e277d Documented thread pools. Ruslan Ermilov <ru@nginx.com> parents: 1285 diff changeset	429 <directive name="thread_pool">
2333e08e277d Documented thread pools. Ruslan Ermilov <ru@nginx.com> parents: 1285 diff changeset	430 <syntax>
2333e08e277d Documented thread pools. Ruslan Ermilov <ru@nginx.com> parents: 1285 diff changeset	431 <value>name</value>
2333e08e277d Documented thread pools. Ruslan Ermilov <ru@nginx.com> parents: 1285 diff changeset	432 <literal>threads</literal>=<value>number</value>
2333e08e277d Documented thread pools. Ruslan Ermilov <ru@nginx.com> parents: 1285 diff changeset	433 [<literal>max_queue</literal>=<value>number</value>]</syntax>
2333e08e277d Documented thread pools. Ruslan Ermilov <ru@nginx.com> parents: 1285 diff changeset	434 <default>default threads=32 max_queue=65536</default>
2333e08e277d Documented thread pools. Ruslan Ermilov <ru@nginx.com> parents: 1285 diff changeset	435 <context>main</context>
2333e08e277d Documented thread pools. Ruslan Ermilov <ru@nginx.com> parents: 1285 diff changeset	436 <appeared-in>1.7.11</appeared-in>
2333e08e277d Documented thread pools. Ruslan Ermilov <ru@nginx.com> parents: 1285 diff changeset	437
2333e08e277d Documented thread pools. Ruslan Ermilov <ru@nginx.com> parents: 1285 diff changeset	438 <para>
2634 0722b485010c Improved wording in the thread_pool directive description. Maxim Dounin <mdounin@mdounin.ru> parents: 2593 diff changeset	439 Defines the <value>name</value> and parameters of a thread pool
1436 2333e08e277d Documented thread pools. Ruslan Ermilov <ru@nginx.com> parents: 1285 diff changeset	440 used for multi-threaded reading and sending of files
2333e08e277d Documented thread pools. Ruslan Ermilov <ru@nginx.com> parents: 1285 diff changeset	441 <link doc="http/ngx_http_core_module.xml" id="aio">without blocking</link>
2333e08e277d Documented thread pools. Ruslan Ermilov <ru@nginx.com> parents: 1285 diff changeset	442 worker processes.
2333e08e277d Documented thread pools. Ruslan Ermilov <ru@nginx.com> parents: 1285 diff changeset	443 </para>
2333e08e277d Documented thread pools. Ruslan Ermilov <ru@nginx.com> parents: 1285 diff changeset	444
2333e08e277d Documented thread pools. Ruslan Ermilov <ru@nginx.com> parents: 1285 diff changeset	445 <para>
2333e08e277d Documented thread pools. Ruslan Ermilov <ru@nginx.com> parents: 1285 diff changeset	446 The <literal>threads</literal> parameter
2333e08e277d Documented thread pools. Ruslan Ermilov <ru@nginx.com> parents: 1285 diff changeset	447 defines the number of threads in the pool.
2333e08e277d Documented thread pools. Ruslan Ermilov <ru@nginx.com> parents: 1285 diff changeset	448 </para>
2333e08e277d Documented thread pools. Ruslan Ermilov <ru@nginx.com> parents: 1285 diff changeset	449
2333e08e277d Documented thread pools. Ruslan Ermilov <ru@nginx.com> parents: 1285 diff changeset	450 <para>
2333e08e277d Documented thread pools. Ruslan Ermilov <ru@nginx.com> parents: 1285 diff changeset	451 In the event that all threads in the pool are busy,
2333e08e277d Documented thread pools. Ruslan Ermilov <ru@nginx.com> parents: 1285 diff changeset	452 a new task will wait in the queue.
2333e08e277d Documented thread pools. Ruslan Ermilov <ru@nginx.com> parents: 1285 diff changeset	453 The <literal>max_queue</literal> parameter limits the number
2333e08e277d Documented thread pools. Ruslan Ermilov <ru@nginx.com> parents: 1285 diff changeset	454 of tasks allowed to be waiting in the queue.
2333e08e277d Documented thread pools. Ruslan Ermilov <ru@nginx.com> parents: 1285 diff changeset	455 By default, up to 65536 tasks can wait in the queue.
2333e08e277d Documented thread pools. Ruslan Ermilov <ru@nginx.com> parents: 1285 diff changeset	456 When the queue overflows, the task is completed with an error.
2333e08e277d Documented thread pools. Ruslan Ermilov <ru@nginx.com> parents: 1285 diff changeset	457 </para>
2333e08e277d Documented thread pools. Ruslan Ermilov <ru@nginx.com> parents: 1285 diff changeset	458
2333e08e277d Documented thread pools. Ruslan Ermilov <ru@nginx.com> parents: 1285 diff changeset	459 </directive>
2333e08e277d Documented thread pools. Ruslan Ermilov <ru@nginx.com> parents: 1285 diff changeset	460
2333e08e277d Documented thread pools. Ruslan Ermilov <ru@nginx.com> parents: 1285 diff changeset	461
63 6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	462 <directive name="timer_resolution">
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	463 <syntax><value>interval</value></syntax>
63 6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	464 <default/>
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	465 <context>main</context>
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	466
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	467 <para>
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	468 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	469 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	470 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	471 a kernel event is received.
63 6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	472 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	473 called once per specified <value>interval</value>.
63 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
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	476 <para>
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	477 Example:
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 timer_resolution 100ms;
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	480 </example>
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	481 </para>
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	482
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	483 <para>
957 6d9d4bb571a9 Text review of the ngx_core_module. Egor Nikitin <yegor.nikitin@gmail.com> parents: 953 diff changeset	484 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	485 <list type="bullet">
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	486
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	487 <listitem>
957 6d9d4bb571a9 Text review of the ngx_core_module. Egor Nikitin <yegor.nikitin@gmail.com> parents: 953 diff changeset	488 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	489 </listitem>
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	490
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	491 <listitem>
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	492 <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	493 </listitem>
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	494
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 <c-func>setitimer</c-func> otherwise.
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	497 </listitem>
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	498
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	499 </list>
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	500 </para>
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 </directive>
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	503
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	504
556 345012910707 Documented the "events" and "use" directives. Ruslan Ermilov <ru@nginx.com> parents: 554 diff changeset	505 <directive name="use">
345012910707 Documented the "events" and "use" directives. Ruslan Ermilov <ru@nginx.com> parents: 554 diff changeset	506 <syntax><value>method</value></syntax>
345012910707 Documented the "events" and "use" directives. Ruslan Ermilov <ru@nginx.com> parents: 554 diff changeset	507 <default/>
345012910707 Documented the "events" and "use" directives. Ruslan Ermilov <ru@nginx.com> parents: 554 diff changeset	508 <context>events</context>
345012910707 Documented the "events" and "use" directives. Ruslan Ermilov <ru@nginx.com> parents: 554 diff changeset	509
345012910707 Documented the "events" and "use" directives. Ruslan Ermilov <ru@nginx.com> parents: 554 diff changeset	510 <para>
345012910707 Documented the "events" and "use" directives. Ruslan Ermilov <ru@nginx.com> parents: 554 diff changeset	511 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	512 <value>method</value> to use.
957 6d9d4bb571a9 Text review of the ngx_core_module. Egor Nikitin <yegor.nikitin@gmail.com> parents: 953 diff changeset	513 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	514 by default use the most efficient method.
345012910707 Documented the "events" and "use" directives. Ruslan Ermilov <ru@nginx.com> parents: 554 diff changeset	515 </para>
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 </directive>
345012910707 Documented the "events" and "use" directives. Ruslan Ermilov <ru@nginx.com> parents: 554 diff changeset	518
345012910707 Documented the "events" and "use" directives. Ruslan Ermilov <ru@nginx.com> parents: 554 diff changeset	519
82 89c31b453d40 Sorted directives alphabetically. Ruslan Ermilov <ru@nginx.com> parents: 63 diff changeset	520 <directive name="user">
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	521 <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	522 <default>nobody nobody</default>
63 6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	523 <context>main</context>
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	524
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	525 <para>
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	526 Defines <value>user</value> and <value>group</value>
82 89c31b453d40 Sorted directives alphabetically. Ruslan Ermilov <ru@nginx.com> parents: 63 diff changeset	527 credentials used by worker processes.
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	528 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	529 that of <value>user</value> is used.
63 6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	530 </para>
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 </directive>
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	533
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	534
749 2abb92a19101 Documented 'worker_aio_requests' directive. Vladimir Homutov <vl@nginx.com> parents: 742 diff changeset	535 <directive name="worker_aio_requests">
2abb92a19101 Documented 'worker_aio_requests' directive. Vladimir Homutov <vl@nginx.com> parents: 742 diff changeset	536 <syntax><value>number</value></syntax>
2abb92a19101 Documented 'worker_aio_requests' directive. Vladimir Homutov <vl@nginx.com> parents: 742 diff changeset	537 <default>32</default>
2abb92a19101 Documented 'worker_aio_requests' directive. Vladimir Homutov <vl@nginx.com> parents: 742 diff changeset	538 <context>events</context>
750 6a1b1ba62cab Documented history of "worker_aio_requests" directive. Vladimir Homutov <vl@nginx.com> parents: 749 diff changeset	539 <appeared-in>1.1.4</appeared-in>
6a1b1ba62cab Documented history of "worker_aio_requests" directive. Vladimir Homutov <vl@nginx.com> parents: 749 diff changeset	540 <appeared-in>1.0.7</appeared-in>
749 2abb92a19101 Documented 'worker_aio_requests' directive. Vladimir Homutov <vl@nginx.com> parents: 742 diff changeset	541
2abb92a19101 Documented 'worker_aio_requests' directive. Vladimir Homutov <vl@nginx.com> parents: 742 diff changeset	542 <para>
2abb92a19101 Documented 'worker_aio_requests' directive. Vladimir Homutov <vl@nginx.com> parents: 742 diff changeset	543 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	544 with the <link doc="../docs/events.xml" id="epoll"/>
2abb92a19101 Documented 'worker_aio_requests' directive. Vladimir Homutov <vl@nginx.com> parents: 742 diff changeset	545 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	546 outstanding asynchronous I/O operations
2abb92a19101 Documented 'worker_aio_requests' directive. Vladimir Homutov <vl@nginx.com> parents: 742 diff changeset	547 for a single worker process.
2abb92a19101 Documented 'worker_aio_requests' directive. Vladimir Homutov <vl@nginx.com> parents: 742 diff changeset	548 </para>
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 </directive>
2abb92a19101 Documented 'worker_aio_requests' directive. Vladimir Homutov <vl@nginx.com> parents: 742 diff changeset	551
2abb92a19101 Documented 'worker_aio_requests' directive. Vladimir Homutov <vl@nginx.com> parents: 742 diff changeset	552
545 e97b46d1842d Documented the "worker_connections" directive. Ruslan Ermilov <ru@nginx.com> parents: 523 diff changeset	553 <directive name="worker_connections">
e97b46d1842d Documented the "worker_connections" directive. Ruslan Ermilov <ru@nginx.com> parents: 523 diff changeset	554 <syntax><value>number</value></syntax>
e97b46d1842d Documented the "worker_connections" directive. Ruslan Ermilov <ru@nginx.com> parents: 523 diff changeset	555 <default>512</default>
e97b46d1842d Documented the "worker_connections" directive. Ruslan Ermilov <ru@nginx.com> parents: 523 diff changeset	556 <context>events</context>
e97b46d1842d Documented the "worker_connections" directive. Ruslan Ermilov <ru@nginx.com> parents: 523 diff changeset	557
e97b46d1842d Documented the "worker_connections" directive. Ruslan Ermilov <ru@nginx.com> parents: 523 diff changeset	558 <para>
e97b46d1842d Documented the "worker_connections" directive. Ruslan Ermilov <ru@nginx.com> parents: 523 diff changeset	559 Sets the maximum number of simultaneous connections that
e97b46d1842d Documented the "worker_connections" directive. Ruslan Ermilov <ru@nginx.com> parents: 523 diff changeset	560 can be opened by a worker process.
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
e97b46d1842d Documented the "worker_connections" directive. Ruslan Ermilov <ru@nginx.com> parents: 523 diff changeset	563 <para>
e97b46d1842d Documented the "worker_connections" directive. Ruslan Ermilov <ru@nginx.com> parents: 523 diff changeset	564 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	565 (e.g. connections with proxied servers, among others),
545 e97b46d1842d Documented the "worker_connections" directive. Ruslan Ermilov <ru@nginx.com> parents: 523 diff changeset	566 not only connections with clients.
e97b46d1842d Documented the "worker_connections" directive. Ruslan Ermilov <ru@nginx.com> parents: 523 diff changeset	567 Another consideration is that the actual number of simultaneous
966 95c3c3bbf1ce Text review. Egor Nikitin <yegor.nikitin@gmail.com> parents: 957 diff changeset	568 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	569 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	570 <link id="worker_rlimit_nofile"/>.
e97b46d1842d Documented the "worker_connections" directive. Ruslan Ermilov <ru@nginx.com> parents: 523 diff changeset	571 </para>
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 </directive>
e97b46d1842d Documented the "worker_connections" directive. Ruslan Ermilov <ru@nginx.com> parents: 523 diff changeset	574
e97b46d1842d Documented the "worker_connections" directive. Ruslan Ermilov <ru@nginx.com> parents: 523 diff changeset	575
469 8275e169f77b Documented the "worker_cpu_affinity" directive. Ruslan Ermilov <ru@nginx.com> parents: 455 diff changeset	576 <directive name="worker_cpu_affinity">
8275e169f77b Documented the "worker_cpu_affinity" directive. Ruslan Ermilov <ru@nginx.com> parents: 455 diff changeset	577 <syntax><value>cpumask</value> ...</syntax>
1641 c0d1026e7e7b Documented the "auto" parameter in worker_cpu_affinity. Yaroslav Zhuravlev <yar@nginx.com> parents: 1480 diff changeset	578 <syntax><literal>auto</literal> [<value>cpumask</value>]</syntax>
469 8275e169f77b Documented the "worker_cpu_affinity" directive. Ruslan Ermilov <ru@nginx.com> parents: 455 diff changeset	579 <default/>
8275e169f77b Documented the "worker_cpu_affinity" directive. Ruslan Ermilov <ru@nginx.com> parents: 455 diff changeset	580 <context>main</context>
8275e169f77b Documented the "worker_cpu_affinity" directive. Ruslan Ermilov <ru@nginx.com> parents: 455 diff changeset	581
8275e169f77b Documented the "worker_cpu_affinity" directive. Ruslan Ermilov <ru@nginx.com> parents: 455 diff changeset	582 <para>
8275e169f77b Documented the "worker_cpu_affinity" directive. Ruslan Ermilov <ru@nginx.com> parents: 455 diff changeset	583 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	584 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	585 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	586 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	587 </para>
8275e169f77b Documented the "worker_cpu_affinity" directive. Ruslan Ermilov <ru@nginx.com> parents: 455 diff changeset	588
8275e169f77b Documented the "worker_cpu_affinity" directive. Ruslan Ermilov <ru@nginx.com> parents: 455 diff changeset	589 <para>
8275e169f77b Documented the "worker_cpu_affinity" directive. Ruslan Ermilov <ru@nginx.com> parents: 455 diff changeset	590 For example,
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 worker_processes 4;
8275e169f77b Documented the "worker_cpu_affinity" directive. Ruslan Ermilov <ru@nginx.com> parents: 455 diff changeset	593 worker_cpu_affinity 0001 0010 0100 1000;
8275e169f77b Documented the "worker_cpu_affinity" directive. Ruslan Ermilov <ru@nginx.com> parents: 455 diff changeset	594 </example>
8275e169f77b Documented the "worker_cpu_affinity" directive. Ruslan Ermilov <ru@nginx.com> parents: 455 diff changeset	595 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	596 <example>
8275e169f77b Documented the "worker_cpu_affinity" directive. Ruslan Ermilov <ru@nginx.com> parents: 455 diff changeset	597 worker_processes 2;
8275e169f77b Documented the "worker_cpu_affinity" directive. Ruslan Ermilov <ru@nginx.com> parents: 455 diff changeset	598 worker_cpu_affinity 0101 1010;
8275e169f77b Documented the "worker_cpu_affinity" directive. Ruslan Ermilov <ru@nginx.com> parents: 455 diff changeset	599 </example>
8275e169f77b Documented the "worker_cpu_affinity" directive. Ruslan Ermilov <ru@nginx.com> parents: 455 diff changeset	600 binds the first worker process to CPU0/CPU2,
8275e169f77b Documented the "worker_cpu_affinity" directive. Ruslan Ermilov <ru@nginx.com> parents: 455 diff changeset	601 and the second worker process to CPU1/CPU3.
8275e169f77b Documented the "worker_cpu_affinity" directive. Ruslan Ermilov <ru@nginx.com> parents: 455 diff changeset	602 The second example is suitable for hyper-threading.
8275e169f77b Documented the "worker_cpu_affinity" directive. Ruslan Ermilov <ru@nginx.com> parents: 455 diff changeset	603 </para>
8275e169f77b Documented the "worker_cpu_affinity" directive. Ruslan Ermilov <ru@nginx.com> parents: 455 diff changeset	604
8275e169f77b Documented the "worker_cpu_affinity" directive. Ruslan Ermilov <ru@nginx.com> parents: 455 diff changeset	605 <para>
1641 c0d1026e7e7b Documented the "auto" parameter in worker_cpu_affinity. Yaroslav Zhuravlev <yar@nginx.com> parents: 1480 diff changeset	606 The special value <literal>auto</literal> (1.9.10) allows
c0d1026e7e7b Documented the "auto" parameter in worker_cpu_affinity. Yaroslav Zhuravlev <yar@nginx.com> parents: 1480 diff changeset	607 binding worker processes automatically to available CPUs:
c0d1026e7e7b Documented the "auto" parameter in worker_cpu_affinity. Yaroslav Zhuravlev <yar@nginx.com> parents: 1480 diff changeset	608 <example>
c0d1026e7e7b Documented the "auto" parameter in worker_cpu_affinity. Yaroslav Zhuravlev <yar@nginx.com> parents: 1480 diff changeset	609 worker_processes auto;
c0d1026e7e7b Documented the "auto" parameter in worker_cpu_affinity. Yaroslav Zhuravlev <yar@nginx.com> parents: 1480 diff changeset	610 worker_cpu_affinity auto;
c0d1026e7e7b Documented the "auto" parameter in worker_cpu_affinity. Yaroslav Zhuravlev <yar@nginx.com> parents: 1480 diff changeset	611 </example>
c0d1026e7e7b Documented the "auto" parameter in worker_cpu_affinity. Yaroslav Zhuravlev <yar@nginx.com> parents: 1480 diff changeset	612 The optional mask parameter can be used to limit the CPUs
c0d1026e7e7b Documented the "auto" parameter in worker_cpu_affinity. Yaroslav Zhuravlev <yar@nginx.com> parents: 1480 diff changeset	613 available for automatic binding:
c0d1026e7e7b Documented the "auto" parameter in worker_cpu_affinity. Yaroslav Zhuravlev <yar@nginx.com> parents: 1480 diff changeset	614 <example>
c0d1026e7e7b Documented the "auto" parameter in worker_cpu_affinity. Yaroslav Zhuravlev <yar@nginx.com> parents: 1480 diff changeset	615 worker_cpu_affinity auto 01010101;
c0d1026e7e7b Documented the "auto" parameter in worker_cpu_affinity. Yaroslav Zhuravlev <yar@nginx.com> parents: 1480 diff changeset	616 </example>
c0d1026e7e7b Documented the "auto" parameter in worker_cpu_affinity. Yaroslav Zhuravlev <yar@nginx.com> parents: 1480 diff changeset	617 </para>
c0d1026e7e7b Documented the "auto" parameter in worker_cpu_affinity. Yaroslav Zhuravlev <yar@nginx.com> parents: 1480 diff changeset	618
c0d1026e7e7b Documented the "auto" parameter in worker_cpu_affinity. Yaroslav Zhuravlev <yar@nginx.com> parents: 1480 diff changeset	619 <para>
469 8275e169f77b Documented the "worker_cpu_affinity" directive. Ruslan Ermilov <ru@nginx.com> parents: 455 diff changeset	620 <note>
8275e169f77b Documented the "worker_cpu_affinity" directive. Ruslan Ermilov <ru@nginx.com> parents: 455 diff changeset	621 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	622 </note>
8275e169f77b Documented the "worker_cpu_affinity" directive. Ruslan Ermilov <ru@nginx.com> parents: 455 diff changeset	623 </para>
8275e169f77b Documented the "worker_cpu_affinity" directive. Ruslan Ermilov <ru@nginx.com> parents: 455 diff changeset	624
8275e169f77b Documented the "worker_cpu_affinity" directive. Ruslan Ermilov <ru@nginx.com> parents: 455 diff changeset	625 </directive>
8275e169f77b Documented the "worker_cpu_affinity" directive. Ruslan Ermilov <ru@nginx.com> parents: 455 diff changeset	626
8275e169f77b Documented the "worker_cpu_affinity" directive. Ruslan Ermilov <ru@nginx.com> parents: 455 diff changeset	627
63 6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	628 <directive name="worker_priority">
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	629 <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	630 <default>0</default>
63 6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	631 <context>main</context>
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 <para>
957 6d9d4bb571a9 Text review of the ngx_core_module. Egor Nikitin <yegor.nikitin@gmail.com> parents: 953 diff changeset	634 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	635 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	636 <value>number</value>
63 6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	637 means higher priority.
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	638 Allowed range normally varies from -20 to 20.
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
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 Example:
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	643 <example>
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	644 worker_priority -10;
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	645 </example>
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	646 </para>
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	647
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	648 </directive>
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	649
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	650
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	651 <directive name="worker_processes">
740 46d70031bea9 Documented the recently added "auto" parameter of the Andrey Belov <defan@nginx.com> parents: 659 diff changeset	652 <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	653 <default>1</default>
63 6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	654 <context>main</context>
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	655
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	656 <para>
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	657 Defines the number of worker processes.
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	658 </para>
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	659
226 c4b33b07dcfe Added some basic hints on how to tune "worker_processes". Ruslan Ermilov <ru@nginx.com> parents: 158 diff changeset	660 <para>
c4b33b07dcfe Added some basic hints on how to tune "worker_processes". Ruslan Ermilov <ru@nginx.com> parents: 158 diff changeset	661 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	662 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	663 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	664 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	665 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	666 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	667 <note>
3a2e35f4c279 Documented that "worker_processes auto" appeared in version 1.3.8. Ruslan Ermilov <ru@nginx.com> parents: 740 diff changeset	668 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	669 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	670 </note>
226 c4b33b07dcfe Added some basic hints on how to tune "worker_processes". Ruslan Ermilov <ru@nginx.com> parents: 158 diff changeset	671 </para>
c4b33b07dcfe Added some basic hints on how to tune "worker_processes". Ruslan Ermilov <ru@nginx.com> parents: 158 diff changeset	672
63 6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	673 </directive>
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	674
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	675
82 89c31b453d40 Sorted directives alphabetically. Ruslan Ermilov <ru@nginx.com> parents: 63 diff changeset	676 <directive name="worker_rlimit_core">
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	677 <syntax><value>size</value></syntax>
82 89c31b453d40 Sorted directives alphabetically. Ruslan Ermilov <ru@nginx.com> parents: 63 diff changeset	678 <default/>
89c31b453d40 Sorted directives alphabetically. Ruslan Ermilov <ru@nginx.com> parents: 63 diff changeset	679 <context>main</context>
89c31b453d40 Sorted directives alphabetically. Ruslan Ermilov <ru@nginx.com> parents: 63 diff changeset	680
89c31b453d40 Sorted directives alphabetically. Ruslan Ermilov <ru@nginx.com> parents: 63 diff changeset	681 <para>
89c31b453d40 Sorted directives alphabetically. Ruslan Ermilov <ru@nginx.com> parents: 63 diff changeset	682 Changes the limit on the largest size of a core file
89c31b453d40 Sorted directives alphabetically. Ruslan Ermilov <ru@nginx.com> parents: 63 diff changeset	683 (<c-def>RLIMIT_CORE</c-def>) for worker processes.
89c31b453d40 Sorted directives alphabetically. Ruslan Ermilov <ru@nginx.com> parents: 63 diff changeset	684 Used to increase the limit without restarting the main process.
89c31b453d40 Sorted directives alphabetically. Ruslan Ermilov <ru@nginx.com> parents: 63 diff changeset	685 </para>
89c31b453d40 Sorted directives alphabetically. Ruslan Ermilov <ru@nginx.com> parents: 63 diff changeset	686
89c31b453d40 Sorted directives alphabetically. Ruslan Ermilov <ru@nginx.com> parents: 63 diff changeset	687 </directive>
89c31b453d40 Sorted directives alphabetically. Ruslan Ermilov <ru@nginx.com> parents: 63 diff changeset	688
89c31b453d40 Sorted directives alphabetically. Ruslan Ermilov <ru@nginx.com> parents: 63 diff changeset	689
89c31b453d40 Sorted directives alphabetically. Ruslan Ermilov <ru@nginx.com> parents: 63 diff changeset	690 <directive name="worker_rlimit_nofile">
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	691 <syntax><value>number</value></syntax>
82 89c31b453d40 Sorted directives alphabetically. Ruslan Ermilov <ru@nginx.com> parents: 63 diff changeset	692 <default/>
89c31b453d40 Sorted directives alphabetically. Ruslan Ermilov <ru@nginx.com> parents: 63 diff changeset	693 <context>main</context>
89c31b453d40 Sorted directives alphabetically. Ruslan Ermilov <ru@nginx.com> parents: 63 diff changeset	694
89c31b453d40 Sorted directives alphabetically. Ruslan Ermilov <ru@nginx.com> parents: 63 diff changeset	695 <para>
89c31b453d40 Sorted directives alphabetically. Ruslan Ermilov <ru@nginx.com> parents: 63 diff changeset	696 Changes the limit on the maximum number of open files
89c31b453d40 Sorted directives alphabetically. Ruslan Ermilov <ru@nginx.com> parents: 63 diff changeset	697 (<c-def>RLIMIT_NOFILE</c-def>) for worker processes.
89c31b453d40 Sorted directives alphabetically. Ruslan Ermilov <ru@nginx.com> parents: 63 diff changeset	698 Used to increase the limit without restarting the main process.
89c31b453d40 Sorted directives alphabetically. Ruslan Ermilov <ru@nginx.com> parents: 63 diff changeset	699 </para>
89c31b453d40 Sorted directives alphabetically. Ruslan Ermilov <ru@nginx.com> parents: 63 diff changeset	700
89c31b453d40 Sorted directives alphabetically. Ruslan Ermilov <ru@nginx.com> parents: 63 diff changeset	701 </directive>
89c31b453d40 Sorted directives alphabetically. Ruslan Ermilov <ru@nginx.com> parents: 63 diff changeset	702
89c31b453d40 Sorted directives alphabetically. Ruslan Ermilov <ru@nginx.com> parents: 63 diff changeset	703
1927 75d2478260f4 Documented the "worker_shutdown_timeout" directive. Yaroslav Zhuravlev <yar@nginx.com> parents: 1893 diff changeset	704 <directive name="worker_shutdown_timeout">
75d2478260f4 Documented the "worker_shutdown_timeout" directive. Yaroslav Zhuravlev <yar@nginx.com> parents: 1893 diff changeset	705 <syntax><value>time</value></syntax>
75d2478260f4 Documented the "worker_shutdown_timeout" directive. Yaroslav Zhuravlev <yar@nginx.com> parents: 1893 diff changeset	706 <default/>
75d2478260f4 Documented the "worker_shutdown_timeout" directive. Yaroslav Zhuravlev <yar@nginx.com> parents: 1893 diff changeset	707 <context>main</context>
75d2478260f4 Documented the "worker_shutdown_timeout" directive. Yaroslav Zhuravlev <yar@nginx.com> parents: 1893 diff changeset	708 <appeared-in>1.11.11</appeared-in>
75d2478260f4 Documented the "worker_shutdown_timeout" directive. Yaroslav Zhuravlev <yar@nginx.com> parents: 1893 diff changeset	709
75d2478260f4 Documented the "worker_shutdown_timeout" directive. Yaroslav Zhuravlev <yar@nginx.com> parents: 1893 diff changeset	710 <para>
75d2478260f4 Documented the "worker_shutdown_timeout" directive. Yaroslav Zhuravlev <yar@nginx.com> parents: 1893 diff changeset	711 Configures a timeout for a graceful shutdown of worker processes.
75d2478260f4 Documented the "worker_shutdown_timeout" directive. Yaroslav Zhuravlev <yar@nginx.com> parents: 1893 diff changeset	712 When the <value>time</value> expires,
75d2478260f4 Documented the "worker_shutdown_timeout" directive. Yaroslav Zhuravlev <yar@nginx.com> parents: 1893 diff changeset	713 nginx will try to close all the connections currently open
75d2478260f4 Documented the "worker_shutdown_timeout" directive. Yaroslav Zhuravlev <yar@nginx.com> parents: 1893 diff changeset	714 to facilitate shutdown.
75d2478260f4 Documented the "worker_shutdown_timeout" directive. Yaroslav Zhuravlev <yar@nginx.com> parents: 1893 diff changeset	715 </para>
75d2478260f4 Documented the "worker_shutdown_timeout" directive. Yaroslav Zhuravlev <yar@nginx.com> parents: 1893 diff changeset	716
75d2478260f4 Documented the "worker_shutdown_timeout" directive. Yaroslav Zhuravlev <yar@nginx.com> parents: 1893 diff changeset	717 </directive>
75d2478260f4 Documented the "worker_shutdown_timeout" directive. Yaroslav Zhuravlev <yar@nginx.com> parents: 1893 diff changeset	718
75d2478260f4 Documented the "worker_shutdown_timeout" directive. Yaroslav Zhuravlev <yar@nginx.com> parents: 1893 diff changeset	719
63 6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	720 <directive name="working_directory">
271 4c6d2c614d2c Cleaned up XML tag mess: Ruslan Ermilov <ru@nginx.com> parents: 270 diff changeset	721 <syntax><value>directory</value></syntax>
63 6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	722 <default/>
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	723 <context>main</context>
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	724
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	725 <para>
957 6d9d4bb571a9 Text review of the ngx_core_module. Egor Nikitin <yegor.nikitin@gmail.com> parents: 953 diff changeset	726 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	727 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	728 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	729 specified directory.
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	730 </para>
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	731
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	732 </directive>
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	733
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	734 </section>
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	735
6108fd3217e7 Initial English translation of ngx_core_module. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	736 </module>

Mercurial > hg > nginx-site

annotate xml/en/docs/ngx_core_module.xml @ 2634:0722b485010c