nginx: docs/xml/ngx_core_module.xml annotate

annotate docs/xml/ngx_core_module.xml @ 4108:5e2103cffd80

- The module name is now also output as an HTML header. - Agreed that examples can only contain literal text. - Agreed to call modules "ngx_*_module". - Renamed XML element "http-error" to a more general "http-status". - Fixed text of error codes to match the actual code.

author	Ruslan Ermilov <ru@nginx.com>
date	Thu, 15 Sep 2011 08:24:33 +0000
parents	9755cb2a39b2
children	a18b10aea510

rev	line source
4068 22364b1f61c9 Initial English translation of Core and HTTP Core modules. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	1 <?xml version="1.0"?>
22364b1f61c9 Initial English translation of Core and HTTP Core modules. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	2
22364b1f61c9 Initial English translation of Core and HTTP Core modules. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	3 <!DOCTYPE module SYSTEM "../dtd/module.dtd">
22364b1f61c9 Initial English translation of Core and HTTP Core modules. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	4
22364b1f61c9 Initial English translation of Core and HTTP Core modules. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	5 <module name="Core Module" id="core_module">
22364b1f61c9 Initial English translation of Core and HTTP Core modules. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	6
4108 5e2103cffd80 - The module name is now also output as an HTML header. Ruslan Ermilov <ru@nginx.com> parents: 4079 diff changeset	7 <section id="example" name="Example Configuration">
4068 22364b1f61c9 Initial English translation of Core and HTTP Core modules. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	8
22364b1f61c9 Initial English translation of Core and HTTP Core modules. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	9 <para>
22364b1f61c9 Initial English translation of Core and HTTP Core modules. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	10 <example>
4079 9755cb2a39b2 Finished initial translation of the Core and HTTP Core modules. Ruslan Ermilov <ru@nginx.com> parents: 4068 diff changeset	11 user www www;
9755cb2a39b2 Finished initial translation of the Core and HTTP Core modules. Ruslan Ermilov <ru@nginx.com> parents: 4068 diff changeset	12 worker_processes 2;
4068 22364b1f61c9 Initial English translation of Core and HTTP Core modules. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	13
4079 9755cb2a39b2 Finished initial translation of the Core and HTTP Core modules. Ruslan Ermilov <ru@nginx.com> parents: 4068 diff changeset	14 error_log /var/log/nginx-error.log info;
4068 22364b1f61c9 Initial English translation of Core and HTTP Core modules. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	15
22364b1f61c9 Initial English translation of Core and HTTP Core modules. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	16 events {
4079 9755cb2a39b2 Finished initial translation of the Core and HTTP Core modules. Ruslan Ermilov <ru@nginx.com> parents: 4068 diff changeset	17 use kqueue;
9755cb2a39b2 Finished initial translation of the Core and HTTP Core modules. Ruslan Ermilov <ru@nginx.com> parents: 4068 diff changeset	18 worker_connections 2048;
4068 22364b1f61c9 Initial English translation of Core and HTTP Core modules. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	19 }
22364b1f61c9 Initial English translation of Core and HTTP Core modules. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	20
22364b1f61c9 Initial English translation of Core and HTTP Core modules. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	21 ...
22364b1f61c9 Initial English translation of Core and HTTP Core modules. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	22 </example>
22364b1f61c9 Initial English translation of Core and HTTP Core modules. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	23 </para>
22364b1f61c9 Initial English translation of Core and HTTP Core modules. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	24
22364b1f61c9 Initial English translation of Core and HTTP Core modules. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	25 </section>
22364b1f61c9 Initial English translation of Core and HTTP Core modules. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	26
22364b1f61c9 Initial English translation of Core and HTTP Core modules. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	27
4108 5e2103cffd80 - The module name is now also output as an HTML header. Ruslan Ermilov <ru@nginx.com> parents: 4079 diff changeset	28 <section id="directives" name="Directives">
4068 22364b1f61c9 Initial English translation of Core and HTTP Core modules. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	29
22364b1f61c9 Initial English translation of Core and HTTP Core modules. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	30 <directive name="daemon">
22364b1f61c9 Initial English translation of Core and HTTP Core modules. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	31 <syntax>daemon <value>on</value> \| <value>off</value></syntax>
22364b1f61c9 Initial English translation of Core and HTTP Core modules. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	32 <default>daemon on</default>
22364b1f61c9 Initial English translation of Core and HTTP Core modules. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	33 <context>main</context>
22364b1f61c9 Initial English translation of Core and HTTP Core modules. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	34
22364b1f61c9 Initial English translation of Core and HTTP Core modules. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	35 <para>
22364b1f61c9 Initial English translation of Core and HTTP Core modules. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	36 Determines whether nginx should become a daemon.
22364b1f61c9 Initial English translation of Core and HTTP Core modules. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	37 Mainly used during development.
22364b1f61c9 Initial English translation of Core and HTTP Core modules. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	38 </para>
22364b1f61c9 Initial English translation of Core and HTTP Core modules. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	39
22364b1f61c9 Initial English translation of Core and HTTP Core modules. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	40 </directive>
22364b1f61c9 Initial English translation of Core and HTTP Core modules. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	41
22364b1f61c9 Initial English translation of Core and HTTP Core modules. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	42
22364b1f61c9 Initial English translation of Core and HTTP Core modules. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	43 <directive name="env">
22364b1f61c9 Initial English translation of Core and HTTP Core modules. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	44 <syntax>env <argument>VAR</argument>[=<argument>VALUE</argument>]</syntax>
22364b1f61c9 Initial English translation of Core and HTTP Core modules. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	45 <default>env TZ</default>
22364b1f61c9 Initial English translation of Core and HTTP Core modules. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	46 <context>main</context>
22364b1f61c9 Initial English translation of Core and HTTP Core modules. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	47
22364b1f61c9 Initial English translation of Core and HTTP Core modules. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	48 <para>
22364b1f61c9 Initial English translation of Core and HTTP Core modules. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	49 Allows to limit a set of environment variables, change their values,
22364b1f61c9 Initial English translation of Core and HTTP Core modules. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	50 or create new environment variables, for the following cases:
22364b1f61c9 Initial English translation of Core and HTTP Core modules. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	51 <list type="bullet">
22364b1f61c9 Initial English translation of Core and HTTP Core modules. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	52
22364b1f61c9 Initial English translation of Core and HTTP Core modules. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	53 <listitem>
22364b1f61c9 Initial English translation of Core and HTTP Core modules. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	54 variable inheritance during a
22364b1f61c9 Initial English translation of Core and HTTP Core modules. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	55 <link doc="control.xml" id="upgrade">live upgrade</link>
22364b1f61c9 Initial English translation of Core and HTTP Core modules. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	56 of an executable file;
22364b1f61c9 Initial English translation of Core and HTTP Core modules. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	57 </listitem>
22364b1f61c9 Initial English translation of Core and HTTP Core modules. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	58
22364b1f61c9 Initial English translation of Core and HTTP Core modules. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	59 <listitem>
4108 5e2103cffd80 - The module name is now also output as an HTML header. Ruslan Ermilov <ru@nginx.com> parents: 4079 diff changeset	60 use of variables by the module
5e2103cffd80 - The module name is now also output as an HTML header. Ruslan Ermilov <ru@nginx.com> parents: 4079 diff changeset	61 <link doc="http/ngx_http_perl_module.xml">ngx_http_perl_module</link>;
4068 22364b1f61c9 Initial English translation of Core and HTTP Core modules. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	62 </listitem>
22364b1f61c9 Initial English translation of Core and HTTP Core modules. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	63
22364b1f61c9 Initial English translation of Core and HTTP Core modules. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	64 <listitem>
22364b1f61c9 Initial English translation of Core and HTTP Core modules. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	65 use of variables by worker processes.
22364b1f61c9 Initial English translation of Core and HTTP Core modules. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	66 Please bear in mind that controlling system libraries in this way
4079 9755cb2a39b2 Finished initial translation of the Core and HTTP Core modules. Ruslan Ermilov <ru@nginx.com> parents: 4068 diff changeset	67 is not always possible as it is not uncommon for libraries to check
4068 22364b1f61c9 Initial English translation of Core and HTTP Core modules. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	68 variables only during initialization, well before they can be set
22364b1f61c9 Initial English translation of Core and HTTP Core modules. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	69 using this directive.
22364b1f61c9 Initial English translation of Core and HTTP Core modules. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	70 An exception from this is an above mentioned
22364b1f61c9 Initial English translation of Core and HTTP Core modules. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	71 <link doc="control.xml" id="upgrade">live upgrade</link>
22364b1f61c9 Initial English translation of Core and HTTP Core modules. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	72 of an executable file.
22364b1f61c9 Initial English translation of Core and HTTP Core modules. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	73 </listitem>
22364b1f61c9 Initial English translation of Core and HTTP Core modules. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	74
22364b1f61c9 Initial English translation of Core and HTTP Core modules. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	75 </list>
22364b1f61c9 Initial English translation of Core and HTTP Core modules. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	76 </para>
22364b1f61c9 Initial English translation of Core and HTTP Core modules. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	77
22364b1f61c9 Initial English translation of Core and HTTP Core modules. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	78 <para>
4108 5e2103cffd80 - The module name is now also output as an HTML header. Ruslan Ermilov <ru@nginx.com> parents: 4079 diff changeset	79 The TZ variable is always inherited and made available to the module
5e2103cffd80 - The module name is now also output as an HTML header. Ruslan Ermilov <ru@nginx.com> parents: 4079 diff changeset	80 <link doc="http/ngx_http_perl_module.xml">ngx_http_perl_module</link>,
5e2103cffd80 - The module name is now also output as an HTML header. Ruslan Ermilov <ru@nginx.com> parents: 4079 diff changeset	81 unless configured explicitly.
4068 22364b1f61c9 Initial English translation of Core and HTTP Core modules. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	82 </para>
22364b1f61c9 Initial English translation of Core and HTTP Core modules. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	83
22364b1f61c9 Initial English translation of Core and HTTP Core modules. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	84 <para>
22364b1f61c9 Initial English translation of Core and HTTP Core modules. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	85 Usage example:
22364b1f61c9 Initial English translation of Core and HTTP Core modules. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	86 <example>
4079 9755cb2a39b2 Finished initial translation of the Core and HTTP Core modules. Ruslan Ermilov <ru@nginx.com> parents: 4068 diff changeset	87 env MALLOC_OPTIONS;
9755cb2a39b2 Finished initial translation of the Core and HTTP Core modules. Ruslan Ermilov <ru@nginx.com> parents: 4068 diff changeset	88 env PERL5LIB=/data/site/modules;
9755cb2a39b2 Finished initial translation of the Core and HTTP Core modules. Ruslan Ermilov <ru@nginx.com> parents: 4068 diff changeset	89 env OPENSSL_ALLOW_PROXY_CERTS=1;
4068 22364b1f61c9 Initial English translation of Core and HTTP Core modules. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	90 </example>
22364b1f61c9 Initial English translation of Core and HTTP Core modules. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	91 </para>
22364b1f61c9 Initial English translation of Core and HTTP Core modules. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	92
22364b1f61c9 Initial English translation of Core and HTTP Core modules. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	93 </directive>
22364b1f61c9 Initial English translation of Core and HTTP Core modules. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	94
22364b1f61c9 Initial English translation of Core and HTTP Core modules. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	95 <directive name="include">
22364b1f61c9 Initial English translation of Core and HTTP Core modules. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	96 <syntax>include <argument>file</argument> \| <argument>mask</argument></syntax>
22364b1f61c9 Initial English translation of Core and HTTP Core modules. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	97 <default/>
22364b1f61c9 Initial English translation of Core and HTTP Core modules. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	98 <context/>
22364b1f61c9 Initial English translation of Core and HTTP Core modules. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	99
22364b1f61c9 Initial English translation of Core and HTTP Core modules. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	100 <para>
22364b1f61c9 Initial English translation of Core and HTTP Core modules. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	101 Includes another <argument>file</argument>, or files matching the
22364b1f61c9 Initial English translation of Core and HTTP Core modules. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	102 specified <argument>mask</argument>, into configuration.
22364b1f61c9 Initial English translation of Core and HTTP Core modules. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	103 Included files should consist of
22364b1f61c9 Initial English translation of Core and HTTP Core modules. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	104 syntactically correct directives and blocks.
22364b1f61c9 Initial English translation of Core and HTTP Core modules. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	105 </para>
22364b1f61c9 Initial English translation of Core and HTTP Core modules. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	106
22364b1f61c9 Initial English translation of Core and HTTP Core modules. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	107 <para>
22364b1f61c9 Initial English translation of Core and HTTP Core modules. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	108 Usage example:
22364b1f61c9 Initial English translation of Core and HTTP Core modules. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	109 <example>
4079 9755cb2a39b2 Finished initial translation of the Core and HTTP Core modules. Ruslan Ermilov <ru@nginx.com> parents: 4068 diff changeset	110 include mime.types;
9755cb2a39b2 Finished initial translation of the Core and HTTP Core modules. Ruslan Ermilov <ru@nginx.com> parents: 4068 diff changeset	111 include vhosts/*.conf;
4068 22364b1f61c9 Initial English translation of Core and HTTP Core modules. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	112 </example>
22364b1f61c9 Initial English translation of Core and HTTP Core modules. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	113 </para>
22364b1f61c9 Initial English translation of Core and HTTP Core modules. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	114
22364b1f61c9 Initial English translation of Core and HTTP Core modules. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	115 </directive>
22364b1f61c9 Initial English translation of Core and HTTP Core modules. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	116
22364b1f61c9 Initial English translation of Core and HTTP Core modules. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	117
22364b1f61c9 Initial English translation of Core and HTTP Core modules. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	118 <directive name="master_process">
22364b1f61c9 Initial English translation of Core and HTTP Core modules. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	119 <syntax>master_process <value>on</value> \| <value>off</value></syntax>
22364b1f61c9 Initial English translation of Core and HTTP Core modules. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	120 <default>master_process on</default>
22364b1f61c9 Initial English translation of Core and HTTP Core modules. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	121 <context>main</context>
22364b1f61c9 Initial English translation of Core and HTTP Core modules. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	122
22364b1f61c9 Initial English translation of Core and HTTP Core modules. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	123 <para>
22364b1f61c9 Initial English translation of Core and HTTP Core modules. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	124 Determines whether worker processes are started.
22364b1f61c9 Initial English translation of Core and HTTP Core modules. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	125 This directive is intended for nginx developers.
22364b1f61c9 Initial English translation of Core and HTTP Core modules. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	126 </para>
22364b1f61c9 Initial English translation of Core and HTTP Core modules. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	127
22364b1f61c9 Initial English translation of Core and HTTP Core modules. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	128 </directive>
22364b1f61c9 Initial English translation of Core and HTTP Core modules. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	129
22364b1f61c9 Initial English translation of Core and HTTP Core modules. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	130
22364b1f61c9 Initial English translation of Core and HTTP Core modules. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	131 <directive name="pid">
22364b1f61c9 Initial English translation of Core and HTTP Core modules. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	132 <syntax>pid <argument>file</argument></syntax>
22364b1f61c9 Initial English translation of Core and HTTP Core modules. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	133 <default>pid nginx.pid</default>
22364b1f61c9 Initial English translation of Core and HTTP Core modules. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	134 <context>main</context>
22364b1f61c9 Initial English translation of Core and HTTP Core modules. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	135
22364b1f61c9 Initial English translation of Core and HTTP Core modules. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	136 <para>
22364b1f61c9 Initial English translation of Core and HTTP Core modules. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	137 Defines a <argument>file</argument> which will store the process ID of the main process.
22364b1f61c9 Initial English translation of Core and HTTP Core modules. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	138 </para>
22364b1f61c9 Initial English translation of Core and HTTP Core modules. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	139
22364b1f61c9 Initial English translation of Core and HTTP Core modules. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	140 </directive>
22364b1f61c9 Initial English translation of Core and HTTP Core modules. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	141
22364b1f61c9 Initial English translation of Core and HTTP Core modules. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	142
22364b1f61c9 Initial English translation of Core and HTTP Core modules. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	143 <directive name="ssl_engine">
22364b1f61c9 Initial English translation of Core and HTTP Core modules. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	144 <syntax>ssl_engine <argument>device</argument></syntax>
22364b1f61c9 Initial English translation of Core and HTTP Core modules. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	145 <default/>
22364b1f61c9 Initial English translation of Core and HTTP Core modules. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	146 <context>main</context>
22364b1f61c9 Initial English translation of Core and HTTP Core modules. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	147
22364b1f61c9 Initial English translation of Core and HTTP Core modules. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	148 <para>
22364b1f61c9 Initial English translation of Core and HTTP Core modules. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	149 Defines the name of the hardware SSL accelerator.
22364b1f61c9 Initial English translation of Core and HTTP Core modules. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	150 </para>
22364b1f61c9 Initial English translation of Core and HTTP Core modules. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	151
22364b1f61c9 Initial English translation of Core and HTTP Core modules. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	152 </directive>
22364b1f61c9 Initial English translation of Core and HTTP Core modules. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	153
22364b1f61c9 Initial English translation of Core and HTTP Core modules. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	154
22364b1f61c9 Initial English translation of Core and HTTP Core modules. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	155 <directive name="user">
22364b1f61c9 Initial English translation of Core and HTTP Core modules. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	156 <syntax>user <argument>user</argument> [<argument>group</argument>]</syntax>
22364b1f61c9 Initial English translation of Core and HTTP Core modules. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	157 <default>user nobody nobody</default>
22364b1f61c9 Initial English translation of Core and HTTP Core modules. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	158 <context>main</context>
22364b1f61c9 Initial English translation of Core and HTTP Core modules. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	159
22364b1f61c9 Initial English translation of Core and HTTP Core modules. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	160 <para>
22364b1f61c9 Initial English translation of Core and HTTP Core modules. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	161 Defines <argument>user</argument> and <argument>group</argument>
22364b1f61c9 Initial English translation of Core and HTTP Core modules. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	162 credentials used by worker processes.
22364b1f61c9 Initial English translation of Core and HTTP Core modules. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	163 If <argument>group</argument> is omitted, a group whose name equals
22364b1f61c9 Initial English translation of Core and HTTP Core modules. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	164 that of <argument>user</argument> is used.
22364b1f61c9 Initial English translation of Core and HTTP Core modules. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	165 </para>
22364b1f61c9 Initial English translation of Core and HTTP Core modules. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	166
22364b1f61c9 Initial English translation of Core and HTTP Core modules. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	167 </directive>
22364b1f61c9 Initial English translation of Core and HTTP Core modules. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	168
22364b1f61c9 Initial English translation of Core and HTTP Core modules. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	169
22364b1f61c9 Initial English translation of Core and HTTP Core modules. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	170 <directive name="timer_resolution">
22364b1f61c9 Initial English translation of Core and HTTP Core modules. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	171 <syntax>timer_resolution <argument>interval</argument></syntax>
22364b1f61c9 Initial English translation of Core and HTTP Core modules. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	172 <default/>
22364b1f61c9 Initial English translation of Core and HTTP Core modules. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	173 <context>main</context>
22364b1f61c9 Initial English translation of Core and HTTP Core modules. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	174
22364b1f61c9 Initial English translation of Core and HTTP Core modules. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	175 <para>
22364b1f61c9 Initial English translation of Core and HTTP Core modules. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	176 Reduces timer resolution in worker processes, thus reducing the
22364b1f61c9 Initial English translation of Core and HTTP Core modules. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	177 number of <c-func>gettimeofday</c-func> system calls made.
22364b1f61c9 Initial English translation of Core and HTTP Core modules. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	178 By default, <c-func>gettimeofday</c-func> is called each time
22364b1f61c9 Initial English translation of Core and HTTP Core modules. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	179 on receiving a kernel event.
22364b1f61c9 Initial English translation of Core and HTTP Core modules. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	180 With reduced resolution, <c-func>gettimeofday</c-func> is only
22364b1f61c9 Initial English translation of Core and HTTP Core modules. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	181 called once per specified <argument>interval</argument>.
22364b1f61c9 Initial English translation of Core and HTTP Core modules. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	182 </para>
22364b1f61c9 Initial English translation of Core and HTTP Core modules. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	183
22364b1f61c9 Initial English translation of Core and HTTP Core modules. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	184 <para>
22364b1f61c9 Initial English translation of Core and HTTP Core modules. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	185 Example:
22364b1f61c9 Initial English translation of Core and HTTP Core modules. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	186 <example>
4079 9755cb2a39b2 Finished initial translation of the Core and HTTP Core modules. Ruslan Ermilov <ru@nginx.com> parents: 4068 diff changeset	187 timer_resolution 100ms;
4068 22364b1f61c9 Initial English translation of Core and HTTP Core modules. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	188 </example>
22364b1f61c9 Initial English translation of Core and HTTP Core modules. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	189 </para>
22364b1f61c9 Initial English translation of Core and HTTP Core modules. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	190
22364b1f61c9 Initial English translation of Core and HTTP Core modules. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	191 <para>
22364b1f61c9 Initial English translation of Core and HTTP Core modules. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	192 An internal implementation of interval depends on the method used:
22364b1f61c9 Initial English translation of Core and HTTP Core modules. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	193 <list type="bullet">
22364b1f61c9 Initial English translation of Core and HTTP Core modules. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	194
22364b1f61c9 Initial English translation of Core and HTTP Core modules. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	195 <listitem>
4079 9755cb2a39b2 Finished initial translation of the Core and HTTP Core modules. Ruslan Ermilov <ru@nginx.com> parents: 4068 diff changeset	196 an <c-def>EVFILT_TIMER</c-def> filter if <value>kqueue</value> is used;
4068 22364b1f61c9 Initial English translation of Core and HTTP Core modules. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	197 </listitem>
22364b1f61c9 Initial English translation of Core and HTTP Core modules. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	198
22364b1f61c9 Initial English translation of Core and HTTP Core modules. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	199 <listitem>
4079 9755cb2a39b2 Finished initial translation of the Core and HTTP Core modules. Ruslan Ermilov <ru@nginx.com> parents: 4068 diff changeset	200 <c-func>timer_create</c-func> if <value>eventport</value> is used;
4068 22364b1f61c9 Initial English translation of Core and HTTP Core modules. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	201 </listitem>
22364b1f61c9 Initial English translation of Core and HTTP Core modules. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	202
22364b1f61c9 Initial English translation of Core and HTTP Core modules. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	203 <listitem>
22364b1f61c9 Initial English translation of Core and HTTP Core modules. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	204 <c-func>setitimer</c-func> otherwise.
22364b1f61c9 Initial English translation of Core and HTTP Core modules. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	205 </listitem>
22364b1f61c9 Initial English translation of Core and HTTP Core modules. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	206
22364b1f61c9 Initial English translation of Core and HTTP Core modules. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	207 </list>
22364b1f61c9 Initial English translation of Core and HTTP Core modules. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	208 </para>
22364b1f61c9 Initial English translation of Core and HTTP Core modules. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	209
22364b1f61c9 Initial English translation of Core and HTTP Core modules. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	210 </directive>
22364b1f61c9 Initial English translation of Core and HTTP Core modules. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	211
22364b1f61c9 Initial English translation of Core and HTTP Core modules. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	212
22364b1f61c9 Initial English translation of Core and HTTP Core modules. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	213 <directive name="worker_rlimit_core">
22364b1f61c9 Initial English translation of Core and HTTP Core modules. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	214 <syntax>worker_rlimit_core <argument>size</argument></syntax>
22364b1f61c9 Initial English translation of Core and HTTP Core modules. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	215 <default/>
22364b1f61c9 Initial English translation of Core and HTTP Core modules. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	216 <context>main</context>
22364b1f61c9 Initial English translation of Core and HTTP Core modules. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	217
22364b1f61c9 Initial English translation of Core and HTTP Core modules. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	218 <para>
22364b1f61c9 Initial English translation of Core and HTTP Core modules. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	219 Changes the limit on the largest size of a core file
22364b1f61c9 Initial English translation of Core and HTTP Core modules. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	220 (<c-def>RLIMIT_CORE</c-def>) for worker processes.
22364b1f61c9 Initial English translation of Core and HTTP Core modules. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	221 Used to increase the limit without restarting the main process.
22364b1f61c9 Initial English translation of Core and HTTP Core modules. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	222 </para>
22364b1f61c9 Initial English translation of Core and HTTP Core modules. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	223
22364b1f61c9 Initial English translation of Core and HTTP Core modules. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	224 </directive>
22364b1f61c9 Initial English translation of Core and HTTP Core modules. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	225
22364b1f61c9 Initial English translation of Core and HTTP Core modules. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	226
22364b1f61c9 Initial English translation of Core and HTTP Core modules. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	227 <directive name="worker_rlimit_nofile">
22364b1f61c9 Initial English translation of Core and HTTP Core modules. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	228 <syntax>worker_rlimit_nofile <argument>number</argument></syntax>
22364b1f61c9 Initial English translation of Core and HTTP Core modules. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	229 <default/>
22364b1f61c9 Initial English translation of Core and HTTP Core modules. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	230 <context>main</context>
22364b1f61c9 Initial English translation of Core and HTTP Core modules. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	231
22364b1f61c9 Initial English translation of Core and HTTP Core modules. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	232 <para>
22364b1f61c9 Initial English translation of Core and HTTP Core modules. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	233 Changes the limit on the maximum number of open files
22364b1f61c9 Initial English translation of Core and HTTP Core modules. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	234 (<c-def>RLIMIT_NOFILE</c-def>) for worker processes.
22364b1f61c9 Initial English translation of Core and HTTP Core modules. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	235 Used to increase the limit without restarting the main process.
22364b1f61c9 Initial English translation of Core and HTTP Core modules. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	236 </para>
22364b1f61c9 Initial English translation of Core and HTTP Core modules. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	237
22364b1f61c9 Initial English translation of Core and HTTP Core modules. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	238 </directive>
22364b1f61c9 Initial English translation of Core and HTTP Core modules. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	239
22364b1f61c9 Initial English translation of Core and HTTP Core modules. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	240
22364b1f61c9 Initial English translation of Core and HTTP Core modules. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	241 <directive name="worker_priority">
22364b1f61c9 Initial English translation of Core and HTTP Core modules. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	242 <syntax>worker_priority <argument>number</argument></syntax>
22364b1f61c9 Initial English translation of Core and HTTP Core modules. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	243 <default>worker_priority 0</default>
22364b1f61c9 Initial English translation of Core and HTTP Core modules. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	244 <context>main</context>
22364b1f61c9 Initial English translation of Core and HTTP Core modules. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	245
22364b1f61c9 Initial English translation of Core and HTTP Core modules. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	246 <para>
22364b1f61c9 Initial English translation of Core and HTTP Core modules. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	247 Defines a scheduling priority for worker processes like is
22364b1f61c9 Initial English translation of Core and HTTP Core modules. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	248 done by the <command>nice</command>: a negative
22364b1f61c9 Initial English translation of Core and HTTP Core modules. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	249 <argument>number</argument>
22364b1f61c9 Initial English translation of Core and HTTP Core modules. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	250 means higher priority.
22364b1f61c9 Initial English translation of Core and HTTP Core modules. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	251 Allowed range normally varies from -20 to 20.
22364b1f61c9 Initial English translation of Core and HTTP Core modules. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	252 </para>
22364b1f61c9 Initial English translation of Core and HTTP Core modules. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	253
22364b1f61c9 Initial English translation of Core and HTTP Core modules. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	254 <para>
22364b1f61c9 Initial English translation of Core and HTTP Core modules. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	255 Example:
22364b1f61c9 Initial English translation of Core and HTTP Core modules. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	256 <example>
4079 9755cb2a39b2 Finished initial translation of the Core and HTTP Core modules. Ruslan Ermilov <ru@nginx.com> parents: 4068 diff changeset	257 worker_priority -10;
4068 22364b1f61c9 Initial English translation of Core and HTTP Core modules. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	258 </example>
22364b1f61c9 Initial English translation of Core and HTTP Core modules. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	259 </para>
22364b1f61c9 Initial English translation of Core and HTTP Core modules. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	260
22364b1f61c9 Initial English translation of Core and HTTP Core modules. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	261 </directive>
22364b1f61c9 Initial English translation of Core and HTTP Core modules. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	262
22364b1f61c9 Initial English translation of Core and HTTP Core modules. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	263
22364b1f61c9 Initial English translation of Core and HTTP Core modules. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	264 <directive name="worker_processes">
22364b1f61c9 Initial English translation of Core and HTTP Core modules. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	265 <syntax>worker_processes <argument>number</argument></syntax>
22364b1f61c9 Initial English translation of Core and HTTP Core modules. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	266 <default>worker_processes 1</default>
22364b1f61c9 Initial English translation of Core and HTTP Core modules. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	267 <context>main</context>
22364b1f61c9 Initial English translation of Core and HTTP Core modules. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	268
22364b1f61c9 Initial English translation of Core and HTTP Core modules. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	269 <para>
22364b1f61c9 Initial English translation of Core and HTTP Core modules. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	270 Defines the number of worker processes.
22364b1f61c9 Initial English translation of Core and HTTP Core modules. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	271 </para>
22364b1f61c9 Initial English translation of Core and HTTP Core modules. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	272
22364b1f61c9 Initial English translation of Core and HTTP Core modules. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	273 </directive>
22364b1f61c9 Initial English translation of Core and HTTP Core modules. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	274
22364b1f61c9 Initial English translation of Core and HTTP Core modules. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	275
22364b1f61c9 Initial English translation of Core and HTTP Core modules. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	276 <directive name="working_directory">
22364b1f61c9 Initial English translation of Core and HTTP Core modules. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	277 <syntax>working_directory <argument>directory</argument></syntax>
22364b1f61c9 Initial English translation of Core and HTTP Core modules. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	278 <default/>
22364b1f61c9 Initial English translation of Core and HTTP Core modules. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	279 <context>main</context>
22364b1f61c9 Initial English translation of Core and HTTP Core modules. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	280
22364b1f61c9 Initial English translation of Core and HTTP Core modules. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	281 <para>
22364b1f61c9 Initial English translation of Core and HTTP Core modules. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	282 Defines a current working directory for a worker process.
4079 9755cb2a39b2 Finished initial translation of the Core and HTTP Core modules. Ruslan Ermilov <ru@nginx.com> parents: 4068 diff changeset	283 It is primarily used when writing a core-file, in which case
4068 22364b1f61c9 Initial English translation of Core and HTTP Core modules. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	284 a working process should have write permission for the
22364b1f61c9 Initial English translation of Core and HTTP Core modules. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	285 specified directory.
22364b1f61c9 Initial English translation of Core and HTTP Core modules. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	286 </para>
22364b1f61c9 Initial English translation of Core and HTTP Core modules. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	287
22364b1f61c9 Initial English translation of Core and HTTP Core modules. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	288 </directive>
22364b1f61c9 Initial English translation of Core and HTTP Core modules. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	289
22364b1f61c9 Initial English translation of Core and HTTP Core modules. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	290 </section>
22364b1f61c9 Initial English translation of Core and HTTP Core modules. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	291
22364b1f61c9 Initial English translation of Core and HTTP Core modules. Ruslan Ermilov <ru@nginx.com> parents: diff changeset	292 </module>

Mercurial > hg > nginx

annotate docs/xml/ngx_core_module.xml @ 4108:5e2103cffd80